@xwiki/cristal-backend-dexie 1.3.0 → 1.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xwiki/cristal-backend-dexie",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "license": "LGPL 2.1",
   "author": "XWiki Org Community <contact@xwiki.org>",
   "homepage": "https://cristal.xwiki.org/",
@@ -28,10 +28,10 @@
   "main": "./dist/index.es.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@xwiki/platform-api": "18.3.0",
-    "@xwiki/platform-backend-api": "18.3.0",
+    "@xwiki/platform-api": "18.4.0",
+    "@xwiki/platform-backend-api": "18.4.0",
     "dexie": "4.3.0",
-    "@xwiki/cristal-sharedworker-api": "1.3.0"
+    "@xwiki/cristal-sharedworker-api": "1.4.0"
   },
   "peerDependencies": {
     "inversify": "8.x",
@@ -42,7 +42,7 @@
     "reflect-metadata": "0.2.2",
     "typescript": "5.9.3",
     "vite": "7.3.2",
-    "@xwiki/cristal-dev-config": "1.3.0"
+    "@xwiki/cristal-dev-config": "1.4.0"
   },
   "scripts": {
     "api-extractor:local": "api-extractor run --local",

package/dist/dexieOfflineStorage.d.ts

@@ -1,12 +0,0 @@
-import { default as DexiePageStorage } from './dexiePageStorage';
-import { Logger, PageData } from '@xwiki/platform-api';
-import { OfflineStorage } from '@xwiki/platform-backend-api';
-export default class DexieOfflineStorage implements OfflineStorage {
-    private pageStorageMap;
-    private logger;
-    constructor(logger: Logger);
-    getPageStorage(wikiName: string): DexiePageStorage;
-    getPage(wikiName: string, id: string): Promise<PageData | undefined>;
-    savePage(wikiName: string, id: string, page: PageData): Promise<void>;
-    updatePage(wikiName: string, id: string, page: PageData): Promise<void>;
-}

package/dist/dexiePageStorage.d.ts

@@ -1,5 +0,0 @@
-import { default as Dexie, Table } from 'dexie';
-export default class DexiePageStorage extends Dexie {
-    pages: Table<object>;
-    constructor(wikiName: string);
-}

package/dist/index.d.cts

@@ -1,7 +0,0 @@
-import { Container } from 'inversify';
-/**
- * @beta
- */
-export declare class ComponentInit {
-    constructor(container: Container);
-}

package/dist/index.d.ts

@@ -1,7 +0,0 @@
-import { Container } from 'inversify';
-/**
- * @beta
- */
-export declare class ComponentInit {
-    constructor(container: Container);
-}

package/dist/index.es.js

@@ -1,199 +0,0 @@
-import h from "dexie";
-import { DefaultPageData as f } from "@xwiki/platform-api";
-import { injectable as u, inject as i } from "inversify";
-class d extends h {
-  pages;
-  constructor(t) {
-    super("pages_" + t), this.version(2).stores({
-      pages: (
-        // Primary key and indexed props
-        "id, name, content, document, css, js, document.name, document.headline, document.creator"
-      )
-    });
-  }
-}
-var p = Object.getOwnPropertyDescriptor, S = (e, t, g, o) => {
-  for (var r = o > 1 ? void 0 : o ? p(t, g) : t, a = e.length - 1, s; a >= 0; a--)
-    (s = e[a]) && (r = s(r) || r);
-  return r;
-}, m = (e, t) => (g, o) => t(g, o, e);
-let l = class {
-  pageStorageMap = /* @__PURE__ */ new Map();
-  logger;
-  constructor(e) {
-    this.logger = e, this.logger.setModule("storage.components.dexieOfflineStorage");
-  }
-  getPageStorage(e) {
-    let t = this.pageStorageMap.get(e);
-    return t == null && (t = new d(e), this.pageStorageMap.set(e, t)), t;
-  }
-  async getPage(e, t) {
-    try {
-      this.logger.debug("Ready to load page from local storage", t);
-      const g = this.getPageStorage(e);
-      this.logger.debug("pageStorage is ready, asking for page");
-      const o = await g.pages.get(t), r = new f();
-      return r.fromObject(o), r;
-    } catch (g) {
-      this.logger.debug("Exception while trying to read from local storage", g);
-      return;
-    }
-  }
-  async savePage(e, t, g) {
-    try {
-      await this.getPageStorage(e).pages.put(g.toObject(), t);
-    } catch (o) {
-      this.logger.debug(
-        "Exception while trying to store in local storage",
-        e,
-        t,
-        g,
-        o
-      );
-    }
-  }
-  async updatePage(e, t, g) {
-    try {
-      const o = this.getPageStorage(e);
-      this.logger.debug("Ready to store", g), await o.pages.update(t, g.toObject());
-    } catch (o) {
-      this.logger.debug(
-        "Exception while trying to store in local storage",
-        e,
-        t,
-        g,
-        o
-      );
-    }
-  }
-};
-l = S([
-  u(),
-  m(0, i("Logger"))
-], l);
-var v = Object.getOwnPropertyDescriptor, P = (e, t, g, o) => {
-  for (var r = o > 1 ? void 0 : o ? v(t, g) : t, a = e.length - 1, s; a >= 0; a--)
-    (s = e[a]) && (r = s(r) || r);
-  return r;
-}, n = (e, t) => (g, o) => t(g, o, e);
-let c = class {
-  logger;
-  // @ts-expect-error storage can be temporarily undefined during class
-  // initialization
-  storage;
-  offlineStorage;
-  queueWorker;
-  constructor(e, t, g) {
-    this.logger = e, this.logger.setModule("storage.components.wrappingOfflineStorage"), this.offlineStorage = t, this.queueWorker = g;
-  }
-  setStorage(e) {
-    this.storage = e;
-  }
-  getStorage() {
-    return this.storage;
-  }
-  setWikiConfig(e) {
-    return this.storage.setWikiConfig(e);
-  }
-  getWikiConfig() {
-    return this.storage.getWikiConfig();
-  }
-  async isStorageReady() {
-    return this.storage.isStorageReady();
-  }
-  getPageRestURL(e, t) {
-    return this.storage.getPageRestURL(e, t);
-  }
-  getPageFromViewURL(e) {
-    return this.storage.getPageFromViewURL(e);
-  }
-  getImageURL(e, t) {
-    return this.storage.getImageURL(e, t);
-  }
-  // TODO: reduce the number of statements in the following method and reactivate the disabled eslint rule.
-  // eslint-disable-next-line max-statements
-  async getPageContent(e, t, g, o) {
-    if (this.logger.debug("Trying to get data for page ", e), this.offlineStorage) {
-      this.logger.debug("Asking offline storage for ", e);
-      const r = await this.offlineStorage.getPage(
-        this.getWikiConfig().name,
-        e + "_" + t
-      );
-      return r != null && r != null ? (this.logger.debug("Loading data from local storage for page", e), (o == null || o) && this.queueWorker.addToQueue(
-        this.getWikiConfig().name + ":" + e + "_" + t
-      ), r) : (this.logger.debug(
-        "Could not find data in local storage for page",
-        e
-      ), this.savePageContent(e, t));
-    } else
-      return this.logger.debug("No offline local storage available"), this.storage.getPageContent(e, t);
-  }
-  getAttachments(e) {
-    return this.storage.getAttachments(e);
-  }
-  getAttachment(e, t) {
-    return this.storage.getAttachment(e, t);
-  }
-  async savePageContent(e, t) {
-    const g = await this.storage.getPageContent(e, t);
-    if (g)
-      return g.id = e + "_" + t, this.logger.debug("Saving page to offline storage", e), this.offlineStorage.savePage(
-        this.getWikiConfig().name,
-        e + "_" + t,
-        g
-      ), g;
-    throw new Error("Can't save missing page.");
-  }
-  // TODO: reduce the number of statements in the following method and reactivate the disabled eslint rule.
-  // eslint-disable-next-line max-statements
-  async updatePageContent(e, t) {
-    const g = await this.offlineStorage.getPage(
-      this.getWikiConfig().name,
-      e + "_" + t
-    ), o = await this.storage.getPageContent(e, t);
-    return g && o ? (o.id = e + "_" + t, this.logger.debug("Saving page to offline storage", e), this.offlineStorage.savePage(
-      this.getWikiConfig().name,
-      e + "_" + t,
-      o
-    ), !0) : g?.version != o?.version && o ? (o.id = e + "_" + t, this.logger.debug("Updating page to offline storage", e), this.offlineStorage.updatePage(
-      this.getWikiConfig().name,
-      e + "_" + t,
-      o
-    ), !0) : (this.logger.debug(
-      "Local storage not updated, because version are identical"
-    ), !1);
-  }
-  async getPanelContent(e, t, g) {
-    return this.storage.getPanelContent(e, t, g);
-  }
-  async getEditField(e, t) {
-    return await this.storage.getEditField(e, t);
-  }
-  save(e, t, g, o) {
-    return this.storage.save(e, t, g, o);
-  }
-  async saveAttachments(e, t) {
-    return this.storage.saveAttachments(e, t);
-  }
-  async delete(e) {
-    return this.storage.delete(e);
-  }
-  async move(e, t, g) {
-    return this.storage.move(e, t, g);
-  }
-};
-c = P([
-  u(),
-  n(0, i("Logger")),
-  n(1, i("OfflineStorage")),
-  n(2, i("QueueWorker"))
-], c);
-class w {
-  constructor(t) {
-    t.bind("WrappingStorage").to(c).inSingletonScope(), t.bind("OfflineStorage").to(l).inSingletonScope();
-  }
-}
-export {
-  w as ComponentInit
-};
-//# sourceMappingURL=index.es.js.map

package/dist/index.es.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.es.js","sources":["../src/dexiePageStorage.ts","../src/dexieOfflineStorage.ts","../src/wrappingOfflineStorage.ts","../src/index.ts"],"sourcesContent":["/**\n * See the LICENSE file distributed with this work for additional\n * information regarding copyright ownership.\n *\n * This is free software; you can redistribute it and/or modify it\n * under the terms of the GNU Lesser General Public License as\n * published by the Free Software Foundation; either version 2.1 of\n * the License, or (at your option) any later version.\n *\n * This software is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n * Lesser General Public License for more details.\n *\n * You should have received a copy of the GNU Lesser General Public\n * License along with this software; if not, write to the Free\n * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA\n * 02110-1301 USA, or see the FSF site: http://www.fsf.org.\n */\n\nimport { default as Dexie } from \"dexie\";\nimport type { Table } from \"dexie\";\n\nexport default class DexiePageStorage extends Dexie {\n  pages!: Table<object>;\n\n  constructor(wikiName: string) {\n    super(\"pages_\" + wikiName);\n    this.version(2).stores({\n      pages:\n        // Primary key and indexed props\n        \"id, name, content, document, css, js, document.name, document.headline, document.creator\",\n    });\n  }\n}\n","/**\n * See the LICENSE file distributed with this work for additional\n * information regarding copyright ownership.\n *\n * This is free software; you can redistribute it and/or modify it\n * under the terms of the GNU Lesser General Public License as\n * published by the Free Software Foundation; either version 2.1 of\n * the License, or (at your option) any later version.\n *\n * This software is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n * Lesser General Public License for more details.\n *\n * You should have received a copy of the GNU Lesser General Public\n * License along with this software; if not, write to the Free\n * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA\n * 02110-1301 USA, or see the FSF site: http://www.fsf.org.\n */\n\nimport DexiePageStorage from \"./dexiePageStorage\";\nimport { DefaultPageData } from \"@xwiki/platform-api\";\nimport { inject, injectable } from \"inversify\";\nimport type { Logger, PageData } from \"@xwiki/platform-api\";\nimport type { OfflineStorage } from \"@xwiki/platform-backend-api\";\n\n@injectable()\nexport default class DexieOfflineStorage implements OfflineStorage {\n  private pageStorageMap: Map<string, DexiePageStorage> = new Map<\n    string,\n    DexiePageStorage\n  >();\n  private logger: Logger;\n\n  constructor(@inject(\"Logger\") logger: Logger) {\n    this.logger = logger;\n    this.logger.setModule(\"storage.components.dexieOfflineStorage\");\n  }\n\n  getPageStorage(wikiName: string): DexiePageStorage {\n    let pageStorage = this.pageStorageMap.get(wikiName);\n    if (pageStorage == null) {\n      pageStorage = new DexiePageStorage(wikiName);\n      this.pageStorageMap.set(wikiName, pageStorage);\n    }\n    return pageStorage;\n  }\n\n  async getPage(wikiName: string, id: string): Promise<PageData | undefined> {\n    try {\n      this.logger.debug(\"Ready to load page from local storage\", id);\n      const pageStorage = this.getPageStorage(wikiName);\n      this.logger.debug(\"pageStorage is ready, asking for page\");\n      const pageObject = await pageStorage.pages.get(id);\n      const pageData = new DefaultPageData();\n      pageData.fromObject(pageObject);\n      return pageData;\n    } catch (e) {\n      this.logger.debug(\"Exception while trying to read from local storage\", e);\n      return undefined;\n    }\n  }\n\n  async savePage(wikiName: string, id: string, page: PageData): Promise<void> {\n    try {\n      const pageStorage = this.getPageStorage(wikiName);\n      // Put must be used instead of get since the later does not allow for\n      // content update.\n      await pageStorage.pages.put(page.toObject(), id);\n    } catch (e) {\n      this.logger.debug(\n        \"Exception while trying to store in local storage\",\n        wikiName,\n        id,\n        page,\n        e,\n      );\n    }\n  }\n\n  async updatePage(\n    wikiName: string,\n    id: string,\n    page: PageData,\n  ): Promise<void> {\n    try {\n      const pageStorage = this.getPageStorage(wikiName);\n      this.logger.debug(\"Ready to store\", page);\n      await pageStorage.pages.update(id, page.toObject());\n    } catch (e) {\n      this.logger.debug(\n        \"Exception while trying to store in local storage\",\n        wikiName,\n        id,\n        page,\n        e,\n      );\n    }\n  }\n}\n","/**\n * See the LICENSE file distributed with this work for additional\n * information regarding copyright ownership.\n *\n * This is free software; you can redistribute it and/or modify it\n * under the terms of the GNU Lesser General Public License as\n * published by the Free Software Foundation; either version 2.1 of\n * the License, or (at your option) any later version.\n *\n * This software is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n * Lesser General Public License for more details.\n *\n * You should have received a copy of the GNU Lesser General Public\n * License along with this software; if not, write to the Free\n * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA\n * 02110-1301 USA, or see the FSF site: http://www.fsf.org.\n */\n\nimport { inject, injectable } from \"inversify\";\nimport type { QueueWorker } from \"@xwiki/cristal-sharedworker-api\";\nimport type {\n  AttachmentsData,\n  Document,\n  Logger,\n  PageAttachment,\n  PageData,\n  Storage,\n  WikiConfig,\n  WrappingStorage,\n} from \"@xwiki/platform-api\";\nimport type { OfflineStorage } from \"@xwiki/platform-backend-api\";\n\n@injectable()\nexport class WrappingOfflineStorage implements WrappingStorage {\n  public logger: Logger;\n  // @ts-expect-error storage can be temporarily undefined during class\n  // initialization\n  public storage: Storage;\n  public offlineStorage: OfflineStorage;\n  public queueWorker: QueueWorker;\n\n  constructor(\n    @inject(\"Logger\") logger: Logger,\n    @inject(\"OfflineStorage\") offlineStorage: OfflineStorage,\n    @inject(\"QueueWorker\") queueWorker: QueueWorker,\n  ) {\n    this.logger = logger;\n    this.logger.setModule(\"storage.components.wrappingOfflineStorage\");\n    this.offlineStorage = offlineStorage;\n    this.queueWorker = queueWorker;\n  }\n\n  public setStorage(storage: Storage): void {\n    this.storage = storage;\n  }\n\n  public getStorage(): Storage {\n    return this.storage;\n  }\n\n  public setWikiConfig(config: WikiConfig): void {\n    return this.storage.setWikiConfig(config);\n  }\n\n  public getWikiConfig(): WikiConfig {\n    return this.storage.getWikiConfig();\n  }\n\n  public async isStorageReady(): Promise<boolean> {\n    return this.storage.isStorageReady();\n  }\n\n  public getPageRestURL(page: string, syntax: string): string {\n    return this.storage.getPageRestURL(page, syntax);\n  }\n\n  public getPageFromViewURL(url: string): string | null {\n    return this.storage.getPageFromViewURL(url);\n  }\n\n  public getImageURL(page: string, image: string): string {\n    return this.storage.getImageURL(page, image);\n  }\n\n  // TODO: reduce the number of statements in the following method and reactivate the disabled eslint rule.\n  // eslint-disable-next-line max-statements\n  public async getPageContent(\n    page: string,\n    syntax: string,\n    _revision?: string,\n    requeue?: boolean,\n  ): Promise<PageData | undefined> {\n    this.logger.debug(\"Trying to get data for page \", page);\n    if (this.offlineStorage) {\n      this.logger.debug(\"Asking offline storage for \", page);\n      const pageData = await this.offlineStorage.getPage(\n        this.getWikiConfig().name,\n        page + \"_\" + syntax,\n      );\n      if (pageData != null && pageData != undefined) {\n        this.logger.debug(\"Loading data from local storage for page\", page);\n        // Adding page to refresh queue in shared worker\n        if (requeue == undefined || requeue) {\n          this.queueWorker.addToQueue(\n            this.getWikiConfig().name + \":\" + page + \"_\" + syntax,\n          );\n        }\n        return pageData;\n      } else {\n        this.logger.debug(\n          \"Could not find data in local storage for page\",\n          page,\n        );\n        return this.savePageContent(page, syntax);\n      }\n    } else {\n      this.logger.debug(\"No offline local storage available\");\n      return this.storage.getPageContent(page, syntax);\n    }\n  }\n\n  public getAttachments(page: string): Promise<AttachmentsData | undefined> {\n    // TODO: add support for offline storage of attachments.\n    return this.storage.getAttachments(page);\n  }\n\n  getAttachment(\n    page: string,\n    name: string,\n  ): Promise<PageAttachment | undefined> {\n    return this.storage.getAttachment(page, name);\n  }\n\n  private async savePageContent(\n    page: string,\n    syntax: string,\n  ): Promise<PageData> {\n    const pageData = await this.storage.getPageContent(page, syntax);\n    if (pageData) {\n      pageData.id = page + \"_\" + syntax;\n      this.logger.debug(\"Saving page to offline storage\", page);\n      this.offlineStorage.savePage(\n        this.getWikiConfig().name,\n        page + \"_\" + syntax,\n        pageData,\n      );\n\n      return pageData;\n    } else {\n      throw new Error(\"Can't save missing page.\");\n    }\n  }\n\n  // TODO: reduce the number of statements in the following method and reactivate the disabled eslint rule.\n  // eslint-disable-next-line max-statements\n  public async updatePageContent(\n    page: string,\n    syntax: string,\n  ): Promise<boolean> {\n    const currentPageData = await this.offlineStorage.getPage(\n      this.getWikiConfig().name,\n      page + \"_\" + syntax,\n    );\n    const pageData = await this.storage.getPageContent(page, syntax);\n    if (currentPageData && pageData) {\n      pageData.id = page + \"_\" + syntax;\n      this.logger.debug(\"Saving page to offline storage\", page);\n      this.offlineStorage.savePage(\n        this.getWikiConfig().name,\n        page + \"_\" + syntax,\n        pageData,\n      );\n      return true;\n    } else if (currentPageData?.version != pageData?.version && pageData) {\n      pageData.id = page + \"_\" + syntax;\n      this.logger.debug(\"Updating page to offline storage\", page);\n      this.offlineStorage.updatePage(\n        this.getWikiConfig().name,\n        page + \"_\" + syntax,\n        pageData,\n      );\n      return true;\n    } else {\n      this.logger.debug(\n        \"Local storage not updated, because version are identical\",\n      );\n      return false;\n    }\n  }\n\n  public async getPanelContent(\n    panel: string,\n    contextPage: string,\n    syntax: string,\n  ): Promise<PageData> {\n    return this.storage.getPanelContent(panel, contextPage, syntax);\n  }\n\n  public async getEditField(\n    document: Document,\n    fieldName: string,\n  ): Promise<string> {\n    return await this.storage.getEditField(document, fieldName);\n  }\n\n  save(\n    page: string,\n    title: string,\n    content: string,\n    syntax: string,\n  ): Promise<unknown> {\n    return this.storage.save(page, title, content, syntax);\n  }\n\n  async saveAttachments(\n    page: string,\n    files: File[],\n  ): Promise<undefined | (undefined | string)[]> {\n    return this.storage.saveAttachments(page, files);\n  }\n\n  async delete(page: string): Promise<{ success: boolean; error?: string }> {\n    return this.storage.delete(page);\n  }\n\n  async move(\n    page: string,\n    newPage: string,\n    preserveChildren: boolean,\n  ): Promise<{ success: boolean; error?: string }> {\n    return this.storage.move(page, newPage, preserveChildren);\n  }\n}\n","/**\n * See the LICENSE file distributed with this work for additional\n * information regarding copyright ownership.\n *\n * This is free software; you can redistribute it and/or modify it\n * under the terms of the GNU Lesser General Public License as\n * published by the Free Software Foundation; either version 2.1 of\n * the License, or (at your option) any later version.\n *\n * This software is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n * Lesser General Public License for more details.\n *\n * You should have received a copy of the GNU Lesser General Public\n * License along with this software; if not, write to the Free\n * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA\n * 02110-1301 USA, or see the FSF site: http://www.fsf.org.\n */\n\nimport DexieOfflineStorage from \"./dexieOfflineStorage\";\nimport { WrappingOfflineStorage } from \"./wrappingOfflineStorage\";\nimport { Container } from \"inversify\";\nimport type { WrappingStorage } from \"@xwiki/platform-api\";\nimport type { OfflineStorage } from \"@xwiki/platform-backend-api\";\n\n/**\n * @beta\n */\nexport class ComponentInit {\n  constructor(container: Container) {\n    container\n      .bind<WrappingStorage>(\"WrappingStorage\")\n      .to(WrappingOfflineStorage)\n      .inSingletonScope();\n    container\n      .bind<OfflineStorage>(\"OfflineStorage\")\n      .to(DexieOfflineStorage)\n      .inSingletonScope();\n  }\n}\n"],"names":["DexiePageStorage","Dexie","wikiName","DexieOfflineStorage","logger","pageStorage","id","pageObject","pageData","DefaultPageData","e","page","__decorateClass","injectable","__decorateParam","WrappingOfflineStorage","offlineStorage","queueWorker","storage","config","syntax","url","image","_revision","requeue","name","currentPageData","panel","contextPage","document","fieldName","title","content","files","newPage","preserveChildren","ComponentInit","container"],"mappings":";;;AAuBA,MAAqBA,UAAyBC,EAAM;AAAA,EAClD;AAAA,EAEA,YAAYC,GAAkB;AAC5B,UAAM,WAAWA,CAAQ,GACzB,KAAK,QAAQ,CAAC,EAAE,OAAO;AAAA,MACrB;AAAA;AAAA,QAEE;AAAA;AAAA,IAAA,CACH;AAAA,EACH;AACF;;;;;;ACPA,IAAqBC,IAArB,MAAmE;AAAA,EACzD,qCAAoD,IAAA;AAAA,EAIpD;AAAA,EAER,YAA8BC,GAAgB;AAC5C,SAAK,SAASA,GACd,KAAK,OAAO,UAAU,wCAAwC;AAAA,EAChE;AAAA,EAEA,eAAeF,GAAoC;AACjD,QAAIG,IAAc,KAAK,eAAe,IAAIH,CAAQ;AAClD,WAAIG,KAAe,SACjBA,IAAc,IAAIL,EAAiBE,CAAQ,GAC3C,KAAK,eAAe,IAAIA,GAAUG,CAAW,IAExCA;AAAA,EACT;AAAA,EAEA,MAAM,QAAQH,GAAkBI,GAA2C;AACzE,QAAI;AACF,WAAK,OAAO,MAAM,yCAAyCA,CAAE;AAC7D,YAAMD,IAAc,KAAK,eAAeH,CAAQ;AAChD,WAAK,OAAO,MAAM,uCAAuC;AACzD,YAAMK,IAAa,MAAMF,EAAY,MAAM,IAAIC,CAAE,GAC3CE,IAAW,IAAIC,EAAA;AACrB,aAAAD,EAAS,WAAWD,CAAU,GACvBC;AAAA,IACT,SAASE,GAAG;AACV,WAAK,OAAO,MAAM,qDAAqDA,CAAC;AACxE;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,SAASR,GAAkBI,GAAYK,GAA+B;AAC1E,QAAI;AAIF,YAHoB,KAAK,eAAeT,CAAQ,EAG9B,MAAM,IAAIS,EAAK,SAAA,GAAYL,CAAE;AAAA,IACjD,SAASI,GAAG;AACV,WAAK,OAAO;AAAA,QACV;AAAA,QACAR;AAAA,QACAI;AAAA,QACAK;AAAA,QACAD;AAAA,MAAA;AAAA,IAEJ;AAAA,EACF;AAAA,EAEA,MAAM,WACJR,GACAI,GACAK,GACe;AACf,QAAI;AACF,YAAMN,IAAc,KAAK,eAAeH,CAAQ;AAChD,WAAK,OAAO,MAAM,kBAAkBS,CAAI,GACxC,MAAMN,EAAY,MAAM,OAAOC,GAAIK,EAAK,UAAU;AAAA,IACpD,SAASD,GAAG;AACV,WAAK,OAAO;AAAA,QACV;AAAA,QACAR;AAAA,QACAI;AAAA,QACAK;AAAA,QACAD;AAAA,MAAA;AAAA,IAEJ;AAAA,EACF;AACF;AAxEqBP,IAArBS,EAAA;AAAA,EADCC,EAAA;AAAA,EAQcC,OAAO,QAAQ,CAAA;AAAA,GAPTX,CAAA;;;;;;ACQd,IAAMY,IAAN,MAAwD;AAAA,EACtD;AAAA;AAAA;AAAA,EAGA;AAAA,EACA;AAAA,EACA;AAAA,EAEP,YACoBX,GACQY,GACHC,GACvB;AACA,SAAK,SAASb,GACd,KAAK,OAAO,UAAU,2CAA2C,GACjE,KAAK,iBAAiBY,GACtB,KAAK,cAAcC;AAAA,EACrB;AAAA,EAEO,WAAWC,GAAwB;AACxC,SAAK,UAAUA;AAAA,EACjB;AAAA,EAEO,aAAsB;AAC3B,WAAO,KAAK;AAAA,EACd;AAAA,EAEO,cAAcC,GAA0B;AAC7C,WAAO,KAAK,QAAQ,cAAcA,CAAM;AAAA,EAC1C;AAAA,EAEO,gBAA4B;AACjC,WAAO,KAAK,QAAQ,cAAA;AAAA,EACtB;AAAA,EAEA,MAAa,iBAAmC;AAC9C,WAAO,KAAK,QAAQ,eAAA;AAAA,EACtB;AAAA,EAEO,eAAeR,GAAcS,GAAwB;AAC1D,WAAO,KAAK,QAAQ,eAAeT,GAAMS,CAAM;AAAA,EACjD;AAAA,EAEO,mBAAmBC,GAA4B;AACpD,WAAO,KAAK,QAAQ,mBAAmBA,CAAG;AAAA,EAC5C;AAAA,EAEO,YAAYV,GAAcW,GAAuB;AACtD,WAAO,KAAK,QAAQ,YAAYX,GAAMW,CAAK;AAAA,EAC7C;AAAA;AAAA;AAAA,EAIA,MAAa,eACXX,GACAS,GACAG,GACAC,GAC+B;AAE/B,QADA,KAAK,OAAO,MAAM,gCAAgCb,CAAI,GAClD,KAAK,gBAAgB;AACvB,WAAK,OAAO,MAAM,+BAA+BA,CAAI;AACrD,YAAMH,IAAW,MAAM,KAAK,eAAe;AAAA,QACzC,KAAK,gBAAgB;AAAA,QACrBG,IAAO,MAAMS;AAAA,MAAA;AAEf,aAAIZ,KAAY,QAAQA,KAAY,QAClC,KAAK,OAAO,MAAM,4CAA4CG,CAAI,IAE9Da,KAAW,QAAaA,MAC1B,KAAK,YAAY;AAAA,QACf,KAAK,cAAA,EAAgB,OAAO,MAAMb,IAAO,MAAMS;AAAA,MAAA,GAG5CZ,MAEP,KAAK,OAAO;AAAA,QACV;AAAA,QACAG;AAAA,MAAA,GAEK,KAAK,gBAAgBA,GAAMS,CAAM;AAAA,IAE5C;AACE,kBAAK,OAAO,MAAM,oCAAoC,GAC/C,KAAK,QAAQ,eAAeT,GAAMS,CAAM;AAAA,EAEnD;AAAA,EAEO,eAAeT,GAAoD;AAExE,WAAO,KAAK,QAAQ,eAAeA,CAAI;AAAA,EACzC;AAAA,EAEA,cACEA,GACAc,GACqC;AACrC,WAAO,KAAK,QAAQ,cAAcd,GAAMc,CAAI;AAAA,EAC9C;AAAA,EAEA,MAAc,gBACZd,GACAS,GACmB;AACnB,UAAMZ,IAAW,MAAM,KAAK,QAAQ,eAAeG,GAAMS,CAAM;AAC/D,QAAIZ;AACF,aAAAA,EAAS,KAAKG,IAAO,MAAMS,GAC3B,KAAK,OAAO,MAAM,kCAAkCT,CAAI,GACxD,KAAK,eAAe;AAAA,QAClB,KAAK,gBAAgB;AAAA,QACrBA,IAAO,MAAMS;AAAA,QACbZ;AAAA,MAAA,GAGKA;AAEP,UAAM,IAAI,MAAM,0BAA0B;AAAA,EAE9C;AAAA;AAAA;AAAA,EAIA,MAAa,kBACXG,GACAS,GACkB;AAClB,UAAMM,IAAkB,MAAM,KAAK,eAAe;AAAA,MAChD,KAAK,gBAAgB;AAAA,MACrBf,IAAO,MAAMS;AAAA,IAAA,GAETZ,IAAW,MAAM,KAAK,QAAQ,eAAeG,GAAMS,CAAM;AAC/D,WAAIM,KAAmBlB,KACrBA,EAAS,KAAKG,IAAO,MAAMS,GAC3B,KAAK,OAAO,MAAM,kCAAkCT,CAAI,GACxD,KAAK,eAAe;AAAA,MAClB,KAAK,gBAAgB;AAAA,MACrBA,IAAO,MAAMS;AAAA,MACbZ;AAAA,IAAA,GAEK,MACEkB,GAAiB,WAAWlB,GAAU,WAAWA,KAC1DA,EAAS,KAAKG,IAAO,MAAMS,GAC3B,KAAK,OAAO,MAAM,oCAAoCT,CAAI,GAC1D,KAAK,eAAe;AAAA,MAClB,KAAK,gBAAgB;AAAA,MACrBA,IAAO,MAAMS;AAAA,MACbZ;AAAA,IAAA,GAEK,OAEP,KAAK,OAAO;AAAA,MACV;AAAA,IAAA,GAEK;AAAA,EAEX;AAAA,EAEA,MAAa,gBACXmB,GACAC,GACAR,GACmB;AACnB,WAAO,KAAK,QAAQ,gBAAgBO,GAAOC,GAAaR,CAAM;AAAA,EAChE;AAAA,EAEA,MAAa,aACXS,GACAC,GACiB;AACjB,WAAO,MAAM,KAAK,QAAQ,aAAaD,GAAUC,CAAS;AAAA,EAC5D;AAAA,EAEA,KACEnB,GACAoB,GACAC,GACAZ,GACkB;AAClB,WAAO,KAAK,QAAQ,KAAKT,GAAMoB,GAAOC,GAASZ,CAAM;AAAA,EACvD;AAAA,EAEA,MAAM,gBACJT,GACAsB,GAC6C;AAC7C,WAAO,KAAK,QAAQ,gBAAgBtB,GAAMsB,CAAK;AAAA,EACjD;AAAA,EAEA,MAAM,OAAOtB,GAA6D;AACxE,WAAO,KAAK,QAAQ,OAAOA,CAAI;AAAA,EACjC;AAAA,EAEA,MAAM,KACJA,GACAuB,GACAC,GAC+C;AAC/C,WAAO,KAAK,QAAQ,KAAKxB,GAAMuB,GAASC,CAAgB;AAAA,EAC1D;AACF;AAvMapB,IAANH,EAAA;AAAA,EADNC,EAAA;AAAA,EAUIC,OAAO,QAAQ,CAAA;AAAA,EACfA,OAAO,gBAAgB,CAAA;AAAA,EACvBA,OAAO,aAAa,CAAA;AAAA,GAXZC,CAAA;ACNN,MAAMqB,EAAc;AAAA,EACzB,YAAYC,GAAsB;AAChC,IAAAA,EACG,KAAsB,iBAAiB,EACvC,GAAGtB,CAAsB,EACzB,iBAAA,GACHsB,EACG,KAAqB,gBAAgB,EACrC,GAAGlC,CAAmB,EACtB,iBAAA;AAAA,EACL;AACF;"}

