@mcp-abap-adt/interfaces-adt 1.0.0
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/CHANGELOG.md +16 -0
- package/COPYING +674 -0
- package/LICENSE +165 -0
- package/README.md +35 -0
- package/dist/Headers.d.ts +57 -0
- package/dist/Headers.d.ts.map +1 -0
- package/dist/Headers.js +62 -0
- package/dist/adt/AdtTypes.d.ts +40 -0
- package/dist/adt/AdtTypes.d.ts.map +1 -0
- package/dist/adt/AdtTypes.js +5 -0
- package/dist/adt/IAdtAbapGit.d.ts +60 -0
- package/dist/adt/IAdtAbapGit.d.ts.map +1 -0
- package/dist/adt/IAdtAbapGit.js +2 -0
- package/dist/adt/IAdtAccessControl.d.ts +30 -0
- package/dist/adt/IAdtAccessControl.d.ts.map +1 -0
- package/dist/adt/IAdtAccessControl.js +5 -0
- package/dist/adt/IAdtAppendStructure.d.ts +32 -0
- package/dist/adt/IAdtAppendStructure.d.ts.map +1 -0
- package/dist/adt/IAdtAppendStructure.js +5 -0
- package/dist/adt/IAdtAuthorizationField.d.ts +49 -0
- package/dist/adt/IAdtAuthorizationField.d.ts.map +1 -0
- package/dist/adt/IAdtAuthorizationField.js +5 -0
- package/dist/adt/IAdtBehaviorDefinition.d.ts +58 -0
- package/dist/adt/IAdtBehaviorDefinition.d.ts.map +1 -0
- package/dist/adt/IAdtBehaviorDefinition.js +7 -0
- package/dist/adt/IAdtBehaviorImplementation.d.ts +30 -0
- package/dist/adt/IAdtBehaviorImplementation.d.ts.map +1 -0
- package/dist/adt/IAdtBehaviorImplementation.js +5 -0
- package/dist/adt/IAdtCapabilities.d.ts +391 -0
- package/dist/adt/IAdtCapabilities.d.ts.map +1 -0
- package/dist/adt/IAdtCapabilities.js +2 -0
- package/dist/adt/IAdtClass.d.ts +66 -0
- package/dist/adt/IAdtClass.d.ts.map +1 -0
- package/dist/adt/IAdtClass.js +5 -0
- package/dist/adt/IAdtClientOptions.d.ts +25 -0
- package/dist/adt/IAdtClientOptions.d.ts.map +1 -0
- package/dist/adt/IAdtClientOptions.js +9 -0
- package/dist/adt/IAdtContentTypes.d.ts +45 -0
- package/dist/adt/IAdtContentTypes.d.ts.map +1 -0
- package/dist/adt/IAdtContentTypes.js +13 -0
- package/dist/adt/IAdtDataElement.d.ts +95 -0
- package/dist/adt/IAdtDataElement.d.ts.map +1 -0
- package/dist/adt/IAdtDataElement.js +5 -0
- package/dist/adt/IAdtDdl.d.ts +37 -0
- package/dist/adt/IAdtDdl.d.ts.map +1 -0
- package/dist/adt/IAdtDdl.js +7 -0
- package/dist/adt/IAdtDomain.d.ts +79 -0
- package/dist/adt/IAdtDomain.d.ts.map +1 -0
- package/dist/adt/IAdtDomain.js +5 -0
- package/dist/adt/IAdtEnhancement.d.ts +61 -0
- package/dist/adt/IAdtEnhancement.d.ts.map +1 -0
- package/dist/adt/IAdtEnhancement.js +7 -0
- package/dist/adt/IAdtFeatureToggle.d.ts +100 -0
- package/dist/adt/IAdtFeatureToggle.d.ts.map +1 -0
- package/dist/adt/IAdtFeatureToggle.js +5 -0
- package/dist/adt/IAdtFunctionGroup.d.ts +52 -0
- package/dist/adt/IAdtFunctionGroup.d.ts.map +1 -0
- package/dist/adt/IAdtFunctionGroup.js +5 -0
- package/dist/adt/IAdtFunctionInclude.d.ts +23 -0
- package/dist/adt/IAdtFunctionInclude.d.ts.map +1 -0
- package/dist/adt/IAdtFunctionInclude.js +5 -0
- package/dist/adt/IAdtFunctionModule.d.ts +35 -0
- package/dist/adt/IAdtFunctionModule.d.ts.map +1 -0
- package/dist/adt/IAdtFunctionModule.js +5 -0
- package/dist/adt/IAdtInclude.d.ts +45 -0
- package/dist/adt/IAdtInclude.d.ts.map +1 -0
- package/dist/adt/IAdtInclude.js +17 -0
- package/dist/adt/IAdtInterface.d.ts +33 -0
- package/dist/adt/IAdtInterface.d.ts.map +1 -0
- package/dist/adt/IAdtInterface.js +5 -0
- package/dist/adt/IAdtMessageClass.d.ts +35 -0
- package/dist/adt/IAdtMessageClass.d.ts.map +1 -0
- package/dist/adt/IAdtMessageClass.js +2 -0
- package/dist/adt/IAdtMetadataExtension.d.ts +29 -0
- package/dist/adt/IAdtMetadataExtension.d.ts.map +1 -0
- package/dist/adt/IAdtMetadataExtension.js +5 -0
- package/dist/adt/IAdtObject.d.ts +224 -0
- package/dist/adt/IAdtObject.d.ts.map +1 -0
- package/dist/adt/IAdtObject.js +82 -0
- package/dist/adt/IAdtObjectState.d.ts +36 -0
- package/dist/adt/IAdtObjectState.d.ts.map +1 -0
- package/dist/adt/IAdtObjectState.js +13 -0
- package/dist/adt/IAdtPackage.d.ts +69 -0
- package/dist/adt/IAdtPackage.d.ts.map +1 -0
- package/dist/adt/IAdtPackage.js +5 -0
- package/dist/adt/IAdtProgram.d.ts +37 -0
- package/dist/adt/IAdtProgram.d.ts.map +1 -0
- package/dist/adt/IAdtProgram.js +5 -0
- package/dist/adt/IAdtResponse.d.ts +289 -0
- package/dist/adt/IAdtResponse.d.ts.map +1 -0
- package/dist/adt/IAdtResponse.js +51 -0
- package/dist/adt/IAdtScalarFunction.d.ts +30 -0
- package/dist/adt/IAdtScalarFunction.d.ts.map +1 -0
- package/dist/adt/IAdtScalarFunction.js +5 -0
- package/dist/adt/IAdtScalarFunctionImplementation.d.ts +35 -0
- package/dist/adt/IAdtScalarFunctionImplementation.d.ts.map +1 -0
- package/dist/adt/IAdtScalarFunctionImplementation.js +5 -0
- package/dist/adt/IAdtServiceBinding.d.ts +61 -0
- package/dist/adt/IAdtServiceBinding.d.ts.map +1 -0
- package/dist/adt/IAdtServiceBinding.js +33 -0
- package/dist/adt/IAdtServiceDefinition.d.ts +30 -0
- package/dist/adt/IAdtServiceDefinition.d.ts.map +1 -0
- package/dist/adt/IAdtServiceDefinition.js +5 -0
- package/dist/adt/IAdtShared.d.ts +110 -0
- package/dist/adt/IAdtShared.d.ts.map +1 -0
- package/dist/adt/IAdtShared.js +5 -0
- package/dist/adt/IAdtStructure.d.ts +48 -0
- package/dist/adt/IAdtStructure.d.ts.map +1 -0
- package/dist/adt/IAdtStructure.js +5 -0
- package/dist/adt/IAdtTable.d.ts +30 -0
- package/dist/adt/IAdtTable.d.ts.map +1 -0
- package/dist/adt/IAdtTable.js +5 -0
- package/dist/adt/IAdtTableType.d.ts +61 -0
- package/dist/adt/IAdtTableType.d.ts.map +1 -0
- package/dist/adt/IAdtTableType.js +5 -0
- package/dist/adt/IAdtTransformation.d.ts +33 -0
- package/dist/adt/IAdtTransformation.d.ts.map +1 -0
- package/dist/adt/IAdtTransformation.js +7 -0
- package/dist/adt/IAdtTransport.d.ts +104 -0
- package/dist/adt/IAdtTransport.d.ts.map +1 -0
- package/dist/adt/IAdtTransport.js +8 -0
- package/dist/adt/IAdtUnitTest.d.ts +125 -0
- package/dist/adt/IAdtUnitTest.d.ts.map +1 -0
- package/dist/adt/IAdtUnitTest.js +5 -0
- package/dist/adt/IAdtUtilities.d.ts +310 -0
- package/dist/adt/IAdtUtilities.d.ts.map +1 -0
- package/dist/adt/IAdtUtilities.js +92 -0
- package/dist/auth/AuthType.d.ts +5 -0
- package/dist/auth/AuthType.d.ts.map +1 -0
- package/dist/auth/AuthType.js +2 -0
- package/dist/auth/IAuthorizationConfig.d.ts +15 -0
- package/dist/auth/IAuthorizationConfig.d.ts.map +1 -0
- package/dist/auth/IAuthorizationConfig.js +2 -0
- package/dist/auth/IAuthorizationStrategy.d.ts +59 -0
- package/dist/auth/IAuthorizationStrategy.d.ts.map +1 -0
- package/dist/auth/IAuthorizationStrategy.js +12 -0
- package/dist/auth/ICallbackServer.d.ts +139 -0
- package/dist/auth/ICallbackServer.d.ts.map +1 -0
- package/dist/auth/ICallbackServer.js +2 -0
- package/dist/auth/ICertificateMaterialLoader.d.ts +7 -0
- package/dist/auth/ICertificateMaterialLoader.d.ts.map +1 -0
- package/dist/auth/ICertificateMaterialLoader.js +2 -0
- package/dist/auth/IConfig.d.ts +8 -0
- package/dist/auth/IConfig.d.ts.map +1 -0
- package/dist/auth/IConfig.js +2 -0
- package/dist/auth/IConnectionConfig.d.ts +23 -0
- package/dist/auth/IConnectionConfig.d.ts.map +1 -0
- package/dist/auth/IConnectionConfig.js +2 -0
- package/dist/connection/CalmService.d.ts +3 -0
- package/dist/connection/CalmService.d.ts.map +1 -0
- package/dist/connection/CalmService.js +14 -0
- package/dist/connection/IAbapConnection.d.ts +73 -0
- package/dist/connection/IAbapConnection.d.ts.map +1 -0
- package/dist/connection/IAbapConnection.js +2 -0
- package/dist/connection/IAbapRequestOptions.d.ts +9 -0
- package/dist/connection/IAbapRequestOptions.d.ts.map +1 -0
- package/dist/connection/IAbapRequestOptions.js +2 -0
- package/dist/connection/ICalmConnection.d.ts +29 -0
- package/dist/connection/ICalmConnection.d.ts.map +1 -0
- package/dist/connection/ICalmConnection.js +2 -0
- package/dist/connection/ICalmRequestOptions.d.ts +11 -0
- package/dist/connection/ICalmRequestOptions.d.ts.map +1 -0
- package/dist/connection/ICalmRequestOptions.js +2 -0
- package/dist/connection/IConnectionCapabilities.d.ts +217 -0
- package/dist/connection/IConnectionCapabilities.d.ts.map +1 -0
- package/dist/connection/IConnectionCapabilities.js +29 -0
- package/dist/execution/IAdtExecutors.d.ts +78 -0
- package/dist/execution/IAdtExecutors.d.ts.map +1 -0
- package/dist/execution/IAdtExecutors.js +9 -0
- package/dist/execution/IAdtRunnable.d.ts +61 -0
- package/dist/execution/IAdtRunnable.d.ts.map +1 -0
- package/dist/execution/IAdtRunnable.js +2 -0
- package/dist/execution/ITraceScheduling.d.ts +39 -0
- package/dist/execution/ITraceScheduling.d.ts.map +1 -0
- package/dist/execution/ITraceScheduling.js +15 -0
- package/dist/feeds/IFeedRepository.d.ts +32 -0
- package/dist/feeds/IFeedRepository.d.ts.map +1 -0
- package/dist/feeds/IFeedRepository.js +8 -0
- package/dist/feeds/types.d.ts +18 -0
- package/dist/feeds/types.d.ts.map +1 -0
- package/dist/feeds/types.js +9 -0
- package/dist/index.d.ts +103 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +57 -0
- package/dist/runtime/IApplicationLog.d.ts +21 -0
- package/dist/runtime/IApplicationLog.d.ts.map +1 -0
- package/dist/runtime/IApplicationLog.js +2 -0
- package/dist/runtime/IAtcLog.d.ts +15 -0
- package/dist/runtime/IAtcLog.d.ts.map +1 -0
- package/dist/runtime/IAtcLog.js +2 -0
- package/dist/runtime/IAtcRun.d.ts +99 -0
- package/dist/runtime/IAtcRun.d.ts.map +1 -0
- package/dist/runtime/IAtcRun.js +10 -0
- package/dist/runtime/ICrossTrace.d.ts +32 -0
- package/dist/runtime/ICrossTrace.d.ts.map +1 -0
- package/dist/runtime/ICrossTrace.js +2 -0
- package/dist/runtime/IDdicActivation.d.ts +12 -0
- package/dist/runtime/IDdicActivation.d.ts.map +1 -0
- package/dist/runtime/IDdicActivation.js +2 -0
- package/dist/runtime/IGatewayErrorLog.d.ts +10 -0
- package/dist/runtime/IGatewayErrorLog.d.ts.map +1 -0
- package/dist/runtime/IGatewayErrorLog.js +2 -0
- package/dist/runtime/IProfiler.d.ts +65 -0
- package/dist/runtime/IProfiler.d.ts.map +1 -0
- package/dist/runtime/IProfiler.js +2 -0
- package/dist/runtime/IRuntimeDumps.d.ts +23 -0
- package/dist/runtime/IRuntimeDumps.d.ts.map +1 -0
- package/dist/runtime/IRuntimeDumps.js +2 -0
- package/dist/runtime/ISt05Trace.d.ts +8 -0
- package/dist/runtime/ISt05Trace.d.ts.map +1 -0
- package/dist/runtime/ISt05Trace.js +2 -0
- package/dist/runtime/ISystemMessages.d.ts +10 -0
- package/dist/runtime/ISystemMessages.d.ts.map +1 -0
- package/dist/runtime/ISystemMessages.js +2 -0
- package/dist/runtime/ITrace.d.ts +170 -0
- package/dist/runtime/ITrace.d.ts.map +1 -0
- package/dist/runtime/ITrace.js +14 -0
- package/dist/sap/ISapConfig.d.ts +22 -0
- package/dist/sap/ISapConfig.d.ts.map +1 -0
- package/dist/sap/ISapConfig.js +2 -0
- package/dist/sap/SapAuthType.d.ts +3 -0
- package/dist/sap/SapAuthType.d.ts.map +1 -0
- package/dist/sap/SapAuthType.js +2 -0
- package/dist/service/IAdtService.d.ts +84 -0
- package/dist/service/IAdtService.d.ts.map +1 -0
- package/dist/service/IAdtService.js +27 -0
- package/dist/serviceKey/IServiceKeyStore.d.ts +31 -0
- package/dist/serviceKey/IServiceKeyStore.d.ts.map +1 -0
- package/dist/serviceKey/IServiceKeyStore.js +7 -0
- package/dist/session/ISessionStore.d.ts +59 -0
- package/dist/session/ISessionStore.d.ts.map +1 -0
- package/dist/session/ISessionStore.js +7 -0
- package/dist/shared/IReadOptions.d.ts +9 -0
- package/dist/shared/IReadOptions.d.ts.map +1 -0
- package/dist/shared/IReadOptions.js +2 -0
- package/dist/store/StoreErrorCodes.d.ts +12 -0
- package/dist/store/StoreErrorCodes.d.ts.map +1 -0
- package/dist/store/StoreErrorCodes.js +13 -0
- package/dist/token/AuthType.d.ts +43 -0
- package/dist/token/AuthType.d.ts.map +1 -0
- package/dist/token/AuthType.js +41 -0
- package/dist/token/ITokenProvider.d.ts +27 -0
- package/dist/token/ITokenProvider.d.ts.map +1 -0
- package/dist/token/ITokenProvider.js +8 -0
- package/dist/token/ITokenProviderOptions.d.ts +23 -0
- package/dist/token/ITokenProviderOptions.d.ts.map +1 -0
- package/dist/token/ITokenProviderOptions.js +2 -0
- package/dist/token/ITokenRefresher.d.ts +39 -0
- package/dist/token/ITokenRefresher.d.ts.map +1 -0
- package/dist/token/ITokenRefresher.js +12 -0
- package/dist/token/ITokenResult.d.ts +36 -0
- package/dist/token/ITokenResult.d.ts.map +1 -0
- package/dist/token/ITokenResult.js +7 -0
- package/dist/token/TokenProviderErrorCodes.d.ts +26 -0
- package/dist/token/TokenProviderErrorCodes.d.ts.map +1 -0
- package/dist/token/TokenProviderErrorCodes.js +24 -0
- package/dist/utils/ITokenRefreshResult.d.ts +8 -0
- package/dist/utils/ITokenRefreshResult.d.ts.map +1 -0
- package/dist/utils/ITokenRefreshResult.js +2 -0
- package/dist/validation/IHeaderValidationResult.d.ts +15 -0
- package/dist/validation/IHeaderValidationResult.d.ts.map +1 -0
- package/dist/validation/IHeaderValidationResult.js +2 -0
- package/dist/validation/IValidatedAuthConfig.d.ts +46 -0
- package/dist/validation/IValidatedAuthConfig.d.ts.map +1 -0
- package/dist/validation/IValidatedAuthConfig.js +15 -0
- package/package.json +42 -0
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Interface ADT operation parameter interfaces (snake_case, low-level)
|
|
3
|
+
*/
|
|
4
|
+
import type { IAdtObjectConfig } from './IAdtObjectState';
|
|
5
|
+
export interface ICreateInterfaceParams {
|
|
6
|
+
interfaceName: string;
|
|
7
|
+
description: string;
|
|
8
|
+
packageName: string;
|
|
9
|
+
transportRequest?: string;
|
|
10
|
+
masterSystem?: string;
|
|
11
|
+
responsible?: string;
|
|
12
|
+
masterLanguage?: string;
|
|
13
|
+
}
|
|
14
|
+
export interface IUpdateInterfaceSourceParams {
|
|
15
|
+
interface_name: string;
|
|
16
|
+
source_code: string;
|
|
17
|
+
activate?: boolean;
|
|
18
|
+
}
|
|
19
|
+
export interface IDeleteInterfaceParams {
|
|
20
|
+
interface_name: string;
|
|
21
|
+
transport_request?: string;
|
|
22
|
+
}
|
|
23
|
+
export type IInterfaceConfig = IAdtObjectConfig & {
|
|
24
|
+
interfaceName: string;
|
|
25
|
+
masterLanguage?: string;
|
|
26
|
+
packageName?: string;
|
|
27
|
+
transportRequest?: string;
|
|
28
|
+
description?: string;
|
|
29
|
+
sourceCode?: string;
|
|
30
|
+
sessionId?: string;
|
|
31
|
+
onLock?: (lockHandle: string) => void;
|
|
32
|
+
};
|
|
33
|
+
//# sourceMappingURL=IAdtInterface.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IAdtInterface.d.ts","sourceRoot":"","sources":["../../src/adt/IAdtInterface.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAE1D,MAAM,WAAW,sBAAsB;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,4BAA4B;IAC3C,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAKD,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,GAAG;IAChD,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;CACvC,CAAC"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
export interface ICreateMessageClassParams {
|
|
2
|
+
name: string;
|
|
3
|
+
description: string;
|
|
4
|
+
package_name: string;
|
|
5
|
+
transport_request?: string;
|
|
6
|
+
master_language?: string;
|
|
7
|
+
}
|
|
8
|
+
export interface IMessageClassConfig {
|
|
9
|
+
/** Message class name (e.g. ZMY_MSGS) */
|
|
10
|
+
name: string;
|
|
11
|
+
/** Short description */
|
|
12
|
+
description?: string;
|
|
13
|
+
/** Package name — required for create */
|
|
14
|
+
packageName?: string;
|
|
15
|
+
/** Transport request — sent as corrNr (create/update) or <del:transportNumber> (delete) for transportable packages */
|
|
16
|
+
transportRequest?: string;
|
|
17
|
+
/** Master language of the message class — defaults to 'EN' on create */
|
|
18
|
+
masterLanguage?: string;
|
|
19
|
+
}
|
|
20
|
+
/** Configuration for operating on a single message within a message class. */
|
|
21
|
+
export interface IMessageClassMessageConfig {
|
|
22
|
+
/** Parent message class name (e.g. ZMY_MSGS) */
|
|
23
|
+
className: string;
|
|
24
|
+
/** Message number (e.g. '001') */
|
|
25
|
+
msgno: string;
|
|
26
|
+
/** Message text — required for create/update */
|
|
27
|
+
msgtext?: string;
|
|
28
|
+
/** Whether the message is self-explanatory (mc:selfexplainatory attribute) */
|
|
29
|
+
selfExplanatory?: boolean;
|
|
30
|
+
/** Long description for the message (adtcore:description attribute) */
|
|
31
|
+
description?: string;
|
|
32
|
+
/** Transport request — sent as &corrNr= on the parent-class PUT for create/update/delete (transportable packages) */
|
|
33
|
+
transportRequest?: string;
|
|
34
|
+
}
|
|
35
|
+
//# sourceMappingURL=IAdtMessageClass.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IAdtMessageClass.d.ts","sourceRoot":"","sources":["../../src/adt/IAdtMessageClass.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAKD,MAAM,WAAW,mBAAmB;IAClC,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,wBAAwB;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yCAAyC;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sHAAsH;IACtH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,wEAAwE;IACxE,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAKD,8EAA8E;AAC9E,MAAM,WAAW,0BAA0B;IACzC,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,gDAAgD;IAChD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8EAA8E;IAC9E,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,uEAAuE;IACvE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qHAAqH;IACrH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Metadata Extension ADT operation parameter interfaces (low-level)
|
|
3
|
+
*/
|
|
4
|
+
export interface IMetadataExtensionValidationParams {
|
|
5
|
+
name: string;
|
|
6
|
+
description: string;
|
|
7
|
+
packageName: string;
|
|
8
|
+
}
|
|
9
|
+
export interface IMetadataExtensionCreateParams {
|
|
10
|
+
name: string;
|
|
11
|
+
description: string;
|
|
12
|
+
packageName: string;
|
|
13
|
+
transportRequest?: string;
|
|
14
|
+
masterLanguage?: string;
|
|
15
|
+
masterSystem?: string;
|
|
16
|
+
responsible?: string;
|
|
17
|
+
}
|
|
18
|
+
export interface IMetadataExtensionConfig {
|
|
19
|
+
name: string;
|
|
20
|
+
description?: string;
|
|
21
|
+
packageName?: string;
|
|
22
|
+
transportRequest?: string;
|
|
23
|
+
sourceCode?: string;
|
|
24
|
+
masterLanguage?: string;
|
|
25
|
+
masterSystem?: string;
|
|
26
|
+
responsible?: string;
|
|
27
|
+
sessionId?: string;
|
|
28
|
+
}
|
|
29
|
+
//# sourceMappingURL=IAdtMetadataExtension.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IAdtMetadataExtension.d.ts","sourceRoot":"","sources":["../../src/adt/IAdtMetadataExtension.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,MAAM,WAAW,kCAAkC;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,8BAA8B;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAID,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}
|
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Operation options, version entries and error codes shared by the capability
|
|
3
|
+
* atoms.
|
|
4
|
+
*
|
|
5
|
+
* The wide `IAdtObject` this file was named for was removed in 29.0.0; what an
|
|
6
|
+
* object can do is now stated by the atoms it declares in `IAdtCapabilities.ts`.
|
|
7
|
+
* Nothing here declares an operation — these are the pieces the atoms refer to:
|
|
8
|
+
* {@link IAdtOperationOptions} carries the strategy a caller injects,
|
|
9
|
+
* a version history's entries are the implementation's since 31.0.0, and
|
|
10
|
+
* {@link AdtObjectErrorCodes} names failures a strategy can put in
|
|
11
|
+
* {@link IAdtError.code}.
|
|
12
|
+
*/
|
|
13
|
+
import type { IAdtWireResponse } from '../connection/IAbapConnection';
|
|
14
|
+
import type { AdtNoFailure, IAdtError } from './IAdtResponse';
|
|
15
|
+
/**
|
|
16
|
+
* The codes a failure can name itself by.
|
|
17
|
+
*
|
|
18
|
+
* **No member of this contract throws** since 30.0.0 — which is about what the
|
|
19
|
+
* server's answer becomes, not about what an implementation does when its own
|
|
20
|
+
* reading fails. Every member answers
|
|
21
|
+
* {@link IAdtResponse}, so a failure comes back rather than flying past, and it
|
|
22
|
+
* is read from the contract:
|
|
23
|
+
*
|
|
24
|
+
* ```typescript
|
|
25
|
+
* const answer = await adtObject.read({ className: 'ZTEST' });
|
|
26
|
+
*
|
|
27
|
+
* if (answer.ok) {
|
|
28
|
+
* answer.getResult().value; // what the endpoint produced
|
|
29
|
+
* } else {
|
|
30
|
+
* const failure = answer.getError();
|
|
31
|
+
* failure.origin; // 'connection' | 'refusal'
|
|
32
|
+
* failure.message; // what SAP said, in SAP's words
|
|
33
|
+
* failure.code; // one of these, when the strategy named one
|
|
34
|
+
* failure.response; // the answer it was read from, untouched
|
|
35
|
+
* }
|
|
36
|
+
* ```
|
|
37
|
+
*
|
|
38
|
+
* These are for the failures the contract promises in a specific place, where
|
|
39
|
+
* `origin` alone cannot tell two apart: a version resource a system does not
|
|
40
|
+
* expose is `UNSUPPORTED_OPERATION` rather than merely a refusal, and a lock
|
|
41
|
+
* another user holds is `LOCK_FAILED`. A consumer branches on the code without a
|
|
42
|
+
* cast, which until 30.0.0 they could not — the promise was made by members that
|
|
43
|
+
* threw, and the failure contract had nowhere to carry it.
|
|
44
|
+
*
|
|
45
|
+
* `code` is optional, and deliberately: what a strategy chooses is how much of a
|
|
46
|
+
* failure to fill in, not whether to be one. An implementation is free to name
|
|
47
|
+
* codes of its own beside these; this package ships no error class to narrow
|
|
48
|
+
* with, because a contract says what a thing is and shipping a class from it
|
|
49
|
+
* would make "use your own implementation" untrue for that piece.
|
|
50
|
+
*
|
|
51
|
+
* Note what is *not* among them: "not found". ADT answers a request for a
|
|
52
|
+
* missing object with **200 and an empty body** rather than a 404, so absence is
|
|
53
|
+
* not a failure this library can report on its own authority — a read-modify-write
|
|
54
|
+
* must treat it as one, since writing back what it read erases the object, while
|
|
55
|
+
* a listing must treat it as an empty list. That reading is supplied through
|
|
56
|
+
* {@link IAdtOperationOptions.analyse}.
|
|
57
|
+
*/
|
|
58
|
+
export declare const AdtObjectErrorCodes: {
|
|
59
|
+
/** Object not found (404) */
|
|
60
|
+
readonly OBJECT_NOT_FOUND: "ADT_OBJECT_NOT_FOUND";
|
|
61
|
+
/** Object not ready yet (400) - e.g., just created, not available for reading */
|
|
62
|
+
readonly OBJECT_NOT_READY: "ADT_OBJECT_NOT_READY";
|
|
63
|
+
/** Object validation failed */
|
|
64
|
+
readonly VALIDATION_FAILED: "ADT_VALIDATION_FAILED";
|
|
65
|
+
/** Object creation failed */
|
|
66
|
+
readonly CREATE_FAILED: "ADT_CREATE_FAILED";
|
|
67
|
+
/** Object update failed */
|
|
68
|
+
readonly UPDATE_FAILED: "ADT_UPDATE_FAILED";
|
|
69
|
+
/** Object deletion failed */
|
|
70
|
+
readonly DELETE_FAILED: "ADT_DELETE_FAILED";
|
|
71
|
+
/** Object activation failed */
|
|
72
|
+
readonly ACTIVATE_FAILED: "ADT_ACTIVATE_FAILED";
|
|
73
|
+
/** Object check failed */
|
|
74
|
+
readonly CHECK_FAILED: "ADT_CHECK_FAILED";
|
|
75
|
+
/** Lock operation failed */
|
|
76
|
+
readonly LOCK_FAILED: "ADT_LOCK_FAILED";
|
|
77
|
+
/** Unlock operation failed */
|
|
78
|
+
readonly UNLOCK_FAILED: "ADT_UNLOCK_FAILED";
|
|
79
|
+
/** Operation not supported for this object type (e.g. version history on a non-source object) */
|
|
80
|
+
readonly UNSUPPORTED_OPERATION: "ADT_UNSUPPORTED_OPERATION";
|
|
81
|
+
};
|
|
82
|
+
/**
|
|
83
|
+
* The caller's own reading of what counts as a failure.
|
|
84
|
+
*
|
|
85
|
+
* Handed the default's verdict **and** the answer it was reached from, so it can
|
|
86
|
+
* overrule in either direction: name a failure the default let through, or clear
|
|
87
|
+
* one it raised. Answering {@link ADT_NO_FAILURE} means "not a failure here" — a
|
|
88
|
+
* token rather than `undefined`, so that the absence of a strategy and a
|
|
89
|
+
* strategy's verdict of "fine" are not the same value.
|
|
90
|
+
*
|
|
91
|
+
* **It names its own failure type.** `IAdtFailure<TError extends IAdtError>` has
|
|
92
|
+
* carried the parameter since the failure half existed, and it never arrived
|
|
93
|
+
* anywhere, because the options pinned this return to `IAdtError`. A consumer
|
|
94
|
+
* whose strategy answered something richer got it back narrowed and had to cast
|
|
95
|
+
* at the call site — which is the one thing a parameterised failure exists to
|
|
96
|
+
* prevent.
|
|
97
|
+
*
|
|
98
|
+
* The alternative was a field per case on `IAdtError`: a message id here, a
|
|
99
|
+
* severity there, a job handle next time. A contract that grows a field for
|
|
100
|
+
* every caller's special case is worse than one that lets a caller say what
|
|
101
|
+
* their own failure is, and a consumer knows perfectly well which strategy they
|
|
102
|
+
* injected.
|
|
103
|
+
*
|
|
104
|
+
* ```typescript
|
|
105
|
+
* interface IT100Failure extends IAdtError {
|
|
106
|
+
* readonly t100: { msgid: string; msgno: string };
|
|
107
|
+
* }
|
|
108
|
+
* const t100: IAnalyse<IT100Failure> = (verdict, answer) => …;
|
|
109
|
+
*
|
|
110
|
+
* const answer = await client.getClass().activate(config, { analyse: t100 });
|
|
111
|
+
* if (!answer.ok) answer.getError().t100; // typed, no cast
|
|
112
|
+
* ```
|
|
113
|
+
*
|
|
114
|
+
* The verdict handed in stays `IAdtError`: it is the library's own, built before
|
|
115
|
+
* any strategy is consulted. Only what comes back is the caller's.
|
|
116
|
+
*/
|
|
117
|
+
export type IAnalyse<E extends IAdtError = IAdtError> = (verdict: IAdtError | AdtNoFailure, answer?: IAdtWireResponse) => E | AdtNoFailure;
|
|
118
|
+
/**
|
|
119
|
+
* Options for ADT operations (create and update)
|
|
120
|
+
* Unified interface for both create and update operations
|
|
121
|
+
*/
|
|
122
|
+
export interface IAdtOperationOptions<E extends IAdtError = IAdtError> {
|
|
123
|
+
/**
|
|
124
|
+
* {@link IAnalyse} — the caller's own reading of what counts as a failure.
|
|
125
|
+
*
|
|
126
|
+
* It exists because no single reading serves every caller. ADT answers a
|
|
127
|
+
* request for a missing object with 200 and an empty body, and those same
|
|
128
|
+
* bytes are a failure to a read-modify-write — writing back what it read
|
|
129
|
+
* erases the object — and an empty list to a listing. Neither reading can be
|
|
130
|
+
* the library's.
|
|
131
|
+
*
|
|
132
|
+
* The status is not the signal: a refusal arrives inside a 200, and what
|
|
133
|
+
* decides is the message severity in the document, which is why the raw answer
|
|
134
|
+
* is passed rather than a summary of it.
|
|
135
|
+
*/
|
|
136
|
+
analyse?: IAnalyse<E>;
|
|
137
|
+
/**
|
|
138
|
+
* The source this member writes. **An update's, and only an update's.**
|
|
139
|
+
*
|
|
140
|
+
* This used to name an exception — "a DDL source, a table and a program are
|
|
141
|
+
* created *from* their source, so it is the POST body" — and the exception is
|
|
142
|
+
* not real. Measured across all 27 create implementations in
|
|
143
|
+
* `@mcp-abap-adt/adt-clients`: every one of them posts a metadata document
|
|
144
|
+
* and none carries source. A DDL posts `ddl:ddlSource`, a table posts
|
|
145
|
+
* `blue:blueSource`, a program posts its program metadata; the text appears
|
|
146
|
+
* in none of the three bodies.
|
|
147
|
+
*
|
|
148
|
+
* The cost of the wrong exception was silence. Five classes created with full
|
|
149
|
+
* bodies on E19 answered ok at every step, activated, and came back as ADT's
|
|
150
|
+
* empty skeleton — the only symptom arriving later, when the entry point
|
|
151
|
+
* refused to run because it did not implement the interface its source
|
|
152
|
+
* declared. `create` no longer accepts this field, so that call now fails to
|
|
153
|
+
* compile instead (see {@link IAdtCreateOptions}).
|
|
154
|
+
*
|
|
155
|
+
* It used to say "used in create operations for update after create" — that
|
|
156
|
+
* described a create that wrote the source itself in a second request. A
|
|
157
|
+
* member is one request now, so where the endpoint does not carry source,
|
|
158
|
+
* writing it is a separate call the caller makes.
|
|
159
|
+
*/
|
|
160
|
+
sourceCode?: string;
|
|
161
|
+
/**
|
|
162
|
+
* The body of this member’s request, for the objects whose editor content is
|
|
163
|
+
* XML rather than source — a domain, a data element, a package, an
|
|
164
|
+
* authorization field.
|
|
165
|
+
*
|
|
166
|
+
* Same rule as {@link IAdtOperationOptions.sourceCode}: it is the body of the
|
|
167
|
+
* one request the member makes, where that endpoint takes one.
|
|
168
|
+
*/
|
|
169
|
+
xmlContent?: string;
|
|
170
|
+
/**
|
|
171
|
+
* The lock handle to put on the write request.
|
|
172
|
+
*
|
|
173
|
+
* Nothing more. It used to say the update "will skip lock, check and unlock
|
|
174
|
+
* operations" when provided, which implied that without one those still
|
|
175
|
+
* happen — they did, and they no longer do: a member is one request and the
|
|
176
|
+
* lock is the caller’s, taken with `lock` and released with `unlock`.
|
|
177
|
+
*
|
|
178
|
+
* **Leaving it out is not refused here.** Whether a write without a lock is
|
|
179
|
+
* allowed is ADT’s judgement, and ADT answers it; a library that refused
|
|
180
|
+
* first would be standing in front of the server with an opinion of its own.
|
|
181
|
+
*/
|
|
182
|
+
lockHandle?: string;
|
|
183
|
+
/**
|
|
184
|
+
* HTTP request timeout for operations in milliseconds
|
|
185
|
+
* @default 1000 (1 second)
|
|
186
|
+
*
|
|
187
|
+
* Note: This timeout is for HTTP request completion, not for waiting object readiness.
|
|
188
|
+
* For waiting object readiness after create/update/activate operations, use `withLongPolling: true`
|
|
189
|
+
* in read operations instead of fixed timeouts.
|
|
190
|
+
*
|
|
191
|
+
* The `timeout` parameter controls how long to wait for HTTP responses from the server.
|
|
192
|
+
* Increase timeout for complex operations or slow systems.
|
|
193
|
+
*
|
|
194
|
+
* Example: timeout: 5000 for 5 seconds
|
|
195
|
+
*
|
|
196
|
+
* @see withLongPolling - Use long polling for waiting object readiness
|
|
197
|
+
*/
|
|
198
|
+
timeout?: number;
|
|
199
|
+
}
|
|
200
|
+
/**
|
|
201
|
+
* What `create` accepts: {@link IAdtOperationOptions} without the source.
|
|
202
|
+
*
|
|
203
|
+
* A create is the POST that brings the object into existence, and no create
|
|
204
|
+
* endpoint carries source — checked against all 27 implementations in
|
|
205
|
+
* `@mcp-abap-adt/adt-clients`, including the three this contract used to name
|
|
206
|
+
* as exceptions. Writing source is a PUT to `source/main` under a lock, which
|
|
207
|
+
* `create` neither holds nor can obtain.
|
|
208
|
+
*
|
|
209
|
+
* So the field is gone from the member rather than documented as ignored.
|
|
210
|
+
* Accepting a value that cannot be honoured is worse than refusing it: the call
|
|
211
|
+
* compiles, runs, answers ok, and leaves an empty object behind, and the
|
|
212
|
+
* failure surfaces somewhere else entirely.
|
|
213
|
+
*
|
|
214
|
+
* **`Omit` alone does not refuse it.** Excess-property checking applies to
|
|
215
|
+
* object literals and nothing else, so `create(config, opts)` where `opts` is a
|
|
216
|
+
* variable of type {@link IAdtOperationOptions} carrying `sourceCode` is
|
|
217
|
+
* structurally assignable and compiles — which is the shape real consumer code
|
|
218
|
+
* takes. `sourceCode?: never` is what makes the refusal hold for a variable as
|
|
219
|
+
* well as a literal.
|
|
220
|
+
*/
|
|
221
|
+
export type IAdtCreateOptions<E extends IAdtError = IAdtError> = Omit<IAdtOperationOptions<E>, 'sourceCode'> & {
|
|
222
|
+
sourceCode?: never;
|
|
223
|
+
};
|
|
224
|
+
//# sourceMappingURL=IAdtObject.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IAdtObject.d.ts","sourceRoot":"","sources":["../../src/adt/IAdtObject.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,eAAO,MAAM,mBAAmB;IAC9B,6BAA6B;;IAE7B,iFAAiF;;IAEjF,+BAA+B;;IAE/B,6BAA6B;;IAE7B,2BAA2B;;IAE3B,6BAA6B;;IAE7B,+BAA+B;;IAE/B,0BAA0B;;IAE1B,4BAA4B;;IAE5B,8BAA8B;;IAE9B,iGAAiG;;CAEzF,CAAC;AAEX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI,CACtD,OAAO,EAAE,SAAS,GAAG,YAAY,EACjC,MAAM,CAAC,EAAE,gBAAgB,KACtB,CAAC,GAAG,YAAY,CAAC;AAEtB;;;GAGG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IACnE;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAmBtB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI,IAAI,CACnE,oBAAoB,CAAC,CAAC,CAAC,EACvB,YAAY,CACb,GAAG;IAAE,UAAU,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC"}
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Operation options, version entries and error codes shared by the capability
|
|
4
|
+
* atoms.
|
|
5
|
+
*
|
|
6
|
+
* The wide `IAdtObject` this file was named for was removed in 29.0.0; what an
|
|
7
|
+
* object can do is now stated by the atoms it declares in `IAdtCapabilities.ts`.
|
|
8
|
+
* Nothing here declares an operation — these are the pieces the atoms refer to:
|
|
9
|
+
* {@link IAdtOperationOptions} carries the strategy a caller injects,
|
|
10
|
+
* a version history's entries are the implementation's since 31.0.0, and
|
|
11
|
+
* {@link AdtObjectErrorCodes} names failures a strategy can put in
|
|
12
|
+
* {@link IAdtError.code}.
|
|
13
|
+
*/
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.AdtObjectErrorCodes = void 0;
|
|
16
|
+
/**
|
|
17
|
+
* The codes a failure can name itself by.
|
|
18
|
+
*
|
|
19
|
+
* **No member of this contract throws** since 30.0.0 — which is about what the
|
|
20
|
+
* server's answer becomes, not about what an implementation does when its own
|
|
21
|
+
* reading fails. Every member answers
|
|
22
|
+
* {@link IAdtResponse}, so a failure comes back rather than flying past, and it
|
|
23
|
+
* is read from the contract:
|
|
24
|
+
*
|
|
25
|
+
* ```typescript
|
|
26
|
+
* const answer = await adtObject.read({ className: 'ZTEST' });
|
|
27
|
+
*
|
|
28
|
+
* if (answer.ok) {
|
|
29
|
+
* answer.getResult().value; // what the endpoint produced
|
|
30
|
+
* } else {
|
|
31
|
+
* const failure = answer.getError();
|
|
32
|
+
* failure.origin; // 'connection' | 'refusal'
|
|
33
|
+
* failure.message; // what SAP said, in SAP's words
|
|
34
|
+
* failure.code; // one of these, when the strategy named one
|
|
35
|
+
* failure.response; // the answer it was read from, untouched
|
|
36
|
+
* }
|
|
37
|
+
* ```
|
|
38
|
+
*
|
|
39
|
+
* These are for the failures the contract promises in a specific place, where
|
|
40
|
+
* `origin` alone cannot tell two apart: a version resource a system does not
|
|
41
|
+
* expose is `UNSUPPORTED_OPERATION` rather than merely a refusal, and a lock
|
|
42
|
+
* another user holds is `LOCK_FAILED`. A consumer branches on the code without a
|
|
43
|
+
* cast, which until 30.0.0 they could not — the promise was made by members that
|
|
44
|
+
* threw, and the failure contract had nowhere to carry it.
|
|
45
|
+
*
|
|
46
|
+
* `code` is optional, and deliberately: what a strategy chooses is how much of a
|
|
47
|
+
* failure to fill in, not whether to be one. An implementation is free to name
|
|
48
|
+
* codes of its own beside these; this package ships no error class to narrow
|
|
49
|
+
* with, because a contract says what a thing is and shipping a class from it
|
|
50
|
+
* would make "use your own implementation" untrue for that piece.
|
|
51
|
+
*
|
|
52
|
+
* Note what is *not* among them: "not found". ADT answers a request for a
|
|
53
|
+
* missing object with **200 and an empty body** rather than a 404, so absence is
|
|
54
|
+
* not a failure this library can report on its own authority — a read-modify-write
|
|
55
|
+
* must treat it as one, since writing back what it read erases the object, while
|
|
56
|
+
* a listing must treat it as an empty list. That reading is supplied through
|
|
57
|
+
* {@link IAdtOperationOptions.analyse}.
|
|
58
|
+
*/
|
|
59
|
+
exports.AdtObjectErrorCodes = {
|
|
60
|
+
/** Object not found (404) */
|
|
61
|
+
OBJECT_NOT_FOUND: 'ADT_OBJECT_NOT_FOUND',
|
|
62
|
+
/** Object not ready yet (400) - e.g., just created, not available for reading */
|
|
63
|
+
OBJECT_NOT_READY: 'ADT_OBJECT_NOT_READY',
|
|
64
|
+
/** Object validation failed */
|
|
65
|
+
VALIDATION_FAILED: 'ADT_VALIDATION_FAILED',
|
|
66
|
+
/** Object creation failed */
|
|
67
|
+
CREATE_FAILED: 'ADT_CREATE_FAILED',
|
|
68
|
+
/** Object update failed */
|
|
69
|
+
UPDATE_FAILED: 'ADT_UPDATE_FAILED',
|
|
70
|
+
/** Object deletion failed */
|
|
71
|
+
DELETE_FAILED: 'ADT_DELETE_FAILED',
|
|
72
|
+
/** Object activation failed */
|
|
73
|
+
ACTIVATE_FAILED: 'ADT_ACTIVATE_FAILED',
|
|
74
|
+
/** Object check failed */
|
|
75
|
+
CHECK_FAILED: 'ADT_CHECK_FAILED',
|
|
76
|
+
/** Lock operation failed */
|
|
77
|
+
LOCK_FAILED: 'ADT_LOCK_FAILED',
|
|
78
|
+
/** Unlock operation failed */
|
|
79
|
+
UNLOCK_FAILED: 'ADT_UNLOCK_FAILED',
|
|
80
|
+
/** Operation not supported for this object type (e.g. version history on a non-source object) */
|
|
81
|
+
UNSUPPORTED_OPERATION: 'ADT_UNSUPPORTED_OPERATION',
|
|
82
|
+
};
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The configuration shapes an ADT object is identified and created by.
|
|
3
|
+
*
|
|
4
|
+
* The state interfaces this file is named for were removed in 29.0.0 — they were
|
|
5
|
+
* a bag of transport frames, and a state is a shape an *implementation* builds
|
|
6
|
+
* rather than something a contract hands back. What a member answers is now
|
|
7
|
+
* named by its own atom in `IAdtCapabilities.ts`.
|
|
8
|
+
*
|
|
9
|
+
* The filename outlives them for one release so import paths do not churn twice;
|
|
10
|
+
* it is `IAdtObjectConfig.ts` in spirit.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Base configuration interface for all ADT Object operations
|
|
14
|
+
*
|
|
15
|
+
* This interface defines common fields that are present in all ADT object configurations.
|
|
16
|
+
* Specific configuration types should extend this interface to ensure consistency.
|
|
17
|
+
*
|
|
18
|
+
* Example:
|
|
19
|
+
* ```typescript
|
|
20
|
+
* export type DomainBuilderConfig = IAdtObjectConfig & {
|
|
21
|
+
* domainName: string;
|
|
22
|
+
* // ... domain-specific fields
|
|
23
|
+
* // packageName, description and transportRequest come from IAdtObjectConfig,
|
|
24
|
+
* // composed rather than inherited — decision 23
|
|
25
|
+
* }
|
|
26
|
+
* ```
|
|
27
|
+
*/
|
|
28
|
+
export interface IAdtObjectConfig {
|
|
29
|
+
/** Package name (required for create operations, optional for others) */
|
|
30
|
+
packageName?: string;
|
|
31
|
+
/** Description (required for create/validate operations, optional for others) */
|
|
32
|
+
description?: string;
|
|
33
|
+
/** Transport request (optional, used for create/update/delete operations) */
|
|
34
|
+
transportRequest?: string;
|
|
35
|
+
}
|
|
36
|
+
//# sourceMappingURL=IAdtObjectState.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IAdtObjectState.d.ts","sourceRoot":"","sources":["../../src/adt/IAdtObjectState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,gBAAgB;IAC/B,yEAAyE;IACzE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iFAAiF;IACjF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6EAA6E;IAC7E,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* The configuration shapes an ADT object is identified and created by.
|
|
4
|
+
*
|
|
5
|
+
* The state interfaces this file is named for were removed in 29.0.0 — they were
|
|
6
|
+
* a bag of transport frames, and a state is a shape an *implementation* builds
|
|
7
|
+
* rather than something a contract hands back. What a member answers is now
|
|
8
|
+
* named by its own atom in `IAdtCapabilities.ts`.
|
|
9
|
+
*
|
|
10
|
+
* The filename outlives them for one release so import paths do not churn twice;
|
|
11
|
+
* it is `IAdtObjectConfig.ts` in spirit.
|
|
12
|
+
*/
|
|
13
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Package ADT operation parameter interfaces (snake_case, low-level)
|
|
3
|
+
*/
|
|
4
|
+
export interface ICreatePackageParams {
|
|
5
|
+
package_name: string;
|
|
6
|
+
description?: string;
|
|
7
|
+
super_package: string;
|
|
8
|
+
package_type?: string;
|
|
9
|
+
software_component?: string;
|
|
10
|
+
transport_layer?: string;
|
|
11
|
+
transport_request?: string;
|
|
12
|
+
application_component?: string;
|
|
13
|
+
responsible?: string;
|
|
14
|
+
master_system?: string;
|
|
15
|
+
/** Master/original language (e.g. "EN", "DE"). Defaults to EN when unset. */
|
|
16
|
+
master_language?: string;
|
|
17
|
+
record_changes: boolean;
|
|
18
|
+
}
|
|
19
|
+
export interface IUpdatePackageParams {
|
|
20
|
+
package_name: string;
|
|
21
|
+
description?: string;
|
|
22
|
+
super_package?: string;
|
|
23
|
+
package_type?: string;
|
|
24
|
+
software_component?: string;
|
|
25
|
+
transport_layer?: string;
|
|
26
|
+
transport_request?: string;
|
|
27
|
+
application_component?: string;
|
|
28
|
+
responsible?: string;
|
|
29
|
+
master_system?: string;
|
|
30
|
+
record_changes?: boolean;
|
|
31
|
+
}
|
|
32
|
+
export interface IDeletePackageParams {
|
|
33
|
+
package_name: string;
|
|
34
|
+
transport_request?: string;
|
|
35
|
+
}
|
|
36
|
+
export interface IPackageConfig {
|
|
37
|
+
/**
|
|
38
|
+
* The complete document to write, when this config is used for an update.
|
|
39
|
+
*
|
|
40
|
+
* **An update is a write, not a read-modify-write.** Until 19.0.0 of
|
|
41
|
+
* `adt-clients` the five DDIC-shaped updates fetched the current document,
|
|
42
|
+
* patched the fields named here into it, and PUT the result — two requests in
|
|
43
|
+
* one member, and a merge whose rules nobody outside could change. They no
|
|
44
|
+
* longer do: a caller reads the document with the member that reads it, edits
|
|
45
|
+
* it, and passes it here.
|
|
46
|
+
*
|
|
47
|
+
* So the fields beside this one describe a *create*. On an update they are not
|
|
48
|
+
* sent, and a field left out of `document` is not preserved — there is nothing
|
|
49
|
+
* to preserve it from, because nothing was read.
|
|
50
|
+
*
|
|
51
|
+
* Optional because the same config creates, where there is no document yet.
|
|
52
|
+
*/
|
|
53
|
+
document?: string;
|
|
54
|
+
packageName: string;
|
|
55
|
+
superPackage?: string;
|
|
56
|
+
description?: string;
|
|
57
|
+
updatedDescription?: string;
|
|
58
|
+
packageType?: string;
|
|
59
|
+
softwareComponent?: string;
|
|
60
|
+
transportLayer?: string;
|
|
61
|
+
transportRequest?: string;
|
|
62
|
+
applicationComponent?: string;
|
|
63
|
+
responsible?: string;
|
|
64
|
+
masterSystem?: string;
|
|
65
|
+
masterLanguage?: string;
|
|
66
|
+
recordChanges?: boolean;
|
|
67
|
+
onLock?: (lockHandle: string) => void;
|
|
68
|
+
}
|
|
69
|
+
//# sourceMappingURL=IAdtPackage.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IAdtPackage.d.ts","sourceRoot":"","sources":["../../src/adt/IAdtPackage.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,6EAA6E;IAC7E,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAKD,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;CACvC"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Program ADT operation parameter interfaces (snake_case, low-level)
|
|
3
|
+
*/
|
|
4
|
+
export interface ICreateProgramParams {
|
|
5
|
+
programName: string;
|
|
6
|
+
description?: string;
|
|
7
|
+
packageName: string;
|
|
8
|
+
transportRequest?: string;
|
|
9
|
+
masterSystem?: string;
|
|
10
|
+
responsible?: string;
|
|
11
|
+
masterLanguage?: string;
|
|
12
|
+
programType?: string;
|
|
13
|
+
application?: string;
|
|
14
|
+
activate?: boolean;
|
|
15
|
+
}
|
|
16
|
+
export interface IUpdateProgramSourceParams {
|
|
17
|
+
programName: string;
|
|
18
|
+
sourceCode: string;
|
|
19
|
+
activate?: boolean;
|
|
20
|
+
}
|
|
21
|
+
export interface IDeleteProgramParams {
|
|
22
|
+
programName: string;
|
|
23
|
+
transportRequest?: string;
|
|
24
|
+
}
|
|
25
|
+
export interface IProgramConfig {
|
|
26
|
+
programName: string;
|
|
27
|
+
masterLanguage?: string;
|
|
28
|
+
packageName?: string;
|
|
29
|
+
transportRequest?: string;
|
|
30
|
+
description?: string;
|
|
31
|
+
programType?: string;
|
|
32
|
+
application?: string;
|
|
33
|
+
sourceCode?: string;
|
|
34
|
+
sessionId?: string;
|
|
35
|
+
onLock?: (lockHandle: string) => void;
|
|
36
|
+
}
|
|
37
|
+
//# sourceMappingURL=IAdtProgram.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IAdtProgram.d.ts","sourceRoot":"","sources":["../../src/adt/IAdtProgram.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAKD,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;CACvC"}
|