@prismatic-io/spectral 10.15.0 → 10.16.2

package/dist/clients/http/index.d.ts

@@ -11,7 +11,10 @@ interface RetryConfig extends Omit<IAxiosRetryConfig, "retryDelay"> {
      * a retryCondition function to determine when retries should occur.
      */
     retryAllErrors?: boolean;
-    /** When true, double the retry delay after each attempt (e.g. 1000ms, 2000ms, 4000ms, 8000ms, etc.). */
+    /**
+     * When true, double the retryDelay after each attempt (e.g. 1000ms, 2000ms, 4000ms, 8000ms, etc.).
+     * If no retryDelay is specified, defaults to axios-retry's exponentialDelay function.
+     */
     useExponentialBackoff?: boolean;
 }
 export interface ClientProps {
@@ -30,6 +33,7 @@ export interface ClientProps {
     /** Configuration used to determine if and how failed HTTP requests should be retried. */
     retryConfig?: RetryConfig;
 }
+export declare const toAxiosRetryConfig: ({ retryDelay, retryAllErrors, retryCondition, useExponentialBackoff, ...rest }: RetryConfig) => IAxiosRetryConfig;
 /**
  * Creates a reusable Axios HTTP client. See
  * https://prismatic.io/docs/custom-connectors/connections/#using-the-built-in-createclient-http-client

package/dist/clients/http/index.js

@@ -46,7 +46,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.inputs = exports.buildRawRequestAction = exports.sendRawRequest = exports.handleErrors = exports.createClient = void 0;
+exports.inputs = exports.buildRawRequestAction = exports.sendRawRequest = exports.handleErrors = exports.createClient = exports.toAxiosRetryConfig = void 0;
 const isEmpty_1 = __importDefault(require("lodash/isEmpty"));
 const axios_1 = __importDefault(require("axios"));
 const axios_retry_1 = __importStar(require("axios-retry"));
@@ -84,8 +84,11 @@ const toFormData = (formData, fileData, fileDataFileNames = {}) => {
 };
 const computeRetryDelay = (retryDelay, useExponentialBackoff) => {
     if (useExponentialBackoff) {
-        return axios_retry_1.exponentialDelay;
+        return typeof retryDelay === "number"
+            ? (retryCount) => Math.pow(2, (retryCount - 1)) * retryDelay
+            : axios_retry_1.exponentialDelay;
     }
+    // retryDelay is either a number or a function
     return typeof retryDelay === "number" ? () => retryDelay : retryDelay;
 };
 const toAxiosRetryConfig = (_a) => {
@@ -96,6 +99,7 @@ const toAxiosRetryConfig = (_a) => {
                 ? retryCondition
                 : axios_retry_1.isNetworkOrIdempotentRequestError }));
 };
+exports.toAxiosRetryConfig = toAxiosRetryConfig;
 /**
  * Creates a reusable Axios HTTP client. See
  * https://prismatic.io/docs/custom-connectors/connections/#using-the-built-in-createclient-http-client
@@ -141,7 +145,7 @@ const createClient = ({ baseUrl, responseType, headers, timeout, params, debug =
     }
     if (retryConfig) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        (0, axios_retry_1.default)(client, toAxiosRetryConfig(retryConfig));
+        (0, axios_retry_1.default)(client, (0, exports.toAxiosRetryConfig)(retryConfig));
     }
     return client;
 };

package/dist/serverTypes/context.js

@@ -81,10 +81,7 @@ function createDebugContext(context) {
         },
         memoryUsage: (actionContext, label, showDetail) => {
             if (globalDebug) {
-                const usage = showDetail
-                    ? memoryUsageInMB()
-                    : // @ts-expect-error: memoryUsage.rss() is documented but not typed
-                        node_process_1.memoryUsage.rss() / MEMORY_USAGE_CONVERSION;
+                const usage = showDetail ? memoryUsageInMB() : node_process_1.memoryUsage.rss() / MEMORY_USAGE_CONVERSION;
                 actionContext.debug.results.memoryUsage.push({
                     mark: label,
                     rss: typeof usage === "number" ? usage : usage.rss,

package/dist/serverTypes/convertIntegration.d.ts

@@ -1,8 +1,12 @@
-import { IntegrationDefinition, ConfigVar, Flow, ConfigPages, ComponentRegistry, TriggerReference, CollectionType, Inputs, TriggerResult as TriggerPerformResult, ConfigVarResultCollection } from "../types";
+import { IntegrationDefinition, ConfigVar, Flow, ConfigPages, ComponentRegistry, TriggerReference, CollectionType, Inputs, TriggerResult as TriggerPerformResult, ConfigVarResultCollection, QueueConfig, StandardQueueConfig } from "../types";
 import { Component as ServerComponent, ActionContext, TriggerPayload, TriggerResult } from ".";
 import { RequiredConfigVariable as ServerRequiredConfigVariable, ConfigPage as ServerConfigPage, ComponentReference as ServerComponentReference } from "./integration";
+export declare const CONCURRENCY_LIMIT_MAX = 15;
+export declare const CONCURRENCY_LIMIT_MIN = 2;
 export declare const convertIntegration: <TInputs extends Inputs, TActionInputs extends Inputs, TPayload extends TriggerPayload = TriggerPayload, TAllowsBranching extends boolean = boolean, TResult extends TriggerPerformResult<TAllowsBranching, TPayload> = TriggerPerformResult<TAllowsBranching, TPayload>>(definition: IntegrationDefinition<TInputs, TActionInputs, TPayload, TAllowsBranching, TResult>) => ServerComponent<TInputs, TActionInputs, ConfigVarResultCollection, TPayload, TAllowsBranching, TResult>;
 export declare const convertConfigPages: (pages: ConfigPages | undefined, userLevelConfigured: boolean) => ServerConfigPage[];
+/** Converts typed QueueConfig to legacy format with usesFifoQueue and concurrencyLimit. */
+export declare const convertQueueConfig: (queueConfig: QueueConfig) => StandardQueueConfig;
 /** Converts a Flow into the structure necessary for YAML generation. */
 export declare const convertFlow: <TInputs extends Inputs, TActionInputs extends Inputs, TPayload extends TriggerPayload = TriggerPayload, TAllowsBranching extends boolean = boolean, TResult extends TriggerPerformResult<TAllowsBranching, TPayload> = TriggerPerformResult<TAllowsBranching, TPayload>>(flow: Flow<TInputs, TActionInputs, TPayload, TAllowsBranching, TResult>, componentRegistry: ComponentRegistry, referenceKey: string) => Record<string, unknown>;
 /** Converts an input value to the expected server type by its collection type. */

package/dist/serverTypes/convertIntegration.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.invokeTriggerComponentInput = exports.convertConfigVar = exports.convertInputValue = exports.convertFlow = exports.convertConfigPages = exports.convertIntegration = void 0;
+exports.invokeTriggerComponentInput = exports.convertConfigVar = exports.convertInputValue = exports.convertFlow = exports.convertQueueConfig = exports.convertConfigPages = exports.convertIntegration = exports.CONCURRENCY_LIMIT_MIN = exports.CONCURRENCY_LIMIT_MAX = void 0;
 const yaml_1 = __importDefault(require("yaml"));
 const uuid_1 = require("uuid");
 const assign_1 = __importDefault(require("lodash/assign"));
@@ -27,6 +27,8 @@ const context_1 = require("./context");
 const asyncContext_1 = require("./asyncContext");
 const path_1 = __importDefault(require("path"));
 const fs_1 = require("fs");
+exports.CONCURRENCY_LIMIT_MAX = 15;
+exports.CONCURRENCY_LIMIT_MIN = 2;
 const convertIntegration = (definition) => {
     var _a, _b, _c;
     // Generate a unique reference key that will be used to reference the
@@ -279,6 +281,30 @@ const flowUsesWrapperTrigger = (flow) => {
         flow.onInstanceDeploy ||
         flow.webhookLifecycleHandlers);
 };
+/** Converts typed QueueConfig to legacy format with usesFifoQueue and concurrencyLimit. */
+const convertQueueConfig = (queueConfig) => {
+    if (!("type" in queueConfig)) {
+        return queueConfig;
+    }
+    switch (queueConfig.type) {
+        case "parallel":
+            return { usesFifoQueue: false };
+        case "throttled":
+            return {
+                usesFifoQueue: true,
+                concurrencyLimit: queueConfig.concurrencyLimit,
+                dedupeIdField: queueConfig.dedupeIdField,
+            };
+        case "sequential":
+            return {
+                usesFifoQueue: true,
+                dedupeIdField: queueConfig.dedupeIdField,
+            };
+        default:
+            return queueConfig;
+    }
+};
+exports.convertQueueConfig = convertQueueConfig;
 const convertFlowSchemas = (flowKey, schemas) => {
     return Object.entries(schemas).reduce((acc, [key, value]) => {
         var _a;
@@ -356,7 +382,7 @@ const convertFlow = (flow, componentRegistry, referenceKey) => {
         throw new Error(`${flow.name} is marked as a polling trigger but has no schedule. Polling triggers require a schedule.`);
     }
     if ("queueConfig" in flow && typeof flow.queueConfig === "object") {
-        const { queueConfig } = flow;
+        const queueConfig = (0, exports.convertQueueConfig)(flow.queueConfig);
         if (hasSchedule && queueConfig.usesFifoQueue) {
             throw new Error(`${flow.name} has a schedule & usesFifoQueue set to true. FIFO queues cannot be used with scheduled flows.`);
         }
@@ -367,8 +393,9 @@ const convertFlow = (flow, componentRegistry, referenceKey) => {
             throw new Error(`${flow.name} is configured for both FIFO queues and singleton executions, but these options are mutually exclusive. Please choose one.`);
         }
         if (queueConfig.concurrencyLimit !== undefined &&
-            (queueConfig.concurrencyLimit < 2 || queueConfig.concurrencyLimit > 10)) {
-            throw new Error(`${flow.name} has an invalid concurrencyLimit of ${queueConfig.concurrencyLimit}. concurrencyLimit must be between 2 and 10.`);
+            (queueConfig.concurrencyLimit < exports.CONCURRENCY_LIMIT_MIN ||
+                queueConfig.concurrencyLimit > exports.CONCURRENCY_LIMIT_MAX)) {
+            throw new Error(`${flow.name} has an invalid concurrencyLimit of ${queueConfig.concurrencyLimit}. concurrencyLimit must be between ${exports.CONCURRENCY_LIMIT_MIN} and ${exports.CONCURRENCY_LIMIT_MAX}.`);
         }
         result.queueConfig = Object.assign(Object.assign({ usesFifoQueue: false }, queueConfig), (queueConfig.dedupeIdField
             ? {

package/dist/types/IntegrationDefinition.d.ts

@@ -198,16 +198,35 @@ export type RetryConfig = {
     uniqueRequestIdField?: string;
 };
 /** Defines attributes of a queue configuration used by a flow of an integration. */
-export type QueueConfig = {
+export type StandardQueueConfig = {
     /** Determines whether the flow should be executed using FIFO ordering. Not valid for synchronous or scheduled flows. */
     usesFifoQueue?: boolean;
     /** Reference to the field in the flow's trigger return payload; used to determine whether to queue the execution. */
     dedupeIdField?: string;
     /** Determines whether the flow should be setup for singleton executions. Only valid for scheduled/polling trigger-based flows. */
     singletonExecutions?: boolean;
-    /** The maximum number of concurrent executions for this flow. Must be between 2 and 10. */
+    /** The maximum number of concurrent executions for this flow. Must be between 2 and 15. */
     concurrencyLimit?: number;
 };
+export type ParallelQueueConfig = {
+    /** No limits. All requests processed simultaneously. */
+    type: "parallel";
+};
+export type ThrottledQueueConfig = {
+    /** Set the max concurrent executions per instance. */
+    type: "throttled";
+    /** The maximum number of concurrent executions for this flow. Must be between 2 and 15. */
+    concurrencyLimit?: number;
+    /** Reference to the field in the flow's trigger return payload; used to determine whether to queue the execution. */
+    dedupeIdField?: string;
+};
+export type SequentialQueueConfig = {
+    /** Processed one at a time, in order received. */
+    type: "sequential";
+    /** Reference to the field in the flow's trigger return payload; used to determine whether to queue the execution. */
+    dedupeIdField?: string;
+};
+export type QueueConfig = ParallelQueueConfig | ThrottledQueueConfig | SequentialQueueConfig | StandardQueueConfig;
 /** Defines attributes of a step error configuration used to determine how to handle errors during flow step execution. */
 export type StepErrorConfig = {
     /** Defines the type of error handler. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "10.15.0",
+  "version": "10.16.2",
   "description": "Utility library for building Prismatic connectors and code-native integrations",
   "keywords": ["prismatic"],
   "main": "dist/index.js",
@@ -34,18 +34,20 @@
     "format": "yarn run lint-fix && biome format --write .",
     "check-format": "biome format .",
     "check": "yarn run check-format && yarn run lint",
-    "test": "jest"
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:ui": "vitest --ui"
   },
   "files": ["dist/"],
   "dependencies": {
-    "axios": "1.12.2",
+    "axios": "1.13.5",
     "axios-retry": "4.5.0",
     "date-fns": "2.30.0",
     "ejs": "^3.1.10",
     "form-data": "4.0.4",
     "fs-extra": "^11.2.0",
     "jest-mock": "29.7.0",
-    "lodash": "4.17.21",
+    "lodash": "4.17.23",
     "object-sizeof": "^2.6.4",
     "prettier": "2.6.2",
     "safe-stable-stringify": "2.3.1",
@@ -57,20 +59,20 @@
   },
   "devDependencies": {
     "@biomejs/biome": "1.6.3",
+    "@fast-check/vitest": "^0.2.4",
     "@types/ejs": "3.1.5",
     "@types/fs-extra": "11.0.4",
-    "@types/jest": "29.5.12",
-    "@types/lodash": "4.17.0",
-    "@types/node": "14.14.35",
+    "@types/lodash": "4.17.23",
+    "@types/node": "^22.19.7",
     "@types/prettier": "2.6.2",
     "@types/sax": "1.2.4",
     "@types/url-join": "4.0.1",
     "@types/uuid": "8.3.4",
     "@types/valid-url": "1.0.3",
+    "@vitest/ui": "^4.0.18",
     "copyfiles": "2.4.1",
-    "fast-check": "2.16.0",
-    "jest": "29.7.0",
-    "ts-jest": "29.1.2",
-    "typescript": "5.5.3"
+    "fast-check": "^4.5.3",
+    "typescript": "5.5.3",
+    "vitest": "^4.0.18"
   }
 }