@vertesia/common 0.42.2

package/src/store/store.ts

@@ -0,0 +1,262 @@
+import { SearchPayload } from '../payload.js';
+import { SupportedEmbeddingTypes } from '../project.js';
+import { ComplexSearchQuery } from '../query.js';
+import { BaseObject } from './common.js';
+import { RenditionProperties } from './index.js';
+
+export enum ContentObjectStatus {
+    created = 'created',
+    processing = 'processing', // the was created and still processing
+    completed = 'completed',
+    failed = 'failed',
+    archived = 'archived',
+}
+
+
+export interface Embedding {
+    model: string; //the model used to generate this embedding
+    values: number[];
+    etag?: string; // the etag of the text used for the embedding
+}
+
+export interface ContentObject<T = any> extends ContentObjectItem<T> {
+    text?: string; // the text representation of the object
+    text_etag?: string;
+    embeddings: Partial<Record<SupportedEmbeddingTypes, Embedding>>;
+    parts?: string[]; // the list of objectId of the parts of the object
+    parts_etag?: string; // the etag of the text used for the parts list
+    transcript?: Transcript;
+}
+
+
+export type ContentNature = 'video' | 'image' | 'audio' | 'document' | 'code' | 'other';
+
+export interface Dimensions {
+    width: number;
+    height: number;
+}
+
+export interface Location {
+    latitude: number;
+    longitude: number;
+}
+
+export interface GenerationRunMetadata {
+    id: string;
+    date: string;
+    model: string;
+    target?: string;
+}
+
+export interface ContentMetadata {
+    // Common fields for all media types
+    type?: ContentNature;
+    size?: number;      // in bytes
+    language?: string;
+    location?: Location;
+    generation_runs: GenerationRunMetadata[];
+    etag?: string;
+}
+
+// Example of type-specific metadata interfaces (optional, for better type safety)
+export interface TemporalMediaMetadata extends ContentMetadata {
+    duration?: number; // in seconds
+    transcript?: Transcript
+}
+
+export interface ImageMetadata extends ContentMetadata {
+    type: 'image';
+    dimensions?: Dimensions;
+}
+
+export interface AudioMetadata extends TemporalMediaMetadata {
+    type: 'audio';
+}
+
+export interface VideoMetadata extends TemporalMediaMetadata {
+    type: 'video';
+    dimensions?: Dimensions;
+}
+
+export interface DocumentMetadata extends ContentMetadata {
+    type: 'document';
+    page_count?: number;
+}
+
+export interface Transcript {
+    text?: string;
+    segments?: TranscriptSegment[];
+    etag?: string;
+}
+
+export interface TranscriptSegment {
+    start: number
+    text: string
+    speaker?: number
+    end?: number
+    language?: string
+    confidence?: number
+}
+
+export interface ContentSource {
+    // the URI of the content source. Usually an URL to the uploaded file inside a cloud file storage like s3.
+    source?: string;
+    // the mime type of the content source.
+    type?: string;
+    // the original name of the input file if any
+    name?: string;
+    // the etag of the content source if any
+    etag?: string;
+}
+
+/**
+ * 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 = any> extends BaseObject {
+    root?: string; // the ID of the root parent object. The root object doesn't have the root field set.
+    parent: string; // the id of the direct parent object. The root object doesn't have the parent field set.
+    location: string; // the path of the parent object
+    status: ContentObjectStatus;
+    // A ref to the object type
+    type?: ContentObjectTypeRef;
+    // the content source URL and type
+    content: ContentSource;
+    external_id?: string;
+    properties: T | Record<string, any>; // a JSON object that describes the object
+    metadata?: VideoMetadata | AudioMetadata | ImageMetadata | DocumentMetadata | ContentMetadata;
+    tokens?: {
+        count: number; // the number of tokens in the text
+        encoding: string; // the encoding used to calculate the tokens
+        etag: string; //the etag of the text used for the token count
+    };
+    run?: string; // the ID of the interaction run that created the object
+}
+
+/**
+ * When creating from an uploaded file the content shouild 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'>> {
+    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 interface ContentObjectTypeRef {
+    id: string;
+    name: string;
+}
+
+export interface ComplexSearchPayload extends Omit<SearchPayload, 'query'> {
+    query?: ComplexSearchQuery;
+}
+
+export interface ColumnLayout {
+    /**
+     * The path of the field to use (e.g. "properties.title")
+     */
+    field: string;
+    /**
+     * The name to display in the table column
+     */
+    name: string;
+    /**
+     * The type of the field specifies how the rendering will be done. If not specified the string type will be used.
+     * The type may contain additional parameters prepended using a web-like query string syntax: date?LLL
+     */
+    type?: string;
+    /*
+     * a fallback field to use if the field is not present in the object
+     */
+    fallback?: string;
+    /**
+     * A default value to be used if the field is not present in the object
+     */
+    default?: any;
+}
+export interface ContentObjectType extends ContentObjectTypeItem {
+    object_schema?: Record<string, any>; // an optional JSON schema for the object properties.
+    table_layout?: ColumnLayout[]; // an optional table layout for the object properties.
+}
+export interface ContentObjectTypeItem extends BaseObject {
+    is_chunkable?: boolean;
+}
+/**
+ * Used to list types with their table layout if any
+ */
+export interface ContentObjectTypeLayout {
+    id: string;
+    name: string;
+    description?: string;
+    table_layout?: ColumnLayout[];
+}
+
+export interface CreateContentObjectTypePayload extends Omit<ContentObjectType, 'id' | 'created_at' | 'updated_at' | 'created_by' | 'updated_by'> {
+}
+
+export enum WorkflowRuleInputType {
+    single = 'single',
+    multiple = 'multiple',
+    none = 'none'
+}
+export interface WorkflowRuleItem extends BaseObject {
+    // the name of the workflow function
+    endpoint: string;
+    input_type: WorkflowRuleInputType;
+}
+export interface WorkflowRule extends WorkflowRuleItem {
+    /*
+     * mongo matching rules for a content event
+     */
+    match?: Record<string, any>;
+    /**
+     * Activities configuration if any.
+     */
+    config?: Record<string, any>;
+
+    /**
+     * Debug mode for the rule
+     * @default false
+     */
+    debug?: boolean;
+
+    /**
+     * Customer override for the rule
+     * When set to true the rule will not be updated by the system
+     */
+    customer_override?: boolean;
+}
+
+
+export interface CreateWorkflowRulePayload extends UploadWorkflowRulePayload {
+    name: string; // required
+    endpoint: string; // required
+}
+export interface UploadWorkflowRulePayload extends Partial<Omit<WorkflowRule, 'id' | 'created_at' | 'updated_at' | 'owner'>> {
+}
+
+export interface GetRenditionResponse {
+
+    status: 'found' | 'generating' | 'failed';
+    rendition?: ContentObject<RenditionProperties> //TODO add <Rendition>
+    workflow_run_id?: string;
+}
+
+export interface GetUploadUrlPayload {
+    name: string;
+    id?: string;
+    mime_type?: string;
+    ttl?: number;
+}
+
+export interface GetFileUrlPayload {
+    file: string;
+}
+
+export interface GetFileUrlResponse {
+    url: string;
+    id: string;
+    mime_type: string;
+    path: string;
+}

