@onebeyond/agnostic-cms-harmonizer

Agnostic CMS harmonizer

Library to handle communication with different CMSs in a user-agnostic way.

Contribute

To contribute to this project, you need to follow the next steps:

Requirements

• contentful requirements
• If you don't want to install the contentful CLI you can use the npx command to run it without installing it globally, as it's an optional dependency.

Contentful

1. You have to create a space in contentful to run the tests.
2. Follow the instructions here to create an API key.

Environment variables

Create a .env file in the root of the project with the following content:

CONTENTFUL_ACCESS_TOKEN=your_access_token
CONTENTFUL_ENVIRONMENT=your_environment
CONTENTFUL_SPACE=your_space
CONTENTFUL_ENTRY=your_entry

Import dummy content to your space

To run the e2e tests you need to be authenticated in your contentful account and import the dummy content into the space you created before. The content you need to import is located at __tests__/exports/contentful/agnostic-cms-harmonizer_space.json and should not be updated.

To log in to your contentful account run the following command and follow the instructions in the terminal:

# If you have the contenful-cli installed globally
contenful login

# If you don't have the contenful-cli installed globally
npx contentful-cli login

To import the dummy content run the following command:

# If you have the contenful-cli installed globally
contentful space import --content-file __tests__/exports/contentful/agnostic-cms-harmonizer_space.json --space-id <your-contentful-space-id> --environment-id <your-contentful-environment-id>

# If you don't have the contenful-cli installed globally
npx contentful-cli space import --content-file __tests__/exports/contentful/agnostic-cms-harmonizer_space.json --space-id <your-contentful-space-id> --environment-id <your-contentful-environment-id>

There is also a located at ./__tests__/exports/contentful/config.json in case you need to export your space's content for any reason. You just need to run the following command:

# If you have the contenful-cli installed globally
contentful space export --config ./__tests__/exports/contentful/config.json --space-id <your-contentful-space-id> --environment-id <your-contentful-environment-id>

# If you don't have the contenful-cli installed globally
npx contentful-cli space export --config ./__tests__/exports/contentful/config.json --space-id <your-contentful-space-id> --environment-id <your-contentful-environment-id>

Tests

At this point, no further configuration is required to run the unit tests.

npm run test

More of the same, for the E2E tests. Here it is crucial to have configured our .env and imported the dummy content to our space.

npm run test:e2e

The pipeline is configured to use the Contentful space managed by the [e-mail] account during the E2E tests execution. If the content of these tests needs to be updated in the provider, you must have access to this vault, otherwise, you can open an issue referencing the new content exported.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Íñigo Marquínez Prado 💻 📖 👀

Àlex Serra 💻 ⚠️ 📖 👀

Matyas Angyal 👀 💻 📖 ⚠️

Ulises Gascón 👀

This project follows the all-contributors specification. Contributions of any kind welcome!

Changelog

0.2.0 (2024-03-14)

🆕 Features

• add basic TS configuration (a25489d)
• add commitllint (396bfa6)
• add contentful mapper to harmonize output (18fd836)
• add eslint fot TS (b5fa54d)
• add husky hooks (e3eec74)
• add include as customizable query param for contentful (2c772a3)
• add inferred types and generics to Contentful client (#13) (24482d4)
• add prettier (a913080)
• define HarmonizedOutput type (4150197)
• return id of link items (7c1bb78)

🐛 Bug Fixes

• remove contentful-cli from "dependencies" section (1cf9820)
• remove redundant bool cast and add object cast (#24) (38e5626)
• return undefinded if asset url is not defined (#23) (68d96cd)
• typedocs high CPU usage watch mode (be6cf0d)
• typo (d66de65)

🔧 Others

• add .nvmrc (e933bb3)
• add experimentalTernaries to prettier (b6b36b2)
• add new contents to contentful test data (89b619d)
• add script to format code (98df01d)
• add script to update dependencies (7f76dea)
• apply linter rules (ee84118)
• apply prettier format (bdd3c01)
• contentful e2e space exports (e0e572c)
• deps: bump actions/setup-node from 4.0.1 to 4.0.2 (1bcb62e)
• exclude tests from the build (cbb5f23)
• get space entry contentful without parser (cbedfc1)
• improve contentful export config file (a7ce1da)
• init npm project (5a2529a)
• instance prototype (99b64e5)
• merge main branch (b3c4c26)
• minor changes in the exported contentful data (ea1e25f)
• update .prettierignore file (3036376)
• update content to be able to test localization and nested content (a8becdd)

📝 Docs

• add Bounteous17 as a contributor for review (#27) (14bdd20)
• add docs to protected methods and abstracts (#45) (cdd2dec)
• add matyasjay as a contributor for code, doc, and test (#26) (35129b6)
• autogenerate docs using typedoc (7f3adf7)
• create .all-contributorsrc [skip ci] (a54ba99)
• improve documentation (1e43791)
• improve documentation (2a17f57)
• improve documentation (c2066cc)
• improve readme (4b05d3a)
• improve typedoc configuration (499d498)
• update .all-contributorsrc [skip ci] (dec6ee6)
• update .all-contributorsrc [skip ci] (a2b4608)
• update .all-contributorsrc [skip ci] (fcf5bd5)
• update .all-contributorsrc [skip ci] (04fc4fc)
• update README.md [skip ci] (eb4241b)
• update README.md [skip ci] (515ac01)
• update README.md [skip ci] (d982708)
• update README.md [skip ci] (e75da21)
• update README.md [skip ci] (bf492e8)

🔄 Code Refactoring

• enhance non agnostic cms class extensions (c2bf4a8)
• implement agnostic client abstract methods instead of redefine (c17f4e6)
• query params for contentful getEntry (db9e59e)
• replace enum by object (b1c6e95)
• some agnostic instance class methods protected (2bd00e4)

🔬 Tests

• add test to fetch content in a different locale (8b7adc6)
• e2e update export parsed output data (2d05398)
• fix failing tests (#46) (312decc)
• jest e2e setup (d9974df)
• update snapshot (eff9ee7)

☁️ CI

• add gh action to deploy documentation to gh pages (17a642d)
• main application file (74cccd2)
• running tests action (2c0aad1)
• running tests action (#28) (e697f1d)