@sme.up/kokos-sdk-node 2.4.0 → 3.0.0-SNAPSHOT

package/lib/types/data-structures/smeupDataTable.d.ts

@@ -1,117 +0,0 @@
-import { SmeupDataStructure, SmeupDataStructureType, SmeupLayout } from "./smeupDataStructure.js";
-export interface SmeupDataTable extends SmeupDataStructure {
-    type: SmeupDataStructureType.SmeupDataTable;
-    columns: SmeupDataColumn[];
-    rows: SmeupDataRow[];
-    layout?: SmeupLayout;
-}
-export interface SmeupDataColumn {
-    name: string;
-    title?: string;
-    visible?: boolean;
-    isEditable?: boolean;
-    isKey?: boolean;
-    fill?: string;
-    obj?: {
-        t: string;
-        p: string;
-    };
-    maxLength?: number;
-    length?: number;
-    integers?: number;
-    decimals?: number;
-    tooltip?: boolean;
-    formula?: string;
-    shape?: SmeupDataCellShapes;
-    useAs?: string;
-    helper?: string;
-    hideValuesRepetitions?: boolean;
-}
-export interface SmeupDataRow {
-    cells?: {
-        [columnName: string]: SmeupDataCell;
-    };
-    layout?: SmeupLayout;
-    rowId?: string;
-    error?: boolean;
-}
-export interface SmeupDataCell {
-    value: string;
-    obj?: {
-        t: string;
-        p: string;
-        k: string;
-    };
-    options?: SmeupDataCellOption[];
-    icon?: string;
-    isEditable?: boolean;
-    hasMCell?: boolean;
-    mandatory?: boolean;
-    shape?: SmeupDataCellShapes;
-    fun?: string;
-    tooltip?: boolean;
-    data?: {
-        [key: string]: Object;
-    };
-    disabled?: boolean;
-    styleName?: string;
-    styleAttributes?: {
-        [attributeKey: string]: string;
-    };
-    inputSettings?: {
-        [key: string]: Object;
-    };
-}
-/**
- * Represents the single option of the cell
- */
-export interface SmeupDataCellOption {
-    id: string;
-    label: string;
-}
-/**
- * Represent the possible shapes of a field
- */
-export declare const SmeupDataCellShapes: {
-    readonly AUTOCOMPLETE: "ACP";
-    readonly BUTTON_LIST: "BTN";
-    readonly CHART: "GRA";
-    readonly CHECKBOX: "CHK";
-    readonly CHIP: "CHI";
-    readonly COLOR_PICKER: "CLP";
-    readonly COMBOBOX: "CMB";
-    readonly DATE: "CAL";
-    readonly EDITOR: "EDT";
-    readonly GAUGE: "GAU";
-    readonly ICON: "ICO";
-    readonly IMAGE: "IMG";
-    readonly INPUT_CHECKBOX: "INC";
-    readonly INPUT_FIELD: "INF";
-    readonly KNOB: "KNB";
-    readonly LABEL: "LBL";
-    readonly MEMO: "MEM";
-    readonly MULTI_AUTOCOMPLETE: "AML";
-    readonly MULTI_COMBOBOX: "CML";
-    readonly OBJECT: "OBJ";
-    readonly PROGRESS_BAR: "PGB";
-    readonly RADIO: "RAD";
-    readonly RATING: "RTG";
-    readonly SWITCH: "SWT";
-    readonly TABLE: "TBL";
-    readonly TEXT_FIELD: "ITX";
-    readonly TIME: "TIM";
-    readonly INPUT_NUMBER: "INR";
-    readonly BOOLEAN_BUTTON: "BNB";
-    readonly RANGE: "RNG";
-    readonly FILE_UPLOAD: "FUP";
-    readonly FILE_READER: "FRE";
-    readonly COMMAND_EXECUTE: "RUN";
-    readonly ONE_BUTTON: "BTO";
-    readonly PASSWORD: "PWD";
-    readonly SPINNER: "SPN";
-    readonly DECODE: "DEC";
-};
-/**
- * Represent the type of the shape (like enum)
- */
-export type SmeupDataCellShapes = (typeof SmeupDataCellShapes)[keyof typeof SmeupDataCellShapes] | string;

