@prismatic-io/spectral 7.8.4 → 7.10.0

package/dist/types/ActionInputParameters.d.ts

@@ -1,6 +1,6 @@
 import { Inputs } from ".";
 import { ConditionalExpression } from "./conditional-logic";
-import { InputFieldCollection, InputCleanFunction, Connection } from "./Inputs";
+import { InputFieldCollection, InputCleanFunction, Connection, KeyValuePair } from "./Inputs";
 /**
  * Collection of input parameters.
  * Inputs can be static values, references to config variables, or
@@ -10,16 +10,3 @@ export declare type ActionInputParameters<TInputs extends Inputs> = {
     [Property in keyof TInputs]: TInputs[Property]["clean"] extends InputCleanFunction<any> ? ReturnType<TInputs[Property]["clean"]> : TInputs[Property]["type"] extends "connection" ? ExtractValue<Connection, TInputs[Property]["collection"]> : TInputs[Property]["type"] extends "conditional" ? ExtractValue<ConditionalExpression, TInputs[Property]["collection"]> : ExtractValue<TInputs[Property]["default"], TInputs[Property]["collection"]>;
 };
 export declare type ExtractValue<TType, TCollection extends InputFieldCollection | undefined> = TCollection extends "keyvaluelist" ? KeyValuePair<TType>[] : TCollection extends "valuelist" ? TType[] : TType;
-/**
- * KeyValuePair input parameter type.
- * This allows users to input multiple keys / values as an input.
- * To see an example of how this can be used, see the `tagging` input
- * of the `putObject` action of the AWS S3 component:
- * https://github.com/prismatic-io/examples/blob/main/components/aws-s3/src/actions.ts
- */
-export interface KeyValuePair<V = unknown> {
-    /** Key of the KeyValuePair */
-    key: string;
-    /** Value of the KeyValuePair */
-    value: V;
-}

package/dist/types/Inputs.d.ts

@@ -1,5 +1,18 @@
 import { ConditionalExpression } from "./conditional-logic";
 import { JsonSchema, UISchemaElement } from "@jsonforms/core";
