@verdant-web/store 2.7.5 → 2.7.7-next.0

package/dist/cjs/files/FileStorage.js

@@ -1,105 +1,105 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.arrayBufferToBlob = exports.FileStorage = void 0;
-const IDBService_js_1 = require("../IDBService.js");
-const utils_js_1 = require("./utils.js");
-class FileStorage extends IDBService_js_1.IDBService {
-    constructor() {
-        super(...arguments);
-        this.addFile = async (file, { transaction, downloadRemote = false, } = {}) => {
-            let buffer = file.file ? await (0, utils_js_1.fileToArrayBuffer)(file.file) : undefined;
-            if (!buffer && downloadRemote && file.url) {
-                try {
-                    buffer = await fetch(file.url, {
-                        method: 'GET',
-                        credentials: 'include',
-                    }).then((r) => r.arrayBuffer());
-                }
-                catch (err) {
-                    console.error("Failed to download file to cache it locally. The file will still be available using its URL. Check the file server's CORS configuration.", err);
-                }
-            }
-            return this.run('files', (store) => {
-                return store.put({
-                    id: file.id,
-                    // IDB doesn't support boolean indexes
-                    remote: file.remote ? 'true' : 'false',
-                    deletedAt: null,
-                    name: file.name,
-                    type: file.type,
-                    url: file.url,
-                    buffer,
-                });
-            }, 'readwrite', transaction);
-        };
-        this.hydrateFileData = (raw) => {
-            raw.remote = raw.remote === 'true';
-            const buffer = raw.buffer;
-            delete raw.buffer;
-            raw.file = buffer
-                ? arrayBufferToBlob(buffer, raw.type)
-                : undefined;
-            return raw;
-        };
-        this.markUploaded = async (id, { transaction } = {}) => {
-            const current = await this.getFileRaw(id, { transaction });
-            if (!current) {
-                throw new Error('File is not in local database');
-            }
-            return this.run('files', (store) => {
-                return store.put(Object.assign(Object.assign({}, current), { remote: 'true' }));
-            }, 'readwrite', transaction);
-        };
-        this.getFileRaw = async (id, { transaction } = {}) => {
-            const raw = await this.run('files', (store) => {
-                return store.get(id);
-            }, 'readonly', transaction);
-            if (!raw) {
-                return undefined;
-            }
-            return raw;
-        };
-        this.getFile = async (id, { transaction } = {}) => {
-            const raw = await this.getFileRaw(id, { transaction });
-            if (!raw) {
-                return undefined;
-            }
-            return this.hydrateFileData(raw);
-        };
-        this.markPendingDelete = async (id, { transaction } = {}) => {
-            const current = await this.getFileRaw(id, { transaction });
-            if (!current) {
-                throw new Error('File is not in local database');
-            }
-            return this.run('files', (store) => {
-                return store.put(Object.assign(Object.assign({}, current), { deletedAt: Date.now() }));
-            }, 'readwrite', transaction);
-        };
-        this.listUnsynced = async () => {
-            const raw = await this.run('files', (store) => {
-                return store.index('remote').getAll('false');
-            }, 'readonly');
-            return raw.map(this.hydrateFileData);
-        };
-        this.iterateOverPendingDelete = (iterator, transaction) => {
-            return this.iterate('files', (store) => {
-                return store
-                    .index('deletedAt')
-                    .openCursor(IDBKeyRange.lowerBound(0, true));
-            }, (value, store) => {
-                iterator(this.hydrateFileData(value), store);
-            }, 'readwrite', transaction);
-        };
-    }
-    deleteFile(id, { transaction } = {}) {
-        return this.run('files', (store) => {
-            return store.delete(id);
-        }, 'readwrite', transaction);
-    }
-}
-exports.FileStorage = FileStorage;
-function arrayBufferToBlob(buffer, type) {
-    return new Blob([buffer], { type });
-}
-exports.arrayBufferToBlob = arrayBufferToBlob;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.arrayBufferToBlob = exports.FileStorage = void 0;
+const IDBService_js_1 = require("../IDBService.js");
+const utils_js_1 = require("./utils.js");
+class FileStorage extends IDBService_js_1.IDBService {
+    constructor() {
+        super(...arguments);
+        this.addFile = async (file, { transaction, downloadRemote = false, } = {}) => {
+            let buffer = file.file ? await (0, utils_js_1.fileToArrayBuffer)(file.file) : undefined;
+            if (!buffer && downloadRemote && file.url) {
+                try {
+                    buffer = await fetch(file.url, {
+                        method: 'GET',
+                        credentials: 'include',
+                    }).then((r) => r.arrayBuffer());
+                }
+                catch (err) {
+                    console.error("Failed to download file to cache it locally. The file will still be available using its URL. Check the file server's CORS configuration.", err);
+                }
+            }
+            return this.run('files', (store) => {
+                return store.put({
+                    id: file.id,
+                    // IDB doesn't support boolean indexes
+                    remote: file.remote ? 'true' : 'false',
+                    deletedAt: null,
+                    name: file.name,
+                    type: file.type,
+                    url: file.url,
+                    buffer,
+                });
+            }, 'readwrite', transaction);
+        };
+        this.hydrateFileData = (raw) => {
+            raw.remote = raw.remote === 'true';
+            const buffer = raw.buffer;
+            delete raw.buffer;
+            raw.file = buffer
+                ? arrayBufferToBlob(buffer, raw.type)
+                : undefined;
+            return raw;
+        };
+        this.markUploaded = async (id, { transaction } = {}) => {
+            const current = await this.getFileRaw(id, { transaction });
+            if (!current) {
+                throw new Error('File is not in local database');
+            }
+            return this.run('files', (store) => {
+                return store.put(Object.assign(Object.assign({}, current), { remote: 'true' }));
+            }, 'readwrite', transaction);
+        };
+        this.getFileRaw = async (id, { transaction } = {}) => {
+            const raw = await this.run('files', (store) => {
+                return store.get(id);
+            }, 'readonly', transaction);
+            if (!raw) {
+                return undefined;
+            }
+            return raw;
+        };
+        this.getFile = async (id, { transaction } = {}) => {
+            const raw = await this.getFileRaw(id, { transaction });
+            if (!raw) {
+                return undefined;
+            }
+            return this.hydrateFileData(raw);
+        };
+        this.markPendingDelete = async (id, { transaction } = {}) => {
+            const current = await this.getFileRaw(id, { transaction });
+            if (!current) {
+                throw new Error('File is not in local database');
+            }
+            return this.run('files', (store) => {
+                return store.put(Object.assign(Object.assign({}, current), { deletedAt: Date.now() }));
+            }, 'readwrite', transaction);
+        };
+        this.listUnsynced = async () => {
+            const raw = await this.run('files', (store) => {
+                return store.index('remote').getAll('false');
+            }, 'readonly');
+            return raw.map(this.hydrateFileData);
+        };
+        this.iterateOverPendingDelete = (iterator, transaction) => {
+            return this.iterate('files', (store) => {
+                return store
+                    .index('deletedAt')
+                    .openCursor(IDBKeyRange.lowerBound(0, true));
+            }, (value, store) => {
+                iterator(this.hydrateFileData(value), store);
+            }, 'readwrite', transaction);
+        };
+    }
+    deleteFile(id, { transaction } = {}) {
+        return this.run('files', (store) => {
+            return store.delete(id);
+        }, 'readwrite', transaction);
+    }
+}
+exports.FileStorage = FileStorage;
+function arrayBufferToBlob(buffer, type) {
+    return new Blob([buffer], { type });
+}
+exports.arrayBufferToBlob = arrayBufferToBlob;
 //# sourceMappingURL=FileStorage.js.map

