@dcupl/common 1.7.2 → 1.8.0

package/dist/lib-cjs/types/rest-api/rest-api.types.d.ts

@@ -1,118 +0,0 @@
-import { AppLoaderConfiguration } from '../app-loader.types';
-export declare namespace RestApi {
-    type Template = {
-        key: string;
-        dcuplConfig: DcuplConfig;
-        vGuardEnabled: boolean;
-        auth?: InstanceAuth[];
-        name?: string;
-        description?: string;
-        version?: string;
-    };
-    type Instance = {
-        uid: string;
-        key: string;
-        template: Template;
-        runnerUid: string;
-        projectId: string;
-        v: string;
-        createdAt: string;
-        changedAt: string;
-        runtime?: InstanceRuntime;
-    };
-    type DcuplConfig = {
-        projectId: string;
-        apiKey: string;
-        processOptions: AppLoaderConfiguration.ProcessOptions;
-        loaderFetchOptions?: AppLoaderConfiguration.FetchOptions;
-    };
-    type InstanceAuth = {
-        type: 'api-key';
-        value: string;
-    };
-    type InstanceRuntime = {
-        max_heap_size: number;
-    };
-    /**
-     * Api Types
-     */
-    type InstanceStatus = 'waiting' | 'processing' | 'ready' | 'updating' | 'error' | 'stopped';
-    type StatusResponse = {
-        key: string;
-        uid: string;
-        status: InstanceStatus;
-        createdAt: string;
-        changedAt: string;
-        templateVersion?: string;
-        v: string;
-    };
-    type InstanceEvent = {
-        type: 'create' | 'start' | 'initialized' | 'update' | 'stop' | 'error';
-        createdAt: string;
-        data?: any;
-    };
-    type ApiInstanceRuntimeResponse = {
-        used_heap_size: number;
-        max_heap_size: number;
-    };
-    type DetailsResponse = {
-        key: string;
-        uid: string;
-        runtime: ApiInstanceRuntimeResponse;
-        invocations: Invocation[];
-    };
-    /**
-     * Invocations
-     */
-    type InvocationStatus = 'completed' | 'failed';
-    type InvocationType = 'project' | 'instance' | 'instance-action' | 'total';
-    type Invocation = {
-        key: string;
-        type: InvocationType;
-        action: string;
-        completed: number;
-        failed: number;
-        instanceKey?: string;
-        projectId?: string;
-    };
-    /**
-     * Manager Types
-     */
-    type ManagerStatus = 'idle' | 'processing';
-    type ManagerStatusRuntime = {
-        used_heap_size: number;
-        total_used_heap_size: number;
-        workers: number;
-    };
-    type ManagerStatusResponse = {
-        status: ManagerStatus;
-        meta: ManagerMeta;
-        runtime: ManagerStatusRuntime;
-        instances: StatusResponse[];
-        events: ManagerEvent[];
-    };
-    type ManagerEvent = {
-        type: 'fetch_config' | 'init' | 'initialized' | 'start' | 'stop';
-        createdAt: string;
-        data?: any;
-    };
-    type ManagerMeta = {
-        total: number;
-        waiting: number;
-        processing: number;
-        ready: number;
-        error: number;
-        stopped: number;
-        updating: number;
-    };
-    /**
-     * DTO's
-     */
-    type DeployDto = {
-        runnerUid: string;
-        template: Template;
-    };
-    type UndeployDto = {
-        uid: string;
-    };
-}

package/dist/lib-cjs/types/rest-api/rest-api.types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=rest-api.types.js.map

package/dist/lib-cjs/types/rest-api/rest-api.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"rest-api.types.js","sourceRoot":"","sources":["../../../../src/types/rest-api/rest-api.types.ts"],"names":[],"mappings":""}

package/dist/lib-cjs/types/runner/runner.types.d.ts

