開発者ポータル
niyase プラグインを公開する
あなたの業務ノウハウをプラグインにして、niyase を使う事業者に使ってもらえます。SDK と CLI で、開発から公開までひと通り揃っています。
公開までの流れ
1. SDK でプラグインを開発
npm create niyase-plugin で雛形を作成。マニフェスト・画面・データ操作を TypeScript で書き、niyase 本体のソースが無くても「本物の見た目」で動作確認できます。
2. ビルドして動作確認
niyase-plugin build でバンドルを生成し、niyase-plugin test でオフラインのまま動作を確かめます。
3. 公開申請 → 審査 → 公開
niyase-plugin publish で申請。niyase の審査(要件・セキュリティ・使い心地)を通ると、「認定」バッジ付きでマーケットプレイスに公開されます。
SDK の特徴
TypeScript ファースト
マニフェストも画面も型安全。設定ミスはエディタがその場で指摘します。
アプリ本体のソース不要
MIT ライセンスの公開 SDK だけで開発できます。手元のモック環境が本番そっくりの画面を再現するので、niyase 本体のコードは要りません。
認定制度
niyase の審査を通った公式・認定プラグインにはバッジが付き、利用者が安心して選べます。
SDK の概要
パッケージ
npm install @niyase/plugin-sdkマニフェストの例
import { defineManifest } from "@niyase/plugin-sdk/manifest";
export default defineManifest({
id: "@your-company/your-plugin",
scope: "CERTIFIED", // 公式=OFFICIAL / 認定=CERTIFIED
visibility: "PUBLIC", // 一般公開 / PRIVATE=指定スペースのみ
targetWorkspace: "BUSINESS", // BUSINESS / PERSONAL / BOTH
category: "sales", // niyase のカテゴリ
industries: ["REAL_ESTATE"], // 関連業種(任意・発見用ラベル)
displayName: "プラグイン名",
description: "1〜2 文の説明",
iconName: "Briefcase", // lucide-react のアイコン名
defaultRole: "LOCAL",
audiences: [
{
role: "executive",
nav: { label: "メニュー名", href: "/your-plugin" },
tabs: [
{ value: "list", label: "一覧" },
{ value: "settings", label: "設定" },
],
},
],
tables: [
// 有効化時に作成される専用テーブル
{ name: "record", columns: { title: { type: "TEXT", notNull: true } } },
],
// ほか paletteMetadata 等の必須項目あり。完全な型はドキュメント参照
});