@kindgi/cli 0.1.8 → 0.1.9-rc.1

package/dist/exports/plan.d.ts

@@ -0,0 +1,69 @@
+/**
+ * What `kindgi exports create` reads: every kind of record the workspace
+ * holds, with the route it's read from, and every other read route with
+ * why it isn't one. `tests/exports-plan.test.ts` checks both against
+ * `openapi.json`: every `GET` is in exactly one place, so a new read
+ * route fails the test until someone classifies it.
+ *
+ * Each record is written as the route answers it, unchanged, so the API
+ * reference documents the files. A top-level kind's file holds one record
+ * per line. A child kind's line is `{ "parent": { <path params> }, "item": … }`,
+ * so a line never depends on the item carrying its parent's id.
+ */
+/** How a route answers. */
+export type Paging = 
+/** `limit` + `cursor` in, `{ data, nextCursor, hasMore }` out, read to the last page. */
+'cursor'
+/** One answer, `{ data }`, holding every record. */
+ | 'whole'
+/** One answer, one record. */
+ | 'one';
+/** Where a child kind's path parameters come from: each one, the field of the parent's record that fills it. */
+export interface ParentRef {
+    /** The parent kind's name; it comes earlier in the plan. */
+    readonly kind: string;
+    /** Path parameter -> the parent record's field. */
+    readonly params: Readonly<Record<string, string>>;
+}
+/** A kind of record, and how it's read. */
+export interface ExportKind {
+    /** The file's name: `<name>.jsonl`. */
+    readonly name: string;
+    /** The read route, as `openapi.json` writes it. */
+    readonly route: string;
+    readonly paging: Paging;
+    /** For a child kind: its parent, read once for each of the parent's records. */
+    readonly parent?: ParentRef;
+    /** Query parameters sent on every read: what the route leaves out unless asked. */
+    readonly query?: Readonly<Record<string, string>>;
+    /**
+     * Read once for each env name (`GET /v1/environments`) at each scope:
+     * the tenant, each org, each project (with `inherit=false` in `query`,
+     * so nothing is read twice). A child kind is read at its parent's env
+     * and scope.
+     */
+    readonly envScoped?: true;
+    /**
+     * The full record is each item's own route (the list holds a summary):
+     * the file holds what that route answers.
+     */
+    readonly item?: {
+        readonly route: string;
+        readonly params: Readonly<Record<string, string>>;
+    };
+    /** Each record's bytes, written to `<dir>/<id>`. */
+    readonly bytes?: {
+        readonly route: string;
+        readonly params: Readonly<Record<string, string>>;
+        readonly dir: string;
+    };
+    /** Other read routes that answer these same records (each item's own route), so they're read here. */
+    readonly covers?: readonly string[];
+    /** Only a tenant admin reads the whole of it; anyone else reads part of it, or is refused. */
+    readonly admin?: true;
+}
+/** In order: a parent comes before its children. */
+export declare const EXPORT_PLAN: readonly ExportKind[];
+/** The read routes that aren't exported, each with why. */
+export declare const EXCLUDED: Readonly<Record<string, string>>;
+//# sourceMappingURL=plan.d.ts.map

package/dist/exports/plan.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.d.ts","sourceRoot":"","sources":["../../src/exports/plan.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;GAWG;AAEH,2BAA2B;AAC3B,MAAM,MAAM,MAAM;AAChB,yFAAyF;AACvF,QAAQ;AACV,oDAAoD;GAClD,OAAO;AACT,8BAA8B;GAC5B,KAAK,CAAC;AAEV,gHAAgH;AAChH,MAAM,WAAW,SAAS;IACxB,4DAA4D;IAC5D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,mDAAmD;IACnD,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CACnD;AAED,2CAA2C;AAC3C,MAAM,WAAW,UAAU;IACzB,uCAAuC;IACvC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,mDAAmD;IACnD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,gFAAgF;IAChF,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC;IAC5B,mFAAmF;IACnF,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAClD;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC;IAC1B;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;KAAE,CAAC;IAC9F,oDAAoD;IACpD,QAAQ,CAAC,KAAK,CAAC,EAAE;QACf,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;QAClD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,sGAAsG;IACtG,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,8FAA8F;IAC9F,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC;CACvB;AAKD,oDAAoD;AACpD,eAAO,MAAM,WAAW,EAAE,SAAS,UAAU,EAsb5C,CAAC;AAEF,2DAA2D;AAC3D,eAAO,MAAM,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAyDrD,CAAC"}

package/dist/exports/plan.js

