@contrail/cli 1.0.71 → 2.0.1

package/{lib → dist}/interfaces.d.ts

@@ -1,191 +1,323 @@
-/** Describes the derivative JSON / object represented
- * in app.yml file.
- */
-export interface AppDeclaration {
-    appIdentifier: string;
-    appName: string;
-    appDescription?: string;
-    visibility: 'private' | 'public';
-    publisher: string;
-    version: string;
-    eventWorkflowTriggerKeyMapping: string;
-    thumbnail?: string;
-    keywords?: Array<string>;
-    actions?: {
-        [key: string]: AppActionDeclaration;
-    };
-    appConfiguration: ConfigPropertyElements;
-    triggers: {
-        [key: string]: AppTriggerDeclaration;
-    };
-    workflows?: {
-        [key: string]: WorkflowDefinition | WorkflowTemplateDeclaration;
-    };
-    dockerImageRef?: string;
-}
-export interface ConfigPropertyElements {
-    [key: string]: ConfigPropertyElement;
-}
-export interface ConfigPropertyElement {
-    propertyType: string;
-    options?: any[];
-    label: string;
-    dynamic?: boolean;
-}
-export interface AppActionDeclaration {
-    handler: string;
-    public?: boolean;
-    name: string;
-    description?: string;
-    actionConfiguration?: ConfigPropertyElements;
-    async?: boolean;
-}
-export interface AppTriggerDeclaration {
-    key: string;
-    name: string;
-    external?: boolean;
-    description?: string;
-}
-export interface WorkflowDefinition {
-    id?: string;
-    identifier: string;
-    name: string;
-    triggerKey: string;
-    workflowDefinition: WorkflowDefinitionPaths;
-    ownerKey: string;
-    isActive: boolean;
-    public: boolean;
-    supportingAppId?: string;
-    messageGroupId?: string;
-    parallelWorkerCount?: number;
-}
-export interface WorkflowTemplateDeclaration {
-    workflows?: {
-        [key: string]: WorkflowTemplate;
-    };
-}
-export interface WorkflowTemplate {
-    id?: string;
-    identifier?: string;
-    name: string;
-    triggerKey: string;
-    workflowDefinition: WorkflowDefinitionPaths;
-    isActive: boolean;
-    ownerKey?: string;
-    supportingAppId?: string;
-    messageGroupId?: string;
-    parallelWorkerCount?: number;
-}
-export interface WorkflowDefinitionPaths {
-    paths: WorkflowConditional[];
-}
-export interface WorkflowConditional {
-    conditional: string;
-    actionDefinitionConfigs: ActionDefinitionConfig[];
-}
-export interface ActionDefinitionConfig {
-    name: string;
-    action: string;
-    config?: {
-        [key: string]: any;
-    };
-    id?: string;
-}
-export interface App {
-    id: string;
-    identifier: string;
-    name: string;
-    public: boolean;
-    description?: string;
-    publisher: string;
-    thumbnail: string;
-    eventWorkflowTriggerKeyMapping: string;
-    configProperties?: ConfigProperty[];
-    triggerKeyDefinitions?: TriggerKeyDefinition[];
-}
-export interface AppOrg {
-    id: string;
-    createdOn?: Date;
-    updatedOn?: Date;
-    createdById?: string;
-    updatedById?: string;
-    createdBy?: any;
-    updatedBy?: any;
-    orgId?: string;
-    status: AppOrgStatus;
-    appId?: string;
-    app?: App;
-    appVersionId?: string;
-    appVersion?: AppVersion;
-    apiKey?: AppApiKey;
-    appConfig?: any;
-}
-export declare enum AppOrgStatus {
-    INSTALLING = "INSTALLING",
-    FAILED_INSTALLING = "FAILED_INSTALLING",
-    READY = "READY",
-    DELETING = "DELETING",
-    FAILED_DELETING = "FAILED_DELETING"
-}
-export declare enum AppVersionStatus {
-    PUBLISHING = "PUBLISHING",
-    FAILED_PUBLISHING = "FAILED_PUBLISHING",
-    PUBLISHED = "PUBLISHED",
-    ARCHIVING = "ARCHIVING",
-    FAILED_ARCHIVING = "FAILED_ARCHIVING",
-    ARCHIVED = "ARCHIVED"
-}
-export declare class AppVersion {
-    id: string;
-    createdOn?: Date;
-    updatedOn?: Date;
-    createdById?: string;
-    updatedById?: string;
-    createdBy?: any;
-    updatedBy?: any;
-    orgId?: string;
-    appId?: string;
-    app?: App;
-    appOrgs?: AppOrg[];
-    versionNumber: number;
-    status: AppVersionStatus;
-    eventWorkflowTriggerKeyMapping: string;
-    configProperties?: ConfigProperty[];
-    triggerKeyDefinitions?: TriggerKeyDefinition[];
-    dockerImageRef?: string;
-}
-export declare class AppApiKey {
-    id: string;
-    createdOn?: Date;
-    updatedOn?: Date;
-    createdById?: string;
-    updatedById?: string;
-    createdBy?: any;
-    updatedBy?: any;
-    orgId?: string;
-    appOrgId?: string;
-    appOrg?: AppOrg;
-    apiKey?: string;
-}
-export declare class ConfigProperty {
-    slug: string;
-    propertyType: string;
-    options?: any[];
-    label: string;
-}
-export interface EventWorkflowActionDefinition {
-    id?: string;
-    identifier?: string;
-    name?: string;
-    executeFunctionString?: string;
-    ownerKey?: string;
-    public?: boolean;
-    configProperties?: ConfigProperty[];
-    async?: boolean;
-}
-export declare class TriggerKeyDefinition {
-    name: string;
-    description?: string;
-    triggerKey: string;
-    external?: boolean;
-}
+/** Describes the derivative JSON / object represented
+ * in app.yml file.
+ */
+export interface AppDeclaration {
+    appIdentifier: string;
+    appName: string;
+    appDescription?: string;
+    visibility: 'private' | 'public';
+    publisher: string;
+    version: string;
+    eventWorkflowTriggerKeyMapping: string;
+    thumbnail?: string;
+    keywords?: Array<string>;
+    actions?: {
+        [key: string]: AppActionDeclaration;
+    };
+    appConfiguration: ConfigPropertyElements;
+    triggers: {
+        [key: string]: AppTriggerDeclaration;
+    };
+    workflows?: {
+        [key: string]: WorkflowDefinition | WorkflowTemplateDeclaration;
+    };
+    dockerImageRef?: string;
+}
+export interface ConfigPropertyElements {
+    [key: string]: ConfigPropertyElement;
+}
+export interface ConfigPropertyElement {
+    propertyType: string;
+    options?: any[];
+    label: string;
+    dynamic?: boolean;
+}
+export interface AppActionDeclaration {
+    handler: string;
+    public?: boolean;
+    name: string;
+    description?: string;
+    actionConfiguration?: ConfigPropertyElements;
+    async?: boolean;
+}
+export interface AppTriggerDeclaration {
+    key: string;
+    name: string;
+    external?: boolean;
+    description?: string;
+}
+export interface WorkflowDefinition {
+    id?: string;
+    identifier: string;
+    name: string;
+    triggerKey: string;
+    workflowDefinition: WorkflowDefinitionPaths;
+    ownerKey: string;
+    isActive: boolean;
+    public: boolean;
+    supportingAppId?: string;
+    messageGroupId?: string;
+    parallelWorkerCount?: number;
+}
+export interface WorkflowTemplateDeclaration {
+    workflows?: {
+        [key: string]: WorkflowTemplate;
+    };
+}
+export interface WorkflowTemplate {
+    id?: string;
+    identifier?: string;
+    name: string;
+    triggerKey: string;
+    workflowDefinition: WorkflowDefinitionPaths;
+    isActive: boolean;
+    ownerKey?: string;
+    supportingAppId?: string;
+    messageGroupId?: string;
+    parallelWorkerCount?: number;
+}
+export interface WorkflowDefinitionPaths {
+    paths: WorkflowConditional[];
+}
+export interface WorkflowConditional {
+    conditional: string;
+    actionDefinitionConfigs: ActionDefinitionConfig[];
+}
+export interface ActionDefinitionConfig {
+    name: string;
+    action: string;
+    config?: {
+        [key: string]: any;
+    };
+    id?: string;
+}
+export interface App {
+    id: string;
+    identifier: string;
+    name: string;
+    public: boolean;
+    description?: string;
+    publisher: string;
+    thumbnail: string;
+    eventWorkflowTriggerKeyMapping: string;
+    configProperties?: ConfigProperty[];
+    triggerKeyDefinitions?: TriggerKeyDefinition[];
+}
+export interface AppOrg {
+    id: string;
+    createdOn?: Date;
+    updatedOn?: Date;
+    createdById?: string;
+    updatedById?: string;
+    createdBy?: any;
+    updatedBy?: any;
+    orgId?: string;
+    status: AppOrgStatus;
+    appId?: string;
+    app?: App;
+    appVersionId?: string;
+    appVersion?: AppVersion;
+    apiKey?: AppApiKey;
+    appConfig?: any;
+}
+export declare enum AppOrgStatus {
+    INSTALLING = "INSTALLING",
+    FAILED_INSTALLING = "FAILED_INSTALLING",
+    READY = "READY",
+    DELETING = "DELETING",
+    FAILED_DELETING = "FAILED_DELETING"
+}
+export declare enum AppVersionStatus {
+    PUBLISHING = "PUBLISHING",
+    FAILED_PUBLISHING = "FAILED_PUBLISHING",
+    PUBLISHED = "PUBLISHED",
+    ARCHIVING = "ARCHIVING",
+    FAILED_ARCHIVING = "FAILED_ARCHIVING",
+    ARCHIVED = "ARCHIVED"
+}
+export declare class AppVersion {
+    id: string;
+    createdOn?: Date;
+    updatedOn?: Date;
+    createdById?: string;
+    updatedById?: string;
+    createdBy?: any;
+    updatedBy?: any;
+    orgId?: string;
+    appId?: string;
+    app?: App;
+    appOrgs?: AppOrg[];
+    versionNumber: number;
+    status: AppVersionStatus;
+    eventWorkflowTriggerKeyMapping: string;
+    configProperties?: ConfigProperty[];
+    triggerKeyDefinitions?: TriggerKeyDefinition[];
+    dockerImageRef?: string;
+}
+export declare class AppApiKey {
+    id: string;
+    createdOn?: Date;
+    updatedOn?: Date;
+    createdById?: string;
+    updatedById?: string;
+    createdBy?: any;
+    updatedBy?: any;
+    orgId?: string;
+    appOrgId?: string;
+    appOrg?: AppOrg;
+    apiKey?: string;
+}
+export declare class ConfigProperty {
+    slug: string;
+    propertyType: string;
+    options?: any[];
+    label: string;
+}
+export interface EventWorkflowActionDefinition {
+    id?: string;
+    identifier?: string;
+    name?: string;
+    executeFunctionString?: string;
+    ownerKey?: string;
+    public?: boolean;
+    configProperties?: ConfigProperty[];
+    async?: boolean;
+}
+export declare class TriggerKeyDefinition {
+    name: string;
+    description?: string;
+    triggerKey: string;
+    external?: boolean;
+}
+export declare class CommonConfiguration {
+    [key: string]: any;
+}
+export declare enum AssortmentType {
+    ASSORTMENT = "ASSORTMENT",
+    BOARD = "BOARD",
+    PLAN = "PLAN",
+    SHOWCASE = "SHOWCASE"
+}
+export declare class AssortmentConfiguration {
+    identifier: string;
+    name: string;
+    type: AssortmentType;
+    sourceAssortmentIdentifier?: string;
+    composedFromAssortmentIdentifiers?: string[];
+    ownerAtts?: {
+        [key: string]: any;
+    };
+    assortmentAtts?: {
+        [key: string]: any;
+    };
+}
+export declare class Folder {
+    identifier: string;
+    name: string;
+    principals: string[];
+    assortments: AssortmentConfiguration[];
+    subFolders: Folder[];
+}
+export declare class ProjectConfiguration {
+    projectName: string;
+    identifier: string;
+    commonConfig: CommonConfiguration;
+    principals: string[];
+    assortments: AssortmentConfiguration[];
+    subFolders: Folder[];
+}
+export declare class ProjectConfigurationTemplate {
+    projectName: string;
+    identifier: string;
+    commonConfig: CommonConfiguration;
+    principals: string[];
+    allFolders: FolderSlim[];
+    allAssortments: AssortmentConfigurationSlim[];
+    allAssortmentRelationships: AssortmentConfigurationRelationships[];
+}
+export declare class FolderSlim {
+    identifier: string;
+    name: string;
+    principals: string[];
+    folderIdentifier: string;
+}
+export declare class AssortmentConfigurationSlim {
+    identifier: string;
+    name: string;
+    type: AssortmentType;
+    folderIdentifier: string;
+    sourceAssortmentIdentifier?: string;
+    composedFromAssortmentIdentifiers?: string[];
+    ownerAtts?: {
+        [key: string]: any;
+    };
+    assortmentAtts?: {
+        [key: string]: any;
+    };
+}
+export declare class AssortmentConfigurationRelationships {
+    identifier: string;
+    sourceAssortmentIdentifier?: string;
+    composedFromAssortmentIdentifiers?: string[];
+    ownerAtts?: {
+        [key: string]: any;
+    };
+    assortmentAtts?: {
+        [key: string]: any;
+    };
+}
+export interface ReducedType {
+    slug: string;
+    label: string;
+    typePath: string;
+    isArchived: boolean;
+    typeProperties: ReducedTypeProperty[];
+}
+export interface ReducedTypeProperty {
+    id: string;
+    isArchived: boolean;
+    propertyType: PropertyType;
+    slug: string;
+    label: string;
+    editable: boolean;
+    searchable: boolean;
+    core: boolean;
+    typePropertyOptionSetName: string;
+    formula: string;
+    referencedTypeRootSlug: string;
+    defaultValue: string;
+    propertyLevel: string;
+    inherited: boolean;
+    formulaFunction?: string;
+    validationFunction?: string;
+    numberFormat?: any;
+}
+export interface ReducedOptionSet {
+    name: string;
+    isArchived: boolean;
+    optionSet: any[];
+}
+export declare enum PropertyType {
+    Text = "text",
+    String = "string",
+    Number = "number",
+    Date = "date",
+    Boolean = "boolean",
+    MultiSelect = "multi_select",
+    SingleSelect = "choice",
+    Url = "url",
+    Currency = "currency",
+    Percent = "percent",
+    Rating = "rating",
+    Formula = "formula",
+    ObjectReference = "object_reference",
+    ObjectReferenceList = "object_ref_list",
+    DataGrid = "data_grid",
+    CascadingSelect = "cascading_select",
+    Sequence = "sequence",
+    Constant = "constant",
+    Composite = "composite",
+    UserList = "userList",
+    Image = "image",
+    Json = "json"
+}

