@protontech/drive-sdk 0.0.11 → 0.0.13

package/dist/cache/index.d.ts

@@ -0,0 +1,2 @@
+export type { ProtonDriveCache, EntityResult } from './interface';
+export { MemoryCache } from './memoryCache';

package/dist/cache/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemoryCache = void 0;
+var memoryCache_1 = require("./memoryCache");
+Object.defineProperty(exports, "MemoryCache", { enumerable: true, get: function () { return memoryCache_1.MemoryCache; } });
+//# sourceMappingURL=index.js.map

package/dist/cache/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cache/index.ts"],"names":[],"mappings":";;;AACA,6CAA4C;AAAnC,0GAAA,WAAW,OAAA"}

package/dist/cache/interface.d.ts

@@ -0,0 +1,105 @@
+export interface ProtonDriveCacheConstructor<T> {
+    /**
+     * Initialize the cache.
+     *
+     * The local database should follow document-based structure. The SDK does
+     * serialisation and data is not intended to be read by 3rd party. The SDK,
+     * however, provides also clear fields in form of tags that is used for
+     * search. Local database should have index or other structure for easier
+     * look-up.
+     *
+     * See {@link setEntity} for more details how tags are used.
+     */
+    new (): ProtonDriveCache<T>;
+}
+export interface ProtonDriveCache<T> {
+    /**
+     * Re-creates the whole persistent cache.
+     *
+     * The SDK can call this when there is some inconsistency and it is better
+     * to start from scratch rather than fix it.
+     */
+    clear(): Promise<void>;
+    /**
+     * Adds or updates entity in the local database.
+     *
+     * The `tags` is a list of strings that should be stored properly for fast
+     * look-up.
+     *
+     * @example Usage by the SDK
+     * ```ts
+     * await cache.setEntity("node-abc42", "{ node abc42 serialised data }", ["parentUid:abc123", "sharedWithMe"] });
+     * await Array.fromAsync(cache.iterateEntitiesByTag("parentUid:abc123")); // returns ["node-abc42"]
+     * await cache.getEntity("node-abc42"); // returns "{ node abc42 serialised data }"
+     * await Array.fromAsync(cache.iterateEntities(["node-abc42"])); // returns ["{ node abc42 serialised data }"]
+     * ```
+     *
+     * @example Stored data
+     * ```json
+     * {
+     *     type: "node",
+     *     version: 1,
+     *     internal: {
+     *         isStale,
+     *         claimedDigests,
+     *         // ...
+     *     }
+     *     node: {
+     *         // same as node entity, here some example
+     *         uid,
+     *         parentUid,
+     *         // ...
+     *     }
+     * }
+     * ```
+     *
+     * @param key - Key is internal ID controlled by the SDK. It combines type and ID of the entity.
+     * @param value - Serialised JSON object controlled by the SDK. It is not intended for use outside of the SDK.
+     * @param tags - Clear metadata about the entity used for filtering. It is intended to store efficiently for fast look-up.
+     * @throws Exception if `key` from `tags` is not one of the tag keys provided from `usedTagKeysBySDK` in constructor.
+     */
+    setEntity(key: string, value: T, tags?: string[]): Promise<void>;
+    /**
+     * Returns the data of the entity stored locally.
+     *
+     * @throws Exception if entity is not present.
+     */
+    getEntity(key: string): Promise<T>;
+    /**
+     * Generator providing the data of the entities stored locally for given
+     * list of keys.
+     *
+     * No exception is thrown when data is missing.
+     */
+    iterateEntities(keys: string[]): AsyncGenerator<EntityResult<T>>;
+    /**
+     * Generator providing the data of the entities stored locally for given
+     * filter option.
+     *
+     * No exception is thrown when data is missing.
+     *
+     * @example Usage by the SDK
+     * ```ts
+     * await cache.setEntity("node-abc42", "{ node abc42 serialised data }", { "parentUid": "abc123", "shared": "withMe" });
+     * await Array.fromAsync(cache.iterateEntitiesByTag("parentUid", "abc123")); // returns ["node-abc42"]
+     * ```
+     *
+     * @param tag - The tag, for example `parentUid:abc123`
+     */
+    iterateEntitiesByTag(tag: string): AsyncGenerator<EntityResult<T>>;
+    /**
+     * Removes completely the entity stored locally from the database.
+     *
+     * It is no-op if entity is not present.
+     */
+    removeEntities(keys: string[]): Promise<void>;
+}
+export type EntityResult<T> = {
+    key: string;
+    ok: true;
+    value: T;
+} | {
+    key: string;
+    ok: false;
+    error: string;
+};