@@ -1,22 +0,0 @@
-import { RestApi } from '../rest-api/rest-api.types';
-import { Workflow } from '../workflow/workflow.types';
-export declare namespace Runner {
-    type Setup = {
-        uid: string;
-        url: string;
-        type: 'app-runner' | 'workflow-runner';
-        runnerApiKey: string;
-        runnerKey: string;
-    };
-    type WorkflowRunnerConfig = {
-        workflows: Workflow.Workflow[];
-        v: string;
-    };
-    type RestApiRunnerConfig = {
-        instances: RestApi.Instance[];
-        processMode: 'parallel' | 'sequential' | 'batch';
-        timeoutBetweenInstances?: number;
-        batchSize?: number;
-        v: string;
-    };
-}

package/dist/lib-cjs/types/runner/runner.types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=runner.types.js.map

package/dist/lib-cjs/types/runner/runner.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"runner.types.js","sourceRoot":"","sources":["../../../../src/types/runner/runner.types.ts"],"names":[],"mappings":""}

package/dist/lib-cjs/types/section.types.d.ts

@@ -1,16 +0,0 @@
-import { ListItem } from './data.types';
-import { Aggregation } from './aggregation.types';
-export type GroupByResponse = {
-    _meta: {
-        currentSize: number;
-        initialSize: number;
-    };
-    items: SectionItem[];
-};
-export type SectionItem = ListItem & {
-    _meta: {
-        size: number;
-    };
-    _aggregates: Aggregation[];
-    _items: ListItem[];
-};

package/dist/lib-cjs/types/section.types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=section.types.js.map

package/dist/lib-cjs/types/section.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"section.types.js","sourceRoot":"","sources":["../../../src/types/section.types.ts"],"names":[],"mappings":""}

package/dist/lib-cjs/types/suggestion.types.d.ts

@@ -1,28 +0,0 @@
-import { DcuplQuery, DcuplQueryGroup, DcuplQueryTransformOptions } from './query.types';
-type SuggestionOptionsBase = {
-    attribute: string;
-    value: any;
-    max?: number;
-    calculateResultKeys?: boolean;
-    excludeUndefineds?: boolean;
-    excludeNulls?: boolean;
-    transform?: DcuplQueryTransformOptions[];
-};
-type SuggestionOptionsFiltered = SuggestionOptionsBase & {
-    relevantData?: 'filtered';
-    excludeQuery?: never;
-};
-type SuggestionOptionsAll = SuggestionOptionsBase & {
-    relevantData?: 'all';
-    excludeQuery?: never;
-};
-type SuggestionOptionsExcludequery = SuggestionOptionsBase & {
-    relevantData: 'excludeQuery';
-    excludeQuery: Partial<DcuplQuery | DcuplQueryGroup>;
-};
-export type SuggestionOptions = SuggestionOptionsFiltered | SuggestionOptionsAll | SuggestionOptionsExcludequery;
-export type Suggestion = {
-    value: string;
-    keys: string[];
-};
-export {};

package/dist/lib-cjs/types/suggestion.types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=suggestion.types.js.map

package/dist/lib-cjs/types/suggestion.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"suggestion.types.js","sourceRoot":"","sources":["../../../src/types/suggestion.types.ts"],"names":[],"mappings":""}

package/dist/lib-cjs/types/testing.types.d.ts

