@calmlens/js-sdk 0.0.2 → 0.0.4

package/cjs/CalmLensClient.d.ts

@@ -49,10 +49,19 @@ export default class CalmLensClient {
          */
         listChildren: (assetId: string, options: GetAssetChildrenQuery) => Promise<GetAssetChildrenResponse>;
         /**
-         * Submit a new asset for processing
+         * Submit a new asset for processing (queued asynchronously)
+         * The asset will be queued for classification and returned immediately.
          * @param options - Asset submission options
          * @returns Promise with created asset
          */
         create: (options: SubmitAssetOptions) => Promise<Asset>;
+        /**
+         * Submit a new asset and analyze it synchronously
+         * The asset will be classified immediately before the response is returned.
+         * This may take longer but ensures the asset is fully processed.
+         * @param options - Asset submission options
+         * @returns Promise with created and analyzed asset
+         */
+        analyze: (options: SubmitAssetOptions) => Promise<Asset>;
     };
 }

package/cjs/CalmLensClient.js

@@ -91,6 +91,7 @@ var createEndpoints = function (api) {
         .endpoint()
         .bodyOf()
         .paramsOf()
+        .queryOf()
         .responseOf()
         .build({
         id: "postUploadAsset",
@@ -223,7 +224,8 @@ var CalmLensClient = /** @class */ (function () {
                     });
                 }); },
                 /**
-                 * Submit a new asset for processing
+                 * Submit a new asset for processing (queued asynchronously)
+                 * The asset will be queued for classification and returned immediately.
                  * @param options - Asset submission options
                  * @returns Promise with created asset
                  */