package/dist/cache/interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=interface.js.map

package/dist/cache/interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface.js","sourceRoot":"","sources":["../../src/cache/interface.ts"],"names":[],"mappings":""}

package/dist/cache/memoryCache.d.ts

@@ -0,0 +1,18 @@
+import type { ProtonDriveCache, EntityResult } from './interface';
+/**
+ * In-memory cache implementation for Proton Drive SDK.
+ *
+ * This cache is not persistent and is intended for mostly for testing or
+ * development only. It is not recommended to use this cache in production
+ * environments.
+ */
+export declare class MemoryCache<T> implements ProtonDriveCache<T> {
+    private entities;
+    private entitiesByTag;
+    clear(): Promise<void>;
+    setEntity(key: string, value: T, tags?: string[]): Promise<void>;
+    getEntity(key: string): Promise<NonNullable<T>>;
+    iterateEntities(keys: string[]): AsyncGenerator<EntityResult<T>>;
+    iterateEntitiesByTag(tag: string): AsyncGenerator<EntityResult<T>>;
+    removeEntities(keys: string[]): Promise<void>;
+}

package/dist/cache/memoryCache.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemoryCache = void 0;
+/**
+ * In-memory cache implementation for Proton Drive SDK.
+ *
+ * This cache is not persistent and is intended for mostly for testing or
+ * development only. It is not recommended to use this cache in production
+ * environments.
+ */
+class MemoryCache {
+    entities = {};
+    entitiesByTag = {};
+    async clear() {
+        this.entities = {};
+    }
+    async setEntity(key, value, tags) {
+        this.entities[key] = value;
+        for (const tag of Object.keys(this.entitiesByTag)) {
+            const index = this.entitiesByTag[tag].indexOf(key);
+            if (index !== -1) {
+                this.entitiesByTag[tag].splice(index, 1);
+                if (this.entitiesByTag[tag].length === 0) {
+                    delete this.entitiesByTag[tag];
+                }
+            }
+        }
+        if (tags) {
+            for (const tag of tags) {
+                if (!this.entitiesByTag[tag]) {
+                    this.entitiesByTag[tag] = [];
+                }
+                this.entitiesByTag[tag].push(key);
+            }
+        }
+    }
+    async getEntity(key) {
+        const value = this.entities[key];
+        if (!value) {
+            throw Error('Entity not found');
+        }
+        return value;
+    }
+    async *iterateEntities(keys) {
+        for (const key of keys) {
+            try {
+                const value = await this.getEntity(key);
+                yield { key, ok: true, value };
+            }
+            catch (error) {
+                yield { key, ok: false, error: `${error}` };
+            }
+        }
+    }
+    async *iterateEntitiesByTag(tag) {
+        const keys = this.entitiesByTag[tag];
+        if (!keys) {
+            return;
+        }
+        // Pass copy of keys so concurrent changes to the cache do not affect
+        // results from iterating entities.
+        yield* this.iterateEntities([...keys]);
+    }
+    async removeEntities(keys) {
+        for (const key of keys) {
+            delete this.entities[key];
+            Object.values(this.entitiesByTag).forEach((tagKeys) => {
+                const index = tagKeys.indexOf(key);
+                if (index !== -1) {
+                    tagKeys.splice(index, 1);
+                }
+            });
+        }
+    }
+}
+exports.MemoryCache = MemoryCache;
+;
+//# sourceMappingURL=memoryCache.js.map

