githttp-fs-client 1.0.20 → 1.0.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +153 -0
- package/dist/index.d.ts +20 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +31 -3
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -31,6 +31,159 @@ const files = await client.listFiles("<collection_id>", "<tenant_id>");
|
|
|
31
31
|
console.log("Listed files:", files);
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
+
## Available methods
|
|
35
|
+
|
|
36
|
+
All methods are asynchronous and reject with an `Error` carrying the HTTP status code when the server returns a non-success response.
|
|
37
|
+
|
|
38
|
+
### Base operations
|
|
39
|
+
|
|
40
|
+
#### `sendPing(): Promise<PingResult>`
|
|
41
|
+
|
|
42
|
+
Pings the server, to check that it is reachable and that the API key is valid.
|
|
43
|
+
|
|
44
|
+
```ts
|
|
45
|
+
const pong = await client.sendPing();
|
|
46
|
+
// { pong: true }
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Tenant operations
|
|
50
|
+
|
|
51
|
+
#### `deleteTenant(collectionId, tenantId): Promise<void>`
|
|
52
|
+
|
|
53
|
+
Deletes an entire tenant repository, with all its files and history. **This is irreversible.**
|
|
54
|
+
|
|
55
|
+
```ts
|
|
56
|
+
await client.deleteTenant("notes", "t_1");
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### File operations
|
|
60
|
+
|
|
61
|
+
#### `listFiles(collectionId, tenantId, page?, perPage?, prefixPath?, maximumDepth?): Promise<FileList>`
|
|
62
|
+
|
|
63
|
+
Lists all tracked files as a paginated tree of file and directory entries. Defaults to `page = 1` and `perPage = 100`. Pass `prefixPath` to list only files under a folder, and `maximumDepth` to limit how deep the tree goes.
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
const list = await client.listFiles("notes", "t_1", 1, 100, "articles/", 2);
|
|
67
|
+
// { files: [...], page: 1, per_page: 100, has_more: false }
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
#### `getFileContent(collectionId, tenantId, path, seek?): Promise<FileContent>`
|
|
71
|
+
|
|
72
|
+
Reads the content of a file. An optional `seek` object narrows `content` to a line window (see [Seek options](#seek-options)).
|
|
73
|
+
|
|
74
|
+
```ts
|
|
75
|
+
const file = await client.getFileContent("notes", "t_1", "articles/hello.md");
|
|
76
|
+
// { path: "articles/hello.md", content: "..." }
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
#### `fileExists(collectionId, tenantId, path): Promise<boolean>`
|
|
80
|
+
|
|
81
|
+
Checks whether a file exists, without reading its content (cheaper than `getFileContent()`).
|
|
82
|
+
|
|
83
|
+
```ts
|
|
84
|
+
const exists = await client.fileExists("notes", "t_1", "articles/hello.md");
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
#### `writeFile(collectionId, tenantId, path, payload): Promise<void>`
|
|
88
|
+
|
|
89
|
+
Creates or updates a file, committing the change. The payload holds the `content`, the commit `author` (`{ name, email }`) and an optional commit `message`. If the content did not change, no new commit is created.
|
|
90
|
+
|
|
91
|
+
```ts
|
|
92
|
+
await client.writeFile("notes", "t_1", "articles/hello.md", {
|
|
93
|
+
content: "Hello world!",
|
|
94
|
+
author: { name: "Jane Doe", email: "jane@doe.com" },
|
|
95
|
+
message: "feat: add hello article"
|
|
96
|
+
});
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
#### `deleteFile(collectionId, tenantId, path, payload): Promise<void>`
|
|
100
|
+
|
|
101
|
+
Deletes a file, committing the change. The payload holds the commit `author` and an optional `message`.
|
|
102
|
+
|
|
103
|
+
```ts
|
|
104
|
+
await client.deleteFile("notes", "t_1", "articles/hello.md", {
|
|
105
|
+
author: { name: "Jane Doe", email: "jane@doe.com" }
|
|
106
|
+
});
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
#### `moveFile(collectionId, tenantId, path, payload): Promise<void>`
|
|
110
|
+
|
|
111
|
+
Moves (or renames) a file to the payload's `destination` path, committing the change. The payload also holds the commit `author` and an optional `message`.
|
|
112
|
+
|
|
113
|
+
```ts
|
|
114
|
+
await client.moveFile("notes", "t_1", "articles/hello.md", {
|
|
115
|
+
destination: "archives/hello.md",
|
|
116
|
+
author: { name: "Jane Doe", email: "jane@doe.com" }
|
|
117
|
+
});
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### Commit operations
|
|
121
|
+
|
|
122
|
+
#### `listCommits(collectionId, tenantId, page?, perPage?, filePath?): Promise<CommitList>`
|
|
123
|
+
|
|
124
|
+
Lists commits, most recent first, with pagination. Defaults to `page = 1` and `perPage = 100`. Pass `filePath` to only list commits that touched a given file.
|
|
125
|
+
|
|
126
|
+
```ts
|
|
127
|
+
const commits = await client.listCommits("notes", "t_1", 1, 10);
|
|
128
|
+
// { commits: [{ sha, message, author, committed_at }, ...], ... }
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
#### `getCommitDetail(collectionId, tenantId, sha): Promise<CommitDetail>`
|
|
132
|
+
|
|
133
|
+
Returns the details of a commit, with per-file diffs and content snapshots.
|
|
134
|
+
|
|
135
|
+
```ts
|
|
136
|
+
const detail = await client.getCommitDetail("notes", "t_1", "9b924c1d...");
|
|
137
|
+
// { sha, message, author, committed_at, files: [{ path, change, content, diff }] }
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
#### `revertCommit(collectionId, tenantId, sha, payload): Promise<void>`
|
|
141
|
+
|
|
142
|
+
Reverts a commit, as a new commit. The payload holds the commit `author` and an optional `message`.
|
|
143
|
+
|
|
144
|
+
```ts
|
|
145
|
+
await client.revertCommit("notes", "t_1", "9b924c1d...", {
|
|
146
|
+
author: { name: "Jane Doe", email: "jane@doe.com" }
|
|
147
|
+
});
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### Batch operations
|
|
151
|
+
|
|
152
|
+
#### `batchGetFileContents(collectionId, tenantId, paths, seek?): Promise<FileContentBatch>`
|
|
153
|
+
|
|
154
|
+
Reads several files in one request. The returned `files` array is index-aligned with `paths`: each slot is either a `{ path, content }` object, or `null` when that path does not exist. An optional `seek` object applies the same line window to every file (see [Seek options](#seek-options)).
|
|
155
|
+
|
|
156
|
+
```ts
|
|
157
|
+
const batch = await client.batchGetFileContents("notes", "t_1", [
|
|
158
|
+
"articles/hello.md",
|
|
159
|
+
"articles/missing.md"
|
|
160
|
+
]);
|
|
161
|
+
// { files: [{ path, content }, null] }
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### Seek options
|
|
165
|
+
|
|
166
|
+
`getFileContent()` and `batchGetFileContents()` accept an optional `seek` object, which narrows the returned `content` to a line window instead of the whole file. All fields are optional and combinable:
|
|
167
|
+
|
|
168
|
+
- `from_line_starts_with` — array of prefixes: the window starts at the first line starting with any of them (that line included). When no line matches, the window is empty. Omitted: the window starts at the first line.
|
|
169
|
+
- `to_line_starts_with` — array of prefixes: the window stops at the first line (after the window's first line) starting with any of them, that line included. When no line matches, the window runs to the end of the file. The exported `SEEK_TO_FROM_LINE_STARTS_WITH` meta value can be used (bare, or inside prefixes) as a placeholder for whichever `from` prefix actually matched.
|
|
170
|
+
- `lines_maximum` — caps the window to this many lines.
|
|
171
|
+
|
|
172
|
+
```ts
|
|
173
|
+
import { SEEK_TO_FROM_LINE_STARTS_WITH } from "githttp-fs-client";
|
|
174
|
+
|
|
175
|
+
// Select a whole front-matter block (both "---" markers included)
|
|
176
|
+
const frontMatter = await client.getFileContent("notes", "t_1", "articles/hello.md", {
|
|
177
|
+
from_line_starts_with: ["---"],
|
|
178
|
+
to_line_starts_with: SEEK_TO_FROM_LINE_STARTS_WITH
|
|
179
|
+
});
|
|
180
|
+
|
|
181
|
+
// Read at most the first 10 lines of each file
|
|
182
|
+
const previews = await client.batchGetFileContents("notes", "t_1", paths, {
|
|
183
|
+
lines_maximum: 10
|
|
184
|
+
});
|
|
185
|
+
```
|
|
186
|
+
|
|
34
187
|
## What is Git HTTP FS?
|
|
35
188
|
|
|
36
189
|
ℹ️ **Wondering what Git HTTP FS is?** Check out **[crisp-oss/githttp-fs](https://github.com/crisp-oss/githttp-fs)**.
|
package/dist/index.d.ts
CHANGED
|
@@ -44,6 +44,15 @@ export interface FileContent {
|
|
|
44
44
|
content: string;
|
|
45
45
|
path: string;
|
|
46
46
|
}
|
|
47
|
+
/**
|
|
48
|
+
* Types for seek options (getFileContent() and batchGetFileContents())
|
|
49
|
+
*/
|
|
50
|
+
export declare const SEEK_TO_FROM_LINE_STARTS_WITH = "$seek_from_line_starts_with";
|
|
51
|
+
export interface FileSeekOptions {
|
|
52
|
+
from_line_starts_with?: Array<string>;
|
|
53
|
+
to_line_starts_with?: Array<string> | typeof SEEK_TO_FROM_LINE_STARTS_WITH;
|
|
54
|
+
lines_maximum?: number;
|
|
55
|
+
}
|
|
47
56
|
/**
|
|
48
57
|
* Types for writeFile()
|
|
49
58
|
*/
|
|
@@ -105,6 +114,12 @@ export interface CommitRevertPayload {
|
|
|
105
114
|
author: CommitAuthor;
|
|
106
115
|
message?: string;
|
|
107
116
|
}
|
|
117
|
+
/**
|
|
118
|
+
* Types for batchGetFileContents()
|
|
119
|
+
*/
|
|
120
|
+
export interface FileContentBatch {
|
|
121
|
+
files: Array<FileContent | null>;
|
|
122
|
+
}
|
|
108
123
|
/**
|
|
109
124
|
* Git HTTP FS client, manages files and commits over the Git HTTP FS HTTP API.
|
|
110
125
|
*/
|
|
@@ -122,8 +137,8 @@ export declare class GitHTTPFSClient {
|
|
|
122
137
|
deleteTenant(collectionId: string, tenantId: string): Promise<void>;
|
|
123
138
|
/** List all tracked files (paths) */
|
|
124
139
|
listFiles(collectionId: string, tenantId: string, page?: number, perPage?: number, prefixPath?: string, maximumDepth?: number): Promise<FileList>;
|
|
125
|
-
/** Read file content */
|
|
126
|
-
getFileContent(collectionId: string, tenantId: string, path: string): Promise<FileContent>;
|
|
140
|
+
/** Read file content (optionally narrowed to a line window with seek) */
|
|
141
|
+
getFileContent(collectionId: string, tenantId: string, path: string, seek?: FileSeekOptions): Promise<FileContent>;
|
|
127
142
|
/** Check if a file exists in HEAD without reading its content */
|
|
128
143
|
fileExists(collectionId: string, tenantId: string, path: string): Promise<boolean>;
|
|
129
144
|
/** Create or update a file */
|
|
@@ -138,5 +153,8 @@ export declare class GitHTTPFSClient {
|
|
|
138
153
|
getCommitDetail(collectionId: string, tenantId: string, sha: string): Promise<CommitDetail>;
|
|
139
154
|
/** Revert a commit */
|
|
140
155
|
revertCommit(collectionId: string, tenantId: string, sha: string, payload: CommitRevertPayload): Promise<void>;
|
|
156
|
+
/** Read multiple file contents in one request (a null slot means the \
|
|
157
|
+
path does not exist; an optional seek window applies to every file) */
|
|
158
|
+
batchGetFileContents(collectionId: string, tenantId: string, paths: Array<string>, seek?: FileSeekOptions): Promise<FileContentBatch>;
|
|
141
159
|
}
|
|
142
160
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1B,IAAI,EAAE,WAAW,CAAC;CACnB;AAED,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAAG,uBAAuB,CAAC;AAExE,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,YAAY,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,YAAY,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,YAAY,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAYD;;GAEG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAyB;gBAE5B,MAAM,EAAE,YAAY;IAWhC;;OAEG;YACW,OAAO;IAoErB,kBAAkB;IACZ,QAAQ,IAAI,OAAO,CAAC,UAAU,CAAC;IAMrC,sCAAsC;IAChC,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMzE,qCAAqC;IAC/B,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,GAAE,MAAU,EAAE,OAAO,GAAE,MAAY,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAa/J,
|
|
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;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1B,IAAI,EAAE,WAAW,CAAC;CACnB;AAED,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAAG,uBAAuB,CAAC;AAExE,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,eAAO,MAAM,6BAA6B,gCAAgC,CAAC;AAE3E,MAAM,WAAW,eAAe;IAC9B,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACtC,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,OAAO,6BAA6B,CAAC;IAC3E,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,YAAY,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,YAAY,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,YAAY,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;CAClC;AAYD;;GAEG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAyB;gBAE5B,MAAM,EAAE,YAAY;IAWhC;;OAEG;YACW,OAAO;IAoErB,kBAAkB;IACZ,QAAQ,IAAI,OAAO,CAAC,UAAU,CAAC;IAMrC,sCAAsC;IAChC,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMzE,qCAAqC;IAC/B,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,GAAE,MAAU,EAAE,OAAO,GAAE,MAAY,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAa/J,yEAAyE;IACnE,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC;IAsBxH,iEAAiE;IAC3D,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAexF,8BAA8B;IACxB,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAM/G,oBAAoB;IACd,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMjH,2BAA2B;IACrB,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ7G,mCAAmC;IAC7B,WAAW,CACf,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,MAAU,EAChB,OAAO,GAAE,MAAY,EACrB,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,UAAU,CAAC;IAYtB,sDAAsD;IAChD,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAMjG,sBAAsB;IAChB,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAQpH;gFAC4E;IACtE,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAQ5I"}
|
package/dist/index.js
CHANGED
|
@@ -4,6 +4,10 @@
|
|
|
4
4
|
* Copyright 2026, Valerian Saliou
|
|
5
5
|
* Author: Valerian Saliou <valerian@valeriansaliou.name>
|
|
6
6
|
*/
|
|
7
|
+
/**
|
|
8
|
+
* Types for seek options (getFileContent() and batchGetFileContents())
|
|
9
|
+
*/
|
|
10
|
+
export const SEEK_TO_FROM_LINE_STARTS_WITH = "$seek_from_line_starts_with";
|
|
7
11
|
/** Defines the API version */
|
|
8
12
|
const VERSION = "v1";
|
|
9
13
|
/** Defines all HTTP methods */
|
|
@@ -94,9 +98,24 @@ export class GitHTTPFSClient {
|
|
|
94
98
|
};
|
|
95
99
|
return this.request(`${collectionId}/${tenantId}/files`, GET, undefined, params);
|
|
96
100
|
}
|
|
97
|
-
/** Read file content */
|
|
98
|
-
async getFileContent(collectionId, tenantId, path) {
|
|
99
|
-
|
|
101
|
+
/** Read file content (optionally narrowed to a line window with seek) */
|
|
102
|
+
async getFileContent(collectionId, tenantId, path, seek) {
|
|
103
|
+
// Prefix lists travel as JSON-array strings in query parameters, \
|
|
104
|
+
// except the bare meta value which is passed as-is
|
|
105
|
+
const params = {
|
|
106
|
+
seek_from_line_starts_with: (seek?.from_line_starts_with !== undefined)
|
|
107
|
+
? JSON.stringify(seek.from_line_starts_with)
|
|
108
|
+
: undefined,
|
|
109
|
+
seek_to_line_starts_with: (seek?.to_line_starts_with !== undefined)
|
|
110
|
+
? (typeof seek.to_line_starts_with === "string")
|
|
111
|
+
? seek.to_line_starts_with
|
|
112
|
+
: JSON.stringify(seek.to_line_starts_with)
|
|
113
|
+
: undefined,
|
|
114
|
+
seek_lines_maximum: (seek?.lines_maximum !== undefined)
|
|
115
|
+
? seek.lines_maximum.toString()
|
|
116
|
+
: undefined
|
|
117
|
+
};
|
|
118
|
+
return this.request(`${collectionId}/${tenantId}/files/${path}`, GET, undefined, params);
|
|
100
119
|
}
|
|
101
120
|
/** Check if a file exists in HEAD without reading its content */
|
|
102
121
|
async fileExists(collectionId, tenantId, path) {
|
|
@@ -142,5 +161,14 @@ export class GitHTTPFSClient {
|
|
|
142
161
|
async revertCommit(collectionId, tenantId, sha, payload) {
|
|
143
162
|
return this.request(`${collectionId}/${tenantId}/commits/${sha}/revert`, POST, payload);
|
|
144
163
|
}
|
|
164
|
+
// --- Batch Operations ---
|
|
165
|
+
/** Read multiple file contents in one request (a null slot means the \
|
|
166
|
+
path does not exist; an optional seek window applies to every file) */
|
|
167
|
+
async batchGetFileContents(collectionId, tenantId, paths, seek) {
|
|
168
|
+
return this.request(`${collectionId}/${tenantId}/batch/files/read`, POST, {
|
|
169
|
+
files: paths,
|
|
170
|
+
seek
|
|
171
|
+
});
|
|
172
|
+
}
|
|
145
173
|
}
|
|
146
174
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAwDH;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,6BAA6B,CAAC;AAoF3E,8BAA8B;AAC9B,MAAM,OAAO,GAAG,IAAI,CAAC;AAErB,+BAA+B;AAC/B,MAAM,IAAI,GAAG,MAAM,CAAC;AACpB,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,OAAe,EAAE,EACjB,SAAqD,GAAG,EACxD,OAAa,EACb,MAAyC;QAEzC,MAAM,GAAG,GAAG,IAAI,GAAG,CACjB,GAAG,IAAI,CAAC,OAAO,IAAI,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CACxD,CAAC;QAEF,0BAA0B;QAC1B,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;gBAC9C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBACxB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACnC,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,OAAO,GAAgB;YAC3B,MAAM;YAEN,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC;QAEF,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACzC,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,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAE/D,qEAAqE;YACrE,4BAA4B;YAC5B,IAAI,YAAY,CAAC;YAEjB,IAAI,CAAC;gBACH,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC;YAC9C,CAAC;YAAC,MAAM,CAAC;gBACP,YAAY,GAAG,SAAS,CAAC;YAC3B,CAAC;YAED,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,eAAe,QAAQ,CAAC,MAAM,MAAM,YAAY,IAAI,WAAW,EAAE,CAAC,CAAC;YAE3F,aAAa;YACb,KAAK,CAAC,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC;YAErC,MAAM,KAAK,CAAC;QACd,CAAC;QAED,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACpB,OAAO,SAAc,CAAC;QACxB,CAAC;QAED,0DAA0D;QAC1D,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEvC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,SAAc,CAAC;QACxB,CAAC;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAED,0BAA0B;IAE1B,kBAAkB;IAClB,KAAK,CAAC,QAAQ;QACZ,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;IAED,4BAA4B;IAE5B,sCAAsC;IACtC,KAAK,CAAC,YAAY,CAAC,YAAoB,EAAE,QAAgB;QACvD,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,YAAY,IAAI,QAAQ,EAAE,EAAE,MAAM,EAAE,EAAE,CAC1C,CAAC;IACJ,CAAC;IAED,qCAAqC;IACrC,KAAK,CAAC,SAAS,CAAC,YAAoB,EAAE,QAAgB,EAAE,OAAe,CAAC,EAAE,UAAkB,GAAG,EAAE,UAAmB,EAAE,YAAqB;QACzI,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE;YACrB,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE;YAC5B,WAAW,EAAE,UAAU,IAAI,EAAE;YAC7B,aAAa,EAAE,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;SAChF,CAAC;QAEF,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,YAAY,IAAI,QAAQ,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,CAC5D,CAAC;IACJ,CAAC;IAED,yEAAyE;IACzE,KAAK,CAAC,cAAc,CAAC,YAAoB,EAAE,QAAgB,EAAE,IAAY,EAAE,IAAsB;QAC/F,mEAAmE;QACnE,qDAAqD;QACrD,MAAM,MAAM,GAAG;YACb,0BAA0B,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,SAAS,CAAC;gBACrE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,qBAAqB,CAAC;gBAC5C,CAAC,CAAC,SAAS;YACb,wBAAwB,EAAE,CAAC,IAAI,EAAE,mBAAmB,KAAK,SAAS,CAAC;gBACjE,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,mBAAmB,KAAK,QAAQ,CAAC;oBAC9C,CAAC,CAAC,IAAI,CAAC,mBAAmB;oBAC1B,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC;gBAC5C,CAAC,CAAC,SAAS;YACb,kBAAkB,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,SAAS,CAAC;gBACrD,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;gBAC/B,CAAC,CAAC,SAAS;SACd,CAAC;QAEF,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,YAAY,IAAI,QAAQ,UAAU,IAAI,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,CACpE,CAAC;IACJ,CAAC;IAED,iEAAiE;IACjE,KAAK,CAAC,UAAU,CAAC,YAAoB,EAAE,QAAgB,EAAE,IAAY;QACnE,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,YAAY,IAAI,QAAQ,UAAU,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;YAEtE,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,aAAa;YACb,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,YAAY,KAAK,GAAG,EAAE,CAAC;gBACzD,OAAO,KAAK,CAAC;YACf,CAAC;YAED,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,8BAA8B;IAC9B,KAAK,CAAC,SAAS,CAAC,YAAoB,EAAE,QAAgB,EAAE,IAAY,EAAE,OAAyB;QAC7F,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,YAAY,IAAI,QAAQ,UAAU,IAAI,EAAE,EAAE,GAAG,EAAE,OAAO,CAC1D,CAAC;IACJ,CAAC;IAED,oBAAoB;IACpB,KAAK,CAAC,UAAU,CAAC,YAAoB,EAAE,QAAgB,EAAE,IAAY,EAAE,OAA0B;QAC/F,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,YAAY,IAAI,QAAQ,UAAU,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAC7D,CAAC;IACJ,CAAC;IAED,2BAA2B;IAC3B,KAAK,CAAC,QAAQ,CAAC,YAAoB,EAAE,QAAgB,EAAE,IAAY,EAAE,OAAwB;QAC3F,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,YAAY,IAAI,QAAQ,UAAU,IAAI,OAAO,EAAE,IAAI,EAAE,OAAO,CAChE,CAAC;IACJ,CAAC;IAED,4BAA4B;IAE5B,mCAAmC;IACnC,KAAK,CAAC,WAAW,CACf,YAAoB,EACpB,QAAgB,EAChB,OAAe,CAAC,EAChB,UAAkB,GAAG,EACrB,QAAiB;QAEjB,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE;YACrB,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE;YAC5B,SAAS,EAAE,QAAQ,IAAI,SAAS;SACjC,CAAC;QAEF,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,YAAY,IAAI,QAAQ,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,CAC9D,CAAC;IACJ,CAAC;IAED,sDAAsD;IACtD,KAAK,CAAC,eAAe,CAAC,YAAoB,EAAE,QAAgB,EAAE,GAAW;QACvE,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,YAAY,IAAI,QAAQ,YAAY,GAAG,EAAE,EAAE,GAAG,CAClD,CAAC;IACJ,CAAC;IAED,sBAAsB;IACtB,KAAK,CAAC,YAAY,CAAC,YAAoB,EAAE,QAAgB,EAAE,GAAW,EAAE,OAA4B;QAClG,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,YAAY,IAAI,QAAQ,YAAY,GAAG,SAAS,EAAE,IAAI,EAAE,OAAO,CACnE,CAAC;IACJ,CAAC;IAED,2BAA2B;IAE3B;gFAC4E;IAC5E,KAAK,CAAC,oBAAoB,CAAC,YAAoB,EAAE,QAAgB,EAAE,KAAoB,EAAE,IAAsB;QAC7G,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,YAAY,IAAI,QAAQ,mBAAmB,EAAE,IAAI,EAAE;YACpD,KAAK,EAAE,KAAK;YACZ,IAAI;SACL,CACF,CAAC;IACJ,CAAC;CACF"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "githttp-fs-client",
|
|
3
3
|
"description": "Git HTTP FS client for Node. Used in pair with Git HTTP FS, a git-backed content management database served over HTTP.",
|
|
4
|
-
"version": "1.0.
|
|
4
|
+
"version": "1.0.21",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"homepage": "https://github.com/crisp-oss/node-githttp-fs-client",
|
|
7
7
|
"license": "MIT",
|