@vertesia/common 1.3.0 → 1.4.0-dev.20260615.042033Z

package/src/store/store.ts

@@ -1,7 +1,9 @@
-import { SearchPayload } from "../payload.js";
-import { SupportedEmbeddingTypes } from "../project.js";
-import { ComplexSearchQuery } from "../query.js";
-import { BaseObject } from "./common.js";
+import type { ComputedFacetResponse } from '../facets.js';
+import type { JSONObject } from '../json.js';
+import type { SearchPayload } from '../payload.js';
+import type { SupportedEmbeddingTypes } from '../project.js';
+import type { ComplexSearchQuery } from '../query.js';
+import type { BaseObject } from './common.js';
 
 export enum ContentObjectApiHeaders {
     COLLECTION_ID = 'x-collection-id',
@@ -53,12 +55,12 @@ export enum DataStoreApiHeaders {
 }
 
 export enum ContentObjectStatus {
-    created = "created",
-    processing = "processing", // the was created and still processing
-    ready = "ready", // the object is rendered and ready to be used
-    completed = "completed",
-    failed = "failed",
-    archived = "archived",
+    created = 'created',
+    processing = 'processing', // the was created and still processing
+    ready = 'ready', // the object is rendered and ready to be used
+    completed = 'completed',
+    failed = 'failed',
+    archived = 'archived',
 }
 
 export interface Embedding {
@@ -98,11 +100,7 @@ export interface SetObjectEmbeddingsResponse {
     type?: Embedding;
 }
 
-export interface ContentObjectApiTypeRef {
-    id?: string;
-    code?: string;
-    name: string;
-}
+export type ContentObjectApiTypeRef = ContentObjectTypeRef;
 
 export interface ContentObjectApiRevision {
     parent?: string;
@@ -112,11 +110,11 @@ export interface ContentObjectApiRevision {
 }
 
 export interface ContentObjectItemApiResponse extends BaseObject {
-    parent: string;
+    parent?: string;
     location: string;
     status: ContentObjectStatus;
     type?: ContentObjectApiTypeRef;
-    content: ContentSource;
+    content?: ContentSource;
     external_id?: string;
     properties: Record<string, unknown>;
     metadata?: Record<string, unknown>;
@@ -143,7 +141,7 @@ export interface ContentObjectApiResponse extends ContentObjectItemApiResponse {
     inherited_properties?: InheritedPropertyMetadata[];
 }
 
-export interface ContentObject<T = any> extends ContentObjectItem<T> {
+export interface ContentObject<T = JSONObject> extends ContentObjectItem<T> {
     text?: string; // the text representation of the object
     text_etag?: string;
     embeddings: Partial<Record<SupportedEmbeddingTypes, Embedding>>;
@@ -164,12 +162,12 @@ export interface ContentObject<T = any> extends ContentObjectItem<T> {
 }
 
 export enum ContentNature {
-    Video = "video",
-    Image = "image",
-    Audio = "audio",
-    Document = "document",
-    Code = "code",
-    Other = "other"
+    Video = 'video',
+    Image = 'image',
+    Audio = 'audio',
+    Document = 'document',
+    Code = 'code',
+    Other = 'other',
 }
 
 export interface Dimensions {
@@ -200,15 +198,10 @@ export interface RenditionWithDimensions extends Rendition {
     dimensions: Dimensions;
 }
 
-/**
- * @deprecated Use RenditionWithDimensions instead
- */
-export type VideoRendition = RenditionWithDimensions;
-
-export const POSTER_RENDITION_NAME = "Poster";
-export const AUDIO_RENDITION_NAME = "Audio";
-export const WEB_VIDEO_RENDITION_NAME = "Web";
-export const PDF_RENDITION_NAME = "PDF";
+export const POSTER_RENDITION_NAME = 'Poster';
+export const AUDIO_RENDITION_NAME = 'Audio';
+export const WEB_VIDEO_RENDITION_NAME = 'Web';
+export const PDF_RENDITION_NAME = 'PDF';
 
 export interface ContentMetadata {
     // Common fields for all media types
@@ -216,7 +209,7 @@ export interface ContentMetadata {
     size?: number; // in bytes
     languages?: string[];
     location?: Location;
-    generation_runs: GenerationRunMetadata[];
+    generation_runs?: GenerationRunMetadata[];
     etag?: string;
     renditions?: Rendition[];
 }
@@ -258,8 +251,8 @@ export interface DocumentMetadata extends ContentMetadata {
         features_requested?: string[];
         zones_requested?: string[];
         table_count?: number;
-        image_count: number;
-        zone_count: number;
+        image_count?: number;
+        zone_count?: number;
         needs_ocr_count?: number;
     };
     sections?: TextSection[]; // List of sections with descriptions and line indexes
@@ -272,7 +265,7 @@ export interface Transcript {
 }
 
 export const TextExtractionStatus = {
-    success: "success",
+    success: 'success',
 } as const;
 
 export interface TranscriptMediaResult {
@@ -328,8 +321,8 @@ export interface RevisionInfo {
 /**
  * The content object item is a simplified version of the ContentObject that is returned by the store API when listing objects.
  */
-export interface ContentObjectItem<T = Record<string, any>> extends BaseObject {
-    parent: string; // the id of the direct parent object. The root object doesn't have the parent field set.
+export interface ContentObjectItem<T = JSONObject> extends BaseObject {
+    parent?: string; // the id of the direct parent object. The root object doesn't have the parent field set.
 
     /** An optional path based location for the object */
     location: string; // the path of the parent object
@@ -352,7 +345,7 @@ export interface ContentObjectItem<T = Record<string, any>> extends BaseObject {
     /**
      * Content source information, typically a link to an object store
      */
-    content: ContentSource;
+    content?: ContentSource;
 
     /**
      * External identifier for integration with other systems
@@ -363,12 +356,7 @@ export interface ContentObjectItem<T = Record<string, any>> extends BaseObject {
     properties: T; // a JSON object that describes the object
 
     /** Technical metadata of the object */
-    metadata?:
-    | VideoMetadata
-    | AudioMetadata
-    | ImageMetadata
-    | DocumentMetadata
-    | ContentMetadata;
+    metadata?: VideoMetadata | AudioMetadata | ImageMetadata | DocumentMetadata | ContentMetadata;
 
     /** Token information  */
     tokens?: {
@@ -408,46 +396,64 @@ export interface ContentObjectItem<T = Record<string, any>> extends BaseObject {
 /**
  * When creating from an uploaded file the content should be an URL to the uploaded file
  */
-export interface CreateContentObjectPayload<T = any>
-    extends Partial<
-        Omit<
-            ContentObject<T>,
-            "id" | "root" | "created_at" | "updated_at" | "type" | "owner"
-        >
-    > {
+export interface CreateContentObjectPayload<T = JSONObject>
+    extends Partial<Omit<ContentObject<T>, 'id' | 'root' | 'created_at' | 'updated_at' | 'type' | 'owner'>> {
     id?: string; // An optional existing object ID to be replaced by the new one
     type?: string; // the object type ID
     generation_run_info?: GenerationRunMetadata;
 }
 
-export function getContentTypeRefId(type: ContentObjectTypeRef) {
-    return (type as StoredTypeRef).id || (type as InCodeTypeRef).code;
+type LegacyContentObjectTypeRef = Partial<ContentObjectTypeRef> & {
+    ref_type?: 'stored' | 'incode';
+    id?: string;
+    code?: string;
+    name?: string;
+};
+
+export function getContentTypeRefId(type: ContentObjectTypeRef): string {
+    return type.id;
+}
+
+export function withContentObjectTypeRefDiscriminator(
+    type: ContentObjectTypeRef | LegacyContentObjectTypeRef,
+): ContentObjectTypeRef {
+    const legacyCode = 'code' in type ? type.code : undefined;
+    const id = type.id || legacyCode || '';
+    const name = type.name || '';
+    if (type.ref_type === 'incode' || isInCodeType(id)) {
+        return { ref_type: 'incode', id, name };
+    }
+    return { ref_type: 'stored', id, name };
 }
 
 /**
- * Reference to a content object type. Either `id` (stored type) or `code` (in-code type) must be set.
+ * Reference to a content object type. `id` is the canonical identifier for both
+ * stored and in-code types.
+ */
+/**
+ * @discriminator ref_type
  */
 export type ContentObjectTypeRef = StoredTypeRef | InCodeTypeRef;
 
 interface StoredTypeRef {
+    ref_type: 'stored';
     /**
      * MongoDB ObjectId string for stored types
      */
     id: string;
-    code?: never;
     name: string;
 }
 
 interface InCodeTypeRef {
-    id?: never;
+    ref_type: 'incode';
     /**
      * Namespaced identifier for in-code types (e.g. "sys:Invoice", "app:myapp:Contract")
      */
-    code: string;
+    id: string;
     name: string;
 }
 
-export interface ComplexSearchPayload extends Omit<SearchPayload, "query"> {
+export interface ComplexSearchPayload extends Omit<SearchPayload, 'query'> {
     query?: ComplexSearchQuery;
 }
 
@@ -472,9 +478,9 @@ export interface ColumnLayout {
     /**
      * A default value to be used if the field is not present in the object
      */
-    default?: any;
+    default?: unknown;
 }
-export interface ContentObjectType extends ContentObjectTypeItem { }
+export interface ContentObjectType extends ContentObjectTypeItem {}
 export interface ContentObjectTypeItem extends BaseObject {
     is_chunkable?: boolean;
     /**
@@ -486,14 +492,23 @@ export interface ContentObjectTypeItem extends BaseObject {
      * this is only included in ContentObjectTypeItem if explicitly requested
      * It is always included in ContentObjectType
      */
-    object_schema?: Record<string, any>; // an optional JSON schema for the object properties.
+    object_schema?: Record<string, unknown>; // an optional JSON schema for the object properties.
 
     /**
      * Determines if the content will be validated against the object schema a generation time and save/update time.
      */
     strict_mode?: boolean;
 }
-export type InCodeTypeDefinition = Pick<ContentObjectTypeItem, 'id' | 'name' | 'description' | 'tags' | 'object_schema' | 'table_layout' | 'is_chunkable' | 'strict_mode'>;
+export type InCodeTypeDefinition = Pick<
+    ContentObjectTypeItem,
+    'id' | 'name' | 'description' | 'tags' | 'object_schema' | 'table_layout' | 'is_chunkable' | 'strict_mode'
+>;
+export interface ContentObjectTypeCatalogEntry extends InCodeTypeDefinition {
+    updated_by?: string;
+    created_by?: string;
+    created_at?: string;
+    updated_at?: string;
+}
 /**
  * The itnerface to be used whend efining types in a plugin app.
  */
@@ -509,15 +524,12 @@ export function isInCodeType(typeId: string): boolean {
 }
 
 export interface CreateContentObjectTypePayload
-    extends Omit<
-        ContentObjectType,
-        "id" | "created_at" | "updated_at" | "created_by" | "updated_by"
-    > { }
+    extends Omit<ContentObjectType, 'id' | 'created_at' | 'updated_at' | 'created_by' | 'updated_by'> {}
 
 export enum WorkflowRuleInputType {
-    single = "single",
-    multiple = "multiple",
-    none = "none",
+    single = 'single',
+    multiple = 'multiple',
+    none = 'none',
 }
 export interface WorkflowRuleItem extends BaseObject {
     // the name of the workflow function
@@ -528,11 +540,11 @@ export interface WorkflowRule extends WorkflowRuleItem {
     /*
      * mongo matching rules for a content event
      */
-    match?: Record<string, any>;
+    match?: Record<string, unknown>;
     /**
      * Activities configuration if any.
      */
-    config?: Record<string, any>;
+    config?: Record<string, unknown>;
 
     /**
      * Debug mode for the rule
@@ -557,19 +569,17 @@ export interface CreateWorkflowRulePayload extends UploadWorkflowRulePayload {
     endpoint: string; // required
 }
 export interface UploadWorkflowRulePayload
-    extends Partial<
-        Omit<WorkflowRule, "id" | "created_at" | "updated_at" | "owner">
-    > { }
+    extends Partial<Omit<WorkflowRule, 'id' | 'created_at' | 'updated_at' | 'owner'>> {}
 
 export enum ImageRenditionFormat {
-    jpeg = "jpeg",
-    png = "png",
-    webp = "webp",
+    jpeg = 'jpeg',
+    png = 'png',
+    webp = 'webp',
 }
 
 export enum MarkdownRenditionFormat {
-    docx = "docx",
-    pdf = "pdf",
+    docx = 'docx',
+    pdf = 'pdf',
 }
 
 export interface GetRenditionParams {
@@ -581,14 +591,14 @@ export interface GetRenditionParams {
 }
 
 export interface GetRenditionResponse {
-    status: "found" | "generating" | "failed";
+    status: 'found' | 'generating' | 'failed';
     renditions?: string[]; //file paths for the renditions
     workflow_run_id?: string;
 }
 
 export interface ObjectSearchResponse {
-    results: ContentObjectItem<Record<string, unknown>>[];
-    facets: import('../facets.js').ComputedFacetResponse;
+    results: ContentObjectItem[];
+    facets: ComputedFacetResponse;
     aggregations?: Record<string, unknown>;
 }
 
@@ -643,7 +653,7 @@ export function canGenerateRendition(contentType: string | undefined, format: Re
 
     // Check exact match first
     const exactMatch = RENDITION_COMPATIBILITY[contentType];
-    if (exactMatch && exactMatch.some(f => f === formatStr)) {
+    if (exactMatch?.some((f) => f === formatStr)) {
         return true;
     }
 
@@ -651,7 +661,7 @@ export function canGenerateRendition(contentType: string | undefined, format: Re
     const [category] = contentType.split('/');
     const wildcardKey = `${category}/*`;
     const wildcardMatch = RENDITION_COMPATIBILITY[wildcardKey];
-    if (wildcardMatch && wildcardMatch.some(f => f === formatStr)) {
+    if (wildcardMatch?.some((f) => f === formatStr)) {
         return true;
     }
 
@@ -716,7 +726,7 @@ export interface GetFileUrlPayload {
     // Optional filename to use in Content-Disposition for downloads
     name?: string;
     // Optional disposition for downloads (default: attachment)
-    disposition?: "inline" | "attachment";
+    disposition?: 'inline' | 'attachment';
 }
 
 export interface GetFileUrlResponse {
@@ -726,6 +736,22 @@ export interface GetFileUrlResponse {
     path: string;
 }
 
+export interface EnsureBucketReadAccessPayload {
+    principal: string;
+}
+
+export interface EnsureBucketReadAccessResponse {
+    bucket: string;
+    principal: string;
+    granted: boolean;
+}
+
+export interface BucketReadAccessStatusResponse {
+    bucket: string;
+    principal: string;
+    hasAccess: boolean;
+}
+
 export interface FileMetadataResponse {
     name: string;
     size: number;
@@ -811,6 +837,6 @@ export interface DeleteFileResult {
 }
 
 export enum ContentObjectProcessingPriority {
-    normal = "normal",
-    low = "low",
+    normal = 'normal',
+    low = 'low',
 }

package/src/store/task.ts

@@ -0,0 +1,71 @@
+/**
+ * Durable human task types used by process human_task nodes and agent asks.
+ */
+
+export type DurableTaskStatus = 'pending' | 'in_progress' | 'completed' | 'cancelled';
+
+export type TaskFieldType = 'string' | 'number' | 'boolean' | 'select' | 'text';
+
+export interface TaskField {
+    name: string;
+    type: TaskFieldType;
+    required?: boolean;
+    label?: string;
+    options?: string[];
+    default?: unknown;
+}
+
+export interface TaskSource {
+    type: 'process' | 'agent';
+    run_id: string;
+    node?: string;
+    ask_id?: string;
+}
+
+export interface Task {
+    id: string;
+    account: string;
+    project: string;
+    title: string;
+    description?: string;
+    status: DurableTaskStatus;
+    assignee?: string;
+    fields: TaskField[];
+    result?: Record<string, unknown>;
+    source: TaskSource;
+    due_at?: Date;
+    created_at: Date;
+    completed_at?: Date;
+    updated_at?: Date;
+}
+
+export interface CreateTaskPayload {
+    title: string;
+    description?: string;
+    assignee?: string;
+    fields?: TaskField[];
+    source: TaskSource;
+    due_at?: Date;
+}
+
+export interface UpdateTaskPayload {
+    title?: string;
+    description?: string;
+    status?: DurableTaskStatus;
+    assignee?: string | null;
+    fields?: TaskField[];
+    due_at?: Date | null;
+}
+
+export interface CompleteTaskPayload {
+    result: Record<string, unknown>;
+}
+
+export interface ListTasksQuery {
+    status?: DurableTaskStatus | DurableTaskStatus[];
+    assignee?: string;
+    run_id?: string;
+    source_type?: TaskSource['type'];
+    limit?: number;
+    offset?: number;
+}

package/src/store/temporalio.ts

@@ -2,15 +2,15 @@
  * Copied from temporalio
  * The temporalio ParentClosePolicy
  */
-export type ParentClosePolicyType = "TERMINATE" | "ABANDON" | "REQUEST_CANCEL" | undefined;
+export type ParentClosePolicyType = 'TERMINATE' | 'ABANDON' | 'REQUEST_CANCEL' | undefined;
 interface ParentClosePolicyI {
-    TERMINATE: "TERMINATE",
-    ABANDON: "ABANDON",
-    REQUEST_CANCEL: "REQUEST_CANCEL",
-    PARENT_CLOSE_POLICY_UNSPECIFIED: undefined,
-    PARENT_CLOSE_POLICY_TERMINATE: "TERMINATE",
-    PARENT_CLOSE_POLICY_ABANDON: "ABANDON",
-    PARENT_CLOSE_POLICY_REQUEST_CANCEL: "REQUEST_CANCEL"
+    TERMINATE: 'TERMINATE';
+    ABANDON: 'ABANDON';
+    REQUEST_CANCEL: 'REQUEST_CANCEL';
+    PARENT_CLOSE_POLICY_UNSPECIFIED: undefined;
+    PARENT_CLOSE_POLICY_TERMINATE: 'TERMINATE';
+    PARENT_CLOSE_POLICY_ABANDON: 'ABANDON';
+    PARENT_CLOSE_POLICY_REQUEST_CANCEL: 'REQUEST_CANCEL';
 }
 export const ParentClosePolicy = {
     /**
@@ -18,15 +18,15 @@ export const ParentClosePolicy = {
      *
      * @default
      */
-    TERMINATE: "TERMINATE",
+    TERMINATE: 'TERMINATE',
     /**
      * When the Parent is Closed, nothing is done to the Child.
      */
-    ABANDON: "ABANDON",
+    ABANDON: 'ABANDON',
     /**
      * When the Parent is Closed, the Child is Cancelled.
      */
-    REQUEST_CANCEL: "REQUEST_CANCEL",
+    REQUEST_CANCEL: 'REQUEST_CANCEL',
     /**
      * If a `ParentClosePolicy` is set to this, or is not set at all, the server default value will be used.
      *
@@ -38,17 +38,17 @@ export const ParentClosePolicy = {
      *
      * @deprecated Use {@link ParentClosePolicy.TERMINATE} instead.
      */
-    PARENT_CLOSE_POLICY_TERMINATE: "TERMINATE",
+    PARENT_CLOSE_POLICY_TERMINATE: 'TERMINATE',
     /**
      * When the Parent is Closed, nothing is done to the Child.
      *
      * @deprecated Use {@link ParentClosePolicy.ABANDON} instead.
      */
-    PARENT_CLOSE_POLICY_ABANDON: "ABANDON",
+    PARENT_CLOSE_POLICY_ABANDON: 'ABANDON',
     /**
      * When the Parent is Closed, the Child is Cancelled.
      *
      * @deprecated Use {@link ParentClosePolicy.REQUEST_CANCEL} instead.
      */
-    PARENT_CLOSE_POLICY_REQUEST_CANCEL: "REQUEST_CANCEL"
+    PARENT_CLOSE_POLICY_REQUEST_CANCEL: 'REQUEST_CANCEL',
 } as ParentClosePolicyI;

package/src/store/workflow.test.ts

@@ -1,15 +1,15 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
 import {
+    type AgentMessage,
     AgentMessageType,
-    AgentMessage,
-    CompactMessage,
-    normalizeMessageType,
-    toCompactMessage,
-    toAgentMessage,
-    parseMessage,
+    type CompactMessage,
+    createCompactMessage,
     isCompactMessage,
     isLegacyMessage,
-    createCompactMessage,
+    normalizeMessageType,
+    parseMessage,
+    toAgentMessage,
+    toCompactMessage,
 } from './workflow.js';
 
 describe('CompactMessage converters', () => {
@@ -78,12 +78,14 @@ describe('CompactMessage converters', () => {
     describe('isLegacyMessage', () => {
         it('returns true for legacy messages', () => {
             expect(isLegacyMessage({ type: AgentMessageType.UPDATE })).toBe(true);
-            expect(isLegacyMessage({
-                type: AgentMessageType.ANSWER,
-                timestamp: 12345,
-                workflow_run_id: 'run-1',
-                message: 'test'
-            })).toBe(true);
+            expect(
+                isLegacyMessage({
+                    type: AgentMessageType.ANSWER,
+                    timestamp: 12345,
+                    workflow_run_id: 'run-1',
+                    message: 'test',
+                }),
+            ).toBe(true);
         });
 
         it('returns false for compact messages', () => {