package/dist/interfaces.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssortmentConfigurationRelationships = exports.AssortmentConfigurationSlim = exports.FolderSlim = exports.ProjectConfigurationTemplate = exports.ProjectConfiguration = exports.Folder = exports.AssortmentConfiguration = exports.AssortmentType = exports.CommonConfiguration = exports.TriggerKeyDefinition = exports.ConfigProperty = exports.AppApiKey = exports.AppVersion = exports.AppVersionStatus = exports.AppOrgStatus = void 0;
+var AppOrgStatus;
+(function (AppOrgStatus) {
+    AppOrgStatus["INSTALLING"] = "INSTALLING";
+    AppOrgStatus["FAILED_INSTALLING"] = "FAILED_INSTALLING";
+    AppOrgStatus["READY"] = "READY";
+    AppOrgStatus["DELETING"] = "DELETING";
+    AppOrgStatus["FAILED_DELETING"] = "FAILED_DELETING";
+})(AppOrgStatus = exports.AppOrgStatus || (exports.AppOrgStatus = {}));
+var AppVersionStatus;
+(function (AppVersionStatus) {
+    AppVersionStatus["PUBLISHING"] = "PUBLISHING";
+    AppVersionStatus["FAILED_PUBLISHING"] = "FAILED_PUBLISHING";
+    AppVersionStatus["PUBLISHED"] = "PUBLISHED";
+    AppVersionStatus["ARCHIVING"] = "ARCHIVING";
+    AppVersionStatus["FAILED_ARCHIVING"] = "FAILED_ARCHIVING";
+    AppVersionStatus["ARCHIVED"] = "ARCHIVED";
+})(AppVersionStatus = exports.AppVersionStatus || (exports.AppVersionStatus = {}));
+class AppVersion {
+}
+exports.AppVersion = AppVersion;
+class AppApiKey {
+}
+exports.AppApiKey = AppApiKey;
+class ConfigProperty {
+}
+exports.ConfigProperty = ConfigProperty;
+class TriggerKeyDefinition {
+}
+exports.TriggerKeyDefinition = TriggerKeyDefinition;
+class CommonConfiguration {
+}
+exports.CommonConfiguration = CommonConfiguration;
+var AssortmentType;
+(function (AssortmentType) {
+    AssortmentType["ASSORTMENT"] = "ASSORTMENT";
+    AssortmentType["BOARD"] = "BOARD";
+    AssortmentType["PLAN"] = "PLAN";
+    AssortmentType["SHOWCASE"] = "SHOWCASE";
+})(AssortmentType = exports.AssortmentType || (exports.AssortmentType = {}));
+class AssortmentConfiguration {
+}
+exports.AssortmentConfiguration = AssortmentConfiguration;
+class Folder {
+}
+exports.Folder = Folder;
+class ProjectConfiguration {
+}
+exports.ProjectConfiguration = ProjectConfiguration;
+class ProjectConfigurationTemplate {
+}
+exports.ProjectConfigurationTemplate = ProjectConfigurationTemplate;
+class FolderSlim {
+}
+exports.FolderSlim = FolderSlim;
+class AssortmentConfigurationSlim {
+}
+exports.AssortmentConfigurationSlim = AssortmentConfigurationSlim;
+class AssortmentConfigurationRelationships {
+}
+exports.AssortmentConfigurationRelationships = AssortmentConfigurationRelationships;

