@xwiki/cristal-electron-settings-main 0.24.0 → 0.25.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/dist/index.es.js.map +1 -1
- package/dist/index.umd.js.map +1 -1
- package/dist/storage.d.ts +1 -1
- package/etc/cristal-electron-settings-main.api.md +1 -1
- package/package.json +6 -6
- package/src/storage.ts +1 -1
- package/CHANGELOG.md +0 -85
package/dist/index.es.js.map
CHANGED
|
@@ -1 +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 Store from \"electron-store\";\nimport type { Configurations } from \"@xwiki/
|
|
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 Store from \"electron-store\";\nimport type { Configurations } from \"@xwiki/platform-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.map
CHANGED
|
@@ -1 +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 Store from \"electron-store\";\nimport type { Configurations } from \"@xwiki/
|
|
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 Store from \"electron-store\";\nimport type { Configurations } from \"@xwiki/platform-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":"0sCAwBMA,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
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Configurations } from '@xwiki/
|
|
1
|
+
import { Configurations } from '@xwiki/platform-configuration-api';
|
|
2
2
|
declare function setSettings(value: string): void;
|
|
3
3
|
declare function getSettings(): string;
|
|
4
4
|
declare function deleteSettings(): void;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xwiki/cristal-electron-settings-main",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.25.0",
|
|
4
4
|
"license": "LGPL 2.1",
|
|
5
5
|
"author": "XWiki Org Community <contact@xwiki.org>",
|
|
6
6
|
"homepage": "https://cristal.xwiki.org/",
|
|
@@ -28,17 +28,17 @@
|
|
|
28
28
|
"main": "./dist/index.es.js",
|
|
29
29
|
"types": "./dist/index.d.ts",
|
|
30
30
|
"dependencies": {
|
|
31
|
+
"@xwiki/platform-configuration-api": "18.0.0-1766398944",
|
|
31
32
|
"electron-store": "11.0.2",
|
|
32
|
-
"@xwiki/cristal-
|
|
33
|
-
"@xwiki/cristal-settings-api": "0.24.0"
|
|
33
|
+
"@xwiki/cristal-settings-api": "0.25.0"
|
|
34
34
|
},
|
|
35
35
|
"peerDependencies": {
|
|
36
|
-
"electron": "39.
|
|
36
|
+
"electron": "39.2.6"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
39
|
"typescript": "5.9.3",
|
|
40
|
-
"vite": "7.
|
|
41
|
-
"@xwiki/cristal-dev-config": "0.
|
|
40
|
+
"vite": "7.2.7",
|
|
41
|
+
"@xwiki/cristal-dev-config": "0.25.0"
|
|
42
42
|
},
|
|
43
43
|
"scripts": {
|
|
44
44
|
"api-extractor:local": "api-extractor run --local",
|
package/src/storage.ts
CHANGED
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
|
|
21
21
|
import defaultSettings from "./defaultSettings.json";
|
|
22
22
|
import Store from "electron-store";
|
|
23
|
-
import type { Configurations } from "@xwiki/
|
|
23
|
+
import type { Configurations } from "@xwiki/platform-configuration-api";
|
|
24
24
|
|
|
25
25
|
const configurationKey = "configuration";
|
|
26
26
|
const settingsKey = "_raw";
|
package/CHANGELOG.md
DELETED
|
@@ -1,85 +0,0 @@
|
|
|
1
|
-
# @xwiki/cristal-electron-settings-main
|
|
2
|
-
|
|
3
|
-
## 0.23.0
|
|
4
|
-
|
|
5
|
-
### Minor Changes
|
|
6
|
-
|
|
7
|
-
- Cristal 0.23 Release
|
|
8
|
-
|
|
9
|
-
### Patch Changes
|
|
10
|
-
|
|
11
|
-
- Updated dependencies
|
|
12
|
-
- @xwiki/cristal-configuration-api@0.23.0
|
|
13
|
-
- @xwiki/cristal-settings-api@0.23.0
|
|
14
|
-
|
|
15
|
-
## 0.22.0
|
|
16
|
-
|
|
17
|
-
### Minor Changes
|
|
18
|
-
|
|
19
|
-
- Cristal 0.22 Release
|
|
20
|
-
|
|
21
|
-
### Patch Changes
|
|
22
|
-
|
|
23
|
-
- Updated dependencies
|
|
24
|
-
- @xwiki/cristal-configuration-api@0.22.0
|
|
25
|
-
- @xwiki/cristal-settings-api@0.22.0
|
|
26
|
-
|
|
27
|
-
## 0.21.0
|
|
28
|
-
|
|
29
|
-
### Minor Changes
|
|
30
|
-
|
|
31
|
-
- Cristal 0.21 Release
|
|
32
|
-
|
|
33
|
-
### Patch Changes
|
|
34
|
-
|
|
35
|
-
- Updated dependencies
|
|
36
|
-
- @xwiki/cristal-configuration-api@0.21.0
|
|
37
|
-
- @xwiki/cristal-settings-api@0.21.0
|
|
38
|
-
|
|
39
|
-
## 0.20.0
|
|
40
|
-
|
|
41
|
-
### Minor Changes
|
|
42
|
-
|
|
43
|
-
- Cristal 0.20 Release
|
|
44
|
-
|
|
45
|
-
### Patch Changes
|
|
46
|
-
|
|
47
|
-
- Updated dependencies
|
|
48
|
-
- @xwiki/cristal-configuration-api@0.20.0
|
|
49
|
-
- @xwiki/cristal-settings-api@0.20.0
|
|
50
|
-
|
|
51
|
-
## 0.20.0-rc.0
|
|
52
|
-
|
|
53
|
-
### Minor Changes
|
|
54
|
-
|
|
55
|
-
- Cristal 0.20-rc-1 Release
|
|
56
|
-
|
|
57
|
-
### Patch Changes
|
|
58
|
-
|
|
59
|
-
- Updated dependencies
|
|
60
|
-
- @xwiki/cristal-configuration-api@0.20.0-rc.0
|
|
61
|
-
- @xwiki/cristal-settings-api@0.20.0-rc.0
|
|
62
|
-
|
|
63
|
-
## 0.19.0
|
|
64
|
-
|
|
65
|
-
### Minor Changes
|
|
66
|
-
|
|
67
|
-
- 3eea53e: Cristal 0.19 Release
|
|
68
|
-
|
|
69
|
-
### Patch Changes
|
|
70
|
-
|
|
71
|
-
- Updated dependencies [3eea53e]
|
|
72
|
-
- @xwiki/cristal-configuration-api@0.19.0
|
|
73
|
-
- @xwiki/cristal-settings-api@0.19.0
|
|
74
|
-
|
|
75
|
-
## 0.18.0
|
|
76
|
-
|
|
77
|
-
### Minor Changes
|
|
78
|
-
|
|
79
|
-
- Cristal 0.18 Release
|
|
80
|
-
|
|
81
|
-
### Patch Changes
|
|
82
|
-
|
|
83
|
-
- Updated dependencies
|
|
84
|
-
- @xwiki/cristal-configuration-api@0.18.0
|
|
85
|
-
- @xwiki/cristal-settings-api@0.18.0
|