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,221 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ *
5
+ * @export
6
+ */
7
+ export const AasSubmodelElements = {
8
+ AnnotatedRelationshipElement: 'AnnotatedRelationshipElement',
9
+ BasicEventElement: 'BasicEventElement',
10
+ Blob: 'Blob',
11
+ Capability: 'Capability',
12
+ DataElement: 'DataElement',
13
+ Entity: 'Entity',
14
+ EventElement: 'EventElement',
15
+ File: 'File',
16
+ MultiLanguageProperty: 'MultiLanguageProperty',
17
+ Operation: 'Operation',
18
+ Property: 'Property',
19
+ Range: 'Range',
20
+ ReferenceElement: 'ReferenceElement',
21
+ RelationshipElement: 'RelationshipElement',
22
+ SubmodelElement: 'SubmodelElement',
23
+ SubmodelElementCollection: 'SubmodelElementCollection',
24
+ SubmodelElementList: 'SubmodelElementList'
25
+ };
26
+ /**
27
+ *
28
+ * @export
29
+ */
30
+ export const AssetKind = {
31
+ Instance: 'Instance',
32
+ NotApplicable: 'NotApplicable',
33
+ Role: 'Role',
34
+ Type: 'Type'
35
+ };
36
+ /**
37
+ *
38
+ * @export
39
+ */
40
+ export const DataTypeDefXsd = {
41
+ XsAnyUri: 'xs:anyURI',
42
+ XsBase64Binary: 'xs:base64Binary',
43
+ XsBoolean: 'xs:boolean',
44
+ XsByte: 'xs:byte',
45
+ XsDate: 'xs:date',
46
+ XsDateTime: 'xs:dateTime',
47
+ XsDecimal: 'xs:decimal',
48
+ XsDouble: 'xs:double',
49
+ XsDuration: 'xs:duration',
50
+ XsFloat: 'xs:float',
51
+ XsGDay: 'xs:gDay',
52
+ XsGMonth: 'xs:gMonth',
53
+ XsGMonthDay: 'xs:gMonthDay',
54
+ XsGYear: 'xs:gYear',
55
+ XsGYearMonth: 'xs:gYearMonth',
56
+ XsHexBinary: 'xs:hexBinary',
57
+ XsInt: 'xs:int',
58
+ XsInteger: 'xs:integer',
59
+ XsLong: 'xs:long',
60
+ XsNegativeInteger: 'xs:negativeInteger',
61
+ XsNonNegativeInteger: 'xs:nonNegativeInteger',
62
+ XsNonPositiveInteger: 'xs:nonPositiveInteger',
63
+ XsPositiveInteger: 'xs:positiveInteger',
64
+ XsShort: 'xs:short',
65
+ XsString: 'xs:string',
66
+ XsTime: 'xs:time',
67
+ XsUnsignedByte: 'xs:unsignedByte',
68
+ XsUnsignedInt: 'xs:unsignedInt',
69
+ XsUnsignedLong: 'xs:unsignedLong',
70
+ XsUnsignedShort: 'xs:unsignedShort'
71
+ };
72
+ /**
73
+ *
74
+ * @export
75
+ */
76
+ export const DataTypeIec61360 = {
77
+ Blob: 'BLOB',
78
+ Boolean: 'BOOLEAN',
79
+ Date: 'DATE',
80
+ File: 'FILE',
81
+ Html: 'HTML',
82
+ IntegerCount: 'INTEGER_COUNT',
83
+ IntegerCurrency: 'INTEGER_CURRENCY',
84
+ IntegerMeasure: 'INTEGER_MEASURE',
85
+ Irdi: 'IRDI',
86
+ Iri: 'IRI',
87
+ Rational: 'RATIONAL',
88
+ RationalMeasure: 'RATIONAL_MEASURE',
89
+ RealCount: 'REAL_COUNT',
90
+ RealCurrency: 'REAL_CURRENCY',
91
+ RealMeasure: 'REAL_MEASURE',
92
+ String: 'STRING',
93
+ StringTranslatable: 'STRING_TRANSLATABLE',
94
+ Time: 'TIME',
95
+ Timestamp: 'TIMESTAMP'
96
+ };
97
+ /**
98
+ *
99
+ * @export
100
+ */
101
+ export const Direction = {
102
+ Input: 'input',
103
+ Output: 'output'
104
+ };
105
+ /**
106
+ *
107
+ * @export
108
+ */
109
+ export const EntityType = {
110
+ CoManagedEntity: 'CoManagedEntity',
111
+ SelfManagedEntity: 'SelfManagedEntity'
112
+ };
113
+ /**
114
+ *
115
+ * @export
116
+ */
117
+ export const ExecutionState = {
118
+ Initiated: 'Initiated',
119
+ Running: 'Running',
120
+ Completed: 'Completed',
121
+ Canceled: 'Canceled',
122
+ Failed: 'Failed',
123
+ Timeout: 'Timeout'
124
+ };
125
+ /**
126
+ *
127
+ * @export
128
+ */
129
+ export const KeyTypes = {
130
+ AnnotatedRelationshipElement: 'AnnotatedRelationshipElement',
131
+ AssetAdministrationShell: 'AssetAdministrationShell',
132
+ BasicEventElement: 'BasicEventElement',
133
+ Blob: 'Blob',
134
+ Capability: 'Capability',
135
+ ConceptDescription: 'ConceptDescription',
136
+ DataElement: 'DataElement',
137
+ Entity: 'Entity',
138
+ EventElement: 'EventElement',
139
+ File: 'File',
140
+ FragmentReference: 'FragmentReference',
141
+ GlobalReference: 'GlobalReference',
142
+ Identifiable: 'Identifiable',
143
+ MultiLanguageProperty: 'MultiLanguageProperty',
144
+ Operation: 'Operation',
145
+ Property: 'Property',
146
+ Range: 'Range',
147
+ Referable: 'Referable',
148
+ ReferenceElement: 'ReferenceElement',
149
+ RelationshipElement: 'RelationshipElement',
150
+ Submodel: 'Submodel',
151
+ SubmodelElement: 'SubmodelElement',
152
+ SubmodelElementCollection: 'SubmodelElementCollection',
153
+ SubmodelElementList: 'SubmodelElementList'
154
+ };
155
+ /**
156
+ * @export
157
+ */
158
+ export const MessageMessageTypeEnum = {
159
+ Undefined: 'Undefined',
160
+ Info: 'Info',
161
+ Warning: 'Warning',
162
+ Error: 'Error',
163
+ Exception: 'Exception'
164
+ };
165
+ /**
166
+ *
167
+ * @export
168
+ */
169
+ export const ModelType = {
170
+ AnnotatedRelationshipElement: 'AnnotatedRelationshipElement',
171
+ AssetAdministrationShell: 'AssetAdministrationShell',
172
+ BasicEventElement: 'BasicEventElement',
173
+ Blob: 'Blob',
174
+ Capability: 'Capability',
175
+ ConceptDescription: 'ConceptDescription',
176
+ DataSpecificationIec61360: 'DataSpecificationIec61360',
177
+ Entity: 'Entity',
178
+ File: 'File',
179
+ MultiLanguageProperty: 'MultiLanguageProperty',
180
+ Operation: 'Operation',
181
+ Property: 'Property',
182
+ Range: 'Range',
183
+ ReferenceElement: 'ReferenceElement',
184
+ RelationshipElement: 'RelationshipElement',
185
+ Submodel: 'Submodel',
186
+ SubmodelElementCollection: 'SubmodelElementCollection',
187
+ SubmodelElementList: 'SubmodelElementList'
188
+ };
189
+ /**
190
+ *
191
+ * @export
192
+ */
193
+ export const ModellingKind = {
194
+ Instance: 'Instance',
195
+ Template: 'Template'
196
+ };
197
+ /**
198
+ *
199
+ * @export
200
+ */
201
+ export const QualifierKind = {
202
+ ConceptQualifier: 'ConceptQualifier',
203
+ TemplateQualifier: 'TemplateQualifier',
204
+ ValueQualifier: 'ValueQualifier'
205
+ };
206
+ /**
207
+ *
208
+ * @export
209
+ */
210
+ export const ReferenceTypes = {
211
+ ExternalReference: 'ExternalReference',
212
+ ModelReference: 'ModelReference'
213
+ };
214
+ /**
215
+ *
216
+ * @export
217
+ */
218
+ export const StateOfEvent = {
219
+ Off: 'off',
220
+ On: 'on'
221
+ };
@@ -0,0 +1,181 @@
1
+ /**
2
+ * DotAAS Part 2 | HTTP/REST | Asset Administration Shell Repository Service Specification
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: V3.1.0_SSP-001
6
+ * Contact: info@idtwin.org
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
+ export declare const BASE_PATH: string;
13
+ export interface ConfigurationParameters {
14
+ basePath?: string;
15
+ fetchApi?: FetchAPI;
16
+ middleware?: Middleware[];
17
+ queryParamsStringify?: (params: HTTPQuery) => string;
18
+ username?: string;
19
+ password?: string;
20
+ apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
21
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
22
+ headers?: HTTPHeaders;
23
+ credentials?: RequestCredentials;
24
+ }
25
+ export declare class Configuration {
26
+ private configuration;
27
+ constructor(configuration?: ConfigurationParameters);
28
+ set config(configuration: Configuration);
29
+ get basePath(): string;
30
+ get fetchApi(): FetchAPI | undefined;
31
+ get middleware(): Middleware[];
32
+ get queryParamsStringify(): (params: HTTPQuery) => string;
33
+ get username(): string | undefined;
34
+ get password(): string | undefined;
35
+ get apiKey(): ((name: string) => string | Promise<string>) | undefined;
36
+ get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
37
+ get headers(): HTTPHeaders | undefined;
38
+ get credentials(): RequestCredentials | undefined;
39
+ }
40
+ export declare const DefaultConfig: Configuration;
41
+ /**
42
+ * This is the base class for all generated API classes.
43
+ */
44
+ export declare class BaseAPI {
45
+ protected configuration: Configuration;
46
+ private static readonly jsonRegex;
47
+ private middleware;
48
+ constructor(configuration?: Configuration);
49
+ withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
50
+ withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
51
+ withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
52
+ /**
53
+ * Check if the given MIME is a JSON MIME.
54
+ * JSON MIME examples:
55
+ * application/json
56
+ * application/json; charset=UTF8
57
+ * APPLICATION/JSON
58
+ * application/vnd.company+json
59
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
60
+ * @return True if the given MIME is JSON, false otherwise.
61
+ */
62
+ protected isJsonMime(mime: string | null | undefined): boolean;
63
+ protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
64
+ private createFetchParams;
65
+ private fetchApi;
66
+ /**
67
+ * Create a shallow clone of `this` by constructing a new instance
68
+ * and then shallow cloning data members.
69
+ */
70
+ private clone;
71
+ }
72
+ export declare class ResponseError extends Error {
73
+ response: Response;
74
+ name: "ResponseError";
75
+ constructor(response: Response, msg?: string);
76
+ }
77
+ export declare class FetchError extends Error {
78
+ cause: Error;
79
+ name: "FetchError";
80
+ constructor(cause: Error, msg?: string);
81
+ }
82
+ export declare class RequiredError extends Error {
83
+ field: string;
84
+ name: "RequiredError";
85
+ constructor(field: string, msg?: string);
86
+ }
87
+ export declare const COLLECTION_FORMATS: {
88
+ csv: string;
89
+ ssv: string;
90
+ tsv: string;
91
+ pipes: string;
92
+ };
93
+ export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
94
+ export type Json = any;
95
+ export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
96
+ export type HTTPHeaders = {
97
+ [key: string]: string;
98
+ };
99
+ export type HTTPQuery = {
100
+ [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
101
+ };
102
+ export type HTTPBody = Json | FormData | URLSearchParams;
103
+ export type HTTPRequestInit = {
104
+ headers?: HTTPHeaders;
105
+ method: HTTPMethod;
106
+ credentials?: RequestCredentials;
107
+ body?: HTTPBody;
108
+ };
109
+ export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
110
+ export type InitOverrideFunction = (requestContext: {
111
+ init: HTTPRequestInit;
112
+ context: RequestOpts;
113
+ }) => Promise<RequestInit>;
114
+ export interface FetchParams {
115
+ url: string;
116
+ init: RequestInit;
117
+ }
118
+ export interface RequestOpts {
119
+ path: string;
120
+ method: HTTPMethod;
121
+ headers: HTTPHeaders;
122
+ query?: HTTPQuery;
123
+ body?: HTTPBody;
124
+ }
125
+ export declare function querystring(params: HTTPQuery, prefix?: string): string;
126
+ export declare function exists(json: any, key: string): boolean;
127
+ export declare function canConsumeForm(consumes: Consume[]): boolean;
128
+ export interface Consume {
129
+ contentType: string;
130
+ }
131
+ export interface RequestContext {
132
+ fetch: FetchAPI;
133
+ url: string;
134
+ init: RequestInit;
135
+ }
136
+ export interface ResponseContext {
137
+ fetch: FetchAPI;
138
+ url: string;
139
+ init: RequestInit;
140
+ response: Response;
141
+ }
142
+ export interface ErrorContext {
143
+ fetch: FetchAPI;
144
+ url: string;
145
+ init: RequestInit;
146
+ error: unknown;
147
+ response?: Response;
148
+ }
149
+ export interface Middleware {
150
+ pre?(context: RequestContext): Promise<FetchParams | void>;
151
+ post?(context: ResponseContext): Promise<Response | void>;
152
+ onError?(context: ErrorContext): Promise<Response | void>;
153
+ }
154
+ export interface ApiResponse<T> {
155
+ raw: Response;
156
+ value(): Promise<T>;
157
+ }
158
+ export interface ResponseTransformer<T> {
159
+ (json: any): T;
160
+ }
161
+ export declare class JSONApiResponse<T> {
162
+ raw: Response;
163
+ private transformer;
164
+ constructor(raw: Response, transformer?: ResponseTransformer<T>);
165
+ value(): Promise<T>;
166
+ }
167
+ export declare class VoidApiResponse {
168
+ raw: Response;
169
+ constructor(raw: Response);
170
+ value(): Promise<void>;
171
+ }
172
+ export declare class BlobApiResponse {
173
+ raw: Response;
174
+ constructor(raw: Response);
175
+ value(): Promise<Blob>;
176
+ }
177
+ export declare class TextApiResponse {
178
+ raw: Response;
179
+ constructor(raw: Response);
180
+ value(): Promise<string>;
181
+ }