basyx-typescript-sdk 0.2.1 → 0.9.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.
Files changed (155) hide show
  1. package/README.md +5 -3
  2. package/bundle/index.js +17522 -841
  3. package/bundle/index.js.map +1 -1
  4. package/dist/clients/AasDiscoveryClient.d.ts +67 -0
  5. package/dist/clients/AasDiscoveryClient.js +115 -0
  6. package/dist/clients/AasRegistryClient.d.ts +163 -0
  7. package/dist/clients/AasRegistryClient.js +287 -0
  8. package/dist/clients/AasRepositoryClient.d.ts +790 -103
  9. package/dist/clients/AasRepositoryClient.js +1323 -211
  10. package/dist/clients/AasxFileClient.d.ts +81 -0
  11. package/dist/clients/AasxFileClient.js +148 -0
  12. package/dist/clients/ConceptDescriptionRepositoryClient.d.ts +83 -0
  13. package/dist/clients/ConceptDescriptionRepositoryClient.js +143 -0
  14. package/dist/clients/SubmodelRegistryClient.d.ts +77 -0
  15. package/dist/clients/SubmodelRegistryClient.js +138 -0
  16. package/dist/clients/SubmodelRepositoryClient.d.ts +354 -0
  17. package/dist/clients/SubmodelRepositoryClient.js +585 -0
  18. package/dist/clients/index.d.ts +6 -0
  19. package/dist/clients/index.js +6 -0
  20. package/dist/generated/AasDiscoveryService/apis/AssetAdministrationShellBasicDiscoveryAPIApi.d.ts +80 -0
  21. package/dist/generated/AasDiscoveryService/apis/AssetAdministrationShellBasicDiscoveryAPIApi.js +156 -0
  22. package/dist/generated/AasDiscoveryService/apis/DescriptionAPIApi.d.ts +26 -0
  23. package/dist/generated/AasDiscoveryService/apis/DescriptionAPIApi.js +40 -0
  24. package/dist/generated/AasDiscoveryService/apis/index.d.ts +2 -0
  25. package/dist/generated/AasDiscoveryService/apis/index.js +4 -0
  26. package/dist/generated/AasDiscoveryService/index.d.ts +3 -0
  27. package/dist/generated/AasDiscoveryService/index.js +5 -0
  28. package/dist/generated/AasDiscoveryService/models/index.d.ts +297 -0
  29. package/dist/generated/AasDiscoveryService/models/index.js +48 -0
  30. package/dist/generated/AasDiscoveryService/runtime.d.ts +181 -0
  31. package/dist/generated/AasDiscoveryService/runtime.js +326 -0
  32. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.d.ts +139 -0
  33. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.js +312 -0
  34. package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.d.ts +26 -0
  35. package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.js +40 -0
  36. package/dist/generated/AasRegistryService/apis/index.d.ts +2 -0
  37. package/dist/generated/AasRegistryService/apis/index.js +4 -0
  38. package/dist/generated/AasRegistryService/index.d.ts +3 -0
  39. package/dist/generated/AasRegistryService/index.js +5 -0
  40. package/dist/generated/AasRegistryService/models/index.d.ts +1070 -0
  41. package/dist/generated/AasRegistryService/models/index.js +151 -0
  42. package/dist/generated/AasRegistryService/runtime.d.ts +181 -0
  43. package/dist/generated/AasRegistryService/runtime.js +326 -0
  44. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.d.ts +870 -0
  45. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.js +1842 -0
  46. package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
  47. package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.js +40 -0
  48. package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
  49. package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.js +49 -0
  50. package/dist/generated/AasRepositoryService/apis/index.d.ts +3 -0
  51. package/dist/generated/AasRepositoryService/apis/index.js +5 -0
  52. package/dist/generated/AasRepositoryService/index.d.ts +3 -0
  53. package/dist/generated/AasRepositoryService/index.js +5 -0
  54. package/dist/generated/AasRepositoryService/models/index.d.ts +4585 -0
  55. package/dist/generated/AasRepositoryService/models/index.js +221 -0
  56. package/dist/generated/AasRepositoryService/runtime.d.ts +181 -0
  57. package/dist/generated/AasRepositoryService/runtime.js +326 -0
  58. package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.d.ts +78 -0
  59. package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.js +184 -0
  60. package/dist/generated/AasxFileService/apis/index.d.ts +1 -0
  61. package/dist/generated/AasxFileService/apis/index.js +3 -0
  62. package/dist/generated/AasxFileService/index.d.ts +3 -0
  63. package/dist/generated/AasxFileService/index.js +5 -0
  64. package/dist/generated/AasxFileService/models/index.d.ts +80 -0
  65. package/dist/generated/AasxFileService/models/index.js +10 -0
  66. package/dist/generated/AasxFileService/runtime.d.ts +181 -0
  67. package/dist/generated/AasxFileService/runtime.js +326 -0
  68. package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.d.ts +78 -0
  69. package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.js +164 -0
  70. package/dist/generated/ConceptDescriptionRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
  71. package/dist/generated/ConceptDescriptionRepositoryService/apis/DescriptionAPIApi.js +40 -0
  72. package/dist/generated/ConceptDescriptionRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
  73. package/dist/generated/ConceptDescriptionRepositoryService/apis/SerializationAPIApi.js +49 -0
  74. package/dist/generated/ConceptDescriptionRepositoryService/apis/index.d.ts +3 -0
  75. package/dist/generated/ConceptDescriptionRepositoryService/apis/index.js +5 -0
  76. package/dist/generated/ConceptDescriptionRepositoryService/index.d.ts +3 -0
  77. package/dist/generated/ConceptDescriptionRepositoryService/index.js +5 -0
  78. package/dist/generated/ConceptDescriptionRepositoryService/models/index.d.ts +2869 -0
  79. package/dist/generated/ConceptDescriptionRepositoryService/models/index.js +209 -0
  80. package/dist/generated/ConceptDescriptionRepositoryService/runtime.d.ts +181 -0
  81. package/dist/generated/ConceptDescriptionRepositoryService/runtime.js +326 -0
  82. package/dist/generated/SubmodelRegistryService/apis/DescriptionAPIApi.d.ts +26 -0
  83. package/dist/generated/SubmodelRegistryService/apis/DescriptionAPIApi.js +40 -0
  84. package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.d.ts +75 -0
  85. package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.js +155 -0
  86. package/dist/generated/SubmodelRegistryService/apis/index.d.ts +2 -0
  87. package/dist/generated/SubmodelRegistryService/apis/index.js +4 -0
  88. package/dist/generated/SubmodelRegistryService/index.d.ts +3 -0
  89. package/dist/generated/SubmodelRegistryService/index.js +5 -0
  90. package/dist/generated/SubmodelRegistryService/models/index.d.ts +924 -0
  91. package/dist/generated/SubmodelRegistryService/models/index.js +141 -0
  92. package/dist/generated/SubmodelRegistryService/runtime.d.ts +181 -0
  93. package/dist/generated/SubmodelRegistryService/runtime.js +326 -0
  94. package/dist/generated/SubmodelRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
  95. package/dist/generated/SubmodelRepositoryService/apis/DescriptionAPIApi.js +40 -0
  96. package/dist/generated/SubmodelRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
  97. package/dist/generated/SubmodelRepositoryService/apis/SerializationAPIApi.js +49 -0
  98. package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.d.ts +802 -0
  99. package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.js +1572 -0
  100. package/dist/generated/SubmodelRepositoryService/apis/index.d.ts +3 -0
  101. package/dist/generated/SubmodelRepositoryService/apis/index.js +5 -0
  102. package/dist/generated/SubmodelRepositoryService/index.d.ts +3 -0
  103. package/dist/generated/SubmodelRepositoryService/index.js +5 -0
  104. package/dist/generated/SubmodelRepositoryService/models/index.d.ts +4623 -0
  105. package/dist/generated/SubmodelRepositoryService/models/index.js +221 -0
  106. package/dist/generated/SubmodelRepositoryService/runtime.d.ts +181 -0
  107. package/dist/generated/SubmodelRepositoryService/runtime.js +326 -0
  108. package/dist/generated/index.d.ts +8 -2
  109. package/dist/generated/index.js +8 -3
  110. package/dist/index.d.ts +1 -1
  111. package/dist/index.js +1 -1
  112. package/dist/lib/apiConfig.d.ts +2 -0
  113. package/dist/lib/apiConfig.js +41 -0
  114. package/dist/lib/base64Url.js +4 -0
  115. package/dist/lib/convertAasDescriptorTypes.d.ts +34 -0
  116. package/dist/lib/convertAasDescriptorTypes.js +76 -0
  117. package/dist/lib/convertAasDiscoveryTypes.d.ts +18 -0
  118. package/dist/lib/convertAasDiscoveryTypes.js +39 -0
  119. package/dist/lib/convertAasTypes.d.ts +7 -7
  120. package/dist/lib/convertAasTypes.js +5 -0
  121. package/dist/lib/convertConceptDescriptionTypes.d.ts +18 -0
  122. package/dist/lib/convertConceptDescriptionTypes.js +39 -0
  123. package/dist/lib/convertSubmodelTypes.d.ts +34 -0
  124. package/dist/lib/convertSubmodelTypes.js +69 -0
  125. package/dist/lib/descriptorJsonization.d.ts +12 -0
  126. package/dist/lib/descriptorJsonization.js +172 -0
  127. package/dist/lib/errorHandler.d.ts +9 -0
  128. package/dist/lib/errorHandler.js +113 -0
  129. package/dist/models/Descriptors.d.ts +51 -0
  130. package/dist/models/Descriptors.js +56 -0
  131. package/dist/models/index.d.ts +0 -1
  132. package/dist/models/index.js +0 -1
  133. package/dist/utils/DescriptorUtils.d.ts +9 -0
  134. package/dist/utils/DescriptorUtils.js +37 -0
  135. package/dist/utils/KeyTypesUtil.d.ts +24 -0
  136. package/dist/utils/KeyTypesUtil.js +55 -0
  137. package/dist/utils/MultiLanguagePropertyUtils.d.ts +24 -0
  138. package/dist/utils/MultiLanguagePropertyUtils.js +46 -0
  139. package/dist/utils/ReferableUtils.d.ts +69 -0
  140. package/dist/utils/ReferableUtils.js +220 -0
  141. package/dist/utils/ReferenceUtil.d.ts +9 -0
  142. package/dist/utils/ReferenceUtil.js +22 -0
  143. package/dist/utils/SemanticIdUtils.d.ts +119 -0
  144. package/dist/utils/SemanticIdUtils.js +363 -0
  145. package/package.json +14 -11
  146. package/dist/generated/schemas.gen.d.ts +0 -2357
  147. package/dist/generated/schemas.gen.js +0 -2789
  148. package/dist/generated/sdk.gen.d.ts +0 -822
  149. package/dist/generated/sdk.gen.js +0 -2225
  150. package/dist/generated/types.gen.d.ts +0 -10829
  151. package/dist/generated/types.gen.js +0 -2
  152. package/dist/lib/createAasRepoClient.d.ts +0 -9
  153. package/dist/lib/createAasRepoClient.js +0 -15
  154. package/dist/models/aas-repository.d.ts +0 -65
  155. package/dist/models/aas-repository.js +0 -1
