Update Kontent.ai Management SDK

kontent-ai · Jul 1, 2024 · f46fe43 · f46fe43
1 parent 07a5340
commit f46fe43
Show file tree

Hide file tree

Showing 30 changed files with 1,303 additions and 12,752 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -12,13 +12,12 @@
   },
   "dependencies": {
     "@kontent-ai/delivery-sdk": "^14.9.0",
-    "@kontent-ai/management-sdk": "^3.4.0",
+    "@kontent-ai/management-sdk": "^6.4.0",
     "zapier-platform-core": "15.8.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.12",
     "@types/node": "^18.19.39",
-    "@types/node-fetch": "^2.6.11",
     "jest": "^29.7.0",
     "nock": "^13.5.4",
     "ts-jest": "^29.1.5",

diff --git a/src/authentication.ts b/src/authentication.ts
@@ -49,7 +49,7 @@ export const Authentication = {
 
 const checkCmApi = (z: ZObject, bundle: KontentBundle<{}>) =>
   createManagementClient(z, bundle)
-    .projectInformation()
+    .environmentInformation()
     .toPromise()
     .then(res => res.data.project);
 

diff --git a/src/test/actions/changeContentItemWorkflow.test.ts b/src/test/actions/changeContentItemWorkflow.test.ts
@@ -20,7 +20,7 @@ describe("changeContentItemWorkflow", () => {
     });
 
     const client = new ManagementClient({
-      projectId: bundle.authData.projectId,
+      environmentId: bundle.authData.projectId,
       apiKey: bundle.authData.cmApiKey,
     });
 
@@ -78,5 +78,9 @@ const rawVariant: LanguageVariantContracts.ILanguageVariantModelContract = {
   language: { id: "984efe5c-6898-4d51-8afa-a66b9de51cc0" },
   elements: [],
   last_modified: createUTCDate(1316, 5, 14).toISOString(),
+  workflow: {
+    workflow_identifier: { codename: "default" },
+    step_identifier: { id: rawWfSteps[0]?.id },
+  },
   workflow_step: { id: rawWfSteps[0]?.id },
 };
diff --git a/src/test/actions/createContentItem.test.ts b/src/test/actions/createContentItem.test.ts
@@ -7,7 +7,6 @@ import {
   ElementContracts,
   LanguageContracts,
   LanguageVariantContracts,
-  LanguageVariantElements,
   languageVariantElementsBuilder,
   LanguageVariantElementsBuilder,
   ManagementClient,
@@ -58,7 +57,7 @@ describe("createContentItem", () => {
     });
 
     const client = new ManagementClient({
-      projectId: bundle.authData.projectId,
+      environmentId: bundle.authData.projectId,
       apiKey: bundle.authData.cmApiKey,
     });
 
@@ -90,24 +89,23 @@ describe("createContentItem", () => {
       .upsertLanguageVariant()
       .byItemId(itemId)
       .byLanguageId(rawLanguage.id)
-      .withData(buildExpectedElements);
+      .withData(builder => ({
+        elements: buildExpectedElements(builder),
+      }));
 
     nock(expectedCreateVariantRequest.getUrl())
-      .put(
-        "",
-        JSON.stringify({
-          elements: expectedCreateVariantRequest.data(
-            languageVariantElementsBuilder
-          ),
-        })
-      )
+      .put("", JSON.stringify(expectedCreateVariantRequest.data(languageVariantElementsBuilder)))
       .reply(201, {
         item: { id: itemId },
         language: { id: rawLanguage.id },
         elements: resultElements,
         last_modified: createUTCDate(1993, 1, 1).toISOString(),
+        workflow: {
+          workflow_identifier: { codename: "default" },
+          step_identifier: { id: "3ecd7341-ad09-44b1-b457-4257ba3fa73b" },
+        },
         workflow_step: { id: "3ecd7341-ad09-44b1-b457-4257ba3fa73b" },
-      } as LanguageVariantContracts.IUpsertLanguageVariantResponseContract);
+      } satisfies LanguageVariantContracts.IUpsertLanguageVariantResponseContract);
 
     const search = App.creates[createContentItem.key].operation.perform;
 
@@ -210,6 +208,7 @@ const resultElements: ElementContracts.IContentItemElementContract[] = [
       id: "2e460e16-e006-4726-848b-9912c413d947",
     },
     value: "<p>rich value</p>",
+    components: [],
   },
   {
     element: {
@@ -271,6 +270,7 @@ const buildExpectedElements = (builder: LanguageVariantElementsBuilder) => [
   builder.richTextElement({
     element: { id: "2e460e16-e006-4726-848b-9912c413d947" },
     value: "<p>rich value</p>",
+    components: [],
   }),
   builder.taxonomyElement({
     element: { id: "f870da17-761e-49fe-a546-e52be730b05e" },

diff --git a/src/test/actions/deleteLanguageVariant.test.ts b/src/test/actions/deleteLanguageVariant.test.ts
@@ -33,7 +33,7 @@ describe("deleteLanguageVariant", () => {
     });
 
     const client = new ManagementClient({
-      projectId: bundle.authData.projectId,
+      environmentId: bundle.authData.projectId,
       apiKey: bundle.authData.cmApiKey,
     });
 
@@ -197,5 +197,9 @@ const rawVariant: LanguageVariantContracts.ILanguageVariantModelContract = {
   language: { id: rawLanguage.id },
   elements: [],
   last_modified: createUTCDate(1316, 5, 14).toISOString(),
+  workflow: {
+    workflow_identifier: { codename: "default" },
+    step_identifier: { id: "6b7590d5-75e5-4860-8cc0-02c5bffce2dc" },
+  },
   workflow_step: { id: "6b7590d5-75e5-4860-8cc0-02c5bffce2dc" },
 };
diff --git a/src/test/actions/updateLanguageVariant.test.ts b/src/test/actions/updateLanguageVariant.test.ts
@@ -40,7 +40,7 @@ describe("updateLanguageVariant", () => {
     });
 
     const client = new ManagementClient({
-      projectId: bundle.authData.projectId,
+      environmentId: bundle.authData.projectId,
       apiKey: bundle.authData.cmApiKey,
     });
 
@@ -72,15 +72,15 @@ describe("updateLanguageVariant", () => {
       .upsertLanguageVariant()
       .byItemId(rawItem.id)
       .byLanguageId(rawLanguage.id)
-      .withData((builder) => [
-        builder.textElement({
-          element: { id: rawContentType.elements[0]?.id || "" },
-          value: newElementValue,
-        }),
-      ]);
-    const expectedRawBody = JSON.stringify({
-      elements: expectedUpdateRequest.data(languageVariantElementsBuilder),
-    });
+      .withData((builder) => ({
+        elements: [
+          builder.textElement({
+            element: { id: rawContentType.elements[0]?.id || "" },
+            value: newElementValue,
+          }),
+        ]
+      }));
+    const expectedRawBody = JSON.stringify(expectedUpdateRequest.data(languageVariantElementsBuilder));
     nock(expectedUpdateRequest.getUrl())
       .put("", expectedRawBody)
       .reply(200, {
@@ -175,5 +175,9 @@ const rawVariant: LanguageVariantContracts.ILanguageVariantModelContract = {
     },
   ],
   last_modified: createUTCDate(1316, 5, 14).toISOString(),
+  workflow: {
+    workflow_identifier: { codename: "default" },
+    step_identifier: { id: rawWfSteps[0]?.id || "" },
+  },
   workflow_step: { id: rawWfSteps[0]?.id || "" },
 };
diff --git a/src/test/authentication.test.ts b/src/test/authentication.test.ts
@@ -20,9 +20,9 @@ describe("Zapier authentication", () => {
     };
 
     const expectedMapiRequest = new ManagementClient({
-      projectId: authData.projectId,
+      environmentId: authData.projectId,
       apiKey: authData.cmApiKey,
-    }).projectInformation();
+    }).environmentInformation();
 
     nock(expectedMapiRequest.getUrl())
       .get("")

diff --git a/src/test/searches/findAsset.test.ts b/src/test/searches/findAsset.test.ts
@@ -36,7 +36,7 @@ describe("findAsset", () => {
     };
 
     const client = new ManagementClient({
-      projectId: bundleById.authData.projectId,
+      environmentId: bundleById.authData.projectId,
       apiKey: bundleById.authData.cmApiKey,
     });
 
@@ -48,6 +48,7 @@ describe("findAsset", () => {
 
     const expectedRawAsset: AssetContracts.IAssetModelContract = {
       id: "d0442642-6e09-44a0-a5d3-1e842030cee6",
+      codename: "best_asset",
       title: "test asset",
       url: "https://bestAsset.test",
       external_id: expectedAssetExternalId,

diff --git a/src/test/searches/findContentItem.test.ts b/src/test/searches/findContentItem.test.ts
@@ -33,7 +33,7 @@ describe("findContentItem", () => {
     });
 
     const managementClient = new ManagementClient({
-      projectId: bundle.authData.projectId,
+      environmentId: bundle.authData.projectId,
       apiKey: bundle.authData.cmApiKey,
     });
 
@@ -289,10 +289,11 @@ const rawVariant: LanguageVariantContracts.IListLanguageVariantsOfItemResponseCo
   item: rawContentItem,
   language: rawLanguage,
   last_modified: createUTCDate(1230, 12, 15).toISOString(),
-  workflow_step: {
-    id: "89205fc8-bf8e-4bc3-9eb2-725c9623ef40",
-    codename: "draft",
+  workflow: {
+    workflow_identifier: { codename: "default" },
+    step_identifier: { id: "89205fc8-bf8e-4bc3-9eb2-725c9623ef40" },
   },
+  workflow_step: { id: "89205fc8-bf8e-4bc3-9eb2-725c9623ef40" },
   elements: [
     {
       element: {
@@ -312,8 +313,8 @@ const rawDeliveryItem: Contracts.IContentItemContract = {
     name: rawContentItem.name,
     language: rawLanguage.codename,
     collection: "default",
-    workflow_step: rawVariant.workflow_step.codename || "",
-    workflow: null,
+    workflow_step: rawVariant.workflow_step.id || "",
+    workflow: rawVariant.workflow.workflow_identifier.codename || "",
     last_modified: rawVariant.last_modified,
     sitemap_locations: [],
   },

diff --git a/src/test/searches/findContentItemWithSnippet.test.ts b/src/test/searches/findContentItemWithSnippet.test.ts
@@ -34,7 +34,7 @@ describe("findContentItem", () => {
     });
 
     const managementClient = new ManagementClient({
-      projectId: bundle.authData.projectId,
+      environmentId: bundle.authData.projectId,
       apiKey: bundle.authData.cmApiKey,
     });
 
@@ -311,15 +311,15 @@ const rawSnippets: ReadonlyArray<ContentTypeSnippetContracts.IContentTypeSnippet
 }];
 
 
-const rawVariant: LanguageVariantContracts.IListLanguageVariantsOfItemResponseContract =
-{
+const rawVariant: LanguageVariantContracts.IListLanguageVariantsOfItemResponseContract = {
   item: rawContentItem,
   language: rawLanguage,
   last_modified: createUTCDate(1230, 12, 15).toISOString(),
-  workflow_step: {
-    id: "89205fc8-bf8e-4bc3-9eb2-725c9623ef40",
-    codename: "draft",
+  workflow: {
+    workflow_identifier: { codename: "default" },
+    step_identifier: { codename: "89205fc8-bf8e-4bc3-9eb2-725c9623ef40" },
   },
+  workflow_step: { id: "89205fc8-bf8e-4bc3-9eb2-725c9623ef40" },
   elements: [
     {
       element: {
@@ -346,7 +346,7 @@ const rawDeliveryItem: Contracts.IContentItemContract = {
     name: rawContentItem.name,
     language: rawLanguage.codename,
     collection: "default",
-    workflow_step: rawVariant.workflow_step.codename || "",
+    workflow_step: rawVariant.workflow_step.id || "",
     workflow: null,
     last_modified: rawVariant.last_modified,
     sitemap_locations: [],

diff --git a/src/test/searches/findLanguage.test.ts b/src/test/searches/findLanguage.test.ts
@@ -18,7 +18,7 @@ describe("findLanguage", () => {
     > = addInputData(mockBundle, { searchPattern: "{0}={1}" });
 
     const client = new ManagementClient({
-      projectId: bundle.authData.projectId,
+      environmentId: bundle.authData.projectId,
       apiKey: bundle.authData.cmApiKey,
     });
 

diff --git a/src/test/searches/findWorkflowStep.test.ts b/src/test/searches/findWorkflowStep.test.ts
@@ -21,7 +21,7 @@ describe("findWorkflowStep", () => {
     });
 
     const expectedRequest = new ManagementClient({
-      projectId: bundle.authData.projectId,
+      environmentId: bundle.authData.projectId,
       apiKey: bundle.authData.cmApiKey,
     }).listWorkflowSteps();
 
@@ -57,7 +57,7 @@ describe("findWorkflowStep", () => {
     });
 
     const expectedRequest = new ManagementClient({
-      projectId: bundle.authData.projectId,
+      environmentId: bundle.authData.projectId,
       apiKey: bundle.authData.cmApiKey,
     }).listWorkflowSteps();
 

diff --git a/src/test/triggers/dropdowns/getContentItems.test.ts b/src/test/triggers/dropdowns/getContentItems.test.ts
@@ -77,7 +77,7 @@ describe("getContentItems", () => {
       });
 
     const expectedLanguagesRequest = new ManagementClient({
-      projectId: bundle.authData.projectId,
+      environmentId: bundle.authData.projectId,
       apiKey: bundle.authData.cmApiKey,
     }).listLanguages();
 

diff --git a/src/test/triggers/dropdowns/getLanguages.test.ts b/src/test/triggers/dropdowns/getLanguages.test.ts
@@ -16,7 +16,7 @@ describe('getLanguages', () => {
     const bundle = mockBundle;
 
     const expectedRequest = new ManagementClient({
-      projectId: bundle.authData.projectId,
+      environmentId: bundle.authData.projectId,
       apiKey: bundle.authData.cmApiKey,
     }).listLanguages();
 

diff --git a/src/test/triggers/dropdowns/getWorkflowSteps.test.ts b/src/test/triggers/dropdowns/getWorkflowSteps.test.ts
@@ -18,7 +18,7 @@ describe('getWorkflowSteps', () => {
     const bundle = mockBundle;
 
     const expectedRequest = new ManagementClient({
-      projectId: bundle.authData.projectId,
+      environmentId: bundle.authData.projectId,
       apiKey: bundle.authData.cmApiKey,
     }).listWorkflowSteps();
 

diff --git a/src/test/triggers/triggerItemExistenceChanged.test.ts b/src/test/triggers/triggerItemExistenceChanged.test.ts
@@ -35,13 +35,25 @@ describe("triggerItemExistenceChanged", () => {
     const result = await appTester(subscribe, bundle);
 
     expect(result).toMatchInlineSnapshot(`
-      Webhook {
+      LegacyWebhook {
+        "healthStatus": undefined,
         "id": "404c8821-d3ba-4794-8cee-853f3952ca99",
         "lastModified": 1993-01-01T00:00:00.000Z,
         "name": "Simple test name for webhook (Zapier)",
         "secret": "sample_secret",
         "triggers": {
           "deliveryApiContentChanges": [],
+          "managementApiContentChanges": [
+            LegacyWebhookManagementApiContentChanges {
+              "operations": [
+                "create",
+                "archive",
+                "restore",
+              ],
+              "type": "content_item_variant",
+            },
+          ],
+          "previewDeliveryContentChanges": [],
           "workflowStepChanges": [],
         },
         "url": "https://test-url.test",

diff --git a/src/test/triggers/triggerItemPublishChanged.test.ts b/src/test/triggers/triggerItemPublishChanged.test.ts
@@ -31,21 +31,24 @@ describe("triggerItemPublishChanged", () => {
     const result = await appTester(subscribe, bundle);
 
     expect(result).toMatchInlineSnapshot(`
-      Webhook {
+      LegacyWebhook {
+        "healthStatus": undefined,
         "id": "404c8821-d3ba-4794-8cee-853f3952ca99",
         "lastModified": 1993-01-01T00:00:00.000Z,
         "name": "Simple test name for webhook (Zapier)",
         "secret": "sample_secret",
         "triggers": {
           "deliveryApiContentChanges": [
-            WebhookDeliveryApiContentChanges {
+            LegacyWebhookDeliveryApiContentChanges {
               "operations": [
                 "publish",
                 "unpublish",
               ],
               "type": "content_item_variant",
             },
           ],
+          "managementApiContentChanges": [],
+          "previewDeliveryContentChanges": [],
           "workflowStepChanges": [],
         },
         "url": "https://test-url.test",