@prismatic-io/spectral 9.0.0 → 9.0.2

package/dist/types/IntegrationDefinition.d.ts

@@ -1,6 +1,6 @@
 import { ActionPerformFunction, ActionPerformReturn, TriggerEventFunction, TriggerPerformFunction, Inputs, TriggerResult, TriggerPayload, ComponentRegistry, TriggerReference, ConfigVars, ConfigPages, UserLevelConfigPages, ValueExpression, ConfigVarExpression } from ".";
 /** Defines attributes of a Code-Native Integration. */
-export declare type IntegrationDefinition = {
+export type IntegrationDefinition = {
     /** The unique name for this Integration. */
     name: string;
     /** Optional description for this Integration. */
@@ -74,7 +74,7 @@ export interface Flow<TTriggerPayload extends TriggerPayload = TriggerPayload> {
     }, false, ActionPerformReturn<false, unknown>>;
 }
 /** Defines attributes of a Preprocess Flow Configuration used by a Flow of an Integration. */
-export declare type PreprocessFlowConfig = {
+export type PreprocessFlowConfig = {
     /** Name of the field in the data payload returned by the Preprocess Flow to use for a Flow Name. */
     flowNameField: string;
     /** Optional name of the field in the data payload returned by the Preprocess Flow to use for an External Customer Id. */
@@ -83,7 +83,7 @@ export declare type PreprocessFlowConfig = {
     externalCustomerUserIdField?: string;
 };
 /** Defines attributes of a Retry Configuration used by a Flow of an Integration. */
-export declare type RetryConfig = {
+export type RetryConfig = {
     /** The maximum number of retry attempts. Must be between 0 and 10. */
     maxAttempts: number;
     /** The delay in minutes to wait between retry attempts. Must be between 0 and 60. */
@@ -94,7 +94,7 @@ export declare type RetryConfig = {
     uniqueRequestIdField?: string;
 };
 /** Defines attributes of a Step Error Configuration used to determine how to handle errors during Flow step execution. */
-export declare type StepErrorConfig = {
+export type StepErrorConfig = {
     /** Defines the type of error handler. */
     errorHandlerType: StepErrorHandlerType;
     /** The maximum number of retry attempts. Must be between 0 and 5. */
@@ -107,8 +107,8 @@ export declare type StepErrorConfig = {
     ignoreFinalError?: boolean;
 };
 /** Choices of Endpoint Types that may be used by Instances of an Integration. */
-export declare type EndpointType = "flow_specific" | "instance_specific" | "shared_instance";
+export type EndpointType = "flow_specific" | "instance_specific" | "shared_instance";
 /** Choices of Endpoint Security Types that may be used by endpoints of a Flow. */
-export declare type EndpointSecurityType = "unsecured" | "customer_optional" | "customer_required" | "organization";
+export type EndpointSecurityType = "unsecured" | "customer_optional" | "customer_required" | "organization";
 /** Choices of Step Error Handlers that define the behavior when a step error occurs. */
-export declare type StepErrorHandlerType = "fail" | "ignore" | "retry";
+export type StepErrorHandlerType = "fail" | "ignore" | "retry";

package/dist/types/TriggerDefinition.d.ts

@@ -1,6 +1,6 @@
 import { ActionDisplayDefinition, TriggerPerformFunction, TriggerEventFunction, Inputs, TriggerResult, ConfigVarResultCollection, TriggerPayload } from ".";
 declare const optionChoices: readonly ["invalid", "valid", "required"];
-export declare type TriggerOptionChoice = typeof optionChoices[number];
+export type TriggerOptionChoice = (typeof optionChoices)[number];
 export declare const TriggerOptionChoices: TriggerOptionChoice[];
 /**
  * TriggerDefinition is the type of the object that is passed in to `trigger` function to

package/dist/types/TriggerEventFunction.d.ts

@@ -1,5 +1,5 @@
 import { Inputs, ActionContext, ActionInputParameters, ConfigVarResultCollection } from ".";
-export declare type TriggerEventFunctionReturn = {
+export type TriggerEventFunctionReturn = {
     /** An optional object, the keys and values of which will be persisted in the flow-specific instanceState and available for subsequent actions and executions */
     instanceState?: Record<string, unknown>;
     /** An optional object, the keys and values of which will be persisted in the crossFlowState and available in any flow for subsequent actions and executions */
@@ -10,4 +10,4 @@ export declare type TriggerEventFunctionReturn = {
     integrationState?: Record<string, unknown>;
 };
 /** Definition of the function to execute when a Trigger Event occurs. */
-export declare type TriggerEventFunction<TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection> = (context: ActionContext<TConfigVars>, params: ActionInputParameters<TInputs>) => Promise<void | TriggerEventFunctionReturn>;
+export type TriggerEventFunction<TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection> = (context: ActionContext<TConfigVars>, params: ActionInputParameters<TInputs>) => Promise<TriggerEventFunctionReturn | void>;

package/dist/types/TriggerPerformFunction.d.ts

@@ -1,3 +1,3 @@
 import { Inputs, TriggerResult, ActionInputParameters, ActionContext, TriggerPayload, ConfigVarResultCollection } from ".";
 /** Definition of the function to perform when a Trigger is invoked. */
-export declare type TriggerPerformFunction<TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TAllowsBranching extends boolean | undefined, TResult extends TriggerResult<TAllowsBranching, TriggerPayload>> = (context: ActionContext<TConfigVars>, payload: TriggerPayload, params: ActionInputParameters<TInputs>) => Promise<TResult>;
+export type TriggerPerformFunction<TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TAllowsBranching extends boolean | undefined, TResult extends TriggerResult<TAllowsBranching, TriggerPayload>> = (context: ActionContext<TConfigVars>, payload: TriggerPayload, params: ActionInputParameters<TInputs>) => Promise<TResult>;

package/dist/types/TriggerResult.d.ts

@@ -25,4 +25,4 @@ export interface TriggerBranchingResult<TPayload extends TriggerPayload> extends
     branch: string;
 }
 /** Required return type of all trigger perform functions */
-export declare type TriggerResult<AllowsBranching extends boolean | undefined, TPayload extends TriggerPayload> = (AllowsBranching extends true ? TriggerBranchingResult<TPayload> : TriggerBaseResult<TPayload>) | undefined;
+export type TriggerResult<AllowsBranching extends boolean | undefined, TPayload extends TriggerPayload> = (AllowsBranching extends true ? TriggerBranchingResult<TPayload> : TriggerBaseResult<TPayload>) | undefined;

package/dist/types/utils.d.ts

@@ -1,5 +1,5 @@
-export declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
-export declare type Prettify<T> = {
+export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+export type Prettify<T> = {
     [K in keyof T]: T[K];
 };
-export declare type ValueOf<T> = T[keyof T];
+export type ValueOf<T> = T[keyof T];

package/dist/util.d.ts

@@ -29,13 +29,13 @@ export declare const toObject: (value: unknown) => object;
 declare const _default: {
     types: {
         isBool: (value: unknown) => value is boolean;
-        toBool: (value: unknown, defaultValue?: boolean | undefined) => boolean;
+        toBool: (value: unknown, defaultValue?: boolean) => boolean;
         isInt: (value: unknown) => value is number;
-        toInt: (value: unknown, defaultValue?: number | undefined) => number;
+        toInt: (value: unknown, defaultValue?: number) => number;
         isNumber: (value: unknown) => boolean;
-        toNumber: (value: unknown, defaultValue?: number | undefined) => number;
+        toNumber: (value: unknown, defaultValue?: number) => number;
         isBigInt: (value: unknown) => value is bigint;
-        toBigInt: (value: unknown) => BigInt;
+        toBigInt: (value: unknown) => bigint;
         isDate: (value: unknown) => value is Date;
         toDate: (value: unknown) => Date;
         isUrl: (value: string) => boolean;
@@ -45,7 +45,7 @@ declare const _default: {
         toData: (value: unknown) => DataPayload;
         isString: (value: unknown) => value is string;
         toString: (value: unknown, defaultValue?: string) => string;
-        keyValPairListToObject: <TValue = unknown>(kvpList: KeyValuePair<unknown>[], valueConverter?: ((value: unknown) => TValue) | undefined) => Record<string, TValue>;
+        keyValPairListToObject: <TValue = unknown>(kvpList: KeyValuePair<unknown>[], valueConverter?: (value: unknown) => TValue) => Record<string, TValue>;
         isJSON: (value: string) => boolean;
         toJSON: (value: unknown, prettyPrint?: boolean, retainKeyOrder?: boolean) => string;
         lowerCaseHeaders: (headers: Record<string, string>) => Record<string, string>;
@@ -60,7 +60,7 @@ declare const _default: {
         isConnection: (value: unknown) => value is ConnectionDefinition;
         isElement: (value: unknown) => value is Element;
         toObject: (value: unknown) => object;
-        cleanObject: (obj: Record<string, unknown>, predicate?: ((v: any) => boolean) | undefined) => Record<string, unknown>;
+        cleanObject: (obj: Record<string, unknown>, predicate?: (v: any) => boolean) => Record<string, unknown>;
     };
 };
 export default _default;

package/dist/util.js

@@ -44,8 +44,7 @@ const isObjectSelection = (value) => {
     if (typeof value === "string" && isJSON(value)) {
         return isObjectSelection(JSON.parse(value));
     }
-    return (Array.isArray(value) &&
-        value.every((item) => (0, exports.isObjectWithTruthyKeys)(item, ["object"])));
+    return Array.isArray(value) && value.every((item) => (0, exports.isObjectWithTruthyKeys)(item, ["object"]));
 };
 /**
  * This function coerces a provided value into an ObjectSelection if possible.
@@ -331,7 +330,7 @@ const keyValPairListToObject = (kvpList, valueConverter) => {
  * @param value The value to test
  * @returns This function returns true if `value` is a DataPayload object, and false otherwise.
  */
-const isBufferDataPayload = (value) => value instanceof Object && "data" in value && Buffer.isBuffer(value["data"]);
+const isBufferDataPayload = (value) => value instanceof Object && "data" in value && Buffer.isBuffer(value.data);
 /**
  * Many libraries for third-party API that handle binary files expect `Buffer` objects.
  * This function helps to convert strings, Uint8Arrays, and Arrays to a data structure
@@ -428,16 +427,10 @@ const isConnection = (value) => {
     if (Boolean(value) && typeof value === "object") {
         const { inputs } = value;
         if ((0, exports.isObjectWithTruthyKeys)(value, ["key", "label", "oauth2Type"])) {
-            return ((0, exports.isObjectWithTruthyKeys)(inputs, [
-                "authorizeUrl",
-                "tokenUrl",
-                "clientId",
-                "clientSecret",
-            ]) ||
+            return ((0, exports.isObjectWithTruthyKeys)(inputs, ["authorizeUrl", "tokenUrl", "clientId", "clientSecret"]) ||
                 (0, exports.isObjectWithTruthyKeys)(inputs, ["tokenUrl", "clientId", "clientSecret"]));
         }
-        return ((0, exports.isObjectWithTruthyKeys)(value, ["key", "label"]) &&
-            typeof inputs === "object");
+        return (0, exports.isObjectWithTruthyKeys)(value, ["key", "label"]) && typeof inputs === "object";
     }
     return false;
 };

package/package.json

@@ -1,10 +1,8 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "9.0.0",
+  "version": "9.0.2",
   "description": "Utility library for building Prismatic components",
-  "keywords": [
-    "prismatic"
-  ],
+  "keywords": ["prismatic"],
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "homepage": "https://prismatic.io",
@@ -30,17 +28,15 @@
     "dev": "tsc -w",
     "postbuild": "yarn run build:templates",
     "prepack": "yarn run build",
-    "format": "yarn run lint-fix && prettier --loglevel error --write 'src/**/*.ts' '*.{ts,js,json}' '!sidebars.{js,jse}'",
-    "check-format": "prettier --check 'src/**/*.ts' '*.{ts,js,json}' '!sidebars.{js,jse}'",
+    "lint": "biome lint .",
+    "lint-fix": "biome lint --apply-unsafe .",
+    "format": "yarn run lint-fix && biome format --write .",
+    "check-format": "biome format .",
     "check": "yarn run check-format && yarn run lint",
-    "lint": "eslint --ext .ts .",
-    "lint-fix": "eslint --fix --ext .ts .",
     "test": "jest",
     "docs": "rm -f sidebars.{js,jse} && typedoc"
   },
-  "files": [
-    "dist/"
-  ],
+  "files": ["dist/"],
   "dependencies": {
     "@jsonforms/core": "3.0.0",
     "axios": "1.6.2",
@@ -52,7 +48,6 @@
     "jest-mock": "29.7.0",
     "lodash": "4.17.21",
     "object-sizeof": "^2.6.4",
-    "prettier": "2.6.2",
     "safe-stable-stringify": "2.3.1",
     "serialize-error": "8.1.0",
     "url-join": "5.0.0",
@@ -61,29 +56,23 @@
     "yaml": "2.3.4"
   },
   "devDependencies": {
+    "@biomejs/biome": "1.6.3",
     "@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/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",
-    "@typescript-eslint/eslint-plugin": "5.18.0",
-    "@typescript-eslint/parser": "5.18.0",
     "copyfiles": "2.4.1",
-    "eslint": "8.12.0",
-    "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-jest": "27.9.0",
-    "eslint-plugin-prettier": "4.0.0",
     "fast-check": "2.16.0",
     "jest": "29.7.0",
     "ts-jest": "29.1.2",
     "typedoc": "0.17.7",
     "typedoc-plugin-markdown": "2.4.2",
     "typedoc-plugin-remove-references": "0.0.5",
-    "typescript": "4.6.3"
+    "typescript": "5.5.3"
   }
 }