@whereby.com/browser-sdk 2.0.0-alpha → 2.0.0-alpha1

package/src/lib/api/modules/LocalStorageStore.ts

@@ -1,57 +0,0 @@
-import { assertString, assertTruthy } from "../parameterAssertUtils";
-import { Json } from "../Response";
-import AbstractStore from "./AbstractStore";
-
-/**
- * Utility to ease handling localStorage.
- */
-export default class LocalStorageStore implements AbstractStore {
-    _key: string;
-    _localStorage: Storage;
-
-    constructor(key: string, localStorage: Storage) {
-        assertTruthy(localStorage, "localStorage");
-        this._key = assertString(key, "key");
-        this._localStorage = localStorage;
-    }
-
-    /**
-     * Returns the stored value for this store, or a default if not available.
-     *
-     * @param {(Object|Array.|string|number)} [defaultValue] - Value returned if the object can't be retrieved.
-     * @return {?(Object|Array.|string|number)} Value stored, or defaultValue if not available.
-     */
-    loadOrDefault(defaultValue: Json): Promise<Json> {
-        try {
-            const value = this._localStorage.getItem(this._key);
-            if (value) {
-                try {
-                    return Promise.resolve(JSON.parse(value));
-                } catch (e) {
-                    /* NOOP */
-                }
-            }
-            return Promise.resolve(defaultValue);
-        } catch (e) {
-            // Cookies are blocked
-            console.warn("Error getting access to storage. Are cookies blocked?", e); // eslint-disable-line no-console
-            return Promise.resolve(defaultValue);
-        }
-    }
-
-    /**
-     * Change the value stored for this key.
-     *
-     * @param {(Object|Array.|string|number)} [value] - New value, will replace any previously stored.
-     */
-    save(value: Json): Promise<void> {
-        try {
-            this._localStorage.setItem(this._key, JSON.stringify(value));
-            return Promise.resolve();
-        } catch (e) {
-            /* NOOP, cookies are blocked */
-            console.warn("Error getting access to storage. Are cookies blocked?", e); // eslint-disable-line no-console
-            return Promise.reject(e);
-        }
-    }
-}

package/src/lib/api/modules/tests/ChromeStorageStore.spec.ts

@@ -1,67 +0,0 @@
-import ChromeStorageStore from "../ChromeStorageStore";
-
-describe("ChromeStorageStore", () => {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    let chromeStorage: any;
-    const storeName = "myStore1";
-    let credentialsStore: ChromeStorageStore;
-
-    beforeEach(() => {
-        chromeStorage = {
-            get: jest.fn(() => ({})),
-            set: jest.fn(),
-        };
-
-        credentialsStore = new ChromeStorageStore(storeName, chromeStorage);
-    });
-
-    describe("loadOrDefault", () => {
-        it("should resolve with the stored object", async () => {
-            const savedValue = { mrT: "I pitty the fool" };
-            chromeStorage.get.mockImplementation((key: string, cb: any) => {
-                cb({ [storeName]: savedValue });
-            });
-
-            const result = await credentialsStore.loadOrDefault({});
-
-            expect(result).toEqual(savedValue);
-        });
-
-        it("should resolve with the default value if a stored object cannot be retrieved", async () => {
-            const defaultValue = { mrT: "I pitty the fool" };
-            chromeStorage.get.mockImplementation((key: string, cb: any) => {
-                cb(defaultValue);
-            });
-
-            const result = await credentialsStore.loadOrDefault(defaultValue);
-
-            expect(result).toEqual(defaultValue);
-        });
-    });
-
-    describe("save", () => {
-        it("should save the object to local storage", async () => {
-            const savedValue = { mrT: "I pitty the fool" };
-            chromeStorage.set.mockImplementation((obj: any, cb: any) => {
-                cb();
-            });
-
-            await credentialsStore.save(savedValue);
-
-            // The first arg of the first call to the function 
-            // The 2nd arg is the Promise.resolve anonymous fn
-            expect(chromeStorage.set.mock.calls[0][0]).toEqual({ [storeName]: savedValue });
-        });
-
-        it("should return undefined", async () => {
-            const savedValue = { mrT: "I pitty the fool" };
-            chromeStorage.set.mockImplementation((obj: any, cb: any) => {
-                cb();
-            });
-
-            const result = await credentialsStore.save(savedValue);
-
-            expect(result).toBeUndefined();
-        });
-    });
-});

