@dimah-s3/react 2.0.0-beta.2 → 2.0.0-beta.3

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.
@@ -53,8 +53,9 @@ export type UseObjectListReturn<TItem> = {
53
53
  /** Change the search text. Reloads the first page. Debounce it yourself. */
54
54
  setSearch: (search: string) => void;
55
55
  /**
56
- * Edit the loaded files without a request, for example after a rename.
57
- * The next reload replaces them.
56
+ * Edit the loaded files without a request, for example after your own
57
+ * update. The next reload replaces them. Prefer `renameFile` when the
58
+ * source can rename.
58
59
  */
59
60
  setItems: (items: Updater<readonly TItem[]>) => void;
60
61
  /** Edit the loaded folders without a request. */
@@ -73,6 +74,19 @@ export type UseObjectListReturn<TItem> = {
73
74
  * `createFolder`.
74
75
  */
75
76
  createFolder: ((name: string) => Promise<ObjectListFolder>) | undefined;
77
+ /**
78
+ * Renames a file through the source and replaces the loaded row.
79
+ * Rejects with an `APIError`. The same name does nothing. A name sort
80
+ * or a search reloads afterwards, and so does a source that returns
81
+ * nothing. Set when the source has `renameFile`.
82
+ */
83
+ renameFile: ((item: TItem, name: string) => Promise<TItem | void>) | undefined;
84
+ /**
85
+ * Renames a folder through the source, replaces the loaded row, and
86
+ * updates that id in the breadcrumb. Rejects with an `APIError`. The
87
+ * same name does nothing. Set when the source has `renameFolder`.
88
+ */
89
+ renameFolder: ((folder: ObjectListFolder, name: string) => Promise<ObjectListFolder | void>) | undefined;
76
90
  };
77
91
  /**
78
92
  * Page through a folder catalog without knowing the backend.
@@ -1 +1 @@
1
- {"version":3,"file":"use-object-list.d.ts","sourceRoot":"","sources":["../../src/hooks/use-object-list.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAI/C,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,eAAe,EACf,oBAAoB,EACrB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAE3D,YAAY,EACV,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,gBAAgB,EAChB,qBAAqB,EACrB,cAAc,EACd,eAAe,EACf,oBAAoB,EACpB,cAAc,EACd,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,oBAAoB,GACrB,MAAM,cAAc,CAAC;AAItB,qDAAqD;AACrD,KAAK,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;AAE1C,4DAA4D;AAC5D,MAAM,MAAM,mBAAmB,CAAC,KAAK,IAAI;IACvC,iEAAiE;IACjE,OAAO,EAAE,SAAS,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;IAC3C,KAAK,EAAE,SAAS,KAAK,EAAE,CAAC;IACxB,gDAAgD;IAChD,OAAO,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACrC,yCAAyC;IACzC,KAAK,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACnC,0CAA0C;IAC1C,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;IAC5B,2DAA2D;IAC3D,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,KAAK,EAAE,eAAe,GAAG,IAAI,CAAC;IAC9B,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAC;IACvB,MAAM,EAAE,gBAAgB,CAAC;IACzB,2EAA2E;IAC3E,SAAS,EAAE,OAAO,CAAC;IACnB,4EAA4E;IAC5E,YAAY,EAAE,OAAO,CAAC;IACtB,4CAA4C;IAC5C,aAAa,EAAE,OAAO,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,sEAAsE;IACtE,QAAQ,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B;;;OAGG;IACH,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,kEAAkE;IAClE,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,mDAAmD;IACnD,UAAU,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC/C,gDAAgD;IAChD,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,gBAAgB,EAAE,KAAK,IAAI,CAAC;IACvD,uEAAuE;IACvE,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,gDAAgD;IAChD,OAAO,EAAE,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,KAAK,IAAI,CAAC;IAC/C,4EAA4E;IAC5E,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC;;;OAGG;IACH,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,SAAS,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;IACrD,iDAAiD;IACjD,UAAU,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,gBAAgB,EAAE,CAAC,KAAK,IAAI,CAAC;IACpE,qCAAqC;IACrC,WAAW,EAAE,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,KAAK,IAAI,CAAC;IAC/C,2BAA2B;IAC3B,MAAM,EAAE,CAAC,IAAI,EAAE,KAAK,KAAK,MAAM,CAAC;IAChC,yDAAyD;IACzD,OAAO,EAAE,CAAC,IAAI,EAAE,KAAK,KAAK,cAAc,CAAC;IACzC,yEAAyE;IACzE,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,KAAK,oBAAoB,CAAC,GAAG,SAAS,CAAC;IAC7E;;;;OAIG;IACH,YAAY,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC,GAAG,SAAS,CAAC;CACzE,CAAC;AAgDF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,aAAa,CAAC,KAAK,EACjC,OAAO,EAAE,oBAAoB,CAAC,KAAK,CAAC,GACnC,mBAAmB,CAAC,KAAK,CAAC,CAuX5B"}
1
+ {"version":3,"file":"use-object-list.d.ts","sourceRoot":"","sources":["../../src/hooks/use-object-list.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAI/C,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,eAAe,EACf,oBAAoB,EACrB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAE3D,YAAY,EACV,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,gBAAgB,EAChB,qBAAqB,EACrB,cAAc,EACd,eAAe,EACf,oBAAoB,EACpB,cAAc,EACd,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,oBAAoB,GACrB,MAAM,cAAc,CAAC;AAItB,qDAAqD;AACrD,KAAK,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;AAE1C,4DAA4D;AAC5D,MAAM,MAAM,mBAAmB,CAAC,KAAK,IAAI;IACvC,iEAAiE;IACjE,OAAO,EAAE,SAAS,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;IAC3C,KAAK,EAAE,SAAS,KAAK,EAAE,CAAC;IACxB,gDAAgD;IAChD,OAAO,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACrC,yCAAyC;IACzC,KAAK,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACnC,0CAA0C;IAC1C,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;IAC5B,2DAA2D;IAC3D,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,KAAK,EAAE,eAAe,GAAG,IAAI,CAAC;IAC9B,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAC;IACvB,MAAM,EAAE,gBAAgB,CAAC;IACzB,2EAA2E;IAC3E,SAAS,EAAE,OAAO,CAAC;IACnB,4EAA4E;IAC5E,YAAY,EAAE,OAAO,CAAC;IACtB,4CAA4C;IAC5C,aAAa,EAAE,OAAO,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,sEAAsE;IACtE,QAAQ,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B;;;OAGG;IACH,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,kEAAkE;IAClE,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,mDAAmD;IACnD,UAAU,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC/C,gDAAgD;IAChD,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,gBAAgB,EAAE,KAAK,IAAI,CAAC;IACvD,uEAAuE;IACvE,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,gDAAgD;IAChD,OAAO,EAAE,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,KAAK,IAAI,CAAC;IAC/C,4EAA4E;IAC5E,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC;;;;OAIG;IACH,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,SAAS,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;IACrD,iDAAiD;IACjD,UAAU,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,gBAAgB,EAAE,CAAC,KAAK,IAAI,CAAC;IACpE,qCAAqC;IACrC,WAAW,EAAE,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,KAAK,IAAI,CAAC;IAC/C,2BAA2B;IAC3B,MAAM,EAAE,CAAC,IAAI,EAAE,KAAK,KAAK,MAAM,CAAC;IAChC,yDAAyD;IACzD,OAAO,EAAE,CAAC,IAAI,EAAE,KAAK,KAAK,cAAc,CAAC;IACzC,yEAAyE;IACzE,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,KAAK,oBAAoB,CAAC,GAAG,SAAS,CAAC;IAC7E;;;;OAIG;IACH,YAAY,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC,GAAG,SAAS,CAAC;IACxE;;;;;OAKG;IACH,UAAU,EACR,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,GAAG,SAAS,CAAC;IACrE;;;;OAIG;IACH,YAAY,EACR,CAAC,CACC,MAAM,EAAE,gBAAgB,EACxB,IAAI,EAAE,MAAM,KACT,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC,GACtC,SAAS,CAAC;CACf,CAAC;AAgDF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,aAAa,CAAC,KAAK,EACjC,OAAO,EAAE,oBAAoB,CAAC,KAAK,CAAC,GACnC,mBAAmB,CAAC,KAAK,CAAC,CAyd5B"}
package/dist/index.js CHANGED
@@ -2156,6 +2156,96 @@ function useObjectList(options) {
2156
2156
  },
2157
2157
  [optionsRef, requestRef, update]
2158
2158
  );
2159
+ const settleRename = useCallback(
2160
+ async (scope, replaced) => {
2161
+ if (requestRef.current.scope !== scope) return;
2162
+ if (!replaced || namesNeedReload(requestRef.current)) {
2163
+ await run("refresh");
2164
+ }
2165
+ },
2166
+ [requestRef, run]
2167
+ );
2168
+ const renameFile = useCallback(
2169
+ async (item, name) => {
2170
+ const rename = optionsRef.current.renameFile;
2171
+ if (!rename) {
2172
+ throw new Error("[dimah-s3] The source has no renameFile.");
2173
+ }
2174
+ const { getFile: read, getKey: keyOf } = optionsRef.current;
2175
+ if ((read ? read(item).name : keyOf(item)) === name) return item;
2176
+ const key = keyOf(item);
2177
+ const { scope } = requestRef.current;
2178
+ let next;
2179
+ try {
2180
+ next = await rename({ item, name });
2181
+ } catch (err) {
2182
+ throw toClientError(err);
2183
+ }
2184
+ if (next) {
2185
+ const replacement = next;
2186
+ update((draft) => {
2187
+ if (draft.snapshot.scope !== scope) return draft;
2188
+ const idOf = optionsRef.current.getKey;
2189
+ return {
2190
+ ...draft,
2191
+ snapshot: {
2192
+ ...draft.snapshot,
2193
+ items: draft.snapshot.items.map(
2194
+ (current) => idOf(current) === key ? replacement : current
2195
+ )
2196
+ }
2197
+ };
2198
+ });
2199
+ }
2200
+ await settleRename(scope, next != null);
2201
+ return next;
2202
+ },
2203
+ [optionsRef, requestRef, settleRename, update]
2204
+ );
2205
+ const renameFolder = useCallback(
2206
+ async (folder, name) => {
2207
+ const rename = optionsRef.current.renameFolder;
2208
+ if (!rename) {
2209
+ throw new Error("[dimah-s3] The source has no renameFolder.");
2210
+ }
2211
+ if (folder.name === name) return folder;
2212
+ const { scope } = requestRef.current;
2213
+ let next;
2214
+ try {
2215
+ next = await rename({ folder, name });
2216
+ } catch (err) {
2217
+ throw toClientError(err);
2218
+ }
2219
+ if (next) {
2220
+ const replacement = next;
2221
+ update((draft) => {
2222
+ if (draft.snapshot.scope !== scope) return draft;
2223
+ return {
2224
+ ...draft,
2225
+ snapshot: {
2226
+ ...draft.snapshot,
2227
+ folders: draft.snapshot.folders.map(
2228
+ (current) => current.id === folder.id ? replacement : current
2229
+ )
2230
+ }
2231
+ };
2232
+ });
2233
+ const currentTrail = trailRef.current;
2234
+ if (currentTrail.some(
2235
+ (entry) => entry.id === folder.id && entry.name !== replacement.name
2236
+ )) {
2237
+ const renamedTrail = currentTrail.map(
2238
+ (entry) => entry.id === folder.id ? { ...entry, name: replacement.name } : entry
2239
+ );
2240
+ trailRef.current = renamedTrail;
2241
+ setTrailState(renamedTrail);
2242
+ }
2243
+ }
2244
+ await settleRename(scope, next != null);
2245
+ return next;
2246
+ },
2247
+ [optionsRef, requestRef, settleRename, trailRef, update]
2248
+ );
2159
2249
  const setSort = useCallback(
2160
2250
  (next) => setSortValue(next),
2161
2251
  [setSortValue]
@@ -2218,7 +2308,9 @@ function useObjectList(options) {
2218
2308
  getKey,
2219
2309
  getFile,
2220
2310
  uploadOptions: options.uploadOptions,
2221
- createFolder: options.createFolder ? createFolder : void 0
2311
+ createFolder: options.createFolder ? createFolder : void 0,
2312
+ renameFile: options.renameFile ? renameFile : void 0,
2313
+ renameFolder: options.renameFolder ? renameFolder : void 0
2222
2314
  };
2223
2315
  }
2224
2316
  function readStatus({
@@ -2236,6 +2328,9 @@ function readStatus({
2236
2328
  if (pending === "refresh") return hasRows ? "refreshing" : "loading";
2237
2329
  return failure ? "error" : "ready";
2238
2330
  }
2331
+ function namesNeedReload(request) {
2332
+ return request.sort?.field === "name" || request.search !== "";
2333
+ }
2239
2334
  function sortsEqual(a, b) {
2240
2335
  return a === b || a?.field === b?.field && a?.direction === b?.direction;
2241
2336
  }