@xwiki/cristal-sharedworker-impl 0.8.0

package/dist/components/componentsInit.d.ts

@@ -0,0 +1,5 @@
+import { Container } from 'inversify';
+
+export default class ComponentInit {
+    constructor(container: Container);
+}

package/dist/components/defaultQueueWorker.d.ts

@@ -0,0 +1,15 @@
+import { QueueWorker } from '@xwiki/cristal-sharedworker-api';
+import { CristalApp, Logger } from '@xwiki/cristal-api';
+
+export default class DefaultQueueWorker implements QueueWorker {
+    private workerInstance;
+    private cristalApp;
+    private logger;
+    constructor(logger: Logger, cristalApp: CristalApp);
+    pageLoaded(page: string): void;
+    initialize(): void;
+    getStatus(): boolean;
+    increment(): Promise<number>;
+    addToQueue(page: string): Promise<void>;
+    getQueueSize(): Promise<number>;
+}

package/dist/components/worker.d.ts

@@ -0,0 +1,22 @@
+import { MyWorker } from '@xwiki/cristal-sharedworker-api';
+import { WikiConfig } from '@xwiki/cristal-api';
+
+export declare class Worker implements MyWorker {
+    private currentNumber;
+    private queue;
+    private container;
+    private cristal;
+    private configMap;
+    private initialized;
+    private fct;
+    start(): Promise<void>;
+    setPageLoadedCallback(fct: (a: string) => void): void;
+    sleep(ms: number): Promise<unknown>;
+    checkQueue(): Promise<void>;
+    handleQueueItem(page: string): Promise<void>;
+    add(a: number): number;
+    addToQueue(page: string): void;
+    getQueueSize(): number;
+    getWikiConfig(configName: string): WikiConfig | undefined;
+    initialize(): Promise<void>;
+}

package/dist/components/workerCristalApp.d.ts

@@ -0,0 +1,36 @@
+import { CristalApp as CristalApp, Logger, LoggerConfig, PageData, SkinManager, WikiConfig } from '@xwiki/cristal-api';
+import { Container } from 'inversify';
+import { App, Component } from 'vue';
+import { Router } from 'vue-router';
+
+export declare class WorkerCristalApp implements CristalApp {
+    private wikiConfig;
+    private container;
+    private availableConfigurations;
+    constructor();
+    getApp(): App;
+    getRouter(): Router;
+    getContainer(): Container;
+    setContainer(container: Container): void;
+    getWikiConfig(): WikiConfig;
+    setWikiConfig(wikiConfig: WikiConfig): void;
+    getSkinManager(): SkinManager;
+    switchConfig(): void;
+    setAvailableConfigurations(config: Map<string, any>): void;
+    getAvailableConfigurations(): Map<string, WikiConfig>;
+    run(): Promise<void>;
+    getUIXTemplates(): Component[];
+    getMenuEntries(): string[];
+    getCurrentPage(): string;
+    getCurrentContent(): string;
+    getCurrentSource(): string;
+    getCurrentSyntax(): string;
+    setCurrentPage(): void;
+    setContentRef(): void;
+    loadPageFromURL(): Promise<void>;
+    loadPage(): Promise<void>;
+    getPage(): Promise<PageData>;
+    getLogger(): Logger;
+    getLoggerConfig(): LoggerConfig;
+    renderContent(): Promise<string>;
+}

package/dist/components/workerQueueWorker.d.ts

@@ -0,0 +1,10 @@
+import { QueueWorker } from '@xwiki/cristal-sharedworker-api';
+
+export default class WorkerQueueWorker implements QueueWorker {
+    constructor();
+    initialize(): void;
+    getStatus(): boolean;
+    increment(): Promise<number>;
+    addToQueue(): Promise<void>;
+    getQueueSize(): Promise<number>;
+}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import { default as ComponentInit } from './components/componentsInit';
+import { QueueWorker } from '@xwiki/cristal-sharedworker-api';
+
+export type { QueueWorker };
+export { ComponentInit };

package/dist/index.es.js

