@contrail/cli 3.5.4 → 3.5.5-alpha.177136f

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExtensionsDeployer = exports.getExtensionDefinitionsForAppVersion = void 0;
+exports.ExtensionsDeployer = exports.buildExtensionDefinition = exports.getExtensionDefinitionsForAppVersion = void 0;
 const tslib_1 = require("tslib");
 const sdk_1 = require("@contrail/sdk");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
@@ -13,6 +13,28 @@ async function getExtensionDefinitionsForAppVersion(app) {
     });
 }
 exports.getExtensionDefinitionsForAppVersion = getExtensionDefinitionsForAppVersion;
+/** The definition published for an app.yml extension, for a new version or an update alike. */
+function buildExtensionDefinition(extension, app, appName) {
+    return {
+        identifier: util_1.AppUtil.createExtensionIdentifier({
+            extensionIdentifier: extension?.identifier,
+            appIdentifier: app.identifier,
+        }),
+        name: extension.name,
+        appId: app.id,
+        appVersionId: app.latestAppVersionId,
+        extensionType: extension.extensionType,
+        userApps: extension.userApps,
+        /** @deprecated since entity-types v1.5.1, use display instead */
+        modalDimensions: extension.modalDimensions,
+        display: extension.display,
+        iframeUrl: extension.iframeUrl,
+        icon: extension.icon,
+        appliesTo: extension.appliesTo,
+        group: extension.group ?? appName,
+    };
+}
+exports.buildExtensionDefinition = buildExtensionDefinition;
 class ExtensionsDeployer {
     async deployExtensions(appDeclaration, app) {
         // FETCH ALL EXTENSIONS FROM THE API.
@@ -26,11 +48,11 @@ class ExtensionsDeployer {
         logger_1.default.debug(appDeclaration.extensions);
         if (appDeclaration.extensions) {
             for (const extension of appDeclaration?.extensions ?? []) {
-                await this.deployExtension(extension, app, existingExtensions);
+                await this.deployExtension(extension, app, existingExtensions, appDeclaration.appName);
             }
         }
     }
-    async deployExtension(extension, app, existingExtensions) {
+    async deployExtension(extension, app, existingExtensions, appName) {
         logger_1.default.info(`${chalk_1.default.yellow.bold('EXTENSION')} \tDeploying extension: ${extension?.identifier}`);
         const identifier = util_1.AppUtil.createExtensionIdentifier({
             appIdentifier: app.identifier,
@@ -38,28 +60,14 @@ class ExtensionsDeployer {
         });
         const existingDefinition = existingExtensions.find((ad) => ad.identifier === identifier);
         if (!existingDefinition) {
-            await this.createNewExtensionDefinition(extension, app);
+            await this.createNewExtensionDefinition(extension, app, appName);
         }
         else {
-            await this.updateActionDefinition(existingDefinition, extension, app);
+            await this.updateActionDefinition(existingDefinition, extension, app, appName);
         }
     }
-    async createNewExtensionDefinition(extension, app) {
-        const newObject = {
-            identifier: util_1.AppUtil.createExtensionIdentifier({
-                extensionIdentifier: extension?.identifier,
-                appIdentifier: app.identifier,
-            }),
-            name: extension.name,
-            appId: app.id,
-            appVersionId: app.latestAppVersionId,
-            extensionType: extension.extensionType,
-            userApps: extension.userApps,
-            /** @deprecated since entity-types v1.5.1, use display instead */
-            modalDimensions: extension.modalDimensions,
-            display: extension.display,
-            iframeUrl: extension.iframeUrl,
-        };
+    async createNewExtensionDefinition(extension, app, appName) {
+        const newObject = buildExtensionDefinition(extension, app, appName);
         const actionDefinition = await new sdk_1.Entities().create({
             entityName: 'app-extension-definition',
             object: newObject,
@@ -67,22 +75,8 @@ class ExtensionsDeployer {
         logger_1.default.info(`${chalk_1.default.yellow.bold('EXTENSION')}     Created new extension definition: ${extension?.identifier}`);
         return actionDefinition;
     }
-    async updateActionDefinition(existingActionDefinition, extension, app) {
-        const updates = {
-            identifier: util_1.AppUtil.createExtensionIdentifier({
-                extensionIdentifier: extension?.identifier,
-                appIdentifier: app.identifier,
-            }),
-            name: extension.name,
-            appId: app.id,
-            appVersionId: app.latestAppVersionId,
-            extensionType: extension.extensionType,
-            userApps: extension.userApps,
-            /** @deprecated since entity-types v1.5.1, use display instead */
-            modalDimensions: extension.modalDimensions,
-            display: extension.display,
-            iframeUrl: extension.iframeUrl,
-        };
+    async updateActionDefinition(existingActionDefinition, extension, app, appName) {
+        const updates = buildExtensionDefinition(extension, app, appName);
         const extensionDefinition = await new sdk_1.Entities().update({
             entityName: 'app-extension-definition',
             id: existingActionDefinition.id,

package/dist/helpers/app/extensions-deployer.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const extensions_deployer_1 = require("./extensions-deployer");
+const app = {
+    id: 'app-1',
+    identifier: '@vibeiq.com/gap-design-poc',
+    latestAppVersionId: 'version-1',
+};
+describe('buildExtensionDefinition', () => {
+    it('should publish placement as declared, grouped under the app name', () => {
+        const definition = (0, extensions_deployer_1.buildExtensionDefinition)({
+            identifier: 'line-builder',
+            name: 'Line builder',
+            iframeUrl: 'http://localhost:4395/index.html#/line-builder',
+            icon: 'line-builder',
+            appliesTo: { typePaths: ['custom-entity:silhouette'], maxSelected: 20 },
+        }, app, 'Gap');
+        expect(definition).toMatchObject({
+            identifier: '@vibeiq.com/gap-design-poc:line-builder',
+            appVersionId: 'version-1',
+            icon: 'line-builder',
+            appliesTo: { typePaths: ['custom-entity:silhouette'], maxSelected: 20 },
+            group: 'Gap',
+        });
+    });
+    it("should keep an extension's own group", () => {
+        expect((0, extensions_deployer_1.buildExtensionDefinition)({ identifier: 'x', name: 'X', group: 'Tools' }, app, 'Gap').group).toBe('Tools');
+    });
+});

package/dist/interfaces.d.ts

@@ -55,6 +55,42 @@ export interface ExtensionDefinitionDeclaration {
     modalDimensions?: any;
     display?: AppExtensionDisplayConfiguration;
     iframeUrl?: string;
+    /** A default icon's name, `{ material: <icon name> }`, or `{ url: <one-color SVG, absolute or beside iframeUrl> }`.
+     * An extension without an icon shows none. */
+    icon?: ExtensionIconDeclaration;
+    /** What the extension acts on. Apps offer it beside a selection it fits (Boards: the property bar's app row and the
+     * top of the context menu); without it, it is offered as before. */
+    appliesTo?: ExtensionAppliesToDeclaration;
+    /** The name the app's extensions are grouped under; defaults to appName. */
+    group?: string;
+}
+export type ExtensionIconDeclaration = string | {
+    material: string;
+} | {
+    url: string;
+};
+/** Which selected records a rule takes: by type path (with subtypes), exclusions, item role and how many. */
+export interface ExtensionSelectionRuleDeclaration {
+    /** Type paths, each matching itself and its subtypes: item:product matches item:product:footwear. */
+    typePaths?: string[];
+    /** Type paths left out, with their subtypes: item:material. */
+    excludeTypePaths?: string[];
+    /** Item roles a record must have: family, option. */
+    roles?: string[];
+    /** Fewest records: 1 for a target, 0 for an input, unless set. */
+    minSelected?: number;
+    maxSelected?: number;
+    /** What to select, for hints and summaries: "a Design or BOM", "colors". */
+    label?: string;
+}
+/**
+ * A selection is a target (what the action acts on) plus optional inputs that come along with it (colors to build
+ * in). Every selected record must fit the target or an input. The flat form, the rule's fields with no target, is a
+ * target with no inputs.
+ */
+export interface ExtensionAppliesToDeclaration extends ExtensionSelectionRuleDeclaration {
+    target?: ExtensionSelectionRuleDeclaration;
+    inputs?: ExtensionSelectionRuleDeclaration[];
 }
 export interface ConfigPropertyElements {
     [key: string]: ConfigPropertyElement;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.5.4",
+  "version": "3.5.5-alpha.177136f",
   "commands": {
     "app:create": {
       "id": "app:create",
@@ -672,6 +672,116 @@
         }
       }
     },
+    "feature-flags:export": {
+      "id": "feature-flags:export",
+      "description": "Export the enabled feature flags for your Org",
+      "strict": true,
+      "pluginName": "@contrail/cli",
+      "pluginAlias": "@contrail/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "$ contrail feature-flags export\n"
+      ],
+      "flags": {
+        "logLevel": {
+          "name": "logLevel",
+          "type": "option",
+          "char": "l",
+          "description": "The Log Level",
+          "required": false,
+          "multiple": false,
+          "options": [
+            "error",
+            "warn",
+            "info",
+            "debug"
+          ]
+        },
+        "alwaysConfirmEnv": {
+          "name": "alwaysConfirmEnv",
+          "type": "option",
+          "char": "e",
+          "description": "The Environment variables",
+          "required": false,
+          "multiple": false,
+          "options": [
+            "true",
+            "false"
+          ],
+          "default": "true"
+        },
+        "outDir": {
+          "name": "outDir",
+          "type": "option",
+          "char": "d",
+          "description": "The directory to which to export the feature flags. Defaults to the current directory",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        },
+        "overwrite": {
+          "name": "overwrite",
+          "type": "boolean",
+          "char": "f",
+          "description": "Replaces any existing export files in outDir",
+          "required": false,
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "feature-flags:import": {
+      "id": "feature-flags:import",
+      "description": "Upload an extracted set of feature flags",
+      "strict": true,
+      "pluginName": "@contrail/cli",
+      "pluginAlias": "@contrail/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "$ contrail feature-flags import\n"
+      ],
+      "flags": {
+        "logLevel": {
+          "name": "logLevel",
+          "type": "option",
+          "char": "l",
+          "description": "The Log Level",
+          "required": false,
+          "multiple": false,
+          "options": [
+            "error",
+            "warn",
+            "info",
+            "debug"
+          ]
+        },
+        "alwaysConfirmEnv": {
+          "name": "alwaysConfirmEnv",
+          "type": "option",
+          "char": "e",
+          "description": "The Environment variables",
+          "required": false,
+          "multiple": false,
+          "options": [
+            "true",
+            "false"
+          ],
+          "default": "true"
+        },
+        "dir": {
+          "name": "dir",
+          "type": "option",
+          "char": "d",
+          "description": "The directory from which to import the feature flags. Defaults to the current directory. The feature flags will be loaded from $dir/feature-flags.yml",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        }
+      },
+      "args": {}
+    },
     "file:upload": {
       "id": "file:upload",
       "description": "Uploads a file to the VibeIQ platform",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/cli",
-  "version": "3.5.4",
+  "version": "3.5.5-alpha.177136f",
   "description": "VibeIQ's Contrail Platform CLI.",
   "bin": {
     "contrail-cli": "./bin/run",
@@ -116,6 +116,9 @@
       "org-config": {
         "description": "Export and import org-level configuration"
       },
+      "feature-flags": {
+        "description": "Export and import the org's enabled feature flags"
+      },
       "webhooks": {
         "description": "Manage VibeIQ webhooks"
       },