package/src/store/temporalio.ts

@@ -0,0 +1,54 @@
+/**
+ * Copied from temporalio
+ * The temporalio ParentClosePolicy
+ */
+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"
+}
+export const ParentClosePolicy = {
+    /**
+     * When the Parent is Closed, the Child is Terminated.
+     *
+     * @default
+     */
+    TERMINATE: "TERMINATE",
+    /**
+     * When the Parent is Closed, nothing is done to the Child.
+     */
+    ABANDON: "ABANDON",
+    /**
+     * When the Parent is Closed, the Child is Cancelled.
+     */
+    REQUEST_CANCEL: "REQUEST_CANCEL",
+    /**
+     * If a `ParentClosePolicy` is set to this, or is not set at all, the server default value will be used.
+     *
+     * @deprecated Either leave property `undefined`, or set an explicit policy instead.
+     */
+    PARENT_CLOSE_POLICY_UNSPECIFIED: undefined,
+    /**
+     * When the Parent is Closed, the Child is Terminated.
+     *
+     * @deprecated Use {@link ParentClosePolicy.TERMINATE} instead.
+     */
+    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",
+    /**
+     * When the Parent is Closed, the Child is Cancelled.
+     *
+     * @deprecated Use {@link ParentClosePolicy.REQUEST_CANCEL} instead.
+     */
+    PARENT_CLOSE_POLICY_REQUEST_CANCEL: "REQUEST_CANCEL"
+} as ParentClosePolicyI;

package/src/store/workflow.ts