package/dist/cjs/files/utils.d.ts

@@ -1,8 +1,8 @@
-import { FileData } from '@verdant-web/common';
-export declare function createFileData(file: File): FileData;
-/**
- * Replaces File values with refs and returns the normalized value.
- * The list of files passed to the second argument will be populated with the files found in the value.
- */
-export declare function processValueFiles(value: any, onFileIdentified: (fileData: FileData) => void): any;
-export declare function fileToArrayBuffer(file: File | Blob): Promise<ArrayBuffer>;
+import { FileData } from '@verdant-web/common';
+export declare function createFileData(file: File): FileData;
+/**
+ * Replaces File values with refs and returns the normalized value.
+ * The list of files passed to the second argument will be populated with the files found in the value.
+ */
+export declare function processValueFiles(value: any, onFileIdentified: (fileData: FileData) => void): any;
+export declare function fileToArrayBuffer(file: File | Blob): Promise<ArrayBuffer>;

package/dist/cjs/files/utils.js

@@ -1,56 +1,56 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fileToArrayBuffer = exports.processValueFiles = exports.createFileData = void 0;
-const common_1 = require("@verdant-web/common");
-const cuid_1 = __importDefault(require("cuid"));
-function createFileData(file) {
-    return {
-        id: (0, cuid_1.default)(),
-        file: file,
-        url: undefined,
-        remote: false,
-        name: file.name,
-        type: file.type,
-    };
-}
-exports.createFileData = createFileData;
-/**
- * Replaces File values with refs and returns the normalized value.
- * The list of files passed to the second argument will be populated with the files found in the value.
- */
-function processValueFiles(value, onFileIdentified) {
-    if (typeof window !== 'undefined' && value instanceof File) {
-        const data = createFileData(value);
-        onFileIdentified(data);
-        return (0, common_1.createFileRef)(data.id);
-    }
-    if (Array.isArray(value)) {
-        for (let i = 0; i < value.length; i++) {
-            value[i] = processValueFiles(value[i], onFileIdentified);
-        }
-        return value;
-    }
-    if (typeof value === 'object') {
-        for (const key in value) {
-            value[key] = processValueFiles(value[key], onFileIdentified);
-        }
-        return value;
-    }
-    return value;
-}
-exports.processValueFiles = processValueFiles;
-function fileToArrayBuffer(file) {
-    return new Promise((resolve, reject) => {
-        const reader = new FileReader();
-        reader.onload = () => {
-            resolve(reader.result);
-        };
-        reader.onerror = reject;
-        reader.readAsArrayBuffer(file);
-    });
-}
-exports.fileToArrayBuffer = fileToArrayBuffer;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fileToArrayBuffer = exports.processValueFiles = exports.createFileData = void 0;
+const common_1 = require("@verdant-web/common");
+const cuid_1 = __importDefault(require("cuid"));
+function createFileData(file) {
+    return {
+        id: (0, cuid_1.default)(),
+        file: file,
+        url: undefined,
+        remote: false,
+        name: file.name,
+        type: file.type,
+    };
+}
+exports.createFileData = createFileData;
+/**
+ * Replaces File values with refs and returns the normalized value.
+ * The list of files passed to the second argument will be populated with the files found in the value.
+ */
+function processValueFiles(value, onFileIdentified) {
+    if (typeof window !== 'undefined' && value instanceof File) {
+        const data = createFileData(value);
+        onFileIdentified(data);
+        return (0, common_1.createFileRef)(data.id);
+    }
+    if (Array.isArray(value)) {
+        for (let i = 0; i < value.length; i++) {
+            value[i] = processValueFiles(value[i], onFileIdentified);
+        }
+        return value;
+    }
+    if (typeof value === 'object') {
+        for (const key in value) {
+            value[key] = processValueFiles(value[key], onFileIdentified);
+        }
+        return value;
+    }
+    return value;
+}
+exports.processValueFiles = processValueFiles;
+function fileToArrayBuffer(file) {
+    return new Promise((resolve, reject) => {
+        const reader = new FileReader();
+        reader.onload = () => {
+            resolve(reader.result);
+        };
+        reader.onerror = reject;
+        reader.readAsArrayBuffer(file);
+    });
+}
+exports.fileToArrayBuffer = fileToArrayBuffer;
 //# sourceMappingURL=utils.js.map

