@npmforge/snapforge 0.1.1

package/dist/client.d.ts

@@ -0,0 +1,12 @@
+import type { SnapshotRequest, SnapshotResult, SnapforgeClientOptions } from "./types.js";
+export declare class SnapforgeClient {
+    private readonly baseUrl;
+    private readonly apiKey;
+    private readonly defaultTtlSeconds?;
+    private readonly fetchImpl;
+    constructor(options: SnapforgeClientOptions);
+    getSnapshot(request: SnapshotRequest): Promise<SnapshotResult>;
+    private requestJson;
+    private toDataUrl;
+}
+export declare function createSnapforgeClient(options: SnapforgeClientOptions): SnapforgeClient;

package/dist/client.js

@@ -0,0 +1,80 @@
+export class SnapforgeClient {
+    baseUrl;
+    apiKey;
+    defaultTtlSeconds;
+    fetchImpl;
+    constructor(options) {
+        if (!options.baseUrl) {
+            throw new Error("baseUrl is required.");
+        }
+        if (!options.apiKey) {
+            throw new Error("apiKey is required.");
+        }
+        this.baseUrl = new URL(options.baseUrl);
+        this.apiKey = options.apiKey;
+        this.defaultTtlSeconds = options.defaultTtlSeconds;
+        this.fetchImpl = options.fetchImpl ?? fetch;
+    }
+    async getSnapshot(request) {
+        if (!request.url) {
+            throw new Error("request.url is required.");
+        }
+        const captureBody = {
+            url: request.url,
+            ttlOverrideSeconds: request.ttlOverrideSeconds ?? this.defaultTtlSeconds,
+            width: request.width,
+            height: request.height,
+            fullPage: request.fullPage,
+            format: request.format,
+            quality: request.quality
+        };
+        const capture = await this.requestJson({
+            method: "POST",
+            path: "/capture",
+            body: captureBody
+        });
+        const imageUrl = new URL(capture.imagePath, this.baseUrl);
+        const imageResponse = await this.fetchImpl(imageUrl, {
+            method: "GET",
+            headers: {
+                "x-api-key": this.apiKey
+            }
+        });
+        if (!imageResponse.ok) {
+            const body = await imageResponse.text();
+            throw new Error(`Failed to fetch image (${imageResponse.status}): ${body || imageResponse.statusText}`);
+        }
+        const arrayBuffer = await imageResponse.arrayBuffer();
+        const bytes = new Uint8Array(arrayBuffer);
+        const dataUrl = this.toDataUrl(capture.mimeType, bytes);
+        return {
+            ...capture,
+            bytes,
+            dataUrl
+        };
+    }
+    async requestJson(options) {
+        const url = new URL(options.path, this.baseUrl);
+        const response = await this.fetchImpl(url, {
+            method: options.method,
+            headers: {
+                "content-type": "application/json",
+                "x-api-key": this.apiKey
+            },
+            body: options.body ? JSON.stringify(options.body) : undefined
+        });
+        if (!response.ok) {
+            const body = await response.text();
+            throw new Error(`Snapforge request failed (${response.status}): ${body || response.statusText}`);
+        }
+        return (await response.json());
+    }
+    toDataUrl(mimeType, bytes) {
+        const base64 = Buffer.from(bytes).toString("base64");
+        return `data:${mimeType};base64,${base64}`;
+    }
+}
+export function createSnapforgeClient(options) {
+    return new SnapforgeClient(options);
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAaA,MAAM,OAAO,eAAe;IACT,OAAO,CAAM;IACb,MAAM,CAAS;IACf,iBAAiB,CAAU;IAC3B,SAAS,CAAe;IAEzC,YAAY,OAA+B;QACzC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC1C,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,KAAK,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,OAAwB;QACxC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC9C,CAAC;QAED,MAAM,WAAW,GAAG;YAClB,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,kBAAkB,EAAE,OAAO,CAAC,kBAAkB,IAAI,IAAI,CAAC,iBAAiB;YACxE,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC;QAEF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,CAAyB;YAC7D,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,WAAW;SAClB,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1D,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;YACnD,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,WAAW,EAAE,IAAI,CAAC,MAAM;aACzB;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;YACtB,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CACb,0BAA0B,aAAa,CAAC,MAAM,MAAM,IAAI,IAAI,aAAa,CAAC,UAAU,EAAE,CACvF,CAAC;QACJ,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,aAAa,CAAC,WAAW,EAAE,CAAC;QACtD,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,WAAW,CAAC,CAAC;QAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAExD,OAAO;YACL,GAAG,OAAO;YACV,KAAK;YACL,OAAO;SACR,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,WAAW,CAAI,OAAuB;QAClD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAEhD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE;YACzC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,WAAW,EAAE,IAAI,CAAC,MAAM;aACzB;YACD,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;SAC9D,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CACb,6BAA6B,QAAQ,CAAC,MAAM,MAAM,IAAI,IAAI,QAAQ,CAAC,UAAU,EAAE,CAChF,CAAC;QACJ,CAAC;QAED,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAC;IACtC,CAAC;IAEO,SAAS,CAAC,QAAgB,EAAE,KAAiB;QACnD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACrD,OAAO,QAAQ,QAAQ,WAAW,MAAM,EAAE,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,UAAU,qBAAqB,CACnC,OAA+B;IAE/B,OAAO,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC;AACtC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { createSnapforgeClient, SnapforgeClient } from "./client.js";
+export type { CaptureResponsePayload, ImageFormat, SnapshotRequest, SnapshotResult, SnapforgeClientOptions } from "./types.js";

package/dist/index.js

@@ -0,0 +1,2 @@
+export { createSnapforgeClient, SnapforgeClient } from "./client.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,31 @@
+export type ImageFormat = "png" | "jpeg" | "webp";
+export interface SnapforgeClientOptions {
+    baseUrl: string;
+    apiKey: string;
+    defaultTtlSeconds?: number;
+    fetchImpl?: typeof fetch;
+}
+export interface SnapshotRequest {
+    url: string;
+    ttlOverrideSeconds?: number;
+    width?: number;
+    height?: number;
+    fullPage?: boolean;
+    format?: ImageFormat;
+    quality?: number;
+}
+export interface CaptureResponsePayload {
+    key: string;
+    sourceUrl: string;
+    cached: boolean;
+    capturedAt: string;
+    expiresAt: string;
+    ttlSeconds: number;
+    mimeType: string;
+    imagePath: string;
+    imageUrl: string;
+}
+export interface SnapshotResult extends CaptureResponsePayload {
+    bytes: Uint8Array;
+    dataUrl: string;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@npmforge/snapforge",
+  "version": "0.1.1",
+  "description": "TypeScript client for the self-hosted Snapforge screenshot service.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/clow99/getsnapforge.com"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./src/index.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "dev": "tsc -p tsconfig.json --watch",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "lint": "tsc -p tsconfig.json --noEmit"
+  },
+  "devDependencies": {
+    "@types/node": "*",
+    "typescript": "*"
+  }
+}