@prismatic-io/spectral 8.1.5 → 8.1.7

package/dist/index.d.ts

@@ -3,7 +3,7 @@
  * authors create inputs, actions, and components that can
  * be processed by the Prismatic API.
  */
-import { ActionDefinition, InputFieldDefinition, ComponentDefinition, DefaultConnectionDefinition, OAuth2ConnectionDefinition, Inputs, TriggerDefinition, ActionPerformReturn, TriggerResult, DataSourceDefinition, IntegrationDefinition, Flow, ConfigPage, StandardConfigVar, ConnectionConfigVar, ConfigVarResultCollection, TriggerPayload, DataSourceConfigVar, ConfigPages, OnPremiseConnectionDefinition, ScheduleConfigVar, ComponentSelector } from "./types";
+import { ActionDefinition, InputFieldDefinition, ComponentDefinition, DefaultConnectionDefinition, OAuth2ConnectionDefinition, Inputs, TriggerDefinition, ActionPerformReturn, TriggerResult, DataSourceDefinition, IntegrationDefinition, Flow, ConfigPage, StandardConfigVar, ConnectionConfigVar, ConfigVarResultCollection, TriggerPayload, DataSourceConfigVar, ConfigPages, OnPremConnectionDefinition, ScheduleConfigVar, ComponentSelector } from "./types";
 import { convertComponent } from "./serverTypes/convert";
 import { convertIntegration } from "./serverTypes/convertIntegration";
 /**
@@ -128,10 +128,10 @@ export declare const connection: <T extends DefaultConnectionDefinition>(definit
 /**
  * For information on writing custom component connections using on-premise resources, see
  * https://prismatic.io/docs/custom-components/writing-custom-components/#adding-connections.
- * @param definition An OnPremiseConnectionDefinition object that describes the type of a connection for a custom component action or trigger, and information on how it should be displayed in the Prismatic WebApp.
+ * @param definition An OnPremConnectionDefinition object that describes the type of a connection for a custom component action or trigger, and information on how it should be displayed in the Prismatic WebApp.
  * @returns This function validates the shape of the `definition` object provided and returns the same connection object.
  */
-export declare const onPremiseConnection: <T extends OnPremiseConnectionDefinition>(definition: T) => T;
+export declare const onPremConnection: <T extends OnPremConnectionDefinition>(definition: T) => T;
 /**
  * For information on writing custom component connections, see
  * https://prismatic.io/docs/custom-components/writing-custom-components/#adding-connections.

package/dist/index.js

@@ -22,7 +22,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.testing = exports.util = exports.oauth2Connection = exports.onPremiseConnection = exports.connection = exports.input = exports.dataSource = exports.trigger = exports.action = exports.component = exports.connectionConfigVar = exports.dataSourceConfigVar = exports.configVar = exports.reference = exports.configPage = exports.flow = exports.integration = void 0;
+exports.testing = exports.util = exports.oauth2Connection = exports.onPremConnection = exports.connection = exports.input = exports.dataSource = exports.trigger = exports.action = exports.component = exports.connectionConfigVar = exports.dataSourceConfigVar = exports.configVar = exports.reference = exports.configPage = exports.flow = exports.integration = void 0;
 const convert_1 = require("./serverTypes/convert");
 const convertIntegration_1 = require("./serverTypes/convertIntegration");
 /**
@@ -153,11 +153,11 @@ exports.connection = connection;
 /**
  * For information on writing custom component connections using on-premise resources, see
  * https://prismatic.io/docs/custom-components/writing-custom-components/#adding-connections.
- * @param definition An OnPremiseConnectionDefinition object that describes the type of a connection for a custom component action or trigger, and information on how it should be displayed in the Prismatic WebApp.
+ * @param definition An OnPremConnectionDefinition object that describes the type of a connection for a custom component action or trigger, and information on how it should be displayed in the Prismatic WebApp.
  * @returns This function validates the shape of the `definition` object provided and returns the same connection object.
  */
