@prismatic-io/spectral 8.0.0-preview8 → 8.0.1

package/dist/types/IntegrationDefinition.d.ts

@@ -1,6 +1,13 @@
-import { DataSourceDefinition, ConnectionDefinition, ActionPerformFunction, ActionPerformReturn, TriggerEventFunction, TriggerPerformFunction, Inputs, TriggerResult, DataSourceType } from ".";
+import { DataSourceDefinition, ConnectionDefinition, ActionPerformFunction, ActionPerformReturn, TriggerEventFunction, TriggerPerformFunction, Inputs, TriggerResult, DataSourceType, TriggerPayload, Connection, JSONForm, ObjectFieldMap, ObjectSelection, ConfigVarResultCollection } from ".";
+import { Prettify, UnionToIntersection, ValueOf } from "./utils";
+declare type ToDataSourceRuntimeType<TType extends DataSourceType> = TType extends "jsonForm" ? JSONForm : TType extends "objectSelection" ? ObjectSelection : TType extends "objectFieldMap" ? ObjectFieldMap : string;
+export declare type ElementToRuntimeType<TElement extends ConfigPageElement> = TElement extends ConnectionConfigVar ? Connection : TElement extends DataSourceConfigVar ? ToDataSourceRuntimeType<TElement["dataSourceType"]> : TElement extends StandardConfigVar ? string : never;
+declare type GetElements<TConfigPages extends ConfigPages> = TConfigPages extends ConfigPages ? UnionToIntersection<ValueOf<TConfigPages>["elements"]> : never;
+export declare type ExtractConfigVars<TConfigPages extends ConfigPages, TElements extends ConfigPage["elements"] = GetElements<TConfigPages>> = Prettify<{
+    [Key in keyof TElements]: ElementToRuntimeType<TElements[Key]>;
+}>;
 /** Defines attributes of a Code-Native Integration. */