package/lib/types/data-structures/smeupDataTree.d.ts

@@ -1,13 +0,0 @@
-import { SmeupDataStructure, SmeupDataStructureType } from "./smeupDataStructure.js";
-import { SmeupDataCell, SmeupDataColumn } from "./smeupDataTable.js";
-export interface SmeupDataTree extends SmeupDataStructure {
-    type: SmeupDataStructureType.SmeupDataTree;
-    children: SmeupDataNode[];
-    columns?: SmeupDataColumn[];
-}
-export interface SmeupDataNode extends SmeupDataCell {
-    children?: SmeupDataNode[];
-    cells?: {
-        [columnName: string]: SmeupDataCell;
-    };
-}

package/lib/types/data-structures/smeupSch.d.ts

@@ -1,72 +0,0 @@
-import { YesNo } from "../helpers.js";
-import { SmeupDataStructure, SmeupDataStructureType, SmeupSetupBase, SmeupVariable } from "./smeupDataStructure.js";
-import { RawDynamism } from "../dynamism.js";
-import { SmeupDataTable } from "./smeupDataTable.js";
-import { SmeupDataTree, SmeupDataNode } from "./smeupDataTree.js";
-import { Shapes, ToolbarState } from "../component.js";
-export interface SmeupSch extends SmeupDataStructure {
-    type: SmeupDataStructureType.SmeupScheda;
-    title: string;
-    sections: SmeupSchSection[];
-    info?: string;
-    id?: string;
-    styles?: SmeupStyle[];
-    layout?: string;
-    /** other setup: for example "Menu", left menù */
-    laySetup?: any;
-    dynamisms?: RawDynamism[];
-}
-export interface SmeupSchSection {
-    id: string;
-    layout: string;
-    dim?: string;
-    variables?: SmeupVariable[];
-    sections?: SmeupSchSection[];
-    components?: SmeupSchComponent[];
-    type?: SectionTypes;
-}
-export interface SmeupSchComponent {
-    type: Shapes;
-    title: string;
-    load?: boolean;
-    subNote?: string;
-    id?: string;
-    fun?: string;
-    data?: SmeupDataTree | SmeupDataTable;
-    dynamisms?: RawDynamism[];
-    variables?: {
-        [key: string]: SmeupVariable;
-    };
-    options?: SmeupSetupBase;
-    icon?: string;
-    buttons?: SmeupDataNode[];
-    toolbarState?: ToolbarState;
-    context?: string;
-}
-export interface SmeupStyle {
-    name: string;
-    value: SmeupStyleOptions;
-}
-export interface SmeupStyleOptions {
-    Align?: string;
-    FontBold?: YesNo;
-    FontItalic?: YesNo;
-    FontName?: string;
-    FontSize?: string;
-    FontULine?: YesNo;
-    FontUnder?: YesNo;
-    FontColor?: string;
-    BackColor?: string;
-    Padding?: string;
-    Border?: string;
-    TxtOri?: string;
-}
-export declare enum SectionTypes {
-    Acc = "Acc",
-    Tab = "Tab",
-    TabVer = "TabVer",
-    Radio = "Radio",
-    Combo = "Combo",
-    OneBut = "OneBut",
-    Menu = "Menu"
-}

package/lib/types/dynamism.d.ts

@@ -1,45 +0,0 @@
-import { SmeupVariable } from "./data-structures/smeupDataStructure.js";
-/**
- * Raw Dynamism
- */
-export interface RawDynamism {
-    /** Event type */
-    event: string;
-    /** Fun or Action */
-    exec?: string;
-    /** Component ids */
-    targets?: string[];
-    /** Declared variables */
-    variables?: SmeupVariable[];
-    /** Enable conditions */
-    enabled?: string;
-    /** Load method  */
-    Load?: LoadType;
-}
-/**
- * Dynamism Event
- */
-export declare enum DynamismEvents {
-    ALL = "*all",
-    BTN_CLICK = "btnclick",
-    CHANGE = "change",
-    CHANGE_MONTH = "changemonth",
-    CHANGE_ROW = "changerow",
-    CHANGE_VAL = "changeval",
-    CLICK = "click",
-    DBLCLICK = "dblclick",
-    DETAIL_CLICK = "detailclick",
-    EXPAND = "expand",
-    RESIZE = "resize",
-    DATESELECT = "dateselect",
-    DROP = "drop",
-    SELECT = "select",
-    UPDATE = "update",
-    CHECK = "check",
-    INIT = "init",
-    CLOSE = "close",
-    UNMOUNT = "unmount"
-}
-export declare enum LoadType {
-    D = "D"
-}

