githttp-fs-client 1.0.0

package/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2026 Valerian Saliou
+
+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,34 @@
+# node-githttp-fs-client
+
+**Git HTTP FS client for Node. Used in pair with Git HTTP FS, a git-backed content management database served over HTTP.**
+
+Git HTTP FS Client is used to manage per-tenant Git content databases, over the Git HTTP FS HTTP API. All operations supported by the Git HTTP FS HTTP API are also supported in this client.
+
+**🇵🇹 Crafted in Lisbon, Portugal.**
+
+## How to install?
+
+Include `githttp-fs-client` in your `package.json` dependencies.
+
+Alternatively, you can run `npm install githttp-fs-client --save`.
+
+## How to use?
+
+Then, you can import `githttp-fs-client` and start listing and committing files:
+
+```ts
+import { GitHTTPFSClient } from "../lib/index.ts";
+
+const client = new GitHTTPFSClient({
+  baseUrl: "http://localhost:5355",
+  apiKey: "MySecretAPIKey"
+});
+
+const files = await client.listFiles("<your_tenant_id_here>");
+
+console.log("Listed files:", files);
+```
+
+## What is Git HTTP FS?
+
+ℹ️ **Wondering what Git HTTP FS is?** Check out **[crisp-oss/githttp-fs](https://github.com/crisp-oss/githttp-fs)**.

package/lib/index.ts

@@ -0,0 +1,157 @@
+/*
+ * node-githttp-fs-client
+ *
+ * Copyright 2026, Valerian Saliou
+ * Author: Valerian Saliou <valerian@valeriansaliou.name>
+ */
+
+/**
+ * Configuration for the Git HTTP FS API client.
+ */
+export interface ClientConfig {
+  baseUrl: string;
+  apiKey: string;
+}
+
+/** 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 {
+  private baseUrl: string;
+  private headers: Record<string, string>;
+
+  constructor(config: ClientConfig) {
+    // 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.
+   */
+  private async request<T>(
+    path: string,
+    method: "GET" | "POST" | "PUT" | "DELETE",
+    body?: any,
+    params?: Record<string, string>
+  ): Promise<T> {
+    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: RequestInit = {
+      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: string) {
+    return this.request(
+      `${tenantId}`, DELETE
+    );
+  }
+
+  /** List all tracked files (path + size) */
+  async listFiles(tenantId: string) {
+    return this.request(
+      `${tenantId}/files`, GET
+    );
+  }
+
+  /** Read file content */
+  async getFileContent(tenantId: string, path: string) {
+    return this.request(
+      `${tenantId}/files/${path}`, GET
+    );
+  }
+
+  /** Create or update a file */
+  async putFile(tenantId: string, path: string, body: any) {
+    return this.request(
+      `${tenantId}/files/${path}`, PUT, body
+    );
+  }
+
+  /** Delete a file */
+  async deleteFile(tenantId: string, path: string) {
+    return this.request(
+      `${tenantId}/files/${path}`, DELETE
+    );
+  }
+
+  /** Move / rename a file */
+  async moveFile(tenantId: string, path: string, body: any) {
+    return this.request(
+      `${tenantId}/files/${path}/move`, POST, body
+    );
+  }
+
+  // --- Commit Operations ---
+
+  /** List commits with pagination */
+  async listCommits(
+    tenantId: string,
+    page: number = 1,
+    perPage: number = 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: string, sha: string) {
+    return this.request(
+      `${tenantId}/commits/${sha}`, GET
+    );
+  }
+
+  /** Revert a commit */
+  async revertCommit(tenantId: string, sha: string, body: any) {
+    return this.request(
+      `${tenantId}/commits/${sha}/revert`, POST, body
+    );
+  }
+}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "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.0",
+  "type": "module",
+  "homepage": "https://github.com/crisp-oss/node-githttp-fs-client",
+  "license": "MIT",
+  "author": {
+    "name": "Valerian Saliou",
+    "email": "valerian@valeriansaliou.name",
+    "url": "https://valeriansaliou.name/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/crisp-oss/node-githttp-fs-client.git"
+  },
+  "bugs": {
+    "url": "https://github.com/crisp-oss/node-githttp-fs-client/issues"
+  },
+  "licenses": [
+    {
+      "type": "MIT",
+      "url": "https://github.com/crisp-oss/node-githttp-fs-client/blob/master/LICENSE"
+    }
+  ],
+  "main": "lib/index.ts",
+  "engines": {
+    "node": ">= 23.0.0"
+  },
+  "keywords": [
+    "githttp-fs",
+    "git",
+    "cms"
+  ]
+}