@xwiki/cristal-backend-dexie 0.15.0 → 0.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
# @xwiki/cristal-backend-dexie
|
|
2
2
|
|
|
3
|
+
## 0.16.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- Cristal 0.16 Release
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- Updated dependencies
|
|
12
|
+
- @xwiki/cristal-api@0.16.0
|
|
13
|
+
- @xwiki/cristal-backend-api@0.16.0
|
|
14
|
+
- @xwiki/cristal-sharedworker-api@0.16.0
|
|
15
|
+
|
|
3
16
|
## 0.15.0
|
|
4
17
|
|
|
5
18
|
### Minor Changes
|
package/dist/index.es.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"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\n// eslint-disable-next-line import/no-named-as-default\nimport 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, PageData } from \"@xwiki/cristal-api\";\nimport { inject, injectable } from \"inversify\";\nimport type { Logger } from \"@xwiki/cristal-api\";\nimport type { OfflineStorage } from \"@xwiki/cristal-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: 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 {\n AttachmentsData,\n Document,\n Logger,\n PageAttachment,\n PageData,\n Storage,\n WikiConfig,\n WrappingStorage,\n} from \"@xwiki/cristal-api\";\nimport type { OfflineStorage } from \"@xwiki/cristal-backend-api\";\nimport type { QueueWorker } from \"@xwiki/cristal-sharedworker-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: Logger,\n @inject<OfflineStorage>(\"OfflineStorage\") offlineStorage: OfflineStorage,\n @inject<QueueWorker>(\"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(page: string, files: File[]): Promise<unknown> {\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 { WrappingStorage } from \"@xwiki/cristal-api\";\nimport { OfflineStorage } from \"@xwiki/cristal-backend-api\";\nimport { Container } from \"inversify\";\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":";;;AAwBA,MAAqBA,UAAyBC,EAAM;AAAA,EAGlD,YAAYC,GAAkB;AAC5B,UAAM,WAAWA,CAAQ,GACpB,KAAA,QAAQ,CAAC,EAAE,OAAO;AAAA,MACrB;AAAA;AAAA,QAEE;AAAA;AAAA,IAAA,CACH;AAAA,EAAA;AAEL;;;;;;ACRA,IAAqBC,IAArB,MAAmE;AAAA,EAOjE,YAAsCC,GAAgB;AAN9C,SAAA,qCAAoD,IAG1D,GAIA,KAAK,SAASA,GACT,KAAA,OAAO,UAAU,wCAAwC;AAAA,EAAA;AAAA,EAGhE,eAAeF,GAAoC;AACjD,QAAIG,IAAc,KAAK,eAAe,IAAIH,CAAQ;AAClD,WAAIG,KAAe,SACHA,IAAA,IAAIL,EAAiBE,CAAQ,GACtC,KAAA,eAAe,IAAIA,GAAUG,CAAW,IAExCA;AAAA,EAAA;AAAA,EAGT,MAAM,QAAQH,GAAkBI,GAA2C;AACrE,QAAA;AACG,WAAA,OAAO,MAAM,yCAAyCA,CAAE;AACvD,YAAAD,IAAc,KAAK,eAAeH,CAAQ;AAC3C,WAAA,OAAO,MAAM,uCAAuC;AACzD,YAAMK,IAAa,MAAMF,EAAY,MAAM,IAAIC,CAAE,GAC3CE,IAAW,IAAIC,EAAgB;AACrC,aAAAD,EAAS,WAAWD,CAAU,GACvBC;AAAA,aACAE,GAAG;AACL,WAAA,OAAO,MAAM,qDAAqDA,CAAC;AACjE;AAAA,IAAA;AAAA,EACT;AAAA,EAGF,MAAM,SAASR,GAAkBI,GAAYK,GAA+B;AACtE,QAAA;AAIF,YAHoB,KAAK,eAAeT,CAAQ,EAG9B,MAAM,IAAIS,EAAK,YAAYL,CAAE;AAAA,aACxCI,GAAG;AACV,WAAK,OAAO;AAAA,QACV;AAAA,QACAR;AAAA,QACAI;AAAA,QACAK;AAAA,QACAD;AAAA,MACF;AAAA,IAAA;AAAA,EACF;AAAA,EAGF,MAAM,WACJR,GACAI,GACAK,GACe;AACX,QAAA;AACI,YAAAN,IAAc,KAAK,eAAeH,CAAQ;AAC3C,WAAA,OAAO,MAAM,kBAAkBS,CAAI,GACxC,MAAMN,EAAY,MAAM,OAAOC,GAAIK,EAAK,UAAU;AAAA,aAC3CD,GAAG;AACV,WAAK,OAAO;AAAA,QACV;AAAA,QACAR;AAAA,QACAI;AAAA,QACAK;AAAA,QACAD;AAAA,MACF;AAAA,IAAA;AAAA,EACF;AAEJ;AAxEqBP,IAArBS,EAAA;AAAA,EADCC,EAAW;AAAA,EAQGC,OAAe,QAAQ,CAAA;AAAA,GAPjBX,CAAA;;;;;;ACQd,IAAMY,IAAN,MAAwD;AAAA,EAQ7D,YAC4BX,GACgBY,GACNC,GACpC;AACA,SAAK,SAASb,GACT,KAAA,OAAO,UAAU,2CAA2C,GACjE,KAAK,iBAAiBY,GACtB,KAAK,cAAcC;AAAA,EAAA;AAAA,EAGd,WAAWC,GAAwB;AACxC,SAAK,UAAUA;AAAA,EAAA;AAAA,EAGV,aAAsB;AAC3B,WAAO,KAAK;AAAA,EAAA;AAAA,EAGP,cAAcC,GAA0B;AACtC,WAAA,KAAK,QAAQ,cAAcA,CAAM;AAAA,EAAA;AAAA,EAGnC,gBAA4B;AAC1B,WAAA,KAAK,QAAQ,cAAc;AAAA,EAAA;AAAA,EAGpC,MAAa,iBAAmC;AACvC,WAAA,KAAK,QAAQ,eAAe;AAAA,EAAA;AAAA,EAG9B,eAAeR,GAAcS,GAAwB;AAC1D,WAAO,KAAK,QAAQ,eAAeT,GAAMS,CAAM;AAAA,EAAA;AAAA,EAG1C,mBAAmBC,GAA4B;AAC7C,WAAA,KAAK,QAAQ,mBAAmBA,CAAG;AAAA,EAAA;AAAA,EAGrC,YAAYV,GAAcW,GAAuB;AACtD,WAAO,KAAK,QAAQ,YAAYX,GAAMW,CAAK;AAAA,EAAA;AAAA;AAAA;AAAA,EAK7C,MAAa,eACXX,GACAS,GACAG,GACAC,GAC+B;AAE/B,QADK,KAAA,OAAO,MAAM,gCAAgCb,CAAI,GAClD,KAAK,gBAAgB;AAClB,WAAA,OAAO,MAAM,+BAA+BA,CAAI;AAC/C,YAAAH,IAAW,MAAM,KAAK,eAAe;AAAA,QACzC,KAAK,gBAAgB;AAAA,QACrBG,IAAO,MAAMS;AAAA,MACf;AACI,aAAAZ,KAAY,QAAQA,KAAY,QAC7B,KAAA,OAAO,MAAM,4CAA4CG,CAAI,IAE9Da,KAAW,QAAaA,MAC1B,KAAK,YAAY;AAAA,QACf,KAAK,cAAc,EAAE,OAAO,MAAMb,IAAO,MAAMS;AAAA,MACjD,GAEKZ,MAEP,KAAK,OAAO;AAAA,QACV;AAAA,QACAG;AAAA,MACF,GACO,KAAK,gBAAgBA,GAAMS,CAAM;AAAA,IAC1C;AAEK,kBAAA,OAAO,MAAM,oCAAoC,GAC/C,KAAK,QAAQ,eAAeT,GAAMS,CAAM;AAAA,EACjD;AAAA,EAGK,eAAeT,GAAoD;AAEjE,WAAA,KAAK,QAAQ,eAAeA,CAAI;AAAA,EAAA;AAAA,EAGzC,cACEA,GACAc,GACqC;AACrC,WAAO,KAAK,QAAQ,cAAcd,GAAMc,CAAI;AAAA,EAAA;AAAA,EAG9C,MAAc,gBACZd,GACAS,GACmB;AACnB,UAAMZ,IAAW,MAAM,KAAK,QAAQ,eAAeG,GAAMS,CAAM;AAC/D,QAAIZ;AACO,aAAAA,EAAA,KAAKG,IAAO,MAAMS,GACtB,KAAA,OAAO,MAAM,kCAAkCT,CAAI,GACxD,KAAK,eAAe;AAAA,QAClB,KAAK,gBAAgB;AAAA,QACrBA,IAAO,MAAMS;AAAA,QACbZ;AAAA,MACF,GAEOA;AAED,UAAA,IAAI,MAAM,0BAA0B;AAAA,EAC5C;AAAA;AAAA;AAAA,EAKF,MAAa,kBACXG,GACAS,GACkB;AACZ,UAAAM,IAAkB,MAAM,KAAK,eAAe;AAAA,MAChD,KAAK,gBAAgB;AAAA,MACrBf,IAAO,MAAMS;AAAA,IACf,GACMZ,IAAW,MAAM,KAAK,QAAQ,eAAeG,GAAMS,CAAM;AAC/D,WAAIM,KAAmBlB,KACZA,EAAA,KAAKG,IAAO,MAAMS,GACtB,KAAA,OAAO,MAAM,kCAAkCT,CAAI,GACxD,KAAK,eAAe;AAAA,MAClB,KAAK,gBAAgB;AAAA,MACrBA,IAAO,MAAMS;AAAA,MACbZ;AAAA,IACF,GACO,OACEkB,KAAA,gBAAAA,EAAiB,aAAWlB,KAAA,gBAAAA,EAAU,YAAWA,KACjDA,EAAA,KAAKG,IAAO,MAAMS,GACtB,KAAA,OAAO,MAAM,oCAAoCT,CAAI,GAC1D,KAAK,eAAe;AAAA,MAClB,KAAK,gBAAgB;AAAA,MACrBA,IAAO,MAAMS;AAAA,MACbZ;AAAA,IACF,GACO,OAEP,KAAK,OAAO;AAAA,MACV;AAAA,IACF,GACO;AAAA,EACT;AAAA,EAGF,MAAa,gBACXmB,GACAC,GACAR,GACmB;AACnB,WAAO,KAAK,QAAQ,gBAAgBO,GAAOC,GAAaR,CAAM;AAAA,EAAA;AAAA,EAGhE,MAAa,aACXS,GACAC,GACiB;AACjB,WAAO,MAAM,KAAK,QAAQ,aAAaD,GAAUC,CAAS;AAAA,EAAA;AAAA,EAG5D,KACEnB,GACAoB,GACAC,GACAZ,GACkB;AAClB,WAAO,KAAK,QAAQ,KAAKT,GAAMoB,GAAOC,GAASZ,CAAM;AAAA,EAAA;AAAA,EAGvD,MAAM,gBAAgBT,GAAcsB,GAAiC;AACnE,WAAO,KAAK,QAAQ,gBAAgBtB,GAAMsB,CAAK;AAAA,EAAA;AAAA,EAGjD,MAAM,OAAOtB,GAA6D;AACjE,WAAA,KAAK,QAAQ,OAAOA,CAAI;AAAA,EAAA;AAAA,EAGjC,MAAM,KACJA,GACAuB,GACAC,GAC+C;AAC/C,WAAO,KAAK,QAAQ,KAAKxB,GAAMuB,GAASC,CAAgB;AAAA,EAAA;AAE5D;AApMapB,IAANH,EAAA;AAAA,EADNC,EAAW;AAAA,EAUPC,OAAe,QAAQ,CAAA;AAAA,EACvBA,OAAuB,gBAAgB,CAAA;AAAA,EACvCA,OAAoB,aAAa,CAAA;AAAA,GAXzBC,CAAA;ACTN,MAAMqB,EAAc;AAAA,EACzB,YAAYC,GAAsB;AAChC,IAAAA,EACG,KAAsB,iBAAiB,EACvC,GAAGtB,CAAsB,EACzB,iBAAiB,GACpBsB,EACG,KAAqB,gBAAgB,EACrC,GAAGlC,CAAmB,EACtB,iBAAiB;AAAA,EAAA;AAExB;"}
|
|
1
|
+
{"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 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, PageData } from \"@xwiki/cristal-api\";\nimport { inject, injectable } from \"inversify\";\nimport type { Logger } from \"@xwiki/cristal-api\";\nimport type { OfflineStorage } from \"@xwiki/cristal-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 {\n AttachmentsData,\n Document,\n Logger,\n PageAttachment,\n PageData,\n Storage,\n WikiConfig,\n WrappingStorage,\n} from \"@xwiki/cristal-api\";\nimport type { OfflineStorage } from \"@xwiki/cristal-backend-api\";\nimport type { QueueWorker } from \"@xwiki/cristal-sharedworker-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(page: string, files: File[]): Promise<unknown> {\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 { WrappingStorage } from \"@xwiki/cristal-api\";\nimport { OfflineStorage } from \"@xwiki/cristal-backend-api\";\nimport { Container } from \"inversify\";\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,EAGlD,YAAYC,GAAkB;AAC5B,UAAM,WAAWA,CAAQ,GACpB,KAAA,QAAQ,CAAC,EAAE,OAAO;AAAA,MACrB;AAAA;AAAA,QAEE;AAAA;AAAA,IAAA,CACH;AAAA,EAAA;AAEL;;;;;;ACPA,IAAqBC,IAArB,MAAmE;AAAA,EAOjE,YAA8BC,GAAgB;AANtC,SAAA,qCAAoD,IAG1D,GAIA,KAAK,SAASA,GACT,KAAA,OAAO,UAAU,wCAAwC;AAAA,EAAA;AAAA,EAGhE,eAAeF,GAAoC;AACjD,QAAIG,IAAc,KAAK,eAAe,IAAIH,CAAQ;AAClD,WAAIG,KAAe,SACHA,IAAA,IAAIL,EAAiBE,CAAQ,GACtC,KAAA,eAAe,IAAIA,GAAUG,CAAW,IAExCA;AAAA,EAAA;AAAA,EAGT,MAAM,QAAQH,GAAkBI,GAA2C;AACrE,QAAA;AACG,WAAA,OAAO,MAAM,yCAAyCA,CAAE;AACvD,YAAAD,IAAc,KAAK,eAAeH,CAAQ;AAC3C,WAAA,OAAO,MAAM,uCAAuC;AACzD,YAAMK,IAAa,MAAMF,EAAY,MAAM,IAAIC,CAAE,GAC3CE,IAAW,IAAIC,EAAgB;AACrC,aAAAD,EAAS,WAAWD,CAAU,GACvBC;AAAA,aACAE,GAAG;AACL,WAAA,OAAO,MAAM,qDAAqDA,CAAC;AACjE;AAAA,IAAA;AAAA,EACT;AAAA,EAGF,MAAM,SAASR,GAAkBI,GAAYK,GAA+B;AACtE,QAAA;AAIF,YAHoB,KAAK,eAAeT,CAAQ,EAG9B,MAAM,IAAIS,EAAK,YAAYL,CAAE;AAAA,aACxCI,GAAG;AACV,WAAK,OAAO;AAAA,QACV;AAAA,QACAR;AAAA,QACAI;AAAA,QACAK;AAAA,QACAD;AAAA,MACF;AAAA,IAAA;AAAA,EACF;AAAA,EAGF,MAAM,WACJR,GACAI,GACAK,GACe;AACX,QAAA;AACI,YAAAN,IAAc,KAAK,eAAeH,CAAQ;AAC3C,WAAA,OAAO,MAAM,kBAAkBS,CAAI,GACxC,MAAMN,EAAY,MAAM,OAAOC,GAAIK,EAAK,UAAU;AAAA,aAC3CD,GAAG;AACV,WAAK,OAAO;AAAA,QACV;AAAA,QACAR;AAAA,QACAI;AAAA,QACAK;AAAA,QACAD;AAAA,MACF;AAAA,IAAA;AAAA,EACF;AAEJ;AAxEqBP,IAArBS,EAAA;AAAA,EADCC,EAAW;AAAA,EAQGC,OAAO,QAAQ,CAAA;AAAA,GAPTX,CAAA;;;;;;ACQd,IAAMY,IAAN,MAAwD;AAAA,EAQ7D,YACoBX,GACQY,GACHC,GACvB;AACA,SAAK,SAASb,GACT,KAAA,OAAO,UAAU,2CAA2C,GACjE,KAAK,iBAAiBY,GACtB,KAAK,cAAcC;AAAA,EAAA;AAAA,EAGd,WAAWC,GAAwB;AACxC,SAAK,UAAUA;AAAA,EAAA;AAAA,EAGV,aAAsB;AAC3B,WAAO,KAAK;AAAA,EAAA;AAAA,EAGP,cAAcC,GAA0B;AACtC,WAAA,KAAK,QAAQ,cAAcA,CAAM;AAAA,EAAA;AAAA,EAGnC,gBAA4B;AAC1B,WAAA,KAAK,QAAQ,cAAc;AAAA,EAAA;AAAA,EAGpC,MAAa,iBAAmC;AACvC,WAAA,KAAK,QAAQ,eAAe;AAAA,EAAA;AAAA,EAG9B,eAAeR,GAAcS,GAAwB;AAC1D,WAAO,KAAK,QAAQ,eAAeT,GAAMS,CAAM;AAAA,EAAA;AAAA,EAG1C,mBAAmBC,GAA4B;AAC7C,WAAA,KAAK,QAAQ,mBAAmBA,CAAG;AAAA,EAAA;AAAA,EAGrC,YAAYV,GAAcW,GAAuB;AACtD,WAAO,KAAK,QAAQ,YAAYX,GAAMW,CAAK;AAAA,EAAA;AAAA;AAAA;AAAA,EAK7C,MAAa,eACXX,GACAS,GACAG,GACAC,GAC+B;AAE/B,QADK,KAAA,OAAO,MAAM,gCAAgCb,CAAI,GAClD,KAAK,gBAAgB;AAClB,WAAA,OAAO,MAAM,+BAA+BA,CAAI;AAC/C,YAAAH,IAAW,MAAM,KAAK,eAAe;AAAA,QACzC,KAAK,gBAAgB;AAAA,QACrBG,IAAO,MAAMS;AAAA,MACf;AACI,aAAAZ,KAAY,QAAQA,KAAY,QAC7B,KAAA,OAAO,MAAM,4CAA4CG,CAAI,IAE9Da,KAAW,QAAaA,MAC1B,KAAK,YAAY;AAAA,QACf,KAAK,cAAc,EAAE,OAAO,MAAMb,IAAO,MAAMS;AAAA,MACjD,GAEKZ,MAEP,KAAK,OAAO;AAAA,QACV;AAAA,QACAG;AAAA,MACF,GACO,KAAK,gBAAgBA,GAAMS,CAAM;AAAA,IAC1C;AAEK,kBAAA,OAAO,MAAM,oCAAoC,GAC/C,KAAK,QAAQ,eAAeT,GAAMS,CAAM;AAAA,EACjD;AAAA,EAGK,eAAeT,GAAoD;AAEjE,WAAA,KAAK,QAAQ,eAAeA,CAAI;AAAA,EAAA;AAAA,EAGzC,cACEA,GACAc,GACqC;AACrC,WAAO,KAAK,QAAQ,cAAcd,GAAMc,CAAI;AAAA,EAAA;AAAA,EAG9C,MAAc,gBACZd,GACAS,GACmB;AACnB,UAAMZ,IAAW,MAAM,KAAK,QAAQ,eAAeG,GAAMS,CAAM;AAC/D,QAAIZ;AACO,aAAAA,EAAA,KAAKG,IAAO,MAAMS,GACtB,KAAA,OAAO,MAAM,kCAAkCT,CAAI,GACxD,KAAK,eAAe;AAAA,QAClB,KAAK,gBAAgB;AAAA,QACrBA,IAAO,MAAMS;AAAA,QACbZ;AAAA,MACF,GAEOA;AAED,UAAA,IAAI,MAAM,0BAA0B;AAAA,EAC5C;AAAA;AAAA;AAAA,EAKF,MAAa,kBACXG,GACAS,GACkB;AACZ,UAAAM,IAAkB,MAAM,KAAK,eAAe;AAAA,MAChD,KAAK,gBAAgB;AAAA,MACrBf,IAAO,MAAMS;AAAA,IACf,GACMZ,IAAW,MAAM,KAAK,QAAQ,eAAeG,GAAMS,CAAM;AAC/D,WAAIM,KAAmBlB,KACZA,EAAA,KAAKG,IAAO,MAAMS,GACtB,KAAA,OAAO,MAAM,kCAAkCT,CAAI,GACxD,KAAK,eAAe;AAAA,MAClB,KAAK,gBAAgB;AAAA,MACrBA,IAAO,MAAMS;AAAA,MACbZ;AAAA,IACF,GACO,OACEkB,KAAA,gBAAAA,EAAiB,aAAWlB,KAAA,gBAAAA,EAAU,YAAWA,KACjDA,EAAA,KAAKG,IAAO,MAAMS,GACtB,KAAA,OAAO,MAAM,oCAAoCT,CAAI,GAC1D,KAAK,eAAe;AAAA,MAClB,KAAK,gBAAgB;AAAA,MACrBA,IAAO,MAAMS;AAAA,MACbZ;AAAA,IACF,GACO,OAEP,KAAK,OAAO;AAAA,MACV;AAAA,IACF,GACO;AAAA,EACT;AAAA,EAGF,MAAa,gBACXmB,GACAC,GACAR,GACmB;AACnB,WAAO,KAAK,QAAQ,gBAAgBO,GAAOC,GAAaR,CAAM;AAAA,EAAA;AAAA,EAGhE,MAAa,aACXS,GACAC,GACiB;AACjB,WAAO,MAAM,KAAK,QAAQ,aAAaD,GAAUC,CAAS;AAAA,EAAA;AAAA,EAG5D,KACEnB,GACAoB,GACAC,GACAZ,GACkB;AAClB,WAAO,KAAK,QAAQ,KAAKT,GAAMoB,GAAOC,GAASZ,CAAM;AAAA,EAAA;AAAA,EAGvD,MAAM,gBAAgBT,GAAcsB,GAAiC;AACnE,WAAO,KAAK,QAAQ,gBAAgBtB,GAAMsB,CAAK;AAAA,EAAA;AAAA,EAGjD,MAAM,OAAOtB,GAA6D;AACjE,WAAA,KAAK,QAAQ,OAAOA,CAAI;AAAA,EAAA;AAAA,EAGjC,MAAM,KACJA,GACAuB,GACAC,GAC+C;AAC/C,WAAO,KAAK,QAAQ,KAAKxB,GAAMuB,GAASC,CAAgB;AAAA,EAAA;AAE5D;AApMapB,IAANH,EAAA;AAAA,EADNC,EAAW;AAAA,EAUPC,OAAO,QAAQ,CAAA;AAAA,EACfA,OAAO,gBAAgB,CAAA;AAAA,EACvBA,OAAO,aAAa,CAAA;AAAA,GAXZC,CAAA;ACTN,MAAMqB,EAAc;AAAA,EACzB,YAAYC,GAAsB;AAChC,IAAAA,EACG,KAAsB,iBAAiB,EACvC,GAAGtB,CAAsB,EACzB,iBAAiB,GACpBsB,EACG,KAAqB,gBAAgB,EACrC,GAAGlC,CAAmB,EACtB,iBAAiB;AAAA,EAAA;AAExB;"}
|
package/dist/index.umd.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"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\n// eslint-disable-next-line import/no-named-as-default\nimport 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, PageData } from \"@xwiki/cristal-api\";\nimport { inject, injectable } from \"inversify\";\nimport type { Logger } from \"@xwiki/cristal-api\";\nimport type { OfflineStorage } from \"@xwiki/cristal-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: 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 {\n AttachmentsData,\n Document,\n Logger,\n PageAttachment,\n PageData,\n Storage,\n WikiConfig,\n WrappingStorage,\n} from \"@xwiki/cristal-api\";\nimport type { OfflineStorage } from \"@xwiki/cristal-backend-api\";\nimport type { QueueWorker } from \"@xwiki/cristal-sharedworker-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: Logger,\n @inject<OfflineStorage>(\"OfflineStorage\") offlineStorage: OfflineStorage,\n @inject<QueueWorker>(\"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(page: string, files: File[]): Promise<unknown> {\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 { WrappingStorage } from \"@xwiki/cristal-api\";\nimport { OfflineStorage } from \"@xwiki/cristal-backend-api\";\nimport { Container } from \"inversify\";\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":"oYAwBA,MAAqBA,UAAyBC,CAAM,CAGlD,YAAYC,EAAkB,CAC5B,MAAM,SAAWA,CAAQ,EACpB,KAAA,QAAQ,CAAC,EAAE,OAAO,CACrB,MAEE,0FAAA,CACH,CAAA,CAEL,0NCRA,IAAqBC,EAArB,KAAmE,CAOjE,YAAsCC,EAAgB,CAN9C,KAAA,mBAAoD,IAO1D,KAAK,OAASA,EACT,KAAA,OAAO,UAAU,wCAAwC,CAAA,CAGhE,eAAeF,EAAoC,CACjD,IAAIG,EAAc,KAAK,eAAe,IAAIH,CAAQ,EAClD,OAAIG,GAAe,OACHA,EAAA,IAAIL,EAAiBE,CAAQ,EACtC,KAAA,eAAe,IAAIA,EAAUG,CAAW,GAExCA,CAAA,CAGT,MAAM,QAAQH,EAAkBI,EAA2C,CACrE,GAAA,CACG,KAAA,OAAO,MAAM,wCAAyCA,CAAE,EACvD,MAAAD,EAAc,KAAK,eAAeH,CAAQ,EAC3C,KAAA,OAAO,MAAM,uCAAuC,EACzD,MAAMK,EAAa,MAAMF,EAAY,MAAM,IAAIC,CAAE,EAC3CE,EAAW,IAAIC,kBACrB,OAAAD,EAAS,WAAWD,CAAU,EACvBC,QACAE,EAAG,CACL,KAAA,OAAO,MAAM,oDAAqDA,CAAC,EACjE,MAAA,CACT,CAGF,MAAM,SAASR,EAAkBI,EAAYK,EAA+B,CACtE,GAAA,CAIF,MAHoB,KAAK,eAAeT,CAAQ,EAG9B,MAAM,IAAIS,EAAK,WAAYL,CAAE,QACxCI,EAAG,CACV,KAAK,OAAO,MACV,mDACAR,EACAI,EACAK,EACAD,CACF,CAAA,CACF,CAGF,MAAM,WACJR,EACAI,EACAK,EACe,CACX,GAAA,CACI,MAAAN,EAAc,KAAK,eAAeH,CAAQ,EAC3C,KAAA,OAAO,MAAM,iBAAkBS,CAAI,EACxC,MAAMN,EAAY,MAAM,OAAOC,EAAIK,EAAK,UAAU,QAC3CD,EAAG,CACV,KAAK,OAAO,MACV,mDACAR,EACAI,EACAK,EACAD,CACF,CAAA,CACF,CAEJ,EAxEqBP,EAArBS,EAAA,CADCC,aAAW,EAQGC,aAAe,QAAQ,CAAA,CAAA,EAPjBX,CAAA,2NCQd,IAAMY,EAAN,KAAwD,CAQ7D,YAC4BX,EACgBY,EACNC,EACpC,CACA,KAAK,OAASb,EACT,KAAA,OAAO,UAAU,2CAA2C,EACjE,KAAK,eAAiBY,EACtB,KAAK,YAAcC,CAAA,CAGd,WAAWC,EAAwB,CACxC,KAAK,QAAUA,CAAA,CAGV,YAAsB,CAC3B,OAAO,KAAK,OAAA,CAGP,cAAcC,EAA0B,CACtC,OAAA,KAAK,QAAQ,cAAcA,CAAM,CAAA,CAGnC,eAA4B,CAC1B,OAAA,KAAK,QAAQ,cAAc,CAAA,CAGpC,MAAa,gBAAmC,CACvC,OAAA,KAAK,QAAQ,eAAe,CAAA,CAG9B,eAAeR,EAAcS,EAAwB,CAC1D,OAAO,KAAK,QAAQ,eAAeT,EAAMS,CAAM,CAAA,CAG1C,mBAAmBC,EAA4B,CAC7C,OAAA,KAAK,QAAQ,mBAAmBA,CAAG,CAAA,CAGrC,YAAYV,EAAcW,EAAuB,CACtD,OAAO,KAAK,QAAQ,YAAYX,EAAMW,CAAK,CAAA,CAK7C,MAAa,eACXX,EACAS,EACAG,EACAC,EAC+B,CAE/B,GADK,KAAA,OAAO,MAAM,+BAAgCb,CAAI,EAClD,KAAK,eAAgB,CAClB,KAAA,OAAO,MAAM,8BAA+BA,CAAI,EAC/C,MAAAH,EAAW,MAAM,KAAK,eAAe,QACzC,KAAK,gBAAgB,KACrBG,EAAO,IAAMS,CACf,EACI,OAAAZ,GAAY,MAAQA,GAAY,MAC7B,KAAA,OAAO,MAAM,2CAA4CG,CAAI,GAE9Da,GAAW,MAAaA,IAC1B,KAAK,YAAY,WACf,KAAK,cAAc,EAAE,KAAO,IAAMb,EAAO,IAAMS,CACjD,EAEKZ,IAEP,KAAK,OAAO,MACV,gDACAG,CACF,EACO,KAAK,gBAAgBA,EAAMS,CAAM,EAC1C,KAEK,aAAA,OAAO,MAAM,oCAAoC,EAC/C,KAAK,QAAQ,eAAeT,EAAMS,CAAM,CACjD,CAGK,eAAeT,EAAoD,CAEjE,OAAA,KAAK,QAAQ,eAAeA,CAAI,CAAA,CAGzC,cACEA,EACAc,EACqC,CACrC,OAAO,KAAK,QAAQ,cAAcd,EAAMc,CAAI,CAAA,CAG9C,MAAc,gBACZd,EACAS,EACmB,CACnB,MAAMZ,EAAW,MAAM,KAAK,QAAQ,eAAeG,EAAMS,CAAM,EAC/D,GAAIZ,EACO,OAAAA,EAAA,GAAKG,EAAO,IAAMS,EACtB,KAAA,OAAO,MAAM,iCAAkCT,CAAI,EACxD,KAAK,eAAe,SAClB,KAAK,gBAAgB,KACrBA,EAAO,IAAMS,EACbZ,CACF,EAEOA,EAED,MAAA,IAAI,MAAM,0BAA0B,CAC5C,CAKF,MAAa,kBACXG,EACAS,EACkB,CACZ,MAAAM,EAAkB,MAAM,KAAK,eAAe,QAChD,KAAK,gBAAgB,KACrBf,EAAO,IAAMS,CACf,EACMZ,EAAW,MAAM,KAAK,QAAQ,eAAeG,EAAMS,CAAM,EAC/D,OAAIM,GAAmBlB,GACZA,EAAA,GAAKG,EAAO,IAAMS,EACtB,KAAA,OAAO,MAAM,iCAAkCT,CAAI,EACxD,KAAK,eAAe,SAClB,KAAK,gBAAgB,KACrBA,EAAO,IAAMS,EACbZ,CACF,EACO,KACEkB,GAAA,YAAAA,EAAiB,WAAWlB,GAAA,YAAAA,EAAU,UAAWA,GACjDA,EAAA,GAAKG,EAAO,IAAMS,EACtB,KAAA,OAAO,MAAM,mCAAoCT,CAAI,EAC1D,KAAK,eAAe,WAClB,KAAK,gBAAgB,KACrBA,EAAO,IAAMS,EACbZ,CACF,EACO,KAEP,KAAK,OAAO,MACV,0DACF,EACO,GACT,CAGF,MAAa,gBACXmB,EACAC,EACAR,EACmB,CACnB,OAAO,KAAK,QAAQ,gBAAgBO,EAAOC,EAAaR,CAAM,CAAA,CAGhE,MAAa,aACXS,EACAC,EACiB,CACjB,OAAO,MAAM,KAAK,QAAQ,aAAaD,EAAUC,CAAS,CAAA,CAG5D,KACEnB,EACAoB,EACAC,EACAZ,EACkB,CAClB,OAAO,KAAK,QAAQ,KAAKT,EAAMoB,EAAOC,EAASZ,CAAM,CAAA,CAGvD,MAAM,gBAAgBT,EAAcsB,EAAiC,CACnE,OAAO,KAAK,QAAQ,gBAAgBtB,EAAMsB,CAAK,CAAA,CAGjD,MAAM,OAAOtB,EAA6D,CACjE,OAAA,KAAK,QAAQ,OAAOA,CAAI,CAAA,CAGjC,MAAM,KACJA,EACAuB,EACAC,EAC+C,CAC/C,OAAO,KAAK,QAAQ,KAAKxB,EAAMuB,EAASC,CAAgB,CAAA,CAE5D,EApMapB,EAANH,EAAA,CADNC,aAAW,EAUPC,aAAe,QAAQ,CAAA,EACvBA,aAAuB,gBAAgB,CAAA,EACvCA,aAAoB,aAAa,CAAA,CAAA,EAXzBC,CAAA,ECTN,MAAMqB,CAAc,CACzB,YAAYC,EAAsB,CAChCA,EACG,KAAsB,iBAAiB,EACvC,GAAGtB,CAAsB,EACzB,iBAAiB,EACpBsB,EACG,KAAqB,gBAAgB,EACrC,GAAGlC,CAAmB,EACtB,iBAAiB,CAAA,CAExB"}
|
|
1
|
+
{"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 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, PageData } from \"@xwiki/cristal-api\";\nimport { inject, injectable } from \"inversify\";\nimport type { Logger } from \"@xwiki/cristal-api\";\nimport type { OfflineStorage } from \"@xwiki/cristal-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 {\n AttachmentsData,\n Document,\n Logger,\n PageAttachment,\n PageData,\n Storage,\n WikiConfig,\n WrappingStorage,\n} from \"@xwiki/cristal-api\";\nimport type { OfflineStorage } from \"@xwiki/cristal-backend-api\";\nimport type { QueueWorker } from \"@xwiki/cristal-sharedworker-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(page: string, files: File[]): Promise<unknown> {\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 { WrappingStorage } from \"@xwiki/cristal-api\";\nimport { OfflineStorage } from \"@xwiki/cristal-backend-api\";\nimport { Container } from \"inversify\";\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":"oYAuBA,MAAqBA,UAAyBC,CAAM,CAGlD,YAAYC,EAAkB,CAC5B,MAAM,SAAWA,CAAQ,EACpB,KAAA,QAAQ,CAAC,EAAE,OAAO,CACrB,MAEE,0FAAA,CACH,CAAA,CAEL,0NCPA,IAAqBC,EAArB,KAAmE,CAOjE,YAA8BC,EAAgB,CANtC,KAAA,mBAAoD,IAO1D,KAAK,OAASA,EACT,KAAA,OAAO,UAAU,wCAAwC,CAAA,CAGhE,eAAeF,EAAoC,CACjD,IAAIG,EAAc,KAAK,eAAe,IAAIH,CAAQ,EAClD,OAAIG,GAAe,OACHA,EAAA,IAAIL,EAAiBE,CAAQ,EACtC,KAAA,eAAe,IAAIA,EAAUG,CAAW,GAExCA,CAAA,CAGT,MAAM,QAAQH,EAAkBI,EAA2C,CACrE,GAAA,CACG,KAAA,OAAO,MAAM,wCAAyCA,CAAE,EACvD,MAAAD,EAAc,KAAK,eAAeH,CAAQ,EAC3C,KAAA,OAAO,MAAM,uCAAuC,EACzD,MAAMK,EAAa,MAAMF,EAAY,MAAM,IAAIC,CAAE,EAC3CE,EAAW,IAAIC,kBACrB,OAAAD,EAAS,WAAWD,CAAU,EACvBC,QACAE,EAAG,CACL,KAAA,OAAO,MAAM,oDAAqDA,CAAC,EACjE,MAAA,CACT,CAGF,MAAM,SAASR,EAAkBI,EAAYK,EAA+B,CACtE,GAAA,CAIF,MAHoB,KAAK,eAAeT,CAAQ,EAG9B,MAAM,IAAIS,EAAK,WAAYL,CAAE,QACxCI,EAAG,CACV,KAAK,OAAO,MACV,mDACAR,EACAI,EACAK,EACAD,CACF,CAAA,CACF,CAGF,MAAM,WACJR,EACAI,EACAK,EACe,CACX,GAAA,CACI,MAAAN,EAAc,KAAK,eAAeH,CAAQ,EAC3C,KAAA,OAAO,MAAM,iBAAkBS,CAAI,EACxC,MAAMN,EAAY,MAAM,OAAOC,EAAIK,EAAK,UAAU,QAC3CD,EAAG,CACV,KAAK,OAAO,MACV,mDACAR,EACAI,EACAK,EACAD,CACF,CAAA,CACF,CAEJ,EAxEqBP,EAArBS,EAAA,CADCC,aAAW,EAQGC,aAAO,QAAQ,CAAA,CAAA,EAPTX,CAAA,2NCQd,IAAMY,EAAN,KAAwD,CAQ7D,YACoBX,EACQY,EACHC,EACvB,CACA,KAAK,OAASb,EACT,KAAA,OAAO,UAAU,2CAA2C,EACjE,KAAK,eAAiBY,EACtB,KAAK,YAAcC,CAAA,CAGd,WAAWC,EAAwB,CACxC,KAAK,QAAUA,CAAA,CAGV,YAAsB,CAC3B,OAAO,KAAK,OAAA,CAGP,cAAcC,EAA0B,CACtC,OAAA,KAAK,QAAQ,cAAcA,CAAM,CAAA,CAGnC,eAA4B,CAC1B,OAAA,KAAK,QAAQ,cAAc,CAAA,CAGpC,MAAa,gBAAmC,CACvC,OAAA,KAAK,QAAQ,eAAe,CAAA,CAG9B,eAAeR,EAAcS,EAAwB,CAC1D,OAAO,KAAK,QAAQ,eAAeT,EAAMS,CAAM,CAAA,CAG1C,mBAAmBC,EAA4B,CAC7C,OAAA,KAAK,QAAQ,mBAAmBA,CAAG,CAAA,CAGrC,YAAYV,EAAcW,EAAuB,CACtD,OAAO,KAAK,QAAQ,YAAYX,EAAMW,CAAK,CAAA,CAK7C,MAAa,eACXX,EACAS,EACAG,EACAC,EAC+B,CAE/B,GADK,KAAA,OAAO,MAAM,+BAAgCb,CAAI,EAClD,KAAK,eAAgB,CAClB,KAAA,OAAO,MAAM,8BAA+BA,CAAI,EAC/C,MAAAH,EAAW,MAAM,KAAK,eAAe,QACzC,KAAK,gBAAgB,KACrBG,EAAO,IAAMS,CACf,EACI,OAAAZ,GAAY,MAAQA,GAAY,MAC7B,KAAA,OAAO,MAAM,2CAA4CG,CAAI,GAE9Da,GAAW,MAAaA,IAC1B,KAAK,YAAY,WACf,KAAK,cAAc,EAAE,KAAO,IAAMb,EAAO,IAAMS,CACjD,EAEKZ,IAEP,KAAK,OAAO,MACV,gDACAG,CACF,EACO,KAAK,gBAAgBA,EAAMS,CAAM,EAC1C,KAEK,aAAA,OAAO,MAAM,oCAAoC,EAC/C,KAAK,QAAQ,eAAeT,EAAMS,CAAM,CACjD,CAGK,eAAeT,EAAoD,CAEjE,OAAA,KAAK,QAAQ,eAAeA,CAAI,CAAA,CAGzC,cACEA,EACAc,EACqC,CACrC,OAAO,KAAK,QAAQ,cAAcd,EAAMc,CAAI,CAAA,CAG9C,MAAc,gBACZd,EACAS,EACmB,CACnB,MAAMZ,EAAW,MAAM,KAAK,QAAQ,eAAeG,EAAMS,CAAM,EAC/D,GAAIZ,EACO,OAAAA,EAAA,GAAKG,EAAO,IAAMS,EACtB,KAAA,OAAO,MAAM,iCAAkCT,CAAI,EACxD,KAAK,eAAe,SAClB,KAAK,gBAAgB,KACrBA,EAAO,IAAMS,EACbZ,CACF,EAEOA,EAED,MAAA,IAAI,MAAM,0BAA0B,CAC5C,CAKF,MAAa,kBACXG,EACAS,EACkB,CACZ,MAAAM,EAAkB,MAAM,KAAK,eAAe,QAChD,KAAK,gBAAgB,KACrBf,EAAO,IAAMS,CACf,EACMZ,EAAW,MAAM,KAAK,QAAQ,eAAeG,EAAMS,CAAM,EAC/D,OAAIM,GAAmBlB,GACZA,EAAA,GAAKG,EAAO,IAAMS,EACtB,KAAA,OAAO,MAAM,iCAAkCT,CAAI,EACxD,KAAK,eAAe,SAClB,KAAK,gBAAgB,KACrBA,EAAO,IAAMS,EACbZ,CACF,EACO,KACEkB,GAAA,YAAAA,EAAiB,WAAWlB,GAAA,YAAAA,EAAU,UAAWA,GACjDA,EAAA,GAAKG,EAAO,IAAMS,EACtB,KAAA,OAAO,MAAM,mCAAoCT,CAAI,EAC1D,KAAK,eAAe,WAClB,KAAK,gBAAgB,KACrBA,EAAO,IAAMS,EACbZ,CACF,EACO,KAEP,KAAK,OAAO,MACV,0DACF,EACO,GACT,CAGF,MAAa,gBACXmB,EACAC,EACAR,EACmB,CACnB,OAAO,KAAK,QAAQ,gBAAgBO,EAAOC,EAAaR,CAAM,CAAA,CAGhE,MAAa,aACXS,EACAC,EACiB,CACjB,OAAO,MAAM,KAAK,QAAQ,aAAaD,EAAUC,CAAS,CAAA,CAG5D,KACEnB,EACAoB,EACAC,EACAZ,EACkB,CAClB,OAAO,KAAK,QAAQ,KAAKT,EAAMoB,EAAOC,EAASZ,CAAM,CAAA,CAGvD,MAAM,gBAAgBT,EAAcsB,EAAiC,CACnE,OAAO,KAAK,QAAQ,gBAAgBtB,EAAMsB,CAAK,CAAA,CAGjD,MAAM,OAAOtB,EAA6D,CACjE,OAAA,KAAK,QAAQ,OAAOA,CAAI,CAAA,CAGjC,MAAM,KACJA,EACAuB,EACAC,EAC+C,CAC/C,OAAO,KAAK,QAAQ,KAAKxB,EAAMuB,EAASC,CAAgB,CAAA,CAE5D,EApMapB,EAANH,EAAA,CADNC,aAAW,EAUPC,aAAO,QAAQ,CAAA,EACfA,aAAO,gBAAgB,CAAA,EACvBA,aAAO,aAAa,CAAA,CAAA,EAXZC,CAAA,ECTN,MAAMqB,CAAc,CACzB,YAAYC,EAAsB,CAChCA,EACG,KAAsB,iBAAiB,EACvC,GAAGtB,CAAsB,EACzB,iBAAiB,EACpBsB,EACG,KAAqB,gBAAgB,EACrC,GAAGlC,CAAmB,EACtB,iBAAiB,CAAA,CAExB"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xwiki/cristal-backend-dexie",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.16.0",
|
|
4
4
|
"license": "LGPL 2.1",
|
|
5
5
|
"author": "XWiki Org Community <contact@xwiki.org>",
|
|
6
6
|
"homepage": "https://cristal.xwiki.org/",
|
|
@@ -23,19 +23,19 @@
|
|
|
23
23
|
"main": "./dist/index.es.js",
|
|
24
24
|
"dependencies": {
|
|
25
25
|
"dexie": "4.0.11",
|
|
26
|
-
"inversify": "
|
|
27
|
-
"@xwiki/cristal-
|
|
28
|
-
"@xwiki/cristal-api": "0.
|
|
29
|
-
"@xwiki/cristal-
|
|
26
|
+
"inversify": "7.1.0",
|
|
27
|
+
"@xwiki/cristal-api": "0.16.0",
|
|
28
|
+
"@xwiki/cristal-sharedworker-api": "0.16.0",
|
|
29
|
+
"@xwiki/cristal-backend-api": "0.16.0"
|
|
30
30
|
},
|
|
31
31
|
"peerDependencies": {
|
|
32
32
|
"reflect-metadata": "0.2.2"
|
|
33
33
|
},
|
|
34
34
|
"devDependencies": {
|
|
35
35
|
"reflect-metadata": "0.2.2",
|
|
36
|
-
"typescript": "5.
|
|
37
|
-
"vite": "6.
|
|
38
|
-
"@xwiki/cristal-dev-config": "0.
|
|
36
|
+
"typescript": "5.8.2",
|
|
37
|
+
"vite": "6.2.2",
|
|
38
|
+
"@xwiki/cristal-dev-config": "0.16.0"
|
|
39
39
|
},
|
|
40
40
|
"scripts": {
|
|
41
41
|
"build": "tsc --project tsconfig.json && vite build",
|
|
@@ -32,7 +32,7 @@ export default class DexieOfflineStorage implements OfflineStorage {
|
|
|
32
32
|
>();
|
|
33
33
|
private logger: Logger;
|
|
34
34
|
|
|
35
|
-
constructor(@inject
|
|
35
|
+
constructor(@inject("Logger") logger: Logger) {
|
|
36
36
|
this.logger = logger;
|
|
37
37
|
this.logger.setModule("storage.components.dexieOfflineStorage");
|
|
38
38
|
}
|
package/src/dexiePageStorage.ts
CHANGED
|
@@ -42,9 +42,9 @@ export class WrappingOfflineStorage implements WrappingStorage {
|
|
|
42
42
|
public queueWorker: QueueWorker;
|
|
43
43
|
|
|
44
44
|
constructor(
|
|
45
|
-
@inject
|
|
46
|
-
@inject
|
|
47
|
-
@inject
|
|
45
|
+
@inject("Logger") logger: Logger,
|
|
46
|
+
@inject("OfflineStorage") offlineStorage: OfflineStorage,
|
|
47
|
+
@inject("QueueWorker") queueWorker: QueueWorker,
|
|
48
48
|
) {
|
|
49
49
|
this.logger = logger;
|
|
50
50
|
this.logger.setModule("storage.components.wrappingOfflineStorage");
|