@@ -0,0 +1,496 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright (C) 2026 Kindgi Inc.
+const cursor = 'cursor';
+const whole = 'whole';
+/** In order: a parent comes before its children. */
+export const EXPORT_PLAN = [
+    // The tenant and who's in it.
+    { name: 'tenant', route: '/v1/tenant', paging: 'one' },
+    { name: 'orgs', route: '/v1/orgs', paging: cursor, covers: ['/v1/orgs/{orgId}'] },
+    { name: 'projects', route: '/v1/projects', paging: cursor, covers: ['/v1/projects/{projectId}'] },
+    { name: 'teams', route: '/v1/teams', paging: cursor, covers: ['/v1/teams/{teamId}'] },
+    {
+        name: 'team-memberships',
+        route: '/v1/teams/{teamId}/memberships',
+        paging: cursor,
+        parent: { kind: 'teams', params: { teamId: 'id' } },
+        admin: true,
+    },
+    {
+        name: 'team-project-grants',
+        route: '/v1/teams/{teamId}/project-grants',
+        paging: cursor,
+        parent: { kind: 'teams', params: { teamId: 'id' } },
+        admin: true,
+    },
+    {
+        name: 'project-memberships',
+        route: '/v1/projects/{projectId}/memberships',
+        paging: cursor,
+        parent: { kind: 'projects', params: { projectId: 'id' } },
+    },
+    {
+        name: 'sites',
+        route: '/v1/projects/{projectId}/sites',
+        paging: cursor,
+        parent: { kind: 'projects', params: { projectId: 'id' } },
+        query: { includeUnregistered: 'true' },
+        covers: ['/v1/projects/{projectId}/sites/{siteId}'],
+        admin: true,
+    },
+    {
+        name: 'users',
+        route: '/v1/identity/users',
+        paging: cursor,
+        query: { includeUnregistered: 'true', include: 'grants' },
+        covers: ['/v1/identity/users/{userId}', '/v1/identity/users/{userId}/grants'],
+        admin: true,
+    },
+    {
+        name: 'user-sessions',
+        route: '/v1/identity/users/{userId}/sessions',
+        paging: whole,
+        parent: { kind: 'users', params: { userId: 'userId' } },
+        admin: true,
+    },
+    {
+        name: 'user-second-factors',
+        route: '/v1/identity/users/{userId}/second-factor',
+        paging: 'one',
+        parent: { kind: 'users', params: { userId: 'userId' } },
+        admin: true,
+    },
+    {
+        name: 'service-accounts',
+        route: '/v1/service-accounts',
+        paging: cursor,
+        query: { includeUnregistered: 'true' },
+        covers: ['/v1/service-accounts/{serviceAccountId}'],
+        admin: true,
+    },
+    {
+        name: 'api-keys',
+        route: '/v1/tokens',
+        paging: cursor,
+        covers: ['/v1/tokens/{tokenId}'],
+        admin: true,
+    },
+    {
+        name: 'signing-keys',
+        route: '/v1/signing-keys',
+        paging: cursor,
+        query: { includeRevoked: 'true' },
+        covers: ['/v1/signing-keys/{keyId}'],
+    },
+    {
+        name: 'reviewers',
+        route: '/v1/approvals/reviewers',
+        paging: cursor,
+        covers: ['/v1/approvals/reviewers/{reviewerId}'],
+    },
+    {
+        name: 'identity-providers',
+        route: '/v1/auth/providers',
+        paging: whole,
+        covers: ['/v1/auth/providers/{providerId}'],
+    },
+    { name: 'sign-in-settings', route: '/v1/auth/settings', paging: 'one', admin: true },
+    // Settings.
+    { name: 'environments', route: '/v1/environments', paging: cursor, admin: true },
+    { name: 'environment-orders', route: '/v1/environment-orders', paging: cursor, admin: true },
+    {
+        name: 'env',
+        route: '/v1/env',
+        paging: cursor,
+        envScoped: true,
+        query: { inherit: 'false' },
+        covers: ['/v1/env/{name}'],
+    },
+    {
+        name: 'secrets',
+        route: '/v1/secrets',
+        paging: cursor,
+        envScoped: true,
+        query: { inherit: 'false', includeRevoked: 'true' },
+        covers: ['/v1/secrets/{name}'],
+    },
+    {
+        name: 'secret-versions',
+        route: '/v1/secrets/{name}/versions',
+        paging: cursor,
+        parent: { kind: 'secrets', params: { name: 'name' } },
+        envScoped: true,
+        covers: ['/v1/secrets/{name}/versions/{versionId}'],
+    },
+    { name: 'tenant-config', route: '/v1/tenant/config', paging: cursor },
+    // What the packs and the console registered.
+    {
+        name: 'agents',
+        route: '/v1/agents',
+        paging: cursor,
+        query: { includeRetired: 'true' },
+        covers: ['/v1/agents/{agentId}'],
+    },
+    {
+        name: 'agent-versions',
+        route: '/v1/agents/{agentId}/versions',
+        paging: cursor,
+        parent: { kind: 'agents', params: { agentId: 'id' } },
+        query: { includeTombstoned: 'true' },
+        covers: ['/v1/agents/{agentId}/versions/{version}'],
+    },
+    {
+        name: 'agent-live-versions',
+        route: '/v1/agents/{agentId}/live-versions',
+        paging: whole,
+        parent: { kind: 'agents', params: { agentId: 'id' } },
+    },
+    {
+        name: 'agent-promotions',
+        route: '/v1/agents/{agentId}/promotions',
+        paging: cursor,
+        parent: { kind: 'agents', params: { agentId: 'id' } },
+        covers: ['/v1/agents/{agentId}/promotions/{promotionId}'],
+    },
+    {
+        name: 'gate-policies',
+        route: '/v1/gate-policies',
+        paging: cursor,
+        covers: ['/v1/gate-policies/{policyId}'],
+    },
+    {
+        name: 'gate-policy-versions',
+        route: '/v1/gate-policies/{policyId}/versions',
+        paging: whole,
+        parent: { kind: 'gate-policies', params: { policyId: 'id' } },
+        covers: ['/v1/gate-policies/{policyId}/versions/{version}'],
+    },
+    {
+        name: 'flows',
+        route: '/v1/flows',
+        paging: cursor,
+        query: { includeRetired: 'true' },
+        covers: ['/v1/flows/{flowId}'],
+    },
+    {
+        name: 'flow-versions',
+        route: '/v1/flows/{flowId}/versions',
+        paging: cursor,
+        parent: { kind: 'flows', params: { flowId: 'id' } },
+        query: { includeTombstoned: 'true' },
+        covers: ['/v1/flows/{flowId}/versions/{version}'],
+    },
+    {
+        name: 'tools',
+        route: '/v1/tools',
+        paging: cursor,
+        query: { includeRetired: 'true' },
+        covers: ['/v1/tools/{toolId}'],
+    },
+    {
+        name: 'tool-versions',
+        route: '/v1/tools/{toolId}/versions',
+        paging: cursor,
+        parent: { kind: 'tools', params: { toolId: 'id' } },
+        query: { includeTombstoned: 'true' },
+        covers: ['/v1/tools/{toolId}/versions/{version}'],
+    },
+    {
+        name: 'guardrails',
+        route: '/v1/guardrails',
+        paging: cursor,
+        covers: ['/v1/guardrails/{guardrailId}'],
+    },
+    { name: 'blocks', route: '/v1/blocks', paging: cursor, covers: ['/v1/blocks/{blockId}'] },
+    {
+        name: 'block-versions',
+        route: '/v1/blocks/{blockId}/versions',
+        paging: cursor,
+        parent: { kind: 'blocks', params: { blockId: 'id' } },
+        query: { includeTombstoned: 'true' },
+        covers: ['/v1/blocks/{blockId}/versions/{version}'],
+    },
+    { name: 'policies', route: '/v1/policies', paging: cursor, covers: ['/v1/policies/{policyId}'] },
+    {
+        name: 'policy-versions',
+        route: '/v1/policies/{policyId}/versions',
+        paging: cursor,
+        parent: { kind: 'policies', params: { policyId: 'id' } },
+        query: { includeTombstoned: 'true' },
+        covers: ['/v1/policies/{policyId}/versions/{version}'],
+    },
+    {
+        name: 'mcp-endpoints',
+        route: '/v1/mcp/endpoints',
+        paging: cursor,
+        covers: ['/v1/mcp/endpoints/{endpointId}'],
+    },
+    {
+        name: 'capabilities',
+        route: '/v1/capabilities',
+        paging: cursor,
+        covers: ['/v1/capabilities/{capabilityId}'],
+    },
+    {
+        name: 'providers',
+        route: '/v1/providers',
+        paging: cursor,
+        covers: ['/v1/providers/{providerId}'],
+    },
+    {
+        name: 'provider-capabilities',
+        route: '/v1/providers/{providerId}/capabilities',
+        paging: whole,
+        parent: { kind: 'providers', params: { providerId: 'id' } },
+    },
+    {
+        name: 'judge-classes',
+        route: '/v1/judge-classes',
+        paging: cursor,
+        covers: ['/v1/judge-classes/{judgeClassId}'],
+    },
+    {
+        name: 'eval-suites',
+        route: '/v1/eval-suites',
+        paging: cursor,
+        query: { includeRetired: 'true' },
+        covers: ['/v1/eval-suites/{suiteId}'],
+    },
+    {
+        name: 'eval-suite-versions',
+        route: '/v1/eval-suites/{suiteId}/versions',
+        paging: cursor,
+        parent: { kind: 'eval-suites', params: { suiteId: 'id' } },
+        query: { includeTombstoned: 'true' },
+        covers: ['/v1/eval-suites/{suiteId}/versions/{version}'],
+    },
+    {
+        name: 'eval-cases',
+        route: '/v1/eval-suites/{suiteId}/versions/{version}/cases',
+        paging: cursor,
+        parent: { kind: 'eval-suite-versions', params: { suiteId: 'id', version: 'version' } },
+    },
+    {
+        name: 'judging-rules',
+        route: '/v1/projects/{projectId}/judging-rules',
+        paging: cursor,
+        parent: { kind: 'projects', params: { projectId: 'id' } },
+        covers: ['/v1/projects/{projectId}/judging-rules/{ruleId}'],
+    },
+    {
+        name: 'judging-rule-versions',
+        route: '/v1/projects/{projectId}/judging-rules/{ruleId}/versions',
+        paging: cursor,
+        parent: { kind: 'judging-rules', params: { projectId: 'projectId', ruleId: 'ruleId' } },
+    },
+    {
+        name: 'deployments',
+        route: '/v1/deployments',
+        paging: cursor,
+        covers: ['/v1/deployments/{deploymentId}'],
+    },
+    {
+        name: 'schedules',
+        route: '/v1/schedules',
+        paging: cursor,
+        covers: ['/v1/schedules/{triggerId}'],
+    },
+    {
+        name: 'schedule-fires',
+        route: '/v1/schedules/{triggerId}/fires',
+        paging: cursor,
+        parent: { kind: 'schedules', params: { triggerId: 'triggerId' } },
+    },
+    { name: 'webhooks', route: '/v1/webhooks', paging: cursor, covers: ['/v1/webhooks/{triggerId}'] },
+    {
+        name: 'webhook-fires',
+        route: '/v1/webhooks/{triggerId}/fires',
+        paging: cursor,
+        parent: { kind: 'webhooks', params: { triggerId: 'triggerId' } },
+    },
+    {
+        name: 'webhook-endpoints',
+        route: '/v1/webhook-endpoints',
+        paging: cursor,
+        covers: ['/v1/webhook-endpoints/{endpointId}'],
+    },
+    {
+        name: 'webhook-deliveries',
+        route: '/v1/webhook-endpoints/{endpointId}/deliveries',
+        paging: cursor,
+        parent: { kind: 'webhook-endpoints', params: { endpointId: 'endpointId' } },
+    },
+    // What ran, and what came of it.
+    {
+        name: 'runs',
+        route: '/v1/runs',
+        paging: cursor,
+        query: { replays: 'include', include: 'output' },
+        covers: ['/v1/runs/{runId}'],
+    },
+    {
+        name: 'run-journals',
+        route: '/v1/runs/{runId}/journal',
+        paging: cursor,
+        parent: { kind: 'runs', params: { runId: 'id' } },
+    },
+    {
+        name: 'conversations',
+        route: '/v1/conversations',
+        paging: cursor,
+        query: { replays: 'include' },
+        covers: ['/v1/conversations/{conversationId}'],
+    },
+    {
+        name: 'conversation-messages',
+        route: '/v1/conversations/{conversationId}/messages',
+        paging: cursor,
+        parent: { kind: 'conversations', params: { conversationId: 'id' } },
+    },
+    {
+        name: 'approvals',
+        route: '/v1/approvals',
+        paging: cursor,
+        covers: ['/v1/approvals/{approvalId}'],
+        admin: true,
+    },
+    {
+        name: 'memory-facts',
+        route: '/v1/memory/facts',
+        paging: cursor,
+        covers: ['/v1/memory/facts/{factId}'],
+        admin: true,
+    },
+    {
+        name: 'memory-fact-revisions',
+        route: '/v1/memory/facts/{factId}/revisions',
+        paging: whole,
+        parent: { kind: 'memory-facts', params: { factId: 'id' } },
+    },
+    {
+        name: 'memory-erasures',
+        route: '/v1/memory/erasures',
+        paging: cursor,
+        covers: ['/v1/memory/erasures/{erasureId}'],
+    },
+    {
+        name: 'memory-erasure-ledger',
+        route: '/v1/memory/erasures/export',
+        paging: whole,
+        admin: true,
+    },
+    {
+        name: 'proposals',
+        route: '/v1/proposals',
+        paging: cursor,
+        covers: ['/v1/proposals/{proposalId}'],
+    },
+    {
+        name: 'improvement-passes',
+        route: '/v1/improvement-passes',
+        paging: cursor,
+        covers: ['/v1/improvement-passes/{passId}'],
+    },
+    {
+        name: 'provenance',
+        route: '/v1/provenance',
+        paging: cursor,
+        item: { route: '/v1/provenance/{runId}', params: { runId: 'runId' } },
+    },
+    {
+        name: 'judgments',
+        route: '/v1/judgments',
+        paging: cursor,
+        item: { route: '/v1/judgments/{judgmentId}', params: { judgmentId: 'id' } },
+    },
+    {
+        name: 'judging-queue',
+        route: '/v1/projects/{projectId}/judging-queue',
+        paging: cursor,
+        parent: { kind: 'projects', params: { projectId: 'id' } },
+    },
+    { name: 'observations', route: '/v1/observations', paging: cursor },
+    {
+        name: 'eval-runs',
+        route: '/v1/eval-runs',
+        paging: cursor,
+        covers: ['/v1/eval-runs/{runId}'],
+    },
+    {
+        name: 'cost-records',
+        route: '/v1/cost/records',
+        paging: cursor,
+        query: { include: 'rawUsage' },
+        covers: ['/v1/cost/records/{recordId}'],
+    },
+    {
+        name: 'compliance-evidence',
+        route: '/v1/compliance/evidence',
+        paging: cursor,
+        covers: ['/v1/compliance/evidence/{evidenceId}'],
+    },
+    { name: 'sign-ins', route: '/v1/audit/sign-ins', paging: cursor, admin: true },
+    { name: 'access-decisions', route: '/v1/audit/authz', paging: cursor },
+    {
+        name: 'artifacts',
+        route: '/v1/artifacts',
+        paging: cursor,
+        bytes: { route: '/v1/artifacts/{blobId}', params: { blobId: 'blobId' }, dir: 'artifacts' },
+    },
+    { name: 'export-signing-keys', route: '/v1/export-signing-keys', paging: whole },
+];
+/** The read routes that aren't exported, each with why. */
+export const EXCLUDED = {
+    // The server, not the workspace.
+    '/health': 'the server, not the workspace',
+    '/v1/openapi.json': 'the server, not the workspace',
+    '/v1/license': 'the server, not the workspace',
+    '/v1/license/usage': 'the server, not the workspace',
+    '/v1/adapters': 'the server, not the workspace: the adapters the deployment wired at boot',
+    '/v1/adapters/{adapterId}': 'the server, not the workspace: the adapters the deployment wired at boot',
+    '/v1/system/keys': "the server's operator routes",
+    '/v1/system/tenants': "the server's operator routes",
+    '/v1/system/tenants/{tenantId}': "the server's operator routes",
+    '/v1/system/tenants/{tenantId}/admins': "the server's operator routes",
+    '/v1/system/tenants/{tenantId}/limits': "the server's operator routes",
+    '/v1/system/whoami': "the server's operator routes",
+    '/v1/system/deployments': "the server's operator routes",
+    '/v1/system/pack-env': "the server's operator routes",
+    '/v1/system/tenants/{tenantId}/deployments/{deploymentId}/pack-env': "the server's operator routes",
+    // The caller, not the workspace.
+    '/v1/identity/whoami': 'the caller, not the workspace',
+    '/v1/identity/me/permissions': 'the caller, not the workspace',
+    '/v1/identity/me/second-factor': 'the caller, not the workspace',
+    '/v1/auth/sign-in-options': 'the caller, not the workspace',
+    '/v1/auth/providers/{providerId}/sign-in': 'the caller, not the workspace',
+    // Live views of records exported elsewhere.
+    '/v1/runs/{runId}/stream': 'a live view of run-journals',
+    '/v1/runs/{runId}/progress': 'a live view of runs',
+    '/v1/runs/{runId}/progress/stream': 'a live view of runs',
+    '/v1/eval-runs/{runId}/events': 'a live view of eval-runs',
+    '/v1/secrets/{name}/rotations/{rotationId}/events': 'a live view of a rotation',
+    // Computed from records that are exported, not stored.
+    '/v1/runs/failures': 'computed from runs',
+    '/v1/cost/aggregate': 'computed from cost-records',
+    '/v1/agents/{agentId}/live': 'computed from agent-live-versions',
+    '/v1/agents/{agentId}/gate-policy': 'computed from gate-policies',
+    '/v1/guardrails/{guardrailId}/outcomes': 'computed from runs',
+    '/v1/projects/{projectId}/judging-rules/preview': 'computed from judging-rules and runs',
+    '/v1/projects/{projectId}/judging-rules/{ruleId}/results': 'computed from judgments',
+    '/v1/projects/{projectId}/access': 'computed from project-memberships, team-project-grants, orgs and users',
+    '/v1/projects/default': 'one of projects',
+    '/v1/projects/{projectId}/team-grants': 'the same records as team-project-grants',
+    '/v1/environment-orders/tenant': 'the same records as environment-orders',
+    '/v1/environment-orders/orgs/{orgId}': 'the same records as environment-orders',
+    '/v1/providers/{providerId}/check': "a live check of a provider's settings",
+    '/v1/deployments/{deploymentId}/values': 'computed from deployments, tools, agents, providers, secrets and env values',
+    '/v1/retention/scheduled': 'computed from the retention policies and the records',
+    '/v1/deployments/{deploymentId}/pack-env': 'computed from deployments, env and secrets',
+    // Not listed by any route.
+    '/v1/secrets/{name}/rotations/{rotationId}': "read by the id its rotation's request answered; no route lists rotations, and each rotation's versions are in secret-versions",
+    // Read live from another server.
+    '/v1/mcp/endpoints/{endpointId}/resources': "read live from the MCP endpoint's own server",
+    '/v1/mcp/endpoints/{endpointId}/resources/{uri}': "read live from the MCP endpoint's own server",
+    '/v1/mcp/endpoints/{endpointId}/prompts': "read live from the MCP endpoint's own server",
+};
+//# sourceMappingURL=plan.js.map

