@api-client/core 0.18.39 → 0.18.41

package/src/sdk/SdkMock.ts

@@ -1,13 +1,30 @@
-import { type ResponseGenerator, setupWorker, type MockHandler, type SetupWorkerOptions } from '@jarrodek/amw'
+import {
+  type ResponseGenerator,
+  setupWorker,
+  type MockHandler,
+  type SetupWorkerOptions,
+  type InterceptOptions,
+  type SerializedRequest,
+} from '@jarrodek/amw'
 import type { IOrganization } from '../models/store/Organization.js'
 import type { GroupSchema } from '../models/store/Group.js'
 import type { IUser } from '../models/store/User.js'
 import type { InvitationSchema } from '../models/store/Invitation.js'
 import { type IFile, type FileBreadcrumb } from '../models/store/File.js'
-import type { ContextListResult, IBulkOperationResult } from '../events/BaseEvents.js'
+import type { ContextChangeRecord, ContextListResult, IBulkOperationResult } from '../events/BaseEvents.js'
 import type { TrashEntry } from '../models/TrashEntry.js'
 import { RouteBuilder } from './RouteBuilder.js'
 import { ModelingMock } from '../mocking/ModelingMock.js'
+import type {
+  DataCatalogSchema,
+  DataCatalogSchemaWithVersion,
+  DataCatalogStatus,
+  DataCatalogVersionInfo,
+} from '../models/DataCatalog.js'
+import type { DataCatalogVersionSchema } from '../models/DataCatalogVersion.js'
+import { DataDomain, type DataDomainSchema } from '../modeling/DataDomain.js'
+import type { ForeignDomainDependency } from '../modeling/types.js'
+import { nanoid } from '../nanoid.js'
 
 export interface MockResult {
   /**
@@ -90,6 +107,10 @@ export interface MockListResult extends MockResult {
  * // Stop and remove the Service Worker
  * await mocker.teardown();
  * ```
+ *
+ * @TODO: Add a in-memory state store so that mocks can maintain state across requests.
+ * This way, operations like create, update, delete can affect subsequent list/read calls
+ * and we can mimic the API behavior more closely.
  */
 export class SdkMock {
   handler?: MockHandler
@@ -140,7 +161,7 @@ export class SdkMock {
   protected createDefaultResponse(
     status: number,
     headers?: Record<string, string>,
-    body?: () => string,
+    body?: (req: SerializedRequest) => string,
     userConfig?: MockResult
   ): ResponseGenerator {
     let respond: ResponseGenerator
@@ -161,10 +182,10 @@ export class SdkMock {
     }
     if (!respond.body && userConfig?.forceBody && body) {
       // when body is missing and forceBody is set, generate the body
-      respond.body = 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 = body()
+      respond.body = (req: SerializedRequest) => body(req)
     }
     return respond
   }
@@ -177,7 +198,7 @@ export class SdkMock {
      * Adds an intercept to mock the `organizations.list()` method.
      * @param options Optional response configuration
      */
-    list: async (init?: MockListResult): Promise<void> => {
+    list: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
@@ -197,20 +218,23 @@ export class SdkMock {
           } as ContextListResult<IOrganization>),
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.organizations(),
-          methods: ['GET'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.organizations(),
+            methods: ['GET'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Adds an intercept to mock the `organizations.create()` method.
      * @param options Optional response configuration
      */
-    create: async (init?: MockResult): Promise<void> => {
+    create: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
@@ -223,17 +247,20 @@ export class SdkMock {
         () => JSON.stringify(this.gen.organization.organization()),
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.organizations(),
-          methods: ['POST'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.organizations(),
+            methods: ['POST'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     invitations: {
-      list: async (init?: MockListResult): Promise<void> => {
+      list: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
         const { mock } = this
         // const respond = init?.response ?? {
         //   status: 200,
@@ -255,15 +282,18 @@ export class SdkMock {
           },
           init
         )
-        await mock.add({
-          match: {
-            uri: RouteBuilder.invitations(':oid'),
-            methods: ['GET'],
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.invitations(':oid'),
+              methods: ['GET'],
+            },
+            respond,
           },
-          respond,
-        })
+          options
+        )
       },
-      create: async (init?: MockResult): Promise<void> => {
+      create: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
         const { mock } = this
         // const respond = init?.response ?? {
         //   status: 200,
@@ -276,15 +306,18 @@ export class SdkMock {
           () => JSON.stringify(this.gen.invitation.invitation()),
           init
         )
-        await mock.add({
-          match: {
-            uri: RouteBuilder.invitations(':oid'),
-            methods: ['POST'],
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.invitations(':oid'),
+              methods: ['POST'],
+            },
+            respond,
           },
-          respond,
-        })
+          options
+        )
       },
-      findByToken: async (init?: MockResult): Promise<void> => {
+      findByToken: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
         const { mock } = this
         // const respond = init?.response ?? {
         //   status: 200,
@@ -298,15 +331,18 @@ export class SdkMock {
           init
         )
 
-        await mock.add({
-          match: {
-            uri: RouteBuilder.findInvitation(),
-            methods: ['GET'],
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.findInvitation(),
+              methods: ['GET'],
+            },
+            respond,
           },
-          respond,
-        })
+          options
+        )
       },
-      decline: async (init?: MockResult): Promise<void> => {
+      decline: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
         const { mock } = this
         // const respond = init?.response ?? {
         //   status: 200,
@@ -320,15 +356,18 @@ export class SdkMock {
           init
         )
 
-        await mock.add({
-          match: {
-            uri: RouteBuilder.declineInvitation(':oid', ':id'),
-            methods: ['POST'],
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.declineInvitation(':oid', ':id'),
+              methods: ['POST'],
+            },
+            respond,
           },
-          respond,
-        })
+          options
+        )
       },
-      delete: async (init?: MockResult): Promise<void> => {
+      delete: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
         const { mock } = this
         // const respond = init?.response ?? {
         //   status: 200,
@@ -342,15 +381,18 @@ export class SdkMock {
           init
         )
 
-        await mock.add({
-          match: {
-            uri: RouteBuilder.invitation(':oid', ':id'),
-            methods: ['DELETE'],
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.invitation(':oid', ':id'),
+              methods: ['DELETE'],
+            },
+            respond,
           },
-          respond,
-        })
+          options
+        )
       },
