@invinite-org/invinite-data-cli 3.0.0 → 4.1.0

package/dist/src/spec-manifest.js

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 /**
- * The compact, committed form of the Data API spec that `invd` registers its generated commands from
+ * The compact, committed form of the Data API v2 spec that `invd` registers its generated commands from
  * (`src/generated/cli-manifest.json`, written by `scripts/build-cli-manifest.ts` from `openapi.json`'s `x-cli`).
  * One schema for the builder's output, the startup loader and the dispatcher.
  */
@@ -8,53 +8,82 @@ export const MANIFEST_PARAM_TYPES = ['string', 'integer', 'number', 'boolean', '
 export const MANIFEST_ITEM_TYPES = ['string', 'integer', 'number'];
 export const MANIFEST_METHODS = ['get', 'post', 'put', 'patch', 'delete'];
 export const MANIFEST_VIEWS = ['table', 'keyValue', 'json'];
-export const MANIFEST_PAGINATIONS = ['none', 'top', 'perCompany'];
 const manifestParamSchema = z.object({
     name: z.string().min(1),
-    in: z.enum(['query', 'path']),
+    in: z.enum(['query', 'path', 'header']),
     required: z.boolean(),
     type: z.enum(MANIFEST_PARAM_TYPES),
     /** Arrays only: the item type; the value is sent as a repeated parameter. */
     items: z.enum(MANIFEST_ITEM_TYPES).optional(),
     /** Allowed values, stringified; on an array they apply to each item. */
     enum: z.array(z.string()).optional(),
+    /** The spec's `pattern` (comma lists like `income-statement,balance-sheet` are patterns, not arrays). */
+    pattern: z.string().optional(),
     /** Shown in help, never sent — the API applies its own default. */
     default: z.unknown().optional(),
-    /** The spec's `example`: shown in help and the skill's example line, never sent. */
+    /** The spec's `example`: shown in help and in the examples, never sent. */
     example: z.unknown().optional(),
     description: z.string().optional(),
     /** One-letter short flag (`-q`). */
     alias: z.string().length(1).optional(),
+    /** The long flag without dashes (`filed_at.gte` → `filed-at-gte`). */
+    flag: z.string().min(1),
+}).strict();
+const bodyFieldSchema = z.object({
+    /** The property's path in the JSON body (`["filters", "ciks"]`). */
+    path: z.array(z.string().min(1)).min(1),
+    type: z.enum(MANIFEST_PARAM_TYPES),
+    items: z.enum(MANIFEST_ITEM_TYPES).optional(),
+    required: z.boolean(),
+    description: z.string().optional(),
+    alias: z.string().length(1).optional(),
+    flag: z.string().min(1),
 }).strict();
 const manifestOperationSchema = z.object({
     operationId: z.string().min(1),
     group: z.string().min(1),
-    /** `""` = the group itself is the command (`invd health`). */
+    /** `""` = the group itself is the command (`invd financials`, the `x-cli.command` operations). */
     action: z.string(),
     method: z.enum(MANIFEST_METHODS),
     path: z.string().startsWith('/'),
-    /** `false` = the operation needs no API key (`security: []` or none in the spec): no key is resolved or sent. */
+    /** `false` = the operation needs no API key: no key is resolved or sent. */
     auth: z.boolean(),
     summary: z.string(),
+    /** The spec's `x-credits`: the base cost of one response (`--dry-run`, the `--all` confirmation). */
+    credits: z.number().nonnegative(),
+    /** The spec's `x-tier` (free, lite, standard, pro). */
+    tier: z.string(),
     params: z.array(manifestParamSchema),
+    /** The parameter the first positional fills: a company list (`AAPL MSFT` → `company=AAPL,MSFT`), a member id, `q`. */
+    positional: z.object({
+        name: z.string().min(1),
+        required: z.boolean(),
+        /** Several words: joined with `,` (a company list) or ` ` (a search text). */
+        variadic: z.enum(['comma', 'space']).optional(),
+    }).strict().optional(),
+    /** One command over several operations (`invd financials`): the `--basis` / `--view` values that pick this one. */
+    select: z.record(z.string()).optional(),
     /** The spec's `x-example-params`: the OPTIONAL params an example invocation passes beside the required ones. */
     exampleParams: z.array(z.string().min(1)).min(1).optional(),
     body: z.object({
         required: z.boolean(),
         contentType: z.literal('application/json'),
-        /** The spec's request-body `example` (the skill's `--body`). */
+        /** The spec's request-body `example`. */
         example: z.unknown().optional(),
+        /** Flags for the body's scalar / list properties (`--url`, `--events a,b`, `--ciks` → `filters.ciks`). */
+        fields: z.array(bodyFieldSchema),
     }).strict().optional(),
+    /** A cursor-paginated list (`{data, has_more, next_cursor, meta}`): `--all`, `--cursor`, JSONL / CSV rows. */
+    list: z.boolean(),
     view: z.enum(MANIFEST_VIEWS),
-    /** Dotted path to the table's rows, or to the ONE object a `keyValue` view shows (absent = the response root). */
-    rowsPath: z.string().optional(),
     columns: z.array(z.string()).optional(),
-    pagination: z.enum(MANIFEST_PAGINATIONS),
+    /** The JSON fields of one row (a list's `data[]` item, else the object): `--json a,b` and `--help`. */
+    fields: z.array(z.string()),
     /**
-     * The arrays `--all` concatenates: top-level paths for `top` (default: `[rowsPath]`), paths under `companies[]`
-     * for `perCompany`. Absent on `none`.
+     * Where the response carries a downloadable file (`{url, sha256?, bytes?, content_type?}`): `""` = the response
+     * root, else a dotted path (`pdf`, `deck`). Present = the command takes `--save <file>`.
      */
-    allItemsPath: z.array(z.string()).min(1).optional(),
+    download: z.string().optional(),
 }).strict();
 export const manifestSchema = z.object({
     specVersion: z.string(),
@@ -64,6 +93,8 @@ export const manifestSchema = z.object({
 }).strict();
 /** A param's spec example as its flag takes it: an array comma-joined, anything else as its text. */
 export const exampleValue = (example) => Array.isArray(example) ? example.map(item => String(item)).join(',') : String(example);
+/** `invd <group> <action>` without the program name (`financials`, `companies get`). */
+export const commandName = (operation) => [operation.group, operation.action].filter(Boolean).join(' ');
 /** Parses a loaded manifest; a corrupt file fails by name rather than registering half a CLI. */
 export function parseManifest(raw, source = 'src/generated/cli-manifest.json') {
     const result = manifestSchema.safeParse(raw);

package/dist/src/spec-manifest.js.map

@@ -1 +1 @@
-{"version":3,"file":"spec-manifest.js","sourceRoot":"","sources":["../../src/spec-manifest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;GAIG;AAEH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAU,CAAC;AACjG,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAU,CAAC;AAC5E,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAU,CAAC;AACnF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,CAAU,CAAC;AACrE,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,CAAU,CAAC;AAE3E,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC7B,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC;IAClC,6EAA6E;IAC7E,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,QAAQ,EAAE;IAC7C,wEAAwE;IACxE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACpC,mEAAmE;IACnE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,oFAAoF;IACpF,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,oCAAoC;IACpC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;CACvC,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACxB,8DAA8D;IAC9D,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;IAChC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC;IAChC,iHAAiH;IACjH,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE;IACjB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC;IACpC,gHAAgH;IAChH,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC3D,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACb,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;QACrB,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;QAC1C,gEAAgE;QAChE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;KAChC,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC;IAC5B,kHAAkH;IAClH,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC;IACxC;;;OAGG;IACH,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;CACpD,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC;IAC9C,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;IACxF,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC;CAC7C,CAAC,CAAC,MAAM,EAAE,CAAC;AAIZ,qGAAqG;AACrG,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAgB,EAAU,EAAE,CACvD,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAIzF,iGAAiG;AACjG,MAAM,UAAU,aAAa,CAAC,GAAY,EAAE,MAAM,GAAG,iCAAiC;IACpF,MAAM,MAAM,GAAG,cAAc,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC7C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACrC,MAAM,IAAI,KAAK,CAAC,4BAA4B,MAAM,KAAK,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,QAAQ,KAAK,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;IACjH,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC;AACrB,CAAC"}
+{"version":3,"file":"spec-manifest.js","sourceRoot":"","sources":["../../src/spec-manifest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;GAIG;AAEH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAU,CAAC;AACjG,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAU,CAAC;AAC5E,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAU,CAAC;AACnF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,CAAU,CAAC;AAErE,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACvC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC;IAClC,6EAA6E;IAC7E,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,QAAQ,EAAE;IAC7C,wEAAwE;IACxE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACpC,yGAAyG;IACzG,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,mEAAmE;IACnE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,2EAA2E;IAC3E,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,oCAAoC;IACpC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACtC,sEAAsE;IACtE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CACxB,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/B,oEAAoE;IACpE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACvC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC;IAClC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,QAAQ,EAAE;IAC7C,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACtC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CACxB,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACxB,kGAAkG;IAClG,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;IAChC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC;IAChC,4EAA4E;IAC5E,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE;IACjB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,qGAAqG;IACrG,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE;IACjC,uDAAuD;IACvD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC;IACpC,sHAAsH;IACtH,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QACvB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;QACrB,8EAA8E;QAC9E,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE;KAChD,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtB,mHAAmH;IACnH,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,gHAAgH;IAChH,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC3D,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACb,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;QACrB,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;QAC1C,yCAAyC;QACzC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAC/B,0GAA0G;QAC1G,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC;KACjC,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtB,8GAA8G;IAC9G,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE;IACjB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC;IAC5B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,uGAAuG;IACvG,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC3B;;;OAGG;IACH,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC;IAC9C,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;IACxF,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC;CAC7C,CAAC,CAAC,MAAM,EAAE,CAAC;AAOZ,qGAAqG;AACrG,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAgB,EAAU,EAAE,CACvD,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAEzF,wFAAwF;AACxF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,SAAsD,EAAU,EAAE,CAC5F,CAAC,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAEhE,iGAAiG;AACjG,MAAM,UAAU,aAAa,CAAC,GAAY,EAAE,MAAM,GAAG,iCAAiC;IACpF,MAAM,MAAM,GAAG,cAAc,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC7C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACrC,MAAM,IAAI,KAAK,CAAC,4BAA4B,MAAM,KAAK,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,QAAQ,KAAK,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;IACjH,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC;AACrB,CAAC"}

package/dist/src/update-notifier.d.ts

@@ -0,0 +1,9 @@
+/**
+ * A once-a-day look at npm's `latest` for this package; the notice prints on stderr from the cached answer. Never
+ * in CI, under a test runner, without a terminal on stderr, or with `INVD_NO_UPDATE_NOTIFIER` set.
+ */
+export declare function updateCheckEnabled(env?: NodeJS.ProcessEnv, stderrIsTty?: boolean): boolean;
+/** `a` newer than `b` (plain `x.y.z`; anything else is never newer). */
+export declare function isNewer(a: string, b: string): boolean;
+/** Prints the cached notice and, at most once a day, refreshes the cache (≤ 1.5 s, failures ignored). */
+export declare function runUpdateNotifier(current: string): Promise<void>;

package/dist/src/update-notifier.js

@@ -0,0 +1,63 @@
+import { mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { join } from 'node:path';
+import chalk from 'chalk';
+import { configDir } from './config/config-manager.js';
+const PACKAGE = '@invinite-org/invinite-data-cli';
+const DAY_MS = 24 * 60 * 60 * 1000;
+/**
+ * A once-a-day look at npm's `latest` for this package; the notice prints on stderr from the cached answer. Never
+ * in CI, under a test runner, without a terminal on stderr, or with `INVD_NO_UPDATE_NOTIFIER` set.
+ */
+export function updateCheckEnabled(env = process.env, stderrIsTty = Boolean(process.stderr.isTTY)) {
+    return stderrIsTty && !env.CI && !env.INVD_NO_UPDATE_NOTIFIER && !env.VITEST && env.NODE_ENV !== 'test';
+}
+/** `a` newer than `b` (plain `x.y.z`; anything else is never newer). */
+export function isNewer(a, b) {
+    const parse = (version) => /^(\d+)\.(\d+)\.(\d+)$/.exec(version)?.slice(1).map(Number);
+    const [x, y] = [parse(a), parse(b)];
+    if (!x || !y)
+        return false;
+    for (let index = 0; index < 3; index += 1) {
+        if ((x[index] ?? 0) !== (y[index] ?? 0))
+            return (x[index] ?? 0) > (y[index] ?? 0);
+    }
+    return false;
+}
+const statePath = () => join(configDir(), 'update-check.json');
+function readState() {
+    try {
+        return JSON.parse(readFileSync(statePath(), 'utf8'));
+    }
+    catch {
+        return {};
+    }
+}
+/** Prints the cached notice and, at most once a day, refreshes the cache (≤ 1.5 s, failures ignored). */
+export async function runUpdateNotifier(current) {
+    if (!updateCheckEnabled())
+        return;
+    const state = readState();
+    if (state.latest && isNewer(state.latest, current)) {
+        console.error(chalk.yellow(`invd ${state.latest} is available (you have ${current}): npm install -g ${PACKAGE}`));
+    }
+    if (state.checkedAt && Date.now() - state.checkedAt < DAY_MS)
+        return;
+    let latest = state.latest;
+    try {
+        const response = await fetch(`https://registry.npmjs.org/${PACKAGE}/latest`, { signal: AbortSignal.timeout(1500) });
+        const body = await response.json();
+        if (typeof body.version === 'string')
+            latest = body.version;
+    }
+    catch {
+        // offline or slow: the next check is tomorrow either way
+    }
+    try {
+        mkdirSync(configDir(), { recursive: true });
+        writeFileSync(statePath(), JSON.stringify({ checkedAt: Date.now(), ...(latest ? { latest } : {}) }));
+    }
+    catch {
+        // a read-only config dir: no cache, no notice
+    }
+}
+//# sourceMappingURL=update-notifier.js.map

package/dist/src/update-notifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-notifier.js","sourceRoot":"","sources":["../../src/update-notifier.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACjE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAEvD,MAAM,OAAO,GAAG,iCAAiC,CAAC;AAClD,MAAM,MAAM,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAEnC;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAyB,OAAO,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;IAClH,OAAO,WAAW,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,uBAAuB,IAAI,CAAC,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,QAAQ,KAAK,MAAM,CAAC;AAC1G,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,OAAO,CAAC,CAAS,EAAE,CAAS;IAC1C,MAAM,KAAK,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC/F,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACpC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IAC3B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAC1C,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACpF,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAOD,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,mBAAmB,CAAC,CAAC;AAE/D,SAAS,SAAS;IAChB,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,MAAM,CAAC,CAAU,CAAC;IAChE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAED,yGAAyG;AACzG,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,OAAe;IACrD,IAAI,CAAC,kBAAkB,EAAE;QAAE,OAAO;IAClC,MAAM,KAAK,GAAG,SAAS,EAAE,CAAC;IAC1B,IAAI,KAAK,CAAC,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;QACnD,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,KAAK,CAAC,MAAM,2BAA2B,OAAO,qBAAqB,OAAO,EAAE,CAAC,CAAC,CAAC;IACpH,CAAC;IACD,IAAI,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,SAAS,GAAG,MAAM;QAAE,OAAO;IACrE,IAAI,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IAC1B,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,8BAA8B,OAAO,SAAS,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAA2B,CAAC;QAC5D,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ;YAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;IAC9D,CAAC;IAAC,MAAM,CAAC;QACP,yDAAyD;IAC3D,CAAC;IACD,IAAI,CAAC;QACH,SAAS,CAAC,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5C,aAAa,CAAC,SAAS,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACvG,CAAC;IAAC,MAAM,CAAC;QACP,8CAA8C;IAChD,CAAC;AACH,CAAC"}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@invinite-org/invinite-data-cli",
-  "version": "3.0.0",
+  "version": "4.1.0",
   "type": "module",
-  "description": "CLI for the Invinite Data API",
+  "description": "CLI for the Invinite Data API (v2)",
   "publishConfig": {
     "access": "public"
   },
@@ -27,7 +27,6 @@
   "dependencies": {
     "chalk": "^5.3.0",
     "commander": "^12.1.0",
-    "conf": "^13.0.1",
     "enquirer": "^2.4.1",
     "ora": "^8.1.1",
     "zod": "^3.23.8"

package/dist/src/client/earnings-live.d.ts

@@ -1,194 +0,0 @@
-/**
- * Pure pieces of `invd ws listen --earnings`: the subscribe frame and one step per server
- * frame of IDA's `earnings-calls.live` channel (`src/routes/websocket/types/earningsMessages.ts`).
- */
-export declare const EARNINGS_LIVE_CHANNEL = "earnings-calls.live";
-/** One call (event ID / CIK), or every live call at once (`scope: "all_live"`, keywords required). */
-export type LiveTarget = {
-    event_id: string;
-} | {
-    cik: string;
-} | {
-    scope: 'all_live';
-};
-export declare const KEYWORD_MATCH_MODES: readonly ["exact", "stem"];
-export type KeywordMatch = (typeof KEYWORD_MATCH_MODES)[number];
-export declare const SPEAKER_ROLES: readonly ["executive", "ir_host", "analyst", "operator"];
-export type SpeakerRole = (typeof SPEAKER_ROLES)[number];
-/** Keyword alerts of the subscribe frame (`keywords` required for the global scope). */
-export interface KeywordOptions {
-    keywords: string[];
-    keywordMatch?: KeywordMatch;
-    speakerRoles?: SpeakerRole[];
-    /** Global scope only: companies ranked ≤ N by market cap. */
-    minRank?: number;
-}
-export interface KeywordHit {
-    cik: string;
-    symbol: string;
-    conference_date: string;
-    keyword: string;
-    seq: number;
-    start_ms: number;
-    end_ms: number;
-    text: string;
-    context_before: string;
-    speaker_label: string | null;
-    speaker_name: string | null;
-    speaker_role: string | null;
-    layer: 'live' | 'final';
-    latency_ms: number;
-}
-export interface GuidanceFlash {
-    symbol: string;
-    conference_date: string;
-    seq: number;
-    revision: number;
-    metric: string;
-    metric_normalized: string | null;
-    period_label: string | null;
-    low: number | null;
-    high: number | null;
-    point: number | null;
-    unit: string | null;
-    currency: string | null;
-    source_sentence: string;
-    start_ms: number;
-}
-/**
- * One second of the call's stock (`price_tick`, `prices: true` subscriptions only; ≤ 1 / s, only seconds with a
- * trade) — the API's `WebSocketPriceTickEvent`, field for field.
- */
-export interface PriceTickFrame {
-    type: 'price_tick';
-    subscription_id: string;
-    event_id: string;
-    /** 10-digit CIK. */
-    cik: string;
-    symbol: string;
-    conference_date: string;
-    /** Bar start (ISO, wall time). */
-    at: string;
-    /** Bar start on the transcript clock; null before the call's first audio. */
-    call_ms: number | null;
-    price: number;
-    open: number;
-    high: number;
-    low: number;
-    volume: number;
-    cumulative_volume: number | null;
-    /** The last trade before the call start (a late join: the previous close). */
-    reference_price: number | null;
-    /** vs `reference_price`. */
-    return_bps: number | null;
-    prev_close: number | null;
-    /** vs `prev_close`. */
-    day_return_bps: number | null;
-    source: 'stream' | 'snapshot';
-}
-export interface SpeakerAssignment {
-    speaker_label: string;
-    from_seq: number;
-    to_seq: number | null;
-    name: string;
-    role?: string;
-    title?: string | null;
-    firm?: string | null;
-}
-export interface LiveSegment {
-    seq: number;
-    start_ms: number;
-    speaker_label: string | null;
-    text: string;
-    is_final: boolean;
-}
-export interface LiveState {
-    /** Highest final seq printed (or the `since_seq` asked for): a reconnect resumes after it. */
-    lastSeq: number;
-    eventId: string | null;
-    names: {
-        revision: number;
-        assignments: SpeakerAssignment[];
-    } | null;
-}
-export interface LiveOptions {
-    partials: boolean;
-    names: boolean;
-    /** Global scope: every hit line names its company. */
-    allLive?: boolean;
-}
-export interface LiveStep {
-    state: LiveState;
-    lines: string[];
-    /** A partial to show in place of the previous one (TTY only). */
-    partial?: string;
-    /** Stop: exit code + a closing line. */
-    end?: {
-        code: 0 | 1;
-        message: string;
-    };
-    /** Close the socket and resubscribe through the backoff. */
-    reconnect?: boolean;
-}
-/** `--earnings`: a UUID is an event_id, 1–10 digits a CIK. */
-export declare function parseTarget(value: string): LiveTarget;
-/** `--since-seq`: an integer ≥ -1; default -1 (the whole call from its first final). */
-export declare function parseSinceSeq(value: string | undefined): number;
-/** `--keywords`: 1–20 keywords of 2–64 characters (the API's limits), trimmed and de-duplicated. */
-export declare function parseKeywords(value: string | undefined): string[];
-/** `--keyword-match`: `exact` (default) or `stem`. */
-export declare function parseKeywordMatch(value: string | undefined): KeywordMatch | undefined;
-/** `--speaker-roles`: a comma-separated subset of executive, ir_host, analyst, operator. */
-export declare function parseSpeakerRoles(value: string | undefined): SpeakerRole[] | undefined;
-/** `--min-rank`: a positive integer (market-cap rank). */
-export declare function parseMinRank(value: string | undefined): number | undefined;
-export declare function isAllLive(target: LiveTarget): target is {
-    scope: 'all_live';
-};
-/** What a global subscription receives (the API defaults to keyword hits only; `ws listen` wants the flashes too). */
-export declare const ALL_LIVE_EVENTS: readonly ["keyword_hit", "guidance_flash"];
-/**
- * The subscribe frame. One call: target + `since_seq` + `partials`. Global scope: `scope: "all_live"`
- * carries no call target, no replay, no partials and no prices — only the keyword fields (the API refuses it
- * without keywords, and so does `ws listen`) and `events` = keyword hits + guidance flashes.
- */
-export declare function subscribeFrame(target: LiveTarget, sinceSeq: number, partials: boolean, keywords?: KeywordOptions, prices?: boolean): {
-    min_rank?: number | undefined;
-    events: ("keyword_hit" | "guidance_flash")[];
-    type: string;
-    channel: string;
-    scope: string;
-} | {
-    prices?: boolean | undefined;
-    since_seq: number;
-    partials: boolean;
-    event_id: string;
-    type: string;
-    channel: string;
-} | {
-    prices?: boolean | undefined;
-    since_seq: number;
-    partials: boolean;
-    cik: string;
-    type: string;
-    channel: string;
-};
-export declare function initialLiveState(sinceSeq: number): LiveState;
-/** The assignment of `label` covering `seq` (the latest-starting one wins), else null. */
-export declare function nameFor(assignments: SpeakerAssignment[], label: string | null, seq: number): string | null;
-/** `[m:ss] name: text`, the name from the snapshot, else `Speaker <label>`. */
-export declare function formatSegment(segment: LiveSegment, assignments: SpeakerAssignment[]): string;
-/** One highlighted line per keyword hit: `[m:ss] keyword "x" · speaker: text` (+ the company in the global scope). */
-export declare function formatKeywordHit(hit: KeywordHit, allLive?: boolean): string;
-/** One line per guidance flash: `[m:ss] guidance flash · metric period: value — "sentence"`. */
-export declare function formatGuidanceFlash(flash: GuidanceFlash, allLive?: boolean): string;
-/**
- * One price tick as the in-place line: `[16:32:05 ET · 12:34] AAPL 336.08  +42.5 bp since call  −127.5 bp on day
- * (vol 1,240)` — green / red by the since-call return, dim from the snapshot fallback.
- */
-export declare function formatPriceTick(tick: PriceTickFrame): string;
-export declare function finalTranscriptHint(eventId: string | null): string;
-/** One server frame → the new state and what to print / do. Unknown frames are ignored. */
-export declare function liveStep(state: LiveState, frame: Record<string, any>, opts: LiveOptions): LiveStep;
-/** Frames of the earnings channel (the socket also carries `new_filing` broadcasts and pings). */
-export declare function isEarningsFrame(frame: Record<string, any>): boolean;