@l1yp/file-viewer 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Public input types for @l1yp/file-viewer.
+ *
+ * {@link ViewerInput} is what a CONSUMER hands the viewer — a file described by name/mime/size plus a data
+ * source (a URL, in-memory bytes, decoded text, or a custom loader). This replaces the app-specific
+ * `lib/files.ts` download-URL coupling; see {@link ./lib/resolveInput}.
+ *
+ * {@link ViewerFile} — the INTERNAL classified shape (which viewer + how to fetch), produced by
+ * `classifyViewerFile` — lives with the viewer state in {@link ./composables/useFileViewer} and is re-exported
+ * here for convenience.
+ */
+/** Extra `fetch()` configuration for pulling `src` (auth headers, credentials, mode, …). No method/body. */
+export type FetchConfig = Omit<RequestInit, 'method' | 'body'>;
+/** Custom byte loader — resolve the file's bytes yourself (signed-URL exchange, SDK, …). Wins over `src`. */
+export type LoadFn = () => Promise<Blob | ArrayBuffer>;
+/**
+ * A file to open in the viewer. Describe it (name drives type detection; mime/size refine it) and give
+ * exactly one data source — precedence is `text` > `blob` > `load` > `src`:
+ *  - `src`   a fetchable URL (the common case). Add `fetchConfig` for auth headers, or `load` to fully
+ *            override how bytes are pulled.
+ *  - `blob`  in-memory bytes (a dropped/uploaded File works directly).
+ *  - `text`  already-decoded text — text-backed viewers use it without a network round-trip.
+ */
+export interface ViewerInput {
+    /** Display name; its extension is the primary type signal (mime refines, is never blindly trusted). */
+    name: string;
+    /** Provider mime when known. `application/octet-stream` is treated as "unknown" and ignored. */
+    mime?: string | null;
+    /** Byte size when known — drives the large-file gate and the log/stream routing. */
+    size?: number;
+    /** A fetchable URL. Pass `fetchConfig`/`load` alongside it for authenticated sources. */
+    src?: string;
+    /** In-memory bytes. */
+    blob?: Blob;
+    /** Already-decoded text (skips the network for text-backed viewers). */
+    text?: string;
+    /** Extra config merged into `fetch(src, …)` — headers/credentials/mode/etc. Forces a one-time pre-fetch. */
+    fetchConfig?: FetchConfig;
+    /** Full override: pull the bytes yourself. Wins over `src`; also forces a one-time pre-fetch to a blob URL. */
+    load?: LoadFn;
+}
+export type { ViewerFile } from './composables/useFileViewer';

package/package.json

@@ -0,0 +1,128 @@
+{
+  "name": "@l1yp/file-viewer",
+  "version": "0.1.0",
+  "description": "In-browser file viewer for 60+ formats (office / archives / images / code / …) as a Vue 3 component. Bytes never leave the browser.",
+  "keywords": [
+    "archive",
+    "component",
+    "document-viewer",
+    "docx",
+    "file-preview",
+    "file-viewer",
+    "hex",
+    "office",
+    "pdf",
+    "pptx",
+    "vue",
+    "vue3",
+    "xlsx"
+  ],
+  "homepage": "https://chat.l1yp.com/dev/viewer",
+  "bugs": {
+    "url": "https://github.com/L1yp/file-viewer/issues"
+  },
+  "license": "MIT",
+  "author": "l1yp",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/L1yp/file-viewer.git"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "module",
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./style.css": "./dist/style.css"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "vp build && vue-tsc -p tsconfig.build.json",
+    "type-check": "vue-tsc -p tsconfig.json --noEmit",
+    "prepack": "vp build && vue-tsc -p tsconfig.build.json"
+  },
+  "dependencies": {
+    "highlight.js": "^11.11.1",
+    "js-yaml": "^4.2.0",
+    "katex": "^0.17.0"
+  },
+  "peerDependencies": {
+    "vue": "^3.5.0"
+  },
+  "peerDependenciesMeta": {
+    "@aiden0z/pptx-renderer": {
+      "optional": true
+    },
+    "@audio/decode-amr": {
+      "optional": true
+    },
+    "@cornerstonejs/codec-charls": {
+      "optional": true
+    },
+    "@cornerstonejs/codec-libjpeg-turbo-8bit": {
+      "optional": true
+    },
+    "@cornerstonejs/codec-openjpeg": {
+      "optional": true
+    },
+    "ag-psd": {
+      "optional": true
+    },
+    "brotli-dec-wasm": {
+      "optional": true
+    },
+    "dicom-parser": {
+      "optional": true
+    },
+    "docx-preview": {
+      "optional": true
+    },
+    "epubjs": {
+      "optional": true
+    },
+    "exceljs": {
+      "optional": true
+    },
+    "heic2any": {
+      "optional": true
+    },
+    "jpeg-lossless-decoder-js": {
+      "optional": true
+    },
+    "maplibre-gl": {
+      "optional": true
+    },
+    "node-unrar-js": {
+      "optional": true
+    },
+    "numfmt": {
+      "optional": true
+    },
+    "pdfjs-dist": {
+      "optional": true
+    },
+    "silk-wasm": {
+      "optional": true
+    },
+    "sql.js": {
+      "optional": true
+    },
+    "three": {
+      "optional": true
+    },
+    "utif2": {
+      "optional": true
+    }
+  }
+}