@prismatic-io/spectral 8.0.7 → 8.1.0-preview2

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 } from "./types";
+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 { convertComponent } from "./serverTypes/convert";
 import { convertIntegration } from "./serverTypes/convertIntegration";
 /**
@@ -14,42 +14,49 @@ import { convertIntegration } from "./serverTypes/convertIntegration";
  * @param definition An IntegrationDefinition type object.
  * @returns This function returns an integration object that has the shape the Prismatic API expects.
  */
-export declare const integration: <TConfigPages extends ConfigPages = ConfigPages>(definition: IntegrationDefinition<TConfigPages>) => ReturnType<typeof convertIntegration>;
+export declare const integration: <TComponents extends ComponentSelector<any> = ComponentSelector<any>, TConfigPages extends ConfigPages<TComponents> = ConfigPages<TComponents>>(definition: IntegrationDefinition<TConfigPages, TComponents>) => ReturnType<typeof convertIntegration>;
 /**
  * For information on writing Code Native Integrations, see
  * https://prismatic.io/docs/code-native-integrations/#adding-flows.
  * @param definition A Flow type object.
  * @returns This function returns a flow object that has the shape the Prismatic API expects.
  */
-export declare const flow: <TConfigPages extends ConfigPages = ConfigPages, TTriggerPayload extends TriggerPayload = TriggerPayload, T extends Flow<TConfigPages, TTriggerPayload> = Flow<TConfigPages, TTriggerPayload>>(definition: T) => T;
+export declare const flow: <TConfigPages extends ConfigPages<any> = ConfigPages<any>, TComponents extends ComponentSelector<any> = ComponentSelector<any>, TTriggerPayload extends TriggerPayload = TriggerPayload, T extends Flow<TConfigPages, TComponents, TTriggerPayload> = Flow<TConfigPages, TComponents, TTriggerPayload>>(definition: T) => T;
 /**
  * For information on writing Code Native Integrations, see
  * https://prismatic.io/docs/code-native-integrations/#adding-config-pages.
  * @param definition A Config Page type object.
  * @returns This function returns a config page object that has the shape the Prismatic API expects.
  */
-export declare const configPage: <T extends ConfigPage>(definition: T) => T;
+export declare const configPage: <T extends ConfigPage<any> = ConfigPage<any>>(definition: T) => T;
+/**
+ * @returns Helper utility to create component references.
+ */
+export declare const reference: <TComponents extends ComponentSelector<any>>() => {
+    connection: <T extends ConnectionConfigVar<TComponents>>(definition: T) => T;
+    dataSource: <T_1 extends DataSourceConfigVar<TComponents>>(definition: T_1) => T_1;
+};
 /**
  * For information on writing Code Native Integrations, see
  * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
  * @param definition A Config Var type object.
  * @returns This function returns a standard config var object that has the shape the Prismatic API expects.
  */
-export declare const configVar: <T extends StandardConfigVar>(definition: T) => T;
+export declare const configVar: <T extends StandardConfigVar | ScheduleConfigVar>(definition: T) => T;
 /**
  * For information on writing Code Native Integrations, see
  * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
  * @param definition A Data Source Config Var type object.
  * @returns This function returns a data source config var object that has the shape the Prismatic API expects.
  */
-export declare const dataSourceConfigVar: <T extends DataSourceConfigVar>(definition: T) => T;
+export declare const dataSourceConfigVar: <T extends DataSourceConfigVar<any> = DataSourceConfigVar<any>>(definition: T) => T;
 /**
  * For information on writing Code Native Integrations, see
  * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
  * @param definition A Connection Config Var type object.
  * @returns This function returns a connection config var object that has the shape the Prismatic API expects.
  */
-export declare const connectionConfigVar: <T extends ConnectionConfigVar>(definition: T) => T;
+export declare const connectionConfigVar: <T extends ConnectionConfigVar<any> = ConnectionConfigVar<any>>(definition: T) => T;
 /**
  * This function creates a component object that can be
  * imported into the Prismatic API. For information on using

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.configPage = exports.flow = exports.integration = void 0;
+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;
 const convert_1 = require("./serverTypes/convert");
 const convertIntegration_1 = require("./serverTypes/convertIntegration");
 /**
@@ -58,6 +58,14 @@ exports.flow = flow;
  */
 const configPage = (definition) => definition;
 exports.configPage = configPage;
