feat: add new scripts for Contentful setup and export, and update package dependencies for improved compatibility

Author: Lotfi Arif

package.json

@@ -13,7 +13,9 @@
     "test-all": "nx run-many --target=test --all --skip-nx-cache",
     "generate:doc": "ts-node -P ./tools/scripts/tsconfig.scripts.json ./tools/scripts/documentation/generate-documentation.ts",
     "prepare": "husky install",
-    "license:add": "ts-node -P ./tools/scripts/tsconfig.scripts.json ./tools/scripts/add-license.ts"
+    "license:add": "ts-node -P ./tools/scripts/tsconfig.scripts.json ./tools/scripts/add-license.ts",
+    "setup": "PATH_TO_ENV_FILE=./packages/playgrounds/easy-hr/.env.local node ./packages/playgrounds/easy-hr/contentful/setup.js",
+    "export": "PATH_TO_ENV_FILE=./packages/playgrounds/easy-hr/.env.local node ./packages/playgrounds/easy-hr/contentful/export.js"
   },
   "private": true,
   "dependencies": {
@@ -28,6 +30,10 @@
     "async-retry": "1.3.3",
     "classnames": "2.3.2",
     "contentful": "9.2.14",
+    "contentful-export": "7.18.16",
+    "contentful-import": "8.3.0",
+    "contentful-management": "10.15.1",
+    "contentful-typescript-codegen": "3.2.3",
     "core-js": "3.26.1",
     "diary": "0.4.4",
     "dot": "1.1.3",

packages/playgrounds/easy-hr/.env.local.example

@@ -0,0 +1,16 @@
+NEXT_PUBLIC_NINETAILED_CLIENT_ID=
+NEXT_PUBLIC_NINETAILED_ENVIRONMENT=
+
+NEXT_PUBLIC_NINETAILED_MANAGEMENT_CLIENT_ID=
+NEXT_PUBLIC_NINETAILED_MANAGEMENT_SECRET=
+
+NEXT_PUBLIC_GTM_ID=
+
+NEXT_PUBLIC_CONTENTFUL_SPACE_ID=
+NEXT_PUBLIC_CONTENTFUL_ENVIRONMENT=
+CONTENTFUL_TOKEN=
+CONTENTFUL_PREVIEW_TOKEN=
+CONTENTFUL_PREVIEW_SECRET=
+
+CONTENTFUL_MANAGEMENT_TOKEN=
+CONTENTFUL_SPACE_DATA_LOCATION=./packages/playgrounds/easy-hr/contentful/data/contentful-space-data.json

packages/playgrounds/easy-hr/contentful/deleteEntriesOfContentType.js

@@ -26,21 +26,23 @@ async function unpublishAndDeleteEntry(entry) {
   }
 }
 
-contentfulClient.getSpace(process.env.CONTENTFUL_SPACE_ID).then((space) => {
-  space
-    .getEnvironment(process.env.CONTENTFUL_ENVIRONMENT)
-    .then((environment) => {
-      console.info(`Accessing Environment: ${environment.sys.id}`);
-      console.info(
-        `Deleting Entries Of ContentType: ${process.env.CONTENT_TYPE} `
-      );
-      environment
-        .getEntries({
-          content_type: `${process.env.CONTENT_TYPE}`,
-          limit: `${process.env.LIMIT}`,
-        })
-        .then(async (response) => {
-          await Promise.all(response.items.map(unpublishAndDeleteEntry));
-        });
-    });
-});
+contentfulClient
+  .getSpace(process.env.NEXT_PUBLIC_CONTENTFUL_SPACE_ID)
+  .then((space) => {
+    space
+      .getEnvironment(process.env.NEXT_PUBLIC_CONTENTFUL_ENVIRONMENT)
+      .then((environment) => {
+        console.info(`Accessing Environment: ${environment.sys.id}`);
+        console.info(
+          `Deleting Entries Of ContentType: ${process.env.CONTENT_TYPE} `
+        );
+        environment
+          .getEntries({
+            content_type: `${process.env.CONTENT_TYPE}`,
+            limit: `${process.env.LIMIT}`,
+          })
+          .then(async (response) => {
+            await Promise.all(response.items.map(unpublishAndDeleteEntry));
+          });
+      });
+  });

packages/playgrounds/easy-hr/contentful/export.js

