@calmlens/sdk 0.11.0 → 0.13.0

package/cjs/testing.d.ts

@@ -1,4 +1,4 @@
-import { $ as TypedEvent, A as ListEventsOptions, B as UpdateAssetOptions, E as Lens, H as UploadAssetPartOptions, J as GetEventsResponse, K as AssetSearchQuery, L as RetrieveAssetOptions, M as MoveAssetOptions, N as MoveFolderOptions, O as ListAssetChildrenOptions, Q as Event, R as RetryAssetOptions, T as IterateAssetsOptions, V as UpdateFolderOptions, X as AssetBinaryPayloadInput, Y as PostAssetSignedUrlResponse, Z as Folder, _ as DeleteAssetContentOptions, a as AssetSearchResponse, b as EnsureLensesOptions, d as CdnAssetUrlOptions, f as CdnServeOptions, h as CreateFolderOptions, i as AssetPage, j as ModerateTextOptions, k as ListAssetsOptions, m as CreateAssetSignedUrlOptions, n as AssetChildrenPage, ot as ClassificationCategory, q as WebhookEventPayload, s as AssetStatus, t as Asset, u as CalmLensClientOptions, v as DeleteAssetOptions, w as IterateAssetChildrenOptions, x as FolderIdOptions, y as EnsureLensOptions, z as SubmitAssetOptions } from "./CalmLensTypes-BZ-nxhr_.js";
+import { $ as SearchAssetsOptions, A as DeleteAssetContentOptions, At as AssetBinaryPayloadInput, B as Lens, C as CdnAssetUrlOptions, D as CreateAssetSignedUrlOptions, G as ModerateTextOptions, H as ListAssetChildrenOptions, K as MoveAssetOptions, M as EnsureLensOptions, N as EnsureLensesOptions, O as CreateFolderOptions, P as FolderIdOptions, Q as RetryAssetOptions, R as IterateAssetChildrenOptions, S as CalmLensServerClientOptions, U as ListAssetsOptions, W as ListEventsOptions, Z as RetrieveAssetOptions, at as UpdateFolderOptions, d as Asset, et as SignUploadTokenOptions, g as AssetSearchResponse, gt as Event, h as AssetPage, ht as Folder, it as UpdateAssetOptions, j as DeleteAssetOptions, mt as PostAssetSignedUrlResponse, ot as UploadAssetPartOptions, p as AssetChildrenPage, pt as GetEventsResponse, q as MoveFolderOptions, r as ClassificationCategory, rt as SubmitAssetOptions, t as WebhookEventPayload, tt as SignedUploadToken, ut as WaitForAssetDecisionOptions, v as AssetStatus, vt as TypedEvent, w as CdnServeOptions, z as IterateAssetsOptions } from "./WebhookPayload-B7CgSmI5.js";
 import * as zod from "zod";
 //#region ../shared/src/TestTriggers.d.ts
 type ClassificationTestSignal = ClassificationCategory | "sexual.involving-minors" | "violence.graphic";
@@ -32,8 +32,12 @@ declare const GRANT_SCHEMA: zod.ZodObject<{
     "metadata:read": "metadata:read";
     "metadata:write": "metadata:write";
     "project:manage": "project:manage";
+    "reviews:read": "reviews:read";
+    "reviews:write": "reviews:write";
     "settings:read": "settings:read";
     "settings:write": "settings:write";
+    "upload-presets:read": "upload-presets:read";
+    "upload-presets:write": "upload-presets:write";
   }>>;
   folderId: zod.ZodNullable<zod.ZodString>;
   includeSubfolders: zod.ZodBoolean;
@@ -102,8 +106,8 @@ export declare class InMemoryMockDatabaseStorage implements MockDatabaseStorage
   deleteFolder(folderId: string): Promise<void>;
 }
 //#endregion