+/**
+ * @returns Helper utility to create component references.
+ */
+const reference = () => ({
+    connection: (definition) => definition,
+    dataSource: (definition) => definition,
+});
+exports.reference = reference;
 /**
  * For information on writing Code Native Integrations, see
  * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.

package/dist/serverTypes/convertIntegration.d.ts

@@ -1,3 +1,3 @@
-import { IntegrationDefinition, ConfigPages } from "../types";
+import { IntegrationDefinition, ConfigPages, ComponentSelector } from "../types";
 import { Component as ServerComponent } from ".";
-export declare const convertIntegration: (definition: IntegrationDefinition<ConfigPages>) => ServerComponent;
+export declare const convertIntegration: (definition: IntegrationDefinition<ConfigPages<any>, ComponentSelector<any>>) => ServerComponent;

package/dist/serverTypes/convertIntegration.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertIntegration = void 0;
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
 const yaml_1 = __importDefault(require("yaml"));
 const uuid_1 = require("uuid");
 const lodash_1 = require("lodash");
@@ -47,7 +48,11 @@ const codeNativeIntegrationYaml = ({ name, description, category, documentation,
     const preprocessFlowConfig = hasPreprocessFlow
         ? preprocessFlows[0].preprocessFlowConfig
         : triggerPreprocessFlowConfig;
-    if ([types_1.EndpointType.InstanceSpecific, types_1.EndpointType.SharedInstance].includes(endpointType || types_1.EndpointType.FlowSpecific) &&
+    const nonPreprocessFlowTypes = [
+        "instance_specific",
+        "shared_instance",
+    ];
+    if (nonPreprocessFlowTypes.includes(endpointType || "flow_specific") &&
         !preprocessFlowConfig) {
         throw new Error("Integration with specified EndpointType must define either a Trigger Preprocess Flow Config or a Preprocess Flow.");
     }
@@ -74,8 +79,35 @@ const codeNativeIntegrationYaml = ({ name, description, category, documentation,
     };
     return yaml_1.default.stringify(result);
 };
+const convertComponentReference = ({ key, component: componentRef, values, }) => {
+    const component = typeof componentRef === "string"
+        ? {
+            key: componentRef,
+            version: "LATEST",
+            isPublic: true,
+        }
+        : {
+            key: componentRef.key,
+            version: "LATEST",
+            isPublic: componentRef.isPublic,
+        };
+    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 } });
+        }
+        if ("configVar" in value) {
+            return Object.assign(Object.assign({}, result), { [key]: { type: "configVar", value: value.configVar } });
+        }
+        return result;
+    }, {});
+    return {
+        ref: { key, component },
+        inputs,
+    };
+};
 /** Converts a Flow into the structure necessary for YAML generation. */
 const convertFlow = (flow, referenceKey) => {
+    var _a;
     const result = Object.assign({}, flow);
     delete result.onTrigger;
     delete result.trigger;
@@ -90,20 +122,38 @@ const convertFlow = (flow, referenceKey) => {
         description: "The function that will be executed by the flow to return an HTTP response.",
         isTrigger: true,
         errorConfig: "errorConfig" in flow ? Object.assign({}, flow.errorConfig) : undefined,
-        action: {
-            key: flowFunctionKey(flow.name, "onTrigger"),
-            component: { key: referenceKey, version: "LATEST", isPublic: false },
-        },
     };
+    if (typeof flow.onTrigger === "function") {
+        triggerStep.action = {
+            key: flowFunctionKey(flow.name, "onTrigger"),
+            component: {
+                key: referenceKey,
+                version: "LATEST",
+                isPublic: false,
+            },
+        };
+    }
+    else if ((0, types_1.isComponentReference)(flow.onTrigger)) {
+        const { ref, inputs } = convertComponentReference(flow.onTrigger);
+        triggerStep.action = ref;
+        triggerStep.inputs = inputs;
+    }
+    else {
+        const hasSchedule = "schedule" in flow && typeof flow.schedule === "object";
+        const key = hasSchedule ? "schedule" : "webhook";
+        triggerStep.action = {
+            key,
+            component: { key: `${key}-triggers`, version: "LATEST", isPublic: true },
+        };
+    }
     if ("schedule" in flow && typeof flow.schedule === "object") {
+        const { schedule } = flow;
         triggerStep.schedule = {
-            type: "cronExpression" in flow.schedule ? "value" : "configVar",
-            value: "cronExpression" in flow.schedule
-                ? flow.schedule.cronExpression
-                : flow.schedule.configVarKey,
+            type: "configVar" in schedule ? "configVar" : "value",
+            value: "configVar" in schedule ? schedule.configVar : schedule.value,
             meta: {
-                scheduleType: types_1.ScheduleType.Custom,
-                timeZone: flow.schedule.timeZone,
+                scheduleType: "custom",
+                timeZone: (_a = schedule.timezone) !== null && _a !== void 0 ? _a : "",
             },
         };
         delete result.schedule;
@@ -127,7 +177,7 @@ const convertConfigVar = (key, configVar, referenceKey) => {
         "visibleToCustomerDeployer",
         "visibleToOrgDeployer",
     ]);
-    if ((0, types_1.isConnectionConfigVar)(configVar)) {
+    if ((0, types_1.isConnectionDefinitionConfigVar)(configVar)) {
         return Object.assign(Object.assign({}, (0, lodash_1.pick)(configVar, ["stableKey", "description", "orgOnly"])), { key, dataType: "connection", connection: {
                 component: { key: referenceKey, version: "LATEST", isPublic: false },
                 key: (0, lodash_1.camelCase)(key),
@@ -143,6 +193,10 @@ const convertConfigVar = (key, configVar, referenceKey) => {
                 return Object.assign(Object.assign({}, result), { [key]: { type: "value", value } });
             }, {}), meta });
     }
+    if ((0, types_1.isConnectionReferenceConfigVar)(configVar)) {
+        const { ref, inputs } = convertComponentReference(configVar.connection);
+        return Object.assign(Object.assign({}, (0, lodash_1.pick)(configVar, ["stableKey", "description", "orgOnly"])), { key, dataType: "connection", connection: ref, inputs });
+    }
     const result = (0, lodash_1.assign)({ meta, key }, (0, lodash_1.pick)(configVar, [
         "stableKey",
         "description",
@@ -150,19 +204,26 @@ const convertConfigVar = (key, configVar, referenceKey) => {
         "defaultValue",
         "dataType",
         "pickList",
-        "scheduleType",
         "timeZone",
         "codeLanguage",
         "collectionType",
     ]));
-    // Handle data sources.
-    if ((0, types_1.isDataSourceConfigVar)(configVar)) {
+    if ((0, types_1.isScheduleConfigVar)(configVar)) {
+        result.scheduleType = "custom";
+    }
+    if ((0, types_1.isDataSourceDefinitionConfigVar)(configVar)) {
         result.dataType = configVar.dataSourceType;
         result.dataSource = {
             key: (0, lodash_1.camelCase)(key),
             component: { key: referenceKey, version: "LATEST", isPublic: false },
         };
     }
+    if ((0, types_1.isDataSourceReferenceConfigVar)(configVar)) {
+        const { ref, inputs } = convertComponentReference(configVar.dataSource);
+        result.dataType = configVar.dataSourceType;
+        result.dataSource = ref;
+        result.inputs = inputs;
+    }
     return result;
 };
 /** Maps the step name field to a fully qualified input. */
@@ -199,6 +260,9 @@ const codeNativeIntegrationComponent = ({ name, iconPath, description, flows = [
             } });
     }, {});
     const convertedTriggers = flows.reduce((result, { name, onTrigger, onInstanceDeploy, onInstanceDelete }) => {
+        if (typeof onTrigger !== "function") {
+            return result;
+        }
         const key = flowFunctionKey(name, "onTrigger");
         return Object.assign(Object.assign({}, result), { [key]: {
                 key,
@@ -217,7 +281,7 @@ const codeNativeIntegrationComponent = ({ name, iconPath, description, flows = [
             } });
     }, {});
     const convertedDataSources = Object.entries(configVars).reduce((result, [key, configVar]) => {
-        if (!(0, types_1.isDataSourceConfigVar)(configVar)) {
+        if (!(0, types_1.isDataSourceDefinitionConfigVar)(configVar)) {
             return result;
         }
         const camelKey = (0, lodash_1.camelCase)(key);
@@ -228,7 +292,7 @@ const codeNativeIntegrationComponent = ({ name, iconPath, description, flows = [
                 }, inputs: [] }) });
     }, {});
     const convertedConnections = Object.entries(configVars).reduce((result, [key, configVar]) => {
-        if (!(0, types_1.isConnectionConfigVar)(configVar)) {
+        if (!(0, types_1.isConnectionDefinitionConfigVar)(configVar)) {
             return result;
         }
         const convertedInputs = Object.entries(configVar.inputs).map(([key, value]) => (0, convert_1.convertInput)(key, value));

package/dist/serverTypes/integration.d.ts

@@ -1,8 +1,11 @@
 export declare const DefinitionVersion = 7;
 export interface ComponentReference {
+    component: {
+        key: string;
+        version: number | "LATEST";
+        isPublic: boolean;
+    };
     key: string;
-    version: number | "LATEST";
-    isPublic: boolean;
 }
 export declare type Input = {
     name?: string;
@@ -21,10 +24,7 @@ export interface ConnectionRequiredConfigVariable {
     description?: string;
     orgOnly?: boolean;
     dataType: "connection";
-    connection: {
-        component: ComponentReference;
-        key: string;
-    };
+    connection: ComponentReference;
     inputs?: Record<string, Input>;
     meta?: Record<string, unknown>;
 }
@@ -40,10 +40,7 @@ export interface DefaultRequiredConfigVariable {
     description?: string;
     orgOnly?: boolean;
     collectionType?: "valuelist" | "keyvaluelist";
-    dataSource?: {
-        component: ComponentReference;
-        key: string;
-    };
+    dataSource?: ComponentReference;
     inputs?: Record<string, Input>;
     meta?: Record<string, unknown>;
 }

package/dist/testing.d.ts

@@ -5,7 +5,7 @@
  * https://prismatic.io/docs/custom-components/writing-custom-components/#testing-a-component
  */
 import { TriggerPayload, TriggerResult, ConnectionValue, ActionLogger, Component, ActionContext, ActionPerformReturn, DataSourceResult, DataSourceContext } from "./serverTypes";
-import { ConnectionDefinition, ActionDefinition, TriggerDefinition, Inputs, ActionInputParameters, DataSourceDefinition, ActionPerformReturn as InvokeActionPerformReturn, TriggerResult as InvokeTriggerResult, DataSourceResult as InvokeDataSourceResult, TriggerEventFunctionReturn, Flow, ConfigVarResultCollection, ConfigPages } from "./types";
+import { ConnectionDefinition, ActionDefinition, TriggerDefinition, Inputs, ActionInputParameters, DataSourceDefinition, ActionPerformReturn as InvokeActionPerformReturn, TriggerResult as InvokeTriggerResult, DataSourceResult as InvokeDataSourceResult, TriggerEventFunctionReturn, Flow, ConfigVarResultCollection, ConfigPages, ComponentSelector } from "./types";
 export declare const createConnection: <T extends ConnectionDefinition>({ key }: T, values: Record<string, unknown>, tokenValues?: Record<string, unknown> | undefined) => ConnectionValue;
 /**
  * Pre-built mock of ActionLogger. Suitable for asserting logs are created as expected.
@@ -63,7 +63,7 @@ declare type ToTestValues<TConfigVars extends ConfigVarResultCollection> = {
  * Invokes specified Flow of a Code Native Integration using supplied params.
  * Runs the Trigger and then the Action function and returns the result of the Action.
  */
-export declare const invokeFlow: <TConfigPages extends ConfigPages, TConfigVars extends ConfigVarResultCollection = import("./types/utils").Prettify<{ [Key in keyof (TConfigPages extends ConfigPages ? import("./types/utils").UnionToIntersection<import("./types/utils").ValueOf<TConfigPages>["elements"]> : never)]: import("./types").ElementToRuntimeType<(TConfigPages extends ConfigPages ? import("./types/utils").UnionToIntersection<import("./types/utils").ValueOf<TConfigPages>["elements"]> : never)[Key]>; }>, TConfigVarValues extends TestConfigVarValues = ToTestValues<TConfigVars>>(flow: Flow<TConfigPages, import("./types").TriggerPayload>, configVars: TConfigVarValues, context?: Partial<ActionContext<TConfigVars>> | undefined, payload?: TriggerPayload | undefined) => Promise<InvokeReturn<InvokeActionPerformReturn<false, unknown>>>;
+export declare const invokeFlow: <TConfigPages extends ConfigPages<any>, TConfigVars extends ConfigVarResultCollection = import("./types/utils").Prettify<{ [Key in keyof import("./types").GetElements<TConfigPages> as Key extends string ? Key : never]: import("./types").ElementToRuntimeType<import("./types").GetElements<TConfigPages>[Key]>; }>, TConfigVarValues extends TestConfigVarValues = ToTestValues<TConfigVars>>(flow: Flow<TConfigPages, ComponentSelector<any>, import("./types").TriggerPayload>, configVars: TConfigVarValues, context?: Partial<ActionContext<TConfigVars>> | undefined, payload?: TriggerPayload | undefined) => Promise<InvokeReturn<InvokeActionPerformReturn<false, unknown>>>;
 export declare class ComponentTestHarness<TComponent extends Component> {
     component: TComponent;
     constructor(component: TComponent);

package/dist/testing.js

@@ -197,7 +197,7 @@ const invokeFlow = (flow, configVars, context, payload) => __awaiter(void 0, voi
     const params = {
         onTrigger: { results: null },
     };
-    if ("onTrigger" in flow) {
+    if ("onTrigger" in flow && typeof flow.onTrigger === "function") {
         const triggerResult = yield flow.onTrigger(realizedContext, realizedPayload, params);
         params.onTrigger = { results: triggerResult === null || triggerResult === void 0 ? void 0 : triggerResult.payload };
     }

package/dist/types/IntegrationDefinition.d.ts

@@ -1,14 +1,13 @@
 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]>;
+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;
+export declare type GetElements<TConfigPages extends ConfigPages<any>> = TConfigPages extends ConfigPages<any> ? UnionToIntersection<ValueOf<TConfigPages>["elements"]> : never;
+export declare type ExtractConfigVars<TConfigPages extends ConfigPages<any>, TElements extends ConfigPage<any>["elements"] = GetElements<TConfigPages>> = Prettify<{
+    [Key in keyof TElements as Key extends string ? Key : never]: ElementToRuntimeType<TElements[Key]>;
 }>;
 /** Defines attributes of a Code-Native Integration. */
-export declare type IntegrationDefinition<TConfigPages extends ConfigPages> = {
+export declare type IntegrationDefinition<TConfigPages extends ConfigPages<TComponents>, TComponents extends ComponentSelector<any>> = {
     /** The unique name for this Integration. */
     name: string;
     /** Optional description for this Integration. */
@@ -31,12 +30,12 @@ export declare type IntegrationDefinition<TConfigPages extends ConfigPages> = {
      *  Cannot specify this if a Preprocess Flow is also configured. */
     triggerPreprocessFlowConfig?: PreprocessFlowConfig;
     /** Flows for this Integration. */
-    flows: Flow<TConfigPages>[];
+    flows: Flow<TConfigPages, TComponents>[];
     /** Config Wizard Pages for this Integration. */
     configPages?: TConfigPages;
 };
 /** Defines attributes of a Flow of a Code-Native Integration. */
-export interface Flow<TConfigPages extends ConfigPages, TTriggerPayload extends TriggerPayload = TriggerPayload> {
+export interface Flow<TConfigPages extends ConfigPages<TComponents>, TComponents extends ComponentSelector<any>, 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. */
@@ -54,11 +53,13 @@ export interface Flow<TConfigPages extends ConfigPages, TTriggerPayload extends
     /** Optional list of API key(s) to use for the endpoint of this Flow when the endpoint security type is EndpointSecurityType.Organization. */
     organizationApiKeys?: string[];
     /** Optional schedule configuration that defines the frequency with which this Flow will be automatically executed. */
-    schedule?: FlowSchedule;
+    schedule?: ValueReference<string, TConfigPages> & {
+        timezone?: string;
+    };
     /** Optional error handling configuration. */
     errorConfig?: StepErrorConfig;
     /** Specifies the trigger function for this Flow, which returns a payload and optional HTTP response. */
-    onTrigger: TriggerPerformFunction<Inputs, ExtractConfigVars<TConfigPages>, false, TriggerResult<false, TTriggerPayload>>;
+    onTrigger?: ToComponentReferences<"trigger", TComponents, TConfigPages> | TriggerPerformFunction<Inputs, ExtractConfigVars<TConfigPages>, false, TriggerResult<false, TTriggerPayload>>;
     /** Specifies the function to execute when an Instance of this Integration is deployed. */
     onInstanceDeploy?: TriggerEventFunction<Inputs, ExtractConfigVars<TConfigPages>>;
     /** Specifies the function to execute when an Instance of an Integration is deleted. */
@@ -90,33 +91,49 @@ declare type BaseConfigVar = {
 /** Defines attributes of a standard Config Var. */
 export declare type StandardConfigVar = BaseConfigVar & {
     /** The data type of the Config Var. */
-    dataType: ConfigVarDataType;
+    dataType: Exclude<ConfigVarDataType, "schedule">;
     /** 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. */
-    scheduleType?: ScheduleType;
-    /** Optional value to use as a timezone if the Config Var is a schedule value. */
-    timeZone?: 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 & {
+    /** The data type of the Config Var. */
+    dataType: "schedule";
+    /** Optional default value for the Config Var. */
+    defaultValue?: string;
+    /** 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;
+    dataSource: ToComponentReferences<"dataSource", TComponents, ConfigPages<TComponents>>;
+};
 /** Defines attributes of a data source Config Var. */
-export declare type DataSourceConfigVar = BaseConfigVar & Omit<DataSourceDefinition<Inputs, ConfigVarResultCollection, DataSourceType>, "display" | "inputs" | "examplePayload">;
+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 & {
+    connection: ToComponentReferences<"connection", TComponents>;
+};
 /** Defines attributes of a Config Var that represents a Connection. */
-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>;
+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 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>;
+export declare const isConnectionDefinitionConfigVar: (cv: ConfigVar<any>) => cv is ConnectionDefinitionConfigVar;
+export declare const isConnectionReferenceConfigVar: <TComponents extends ComponentSelector<any>>(cv: ConfigVar<TComponents>) => cv is ConnectionReferenceConfigVar<TComponents>;
+export declare type ConfigPageElement<TComponents extends ComponentSelector<any>> = string | ConfigVar<TComponents>;
+export declare type ConfigPages<TComponents extends ComponentSelector<any>> = Record<string, ConfigPage<TComponents>>;
 /** Defines attributes of a Config Wizard Page used when deploying an Instance of an Integration. */
-export declare type ConfigPage = {
+export declare type ConfigPage<TComponents extends ComponentSelector<any>> = {
     /** Elements included on this Config Page. */
-    elements: Record<string, ConfigPageElement>;
+    elements: Record<string, ConfigPageElement<TComponents>>;
     /** Specifies an optional tagline for this Config Page. */
     tagline?: string;
 };
@@ -153,66 +170,52 @@ export declare type StepErrorConfig = {
     /** Specifies whether to ignore the final error after the final retry attempt. @default false */
     ignoreFinalError?: boolean;
 };
-/** Defines attributes of a Schedule that controls how often a Flow is automatically executed. */
-export declare type FlowSchedule = {
-    /** The cron expression to use for defining an execution schedule. */
-    cronExpression: string;
-    /** Specifies an optional value to use as the timezone. */
-    timeZone?: string;
-} | {
-    /** The key of the Config Var whose value will define the execution schedule. */
-    configVarKey: string;
-    /** Specifies an optional value to use as the timezone. */
-    timeZone?: string;
-};
 /** Choices of Endpoint Types that may be used by Instances of an Integration. */
-export declare enum EndpointType {
-    FlowSpecific = "flow_specific",
-    InstanceSpecific = "instance_specific",
-    SharedInstance = "shared_instance"
-}
+export declare type EndpointType = "flow_specific" | "instance_specific" | "shared_instance";
 /** Choices of Endpoint Security Types that may be used by endpoints of a Flow. */
-export declare enum EndpointSecurityType {
-    Unsecured = "unsecured",
-    CustomerOptional = "customer_optional",
-    CustomerRequired = "customer_required",
-    Organization = "organization"
-}
+export declare type EndpointSecurityType = "unsecured" | "customer_optional" | "customer_required" | "organization";
 /** Choices of Step Error Handlers that define the behavior when a step error occurs. */
-export declare enum StepErrorHandlerType {
-    Fail = "fail",
-    Ignore = "ignore",
-    Retry = "retry"
-}
-/** Choices for Schedules that add context for the cadence of a given schedule. */
-export declare enum ScheduleType {
-    None = "none",
-    Custom = "custom",
-    Minute = "minute",
-    Hour = "hour",
-    Day = "day",
-    Week = "week"
-}
+export declare type StepErrorHandlerType = "fail" | "ignore" | "retry";
 /** Supported data types for Config Vars. */
-export declare enum ConfigVarDataType {
-    String = "string",
-    Date = "date",
-    Timestamp = "timestamp",
-    Picklist = "picklist",
-    Schedule = "schedule",
-    Code = "code",
-    Boolean = "boolean",
-    Number = "number"
-}
+export declare type ConfigVarDataType = "string" | "date" | "timestamp" | "picklist" | "schedule" | "code" | "boolean" | "number";
 /** Choices of programming languages that may be used for Config Var code values. */
-export declare enum CodeLanguageType {
-    JSON = "json",
-    XML = "xml",
-    HTML = "html"
-}
+export declare type CodeLanguageType = "json" | "xml" | "html";
 /** Choices of collection types for multi-value Config Vars. */
-export declare enum CollectionType {
-    ValueList = "valuelist",
-    KeyValueList = "keyvaluelist"
+export declare type CollectionType = "valuelist" | "keyvaluelist";
+/** Choices of component reference types. */
+export declare type ComponentSelectorType = "trigger" | "connection" | "dataSource";
+export declare type ValueReference<TValueType, TConfigPages extends ConfigPages<any>, TConfigVarKeys = keyof ExtractConfigVars<TConfigPages>> = {
+    value: TValueType;
+} | (TConfigPages extends ConfigPages<any> ? {
+    configVar: TConfigVarKeys;
+} : never);
+export interface ComponentSelector<TValueType> {
+    type: ComponentSelectorType;
+    component: string | {
+        key: string;
+        isPublic: boolean;
+    };
+    key: string;
+    values?: {
+        [key: string]: TValueType;
+    };
+}
+export declare type ToComponentReferences<TReferenceType extends ComponentSelectorType, TComponents extends ComponentSelector<any>, TConfigPages extends ConfigPages<TComponents> = never> = TComponents extends ComponentSelector<infer TValueType> ? TComponents["type"] extends TReferenceType ? {
+    component: TComponents["component"];
+    key: TComponents["key"];
+    values: {
+        [K in keyof TComponents["values"]]: ValueReference<TValueType, TConfigPages>;
+    };
+} : never : never;
+export interface ComponentReference<TValueType, TConfigPages extends ConfigPages<any>> {
+    component: string | {
+        key: string;
+        isPublic: boolean;
+    };
+    key: string;
+    values?: {
+        [key: string]: ValueReference<TValueType, TConfigPages>;
+    };
 }
+export declare const isComponentReference: (ref: unknown) => ref is ComponentReference<any, ConfigPages<any>>;
 export {};

package/dist/types/IntegrationDefinition.js

@@ -1,64 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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) {
-    EndpointType["FlowSpecific"] = "flow_specific";
-    EndpointType["InstanceSpecific"] = "instance_specific";
-    EndpointType["SharedInstance"] = "shared_instance";
-})(EndpointType = exports.EndpointType || (exports.EndpointType = {}));
-/** Choices of Endpoint Security Types that may be used by endpoints of a Flow. */
-var EndpointSecurityType;
-(function (EndpointSecurityType) {
-    EndpointSecurityType["Unsecured"] = "unsecured";
-    EndpointSecurityType["CustomerOptional"] = "customer_optional";
-    EndpointSecurityType["CustomerRequired"] = "customer_required";
-    EndpointSecurityType["Organization"] = "organization";
-})(EndpointSecurityType = exports.EndpointSecurityType || (exports.EndpointSecurityType = {}));
-/** Choices of Step Error Handlers that define the behavior when a step error occurs. */
-var StepErrorHandlerType;
-(function (StepErrorHandlerType) {
-    StepErrorHandlerType["Fail"] = "fail";
-    StepErrorHandlerType["Ignore"] = "ignore";
-    StepErrorHandlerType["Retry"] = "retry";
-})(StepErrorHandlerType = exports.StepErrorHandlerType || (exports.StepErrorHandlerType = {}));
-/** Choices for Schedules that add context for the cadence of a given schedule. */
-var ScheduleType;
-(function (ScheduleType) {
-    ScheduleType["None"] = "none";
-    ScheduleType["Custom"] = "custom";
-    ScheduleType["Minute"] = "minute";
-    ScheduleType["Hour"] = "hour";
-    ScheduleType["Day"] = "day";
-    ScheduleType["Week"] = "week";
-})(ScheduleType = exports.ScheduleType || (exports.ScheduleType = {}));
-/** Supported data types for Config Vars. */
-var ConfigVarDataType;
-(function (ConfigVarDataType) {
-    ConfigVarDataType["String"] = "string";
-    ConfigVarDataType["Date"] = "date";
-    ConfigVarDataType["Timestamp"] = "timestamp";
-    ConfigVarDataType["Picklist"] = "picklist";
-    ConfigVarDataType["Schedule"] = "schedule";
-    ConfigVarDataType["Code"] = "code";
-    ConfigVarDataType["Boolean"] = "boolean";
-    ConfigVarDataType["Number"] = "number";
-})(ConfigVarDataType = exports.ConfigVarDataType || (exports.ConfigVarDataType = {}));
-/** Choices of programming languages that may be used for Config Var code values. */
-var CodeLanguageType;
-(function (CodeLanguageType) {
-    CodeLanguageType["JSON"] = "json";
-    CodeLanguageType["XML"] = "xml";
-    CodeLanguageType["HTML"] = "html";
-})(CodeLanguageType = exports.CodeLanguageType || (exports.CodeLanguageType = {}));
-/** Choices of collection types for multi-value Config Vars. */
-var CollectionType;
-(function (CollectionType) {
-    CollectionType["ValueList"] = "valuelist";
-    CollectionType["KeyValueList"] = "keyvaluelist";
-})(CollectionType = exports.CollectionType || (exports.CollectionType = {}));
+exports.isComponentReference = exports.isConnectionReferenceConfigVar = exports.isConnectionDefinitionConfigVar = exports.isDataSourceReferenceConfigVar = exports.isDataSourceDefinitionConfigVar = exports.isScheduleConfigVar = void 0;
+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);
+exports.isDataSourceReferenceConfigVar = isDataSourceReferenceConfigVar;
+const isConnectionDefinitionConfigVar = (cv) => "inputs" in cv;
+exports.isConnectionDefinitionConfigVar = isConnectionDefinitionConfigVar;
+const isConnectionReferenceConfigVar = (cv) => "connection" in cv && (0, exports.isComponentReference)(cv.connection);
+exports.isConnectionReferenceConfigVar = isConnectionReferenceConfigVar;
+const isComponentReference = (ref) => typeof ref === "object" && ref !== null && "key" in ref && "component" in ref;
+exports.isComponentReference = isComponentReference;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "8.0.7",
+  "version": "8.1.0-preview2",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"
@@ -42,7 +42,7 @@
     "axios-retry": "3.9.1",
     "date-fns": "2.30.0",
     "form-data": "4.0.0",
-    "jest-mock": "27.0.3",
+    "jest-mock": "29.7.0",
     "lodash": "4.17.21",
     "object-sizeof": "^2.6.4",
     "safe-stable-stringify": "2.3.1",
@@ -53,7 +53,7 @@
     "yaml": "2.3.4"
   },
   "devDependencies": {
-    "@types/jest": "27.4.1",
+    "@types/jest": "29.5.12",
     "@types/lodash": "4.14.202",
     "@types/node": "14.14.35",
     "@types/sax": "1.2.4",
@@ -64,13 +64,13 @@
     "@typescript-eslint/parser": "5.18.0",
     "eslint": "8.12.0",
     "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-jest": "26.1.3",
+    "eslint-plugin-jest": "27.9.0",
     "eslint-plugin-prettier": "4.0.0",
     "fast-check": "2.16.0",
-    "jest": "27.5.1",
+    "jest": "29.7.0",
     "prettier": "2.6.2",
-    "ts-jest": "27.0.3",
-    "tsd": "0.20.0",
+    "ts-jest": "29.1.2",
+    "tsd": "0.31.0",
     "typedoc": "0.17.7",
     "typedoc-plugin-markdown": "2.4.2",
     "typedoc-plugin-remove-references": "0.0.5",