feat: add dynamic window pathing, adjust tests, add prettier, cleanup tsconfig

.eslintrc.js

@@ -9,7 +9,16 @@ module.exports = {
   plugins: ["@typescript-eslint", "prettier"],
   root: true,
   rules: {
-    "prettier/prettier": "error",
+    "prettier/prettier": [
+      "error",
+      {
+        tabWidth: 2,
+        singleQuote: false,
+        trailingComma: "all",
+        printWidth: 120,
+        bracketSpacing: true,
+      },
+    ],
     "no-unused-vars": "off",
     "@typescript-eslint/no-unused-vars": [
       "error", // or "error"

package.json

@@ -11,8 +11,8 @@
     "build": "tsc",
     "coverage": "vitest run --coverage",
     "dev": "vitest",
-    "lint": "eslint -c .eslintrc.js './src/**/*.ts' --ignore-path .gitignore",
-    "lint:fix": "eslint -c .eslintrc.js './src/**/*.ts' --fix --ignore-path .gitignore",
+    "lint": "eslint -c .eslintrc.js \"./src/**/*.ts\" --ignore-path .gitignore",
+    "lint:fix": "eslint -c .eslintrc.js \"./src/**/*.ts\" --fix --ignore-path .gitignore",
     "test": "vitest run"
   },
   "keywords": [],

src/binder/index.ts

@@ -0,0 +1,83 @@
+/**
+ * Safely binds functions to globalThis
+ *
+ * @example
+ * ```ts
+ * type bindings = { test: Function };
+ *
+ * setObject<bindings>("wallet", bindings);
+ * ```
+ *
+ * @export
+ * @template T
+ * @param {string} name
+ * @param {T} bindings
+ */
+export function setObject<T = object>(name: string, bindings: T) {
+  (
+    globalThis as typeof globalThis & {
+      [key in typeof name]: T;
+    }
+  )[name] = bindings;
+}
+
+/**
+ * Safely binds class functions to globalThis
+ *
+ * @example
+ * ```ts
+ * class Test {
+ *    constructor(){}
+ *
+ *    test1() {}
+ * }
+ *
+ * setClass('wallet', new Test());
+ * ```
+ *
+ * @export
+ * @template T
+ * @param {string} name
+ * @param {T} bindings
+ */
+export function setClass<T = object>(name: string, bindings: T) {
+  const target = globalThis as typeof globalThis & {
+    [key in typeof name]: object;
+  };
+
+  const newBindings: { [key: string]: Function } = {};
+  for (let key of Object.getOwnPropertyNames(Object.getPrototypeOf(bindings))) {
+    if (typeof key !== "string") {
+      continue;
+    }
+
+    newBindings[key] = (bindings as { [key: string]: Function })[key].bind(
+      bindings
+    );
+  }
+
+  target[name] = newBindings;
+}
+
+/**
+ * Returns bindings assigned to globalThis
+ *
+ * @example
+ * ```
+ * type bindings = { test: Function };
+ *
+ * const wallet = get<bindings>("wallet");
+ * ```
+ *
+ * @export
+ * @template T
+ * @param {string} name
+ * @return {T}
+ */
+export function get<T = object>(name: string): T {
+  return (
+    globalThis as typeof globalThis & {
+      [key in typeof name]: T;
+    }
+  )[name];
+}

src/index.test.ts

@@ -0,0 +1,65 @@
+import * as bindings from "./binder";
+import { expect, test } from "vitest";
+
+declare global {
+  // eslint-disable-next-line no-var
+  var wallet: typeof testBindings;
+}
+
+const testBindings = {
+  test1() {},
+  test2() {},
+  test3() {},
+};
+
+let index = 0;
+
+class Test {
+  private id = 0;
+
+  constructor() {
+    this.id = index;
+    index += 1;
+  }
+
+  getId() {
+    return this.id;
+  }
+}
+
+test("test binding to 'window' or 'global' variables with object", () => {
+  const bindingName = "wallet";
+
+  const target = typeof window !== "undefined" ? window : global;
+
+  expect(typeof target).not.toBe("undefined");
+  expect(Object.hasOwn(target, bindingName)).toBe(false);
+
+  bindings.setObject(bindingName, testBindings);
+
+  expect(typeof target[bindingName]).not.toBe("undefined");
+
+  const result = bindings.get<typeof testBindings>(bindingName);
+  expect(typeof result.test1).toBe("function");
+  expect(typeof result.test2).toBe("function");
+  expect(typeof result.test3).toBe("function");
+});
+
+test("test binding to 'window' or 'global' variables with class", () => {
+  const bindingName = "wallet";
+
+  // Bindings testing
+  const testClass = new Test();
+  expect(testClass.getId() === 0).toBe(true);
+  const testClass2 = new Test();
+  expect(testClass2.getId() === 1).toBe(true);
+
+  bindings.setClass(bindingName, testClass);
+
+  const target = typeof window !== "undefined" ? window : global;
+  expect(typeof target[bindingName]).not.toBe("undefined");
+
+  const result = bindings.get<Test>(bindingName);
+  expect(typeof result.getId).toBe("function");
+  expect(result.getId() === 0).toBe(true);
+});

tsconfig.json

@@ -6,101 +6,17 @@
       "node_modules"
     ],
     "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": "esnext",                                     /* 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": "./src/",                                  /* Specify the root folder within your source files. */
-      // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
-      // "baseUrl": "./",                                  /* 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": false,                      /* Only output d.ts files and not JavaScript files. */
-      // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
-      //"outFile": "./lib/index",                                  /* 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/",                                   /* Specify an output folder for all emitted files. */
-      // "removeComments": true,                           /* 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": "./",                           /* Specify the output directory for generated declaration files. */
-
-      /* 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. */
+      "target": "esnext",       
+      "module": "commonjs",              
+      "rootDir": "./src/", 
+      "declaration": true,              
+      "declarationMap": true,         
+      "emitDeclarationOnly": false,     
+      "outDir": "./lib/",   
+      "esModuleInterop": true,           
+      "forceConsistentCasingInFileNames": true,      
+      "strict": true,      
+      "noImplicitAny": true,      
+      "skipLibCheck": true
     }
   }