@api-client/core 0.19.36 → 0.19.38

package/src/sdk/SdkMock.ts

@@ -11,7 +11,13 @@ import type { GroupSchema } from '../models/store/Group.js'
 import type { UserSchema } from '../models/store/User.js'
 import type { InvitationSchema } from '../models/store/Invitation.js'
 import { type FileSchema, type FileBreadcrumb } from '../models/store/File.js'
-import type { ContextChangeRecord, ContextListResult, IBulkOperationResult } from '../events/BaseEvents.js'
+import {
+  isAtomicFilter,
+  type ContextChangeRecord,
+  type ContextListResult,
+  type IBulkOperationResult,
+  type QueryFilter,
+} from '../events/BaseEvents.js'
 import type { TrashEntry } from '../models/TrashEntry.js'
 import { RouteBuilder } from './RouteBuilder.js'
 import { ModelingMock } from '../mocking/ModelingMock.js'
@@ -29,7 +35,7 @@ import type { AiSessionSchema, AiSessionApp } from '../models/AiSession.js'
 import type { AiMessageSchema } from '../models/AiMessage.js'
 import type { DeploymentSchema } from '../models/store/Deployment.js'
 import { DeploymentEnvironment } from '../models/store/Deployment.js'
-import type { CreateDeploymentPayload } from './DeploymentsSdk.js'
+import type { CreateDeploymentPayload, DeploymentApi, DeploymentLatestEnvironmentsResponse } from './DeploymentsSdk.js'
 
 export interface MockResult {
   /**
@@ -152,49 +158,6 @@ export class SdkMock {
     return this.handler
   }
 
-  protected createCursorOption(init: MockListResult = {}): string | undefined {
-    if (init.cursor === false) {
-      return undefined
-    }
-    const hasCursor = init.cursor === true ? true : this.gen.faker.datatype.boolean()
-    if (!hasCursor) {
-      return undefined
-    }
-    return this.gen.faker.internet.jwt()
-  }
-
-  protected createDefaultResponse(
-    status: number,
-    headers?: Record<string, string>,
-    body?: (req: SerializedRequest) => string,
-    userConfig?: MockResult
-  ): ResponseGenerator {
-    let respond: ResponseGenerator
-    if (userConfig?.response) {
-      // user config takes precedence
-      respond = userConfig.response
-    } else {
-      respond = {}
-    }
-    // Set defaults if not provided in user config
-    if (!respond.status) {
-      respond.status = status
-    }
-    // only set headers if the user didn't configure the response only.
-    // The user may want to remove default headers.
-    if (!userConfig || !userConfig.response) {
-      respond.headers = headers
-    }
-    if (!respond.body && userConfig?.forceBody && body) {
-      // when body is missing and forceBody is set, generate the body
-      respond.body = (req: SerializedRequest) => body(req)
-    } else if (body && (!userConfig || !userConfig.response)) {
-      // we set the body by default when the user config is missing
-      respond.body = (req: SerializedRequest) => body(req)
-    }
-    return respond
-  }
-
   /**
    * Organization API mocks.
    */
@@ -205,20 +168,12 @@ export class SdkMock {
      */
     list: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
-      // const respond = init?.response ?? {
-      //   status: 200,
-      //   headers: { 'content-type': 'application/json' },
-      //   body: JSON.stringify({
-      //     items: this.gen.organization.organizations(init?.size ?? 5),
-      //     cursor: this.createCursorOption(init),
-      //   } as ContextListResult<OrganizationSchema>),
-      // }
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
         () =>
           JSON.stringify({
-            items: this.gen.organization.organizations(init?.size ?? 5),
+            data: this.gen.organization.organizations(init?.size ?? 5),
             cursor: this.createCursorOption(init),
           } as ContextListResult<OrganizationSchema>),
         init
@@ -267,20 +222,12 @@ export class SdkMock {
     invitations: {
       list: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
         const { mock } = this
-        // const respond = init?.response ?? {
-        //   status: 200,
-        //   headers: { 'content-type': 'application/json' },
-        //   body: JSON.stringify({
-        //     items: this.gen.invitation.invitations(init?.size ?? 5),
-        //     cursor: this.createCursorOption(init),
-        //   } as ContextListResult<InvitationSchema>),
-        // }
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
           () => {
             const obj: ContextListResult<InvitationSchema> = {
-              items: this.gen.invitation.invitations(init?.size ?? 5),
+              data: this.gen.invitation.invitations(init?.size ?? 5),
               cursor: this.createCursorOption(init),
             }
             return JSON.stringify(obj)
@@ -451,20 +398,12 @@ export class SdkMock {
     users: {
       list: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
         const { mock } = this
-        // const respond = init?.response ?? {
-        //   status: 200,
-        //   headers: { 'content-type': 'application/json' },
-        //   body: JSON.stringify({
-        //     items: this.gen.users.users(init?.size ?? 5),
-        //     cursor: this.createCursorOption(init),
-        //   } as ContextListResult<UserSchema>),
-        // }
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
           () => {
             const obj: ContextListResult<UserSchema> = {
-              items: this.gen.users.users(init?.size ?? 5),
+              data: this.gen.users.users(init?.size ?? 5),
               cursor: this.createCursorOption(init),
             }
             return JSON.stringify(obj)
@@ -513,7 +452,7 @@ export class SdkMock {
           status: 200,
           headers: { 'content-type': 'application/json' },
           body: JSON.stringify({
-            items: this.gen.users.users(init?.size ?? 5),
+            data: this.gen.users.users(init?.size ?? 5),
             cursor: this.createCursorOption(init),
           } as ContextListResult<UserSchema>),
         }
@@ -656,20 +595,12 @@ export class SdkMock {
      */
     list: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
-      // const respond = init?.response ?? {
-      //   status: 200,
-      //   headers: { 'content-type': 'application/json' },
-      //   body: JSON.stringify({
-      //     items: this.gen.group.groups(init?.size ?? 5),
-      //     cursor: this.createCursorOption(init),
-      //   } as ContextListResult<GroupSchema>),
-      // }
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
         () => {
           const obj: ContextListResult<GroupSchema> = {
-            items: this.gen.group.groups(init?.size ?? 5),
+            data: this.gen.group.groups(init?.size ?? 5),
             cursor: this.createCursorOption(init),
           }
           return JSON.stringify(obj)
@@ -834,7 +765,7 @@ export class SdkMock {
           { 'content-type': 'application/json' },
           () => {
             const obj: ContextListResult<AiSessionSchema> = {
-              items: this.gen.ai.sessions('general', init?.size ?? 5),
+              data: this.gen.ai.sessions('general', init?.size ?? 5),
               cursor: this.createCursorOption(init),
             }
             return JSON.stringify(obj)
@@ -933,7 +864,7 @@ export class SdkMock {
           { 'content-type': 'application/json' },
           () => {
             const obj: ContextListResult<AiMessageSchema> = {
-              items: this.gen.ai.messages(init?.size ?? 5),
+              data: this.gen.ai.messages(init?.size ?? 5),
               cursor: this.createCursorOption(init),
             }
             return JSON.stringify(obj)
@@ -1051,20 +982,12 @@ export class SdkMock {
      */
     list: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
-      // const respond = init?.response ?? {
-      //   status: 200,
-      //   headers: { 'content-type': 'application/json' },
-      //   body: JSON.stringify({
-      //     items: this.gen.files.files(init?.size ?? 5),
-      //     cursor: this.createCursorOption(init),
-      //   } as ContextListResult<FileSchema>),
-      // }
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
         () => {
           const obj: ContextListResult<FileSchema> = {
-            items: this.gen.files.files(init?.size ?? 5),
+            data: this.gen.files.files(init?.size ?? 5),
             cursor: this.createCursorOption(init),
           }
           return JSON.stringify(obj)
@@ -1238,19 +1161,12 @@ export class SdkMock {
      */
     readBulk: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
-      // const respond = init?.response ?? {
-      //   status: 200,
-      //   headers: { 'content-type': 'application/json' },
-      //   body: JSON.stringify({
-      //     items: this.gen.files.files(init?.size ?? 5),
-      //   } as IBulkOperationResult<FileSchema>),
-      // }
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
         () => {
           const obj: IBulkOperationResult<FileSchema> = {
-            items: this.gen.files.files(init?.size ?? 5),
+            data: this.gen.files.files(init?.size ?? 5),
           }
           return JSON.stringify(obj)
         },
@@ -1413,20 +1329,12 @@ export class SdkMock {
      */
     listUsers: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
-      // const respond = init?.response ?? {
-      //   status: 200,
-      //   headers: { 'content-type': 'application/json' },
-      //   body: JSON.stringify({
-      //     items: this.gen.users.users(init?.size ?? 5),
-      //     cursor: this.createCursorOption(init),
-      //   } as ContextListResult<UserSchema>),
-      // }
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
         () => {
           const obj: ContextListResult<UserSchema> = {
-            items: this.gen.users.users(init?.size ?? 5),
+            data: this.gen.users.users(init?.size ?? 5),
             cursor: this.createCursorOption(init),
           }
           return JSON.stringify(obj)
@@ -1450,20 +1358,12 @@ export class SdkMock {
      */
     breadcrumbs: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
-      // const respond = init?.response ?? {
-      //   status: 200,
-      //   headers: { 'content-type': 'application/json' },
-      //   body: JSON.stringify({
-      //     items: this.gen.files.fileBreadcrumbs(init?.size ?? 5),
-      //     cursor: this.createCursorOption(init),
-      //   } as ContextListResult<FileBreadcrumb>),
-      // }
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
         () => {
           const obj: ContextListResult<FileBreadcrumb> = {
-            items: this.gen.files.fileBreadcrumbs(init?.size ?? 5),
+            data: this.gen.files.fileBreadcrumbs(init?.size ?? 5),
             cursor: this.createCursorOption(init),
           }
           return JSON.stringify(obj)
@@ -1494,20 +1394,12 @@ export class SdkMock {
   shared = {
     list: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
-      // const respond = init?.response ?? {
-      //   status: 200,
-      //   headers: { 'content-type': 'application/json' },
-      //   body: JSON.stringify({
-      //     items: this.gen.files.files(init?.size ?? 5),
-      //     cursor: this.createCursorOption(init),
-      //   } as ContextListResult<FileSchema>),
-      // }
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
         () => {
           const obj: ContextListResult<FileSchema> = {
-            items: this.gen.files.files(init?.size ?? 5),
+            data: this.gen.files.files(init?.size ?? 5),
             cursor: this.createCursorOption(init),
           }
           return JSON.stringify(obj)
@@ -1533,20 +1425,12 @@ export class SdkMock {
   trash = {
     list: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
-      // const respond = init?.response ?? {
-      //   status: 200,
-      //   headers: { 'content-type': 'application/json' },
-      //   body: JSON.stringify({
-      //     items: this.gen.trash.trashEntries(init?.size ?? 5),
-      //     cursor: this.createCursorOption(init),
-      //   } as ContextListResult<TrashEntry>),
-      // }
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
         () => {
           const obj: ContextListResult<TrashEntry> = {
-            items: this.gen.trash.trashEntries(init?.size ?? 5),
+            data: this.gen.trash.trashEntries(init?.size ?? 5),
             cursor: this.createCursorOption(init),
           }
           return JSON.stringify(obj)
@@ -1626,9 +1510,58 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => {
+        (req: SerializedRequest) => {
+          const { query } = req
+          const filter = this.decodeFilter(query.filter)
+          const schema: Partial<DeploymentSchema> = {}
+          if (isAtomicFilter(filter)) {
+            if (['apiId', 'api_id'].includes(filter.field)) {
+              if (filter.operator === 'eq') {
+                schema.apiId = filter.value as string
+              }
+            }
+            if (['apiSlug', 'api_slug'].includes(filter.field)) {
+              if (filter.operator === 'eq') {
+                schema.apiSlug = filter.value as string
+              }
+            }
+            if (['orgId', 'organization'].includes(filter.field)) {
+              if (filter.operator === 'eq') {
+                schema.orgId = filter.value as string
+              }
+            }
+            if (['modelVersion', 'model_version'].includes(filter.field)) {
+              if (filter.operator === 'eq') {
+                schema.modelVersion = filter.value as string
+              }
+            }
+            if (filter.field === 'version') {
+              if (filter.operator === 'eq') {
+                schema.version = filter.value as string
+              }
+            }
+            if (filter.field === 'env') {
+              if (filter.operator === 'eq') {
+                schema.env = filter.value as DeploymentEnvironment
+              }
+            }
+          }
+          const limit = this.readQueryLimit(req, init)
+          const data = this.gen.deployments.deployments(limit, schema)
+          const { order = 'asc', sort } = req.query
+          if (sort) {
+            data.sort((a, b) => {
+              const aValue = a[sort as keyof DeploymentSchema] ?? 0
+              const bValue = b[sort as keyof DeploymentSchema] ?? 0
+              if (order === 'asc') {
+                return aValue < bValue ? -1 : aValue > bValue ? 1 : 0
+              } else {
+                return aValue > bValue ? -1 : aValue < bValue ? 1 : 0
+              }
+            })
+          }
           const obj: ContextListResult<DeploymentSchema> = {
-            items: this.gen.deployments.deployments(init?.size ?? 5),
+            data,
             cursor: this.createCursorOption(init),
           }
           return JSON.stringify(obj)
@@ -1716,15 +1649,30 @@ export class SdkMock {
       )
     },
     apis: {
-      listAllForApi: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
+      getLatestPerEnvironment: async (
+        init?: MockResult & { prod?: boolean; staging?: boolean; dev?: boolean },
+        options?: InterceptOptions
+      ): Promise<void> => {
         const { mock } = this
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
           () => {
-            const obj: ContextListResult<DeploymentSchema> = {
-              items: this.gen.deployments.deployments(init?.size ?? 5),
-              cursor: this.createCursorOption(init),
+            const obj: DeploymentLatestEnvironmentsResponse = {
+              data: {},
+            }
+            const hasProd = init?.prod ?? this.gen.faker.datatype.boolean()
+            const hasStaging = init?.staging ?? this.gen.faker.datatype.boolean()
+            const hasDev = init?.dev ?? this.gen.faker.datatype.boolean()
+
+            if (hasProd) {
+              obj.data.prod = this.gen.deployments.deployment()
+            }
+            if (hasStaging) {
+              obj.data.staging = this.gen.deployments.deployment()
+            }
+            if (hasDev) {
+              obj.data.dev = this.gen.deployments.deployment()
             }
             return JSON.stringify(obj)
           },
@@ -1733,7 +1681,7 @@ export class SdkMock {
         await mock.add(
           {
             match: {
-              uri: RouteBuilder.deploymentsApisByEnv(':oid', ':apiId'),
+              uri: RouteBuilder.deploymentsApisByEnvLatest(':oid', ':fileId'),
               methods: ['GET'],
             },
             respond,
@@ -1741,15 +1689,14 @@ export class SdkMock {
           options
         )
       },
-      listForEnvironment: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
+      list: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
         const { mock } = this
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
           () => {
-            const obj: ContextListResult<DeploymentSchema> = {
-              items: this.gen.deployments.deployments(init?.size ?? 5),
-              cursor: this.createCursorOption(init),
+            const obj: ContextListResult<DeploymentApi> = {
+              data: this.gen.deployments.deploymentApis(init?.size ?? 5),
             }
             return JSON.stringify(obj)
           },
@@ -1758,7 +1705,7 @@ export class SdkMock {
         await mock.add(
           {
             match: {
-              uri: RouteBuilder.deploymentsApisForEnv(':oid', ':apiId', ':env' as unknown as DeploymentEnvironment),
+              uri: RouteBuilder.deploymentsApis(':oid'),
               methods: ['GET'],
             },
             respond,
@@ -1780,7 +1727,7 @@ export class SdkMock {
         { 'content-type': 'application/json' },
         () => {
           const obj: ContextListResult<DataCatalogSchemaWithVersion> = {
-            items: this.gen.dataCatalog.dataCatalogsWithVersion(init?.size ?? 5),
+            data: this.gen.dataCatalog.dataCatalogsWithVersion(init?.size ?? 5),
             cursor: this.createCursorOption(init),
           }
           return JSON.stringify(obj)
@@ -1806,7 +1753,7 @@ export class SdkMock {
         { 'content-type': 'application/json' },
         () => {
           const obj: ContextListResult<DataCatalogVersionInfo> = {
-            items: this.gen.dataCatalog.versionInfos(init?.size ?? 5),
+            data: this.gen.dataCatalog.versionInfos(init?.size ?? 5),
             cursor: this.createCursorOption(init),
           }
           return JSON.stringify(obj)
@@ -1992,16 +1939,16 @@ export class SdkMock {
         { 'content-type': 'application/json' },
         (req: SerializedRequest) => {
           const requirements = JSON.parse(req.body as string) as { items: ForeignDomainDependency[] }
-          const items: DataDomainSchema[] = []
+          const data: DataDomainSchema[] = []
           for (const item of requirements.items) {
             const domain = new DataDomain({
               key: item.key,
               info: { name: `Domain ${item.key}`, version: item.version },
             })
-            items.push(domain.toJSON())
+            data.push(domain.toJSON())
           }
           const obj: ContextListResult<DataDomainSchema> = {
-            items: items,
+            data,
           }
           return JSON.stringify(obj)
         },
@@ -2106,4 +2053,80 @@ export class SdkMock {
       )
     },
   }
+
+  //
+  // Helpers
+  //
+
+  /**
+   * Decodes the filter parameter from the query string.
+   *
+   * @param filter The filter parameter from the query string.
+   * @returns The decoded filter or undefined if the filter is invalid.
+   */
+  decodeFilter(filter?: string | string[]): QueryFilter | undefined {
+    if (typeof filter !== 'string' || !filter) {
+      return undefined
+    }
+    try {
+      return JSON.parse(atob(filter)) as QueryFilter
+    } catch {
+      return undefined
+    }
+  }
+
+  readQueryLimit(req: SerializedRequest, init?: MockListResult): number {
+    let limit = init?.size ?? 5
+    if (req.query?.limit) {
+      const l = Array.isArray(req.query.limit) ? req.query.limit[0] : req.query.limit
+      const tmp = parseInt(l, 10)
+      if (Number.isInteger(tmp) && tmp > 0) {
+        limit = tmp
+      }
+    }
+    return limit
+  }
+
+  protected createCursorOption(init: MockListResult = {}): string | undefined {
+    if (init.cursor === false) {
+      return undefined
+    }
+    const hasCursor = init.cursor === true ? true : this.gen.faker.datatype.boolean()
+    if (!hasCursor) {
+      return undefined
+    }
+    return this.gen.faker.internet.jwt()
+  }
+
+  protected createDefaultResponse(
+    status: number,
+    headers?: Record<string, string>,
+    body?: (req: SerializedRequest) => string,
+    userConfig?: MockResult
+  ): ResponseGenerator {
+    let respond: ResponseGenerator
+    if (userConfig?.response) {
+      // user config takes precedence
+      respond = userConfig.response
+    } else {
+      respond = {}
+    }
+    // Set defaults if not provided in user config
+    if (!respond.status) {
+      respond.status = status
+    }
+    // only set headers if the user didn't configure the response only.
+    // The user may want to remove default headers.
+    if (!userConfig || !userConfig.response) {
+      respond.headers = headers
+    }
+    if (!respond.body && userConfig?.forceBody && body) {
+      // when body is missing and forceBody is set, generate the body
+      respond.body = (req: SerializedRequest) => body(req)
+    } else if (body && (!userConfig || !userConfig.response)) {
+      // we set the body by default when the user config is missing
+      respond.body = (req: SerializedRequest) => body(req)
+    }
+    return respond
+  }
 }

package/src/sdk/SharedSdk.ts

@@ -43,7 +43,7 @@ export class SharedSdk extends SdkBase {
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
-    if (!Array.isArray(data.items)) {
+    if (!Array.isArray(data.data)) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
     }
     return data

package/src/sdk/TrashSdk.ts

@@ -40,7 +40,7 @@ export class TrashSdk extends SdkBase {
     } catch {
       throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
     }
-    if (!Array.isArray(data.items)) {
+    if (!Array.isArray(data.data)) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
     }
     return data