add "create with explicit ID" tests on field, fieldset, item, itemType, itemTypeFilters, menuItem, plugin, upload, uploadFilters and workflow

pinzer · pinzer · commit a82601775122 · 2023-11-14T14:52:44.000+01:00
diff --git a/packages/cma-client-node/__tests__/field.test.ts b/packages/cma-client-node/__tests__/field.test.ts
@@ -1,4 +1,5 @@
 import { generateNewCmaClient } from '../../../jest-helpers/generateNewCmaClient';
+import { generateId } from '../../cma-client/src';
 
 describe('field', () => {
   it.concurrent('create, find, all, update, destroy', async () => {
@@ -34,4 +35,25 @@ describe('field', () => {
 
     await client.fields.destroy(field);
   });
+
+  it.concurrent('create with explicit ID', async () => {
+    const client = await generateNewCmaClient();
+
+    const newId = generateId();
+
+    const itemType = await client.itemTypes.create({
+      name: 'Article',
+      api_key: 'article',
+    });
+
+    const field = await client.fields.create(itemType, {
+      id: newId,
+      label: 'Image',
+      field_type: 'file',
+      localized: false,
+      api_key: 'image',
+      validators: { required: {} },
+    });
+    expect(field.id).toEqual(newId);
+  });
 });
diff --git a/packages/cma-client-node/__tests__/fieldset.test.ts b/packages/cma-client-node/__tests__/fieldset.test.ts
@@ -1,4 +1,5 @@
 import { generateNewCmaClient } from '../../../jest-helpers/generateNewCmaClient';
+import { generateId } from '../../cma-client/src';
 
 describe('Fieldsets', () => {
   it.concurrent('create, find, all, update, destroy, duplicate', async () => {
@@ -34,4 +35,26 @@ describe('Fieldsets', () => {
     await client.fieldsets.destroy(fieldset);
     expect(await client.fieldsets.list(itemType)).toHaveLength(0);
   });
+
+  it.concurrent('create with explicit ID', async () => {
+    const client = await generateNewCmaClient();
+
+    const newId = generateId();
+
+    const itemType = await client.itemTypes.create({
+      name: 'Article',
+      api_key: 'item_type',
+    });
+
+    const fieldset = await client.fieldsets.create(itemType, {
+      id: newId,
+      title: 'My fieldset',
+      position: 1,
+      hint: 'foo bar',
+      collapsible: true,
+      start_collapsed: true,
+    });
+
+    expect(fieldset.id).toEqual(newId);
+  });
 });
diff --git a/packages/cma-client-node/__tests__/item.test.ts b/packages/cma-client-node/__tests__/item.test.ts
@@ -1,5 +1,6 @@
 import { generateNewCmaClient } from '../../../jest-helpers/generateNewCmaClient';
 import { ApiError, buildBlockRecord, SchemaTypes } from '../src';
+import { generateId } from '../../cma-client/src';
 
 describe('item', () => {
   it.concurrent('bulk publish/unpublish/destroy works', async () => {
@@ -276,4 +277,33 @@ describe('item', () => {
     expect(updatedContent[0].attributes.text).toEqual('Updated Foo');
     expect(updatedContent[1].attributes.text).toEqual('Updated Bar');
   });
+
+  it.concurrent('create with explicit ID', async () => {
+    const client = await generateNewCmaClient();
+
+    const newId = generateId();
+
+    const itemType = await client.itemTypes.create({
+      name: 'Article',
+      api_key: 'article',
+    });
+
+    await client.fields.create(itemType.id, {
+      label: 'Title',
+      field_type: 'string',
+      api_key: 'title',
+    });
+
+    const item = await client.items.create({
+      id: newId,
+      title: 'My first blog post',
+      item_type: itemType,
+    });
+
+    await client.items.bulkPublish({
+      items: [item],
+    });
+
+    expect(item.id).toEqual(newId);
+  });
 });
diff --git a/packages/cma-client-node/__tests__/itemType.test.ts b/packages/cma-client-node/__tests__/itemType.test.ts
@@ -1,4 +1,5 @@
 import { generateNewCmaClient } from '../../../jest-helpers/generateNewCmaClient';
+import { generateId } from '../../cma-client/src';
 
 describe('item type', () => {
   it.concurrent('create, find, all, duplicate, update, destroy', async () => {
@@ -44,4 +45,18 @@ describe('item type', () => {
 
     await client.itemTypes.destroy(itemType.id);
   });
+
+  it.concurrent('create with explicit ID', async () => {
+    const client = await generateNewCmaClient();
+
+    const newId = generateId();
+
+    const itemType = await client.itemTypes.create({
+      id: newId,
+      name: 'Article',
+      api_key: 'article',
+    });
+
+    expect(itemType.id).toEqual(newId);
+  });
 });
diff --git a/packages/cma-client-node/__tests__/itemTypeFilters.test.ts b/packages/cma-client-node/__tests__/itemTypeFilters.test.ts
@@ -1,4 +1,5 @@
 import { generateNewCmaClient } from '../../../jest-helpers/generateNewCmaClient';
+import { generateId } from '../../cma-client/src';
 
 describe('itemTypeFilters', () => {
   it.concurrent('create, find, all, update, destroy', async () => {
@@ -37,4 +38,29 @@ describe('itemTypeFilters', () => {
     await client.itemTypeFilters.destroy(filter);
     expect(await client.itemTypeFilters.list()).toHaveLength(0);
   });
+
+  it.concurrent('create with explicit ID', async () => {
+    const client = await generateNewCmaClient();
+
+    const newId = generateId();
+
+    const itemType = await client.itemTypes.create({
+      name: 'Article',
+      api_key: 'item_type',
+      singleton: true,
+    });
+
+    const filter = await client.itemTypeFilters.create({
+      id: newId,
+      name: 'My filter',
+      shared: true,
+      item_type: itemType,
+      filter: {
+        status: {
+          eq: 'draft',
+        },
+      },
+    });
+    expect(filter.id).toEqual(newId);
+  });
 });
diff --git a/packages/cma-client-node/__tests__/menuItem.test.ts b/packages/cma-client-node/__tests__/menuItem.test.ts
@@ -1,5 +1,6 @@
 import { LogLevel } from '../src';
 import { generateNewCmaClient } from '../../../jest-helpers/generateNewCmaClient';
+import { generateId } from '../../cma-client/src';
 
 describe('menu item', () => {
   it.concurrent('create, find, list, update, destroy', async () => {
@@ -27,4 +28,18 @@ describe('menu item', () => {
     await client.menuItems.destroy(menuItem);
     expect(await client.menuItems.list()).toHaveLength(0);
   });
+
+  it.concurrent('create with explicit ID', async () => {
+    const client = await generateNewCmaClient();
+
+    const newId = generateId();
+
+    const menuItem = await client.menuItems.create({
+      id: newId,
+      label: 'Browse Articles',
+      position: 1,
+    });
+
+    expect(menuItem.id).toEqual(newId);
+  });
 });
diff --git a/packages/cma-client-node/__tests__/plugin.test.ts b/packages/cma-client-node/__tests__/plugin.test.ts
@@ -1,4 +1,5 @@
 import { generateNewCmaClient } from '../../../jest-helpers/generateNewCmaClient';
+import { generateId } from '../../cma-client/src';
 
 describe('plugins', () => {
   it.concurrent('create, find, all, duplicate, update, destroy', async () => {
@@ -15,4 +16,17 @@ describe('plugins', () => {
 
     await client.plugins.destroy(plugin.id);
   });
+
+  it.concurrent('create with explicit ID', async () => {
+    const client = await generateNewCmaClient();
+
+    const newId = generateId();
+
+    const plugin = await client.plugins.create({
+      id: newId,
+      package_name: 'datocms-plugin-tag-editor',
+    });
+
+    expect(plugin.id).toEqual(newId);
+  });
 });
diff --git a/packages/cma-client-node/__tests__/upload.test.ts b/packages/cma-client-node/__tests__/upload.test.ts
@@ -1,5 +1,6 @@
 import { LogLevel } from '../src';
 import { generateNewCmaClient } from '../../../jest-helpers/generateNewCmaClient';
+import { generateId } from '../../cma-client/src';
 
 describe('upload', () => {
   it.concurrent('upload local file', async () => {
@@ -57,4 +58,17 @@ describe('upload', () => {
 
     expect(items.length).toEqual(1);
   });
+
+  it.concurrent('create with explicit ID', async () => {
+    const client = await generateNewCmaClient();
+
+    const newId = generateId();
+
+    const upload = await client.uploads.createFromLocalFile({
+      id: newId,
+      localPath: `${__dirname}/fixtures/text.txt`,
+    });
+
+    expect(upload.id).toEqual(newId);
+  });
 });
diff --git a/packages/cma-client-node/__tests__/uploadFilters.test.ts b/packages/cma-client-node/__tests__/uploadFilters.test.ts
@@ -1,4 +1,5 @@
 import { generateNewCmaClient } from '../../../jest-helpers/generateNewCmaClient';
+import { generateId } from '../../cma-client/src';
 
 describe('uploadFilters', () => {
   test('create, find, all, update, destroy', async () => {
@@ -30,4 +31,22 @@ describe('uploadFilters', () => {
     await client.uploadFilters.destroy(filter);
     expect(await client.uploadFilters.list()).toHaveLength(0);
   });
+
+  it.concurrent('create with explicit ID', async () => {
+    const client = await generateNewCmaClient();
+
+    const newId = generateId();
+
+    const filter = await client.uploadFilters.create({
+      id: newId,
+      name: 'My filter',
+      shared: true,
+      filter: {
+        in_use: {
+          eq: false,
+        },
+      },
+    });
+    expect(filter.id).toEqual(newId);
+  });
 });
diff --git a/packages/cma-client-node/__tests__/workflow.test.ts b/packages/cma-client-node/__tests__/workflow.test.ts
@@ -1,4 +1,5 @@
 import { generateNewCmaClient } from '../../../jest-helpers/generateNewCmaClient';
+import { generateId } from '../../cma-client/src';
 
 describe('Workflow settings', () => {
   it.concurrent('create, find, list, destroy', async () => {
@@ -28,4 +29,24 @@ describe('Workflow settings', () => {
     await client.workflows.destroy(workflow);
     expect(await client.workflows.list()).toHaveLength(0);
   });
+
+  it.concurrent('create with explicit ID', async () => {
+    const client = await generateNewCmaClient();
+
+    const newId = generateId();
+
+    const workflow = await client.workflows.create({
+      id: newId,
+      api_key: 'approval_by_editors',
+      name: 'Approval by editors required',
+      stages: [
+        {
+          id: 'waiting_for_review',
+          name: 'Waiting for review',
+          initial: true,
+        },
+      ],
+    });
+    expect(workflow.id).toEqual(newId);
+  });
 });
diff --git a/packages/cma-client/package-lock.json b/packages/cma-client/package-lock.json
diff --git a/packages/cma-client/src/generated/SchemaTypes.ts b/packages/cma-client/src/generated/SchemaTypes.ts
diff --git a/packages/cma-client/src/generated/SimpleSchemaTypes.ts b/packages/cma-client/src/generated/SimpleSchemaTypes.ts
