primitive-admin 1.1.0-alpha.84 → 1.1.0-alpha.86

package/dist/src/lib/api-client.d.ts

@@ -432,6 +432,15 @@ interface PromptAnalyticsSummary {
     medianDurationMs: number;
     p95DurationMs: number;
     totalTokens: number;
+    /**
+     * #3787 — how many of the window's executions reported a cost, and what they
+     * spent. `totalCost` / `avgCost` are `null` (never `0`) when none did, and
+     * `executionsWithCost < executions` means the figures cover part of the
+     * window.
+     */
+    executionsWithCost?: number;
+    totalCost?: number | null;
+    avgCost?: number | null;
 }
 interface TopPromptsResponse {
     windowDays: number;
@@ -518,6 +527,34 @@ export declare class ApiClient {
     put<T = any>(path: string, body?: any): Promise<T>;
     patch<T = any>(path: string, body?: any): Promise<T>;
     delete<T = any>(path: string): Promise<T>;
+    /**
+     * One page of the apps the caller can reach.
+     *
+     * The route paginates cursor-style (default pageSize=25, cap=100). This
+     * method used to walk the whole chain so `primitive apps list` could not
+     * truncate at 25 (#436); since #3646 the page boundary belongs to the
+     * caller instead — `apps list` declares `--limit`/`--cursor` and prints the
+     * `hasMore`/`nextCursor` the server reported, and the aggregate readers that
+     * really do mean "every app" call `listAllApps()`.
+     */
+    listAppsPage(params?: {
+        limit?: number;
+        cursor?: string;
+    }): Promise<{
+        items: Array<{
+            id: string;
+            name: string;
+            role?: string;
+        }>;
+        hasMore?: boolean;
+        nextCursor?: string | null;
+    }>;
+    /**
+     * Every app the caller can reach, cursor chain walked (#436).
+     *
+     * For readers that genuinely need the whole set — an app picker, a sweep —
+     * rather than the one page `apps list` prints.
+     */
     listApps(): Promise<{
         apps: Array<{
             id: string;
@@ -568,8 +605,13 @@ export declare class ApiClient {
         cursor?: string;
     }): Promise<{
         items: any[];
+        hasMore?: boolean;
         nextCursor?: string | null;
     }>;
+    /**
+     * @deprecated Use {@link setUserAvailability} with `"disable"`
+     * (`PUT /admin/api/apps/:appId/users/:userId/disable`) instead (#518).
+     */
     removeUser(appId: string, userId: string): Promise<void>;
     /**
      * #2803 — take a user's access away, or give it back. Distinct from
@@ -642,6 +684,8 @@ export declare class ApiClient {
         limit?: number;
         cursor?: string;
     }): Promise<{
+        items: any[];
+        /** @deprecated Read `items`; `grants` is a legacy alias of it (#1982). */
         grants: any[];
         nextCursor?: string | null;
         hasMore?: boolean;
@@ -653,6 +697,7 @@ export declare class ApiClient {
         limit?: number;
     }): Promise<{
         items: any[];
+        hasMore?: boolean;
         nextCursor?: string | null;
     }>;
     /** Integration detail (#2631: `accessRule` is on the detail, not the list summary). */
@@ -682,7 +727,9 @@ export declare class ApiClient {
         status?: string;
         from?: string;
         to?: string;
-        source?: "user" | "admin" | "test" | "workflow";
+        source?: "user" | "admin" | "test" | "workflow" | "function";
+        /** #3691 — only the calls this run made, workflow run or function run. */
+        runId?: string;
     }): Promise<any[]>;
     listWorkflowRunIntegrationLogs(appId: string, runId: string, params?: {
         limit?: number;
@@ -716,6 +763,7 @@ export declare class ApiClient {
         limit?: number;
     }): Promise<{
         items: any[];
+        hasMore?: boolean;
         nextCursor?: string | null;
     }>;
     getWebhook(appId: string, webhookId: string): Promise<any>;
@@ -939,6 +987,7 @@ export declare class ApiClient {
         cursor?: string;
     }): Promise<{
         items: unknown[];
+        hasMore?: boolean;
         nextCursor?: string | null;
     }>;
     listSessions(appId: string, userId: string, params?: {
@@ -946,6 +995,7 @@ export declare class ApiClient {
         cursor?: string;
     }): Promise<{
         items: unknown[];
+        hasMore?: boolean;
         nextCursor?: string | null;
     }>;
     testWebhook(appId: string, webhookId: string, payload?: any): Promise<any>;
@@ -1045,6 +1095,7 @@ export declare class ApiClient {
         cursor?: string;
     }): Promise<{
         items: any[];
+        hasMore?: boolean;
         nextCursor?: string | null;
     }>;
     getPrompt(appId: string, promptId: string): Promise<any>;
@@ -1144,6 +1195,7 @@ export declare class ApiClient {
         cursor?: string;
     }): Promise<{
         items: any[];
+        hasMore?: boolean;
         nextCursor?: string;
     }>;
     getTestCase(appId: string, blockType: "prompt" | "integration" | "workflow" | "script", blockId: string, testCaseId: string): Promise<any>;
