@vertesia/client 0.53.0 → 0.55.0

package/src/store/ObjectsApi.ts

@@ -1,35 +1,54 @@
-import { ApiTopic, ClientBase } from '@vertesia/api-fetch-client';
-import { ComplexSearchPayload, ComputeObjectFacetPayload, ContentObject, ContentObjectItem, ContentSource, CreateContentObjectPayload, Embedding, ExportPropertiesPayload, ExportPropertiesResponse, FindPayload, GetFileUrlPayload, GetFileUrlResponse, GetRenditionResponse, GetUploadUrlPayload, ListWorkflowRunsResponse, ObjectSearchPayload, ObjectSearchQuery, SupportedEmbeddingTypes } from '@vertesia/common';
-
-import { StreamSource } from '../StreamSource.js';
-import { ZenoClient } from './client.js';
-import { AnalyzeDocApi } from './AnalyzeDocApi.js';
-
-export interface UploadContentObjectPayload extends Omit<CreateContentObjectPayload, 'content'> {
-    content?: StreamSource | File | {
-
-        // the source URI
-        source: string,
-        // the original name of the input file if any
-        name?: string,
-        // the mime type of the content source.
-        type?: string
-
-        // the target id in the content store
-        id?: string
-
-    }
+import { ApiTopic, ClientBase } from "@vertesia/api-fetch-client";
+import {
+    ComplexSearchPayload,
+    ComputeObjectFacetPayload,
+    ContentObject,
+    ContentObjectItem,
+    ContentSource,
+    CreateContentObjectPayload,
+    Embedding,
+    ExportPropertiesPayload,
+    ExportPropertiesResponse,
+    FindPayload,
+    GetFileUrlPayload,
+    GetFileUrlResponse,
+    GetRenditionResponse,
+    GetUploadUrlPayload,
+    ListWorkflowRunsResponse,
+    ObjectSearchPayload,
+    ObjectSearchQuery,
+    SupportedEmbeddingTypes,
+} from "@vertesia/common";
+
+import { StreamSource } from "../StreamSource.js";
+import { ZenoClient } from "./client.js";
+import { AnalyzeDocApi } from "./AnalyzeDocApi.js";
+
+export interface UploadContentObjectPayload extends Omit<CreateContentObjectPayload, "content"> {
+    content?:
+        | StreamSource
+        | File
+        | {
+              // the source URI
+              source: string;
+              // the original name of the input file if any
+              name?: string;
+              // the mime type of the content source.
+              type?: string;
+
+              // the target id in the content store
+              id?: string;
+          };
 }
 
 export interface ComputeFacetsResponse {
-    type?: { _id: string, count: number }[];
-    location?: { _id: string, count: number }[];
-    status?: { _id: string, count: number }[];
+    type?: { _id: string; count: number }[];
+    location?: { _id: string; count: number }[];
+    status?: { _id: string; count: number }[];
     total?: { count: number }[];
 }
 
 export class ObjectsApi extends ApiTopic {
-
     constructor(parent: ClientBase) {
         super(parent, "/api/v1/objects");
     }
@@ -39,64 +58,85 @@ export class ObjectsApi extends ApiTopic {
     }
 
     getUploadUrl(payload: GetUploadUrlPayload): Promise<GetFileUrlResponse> {
-        return this.post('/upload-url', {
-            payload
-        })
+        return this.post("/upload-url", {
+            payload,
+        });
     }
 
     getDownloadUrl(fileUri: string): Promise<{ url: string }> {
-        return this.post('/download-url', {
+        return this.post("/download-url", {
             payload: {
-                file: fileUri
-            } satisfies GetFileUrlPayload
-        })
+                file: fileUri,
+            } satisfies GetFileUrlPayload,
+        });
     }
 
     getContentSource(objectId: string): Promise<ContentSource> {
         return this.get(`/${objectId}/content-source`);
     }
 
-    list(payload: ObjectSearchPayload = {}): Promise<ContentObjectItem[]> {
+    /**
+     * List objects with revision filtering options
+     *
+     * @param payload Search/filter parameters
+     * @returns Matching content objects
+     */
+    list<T = any>(payload: ObjectSearchPayload = {}): Promise<ContentObjectItem<T>[]> {
         const limit = payload.limit || 100;
         const offset = payload.offset || 0;
-        const query = payload.query || {} as ObjectSearchQuery;
+        const query = payload.query || ({} as ObjectSearchQuery);
+
+        // Add revision filtering options
+        const showAllRevisions = payload.show_all_revisions === true;
+        const revisionRoot = payload.from_root;
 
         return this.get("/", {
             query: {
                 limit,
                 offset,
-                ...query
-            }
+                ...query,
+                show_all_revisions: showAllRevisions ? "true" : undefined,
+                from_root: revisionRoot,
+            },
         });
     }
 
     computeFacets(query: ComputeObjectFacetPayload): Promise<ComputeFacetsResponse> {
         return this.post("/facets", {
-            payload: query
+            payload: query,
         });
     }
 
-    listFolders(path: string = '/') {
-        path;//TODO
+    listFolders(path: string = "/") {
+        path; //TODO
     }
 
+    /** Find object based on query */
     find(payload: FindPayload): Promise<ContentObject[]> {
         return this.post("/find", {
-            payload
+            payload,
         });
     }
 
+    /** Count number of objects matching this query */
+    count(payload: FindPayload): Promise<{ count: number }> {
+        return this.post("/count", {
+            payload,
+        });
+    }
+
+    /** Search object — different from find because allow full text search */
     search(payload: ComplexSearchPayload): Promise<ContentObjectItem[]> {
         return this.post("/search", {
-            payload
+            payload,
         });
     }
 
     retrieve(id: string, select?: string): Promise<ContentObject> {
         return this.get(`/${id}`, {
             query: {
-                select
-            }
+                select,
+            },
         });
     }
 
@@ -110,10 +150,10 @@ export class ObjectsApi extends ApiTopic {
         const { url, id, mime_type } = await this.getUploadUrl({
             id: isStream ? source.id : undefined,
             name: source.name,
-            mime_type: source.type
+            mime_type: source.type,
         });
 
-        console.log(`Uploading file to ${url}`, { id, mime_type, isStream, source })
+        console.log(`Uploading content to ${url}`, { id, mime_type, isStream, source });
 
         // upload the file content to the signed URL
         /*const res = await this.fetch(url, {
@@ -134,44 +174,50 @@ export class ObjectsApi extends ApiTopic {
         });*/
 
         const res = await fetch(url, {
-            method: 'PUT',
+            method: "PUT",
             body: isStream ? source.stream : source,
             //@ts-ignore: duplex is not in the types. See https://github.com/node-fetch/node-fetch/issues/1769
             duplex: isStream ? "half" : undefined,
             headers: {
-                'Content-Type': mime_type || 'application/octet-stream'
-            }
-        }).then((res: Response) => {
-            if (res.ok) {
-                return res;
-            } else {
-                console.log(res);
-                throw new Error(`Failed to upload file: ${res.statusText}`);
-            }
-        }).catch(err => {
-            console.error('Failed to upload file', err);
-            throw err;
-        });
-
+                "Content-Type": mime_type || "application/octet-stream",
+            },
+        })
+            .then((res: Response) => {
+                if (res.ok) {
+                    return res;
+                } else {
+                    console.log(res);
+                    throw new Error(`Failed to upload file: ${res.statusText}`);
+                }
+            })
+            .catch((err) => {
+                console.error("Failed to upload file", err);
+                throw err;
+            });
+
+        //Etag need to be unquoted
+        //When a server returns an ETag header, it includes the quotes around the actual hash value.
+        //This is part of the HTTP specification (RFC 7232), which states that ETags should be
+        //enclosed in double quotes.
+        const etag = res.headers.get("etag")?.replace(/^"(.*)"$/, "$1");
 
         return {
             source: id,
             name: source.name,
             type: mime_type,
-            etag: res.headers.get('etag') ?? undefined
-        }
+            etag,
+        };
     }
 
     async create(payload: UploadContentObjectPayload): Promise<ContentObject> {
-
         const createPayload: CreateContentObjectPayload = {
-            ...payload
+            ...payload,
         };
         if (payload.content instanceof StreamSource || payload.content instanceof File) {
             createPayload.content = await this.upload(payload.content);
         }
-        return await this.post('/', {
-            payload: createPayload
+        return await this.post("/", {
+            payload: createPayload,
         });
     }
 
@@ -184,25 +230,72 @@ export class ObjectsApi extends ApiTopic {
      * @returns
      */
     async createFromExternalSource(uri: string, payload: CreateContentObjectPayload = {}): Promise<ContentObject> {
-        const metadata = await ((this.client as ZenoClient).files.getMetadata(uri));
+        const metadata = await (this.client as ZenoClient).files.getMetadata(uri);
         const createPayload: CreateContentObjectPayload = {
             ...payload,
             content: {
                 source: uri,
                 name: metadata.name,
                 type: metadata.contentType,
-                etag: metadata.etag
-            }
+                etag: metadata.etag,
+            },
         };
-        return await this.post('/', {
-            payload: createPayload
+        return await this.post("/", {
+            payload: createPayload,
         });
     }
 
-    update(id: string, payload: Partial<CreateContentObjectPayload>): Promise<ContentObject> {
-        return this.put(`/${id}`, {
-            payload
-        });
+    /**
+     * Updates an existing object or creates a new revision
+     * Handles file uploads similar to the create method
+     *
+     * @param id The ID of the object to update
+     * @param payload The changes to apply
+     * @param options Additional options
+     * @param options.createRevision Whether to create a new revision instead of updating in place
+     * @param options.revisionLabel Optional label for the revision (e.g., "v1.2")
+     * @returns The updated object or newly created revision
+     */
+    async update(
+        id: string,
+        payload: Partial<CreateContentObjectPayload>,
+        options?: {
+            createRevision?: boolean;
+            revisionLabel?: string;
+        },
+    ): Promise<ContentObject> {
+        const updatePayload: Partial<CreateContentObjectPayload> = {
+            ...payload,
+        };
+
+        // Handle file upload if content is provided as File or StreamSource
+        if (payload.content instanceof StreamSource || payload.content instanceof File) {
+            updatePayload.content = await this.upload(payload.content);
+        }
+
+        if (options?.createRevision) {
+            return this.put(`/${id}`, {
+                payload: updatePayload,
+                headers: {
+                    "x-create-revision": "true",
+                    "x-revision-label": options.revisionLabel || "",
+                },
+            });
+        } else {
+            return this.put(`/${id}`, {
+                payload: updatePayload,
+            });
+        }
+    }
+
+    /**
+     * Retrieves all revisions of a content object
+     *
+     * @param id The ID of any revision in the object's history
+     * @returns Array of all revisions sharing the same root
+     */
+    getRevisions(id: string): Promise<ContentObjectItem[]> {
+        return this.get(`/${id}/revisions`);
     }
 
     delete(id: string): Promise<{ id: string }> {
@@ -210,9 +303,7 @@ export class ObjectsApi extends ApiTopic {
     }
 
     listWorkflowRuns(documentId: string): Promise<ListWorkflowRunsResponse> {
-
-        return this.get(`/${documentId}/workflow-runs`)
-
+        return this.get(`/${documentId}/workflow-runs`);
     }
 
     listRenditions(documentId: string): Promise<ContentObjectItem[]> {
@@ -220,31 +311,33 @@ export class ObjectsApi extends ApiTopic {
     }
 
     getRendition(documentId: string, options: GetRenditionParams): Promise<GetRenditionResponse> {
-
         const query = {
             max_hw: options.max_hw,
-            generate_if_missing: options.generate_if_missing
-        }
+            generate_if_missing: options.generate_if_missing,
+        };
 
         return this.get(`/${documentId}/renditions/${options.format}`, { query });
     }
 
     exportProperties(payload: ExportPropertiesPayload): Promise<ExportPropertiesResponse> {
         return this.post("/export", {
-            payload
+            payload,
         });
     }
 
-    setEmbedding(id: string, type: SupportedEmbeddingTypes, payload: Embedding): Promise<Record<SupportedEmbeddingTypes, Embedding>> {
+    setEmbedding(
+        id: string,
+        type: SupportedEmbeddingTypes,
+        payload: Embedding,
+    ): Promise<Record<SupportedEmbeddingTypes, Embedding>> {
         return this.put(`/${id}/embeddings/${type}`, {
-            payload
+            payload,
         });
     }
-
 }
 
 interface GetRenditionParams {
     format: string;
     max_hw?: number;
     generate_if_missing?: boolean;
-}
+}