@xwiki/cristal-settings-browser 1.4.0 → 1.6.0

package/api-extractor.json

@@ -1,4 +1,4 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "extends": "../../../api-extractor.json"
+  "extends": "@xwiki/platform-tool-apiextractorconfig/api-extractor.json"
 }

package/dist/defaultSettingsStorage.d.ts

@@ -0,0 +1,12 @@
+import { SettingsManager, SettingsStorage } from '@xwiki/cristal-settings-api';
+/**
+ * Default implementation for {@link SettingsStorage}.
+ * It stores and retrieves settings as JSON from the browser's local storage.
+ * @since 0.18
+ * @beta
+ */
+export declare class DefaultSettingsStorage implements SettingsStorage {
+    private readonly localStorageSettingsKey;
+    save(settingsManager: SettingsManager): Promise<void>;
+    load(settingsManager: SettingsManager): Promise<void>;
+}

package/dist/index.d.cts

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

package/dist/index.d.ts

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

package/dist/index.es.js

@@ -0,0 +1,32 @@
+import { injectable as g } from "inversify";
+var i = Object.getOwnPropertyDescriptor, S = (t, e, l, r) => {
+  for (var o = r > 1 ? void 0 : r ? i(e, l) : e, a = t.length - 1, s; a >= 0; a--)
+    (s = t[a]) && (o = s(o) || o);
+  return o;
+};
+let n = class {
+  localStorageSettingsKey = "settings";
+  async save(t) {
+    window.localStorage.setItem(
+      this.localStorageSettingsKey,
+      t.toJSON()
+    );
+  }
+  async load(t) {
+    t.fromJSON(
+      window.localStorage.getItem(this.localStorageSettingsKey) ?? "[]"
+    );
+  }
+};
+n = S([
+  g()
+], n);
+class p {
+  constructor(e) {
+    e.bind("SettingsStorage").to(n).inSingletonScope();
+  }
+}
+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/defaultSettingsStorage.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 { injectable } from \"inversify\";\nimport type {\n  SettingsManager,\n  SettingsStorage,\n} from \"@xwiki/cristal-settings-api\";\n\n/**\n * Default implementation for {@link SettingsStorage}.\n * It stores and retrieves settings as JSON from the browser's local storage.\n * @since 0.18\n * @beta\n */\n@injectable()\nexport class DefaultSettingsStorage implements SettingsStorage {\n  private readonly localStorageSettingsKey = \"settings\";\n\n  async save(settingsManager: SettingsManager): Promise<void> {\n    window.localStorage.setItem(\n      this.localStorageSettingsKey,\n      settingsManager.toJSON(),\n    );\n  }\n\n  async load(settingsManager: SettingsManager): Promise<void> {\n    settingsManager.fromJSON(\n      window.localStorage.getItem(this.localStorageSettingsKey) ?? \"[]\",\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 { DefaultSettingsStorage } from \"./defaultSettingsStorage\";\nimport { Container } from \"inversify\";\nimport type { SettingsStorage } from \"@xwiki/cristal-settings-api\";\n\n/**\n * @beta\n */\nexport class ComponentInit {\n  constructor(container: Container) {\n    container\n      .bind<SettingsStorage>(\"SettingsStorage\")\n      .to(DefaultSettingsStorage)\n      .inSingletonScope();\n  }\n}\n"],"names":["DefaultSettingsStorage","settingsManager","__decorateClass","injectable","ComponentInit","container"],"mappings":";;;;;;AAiCO,IAAMA,IAAN,MAAwD;AAAA,EAC5C,0BAA0B;AAAA,EAE3C,MAAM,KAAKC,GAAiD;AAC1D,WAAO,aAAa;AAAA,MAClB,KAAK;AAAA,MACLA,EAAgB,OAAA;AAAA,IAAO;AAAA,EAE3B;AAAA,EAEA,MAAM,KAAKA,GAAiD;AAC1D,IAAAA,EAAgB;AAAA,MACd,OAAO,aAAa,QAAQ,KAAK,uBAAuB,KAAK;AAAA,IAAA;AAAA,EAEjE;AACF;AAfaD,IAANE,EAAA;AAAA,EADNC,EAAA;AAAW,GACCH,CAAA;ACNN,MAAMI,EAAc;AAAA,EACzB,YAAYC,GAAsB;AAChC,IAAAA,EACG,KAAsB,iBAAiB,EACvC,GAAGL,CAAsB,EACzB,iBAAA;AAAA,EACL;AACF;"}

package/dist/index.umd.js

