feat: export csm

.circleci/config.yml

@@ -18,7 +18,9 @@ commands:
       - restore_cache: *cache-key
       - vault/get-secrets:
           template-preset: 'semantic-release'
-      - run: 'echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" >> ~/.npmrc'
+      - run: |
+          echo "//npm.pkg.github.com/:_authToken=${GITHUB_PACKAGES_READ_TOKEN}" > ~/.npmrc
+          echo "@contentful:registry=https://npm.pkg.github.com" >> ~/.npmrc
       - run: yarn install --prefer-offline --pure-lockfile
       - save_cache:
           <<: *cache-key
@@ -50,7 +52,9 @@ jobs:
           template-preset: 'semantic-release'
       - yarn_install
       - vault/configure-lerna
-      - run: echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' > ~/.npmrc
+      - run: |
+          echo "//npm.pkg.github.com/:_authToken=${GITHUB_PACKAGES_WRITE_TOKEN}" > ~/.npmrc
+          echo "@contentful:registry=https://npm.pkg.github.com" >> ~/.npmrc
       - run: yarn build # This should not be needed, but without it it will not contain any files
       - run: yarn version
       - run: yarn publish
@@ -63,7 +67,9 @@ jobs:
           template-preset: 'semantic-release'
       - yarn_install
       - vault/configure-lerna
-      - run: echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' > ~/.npmrc
+      - run: |
+          echo "//npm.pkg.github.com/:_authToken=${GITHUB_PACKAGES_WRITE_TOKEN}" > ~/.npmrc
+          echo "@contentful:registry=https://npm.pkg.github.com" >> ~/.npmrc
       - run: yarn build # This should not be needed, but without it it will not contain any files
       - run: yarn version:canary
       - run: yarn publish:canary

.contentful/vault-secrets.yaml

@@ -3,6 +3,7 @@ services:
   circleci:
     policies:
       - semantic-release
+      - packages-read
   github-action:
     policies:
       - dependabot

.eslintrc.cjs

@@ -1,11 +1,27 @@
 module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+  },
   extends: [
-    require.resolve('@contentful/eslint-config-extension'),
-    require.resolve('@contentful/eslint-config-extension/react.js'),
-    require.resolve('@contentful/eslint-config-extension/typescript.js'),
+    'eslint:recommended',
+    'plugin:react/recommended',
+    'plugin:react-hooks/recommended',
+    'plugin:@typescript-eslint/recommended',
   ],
-  plugins: ['eslint-plugin-import-helpers'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: true,
+    },
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+  plugins: ['react', 'react-hooks', '@typescript-eslint', 'eslint-plugin-import-helpers'],
   rules: {
+    'react-hooks/exhaustive-deps': 'warn',
+    '@typescript-eslint/no-explicit-any': 'warn',
+    '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
     'import-helpers/order-imports': [
       'warn',
       {
@@ -14,6 +30,17 @@ module.exports = {
         alphabetize: { order: 'asc', ignoreCase: true },
       },
     ],
-    'react/react-in-jsx-scope': 'off'
+    'react/react-in-jsx-scope': 'off',
+  },
+  overrides: [
+    {
+      files: ['*.test.ts(x)', '*.spec.tsx(x)'],
+      rules: {
+        '@typescript-eslint/no-empty-function': 'off',
+      },
+    },
+  ],
+  settings: {
+    react: { version: 'detect' },
   },
 };

.github/dependabot.yml

@@ -4,6 +4,10 @@ registries:
     type: npm-registry
     url: https://registry.npmjs.org
     token: '${{secrets.NPM_REGISTRY_REGISTRY_NPMJS_ORG_TOKEN}}'
+  npm-github:
+    type: npm-registry
+    url: https://npm.pkg.github.com
+    token: ${{secrets.NPM_REGISTRY_REGISTRY_GH_ORG_TOKEN}}
 
 updates:
   - package-ecosystem: npm
@@ -21,6 +25,7 @@ updates:
       prefix: chore
     registries:
       - npm-registry-registry-npmjs-org
+      - npm-github
     ignore:
       # https://github.com/lerna/lerna/issues/3765
       - dependency-name: 'prettier'

catalog-info.yaml

@@ -0,0 +1,23 @@
+apiVersion: backstage.io/v1alpha1
+kind: System
+metadata:
+  name: live-preview
+  description: |
+    A Monorepo for all packages around the live preview SDK functionality (inspectorMode and live updates)
+  annotations:
+    circleci.com/project-slug: github/contentful/live-preview
+    github.com/project-slug: contentful/live-preview
+    backstage.io/source-location: url:https://github.com/contentful/live-preview/
+spec:
+  type: library
+  lifecycle: production
+  owner: group:team-tolkien
+---
+apiVersion: backstage.io/v1alpha1
+kind: Location
+metadata:
+  name: live-preview-index
+spec:
+  type: url
+  targets:
+    - ./packages/live-preview-sdk/catalog-info.yaml

examples/next-13-app-router-ssr/package.json

@@ -25,7 +25,7 @@
     "eslint": "8.47.0",
     "eslint-config-next": "13.4.13",
     "relative-deps": "1.0.7",
-    "vite": "4.4.12",
+    "vite": "4.5.2",
     "typescript": "5.1.6"
   }
 }

package.json