@@ -0,0 +1,156 @@
+
+export enum ContentEventName {
+    create = "create",
+    change_type = "change_type",
+    update = "update",
+    delete = "delete",
+    workflow_finished = "workflow_finished",
+    workflow_execution_request = "workflow_execution_request",
+}
+
+
+export interface WorkflowExecutionPayload {
+    /**
+     * The event which started the workflow who created the activity.
+     */
+    event: ContentEventName;
+
+    /**
+     * The account ID of the user who created the activity.
+     * This is usefull to select the right database to work on.
+     */
+    account_id: string;
+
+    /**
+     * The project ID of the account who created the activity.
+     */
+    project_id: string;
+
+    /**
+     * The Unix timestamp when the workflow was started.
+     */
+    timestamp: number;
+
+    /*
+     * The Workflow Rule ID if any. If the workflow was started by a rule this field will contain the rule ID
+     * otherwise if the workflow was started on demand the property will be undefined.
+     */
+    wf_rule_name?: string;
+
+    /**
+     * The vars field is mainly used to pass the user input to the workflow.
+     * The user input ar custom user options that can be used to configure the workflow.
+     * You can see the user input as the arguments for a command line app.
+     *
+     * In the case of workflows started by events (e.g. using a a workflow rule) the user input vars will be initialized with the workflow rule configuration field.
+     *
+     * In case of dsl workflows the worflow execution payload vars will be applied over the default vars values stored in the DSL vars field.
+     */
+    vars: Record<string, any>;
+
+    /**
+     * Auth Token to access Zeno and Composable from the workers
+     */
+    auth_token: string;
+
+    /**
+     * The ID of the target objects processed by the workflow.
+     */
+    objectIds: string[];
+
+    /**
+     * The configuration for the workflow execution.
+     */
+    config?: {
+        studio_url: string;
+        store_url: string;
+        enabled_integrations?: string[]; //list of enabled integrations
+    }
+}
+
+
+export interface ExecuteWorkflowPayload {
+    objectIds?: string[];
+    vars?: Record<string, any>;
+}
+
+export interface ListWorkflowRunsPayload {
+    document_id?: string;
+    event_name?: string;
+    rule_id?: string;
+    start?: string;
+    end?: string;
+    status?: string;
+    search_term?: string;
+}
+
+interface WorkflowRunEvent {
+    event_id: number;
+    event_time: number;
+    event_type: string;
+    task_id: string;
+    attempt: number;
+
+    activity?: {
+        name: string;
+        id: string;
+        input?: any;
+    }
+
+    error?: {
+        message: string;
+        source: string;
+        stacktrace: string;
+        type?: string;
+    };
+
+    result?: any
+
+}
+
+export interface WorkflowRun {
+    status?: WorkflowExecutionStatus | string,
+    type?: string,
+    started_at?: number,
+    closed_at?: number,
+    execution_duration?: number,
+    run_id?: string,
+    workflow_id?: string,
+    raw?: any
+}
+
+export interface WorkflowRunWithDetails extends WorkflowRun {
+    history?: WorkflowRunEvent[];
+}
+export interface ListWorkflowRunsResponse {
+    runs: WorkflowRun[];
+}
+
+export interface MultiDocumentsInteractionParams extends Omit<WorkflowExecutionPayload, 'config'> {
+    config: {
+        interactionName: string;
+        action: DocumentActionConfig;
+        data: Record<string, any>;
+    }
+}
+
+export interface DocumentActionConfig {
+    contentTypeName?: string; //content type to use
+    setAsProperties: boolean; //set result as properties
+    setAsText: string; //set result as text, if result set the whole result as text
+    setNameFrom: string; //result property to use as name
+    upsert: boolean; //wether to upsert or update only
+    documentId?: string; //doc Id to update
+    parentId?: string; //parentId for the created doc
+}
+
+export enum WorkflowExecutionStatus {
+    UNKNOWN = 0,
+    RUNNING = 1,
+    COMPLETED = 2,
+    FAILED = 3,
+    CANCELED = 4,
+    TERMINATED = 5,
+    CONTINUED_AS_NEW = 6,
+    TIMED_OUT = 7,
+}

package/src/training.ts

@@ -0,0 +1,44 @@
+import { TrainingJob } from "@llumiverse/core";
+import { ExecutionEnvironmentRef } from "./environment.js";
+
+export enum TrainingSessionStatus {
+    'created' = 'created',
+    'building' = 'building',
+    'prepared' = 'prepared',
+    'processing' = 'processing',
+    'completed' = 'completed',
+    'cancelled' = 'cancelled',
+    'failed' = 'failed'
+}
+
+export interface TrainingSession {
+    id: string;
+    project: string;
+    name: string
+    env: ExecutionEnvironmentRef,
+    model: string,
+    status: TrainingSessionStatus,
+    runs: string[],
+    dataset: string, //the name of the file dataset which was generated in GCS
+    job: TrainingJob,
+    created_by: string,
+    updated_by: string,
+    created_at: Date,
+    updated_at: Date,
+}
+
+export interface TrainingSessionRef extends Omit<TrainingSession, 'runs'> {
+}
+
+
+export interface TrainingSessionCreatePayload {
+    name: string
+    env: string,
+    model: string,
+}
+
+export interface ListTrainingSessionsQuery {
+    limit?: number;
+    offset?: number;
+    status?: TrainingSessionStatus;
+}