@@ -0,0 +1,107 @@
+import { injectable as d, inject as i } from "inversify";
+import * as c from "comlink";
+function g(e) {
+  return new SharedWorker(
+    "/assets/worker-D2exZhnK.js",
+    {
+      name: e == null ? void 0 : e.name
+    }
+  );
+}
+var h = Object.defineProperty, w = Object.getOwnPropertyDescriptor, k = (e, r, n, o) => {
+  for (var t = o > 1 ? void 0 : o ? w(r, n) : r, a = e.length - 1, l; a >= 0; a--)
+    (l = e[a]) && (t = (o ? l(r, n, t) : l(t)) || t);
+  return o && t && h(r, n, t), t;
+}, u = (e, r) => (n, o) => r(n, o, e);
+let s = class {
+  constructor(e, r) {
+    this.initialize(), this.logger = e, this.cristalApp = r;
+  }
+  pageLoaded(e) {
+    try {
+      this.logger.debug(
+        "Received callback that new document has been loaded",
+        e
+      ), this.cristalApp.loadPage({
+        requeue: !1
+      }), this.logger.debug(
+        "Done callback that new document has been loaded",
+        e
+      );
+    } catch (r) {
+      this.logger.error("Error calling loadPage", r);
+    }
+  }
+  initialize() {
+    try {
+      if (this.workerInstance == null) {
+        const e = new g();
+        this.workerInstance = c.wrap(e.port);
+        const r = this;
+        this.workerInstance.setPageLoadedCallback(
+          c.proxy(function(n) {
+            r.pageLoaded(n);
+          })
+        ), console.debug("Worker initialized", this.workerInstance);
+      } else
+        console.debug("Already initialized");
+    } catch (e) {
+      console.error("Failed to initialize shared worker", e);
+    }
+  }
+  getStatus() {
+    return this.workerInstance != null ? (console.log("workerInstance is ready"), !0) : (console.log("workerInstance is null. Cannot call"), !1);
+  }
+  async increment() {
+    if (this.workerInstance == null)
+      return console.log("workerInstance is null. Cannot call"), -1;
+    {
+      const e = await this.workerInstance.add(1);
+      return console.log("Results from shared worker: ", e), e;
+    }
+  }
+  async addToQueue(e) {
+    console.log("worker Calling addToQueue", e), this.workerInstance != null ? await this.workerInstance.addToQueue(e) : console.log("workerInstance is null. Cannot call");
+  }
+  async getQueueSize() {
+    return console.log("worker Calling getQueueSize"), this.workerInstance == null ? -1 : await this.workerInstance.getQueueSize();
+  }
+};
+s = k([
+  d(),
+  u(0, i("Logger")),
+  u(1, i("CristalApp"))
+], s);
+/**
+ * See the LICENSE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ *
+ * This file is part of the Cristal Wiki software prototype
+ * @copyright  Copyright (c) 2023 XWiki SAS
+ * @license    http://opensource.org/licenses/AGPL-3.0 AGPL-3.0
+ *
+ **/
+class p {
+  constructor(r) {
+    r.bind("QueueWorker").to(s);
+  }
+}
+export {
+  p as ComponentInit
+};
+//# sourceMappingURL=index.es.js.map

