@api-client/core 0.13.3 → 0.13.5

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

@@ -42470,16 +42470,16 @@
 "@id": "#219"
 },
 {
-"@id": "#210"
+"@id": "#216"
 },
 {
-"@id": "#219"
+"@id": "#210"
 },
 {
 "@id": "#213"
 },
 {
-"@id": "#216"
+"@id": "#219"
 }
 ],
 "doc:root": false,
@@ -43892,7 +43892,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\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": [
 {
@@ -43934,7 +43934,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: \"GENERAL\"\nvalue: \"www.company.be\"\n",
+"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43955,7 +43955,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": "type: \"GENERAL\"\nvalue: \"www.company.be\"\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44786,12 +44786,12 @@
 {
 "@id": "#218/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#218",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(6,0)]"
 },
 {
 "@id": "#221/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#221",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#338/source-map/synthesized-field/element_1",

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.13.3",
+  "version": "0.13.5",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {

package/src/models/store/Backend.ts

@@ -201,6 +201,14 @@ export interface ServerPatchEvent extends ServerEvent {
    * The id of the user who patched the document.
    */
   uid: string
+  /**
+   * For files, the old version of the object before the patch.
+   */
+  version?: number
+  /**
+   * For files, the new version of the object after the patch.
+   */
+  newVersion?: number
 }
 
 /**

package/src/sdk/FilesSdk.ts

@@ -7,16 +7,11 @@ import {
   SdkOptions,
 } from './SdkBase.js'
 import { RouteBuilder } from './RouteBuilder.js'
-import { IUser } from '../models/store/User.js'
-import { FileBreadcrumb, IFile } from '../models/store/File.js'
+import type { IUser } from '../models/store/User.js'
+import type { FileBreadcrumb, IFile } from '../models/store/File.js'
 import { FolderKind, CertificateFileKind, ProjectKind, DomainFileKind } from '../models/kinds.js'
-import {
-  ContextListResult,
-  ContextChangeRecord,
-  IBulkOperationResult,
-  ContextListOptions,
-} from '../events/BaseEvents.js'
-import { IAccessAddOperation, IAccessRemoveOperation, PermissionRole } from '../models/store/Permission.js'
+import type { ContextListResult, IBulkOperationResult, ContextListOptions } from '../events/BaseEvents.js'
+import type { IAccessAddOperation, IAccessRemoveOperation, PermissionRole } from '../models/store/Permission.js'
 import { nanoid } from 'nanoid'
 import { Folder, type IFolder } from '../models/Folder.js'
 import type { AccessPatchInfo, MediaPatchInfo, MediaPatchRevision, PatchInfo } from '../patch/types.js'
@@ -104,7 +99,7 @@ export class FilesSdk extends SdkBase {
     organization: string,
     opts: IFileCreateOptions = {},
     request: SdkOptions = {}
-  ): Promise<ContextChangeRecord<IFile>> {
+  ): Promise<IFile> {
     const result = await this.createMeta(meta, organization, opts, request)
     await this.createMedia(contents, organization, result.key, opts, request)
     return result
@@ -123,7 +118,7 @@ export class FilesSdk extends SdkBase {
     organization: string,
     opts: IMetaCreateOptions = {},
     request: SdkOptions = {}
-  ): Promise<ContextChangeRecord<IFile>> {
+  ): Promise<IFile> {
     const { token } = request
     const url = this.sdk.getUrl(RouteBuilder.files(organization))
     if (opts.parent) {
@@ -147,7 +142,7 @@ export class FilesSdk extends SdkBase {
     if (!result.body) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
     }
-    let data: ContextChangeRecord<IFile>
+    let data: IFile
     try {
       data = JSON.parse(result.body)
     } catch {
@@ -450,17 +445,30 @@ export class FilesSdk extends SdkBase {
    * @param info The patch operation on the file's ACL
    * @param request Optional request options.
    */
-  async patchUsers(oid: string, fid: string, info: AccessPatchInfo, request: SdkOptions = {}): Promise<void> {
+  async patchUsers(oid: string, fid: string, info: AccessPatchInfo, request: SdkOptions = {}): Promise<IFile> {
     const { token } = request
-    const url = this.sdk.getUrl(RouteBuilder.fileUsers(oid, fid))
+    const url = this.sdk.getUrl(RouteBuilder.filesAccess(oid, fid))
     const body = JSON.stringify(info)
     const result = await this.sdk.http.patch(url.toString(), { token, body })
     this.inspectCommonStatusCodes(result)
     const E_PREFIX = 'Unable to patch the file. '
-    if (result.status !== 204) {
+    if (result.status !== 200) {
       this.logInvalidResponse(result)
       throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
     }
+    if (!result.body) {
+      throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
+    }
+    let data: IFile
+    try {
+      data = JSON.parse(result.body)
+    } catch {
+      throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
+    }
+    if (!data.key) {
+      throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
+    }
+    return data
   }
 
   /**
@@ -479,7 +487,7 @@ export class FilesSdk extends SdkBase {
     role: PermissionRole,
     expires?: number,
     request?: SdkOptions
-  ): Promise<void> {
+  ): Promise<IFile> {
     const op: IAccessAddOperation = {
       op: 'add',
       type: 'user',
@@ -503,7 +511,7 @@ export class FilesSdk extends SdkBase {
    * @param key The file key
    * @param otherUserKey The key of the user that gets access to the organization
    */
-  async removeUser(organization: string, key: string, otherUserKey: string, request?: SdkOptions): Promise<void> {
+  async removeUser(organization: string, key: string, otherUserKey: string, request?: SdkOptions): Promise<IFile> {
     const op: IAccessRemoveOperation = {
       op: 'remove',
       type: 'user',

package/src/sdk/RouteBuilder.ts

@@ -19,11 +19,10 @@ export class RouteBuilder {
   }
 
   /**
-   * Used for SSE or WS to inform clients about a file being shared with the user.
-   * @returns The path to the /files/access route.
+   * Used to patch file access.
    */
-  static filesAccess(oid: string): string {
-    return `${RouteBuilder.files(oid)}/access`
+  static filesAccess(oid: string, fid: string): string {
+    return `${RouteBuilder.file(oid, fid)}/access`
   }
 
   /**