package/src/lib/api/modules/tests/LocalStorageStore.spec.ts

@@ -1,79 +0,0 @@
-import LocalStorageStore from "../LocalStorageStore";
-import { itShouldThrowIfInvalid } from "../../test/helpers";
-import DummyStore from "./__mocks__/storage";
-
-jest.mock("./__mocks__/storage");
-
-describe("LocalStorageStore", () => {
-    const storeName = "myStore";
-    let credentialsStore: LocalStorageStore;
-    let localStorage: jest.Mocked<DummyStore>;
-
-    beforeEach(() => {
-        localStorage = new DummyStore() as jest.Mocked<DummyStore>;
-        credentialsStore = new LocalStorageStore(storeName, localStorage);
-    });
-
-    afterEach(() => {
-        jest.clearAllMocks();
-    });
-
-    describe("constructor", () => {
-        //@ts-expect-error
-        itShouldThrowIfInvalid("key", () => new LocalStorageStore(undefined, localStorage));
-        //@ts-expect-error
-        itShouldThrowIfInvalid("localStorage", () => new LocalStorageStore(storeName, undefined));
-    });
-
-    describe("loadOrDefault", () => {
-        it("should resolve with the stored object if available", async () => {
-            const savedValue = { mrT: "I pitty the fool" };
-            localStorage.getItem.mockImplementation((key: string) => {
-                if (key === storeName) {
-                    return JSON.stringify(savedValue);
-                } else {
-                    return null;
-                }
-            });
-
-            const result = await credentialsStore.loadOrDefault({});
-
-            expect(result).toEqual(savedValue);
-        });
-
-        it("should resolve with the default value if the stored object cannot be retrieved", async () => {
-            const defaultValue = { mrT: "I pitty the fool" };
-            localStorage.getItem.mockImplementation((key: string) => {
-                if (key === storeName) {
-                    return "This is not valid json";
-                } else {
-                    return null;
-                }
-            });
-
-            const result = await credentialsStore.loadOrDefault(defaultValue);
-
-            expect(result).toEqual(defaultValue);
-        });
-
-        it("should resolve with the default value if no object has been stored", async () => {
-            const defaultValue = { mrT: "I pitty the fool" };
-            localStorage.getItem.mockReturnValue(null);
-            const result = await credentialsStore.loadOrDefault(defaultValue);
-            expect(result).toEqual(defaultValue);
-        });
-    });
-
-    describe("save", () => {
-        it("should save the object to local storage", () => {
-            const savedValue = { mrT: "I pitty the fool" };
-            const expectedValue = JSON.stringify(savedValue);
-
-            const promise = credentialsStore.save(savedValue);
-
-            return promise.then(() => {
-                expect(localStorage.setItem).toBeCalledWith(storeName, expectedValue);
-            });
-        });
-    });
-});

package/src/lib/api/modules/tests/__mocks__/storage.ts