package/dist/index.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.es.js","sources":["../src/components/defaultQueueWorker.ts","../src/components/componentsInit.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 Affero 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 Affero 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 * This file is part of the Cristal Wiki software prototype\n * @copyright  Copyright (c) 2023 XWiki SAS\n * @license    http://opensource.org/licenses/AGPL-3.0 AGPL-3.0\n *\n **/\n\nimport { inject, injectable } from \"inversify\";\nimport type { MyWorker, QueueWorker } from \"@xwiki/cristal-sharedworker-api\";\nimport * as Comlink from \"comlink\";\nimport Worker from \"./worker?sharedworker\";\nimport { type CristalApp, type Logger } from \"@xwiki/cristal-api\";\n\n@injectable()\nexport default class DefaultQueueWorker implements QueueWorker {\n  // TODO remove use of any\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  private workerInstance: any;\n  private cristalApp: CristalApp;\n  private logger: Logger;\n\n  public constructor(\n    @inject<Logger>(\"Logger\") logger: Logger,\n    @inject<CristalApp>(\"CristalApp\") cristalApp: CristalApp,\n  ) {\n    this.initialize();\n    this.logger = logger;\n    this.cristalApp = cristalApp;\n  }\n\n  public pageLoaded(page: string) {\n    try {\n      this.logger.debug(\n        \"Received callback that new document has been loaded\",\n        page,\n      );\n      // When reloading the page for the worker, prevents a requeue to avoid\n      // an endless re-fetch of the current page.\n      this.cristalApp.loadPage({\n        requeue: false,\n      });\n      this.logger.debug(\n        \"Done callback that new document has been loaded\",\n        page,\n      );\n    } catch (e) {\n      this.logger.error(\"Error calling loadPage\", e);\n    }\n  }\n\n  public initialize() {\n    try {\n      if (this.workerInstance == null) {\n        // this.workerInstance = new ComlinkWorker<typeof import('./worker')>(new URL('./worker',\n        // import.meta.url), {/* normal Worker options*/})\n        const sworker = new Worker();\n        this.workerInstance = Comlink.wrap<MyWorker>(sworker.port);\n        // TODO get rid of aliasing\n        // eslint-disable-next-line @typescript-eslint/no-this-alias\n        const that = this;\n        this.workerInstance.setPageLoadedCallback(\n          Comlink.proxy(function (page: string) {\n            that.pageLoaded(page);\n          }),\n        );\n\n        console.debug(\"Worker initialized\", this.workerInstance);\n      } else {\n        console.debug(\"Already initialized\");\n      }\n    } catch (e) {\n      console.error(\"Failed to initialize shared worker\", e);\n    }\n  }\n\n  public getStatus(): boolean {\n    if (this.workerInstance != null) {\n      console.log(\"workerInstance is ready\");\n      return true;\n    } else {\n      console.log(\"workerInstance is null. Cannot call\");\n      return false;\n    }\n  }\n\n  public async increment(): Promise<number> {\n    if (this.workerInstance == null) {\n      console.log(\"workerInstance is null. Cannot call\");\n      return -1;\n    } else {\n      const result = await this.workerInstance.add(1);\n      console.log(\"Results from shared worker: \", result);\n      return result;\n    }\n  }\n\n  public async addToQueue(page: string): Promise<void> {\n    console.log(\"worker Calling addToQueue\", page);\n    if (this.workerInstance != null) {\n      await this.workerInstance.addToQueue(page);\n    } else {\n      console.log(\"workerInstance is null. Cannot call\");\n    }\n  }\n\n  public async getQueueSize(): Promise<number> {\n    console.log(\"worker Calling getQueueSize\");\n    if (this.workerInstance == null) return -1;\n    else return await this.workerInstance.getQueueSize();\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 Affero 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 Affero 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 * This file is part of the Cristal Wiki software prototype\n * @copyright  Copyright (c) 2023 XWiki SAS\n * @license    http://opensource.org/licenses/AGPL-3.0 AGPL-3.0\n *\n **/\n\nimport type { Container } from \"inversify\";\nimport type { QueueWorker } from \"@xwiki/cristal-sharedworker-api\";\nimport DefaultQueueWorker from \"./defaultQueueWorker\";\n\nexport default class ComponentInit {\n  constructor(container: Container) {\n    container.bind<QueueWorker>(\"QueueWorker\").to(DefaultQueueWorker);\n  }\n}\n"],"names":["DefaultQueueWorker","logger","cristalApp","page","e","sworker","Worker","Comlink","that","result","__decorateClass","injectable","__decorateParam","ComponentInit","container"],"mappings":";;;;;;;;;;;;;;;AAgCA,IAAqBA,IAArB,MAA+D;AAAA,EAOtD,YACqBC,GACQC,GAClC;AACA,SAAK,WAAW,GAChB,KAAK,SAASD,GACd,KAAK,aAAaC;AAAA,EACpB;AAAA,EAEO,WAAWC,GAAc;AAC1B,QAAA;AACF,WAAK,OAAO;AAAA,QACV;AAAA,QACAA;AAAA,MAAA,GAIF,KAAK,WAAW,SAAS;AAAA,QACvB,SAAS;AAAA,MAAA,CACV,GACD,KAAK,OAAO;AAAA,QACV;AAAA,QACAA;AAAA,MAAA;AAAA,aAEKC,GAAG;AACL,WAAA,OAAO,MAAM,0BAA0BA,CAAC;AAAA,IAC/C;AAAA,EACF;AAAA,EAEO,aAAa;AACd,QAAA;AACE,UAAA,KAAK,kBAAkB,MAAM;AAGzB,cAAAC,IAAU,IAAIC;AACpB,aAAK,iBAAiBC,EAAQ,KAAeF,EAAQ,IAAI;AAGzD,cAAMG,IAAO;AACb,aAAK,eAAe;AAAA,UAClBD,EAAQ,MAAM,SAAUJ,GAAc;AACpC,YAAAK,EAAK,WAAWL,CAAI;AAAA,UAAA,CACrB;AAAA,QAAA,GAGK,QAAA,MAAM,sBAAsB,KAAK,cAAc;AAAA,MAAA;AAEvD,gBAAQ,MAAM,qBAAqB;AAAA,aAE9B,GAAG;AACF,cAAA,MAAM,sCAAsC,CAAC;AAAA,IACvD;AAAA,EACF;AAAA,EAEO,YAAqB;AACtB,WAAA,KAAK,kBAAkB,QACzB,QAAQ,IAAI,yBAAyB,GAC9B,OAEP,QAAQ,IAAI,qCAAqC,GAC1C;AAAA,EAEX;AAAA,EAEA,MAAa,YAA6B;AACpC,QAAA,KAAK,kBAAkB;AACzB,qBAAQ,IAAI,qCAAqC,GAC1C;AACF;AACL,YAAMM,IAAS,MAAM,KAAK,eAAe,IAAI,CAAC;AACtC,qBAAA,IAAI,gCAAgCA,CAAM,GAC3CA;AAAA,IACT;AAAA,EACF;AAAA,EAEA,MAAa,WAAWN,GAA6B;AAC3C,YAAA,IAAI,6BAA6BA,CAAI,GACzC,KAAK,kBAAkB,OACnB,MAAA,KAAK,eAAe,WAAWA,CAAI,IAEzC,QAAQ,IAAI,qCAAqC;AAAA,EAErD;AAAA,EAEA,MAAa,eAAgC;AAE3C,WADA,QAAQ,IAAI,6BAA6B,GACrC,KAAK,kBAAkB,OAAa,KAC5B,MAAM,KAAK,eAAe;EACxC;AACF;AAhGqBH,IAArBU,EAAA;AAAA,EADCC,EAAW;AAAA,EASPC,OAAe,QAAQ,CAAA;AAAA,EACvBA,OAAmB,YAAY,CAAA;AAAA,GATfZ,CAAA;AChCrB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA6BA,MAAqBa,EAAc;AAAA,EACjC,YAAYC,GAAsB;AAChC,IAAAA,EAAU,KAAkB,aAAa,EAAE,GAAGd,CAAkB;AAAA,EAClE;AACF;"}