package/dist/cache/memoryCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memoryCache.js","sourceRoot":"","sources":["../../src/cache/memoryCache.ts"],"names":[],"mappings":";;;AAKA;;;;;;GAMG;AACH,MAAa,WAAW;IACZ,QAAQ,GAAqB,EAAE,CAAC;IAChC,aAAa,GAAc,EAAE,CAAC;IAEtC,KAAK,CAAC,KAAK;QACP,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,GAAW,EAAE,KAAQ,EAAE,IAAe;QAClD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAE3B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;YAChD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACnD,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBACf,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;gBACzC,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACvC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;gBACnC,CAAC;YACL,CAAC;QACL,CAAC;QAED,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACrB,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC3B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;gBACjC,CAAC;gBACD,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,CAAC;QACL,CAAC;IACL,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,GAAW;QACvB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACjC,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,MAAM,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,CAAC,eAAe,CAAC,IAAc;QACjC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACrB,IAAI,CAAC;gBACD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;gBACxC,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YACnC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,EAAE,CAAC;YAChD,CAAC;QACL,CAAC;IACL,CAAC;IAED,KAAK,CAAC,CAAC,oBAAoB,CAAC,GAAW;QACnC,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,OAAO;QACX,CAAC;QAED,qEAAqE;QACrE,mCAAmC;QACnC,KAAK,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,IAAc;QAC/B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC1B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAClD,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBACnC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;oBACf,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;gBAC7B,CAAC;YACL,CAAC,CAAC,CAAC;QACP,CAAC;IACL,CAAC;CACJ;AAxED,kCAwEC;AAAA,CAAC"}

package/dist/cache/memoryCache.test.d.ts

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

package/dist/cache/memoryCache.test.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const memoryCache_1 = require("./memoryCache");
+describe('MemoryCache', () => {
+    let cache;
+    beforeEach(async () => {
+        cache = new memoryCache_1.MemoryCache();
+        await cache.setEntity('key1', 'value1', ['tag1:hello', 'tag2:world']);
+        await cache.setEntity('key2', 'value2', ['tag2:world']);
+        await cache.setEntity('key3', 'value3');
+    });
+    it('should store and retrieve an entity', async () => {
+        const key = 'newkey';
+        const value = 'newvalue';
+        await cache.setEntity(key, value);
+        const result = await cache.getEntity(key);
+        expect(result).toBe(value);
+    });
+    it('should update an entity with tags - remove old and add new tags', async () => {
+        const key = 'newkey';
+        await cache.setEntity(key, 'value1', ['tag1', 'tag2']);
+        await cache.setEntity(key, 'value2', ['tag2', 'tag3']);
+        const result = await cache.getEntity(key);
+        expect(result).toBe('value2');
+        const tag1 = await Array.fromAsync(cache.iterateEntitiesByTag('tag1'));
+        expect(tag1).toEqual([]);
+        const tag2 = await Array.fromAsync(cache.iterateEntitiesByTag('tag2'));
+        expect(tag2).toEqual([{ key, ok: true, value: 'value2' }]);
+        const tag3 = await Array.fromAsync(cache.iterateEntitiesByTag('tag3'));
+        expect(tag3).toEqual([{ key, ok: true, value: 'value2' }]);
+    });
+    it('should throw an error when retrieving a non-existing entity', async () => {
+        const key = 'newkey';
+        try {
+            await cache.getEntity(key);
+            fail('Should have thrown an error');
+        }
+        catch (error) {
+            expect(`${error}`).toBe('Error: Entity not found');
+        }
+    });
+    it('should iterate over entities', async () => {
+        const results = [];
+        for await (const result of cache.iterateEntities(['key1', 'key2', 'key100'])) {
+            results.push(result);
+        }
+        expect(results).toEqual([
+            { key: 'key1', ok: true, value: 'value1' },
+            { key: 'key2', ok: true, value: 'value2' },
+            { key: 'key100', ok: false, error: 'Error: Entity not found' },
+        ]);
+    });
+    it('should iterate over entities by tag', async () => {
+        const results = [];
+        for await (const result of cache.iterateEntitiesByTag('tag2:world')) {
+            results.push(result);
+        }
+        expect(results).toEqual([
+            { key: 'key1', ok: true, value: 'value1' },
+            { key: 'key2', ok: true, value: 'value2' },
+        ]);
+    });
+    it('should iterate over entities with multiple tags by tag', async () => {
+        const results = [];
+        for await (const result of cache.iterateEntitiesByTag('tag1:hello')) {
+            results.push(result);
+        }
+        expect(results).toEqual([
+            { key: 'key1', ok: true, value: 'value1' },
+        ]);
+    });
+    it('should iterate over entities by empty tag', async () => {
+        const results = [];
+        for await (const result of cache.iterateEntitiesByTag('nonexistent')) {
+            results.push(result);
+        }
+        expect(results).toEqual([]);
+    });
+    it('should iterate over entities with concurrent changes to the same set', async () => {
+        const iterator = cache.iterateEntities(['key1', 'key2', 'key3']);
+        const results = [];
+        const { value: { key: key1 } } = await iterator.next();
+        results.push(key1);
+        await cache.removeEntities([key1]);
+        let value = await iterator.next(); // key2
+        results.push(value.value.key);
+        value = await iterator.next(); // key3
+        results.push(value.value.key);
+        expect(results).toEqual(['key1', 'key2', 'key3']);
+    });
+    it('should remove entities', async () => {
+        await cache.removeEntities(['key1', 'key3']);
+        const results = [];
+        for await (const result of cache.iterateEntities(['key1', 'key2', 'key3'])) {
+            results.push(result);
+        }
+        expect(results).toEqual([
+            { key: 'key1', ok: false, error: 'Error: Entity not found' },
+            { key: 'key2', ok: true, value: 'value2' },
+            { key: 'key3', ok: false, error: 'Error: Entity not found' },
+        ]);
+        const results2 = [];
+        for await (const result of cache.iterateEntitiesByTag('tag1:hello')) {
+            results2.push(result);
+        }
+        expect(results2).toEqual([]);
+    });
+    it('should clear the cache', async () => {
+        await cache.clear();
+        const results = [];
+        for await (const result of cache.iterateEntities(['key1', 'key2', 'key3'])) {
+            results.push(result);
+        }
+        expect(results).toEqual([
+            { key: 'key1', ok: false, error: 'Error: Entity not found' },
+            { key: 'key2', ok: false, error: 'Error: Entity not found' },
+            { key: 'key3', ok: false, error: 'Error: Entity not found' },
+        ]);
+    });
+});
+//# sourceMappingURL=memoryCache.test.js.map

