githttp-fs-client 1.7.0 → 1.8.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 +26 -2
- package/dist/index.d.ts +18 -4
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +25 -7
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -99,12 +99,17 @@ const file = await client.getFileContent("notes", "t_1", "articles/hello.md");
|
|
|
99
99
|
// { path: "articles/hello.md", content: "..." }
|
|
100
100
|
```
|
|
101
101
|
|
|
102
|
-
#### `fileExists(collectionId, tenantId, path): Promise<boolean>`
|
|
102
|
+
#### `fileExists(collectionId, tenantId, path, options?): Promise<boolean>`
|
|
103
103
|
|
|
104
|
-
Checks whether a file exists, without reading its content (cheaper than `getFileContent()`).
|
|
104
|
+
Checks whether a file exists, without reading its content (cheaper than `getFileContent()`). Pass `checkPrefixPath: true` to also count a directory at that path as existing (useful before a recursive delete or move).
|
|
105
105
|
|
|
106
106
|
```ts
|
|
107
107
|
const exists = await client.fileExists("notes", "t_1", "articles/hello.md");
|
|
108
|
+
|
|
109
|
+
// Does anything exist at this path, file or directory?
|
|
110
|
+
const anyExists = await client.fileExists("notes", "t_1", "articles", {
|
|
111
|
+
checkPrefixPath: true
|
|
112
|
+
});
|
|
108
113
|
```
|
|
109
114
|
|
|
110
115
|
#### `writeFile(collectionId, tenantId, path, payload): Promise<void>`
|
|
@@ -129,6 +134,15 @@ await client.deleteFile("notes", "t_1", "articles/hello.md", {
|
|
|
129
134
|
});
|
|
130
135
|
```
|
|
131
136
|
|
|
137
|
+
Set `allowPrefixPathRecurse: true` to let the path name a directory instead, deleting every file beneath it in a single commit (one webhook event per file). It only permits directory semantics: a path resolving to a file still runs the ordinary single-file delete.
|
|
138
|
+
|
|
139
|
+
```ts
|
|
140
|
+
await client.deleteFile("notes", "t_1", "articles", {
|
|
141
|
+
author: { name: "Jane Doe", email: "jane@doe.com" },
|
|
142
|
+
allowPrefixPathRecurse: true
|
|
143
|
+
});
|
|
144
|
+
```
|
|
145
|
+
|
|
132
146
|
#### `moveFile(collectionId, tenantId, path, payload): Promise<void>`
|
|
133
147
|
|
|
134
148
|
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`.
|
|
@@ -140,6 +154,16 @@ await client.moveFile("notes", "t_1", "articles/hello.md", {
|
|
|
140
154
|
});
|
|
141
155
|
```
|
|
142
156
|
|
|
157
|
+
Set `allowPrefixPathRecurse: true` to let the path name a directory instead, relocating its whole subtree in a single commit (each file keeps its own leaf name, and emits its own move event). The `destination` must not already exist, and must not sit inside the source directory.
|
|
158
|
+
|
|
159
|
+
```ts
|
|
160
|
+
await client.moveFile("notes", "t_1", "articles", {
|
|
161
|
+
destination: "archives",
|
|
162
|
+
author: { name: "Jane Doe", email: "jane@doe.com" },
|
|
163
|
+
allowPrefixPathRecurse: true
|
|
164
|
+
});
|
|
165
|
+
```
|
|
166
|
+
|
|
143
167
|
### Commit operations
|
|
144
168
|
|
|
145
169
|
#### `listCommits(collectionId, tenantId, page?, perPage?, filePath?): Promise<CommitList>`
|
package/dist/index.d.ts
CHANGED
|
@@ -89,12 +89,19 @@ export interface FileWritePayload {
|
|
|
89
89
|
content: string;
|
|
90
90
|
message?: string;
|
|
91
91
|
}
|
|
92
|
+
/**
|
|
93
|
+
* Types for fileExists()
|
|
94
|
+
*/
|
|
95
|
+
export interface FileExistsOptions {
|
|
96
|
+
checkPrefixPath?: boolean;
|
|
97
|
+
}
|
|
92
98
|
/**
|
|
93
99
|
* Types for deleteFile()
|
|
94
100
|
*/
|
|
95
101
|
export interface FileDeletePayload {
|
|
96
102
|
author: CommitAuthor;
|
|
97
103
|
message?: string;
|
|
104
|
+
allowPrefixPathRecurse?: boolean;
|
|
98
105
|
}
|
|
99
106
|
/**
|
|
100
107
|
* Types for moveFile()
|
|
@@ -103,6 +110,7 @@ export interface FileMovePayload {
|
|
|
103
110
|
author: CommitAuthor;
|
|
104
111
|
destination: string;
|
|
105
112
|
message?: string;
|
|
113
|
+
allowPrefixPathRecurse?: boolean;
|
|
106
114
|
}
|
|
107
115
|
/**
|
|
108
116
|
* Types shared by listCommits() and getCommitDetail()
|
|
@@ -197,13 +205,19 @@ export declare class GitHTTPFSClient {
|
|
|
197
205
|
listFiles(collectionId: string, tenantId: string, options?: ListFilesOptions): Promise<FileList>;
|
|
198
206
|
/** Read file content (optionally narrowed to a line window with seek) */
|
|
199
207
|
getFileContent(collectionId: string, tenantId: string, path: string, options?: GetFileContentOptions): Promise<FileContent>;
|
|
200
|
-
/** Check if a file exists in HEAD without reading its content
|
|
201
|
-
|
|
208
|
+
/** Check if a file exists in HEAD without reading its content (with \
|
|
209
|
+
'checkPrefixPath' enabled, a directory at that path counts as \
|
|
210
|
+
existing too) */
|
|
211
|
+
fileExists(collectionId: string, tenantId: string, path: string, options?: FileExistsOptions): Promise<boolean>;
|
|
202
212
|
/** Create or update a file */
|
|
203
213
|
writeFile(collectionId: string, tenantId: string, path: string, payload: FileWritePayload): Promise<void>;
|
|
204
|
-
/** Delete a file
|
|
214
|
+
/** Delete a file (with 'allowPrefixPathRecurse' enabled in the payload, \
|
|
215
|
+
the path may name a directory, whose files are all deleted in a \
|
|
216
|
+
single commit) */
|
|
205
217
|
deleteFile(collectionId: string, tenantId: string, path: string, payload: FileDeletePayload): Promise<void>;
|
|
206
|
-
/** Move / rename a file
|
|
218
|
+
/** Move / rename a file (with 'allowPrefixPathRecurse' enabled in the \
|
|
219
|
+
payload, the path may name a directory, whose whole subtree is \
|
|
220
|
+
relocated in a single commit) */
|
|
207
221
|
moveFile(collectionId: string, tenantId: string, path: string, payload: FileMovePayload): Promise<void>;
|
|
208
222
|
/** List commits with pagination */
|
|
209
223
|
listCommits(collectionId: string, tenantId: string, options?: ListCommitsOptions): Promise<CommitList>;
|
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,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,YAAY,CAAC,CAAC;IAC9B,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,MAAM,iBAAiB,GAAG,SAAS,GAAG,SAAS,CAAC;AAEtD,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;IAC7B,kBAAkB,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5C,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,eAAe,CAAC,EAAE,iBAAiB,CAAC;CACrC;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;
|
|
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,YAAY,CAAC,CAAC;IAC9B,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,MAAM,iBAAiB,GAAG,SAAS,GAAG,SAAS,CAAC;AAEtD,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;IAC7B,kBAAkB,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5C,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,eAAe,CAAC,EAAE,iBAAiB,CAAC;CACrC;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,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,YAAY,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC;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,qBAAqB,GAAG,mBAAmB,CAAC;AAExD;;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;AAwBD;;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,CA6BzG;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;;0BAEsB;IAChB,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC,CAmBxH;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;;2BAEuB;IACjB,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAUhH;IAED;;0CAEsC;IAChC,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAU5G;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;IAED;sDACkD;IAC5C,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CAIvH;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
|
@@ -157,10 +157,16 @@ export class GitHTTPFSClient {
|
|
|
157
157
|
};
|
|
158
158
|
return this.request(`${collectionId}/${tenantId}/files/${path}`, GET, undefined, params);
|
|
159
159
|
}
|
|
160
|
-
/** Check if a file exists in HEAD without reading its content
|
|
161
|
-
|
|
160
|
+
/** Check if a file exists in HEAD without reading its content (with \
|
|
161
|
+
'checkPrefixPath' enabled, a directory at that path counts as \
|
|
162
|
+
existing too) */
|
|
163
|
+
async fileExists(collectionId, tenantId, path, options = {}) {
|
|
164
|
+
const { checkPrefixPath } = options;
|
|
165
|
+
const params = {
|
|
166
|
+
check_prefix_path: checkPrefixPath !== undefined ? checkPrefixPath.toString() : undefined
|
|
167
|
+
};
|
|
162
168
|
try {
|
|
163
|
-
await this.request(`${collectionId}/${tenantId}/files/${path}`, HEAD);
|
|
169
|
+
await this.request(`${collectionId}/${tenantId}/files/${path}`, HEAD, undefined, params);
|
|
164
170
|
return true;
|
|
165
171
|
}
|
|
166
172
|
catch (error) {
|
|
@@ -175,13 +181,25 @@ export class GitHTTPFSClient {
|
|
|
175
181
|
async writeFile(collectionId, tenantId, path, payload) {
|
|
176
182
|
return this.request(`${collectionId}/${tenantId}/files/${path}`, PUT, payload);
|
|
177
183
|
}
|
|
178
|
-
/** Delete a file
|
|
184
|
+
/** Delete a file (with 'allowPrefixPathRecurse' enabled in the payload, \
|
|
185
|
+
the path may name a directory, whose files are all deleted in a \
|
|
186
|
+
single commit) */
|
|
179
187
|
async deleteFile(collectionId, tenantId, path, payload) {
|
|
180
|
-
|
|
188
|
+
const { allowPrefixPathRecurse, ...basePayload } = payload;
|
|
189
|
+
return this.request(`${collectionId}/${tenantId}/files/${path}`, DELETE, {
|
|
190
|
+
...basePayload,
|
|
191
|
+
allow_prefix_path_recurse: allowPrefixPathRecurse
|
|
192
|
+
});
|
|
181
193
|
}
|
|
182
|
-
/** Move / rename a file
|
|
194
|
+
/** Move / rename a file (with 'allowPrefixPathRecurse' enabled in the \
|
|
195
|
+
payload, the path may name a directory, whose whole subtree is \
|
|
196
|
+
relocated in a single commit) */
|
|
183
197
|
async moveFile(collectionId, tenantId, path, payload) {
|
|
184
|
-
|
|
198
|
+
const { allowPrefixPathRecurse, ...basePayload } = payload;
|
|
199
|
+
return this.request(`${collectionId}/${tenantId}/files/${path}/move`, POST, {
|
|
200
|
+
...basePayload,
|
|
201
|
+
allow_prefix_path_recurse: allowPrefixPathRecurse
|
|
202
|
+
});
|
|
185
203
|
}
|
|
186
204
|
// --- Commit Operations ---
|
|
187
205
|
/** List commits with pagination */
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAyFH;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,6BAA6B,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAyFH;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,6BAA6B,CAAC;AA6H3E,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;;;GAGG;AACH,SAAS,SAAS,CAAC,IAAoB;IACrC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,CAAC,IAAI,YAAY,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AAC5D,CAAC;AAED;;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,EACJ,IAAI,GAAG,CAAC,EAAE,OAAO,GAAG,GAAG,EAAE,UAAU,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EACzF,eAAe,EAAE,aAAa,EAAE,eAAe,EAChD,GAAG,OAAO,CAAC;QAEZ,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;YAClG,mEAAmE;YACnE,mEAAmE;YACnE,qBAAqB,EAAE,CAAC,kBAAkB,KAAK,SAAS,CAAC;gBACvD,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,kBAAkB,CAAC;oBAClC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC;oBACpC,CAAC,CAAC,kBAAkB,CAAC;gBACvB,CAAC,CAAC,SAAS;YACb,gEAAgE;YAChE,+DAA+D;YAC/D,iBAAiB,EAAE,SAAS,CAAC,eAAe,CAAC;YAC7C,eAAe,EAAE,SAAS,CAAC,aAAa,CAAC;YACzC,iBAAiB,EAAE,eAAe;SACnC,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;;0BAEsB;IACtB,KAAK,CAAC,UAAU,CAAC,YAAoB,EAAE,QAAgB,EAAE,IAAY,EAAE,OAAO,GAAsB,EAAE;QACpG,MAAM,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;QAEpC,MAAM,MAAM,GAAG;YACb,iBAAiB,EAAE,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;SAC1F,CAAC;QAEF,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,YAAY,IAAI,QAAQ,UAAU,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;YAEzF,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;;2BAEuB;IACvB,KAAK,CAAC,UAAU,CAAC,YAAoB,EAAE,QAAgB,EAAE,IAAY,EAAE,OAA0B;QAC/F,MAAM,EAAE,sBAAsB,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC;QAE3D,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,YAAY,IAAI,QAAQ,UAAU,IAAI,EAAE,EAAE,MAAM,EAAE;YACnD,GAAG,WAAW;YAEd,yBAAyB,EAAE,sBAAsB;SAClD,CACF,CAAC;IACJ,CAAC;IAED;;0CAEsC;IACtC,KAAK,CAAC,QAAQ,CAAC,YAAoB,EAAE,QAAgB,EAAE,IAAY,EAAE,OAAwB;QAC3F,MAAM,EAAE,sBAAsB,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC;QAE3D,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,YAAY,IAAI,QAAQ,UAAU,IAAI,OAAO,EAAE,IAAI,EAAE;YACtD,GAAG,WAAW;YAEd,yBAAyB,EAAE,sBAAsB;SAClD,CACF,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;sDACkD;IAClD,KAAK,CAAC,cAAc,CAAC,YAAoB,EAAE,QAAgB,EAAE,GAAW,EAAE,OAA8B;QACtG,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,YAAY,IAAI,QAAQ,YAAY,GAAG,WAAW,EAAE,IAAI,EAAE,OAAO,CACrE,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.8.0",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"homepage": "https://github.com/crisp-oss/node-githttp-fs-client",
|
|
7
7
|
"license": "MIT",
|