Merge pull request #76 from ninetailed-inc/NT-665-sdk-fix-setup-and-export-scripts

feat: add new scripts for Contentful setup and export, and update pac…

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=
+
+CONTENTFUL_SPACE_ID=
+CONTENTFUL_ENVIRONMENT=
+NEXT_PUBLIC_CONTENTFUL_TOKEN=
+NEXT_PUBLIC_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/export.js

@@ -9,25 +9,26 @@ dotEnv.config({ path: `${process.env.PATH_TO_ENV_FILE}` });
  * */
 const exportOptions = {
   spaceId: process.env.CONTENTFUL_SPACE_ID,
-  environmentId: process.env.CONTENTFUL_ENVIRONMENT,
+  environmentId: process.env.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.CONTENTFUL_MANAGEMENT_TOKEN
 ) {
   throw new Error(
     [
       'Parameters missing...',
-      'Please insert the following credentials into your .env.local.local file:',
+      'Please insert the following credentials into your .env.local file:',
       '- 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

@@ -10,7 +10,7 @@ const importOptions = {
   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 (
@@ -20,10 +20,9 @@ if (
   throw new Error(
     [
       'Parameters missing...',
-      'Please insert the following credentials into your .env.local.local file:',
+      'Please insert the following credentials into your .env.local file:',
       '- 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')