@api-client/core 0.3.1 → 0.3.4

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 (183) hide show
  1. package/build/browser.d.ts +1 -1
  2. package/build/index.d.ts +2 -2
  3. package/build/index.js.map +1 -1
  4. package/build/src/models/Backend.d.ts +22 -0
  5. package/build/src/runtime/store/StoreSdk.d.ts +192 -12
  6. package/build/src/runtime/store/StoreSdk.js +592 -53
  7. package/build/src/runtime/store/StoreSdk.js.map +1 -1
  8. package/package.json +3 -1
  9. package/src/data/DataReader.ts +11 -0
  10. package/src/data/DataUtils.ts +108 -0
  11. package/src/data/JmesparthReader.ts +26 -0
  12. package/src/data/Json2Xml.ts +190 -0
  13. package/src/data/JsonReader.ts +41 -0
  14. package/src/data/PayloadPointer.ts +48 -0
  15. package/src/data/RequestDataExtractor.ts +133 -0
  16. package/src/data/UrlEncodedReader.ts +20 -0
  17. package/src/data/XmlReader.ts +103 -0
  18. package/src/events/BaseEvents.ts +259 -0
  19. package/src/events/CustomEvent.ts +27 -0
  20. package/src/events/EventTypes.ts +19 -0
  21. package/src/events/Events.ts +19 -0
  22. package/src/events/authorization/AuthorizationEventTypes.ts +22 -0
  23. package/src/events/authorization/AuthorizationEvents.ts +61 -0
  24. package/src/events/cookies/CookieEventTypes.ts +13 -0
  25. package/src/events/cookies/CookieEvents.ts +157 -0
  26. package/src/events/encryption/EncryptionEventTypes.ts +4 -0
  27. package/src/events/encryption/EncryptionEvents.ts +51 -0
  28. package/src/events/environment/EnvironmentEventTypes.ts +3 -0
  29. package/src/events/environment/EnvironmentEvents.ts +24 -0
  30. package/src/events/models/ClientCertificateEvents.ts +87 -0
  31. package/src/events/models/ModelEventTypes.ts +47 -0
  32. package/src/events/models/ModelEvents.ts +7 -0
  33. package/src/events/models/ProjectEvents.ts +331 -0
  34. package/src/events/process/ProcessEventTypes.ts +5 -0
  35. package/src/events/process/ProcessEvents.ts +76 -0
  36. package/src/events/readme.md +22 -0
  37. package/src/events/reporting/ReportingEventTypes.ts +3 -0
  38. package/src/events/reporting/ReportingEvents.ts +28 -0
  39. package/src/events/telemetry/TelemetryEventTypes.ts +10 -0
  40. package/src/events/telemetry/TelemetryEvents.ts +156 -0
  41. package/src/lib/cookies/Cookie.ts +312 -0
  42. package/src/lib/cookies/Cookies.ts +326 -0
  43. package/src/lib/cookies/Utils.ts +168 -0
  44. package/src/lib/headers/Headers.ts +219 -0
  45. package/src/lib/logging/DefaultLogger.ts +19 -0
  46. package/src/lib/logging/DummyLogger.ts +21 -0
  47. package/src/lib/logging/Logger.ts +16 -0
  48. package/src/lib/transformers/PayloadSerializer.ts +332 -0
  49. package/src/lib/transformers/Utils.ts +18 -0
  50. package/src/lib/uuid.ts +40 -0
  51. package/src/mocking/LegacyInterfaces.ts +52 -0
  52. package/src/mocking/LegacyMock.ts +37 -0
  53. package/src/mocking/legacy/Authorization.ts +39 -0
  54. package/src/mocking/legacy/Certificates.ts +145 -0
  55. package/src/mocking/legacy/Cookies.ts +51 -0
  56. package/src/mocking/legacy/HostRules.ts +43 -0
  57. package/src/mocking/legacy/Http.ts +236 -0
  58. package/src/mocking/legacy/HttpResponse.ts +106 -0
  59. package/src/mocking/legacy/RestApi.ts +68 -0
  60. package/src/mocking/legacy/Urls.ts +44 -0
  61. package/src/mocking/legacy/Variables.ts +53 -0
  62. package/src/models/ArcResponse.ts +166 -0
  63. package/src/models/Authorization.ts +481 -0
  64. package/src/models/AuthorizationData.ts +60 -0
  65. package/src/models/Backend.ts +107 -0
  66. package/src/models/ClientCertificate.ts +68 -0
  67. package/src/models/Environment.ts +279 -0
  68. package/src/models/ErrorResponse.ts +101 -0
  69. package/src/models/HistoryIndex.ts +76 -0
  70. package/src/models/HistoryRequest.ts +28 -0
  71. package/src/models/HostRule.ts +163 -0
  72. package/src/models/HttpCookie.ts +285 -0
  73. package/src/models/HttpProject.ts +1294 -0
  74. package/src/models/HttpProjectListItem.ts +23 -0
  75. package/src/models/HttpRequest.ts +124 -0
  76. package/src/models/HttpResponse.ts +143 -0
  77. package/src/models/License.ts +113 -0
  78. package/src/models/ProjectDefinitionProperty.ts +40 -0
  79. package/src/models/ProjectFolder.ts +439 -0
  80. package/src/models/ProjectItem.ts +135 -0
  81. package/src/models/ProjectParent.ts +113 -0
  82. package/src/models/ProjectRequest.ts +277 -0
  83. package/src/models/ProjectSchema.ts +202 -0
  84. package/src/models/Property.ts +423 -0
  85. package/src/models/Provider.ts +98 -0
  86. package/src/models/README.md +20 -0
  87. package/src/models/Request.ts +452 -0
  88. package/src/models/RequestActions.ts +163 -0
  89. package/src/models/RequestAuthorization.ts +115 -0
  90. package/src/models/RequestConfig.ts +317 -0
  91. package/src/models/RequestLog.ts +159 -0
  92. package/src/models/RequestTime.ts +108 -0
  93. package/src/models/RequestUiMeta.ts +258 -0
  94. package/src/models/RequestsSize.ts +65 -0
  95. package/src/models/ResponseAuthorization.ts +104 -0
  96. package/src/models/ResponseRedirect.ts +158 -0
  97. package/src/models/RevisionInfo.ts +37 -0
  98. package/src/models/SentRequest.ts +125 -0
  99. package/src/models/SerializablePayload.ts +68 -0
  100. package/src/models/Server.ts +153 -0
  101. package/src/models/Thing.ts +110 -0
  102. package/src/models/Url.ts +90 -0
  103. package/src/models/User.ts +120 -0
  104. package/src/models/WebApi.ts +234 -0
  105. package/src/models/WebApiIndex.ts +122 -0
  106. package/src/models/Workspace.ts +182 -0
  107. package/src/models/actions/Action.ts +213 -0
  108. package/src/models/actions/ActionView.ts +40 -0
  109. package/src/models/actions/Condition.ts +207 -0
  110. package/src/models/actions/ConditionView.ts +42 -0
  111. package/src/models/actions/Enums.ts +29 -0
  112. package/src/models/actions/RunnableAction.ts +144 -0
  113. package/src/models/actions/runnable/DeleteCookieAction.ts +113 -0
  114. package/src/models/actions/runnable/Runnable.ts +9 -0
  115. package/src/models/actions/runnable/SetCookieAction.ts +216 -0
  116. package/src/models/actions/runnable/SetVariableAction.ts +81 -0
  117. package/src/models/legacy/DataExport.ts +172 -0
  118. package/src/models/legacy/Normalizer.ts +110 -0
  119. package/src/models/legacy/actions/Actions.ts +269 -0
  120. package/src/models/legacy/authorization/Authorization.ts +572 -0
  121. package/src/models/legacy/models/ApiTypes.ts +202 -0
  122. package/src/models/legacy/models/ArcLegacyProject.ts +39 -0
  123. package/src/models/legacy/models/AuthData.ts +17 -0
  124. package/src/models/legacy/models/ClientCertificate.ts +95 -0
  125. package/src/models/legacy/models/Cookies.ts +52 -0
  126. package/src/models/legacy/models/HostRule.ts +35 -0
  127. package/src/models/legacy/models/RestApi.ts +49 -0
  128. package/src/models/legacy/models/UrlHistory.ts +37 -0
  129. package/src/models/legacy/models/Variable.ts +43 -0
  130. package/src/models/legacy/models/base.d.ts +95 -0
  131. package/src/models/legacy/request/ArcRequest.ts +405 -0
  132. package/src/models/legacy/request/ArcResponse.ts +177 -0
  133. package/src/models/legacy/request/HistoryData.ts +47 -0
  134. package/src/models/legacy/request/Legacy.ts +45 -0
  135. package/src/models/legacy/request/RequestBody.ts +87 -0
  136. package/src/models/transformers/ArcDexieTransformer.ts +323 -0
  137. package/src/models/transformers/ArcLegacyNormalizer.ts +85 -0
  138. package/src/models/transformers/ArcLegacyTransformer.ts +200 -0
  139. package/src/models/transformers/ArcPouchTransformer.ts +184 -0
  140. package/src/models/transformers/BaseTransformer.ts +116 -0
  141. package/src/models/transformers/ImportUtils.ts +141 -0
  142. package/src/models/transformers/LegacyDataExportToApiProject.ts +76 -0
  143. package/src/models/transformers/LegacyExportProcessor.ts +252 -0
  144. package/src/models/transformers/PostmanBackupTransformer.ts +306 -0
  145. package/src/models/transformers/PostmanDataTransformer.ts +50 -0
  146. package/src/models/transformers/PostmanTransformer.ts +106 -0
  147. package/src/models/transformers/PostmanV21Transformer.ts +311 -0
  148. package/src/models/transformers/PostmanV2Transformer.ts +308 -0
  149. package/src/models/transformers/har.ts +865 -0
  150. package/src/runtime/actions/ActionRunner.ts +83 -0
  151. package/src/runtime/actions/ConditionRunner.ts +194 -0
  152. package/src/runtime/actions/RunnableCondition.ts +57 -0
  153. package/src/runtime/actions/runnable/ActionRunnable.ts +19 -0
  154. package/src/runtime/actions/runnable/DeleteCookieRunnable.ts +39 -0
  155. package/src/runtime/actions/runnable/SetCookieRunnable.ts +92 -0
  156. package/src/runtime/actions/runnable/SetVariableRunnable.ts +53 -0
  157. package/src/runtime/http-engine/ArcEngine.ts +1064 -0
  158. package/src/runtime/http-engine/Errors.ts +13 -0
  159. package/src/runtime/http-engine/FormData.ts +85 -0
  160. package/src/runtime/http-engine/HttpEngine.ts +874 -0
  161. package/src/runtime/http-engine/HttpErrorCodes.ts +270 -0
  162. package/src/runtime/http-engine/NodeEngine.ts +787 -0
  163. package/src/runtime/http-engine/NodeEngineDirect.ts +476 -0
  164. package/src/runtime/http-engine/PayloadSupport.ts +84 -0
  165. package/src/runtime/http-engine/RequestUtils.ts +164 -0
  166. package/src/runtime/http-engine/ntlm/Des.ts +345 -0
  167. package/src/runtime/http-engine/ntlm/MD4.ts +135 -0
  168. package/src/runtime/http-engine/ntlm/NtlmAuth.ts +186 -0
  169. package/src/runtime/http-engine/ntlm/NtlmMessage.ts +57 -0
  170. package/src/runtime/modules/BasicAuthCache.ts +133 -0
  171. package/src/runtime/modules/ExecutionResponse.ts +4 -0
  172. package/src/runtime/modules/ModulesRegistry.ts +136 -0
  173. package/src/runtime/modules/RequestAuthorization.ts +110 -0
  174. package/src/runtime/modules/RequestCookies.ts +145 -0
  175. package/src/runtime/node/ProjectRunner.ts +275 -0
  176. package/src/runtime/node/RequestFactory.ts +422 -0
  177. package/src/runtime/node/VariablesStore.ts +25 -0
  178. package/src/runtime/store/StoreSdk.ts +838 -0
  179. package/src/runtime/variables/Cache.ts +53 -0
  180. package/src/runtime/variables/EvalFunctions.ts +132 -0
  181. package/src/runtime/variables/ProjectVariables.ts +6 -0
  182. package/src/runtime/variables/VariablesProcessor.ts +543 -0
  183. package/src/runtime/variables/VariablesTokenizer.ts +55 -0