package/dist/index.umd.js

@@ -0,0 +1,25 @@
+(function(o,a){typeof exports=="object"&&typeof module<"u"?a(exports,require("inversify"),require("comlink")):typeof define=="function"&&define.amd?define(["exports","inversify","comlink"],a):(o=typeof globalThis<"u"?globalThis:o||self,a(o.cristal_impl={},o.inversify,o.Comlink))})(this,function(o,a,f){"use strict";function g(e){const r=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(e){for(const n in e)if(n!=="default"){const t=Object.getOwnPropertyDescriptor(e,n);Object.defineProperty(r,n,t.get?t:{enumerable:!0,get:()=>e[n]})}}return r.default=e,Object.freeze(r)}const u=g(f);function h(e){return new SharedWorker("/assets/worker-D2exZhnK.js",{name:e==null?void 0:e.name})}var w=Object.defineProperty,k=Object.getOwnPropertyDescriptor,p=(e,r,n,t)=>{for(var l=t>1?void 0:t?k(r,n):r,i=e.length-1,c;i>=0;i--)(c=e[i])&&(l=(t?c(r,n,l):c(l))||l);return t&&l&&w(r,n,l),l},d=(e,r)=>(n,t)=>r(n,t,e);let s=class{constructor(e,r){this.initialize(),this.logger=e,this.cristalApp=r}pageLoaded(e){try{this.logger.debug("Received callback that new document has been loaded",e),this.cristalApp.loadPage({requeue:!1}),this.logger.debug("Done callback that new document has been loaded",e)}catch(r){this.logger.error("Error calling loadPage",r)}}initialize(){try{if(this.workerInstance==null){const e=new h;this.workerInstance=u.wrap(e.port);const r=this;this.workerInstance.setPageLoadedCallback(u.proxy(function(n){r.pageLoaded(n)})),console.debug("Worker initialized",this.workerInstance)}else console.debug("Already initialized")}catch(e){console.error("Failed to initialize shared worker",e)}}getStatus(){return this.workerInstance!=null?(console.log("workerInstance is ready"),!0):(console.log("workerInstance is null. Cannot call"),!1)}async increment(){if(this.workerInstance==null)return console.log("workerInstance is null. Cannot call"),-1;{const e=await this.workerInstance.add(1);return console.log("Results from shared worker: ",e),e}}async addToQueue(e){console.log("worker Calling addToQueue",e),this.workerInstance!=null?await this.workerInstance.addToQueue(e):console.log("workerInstance is null. Cannot call")}async getQueueSize(){return console.log("worker Calling getQueueSize"),this.workerInstance==null?-1:await this.workerInstance.getQueueSize()}};s=p([a.injectable(),d(0,a.inject("Logger")),d(1,a.inject("CristalApp"))],s);/**
+ * See the LICENSE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ *
+ * This file is part of the Cristal Wiki software prototype
+ * @copyright  Copyright (c) 2023 XWiki SAS
+ * @license    http://opensource.org/licenses/AGPL-3.0 AGPL-3.0
+ *
+ **/class m{constructor(r){r.bind("QueueWorker").to(s)}}o.ComponentInit=m,Object.defineProperty(o,Symbol.toStringTag,{value:"Module"})});
+//# sourceMappingURL=index.umd.js.map

