githttp-fs-client 1.4.0 → 1.5.0
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 +4 -4
- package/dist/index.d.ts +40 -5
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +12 -6
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -132,20 +132,20 @@ await client.moveFile("notes", "t_1", "articles/hello.md", {
|
|
|
132
132
|
|
|
133
133
|
#### `listCommits(collectionId, tenantId, page?, perPage?, filePath?): Promise<CommitList>`
|
|
134
134
|
|
|
135
|
-
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.
|
|
135
|
+
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. Pass `includeStatistics: true` to add a `statistics` (`{ insertions, deletions, files_changed }`) object to each commit.
|
|
136
136
|
|
|
137
137
|
```ts
|
|
138
|
-
const commits = await client.listCommits("notes", "t_1", 1, 10);
|
|
138
|
+
const commits = await client.listCommits("notes", "t_1", { page: 1, perPage: 10 });
|
|
139
139
|
// { commits: [{ sha, message, author, committed_at }, ...], ... }
|
|
140
140
|
```
|
|
141
141
|
|
|
142
142
|
#### `getCommitDetail(collectionId, tenantId, sha): Promise<CommitDetail>`
|
|
143
143
|
|
|
144
|
-
Returns the details of a commit, with per-file diffs and
|
|
144
|
+
Returns the details of a commit, with per-file diffs, content snapshots, and aggregate `statistics` (`{ insertions, deletions, files_changed }`).
|
|
145
145
|
|
|
146
146
|
```ts
|
|
147
147
|
const detail = await client.getCommitDetail("notes", "t_1", "9b924c1d...");
|
|
148
|
-
// { sha, message, author, committed_at, files: [{ path, change, content, diff }] }
|
|
148
|
+
// { sha, message, author, committed_at, files: [{ path, change, content, diff }], statistics: { insertions, deletions, files_changed } }
|
|
149
149
|
```
|
|
150
150
|
|
|
151
151
|
#### `revertCommit(collectionId, tenantId, sha, payload): Promise<void>`
|
package/dist/index.d.ts
CHANGED
|
@@ -25,6 +25,12 @@ export interface FileCount {
|
|
|
25
25
|
files: number;
|
|
26
26
|
directories: number;
|
|
27
27
|
}
|
|
28
|
+
export interface CountFilesOptions {
|
|
29
|
+
prefixPath?: string;
|
|
30
|
+
maximumDepth?: number;
|
|
31
|
+
includeHiddenFiles?: boolean;
|
|
32
|
+
restrictFileExtensions?: Array<string>;
|
|
33
|
+
}
|
|
28
34
|
/**
|
|
29
35
|
* Types for listFiles()
|
|
30
36
|
*/
|
|
@@ -44,6 +50,13 @@ export interface FileList {
|
|
|
44
50
|
per_page: number;
|
|
45
51
|
has_more: boolean;
|
|
46
52
|
}
|
|
53
|
+
export interface ListFilesOptions {
|
|
54
|
+
page?: number;
|
|
55
|
+
perPage?: number;
|
|
56
|
+
prefixPath?: string;
|
|
57
|
+
maximumDepth?: number;
|
|
58
|
+
includeHiddenFiles?: boolean;
|
|
59
|
+
}
|
|
47
60
|
/**
|
|
48
61
|
* Types for getFileContent()
|
|
49
62
|
*/
|
|
@@ -51,6 +64,9 @@ export interface FileContent {
|
|
|
51
64
|
content: string;
|
|
52
65
|
path: string;
|
|
53
66
|
}
|
|
67
|
+
export interface GetFileContentOptions {
|
|
68
|
+
seek?: FileSeekOptions;
|
|
69
|
+
}
|
|
54
70
|
/**
|
|
55
71
|
* Types for seek options (getFileContent() and batchGetFileContents())
|
|
56
72
|
*/
|
|
@@ -83,6 +99,14 @@ export interface FileMovePayload {
|
|
|
83
99
|
destination: string;
|
|
84
100
|
message?: string;
|
|
85
101
|
}
|
|
102
|
+
/**
|
|
103
|
+
* Types shared by listCommits() and getCommitDetail()
|
|
104
|
+
*/
|
|
105
|
+
export interface CommitStatistics {
|
|
106
|
+
insertions: number;
|
|
107
|
+
deletions: number;
|
|
108
|
+
files_changed: number;
|
|
109
|
+
}
|
|
86
110
|
/**
|
|
87
111
|
* Types for listCommits()
|
|
88
112
|
*/
|
|
@@ -91,6 +115,7 @@ export interface CommitListCommit {
|
|
|
91
115
|
committed_at: string;
|
|
92
116
|
message: string;
|
|
93
117
|
sha: string;
|
|
118
|
+
statistics?: CommitStatistics;
|
|
94
119
|
}
|
|
95
120
|
export interface CommitList {
|
|
96
121
|
commits: Array<CommitListCommit>;
|
|
@@ -98,6 +123,12 @@ export interface CommitList {
|
|
|
98
123
|
per_page: number;
|
|
99
124
|
has_more: boolean;
|
|
100
125
|
}
|
|
126
|
+
export interface ListCommitsOptions {
|
|
127
|
+
page?: number;
|
|
128
|
+
perPage?: number;
|
|
129
|
+
filePath?: string;
|
|
130
|
+
includeStatistics?: boolean;
|
|
131
|
+
}
|
|
101
132
|
/**
|
|
102
133
|
* Types for getCommitDetail()
|
|
103
134
|
*/
|
|
@@ -113,6 +144,7 @@ export interface CommitDetail {
|
|
|
113
144
|
author: CommitAuthor;
|
|
114
145
|
committed_at: string;
|
|
115
146
|
files: Array<CommitDetailFile>;
|
|
147
|
+
statistics: CommitStatistics;
|
|
116
148
|
}
|
|
117
149
|
/**
|
|
118
150
|
* Types for revertCommit()
|
|
@@ -131,6 +163,9 @@ export type FileContentBatchPath = string | {
|
|
|
131
163
|
export interface FileContentBatch {
|
|
132
164
|
files: Array<FileContent | null>;
|
|
133
165
|
}
|
|
166
|
+
export interface BatchGetFileContentsOptions {
|
|
167
|
+
seek?: FileSeekOptions;
|
|
168
|
+
}
|
|
134
169
|
/**
|
|
135
170
|
* Git HTTP FS client, manages files and commits over the Git HTTP FS HTTP API.
|
|
136
171
|
*/
|
|
@@ -146,13 +181,13 @@ export declare class GitHTTPFSClient {
|
|
|
146
181
|
sendPing(): Promise<PingResult>;
|
|
147
182
|
/** Count files and directories (an optional list of file extensions \
|
|
148
183
|
narrows the file count to files carrying one of them) */
|
|
149
|
-
countFiles(collectionId: string, tenantId: string,
|
|
184
|
+
countFiles(collectionId: string, tenantId: string, options?: CountFilesOptions): Promise<FileCount>;
|
|
150
185
|
/** Delete entire tenant repository */
|
|
151
186
|
deleteTenant(collectionId: string, tenantId: string): Promise<void>;
|
|
152
187
|
/** List all tracked files (paths) */
|
|
153
|
-
listFiles(collectionId: string, tenantId: string,
|
|
188
|
+
listFiles(collectionId: string, tenantId: string, options?: ListFilesOptions): Promise<FileList>;
|
|
154
189
|
/** Read file content (optionally narrowed to a line window with seek) */
|
|
155
|
-
getFileContent(collectionId: string, tenantId: string, path: string,
|
|
190
|
+
getFileContent(collectionId: string, tenantId: string, path: string, options?: GetFileContentOptions): Promise<FileContent>;
|
|
156
191
|
/** Check if a file exists in HEAD without reading its content */
|
|
157
192
|
fileExists(collectionId: string, tenantId: string, path: string): Promise<boolean>;
|
|
158
193
|
/** Create or update a file */
|
|
@@ -162,7 +197,7 @@ export declare class GitHTTPFSClient {
|
|
|
162
197
|
/** Move / rename a file */
|
|
163
198
|
moveFile(collectionId: string, tenantId: string, path: string, payload: FileMovePayload): Promise<void>;
|
|
164
199
|
/** List commits with pagination */
|
|
165
|
-
listCommits(collectionId: string, tenantId: string,
|
|
200
|
+
listCommits(collectionId: string, tenantId: string, options?: ListCommitsOptions): Promise<CommitList>;
|
|
166
201
|
/** Commit detail with per-file diffs and snapshots */
|
|
167
202
|
getCommitDetail(collectionId: string, tenantId: string, sha: string): Promise<CommitDetail>;
|
|
168
203
|
/** Revert a commit */
|
|
@@ -170,6 +205,6 @@ export declare class GitHTTPFSClient {
|
|
|
170
205
|
/** Read multiple file contents in one request (a null slot means the \
|
|
171
206
|
path does not exist; an optional seek window applies to every file, \
|
|
172
207
|
overridable per file with a { path, seek } entry) */
|
|
173
|
-
batchGetFileContents(collectionId: string, tenantId: string, paths: Array<FileContentBatchPath>,
|
|
208
|
+
batchGetFileContents(collectionId: string, tenantId: string, paths: Array<FileContentBatchPath>, options?: BatchGetFileContentsOptions): Promise<FileContentBatch>;
|
|
174
209
|
}
|
|
175
210
|
//# 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,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACrB;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;
|
|
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,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxC;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,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;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,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;CACvB;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;IACZ,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;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,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;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;IAC/B,UAAU,EAAE,gBAAgB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB,CAAC;AAEF,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAYD;;GAEG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAyB;IAExC,YAAY,MAAM,EAAE,YAAY,EAS/B;IAED;;OAEG;YACW,OAAO;IAoErB,kBAAkB;IACZ,QAAQ,IAAI,OAAO,CAAC,UAAU,CAAC,CAEpC;IAID;kEAC8D;IACxD,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,SAAS,CAAC,CAe5G;IAID,sCAAsC;IAChC,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAIxE;IAED,qCAAqC;IAC/B,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAczG;IAED,yEAAyE;IACnE,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B,GAAG,OAAO,CAAC,WAAW,CAAC,CAsBpI;IAED,iEAAiE;IAC3D,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAavF;IAED,8BAA8B;IACxB,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAI9G;IAED,oBAAoB;IACd,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAIhH;IAED,2BAA2B;IACrB,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAI5G;IAID,mCAAmC;IAC7B,WAAW,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,kBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC,CAa/G;IAED,sDAAsD;IAChD,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAIhG;IAED,sBAAsB;IAChB,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAInH;IAID;;8DAE0D;IACpD,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,EAAE,OAAO,GAAE,2BAAgC,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAS3K;CACF"}
|
package/dist/index.js
CHANGED
|
@@ -86,7 +86,8 @@ export class GitHTTPFSClient {
|
|
|
86
86
|
// --- Count Operations ---
|
|
87
87
|
/** Count files and directories (an optional list of file extensions \
|
|
88
88
|
narrows the file count to files carrying one of them) */
|
|
89
|
-
async countFiles(collectionId, tenantId,
|
|
89
|
+
async countFiles(collectionId, tenantId, options = {}) {
|
|
90
|
+
const { prefixPath, maximumDepth, includeHiddenFiles, restrictFileExtensions } = options;
|
|
90
91
|
// Extension lists travel as JSON-array strings in query parameters, \
|
|
91
92
|
// same wire spelling as the seek prefix lists
|
|
92
93
|
const params = {
|
|
@@ -103,7 +104,8 @@ export class GitHTTPFSClient {
|
|
|
103
104
|
return this.request(`${collectionId}/${tenantId}`, DELETE, {});
|
|
104
105
|
}
|
|
105
106
|
/** List all tracked files (paths) */
|
|
106
|
-
async listFiles(collectionId, tenantId,
|
|
107
|
+
async listFiles(collectionId, tenantId, options = {}) {
|
|
108
|
+
const { page = 1, perPage = 100, prefixPath, maximumDepth, includeHiddenFiles } = options;
|
|
107
109
|
const params = {
|
|
108
110
|
page: page.toString(),
|
|
109
111
|
per_page: perPage.toString(),
|
|
@@ -114,7 +116,8 @@ export class GitHTTPFSClient {
|
|
|
114
116
|
return this.request(`${collectionId}/${tenantId}/files`, GET, undefined, params);
|
|
115
117
|
}
|
|
116
118
|
/** Read file content (optionally narrowed to a line window with seek) */
|
|
117
|
-
async getFileContent(collectionId, tenantId, path,
|
|
119
|
+
async getFileContent(collectionId, tenantId, path, options = {}) {
|
|
120
|
+
const { seek } = options;
|
|
118
121
|
// Prefix lists travel as JSON-array strings in query parameters, \
|
|
119
122
|
// except the bare meta value which is passed as-is
|
|
120
123
|
const params = {
|
|
@@ -160,11 +163,13 @@ export class GitHTTPFSClient {
|
|
|
160
163
|
}
|
|
161
164
|
// --- Commit Operations ---
|
|
162
165
|
/** List commits with pagination */
|
|
163
|
-
async listCommits(collectionId, tenantId,
|
|
166
|
+
async listCommits(collectionId, tenantId, options = {}) {
|
|
167
|
+
const { page = 1, perPage = 100, filePath, includeStatistics } = options;
|
|
164
168
|
const params = {
|
|
165
169
|
page: page.toString(),
|
|
166
170
|
per_page: perPage.toString(),
|
|
167
|
-
file_path: filePath || undefined
|
|
171
|
+
file_path: filePath || undefined,
|
|
172
|
+
include_statistics: includeStatistics ? "true" : undefined
|
|
168
173
|
};
|
|
169
174
|
return this.request(`${collectionId}/${tenantId}/commits`, GET, undefined, params);
|
|
170
175
|
}
|
|
@@ -180,7 +185,8 @@ export class GitHTTPFSClient {
|
|
|
180
185
|
/** Read multiple file contents in one request (a null slot means the \
|
|
181
186
|
path does not exist; an optional seek window applies to every file, \
|
|
182
187
|
overridable per file with a { path, seek } entry) */
|
|
183
|
-
async batchGetFileContents(collectionId, tenantId, paths,
|
|
188
|
+
async batchGetFileContents(collectionId, tenantId, paths, options = {}) {
|
|
189
|
+
const { seek } = options;
|
|
184
190
|
return this.request(`${collectionId}/${tenantId}/batch/files/read`, POST, {
|
|
185
191
|
files: paths,
|
|
186
192
|
seek
|
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;AAmFH;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,6BAA6B,CAAC;AA+G3E,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,IAAI,GAAW,EAAE,EACjB,MAAM,GAA+C,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,2BAA2B;IAE3B;kEAC8D;IAC9D,KAAK,CAAC,UAAU,CAAC,YAAoB,EAAE,QAAgB,EAAE,OAAO,GAAsB,EAAE;QACtF,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,GAAG,OAAO,CAAC;QAEzF,sEAAsE;QACtE,gDAAgD;QAChD,MAAM,MAAM,GAAG;YACb,WAAW,EAAE,UAAU,IAAI,EAAE;YAC7B,aAAa,EAAE,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;YAC/E,oBAAoB,EAAE,kBAAkB,KAAK,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;YAClG,wBAAwB,EAAE,sBAAsB,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,SAAS;SACpH,CAAC;QAEF,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,YAAY,IAAI,QAAQ,cAAc,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,CAClE,CAAC;IACJ,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,OAAO,GAAqB,EAAE;QACpF,MAAM,EAAE,IAAI,GAAG,CAAC,EAAE,OAAO,GAAG,GAAG,EAAE,UAAU,EAAE,YAAY,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC;QAE1F,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;YAC/E,oBAAoB,EAAE,kBAAkB,KAAK,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;SACnG,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,OAAO,GAA0B,EAAE;QAC5G,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;QAEzB,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,CAAC,YAAoB,EAAE,QAAgB,EAAE,OAAO,GAAuB,EAAE;QACxF,MAAM,EAAE,IAAI,GAAG,CAAC,EAAE,OAAO,GAAG,GAAG,EAAE,QAAQ,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC;QAEzE,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE;YACrB,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE;YAC5B,SAAS,EAAE,QAAQ,IAAI,SAAS;YAChC,kBAAkB,EAAE,iBAAiB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;SAC3D,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;;8DAE0D;IAC1D,KAAK,CAAC,oBAAoB,CAAC,YAAoB,EAAE,QAAgB,EAAE,KAAkC,EAAE,OAAO,GAAgC,EAAE;QAC9I,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;QAEzB,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.
|
|
4
|
+
"version": "1.5.0",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"homepage": "https://github.com/crisp-oss/node-githttp-fs-client",
|
|
7
7
|
"license": "MIT",
|