taffy-js 0.2.4 → 0.2.5

package/README.md

@@ -23,7 +23,8 @@ npm install taffy-js
 ## 🚀 Quick Start
 
 ```javascript
-import init, {
+import {
+  loadTaffy,
   TaffyTree,
   Style,
   Display,
@@ -33,7 +34,7 @@ import init, {
 
 async function main() {
   // Initialize WebAssembly module
-  await init();
+  await loadTaffy();
 
   // Create a layout tree
   const tree = new TaffyTree();

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Taffy-JS: TypeScript wrapper for Taffy WASM bindings
+ *
+ * This module provides the `loadTaffy` function for initializing the WASM module
+ * and re-exports all types and functions from the underlying WASM bindings.
+ *
+ * @example
+ * ```typescript
+ * import { loadTaffy, TaffyTree, Style, Display } from 'taffy-js';
+ *
+ * await loadTaffy();
+ *
+ * const tree = new TaffyTree();
+ * const style = new Style();
+ * style.display = Display.Flex;
+ * const node = tree.newLeaf(style);
+ * ```
+ */
+export * from "../pkg/taffy_wasm.js";
+export type { InitOutput } from "../pkg/taffy_wasm.js";
+import type { InitOutput } from "../pkg/taffy_wasm.js";
+/**
+ * Universal initialization function for Taffy WASM module.
+ *
+ * Automatically detects the environment (Web or Node.js) and loads the WASM accordingly.
+ * - In a **Web environment**, it uses `fetch` to load the WASM file.
+ * - In a **Node.js environment**, it uses `fs` to read the WASM file.
+ *
+ * @returns - A promise that resolves to the WASM module exports.
+ *
+ * @example
+ * ```typescript
+ * import { loadTaffy } from 'taffy-js';
+ * await loadTaffy();
+ * ```
+ */
+export declare function loadTaffy(): Promise<InitOutput>;
+export default loadTaffy;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAGH,cAAc,sBAAsB,CAAC;AACrC,YAAY,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAIvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAavD;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,SAAS,IAAI,OAAO,CAAC,UAAU,CAAC,CAkBrD;AAGD,eAAe,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,66 @@
+/**
+ * Taffy-JS: TypeScript wrapper for Taffy WASM bindings
+ *
+ * This module provides the `loadTaffy` function for initializing the WASM module
+ * and re-exports all types and functions from the underlying WASM bindings.
+ *
+ * @example
+ * ```typescript
+ * import { loadTaffy, TaffyTree, Style, Display } from 'taffy-js';
+ *
+ * await loadTaffy();
+ *
+ * const tree = new TaffyTree();
+ * const style = new Style();
+ * style.display = Display.Flex;
+ * const node = tree.newLeaf(style);
+ * ```
+ */
+// Re-export everything from the WASM module
+export * from "../pkg/taffy_wasm.js";
+// Import the init functions for the loader
+import init, { initSync } from "../pkg/taffy_wasm.js";
+/**
+ * Detects if running in a Node.js environment
+ */
+function isNode() {
+    return (typeof process !== "undefined" &&
+        process.versions != null &&
+        process.versions.node != null);
+}
+/**
+ * Universal initialization function for Taffy WASM module.
+ *
+ * Automatically detects the environment (Web or Node.js) and loads the WASM accordingly.
+ * - In a **Web environment**, it uses `fetch` to load the WASM file.
+ * - In a **Node.js environment**, it uses `fs` to read the WASM file.
+ *
+ * @returns - A promise that resolves to the WASM module exports.
+ *
+ * @example
+ * ```typescript
+ * import { loadTaffy } from 'taffy-js';
+ * await loadTaffy();
+ * ```
+ */
+export async function loadTaffy() {
+    if (isNode()) {
+        // Node.js environment - use fs to read the WASM file
+        const fs = await import("fs");
+        const url = await import("url");
+        const path = await import("path");
+        // Resolve WASM path relative to this module
+        const __filename = url.fileURLToPath(import.meta.url);
+        const __dirname = path.dirname(__filename);
+        const wasmPath = path.join(__dirname, "..", "pkg", "taffy_wasm_bg.wasm");
+        const wasmBuffer = fs.readFileSync(wasmPath);
+        return initSync({ module: wasmBuffer });
+    }
+    else {
+        // Web environment - use fetch via the default init function
+        return await init();
+    }
+}
+// Default export for convenience
+export default loadTaffy;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,4CAA4C;AAC5C,cAAc,sBAAsB,CAAC;AAGrC,2CAA2C;AAC3C,OAAO,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAGtD;;GAEG;AACH,SAAS,MAAM;IACb,OAAO,CACL,OAAO,OAAO,KAAK,WAAW;QAC9B,OAAO,CAAC,QAAQ,IAAI,IAAI;QACxB,OAAO,CAAC,QAAQ,CAAC,IAAI,IAAI,IAAI,CAC9B,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS;IAC7B,IAAI,MAAM,EAAE,EAAE,CAAC;QACb,qDAAqD;QACrD,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC;QAC9B,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,CAAC;QAChC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC;QAElC,4CAA4C;QAC5C,MAAM,UAAU,GAAG,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,oBAAoB,CAAC,CAAC;QAEzE,MAAM,UAAU,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC7C,OAAO,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;IAC1C,CAAC;SAAM,CAAC;QACN,4DAA4D;QAC5D,OAAO,MAAM,IAAI,EAAE,CAAC;IACtB,CAAC;AACH,CAAC;AAED,iCAAiC;AACjC,eAAe,SAAS,CAAC"}

package/package.json

@@ -1,24 +1,79 @@
 {
   "name": "taffy-js",
-  "type": "module",
-  "collaborators": [
-    "ByteLandTechnology <github@byteland.app>"
-  ],
+  "version": "0.2.5",
   "description": "WebAssembly bindings for Taffy layout library",
-  "version": "0.2.4",
-  "license": "MIT",
+  "keywords": [
+    "layout",
+    "flexbox",
+    "css-grid",
+    "grid",
+    "ui",
+    "wasm",
+    "webassembly"
+  ],
+  "homepage": "https://github.com/ByteLandTechnology/taffy-js#readme",
+  "bugs": {
+    "url": "https://github.com/ByteLandTechnology/taffy-js/issues"
+  },
   "repository": {
     "type": "git",
-    "url": "https://github.com/ByteLandTechnology/taffy-js"
+    "url": "git+https://github.com/ByteLandTechnology/taffy-js.git"
+  },
+  "license": "MIT",
+  "author": "ByteLandTechnology <github@byteland.app>",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./wasm": {
+      "types": "./pkg/taffy_wasm.d.ts",
+      "import": "./pkg/taffy_wasm.js"
+    }
   },
   "files": [
-    "taffy_js_bg.wasm",
-    "taffy_js.js",
-    "taffy_js.d.ts"
+    "dist",
+    "pkg"
   ],
-  "main": "taffy_js.js",
-  "types": "taffy_js.d.ts",
-  "sideEffects": [
-    "./snippets/*"
-  ]
-}
+  "scripts": {
+    "build": "npm run build:wasm && npm run build:ts && npm run docs",
+    "build:wasm": "wasm-pack build --release --target web && npm run patch-dts",
+    "build:ts": "tsc",
+    "build:dev": "wasm-pack build --dev --target web && npm run patch-dts && npm run build:ts",
+    "docs": "typedoc && prettier --write docs",
+    "patch-dts": "npx tsx scripts/patch-dts.ts",
+    "test": "wasm-pack test --node",
+    "prepare": "husky"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^20.3.0",
+    "@commitlint/config-conventional": "^20.3.0",
+    "@types/node": "^22.0.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.2.7",
+    "prettier": "^3.7.4",
+    "tsx": "^4.0.0",
+    "typedoc": "^0.28.15",
+    "typedoc-plugin-markdown": "^4.9.0",
+    "typescript": "^5.7.0",
+    "wasm-pack": "^0.13.1"
+  },
+  "engines": {
+    "node": ">=12"
+  },
+  "overrides": {
+    "axios": "^1.7.9"
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "lint-staged": {
+    "*.{js,ts,jsx,tsx,json,md,yaml,yml}": "prettier --write",
+    "*.rs": "cargo fmt --"
+  }
+}