@prismatic-io/spectral 5.3.0 → 6.1.0

package/dist/util.d.ts

@@ -3,8 +3,13 @@
  * Many functions in the `util` module are used to coerce data into a particular type, and can be accessed through `util.types`.
  * For example, `util.types.toInt("5.5")` will return an integer, `5`.
  */
-import { DataPayload } from "./types/server-types";
-import { KeyValuePair } from "./types";
+import { KeyValuePair, DataPayload } from "./types";
+/** This function accepts an arbitrary object/value and safely serializes it (handles cyclic references).
+ *
+ * @param value Arbitrary object/value to serialize.
+ * @returns JSON serialized text that can be safely logged.
+ */
+export declare const toJSON: (value: unknown) => string;
 /**
  * This function returns a lower cased version of the headers passed to it.
  *
@@ -33,8 +38,9 @@ declare const _default: {
         isData: (value: unknown) => boolean;
         toData: (value: unknown) => DataPayload;
         toString: (value: unknown, defaultValue?: string) => string;
-        keyValPairListToObject: (kvpList?: KeyValuePair<unknown>[]) => Record<string, unknown>;
+        keyValPairListToObject: <TValue = unknown>(kvpList?: KeyValuePair<unknown>[], valueConverter?: ((value: unknown) => TValue) | undefined) => Record<string, TValue>;
         isJSON: (value: string) => boolean;
+        toJSON: (value: unknown) => string;
         lowerCaseHeaders: (headers: Record<string, string>) => Record<string, string>;
     };
     docs: {

package/dist/util.js

@@ -8,11 +8,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lowerCaseHeaders = void 0;
+exports.lowerCaseHeaders = exports.toJSON = void 0;
 /** */
 const parseISO_1 = __importDefault(require("date-fns/parseISO"));
 const isValid_1 = __importDefault(require("date-fns/isValid"));
 const isDate_1 = __importDefault(require("date-fns/isDate"));
+const safe_stable_stringify_1 = require("safe-stable-stringify");
 const valid_url_1 = require("valid-url");
 /**
  * Determine if a variable is a boolean (true or false).
@@ -152,7 +153,7 @@ const toBigInt = (value) => {
     }
 };
 /** This function returns true if `value` is a variable of type `Date`, and false otherwise. */
-const isDate = (value) => isDate_1.default(value);
+const isDate = (value) => (0, isDate_1.default)(value);
 /**
  * This function parses an ISO date if possible, or throws an error if the value provided
  * cannot be coerced into a Date object.
@@ -168,8 +169,8 @@ const toDate = (value) => {
         return value;
     }
     if (typeof value === "string") {
-        const dt = parseISO_1.default(value);
-        if (isValid_1.default(dt)) {
+        const dt = (0, parseISO_1.default)(value);
+        if ((0, isValid_1.default)(dt)) {
             return dt;
         }
     }
@@ -185,7 +186,7 @@ const toDate = (value) => {
  * @param value The URL to test.
  * @returns This function returns true if `value` is a valid URL, and false otherwise.
  */
-const isUrl = (value) => valid_url_1.isWebUri(value) !== undefined;
+const isUrl = (value) => (0, valid_url_1.isWebUri)(value) !== undefined;
 /**
  * This function helps to transform key-value lists to objects.
  * This is useful for transforming inputs that are key-value collections into objects.
@@ -194,9 +195,10 @@ const isUrl = (value) => valid_url_1.isWebUri(value) !== undefined;
  * If that array were passed into `util.types.keyValPairListToObject()`, an object would be returned of the form
  * `{foo: "bar", baz: 5}`.
  * @param kvpList An array of objects with `key` and `value` properties.
+ * @param valueConverter Optional function to call for each `value`.
  */
