@calmlens/js-sdk 0.0.0 → 0.0.2

package/cjs/Asset.js

@@ -1,39 +1,209 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ASSET_SCHEMA = exports.ASSET_VISIBILITY_SCHEMA = exports.ASSET_TYPE_SCHEMA = exports.ASSET_STATUS_SCHEMA = void 0;
-var zod = require("zod/v4");
+exports.ASSET_SCHEMA = exports.PROCESSING_OPTIONS_SCHEMA = exports.DOCUMENT_DATA_SCHEMA = exports.IMAGE_DATA_SCHEMA = exports.CHECKSUMS_SCHEMA = exports.ASSET_VISIBILITY_SCHEMA = exports.isMultimediaDocumentMimeType = exports.MULTIMEDIA_DOCUMENT_MIME_TYPES = exports.ASSET_TYPE_SCHEMA = exports.ASSET_STATUS_SCHEMA = void 0;
+var zod = __importStar(require("zod/v4"));
+var zod_meta_1 = require("zod-meta");
 var Classification_1 = require("./Classification");
-var SchemaUtils_1 = require("./SchemaUtils");
+var DocMetaTypes_1 = require("./DocMetaTypes");
+var Workflow_1 = require("./Workflow");
+var ZodUtils_1 = require("./ZodUtils");
 exports.ASSET_STATUS_SCHEMA = zod.enum(["pending", "approved", "rejected", "error"]);
-exports.ASSET_TYPE_SCHEMA = zod.enum(["image", "video", "audio", "document", "website"]);
+exports.ASSET_TYPE_SCHEMA = zod.enum([
+    "image",
+    "video",
+    "audio",
+    "plaintext-document",
+    "multimedia-document",
+    "website",
+    "file",
+]);
+/**
+ * MIME types that are considered multimedia documents
+ * (documents that contain both text and embedded images/media)
+ */
+exports.MULTIMEDIA_DOCUMENT_MIME_TYPES = [
+    "application/pdf",
+    "application/vnd.openxmlformats-officedocument.wordprocessingml.document", // DOCX
+    "application/msword", // DOC
+    "application/rtf", // RTF
+    "application/vnd.oasis.opendocument.text", // ODT
+];
+/**
+ * Checks if a MIME type is a multimedia document
+ */
+var isMultimediaDocumentMimeType = function (mimeType) {
+    return exports.MULTIMEDIA_DOCUMENT_MIME_TYPES.includes(mimeType);
+};
+exports.isMultimediaDocumentMimeType = isMultimediaDocumentMimeType;
 exports.ASSET_VISIBILITY_SCHEMA = zod.enum(["public", "private"]);
