@cap-ts/soap-adapter 0.1.0 → 0.1.6

package/types/lib/base/index.d.ts

@@ -1,96 +0,0 @@
-export type TraceContext = import("../orchestrator").TraceContext;
-export type CdsEntity = import("../orchestrator").CdsEntity;
-export type SoapHeaderObject = import("../orchestrator").SoapHeaderObject;
-/**
- * @typedef {import('../orchestrator').TraceContext} TraceContext
- * @typedef {import('../orchestrator').CdsEntity} CdsEntity
- * @typedef {import('../orchestrator').SoapHeaderObject} SoapHeaderObject
- */
-/**
- * Abstract foundational class defining structural contracts and lifecycle hook registration chains
- * for CAP-to-SOAP adapter overrides. This class cannot be instantiated directly.
- *
- * @abstract
- */
-export class Base {
-    /**
-     * Initializes the abstract service base layout.
-     * @param {CdsEntity} entity - Contextual meta-reflection model representing the current execution entity instance.
-     * @param {cds.Request} req - The incoming runtime context parameter bundle payload managed by the active application framework.
-     * @param {TraceContext} traceContext - Unique execution tracking identifier context map used for logging.
-     * @throws {TypeError} If this abstract class is directly instantiated via `new Base()`.
-     */
-    constructor(entity: CdsEntity, req: cds.Request, traceContext: TraceContext);
-    entity: import("../orchestrator").CdsEntity;
-    req: cds.Request;
-    traceContext: import("../orchestrator").TraceContext;
-    _requestHandlers: {};
-    _responseHandlers: {};
-    _mockHandlers: {};
-    _headerHandlers: {};
-    /**
-     * Abstract initialization sequence triggered automatically during instance generation.
-     * Must be overridden in child classes to establish event listeners.
-     * @abstract
-     * @throws {Error} If the derived child class does not implement this method.
-     * @returns {void}
-     */
-    init(): void;
-    /**
-     * @callback SoapHeaderEvaluator
-     * @param {cds.Request} req - The incoming CAP request context.
-     * @param {*} [data] - The optional secondary payload data context.
-     * @returns {Promise.<SoapHeaderObject>|SoapHeaderObject}
-     */
-    /**
-     * Registers a custom SOAP header factory interceptor or a static structural payload value for a specific entity.
-     * @param {string} entityName - Unqualified short name modifier string targeting an internal entity definition.
-     * @param {SoapHeaderObject|SoapHeaderEvaluator} handler - A static header matching object configurations or an executable factory generator function.
-     * @throws {Error} If the provided handler is neither a functional execution block nor an object structure.
-     * @returns {void}
-     */
-    header(entityName: string, handler: SoapHeaderObject | ((req: cds.Request, data?: any) => Promise<SoapHeaderObject> | SoapHeaderObject)): void;
-    /**
-     * @callback SoapRequestEvaluator
-     * @param {cds.Request} req - The incoming CAP request context.
-     * @param {*} [data] - The optional secondary payload data context.
-     * @returns {Promise.<*>|*}
-     */
-    /**
-     * Appends a pre-flight payload manipulation interceptor function to the execution chain of an entity.
-     * @param {string} entityName - Unqualified short name modifier string targeting an internal entity definition.
-     * @param {SoapRequestEvaluator} handler - Callback function mutating incoming outbound arguments.
-     * @throws {Error} If the handler input fails functional type evaluation checks.
-     * @returns {void}
-     */
-    request(entityName: string, handler: (req: cds.Request, data?: any) => Promise<any> | any): void;
-    /**
-     * @callback SoapMockEvaluator
-     * @param {cds.Request} req - The incoming CAP request context.
-     * @param {*} [data] - The optional secondary payload data context.
-     * @returns {Promise.<*>|*}
-     */
-    /**
-     * Registers a single intercept sandbox bypass mock handler function for an entity, overriding native network requests entirely.
-     * @param {string} entityName - Unqualified short name modifier string targeting an internal entity definition.
-     * @param {SoapMockEvaluator} handler - Intercept bypass simulation callback executing sandboxed returns.
-     * @throws {Error} If the handler input fails functional type evaluation checks.
-     * @returns {void}
-     */
-    mock(entityName: string, handler: (req: cds.Request, data?: any) => Promise<any> | any): void;
-    /**
-    * @callback SoapResponseEvaluator
-    * @param {cds.Request} req - The incoming CAP request context.
-    * @param {*} data - The response data context.
-    * @returns {Promise.<Array.<Object>>|Array.<Object>}
-    */
-    /**
-     * Appends a post-flight response extraction array mapping transformation interceptor function to the execution chain of an entity.
-     * @param {string} entityName - Unqualified short name modifier string targeting an internal entity definition.
-     * @param {SoapResponseEvaluator} handler - Translation mapper formatting downstream runtime array structures.
-     * @throws {Error} If the handler input fails functional type evaluation checks.
-     * @returns {void}
-     */
-    response(entityName: string, handler: (req: cds.Request, data: any) => Promise<Array<any>> | Array<any>): void;
-}
-//# sourceMappingURL=index.d.ts.map

