initial source

Author: andrewmd5

.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Publish to NPM
+on:
+  push:
+    tags:
+      - 'v*'
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+
+      - name: Install dependencies
+        run: npm i
+
+      - name: Build package
+        run: npm run build
+
+      - name: Publish package to NPM
+        run: npm publish --provenance --access public --tag latest
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,6 @@
+dist
+node_modules
+.DS_Store
+*.wasm
+*.esm.js
+*.map

README.md

@@ -0,0 +1,124 @@
+# @uswriting/exiftool
+
+ExifTool powered by WebAssembly to extract metadata from files in browsers and Node.js environments using [zeroperl](https://github.com/uswriting/zeroperl).
+
+## Installation
+
+```
+npm install @uswriting/exiftool
+```
+
+## Description
+
+This package provides a WebAssembly-based implementation of ExifTool that works in both browser and Node.js environments. It leverages [zeroperl](https://github.com/uswriting/zeroperl) to execute ExifTool without requiring any native binaries or system dependencies.
+
+## Usage
+
+### Basic Usage
+
+```typescript
+import { parseMetadata } from '@uswriting/exiftool';
+
+// Browser usage with File API
+document.querySelector('input[type="file"]').addEventListener('change', async (event) => {
+  const file = event.target.files[0];
+  const result = await parseMetadata(file);
+  
+  if (result.success) {
+    console.log(result.data);
+  } else {
+    console.error('Error:', result.error);
+  }
+});
+```
+
+### Extracting Specific Metadata
+
+```typescript
+import { parseMetadata } from '@uswriting/exiftool';
+
+const result = await parseMetadata(file, {
+  args: ['-Author', '-CreateDate', '-Make', '-Model']
+});
+
+if (result.success) {
+  console.log(result.data);
+}
+```
+
+### JSON Output
+
+```typescript
+import { parseMetadata } from '@uswriting/exiftool';
+
+const result = await parseMetadata(file, {
+  args: ['-json', '-n'],
+  transform: (data) => JSON.parse(data)
+});
+
+if (result.success) {
+  // Typed access to properties
+  console.log(result.data); // { ... }
+}
+```
+
+## Important Notes
+
+- In browser environments, pass the `File` object directly from file inputs. Do not convert it to an ArrayBuffer or Uint8Array.
+- This package uses asynchronous web APIs for file processing which allows handling files over 2GB without loading them entirely into memory.
+- ExifTool is executed entirely within the browser or Node.js environment - no server requests are made for metadata extraction.
+
+## API Reference
+
+### parseMetadata()
+
+```typescript
+async function parseMetadata<TReturn = string>(
+  file: Binaryfile | File,
+  options: ExifToolOptions<TReturn> = {}
+): Promise<ExifToolOutput<TReturn>>
+```
+
+#### Parameters
+
+- `file`: Either a browser `File` object or a `Binaryfile` object with `name` and `data` properties.
+- `options`: Configuration options for the metadata extraction.
+
+#### Options
+
+```typescript
+interface ExifToolOptions<TReturn> {
+  // Additional command-line arguments to pass to ExifTool
+  args?: string[];
+  
+  // Custom fetch implementation for loading the WASM module
+  fetch?: (...args: any[]) => Promise<Response>;
+  
+  // Transform the raw ExifTool output into a different format
+  transform?: (data: string) => TReturn;
+}
+```
+
+#### Return Value
+
+Returns a Promise that resolves to an `ExifToolOutput` object:
+
+```typescript
+type ExifToolOutput<TOutput> =
+  | {
+      success: true;
+      data: TOutput;
+      error: string;
+      exitCode: 0;
+    }
+  | {
+      success: false;
+      data: undefined;
+      error: string;
+      exitCode: number | undefined;
+    };
+```
+
+## License
+
+Apache License, Version 2.0

build.mjs

@@ -0,0 +1,26 @@
+import { build } from 'esbuild';
+import { raw } from "esbuild-raw-plugin";
+
+const prod = build({
+    entryPoints: ['src/index.ts'],
+    bundle: true,
+    format: 'esm',
+    outfile: 'dist/esm/index.esm.js',
+    sourcemap: true,
+    minify: true,
+    plugins: [raw()],
+    target: ['ESNext'],
+});
+
+const demo = build({
+    entryPoints: ['src/index.ts'],
+    bundle: true,
+    format: 'esm',
+    outfile: 'demo/index.esm.js',
+    sourcemap: true,
+    minify: false,
+    plugins: [raw()],
+});
+
+
+Promise.all([prod, demo]).catch(() => process.exit(1));