-exports.ASSET_SCHEMA = zod.object({
-    id: (0, SchemaUtils_1.primaryUuidField)(),
-    projectId: (0, SchemaUtils_1.uuidField)(),
+exports.CHECKSUMS_SCHEMA = zod.object({
+    md5: zod.string().nullish(),
+    sha1: zod.string().nullish(),
+    sha256: zod.string().nullish(),
+    sha384: zod.string().nullish(),
+    sha512: zod.string().nullish(),
+});
+exports.IMAGE_DATA_SCHEMA = zod.object({
+    perceptualHash: zod.string().nullish(),
+});
+exports.DOCUMENT_DATA_SCHEMA = zod.object({});
+exports.PROCESSING_OPTIONS_SCHEMA = zod
+    .object({
+    keepAfterProcessing: zod
+        .boolean()
+        .nullish()
+        .meta((0, zod_meta_1.metaStore)([
+        (0, DocMetaTypes_1.docPropertyInfo)({
+            description: "Whether to keep the asset after processing",
+            defaultValue: false,
+        }),
+    ])),
+    image: zod
+        .object({
+        ocrEnabled: zod
+            .boolean()
+            .nullish()
+            .meta((0, zod_meta_1.metaStore)([
+            (0, DocMetaTypes_1.docPropertyInfo)({
+                description: "Whether to perform OCR on image assets or images extracted from multimedia documents and websites",
+                defaultValue: false,
+            }),
+        ])),
+    })
+        .nullish(),
+})
+    .nullish();
+exports.ASSET_SCHEMA = zod
+    .object({
+    id: (0, ZodUtils_1.primaryUuidField)(),
+    projectId: (0, ZodUtils_1.uuidField)(),
     sizeInBytes: zod.number().nullish(),
-    userId: (0, SchemaUtils_1.saneStringField)().nullish(),
-    parentId: (0, SchemaUtils_1.uuidField)().nullish(),
-    createdAt: (0, SchemaUtils_1.createdAtField)(),
-    updatedAt: (0, SchemaUtils_1.updatedAtField)(),
-    name: (0, SchemaUtils_1.saneStringField)({
+    userId: (0, ZodUtils_1.saneStringField)().nullish(),
+    parentId: (0, ZodUtils_1.uuidField)().nullish(),
+    createdAt: (0, ZodUtils_1.createdAtField)(),
+    updatedAt: (0, ZodUtils_1.updatedAtField)(),
+    checksums: exports.CHECKSUMS_SCHEMA.nullish(),
+    imageData: exports.IMAGE_DATA_SCHEMA.nullish(),
+    documentData: exports.DOCUMENT_DATA_SCHEMA.nullish(),
+    name: (0, ZodUtils_1.saneStringField)({
         type: "large",
-    }),
-    fileFormat: (0, SchemaUtils_1.saneStringField)().nullish(),
-    fileExtension: (0, SchemaUtils_1.saneStringField)().nullish(),
-    description: (0, SchemaUtils_1.saneStringField)({
+    }).meta((0, zod_meta_1.metaStore)([
+        (0, DocMetaTypes_1.docPropertyInfo)({
+            description: "Name of the asset",
+            placeholder: "my-image.jpg",
+        }),
+    ])),
+    fileFormat: (0, ZodUtils_1.saneStringField)().nullish(),
+    fileExtension: (0, ZodUtils_1.saneStringField)().nullish(),
+    description: (0, ZodUtils_1.saneStringField)({
         type: "large",
-    }).nullish(),
-    externalId: (0, SchemaUtils_1.saneStringField)().nullish(),
-    externalUrl: zod.string().url().nullish(),
-    previewImageId: (0, SchemaUtils_1.saneStringField)().nullish(),
-    storageId: (0, SchemaUtils_1.saneStringField)().nullish(),
-    averageColor: (0, SchemaUtils_1.saneStringField)().nullish(),
+    })
+        .nullish()
+        .meta((0, zod_meta_1.metaStore)([
+        (0, DocMetaTypes_1.docPropertyInfo)({
+            description: "Optional description of the asset",
+            placeholder: "A beautiful landscape image",
+        }),
+    ])),
+    externalId: (0, ZodUtils_1.saneStringField)()
+        .nullish()
+        .meta((0, zod_meta_1.metaStore)([
+        (0, DocMetaTypes_1.docPropertyInfo)({
+            description: "External identifier for the asset",
+            placeholder: "ext-12345",
+        }),
+    ])),
+    externalUrl: zod
+        .string()
+        .url()
+        .nullish()
+        .meta((0, zod_meta_1.metaStore)([
+        (0, DocMetaTypes_1.docPropertyInfo)({
+            description: "External URL associated with the asset",
+            placeholder: "https://example.com/asset",
+        }),
+    ])),
+    previewImageId: (0, ZodUtils_1.saneStringField)().nullish(),
+    storageId: (0, ZodUtils_1.saneStringField)().nullish(),
+    averageColor: (0, ZodUtils_1.saneStringField)().nullish(),
     type: exports.ASSET_TYPE_SCHEMA,
-    previewHash: (0, SchemaUtils_1.saneStringField)().nullish(),
-    metadata: zod.any().nullish(),
-    tags: zod.array((0, SchemaUtils_1.saneStringField)()).nullish(),
+    previewHash: (0, ZodUtils_1.saneStringField)().nullish(),
+    metadata: zod
+        .any()
+        .nullish()
+        .meta((0, zod_meta_1.metaStore)([
+        (0, DocMetaTypes_1.docPropertyInfo)({
+            description: "Custom metadata for the asset",
+        }),
+    ])),
+    tags: zod
+        .array((0, ZodUtils_1.saneStringField)())
+        .nullish()
+        .meta((0, zod_meta_1.metaStore)([
+        (0, DocMetaTypes_1.docPropertyInfo)({
+            description: "Array of tags for the asset",
+            placeholder: '["tag1", "tag2"]',
+        }),
+    ])),
     report: Classification_1.CLASSIFICATION_REPORT_SCHEMA.nullish(),
     status: exports.ASSET_STATUS_SCHEMA,
-    keepAfterProcessing: zod.boolean().nullish(),
-    visibility: exports.ASSET_VISIBILITY_SCHEMA.nullish(),
-});
+    extractedTextId: (0, ZodUtils_1.saneStringField)()
+        .nullish()
+        .meta((0, zod_meta_1.metaStore)([
+        (0, DocMetaTypes_1.docPropertyInfo)({
+            description: "ID of the extracted text content stored in R2 (e.g., from OCR or text extraction)",
+        }),
+    ])),
+    processingOptions: exports.PROCESSING_OPTIONS_SCHEMA,
+    visibility: exports.ASSET_VISIBILITY_SCHEMA.nullish().meta((0, zod_meta_1.metaStore)([
+        (0, DocMetaTypes_1.docPropertyInfo)({
+            description: "Visibility level of the asset",
+            defaultValue: "private",
+        }),
+    ])),
+    storageDeletedAt: zod.number().nullish(),
+    classificationWorkflow: Workflow_1.WORKFLOW_SCHEMA.nullish().meta((0, zod_meta_1.metaStore)([
+        (0, DocMetaTypes_1.docPropertyInfo)({
+            description: "Workflow tracking the classification process for this asset",
+        }),
+    ])),
+})
+    .meta((0, zod_meta_1.metaStore)([
+    (0, DocMetaTypes_1.docPropertyInfo)({
+        description: "An asset in the system",
+        namedType: "Asset",
+    }),
+]));