package/dist/index.umd.js

@@ -1,2 +0,0 @@
-(function(g,n){typeof exports=="object"&&typeof module<"u"?n(exports,require("dexie"),require("@xwiki/platform-api"),require("inversify")):typeof define=="function"&&define.amd?define(["exports","dexie","@xwiki/platform-api","inversify"],n):(g=typeof globalThis<"u"?globalThis:g||self,n(g["cristal_backend-dexie"]={},g.Dexie,g.platformApi,g.inversify))})(this,(function(g,n,h,s){"use strict";class d extends n{pages;constructor(t){super("pages_"+t),this.version(2).stores({pages:"id, name, content, document, css, js, document.name, document.headline, document.creator"})}}var p=Object.getOwnPropertyDescriptor,S=(e,t,o,r)=>{for(var a=r>1?void 0:r?p(t,o):t,i=e.length-1,l;i>=0;i--)(l=e[i])&&(a=l(a)||a);return a},m=(e,t)=>(o,r)=>t(o,r,e);let c=class{pageStorageMap=new Map;logger;constructor(e){this.logger=e,this.logger.setModule("storage.components.dexieOfflineStorage")}getPageStorage(e){let t=this.pageStorageMap.get(e);return t==null&&(t=new d(e),this.pageStorageMap.set(e,t)),t}async getPage(e,t){try{this.logger.debug("Ready to load page from local storage",t);const o=this.getPageStorage(e);this.logger.debug("pageStorage is ready, asking for page");const r=await o.pages.get(t),a=new h.DefaultPageData;return a.fromObject(r),a}catch(o){this.logger.debug("Exception while trying to read from local storage",o);return}}async savePage(e,t,o){try{await this.getPageStorage(e).pages.put(o.toObject(),t)}catch(r){this.logger.debug("Exception while trying to store in local storage",e,t,o,r)}}async updatePage(e,t,o){try{const r=this.getPageStorage(e);this.logger.debug("Ready to store",o),await r.pages.update(t,o.toObject())}catch(r){this.logger.debug("Exception while trying to store in local storage",e,t,o,r)}}};c=S([s.injectable(),m(0,s.inject("Logger"))],c);var P=Object.getOwnPropertyDescriptor,v=(e,t,o,r)=>{for(var a=r>1?void 0:r?P(t,o):t,i=e.length-1,l;i>=0;i--)(l=e[i])&&(a=l(a)||a);return a},u=(e,t)=>(o,r)=>t(o,r,e);let f=class{logger;storage;offlineStorage;queueWorker;constructor(e,t,o){this.logger=e,this.logger.setModule("storage.components.wrappingOfflineStorage"),this.offlineStorage=t,this.queueWorker=o}setStorage(e){this.storage=e}getStorage(){return this.storage}setWikiConfig(e){return this.storage.setWikiConfig(e)}getWikiConfig(){return this.storage.getWikiConfig()}async isStorageReady(){return this.storage.isStorageReady()}getPageRestURL(e,t){return this.storage.getPageRestURL(e,t)}getPageFromViewURL(e){return this.storage.getPageFromViewURL(e)}getImageURL(e,t){return this.storage.getImageURL(e,t)}async getPageContent(e,t,o,r){if(this.logger.debug("Trying to get data for page ",e),this.offlineStorage){this.logger.debug("Asking offline storage for ",e);const a=await this.offlineStorage.getPage(this.getWikiConfig().name,e+"_"+t);return a!=null&&a!=null?(this.logger.debug("Loading data from local storage for page",e),(r==null||r)&&this.queueWorker.addToQueue(this.getWikiConfig().name+":"+e+"_"+t),a):(this.logger.debug("Could not find data in local storage for page",e),this.savePageContent(e,t))}else return this.logger.debug("No offline local storage available"),this.storage.getPageContent(e,t)}getAttachments(e){return this.storage.getAttachments(e)}getAttachment(e,t){return this.storage.getAttachment(e,t)}async savePageContent(e,t){const o=await this.storage.getPageContent(e,t);if(o)return o.id=e+"_"+t,this.logger.debug("Saving page to offline storage",e),this.offlineStorage.savePage(this.getWikiConfig().name,e+"_"+t,o),o;throw new Error("Can't save missing page.")}async updatePageContent(e,t){const o=await this.offlineStorage.getPage(this.getWikiConfig().name,e+"_"+t),r=await this.storage.getPageContent(e,t);return o&&r?(r.id=e+"_"+t,this.logger.debug("Saving page to offline storage",e),this.offlineStorage.savePage(this.getWikiConfig().name,e+"_"+t,r),!0):o?.version!=r?.version&&r?(r.id=e+"_"+t,this.logger.debug("Updating page to offline storage",e),this.offlineStorage.updatePage(this.getWikiConfig().name,e+"_"+t,r),!0):(this.logger.debug("Local storage not updated, because version are identical"),!1)}async getPanelContent(e,t,o){return this.storage.getPanelContent(e,t,o)}async getEditField(e,t){return await this.storage.getEditField(e,t)}save(e,t,o,r){return this.storage.save(e,t,o,r)}async saveAttachments(e,t){return this.storage.saveAttachments(e,t)}async delete(e){return this.storage.delete(e)}async move(e,t,o){return this.storage.move(e,t,o)}};f=v([s.injectable(),u(0,s.inject("Logger")),u(1,s.inject("OfflineStorage")),u(2,s.inject("QueueWorker"))],f);class b{constructor(t){t.bind("WrappingStorage").to(f).inSingletonScope(),t.bind("OfflineStorage").to(c).inSingletonScope()}}g.ComponentInit=b,Object.defineProperty(g,Symbol.toStringTag,{value:"Module"})}));
-//# sourceMappingURL=index.umd.js.map