-const onPremiseConnection = (definition) => definition;
-exports.onPremiseConnection = onPremiseConnection;
+const onPremConnection = (definition) => definition;
+exports.onPremConnection = onPremConnection;
 /**
  * For information on writing custom component connections, see
  * https://prismatic.io/docs/custom-components/writing-custom-components/#adding-connections.

package/dist/serverTypes/convert.d.ts

@@ -1,4 +1,4 @@
-import { InputFieldDefinition, ComponentDefinition } from "../types";
+import { InputFieldDefinition, ComponentDefinition, OnPremConnectionInput } from "../types";
 import { Component as ServerComponent, Input as ServerInput } from ".";
-export declare const convertInput: (key: string, { default: defaultValue, type, label, collection, ...rest }: InputFieldDefinition) => ServerInput;
+export declare const convertInput: (key: string, { default: defaultValue, type, label, collection, ...rest }: InputFieldDefinition | OnPremConnectionInput) => ServerInput;
 export declare const convertComponent: <TPublic extends boolean, TKey extends string>({ connections, actions, triggers, dataSources, hooks, ...definition }: ComponentDefinition<TPublic, TKey>) => ServerComponent;

package/dist/serverTypes/convert.js

@@ -14,13 +14,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertComponent = exports.convertInput = void 0;
 const types_1 = require("../types");
 const perform_1 = require("./perform");
+const lodash_1 = require("lodash");
 const convertInput = (key, _a) => {
     var { default: defaultValue, type, label, collection } = _a, rest = __rest(_a, ["default", "type", "label", "collection"]);
     const keyLabel = collection === "keyvaluelist" && typeof label === "object"
         ? label.key
         : undefined;
-    return Object.assign(Object.assign({}, rest), { key,
-        type, default: defaultValue !== null && defaultValue !== void 0 ? defaultValue : types_1.InputFieldDefaultMap[type], collection, label: typeof label === "string" ? label : label.value, keyLabel });
+    return Object.assign(Object.assign({}, (0, lodash_1.omit)(rest, ["onPremControlled"])), { key,
+        type, default: defaultValue !== null && defaultValue !== void 0 ? defaultValue : types_1.InputFieldDefaultMap[type], collection, label: typeof label === "string" ? label : label.value, keyLabel, onPremiseControlled: ("onPremControlled" in rest && rest.onPremControlled) || undefined });
 };
 exports.convertInput = convertInput;
 const convertAction = (actionKey, _a, hooks) => {

package/dist/serverTypes/convertIntegration.js

@@ -93,7 +93,15 @@ const convertComponentReference = ({ key, component: componentRef, values, }) =>
         };
     const inputs = Object.entries(values !== null && values !== void 0 ? values : {}).reduce((result, [key, value]) => {
         if ("value" in value) {
-            return Object.assign(Object.assign({}, result), { [key]: { type: "value", value: value.value } });
+            const type = value.value instanceof Object ? "complex" : "value";
+            const valueExpr = value.value instanceof Object && !Array.isArray(value.value)
+                ? Object.entries(value.value).map(([k, v]) => ({
+                    name: { type: "value", value: k },
+                    type: "value",
+                    value: v,
+                }))
+                : value.value;
+            return Object.assign(Object.assign({}, result), { [key]: { type: type, value: valueExpr } });
         }
         if ("configVar" in value) {
             return Object.assign(Object.assign({}, result), { [key]: { type: "configVar", value: value.configVar } });
@@ -185,12 +193,11 @@ const convertConfigVar = (key, configVar, referenceKey) => {
                 if (input.shown === false) {
                     return result;
                 }
-                const value = input.default
-                    ? input.default
-                    : input.collection
-                        ? []
-                        : "";
-                return Object.assign(Object.assign({}, result), { [key]: { type: "value", value } });
+                const defaultValue = input.collection ? [] : "";
+                return Object.assign(Object.assign({}, result), { [key]: {
+                        type: input.collection ? "complex" : "value",
+                        value: input.default || defaultValue,
+                    } });
             }, {}), meta });
     }
     if ((0, types_1.isConnectionReferenceConfigVar)(configVar)) {

package/dist/serverTypes/index.d.ts

@@ -174,7 +174,7 @@ export interface Connection {
     iconPath?: string;
     inputs: (Input & {
         shown?: boolean;
-        onPremiseControlled?: boolean;
+        onPremControlled?: boolean;
     })[];
 }
 export interface ConnectionValue {
@@ -235,4 +235,5 @@ export interface Input {
     required?: boolean;
     model?: InputFieldChoice[];
     language?: string;
+    onPremiseControlled?: boolean;
 }

package/dist/serverTypes/integration.d.ts

@@ -9,12 +9,12 @@ export interface ComponentReference {
     template?: string;
 }
 export declare type Input = {
-    name?: string;
+    name?: string | Input;
     type: "value" | "reference" | "configVar" | "template";
     value: string;
     meta?: Record<string, unknown>;
 } | {
-    name?: string;
+    name?: string | Input;
     type: "complex";
     value: string | Input;
     meta?: Record<string, unknown>;

package/dist/types/ConnectionDefinition.d.ts

@@ -1,4 +1,4 @@
-import { ConnectionInput } from ".";
+import { ConnectionInput, OnPremConnectionInput } from ".";
 export declare enum OAuth2Type {
     ClientCredentials = "client_credentials",
     AuthorizationCode = "authorization_code"
@@ -19,13 +19,10 @@ export interface DefaultConnectionDefinition extends BaseConnectionDefinition {
         [key: string]: ConnectionInput;
     };
 }
-declare type OnPremiseConnectionInput = ConnectionInput & {
-    onPremiseControlled: true;
-};
-export interface OnPremiseConnectionDefinition extends BaseConnectionDefinition {
+export interface OnPremConnectionDefinition extends BaseConnectionDefinition {
     inputs: {
-        host: OnPremiseConnectionInput;
-        port: OnPremiseConnectionInput;
+        host: OnPremConnectionInput;
+        port: OnPremConnectionInput;
         [key: string]: ConnectionInput;
     };
 }
@@ -53,5 +50,5 @@ interface OAuth2ClientCredentialConnectionDefinition extends BaseConnectionDefin
     };
 }
 export declare type OAuth2ConnectionDefinition = OAuth2AuthorizationCodeConnectionDefinition | OAuth2ClientCredentialConnectionDefinition;
-export declare type ConnectionDefinition = DefaultConnectionDefinition | OnPremiseConnectionDefinition | OAuth2ConnectionDefinition;
+export declare type ConnectionDefinition = DefaultConnectionDefinition | OnPremConnectionDefinition | OAuth2ConnectionDefinition;
 export {};

package/dist/types/DataSourceResult.d.ts

@@ -16,6 +16,7 @@ declare type DataSourceTypeMap = {
     jsonForm: JSONForm;
 };
 export declare type DataSourceType = keyof DataSourceTypeMap;
+export declare type CollectionDataSourceType = Exclude<DataSourceType, "objectSelection" | "objectFieldMap" | "jsonForm">;
 export declare type DataSourceResultType = DataSourceTypeMap[DataSourceType];
 /** Represents the result of a Data Source action. */
 export declare type DataSourceResult<TDataSourceType extends DataSourceType> = {

package/dist/types/Inputs.d.ts

@@ -67,6 +67,9 @@ export declare type Inputs = Record<string, InputFieldDefinition>;
 export declare type ConnectionInput = (StringInputField | DataInputField | TextInputField | PasswordInputField | BooleanInputField) & {
     shown?: boolean;
 };
+export declare type OnPremConnectionInput = ConnectionInput & {
+    onPremControlled: true;
+};
 export declare type InputFieldDefinition = StringInputField | DataInputField | TextInputField | PasswordInputField | BooleanInputField | CodeInputField | ConditionalInputField | ConnectionInputField | ObjectSelectionInputField | ObjectFieldMapInputField | JSONFormInputField | DynamicObjectSelectionInputField | DynamicFieldSelectionInputField;
 export declare type InputCleanFunction<TValue, TResult = TValue> = (value: TValue) => TResult;
 interface BaseInputField {

package/dist/types/IntegrationDefinition.d.ts

@@ -1,4 +1,4 @@
-import { DataSourceDefinition, ConnectionDefinition, ActionPerformFunction, ActionPerformReturn, TriggerEventFunction, TriggerPerformFunction, Inputs, TriggerResult, DataSourceType, TriggerPayload, Connection, JSONForm, ObjectFieldMap, ObjectSelection, ConfigVarResultCollection, Schedule } from ".";
+import { DataSourceDefinition, ConnectionDefinition, ActionPerformFunction, ActionPerformReturn, TriggerEventFunction, TriggerPerformFunction, Inputs, TriggerResult, DataSourceType, TriggerPayload, Connection, JSONForm, ObjectFieldMap, ObjectSelection, ConfigVarResultCollection, Schedule, CollectionDataSourceType } from ".";
 import { Prettify, UnionToIntersection, ValueOf } from "./utils";
 export declare type ToDataSourceRuntimeType<TType extends DataSourceType> = TType extends "jsonForm" ? JSONForm : TType extends "objectSelection" ? ObjectSelection : TType extends "objectFieldMap" ? ObjectFieldMap : string;
 export declare type ElementToRuntimeType<TElement extends ConfigPageElement<any>> = TElement extends ConnectionConfigVar<any> ? Connection : TElement extends DataSourceConfigVar<any> ? ToDataSourceRuntimeType<TElement["dataSourceType"]> : TElement extends ScheduleConfigVar ? Schedule : TElement extends StandardConfigVar ? string : never;
@@ -87,21 +87,27 @@ declare type BaseConfigVar = {
     visibleToOrgDeployer?: boolean;
     /** Optional value that specifies whether this Config Var is visible to a Customer deployer. @default true */
     visibleToCustomerDeployer?: boolean;
+    /** Optional default value for the Config Var. */
+    defaultValue?: string;
+    /** Optional list of picklist values if the Config Var is a multi-choice selection value. */
+    pickList?: string[];
+    /** Optional value to specify the type of collection if the Config Var is multi-value. */
+    collectionType?: CollectionType;
 };
 /** Defines attributes of a standard Config Var. */
 export declare type StandardConfigVar = BaseConfigVar & {
     /** The data type of the Config Var. */
-    dataType: Exclude<ConfigVarDataType, "schedule">;
+    dataType: Exclude<ConfigVarDataType, "schedule" | "code">;
+};
+export declare type CodeConfigVar = BaseConfigVar & {
+    /** The data type of the Config Var. */
+    dataType: "code";
     /** Optional default value for the Config Var. */
     defaultValue?: string;
-    /** Optional list of picklist values if the Config Var is a multi-choice selection value. */
-    pickList?: string[];
     /** Optional value to specify the type of language if the Config Var is a code value. */
     codeLanguage?: CodeLanguageType;
-    /** Optional value to specify the type of collection if the Config Var is multi-value. */
-    collectionType?: CollectionType;
 };
-export declare type ScheduleConfigVar = BaseConfigVar & {
+export declare type ScheduleConfigVar = Omit<BaseConfigVar, "collectionType"> & {
     /** The data type of the Config Var. */
     dataType: "schedule";
     /** Optional default value for the Config Var. */
@@ -109,22 +115,28 @@ export declare type ScheduleConfigVar = BaseConfigVar & {
     /** Optional timezone for the schedule. */
     timeZone?: string;
 };
-declare type DataSourceDefinitionConfigVar = BaseConfigVar & Omit<DataSourceDefinition<Inputs, ConfigVarResultCollection, DataSourceType>, "display" | "inputs" | "examplePayload">;
-declare type DataSourceReferenceConfigVar<TComponents extends ComponentSelector<any>> = BaseConfigVar & {
-    dataSourceType: DataSourceType;
+declare type BaseDataSourceConfigVar = ({
+    dataSourceType: CollectionDataSourceType;
+} & BaseConfigVar) | ({
+    dataSourceType: Exclude<DataSourceType, CollectionDataSourceType>;
+} & Omit<BaseConfigVar, "collectionType">);
+declare type DataSourceDefinitionConfigVar = BaseDataSourceConfigVar & Omit<DataSourceDefinition<Inputs, ConfigVarResultCollection, DataSourceType>, "display" | "inputs" | "examplePayload" | "dataSourceType" | "detailDataSource">;
+declare type DataSourceReferenceConfigVar<TComponents extends ComponentSelector<any>> = BaseDataSourceConfigVar & {
     dataSource: ToComponentReferences<"dataSource", TComponents, ConfigPages<TComponents>>;
 };
 /** Defines attributes of a data source Config Var. */
 export declare type DataSourceConfigVar<TComponents extends ComponentSelector<any>> = DataSourceDefinitionConfigVar | DataSourceReferenceConfigVar<TComponents>;
-declare type ConnectionDefinitionConfigVar = BaseConfigVar & Omit<ConnectionDefinition, "label" | "comments" | "key">;
-declare type ConnectionReferenceConfigVar<TComponents extends ComponentSelector<any>> = BaseConfigVar & {
+declare type BaseConnectionConfigVar = Omit<BaseConfigVar, "collectionType">;
+declare type ConnectionDefinitionConfigVar = BaseConnectionConfigVar & Omit<ConnectionDefinition, "label" | "comments" | "key">;
+declare type ConnectionReferenceConfigVar<TComponents extends ComponentSelector<any>> = BaseConnectionConfigVar & {
     connection: ToComponentReferences<"connection", TComponents> & {
         template?: string;
     };
 };
 /** Defines attributes of a Config Var that represents a Connection. */
 export declare type ConnectionConfigVar<TComponents extends ComponentSelector<any>> = ConnectionDefinitionConfigVar | ConnectionReferenceConfigVar<TComponents>;
-export declare type ConfigVar<TComponents extends ComponentSelector<any>> = StandardConfigVar | ScheduleConfigVar | DataSourceConfigVar<TComponents> | ConnectionConfigVar<TComponents>;
+export declare type ConfigVar<TComponents extends ComponentSelector<any>> = StandardConfigVar | CodeConfigVar | ScheduleConfigVar | DataSourceConfigVar<TComponents> | ConnectionConfigVar<TComponents>;
+export declare const isCodeConfigVar: (cv: ConfigVar<any>) => cv is CodeConfigVar;
 export declare const isScheduleConfigVar: (cv: ConfigVar<any>) => cv is ScheduleConfigVar;
 export declare const isDataSourceDefinitionConfigVar: (cv: ConfigVar<any>) => cv is DataSourceDefinitionConfigVar;
 export declare const isDataSourceReferenceConfigVar: <TComponents extends ComponentSelector<any>>(cv: ConfigVar<TComponents>) => cv is DataSourceReferenceConfigVar<TComponents>;

package/dist/types/IntegrationDefinition.js

@@ -1,11 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isComponentReference = exports.isConnectionReferenceConfigVar = exports.isConnectionDefinitionConfigVar = exports.isDataSourceReferenceConfigVar = exports.isDataSourceDefinitionConfigVar = exports.isScheduleConfigVar = void 0;
+exports.isComponentReference = exports.isConnectionReferenceConfigVar = exports.isConnectionDefinitionConfigVar = exports.isDataSourceReferenceConfigVar = exports.isDataSourceDefinitionConfigVar = exports.isScheduleConfigVar = exports.isCodeConfigVar = void 0;
+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 isDataSourceDefinitionConfigVar = (cv) => "dataSourceType" in cv && "perform" in cv && typeof cv.perform === "function";
 exports.isDataSourceDefinitionConfigVar = isDataSourceDefinitionConfigVar;
-const isDataSourceReferenceConfigVar = (cv) => "dataSource" in cv && (0, exports.isComponentReference)(cv.dataSource);
+const isDataSourceReferenceConfigVar = (cv) => "dataSourceType" in cv &&
+    "dataSource" in cv &&
+    (0, exports.isComponentReference)(cv.dataSource);
 exports.isDataSourceReferenceConfigVar = isDataSourceReferenceConfigVar;
 const isConnectionDefinitionConfigVar = (cv) => "inputs" in cv;
 exports.isConnectionDefinitionConfigVar = isConnectionDefinitionConfigVar;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "8.1.5",
+  "version": "8.1.7",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"