@api-client/ui 0.0.14 → 0.0.17

package/build/src/apps/services/OrganizationService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OrganizationService.js","sourceRoot":"","sources":["../../../../src/apps/services/OrganizationService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAE/C,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAA;AAC/D,OAAO,QAAQ,MAAM,mBAAmB,CAAA;AAExC,IAAK,KAIJ;AAJD,WAAK,KAAK;IACR,6CAAU,CAAA;IACV,yCAAQ,CAAA;IACR,uCAAO,CAAA;AACT,CAAC,EAJI,KAAK,KAAL,KAAK,QAIT;AAED,MAAM,CAAN,IAAY,eAiBX;AAjBD,WAAY,eAAe;IACzB;;OAEG;IACH,iDAAE,CAAA;IACF;;OAEG;IACH,mEAAW,CAAA;IACX;;OAEG;IACH,2EAAe,CAAA;IACf;;OAEG;IACH,uDAAK,CAAA;AACP,CAAC,EAjBW,eAAe,KAAf,eAAe,QAiB1B;AAED,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,OAAO;IACtD,MAAM,CAAU,GAAG,GAAG,0BAA0B,CAAA;IAEhD,KAAK,GAAU,KAAK,CAAC,UAAU,CAAA;IAC/B,aAAa,GAAoB,EAAE,CAAA;IACnC,cAAc,CAAoB;IAElC;;OAEG;IACH,eAAe,CAA2B;IAE1C;;OAEG;IACH,eAAe,CAAmC;IAElD,KAAK,CAAC,mBAAmB;QACvB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,+DAA+D;QAC/D,wDAAwD;QACxD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,cAAc,CAAC,CAAA;IACtE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU;QACR,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,QAAQ,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC,eAA2C,CAAA;QACzD,CAAC;QACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,OAAO,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC,CAAA;QAC5C,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAA;QAC3B,IAAI,CAAC,eAAe,GAAG,IAAI,OAAO,CAAkB,CAAC,QAAQ,EAAE,EAAE;YAC/D,IAAI,CAAC,eAAe,GAAG,QAAQ,CAAA;QACjC,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,kBAAkB,EAAE,CAAA;QACzB,OAAO,IAAI,CAAC,eAAe,CAAA;IAC7B,CAAC;IAED,KAAK,CAAC,kBAAkB;QACtB,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QACrC,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAA;YAC1C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,KAAK,IAAI,EAAE,CAAA;QACvC,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC,eAAe,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,CAAA;YAC7C,IAAI,CAAC,eAAe,GAAG,SAAS,CAAA;YAChC,IAAI,CAAC,eAAe,GAAG,SAAS,CAAA;YAChC,OAAM;QACR,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACtC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAA;QAC1B,IAAI,CAAC,eAAe,EAAE,CAAC,MAAM,CAAC,CAAA;QAC9B,IAAI,CAAC,eAAe,GAAG,SAAS,CAAA;QAChC,IAAI,CAAC,eAAe,GAAG,SAAS,CAAA;IAClC,CAAC;IAED,KAAK,CAAC,UAAU;QACd,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC3C,MAAM,QAAQ,GAAG,CAAC,MAAM,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAuB,CAAA;QACvF,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAA;QACtE,IAAI,MAAuB,CAAA;QAC3B,IAAI,QAAQ,IAAI,WAAW,EAAE,CAAC;YAC5B,IAAI,CAAC,cAAc,GAAG,QAAQ,CAAA;YAC9B,MAAM,GAAG,eAAe,CAAC,EAAE,CAAA;QAC7B,CAAC;aAAM,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3C,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA;YACrC,MAAM,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAA;YACnD,IAAI,CAAC,cAAc,GAAG,GAAG,CAAA;YACzB,MAAM,GAAG,eAAe,CAAC,EAAE,CAAA;QAC7B,CAAC;aAAM,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;YACrC,MAAM,GAAG,eAAe,CAAC,WAAW,CAAA;QACtC,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,eAAe,CAAC,eAAe,CAAA;QAC1C,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,qBAAqB,CAAC,GAAkB;QAC5C,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;YAC9B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAC5B,OAAM;QACR,CAAC;QACD,IAAI,CAAC,aAAa,GAAG,CAAC,GAAG,CAAC,CAAA;QAC1B,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC3C,MAAM,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,sBAAsB,EAAE,GAAG,CAAC,GAAG,CAAC,CAAA;QACvD,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,GAAG,CAAA;IAC/B,CAAC","sourcesContent":["import { Service } from '../../core/Service.js'\nimport { IOrganization } from '@api-client/core/browser.js'\nimport { CurrentOrganizationKey } from '../../lib/StoreKeys.js'\nimport services from '../api_service.js'\n\nenum State {\n  NotChecked,\n  Checking,\n  Checked,\n}\n\nexport enum CompletionState {\n  /**\n   * The user has at least one organization and the current organization is selected.\n   */\n  OK,\n  /**\n   * The user has at leas two organizations and no valid selection.\n   */\n  NotSelected,\n  /**\n   * The user have no organizations. Setup is needed.\n   */\n  NoOrganizations,\n  /**\n   * Unable to determine the state due to an error.\n   */\n  Error,\n}\n\nexport default class OrganizationService extends Service {\n  static override key = 'api-service/organization'\n\n  state: State = State.NotChecked\n  organizations: IOrganization[] = []\n  organizationId: string | undefined\n\n  /**\n   * A hidden value for the `updateComplete` getter.\n   */\n  #updateComplete?: Promise<CompletionState>\n\n  /**\n   * The resolver to call when the update completes.\n   */\n  #updateResolver?: (state: CompletionState) => void\n\n  async currentOrganization(): Promise<IOrganization | undefined> {\n    if (!this.organizationId) {\n      return undefined\n    }\n    // TODO: we will store the orgs list in the local/session store\n    // so we won't be pinging server with every page reload.\n    return this.organizations.find((i) => i.key === this.organizationId)\n  }\n\n  /**\n   * Forces to get the list of organizations from the server.\n   *\n   * Returns one of the following states:\n   *\n   * - `CompletionState.OK` - The user has at least one organization and the current organization is selected.\n   * - `CompletionState.NotSelected` - The user has at leas two organizations and no valid selection.\n   * - `CompletionState.NoOrganizations` - The user have no organizations. Setup is needed.\n   * - `CompletionState.Error` - Unable to determine the state due to an error.\n   *\n   * @returns The state of the organization creation.\n   */\n  revalidate(): Promise<CompletionState> {\n    if (this.state === State.Checking) {\n      return this.#updateComplete as Promise<CompletionState>\n    }\n    if (this.organizationId) {\n      return Promise.resolve(CompletionState.OK)\n    }\n    this.state = State.Checking\n    this.#updateComplete = new Promise<CompletionState>((resolver) => {\n      this.#updateResolver = resolver\n    })\n    this.#callOrganizations()\n    return this.#updateComplete\n  }\n\n  async #callOrganizations(): Promise<void> {\n    const sdk = await services.get('sdk')\n    try {\n      const orgs = await sdk.organization.list()\n      this.organizations = orgs.items || []\n    } catch {\n      this.#updateResolver?.(CompletionState.Error)\n      this.#updateResolver = undefined\n      this.#updateComplete = undefined\n      return\n    }\n    const result = await this.#readState()\n    this.state = State.Checked\n    this.#updateResolver?.(result)\n    this.#updateResolver = undefined\n    this.#updateComplete = undefined\n  }\n\n  async #readState(): Promise<CompletionState> {\n    const config = await services.get('config')\n    const selected = (await config.local.get(CurrentOrganizationKey)) as string | undefined\n    const hasSelected = this.organizations.some((i) => i.key === selected)\n    let result: CompletionState\n    if (selected && hasSelected) {\n      this.organizationId = selected\n      result = CompletionState.OK\n    } else if (this.organizations.length === 1) {\n      const key = this.organizations[0].key\n      await config.local.set(CurrentOrganizationKey, key)\n      this.organizationId = key\n      result = CompletionState.OK\n    } else if (this.organizations.length) {\n      result = CompletionState.NotSelected\n    } else {\n      result = CompletionState.NoOrganizations\n    }\n    return result\n  }\n\n  /**\n   * When the user has no organizations, it set the organization as the only one\n   * and persists the organization id as the selected organization.\n   * @param org The organization to add.\n   */\n  async setupUserOrganization(org: IOrganization): Promise<void> {\n    if (this.organizations.length) {\n      this.organizations.push(org)\n      return\n    }\n    this.organizations = [org]\n    const config = await services.get('config')\n    await config.local.set(CurrentOrganizationKey, org.key)\n    this.organizationId = org.key\n  }\n}\n"]}

package/build/src/apps/services/SdkService.d.ts

@@ -0,0 +1,17 @@
+import { Service } from '../../core/Service.js';
+import { UiSdk } from '../../sdk/UiSdk.js';
+export default class SdkService extends Service {
+    static key: string;
+    sdk: UiSdk;
+    protected url: string;
+    constructor(url: string);
+    onCreate(): Promise<void>;
+    onStart(): Promise<void>;
+    get organization(): UiSdk['organization'];
+    get user(): UiSdk['user'];
+    get auth(): UiSdk['auth'];
+    get file(): UiSdk['file'];
+    get shared(): UiSdk['shared'];
+    get trash(): UiSdk['trash'];
+}
+//# sourceMappingURL=SdkService.d.ts.map

package/build/src/apps/services/SdkService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SdkService.d.ts","sourceRoot":"","sources":["../../../../src/apps/services/SdkService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAE1C,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,OAAO;IAC7C,OAAgB,GAAG,SAAoB;IACvC,GAAG,EAAG,KAAK,CAAA;IACX,SAAS,CAAC,GAAG,EAAE,MAAM,CAAA;gBAET,GAAG,EAAE,MAAM;IAKR,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAIzB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIvC,IAAI,YAAY,IAAI,KAAK,CAAC,cAAc,CAAC,CAExC;IAED,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,CAExB;IAED,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,CAExB;IAED,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,CAExB;IAED,IAAI,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,CAE5B;IAED,IAAI,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,CAE1B;CACF"}

package/build/src/apps/services/SdkService.js

@@ -0,0 +1,36 @@
+import { Service } from '../../core/Service.js';
+import { UiSdk } from '../../sdk/UiSdk.js';
+export default class SdkService extends Service {
+    static key = 'api-service/sdk';
+    sdk;
+    url;
+    constructor(url) {
+        super();
+        this.url = url;
+    }
+    async onCreate() {
+        this.sdk = new UiSdk(this.url);
+    }
+    async onStart() {
+        await this.sdk.initialize();
+    }
+    get organization() {
+        return this.sdk.organization;
+    }
+    get user() {
+        return this.sdk.user;
+    }
+    get auth() {
+        return this.sdk.auth;
+    }
+    get file() {
+        return this.sdk.file;
+    }
+    get shared() {
+        return this.sdk.shared;
+    }
+    get trash() {
+        return this.sdk.trash;
+    }
+}
+//# sourceMappingURL=SdkService.js.map

package/build/src/apps/services/SdkService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SdkService.js","sourceRoot":"","sources":["../../../../src/apps/services/SdkService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAE1C,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,OAAO;IAC7C,MAAM,CAAU,GAAG,GAAG,iBAAiB,CAAA;IACvC,GAAG,CAAQ;IACD,GAAG,CAAQ;IAErB,YAAY,GAAW;QACrB,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IAChB,CAAC;IAEQ,KAAK,CAAC,QAAQ;QACrB,IAAI,CAAC,GAAG,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAChC,CAAC;IAEQ,KAAK,CAAC,OAAO;QACpB,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,CAAA;IAC7B,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,CAAA;IAC9B,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAA;IACtB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAA;IACtB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAA;IACtB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAA;IACxB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAA;IACvB,CAAC","sourcesContent":["import { Service } from '../../core/Service.js'\nimport { UiSdk } from '../../sdk/UiSdk.js'\n\nexport default class SdkService extends Service {\n  static override key = 'api-service/sdk'\n  sdk!: UiSdk\n  protected url: string\n\n  constructor(url: string) {\n    super()\n    this.url = url\n  }\n\n  override async onCreate(): Promise<void> {\n    this.sdk = new UiSdk(this.url)\n  }\n\n  override async onStart(): Promise<void> {\n    await this.sdk.initialize()\n  }\n\n  get organization(): UiSdk['organization'] {\n    return this.sdk.organization\n  }\n\n  get user(): UiSdk['user'] {\n    return this.sdk.user\n  }\n\n  get auth(): UiSdk['auth'] {\n    return this.sdk.auth\n  }\n\n  get file(): UiSdk['file'] {\n    return this.sdk.file\n  }\n\n  get shared(): UiSdk['shared'] {\n    return this.sdk.shared\n  }\n\n  get trash(): UiSdk['trash'] {\n    return this.sdk.trash\n  }\n}\n"]}

package/build/src/apps/services/TransmitService.d.ts

@@ -0,0 +1,10 @@
+import { Transmit } from '@adonisjs/transmit-client';
+import { Service } from '../../core/Service.js';
+export default class TransmitService extends Service {
+    static key: string;
+    transmit: Transmit;
+    protected url: string;
+    constructor(url: string);
+    protected onCreate(): Promise<void>;
+}
+//# sourceMappingURL=TransmitService.d.ts.map

package/build/src/apps/services/TransmitService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransmitService.d.ts","sourceRoot":"","sources":["../../../../src/apps/services/TransmitService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAE/C,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,OAAO;IAClD,OAAgB,GAAG,SAAyB;IAE5C,QAAQ,EAAG,QAAQ,CAAA;IAEnB,SAAS,CAAC,GAAG,EAAE,MAAM,CAAA;gBAET,GAAG,EAAE,MAAM;cAKE,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;CAKnD"}

package/build/src/apps/services/TransmitService.js

@@ -0,0 +1,17 @@
+import { Transmit } from '@adonisjs/transmit-client';
+import { Service } from '../../core/Service.js';
+export default class TransmitService extends Service {
+    static key = 'api-service/transmit';
+    transmit;
+    url;
+    constructor(url) {
+        super();
+        this.url = url;
+    }
+    async onCreate() {
+        this.transmit = new Transmit({
+            baseUrl: this.url,
+        });
+    }
+}
+//# sourceMappingURL=TransmitService.js.map

package/build/src/apps/services/TransmitService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransmitService.js","sourceRoot":"","sources":["../../../../src/apps/services/TransmitService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAE/C,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,OAAO;IAClD,MAAM,CAAU,GAAG,GAAG,sBAAsB,CAAA;IAE5C,QAAQ,CAAW;IAET,GAAG,CAAQ;IAErB,YAAY,GAAW;QACrB,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IAChB,CAAC;IAEkB,KAAK,CAAC,QAAQ;QAC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC;YAC3B,OAAO,EAAE,IAAI,CAAC,GAAG;SAClB,CAAC,CAAA;IACJ,CAAC","sourcesContent":["import { Transmit } from '@adonisjs/transmit-client'\nimport { Service } from '../../core/Service.js'\n\nexport default class TransmitService extends Service {\n  static override key = 'api-service/transmit'\n\n  transmit!: Transmit\n\n  protected url: string\n\n  constructor(url: string) {\n    super()\n    this.url = url\n  }\n\n  protected override async onCreate(): Promise<void> {\n    this.transmit = new Transmit({\n      baseUrl: this.url,\n    })\n  }\n}\n"]}

package/build/src/apps/services/UserService.d.ts

@@ -0,0 +1,23 @@
+import type { IUser } from '@api-client/core/browser.js';
+import { Service } from '../../core/Service.js';
+declare enum CheckState {
+    NotChecked = 0,
+    Checking = 1,
+    Checked = 2
+}
+export default class UserService extends Service {
+    #private;
+    static key: string;
+    /**
+     * Tells yhe current state of checking for user session.
+     */
+    status: CheckState;
+    /**
+     * Checks whether user is logged in and exists.
+     * @returns `true`
+     */
+    get isLoggedIn(): boolean;
+    getUser(): Promise<IUser | null>;
+}
+export {};
+//# sourceMappingURL=UserService.d.ts.map

package/build/src/apps/services/UserService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserService.d.ts","sourceRoot":"","sources":["../../../../src/apps/services/UserService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAA;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAG/C,aAAK,UAAU;IACb,UAAU,IAAA;IACV,QAAQ,IAAA;IACR,OAAO,IAAA;CACR;AAED,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,OAAO;;IAC9C,OAAgB,GAAG,SAAqB;IAExC;;OAEG;IACH,MAAM,aAAwB;IAiB9B;;;OAGG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAEK,OAAO,IAAI,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;CA2BvC"}

package/build/src/apps/services/UserService.js

@@ -0,0 +1,62 @@
+import { Service } from '../../core/Service.js';
+import services from '../api_service.js';
+var CheckState;
+(function (CheckState) {
+    CheckState[CheckState["NotChecked"] = 0] = "NotChecked";
+    CheckState[CheckState["Checking"] = 1] = "Checking";
+    CheckState[CheckState["Checked"] = 2] = "Checked";
+})(CheckState || (CheckState = {}));
+export default class UserService extends Service {
+    static key = 'api-service/user';
+    /**
+     * Tells yhe current state of checking for user session.
+     */
+    status = CheckState.NotChecked;
+    /**
+     * The currently logged in user.
+     */
+    #user;
+    /**
+     * A hidden value for the `updateComplete` getter.
+     */
+    #updateComplete;
+    /**
+     * The resolver to call when the update completes.
+     */
+    #updateResolver;
+    /**
+     * Checks whether user is logged in and exists.
+     * @returns `true`
+     */
+    get isLoggedIn() {
+        return !!this.#user;
+    }
+    async getUser() {
+        if (this.#user) {
+            return Promise.resolve(this.#user);
+        }
+        if (this.status === CheckState.Checking) {
+            return this.#updateComplete;
+        }
+        this.status = CheckState.Checking;
+        this.#updateComplete = new Promise((resolver) => {
+            this.#updateResolver = resolver;
+        });
+        this.#callUser();
+        return this.#updateComplete;
+    }
+    async #callUser() {
+        const sdk = await services.get('sdk');
+        try {
+            this.#user = await sdk.user.me();
+        }
+        catch {
+            //
+        }
+        this.status = CheckState.Checked;
+        this.#updateResolver?.(this.#user || null);
+        this.#updateResolver = undefined;
+        this.#updateComplete = undefined;
+    }
+}
+//# sourceMappingURL=UserService.js.map

