@dcupl/common 1.4.1 → 1.4.3

package/dist/lib-esm/types/app-loader.types.d.ts

@@ -0,0 +1,203 @@
+import { DataContainerType } from '@dcupl/common';
+export declare namespace AppLoaderConfiguration {
+    /**
+     * The base structure for configuration file contains all resources, evnironments and headers
+     * The process options define how this file is processed
+     *
+     *  @defaultSnippets { "label": "Default Loader Configuration", "properties": ["applications:json:[{\"key\":\"default\", \"name\":\"My Application\"}]", "resources:json:[{\"url\":\"${baseUrl}/models/my-model.dcupl.json\", \"type\":\"model\"},{\"url\":\"${baseUrl}/data/some-data.json\", \"type\":\"data\", \"model\":\"MyModel\"}]"] }
+     */
+    export type ProjectConfiguration = {
+        resources: Resource[];
+        environments?: Environment[];
+        applications?: ApplicationConfiguration[];
+        options?: Options;
+    };
+    /**
+     *  @defaultSnippets { "label": "Application", "properties": ["key", "name", "description", "resourceTags:array"] }
+     */
+    export type ApplicationConfiguration = {
+        key: string;
+        name?: string;
+        description?: string;
+        resourceTags?: string[];
+        variables?: Variable[];
+    };
+    export type ProcessOptions = {
+        applicationKey?: string;
+        environmentKeys?: string[];
+        resourceTags?: string[];
+        variables?: Variable[];
+        options?: Options;
+    };
+    export type FetchOptions = {
+        baseUrl?: string;
+        loaderFileName?: string;
+        headers?: AppLoaderConfiguration.AppLoaderConfigHeader[];
+        skipApply?: boolean;
+    };
+    export type Options = {
+        defaultDataContainerUpdateType?: DataContainerType;
+        csvParserOptions?: CsvParserOptions;
+        missingModelHandling?: {
+            autoGenerateProperties?: boolean;
+        };
+    };
+    export type CsvParserOptions = {
+        delimiter?: string;
+        quoteChar?: string;
+        escapeChar?: string;
+    };
+    export type TransformerType = 'rawFileTransformer' | 'parsedFileTransformer';
+    /**
+     *  @defaultSnippets { "label": "Environment", "properties": ["key", "description", "variables:array", "headers:array", "queryParams:array"] }
+     */
+    export type Environment = {
+        key: string;
+        description?: string;
+        variables?: Variable[];
+        headers?: HttpHeaderConfiguration[];
+        queryParams?: HttpQueryParamConfiguration[];
+    };
+    /**
+     *  @defaultSnippets { "label": "Variable", "properties": ["key", "description", "value:string"] }
+     */
+    export type Variable<T = string> = {
+        key: T;
+        description?: string;
+        value: string | undefined;
+    };
+    export type EnvironmentVariableAsObject = Record<string, any>;
+    /**
+     *  @defaultSnippets { "label": "Query Parameter Configuration", "properties": ["key", "description", "value:string", "tags:array"] }
+     */
+    export type HttpQueryParamConfiguration = {
+        key: string;
+        description?: string;
+        value: string;
+        tags?: string[];
+        condition?: {
+            applyIfVariableHasValue?: string;
+        };
+    };
+    /**
+     *  @defaultSnippets { "label": "Header Configuration", "properties": ["key", "description", "value:string", "tags:array"] }
+     */
+    export type HttpHeaderConfiguration = {
+        key: string;
+        description?: string;
+        value: string;
+        tags?: string[];
+        condition?: {
+            applyIfVariableHasValue?: string;
+        };
+    };
+    export type HttpHeaderAsObject = {
+        [key: string]: string;
+    };
+    type ResourceType = 'model' | 'data' | 'transformer' | 'operator' | 'script';
+    type ResourceBase = {
+        key?: string;
+        url: string;
+        type: ResourceType;
+        tags?: string[];
+    };
+    /**
+     * A model describes a real world object of your applicatoin like a customer, a product or a sales order.
+     *
+     *  @defaultSnippets { "label": "Model", "properties": ["url:string:${baseUrl}/models/my-model.dcupl.json", "type:model", "tags:array"] }
+     */
+    export type ModelResource = ResourceBase & {
+        type: 'model';
+    };
+    /**
+     * A data resource contains data for a model.
+     *
+     *  @defaultSnippets { "label": "Data", "properties": ["url:string:${baseUrl}/data/my-data.json", "type:data", "model", "tags:array"] }
+     */
+    export type DataResource = ResourceBase & {
+        type: 'data';
+        model: string;
+        options?: DataResourceOptions;
+    };
+    /**
+     * A transformer resource points to a javascript file that can be used to transform the data of a data resource.
+     *
+     *  @defaultSnippets { "label": "Transformer", "properties": ["url:string:${baseUrl}/transformers/my-transformer.js", "type:transformer", "applyTo:array", "tags:array"] }
+     */
+    export type TransformerResource = ResourceBase & {
+        type: 'transformer';
+        /**
+         * The tags the transformer applies to
+         */
+        applyTo?: string[];
+        /**
+         * The transformer type
+         * rawFileTransformer: The transformer is applied to the raw file
+         * parsedFileTransformer: The transformer is applied to the parsed file
+         * default: rawFileTransformer
+         */
+        transformerType?: TransformerType;
+    };
+    /**
+     * A script resource.
+     *
+     *  @defaultSnippets { "label": "Query Operator", "properties": ["url:string:${baseUrl}/models/my-operator.js", "type:operator", "operator:my_operator", "tags:array"] }
+     */
+    export type CustomScriptResource = ResourceBase & {
+        type: 'script';
+        /**
+         * The operator name that can be used in a query
+         */
+        scriptKey: string;
+    };
+    /**
+     * A query operator resource points to a javascript file that defines a custom query operator.
+     *
+     *  @defaultSnippets { "label": "Query Operator", "properties": ["url:string:${baseUrl}/models/my-operator.js", "type:operator", "operator:my_operator", "tags:array"] }
+     */
+    export type CustomOperatorResource = ResourceBase & {
+        type: 'operator';
+        /**
+         * The operator name that can be used in a query
+         */
+        operator: string;
+    };
+    export type DataResourceOptions = {
+        updateType?: DataContainerType;
+        autoGenerateProperties?: boolean;
+        autoGenerateKey?: boolean;
+        keyProperty?: string;
+        csvParserOptions?: CsvParserOptions;
+    };
+    export type Resource = ModelResource | DataResource | TransformerResource | CustomOperatorResource | CustomScriptResource;
+    export type AppLoaderConfigHeader = {
+        key: string;
+        value: string;
+    };
+    export {};
+}
+export type FilesApiStatusResponse = {
+    changedAt: number;
+};
+/**
+ * The input type is depending on the resource type (csv/json) and if it's a raw or parsed transformer
+ * Shuld return the transformed data
+ */
+export type AppLoaderTransformerFunction = (item: AppLoaderConfiguration.Resource, input: any) => any;
+export declare namespace AppLoaderProgress {
+    type ResourceItem = AppLoaderConfiguration.Resource;
+    type ProgressItem = {
+        total: number;
+        processed: number;
+        remaining: number;
+        progress: number;
+        context: string;
+        currentItem: ResourceItem;
+        totalItems: ResourceItem[];
+        processedItems: ResourceItem[];
+        downloadedItems: ResourceItem[];
+        failedItems: ResourceItem[];
+        remainingItems: ResourceItem[];
+    };
+    type CallbackFunction = (item: ProgressItem) => void;
+}

