@starpak/config 0.0.0-stage → 1.0.5

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/LICENSE ADDED
@@ -0,0 +1,22 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024-present Spak Team
4
+ Copyright (c) 2019-present Shigma
5
+
6
+ Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ of this software and associated documentation files (the "Software"), to deal
8
+ in the Software without restriction, including without limitation the rights
9
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ copies of the Software, and to permit persons to whom the Software is
11
+ furnished to do so, subject to the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be included in all
14
+ copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22
+ SOFTWARE.
package/lib/index.d.ts ADDED
@@ -0,0 +1,29 @@
1
+ export interface SpakConfig {
2
+ plugins: Record<string, any>;
3
+ cpc?: {
4
+ enabled?: boolean;
5
+ sandbox?: {
6
+ enabled?: boolean;
7
+ };
8
+ processIsolation?: {
9
+ enabled?: boolean;
10
+ };
11
+ ssetps?: {
12
+ enabled?: boolean;
13
+ /** Memory limit in MB for SSetPS RSS monitoring; 80% of this trips the warning + circuit breaker. */
14
+ memoryLimitMB?: number;
15
+ };
16
+ };
17
+ }
18
+ export declare function loadConfig(): SpakConfig;
19
+ export declare function saveConfig(config: SpakConfig): void;
20
+ export declare function getConfig(key: string): any;
21
+ export declare function setConfig(key: string, value: any): SpakConfig;
22
+ declare const _default: {
23
+ loadConfig: typeof loadConfig;
24
+ saveConfig: typeof saveConfig;
25
+ getConfig: typeof getConfig;
26
+ setConfig: typeof setConfig;
27
+ };
28
+ export default _default;
29
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC5B,GAAG,CAAC,EAAE;QACJ,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,OAAO,CAAC,EAAE;YAAE,OAAO,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;QAC/B,gBAAgB,CAAC,EAAE;YAAE,OAAO,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;QACxC,MAAM,CAAC,EAAE;YACP,OAAO,CAAC,EAAE,OAAO,CAAA;YACjB,qGAAqG;YACrG,aAAa,CAAC,EAAE,MAAM,CAAA;SACvB,CAAA;KACF,CAAA;CACF;AAYD,wBAAgB,UAAU,IAAI,UAAU,CAYvC;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI,CAoBnD;AAED,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAS1C;AAED,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,UAAU,CAW7D;;;;;;;AAED,wBAA+D"}
package/lib/index.js ADDED
@@ -0,0 +1,86 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.loadConfig = loadConfig;
4
+ exports.saveConfig = saveConfig;
5
+ exports.getConfig = getConfig;
6
+ exports.setConfig = setConfig;
7
+ const fs_1 = require("fs");
8
+ const path_1 = require("path");
9
+ const util_1 = require("@starpak/util");
10
+ // 数据目录 = 项目源码根下的 data/(尊重 SPAK_DATA_DIR 覆盖,不写 ~/.spak)
11
+ const CONFIG_DIR = (0, util_1.projectDataDir)();
12
+ const CONFIG_FILE = (0, path_1.resolve)(CONFIG_DIR, 'config.json');
13
+ const defaultConfig = {
14
+ plugins: {},
15
+ };
16
+ function ensureConfigDir() {
17
+ if (!(0, fs_1.existsSync)(CONFIG_DIR)) {
18
+ (0, fs_1.mkdirSync)(CONFIG_DIR, { recursive: true });
19
+ }
20
+ }
21
+ function loadConfig() {
22
+ ensureConfigDir();
23
+ if (!(0, fs_1.existsSync)(CONFIG_FILE)) {
24
+ saveConfig(defaultConfig);
25
+ return { ...defaultConfig };
26
+ }
27
+ try {
28
+ const data = (0, fs_1.readFileSync)(CONFIG_FILE, 'utf-8');
29
+ return { ...defaultConfig, ...JSON.parse(data) };
30
+ }
31
+ catch {
32
+ return { ...defaultConfig };
33
+ }
34
+ }
35
+ function saveConfig(config) {
36
+ ensureConfigDir();
37
+ // Atomic write: write to a temp file first, then rename into place.
38
+ // This prevents half-written JSON when the process crashes mid-write, and
39
+ // reduces the race window between two concurrent setConfig() calls.
40
+ const tmpFile = CONFIG_FILE + '.tmp.' + process.pid.toString(36);
41
+ try {
42
+ (0, fs_1.writeFileSync)(tmpFile, JSON.stringify(config, null, 2), 'utf-8');
43
+ // rename() is atomic on POSIX filesystems; on Windows we fallback to
44
+ // replace via copy+unlink if rename fails.
45
+ try {
46
+ require('fs').renameSync(tmpFile, CONFIG_FILE);
47
+ }
48
+ catch {
49
+ require('fs').copyFileSync(tmpFile, CONFIG_FILE);
50
+ require('fs').unlinkSync(tmpFile);
51
+ }
52
+ }
53
+ catch (err) {
54
+ try {
55
+ require('fs').unlinkSync(tmpFile);
56
+ }
57
+ catch { /* ignore */ }
58
+ throw err;
59
+ }
60
+ }
61
+ function getConfig(key) {
62
+ const config = loadConfig();
63
+ const parts = key.split('.');
64
+ let value = config;
65
+ for (const part of parts) {
66
+ if (value === undefined || value === null)
67
+ return undefined;
68
+ value = value[part];
69
+ }
70
+ return value;
71
+ }
72
+ function setConfig(key, value) {
73
+ const config = loadConfig();
74
+ const parts = key.split('.');
75
+ let obj = config;
76
+ for (let i = 0; i < parts.length - 1; i++) {
77
+ if (!obj[parts[i]])
78
+ obj[parts[i]] = {};
79
+ obj = obj[parts[i]];
80
+ }
81
+ obj[parts[parts.length - 1]] = value;
82
+ saveConfig(config);
83
+ return config;
84
+ }
85
+ exports.default = { loadConfig, saveConfig, getConfig, setConfig };
86
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAgCA,gCAYC;AAED,gCAoBC;AAED,8BASC;AAED,8BAWC;AA1FD,2BAAuE;AACvE,+BAA8B;AAC9B,wCAA8C;AAE9C,uDAAuD;AACvD,MAAM,UAAU,GAAG,IAAA,qBAAc,GAAE,CAAA;AACnC,MAAM,WAAW,GAAG,IAAA,cAAO,EAAC,UAAU,EAAE,aAAa,CAAC,CAAA;AAgBtD,MAAM,aAAa,GAAe;IAChC,OAAO,EAAE,EAAE;CACZ,CAAA;AAED,SAAS,eAAe;IACtB,IAAI,CAAC,IAAA,eAAU,EAAC,UAAU,CAAC,EAAE,CAAC;QAC5B,IAAA,cAAS,EAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IAC5C,CAAC;AACH,CAAC;AAED,SAAgB,UAAU;IACxB,eAAe,EAAE,CAAA;IACjB,IAAI,CAAC,IAAA,eAAU,EAAC,WAAW,CAAC,EAAE,CAAC;QAC7B,UAAU,CAAC,aAAa,CAAC,CAAA;QACzB,OAAO,EAAE,GAAG,aAAa,EAAE,CAAA;IAC7B,CAAC;IACD,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,IAAA,iBAAY,EAAC,WAAW,EAAE,OAAO,CAAC,CAAA;QAC/C,OAAO,EAAE,GAAG,aAAa,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAA;IAClD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,GAAG,aAAa,EAAE,CAAA;IAC7B,CAAC;AACH,CAAC;AAED,SAAgB,UAAU,CAAC,MAAkB;IAC3C,eAAe,EAAE,CAAA;IACjB,oEAAoE;IACpE,0EAA0E;IAC1E,oEAAoE;IACpE,MAAM,OAAO,GAAG,WAAW,GAAG,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;IAChE,IAAI,CAAC;QACH,IAAA,kBAAa,EAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;QAChE,qEAAqE;QACrE,2CAA2C;QAC3C,IAAI,CAAC;YACH,OAAO,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAChD,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAChD,OAAO,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;QACnC,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,CAAC;YAAC,OAAO,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;QAAC,CAAC;QAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC;QAChE,MAAM,GAAG,CAAA;IACX,CAAC;AACH,CAAC;AAED,SAAgB,SAAS,CAAC,GAAW;IACnC,MAAM,MAAM,GAAG,UAAU,EAAE,CAAA;IAC3B,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC5B,IAAI,KAAK,GAAQ,MAAM,CAAA;IACvB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO,SAAS,CAAA;QAC3D,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAA;IACrB,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED,SAAgB,SAAS,CAAC,GAAW,EAAE,KAAU;IAC/C,MAAM,MAAM,GAAG,UAAU,EAAE,CAAA;IAC3B,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC5B,IAAI,GAAG,GAAQ,MAAM,CAAA;IACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;QACtC,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IACrB,CAAC;IACD,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAA;IACpC,UAAU,CAAC,MAAM,CAAC,CAAA;IAClB,OAAO,MAAM,CAAA;AACf,CAAC;AAED,kBAAe,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,25 @@
1
1
  {
2
2
  "name": "@starpak/config",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
3
+ "description": "Spak Config - Central configuration manager",
4
+ "version": "1.0.5",
5
+ "main": "lib/index.js",
6
+ "typings": "lib/index.d.ts",
7
+ "exports": {
8
+ ".": {
9
+ "types": "./lib/index.d.ts",
10
+ "import": "./lib/index.js",
11
+ "require": "./lib/index.js"
12
+ },
13
+ "./src/*": "./src/*",
14
+ "./package.json": "./package.json"
15
+ },
16
+ "files": [
17
+ "lib",
18
+ "src"
19
+ ],
20
+ "author": "Spak Team",
21
+ "license": "MIT",
22
+ "dependencies": {
23
+ "@starpak/util": "^1.0.5"
24
+ }
6
25
  }