package/cjs/Auth.d.ts

@@ -0,0 +1,95 @@
+import type { ApiKey } from "./ApiKey";
+import type { Role } from "./Roles";
+import type { User } from "./User";
+export interface UserToken {
+    /**
+     * Always set to https://securetoken.google.com/GOOGLE_CLOUD_PROJECT
+     */
+    iss: string;
+    /**
+     * Always set to GOOGLE_CLOUD_PROJECT
+     */
+    aud: string;
+    /**
+     * The user's unique ID
+     */
+    sub: string;
+    /**
+     * The token issue time, in seconds since epoch
+     */
+    iat: number;
+    /**
+     * The token expiry time, normally 'iat' + 3600
+     */
+    exp: number;
+    /**
+     * The user's unique ID. Must be equal to 'sub'
+     */
+    user_id: string;
+    /**
+     * The time the user authenticated, normally 'iat'
+     */
+    auth_time: number;
+    /**
+     * The sign in provider, only set when the provider is 'anonymous'
+     */
+    provider_id?: "anonymous";
+    /**
+     * The user's primary email
+     */
+    email?: string;
+    /**
+     * The user's email verification status
+     */
+    email_verified?: boolean;
+    /**
+     * The user's primary phone number
+     */
+    phone_number?: string;
+    /**
+     * The user's display name
+     */
+    name?: string;
+    /**
+     * The user's profile photo URL
+     */
+    picture?: string;
+    /**
+     * Information on all identities linked to this user
+     */
+    firebase: any;
+    /**
+     * Custom claims set by the developer
+     */
+    [claim: string]: unknown;
+    /**
+     * @deprecated use `sub` instead
+     */
+    uid?: never;
+}
+export interface BaseAuth {
+    type: "apiKey" | "user";
+    roles: Role[];
+}
+export interface ApiKeyAuth extends BaseAuth {
+    type: "apiKey";
+    apiKey: ApiKey;
+    userId: string | undefined;
+    originalUserId: string | undefined;
+    getUser: () => Promise<User | undefined>;
+    getOriginalUser: () => Promise<User | undefined>;
+}
+export interface UserAuth extends BaseAuth {
+    type: "user";
+    token: Token;
+    idTokenExpiresAt: number;
+    provider: string;
+    userId: string;
+    originalUserId: string;
+    getUser: () => Promise<User>;
+    getOriginalUser: () => Promise<User>;
+}
+export type Auth = ApiKeyAuth | UserAuth;
+export interface Token extends UserToken {
+    roles: Role[];
+}

package/cjs/Auth.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/CalmLensClient.d.ts

@@ -1,4 +1,5 @@
 import type { Asset } from "./Asset";
