feat: added typescript types for exported functions

index.d.ts

@@ -0,0 +1,40 @@
+export type ScrambleType =
+  | "333"
+  | "444"
+  | "555"
+  | "666"
+  | "777"
+  | "222"
+  | "sq1"
+  | "pyraminx"
+  | "skewb"
+  | "mgmp"
+  | "kilominx"
+  | "redi"
+  | "fto"
+  | "clock"
+  | "1x3x3"
+  | "2x2x3"
+  | "333lse"
+  | "gearcube"
+  | "mgmlsll"
+  | "slide"
+  | string;
+
+export interface ScrambleOptions {
+  type?: ScrambleType;
+  length?: number;
+  state?: unknown;
+  neutrality?: number;
+}
+
+export function getScrambleTypes(): ScrambleType[];
+
+export function setSeed(seed: string | number | undefined | null): void;
+
+export function getScramble(
+  type?: ScrambleType,
+  length?: number,
+  state?: unknown,
+  neutrality?: number,
+): string;

package.json

@@ -7,10 +7,12 @@
   "module": "./dist/index.js",
   "exports": {
     ".": {
+      "types": "./index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     }
   },
+  "types": "./index.d.ts",
   "scripts": {
     "build": "tsup",
     "test": "node --input-type=module -e \"import { getScramble, setSeed } from './dist/index.js'; setSeed('42'); console.log(getScramble('333'));\""

tsconfig.json

@@ -0,0 +1,44 @@
+{
+  // Visit https://aka.ms/tsconfig to read more about this file
+  "compilerOptions": {
+    // File Layout
+    // "rootDir": "./src",
+    // "outDir": "./dist",
+
+    // Environment Settings
+    // See also https://aka.ms/tsconfig/module
+    "module": "nodenext",
+    "target": "esnext",
+    "types": [],
+    // For nodejs:
+    // "lib": ["esnext"],
+    // "types": ["node"],
+    // and npm install -D @types/node
+
+    // Other Outputs
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+
+    // Stricter Typechecking Options
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+
+    // Style Options
+    // "noImplicitReturns": true,
+    // "noImplicitOverride": true,
+    // "noUnusedLocals": true,
+    // "noUnusedParameters": true,
+    // "noFallthroughCasesInSwitch": true,
+    // "noPropertyAccessFromIndexSignature": true,
+
+    // Recommended Options
+    "strict": true,
+    "jsx": "react-jsx",
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true
+  }
+}

tsup.config.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("tsup").Options | import("tsup").Options[] | ((overrideOptions: import("tsup").Options) => import("tsup").Options | import("tsup").Options[] | Promise<import("tsup").Options | import("tsup").Options[]>);
+export default _default;
+//# sourceMappingURL=tsup.config.d.ts.map

tsup.config.ts

@@ -1,13 +1,13 @@
 import { defineConfig } from "tsup";
 
 export default defineConfig({
-	entry: ["src/index.js"],
-	format: ["esm", "cjs"],
-	splitting: false,
-	sourcemap: true,
-	clean: true,
-	outDir: "dist",
-	target: "es2020",
-	dts: false,
-	minify: false
+  entry: ["src/index.js"],
+  format: ["esm", "cjs"],
+  splitting: false,
+  sourcemap: true,
+  clean: true,
+  outDir: "dist",
+  target: "es2020",
+  dts: false,
+  minify: false,
 });