Updated timezone-data package to use TypeScript (#480)

binary-koan · web-flow · commit d4a312886e91 · 2023-10-26T10:34:54.000+01:00
refs https://github.com/TryGhost/Product/issues/4073
diff --git a/.gitignore b/.gitignore
@@ -63,6 +63,7 @@ typings/
 .idea/*
 *.iml
 *.sublime-*
+.vscode
 
 # OSX
 .DS_Store
diff --git a/package.json b/package.json
@@ -20,7 +20,7 @@
   },
   "devDependencies": {
     "eslint": "8.39.0",
-    "eslint-plugin-ghost": "2.16.0",
+    "eslint-plugin-ghost": "3.3.2",
     "eslint-plugin-react": "7.32.2",
     "lerna": "6.6.2",
     "mocha": "10.2.0",
diff --git a/packages/adapter-base-cache/index.js b/packages/adapter-base-cache/index.js
@@ -1 +1 @@
-module.exports = require('./lib/adapter-base-cache');
+module.exports = require('./lib/BaseCacheAdapter');
diff --git a/packages/adapter-base-cache/lib/BaseCacheAdapter.js b/packages/adapter-base-cache/lib/BaseCacheAdapter.js
diff --git a/packages/adapter-base-cache/test/BaseCacheAdapter.test.js b/packages/adapter-base-cache/test/BaseCacheAdapter.test.js
@@ -1,4 +1,4 @@
-const assert = require('assert');
+const assert = require('assert/strict');
 const BaseCacheAdapter = require('../index');
 
 describe('adapter base cache', function () {
diff --git a/packages/admin-api/.eslintrc.js b/packages/admin-api/.eslintrc.js
@@ -2,5 +2,8 @@ module.exports = {
     plugins: ['ghost'],
     extends: [
         'plugin:ghost/node'
-    ]
+    ],
+    rules: {
+        'ghost/ghost-custom/no-native-error': 'off'
+    }
 };
diff --git a/packages/limit-service/index.js b/packages/limit-service/index.js
@@ -0,0 +1 @@
+module.exports = require('./lib/LimitService');
diff --git a/packages/limit-service/lib/LimitService.js b/packages/limit-service/lib/LimitService.js
diff --git a/packages/limit-service/package.json b/packages/limit-service/package.json
@@ -4,8 +4,8 @@
   "repository": "https://github.com/TryGhost/SDK/tree/main/packages/limit-service",
   "author": "Ghost Foundation",
   "license": "MIT",
-  "main": "./lib/limit-service.js",
-  "exports": "./lib/limit-service.js",
+  "main": "index.js",
+  "exports": "./index.js",
   "scripts": {
     "dev": "echo \"Implement me!\"",
     "test": "NODE_ENV=testing c8 --all --reporter text --reporter cobertura mocha './test/**/*.test.js'",
diff --git a/packages/limit-service/test/LimitService.test.js b/packages/limit-service/test/LimitService.test.js
@@ -2,7 +2,7 @@
 // const testUtils = require('./utils');
 require('./utils');
 const should = require('should');
-const LimitService = require('../lib/limit-service');
+const LimitService = require('../lib/LimitService');
 const {MaxLimit, MaxPeriodicLimit, FlagLimit} = require('../lib/limit');
 const sinon = require('sinon');
 
diff --git a/packages/string/lib/escape-html.js b/packages/string/lib/escape-html.js
diff --git a/packages/string/lib/index.js b/packages/string/lib/index.js
@@ -1,3 +1,3 @@
-module.exports.stripInvisibleChars = require('./stripInvisibleChars');
+module.exports.stripInvisibleChars = require('./strip-invisible-chars');
 module.exports.slugify = require('./slugify');
-module.exports.escapeHtml = require('./escapeHtml');
+module.exports.escapeHtml = require('./escape-html');
diff --git a/packages/string/lib/slugify.js b/packages/string/lib/slugify.js
@@ -1,5 +1,5 @@
 const unidecode = require('unidecode');
-const stripInvisibleChars = require('./stripInvisibleChars');
+const stripInvisibleChars = require('./strip-invisible-chars');
 
 /**
  * Slugify
diff --git a/packages/string/lib/strip-invisible-chars.js b/packages/string/lib/strip-invisible-chars.js
diff --git a/packages/timezone-data/.eslintrc.js b/packages/timezone-data/.eslintrc.js
@@ -2,6 +2,6 @@
 module.exports = {
     plugins: ['ghost'],
     extends: [
-        'plugin:ghost/es'
+        'plugin:ghost/ts'
     ]
 };
diff --git a/packages/timezone-data/.gitignore b/packages/timezone-data/.gitignore
@@ -1,3 +1,4 @@
 cjs/
 umd/
 es/
+types/
diff --git a/packages/timezone-data/package.json b/packages/timezone-data/package.json
@@ -8,20 +8,22 @@
   "umd:main": "umd/timezone-data.min.js",
   "unpkg": "umd/timezone-data.min.js",
   "module": "es/timezone-data.js",
-  "source": "lib/index.js",
+  "source": "src/index.ts",
+  "types": "types/index.d.ts",
   "files": [
     "LICENSE",
     "README.md",
     "cjs/",
-    "lib/",
+    "src/",
     "umd/",
-    "es/"
+    "es/",
+    "types/"
   ],
   "scripts": {
     "dev": "echo \"Implement me!\"",
     "pretest": "yarn build",
     "test": "NODE_ENV=testing c8 --all --reporter text --reporter cobertura mocha './test/**/*.test.js'",
-    "build": "rollup -c",
+    "build": "rollup -c && tsc --declaration --emitDeclarationOnly --declarationDir ./types",
     "lint": "eslint . --ext .js --cache",
     "prepare": "NODE_ENV=production yarn build",
     "posttest": "yarn lint"
@@ -30,16 +32,15 @@
     "access": "public"
   },
   "devDependencies": {
-    "@babel/core": "7.23.2",
-    "@babel/preset-env": "7.23.2",
+    "@rollup/plugin-typescript": "11.1.5",
     "c8": "7.13.0",
     "mocha": "10.2.0",
     "rollup": "2.79.1",
-    "rollup-plugin-babel": "4.4.0",
     "rollup-plugin-commonjs": "10.1.0",
     "rollup-plugin-node-resolve": "5.2.0",
     "rollup-plugin-terser": "7.0.2",
     "should": "13.2.3",
-    "sinon": "15.0.4"
+    "sinon": "15.0.4",
+    "typescript": "5.2.2"
   }
 }
