@prismatic-io/spectral 9.0.0-rc.7 → 9.0.0-rc.9

package/dist/generators/componentManifest/cli.js

@@ -26,26 +26,7 @@ const runMain = (process) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b;
     const componentDir = process.cwd();
     const componentDistDir = path_1.default.join(componentDir, "dist", "index.js");
-    if (!componentDir) {
-        console.error("Please run this script using npm or yarn.");
-        process.exit(1);
-    }
-    if (!(0, fs_extra_1.existsSync)(componentDistDir)) {
-        console.error("Component build directory `dist` does not exist. Please verify that the component has been built.");
-        process.exit(1);
-    }
-    const component = require(componentDistDir).default;
-    if (!component ||
-        !(0, util_1.isObjectWithTruthyKeys)(component, ["key", "display"]) ||
-        !(0, util_1.isObjectWithOneTruthyKey)(component, [
-            "actions",
-            "connections",
-            "dataSources",
-        ])) {
-        console.error("Component is invalid.");
-        process.exit(1);
-    }
-    const args = process.argv.slice(3);
+    const args = process.argv.slice(2);
     const flags = {
         name: {
             flag: ["--name", "-n"],
@@ -111,6 +92,25 @@ const runMain = (process) => __awaiter(void 0, void 0, void 0, function* () {
         });
         process.exit(0);
     }
+    if (!componentDir) {
+        console.error("Please run this script using npm or yarn.");
+        process.exit(1);
+    }
+    if (!(0, fs_extra_1.existsSync)(componentDistDir)) {
+        console.error("Component build directory `dist` does not exist. Please verify that the component has been built.");
+        process.exit(1);
+    }
+    const component = require(componentDistDir).default;
+    if (!component ||
+        !(0, util_1.isObjectWithTruthyKeys)(component, ["key", "display"]) ||
+        !(0, util_1.isObjectWithOneTruthyKey)(component, [
+            "actions",
+            "connections",
+            "dataSources",
+        ])) {
+        console.error("Component is invalid.");
+        process.exit(1);
+    }
     const packageJson = (0, fs_extra_1.readJsonSync)(path_1.default.join(__dirname, "../../../package.json"));
     yield (0, index_1.createComponentManifest)({
         component,

package/dist/generators/componentManifest/createActions.d.ts

@@ -1,4 +1,4 @@
-import { Component } from "../../serverTypes";
+import type { Component } from "../../serverTypes";
 interface CreateActionsProps {
     component: Component;
     dryRun: boolean;

package/dist/generators/componentManifest/createActions.js

@@ -18,11 +18,19 @@ const getInputs_1 = require("./getInputs");
 const getImports_1 = require("./getImports");
 const helpers_1 = require("./helpers");
 const createTemplate_1 = require("../utils/createTemplate");
-const DOCUMENT_PROPERTIES = [
-    "comments",
-    "default",
-    "example",
-    "placeholder",
+const DOC_BLOCK = [
+    {
+        propertyKey: "comments",
+    },
+    {
+        propertyKey: "default",
+    },
+    {
+        propertyKey: "example",
+    },
+    {
+        propertyKey: "placeholder",
+    },
 ];
 const createActions = ({ component, dryRun, verbose, sourceDir, destinationDir, }) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b;
@@ -43,7 +51,7 @@ const createActions = ({ component, dryRun, verbose, sourceDir, destinationDir,
     const actions = yield Promise.all(Object.entries((_b = component.actions) !== null && _b !== void 0 ? _b : {}).map(([actionKey, action]) => __awaiter(void 0, void 0, void 0, function* () {
         const inputs = (0, getInputs_1.getInputs)({
             inputs: action.inputs,
-            documentProperties: DOCUMENT_PROPERTIES,
+            docBlock: DOC_BLOCK,
         });
         const imports = (0, getImports_1.getImports)({ inputs });
         return yield renderAction({

package/dist/generators/componentManifest/createConnections.d.ts

@@ -1,4 +1,4 @@
-import { Component } from "../../serverTypes";
+import type { Component } from "../../serverTypes";
 interface CreateConnectionsProps {
     component: Component;
     dryRun: boolean;

package/dist/generators/componentManifest/createConnections.js

@@ -18,11 +18,29 @@ const getInputs_1 = require("./getInputs");
 const getImports_1 = require("./getImports");
 const helpers_1 = require("./helpers");
 const createTemplate_1 = require("../utils/createTemplate");
-const DOCUMENT_PROPERTIES = [
-    "comments",
-    "default",
-    "example",
-    "placeholder",
+const DOC_BLOCK = [
+    {
+        propertyKey: "comments",
+    },
+    {
+        propertyKey: "default",
+    },
+    {
+        propertyKey: "example",
+    },
+    {
+        propertyKey: "placeholder",
+    },
+    {
+        propertyKey: "onPremControlled",
+        propertyValue: true,
+        output: "This input will be supplied when using an on prem resource.",
+    },
+    {
+        propertyKey: "onPremiseControlled",
+        propertyValue: true,
+        output: "This input will be supplied when using an on prem resource.",
+    },
 ];
 const createConnections = ({ component, dryRun, verbose, sourceDir, destinationDir, }) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b;
@@ -43,15 +61,17 @@ const createConnections = ({ component, dryRun, verbose, sourceDir, destinationD
     const connections = yield Promise.all(((_b = component.connections) !== null && _b !== void 0 ? _b : []).map((connection) => __awaiter(void 0, void 0, void 0, function* () {
         const inputs = (0, getInputs_1.getInputs)({
             inputs: connection.inputs,
-            documentProperties: DOCUMENT_PROPERTIES,
+            docBlock: DOC_BLOCK,
         });
         const imports = (0, getImports_1.getImports)({ inputs });
+        const onPremAvailable = connection.inputs.some((input) => input.onPremControlled || input.onPremiseControlled);
         return yield renderConnection({
             connection: {
                 key: connection.key,
                 label: connection.label,
                 comments: connection.comments,
                 inputs,
+                onPremAvailable,
             },
             imports,
             dryRun,

package/dist/generators/componentManifest/createDataSources.d.ts

@@ -1,4 +1,4 @@
-import { Component } from "../../serverTypes";
+import type { Component } from "../../serverTypes";
 interface CreateDataSourcesProps {
     component: Component;
     dryRun: boolean;

package/dist/generators/componentManifest/createDataSources.js

@@ -18,11 +18,19 @@ const getInputs_1 = require("./getInputs");
 const getImports_1 = require("./getImports");
 const helpers_1 = require("./helpers");
 const createTemplate_1 = require("../utils/createTemplate");
-const DOCUMENT_PROPERTIES = [
-    "comments",
-    "default",
-    "example",
-    "placeholder",
+const DOC_BLOCK = [
+    {
+        propertyKey: "comments",
+    },
+    {
+        propertyKey: "default",
+    },
+    {
+        propertyKey: "example",
+    },
+    {
+        propertyKey: "placeholder",
+    },
 ];
 const createDataSources = ({ component, dryRun, verbose, sourceDir, destinationDir, }) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b;
@@ -43,7 +51,7 @@ const createDataSources = ({ component, dryRun, verbose, sourceDir, destinationD
     const dataSources = yield Promise.all(Object.entries((_b = component.dataSources) !== null && _b !== void 0 ? _b : {}).map(([dataSourceKey, dataSource]) => __awaiter(void 0, void 0, void 0, function* () {
         const inputs = (0, getInputs_1.getInputs)({
             inputs: dataSource.inputs,
-            documentProperties: DOCUMENT_PROPERTIES,
+            docBlock: DOC_BLOCK,
         });
         const imports = (0, getImports_1.getImports)({ inputs });
         return yield renderDataSource({

package/dist/generators/componentManifest/createStaticFiles.d.ts

@@ -1,4 +1,4 @@
-import { Component } from "../../serverTypes";
+import type { Component } from "../../serverTypes";
 export interface PackageDependencies {
     spectral: string;
     dependencies: Record<string, string>;

package/dist/generators/componentManifest/createTriggers.d.ts

@@ -1,4 +1,4 @@
-import { Component } from "../../serverTypes";
+import type { Component } from "../../serverTypes";
 interface CreateTriggersProps {
     component: Component;
     dryRun: boolean;

package/dist/generators/componentManifest/createTriggers.js

@@ -18,11 +18,19 @@ const getInputs_1 = require("./getInputs");
 const getImports_1 = require("./getImports");
 const helpers_1 = require("./helpers");
 const createTemplate_1 = require("../utils/createTemplate");
-const DOCUMENT_PROPERTIES = [
-    "comments",
-    "default",
-    "example",
-    "placeholder",
+const DOC_BLOCK = [
+    {
+        propertyKey: "comments",
+    },
+    {
+        propertyKey: "default",
+    },
+    {
+        propertyKey: "example",
+    },
+    {
+        propertyKey: "placeholder",
+    },
 ];
 const createTriggers = ({ component, dryRun, verbose, sourceDir, destinationDir, }) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b;
@@ -43,7 +51,7 @@ const createTriggers = ({ component, dryRun, verbose, sourceDir, destinationDir,
     const triggers = yield Promise.all(Object.entries((_b = component.triggers) !== null && _b !== void 0 ? _b : {}).map(([triggerKey, trigger]) => __awaiter(void 0, void 0, void 0, function* () {
         const inputs = (0, getInputs_1.getInputs)({
             inputs: trigger.inputs,
-            documentProperties: DOCUMENT_PROPERTIES,
+            docBlock: DOC_BLOCK,
         });
         const imports = (0, getImports_1.getImports)({ inputs });
         return yield renderTrigger({

package/dist/generators/componentManifest/getImports.d.ts

@@ -1,4 +1,4 @@
-import { Input } from "./getInputs";
+import type { Input } from "./getInputs";
 export declare type Imports = Record<string, string[]>;
 interface GetImportsProps {
     inputs: Input[];

package/dist/generators/componentManifest/getImports.js

@@ -3,14 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getImports = void 0;
 const getImports = ({ inputs }) => {
     return inputs.reduce((acc, input) => {
-        if (typeof input.type === "string") {
+        if (typeof input.valueType === "string") {
             return acc;
         }
-        return Object.assign(Object.assign({}, acc), { [input.type.module]: acc[input.type.module]
-                ? !acc[input.type.module].includes(input.type.type)
-                    ? [...acc[input.type.module], input.type.type]
-                    : acc[input.type.module]
-                : [input.type.type] });
+        return Object.assign(Object.assign({}, acc), { [input.valueType.module]: acc[input.valueType.module]
+                ? !acc[input.valueType.module].includes(input.valueType.type)
+                    ? [...acc[input.valueType.module], input.valueType.type]
+                    : acc[input.valueType.module]
+                : [input.valueType.type] });
     }, {});
 };
 exports.getImports = getImports;

package/dist/generators/componentManifest/getInputs.d.ts

@@ -1,23 +1,33 @@
-import { Input as ServerTypeInput } from "../../serverTypes";
-import { InputFieldDefinition } from "../../types/Inputs";
+import type { Input as InputBase } from "../../serverTypes";
+import type { InputFieldDefinition } from "../../types/Inputs";
+declare type ServerTypeInput = InputBase & {
+    onPremControlled?: boolean;
+};
 export interface Input {
     key: string;
     label: string;
-    type: InputType;
+    inputType: string;
+    valueType: ValueType;
     required: boolean | undefined;
     properties: {
         key: keyof ServerTypeInput;
         value: string;
     }[];
 }
-export declare type InputType = string | {
+export declare type ValueType = string | {
     type: string;
     module: string;
 };
+export declare type DocBlock = {
+    inputKey?: string;
+    propertyKey: keyof ServerTypeInput;
+    propertyValue?: unknown;
+    output?: string;
+}[];
 interface GetInputsProps {
     inputs: ServerTypeInput[];
-    documentProperties: (keyof ServerTypeInput)[];
+    docBlock: DocBlock;
 }
-export declare const getInputs: ({ inputs, documentProperties, }: GetInputsProps) => Input[];
-export declare const INPUT_TYPE_MAP: Record<InputFieldDefinition["type"], InputType>;
+export declare const getInputs: ({ inputs, docBlock }: GetInputsProps) => Input[];
+export declare const INPUT_TYPE_MAP: Record<InputFieldDefinition["type"], ValueType>;
 export {};

package/dist/generators/componentManifest/getInputs.js

@@ -1,29 +1,45 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.INPUT_TYPE_MAP = exports.getInputs = void 0;
-const getInputs = ({ inputs, documentProperties, }) => {
+const getInputs = ({ inputs, docBlock }) => {
     return inputs.map((input) => {
         return {
             key: input.key,
             label: input.label,
-            type: getInputType(input),
+            inputType: input.type,
+            valueType: getInputValueType(input),
             required: input.required,
             collection: input.collection,
-            inputType: input.type,
-            properties: documentProperties.reduce((acc, key) => {
-                const value = input[key]
-                    ? JSON.stringify(input[key])
-                        .replace(/(^"|"$)|(^'|'$)/g, "")
-                        .trim()
-                    : null;
-                if (typeof value === "undefined" || value === null || value === "") {
+            onPremControlled: input.onPremiseControlled || input.onPremControlled,
+            properties: docBlock.reduce((acc, { propertyKey, inputKey, propertyValue, output }) => {
+                if (inputKey && inputKey !== input.key) {
+                    return acc;
+                }
+                if (output &&
+                    (input[propertyKey] === propertyValue ||
+                        typeof propertyValue === "undefined")) {
+                    return [
+                        ...acc,
+                        {
+                            key: propertyKey,
+                            value: output,
+                        },
+                    ];
+                }
+                if (typeof input[propertyKey] === "undefined" ||
+                    input[propertyKey] === null ||
+                    input[propertyKey] === "" ||
+                    (typeof propertyValue !== "undefined" &&
+                        input[propertyKey] !== propertyValue)) {
                     return acc;
                 }
                 return [
                     ...acc,
                     {
-                        key,
-                        value,
+                        key: propertyKey,
+                        value: JSON.stringify(input[propertyKey])
+                            .replace(/(^"|"$)|(^'|'$)/g, "")
+                            .trim(),
                     },
                 ];
             }, []),
@@ -61,12 +77,12 @@ exports.INPUT_TYPE_MAP = {
     dynamicObjectSelection: "string",
     dynamicFieldSelection: "string",
 };
-const getInputType = (input) => {
+const getInputValueType = (input) => {
     const valueType = input.model
         ? input.model.map((choice) => `"${choice.value}"`).join(" | ")
         : exports.INPUT_TYPE_MAP[input.type] || "never";
     if (input.collection === "keyvaluelist") {
-        return `Record<string, ${valueType}>`;
+        return `Record<string, ${valueType}> | Array<{key: string, value: ${valueType}}>`;
     }
     if (input.collection === "valuelist") {
         return `${valueType}[]`;

package/dist/generators/componentManifest/index.d.ts

@@ -1,5 +1,5 @@
-import { PackageDependencies } from "./createStaticFiles";
-import { Component } from "../../serverTypes";
+import { type PackageDependencies } from "./createStaticFiles";
+import type { Component } from "../../serverTypes";
 interface CreateComponentManifestProps {
     component: Component;
     dryRun: boolean;

package/dist/generators/componentManifest/removeComponentManifest.js

@@ -1,13 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.removeComponentManifest = void 0;
-const fs_extra_1 = require("fs-extra");
+const fs_1 = require("fs");
 const removeComponentManifest = ({ destinationDir, verbose, }) => {
     if (verbose) {
         console.info("Removing existing component manifest files...");
     }
     try {
-        (0, fs_extra_1.removeSync)(destinationDir);
+        if ((0, fs_1.existsSync)(destinationDir)) {
+            (0, fs_1.rmSync)(destinationDir, { recursive: true, force: true });
+        }
     }
     catch (err) {
         console.error(err);

package/dist/generators/componentManifest/templates/connections/connection.ts.ejs

@@ -13,6 +13,9 @@ export const <%= connection.key %> = {
   perform: (
     _values: <%= helpers.capitalizeFirstLetter(connection.key) %>Values
   ): Promise<void> => Promise.resolve(),
+  <%_ if (connection.onPremAvailable) { -%>
+  onPremAvailable: true,
+  <%_ } -%>
   inputs: {
     <%- include('../partials/inputs.ejs', { inputs: connection.inputs }) -%>
   }

package/dist/generators/componentManifest/templates/partials/inputs.ejs

@@ -1,6 +1,7 @@
 <% inputs.forEach((input) => { -%>
   <%= input.key %>: {
-    inputType: "<%= input.defaultType %>",
+    valueType: "<%- input.valueType.type ? input.valueType.type : input.valueType %>",
+    inputType: "<%= input.inputType %>",
     <%_ if (input.collection) { -%>
     collection: "<%= input.collection %>" as const,
     <%_ } else { -%>
@@ -12,8 +13,8 @@
     <%_ if (input.required) { -%>
     required: <%= input.required %>,
     <%_ } -%>
-    <%_ if (typeof input.onPremiseControlled !== "undefined") { -%>
-    onPremiseControlled: <%= input.onPremiseControlled %>,
+    <%_ if (typeof input.onPremControlled !== "undefined") { -%>
+    onPremControlled: <%= input.onPremControlled %>,
     <%_ } -%>
   },
 <% }); -%>

package/dist/generators/componentManifest/templates/partials/performArgs.ejs

@@ -6,5 +6,5 @@
    * @<%= property.key %> <%- property.value %>
    <%_ }); -%>
    */
-  <%= input.key %><%= input.required ? "" : "?" %>: <%- input.type.type ? input.type.type : input.type %>;
+  <%= input.key %><%= input.required ? "" : "?" %>: <%- input.valueType.type ? input.valueType.type : input.valueType %>;
 <% }); -%>

package/dist/generators/utils/createDependencyImports.d.ts

@@ -1,4 +1,4 @@
-import { Imports } from "../componentManifest/getImports";
+import type { Imports } from "../componentManifest/getImports";
 export interface CreateDependencyImportsProps {
     imports: Imports;
 }

package/dist/serverTypes/convertIntegration.js

@@ -160,16 +160,17 @@ const convertConfigVarPermissionAndVisibility = ({ permissionAndVisibilityType,
     };
 };
 const convertComponentReference = (componentReference, componentRegistry) => {
-    var _a, _b, _c;
+    var _a, _b;
+    const manifest = componentRegistry[componentReference.component];
     const ref = {
         component: {
-            key: componentReference.component,
-            signature: (_b = (_a = componentRegistry[componentReference.component]) === null || _a === void 0 ? void 0 : _a.signature) !== null && _b !== void 0 ? _b : "",
-            isPublic: componentReference.isPublic,
+            key: manifest.key,
+            signature: (_a = manifest.signature) !== null && _a !== void 0 ? _a : "",
+            isPublic: manifest.public,
         },
         key: componentReference.key,
     };
-    const inputs = Object.entries((_c = componentReference.values) !== null && _c !== void 0 ? _c : {}).reduce((result, [key, value]) => {
+    const inputs = Object.entries((_b = componentReference.values) !== null && _b !== void 0 ? _b : {}).reduce((result, [key, value]) => {
         if ("value" in value) {
             const type = value.value instanceof Object ? "complex" : "value";
             const valueExpr = value.value instanceof Object && !Array.isArray(value.value)
@@ -387,6 +388,13 @@ const convertOnExecution = (onExecution, componentRegistry) => (context, params)
                 // Transform the input values based on the action's inputs
                 const transformedValues = Object.entries(values).reduce((transformedAccumulator, [inputKey, inputValue]) => {
                     const { collection } = action.inputs[inputKey];
+                    if (collection === "keyvaluelist" &&
+                        Array.isArray(inputValue)) {
+                        transformedAccumulator[inputKey] = inputValue.reduce((acc, { key, value }) => {
+                            return [...acc, { key, value }];
+                        }, []);
+                        return transformedAccumulator;
+                    }
                     // Transform key-value list inputs
                     if (collection === "keyvaluelist" &&
                         Object.keys(inputValue).length) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "9.0.0-rc.7",
+  "version": "9.0.0-rc.9",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"