canopycms 0.0.68-int.98 → 0.1.0

package/dist/api/client.d.ts

@@ -5,15 +5,18 @@
  * AUTO-GENERATED by scripts/generate-client.ts; do not edit this file manually
  * (changes will be overwritten), edit the generator's templates instead.
  */
-import type { BranchCreateResponse, BranchDeleteResponse, BranchListResponse, BranchResponse, CreateBranchBody, UpdateBranchAccessBody } from './branch.js';
-import type { BranchMergeResponse } from './branch-status.js';
+import { type RequestOptions } from './request-deadline.js';
+export { isApiTimeoutError, WRITE_TIMED_OUT_MESSAGE, type RequestOptions } from './request-deadline.js';
+import type { OperatingMode } from '../operating-mode/types.js';
+import type { BranchDeleteResponse, BranchListItemResponse, BranchListResponse, CreateBranchBody, UpdateBranchAccessBody } from './branch.js';
+import type { BranchMergeResponse, SubmitBranchResponse } from './branch-status.js';
 import type { AddCommentBody, AddCommentResponse, CommentsResponse, ResolveCommentResponse } from './comments.js';
 import type { ContentReadResponse, ContentWriteResponse, ReferenceValidationResponse, RenameEntryBody, RenameEntryResponse, ValidateReferencesBody, WriteContentBody } from './content.js';
 import type { ReferenceOptionsResponse } from './reference-options.js';
 import type { ResolveReferencesBody, ResolveReferencesResponse } from './resolve-references.js';
 import type { DeleteEntryResponse, EntriesResponse } from './entries.js';
 import type { AssetDeleteResponse, AssetsListResponse, FinalizeAssetBody, FinalizeAssetResponse, PresignAssetBody, PresignAssetResponse } from './assets.js';
-import type { GetUserMetadataResponse, ListGroupsResponse, PermissionsResponse, SearchUsersResponse, UpdatePermissionsBody } from './permissions.js';
+import type { BatchGetUserMetadataBody, BatchGetUserMetadataResponse, GetUserMetadataResponse, ListGroupsResponse, PermissionsResponse, SearchUsersResponse, UpdatePermissionsBody } from './permissions.js';
 import type { ExternalGroupsResponse, InternalGroupsResponse, UpdateInternalGroupsBody, UpdateInternalGroupsResponse } from './groups.js';
 import type { UserInfoResponse } from './user.js';
 import type { AddEntryTypeApiResponse, CreateCollectionApiResponse, DeleteCollectionApiResponse, GetCollectionApiResponse, GetSchemaApiResponse, InvalidateSchemaCacheApiResponse, RemoveEntryTypeApiResponse, UpdateCollectionApiResponse, UpdateEntryTypeApiResponse, UpdateOrderApiResponse, UpdateOrderBody } from './schema.js';
@@ -32,14 +35,25 @@ export interface ApiClientOptions {
      */
     trailingSlash?: boolean;
     /**
-     * Called whenever a response comes back 401: the credential is no longer accepted. A
+     * Called whenever a response says the credential is no longer accepted: HTTP 401, or a
+     * handler's body with `status: 401` under the HTTP status `unauthenticatedStatus` chose. A
      * notification, not a retry; the editor's auth gate uses it to show sign-in.
      */
     onUnauthorized?: () => void;
+    /**
+     * The mode this bundle was built for, sent on every request so the server refuses a bundle built
+     * for the other mode (operating-mode/editor-mode-check.ts). Set by the editor from
+     * `config.mode`; a client without it is not checked.
+     * @internal
+     */
+    editorMode?: OperatingMode;
+    /** Called whenever the server refuses `editorMode` (code `EDITOR_MODE_MISMATCH`). @internal */
+    onEditorModeMismatch?: () => void;
 }
 /**
  * Typed client for the CanopyCMS API: one method per endpoint, grouped by namespace, each
- * returning that endpoint's ApiResponse.
+ * returning that endpoint's ApiResponse. Every method takes {@link RequestOptions} last; a call
+ * that outlives its deadline rejects with an `ApiTimeoutError` (request-deadline.ts).
  *
  * @example
  * ```ts
@@ -52,139 +66,145 @@ export declare class CanopyApiClient {
     private fetchFn;
     private trailingSlash;
     private onUnauthorized;
+    private editorMode;
+    private onEditorModeMismatch;
     readonly branches: {
         /** GET /branches */
-        list: () => Promise<BranchListResponse>;
+        list: (options?: RequestOptions) => Promise<BranchListResponse>;
         /** POST /branches */
-        create: (body: CreateBranchBody) => Promise<BranchCreateResponse>;
+        create: (body: CreateBranchBody, options?: RequestOptions) => Promise<BranchListItemResponse>;
         /** DELETE /:branch */
