@api-client/core 0.20.10 → 0.21.1

package/src/sdk/SdkNetworkMock.ts

@@ -0,0 +1,1607 @@
+import type {
+  Network,
+  NetworkRespondPayload,
+  NetworkRespondDynamic,
+  CapturedRequest,
+  NetworkInterceptor,
+} from '@pawel-up/lupa/network'
+import { RouteBuilder } from './RouteBuilder.js'
+import { ModelingMock } from '../mocking/ModelingMock.js'
+import { ResourceResponse } from './SdkBase.js'
+import { ContextChangeRecord, ContextListResult, isAtomicFilter, QueryFilter } from '../events/BaseEvents.js'
+import { DataCatalogSchema, DataCatalogStatus } from '../models/DataCatalog.js'
+import { DataCatalogVersionSchema } from '../models/DataCatalogVersion.js'
+import { nanoid } from '../nanoid.js'
+import { ForeignDomainDependency } from '../modeling/types.js'
+import { DataDomain, DataDomainSchema } from '../modeling/DataDomain.js'
+import { AiSessionApp } from '../models/AiSession.js'
+import { CreateDeploymentPayload, DeploymentLatestEnvironments } from './DeploymentsSdk.js'
+import { DeploymentEnvironment, DeploymentSchema, DeploymentStatus } from '../models/store/Deployment.js'
+
+export interface MockResourceInit {
+  /**
+   * Custom response generator for the mock intercept.
+   */
+  response?: NetworkRespondPayload
+  /**
+   * If true, the request body will be generated using the body generator.
+   * It is useful when only setting up response headers or status code, but
+   * the request body should still be generated, even when missing in the `response` option.
+   */
+  forceBody?: boolean
+  /**
+   * Allows to override the base URI for the mock. It is useful when you want to mock a request
+   * to a different base URI than the one set in the constructor.
+   */
+  baseUri?: string
+}
+
+export interface MockListInit extends MockResourceInit {
+  /**
+   * Number of items to generate in the list response.
+   */
+  size?: number
+  /**
+   * If true, the response will include a cursor for pagination.
+   * If false, the response will not include a cursor.
+   * If not set, a random choice will be made.
+   * If string, the exact cursor value will be used.
+   */
+  cursor?: boolean | string
+}
+
+/**
+ * A helper class for generating mock responses for the SDK.
+ * Uses the Lupa Network for mocking.
+ *
+ * @example
+ * ```typescript
+ * import { SdkNetworkMock } from './SdkNetworkMock.js';
+ * import { Network } from '@pawel-up/lupa/network';
+ *
+ * const network = new Network();
+ * const mocker = new SdkNetworkMock();
+ *
+ * await mocker.dataCatalog.list(network);
+ * ```
+ */
+export class SdkNetworkMock {
+  gen = new ModelingMock()
+
+  private readonly baseUrl?: string
+
+  /**
+   * @param baseUrl The base URI to be used to construct the URL.
+   */
+  public constructor(baseUrl?: string) {
+    if (baseUrl) {
+      this.baseUrl = baseUrl.endsWith('/') ? baseUrl.slice(0, -1) : baseUrl
+    }
+  }
+
+  protected createDefaultResponse(
+    status: number,
+    headers?: Record<string, string>,
+    body?: (req: CapturedRequest) => string,
+    userConfig?: MockResourceInit
+  ): NetworkRespondPayload | NetworkRespondDynamic {
+    let hasBodyGenerator = false
+    if (!userConfig?.response?.body && userConfig?.forceBody && body) {
+      // when body is missing and forceBody is set, generate the body
+      hasBodyGenerator = true
+    } else if (body && (!userConfig || !userConfig.response)) {
+      // we set the body by default when the user config is missing
+      hasBodyGenerator = true
+    }
+
+    if (hasBodyGenerator && body) {
+      return (req: CapturedRequest) => ({ status, headers, body: body(req) })
+    }
+
+    let respond: NetworkRespondPayload
+    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 (userConfig?.response?.body) {
+      // body is fixed.
+      respond.body = userConfig.response.body
+    }
+    return respond
+  }
+
+  /**
+   * 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?: MockListInit): 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: MockListInit = {}): 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()
+  }
+
+  /**
+   * Builds a route by joining the base URL with the given path.
+   * @param path - The path to join.
+   * @returns The built route.
+   */
+  protected buildRoute(path: string, init?: MockListInit): string {
+    const baseUrl = init?.baseUri ?? this.baseUrl
+    if (!baseUrl) {
+      return path
+    }
+    const relativePath = path.startsWith('/') ? path : '/' + path
+    return `${baseUrl}${relativePath}`
+  }
+
+  /**
+   * Organization API mocks.
+   */
+  organizations = {
+    /**
+     * Adds an intercept to mock the `organizations.list()` method.
+     * @param network Lupa network instance
+     * @param init Optional response configuration
+     */
+    list: (network: Network, init?: MockListInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.wrapList(this.gen.organization.organizations(init?.size ?? 5), init),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.organizations(), init),
+          methods: ['GET'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Adds an intercept to mock the `organizations.create()` method.
+     * @param network Lupa network instance
+     * @param init Optional response configuration
+     */
+    create: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.wrapResource(this.gen.organization.organization()),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.organizations(), init),
+          methods: ['POST'],
+        },
+        respond,
+      })
+    },
+
+    invitations: {
+      list: (network: Network, init?: MockListInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.wrapList(this.gen.invitation.invitations(init?.size ?? 5), init),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.invitations(':oid'), init),
+            methods: ['GET'],
+          },
+          respond,
+        })
+      },
+      create: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.wrapResource(this.gen.invitation.invitation()),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.invitations(':oid'), init),
+            methods: ['POST'],
+          },
+          respond,
+        })
+      },
+      findByToken: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.wrapResource(this.gen.invitation.invitation()),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.findInvitation(), init),
+            methods: ['GET'],
+          },
+          respond,
+        })
+      },
+      decline: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.wrapResource(this.gen.invitation.invitation()),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.declineInvitation(':oid', ':id'), init),
+            methods: ['POST'],
+          },
+          respond,
+        })
+      },
+      delete: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.wrapResource(this.gen.invitation.invitation()),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.invitation(':oid', ':id'), init),
+            methods: ['DELETE'],
+          },
+          respond,
+        })
+      },
+      patch: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.wrapResource(this.gen.invitation.invitation()),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.invitation(':oid', ':id'), init),
+            methods: ['PATCH'],
+          },
+          respond,
+        })
+      },
+      resend: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.wrapResource(this.gen.invitation.invitation()),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.resendInvitation(':oid', ':id'), init),
+            methods: ['PUT'],
+          },
+          respond,
+        })
+      },
+    },
+
+    users: {
+      list: (network: Network, init?: MockListInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.wrapList(this.gen.users.users(init?.size ?? 5), init),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.organizationUsers(':oid'), init),
+            methods: ['GET'],
+          },
+          respond,
+        })
+      },
+      read: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.wrapResource(this.gen.users.user()),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.organizationUser(':oid', ':id'), init),
+            methods: ['GET'],
+          },
+          respond,
+        })
+      },
+      readBatch: (network: Network, init?: MockListInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.wrapList(this.gen.users.users(init?.size ?? 5), init),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.organizationUserBatch(':oid'), init),
+            methods: ['POST'],
+          },
+          respond,
+        })
+      },
+      activate: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.wrapResource(this.gen.users.user()),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.organizationUserActivate(':oid', ':id'), init),
+            methods: ['POST'],
+          },
+          respond,
+        })
+      },
+      deactivate: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.wrapResource(this.gen.users.user()),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.organizationUserDeactivate(':oid', ':id'), init),
+            methods: ['POST'],
+          },
+          respond,
+        })
+      },
+      delete: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(204, undefined, undefined, init)
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.organizationUser(':oid', ':id'), init),
+            methods: ['DELETE'],
+          },
+          respond,
+        })
+      },
+    },
+
+    slugs: {
+      /**
+       * Mocks the `slugs.validate()` method.
+       * @param options Optional response customization.
+       */
+      validate: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.wrapResource(this.gen.organization.organizationSlugValidateResponse()),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.orgSlugValidate(), init),
+            methods: ['POST'],
+          },
+          respond,
+        })
+      },
+
+      /**
+       * Mocks the `slugs.generate()` method.
+       * @param options Optional response customization.
+       */
+      generate: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.wrapResource(this.gen.organization.organizationSlugGenerateResponse()),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.orgSlugGenerate(), init),
+            methods: ['POST'],
+          },
+          respond,
+        })
+      },
+    },
+  }
+
+  /**
+   * Group API mocks.
+   */
+  groups = {
+    /**
+     * Mocks the `groups.list()` method.
+     * @param options Optional response customization.
+     */
+    list: (network: Network, init?: MockListInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.wrapList(this.gen.group.groups(init?.size ?? 5), init),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.groups(':oid'), init),
+          methods: ['GET'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Mocks the `groups.create()` method.
+     * @param options Optional response customization.
+     */
+    create: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        201,
+        { 'content-type': 'application/json' },
+        () => this.wrapResource(this.gen.group.group()),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.groups(':oid'), init),
+          methods: ['POST'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Mocks the `groups.update()` method.
+     * @param options Optional response customization.
+     */
+    update: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.wrapResource(this.gen.group.group()),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.group(':oid', ':key'), init),
+          methods: ['PUT'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Mocks the `groups.delete()` method.
+     * @param options Optional response customization.
+     */
+    delete: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(204, undefined, undefined, init)
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.group(':oid', ':key'), init),
+          methods: ['DELETE'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Mocks the `groups.addUsers()` method.
+     */
+    addUsers: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.wrapResource(this.gen.group.group()),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.groupUsers(':oid', ':key'), init),
+          methods: ['POST'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Mocks the `groups.removeUsers()` method.
+     */
+    removeUsers: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.wrapResource(this.gen.group.group()),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.groupUsers(':oid', ':key'), init),
+          methods: ['DELETE'],
+        },
+        respond,
+      })
+    },
+  }
+
+  ai = {
+    sessions: {
+      list: (network: Network, init?: MockListInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.wrapList(this.gen.ai.sessions('general', init?.size ?? 5), init),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.aiSessions(':oid', ':app' as AiSessionApp), init),
+            methods: ['GET'],
+          },
+          respond,
+        })
+      },
+      create: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          201,
+          { 'content-type': 'application/json' },
+          () => this.gen.wrapResource(this.gen.ai.session()),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.aiSessions(':oid', ':app' as AiSessionApp), init),
+            methods: ['POST'],
+          },
+          respond,
+        })
+      },
+      read: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.gen.wrapResource(this.gen.ai.session()),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.aiSession(':oid', ':app' as AiSessionApp, ':sid'), init),
+            methods: ['GET'],
+          },
+          respond,
+        })
+      },
+      update: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.gen.wrapResource(this.gen.ai.session()),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.aiSession(':oid', ':app' as AiSessionApp, ':sid'), init),
+            methods: ['PUT'],
+          },
+          respond,
+        })
+      },
+      delete: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(204, undefined, undefined, init)
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.aiSession(':oid', ':app' as AiSessionApp, ':sid'), init),
+            methods: ['DELETE'],
+          },
+          respond,
+        })
+      },
+    },
+
+    messages: {
+      list: (network: Network, init?: MockListInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.wrapList(this.gen.ai.messages(init?.size ?? 5), init),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.aiMessages(':oid', ':sid'), init),
+            methods: ['GET'],
+          },
+          respond,
+        })
+      },
+      update: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.gen.wrapResource(this.gen.ai.message()),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.aiMessage(':oid', ':sid', ':mid'), init),
+            methods: ['PUT'],
+          },
+          respond,
+        })
+      },
+      delete: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(204, undefined, undefined, init)
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.aiMessage(':oid', ':sid', ':mid'), init),
+            methods: ['DELETE'],
+          },
+          respond,
+        })
+      },
+    },
+
+    modifyDomain: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      // Return a basic JSON response simulating the stream end state for simplicity if not overriding.
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'text/event-stream' },
+        () => 'event: done\ndata: {}\n\n',
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.aiModifyDomain(':oid', ':fid'), init),
+          methods: ['POST'],
+        },
+        respond,
+      })
+    },
+  }
+
+  /**
+   * User API mocks.
+   */
+  users = {
+    /**
+     * Mocks the `user.me()` method.
+     * @param options Optional response customization.
+     */
+    me: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.gen.wrapResource(this.gen.users.user()),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.usersMe(), init),
+          methods: ['GET'],
+        },
+        respond,
+      })
+    },
+  }
+
+  /**
+   * Files API mocks.
+   */
+  files = {
+    /**
+     * Mocks the `file.list()` method.
+     */
+    list: (network: Network, init?: MockListInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.wrapList(this.gen.files.files(init?.size ?? 5), init),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.files(':oid'), init),
+          methods: ['GET'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Mocks the `file.createMeta()` method.
+     */
+    createMeta: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        201,
+        { 'content-type': 'application/json' },
+        () => this.gen.wrapResource(this.gen.files.file()),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.files(':oid'), init),
+          methods: ['POST'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Mocks the `file.createMedia()` method.
+     */
+    createMedia: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(200, undefined, undefined, init)
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.fileMedia(':oid', ':id'), init),
+          methods: ['PUT'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Mocks the `file.create()` method.
+     */
+    create: async (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      await this.files.createMeta(network, init)
+      // 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.
+      return this.files.createMedia(network, init)
+    },
+
+    /**
+     * Mocks the `file.createFolder()` method.
+     */
+    createFolder: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        201,
+        { 'content-type': 'application/json' },
+        () => this.gen.wrapResource(this.gen.files.folder()),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.files(':oid'), init),
+          methods: ['POST'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Mocks the `file.read()` method.
+     */
+    read: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.gen.wrapResource(this.gen.files.file()),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.file(':oid', ':id'), init),
+          methods: ['GET'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Mocks the `file.readMedia()` method.
+     */
+    readMedia: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        {
+          'content-type': 'application/json',
+          'x-version': `${this.gen.faker.number.int({ min: 1, max: 100 })}`,
+        },
+        () => this.gen.wrapResource({ data: this.gen.faker.lorem.sentences() }),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.fileMedia(':oid', ':id'), init),
+          methods: ['GET'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Mocks the `file.readBulk()` method.
+     */
+    readBulk: (network: Network, init?: MockListInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.wrapList(this.gen.files.files(init?.size ?? 5), { cursor: false }),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.filesBatch(':oid'), init),
+          methods: ['POST'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Mocks the `file.patch()` method.
+     */
+    patch: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.gen.wrapResource(this.gen.files.file()),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.file(':oid', ':id'), init),
+          methods: ['PATCH'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Mocks the `file.patchMedia()` method.
+     */
+    patchMedia: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.gen.wrapResource(this.gen.patch.mediaPatchRevision()),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.fileMedia(':oid', ':id'), init),
+          methods: ['PATCH'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Mocks the `file.delete()` method.
+     */
+    delete: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(204, undefined, undefined, init)
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.file(':oid', ':id'), init),
+          methods: ['DELETE'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Mocks the `file.deleteBulk()` method.
+     */
+    deleteBulk: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(204, undefined, undefined, init)
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.files(':oid'), init),
+          methods: ['DELETE'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Mocks the `file.patchUsers()` method.
+     */
+    patchUsers: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.gen.wrapResource(this.gen.files.file()),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.filesAccess(':oid', ':id'), init),
+          methods: ['PATCH'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Mocks the `file.addUser()` method.
+     */
+    addUser: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      return this.files.patchUsers(network, init)
+    },
+
+    /**
+     * Mocks the `file.removeUser()` method.
+     */
+    removeUser: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      return this.files.patchUsers(network, init)
+    },
+
+    /**
+     * Mocks the `file.listUsers()` method.
+     */
+    listUsers: (network: Network, init?: MockListInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.wrapList(this.gen.users.users(init?.size ?? 5), init),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.fileUsers(':oid', ':id'), init),
+          methods: ['GET'],
+        },
+        respond,
+      })
+    },
+
+    /**
+     * Mocks the `file.breadcrumbs()` method.
+     */
+    breadcrumbs: (network: Network, init?: MockListInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.wrapList(this.gen.files.fileBreadcrumbs(init?.size ?? 5), init),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.fileBreadcrumbs(':oid', ':id'), init),
+          methods: ['GET'],
+        },
+        respond,
+      })
+    },
+  }
+
+  /**
+   * Shared API mocks.
+   */
+  shared = {
+    list: async (network: Network, init?: MockListInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.wrapList(this.gen.files.files(init?.size ?? 5), init),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.shared(':oid'), init),
+          methods: ['GET'],
+        },
+        respond,
+      })
+    },
+  }
+
+  /**
+   * Trash API mocks.
+   */
+  trash = {
+    list: async (network: Network, init?: MockListInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.wrapList(this.gen.trash.trashEntries(init?.size ?? 5), init),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.trash(':oid'), init),
+          methods: ['GET'],
+        },
+        respond,
+      })
+    },
+    delete: async (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(204, undefined, undefined, init)
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.trashBatchDelete(':oid'), init),
+          methods: ['DELETE'],
+        },
+        respond,
+      })
+    },
+    restore: async (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(204, undefined, undefined, init)
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.trashBatchRestore(':oid'), init),
+          methods: ['POST'],
+        },
+        respond,
+      })
+    },
+    empty: async (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(204, undefined, undefined, init)
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.trashEmpty(':oid'), init),
+          methods: ['DELETE'],
+        },
+        respond,
+      })
+    },
+  }
+
+  /**
+   * Deployments API mocks.
+   */
+  deployments = {
+    list: async (network: Network, init?: MockListInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: CapturedRequest) => {
+          const { query } = req
+          const filter = this.decodeFilter(query.filter)
+          const schema: Partial<DeploymentSchema> = {}
+          if (isAtomicFilter(filter)) {
+            if (filter.field === 'fid') {
+              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
+              }
+            })
+          }
+          return this.wrapList(data, init)
+        },
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.deployments(':oid'), init),
+          methods: ['GET'],
+        },
+        respond,
+      })
+    },
+    create: async (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        202,
+        { 'content-type': 'application/json' },
+        (req: CapturedRequest) => {
+          const raw = req.body as string
+          const payload = JSON.parse(raw) as CreateDeploymentPayload
+          const obj = this.gen.deployments.deployment({
+            orgId: req.params?.oid,
+            apiId: payload.fid,
+            modelVersion: payload.modelVersion,
+            env: payload.env,
+            ...(payload.env === DeploymentEnvironment.PROD ? { version: payload.version } : {}),
+          })
+          return this.gen.wrapResource(obj)
+        },
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.deployments(':oid'), init),
+          methods: ['POST'],
+        },
+        respond,
+      })
+    },
+    read: async (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: CapturedRequest) => {
+          const obj = this.gen.deployments.deployment({
+            key: req.params?.id,
+            orgId: req.params?.oid,
+          })
+          return this.gen.wrapResource(obj)
+        },
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.deployment(':oid', ':id'), init),
+          methods: ['GET'],
+        },
+        respond,
+      })
+    },
+    deactivate: async (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: CapturedRequest) => {
+          const obj = this.gen.deployments.deployment({
+            key: req.params?.id,
+            orgId: req.params?.oid,
+            status: DeploymentStatus.Inactive,
+          })
+          return this.gen.wrapResource(obj)
+        },
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.deployment(':oid', ':id'), init),
+          methods: ['DELETE'],
+        },
+        respond,
+      })
+    },
+    apis: {
+      getLatestPerEnvironment: async (
+        network: Network,
+        init?: MockResourceInit & { prod?: boolean; staging?: boolean; dev?: boolean }
+      ): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => {
+            const obj: DeploymentLatestEnvironments = {}
+            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.prod = this.gen.deployments.deployment()
+            }
+            if (hasStaging) {
+              obj.staging = this.gen.deployments.deployment()
+            }
+            if (hasDev) {
+              obj.dev = this.gen.deployments.deployment()
+            }
+            return this.gen.wrapResource(obj)
+          },
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.deploymentsApisByEnvLatest(':oid', ':fileId'), init),
+            methods: ['GET'],
+          },
+          respond,
+        })
+      },
+      list: async (network: Network, init?: MockListInit): Promise<NetworkInterceptor> => {
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => this.wrapList(this.gen.deployments.deploymentApis(init?.size ?? 5), { cursor: false }),
+          init
+        )
+        return network.mock({
+          match: {
+            uri: this.buildRoute(RouteBuilder.deploymentsApis(':oid'), init),
+            methods: ['GET'],
+          },
+          respond,
+        })
+      },
+    },
+  }
+
+  /**
+   * Trash Data Catalog mocks.
+   */
+  dataCatalog = {
+    list: (network: Network, init?: MockListInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.wrapList(this.gen.dataCatalog.dataCatalogsWithVersion(init?.size ?? 5), init),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.dataCatalog(), init),
+          methods: ['GET'],
+        },
+        respond,
+      })
+    },
+
+    listVersions: (network: Network, init?: MockListInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        () => this.wrapList(this.gen.dataCatalog.versionInfos(init?.size ?? 5), init),
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.dataCatalogEntryVersions(':id'), init),
+          methods: ['GET'],
+        },
+        respond,
+      })
+    },
+
+    publish: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      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 this.gen.wrapResource(result)
+        },
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.dataCatalog(), init),
+          methods: ['POST'],
+        },
+        respond,
+      })
+    },
+
+    read: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: CapturedRequest) => {
+          const obj = this.gen.dataCatalog.dataCatalog({ key: req.params?.id })
+          return this.gen.wrapResource(obj)
+        },
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.dataCatalogEntry(':id'), init),
+          methods: ['GET'],
+        },
+        respond,
+      })
+    },
+
+    deprecate: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: CapturedRequest) => {
+          const obj = this.gen.dataCatalog.dataCatalog({ key: req.params?.id })
+          const result: ContextChangeRecord<DataCatalogSchema> = {
+            key: obj.key,
+            item: obj,
+            kind: obj.kind,
+          }
+          return this.gen.wrapResource(result)
+        },
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.dataCatalogDeprecate(':id'), init),
+          methods: ['PUT'],
+        },
+        respond,
+      })
+    },
+
+    unpublish: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: CapturedRequest) => {
+          const obj = this.gen.dataCatalog.dataCatalog({ key: req.params?.id })
+          const result: ContextChangeRecord<DataCatalogSchema> = {
+            key: obj.key,
+            item: obj,
+            kind: obj.kind,
+          }
+          return this.gen.wrapResource(result)
+        },
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.dataCatalogUnpublish(':id'), init),
+          methods: ['PUT'],
+        },
+        respond,
+      })
+    },
+
+    publishVersion: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: CapturedRequest) => {
+          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 this.gen.wrapResource(result)
+        },
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.dataCatalogEntryVersions(':id'), init),
+          methods: ['POST'],
+        },
+        respond,
+      })
+    },
+
+    readVersion: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: CapturedRequest) => {
+          const obj = this.gen.dataCatalog.dataCatalogVersion({ key: req.params?.vid, catalogKey: req.params?.id })
+          return this.gen.wrapResource(obj)
+        },
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.dataCatalogVersion(':id', ':vid'), init),
+          methods: ['GET'],
+        },
+        respond,
+      })
+    },
+
+    listDependencies: (network: Network, init?: MockListInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: CapturedRequest) => {
+          const requirements = JSON.parse(req.body as string) as { items: ForeignDomainDependency[] }
+          const data: DataDomainSchema[] = []
+          for (const item of requirements.items) {
+            const domain = new DataDomain({
+              key: item.key,
+              info: { name: `Domain ${item.key}`, version: item.version },
+            })
+            data.push(domain.toJSON())
+          }
+          return this.wrapList(data, { cursor: false })
+        },
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.dataCatalogDependencies(), init),
+          methods: ['POST'],
+        },
+        respond,
+      })
+    },
+
+    deprecateVersion: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: CapturedRequest) => {
+          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 this.gen.wrapResource(result)
+        },
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.dataCatalogVersionDeprecate(':id', ':vid'), init),
+          methods: ['PUT'],
+        },
+        respond,
+      })
+    },
+
+    unpublishVersion: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      const respond = this.createDefaultResponse(
+        200,
+        { 'content-type': 'application/json' },
+        (req: CapturedRequest) => {
+          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 this.gen.wrapResource(result)
+        },
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.dataCatalogVersionUnpublish(':id', ':vid'), init),
+          methods: ['PUT'],
+        },
+        respond,
+      })
+    },
+
+    checkPublicationStatus: (network: Network, init?: MockResourceInit): Promise<NetworkInterceptor> => {
+      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 this.gen.wrapResource(obj)
+        },
+        init
+      )
+      return network.mock({
+        match: {
+          uri: this.buildRoute(RouteBuilder.dataCatalogStatus(':id'), init),
+          methods: ['GET'],
+        },
+        respond,
+      })
+    },
+  }
+
+  //
+  // 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: CapturedRequest, init?: MockListInit): 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
+  }
+}