@@ -0,0 +1,2 @@
+(function(e,n){typeof exports=="object"&&typeof module<"u"?n(exports,require("inversify")):typeof define=="function"&&define.amd?define(["exports","inversify"],n):(e=typeof globalThis<"u"?globalThis:e||self,n(e["cristal_settings-browser"]={},e.inversify))})(this,(function(e,n){"use strict";var c=Object.getOwnPropertyDescriptor,f=(t,o,S,a)=>{for(var i=a>1?void 0:a?c(o,S):o,r=t.length-1,l;r>=0;r--)(l=t[r])&&(i=l(i)||i);return i};let s=class{localStorageSettingsKey="settings";async save(t){window.localStorage.setItem(this.localStorageSettingsKey,t.toJSON())}async load(t){t.fromJSON(window.localStorage.getItem(this.localStorageSettingsKey)??"[]")}};s=f([n.injectable()],s);class g{constructor(o){o.bind("SettingsStorage").to(s).inSingletonScope()}}e.ComponentInit=g,Object.defineProperty(e,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/defaultSettingsStorage.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 { injectable } from \"inversify\";\nimport type {\n  SettingsManager,\n  SettingsStorage,\n} from \"@xwiki/cristal-settings-api\";\n\n/**\n * Default implementation for {@link SettingsStorage}.\n * It stores and retrieves settings as JSON from the browser's local storage.\n * @since 0.18\n * @beta\n */\n@injectable()\nexport class DefaultSettingsStorage implements SettingsStorage {\n  private readonly localStorageSettingsKey = \"settings\";\n\n  async save(settingsManager: SettingsManager): Promise<void> {\n    window.localStorage.setItem(\n      this.localStorageSettingsKey,\n      settingsManager.toJSON(),\n    );\n  }\n\n  async load(settingsManager: SettingsManager): Promise<void> {\n    settingsManager.fromJSON(\n      window.localStorage.getItem(this.localStorageSettingsKey) ?? \"[]\",\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 { DefaultSettingsStorage } from \"./defaultSettingsStorage\";\nimport { Container } from \"inversify\";\nimport type { SettingsStorage } from \"@xwiki/cristal-settings-api\";\n\n/**\n * @beta\n */\nexport class ComponentInit {\n  constructor(container: Container) {\n    container\n      .bind<SettingsStorage>(\"SettingsStorage\")\n      .to(DefaultSettingsStorage)\n      .inSingletonScope();\n  }\n}\n"],"names":["DefaultSettingsStorage","settingsManager","__decorateClass","injectable","ComponentInit","container"],"mappings":"+aAiCO,IAAMA,EAAN,KAAwD,CAC5C,wBAA0B,WAE3C,MAAM,KAAKC,EAAiD,CAC1D,OAAO,aAAa,QAClB,KAAK,wBACLA,EAAgB,OAAA,CAAO,CAE3B,CAEA,MAAM,KAAKA,EAAiD,CAC1DA,EAAgB,SACd,OAAO,aAAa,QAAQ,KAAK,uBAAuB,GAAK,IAAA,CAEjE,CACF,EAfaD,EAANE,EAAA,CADNC,EAAAA,WAAA,CAAW,EACCH,CAAA,ECNN,MAAMI,CAAc,CACzB,YAAYC,EAAsB,CAChCA,EACG,KAAsB,iBAAiB,EACvC,GAAGL,CAAsB,EACzB,iBAAA,CACL,CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xwiki/cristal-settings-browser",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "license": "LGPL 2.1",
   "author": "XWiki Org Community <contact@xwiki.org>",
   "homepage": "https://cristal.xwiki.org/",
@@ -28,18 +28,20 @@
   "main": "./dist/index.es.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@xwiki/platform-api": "18.4.0",
-    "@xwiki/cristal-settings-api": "1.4.0"
+    "@xwiki/platform-api": "18.6.0",
+    "@xwiki/cristal-settings-api": "1.6.0"
   },
   "peerDependencies": {
     "inversify": "8.x"
   },
   "devDependencies": {
-    "@xwiki/platform-dsapi": "18.4.0",
-    "inversify": "8.1.0",
+    "@xwiki/platform-dsapi": "18.6.0",
+    "@xwiki/platform-tool-apiextractorconfig": "18.6.0",
+    "@xwiki/platform-tool-tsconfig": "18.6.0",
+    "inversify": "8.1.1",
     "typescript": "5.9.3",
-    "vite": "7.3.2",
-    "@xwiki/cristal-dev-config": "1.4.0"
+    "vite": "7.3.5",
+    "@xwiki/cristal-dev-config": "1.6.0"
   },
   "scripts": {
     "api-extractor:local": "api-extractor run --local",

package/tsconfig.json

@@ -6,7 +6,7 @@
     "isolatedDeclarations": false,
     "types": ["@xwiki/platform-dsapi"]
   },
-  "extends": "../../../tsconfig.json",
+  "extends": "@xwiki/platform-tool-tsconfig/tsconfig.json",
   "include": [
     "./src/index.ts",
     "./src/**/*"