@prismatic-io/spectral 8.0.0 → 8.0.2

package/dist/index.d.ts

@@ -3,8 +3,9 @@
  * 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, ConfigVar, ConfigVarResultCollection, ConfigVarCollection, TriggerPayload } from "./types";
-import { convertComponent, convertIntegration } from "./serverTypes/convert";
+import { ActionDefinition, InputFieldDefinition, ComponentDefinition, DefaultConnectionDefinition, OAuth2ConnectionDefinition, Inputs, TriggerDefinition, ActionPerformReturn, TriggerResult, DataSourceDefinition, IntegrationDefinition, Flow, ConfigPage, StandardConfigVar, ConnectionConfigVar, ConfigVarResultCollection, TriggerPayload, DataSourceConfigVar, ConfigPages } from "./types";
+import { convertComponent } from "./serverTypes/convert";
+import { convertIntegration } from "./serverTypes/convertIntegration";
 /**
  * This function creates a Integration object that can be
  * imported into the Prismatic API. For information on using
@@ -13,21 +14,21 @@ import { convertComponent, convertIntegration } from "./serverTypes/convert";
  * @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: <TConfigVar extends Record<string, ConfigVar> = Record<string, ConfigVar>>(definition: IntegrationDefinition<TConfigVar>) => ReturnType<typeof convertIntegration>;
+export declare const integration: <TConfigPages extends ConfigPages = ConfigPages>(definition: IntegrationDefinition<TConfigPages>) => 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: <TConfigVars extends ConfigVarCollection = ConfigVarCollection, TTriggerPayload extends TriggerPayload = TriggerPayload, T extends Flow<TConfigVars, TTriggerPayload> = Flow<TConfigVars, TTriggerPayload>>(definition: T) => T;
+export declare const flow: <TConfigPages extends ConfigPages = ConfigPages, TTriggerPayload extends TriggerPayload = TriggerPayload, T extends Flow<TConfigPages, TTriggerPayload> = Flow<TConfigPages, 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<ConfigVarCollection>>(definition: T) => T;
+export declare const configPage: <T extends ConfigPage>(definition: T) => T;
 /**
  * For information on writing Code Native Integrations, see
  * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
@@ -35,6 +36,13 @@ export declare const configPage: <T extends ConfigPage<ConfigVarCollection>>(def
  * @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;
+/**
+ * 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;
 /**
  * For information on writing Code Native Integrations, see
  * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
@@ -80,7 +88,7 @@ export declare const trigger: <TInputs extends Inputs, TConfigVar extends Config
  * @param definition A DataSourceDefinition type object that includes UI display information, a function to perform when the data source is invoked, and a an object containing inputs for the perform function.
  * @returns This function validates the shape of the `definition` object provided, and returns the same data source object.
  */
-export declare const dataSource: <TInputs extends Inputs, TDataSourceType extends keyof {
+export declare const dataSource: <TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TDataSourceType extends keyof {
     string: string;
     date: string;
     timestamp: string;
@@ -89,14 +97,12 @@ export declare const dataSource: <TInputs extends Inputs, TDataSourceType extend
         value: string;
     };
     code: string;
-    credential: unknown;
     boolean: boolean;
     number: number;
-    connection: import("./types").Connection;
     objectSelection: import("./types").ObjectSelection;
     objectFieldMap: import("./types").ObjectFieldMap;
     jsonForm: import("./types").JSONForm;
-}>(definition: DataSourceDefinition<TInputs, TDataSourceType>) => DataSourceDefinition<TInputs, TDataSourceType>;
+}>(definition: DataSourceDefinition<TInputs, TConfigVars, TDataSourceType>) => DataSourceDefinition<TInputs, TConfigVars, TDataSourceType>;
 /**
  * For information and examples on how to write inputs
  * for custom component actions and triggers, see

package/dist/index.js

@@ -22,8 +22,9 @@ 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.connection = exports.input = exports.dataSource = exports.trigger = exports.action = exports.component = exports.connectionConfigVar = exports.configVar = exports.configPage = exports.flow = exports.integration = void 0;
+exports.testing = exports.util = exports.oauth2Connection = 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;
 const convert_1 = require("./serverTypes/convert");
+const convertIntegration_1 = require("./serverTypes/convertIntegration");
 /**
  * This function creates a Integration object that can be
  * imported into the Prismatic API. For information on using
@@ -32,7 +33,7 @@ const convert_1 = require("./serverTypes/convert");
  * @param definition An IntegrationDefinition type object.
  * @returns This function returns an integration object that has the shape the Prismatic API expects.
  */