+import type { GetAssetChildrenQuery, GetAssetChildrenResponse, GetAssetResponse, GetAssetsPageQuery, GetAssetsPageResponse } from "./PublicApiSchemas";
 import type { SubmitAssetOptions } from "./SharedTypes";
 import type { CalmLensClientOptions } from "./CalmLensTypes";
 export default class CalmLensClient {
@@ -27,15 +28,31 @@ export default class CalmLensClient {
      */
     static verifyWebhookSignature(payload: string | object, signatureHex: string, secret: string): Promise<boolean>;
     constructor(options: CalmLensClientOptions);
-    submitAsset(options: SubmitAssetOptions): Promise<Asset>;
-    getAsset(assetId: string): Promise<Asset>;
-    listAssets(options?: {
-        pageIndex?: number;
-        pageSize?: number;
-    }): Promise<{
-        items: Asset[];
-        total: number;
-        pageIndex: number;
-        pageSize: number;
-    }>;
+    get assets(): {
+        /**
+         * List all assets for a project
+         * @param options - Pagination and filtering options
+         * @returns Promise with paginated assets
+         */
+        list: (options: GetAssetsPageQuery) => Promise<GetAssetsPageResponse>;
+        /**
+         * Retrieve a specific asset by ID
+         * @param assetId - The asset ID
+         * @returns Promise with asset data
+         */
+        retrieve: (assetId: string) => Promise<GetAssetResponse>;
+        /**
+         * Get child assets of a parent asset
+         * @param assetId - The parent asset ID
+         * @param options - Pagination options
+         * @returns Promise with paginated child assets
+         */
+        listChildren: (assetId: string, options: GetAssetChildrenQuery) => Promise<GetAssetChildrenResponse>;
+        /**
+         * Submit a new asset for processing
+         * @param options - Asset submission options
+         * @returns Promise with created asset
+         */
+        create: (options: SubmitAssetOptions) => Promise<Asset>;
+    };
 }

package/cjs/CalmLensClient.js

@@ -37,6 +37,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var api_def_1 = require("api-def");
+var SharedConstants_1 = require("shared/SharedConstants");
 var CalmLensUtils_1 = require("./CalmLensUtils");
 var createApi = function (options) {
     var api = new api_def_1.Api({
@@ -51,40 +52,56 @@ var createApi = function (options) {
                 },
             },
         ],
+        requestBackend: options.requestBackend,
     });
     return api;
 };
