@luminocity/lemonate-gateway 8.0.6 → 8.1.0

package/dist/index.d.ts

@@ -2,9 +2,12 @@ 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';
 
 declare class Snapshot {
     id: string;
@@ -265,7 +268,6 @@ declare class AggregatedItem extends Item {
     }[];
     fields?: any[];
     userFields?: any[];
-    additionalUserAttributes?: Record<string, unknown>;
     readonly isAggregatedItem: boolean;
     constructor(data: any);
 }
@@ -969,7 +971,7 @@ declare class Field extends Snapshotable {
     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 +985,7 @@ declare class PreparedItem extends AggregatedItem {
     isDirty: boolean;
     fieldInstances: Field[];
     userFieldInstances: Field[];
+    customFieldInstances: CustomField$1[];
     packageContent?: PreparedItem;
     packageType?: string;
     public: boolean;
@@ -993,6 +996,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;
@@ -3920,7 +3925,7 @@ declare class ApiGateway {
 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 +3938,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;
@@ -4161,6 +4167,7 @@ declare class ItemRepo {
         id: any;
         newName: any;
     }): void;
+    isItemKnown(itemId: string): boolean;
     invalidateId(itemId: string): void;
 }
 
@@ -4180,7 +4187,7 @@ declare class ProxyEvent {
     length?: number;
     position?: number;
     elementsToDelete?: any[];
-    field?: Field;
+    field?: string;
     fieldId?: string;
     isLink?: boolean;
     bundleIndex: number;
@@ -4195,7 +4202,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 +4233,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 +4294,15 @@ 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;
     createGUID: () => string;
     createGeneratedItemId: () => string;
     toUserFriendlyName: (variableName: string) => string;
@@ -12164,5 +12175,33 @@ 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 };
+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, ThumbCache, UndoManager, eventBus, getDatatypeByName, getDatatypes, hasPermission, _default as tools, verifyAcl };
+export type { Acl, Attachments, BaseBlogArticle, ConversationEntry, CustomFieldDefinition, FolderListingOptions, FolderListingWithOptions, ItemOptions, ItemQueryOptions, ItemQueryWithOptions, ItemWithOptions, JobState, Me, ProgressCallback, UserInfo };