package/dist/index.umd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.umd.js","sources":["../src/components/defaultQueueWorker.ts","../src/components/componentsInit.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 Affero 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 Affero 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 * This file is part of the Cristal Wiki software prototype\n * @copyright  Copyright (c) 2023 XWiki SAS\n * @license    http://opensource.org/licenses/AGPL-3.0 AGPL-3.0\n *\n **/\n\nimport { inject, injectable } from \"inversify\";\nimport type { MyWorker, QueueWorker } from \"@xwiki/cristal-sharedworker-api\";\nimport * as Comlink from \"comlink\";\nimport Worker from \"./worker?sharedworker\";\nimport { type CristalApp, type Logger } from \"@xwiki/cristal-api\";\n\n@injectable()\nexport default class DefaultQueueWorker implements QueueWorker {\n  // TODO remove use of any\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  private workerInstance: any;\n  private cristalApp: CristalApp;\n  private logger: Logger;\n\n  public constructor(\n    @inject<Logger>(\"Logger\") logger: Logger,\n    @inject<CristalApp>(\"CristalApp\") cristalApp: CristalApp,\n  ) {\n    this.initialize();\n    this.logger = logger;\n    this.cristalApp = cristalApp;\n  }\n\n  public pageLoaded(page: string) {\n    try {\n      this.logger.debug(\n        \"Received callback that new document has been loaded\",\n        page,\n      );\n      // When reloading the page for the worker, prevents a requeue to avoid\n      // an endless re-fetch of the current page.\n      this.cristalApp.loadPage({\n        requeue: false,\n      });\n      this.logger.debug(\n        \"Done callback that new document has been loaded\",\n        page,\n      );\n    } catch (e) {\n      this.logger.error(\"Error calling loadPage\", e);\n    }\n  }\n\n  public initialize() {\n    try {\n      if (this.workerInstance == null) {\n        // this.workerInstance = new ComlinkWorker<typeof import('./worker')>(new URL('./worker',\n        // import.meta.url), {/* normal Worker options*/})\n        const sworker = new Worker();\n        this.workerInstance = Comlink.wrap<MyWorker>(sworker.port);\n        // TODO get rid of aliasing\n        // eslint-disable-next-line @typescript-eslint/no-this-alias\n        const that = this;\n        this.workerInstance.setPageLoadedCallback(\n          Comlink.proxy(function (page: string) {\n            that.pageLoaded(page);\n          }),\n        );\n\n        console.debug(\"Worker initialized\", this.workerInstance);\n      } else {\n        console.debug(\"Already initialized\");\n      }\n    } catch (e) {\n      console.error(\"Failed to initialize shared worker\", e);\n    }\n  }\n\n  public getStatus(): boolean {\n    if (this.workerInstance != null) {\n      console.log(\"workerInstance is ready\");\n      return true;\n    } else {\n      console.log(\"workerInstance is null. Cannot call\");\n      return false;\n    }\n  }\n\n  public async increment(): Promise<number> {\n    if (this.workerInstance == null) {\n      console.log(\"workerInstance is null. Cannot call\");\n      return -1;\n    } else {\n      const result = await this.workerInstance.add(1);\n      console.log(\"Results from shared worker: \", result);\n      return result;\n    }\n  }\n\n  public async addToQueue(page: string): Promise<void> {\n    console.log(\"worker Calling addToQueue\", page);\n    if (this.workerInstance != null) {\n      await this.workerInstance.addToQueue(page);\n    } else {\n      console.log(\"workerInstance is null. Cannot call\");\n    }\n  }\n\n  public async getQueueSize(): Promise<number> {\n    console.log(\"worker Calling getQueueSize\");\n    if (this.workerInstance == null) return -1;\n    else return await this.workerInstance.getQueueSize();\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 Affero 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 Affero 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 * This file is part of the Cristal Wiki software prototype\n * @copyright  Copyright (c) 2023 XWiki SAS\n * @license    http://opensource.org/licenses/AGPL-3.0 AGPL-3.0\n *\n **/\n\nimport type { Container } from \"inversify\";\nimport type { QueueWorker } from \"@xwiki/cristal-sharedworker-api\";\nimport DefaultQueueWorker from \"./defaultQueueWorker\";\n\nexport default class ComponentInit {\n  constructor(container: Container) {\n    container.bind<QueueWorker>(\"QueueWorker\").to(DefaultQueueWorker);\n  }\n}\n"],"names":["DefaultQueueWorker","logger","cristalApp","page","e","sworker","Worker","Comlink","that","result","__decorateClass","injectable","__decorateParam","ComponentInit","container"],"mappings":"g5BAgCA,IAAqBA,EAArB,KAA+D,CAOtD,YACqBC,EACQC,EAClC,CACA,KAAK,WAAW,EAChB,KAAK,OAASD,EACd,KAAK,WAAaC,CACpB,CAEO,WAAWC,EAAc,CAC1B,GAAA,CACF,KAAK,OAAO,MACV,sDACAA,CAAA,EAIF,KAAK,WAAW,SAAS,CACvB,QAAS,EAAA,CACV,EACD,KAAK,OAAO,MACV,kDACAA,CAAA,QAEKC,EAAG,CACL,KAAA,OAAO,MAAM,yBAA0BA,CAAC,CAC/C,CACF,CAEO,YAAa,CACd,GAAA,CACE,GAAA,KAAK,gBAAkB,KAAM,CAGzB,MAAAC,EAAU,IAAIC,EACpB,KAAK,eAAiBC,EAAQ,KAAeF,EAAQ,IAAI,EAGzD,MAAMG,EAAO,KACb,KAAK,eAAe,sBAClBD,EAAQ,MAAM,SAAUJ,EAAc,CACpCK,EAAK,WAAWL,CAAI,CAAA,CACrB,CAAA,EAGK,QAAA,MAAM,qBAAsB,KAAK,cAAc,CAAA,MAEvD,QAAQ,MAAM,qBAAqB,QAE9B,EAAG,CACF,QAAA,MAAM,qCAAsC,CAAC,CACvD,CACF,CAEO,WAAqB,CACtB,OAAA,KAAK,gBAAkB,MACzB,QAAQ,IAAI,yBAAyB,EAC9B,KAEP,QAAQ,IAAI,qCAAqC,EAC1C,GAEX,CAEA,MAAa,WAA6B,CACpC,GAAA,KAAK,gBAAkB,KACzB,eAAQ,IAAI,qCAAqC,EAC1C,GACF,CACL,MAAMM,EAAS,MAAM,KAAK,eAAe,IAAI,CAAC,EACtC,eAAA,IAAI,+BAAgCA,CAAM,EAC3CA,CACT,CACF,CAEA,MAAa,WAAWN,EAA6B,CAC3C,QAAA,IAAI,4BAA6BA,CAAI,EACzC,KAAK,gBAAkB,KACnB,MAAA,KAAK,eAAe,WAAWA,CAAI,EAEzC,QAAQ,IAAI,qCAAqC,CAErD,CAEA,MAAa,cAAgC,CAE3C,OADA,QAAQ,IAAI,6BAA6B,EACrC,KAAK,gBAAkB,KAAa,GAC5B,MAAM,KAAK,eAAe,cACxC,CACF,EAhGqBH,EAArBU,EAAA,CADCC,aAAW,EASPC,aAAe,QAAQ,CAAA,EACvBA,aAAmB,YAAY,CAAA,CAAA,EATfZ,CAAA,EChCrB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IA6BA,MAAqBa,CAAc,CACjC,YAAYC,EAAsB,CAChCA,EAAU,KAAkB,aAAa,EAAE,GAAGd,CAAkB,CAClE,CACF"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@xwiki/cristal-sharedworker-impl",
+  "version": "0.8.0",
+  "license": "AGPL-3.0",
+  "author": "XWiki Org Community <contact@xwiki.org>",
+  "homepage": "https://cristal.xwiki.org/",
+  "repository": {
+    "type": "git",
+    "directory": "sharedworker/impl",
+    "url": "https://github.com/xwiki-contrib/cristal/"
+  },
+  "bugs": {
+    "url": "https://jira.xwiki.org/projects/CRISTAL/"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.umd.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "./dist/index.es.js",
+  "types": "./dist/index.d.ts",
+  "dependencies": {
+    "comlink": "4.4.1",
+    "inversify": "6.0.2",
+    "vue": "3.4.27",
+    "vue-i18n": "9.13.1",
+    "vue-router": "4.3.2",
+    "@xwiki/cristal-api": "0.8.0",
+    "@xwiki/cristal-sharedworker-api": "0.8.0",
+    "@xwiki/cristal-storage": "0.8.0",
+    "@xwiki/cristal-extension-manager": "0.8.0"
+  },
+  "devDependencies": {
+    "rimraf": "5.0.7",
+    "vite": "5.2.11",
+    "vite-plugin-comlink": "4.0.2",
+    "vue-tsc": "2.0.19"
+  },
+  "scripts": {
+    "build": "pnpm compile",
+    "clean": "rimraf dist",
+    "compile": "vue-tsc --project tsconfig.json --noEmit && vite build",
+    "lint": "eslint \"./src/**/*.{ts,tsx}\" --max-warnings=0",
+    "test": "echo 'no test'"
+  }
+}