+/**
+ * KeyValuePair input parameter type.
+ * This allows users to input multiple keys / values as an input.
+ * To see an example of how this can be used, see the `tagging` input
+ * of the `putObject` action of the AWS S3 component:
+ * https://github.com/prismatic-io/examples/blob/main/components/aws-s3/src/actions.ts
+ */
+export interface KeyValuePair<V = unknown> {
+    /** Key of the KeyValuePair */
+    key: string;
+    /** Value of the KeyValuePair */
+    value: V;
+}
 export declare type Element = {
     key: string;
     label?: string;
@@ -66,81 +79,76 @@ interface BaseInputField {
     /** Indicate if this InputField is required. */
     required?: boolean;
 }
-export interface StringInputField extends BaseInputField {
-    /** Data type the InputField will collect. */
-    type: "string";
+declare type CollectionOptions<T> = SingleValue<T> | ValueListCollection<T> | KeyValueListCollection<T>;
+interface SingleValue<T> {
     /** Collection type of the InputField */
-    collection?: InputFieldCollection;
+    collection?: undefined;
     /** Default value for this field. */
-    default?: unknown;
+    default?: T;
+}
+interface ValueListCollection<T> {
+    /** Collection type of the InputField */
+    collection: "valuelist";
+    /** Default value for this field. */
+    default?: T[];
+}
+interface KeyValueListCollection<T> {
+    /** Collection type of the InputField */
+    collection: "keyvaluelist";
+    /** Default value for this field. */
+    default?: KeyValuePair<T>[];
+}
+export declare type StringInputField = BaseInputField & CollectionOptions<string> & {
+    /** Data type the InputField will collect. */
+    type: "string";
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
     /** Clean function */
-    clean?: InputCleanFunction<this["default"]>;
-}
-export interface DataInputField extends BaseInputField {
+    clean?: InputCleanFunction<unknown>;
+};
+export declare type DataInputField = BaseInputField & CollectionOptions<string> & {
     /** Data type the InputField will collect. */
     type: "data";
-    /** Collection type of the InputField */
-    collection?: InputFieldCollection;
-    /** Default value for this field. */
-    default?: unknown;
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
     /** Clean function */
-    clean?: InputCleanFunction<this["default"]>;
-}
-export interface TextInputField extends BaseInputField {
+    clean?: InputCleanFunction<unknown>;
+};
+export declare type TextInputField = BaseInputField & CollectionOptions<string> & {
     /** Data type the InputField will collect. */
     type: "text";
-    /** Collection type of the InputField */
-    collection?: InputFieldCollection;
-    /** Default value for this field. */
-    default?: unknown;
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
     /** Clean function */
-    clean?: InputCleanFunction<this["default"]>;
-}
-export interface PasswordInputField extends BaseInputField {
+    clean?: InputCleanFunction<unknown>;
+};
+export declare type PasswordInputField = BaseInputField & CollectionOptions<string> & {
     /** Data type the InputField will collect. */
     type: "password";
-    /** Collection type of the InputField */
-    collection?: InputFieldCollection;
-    /** Default value for this field. */
-    default?: unknown;
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
     /** Clean function */
-    clean?: InputCleanFunction<this["default"]>;
-}
-export interface BooleanInputField extends BaseInputField {
+    clean?: InputCleanFunction<unknown>;
+};
+export declare type BooleanInputField = BaseInputField & CollectionOptions<string> & {
     /** Data type the InputField will collect. */
     type: "boolean";
-    /** Collection type of the InputField */
-    collection?: InputFieldCollection;
-    /** Default value for this field. */
-    default?: unknown;
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
     /** Clean function */
-    clean?: InputCleanFunction<this["default"]>;
-}
+    clean?: InputCleanFunction<unknown>;
+};
 /** Defines attributes of a CodeInputField. */
-export interface CodeInputField extends BaseInputField {
+export declare type CodeInputField = BaseInputField & CollectionOptions<string> & {
     /** Data type the InputField will collect. */
     type: "code";
-    /** Collection type of the InputField */
-    collection?: InputFieldCollection;
-    /** Default value for this field. */
-    default?: unknown;
     /** Code language for syntax highlighting. For no syntax highlighting, choose "plaintext" */
     language: "css" | "graphql" | "handlebars" | "hcl" | "html" | "javascript" | "json" | "liquid" | "markdown" | "mysql" | "pgsql" | "plaintext" | "sql" | "typescript" | "xml" | "yaml";
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
     /** Clean function */
-    clean?: InputCleanFunction<this["default"]>;
-}
+    clean?: InputCleanFunction<unknown>;
+};
 /** Defines attributes of a ConditionalInputField. */
 export interface ConditionalInputField extends BaseInputField {
     /** Data type the InputField will collect. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "7.8.4",
+  "version": "7.10.0",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"
@@ -38,14 +38,13 @@
   ],
   "dependencies": {
     "@jsonforms/core": "3.0.0",
-    "axios": "0.27.2",
-    "axios-retry": "3.2.5",
+    "axios": "1.6.2",
+    "axios-retry": "3.9.1",
     "date-fns": "2.30.0",
     "form-data": "4.0.0",
     "jest-mock": "27.0.3",
     "safe-stable-stringify": "2.3.1",
     "serialize-error": "8.1.0",
-    "soap": "1.0.0",
     "url-join": "5.0.0",
     "uuid": "8.3.2",
     "valid-url": "1.0.9"

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

@@ -1,2 +0,0 @@
-export * from "./types";
-export * from "./utils";

package/dist/clients/soap/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types"), exports);
-__exportStar(require("./utils"), exports);

package/dist/clients/soap/types.d.ts

@@ -1,71 +0,0 @@
-import { Connection } from "../../index";
-import { IMTOMAttachments } from "soap";
-/**
- * SOAPConnection takes standard connection fields, and adds an optional `wsdlDefinitionUrl` field.
- */
-export interface SOAPConnection extends Connection {
-    fields: {
-        [key: string]: unknown;
-        wsdlDefinitionUrl?: string;
-    };
-}
-/**
- * This function determines if the object presented is a SOAP connection with a `wsdlDefinitionUrl` field.
- * @param connection The connection to test
- * @returns This function returns true if the connection is a SOAPConnection, and false otherwise.
- */
-export declare const isSOAPConnection: (connection: unknown) => connection is SOAPConnection;
-/**
- * SOAP requests return a 4-tuple or 5-tuple with the response first, the XML response second, headers third, and the XML request fourth, and optional message attachments fifth.
- */
-export declare type SOAPResponse = [any, any, any, any, IMTOMAttachments?];
-/**
- * Overload the `soapRequest` function to take a variety of types of arguments.
- */
-export interface SOAPRequest {
-    (params: RequestParams): Promise<SOAPResponse>;
-    (params: RequestParams, methodParams: Record<string, unknown>): Promise<SOAPResponse>;
-    (params: RequestParams, methodParams: undefined): Promise<SOAPResponse>;
-}
-export interface RequestParams {
-    wsdlParam: SOAPConnection | string;
-    method: string;
-    overrides?: ClientOverrides;
-    debug?: boolean;
-}
-export interface ClientOverrides {
-    endpointURL?: string;
-    soapHeaders?: unknown[];
-}
-export interface HeaderPayload {
-    [x: string]: any;
-}
-export interface GenerateHeader {
-    (wsdlParam: SOAPConnection | string, headerPayload: HeaderPayload, headerOptions: undefined): Promise<string>;
-    (wsdlParam: SOAPConnection | string, headerPayload: HeaderPayload, headerOptions: {
-        namespace: string;
-        xmlns: string;
-    }): Promise<string>;
-}
-export interface BasicAuthConnection extends Connection {
-    fields: {
-        [key: string]: unknown;
-        username: unknown;
-        password: unknown;
-        loginMethod: unknown;
-    };
-}
-/**
- * This function determines if the object presented is a Basic Auth connection with `username`, `password`, and `loginMethod` fields.
- * @param connection The connection to test
- * @returns This function returns true if the connection is a SOAPConnection, and false otherwise.
- */
-export declare const isBasicAuthConnection: (connection: Connection) => connection is BasicAuthConnection;
-export interface SOAPAuth {
-    (connection: BasicAuthConnection, wsdlDefinition: string): Promise<any>;
-    (connection: BasicAuthConnection & SOAPConnection): Promise<any>;
-}
-export interface DescribeWSDL {
-    (connection: SOAPConnection): Promise<any>;
-    (wsdlDefinition: string): Promise<any>;
-}

package/dist/clients/soap/types.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isBasicAuthConnection = exports.isSOAPConnection = void 0;
-/**
- * This function determines if the object presented is a SOAP connection with a `wsdlDefinitionUrl` field.
- * @param connection The connection to test
- * @returns This function returns true if the connection is a SOAPConnection, and false otherwise.
- */
-const isSOAPConnection = (connection) => {
-    if (typeof connection === "object" && connection !== null)
-        return "wsdlDefinitionURL" in (connection === null || connection === void 0 ? void 0 : connection.fields);
-    return false;
-};
-exports.isSOAPConnection = isSOAPConnection;
-/**
- * This function determines if the object presented is a Basic Auth connection with `username`, `password`, and `loginMethod` fields.
- * @param connection The connection to test
- * @returns This function returns true if the connection is a SOAPConnection, and false otherwise.
- */
-const isBasicAuthConnection = (connection) => {
-    const { fields } = connection;
-    return ("username" in fields && "password" in fields && "loginMethod" in fields);
-};
-exports.isBasicAuthConnection = isBasicAuthConnection;

package/dist/clients/soap/utils.d.ts

@@ -1,12 +0,0 @@
-import { ClientOverrides, GenerateHeader, SOAPAuth, SOAPConnection, SOAPRequest, DescribeWSDL } from "./types";
-import { Client } from "soap";
-declare const _default: {
-    describeWSDL: DescribeWSDL;
-    generateHeader: GenerateHeader;
-    getSOAPAuth: SOAPAuth;
-    getSOAPClient: <T extends string | SOAPConnection = string | SOAPConnection>(wsdlParam: T) => Promise<Client>;
-    getWSDL: (wsdlDefinitionURL: string) => Promise<string>;
-    overrideClientDefaults: (client: Client, overrides: ClientOverrides) => void;
-    soapRequest: SOAPRequest;
-};
-export default _default;

package/dist/clients/soap/utils.js

@@ -1,191 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable @typescript-eslint/no-unsafe-return */
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-const types_1 = require("./types");
-const index_1 = require("../../index");
-const soap_1 = require("soap");
-const axios_1 = __importDefault(require("axios"));
-const promises_1 = require("fs/promises");
-const uuid_1 = require("uuid");
-const os_1 = __importDefault(require("os"));
-const path_1 = __importDefault(require("path"));
-/**
- * Optionally log out SOAP requests and responses for debugging purposes
- *
- * @param client A SOAP client that generates requests and responses
- */
-const debugRequest = (client) => {
-    console.debug(client.lastRequest);
-    console.debug(client.lastResponse);
-};
-/**
- * This function takes either the URL of a WSDL or the XML defining a WSDL, and returns an object describing the methods and attributes defined in the WSDL.
- *
- * @param wsdlParam Either the URL where a WSDL is stored, or the XML defining a WSDL.
- * @returns An object containing the methods and attributes defined in a WSDL
- */
-const describeWSDL = (wsdlParam) => __awaiter(void 0, void 0, void 0, function* () {
-    const client = yield getSOAPClient((0, types_1.isSOAPConnection)(wsdlParam) ? wsdlParam : index_1.util.types.toString(wsdlParam));
-    try {
-        const result = client.describe();
-        return result;
-    }
-    catch (error) {
-        throw new Error("Unable to parse WSDL Services due to circular references");
-    }
-});
-/**
- * Fetch a WSDL from a URL
- * @param wsdlDefinitionURL The URL where the WSDL is stored
- * @returns The WSDL's raw XML
- */
-const getWSDL = (wsdlDefinitionURL) => __awaiter(void 0, void 0, void 0, function* () {
-    const httpClient = axios_1.default.create({
-        baseURL: wsdlDefinitionURL,
-        headers: { "Content-Type": "text/xml" },
-    });
-    const { data } = yield httpClient.get("");
-    return index_1.util.types.toString(data);
-});
-/**
- * Create a SOAP client given a WSDL or SOAPConnection
- * @param wsdlParam a SOAPConnection or XML defining a WSDL
- * @returns An HTTP client configured to query a SOAP-based API
- */
-const getSOAPClient = (wsdlParam) => __awaiter(void 0, void 0, void 0, function* () {
-    if (typeof wsdlParam === "string") {
-        const wsdl = index_1.util.types.toString(wsdlParam);
-        const filePath = path_1.default.join(os_1.default.tmpdir(), `${(0, uuid_1.v4)()}.wsdl`);
-        yield (0, promises_1.writeFile)(filePath, wsdl);
-        const client = yield (0, soap_1.createClientAsync)(filePath);
-        yield (0, promises_1.rm)(filePath);
-        return client;
-    }
-    else if ((0, types_1.isSOAPConnection)(wsdlParam)) {
-        const { fields: { wsdlDefinitionURL }, } = wsdlParam;
-        if (!wsdlDefinitionURL ||
-            !index_1.util.types.isUrl(index_1.util.types.toString(wsdlDefinitionURL))) {
-            throw new Error("WSDL Definition or the Connection field 'wsdlDefinitionURL' must be supplied.");
-        }
-        const client = yield (0, soap_1.createClientAsync)(index_1.util.types.toString(wsdlDefinitionURL));
-        return client;
-    }
-    else {
-        throw new Error("WSDL Definition or the Connection field 'wsdlDefinitionURL' must be supplied.");
-    }
-});
-/**
- * Override some HTTP client defaults
- * @param client The client to override
- * @param overrides An endpoint URL or SOAP headers to override
- */
-const overrideClientDefaults = (client, overrides) => {
-    const { endpointURL, soapHeaders } = overrides;
-    if (endpointURL) {
-        client.setEndpoint(endpointURL);
-    }
-    if (soapHeaders) {
-        soapHeaders.map((header) => {
-            client.addSoapHeader(header);
-        });
-    }
-};
-/**
- * Make a request to a SOAP-based API
- * @param param0
- * @param methodParams Parameters to pass to the specified SOAP method
- * @returns The results from the SOAP request, including the full XML of the request and response
- */
-const soapRequest = ({ wsdlParam, method, overrides, debug }, methodParams) => __awaiter(void 0, void 0, void 0, function* () {
-    const client = yield getSOAPClient((0, types_1.isSOAPConnection)(wsdlParam) ? wsdlParam : index_1.util.types.toString(wsdlParam));
-    if (overrides) {
-        overrideClientDefaults(client, overrides);
-    }
-    const requestFunction = client[`${method}Async`];
-    let results = undefined;
-    try {
-        if (typeof methodParams === "object" && methodParams !== null) {
-            results = yield requestFunction(methodParams);
-        }
-        else {
-            results = yield requestFunction({});
-        }
-        if (index_1.util.types.isBool(debug) && debug) {
-            debugRequest(client);
-        }
-        return results;
-    }
-    catch (error) {
-        if (index_1.util.types.isBool(debug) && debug) {
-            debugRequest(client);
-        }
-        console.warn("Please verify that the method you specified exists in the WSDL specification.");
-        throw error;
-    }
-});
-/**
- * Create a SOAP header
- * @param wsdlParam A SOAPConnection or XML definition of a WSDL
- * @param headerPayload The contents of a header XML node
- * @param headerOptions Attributes for a header XML node, like namespace or xmlns
- * @returns
- */
-const generateHeader = (wsdlParam, headerPayload, headerOptions) => __awaiter(void 0, void 0, void 0, function* () {
-    const client = yield getSOAPClient((0, types_1.isSOAPConnection)(wsdlParam) ? wsdlParam : index_1.util.types.toString(wsdlParam));
-    let options = [];
-    if (headerOptions) {
-        options = Object.values(headerOptions);
-    }
-    const index = client.addSoapHeader(headerPayload, "", ...options);
-    return client.getSoapHeaders()[index];
-});
-/**
- * Fetch authentication information for a SOAPConnection
- * @param connection The SOAPConnection
- * @param wsdlDefinition The XML WSDL definition
- * @returns
- */
-const getSOAPAuth = (connection, wsdlDefinition) => __awaiter(void 0, void 0, void 0, function* () {
-    if ((0, types_1.isBasicAuthConnection)(connection) && wsdlDefinition) {
-        const { fields: { username, password, loginMethod }, } = connection;
-        const result = yield soapRequest({
-            wsdlParam: index_1.util.types.toString(wsdlDefinition),
-            method: index_1.util.types.toString(loginMethod),
-        }, { username, password });
-        return result;
-    }
-    else if ((0, types_1.isSOAPConnection)(connection) &&
-        (0, types_1.isBasicAuthConnection)(connection)) {
-        const { fields: { username, password, loginMethod }, } = connection;
-        const result = yield soapRequest({
-            wsdlParam: connection,
-            method: index_1.util.types.toString(loginMethod),
-        }, { username, password });
-        return result;
-    }
-    else {
-        throw new Error("Must supply a SOAP Connection or a WSDL Definition");
-    }
-});
-exports.default = {
-    describeWSDL,
-    generateHeader,
-    getSOAPAuth,
-    getSOAPClient,
-    getWSDL,
-    overrideClientDefaults,
-    soapRequest,
-};