package/build/src/apps/services/UserService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserService.js","sourceRoot":"","sources":["../../../../src/apps/services/UserService.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAC/C,OAAO,QAAQ,MAAM,mBAAmB,CAAA;AAExC,IAAK,UAIJ;AAJD,WAAK,UAAU;IACb,uDAAU,CAAA;IACV,mDAAQ,CAAA;IACR,iDAAO,CAAA;AACT,CAAC,EAJI,UAAU,KAAV,UAAU,QAId;AAED,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,OAAO;IAC9C,MAAM,CAAU,GAAG,GAAG,kBAAkB,CAAA;IAExC;;OAEG;IACH,MAAM,GAAG,UAAU,CAAC,UAAU,CAAA;IAE9B;;OAEG;IACH,KAAK,CAAQ;IAEb;;OAEG;IACH,eAAe,CAAwB;IAEvC;;OAEG;IACH,eAAe,CAAgC;IAE/C;;;OAGG;IACH,IAAI,UAAU;QACZ,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACpC,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,QAAQ,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC,eAAwC,CAAA;QACtD,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAA;QACjC,IAAI,CAAC,eAAe,GAAG,IAAI,OAAO,CAAe,CAAC,QAAQ,EAAE,EAAE;YAC5D,IAAI,CAAC,eAAe,GAAG,QAAQ,CAAA;QACjC,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,SAAS,EAAE,CAAA;QAChB,OAAO,IAAI,CAAC,eAAe,CAAA;IAC7B,CAAC;IAED,KAAK,CAAC,SAAS;QACb,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QACrC,IAAI,CAAC;YACH,IAAI,CAAC,KAAK,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,CAAA;QAClC,CAAC;QAAC,MAAM,CAAC;YACP,EAAE;QACJ,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,OAAO,CAAA;QAChC,IAAI,CAAC,eAAe,EAAE,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,CAAA;QAC1C,IAAI,CAAC,eAAe,GAAG,SAAS,CAAA;QAChC,IAAI,CAAC,eAAe,GAAG,SAAS,CAAA;IAClC,CAAC","sourcesContent":["import type { IUser } from '@api-client/core/browser.js'\nimport { Service } from '../../core/Service.js'\nimport services from '../api_service.js'\n\nenum CheckState {\n  NotChecked,\n  Checking,\n  Checked,\n}\n\nexport default class UserService extends Service {\n  static override key = 'api-service/user'\n\n  /**\n   * Tells yhe current state of checking for user session.\n   */\n  status = CheckState.NotChecked\n\n  /**\n   * The currently logged in user.\n   */\n  #user?: IUser\n\n  /**\n   * A hidden value for the `updateComplete` getter.\n   */\n  #updateComplete?: Promise<IUser | null>\n\n  /**\n   * The resolver to call when the update completes.\n   */\n  #updateResolver?: (state: IUser | null) => void\n\n  /**\n   * Checks whether user is logged in and exists.\n   * @returns `true`\n   */\n  get isLoggedIn(): boolean {\n    return !!this.#user\n  }\n\n  async getUser(): Promise<IUser | null> {\n    if (this.#user) {\n      return Promise.resolve(this.#user)\n    }\n    if (this.status === CheckState.Checking) {\n      return this.#updateComplete as Promise<IUser | null>\n    }\n    this.status = CheckState.Checking\n    this.#updateComplete = new Promise<IUser | null>((resolver) => {\n      this.#updateResolver = resolver\n    })\n    this.#callUser()\n    return this.#updateComplete\n  }\n\n  async #callUser(): Promise<void> {\n    const sdk = await services.get('sdk')\n    try {\n      this.#user = await sdk.user.me()\n    } catch {\n      //\n    }\n    this.status = CheckState.Checked\n    this.#updateResolver?.(this.#user || null)\n    this.#updateResolver = undefined\n    this.#updateComplete = undefined\n  }\n}\n"]}

package/build/src/apps/transmit_client.d.ts

@@ -0,0 +1,3 @@
+import { Transmit } from '@adonisjs/transmit-client';
+export declare const transmit: Transmit;
+//# sourceMappingURL=transmit_client.d.ts.map

package/build/src/apps/transmit_client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transmit_client.d.ts","sourceRoot":"","sources":["../../../src/apps/transmit_client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AAEpD,eAAO,MAAM,QAAQ,UAEnB,CAAA"}

package/build/src/apps/transmit_client.js

@@ -0,0 +1,5 @@
+import { Transmit } from '@adonisjs/transmit-client';
+export const transmit = new Transmit({
+    baseUrl: window.location.origin,
+});
+//# sourceMappingURL=transmit_client.js.map

package/build/src/apps/transmit_client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transmit_client.js","sourceRoot":"","sources":["../../../src/apps/transmit_client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AAEpD,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC;IACnC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM;CAChC,CAAC,CAAA","sourcesContent":["import { Transmit } from '@adonisjs/transmit-client'\n\nexport const transmit = new Transmit({\n  baseUrl: window.location.origin,\n})\n"]}

package/build/src/apps/types.d.ts

@@ -0,0 +1,11 @@
+export interface AppInfo {
+    /**
+     * The application name
+     */
+    app: string;
+    /**
+     * The application version.
+     */
+    appVersion: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/src/apps/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apps/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;CACnB"}

package/build/src/apps/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/apps/types.ts"],"names":[],"mappings":"","sourcesContent":["export interface AppInfo {\n  /**\n   * The application name\n   */\n  app: string\n  /**\n   * The application version.\n   */\n  appVersion: string\n}\n"]}

package/build/src/bindings/base/ConfigurationBindings.d.ts

@@ -0,0 +1,78 @@
+import { TelemetryConfig } from '@api-client/core/browser.js';
+import { PlatformBindings } from './PlatformBindings.js';
+export declare const KeyPrefix = "api-client.config.";
+export declare const TelemetryKey = "api-client.config.telemetry";
+export interface LocalConfiguration {
+    /**
+     * Reads a previously stored local value.
+     *
+     * @param key The key under which the property was stored.
+     * @returns The configuration value or undefined when not found.
+     */
+    get(key: string): Promise<unknown | undefined>;
+    /**
+     * Sets a config property that is permanently stored.
+     *
+     * @param key The key under to store the value.
+     * @param value The value to store. If this is not a primitive it will be serialized with `JSON.stringify()`.
+     */
+    set(key: string, value: unknown): Promise<void>;
+    /**
+     * Deletes previously stored local value.
+     *
+     * @param key The key under which the property was stored.
+     */
+    delete(key: string): Promise<void>;
+}
+export interface SessionConfiguration {
+    /**
+     * Reads a previously stored session value.
+     *
+     * @param key The key under which the property was stored.
+     * @returns The configuration value or undefined when not found.
+     */
+    get(key: string): Promise<unknown | undefined>;
+    /**
+     * Sets a config property that is held in the storage only for the time of the current session.
+     *
+     * @param key The key under to store the value.
+     * @param value The value to store. If this is not a primitive it will be serialized with `JSON.stringify()`.
+     */
+    set(key: string, value: unknown): Promise<void>;
+    /**
+     * Deletes previously stored session value.
+     *
+     * @param key The key under which the property was stored.
+     */
+    delete(key: string): Promise<void>;
+}
+export interface TelemetryConfiguration {
+    /**
+     * Reads the set telemetry configuration. If the configuration is missing a default value is returned.
+     */
+    read(): Promise<TelemetryConfig>;
+    /**
+     * Sets the configuration for telemetry.
+     *
+     * @param config The configuration to set.
+     */
+    set(config: TelemetryConfig): Promise<void>;
+}
+/**
+ * The base class for application settings bindings.
+ */
+export declare abstract class ConfigurationBindings extends PlatformBindings {
+    abstract local: LocalConfiguration;
+    abstract session: SessionConfiguration;
+    abstract telemetry: TelemetryConfiguration;
+    initialize(): Promise<void>;
+    protected getSessionHandler(input: Event): void;
+    protected setSessionHandler(input: Event): void;
+    protected deleteSessionHandler(input: Event): void;
+    protected getLocalHandler(input: Event): void;
+    protected setLocalHandler(input: Event): void;
+    protected deleteLocalHandler(input: Event): void;
+    protected telemetryReadHandler(input: Event): void;
+    protected telemetrySetHandler(input: Event): void;
+}
+//# sourceMappingURL=ConfigurationBindings.d.ts.map

package/build/src/bindings/base/ConfigurationBindings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigurationBindings.d.ts","sourceRoot":"","sources":["../../../../src/bindings/base/ConfigurationBindings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAA;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAGxD,eAAO,MAAM,SAAS,uBAAuB,CAAA;AAC7C,eAAO,MAAM,YAAY,gCAA0B,CAAA;AAEnD,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IAE9C;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE/C;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IAE9C;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE/C;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,eAAe,CAAC,CAAA;IAEhC;;;;OAIG;IACH,GAAG,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC5C;AAED;;GAEG;AACH,8BAAsB,qBAAsB,SAAQ,gBAAgB;IAClE,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAA;IAElC,QAAQ,CAAC,OAAO,EAAE,oBAAoB,CAAA;IAEtC,QAAQ,CAAC,SAAS,EAAE,sBAAsB,CAAA;IAEpC,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAajC,SAAS,CAAC,iBAAiB,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAM/C,SAAS,CAAC,iBAAiB,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAM/C,SAAS,CAAC,oBAAoB,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAMlD,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAM7C,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAM7C,SAAS,CAAC,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAMhD,SAAS,CAAC,oBAAoB,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAMlD,SAAS,CAAC,mBAAmB,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;CAKlD"}

package/build/src/bindings/base/ConfigurationBindings.js

@@ -0,0 +1,60 @@
+import { PlatformBindings } from './PlatformBindings.js';
+import { EventTypes } from '../../events/EventTypes.js';
+export const KeyPrefix = 'api-client.config.';
+export const TelemetryKey = `${KeyPrefix}telemetry`;
+/**
+ * The base class for application settings bindings.
+ */
+export class ConfigurationBindings extends PlatformBindings {
+    async initialize() {
+        window.addEventListener(EventTypes.Config.Session.get, this.getSessionHandler.bind(this));
+        window.addEventListener(EventTypes.Config.Session.set, this.setSessionHandler.bind(this));
+        window.addEventListener(EventTypes.Config.Session.delete, this.deleteSessionHandler.bind(this));
+        window.addEventListener(EventTypes.Config.Local.get, this.getLocalHandler.bind(this));
+        window.addEventListener(EventTypes.Config.Local.set, this.setLocalHandler.bind(this));
+        window.addEventListener(EventTypes.Config.Local.delete, this.deleteLocalHandler.bind(this));
+        window.addEventListener(EventTypes.Config.Telemetry.read, this.telemetryReadHandler.bind(this));
+        window.addEventListener(EventTypes.Config.Telemetry.set, this.telemetrySetHandler.bind(this));
+    }
+    getSessionHandler(input) {
+        const e = input;
+        e.preventDefault();
+        e.detail.result = this.session.get(e.detail.key);
+    }
+    setSessionHandler(input) {
+        const e = input;
+        e.preventDefault();
+        e.detail.result = this.session.set(e.detail.key, e.detail.value);
+    }
+    deleteSessionHandler(input) {
+        const e = input;
+        e.preventDefault();
+        e.detail.result = this.session.delete(e.detail.key);
+    }
+    getLocalHandler(input) {
+        const e = input;
+        e.preventDefault();
+        e.detail.result = this.local.get(e.detail.key);
+    }
+    setLocalHandler(input) {
+        const e = input;
+        e.preventDefault();
+        e.detail.result = this.local.set(e.detail.key, e.detail.value);
+    }
+    deleteLocalHandler(input) {
+        const e = input;
+        e.preventDefault();
+        e.detail.result = this.local.delete(e.detail.key);
+    }
+    telemetryReadHandler(input) {
+        const e = input;
+        e.preventDefault();
+        e.detail.result = this.telemetry.read();
+    }
+    telemetrySetHandler(input) {
+        const e = input;
+        e.preventDefault();
+        e.detail.result = this.telemetry.set(e.detail.config);
+    }
+}
+//# sourceMappingURL=ConfigurationBindings.js.map

package/build/src/bindings/base/ConfigurationBindings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigurationBindings.js","sourceRoot":"","sources":["../../../../src/bindings/base/ConfigurationBindings.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAEvD,MAAM,CAAC,MAAM,SAAS,GAAG,oBAAoB,CAAA;AAC7C,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,SAAS,WAAW,CAAA;AAkEnD;;GAEG;AACH,MAAM,OAAgB,qBAAsB,SAAQ,gBAAgB;IAOlE,KAAK,CAAC,UAAU;QACd,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QACzF,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QACzF,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QAE/F,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QACrF,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QACrF,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QAE3F,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QAC/F,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IAC/F,CAAC;IAES,iBAAiB,CAAC,KAAY;QACtC,MAAM,CAAC,GAAG,KAAoB,CAAA;QAC9B,CAAC,CAAC,cAAc,EAAE,CAAA;QAClB,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IAClD,CAAC;IAES,iBAAiB,CAAC,KAAY;QACtC,MAAM,CAAC,GAAG,KAAoB,CAAA;QAC9B,CAAC,CAAC,cAAc,EAAE,CAAA;QAClB,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAClE,CAAC;IAES,oBAAoB,CAAC,KAAY;QACzC,MAAM,CAAC,GAAG,KAAoB,CAAA;QAC9B,CAAC,CAAC,cAAc,EAAE,CAAA;QAClB,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACrD,CAAC;IAES,eAAe,CAAC,KAAY;QACpC,MAAM,CAAC,GAAG,KAAoB,CAAA;QAC9B,CAAC,CAAC,cAAc,EAAE,CAAA;QAClB,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IAChD,CAAC;IAES,eAAe,CAAC,KAAY;QACpC,MAAM,CAAC,GAAG,KAAoB,CAAA;QAC9B,CAAC,CAAC,cAAc,EAAE,CAAA;QAClB,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAChE,CAAC;IAES,kBAAkB,CAAC,KAAY;QACvC,MAAM,CAAC,GAAG,KAAoB,CAAA;QAC9B,CAAC,CAAC,cAAc,EAAE,CAAA;QAClB,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACnD,CAAC;IAES,oBAAoB,CAAC,KAAY;QACzC,MAAM,CAAC,GAAG,KAAoB,CAAA;QAC9B,CAAC,CAAC,cAAc,EAAE,CAAA;QAClB,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAA;IACzC,CAAC;IAES,mBAAmB,CAAC,KAAY;QACxC,MAAM,CAAC,GAAG,KAAoB,CAAA;QAC9B,CAAC,CAAC,cAAc,EAAE,CAAA;QAClB,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IACvD,CAAC;CACF","sourcesContent":["import { TelemetryConfig } from '@api-client/core/browser.js'\nimport { PlatformBindings } from './PlatformBindings.js'\nimport { EventTypes } from '../../events/EventTypes.js'\n\nexport const KeyPrefix = 'api-client.config.'\nexport const TelemetryKey = `${KeyPrefix}telemetry`\n\nexport interface LocalConfiguration {\n  /**\n   * Reads a previously stored local value.\n   *\n   * @param key The key under which the property was stored.\n   * @returns The configuration value or undefined when not found.\n   */\n  get(key: string): Promise<unknown | undefined>\n\n  /**\n   * Sets a config property that is permanently stored.\n   *\n   * @param key The key under to store the value.\n   * @param value The value to store. If this is not a primitive it will be serialized with `JSON.stringify()`.\n   */\n  set(key: string, value: unknown): Promise<void>\n\n  /**\n   * Deletes previously stored local value.\n   *\n   * @param key The key under which the property was stored.\n   */\n  delete(key: string): Promise<void>\n}\n\nexport interface SessionConfiguration {\n  /**\n   * Reads a previously stored session value.\n   *\n   * @param key The key under which the property was stored.\n   * @returns The configuration value or undefined when not found.\n   */\n  get(key: string): Promise<unknown | undefined>\n\n  /**\n   * Sets a config property that is held in the storage only for the time of the current session.\n   *\n   * @param key The key under to store the value.\n   * @param value The value to store. If this is not a primitive it will be serialized with `JSON.stringify()`.\n   */\n  set(key: string, value: unknown): Promise<void>\n\n  /**\n   * Deletes previously stored session value.\n   *\n   * @param key The key under which the property was stored.\n   */\n  delete(key: string): Promise<void>\n}\n\nexport interface TelemetryConfiguration {\n  /**\n   * Reads the set telemetry configuration. If the configuration is missing a default value is returned.\n   */\n  read(): Promise<TelemetryConfig>\n\n  /**\n   * Sets the configuration for telemetry.\n   *\n   * @param config The configuration to set.\n   */\n  set(config: TelemetryConfig): Promise<void>\n}\n\n/**\n * The base class for application settings bindings.\n */\nexport abstract class ConfigurationBindings extends PlatformBindings {\n  abstract local: LocalConfiguration\n\n  abstract session: SessionConfiguration\n\n  abstract telemetry: TelemetryConfiguration\n\n  async initialize(): Promise<void> {\n    window.addEventListener(EventTypes.Config.Session.get, this.getSessionHandler.bind(this))\n    window.addEventListener(EventTypes.Config.Session.set, this.setSessionHandler.bind(this))\n    window.addEventListener(EventTypes.Config.Session.delete, this.deleteSessionHandler.bind(this))\n\n    window.addEventListener(EventTypes.Config.Local.get, this.getLocalHandler.bind(this))\n    window.addEventListener(EventTypes.Config.Local.set, this.setLocalHandler.bind(this))\n    window.addEventListener(EventTypes.Config.Local.delete, this.deleteLocalHandler.bind(this))\n\n    window.addEventListener(EventTypes.Config.Telemetry.read, this.telemetryReadHandler.bind(this))\n    window.addEventListener(EventTypes.Config.Telemetry.set, this.telemetrySetHandler.bind(this))\n  }\n\n  protected getSessionHandler(input: Event): void {\n    const e = input as CustomEvent\n    e.preventDefault()\n    e.detail.result = this.session.get(e.detail.key)\n  }\n\n  protected setSessionHandler(input: Event): void {\n    const e = input as CustomEvent\n    e.preventDefault()\n    e.detail.result = this.session.set(e.detail.key, e.detail.value)\n  }\n\n  protected deleteSessionHandler(input: Event): void {\n    const e = input as CustomEvent\n    e.preventDefault()\n    e.detail.result = this.session.delete(e.detail.key)\n  }\n\n  protected getLocalHandler(input: Event): void {\n    const e = input as CustomEvent\n    e.preventDefault()\n    e.detail.result = this.local.get(e.detail.key)\n  }\n\n  protected setLocalHandler(input: Event): void {\n    const e = input as CustomEvent\n    e.preventDefault()\n    e.detail.result = this.local.set(e.detail.key, e.detail.value)\n  }\n\n  protected deleteLocalHandler(input: Event): void {\n    const e = input as CustomEvent\n    e.preventDefault()\n    e.detail.result = this.local.delete(e.detail.key)\n  }\n\n  protected telemetryReadHandler(input: Event): void {\n    const e = input as CustomEvent\n    e.preventDefault()\n    e.detail.result = this.telemetry.read()\n  }\n\n  protected telemetrySetHandler(input: Event): void {\n    const e = input as CustomEvent\n    e.preventDefault()\n    e.detail.result = this.telemetry.set(e.detail.config)\n  }\n}\n"]}

package/build/src/bindings/base/FileBindings.d.ts

@@ -0,0 +1,170 @@
+import { PlatformBindings } from './PlatformBindings.js';
+export interface IFileFilter {
+    /**
+     * An optional description of the category of files types allowed.
+     *
+     * @platform web
+     * @platform electron
+     */
+    description?: string;
+    /**
+     * An Object with the keys set to the MIME type and the values an Array of file extensions.
+     *
+     * ```
+     * "description": "Images",
+     * "accept": {
+     *  'image/*': ['.png', '.gif', '.jpeg', '.jpg']
+     * }
+     * ```
+     *
+     * @platform web
+     * @platform electron
+     */
+    accept: Record<string, string[]>;
+}
+export interface ISaveFileDialogInit {
+    /**
+     * Only when the platform supports it.
+     * The dialog title. Cannot be displayed on some _Linux_ desktop environments.
+     */
+    title?: string;
+    /**
+     * Only when the platform supports it.
+     * Absolute directory path, absolute file path, or file name to use by default.
+     */
+    defaultPath?: string;
+    /**
+     * The list of file filters to apply to the dialog.
+     */
+    filters?: IFileFilter[];
+    /**
+     * Default false. By default the picker should include an option to not apply any file type filters.
+     * Setting this option to true means that option is not available.
+     *
+     * @platform web
+     */
+    excludeAcceptAllOption?: boolean;
+}
+export interface ISaveFileDialogResult {
+    /**
+     * Whether or not the dialog was canceled.
+     */
+    canceled: boolean;
+    /**
+     * If the dialog is canceled, this will be `undefined`.
+     *
+     * In **electron** this is the path to the selected file.
+     * In the **web** platform this is autogenerated id to the file handle
+     * the app should use with the further communication.
+     */
+    filePath?: string;
+}
+export interface IOpenFileDialogInit {
+    /**
+     * Only when the platform supports it.
+     * The dialog title. Cannot be displayed on some _Linux_ desktop environments.
+     */
+    title?: string;
+    /**
+     * Only when the platform supports it.
+     * Absolute directory path, absolute file path, or file name to use by default.
+     */
+    defaultPath?: string;
+    /**
+     * The list of file filters to apply to the dialog.
+     */
+    filters?: IFileFilter[];
+    /**
+     * Default false. By default the picker should include an option to not apply any file type filters.
+     * Setting this option to true means that option is not available.
+     *
+     * @platform web
+     */
+    excludeAcceptAllOption?: boolean;
+    /**
+     * When set to true multiple files may be selected.
+     * @platform web
+     */
+    multiple?: boolean;
+}
+export interface IOpenFileDialogResult {
+    /**
+     * Whether or not the dialog was canceled.
+     */
+    canceled: boolean;
+    /**
+     * If the dialog is cancelled this will be an empty array.
+     *
+     * In **electron** this is an array of file paths chosen by the user.
+     * In the **web** platform this is autogenerated list of ids to the file handles
+     * the app should use with the further communication.
+     */
+    filePath?: string[];
+}
+interface ReadWriteOptions {
+    /**
+     * Whether the `path` will no longer be used.
+     * This is relevant for the `web` environment when the bindings keep a reference to a file entry.
+     * This should always be set to true when the read/write operation is done only once.
+     */
+    dispose?: boolean;
+}
+export interface FileReadOptions extends ReadWriteOptions {
+    /**
+     * The type of the return value. It can be either an instance of a File or a string.
+     *
+     * @default string
+     */
+    returnType?: 'file' | 'string';
+}
+export interface FileWriteOptions extends ReadWriteOptions {
+    /**
+     * File encoding.
+     */
+    encoding?: 'utf8';
+}
+/**
+ * The base class for file access bindings.
+ */
+export declare abstract class FileBindings extends PlatformBindings {
+    initialize(): Promise<void>;
+    protected handleRequestSaveFile(e: Event): void;
+    protected handleRequestOpenFile(e: Event): void;
+    protected handleWriteFile(e: Event): void;
+    protected handleReadFile(e: Event): void;
+    /**
+     * Opens a dialog to pick a file to save.
+     *
+     * @param opts The dialog configuration.
+     */
+    abstract saveFileDialog(opts?: ISaveFileDialogInit): Promise<ISaveFileDialogResult>;
+    /**
+     * Opens a dialog to pick a file for reading.
+     *
+     * @param opts The dialog configuration.
+     */
+    abstract openFileDialog(opts?: IOpenFileDialogInit): Promise<IOpenFileDialogResult>;
+    /**
+     * Writes contents to the file.
+     *
+     * @param path The path returned by the `saveFileDialog()`.
+     * @param contents The contents to write to the file.
+     */
+    abstract writeFile(path: string, contents: BufferSource | Blob | string, opts?: FileWriteOptions): Promise<void>;
+    /**
+     * Reads file data.
+     * @param path The path returned by the `openFileDialog()`.
+     * @param returnType The type of the return value. It can be either a buffer or a string.
+     */
+    abstract readFile(path: string, opts?: FileReadOptions): Promise<ArrayBuffer | string>;
+    /**
+     * Disposes of previously created path with the `saveFileDialog()` or `openFileDialog()`.
+     * This is mandatory to call when during reading or writing to a file the `dispose` option
+     * is not set to true, after the file is no longer in use.
+     *
+     * @param path The previously created path.
+     */
+    abstract dispose(path: string): Promise<void>;
+}
+export {};
+//# sourceMappingURL=FileBindings.d.ts.map

package/build/src/bindings/base/FileBindings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileBindings.d.ts","sourceRoot":"","sources":["../../../../src/bindings/base/FileBindings.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAGxD,MAAM,WAAW,WAAW;IAC1B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;;;;;;;;;;OAYG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,EAAE,CAAA;IAEvB;;;;;OAKG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;CACjC;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAA;IAEjB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,EAAE,CAAA;IAEvB;;;;;OAKG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAEhC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAA;IAEjB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB;AAED,UAAU,gBAAgB;IACxB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;IACvD;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAA;CAC/B;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,8BAAsB,YAAa,SAAQ,gBAAgB;IACnD,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAOjC,SAAS,CAAC,qBAAqB,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI;IAK/C,SAAS,CAAC,qBAAqB,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI;IAK/C,SAAS,CAAC,eAAe,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI;IAUzC,SAAS,CAAC,cAAc,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI;IASxC;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAEnF;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAEnF;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,GAAG,IAAI,GAAG,MAAM,EAAE,IAAI,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAEhH;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,GAAG,MAAM,CAAC;IAEtF;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAC9C"}

package/build/src/bindings/base/FileBindings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileBindings.js","sourceRoot":"","sources":["../../../../src/bindings/base/FileBindings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AA6IxD;;GAEG;AACH,MAAM,OAAgB,YAAa,SAAQ,gBAAgB;IACzD,KAAK,CAAC,UAAU;QACd,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,UAAU,CAAC,eAAe,EAAE,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QACrG,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,UAAU,CAAC,eAAe,EAAE,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QACrG,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QACzF,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IACzF,CAAC;IAES,qBAAqB,CAAC,CAAQ;QACtC,MAAM,KAAK,GAAG,CAA2F,CAAA;QACzG,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IACjE,CAAC;IAES,qBAAqB,CAAC,CAAQ;QACtC,MAAM,KAAK,GAAG,CAA2F,CAAA;QACzG,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IACjE,CAAC;IAES,eAAe,CAAC,CAAQ;QAChC,MAAM,KAAK,GAAG,CAKZ,CAAA;QACF,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IACtG,CAAC;IAES,cAAc,CAAC,CAAQ;QAC/B,MAAM,KAAK,GAAG,CAIZ,CAAA;QACF,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAC9E,CAAC;CAuCF","sourcesContent":["import { EventTypes } from '../../events/EventTypes.js'\nimport { PlatformBindings } from './PlatformBindings.js'\n// import { EventTypes } from '../../events/EventTypes.js';\n\nexport interface IFileFilter {\n  /**\n   * An optional description of the category of files types allowed.\n   *\n   * @platform web\n   * @platform electron\n   */\n  description?: string\n  /**\n   * An Object with the keys set to the MIME type and the values an Array of file extensions.\n   *\n   * ```\n   * \"description\": \"Images\",\n   * \"accept\": {\n   *  'image/*': ['.png', '.gif', '.jpeg', '.jpg']\n   * }\n   * ```\n   *\n   * @platform web\n   * @platform electron\n   */\n  accept: Record<string, string[]>\n}\n\nexport interface ISaveFileDialogInit {\n  /**\n   * Only when the platform supports it.\n   * The dialog title. Cannot be displayed on some _Linux_ desktop environments.\n   */\n  title?: string\n  /**\n   * Only when the platform supports it.\n   * Absolute directory path, absolute file path, or file name to use by default.\n   */\n  defaultPath?: string\n\n  /**\n   * The list of file filters to apply to the dialog.\n   */\n  filters?: IFileFilter[]\n\n  /**\n   * Default false. By default the picker should include an option to not apply any file type filters.\n   * Setting this option to true means that option is not available.\n   *\n   * @platform web\n   */\n  excludeAcceptAllOption?: boolean\n}\n\nexport interface ISaveFileDialogResult {\n  /**\n   * Whether or not the dialog was canceled.\n   */\n  canceled: boolean\n\n  /**\n   * If the dialog is canceled, this will be `undefined`.\n   *\n   * In **electron** this is the path to the selected file.\n   * In the **web** platform this is autogenerated id to the file handle\n   * the app should use with the further communication.\n   */\n  filePath?: string\n}\n\nexport interface IOpenFileDialogInit {\n  /**\n   * Only when the platform supports it.\n   * The dialog title. Cannot be displayed on some _Linux_ desktop environments.\n   */\n  title?: string\n  /**\n   * Only when the platform supports it.\n   * Absolute directory path, absolute file path, or file name to use by default.\n   */\n  defaultPath?: string\n  /**\n   * The list of file filters to apply to the dialog.\n   */\n  filters?: IFileFilter[]\n\n  /**\n   * Default false. By default the picker should include an option to not apply any file type filters.\n   * Setting this option to true means that option is not available.\n   *\n   * @platform web\n   */\n  excludeAcceptAllOption?: boolean\n\n  /**\n   * When set to true multiple files may be selected.\n   * @platform web\n   */\n  multiple?: boolean\n}\n\nexport interface IOpenFileDialogResult {\n  /**\n   * Whether or not the dialog was canceled.\n   */\n  canceled: boolean\n\n  /**\n   * If the dialog is cancelled this will be an empty array.\n   *\n   * In **electron** this is an array of file paths chosen by the user.\n   * In the **web** platform this is autogenerated list of ids to the file handles\n   * the app should use with the further communication.\n   */\n  filePath?: string[]\n}\n\ninterface ReadWriteOptions {\n  /**\n   * Whether the `path` will no longer be used.\n   * This is relevant for the `web` environment when the bindings keep a reference to a file entry.\n   * This should always be set to true when the read/write operation is done only once.\n   */\n  dispose?: boolean\n}\n\nexport interface FileReadOptions extends ReadWriteOptions {\n  /**\n   * The type of the return value. It can be either an instance of a File or a string.\n   *\n   * @default string\n   */\n  returnType?: 'file' | 'string'\n}\n\nexport interface FileWriteOptions extends ReadWriteOptions {\n  /**\n   * File encoding.\n   */\n  encoding?: 'utf8'\n}\n\n/**\n * The base class for file access bindings.\n */\nexport abstract class FileBindings extends PlatformBindings {\n  async initialize(): Promise<void> {\n    window.addEventListener(EventTypes.Filesystem.requestSaveFile, this.handleRequestSaveFile.bind(this))\n    window.addEventListener(EventTypes.Filesystem.requestOpenFile, this.handleRequestOpenFile.bind(this))\n    window.addEventListener(EventTypes.Filesystem.writeFile, this.handleWriteFile.bind(this))\n    window.addEventListener(EventTypes.Filesystem.readFile, this.handleReadFile.bind(this))\n  }\n\n  protected handleRequestSaveFile(e: Event): void {\n    const event = e as CustomEvent<{ options?: ISaveFileDialogInit; result: Promise<ISaveFileDialogResult> }>\n    event.detail.result = this.saveFileDialog(event.detail.options)\n  }\n\n  protected handleRequestOpenFile(e: Event): void {\n    const event = e as CustomEvent<{ options?: IOpenFileDialogInit; result: Promise<IOpenFileDialogResult> }>\n    event.detail.result = this.openFileDialog(event.detail.options)\n  }\n\n  protected handleWriteFile(e: Event): void {\n    const event = e as CustomEvent<{\n      path: string\n      contents: BufferSource | Blob | string\n      options?: FileWriteOptions\n      result: Promise<void>\n    }>\n    event.detail.result = this.writeFile(event.detail.path, event.detail.contents, event.detail.options)\n  }\n\n  protected handleReadFile(e: Event): void {\n    const event = e as CustomEvent<{\n      path: string\n      options?: FileReadOptions\n      result: Promise<ArrayBuffer | string>\n    }>\n    event.detail.result = this.readFile(event.detail.path, event.detail.options)\n  }\n\n  /**\n   * Opens a dialog to pick a file to save.\n   *\n   * @param opts The dialog configuration.\n   */\n  abstract saveFileDialog(opts?: ISaveFileDialogInit): Promise<ISaveFileDialogResult>\n\n  /**\n   * Opens a dialog to pick a file for reading.\n   *\n   * @param opts The dialog configuration.\n   */\n  abstract openFileDialog(opts?: IOpenFileDialogInit): Promise<IOpenFileDialogResult>\n\n  /**\n   * Writes contents to the file.\n   *\n   * @param path The path returned by the `saveFileDialog()`.\n   * @param contents The contents to write to the file.\n   */\n  abstract writeFile(path: string, contents: BufferSource | Blob | string, opts?: FileWriteOptions): Promise<void>\n\n  /**\n   * Reads file data.\n   * @param path The path returned by the `openFileDialog()`.\n   * @param returnType The type of the return value. It can be either a buffer or a string.\n   */\n  abstract readFile(path: string, opts?: FileReadOptions): Promise<ArrayBuffer | string>\n\n  /**\n   * Disposes of previously created path with the `saveFileDialog()` or `openFileDialog()`.\n   * This is mandatory to call when during reading or writing to a file the `dispose` option\n   * is not set to true, after the file is no longer in use.\n   *\n   * @param path The previously created path.\n   */\n  abstract dispose(path: string): Promise<void>\n}\n"]}