package/dist/cache/memoryCache.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memoryCache.test.js","sourceRoot":"","sources":["../../src/cache/memoryCache.test.ts"],"names":[],"mappings":";;AACA,+CAA4C;AAE5C,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IACzB,IAAI,KAA0B,CAAC;IAE/B,UAAU,CAAC,KAAK,IAAI,EAAE;QAClB,KAAK,GAAG,IAAI,yBAAW,EAAE,CAAC;QAE1B,MAAM,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC;QACtE,MAAM,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;QACxD,MAAM,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,GAAG,GAAG,QAAQ,CAAC;QACrB,MAAM,KAAK,GAAG,UAAU,CAAC;QAEzB,MAAM,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAE1C,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC7E,MAAM,GAAG,GAAG,QAAQ,CAAC;QAErB,MAAM,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;QACvD,MAAM,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;QAEvD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE9B,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;QACvE,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;QACvE,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;QACvE,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,GAAG,GAAG,QAAQ,CAAC;QAErB,IAAI,CAAC;YACD,MAAM,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YAC3B,IAAI,CAAC,6BAA6B,CAAC,CAAC;QACxC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QACvD,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;QAC1C,MAAM,OAAO,GAAG,EAAE,CAAC;QACnB,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC;YAC3E,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;YACpB,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE;YAC1C,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE;YAC1C,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,yBAAyB,EAAE;SACjE,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,OAAO,GAAG,EAAE,CAAC;QACnB,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,YAAY,CAAC,EAAE,CAAC;YAClE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;YACpB,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE;YAC1C,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE;SAC7C,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,OAAO,GAAG,EAAE,CAAC;QACnB,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,YAAY,CAAC,EAAE,CAAC;YAClE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;YACpB,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE;SAC7C,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,OAAO,GAAG,EAAE,CAAC;QACnB,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,aAAa,CAAC,EAAE,CAAC;YACnE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QAClF,MAAM,QAAQ,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;QAEjE,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,MAAM,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACvD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,MAAM,KAAK,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAEnC,IAAI,KAAK,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO;QAC1C,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE9B,KAAK,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO;QACtC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE9B,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,KAAK,CAAC,cAAc,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;QAE7C,MAAM,OAAO,GAAG,EAAE,CAAC;QACnB,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;YACzE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;YACpB,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,yBAAyB,EAAE;YAC5D,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE;YAC1C,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,yBAAyB,EAAE;SAC/D,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,YAAY,CAAC,EAAE,CAAC;YAClE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC;QACD,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;QAEpB,MAAM,OAAO,GAAG,EAAE,CAAC;QACnB,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;YACzE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;YACpB,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,yBAAyB,EAAE;YAC5D,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,yBAAyB,EAAE;YAC5D,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,yBAAyB,EAAE;SAC/D,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/crypto/hmac.d.ts

