@node-elion/syncron/dist/types/types.d.ts

Provides a simple way to delivery models between sender and receiver

export type JSONLike = string | number | boolean | null | JSONLike[] | {
    [key: string]: JSONLike;
};
export declare enum ModelEventAction {
    UPDATE = "update",
    MANUAL_UPDATE = "manual-update",
    UPDATE_INDEX = "update-index",
    DELETE = "delete",
    META = "meta"
}
export declare enum ManualUpdateTypes {
    INIT = "init",
    REGENERATE_STATE = "regenerateState",
    REGENERATE_INDEXES = "regenerateIndexes",
    REGENERATE_METADATA = "regenerateMetadata"
}
export type UpdateStrategyType = UpdateStrategy;
export declare enum UpdateStrategy {
    REPLACE = "replace",
    MERGE = "merge"
}
export declare const generateTrackIdentifier: (modelName: string, action: string) => string;
export declare const getActionFromTrackIdentifier: (trackIdentifier: string) => string;
export declare const getModelNameFromTrackIdentifier: (trackIdentifier: string) => string;
export type ModelId = number | string;
export type ModelPrototype = {
    [key: string]: JSONLike;
};
export type ModelSubscribeEvent = {
    modelName: string;
    idParamName: string;
    action: ModelEventAction | string;
    data: {
        id: ModelId;
        data?: JSONLike;
        [key: string]: JSONLike;
    };
};
export type ModelSubscribeUpdateEvent = ModelSubscribeEvent & {
    action: ModelEventAction.UPDATE;
    data: {
        id: ModelId;
        data: JSONLike;
        updateStrategy: UpdateStrategyType;
        index: number;
    };
};
export type ModelSubscribeUpdateIndexEvent = ModelSubscribeEvent & {
    action: ModelEventAction.UPDATE_INDEX;
    data: {
        id: ModelId;
        index: number;
    };
};
export type ModelSubscribeManualUpdateEvent = ModelSubscribeEvent & {
    action: ModelEventAction.MANUAL_UPDATE;
    data: {
        id: ManualUpdateTypes;
    };
};
export type ModelSubscribeDeleteEvent = ModelSubscribeEvent & {
    action: ModelEventAction.DELETE;
    data: {
        id: ModelId;
    };
};
export type ModelSubscribeMetaEvent = ModelSubscribeEvent & {
    action: ModelEventAction.META;
    data: {
        id: string;
        data: JSONLike;
    };
};
export type ModelSubscribeEventLike = ModelSubscribeUpdateEvent | ModelSubscribeUpdateIndexEvent | ModelSubscribeDeleteEvent | ModelSubscribeMetaEvent | ModelSubscribeManualUpdateEvent;
export type ModelPublishEvent = {
    id: ModelId;
};
export type ModelPublishUpdateEvent = ModelPublishEvent & {
    data?: JSONLike;
    updateStrategy?: UpdateStrategyType;
};
export type ModelPublishDeleteEvent = ModelPublishEvent;
export type ModelPublishCustomEvent = ModelPublishEvent & {
    data?: JSONLike;
};
export type ModelPublishEventLike = ModelPublishUpdateEvent | ModelPublishDeleteEvent | ModelPublishCustomEvent;
export type ModelPublishEventLikeWithHeader = {
    header: string;
    body: ModelPublishEventLike;
};
export declare enum ModelSubscribeEventBatchSize {
    "default" = 1,
    "auto" = "auto"
}
export declare enum ModelSubscriberEventFirstContentSendSize {
    "default" = 1,
    "auto" = "auto"
}
export declare enum ModelSubscribeEventQueWaitTime {
    "default" = 100
}
export declare enum ModelSubscribeEventKeepAlivePeriod {
    "default" = 5000
}
export declare enum ModelSubscribeEventKeepAliveCheckPendingPeriod {
    "default" = 5000
}
export type ModelSubscribeEventMeta = {
    modelTriggers: (ModelEventAction | string)[];
    customTriggers?: string[];
    onModelChange: () => Promise<JSONLike>;
    onCustomTrigger?: (eventName: string, eventData: JSONLike) => Promise<JSONLike>;
};
export type ModelSubscribeEventMetaField = {
    [key: string]: ModelSubscribeEventMeta;
};
export type ModelEventMeta = {
    [key: string]: JSONLike;
};
export type IdList = ModelId[];