githttp-fs-client 1.0.5 → 1.0.7
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/dist/index.d.ts +36 -9
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +9 -9
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -5,6 +5,13 @@ export interface ClientConfig {
|
|
|
5
5
|
baseUrl: string;
|
|
6
6
|
apiKey: string;
|
|
7
7
|
}
|
|
8
|
+
/**
|
|
9
|
+
* Common types
|
|
10
|
+
*/
|
|
11
|
+
export interface CommitAuthor {
|
|
12
|
+
email: string;
|
|
13
|
+
name: string;
|
|
14
|
+
}
|
|
8
15
|
/**
|
|
9
16
|
* Types for listFiles()
|
|
10
17
|
*/
|
|
@@ -27,14 +34,26 @@ export interface FileContent {
|
|
|
27
34
|
path: string;
|
|
28
35
|
}
|
|
29
36
|
/**
|
|
30
|
-
* Types for
|
|
37
|
+
* Types for writeFile()
|
|
31
38
|
*/
|
|
32
|
-
export interface
|
|
33
|
-
|
|
34
|
-
|
|
39
|
+
export interface FileWritePayload {
|
|
40
|
+
author: CommitAuthor;
|
|
41
|
+
content: string;
|
|
42
|
+
message?: string;
|
|
35
43
|
}
|
|
44
|
+
/**
|
|
45
|
+
* Types for moveFile()
|
|
46
|
+
*/
|
|
47
|
+
export interface FileMovePayload {
|
|
48
|
+
author: CommitAuthor;
|
|
49
|
+
destination: string;
|
|
50
|
+
message?: string;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Types for listCommits()
|
|
54
|
+
*/
|
|
36
55
|
export interface CommitListCommit {
|
|
37
|
-
author:
|
|
56
|
+
author: CommitAuthor;
|
|
38
57
|
committed_at: string;
|
|
39
58
|
message: string;
|
|
40
59
|
sha: string;
|
|
@@ -43,6 +62,7 @@ export interface CommitList {
|
|
|
43
62
|
commits: Array<CommitListCommit>;
|
|
44
63
|
page: number;
|
|
45
64
|
per_page: number;
|
|
65
|
+
has_more: boolean;
|
|
46
66
|
}
|
|
47
67
|
/**
|
|
48
68
|
* Types for getCommitDetail()
|
|
@@ -56,10 +76,17 @@ export interface CommitDetailFile {
|
|
|
56
76
|
export interface CommitDetail {
|
|
57
77
|
sha: string;
|
|
58
78
|
message: string;
|
|
59
|
-
author:
|
|
79
|
+
author: CommitAuthor;
|
|
60
80
|
committed_at: string;
|
|
61
81
|
files: Array<CommitDetailFile>;
|
|
62
82
|
}
|
|
83
|
+
/**
|
|
84
|
+
* Types for revertCommit()
|
|
85
|
+
*/
|
|
86
|
+
export interface CommitRevertPayload {
|
|
87
|
+
author: CommitAuthor;
|
|
88
|
+
message: string;
|
|
89
|
+
}
|
|
63
90
|
/**
|
|
64
91
|
* Git HTTP FS client, manages files and commits over the Git HTTP FS HTTP API.
|
|
65
92
|
*/
|
|
@@ -78,16 +105,16 @@ export declare class GitHTTPFSClient {
|
|
|
78
105
|
/** Read file content */
|
|
79
106
|
getFileContent(collectionId: string, tenantId: string, path: string): Promise<FileContent>;
|
|
80
107
|
/** Create or update a file */
|
|
81
|
-
|
|
108
|
+
writeFile(collectionId: string, tenantId: string, path: string, payload: FileWritePayload): Promise<void>;
|
|
82
109
|
/** Delete a file */
|
|
83
110
|
deleteFile(collectionId: string, tenantId: string, path: string): Promise<void>;
|
|
84
111
|
/** Move / rename a file */
|
|
85
|
-
moveFile(collectionId: string, tenantId: string, path: string,
|
|
112
|
+
moveFile(collectionId: string, tenantId: string, path: string, payload: FileMovePayload): Promise<void>;
|
|
86
113
|
/** List commits with pagination */
|
|
87
114
|
listCommits(collectionId: string, tenantId: string, page?: number, perPage?: number): Promise<CommitList>;
|
|
88
115
|
/** Commit detail with per-file diffs and snapshots */
|
|
89
116
|
getCommitDetail(collectionId: string, tenantId: string, sha: string): Promise<CommitDetail>;
|
|
90
117
|
/** Revert a commit */
|
|
91
|
-
revertCommit(collectionId: string, tenantId: string, sha: string,
|
|
118
|
+
revertCommit(collectionId: string, tenantId: string, sha: string, payload: CommitRevertPayload): Promise<void>;
|
|
92
119
|
}
|
|
93
120
|
//# 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,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1B,IAAI,EAAE,WAAW,CAAC;CACnB;AAED,MAAM,MAAM,QAAQ,GAAG,YAAY,GAAG,iBAAiB,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,
|
|
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,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1B,IAAI,EAAE,WAAW,CAAC;CACnB;AAED,MAAM,MAAM,QAAQ,GAAG,YAAY,GAAG,iBAAiB,CAAC;AAExD;;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,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,EAAE,MAAM,CAAC;CACjB;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,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMzE,2CAA2C;IACrC,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAMjF,wBAAwB;IAClB,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAMhG,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,GAAG,OAAO,CAAC,IAAI,CAAC;IAMrF,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,GACpB,OAAO,CAAC,UAAU,CAAC;IAWtB,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;CAKrH"}
|
package/dist/index.js
CHANGED
|
@@ -29,7 +29,7 @@ export class GitHTTPFSClient {
|
|
|
29
29
|
/**
|
|
30
30
|
* Helper to handle requests and parse JSON responses.
|
|
31
31
|
*/
|
|
32
|
-
async request(path, method,
|
|
32
|
+
async request(path, method, payload, params) {
|
|
33
33
|
const url = new URL(`${this.baseUrl}/${VERSION}/${path}`);
|
|
34
34
|
// Append query parameters
|
|
35
35
|
if (params) {
|
|
@@ -39,8 +39,8 @@ export class GitHTTPFSClient {
|
|
|
39
39
|
method,
|
|
40
40
|
headers: this.headers
|
|
41
41
|
};
|
|
42
|
-
if (
|
|
43
|
-
options.body = JSON.stringify(
|
|
42
|
+
if (payload && method !== GET) {
|
|
43
|
+
options.body = JSON.stringify(payload);
|
|
44
44
|
}
|
|
45
45
|
const response = await fetch(url.toString(), options);
|
|
46
46
|
if (!response.ok) {
|
|
@@ -63,16 +63,16 @@ export class GitHTTPFSClient {
|
|
|
63
63
|
return this.request(`${collectionId}/${tenantId}/files/${path}`, GET);
|
|
64
64
|
}
|
|
65
65
|
/** Create or update a file */
|
|
66
|
-
async
|
|
67
|
-
return this.request(`${collectionId}/${tenantId}/files/${path}`, PUT,
|
|
66
|
+
async writeFile(collectionId, tenantId, path, payload) {
|
|
67
|
+
return this.request(`${collectionId}/${tenantId}/files/${path}`, PUT, payload);
|
|
68
68
|
}
|
|
69
69
|
/** Delete a file */
|
|
70
70
|
async deleteFile(collectionId, tenantId, path) {
|
|
71
71
|
return this.request(`${collectionId}/${tenantId}/files/${path}`, DELETE);
|
|
72
72
|
}
|
|
73
73
|
/** Move / rename a file */
|
|
74
|
-
async moveFile(collectionId, tenantId, path,
|
|
75
|
-
return this.request(`${collectionId}/${tenantId}/files/${path}/move`, POST,
|
|
74
|
+
async moveFile(collectionId, tenantId, path, payload) {
|
|
75
|
+
return this.request(`${collectionId}/${tenantId}/files/${path}/move`, POST, payload);
|
|
76
76
|
}
|
|
77
77
|
// --- Commit Operations ---
|
|
78
78
|
/** List commits with pagination */
|
|
@@ -88,8 +88,8 @@ export class GitHTTPFSClient {
|
|
|
88
88
|
return this.request(`${collectionId}/${tenantId}/commits/${sha}`, GET);
|
|
89
89
|
}
|
|
90
90
|
/** Revert a commit */
|
|
91
|
-
async revertCommit(collectionId, tenantId, sha,
|
|
92
|
-
return this.request(`${collectionId}/${tenantId}/commits/${sha}/revert`, POST,
|
|
91
|
+
async revertCommit(collectionId, tenantId, sha, payload) {
|
|
92
|
+
return this.request(`${collectionId}/${tenantId}/commits/${sha}/revert`, POST, payload);
|
|
93
93
|
}
|
|
94
94
|
}
|
|
95
95
|
//# 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;AAwGH,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,OAAa,EACb,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,OAAO,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YAC9B,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,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,YAAoB,EAAE,QAAgB;QACvD,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,YAAY,IAAI,QAAQ,EAAE,EAAE,MAAM,CACtC,CAAC;IACJ,CAAC;IAED,2CAA2C;IAC3C,KAAK,CAAC,SAAS,CAAC,YAAoB,EAAE,QAAgB;QACpD,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,YAAY,IAAI,QAAQ,QAAQ,EAAE,GAAG,CACzC,CAAC;IACJ,CAAC;IAED,wBAAwB;IACxB,KAAK,CAAC,cAAc,CAAC,YAAoB,EAAE,QAAgB,EAAE,IAAY;QACvE,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,YAAY,IAAI,QAAQ,UAAU,IAAI,EAAE,EAAE,GAAG,CACjD,CAAC;IACJ,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;QACnE,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,YAAY,IAAI,QAAQ,UAAU,IAAI,EAAE,EAAE,MAAM,CACpD,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;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,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;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.7",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"homepage": "https://github.com/crisp-oss/node-githttp-fs-client",
|
|
7
7
|
"license": "MIT",
|