package/dist/index.umd.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.umd.js","sources":["../src/dexiePageStorage.ts","../src/dexieOfflineStorage.ts","../src/wrappingOfflineStorage.ts","../src/index.ts"],"sourcesContent":["/**\n * See the LICENSE file distributed with this work for additional\n * information regarding copyright ownership.\n *\n * This is free software; you can redistribute it and/or modify it\n * under the terms of the GNU Lesser General Public License as\n * published by the Free Software Foundation; either version 2.1 of\n * the License, or (at your option) any later version.\n *\n * This software is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n * Lesser General Public License for more details.\n *\n * You should have received a copy of the GNU Lesser General Public\n * License along with this software; if not, write to the Free\n * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA\n * 02110-1301 USA, or see the FSF site: http://www.fsf.org.\n */\n\nimport { default as Dexie } from \"dexie\";\nimport type { Table } from \"dexie\";\n\nexport default class DexiePageStorage extends Dexie {\n  pages!: Table<object>;\n\n  constructor(wikiName: string) {\n    super(\"pages_\" + wikiName);\n    this.version(2).stores({\n      pages:\n        // Primary key and indexed props\n        \"id, name, content, document, css, js, document.name, document.headline, document.creator\",\n    });\n  }\n}\n","/**\n * See the LICENSE file distributed with this work for additional\n * information regarding copyright ownership.\n *\n * This is free software; you can redistribute it and/or modify it\n * under the terms of the GNU Lesser General Public License as\n * published by the Free Software Foundation; either version 2.1 of\n * the License, or (at your option) any later version.\n *\n * This software is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n * Lesser General Public License for more details.\n *\n * You should have received a copy of the GNU Lesser General Public\n * License along with this software; if not, write to the Free\n * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA\n * 02110-1301 USA, or see the FSF site: http://www.fsf.org.\n */\n\nimport DexiePageStorage from \"./dexiePageStorage\";\nimport { DefaultPageData } from \"@xwiki/platform-api\";\nimport { inject, injectable } from \"inversify\";\nimport type { Logger, PageData } from \"@xwiki/platform-api\";\nimport type { OfflineStorage } from \"@xwiki/platform-backend-api\";\n\n@injectable()\nexport default class DexieOfflineStorage implements OfflineStorage {\n  private pageStorageMap: Map<string, DexiePageStorage> = new Map<\n    string,\n    DexiePageStorage\n  >();\n  private logger: Logger;\n\n  constructor(@inject(\"Logger\") logger: Logger) {\n    this.logger = logger;\n    this.logger.setModule(\"storage.components.dexieOfflineStorage\");\n  }\n\n  getPageStorage(wikiName: string): DexiePageStorage {\n    let pageStorage = this.pageStorageMap.get(wikiName);\n    if (pageStorage == null) {\n      pageStorage = new DexiePageStorage(wikiName);\n      this.pageStorageMap.set(wikiName, pageStorage);\n    }\n    return pageStorage;\n  }\n\n  async getPage(wikiName: string, id: string): Promise<PageData | undefined> {\n    try {\n      this.logger.debug(\"Ready to load page from local storage\", id);\n      const pageStorage = this.getPageStorage(wikiName);\n      this.logger.debug(\"pageStorage is ready, asking for page\");\n      const pageObject = await pageStorage.pages.get(id);\n      const pageData = new DefaultPageData();\n      pageData.fromObject(pageObject);\n      return pageData;\n    } catch (e) {\n      this.logger.debug(\"Exception while trying to read from local storage\", e);\n      return undefined;\n    }\n  }\n\n  async savePage(wikiName: string, id: string, page: PageData): Promise<void> {\n    try {\n      const pageStorage = this.getPageStorage(wikiName);\n      // Put must be used instead of get since the later does not allow for\n      // content update.\n      await pageStorage.pages.put(page.toObject(), id);\n    } catch (e) {\n      this.logger.debug(\n        \"Exception while trying to store in local storage\",\n        wikiName,\n        id,\n        page,\n        e,\n      );\n    }\n  }\n\n  async updatePage(\n    wikiName: string,\n    id: string,\n    page: PageData,\n  ): Promise<void> {\n    try {\n      const pageStorage = this.getPageStorage(wikiName);\n      this.logger.debug(\"Ready to store\", page);\n      await pageStorage.pages.update(id, page.toObject());\n    } catch (e) {\n      this.logger.debug(\n        \"Exception while trying to store in local storage\",\n        wikiName,\n        id,\n        page,\n        e,\n      );\n    }\n  }\n}\n","/**\n * See the LICENSE file distributed with this work for additional\n * information regarding copyright ownership.\n *\n * This is free software; you can redistribute it and/or modify it\n * under the terms of the GNU Lesser General Public License as\n * published by the Free Software Foundation; either version 2.1 of\n * the License, or (at your option) any later version.\n *\n * This software is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n * Lesser General Public License for more details.\n *\n * You should have received a copy of the GNU Lesser General Public\n * License along with this software; if not, write to the Free\n * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA\n * 02110-1301 USA, or see the FSF site: http://www.fsf.org.\n */\n\nimport { inject, injectable } from \"inversify\";\nimport type { QueueWorker } from \"@xwiki/cristal-sharedworker-api\";\nimport type {\n  AttachmentsData,\n  Document,\n  Logger,\n  PageAttachment,\n  PageData,\n  Storage,\n  WikiConfig,\n  WrappingStorage,\n} from \"@xwiki/platform-api\";\nimport type { OfflineStorage } from \"@xwiki/platform-backend-api\";\n\n@injectable()\nexport class WrappingOfflineStorage implements WrappingStorage {\n  public logger: Logger;\n  // @ts-expect-error storage can be temporarily undefined during class\n  // initialization\n  public storage: Storage;\n  public offlineStorage: OfflineStorage;\n  public queueWorker: QueueWorker;\n\n  constructor(\n    @inject(\"Logger\") logger: Logger,\n    @inject(\"OfflineStorage\") offlineStorage: OfflineStorage,\n    @inject(\"QueueWorker\") queueWorker: QueueWorker,\n  ) {\n    this.logger = logger;\n    this.logger.setModule(\"storage.components.wrappingOfflineStorage\");\n    this.offlineStorage = offlineStorage;\n    this.queueWorker = queueWorker;\n  }\n\n  public setStorage(storage: Storage): void {\n    this.storage = storage;\n  }\n\n  public getStorage(): Storage {\n    return this.storage;\n  }\n\n  public setWikiConfig(config: WikiConfig): void {\n    return this.storage.setWikiConfig(config);\n  }\n\n  public getWikiConfig(): WikiConfig {\n    return this.storage.getWikiConfig();\n  }\n\n  public async isStorageReady(): Promise<boolean> {\n    return this.storage.isStorageReady();\n  }\n\n  public getPageRestURL(page: string, syntax: string): string {\n    return this.storage.getPageRestURL(page, syntax);\n  }\n\n  public getPageFromViewURL(url: string): string | null {\n    return this.storage.getPageFromViewURL(url);\n  }\n\n  public getImageURL(page: string, image: string): string {\n    return this.storage.getImageURL(page, image);\n  }\n\n  // TODO: reduce the number of statements in the following method and reactivate the disabled eslint rule.\n  // eslint-disable-next-line max-statements\n  public async getPageContent(\n    page: string,\n    syntax: string,\n    _revision?: string,\n    requeue?: boolean,\n  ): Promise<PageData | undefined> {\n    this.logger.debug(\"Trying to get data for page \", page);\n    if (this.offlineStorage) {\n      this.logger.debug(\"Asking offline storage for \", page);\n      const pageData = await this.offlineStorage.getPage(\n        this.getWikiConfig().name,\n        page + \"_\" + syntax,\n      );\n      if (pageData != null && pageData != undefined) {\n        this.logger.debug(\"Loading data from local storage for page\", page);\n        // Adding page to refresh queue in shared worker\n        if (requeue == undefined || requeue) {\n          this.queueWorker.addToQueue(\n            this.getWikiConfig().name + \":\" + page + \"_\" + syntax,\n          );\n        }\n        return pageData;\n      } else {\n        this.logger.debug(\n          \"Could not find data in local storage for page\",\n          page,\n        );\n        return this.savePageContent(page, syntax);\n      }\n    } else {\n      this.logger.debug(\"No offline local storage available\");\n      return this.storage.getPageContent(page, syntax);\n    }\n  }\n\n  public getAttachments(page: string): Promise<AttachmentsData | undefined> {\n    // TODO: add support for offline storage of attachments.\n    return this.storage.getAttachments(page);\n  }\n\n  getAttachment(\n    page: string,\n    name: string,\n  ): Promise<PageAttachment | undefined> {\n    return this.storage.getAttachment(page, name);\n  }\n\n  private async savePageContent(\n    page: string,\n    syntax: string,\n  ): Promise<PageData> {\n    const pageData = await this.storage.getPageContent(page, syntax);\n    if (pageData) {\n      pageData.id = page + \"_\" + syntax;\n      this.logger.debug(\"Saving page to offline storage\", page);\n      this.offlineStorage.savePage(\n        this.getWikiConfig().name,\n        page + \"_\" + syntax,\n        pageData,\n      );\n\n      return pageData;\n    } else {\n      throw new Error(\"Can't save missing page.\");\n    }\n  }\n\n  // TODO: reduce the number of statements in the following method and reactivate the disabled eslint rule.\n  // eslint-disable-next-line max-statements\n  public async updatePageContent(\n    page: string,\n    syntax: string,\n  ): Promise<boolean> {\n    const currentPageData = await this.offlineStorage.getPage(\n      this.getWikiConfig().name,\n      page + \"_\" + syntax,\n    );\n    const pageData = await this.storage.getPageContent(page, syntax);\n    if (currentPageData && pageData) {\n      pageData.id = page + \"_\" + syntax;\n      this.logger.debug(\"Saving page to offline storage\", page);\n      this.offlineStorage.savePage(\n        this.getWikiConfig().name,\n        page + \"_\" + syntax,\n        pageData,\n      );\n      return true;\n    } else if (currentPageData?.version != pageData?.version && pageData) {\n      pageData.id = page + \"_\" + syntax;\n      this.logger.debug(\"Updating page to offline storage\", page);\n      this.offlineStorage.updatePage(\n        this.getWikiConfig().name,\n        page + \"_\" + syntax,\n        pageData,\n      );\n      return true;\n    } else {\n      this.logger.debug(\n        \"Local storage not updated, because version are identical\",\n      );\n      return false;\n    }\n  }\n\n  public async getPanelContent(\n    panel: string,\n    contextPage: string,\n    syntax: string,\n  ): Promise<PageData> {\n    return this.storage.getPanelContent(panel, contextPage, syntax);\n  }\n\n  public async getEditField(\n    document: Document,\n    fieldName: string,\n  ): Promise<string> {\n    return await this.storage.getEditField(document, fieldName);\n  }\n\n  save(\n    page: string,\n    title: string,\n    content: string,\n    syntax: string,\n  ): Promise<unknown> {\n    return this.storage.save(page, title, content, syntax);\n  }\n\n  async saveAttachments(\n    page: string,\n    files: File[],\n  ): Promise<undefined | (undefined | string)[]> {\n    return this.storage.saveAttachments(page, files);\n  }\n\n  async delete(page: string): Promise<{ success: boolean; error?: string }> {\n    return this.storage.delete(page);\n  }\n\n  async move(\n    page: string,\n    newPage: string,\n    preserveChildren: boolean,\n  ): Promise<{ success: boolean; error?: string }> {\n    return this.storage.move(page, newPage, preserveChildren);\n  }\n}\n","/**\n * See the LICENSE file distributed with this work for additional\n * information regarding copyright ownership.\n *\n * This is free software; you can redistribute it and/or modify it\n * under the terms of the GNU Lesser General Public License as\n * published by the Free Software Foundation; either version 2.1 of\n * the License, or (at your option) any later version.\n *\n * This software is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n * Lesser General Public License for more details.\n *\n * You should have received a copy of the GNU Lesser General Public\n * License along with this software; if not, write to the Free\n * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA\n * 02110-1301 USA, or see the FSF site: http://www.fsf.org.\n */\n\nimport DexieOfflineStorage from \"./dexieOfflineStorage\";\nimport { WrappingOfflineStorage } from \"./wrappingOfflineStorage\";\nimport { Container } from \"inversify\";\nimport type { WrappingStorage } from \"@xwiki/platform-api\";\nimport type { OfflineStorage } from \"@xwiki/platform-backend-api\";\n\n/**\n * @beta\n */\nexport class ComponentInit {\n  constructor(container: Container) {\n    container\n      .bind<WrappingStorage>(\"WrappingStorage\")\n      .to(WrappingOfflineStorage)\n      .inSingletonScope();\n    container\n      .bind<OfflineStorage>(\"OfflineStorage\")\n      .to(DexieOfflineStorage)\n      .inSingletonScope();\n  }\n}\n"],"names":["DexiePageStorage","Dexie","wikiName","DexieOfflineStorage","logger","pageStorage","id","pageObject","pageData","DefaultPageData","e","page","__decorateClass","injectable","__decorateParam","WrappingOfflineStorage","offlineStorage","queueWorker","storage","config","syntax","url","image","_revision","requeue","name","currentPageData","panel","contextPage","document","fieldName","title","content","files","newPage","preserveChildren","ComponentInit","container"],"mappings":"wYAuBA,MAAqBA,UAAyBC,CAAM,CAClD,MAEA,YAAYC,EAAkB,CAC5B,MAAM,SAAWA,CAAQ,EACzB,KAAK,QAAQ,CAAC,EAAE,OAAO,CACrB,MAEE,0FAAA,CACH,CACH,CACF,sKCPA,IAAqBC,EAArB,KAAmE,CACzD,mBAAoD,IAIpD,OAER,YAA8BC,EAAgB,CAC5C,KAAK,OAASA,EACd,KAAK,OAAO,UAAU,wCAAwC,CAChE,CAEA,eAAeF,EAAoC,CACjD,IAAIG,EAAc,KAAK,eAAe,IAAIH,CAAQ,EAClD,OAAIG,GAAe,OACjBA,EAAc,IAAIL,EAAiBE,CAAQ,EAC3C,KAAK,eAAe,IAAIA,EAAUG,CAAW,GAExCA,CACT,CAEA,MAAM,QAAQH,EAAkBI,EAA2C,CACzE,GAAI,CACF,KAAK,OAAO,MAAM,wCAAyCA,CAAE,EAC7D,MAAMD,EAAc,KAAK,eAAeH,CAAQ,EAChD,KAAK,OAAO,MAAM,uCAAuC,EACzD,MAAMK,EAAa,MAAMF,EAAY,MAAM,IAAIC,CAAE,EAC3CE,EAAW,IAAIC,kBACrB,OAAAD,EAAS,WAAWD,CAAU,EACvBC,CACT,OAASE,EAAG,CACV,KAAK,OAAO,MAAM,oDAAqDA,CAAC,EACxE,MACF,CACF,CAEA,MAAM,SAASR,EAAkBI,EAAYK,EAA+B,CAC1E,GAAI,CAIF,MAHoB,KAAK,eAAeT,CAAQ,EAG9B,MAAM,IAAIS,EAAK,SAAA,EAAYL,CAAE,CACjD,OAASI,EAAG,CACV,KAAK,OAAO,MACV,mDACAR,EACAI,EACAK,EACAD,CAAA,CAEJ,CACF,CAEA,MAAM,WACJR,EACAI,EACAK,EACe,CACf,GAAI,CACF,MAAMN,EAAc,KAAK,eAAeH,CAAQ,EAChD,KAAK,OAAO,MAAM,iBAAkBS,CAAI,EACxC,MAAMN,EAAY,MAAM,OAAOC,EAAIK,EAAK,UAAU,CACpD,OAASD,EAAG,CACV,KAAK,OAAO,MACV,mDACAR,EACAI,EACAK,EACAD,CAAA,CAEJ,CACF,CACF,EAxEqBP,EAArBS,EAAA,CADCC,aAAA,EAQcC,aAAO,QAAQ,CAAA,CAAA,EAPTX,CAAA,uKCQd,IAAMY,EAAN,KAAwD,CACtD,OAGA,QACA,eACA,YAEP,YACoBX,EACQY,EACHC,EACvB,CACA,KAAK,OAASb,EACd,KAAK,OAAO,UAAU,2CAA2C,EACjE,KAAK,eAAiBY,EACtB,KAAK,YAAcC,CACrB,CAEO,WAAWC,EAAwB,CACxC,KAAK,QAAUA,CACjB,CAEO,YAAsB,CAC3B,OAAO,KAAK,OACd,CAEO,cAAcC,EAA0B,CAC7C,OAAO,KAAK,QAAQ,cAAcA,CAAM,CAC1C,CAEO,eAA4B,CACjC,OAAO,KAAK,QAAQ,cAAA,CACtB,CAEA,MAAa,gBAAmC,CAC9C,OAAO,KAAK,QAAQ,eAAA,CACtB,CAEO,eAAeR,EAAcS,EAAwB,CAC1D,OAAO,KAAK,QAAQ,eAAeT,EAAMS,CAAM,CACjD,CAEO,mBAAmBC,EAA4B,CACpD,OAAO,KAAK,QAAQ,mBAAmBA,CAAG,CAC5C,CAEO,YAAYV,EAAcW,EAAuB,CACtD,OAAO,KAAK,QAAQ,YAAYX,EAAMW,CAAK,CAC7C,CAIA,MAAa,eACXX,EACAS,EACAG,EACAC,EAC+B,CAE/B,GADA,KAAK,OAAO,MAAM,+BAAgCb,CAAI,EAClD,KAAK,eAAgB,CACvB,KAAK,OAAO,MAAM,8BAA+BA,CAAI,EACrD,MAAMH,EAAW,MAAM,KAAK,eAAe,QACzC,KAAK,gBAAgB,KACrBG,EAAO,IAAMS,CAAA,EAEf,OAAIZ,GAAY,MAAQA,GAAY,MAClC,KAAK,OAAO,MAAM,2CAA4CG,CAAI,GAE9Da,GAAW,MAAaA,IAC1B,KAAK,YAAY,WACf,KAAK,cAAA,EAAgB,KAAO,IAAMb,EAAO,IAAMS,CAAA,EAG5CZ,IAEP,KAAK,OAAO,MACV,gDACAG,CAAA,EAEK,KAAK,gBAAgBA,EAAMS,CAAM,EAE5C,KACE,aAAK,OAAO,MAAM,oCAAoC,EAC/C,KAAK,QAAQ,eAAeT,EAAMS,CAAM,CAEnD,CAEO,eAAeT,EAAoD,CAExE,OAAO,KAAK,QAAQ,eAAeA,CAAI,CACzC,CAEA,cACEA,EACAc,EACqC,CACrC,OAAO,KAAK,QAAQ,cAAcd,EAAMc,CAAI,CAC9C,CAEA,MAAc,gBACZd,EACAS,EACmB,CACnB,MAAMZ,EAAW,MAAM,KAAK,QAAQ,eAAeG,EAAMS,CAAM,EAC/D,GAAIZ,EACF,OAAAA,EAAS,GAAKG,EAAO,IAAMS,EAC3B,KAAK,OAAO,MAAM,iCAAkCT,CAAI,EACxD,KAAK,eAAe,SAClB,KAAK,gBAAgB,KACrBA,EAAO,IAAMS,EACbZ,CAAA,EAGKA,EAEP,MAAM,IAAI,MAAM,0BAA0B,CAE9C,CAIA,MAAa,kBACXG,EACAS,EACkB,CAClB,MAAMM,EAAkB,MAAM,KAAK,eAAe,QAChD,KAAK,gBAAgB,KACrBf,EAAO,IAAMS,CAAA,EAETZ,EAAW,MAAM,KAAK,QAAQ,eAAeG,EAAMS,CAAM,EAC/D,OAAIM,GAAmBlB,GACrBA,EAAS,GAAKG,EAAO,IAAMS,EAC3B,KAAK,OAAO,MAAM,iCAAkCT,CAAI,EACxD,KAAK,eAAe,SAClB,KAAK,gBAAgB,KACrBA,EAAO,IAAMS,EACbZ,CAAA,EAEK,IACEkB,GAAiB,SAAWlB,GAAU,SAAWA,GAC1DA,EAAS,GAAKG,EAAO,IAAMS,EAC3B,KAAK,OAAO,MAAM,mCAAoCT,CAAI,EAC1D,KAAK,eAAe,WAClB,KAAK,gBAAgB,KACrBA,EAAO,IAAMS,EACbZ,CAAA,EAEK,KAEP,KAAK,OAAO,MACV,0DAAA,EAEK,GAEX,CAEA,MAAa,gBACXmB,EACAC,EACAR,EACmB,CACnB,OAAO,KAAK,QAAQ,gBAAgBO,EAAOC,EAAaR,CAAM,CAChE,CAEA,MAAa,aACXS,EACAC,EACiB,CACjB,OAAO,MAAM,KAAK,QAAQ,aAAaD,EAAUC,CAAS,CAC5D,CAEA,KACEnB,EACAoB,EACAC,EACAZ,EACkB,CAClB,OAAO,KAAK,QAAQ,KAAKT,EAAMoB,EAAOC,EAASZ,CAAM,CACvD,CAEA,MAAM,gBACJT,EACAsB,EAC6C,CAC7C,OAAO,KAAK,QAAQ,gBAAgBtB,EAAMsB,CAAK,CACjD,CAEA,MAAM,OAAOtB,EAA6D,CACxE,OAAO,KAAK,QAAQ,OAAOA,CAAI,CACjC,CAEA,MAAM,KACJA,EACAuB,EACAC,EAC+C,CAC/C,OAAO,KAAK,QAAQ,KAAKxB,EAAMuB,EAASC,CAAgB,CAC1D,CACF,EAvMapB,EAANH,EAAA,CADNC,aAAA,EAUIC,aAAO,QAAQ,CAAA,EACfA,aAAO,gBAAgB,CAAA,EACvBA,aAAO,aAAa,CAAA,CAAA,EAXZC,CAAA,ECNN,MAAMqB,CAAc,CACzB,YAAYC,EAAsB,CAChCA,EACG,KAAsB,iBAAiB,EACvC,GAAGtB,CAAsB,EACzB,iBAAA,EACHsB,EACG,KAAqB,gBAAgB,EACrC,GAAGlC,CAAmB,EACtB,iBAAA,CACL,CACF"}