@@ -1222,6 +1274,7 @@ export declare class ApiClient {
         cursor?: string;
     }): Promise<{
         items: any[];
+        hasMore?: boolean;
         nextCursor?: string | null;
     }>;
     getWorkflow(appId: string, workflowId: string): Promise<any>;
@@ -1417,7 +1470,15 @@ export declare class ApiClient {
     listAllAdmins(params?: {
         limit?: number;
         cursor?: string;
-    }): Promise<any>;
+    }): Promise<{
+        items: any[];
+        /** @deprecated Read `items`; `admins` is a legacy alias of it (#1982). */
+        admins: any[];
+        hasMore?: boolean;
+        nextCursor: string | null;
+        /** @deprecated Read `nextCursor`; `cursor` is a legacy alias of it (#1316, #1982). */
+        cursor: string | null;
+    }>;
     searchAdminByEmail(email: string): Promise<any>;
     getAdminApps(email: string): Promise<any>;
     updateAdminSettings(adminId: string, data: {
@@ -1566,9 +1627,22 @@ export declare class ApiClient {
      * `options.owner` narrows the result to the databases that user created; the
      * server resolves it through the `databasesByCreator` index (#1965).
      */
+    /**
+     * One page of an app's databases (#3646).
+     *
+     * `databases list` used to walk the chain here. The route pages, so the page
+     * boundary belongs to the caller: the verb declares `--limit`/`--cursor` and
+     * prints what came back.
+     */
     listDatabases(appId: string, options?: {
         owner?: string;
-    }): Promise<any[]>;
+        limit?: number;
+        cursor?: string;
+    }): Promise<{
+        items: any[];
+        hasMore?: boolean;
+        nextCursor?: string | null;
+    }>;
     createDatabase(appId: string, data: {
         title: string;
         databaseType?: string;
@@ -1583,13 +1657,29 @@ export declare class ApiClient {
      *
      * The HTTP path stays `/metadata` because the wire field name is still
      * `metadata`; only the client/CLI-facing helper names were reframed.
+     *
+     * @deprecated Use resource metadata categories instead (`primitive metadata
+     * get database <id> <category>`, #1420, #1815).
      */
     getDatabaseCelContext(appId: string, databaseId: string): Promise<any>;
-    /** Update a database's CEL context dict (merge with existing). */
+    /**
+     * Update a database's CEL context dict (merge with existing).
+     *
+     * @deprecated Use resource metadata categories instead (`primitive metadata
+     * set database <id> <category>`, #1420, #1815).
+     */
     updateDatabaseCelContext(appId: string, databaseId: string, celContext: Record<string, any>): Promise<any>;
-    /** @deprecated Use {@link getDatabaseCelContext} instead. */
+    /**
+     * @deprecated Database CEL context is deprecated; use resource metadata
+     * categories instead (`primitive metadata get database <id> <category>`,
+     * #1420, #1815).
+     */
     getDatabaseMetadata(appId: string, databaseId: string): Promise<any>;
-    /** @deprecated Use {@link updateDatabaseCelContext} instead. */
+    /**
+     * @deprecated Database CEL context is deprecated; use resource metadata
+     * categories instead (`primitive metadata set database <id> <category>`,
+     * #1420, #1815).
+     */
     updateDatabaseMetadata(appId: string, databaseId: string, metadata: Record<string, any>): Promise<any>;
     listDatabasePermissions(appId: string, databaseId: string): Promise<any[]>;
     addDatabaseManager(appId: string, databaseId: string, userId: string): Promise<any>;
@@ -1723,6 +1813,10 @@ export declare class ApiClient {
         databaseType: string;
         ruleSetId?: string | null;
         triggers?: Record<string, any> | null;
+        /**
+         * @deprecated The TOML `type.celContextAccess` expression. Use resource
+         * metadata categories instead (#1420, #1815).
+         */
         metadataAccess?: string | null;
         defaultAccess?: string | null;
         autoPopulatedFields?: Record<string, any> | null;
@@ -1735,6 +1829,10 @@ export declare class ApiClient {
     updateDatabaseTypeConfig(appId: string, databaseType: string, data: {
         ruleSetId?: string | null;
         triggers?: Record<string, any> | null;
+        /**
+         * @deprecated The TOML `type.celContextAccess` expression. Use resource
+         * metadata categories instead (#1420, #1815).
+         */
         metadataAccess?: string | null;
         defaultAccess?: string | null;
         autoPopulatedFields?: Record<string, any> | null;
@@ -1823,8 +1921,18 @@ export declare class ApiClient {
         description?: string;
     }): Promise<any>;
     deleteGroup(appId: string, groupType: string, groupId: string): Promise<any>;
+    /**
+     * One page of a group's members.
+     *
+     * The route paginates cursor-style (no default limit, cap 200) and reports
+     * the boundary, so `groups members list` carries `--limit`/`--cursor` and
+     * forwards them (#3646) rather than printing a first page that claims to be
+     * the whole membership.
+     */
     listGroupMembers(appId: string, groupType: string, groupId: string, options?: {
         include?: "profiles";
+        limit?: number;
+        cursor?: string;
     }): Promise<{
         items: any[];
         nextCursor?: string;
@@ -1850,6 +1958,7 @@ export declare class ApiClient {
         cursor?: string;
     }): Promise<{
         items: any[];
+        hasMore?: boolean;
         nextCursor?: string | null;
     }>;
     listAllCollections(appId: string, params?: {
@@ -1857,11 +1966,19 @@ export declare class ApiClient {
         cursor?: string;
     }): Promise<{
         items: any[];
+        hasMore?: boolean;
         nextCursor?: string | null;
     }>;
     createCollection(appId: string, data: {
         name: string;
         description?: string;
+        /**
+         * Which rule set governs the collection, and which context it belongs
+         * to. Both are immutable after creation, so a migration has to send them
+         * with the create or never (#3643).
+         */
+        collectionType?: string;
+        contextId?: string;
         initialMetadata?: Record<string, Record<string, unknown>>;
         /**
          * The app user to create the collection FOR (#3641). Honored only for
@@ -1881,6 +1998,7 @@ export declare class ApiClient {
         cursor?: string;
     }): Promise<{
         items: any[];
+        hasMore?: boolean;
         nextCursor?: string | null;
     }>;
     addCollectionDocument(appId: string, collectionId: string, data: {
@@ -2048,6 +2166,16 @@ export declare class ApiClient {
      * describe`. Reuses the existing `GET documents/:id/schema` endpoint.
      */
     getDocumentSchema(appId: string, documentId: string): Promise<any>;
+    /**
+     * The `documentFormat` a records call states, as a query string to APPEND to
+     * a path (#3764).
+     *
+     * `post`, `patch` and `delete` take no params object — only `get` does — so
+     * for every verb but the reads the parameter rides the path. Empty when the
+     * caller states nothing, so an unparameterised call's URL is byte-identical
+     * to what it was.
+     */
+    private documentFormatQuery;
     /**
      * Query records in a document model (issue #1964 Phase 3). Reuses the
      * server-side `GET documents/:id/records/:model` endpoint, which runs
@@ -2062,12 +2190,15 @@ export declare class ApiClient {
         filter?: Record<string, any>;
         limit?: number;
         cursor?: string;
+        /** #3764 — the format the caller believes this document has. */
+        documentFormat?: 1 | 2;
     }): Promise<ListEnvelope>;
     /**
      * Count records in a document model (issue #1964 Phase 3). Returns `{ count }`.
      */
     countDocumentRecords(appId: string, documentId: string, modelName: string, queryOptions?: {
         filter?: Record<string, any>;
+        documentFormat?: 1 | 2;
     }): Promise<{
         count: number;
     }>;
@@ -2088,6 +2219,8 @@ export declare class ApiClient {
         }[];
         groupBy?: string[];
         filter?: Record<string, any>;
+    }, extra?: {
+        documentFormat?: 1 | 2;
     }): Promise<{
         result: unknown;
     }>;
@@ -2171,6 +2304,8 @@ export declare class ApiClient {
         id: string;
         data: Record<string, unknown>;
         options?: Record<string, unknown>;
+    }, extra?: {
+        documentFormat?: 1 | 2;
     }): Promise<{
         record: unknown;
     }>;
@@ -2182,6 +2317,8 @@ export declare class ApiClient {
     patchDocumentRecord(appId: string, documentId: string, modelName: string, recordId: string, body: {
         data: Record<string, unknown>;
         options?: Record<string, unknown>;
+    }, extra?: {
+        documentFormat?: 1 | 2;
     }): Promise<{
         record: unknown;
     }>;
@@ -2190,7 +2327,9 @@ export declare class ApiClient {
      * `DELETE documents/:id/records/:model/:recordId`. A missing record id is
      * a silent no-op per the facade contract. Returns `{ deleted: true }`.
      */
-    deleteDocumentRecord(appId: string, documentId: string, modelName: string, recordId: string): Promise<{
+    deleteDocumentRecord(appId: string, documentId: string, modelName: string, recordId: string, extra?: {
+        documentFormat?: 1 | 2;
+    }): Promise<{
         deleted: boolean;
     }>;
     /**
@@ -2199,7 +2338,9 @@ export declare class ApiClient {
      * a validation failure commits nothing. Returns the facade's
      * `{ applied, added, updated, deleted }`.
      */
-    bulkDocumentRecords(appId: string, documentId: string, operations: Array<Record<string, unknown>>): Promise<{
+    bulkDocumentRecords(appId: string, documentId: string, operations: Array<Record<string, unknown>>, extra?: {
+        documentFormat?: 1 | 2;
+    }): Promise<{
         applied: number;
         added: Array<{
             model: string;
@@ -2236,6 +2377,14 @@ export declare class ApiClient {
         userId?: string;
         email?: string;
     }): Promise<any>;
+    /**
+     * Resolve a NAMED user's effective access to a document (#3658).
+     *
+     * The admin token is admitted to name a subject (it can already read every
+     * grant, group permission and membership the answer derives from), which is
+     * what makes this an operator read rather than a per-user one.
+     */
+    validateDocumentAccessForUser(appId: string, documentId: string, userId: string): Promise<any>;
     getDocumentLinkAccess(appId: string, documentId: string): Promise<any>;
     setDocumentLinkAccess(appId: string, documentId: string, level: "reader" | "read-write"): Promise<any>;
     clearDocumentLinkAccess(appId: string, documentId: string): Promise<any>;
@@ -2287,6 +2436,25 @@ export declare class ApiClient {
      * `{ documents }` array and no cursor: that reads as a single page.
      */
     listAdminDocuments(appId: string, userId: string): Promise<any[]>;
+    /**
+     * One page of the admin inventory of a user's documents (#3646).
+     *
+     * `documents list --user-id` prints exactly this — the page the caller's
+     * `--limit`/`--cursor` asked for, with the server's own page boundary
+     * beside it. `documents export-all`, which really does mean every document,
+     * keeps the walking `listAdminDocuments()` above.
+     *
+     * Tolerant of a pre-contract server, which answers with a bare
+     * `{ documents }` array and no cursor: that reads as a single page.
+     */
+    listAdminDocumentsPage(appId: string, userId: string, options?: {
+        limit?: number;
+        cursor?: string;
+    }): Promise<{
+        items: any[];
+        hasMore?: boolean;
+        nextCursor?: string | null;
+    }>;
     /**
      * The document `AppUser.rootDocId` points at, or null when the user has none
      * yet (#3135). A user who is not a member of the app is a 404, which