package/lib/types/exceptions/application.d.ts

@@ -1,8 +0,0 @@
-/**
- * Generic application exception
- */
-export declare class ApplicationException extends Error {
-    status: number;
-    message: string;
-    constructor(status: number, message: string);
-}

package/lib/types/exceptions/validation.d.ts

@@ -1,7 +0,0 @@
-import { ApplicationException } from "./application.js";
-/**
- * Validation Exception
- */
-export declare class ValidationException extends ApplicationException {
-    constructor(message: string);
-}

package/lib/types/general.d.ts

@@ -1,221 +0,0 @@
-import { SmeupDataStructureWriter } from "../utils/smeupDataStructureWriter.js";
-import { Format, Level } from "../logger/logger.js";
-export declare class ErrorWithStatus extends Error {
-    status: number;
-    constructor(message: string, status: number);
-}
-/**
- * Micro Executor base config. To personalize the configuration you can extend this interface
- */
-export interface MicroExecutorConfiguration {
-    server: {
-        port: 8011 | number;
-    };
-    logger: {
-        format: Format;
-        level: Level;
-    };
-}
-/**
- * Fun Object
- */
-export declare class FunObject {
-    t: string;
-    p: string;
-    k: string;
-}
-/**
- * Fun
- */
-export declare class Fun {
-    component: string;
-    service: string;
-    function: string;
-    obj1?: FunObject;
-    obj2?: FunObject;
-    obj3?: FunObject;
-    obj4?: FunObject;
-    obj5?: FunObject;
-    obj6?: FunObject;
-    P?: string;
-    INPUT?: string;
-    SS?: string;
-}
-/**
- * User Type
- */
-export declare class User {
-    sessionId: string;
-    username: string;
-    app: string;
-    device: string;
-    expiresAt: number;
-    properties?: {
-        [key: string]: string;
-    };
-}
-export declare class SourceLibrary {
-    path: string;
-}
-export interface DocumentDatabaseDataSource {
-    id: string;
-    description: string;
-    uri: string;
-    database: string;
-}
-/**
- * Registry
- */
-export declare class Registry {
-    handlers?: {
-        [id: string]: string;
-    };
-    services?: {
-        [key: string]: string;
-    };
-    aliases?: {
-        [key: string]: string;
-    };
-    defaultHandler?: string;
-}
-/**
- * App
- */
-export declare class App {
-    registry?: Registry;
-    libraries?: {
-        [key: string]: SourceLibrary;
-    };
-    otherConfigs?: Map<string, string>;
-}
-/**
- * Execution Context
- */
-export declare class ExecutionContext {
-    user?: User;
-    app?: App;
-    batchContext?: BatchContext;
-}
-/**
- * Batch Context
- */
-export declare class BatchContext {
-    batchJobId?: string;
-    scheduledJobId?: string;
-    progress?: number;
-}
-/**
- * Execute Fun payload DTO
- */
-export declare class ExecuteFunPayload {
-    fun: Fun;
-    context: ExecutionContext;
-}
-/**
- * Type of Kokos Service ES Module
- */
-export interface KokosServiceModule {
-    default: KokosService;
-}
-/**
- * Kokos Service Interface
- */
-export interface KokosService {
-    methods: KokosServiceMethods;
-}
-/**
- * Kokos Service Method
- */
-export interface KokosServiceMethods {
-    [key: string]: (fun: Fun, context: ExecutionContext, printer: SmeupDataStructureWriter) => Promise<void>;
-}
-/**
- * KokosEntityDAOService is a specific KokosService used to funize a DAO
- */
-export interface IKokosEntityDAOService {
-    methods: KokosEntityDAOServiceMethods;
-}
-export interface KokosEntityDAOServiceMethods {
-    /** F(EXB;XXX;FND.BID) 1([T];[P];[K]). K is Id. */
-    "FND.BID": (fun: Fun, context: ExecutionContext, printer: SmeupDataStructureWriter) => Promise<void>;
-    /** F(EXB;XXX;FND.ALL) 1(OG;;[T][P]). */
-    "FND.ALL": (fun: Fun, context: ExecutionContext, printer: SmeupDataStructureWriter) => Promise<void>;
-    /** F(EXB;XXX;FND.MNY) 1(OG;;[T][P]) INPUT(IDS(xxx;yyy;zzz)) */
-    "FND.MNY": (fun: Fun, context: ExecutionContext, printer: SmeupDataStructureWriter) => Promise<void>;
-    /** F(FBK;XXX;DEL.BID) 1([T];[P];[K]) */
-    "DEL.BID": (fun: Fun, context: ExecutionContext, printer: SmeupDataStructureWriter) => Promise<void>;
-    /** F(EXB;XXX;INS.NEW) 1([T];[P];[K]) INPUT(OAVS(oav_key(oav_value) oav_key(oav_value)...)) */
-    "INS.NEW": (fun: Fun, context: ExecutionContext, printer: SmeupDataStructureWriter) => Promise<void>;
-    /** F(EXB;XXX;UPD.BID) 1([T];[P];[K]) INPUT(OAVS(oav_key(oav_value) oav_key(oav_value)...)) */
-    "UPD.BID": (fun: Fun, context: ExecutionContext, printer: SmeupDataStructureWriter) => Promise<void>;
-}
-export declare class EntitySlice {
-    code: string;
-    oavs: Map<string, EntityOav>;
-    constructor(code?: string, oavs?: Map<string, EntityOav>);
-}
-export declare class EntityOav {
-    type: string;
-    parameter: string;
-    value: any;
-    readOnly: boolean;
-    constructor(type?: string, parameter?: string, value?: any, readOnly?: boolean);
-}
-export declare abstract class KokosEntityDAOService implements KokosEntityDAOServiceMethods, IKokosEntityDAOService {
-    static readonly ID_COLUMN_CODE: string;
-    get methods(): KokosEntityDAOServiceMethods;
-    protected abstract findById(context: ExecutionContext, id: string): Promise<EntitySlice>;
-    protected abstract findMany(context: ExecutionContext, ids: string[]): Promise<EntitySlice[]>;
-    protected abstract findAll(context: ExecutionContext): Promise<EntitySlice[]>;
-    protected abstract create(context: ExecutionContext, slice: EntitySlice): Promise<EntitySlice>;
-    protected abstract update(context: ExecutionContext, slice: EntitySlice): Promise<void>;
-    protected abstract delete(context: ExecutionContext, id: string): Promise<void>;
-    /**
-     * FND.BID: Finds an entity by its Id.
-     * Signature: F(EXB;XXX;FND.BID) 1([T];[P];[K])
-     */
-    "FND.BID"(fun: Fun, context: ExecutionContext, printer: SmeupDataStructureWriter): Promise<void>;
-    /**
-     * FND.ALL: Finds all entities.
-     * Signature: F(EXB;XXX;FND.ALL) 1(OG;;[T][P])
-     */
-    "FND.ALL"(fun: Fun, context: ExecutionContext, printer: SmeupDataStructureWriter): Promise<void>;
-    /**
-     * FND.MNY: Finds a set of entities based on provided Ids.
-     * Signature: F(EXB;XXX;FND.MNY) 1(OG;;[T][P]) INPUT(IDS(xxx;yyy;zzz))
-     */
-    "FND.MNY"(fun: Fun, context: ExecutionContext, printer: SmeupDataStructureWriter): Promise<void>;
-    /**
-     * DEL.BID: Deletes an entity and sends a feedback message.
-     * Signature: F(FBK;XXX;DEL.BID) 1([T];[P];[K])
-     */
-    "DEL.BID"(fun: Fun, context: ExecutionContext, printer: SmeupDataStructureWriter): Promise<void>;
-    /**
-     * INS.NEW: Adds a new entity with provided oavs and returns a feedback.
-     * Signature: F(EXB;XXX;INS.NEW) 1([T];[P];[K]) INPUT(OAVS(oav_key(oav_value) ...))
-     */
-    "INS.NEW"(fun: Fun, context: ExecutionContext, printer: SmeupDataStructureWriter): Promise<void>;
-    /**
-     * UPD.BID: Updates a new entity with provided oavs and returns a feedback.
-     * Signature: F(EXB;XXX;UPD.BID) 1([T];[P];[K]) INPUT(OAVS(oav_key(oav_value) ...))
-     */
-    "UPD.BID"(fun: Fun, context: ExecutionContext, printer: SmeupDataStructureWriter): Promise<void>;
-}
-/**
- * KokosInputPanelService is a specific KokosService used to handle input panels.
- */
-export interface IKokosInputPanelService {
-    methods: KokosInputPanelServiceMethods;
-}
-export interface KokosInputPanelServiceMethods {
-    /** F(EXB;XXX;*INIT) */
-    "*INIT": (fun: Fun, context: ExecutionContext, printer: SmeupDataStructureWriter) => Promise<void>;
-    /** F(EXB;XXX;*UPDATE) INPUT(BEFORE() AFTER()) */
-    "*UPDATE": (fun: Fun, context: ExecutionContext, printer: SmeupDataStructureWriter) => Promise<void>;
-    /** F(EXB;XXX;*SETUP) */
-    "*SETUP": (fun: Fun, context: ExecutionContext, printer: SmeupDataStructureWriter) => Promise<void>;
-    /** F(FBK;XXX;*EXIT) */
-    "*EXIT": (fun: Fun, context: ExecutionContext, printer: SmeupDataStructureWriter) => Promise<void>;
-    /** F(FBK;XXX;*CHECK) */
-    "*CHECK": (fun: Fun, context: ExecutionContext, printer: SmeupDataStructureWriter) => Promise<void>;
-}