-const keyValPairListToObject = (kvpList = []) => {
-    return kvpList.reduce((result, { key, value }) => (Object.assign(Object.assign({}, result), { [key]: value })), {});
+const keyValPairListToObject = (kvpList = [], valueConverter) => {
+    return kvpList.reduce((result, { key, value }) => (Object.assign(Object.assign({}, result), { [key]: valueConverter ? valueConverter(value) : value })), {});
 };
 /**
  * This function tests if the object provided is a Prismatic `DataPayload` object.
@@ -311,6 +313,16 @@ const isJSON = (value) => {
         return false;
     }
 };
+/** This function accepts an arbitrary object/value and safely serializes it (handles cyclic references).
+ *
+ * @param value Arbitrary object/value to serialize.
+ * @returns JSON serialized text that can be safely logged.
+ */
+const toJSON = (value) => {
+    const stringify = (0, safe_stable_stringify_1.configure)({ circularValue: undefined });
+    return stringify(value, null, 2);
+};
+exports.toJSON = toJSON;
 /**
  * This function returns a lower cased version of the headers passed to it.
  *
@@ -344,6 +356,7 @@ exports.default = {
         toString,
         keyValPairListToObject,
         isJSON,
+        toJSON: exports.toJSON,
         lowerCaseHeaders: exports.lowerCaseHeaders,
     },
     docs: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "5.3.0",
+  "version": "6.1.0",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"
@@ -15,6 +15,10 @@
     "type": "git",
     "url": "https://github.com/prismatic-io/spectral.git"
   },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
   "license": "MIT",
   "scripts": {
     "clean": "rm -rf dist",
@@ -23,68 +27,51 @@
     "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}'",
     "check": "yarn run check-format && yarn run lint",
-    "lint": "eslint --ext .ts,.js src/",
-    "lint-fix": "eslint --fix --ext .ts,.js src/",
+    "lint": "eslint --ext .ts .",
+    "lint-fix": "eslint --fix --ext .ts .",
     "test": "jest --maxWorkers=4",
+    "tsd": "tsd",
     "docs": "rm -f sidebars.{js,jse} && typedoc"
   },
   "files": [
     "dist/"
   ],
   "dependencies": {
-    "axios": "0.24.0",
-    "date-fns": "2.17.0",
+    "axios": "0.26.1",
+    "axios-retry": "3.2.4",
+    "date-fns": "2.28.0",
     "jest-mock": "27.0.3",
     "soap": "0.43.0",
-    "uuid": "8.3.1",
-    "valid-url": "1.0.9"
+    "uuid": "8.3.2",
+    "valid-url": "1.0.9",
+    "url-join": "5.0.0",
+    "safe-stable-stringify": "2.3.1",
+    "serialize-error": "8.1.0"
   },
   "devDependencies": {
-    "@types/axios": "0.14.0",
-    "@types/jest": "26.0.23",
+    "@types/jest": "27.4.1",
     "@types/node": "14.14.35",
     "@types/sax": "1.2.4",
-    "@types/uuid": "8.3.1",
+    "@types/uuid": "8.3.4",
+    "@types/url-join": "4.0.1",
     "@types/valid-url": "1.0.3",
-    "@typescript-eslint/eslint-plugin": "4.27.0",
-    "@typescript-eslint/parser": "4.27.0",
-    "eslint": "7.28.0",
-    "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-jest": "24.3.6",
-    "eslint-plugin-prettier": "3.4.0",
+    "@typescript-eslint/eslint-plugin": "5.18.0",
+    "@typescript-eslint/parser": "5.18.0",
+    "eslint": "8.12.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-jest": "26.1.3",
+    "eslint-plugin-prettier": "4.0.0",
     "fast-check": "2.16.0",
-    "jest": "27.0.4",
-    "prettier": "2.3.1",
+    "jest": "27.5.1",
+    "prettier": "2.6.2",
     "ts-jest": "27.0.3",
     "typedoc": "0.17.7",
     "typedoc-plugin-markdown": "2.4.2",
     "typedoc-plugin-remove-references": "0.0.5",
-    "typescript": "4.3.4"
+    "typescript": "4.6.3",
+    "tsd": "0.20.0"
   },
-  "eslintConfig": {
-    "root": true,
-    "parser": "@typescript-eslint/parser",
-    "env": {
-      "node": true
-    },
-    "parserOptions": {
-      "project": [
-        "./tsconfig.json"
-      ]
-    },
-    "plugins": [
-      "@typescript-eslint"
-    ],
-    "extends": [
-      "eslint:recommended",
-      "plugin:@typescript-eslint/eslint-recommended",
-      "plugin:@typescript-eslint/recommended",
-      "plugin:@typescript-eslint/recommended-requiring-type-checking",
-      "prettier"
-    ],
-    "rules": {
-      "@typescript-eslint/explicit-function-return-type": "off",
-      "@typescript-eslint/restrict-template-expressions": "off"
-    }
+  "tsd": {
+    "directory": "./src/types-tests"
   }
 }

package/dist/types/server-types.d.ts

@@ -1,172 +0,0 @@
-/**
- * Types defined in this module describe the shape of objects that are
- * sent to Prismatic's API when a component is published. Types defined
- * should not generally be imported directly, but they're the types of
- * objects that are created by `component()` and `action()` helper functions.
- */
-/// <reference types="node" />
-/** Import shared types from types/ */
-import { OAuth2Type, InputFieldType, InputFieldDefaultMap } from ".";
-import { ActionContext } from "./ActionPerformFunction";
-import { ActionDisplayDefinition, ComponentDisplayDefinition } from "./DisplayDefinition";
-import { InputFieldChoice, InputFieldCollection } from "./Inputs";
-import { TriggerOptionChoice } from "./TriggerDefinition";
-import { TriggerPayload as _TriggerPayload } from "./TriggerPayload";
-import { TriggerBaseResult, TriggerBranchingResult } from "./TriggerResult";
-/** Defines attributes of a Component. */
-interface ComponentBase<TPublic extends boolean> {
-    /** Specifies unique key for this Component. */
-    key: string;
-    /** Specifies if this Component is available for all Organizations or only your own @default false */
-    public?: TPublic;
-    /** Defines how the Component is displayed in the Prismatic interface. */
-    display: ComponentDisplayDefinition<TPublic>;
-    /** Specifies the supported Actions of this Component. */
-    actions?: Record<string, Action>;
-    /** Specifies the supported Triggers of this Component. */
-    triggers?: Record<string, Trigger>;
-    /** Specifies the supported Connections of this Component. */
-    connections?: Connection[];
-}
-export declare type Component<TPublic extends boolean> = ComponentBase<TPublic> & (TPublic extends true ? {
-    /** Specified the URL for the Component Documentation. */
-    documentationUrl: string;
-} : {
-    /** Specified the URL for the Component Documentation. */
-    documentationUrl?: string;
-});
-/** Base properties of Actions and Triggers. */
-interface BaseAction {
-    /** Key used for the Actions map and to uniquely identify this Component in your tenant. */
-    key: string;
-    /** Defines how the Action is displayed in the Prismatic interface. */
-    display: ActionDisplayDefinition;
-    /** InputFields to present in the Prismatic interface for configuration of this Action. */
-    inputs: InputField[];
-    /** Optional attribute that specifies whether an Action will terminate execution. */
-    terminateExecution?: boolean;
-    /** Specifies whether an Action will break out of a loop. */
-    breakLoop?: boolean;
-    /** Determines whether an Action will allow Conditional Branching. */
-    allowsBranching?: boolean;
-    /** Static Branch names associated with an Action. */
-    staticBranchNames?: string[];
-    /** The Input associated with Dynamic Branching. */
-    dynamicBranchInput?: string;
-}
-/** Configuration of an Action. */
-export interface Action extends BaseAction {
-    /** Function to perform when this Action is used and invoked. */
-    perform: ActionPerformFunction;
-    /** An example of the payload outputted by an Action. */
-    examplePayload?: ServerPerformDataStructureReturn | ServerPerformBranchingDataStructureReturn;
-}
-/** Configuration of a Trigger. */
-export interface Trigger extends BaseAction {
-    /** Function to perform when this Trigger is used and invoked. */
-    perform: TriggerPerformFunction;
-    /** Specifies whether this Trigger supports executing the Integration on a recurring schedule. */
-    scheduleSupport: TriggerOptionChoice;
-    /** Specifies whether this Trigger supports synchronous responses to an Integration webhook request. */
-    synchronousResponseSupport: TriggerOptionChoice;
-    /** An example of the payload outputted by this Trigger. */
-    examplePayload?: TriggerBaseResult | TriggerBranchingResult;
-    /** Specifies if this Trigger appears in the list of 'common' Triggers. Only configurable by Prismatic. @default false */
-    isCommonTrigger?: boolean;
-}
-export interface Connection {
-    key: string;
-    label: string;
-    comments?: string;
-    oauth2Type?: OAuth2Type;
-    iconPath?: string;
-    inputs: (InputField & {
-        shown?: boolean;
-    })[];
-}
-/** Collection of input parameters provided by the user or previous steps' outputs */
-interface ActionInputParameters {
-    [key: string]: unknown;
-}
-/** Used to represent returning conventional data and does not require content type to be specified */
-export interface ServerPerformDataStructureReturn {
-    /** Data structure to return from the action */
-    data: boolean | number | string | Record<string, unknown> | unknown[] | unknown;
-    /** The Content Type of the payload data that can be optionally specified */
-    contentType?: string;
-    /** The HTTP Status code that will be used if this terminates a synchronous invocation  */
-    statusCode?: number;
-    /** An optional object, the keys and values of which will be persisted in the 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 executionState and available for the duration of the execution */
-    executionState?: Record<string, unknown>;
-}
-/** Used to represent a binary or serialized data return as content type must be specified */
-interface ServerPerformDataReturn {
-    /** Data payload containing data of the specified contentType */
-    data: Buffer | string | unknown;
-    /** The Content Type of the payload data */
-    contentType: string;
-    /** The HTTP Status code that will be used if this terminates a synchronous invocation  */
-    statusCode?: number;
-    /** An optional object, the keys and values of which will be persisted in the 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 executionState and available for the duration of the execution */
-    executionState?: Record<string, unknown>;
-}
-/** Used to represent a branching return of conventional data and does not require content type to be specified */
-export interface ServerPerformBranchingDataStructureReturn extends ServerPerformDataStructureReturn {
-    /** Name of the Branch to take. */
-    branch: string;
-}
-/** Used to represent a binary or serialized data branching return as content type must be specified */
-interface ServerPerformBranchingDataReturn extends ServerPerformDataReturn {
-    /** Name of the Branch to take. */
-    branch: string;
-}
-/** Required return type of all action perform functions */
-export declare type ActionPerformReturn = ServerPerformDataStructureReturn | ServerPerformBranchingDataStructureReturn | ServerPerformDataReturn | ServerPerformBranchingDataReturn | undefined;
-/** Definition of the function to perform when an Action is invoked. */
-export declare type ActionPerformFunction = (context: ActionContext, params: ActionInputParameters) => Promise<ActionPerformReturn>;
-export declare type TriggerResult = TriggerBranchingResult | TriggerBaseResult | undefined;
-/** Definition of the function to perform when a Trigger is invoked. */
-export declare type TriggerPerformFunction = (context: ActionContext, payload: TriggerPayload, params: ActionInputParameters) => Promise<TriggerResult>;
-export declare type TriggerPayload = _TriggerPayload;
-export declare type InputField = DefaultInputField | CodeInputField;
-/** Defines attributes of a InputField. */
-interface DefaultInputField {
-    /** Unique identifier of the InputField. Must be unique within an Action. */
-    key: string;
-    /** Interface label of the InputField. */
-    label: string;
-    /** Data type the InputField will collect. */
-    type: InputFieldType;
-    /** Collection type of the InputField */
-    collection?: InputFieldCollection;
-    /** Text to show as the InputField placeholder. */
-    placeholder?: string;
-    /** Default value for this field. */
-    default?: typeof InputFieldDefaultMap[this["type"]];
-    /** Additional text to give guidance to the user configuring the InputField. */
-    comments?: string;
-    /** Example valid input for this InputField. */
-    example?: string;
-    /** Indicate if this InputField is required. */
-    required?: boolean;
-    /** Dictates possible choices for the input. */
-    model?: InputFieldChoice[];
-}
-interface CodeInputField extends DefaultInputField {
-    type: "code";
-    language?: string;
-}
-/** Binary data payload */
-export interface DataPayload {
-    /** Raw binary data as a Buffer */
-    data: Buffer;
-    /** Content type of data contained within this payload */
-    contentType: string;
-    /** Suggested extension to use when writing the data */
-    suggestedExtension?: string;
-}
-export {};

package/dist/types/server-types.js

@@ -1,8 +0,0 @@
-"use strict";
-/**
- * Types defined in this module describe the shape of objects that are
- * sent to Prismatic's API when a component is published. Types defined
- * should not generally be imported directly, but they're the types of
- * objects that are created by `component()` and `action()` helper functions.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/util.test.d.ts

@@ -1 +0,0 @@
-export {};