@luminocity/lemonate-gateway 8.2.26 → 8.2.28

package/dist/index.d.ts

@@ -3,16 +3,10 @@ import * as axios from 'axios';
 import { AxiosInstance, ResponseType } from 'axios';
 import WebSocket from 'isomorphic-ws';
 import FormData from 'form-data';
-import { CustomField as CustomField$1, CustomFieldDefinition as CustomFieldDefinition$1 } from '@/repo/CustomField';
 import { WebsocketProvider } from 'y-websocket';
 import * as awarenessProtocol from 'y-protocols/awareness';
-import { CollabDocument } from '@/collabstate/CollabDocument';
-import { ItemCopier } from '@/ItemCopier';
-import { ExecutableExporter } from '@/ExecutableExporter';
+import * as Y from 'yjs';
 import { Buffer as Buffer$1 } from 'buffer';
-import { ScriptItem as ScriptItem$1, Script as Script$1 } from '@/repo/Script';
-import { ScriptField as ScriptField$1 } from '@/repo/ScriptField';
-import { TemplateEntry as TemplateEntry$1 } from '@/repo/TemplateEntry';
 
 declare class Snapshot {
     id: string;
@@ -681,7 +675,7 @@ declare class JobManager {
     jobs: Map<string, JobEntry>;
     constructor(apiClient: any);
     getJobs(): JobEntry[];
-    execute(type: string, elements: any[], parameters: any[], progressCallback: Function | undefined, requiredParameters: any): Promise<JobState>;
+    execute(type: string, elements: any[], parameters: any[], progressCallback?: Function | undefined, requiredParameters?: any): Promise<JobState>;
 }
 
 type PublishedVersion = {
@@ -955,6 +949,34 @@ declare class Field extends Snapshotable {
     rollbackFromSnapshot(snapshot: Snapshot): void;
 }
 
+type CustomFieldDefinition = {
+    name: string;
+    defaultValue: any;
+    type: string;
+};
+declare class CustomField extends Snapshotable {
+    id: string;
+    name: string | undefined;
+    displayName: string | undefined;
+    value: any;
+    type: string | undefined;
+    datatype: string | undefined;
+    linkableTypes: string[];
+    order: number;
+    constructor(name?: string | undefined, value?: any | undefined, item?: PreparedItem | undefined);
+    getId(): string;
+    setName(name: string | undefined): void;
+    setType(name: string): void;
+    setOrder(order: number): void;
+    clone(fieldOverrides?: Map<string, string>): CustomField;
+    clearDefinition(): void;
+    setDefinition(def: any): void;
+    _toBoolean(value: any): any;
+    _updateDisplayName(): void;
+    createSnapshot(): Snapshot;
+    rollbackFromSnapshot(snapshot: Snapshot): void;
+}
+
 declare class PreparedItem extends AggregatedItem {
     links?: {
         to: string;
@@ -966,7 +988,7 @@ declare class PreparedItem extends AggregatedItem {
     isDirty: boolean;
     fieldInstances: Field[];
     userFieldInstances: Field[];
-    customFieldInstances: CustomField$1[];
+    customFieldInstances: CustomField[];
     packageContent?: PreparedItem;
     packageType?: string;
     public: boolean;
@@ -978,8 +1000,8 @@ declare class PreparedItem extends AggregatedItem {
     resultingAcl?: Acl;
     userData: any;
     constructor(data: any);
-    createCustomFieldInstances(definitions: CustomFieldDefinition$1[]): void;
-    addCustomField(customField: CustomField$1): void;
+    createCustomFieldInstances(definitions: CustomFieldDefinition[]): void;
+    addCustomField(customField: CustomField): void;
     markDirty(): void;
     makeIdsUnique(): void;
     clone(makeIdsUnique?: boolean): PreparedItem;
@@ -1273,6 +1295,9 @@ declare global {
     }
 }
 
+declare class CollabDocument extends Y.Doc {
+}
+
 type CollabUser = {
     id: string;
     key: number;
@@ -1305,6 +1330,33 @@ declare class Collab {
     endCollaboration(): void;
 }
 
+type CopyElement = {
+    _id: string;
+    isFolder: boolean;
+};
+type CopyElementTestResult = {
+    _id: string;
+    name: string | undefined;
+    isFolder: boolean;
+    conflicted: boolean;
+    conflictedItemId: string | undefined;
+    data: any;
+};
+declare class ItemCopier {
+    apiClient: ApiClient;
+    constructor(apiClient: ApiClient);
+    testCopyItems(elements: CopyElement[], targetFolderId: string): Promise<CopyElementTestResult[]>;
+    copyItems(elements: CopyElementTestResult[], targetFolderId: string, deepCopy?: boolean, overwrite?: boolean): Promise<ItemCopyResult[]>;
+}
+
+type Platform = "windows" | "linux" | "macos";
+declare class ExecutableExporter {
+    apiClient: ApiClient;
+    jobManager: JobManager;
+    constructor(apiClient: ApiClient);
+    executeExport(packageId: string, platform: Platform, destinationFolderId: string, engineVersion: string): Promise<void>;
+}
+
 /**
  * @fileoverview ApiClient class for handling API interactions with the Lumino cloud service.
  * @module ApiClient
@@ -1333,6 +1385,7 @@ type ApiClientOptions = {
     storageSizeMib: number;
     requestClientId: string | null;
     debug: boolean;
+    withCollaboration: boolean;
 };
 type ItemCopyResult = {
     original: string;
@@ -1373,7 +1426,7 @@ declare class ApiClient extends EventEmitter {
     attachmentCache: AttachmentCache;
     jobManager: JobManager;
     serializer: Serializer;
-    collab: Collab;
+    collab?: Collab;
     itemCopier: ItemCopier;
     executableExporter: ExecutableExporter;
     eventBus: typeof eventBus;
@@ -1421,7 +1474,7 @@ declare class ApiClient extends EventEmitter {
     websocketSend(data: string): void;
     getItemCopier(): ItemCopier;
     getExecutableExporter(): ExecutableExporter;
-    getCollab(): Collab;
+    getCollab(): Collab | undefined;
     getCollabUrl(): string;
     /**
      * Get a new Publisher instance.
@@ -3980,7 +4033,7 @@ declare class ItemPreparator {
     setItemFetcher(itemFetcher: Function): void;
     setFieldsFromDatatypes(item: PreparedItem): void;
     prepare(item: any): Promise<PreparedItem>;
-    createCustomFieldInstances(item: PreparedItem, attributes: Record<string, unknown>, prefix?: string): Promise<CustomField$1[]>;
+    createCustomFieldInstances(item: PreparedItem, attributes: Record<string, unknown>, prefix?: string): Promise<CustomField[]>;
     createFieldInstances(item: PreparedItem, fields: any[], attributes: Record<string, unknown>, path: string, attributeSrc: string, doNotFillValues?: boolean): Promise<Field[]>;
     getFieldSet(item: PreparedItem, name: string): {
         name: string;
@@ -4342,11 +4395,11 @@ declare class Proxifier {
     proxyItemField(field: Field, item: any): any;
     proxyGraphBlockField(field: Field, block: Block, item: PreparedItem): any;
     proxyBlockField(field: Field, block: Block, item: PreparedItem): any;
-    proxyScriptItem(scriptItem: ScriptItem$1, script: Script$1, item: PreparedItem): any;
-    proxyScriptFieldsArray(fields: ScriptField$1[], script: Script$1, item: PreparedItem): any[];
-    proxyScriptField(field: ScriptField$1, script: Script$1, item: PreparedItem): any;
-    proxyCustomFieldsArray(fields: CustomField$1[], item: PreparedItem): any[];
-    proxyCustomField(field: CustomField$1, item: PreparedItem): any;
+    proxyScriptItem(scriptItem: ScriptItem, script: Script, item: PreparedItem): any;
+    proxyScriptFieldsArray(fields: ScriptField[], script: Script, item: PreparedItem): any[];
+    proxyScriptField(field: ScriptField, script: Script, item: PreparedItem): any;
+    proxyCustomFieldsArray(fields: CustomField[], item: PreparedItem): any[];
+    proxyCustomField(field: CustomField, item: PreparedItem): any;
 }
 
 declare const _default: {
@@ -12254,9 +12307,9 @@ declare class TemplateFactory {
     private static _instance;
     static get instance(): TemplateFactory;
     private _existsTemplate;
-    addTemplates(itemType: string, fieldName: string, templates: TemplateEntry$1[]): void;
-    getTemplate(itemType: string, fieldName: string, templateName: string): TemplateEntry$1 | undefined;
-    getTemplates(itemType: string, fieldName: string): TemplateEntry$1[];
+    addTemplates(itemType: string, fieldName: string, templates: TemplateEntry[]): void;
+    getTemplate(itemType: string, fieldName: string, templateName: string): TemplateEntry | undefined;
+    getTemplates(itemType: string, fieldName: string): TemplateEntry[];
 }
 
 declare class LinkableItemsCache {
@@ -12270,33 +12323,5 @@ declare class LinkableItemsCache {
     loadLinkableItems(item: any, field: Field): Promise<any[] | undefined>;
 }
 
-type CustomFieldDefinition = {
-    name: string;
-    defaultValue: any;
-    type: string;
-};
-declare class CustomField extends Snapshotable {
-    id: string;
-    name: string | undefined;
-    displayName: string | undefined;
-    value: any;
-    type: string | undefined;
-    datatype: string | undefined;
-    linkableTypes: string[];
-    order: number;
-    constructor(name?: string | undefined, value?: any | undefined, item?: PreparedItem | undefined);
-    getId(): string;
-    setName(name: string | undefined): void;
-    setType(name: string): void;
-    setOrder(order: number): void;
-    clone(fieldOverrides?: Map<string, string>): CustomField;
-    clearDefinition(): void;
-    setDefinition(def: any): void;
-    _toBoolean(value: any): any;
-    _updateDisplayName(): void;
-    createSnapshot(): Snapshot;
-    rollbackFromSnapshot(snapshot: Snapshot): void;
-}
-
 export { AccessDeniedException, AggregatedItem, ApiClient, ApiGateway, Block, CustomField, EventEmitter, Field, InvalidArgumentException, InvalidStateException, Item, ItemCache$1 as ItemCache, ItemRepo, ItemVisibility, LinkableItemsCache, LoaderException, Package as PackageTools, PreparedItem, Profiler, Proxifier, ProxyEvent, QuotaExceededException, Script, ScriptField, Snapshot, Storage, Template, TemplateFactory, ThumbCache, UndoManager, eventBus, getDatatypeByName, getDatatypes, hasPermission, profileAsyncBlock, profileBlock, _default as tools, verifyAcl };
 export type { Acl, Attachments, BaseBlogArticle, ConversationEntry, CustomFieldDefinition, FolderListingOptions, FolderListingWithOptions, ItemOptions, ItemQueryOptions, ItemQueryWithOptions, ItemWithOptions, JobState, Me, ProgressCallback$1 as ProgressCallback, UserInfo };