@@ -1,7 +1,7 @@
1
1
  export { ArcResponse, IArcResponse, Kind as ArcResponseKind } from './src/models/ArcResponse.js';
2
2
  export { IAuthorizationSettingsUnion, IApiKeyAuthorization, IAuthorizationParams, IBasicAuthorization, IBearerAuthorization, ICCAuthorization, IDigestAuthorization, INtlmAuthorization, IOAuth1Authorization, IOAuth2Authorization, IOAuth2AuthorizationRequestCustomData, IOAuth2CustomData, IOAuth2CustomParameter, IOAuth2TokenRequestCustomData, IOauth2GrantType, IOauth2ResponseType, IOidcAuthorization, IOidcTokenError, IOidcTokenInfo, IPassThroughAuthorization, IRamlCustomAuthorization, ITokenError, ITokenInfo, ITokenRemoveOptions, OAuth2DeliveryMethod } from './src/models/Authorization.js';
3
3
  export { AuthorizationData, IAuthorizationData } from './src/models/AuthorizationData.js';
4
- export { IBackendInfo, IBackendCommand, IBackendEvent, IListResponse } from './src/models/Backend.js';
4
+ export { IBackendInfo, IBackendCommand, IBackendEvent, IListResponse, IListOptions } from './src/models/Backend.js';
5
5
  export { CertificateType, ICertificate, ICertificateIndex, IClientCertificate, IRequestCertificate } from './src/models/ClientCertificate.js';
