@api-client/core 0.18.41 → 0.18.47

package/data/models/example-generator-api.json

@@ -42065,13 +42065,13 @@
 "@id": "#191"
 },
 {
-"@id": "#197"
+"@id": "#200"
 },
 {
 "@id": "#194"
 },
 {
-"@id": "#200"
+"@id": "#197"
 },
 {
 "@id": "#203"
@@ -42813,10 +42813,10 @@
 "@id": "#210"
 },
 {
-"@id": "#216"
+"@id": "#213"
 },
 {
-"@id": "#213"
+"@id": "#216"
 },
 {
 "@id": "#219"
@@ -43478,7 +43478,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "addressType: 'REGISTERED-OFFICE-ADDRESS'\nstreetName: 'UITBREIDINGSTRAAT'\nhouseNumber: '84'\nhouseNumberAddition: '/1'\npostalCode: '2600'\ncity: 'BERCHEM (ANTWERPEN)'\ncountry: 'Belgium'\ncountryCode: 'BE'\nfullFormatedAddress: \"UITBREIDINGSTRAAT 84 /1, 2600 BERCHEM (ANTWERPEN), BELIUM\"\n",
+"doc:raw": "class: '3'\ndescription: '150 - 300'\nnumberOfFte: 5500\nnumberOfEmployees: 5232\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43499,7 +43499,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "class: '3'\ndescription: '150 - 300'\nnumberOfFte: 5500\nnumberOfEmployees: 5232\n",
+"doc:raw": "addressType: 'REGISTERED-OFFICE-ADDRESS'\nstreetName: 'UITBREIDINGSTRAAT'\nhouseNumber: '84'\nhouseNumberAddition: '/1'\npostalCode: '2600'\ncity: 'BERCHEM (ANTWERPEN)'\ncountry: 'Belgium'\ncountryCode: 'BE'\nfullFormatedAddress: \"UITBREIDINGSTRAAT 84 /1, 2600 BERCHEM (ANTWERPEN), BELIUM\"\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44253,7 +44253,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
+"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '21'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)21 302099'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44274,7 +44274,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '21'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)21 302099'\n",
+"doc:raw": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44766,12 +44766,12 @@
 {
 "@id": "#199/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#199",
-"sourcemaps:value": "[(1,0)-(10,0)]"
+"sourcemaps:value": "[(1,0)-(5,0)]"
 },
 {
 "@id": "#202/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#202",
-"sourcemaps:value": "[(1,0)-(5,0)]"
+"sourcemaps:value": "[(1,0)-(10,0)]"
 },
 {
 "@id": "#205/source-map/lexical/element_0",
@@ -45121,12 +45121,12 @@
 {
 "@id": "#215/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#215",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(6,0)]"
 },
 {
 "@id": "#218/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#218",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(7,0)]"
 },
 {
 "@id": "#221/source-map/lexical/element_0",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.18.41",
+  "version": "0.18.47",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {

package/src/mocking/ModelingMock.ts

@@ -12,8 +12,8 @@ export class ModelingMock {
   faker: Faker = faker
   organization = new Organization()
   group = new Group()
-  user = new User()
-  file = new File()
+  users = new User()
+  files = new File()
   invitation = new Invitation()
   trash = new Trash()
   patch = new Patch()

package/src/sdk/FilesSdk.ts

@@ -568,7 +568,7 @@ export class FilesSdk extends SdkBase {
     const url = this.sdk.getUrl(RouteBuilder.fileBreadcrumbs(organization, key))
     const result = await this.sdk.http.get(url.toString(), { token })
     this.inspectCommonStatusCodes(result)
-    const E_PREFIX = 'Unable to read a file. '
+    const E_PREFIX = 'Unable to read breadcrumbs. '
     if (result.status !== 200) {
       this.logInvalidResponse(result)
       throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)

package/src/sdk/Sdk.ts

@@ -38,13 +38,21 @@ export abstract class Sdk {
    */
   auth = new AuthSdk(this)
   /**
-   * The user organizations features.
+   * The user files features.
    */
-  file = new FilesSdk(this)
+  files = new FilesSdk(this)
   /**
-   * Reads user information.
+   * @deprecated Use `files` instead.
    */
-  user = new UsersSdk(this)
+  file = this.files
+  /**
+   * User management features.
+   */
+  users = new UsersSdk(this)
+  /**
+   * @deprecated Use `users` instead.
+   */
+  user = this.users
   /**
    * The HTTP(S) requests.
    */

package/src/sdk/SdkMock.ts

@@ -450,7 +450,7 @@ export class SdkMock {
         //   status: 200,
         //   headers: { 'content-type': 'application/json' },
         //   body: JSON.stringify({
-        //     items: this.gen.user.users(init?.size ?? 5),
+        //     items: this.gen.users.users(init?.size ?? 5),
         //     cursor: this.createCursorOption(init),
         //   } as ContextListResult<IUser>),
         // }
@@ -459,7 +459,7 @@ export class SdkMock {
           { 'content-type': 'application/json' },
           () => {
             const obj: ContextListResult<IUser> = {
-              items: this.gen.user.users(init?.size ?? 5),
+              items: this.gen.users.users(init?.size ?? 5),
               cursor: this.createCursorOption(init),
             }
             return JSON.stringify(obj)
@@ -482,12 +482,12 @@ export class SdkMock {
         // const respond = init?.response ?? {
         //   status: 200,
         //   headers: { 'content-type': 'application/json' },
-        //   body: JSON.stringify(this.gen.user.user()),
+        //   body: JSON.stringify(this.gen.users.user()),
         // }
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => JSON.stringify(this.gen.user.user()),
+          () => JSON.stringify(this.gen.users.user()),
           init
         )
         await mock.add(
@@ -508,7 +508,7 @@ export class SdkMock {
           status: 200,
           headers: { 'content-type': 'application/json' },
           body: JSON.stringify({
-            items: this.gen.user.users(init?.size ?? 5),
+            items: this.gen.users.users(init?.size ?? 5),
             cursor: this.createCursorOption(init),
           } as ContextListResult<IUser>),
         }
@@ -528,12 +528,12 @@ export class SdkMock {
         // const respond = init?.response ?? {
         //   status: 200,
         //   headers: { 'content-type': 'application/json' },
-        //   body: JSON.stringify(this.gen.user.user()),
+        //   body: JSON.stringify(this.gen.users.user()),
         // }
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => JSON.stringify(this.gen.user.user()),
+          () => JSON.stringify(this.gen.users.user()),
           init
         )
         await mock.add(
@@ -552,12 +552,12 @@ export class SdkMock {
         // const respond = init?.response ?? {
         //   status: 200,
         //   headers: { 'content-type': 'application/json' },
-        //   body: JSON.stringify(this.gen.user.user()),
+        //   body: JSON.stringify(this.gen.users.user()),
         // }
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => JSON.stringify(this.gen.user.user()),
+          () => JSON.stringify(this.gen.users.user()),
           init
         )
         await mock.add(
@@ -783,12 +783,12 @@ export class SdkMock {
       // const respond = init?.response ?? {
       //   status: 200,
       //   headers: { 'content-type': 'application/json' },
-      //   body: JSON.stringify(this.gen.user.user()),
+      //   body: JSON.stringify(this.gen.users.user()),
       // }
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => JSON.stringify(this.gen.user.user()),
+        () => JSON.stringify(this.gen.users.user()),
         init
       )
       await mock.add(
@@ -807,7 +807,7 @@ export class SdkMock {
   /**
    * Files API mocks.
    */
-  file = {
+  files = {
     /**
      * Mocks the `file.list()` method.
      */
@@ -817,7 +817,7 @@ export class SdkMock {
       //   status: 200,
       //   headers: { 'content-type': 'application/json' },
       //   body: JSON.stringify({
-      //     items: this.gen.file.files(init?.size ?? 5),
+      //     items: this.gen.files.files(init?.size ?? 5),
       //     cursor: this.createCursorOption(init),
       //   } as ContextListResult<IFile>),
       // }
@@ -826,7 +826,7 @@ export class SdkMock {
         { 'content-type': 'application/json' },
         () => {
           const obj: ContextListResult<IFile> = {
-            items: this.gen.file.files(init?.size ?? 5),
+            items: this.gen.files.files(init?.size ?? 5),
             cursor: this.createCursorOption(init),
           }
           return JSON.stringify(obj)
@@ -853,12 +853,12 @@ export class SdkMock {
       // const respond = init?.response ?? {
       //   status: 201,
       //   headers: { 'content-type': 'application/json' },
-      //   body: JSON.stringify(this.gen.file.file()),
+      //   body: JSON.stringify(this.gen.files.file()),
       // }
       const respond = this.createDefaultResponse(
         201,
         { 'content-type': 'application/json' },
-        () => JSON.stringify(this.gen.file.file()),
+        () => JSON.stringify(this.gen.files.file()),
         init
       )
       await mock.add(
@@ -898,11 +898,11 @@ export class SdkMock {
      * Mocks the `file.create()` method.
      */
     create: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
-      await this.file.createMeta(init, options)
+      await this.files.createMeta(init, options)
       // When SDK's file.create() is called, it responds with
       // what the result of file.createMeta() would be.
       // Because of that, we don't need to configure the media request.
-      await this.file.createMedia(undefined, options)
+      await this.files.createMedia(undefined, options)
     },
 
     /**
@@ -913,12 +913,12 @@ export class SdkMock {
       // const respond = init?.response ?? {
       //   status: 201,
       //   headers: { 'content-type': 'application/json' },
-      //   body: JSON.stringify(this.gen.file.folder()),
+      //   body: JSON.stringify(this.gen.files.folder()),
       // }
       const respond = this.createDefaultResponse(
         201,
         { 'content-type': 'application/json' },
-        () => JSON.stringify(this.gen.file.folder()),
+        () => JSON.stringify(this.gen.files.folder()),
         init
       )
       await mock.add(
@@ -941,12 +941,12 @@ export class SdkMock {
       // const respond = init?.response ?? {
       //   status: 200,
       //   headers: { 'content-type': 'application/json' },
-      //   body: JSON.stringify(this.gen.file.file()),
+      //   body: JSON.stringify(this.gen.files.file()),
       // }
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => JSON.stringify(this.gen.file.file()),
+        () => JSON.stringify(this.gen.files.file()),
         init
       )
       await mock.add(
@@ -1004,7 +1004,7 @@ export class SdkMock {
       //   status: 200,
       //   headers: { 'content-type': 'application/json' },
       //   body: JSON.stringify({
-      //     items: this.gen.file.files(init?.size ?? 5),
+      //     items: this.gen.files.files(init?.size ?? 5),
       //   } as IBulkOperationResult<IFile>),
       // }
       const respond = this.createDefaultResponse(
@@ -1012,7 +1012,7 @@ export class SdkMock {
         { 'content-type': 'application/json' },
         () => {
           const obj: IBulkOperationResult<IFile> = {
-            items: this.gen.file.files(init?.size ?? 5),
+            items: this.gen.files.files(init?.size ?? 5),
           }
           return JSON.stringify(obj)
         },
@@ -1038,12 +1038,12 @@ export class SdkMock {
       // const respond = init?.response ?? {
       //   status: 200,
       //   headers: { 'content-type': 'application/json' },
-      //   body: JSON.stringify(this.gen.file.file()),
+      //   body: JSON.stringify(this.gen.files.file()),
       // }
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => JSON.stringify(this.gen.file.file()),
+        () => JSON.stringify(this.gen.files.file()),
         init
       )
       await mock.add(
@@ -1136,12 +1136,12 @@ export class SdkMock {
       // const respond = init?.response ?? {
       //   status: 200,
       //   headers: { 'content-type': 'application/json' },
-      //   body: JSON.stringify(this.gen.file.file()),
+      //   body: JSON.stringify(this.gen.files.file()),
       // }
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => JSON.stringify(this.gen.file.file()),
+        () => JSON.stringify(this.gen.files.file()),
         init
       )
       await mock.add(
@@ -1160,14 +1160,14 @@ export class SdkMock {
      * Mocks the `file.addUser()` method.
      */
     addUser: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
-      await this.file.patchUsers(init, options)
+      await this.files.patchUsers(init, options)
     },
 
     /**
      * Mocks the `file.removeUser()` method.
      */
     removeUser: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
-      await this.file.patchUsers(init, options)
+      await this.files.patchUsers(init, options)
     },
 
     /**
@@ -1179,7 +1179,7 @@ export class SdkMock {
       //   status: 200,
       //   headers: { 'content-type': 'application/json' },
       //   body: JSON.stringify({
-      //     items: this.gen.user.users(init?.size ?? 5),
+      //     items: this.gen.users.users(init?.size ?? 5),
       //     cursor: this.createCursorOption(init),
       //   } as ContextListResult<IUser>),
       // }
@@ -1188,7 +1188,7 @@ export class SdkMock {
         { 'content-type': 'application/json' },
         () => {
           const obj: ContextListResult<IUser> = {
-            items: this.gen.user.users(init?.size ?? 5),
+            items: this.gen.users.users(init?.size ?? 5),
             cursor: this.createCursorOption(init),
           }
           return JSON.stringify(obj)
@@ -1216,7 +1216,7 @@ export class SdkMock {
       //   status: 200,
       //   headers: { 'content-type': 'application/json' },
       //   body: JSON.stringify({
-      //     items: this.gen.file.fileBreadcrumbs(init?.size ?? 5),
+      //     items: this.gen.files.fileBreadcrumbs(init?.size ?? 5),
       //     cursor: this.createCursorOption(init),
       //   } as ContextListResult<FileBreadcrumb>),
       // }
@@ -1225,7 +1225,7 @@ export class SdkMock {
         { 'content-type': 'application/json' },
         () => {
           const obj: ContextListResult<FileBreadcrumb> = {
-            items: this.gen.file.fileBreadcrumbs(init?.size ?? 5),
+            items: this.gen.files.fileBreadcrumbs(init?.size ?? 5),
             cursor: this.createCursorOption(init),
           }
           return JSON.stringify(obj)
@@ -1245,6 +1245,11 @@ export class SdkMock {
     },
   }
 
+  /**
+   * @deprecated Use `files` instead.
+   */
+  file = this.files
+
   /**
    * Shared API mocks.
    */
@@ -1255,7 +1260,7 @@ export class SdkMock {
       //   status: 200,
       //   headers: { 'content-type': 'application/json' },
       //   body: JSON.stringify({
-      //     items: this.gen.file.files(init?.size ?? 5),
+      //     items: this.gen.files.files(init?.size ?? 5),
       //     cursor: this.createCursorOption(init),
       //   } as ContextListResult<IFile>),
       // }
@@ -1264,7 +1269,7 @@ export class SdkMock {
         { 'content-type': 'application/json' },
         () => {
           const obj: ContextListResult<IFile> = {
-            items: this.gen.file.files(init?.size ?? 5),
+            items: this.gen.files.files(init?.size ?? 5),
             cursor: this.createCursorOption(init),
           }
           return JSON.stringify(obj)

package/src/sdk/SharedSdk.ts

@@ -29,7 +29,7 @@ export class SharedSdk extends SdkBase {
     this.sdk.appendListOptions(url, options)
     const result = await this.sdk.http.get(url.toString(), { token })
     this.inspectCommonStatusCodes(result)
-    const E_PREFIX = 'Unable to list organizations. '
+    const E_PREFIX = 'Unable to list shared files. '
     if (result.status !== 200) {
       this.logInvalidResponse(result)
       throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)

package/build/oauth-popup.html

@@ -1,33 +0,0 @@
-<!doctype html>
-<html>
-  <head>
-    <meta charset="utf-8" />
-    <title>Oauth2 callback window</title>
-    <style>
-      *[hidden] {
-        display: none;
-      }
-    </style>
-  </head>
-  <body>
-    <h1>Sending the authorization data to the application</h1>
-    <p id="general-error" hidden>
-      The window wasn't opened as a popup and therefore it can't pass the authorization information.<br />
-      This is an error.
-    </p>
-    <script>
-      const messageTarget = window.opener || window.parent || window.top
-      if (!messageTarget || messageTarget === window || !messageTarget.postMessage) {
-        const elm = document.getElementById('general-error')
-        elm.removeAttribute('hidden')
-      } else {
-        const search = window.location.search.substr(1)
-        if (search) {
-          messageTarget.postMessage(search, '*')
-        } else {
-          messageTarget.postMessage(window.location.hash.substr(1), '*')
-        }
-      }
-    </script>
-  </body>
-</html>