-//#region src/testing/MockCalmLensClient.d.ts
-interface MockCalmLensClientOptions extends CalmLensClientOptions {
+//#region src/testing/MockCalmLensServerClient.d.ts
+interface MockCalmLensServerClientOptions extends CalmLensServerClientOptions {
   mockOptions?: {
     databaseStorage?: MockDatabaseStorage;
     imageStorage?: MockImageStorage;
@@ -116,13 +120,45 @@ interface MockCalmLensClientOptions extends CalmLensClientOptions {
     signedUrlBaseUrl?: string;
   };
 }
-/** A `MockCalmLensClient` method, named like its path on the client. */
-type MockCalmLensOperation = "assets.list" | "assets.search" | "assets.retrieve" | "assets.update" | "assets.listChildren" | "assets.create" | "assets.moderate" | "assets.uploadPart" | "assets.createSignedUrl" | "assets.move" | "assets.retry" | "assets.deleteContent" | "assets.delete" | "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;
+/** The options each `MockCalmLensServerClient` method was given, by operation name. */
+interface MockCalmLensOperationOptions {
+  "assets.list": ListAssetsOptions;
+  "assets.search": SearchAssetsOptions;
+  "assets.retrieve": RetrieveAssetOptions;
+  "assets.update": UpdateAssetOptions;
+  "assets.listChildren": ListAssetChildrenOptions;
+  "assets.create": SubmitAssetOptions;
+  "assets.moderate": SubmitAssetOptions;
+  "assets.uploadPart": UploadAssetPartOptions;
+  "assets.createSignedUrl": CreateAssetSignedUrlOptions;
+  "assets.move": MoveAssetOptions;
+  "assets.retry": RetryAssetOptions;
+  "assets.waitForDecision": WaitForAssetDecisionOptions;
+  "assets.deleteContent": DeleteAssetContentOptions;
+  "assets.delete": DeleteAssetOptions;
+  "text.moderate": ModerateTextOptions;
+  "cdn.serve": CdnServeOptions;
+  "events.list": ListEventsOptions;
+  "folders.list": undefined;
+  "folders.retrieve": FolderIdOptions;
+  "folders.create": CreateFolderOptions;
+  "folders.update": UpdateFolderOptions;
+  "folders.delete": FolderIdOptions;
+  "folders.move": MoveFolderOptions;
+  ensureLens: EnsureLensOptions;
+  ensureLenses: EnsureLensesOptions;
+  "uploadTokens.sign": SignUploadTokenOptions;
 }
+/** A `MockCalmLensServerClient` method, named like its path on the client. */
+type MockCalmLensOperation = keyof MockCalmLensOperationOptions;
+/**
+ * One recorded call: the method and the options object it was given, exactly as passed. Narrow
+ * on `operation` (or use `callsTo`) to get its options type.
+ */
+type MockCalmLensCall<TOperation extends MockCalmLensOperation = MockCalmLensOperation> = { [Operation in TOperation]: {
+  operation: Operation;
+  options: MockCalmLensOperationOptions[Operation];
+}; }[TOperation];
 /**
  * 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
@@ -134,11 +170,11 @@ type MockEventInput = Partial<Omit<TypedEvent, "type">> & {
   type: TypedEvent["type"];
 };
 /**
- * An in-memory stand-in for `CalmLensClient` with the same methods, validation and error
+ * An in-memory stand-in for `CalmLensServerClient` with the same methods, validation and error
  * codes. API errors carry the HTTP status, a `requestId` and response headers like the real
  * client's, so error handling can be tested without a network.
  */
-export declare class MockCalmLensClient {
+export declare class MockCalmLensServerClient {
   readonly databaseStorage: MockDatabaseStorage;
   readonly imageStorage: MockImageStorage;
   private readonly createId;
@@ -149,6 +185,7 @@ export declare class MockCalmLensClient {
   private readonly signedUrlBaseUrl;
   private readonly cdnBaseUrl;
   private readonly projectId;
+  private readonly apiKey;
   private readonly lenses;
   private readonly eventFeed;
   /** The queue mode each open multipart upload was started with, as the API saves it. */
@@ -158,8 +195,8 @@ export declare class MockCalmLensClient {
   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);
+  /** Accepts the same options as `CalmLensServerClient` (validated the same way), plus `mockOptions`. */
+  constructor(options: MockCalmLensServerClientOptions);
   /**
    * 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.
@@ -168,7 +205,7 @@ export declare class MockCalmLensClient {
     operation?: MockCalmLensOperation;
   }): void;
   /** Calls recorded for one operation, oldest first. */
-  callsTo(operation: MockCalmLensOperation): MockCalmLensCall[];
+  callsTo<TOperation extends MockCalmLensOperation>(operation: TOperation): MockCalmLensCall<TOperation>[];
   /**
    * Adds an event to the feed `events.list` reads, as if CalmLens had recorded it. Returns the
    * stored event; pass it to `toWebhookEventPayload` to build a matching webhook body.
@@ -211,9 +248,7 @@ export declare class MockCalmLensClient {
      * description and tags, best match first. Mock scores are 1 for an exact match and 0.5
      * otherwise; `mode` is accepted but there is no semantic search.
      */
-    search: (options: Partial<AssetSearchQuery> & {
-      query: string;
-    }) => Promise<AssetSearchResponse>;
+    search: (options: SearchAssetsOptions) => Promise<AssetSearchResponse>;
     /** Lists assets with the real client's paging, `ordering`, `folderId` and `filter`. */
     list: (options?: ListAssetsOptions) => Promise<AssetPage>;
     iterate: (options?: IterateAssetsOptions) => AsyncGenerator<Asset, void, undefined>;
@@ -228,9 +263,15 @@ export declare class MockCalmLensClient {
     createSignedUrl: (signedUrlOptions: CreateAssetSignedUrlOptions) => Promise<PostAssetSignedUrlResponse>;
     move: (options: MoveAssetOptions) => Promise<Asset>;
     retry: (options: RetryAssetOptions) => Promise<Asset>;
+    /** Waits like the real client, checking the mock's storage for a decision. */
+    waitForDecision: (options: WaitForAssetDecisionOptions) => Promise<Asset>;
     deleteContent: (options: DeleteAssetContentOptions) => Promise<Asset>;
     delete: (options: DeleteAssetOptions) => Promise<void>;
   };
+  /** Signs real upload tokens with the mock's API key, like the real client, without a request. */
+  get uploadTokens(): {
+    sign: (options: SignUploadTokenOptions) => Promise<SignedUploadToken>;
+  };
   get folders(): {
     list: () => Promise<Folder[]>;
     retrieve: (options: FolderIdOptions) => Promise<Folder>;
@@ -265,4 +306,4 @@ export declare const createWebhookHeaders: (options: {
   timestampSeconds?: number;
 }) => Promise<Record<string, string>>;
 //#endregion
-export type { MockCalmLensCall, MockCalmLensClientOptions, MockCalmLensOperation, MockDatabaseStorage, MockEventInput, MockImageStorage, MockRequestFailure, MockStoredContent };
+export type { MockCalmLensCall, MockCalmLensOperation, MockCalmLensOperationOptions, MockCalmLensServerClientOptions, MockDatabaseStorage, MockEventInput, MockImageStorage, MockRequestFailure, MockStoredContent };