-const integration = (definition) => (0, convert_1.convertIntegration)(definition);
+const integration = (definition) => (0, convertIntegration_1.convertIntegration)(definition);
 exports.integration = integration;
 /**
  * For information on writing Code Native Integrations, see
@@ -58,6 +59,14 @@ exports.configPage = configPage;
  */
 const configVar = (definition) => definition;
 exports.configVar = configVar;
+/**
+ * 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.
+ */
+const dataSourceConfigVar = (definition) => definition;
+exports.dataSourceConfigVar = dataSourceConfigVar;
 /**
  * For information on writing Code Native Integrations, see
  * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.

package/dist/serverTypes/convert.d.ts

@@ -1,4 +1,4 @@
-import { ComponentDefinition, IntegrationDefinition } from "../types";
-import { Component as ServerComponent } from ".";
+import { InputFieldDefinition, ComponentDefinition } 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 convertComponent: <TPublic extends boolean, TKey extends string>({ connections, actions, triggers, dataSources, hooks, ...definition }: ComponentDefinition<TPublic, TKey>) => ServerComponent;
-export declare const convertIntegration: (definition: IntegrationDefinition) => ServerComponent;

package/dist/serverTypes/convert.js

@@ -10,13 +10,8 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertIntegration = exports.convertComponent = void 0;
-const yaml_1 = __importDefault(require("yaml"));
-const uuid_1 = require("uuid");
+exports.convertComponent = exports.convertInput = void 0;
 const types_1 = require("../types");
 const perform_1 = require("./perform");
 const convertInput = (key, _a) => {
@@ -27,9 +22,10 @@ const convertInput = (key, _a) => {
     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 });
 };
+exports.convertInput = convertInput;
 const convertAction = (actionKey, _a, hooks) => {
     var { inputs = {}, perform } = _a, action = __rest(_a, ["inputs", "perform"]);
-    const convertedInputs = Object.entries(inputs).map(([key, value]) => convertInput(key, value));
+    const convertedInputs = Object.entries(inputs).map(([key, value]) => (0, exports.convertInput)(key, value));
     const inputCleaners = Object.entries(inputs).reduce((result, [key, { clean }]) => (Object.assign(Object.assign({}, result), { [key]: clean })), {});
     return Object.assign(Object.assign({}, action), { key: actionKey, inputs: convertedInputs, perform: (0, perform_1.createPerform)(perform, {
             inputCleaners,
@@ -38,7 +34,7 @@ const convertAction = (actionKey, _a, hooks) => {
 };
 const convertTrigger = (triggerKey, _a, hooks) => {
     var { inputs = {}, perform, onInstanceDeploy, onInstanceDelete } = _a, trigger = __rest(_a, ["inputs", "perform", "onInstanceDeploy", "onInstanceDelete"]);
-    const convertedInputs = Object.entries(inputs).map(([key, value]) => convertInput(key, value));
+    const convertedInputs = Object.entries(inputs).map(([key, value]) => (0, exports.convertInput)(key, value));
     const inputCleaners = Object.entries(inputs).reduce((result, [key, { clean }]) => (Object.assign(Object.assign({}, result), { [key]: clean })), {});
     const result = Object.assign(Object.assign({}, trigger), { key: triggerKey, inputs: convertedInputs, perform: (0, perform_1.createPerform)(perform, {
             inputCleaners,
@@ -62,7 +58,7 @@ const convertTrigger = (triggerKey, _a, hooks) => {
 };
 const convertDataSource = (dataSourceKey, _a, hooks) => {
     var { inputs = {}, perform } = _a, dataSource = __rest(_a, ["inputs", "perform"]);
-    const convertedInputs = Object.entries(inputs).map(([key, value]) => convertInput(key, value));
+    const convertedInputs = Object.entries(inputs).map(([key, value]) => (0, exports.convertInput)(key, value));
     const inputCleaners = Object.entries(inputs).reduce((result, [key, { clean }]) => (Object.assign(Object.assign({}, result), { [key]: clean })), {});
     return Object.assign(Object.assign({}, dataSource), { key: dataSourceKey, inputs: convertedInputs, perform: (0, perform_1.createPerform)(perform, {
             inputCleaners,
@@ -71,7 +67,7 @@ const convertDataSource = (dataSourceKey, _a, hooks) => {
 };
 const convertConnection = (_a) => {
     var { inputs = {} } = _a, connection = __rest(_a, ["inputs"]);
-    const convertedInputs = Object.entries(inputs).map(([key, value]) => convertInput(key, value));
+    const convertedInputs = Object.entries(inputs).map(([key, value]) => (0, exports.convertInput)(key, value));
     return Object.assign(Object.assign({}, connection), { inputs: convertedInputs });
 };
 const convertComponent = (_a) => {
@@ -82,247 +78,3 @@ const convertComponent = (_a) => {
     return Object.assign(Object.assign({}, definition), { connections: connections.map(convertConnection), actions: convertedActions, triggers: convertedTriggers, dataSources: convertedDataSources });
 };
 exports.convertComponent = convertComponent;
-const convertIntegration = (definition) => {
-    // Generate a unique reference key that will be used to reference the
-    // actions, triggers, data sources, and connections that are created
-    // inline as part of the integration definition.
-    const referenceKey = (0, uuid_1.v4)();
-    return Object.assign(Object.assign({}, codeNativeIntegrationComponent(definition, referenceKey)), { codeNativeIntegrationYAML: codeNativeIntegrationYaml(definition, referenceKey) });
-};
-exports.convertIntegration = convertIntegration;
-const codeNativeIntegrationYaml = ({ name, description, category, documentation, version, labels, configVars, endpointType, triggerPreprocessFlowConfig, flows, configPages, }, referenceKey) => {
-    const DEFINITION_VERSION = 7;
-    // Find the preprocess flow config on the flow, if one exists.
-    const preprocessFlows = flows.filter((flow) => flow.preprocessFlowConfig);
-    // Do some validation of preprocess flow configs.
-    if (preprocessFlows.length > 1) {
-        throw new Error("Only one flow may define a Preprocess Flow Config.");
-    }
-    if (preprocessFlows.length && triggerPreprocessFlowConfig) {
-        throw new Error("Integration must not define both a Trigger Preprocess Flow Config and a Preprocess Flow.");
-    }
-    const hasPreprocessFlow = preprocessFlows.length > 0;
-    const preprocessFlowConfig = hasPreprocessFlow
-        ? preprocessFlows[0].preprocessFlowConfig
-        : triggerPreprocessFlowConfig;
-    if ([types_1.EndpointType.InstanceSpecific, types_1.EndpointType.SharedInstance].includes(endpointType || types_1.EndpointType.FlowSpecific) &&
-        !preprocessFlowConfig) {
-        throw new Error("Integration with specified EndpointType must define either a Trigger Preprocess Flow Config or a Preprocess Flow.");
-    }
-    // Transform the IntegrationDefinition into the structure that is appropriate
-    // for generating YAML, which will then be used by the Prismatic API to import
-    // the integration as a Code Native Integration.
-    const result = {
-        definitionVersion: DEFINITION_VERSION,
-        isCodeNative: true,
-        name,
-        description,
-        category,
-        documentation,
-        version,
-        labels,
-        requiredConfigVars: Object.entries(configVars || {}).map(([key, configVar]) => convertConfigVar(Object.assign(Object.assign({}, configVar), { key }), referenceKey)),
-        endpointType,
-        preprocessFlowName: hasPreprocessFlow ? preprocessFlows[0].name : undefined,
-        externalCustomerIdField: fieldNameToReferenceInput(hasPreprocessFlow ? "onExecution" : "payload", preprocessFlowConfig === null || preprocessFlowConfig === void 0 ? void 0 : preprocessFlowConfig.externalCustomerIdField),
-        externalCustomerUserIdField: fieldNameToReferenceInput(hasPreprocessFlow ? "onExecution" : "payload", preprocessFlowConfig === null || preprocessFlowConfig === void 0 ? void 0 : preprocessFlowConfig.externalCustomerUserIdField),
-        flowNameField: fieldNameToReferenceInput(hasPreprocessFlow ? "onExecution" : "payload", preprocessFlowConfig === null || preprocessFlowConfig === void 0 ? void 0 : preprocessFlowConfig.flowNameField),
-        flows: flows.map((flow) => convertFlow(flow, referenceKey)),
-        configPages,
-    };
-    return yaml_1.default.stringify(result);
-};
-/** Converts a Flow into the structure necessary for YAML generation. */
-const convertFlow = (flow, referenceKey) => {
-    const result = Object.assign({}, flow);
-    delete result.onTrigger;
-    delete result.trigger;
-    delete result.onInstanceDeploy;
-    delete result.onInstanceDelete;
-    delete result.onExecution;
-    delete result.preprocessFlowConfig;
-    delete result.errorConfig;
-    const triggerStep = {
-        name: "On Trigger",
-        stableKey: `${flow.stableKey}-onTrigger`,
-        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 ("schedule" in flow && typeof flow.schedule === "object") {
-        triggerStep.schedule = {
-            type: "cronExpression" in flow.schedule
-                ? types_1.SimpleInputValueType.Value
-                : types_1.SimpleInputValueType.ConfigVar,
-            value: "cronExpression" in flow.schedule
-                ? flow.schedule.cronExpression
-                : flow.schedule.configVarKey,
-            meta: {
-                scheduleType: types_1.ScheduleType.Custom,
-                timeZone: flow.schedule.timeZone,
-            },
-        };
-        delete result.schedule;
-    }
-    const actionStep = {
-        action: {
-            key: flowFunctionKey(flow.name, "onExecution"),
-            component: { key: referenceKey, version: "LATEST", isPublic: false },
-        },
-        name: "On Execution",
-        stableKey: `${flow.stableKey}-onExecution`,
-        description: "The function that will be executed by the flow.",
-        errorConfig: "errorConfig" in flow ? Object.assign({}, flow.errorConfig) : undefined,
-    };
-    result.steps = [triggerStep, actionStep];
-    return result;
-};
-/** Converts a Config Var into the structure necessary for YAML generation. */
-const convertConfigVar = (configVar, referenceKey) => {
-    // This is unfortunate but we need to strip out some fields that are not
-    // relevant to config vars.
-    const fields = [
-        "key",
-        "stableKey",
-        "description",
-        "orgOnly",
-        "inputs",
-        "defaultValue",
-        "dataType",
-        "pickList",
-        "scheduleType",
-        "timeZone",
-        "codeLanguage",
-        "collectionType",
-        "dataSource",
-    ];
-    const result = Object.entries(configVar).reduce((result, [key, value]) => {
-        if (!fields.includes(key)) {
-            return result;
-        }
-        return Object.assign(Object.assign({}, result), { [key]: value });
-    }, { meta: {} });
-    // Handle some non-standard fields.
-    if ("visibleToOrgDeployer" in configVar) {
-        result.meta.visibleToOrgDeployer = configVar.visibleToOrgDeployer;
-    }
-    if ("visibleToCustomerDeployer" in configVar) {
-        result.meta.visibleToCustomerDeployer = configVar.visibleToCustomerDeployer;
-    }
-    // Handle connections.
-    if ("label" in configVar) {
-        result.dataType = "connection";
-        // This refers to a connection we are creating.
-        result.connection = {
-            key: configVar.key,
-            component: { key: referenceKey, version: "LATEST", isPublic: false },
-        };
-        result.description = configVar.label;
-        // Convert connection inputs to the inputs expected in the YAML.
-        // FIXME: This is just a placeholder for now.
-        // TODO: It seems like using the default value as the value is probably correct?
-        result.inputs = Object.entries(configVar.inputs).reduce((result, [key, input]) => {
-            var _a;
-            return Object.assign(Object.assign({}, result), { [key]: {
-                    type: types_1.SimpleInputValueType.Value,
-                    value: (_a = input.default) !== null && _a !== void 0 ? _a : "",
-                } });
-        }, {});
-    }
-    // Handle data source references.
-    if ("dataSource" in result) {
-        // This is a reference to a data source we are creating.
-        result.dataSource = {
-            key: result.dataSource,
-            component: { key: referenceKey, version: "LATEST", isPublic: false },
-        };
-    }
-    return result;
-};
-/** Maps the step name field to a fully qualified input. */
-const fieldNameToReferenceInput = (stepName, fieldName) => {
-    if (!fieldName) {
-        return undefined;
-    }
-    return {
-        type: types_1.SimpleInputValueType.Reference,
-        value: `${stepName}.results.${fieldName}`,
-    };
-};
-/** Actions and Triggers will be scoped to their flow by combining the flow
- *  name and the function name. This is to ensure that the keys are unique
- *  on the resulting object, which will be turned into a Component. */
-const flowFunctionKey = (flowName, functionName) => {
-    const flowKey = flowName
-        .replace(/[^0-9a-zA-Z]+/g, " ")
-        .trim()
-        .split(" ")
-        .map((w, i) => i === 0
-        ? w.toLowerCase()
-        : w.charAt(0).toUpperCase() + w.slice(1).toLowerCase())
-        .join("");
-    return `${flowKey}_${functionName}`;
-};
-/** Creates the structure necessary to import a Component as part of a
- *  Code Native integration. */
-const codeNativeIntegrationComponent = ({ name, iconPath, description, flows = [], dataSources = {}, configVars = {}, }, referenceKey) => {
-    const convertedActions = flows.reduce((result, { name, onExecution }) => {
-        const actionKey = flowFunctionKey(name, "onExecution");
-        return Object.assign(Object.assign({}, result), { [actionKey]: convertAction(actionKey, {
-                display: {
-                    label: `${name} - onExecution`,
-                    description: "The function that will be executed by the flow.",
-                },
-                perform: onExecution,
-                inputs: {},
-            }) });
-    }, {});
-    const convertedTriggers = flows.reduce((result, flow) => {
-        // Filter out TriggerReferences.
-        if ("trigger" in flow)
-            return result;
-        const { name, onTrigger, onInstanceDeploy, onInstanceDelete } = flow;
-        const triggerKey = flowFunctionKey(name, "onTrigger");
-        return Object.assign(Object.assign({}, result), { [triggerKey]: convertTrigger(triggerKey, {
-                display: {
-                    label: `${name} - onTrigger`,
-                    description: "The function that will be executed by the flow to return an HTTP response.",
-                },
-                perform: onTrigger,
-                onInstanceDeploy: onInstanceDeploy,
-                onInstanceDelete: onInstanceDelete,
-                inputs: {},
-                scheduleSupport: "valid",
-                synchronousResponseSupport: "valid",
-            }) });
-    }, {});
-    const convertedDataSources = Object.entries(dataSources).reduce((result, [dataSourceKey, dataSource]) => (Object.assign(Object.assign({}, result), { [dataSourceKey]: convertDataSource(dataSourceKey, Object.assign(Object.assign({}, dataSource), { inputs: {} })) })), {});
-    const convertedConnections = Object.entries(configVars).reduce((result, [key, configVar]) => {
-        if (!("label" in configVar)) {
-            return result;
-        }
-        // Remove a few fields that are not relevant to connections.
-        const { 
-        /* eslint-disable @typescript-eslint/no-unused-vars */
-        orgOnly, visibleToOrgDeployer, visibleToCustomerDeployer, stableKey } = configVar, 
-        /* eslint-enable @typescript-eslint/no-unused-vars */
-        connection = __rest(configVar, ["orgOnly", "visibleToOrgDeployer", "visibleToCustomerDeployer", "stableKey"]);
-        return [...result, convertConnection(Object.assign(Object.assign({}, connection), { key }))];
-    }, []);
-    return {
-        key: referenceKey,
-        display: {
-            label: referenceKey,
-            iconPath,
-            description: description || name,
-        },
-        connections: convertedConnections,
-        actions: convertedActions,
-        triggers: convertedTriggers,
-        dataSources: convertedDataSources,
-    };
-};

package/dist/serverTypes/convertIntegration.d.ts

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