fix(#7410): add proper typings for registerWidget and CmsBackendClass

.eslintrc.js

@@ -90,6 +90,7 @@ module.exports = {
       rules: {
         'no-duplicate-imports': [0], // handled by @typescript-eslint
         '@typescript-eslint/ban-types': [0], // TODO enable in future
+        '@typescript-eslint/no-explicit-any': [0], // TODO enable in future
         '@typescript-eslint/no-non-null-assertion': [0],
         '@typescript-eslint/consistent-type-imports': 'error',
         '@typescript-eslint/explicit-function-return-type': [0],
@@ -102,4 +103,5 @@ module.exports = {
       },
     },
   ],
+  ignorePatterns: ['**/dist/**'],
 };

.gitignore

@@ -20,3 +20,4 @@ coverage/
 .temp/
 storybook-static/
 .nx/cache
+tsconfig.tsbuildinfo

jest.config.js

@@ -6,7 +6,7 @@ module.exports = {
     'decap-cms-ui-default': '<rootDir>/packages/decap-cms-ui-default/src/index.js',
     'decap-cms-backend-github': '<rootDir>/packages/decap-cms-backend-github/src/index.ts',
     'decap-cms-lib-widgets': '<rootDir>/packages/decap-cms-lib-widgets/src/index.ts',
-    'decap-cms-widget-object': '<rootDir>/packages/decap-cms-widget-object/src/index.js',
+    'decap-cms-widget-object': '<rootDir>/packages/decap-cms-widget-object/src/index.ts',
     '\\.(css|less)$': '<rootDir>/__mocks__/styleMock.js',
   },
   snapshotSerializers: ['@emotion/jest/serializer'],

package.json

@@ -6,13 +6,13 @@
     "build:esm": "nx run-many -t build:esm",
     "build:demo": "npm run build && ncp packages/decap-cms/dist dev-test/dist/",
     "build-preview": "npm run build && nx run decap-cms:build-preview --output-style=stream",
-    "type-check": "tsc --noEmit",
+    "type-check": "tsc --build",
     "type-check:watch": "npm run type-check -- --watch",
-    "clean": "rimraf \"packages/*/dist\" dev-test/dist \"packages/*/node_modules\" \".nx/cache\"",
+    "clean": "rimraf \"packages/*/dist\" dev-test/dist \"packages/*/node_modules\" \".nx/cache\" \"packages/*/tsconfig.tsbuildinfo\"",
     "reset": "npm run clean",
     "test": "npm run lint && npm run type-check && npm run test:unit",
     "test:all": "npm run test && npm run test:e2e",
-    "test:ci": "npm run lint-quiet && npm run type-check && npm run test:unit",
+    "test:ci": "npm run lint-quiet && npm run test:unit",
     "test:unit": "cross-env NODE_ENV=test jest --no-cache",
     "test:e2e": "npm run build:demo && npm run test:e2e:run",
     "test:e2e:ci": "npm run build:demo && npm run test:e2e:run-ci",
@@ -141,7 +141,7 @@
     "stylelint-processor-styled-components": "^1.10.0",
     "svg-inline-loader": "^0.8.0",
     "to-string-loader": "^1.1.5",
-    "typescript": "^4.9.4",
+    "typescript": "^5.3.0",
     "unist-util-visit": "^1.4.0",
     "webpack": "^5.75.0",
     "webpack-cli": "^5.0.1",

packages/decap-cms-app/package.json

@@ -6,18 +6,20 @@
   "repository": "https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-app",
   "bugs": "https://github.com/decaporg/decap-cms/issues",
   "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
   "main": "dist/decap-cms-app.js",
   "files": [
     "src/",
     "dist/",
     "index.d.ts"
   ],
