@api-client/core 0.18.39 → 0.18.41

package/build/src/sdk/SdkMock.js

@@ -1,6 +1,8 @@
-import { setupWorker } from '@jarrodek/amw';
+import { setupWorker, } from '@jarrodek/amw';
 import { RouteBuilder } from './RouteBuilder.js';
 import { ModelingMock } from '../mocking/ModelingMock.js';
+import { DataDomain } from '../modeling/DataDomain.js';
+import { nanoid } from '../nanoid.js';
 /**
  * SDK mocking utility for testing. Uses Service Workers to intercept HTTP requests
  * and provide mock responses for API calls.
@@ -56,6 +58,10 @@ import { ModelingMock } from '../mocking/ModelingMock.js';
  * // 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 {
     options;
@@ -119,11 +125,11 @@ 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) => 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) => body(req);
         }
         return respond;
     }
@@ -135,7 +141,7 @@ export class SdkMock {
          * Adds an intercept to mock the `organizations.list()` method.
          * @param options Optional response configuration
          */
-        list: async (init) => {
+        list: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -155,13 +161,13 @@ export class SdkMock {
                     methods: ['GET'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Adds an intercept to mock the `organizations.create()` method.
          * @param options Optional response configuration
          */
-        create: async (init) => {
+        create: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -175,10 +181,10 @@ export class SdkMock {
                     methods: ['POST'],
                 },
                 respond,
-            });
+            }, options);
         },
         invitations: {
-            list: async (init) => {
+            list: async (init, options) => {
                 const { mock } = this;
                 // const respond = init?.response ?? {
                 //   status: 200,
@@ -201,9 +207,9 @@ export class SdkMock {
                         methods: ['GET'],
                     },
                     respond,
-                });
+                }, options);
             },
-            create: async (init) => {
+            create: async (init, options) => {
                 const { mock } = this;
                 // const respond = init?.response ?? {
                 //   status: 200,
@@ -217,9 +223,9 @@ export class SdkMock {
                         methods: ['POST'],
                     },
                     respond,
-                });
+                }, options);
             },
-            findByToken: async (init) => {
+            findByToken: async (init, options) => {
                 const { mock } = this;
                 // const respond = init?.response ?? {
                 //   status: 200,
@@ -233,9 +239,9 @@ export class SdkMock {
                         methods: ['GET'],
                     },
                     respond,
-                });
+                }, options);
             },
-            decline: async (init) => {
+            decline: async (init, options) => {
                 const { mock } = this;
                 // const respond = init?.response ?? {
                 //   status: 200,
@@ -249,9 +255,9 @@ export class SdkMock {
                         methods: ['POST'],
                     },
                     respond,
-                });
+                }, options);
             },
-            delete: async (init) => {
+            delete: async (init, options) => {
                 const { mock } = this;
                 // const respond = init?.response ?? {
                 //   status: 200,
@@ -265,9 +271,9 @@ export class SdkMock {
                         methods: ['DELETE'],
                     },
                     respond,
-                });
+                }, options);
             },
-            patch: async (init) => {
+            patch: async (init, options) => {
                 const { mock } = this;
                 // const respond = init?.response ?? {
                 //   status: 200,
@@ -281,9 +287,9 @@ export class SdkMock {
                         methods: ['PATCH'],
                     },
                     respond,
-                });
+                }, options);
             },
-            resend: async (init) => {
+            resend: async (init, options) => {
                 const { mock } = this;
                 // const respond = init?.response ?? {
                 //   status: 200,
@@ -297,11 +303,11 @@ export class SdkMock {
                         methods: ['PUT'],
                     },
                     respond,
-                });
+                }, options);
             },
         },
         users: {
-            list: async (init) => {
+            list: async (init, options) => {
                 const { mock } = this;
                 // const respond = init?.response ?? {
                 //   status: 200,
@@ -324,9 +330,9 @@ export class SdkMock {
                         methods: ['GET'],
                     },
                     respond,
-                });
+                }, options);
             },
-            read: async (init) => {
+            read: async (init, options) => {
                 const { mock } = this;
                 // const respond = init?.response ?? {
                 //   status: 200,
@@ -340,9 +346,9 @@ export class SdkMock {
                         methods: ['GET'],
                     },
                     respond,
-                });
+                }, options);
             },
-            readBatch: async (init) => {
+            readBatch: async (init, options) => {
                 const { mock } = this;
                 const path = RouteBuilder.organizationUserBatch(':oid');
                 const respond = init?.response ?? {
@@ -359,9 +365,9 @@ export class SdkMock {
                         methods: ['POST'],
                     },
                     respond,
-                });
+                }, options);
             },
-            activate: async (init) => {
+            activate: async (init, options) => {
                 const { mock } = this;
                 // const respond = init?.response ?? {
                 //   status: 200,
@@ -375,9 +381,9 @@ export class SdkMock {
                         methods: ['POST'],
                     },
                     respond,
-                });
+                }, options);
             },
