@prismatic-io/spectral 10.6.7 → 10.8.0

package/dist/generators/cniComponentManifest/index.js

@@ -123,7 +123,7 @@ const fetchComponentDataForManifest = (_a) => __awaiter(void 0, [_a], void 0, fu
         };
     });
     return {
-        key: componentKey,
+        key: component.key,
         signature: component.signature,
         public: !isPrivate,
         display: {

package/dist/generators/componentManifest/createTriggers.js

@@ -49,6 +49,7 @@ const createTriggers = (_a) => __awaiter(void 0, [_a], void 0, function* ({ comp
                 label: trigger.display.description,
                 description: trigger.display.description,
                 inputs,
+                componentKey: component.key,
             },
             dryRun,
             imports,

package/dist/generators/componentManifest/templates/actions/action.ts.ejs

@@ -17,7 +17,7 @@ export const <%= action.import %> = {
     values: <%= action.typeInterface %>Values
   ): Promise<TReturn> => {
     const context = requireContext();
-    return await context.components.<%= helpers.camelCase(action.componentKey) %>.<%= action.key %>({ ...values }) as TReturn;
+    return await context.components.<%= helpers.camelCase(action.componentKey) %>.<%= action.import %>({ ...values }) as TReturn;
   },
   inputs: {
     <%- include('../partials/inputs.ejs', { inputs: action.inputs, helpers }) -%>

package/dist/generators/componentManifest/templates/connections/connection.ts.ejs

@@ -10,6 +10,7 @@ export interface <%= connection.typeInterface %>Values {
  * <%= connection.label %>
  *
  * @comments <%- connection.comments %>
+ * This object is used to support type hinting.
  */
 export const <%= connection.import %> = {
   key: "<%= connection.key %>",
@@ -27,7 +28,7 @@ export const <%= connection.import %> = {
 /**
  * <%= connection.label %> Connection Helper
  *
- * @comments Helper for direct usage in config wizard definitions.
+ * @comments This wrapper function can be used directly in config wizard definitions.
  */
 export const <%= helpers.camelCase(connection.componentKey) %><%= helpers.capitalizeFirstLetter(helpers.camelCase(connection.key)) %> = (
   stableKey: string,

package/dist/generators/componentManifest/templates/dataSources/dataSource.ts.ejs

@@ -10,6 +10,7 @@ export interface <%= dataSource.typeInterface %>Values {
  * <%= dataSource.label %>
  *
  * @description <%- dataSource.description %>
+ * This object is used to support type hinting.
  */
 export const <%= dataSource.import %> = {
   key: "<%= dataSource.key %>",
@@ -25,7 +26,7 @@ export const <%= dataSource.import %> = {
 /**
  * <%= dataSource.label %> DataSource Helper
  *
- * @comments Helper for direct usage in config wizard definitions.
+ * @comments This wrapper function can be used directly in config wizard definitions.
  */
 export const <%= helpers.camelCase(dataSource.componentKey) %><%= helpers.capitalizeFirstLetter(helpers.camelCase(dataSource.key)) %> = (
   stableKey: string,

package/dist/generators/componentManifest/templates/triggers/trigger.ts.ejs

@@ -1,5 +1,6 @@
 <%- include('../partials/generatedHeader.ejs') -%>
 <%- include('../partials/imports.ejs', { imports, helpers }) %>
+import { ConfigVarExpression } from "@prismatic-io/spectral";
 
 export interface <%= trigger.typeInterface %>Values {
 <%- include('../partials/performArgs.ejs', { inputs: trigger.inputs, helpers }) -%>
@@ -9,6 +10,7 @@ export interface <%= trigger.typeInterface %>Values {
  * <%= trigger.label %>
  *
  * @description <%- trigger.description %>
+ * This object is used to support type hinting.
  */
 export const <%= trigger.import %> = {
   key: "<%= trigger.key %>",
@@ -18,4 +20,23 @@ export const <%= trigger.import %> = {
   inputs: {
     <%- include('../partials/inputs.ejs', { inputs: trigger.inputs, helpers }) -%>
   }
-} as const;
+} as const;
+
+/**
+ * <%= trigger.label %> Trigger Helper
+ *
+ * @comments This wrapper function can be used directly in flow definitions.
+ */
+export const <%= helpers.camelCase(trigger.componentKey) %><%= helpers.capitalizeFirstLetter(trigger.import) %> = (values: {
+  <% trigger.inputs.forEach((input) => { -%>
+    <%- helpers.formatType(input.key) %><%= input.required ? "" : "?" %>: ({
+      value: <%- input.valueType.type ? input.valueType.type : input.valueType %>;
+    } | ConfigVarExpression);
+  <% }); -%>
+}) => {
+  return {
+    component: "<%= helpers.camelCase(trigger.componentKey) %>",
+    key: "<%= trigger.key %>",
+    values,
+  } as const;
+};

package/dist/serverTypes/convertComponent.js

@@ -82,6 +82,7 @@ const convertAction = (actionKey, _a, hooks) => {
 const convertTrigger = (triggerKey, trigger, hooks) => {
     var _a;
     const { onInstanceDeploy, onInstanceDelete } = trigger;
+    const webhookLifecycleHandlers = "webhookLifecycleHandlers" in trigger ? trigger.webhookLifecycleHandlers : undefined;
     const inputs = (_a = trigger.inputs) !== null && _a !== void 0 ? _a : {};
     const isPollingTrigger = (0, PollingTriggerDefinition_1.isPollingTriggerDefinition)(trigger);
     const triggerInputKeys = Object.keys(inputs);
@@ -119,11 +120,11 @@ const convertTrigger = (triggerKey, trigger, hooks) => {
             errorHandler: hooks === null || hooks === void 0 ? void 0 : hooks.error,
         });
     }
-    const result = Object.assign(Object.assign({}, trigger), { key: triggerKey, inputs: convertedTriggerInputs.concat(convertedActionInputs), perform: performToUse, scheduleSupport, synchronousResponseSupport: "synchronousResponseSupport" in trigger
+    const result = Object.assign(Object.assign(Object.assign({}, trigger), { key: triggerKey, inputs: convertedTriggerInputs.concat(convertedActionInputs), perform: performToUse, scheduleSupport, synchronousResponseSupport: "synchronousResponseSupport" in trigger
             ? trigger.synchronousResponseSupport
             : scheduleSupport === "invalid"
                 ? "valid"
-                : "invalid" });
+                : "invalid" }), (isPollingTrigger ? { isPollingTrigger: true } : {}));
     if (onInstanceDeploy) {
         result.onInstanceDeploy = (0, perform_1.createPerform)(onInstanceDeploy, {
             inputCleaners: triggerInputCleaners,
@@ -138,7 +139,19 @@ const convertTrigger = (triggerKey, trigger, hooks) => {
         });
         result.hasOnInstanceDelete = true;
     }
-    const { pollAction, triggerType } = result, resultTrigger = __rest(result, ["pollAction", "triggerType"]);
+    if (webhookLifecycleHandlers) {
+        result.webhookCreate = (0, perform_1.createPerform)(webhookLifecycleHandlers.create, {
+            inputCleaners: triggerInputCleaners,
+            errorHandler: hooks === null || hooks === void 0 ? void 0 : hooks.error,
+        });
+        result.webhookDelete = (0, perform_1.createPerform)(webhookLifecycleHandlers.delete, {
+            inputCleaners: triggerInputCleaners,
+            errorHandler: hooks === null || hooks === void 0 ? void 0 : hooks.error,
+        });
+        result.hasWebhookCreateFunction = true;
+        result.hasWebhookDeleteFunction = true;
+    }
+    const { pollAction, triggerType, webhookLifecycleHandlers: _ } = result, resultTrigger = __rest(result, ["pollAction", "triggerType", "webhookLifecycleHandlers"]);
     return resultTrigger;
 };
 exports.convertTrigger = convertTrigger;

package/dist/serverTypes/convertIntegration.js

@@ -287,13 +287,8 @@ const flowUsesWrapperTrigger = (flow) => {
 };
 const convertFlowSchemas = (flowKey, schemas) => {
     return Object.entries(schemas).reduce((acc, [key, value]) => {
-        acc[key] = {
-            title: value.title || `${flowKey}-${key}`,
-            type: "object",
-            $comment: value.$comment,
-            properties: value.properties,
-            $schema: value.$schema || types_1.DEFAULT_JSON_SCHEMA_VERSION,
-        };
+        var _a;
+        acc[key] = Object.assign({ title: value.title || `${flowKey}-${key}`, type: "object", $comment: value.$comment, properties: value.properties, $schema: value.$schema || types_1.DEFAULT_JSON_SCHEMA_VERSION }, (((_a = value.required) === null || _a === void 0 ? void 0 : _a.length) ? { required: value.required } : {}));
         return acc;
     }, {});
 };

package/dist/serverTypes/index.d.ts

@@ -143,10 +143,19 @@ export interface Trigger {
     hasOnInstanceDeploy?: boolean;
     onInstanceDelete?: TriggerEventFunction;
     hasOnInstanceDelete?: boolean;
+    webhookLifecycleHandlers?: {
+        create: TriggerEventFunction;
+        delete: TriggerEventFunction;
+    };
+    webhookCreate?: TriggerEventFunction;
+    hasWebhookCreateFunction?: boolean;
+    webhookDelete?: TriggerEventFunction;
+    hasWebhookDeleteFunction?: boolean;
     scheduleSupport: TriggerOptionChoice;
     synchronousResponseSupport: TriggerOptionChoice;
     examplePayload?: unknown;
     isCommonTrigger?: boolean;
+    isPollingTrigger?: boolean;
 }
 export interface DataSourceContext<TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection> {
     logger: ActionLogger;

package/dist/types/FlowSchemas.d.ts

@@ -1,6 +1,6 @@
 interface FlowSchemaProperty {
     description: string;
-    type: string;
+    type?: string;
 }
 export declare const DEFAULT_JSON_SCHEMA_VERSION = "https://json-schema.org/draft/2020-12/schema";
 /** Flow definition schemas require fewer fields than the actual FlowSchema
@@ -10,6 +10,7 @@ export type FlowDefinitionFlowSchema = {
     $comment?: string;
     $schema?: string;
     properties: Record<string, FlowSchemaProperty>;
+    required?: string[];
 };
 export interface FlowSchema {
     title: string;
@@ -17,6 +18,7 @@ export interface FlowSchema {
     $schema: string;
     type: string;
     properties: Record<string, FlowSchemaProperty>;
+    required?: string[];
 }
 export interface FlowSchemas {
     [key: string]: {

package/dist/types/TriggerDefinition.d.ts

@@ -26,6 +26,13 @@ export interface TriggerDefinition<TInputs extends Inputs = Inputs, TConfigVars
      * https://prismatic.io/docs/custom-connectors/triggers/#instance-deploy-and-delete-events-for-triggers
      */
     onInstanceDelete?: TriggerEventFunction<TInputs, TConfigVars>;
+    /** Optional webhook lifecycle handlers for create, read, and delete operations. */
+    webhookLifecycleHandlers?: {
+        /** Function to execute to configure a webhook. */
+        create: TriggerEventFunction<TInputs, TConfigVars>;
+        /** Function to execute for webhook teardown. */
+        delete: TriggerEventFunction<TInputs, TConfigVars>;
+    };
     /**
      * The inputs to present a low-code integration builder. Values of these inputs
      * are passed to the `perform` function when the trigger is invoked.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "10.6.7",
+  "version": "10.8.0",
   "description": "Utility library for building Prismatic connectors and code-native integrations",
   "keywords": ["prismatic"],
   "main": "dist/index.js",
@@ -38,7 +38,7 @@
   },
   "files": ["dist/"],
   "dependencies": {
-    "axios": "1.8.3",
+    "axios": "1.12.2",
     "axios-retry": "4.5.0",
     "date-fns": "2.30.0",
     "ejs": "^3.1.10",