package/{templates → dist/templates}/typescript/Dockerfile

@@ -1,15 +1,15 @@
-# docker build -t app-name .
-# docker run -p 9000:8080 app-name
-FROM public.ecr.aws/lambda/nodejs:16
-
-# Install NPM dependencies for function
-COPY package* ${LAMBDA_TASK_ROOT}
-COPY app.yml  ${LAMBDA_TASK_ROOT}
-RUN npm install
-
-COPY tsconfig.json  ${LAMBDA_TASK_ROOT}
-COPY src/       ${LAMBDA_TASK_ROOT}/src
-
-RUN npm run build
-
-CMD ["dist/framework/handler.execute"]
+# docker build -t app-name .
+# docker run -p 9000:8080 app-name
+FROM public.ecr.aws/lambda/nodejs:16
+
+# Install NPM dependencies for function
+COPY package* ${LAMBDA_TASK_ROOT}
+COPY app.yml  ${LAMBDA_TASK_ROOT}
+RUN npm install
+
+COPY tsconfig.json  ${LAMBDA_TASK_ROOT}
+COPY src/       ${LAMBDA_TASK_ROOT}/src
+
+RUN npm run build
+
+CMD ["dist/framework/handler.execute"]

package/{templates → dist/templates}/typescript/README.md

@@ -1,10 +1,10 @@
-### building and uploading docker image to ECR
-1. set AWS_REGISTRY  environment variable to be able to tag  and/or push to ECR
-### Example: xxx.dkr.ecr.us-east-1.amazonaws.com
-1. To build, run, tag, and push using docker, there are npm scripts that can be used.
-2. The npm scripts use the npm package name, version, and config fields to set the appropriate values
-3. OPTIONAL: if you want to inspect the container you can run `npm run docker-run-entry`
-4. OPTIONAL: if you want to run this locally using port 9000, you can run `npm run docker-run`
-5. To tag the image for pushing to ECR `npm run docker-tag`
-6. To push the image to ECR `npm run docker-push`
-7. All the npm scripts have a ':win" version to run on windows
+### building and uploading docker image to ECR
+1. set AWS_REGISTRY  environment variable to be able to tag  and/or push to ECR
+### Example: xxx.dkr.ecr.us-east-1.amazonaws.com
+1. To build, run, tag, and push using docker, there are npm scripts that can be used.
+2. The npm scripts use the npm package name, version, and config fields to set the appropriate values
+3. OPTIONAL: if you want to inspect the container you can run `npm run docker-run-entry`
+4. OPTIONAL: if you want to run this locally using port 9000, you can run `npm run docker-run`
+5. To tag the image for pushing to ECR `npm run docker-tag`
+6. To push the image to ECR `npm run docker-push`
+7. All the npm scripts have a ':win" version to run on windows