@calmlens/sdk 0.0.0-stage → 0.6.0

package/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/cjs/testing.d.ts

@@ -0,0 +1,190 @@
+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;
+}, zod.core.$strict>;
+type PermissionGrant = zod.infer<typeof GRANT_SCHEMA>;
+//#endregion
+//#region src/testing/MockApiKey.d.ts
+export declare const MOCK_API_KEY_PREFIX = "sk_test_";
+export declare const createMockApiKey: (grants?: PermissionGrant[]) => string;
+//#endregion
+//#region src/testing/MockStorage.d.ts
+interface MockStoredContent {
+  assetId: string;
+  parts: Map<number, Uint8Array>;
+  type?: string;
+}
+interface MockImageStorage {
+  putContent(assetId: string, content: AssetBinaryPayloadInput & {
+    type: string;
+  }): Promise<void>;
+  putPart(assetId: string, part: AssetBinaryPayloadInput & {
+    type?: string;
+    partNumber?: number;
+    isFinal?: boolean;
+  }): Promise<void>;
+  getContent(assetId: string): Promise<MockStoredContent | undefined>;
+  deleteContent(assetId: string): Promise<void>;
+}
+export declare class InMemoryMockImageStorage implements MockImageStorage {
+  private readonly content;
+  putContent(assetId: string, content: AssetBinaryPayloadInput & {
+    type: string;
+  }): Promise<void>;
+  putPart(assetId: string, part: AssetBinaryPayloadInput & {
+    type?: string;
+    partNumber?: number;
+    isFinal?: boolean;
+  }): Promise<void>;
+  getContent(assetId: string): Promise<MockStoredContent | undefined>;
+  deleteContent(assetId: string): Promise<void>;
+}
+interface MockDatabaseStorage {
+  createAsset(asset: Asset): Promise<Asset>;
+  updateAsset(asset: Asset): Promise<Asset>;
+  getAsset(assetId: string): Promise<Asset | undefined>;
+  listAssets(projectId: string): Promise<Asset[]>;
+  deleteAsset(assetId: string): Promise<void>;
+  createFolder?(folder: Folder): Promise<Folder>;
+  updateFolder?(folder: Folder): Promise<Folder>;
+  getFolder?(folderId: string): Promise<Folder | undefined>;
+  listFolders?(projectId: string): Promise<Folder[]>;
+  deleteFolder?(folderId: string): Promise<void>;
+}
+export declare class InMemoryMockDatabaseStorage implements MockDatabaseStorage {
+  private readonly assets;
+  private readonly folders;
+  createAsset(asset: Asset): Promise<Asset>;
+  updateAsset(asset: Asset): Promise<Asset>;
+  getAsset(assetId: string): Promise<Asset | undefined>;
+  listAssets(projectId: string): Promise<Asset[]>;
+  deleteAsset(assetId: string): Promise<void>;
+  createFolder(folder: Folder): Promise<Folder>;
+  updateFolder(folder: Folder): Promise<Folder>;
+  getFolder(folderId: string): Promise<Folder | undefined>;
+  listFolders(projectId: string): Promise<Folder[]>;
+  deleteFolder(folderId: string): Promise<void>;
+}
+//#endregion
+//#region src/testing/MockCalmLensClient.d.ts
+interface MockCalmLensClientOptions extends CalmLensClientOptions {
+  mockOptions?: {
+    databaseStorage?: MockDatabaseStorage;
+    imageStorage?: MockImageStorage;
+    createId?: () => string;
+    now?: () => number;
+    queuedStatus?: AssetStatus;
+    analyzedStatus?: AssetStatus;
+    signedUrlBaseUrl?: 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;
+  readonly imageStorage: MockImageStorage;
+  private readonly createId;
+  private readonly now;
+  private readonly queuedStatus;
+  private readonly analyzedStatus;
+  private readonly apiKeyGrants;
+  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: (serveOptions: CdnServeOptions) => Promise<Response>;
+  };
+  get events(): {
+    /** The mock does not record events; it always returns an empty page at "now". */
+    list: (options?: ListEventsOptions) => Promise<GetEventsResponse>;
+  };
+  get text(): {
+    moderate: (options: ModerateTextOptions) => Promise<Asset>;
+  };
+  get assets(): {
+    list: (options: ListAssetsOptions) => Promise<GetAssetsPageResponse>;
+    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: (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: (options: FolderIdOptions) => Promise<Folder>;
+    create: (options: CreateFolderOptions) => Promise<Folder>;
+    update: (options: UpdateFolderOptions) => Promise<Folder>;
+    delete: (options: FolderIdOptions) => Promise<void>;
+    move: (options: MoveFolderOptions) => Promise<Folder>;
+  };
+  ensureLens(options: EnsureLensOptions): Promise<Lens>;
+  private ensureLensDefinition;
+  ensureLenses(options: EnsureLensesOptions): Promise<Lens[]>;
+  private moderateAsset;
+  private createAsset;
+  private resolveFolder;
+  private assertUniqueFolderName;
+  private getSizeInBytes;
+}
+//#endregion
+export type { MockCalmLensCall, MockCalmLensClientOptions, MockCalmLensOperation, MockDatabaseStorage, MockImageStorage, MockRequestFailure, MockStoredContent };