-      patch: async (init?: MockResult): Promise<void> => {
+      patch: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
         const { mock } = this
         // const respond = init?.response ?? {
         //   status: 200,
@@ -363,15 +405,18 @@ export class SdkMock {
           () => JSON.stringify(this.gen.invitation.invitation()),
           init
         )
-        await mock.add({
-          match: {
-            uri: RouteBuilder.invitation(':oid', ':id'),
-            methods: ['PATCH'],
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.invitation(':oid', ':id'),
+              methods: ['PATCH'],
+            },
+            respond,
           },
-          respond,
-        })
+          options
+        )
       },
-      resend: async (init?: MockResult): Promise<void> => {
+      resend: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
         const { mock } = this
         // const respond = init?.response ?? {
         //   status: 200,
@@ -385,18 +430,21 @@ export class SdkMock {
           init
         )
 
-        await mock.add({
-          match: {
-            uri: RouteBuilder.resendInvitation(':oid', ':id'),
-            methods: ['PUT'],
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.resendInvitation(':oid', ':id'),
+              methods: ['PUT'],
+            },
+            respond,
           },
-          respond,
-        })
+          options
+        )
       },
     },
 
     users: {
-      list: async (init?: MockListResult): Promise<void> => {
+      list: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
         const { mock } = this
         // const respond = init?.response ?? {
         //   status: 200,
@@ -418,15 +466,18 @@ export class SdkMock {
           },
           init
         )
-        await mock.add({
-          match: {
-            uri: RouteBuilder.organizationUsers(':oid'),
-            methods: ['GET'],
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.organizationUsers(':oid'),
+              methods: ['GET'],
+            },
+            respond,
           },
-          respond,
-        })
+          options
+        )
       },
