@edgestore/react 0.1.3-alpha.2 → 0.1.3-alpha.3

package/dist/createNextProxy.d.ts

@@ -1,6 +1,13 @@
 /// <reference types="react" />
 import { type AnyRouter, type InferBucketPathObject, type InferMetadataObject } from '@edgestore/server/core';
 import { type z } from 'zod';
+/**
+ * @internal
+ * @see https://www.totaltypescript.com/concepts/the-prettify-helper
+ */
+export type Prettify<TType> = {
+    [K in keyof TType]: TType[K];
+} & {};
 export type BucketFunctions<TRouter extends AnyRouter> = {
     [K in keyof TRouter['buckets']]: {
         upload: (params: z.infer<TRouter['buckets'][K]['_def']['input']> extends never ? {
@@ -19,12 +26,14 @@ export type BucketFunctions<TRouter extends AnyRouter> = {
             uploadedAt: Date;
             metadata: InferMetadataObject<TRouter['buckets'][K]>;
             path: InferBucketPathObject<TRouter['buckets'][K]>;
+            pathOrder: Prettify<keyof InferBucketPathObject<TRouter['buckets'][K]>>[];
         } : {
             url: string;
             size: number;
             uploadedAt: Date;
             metadata: InferMetadataObject<TRouter['buckets'][K]>;
             path: InferBucketPathObject<TRouter['buckets'][K]>;
+            pathOrder: Prettify<keyof InferBucketPathObject<TRouter['buckets'][K]>>[];
         }>;
         confirmUpload: (params: {
             url: string;

package/dist/createNextProxy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createNextProxy.d.ts","sourceRoot":"","sources":["../src/createNextProxy.ts"],"names":[],"mappings":";AACA,OAAO,EACL,KAAK,SAAS,EACd,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACzB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAC;AAG7B,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,SAAS,IAAI;KACtD,CAAC,IAAI,MAAM,OAAO,CAAC,SAAS,CAAC,GAAG;QAC/B,MAAM,EAAE,CACN,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,KAAK,GACjE;YACE,IAAI,EAAE,IAAI,CAAC;YACX,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;YAC3C,OAAO,CAAC,EAAE,aAAa,CAAC;SACzB,GACD;YACE,IAAI,EAAE,IAAI,CAAC;YACX,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;YACvD,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;YAC3C,OAAO,CAAC,EAAE,aAAa,CAAC;SACzB,KACF,OAAO,CACV,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,SAAS,OAAO,GACjD;YACE,GAAG,EAAE,MAAM,CAAC;YACZ,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;YAC5B,IAAI,EAAE,MAAM,CAAC;YACb,UAAU,EAAE,IAAI,CAAC;YACjB,QAAQ,EAAE,mBAAmB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACrD,IAAI,EAAE,qBAAqB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACpD,GACD;YACE,GAAG,EAAE,MAAM,CAAC;YACZ,IAAI,EAAE,MAAM,CAAC;YACb,UAAU,EAAE,IAAI,CAAC;YACjB,QAAQ,EAAE,mBAAmB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACrD,IAAI,EAAE,qBAAqB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACpD,CACN,CAAC;QACF,aAAa,EAAE,CAAC,MAAM,EAAE;YAAE,GAAG,EAAE,MAAM,CAAA;SAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,EAAE,CAAC,MAAM,EAAE;YAAE,GAAG,EAAE,MAAM,CAAA;SAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;KACpD;CACF,CAAC;AAEF,KAAK,uBAAuB,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;AAE1D,KAAK,aAAa,GAAG;IACnB;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,wBAAgB,eAAe,CAAC,OAAO,SAAS,SAAS,EAAE,EACzD,OAAO,EACP,iBAAiB,EACjB,oBAAwB,GACzB,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAClD,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,4BA6CA"}
+{"version":3,"file":"createNextProxy.d.ts","sourceRoot":"","sources":["../src/createNextProxy.ts"],"names":[],"mappings":";AACA,OAAO,EACL,KAAK,SAAS,EACd,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACzB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAC;AAG7B;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,KAAK,IAAI;KAC3B,CAAC,IAAI,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC;CAE7B,GAAG,EAAE,CAAC;AAEP,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,SAAS,IAAI;KACtD,CAAC,IAAI,MAAM,OAAO,CAAC,SAAS,CAAC,GAAG;QAC/B,MAAM,EAAE,CACN,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,KAAK,GACjE;YACE,IAAI,EAAE,IAAI,CAAC;YACX,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;YAC3C,OAAO,CAAC,EAAE,aAAa,CAAC;SACzB,GACD;YACE,IAAI,EAAE,IAAI,CAAC;YACX,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;YACvD,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;YAC3C,OAAO,CAAC,EAAE,aAAa,CAAC;SACzB,KACF,OAAO,CACV,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,SAAS,OAAO,GACjD;YACE,GAAG,EAAE,MAAM,CAAC;YACZ,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;YAC5B,IAAI,EAAE,MAAM,CAAC;YACb,UAAU,EAAE,IAAI,CAAC;YACjB,QAAQ,EAAE,mBAAmB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACrD,IAAI,EAAE,qBAAqB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACnD,SAAS,EAAE,QAAQ,CACjB,MAAM,qBAAqB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CACnD,EAAE,CAAC;SACL,GACD;YACE,GAAG,EAAE,MAAM,CAAC;YACZ,IAAI,EAAE,MAAM,CAAC;YACb,UAAU,EAAE,IAAI,CAAC;YACjB,QAAQ,EAAE,mBAAmB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACrD,IAAI,EAAE,qBAAqB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACnD,SAAS,EAAE,QAAQ,CACjB,MAAM,qBAAqB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CACnD,EAAE,CAAC;SACL,CACN,CAAC;QACF,aAAa,EAAE,CAAC,MAAM,EAAE;YAAE,GAAG,EAAE,MAAM,CAAA;SAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,EAAE,CAAC,MAAM,EAAE;YAAE,GAAG,EAAE,MAAM,CAAA;SAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;KACpD;CACF,CAAC;AAEF,KAAK,uBAAuB,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;AAE1D,KAAK,aAAa,GAAG;IACnB;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,wBAAgB,eAAe,CAAC,OAAO,SAAS,SAAS,EAAE,EACzD,OAAO,EACP,iBAAiB,EACjB,oBAAwB,GACzB,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAClD,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,4BA6CA"}

package/dist/index.js

@@ -117,6 +117,7 @@ async function uploadFile({ file, input, onProgressChange, options }, { apiPath,
             size: json.size,
             uploadedAt: new Date(json.uploadedAt),
             path: json.path,
+            pathOrder: json.pathOrder,
             metadata: json.metadata
         };
     } catch (e) {

package/dist/index.mjs

@@ -93,6 +93,7 @@ async function uploadFile({ file, input, onProgressChange, options }, { apiPath,
             size: json.size,
             uploadedAt: new Date(json.uploadedAt),
             path: json.path,
+            pathOrder: json.pathOrder,
             metadata: json.metadata
         };
     } catch (e) {

package/dist/utils/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This will add the necessary query param to the url
+ * to make the browser download the file instead of opening it.
+ *
+ * You can also override the name of the file by passing the name param.
+ */
+export declare function getDownloadUrl(url: string, name?: string): string;
+/**
+ * This will format the file size to a human readable format.
+ *
+ * @example 1024 => 1 KB
+ */
+export declare function formatFileSize(bytes?: number): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,UAIxD;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,UAa5C"}

package/dist/utils/index.js

@@ -0,0 +1,45 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * This will add the necessary query param to the url
+ * to make the browser download the file instead of opening it.
+ *
+ * You can also override the name of the file by passing the name param.
+ */ function getDownloadUrl(url, name) {
+    const urlObj = new URL(url);
+    urlObj.searchParams.set('download', name ?? 'true');
+    return urlObj.toString();
+}
+/**
+ * This will format the file size to a human readable format.
+ *
+ * @example 1024 => 1 KB
+ */ function formatFileSize(bytes) {
+    if (!bytes) {
+        return '0 Bytes';
+    }
+    bytes = Number(bytes);
+    if (bytes === 0) {
+        return '0 Bytes';
+    }
+    const k = 1024;
+    const dm = 2;
+    const sizes = [
+        'Bytes',
+        'KB',
+        'MB',
+        'GB',
+        'TB',
+        'PB',
+        'EB',
+        'ZB',
+        'YB'
+    ];
+    const i = Math.floor(Math.log(bytes) / Math.log(k));
+    return `${parseFloat((bytes / Math.pow(k, i)).toFixed(dm))} ${sizes[i]}`;
+}
+
+exports.formatFileSize = formatFileSize;
+exports.getDownloadUrl = getDownloadUrl;

package/dist/utils/index.mjs

@@ -0,0 +1,40 @@
+/**
+ * This will add the necessary query param to the url
+ * to make the browser download the file instead of opening it.
+ *
+ * You can also override the name of the file by passing the name param.
+ */ function getDownloadUrl(url, name) {
+    const urlObj = new URL(url);
+    urlObj.searchParams.set('download', name ?? 'true');
+    return urlObj.toString();
+}
+/**
+ * This will format the file size to a human readable format.
+ *
+ * @example 1024 => 1 KB
+ */ function formatFileSize(bytes) {
+    if (!bytes) {
+        return '0 Bytes';
+    }
+    bytes = Number(bytes);
+    if (bytes === 0) {
+        return '0 Bytes';
+    }
+    const k = 1024;
+    const dm = 2;
+    const sizes = [
+        'Bytes',
+        'KB',
+        'MB',
+        'GB',
+        'TB',
+        'PB',
+        'EB',
+        'ZB',
+        'YB'
+    ];
+    const i = Math.floor(Math.log(bytes) / Math.log(k));
+    return `${parseFloat((bytes / Math.pow(k, i)).toFixed(dm))} ${sizes[i]}`;
+}
+
+export { formatFileSize, getDownloadUrl };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edgestore/react",
-  "version": "0.1.3-alpha.2",
+  "version": "0.1.3-alpha.3",
   "description": "Upload files with ease from React/Next.js",
   "homepage": "https://edgestore.dev",
   "repository": "https://github.com/edgestorejs/edgestore.git",
@@ -31,6 +31,11 @@
       "import": "./dist/index.mjs",
       "require": "./dist/index.js",
       "default": "./dist/index.js"
+    },
+    "./utils": {
+      "import": "./dist/utils/index.mjs",
+      "require": "./dist/utils/index.js",
+      "default": "./dist/utils/index.js"
     }
   },
   "files": [
@@ -38,6 +43,7 @@
     "src",
     "README.md",
     "package.json",
+    "utils",
     "!**/*.test.*"
   ],
   "private": false,
@@ -54,14 +60,14 @@
     "uuid": "^9.0.0"
   },
   "peerDependencies": {
-    "@edgestore/server": "0.1.3-alpha.2",
+    "@edgestore/server": "0.1.3-alpha.3",
     "next": "*",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
     "zod": ">=3.0.0"
   },
   "devDependencies": {
-    "@edgestore/server": "0.1.3-alpha.2",
+    "@edgestore/server": "0.1.3-alpha.3",
     "@types/cookie": "^0.5.1",
     "@types/node": "^18.11.18",
     "@types/uuid": "^9.0.1",
@@ -71,5 +77,5 @@
     "typescript": "^5.1.6",
     "zod": "^3.21.4"
   },
-  "gitHead": "72b66cc7b82d03f2a966ef790be3ab09793aea47"
+  "gitHead": "f251931cec589c801432683521c8aa30428fa107"
 }

package/src/createNextProxy.ts

@@ -7,6 +7,15 @@ import {
 import { type z } from 'zod';
 import EdgeStoreError from './libs/errors/EdgeStoreError';
 
+/**
+ * @internal
+ * @see https://www.totaltypescript.com/concepts/the-prettify-helper
+ */
+export type Prettify<TType> = {
+  [K in keyof TType]: TType[K];
+  // eslint-disable-next-line @typescript-eslint/ban-types
+} & {};
+
 export type BucketFunctions<TRouter extends AnyRouter> = {
   [K in keyof TRouter['buckets']]: {
     upload: (
@@ -31,6 +40,9 @@ export type BucketFunctions<TRouter extends AnyRouter> = {
             uploadedAt: Date;
             metadata: InferMetadataObject<TRouter['buckets'][K]>;
             path: InferBucketPathObject<TRouter['buckets'][K]>;
+            pathOrder: Prettify<
+              keyof InferBucketPathObject<TRouter['buckets'][K]>
+            >[];
           }
         : {
             url: string;
@@ -38,6 +50,9 @@ export type BucketFunctions<TRouter extends AnyRouter> = {
             uploadedAt: Date;
             metadata: InferMetadataObject<TRouter['buckets'][K]>;
             path: InferBucketPathObject<TRouter['buckets'][K]>;
+            pathOrder: Prettify<
+              keyof InferBucketPathObject<TRouter['buckets'][K]>
+            >[];
           }
     >;
     confirmUpload: (params: { url: string }) => Promise<void>;
@@ -196,6 +211,7 @@ async function uploadFile(
       size: json.size,
       uploadedAt: new Date(json.uploadedAt),
       path: json.path as any,
+      pathOrder: json.pathOrder as any,
       metadata: json.metadata as any,
     };
   } catch (e) {

package/src/utils/index.ts

@@ -0,0 +1,31 @@
+/**
+ * This will add the necessary query param to the url
+ * to make the browser download the file instead of opening it.
+ *
+ * You can also override the name of the file by passing the name param.
+ */
+export function getDownloadUrl(url: string, name?: string) {
+  const urlObj = new URL(url);
+  urlObj.searchParams.set('download', name ?? 'true');
+  return urlObj.toString();
+}
+
+/**
+ * This will format the file size to a human readable format.
+ *
+ * @example 1024 => 1 KB
+ */
+export function formatFileSize(bytes?: number) {
+  if (!bytes) {
+    return '0 Bytes';
+  }
+  bytes = Number(bytes);
+  if (bytes === 0) {
+    return '0 Bytes';
+  }
+  const k = 1024;
+  const dm = 2;
+  const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
+  const i = Math.floor(Math.log(bytes) / Math.log(k));
+  return `${parseFloat((bytes / Math.pow(k, i)).toFixed(dm))} ${sizes[i]}`;
+}

package/utils/index.d.ts

@@ -0,0 +1 @@
+export * from '../dist/utils';

package/utils/index.js

@@ -0,0 +1 @@
+module.exports = require('../dist/utils');