@prismatic-io/spectral 5.0.0 → 5.3.0

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

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

package/dist/clients/soap/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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

@@ -0,0 +1,71 @@
+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

@@ -0,0 +1,25 @@
+"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) => {
+    var _a;
+    if (typeof connection === "object" && connection !== null)
+        return "wsdlDefinitionURL" in ((_a = connection) === null || _a === void 0 ? void 0 : _a.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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,191 @@
+"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(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(), `${uuid_1.v4()}.wsdl`);
+        yield promises_1.writeFile(filePath, wsdl);
+        const client = yield soap_1.createClientAsync(filePath);
+        yield promises_1.rm(filePath);
+        return client;
+    }
+    else if (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 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(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(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 (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 (types_1.isSOAPConnection(connection) &&
+        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,
+};

package/dist/index.js

@@ -14,12 +14,31 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 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);
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.testing = exports.util = exports.oauth2Connection = exports.connection = exports.input = exports.trigger = exports.action = exports.component = void 0;
-const convertInput = (key, input) => (Object.assign(Object.assign({}, input), { key }));
+/**
+ * Both component author-facing types and server types that
+ * the Prismatic API expects are imported here.
+ */
+const types_1 = require("./types");
+const convertInput = (key, _a) => {
+    var { default: defaultValue, type } = _a, rest = __rest(_a, ["default", "type"]);
+    return (Object.assign(Object.assign({}, rest), { type, default: defaultValue !== null && defaultValue !== void 0 ? defaultValue : types_1.InputFieldDefaultMap[type], key }));
+};
 /**
  * This is a helper function for component() to convert an
  * action defined in TypeScript into an action object that

package/dist/types/InputFieldType.d.ts

@@ -12,3 +12,4 @@ export declare type InputFieldTypeMap = {
     conditional: ConditionalExpression;
     connection: Connection;
 };
+export declare const InputFieldDefaultMap: Record<InputFieldType, string | undefined>;

package/dist/types/InputFieldType.js

@@ -1,2 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.InputFieldDefaultMap = void 0;
+exports.InputFieldDefaultMap = {
+    string: "",
+    data: "",
+    text: "",
+    password: "",
+    boolean: "false",
+    code: "",
+    conditional: undefined,
+    connection: undefined,
+};

package/dist/types/Inputs.d.ts

@@ -1,10 +1,12 @@
-import { InputFieldType } from ".";
+import { InputFieldDefaultMap, InputFieldType } from ".";
 export declare type Inputs = Record<string, InputFieldDefinition>;
 export declare type ConnectionInput = DefaultInputFieldDefinition & {
     shown?: boolean;
 };
-export declare type InputFieldDefinition = DefaultInputFieldDefinition | CodeInputFieldDefinition;
+export declare type InputFieldDefinition = DefaultInputFieldDefinition | CodeInputFieldDefinition | ConditionalInputField | ConnectionInputField;
 interface BaseInputFieldDefinition {
+    /** Data type the InputField will collect. */
+    type: InputFieldType;
     /** Interface label of the InputField. */
     label: string;
     /** Collection type of the InputField */
@@ -12,7 +14,7 @@ interface BaseInputFieldDefinition {
     /** Text to show as the InputField placeholder. */
     placeholder?: string;
     /** Default value for this field. */
-    default?: string;
+    default?: typeof InputFieldDefaultMap[this["type"]];
     /** Additional text to give guidance to the user configuring the InputField. */
     comments?: string;
     /** Example valid input for this InputField. */
@@ -24,13 +26,21 @@ interface BaseInputFieldDefinition {
 }
 /** Defines attributes of a InputField. */
 export interface DefaultInputFieldDefinition extends BaseInputFieldDefinition {
-    type: Exclude<InputFieldType, "code">;
+    type: Exclude<InputFieldType, "code" | "conditional" | "connection">;
 }
 /** Defines attributes of a CodeInputField. */
 export interface CodeInputFieldDefinition extends BaseInputFieldDefinition {
     type: Extract<InputFieldType, "code">;
     language?: string;
 }
+/** Defines attributes of a ConditionalInputField. */
+export interface ConditionalInputField extends BaseInputFieldDefinition {
+    type: Extract<InputFieldType, "conditional">;
+}
+/** Defines attributes of a ConnectionInputField. */
+export interface ConnectionInputField extends BaseInputFieldDefinition {
+    type: Extract<InputFieldType, "connection">;
+}
 export interface Connection {
     /** Key of the Connection type. */
     key: string;

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

@@ -6,7 +6,7 @@
  */
 /// <reference types="node" />
 /** Import shared types from types/ */
-import { OAuth2Type } from ".";
+import { OAuth2Type, InputFieldType, InputFieldDefaultMap } from ".";
 import { ActionContext } from "./ActionPerformFunction";
 import { ActionDisplayDefinition, ComponentDisplayDefinition } from "./DisplayDefinition";
 import { InputFieldChoice, InputFieldCollection } from "./Inputs";
@@ -146,7 +146,7 @@ interface DefaultInputField {
     /** Text to show as the InputField placeholder. */
     placeholder?: string;
     /** Default value for this field. */
-    default?: string;
+    default?: typeof InputFieldDefaultMap[this["type"]];
     /** Additional text to give guidance to the user configuring the InputField. */
     comments?: string;
     /** Example valid input for this InputField. */
@@ -160,8 +160,6 @@ interface CodeInputField extends DefaultInputField {
     type: "code";
     language?: string;
 }
-/** InputField type enumeration. */
-export declare type InputFieldType = "string" | "text" | "password" | "boolean" | "code" | "data" | "conditional" | "connection";
 /** Binary data payload */
 export interface DataPayload {
     /** Raw binary data as a Buffer */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "5.0.0",
+  "version": "5.3.0",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"
@@ -32,13 +32,19 @@
     "dist/"
   ],
   "dependencies": {
+    "axios": "0.24.0",
     "date-fns": "2.17.0",
     "jest-mock": "27.0.3",
+    "soap": "0.43.0",
+    "uuid": "8.3.1",
     "valid-url": "1.0.9"
   },
   "devDependencies": {
+    "@types/axios": "0.14.0",
     "@types/jest": "26.0.23",
     "@types/node": "14.14.35",
+    "@types/sax": "1.2.4",
+    "@types/uuid": "8.3.1",
     "@types/valid-url": "1.0.3",
     "@typescript-eslint/eslint-plugin": "4.27.0",
     "@typescript-eslint/parser": "4.27.0",