@storyblok/management-api-client 1.0.0-alpha.3 → 1.0.0-alpha.4

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@storyblok/management-api-client",
   "type": "module",
-  "version": "1.0.0-alpha.3",
+  "version": "1.0.0-alpha.4",
   "private": false,
   "description": "Storyblok Management API Client",
   "author": "",
@@ -32,7 +32,7 @@
   "dependencies": {
     "async-sema": "^3.1.1",
     "ky": "^1.14.3",
-    "@storyblok/region-helper": "1.4.1"
+    "@storyblok/region-helper": "1.5.0"
   },
   "devDependencies": {
     "@types/node": "^24.1.0",
@@ -42,7 +42,7 @@
     "tsdown": "^0.20.3",
     "tsx": "^4.20.3",
     "vitest": "^4.1.3",
-    "@storyblok/eslint-config": "0.5.1",
+    "@storyblok/eslint-config": "0.6.0",
     "@storyblok/openapi-codegen": "0.0.1"
   },
   "nx": {

package/playground/integration-tests/test/types/stories.test-d.ts

@@ -1,5 +1,6 @@
-import { defineBlock, defineField } from '@storyblok/schema';
-import { createManagementApiClient, type Story as StoryMapi } from '@storyblok/management-api-client';
+import { defineBlock, defineField, defineSchema, type Schema as InferSchema } from '@storyblok/schema';
+import { storyblokColorField } from '@storyblok/schema/field-plugins';
+import { createManagementApiClient, type PluginFieldValue, type Story as StoryMapi } from '@storyblok/management-api-client';
 import { describe, expectTypeOf, it } from 'vitest';
 
 // Nestable block — not a root story type
@@ -271,3 +272,39 @@ describe('withTypes() write-body narrowing', () => {
     }
   });
 });
+
+describe('createManagementApiClient with .withTypes() — field plugins', () => {
+  const _themedComponent = defineBlock({
+    name: 'themed',
+    is_root: true,
+    fields: [
+      defineField('bg', { type: 'custom', field_type: 'storyblok-colorpicker' }),
+      defineField('legacy', { type: 'custom', field_type: 'unregistered-plugin' }),
+    ],
+  });
+  const _schema = defineSchema({
+    blocks: { themedComponent: _themedComponent },
+    fieldPlugins: { storyblokColorField },
+  });
+  type Schema = InferSchema<typeof _schema>;
+
+  it('resolves a registered custom field to the validator output merged with the plugin envelope', async () => {
+    const client = createManagementApiClient(CLIENT_CONFIG).withTypes<Schema>();
+    const result = await client.stories.get(123);
+    if (result.data?.story && result.data.story.content.component === 'themed') {
+      expectTypeOf<NonNullable<typeof result.data.story.content.bg>>().toEqualTypeOf<{
+        color: string;
+        plugin: string;
+        _uid?: string;
+      }>();
+    }
+  });
+
+  it('leaves an unregistered custom field as PluginFieldValue', async () => {
+    const client = createManagementApiClient(CLIENT_CONFIG).withTypes<Schema>();
+    const result = await client.stories.get(123);
+    if (result.data?.story && result.data.story.content.component === 'themed') {
+      expectTypeOf<NonNullable<typeof result.data.story.content.legacy>>().toEqualTypeOf<PluginFieldValue>();
+    }
+  });
+});