implement cjs and esm builds

DylanBulmer · DylanBulmer · commit 6d4ef1b60813 · 2022-12-12T13:34:45.000-05:00
diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml
@@ -35,6 +35,10 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: "16.x"
+      - uses: actions/download-artifact@v3
+        with:
+          name: lib
+          path: lib/
       - run: yarn
       - run: yarn test
 
diff --git a/.swcrc b/.swcrc
@@ -3,10 +3,7 @@
   "jsc": {
     "parser": {
       "syntax": "typescript",
-      "dynamicImport": true,
-      "dts": true,
-      "tsx": false,
-      "decorators": true
+      "dynamicImport": true
     },
     "baseUrl": "./src",
     "paths": {
@@ -15,7 +12,7 @@
       "services/*": ["services/*"],
       "types/*": ["types/*"]
     },
-    "target": "es2022"
+    "target": "es5"
   },
   "env": {
     "targets": {
diff --git a/bin/post-build.sh b/bin/post-build.sh
@@ -0,0 +1,11 @@
+cat >lib/cjs/package.json <<!EOF
+{
+    "type": "commonjs"
+}
+!EOF
+
+cat >lib/esm/package.json <<!EOF
+{
+    "type": "module"
+}
+!EOF
diff --git a/jest.config.json b/jest.config.json
@@ -2,6 +2,6 @@
   "transform": {
     "^.+\\.(t|j)sx?$": "@swc/jest"
   },
-  "testRegex": "/lib/__tests__/.*\\.(test|spec)\\.(jsx?|tsx?)$",
+  "testRegex": "/lib/cjs/__tests__/.*\\.(test|spec)\\.(jsx?|tsx?)$",
   "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"]
 }