@@ -1,68 +0,0 @@
-export type DcuplTestTriggerOptions = {
-    type: 'manual' | 'chron';
-    cron?: string;
-};
-export type DcuplTestScenario = {
-    key: string;
-    name: string;
-    processOptions: any;
-    testConfigKey: string;
-    trigger: DcuplTestTriggerOptions;
-};
-export type DcuplTestScenarioConfig = DcuplTestScenario[];
-export type TestRunnerOptions = {
-    projectId: string;
-    apiKey: string;
-    baseUrl: string;
-    loaderFileName: string;
-    processOptions: any;
-    testConfigKey: string;
-    include?: string[];
-    exclude?: string[];
-};
-export type DcuplApplicationTestingConfig = {
-    key: string;
-    startupDuration?: number;
-    processDuration?: number;
-    downloadDuration?: number;
-    maxPercentageOfUnusedData?: number;
-    maxAmountOfUnusedAttributes?: number;
-    errorTracking?: DcuplErrorTrackingTestingConfig;
-    models?: DcuplModelTestingConfig[];
-};
-export type DcuplErrorTrackingTestingConfig = {
-    allowModelDefinitionErrors?: boolean;
-    allowMissingReferences?: boolean;
-    allowMissingData?: boolean;
-};
-export type DcuplModelTestingConfig = {
-    key: string;
-    modelKey: string;
-    minSize?: number;
-    maxSize?: number;
-    requiredAttributes?: string[];
-};
-export type Stats = {
-    suites: number;
-    tests: number;
-    passes: number;
-    pending: number;
-    failures: number;
-    start: string;
-    end: string;
-    duration: number;
-};
-export type Test = {
-    title: string;
-    fullTitle: string;
-    file: string;
-    duration: number;
-    state: string;
-    ctx: any;
-    parent: string;
-};
-export type TestRunnerResult = {
-    stats: Stats;
-    tests: Test[];
-    config: DcuplApplicationTestingConfig;
-};

package/dist/lib-cjs/types/testing.types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=testing.types.js.map

package/dist/lib-cjs/types/testing.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"testing.types.js","sourceRoot":"","sources":["../../../src/types/testing.types.ts"],"names":[],"mappings":""}

package/dist/lib-cjs/types/workflow/workflow.types.d.ts