-  "types": "index.d.ts",
   "scripts": {
     "develop": "npm run build:esm -- --watch",
     "webpack": "node --max_old_space_size=4096 ../../node_modules/webpack/bin/webpack.js",
-    "build": "cross-env NODE_ENV=production run-s webpack",
-    "build:esm": "cross-env NODE_ENV=esm babel src --out-dir dist/esm --ignore \"**/__tests__\" --root-mode upward"
+    "build": "cross-env NODE_ENV=production webpack",
+    "build:esm": "run-p build:types build:babel",
+    "build:babel": "cross-env NODE_ENV=esm babel src --out-dir dist/esm --ignore \"**/__tests__\" --root-mode upward --extensions \".js,.jsx,.ts,.tsx\"",
+    "build:types": "tsc"
   },
   "keywords": [
     "cms",

packages/decap-cms-app/src/index.js → packages/decap-cms-app/src/index.ts

@@ -1,6 +1,13 @@
 import { DecapCmsCore as CMS } from 'decap-cms-core';
 import './extensions.js';
 
+export * from 'decap-cms-core';
+
+declare global {
+  // This is not really a global but a literal injected by babel
+  const DECAP_CMS_APP_VERSION: string;
+}
+
 // Log version
 if (typeof window !== 'undefined') {
   if (typeof DECAP_CMS_APP_VERSION === 'string') {

packages/decap-cms-app/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "composite": true,
+    "outDir": "./dist/esm",
+    "rootDir": "./src"
+  },
+  "include": ["src/**/*"]
+}

packages/decap-cms-backend-aws-cognito-github-proxy/package.json

@@ -6,6 +6,7 @@
   "repository": "https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-backend-aws-cognito-github-proxy",
   "bugs": "https://github.com/decaporg/decap-cms/issues",
   "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
   "main": "dist/decap-cms-backend-aws-cognito-github-proxy.js",
   "keywords": [
     "decap-cms",
@@ -17,7 +18,9 @@
   "scripts": {
     "develop": "npm run build:esm -- --watch",
     "build": "cross-env NODE_ENV=production webpack",
-    "build:esm": "cross-env NODE_ENV=esm babel src --out-dir dist/esm --ignore **/__tests__ --root-mode upward --extensions \".js,.jsx,.ts,.tsx\""
+    "build:esm": "run-p build:types build:babel",
+    "build:babel": "cross-env NODE_ENV=esm babel src --out-dir dist/esm --ignore \"**/__tests__\" --root-mode upward --extensions \".js,.jsx,.ts,.tsx\"",
+    "build:types": "tsc"
   },
   "dependencies": {
     "apollo-cache-inmemory": "^1.6.2",
@@ -40,5 +43,8 @@
     "lodash": "^4.17.11",
     "prop-types": "^15.7.2",
     "react": "^18.2.0"
+  },
+  "devDependencies": {
+    "@types/semaphore": "^1.1.4"
   }
 }

packages/decap-cms-backend-aws-cognito-github-proxy/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "composite": true,
+    "outDir": "./dist/esm",
+    "rootDir": "./src"
+  },
+  "include": ["src/**/*"]
+}

packages/decap-cms-backend-azure/package.json

@@ -6,6 +6,7 @@
   "repository": "https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-backend-azure",
   "bugs": "https://github.com/decaporg/decap-cms/issues",
   "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
   "main": "dist/decap-cms-backend-azure.js",
   "keywords": [
     "decap-cms",
@@ -17,7 +18,9 @@
   "scripts": {
     "develop": "npm run build:esm -- --watch",
     "build": "cross-env NODE_ENV=production webpack",
-    "build:esm": "cross-env NODE_ENV=esm babel src --out-dir dist/esm --ignore **/__tests__ --root-mode upward --extensions \".js,.jsx,.ts,.tsx\""
+    "build:esm": "run-p build:types build:babel",
+    "build:babel": "cross-env NODE_ENV=esm babel src --out-dir dist/esm --ignore \"**/__tests__\" --root-mode upward --extensions \".js,.jsx,.ts,.tsx\"",
+    "build:types": "tsc"
   },
   "dependencies": {
     "js-base64": "^3.0.0",
@@ -33,5 +36,8 @@
     "lodash": "^4.17.11",
     "prop-types": "^15.7.2",
     "react": "^18.2.0"
+  },
+  "devDependencies": {
+    "@types/semaphore": "^1.1.4"
   }
 }

packages/decap-cms-backend-azure/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "composite": true,
+    "outDir": "./dist/esm",
+    "rootDir": "./src"
+  },
+  "include": ["src/**/*"]
+}

packages/decap-cms-backend-bitbucket/package.json

@@ -5,6 +5,7 @@
   "repository": "https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-backend-bitbucket",
   "bugs": "https://github.com/decaporg/decap-cms/issues",
   "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
   "main": "dist/decap-cms-backend-bitbucket.js",
   "license": "MIT",
   "keywords": [
@@ -16,7 +17,9 @@
   "scripts": {
     "develop": "npm run build:esm -- --watch",
     "build": "cross-env NODE_ENV=production webpack",
-    "build:esm": "cross-env NODE_ENV=esm babel src --out-dir dist/esm --ignore \"**/__tests__\" --root-mode upward --extensions \".js,.jsx,.ts,.tsx\""
+    "build:esm": "run-p build:types build:babel",
+    "build:babel": "cross-env NODE_ENV=esm babel src --out-dir dist/esm --ignore \"**/__tests__\" --root-mode upward --extensions \".js,.jsx,.ts,.tsx\"",
+    "build:types": "tsc"
   },
   "dependencies": {
     "common-tags": "^1.8.0",
@@ -34,5 +37,8 @@
     "lodash": "^4.17.11",
     "prop-types": "^15.7.2",
     "react": "^18.2.0"
+  },
+  "devDependencies": {
+    "@types/semaphore": "^1.1.4"
   }
 }

packages/decap-cms-backend-bitbucket/src/API.ts

@@ -469,7 +469,11 @@ export default class API {
                 branch: filesBranch,
                 parseText: false,
               });
-        formData.append(file.path.replace(sourceDir, destDir), content, basename(file.path));
+        formData.append(
+          file.path.replace(sourceDir, destDir),
+          content as Blob,
+          basename(file.path),
+        );
       }
     }