open-index/open-npm huggingface dataset:
npm package: @kintone/kintone-js-sdk
Description: The SDK of kintone REST API client on node and browser
Author: Cybozu, Inc.
Latest version: 0.7.8
Deprecated: Package no longer supported. Please use @kintone/rest-api-client instead.

# kintone-js-sdk
REST API client of kintone for node.js and javascript 

## ⚠️This package will be deprecated. Please use [@kintone/rest-api-client](https://github.com/kintone/js-sdk/tree/master/packages/rest-api-client) instead.
### Note when using [@kintone/rest-api-client](https://github.com/kintone/js-sdk/tree/master/packages/rest-api-client)
rest-api-client is being updated weekly.  
Currently, not all kintone-js-sdk's features are being supported on the rest-api-client.  
Once the rest-api-client supports all the necessary features for your use, it is highly recommended to switch over.  
For the latest features and news regarding the rest-api-client, please check the [reference](https://github.com/kintone/js-sdk/tree/master/packages/rest-api-client#references).

# How to build

## Requirement

```
* Node.js
* Git
```

```
$ git clone https://github.com/kintone/kintone-js-sdk.git
$ cd kintone-js-sdk
$ npm install
$ npm run build
```
### Output
```
/dist/kintone-js-sdk.min.js
/esm/browser/main.js
/cjs/node/main.js
```

# Installation
npm i @kintone/kintone-js-sdk

## Note
From v0.5.0 completely changed parameters of all modules' constructors and functions to single object parameters.
If you will not use v0.5.0 or upper, please specify the version to install.<br/>
Ex.
```
npm i @kintone/kintone-js-sdk@v0.4.2
```

# Usage
* UMD: include <i>kintone-js-sdk.min.js</i> from <i>dist</i> folder <br/>
```
const kintone = window.kintoneJSSDK;
```
* CommonJS: install kintone-js-sdk using "npm i @kintone/kintone-js-sdk"<br/>
```
const kintone = require('@kintone/kintone-js-sdk')
```
* ESM: install kintone-js-sdk using "npm i @kintone/kintone-js-sdk"<br/>
```
import * as kintoneJSSDK from '@kintone/kintone-js-sdk'
```


# Document
[kintone-js-sdk](https://kintone.github.io/kintone-js-sdk)

# License
MIT License

# Copyright
Copyright(c) Cybozu, Inc.
npm package: @kintone/kintone-ui-component
Description: kintone ui component
Author: Cybozu, Inc.
Latest version: 0.9.5
Deprecated: The maintenance of kintone UI Component v0 ended on 31 December 2023. We recommend migrating to kintone UI Component v1.

# kintone UI Component
[![npm version][npm-image]][npm-url]

## Announcements
ⓘ We released kintone UI Component v1.0.0 on 04 March 2021 and now it is the mainstream.
If you want to use it, please check [this website](https://kintone-ui-component.netlify.app/).

ⓘ We will end the maintenance of kintone UI Component v0 on 31 December 2023.
Please check [this announcement](https://github.com/kintone-labs/kintone-ui-component/discussions/1280) for details.

ⓘ kintone UI Component v0.x.x library has been migrated from git://github.com/kintone/kintone-ui-component.

## Usage
[kintone UI Component Quickstart](https://kintone-labs.github.io/kintone-ui-component/latest/#quick-start)

## Document
[kintone UI Component](https://kintone-labs.github.io/kintone-ui-component)

## Contributing Guide

We welcome contributions to kintone UI Component.<br>
For the details, please check [CONTRIBUTING.md](https://github.com/kintone-labs/kintone-ui-component/blob/v0_dev/CONTRIBUTING.md).


If you have a question or feature request, please register [GitHub issue](https://github.com/kintone-labs/kintone-ui-component/issues/).

## License
MIT License

## Copyright
Copyright(c) Cybozu, Inc.

[npm-image]: https://img.shields.io/npm/v/@kintone/kintone-ui-component.svg
[npm-url]: https://npmjs.org/package/@kintone/kintone-ui-component
npm package: @kintone/kintone-wechat-miniprogram-sdk
Description: The SDK of kintone REST API client on WeChat Mini Program
Author: Cybozu, Inc.
Latest version: 0.1.1
Deprecated: This package has been deprecated. Please use @kintone/rest-api-client-wechat-mp instead.

# kintone-wechat-miniprogram-sdk
REST API client of kintone for WeChat Mini Program

## :warning::warning: This package has been deprecated. Please use [@kintone/rest-api-client-wechat-mp](https://github.com/kintone-labs/rest-api-client-wechat-mp) instead. :warning::warning:

# Installation
```bash
npm i @kintone/kintone-wechat-miniprogram-sdk
```

# Usage
```javascript
const kintone = require('@kintone/kintone-wechat-miniprogram-sdk')
```
For detail, please refer to [Quick start](https://kintone-labs.github.io/kintone-wechat-miniprogram-sdk/latest/getting-started/quickstart/)

# Document
[kintone-wechat-miniprogram-sdk](https://kintone-labs.github.io/kintone-wechat-miniprogram-sdk)

# License
MIT License

# Copyright
Copyright(c) Cybozu, Inc.
npm package: @kintone/plugin-manifest-validator
Description: [![npm version](https://badge.fury.io/js/%40kintone%2Fplugin-manifest-validator.svg)](https://badge.fury.io/js/%40kintone%2Fplugin-manifest-validator) ![Node.js version](https://img.shields.io/badge/dynamic/json.svg?url=https://raw.githubusercontent.com/k
Author: Cybozu, Inc.
Latest version: 11.1.1

# @kintone/plugin-manifest-validator

[![npm version](https://badge.fury.io/js/%40kintone%2Fplugin-manifest-validator.svg)](https://badge.fury.io/js/%40kintone%2Fplugin-manifest-validator)
![Node.js version](https://img.shields.io/badge/dynamic/json.svg?url=https://raw.githubusercontent.com/kintone/js-sdk/main/packages/create-plugin/package.json&label=node&query=$.engines.node&colorB=blue)
![License](https://img.shields.io/npm/l/@kintone/plugin-manifest-validator.svg)

Validate `manifest.json` of kintone plugin. Used in [@kintone/plugin-packer](https://github.com/kintone/plugin-packer).

## How to install

```console
$ npm install @kintone/plugin-manifest-validator
```

## Usage

```js
const validator = require("@kintone/plugin-manifest-validator");

const manifestJson = require("./path/to/your/manifest.json");
const result = validator(manifestJson);
console.log(result.valid); // true or false
console.log(result.errors); // array of ajv error objects
console.log(result.warnings); // string array
```

[ajv error objects](https://ajv.js.org/api.html#error-objects) is like:

```js
{
  dataPath: '/version',
  keyword: 'type',
  message: 'should be integer',
  params: {
    type: 'integer',
  },
  schemaPath: '#/properties/version/type',
}
```

## `manifest-schema.json`

JSON schema for manifest.json is available.

```js
const manifestJsonSchema = require("@kintone/plugin-manifest-validator/manifest-schema.json");
```

## `manifest-schema.d.ts`

TypeScript type definition (d.ts) for manifest.json is available.

```typescript
import { KintonePluginManifestJson } from "@kintone/plugin-manifest-validator/manifest-schema";

let manifest: KintonePluginManifestJson;
```

## Setting the `$schema` property

When you are configuring your project, you would better set the $schema property. This property should point to a schema file that validates your manifest.
We recommend setting the $schema property to the following URI in your manifest.json:

```
https://raw.githubusercontent.com/kintone/js-sdk/%40kintone/plugin-manifest-validator%4011.1.0/packages/plugin-manifest-validator/manifest-schema.json
```

Note: Add or update the $schema property at the top of the manifest.json.

## License

MIT License
npm package: @kintone/plugin-packer
Description: Package your kintone plugin with pure JavaScript
Author: Cybozu, Inc.
Latest version: 9.1.1

# kintone-plugin-packer

[![npm version](https://badge.fury.io/js/%40kintone%2Fplugin-packer.svg)](https://badge.fury.io/js/%40kintone%2Fplugin-packer)
![Node.js version](https://img.shields.io/badge/dynamic/json.svg?url=https://raw.githubusercontent.com/kintone/js-sdk/main/packages/plugin-packer/package.json&label=node&query=$.engines.node&colorB=blue)
![License](https://img.shields.io/npm/l/@kintone/plugin-packer.svg)

[kintone plugin package.sh](https://github.com/kintone-samples/plugin-samples) in JavaScript

It's written in pure JavaScript, so

- The CLI works with Node.js in Mac/Windows/Linux
- [The web page](https://plugin-packer.kintone.dev/) works in any modern browsers
- Validate your `manifest.json` with [JSON Schema](https://github.com/kintone/js-sdk/tree/main/packages/plugin-manifest-validator)

# How to install

```console
$ npm install -g @kintone/plugin-packer
```

# Usage: CLI

```console
$ kintone-plugin-packer [OPTIONS] PLUGIN_DIR
```

## Options

- `--ppk PPK_FILE`: The path of input private key file. If omitted, it is generated automatically into `<Plugin ID>.ppk` in the same directory of `PLUGIN_DIR` or `--out` if specified.
- `--out PLUGIN_FILE`: The path of generated plugin file. The default is `plugin.zip` in the same directory of `PLUGIN_DIR`.
- `--watch`, `-w`: Watch PLUGIN_DIR for the changes.

## How to use with `npm run`

If your private key is `./private.ppk` and the plugin directory is `./plugin`, edit `package.json`:

```json
{
  "scripts": {
    "package": "kintone-plugin-packer --ppk private.ppk plugin"
  }
}
```

and then

```console
$ npm run package
```

# Usage: Node.js API

```js
const packer = require("@kintone/plugin-packer");
const fs = require("fs");

const buffer = createContentsZipBufferInYourSelf();
packer(buffer).then((output) => {
  console.log(output.id);
  fs.writeFileSync("./private.ppk", output.privateKey);
  fs.writeFileSync("./plugin.zip", output.plugin);
});
```

## License

MIT License
npm package: @kintone/webpack-plugin-kintone-plugin
Description: A webpack plugin to generate a plugin zip
Author: Cybozu, Inc.
Latest version: 9.0.3

# webpack-plugin-kintone-plugin

[![npm version](https://badge.fury.io/js/%40kintone%2Fwebpack-plugin-kintone-plugin.svg)](https://badge.fury.io/js/%40kintone%2Fwebpack-plugin-kintone-plugin)
![Node.js version](https://img.shields.io/badge/dynamic/json.svg?url=https://raw.githubusercontent.com/kintone/js-sdk/main/packages/webpack-plugin-kintone-plugin/package.json&label=node&query=$.engines.node&colorB=blue)
![License](https://img.shields.io/npm/l/@kintone/webpack-plugin-kintone-plugin.svg)

A webpack plugin to create a plugin zip of Kintone.

## Usage

```js
"use strict";

const path = require("path");
const KintonePlugin = require("@kintone/webpack-plugin-kintone-plugin");

module.exports = {
  entry: {
    desktop: "./src/desktop.js",
    mobile: "./src/mobile.js",
  },
  output: {
    path: path.resolve(__dirname, "plugin", "js"),
    filename: "[name].js",
  },
  plugins: [
    new KintonePlugin({
      manifestJSONPath: "./plugin/manifest.json",
      privateKeyPath: "./private.ppk",
      pluginZipPath: "./dist/plugin.zip",
    }),
  ],
};
```

The settings is the following structure.

- `src/desktop.js` is an entry point of desktop javascript.
- `src/mobild.js` is an entry point of desktop javascript.
- `plugin` is the directory of the plugin, which includes `manifest.json` and other resources.
- `private.ppk` is the private key for the plugin
- `dist/plugin.zip` is the plugin zip file.

## Private Key Generation

To generate a private key for your plugin, use the cli-kintone command:

```bash
npx @kintone/cli plugin keygen --output ./private.ppk
```

For more details, see the [cli-kintone documentation](https://github.com/kintone/cli-kintone).

## Install

```
npm install @kintone/webpack-plugin-kintone-plugin
```

## Options

You can customize the paths of manifest.json, privateKey and plugin zip.
Those default values are like the following.

```
manifestJSONPath: './manifest.json',
privateKeyPath: './private.ppk',
pluginZipPath: './dist/plugin.zip'
```

If you want to customize these values, you can update the values like this.

```js
"use strict";

const path = require("path");
const KintonePlugin = require("@kintone/webpack-plugin-kintone-plugin");

module.exports = {
  entry: {
    desktop: "./src/desktop.js",
    mobile: "./src/mobile.js",
  },
  output: {
    path: path.resolve(__dirname, "plugin", "js"),
    filename: "[name].js",
  },
  plugins: [
    new KintonePlugin({
      manifestJSONPath: "./plugin/manifest.json",
      privateKeyPath: "./private.ppk",
      pluginZipPath: "./dist/plugin.zip",
    }),
  ],
};
```

In addition to that, you can specify the plugin zip name based on the plugin id and values of the manifest.json.

```js
plugins: [
  new KintonePlugin({
    manifestJSONPath: "./plugin/manifest.json",
    privateKeyPath: "./private.ppk",
    pluginZipPath: (id, manifest) => `${id}.${manifest.version}.plugin.zip`,
  }),
];
```

## License

MIT License