@mdgate/zip 0.1.0

package/README.md

@@ -0,0 +1,29 @@
+# @mdgate/zip
+
+Convert generic ZIP archives by converting each member. Outputs GitHub-Flavored Markdown. Works in
+Node, Edge, and browsers. No native addons.
+
+Handles: `.zip`, `.zipx`, `.jar` (not Office/ODF/EPUB/iWork packages — those win at sniff 2)
+
+## Usage
+
+```ts
+import { toMarkdown } from '@mdgate/zip';
+
+const markdown = await toMarkdown(bytes);
+```
+
+Compose with other converters so members are converted by format:
+
+```ts
+import { create } from '@mdgate/core';
+import { csv } from '@mdgate/csv';
+import { zip } from '@mdgate/zip';
+
+const convert = create([zip(), csv()]);
+```
+
+Without a nested `convert`, member names are listed as a bullet list.
+
+Part of [mdgate converters](https://github.com/mdgate/converters); install
+`@mdgate/converters` for every format at once.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { toMarkdown } from './to-markdown.js';
+export { zip } from './zip.js';

package/dist/index.js

@@ -0,0 +1,6 @@
+import{create as k}from"@mdgate/core";import{detectZipDoc as N,hasOleMagic as z,Package as F}from"@mdgate/containers";import{ConvertError as J}from"@mdgate/core";import{documentToMarkdown as $,emptyDocument as P,heading as D,plain as B}from"@mdgate/document";import{fileExtension as Z}from"@mdgate/utils";var j=new Set(["zip","zipx","jar"]);function H(){return{id:"zip",sniff(q,A){if(N(q)!==void 0)return 0;if(X(q))return 2;if(A?.path!==void 0&&j.has(Z(A.path)??""))return 1;return 0},convert(q,A){O(q);let G;try{G=F.open(q)}catch(Q){throw u(Q)}let L=T(G);if(A?.convert===void 0)return{markdown:$(x(L))};return S(G,L,A.convert)}}}function O(q){if(X(q))return;if(C(q))throw J.unsupported("pdf");if(z(q))throw J.unsupported("ole");throw J.unsupported("zip")}async function S(q,A,G){let L=[];for(let Q of A){let R=M(Q),Y;try{Y=q.part(Q)}catch(I){if(I instanceof J&&I.isFatal())throw I;if(U(I))throw J.encrypted();L.push(V(R,_(K(I))));continue}if(Y===void 0){L.push(V(R,_(`missing required part: ${Q}`)));continue}try{let I=await G(Y,{path:Q});L.push(V(R,I.trimEnd()))}catch(I){if(I instanceof J&&I.isFatal())throw I;L.push(V(R,_(K(I))))}}return{markdown:f(L)}}function T(q){let A=[];for(let G of q.partNames()){if(G.endsWith("/"))continue;if(w(G))continue;A.push(G)}return A}function w(q){for(let A of q.split("/"))if(A==="__MACOSX")return!0;return!1}function x(q){if(q.length===0)return P();return{blocks:[{type:"list",list:{marker:"bullet",start:1,items:q.map((A)=>({blocks:[{type:"paragraph",inlines:[B(A)]}],checked:void 0,markerLabel:void 0}))}}],notes:[],assets:[]}}function M(q){return $({blocks:[D(2,[B(q)])],notes:[],assets:[]}).trimEnd()}function _(q){return $({blocks:[{type:"paragraph",inlines:[B(`could not convert: ${q}`)]}],notes:[],assets:[]}).trimEnd()}function V(q,A){return A.length===0?q:`${q}
+
+${A}`}function f(q){let A=q.filter((G)=>G.length>0);return A.length===0?"":`${A.join(`
+
+`)}
+`}function K(q){return q instanceof Error?q.message:String(q)}function u(q){if(q instanceof J){if(q.code==="encrypted")return q;if(U(q))return J.encrypted();return q}let A=q instanceof Error?q.message:String(q);if(W(A))return J.encrypted();return J.malformed(`not a readable zip archive: ${A}`)}function U(q){if(q instanceof J&&q.code==="encrypted")return!0;let A=q instanceof J?q.detail??"":"",G=q instanceof Error?`${q.message} ${A}`:String(q);return W(G)}function W(q){let A=q.toLowerCase();return A.includes("encrypted")||A.includes("password")}function X(q){return q.length>=4&&q[0]===80&&q[1]===75&&q[2]===3&&q[3]===4}function C(q){return q.length>=5&&q[0]===37&&q[1]===80&&q[2]===68&&q[3]===70&&q[4]===45}var h=k([H()]);function g(q,A){return h(q,A)}export{H as zip,g as toMarkdown};

package/dist/to-markdown.d.ts

@@ -0,0 +1,6 @@
+import { type ConvertHint } from '@mdgate/core';
+/**
+ * Convert a single file's bytes to Markdown with the zip converter.
+ * `hint.path` is only a sniff hint; it is never read from disk.
+ */
+export declare function toMarkdown(bytes: Uint8Array, hint?: ConvertHint): Promise<string>;

package/dist/zip.d.ts

@@ -0,0 +1,2 @@
+import type { Converter } from '@mdgate/core';
+export declare function zip(): Converter;

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@mdgate/zip",
+  "version": "0.1.0",
+  "description": "mdgate generic ZIP converter",
+  "type": "module",
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "scripts": {
+    "build": "bun ../../scripts/build-package.ts",
+    "prepublishOnly": "bun run build"
+  },
+  "dependencies": {
+    "@mdgate/containers": "0.1.0",
+    "@mdgate/core": "0.1.3",
+    "@mdgate/document": "0.1.0",
+    "@mdgate/utils": "0.1.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "keywords": [
+    "mdgate",
+    "markdown",
+    "zip"
+  ]
+}