-        delete: (params: Record<string, string>) => Promise<BranchDeleteResponse>;
+        delete: (params: Record<string, string>, options?: RequestOptions) => Promise<BranchDeleteResponse>;
         /** PATCH /:branch/access */
-        updateAccess: (params: Record<string, string>, body: UpdateBranchAccessBody) => Promise<BranchResponse>;
+        updateAccess: (params: Record<string, string>, body: UpdateBranchAccessBody, options?: RequestOptions) => Promise<BranchListItemResponse>;
     };
     readonly workflow: {
         /** POST /:branch/withdraw */
-        withdraw: (params: Record<string, string>) => Promise<BranchResponse>;
+        withdraw: (params: Record<string, string>, options?: RequestOptions) => Promise<BranchListItemResponse>;
         /** POST /:branch/request-changes */
-        requestChanges: (params: Record<string, string>) => Promise<BranchResponse>;
+        requestChanges: (params: Record<string, string>, options?: RequestOptions) => Promise<BranchListItemResponse>;
         /** POST /:branch/approve */
-        approve: (params: Record<string, string>) => Promise<BranchResponse>;
+        approve: (params: Record<string, string>, options?: RequestOptions) => Promise<BranchListItemResponse>;
         /** POST /:branch/mark-merged */
-        markMerged: (params: Record<string, string>) => Promise<BranchMergeResponse>;
+        markMerged: (params: Record<string, string>, options?: RequestOptions) => Promise<BranchMergeResponse>;
         /** GET /:branch/status */
-        getStatus: (params: Record<string, string>) => Promise<BranchResponse>;
+        getStatus: (params: Record<string, string>, options?: RequestOptions) => Promise<BranchListItemResponse>;
         /** POST /:branch/submit */
-        submit: (params: Record<string, string>) => Promise<BranchResponse>;
+        submit: (params: Record<string, string>, options?: RequestOptions) => Promise<SubmitBranchResponse>;
     };
     readonly comments: {
         /** GET /:branch/comments */
-        list: (params: Record<string, string>) => Promise<CommentsResponse>;
+        list: (params: Record<string, string>, options?: RequestOptions) => Promise<CommentsResponse>;
         /** POST /:branch/comments */
-        add: (params: Record<string, string>, body: AddCommentBody) => Promise<AddCommentResponse>;
+        add: (params: Record<string, string>, body: AddCommentBody, options?: RequestOptions) => Promise<AddCommentResponse>;
         /** POST /:branch/comments/:threadId/resolve */
-        resolve: (params: Record<string, string>) => Promise<ResolveCommentResponse>;
+        resolve: (params: Record<string, string>, options?: RequestOptions) => Promise<ResolveCommentResponse>;
     };
     readonly content: {
         /** GET /:branch/content/...path */
-        read: (params: Record<string, string>) => Promise<ContentReadResponse>;
+        read: (params: Record<string, string>, options?: RequestOptions) => Promise<ContentReadResponse>;
         /** PUT /:branch/content/...path */
-        write: (params: Record<string, string>, body: WriteContentBody) => Promise<ContentWriteResponse>;
+        write: (params: Record<string, string>, body: WriteContentBody, options?: RequestOptions) => Promise<ContentWriteResponse>;
         /** POST /:branch/validate-references/...path */
-        validateReferences: (params: Record<string, string>, body: ValidateReferencesBody) => Promise<ReferenceValidationResponse>;
+        validateReferences: (params: Record<string, string>, body: ValidateReferencesBody, options?: RequestOptions) => Promise<ReferenceValidationResponse>;
         /** PATCH /:branch/rename-entry/...path */
-        renameEntry: (params: Record<string, string>, body: RenameEntryBody) => Promise<RenameEntryResponse>;
+        renameEntry: (params: Record<string, string>, body: RenameEntryBody, options?: RequestOptions) => Promise<RenameEntryResponse>;
         /** GET /:branch/reference-options */
-        getReferenceOptions: (params: Record<string, string>) => Promise<ReferenceOptionsResponse>;
+        getReferenceOptions: (params: Record<string, string>, options?: RequestOptions) => Promise<ReferenceOptionsResponse>;
         /** POST /:branch/resolve-references */
-        resolveReferences: (params: Record<string, string>, body: ResolveReferencesBody) => Promise<ResolveReferencesResponse>;
+        resolveReferences: (params: Record<string, string>, body: ResolveReferencesBody, options?: RequestOptions) => Promise<ResolveReferencesResponse>;
     };
     readonly entries: {
         /** GET /:branch/entries */
-        list: (params: Record<string, string>) => Promise<EntriesResponse>;
+        list: (params: Record<string, string>, options?: RequestOptions) => Promise<EntriesResponse>;
         /** DELETE /:branch/entries/...entryPath */
-        delete: (params: Record<string, string>) => Promise<DeleteEntryResponse>;
+        delete: (params: Record<string, string>, options?: RequestOptions) => Promise<DeleteEntryResponse>;
     };
     readonly assets: {
         /** POST /assets/presign */
-        presign: (body: PresignAssetBody) => Promise<PresignAssetResponse>;
+        presign: (body: PresignAssetBody, options?: RequestOptions) => Promise<PresignAssetResponse>;
         /** POST /assets/finalize */
-        finalize: (body: FinalizeAssetBody) => Promise<FinalizeAssetResponse>;
+        finalize: (body: FinalizeAssetBody, options?: RequestOptions) => Promise<FinalizeAssetResponse>;
         /** POST /assets/upload: multipart upload, hand-written because the generic template only knows JSON bodies. */
         uploadProxied: (file: File, options?: {
             filename?: string;
-        }) => Promise<FinalizeAssetResponse>;
+        } & RequestOptions) => Promise<FinalizeAssetResponse>;
         /** GET /assets */
