@api-client/core 0.18.40 → 0.18.46

package/src/sdk/SdkMock.ts

@@ -4,16 +4,27 @@ import {
   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 {
   /**
@@ -150,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
@@ -171,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
   }
@@ -1362,4 +1373,342 @@ export class SdkMock {
       )
     },
   }
+
+  /**
+   * 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
+      )
+    },
+  }
 }