@@ -5,6 +5,9 @@
   "license": "MIT",
   "description": "Everything about content preview in contentful",
   "homepage": "https://github.com/contentful/live-preview#readme",
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com/"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/contentful/live-preview.git"
@@ -33,17 +36,22 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "@commitlint/cli": "^18.0.0",
-    "@commitlint/config-conventional": "^18.0.0",
-    "@contentful/eslint-config-extension": "0.4.3",
+    "@commitlint/cli": "18.6.0",
+    "@commitlint/config-conventional": "18.6.0",
+    "@typescript-eslint/eslint-plugin": "6.20.0",
+    "@typescript-eslint/parser": "6.20.0",
     "commitizen": "4.3.0",
     "concurrently": "8.2.2",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-import-helpers": "^1.2.1",
-    "husky": "^8.0.3",
+    "eslint": "8.56.0",
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-import-helpers": "1.3.1",
+    "eslint-plugin-react": "7.33.2",
+    "eslint-plugin-react-hooks": "4.6.0",
+    "husky": "^9.0.6",
     "lerna": "^8.0.0",
     "lint-staged": "^15.0.1",
-    "prettier": "2.8.8"
+    "prettier": "3.2.4",
+    "typescript": "5.3.3"
   },
   "lint-staged": {
     "*.{t,j}s?(x)": [

packages/live-preview-sdk/CHANGELOG.md

@@ -4,11 +4,59 @@ All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
 # [3.0.0-alpha.2](https://github.com/contentful/live-preview/compare/@contentful/[email protected]...@contentful/[email protected]) (2024-01-19)
+## [2.17.3](https://github.com/contentful/live-preview/compare/@contentful/[email protected]...@contentful/[email protected]) (2024-02-05)
+
+**Note:** Version bump only for package @contentful/live-preview
+
+
+
+
+
+## [2.17.2](https://github.com/contentful/live-preview/compare/@contentful/[email protected]...@contentful/[email protected]) (2024-01-26)
+
+**Note:** Version bump only for package @contentful/live-preview
+
+
+
+
+
+## [2.17.1](https://github.com/contentful/live-preview/compare/@contentful/[email protected]...@contentful/[email protected]) (2024-01-26)
+
+
+### Bug Fixes
+
+* pass experimental flags from LivePreviewProvider [TOL-1711] ([#525](https://github.com/contentful/live-preview/issues/525)) ([b9e4bf3](https://github.com/contentful/live-preview/commit/b9e4bf374999d10729ec57f8c4d950862528e5cf))
+
+
+
+
+
+# [2.17.0](https://github.com/contentful/live-preview/compare/@contentful/[email protected]...@contentful/[email protected]) (2024-01-26)
+
+
+### Features
+
+* recognise auto-tagged elements [TOL-1711] ([#523](https://github.com/contentful/live-preview/issues/523)) ([f40704a](https://github.com/contentful/live-preview/commit/f40704aeb10a2c2749402e6fb47c52af85775afe))
+
+
+
+
+
+## [2.16.1](https://github.com/contentful/live-preview/compare/@contentful/[email protected]...@contentful/[email protected]) (2024-01-22)
+
+**Note:** Version bump only for package @contentful/live-preview
+
+
+
+
+
+# [2.16.0](https://github.com/contentful/live-preview/compare/@contentful/[email protected]...@contentful/[email protected]) (2024-01-22)
 
 
 ### Features
 
 * restore unsub logic ([7161b56](https://github.com/contentful/live-preview/commit/7161b560af5b4d1ca832ad26cc8a34f6796bc0fd))
+* setup gh packages [TOL-1702] ([#512](https://github.com/contentful/live-preview/issues/512)) ([21128c9](https://github.com/contentful/live-preview/commit/21128c9d022a6994fda25a8fd17971ce5d13e735))
 
 
 
@@ -28,6 +76,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 
 # [2.15.0-alpha.15](https://github.com/contentful/live-preview/compare/@contentful/[email protected]...@contentful/[email protected]) (2024-01-18)
+## [2.15.2](https://github.com/contentful/live-preview/compare/@contentful/[email protected]...@contentful/[email protected]) (2024-01-22)
 
 **Note:** Version bump only for package @contentful/live-preview
 

packages/live-preview-sdk/catalog-info.yaml

@@ -0,0 +1,14 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: live-preview
+  description: |
+    JavaScript library for Contentful's live preview functionality (inspectorMode and live updates)
+  annotations:
+    circleci.com/project-slug: github/contentful/live-preview
+    github.com/project-slug: contentful/live-preview
+    backstage.io/source-location: url:https://github.com/contentful/live-preview/tree/main/packages/live-preview-sdk
+spec:
+  type: library
+  lifecycle: production
+  owner: group:team-tolkien

packages/live-preview-sdk/package.json

@@ -46,12 +46,14 @@
   "dependencies": {
     "@contentful/rich-text-types": "^16.2.0",
     "flatted": "^3.2.9",
+    "@contentful/visual-sdk": "^1.0.0-alpha.34",
+    "@vercel/stega": "^0.1.0",
     "graphql-tag": "^2.12.6",
     "json-pointer": "^0.6.2",
     "lodash.isequal": "^4.5.0"
   },
   "devDependencies": {
-    "@testing-library/react": "14.1.2",
+    "@testing-library/react": "14.2.1",
     "@types/json-pointer": "^1.0.34",
     "@types/lodash.isequal": "^4.5.6",
     "@types/node": "^20.1.0",
@@ -61,7 +63,7 @@
     "contentful": "^10.3.4",
     "contentful-management": "^11.0.1",
     "graphql": "^16.6.0",
-    "jsdom": "^23.0.0",
+    "jsdom": "^24.0.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "type-fest": "^4.0.0",