refactor: Ensure package types are built & validated

Author: nonara

package.json

@@ -3,19 +3,20 @@
   "version": "3.3.1",
   "description": "Transforms module resolution paths using TypeScript path mapping and/or custom paths",
   "main": "dist/index.js",
-  "types": "types/index.d.ts",
+  "types": "dist/index.d.ts",
   "scripts": {
     "compile": "tsc",
-    "build": "yarn run clean && yarn run compile",
+    "build": "yarn run clean && yarn run compile && yarn run check:built-types",
     "test": "jest",
     "release": "standard-version",
     "--------------": "",
     "format": "prettier --write \"{src,test}/**/{*.js,!(*.d).ts}\"",
-    "clean": "rimraf dist **/*.tsbuildinfo",
-    "clean:all": "yarn run clean && rimraf node_modules **/node_modules test/.yarn-cache",
+    "clean": "npx rimraf dist **/*.tsbuildinfo",
+    "clean:all": "yarn run clean && npx rimraf node_modules **/node_modules test/.yarn-cache",
     "reset": "yarn run clean:all && yarn install && yarn build",
+    "check:built-types": "tsc dist/index.d.ts --esModuleInterop",
     "-------------- ": "",
-    "prebuild": "rimraf dist",
+    "prebuild": "npx rimraf dist",
     "install:tests": "cd test && yarn install && cd projects/extras && yarn install",
     "prepare": "yarn run install:tests"
   },

src/index.ts

@@ -1,5 +1,5 @@
 import transformer from "./transformer";
 export default transformer;
 
-export { TsTransformPathsConfig } from "./types";
+export { TsTransformPathsConfig, TransformerExtras } from "./types";
 export { register } from "./register";

src/transformer.ts

@@ -2,13 +2,12 @@
 import {} from "ts-expose-internals";
 import path from "path";
 import ts from "typescript";
-import { cast } from "./utils";
-import { TsTransformPathsConfig, TsTransformPathsContext, TypeScriptThree, VisitorContext } from "./types";
+import { TransformerExtras, TsTransformPathsConfig, TsTransformPathsContext, VisitorContext } from "./types";
 import { nodeVisitor } from "./visitor";
 import { createHarmonyFactory } from "./utils/harmony-factory";
 import { Minimatch } from "minimatch";
 import { createSyntheticEmitHost, getTsNodeRegistrationProperties } from "./utils/ts-helpers";
-import { TransformerExtras } from "ts-patch";
+
 
 /* ****************************************************************************************************************** */
 // region: Helpers
@@ -109,7 +108,6 @@ export default function transformer(
       emitHost,
       isTranspileOnly,
       isTsNode,
-      tsThreeInstance: cast<TypeScriptThree>(tsInstance),
       excludeMatchers: config.exclude?.map((globPattern) => new Minimatch(globPattern, { matchBase: true })),
       outputFileNamesCache: new Map(),
       // Get paths patterns appropriate for TS compiler version

src/utils/harmony-factory.ts

@@ -8,6 +8,8 @@ import TS, {
   NamedExportBindings,
   NamedImportBindings,
 } from "typescript";
+import { cast } from "./general-utils";
+import * as TsThree from '../declarations/typescript3';
 import { TsTransformPathsContext } from "../types";
 import { downSampleTsTypes } from "./ts-type-conversion";
 
@@ -27,7 +29,8 @@ export interface HarmonyFactory extends TS.NodeFactory {}
  * Creates a node factory compatible with TS v3+
  */
 export function createHarmonyFactory(context: TsTransformPathsContext): HarmonyFactory {
-  const { tsThreeInstance } = context;
+  const { tsInstance } = context;
+  const tsThreeInstance = cast<typeof TsThree>(tsInstance);
 
   return new Proxy(context.tsFactory ?? context.tsInstance, {
     get(target, prop) {

src/utils/resolve-module-name.ts

@@ -88,6 +88,7 @@ function getReturnPath(ctx: GetReturnPathContext) {
 
 /**
  * Resolve a module name
+ * @internal — Uses internal TS type
  */
 export function resolveModuleName(
   context: VisitorContext,

src/utils/ts-type-conversion.ts

@@ -28,13 +28,13 @@ type TypeMapping = [
 type TsType = Exclude<TypeMapping[number][0], undefined>;
 type TsThreeType = Exclude<TypeMapping[number][1], undefined>;
 
-export type TsTypeConversion<Tuple extends [...unknown[]]> = {
+type TsTypeConversion<Tuple extends [...unknown[]]> = {
   [i in keyof Tuple]: Tuple[i] extends any[] ? TsTypeConversion<Tuple[i]> : DownSampleTsType<Tuple[i]>;
 } & { length: Tuple["length"] };
 
 type DownSampleTsType<T> = T extends TsType ? Extract<TypeMapping[number], [T, any]>[1] : T;
 
-export type UpSampleTsTypes<Tuple extends [...unknown[]]> = {
+type UpSampleTsTypes<Tuple extends [...unknown[]]> = {
   [i in keyof Tuple]: Tuple[i] extends any[] ? UpSampleTsTypes<Tuple[i]> : UpSampleTsType<Tuple[i]>;
 } & { length: Tuple["length"] };
 
@@ -48,27 +48,31 @@ type UpSampleTsType<T> = T extends TsThreeType ? Extract<TypeMapping[number], [a
 
 /**
  * Convert TS4 to TS3 types
- */
+ * @internal
+*/
 export function downSampleTsTypes<T extends [...unknown[]]>(...args: T): TsTypeConversion<T> {
   return args as TsTypeConversion<T>;
 }
 
 /**
  * Convert TS4 to TS3 type
+ * @internal
  */
 export function downSampleTsType<T>(v: T): DownSampleTsType<T> {
   return v as DownSampleTsType<T>;
 }
 
 /**
  * Convert TS3 to TS4 types
+ * @internal
  */
 export function upSampleTsTypes<T extends [...unknown[]]>(...args: T): UpSampleTsTypes<T> {
   return args as UpSampleTsTypes<T>;
 }
 
 /**
  * Convert TS3 to TS4 type
+ * @internal
  */
 export function upSampleTsType<T extends TsThreeType>(v: T): UpSampleTsType<T> {
   return v as UpSampleTsType<T>;

tsconfig.json

@@ -6,6 +6,7 @@
   "compilerOptions": {
     "rootDir": "src",
     "outDir": "dist",
-    "declaration": true
+    "declaration": true,
+    "stripInternal": true
   }
 }