@ricsam/quickjs-test-utils 0.0.1 → 1.0.1

package/dist/types/typecheck.d.ts

@@ -0,0 +1,115 @@
+/**
+ * Type-checking utility for QuickJS user code using ts-morph.
+ *
+ * This utility allows you to validate TypeScript code strings against
+ * the QuickJS global type definitions before running them in the sandbox.
+ *
+ * @example
+ * import { typecheckQuickJSCode } from "@ricsam/quickjs-test-utils";
+ *
+ * const result = typecheckQuickJSCode(`
+ *   serve({
+ *     fetch(request, server) {
+ *       return new Response("Hello!");
+ *     }
+ *   });
+ * `, { include: ["fetch"] });
+ *
+ * if (!result.success) {
+ *   console.error("Type errors:", result.errors);
+ * }
+ */
+import { ts } from "ts-morph";
+/**
+ * Result of type-checking QuickJS code.
+ */
+export interface TypecheckResult {
+    /**
+     * Whether the code passed type checking.
+     */
+    success: boolean;
+    /**
+     * Array of type errors found in the code.
+     */
+    errors: TypecheckError[];
+}
+/**
+ * A single type-checking error.
+ */
+export interface TypecheckError {
+    /**
+     * The error message from TypeScript.
+     */
+    message: string;
+    /**
+     * The line number where the error occurred (1-indexed).
+     */
+    line?: number;
+    /**
+     * The column number where the error occurred (1-indexed).
+     */
+    column?: number;
+    /**
+     * The TypeScript error code.
+     */
+    code?: number;
+}
+/**
+ * Options for type-checking QuickJS code.
+ */
+export interface TypecheckOptions {
+    /**
+     * Which package types to include.
+     * @default ["core", "fetch", "fs"]
+     */
+    include?: Array<"core" | "fetch" | "fs">;
+    /**
+     * Additional compiler options to pass to TypeScript.
+     */
+    compilerOptions?: Partial<ts.CompilerOptions>;
+}
+/**
+ * Type-check QuickJS user code against the package type definitions.
+ *
+ * @param code - The TypeScript/JavaScript code to check
+ * @param options - Configuration options
+ * @returns The result of type checking
+ *
+ * @example
+ * // Check code that uses the fetch API
+ * const result = typecheckQuickJSCode(`
+ *   const response = await fetch("https://api.example.com/data");
+ *   const data = await response.json();
+ * `, { include: ["core", "fetch"] });
+ *
+ * @example
+ * // Check code that uses serve()
+ * const result = typecheckQuickJSCode(`
+ *   serve({
+ *     fetch(request, server) {
+ *       return new Response("Hello!");
+ *     }
+ *   });
+ * `, { include: ["fetch"] });
+ *
+ * @example
+ * // Check code that uses the file system API
+ * const result = typecheckQuickJSCode(`
+ *   const root = await fs.getDirectory("/data");
+ *   const file = await root.getFileHandle("config.json");
+ * `, { include: ["core", "fs"] });
+ */
+export declare function typecheckQuickJSCode(code: string, options?: TypecheckOptions): TypecheckResult;
+/**
+ * Format type-check errors for display.
+ *
+ * @param result - The type-check result
+ * @returns A formatted string of errors
+ *
+ * @example
+ * const result = typecheckQuickJSCode(code);
+ * if (!result.success) {
+ *   console.error(formatTypecheckErrors(result));
+ * }
+ */
+export declare function formatTypecheckErrors(result: TypecheckResult): string;

package/package.json

@@ -1,10 +1,66 @@
 {
   "name": "@ricsam/quickjs-test-utils",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @ricsam/quickjs-test-utils",
+  "version": "1.0.1",
+  "main": "./dist/cjs/index.cjs",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "require": "./dist/cjs/index.cjs",
+      "import": "./dist/mjs/index.mjs"
+    }
+  },
+  "scripts": {
+    "build": "bun build ./src/index.ts --outdir ./dist --target bun",
+    "test": "bun test",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "ts-morph": "^24.0.0"
+  },
+  "peerDependencies": {
+    "quickjs-emscripten": "^0.31.0",
+    "@ricsam/quickjs-core": "^0.2.1",
+    "@ricsam/quickjs-fetch": "^0.2.1",
+    "@ricsam/quickjs-fs": "^0.2.1",
+    "@ricsam/quickjs-runtime": "^0.2.1"
+  },
+  "peerDependenciesMeta": {
+    "@ricsam/quickjs-fs": {
+      "optional": true
+    },
+    "@ricsam/quickjs-runtime": {
+      "optional": true
+    }
+  },
+  "author": "Richard Samuelsson",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ricsam/richie-qjs.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ricsam/richie-qjs/issues"
+  },
+  "homepage": "https://github.com/ricsam/richie-qjs#readme",
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
+    "quickjs",
+    "sandbox",
+    "javascript",
+    "runtime",
+    "fetch",
+    "filesystem",
+    "streams",
+    "wasm",
+    "emscripten"
+  ],
+  "description": "Testing utilities for QuickJS runtime",
+  "module": "./dist/mjs/index.mjs",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "README.md"
   ]
-}
+}