feat(services-bookmark): Update bookmark module schemas

equinor · Sep 4, 2024 · 260c2f4 · 260c2f4
1 parent 109e2cf
commit 260c2f4
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 23 deletions.
diff --git a/packages/modules/services/src/bookmarks/endpoints/bookmark-apply.get.ts b/packages/modules/services/src/bookmarks/endpoints/bookmark-apply.get.ts
@@ -11,6 +11,7 @@ import type { ClientMethod, ExtractApiVersion, FilterAllowedApiVersions } from '
 
 import { extractVersion, schemaSelector } from '../../utils';
 import { ApiVersion } from '../api-version';
+import { ApiBookmarkPayload } from '../schemas';
 
 /** API version which this operation uses. */
 type AvailableVersions = ApiVersion.v1;
@@ -27,18 +28,7 @@ const ArgSchema = {
 const ApiResponseSchema = {
     [ApiVersion.v1]: z.object({
         id: z.string(),
-        payload: z
-            .string()
-            .or(z.record(z.unknown()))
-            .optional()
-            .default('')
-            .transform((x) => {
-                try {
-                    return typeof x === 'string' ? JSON.parse(x) : x;
-                } catch {
-                    return x;
-                }
-            }),
+        payload: ApiBookmarkPayload[ApiVersion.v1],
     }),
 };
 

diff --git a/packages/modules/services/src/bookmarks/endpoints/bookmark.patch.ts b/packages/modules/services/src/bookmarks/endpoints/bookmark.patch.ts
@@ -11,7 +11,7 @@ import type { ClientMethod, ExtractApiVersion, FilterAllowedApiVersions } from '
 
 import { extractVersion, schemaSelector } from '../../utils';
 import { ApiVersion } from '../api-version';
-import { ApiBookmarkSchema } from '../schemas';
+import { ApiBookmarkPayload, ApiBookmarkSchema } from '../schemas';
 
 /** API version which this operation uses. */
 type AvailableVersions = ApiVersion.v1;
@@ -45,9 +45,11 @@ const ArgSchema = {
 
 /** Schema for the response from the API. */
 const ApiResponseSchema = {
-    [ApiVersion.v1]: ApiBookmarkSchema[ApiVersion.v1].extend({
-        payload: z.string().or(z.record(z.unknown())).optional(),
-    }),
+    [ApiVersion.v1]: ApiBookmarkSchema[ApiVersion.v1].and(
+        z.object({
+            payload: ApiBookmarkPayload[ApiVersion.v1].optional(),
+        }),
+    ),
 };
 
 /** Defines the expected output from the api. */

diff --git a/packages/modules/services/src/bookmarks/endpoints/bookmark.post.ts b/packages/modules/services/src/bookmarks/endpoints/bookmark.post.ts
@@ -11,7 +11,7 @@ import type { ClientMethod, ExtractApiVersion, FilterAllowedApiVersions } from '
 
 import { extractVersion, schemaSelector } from '../../utils';
 import { ApiVersion } from '../api-version';
-import { ApiBookmarkSchema, ApiSourceSystem } from '../schemas';
+import { ApiBookmarkPayload, ApiBookmarkSchema, ApiSourceSystem } from '../schemas';
 
 /** API version which this operation uses. */
 type AvailableVersions = ApiVersion.v1;
@@ -24,11 +24,7 @@ const ArgSchema = {
     [ApiVersion.v1]: z.object({
         name: z.string(),
         appKey: z.string(),
-        payload: z
-            .record(z.unknown())
-            .or(z.string())
-            .optional()
-            .transform((x) => (typeof x === 'object' ? JSON.stringify(x) : x)),
+        payload: z.record(z.unknown()).or(z.string()).optional(),
         description: z.string().nullish(),
         isShared: z.boolean().nullish(),
         contextId: z.string().nullish(),
@@ -38,7 +34,11 @@ const ArgSchema = {
 
 /** Schema for the response from the API. */
 const ApiResponseSchema = {
-    [ApiVersion.v1]: ApiBookmarkSchema[ApiVersion.v1],
+    [ApiVersion.v1]: ApiBookmarkSchema[ApiVersion.v1].and(
+        z.object({
+            payload: ApiBookmarkPayload[ApiVersion.v1].optional(),
+        }),
+    ),
 };
 
 /** Defines the expected output from the api. */

diff --git a/packages/modules/services/src/bookmarks/schemas.ts b/packages/modules/services/src/bookmarks/schemas.ts
@@ -62,3 +62,20 @@ export const ApiBookmarkSchema = {
         return this[ApiVersion.v1];
     },
 };
+
+export const ApiBookmarkPayload = {
+    get [ApiVersion.v1]() {
+        return z
+            .record(z.unknown())
+            .or(z.string())
+            .optional()
+            .default('')
+            .transform((x) => {
+                try {
+                    return typeof x === 'string' ? JSON.parse(x) : x;
+                } catch {
+                    return x;
+                }
+            });
+    },
+};