6
6
  export { Environment, IEnvironment, Kind as EnvironmentKind } from './src/models/Environment.js';
7
7
  export { ErrorResponse, IErrorResponse } from './src/models/ErrorResponse.js';
package/build/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  export { ArcResponse, IArcResponse, Kind as ArcResponseKind } from './src/models/ArcResponse.js';
2
2
  export { IAuthorizationSettingsUnion, IApiKeyAuthorization, IAuthorizationParams, IBasicAuthorization, IBearerAuthorization, ICCAuthorization, IDigestAuthorization, INtlmAuthorization, IOAuth1Authorization, IOAuth2Authorization, IOAuth2AuthorizationRequestCustomData, IOAuth2CustomData, IOAuth2CustomParameter, IOAuth2TokenRequestCustomData, IOauth2GrantType, IOauth2ResponseType, IOidcAuthorization, IOidcTokenError, IOidcTokenInfo, IPassThroughAuthorization, IRamlCustomAuthorization, ITokenError, ITokenInfo, ITokenRemoveOptions, OAuth2DeliveryMethod } from './src/models/Authorization.js';
3
3
  export { AuthorizationData, IAuthorizationData } from './src/models/AuthorizationData.js';
4
- export { IBackendInfo, IBackendCommand, IBackendEvent, IListResponse } from './src/models/Backend.js';
4
+ export { IBackendInfo, IBackendCommand, IBackendEvent, IListResponse, IListOptions } from './src/models/Backend.js';
5
5
  export { CertificateType, ICertificate, ICertificateIndex, IClientCertificate, IRequestCertificate } from './src/models/ClientCertificate.js';
