@api-client/core 0.19.39 → 0.19.41

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.19.39",
+  "version": "0.19.41",
   "license": "UNLICENSED",
   "exports": {
     "./browser.js": {

package/src/models/store/Organization.ts

@@ -16,6 +16,10 @@ export interface OrganizationSlugValidateResponse {
    * The reason why the slug is invalid.
    */
   reason?: string
+  /**
+   * The code of the reason.
+   */
+  code?: string
 }
 
 /**

package/src/proxy/HttpProjectProxy.ts

@@ -92,7 +92,7 @@ export default class HttpProjectProxy extends Proxy {
     sdk.token = token
     let project: IHttpProject
     try {
-      const data = await sdk.file.readMedia(organization, pid)
+      const data = await sdk.files.readMedia(organization, pid)
       project = data.media as IHttpProject
     } catch (cause) {
       const e = cause as Error

package/src/sdk/AiSdk.ts

@@ -185,7 +185,7 @@ export class AiSdk extends SdkBase {
       }
       let data: AiSessionSchema
       try {
-        data = JSON.parse(result.body)
+        data = JSON.parse(result.body).data
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }
@@ -224,7 +224,7 @@ export class AiSdk extends SdkBase {
       }
       let data: AiSessionSchema
       try {
-        data = JSON.parse(result.body)
+        data = JSON.parse(result.body).data
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }
@@ -283,7 +283,7 @@ export class AiSdk extends SdkBase {
       }
       let data: AiSessionSchema
       try {
-        data = JSON.parse(result.body)
+        data = JSON.parse(result.body).data
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }
@@ -383,7 +383,7 @@ export class AiSdk extends SdkBase {
       }
       let data: AiMessageSchema
       try {
-        data = JSON.parse(result.body)
+        data = JSON.parse(result.body).data
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }

package/src/sdk/DataCatalogSdk.ts

@@ -1,4 +1,4 @@
-import { SdkBase, E_RESPONSE_STATUS, SdkOptions } from './SdkBase.js'
+import { SdkBase, E_RESPONSE_STATUS, SdkOptions, ResourceResponse } from './SdkBase.js'
 import { ContextListResult, ContextListOptions, ContextChangeRecord } from '../events/BaseEvents.js'
 import type {
   DataCatalogSchema,
@@ -67,7 +67,7 @@ export class DataCatalogSdk extends SdkBase {
       this.logInvalidResponse(result)
       throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
     }
-    const data = this.readResponseJSON<DataCatalogSchema>(result, E_PREFIX)
+    const data = this.readResponseJSON<ResourceResponse<DataCatalogSchema>>(result, E_PREFIX).data
     this.assertObjectKind(E_PREFIX, DataCatalogKind, data.kind)
     return data
   }
@@ -82,7 +82,7 @@ export class DataCatalogSdk extends SdkBase {
       this.logInvalidResponse(result)
       throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
     }
-    const data = this.readResponseJSON<DataCatalogSchema>(result, E_PREFIX)
+    const data = this.readResponseJSON<ResourceResponse<DataCatalogSchema>>(result, E_PREFIX).data
     this.assertObjectKind(E_PREFIX, DataCatalogKind, data.kind)
     return data
   }
@@ -114,7 +114,7 @@ export class DataCatalogSdk extends SdkBase {
       this.logInvalidResponse(result)
       throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
     }
-    const data = this.readResponseJSON<DataCatalogSchema>(result, E_PREFIX)
+    const data = this.readResponseJSON<ResourceResponse<DataCatalogSchema>>(result, E_PREFIX).data
     this.assertObjectKind(E_PREFIX, DataCatalogKind, data.kind)
     return data
   }
@@ -135,7 +135,7 @@ export class DataCatalogSdk extends SdkBase {
       this.logInvalidResponse(result)
       throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
     }
-    const data = this.readResponseJSON<DataCatalogSchema>(result, E_PREFIX)
+    const data = this.readResponseJSON<ResourceResponse<DataCatalogSchema>>(result, E_PREFIX).data
     this.assertObjectKind(E_PREFIX, DataCatalogKind, data.kind)
     return data
   }
@@ -161,7 +161,7 @@ export class DataCatalogSdk extends SdkBase {
       this.logInvalidResponse(result)
       throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
     }
-    const data = this.readResponseJSON<DataCatalogVersionSchema>(result, E_PREFIX)
+    const data = this.readResponseJSON<ResourceResponse<DataCatalogVersionSchema>>(result, E_PREFIX).data
     this.assertObjectKind(E_PREFIX, DataCatalogVersionKind, data.kind)
     return data
   }
@@ -176,7 +176,7 @@ export class DataCatalogSdk extends SdkBase {
       this.logInvalidResponse(result)
       throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
     }
-    const data = this.readResponseJSON<DataCatalogVersionSchema>(result, E_PREFIX)
+    const data = this.readResponseJSON<ResourceResponse<DataCatalogVersionSchema>>(result, E_PREFIX).data
     this.assertObjectKind(E_PREFIX, DataCatalogVersionKind, data.kind)
     return data
   }
@@ -220,7 +220,7 @@ export class DataCatalogSdk extends SdkBase {
       this.logInvalidResponse(result)
       throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
     }
-    const data = this.readResponseJSON<DataCatalogVersionSchema>(result, E_PREFIX)
+    const data = this.readResponseJSON<ResourceResponse<DataCatalogVersionSchema>>(result, E_PREFIX).data
     this.assertObjectKind(E_PREFIX, DataCatalogVersionKind, data.kind)
     return data
   }
@@ -239,7 +239,7 @@ export class DataCatalogSdk extends SdkBase {
       this.logInvalidResponse(result)
       throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
     }
-    const data = this.readResponseJSON<DataCatalogVersionSchema>(result, E_PREFIX)
+    const data = this.readResponseJSON<ResourceResponse<DataCatalogVersionSchema>>(result, E_PREFIX).data
     this.assertObjectKind(E_PREFIX, DataCatalogVersionKind, data.kind)
     return data
   }
@@ -264,7 +264,7 @@ export class DataCatalogSdk extends SdkBase {
       this.logInvalidResponse(result)
       throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
     }
-    const data = this.readResponseJSON<DataCatalogStatus>(result, E_PREFIX)
+    const data = this.readResponseJSON<ResourceResponse<DataCatalogStatus>>(result, E_PREFIX).data
     this.assertObjectKind(E_PREFIX, DataCatalogKind, data.kind)
     return data
   }

package/src/sdk/DeploymentsSdk.ts

@@ -1,4 +1,4 @@
-import { SdkBase, type SdkOptions, E_RESPONSE_STATUS, E_RESPONSE_UNKNOWN } from './SdkBase.js'
+import { SdkBase, type SdkOptions, E_RESPONSE_STATUS, E_RESPONSE_UNKNOWN, ResourceResponse } from './SdkBase.js'
 import { RouteBuilder } from './RouteBuilder.js'
 import { DeploymentEnvironment, DeploymentKind, DeploymentSchema } from '../models/store/Deployment.js'
 import { Exception } from '../exceptions/exception.js'
@@ -118,7 +118,7 @@ export class DeploymentsSdk extends SdkBase {
       this.logInvalidResponse(result)
       throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
     }
-    const data = this.readResponseJSON<DeploymentSchema>(result, E_PREFIX)
+    const data = this.readResponseJSON<ResourceResponse<DeploymentSchema>>(result, E_PREFIX).data
     this.assertObjectKind(E_PREFIX, DeploymentKind, data.kind)
     return data
   }
@@ -141,7 +141,7 @@ export class DeploymentsSdk extends SdkBase {
       this.logInvalidResponse(result)
       throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
     }
-    const data = this.readResponseJSON<DeploymentSchema>(result, E_PREFIX)
+    const data = this.readResponseJSON<ResourceResponse<DeploymentSchema>>(result, E_PREFIX).data
     this.assertObjectKind(E_PREFIX, DeploymentKind, data.kind)
     return data
   }
@@ -151,16 +151,19 @@ export class DeploymentsSdk extends SdkBase {
    * @param oid The organization ID
    * @param did The deployment ID
    */
-  async deactivate(oid: string, did: string, request: SdkOptions = {}): Promise<void> {
+  async deactivate(oid: string, did: string, request: SdkOptions = {}): Promise<DeploymentSchema> {
     const url = this.sdk.getUrl(RouteBuilder.deployment(oid, did))
     const { token = this.sdk.token } = request
     const result = await this.sdk.http.delete(url.toString(), { token })
     this.inspectCommonStatusCodes(result)
     const E_PREFIX = 'Unable to deactivate a deployment. '
-    if (result.status !== 204) {
+    if (result.status !== 200) {
       this.logInvalidResponse(result)
       throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
     }
+    const data = this.readResponseJSON<ResourceResponse<DeploymentSchema>>(result, E_PREFIX).data
+    this.assertObjectKind(E_PREFIX, DeploymentKind, data.kind)
+    return data
   }
 
   apis = {

package/src/sdk/FilesSdk.ts

@@ -144,7 +144,7 @@ export class FilesSdk extends SdkBase {
     }
     let data: FileSchema
     try {
-      data = JSON.parse(result.body)
+      data = JSON.parse(result.body).data
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
@@ -226,7 +226,7 @@ export class FilesSdk extends SdkBase {
     }
     let data: FolderSchema
     try {
-      data = JSON.parse(result.body)
+      data = JSON.parse(result.body).data
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
@@ -258,7 +258,7 @@ export class FilesSdk extends SdkBase {
     }
     let data: FileSchema
     try {
-      data = JSON.parse(result.body)
+      data = JSON.parse(result.body).data
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
@@ -283,7 +283,7 @@ export class FilesSdk extends SdkBase {
     }
     let data: unknown
     try {
-      data = JSON.parse(result.body)
+      data = JSON.parse(result.body).data
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
@@ -368,7 +368,7 @@ export class FilesSdk extends SdkBase {
     }
     let data: FileSchema
     try {
-      data = JSON.parse(result.body)
+      data = JSON.parse(result.body).data
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
@@ -403,7 +403,7 @@ export class FilesSdk extends SdkBase {
     }
     let data: MediaPatchRevision
     try {
-      data = JSON.parse(result.body)
+      data = JSON.parse(result.body).data
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
@@ -465,7 +465,7 @@ export class FilesSdk extends SdkBase {
     }
     let data: FileSchema
     try {
-      data = JSON.parse(result.body)
+      data = JSON.parse(result.body).data
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }

package/src/sdk/GroupsSdk.ts

@@ -42,7 +42,7 @@ export class GroupsSdk extends SdkBase {
     }
     let data: GroupSchema
     try {
-      data = JSON.parse(result.body)
+      data = JSON.parse(result.body).data
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
@@ -118,7 +118,7 @@ export class GroupsSdk extends SdkBase {
     }
     let data: GroupSchema
     try {
-      data = JSON.parse(result.body)
+      data = JSON.parse(result.body).data
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
@@ -170,7 +170,7 @@ export class GroupsSdk extends SdkBase {
     }
     let data: GroupSchema
     try {
-      data = JSON.parse(result.body)
+      data = JSON.parse(result.body).data
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
@@ -202,7 +202,7 @@ export class GroupsSdk extends SdkBase {
     }
     let data: GroupSchema
     try {
-      data = JSON.parse(result.body)
+      data = JSON.parse(result.body).data
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }

package/src/sdk/HistorySdk.ts

@@ -48,7 +48,7 @@ export class HistorySdk extends SdkBase {
     }
     let data: ContextChangeRecord<IHttpHistory>
     try {
-      data = JSON.parse(result.body)
+      data = JSON.parse(result.body).data
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
@@ -219,7 +219,7 @@ export class HistorySdk extends SdkBase {
     }
     let data: IHttpHistory
     try {
-      data = JSON.parse(result.body)
+      data = JSON.parse(result.body).data
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }

package/src/sdk/OrganizationsSdk.ts

@@ -79,7 +79,7 @@ export class OrganizationsSdk extends SdkBase {
     }
     let data: OrganizationSchema
     try {
-      data = JSON.parse(result.body)
+      data = JSON.parse(result.body).data
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
@@ -161,7 +161,7 @@ export class OrganizationsSdk extends SdkBase {
       }
       let data: InvitationSchema
       try {
-        data = JSON.parse(result.body)
+        data = JSON.parse(result.body).data
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }
@@ -193,7 +193,7 @@ export class OrganizationsSdk extends SdkBase {
       }
       let data: InvitationSchema
       try {
-        data = JSON.parse(result.body)
+        data = JSON.parse(result.body).data
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }
@@ -224,7 +224,7 @@ export class OrganizationsSdk extends SdkBase {
       }
       let data: InvitationSchema
       try {
-        data = JSON.parse(result.body)
+        data = JSON.parse(result.body).data
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }
@@ -255,7 +255,7 @@ export class OrganizationsSdk extends SdkBase {
       }
       let data: InvitationSchema
       try {
-        data = JSON.parse(result.body)
+        data = JSON.parse(result.body).data
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }
@@ -297,7 +297,7 @@ export class OrganizationsSdk extends SdkBase {
       }
       let data: InvitationSchema
       try {
-        data = JSON.parse(result.body)
+        data = JSON.parse(result.body).data
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }
@@ -328,7 +328,7 @@ export class OrganizationsSdk extends SdkBase {
       }
       let data: InvitationSchema
       try {
-        data = JSON.parse(result.body)
+        data = JSON.parse(result.body).data
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }
@@ -400,7 +400,7 @@ export class OrganizationsSdk extends SdkBase {
       }
       let data: UserSchema
       try {
-        data = JSON.parse(result.body)
+        data = JSON.parse(result.body).data
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }
@@ -472,7 +472,7 @@ export class OrganizationsSdk extends SdkBase {
       }
       let data: UserSchema
       try {
-        data = JSON.parse(result.body)
+        data = JSON.parse(result.body).data
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }
@@ -500,7 +500,7 @@ export class OrganizationsSdk extends SdkBase {
       }
       let data: UserSchema
       try {
-        data = JSON.parse(result.body)
+        data = JSON.parse(result.body).data
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }
@@ -555,7 +555,7 @@ export class OrganizationsSdk extends SdkBase {
       }
       let data: { slug: string }
       try {
-        data = JSON.parse(result.body)
+        data = JSON.parse(result.body).data
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }
@@ -592,7 +592,7 @@ export class OrganizationsSdk extends SdkBase {
       }
       let data: OrganizationSlugValidateResponse
       try {
-        data = JSON.parse(result.body)
+        data = JSON.parse(result.body).data
       } catch {
         throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
       }

package/src/sdk/ProjectExecutionsSdk.ts

@@ -1,4 +1,4 @@
-import { SdkBase, E_RESPONSE_UNKNOWN, SdkOptions } from './SdkBase.js'
+import { SdkBase, E_RESPONSE_UNKNOWN, SdkOptions, ResourceResponse } from './SdkBase.js'
 import { RouteBuilder } from './RouteBuilder.js'
 import {
   ContextChangeRecord,
@@ -27,11 +27,11 @@ export class ProjectExecutionSdk extends SdkBase {
     const result = await this.sdk.http.post(url.toString(), { token, body: JSON.stringify(value) })
     this.inspectCommonStatusCodes(result)
     const E_PREFIX = 'Unable to create a project execution entity. '
-    const data = this.readResponseJSON(result, E_PREFIX) as ContextChangeRecord<IProjectExecution>
-    if (!data.key) {
+    const data = this.readResponseJSON(result, E_PREFIX) as ResourceResponse<ContextChangeRecord<IProjectExecution>>
+    if (!data.data.key) {
       throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`)
     }
-    return data
+    return data.data
   }
 
   /**
@@ -45,11 +45,11 @@ export class ProjectExecutionSdk extends SdkBase {
     const result = await this.sdk.http.get(url.toString(), { token })
     this.inspectCommonStatusCodes(result)
     const E_PREFIX = 'Unable to read a project execution entity. '
-    const data = this.readResponseJSON(result, E_PREFIX) as IProjectExecution
-    if (data.kind !== ProjectExecutionKind) {
+    const data = this.readResponseJSON(result, E_PREFIX) as ResourceResponse<IProjectExecution>
+    if (data.data.kind !== ProjectExecutionKind) {
       throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`)
     }
-    return data
+    return data.data
   }
 
   /**

package/src/sdk/SdkBase.ts

@@ -42,6 +42,15 @@ export const E_RESPONSE_STATUS = 'Invalid response status: '
 export const E_RESPONSE_UNKNOWN = 'Unknown response from the server.'
 export const E_RESPONSE_LOCATION = 'The response has no "location" header.'
 
+/**
+ * The API wraps resource response with the `data` property.
+ * It makes it consistent with the collection response and scales
+ * to adding metadata when needed.
+ */
+export interface ResourceResponse<T> {
+  data: T
+}
+
 export class SdkBase {
   constructor(public sdk: Sdk) {}