@xwiki/cristal-electron-settings-main 0.21.1 → 0.22.0

package/CHANGELOG.md

@@ -1,13 +1,16 @@
 # @xwiki/cristal-electron-settings-main
 
-## 0.21.1
+## 0.22.0
+
+### Minor Changes
+
+- Cristal 0.22 Release
 
 ### Patch Changes
 
-- Cristal 0.21.1 Release
 - Updated dependencies
-  - @xwiki/cristal-configuration-api@0.21.1
-  - @xwiki/cristal-settings-api@0.21.1
+  - @xwiki/cristal-configuration-api@0.22.0
+  - @xwiki/cristal-settings-api@0.22.0
 
 ## 0.21.0
 

package/api-extractor.json

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

package/dist/index.d.cts

@@ -1,3 +1,7 @@
 import { getConfigurations } from './storage';
+/**
+ * @since 0.18
+ * @beta
+ */
 declare function load(): void;
 export { getConfigurations, load };

package/dist/index.d.ts

@@ -1,3 +1,7 @@
 import { getConfigurations } from './storage';
+/**
+ * @since 0.18
+ * @beta
+ */
 declare function load(): void;
 export { getConfigurations, load };

package/dist/index.es.js

@@ -1,15 +1,15 @@
-import r from "electron-store";
-import { ipcMain as n } from "electron";
-const c = { FileSystem: { name: "FileSystem", configType: "FileSystem", serverRendering: !1, offline: !1, designSystem: "vuetify", editor: "tiptap" }, FileSystemSL: { name: "FileSystemSL", configType: "FileSystem", serverRendering: !1, offline: !1, designSystem: "shoelace", editor: "tiptap" }, XWiki: { name: "XWiki", configType: "XWiki", serverRendering: !1, offline: !1, baseURL: "https://cristal-backend.demo.xwiki.com/xwiki", baseRestURL: "/rest/cristal/page?media=json", homePage: "Main.WebHome", designSystem: "vuetify", editor: "tiptap", realtimeURL: "https://cristal.demo.xwiki.com:8093/collaboration" }, XWikiSL: { name: "XWikiSL", configType: "XWiki", serverRendering: !1, offline: !1, baseURL: "https://cristal-backend.demo.xwiki.com/xwiki", baseRestURL: "/rest/cristal/page?media=json", homePage: "Main.WebHome", designSystem: "shoelace", editor: "tiptap", realtimeURL: "https://cristal.demo.xwiki.com:8093/collaboration" } }, l = {
-  configuration: c
-}, f = "configuration", s = "_raw", g = {
+import o from "electron-store";
+import { ipcMain as t } from "electron";
+const r = { FileSystem: { name: "FileSystem", configType: "FileSystem", serverRendering: !1, offline: !1, designSystem: "vuetify", editor: "tiptap" }, FileSystemSL: { name: "FileSystemSL", configType: "FileSystem", serverRendering: !1, offline: !1, designSystem: "shoelace", editor: "tiptap" }, XWiki: { name: "XWiki", configType: "XWiki", serverRendering: !1, offline: !1, baseURL: "https://cristal-backend.demo.xwiki.com/xwiki", baseRestURL: "/rest/cristal/page?media=json", homePage: "Main.WebHome", designSystem: "vuetify", editor: "tiptap", realtimeURL: "https://cristal.demo.xwiki.com:8093/collaboration" }, XWikiSL: { name: "XWikiSL", configType: "XWiki", serverRendering: !1, offline: !1, baseURL: "https://cristal-backend.demo.xwiki.com/xwiki", baseRestURL: "/rest/cristal/page?media=json", homePage: "Main.WebHome", designSystem: "shoelace", editor: "tiptap", realtimeURL: "https://cristal.demo.xwiki.com:8093/collaboration" } }, c = {
+  configuration: r
+}, l = "configuration", n = "_raw", f = {
   _raw: {
     type: "string"
   },
   configuration: {
     type: "object"
   }
-}, t = new r({
+}, i = new o({
   name: "settings",
   // Here, we want to keep in the store the raw string representation of the
   // file, since it should be parsed and serialized by the SettingsManager
@@ -17,41 +17,35 @@ const c = { FileSystem: { name: "FileSystem", configType: "FileSystem", serverRe
   // some settings values on Electron's main process.
   serialize: (e) => e._raw,
   deserialize: (e) => ({ _raw: e, ...JSON.parse(e) }),
-  schema: g
+  schema: f
 });
-function m(e, i) {
-  t.set(e, i);
+function s(e) {
+  i.set(n, e);
 }
-function a(e) {
-  return t.get(e);
+function g() {
+  return i.size < 2 && s(JSON.stringify(c, null, 2)), i.get(n);
 }
-function o(e) {
-  m(s, e);
+function S() {
+  return i.get(l);
 }
-function d() {
-  return t.size < 2 && o(JSON.stringify(l, null, 2)), a(s);
-}
-function k() {
-  return a(f);
+function m(e) {
+  s(e);
 }
-function p(e) {
-  o(e);
-}
-function y() {
-  return d();
+function d() {
+  return g();
 }
-function R() {
-  n.handle(
+function u() {
+  t.handle(
     "settings:save",
     async (e, {
-      settings: i
+      settings: a
     }) => {
-      p(i);
+      m(a);
     }
-  ), n.handle("settings:load", async () => y());
+  ), t.handle("settings:load", async () => d());
 }
 export {
-  k as getConfigurations,
-  R as load
+  S as getConfigurations,
+  u as load
 };
 //# sourceMappingURL=index.es.js.map

package/dist/index.es.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.es.js","sources":["../src/storage.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 defaultSettings from \"./defaultSettings.json\";\nimport { Configurations } from \"@xwiki/cristal-configuration-api\";\nimport Store from \"electron-store\";\n\nconst configurationKey = \"configuration\";\nconst settingsKey = \"_raw\";\n\nconst schema = {\n  _raw: {\n    type: \"string\",\n  },\n  configuration: {\n    type: \"object\",\n  },\n};\n\nconst storeInstance: Store = new Store({\n  name: \"settings\",\n  // Here, we want to keep in the store the raw string representation of the\n  // file, since it should be parsed and serialized by the SettingsManager\n  // service. We still include the deserialized object in case we want to check\n  // some settings values on Electron's main process.\n  serialize: (value: Record<string, unknown>) => value._raw as string,\n  deserialize: (value: string) => ({ _raw: value, ...JSON.parse(value) }),\n  schema,\n});\n\nfunction set<T>(key: string, value: T) {\n  // @ts-expect-error type resolution failing because of electron-store library bug\n  storeInstance.set(key, value);\n}\n\nfunction get<T>(key: string): T {\n  // @ts-expect-error type resolution failing because of electron-store library bug\n  return storeInstance.get(key) as T;\n}\n\nfunction rm(key: string) {\n  // @ts-expect-error type resolution failing because of electron-store library bug\n  storeInstance.delete(key);\n}\n\nfunction setSettings(value: string): void {\n  set(settingsKey, value);\n}\n\nfunction getSettings(): string {\n  // @ts-expect-error type resolution failing because of electron-store library bug\n  if (storeInstance.size < 2) {\n    setSettings(JSON.stringify(defaultSettings, null, 2));\n  }\n  return get(settingsKey);\n}\n\nfunction deleteSettings(): void {\n  rm(settingsKey);\n}\n\nfunction getConfigurations(): Configurations {\n  return get(configurationKey);\n}\n\nexport { deleteSettings, getConfigurations, getSettings, setSettings };\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 { getConfigurations, getSettings, setSettings } from \"./storage\";\nimport { ipcMain } from \"electron\";\n\nfunction saveSettings(settings: string): void {\n  setSettings(settings);\n}\n\nfunction loadSettings(): string {\n  return getSettings();\n}\n\nfunction load(): void {\n  ipcMain.handle(\n    \"settings:save\",\n    async (\n      _event,\n      {\n        settings,\n      }: {\n        settings: string;\n      },\n    ): Promise<void> => {\n      saveSettings(settings);\n    },\n  );\n\n  ipcMain.handle(\"settings:load\", async (): Promise<string> => {\n    return loadSettings();\n  });\n}\n\nexport { getConfigurations, load };\n"],"names":["configurationKey","settingsKey","schema","storeInstance","Store","value","set","key","get","setSettings","getSettings","defaultSettings","getConfigurations","saveSettings","settings","loadSettings","load","ipcMain","_event"],"mappings":";;;;GAwBMA,IAAmB,iBACnBC,IAAc,QAEdC,IAAS;AAAA,EACb,MAAM;AAAA,IACJ,MAAM;AAAA,EAAA;AAAA,EAER,eAAe;AAAA,IACb,MAAM;AAAA,EAAA;AAEV,GAEMC,IAAuB,IAAIC,EAAM;AAAA,EACrC,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,EAKN,WAAW,CAACC,MAAmCA,EAAM;AAAA,EACrD,aAAa,CAACA,OAAmB,EAAE,MAAMA,GAAO,GAAG,KAAK,MAAMA,CAAK;EACnE,QAAAH;AACF,CAAC;AAED,SAASI,EAAOC,GAAaF,GAAU;AAErC,EAAAF,EAAc,IAAII,GAAKF,CAAK;AAC9B;AAEA,SAASG,EAAOD,GAAgB;AAE9B,SAAOJ,EAAc,IAAII,CAAG;AAC9B;AAOA,SAASE,EAAYJ,GAAqB;AACxC,EAAAC,EAAIL,GAAaI,CAAK;AACxB;AAEA,SAASK,IAAsB;AAE7B,SAAIP,EAAc,OAAO,KACvBM,EAAY,KAAK,UAAUE,GAAiB,MAAM,CAAC,CAAC,GAE/CH,EAAIP,CAAW;AACxB;AAMA,SAASW,IAAoC;AAC3C,SAAOJ,EAAIR,CAAgB;AAC7B;ACzDA,SAASa,EAAaC,GAAwB;AAC5C,EAAAL,EAAYK,CAAQ;AACtB;AAEA,SAASC,IAAuB;AAC9B,SAAOL,EAAA;AACT;AAEA,SAASM,IAAa;AACpB,EAAAC,EAAQ;AAAA,IACN;AAAA,IACA,OACEC,GACA;AAAA,MACE,UAAAJ;AAAA,IAAA,MAIgB;AAClB,MAAAD,EAAaC,CAAQ;AAAA,IACvB;AAAA,EAAA,GAGFG,EAAQ,OAAO,iBAAiB,YACvBF,EAAA,CACR;AACH;"}
+{"version":3,"file":"index.es.js","sources":["../src/storage.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 defaultSettings from \"./defaultSettings.json\";\nimport Store from \"electron-store\";\nimport type { Configurations } from \"@xwiki/cristal-configuration-api\";\n\nconst configurationKey = \"configuration\";\nconst settingsKey = \"_raw\";\n\nconst schema = {\n  _raw: {\n    type: \"string\",\n  },\n  configuration: {\n    type: \"object\",\n  },\n};\n\ntype StoreType = {\n  _raw: string;\n  configuration: object;\n};\n\nconst storeInstance: Store<StoreType> = new Store<StoreType>({\n  name: \"settings\",\n  // Here, we want to keep in the store the raw string representation of the\n  // file, since it should be parsed and serialized by the SettingsManager\n  // service. We still include the deserialized object in case we want to check\n  // some settings values on Electron's main process.\n  serialize: (value: Record<string, unknown>) => value._raw as string,\n  deserialize: (value: string) => ({ _raw: value, ...JSON.parse(value) }),\n  schema,\n});\n\nfunction setSettings(value: string): void {\n  storeInstance.set(settingsKey, value);\n}\n\nfunction getSettings(): string {\n  if (storeInstance.size < 2) {\n    setSettings(JSON.stringify(defaultSettings, null, 2));\n  }\n  return storeInstance.get(settingsKey);\n}\n\nfunction deleteSettings(): void {\n  storeInstance.delete(settingsKey);\n}\n\n/**\n * @since 0.18\n * @beta\n */\nfunction getConfigurations(): Configurations {\n  return storeInstance.get(configurationKey) as Configurations;\n}\n\nexport { deleteSettings, getConfigurations, getSettings, setSettings };\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 { getConfigurations, getSettings, setSettings } from \"./storage\";\nimport { ipcMain } from \"electron\";\n\nfunction saveSettings(settings: string): void {\n  setSettings(settings);\n}\n\nfunction loadSettings(): string {\n  return getSettings();\n}\n\n/**\n * @since 0.18\n * @beta\n */\nfunction load(): void {\n  ipcMain.handle(\n    \"settings:save\",\n    async (\n      _event,\n      {\n        settings,\n      }: {\n        settings: string;\n      },\n    ): Promise<void> => {\n      saveSettings(settings);\n    },\n  );\n\n  ipcMain.handle(\"settings:load\", async (): Promise<string> => {\n    return loadSettings();\n  });\n}\n\nexport { getConfigurations, load };\n"],"names":["configurationKey","settingsKey","schema","storeInstance","Store","value","setSettings","getSettings","defaultSettings","getConfigurations","saveSettings","settings","loadSettings","load","ipcMain","_event"],"mappings":";;;;GAwBMA,IAAmB,iBACnBC,IAAc,QAEdC,IAAS;AAAA,EACb,MAAM;AAAA,IACJ,MAAM;AAAA,EAAA;AAAA,EAER,eAAe;AAAA,IACb,MAAM;AAAA,EAAA;AAEV,GAOMC,IAAkC,IAAIC,EAAiB;AAAA,EAC3D,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,EAKN,WAAW,CAACC,MAAmCA,EAAM;AAAA,EACrD,aAAa,CAACA,OAAmB,EAAE,MAAMA,GAAO,GAAG,KAAK,MAAMA,CAAK;EACnE,QAAAH;AACF,CAAC;AAED,SAASI,EAAYD,GAAqB;AACxC,EAAAF,EAAc,IAAIF,GAAaI,CAAK;AACtC;AAEA,SAASE,IAAsB;AAC7B,SAAIJ,EAAc,OAAO,KACvBG,EAAY,KAAK,UAAUE,GAAiB,MAAM,CAAC,CAAC,GAE/CL,EAAc,IAAIF,CAAW;AACtC;AAUA,SAASQ,IAAoC;AAC3C,SAAON,EAAc,IAAIH,CAAgB;AAC3C;AClDA,SAASU,EAAaC,GAAwB;AAC5C,EAAAL,EAAYK,CAAQ;AACtB;AAEA,SAASC,IAAuB;AAC9B,SAAOL,EAAA;AACT;AAMA,SAASM,IAAa;AACpB,EAAAC,EAAQ;AAAA,IACN;AAAA,IACA,OACEC,GACA;AAAA,MACE,UAAAJ;AAAA,IAAA,MAIgB;AAClB,MAAAD,EAAaC,CAAQ;AAAA,IACvB;AAAA,EAAA,GAGFG,EAAQ,OAAO,iBAAiB,YACvBF,EAAA,CACR;AACH;"}

package/dist/index.umd.js

@@ -1,2 +1,2 @@
-(function(i,t){typeof exports=="object"&&typeof module<"u"?t(exports,require("electron-store"),require("electron")):typeof define=="function"&&define.amd?define(["exports","electron-store","electron"],t):(i=typeof globalThis<"u"?globalThis:i||self,t(i["cristal_settings-main"]={},i.Store,i.electron))})(this,function(i,t,o){"use strict";const f={configuration:{FileSystem:{name:"FileSystem",configType:"FileSystem",serverRendering:!1,offline:!1,designSystem:"vuetify",editor:"tiptap"},FileSystemSL:{name:"FileSystemSL",configType:"FileSystem",serverRendering:!1,offline:!1,designSystem:"shoelace",editor:"tiptap"},XWiki:{name:"XWiki",configType:"XWiki",serverRendering:!1,offline:!1,baseURL:"https://cristal-backend.demo.xwiki.com/xwiki",baseRestURL:"/rest/cristal/page?media=json",homePage:"Main.WebHome",designSystem:"vuetify",editor:"tiptap",realtimeURL:"https://cristal.demo.xwiki.com:8093/collaboration"},XWikiSL:{name:"XWikiSL",configType:"XWiki",serverRendering:!1,offline:!1,baseURL:"https://cristal-backend.demo.xwiki.com/xwiki",baseRestURL:"/rest/cristal/page?media=json",homePage:"Main.WebHome",designSystem:"shoelace",editor:"tiptap",realtimeURL:"https://cristal.demo.xwiki.com:8093/collaboration"}}},l="configuration",a="_raw",g={_raw:{type:"string"},configuration:{type:"object"}},n=new t({name:"settings",serialize:e=>e._raw,deserialize:e=>({_raw:e,...JSON.parse(e)}),schema:g});function d(e,s){n.set(e,s)}function r(e){return n.get(e)}function c(e){d(a,e)}function m(){return n.size<2&&c(JSON.stringify(f,null,2)),r(a)}function u(){return r(l)}function p(e){c(e)}function y(){return m()}function S(){o.ipcMain.handle("settings:save",async(e,{settings:s})=>{p(s)}),o.ipcMain.handle("settings:load",async()=>y())}i.getConfigurations=u,i.load=S,Object.defineProperty(i,Symbol.toStringTag,{value:"Module"})});
+(function(e,t){typeof exports=="object"&&typeof module<"u"?t(exports,require("electron-store"),require("electron")):typeof define=="function"&&define.amd?define(["exports","electron-store","electron"],t):(e=typeof globalThis<"u"?globalThis:e||self,t(e["cristal_settings-main"]={},e.Store,e.electron))})(this,(function(e,t,s){"use strict";const r={configuration:{FileSystem:{name:"FileSystem",configType:"FileSystem",serverRendering:!1,offline:!1,designSystem:"vuetify",editor:"tiptap"},FileSystemSL:{name:"FileSystemSL",configType:"FileSystem",serverRendering:!1,offline:!1,designSystem:"shoelace",editor:"tiptap"},XWiki:{name:"XWiki",configType:"XWiki",serverRendering:!1,offline:!1,baseURL:"https://cristal-backend.demo.xwiki.com/xwiki",baseRestURL:"/rest/cristal/page?media=json",homePage:"Main.WebHome",designSystem:"vuetify",editor:"tiptap",realtimeURL:"https://cristal.demo.xwiki.com:8093/collaboration"},XWikiSL:{name:"XWikiSL",configType:"XWiki",serverRendering:!1,offline:!1,baseURL:"https://cristal-backend.demo.xwiki.com/xwiki",baseRestURL:"/rest/cristal/page?media=json",homePage:"Main.WebHome",designSystem:"shoelace",editor:"tiptap",realtimeURL:"https://cristal.demo.xwiki.com:8093/collaboration"}}},c="configuration",o="_raw",f={_raw:{type:"string"},configuration:{type:"object"}},n=new t({name:"settings",serialize:i=>i._raw,deserialize:i=>({_raw:i,...JSON.parse(i)}),schema:f});function a(i){n.set(o,i)}function l(){return n.size<2&&a(JSON.stringify(r,null,2)),n.get(o)}function g(){return n.get(c)}function d(i){a(i)}function m(){return l()}function u(){s.ipcMain.handle("settings:save",async(i,{settings:p})=>{d(p)}),s.ipcMain.handle("settings:load",async()=>m())}e.getConfigurations=g,e.load=u,Object.defineProperty(e,Symbol.toStringTag,{value:"Module"})}));
 //# sourceMappingURL=index.umd.js.map

package/dist/index.umd.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.umd.js","sources":["../src/storage.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 defaultSettings from \"./defaultSettings.json\";\nimport { Configurations } from \"@xwiki/cristal-configuration-api\";\nimport Store from \"electron-store\";\n\nconst configurationKey = \"configuration\";\nconst settingsKey = \"_raw\";\n\nconst schema = {\n  _raw: {\n    type: \"string\",\n  },\n  configuration: {\n    type: \"object\",\n  },\n};\n\nconst storeInstance: Store = new Store({\n  name: \"settings\",\n  // Here, we want to keep in the store the raw string representation of the\n  // file, since it should be parsed and serialized by the SettingsManager\n  // service. We still include the deserialized object in case we want to check\n  // some settings values on Electron's main process.\n  serialize: (value: Record<string, unknown>) => value._raw as string,\n  deserialize: (value: string) => ({ _raw: value, ...JSON.parse(value) }),\n  schema,\n});\n\nfunction set<T>(key: string, value: T) {\n  // @ts-expect-error type resolution failing because of electron-store library bug\n  storeInstance.set(key, value);\n}\n\nfunction get<T>(key: string): T {\n  // @ts-expect-error type resolution failing because of electron-store library bug\n  return storeInstance.get(key) as T;\n}\n\nfunction rm(key: string) {\n  // @ts-expect-error type resolution failing because of electron-store library bug\n  storeInstance.delete(key);\n}\n\nfunction setSettings(value: string): void {\n  set(settingsKey, value);\n}\n\nfunction getSettings(): string {\n  // @ts-expect-error type resolution failing because of electron-store library bug\n  if (storeInstance.size < 2) {\n    setSettings(JSON.stringify(defaultSettings, null, 2));\n  }\n  return get(settingsKey);\n}\n\nfunction deleteSettings(): void {\n  rm(settingsKey);\n}\n\nfunction getConfigurations(): Configurations {\n  return get(configurationKey);\n}\n\nexport { deleteSettings, getConfigurations, getSettings, setSettings };\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 { getConfigurations, getSettings, setSettings } from \"./storage\";\nimport { ipcMain } from \"electron\";\n\nfunction saveSettings(settings: string): void {\n  setSettings(settings);\n}\n\nfunction loadSettings(): string {\n  return getSettings();\n}\n\nfunction load(): void {\n  ipcMain.handle(\n    \"settings:save\",\n    async (\n      _event,\n      {\n        settings,\n      }: {\n        settings: string;\n      },\n    ): Promise<void> => {\n      saveSettings(settings);\n    },\n  );\n\n  ipcMain.handle(\"settings:load\", async (): Promise<string> => {\n    return loadSettings();\n  });\n}\n\nexport { getConfigurations, load };\n"],"names":["configurationKey","settingsKey","schema","storeInstance","Store","value","set","key","get","setSettings","getSettings","defaultSettings","getConfigurations","saveSettings","settings","loadSettings","load","ipcMain","_event"],"mappings":"6rCAwBMA,EAAmB,gBACnBC,EAAc,OAEdC,EAAS,CACb,KAAM,CACJ,KAAM,QAAA,EAER,cAAe,CACb,KAAM,QAAA,CAEV,EAEMC,EAAuB,IAAIC,EAAM,CACrC,KAAM,WAKN,UAAYC,GAAmCA,EAAM,KACrD,YAAcA,IAAmB,CAAE,KAAMA,EAAO,GAAG,KAAK,MAAMA,CAAK,IACnE,OAAAH,CACF,CAAC,EAED,SAASI,EAAOC,EAAaF,EAAU,CAErCF,EAAc,IAAII,EAAKF,CAAK,CAC9B,CAEA,SAASG,EAAOD,EAAgB,CAE9B,OAAOJ,EAAc,IAAII,CAAG,CAC9B,CAOA,SAASE,EAAYJ,EAAqB,CACxCC,EAAIL,EAAaI,CAAK,CACxB,CAEA,SAASK,GAAsB,CAE7B,OAAIP,EAAc,KAAO,GACvBM,EAAY,KAAK,UAAUE,EAAiB,KAAM,CAAC,CAAC,EAE/CH,EAAIP,CAAW,CACxB,CAMA,SAASW,GAAoC,CAC3C,OAAOJ,EAAIR,CAAgB,CAC7B,CCzDA,SAASa,EAAaC,EAAwB,CAC5CL,EAAYK,CAAQ,CACtB,CAEA,SAASC,GAAuB,CAC9B,OAAOL,EAAA,CACT,CAEA,SAASM,GAAa,CACpBC,EAAAA,QAAQ,OACN,gBACA,MACEC,EACA,CACE,SAAAJ,CAAA,IAIgB,CAClBD,EAAaC,CAAQ,CACvB,CAAA,EAGFG,UAAQ,OAAO,gBAAiB,SACvBF,EAAA,CACR,CACH"}
+{"version":3,"file":"index.umd.js","sources":["../src/storage.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 defaultSettings from \"./defaultSettings.json\";\nimport Store from \"electron-store\";\nimport type { Configurations } from \"@xwiki/cristal-configuration-api\";\n\nconst configurationKey = \"configuration\";\nconst settingsKey = \"_raw\";\n\nconst schema = {\n  _raw: {\n    type: \"string\",\n  },\n  configuration: {\n    type: \"object\",\n  },\n};\n\ntype StoreType = {\n  _raw: string;\n  configuration: object;\n};\n\nconst storeInstance: Store<StoreType> = new Store<StoreType>({\n  name: \"settings\",\n  // Here, we want to keep in the store the raw string representation of the\n  // file, since it should be parsed and serialized by the SettingsManager\n  // service. We still include the deserialized object in case we want to check\n  // some settings values on Electron's main process.\n  serialize: (value: Record<string, unknown>) => value._raw as string,\n  deserialize: (value: string) => ({ _raw: value, ...JSON.parse(value) }),\n  schema,\n});\n\nfunction setSettings(value: string): void {\n  storeInstance.set(settingsKey, value);\n}\n\nfunction getSettings(): string {\n  if (storeInstance.size < 2) {\n    setSettings(JSON.stringify(defaultSettings, null, 2));\n  }\n  return storeInstance.get(settingsKey);\n}\n\nfunction deleteSettings(): void {\n  storeInstance.delete(settingsKey);\n}\n\n/**\n * @since 0.18\n * @beta\n */\nfunction getConfigurations(): Configurations {\n  return storeInstance.get(configurationKey) as Configurations;\n}\n\nexport { deleteSettings, getConfigurations, getSettings, setSettings };\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 { getConfigurations, getSettings, setSettings } from \"./storage\";\nimport { ipcMain } from \"electron\";\n\nfunction saveSettings(settings: string): void {\n  setSettings(settings);\n}\n\nfunction loadSettings(): string {\n  return getSettings();\n}\n\n/**\n * @since 0.18\n * @beta\n */\nfunction load(): void {\n  ipcMain.handle(\n    \"settings:save\",\n    async (\n      _event,\n      {\n        settings,\n      }: {\n        settings: string;\n      },\n    ): Promise<void> => {\n      saveSettings(settings);\n    },\n  );\n\n  ipcMain.handle(\"settings:load\", async (): Promise<string> => {\n    return loadSettings();\n  });\n}\n\nexport { getConfigurations, load };\n"],"names":["configurationKey","settingsKey","schema","storeInstance","Store","value","setSettings","getSettings","defaultSettings","getConfigurations","saveSettings","settings","loadSettings","load","ipcMain","_event"],"mappings":"8rCAwBMA,EAAmB,gBACnBC,EAAc,OAEdC,EAAS,CACb,KAAM,CACJ,KAAM,QAAA,EAER,cAAe,CACb,KAAM,QAAA,CAEV,EAOMC,EAAkC,IAAIC,EAAiB,CAC3D,KAAM,WAKN,UAAYC,GAAmCA,EAAM,KACrD,YAAcA,IAAmB,CAAE,KAAMA,EAAO,GAAG,KAAK,MAAMA,CAAK,IACnE,OAAAH,CACF,CAAC,EAED,SAASI,EAAYD,EAAqB,CACxCF,EAAc,IAAIF,EAAaI,CAAK,CACtC,CAEA,SAASE,GAAsB,CAC7B,OAAIJ,EAAc,KAAO,GACvBG,EAAY,KAAK,UAAUE,EAAiB,KAAM,CAAC,CAAC,EAE/CL,EAAc,IAAIF,CAAW,CACtC,CAUA,SAASQ,GAAoC,CAC3C,OAAON,EAAc,IAAIH,CAAgB,CAC3C,CClDA,SAASU,EAAaC,EAAwB,CAC5CL,EAAYK,CAAQ,CACtB,CAEA,SAASC,GAAuB,CAC9B,OAAOL,EAAA,CACT,CAMA,SAASM,GAAa,CACpBC,EAAAA,QAAQ,OACN,gBACA,MACEC,EACA,CACE,SAAAJ,CAAA,IAIgB,CAClBD,EAAaC,CAAQ,CACvB,CAAA,EAGFG,UAAQ,OAAO,gBAAiB,SACvBF,EAAA,CACR,CACH"}

package/dist/storage.d.ts

@@ -2,5 +2,9 @@ import { Configurations } from '@xwiki/cristal-configuration-api';
 declare function setSettings(value: string): void;
 declare function getSettings(): string;
 declare function deleteSettings(): void;
+/**
+ * @since 0.18
+ * @beta
+ */
 declare function getConfigurations(): Configurations;
 export { deleteSettings, getConfigurations, getSettings, setSettings };

package/etc/cristal-electron-settings-main.api.md

@@ -0,0 +1,17 @@
+## API Report File for "@xwiki/cristal-electron-settings-main"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { Configurations } from '@xwiki/cristal-configuration-api';
+
+// @beta (undocumented)
+export function getConfigurations(): Configurations;
+
+// @beta (undocumented)
+export function load(): void;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xwiki/cristal-electron-settings-main",
-  "version": "0.21.1",
+  "version": "0.22.0",
   "license": "LGPL 2.1",
   "author": "XWiki Org Community <contact@xwiki.org>",
   "homepage": "https://cristal.xwiki.org/",
@@ -26,24 +26,26 @@
     }
   },
   "main": "./dist/index.es.js",
+  "types": "./dist/index.d.ts",
   "dependencies": {
     "electron-store": "10.1.0",
-    "@xwiki/cristal-configuration-api": "0.21.1",
-    "@xwiki/cristal-settings-api": "0.21.1"
+    "@xwiki/cristal-configuration-api": "0.22.0",
+    "@xwiki/cristal-settings-api": "0.22.0"
   },
   "peerDependencies": {
-    "electron": "37.2.5"
+    "electron": "37.4.0"
   },
   "devDependencies": {
     "typescript": "5.9.2",
-    "vite": "7.0.6",
-    "@xwiki/cristal-dev-config": "0.21.1"
+    "vite": "7.1.5",
+    "@xwiki/cristal-dev-config": "0.22.0"
   },
   "scripts": {
-    "build": "tsc --project tsconfig.json && vite build",
+    "api-extractor:local": "api-extractor run --local",
+    "build": "vite build",
     "clean": "rimraf dist",
     "lint": "eslint \"./src/**/*.{ts,tsx,vue}\" --max-warnings=0",
-    "test": "vitest --run"
-  },
-  "types": "./dist/index.d.ts"
+    "test": "vitest --run",
+    "typecheck": "tsc"
+  }
 }

package/src/index.ts

@@ -29,6 +29,10 @@ function loadSettings(): string {
   return getSettings();
 }
 
+/**
+ * @since 0.18
+ * @beta
+ */
 function load(): void {
   ipcMain.handle(
     "settings:save",

package/src/storage.ts

@@ -19,8 +19,8 @@
  */
 
 import defaultSettings from "./defaultSettings.json";
-import { Configurations } from "@xwiki/cristal-configuration-api";
 import Store from "electron-store";
+import type { Configurations } from "@xwiki/cristal-configuration-api";
 
 const configurationKey = "configuration";
 const settingsKey = "_raw";
@@ -34,7 +34,12 @@ const schema = {
   },
 };
 
-const storeInstance: Store = new Store({
+type StoreType = {
+  _raw: string;
+  configuration: object;
+};
+
+const storeInstance: Store<StoreType> = new Store<StoreType>({
   name: "settings",
   // Here, we want to keep in the store the raw string representation of the
   // file, since it should be parsed and serialized by the SettingsManager
@@ -45,39 +50,27 @@ const storeInstance: Store = new Store({
   schema,
 });
 
-function set<T>(key: string, value: T) {
-  // @ts-expect-error type resolution failing because of electron-store library bug
-  storeInstance.set(key, value);
-}
-
-function get<T>(key: string): T {
-  // @ts-expect-error type resolution failing because of electron-store library bug
-  return storeInstance.get(key) as T;
-}
-
-function rm(key: string) {
-  // @ts-expect-error type resolution failing because of electron-store library bug
-  storeInstance.delete(key);
-}
-
 function setSettings(value: string): void {
-  set(settingsKey, value);
+  storeInstance.set(settingsKey, value);
 }
 
 function getSettings(): string {
-  // @ts-expect-error type resolution failing because of electron-store library bug
   if (storeInstance.size < 2) {
     setSettings(JSON.stringify(defaultSettings, null, 2));
   }
-  return get(settingsKey);
+  return storeInstance.get(settingsKey);
 }
 
 function deleteSettings(): void {
-  rm(settingsKey);
+  storeInstance.delete(settingsKey);
 }
 
+/**
+ * @since 0.18
+ * @beta
+ */
 function getConfigurations(): Configurations {
-  return get(configurationKey);
+  return storeInstance.get(configurationKey) as Configurations;
 }
 
 export { deleteSettings, getConfigurations, getSettings, setSettings };

package/tsdoc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": ["../../../tsdoc.json"]
+}

package/vitest.config.ts

@@ -19,7 +19,7 @@
  */
 
 import localConfig from "./vite.config";
+import { vitestVue as defaultConfig } from "@xwiki/cristal-dev-config";
 import { mergeConfig } from "vitest/config";
-import defaultConfig from "@xwiki/cristal-dev-config/vitest-vue.config";
 
 export default mergeConfig(defaultConfig, localConfig);