@prismatic-io/spectral 10.13.0 → 10.15.0

package/dist/serverTypes/convertIntegration.d.ts

@@ -9,7 +9,7 @@ export declare const convertFlow: <TInputs extends Inputs, TActionInputs extends
 export declare const convertInputValue: (value: unknown, collectionType: CollectionType | undefined) => unknown;
 /** Converts a Config Var into the structure necessary for YAML generation. */
 export declare const convertConfigVar: (key: string, configVar: ConfigVar, referenceKey: string, componentRegistry: ComponentRegistry) => ServerRequiredConfigVariable;
-export declare const invokeTriggerComponentInput: (componentRef: ServerComponentReference, onTrigger: TriggerReference | undefined, eventName: "perform" | "onInstanceDeploy" | "onInstanceDelete") => {
+export declare const invokeTriggerComponentInput: (componentRef: ServerComponentReference, onTrigger: TriggerReference | undefined, eventName: "perform" | "onInstanceDeploy" | "onInstanceDelete" | "webhookCreate" | "webhookDelete") => {
     component: {
         key: string;
         version: number | "LATEST";
@@ -20,10 +20,10 @@ export declare const invokeTriggerComponentInput: (componentRef: ServerComponent
         isPublic: boolean;
     };
     key: string;
-    triggerEventFunctionName: "perform" | "onInstanceDeploy" | "onInstanceDelete";
+    triggerEventFunctionName: "perform" | "onInstanceDeploy" | "onInstanceDelete" | "webhookCreate" | "webhookDelete";
 };
 export type TriggerActionInvokeFunction = (ref: {
     component: ServerComponentReference["component"];
     key: string;
-    triggerEventFunctionName: "perform" | "onInstanceDeploy" | "onInstanceDelete";
+    triggerEventFunctionName: "perform" | "onInstanceDeploy" | "onInstanceDelete" | "webhookCreate" | "webhookDelete";
 }, context: ActionContext, payload: TriggerPayload | null, params: Record<string, unknown>) => Promise<TriggerResult>;

package/dist/serverTypes/convertIntegration.js

@@ -92,7 +92,7 @@ const convertConfigPages = (pages, userLevelConfigured) => {
         }) })));
 };
 exports.convertConfigPages = convertConfigPages;
