primitive-admin 1.2.0-alpha.4 → 1.2.0-alpha.5

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

@@ -134,51 +134,11 @@ export interface ParsedErrorResponse {
 export declare function parseErrorResponse(response: {
     status: number;
 }, text: string, path?: string): ParsedErrorResponse;
-/**
- * Typed exception classes for the database-schema feature (issue #666).
- * Each maps 1:1 to a server `code` value emitted from the op-edit or
- * schema-edit gate. They all extend ApiError so existing catch-all paths
- * continue to work; specialized catch blocks can branch on `instanceof`.
- *
- * Per round-2 addendum A1, `details` is always preserved so callers can
- * extract structured offender lists (refs[], operations[], etc.).
- */
-export declare class SchemaRequiredError extends ApiError {
-    constructor(message: string, details?: Record<string, any>);
-}
-export declare class OperationRefError extends ApiError {
-    constructor(message: string, details?: Record<string, any>);
-    get refs(): Array<{
-        ref: string;
-        location: string;
-    }>;
-}
-export declare class SchemaBreaksOpsError extends ApiError {
-    constructor(message: string, details?: Record<string, any>);
-    get operations(): Array<{
-        operation: string;
-        refs: Array<{
-            ref: string;
-            location: string;
-        }>;
-    }>;
-}
-export declare class SchemaHasUncheckableOpsError extends ApiError {
-    constructor(message: string, details?: Record<string, any>);
-    get operations(): Array<{
-        operation: string;
-        locations: string[];
-    }>;
-}
 export declare class TomlParseError extends ApiError {
     constructor(message: string, details?: Record<string, any>);
     get line(): number | undefined;
     get column(): number | undefined;
 }
-export declare class OpsExistError extends ApiError {
-    constructor(message: string, details?: Record<string, any>);
-    get opCount(): number;
-}
 interface EmailTemplateSummary {
     emailType: string;
     label: string;
@@ -515,35 +475,6 @@ export interface DatabaseBatchOperation {
      */
     condition?: Record<string, any>;
 }
-/**
- * Normalize a `databases operations execute` result to the CLI's one list
- * envelope — but only when the result is a Durable Object query page
- * (issue #2440).
- *
- * A registered operation is a list only sometimes. Of the shapes the server's
- * operation dispatch can return, exactly two carry a top-level `data` array: a
- * bare `query` and a `pipeline` whose `returnField` names a query step. A
- * `count` (`{ count }`), an `aggregate` (`{ result }`), a mutation
- * (`{ results }`), an `applyToQuery` (`{ matched, affected, failed, … }`) and a
- * `returnField: "all"` pipeline (`{ steps: { … } }`) do not, so blanket
- * normalization would corrupt them. This helper therefore tests the shape
- * first and passes everything else through byte-for-byte — including the
- * nested steps of a `returnField: "all"` pipeline, which are operation-defined
- * objects the CLI must not reach into.
- *
- * Deliberately narrow, not a general-purpose predicate: the contract is
- * specifically "an operations-execute result may be a DO query page".
- * `executeDatabaseOperation()` is the only caller.
- *
- * The conversion itself is delegated to `normalizeCliListEnvelope()` so cursor
- * handling, `prevCursor` dropping and `hasMore` derivation have exactly one
- * implementation. That helper throws on an unrecognized shape — correct when
- * the payload is supposed to be a list, wrong here, where the payload is the
- * caller's own result — which is why the shape test has to run first. `_timing`
- * (`--timing`) is re-attached afterwards, since it rides alongside the envelope
- * rather than inside it.
- */
-export declare function normalizeDatabaseOperationResult(raw: unknown): unknown;
 export declare class ApiClient {
     /**
      * Loaded on first use (`ensureAuthenticated`), never in a constructor.
@@ -1092,15 +1023,13 @@ export declare class ApiClient {
     }>;
     /**
      * List the live connections the server believes exist for exactly one of a
-     * document, user, or database. Read-only inspection over admin-api. Rows are
+     * document or user. Read-only inspection over admin-api. Rows are
      * per-connection-×-subscription bindings, so `connectionId` is not unique
-     * across rows. `params` on a database-subscription row is caller-defined
-     * bound CEL input — typed `unknown`.
+     * across rows.
      */
     listConnections(appId: string, selector: {
         documentId?: string;
         userId?: string;
-        databaseId?: string;
     }, params?: {
         limit?: number;
         cursor?: string;
@@ -1860,39 +1789,6 @@ export declare class ApiClient {
      * `{ success, id, appliedFields }`.
      */
     patchDatabaseRecord(appId: string, databaseId: string, modelName: string, id: string, data: any): Promise<any>;
-    listDatabaseOperations(appId: string, databaseId: string): Promise<any[]>;
-    /**
-     * Execute a registered operation and, when the result is a query page,
-     * normalize it to the CLI's one list envelope (issue #2440).
-     *
-     * The registered operation decides the response shape, so the normalization
-     * is conditional — see {@link normalizeDatabaseOperationResult}. Everything
-     * else (a `count`, an `aggregate`, a mutation, a `returnField: "all"`
-     * pipeline) is returned exactly as the server sent it.
-     */
-    executeDatabaseOperation(appId: string, databaseId: string, operationName: string, data?: {
-        params?: Record<string, any>;
-        limit?: number;
-        cursor?: string;
-        direction?: number;
-    }, options?: {
-        timing?: boolean;
-    }): Promise<any>;
-    /**
-     * Execute a registered batch (bulk) database operation. Posts a chunk of
-     * items to the canonical `operations/:name/batch` endpoint (the same one the
-     * client library's `executeBatch` uses — NOT the deprecated `import-bulk`
-     * alias). Used by `databases import-csv`.
-     *
-     * @returns `{ imported, failed }` — DO-level write outcome counts. Per-item
-     *   validation/access failures abort the whole chunk with a 4xx (thrown).
-     */
-    executeBatch(appId: string, databaseId: string, operationName: string, batch: Array<{
-        params: Record<string, any>;
-    }>): Promise<{
-        imported: number;
-        failed: number;
-    }>;
     listDatabaseIndexes(appId: string, databaseId: string, modelName?: string): Promise<any>;
     registerDatabaseIndex(appId: string, databaseId: string, data: {
         modelName: string;
@@ -1922,12 +1818,6 @@ 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;
         timestamps?: Record<string, any> | null;
         schema?: string | null;
@@ -1938,24 +1828,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;
         timestamps?: Record<string, any> | null;
         schema?: string | null;
-        pendingOpDeletes?: string[];
-        finalOpNames?: string[];
         metadataManifest?: any;
-        pendingOpUpdates?: Array<{
-            name: string;
-            access?: string | null;
-            params?: Record<string, any> | null;
-        }>;
-        pendingOpUpserts?: Array<Record<string, any>>;
     }, expectedModifiedAt?: string, options?: {
         dryRun?: boolean;
         acceptWarnings?: boolean;
@@ -1964,49 +1840,13 @@ export declare class ApiClient {
         force?: boolean;
     }): Promise<any>;
     /**
-     * Issue #666 Phase 3: ask the server to scaffold a TOML schema from
-     * existing ops + DO field introspection. Read-only — does NOT persist.
+     * Issue #666 Phase 3: ask the server to scaffold a TOML schema from the
+     * type's databases (the models each holds, and their fields). Read-only —
+     * does NOT persist.
      */
     scaffoldDatabaseTypeSchema(appId: string, databaseType: string): Promise<{
         schema: string;
     }>;
-    listDatabaseTypeOperations(appId: string, databaseType: string): Promise<any[]>;
-    getDatabaseTypeOperation(appId: string, databaseType: string, name: string): Promise<any>;
-    createDatabaseTypeOperation(appId: string, databaseType: string, data: {
-        name: string;
-        type: string;
-        modelName: string;
-        access?: string | null;
-        definition: Record<string, any>;
-        params?: Record<string, any> | null;
-    }, options?: {
-        dryRun?: boolean;
-        schemaOverride?: string | null;
-        defaultAccess?: string | null;
-        metadataManifestOverride?: Record<string, any> | null;
-    }): Promise<any>;
-    updateDatabaseTypeOperation(appId: string, databaseType: string, name: string, data: Record<string, any>, expectedModifiedAt?: string, options?: {
-        dryRun?: boolean;
-        schemaOverride?: string | null;
-        metadataManifestOverride?: Record<string, any> | null;
-    }): Promise<any>;
-    deleteDatabaseTypeOperation(appId: string, databaseType: string, name: string): Promise<any>;
-    listDatabaseTypeSubscriptions(appId: string, databaseType: string): Promise<any[]>;
-    getDatabaseTypeSubscription(appId: string, databaseType: string, subscriptionKey: string): Promise<any>;
-    createDatabaseTypeSubscription(appId: string, databaseType: string, data: {
-        subscriptionKey: string;
-        displayName: string;
-        modelName: string;
-        filter: string;
-        access: string;
-        description?: string | null;
-        select?: string[] | null;
-        emit?: string[] | null;
-        params?: Record<string, any> | null;
-        status?: string;
-    }): Promise<any>;
-    updateDatabaseTypeSubscription(appId: string, databaseType: string, subscriptionKey: string, data: Record<string, any>, expectedModifiedAt?: string): Promise<any>;
-    deleteDatabaseTypeSubscription(appId: string, databaseType: string, subscriptionKey: string): Promise<any>;
     listGroups(appId: string, params?: {
         type?: string;
         limit?: number;
@@ -2233,28 +2073,6 @@ export declare class ApiClient {
      */
     downloadDocumentArtifact(_appId: string, grantedPath: string): Promise<Buffer>;
     importDocumentState(appId: string, documentId: string, stateBase64: string): Promise<any>;
-    /**
-     * Upload one artifact of a large document's import chain (#2816,
-     * behavior 20).
-     *
-     * The bytes travel raw and unmodified: the manifest's digest is over the
-     * STORED bytes, so re-encoding a chunk here would fail its own verification
-     * on install. The query says which artifact it is — the server derives the
-     * key from the document it belongs to, so nothing here composes one.
-     */
-    uploadDocumentChainArtifact(appId: string, documentId: string, query: Record<string, string | number>, body: Buffer): Promise<any>;
-    /** Start installing an uploaded chain (#2816, behavior 20). */
-    installDocumentChain(appId: string, documentId: string, plan: {
-        installId?: string;
-        base: {
-            epoch: number;
-            buildId: string;
-        } | null;
-        overlays: number[];
-        currentEpoch: number;
-    }): Promise<any>;
-    /** How far a document's chain install has got (#2816, behavior 20). */
-    getDocumentChainInstall(appId: string, documentId: string): Promise<any>;
     getDocument(appId: string, documentId: string): Promise<any>;
     /**
      * Delete a document and everything hanging off it (#2756). The server route
@@ -2292,14 +2110,14 @@ export declare class ApiClient {
         limit?: number;
         cursor?: string;
         /** #3764 — the format the caller believes this document has. */
-        documentFormat?: 1 | 2 | 3;
+        documentFormat?: 1 | 3;
     }): 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 | 3;
+        documentFormat?: 1 | 3;
     }): Promise<{
         count: number;
     }>;
@@ -2321,7 +2139,7 @@ export declare class ApiClient {
         groupBy?: string[];
         filter?: Record<string, any>;
     }, extra?: {
-        documentFormat?: 1 | 2 | 3;
+        documentFormat?: 1 | 3;
     }): Promise<{
         result: unknown;
     }>;
@@ -2333,9 +2151,14 @@ export declare class ApiClient {
     /**
      * A record-log document's room (#4306): `GET documents/:id/room` →
      * `{ ok, appId, documentId, documentFormat, room }`, `room` null for a
-     * format that has no record room. App admins only.
+     * format that has no record room. With `refused` (#4310), the answer also
+     * carries a page of that bulk load's refused rows. App admins only.
      */
-    getDocumentRoom(appId: string, documentId: string): Promise<any>;
+    getDocumentRoom(appId: string, documentId: string, query?: {
+        refused?: string;
+        limit?: number;
+        cursor?: string;
+    }): Promise<any>;
     /**
      * A large document's snapshot builds, newest first, one page (#3432).
      * `GET documents/:id/snapshots` → `{ items, hasMore, nextCursor? }`.
@@ -2365,8 +2188,16 @@ export declare class ApiClient {
     }>;
     /** One bulk-load session's status (#3434). */
     getDocumentIngest(appId: string, documentId: string, sessionId: string): Promise<any>;
-    /** Open a bulk-load session on a large document (#3435, criterion 9). */
-    createDocumentIngest(appId: string, documentId: string): Promise<any>;
+    /**
+     * Open a bulk-load session on a large document (#3435, criterion 9). A
+     * record-log (format 3) document's load takes `reserveEpoch`, `mode` and a
+     * refresh's `models` (#4310); `{}` keeps every format's defaults.
+     */
+    createDocumentIngest(appId: string, documentId: string, options?: {
+        reserveEpoch?: "open" | "commit";
+        mode?: "merge" | "refresh";
+        models?: string[];
+    }): Promise<any>;
     /**
      * Upload one chunk of a bulk-load session's artifact (#3435).
      *
@@ -2412,7 +2243,7 @@ export declare class ApiClient {
         data: Record<string, unknown>;
         options?: Record<string, unknown>;
     }, extra?: {
-        documentFormat?: 1 | 2 | 3;
+        documentFormat?: 1 | 3;
     }): Promise<{
         record: unknown;
     }>;
@@ -2425,7 +2256,7 @@ export declare class ApiClient {
         data: Record<string, unknown>;
         options?: Record<string, unknown>;
     }, extra?: {
-        documentFormat?: 1 | 2 | 3;
+        documentFormat?: 1 | 3;
     }): Promise<{
         record: unknown;
     }>;
@@ -2435,7 +2266,7 @@ export declare class ApiClient {
      * a silent no-op per the facade contract. Returns `{ deleted: true }`.
      */
     deleteDocumentRecord(appId: string, documentId: string, modelName: string, recordId: string, extra?: {
-        documentFormat?: 1 | 2 | 3;
+        documentFormat?: 1 | 3;
     }): Promise<{
         deleted: boolean;
     }>;
@@ -2446,7 +2277,7 @@ export declare class ApiClient {
      * `{ applied, added, updated, deleted }`.
      */
     bulkDocumentRecords(appId: string, documentId: string, operations: Array<Record<string, unknown>>, extra?: {
-        documentFormat?: 1 | 2 | 3;
+        documentFormat?: 1 | 3;
     }): Promise<{
         applied: number;
         added: Array<{
@@ -2470,7 +2301,7 @@ export declare class ApiClient {
         documentId?: string;
         tags?: string[];
         createdBy?: string;
-        documentFormat?: 1 | 2 | 3;
+        documentFormat?: 1 | 3;
     }): Promise<any>;
     listDocumentPermissions(appId: string, documentId: string): Promise<any[]>;
     grantDocumentPermission(appId: string, documentId: string, permissions: Array<{