package/lib/types/helpers.d.ts

@@ -1,9 +0,0 @@
-export declare enum YesNo {
-    Yes = "Yes",
-    No = "No"
-}
-export declare enum FunStatus {
-    RUNNING = "RUNNING",
-    COMPLETED = "COMPLETED",
-    FAILED = "FAILED"
-}

package/lib/utils/batchUtils.d.ts

@@ -1,6 +0,0 @@
-import { ExecutionContext, Fun } from "../types/general.js";
-import { FunStatus } from "../types/helpers.js";
-export declare function isBatch(context: ExecutionContext): boolean;
-export declare function trackFun(meId: string, context: ExecutionContext, fun: Fun, status: FunStatus, exception?: Error): Promise<void>;
-export declare function trackProgress(context: ExecutionContext, progress: number): Promise<void>;
-export declare function probe(context: ExecutionContext): Promise<boolean>;

package/lib/utils/cells.d.ts

@@ -1,8 +0,0 @@
-import { SmeupDataCell } from "../types/data-structures/smeupDataTable.js";
-export declare function toTextButtonCell(value: string): SmeupDataCell;
-export declare function toIconButtonCell(k: string, icon: string, value: string): SmeupDataCell;
-export declare function toSingleChipCell(value: string): SmeupDataCell;
-export declare function toDateCell(value: string | Date): SmeupDataCell;
-export declare function toTimeCell(value: string | Date): SmeupDataCell;
-export declare function toStringCell(value?: string): SmeupDataCell;
-export declare function toNumberCell(value: string): SmeupDataCell;