package/types/lib/base/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../.types/lib/base/index.js"],"names":[],"mappings":"2BACa,OAAO,iBAAiB,EAAE,YAAY;wBACtC,OAAO,iBAAiB,EAAE,SAAS;+BACnC,OAAO,iBAAiB,EAAE,gBAAgB;AAHvD;;;;GAIG;AAEH;;;;;GAKG;AACH;IACI;;;;;;OAMG;IACH,oBALW,SAAS,OACT,GAAG,CAAC,OAAO,gBACX,YAAY,EAkBtB;IAdG,4CAAoB;IACpB,iBAAc;IACd,qDAAgC;IAGhC,qBAA0B;IAC1B,sBAA2B;IAC3B,kBAAuB;IACvB,oBAAyB;IAQ7B;;;;;;OAMG;IACH,QAFa,IAAI,CAIhB;IAED;;;;;OAKG;IAEH;;;;;;OAMG;IACH,mBALW,MAAM,WACN,gBAAgB,UARhB,GAAG,CAAC,OAAO,SACX,GAAC,KACC,OAAO,CAAE,gBAAgB,CAAC,GAAC,gBAAgB,CAMT,GAElC,IAAI,CAQhB;IAED;;;;;OAKG;IAEH;;;;;;OAMG;IACH,oBALW,MAAM,iBAPN,GAAG,CAAC,OAAO,SACX,GAAC,KACC,OAAO,CAAE,GAAC,CAAC,GAAC,GAAC,GAQb,IAAI,CAMhB;IAED;;;;;OAKG;IAEH;;;;;;OAMG;IACH,iBALW,MAAM,iBAPN,GAAG,CAAC,OAAO,SACX,GAAC,KACC,OAAO,CAAE,GAAC,CAAC,GAAC,GAAC,GAQb,IAAI,CAKhB;IAEA;;;;;MAKE;IAEH;;;;;;OAMG;IACH,qBALW,MAAM,iBAPN,GAAG,CAAC,OAAO,QACX,GAAC,KACC,OAAO,CAAE,KAAK,KAAS,CAAC,GAAC,KAAK,KAAS,GAQvC,IAAI,CAMhB;CACJ"}

package/types/lib/client.d.ts

@@ -1,3 +0,0 @@
-export function getSoapClient(serviceName: any, localWsdlPath: any): Promise<soap.Client>;
-import soap = require("soap");
-//# sourceMappingURL=client.d.ts.map

package/types/lib/client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../.types/lib/client.js"],"names":[],"mappings":"AAIA,0FA4CC"}

package/types/lib/orchestrator/index.d.ts

