basyx-typescript-sdk 2.3.0 → 2.4.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 (62) hide show
  1. package/README.md +68 -1
  2. package/bundle/index.cjs +1421 -91
  3. package/bundle/index.cjs.map +1 -1
  4. package/bundle/index.mjs +1353 -92
  5. package/bundle/index.mjs.map +1 -1
  6. package/dist/clients/AasRegistryClient.d.ts +20 -0
  7. package/dist/clients/AasRegistryClient.js +40 -0
  8. package/dist/clients/AasRepositoryClient.d.ts +20 -0
  9. package/dist/clients/AasRepositoryClient.js +40 -0
  10. package/dist/clients/ConceptDescriptionRepositoryClient.d.ts +20 -0
  11. package/dist/clients/ConceptDescriptionRepositoryClient.js +40 -0
  12. package/dist/clients/SubmodelRegistryClient.d.ts +20 -0
  13. package/dist/clients/SubmodelRegistryClient.js +40 -0
  14. package/dist/clients/SubmodelRepositoryClient.d.ts +20 -0
  15. package/dist/clients/SubmodelRepositoryClient.js +40 -0
  16. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.d.ts +14 -1
  17. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.js +29 -0
  18. package/dist/generated/AasRegistryService/models/index.d.ts +374 -0
  19. package/dist/generated/AasRegistryService/models/index.js +6 -0
  20. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.d.ts +14 -1
  21. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.js +29 -0
  22. package/dist/generated/AasRepositoryService/models/index.d.ts +381 -0
  23. package/dist/generated/AasRepositoryService/models/index.js +7 -0
  24. package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.d.ts +14 -1
  25. package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.js +29 -0
  26. package/dist/generated/ConceptDescriptionRepositoryService/models/index.d.ts +381 -0
  27. package/dist/generated/ConceptDescriptionRepositoryService/models/index.js +7 -0
  28. package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.d.ts +14 -1
  29. package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.js +29 -0
  30. package/dist/generated/SubmodelRegistryService/models/index.d.ts +381 -0
  31. package/dist/generated/SubmodelRegistryService/models/index.js +7 -0
  32. package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.d.ts +14 -1
  33. package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.js +29 -0
  34. package/dist/generated/SubmodelRepositoryService/models/index.d.ts +381 -0
  35. package/dist/generated/SubmodelRepositoryService/models/index.js +7 -0
  36. package/dist/lib/endpointConfiguration.d.ts +71 -0
  37. package/dist/lib/endpointConfiguration.js +101 -0
  38. package/dist/lib/errorHandler.js +9 -4
  39. package/dist/lib/index.d.ts +1 -0
  40. package/dist/lib/index.js +2 -0
  41. package/dist/lib/queryJsonization.d.ts +17 -0
  42. package/dist/lib/queryJsonization.js +309 -0
  43. package/dist/lib/queryRequests.d.ts +24 -0
  44. package/dist/lib/queryRequests.js +44 -0
  45. package/dist/models/Query.d.ts +378 -0
  46. package/dist/models/Query.js +430 -0
  47. package/dist/models/QueryResult.d.ts +22 -0
  48. package/dist/models/QueryResult.js +1 -0
  49. package/dist/models/index.d.ts +2 -0
  50. package/dist/models/index.js +2 -0
  51. package/dist/services/AasService.d.ts +15 -4
  52. package/dist/services/AasService.js +38 -40
  53. package/dist/services/SubmodelService.d.ts +9 -8
  54. package/dist/services/SubmodelService.js +17 -34
  55. package/dist/services/index.d.ts +1 -0
  56. package/dist/utils/DescriptorUtils.d.ts +27 -1
  57. package/dist/utils/DescriptorUtils.js +65 -27
  58. package/dist/utils/ServiceDescriptionUtils.d.ts +30 -0
  59. package/dist/utils/ServiceDescriptionUtils.js +43 -0
  60. package/dist/utils/index.d.ts +2 -0
  61. package/dist/utils/index.js +2 -0
  62. package/package.json +1 -1
@@ -568,6 +568,182 @@ export interface LevelType {
568
568
  */
569
569
  max: boolean;
570
570
  }
