@cap-ts/soap-adapter 0.1.0 → 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.cds +1 -2
- package/package.json +5 -3
- package/src/index.js +1 -1
- package/src/lib/_base/index.js +1 -1
- package/src/lib/_builder/index.js +1 -1
- package/src/lib/_client/index.js +1 -1
- package/src/lib/_loader/index.js +1 -1
- package/src/lib/_orchestrator/index.js +1 -1
- package/src/lib/index.js +1 -1
- package/types/index.d.ts +1 -0
- package/types/lib/index.d.ts +8 -12
- package/types/lib/index.d.ts.map +1 -1
- package/src/lib/Base.js +0 -1
- package/src/lib/Orchestrator.js +0 -1
- package/src/lib/base/index.js +0 -1
- package/src/lib/client.js +0 -1
- package/src/lib/orchestrator/index.js +0 -1
- package/src/lib/plugin-loader.js +0 -1
- package/types/lib/Base.d.ts +0 -100
- package/types/lib/Base.d.ts.map +0 -1
- package/types/lib/Orchestrator.d.ts +0 -184
- package/types/lib/Orchestrator.d.ts.map +0 -1
- package/types/lib/base/index.d.ts +0 -96
- package/types/lib/base/index.d.ts.map +0 -1
- package/types/lib/client.d.ts +0 -3
- package/types/lib/client.d.ts.map +0 -1
- package/types/lib/orchestrator/index.d.ts +0 -180
- package/types/lib/orchestrator/index.d.ts.map +0 -1
- package/types/lib/plugin-loader.d.ts +0 -3
- package/types/lib/plugin-loader.d.ts.map +0 -1
|
@@ -1,180 +0,0 @@
|
|
|
1
|
-
export type TraceContext = {
|
|
2
|
-
/**
|
|
3
|
-
* - Unique execution tracking identifier used for log tracking.
|
|
4
|
-
*/
|
|
5
|
-
correlationId: string;
|
|
6
|
-
/**
|
|
7
|
-
* - ID of the acting user or 'anonymous'.
|
|
8
|
-
*/
|
|
9
|
-
user: string;
|
|
10
|
-
/**
|
|
11
|
-
* - ISO timestamp string indicating when the pipeline transaction initiated.
|
|
12
|
-
*/
|
|
13
|
-
timestamp: string;
|
|
14
|
-
};
|
|
15
|
-
export type SoapBindingConfig = {
|
|
16
|
-
/**
|
|
17
|
-
* - The exact SOAP operation/method name exposed by the WSDL.
|
|
18
|
-
*/
|
|
19
|
-
operation: string;
|
|
20
|
-
/**
|
|
21
|
-
* - Optional constructor reference for an adapter class handling lifecycle hook overrides.
|
|
22
|
-
*/
|
|
23
|
-
resolvedAdapterClass?: Function;
|
|
24
|
-
/**
|
|
25
|
-
* - Overriding XML root element wrapper tag for outgoing payloads. Uses "none" to pass raw data.
|
|
26
|
-
*/
|
|
27
|
-
rootRequest?: string;
|
|
28
|
-
/**
|
|
29
|
-
* - Explicit dot-notation pathway string indicating where the dataset payload array sits inside the incoming response.
|
|
30
|
-
*/
|
|
31
|
-
rootResponse?: string;
|
|
32
|
-
};
|
|
33
|
-
/**
|
|
34
|
-
* [@soap.path] - Explicit target data pathway mapping override to navigate the raw SOAP object graph.
|
|
35
|
-
*/
|
|
36
|
-
export type CdsEntityElement = {
|
|
37
|
-
/**
|
|
38
|
-
* - The primitive data type classification string (e.g., 'cds.String').
|
|
39
|
-
*/
|
|
40
|
-
type?: string;
|
|
41
|
-
""?: string;
|
|
42
|
-
};
|
|
43
|
-
export type CdsEntity = {
|
|
44
|
-
/**
|
|
45
|
-
* - The fully qualified name string of the underlying domain model entity.
|
|
46
|
-
*/
|
|
47
|
-
name: string;
|
|
48
|
-
/**
|
|
49
|
-
* - Key-value pair configuration maps of the entity fields.
|
|
50
|
-
*/
|
|
51
|
-
elements: {
|
|
52
|
-
[x: string]: CdsEntityElement;
|
|
53
|
-
};
|
|
54
|
-
"": SoapBindingConfig;
|
|
55
|
-
};
|
|
56
|
-
export type SoapHeaderObject = {
|
|
57
|
-
/**
|
|
58
|
-
* - The core body value or sub-graph assigned inside the soap header layer block.
|
|
59
|
-
*/
|
|
60
|
-
value?: any;
|
|
61
|
-
/**
|
|
62
|
-
* - Target namespace tag name descriptor applied to XML tracking.
|
|
63
|
-
*/
|
|
64
|
-
name?: string;
|
|
65
|
-
/**
|
|
66
|
-
* - Extracted XML prefix label binding node structure entries.
|
|
67
|
-
*/
|
|
68
|
-
prefix?: string;
|
|
69
|
-
/**
|
|
70
|
-
* - Full target URI qualification schema address string.
|
|
71
|
-
*/
|
|
72
|
-
xmlns?: string;
|
|
73
|
-
};
|
|
74
|
-
export type BaseAdapterInstance = {
|
|
75
|
-
/**
|
|
76
|
-
* - Registered request mutation callback stacks.
|
|
77
|
-
*/
|
|
78
|
-
_requestHandlers: {
|
|
79
|
-
[x: string]: ((arg0: any, arg1: cds.Request) => (Promise<any> | any))[];
|
|
80
|
-
};
|
|
81
|
-
/**
|
|
82
|
-
* - Sandbox mock boundary intercept hooks.
|
|
83
|
-
*/
|
|
84
|
-
_mockHandlers: {
|
|
85
|
-
[x: string]: (arg0: any, arg1: cds.Request) => (Promise<any> | any);
|
|
86
|
-
};
|
|
87
|
-
/**
|
|
88
|
-
* - Custom explicit security header factory injectors.
|
|
89
|
-
*/
|
|
90
|
-
_headerHandlers: {
|
|
91
|
-
[x: string]: (SoapHeaderObject | ((arg0: any, arg1: cds.Request) => (Promise<SoapHeaderObject> | SoapHeaderObject)))[];
|
|
92
|
-
};
|
|
93
|
-
/**
|
|
94
|
-
* - Dynamic override translation format steps.
|
|
95
|
-
*/
|
|
96
|
-
_responseHandlers: {
|
|
97
|
-
[x: string]: ((arg0: any, arg1: cds.Request) => (Promise<Array<any>> | Array<any>))[];
|
|
98
|
-
};
|
|
99
|
-
};
|
|
100
|
-
/**
|
|
101
|
-
* @typedef {Object} TraceContext
|
|
102
|
-
* @property {string} correlationId - Unique execution tracking identifier used for log tracking.
|
|
103
|
-
* @property {string} user - ID of the acting user or 'anonymous'.
|
|
104
|
-
* @property {string} timestamp - ISO timestamp string indicating when the pipeline transaction initiated.
|
|
105
|
-
*/
|
|
106
|
-
/**
|
|
107
|
-
* @typedef {Object} SoapBindingConfig
|
|
108
|
-
* @property {string} operation - The exact SOAP operation/method name exposed by the WSDL.
|
|
109
|
-
* @property {Function} [resolvedAdapterClass] - Optional constructor reference for an adapter class handling lifecycle hook overrides.
|
|
110
|
-
* @property {string} [rootRequest] - Overriding XML root element wrapper tag for outgoing payloads. Uses "none" to pass raw data.
|
|
111
|
-
* @property {string} [rootResponse] - Explicit dot-notation pathway string indicating where the dataset payload array sits inside the incoming response.
|
|
112
|
-
*/
|
|
113
|
-
/**
|
|
114
|
-
* @typedef {Object} CdsEntityElement
|
|
115
|
-
* @property {string} [type] - The primitive data type classification string (e.g., 'cds.String').
|
|
116
|
-
* @property {string} [@soap.path] - Explicit target data pathway mapping override to navigate the raw SOAP object graph.
|
|
117
|
-
*/
|
|
118
|
-
/**
|
|
119
|
-
* @typedef {Object} CdsEntity
|
|
120
|
-
* @property {string} name - The fully qualified name string of the underlying domain model entity.
|
|
121
|
-
* @property {Object.<string, CdsEntityElement>} elements - Key-value pair configuration maps of the entity fields.
|
|
122
|
-
* @property {SoapBindingConfig} @soap.binding - Embedded annotations directive containing runtime transport instructions.
|
|
123
|
-
* @property {Object} parent - Positional contextual parent registry handle.
|
|
124
|
-
* @property {string} parent.name - The explicit namespace identifier of the parent service.
|
|
125
|
-
*/
|
|
126
|
-
/**
|
|
127
|
-
* @typedef {Object} SoapHeaderObject
|
|
128
|
-
* @property {*} [value] - The core body value or sub-graph assigned inside the soap header layer block.
|
|
129
|
-
* @property {string} [name] - Target namespace tag name descriptor applied to XML tracking.
|
|
130
|
-
* @property {string} [prefix] - Extracted XML prefix label binding node structure entries.
|
|
131
|
-
* @property {string} [xmlns] - Full target URI qualification schema address string.
|
|
132
|
-
*/
|
|
133
|
-
/**
|
|
134
|
-
* @typedef {Object} BaseAdapterInstance
|
|
135
|
-
* @property {Object.<string, Array<function(*, cds.Request): (Promise.<*>|*)>>} _requestHandlers - Registered request mutation callback stacks.
|
|
136
|
-
* @property {Object.<string, function(*, cds.Request): (Promise.<*>|*)>} _mockHandlers - Sandbox mock boundary intercept hooks.
|
|
137
|
-
* @property {Object.<string, Array<(SoapHeaderObject|function(*, cds.Request): (Promise.<SoapHeaderObject>|SoapHeaderObject))>>} _headerHandlers - Custom explicit security header factory injectors.
|
|
138
|
-
* @property {Object.<string, Array<function(*, cds.Request): (Promise.<Array.<Object>>|Array.<Object>)>>} _responseHandlers - Dynamic override translation format steps.
|
|
139
|
-
*/
|
|
140
|
-
/**
|
|
141
|
-
* Orchestrates CAP-to-SOAP middleware pipelines by managing boot-time target file system validations,
|
|
142
|
-
* dynamically fetching soap client proxies, executing lifecycle event hooks, parsing path lookups,
|
|
143
|
-
* and converting structural nested objects into planar array datasets.
|
|
144
|
-
*/
|
|
145
|
-
export class Orchestrator {
|
|
146
|
-
/**
|
|
147
|
-
* Reusable utility to normalize the WSDL path string by handling relative normalization
|
|
148
|
-
* and hardcoding the suffix fallback extension if the user left it off.
|
|
149
|
-
* @param {string} [configuredPath] - The raw path configuration string to evaluate.
|
|
150
|
-
* @returns {string} The finalized absolute file system path, or an empty string if input evaluates to falsy.
|
|
151
|
-
* @static
|
|
152
|
-
*/
|
|
153
|
-
static resolveWsdlPath(configuredPath?: string): string;
|
|
154
|
-
/**
|
|
155
|
-
* Traverses a deeply nested complex object structure down an explicit dot-notation path, resolving unwrapped
|
|
156
|
-
* `$value` fields or underlying item collection arrays where necessary.
|
|
157
|
-
* @param {*} obj - The base root object graph to traverse.
|
|
158
|
-
* @param {string} [pathStr] - A dot-separated string path mapping out destination elements (e.g., 'Result.Data.Record').
|
|
159
|
-
* @returns {*} Evaluated value at target path, unnested item collection arrays, or `undefined` if parsing falls flat.
|
|
160
|
-
* @static
|
|
161
|
-
*/
|
|
162
|
-
static getNestedValue(obj: any, pathStr?: string): any;
|
|
163
|
-
/**
|
|
164
|
-
* Fail-Fast Integrity Guard running checks on application boot sequence.
|
|
165
|
-
* Iterates over framework environment requirements on initialization to enforce fail-fast application boot structural safety.
|
|
166
|
-
* @throws {Error} If a configured SOAP service lacks a specified tracking path or the target storage asset is physically missing.
|
|
167
|
-
* @returns {void}
|
|
168
|
-
*/
|
|
169
|
-
validateProjectConfigurations(): void;
|
|
170
|
-
/**
|
|
171
|
-
* Executes the lifecycle pipeline tracking processing workflow loop for intercepted interface interactions.
|
|
172
|
-
* Handles payload pre-processing, automatic XML root generation packaging, header injection, live network communication or mocking,
|
|
173
|
-
* and recursive flattening conversions into mapping models.
|
|
174
|
-
* @param {cds.Request} req - The incoming runtime context parameter bundle payload managed by the active application framework.
|
|
175
|
-
* @returns {Promise<Array<Object>|void>} Resolves with a flat array mapping extracted data elements, or undefined if configuration conditions break early.
|
|
176
|
-
* @async
|
|
177
|
-
*/
|
|
178
|
-
handleEvent(req: cds.Request): Promise<Array<any> | void>;
|
|
179
|
-
}
|
|
180
|
-
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"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"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"plugin-loader.d.ts","sourceRoot":"","sources":["../../.types/lib/plugin-loader.js"],"names":[],"mappings":"AAMiB,kCA8FhB"}
|