@nyrra/prismantix-cli 0.0.3-next.16 → 0.0.3-next.2

package/oclif.manifest.json

@@ -1,13 +1,168 @@
 {
   "commands": {
-    "download": {
+    "object:details": {
+      "aliases": [],
+      "args": {
+        "objectSlug": {
+          "name": "objectSlug",
+          "required": true
+        }
+      },
+      "description": "Show the authored public details for one object slug.",
+      "flags": {
+        "api-base": {
+          "description": "PrismantiX API base URL.",
+          "env": "PRISMANTIX_API_BASE",
+          "name": "api-base",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "json": {
+          "description": "Print one machine-readable JSON result to stdout.",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "object:details",
+      "pluginAlias": "@nyrra/prismantix-cli",
+      "pluginName": "@nyrra/prismantix-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "object",
+        "details.js"
+      ]
+    },
+    "object:list": {
+      "aliases": [],
+      "args": {
+        "ontologyId": {
+          "name": "ontologyId",
+          "required": true
+        }
+      },
+      "description": "List the complete effective object set for an ontology.",
+      "flags": {
+        "api-base": {
+          "description": "PrismantiX API base URL.",
+          "env": "PRISMANTIX_API_BASE",
+          "name": "api-base",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "json": {
+          "description": "Print one machine-readable JSON result to stdout.",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "object:list",
+      "pluginAlias": "@nyrra/prismantix-cli",
+      "pluginName": "@nyrra/prismantix-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "object",
+        "list.js"
+      ]
+    },
+    "ontology:list": {
+      "aliases": [],
+      "args": {},
+      "description": "List every registered PrismantiX ontology.",
+      "flags": {
+        "api-base": {
+          "description": "PrismantiX API base URL.",
+          "env": "PRISMANTIX_API_BASE",
+          "name": "api-base",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "json": {
+          "description": "Print one machine-readable JSON result to stdout.",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "ontology:list",
+      "pluginAlias": "@nyrra/prismantix-cli",
+      "pluginName": "@nyrra/prismantix-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "ontology",
+        "list.js"
+      ]
+    },
+    "records:cancel": {
+      "aliases": [],
+      "args": {
+        "operationId": {
+          "name": "operationId",
+          "required": true
+        }
+      },
+      "description": "Best-effort cancel a record-generation operation.",
+      "flags": {
+        "api-base": {
+          "description": "PrismantiX API base URL.",
+          "env": "PRISMANTIX_API_BASE",
+          "name": "api-base",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "json": {
+          "description": "Print one machine-readable JSON result to stdout.",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "records:cancel",
+      "pluginAlias": "@nyrra/prismantix-cli",
+      "pluginName": "@nyrra/prismantix-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "records",
+        "cancel.js"
+      ]
+    },
+    "records:generate": {
       "aliases": [],
       "args": {},
-      "description": "Create or download a PrismantiX client export without opening the guided UI.",
-      "examples": [
-        "<%= config.bin %> download --client LLY --yes --json",
-        "<%= config.bin %> download --export-id export_123 --json"
-      ],
+      "description": "Append a complete ontology-sized default record set for a client.",
       "flags": {
         "api-base": {
           "description": "PrismantiX API base URL.",
@@ -17,30 +172,96 @@
           "multiple": false,
           "type": "option"
         },
+        "json": {
+          "description": "Print one machine-readable JSON result to stdout.",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "client": {
-          "description": "Client ID to export when queueing a new export.",
+          "description": "Client ID.",
           "name": "client",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "ontology": {
+          "description": "Registered ontology ID.",
+          "name": "ontology",
+          "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "export-id": {
-          "description": "Existing export ID to download.",
-          "env": "PRISMANTIX_EXPORT_ID",
-          "name": "export-id",
+        "poll-interval": {
+          "description": "Polling interval in milliseconds.",
+          "name": "poll-interval",
+          "default": 1000,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "timeout": {
+          "description": "Polling timeout in milliseconds (default: 30 minutes).",
+          "name": "timeout",
+          "default": 1800000,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "wait": {
+          "description": "Wait for the operation to reach a terminal state.",
+          "name": "wait",
+          "allowNo": true,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "records:generate",
+      "pluginAlias": "@nyrra/prismantix-cli",
+      "pluginName": "@nyrra/prismantix-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "records",
+        "generate.js"
+      ]
+    },
+    "records:pull": {
+      "aliases": [],
+      "args": {},
+      "description": "Pull a client CSV-bundle export into a local directory.",
+      "flags": {
+        "api-base": {
+          "description": "PrismantiX API base URL.",
+          "env": "PRISMANTIX_API_BASE",
+          "name": "api-base",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "json": {
-          "description": "Print machine-readable JSON to stdout.",
+          "description": "Print one machine-readable JSON result to stdout.",
           "name": "json",
           "allowNo": false,
           "type": "boolean"
         },
+        "client": {
+          "description": "Client ID to export.",
+          "name": "client",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "output": {
           "description": "Output directory.",
-          "env": "PRISMANTIX_OUTPUT_DIR",
           "name": "output",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -48,7 +269,6 @@
         },
         "poll-interval": {
           "description": "Polling interval in milliseconds.",
-          "env": "PRISMANTIX_POLL_INTERVAL_MS",
           "name": "poll-interval",
           "default": 1000,
           "hasDynamicHelp": false,
@@ -56,39 +276,24 @@
           "type": "option"
         },
         "table": {
-          "description": "Table to download; repeat for multiple tables.",
+          "description": "Table to pull; repeat for multiple tables.",
           "name": "table",
           "hasDynamicHelp": false,
           "multiple": true,
           "type": "option"
         },
-        "tables": {
-          "description": "Comma-separated list of tables to download.",
-          "name": "tables",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
         "timeout": {
           "description": "Polling timeout in milliseconds.",
-          "env": "PRISMANTIX_TIMEOUT_MS",
           "name": "timeout",
           "default": 120000,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
-        },
-        "yes": {
-          "char": "y",
-          "description": "Confirm queueing a new export.",
-          "name": "yes",
-          "allowNo": false,
-          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "download",
+      "id": "records:pull",
       "pluginAlias": "@nyrra/prismantix-cli",
       "pluginName": "@nyrra/prismantix-cli",
       "pluginType": "core",
@@ -98,18 +303,38 @@
       "relativePath": [
         "dist",
         "commands",
-        "download.js"
+        "records",
+        "pull.js"
       ]
     },
-    "guided": {
+    "records:status": {
       "aliases": [],
-      "args": {},
-      "description": "Launch the interactive PrismantiX export flow.",
-      "flags": {},
+      "args": {
+        "operationId": {
+          "name": "operationId",
+          "required": true
+        }
+      },
+      "description": "Show a record-generation operation.",
+      "flags": {
+        "api-base": {
+          "description": "PrismantiX API base URL.",
+          "env": "PRISMANTIX_API_BASE",
+          "name": "api-base",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "json": {
+          "description": "Print one machine-readable JSON result to stdout.",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
       "hasDynamicHelp": false,
-      "hidden": true,
       "hiddenAliases": [],
-      "id": "guided",
+      "id": "records:status",
       "pluginAlias": "@nyrra/prismantix-cli",
       "pluginName": "@nyrra/prismantix-cli",
       "pluginType": "core",
@@ -119,9 +344,10 @@
       "relativePath": [
         "dist",
         "commands",
-        "guided.js"
+        "records",
+        "status.js"
       ]
     }
   },
-  "version": "0.0.3-next.16"
+  "version": "0.0.3-next.2"
 }

package/package.json

@@ -1,76 +1,76 @@
 {
-	"name": "@nyrra/prismantix-cli",
-	"description": "PrismantiX API client CLI.",
-	"version": "0.0.3-next.16",
-	"author": "NYRRA Inc.",
-	"bin": {
-		"prismantix-cli": "bin/run.js"
-	},
-	"bugs": {
-		"url": "https://github.com/nyrra-labs/prismantix/issues"
-	},
-	"dependencies": {
-		"@inkjs/ui": "^2.0.0",
-		"@oclif/core": "^4",
-		"@oclif/plugin-help": "^6",
-		"ink": "^7.0.2",
-		"react": "^19.2.0",
-		"react-devtools-core": "^6.1.2",
-		"zod": "^4.2.1"
-	},
-	"devDependencies": {
-		"@oclif/test": "^4",
-		"@types/node": "^25",
-		"ink-testing-library": "^4.0.0",
-		"oclif": "^4",
-		"shx": "^0.3.3",
-		"typescript": "^5"
-	},
-	"engines": {
-		"node": ">=22.0.0"
-	},
-	"files": [
-		"./bin",
-		"./dist",
-		"./README.md",
-		"./oclif.manifest.json"
-	],
-	"homepage": "https://github.com/nyrra-labs/prismantix",
-	"keywords": [
-		"prismantix",
-		"export",
-		"api",
-		"cli"
-	],
-	"license": "SEE LICENSE IN LICENSE",
-	"main": "dist/index.js",
-	"type": "module",
-	"oclif": {
-		"bin": "prismantix-cli",
-		"dirname": "prismantix-cli",
-		"commands": "./dist/commands",
-		"plugins": [
-			"@oclif/plugin-help"
-		],
-		"topicSeparator": " "
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/nyrra-labs/prismantix.git",
-		"directory": "apps/cli"
-	},
-	"scripts": {
-		"build": "shx rm -rf dist tsconfig.tsbuildinfo && tsc -b tsconfig.json --force && oclif manifest",
-		"postpack": "shx rm -f oclif.manifest.json",
-		"prepack": "pnpm run build",
-		"test": "pnpm run build && vitest run --config vitest.config.mts",
-		"typecheck": "tsc -p tsconfig.json --noEmit"
-	},
-	"types": "dist/index.d.ts",
-	"publishConfig": {
-		"access": "public"
-	},
-	"nx": {
-		"name": "prismantix-cli"
-	}
+  "name": "@nyrra/prismantix-cli",
+  "description": "PrismantiX API client CLI.",
+  "version": "0.0.3-next.2",
+  "author": "NYRRA Inc.",
+  "bin": {
+    "prismantix": "bin/run.js"
+  },
+  "bugs": {
+    "url": "https://github.com/shpitdev/prismantix/issues"
+  },
+  "dependencies": {
+    "@oclif/core": "^4.11.14",
+    "@oclif/plugin-help": "^6.2.53",
+    "@oclif/plugin-plugins": "5.4.86",
+    "effect": "4.0.0-beta.106"
+  },
+  "devDependencies": {
+    "@oclif/test": "^4.1.20",
+    "@types/node": "^25.9.1",
+    "oclif": "^4.23.27",
+    "shx": "^0.4.0"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "files": [
+    "./bin",
+    "./dist",
+    "./README.md",
+    "./oclif.manifest.json"
+  ],
+  "homepage": "https://github.com/shpitdev/prismantix",
+  "keywords": [
+    "prismantix",
+    "export",
+    "ontology",
+    "api",
+    "cli"
+  ],
+  "license": "SEE LICENSE IN LICENSE",
+  "main": "dist/index.js",
+  "type": "module",
+  "oclif": {
+    "bin": "prismantix",
+    "dirname": "prismantix",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins"
+    ],
+    "topicSeparator": " "
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shpitdev/prismantix.git",
+    "directory": "apps/cli"
+  },
+  "scripts": {
+    "build": "shx rm -rf dist tsconfig.tsbuildinfo && tsc -b tsconfig.json --force && oclif manifest",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "prepack": "pnpm run build",
+    "test": "pnpm run build && vitest run --config vitest.config.mts",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "nx": {
+    "name": "prismantix-cli",
+    "tags": [
+      "type:app"
+    ]
+  }
 }

package/dist/commands/download.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../src/commands/download.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAS,MAAM,aAAa,CAAC;AAa7C,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,OAAO;IAC5C,OAAgB,WAAW,SACqD;IAEhF,OAAgB,QAAQ,WAGtB;IAEF,OAAgB,KAAK;;;;;;;;;;;MAwCnB;IAEW,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAmDjC,OAAO,CAAC,IAAI;IAeZ,OAAO,CAAC,aAAa;IA0BrB,OAAO,CAAC,YAAY;CAYpB"}

package/dist/commands/download.js

@@ -1,136 +0,0 @@
-import { Command, Flags } from "@oclif/core";
-import { DEFAULT_API_BASE_URL, DEFAULT_POLL_INTERVAL_MS, DEFAULT_TIMEOUT_MS, } from "../constants.js";
-import { CliUserError, toCliUserError } from "../errors.js";
-import { runDownloadWorkflow, } from "../workflow.js";
-export default class Download extends Command {
-    static description = "Create or download a PrismantiX client export without opening the guided UI.";
-    static examples = [
-        "<%= config.bin %> download --client LLY --yes --json",
-        "<%= config.bin %> download --export-id export_123 --json",
-    ];
-    static flags = {
-        "api-base": Flags.string({
-            description: "PrismantiX API base URL.",
-            env: "PRISMANTIX_API_BASE",
-        }),
-        client: Flags.string({
-            description: "Client ID to export when queueing a new export.",
-        }),
-        "export-id": Flags.string({
-            description: "Existing export ID to download.",
-            env: "PRISMANTIX_EXPORT_ID",
-        }),
-        json: Flags.boolean({
-            description: "Print machine-readable JSON to stdout.",
-        }),
-        output: Flags.string({
-            description: "Output directory.",
-            env: "PRISMANTIX_OUTPUT_DIR",
-        }),
-        "poll-interval": Flags.integer({
-            default: DEFAULT_POLL_INTERVAL_MS,
-            description: "Polling interval in milliseconds.",
-            env: "PRISMANTIX_POLL_INTERVAL_MS",
-        }),
-        table: Flags.string({
-            description: "Table to download; repeat for multiple tables.",
-            multiple: true,
-        }),
-        tables: Flags.string({
-            description: "Comma-separated list of tables to download.",
-        }),
-        timeout: Flags.integer({
-            default: DEFAULT_TIMEOUT_MS,
-            description: "Polling timeout in milliseconds.",
-            env: "PRISMANTIX_TIMEOUT_MS",
-        }),
-        yes: Flags.boolean({
-            char: "y",
-            description: "Confirm queueing a new export.",
-        }),
-    };
-    async run() {
-        const { flags } = await this.parse(Download);
-        try {
-            validatePositiveInteger(flags["poll-interval"], "--poll-interval");
-            validatePositiveInteger(flags.timeout, "--timeout");
-            const clientId = flags.client?.trim();
-            const exportId = flags["export-id"]?.trim();
-            if (!exportId && !clientId) {
-                throw new CliUserError("missing_input", "Pass --client to create an export or --export-id to download one.");
-            }
-            if (!exportId && !flags.yes) {
-                throw new CliUserError("missing_consent", "Pass --yes to confirm queueing a new export.");
-            }
-            const result = await runDownloadWorkflow({
-                apiBaseUrl: flags["api-base"] ?? DEFAULT_API_BASE_URL,
-                apiKey: process.env.PRISMANTIX_API_KEY,
-                clientId,
-                exportId,
-                outputDir: flags.output,
-                pollIntervalMs: flags["poll-interval"],
-                tables: collectTables(flags.table, flags.tables),
-                timeoutMs: flags.timeout,
-            }, {
-                onEvent: (event) => this.printProgress(event),
-            });
-            if (flags.json) {
-                this.log(JSON.stringify(result, null, 2));
-                return;
-            }
-            this.printSummary(result);
-        }
-        catch (error) {
-            this.fail(toCliUserError(error), flags.json);
-        }
-    }
-    fail(error, json) {
-        if (json) {
-            this.logToStderr(JSON.stringify({
-                code: error.code,
-                error: error.message,
-                ok: false,
-            }));
-            this.exit(error.exitCode);
-        }
-        this.error(error.message, { code: error.code, exit: error.exitCode });
-    }
-    printProgress(event) {
-        switch (event.type) {
-            case "created":
-                this.logToStderr(`Queued export ${event.exportId} for ${event.clientId}.`);
-                break;
-            case "poll":
-                this.logToStderr(`Export ${event.status.exportId}: ${event.status.status}.`);
-                break;
-            case "manifest":
-                this.logToStderr(`Manifest ready: ${event.manifest.files.length} file(s), ${event.manifest.totalRows} row(s).`);
-                break;
-            case "download-start":
-                this.logToStderr(`Downloading ${event.file.tableName}...`);
-                break;
-            case "download-complete":
-                this.logToStderr(`Downloaded ${event.file.tableName}.`);
-                break;
-        }
-    }
-    printSummary(result) {
-        this.log(`Downloaded PrismantiX export ${result.exportId}`);
-        this.log(`Output: ${result.outputDir}`);
-        this.log(`Manifest: ${result.manifestPath}`);
-        this.log(`Files: ${result.files.length}`);
-        for (const file of result.files) {
-            const rowLabel = file.rowCount === undefined ? "" : ` (${file.rowCount} row(s))`;
-            this.log(`- ${file.tableName}${rowLabel}: ${file.path}`);
-        }
-    }
-}
-function collectTables(tableFlags, tablesFlag) {
-    return [...(tableFlags ?? []), ...(tablesFlag ? [tablesFlag] : [])];
-}
-function validatePositiveInteger(value, flagName) {
-    if (value === undefined || (Number.isInteger(value) && value > 0)) {
-        return;
-    }
-    throw new CliUserError("invalid_argument", `${flagName} must be a positive integer.`);
-}