@@ -1,180 +0,0 @@
-export type TraceContext = {
-    /**
-     * - Unique execution tracking identifier used for log tracking.
-     */
-    correlationId: string;
-    /**
-     * - ID of the acting user or 'anonymous'.
-     */
-    user: string;
-    /**
-     * - ISO timestamp string indicating when the pipeline transaction initiated.
-     */
-    timestamp: string;
-};
-export type SoapBindingConfig = {
-    /**
-     * - The exact SOAP operation/method name exposed by the WSDL.
-     */
-    operation: string;
-    /**
-     * - Optional constructor reference for an adapter class handling lifecycle hook overrides.
-     */
-    resolvedAdapterClass?: Function;
-    /**
-     * - Overriding XML root element wrapper tag for outgoing payloads. Uses "none" to pass raw data.
-     */
-    rootRequest?: string;
-    /**
-     * - Explicit dot-notation pathway string indicating where the dataset payload array sits inside the incoming response.
-     */
-    rootResponse?: string;
-};
-/**
- * [@soap.path] - Explicit target data pathway mapping override to navigate the raw SOAP object graph.
- */
-export type CdsEntityElement = {
-    /**
-     * - The primitive data type classification string (e.g., 'cds.String').
-     */
-    type?: string;
-    ""?: string;
-};
-export type CdsEntity = {
-    /**
-     * - The fully qualified name string of the underlying domain model entity.
-     */
-    name: string;
-    /**
-     * - Key-value pair configuration maps of the entity fields.
-     */
-    elements: {
-        [x: string]: CdsEntityElement;
-    };
-    "": SoapBindingConfig;
-};
-export type SoapHeaderObject = {
-    /**
-     * - The core body value or sub-graph assigned inside the soap header layer block.
-     */
-    value?: any;
-    /**
-     * - Target namespace tag name descriptor applied to XML tracking.
-     */
-    name?: string;
-    /**
-     * - Extracted XML prefix label binding node structure entries.
-     */
-    prefix?: string;
-    /**
-     * - Full target URI qualification schema address string.
-     */
-    xmlns?: string;
-};
-export type BaseAdapterInstance = {
-    /**
-     * - Registered request mutation callback stacks.
-     */
-    _requestHandlers: {
-        [x: string]: ((arg0: any, arg1: cds.Request) => (Promise<any> | any))[];
-    };
-    /**
-     * - Sandbox mock boundary intercept hooks.
-     */
-    _mockHandlers: {
-        [x: string]: (arg0: any, arg1: cds.Request) => (Promise<any> | any);
-    };
-    /**
-     * - Custom explicit security header factory injectors.
-     */
-    _headerHandlers: {
-        [x: string]: (SoapHeaderObject | ((arg0: any, arg1: cds.Request) => (Promise<SoapHeaderObject> | SoapHeaderObject)))[];
-    };
-    /**
-     * - Dynamic override translation format steps.
-     */
-    _responseHandlers: {
-        [x: string]: ((arg0: any, arg1: cds.Request) => (Promise<Array<any>> | Array<any>))[];
-    };
-};
-/**
- * @typedef {Object} TraceContext
- * @property {string} correlationId - Unique execution tracking identifier used for log tracking.
- * @property {string} user - ID of the acting user or 'anonymous'.
- * @property {string} timestamp - ISO timestamp string indicating when the pipeline transaction initiated.
- */
-/**
- * @typedef {Object} SoapBindingConfig
- * @property {string} operation - The exact SOAP operation/method name exposed by the WSDL.
- * @property {Function} [resolvedAdapterClass] - Optional constructor reference for an adapter class handling lifecycle hook overrides.
- * @property {string} [rootRequest] - Overriding XML root element wrapper tag for outgoing payloads. Uses "none" to pass raw data.
- * @property {string} [rootResponse] - Explicit dot-notation pathway string indicating where the dataset payload array sits inside the incoming response.
- */
-/**
- * @typedef {Object} CdsEntityElement
- * @property {string} [type] - The primitive data type classification string (e.g., 'cds.String').
- * @property {string} [@soap.path] - Explicit target data pathway mapping override to navigate the raw SOAP object graph.
- */
-/**
- * @typedef {Object} CdsEntity
- * @property {string} name - The fully qualified name string of the underlying domain model entity.
- * @property {Object.<string, CdsEntityElement>} elements - Key-value pair configuration maps of the entity fields.
- * @property {SoapBindingConfig} @soap.binding - Embedded annotations directive containing runtime transport instructions.
- * @property {Object} parent - Positional contextual parent registry handle.
- * @property {string} parent.name - The explicit namespace identifier of the parent service.
- */
-/**
- * @typedef {Object} SoapHeaderObject
- * @property {*} [value] - The core body value or sub-graph assigned inside the soap header layer block.
- * @property {string} [name] - Target namespace tag name descriptor applied to XML tracking.
- * @property {string} [prefix] - Extracted XML prefix label binding node structure entries.
- * @property {string} [xmlns] - Full target URI qualification schema address string.
- */
-/**
- * @typedef {Object} BaseAdapterInstance
- * @property {Object.<string, Array<function(*, cds.Request): (Promise.<*>|*)>>} _requestHandlers - Registered request mutation callback stacks.
- * @property {Object.<string, function(*, cds.Request): (Promise.<*>|*)>} _mockHandlers - Sandbox mock boundary intercept hooks.
- * @property {Object.<string, Array<(SoapHeaderObject|function(*, cds.Request): (Promise.<SoapHeaderObject>|SoapHeaderObject))>>} _headerHandlers - Custom explicit security header factory injectors.
- * @property {Object.<string, Array<function(*, cds.Request): (Promise.<Array.<Object>>|Array.<Object>)>>} _responseHandlers - Dynamic override translation format steps.
- */
-/**
- * Orchestrates CAP-to-SOAP middleware pipelines by managing boot-time target file system validations,
- * dynamically fetching soap client proxies, executing lifecycle event hooks, parsing path lookups,
- * and converting structural nested objects into planar array datasets.
- */
-export class Orchestrator {
-    /**
-     * Reusable utility to normalize the WSDL path string by handling relative normalization
-     * and hardcoding the suffix fallback extension if the user left it off.
-     * @param {string} [configuredPath] - The raw path configuration string to evaluate.
-     * @returns {string} The finalized absolute file system path, or an empty string if input evaluates to falsy.
-     * @static
-     */
-    static resolveWsdlPath(configuredPath?: string): string;
-    /**
-     * Traverses a deeply nested complex object structure down an explicit dot-notation path, resolving unwrapped
-     * `$value` fields or underlying item collection arrays where necessary.
-     * @param {*} obj - The base root object graph to traverse.
-     * @param {string} [pathStr] - A dot-separated string path mapping out destination elements (e.g., 'Result.Data.Record').
-     * @returns {*} Evaluated value at target path, unnested item collection arrays, or `undefined` if parsing falls flat.
-     * @static
-     */
-    static getNestedValue(obj: any, pathStr?: string): any;
-    /**
-     * Fail-Fast Integrity Guard running checks on application boot sequence.
-     * Iterates over framework environment requirements on initialization to enforce fail-fast application boot structural safety.
-     * @throws {Error} If a configured SOAP service lacks a specified tracking path or the target storage asset is physically missing.
-     * @returns {void}
-     */
-    validateProjectConfigurations(): void;
-    /**
-     * Executes the lifecycle pipeline tracking processing workflow loop for intercepted interface interactions.
-     * Handles payload pre-processing, automatic XML root generation packaging, header injection, live network communication or mocking,
-     * and recursive flattening conversions into mapping models.
-     * @param {cds.Request} req - The incoming runtime context parameter bundle payload managed by the active application framework.
-     * @returns {Promise<Array<Object>|void>} Resolves with a flat array mapping extracted data elements, or undefined if configuration conditions break early.
-     * @async
-     */
-    handleEvent(req: cds.Request): Promise<Array<any> | void>;
-}
-//# sourceMappingURL=index.d.ts.map