diff --git a/packages/timezone-data/rollup.config.js b/packages/timezone-data/rollup.config.js
@@ -1,7 +1,7 @@
 /* eslint-env node */
-import resolve from 'rollup-plugin-node-resolve';
-import babel from 'rollup-plugin-babel';
+import typescript from '@rollup/plugin-typescript';
 import commonjs from 'rollup-plugin-commonjs';
+import resolve from 'rollup-plugin-node-resolve';
 import {terser} from 'rollup-plugin-terser';
 import pkg from './package.json';
 
@@ -16,6 +16,7 @@ export default [
             interop: false
         },
         plugins: [
+            typescript(),
             commonjs({
                 include: ['node_modules/**', '../../node_modules/**']
             })
@@ -36,18 +37,9 @@ export default [
             resolve({
                 browser: true
             }),
+            typescript(),
             commonjs({
                 include: ['node_modules/**', '../../node_modules/**']
-            }),
-            babel({
-                presets: [
-                    ['@babel/preset-env', {
-                        modules: false,
-                        targets: 'defaults',
-                        useBuiltIns: 'usage'
-                    }]
-                ],
-                exclude: ['node_modules/**', '../../node_modules/**']
             })
         ]
     },
@@ -67,19 +59,10 @@ export default [
             resolve({
                 browser: true
             }),
+            typescript(),
             commonjs({
                 include: ['node_modules/**', '../../node_modules/**']
             }),
-            babel({
-                presets: [
-                    ['@babel/preset-env', {
-                        modules: false,
-                        targets: 'defaults',
-                        useBuiltIns: 'usage'
-                    }]
-                ],
-                exclude: ['node_modules/**', '../../node_modules/**']
-            }),
             terser()
         ]
     }