package/src/transient-tokens.ts

@@ -0,0 +1,30 @@
+import { ProjectRoles } from "./project.js";
+import { AccountRef } from "./user.js";
+
+
+export enum TransientTokenType {
+    userInvite = 'user-invite',
+    migration = 'migration',
+}
+
+export interface TransientToken<T> {
+    id: string;
+    type: TransientTokenType;
+    data: T;
+    expires: Date;
+    account?: string;
+    created_at: Date;
+    updated_at: Date;
+}
+
+
+export interface CreateOrUpdateTransientTokenPayload<T> extends Partial<TransientToken<T>> {
+}
+
+export interface UserInviteTokenData {
+    email: string;
+    role: ProjectRoles;
+    account: AccountRef;
+    projects?: string[];
+    invitedBy: { name: string, email: string; };
+}

package/src/user.ts

@@ -0,0 +1,124 @@
+import { ApiKey } from "./apikey.js";
+import { ProjectRoles } from "./project.js";
+
+export interface UserWithAccounts extends User {
+    accounts: AccountRef[];
+}
+export interface User {
+    id: string;
+    externalId: string;
+    email: string;
+    name: string;
+    username?: string;
+    picture?: string;
+    language?: string;
+    phone?: string;
+    sign_in_provider?: string;
+    last_selected_account?: string;
+}
+
+export interface UserRef {
+    id: string;
+    name: string;
+    email: string;
+    picture?: string;
+}
+export const UserRefPopulate = "id name email picture";
+
+export enum Datacenters {
+    aws = 'aws',
+    gcp = 'gcp',
+    azure = 'azure'
+}
+
+export interface Account {
+    id: string;
+    name: string;
+
+    email_domains: string[];
+    members: {
+        role: ProjectRoles;
+        user: UserRef;
+        disabled: boolean;
+    }[];
+
+    onboarding: {
+        completed: boolean,
+        completed_at: Date,
+    };
+
+    datacenter: string;
+
+    created_by: string;
+    updated_by: string;
+    created_at: string;
+    updated_at: string;
+}
+
+export interface UpdateAccountPayload {
+    name?: string;
+    email_domains?: string[];
+}
+
+export interface AccountRef {
+    id: string;
+    name: string;
+}
+export const AccountRefPopulate = "id name";
+
+
+export interface InviteUserRequestPayload {
+    email: string;
+    role: ProjectRoles;
+    projects?: string[];
+}
+
+export interface InviteUserResponsePayload {
+    action: 'invited' | 'added';
+}
+
+
+type UserOrApiKey<T extends User | ApiKey> = T extends User ? User : ApiKey;
+type SessionType<T extends User | ApiKey> = T extends User ? "user" : "apikey";
+export interface SessionInfo<T extends User | ApiKey> {
+    isNew?: boolean;
+    type: SessionType<T>;
+    subject: UserOrApiKey<T>;
+    //User | ApiKey; // no user if using an apikey
+    current_account: Account;
+    //role: string; // TODO the role on the selected account
+    accounts: AccountRef[];
+}
+
+export interface UserSessionInfo extends SessionInfo<User> { }
+export interface ApiKeySessionInfo extends SessionInfo<ApiKey> { }
+
+export interface OnboardingProgress {
+    projects: boolean,
+    interactions: boolean,
+    prompts: boolean,
+    environments: boolean,
+    runs: boolean;
+    default_environment_defined: boolean
+}
+
+
+/**
+ * Data collected at signup
+ * used for onboarding and segments
+ **/
+export interface SignupData {
+    accountType: string;
+    companyName?: string;
+    companySize?: number;
+    companyWebsite?: string;
+    maturity?: string;
+}
+
+/**
+ * Signup Payload: used to create a new user
+ */
+export interface SignupPayload {
+    firebaseToken: string;
+    signupData: SignupData;
+}

package/src/utils/auth.ts

@@ -0,0 +1,12 @@
+import { ProjectRef } from "../project.js";
+
+export function getTenantId(accountId: string, projectId: string): string {
+    //use the last 6 characters of the accountId as the db name
+    //as in mongo the last 6 char are an incrementing counter
+    const accountLast6 = accountId.slice(-6);
+    const projectLast6 = projectId.slice(-6);
+    return accountLast6 + '_' + projectLast6;
+}
+export function getTenantIdFromProject(project: ProjectRef): string {
+    return getTenantId(project.account, project.id);
+}