package/types/lib/orchestrator/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../.types/lib/orchestrator/index.js"],"names":[],"mappings":";;;;mBAMc,MAAM;;;;UACN,MAAM;;;;eACN,MAAM;;;;;;eAKN,MAAM;;;;;;;;kBAEN,MAAM;;;;mBACN,MAAM;;;;;;;;;WAKN,MAAM;SACN,MAAM;;;;;;UAKN,MAAM;;;;;;;QAEN,iBAAiB;;;;;;YAOjB,GAAC;;;;WACD,MAAM;;;;aACN,MAAM;;;;YACN,MAAM;;;;;;;6BAKyB,GAAC,QAAE,GAAG,CAAC,OAAO,KAAG,CAAC,OAAO,CAAE,GAAC,CAAC,GAAC,GAAC,CAAC;;;;;;4BACtC,GAAC,QAAE,GAAG,CAAC,OAAO,KAAG,CAAC,OAAO,CAAE,GAAC,CAAC,GAAC,GAAC,CAAC;;;;;;iDACR,GAAC,QAAE,GAAG,CAAC,OAAO,KAAG,CAAC,OAAO,CAAE,gBAAgB,CAAC,GAAC,gBAAgB,CAAC;;;;;;6BAChF,GAAC,QAAE,GAAG,CAAC,OAAO,KAAG,CAAC,OAAO,CAAE,KAAK,KAAS,CAAC,GAAC,KAAK,KAAS,CAAC;;;AA3CvG;;;;;GAKG;AAEH;;;;;;GAMG;AAEH;;;;GAIG;AAEH;;;;;;;GAOG;AAEH;;;;;;GAMG;AAEH;;;;;;GAMG;AAEH;;;;GAIG;AACH;IASI;;;;;;OAMG;IACH,wCAJW,MAAM,GACJ,MAAM,CASlB;IAwBD;;;;;;;OAOG;IACH,2BALW,GAAC,YACD,MAAM,GACJ,GAAC,CAgBb;IA3CD;;;;;OAKG;IACH,iCAFa,IAAI,CAgBhB;IAyBD;;;;;;;OAOG;IACH,iBAJW,GAAG,CAAC,OAAO,GACT,OAAO,CAAC,KAAK,KAAQ,GAAC,IAAI,CAAC,CAsGvC;CACJ"}

package/types/lib/plugin-loader.d.ts

@@ -1,3 +0,0 @@
-declare function _exports(): void;
-export = _exports;
-//# sourceMappingURL=plugin-loader.d.ts.map

package/types/lib/plugin-loader.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin-loader.d.ts","sourceRoot":"","sources":["../../.types/lib/plugin-loader.js"],"names":[],"mappings":"AAMiB,kCA8FhB"}