571
+ /**
572
+ *
573
+ * @export
574
+ * @interface LogicalExpression
575
+ */
576
+ export interface LogicalExpression {
577
+ /**
578
+ *
579
+ * @type {Array<LogicalExpression>}
580
+ * @memberof LogicalExpression
581
+ */
582
+ $and?: Array<LogicalExpression>;
583
+ /**
584
+ *
585
+ * @type {Array<MatchExpression>}
586
+ * @memberof LogicalExpression
587
+ */
588
+ $match?: Array<MatchExpression>;
589
+ /**
590
+ *
591
+ * @type {Array<LogicalExpression>}
592
+ * @memberof LogicalExpression
593
+ */
594
+ $or?: Array<LogicalExpression>;
595
+ /**
596
+ *
597
+ * @type {LogicalExpression}
598
+ * @memberof LogicalExpression
599
+ */
600
+ $not?: LogicalExpression | null;
601
+ /**
602
+ *
603
+ * @type {Array<Value>}
604
+ * @memberof LogicalExpression
605
+ */
606
+ $eq?: Array<Value>;
607
+ /**
608
+ *
609
+ * @type {Array<Value>}
610
+ * @memberof LogicalExpression
611
+ */
612
+ $ne?: Array<Value>;
613
+ /**
614
+ *
615
+ * @type {Array<Value>}
616
+ * @memberof LogicalExpression
617
+ */
618
+ $gt?: Array<Value>;
619
+ /**
620
+ *
621
+ * @type {Array<Value>}
622
+ * @memberof LogicalExpression
623
+ */
624
+ $ge?: Array<Value>;
625
+ /**
626
+ *
627
+ * @type {Array<Value>}
628
+ * @memberof LogicalExpression
629
+ */
630
+ $lt?: Array<Value>;
631
+ /**
632
+ *
633
+ * @type {Array<Value>}
634
+ * @memberof LogicalExpression
635
+ */
636
+ $le?: Array<Value>;
637
+ /**
638
+ *
639
+ * @type {Array<StringValue>}
640
+ * @memberof LogicalExpression
641
+ */
642
+ $contains?: Array<StringValue>;
643
+ /**
644
+ *
645
+ * @type {Array<StringValue>}
646
+ * @memberof LogicalExpression
647
+ */
648
+ '$starts-with'?: Array<StringValue>;
649
+ /**
650
+ *
651
+ * @type {Array<StringValue>}
652
+ * @memberof LogicalExpression
653
+ */
654
+ '$ends-with'?: Array<StringValue>;
655
+ /**
656
+ *
657
+ * @type {Array<StringValue>}
658
+ * @memberof LogicalExpression
659
+ */
660
+ $regex?: Array<StringValue>;
661
+ /**
662
+ *
663
+ * @type {boolean}
664
+ * @memberof LogicalExpression
665
+ */
666
+ $boolean?: boolean;
667
+ }
668
+ /**
669
+ *
670
+ * @export
671
+ * @interface MatchExpression
672
+ */
673
+ export interface MatchExpression {
674
+ /**
675
+ *
676
+ * @type {Array<MatchExpression>}
677
+ * @memberof MatchExpression
678
+ */
679
+ $match?: Array<MatchExpression>;
680
+ /**
681
+ *
682
+ * @type {Array<Value>}
683
+ * @memberof MatchExpression
684
+ */
685
+ $eq?: Array<Value>;
686
+ /**
687
+ *
688
+ * @type {Array<Value>}
689
+ * @memberof MatchExpression
690
+ */
691
+ $ne?: Array<Value>;
692
+ /**
693
+ *
694
+ * @type {Array<Value>}
695
+ * @memberof MatchExpression
696
+ */
697
+ $gt?: Array<Value>;
698
+ /**
699
+ *
700
+ * @type {Array<Value>}
701
+ * @memberof MatchExpression
702
+ */
703
+ $ge?: Array<Value>;
704
+ /**
705
+ *
706
+ * @type {Array<Value>}
707
+ * @memberof MatchExpression
708
+ */
709
+ $lt?: Array<Value>;
710
+ /**
711
+ *
712
+ * @type {Array<Value>}
713
+ * @memberof MatchExpression
714
+ */
715
+ $le?: Array<Value>;
716
+ /**
717
+ *
718
+ * @type {Array<StringValue>}
719
+ * @memberof MatchExpression
720
+ */
721
+ $contains?: Array<StringValue>;
722
+ /**
723
+ *
724
+ * @type {Array<StringValue>}
725
+ * @memberof MatchExpression
726
+ */
727
+ '$starts-with'?: Array<StringValue>;
728
+ /**
729
+ *
730
+ * @type {Array<StringValue>}
731
+ * @memberof MatchExpression
732
+ */
733
+ '$ends-with'?: Array<StringValue>;
734
+ /**
735
+ *
736
+ * @type {Array<StringValue>}
737
+ * @memberof MatchExpression
738
+ */
739
+ $regex?: Array<StringValue>;
740
+ /**
741
+ *
742
+ * @type {boolean}
743
+ * @memberof MatchExpression
744
+ */
745
+ $boolean?: boolean;
746
+ }
571
747
  /**
572
748
  *
573
749
  * @export
@@ -750,6 +926,77 @@ export declare const ProtocolInformationSecurityAttributesTypeEnum: {
750
926
  readonly W3CDid: "W3C_DID";
751
927
  };
752
928
  export type ProtocolInformationSecurityAttributesTypeEnum = typeof ProtocolInformationSecurityAttributesTypeEnum[keyof typeof ProtocolInformationSecurityAttributesTypeEnum];
929
+ /**
930
+ *
931
+ * @export
932
+ * @interface Query
933
+ */
934
+ export interface Query {
935
+ /**
936
+ *
937
+ * @type {string}
938
+ * @memberof Query
939
+ */
940
+ $select?: string;
941
+ /**
942
+ *
943
+ * @type {LogicalExpression}
944
+ * @memberof Query
945
+ */
946
+ $condition: LogicalExpression | null;
947
+ }
948
+ /**
949
+ *
950
+ * @export
951
+ * @interface QueryResultSubmodelDescriptor
952
+ */
953
+ export interface QueryResultSubmodelDescriptor {
954
+ /**
955
+ *
956
+ * @type {QueryResultSubmodelDescriptorPagingMetadata}
957
+ * @memberof QueryResultSubmodelDescriptor
958
+ */
959
+ paging_metadata: QueryResultSubmodelDescriptorPagingMetadata;
960
+ /**
961
+ *
962
+ * @type {Array<QueryResultSubmodelDescriptorResultInner>}
963
+ * @memberof QueryResultSubmodelDescriptor
964
+ */
965
+ result?: Array<QueryResultSubmodelDescriptorResultInner>;
966
+ }
967
+ /**
968
+ *
969
+ * @export
970
+ * @interface QueryResultSubmodelDescriptorPagingMetadata
971
+ */
972
+ export interface QueryResultSubmodelDescriptorPagingMetadata {
973
+ /**
974
+ *
975
+ * @type {string}
976
+ * @memberof QueryResultSubmodelDescriptorPagingMetadata
977
+ */
978
+ cursor?: string;
979
+ /**
980
+ *
981
+ * @type {string}
982
+ * @memberof QueryResultSubmodelDescriptorPagingMetadata
983
+ */
984
+ resultType?: QueryResultSubmodelDescriptorPagingMetadataResultTypeEnum;
985
+ }
986
+ /**
987
+ * @export
988
+ */
989
+ export declare const QueryResultSubmodelDescriptorPagingMetadataResultTypeEnum: {
990
+ readonly SubmodelDescriptor: "SubmodelDescriptor";
991
+ readonly Identifier: "Identifier";
992
+ };
993
+ export type QueryResultSubmodelDescriptorPagingMetadataResultTypeEnum = typeof QueryResultSubmodelDescriptorPagingMetadataResultTypeEnum[keyof typeof QueryResultSubmodelDescriptorPagingMetadataResultTypeEnum];
994
+ /**
995
+ * @type QueryResultSubmodelDescriptorResultInner
996
+ *
997
+ * @export
998
+ */
999
+ export type QueryResultSubmodelDescriptorResultInner = SubmodelDescriptor | string;
753
1000
  /**
754
1001
  *
755
1002
  * @export
@@ -829,6 +1076,31 @@ export interface ServiceDescription {
829
1076
  */
