@protontech/drive-sdk 0.0.10

package/README.md

@@ -0,0 +1,17 @@
+# Drive SDK for web
+
+Use only what is exported by the library. This is the public supported API of the SDK. Anything else is internal implementation that can change without warning.
+
+Start by creating instance of the `ProtonDriveClient`. That instance has then available many methods to access nodes, devices, upload and download content, or manage sharing.
+
+```js
+import { ProtonDriveClient, MemoryCache, OpenPGPCryptoWithCryptoProxy } from 'proton-drive-sdk';
+
+const sdk = new ProtonDriveClient({
+    httpClient,
+    entitiesCache: new MemoryCache(),
+    cryptoCache: new MemoryCache(),
+    account,
+    openPGPCryptoModule: new OpenPGPCryptoWithCryptoProxy(cryptoProxy),
+});
+```

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/config.d.ts

@@ -0,0 +1,2 @@
+import { ProtonDriveConfig } from './interface';
+export declare function getConfig(config?: ProtonDriveConfig): Required<ProtonDriveConfig>;

package/dist/config.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConfig = getConfig;
+function getConfig(config) {
+    return {
+        ...config,
+        baseUrl: config?.baseUrl ? `https://${config.baseUrl}` : 'https://drive-api.proton.me',
+        language: config?.language || 'en',
+    };
+}
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;AAEA,8BAMC;AAND,SAAgB,SAAS,CAAC,MAA0B;IAChD,OAAO;QACH,GAAG,MAAM;QACT,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,WAAW,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,6BAA6B;QACtF,QAAQ,EAAE,MAAM,EAAE,QAAQ,IAAI,IAAI;KACrC,CAAC;AACN,CAAC"}

package/dist/crypto/driveCrypto.d.ts