-      read: async (init?: MockResult): Promise<void> => {
+      read: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
         const { mock } = this
         // const respond = init?.response ?? {
         //   status: 200,
@@ -439,15 +490,18 @@ export class SdkMock {
           () => JSON.stringify(this.gen.user.user()),
           init
         )
-        await mock.add({
-          match: {
-            uri: RouteBuilder.organizationUser(':oid', ':id'),
-            methods: ['GET'],
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.organizationUser(':oid', ':id'),
+              methods: ['GET'],
+            },
+            respond,
           },
-          respond,
-        })
+          options
+        )
       },
-      readBatch: async (init?: MockListResult): Promise<void> => {
+      readBatch: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
         const { mock } = this
         const path = RouteBuilder.organizationUserBatch(':oid')
         const respond = init?.response ?? {
@@ -458,15 +512,18 @@ export class SdkMock {
             cursor: this.createCursorOption(init),
           } as ContextListResult<IUser>),
         }
-        await mock.add({
-          match: {
-            uri: path,
-            methods: ['POST'],
+        await mock.add(
+          {
+            match: {
+              uri: path,
+              methods: ['POST'],
+            },
+            respond,
           },
-          respond,
-        })
+          options
+        )
       },
-      activate: async (init?: MockResult): Promise<void> => {
+      activate: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
         const { mock } = this
         // const respond = init?.response ?? {
         //   status: 200,
@@ -479,15 +536,18 @@ export class SdkMock {
           () => JSON.stringify(this.gen.user.user()),
           init
         )
-        await mock.add({
-          match: {
-            uri: RouteBuilder.organizationUserActivate(':oid', ':id'),
-            methods: ['POST'],
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.organizationUserActivate(':oid', ':id'),
+              methods: ['POST'],
+            },
+            respond,
           },
-          respond,
-        })
+          options
+        )
       },
-      deactivate: async (init?: MockResult): Promise<void> => {
+      deactivate: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
         const { mock } = this
         // const respond = init?.response ?? {
         //   status: 200,
@@ -500,27 +560,33 @@ export class SdkMock {
           () => JSON.stringify(this.gen.user.user()),
           init
         )
-        await mock.add({
-          match: {
-            uri: RouteBuilder.organizationUserDeactivate(':oid', ':id'),
-            methods: ['POST'],
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.organizationUserDeactivate(':oid', ':id'),
+              methods: ['POST'],
+            },
+            respond,
           },
-          respond,
-        })
+          options
+        )
       },
-      delete: async (init?: MockResult): Promise<void> => {
+      delete: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
         const { mock } = this
         // const respond = init?.response ?? {
         //   status: 204,
         // }
         const respond = this.createDefaultResponse(204, undefined, undefined, init)
-        await mock.add({
-          match: {
-            uri: RouteBuilder.organizationUser(':oid', ':id'),
-            methods: ['DELETE'],
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.organizationUser(':oid', ':id'),
+              methods: ['DELETE'],
+            },
+            respond,
           },
-          respond,
-        })
+          options
+        )
       },
     },
   }