-        list: (params: Record<string, string>) => Promise<AssetsListResponse>;
+        list: (params: Record<string, string>, options?: RequestOptions) => Promise<AssetsListResponse>;
         /** DELETE /assets */
-        delete: (params: Record<string, string>) => Promise<AssetDeleteResponse>;
+        delete: (params: Record<string, string>, options?: RequestOptions) => Promise<AssetDeleteResponse>;
     };
     readonly permissions: {
         /** GET /permissions */
-        get: () => Promise<PermissionsResponse>;
+        get: (options?: RequestOptions) => Promise<PermissionsResponse>;
         /** PUT /permissions */
-        update: (body: UpdatePermissionsBody) => Promise<PermissionsResponse>;
+        update: (body: UpdatePermissionsBody, options?: RequestOptions) => Promise<PermissionsResponse>;
         /** GET /users/search */
-        searchUsers: (params: Record<string, string>) => Promise<SearchUsersResponse>;
+        searchUsers: (params: Record<string, string>, options?: RequestOptions) => Promise<SearchUsersResponse>;
         /** GET /groups */
-        listGroups: () => Promise<ListGroupsResponse>;
+        listGroups: (options?: RequestOptions) => Promise<ListGroupsResponse>;
         /** GET /users/:userId */
-        getUserMetadata: (params: Record<string, string>) => Promise<GetUserMetadataResponse>;
+        getUserMetadata: (params: Record<string, string>, options?: RequestOptions) => Promise<GetUserMetadataResponse>;
+        /** POST /users/batch */
+        batchGetUserMetadata: (body: BatchGetUserMetadataBody, options?: RequestOptions) => Promise<BatchGetUserMetadataResponse>;
     };
     readonly groups: {
         /** GET /groups/internal */
-        getInternal: () => Promise<InternalGroupsResponse>;
+        getInternal: (options?: RequestOptions) => Promise<InternalGroupsResponse>;
         /** PUT /groups/internal */
-        updateInternal: (body: UpdateInternalGroupsBody) => Promise<UpdateInternalGroupsResponse>;
+        updateInternal: (body: UpdateInternalGroupsBody, options?: RequestOptions) => Promise<UpdateInternalGroupsResponse>;
         /** GET /groups/search */
-        searchExternal: (params: Record<string, string>) => Promise<ExternalGroupsResponse>;
+        searchExternal: (params: Record<string, string>, options?: RequestOptions) => Promise<ExternalGroupsResponse>;
     };
     readonly user: {
         /** GET /whoami */
-        whoami: () => Promise<UserInfoResponse>;
+        whoami: (options?: RequestOptions) => Promise<UserInfoResponse>;
     };
     readonly schema: {
         /** GET /:branch/schema */
-        get: (params: Record<string, string>) => Promise<GetSchemaApiResponse>;
+        get: (params: Record<string, string>, options?: RequestOptions) => Promise<GetSchemaApiResponse>;
         /** GET /:branch/schema/collection/...collectionPath */
-        getCollection: (params: Record<string, string>) => Promise<GetCollectionApiResponse>;
+        getCollection: (params: Record<string, string>, options?: RequestOptions) => Promise<GetCollectionApiResponse>;
         /** POST /:branch/schema/collections */
-        createCollection: (params: Record<string, string>, body: CreateCollectionInput) => Promise<CreateCollectionApiResponse>;
+        createCollection: (params: Record<string, string>, body: CreateCollectionInput, options?: RequestOptions) => Promise<CreateCollectionApiResponse>;
         /** PATCH /:branch/schema/collection/...collectionPath */
-        updateCollection: (params: Record<string, string>, body: UpdateCollectionInput) => Promise<UpdateCollectionApiResponse>;
+        updateCollection: (params: Record<string, string>, body: UpdateCollectionInput, options?: RequestOptions) => Promise<UpdateCollectionApiResponse>;
         /** DELETE /:branch/schema/collection/...collectionPath */
-        deleteCollection: (params: Record<string, string>) => Promise<DeleteCollectionApiResponse>;
+        deleteCollection: (params: Record<string, string>, options?: RequestOptions) => Promise<DeleteCollectionApiResponse>;
         /** POST /:branch/schema/entry-types/...collectionPath */
-        addEntryType: (params: Record<string, string>, body: CreateEntryTypeInput) => Promise<AddEntryTypeApiResponse>;
+        addEntryType: (params: Record<string, string>, body: CreateEntryTypeInput, options?: RequestOptions) => Promise<AddEntryTypeApiResponse>;
         /** PATCH /:branch/schema/entry-types/:entryTypeName/...collectionPath */
-        updateEntryType: (params: Record<string, string>, body: UpdateEntryTypeInput) => Promise<UpdateEntryTypeApiResponse>;
+        updateEntryType: (params: Record<string, string>, body: UpdateEntryTypeInput, options?: RequestOptions) => Promise<UpdateEntryTypeApiResponse>;
         /** DELETE /:branch/schema/entry-types/:entryTypeName/...collectionPath */
-        removeEntryType: (params: Record<string, string>) => Promise<RemoveEntryTypeApiResponse>;
+        removeEntryType: (params: Record<string, string>, options?: RequestOptions) => Promise<RemoveEntryTypeApiResponse>;
         /** PATCH /:branch/schema/order/...collectionPath */
-        updateOrder: (params: Record<string, string>, body: UpdateOrderBody) => Promise<UpdateOrderApiResponse>;
+        updateOrder: (params: Record<string, string>, body: UpdateOrderBody, options?: RequestOptions) => Promise<UpdateOrderApiResponse>;
         /** POST /:branch/schema/invalidate-cache */
-        invalidateSchemaCache: (params: Record<string, string>) => Promise<InvalidateSchemaCacheApiResponse>;
+        invalidateSchemaCache: (params: Record<string, string>, options?: RequestOptions) => Promise<InvalidateSchemaCacheApiResponse>;
     };
     readonly admin: {
         /** GET /admin/branch-health */
-        branchHealth: () => Promise<BranchHealthResponse>;
+        branchHealth: (params: Record<string, string>, options?: RequestOptions) => Promise<BranchHealthResponse>;
         /** POST /admin/branch-dirs/:dirName/purge */
-        purgeBranchDir: (params: Record<string, string>) => Promise<PurgeBranchDirResponse>;
+        purgeBranchDir: (params: Record<string, string>, options?: RequestOptions) => Promise<PurgeBranchDirResponse>;
         /** POST /admin/branch-dirs/:dirName/repair-metadata */
-        repairBranchDir: (params: Record<string, string>) => Promise<RepairBranchDirResponse>;
+        repairBranchDir: (params: Record<string, string>, options?: RequestOptions) => Promise<RepairBranchDirResponse>;
         /** POST /admin/branch-dirs/:dirName/repair-content-duplicates */
-        repairContentDuplicates: (params: Record<string, string>) => Promise<RepairContentDuplicatesResponse>;
+        repairContentDuplicates: (params: Record<string, string>, options?: RequestOptions) => Promise<RepairContentDuplicatesResponse>;
         /** GET /admin/status */
-        status: () => Promise<AdminStatusResponse>;
+        status: (options?: RequestOptions) => Promise<AdminStatusResponse>;
         /** GET /admin/tasks/:status */
-        listTasks: (params: Record<string, string>) => Promise<AdminTasksResponse>;
+        listTasks: (params: Record<string, string>, options?: RequestOptions) => Promise<AdminTasksResponse>;
         /** POST /admin/tasks/:taskId/retry */
-        retryTask: (params: Record<string, string>) => Promise<AdminRetryTaskResponse>;
+        retryTask: (params: Record<string, string>, options?: RequestOptions) => Promise<AdminRetryTaskResponse>;
         /** DELETE /admin/tasks/:status/:fileName */
-        deleteTask: (params: Record<string, string>) => Promise<AdminDeleteTaskResponse>;
+        deleteTask: (params: Record<string, string>, options?: RequestOptions) => Promise<AdminDeleteTaskResponse>;
     };
     constructor(options?: ApiClientOptions);
     private buildPath;
+    /** One API call, 429 resends included, under the deadline `timeout` and `options` give it. */
     private request;
+    private send;
 }
 /**
  * Whether `result` was converted from a body no CanopyCMS handler wrote (a proxy or CDN