@@ -0,0 +1,209 @@
+import { OpenPGPCrypto, PrivateKey, PublicKey, SessionKey, SRPModule, SRPVerifier, VERIFICATION_STATUS } from './interface';
+/**
+ * Drive crypto layer to provide general operations for Drive crypto.
+ *
+ * This layer focuses on providing general Drive crypto functions. Only
+ * high-level functions that are required on multiple places should be
+ * peresent. E.g., no specific implementation how keys are encrypted,
+ * but we do share same key generation across shares and nodes modules,
+ * for example, which we can generelise here and in each module just
+ * call with specific arguments.
+ */
+export declare class DriveCrypto {
+    private openPGPCrypto;
+    private srpModule;
+    constructor(openPGPCrypto: OpenPGPCrypto, srpModule: SRPModule);
+    /**
+     * It generates passphrase and key that is encrypted with the
+     * generated passphrase.
+     *
+     * `encrpytionKeys` are used to generate session key, which is
+     * also used to encrypt the passphrase. The encrypted passphrase
+     * is signed with `signingKey`.
+     *
+     * @returns Object with:
+     *  - encrypted (armored) data (key, passphrase and passphrase
+     *    signature) for sending to the server
+     *  - decrypted data (key, sessionKey) for crypto usage
+     */
+    generateKey(encryptionKeys: PrivateKey[], signingKey: PrivateKey): Promise<{
+        encrypted: {
+            armoredKey: string;
+            armoredPassphrase: string;
+            armoredPassphraseSignature: string;
+        };
+        decrypted: {
+            passphrase: string;
+            key: PrivateKey;
+            passphraseSessionKey: SessionKey;
+        };
+    }>;
+    /**
+     * It generates content key from node key for encrypting file blocks.
+     *
+     * @param encryptionKey - Its own node key.
+     * @returns Object with serialised key packet and decrypted session key.
+     */
+    generateContentKey(encryptionKey: PrivateKey): Promise<{
+        encrypted: {
+            base64ContentKeyPacket: string;
+            armoredContentKeyPacketSignature: string;
+        };
+        decrypted: {
+            contentKeyPacketSessionKey: SessionKey;
+        };
+    }>;
+    /**
+     * It encrypts passphrase with provided session and encryption keys.
+     * This should be used only for re-encrypting the passphrase with
+     * different key (e.g., moving the node to different parent).
+     *
+     * @returns Object with armored passphrase and passphrase signature.
+     */
+    encryptPassphrase(passphrase: string, sessionKey: SessionKey, encryptionKeys: PrivateKey[], signingKey: PrivateKey): Promise<{
+        armoredPassphrase: string;
+        armoredPassphraseSignature: string;
+    }>;
+    /**
+     * It decrypts key generated via `generateKey`.
+     *
+     * Armored data are passed from the server. `decryptionKeys` are used
+     * to decrypt the session key from the `armoredPassphrase`. Then the
+     * session key is used with `verificationKeys` to decrypt and verify
+     * the passphrase. Finally, the armored key is decrypted.
+     *
+     * Note: The function doesn't throw in case of verification issue.
+     * You have to read `verified` result and act based on that.
+     *
+     * @returns key and sessionKey for crypto usage, and verification status
+     */
+    decryptKey(armoredKey: string, armoredPassphrase: string, armoredPassphraseSignature: string, decryptionKeys: PrivateKey[], verificationKeys: PublicKey[]): Promise<{
+        passphrase: string;
+        key: PrivateKey;
+        passphraseSessionKey: SessionKey;
+        verified: VERIFICATION_STATUS;
+    }>;
+    /**
+     * It encrypts session key with provided encryption key.
+     */
+    encryptSessionKey(sessionKey: SessionKey, encryptionKey: PublicKey): Promise<{
+        base64KeyPacket: string;
+    }>;
+    /**
+     * It encrypts password with provided address key that can be used to
+     * manage the public link, encrypts share passphrase session key using
+     * provided bcrypt passphrase and generates SRP verifier.
+     */
+    encryptPublicLinkPasswordAndSessionKey(password: string, addressKey: PrivateKey, bcryptPassphrase: string, sharePassphraseSessionKey: SessionKey): Promise<{
+        armoredPassword: string;
+        base64SharePassphraseKeyPacket: string;
+        srp: SRPVerifier;
+    }>;
+    /**
+     * It decrypts session key from armored data.
+     *
+     * `decryptionKeys` are used to decrypt the session key from the `armoredData`.
+     */
+    decryptSessionKey(armoredData: string, decryptionKeys: PrivateKey | PrivateKey[]): Promise<SessionKey>;
+    decryptAndVerifySessionKey(base64data: string, armoredSignature: string | undefined, decryptionKeys: PrivateKey | PrivateKey[], verificationKeys: PublicKey[]): Promise<{
+        sessionKey: SessionKey;
+        verified?: VERIFICATION_STATUS;
+    }>;
+    /**
+     * It decrypts key similarly like `decryptKey`, but without signature
+     * verification. This is used for invitations.
+     */
+    decryptUnsignedKey(armoredKey: string, armoredPassphrase: string, decryptionKeys: PrivateKey | PrivateKey[]): Promise<PrivateKey>;
+    /**
+     * It encrypts and armors signature with provided session and encryption keys.
+     */
+    encryptSignature(signature: Uint8Array, encryptionKey: PrivateKey, sessionKey: SessionKey): Promise<{
+        armoredSignature: string;
+    }>;
+    /**
+     * It generates random 32 bytes that are encrypted and signed with
+     * the provided key.
+     */
+    generateHashKey(encryptionAndSigningKey: PrivateKey): Promise<{
+        armoredHashKey: string;
+        hashKey: Uint8Array;
+    }>;
+    generateLookupHash(newName: string, parentHashKey: Uint8Array): Promise<string>;
+    /**
+     * It converts node name into bytes array and encrypts and signs
+     * with provided keys.
+     *
+     * The function accepts either encryption or session key. Use encryption
+     * key if you want to encrypt the name for the new node. Use session key
+     * if you want to encrypt the new name for the existing node.
+     */
+    encryptNodeName(nodeName: string, sessionKey: SessionKey | undefined, encryptionKey: PrivateKey | undefined, signingKey: PrivateKey): Promise<{
+        armoredNodeName: string;
+    }>;
+    /**
+     * It decrypts armored node name and verifies embeded signature.
+     *
+     * Note: The function doesn't throw in case of verification issue.
+     * You have to read `verified` result and act based on that.
+     */
+    decryptNodeName(armoredNodeName: string, decryptionKey: PrivateKey, verificationKeys: PublicKey[]): Promise<{
+        name: string;
+        verified: VERIFICATION_STATUS;
+    }>;
+    /**
+     * It decrypts armored node hash key and verifies embeded signature.
+     *
+     * Note: The function doesn't throw in case of verification issue.
+     * You have to read `verified` result and act based on that.
+     */
+    decryptNodeHashKey(armoredHashKey: string, decryptionAndVerificationKey: PrivateKey, extraVerificationKeys: PublicKey[]): Promise<{
+        hashKey: Uint8Array;
+        verified: VERIFICATION_STATUS;
+    }>;
+    encryptExtendedAttributes(extendedAttributes: string, encryptionKey: PrivateKey, signingKey: PrivateKey): Promise<{
+        armoredExtendedAttributes: string;
+    }>;
+    decryptExtendedAttributes(armoreExtendedAttributes: string, decryptionKey: PrivateKey, verificationKeys: PublicKey[]): Promise<{
+        extendedAttributes: string;
+        verified: VERIFICATION_STATUS;
+    }>;
+    encryptInvitation(shareSessionKey: SessionKey, encryptionKey: PublicKey, signingKey: PrivateKey): Promise<{
+        base64KeyPacket: string;
+        base64KeyPacketSignature: string;
+    }>;
+    acceptInvitation(base64KeyPacket: string, signingKey: PrivateKey): Promise<{
+        base64SessionKeySignature: string;
+    }>;
+    encryptExternalInvitation(shareSessionKey: SessionKey, signingKey: PrivateKey, inviteeEmail: string): Promise<{
+        base64ExternalInvitationSignature: string;
+    }>;
+    encryptThumbnailBlock(thumbnailData: Uint8Array, sessionKey: SessionKey, signingKey: PrivateKey): Promise<{
+        encryptedData: Uint8Array;
+    }>;
+    decryptThumbnailBlock(encryptedThumbnail: Uint8Array, sessionKey: SessionKey, verificationKeys: PublicKey[]): Promise<{
+        decryptedThumbnail: Uint8Array;
+        verified: VERIFICATION_STATUS;
+    }>;
+    encryptBlock(blockData: Uint8Array, encryptionKey: PrivateKey, sessionKey: SessionKey, signingKey: PrivateKey): Promise<{
+        encryptedData: Uint8Array;
+        armoredSignature: string;
+    }>;
+    decryptBlock(encryptedBlock: Uint8Array, armoredSignature: string | undefined, decryptionKey: PrivateKey, sessionKey: SessionKey, verificationKeys?: PublicKey[]): Promise<{
+        decryptedBlock: Uint8Array;
+        verified: VERIFICATION_STATUS;
+    }>;
+    signManifest(manifest: Uint8Array, signingKey: PrivateKey): Promise<{
+        armoredManifestSignature: string;
+    }>;
+    verifyManifest(manifest: Uint8Array, armoredSignature: string, verificationKeys: PublicKey | PublicKey[]): Promise<{
+        verified: VERIFICATION_STATUS;
+    }>;
+    decryptShareUrlPassword(armoredPassword: string, decryptionKeys: PrivateKey[]): Promise<string>;
+}
+export declare function uint8ArrayToUtf8(input: Uint8Array): string;
+/**
+ * Convert an array of 8-bit integers to a hex string
+ * @param bytes - Array of 8-bit integers to convert
+ * @returns Hexadecimal representation of the array
+ */
+export declare const arrayToHexString: (bytes: Uint8Array) => string;