830
1077
  profiles?: Array<string>;
831
1078
  }
1079
+ /**
1080
+ *
1081
+ * @export
1082
+ * @interface StringValue
1083
+ */
1084
+ export interface StringValue {
1085
+ /**
1086
+ *
1087
+ * @type {string}
1088
+ * @memberof StringValue
1089
+ */
1090
+ $field?: string;
1091
+ /**
1092
+ *
1093
+ * @type {string}
1094
+ * @memberof StringValue
1095
+ */
1096
+ $strVal?: string;
1097
+ /**
1098
+ *
1099
+ * @type {Value}
1100
+ * @memberof StringValue
1101
+ */
1102
+ $strCast?: Value | null;
1103
+ }
832
1104
  /**
833
1105
  *
834
1106
  * @export
@@ -890,6 +1162,115 @@ export interface SubmodelDescriptor {
890
1162
  */
891
1163
  extensions?: Array<Extension>;
892
1164
  }
1165
+ /**
1166
+ *
1167
+ * @export
1168
+ * @interface Value
1169
+ */
1170
+ export interface Value {
1171
+ /**
1172
+ *
1173
+ * @type {string}
1174
+ * @memberof Value
1175
+ */
1176
+ $field?: string;
1177
+ /**
1178
+ *
1179
+ * @type {string}
1180
+ * @memberof Value
1181
+ */
1182
+ $strVal?: string;
1183
+ /**
1184
+ *
1185
+ * @type {number}
1186
+ * @memberof Value
1187
+ */
1188
+ $numVal?: number;
1189
+ /**
1190
+ *
1191
+ * @type {string}
1192
+ * @memberof Value
1193
+ */
1194
+ $hexVal?: string;
1195
+ /**
1196
+ *
1197
+ * @type {string}
1198
+ * @memberof Value
1199
+ */
1200
+ $dateTimeVal?: string;
1201
+ /**
1202
+ *
1203
+ * @type {string}
1204
+ * @memberof Value
1205
+ */
1206
+ $timeVal?: string;
1207
+ /**
1208
+ *
1209
+ * @type {boolean}
1210
+ * @memberof Value
1211
+ */
1212
+ $boolean?: boolean;
1213
+ /**
1214
+ *
1215
+ * @type {Value}
1216
+ * @memberof Value
1217
+ */
1218
+ $strCast?: Value | null;
1219
+ /**
1220
+ *
1221
+ * @type {Value}
1222
+ * @memberof Value
1223
+ */
1224
+ $numCast?: Value | null;
1225
+ /**
1226
+ *
1227
+ * @type {Value}
1228
+ * @memberof Value
1229
+ */
1230
+ $hexCast?: Value | null;
1231
+ /**
1232
+ *
1233
+ * @type {Value}
1234
+ * @memberof Value
1235
+ */
1236
+ $boolCast?: Value | null;
1237
+ /**
1238
+ *
1239
+ * @type {Value}
1240
+ * @memberof Value
1241
+ */
1242
+ $dateTimeCast?: Value | null;
1243
+ /**
1244
+ *
1245
+ * @type {Value}
1246
+ * @memberof Value
1247
+ */
1248
+ $timeCast?: Value | null;
1249
+ /**
1250
+ *
1251
+ * @type {string}
1252
+ * @memberof Value
1253
+ */
1254
+ $dayOfWeek?: string;
1255
+ /**
1256
+ *
1257
+ * @type {string}
1258
+ * @memberof Value
1259
+ */
1260
+ $dayOfMonth?: string;
1261
+ /**
1262
+ *
1263
+ * @type {string}
1264
+ * @memberof Value
1265
+ */
1266
+ $month?: string;
1267
+ /**
1268
+ *
1269
+ * @type {string}
1270
+ * @memberof Value
1271
+ */
1272
+ $year?: string;
1273
+ }
893
1274
  /**
894
1275
  *
895
1276
  * @export
@@ -131,6 +131,13 @@ export const ProtocolInformationSecurityAttributesTypeEnum = {
131
131
  RfcTlsa: 'RFC_TLSA',
132
132
  W3CDid: 'W3C_DID'
133
133
  };
134
+ /**
135
+ * @export
136
+ */
137
+ export const QueryResultSubmodelDescriptorPagingMetadataResultTypeEnum = {
138
+ SubmodelDescriptor: 'SubmodelDescriptor',
139
+ Identifier: 'Identifier'
140
+ };
134
141
  /**
135
142
  *
136
143
  * @export
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../../runtime';
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';
13
+ import type { BaseOperationResult, GetPathItemsResult, GetReferencesResult, GetSubmodelElementsMetadataResult, GetSubmodelElementsResult, GetSubmodelElementsValueResult, GetSubmodelsMetadataResult, GetSubmodelsResult, GetSubmodelsValueResult, OperationRequest, OperationRequestValueOnly, OperationResult, OperationResultValueOnly, Query, QueryResultSubmodel, Reference, Submodel, SubmodelElement, SubmodelElementMetadata, SubmodelElementValue, SubmodelMetadata } from '../models/index';
14
14
  export interface DeleteFileByPathSubmodelRepoRequest {
15
15
  submodelIdentifier: string;
16
16
  idShortPath: string;
@@ -235,6 +235,11 @@ export interface PutSubmodelElementByPathSubmodelRepoRequest {
235
235
  submodelElement: SubmodelElement;
236
236
  level?: PutSubmodelElementByPathSubmodelRepoLevelEnum;
237
237
  }
238
+ export interface QuerySubmodelsRequest {
239
+ limit?: number;
240
+ cursor?: string;
241
+ query?: Query;
242
+ }
238
243
  /**
239
244
  *
240
245
  */
