@prismatic-io/spectral 8.0.0-preview7 → 8.0.0

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,
-};