-export declare type IntegrationDefinition = {
+export declare type IntegrationDefinition<TConfigPages extends ConfigPages> = {
     /** The unique name for this Integration. */
     name: string;
     /** Optional description for this Integration. */
@@ -23,18 +30,16 @@ export declare type IntegrationDefinition = {
      *  Cannot specify this if a Preprocess Flow is also configured. */
     triggerPreprocessFlowConfig?: PreprocessFlowConfig;
     /** Flows for this Integration. */
-    flows: Flow[];
-    /** Config Vars used on this Integration. */
-    configVars?: ConfigVar[];
+    flows: Flow<TConfigPages>[];
     /** Config Wizard Pages for this Integration. */
-    configPages?: ConfigPage[];
-    /** Specifies any Data Sources that are defined as part of this Integration. */
-    dataSources?: Record<string, CodeNativeDataSource>;
+    configPages?: TConfigPages;
 };
-/** Defines common attributes of a Flow of a Code-Native Integration. */
-declare type BaseFlow = {
+/** Defines attributes of a Flow of a Code-Native Integration. */
+export interface Flow<TConfigPages extends ConfigPages, TTriggerPayload extends TriggerPayload = TriggerPayload> {
     /** The unique name for this Flow. */
     name: string;
+    /** A unique, unchanging value that is used to maintain identity for the Flow even if the name changes. */
+    stableKey: string;
     /** Optional description for this Flow. */
     description?: string;
     /** Optional Preprocess Flow configuration for when the result of this Flow contains the flow routing attributes. Only one Flow per Integration may define this. */
@@ -51,62 +56,31 @@ declare type BaseFlow = {
     schedule?: FlowSchedule;
     /** Optional error handling configuration. */
     errorConfig?: StepErrorConfig;
-    /** Specifies the main function for this Flow */
-    onExecution: ActionPerformFunction<Inputs, false, ActionPerformReturn<false, unknown>>;
-};
-/** Defines attributes of a Flow that will have custom Trigger logic. */
-declare type CustomTriggerFlow = BaseFlow & {
     /** Specifies the trigger function for this Flow, which returns a payload and optional HTTP response. */
-    onTrigger: TriggerPerformFunction<Inputs, false, TriggerResult<false>>;
+    onTrigger: TriggerPerformFunction<Inputs, ExtractConfigVars<TConfigPages>, false, TriggerResult<false, TTriggerPayload>>;
     /** Specifies the function to execute when an Instance of this Integration is deployed. */
-    onInstanceDeploy?: TriggerEventFunction<Inputs>;
+    onInstanceDeploy?: TriggerEventFunction<Inputs, ExtractConfigVars<TConfigPages>>;
     /** Specifies the function to execute when an Instance of an Integration is deleted. */
-    onInstanceDelete?: TriggerEventFunction<Inputs>;
-};
-/** Defines attributes of a Flow that will use a Trigger from an existing Component. */
-declare type PrebuiltTriggerFlow = BaseFlow & {
-    /** Specifies the prebuilt Trigger that will run when this Flow executes. */
-    trigger: TriggerReference;
-};
-/** Defines attributes of a Flow of a Code-Native Integration. */
-export declare type Flow = CustomTriggerFlow | PrebuiltTriggerFlow;
-/** Defines attributes of a Data Source that is defined as part of a Code Native Integration. */
-export declare type CodeNativeDataSource = Pick<DataSourceDefinition<Inputs, DataSourceType>, "display" | "perform" | "dataSourceType" | "detailDataSource">;
-/** Defines attributes of a reference to an existing Trigger. */
-export declare type TriggerReference = {
-    /** Attributes of the referenced Component. */
-    component: ComponentReference;
-    /** The unique key that identifies the Trigger within the Component. */
-    key: string;
-    /** Optional input values for this Trigger. */
-    inputs?: InputValues;
-};
-/** Defines attributes of a reference to an existing Data Source. */
-export declare type DataSourceReference = {
-    /** Attributes of the referenced Component. */
-    component: ComponentReference;
-    /** The unique key that identifies the Data Source within the Component. */
-    key: string;
-};
-/** Defines attributes of a reference to a member of an existing Component. */
-export declare type ComponentReference = {
-    /** The unique key that identifies the Component. */
-    key: string;
-    /** The version of the Component. */
-    version: number | "LATEST";
-    /** Specifies whether the Component is in the public library or a private Component. */
-    isPublic: boolean;
-};
+    onInstanceDelete?: TriggerEventFunction<Inputs, ExtractConfigVars<TConfigPages>>;
+    /** Specifies the main function for this Flow */
+    onExecution: ActionPerformFunction<{
+        onTrigger: {
+            type: "data";
+            label: string;
+            clean: (value: unknown) => {
+                results: TTriggerPayload;
+            };
+        };
+    }, ExtractConfigVars<TConfigPages>, false, ActionPerformReturn<false, unknown>>;
+}
 /** Common attribute shared by all types of Config Vars. */
 declare type BaseConfigVar = {
-    /** The unique key for this Config Var. */
-    key: string;
+    /** A unique, unchanging value that is used to maintain identity for the Config Var even if the key changes. */
+    stableKey: string;
     /** Optional description for this Config Var. */
     description?: string;
     /** Optional value that specifies whether this Config Var is only configurable by Organization users. @default false  */
     orgOnly?: boolean;
-    /** Optional input values for this Config Var. */
-    inputs?: InputValues;
     /** Optional value that specifies whether this Config Var is visible to an Organization deployer. @default true */
     visibleToOrgDeployer?: boolean;
     /** Optional value that specifies whether this Config Var is visible to a Customer deployer. @default true */
@@ -114,10 +88,10 @@ declare type BaseConfigVar = {
 };
 /** Defines attributes of a standard Config Var. */
 export declare type StandardConfigVar = BaseConfigVar & {
-    /** Optional default value for the Config Var. */
-    defaultValue?: string;
     /** The data type of the Config Var. */
     dataType: ConfigVarDataType;
+    /** Optional default value for the Config Var. */
+    defaultValue?: string;
     /** Optional list of picklist values if the Config Var is a multi-choice selection value. */
     pickList?: string[];
     /** Optional schedule type that defines the cadence of the schedule. */
@@ -128,54 +102,22 @@ export declare type StandardConfigVar = BaseConfigVar & {
     codeLanguage?: CodeLanguageType;
     /** Optional value to specify the type of collection if the Config Var is multi-value. */
     collectionType?: CollectionType;
-    /** Optional value to specify the Data Source where the Config Var sources
-     *  its values. If it's a string then it's expected to be the key of a
-     *  CodeNativeDataSource defined in the Code Native Integration. Otherwise it
-     *  is expected to be a reference to an existing Data Source. */
-    dataSource?: string | DataSourceReference;
 };
+/** Defines attributes of a data source Config Var. */
+export declare type DataSourceConfigVar = BaseConfigVar & Omit<DataSourceDefinition<Inputs, ConfigVarResultCollection, DataSourceType>, "display" | "inputs" | "examplePayload">;
 /** Defines attributes of a Config Var that represents a Connection. */
-export declare type ConnectionConfigVar = Omit<BaseConfigVar, "description" | "inputs"> & ConnectionDefinition;
-export declare type ConnectionRefConfigVar = BaseConfigVar & {
-    /** Attributes of the referenced Component. */
-    component: ComponentReference;
-};
-export declare type ConfigVar = StandardConfigVar | ConnectionConfigVar | ConnectionRefConfigVar;
+export declare type ConnectionConfigVar = BaseConfigVar & Omit<ConnectionDefinition, "label" | "comments" | "key">;
+export declare type ConfigVar = StandardConfigVar | DataSourceConfigVar | ConnectionConfigVar;
+export declare const isDataSourceConfigVar: (cv: ConfigVar) => cv is DataSourceConfigVar;
+export declare const isConnectionConfigVar: (cv: ConfigVar) => cv is ConnectionConfigVar;
+export declare type ConfigPageElement = string | ConfigVar;
+export declare type ConfigPages = Record<string, ConfigPage>;
 /** Defines attributes of a Config Wizard Page used when deploying an Instance of an Integration. */
 export declare type ConfigPage = {
-    /** The unique name for this Config Page. */
-    name: string;
+    /** Elements included on this Config Page. */
+    elements: Record<string, ConfigPageElement>;
     /** Specifies an optional tagline for this Config Page. */
     tagline?: string;
-    /** Optional value that specifies whether this Config Page is configured as
-     *  part of User Level Configuration. @default false */
-    userLevelConfigured?: boolean;
-    /** Elements included on this Config Page. */
-    elements: ConfigPageElement[];
-};
-/** Defines attributes of Inputs for Connections, Actions, Triggers,
- *  Data Sources, and Config Vars. */
-export declare type InputValues = Record<string, InputValue>;
-export declare type InputValue = SimpleInputValue | ComplexInputValue;
-export declare type SimpleInputValue = {
-    name?: string;
-    type: SimpleInputValueType;
-    value: string;
-    meta?: Record<string, unknown>;
-};
-export declare type ComplexInputValue = {
-    name?: string;
-    type: "complex";
-    value: ComplexInputValueType;
-    meta?: Record<string, unknown>;
-};
-export declare type ComplexInputValueType = (string | InputValue | ComplexInputValueType)[];
-/** Defines attributes of an Element that appears on a Config Wizard Page. */
-export declare type ConfigPageElement = {
-    /** Specifies what type of data is represented by this Element. */
-    type: ConfigPageElementType;
-    /** Specifies the value of this Element. */
-    value: string;
 };
 /** Defines attributes of a Preprocess Flow Configuration used by a Flow of an Integration. */
 export declare type PreprocessFlowConfig = {
@@ -222,13 +164,6 @@ export declare type FlowSchedule = {
     /** Specifies an optional value to use as the timezone. */
     timeZone?: string;
 };
-/** Choices of Simple Input Value Types that may be used by Simple Input Values. */
-export declare enum SimpleInputValueType {
-    Value = "value",
-    Reference = "reference",
-    ConfigVar = "configVar",
-    Template = "template"
-}
 /** Choices of Endpoint Types that may be used by Instances of an Integration. */
 export declare enum EndpointType {
     FlowSpecific = "flow_specific",
@@ -242,12 +177,6 @@ export declare enum EndpointSecurityType {
     CustomerRequired = "customer_required",
     Organization = "organization"
 }
-/** Choices of Config Page Element Types that may be used for Elements on a Config Wizard Page. */
-export declare enum ConfigPageElementType {
-    ConfigVar = "configVar",
-    HTML = "htmlElement",
-    JSONForm = "jsonForm"
-}
 /** Choices of Step Error Handlers that define the behavior when a step error occurs. */
 export declare enum StepErrorHandlerType {
     Fail = "fail",
@@ -272,10 +201,7 @@ export declare enum ConfigVarDataType {
     Schedule = "schedule",
     Code = "code",
     Boolean = "boolean",
-    Number = "number",
-    ObjectSelection = "objectSelection",
-    ObjectFieldMap = "objectFieldMap",
-    JSONForm = "jsonForm"
+    Number = "number"
 }
 /** Choices of programming languages that may be used for Config Var code values. */
 export declare enum CodeLanguageType {

package/dist/types/IntegrationDefinition.js

@@ -1,14 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CollectionType = exports.CodeLanguageType = exports.ConfigVarDataType = exports.ScheduleType = exports.StepErrorHandlerType = exports.ConfigPageElementType = exports.EndpointSecurityType = exports.EndpointType = exports.SimpleInputValueType = void 0;
-/** Choices of Simple Input Value Types that may be used by Simple Input Values. */
-var SimpleInputValueType;
-(function (SimpleInputValueType) {
-    SimpleInputValueType["Value"] = "value";
-    SimpleInputValueType["Reference"] = "reference";
-    SimpleInputValueType["ConfigVar"] = "configVar";
-    SimpleInputValueType["Template"] = "template";
-})(SimpleInputValueType = exports.SimpleInputValueType || (exports.SimpleInputValueType = {}));
+exports.CollectionType = exports.CodeLanguageType = exports.ConfigVarDataType = exports.ScheduleType = exports.StepErrorHandlerType = exports.EndpointSecurityType = exports.EndpointType = exports.isConnectionConfigVar = exports.isDataSourceConfigVar = void 0;
+const isDataSourceConfigVar = (cv) => "dataSourceType" in cv;
+exports.isDataSourceConfigVar = isDataSourceConfigVar;
+const isConnectionConfigVar = (cv) => "inputs" in cv;
+exports.isConnectionConfigVar = isConnectionConfigVar;
 /** Choices of Endpoint Types that may be used by Instances of an Integration. */
 var EndpointType;
 (function (EndpointType) {
@@ -24,13 +20,6 @@ var EndpointSecurityType;
     EndpointSecurityType["CustomerRequired"] = "customer_required";
     EndpointSecurityType["Organization"] = "organization";
 })(EndpointSecurityType = exports.EndpointSecurityType || (exports.EndpointSecurityType = {}));
-/** Choices of Config Page Element Types that may be used for Elements on a Config Wizard Page. */
-var ConfigPageElementType;
-(function (ConfigPageElementType) {
-    ConfigPageElementType["ConfigVar"] = "configVar";
-    ConfigPageElementType["HTML"] = "htmlElement";
-    ConfigPageElementType["JSONForm"] = "jsonForm";
-})(ConfigPageElementType = exports.ConfigPageElementType || (exports.ConfigPageElementType = {}));
 /** Choices of Step Error Handlers that define the behavior when a step error occurs. */
 var StepErrorHandlerType;
 (function (StepErrorHandlerType) {
@@ -59,9 +48,6 @@ var ConfigVarDataType;
     ConfigVarDataType["Code"] = "code";
     ConfigVarDataType["Boolean"] = "boolean";
     ConfigVarDataType["Number"] = "number";
-    ConfigVarDataType["ObjectSelection"] = "objectSelection";
-    ConfigVarDataType["ObjectFieldMap"] = "objectFieldMap";
-    ConfigVarDataType["JSONForm"] = "jsonForm";
 })(ConfigVarDataType = exports.ConfigVarDataType || (exports.ConfigVarDataType = {}));
 /** Choices of programming languages that may be used for Config Var code values. */
 var CodeLanguageType;

package/dist/types/TriggerDefinition.d.ts

@@ -1,4 +1,4 @@
-import { ActionDisplayDefinition, TriggerPerformFunction, TriggerEventFunction, Inputs, TriggerResult } from ".";
+import { ActionDisplayDefinition, TriggerPerformFunction, TriggerEventFunction, Inputs, TriggerResult, ConfigVarResultCollection, TriggerPayload } from ".";
 declare const optionChoices: readonly ["invalid", "valid", "required"];
 export declare type TriggerOptionChoice = typeof optionChoices[number];
 export declare const TriggerOptionChoices: TriggerOptionChoice[];
@@ -6,15 +6,15 @@ export declare const TriggerOptionChoices: TriggerOptionChoice[];
  * TriggerDefinition is the type of the object that is passed in to `trigger` function to
  * define a component trigger.
  */
-export interface TriggerDefinition<TInputs extends Inputs, TAllowsBranching extends boolean, TResult extends TriggerResult<TAllowsBranching>> {
+export interface TriggerDefinition<TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TAllowsBranching extends boolean, TResult extends TriggerResult<TAllowsBranching, TriggerPayload>> {
     /** Defines how the Trigger is displayed in the Prismatic interface. */
     display: ActionDisplayDefinition;
     /** Function to perform when this Trigger is invoked. */
-    perform: TriggerPerformFunction<TInputs, TAllowsBranching, TResult>;
+    perform: TriggerPerformFunction<TInputs, TConfigVars, TAllowsBranching, TResult>;
     /** Function to execute when an Instance of an Integration with a Flow that uses this Trigger is deployed. */
-    onInstanceDeploy?: TriggerEventFunction<TInputs>;
+    onInstanceDeploy?: TriggerEventFunction<TInputs, TConfigVars>;
     /** Function to execute when an Instance of an Integration with a Flow that uses this Trigger is deleted. */
-    onInstanceDelete?: TriggerEventFunction<TInputs>;
+    onInstanceDelete?: TriggerEventFunction<TInputs, TConfigVars>;
     /** InputFields to present in the Prismatic interface for configuration of this Trigger. */
     inputs: TInputs;
     /** Specifies whether this Trigger supports executing the Integration on a recurring schedule. */

package/dist/types/TriggerEventFunction.d.ts

@@ -1,4 +1,4 @@
-import { Inputs, ActionContext, ActionInputParameters } from ".";
+import { Inputs, ActionContext, ActionInputParameters, ConfigVarResultCollection } from ".";
 export declare 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>;
@@ -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> = (context: ActionContext, params: ActionInputParameters<TInputs>) => Promise<void | TriggerEventFunctionReturn>;
+export declare type TriggerEventFunction<TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection> = (context: ActionContext<TConfigVars>, params: ActionInputParameters<TInputs>) => Promise<void | TriggerEventFunctionReturn>;

package/dist/types/TriggerPerformFunction.d.ts

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

package/dist/types/TriggerResult.d.ts

@@ -1,9 +1,9 @@
 import { TriggerPayload } from "./TriggerPayload";
 import { HttpResponse } from "./HttpResponse";
 /** Represents the result of a Trigger action. */
-export interface TriggerBaseResult {
+export interface TriggerBaseResult<TPayload extends TriggerPayload> {
     /** The payload in the request that invoked the Integration, which is returned as a result for later use. */
-    payload: TriggerPayload;
+    payload: TPayload;
     /** Optional HTTP response to the request that invoked the integration. */
     response?: HttpResponse;
     /** An optional object, the keys and values of which will be persisted in the flow-specific instanceState and available for subsequent actions and executions */
@@ -20,9 +20,9 @@ export interface TriggerBaseResult {
     error?: Record<string, unknown>;
 }
 /** Represents the result of a Trigger action that uses branching. */
-export interface TriggerBranchingResult extends TriggerBaseResult {
+export interface TriggerBranchingResult<TPayload extends TriggerPayload> extends TriggerBaseResult<TPayload> {
     /** Name of the Branch to take. */
     branch: string;
 }
 /** Required return type of all trigger perform functions */
-export declare type TriggerResult<AllowsBranching extends boolean | undefined> = (AllowsBranching extends true ? TriggerBranchingResult : TriggerBaseResult) | undefined;
+export declare type TriggerResult<AllowsBranching extends boolean | undefined, TPayload extends TriggerPayload> = (AllowsBranching extends true ? TriggerBranchingResult<TPayload> : TriggerBaseResult<TPayload>) | undefined;

package/dist/types/utils.d.ts

@@ -0,0 +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> = {
+    [K in keyof T]: T[K];
+};
+export declare type ValueOf<T> = T[keyof T];

package/dist/types/utils.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "8.0.0-preview8",
+  "version": "8.0.1",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"
@@ -38,14 +38,14 @@
   ],
   "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",
+    "lodash": "4.17.21",
     "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",
@@ -53,6 +53,7 @@
   },
   "devDependencies": {
     "@types/jest": "27.4.1",
+    "@types/lodash": "4.14.202",
     "@types/node": "14.14.35",
     "@types/sax": "1.2.4",
     "@types/url-join": "4.0.1",

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;