package/dist/cjs/files/utils.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/cjs/files/utils.test.js

@@ -1,81 +1,81 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const vitest_1 = require("vitest");
-const utils_js_1 = require("./utils.js");
-function makeFile() {
-    return new File([''], 'test.txt', { type: 'text/plain' });
-}
-(0, vitest_1.describe)('processing files in a value', () => {
-    (0, vitest_1.it)('replaces a single file with a reference', () => {
-        const file = makeFile();
-        const list = [];
-        const result = (0, utils_js_1.processValueFiles)(file, list.push.bind(list));
-        (0, vitest_1.expect)(result).toEqual({
-            '@@type': 'file',
-            id: vitest_1.expect.stringContaining(''),
-        });
-        (0, vitest_1.expect)(list).toEqual([
-            {
-                id: vitest_1.expect.stringContaining(''),
-                file,
-                url: undefined,
-                remote: false,
-                name: 'test.txt',
-                type: 'text/plain',
-            },
-        ]);
-    });
-    (0, vitest_1.it)('replaces a list of files with references', () => {
-        const file1 = makeFile();
-        const file2 = makeFile();
-        const list = [];
-        const result = (0, utils_js_1.processValueFiles)([file1, file2], list.push.bind(list));
-        (0, vitest_1.expect)(result).toEqual([
-            { '@@type': 'file', id: vitest_1.expect.stringContaining('') },
-            { '@@type': 'file', id: vitest_1.expect.stringContaining('') },
-        ]);
-        (0, vitest_1.expect)(list).toEqual([
-            {
-                id: vitest_1.expect.stringContaining(''),
-                file: file1,
-                url: undefined,
-                remote: false,
-                name: 'test.txt',
-                type: 'text/plain',
-            },
-            {
-                id: vitest_1.expect.stringContaining(''),
-                file: file2,
-                url: undefined,
-                remote: false,
-                name: 'test.txt',
-                type: 'text/plain',
-            },
-        ]);
-        (0, vitest_1.expect)(result[0].id).not.toEqual(result[1].id);
-    });
-    (0, vitest_1.it)('replaces nested files with references', () => {
-        const file = makeFile();
-        const list = [];
-        const result = (0, utils_js_1.processValueFiles)({ a: { b: file } }, list.push.bind(list));
-        (0, vitest_1.expect)(result).toEqual({
-            a: {
-                b: {
-                    '@@type': 'file',
-                    id: vitest_1.expect.stringContaining(''),
-                },
-            },
-        });
-        (0, vitest_1.expect)(list).toEqual([
-            {
-                id: vitest_1.expect.stringContaining(''),
-                file,
-                url: undefined,
-                remote: false,
-                name: 'test.txt',
-                type: 'text/plain',
-            },
-        ]);
-    });
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const utils_js_1 = require("./utils.js");
+function makeFile() {
+    return new File([''], 'test.txt', { type: 'text/plain' });
+}
+(0, vitest_1.describe)('processing files in a value', () => {
+    (0, vitest_1.it)('replaces a single file with a reference', () => {
+        const file = makeFile();
+        const list = [];
+        const result = (0, utils_js_1.processValueFiles)(file, list.push.bind(list));
+        (0, vitest_1.expect)(result).toEqual({
+            '@@type': 'file',
+            id: vitest_1.expect.stringContaining(''),
+        });
+        (0, vitest_1.expect)(list).toEqual([
+            {
+                id: vitest_1.expect.stringContaining(''),
+                file,
+                url: undefined,
+                remote: false,
+                name: 'test.txt',
+                type: 'text/plain',
+            },
+        ]);
+    });
+    (0, vitest_1.it)('replaces a list of files with references', () => {
+        const file1 = makeFile();
+        const file2 = makeFile();
+        const list = [];
+        const result = (0, utils_js_1.processValueFiles)([file1, file2], list.push.bind(list));
+        (0, vitest_1.expect)(result).toEqual([
+            { '@@type': 'file', id: vitest_1.expect.stringContaining('') },
+            { '@@type': 'file', id: vitest_1.expect.stringContaining('') },
+        ]);
+        (0, vitest_1.expect)(list).toEqual([
+            {
+                id: vitest_1.expect.stringContaining(''),
+                file: file1,
+                url: undefined,
+                remote: false,
+                name: 'test.txt',
+                type: 'text/plain',
+            },
+            {
+                id: vitest_1.expect.stringContaining(''),
+                file: file2,
+                url: undefined,
+                remote: false,
+                name: 'test.txt',
+                type: 'text/plain',
+            },
+        ]);
+        (0, vitest_1.expect)(result[0].id).not.toEqual(result[1].id);
+    });
+    (0, vitest_1.it)('replaces nested files with references', () => {
+        const file = makeFile();
+        const list = [];
+        const result = (0, utils_js_1.processValueFiles)({ a: { b: file } }, list.push.bind(list));
+        (0, vitest_1.expect)(result).toEqual({
+            a: {
+                b: {
+                    '@@type': 'file',
+                    id: vitest_1.expect.stringContaining(''),
+                },
+            },
+        });
+        (0, vitest_1.expect)(list).toEqual([
+            {
+                id: vitest_1.expect.stringContaining(''),
+                file,
+                url: undefined,
+                remote: false,
+                name: 'test.txt',
+                type: 'text/plain',
+            },
+        ]);
+    });
+});
 //# sourceMappingURL=utils.test.js.map

package/dist/cjs/idb.d.ts

@@ -1,11 +1,11 @@
-export declare function storeRequestPromise<T>(request: IDBRequest<T>): Promise<T>;
-export declare function cursorIterator<T>(request: IDBRequest<IDBCursorWithValue | null>, callback: (value: T | null) => boolean): Promise<void>;
-export declare function getSizeOfObjectStore(database: IDBDatabase, storeName: string): Promise<{
-    count: number;
-    size: number;
-}>;
-export declare function getAllFromObjectStores(db: IDBDatabase, stores: string[]): Promise<any[][]>;
-export declare function closeDatabase(db: IDBDatabase): Promise<void>;
-export declare function deleteAllDatabases(namespace: string, indexedDB?: IDBFactory): Promise<void>;
-export declare function deleteDatabase(name: string, indexedDB?: IDBFactory): Promise<IDBDatabase>;
-export declare function getAllDatabaseNamesAndVersions(indexedDB?: IDBFactory): Promise<IDBDatabaseInfo[]>;
+export declare function storeRequestPromise<T>(request: IDBRequest<T>): Promise<T>;
+export declare function cursorIterator<T>(request: IDBRequest<IDBCursorWithValue | null>, callback: (value: T | null) => boolean): Promise<void>;
+export declare function getSizeOfObjectStore(database: IDBDatabase, storeName: string): Promise<{
+    count: number;
+    size: number;
+}>;
+export declare function getAllFromObjectStores(db: IDBDatabase, stores: string[]): Promise<any[][]>;
+export declare function closeDatabase(db: IDBDatabase): Promise<void>;
+export declare function deleteAllDatabases(namespace: string, indexedDB?: IDBFactory): Promise<void>;
+export declare function deleteDatabase(name: string, indexedDB?: IDBFactory): Promise<IDBDatabase>;
+export declare function getAllDatabaseNamesAndVersions(indexedDB?: IDBFactory): Promise<IDBDatabaseInfo[]>;