@prismatic-io/spectral 8.0.0 → 8.0.2

package/dist/types/DataSourcePerformFunction.d.ts

@@ -1,10 +1,5 @@
-import { Inputs, DataSourceResult, DataSourceType, ActionInputParameters, ActionLogger, CustomerAttributes, InstanceAttributes, UserAttributes } from ".";
+import { Inputs, DataSourceResult, DataSourceType, ActionInputParameters, ConfigVarResultCollection, ActionContext } from ".";
 /** Context provided to perform method containing helpers and contextual data */
-export interface DataSourceContext {
-    logger: ActionLogger;
-    customer: CustomerAttributes;
-    instance: InstanceAttributes;
-    user: UserAttributes;
-}
+export declare type DataSourceContext<TConfigVars extends ConfigVarResultCollection> = Pick<ActionContext<TConfigVars>, "logger" | "customer" | "instance" | "user" | "configVars">;
 /** Definition of the function to perform when a Data Source is invoked. */
-export declare type DataSourcePerformFunction<TInputs extends Inputs, TDataSourceType extends DataSourceType> = (context: DataSourceContext, params: ActionInputParameters<TInputs>) => Promise<DataSourceResult<TDataSourceType>>;
+export declare type DataSourcePerformFunction<TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TDataSourceType extends DataSourceType> = (context: DataSourceContext<TConfigVars>, params: ActionInputParameters<TInputs>) => Promise<DataSourceResult<TDataSourceType>>;

package/dist/types/DataSourceResult.d.ts

@@ -1,4 +1,4 @@
-import { ObjectSelection, ObjectFieldMap, JSONForm, Element, Connection } from "./Inputs";
+import { ObjectSelection, ObjectFieldMap, JSONForm, Element } from "./Inputs";
 /** The type of field that is appropriate for rendering the data that is the result of the data source perform function. */
 declare type DataSourceTypeMap = {
     string: string;
@@ -9,10 +9,8 @@ declare type DataSourceTypeMap = {
         value: string;
     };
     code: string;
-    credential: unknown;
     boolean: boolean;
     number: number;
-    connection: Connection;
     objectSelection: ObjectSelection;
     objectFieldMap: ObjectFieldMap;
     jsonForm: JSONForm;

package/dist/types/Inputs.d.ts

@@ -35,6 +35,11 @@ export declare type ObjectFieldMap = {
         fields: Element[];
     }[];
 };