@@ -583,6 +588,14 @@ export declare class SubmodelRepositoryAPIApi extends runtime.BaseAPI {
583
588
  * Creates or updates an existing submodel element at a specified path within submodel elements hierarchy
584
589
  */
585
590
  putSubmodelElementByPathSubmodelRepo(requestParameters: PutSubmodelElementByPathSubmodelRepoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubmodelElement | null | undefined>;
591
+ /**
592
+ * Returns all Submodels that confirm to the input query
593
+ */
594
+ querySubmodelsRaw(requestParameters: QuerySubmodelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QueryResultSubmodel>>;
595
+ /**
596
+ * Returns all Submodels that confirm to the input query
597
+ */
598
+ querySubmodels(requestParameters?: QuerySubmodelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QueryResultSubmodel>;
586
599
  }
587
600
  /**
588
601
  * @export
@@ -1381,6 +1381,35 @@ export class SubmodelRepositoryAPIApi extends runtime.BaseAPI {
1381
1381
  return await response.value();
1382
1382
  }
1383
1383
  }
1384
+ /**
1385
+ * Returns all Submodels that confirm to the input query
1386
+ */
1387
+ async querySubmodelsRaw(requestParameters, initOverrides) {
1388
+ const queryParameters = {};
1389
+ if (requestParameters['limit'] != null) {
1390
+ queryParameters['limit'] = requestParameters['limit'];
1391
+ }
1392
+ if (requestParameters['cursor'] != null) {
1393
+ queryParameters['cursor'] = requestParameters['cursor'];
1394
+ }
1395
+ const headerParameters = {};
1396
+ headerParameters['Content-Type'] = 'application/json';
1397
+ const response = await this.request({
1398
+ path: `/query/submodels`,
1399
+ method: 'POST',
1400
+ headers: headerParameters,
1401
+ query: queryParameters,
1402
+ body: requestParameters['query'],
1403
+ }, initOverrides);
1404
+ return new runtime.JSONApiResponse(response);
1405
+ }
1406
+ /**
1407
+ * Returns all Submodels that confirm to the input query
1408
+ */
1409
+ async querySubmodels(requestParameters = {}, initOverrides) {
1410
+ const response = await this.querySubmodelsRaw(requestParameters, initOverrides);
1411
+ return await response.value();
1412
+ }
1384
1413
  }
1385
1414
  /**
1386
1415
  * @export