-            deactivate: async (init) => {
+            deactivate: async (init, options) => {
                 const { mock } = this;
                 // const respond = init?.response ?? {
                 //   status: 200,
@@ -391,9 +397,9 @@ export class SdkMock {
                         methods: ['POST'],
                     },
                     respond,
-                });
+                }, options);
             },
-            delete: async (init) => {
+            delete: async (init, options) => {
                 const { mock } = this;
                 // const respond = init?.response ?? {
                 //   status: 204,
@@ -405,7 +411,7 @@ export class SdkMock {
                         methods: ['DELETE'],
                     },
                     respond,
-                });
+                }, options);
             },
         },
     };
@@ -417,7 +423,7 @@ export class SdkMock {
          * Mocks the `groups.list()` method.
          * @param options Optional response customization.
          */
-        list: async (init) => {
+        list: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -440,13 +446,13 @@ export class SdkMock {
                     methods: ['GET'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Mocks the `groups.create()` method.
          * @param options Optional response customization.
          */
-        create: async (init) => {
+        create: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 201,
@@ -460,13 +466,13 @@ export class SdkMock {
                     methods: ['POST'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Mocks the `groups.update()` method.
          * @param options Optional response customization.
          */
-        update: async (init) => {
+        update: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -480,13 +486,13 @@ export class SdkMock {
                     methods: ['PATCH'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Mocks the `groups.delete()` method.
          * @param options Optional response customization.
          */
-        delete: async (init) => {
+        delete: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 204,
@@ -498,12 +504,12 @@ export class SdkMock {
                     methods: ['DELETE'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Mocks the `groups.addUsers()` method.
          */
-        addUsers: async (init) => {
+        addUsers: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -517,12 +523,12 @@ export class SdkMock {
                     methods: ['POST'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Mocks the `groups.removeUsers()` method.
          */
-        removeUsers: async (init) => {
+        removeUsers: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -536,7 +542,7 @@ export class SdkMock {
                     methods: ['DELETE'],
                 },
                 respond,
-            });
+            }, options);
         },
     };
     /**
@@ -547,7 +553,7 @@ export class SdkMock {
          * Mocks the `user.me()` method.
          * @param options Optional response customization.
          */
-        me: async (init) => {
+        me: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -561,7 +567,7 @@ export class SdkMock {
                     methods: ['GET'],
                 },
                 respond,
-            });
+            }, options);
         },
     };
     /**
@@ -571,7 +577,7 @@ export class SdkMock {
         /**
          * Mocks the `file.list()` method.
          */
-        list: async (init) => {
+        list: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -594,12 +600,12 @@ export class SdkMock {
                     methods: ['GET'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Mocks the `file.createMeta()` method.
          */
-        createMeta: async (init) => {
+        createMeta: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 201,
@@ -613,12 +619,12 @@ export class SdkMock {
                     methods: ['POST'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Mocks the `file.createMedia()` method.
          */
-        createMedia: async (init) => {
+        createMedia: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -630,22 +636,22 @@ export class SdkMock {
                     methods: ['PUT'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Mocks the `file.create()` method.
          */
-        create: async (init) => {
-            await this.file.createMeta(init);
+        create: async (init, options) => {
+            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) => {
+        createFolder: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 201,
@@ -659,12 +665,12 @@ export class SdkMock {
                     methods: ['POST'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Mocks the `file.read()` method.
          */
-        read: async (init) => {
+        read: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -678,12 +684,12 @@ export class SdkMock {
                     methods: ['GET'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Mocks the `file.readMedia()` method.
          */
-        readMedia: async (init) => {
+        readMedia: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -703,12 +709,12 @@ export class SdkMock {
                     methods: ['GET'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Mocks the `file.readBulk()` method.
          */
-        readBulk: async (init) => {
+        readBulk: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -729,12 +735,12 @@ export class SdkMock {
                     methods: ['POST'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Mocks the `file.patch()` method.
          */
-        patch: async (init) => {
+        patch: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -748,12 +754,12 @@ export class SdkMock {
                     methods: ['PATCH'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Mocks the `file.patchMedia()` method.
          */
-        patchMedia: async (init) => {
+        patchMedia: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -767,12 +773,12 @@ export class SdkMock {
                     methods: ['PATCH'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Mocks the `file.delete()` method.
          */
-        delete: async (init) => {
+        delete: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 204,
@@ -784,12 +790,12 @@ export class SdkMock {
                     methods: ['DELETE'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Mocks the `file.deleteBulk()` method.
          */
-        deleteBulk: async (init) => {
+        deleteBulk: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 204,
@@ -801,12 +807,12 @@ export class SdkMock {
                     methods: ['DELETE'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Mocks the `file.patchUsers()` method.
          */
-        patchUsers: async (init) => {
+        patchUsers: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -820,24 +826,24 @@ export class SdkMock {
                     methods: ['PATCH'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Mocks the `file.addUser()` method.
          */
-        addUser: async (init) => {
-            await this.file.patchUsers(init);
+        addUser: async (init, options) => {
+            await this.file.patchUsers(init, options);
         },
         /**
          * Mocks the `file.removeUser()` method.
          */
-        removeUser: async (init) => {
-            await this.file.patchUsers(init);
+        removeUser: async (init, options) => {
+            await this.file.patchUsers(init, options);
         },
         /**
          * Mocks the `file.listUsers()` method.
          */
-        listUsers: async (init) => {
+        listUsers: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -860,12 +866,12 @@ export class SdkMock {
                     methods: ['GET'],
                 },
                 respond,
-            });
+            }, options);
         },
         /**
          * Mocks the `file.breadcrumbs()` method.
          */
-        breadcrumbs: async (init) => {
+        breadcrumbs: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -888,14 +894,14 @@ export class SdkMock {
                     methods: ['GET'],
                 },
                 respond,
-            });
+            }, options);
         },
     };
     /**
      * Shared API mocks.
      */
     shared = {
-        list: async (init) => {
+        list: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -918,14 +924,14 @@ export class SdkMock {
                     methods: ['GET'],
                 },
                 respond,
-            });
+            }, options);
         },
     };
     /**
      * Trash API mocks.
      */
     trash = {
-        list: async (init) => {
+        list: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 200,
@@ -948,9 +954,9 @@ export class SdkMock {
                     methods: ['GET'],
                 },
                 respond,
-            });
+            }, options);
         },
-        delete: async (init) => {
+        delete: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 204,
@@ -962,9 +968,9 @@ export class SdkMock {
                     methods: ['DELETE'],
                 },
                 respond,
-            });
+            }, options);
         },
-        restore: async (init) => {
+        restore: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 204,
@@ -976,9 +982,9 @@ export class SdkMock {
                     methods: ['POST'],
                 },
                 respond,
-            });
+            }, options);
         },
-        empty: async (init) => {
+        empty: async (init, options) => {
             const { mock } = this;
             // const respond = init?.response ?? {
             //   status: 204,
@@ -990,7 +996,236 @@ export class SdkMock {
                     methods: ['DELETE'],
                 },
                 respond,
-            });
+            }, options);
+        },
+    };
+    /**
+     * Trash Data Catalog mocks.
+     */
+    dataCatalog = {
+        list: async (init, options) => {
+            const { mock } = this;
+            const respond = this.createDefaultResponse(200, { 'content-type': 'application/json' }, () => {
+                const obj = {
+                    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, options) => {
+            const { mock } = this;
+            const respond = this.createDefaultResponse(200, { 'content-type': 'application/json' }, () => {
+                const obj = {
+                    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, options) => {
+            const { mock } = this;
+            const respond = this.createDefaultResponse(200, { 'content-type': 'application/json' }, () => {
+                const obj = this.gen.dataCatalog.dataCatalog();
+                const result = {
+                    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, options) => {
+            const { mock } = this;
+            const respond = this.createDefaultResponse(200, { 'content-type': 'application/json' }, (req) => {
+                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, options) => {
+            const { mock } = this;
+            const respond = this.createDefaultResponse(200, { 'content-type': 'application/json' }, (req) => {
+                const obj = this.gen.dataCatalog.dataCatalog({ key: req.params.id });
+                const result = {
+                    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, options) => {
+            const { mock } = this;
+            const respond = this.createDefaultResponse(200, { 'content-type': 'application/json' }, (req) => {
+                const obj = this.gen.dataCatalog.dataCatalog({ key: req.params.id });
+                const result = {
+                    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, options) => {
+            const { mock } = this;
+            const respond = this.createDefaultResponse(200, { 'content-type': 'application/json' }, (req) => {
+                const raw = req.body;
+                const body = JSON.parse(raw);
+                const result = {
+                    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, options) => {
+            const { mock } = this;
+            const respond = this.createDefaultResponse(200, { 'content-type': 'application/json' }, (req) => {
+                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, options) => {
+            const { mock } = this;
+            const respond = this.createDefaultResponse(200, { 'content-type': 'application/json' }, (req) => {
+                const requirements = JSON.parse(req.body);
+                const items = [];
+                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 = {
+                    items: items,
+                };
+                return JSON.stringify(obj);
+            }, init);
+            await mock.add({
+                match: {
+                    uri: RouteBuilder.dataCatalogDependencies(),
+                    methods: ['POST'],
+                },
+                respond,
+            }, options);
+        },
+        deprecateVersion: async (init, options) => {
+            const { mock } = this;
+            const respond = this.createDefaultResponse(200, { 'content-type': 'application/json' }, (req) => {
+                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);
+                obj.deprecationReason = info.reason;
+                const result = {
+                    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, options) => {
+            const { mock } = this;
+            const respond = this.createDefaultResponse(200, { 'content-type': 'application/json' }, (req) => {
+                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 = {
+                    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, options) => {
+            const { mock } = this;
+            const respond = this.createDefaultResponse(200, { 'content-type': 'application/json' }, () => {
+                const obj = this.gen.dataCatalog.dataCatalog();
+                obj.versions = this.gen.dataCatalog.versionInfos(1);
+                return JSON.stringify(obj);
+            }, init);
+            await mock.add({
+                match: {
+                    uri: RouteBuilder.dataCatalogStatus(':id'),
+                    methods: ['GET'],
+                },
+                respond,
+            }, options);
         },
     };
 }