開発者ドキュメント
はじめに·

はじめに

niyase プラグインとは何か、useNiyase() ブリッジの考え方、公式・認定・社内の違い。

niyase プラグインは、業種や業務に特化した機能をサイドメニュー単位で追加できる仕組みです。 1 つのプラグインバンドルが、niyase クラウド(Web)・niyase アプリ(Desktop / Mobile)で動作します。

コア原則 — useNiyase() ブリッジ

プラグインはアプリのソースコードを一切受け取らず、SDK だけで開発します。 プラグインが触れる唯一の API 面が useNiyase() ブリッジです。

import { useNiyase } from "@niyase/plugin-sdk";

function Root() {
  const niyase = useNiyase();
  niyase.data; // 自プラグインの plg_* テーブル CRUD
  niyase.core; // コアデータの読み取り(社員・部署・スペース、最小フィールド)
  niyase.context; // { spaceId, role, audience, activeIndustry, locale, theme, ... } 反応的
  niyase.i18n; // 業種ごとの言い換え(例: 案件 ↔ 工事)
  niyase.navigate; // 自プラグイン内のナビ
  niyase.toast; // 通知
  niyase.palette; // 統合パレット連携
  // ...
}

1 インターフェース・2 実装: useNiyase() は、ローカルプレビューでは MOCK 実装、 本番の niyase 上では REAL 実装 が注入されます。同じコードがそのまま本番の見た目になります。

3 つの開発形態

形態配布審査用途
公式niyase 提供コア機能の延長
認定マーケットプレイスで公開必要第三者開発・他社にも提供
社内専用自社スペースに限定公開任意自社業務に特化、一般公開しない

SDK パッケージ(すべて npm 公開・MIT)

  • @niyase/plugin-sdkuseNiyase() ブリッジ契約、defineManifest()、型、niyase-plugin CLI
  • @niyase/plugin-sdk/manifestPluginManifest 型 + validateManifest()(zod)
  • @niyase/plugin-sdk/ui — niyase の UI コンポーネント
  • @niyase/plugin-previewniyase-plugin dev のローカルプレビュー

次に読むべきページ