@mdgate/image 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 mdgate
+
+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.

package/README.md

@@ -0,0 +1,15 @@
+# @mdgate/image
+
+Registers an image-to-markdown function with `create()`. The function can be `@mdgate/ai`, Apple OCR, or anything else that returns markdown.
+
+```ts
+import { create } from '@mdgate/core';
+import { image } from '@mdgate/image';
+import { pdf } from '@mdgate/pdf';
+import { ai } from '@mdgate/ai';
+
+const convert = create([
+  pdf(),
+  image(ai({ baseURL, apiKey, model }).convertImage),
+]);
+```

package/dist/image.d.ts

@@ -0,0 +1,3 @@
+import type { ConvertImage, ImagePlugin } from './types.js';
+/** Register an image-to-markdown function with `create([pdf(), image(fn)])`. */
+export declare function image(convert: ConvertImage): ImagePlugin;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { image } from './image.js';
+export type { ConvertImage, ImageInput, ImageMime, ImagePlugin } from './types.js';

package/dist/index.js

@@ -0,0 +1 @@
+function I(m){return{kind:"image",convert:m}}export{I as image};

package/dist/types.d.ts

@@ -0,0 +1,13 @@
+export type ImageMime = 'image/jpeg' | 'image/png' | 'image/webp';
+export type ImageInput = {
+    bytes: Uint8Array;
+    mime: ImageMime;
+    /** 1-based page number when the image came from a paged document. */
+    page?: number;
+};
+/** Convert an image the format converter cannot handle into markdown. */
+export type ConvertImage = (image: ImageInput) => Promise<string>;
+export type ImagePlugin = {
+    readonly kind: 'image';
+    readonly convert: ConvertImage;
+};

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@mdgate/image",
+  "version": "0.1.0",
+  "description": "Image-to-markdown plugin for mdgate: image(fn)",
+  "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/core": "0.1.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "keywords": [
+    "mdgate",
+    "markdown",
+    "image"
+  ]
+}