-const codeNativeIntegrationYaml = ({ name, description, category, documentation, version, labels, endpointType, triggerPreprocessFlowConfig, flows, configPages, userLevelConfigPages, scopedConfigVars, instanceProfile = "Default Instance Profile", componentRegistry = {}, }, referenceKey, configVars, metadata) => {
+const codeNativeIntegrationYaml = ({ name, description, category, documentation, version, labels, endpointType, triggerPreprocessFlowConfig, flows, configPages, userLevelConfigPages, scopedConfigVars, instanceProfile, componentRegistry = {}, }, referenceKey, configVars, metadata) => {
     // 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.
@@ -125,29 +125,17 @@ const codeNativeIntegrationYaml = ({ name, description, category, documentation,
     // 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: integration_1.DefinitionVersion,
-        isCodeNative: true,
-        name,
+    const result = Object.assign(Object.assign({ definitionVersion: integration_1.DefinitionVersion, isCodeNative: true, name,
         description,
         category,
         documentation,
         version,
         labels,
         requiredConfigVars,
-        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) => (0, exports.convertFlow)(flow, componentRegistry, referenceKey)),
-        defaultInstanceProfile: instanceProfile,
-        configPages: [
+        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) => (0, exports.convertFlow)(flow, componentRegistry, referenceKey)) }, (instanceProfile && { defaultInstanceProfile: instanceProfile })), { configPages: [
             ...(0, exports.convertConfigPages)(configPages, false),
             ...(0, exports.convertConfigPages)(userLevelConfigPages, true),
-        ],
-        importMetadata: metadata,
-    };
+        ], importMetadata: metadata });
     return yaml_1.default.stringify(result);
 };
 const permissionAndVisibilityTypeValueMap = {
@@ -283,10 +271,13 @@ const codeNativeIntegrationComponentReference = (referenceKey) => ({
     isPublic: false,
 });
 /* A flow's trigger gets wrapped in a custom component if there's a defined
- * onTrigger function, or if any custom onInstance behavior is defined.
+ * onTrigger function, or if any custom onInstance or webhook lifecycle behavior is defined.
  * */
 const flowUsesWrapperTrigger = (flow) => {
-    return typeof flow.onTrigger === "function" || flow.onInstanceDelete || flow.onInstanceDeploy;
+    return (typeof flow.onTrigger === "function" ||
+        flow.onInstanceDelete ||
+        flow.onInstanceDeploy ||
+        flow.webhookLifecycleHandlers);
 };
 const convertFlowSchemas = (flowKey, schemas) => {
     return Object.entries(schemas).reduce((acc, [key, value]) => {
@@ -303,6 +294,7 @@ const convertFlow = (flow, componentRegistry, referenceKey) => {
     result.trigger = undefined;
     result.onInstanceDeploy = undefined;
     result.onInstanceDelete = undefined;
+    result.webhookLifecycleHandlers = undefined;
     result.onExecution = undefined;
     result.preprocessFlowConfig = undefined;
     result.errorConfig = undefined;
@@ -417,6 +409,22 @@ const convertInputValue = (value, collectionType) => {
     }));
 };
 exports.convertInputValue = convertInputValue;
+const validateOnPremConnectionConfig = (connection) => {
+    if ((0, types_1.isConnectionDefinitionConfigVar)(connection)) {
+        const hasOnPremControlledInputs = Object.values(connection.inputs).some((value) => {
+            return "onPremControlled" in value && value.onPremControlled;
+        });
+        const { onPremConnectionConfig: config } = connection;
+        if (hasOnPremControlledInputs && !config) {
+            throw new Error(`Connection ${connection.stableKey} has onPremControlled inputs but no onPremConnectionConfig value set. Please set an onPremConnectionConfig value for the connection.`);
+        }
+        if (!hasOnPremControlledInputs && config && config !== "disallowed") {
+            throw new Error(`Connection ${connection.stableKey} has onPremConnectionConfig set but no onPremControlled inputs. The connection will not be valid without onPremControlled inputs (host, port).`);
+        }
+        return hasOnPremControlledInputs && config ? config : "disallowed";
+    }
+    return "disallowed";
+};
 /** Converts a Config Var into the structure necessary for YAML generation. */
 const convertConfigVar = (key, configVar, referenceKey, componentRegistry) => {
     var _a, _b, _c;
@@ -437,6 +445,7 @@ const convertConfigVar = (key, configVar, referenceKey, componentRegistry) => {
             description,
             key,
             dataType: "connection",
+            onPremiseConnectionConfig: validateOnPremConnectionConfig(configVar),
             connection: {
                 key: (0, camelCase_1.default)(key),
                 component: codeNativeIntegrationComponentReference(referenceKey),
@@ -630,11 +639,12 @@ function generateTriggerPerformFn(params) {
             throw new Error(`Invalid trigger configuration detected: ${JSON.stringify(params, null, 2)}`);
     }
 }
-/** Generates a wrapper function that calls an existing component's onInstanceDeploy
- * or onInstanceDelete, then calls the flow-defined version if it exists.
+/** Generates a wrapper function that calls an existing component's trigger event function
+ * (onInstanceDeploy, onInstanceDelete, webhookCreate, or webhookDelete), then calls
+ * the flow-defined version if it exists.
  * Returns the deep-merged results of the two, prioritizing the custom response
  * if there's a conflict. */
-const generateOnInstanceWrapperFn = (componentRef, onTrigger, eventName, componentRegistry, customFn) => {
+const generateTriggerEventWrapperFn = (componentRef, onTrigger, eventName, componentRegistry, customFn) => {
     const usesComponentRef = componentRef && typeof onTrigger !== "function";
     if (usesComponentRef) {
         return (context, params) => __awaiter(void 0, void 0, void 0, function* () {
@@ -693,11 +703,12 @@ const codeNativeIntegrationComponent = ({ name, iconPath, description, flows = [
                 inputs: [],
             } });
     }, {});
-    const convertedTriggers = flows.reduce((result, { name, onTrigger, onInstanceDeploy, onInstanceDelete, schedule, triggerType }) => {
+    const convertedTriggers = flows.reduce((result, { name, onTrigger, onInstanceDeploy, onInstanceDelete, webhookLifecycleHandlers, schedule, triggerType, }) => {
         if (!flowUsesWrapperTrigger({
             onTrigger,
             onInstanceDelete,
             onInstanceDeploy,
+            webhookLifecycleHandlers,
         })) {
             // In this scenario, the user has defined an existing component trigger
             // without any custom behavior, so we don't need to wrap anything.
@@ -723,8 +734,10 @@ const codeNativeIntegrationComponent = ({ name, iconPath, description, flows = [
             componentRegistry,
             triggerType,
         });
-        const deleteFn = generateOnInstanceWrapperFn(ref, onTrigger, "onInstanceDelete", componentRegistry, onInstanceDelete);
-        const deployFn = generateOnInstanceWrapperFn(ref, onTrigger, "onInstanceDeploy", componentRegistry, onInstanceDeploy);
+        const deleteFn = generateTriggerEventWrapperFn(ref, onTrigger, "onInstanceDelete", componentRegistry, onInstanceDelete);
+        const deployFn = generateTriggerEventWrapperFn(ref, onTrigger, "onInstanceDeploy", componentRegistry, onInstanceDeploy);
+        const webhookCreateFn = generateTriggerEventWrapperFn(ref, onTrigger, "webhookCreate", componentRegistry, webhookLifecycleHandlers === null || webhookLifecycleHandlers === void 0 ? void 0 : webhookLifecycleHandlers.create);
+        const webhookDeleteFn = generateTriggerEventWrapperFn(ref, onTrigger, "webhookDelete", componentRegistry, webhookLifecycleHandlers === null || webhookLifecycleHandlers === void 0 ? void 0 : webhookLifecycleHandlers.delete);
         return Object.assign(Object.assign({}, result), { [key]: {
                 key,
                 display: {
@@ -736,6 +749,10 @@ const codeNativeIntegrationComponent = ({ name, iconPath, description, flows = [
                 hasOnInstanceDeploy: !!deployFn,
                 onInstanceDelete: deleteFn,
                 hasOnInstanceDelete: !!deleteFn,
+                webhookCreate: webhookCreateFn,
+                hasWebhookCreateFunction: !!webhookCreateFn,
+                webhookDelete: webhookDeleteFn,
+                hasWebhookDeleteFunction: !!webhookDeleteFn,
                 inputs: [],
                 scheduleSupport: triggerType === "polling" ? "required" : "valid",
                 synchronousResponseSupport: "valid",

package/dist/types/ConfigVars.d.ts

@@ -169,13 +169,14 @@ export type DataSourceConfigVar = DataSourceDefinitionConfigVar | DataSourceRefe
 type BaseConnectionConfigVar = BaseConfigVar & {
     dataType: "connection";
 };
+export type OnPremiseConnectionConfigTypeEnum = "allowed" | "disallowed" | "required";
 type ConnectionDefinitionConfigVar = ConnectionDefinition extends infer TConnectionDefinitionType extends ConnectionDefinition ? TConnectionDefinitionType extends infer TConnectionDefinition extends ConnectionDefinition ? BaseConnectionConfigVar & Omit<TConnectionDefinition, "inputs" | "display" | "key"> & {
     icons?: TConnectionDefinition["display"]["icons"];
+    onPremConnectionConfig?: OnPremiseConnectionConfigTypeEnum;
     inputs: {
         [Key in keyof TConnectionDefinition["inputs"]]: TConnectionDefinition["inputs"][Key] & ConfigVarInputVisibility;
     };
 } : never : never;
-type OnPremiseConnectionConfigTypeEnum = "allowed" | "disallowed" | "required";
 type ConnectionReferenceConfigVar = ComponentRegistryConnection extends infer TConnectionReference ? TConnectionReference extends ComponentRegistryConnection ? BaseConnectionConfigVar & {
     connection: TConnectionReference["reference"] & ("onPremAvailable" extends keyof TConnectionReference ? TConnectionReference["onPremAvailable"] extends true ? {
         template?: string;

package/dist/types/IntegrationDefinition.d.ts

@@ -61,7 +61,7 @@ export type IntegrationDefinition<TInputs extends Inputs = Inputs, TActionInputs
     /** Scoped ConfigVars for this integration. */
     scopedConfigVars?: ScopedConfigVarMap;
     /** Instance Profile used for this integration.
-     * @default "Default Instance Profile"
+     * If not specified, the tenant's default Instance Profile will be used.
      */
     instanceProfile?: string;
     /**
@@ -133,6 +133,16 @@ interface FlowBase<TTriggerPayload extends TriggerPayload = TriggerPayload> {
      * https://prismatic.io/docs/custom-connectors/triggers/#instance-deploy-and-delete-events-for-triggers
      */
     onInstanceDelete?: TriggerEventFunction<Inputs, ConfigVars>;
+    /**
+     * Optional webhook lifecycle handlers for create and delete operations. See
+     * https://prismatic.io/docs/custom-connectors/triggers/#webhook-lifecycle-events
+     */
+    webhookLifecycleHandlers?: {
+        /** Function to execute to configure a webhook. */
+        create: TriggerEventFunction<Inputs, ConfigVars>;
+        /** Function to execute for webhook teardown. */
+        delete: TriggerEventFunction<Inputs, ConfigVars>;
+    };
     /** Specifies the main function for this flow which is run when this flow is invoked. */
     onExecution: FlowOnExecution<TTriggerPayload>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "10.13.0",
+  "version": "10.15.0",
   "description": "Utility library for building Prismatic connectors and code-native integrations",
   "keywords": ["prismatic"],
   "main": "dist/index.js",