+export declare type Schedule = {
+    value: string;
+    schedule_type: string;
+    time_zone: string;
+};
 export declare type JSONForm = {
     /**
      * The data/JSON schema defines the underlying data to
@@ -248,5 +253,5 @@ export interface InputFieldChoice {
 /** InputField collection enumeration */
 export declare type InputFieldCollection = "valuelist" | "keyvaluelist";
 /** Config variable result collection */
-export declare type ConfigVarResultCollection = Record<string, string | Connection | JSONForm | ObjectSelection>;
+export declare type ConfigVarResultCollection = Record<string, string | Schedule | Connection | JSONForm | ObjectSelection | ObjectFieldMap>;
 export {};

package/dist/types/IntegrationDefinition.d.ts

@@ -1,10 +1,14 @@
-import { DataSourceDefinition, ConnectionDefinition, ActionPerformFunction, ActionPerformReturn, TriggerEventFunction, TriggerPerformFunction, Inputs, TriggerResult, DataSourceType, Connection as ConnectionResult, TriggerPayload } from ".";
-export declare type ConfigVarCollection = Record<string, ConfigVar>;
-export declare type ConfigVarDefinitionsToResults<TConfigVars extends ConfigVarCollection> = {
-    [Key in keyof TConfigVars]: TConfigVars[Key]["inputs"] extends Record<string, any> ? ConnectionResult : string;
-};
+import { DataSourceDefinition, ConnectionDefinition, ActionPerformFunction, ActionPerformReturn, TriggerEventFunction, TriggerPerformFunction, Inputs, TriggerResult, DataSourceType, TriggerPayload, Connection, JSONForm, ObjectFieldMap, ObjectSelection, ConfigVarResultCollection, Schedule } from ".";
+import { Prettify, UnionToIntersection, ValueOf } from "./utils";
+declare type ToDataSourceRuntimeType<TType extends DataSourceType> = TType extends "jsonForm" ? JSONForm : TType extends "objectSelection" ? ObjectSelection : TType extends "objectFieldMap" ? ObjectFieldMap : string;
+declare type ToRuntimeType<TType extends ConfigVarDataType> = TType extends ConfigVarDataType.Schedule ? Schedule : string;
+export declare type ElementToRuntimeType<TElement extends ConfigPageElement> = TElement extends ConnectionConfigVar ? Connection : TElement extends DataSourceConfigVar ? ToDataSourceRuntimeType<TElement["dataSourceType"]> : TElement extends StandardConfigVar ? ToRuntimeType<TElement["dataType"]> : never;
+declare type GetElements<TConfigPages extends ConfigPages> = TConfigPages extends ConfigPages ? UnionToIntersection<ValueOf<TConfigPages>["elements"]> : never;
+export declare type ExtractConfigVars<TConfigPages extends ConfigPages, TElements extends ConfigPage["elements"] = GetElements<TConfigPages>> = Prettify<{
+    [Key in keyof TElements]: ElementToRuntimeType<TElements[Key]>;
+}>;
 /** Defines attributes of a Code-Native Integration. */
-export declare type IntegrationDefinition<TConfigVars extends ConfigVarCollection = ConfigVarCollection> = {
+export declare type IntegrationDefinition<TConfigPages extends ConfigPages> = {
     /** The unique name for this Integration. */
     name: string;
     /** Optional description for this Integration. */
@@ -27,16 +31,12 @@ export declare type IntegrationDefinition<TConfigVars extends ConfigVarCollectio
      *  Cannot specify this if a Preprocess Flow is also configured. */
     triggerPreprocessFlowConfig?: PreprocessFlowConfig;
     /** Flows for this Integration. */
-    flows: Flow<TConfigVars>[];
-    /** Config Vars used on this Integration. */
-    configVars?: TConfigVars;
+    flows: Flow<TConfigPages>[];
     /** Config Wizard Pages for this Integration. */
-    configPages?: ConfigPage<TConfigVars>[];
-    /** Specifies any Data Sources that are defined as part of this Integration. */
-    dataSources?: Record<string, CodeNativeDataSource>;
+    configPages?: TConfigPages;
 };
 /** Defines attributes of a Flow of a Code-Native Integration. */
-export interface Flow<TConfigVars extends ConfigVarCollection = ConfigVarCollection, TTriggerPayload extends TriggerPayload = TriggerPayload> {
+export interface Flow<TConfigPages extends ConfigPages, TTriggerPayload extends TriggerPayload = TriggerPayload> {
     /** The unique name for this Flow. */
     name: string;
     /** A unique, unchanging value that is used to maintain identity for the Flow even if the name changes. */
@@ -58,11 +58,11 @@ export interface Flow<TConfigVars extends ConfigVarCollection = ConfigVarCollect
     /** Optional error handling configuration. */
     errorConfig?: StepErrorConfig;
     /** Specifies the trigger function for this Flow, which returns a payload and optional HTTP response. */
-    onTrigger: TriggerPerformFunction<Inputs, ConfigVarDefinitionsToResults<TConfigVars>, true, false, TriggerResult<false, TTriggerPayload>>;
+    onTrigger: TriggerPerformFunction<Inputs, ExtractConfigVars<TConfigPages>, false, TriggerResult<false, TTriggerPayload>>;
     /** Specifies the function to execute when an Instance of this Integration is deployed. */
-    onInstanceDeploy?: TriggerEventFunction<Inputs, ConfigVarDefinitionsToResults<TConfigVars>, true>;
+    onInstanceDeploy?: TriggerEventFunction<Inputs, ExtractConfigVars<TConfigPages>>;
     /** Specifies the function to execute when an Instance of an Integration is deleted. */
-    onInstanceDelete?: TriggerEventFunction<Inputs, ConfigVarDefinitionsToResults<TConfigVars>, true>;
+    onInstanceDelete?: TriggerEventFunction<Inputs, ExtractConfigVars<TConfigPages>>;
     /** Specifies the main function for this Flow */
     onExecution: ActionPerformFunction<{
         onTrigger: {
@@ -72,22 +72,16 @@ export interface Flow<TConfigVars extends ConfigVarCollection = ConfigVarCollect
                 results: TTriggerPayload;
             };
         };
-    }, ConfigVarDefinitionsToResults<TConfigVars>, true, false, ActionPerformReturn<false, unknown>>;
+    }, ExtractConfigVars<TConfigPages>, false, ActionPerformReturn<false, unknown>>;
 }
-/** Defines attributes of a Data Source that is defined as part of a Code Native Integration. */
-export declare type CodeNativeDataSource = Pick<DataSourceDefinition<Inputs, DataSourceType>, "display" | "perform" | "dataSourceType" | "detailDataSource">;
 /** Common attribute shared by all types of Config Vars. */
 declare type BaseConfigVar = {
-    /** The unique key for this Config Var. */
-    key: string;
     /** A unique, unchanging value that is used to maintain identity for the Config Var even if the key changes. */
     stableKey: string;
     /** Optional description for this Config Var. */
     description?: string;
     /** Optional value that specifies whether this Config Var is only configurable by Organization users. @default false  */
     orgOnly?: boolean;
-    /** Optional input values for this Config Var. */
-    inputs?: InputValues;
     /** Optional value that specifies whether this Config Var is visible to an Organization deployer. @default true */
     visibleToOrgDeployer?: boolean;
     /** Optional value that specifies whether this Config Var is visible to a Customer deployer. @default true */
@@ -95,10 +89,10 @@ declare type BaseConfigVar = {
 };
 /** Defines attributes of a standard Config Var. */
 export declare type StandardConfigVar = BaseConfigVar & {
-    /** Optional default value for the Config Var. */
-    defaultValue?: string;
     /** The data type of the Config Var. */
     dataType: ConfigVarDataType;
+    /** 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 schedule type that defines the cadence of the schedule. */
@@ -109,55 +103,22 @@ export declare type StandardConfigVar = BaseConfigVar & {
     codeLanguage?: CodeLanguageType;
     /** Optional value to specify the type of collection if the Config Var is multi-value. */
     collectionType?: CollectionType;
-    /** Optional value to specify the key of a Data Source defined in this CNI
-     *  where the Config Var sources its values. */
-    dataSource?: string;
 };
+/** Defines attributes of a data source Config Var. */
+export declare type DataSourceConfigVar = BaseConfigVar & Omit<DataSourceDefinition<Inputs, ConfigVarResultCollection, DataSourceType>, "display" | "inputs" | "examplePayload">;
 /** Defines attributes of a Config Var that represents a Connection. */
-export declare type ConnectionConfigVar = Omit<BaseConfigVar, "description" | "inputs"> & ConnectionDefinition;
-export declare type ConfigVar = StandardConfigVar | ConnectionConfigVar;
+export declare type ConnectionConfigVar = BaseConfigVar & Omit<ConnectionDefinition, "label" | "comments" | "key">;
+export declare type ConfigVar = StandardConfigVar | DataSourceConfigVar | ConnectionConfigVar;
+export declare const isDataSourceConfigVar: (cv: ConfigVar) => cv is DataSourceConfigVar;
+export declare const isConnectionConfigVar: (cv: ConfigVar) => cv is ConnectionConfigVar;
+export declare type ConfigPageElement = string | ConfigVar;
+export declare type ConfigPages = Record<string, ConfigPage>;
 /** Defines attributes of a Config Wizard Page used when deploying an Instance of an Integration. */
-export declare type ConfigPage<TConfigVars extends ConfigVarCollection = ConfigVarCollection> = {
-    /** The unique name for this Config Page. */
-    name: string;
+export declare type ConfigPage = {
+    /** Elements included on this Config Page. */
+    elements: Record<string, ConfigPageElement>;
     /** Specifies an optional tagline for this Config Page. */
     tagline?: string;
-    /** Optional value that specifies whether this Config Page is configured as
-     *  part of User Level Configuration. @default false */
-    userLevelConfigured?: boolean;
-    /** Elements included on this Config Page. */
-    elements: ConfigPageElement<TConfigVars>[];
-};
-/** Defines attributes of Inputs for Connections, Actions, Triggers,
- *  Data Sources, and Config Vars. */
-export declare type InputValues = Record<string, InputValue>;
-export declare type InputValue = SimpleInputValue | ComplexInputValue;
-export declare type SimpleInputValue = {
-    name?: string;
-    type: SimpleInputValueType;
-    value: string;
-    meta?: Record<string, unknown>;
-};
-export declare type ComplexInputValue = {
-    name?: string;
-    type: "complex";
-    value: ComplexInputValueType;
-    meta?: Record<string, unknown>;
-};
-export declare type ComplexInputValueType = (string | InputValue | ComplexInputValueType)[];
-/** Defines attributes of an Element that appears on a Config Wizard Page. */
-export declare type ConfigPageElement<TConfigVars extends ConfigVarCollection = ConfigVarCollection> = HTMLConfigPageElement | JSONFormConfigPageElement | ConfigVarPageElement<TConfigVars>;
-declare type HTMLConfigPageElement = {
-    type: ConfigPageElementType.HTML;
-    value: string;
-};
-declare type JSONFormConfigPageElement = {
-    type: ConfigPageElementType.JSONForm;
-    value: string;
-};
-declare type ConfigVarPageElement<TConfigVars extends ConfigVarCollection = ConfigVarCollection> = {
-    type: ConfigPageElementType.ConfigVar;
-    value: keyof TConfigVars;
 };
 /** Defines attributes of a Preprocess Flow Configuration used by a Flow of an Integration. */
 export declare type PreprocessFlowConfig = {
@@ -204,13 +165,6 @@ export declare type FlowSchedule = {
     /** Specifies an optional value to use as the timezone. */
     timeZone?: string;
 };
-/** Choices of Simple Input Value Types that may be used by Simple Input Values. */
-export declare enum SimpleInputValueType {
-    Value = "value",
-    Reference = "reference",
-    ConfigVar = "configVar",
-    Template = "template"
-}
 /** Choices of Endpoint Types that may be used by Instances of an Integration. */
 export declare enum EndpointType {
     FlowSpecific = "flow_specific",
@@ -224,12 +178,6 @@ export declare enum EndpointSecurityType {
     CustomerRequired = "customer_required",
     Organization = "organization"
 }
-/** Choices of Config Page Element Types that may be used for Elements on a Config Wizard Page. */
-export declare enum ConfigPageElementType {
-    ConfigVar = "configVar",
-    HTML = "htmlElement",
-    JSONForm = "jsonForm"
-}
 /** Choices of Step Error Handlers that define the behavior when a step error occurs. */
 export declare enum StepErrorHandlerType {
     Fail = "fail",
@@ -254,10 +202,7 @@ export declare enum ConfigVarDataType {
     Schedule = "schedule",
     Code = "code",
     Boolean = "boolean",
-    Number = "number",
-    ObjectSelection = "objectSelection",
-    ObjectFieldMap = "objectFieldMap",
-    JSONForm = "jsonForm"
+    Number = "number"
 }
 /** Choices of programming languages that may be used for Config Var code values. */
 export declare enum CodeLanguageType {

package/dist/types/IntegrationDefinition.js

@@ -1,14 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CollectionType = exports.CodeLanguageType = exports.ConfigVarDataType = exports.ScheduleType = exports.StepErrorHandlerType = exports.ConfigPageElementType = exports.EndpointSecurityType = exports.EndpointType = exports.SimpleInputValueType = void 0;
-/** Choices of Simple Input Value Types that may be used by Simple Input Values. */
-var SimpleInputValueType;
-(function (SimpleInputValueType) {
-    SimpleInputValueType["Value"] = "value";
-    SimpleInputValueType["Reference"] = "reference";
-    SimpleInputValueType["ConfigVar"] = "configVar";
-    SimpleInputValueType["Template"] = "template";
-})(SimpleInputValueType = exports.SimpleInputValueType || (exports.SimpleInputValueType = {}));
+exports.CollectionType = exports.CodeLanguageType = exports.ConfigVarDataType = exports.ScheduleType = exports.StepErrorHandlerType = exports.EndpointSecurityType = exports.EndpointType = exports.isConnectionConfigVar = exports.isDataSourceConfigVar = void 0;
+const isDataSourceConfigVar = (cv) => "dataSourceType" in cv;
+exports.isDataSourceConfigVar = isDataSourceConfigVar;
+const isConnectionConfigVar = (cv) => "inputs" in cv;
+exports.isConnectionConfigVar = isConnectionConfigVar;
 /** Choices of Endpoint Types that may be used by Instances of an Integration. */
 var EndpointType;
 (function (EndpointType) {
@@ -24,13 +20,6 @@ var EndpointSecurityType;
     EndpointSecurityType["CustomerRequired"] = "customer_required";
     EndpointSecurityType["Organization"] = "organization";
 })(EndpointSecurityType = exports.EndpointSecurityType || (exports.EndpointSecurityType = {}));
-/** Choices of Config Page Element Types that may be used for Elements on a Config Wizard Page. */
-var ConfigPageElementType;
-(function (ConfigPageElementType) {
-    ConfigPageElementType["ConfigVar"] = "configVar";
-    ConfigPageElementType["HTML"] = "htmlElement";
-    ConfigPageElementType["JSONForm"] = "jsonForm";
-})(ConfigPageElementType = exports.ConfigPageElementType || (exports.ConfigPageElementType = {}));
 /** Choices of Step Error Handlers that define the behavior when a step error occurs. */
 var StepErrorHandlerType;
 (function (StepErrorHandlerType) {
@@ -59,9 +48,6 @@ var ConfigVarDataType;
     ConfigVarDataType["Code"] = "code";
     ConfigVarDataType["Boolean"] = "boolean";
     ConfigVarDataType["Number"] = "number";
-    ConfigVarDataType["ObjectSelection"] = "objectSelection";
-    ConfigVarDataType["ObjectFieldMap"] = "objectFieldMap";
-    ConfigVarDataType["JSONForm"] = "jsonForm";
 })(ConfigVarDataType = exports.ConfigVarDataType || (exports.ConfigVarDataType = {}));
 /** Choices of programming languages that may be used for Config Var code values. */
 var CodeLanguageType;

package/dist/types/TriggerDefinition.d.ts

@@ -10,11 +10,11 @@ export interface TriggerDefinition<TInputs extends Inputs, TConfigVars extends C
     /** Defines how the Trigger is displayed in the Prismatic interface. */
     display: ActionDisplayDefinition;
     /** Function to perform when this Trigger is invoked. */
-    perform: TriggerPerformFunction<TInputs, TConfigVars, false, TAllowsBranching, TResult>;
+    perform: TriggerPerformFunction<TInputs, TConfigVars, TAllowsBranching, TResult>;
     /** Function to execute when an Instance of an Integration with a Flow that uses this Trigger is deployed. */
-    onInstanceDeploy?: TriggerEventFunction<TInputs, TConfigVars, false>;
+    onInstanceDeploy?: TriggerEventFunction<TInputs, TConfigVars>;
     /** Function to execute when an Instance of an Integration with a Flow that uses this Trigger is deleted. */
-    onInstanceDelete?: TriggerEventFunction<TInputs, TConfigVars, false>;
+    onInstanceDelete?: TriggerEventFunction<TInputs, TConfigVars>;
     /** InputFields to present in the Prismatic interface for configuration of this Trigger. */
     inputs: TInputs;
     /** Specifies whether this Trigger supports executing the Integration on a recurring schedule. */

package/dist/types/TriggerEventFunction.d.ts

@@ -10,4 +10,4 @@ export declare type TriggerEventFunctionReturn = {
     integrationState?: Record<string, unknown>;
 };
 /** Definition of the function to execute when a Trigger Event occurs. */
-export declare type TriggerEventFunction<TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, THasConfigVars extends boolean> = (context: ActionContext<TConfigVars, THasConfigVars>, params: ActionInputParameters<TInputs>) => Promise<void | TriggerEventFunctionReturn>;
+export declare type TriggerEventFunction<TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection> = (context: ActionContext<TConfigVars>, params: ActionInputParameters<TInputs>) => Promise<void | TriggerEventFunctionReturn>;

package/dist/types/TriggerPerformFunction.d.ts

@@ -1,3 +1,3 @@
 import { Inputs, TriggerResult, ActionInputParameters, ActionContext, TriggerPayload, ConfigVarResultCollection } from ".";
 /** Definition of the function to perform when a Trigger is invoked. */
-export declare type TriggerPerformFunction<TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, THasConfigVars extends boolean, TAllowsBranching extends boolean | undefined, TResult extends TriggerResult<TAllowsBranching, TriggerPayload>> = (context: ActionContext<TConfigVars, THasConfigVars>, payload: TriggerPayload, params: ActionInputParameters<TInputs>) => Promise<TResult>;
+export declare type TriggerPerformFunction<TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TAllowsBranching extends boolean | undefined, TResult extends TriggerResult<TAllowsBranching, TriggerPayload>> = (context: ActionContext<TConfigVars>, payload: TriggerPayload, params: ActionInputParameters<TInputs>) => Promise<TResult>;

package/dist/types/utils.d.ts

@@ -0,0 +1,5 @@
+export declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+export declare type Prettify<T> = {
+    [K in keyof T]: T[K];
+};
+export declare type ValueOf<T> = T[keyof T];

package/dist/types/utils.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "8.0.0",
+  "version": "8.0.2",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"
@@ -43,6 +43,7 @@
     "date-fns": "2.30.0",
     "form-data": "4.0.0",
     "jest-mock": "27.0.3",
+    "lodash": "4.17.21",
     "safe-stable-stringify": "2.3.1",
     "serialize-error": "8.1.0",
     "url-join": "5.0.0",
@@ -52,6 +53,7 @@
   },
   "devDependencies": {
     "@types/jest": "27.4.1",
+    "@types/lodash": "4.14.202",
     "@types/node": "14.14.35",
     "@types/sax": "1.2.4",
     "@types/url-join": "4.0.1",