package/lib/utils/dataStructureStream.d.ts

@@ -1,8 +0,0 @@
-import { Writable } from "stream";
-import { SmeupDataStructure } from "../../src/types/data-structures/smeupDataStructure.js";
-export declare class DataStructureStream<T extends SmeupDataStructure> extends Writable {
-    private chunks;
-    constructor();
-    _write(chunk: Buffer, encoding: BufferEncoding, callback: (error?: Error | null) => void): void;
-    getDataStructure(): T;
-}

package/lib/utils/fun.d.ts

@@ -1,4 +0,0 @@
-import { Fun, FunObject } from "../types/general.js";
-export declare function funToString(fun: Fun): string;
-export declare function funObjectToString(obj: FunObject): string;
-export declare function stringToFun(funString: string): Fun;

package/lib/utils/path.d.ts

@@ -1,5 +0,0 @@
-/**
- * Get the project root
- * @returns
- */
-export declare function getProjectRoot(): string;

package/lib/utils/regex.d.ts

@@ -1,48 +0,0 @@
-/**
- * Parse key(value) expression NB. Nested brackets must be even
- *
- * @param expression
- * @return
- */
-export declare function parseKeyValueBetweenBrackets(expression: string): {
-    [key: string]: string;
-};
-/**
- * Parses a flat string with nested objects into a structured array of objects
- * @param input A string in the format "key1(value1) key2(key21(value21) key22(value22))[separator]key1(value1)"
- * @param separator The char that will be used to split the input string. Defaults to ';'
- * @returns An array of structured objects
- */
-export declare function parseArrayString(input: string, separator?: string): any[];
-export interface UpdateResult {
-    rowNumber: number;
-    operation: string;
-    values: {
-        [key: string]: string;
-    };
-}
-/**
- * Parse ROW () OP() VALUES(BEFORE() AFTER()) payload from *UPDATE service
- *
- * @param fun input string in the format "INPUT(ROW(rowNumber) OP(operation) VALUES(BEFORE(key1(value1) key2(value2)) AFTER(key3(value3) key4(value4));)"
- * @return An array with an object for each row, with keys and values, where values are the latest ones from AFTER or BEFORE
- */
-export declare function parseUpdatePayloadMultipleRows(input: string): UpdateResult[];
-/**
- * Parse BEFORE() AFTER() payload from *UPDATE service
- *
- * @param fun input string in the format "INPUT(BEFORE(key1(value1) key2(value2)) AFTER(key3(value3) key4(value4)))"
- * @return An object with keys and values, where values are the latest ones from AFTER or BEFORE
- */
-export declare function parseUpdatePayload(input: string): {
-    [key: string]: string;
-};
-/**
- * Parse key(value) pairs from a string in the format "INPUT(BEFORE(key1(;;value1) key2(;;value2)) AFTER(key3(;;value3) key4(;;value4)))"
- *
- * @param raw Input string containing key(value) pairs
- * @return An object where keys are the field names and values are the corresponding values (ignoring the ";;" prefix)
- */
-export declare function parseFieldValues(raw: string): {
-    [key: string]: string;
-};

