@prismatic-io/spectral 9.1.1 → 9.1.3

package/dist/generators/componentManifest/createActions.js

@@ -48,7 +48,7 @@ const createActions = (_a) => __awaiter(void 0, [_a], void 0, function* ({ compo
                 typeInterface: (0, createTypeInterface_1.createTypeInterface)((_b = action.key) !== null && _b !== void 0 ? _b : actionKey),
                 import: (0, createImport_1.createImport)((_c = action.key) !== null && _c !== void 0 ? _c : actionKey),
                 key: action.key || actionKey,
-                label: action.display.description,
+                label: action.display.label,
                 description: action.display.description,
                 inputs,
             },

package/dist/generators/componentManifest/docBlock.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addPunctuation = exports.addLine = exports.DOC_BLOCK_DEFAULT = void 0;
+const escapeSpecialCharacters_1 = require("../utils/escapeSpecialCharacters");
 const DOC_BLOCK_DEFAULT = (input) => {
     const comments = (0, exports.addPunctuation)(input.comments);
     const onPrem = input.onPremControlled || input.onPremiseControlled
@@ -23,9 +24,9 @@ const addLine = ({ key, value, raw }) => {
     if (typeof value === "undefined" || value === null || value === "") {
         return "";
     }
-    const sanitizedValue = JSON.stringify(value)
+    const sanitizedValue = (0, escapeSpecialCharacters_1.escapeSpecialCharacters)(JSON.stringify(value)
         .replace(/(^"|"$)|(^'|'$)/g, "")
-        .trim();
+        .trim());
     return ` * ${key ? `@${key} ${sanitizedValue}` : sanitizedValue}\n`;
 };
 exports.addLine = addLine;

package/dist/generators/componentManifest/getInputs.js

@@ -1,12 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.INPUT_TYPE_MAP = exports.getInputs = void 0;
+const escapeSpecialCharacters_1 = require("../utils/escapeSpecialCharacters");
 const docBlock_1 = require("./docBlock");
 const getDefaultValue = (value) => {
-    if (value === undefined || value === "" || typeof value === "string") {
+    if (value === undefined || value === "") {
         return value;
     }
-    return JSON.stringify(value);
+    const stringValue = typeof value === "string" ? value : JSON.stringify(value);
+    return (0, escapeSpecialCharacters_1.escapeSpecialCharacters)(stringValue);
 };
 const getInputs = ({ inputs, docBlock = docBlock_1.DOC_BLOCK_DEFAULT }) => {
     return inputs.reduce((acc, input) => {

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

@@ -0,0 +1,7 @@
+/**
+ * This regex targets common characters that may be included in default
+ * input values (code comment blocks, backticks, etc) and would cause
+ * component-manifest build issues. More characters may be added
+ * as discovered.
+ */
+export declare const escapeSpecialCharacters: (value?: string) => string;

package/dist/generators/utils/escapeSpecialCharacters.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This regex targets common characters that may be included in default
+ * input values (code comment blocks, backticks, etc) and would cause
+ * component-manifest build issues. More characters may be added
+ * as discovered.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.escapeSpecialCharacters = void 0;
+const escapeRegEx = /(\/|\\|\`|\$)/g;
+const escapeSpecialCharacters = (value = "") => {
+    return value.replace(escapeRegEx, "\\$&");
+};
+exports.escapeSpecialCharacters = escapeSpecialCharacters;

package/dist/serverTypes/convertIntegration.d.ts

@@ -1,3 +1,6 @@
-import { IntegrationDefinition } from "../types";
+import { IntegrationDefinition, ConfigVar, ComponentRegistry } from "../types";
 import { Component as ServerComponent } from ".";
+import { RequiredConfigVariable as ServerRequiredConfigVariable } from "./integration";
 export declare const convertIntegration: (definition: IntegrationDefinition) => ServerComponent;
+/** Converts a Config Var into the structure necessary for YAML generation. */
+export declare const convertConfigVar: (key: string, configVar: ConfigVar, referenceKey: string, componentRegistry: ComponentRegistry) => ServerRequiredConfigVariable;

package/dist/serverTypes/convertIntegration.js

@@ -23,7 +23,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertIntegration = void 0;
+exports.convertConfigVar = exports.convertIntegration = void 0;
 const yaml_1 = __importDefault(require("yaml"));
 const uuid_1 = require("uuid");
 const lodash_1 = require("lodash");
@@ -99,7 +99,7 @@ const codeNativeIntegrationYaml = ({ name, description, category, documentation,
         documentation,
         version,
         labels,
-        requiredConfigVars: Object.entries(configVars || {}).map(([key, configVar]) => convertConfigVar(key, configVar, referenceKey, componentRegistry)),
+        requiredConfigVars: Object.entries(configVars || {}).map(([key, configVar]) => (0, exports.convertConfigVar)(key, configVar, referenceKey, componentRegistry)),
         endpointType,
         preprocessFlowName: hasPreprocessFlow ? preprocessFlows[0].name : undefined,
         externalCustomerIdField: fieldNameToReferenceInput(hasPreprocessFlow ? "onExecution" : "payload", preprocessFlowConfig === null || preprocessFlowConfig === void 0 ? void 0 : preprocessFlowConfig.externalCustomerIdField),
@@ -310,6 +310,7 @@ const convertInputValue = (value, collectionType) => {
 };
 /** Converts a Config Var into the structure necessary for YAML generation. */
 const convertConfigVar = (key, configVar, referenceKey, componentRegistry) => {
+    var _a;
     const { orgOnly, meta } = convertConfigVarPermissionAndVisibility((0, lodash_1.pick)(configVar, ["permissionAndVisibilityType", "visibleToOrgDeployer"]));
     if ((0, types_1.isConnectionDefinitionConfigVar)(configVar)) {
         const { stableKey, description } = (0, lodash_1.pick)(configVar, ["stableKey", "description"]);
@@ -327,10 +328,24 @@ const convertConfigVar = (key, configVar, referenceKey, componentRegistry) => {
                     return result;
                 }
                 const meta = convertInputPermissionAndVisibility((0, lodash_1.pick)(input, ["permissionAndVisibilityType", "visibleToOrgDeployer"]));
-                const defaultValue = input.collection ? [] : "";
+                const defaultValue = input.collection
+                    ? (input.default || []).map((defaultValue) => {
+                        if (typeof defaultValue === "string") {
+                            return {
+                                type: "value",
+                                value: defaultValue,
+                            };
+                        }
+                        return {
+                            name: defaultValue.key,
+                            type: "value",
+                            value: defaultValue.value,
+                        };
+                    })
+                    : input.default || "";
                 return Object.assign(Object.assign({}, result), { [key]: {
                         type: input.collection ? "complex" : "value",
-                        value: input.default || defaultValue,
+                        value: defaultValue,
                         meta,
                     } });
             }, {}),
@@ -373,6 +388,9 @@ const convertConfigVar = (key, configVar, referenceKey, componentRegistry) => {
     if ((0, types_1.isScheduleConfigVar)(configVar)) {
         result.scheduleType = "custom";
     }
+    if ((0, types_1.isJsonFormConfigVar)(configVar) || (0, types_1.isJsonFormDataSourceConfigVar)(configVar)) {
+        result.meta = Object.assign(Object.assign({}, result.meta), { validationMode: (_a = configVar === null || configVar === void 0 ? void 0 : configVar.validationMode) !== null && _a !== void 0 ? _a : "ValidateAndShow" });
+    }
     if ((0, types_1.isDataSourceDefinitionConfigVar)(configVar)) {
         result.dataType = configVar.dataSourceType;
         result.dataSource = {
@@ -385,9 +403,13 @@ const convertConfigVar = (key, configVar, referenceKey, componentRegistry) => {
         result.dataType = componentRegistry[ref.component.key].dataSources[ref.key].dataSourceType;
         result.dataSource = ref;
         result.inputs = inputs;
+        if (configVar.validationMode) {
+            result.meta = Object.assign(Object.assign({}, result.meta), { validationMode: configVar.validationMode });
+        }
     }
     return result;
 };
+exports.convertConfigVar = convertConfigVar;
 /** Maps the step name field to a fully qualified input. */
 const fieldNameToReferenceInput = (stepName, fieldName) => fieldName ? { type: "reference", value: `${stepName}.results.${fieldName}` } : undefined;
 /** Actions and Triggers will be scoped to their flow by combining the flow

package/dist/types/ConfigVars.d.ts

@@ -1,3 +1,4 @@
+import { ValidationMode } from "@jsonforms/core";
 import { type DataSourceDefinition, type ConnectionDefinition, type Inputs, type DataSourceType, type Connection, type JSONForm, type ObjectFieldMap, type ObjectSelection, type ConfigVarResultCollection, type Schedule, type CollectionDataSourceType, type DataSourceReference, type ConfigPage, type ConfigPages, type ConfigPageElement, type ComponentRegistryDataSource, type ComponentRegistryConnection, type UserLevelConfigPages } from ".";
 import type { Prettify, UnionToIntersection } from "./utils";
 /** Supported data types for Config Vars. */
@@ -105,12 +106,22 @@ type ScheduleConfigVar = CreateStandardConfigVar<"schedule"> & {
 };
 type ObjectSelectionConfigVar = CreateStandardConfigVar<"objectSelection">;
 type ObjectFieldMapConfigVar = CreateStandardConfigVar<"objectFieldMap">;
-type JsonFormConfigVar = CreateStandardConfigVar<"jsonForm">;
+type JsonFormConfigVar = CreateStandardConfigVar<"jsonForm"> & {
+    validationMode?: ValidationMode;
+};
+type JsonFormDataSourceDefinitionConfigVar = DataSourceDefinitionConfigVar & {
+    validationMode?: ValidationMode;
+};
 export type StandardConfigVar = StringConfigVar | DateConfigVar | TimestampConfigVar | PicklistConfigVar | CodeConfigVar | BooleanConfigVar | NumberConfigVar | ScheduleConfigVar | ObjectSelectionConfigVar | ObjectFieldMapConfigVar | JsonFormConfigVar;
 type BaseDataSourceConfigVar<TDataSourceType extends DataSourceType = DataSourceType> = TDataSourceType extends CollectionDataSourceType ? {
     dataSourceType: TDataSourceType;
     collectionType?: CollectionType | undefined;
-} & BaseConfigVar : TDataSourceType extends Exclude<DataSourceType, CollectionDataSourceType> ? BaseConfigVar & {
+} & BaseConfigVar : TDataSourceType extends Exclude<DataSourceType, CollectionDataSourceType> ? TDataSourceType extends Extract<DataSourceType, "jsonForm"> ? BaseConfigVar & {
+    dataSourceType: Extract<DataSourceType, "jsonForm">;
+    dataSource?: never;
+    collectionType?: undefined;
+    validationMode?: ValidationMode;
+} : BaseConfigVar & {
     dataSourceType: TDataSourceType;
     collectionType?: undefined;
 } : ({
@@ -123,6 +134,7 @@ type BaseDataSourceConfigVar<TDataSourceType extends DataSourceType = DataSource
 type DataSourceDefinitionConfigVar = DataSourceType extends infer TDataSourceType ? TDataSourceType extends DataSourceType ? BaseDataSourceConfigVar<TDataSourceType> & Omit<DataSourceDefinition<Inputs, ConfigVarResultCollection, TDataSourceType>, "display" | "inputs" | "examplePayload" | "detailDataSource"> : never : never;
 type DataSourceReferenceConfigVar = ComponentRegistryDataSource extends infer TDataSourceReference extends ComponentRegistryDataSource ? Omit<BaseDataSourceConfigVar<TDataSourceReference["dataSourceType"]>, "dataSourceType"> & {
     dataSource: TDataSourceReference["reference"];
+    validationMode?: ValidationMode;
 } : never;
 /** Defines attributes of a data source Config Var. */
 export type DataSourceConfigVar = DataSourceDefinitionConfigVar | DataSourceReferenceConfigVar;
@@ -165,6 +177,8 @@ type ExtractConfigVars<TConfigPages extends {
 export type ConfigVars = Prettify<UnionToIntersection<ExtractConfigVars<ConfigPages>>> & Prettify<UnionToIntersection<ExtractConfigVars<UserLevelConfigPages>>>;
 export declare const isCodeConfigVar: (cv: ConfigVar) => cv is CodeConfigVar;
 export declare const isScheduleConfigVar: (cv: ConfigVar) => cv is ScheduleConfigVar;
+export declare const isJsonFormConfigVar: (cv: ConfigVar) => cv is JsonFormConfigVar;
+export declare const isJsonFormDataSourceConfigVar: (cv: ConfigVar) => cv is JsonFormDataSourceDefinitionConfigVar;
 export declare const isDataSourceDefinitionConfigVar: (cv: ConfigVar) => cv is DataSourceDefinitionConfigVar;
 export declare const isDataSourceReferenceConfigVar: (cv: unknown) => cv is DataSourceReferenceConfigVar;
 export declare const isConnectionDefinitionConfigVar: (cv: ConfigVar) => cv is ConnectionDefinitionConfigVar;

package/dist/types/ConfigVars.js

@@ -1,11 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isConnectionReferenceConfigVar = exports.isConnectionDefinitionConfigVar = exports.isDataSourceReferenceConfigVar = exports.isDataSourceDefinitionConfigVar = exports.isScheduleConfigVar = exports.isCodeConfigVar = void 0;
+exports.isConnectionReferenceConfigVar = exports.isConnectionDefinitionConfigVar = exports.isDataSourceReferenceConfigVar = exports.isDataSourceDefinitionConfigVar = exports.isJsonFormDataSourceConfigVar = exports.isJsonFormConfigVar = exports.isScheduleConfigVar = exports.isCodeConfigVar = void 0;
 const _1 = require(".");
 const isCodeConfigVar = (cv) => "dataType" in cv && cv.dataType === "code";
 exports.isCodeConfigVar = isCodeConfigVar;
 const isScheduleConfigVar = (cv) => "dataType" in cv && cv.dataType === "schedule";
 exports.isScheduleConfigVar = isScheduleConfigVar;
+const isJsonFormConfigVar = (cv) => "dataType" in cv && cv.dataType === "jsonForm";
+exports.isJsonFormConfigVar = isJsonFormConfigVar;
+const isJsonFormDataSourceConfigVar = (cv) => "dataSourceType" in cv && cv.dataSourceType === "jsonForm";
+exports.isJsonFormDataSourceConfigVar = isJsonFormDataSourceConfigVar;
 const isDataSourceDefinitionConfigVar = (cv) => "dataSourceType" in cv && "perform" in cv && typeof cv.perform === "function";
 exports.isDataSourceDefinitionConfigVar = isDataSourceDefinitionConfigVar;
 const isDataSourceReferenceConfigVar = (

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "9.1.1",
+  "version": "9.1.3",
   "description": "Utility library for building Prismatic components",
   "keywords": ["prismatic"],
   "main": "dist/index.js",