@@ -0,0 +1,22 @@
+export type HmacCryptoKey = CryptoKey;
+type HmacKeyUsage = 'sign' | 'verify';
+/**
+ * Import an HMAC-SHA256 key in order to use it with `signData` and `verifyData`.
+ */
+export declare const importHmacKey: (key: Uint8Array, keyUsage?: HmacKeyUsage[]) => Promise<HmacCryptoKey>;
+/**
+ * Sign data using HMAC-SHA256
+ * @param key - WebCrypto secret key for signing
+ * @param data - data to sign
+ * @param additionalData - additional data to authenticate
+ */
+export declare const computeHmacSignature: (key: HmacCryptoKey, data: Uint8Array) => Promise<Uint8Array>;
+/**
+ * Verify data using HMAC-SHA256
+ * @param key - WebCrypto secret key for verification
+ * @param signature - signature over data
+ * @param data - data to verify
+ * @param additionalData - additional data to authenticate
+ */
+export declare const verifyData: (key: HmacCryptoKey, signature: Uint8Array, data: Uint8Array) => Promise<boolean>;
+export {};

package/dist/crypto/hmac.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.verifyData = exports.computeHmacSignature = exports.importHmacKey = void 0;
+const HASH_ALGORITHM = 'SHA-256';
+const KEY_LENGTH_BYTES = 32;
+/**
+ * Import an HMAC-SHA256 key in order to use it with `signData` and `verifyData`.
+ */
+const importHmacKey = async (key, keyUsage = ['sign', 'verify']) => {
+    // From https://datatracker.ietf.org/doc/html/rfc2104:
+    // The key for HMAC can be of any length (keys longer than B bytes are first hashed using H).
+    // However, less than L bytes (L = 32 bytes for SHA-256) is strongly discouraged as it would
+    // decrease the security strength of the function.  Keys longer than L bytes are acceptable
+    // but the extra length would not significantly increase the function strength.
+    // (A longer key may be advisable if the randomness of the key is considered weak.)
+    if (key.length < KEY_LENGTH_BYTES) {
+        throw new Error('Unexpected HMAC key size: key is too short');
+    }
+    return crypto.subtle.importKey('raw', key, { name: 'HMAC', hash: HASH_ALGORITHM }, false, keyUsage);
+};
+exports.importHmacKey = importHmacKey;
+/**
+ * Sign data using HMAC-SHA256
+ * @param key - WebCrypto secret key for signing
+ * @param data - data to sign
+ * @param additionalData - additional data to authenticate
+ */
+const computeHmacSignature = async (key, data) => {
+    const signatureBuffer = await crypto.subtle.sign({ name: 'HMAC', hash: HASH_ALGORITHM }, key, data);
+    return new Uint8Array(signatureBuffer);
+};
+exports.computeHmacSignature = computeHmacSignature;
+/**
+ * Verify data using HMAC-SHA256
+ * @param key - WebCrypto secret key for verification
+ * @param signature - signature over data
+ * @param data - data to verify
+ * @param additionalData - additional data to authenticate
+ */
+const verifyData = async (key, signature, data) => {
+    return crypto.subtle.verify({ name: 'HMAC', hash: HASH_ALGORITHM }, key, signature, data);
+};
+exports.verifyData = verifyData;
+//# sourceMappingURL=hmac.js.map

