basyx-typescript-sdk 0.9.0 → 1.0.1

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 (79) hide show
  1. package/README.md +16 -11
  2. package/bundle/index.cjs +15675 -0
  3. package/bundle/index.cjs.map +1 -0
  4. package/bundle/{index.js → index.mjs} +981 -3080
  5. package/bundle/index.mjs.map +1 -0
  6. package/dist/clients/AasDiscoveryClient.d.ts +5 -4
  7. package/dist/clients/AasRegistryClient.d.ts +11 -10
  8. package/dist/clients/AasRepositoryClient.d.ts +51 -50
  9. package/dist/clients/AasxFileClient.d.ts +6 -5
  10. package/dist/clients/ConceptDescriptionRepositoryClient.d.ts +6 -5
  11. package/dist/clients/SubmodelRegistryClient.d.ts +6 -5
  12. package/dist/clients/SubmodelRepositoryClient.d.ts +21 -20
  13. package/dist/generated/AasDiscoveryService/apis/AssetAdministrationShellBasicDiscoveryAPIApi.d.ts +1 -1
  14. package/dist/generated/AasDiscoveryService/apis/AssetAdministrationShellBasicDiscoveryAPIApi.js +1 -1
  15. package/dist/generated/AasDiscoveryService/apis/DescriptionAPIApi.d.ts +1 -1
  16. package/dist/generated/AasDiscoveryService/apis/DescriptionAPIApi.js +1 -1
  17. package/dist/generated/AasDiscoveryService/index.d.ts +0 -1
  18. package/dist/generated/AasDiscoveryService/index.js +0 -1
  19. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.d.ts +1 -1
  20. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.js +1 -1
  21. package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.d.ts +1 -1
  22. package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.js +1 -1
  23. package/dist/generated/AasRegistryService/index.d.ts +0 -1
  24. package/dist/generated/AasRegistryService/index.js +0 -1
  25. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.d.ts +1 -1
  26. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.js +1 -1
  27. package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.d.ts +1 -1
  28. package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.js +1 -1
  29. package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.d.ts +1 -1
  30. package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.js +1 -1
  31. package/dist/generated/AasRepositoryService/index.d.ts +0 -1
  32. package/dist/generated/AasRepositoryService/index.js +0 -1
  33. package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.d.ts +1 -1
  34. package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.js +1 -1
  35. package/dist/generated/AasxFileService/index.d.ts +0 -1
  36. package/dist/generated/AasxFileService/index.js +0 -1
  37. package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.d.ts +1 -1
  38. package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.js +1 -1
  39. package/dist/generated/ConceptDescriptionRepositoryService/apis/DescriptionAPIApi.d.ts +1 -1
  40. package/dist/generated/ConceptDescriptionRepositoryService/apis/DescriptionAPIApi.js +1 -1
  41. package/dist/generated/ConceptDescriptionRepositoryService/apis/SerializationAPIApi.d.ts +1 -1
  42. package/dist/generated/ConceptDescriptionRepositoryService/apis/SerializationAPIApi.js +1 -1
  43. package/dist/generated/ConceptDescriptionRepositoryService/index.d.ts +0 -1
  44. package/dist/generated/ConceptDescriptionRepositoryService/index.js +0 -2
  45. package/dist/generated/SubmodelRegistryService/apis/DescriptionAPIApi.d.ts +1 -1
  46. package/dist/generated/SubmodelRegistryService/apis/DescriptionAPIApi.js +1 -1
  47. package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.d.ts +1 -1
  48. package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.js +1 -1
  49. package/dist/generated/SubmodelRegistryService/index.d.ts +0 -1
  50. package/dist/generated/SubmodelRegistryService/index.js +0 -1
  51. package/dist/generated/SubmodelRepositoryService/apis/DescriptionAPIApi.d.ts +1 -1
  52. package/dist/generated/SubmodelRepositoryService/apis/DescriptionAPIApi.js +1 -1
  53. package/dist/generated/SubmodelRepositoryService/apis/SerializationAPIApi.d.ts +1 -1
  54. package/dist/generated/SubmodelRepositoryService/apis/SerializationAPIApi.js +1 -1
  55. package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.d.ts +1 -1
  56. package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.js +1 -1
  57. package/dist/generated/SubmodelRepositoryService/index.d.ts +0 -1
  58. package/dist/generated/SubmodelRepositoryService/index.js +0 -1
  59. package/dist/generated/index.d.ts +1 -0
  60. package/dist/generated/index.js +1 -0
  61. package/dist/generated/{SubmodelRepositoryService/runtime.d.ts → runtime.d.ts} +2 -2
  62. package/dist/generated/{SubmodelRepositoryService/runtime.js → runtime.js} +2 -2
  63. package/dist/lib/apiConfig.d.ts +2 -2
  64. package/dist/lib/apiConfig.js +3 -21
  65. package/dist/lib/errorHandler.js +4 -23
  66. package/package.json +6 -11
  67. package/bundle/index.js.map +0 -1
  68. package/dist/generated/AasDiscoveryService/runtime.d.ts +0 -181
  69. package/dist/generated/AasDiscoveryService/runtime.js +0 -326
  70. package/dist/generated/AasRegistryService/runtime.d.ts +0 -181
  71. package/dist/generated/AasRegistryService/runtime.js +0 -326
  72. package/dist/generated/AasRepositoryService/runtime.d.ts +0 -181
  73. package/dist/generated/AasRepositoryService/runtime.js +0 -326
  74. package/dist/generated/AasxFileService/runtime.d.ts +0 -181
  75. package/dist/generated/AasxFileService/runtime.js +0 -326
  76. package/dist/generated/ConceptDescriptionRepositoryService/runtime.d.ts +0 -181
  77. package/dist/generated/ConceptDescriptionRepositoryService/runtime.js +0 -326
  78. package/dist/generated/SubmodelRegistryService/runtime.d.ts +0 -181
  79. package/dist/generated/SubmodelRegistryService/runtime.js +0 -326
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import * as runtime from '../runtime';
12
+ import * as runtime from '../../runtime';
13
13
  export interface GenerateSerializationByIdsRequest {
14
14
  aasIds?: Array<string>;
15
15
  submodelIds?: Array<string>;
@@ -11,7 +11,7 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
- import * as runtime from '../runtime';
14
+ import * as runtime from '../../runtime';
15
15
  /**
16
16
  *
17
17
  */
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import * as runtime from '../runtime';
12
+ import * as runtime from '../../runtime';
13
13
  import type { BaseOperationResult, GetPathItemsResult, GetReferencesResult, GetSubmodelElementsMetadataResult, GetSubmodelElementsResult, GetSubmodelElementsValueResult, GetSubmodelsMetadataResult, GetSubmodelsResult, GetSubmodelsValueResult, OperationRequest, OperationRequestValueOnly, OperationResult, OperationResultValueOnly, Reference, Submodel, SubmodelElement, SubmodelElementMetadata, SubmodelElementValue, SubmodelMetadata } from '../models/index';
14
14
  export interface DeleteFileByPathSubmodelRepoRequest {
15
15
  submodelIdentifier: string;
@@ -11,7 +11,7 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
- import * as runtime from '../runtime';
14
+ import * as runtime from '../../runtime';
15
15
  /**
16
16
  *
17
17
  */
@@ -1,3 +1,2 @@
1
- export * from './runtime';
2
1
  export * from './apis/index';
3
2
  export * from './models/index';
@@ -1,5 +1,4 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
- export * from './runtime';
4
3
  export * from './apis/index';
5
4
  export * from './models/index';
@@ -5,4 +5,5 @@ import * as AasRegistryService from './AasRegistryService';
5
5
  import * as SubmodelRegistryService from './SubmodelRegistryService';
6
6
  import * as AasDiscoveryService from './AasDiscoveryService';
7
7
  import * as AasxFileService from './AasxFileService';
8
+ export * from './runtime';
8
9
  export { AasRepositoryService, SubmodelRepositoryService, ConceptDescriptionRepositoryService, AasRegistryService, SubmodelRegistryService, AasDiscoveryService, AasxFileService };
@@ -5,4 +5,5 @@ import * as AasRegistryService from './AasRegistryService';
5
5
  import * as SubmodelRegistryService from './SubmodelRegistryService';
6
6
  import * as AasDiscoveryService from './AasDiscoveryService';
7
7
  import * as AasxFileService from './AasxFileService';
8
+ export * from './runtime';
8
9
  export { AasRepositoryService, SubmodelRepositoryService, ConceptDescriptionRepositoryService, AasRegistryService, SubmodelRegistryService, AasDiscoveryService, AasxFileService };
@@ -1,6 +1,6 @@
1
1
  /**
2
- * DotAAS Part 2 | HTTP/REST | Submodel Repository Service Specification
3
- * The entire Submodel 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
2
+ * DotAAS Part 2 | HTTP/REST | Runtime Configuration
3
+ * The entire Full Profile of the Runtime Configuration as part of the [Specification of the Asset Administration Shell - Part 2: API](https://industrialdigitaltwin.org/en/content-hub/aasspecifications). Copyright: Industrial Digital Twin Association (IDTA) 2025
4
4
  *
5
5
  * The version of the OpenAPI document: V3.1.0_SSP-001
6
6
  * Contact: info@idtwin.org
@@ -1,8 +1,8 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * DotAAS Part 2 | HTTP/REST | Submodel Repository Service Specification
5
- * The entire Submodel 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
4
+ * DotAAS Part 2 | HTTP/REST | Runtime Configuration
5
+ * The entire Full Profile of the Runtime Configuration as part of the [Specification of the Asset Administration Shell - Part 2: API](https://industrialdigitaltwin.org/en/content-hub/aasspecifications). Copyright: Industrial Digital Twin Association (IDTA) 2025
6
6
  *
7
7
  * The version of the OpenAPI document: V3.1.0_SSP-001
8
8
  * Contact: info@idtwin.org
@@ -1,2 +1,2 @@
1
- import { AasDiscoveryService, AasRegistryService, AasRepositoryService, AasxFileService, ConceptDescriptionRepositoryService, SubmodelRegistryService, SubmodelRepositoryService } from '../generated';
2
- export declare function applyDefaults<T extends AasRepositoryService.Configuration | SubmodelRepositoryService.Configuration | ConceptDescriptionRepositoryService.Configuration | AasRegistryService.Configuration | SubmodelRegistryService.Configuration | AasDiscoveryService.Configuration | AasxFileService.Configuration>(configuration: T): T;
1
+ import { Configuration } from '../generated/runtime';
2
+ export declare function applyDefaults(configuration: Configuration): Configuration;
@@ -1,6 +1,5 @@
1
1
  //import { Configuration } from '../generated';
2
- import { AasDiscoveryService, AasRegistryService, AasRepositoryService, AasxFileService, ConceptDescriptionRepositoryService, SubmodelRegistryService, SubmodelRepositoryService, } from '../generated';
3
- //export function applyDefaults(configuration: AAS.Configuration): AAS.Configuration {
2
+ import { Configuration } from '../generated/runtime';
4
3
  export function applyDefaults(configuration) {
5
4
  // Extract configuration properties
6
5
  const options = {
@@ -15,25 +14,8 @@ export function applyDefaults(configuration) {
15
14
  headers: configuration.headers || undefined,
16
15
  credentials: configuration.credentials || undefined,
17
16
  };
18
- // Create the appropriate configuration type
19
- switch (configuration.constructor) {
20
- case AasRepositoryService.Configuration:
21
- return new AasRepositoryService.Configuration(options);
22
- case SubmodelRepositoryService.Configuration:
23
- return new SubmodelRepositoryService.Configuration(options);
24
- case ConceptDescriptionRepositoryService.Configuration:
25
- return new ConceptDescriptionRepositoryService.Configuration(options);
26
- case AasRegistryService.Configuration:
27
- return new AasRegistryService.Configuration(options);
28
- case SubmodelRegistryService.Configuration:
29
- return new SubmodelRegistryService.Configuration(options);
30
- case AasDiscoveryService.Configuration:
31
- return new AasDiscoveryService.Configuration(options);
32
- case AasxFileService.Configuration:
33
- return new AasxFileService.Configuration(options);
34
- default:
35
- throw new Error('None of the configuration types match');
36
- }
17
+ // Create a new configuration instance with defaults applied
18
+ return new Configuration(options);
37
19
  }
38
20
  function getDefaultFetchApi() {
39
21
  // In Node (>=18) or browser, global fetch is available.
@@ -1,5 +1,4 @@
1
- //import { FetchError, Message, RequiredError, ResponseError, Result } from '../generated';
2
- import { AasDiscoveryService, AasRegistryService, AasRepositoryService, AasxFileService, ConceptDescriptionRepositoryService, SubmodelRegistryService, SubmodelRepositoryService, } from '../generated';
1
+ import { FetchError, RequiredError, ResponseError } from '../generated/runtime';
3
2
  /**
4
3
  * Processes errors from API calls and standardizes them to a Result object
5
4
  * with a consistent messages array following the API spec guidelines.
@@ -23,13 +22,7 @@ export async function handleApiError(err) {
23
22
  text: 'Unknown error',
24
23
  };
25
24
  // Handle different error types
26
- if (err instanceof AasRepositoryService.RequiredError ||
27
- err instanceof SubmodelRepositoryService.RequiredError ||
28
- err instanceof ConceptDescriptionRepositoryService.RequiredError ||
29
- err instanceof AasRegistryService.RequiredError ||
30
- err instanceof SubmodelRegistryService.RequiredError ||
31
- err instanceof AasDiscoveryService.RequiredError ||
32
- err instanceof AasxFileService.RequiredError) {
25
+ if (err instanceof RequiredError) {
33
26
  message = {
34
27
  code: '400',
35
28
  messageType: 'Exception',
@@ -37,13 +30,7 @@ export async function handleApiError(err) {
37
30
  timestamp: timestamp,
38
31
  };
39
32
  }
40
- else if (err instanceof AasRepositoryService.ResponseError ||
41
- err instanceof SubmodelRepositoryService.ResponseError ||
42
- err instanceof ConceptDescriptionRepositoryService.ResponseError ||
43
- err instanceof AasRegistryService.ResponseError ||
44
- err instanceof SubmodelRegistryService.ResponseError ||
45
- err instanceof AasDiscoveryService.ResponseError ||
46
- err instanceof AasxFileService.ResponseError) {
33
+ else if (err instanceof ResponseError) {
47
34
  // Try to parse response body for messages
48
35
  const responseBody = err.response;
49
36
  try {
@@ -70,13 +57,7 @@ export async function handleApiError(err) {
70
57
  };
71
58
  }
72
59
  }
73
- else if (err instanceof AasRepositoryService.FetchError ||
74
- err instanceof SubmodelRepositoryService.FetchError ||
75
- err instanceof ConceptDescriptionRepositoryService.FetchError ||
76
- err instanceof AasRegistryService.FetchError ||
77
- err instanceof SubmodelRegistryService.FetchError ||
78
- err instanceof AasDiscoveryService.FetchError ||
79
- err instanceof AasxFileService.FetchError) {
60
+ else if (err instanceof FetchError) {
80
61
  message = {
81
62
  code: '0',
82
63
  messageType: 'Exception',
package/package.json CHANGED
@@ -1,25 +1,21 @@
1
1
  {
2
2
  "name": "basyx-typescript-sdk",
3
- "version": "0.9.0",
3
+ "version": "1.0.1",
4
4
  "description": "BaSyx TypeScript SDK for developing applications and components for the Asset Administration Shell (AAS)",
5
- "type": "module",
6
- "main": "bundle/index.js",
5
+ "main": "bundle/index.cjs",
6
+ "module": "bundle/index.mjs",
7
7
  "types": "dist/index.d.ts",
8
8
  "exports": {
9
9
  ".": {
10
- "import": "./bundle/index.js",
10
+ "import": "./bundle/index.mjs",
11
+ "require": "./bundle/index.cjs",
11
12
  "types": "./dist/index.d.ts"
12
13
  }
13
14
  },
14
15
  "repository": "https://github.com/eclipse-basyx/basyx-typescript-sdk.git",
15
16
  "author": "Aaron Zielstorff <aaron.zielstorff@iese.fraunhofer.de>",
16
17
  "license": "MIT",
17
- "files": [
18
- "bundle",
19
- "dist",
20
- "README.md",
21
- "LICENSE"
22
- ],
18
+ "files": ["bundle", "dist", "README.md", "LICENSE"],
23
19
  "scripts": {
24
20
  "build": "tsc",
25
21
  "bundle": "rollup -c",
@@ -34,7 +30,6 @@
34
30
  "gen-smregistry": "openapi-generator-cli generate -i openapi/smregistry.yaml -g typescript-fetch -o src/generated/SubmodelRegistryService --additional-properties=withoutRuntimeChecks=true",
35
31
  "gen-aasdiscovery": "openapi-generator-cli generate -i openapi/aasdiscovery.yaml -g typescript-fetch -o src/generated/AasDiscoveryService --additional-properties=withoutRuntimeChecks=true",
36
32
  "gen-aasxfileserver": "openapi-generator-cli generate -i openapi/aasxfileserver.yaml -g typescript-fetch -o src/generated/AasxFileService --additional-properties=withoutRuntimeChecks=true"
37
-
38
33
  },
39
34
  "peerDependencies": {
40
35
  "@aas-core-works/aas-core3.0-typescript": "^1.0.3"