@hamak/ui-remote-fs 0.9.3 → 0.9.4
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/impl/plugin/remote-fs-plugin-factory.d.ts +6 -0
- package/dist/impl/plugin/remote-fs-plugin-factory.d.ts.map +1 -1
- package/dist/impl/plugin/remote-fs-plugin-factory.js +1 -0
- package/dist/impl/providers/http-workspace-client.d.ts +20 -2
- package/dist/impl/providers/http-workspace-client.d.ts.map +1 -1
- package/dist/impl/providers/http-workspace-client.js +22 -3
- package/dist/spi/providers/i-workspace-client.d.ts +3 -1
- package/dist/spi/providers/i-workspace-client.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -32,6 +32,12 @@ export interface RemoteFsPluginFactoryConfig {
|
|
|
32
32
|
* Default: 30000 (30 seconds)
|
|
33
33
|
*/
|
|
34
34
|
timeout?: number;
|
|
35
|
+
/**
|
|
36
|
+
* Indentation used when serializing non-string content to JSON.
|
|
37
|
+
* Set to 0 for minified output.
|
|
38
|
+
* Default: 2
|
|
39
|
+
*/
|
|
40
|
+
jsonIndent?: number;
|
|
35
41
|
/**
|
|
36
42
|
* Whether to automatically reload file content after PUT/POST
|
|
37
43
|
* Default: true
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"remote-fs-plugin-factory.d.ts","sourceRoot":"","sources":["../../../src/impl/plugin/remote-fs-plugin-factory.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAKnD,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAkB,MAAM,WAAW,CAAC;AAU9E;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,GAAG,CAAC;IAEzC;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAEhC;;OAEG;IACH,oBAAoB,CAAC,EAAE,eAAe,CAAC;CACxC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,2BAA2B,GAAG,YAAY,
|
|
1
|
+
{"version":3,"file":"remote-fs-plugin-factory.d.ts","sourceRoot":"","sources":["../../../src/impl/plugin/remote-fs-plugin-factory.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAKnD,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAkB,MAAM,WAAW,CAAC;AAU9E;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,GAAG,CAAC;IAEzC;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAEhC;;OAEG;IACH,oBAAoB,CAAC,EAAE,eAAe,CAAC;CACxC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,2BAA2B,GAAG,YAAY,CA0ItF;AAED,eAAe,oBAAoB,CAAC"}
|
|
@@ -56,6 +56,7 @@ export function createRemoteFsPlugin(config) {
|
|
|
56
56
|
workspaceId: config.workspaceId,
|
|
57
57
|
baseUrl: config.baseUrl,
|
|
58
58
|
timeout: config.timeout,
|
|
59
|
+
jsonIndent: config.jsonIndent,
|
|
59
60
|
};
|
|
60
61
|
workspaceClient = new HttpWorkspaceClient(clientConfig);
|
|
61
62
|
log('Created HTTP workspace client', { baseUrl: config.baseUrl, workspaceId: config.workspaceId });
|
|
@@ -29,6 +29,17 @@ export interface HttpWorkspaceClientConfig {
|
|
|
29
29
|
* Custom axios instance (for advanced configuration)
|
|
30
30
|
*/
|
|
31
31
|
axiosInstance?: AxiosInstance;
|
|
32
|
+
/**
|
|
33
|
+
* Indentation used when serializing non-string content to JSON.
|
|
34
|
+
*
|
|
35
|
+
* Files written through this client are ordinary files on the server's disk:
|
|
36
|
+
* they get hand-edited and reviewed as diffs, so the default is pretty-printed
|
|
37
|
+
* (2 spaces) rather than minified. Set to `0` to restore the previous minified
|
|
38
|
+
* output — only useful when something downstream byte-compares payloads.
|
|
39
|
+
*
|
|
40
|
+
* Default: 2
|
|
41
|
+
*/
|
|
42
|
+
jsonIndent?: number;
|
|
32
43
|
}
|
|
33
44
|
/**
|
|
34
45
|
* HTTP-based implementation of IWorkspaceClient
|
|
@@ -50,6 +61,7 @@ export declare class HttpWorkspaceClient implements IWorkspaceClient {
|
|
|
50
61
|
private readonly workspaceId;
|
|
51
62
|
private readonly baseUrl;
|
|
52
63
|
private readonly axios;
|
|
64
|
+
private readonly jsonIndent;
|
|
53
65
|
constructor(config: HttpWorkspaceClientConfig);
|
|
54
66
|
/**
|
|
55
67
|
* Format path segments to URL path string
|
|
@@ -64,7 +76,13 @@ export declare class HttpWorkspaceClient implements IWorkspaceClient {
|
|
|
64
76
|
*/
|
|
65
77
|
private handleError;
|
|
66
78
|
/**
|
|
67
|
-
* Serialize content to string for transmission
|
|
79
|
+
* Serialize content to string for transmission.
|
|
80
|
+
*
|
|
81
|
+
* Strings pass through verbatim — this client also carries non-JSON files.
|
|
82
|
+
* Everything else is pretty-printed, because the string produced here is what
|
|
83
|
+
* the server writes to disk byte for byte: minifying it would collapse a
|
|
84
|
+
* human-authored file onto one line on every save. Use `jsonIndent` to change
|
|
85
|
+
* the indentation.
|
|
68
86
|
*/
|
|
69
87
|
private serializeContent;
|
|
70
88
|
/**
|
|
@@ -99,5 +117,5 @@ export declare class HttpWorkspaceClient implements IWorkspaceClient {
|
|
|
99
117
|
/**
|
|
100
118
|
* Factory function to create HTTP workspace client with default configuration
|
|
101
119
|
*/
|
|
102
|
-
export declare function createHttpWorkspaceClient(workspaceId: string, baseUrl?: string): HttpWorkspaceClient;
|
|
120
|
+
export declare function createHttpWorkspaceClient(workspaceId: string, baseUrl?: string, options?: Omit<HttpWorkspaceClientConfig, 'workspaceId' | 'baseUrl'>): HttpWorkspaceClient;
|
|
103
121
|
//# sourceMappingURL=http-workspace-client.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"http-workspace-client.d.ts","sourceRoot":"","sources":["../../../src/impl/providers/http-workspace-client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAAE,aAAa,EAAc,MAAM,OAAO,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAG/C;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"http-workspace-client.d.ts","sourceRoot":"","sources":["../../../src/impl/providers/http-workspace-client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAAE,aAAa,EAAc,MAAM,OAAO,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAG/C;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,mBAAoB,YAAW,gBAAgB;IAC1D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;gBAExB,MAAM,EAAE,yBAAyB;IAoB7C;;OAEG;IACH,OAAO,CAAC,UAAU;IAIlB;;OAEG;IACH,OAAO,CAAC,QAAQ;IAmBhB;;OAEG;IACH,OAAO,CAAC,WAAW;IA6BnB;;;;;;;;OAQG;IACH,OAAO,CAAC,gBAAgB;IAYxB;;OAEG;IACG,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAc9E;;OAEG;IACG,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAclF;;OAEG;IACG,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAc3E;;OAEG;IACG,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAexF;;OAEG;IACG,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAc7E;;OAEG;IACH,cAAc,IAAI,MAAM;IAIxB;;OAEG;IACH,UAAU,IAAI,MAAM;CAGrB;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CACvC,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,IAAI,CAAC,yBAAyB,EAAE,aAAa,GAAG,SAAS,CAAC,GACnE,mBAAmB,CAMrB"}
|
|
@@ -41,7 +41,14 @@ export class HttpWorkspaceClient {
|
|
|
41
41
|
writable: true,
|
|
42
42
|
value: void 0
|
|
43
43
|
});
|
|
44
|
+
Object.defineProperty(this, "jsonIndent", {
|
|
45
|
+
enumerable: true,
|
|
46
|
+
configurable: true,
|
|
47
|
+
writable: true,
|
|
48
|
+
value: void 0
|
|
49
|
+
});
|
|
44
50
|
this.workspaceId = config.workspaceId;
|
|
51
|
+
this.jsonIndent = config.jsonIndent ?? 2;
|
|
45
52
|
// Default base URL to current origin if not provided
|
|
46
53
|
this.baseUrl = config.baseUrl ||
|
|
47
54
|
(typeof globalThis !== 'undefined' && 'location' in globalThis
|
|
@@ -112,13 +119,24 @@ export class HttpWorkspaceClient {
|
|
|
112
119
|
throw errorObj;
|
|
113
120
|
}
|
|
114
121
|
/**
|
|
115
|
-
* Serialize content to string for transmission
|
|
122
|
+
* Serialize content to string for transmission.
|
|
123
|
+
*
|
|
124
|
+
* Strings pass through verbatim — this client also carries non-JSON files.
|
|
125
|
+
* Everything else is pretty-printed, because the string produced here is what
|
|
126
|
+
* the server writes to disk byte for byte: minifying it would collapse a
|
|
127
|
+
* human-authored file onto one line on every save. Use `jsonIndent` to change
|
|
128
|
+
* the indentation.
|
|
116
129
|
*/
|
|
117
130
|
serializeContent(content) {
|
|
118
131
|
if (typeof content === 'string') {
|
|
119
132
|
return content;
|
|
120
133
|
}
|
|
121
|
-
|
|
134
|
+
if (content === undefined) {
|
|
135
|
+
// JSON.stringify(undefined) is undefined, not a string. Write an empty
|
|
136
|
+
// file instead, which reads back as undefined and so round-trips.
|
|
137
|
+
return '';
|
|
138
|
+
}
|
|
139
|
+
return JSON.stringify(content, null, this.jsonIndent);
|
|
122
140
|
}
|
|
123
141
|
/**
|
|
124
142
|
* List files and directories at the specified path
|
|
@@ -207,9 +225,10 @@ export class HttpWorkspaceClient {
|
|
|
207
225
|
/**
|
|
208
226
|
* Factory function to create HTTP workspace client with default configuration
|
|
209
227
|
*/
|
|
210
|
-
export function createHttpWorkspaceClient(workspaceId, baseUrl) {
|
|
228
|
+
export function createHttpWorkspaceClient(workspaceId, baseUrl, options) {
|
|
211
229
|
return new HttpWorkspaceClient({
|
|
212
230
|
workspaceId,
|
|
213
231
|
baseUrl,
|
|
232
|
+
...options,
|
|
214
233
|
});
|
|
215
234
|
}
|
|
@@ -74,7 +74,9 @@ export interface IWorkspaceClient {
|
|
|
74
74
|
* Write or update a file's content (uses PUT method)
|
|
75
75
|
*
|
|
76
76
|
* @param path - Array of path segments to the file
|
|
77
|
-
* @param content - Content to write
|
|
77
|
+
* @param content - Content to write. Strings are sent verbatim; anything else
|
|
78
|
+
* is serialized to pretty-printed JSON, since the result is written to disk
|
|
79
|
+
* as-is and read by humans.
|
|
78
80
|
* @param options - Optional request options (query params, etc.)
|
|
79
81
|
* @returns Promise resolving to FileInfo of the written file
|
|
80
82
|
* @throws Error if the operation fails
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"i-workspace-client.d.ts","sourceRoot":"","sources":["../../../src/spi/providers/i-workspace-client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC,CAAC;CAChF;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;OAOG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAEzE;;;;;;;OAOG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE7E;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEtE
|
|
1
|
+
{"version":3,"file":"i-workspace-client.d.ts","sourceRoot":"","sources":["../../../src/spi/providers/i-workspace-client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC,CAAC;CAChF;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;OAOG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAEzE;;;;;;;OAOG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE7E;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEtE;;;;;;;;;;OAUG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEnF;;;;;;;OAOG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CACzE;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,KAAK,gBAAgB,CAAC"}
|