@api-client/core 0.20.9 → 0.20.10

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

package/src/mocking/ModelingMock.ts

@@ -10,6 +10,9 @@ import { DataCatalog } from './lib/DataCatalog.js'
 import { Permission } from './lib/Permission.js'
 import { Ai } from './lib/Ai.js'
 import { Deployment } from './lib/Deployment.js'
+import type { MockListResult } from '../sdk/SdkMock.js'
+import { ResourceResponse } from '../sdk/SdkBase.js'
+import { ContextListResult } from '../events/BaseEvents.js'
 
 export class ModelingMock {
   faker: Faker = faker
@@ -24,4 +27,55 @@ export class ModelingMock {
   permission = new Permission()
   ai = new Ai()
   deployments = new Deployment()
+
+  /**
+   * Wraps a single resource in a standard API resource response structure and serializes it to a JSON string.
+   *
+   * @param resource - The resource object to wrap.
+   * @returns A JSON string representation of the wrapped resource.
+   */
+  public wrapResource<T extends object>(resource: T): string {
+    const wrapper: ResourceResponse<T> = {
+      data: resource,
+    }
+    return JSON.stringify(wrapper)
+  }
+
+  /**
+   * Wraps a list of items in a standard API list response structure, including an optional pagination cursor,
+   * and serializes it to a JSON string.
+   *
+   * @param items - The array of items to wrap.
+   * @param init - Optional configuration for the mock list result, such as cursor settings.
+   * @returns A JSON string representation of the wrapped list.
+   */
+  public wrapList<T extends object>(items: (T | undefined)[], init?: MockListResult): string {
+    const obj: ContextListResult<T | undefined> = {
+      data: items,
+      cursor: this.createCursorOption(init),
+    }
+    return JSON.stringify(obj)
+  }
+
+  /**
+   * Generates or determines the pagination cursor based on the provided mock initialization options.
+   * If a cursor is explicitly provided, it is returned. If explicitly disabled, it returns undefined.
+   * Otherwise, it randomly generates a mock JWT string to simulate a cursor.
+   *
+   * @param init - Configuration object detailing cursor behavior.
+   * @returns The cursor string or undefined if no cursor should be present.
+   */
+  protected createCursorOption(init: MockListResult = {}): string | undefined {
+    if (init.cursor === false) {
+      return undefined
+    }
+    if (typeof init.cursor === 'string') {
+      return init.cursor
+    }
+    const hasCursor = init.cursor === true ? true : this.faker.datatype.boolean()
+    if (!hasCursor) {
+      return undefined
+    }
+    return this.faker.internet.jwt()
+  }
 }

package/src/sdk/SdkMock.ts

@@ -6,12 +6,7 @@ import {
   type InterceptOptions,
   type SerializedRequest,
 } from '@jarrodek/amw'
-import {
-  isAtomicFilter,
-  type ContextChangeRecord,
-  type ContextListResult,
-  type QueryFilter,
-} from '../events/BaseEvents.js'
+import { isAtomicFilter, type ContextChangeRecord, type QueryFilter } from '../events/BaseEvents.js'
 import { RouteBuilder } from './RouteBuilder.js'
 import { ModelingMock } from '../mocking/ModelingMock.js'
 import type { DataCatalogSchema, DataCatalogStatus } from '../models/DataCatalog.js'
@@ -23,7 +18,6 @@ import type { AiSessionApp } from '../models/AiSession.js'
 import type { DeploymentSchema } from '../models/store/Deployment.js'
 import { DeploymentEnvironment, DeploymentStatus } from '../models/store/Deployment.js'
 import type { CreateDeploymentPayload, DeploymentLatestEnvironments } from './DeploymentsSdk.js'
-import { ResourceResponse } from './SdkBase.js'
 
 export interface MockResult {
   /**
@@ -160,7 +154,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapList(this.gen.organization.organizations(init?.size ?? 5), init),
+        () => this.gen.wrapList(this.gen.organization.organizations(init?.size ?? 5), init),
         init
       )
       await mock.add(
@@ -184,7 +178,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapResource(this.gen.organization.organization()),
+        () => this.gen.wrapResource(this.gen.organization.organization()),
         init
       )
       await mock.add(
@@ -205,7 +199,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapList(this.gen.invitation.invitations(init?.size ?? 5), init),
+          () => this.gen.wrapList(this.gen.invitation.invitations(init?.size ?? 5), init),
           init
         )
         await mock.add(
@@ -224,7 +218,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapResource(this.gen.invitation.invitation()),
+          () => this.gen.wrapResource(this.gen.invitation.invitation()),
           init
         )
         await mock.add(
@@ -243,7 +237,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapResource(this.gen.invitation.invitation()),
+          () => this.gen.wrapResource(this.gen.invitation.invitation()),
           init
         )
 
@@ -263,7 +257,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapResource(this.gen.invitation.invitation()),
+          () => this.gen.wrapResource(this.gen.invitation.invitation()),
           init
         )
 
@@ -283,7 +277,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapResource(this.gen.invitation.invitation()),
+          () => this.gen.wrapResource(this.gen.invitation.invitation()),
           init
         )
 
@@ -303,7 +297,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapResource(this.gen.invitation.invitation()),
+          () => this.gen.wrapResource(this.gen.invitation.invitation()),
           init
         )
         await mock.add(
@@ -322,7 +316,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapResource(this.gen.invitation.invitation()),
+          () => this.gen.wrapResource(this.gen.invitation.invitation()),
           init
         )
 
@@ -345,7 +339,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapList(this.gen.users.users(init?.size ?? 5), init),
+          () => this.gen.wrapList(this.gen.users.users(init?.size ?? 5), init),
           init
         )
         await mock.add(
@@ -364,7 +358,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapResource(this.gen.users.user()),
+          () => this.gen.wrapResource(this.gen.users.user()),
           init
         )
         await mock.add(
@@ -384,7 +378,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapList(this.gen.users.users(init?.size ?? 5), init),
+          () => this.gen.wrapList(this.gen.users.users(init?.size ?? 5), init),
           init
         )
         await mock.add(
@@ -403,7 +397,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapResource(this.gen.users.user()),
+          () => this.gen.wrapResource(this.gen.users.user()),
           init
         )
         await mock.add(
@@ -422,7 +416,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapResource(this.gen.users.user()),
+          () => this.gen.wrapResource(this.gen.users.user()),
           init
         )
         await mock.add(
@@ -462,7 +456,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapResource(this.gen.organization.organizationSlugValidateResponse()),
+          () => this.gen.wrapResource(this.gen.organization.organizationSlugValidateResponse()),
           init
         )
         await mock.add(
@@ -486,7 +480,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapResource(this.gen.organization.organizationSlugGenerateResponse()),
+          () => this.gen.wrapResource(this.gen.organization.organizationSlugGenerateResponse()),
           init
         )
         await mock.add(
@@ -516,7 +510,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapList(this.gen.group.groups(init?.size ?? 5), init),
+        () => this.gen.wrapList(this.gen.group.groups(init?.size ?? 5), init),
         init
       )
       await mock.add(
@@ -540,7 +534,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         201,
         { 'content-type': 'application/json' },
-        () => this.wrapResource(this.gen.group.group()),
+        () => this.gen.wrapResource(this.gen.group.group()),
         init
       )
       await mock.add(
@@ -564,7 +558,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapResource(this.gen.group.group()),
+        () => this.gen.wrapResource(this.gen.group.group()),
         init
       )
       await mock.add(
@@ -606,7 +600,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapResource(this.gen.group.group()),
+        () => this.gen.wrapResource(this.gen.group.group()),
         init
       )
       await mock.add(
@@ -629,7 +623,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapResource(this.gen.group.group()),
+        () => this.gen.wrapResource(this.gen.group.group()),
         init
       )
       await mock.add(
@@ -652,7 +646,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapList(this.gen.ai.sessions('general', init?.size ?? 5), init),
+          () => this.gen.wrapList(this.gen.ai.sessions('general', init?.size ?? 5), init),
           init
         )
         await mock.add(
@@ -671,7 +665,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           201,
           { 'content-type': 'application/json' },
-          () => this.wrapResource(this.gen.ai.session()),
+          () => this.gen.wrapResource(this.gen.ai.session()),
           init
         )
         await mock.add(
@@ -690,7 +684,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapResource(this.gen.ai.session()),
+          () => this.gen.wrapResource(this.gen.ai.session()),
           init
         )
         await mock.add(
@@ -709,7 +703,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapResource(this.gen.ai.session()),
+          () => this.gen.wrapResource(this.gen.ai.session()),
           init
         )
         await mock.add(
@@ -745,7 +739,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapList(this.gen.ai.messages(init?.size ?? 5), init),
+          () => this.gen.wrapList(this.gen.ai.messages(init?.size ?? 5), init),
           init
         )
         await mock.add(
@@ -764,7 +758,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapResource(this.gen.ai.message()),
+          () => this.gen.wrapResource(this.gen.ai.message()),
           init
         )
         await mock.add(
@@ -829,7 +823,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapResource(this.gen.users.user()),
+        () => this.gen.wrapResource(this.gen.users.user()),
         init
       )
       await mock.add(
@@ -857,7 +851,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapList(this.gen.files.files(init?.size ?? 5), init),
+        () => this.gen.wrapList(this.gen.files.files(init?.size ?? 5), init),
         init
       )
       await mock.add(
@@ -880,7 +874,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         201,
         { 'content-type': 'application/json' },
-        () => this.wrapResource(this.gen.files.file()),
+        () => this.gen.wrapResource(this.gen.files.file()),
         init
       )
       await mock.add(
@@ -932,7 +926,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         201,
         { 'content-type': 'application/json' },
-        () => this.wrapResource(this.gen.files.folder()),
+        () => this.gen.wrapResource(this.gen.files.folder()),
         init
       )
       await mock.add(
@@ -955,7 +949,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapResource(this.gen.files.file()),
+        () => this.gen.wrapResource(this.gen.files.file()),
         init
       )
       await mock.add(
@@ -981,7 +975,7 @@ export class SdkMock {
           'content-type': 'application/json',
           'x-version': `${this.gen.faker.number.int({ min: 1, max: 100 })}`,
         },
-        () => this.wrapResource({ data: this.gen.faker.lorem.sentences() }),
+        () => this.gen.wrapResource({ data: this.gen.faker.lorem.sentences() }),
         init
       )
       await mock.add(
@@ -1004,7 +998,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapList(this.gen.files.files(init?.size ?? 5), { cursor: false }),
+        () => this.gen.wrapList(this.gen.files.files(init?.size ?? 5), { cursor: false }),
         init
       )
       await mock.add(
@@ -1027,7 +1021,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapResource(this.gen.files.file()),
+        () => this.gen.wrapResource(this.gen.files.file()),
         init
       )
       await mock.add(
@@ -1050,7 +1044,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapResource(this.gen.patch.mediaPatchRevision()),
+        () => this.gen.wrapResource(this.gen.patch.mediaPatchRevision()),
         init
       )
       await mock.add(
@@ -1109,7 +1103,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapResource(this.gen.files.file()),
+        () => this.gen.wrapResource(this.gen.files.file()),
         init
       )
       await mock.add(
@@ -1146,7 +1140,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapList(this.gen.users.users(init?.size ?? 5), init),
+        () => this.gen.wrapList(this.gen.users.users(init?.size ?? 5), init),
         init
       )
       await mock.add(
@@ -1169,7 +1163,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapList(this.gen.files.fileBreadcrumbs(init?.size ?? 5), init),
+        () => this.gen.wrapList(this.gen.files.fileBreadcrumbs(init?.size ?? 5), init),
         init
       )
       await mock.add(
@@ -1199,7 +1193,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapList(this.gen.files.files(init?.size ?? 5), init),
+        () => this.gen.wrapList(this.gen.files.files(init?.size ?? 5), init),
         init
       )
       await mock.add(
@@ -1224,7 +1218,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapList(this.gen.trash.trashEntries(init?.size ?? 5), init),
+        () => this.gen.wrapList(this.gen.trash.trashEntries(init?.size ?? 5), init),
         init
       )
       await mock.add(
@@ -1341,7 +1335,7 @@ export class SdkMock {
               }
             })
           }
-          return this.wrapList(data, init)
+          return this.gen.wrapList(data, init)
         },
         init
       )
@@ -1371,7 +1365,7 @@ export class SdkMock {
             env: payload.env,
             ...(payload.env === DeploymentEnvironment.PROD ? { version: payload.version } : {}),
           })
-          return this.wrapResource(obj)
+          return this.gen.wrapResource(obj)
         },
         init
       )
@@ -1396,7 +1390,7 @@ export class SdkMock {
             key: req.params.id,
             orgId: req.params.oid,
           })
-          return this.wrapResource(obj)
+          return this.gen.wrapResource(obj)
         },
         init
       )
@@ -1422,7 +1416,7 @@ export class SdkMock {
             orgId: req.params.oid,
             status: DeploymentStatus.Inactive,
           })
-          return this.wrapResource(obj)
+          return this.gen.wrapResource(obj)
         },
         init
       )
@@ -1461,7 +1455,7 @@ export class SdkMock {
             if (hasDev) {
               obj.dev = this.gen.deployments.deployment()
             }
-            return this.wrapResource(obj)
+            return this.gen.wrapResource(obj)
           },
           init
         )
@@ -1481,7 +1475,7 @@ export class SdkMock {
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
-          () => this.wrapList(this.gen.deployments.deploymentApis(init?.size ?? 5), { cursor: false }),
+          () => this.gen.wrapList(this.gen.deployments.deploymentApis(init?.size ?? 5), { cursor: false }),
           init
         )
         await mock.add(
@@ -1507,7 +1501,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapList(this.gen.dataCatalog.dataCatalogsWithVersion(init?.size ?? 5), init),
+        () => this.gen.wrapList(this.gen.dataCatalog.dataCatalogsWithVersion(init?.size ?? 5), init),
         init
       )
       await mock.add(
@@ -1527,7 +1521,7 @@ export class SdkMock {
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
-        () => this.wrapList(this.gen.dataCatalog.versionInfos(init?.size ?? 5), init),
+        () => this.gen.wrapList(this.gen.dataCatalog.versionInfos(init?.size ?? 5), init),
         init
       )
       await mock.add(
@@ -1554,7 +1548,7 @@ export class SdkMock {
             item: obj,
             kind: obj.kind,
           }
-          return this.wrapResource(result)
+          return this.gen.wrapResource(result)
         },
         init
       )
@@ -1577,7 +1571,7 @@ export class SdkMock {
         { 'content-type': 'application/json' },
         (req: SerializedRequest) => {
           const obj = this.gen.dataCatalog.dataCatalog({ key: req.params.id })
-          return this.wrapResource(obj)
+          return this.gen.wrapResource(obj)
         },
         init
       )
@@ -1605,7 +1599,7 @@ export class SdkMock {
             item: obj,
             kind: obj.kind,
           }
-          return this.wrapResource(result)
+          return this.gen.wrapResource(result)
         },
         init
       )
@@ -1633,7 +1627,7 @@ export class SdkMock {
             item: obj,
             kind: obj.kind,
           }
-          return this.wrapResource(result)
+          return this.gen.wrapResource(result)
         },
         init
       )
@@ -1663,7 +1657,7 @@ export class SdkMock {
             item: body,
             kind: body.kind,
           }
-          return this.wrapResource(result)
+          return this.gen.wrapResource(result)
         },
         init
       )
@@ -1686,7 +1680,7 @@ export class SdkMock {
         { 'content-type': 'application/json' },
         (req: SerializedRequest) => {
           const obj = this.gen.dataCatalog.dataCatalogVersion({ key: req.params.vid, catalogKey: req.params.id })
-          return this.wrapResource(obj)
+          return this.gen.wrapResource(obj)
         },
         init
       )
@@ -1717,7 +1711,7 @@ export class SdkMock {
             })
             data.push(domain.toJSON())
           }
-          return this.wrapList(data, { cursor: false })
+          return this.gen.wrapList(data, { cursor: false })
         },
         init
       )
@@ -1750,7 +1744,7 @@ export class SdkMock {
             item: obj,
             kind: obj.kind,
           }
-          return this.wrapResource(result)
+          return this.gen.wrapResource(result)
         },
         init
       )
@@ -1780,7 +1774,7 @@ export class SdkMock {
             item: obj,
             kind: obj.kind,
           }
-          return this.wrapResource(result)
+          return this.gen.wrapResource(result)
         },
         init
       )
@@ -1804,7 +1798,7 @@ export class SdkMock {
         () => {
           const obj = this.gen.dataCatalog.dataCatalog() as DataCatalogStatus
           obj.versions = this.gen.dataCatalog.versionInfos(1)
-          return this.wrapResource(obj)
+          return this.gen.wrapResource(obj)
         },
         init
       )
@@ -1854,20 +1848,6 @@ export class SdkMock {
     return limit
   }
 
-  protected createCursorOption(init: MockListResult = {}): string | undefined {
-    if (init.cursor === false) {
-      return undefined
-    }
-    if (typeof init.cursor === 'string') {
-      return init.cursor
-    }
-    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>,
@@ -1899,19 +1879,4 @@ export class SdkMock {
     }
     return respond
   }
-
-  public wrapResource<T extends object>(resource: T): string {
-    const wrapper: ResourceResponse<T> = {
-      data: resource,
-    }
-    return JSON.stringify(wrapper)
-  }
-
-  public wrapList<T extends object>(items: (T | undefined)[], init?: MockListResult): string {
-    const obj: ContextListResult<T | undefined> = {
-      data: items,
-      cursor: this.createCursorOption(init),
-    }
-    return JSON.stringify(obj)
-  }
 }