6
6
  export { Environment, IEnvironment, Kind as EnvironmentKind } from './src/models/Environment.js';
7
7
  export { ErrorResponse, IErrorResponse } from './src/models/ErrorResponse.js';
@@ -62,7 +62,7 @@ export { JmesparthReader } from './src/data/JmesparthReader.js';
62
62
  export { XmlReader } from './src/data/XmlReader.js';
63
63
  export { UrlEncodedReader } from './src/data/UrlEncodedReader.js';
64
64
  export { RequestDataExtractor } from './src/data/RequestDataExtractor.js';
65
- export { StoreSdk } from './src/runtime/store/StoreSdk.js';
65
+ export { StoreSdk, IStoreTokenInfo } from './src/runtime/store/StoreSdk.js';
66
66
  export { Events } from './src/events/Events.js';
67
67
  export { EventTypes } from './src/events/EventTypes.js';
68
68
  export { ProjectMoveEventDetail, ProjectCloneEventDetail, IFolderInitOptions, IRequestInitOptions, IEnvironmentInitOptions, } from './src/events/models/ProjectEvents.js';
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,2DAA2D;AAE3D,EAAE;AACF,SAAS;AACT,EAAE;AACF,OAAO,EAAE,WAAW,EAAgB,IAAI,IAAI,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAEjG,OAAO,EAAE,iBAAiB,EAAsB,MAAM,mCAAmC,CAAC;AAG1F,OAAO,EAAE,WAAW,EAAgB,IAAI,IAAI,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACjG,OAAO,EAAE,aAAa,EAAkB,MAAM,+BAA+B,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAiB,MAAM,8BAA8B,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,IAAI,IAAI,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAC5F,OAAO,EAAa,QAAQ,EAAE,IAAI,IAAI,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACrF,OAAO,EAAe,UAAU,EAA0C,MAAM,4BAA4B,CAAC;AAC7G,OAAO,EAAE,WAAW,EAAgB,IAAI,IAAI,eAAe,EAA2J,MAAM,6BAA6B,CAAC;AAC1P,OAAO,EAAwB,IAAI,IAAI,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC5G,OAAO,EAAgB,WAAW,EAAE,IAAI,IAAI,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACjG,OAAO,EAAE,YAAY,EAAiB,IAAI,IAAI,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AACrG,OAAO,EAAE,OAAO,EAAY,IAAI,IAAI,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACjF,OAAO,EAAkB,aAAa,EAAE,IAAI,IAAI,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAC5H,OAAO,EAAE,WAAW,EAAgB,MAAM,6BAA6B,CAAC;AACxE,OAAO,EAAmB,cAAc,EAAE,IAAI,IAAI,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAC7G,OAAO,EAAE,aAAa,EAAkB,IAAI,IAAI,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACzG,OAAO,EAAE,QAAQ,EAAa,IAAI,IAAI,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACrF,OAAO,EAAE,QAAQ,EAAa,IAAI,IAAI,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACrF,OAAO,EAAE,OAAO,EAAY,IAAI,IAAI,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACjF,OAAO,EAAE,cAAc,EAAmB,MAAM,gCAAgC,CAAC;AACjF,OAAO,EAAE,oBAAoB,EAAyB,IAAI,IAAI,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AACrI,OAAO,EAAE,aAAa,EAAkB,IAAI,IAAI,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACzG,OAAO,EAAE,UAAU,EAAe,IAAI,IAAI,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC7F,OAAO,EAAE,YAAY,EAAiB,IAAI,IAAI,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AACrG,OAAO,EAAE,WAAW,EAAgB,IAAI,IAAI,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACjG,OAAO,EAAE,aAAa,EAAkB,IAAI,IAAI,iBAAiB,EAAyG,MAAM,+BAA+B,CAAC;AAChN,OAAO,EAAE,qBAAqB,EAA0B,IAAI,IAAI,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AACzI,OAAO,EAAE,gBAAgB,EAAqB,IAAI,IAAI,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACrH,OAAO,EAAiB,IAAI,IAAI,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AACvF,OAAO,EAAgB,WAAW,EAAoB,MAAM,6BAA6B,CAAC;AAC1F,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,MAAM,EAAW,IAAI,IAAI,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAC7E,OAAO,EAAE,KAAK,EAAU,IAAI,IAAI,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACzE,OAAO,EAAE,GAAG,EAAQ,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAA0J,IAAI,IAAI,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChN,OAAO,EAAE,MAAM,EAA2B,MAAM,wBAAwB,CAAC;AACzE,OAAO,EAAE,WAAW,EAAoC,MAAM,6BAA6B,CAAC;AAC5F,OAAO,EAA8B,SAAS,EAAE,IAAI,IAAI,aAAa,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEvH,EAAE;AACF,OAAO;AACP,EAAE;AACF,OAAO,EAAE,iBAAiB,EAA8D,MAAM,6CAA6C,CAAC;AAC5I,OAAO,EAAW,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AACvD,OAAO,EAAE,MAAM,EAAiB,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AACvD,OAAO,KAAK,gBAAgB,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEtD,EAAE;AACF,UAAU;AACV,EAAE;AACF,OAAO,EAAE,kBAAkB,EAAE,MAAM,+CAA+C,CAAC;AACnF,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAEtE,GAAG;AACH,cAAc;AACd,GAAG;AACH,OAAO,EAAE,UAAU,EAAsH,MAAM,yCAAyC,CAAC;AACzL,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,MAAM,qCAAqC,CAAC;AAE/D,GAAG;AACH,kBAAkB;AAClB,GAAG;AACH,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAE1E,GAAG;AACH,aAAa;AACb,GAAG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAE3D,GAAG;AACH,SAAS;AACT,GAAG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAQxD,cAAc,4BAA4B,CAAC;AA2B3C,GAAG;AACH,kBAAkB;AAClB,GAAG;AACH,OAAO,EAAE,MAAM,EAAW,IAAI,IAAI,UAAU,EAAE,MAAM,gCAAgC,CAAC;AACrF,OAAO,EAAE,SAAS,EAAc,IAAI,IAAI,aAAa,EAAe,MAAM,mCAAmC,CAAC;AAC9G,OAAO,EAAE,cAAc,EAAmB,IAAI,IAAI,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AACrH,OAAO,KAAK,WAAW,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAa,MAAM,2CAA2C,CAAC;AAChF,OAAO,EAAE,kBAAkB,EAAuB,MAAM,qDAAqD,CAAC;AAC9G,OAAO,EAAoB,eAAe,EAAE,MAAM,kDAAkD,CAAC;AACrG,OAAO,EAAsB,iBAAiB,EAAE,MAAM,oDAAoD,CAAC;AAC3G,OAAO,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AAE/E,GAAG;AACH,kBAAkB;AAClB,GAAG;AACH,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAwF,MAAM,0CAA0C,CAAC;AACrL,OAAO,KAAK,oBAAoB,MAAO,yCAAyC,CAAC;AACjF,OAAO,KAAK,0BAA0B,MAAO,+CAA+C,CAAC;AAC7F,GAAG;AACH,0BAA0B;AAC1B,GAAG;AACH,OAAO,EAAE,4BAA4B,EAAE,MAAM,2DAA2D,CAAC;AACzG,OAAO,EAAE,sBAAsB,EAAE,MAAM,qDAAqD,CAAC;AAC7F,OAAO,EAAE,mBAAmB,EAAE,MAAM,kDAAkD,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,2DAA2D;AAE3D,EAAE;AACF,SAAS;AACT,EAAE;AACF,OAAO,EAAE,WAAW,EAAgB,IAAI,IAAI,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAEjG,OAAO,EAAE,iBAAiB,EAAsB,MAAM,mCAAmC,CAAC;AAG1F,OAAO,EAAE,WAAW,EAAgB,IAAI,IAAI,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACjG,OAAO,EAAE,aAAa,EAAkB,MAAM,+BAA+B,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAiB,MAAM,8BAA8B,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,IAAI,IAAI,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAC5F,OAAO,EAAa,QAAQ,EAAE,IAAI,IAAI,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACrF,OAAO,EAAe,UAAU,EAA0C,MAAM,4BAA4B,CAAC;AAC7G,OAAO,EAAE,WAAW,EAAgB,IAAI,IAAI,eAAe,EAA2J,MAAM,6BAA6B,CAAC;AAC1P,OAAO,EAAwB,IAAI,IAAI,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC5G,OAAO,EAAgB,WAAW,EAAE,IAAI,IAAI,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACjG,OAAO,EAAE,YAAY,EAAiB,IAAI,IAAI,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AACrG,OAAO,EAAE,OAAO,EAAY,IAAI,IAAI,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACjF,OAAO,EAAkB,aAAa,EAAE,IAAI,IAAI,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAC5H,OAAO,EAAE,WAAW,EAAgB,MAAM,6BAA6B,CAAC;AACxE,OAAO,EAAmB,cAAc,EAAE,IAAI,IAAI,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAC7G,OAAO,EAAE,aAAa,EAAkB,IAAI,IAAI,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACzG,OAAO,EAAE,QAAQ,EAAa,IAAI,IAAI,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACrF,OAAO,EAAE,QAAQ,EAAa,IAAI,IAAI,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACrF,OAAO,EAAE,OAAO,EAAY,IAAI,IAAI,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACjF,OAAO,EAAE,cAAc,EAAmB,MAAM,gCAAgC,CAAC;AACjF,OAAO,EAAE,oBAAoB,EAAyB,IAAI,IAAI,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AACrI,OAAO,EAAE,aAAa,EAAkB,IAAI,IAAI,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACzG,OAAO,EAAE,UAAU,EAAe,IAAI,IAAI,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC7F,OAAO,EAAE,YAAY,EAAiB,IAAI,IAAI,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AACrG,OAAO,EAAE,WAAW,EAAgB,IAAI,IAAI,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACjG,OAAO,EAAE,aAAa,EAAkB,IAAI,IAAI,iBAAiB,EAAyG,MAAM,+BAA+B,CAAC;AAChN,OAAO,EAAE,qBAAqB,EAA0B,IAAI,IAAI,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AACzI,OAAO,EAAE,gBAAgB,EAAqB,IAAI,IAAI,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACrH,OAAO,EAAiB,IAAI,IAAI,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AACvF,OAAO,EAAgB,WAAW,EAAoB,MAAM,6BAA6B,CAAC;AAC1F,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,MAAM,EAAW,IAAI,IAAI,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAC7E,OAAO,EAAE,KAAK,EAAU,IAAI,IAAI,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACzE,OAAO,EAAE,GAAG,EAAQ,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAA0J,IAAI,IAAI,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChN,OAAO,EAAE,MAAM,EAA2B,MAAM,wBAAwB,CAAC;AACzE,OAAO,EAAE,WAAW,EAAoC,MAAM,6BAA6B,CAAC;AAC5F,OAAO,EAA8B,SAAS,EAAE,IAAI,IAAI,aAAa,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEvH,EAAE;AACF,OAAO;AACP,EAAE;AACF,OAAO,EAAE,iBAAiB,EAA8D,MAAM,6CAA6C,CAAC;AAC5I,OAAO,EAAW,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AACvD,OAAO,EAAE,MAAM,EAAiB,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AACvD,OAAO,KAAK,gBAAgB,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEtD,EAAE;AACF,UAAU;AACV,EAAE;AACF,OAAO,EAAE,kBAAkB,EAAE,MAAM,+CAA+C,CAAC;AACnF,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAEtE,GAAG;AACH,cAAc;AACd,GAAG;AACH,OAAO,EAAE,UAAU,EAAsH,MAAM,yCAAyC,CAAC;AACzL,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,MAAM,qCAAqC,CAAC;AAE/D,GAAG;AACH,kBAAkB;AAClB,GAAG;AACH,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAE1E,GAAG;AACH,aAAa;AACb,GAAG;AACH,OAAO,EAAE,QAAQ,EAAmB,MAAM,iCAAiC,CAAC;AAE5E,GAAG;AACH,SAAS;AACT,GAAG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAQxD,cAAc,4BAA4B,CAAC;AA2B3C,GAAG;AACH,kBAAkB;AAClB,GAAG;AACH,OAAO,EAAE,MAAM,EAAW,IAAI,IAAI,UAAU,EAAE,MAAM,gCAAgC,CAAC;AACrF,OAAO,EAAE,SAAS,EAAc,IAAI,IAAI,aAAa,EAAe,MAAM,mCAAmC,CAAC;AAC9G,OAAO,EAAE,cAAc,EAAmB,IAAI,IAAI,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AACrH,OAAO,KAAK,WAAW,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAa,MAAM,2CAA2C,CAAC;AAChF,OAAO,EAAE,kBAAkB,EAAuB,MAAM,qDAAqD,CAAC;AAC9G,OAAO,EAAoB,eAAe,EAAE,MAAM,kDAAkD,CAAC;AACrG,OAAO,EAAsB,iBAAiB,EAAE,MAAM,oDAAoD,CAAC;AAC3G,OAAO,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AAE/E,GAAG;AACH,kBAAkB;AAClB,GAAG;AACH,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAwF,MAAM,0CAA0C,CAAC;AACrL,OAAO,KAAK,oBAAoB,MAAO,yCAAyC,CAAC;AACjF,OAAO,KAAK,0BAA0B,MAAO,+CAA+C,CAAC;AAC7F,GAAG;AACH,0BAA0B;AAC1B,GAAG;AACH,OAAO,EAAE,4BAA4B,EAAE,MAAM,2DAA2D,CAAC;AACzG,OAAO,EAAE,sBAAsB,EAAE,MAAM,qDAAqD,CAAC;AAC7F,OAAO,EAAE,mBAAmB,EAAE,MAAM,kDAAkD,CAAC"}
@@ -77,3 +77,25 @@ export interface IListResponse {
77
77
  */
78
78
  data: unknown[];
79
79
  }
