@calmlens/sdk 0.5.0 → 0.7.0

package/esm/testing.d.ts

@@ -1,19 +1,31 @@
-import { A as GetEventsResponse, D as GetAssetChildrenResponse, F as Folder, N as AssetBinaryPayloadInput, O as GetAssetResponse, P as Lens, S as SubmitAssetOptions, T as UploadAssetPartOptions, U as Asset, W as AssetStatus, a as CreateAssetSignedUrlOptions, b as RetrieveAssetOptions, c as EnsureLensOptions, d as ListAssetChildrenOptions, f as ListAssetsOptions, g as MoveFolderOptions, h as MoveAssetOptions, i as CdnServeOptions, j as PostAssetSignedUrlResponse, k as GetAssetsPageResponse, l as EnsureLensesOptions, m as ModerateTextOptions, n as CalmLensClientOptions, o as CreateFolderOptions, p as ListEventsOptions, r as CdnAssetUrlOptions, u as FolderIdOptions, w as UpdateFolderOptions, x as RetryAssetOptions } from "./CalmLensTypes-DG_kHVqY.js";
+import { A as GetEventsResponse, C as UpdateAssetOptions, D as GetAssetChildrenResponse, F as Folder, G as AssetStatus, N as AssetBinaryPayloadInput, O as GetAssetResponse, P as Lens, S as SubmitAssetOptions, T as UploadAssetPartOptions, W as Asset, a as CreateAssetSignedUrlOptions, b as RetrieveAssetOptions, c as EnsureLensOptions, d as ListAssetChildrenOptions, f as ListAssetsOptions, g as MoveFolderOptions, h as MoveAssetOptions, i as CdnServeOptions, j as PostAssetSignedUrlResponse, k as GetAssetsPageResponse, l as EnsureLensesOptions, m as ModerateTextOptions, n as CalmLensClientOptions, o as CreateFolderOptions, p as ListEventsOptions, r as CdnAssetUrlOptions, u as FolderIdOptions, w as UpdateFolderOptions, x as RetryAssetOptions } from "./CalmLensTypes-BpmT60j-.js";
 import * as zod from "zod";
 //#region ../shared/src/Permissions.d.ts
 declare const GRANT_SCHEMA: zod.ZodObject<{
   actions: zod.ZodArray<zod.ZodEnum<{
+    "api-keys:read": "api-keys:read";
+    "api-keys:write": "api-keys:write";
     "assets:create": "assets:create";
     "assets:delete": "assets:delete";
     "assets:download": "assets:download";
     "assets:read": "assets:read";
     "assets:share": "assets:share";
     "assets:update": "assets:update";
+    "connectors:read": "connectors:read";
+    "connectors:write": "connectors:write";
     "folders:create": "folders:create";
     "folders:delete": "folders:delete";
     "folders:read": "folders:read";
     "folders:update": "folders:update";
+    "lenses:read": "lenses:read";
+    "lenses:write": "lenses:write";
+    "members:read": "members:read";
+    "members:write": "members:write";
+    "metadata:read": "metadata:read";
+    "metadata:write": "metadata:write";
     "project:manage": "project:manage";
+    "settings:read": "settings:read";
+    "settings:write": "settings:write";
   }>>;
   folderId: zod.ZodNullable<zod.ZodString>;
   includeSubfolders: zod.ZodBoolean;
@@ -92,9 +104,21 @@ interface MockCalmLensClientOptions extends CalmLensClientOptions {
     queuedStatus?: AssetStatus;
     analyzedStatus?: AssetStatus;
     signedUrlBaseUrl?: string;
-    cdnBaseUrl?: string;
   };
 }