@@ -232,7 +234,7 @@ var CalmLensClient = /** @class */ (function () {
                     return __generator(this, function (_a) {
                         switch (_a.label) {
                             case 0:
-                                if (!("file" in options) && !("url" in options)) {
+                                if (!("content" in options) && !("url" in options)) {
                                     throw new Error("Either file content or URL is required");
                                 }
                                 if (!options.name) {
@@ -243,6 +245,42 @@ var CalmLensClient = /** @class */ (function () {
                                         params: {
                                             projectId: this.options.projectId,
                                         },
+                                        query: {
+                                            queue: true, // Queue for async processing
+                                        },
+                                    })];
+                            case 1:
+                                result = _a.sent();
+                                return [2 /*return*/, result.data];
+                        }
+                    });
+                }); },
+                /**
+                 * Submit a new asset and analyze it synchronously
+                 * The asset will be classified immediately before the response is returned.
+                 * This may take longer but ensures the asset is fully processed.
+                 * @param options - Asset submission options
+                 * @returns Promise with created and analyzed asset
+                 */
+                analyze: function (options) { return __awaiter(_this, void 0, void 0, function () {
+                    var result;
+                    return __generator(this, function (_a) {
+                        switch (_a.label) {
+                            case 0:
+                                if (!("content" 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,
+                                        },
+                                        query: {
+                                            queue: false, // Process synchronously
+                                        },
                                     })];
                             case 1:
                                 result = _a.sent();

package/cjs/PublicApiSchemas.d.ts

@@ -949,8 +949,13 @@ export declare const POST_ASSET_PARAMS_SCHEMA: zod.ZodObject<{
     projectId: zod.ZodString;
 }, zod.z.core.$strip>;
 export declare const POST_ASSET_BODY_SCHEMA: zod.ZodIntersection<zod.ZodUnion<readonly [zod.ZodObject<{
-    file: zod.ZodString;
-    fileType: zod.ZodString;
+    content: zod.ZodUnion<readonly [zod.ZodObject<{
+        plainText: zod.ZodString;
+        type: zod.ZodString;
+    }, zod.z.core.$strip>, zod.ZodObject<{
+        base64: zod.ZodString;
+        type: zod.ZodString;
+    }, zod.z.core.$strip>]>;
     externalUrl: zod.ZodOptional<zod.ZodString>;
 }, zod.z.core.$strip>, zod.ZodObject<{
     url: zod.ZodString;
@@ -969,6 +974,9 @@ export declare const POST_ASSET_BODY_SCHEMA: zod.ZodIntersection<zod.ZodUnion<re
         private: "private";
     }>>>>;
 }, zod.z.core.$strip>>>;
+export declare const POST_ASSET_QUERY_SCHEMA: zod.ZodObject<{
+    queue: zod.ZodDefault<zod.ZodBoolean>;
+}, zod.z.core.$strip>;
 export declare const POST_ASSET_RESPONSE_SCHEMA: zod.ZodObject<{
     id: zod.ZodString;
     projectId: zod.ZodString;
@@ -1098,6 +1106,7 @@ export declare const POST_ASSET_RESPONSE_SCHEMA: zod.ZodObject<{
     }, zod.z.core.$strip>>>;
 }, zod.z.core.$strip>;
 export type PostAssetParams = zod.infer<typeof POST_ASSET_PARAMS_SCHEMA>;
+export type PostAssetQuery = zod.infer<typeof POST_ASSET_QUERY_SCHEMA>;
 export type PostAssetBody = zod.infer<typeof POST_ASSET_BODY_SCHEMA>;
 export type PostAssetResponse = Asset;
 export declare const POST_ASSET_REQUEST: {
@@ -1112,9 +1121,17 @@ export declare const POST_ASSET_REQUEST: {
         readonly params: zod.ZodObject<{
             projectId: zod.ZodString;
         }, zod.z.core.$strip>;
+        readonly query: zod.ZodObject<{
+            queue: zod.ZodDefault<zod.ZodBoolean>;
+        }, zod.z.core.$strip>;
         readonly body: zod.ZodIntersection<zod.ZodUnion<readonly [zod.ZodObject<{
-            file: zod.ZodString;
-            fileType: zod.ZodString;
+            content: zod.ZodUnion<readonly [zod.ZodObject<{
+                plainText: zod.ZodString;
+                type: zod.ZodString;
+            }, zod.z.core.$strip>, zod.ZodObject<{
+                base64: zod.ZodString;
+                type: zod.ZodString;
+            }, zod.z.core.$strip>]>;
             externalUrl: zod.ZodOptional<zod.ZodString>;
         }, zod.z.core.$strip>, zod.ZodObject<{
             url: zod.ZodString;

package/cjs/PublicApiSchemas.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DELETE_ASSET_REQUEST = exports.DELETE_ASSET_RESPONSE_SCHEMA = exports.DELETE_ASSET_PARAMS_SCHEMA = exports.PATCH_ASSET_REQUEST = exports.PATCH_ASSET_RESPONSE_SCHEMA = exports.PATCH_ASSET_BODY_SCHEMA = exports.PATCH_ASSET_PARAMS_SCHEMA = exports.POST_ASSET_REQUEST = exports.POST_ASSET_RESPONSE_SCHEMA = exports.POST_ASSET_BODY_SCHEMA = exports.POST_ASSET_PARAMS_SCHEMA = exports.GET_ASSET_CHILDREN_REQUEST = exports.GET_ASSET_CHILDREN_RESPONSE_SCHEMA = exports.GET_ASSET_CHILDREN_QUERY_SCHEMA = exports.GET_ASSET_CHILDREN_PARAMS_SCHEMA = exports.GET_ASSET_REQUEST = exports.GET_ASSET_RESPONSE_SCHEMA = exports.GET_ASSET_PARAMS_SCHEMA = exports.GET_ASSETS_PAGE_REQUEST = exports.GET_ASSETS_PAGE_RESPONSE_SCHEMA = exports.GET_ASSETS_PAGE_QUERY_SCHEMA = exports.GET_ASSETS_PAGE_PARAMS_SCHEMA = exports.PUBLIC_ERROR_CODES = void 0;
+exports.DELETE_ASSET_REQUEST = exports.DELETE_ASSET_RESPONSE_SCHEMA = exports.DELETE_ASSET_PARAMS_SCHEMA = exports.PATCH_ASSET_REQUEST = exports.PATCH_ASSET_RESPONSE_SCHEMA = exports.PATCH_ASSET_BODY_SCHEMA = exports.PATCH_ASSET_PARAMS_SCHEMA = exports.POST_ASSET_REQUEST = exports.POST_ASSET_RESPONSE_SCHEMA = exports.POST_ASSET_QUERY_SCHEMA = exports.POST_ASSET_BODY_SCHEMA = exports.POST_ASSET_PARAMS_SCHEMA = exports.GET_ASSET_CHILDREN_REQUEST = exports.GET_ASSET_CHILDREN_RESPONSE_SCHEMA = exports.GET_ASSET_CHILDREN_QUERY_SCHEMA = exports.GET_ASSET_CHILDREN_PARAMS_SCHEMA = exports.GET_ASSET_REQUEST = exports.GET_ASSET_RESPONSE_SCHEMA = exports.GET_ASSET_PARAMS_SCHEMA = exports.GET_ASSETS_PAGE_REQUEST = exports.GET_ASSETS_PAGE_RESPONSE_SCHEMA = exports.GET_ASSETS_PAGE_QUERY_SCHEMA = exports.GET_ASSETS_PAGE_PARAMS_SCHEMA = exports.PUBLIC_ERROR_CODES = void 0;
 var sendable_error_1 = require("sendable-error");
 var zod = __importStar(require("zod/v4"));
 var zod_meta_1 = require("zod-meta");
@@ -193,16 +193,40 @@ exports.POST_ASSET_PARAMS_SCHEMA = zod.object({
     ])),
 });
 var POST_ASSET_FILE_BODY_SCHEMA = zod.object({
-    file: zod.string().meta((0, zod_meta_1.metaStore)([
-        (0, DocMetaTypes_1.docPropertyInfo)({
-            description: "Base64 encoded file content or data URL",
-            placeholder: "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ...",
+    content: zod
+        .union([
+        zod.object({
+            plainText: zod.string().meta((0, zod_meta_1.metaStore)([
+                (0, DocMetaTypes_1.docPropertyInfo)({
+                    description: "Plain text content",
+                    placeholder: "This is plain text content...",
+                }),
+            ])),
+            type: zod.string().meta((0, zod_meta_1.metaStore)([
+                (0, DocMetaTypes_1.docPropertyInfo)({
+                    description: "MIME type or file extension",
+                    placeholder: "text/plain",
+                }),
+            ])),
         }),
-    ])),
-    fileType: zod.string().meta((0, zod_meta_1.metaStore)([
+        zod.object({
+            base64: zod.string().meta((0, zod_meta_1.metaStore)([
+                (0, DocMetaTypes_1.docPropertyInfo)({
+                    description: "Base64 encoded file content or data URL",
+                    placeholder: "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ...",
+                }),
+            ])),
+            type: zod.string().meta((0, zod_meta_1.metaStore)([
+                (0, DocMetaTypes_1.docPropertyInfo)({
+                    description: "MIME type or file extension",
+                    placeholder: "image/jpeg",
+                }),
+            ])),
+        }),
+    ])
+        .meta((0, zod_meta_1.metaStore)([
         (0, DocMetaTypes_1.docPropertyInfo)({
-            description: "MIME type or file extension",
-            placeholder: "image/jpeg",
+            description: "File content as plain text or base64",
         }),
     ])),
     externalUrl: zod.string().url().optional(),
@@ -228,6 +252,17 @@ var POST_ASSET_COMMON_BODY_SCHEMA = Asset_1.ASSET_SCHEMA.pick({
 exports.POST_ASSET_BODY_SCHEMA = zod
     .union([POST_ASSET_FILE_BODY_SCHEMA, POST_ASSET_URL_BODY_SCHEMA])
     .and(POST_ASSET_COMMON_BODY_SCHEMA);
+exports.POST_ASSET_QUERY_SCHEMA = zod.object({
+    queue: zod
+        .boolean()
+        .default(false)
+        .meta((0, zod_meta_1.metaStore)([
+        (0, DocMetaTypes_1.docPropertyInfo)({
+            description: "If true, queue the asset for asynchronous classification. If false, classify synchronously.",
+            placeholder: "false",
+        }),
+    ])),
+});
 exports.POST_ASSET_RESPONSE_SCHEMA = Asset_1.ASSET_SCHEMA;
 exports.POST_ASSET_REQUEST = {
     name: "Create Asset",
@@ -239,6 +274,7 @@ exports.POST_ASSET_REQUEST = {
     sdkPath: ["assets", "create"],
     schemas: {
         params: exports.POST_ASSET_PARAMS_SCHEMA,
+        query: exports.POST_ASSET_QUERY_SCHEMA,
         body: exports.POST_ASSET_BODY_SCHEMA,
         response: exports.POST_ASSET_RESPONSE_SCHEMA,
     },

package/cjs/SharedTypes.d.ts

@@ -1,8 +1,13 @@
 import type { AssetVisibility } from "./Asset";
 export type SubmitAssetOptions = ({
-    file: string;
-    fileType: string;
-    url?: string;
+    content: {
+        plainText: string;
+        type: string;
+    } | {
+        base64: string;
+        type: string;
+    };
+    externalUrl?: string;
 } | {
     url: string;
 }) & {

package/esm/CalmLensClient.d.ts

@@ -49,10 +49,19 @@ export default class CalmLensClient {
          */
         listChildren: (assetId: string, options: GetAssetChildrenQuery) => Promise<GetAssetChildrenResponse>;
         /**
-         * Submit a new asset for processing
+         * Submit a new asset for processing (queued asynchronously)
+         * The asset will be queued for classification and returned immediately.
          * @param options - Asset submission options
          * @returns Promise with created asset
          */
         create: (options: SubmitAssetOptions) => Promise<Asset>;
+        /**
+         * Submit a new asset and analyze it synchronously
+         * The asset will be classified immediately before the response is returned.
+         * This may take longer but ensures the asset is fully processed.
+         * @param options - Asset submission options
+         * @returns Promise with created and analyzed asset
+         */
+        analyze: (options: SubmitAssetOptions) => Promise<Asset>;
     };
 }

package/esm/CalmLensClient.js

@@ -62,6 +62,7 @@ const createEndpoints = (api) => {
         .endpoint()
         .bodyOf()
         .paramsOf()
+        .queryOf()
         .responseOf()
         .build({
         id: "postUploadAsset",
@@ -167,12 +168,13 @@ export default class CalmLensClient {
                 return result.data;
             }),
             /**
-             * Submit a new asset for processing
+             * Submit a new asset for processing (queued asynchronously)
+             * The asset will be queued for classification and returned immediately.
              * @param options - Asset submission options
              * @returns Promise with created asset
              */
             create: (options) => __awaiter(this, void 0, void 0, function* () {
-                if (!("file" in options) && !("url" in options)) {
+                if (!("content" in options) && !("url" in options)) {
                     throw new Error("Either file content or URL is required");
                 }
                 if (!options.name) {
@@ -183,6 +185,34 @@ export default class CalmLensClient {
                     params: {
                         projectId: this.options.projectId,
                     },
+                    query: {
+                        queue: true, // Queue for async processing
+                    },
+                });
+                return result.data;
+            }),
+            /**
+             * Submit a new asset and analyze it synchronously
+             * The asset will be classified immediately before the response is returned.
+             * This may take longer but ensures the asset is fully processed.
+             * @param options - Asset submission options
+             * @returns Promise with created and analyzed asset
+             */
+            analyze: (options) => __awaiter(this, void 0, void 0, function* () {
+                if (!("content" 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");
+                }
+                const result = yield this.endpoints.postUploadAsset.submit({
+                    body: options,
+                    params: {
+                        projectId: this.options.projectId,
+                    },
+                    query: {
+                        queue: false, // Process synchronously
+                    },
                 });
                 return result.data;
             }),

package/esm/PublicApiSchemas.d.ts

@@ -949,8 +949,13 @@ export declare const POST_ASSET_PARAMS_SCHEMA: zod.ZodObject<{
     projectId: zod.ZodString;
 }, zod.z.core.$strip>;
 export declare const POST_ASSET_BODY_SCHEMA: zod.ZodIntersection<zod.ZodUnion<readonly [zod.ZodObject<{
-    file: zod.ZodString;
-    fileType: zod.ZodString;
+    content: zod.ZodUnion<readonly [zod.ZodObject<{
+        plainText: zod.ZodString;
+        type: zod.ZodString;
+    }, zod.z.core.$strip>, zod.ZodObject<{
+        base64: zod.ZodString;
+        type: zod.ZodString;
+    }, zod.z.core.$strip>]>;
     externalUrl: zod.ZodOptional<zod.ZodString>;
 }, zod.z.core.$strip>, zod.ZodObject<{
     url: zod.ZodString;
@@ -969,6 +974,9 @@ export declare const POST_ASSET_BODY_SCHEMA: zod.ZodIntersection<zod.ZodUnion<re
         private: "private";
     }>>>>;
 }, zod.z.core.$strip>>>;
+export declare const POST_ASSET_QUERY_SCHEMA: zod.ZodObject<{
+    queue: zod.ZodDefault<zod.ZodBoolean>;
+}, zod.z.core.$strip>;
 export declare const POST_ASSET_RESPONSE_SCHEMA: zod.ZodObject<{
     id: zod.ZodString;
     projectId: zod.ZodString;
@@ -1098,6 +1106,7 @@ export declare const POST_ASSET_RESPONSE_SCHEMA: zod.ZodObject<{
     }, zod.z.core.$strip>>>;
 }, zod.z.core.$strip>;
 export type PostAssetParams = zod.infer<typeof POST_ASSET_PARAMS_SCHEMA>;
+export type PostAssetQuery = zod.infer<typeof POST_ASSET_QUERY_SCHEMA>;
 export type PostAssetBody = zod.infer<typeof POST_ASSET_BODY_SCHEMA>;
 export type PostAssetResponse = Asset;
 export declare const POST_ASSET_REQUEST: {
@@ -1112,9 +1121,17 @@ export declare const POST_ASSET_REQUEST: {
         readonly params: zod.ZodObject<{
             projectId: zod.ZodString;
         }, zod.z.core.$strip>;
+        readonly query: zod.ZodObject<{
+            queue: zod.ZodDefault<zod.ZodBoolean>;
+        }, zod.z.core.$strip>;
         readonly body: zod.ZodIntersection<zod.ZodUnion<readonly [zod.ZodObject<{
-            file: zod.ZodString;
-            fileType: zod.ZodString;
+            content: zod.ZodUnion<readonly [zod.ZodObject<{
+                plainText: zod.ZodString;
+                type: zod.ZodString;
+            }, zod.z.core.$strip>, zod.ZodObject<{
+                base64: zod.ZodString;
+                type: zod.ZodString;
+            }, zod.z.core.$strip>]>;
             externalUrl: zod.ZodOptional<zod.ZodString>;
         }, zod.z.core.$strip>, zod.ZodObject<{
             url: zod.ZodString;

package/esm/PublicApiSchemas.js

@@ -157,16 +157,40 @@ export const POST_ASSET_PARAMS_SCHEMA = zod.object({
     ])),
 });
 const POST_ASSET_FILE_BODY_SCHEMA = zod.object({
-    file: zod.string().meta(metaStore([
-        docPropertyInfo({
-            description: "Base64 encoded file content or data URL",
-            placeholder: "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ...",
+    content: zod
+        .union([
+        zod.object({
+            plainText: zod.string().meta(metaStore([
+                docPropertyInfo({
+                    description: "Plain text content",
+                    placeholder: "This is plain text content...",
+                }),
+            ])),
+            type: zod.string().meta(metaStore([
+                docPropertyInfo({
+                    description: "MIME type or file extension",
+                    placeholder: "text/plain",
+                }),
+            ])),
         }),
-    ])),
-    fileType: zod.string().meta(metaStore([
+        zod.object({
+            base64: zod.string().meta(metaStore([
+                docPropertyInfo({
+                    description: "Base64 encoded file content or data URL",
+                    placeholder: "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ...",
+                }),
+            ])),
+            type: zod.string().meta(metaStore([
+                docPropertyInfo({
+                    description: "MIME type or file extension",
+                    placeholder: "image/jpeg",
+                }),
+            ])),
+        }),
+    ])
+        .meta(metaStore([
         docPropertyInfo({
-            description: "MIME type or file extension",
-            placeholder: "image/jpeg",
+            description: "File content as plain text or base64",
         }),
     ])),
     externalUrl: zod.string().url().optional(),
@@ -192,6 +216,17 @@ const POST_ASSET_COMMON_BODY_SCHEMA = ASSET_SCHEMA.pick({
 export const POST_ASSET_BODY_SCHEMA = zod
     .union([POST_ASSET_FILE_BODY_SCHEMA, POST_ASSET_URL_BODY_SCHEMA])
     .and(POST_ASSET_COMMON_BODY_SCHEMA);
+export const POST_ASSET_QUERY_SCHEMA = zod.object({
+    queue: zod
+        .boolean()
+        .default(false)
+        .meta(metaStore([
+        docPropertyInfo({
+            description: "If true, queue the asset for asynchronous classification. If false, classify synchronously.",
+            placeholder: "false",
+        }),
+    ])),
+});
 export const POST_ASSET_RESPONSE_SCHEMA = ASSET_SCHEMA;
 export const POST_ASSET_REQUEST = {
     name: "Create Asset",
@@ -203,6 +238,7 @@ export const POST_ASSET_REQUEST = {
     sdkPath: ["assets", "create"],
     schemas: {
         params: POST_ASSET_PARAMS_SCHEMA,
+        query: POST_ASSET_QUERY_SCHEMA,
         body: POST_ASSET_BODY_SCHEMA,
         response: POST_ASSET_RESPONSE_SCHEMA,
     },

package/esm/SharedTypes.d.ts

@@ -1,8 +1,13 @@
 import type { AssetVisibility } from "./Asset";
 export type SubmitAssetOptions = ({
-    file: string;
-    fileType: string;
-    url?: string;
+    content: {
+        plainText: string;
+        type: string;
+    } | {
+        base64: string;
+        type: string;
+    };
+    externalUrl?: string;
 } | {
     url: string;
 }) & {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@calmlens/js-sdk",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "main": "cjs/index.js",
   "types": "esm/index.d.ts",
   "module": "esm/index.js",