package/src/index.ts ADDED
@@ -0,0 +1,93 @@
1
+ import { readFileSync, writeFileSync, existsSync, mkdirSync } from 'fs'
2
+ import { resolve } from 'path'
3
+ import { projectDataDir } from '@starpak/util'
4
+
5
+ // 数据目录 = 项目源码根下的 data/(尊重 SPAK_DATA_DIR 覆盖,不写 ~/.spak)
6
+ const CONFIG_DIR = projectDataDir()
7
+ const CONFIG_FILE = resolve(CONFIG_DIR, 'config.json')
8
+
9
+ export interface SpakConfig {
10
+ plugins: Record<string, any>
11
+ cpc?: {
12
+ enabled?: boolean
13
+ sandbox?: { enabled?: boolean }
14
+ processIsolation?: { enabled?: boolean }
15
+ ssetps?: {
16
+ enabled?: boolean
17
+ /** Memory limit in MB for SSetPS RSS monitoring; 80% of this trips the warning + circuit breaker. */
18
+ memoryLimitMB?: number
19
+ }
20
+ }
21
+ }
22
+
23
+ const defaultConfig: SpakConfig = {
24
+ plugins: {},
25
+ }
26
+
27
+ function ensureConfigDir() {
28
+ if (!existsSync(CONFIG_DIR)) {
29
+ mkdirSync(CONFIG_DIR, { recursive: true })
30
+ }
31
+ }
32
+
33
+ export function loadConfig(): SpakConfig {
34
+ ensureConfigDir()
35
+ if (!existsSync(CONFIG_FILE)) {
36
+ saveConfig(defaultConfig)
37
+ return { ...defaultConfig }
38
+ }
39
+ try {
40
+ const data = readFileSync(CONFIG_FILE, 'utf-8')
41
+ return { ...defaultConfig, ...JSON.parse(data) }
42
+ } catch {
43
+ return { ...defaultConfig }
44
+ }
45
+ }
46
+
47
+ export function saveConfig(config: SpakConfig): void {
48
+ ensureConfigDir()
49
+ // Atomic write: write to a temp file first, then rename into place.
50
+ // This prevents half-written JSON when the process crashes mid-write, and
51
+ // reduces the race window between two concurrent setConfig() calls.
52
+ const tmpFile = CONFIG_FILE + '.tmp.' + process.pid.toString(36)
53
+ try {
54
+ writeFileSync(tmpFile, JSON.stringify(config, null, 2), 'utf-8')
55
+ // rename() is atomic on POSIX filesystems; on Windows we fallback to
56
+ // replace via copy+unlink if rename fails.
57
+ try {
58
+ require('fs').renameSync(tmpFile, CONFIG_FILE)
59
+ } catch {
60
+ require('fs').copyFileSync(tmpFile, CONFIG_FILE)
61
+ require('fs').unlinkSync(tmpFile)
62
+ }
63
+ } catch (err) {
64
+ try { require('fs').unlinkSync(tmpFile) } catch { /* ignore */ }
65
+ throw err
66
+ }
67
+ }
68
+
69
+ export function getConfig(key: string): any {
70
+ const config = loadConfig()
71
+ const parts = key.split('.')
72
+ let value: any = config
73
+ for (const part of parts) {
74
+ if (value === undefined || value === null) return undefined
75
+ value = value[part]
76
+ }
77
+ return value
78
+ }
79
+
80
+ export function setConfig(key: string, value: any): SpakConfig {
81
+ const config = loadConfig()
82
+ const parts = key.split('.')
83
+ let obj: any = config
84
+ for (let i = 0; i < parts.length - 1; i++) {
85
+ if (!obj[parts[i]]) obj[parts[i]] = {}
86
+ obj = obj[parts[i]]
87
+ }
88
+ obj[parts[parts.length - 1]] = value
89
+ saveConfig(config)
90
+ return config
91
+ }
92
+
93
+ export default { loadConfig, saveConfig, getConfig, setConfig }
package/README.md DELETED
@@ -1,3 +0,0 @@
1
- # Temporary Holding Version
2
-
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.