package/dist/crypto/hmac.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hmac.js","sourceRoot":"","sources":["../../src/crypto/hmac.ts"],"names":[],"mappings":";;;AAAA,MAAM,cAAc,GAAG,SAAS,CAAC;AACjC,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAK5B;;GAEG;AACI,MAAM,aAAa,GAAG,KAAK,EAC9B,GAAe,EACf,WAA2B,CAAC,MAAM,EAAE,QAAQ,CAAC,EACvB,EAAE;IACxB,sDAAsD;IACtD,6FAA6F;IAC7F,4FAA4F;IAC5F,2FAA2F;IAC3F,+EAA+E;IAC/E,mFAAmF;IACnF,IAAI,GAAG,CAAC,MAAM,GAAG,gBAAgB,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;AACxG,CAAC,CAAC;AAdW,QAAA,aAAa,iBAcxB;AAEF;;;;;GAKG;AACI,MAAM,oBAAoB,GAAG,KAAK,EAAE,GAAkB,EAAE,IAAgB,EAAE,EAAE;IAC/E,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IACpG,OAAO,IAAI,UAAU,CAAC,eAAe,CAAC,CAAC;AAC3C,CAAC,CAAC;AAHW,QAAA,oBAAoB,wBAG/B;AAEF;;;;;;GAMG;AACI,MAAM,UAAU,GAAG,KAAK,EAAE,GAAkB,EAAE,SAAqB,EAAE,IAAgB,EAAE,EAAE;IAC5F,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AAC9F,CAAC,CAAC;AAFW,QAAA,UAAU,cAErB"}

package/dist/crypto/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function uint8ArrayToBase64String(array: Uint8Array): string;
+export declare function base64StringToUint8Array(string: string): Uint8Array;

package/dist/crypto/utils.js

@@ -0,0 +1,35 @@
+"use strict";
+// This file has copy-pasted utilities from CryptoProxy located in Proton web clients monorepo.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uint8ArrayToBase64String = uint8ArrayToBase64String;
+exports.base64StringToUint8Array = base64StringToUint8Array;
+function uint8ArrayToBase64String(array) {
+    return encodeBase64(arrayToBinaryString(array));
+}
+function base64StringToUint8Array(string) {
+    return binaryStringToArray(decodeBase64(string) || '');
+}
+const ifDefined = (cb) => (input) => {
+    return (input !== undefined ? cb(input) : undefined);
+};
+const encodeBase64 = ifDefined((input) => btoa(input).trim());
+const decodeBase64 = ifDefined((input) => atob(input.trim()));
+const arrayToBinaryString = (bytes) => {
+    const result = [];
+    const bs = 1 << 14;
+    const j = bytes.length;
+    for (let i = 0; i < j; i += bs) {
+        // @ts-expect-error Uint8Array treated as number[]
+        // eslint-disable-next-line prefer-spread
+        result.push(String.fromCharCode.apply(String, bytes.subarray(i, i + bs < j ? i + bs : j)));
+    }
+    return result.join('');
+};
+const binaryStringToArray = (str) => {
+    const result = new Uint8Array(str.length);
+    for (let i = 0; i < str.length; i++) {
+        result[i] = str.charCodeAt(i);
+    }
+    return result;
+};
+//# sourceMappingURL=utils.js.map