package/lib/utils/smeupDataStructureWriter.d.ts

@@ -1,51 +0,0 @@
-import stream from "stream";
-import { ApiVersion, SmeupAction, SmeupMessage, SmeupSetup, SmeupVariable } from "../types/data-structures/smeupDataStructure.js";
-import { Fun } from "../types/general.js";
-import { SmeupDataNode } from "../types/data-structures/smeupDataTree.js";
-import { SmeupDataColumn, SmeupDataRow } from "../types/data-structures/smeupDataTable.js";
-import { SmeupSch } from "../types/data-structures/smeupSch.js";
-export declare class SmeupDataStructureWriter {
-    #private;
-    private out;
-    private version;
-    private initalTimestamp;
-    private messages;
-    private dataColumns;
-    private variables;
-    private actions;
-    private setup;
-    private buttons;
-    private firstElement;
-    private lastElementWritten;
-    private isInitializationWritten;
-    private isFinalizationWritten;
-    private isColumnWritten;
-    private isRowWritten;
-    private isNodeWritten;
-    constructor(out: stream.Writable, version?: ApiVersion);
-    writeDataStructureInitialization(fun: Fun): void;
-    writeDataStructureFinalization(fun: Fun): void;
-    /**
-     * Write a SmeupDataNode instance to stream
-     * @param node
-     */
-    writeDataNode(node: SmeupDataNode): void;
-    /**
-     * Write SmeupDataColumns
-     * @param columns
-     */
-    writeDataColumns(columns: SmeupDataColumn[]): void;
-    /**
-     * Write a SmeupDataColumn
-     * @param col
-     */
-    writeDataColumn(col: SmeupDataColumn): void;
-    writeDataRow(row: SmeupDataRow): void;
-    writeSmeupSch(scheda: SmeupSch): void;
-    writeMessage(message: SmeupMessage): void;
-    writeVariable(variable: SmeupVariable): void;
-    writeRawData(rawData: string): void;
-    writeAction(action: SmeupAction): void;
-    writeSetup(setup: SmeupSetup): void;
-    writeButton(button: SmeupDataNode): void;
-}