package/dist/wrappingOfflineStorage.d.ts

@@ -1,35 +0,0 @@
-import { QueueWorker } from '@xwiki/cristal-sharedworker-api';
-import { AttachmentsData, Document, Logger, PageAttachment, PageData, Storage, WikiConfig, WrappingStorage } from '@xwiki/platform-api';
-import { OfflineStorage } from '@xwiki/platform-backend-api';
-export declare class WrappingOfflineStorage implements WrappingStorage {
-    logger: Logger;
-    storage: Storage;
-    offlineStorage: OfflineStorage;
-    queueWorker: QueueWorker;
-    constructor(logger: Logger, offlineStorage: OfflineStorage, queueWorker: QueueWorker);
-    setStorage(storage: Storage): void;
-    getStorage(): Storage;
-    setWikiConfig(config: WikiConfig): void;
-    getWikiConfig(): WikiConfig;
-    isStorageReady(): Promise<boolean>;
-    getPageRestURL(page: string, syntax: string): string;
-    getPageFromViewURL(url: string): string | null;
-    getImageURL(page: string, image: string): string;
-    getPageContent(page: string, syntax: string, _revision?: string, requeue?: boolean): Promise<PageData | undefined>;
-    getAttachments(page: string): Promise<AttachmentsData | undefined>;
-    getAttachment(page: string, name: string): Promise<PageAttachment | undefined>;
-    private savePageContent;
-    updatePageContent(page: string, syntax: string): Promise<boolean>;
-    getPanelContent(panel: string, contextPage: string, syntax: string): Promise<PageData>;
-    getEditField(document: Document, fieldName: string): Promise<string>;
-    save(page: string, title: string, content: string, syntax: string): Promise<unknown>;
-    saveAttachments(page: string, files: File[]): Promise<undefined | (undefined | string)[]>;
-    delete(page: string): Promise<{
-        success: boolean;
-        error?: string;
-    }>;
-    move(page: string, newPage: string, preserveChildren: boolean): Promise<{
-        success: boolean;
-        error?: string;
-    }>;
-}