diff --git a/package.json b/package.json
@@ -1,16 +1,27 @@
 {
   "name": "@codrjs/core",
-  "version": "1.0.6-patch2",
+  "version": "1.0.6-patch3",
   "description": "An open-sourced customizable annotation tool",
-  "main": "index.js",
+  "main": "./cjs/index.js",
+  "module": "./esm/index.js",
+  "types": "./types/index.d.ts",
   "repository": "git@github.com:CodrJS/Core.git",
   "author": "Dylan Bulmer <dylan@dylanbulmer.com>",
   "license": "MIT",
   "type": "module",
   "private": false,
+  "exports": {
+    ".": {
+      "require": "./cjs/index.js",
+      "import": "./esm/index.js",
+      "types": "./types/index.d.ts"
+    }
+  },
   "scripts": {
     "test": "jest --config jest.config.json --passWithNoTests --coverage",
-    "build": "yarn clean && swc src -d lib --copy-files && tsc --emitDeclarationOnly && cp package.json README.md lib/",
+    "build:esm": "tsc --project tsconfig.esm.json",
+    "build:cjs": "tsc --project tsconfig.cjs.json",
+    "build": "yarn clean && yarn build:cjs && yarn build:esm && cp package.json README.md lib/ && rm -rf ./lib/types/__tests__ && ./bin/post-build.sh",
     "clean": "rm -rf ./lib",
     "format": "prettier --write \"src/**/*.(ts|js)\"",
     "lint": "eslint -c .eslintrc.json --ignore-path .eslintignore --ext .ts src",
diff --git a/src/__tests__/AccessToken.test.ts b/src/__tests__/AccessToken.test.ts
@@ -1,7 +1,8 @@
 import dotenv from "dotenv";
 import { v4 as uuidv4 } from "uuid";
-import AccessToken, { decrypt, encrypt } from "../classes/AccessToken.js";
-import Error from "../classes/Error.js";
+import AccessToken from "../classes/AccessToken";
+import { decrypt, encrypt } from "../utils/AccessToken";
+import Error from "../classes/Error";
 
 dotenv.config();
 
diff --git a/src/__tests__/App.test.ts b/src/__tests__/App.test.ts
@@ -1,5 +1,5 @@
 import dotenv from "dotenv";
-import { App } from "../index.js";
+import { App } from "../";
 
 dotenv.config();
 
diff --git a/src/__tests__/Auth.test.ts b/src/__tests__/Auth.test.ts
@@ -1,7 +1,7 @@
 import dotenv from "dotenv";
 import { v4 as uuidv4 } from "uuid";
-import { App, Authentication } from "../index.js";
-import { encrypt } from "../classes/AccessToken.js";
+import { App, Authentication } from "../";
+import { encrypt } from "../utils/AccessToken";
 
 dotenv.config();
 
diff --git a/src/__tests__/Config.test.ts b/src/__tests__/Config.test.ts
@@ -1,4 +1,4 @@
-import ProjectConfiguration, { ConfigOptions } from "../classes/ProjectConfig.js";
+import ProjectConfiguration, { ConfigOptions } from "../classes/ProjectConfig";
 import options from "../examples/project.json";
 
 describe("Project Configuration", () => {
diff --git a/src/classes/AccessToken.ts b/src/classes/AccessToken.ts
@@ -1,50 +1,18 @@
-import { v4, validate } from "uuid";
-import crypto from "crypto";
+import { v4 } from "uuid";
 import Error from "./Error.js";
+import {
+  decrypt,
+  encrypt,
+  isAccessToken,
+  isUuid,
+} from "../utils/AccessToken.js";
 
-const md5 = (text: string) => {
-  return crypto.createHash("md5").update(text).digest();
-};
-
-interface IAccessToken {
+export interface IAccessToken {
   uuid: typeof v4;
   createdAt: string;
   expired: boolean;
 }
 
-export function isAccessToken(obj: any): obj is IAccessToken {
-  if (obj instanceof Object) {
-    return "uuid" in obj;
-  } else {
-    return false;
-  }
-}
-
-export function isUuid(text: any): text is typeof v4 {
-  return validate(text);
-}
-
-// for encrypting AccessCode object into a string
-export function encrypt(text: string) {
-  let secretKey = md5(process.env.SECRET as string);
-  secretKey = Buffer.concat([secretKey, secretKey.subarray(0, 8)]);
-  const cipher = crypto.createCipheriv("des-ede3", secretKey, "");
-  const encrypted = cipher.update(text, "utf8", "hex");
-  return encrypted + cipher.final("hex");
-}
-
-// for decrypting AccessCode string into an object
-export function decrypt<T>(text: string) {
-  let secretKey = md5(process.env.SECRET as string);
-  secretKey = Buffer.concat([secretKey, secretKey.subarray(0, 8)]);
-  const decipher = crypto.createDecipheriv("des-ede3", secretKey, "");
-  let decrypted = decipher.update(text, "hex");
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  // @ts-ignore
-  decrypted += decipher.final();
-  return JSON.parse(decrypted as unknown as string) as T;
-}
-
 class AccessToken {
   private uuid: typeof v4;
   private createdAt: string;
diff --git a/src/classes/Mail/index.ts b/src/classes/Mail/index.ts
diff --git a/src/classes/MailTemplate/Generic.ts b/src/classes/MailTemplate/Generic.ts
diff --git a/src/classes/MailTemplate/Signin.ts b/src/classes/MailTemplate/Signin.ts
diff --git a/src/classes/MailTemplate/Welcome.ts b/src/classes/MailTemplate/Welcome.ts
diff --git a/src/classes/MailTemplate/index.ts b/src/classes/MailTemplate/index.ts
@@ -1 +1,2 @@
 export { default as Welcome } from "./Welcome.js";
+export { default as Signin } from "./Signin.js";
diff --git a/src/classes/index.ts b/src/classes/index.ts
@@ -0,0 +1,7 @@
+export { default as AccessToken } from "./AccessToken";
+export { default as Email } from "./Email";
+export { default as Error } from "./Error";
+export * as JWT from "./JWT";
+export * as MailTemplate from "./MailTemplate";
+export { default as ProjectConfig } from "./ProjectConfig";
+export { default as Response } from "./Response";
diff --git a/src/index.ts b/src/index.ts
@@ -2,3 +2,6 @@ export { default as App } from "./services/app.js";
 export { default as Mail } from "./services/mail/index.js";
 export { default as Authentication } from "./services/auth.js";
 export { default as Database } from "./services/database.js";
+export * from "./classes";
+export * from "./models";
+export * as Utils from "./utils";
diff --git a/src/models/index.ts b/src/models/index.ts
@@ -0,0 +1,13 @@
+import { default as User } from "./User";
+import { default as UserAbility } from "./User.ability";
+import { default as Profile } from "./User";
+import { default as ProfileAbility } from "./Profile.ability";
+
+export const Model = {
+  User,
+  Profile,
+};
+export const Ability = {
+  UserAbility,
+  ProfileAbility,
+};
diff --git a/src/services/auth.ts b/src/services/auth.ts
@@ -6,12 +6,13 @@ import { v4 as uuidv4 } from "uuid";
 import App from "./app.js";
 import Mail from "./mail/index.js";
 import Email from "../classes/Email.js";
-import SigninTemplate from "../classes/Mail/Template/Signin.js";
+import SigninTemplate from "../classes/MailTemplate/Signin.js";
 import User, { IUser } from "../models/User.js";
 import Response from "../classes/Response.js";
 import { generateToken } from "../classes/JWT.js";
 import Error from "../classes/Error.js";
-import AccessToken, { decrypt, encrypt } from "../classes/AccessToken.js";
+import AccessToken from "../classes/AccessToken.js";
+import { decrypt, encrypt } from "../utils/AccessToken";
 
 interface IAccessCode {
   email: string;
diff --git a/src/utils/AccessToken.ts b/src/utils/AccessToken.ts
@@ -0,0 +1,40 @@
+import { v4, validate } from "uuid";
+import crypto from "crypto";
+import type { IAccessToken } from "../classes/AccessToken.js";
+
+const md5 = (text: string) => {
+  return crypto.createHash("md5").update(text).digest();
+};
+
+export function isAccessToken(obj: any): obj is IAccessToken {
+  if (obj instanceof Object) {
+    return "uuid" in obj;
+  } else {
+    return false;
+  }
+}
+
+export function isUuid(text: any): text is typeof v4 {
+  return validate(text);
+}
+
+// for encrypting AccessCode object into a string
+export function encrypt(text: string) {
+  let secretKey = md5(process.env.SECRET as string);
+  secretKey = Buffer.concat([secretKey, secretKey.subarray(0, 8)]);
+  const cipher = crypto.createCipheriv("des-ede3", secretKey, "");
+  const encrypted = cipher.update(text, "utf8", "hex");
+  return encrypted + cipher.final("hex");
+}
+
+// for decrypting AccessCode string into an object
+export function decrypt<T>(text: string) {
+  let secretKey = md5(process.env.SECRET as string);
+  secretKey = Buffer.concat([secretKey, secretKey.subarray(0, 8)]);
+  const decipher = crypto.createDecipheriv("des-ede3", secretKey, "");
+  let decrypted = decipher.update(text, "hex");
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  decrypted += decipher.final();
+  return JSON.parse(decrypted as unknown as string) as T;
+}
diff --git a/src/utils/index.ts b/src/utils/index.ts
@@ -0,0 +1 @@
+export * as AccessToken from "./AccessToken";
diff --git a/tsconfig.cjs.json b/tsconfig.cjs.json
@@ -0,0 +1,104 @@
+{
+  // "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Projects */
+    "incremental": true,                                 /* Enable incremental compilation */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "ES5",                                     /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+    // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+
+    /* Modules */
+    "module": "CommonJS",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    "moduleResolution": "Node",                          /* Specify how TypeScript looks up a file from a given module specifier. */
+    "baseUrl": "./src",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    "resolveJsonModule": true,                           /* Enable importing .json files */
+    // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+
+    /* Emit */
+    "declaration": true,                                 /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                         /* Only output d.ts files and not JavaScript files. */
+    "sourceMap": true,                                   /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./lib/cjs",                                   /* Specify an output folder for all emitted files. */
+    "removeComments": false,                             /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+    "declarationDir": "./lib/types",                     /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    "noImplicitAny": true,                               /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+    // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
+    // "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true,                                /* Skip type checking all .d.ts files. */
+  },
+  "include": ["src"],
+  "exclude": ["node_modules"],
+}
diff --git a/tsconfig.esm.json b/tsconfig.esm.json

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,6 @@`
`2`	`2`	`"transform": {`
`3`	`3`	`"^.+\\.(t\|j)sx?$": "@swc/jest"`
`4`	`4`	`},`
`5`		`- "testRegex": "/lib/__tests__/.*\\.(test\|spec)\\.(jsx?\|tsx?)$",`
	`5`	`+ "testRegex": "/lib/cjs/__tests__/.*\\.(test\|spec)\\.(jsx?\|tsx?)$",`
`6`	`6`	`"moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"]`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import ProjectConfiguration, { ConfigOptions } from "../classes/ProjectConfig.js";`
	`1`	`+import ProjectConfiguration, { ConfigOptions } from "../classes/ProjectConfig";`
`2`	`2`	`import options from "../examples/project.json";`
`3`	`3`
`4`	`4`	`describe("Project Configuration", () => {`