package/dist/exports/plan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.js","sourceRoot":"","sources":["../../src/exports/plan.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,iCAAiC;AAmEjC,MAAM,MAAM,GAAG,QAAiB,CAAC;AACjC,MAAM,KAAK,GAAG,OAAgB,CAAC;AAE/B,oDAAoD;AACpD,MAAM,CAAC,MAAM,WAAW,GAA0B;IAChD,8BAA8B;IAC9B,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;IACtD,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,kBAAkB,CAAC,EAAE;IACjF,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,0BAA0B,CAAC,EAAE;IACjG,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,oBAAoB,CAAC,EAAE;IACrF;QACE,IAAI,EAAE,kBAAkB;QACxB,KAAK,EAAE,gCAAgC;QACvC,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;QACnD,KAAK,EAAE,IAAI;KACZ;IACD;QACE,IAAI,EAAE,qBAAqB;QAC3B,KAAK,EAAE,mCAAmC;QAC1C,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;QACnD,KAAK,EAAE,IAAI;KACZ;IACD;QACE,IAAI,EAAE,qBAAqB;QAC3B,KAAK,EAAE,sCAAsC;QAC7C,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;KAC1D;IACD;QACE,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,gCAAgC;QACvC,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;QACzD,KAAK,EAAE,EAAE,mBAAmB,EAAE,MAAM,EAAE;QACtC,MAAM,EAAE,CAAC,yCAAyC,CAAC;QACnD,KAAK,EAAE,IAAI;KACZ;IACD;QACE,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,oBAAoB;QAC3B,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,EAAE,mBAAmB,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE;QACzD,MAAM,EAAE,CAAC,6BAA6B,EAAE,oCAAoC,CAAC;QAC7E,KAAK,EAAE,IAAI;KACZ;IACD;QACE,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,sCAAsC;QAC7C,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE;QACvD,KAAK,EAAE,IAAI;KACZ;IACD;QACE,IAAI,EAAE,qBAAqB;QAC3B,KAAK,EAAE,2CAA2C;QAClD,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE;QACvD,KAAK,EAAE,IAAI;KACZ;IACD;QACE,IAAI,EAAE,kBAAkB;QACxB,KAAK,EAAE,sBAAsB;QAC7B,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,EAAE,mBAAmB,EAAE,MAAM,EAAE;QACtC,MAAM,EAAE,CAAC,yCAAyC,CAAC;QACnD,KAAK,EAAE,IAAI;KACZ;IACD;QACE,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,sBAAsB,CAAC;QAChC,KAAK,EAAE,IAAI;KACZ;IACD;QACE,IAAI,EAAE,cAAc;QACpB,KAAK,EAAE,kBAAkB;QACzB,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE;QACjC,MAAM,EAAE,CAAC,0BAA0B,CAAC;KACrC;IACD;QACE,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,yBAAyB;QAChC,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,sCAAsC,CAAC;KACjD;IACD;QACE,IAAI,EAAE,oBAAoB;QAC1B,KAAK,EAAE,oBAAoB;QAC3B,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,CAAC,iCAAiC,CAAC;KAC5C;IACD,EAAE,IAAI,EAAE,kBAAkB,EAAE,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE;IAEpF,YAAY;IACZ,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE;IAChF,EAAE,IAAI,EAAE,oBAAoB,EAAE,KAAK,EAAE,wBAAwB,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE;IAC5F;QACE,IAAI,EAAE,KAAK;QACX,KAAK,EAAE,SAAS;QAChB,MAAM,EAAE,MAAM;QACd,SAAS,EAAE,IAAI;QACf,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE;QAC3B,MAAM,EAAE,CAAC,gBAAgB,CAAC;KAC3B;IACD;QACE,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,aAAa;QACpB,MAAM,EAAE,MAAM;QACd,SAAS,EAAE,IAAI;QACf,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE;QACnD,MAAM,EAAE,CAAC,oBAAoB,CAAC;KAC/B;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,KAAK,EAAE,6BAA6B;QACpC,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;QACrD,SAAS,EAAE,IAAI;QACf,MAAM,EAAE,CAAC,yCAAyC,CAAC;KACpD;IACD,EAAE,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,MAAM,EAAE;IAErE,6CAA6C;IAC7C;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE;QACjC,MAAM,EAAE,CAAC,sBAAsB,CAAC;KACjC;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,KAAK,EAAE,+BAA+B;QACtC,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;QACrD,KAAK,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE;QACpC,MAAM,EAAE,CAAC,yCAAyC,CAAC;KACpD;IACD;QACE,IAAI,EAAE,qBAAqB;QAC3B,KAAK,EAAE,oCAAoC;QAC3C,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;KACtD;IACD;QACE,IAAI,EAAE,kBAAkB;QACxB,KAAK,EAAE,iCAAiC;QACxC,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;QACrD,MAAM,EAAE,CAAC,+CAA+C,CAAC;KAC1D;IACD;QACE,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,mBAAmB;QAC1B,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,8BAA8B,CAAC;KACzC;IACD;QACE,IAAI,EAAE,sBAAsB;QAC5B,KAAK,EAAE,uCAAuC;QAC9C,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE;QAC7D,MAAM,EAAE,CAAC,iDAAiD,CAAC;KAC5D;IACD;QACE,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,WAAW;QAClB,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE;QACjC,MAAM,EAAE,CAAC,oBAAoB,CAAC;KAC/B;IACD;QACE,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,6BAA6B;QACpC,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;QACnD,KAAK,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE;QACpC,MAAM,EAAE,CAAC,uCAAuC,CAAC;KAClD;IACD;QACE,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,WAAW;QAClB,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE;QACjC,MAAM,EAAE,CAAC,oBAAoB,CAAC;KAC/B;IACD;QACE,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,6BAA6B;QACpC,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;QACnD,KAAK,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE;QACpC,MAAM,EAAE,CAAC,uCAAuC,CAAC;KAClD;IACD;QACE,IAAI,EAAE,YAAY;QAClB,KAAK,EAAE,gBAAgB;QACvB,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,8BAA8B,CAAC;KACzC;IACD,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,sBAAsB,CAAC,EAAE;IACzF;QACE,IAAI,EAAE,gBAAgB;QACtB,KAAK,EAAE,+BAA+B;QACtC,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;QACrD,KAAK,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE;QACpC,MAAM,EAAE,CAAC,yCAAyC,CAAC;KACpD;IACD,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,yBAAyB,CAAC,EAAE;IAChG;QACE,IAAI,EAAE,iBAAiB;QACvB,KAAK,EAAE,kCAAkC;QACzC,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE;QACxD,KAAK,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE;QACpC,MAAM,EAAE,CAAC,4CAA4C,CAAC;KACvD;IACD;QACE,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,mBAAmB;QAC1B,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,gCAAgC,CAAC;KAC3C;IACD;QACE,IAAI,EAAE,cAAc;QACpB,KAAK,EAAE,kBAAkB;QACzB,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,iCAAiC,CAAC;KAC5C;IACD;QACE,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,eAAe;QACtB,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,4BAA4B,CAAC;KACvC;IACD;QACE,IAAI,EAAE,uBAAuB;QAC7B,KAAK,EAAE,yCAAyC;QAChD,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE;KAC5D;IACD;QACE,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,mBAAmB;QAC1B,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,kCAAkC,CAAC;KAC7C;IACD;QACE,IAAI,EAAE,aAAa;QACnB,KAAK,EAAE,iBAAiB;QACxB,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE;QACjC,MAAM,EAAE,CAAC,2BAA2B,CAAC;KACtC;IACD;QACE,IAAI,EAAE,qBAAqB;QAC3B,KAAK,EAAE,oCAAoC;QAC3C,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;QAC1D,KAAK,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE;QACpC,MAAM,EAAE,CAAC,8CAA8C,CAAC;KACzD;IACD;QACE,IAAI,EAAE,YAAY;QAClB,KAAK,EAAE,oDAAoD;QAC3D,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE;KACvF;IACD;QACE,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,wCAAwC;QAC/C,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;QACzD,MAAM,EAAE,CAAC,iDAAiD,CAAC;KAC5D;IACD;QACE,IAAI,EAAE,uBAAuB;QAC7B,KAAK,EAAE,0DAA0D;QACjE,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE;KACxF;IACD;QACE,IAAI,EAAE,aAAa;QACnB,KAAK,EAAE,iBAAiB;QACxB,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,gCAAgC,CAAC;KAC3C;IACD;QACE,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,eAAe;QACtB,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,2BAA2B,CAAC;KACtC;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,KAAK,EAAE,iCAAiC;QACxC,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE;KAClE;IACD,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,0BAA0B,CAAC,EAAE;IACjG;QACE,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,gCAAgC;QACvC,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE;KACjE;IACD;QACE,IAAI,EAAE,mBAAmB;QACzB,KAAK,EAAE,uBAAuB;QAC9B,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,oCAAoC,CAAC;KAC/C;IACD;QACE,IAAI,EAAE,oBAAoB;QAC1B,KAAK,EAAE,+CAA+C;QACtD,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,EAAE;KAC5E;IAED,iCAAiC;IACjC;QACE,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE;QAChD,MAAM,EAAE,CAAC,kBAAkB,CAAC;KAC7B;IACD;QACE,IAAI,EAAE,cAAc;QACpB,KAAK,EAAE,0BAA0B;QACjC,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;KAClD;IACD;QACE,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,mBAAmB;QAC1B,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE;QAC7B,MAAM,EAAE,CAAC,oCAAoC,CAAC;KAC/C;IACD;QACE,IAAI,EAAE,uBAAuB;QAC7B,KAAK,EAAE,6CAA6C;QACpD,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE;KACpE;IACD;QACE,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,eAAe;QACtB,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,4BAA4B,CAAC;QACtC,KAAK,EAAE,IAAI;KACZ;IACD;QACE,IAAI,EAAE,cAAc;QACpB,KAAK,EAAE,kBAAkB;QACzB,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,2BAA2B,CAAC;QACrC,KAAK,EAAE,IAAI;KACZ;IACD;QACE,IAAI,EAAE,uBAAuB;QAC7B,KAAK,EAAE,qCAAqC;QAC5C,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;KAC3D;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,KAAK,EAAE,qBAAqB;QAC5B,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,iCAAiC,CAAC;KAC5C;IACD;QACE,IAAI,EAAE,uBAAuB;QAC7B,KAAK,EAAE,4BAA4B;QACnC,MAAM,EAAE,KAAK;QACb,KAAK,EAAE,IAAI;KACZ;IACD;QACE,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,eAAe;QACtB,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,4BAA4B,CAAC;KACvC;IACD;QACE,IAAI,EAAE,oBAAoB;QAC1B,KAAK,EAAE,wBAAwB;QAC/B,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,iCAAiC,CAAC;KAC5C;IACD;QACE,IAAI,EAAE,YAAY;QAClB,KAAK,EAAE,gBAAgB;QACvB,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,EAAE,KAAK,EAAE,wBAAwB,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;KACtE;IACD;QACE,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,eAAe;QACtB,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,EAAE,KAAK,EAAE,4BAA4B,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE;KAC5E;IACD;QACE,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,wCAAwC;QAC/C,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;KAC1D;IACD,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,EAAE;IACnE;QACE,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,eAAe;QACtB,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,uBAAuB,CAAC;KAClC;IACD;QACE,IAAI,EAAE,cAAc;QACpB,KAAK,EAAE,kBAAkB;QACzB,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;QAC9B,MAAM,EAAE,CAAC,6BAA6B,CAAC;KACxC;IACD;QACE,IAAI,EAAE,qBAAqB;QAC3B,KAAK,EAAE,yBAAyB;QAChC,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,sCAAsC,CAAC;KACjD;IACD,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,oBAAoB,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE;IAC9E,EAAE,IAAI,EAAE,kBAAkB,EAAE,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,EAAE;IACtE;QACE,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,eAAe;QACtB,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,EAAE,KAAK,EAAE,wBAAwB,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,WAAW,EAAE;KAC3F;IACD,EAAE,IAAI,EAAE,qBAAqB,EAAE,KAAK,EAAE,yBAAyB,EAAE,MAAM,EAAE,KAAK,EAAE;CACjF,CAAC;AAEF,2DAA2D;AAC3D,MAAM,CAAC,MAAM,QAAQ,GAAqC;IACxD,iCAAiC;IACjC,SAAS,EAAE,+BAA+B;IAC1C,kBAAkB,EAAE,+BAA+B;IACnD,aAAa,EAAE,+BAA+B;IAC9C,mBAAmB,EAAE,+BAA+B;IACpD,cAAc,EAAE,0EAA0E;IAC1F,0BAA0B,EACxB,0EAA0E;IAC5E,iBAAiB,EAAE,8BAA8B;IACjD,oBAAoB,EAAE,8BAA8B;IACpD,+BAA+B,EAAE,8BAA8B;IAC/D,sCAAsC,EAAE,8BAA8B;IACtE,sCAAsC,EAAE,8BAA8B;IACtE,mBAAmB,EAAE,8BAA8B;IACnD,wBAAwB,EAAE,8BAA8B;IACxD,qBAAqB,EAAE,8BAA8B;IACrD,mEAAmE,EACjE,8BAA8B;IAChC,iCAAiC;IACjC,qBAAqB,EAAE,+BAA+B;IACtD,6BAA6B,EAAE,+BAA+B;IAC9D,+BAA+B,EAAE,+BAA+B;IAChE,0BAA0B,EAAE,+BAA+B;IAC3D,yCAAyC,EAAE,+BAA+B;IAC1E,4CAA4C;IAC5C,yBAAyB,EAAE,6BAA6B;IACxD,2BAA2B,EAAE,qBAAqB;IAClD,kCAAkC,EAAE,qBAAqB;IACzD,8BAA8B,EAAE,0BAA0B;IAC1D,kDAAkD,EAAE,2BAA2B;IAC/E,uDAAuD;IACvD,mBAAmB,EAAE,oBAAoB;IACzC,oBAAoB,EAAE,4BAA4B;IAClD,2BAA2B,EAAE,mCAAmC;IAChE,kCAAkC,EAAE,6BAA6B;IACjE,uCAAuC,EAAE,oBAAoB;IAC7D,gDAAgD,EAAE,sCAAsC;IACxF,yDAAyD,EAAE,yBAAyB;IACpF,iCAAiC,EAC/B,wEAAwE;IAC1E,sBAAsB,EAAE,iBAAiB;IACzC,sCAAsC,EAAE,yCAAyC;IACjF,+BAA+B,EAAE,wCAAwC;IACzE,qCAAqC,EAAE,wCAAwC;IAC/E,kCAAkC,EAAE,uCAAuC;IAC3E,uCAAuC,EACrC,6EAA6E;IAC/E,yBAAyB,EAAE,sDAAsD;IACjF,yCAAyC,EAAE,4CAA4C;IACvF,2BAA2B;IAC3B,2CAA2C,EACzC,+HAA+H;IACjI,iCAAiC;IACjC,0CAA0C,EAAE,8CAA8C;IAC1F,gDAAgD,EAAE,8CAA8C;IAChG,wCAAwC,EAAE,8CAA8C;CACzF,CAAC"}