@@ -8,26 +8,27 @@ dotEnv.config({ path: `${process.env.PATH_TO_ENV_FILE}` });
  * just the latest published versions of your content
  * */
 const exportOptions = {
-  spaceId: process.env.CONTENTFUL_SPACE_ID,
-  environmentId: process.env.CONTENTFUL_ENVIRONMENT,
+  spaceId: process.env.NEXT_PUBLIC_CONTENTFUL_SPACE_ID,
+  environmentId: process.env.NEXT_PUBLIC_CONTENTFUL_ENVIRONMENT || 'master',
   managementToken: process.env.CONTENTFUL_MANAGEMENT_TOKEN,
-  /* deliveryToken: process.env.CONTENTFUL_TOKEN, */
-  contentFile: process.env.CONTENTFUL_SPACE_DATA_LOCATION,
+  contentFile:
+    process.env.CONTENTFUL_SPACE_DATA_LOCATION ||
+    './packages/playgrounds/easy-hr/contentful/data/contentful-space-data.json',
   includeDrafts: true,
+  skipRoles: true,
+  skipWebhooks: true,
 };
 
 if (
-  !process.env.CONTENTFUL_SPACE_ID ||
-  !process.env.CONTENTFUL_MANAGEMENT_TOKEN ||
-  !process.env.CONTENTFUL_SPACE_DATA_LOCATION
+  !process.env.NEXT_PUBLIC_CONTENTFUL_SPACE_ID ||
+  !process.env.CONTENTFUL_MANAGEMENT_TOKEN
 ) {
   throw new Error(
     [
       'Parameters missing...',
-      'Please insert the following credentials into your .env.local.local file:',
-      '- CONTENTFUL_SPACE_ID=XXX',
+      'Please insert the following credentials into your .env.local file:',
+      '- NEXT_PUBLIC_CONTENTFUL_SPACE_ID=XXX',
       '- CONTENTFUL_MANAGEMENT_TOKEN=CFPAT-XXX',
-      '- CONTENTFUL_SPACE_DATA_LOCATION="PATH TO STORAGE DIRECTORY"',
       'Afterwards run the export command as follows:',
       '"npm run export" or "yarn export"',
     ].join('\n')

packages/playgrounds/easy-hr/contentful/setup.js

@@ -5,25 +5,24 @@ const dotEnv = require('dotenv');
 dotEnv.config({ path: `${process.env.PATH_TO_ENV_FILE}` });
 
 const importOptions = {
-  spaceId: process.env.CONTENTFUL_SPACE_ID,
-  environmentId: process.env.CONTENTFUL_ENVIRONMENT || 'master',
+  spaceId: process.env.NEXT_PUBLIC_CONTENTFUL_SPACE_ID,
+  environmentId: process.env.NEXT_PUBLIC_CONTENTFUL_ENVIRONMENT || 'master',
   managementToken: process.env.CONTENTFUL_MANAGEMENT_TOKEN,
   contentFile:
     process.env.CONTENTFUL_SPACE_DATA_LOCATION ||
-    './contentful/data/contentful-space-data.json',
+    './packages/playgrounds/easy-hr/contentful/data/contentful-space-data.json',
 };
 
 if (
-  !process.env.CONTENTFUL_SPACE_ID ||
+  !process.env.NEXT_PUBLIC_CONTENTFUL_SPACE_ID ||
   !process.env.CONTENTFUL_MANAGEMENT_TOKEN
 ) {
   throw new Error(
     [
       'Parameters missing...',
-      'Please insert the following credentials into your .env.local.local file:',
-      '- CONTENTFUL_SPACE_ID=XXX',
+      'Please insert the following credentials into your .env.local file:',
+      '- NEXT_PUBLIC_CONTENTFUL_SPACE_ID=XXX',
       '- CONTENTFUL_MANAGEMENT_TOKEN=CFPAT-XXX',
-      '- CONTENTFUL_SPACE_DATA_LOCATION="PATH TO STORAGE DIRECTORY"',
       'Afterwards run the setup command as follows:',
       '"npm run setup" or "yarn setup"',
     ].join('\n')

packages/playgrounds/easy-hr/lib/api.ts

@@ -11,13 +11,13 @@ import {
 
 const contentfulClient = createClient({
   space: process.env.NEXT_PUBLIC_CONTENTFUL_SPACE_ID ?? '',
-  accessToken: process.env.NEXT_PUBLIC_CONTENTFUL_TOKEN ?? '',
+  accessToken: process.env.CONTENTFUL_TOKEN ?? '',
   environment: process.env.NEXT_PUBLIC_CONTENTFUL_ENVIRONMENT ?? 'master',
 });
 
 const previewClient = createClient({
   space: process.env.NEXT_PUBLIC_CONTENTFUL_SPACE_ID ?? '',
-  accessToken: process.env.NEXT_PUBLIC_CONTENTFUL_PREVIEW_TOKEN ?? '',
+  accessToken: process.env.CONTENTFUL_PREVIEW_TOKEN ?? '',
   host: 'preview.contentful.com',
 });