Initial

.gitignore

@@ -0,0 +1,2 @@
+dist/
+node_modules/

index.d.ts

@@ -0,0 +1,36 @@
+interface TinkrInitContext {}
+interface TinkrPostLaunchContext {}
+
+type TinkrAlias = "tinkr" | "wow";
+
+interface TinkrUtils {
+    downloadFile: (alias: TinkrAlias, fileName: string, url: string) => Promise<boolean>;
+    readFile: (alias: TinkrAlias, fileName: string) => Promise<string>;
+    writeFile: (alias: TinkrAlias, fileName: string, contents: string) => Promise<void>;
+    deleteFile: (alias: TinkrAlias, fileName: string) => Promise<void>;
+    copyFile: (alias: TinkrAlias, sourceFileName: string, destFileName: string) => Promise<void>;
+    moveFile: (alias: TinkrAlias, sourceFileName: string, destFileName: string) => Promise<void>;
+    fileExists: (alias: TinkrAlias, fileName: string) => Promise<boolean>;
+    listFiles: (alias: TinkrAlias, dirName: string) => Promise<string[]>;
+    listDirs: (alias: TinkrAlias, dirName: string) => Promise<string[]>;
+    createDir: (alias: TinkrAlias, dirName: string) => Promise<void>;
+    deleteDir: (alias: TinkrAlias, dirName: string) => Promise<void>;
+    copyDir: (alias: TinkrAlias, sourceDirName: string, destDirName: string) => Promise<void>;
+    moveDir: (alias: TinkrAlias, sourceDirName: string, destDirName: string) => Promise<void>;
+    dirExists: (alias: TinkrAlias, dirName: string) => Promise<boolean>;
+    unzipFile: (alias: TinkrAlias, fileName: string, destDirName: string, destFileName: string) => Promise<void>;
+}
+
+interface TinkrPreLaunchContext {
+    wowPath: string;
+    tinkrPath: string;
+    gameVersion: string;
+    gameRegion: string;
+    utils: TinkrUtils;
+}
+
+interface TinkrPluginHooks {
+    init: (context: TinkrInitContext) => Promise<void>;
+    preLaunch: (context: TinkrPreLaunchContext) => Promise<void>;
+    postLaunch: (context: TinkrPostLaunchContext) => Promise<void>;
+}

package.json

@@ -0,0 +1,25 @@
+{
+  "name": "ts-tinkr-plugin-boilerplate",
+  "version": "1.0.0",
+  "description": "TypeScript Tinkr Plugin Boilerplate",
+  "type": "module",
+  "main": "main.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "rollup -c"
+  },
+  "author": "You",
+  "license": "UNLICENSED",
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^12.1.0",
+    "tslib": "^2.7.0",
+    "typescript": "^5.6.2"
+  },
+  "dependencies": {
+    "@rollup/plugin-commonjs": "^26.0.1",
+    "@rollup/plugin-node-resolve": "^15.2.4",
+    "node-fetch": "^3.3.2",
+    "rollup": "^4.22.4",
+    "rollup-plugin-generate-package-json": "^3.2.0"
+  }
+}

rollup.config.js

@@ -0,0 +1,31 @@
+import resolve from "@rollup/plugin-node-resolve";
+import commonjs from "@rollup/plugin-commonjs";
+import generatePackageJson from "rollup-plugin-generate-package-json";
+import typescript from '@rollup/plugin-typescript';
+
+export default {
+    input: "src/main.ts",
+    output: {
+        file: `dist/${process.env.npm_package_name}/main.js`,
+        format: "cjs",
+        inlineDynamicImports: true,
+    },
+    plugins: [
+        typescript(),
+        resolve({
+            preferBuiltins: true,
+        }),
+        commonjs(),
+        generatePackageJson({
+            outputFolder: `dist/${process.env.npm_package_name}/`,
+            baseContents: (pkg) => ({
+                name: pkg.name,
+                version: pkg.version,
+                description: pkg.description,
+                author: pkg.author,
+                main: "main.js",
+                private: true,
+            }),
+        }),
+    ],
+};

src/main.ts

@@ -0,0 +1,48 @@
+const hooks = {
+    init: async (context: TinkrInitContext) => {
+        console.log("Example plugin loaded", context);
+    },
+
+    preLaunch: async (context: TinkrPreLaunchContext) => {
+        const { utils, wowPath, tinkrPath, gameVersion, gameRegion } = context;
+        // Example of downloading a file
+        const fileDownloaded = await utils.downloadFile("tinkr", "my-plugin.zip", "https://example.com/my-plugin.zip").catch((error)=> {
+            console.error("Failed to download file", error);
+        });
+
+        // files are cached, so this will not download the file again if it has already been downloaded
+        if (fileDownloaded) {
+            // Example of unzipping a file
+            await utils.unzipFile("tinkr", "my-plugin.zip", "tinkr", "my-plugin-zip").catch((error) => {
+                console.error("Failed to unzip file", error);
+            });
+        }
+
+        // Example of writing to the tinkr directory
+        await utils.writeFile("tinkr", "my-plugin.txt", "Hello, world!").catch((error) => {
+            console.error("Failed to write file", error);
+        });;
+
+        // Example of creating a directory
+        await utils.createDir("tinkr", "my-plugin-dir").catch((error) => {
+            console.error("Failed to create directory", error);
+        });
+
+        // Example of writing to a directory
+        await utils.writeFile("tinkr", "my-plugin-dir/my-plugin.txt", "Hello, world!").catch((error) => {
+            console.error("Failed to write file", error);
+        });
+
+        // Example of reading a file
+        const fileContents = await utils.readFile("tinkr", "my-plugin-dir/my-plugin.txt").catch((error) => {
+            console.error("Failed to read file", error);
+        });
+        console.log("File contents:", fileContents);
+    },
+
+    postLaunch: async (context: TinkrPostLaunchContext) => {
+        console.log("postLaunch hook", context);
+    },
+};
+
+export default hooks;

tsconfig.json

@@ -0,0 +1,110 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "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": "es2016",                                  /* 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 legacy experimental 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. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "esnext",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* 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. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "noUncheckedSideEffectImports": true,             /* Check side effect imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "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. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "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": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "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. */
+    // "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. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
+    // "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. */
+    // "strictBuiltinIteratorReturn": true,              /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when 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,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "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. */
+  }
+}