@luminocity/lemonate-gateway 8.0.6 → 8.1.1-dev1

package/dist/index.d.ts

@@ -2,9 +2,13 @@ import moment from 'moment';
 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 { 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;
@@ -265,7 +269,6 @@ declare class AggregatedItem extends Item {
     }[];
     fields?: any[];
     userFields?: any[];
-    additionalUserAttributes?: Record<string, unknown>;
     readonly isAggregatedItem: boolean;
     constructor(data: any);
 }
@@ -850,25 +853,6 @@ declare class Connection extends Snapshotable {
     rollbackFromSnapshot(snapshot: Snapshot): void;
 }
 
-declare class ItemCache {
-    itemCache: Map<string, any>;
-    apiGateway: ApiGateway;
-    constructor(apiGateway: any);
-    clear(): void;
-    getItem(id: string): Promise<any>;
-}
-
-declare class LinkableItemsCache {
-    linkableItemsCache: Map<string, any[]>;
-    apiGateway: ApiGateway;
-    itemCache: ItemCache;
-    usePublicApi: boolean;
-    constructor(apiGateway: ApiGateway, itemCache: ItemCache, usePublicApi?: boolean);
-    clear(): void;
-    resolveItem(id: string, linkableItems: any[]): any;
-    loadLinkableItems(item: any, field: Field): Promise<any[] | undefined>;
-}
-
 declare class Template {
     fields: Field[];
     constructor(fields: Field[]);
@@ -878,7 +862,7 @@ declare class Template {
      * @param fieldValues object an object with new values for every field that should be changed
      */
     specialize(fieldValues: any): this;
-    instantiate(): Field[];
+    instantiate(copyInstantiate: boolean): Field[];
 }
 
 type TemplateEntry = {
@@ -904,7 +888,6 @@ declare class Field extends Snapshotable {
     dependantFields: Field[];
     dependenciesInitialized: boolean;
     linkableTypes: string[];
-    linkableItemsCache: LinkableItemsCache | undefined;
     collapsed: boolean;
     presets: any[];
     datatype: string | null;
@@ -917,8 +900,6 @@ declare class Field extends Snapshotable {
     labelType: string | null;
     blocks: Block[];
     connections: Connection[];
-    templates: TemplateEntry[];
-    elementName: string | null;
     private _id;
     private _internalValue;
     private _internalOptions;
@@ -930,8 +911,7 @@ declare class Field extends Snapshotable {
     set options(value: string[]);
     get value(): any;
     set value(value: any);
-    get linkableItems(): never[] | Promise<any[] | undefined>;
-    constructor(name: string | Snapshot, displayName?: string | undefined, type?: string | undefined, value?: any | undefined, item?: PreparedItem | undefined, itemRepo?: ItemRepo | undefined, linkableItemsCache?: LinkableItemsCache | undefined);
+    constructor(name: string | Snapshot, displayName?: string | undefined, type?: string | undefined, value?: any | undefined, item?: PreparedItem | undefined, itemRepo?: ItemRepo | undefined);
     updateConditions(): void;
     getId(): string;
     resetValue(): void;
@@ -962,14 +942,12 @@ declare class Field extends Snapshotable {
     setWidget(widget: any): void;
     setBlocks(blocks: any): void;
     setConnections(connections: any): void;
-    setTemplates(templates: any): void;
-    setElementName(name: any): void;
     setCollapsed(value: any): void;
     setPresets(value: any): void;
     setLabelType(value: string): void;
     createSnapshot(dontRecurseIntoBlocks?: boolean): Snapshot;
     restoreFromSnapshot(snapshot: Snapshot): void;
-    rollbackFromSnapshot(snapshot: any): void;
+    rollbackFromSnapshot(snapshot: Snapshot): void;
 }
 
 declare class PreparedItem extends AggregatedItem {
@@ -983,6 +961,7 @@ declare class PreparedItem extends AggregatedItem {
     isDirty: boolean;
     fieldInstances: Field[];
     userFieldInstances: Field[];
+    customFieldInstances: CustomField$1[];
     packageContent?: PreparedItem;
     packageType?: string;
     public: boolean;
@@ -993,6 +972,8 @@ declare class PreparedItem extends AggregatedItem {
     readonly isPreparedItem: boolean;
     resultingAcl?: Acl;
     constructor(data: any);
+    createCustomFieldInstances(definitions: CustomFieldDefinition$1[]): void;
+    addCustomField(customField: CustomField$1): void;
     markDirty(): void;
     makeIdsUnique(): void;
     clone(makeIdsUnique?: boolean): PreparedItem;
@@ -1194,7 +1175,7 @@ declare class Serializer {
      * @param {boolean} [options.omitPath] don't return path
      * @return {string|*[]}
      */
-    grab(item: PreparedItem, field: Field, blocks: Block[], options: any): string | any[];
+    grab(item: PreparedItem, field: Field, blocks: Block[], options: any): string | any[] | any;
     /**
      * Put elements in the project
      * @param msg the data to use to create new elements in the project
@@ -1230,7 +1211,6 @@ declare class Serializer {
     _findItemById(id: string): PreparedItem | undefined;
     _findItemField(item: PreparedItem, fieldName: string): Field | null;
     _findParentBlock(item: PreparedItem, fieldName: string, path: string): Block | null;
-    _getBlockTemplate(field: Field, name: string): TemplateEntry | null;
     _getBlockIndex(block: Block): number;
     _getBlockPath(block: Block): string;
     private _serializeBlockFields;
@@ -3917,10 +3897,18 @@ declare class ApiGateway {
     call(caller: string, method: string, ...params: any[]): Promise<any>;
 }
 
+declare class ItemCache {
+    itemCache: Map<string, any>;
+    apiGateway: ApiGateway;
+    constructor(apiGateway: any);
+    clear(): void;
+    getItem(id: string): Promise<any>;
+}
+
 declare class ItemChangeProcessor {
     updateItemLinksAndAttributes(item: PreparedItem, includeLinkItems: boolean, clearUnusedLinks: boolean): void;
     getLinksAndAttributes(item: PreparedItem, links: Array<any>, attributes: object, userAttributes: object, includeItems: boolean, clearUnusedLinks: boolean): void;
-    retrieveLinksAndAttributesFromFieldInstances(fieldInstances: Array<any>, links: Array<any>, attributes: object, includeLinkItems: boolean, clearUnusedLinks: boolean): void;
+    retrieveLinksAndAttributesFromFieldInstances(fieldInstances: Array<any>, links: Array<any>, attributes: object, includeLinkItems: boolean, clearUnusedLinks: boolean, fieldPrefix?: string): void;
     traverseTreeFieldInstance(blocks: Array<any>, links: Array<any>, attributes: object, path: string, includeLinkItems: boolean): void;
     traverseListFieldInstances(blocks: Array<any>, links: Array<any>, attributes: object, path: string, includeLinkItems: boolean): void;
     processScripts(scripts: Array<any>, links: Array<any>, attributes: object, path: string, includeLinkItems: boolean): void;
@@ -3933,6 +3921,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[]>;
     createFieldInstances(item: PreparedItem, fields: any[], attributes: Record<string, unknown>, path: string, attributeSrc: string, doNotFillValues?: boolean): Promise<Field[]>;
     getFieldSet(item: PreparedItem, name: string): {
         name: string;
@@ -3947,12 +3936,12 @@ declare class ItemPreparator {
         linkItem: null;
         stopRecursion?: undefined;
     }>;
-    readBlocks(item: PreparedItem, parentBlock: Block | undefined, templates: Array<any>, treeNamespace: string, attributes: Record<string, unknown>, readChildren: boolean, readScripts: boolean, parentType: string): Promise<Array<any>>;
+    readBlocks(item: PreparedItem, parentBlock: Block | undefined, fieldName: string, treeNamespace: string, attributes: Record<string, unknown>, readChildren: boolean, readScripts: boolean, parentType: string): Promise<Array<any>>;
     readScripts(item: PreparedItem, parentBlock: Block, treeNamespace: string, attributes: Record<string, unknown>): Promise<Array<any>>;
     existsScriptNamespace(item: PreparedItem, attributes: Record<string, unknown>, namespace: string): boolean;
     readConnections(item: PreparedItem, graphNamespace: string, attributes: Record<string, unknown>): Array<Connection>;
     existsBlockNamespace(item: PreparedItem, attributes: Record<string, unknown>, namespace: string): boolean;
-    createFields(block: Block, item: PreparedItem, template: Template, blockPath: string, isGraphBlockField: boolean, attributes: Record<string, unknown>): Promise<Field[]>;
+    createFields(block: Block, item: PreparedItem, template: Template, blockPath: string, isGraphBlockField: boolean, attributes: Record<string, unknown>, copyInstantiate?: boolean): Promise<Field[]>;
     static refreshFieldDependencies(fields: Field[]): void;
 }
 
@@ -4090,7 +4079,6 @@ declare class ItemRepo {
     jail: any;
     apiGateway: ApiGateway;
     itemCache: ItemCache;
-    linkableItemsCache: LinkableItemsCache;
     undoManager: UndoManager;
     itemPreparator: ItemPreparator;
     itemChangeProcessor: ItemChangeProcessor;
@@ -4104,7 +4092,7 @@ declare class ItemRepo {
     findLoadedItem(id: string): PreparedItem | undefined;
     _handleError(err: any, message: string): void;
     getUndoManager(): UndoManager;
-    createFieldsForItem(block: Block, template: Template, ownerItem: PreparedItem): Promise<Field[]>;
+    createFieldsForItem(block: Block, template: Template, ownerItem: PreparedItem, copyInstantiate?: boolean): Promise<Field[]>;
     createScriptsForItem(block: Block, scriptData: any[] | undefined, ownerItem: PreparedItem, proxify?: boolean): Promise<void>;
     clear(): void;
     removeBlock(block: Block, parent: any): void;
@@ -4134,6 +4122,7 @@ declare class ItemRepo {
     _loadItemFromApi(id: string, options?: any): Promise<any[]>;
     _relinkItems(items: PreparedItem[], referenceMap: Map<string, PreparedItem>): void;
     createItem(typeName: string, attributes: any): Promise<PreparedItem>;
+    getLoadedItem(id: string): PreparedItem | undefined;
     /**
      *
      * @param id
@@ -4161,6 +4150,7 @@ declare class ItemRepo {
         id: any;
         newName: any;
     }): void;
+    isItemKnown(itemId: string): boolean;
     invalidateId(itemId: string): void;
 }
 
@@ -4180,7 +4170,7 @@ declare class ProxyEvent {
     length?: number;
     position?: number;
     elementsToDelete?: any[];
-    field?: Field;
+    field?: string;
     fieldId?: string;
     isLink?: boolean;
     bundleIndex: number;
@@ -4195,7 +4185,7 @@ declare class ProxyEvent {
     setRange(start: number, length: number): void;
     setPosition(position: number): void;
     setElementsToDelete(elements: any[]): void;
-    setField(field: Field): void;
+    setField(field: string): void;
     setFieldId(id: string): void;
     setIsLink(isLink: boolean): void;
     clone(): ProxyEvent & this;
@@ -4226,6 +4216,7 @@ declare class UndoManager {
     rollbackFromSnapshot(id: string): void;
     _grabSnapshot(item: PreparedItem): Snapshot;
     _getFieldInstance(item: PreparedItem, id: string): Field | null;
+    _getCustomFieldInstance(item: PreparedItem, id: string): CustomField | null;
     _rollbackFromSnapshot(item: PreparedItem, snapshot: Snapshot): void;
     getEnabled(): boolean;
     setEnabled(value: boolean): void;
@@ -4286,12 +4277,16 @@ 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: any, script: any, item: any): any;
-    proxyScriptFieldsArray(fields: any, script: any, item: any): any[];
-    proxyScriptField(field: any, script: any, item: any): 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;
 }
 
 declare const _default: {
+    createItemOrBlockID: () => string;
+    createFieldID: () => string;
     createGUID: () => string;
     createGeneratedItemId: () => string;
     toUserFriendlyName: (variableName: string) => string;
@@ -4322,6 +4317,8 @@ declare class ProfilerEntry {
     parent?: ProfilerEntry;
     constructor(name: string, level: number, time: number, parent?: ProfilerEntry);
 }
+declare function profileBlock(key: string, func: Function): any;
+declare function profileAsyncBlock(key: string, func: Function): Promise<any>;
 declare class Profiler {
     startTime: number;
     endTime: number;
@@ -12164,5 +12161,52 @@ declare function getDatatypes(): ({
 declare function verifyAcl(userInfo: any, acls: any, action: string): true | undefined;
 declare function hasPermission(userInfo: any, perm: any, needsSuperadmin: boolean): boolean;
 
-export { AccessDeniedException, AggregatedItem, ApiClient, ApiGateway, Block, 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, ThumbCache, UndoManager, eventBus, getDatatypeByName, getDatatypes, hasPermission, _default as tools, verifyAcl };
-export type { Acl, Attachments, BaseBlogArticle, ConversationEntry, FolderListingOptions, FolderListingWithOptions, ItemOptions, ItemQueryOptions, ItemQueryWithOptions, ItemWithOptions, JobState, Me, ProgressCallback, UserInfo };
+declare class TemplateFactory {
+    private templates;
+    private static _instance;
+    static get instance(): TemplateFactory;
+    addTemplates(fieldName: string, templates: TemplateEntry$1[]): void;
+    getTemplate(fieldName: string, templateName: string): TemplateEntry$1 | undefined;
+}
+
+declare class LinkableItemsCache {
+    linkableItemsCache: Map<string, any[]>;
+    apiGateway: ApiGateway;
+    itemCache: ItemCache;
+    usePublicApi: boolean;
+    constructor(apiGateway: ApiGateway, itemCache: ItemCache, usePublicApi?: boolean);
+    clear(): void;
+    resolveItem(id: string, linkableItems: any[]): any;
+    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, UserInfo };