diff --git a/packages/timezone-data/src/index.ts b/packages/timezone-data/src/index.ts
@@ -1,4 +1,4 @@
-export default [
+const timezoneData: {name: string; label: string}[] = [
     {
         name: 'Pacific/Pago_Pago',
         label: '(GMT -11:00) Midway Island, Samoa'
@@ -264,3 +264,5 @@ export default [
         label: '(GMT +12:00) International Date Line West'
     }
 ];
+
+export default timezoneData;
diff --git a/packages/timezone-data/tsconfig.json b/packages/timezone-data/tsconfig.json
@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "es2016",
+    "module": "ESNext",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "skipLibCheck": true
+  },
+  "include": ["src"]
+}
diff --git a/packages/url-utils/index.js b/packages/url-utils/index.js
@@ -1 +1 @@
-module.exports = require('./lib/url-utils');
+module.exports = require('./lib/UrlUtils');
diff --git a/packages/url-utils/lib/UrlUtils.js b/packages/url-utils/lib/UrlUtils.js
diff --git a/packages/url-utils/lib/utils/html-absolute-to-relative.js b/packages/url-utils/lib/utils/html-absolute-to-relative.js
@@ -1,4 +1,4 @@
-const htmlTransform = require('./_html-transform');
+const htmlTransform = require('./html-transform');
 const absoluteToRelative = require('./absolute-to-relative');
 
 function htmlAbsoluteToRelative(html = '', siteUrl, _options) {
diff --git a/packages/url-utils/lib/utils/html-absolute-to-transform-ready.js b/packages/url-utils/lib/utils/html-absolute-to-transform-ready.js
@@ -1,4 +1,4 @@
-const htmlTransform = require('./_html-transform');
+const htmlTransform = require('./html-transform');
 const absoluteToTransformReady = require('./absolute-to-transform-ready');
 
 const htmlAbsoluteToTransformReady = function (html = '', siteUrl, _options) {
diff --git a/packages/url-utils/lib/utils/html-relative-to-absolute.js b/packages/url-utils/lib/utils/html-relative-to-absolute.js
@@ -1,4 +1,4 @@
-const htmlTransform = require('./_html-transform');
+const htmlTransform = require('./html-transform');
 const relativeToAbsolute = require('./relative-to-absolute');
 
 function htmlRelativeToAbsolute(html = '', siteUrl, itemPath, _options) {
diff --git a/packages/url-utils/lib/utils/html-relative-to-transform-ready.js b/packages/url-utils/lib/utils/html-relative-to-transform-ready.js
@@ -1,4 +1,4 @@
-const htmlTransform = require('./_html-transform');
+const htmlTransform = require('./html-transform');
 const relativeToTransformReady = require('./relative-to-transform-ready');
 
 const htmlRelativeToTransformReady = function (html = '', root, itemPath, _options) {
diff --git a/packages/url-utils/lib/utils/html-transform.js b/packages/url-utils/lib/utils/html-transform.js
diff --git a/packages/url-utils/lib/utils/lexical-absolute-to-relative.js b/packages/url-utils/lib/utils/lexical-absolute-to-relative.js
@@ -1,5 +1,5 @@
 const absoluteToRelative = require('./absolute-to-relative');
-const lexicalTransform = require('./_lexical-transform');
+const lexicalTransform = require('./lexical-transform');
 
 function lexicalAbsoluteToRelative(serializedLexical, siteUrl, _options = {}) {
     const defaultOptions = {assetsOnly: false, secure: false, nodes: [], transformMap: {}};
diff --git a/packages/url-utils/lib/utils/lexical-absolute-to-transform-ready.js b/packages/url-utils/lib/utils/lexical-absolute-to-transform-ready.js
@@ -1,5 +1,5 @@
 const absoluteToTransformReady = require('./absolute-to-transform-ready');
-const lexicalTransform = require('./_lexical-transform');
+const lexicalTransform = require('./lexical-transform');
 
 function lexicalAbsoluteToRelative(serializedLexical, siteUrl, _options = {}) {
     const defaultOptions = {assetsOnly: false, secure: false, nodes: [], transformMap: {}};
diff --git a/packages/url-utils/lib/utils/lexical-relative-to-absolute.js b/packages/url-utils/lib/utils/lexical-relative-to-absolute.js
@@ -1,5 +1,5 @@
 const relativeToAbsolute = require('./relative-to-absolute');
-const lexicalTransform = require('./_lexical-transform');
+const lexicalTransform = require('./lexical-transform');
 
 function lexicalRelativeToAbsolute(serializedLexical, siteUrl, itemPath, _options = {}) {
     const defaultOptions = {assetsOnly: false, secure: false, nodes: [], transformMap: {}};
diff --git a/packages/url-utils/lib/utils/lexical-relative-to-transform-ready.js b/packages/url-utils/lib/utils/lexical-relative-to-transform-ready.js
@@ -1,5 +1,5 @@
 const relativeToTransformReady = require('./relative-to-transform-ready');
-const lexicalTransform = require('./_lexical-transform');
+const lexicalTransform = require('./lexical-transform');
 
 function lexicalRelativeToTransformReady(serializedLexical, siteUrl, itemPath, _options = {}) {
     const defaultOptions = {assetsOnly: false, secure: false, nodes: [], transformMap: {}};
diff --git a/packages/url-utils/lib/utils/lexical-transform.js b/packages/url-utils/lib/utils/lexical-transform.js
diff --git a/packages/url-utils/lib/utils/markdown-absolute-to-relative.js b/packages/url-utils/lib/utils/markdown-absolute-to-relative.js
@@ -1,4 +1,4 @@
-const markdownTransform = require('./_markdown-transform');
+const markdownTransform = require('./markdown-transform');
 const absoluteToRelative = require('./absolute-to-relative');
 const htmlAbsoluteToRelative = require('./html-absolute-to-relative');
 
diff --git a/packages/url-utils/lib/utils/markdown-absolute-to-transform-ready.js b/packages/url-utils/lib/utils/markdown-absolute-to-transform-ready.js
@@ -1,4 +1,4 @@
-const markdownTransform = require('./_markdown-transform');
+const markdownTransform = require('./markdown-transform');
 const absoluteToTransformReady = require('./absolute-to-transform-ready');
 const htmlAbsoluteToTransformReady = require('./html-absolute-to-transform-ready');
 
diff --git a/packages/url-utils/lib/utils/markdown-relative-to-absolute.js b/packages/url-utils/lib/utils/markdown-relative-to-absolute.js
@@ -1,4 +1,4 @@
-const markdownTransform = require('./_markdown-transform');
+const markdownTransform = require('./markdown-transform');
 const htmlRelativeToAbsolute = require('./html-relative-to-absolute');
 const relativeToAbsolute = require('./relative-to-absolute');
 
diff --git a/packages/url-utils/lib/utils/markdown-relative-to-transform-ready.js b/packages/url-utils/lib/utils/markdown-relative-to-transform-ready.js
@@ -1,4 +1,4 @@
-const markdownTransform = require('./_markdown-transform');
+const markdownTransform = require('./markdown-transform');
 const htmlRelativeToTransformReady = require('./html-relative-to-transform-ready');
 const relativeToTransformReady = require('./relative-to-transform-ready');
 
diff --git a/packages/url-utils/lib/utils/markdown-transform.js b/packages/url-utils/lib/utils/markdown-transform.js
diff --git a/packages/url-utils/lib/utils/mobiledoc-absolute-to-relative.js b/packages/url-utils/lib/utils/mobiledoc-absolute-to-relative.js
@@ -1,5 +1,5 @@
 const absoluteToRelative = require('./absolute-to-relative');
-const mobiledocTransform = require('./_mobiledoc-transform');
+const mobiledocTransform = require('./mobiledoc-transform');
 
 function mobiledocAbsoluteToRelative(serializedMobiledoc, siteUrl, _options = {}) {
     const defaultOptions = {assetsOnly: false, secure: false, cardTransformers: []};
diff --git a/packages/url-utils/lib/utils/mobiledoc-absolute-to-transform-ready.js b/packages/url-utils/lib/utils/mobiledoc-absolute-to-transform-ready.js
@@ -1,5 +1,5 @@
 const absoluteToTransformReady = require('./absolute-to-transform-ready');
-const mobiledocTransform = require('./_mobiledoc-transform');
+const mobiledocTransform = require('./mobiledoc-transform');
 
 function mobiledocAbsoluteToRelative(serializedMobiledoc, siteUrl, _options = {}) {
     const defaultOptions = {assetsOnly: false, secure: false, cardTransformers: []};
diff --git a/packages/url-utils/lib/utils/mobiledoc-relative-to-absolute.js b/packages/url-utils/lib/utils/mobiledoc-relative-to-absolute.js
@@ -1,5 +1,5 @@
 const relativeToAbsolute = require('./relative-to-absolute');
-const mobiledocTransform = require('./_mobiledoc-transform');
+const mobiledocTransform = require('./mobiledoc-transform');
 
 function mobiledocRelativeToAbsolute(serializedMobiledoc, siteUrl, itemPath, _options = {}) {
     const defaultOptions = {assetsOnly: false, secure: false, cardTransformers: []};
diff --git a/packages/url-utils/lib/utils/mobiledoc-relative-to-transform-ready.js b/packages/url-utils/lib/utils/mobiledoc-relative-to-transform-ready.js
@@ -1,5 +1,5 @@
 const relativeToTransformReady = require('./relative-to-transform-ready');
-const mobiledocTransform = require('./_mobiledoc-transform');
+const mobiledocTransform = require('./mobiledoc-transform');
 
 function mobiledocRelativeToTransformReady(serializedMobiledoc, siteUrl, itemPath, _options = {}) {
     const defaultOptions = {assetsOnly: false, secure: false, cardTransformers: []};
diff --git a/packages/url-utils/lib/utils/mobiledoc-transform.js b/packages/url-utils/lib/utils/mobiledoc-transform.js
diff --git a/packages/url-utils/test/unit/url-utils.test.js b/packages/url-utils/test/unit/url-utils.test.js
@@ -1,10 +1,10 @@
 // Switch these lines once there are useful utils
 // const testUtils = require('./utils');
 require('../utils');
-const assert = require('assert');
+const assert = require('assert/strict');
 
 const sinon = require('sinon');
-const UrlUtils = require('../../lib/url-utils');
+const UrlUtils = require('../../lib/UrlUtils');
 const configUrlHelpers = require('@tryghost/config-url-helpers');
 
 const constants = {
@@ -744,11 +744,11 @@ describe('UrlUtils', function () {
             it('returns true for the root domain', function () {
                 assert(utils.isSiteUrl(new URL('http://localhost:2368')));
             });
-    
+
             it('returns true for a path along the root domain', function () {
                 assert(utils.isSiteUrl(new URL('http://localhost:2368/path')));
             });
-    
+
             it('returns false for a different domain', function () {
                 assert(!utils.isSiteUrl(new URL('https://google.com/path')));
             });
@@ -774,15 +774,15 @@ describe('UrlUtils', function () {
             it('returns true for the root domain with directory', function () {
                 assert(utils.isSiteUrl(new URL('http://localhost:2368/dir/')));
             });
-    
+
             it('returns true for a path along the root domain', function () {
                 assert(utils.isSiteUrl(new URL('http://localhost:2368/dir/path')));
             });
-    
+
             it('returns false for a different domain', function () {
                 assert(!utils.isSiteUrl(new URL('https://google.com/dir/path')));
             });
-    
+
             it('returns false if not on same subdirectory', function () {
                 assert(!utils.isSiteUrl(new URL('http://localhost:2368/different-dir')));
                 // Check if the matching is not dumb and only matches at the start
@@ -803,7 +803,7 @@ describe('UrlUtils', function () {
             it('returns true for the admin domain', function () {
                 assert(utils.isSiteUrl(new URL('http://admin.site/ghost/'), 'admin'));
             });
-    
+
             it('returns false for the site domain', function () {
                 assert(!utils.isSiteUrl(new URL('http://site.site/ghost/'), 'admin'));
             });
diff --git a/packages/url-utils/test/unit/utils/html-absolute-to-transform-ready.test.js b/packages/url-utils/test/unit/utils/html-absolute-to-transform-ready.test.js
@@ -6,7 +6,7 @@ const rewire = require('rewire');
 const sinon = require('sinon');
 
 const cheerio = require('cheerio');
-const htmlTransform = rewire('../../../lib/utils/_html-transform');
+const htmlTransform = rewire('../../../lib/utils/html-transform');
 const htmlAbsoluteToTransformReady = require('../../../lib/utils/html-absolute-to-transform-ready');
 
 describe('utils: htmlAbsoluteToTransformReady()', function () {
diff --git a/packages/url-utils/test/unit/utils/html-relative-to-absolute.test.js b/packages/url-utils/test/unit/utils/html-relative-to-absolute.test.js
@@ -6,7 +6,7 @@ const sinon = require('sinon');
 const rewire = require('rewire');
 
 const cheerio = require('cheerio');
-const htmlTransform = rewire('../../../lib/utils/_html-transform');
+const htmlTransform = rewire('../../../lib/utils/html-transform');
 const htmlRelativeToAbsolute = require('../../../lib/utils/html-relative-to-absolute');
 
 describe('utils: htmlRelativeToAbsolute()', function () {
diff --git a/packages/url-utils/test/unit/utils/lexical-absolute-to-relative.test.js b/packages/url-utils/test/unit/utils/lexical-absolute-to-relative.test.js
diff --git a/packages/url-utils/test/unit/utils/lexical-absolute-to-transform-ready.test.js b/packages/url-utils/test/unit/utils/lexical-absolute-to-transform-ready.test.js
diff --git a/packages/url-utils/test/unit/utils/lexical-relative-to-absolute.test.js b/packages/url-utils/test/unit/utils/lexical-relative-to-absolute.test.js
diff --git a/packages/url-utils/test/unit/utils/lexical-relative-to-transform-ready.test.js b/packages/url-utils/test/unit/utils/lexical-relative-to-transform-ready.test.js
diff --git a/packages/url-utils/test/unit/utils/markdown-absolute-to-relative.test.js b/packages/url-utils/test/unit/utils/markdown-absolute-to-relative.test.js
diff --git a/packages/url-utils/test/unit/utils/markdown-absolute-to-transform-ready.test.js b/packages/url-utils/test/unit/utils/markdown-absolute-to-transform-ready.test.js
diff --git a/packages/url-utils/test/unit/utils/markdown-relative-to-absolute.test.js b/packages/url-utils/test/unit/utils/markdown-relative-to-absolute.test.js
diff --git a/packages/url-utils/test/unit/utils/markdown-relative-to-transform-ready.test.js b/packages/url-utils/test/unit/utils/markdown-relative-to-transform-ready.test.js
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-module.exports = require('./lib/adapter-base-cache');`
	`1`	`+module.exports = require('./lib/BaseCacheAdapter');`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-const assert = require('assert');`
	`1`	`+const assert = require('assert/strict');`
`2`	`2`	`const BaseCacheAdapter = require('../index');`
`3`	`3`
`4`	`4`	`describe('adapter base cache', function () {`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+module.exports = require('./lib/LimitService');`