Convert to TypeScript

Author: SergeAstapov

package.json

@@ -92,6 +92,7 @@
     "@glint/template": "^1.5.2",
     "@rollup/plugin-babel": "^6.0.4",
     "@tsconfig/ember": "^3.0.8",
+    "@types/rsvp": "^4.0.9",
     "babel-plugin-ember-template-compilation": "^2.2.5",
     "concurrently": "^9.0.1",
     "decorator-transforms": "^2.2.2",

pnpm-lock.yaml

@@ -48,9 +48,8 @@ export default {
     // Ensure that .gjs files are properly integrated as Javascript
     addon.gjs(),
 
-    // @todo convert addon to TypeScript
-    // // Emit .d.ts declaration files
-    // addon.declarations('declarations'),
+    // Emit .d.ts declaration files
+    addon.declarations('declarations'),
 
     // addons are allowed to contain imports of .css files, which we want rollup
     // to leave alone and keep in the published output.

rollup.config.mjs

@@ -1,2 +1,2 @@
 export { lookupValidator as default } from 'validated-changeset';
-export { setMessages } from './utils/messages.js';
+export { setMessages } from './utils/messages.ts';

src/index.ts

@@ -1,8 +1,10 @@
 import _Messages from 'ember-validators/messages';
 import { capitalize, dasherize } from '@ember/string';
 
-let cachedRef;
-let customMessages;
+type IMessages = Record<string, string>;
+
+let cachedRef: IMessages | undefined;
+let customMessages: IMessages | undefined;
 
 export const defaultMessages = Object.assign({}, _Messages, {
   // Blank and present are flipped in ember-validators. Need to flip them back here
@@ -39,17 +41,17 @@ export const defaultMessages = Object.assign({}, _Messages, {
  *
  * @return {Object}
  */
-export function getMessages() {
+export function getMessages(): object {
   if (cachedRef) {
     return cachedRef;
   }
 
   cachedRef = Object.assign({}, defaultMessages, customMessages);
 
-  return cachedRef;
+  return cachedRef as IMessages;
 }
 
-export function setMessages(messages) {
+export function setMessages(messages: IMessages) {
   customMessages = messages;
   cachedRef = undefined;
 }

src/utils/messages.ts

@@ -4,7 +4,9 @@
  * @returns {Date} the parsed date in the local time zone
  * @throws {TypeError} 1 argument required
  */
-export default function toDate(argument) {
+export default function toDate(
+  argument: Date | number | string | (() => Date | number),
+): Date {
   const argStr = Object.prototype.toString.call(argument);
 
   if (typeof argument === 'function') {

src/utils/to-date.ts

@@ -7,10 +7,16 @@ import { get } from '@ember/object';
 
 import { assert } from '@ember/debug';
 import { getOwnConfig } from '@embroider/macros';
-import { getMessages } from './messages.js';
+import { getMessages } from './messages.ts';
+
+type IOwnConfig =
+  | undefined
+  | {
+      rawOutput: boolean;
+    };
 
 export default function buildMessage(key, result) {
-  let returnsRaw = getOwnConfig()?.rawOutput || false;
+  let returnsRaw = getOwnConfig<IOwnConfig>()?.rawOutput || false;
   let messages = getMessages();
 
   let description = messages.getDescriptionFor(key);

src/utils/validation-errors.ts

@@ -1,4 +1,4 @@
-import buildMessage from '../utils/validation-errors.js';
+import buildMessage from '../utils/validation-errors.ts';
 import evValidateConfirmation from 'ember-validators/confirmation';
 
 export default function validateConfirmation(options = {}) {

src/validators/confirmation.ts

@@ -1,6 +1,6 @@
-import buildMessage from '../utils/validation-errors.js';
-import withDefaults from '../utils/with-defaults.js';
-import toDate from '../utils/to-date.js';
+import buildMessage from '../utils/validation-errors.ts';
+import withDefaults from '../utils/with-defaults.ts';
+import toDate from '../utils/to-date.ts';
 
 const errorFormat = 'MMM Do, YYYY';
 

src/validators/date.ts

@@ -1,4 +1,4 @@
-import buildMessage from '../utils/validation-errors.js';
+import buildMessage from '../utils/validation-errors.ts';
 import evValidateExclusion from 'ember-validators/exclusion';
 
 export default function validateExclusion(options = {}) {

src/validators/exclusion.ts

@@ -1,5 +1,5 @@
 import { isEmpty } from '@ember/utils';
-import buildMessage from '../utils/validation-errors.js';
+import buildMessage from '../utils/validation-errors.ts';
 import evValidateFormat from 'ember-validators/format';
 
 export default function validateFormat(options = {}) {

src/validators/format.ts

@@ -1,4 +1,4 @@
-import buildMessage from '../utils/validation-errors.js';
+import buildMessage from '../utils/validation-errors.ts';
 import evValidateInclusion from 'ember-validators/inclusion';
 
 export default function validateInclusion(options = {}) {

src/validators/inclusion.ts

@@ -1,8 +1,8 @@
-export { default as validateDate } from './date.js';
-export { default as validatePresence } from './presence.js';
-export { default as validateLength } from './length.js';
-export { default as validateNumber } from './number.js';
-export { default as validateFormat } from './format.js';
-export { default as validateInclusion } from './inclusion.js';
-export { default as validateExclusion } from './exclusion.js';
-export { default as validateConfirmation } from './confirmation.js';
+export { default as validateDate } from './date.ts';
+export { default as validatePresence } from './presence.ts';
+export { default as validateLength } from './length.ts';
+export { default as validateNumber } from './number.ts';
+export { default as validateFormat } from './format.ts';
+export { default as validateInclusion } from './inclusion.ts';
+export { default as validateExclusion } from './exclusion.ts';
+export { default as validateConfirmation } from './confirmation.ts';

src/validators/index.ts

@@ -1,5 +1,5 @@
-import buildMessage from '../utils/validation-errors.js';
-import withDefaults from '../utils/with-defaults.js';
+import buildMessage from '../utils/validation-errors.ts';
+import withDefaults from '../utils/with-defaults.ts';
 import evValidateLength from 'ember-validators/length';
 
 export default function validateLength(options = {}) {

src/validators/length.ts

@@ -1,5 +1,5 @@
-import buildMessage from '../utils/validation-errors.js';
-import withDefaults from '../utils/with-defaults.js';
+import buildMessage from '../utils/validation-errors.ts';
+import withDefaults from '../utils/with-defaults.ts';
 import evValidateNumber from 'ember-validators/number';
 
 export default function validateNumber(options = {}) {

src/validators/number.ts

@@ -1,4 +1,4 @@
-import buildMessage from '../utils/validation-errors.js';
+import buildMessage from '../utils/validation-errors.ts';
 import evValidatePresence from 'ember-validators/presence';
 import { get } from '@ember/object';