@@ -533,7 +599,7 @@ export class SdkMock {
      * Mocks the `groups.list()` method.
      * @param options Optional response customization.
      */
-    list: async (init?: MockListResult): Promise<void> => {
+    list: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
@@ -555,20 +621,23 @@ export class SdkMock {
         },
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.groups(':oid'),
-          methods: ['GET'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.groups(':oid'),
+            methods: ['GET'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Mocks the `groups.create()` method.
      * @param options Optional response customization.
      */
-    create: async (init?: MockResult): Promise<void> => {
+    create: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 201,
@@ -581,20 +650,23 @@ export class SdkMock {
         () => JSON.stringify(this.gen.group.group()),
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.groups(':oid'),
-          methods: ['POST'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.groups(':oid'),
+            methods: ['POST'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Mocks the `groups.update()` method.
      * @param options Optional response customization.
      */
-    update: async (init?: MockResult): Promise<void> => {
+    update: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
@@ -607,38 +679,44 @@ export class SdkMock {
         () => JSON.stringify(this.gen.group.group()),
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.group(':oid', ':key'),
-          methods: ['PATCH'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.group(':oid', ':key'),
+            methods: ['PATCH'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Mocks the `groups.delete()` method.
      * @param options Optional response customization.
      */
-    delete: async (init?: MockResult): Promise<void> => {
+    delete: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 204,
       // }
       const respond = this.createDefaultResponse(204, undefined, undefined, init)
-      await mock.add({
-        match: {
-          uri: RouteBuilder.group(':oid', ':key'),
-          methods: ['DELETE'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.group(':oid', ':key'),
+            methods: ['DELETE'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Mocks the `groups.addUsers()` method.
      */
-    addUsers: async (init?: MockResult): Promise<void> => {
+    addUsers: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
@@ -651,19 +729,22 @@ export class SdkMock {
         () => JSON.stringify(this.gen.group.group()),
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.groupUsers(':oid', ':key'),
-          methods: ['POST'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.groupUsers(':oid', ':key'),
+            methods: ['POST'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Mocks the `groups.removeUsers()` method.
      */
-    removeUsers: async (init?: MockResult): Promise<void> => {
+    removeUsers: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
@@ -676,13 +757,16 @@ export class SdkMock {
         () => JSON.stringify(this.gen.group.group()),
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.groupUsers(':oid', ':key'),
-          methods: ['DELETE'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.groupUsers(':oid', ':key'),
+            methods: ['DELETE'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
   }
 
@@ -694,7 +778,7 @@ export class SdkMock {
      * Mocks the `user.me()` method.
      * @param options Optional response customization.
      */
-    me: async (init?: MockResult): Promise<void> => {
+    me: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
@@ -707,13 +791,16 @@ export class SdkMock {
         () => JSON.stringify(this.gen.user.user()),
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.usersMe(),
-          methods: ['GET'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.usersMe(),
+            methods: ['GET'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
   }
 
@@ -724,7 +811,7 @@ export class SdkMock {
     /**
      * Mocks the `file.list()` method.
      */
-    list: async (init?: MockListResult): Promise<void> => {
+    list: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
@@ -746,19 +833,22 @@ export class SdkMock {
         },
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.files(':oid'),
-          methods: ['GET'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.files(':oid'),
+            methods: ['GET'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Mocks the `file.createMeta()` method.
      */
-    createMeta: async (init?: MockResult): Promise<void> => {
+    createMeta: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 201,
@@ -771,48 +861,54 @@ export class SdkMock {
         () => JSON.stringify(this.gen.file.file()),
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.files(':oid'),
-          methods: ['POST'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.files(':oid'),
+            methods: ['POST'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Mocks the `file.createMedia()` method.
      */
-    createMedia: async (init?: MockResult): Promise<void> => {
+    createMedia: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
       // }
       const respond = this.createDefaultResponse(200, undefined, undefined, init)
-      await mock.add({
-        match: {
-          uri: RouteBuilder.fileMedia(':oid', ':id'),
-          methods: ['PUT'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.fileMedia(':oid', ':id'),
+            methods: ['PUT'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Mocks the `file.create()` method.
      */
-    create: async (init?: MockResult): Promise<void> => {
-      await this.file.createMeta(init)
+    create: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+      await this.file.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()
+      await this.file.createMedia(undefined, options)
     },
 
     /**
      * Mocks the `file.createFolder()` method.
      */
-    createFolder: async (init?: MockResult): Promise<void> => {
+    createFolder: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 201,
@@ -825,19 +921,22 @@ export class SdkMock {
         () => JSON.stringify(this.gen.file.folder()),
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.files(':oid'),
-          methods: ['POST'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.files(':oid'),
+            methods: ['POST'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Mocks the `file.read()` method.
      */
-    read: async (init?: MockResult): Promise<void> => {
+    read: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
@@ -850,19 +949,22 @@ export class SdkMock {
         () => JSON.stringify(this.gen.file.file()),
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.file(':oid', ':id'),
-          methods: ['GET'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.file(':oid', ':id'),
+            methods: ['GET'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Mocks the `file.readMedia()` method.
      */
-    readMedia: async (init?: MockResult): Promise<void> => {
+    readMedia: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
@@ -881,19 +983,22 @@ export class SdkMock {
         () => JSON.stringify({ data: this.gen.faker.lorem.sentences() }),
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.fileMedia(':oid', ':id'),
-          methods: ['GET'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.fileMedia(':oid', ':id'),
+            methods: ['GET'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Mocks the `file.readBulk()` method.
      */
-    readBulk: async (init?: MockListResult): Promise<void> => {
+    readBulk: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
@@ -913,19 +1018,22 @@ export class SdkMock {
         },
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.filesBatch(':oid'),
-          methods: ['POST'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.filesBatch(':oid'),
+            methods: ['POST'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Mocks the `file.patch()` method.
      */
-    patch: async (init?: MockResult): Promise<void> => {
+    patch: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
@@ -938,19 +1046,22 @@ export class SdkMock {
         () => JSON.stringify(this.gen.file.file()),
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.file(':oid', ':id'),
-          methods: ['PATCH'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.file(':oid', ':id'),
+            methods: ['PATCH'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Mocks the `file.patchMedia()` method.
      */
-    patchMedia: async (init?: MockResult): Promise<void> => {
+    patchMedia: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
@@ -963,55 +1074,64 @@ export class SdkMock {
         () => JSON.stringify(this.gen.patch.mediaPatchRevision()),
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.fileMedia(':oid', ':id'),
-          methods: ['PATCH'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.fileMedia(':oid', ':id'),
+            methods: ['PATCH'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Mocks the `file.delete()` method.
      */
-    delete: async (init?: MockResult): Promise<void> => {
+    delete: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 204,
       // }
       const respond = this.createDefaultResponse(204, undefined, undefined, init)
-      await mock.add({
-        match: {
-          uri: RouteBuilder.file(':oid', ':id'),
-          methods: ['DELETE'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.file(':oid', ':id'),
+            methods: ['DELETE'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Mocks the `file.deleteBulk()` method.
      */
-    deleteBulk: async (init?: MockResult): Promise<void> => {
+    deleteBulk: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 204,
       // }
       const respond = this.createDefaultResponse(204, undefined, undefined, init)
-      await mock.add({
-        match: {
-          uri: RouteBuilder.files(':oid'),
-          methods: ['DELETE'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.files(':oid'),
+            methods: ['DELETE'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Mocks the `file.patchUsers()` method.
      */
-    patchUsers: async (init?: MockResult): Promise<void> => {
+    patchUsers: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
@@ -1024,33 +1144,36 @@ export class SdkMock {
         () => JSON.stringify(this.gen.file.file()),
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.filesAccess(':oid', ':id'),
-          methods: ['PATCH'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.filesAccess(':oid', ':id'),
+            methods: ['PATCH'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Mocks the `file.addUser()` method.
      */
-    addUser: async (init?: MockResult): Promise<void> => {
-      await this.file.patchUsers(init)
+    addUser: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+      await this.file.patchUsers(init, options)
     },
 
     /**
      * Mocks the `file.removeUser()` method.
      */
-    removeUser: async (init?: MockResult): Promise<void> => {
-      await this.file.patchUsers(init)
+    removeUser: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+      await this.file.patchUsers(init, options)
     },
 
     /**
      * Mocks the `file.listUsers()` method.
      */
-    listUsers: async (init?: MockListResult): Promise<void> => {
+    listUsers: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
@@ -1072,19 +1195,22 @@ export class SdkMock {
         },
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.fileUsers(':oid', ':id'),
-          methods: ['GET'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.fileUsers(':oid', ':id'),
+            methods: ['GET'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
 
     /**
      * Mocks the `file.breadcrumbs()` method.
      */
-    breadcrumbs: async (init?: MockListResult): Promise<void> => {
+    breadcrumbs: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
@@ -1106,13 +1232,16 @@ export class SdkMock {
         },
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.fileBreadcrumbs(':oid', ':id'),
-          methods: ['GET'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.fileBreadcrumbs(':oid', ':id'),
+            methods: ['GET'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
   }
 
@@ -1120,7 +1249,7 @@ export class SdkMock {
    * Shared API mocks.
    */
   shared = {
-    list: async (init?: MockListResult): Promise<void> => {
+    list: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
@@ -1142,13 +1271,16 @@ export class SdkMock {
         },
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.shared(':oid'),
-          methods: ['GET'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.shared(':oid'),
+            methods: ['GET'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
   }
 
@@ -1156,7 +1288,7 @@ export class SdkMock {
    * Trash API mocks.
    */
   trash = {
-    list: async (init?: MockListResult): Promise<void> => {
+    list: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 200,
@@ -1178,55 +1310,405 @@ export class SdkMock {
         },
         init
       )
-      await mock.add({
-        match: {
-          uri: RouteBuilder.trash(':oid'),
-          methods: ['GET'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.trash(':oid'),
+            methods: ['GET'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
-    delete: async (init?: MockResult): Promise<void> => {
+    delete: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 204,
       // }
       const respond = this.createDefaultResponse(204, undefined, undefined, init)
-      await mock.add({
-        match: {
-          uri: RouteBuilder.trashBatchDelete(':oid'),
-          methods: ['DELETE'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.trashBatchDelete(':oid'),
+            methods: ['DELETE'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
-    restore: async (init?: MockResult): Promise<void> => {
+    restore: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 204,
       // }
       const respond = this.createDefaultResponse(204, undefined, undefined, init)
-      await mock.add({
-        match: {
-          uri: RouteBuilder.trashBatchRestore(':oid'),
-          methods: ['POST'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.trashBatchRestore(':oid'),
+            methods: ['POST'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
     },
-    empty: async (init?: MockResult): Promise<void> => {
+    empty: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
       const { mock } = this
       // const respond = init?.response ?? {
       //   status: 204,
       // }
       const respond = this.createDefaultResponse(204, undefined, undefined, init)
-      await mock.add({
-        match: {
-          uri: RouteBuilder.trashEmpty(':oid'),
-          methods: ['DELETE'],
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.trashEmpty(':oid'),
+            methods: ['DELETE'],
+          },
+          respond,
         },
-        respond,
-      })
+        options
+      )
+    },
+  }
+
+  /**
+   * Trash Data Catalog mocks.
+   */
+  dataCatalog = {
+    list: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
+      const { mock } = this
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => {
+          const obj: ContextListResult<DataCatalogSchemaWithVersion> = {
+            items: this.gen.dataCatalog.dataCatalogsWithVersion(init?.size ?? 5),
+            cursor: this.createCursorOption(init),
+          }
+          return JSON.stringify(obj)
+        },
+        init
+      )
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.dataCatalog(),
+            methods: ['GET'],
+          },
+          respond,
+        },
+        options
+      )
+    },
+
+    listVersions: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
+      const { mock } = this
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => {
+          const obj: ContextListResult<DataCatalogVersionInfo> = {
+            items: this.gen.dataCatalog.versionInfos(init?.size ?? 5),
+            cursor: this.createCursorOption(init),
+          }
+          return JSON.stringify(obj)
+        },
+        init
+      )
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.dataCatalogEntryVersions(':id'),
+            methods: ['GET'],
+          },
+          respond,
+        },
+        options
+      )
+    },
+
+    publish: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+      const { mock } = this
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => {
+          const obj = this.gen.dataCatalog.dataCatalog()
+          const result: ContextChangeRecord<DataCatalogSchema> = {
+            key: obj.key,
+            item: obj,
+            kind: obj.kind,
+          }
+          return JSON.stringify(result)
+        },
+        init
+      )
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.dataCatalog(),
+            methods: ['POST'],
+          },
+          respond,
+        },
+        options
+      )
+    },
+
+    read: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+      const { mock } = this
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: SerializedRequest) => {
+          const obj = this.gen.dataCatalog.dataCatalog({ key: req.params.id })
+          return JSON.stringify(obj)
+        },
+        init
+      )
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.dataCatalogEntry(':id'),
+            methods: ['GET'],
+          },
+          respond,
+        },
+        options
+      )
+    },
+
+    deprecate: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+      const { mock } = this
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: SerializedRequest) => {
+          const obj = this.gen.dataCatalog.dataCatalog({ key: req.params.id })
+          const result: ContextChangeRecord<DataCatalogSchema> = {
+            key: obj.key,
+            item: obj,
+            kind: obj.kind,
+          }
+          return JSON.stringify(result)
+        },
+        init
+      )
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.dataCatalogDeprecate(':id'),
+            methods: ['PUT'],
+          },
+          respond,
+        },
+        options
+      )
+    },
+
+    unpublish: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+      const { mock } = this
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: SerializedRequest) => {
+          const obj = this.gen.dataCatalog.dataCatalog({ key: req.params.id })
+          const result: ContextChangeRecord<DataCatalogSchema> = {
+            key: obj.key,
+            item: obj,
+            kind: obj.kind,
+          }
+          return JSON.stringify(result)
+        },
+        init
+      )
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.dataCatalogUnpublish(':id'),
+            methods: ['PUT'],
+          },
+          respond,
+        },
+        options
+      )
+    },
+
+    publishVersion: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+      const { mock } = this
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: SerializedRequest) => {
+          const raw = req.body as string
+          const body = JSON.parse(raw) as DataCatalogVersionSchema
+
+          const result: ContextChangeRecord<DataCatalogVersionSchema> = {
+            key: body.key,
+            item: body,
+            kind: body.kind,
+          }
+          return JSON.stringify(result)
+        },
+        init
+      )
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.dataCatalogEntryVersions(':id'),
+            methods: ['POST'],
+          },
+          respond,
+        },
+        options
+      )
+    },
+
+    readVersion: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+      const { mock } = this
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: SerializedRequest) => {
+          const obj = this.gen.dataCatalog.dataCatalogVersion({ key: req.params.vid, catalogKey: req.params.id })
+          return JSON.stringify(obj)
+        },
+        init
+      )
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.dataCatalogVersion(':id', ':vid'),
+            methods: ['GET'],
+          },
+          respond,
+        },
+        options
+      )
+    },
+
+    listDependencies: async (init?: MockListResult, options?: InterceptOptions): Promise<void> => {
+      const { mock } = this
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: SerializedRequest) => {
+          const requirements = JSON.parse(req.body as string) as { items: ForeignDomainDependency[] }
+          const items: 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())
+          }
+          const obj: ContextListResult<DataDomainSchema> = {
+            items: items,
+          }
+          return JSON.stringify(obj)
+        },
+        init
+      )
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.dataCatalogDependencies(),
+            methods: ['POST'],
+          },
+          respond,
+        },
+        options
+      )
+    },
+
+    deprecateVersion: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+      const { mock } = this
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: SerializedRequest) => {
+          const obj = this.gen.dataCatalog.dataCatalogVersion({ key: req.params.vid, catalogKey: req.params.id })
+          obj.deprecated = true
+          obj.deprecatedAt = this.gen.faker.date.past().getTime()
+          obj.deprecatedBy = nanoid()
+          const info = JSON.parse(req.body as string) as { reason: string }
+          obj.deprecationReason = info.reason
+          const result: ContextChangeRecord<DataCatalogVersionSchema> = {
+            key: obj.key,
+            item: obj,
+            kind: obj.kind,
+          }
+          return JSON.stringify(result)
+        },
+        init
+      )
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.dataCatalogVersionDeprecate(':id', ':vid'),
+            methods: ['PUT'],
+          },
+          respond,
+        },
+        options
+      )
+    },
+
+    unpublishVersion: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+      const { mock } = this
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: SerializedRequest) => {
+          const obj = this.gen.dataCatalog.dataCatalogVersion({ key: req.params.vid, catalogKey: req.params.id })
+          obj.unpublishedAt = this.gen.faker.date.past().getTime()
+          obj.scope = 'private'
+          const result: ContextChangeRecord<DataCatalogVersionSchema> = {
+            key: obj.key,
+            item: obj,
+            kind: obj.kind,
+          }
+          return JSON.stringify(result)
+        },
+        init
+      )
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.dataCatalogVersionUnpublish(':id', ':vid'),
+            methods: ['PUT'],
+          },
+          respond,
+        },
+        options
+      )
+    },
+
+    checkPublicationStatus: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+      const { mock } = this
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => {
+          const obj = this.gen.dataCatalog.dataCatalog() as DataCatalogStatus
+          obj.versions = this.gen.dataCatalog.versionInfos(1)
+          return JSON.stringify(obj)
+        },
+        init
+      )
+      await mock.add(
+        {
+          match: {
+            uri: RouteBuilder.dataCatalogStatus(':id'),
+            methods: ['GET'],
+          },
+          respond,
+        },
+        options
+      )
     },
   }
 }