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

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

@@ -1,44 +1,9 @@
-import {
-  defineAssetFolderCreate,
-  defineAssetFolderUpdate,
-  defineBlockFolderCreate,
-  defineBlockFolderUpdate,
-  defineDatasourceCreate,
-  defineDatasourceEntryCreate,
-  defineDatasourceEntryUpdate,
-  defineDatasourceUpdate,
-  defineInternalTagCreate,
-  defineInternalTagUpdate,
-  definePresetCreate,
-  definePresetUpdate,
-  defineSpaceCreate,
-  defineSpaceUpdate,
-  defineUserUpdate,
-} from '@storyblok/schema';
 import { createManagementApiClient } from '@storyblok/management-api-client';
 import { describe, expectTypeOf, it } from 'vitest';
 
 const CLIENT_CONFIG = { personalAccessToken: 'test-token', spaceId: 12345 };
 
 describe('datasources type tests', () => {
-  it('should produce a defineDatasourceCreate result assignable to datasources.create body', () => {
-    const payload = defineDatasourceCreate({ name: 'Categories', slug: 'categories' });
-
-    type CreateBody = Parameters<ReturnType<typeof createManagementApiClient>['datasources']['create']>[0]['body'];
-    type InnerType = NonNullable<CreateBody['datasource']>;
-
-    expectTypeOf(payload).toExtend<InnerType>();
-  });
-
-  it('should produce a defineDatasourceUpdate result assignable to datasources.update body', () => {
-    const payload = defineDatasourceUpdate({ name: 'Updated Categories' });
-
-    type UpdateBody = Parameters<ReturnType<typeof createManagementApiClient>['datasources']['update']>[1]['body'];
-    type InnerType = NonNullable<UpdateBody['datasource']>;
-
-    expectTypeOf(payload).toExtend<InnerType>();
-  });
-
   it('should return datasource in response from create', async () => {
     const client = createManagementApiClient(CLIENT_CONFIG);
     const result = await client.datasources.create({
@@ -67,24 +32,6 @@ describe('datasources type tests', () => {
 });
 
 describe('datasource entries type tests', () => {
-  it('should produce a defineDatasourceEntryCreate result assignable to datasourceEntries.create body', () => {
-    const payload = defineDatasourceEntryCreate({ name: 'red', value: '#ff0000', datasource_id: 42 });
-
-    type CreateBody = Parameters<ReturnType<typeof createManagementApiClient>['datasourceEntries']['create']>[0]['body'];
-    type InnerType = NonNullable<CreateBody['datasource_entry']>;
-
-    expectTypeOf(payload).toExtend<InnerType>();
-  });
-
-  it('should produce a defineDatasourceEntryUpdate result assignable to datasourceEntries.update body', () => {
-    const payload = defineDatasourceEntryUpdate({ value: '#00ff00' });
-
-    type UpdateBody = Parameters<ReturnType<typeof createManagementApiClient>['datasourceEntries']['update']>[1]['body'];
-    type InnerType = NonNullable<UpdateBody['datasource_entry']>;
-
-    expectTypeOf(payload).toExtend<InnerType>();
-  });
-
   it('should return datasource_entry in response from create', async () => {
     const client = createManagementApiClient(CLIENT_CONFIG);
     const result = await client.datasourceEntries.create({
@@ -113,24 +60,6 @@ describe('datasource entries type tests', () => {
 });
 
 describe('asset folders type tests', () => {
-  it('should produce a defineAssetFolderCreate result assignable to assetFolders.create body', () => {
-    const payload = defineAssetFolderCreate({ name: 'Images' });
-
-    type CreateBody = Parameters<ReturnType<typeof createManagementApiClient>['assetFolders']['create']>[0]['body'];
-    type InnerType = NonNullable<CreateBody['asset_folder']>;
-
-    expectTypeOf(payload).toExtend<InnerType>();
-  });
-
-  it('should produce a defineAssetFolderUpdate result assignable to assetFolders.update body', () => {
-    const payload = defineAssetFolderUpdate({ name: 'Updated Images' });
-
-    type UpdateBody = Parameters<ReturnType<typeof createManagementApiClient>['assetFolders']['update']>[1]['body'];
-    type InnerType = NonNullable<UpdateBody['asset_folder']>;
-
-    expectTypeOf(payload).toExtend<InnerType>();
-  });
-
   it('should return asset_folder in response from create', async () => {
     const client = createManagementApiClient(CLIENT_CONFIG);
     const result = await client.assetFolders.create({
@@ -159,24 +88,6 @@ describe('asset folders type tests', () => {
 });
 
 describe('component folders type tests', () => {
-  it('should produce a defineBlockFolderCreate result assignable to componentFolders.create body', () => {
-    const payload = defineBlockFolderCreate({ name: 'Layout' });
-
-    type CreateBody = Parameters<ReturnType<typeof createManagementApiClient>['componentFolders']['create']>[0]['body'];
-    type InnerType = NonNullable<CreateBody['component_group']>;
-
-    expectTypeOf(payload).toExtend<InnerType>();
-  });
-
-  it('should produce a defineBlockFolderUpdate result assignable to componentFolders.update body', () => {
-    const payload = defineBlockFolderUpdate({ name: 'Updated Layout' });
-
-    type UpdateBody = Parameters<ReturnType<typeof createManagementApiClient>['componentFolders']['update']>[1]['body'];
-    type InnerType = NonNullable<UpdateBody['component_group']>;
-
-    expectTypeOf(payload).toExtend<InnerType>();
-  });
-
   it('should return component_group in response from create', async () => {
     const client = createManagementApiClient(CLIENT_CONFIG);
     const result = await client.componentFolders.create({
@@ -205,24 +116,6 @@ describe('component folders type tests', () => {
 });
 
 describe('internal tags type tests', () => {
-  it('should produce a defineInternalTagCreate result assignable to internalTags.create body', () => {
-    const payload = defineInternalTagCreate({ name: 'hero', object_type: 'asset' });
-
-    type CreateBody = Parameters<ReturnType<typeof createManagementApiClient>['internalTags']['create']>[0]['body'];
-    type InnerType = NonNullable<CreateBody['internal_tag']>;
-
-    expectTypeOf(payload).toExtend<InnerType>();
-  });
-
-  it('should produce a defineInternalTagUpdate result assignable to internalTags.update body', () => {
-    const payload = defineInternalTagUpdate({ name: 'hero-image' });
-
-    type UpdateBody = Parameters<ReturnType<typeof createManagementApiClient>['internalTags']['update']>[1]['body'];
-    type InnerType = NonNullable<UpdateBody['internal_tag']>;
-
-    expectTypeOf(payload).toExtend<InnerType>();
-  });
-
   it('should return internal_tag in response from create', async () => {
     const client = createManagementApiClient(CLIENT_CONFIG);
     const result = await client.internalTags.create({
@@ -243,24 +136,6 @@ describe('internal tags type tests', () => {
 });
 
 describe('presets type tests', () => {
-  it('should produce a definePresetCreate result assignable to presets.create body', () => {
-    const payload = definePresetCreate({ name: 'Hero Dark', component_id: 42 });
-
-    type CreateBody = Parameters<ReturnType<typeof createManagementApiClient>['presets']['create']>[0]['body'];
-    type InnerType = NonNullable<CreateBody['preset']>;
-
-    expectTypeOf(payload).toExtend<InnerType>();
-  });
-
-  it('should produce a definePresetUpdate result assignable to presets.update body', () => {
-    const payload = definePresetUpdate({ name: 'Hero Light' });
-
-    type UpdateBody = Parameters<ReturnType<typeof createManagementApiClient>['presets']['update']>[1]['body'];
-    type InnerType = NonNullable<UpdateBody['preset']>;
-
-    expectTypeOf(payload).toExtend<InnerType>();
-  });
-
   it('should return preset in response from create', async () => {
     const client = createManagementApiClient(CLIENT_CONFIG);
     const result = await client.presets.create({
@@ -289,24 +164,6 @@ describe('presets type tests', () => {
 });
 
 describe('spaces type tests', () => {
-  it('should produce a defineSpaceCreate result assignable to spaces.create body', () => {
-    const payload = defineSpaceCreate({ name: 'My New Space' });
-
-    type CreateBody = Parameters<ReturnType<typeof createManagementApiClient>['spaces']['create']>[0]['body'];
-    type InnerType = CreateBody['space'];
-
-    expectTypeOf(payload).toExtend<InnerType>();
-  });
-
-  it('should produce a defineSpaceUpdate result assignable to spaces.update body', () => {
-    const payload = defineSpaceUpdate({ name: 'Updated Space Name' });
-
-    type UpdateBody = Parameters<ReturnType<typeof createManagementApiClient>['spaces']['update']>[0]['body'];
-    type InnerType = UpdateBody['space'];
-
-    expectTypeOf(payload).toExtend<InnerType>();
-  });
-
   it('should return space in response from create', async () => {
     const client = createManagementApiClient(CLIENT_CONFIG);
     const result = await client.spaces.create({
@@ -335,15 +192,6 @@ describe('spaces type tests', () => {
 });
 
 describe('users type tests', () => {
-  it('should produce a defineUserUpdate result assignable to users.updateMe body', () => {
-    const payload = defineUserUpdate({ firstname: 'Jane', lastname: 'Doe' });
-
-    type UpdateBody = Parameters<ReturnType<typeof createManagementApiClient>['users']['updateMe']>[0]['body'];
-    type InnerType = UpdateBody['user'];
-
-    expectTypeOf(payload).toExtend<InnerType>();
-  });
-
   it('should return user in response from updateMe', async () => {
     const client = createManagementApiClient(CLIENT_CONFIG);
     const result = await client.users.updateMe({

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

@@ -1,11 +1,11 @@
-import { defineBlock, defineField, defineStoryCreate, defineStoryUpdate } from '@storyblok/schema';
+import { defineBlock, defineField } from '@storyblok/schema';
 import { createManagementApiClient, type Story as StoryMapi } from '@storyblok/management-api-client';
 import { describe, expectTypeOf, it } from 'vitest';
 
 // Nestable block — not a root story type
 const teaserComponent = defineBlock({
   name: 'teaser',
-  schema: [
+  fields: [
     defineField('text', { type: 'text' }),
     defineField('image', { type: 'asset' }),
   ],
@@ -18,7 +18,7 @@ const teaserComponent = defineBlock({
 const heroComponent = defineBlock({
   name: 'hero',
   is_root: true,
-  schema: [
+  fields: [
     defineField('title', { type: 'text' }),
     defineField('count', { type: 'number' }),
     // bloks field without a whitelist — resolves to nestable components only
@@ -34,12 +34,12 @@ const _pageComponent = defineBlock({
   name: 'page',
   is_root: true,
   is_nestable: false,
-  schema: [
+  fields: [
     defineField('headline', { type: 'text' }),
     defineField('body', { type: 'richtext' }),
-    defineField('teasers', { type: 'bloks', component_whitelist: [teaserComponent.name] }),
-    defineField('hero', { type: 'bloks', component_whitelist: [heroComponent.name] }),
-    defineField('blocks', { type: 'bloks', component_whitelist: [heroComponent.name, teaserComponent.name] }),
+    defineField('teasers', { type: 'bloks', allow: [teaserComponent.name] }),
+    defineField('hero', { type: 'bloks', allow: [heroComponent.name] }),
+    defineField('blocks', { type: 'bloks', allow: [heroComponent.name, teaserComponent.name] }),
   ],
   id: 0,
   created_at: '',
@@ -237,36 +237,7 @@ describe('createManagementApiClient with .withTypes()', () => {
   });
 });
 
-describe('defineStoryCreate / defineStoryUpdate combined with mapi client', () => {
-  it('should produce a defineStoryCreate result accepted by untyped stories.create', async () => {
-    const createPayload = defineStoryCreate(_pageComponent, {
-      name: 'My Page',
-      content: { headline: 'Hello' },
-    });
-
-    const client = createManagementApiClient(CLIENT_CONFIG);
-    await client.stories.create({ body: { story: createPayload } });
-  });
-
-  it('should produce a defineStoryUpdate result accepted by untyped stories.update', async () => {
-    const updatePayload = defineStoryUpdate(_pageComponent, {
-      content: { headline: 'Updated' },
-    });
-
-    const client = createManagementApiClient(CLIENT_CONFIG);
-    await client.stories.update(1, { body: { story: updatePayload } });
-  });
-
-  it('should produce a defineStoryCreate result for hero component accepted by untyped stories.create', async () => {
-    const createPayload = defineStoryCreate(heroComponent, {
-      name: 'My Hero',
-      content: { title: 'Welcome', count: 42, sections: [] },
-    });
-
-    const client = createManagementApiClient(CLIENT_CONFIG);
-    await client.stories.create({ body: { story: createPayload } });
-  });
-
+describe('withTypes() write-body narrowing', () => {
   it('should reject nestable-only component name in create body content', () => {
     const client = createManagementApiClient(CLIENT_CONFIG).withTypes<StoryblokTypes>();
     client.stories.create({
@@ -295,11 +266,7 @@ describe('defineStoryCreate / defineStoryUpdate combined with mapi client', () =
       expectTypeOf(story.content.component).toEqualTypeOf<'page' | 'hero'>();
 
       if (story.content.component === 'page') {
-        const updatePayload = defineStoryUpdate(_pageComponent, {
-          name: story.name,
-          content: { headline: story.content.headline ?? 'Default' },
-        });
-        expectTypeOf(updatePayload).toMatchTypeOf<{ name?: string | null }>();
+        expectTypeOf(story.content.headline).toEqualTypeOf<string | null | undefined>();
       }
     }
   });

package/test/GUIDE.md

@@ -48,7 +48,7 @@ node packages/cli/dist/index.mjs components push \
 
 **Always push components before stories.** The CLI validates that each story's `content.component` (and any nested block components) exist in the space. Pushing stories first fails if the referenced components are not yet present.
 
-You can do the same with stories and `defineStory`. **Story filename convention:** the CLI requires files named `{slug}_{uuid}.json` where the part after the last `_` exactly matches `story.uuid` in the JSON. Use hyphens (not underscores) in UUIDs. A mismatch causes Pass 2 of the push (reference mapping + content update) to silently skip all stories.
+You can do the same with stories. **Story filename convention:** the CLI requires files named `{slug}_{uuid}.json` where the part after the last `_` exactly matches `story.uuid` in the JSON. Use hyphens (not underscores) in UUIDs. A mismatch causes Pass 2 of the push (reference mapping + content update) to silently skip all stories.
 
 ## Known quirks
 
@@ -56,4 +56,4 @@ You can do the same with stories and `defineStory`. **Story filename convention:
 - **MAPI `stories.get` takes a positional ID, not an options object:** `client.stories.get(id)` — there is no `getBySlug`. The `list` response does not include `content`; call `get(id)` for full content.
 - **MAPI client constructor uses `personalAccessToken`:** `createManagementApiClient({ personalAccessToken: '...', spaceId: ... })`.
 - **Delete methods are `delete`:** Use `client.RESOURCE.delete(id)`.
-- **Each story JSON must have a unique `id`.** `defineStory` defaults `id` to `1`. If multiple story files share the same `id`, the CLI's manifest maps all of them to the same `old_id` entry, causing "slug already taken" errors.
+- **Each story JSON must have a unique `id`.** If multiple story files share the same `id`, the CLI's manifest maps all of them to the same `old_id` entry, causing "slug already taken" errors.