package/dist/exports/reader.d.ts

@@ -0,0 +1,48 @@
+/**
+ * The reads `kindgi exports create` makes, straight over HTTP: each answer
+ * is written as the route gives it, so there's nothing for a typed client
+ * to add (as `deploy/post.ts` sends its `POST` itself).
+ *
+ * - A `429` with a `Retry-After` is waited out and sent again, as the
+ *   commands that publish do (`rate-limit-wait.ts`).
+ * - A `5xx`, or no answer at all, is sent again `SERVER_ERROR_RETRIES`
+ *   times, after 1s, 2s, then 4s.
+ * - Anything else that isn't a `200` is a `ReadError`, with the status and
+ *   the code the server named.
+ */
+import { Readable } from 'node:stream';
+import type { RateLimitWaitContext } from '../rate-limit-wait.js';
+/** How many records a page asks for. */
+export declare const PAGE_SIZE = 100;
+/** How many times a `5xx`, or no answer, is sent again. */
+export declare const SERVER_ERROR_RETRIES = 3;
+/** A read the server refused, or that never got an answer (`status` absent). */
+export declare class ReadError extends Error {
+    readonly status?: number | undefined;
+    readonly code?: string | undefined;
+    constructor(message: string, status?: number | undefined, code?: string | undefined);
+}
+export interface ReaderOptions extends RateLimitWaitContext {
+    readonly fetch: typeof fetch;
+    readonly apiUrl: string;
+    readonly token: string;
+    /** The pause before sending a `5xx` again. Default: a timer that Ctrl+C ends. */
+    readonly pause?: (ms: number, signal?: AbortSignal) => Promise<void>;
+}
+export type Query = Readonly<Record<string, string>>;
+export interface Reader {
+    /** One record. */
+    one(path: string, query?: Query): Promise<unknown>;
+    /** A list answered whole: `{ data }`. */
+    whole(path: string, query?: Query): Promise<readonly unknown[]>;
+    /** A list read page by page, to its last page. */
+    pages(path: string, query?: Query): AsyncGenerator<unknown>;
+    /** A record's bytes. */
+    bytes(path: string): Promise<Readable>;
+    /** A `POST` with a JSON body; its JSON answer. */
+    post(path: string, body: unknown, idempotencyKey: string): Promise<unknown>;
+}
+/** A route with its path parameters filled in, each one encoded. */
+export declare function fillRoute(route: string, values: Readonly<Record<string, string>>): string;
+export declare function createReader(options: ReaderOptions): Reader;
+//# sourceMappingURL=reader.d.ts.map

