@rex0220/formula-authoring-tools 0.1.0 → 0.2.1

package/dist/types/workspace.d.ts

@@ -0,0 +1,126 @@
+import { ConnectionError, type ConnectionSet, type Env, type ProfileDef } from "./connections.ts";
+export declare const KINTONE_ROOT = "kintone";
+export declare const INBOX = "inbox";
+/** 1.x の作業フォルダーの環境の定義（2.0.0 から読まない。あれば移行を求めて止まる） */
+export declare const LEGACY_WORKSPACE_FILE = "environments.json";
+/** アプリのフォルダーの印（15.5） */
+export declare const APP_MARKER = ".formula-app.json";
+/** 設定画面のダウンロードのファイル名の接頭辞（kit の exportFileName。計算式プラグインの src/config/main.ts の exportPrefix） */
+export declare const SNAPSHOT_PREFIX = "rex0220-formula";
+export declare const SNAPSHOT_RE: RegExp;
+export declare const EDIT_RE: RegExp;
+export declare class WorkspaceError extends Error {
+}
+/**
+ * 動く形（15.4、15.11。r3 MAJOR 7）: single（1 接続の形。CLI だけ）、profiles（接続のファイルがある）、not-configured（MCP で接続のファイルが無い）、
+ * legacy-blocked（接続のファイルが無く environments.json がある）。どの形でも settings/ などのローカルの操作は動く。kintone/** を読む・書くのは profiles だけ
+ */
+export type WorkspaceMode = {
+    kind: "single";
+} | {
+    kind: "profiles";
+    connections: ProfilesContext;
+} | {
+    kind: "not-configured";
+} | {
+    kind: "legacy-blocked";
+};
+/** profile の形の文脈: 呼び出しの初めに読んだ接続（秘密を含む。外に出さない）と、確定の前に読み直す関数 */
+export interface ProfilesContext {
+    set: ConnectionSet;
+    reload: () => ConnectionSet;
+}
+export interface ModeOptions {
+    /** 接続のファイルの絶対パス（設定されていなければ undefined、設定されていて空なら ""） */
+    configFile: string | undefined;
+    /** そのプロセスが知っている作業フォルダー（この中の接続のファイルは使わない） */
+    workspaceRoots: readonly string[];
+    /** env: と passwordEnv を引く環境変数 */
+    env: Env;
+    /** 接続のファイルが無いときの形: CLI は single（.env の 1 接続）、MCP は not-configured */
+    surface: "cli" | "mcp";
+}
+/** 1.x の environments.json があるか（リンク切れの symlink も「ある」） */
+export declare function hasLegacyConfig(cwd: string): boolean;
+/** 移行で止まっているときの誤り（kintone を使う操作と kintone/** の操作が投げる） */
+export declare function legacyBlockedError(): ConnectionError;
+/**
+ * 動く形を決める（15.4 の表）。接続のファイルが設定されていれば読む（空・読めない・形が違うのは誤り。1 接続の形に戻らない）。
+ * 設定されていなければ、environments.json があれば legacy-blocked、無ければ CLI は single、MCP は not-configured
+ */
+export declare function modeOf(cwd: string, opt: ModeOptions): WorkspaceMode;
+/** kintone を使う操作・アプリのフォルダーの操作の前に: profile の形でなければ止める（未設定・移行で止まっている・1 接続の形の理由で） */
+export declare function requireProfiles(mode: WorkspaceMode, what: string): ProfilesContext;
+/** アプリのフォルダーの名前（番号-アプリ名。名前が使えなければ番号だけ） */
+export declare function folderNameOf(appId: number, appName: string): string;
+export declare function profileDirOf(cwd: string, profile: string): string;
+/**
+ * フォルダー・ファイルの実体（symlink を解いたもの）が作業フォルダーの中か。外なら一覧を作らず・読まずに PathError。リンク切れ・ループも PathError
+ * （kintone/<profile> や inbox が外への symlink のとき、外のファイルの名前を出さない。B1 の Codex レビュー BLOCKER 1）
+ */
+export declare function assertInsideWorkspace(cwd: string, p: string): void;
+/** 今あるアプリのフォルダー（番号で探す。無ければ null。同じ番号が 2 つあれば止まる）。kintone/ と profile のフォルダーの実体が作業フォルダーの中のときだけ一覧する */
+export declare function findAppDir(cwd: string, profile: string, appId: number): string | null;
+/** アプリのフォルダー（あればそれ、無ければ 番号-アプリ名 で作る場所。作るのは ensureAppFolder） */
+export declare function appDirFor(cwd: string, profile: string, appId: number, appName: string): string;
+/** ファイルが kintone/<profile>/<番号>-…/ の中（records/ などの下を含む）なら、そのフォルダーと profile と番号 */
+export declare function appFolderOfFile(cwd: string, file: string): {
+    dir: string;
+    profile: string;
+    appId: number;
+} | null;
+/** ダウンロードと同じ名前（kit の exportFileName と同じ。日時はこの PC の時刻） */
+export declare function snapshotNameOf(appId: number, now?: Date): string;
+export declare function editNameOf(snapshotFile: string): string;
+export interface AppMark {
+    schemaVersion: 1;
+    profile: string;
+    origin: string;
+    guestSpaceId: number | null;
+    appId: number;
+}
+export declare function markOf(def: ProfileDef, appId: number): AppMark;
+export type AppMarkState = {
+    state: "missing";
+} | {
+    state: "invalid";
+} | {
+    state: "ok";
+    mark: AppMark;
+};
+/** 印を読む（無い・壊れている・読めた） */
+export declare function readAppMark(dir: string): AppMarkState;
+/** アプリのフォルダーの印が、今の接続のこのアプリのものか（無い・壊れている・違うは ConnectionError。conflict） */
+export declare function assertAppMark(dir: string, def: ProfileDef, appId: number): void;
+/**
+ * アプリのフォルダーを使う（fields / pull / take だけが呼ぶ。15.5）。あれば印を確かめる。無ければ、同じ親の一時フォルダー（. で始まる名前）に印を置いてから
+ * 最後の名前に付け替える（途中で止まっても印の無いフォルダーを残さない。r3 MINOR 1）。付け替えの先が既にあれば（同時に作った）、その印を確かめて使う。
+ * dir は appDirFor の値（書ける場所と許可は呼ぶ側が先に確かめる）
+ */
+export declare function ensureAppFolder(dir: string, def: ProfileDef, appId: number): void;
+/**
+ * kintone/** の中のファイル・フォルダーを通常の操作で読む・一覧する前に（15.5、r3 MAJOR 3）: profile の形で、フォルダーの profile が接続のファイルにあり、
+ * 印が今の接続のこのアプリのものか。kintone/ の外なら何もしない。profile が無い = denied（PermissionError）、印 = conflict（ConnectionError）
+ */
+export declare function assertUsableInKintone(cwd: string, file: string, mode: WorkspaceMode): void;
+export interface AppFolderList {
+    dir: string;
+    hasFields: boolean;
+    /** ダウンロードと pull（新しい順） */
+    snapshots: string[];
+    /** 直したもの（新しい順） */
+    edits: string[];
+    /** AI が作った設定など、その他の json（. で始まる印などは出さない） */
+    others: string[];
+    records: string[];
+}
+/** アプリのフォルダーの一覧。cwd を渡すと、フォルダーと records の実体が作業フォルダーの中か確かめてから一覧する */
+export declare function listAppFolder(dir: string, cwd?: string): AppFolderList;
+/** profile のフォルダーの中のアプリのフォルダーと印の状態（診断と files の一覧。中身は返さない。15.5） */
+export declare function appFoldersOf(cwd: string, def: ProfileDef): Array<{
+    name: string;
+    appId: number | null;
+    mark: "ok" | "missing" | "invalid" | "conflict";
+}>;
+/** kintone/ の下の profile のフォルダーのうち、接続のファイルに無いもの（使われていないフォルダー。診断で名前だけ示す） */
+export declare function unusedProfileDirs(cwd: string, set: ConnectionSet): string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rex0220/formula-authoring-tools",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "rex0220 計算式プラグイン（kintone）の設定を AI で作るための CLI。利用者のプラグインの zip から authoring API と計算式エンジンを読んで Node で動く",
   "license": "MIT",
   "type": "module",
@@ -34,6 +34,7 @@
     "prepack": "node scripts/vendor.mjs && node scripts/build.mjs",
     "gen-docs": "node scripts/gen-docs.mjs"
   },
+  "publishConfig": { "access": "public" },
   "homepage": "https://github.com/rex0220/formula-authoring#readme",
   "repository": {
     "type": "git",