githttp-fs-client 1.0.2 → 1.0.4

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Configuration for the Git HTTP FS API client.
+ */
+export interface ClientConfig {
+    baseUrl: string;
+    apiKey: string;
+}
+/**
+ * Git HTTP FS client, manages files and commits over the Git HTTP FS HTTP API.
+ */
+export declare class GitHTTPFSClient {
+    private baseUrl;
+    private headers;
+    constructor(config: ClientConfig);
+    /**
+     * Helper to handle requests and parse JSON responses.
+     */
+    private request;
+    /** Delete entire tenant repository */
+    deleteTenant(tenantId: string): Promise<unknown>;
+    /** List all tracked files (path + size) */
+    listFiles(tenantId: string): Promise<unknown>;
+    /** Read file content */
+    getFileContent(tenantId: string, path: string): Promise<unknown>;
+    /** Create or update a file */
+    putFile(tenantId: string, path: string, body: any): Promise<unknown>;
+    /** Delete a file */
+    deleteFile(tenantId: string, path: string): Promise<unknown>;
+    /** Move / rename a file */
+    moveFile(tenantId: string, path: string, body: any): Promise<unknown>;
+    /** List commits with pagination */
+    listCommits(tenantId: string, page?: number, perPage?: number): Promise<unknown>;
+    /** Commit detail with per-file diffs and snapshots */
+    getCommitDetail(tenantId: string, sha: string): Promise<unknown>;
+    /** Revert a commit */
+    revertCommit(tenantId: string, sha: string, body: any): Promise<unknown>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB;AAWD;;GAEG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAyB;gBAE5B,MAAM,EAAE,YAAY;IAWhC;;OAEG;YACW,OAAO;IAsCrB,sCAAsC;IAChC,YAAY,CAAC,QAAQ,EAAE,MAAM;IAMnC,2CAA2C;IACrC,SAAS,CAAC,QAAQ,EAAE,MAAM;IAMhC,wBAAwB;IAClB,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAMnD,8BAA8B;IACxB,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG;IAMvD,oBAAoB;IACd,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAM/C,2BAA2B;IACrB,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG;IAQxD,mCAAmC;IAC7B,WAAW,CACf,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,MAAU,EAChB,OAAO,GAAE,MAAY;IAYvB,sDAAsD;IAChD,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAMnD,sBAAsB;IAChB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG;CAK5D"}

package/dist/index.js

@@ -0,0 +1,95 @@
+/*
+ * node-githttp-fs-client
+ *
+ * Copyright 2026, Valerian Saliou
+ * Author: Valerian Saliou <valerian@valeriansaliou.name>
+ */
+/** Defines the API version */
+const VERSION = "v1";
+/** Defines all HTTP methods */
+const GET = "GET";
+const POST = "POST";
+const PUT = "PUT";
+const DELETE = "DELETE";
+/**
+ * Git HTTP FS client, manages files and commits over the Git HTTP FS HTTP API.
+ */
+export class GitHTTPFSClient {
+    baseUrl;
+    headers;
+    constructor(config) {
+        // Remove trailing slash (if any)
+        this.baseUrl = config.baseUrl.replace(/\/$/, "");
+        this.headers = {
+            "Authorization": `Bearer ${config.apiKey}`,
+            "Content-Type": "application/json",
+            "Accept": "application/json"
+        };
+    }
+    /**
+     * Helper to handle requests and parse JSON responses.
+     */
+    async request(path, method, body, params) {
+        const url = new URL(`${this.baseUrl}/${VERSION}/${path}`);
+        // Append query parameters
+        if (params) {
+            Object.entries(params).forEach(([key, value]) => url.searchParams.set(key, value));
+        }
+        const options = {
+            method,
+            headers: this.headers
+        };
+        if (body && method !== GET) {
+            options.body = JSON.stringify(body);
+        }
+        const response = await fetch(url.toString(), options);
+        if (!response.ok) {
+            const errorText = await response.text();
+            throw new Error(`API Error [${response.status}]: ${errorText}`);
+        }
+        return response.json();
+    }
+    // --- Tenant Operations ---
+    /** Delete entire tenant repository */
+    async deleteTenant(tenantId) {
+        return this.request(`${tenantId}`, DELETE);
+    }
+    /** List all tracked files (path + size) */
+    async listFiles(tenantId) {
+        return this.request(`${tenantId}/files`, GET);
+    }
+    /** Read file content */
+    async getFileContent(tenantId, path) {
+        return this.request(`${tenantId}/files/${path}`, GET);
+    }
+    /** Create or update a file */
+    async putFile(tenantId, path, body) {
+        return this.request(`${tenantId}/files/${path}`, PUT, body);
+    }
+    /** Delete a file */
+    async deleteFile(tenantId, path) {
+        return this.request(`${tenantId}/files/${path}`, DELETE);
+    }
+    /** Move / rename a file */
+    async moveFile(tenantId, path, body) {
+        return this.request(`${tenantId}/files/${path}/move`, POST, body);
+    }
+    // --- Commit Operations ---
+    /** List commits with pagination */
+    async listCommits(tenantId, page = 1, perPage = 100) {
+        const params = {
+            page: page.toString(),
+            per_page: Math.min(perPage, 500).toString()
+        };
+        return this.request(`${tenantId}/commits`, GET, undefined, params);
+    }
+    /** Commit detail with per-file diffs and snapshots */
+    async getCommitDetail(tenantId, sha) {
+        return this.request(`${tenantId}/commits/${sha}`, GET);
+    }
+    /** Revert a commit */
+    async revertCommit(tenantId, sha, body) {
+        return this.request(`${tenantId}/commits/${sha}/revert`, POST, body);
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAUH,8BAA8B;AAC9B,MAAM,OAAO,GAAG,IAAI,CAAC;AAErB,+BAA+B;AAC/B,MAAM,GAAG,GAAG,KAAK,CAAC;AAClB,MAAM,IAAI,GAAG,MAAM,CAAC;AACpB,MAAM,GAAG,GAAG,KAAK,CAAC;AAClB,MAAM,MAAM,GAAG,QAAQ,CAAC;AAExB;;GAEG;AACH,MAAM,OAAO,eAAe;IAClB,OAAO,CAAS;IAChB,OAAO,CAAyB;IAExC,YAAY,MAAoB;QAC9B,iCAAiC;QACjC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAEjD,IAAI,CAAC,OAAO,GAAG;YACb,eAAe,EAAE,UAAU,MAAM,CAAC,MAAM,EAAE;YAC1C,cAAc,EAAE,kBAAkB;YAClC,QAAQ,EAAE,kBAAkB;SAC7B,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,OAAO,CACnB,IAAY,EACZ,MAAyC,EACzC,IAAU,EACV,MAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC,CAAC;QAE1D,0BAA0B;QAC1B,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAC9C,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CACjC,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAgB;YAC3B,MAAM;YAEN,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC;QAEF,IAAI,IAAI,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YAC3B,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACtC,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;QAEtD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAExC,MAAM,IAAI,KAAK,CAAC,cAAc,QAAQ,CAAC,MAAM,MAAM,SAAS,EAAE,CAAC,CAAC;QAClE,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IAED,4BAA4B;IAE5B,sCAAsC;IACtC,KAAK,CAAC,YAAY,CAAC,QAAgB;QACjC,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,QAAQ,EAAE,EAAE,MAAM,CACtB,CAAC;IACJ,CAAC;IAED,2CAA2C;IAC3C,KAAK,CAAC,SAAS,CAAC,QAAgB;QAC9B,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,QAAQ,QAAQ,EAAE,GAAG,CACzB,CAAC;IACJ,CAAC;IAED,wBAAwB;IACxB,KAAK,CAAC,cAAc,CAAC,QAAgB,EAAE,IAAY;QACjD,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,QAAQ,UAAU,IAAI,EAAE,EAAE,GAAG,CACjC,CAAC;IACJ,CAAC;IAED,8BAA8B;IAC9B,KAAK,CAAC,OAAO,CAAC,QAAgB,EAAE,IAAY,EAAE,IAAS;QACrD,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,QAAQ,UAAU,IAAI,EAAE,EAAE,GAAG,EAAE,IAAI,CACvC,CAAC;IACJ,CAAC;IAED,oBAAoB;IACpB,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,IAAY;QAC7C,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,QAAQ,UAAU,IAAI,EAAE,EAAE,MAAM,CACpC,CAAC;IACJ,CAAC;IAED,2BAA2B;IAC3B,KAAK,CAAC,QAAQ,CAAC,QAAgB,EAAE,IAAY,EAAE,IAAS;QACtD,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,QAAQ,UAAU,IAAI,OAAO,EAAE,IAAI,EAAE,IAAI,CAC7C,CAAC;IACJ,CAAC;IAED,4BAA4B;IAE5B,mCAAmC;IACnC,KAAK,CAAC,WAAW,CACf,QAAgB,EAChB,OAAe,CAAC,EAChB,UAAkB,GAAG;QAErB,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE;YACrB,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,QAAQ,EAAE;SAC5C,CAAC;QAEF,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,QAAQ,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,CAC9C,CAAC;IACJ,CAAC;IAED,sDAAsD;IACtD,KAAK,CAAC,eAAe,CAAC,QAAgB,EAAE,GAAW;QACjD,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,QAAQ,YAAY,GAAG,EAAE,EAAE,GAAG,CAClC,CAAC;IACJ,CAAC;IAED,sBAAsB;IACtB,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,GAAW,EAAE,IAAS;QACzD,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,QAAQ,YAAY,GAAG,SAAS,EAAE,IAAI,EAAE,IAAI,CAChD,CAAC;IACJ,CAAC;CACF"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "githttp-fs-client",
   "description": "Git HTTP FS client for Node. Used in pair with Git HTTP FS, a git-backed content management database served over HTTP.",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "type": "module",
   "homepage": "https://github.com/crisp-oss/node-githttp-fs-client",
   "license": "MIT",