@airmark/quiver 0.8.0 → 0.10.0

package/README.md

@@ -17,20 +17,31 @@ and aligned to the current Quillmark spec.
 ## Install
 
 ```bash
-npm install @airmark/quiver @quillmark/quiver@0.5.0 @quillmark/wasm@0.66.2
+npm install @airmark/quiver @quillmark/quiver@^0.6.0 @quillmark/wasm
 ```
 
+This package ships only the Source Quiver assets (`Quiver.yaml` + `quills/`)
+and exposes no JavaScript API. All loading is performed by `@quillmark/quiver`,
+either from the on-disk package directory or from a packed archive fetched
+over HTTP.
+
 ## Usage
 
-### Load via the convenience helper
+### Load from the exported directory
+
+Resolve the package's `Quiver.yaml` via `import.meta.resolve` and hand it to
+`@quillmark/quiver`:
 
 ```ts
+import { fileURLToPath } from 'node:url';
+import path from 'node:path';
 import { Quillmark, Document } from '@quillmark/wasm';
-import { loadAirmarkQuiver } from '@airmark/quiver';
+import { Quiver } from '@quillmark/quiver/node';
 
-const engine = new Quillmark();
-const quiver = await loadAirmarkQuiver();
+const quiverYaml = fileURLToPath(import.meta.resolve('@airmark/quiver/Quiver.yaml'));
+const quiver = await Quiver.fromDir(path.dirname(quiverYaml));
 
+const engine = new Quillmark();
 const doc = Document.fromMarkdown(`---
 QUILL: usaf_memo@0.2
 memo_for: ["ORG/SYMBOL"]
@@ -45,14 +56,11 @@ const quill = await quiver.getQuill(doc.quillRef, { engine });
 const { artifacts } = quill.render(doc, { format: 'pdf' });
 ```
 
-### Load from the exported directory
+### Load a packed Quiver via HTTP
 
-```ts
-import { Quiver } from '@quillmark/quiver/node';
-import { QUIVER_DIR } from '@airmark/quiver';
-
-const quiver = await Quiver.fromDir(QUIVER_DIR);
-```
+Publish a packed Quiver archive (e.g. as a CDN or GitHub release asset) and
+load it in the browser or any fetch-capable runtime through `@quillmark/quiver`.
+See the upstream `@quillmark/quiver` docs for the packed-format and HTTP API.
 
 ## Layout
 

package/package.json

@@ -1,31 +1,22 @@
 {
   "name": "@airmark/quiver",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "Airmark Quiver — Air Force and DAF document Quills for Quillmark.",
   "type": "module",
-  "main": "./index.js",
-  "types": "./index.d.ts",
   "exports": {
-    ".": {
-      "types": "./index.d.ts",
-      "import": "./index.js"
-    }
+    "./Quiver.yaml": "./Quiver.yaml",
+    "./quills/*": "./quills/*",
+    "./package.json": "./package.json"
   },
   "files": [
     "quills",
-    "Quiver.yaml",
-    "index.js",
-    "index.d.ts"
+    "Quiver.yaml"
   ],
   "engines": {
     "node": ">=18"
   },
-  "peerDependencies": {
-    "@quillmark/quiver": ">=0.5.0 <1.0.0",
-    "@quillmark/wasm": ">=0.66.2 <1.0.0"
-  },
   "devDependencies": {
-    "@quillmark/quiver": "^0.5.0",
+    "@quillmark/quiver": "^0.6.0",
     "@quillmark/wasm": "0.66.2"
   },
   "scripts": {

package/index.d.ts

@@ -1,16 +0,0 @@
-import type { Quiver } from '@quillmark/quiver/node';
-
-/**
- * Absolute path to the root of this Source Quiver (contains `Quiver.yaml`).
- */
-export declare const QUIVER_DIR: string;
-
-/**
- * Absolute path to the `quills/` directory inside this Quiver.
- */
-export declare const QUILLS_DIR: string;
-
-/**
- * Convenience loader that resolves this Source Quiver through `@quillmark/quiver/node`.
- */
-export declare function loadAirmarkQuiver(): Promise<Quiver>;

package/index.js

@@ -1,28 +0,0 @@
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-/**
- * Absolute path to the root of this Source Quiver (contains `Quiver.yaml`).
- */
-export const QUIVER_DIR = __dirname;
-
-/**
- * Absolute path to the `quills/` directory inside this Quiver.
- */
-export const QUILLS_DIR = path.join(__dirname, 'quills');
-
-/**
- * Convenience loader that resolves this Source Quiver through `@quillmark/quiver/node`.
- *
- * ```ts
- * import { loadAirmarkQuiver } from '@airmark/quiver';
- * const quiver = await loadAirmarkQuiver();
- * ```
- */
-export async function loadAirmarkQuiver() {
-  const { Quiver } = await import('@quillmark/quiver/node');
-  return Quiver.fromDir(QUIVER_DIR);
-}