package/dist/exports/reader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reader.d.ts","sourceRoot":"","sources":["../../src/exports/reader.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAIvC,OAAO,KAAK,EAAoB,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAEpF,wCAAwC;AACxC,eAAO,MAAM,SAAS,MAAM,CAAC;AAE7B,2DAA2D;AAC3D,eAAO,MAAM,oBAAoB,IAAI,CAAC;AAEtC,gFAAgF;AAChF,qBAAa,SAAU,SAAQ,KAAK;IAGhC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM;IACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM;gBAFtB,OAAO,EAAE,MAAM,EACN,MAAM,CAAC,EAAE,MAAM,YAAA,EACf,IAAI,CAAC,EAAE,MAAM,YAAA;CAKzB;AAED,MAAM,WAAW,aAAc,SAAQ,oBAAoB;IACzD,QAAQ,CAAC,KAAK,EAAE,OAAO,KAAK,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,iFAAiF;IACjF,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACtE;AAED,MAAM,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AASrD,MAAM,WAAW,MAAM;IACrB,kBAAkB;IAClB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACnD,yCAAyC;IACzC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,SAAS,OAAO,EAAE,CAAC,CAAC;IAChE,kDAAkD;IAClD,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IAC5D,wBAAwB;IACxB,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACvC,kDAAkD;IAClD,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC7E;AAED,oEAAoE;AACpE,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,MAAM,CAMzF;AAED,wBAAgB,YAAY,CAAC,OAAO,EAAE,aAAa,GAAG,MAAM,CA4F3D"}