package/dist/lib-esm/types/app-loader.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=app-loader.types.js.map

package/dist/lib-esm/types/app-loader.types.js.map

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

package/dist/lib-esm/types/index.d.ts

@@ -1,3 +1,4 @@
+export * from './app-loader.types';
 export * from './aggregation.types';
 export * from './data.types';
 export * from './dcupl.types';
@@ -12,3 +13,4 @@ export * from './query.types';
 export * from './section.types';
 export * from './suggestion.types';
 export * from './testing.types';
+export * from './workflow.types';

package/dist/lib-esm/types/index.js

@@ -1,3 +1,4 @@
+export * from './app-loader.types';
 export * from './aggregation.types';
 export * from './data.types';
 export * from './dcupl.types';
@@ -12,4 +13,5 @@ export * from './query.types';
 export * from './section.types';
 export * from './suggestion.types';
 export * from './testing.types';
+export * from './workflow.types';
 //# sourceMappingURL=index.js.map

package/dist/lib-esm/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC"}

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

@@ -0,0 +1,154 @@
+import { DataContainer } from '@dcupl/common';
+import { AppLoaderConfiguration } from './app-loader.types';
+import { ModelDefinition } from '@dcupl/common';
+export declare namespace Workflow {
+    type Workflow = {
+        key: string;
+        projectId: string;
+        config: WorkflowConfig;
+        apiKey?: string;
+        name?: string;
+        description?: string;
+        runtime?: WorkflowRuntime;
+        variables?: Record<string, string>;
+    };
+    type WorkflowRuntime = {
+        workflowTimeout: number;
+        scriptTimeout: number;
+    };
+    /**
+     *
+     * Response
+     *
+     */
+    type WorkflowResponseType = 'script' | 'status' | 'debug';
+    type WorkflowResponseConfigBase = {
+        type: WorkflowResponseType;
+        headers?: any;
+    };
+    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' | 'dcupl-instance';
+    type WorkflowStepBase = {
+        key: string;
+        type: WorflowStepType;
+        name?: string;
+        description?: string;
+        skip?: boolean;
+    };
+    type WorkflowRequestMethod = 'GET' | 'POST' | 'PUT' | 'DELETE';
+    type WorkflowStepRequestOptions = {
+        url: string;
+        method: WorkflowRequestMethod;
+        body?: any;
+        headers?: any;
+    };
+    type WorkflowStepRequest = WorkflowStepBase & {
+        type: 'request';
+        options: WorkflowStepRequestOptions;
+        scripts?: {
+            prepare?: string;
+            response?: string;
+            error?: string;
+            success?: string;
+        };
+    };
+    type WorkflowStepScript = WorkflowStepBase & {
+        type: 'script';
+        script: string;
+    };
+    type WorkflowStepDcuplInstanceDataContainer = DataContainer & {
+        data: string;
+    };
+    type WorkflowStepDcuplInstance = WorkflowStepBase & {
+        type: 'dcupl-instance';
+        processOptions: AppLoaderConfiguration.ProcessOptions;
+        fetchOptions?: AppLoaderConfiguration.FetchOptions;
+        dataContainers?: WorkflowStepDcuplInstanceDataContainer[];
+        models?: ModelDefinition[];
+        loaderConfig?: AppLoaderConfiguration.ProjectConfiguration;
+        scriptName?: string;
+        script?: string;
+    };
+    type WorkflowGitPushStepFile = {
+        path: string;
+        value: string;
+        commitMessage?: string;
+    };
+    type WorkflowGitPushStepOptions = {
+        auth: {
+            user: string;
+            token: string;
+        };
+        repository: {
+            user: string;
+            repo: string;
+        };
+        files: WorkflowGitPushStepFile[];
+    };
+    type WorkflowStepGit = WorkflowStepBase & {
+        type: 'git-push';
+        options: WorkflowGitPushStepOptions;
+    };
+    type WorkflowStep = WorkflowStepRequest | WorkflowStepScript | WorkflowStepGit | WorkflowStepDcuplInstance;
+}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=workflow.types.js.map

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

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