@@ -1,24 +0,0 @@
-export default class DummyStore implements Storage {
-    [name: string]: unknown;
-    length: number;
-
-    constructor() {
-        this.length = 0;
-    }
-    clear(): void {
-        throw new Error("Method not implemented.");
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    getItem(_key: string): string | null {
-        return "{}";
-    }
-    key(): string | null {
-        throw new Error("Method not implemented.");
-    }
-    removeItem(): void {
-        throw new Error("Method not implemented.");
-    }
-    setItem(): void {
-        // NOP
-    }
-}

package/src/lib/api/organizationService/index.ts

@@ -1,284 +0,0 @@
-import assert from "assert";
-import Organization, { OrganizationPreferences } from "../models/Organization";
-import {
-    assertInstanceOf,
-    assertTruthy,
-    assertString,
-    assertArray,
-    assertNullOrString,
-    assertRecord,
-} from "../parameterAssertUtils";
-import ApiClient from "../ApiClient";
-import Response from "../Response";
-import { extractArray, extractString } from "../extractUtils";
-import { ConsentGrantRequest } from "../types";
-
-export default class OrganizationService {
-    _apiClient: ApiClient;
-
-    constructor({ apiClient }: { apiClient: ApiClient }) {
-        // apiClient is added since it will be used eventually or rather soon.
-        // this is to avoid the api to be broken again
-        this._apiClient = assertInstanceOf(apiClient, ApiClient);
-    }
-
-    /**
-     * Creates an organization.
-     */
-    createOrganization({
-        organizationName,
-        subdomain,
-        owner,
-    }: {
-        organizationName: string;
-        subdomain: string;
-        owner:
-            | {
-                  email: string;
-                  displayName: string;
-                  verificationCode: string;
-                  consents?: ReadonlyArray<ConsentGrantRequest>;
-              }
-            | {
-                  idToken: string;
-                  displayName: string;
-                  consents?: ReadonlyArray<ConsentGrantRequest>;
-              };
-    }): Promise<string> {
-        const { displayName, consents } = owner || {};
-        const email =
-            "email" in owner
-                ? {
-                      value: owner.email,
-                      verificationCode: assertString(owner.verificationCode, "owner.verificationCode"),
-                  }
-                : null;
-        const idToken = "idToken" in owner ? owner.idToken : null;
-        assertString(subdomain, "subdomain");
-        assertString(organizationName, "organizationName");
-        assertString(displayName, "owner.displayName");
-        assert.ok(email || idToken, "owner.email or owner.idToken is required");
-
-        if (consents) {
-            assertArray(consents, "consents");
-            for (const { consentRevisionId, action } of consents) {
-                assertString(consentRevisionId, "consentRevisionId");
-                assertNullOrString(action, "action");
-            }
-        }
-
-        return this._apiClient
-            .request(`/organizations`, {
-                method: "POST",
-                data: {
-                    organizationName,
-                    type: "private",
-                    subdomain,
-                    owner: {
-                        ...(email && { email }),
-                        ...(idToken && { idToken }),
-                        ...(consents && { consents }),
-                        displayName,
-                    },
-                },
-            })
-            .then(({ data }) => {
-                return extractString(data, "organizationId");
-            });
-    }
-
-    /**
-     * Retrieves the organization based on the subdomain.
-     */
-    getOrganizationBySubdomain(subdomain: string): Promise<Organization | null> {
-        assertString(subdomain, "subdomain");
-
-        return this._apiClient
-            .request(
-                `/organization-subdomains/${encodeURIComponent(
-                    subdomain
-                )}/?fields=permissions,account,onboardingSurvey`,
-                {
-                    method: "GET",
-                }
-            )
-
-            .then(({ data }) => {
-                return Organization.fromJson(data);
-            })
-            .catch((res) => {
-                if (res instanceof Response) {
-                    if (res.status === 404) {
-                        return null;
-                    }
-
-                    throw new Error(res.statusText);
-                }
-
-                throw res;
-            });
-    }
-
-    /**
-     * Retrieves the organization based on the organizationId.
-     *
-     * Note: This endpoint should only be used to retrieve an organization when the device is linked
-     * to a user in that organization. Use getOrganizationBySubdomain instead if you just want the information
-     * about an organization that is mapped to a given subdomain.
-     */
-    getOrganizationByOrganizationId(organizationId: string): Promise<Organization | null> {
-        assertString(organizationId, "organizationId");
-
-        return this._apiClient
-            .request(`/organizations/${encodeURIComponent(organizationId)}?fields=permissions,account`, {
-                method: "GET",
-            })
-            .then(({ data }) => {
-                return Organization.fromJson(data);
-            })
-            .catch((res) => {
-                if (res instanceof Response) {
-                    if (res.status === 404) {
-                        return null;
-                    }
-
-                    throw new Error(res.statusText);
-                }
-
-                throw res;
-            });
-    }
-
-    /**
-     * Retrieves the organizations that contain a user
-     * matching provided the email+code or phoneNumber+code
-     * combination.
-     */
-    getOrganizationsByContactPoint(
-        options:
-            | {
-                  email: string;
-                  code: string;
-              }
-            | {
-                  phoneNumber: string;
-                  code: string;
-              }
-    ): Promise<ReadonlyArray<Organization>> {
-        const { code } = options;
-        const email = "email" in options ? options.email : null;
-        const phoneNumber = "phoneNumber" in options ? options.phoneNumber : null;
-        assert.ok((email || phoneNumber) && !(email && phoneNumber), "either email or phoneNumber is required");
-        assertString(code, "code");
-
-        const contactPoint = email ? { type: "email", value: email } : { type: "phoneNumber", value: phoneNumber };
-        return this._apiClient
-            .request("/organization-queries", {
-                method: "POST",
-                data: {
-                    contactPoint,
-                    code,
-                },
-            })
-            .then(({ data }) => {
-                return extractArray(data, "organizations", (organization) => Organization.fromJson(organization));
-            });
-    }
-
-    /**
-     * Retrieves the organizations that contain a user
-     * matching provided the idToken
-     */
-    getOrganizationsByIdToken({ idToken }: { idToken: string }): Promise<ReadonlyArray<Organization>> {
-        assertString(idToken, "idToken");
-
-        return this._apiClient
-            .request("/organization-queries", {
-                method: "POST",
-                data: {
-                    idToken,
-                },
-            })
-            .then(({ data }) => {
-                return extractArray(data, "organizations", (organization) => {
-                    return Organization.fromJson({
-                        permissions: {},
-                        limits: {},
-                        ...assertRecord(organization, "organization"),
-                    });
-                });
-            });
-    }
-
-    /**
-     * Retrieves the organizations containing a user
-     * with either the email or phoneNumber matching the logged in user.
-     *
-     * This is useful for showing the possible organization that the current
-     * user could log in to.
-     */
-    getOrganizationsByLoggedInUser(): Promise<ReadonlyArray<Organization>> {
-        return this._apiClient
-            .request("/user/organizations", {
-                method: "GET",
-            })
-            .then(({ data }) => {
-                return extractArray(data, "organizations", (o) => {
-                    return Organization.fromJson({
-                        permissions: {},
-                        limits: {},
-                        ...assertRecord(o, "organization"),
-                    });
-                });
-            });
-    }
-
-    /**
-     * Checks if a subdomain is available and verifies its format.
-     */
-    getSubdomainAvailability(subdomain: string): Promise<{ status: string }> {
-        assertString(subdomain, "subdomain");
-
-        return this._apiClient
-            .request(`/organization-subdomains/${encodeURIComponent(subdomain)}/availability`, {
-                method: "GET",
-            })
-            .then(({ data }) => {
-                assertInstanceOf(data, Object, "data");
-
-                return {
-                    status: extractString(data, "status"),
-                };
-            });
-    }
-    /**
-     * Updates preferences of the organization.
-     */
-    updatePreferences({
-        organizationId,
-        preferences,
-    }: {
-        organizationId: string;
-        preferences: OrganizationPreferences;
-    }): Promise<undefined> {
-        assertTruthy(organizationId, "organizationId");
-        assertTruthy(preferences, "preferences");
-        return this._apiClient
-            .request(`/organizations/${encodeURIComponent(organizationId)}/preferences`, {
-                method: "PATCH",
-                data: preferences,
-            })
-            .then(() => undefined);
-    }
-    /**
-     * Delete organization
-     */
-    deleteOrganization({ organizationId }: { organizationId: string }): Promise<undefined> {
-        assertTruthy(organizationId, "organizationId");
-        return this._apiClient
-            .request(`/organizations/${encodeURIComponent(organizationId)}`, {
-                method: "DELETE",
-            })
-            .then(() => undefined);
-    }
-}