package/dist/crypto/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/crypto/utils.ts"],"names":[],"mappings":";AAAA,+FAA+F;;AAE/F,4DAEC;AAED,4DAEC;AAND,SAAgB,wBAAwB,CAAC,KAAiB;IACtD,OAAO,YAAY,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC;AACpD,CAAC;AAED,SAAgB,wBAAwB,CAAC,MAAc;IACnD,OAAO,mBAAmB,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;AAC3D,CAAC;AAED,MAAM,SAAS,GACX,CAAO,EAAmB,EAAE,EAAE,CAC9B,CAA0B,KAAQ,EAAE,EAAE;IAClC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAgC,CAAC;AAC7F,CAAC,CAAC;AAEN,MAAM,YAAY,GAAG,SAAS,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;AAEtE,MAAM,YAAY,GAAG,SAAS,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AAEtE,MAAM,mBAAmB,GAAG,CAAC,KAAiB,EAAE,EAAE;IAC9C,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,MAAM,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC;IACnB,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;IAEvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC;QAC7B,kDAAkD;QAClD,yCAAyC;QACzC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/F,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,GAAW,EAAE,EAAE;IACxC,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAClC,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,142 @@
+/**
+ * Base class for all SDK errors.
+ *
+ * This class can be used for catching all SDK errors. The error should have
+ * translated message in the `message` property that should be shown to the
+ * user without any modification.
+ *
+ * No retries should be done as that is already handled by the SDK.
+ *
+ * When SDK throws an error and it is not `ProtonDriveError`, it is unhandled error
+ * by the SDK and usually indicates bug in the SDK. Please, report it.
+ */
+export declare class ProtonDriveError extends Error {
+    name: string;
+}
+/**
+ * Error thrown when the operation is aborted.
+ *
+ * This error is thrown when the operation is aborted by the user.
+ * For example, by calling `abort()` on the `AbortSignal`.
+ */
+export declare class AbortError extends ProtonDriveError {
+    name: string;
+    constructor(message?: string);
+}
+/**
+ * Error thrown when the validation fails.
+ *
+ * This error is thrown when the validation of the input fails.
+ * Validation can be done on the client side or on the server side.
+ *
+ * For example, on the client, it can be thrown when the node name doesn't
+ * follow the required format, etc., while on the server side, it can be thrown
+ * when there is not enough permissions, etc.
+ */
+export declare class ValidationError extends ProtonDriveError {
+    name: string;
+    /**
+     * Internal API code.
+     *
+     * Use only for debugging purposes.
+     */
+    readonly code?: number;
+    /**
+     * Additional details about the error provided by the server.
+     */
+    readonly details?: object;
+    constructor(message: string, code?: number, details?: object);
+}
+/**
+ * Error thrown when the node already exists.
+ *
+ * This error is thrown when the node with the same name already exists in the
+ * parent folder. The client should ask the user to replace the existing node
+ * or choose another name. The available name is provided in the `availableName`
+ * property (that will contain original name with the index that can be used).
+ */
+export declare class NodeAlreadyExistsValidationError extends ValidationError {
+    name: string;
+    readonly existingNodeUid?: string;
+    constructor(message: string, code: number, existingNodeUid?: string);
+}
+/**
+ * Error thrown when the API call fails.
+ *
+ * This error covers both HTTP errors and API errors. SDK automatically
+ * retries the request before the error is thrown. The sepcific algorithm
+ * used for retries depends on the type of the error.
+ *
+ * Client should not retry the request when this error is thrown.
+ */
+export declare class ServerError extends ProtonDriveError {
+    name: string;
+    /**
+     * HTTP status code of the response.
+     *
+     * Use only for debugging purposes.
+     */
+    readonly statusCode?: number;
+    /**
+     * Internal API code.
+     *
+     * Use only for debugging purposes.
+     */
+    readonly code?: number;
+}
+/**
+ * Error thrown when the client makes too many requests to the API.
+ *
+ * SDK is configured to stay below the rate limits, but it can still happen if
+ * client is running multiple SDKs in parallel, or if the rate limits are
+ * changed on the server side.
+ *
+ * SDK automatically retries the request before the error is thrown after
+ * waiting for the required time specified by the server.
+ *
+ * Client should slow down calling SDK when this error is thrown.
+ *
+ * You can be also notified about the rate limits by the `requestsThrottled`
+ * event. See `onMessage` method on the SDK class for more details.
+ */
+export declare class RateLimitedError extends ServerError {
+    name: string;
+    code: number;
+}
+/**
+ * Error thrown when the client is not connected to the internet.
+ *
+ * Client should check the internet connection when this error is thrown.
+ *
+ * You can also be notified about the connection status by the `offline` event
+ * See `onMessage` method on the SDK class for more details.
+ */
+export declare class ConnectionError extends ProtonDriveError {
+    name: string;
+}
+/**
+ * Error thrown when the decryption fails.
+ *
+ * Client should report this error to the user and report bug report.
+ *
+ * In most cases, there is no decryption error. Every decryption error should
+ * be not exposed but set as empty value on the node, for example. But in the
+ * case of the file content, if block cannot be decrypted, decryption error
+ * is thrown.
+ */
+export declare class DecryptionError extends ProtonDriveError {
+    name: string;
+}
+/**
+ * Error thrown when the data integrity check fails.
+ *
+ * Client should report this error to the user and report bug report.
+ *
+ * For example, it can happen when hashes don't match, etc. In some cases,
+ * SDK allows to run command without verification checks for debug purposes.
+ */
+export declare class IntegrityError extends ProtonDriveError {
+    name: string;
+    readonly debug?: object;
+    constructor(message: string, debug?: object);
+}