first commit

Author: tamaroning

.github/workflows/test.yml

@@ -0,0 +1,17 @@
+name: test
+
+on: [push]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20.x"
+      - run: npm ci
+      - run: npm run build
+        env:
+          RUSTFLAGS: -C target-feature=+bulk-memory
+      - run: npm test

.gitignore

@@ -0,0 +1,10 @@
+rust/target
+rust/pkg
+
+**/node_modules
+**/*.xlsx
+!test/expected/*.xlsx
+
+**/dist
+
+docs/

LICENSE

@@ -0,0 +1,50 @@
+MIT License
+
+Copyright (c) 2024 estie, inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+This project includes software from third-party libraries, which are licensed under their own terms.
+
+# Third-Party Licenses
+
+## rust_xlsxwriter
+
+MIT License
+
+Copyright 2022-2024 John McNamara <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+    

README.md

@@ -0,0 +1,87 @@
+# wasm-xlsxwriter ![NPM Version](https://img.shields.io/npm/v/wasm-xlsxwriter)
+
+The `wasm-xlsxwriter` library is a lightweight wrapper around the write API of Rust's [`rust_xlsxwriter`](https://crates.io/crates/rust_xlsxwriter), compiled to WebAssembly (Wasm) with minimal setup to make it easily usable from JavaScript.
+
+With this library, you can generate Excel files in the browser using JavaScript, complete with support for custom formatting, formulas, links, images, and more.
+
+## Getting Started
+
+To get started, install the library via npm:
+
+```bash
+npm install wasm-xlsxwriter
+```
+
+### Usage
+
+Here’s an example of how to use `wasm-xlsxwriter` to create an Excel file:
+
+```typescript
+import xlsxInit, {
+  Format,
+  FormatAlign,
+  FormatBorder,
+  Formula,
+  Workbook,
+  Image,
+  Url,
+} from "wasm-xlsxwriter";
+
+// Load the WebAssembly module and initialize the library.
+await xlsxInit();
+
+// Create a new Excel file object.
+const workbook = new Workbook();
+
+// Create some formats to use in the worksheet.
+const boldFormat = new Format().setBold();
+const decimalFormat = new Format().setNumFormat("0.000");
+const dateFormat = new Format().setNumFormat("yyyy-mm-dd");
+const mergeFormat = new Format()
+  .setBorder(FormatBorder.Thin)
+  .setAlign(FormatAlign.Center);
+
+// Add a worksheet to the workbook.
+const worksheet = workbook.addWorksheet();
+
+// Set the column width for clarity.
+worksheet.setColumnWidth(0, 22);
+
+// Write a string without formatting.
+worksheet.write(0, 0, "Hello");
+
+// Write a string with the bold format defined above.
+worksheet.writeWithFormat(1, 0, "World", boldFormat);
+
+// Write some numbers.
+worksheet.write(2, 0, 1);
+worksheet.write(3, 0, 2.34);
+
+// Write a number with formatting.
+worksheet.writeWithFormat(4, 0, 3.0, decimalFormat);
+
+// Write a formula.
+worksheet.write(5, 0, new Formula("=SIN(PI()/4)"));
+
+// Write a date.
+const date = new Date(2023, 1, 25);
+worksheet.writeWithFormat(6, 0, date, dateFormat);
+
+// Write some links.
+worksheet.write(7, 0, new Url("https://www.rust-lang.org"));
+worksheet.write(8, 0, new Url("https://www.rust-lang.org").setText("Rust"));
+
+// Write some merged cells.
+worksheet.mergeRange(9, 0, 9, 1, "Merged cells", mergeFormat);
+
+// Insert an image (ensure `imageBuffer` contains the image data).
+const image = Image.newFromBuffer(imageBuffer);
+worksheet.insertImage(1, 2, image);
+
+// Save the file to a buffer.
+const buf = workbook.saveToBufferSync();
+```
+
+## License
+
+MIT

examples/nextjs/.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+.next/

examples/nextjs/app/layout.tsx

@@ -0,0 +1,11 @@
+export default function RootLayout({
+  children,
+}: {
+  children: React.ReactNode;
+}) {
+  return (
+    <html lang="en">
+      <body>{children}</body>
+    </html>
+  );
+}

examples/nextjs/app/page.tsx

@@ -0,0 +1,34 @@
+"use client";
+import initModule, { Workbook } from "wasm-xlsxwriter";
+
+export default function Page() {
+  return (
+    <button
+      onClick={async () => {
+        const workbook = await generateXlsx();
+        download(workbook);
+      }}
+    >
+      Generate a xlsx file
+    </button>
+  );
+}
+
+const generateXlsx = async () => {
+  await initModule();
+  const workbook = new Workbook();
+  const worksheet = workbook.addWorksheet();
+  worksheet.write(0, 0, "Hello, world!");
+  return workbook;
+};
+
+const download = (workbook: Workbook) => {
+  const buffer = workbook.saveToBufferSync();
+  const blob = new Blob([buffer]);
+  const url = window.URL.createObjectURL(blob);
+  const a = document.createElement("a");
+  a.href = url;
+  a.download = "generated.xlsx";
+  a.click();
+  a.remove();
+};

examples/nextjs/next-env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.