+/** A `MockCalmLensClient` method, named like its path on the client. */
+type MockCalmLensOperation = "assets.list" | "assets.retrieve" | "assets.update" | "assets.listChildren" | "assets.create" | "assets.moderate" | "assets.uploadPart" | "assets.createSignedUrl" | "assets.move" | "assets.retry" | "text.moderate" | "cdn.serve" | "events.list" | "folders.list" | "folders.retrieve" | "folders.create" | "folders.update" | "folders.delete" | "folders.move" | "ensureLens" | "ensureLenses";
+/** One recorded call: the method and the options object it was given, exactly as passed. */
+interface MockCalmLensCall {
+  operation: MockCalmLensOperation;
+  options: unknown;
+}
+/**
+ * What a simulated request failure throws: `"transport-error"` and `"timeout"` throw the same
+ * `CalmLensError` the real client throws for a network failure (`sdk/transport-error`) or a
+ * deadline (`sdk/timeout`); any `Error` is thrown as given.
+ */
+type MockRequestFailure = "transport-error" | "timeout" | Error;
 export declare class MockCalmLensClient {
   private readonly options;
   readonly databaseStorage: MockDatabaseStorage;
@@ -107,10 +131,24 @@ export declare class MockCalmLensClient {
   private readonly signedUrlBaseUrl;
   private readonly cdnBaseUrl;
   private readonly lenses;
+  private readonly pendingFailures;
+  /** Every call made through this client, oldest first. */
+  readonly calls: MockCalmLensCall[];
+  /** Accepts the same options as `CalmLensClient` (validated the same way), plus `mockOptions`. */
   constructor(options: MockCalmLensClientOptions);
+  /**
+   * Makes the next call (or the next call to `operation`) throw `failure` instead of running,
+   * as if the request never completed. Queue several to fail several calls in a row.
+   */
+  failNextRequest(failure?: MockRequestFailure, { operation }?: {
+    operation?: MockCalmLensOperation;
+  }): void;
+  /** Calls recorded for one operation, oldest first. */
+  callsTo(operation: MockCalmLensOperation): MockCalmLensCall[];
+  private begin;
   get cdn(): {
     getAssetUrl: ({ assetIdentifier, ...options }: CdnAssetUrlOptions) => string;
-    serve: ({ assetIdentifier, ...options }: CdnServeOptions) => Promise<Response>;
+    serve: (serveOptions: CdnServeOptions) => Promise<Response>;
   };
   get events(): {
     /** The mock does not record events; it always returns an empty page at "now". */
@@ -121,29 +159,32 @@ export declare class MockCalmLensClient {
   };
   get assets(): {
     list: (options: ListAssetsOptions) => Promise<GetAssetsPageResponse>;
-    retrieve: ({ assetId }: RetrieveAssetOptions) => Promise<GetAssetResponse>;
-    listChildren: ({ assetId, ...options }: ListAssetChildrenOptions) => Promise<GetAssetChildrenResponse>;
+    retrieve: (options: RetrieveAssetOptions) => Promise<GetAssetResponse>;
+    listChildren: (childrenOptions: ListAssetChildrenOptions) => Promise<GetAssetChildrenResponse>;
+    update: (options: UpdateAssetOptions) => Promise<Asset>;
     create: (options: SubmitAssetOptions) => Promise<Asset>;
     moderate: (options: SubmitAssetOptions) => Promise<Asset>;
-    uploadPart: ({ assetId, part }: UploadAssetPartOptions) => Promise<Asset>;
-    createSignedUrl: ({ assetId, ...options }: CreateAssetSignedUrlOptions) => Promise<PostAssetSignedUrlResponse>;
-    move: ({ assetId, folderId }: MoveAssetOptions) => Promise<Asset>;
-    retry: ({ assetId }: RetryAssetOptions) => Promise<Asset>;
+    uploadPart: (options: UploadAssetPartOptions) => Promise<Asset>;
+    createSignedUrl: (signedUrlOptions: CreateAssetSignedUrlOptions) => Promise<PostAssetSignedUrlResponse>;
+    move: (options: MoveAssetOptions) => Promise<Asset>;
+    retry: (options: RetryAssetOptions) => Promise<Asset>;
   };
   get folders(): {
     list: () => Promise<Folder[]>;
-    retrieve: ({ folderId }: FolderIdOptions) => Promise<Folder>;
+    retrieve: (options: FolderIdOptions) => Promise<Folder>;
     create: (options: CreateFolderOptions) => Promise<Folder>;
-    update: ({ folderId, ...body }: UpdateFolderOptions) => Promise<Folder>;
-    delete: ({ folderId }: FolderIdOptions) => Promise<void>;
-    move: ({ folderId, parentId }: MoveFolderOptions) => Promise<Folder>;
+    update: (options: UpdateFolderOptions) => Promise<Folder>;
+    delete: (options: FolderIdOptions) => Promise<void>;
+    move: (options: MoveFolderOptions) => Promise<Folder>;
   };
   ensureLens(options: EnsureLensOptions): Promise<Lens>;
-  ensureLenses({ lenses }: EnsureLensesOptions): Promise<Lens[]>;
+  private ensureLensDefinition;
+  ensureLenses(options: EnsureLensesOptions): Promise<Lens[]>;
+  private moderateAsset;
   private createAsset;
   private resolveFolder;
   private assertUniqueFolderName;
   private getSizeInBytes;
 }
 //#endregion
-export type { MockCalmLensClientOptions, MockDatabaseStorage, MockImageStorage, MockStoredContent };
+export type { MockCalmLensCall, MockCalmLensClientOptions, MockCalmLensOperation, MockDatabaseStorage, MockImageStorage, MockRequestFailure, MockStoredContent };