-// API endpoint definitions
+// API endpoint definitions using schemas like CalmLensApi.ts
 var createEndpoints = function (api) {
-    var postUploadAsset = api
+    var getAssetsPage = api
         .endpoint()
-        .bodyOf()
+        .queryOf()
         .paramsOf()
         .responseOf()
         .build({
-        id: "postUploadAsset",
-        method: "post",
-        path: "/projects/:projectId/assets",
+        id: "getAssetsPage",
+        method: "get",
+        path: "/projects/:projectId/assets/page",
     });
-    var getAsset = api.endpoint().paramsOf().responseOf().build({
+    var getAsset = api
+        .endpoint()
+        .paramsOf()
+        .responseOf()
+        .build({
         id: "getAsset",
         method: "get",
         path: "/projects/:projectId/assets/:assetId",
     });
-    var getAssetsPage = api
+    var getAssetChildren = api
         .endpoint()
-        .queryOf()
         .paramsOf()
+        .queryOf()
         .responseOf()
         .build({
-        id: "getAssetsPage",
+        id: "getAssetChildren",
         method: "get",
-        path: "/projects/:projectId/assets/page",
+        path: "/projects/:projectId/assets/:assetId/children",
+    });
+    var postUploadAsset = api
+        .endpoint()
+        .bodyOf()
+        .paramsOf()
+        .responseOf()
+        .build({
+        id: "postUploadAsset",
+        method: "post",
+        path: "/projects/:projectId/assets",
     });
     return {
-        postUploadAsset: postUploadAsset,
-        getAsset: getAsset,
         getAssetsPage: getAssetsPage,
+        getAsset: getAsset,
+        getAssetChildren: getAssetChildren,
+        postUploadAsset: postUploadAsset,
     };
 };
 var CalmLensClient = /** @class */ (function () {
@@ -97,7 +114,7 @@ var CalmLensClient = /** @class */ (function () {
         if (!options.projectId) {
             throw new Error("Project ID is required");
         }
-        this.options.baseUrl = (_a = this.options.baseUrl) !== null && _a !== void 0 ? _a : "https://api.calmlens.com";
+        this.options.baseUrl = (_a = this.options.baseUrl) !== null && _a !== void 0 ? _a : "https://api.".concat(SharedConstants_1.DOMAIN, "/v1");
         this.api = createApi(this.options);
         this.endpoints = createEndpoints(this.api);
     }
@@ -128,72 +145,116 @@ var CalmLensClient = /** @class */ (function () {
             });
         });
     };
-    CalmLensClient.prototype.submitAsset = function (options) {
-        return __awaiter(this, void 0, void 0, function () {
-            var result;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!("file" in options) && !("url" in options)) {
-                            throw new Error("Either file content or URL is required");
+    Object.defineProperty(CalmLensClient.prototype, "assets", {
+        get: function () {
+            var _this = this;
+            return {
+                /**
+                 * List all assets for a project
+                 * @param options - Pagination and filtering options
+                 * @returns Promise with paginated assets
+                 */
+                list: function (options) { return __awaiter(_this, void 0, void 0, function () {
+                    var result;
+                    return __generator(this, function (_a) {
+                        switch (_a.label) {
+                            case 0: return [4 /*yield*/, this.endpoints.getAssetsPage.submit({
+                                    params: {
+                                        projectId: this.options.projectId,
+                                    },
+                                    query: options,
+                                })];
+                            case 1:
+                                result = _a.sent();
+                                return [2 /*return*/, result.data];
                         }
-                        if (!options.name) {
-                            throw new Error("Asset name is required");
+                    });
+                }); },
+                /**
+                 * Retrieve a specific asset by ID
+                 * @param assetId - The asset ID
+                 * @returns Promise with asset data
+                 */
+                retrieve: function (assetId) { return __awaiter(_this, void 0, void 0, function () {
+                    var result;
+                    return __generator(this, function (_a) {
+                        switch (_a.label) {
+                            case 0:
+                                if (!assetId) {
+                                    throw new Error("Asset ID is required");
+                                }
+                                return [4 /*yield*/, this.endpoints.getAsset.submit({
+                                        params: {
+                                            projectId: this.options.projectId,
+                                            assetId: assetId,
+                                        },
+                                    })];
+                            case 1:
+                                result = _a.sent();
+                                return [2 /*return*/, result.data];
                         }
-                        return [4 /*yield*/, this.endpoints.postUploadAsset.submit({
-                                body: options,
-                                params: {
-                                    projectId: this.options.projectId,
-                                },
-                            })];
-                    case 1:
-                        result = _a.sent();
-                        return [2 /*return*/, result.data];
-                }
-            });
-        });
-    };
-    CalmLensClient.prototype.getAsset = function (assetId) {
-        return __awaiter(this, void 0, void 0, function () {
-            var result;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!assetId) {
-                            throw new Error("Asset ID is required");
+                    });
+                }); },
+                /**
+                 * Get child assets of a parent asset
+                 * @param assetId - The parent asset ID
+                 * @param options - Pagination options
+                 * @returns Promise with paginated child assets
+                 */
+                listChildren: function (assetId, options) { return __awaiter(_this, void 0, void 0, function () {
+                    var result;
+                    return __generator(this, function (_a) {
+                        switch (_a.label) {
+                            case 0:
+                                if (!assetId) {
+                                    throw new Error("Asset ID is required");
+                                }
+                                return [4 /*yield*/, this.endpoints.getAssetChildren.submit({
+                                        params: {
+                                            projectId: this.options.projectId,
+                                            assetId: assetId,
+                                        },
+                                        query: options,
+                                    })];
+                            case 1:
+                                result = _a.sent();
+                                return [2 /*return*/, result.data];
                         }
-                        return [4 /*yield*/, this.endpoints.getAsset.submit({
-                                params: {
-                                    projectId: this.options.projectId,
-                                    assetId: assetId,
-                                },
-                            })];
-                    case 1:
-                        result = _a.sent();
-                        return [2 /*return*/, result.data];
-                }
-            });
-        });
-    };
-    CalmLensClient.prototype.listAssets = function () {
-        return __awaiter(this, arguments, void 0, function (options) {
-            var result;
-            if (options === void 0) { options = {}; }
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.endpoints.getAssetsPage.submit({
-                            params: {
-                                projectId: this.options.projectId,
-                            },
-                            query: options,
-                        })];
-                    case 1:
-                        result = _a.sent();
-                        return [2 /*return*/, result.data];
-                }
-            });
-        });
-    };
+                    });
+                }); },
+                /**
+                 * Submit a new asset for processing
+                 * @param options - Asset submission options
+                 * @returns Promise with created asset
+                 */
+                create: function (options) { return __awaiter(_this, void 0, void 0, function () {
+                    var result;
+                    return __generator(this, function (_a) {
+                        switch (_a.label) {
+                            case 0:
+                                if (!("file" in options) && !("url" in options)) {
+                                    throw new Error("Either file content or URL is required");
+                                }
+                                if (!options.name) {
+                                    throw new Error("Asset name is required");
+                                }
+                                return [4 /*yield*/, this.endpoints.postUploadAsset.submit({
+                                        body: options,
+                                        params: {
+                                            projectId: this.options.projectId,
+                                        },
+                                    })];
+                            case 1:
+                                result = _a.sent();
+                                return [2 /*return*/, result.data];
+                        }
+                    });
+                }); },
+            };
+        },
+        enumerable: false,
+        configurable: true
+    });
     return CalmLensClient;
 }());
 exports.default = CalmLensClient;

package/cjs/CalmLensTypes.d.ts

@@ -1,5 +1,7 @@
+import type { RequestBackend } from "api-def";
 export interface CalmLensClientOptions {
     apiKey: string;
     projectId: string;
     baseUrl?: string;
+    requestBackend?: RequestBackend;
 }