@@ -0,0 +1,326 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * DotAAS Part 2 | HTTP/REST | Asset Administration Shell Repository Service Specification
5
+ * The Full Profile of the Asset Administration Shell Repository Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](https://industrialdigitaltwin.org/en/content-hub/aasspecifications). Copyright: Industrial Digital Twin Association (IDTA) 2025
6
+ *
7
+ * The version of the OpenAPI document: V3.1.0_SSP-001
8
+ * Contact: info@idtwin.org
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export const BASE_PATH = "https://admin-shell.io/api/v3".replace(/\/+$/, "");
15
+ export class Configuration {
16
+ configuration;
17
+ constructor(configuration = {}) {
18
+ this.configuration = configuration;
19
+ }
20
+ set config(configuration) {
21
+ this.configuration = configuration;
22
+ }
23
+ get basePath() {
24
+ return this.configuration.basePath != null ? this.configuration.basePath : BASE_PATH;
25
+ }
26
+ get fetchApi() {
27
+ return this.configuration.fetchApi;
28
+ }
29
+ get middleware() {
30
+ return this.configuration.middleware || [];
31
+ }
32
+ get queryParamsStringify() {
33
+ return this.configuration.queryParamsStringify || querystring;
34
+ }
35
+ get username() {
36
+ return this.configuration.username;
37
+ }
38
+ get password() {
39
+ return this.configuration.password;
40
+ }
41
+ get apiKey() {
42
+ const apiKey = this.configuration.apiKey;
43
+ if (apiKey) {
44
+ return typeof apiKey === 'function' ? apiKey : () => apiKey;
45
+ }
46
+ return undefined;
47
+ }
48
+ get accessToken() {
49
+ const accessToken = this.configuration.accessToken;
50
+ if (accessToken) {
51
+ return typeof accessToken === 'function' ? accessToken : async () => accessToken;
52
+ }
53
+ return undefined;
54
+ }
55
+ get headers() {
56
+ return this.configuration.headers;
57
+ }
58
+ get credentials() {
59
+ return this.configuration.credentials;
60
+ }
61
+ }
62
+ export const DefaultConfig = new Configuration();
63
+ /**
64
+ * This is the base class for all generated API classes.
65
+ */
66
+ export class BaseAPI {
67
+ configuration;
68
+ static jsonRegex = new RegExp('^(:?application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(:?;.*)?$', 'i');
69
+ middleware;
70
+ constructor(configuration = DefaultConfig) {
71
+ this.configuration = configuration;
72
+ this.middleware = configuration.middleware;
73
+ }
74
+ withMiddleware(...middlewares) {
75
+ const next = this.clone();
76
+ next.middleware = next.middleware.concat(...middlewares);
77
+ return next;
78
+ }
79
+ withPreMiddleware(...preMiddlewares) {
80
+ const middlewares = preMiddlewares.map((pre) => ({ pre }));
81
+ return this.withMiddleware(...middlewares);
82
+ }
83
+ withPostMiddleware(...postMiddlewares) {
84
+ const middlewares = postMiddlewares.map((post) => ({ post }));
85
+ return this.withMiddleware(...middlewares);
86
+ }
87
+ /**
88
+ * Check if the given MIME is a JSON MIME.
89
+ * JSON MIME examples:
90
+ * application/json
91
+ * application/json; charset=UTF8
92
+ * APPLICATION/JSON
93
+ * application/vnd.company+json
94
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
95
+ * @return True if the given MIME is JSON, false otherwise.
96
+ */
97
+ isJsonMime(mime) {
98
+ if (!mime) {
99
+ return false;
100
+ }
101
+ return BaseAPI.jsonRegex.test(mime);
102
+ }
103
+ async request(context, initOverrides) {
104
+ const { url, init } = await this.createFetchParams(context, initOverrides);
105
+ const response = await this.fetchApi(url, init);
106
+ if (response && (response.status >= 200 && response.status < 300)) {
107
+ return response;
108
+ }
109
+ throw new ResponseError(response, 'Response returned an error code');
110
+ }
111
+ async createFetchParams(context, initOverrides) {
112
+ let url = this.configuration.basePath + context.path;
113
+ if (context.query !== undefined && Object.keys(context.query).length !== 0) {
114
+ // only add the querystring to the URL if there are query parameters.
115
+ // this is done to avoid urls ending with a "?" character which buggy webservers
116
+ // do not handle correctly sometimes.
117
+ url += '?' + this.configuration.queryParamsStringify(context.query);
118
+ }
119
+ const headers = Object.assign({}, this.configuration.headers, context.headers);
120
+ Object.keys(headers).forEach(key => headers[key] === undefined ? delete headers[key] : {});
121
+ const initOverrideFn = typeof initOverrides === "function"
122
+ ? initOverrides
123
+ : async () => initOverrides;
124
+ const initParams = {
125
+ method: context.method,
126
+ headers,
127
+ body: context.body,
128
+ credentials: this.configuration.credentials,
129
+ };
130
+ const overriddenInit = {
131
+ ...initParams,
132
+ ...(await initOverrideFn({
133
+ init: initParams,
134
+ context,
135
+ }))
136
+ };
137
+ let body;
138
+ if (isFormData(overriddenInit.body)
139
+ || (overriddenInit.body instanceof URLSearchParams)
140
+ || isBlob(overriddenInit.body)) {
141
+ body = overriddenInit.body;
142
+ }
143
+ else if (this.isJsonMime(headers['Content-Type'])) {
144
+ body = JSON.stringify(overriddenInit.body);
145
+ }
146
+ else {
147
+ body = overriddenInit.body;
148
+ }
149
+ const init = {
150
+ ...overriddenInit,
151
+ body
152
+ };
153
+ return { url, init };
154
+ }
155
+ fetchApi = async (url, init) => {
156
+ let fetchParams = { url, init };
157
+ for (const middleware of this.middleware) {
158
+ if (middleware.pre) {
159
+ fetchParams = await middleware.pre({
160
+ fetch: this.fetchApi,
161
+ ...fetchParams,
162
+ }) || fetchParams;
163
+ }
164
+ }
165
+ let response = undefined;
166
+ try {
167
+ response = await (this.configuration.fetchApi || fetch)(fetchParams.url, fetchParams.init);
168
+ }
169
+ catch (e) {
170
+ for (const middleware of this.middleware) {
171
+ if (middleware.onError) {
172
+ response = await middleware.onError({
173
+ fetch: this.fetchApi,
174
+ url: fetchParams.url,
175
+ init: fetchParams.init,
176
+ error: e,
177
+ response: response ? response.clone() : undefined,
178
+ }) || response;
179
+ }
180
+ }
181
+ if (response === undefined) {
182
+ if (e instanceof Error) {
183
+ throw new FetchError(e, 'The request failed and the interceptors did not return an alternative response');
184
+ }
185
+ else {
186
+ throw e;
187
+ }
188
+ }
189
+ }
190
+ for (const middleware of this.middleware) {
191
+ if (middleware.post) {
192
+ response = await middleware.post({
193
+ fetch: this.fetchApi,
194
+ url: fetchParams.url,
195
+ init: fetchParams.init,
196
+ response: response.clone(),
197
+ }) || response;
198
+ }
199
+ }
200
+ return response;
201
+ };
202
+ /**
203
+ * Create a shallow clone of `this` by constructing a new instance
204
+ * and then shallow cloning data members.
205
+ */
206
+ clone() {
207
+ const constructor = this.constructor;
208
+ const next = new constructor(this.configuration);
209
+ next.middleware = this.middleware.slice();
210
+ return next;
211
+ }
212
+ }
213
+ ;
214
+ function isBlob(value) {
215
+ return typeof Blob !== 'undefined' && value instanceof Blob;
216
+ }
217
+ function isFormData(value) {
218
+ return typeof FormData !== "undefined" && value instanceof FormData;
219
+ }
220
+ export class ResponseError extends Error {
221
+ response;
222
+ name = "ResponseError";
223
+ constructor(response, msg) {
224
+ super(msg);
225
+ this.response = response;
226
+ }
227
+ }
228
+ export class FetchError extends Error {
229
+ cause;
230
+ name = "FetchError";
231
+ constructor(cause, msg) {
232
+ super(msg);
233
+ this.cause = cause;
234
+ }
235
+ }
236
+ export class RequiredError extends Error {
237
+ field;
238
+ name = "RequiredError";
239
+ constructor(field, msg) {
240
+ super(msg);
241
+ this.field = field;
242
+ }
243
+ }
244
+ export const COLLECTION_FORMATS = {
245
+ csv: ",",
246
+ ssv: " ",
247
+ tsv: "\t",
248
+ pipes: "|",
249
+ };
250
+ export function querystring(params, prefix = '') {
251
+ return Object.keys(params)
252
+ .map(key => querystringSingleKey(key, params[key], prefix))
253
+ .filter(part => part.length > 0)
254
+ .join('&');
255
+ }
256
+ function querystringSingleKey(key, value, keyPrefix = '') {
257
+ const fullKey = keyPrefix + (keyPrefix.length ? `[${key}]` : key);
258
+ if (value instanceof Array) {
259
+ const multiValue = value.map(singleValue => encodeURIComponent(String(singleValue)))
260
+ .join(`&${encodeURIComponent(fullKey)}=`);
261
+ return `${encodeURIComponent(fullKey)}=${multiValue}`;
262
+ }
263
+ if (value instanceof Set) {
264
+ const valueAsArray = Array.from(value);
265
+ return querystringSingleKey(key, valueAsArray, keyPrefix);
266
+ }
267
+ if (value instanceof Date) {
268
+ return `${encodeURIComponent(fullKey)}=${encodeURIComponent(value.toISOString())}`;
269
+ }
270
+ if (value instanceof Object) {
271
+ return querystring(value, fullKey);
272
+ }
273
+ return `${encodeURIComponent(fullKey)}=${encodeURIComponent(String(value))}`;
274
+ }
275
+ export function exists(json, key) {
276
+ const value = json[key];
277
+ return value !== null && value !== undefined;
278
+ }
279
+ export function canConsumeForm(consumes) {
280
+ for (const consume of consumes) {
281
+ if ('multipart/form-data' === consume.contentType) {
282
+ return true;
283
+ }
284
+ }
285
+ return false;
286
+ }
287
+ export class JSONApiResponse {
288
+ raw;
289
+ transformer;
290
+ constructor(raw, transformer = (jsonValue) => jsonValue) {
291
+ this.raw = raw;
292
+ this.transformer = transformer;
293
+ }
294
+ async value() {
295
+ return this.transformer(await this.raw.json());
296
+ }
297
+ }
298
+ export class VoidApiResponse {
299
+ raw;
300
+ constructor(raw) {
301
+ this.raw = raw;
302
+ }
303
+ async value() {
304
+ return undefined;
305
+ }
306
+ }
307
+ export class BlobApiResponse {
308
+ raw;
309
+ constructor(raw) {
310
+ this.raw = raw;
311
+ }
312
+ async value() {
313
+ return await this.raw.blob();
314
+ }
315
+ ;
316
+ }
317
+ export class TextApiResponse {
318
+ raw;
319
+ constructor(raw) {
320
+ this.raw = raw;
321
+ }
322
+ async value() {
323
+ return await this.raw.text();
324
+ }
325
+ ;
326
+ }
@@ -0,0 +1,78 @@
1
+ /**
2
+ * DotAAS Part 2 | HTTP/REST | AASX File Server API
3
+ * The AASX file server API as part of Details of the Asset Administration Shell Part 2
4
+ *
5
+ * The version of the OpenAPI document: V1.0RC03
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { PackageDescription } from '../models/index';
14
+ export interface DeleteAASXByPackageIdRequest {
15
+ packageId: string;
16
+ }
17
+ export interface GetAASXByPackageIdRequest {
18
+ packageId: string;
19
+ }
20
+ export interface GetAllAASXPackageIdsRequest {
21
+ aasId?: string;
22
+ }
23
+ export interface PostAASXPackageRequest {
24
+ aasIds?: Array<string>;
25
+ file?: Blob;
26
+ fileName?: string;
27
+ }
28
+ export interface PutAASXByPackageIdRequest {
29
+ packageId: string;
30
+ aasIds?: Array<string>;
31
+ file?: Blob;
32
+ fileName?: string;
33
+ }
34
+ /**
35
+ *
36
+ */
37
+ export declare class AASXFileServerAPIApi extends runtime.BaseAPI {
38
+ /**
39
+ * Deletes a specific AASX package from the server
40
+ */
41
+ deleteAASXByPackageIdRaw(requestParameters: DeleteAASXByPackageIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
42
+ /**
43
+ * Deletes a specific AASX package from the server
44
+ */
45
+ deleteAASXByPackageId(requestParameters: DeleteAASXByPackageIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
46
+ /**
47
+ * Returns a specific AASX package from the server
48
+ */
49
+ getAASXByPackageIdRaw(requestParameters: GetAASXByPackageIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
50
+ /**
51
+ * Returns a specific AASX package from the server
52
+ */
53
+ getAASXByPackageId(requestParameters: GetAASXByPackageIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
54
+ /**
55
+ * Returns a list of available AASX packages at the server
56
+ */
57
+ getAllAASXPackageIdsRaw(requestParameters: GetAllAASXPackageIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<PackageDescription>>>;
58
+ /**
59
+ * Returns a list of available AASX packages at the server
60
+ */
61
+ getAllAASXPackageIds(requestParameters?: GetAllAASXPackageIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<PackageDescription>>;
62
+ /**
63
+ * Stores the AASX package at the server
64
+ */
65
+ postAASXPackageRaw(requestParameters: PostAASXPackageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PackageDescription>>;
66
+ /**
67
+ * Stores the AASX package at the server
68
+ */
69
+ postAASXPackage(requestParameters?: PostAASXPackageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PackageDescription>;
70
+ /**
71
+ * Updates the AASX package at the server
72
+ */
73
+ putAASXByPackageIdRaw(requestParameters: PutAASXByPackageIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
74
+ /**
75
+ * Updates the AASX package at the server
76
+ */
77
+ putAASXByPackageId(requestParameters: PutAASXByPackageIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
78
+ }
@@ -0,0 +1,184 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * DotAAS Part 2 | HTTP/REST | AASX File Server API
5
+ * The AASX file server API as part of Details of the Asset Administration Shell Part 2
6
+ *
7
+ * The version of the OpenAPI document: V1.0RC03
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import * as runtime from '../runtime';
15
+ /**
16
+ *
17
+ */
18
+ export class AASXFileServerAPIApi extends runtime.BaseAPI {
19
+ /**
20
+ * Deletes a specific AASX package from the server
21
+ */
22
+ async deleteAASXByPackageIdRaw(requestParameters, initOverrides) {
23
+ if (requestParameters['packageId'] == null) {
24
+ throw new runtime.RequiredError('packageId', 'Required parameter "packageId" was null or undefined when calling deleteAASXByPackageId().');
25
+ }
26
+ const queryParameters = {};
27
+ const headerParameters = {};
28
+ const response = await this.request({
29
+ path: `/packages/{packageId}`.replace(`{${"packageId"}}`, encodeURIComponent(String(requestParameters['packageId']))),
30
+ method: 'DELETE',
31
+ headers: headerParameters,
32
+ query: queryParameters,
33
+ }, initOverrides);
34
+ return new runtime.VoidApiResponse(response);
35
+ }
36
+ /**
37
+ * Deletes a specific AASX package from the server
38
+ */
39
+ async deleteAASXByPackageId(requestParameters, initOverrides) {
40
+ await this.deleteAASXByPackageIdRaw(requestParameters, initOverrides);
41
+ }
42
+ /**
43
+ * Returns a specific AASX package from the server
44
+ */
45
+ async getAASXByPackageIdRaw(requestParameters, initOverrides) {
46
+ if (requestParameters['packageId'] == null) {
47
+ throw new runtime.RequiredError('packageId', 'Required parameter "packageId" was null or undefined when calling getAASXByPackageId().');
48
+ }
49
+ const queryParameters = {};
50
+ const headerParameters = {};
51
+ const response = await this.request({
52
+ path: `/packages/{packageId}`.replace(`{${"packageId"}}`, encodeURIComponent(String(requestParameters['packageId']))),
53
+ method: 'GET',
54
+ headers: headerParameters,
55
+ query: queryParameters,
56
+ }, initOverrides);
57
+ return new runtime.BlobApiResponse(response);
58
+ }
59
+ /**
60
+ * Returns a specific AASX package from the server
61
+ */
62
+ async getAASXByPackageId(requestParameters, initOverrides) {
63
+ const response = await this.getAASXByPackageIdRaw(requestParameters, initOverrides);
64
+ return await response.value();
65
+ }
66
+ /**
67
+ * Returns a list of available AASX packages at the server
68
+ */
69
+ async getAllAASXPackageIdsRaw(requestParameters, initOverrides) {
70
+ const queryParameters = {};
71
+ if (requestParameters['aasId'] != null) {
72
+ queryParameters['aasId'] = requestParameters['aasId'];
73
+ }
74
+ const headerParameters = {};
75
+ const response = await this.request({
76
+ path: `/packages`,
77
+ method: 'GET',
78
+ headers: headerParameters,
79
+ query: queryParameters,
80
+ }, initOverrides);
81
+ return new runtime.JSONApiResponse(response);
82
+ }
83
+ /**
84
+ * Returns a list of available AASX packages at the server
85
+ */
86
+ async getAllAASXPackageIds(requestParameters = {}, initOverrides) {
87
+ const response = await this.getAllAASXPackageIdsRaw(requestParameters, initOverrides);
88
+ return await response.value();
89
+ }
90
+ /**
91
+ * Stores the AASX package at the server
92
+ */
93
+ async postAASXPackageRaw(requestParameters, initOverrides) {
94
+ const queryParameters = {};
95
+ const headerParameters = {};
96
+ const consumes = [
97
+ { contentType: 'multipart/form-data' },
98
+ ];
99
+ // @ts-ignore: canConsumeForm may be unused
100
+ const canConsumeForm = runtime.canConsumeForm(consumes);
101
+ let formParams;
102
+ let useForm = false;
103
+ // use FormData to transmit files using content-type "multipart/form-data"
104
+ useForm = canConsumeForm;
105
+ if (useForm) {
106
+ formParams = new FormData();
107
+ }
108
+ else {
109
+ formParams = new URLSearchParams();
110
+ }
111
+ if (requestParameters['aasIds'] != null) {
112
+ formParams.append('aasIds', requestParameters['aasIds'].join(runtime.COLLECTION_FORMATS["csv"]));
113
+ }
114
+ if (requestParameters['file'] != null) {
115
+ formParams.append('file', requestParameters['file']);
116
+ }
117
+ if (requestParameters['fileName'] != null) {
118
+ formParams.append('fileName', requestParameters['fileName']);
119
+ }
120
+ const response = await this.request({
121
+ path: `/packages`,
122
+ method: 'POST',
123
+ headers: headerParameters,
124
+ query: queryParameters,
125
+ body: formParams,
126
+ }, initOverrides);
127
+ return new runtime.JSONApiResponse(response);
128
+ }
129
+ /**
130
+ * Stores the AASX package at the server
131
+ */
132
+ async postAASXPackage(requestParameters = {}, initOverrides) {
133
+ const response = await this.postAASXPackageRaw(requestParameters, initOverrides);
134
+ return await response.value();
135
+ }
136
+ /**
137
+ * Updates the AASX package at the server
138
+ */
139
+ async putAASXByPackageIdRaw(requestParameters, initOverrides) {
140
+ if (requestParameters['packageId'] == null) {
141
+ throw new runtime.RequiredError('packageId', 'Required parameter "packageId" was null or undefined when calling putAASXByPackageId().');
142
+ }
143
+ const queryParameters = {};
144
+ const headerParameters = {};
145
+ const consumes = [
146
+ { contentType: 'multipart/form-data' },
147
+ ];
148
+ // @ts-ignore: canConsumeForm may be unused
149
+ const canConsumeForm = runtime.canConsumeForm(consumes);
150
+ let formParams;
151
+ let useForm = false;
152
+ // use FormData to transmit files using content-type "multipart/form-data"
153
+ useForm = canConsumeForm;
154
+ if (useForm) {
155
+ formParams = new FormData();
156
+ }
157
+ else {
158
+ formParams = new URLSearchParams();
159
+ }
160
+ if (requestParameters['aasIds'] != null) {
161
+ formParams.append('aasIds', requestParameters['aasIds'].join(runtime.COLLECTION_FORMATS["csv"]));
162
+ }
163
+ if (requestParameters['file'] != null) {
164
+ formParams.append('file', requestParameters['file']);
165
+ }
166
+ if (requestParameters['fileName'] != null) {
167
+ formParams.append('fileName', requestParameters['fileName']);
168
+ }
169
+ const response = await this.request({
170
+ path: `/packages/{packageId}`.replace(`{${"packageId"}}`, encodeURIComponent(String(requestParameters['packageId']))),
171
+ method: 'PUT',
172
+ headers: headerParameters,
173
+ query: queryParameters,
174
+ body: formParams,
175
+ }, initOverrides);
176
+ return new runtime.VoidApiResponse(response);
177
+ }
178
+ /**
179
+ * Updates the AASX package at the server
180
+ */
181
+ async putAASXByPackageId(requestParameters, initOverrides) {
182
+ await this.putAASXByPackageIdRaw(requestParameters, initOverrides);
183
+ }
184
+ }
@@ -0,0 +1 @@
1
+ export * from './AASXFileServerAPIApi';
@@ -0,0 +1,3 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ export * from './AASXFileServerAPIApi';
@@ -0,0 +1,3 @@
1
+ export * from './runtime';
2
+ export * from './apis/index';
3
+ export * from './models/index';
@@ -0,0 +1,5 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ export * from './runtime';
4
+ export * from './apis/index';
5
+ export * from './models/index';
@@ -0,0 +1,80 @@
1
+ /**
2
+ *
3
+ * @export
4
+ * @interface Message
5
+ */
6
+ export interface Message {
7
+ /**
8
+ *
9
+ * @type {string}
10
+ * @memberof Message
11
+ */
12
+ code?: string;
13
+ /**
14
+ *
15
+ * @type {string}
16
+ * @memberof Message
17
+ */
18
+ messageType?: MessageMessageTypeEnum;
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof Message
23
+ */
24
+ text?: string;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof Message
29
+ */
30
+ timestamp?: string;
31
+ }
32
+ /**
33
+ * @export
34
+ */
35
+ export declare const MessageMessageTypeEnum: {
36
+ readonly Undefined: "Undefined";
37
+ readonly Info: "Info";
38
+ readonly Warning: "Warning";
39
+ readonly Error: "Error";
40
+ readonly Exception: "Exception";
41
+ };
42
+ export type MessageMessageTypeEnum = typeof MessageMessageTypeEnum[keyof typeof MessageMessageTypeEnum];
43
+ /**
44
+ *
45
+ * @export
46
+ * @interface PackageDescription
47
+ */
48
+ export interface PackageDescription {
49
+ /**
50
+ *
51
+ * @type {Array<string>}
52
+ * @memberof PackageDescription
53
+ */
54
+ aasIds?: Array<string>;
55
+ /**
56
+ *
57
+ * @type {string}
58
+ * @memberof PackageDescription
59
+ */
60
+ packageId?: string;
61
+ }
62
+ /**
63
+ *
64
+ * @export
65
+ * @interface Result
66
+ */
67
+ export interface Result {
68
+ /**
69
+ *
70
+ * @type {Array<Message>}
71
+ * @memberof Result
72
+ */
73
+ messages?: Array<Message>;
74
+ /**
75
+ *
76
+ * @type {boolean}
77
+ * @memberof Result
78
+ */
79
+ success?: boolean;
80
+ }
@@ -0,0 +1,10 @@
1
+ /**
2
+ * @export
3
+ */
4
+ export const MessageMessageTypeEnum = {
5
+ Undefined: 'Undefined',
6
+ Info: 'Info',
7
+ Warning: 'Warning',
8
+ Error: 'Error',
9
+ Exception: 'Exception'
10
+ };