@contrail/cli 2.1.8 → 2.1.10

package/README.md

@@ -15,7 +15,7 @@ $ npm install -g @contrail/cli
 $ contrail COMMAND
 running command...
 $ contrail (--version)
-@contrail/cli/2.1.8 darwin-arm64 node-v18.13.0
+@contrail/cli/2.1.10 darwin-arm64 node-v18.13.0
 $ contrail --help [COMMAND]
 USAGE
   $ contrail COMMAND

package/dist/helpers/app/app-deployer.js

@@ -48,6 +48,7 @@ class AppDeployer {
         if (appDeclaration === null || appDeclaration === void 0 ? void 0 : appDeclaration.appConfiguration) {
             configProperties = app_template_parsers_1.ConfigPropertiesParser.getConfigProperties(appDeclaration.appConfiguration);
         }
+        const externalLinks = appDeclaration.externalLinks ? app_template_parsers_1.ExternalLinkParser.validateAndGetExternalLinks(appDeclaration.externalLinks) : [];
         let triggerKeyDefinitions;
         if (appDeclaration === null || appDeclaration === void 0 ? void 0 : appDeclaration.triggers) {
             triggerKeyDefinitions = app_template_parsers_1.TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration);
@@ -63,6 +64,7 @@ class AppDeployer {
             eventWorkflowTriggerKeyMapping: appDeclaration.eventWorkflowTriggerKeyMapping,
             keywords: appDeclaration.keywords,
             configProperties,
+            externalLinks,
             triggerKeyDefinitions,
             dockerImageRef: (_a = appDeclaration.dockerImageRef) !== null && _a !== void 0 ? _a : null,
             frameworkVersion: 2,
@@ -99,6 +101,7 @@ class AppDeployer {
             const appCodePackage = await createNodePackage(appDeclaration.appIdentifier, this.debug, this.dryRun);
             appCodePackageId = appCodePackage.id;
         }
+        const externalLinks = appDeclaration.externalLinks ? app_template_parsers_1.ExternalLinkParser.validateAndGetExternalLinks(appDeclaration.externalLinks) : [];
         const updates = {
             name: appDeclaration.appName,
             public: appDeclaration.visibility === 'public',
@@ -109,6 +112,7 @@ class AppDeployer {
             eventWorkflowTriggerKeyMapping: appDeclaration.eventWorkflowTriggerKeyMapping,
             keywords: appDeclaration.keywords,
             configProperties,
+            externalLinks,
             triggerKeyDefinitions,
             dockerImageRef: (_a = appDeclaration.dockerImageRef) !== null && _a !== void 0 ? _a : null,
             appCodePackageId: appCodePackageId !== null && appCodePackageId !== void 0 ? appCodePackageId : null,

package/dist/helpers/app/app-template-parsers.d.ts

@@ -1,3 +1,4 @@
+import { ExternalLink } from '@contrail/entity-types';
 import { AppDeclaration, TriggerKeyDefinition, ConfigPropertyElements } from '../../interfaces';
 export declare class TriggerKeyDefinitionParser {
     static buildTriggersArray(appDeclaration: AppDeclaration): Array<TriggerKeyDefinition>;
@@ -5,3 +6,6 @@ export declare class TriggerKeyDefinitionParser {
 export declare class ConfigPropertiesParser {
     static getConfigProperties(configPropertyElements: ConfigPropertyElements): any[];
 }
+export declare class ExternalLinkParser {
+    static validateAndGetExternalLinks(externalLinks: ExternalLink[]): ExternalLink[];
+}

package/dist/helpers/app/app-template-parsers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigPropertiesParser = exports.TriggerKeyDefinitionParser = void 0;
+exports.ExternalLinkParser = exports.ConfigPropertiesParser = exports.TriggerKeyDefinitionParser = void 0;
 class TriggerKeyDefinitionParser {
     static buildTriggersArray(appDeclaration) {
         const triggers = [];
@@ -41,3 +41,33 @@ class ConfigPropertiesParser {
     }
 }
 exports.ConfigPropertiesParser = ConfigPropertiesParser;
+class ExternalLinkParser {
+    static validateAndGetExternalLinks(externalLinks) {
+        if (typeof externalLinks !== 'object' || !Array.isArray(externalLinks)) {
+            throw new Error('externalLinks must be an array');
+        }
+        for (const link of externalLinks) {
+            if (!link.name || typeof link.name !== 'string') {
+                throw new Error('externalLinks must have a url property (string)');
+            }
+            if (!link.link || typeof link.link !== 'string') {
+                throw new Error('externalLinks must have a link property (string)');
+            }
+            if (link.extraAttributes) {
+                if (!Array.isArray(link.extraAttributes)) {
+                    throw new Error('optional externalLinks[].extraAttributes must be an array of objects');
+                }
+                for (const attr of link.extraAttributes) {
+                    if (!attr.name || typeof attr.name !== 'string') {
+                        throw new Error(`externalLinks[].extraAttributes must have a name property (string). Found ${JSON.stringify(attr)}`);
+                    }
+                    if (!attr.value || typeof attr.value !== 'string') {
+                        throw new Error(`externalLinks[].extraAttributes must have a value property (string). Found ${JSON.stringify(attr)}`);
+                    }
+                }
+            }
+        }
+        return externalLinks;
+    }
+}
+exports.ExternalLinkParser = ExternalLinkParser;

package/dist/interfaces.d.ts

@@ -1,3 +1,4 @@
+import { ExternalLink } from '@contrail/entity-types';
 /** Describes the derivative JSON / object represented
  * in app.yml file.
  */
@@ -16,6 +17,7 @@ export interface AppDeclaration {
         [key: string]: AppActionDeclaration;
     };
     appConfiguration: ConfigPropertyElements;
+    externalLinks: ExternalLink[];
     triggers: {
         [key: string]: AppTriggerDeclaration;
     };

package/dist/templates/typescript/README.md

@@ -1,10 +1,5 @@
-### 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
+### Running your app
+Run `npm run start` at the root directory of your app (where the `package.json` file is located).
+
+### Publishing your app
+Run `contrail app publish` to publish a new version of the app.

package/dist/templates/typescript/package.json

@@ -22,7 +22,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@contrail/app-framework": "^1.0.9",
+    "@contrail/app-framework": "^1.2.2",
     "@contrail/sdk": "^1.1.54",
     "chalk": "^4.0.0",
     "js-yaml": "^4.1.0"

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.1.8",
+  "version": "2.1.10",
   "commands": {
     "app:create": {
       "id": "app:create",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/cli",
-  "version": "2.1.8",
+  "version": "2.1.10",
   "description": "VibeIQ's Contrail Platform CLI.",
   "bin": {
     "contrail-cli": "./bin/run",
@@ -22,6 +22,7 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
+    "@contrail/entity-types": "^1.1.9",
     "@contrail/sdk": "^1.2.3",
     "@contrail/types": "^3.0.20",
     "@contrail/util": "^1.0.17",