80
+ export interface IListOptions {
81
+ /**
82
+ * Page cursor to use with the query.
83
+ */
84
+ cursor?: string;
85
+ /**
86
+ * Number of items in the result.
87
+ * Ignored when `cursor` is set.
88
+ *
89
+ * Note, when changing the number of items in the result
90
+ * you need to start listing over again.
91
+ */
92
+ limit?: number;
93
+ /**
94
+ * Supported by some endpoints. When set it performs a query on the data store.
95
+ */
96
+ query?: string;
97
+ /**
98
+ * Only with the `query` property. Tells the system in which fields to search for the query term.
99
+ */
100
+ queryField?: string[];
101
+ }
@@ -1,7 +1,12 @@
1
1
  /// <reference types="node" />
2
2
  import http from 'http';
3
3
  import WebSocket from 'ws';
4
- import { IBackendInfo } from '../../models/Backend.js';
4
+ import { URL } from 'url';
5
+ import { JsonPatch } from 'json8-patch';
6
+ import { IBackendInfo, IListOptions, IListResponse } from '../../models/Backend.js';
7
+ import { IWorkspace, IUserWorkspace, Workspace } from '../../models/Workspace.js';
8
+ import { UserAccessOperation, IUser } from '../../models/User.js';
9
+ import { HttpProject, IHttpProject } from '../../models/HttpProject.js';
5
10
  export interface IStoreRequestOptions {
6
11
  method?: 'GET' | 'POST' | 'PATCH' | 'DELETE';
7
12
  headers?: Record<string, string>;
@@ -16,36 +21,166 @@ export interface IStoreResponse {
16
21
  headers: http.IncomingHttpHeaders;
17
22
  body?: string;
18
23
  }
24
+ export interface IStoreTokenInfo {
25
+ /**
26
+ * The token to use.
27
+ */
28
+ token: string;
29
+ /**
30
+ * The timestamp when the token expires.
31
+ * Note, clients may have a different date than the store.
32
+ *
33
+ * May not be set when the token does not expire.
34
+ */
35
+ expires?: number;
36
+ }
37
+ declare const baseUriSymbol: unique symbol;
19
38
  /**
20
39
  * NodeJS API for API Client's net-store module.
21
40
  */
22
41
  export declare class StoreSdk {
23
- baseUri: string;
24
42
  basePath?: string | undefined;
25
43
  /**
26
44
  * The token to use with requests. Can be overwritten with each API call.
27
45
  */
28
46
  token?: string;
47
+ /**
48
+ * The user authentication features.
49
+ */
50
+ auth: AuthSdk;
51
+ /**
52
+ * The store information features
53
+ */
54
+ store: BackendSdk;
55
+ /**
56
+ * The user spaces features.
57
+ */
58
+ space: SpacesSdk;
59
+ /**
60
+ * The user projects features.
61
+ */
62
+ project: ProjectsSdk;
63
+ /**
64
+ * Reads user information.
65
+ */
66
+ user: UsersSdk;
67
+ /**
68
+ * The HTTP(S) requests.
69
+ */
70
+ http: HttpClient;
71
+ /**
72
+ * The web socket requests.
73
+ */
74
+ ws: WsClient;
75
+ [baseUriSymbol]: string;
76
+ /**
77
+ * @returns The base URI to the store.
78
+ */
79
+ get baseUri(): string;
80
+ /**
81
+ * @param value The base URI to the store.
82
+ */
83
+ set baseUri(value: string);
29
84
  /**
30
85
  * @param baseUri The base URI to the store.
31
86
  * @param basePath The base path (the router prefix) for the server.
32
87
  */
33
88
  constructor(baseUri: string, basePath?: string | undefined);
34
89
  /**
35
- * @returns Client information about the store configuration.
90
+ * Creates a full URL for a path.
91
+ * This adds the server's base path and the passed path to the configured base URL.
92
+ * @param path The path to the endpoint, without the base path.
36
93
  */
37
- getInfo(): Promise<IBackendInfo>;
94
+ getUrl(path?: string): URL;
95
+ /**
96
+ * Appends list options to the query parameters.
97
+ * @param url The URL object to the API endpoint
98
+ * @param options The list options, if any
99
+ */
100
+ appendListOptions(url: URL, options?: IListOptions): void;
101
+ }
102
+ declare class SdkBase {
103
+ sdk: StoreSdk;
104
+ constructor(sdk: StoreSdk);
105
+ protected logInvalidResponse(response: IStoreResponse): void;
106
+ /**
107
+ * Throws unified message for a common error status codes.
108
+ * It handles 404, 403, and 401 status codes.
109
+ */
110
+ protected inspectCommonStatusCodes(status: number): void;
111
+ }
112
+ declare class AuthSdk extends SdkBase {
113
+ protected getExpires(headers: http.IncomingHttpHeaders): number | undefined;
38
114
  /**
39
115
  * Creates unauthenticated session in the backend.
40
116
  * @returns The JWT for unauthenticated user.
41
117
  */
42
- createSession(): Promise<string>;
118
+ createSession(): Promise<IStoreTokenInfo>;
43
119
  /**
44
120
  * Initializes the authentication session.
45
121
  * @param token The unauthenticated session JWT. Required when not set on the class.
46
122
  * @returns The location of the authorization endpoint.
47
123
  */
48
124
  createAuthSession(token?: string, loginPath?: string): Promise<string>;
125
+ /**
126
+ * Listens to the first message coming to the client from the auth endpoint.
127
+ * @param authPath The authorization path returned by the server info or 401 response.
128
+ * @param token Optional token to use.
129
+ */
130
+ listenAuth(authPath: string, token?: string): Promise<void>;
131
+ /**
132
+ * Renews authenticated token to a new one when the token expires.
133
+ * @param token Optional token to use.
134
+ * @returns
135
+ */
136
+ renewToken(token?: string | undefined): Promise<IStoreTokenInfo>;
137
+ }
138
+ declare class BackendSdk extends SdkBase {
139
+ /**
140
+ * @returns Client information about the store configuration.
141
+ */
142
+ getInfo(): Promise<IBackendInfo>;
143
+ }
144
+ declare class SpacesSdk extends SdkBase {
145
+ /**
146
+ * Lists spaces in the store.
147
+ * @param options Optional query options.
148
+ */
149
+ list(options?: IListOptions): Promise<IListResponse>;
150
+ /**
151
+ * Creates a workspace in the store.
152
+ * @param space The workspace definition.
153
+ * @returns The key of the creates space.
154
+ */
155
+ create(space: IWorkspace | Workspace): Promise<string>;
156
+ /**
157
+ * Reads a user space definition from the store.
158
+ * @param key The user space key
159
+ * @returns The definition of the user space.
160
+ */
161
+ read(key: string): Promise<IUserWorkspace>;
162
+ /**
163
+ * Patches a user space in the store.
164
+ * @param key The key of the user space to patch
165
+ * @param value The JSON patch to be processed.
166
+ * @returns The JSON patch to revert the change using the `json8-patch` library
167
+ */
168
+ patch(key: string, value: JsonPatch): Promise<JsonPatch>;
169
+ /**
170
+ * Deletes the space in the store.
171
+ *
172
+ * @param key The key of the space to delete.
173
+ */
174
+ delete(key: string): Promise<void>;
175
+ /**
176
+ * Updates the sharing options of the space.
177
+ *
178
+ * @param key The user space key
179
+ * @param value The patch operation on the space's ACL
180
+ */
181
+ patchUsers(key: string, value: UserAccessOperation[]): Promise<void>;
182
+ }
183
+ declare class HttpClient extends SdkBase {
49
184
  /**
50
185
  * Performs the GET request.
51
186
  *
@@ -58,18 +193,14 @@ export declare class StoreSdk {
58
193
  post(url: string, opts?: IStoreRequestOptions): Promise<IStoreResponse>;
59
194
  patch(url: string, opts?: IStoreRequestOptions): Promise<IStoreResponse>;
60
195
  delete(url: string, opts?: IStoreRequestOptions): Promise<IStoreResponse>;
61
- /**
62
- * Listens to the first message coming to the client from the auth endpoint.
63
- * @param authPath The authorization path returned by the server info or 401 response.
64
- * @param token Optional token to use.
65
- */
66
- listenAuth(authPath: string, token?: string): Promise<void>;
196
+ }
197
+ declare class WsClient extends SdkBase {
67
198
  /**
68
199
  * Creates a WS client with optional token
69
200
  * @param addr The ws:// address
70
201
  * @param token Optional token to add.
71
202
  */
72
- getWsClient(addr: string, token?: string | undefined): WebSocket;
203
+ getClient(addr: string, token?: string | undefined): WebSocket;
73
204
  /**
74
205
  * Connect to the WS server
75
206
  *
@@ -85,3 +216,52 @@ export declare class StoreSdk {
85
216
  */
86
217
  createAndConnect(addr: string, token?: string): Promise<WebSocket>;
87
218
  }
219
+ declare class ProjectsSdk extends SdkBase {
220
+ /**
221
+ * Creates a project in a user space.
222
+ *
223
+ * @param key The user space key
224
+ * @param project THe project to create
225
+ * @returns The key of the created project.
226
+ */
227
+ create(key: string, project: IHttpProject | HttpProject): Promise<string>;
228
+ /**
229
+ * Reads a project definition from the store.
230
+ * @param space The user space key
231
+ * @param project The project key
232
+ * @returns The definition of the project.
233
+ */
234
+ read(space: string, project: string): Promise<IHttpProject>;
235
+ /**
236
+ * Lists projects in the space
237
+ *
238
+ * @param space The user space key
239
+ * @param options Optional query options.
240
+ */
241
+ list(space: string, options?: IListOptions): Promise<IListResponse>;
242
+ /**
243
+ * Deletes a project form the store.
244
+ *
245
+ * @param space The key of the parent space.
246
+ * @param project The key of the project to delete.
247
+ */
248
+ delete(space: string, project: string): Promise<void>;
249
+ /**
250
+ * Patches a project in the store.
251
+ * @param space The key of the parent user space
252
+ * @param project The key of project to patch.
253
+ * @param value The JSON patch to be processed.
254
+ * @returns The JSON patch to revert the change using the `json8-patch` library
255
+ */
256
+ patch(space: string, project: string, value: JsonPatch): Promise<JsonPatch>;
257
+ }
258
+ declare class UsersSdk extends SdkBase {
259
+ me(): Promise<IUser>;
260
+ /**
261
+ * Lists users in the store
262
+ *
263
+ * @param options Optional query options.
264
+ */
265
+ list(options?: IListOptions): Promise<IListResponse>;
266
+ }
267
+ export {};