package/src/components/componentsInit.ts

@@ -0,0 +1,34 @@
+/**
+ * See the LICENSE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ *
+ * This file is part of the Cristal Wiki software prototype
+ * @copyright  Copyright (c) 2023 XWiki SAS
+ * @license    http://opensource.org/licenses/AGPL-3.0 AGPL-3.0
+ *
+ **/
+
+import type { Container } from "inversify";
+import type { QueueWorker } from "@xwiki/cristal-sharedworker-api";
+import DefaultQueueWorker from "./defaultQueueWorker";
+
+export default class ComponentInit {
+  constructor(container: Container) {
+    container.bind<QueueWorker>("QueueWorker").to(DefaultQueueWorker);
+  }
+}

package/src/components/defaultQueueWorker.ts

@@ -0,0 +1,129 @@
+/**
+ * See the LICENSE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ *
+ * This file is part of the Cristal Wiki software prototype
+ * @copyright  Copyright (c) 2023 XWiki SAS
+ * @license    http://opensource.org/licenses/AGPL-3.0 AGPL-3.0
+ *
+ **/
+
+import { inject, injectable } from "inversify";
+import type { MyWorker, QueueWorker } from "@xwiki/cristal-sharedworker-api";
+import * as Comlink from "comlink";
+import Worker from "./worker?sharedworker";
+import { type CristalApp, type Logger } from "@xwiki/cristal-api";
+
+@injectable()
+export default class DefaultQueueWorker implements QueueWorker {
+  // TODO remove use of any
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  private workerInstance: any;
+  private cristalApp: CristalApp;
+  private logger: Logger;
+
+  public constructor(
+    @inject<Logger>("Logger") logger: Logger,
+    @inject<CristalApp>("CristalApp") cristalApp: CristalApp,
+  ) {
+    this.initialize();
+    this.logger = logger;
+    this.cristalApp = cristalApp;
+  }
+
+  public pageLoaded(page: string) {
+    try {
+      this.logger.debug(
+        "Received callback that new document has been loaded",
+        page,
+      );
+      // When reloading the page for the worker, prevents a requeue to avoid
+      // an endless re-fetch of the current page.
+      this.cristalApp.loadPage({
+        requeue: false,
+      });
+      this.logger.debug(
+        "Done callback that new document has been loaded",
+        page,
+      );
+    } catch (e) {
+      this.logger.error("Error calling loadPage", e);
+    }
+  }
+
+  public initialize() {
+    try {
+      if (this.workerInstance == null) {
+        // this.workerInstance = new ComlinkWorker<typeof import('./worker')>(new URL('./worker',
+        // import.meta.url), {/* normal Worker options*/})
+        const sworker = new Worker();
+        this.workerInstance = Comlink.wrap<MyWorker>(sworker.port);
+        // TODO get rid of aliasing
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        const that = this;
+        this.workerInstance.setPageLoadedCallback(
+          Comlink.proxy(function (page: string) {
+            that.pageLoaded(page);
+          }),
+        );
+
+        console.debug("Worker initialized", this.workerInstance);
+      } else {
+        console.debug("Already initialized");
+      }
+    } catch (e) {
+      console.error("Failed to initialize shared worker", e);
+    }
+  }
+
+  public getStatus(): boolean {
+    if (this.workerInstance != null) {
+      console.log("workerInstance is ready");
+      return true;
+    } else {
+      console.log("workerInstance is null. Cannot call");
+      return false;
+    }
+  }
+
+  public async increment(): Promise<number> {
+    if (this.workerInstance == null) {
+      console.log("workerInstance is null. Cannot call");
+      return -1;
+    } else {
+      const result = await this.workerInstance.add(1);
+      console.log("Results from shared worker: ", result);
+      return result;
+    }
+  }
+
+  public async addToQueue(page: string): Promise<void> {
+    console.log("worker Calling addToQueue", page);
+    if (this.workerInstance != null) {
+      await this.workerInstance.addToQueue(page);
+    } else {
+      console.log("workerInstance is null. Cannot call");
+    }
+  }
+
+  public async getQueueSize(): Promise<number> {
+    console.log("worker Calling getQueueSize");
+    if (this.workerInstance == null) return -1;
+    else return await this.workerInstance.getQueueSize();
+  }
+}