@@ -1,341 +0,0 @@
-import { DataContainer } from '../data.types';
-import { ModelDefinition } from '../model.types';
-import { AppLoaderConfiguration } from '../app-loader.types';
-import { ListItem } from '../data.types';
-export declare namespace Workflow {
-    type Template = {
-        key: string;
-        config: WorkflowConfig;
-        auth?: WorkflowAuth[];
-        name?: string;
-        description?: string;
-        version?: string;
-        variables?: Record<string, string>;
-    };
-    type WorkflowAuth = {
-        type: 'api-key';
-        value: string;
-    };
-    /**
-     *
-     * Response
-     *
-     */
-    type WorkflowResponseType = 'script' | 'status' | 'debug';
-    type WorkflowResponseConfigBase = {
-        type: WorkflowResponseType;
-        headers?: Record<string, string>;
-    };
-    type WorkflowResponseScript = WorkflowResponseConfigBase & {
-        type: 'script';
-        script: string;
-    };
-    type WorkflowResponseStatus = WorkflowResponseConfigBase & {
-        type: 'status';
-    };
-    type WorkflowResponseDebug = WorkflowResponseConfigBase & {
-        type: 'debug';
-    };
-    type WorkflowResponseConfig = WorkflowResponseScript | WorkflowResponseStatus | WorkflowResponseDebug;
-    type WorkflowConfig = {
-        trigger: Trigger[];
-        steps: WorkflowStep[];
-        catch?: WorkflowStep;
-        response: WorkflowResponseConfig;
-    };
-    /**
-     *
-     * Trigger
-     *
-     */
-    type TriggerType = 'request' | 'manual' | 'cron';
-    type TriggerBase = {
-        key: string;
-        type: TriggerType;
-    };
-    type TriggerRequestMethod = 'GET' | 'POST';
-    type TriggerRequest = TriggerBase & {
-        type: 'request';
-        path: string;
-        methods: TriggerRequestMethod[];
-        scripts?: {
-            success?: string;
-        };
-    };
-    type TriggerManual = TriggerBase & {
-        type: 'manual';
-    };
-    type TriggerCron = TriggerBase & {
-        type: 'cron';
-        /**
-         * Cron expression
-         * second         0-59
-         * minute         0-59
-         * hour           0-23
-         * day of month   1-31
-         * month          1-12 (or names, see below)
-         * day of week    0-7 (0 or 7 is Sunday, or use names)
-         *
-         * @example '0 0 1 * *' // every day at 1am
-         * @example \*\/5 * * * * *' -> star slash 5 means every 5 seconds
-         */
-        cronTime: string;
-        timezone?: string;
-    };
-    type Trigger = TriggerRequest | TriggerManual | TriggerCron;
-    /**
-     *
-     * Step
-     *
-     */
-    type WorflowStepType = 'request' | 'script' | 'git-push' | 'git-pull' | 'files-read' | 'files-write' | 'dcupl-instance';
-    type WorkflowStepBase = {
-        key: string;
-        type: WorflowStepType;
-        name?: string;
-        description?: string;
-        skip?: boolean;
-    };
-    /**
-     * Request
-     */
-    type WorkflowRequestMethod = 'GET' | 'POST' | 'PUT' | 'DELETE';
-    type WorkflowStepRequestOptions = {
-        url: string;
-        method: WorkflowRequestMethod;
-        body?: any;
-        headers?: Record<string, string>;
-    };
-    type WorkflowStepRequest = WorkflowStepBase & {
-        type: 'request';
-        options: WorkflowStepRequestOptions;
-        scripts?: {
-            error?: string;
-            success?: string;
-        };
-    };
-    /**
-     * Script
-     */
-    type WorkflowStepScript = WorkflowStepBase & {
-        type: 'script';
-        script: string;
-    };
-    /**
-     * Dcupl Instance
-     */
-    type WorkflowStepDcuplInstanceDataContainer = Omit<DataContainer, 'data'> & {
-        data: string | ListItem[];
-    };
-    type WorkflowStepDcuplInstance = WorkflowStepBase & {
-        type: 'dcupl-instance';
-        apiKey: string;
-        processOptions: AppLoaderConfiguration.ProcessOptions;
-        fetchOptions?: AppLoaderConfiguration.FetchOptions;
-        dataContainers?: WorkflowStepDcuplInstanceDataContainer[];
-        models?: ModelDefinition[];
-        loaderConfig?: AppLoaderConfiguration.ProjectConfiguration;
-        scriptName?: string;
-        script?: string;
-    };
-    /**
-     * Git Push
-     */
-    type WorkflowGitPushStepFile = {
-        path: string;
-        content: string;
-        message?: string;
-    };
-    type WorkflowGitPushStepOptions = {
-        auth: {
-            user: string;
-            token: string;
-        };
-        repository: {
-            user: string;
-            repo: string;
-            /**
-             * default: main
-             */
-            branch?: string;
-        };
-        files: WorkflowGitPushStepFile[];
-    };
-    type WorkflowStepGitPush = WorkflowStepBase & {
-        type: 'git-push';
-        options: WorkflowGitPushStepOptions;
-    };
-    /**
-     * Git Pull
-     */
-    type WorkflowGitPullStepFile = {
-        key: string;
-        path: string;
-    };
-    type WorkflowGitPullStepOptions = {
-        auth: {
-            user: string;
-            token: string;
-        };
-        repository: {
-            user: string;
-            repo: string;
-            /**
-             * default: main
-             */
-            branch?: string;
-        };
-        files: WorkflowGitPullStepFile[];
-    };
-    type WorkflowStepGitPull = WorkflowStepBase & {
-        type: 'git-pull';
-        options: WorkflowGitPullStepOptions;
-    };
-    /**
-     * Files Write
-     */
-    type WorkflowFilesWriteFile = {
-        path: string;
-        content: string;
-    };
-    type WorkflowFilesWriteStepOptions = {
-        apiKey: string;
-        version: string;
-        files: WorkflowFilesWriteFile[];
-    };
-    type WorkflowStepFilesWrite = WorkflowStepBase & {
-        type: 'files-write';
-        options: WorkflowFilesWriteStepOptions;
-    };
-    /**
-     * Files Read
-     */
-    type WorkflowFilesReadFile = {
-        key: string;
-        path: string;
-    };
-    type WorkflowFilesReadStepOptions = {
-        apiKey: string;
-        version: string;
-        files: WorkflowFilesReadFile[];
-    };
-    type WorkflowStepFilesRead = WorkflowStepBase & {
-        type: 'files-read';
-        options: WorkflowFilesReadStepOptions;
-    };
-    type WorkflowStep = WorkflowStepRequest | WorkflowStepScript | WorkflowStepGitPush | WorkflowStepGitPull | WorkflowStepDcuplInstance | WorkflowStepFilesWrite | WorkflowStepFilesRead;
-    /**
-     * Server Config
-     */
-    type Workflow = {
-        uid: string;
-        key: string;
-        template: Template;
-        runnerUid: string;
-        projectId: string;
-        v: string;
-        createdAt: string;
-        changedAt: string;
-        runtime?: WorkflowRuntime;
-        logContext?: boolean;
-    };
-    type WorkflowRuntime = {
-        workflowTimeout: number;
-        scriptTimeout: number;
-        requestTimeout: number;
-        abortController: AbortController;
-        max_heap_size: number;
-    };
-    type WorkflowStepResult = {
-        key: string;
-        status: 'success' | 'error';
-        result: any;
-        start: number;
-        end: number;
-    };
-    type WorkflowContext = {
-        runContext: RunContext;
-        stepResults: WorkflowStepResult[];
-        runtimeConfig: Workflow.WorkflowRuntime;
-    };
-    type SimpleRequestObject = {
-        body: any;
-        params: any;
-        query: any;
-        method: string;
-        headers: any;
-    };
-    type RunContext = {
-        projectId: string;
-        workflow: Workflow.Workflow;
-        request: SimpleRequestObject;
-        [key: string]: any;
-    };
-    /**
-     * Api Types
-     */
-    type InstanceStatus = 'waiting' | 'processing' | 'ready' | 'updating' | 'error' | 'stopped';
-    type StatusResponse = {
-        key: string;
-        uid: string;
-        status: InstanceStatus;
-        createdAt: string;
-        changedAt: string;
-        templateVersion?: string;
-        v: string;
-    };
-    type ApiInstanceRuntimeResponse = {
-        used_heap_size: number;
-        max_heap_size: number;
-    };
-    type DetailsResponse = {
-        key: string;
-        uid: string;
-        runtime: ApiInstanceRuntimeResponse;
-        invocations: Invocation[];
-    };
-    type ManagerStatus = 'idle';
-    type ManagerMeta = {
-        total: number;
-    };
-    type ManagerStatusRuntime = {
-        used_heap_size: number;
-        total_used_heap_size: number;
-        workers: number;
-    };
-    type ManagerEvent = {
-        type: 'fetch_config' | 'init' | 'initialized' | 'start' | 'stop';
-        createdAt: string;
-        data?: any;
-    };
-    type ManagerStatusResponse = {
-        status: ManagerStatus;
-        meta: ManagerMeta;
-        runtime: ManagerStatusRuntime;
-        instances: StatusResponse[];
-        events: ManagerEvent[];
-    };
-    /**
-     * Invocations
-     */
-    type InvocationStatus = 'completed' | 'failed';
-    type InvocationType = 'project' | 'workflow' | 'total';
-    type Invocation = {
-        key: string;
-        type: InvocationType;
-        completed: number;
-        failed: number;
-        instanceKey?: string;
-        projectId?: string;
-    };
-    /**
-     * DTO's
-     */
-    type DeployDto = {
-        runnerUid: string;
-        template: Template;
-    };
-    type UndeployDto = {
-        uid: string;
-    };
-}

package/dist/lib-cjs/types/workflow/workflow.types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=workflow.types.js.map

package/dist/lib-cjs/types/workflow/workflow.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"workflow.types.js","sourceRoot":"","sources":["../../../../src/types/workflow/workflow.types.ts"],"names":[],"mappings":""}