@dreamkit/node-app 0.0.2-next.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Juanra GM <juanrgm724@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,22 @@
+# @dreamkit/node-app
+
+> DreamKit application for Node.js.
+
+[![workflow-badge]](https://github.com/swordev/dreamkit/actions/workflows/ci.yaml) [![npm-badge]](https://www.npmjs.com/package/@dreamkit/node-app)
+
+[workflow-badge]: https://img.shields.io/github/actions/workflow/status/swordev/dreamkit/ci.yaml?branch=main
+[npm-badge]: https://img.shields.io/npm/v/@dreamkit/node-app?label=@dreamkit/node-app
+
+## Installation
+
+```sh
+npm install @dreamkit/node-app
+```
+
+## Documentation
+
+https://dreamkit.dev
+
+## License
+
+Distributed under the MIT License. See LICENSE for more information.

package/lib/NodeSettingsHandler.d.ts

@@ -0,0 +1,37 @@
+export declare class NodeSettingsHandlerOptions {
+    readonly data: {
+        path: string;
+    };
+    constructor(data: {
+        path: string;
+    });
+}
+declare const NodeSettingsHandler_base: import("@dreamkit/ioc").IocClass<{
+    options: import("@dreamkit/ioc/params.js").IocParamBuilder<{
+        value: typeof NodeSettingsHandlerOptions;
+        optional: true;
+    }>;
+}, import("@dreamkit/app").SettingsHandler, never, import("@dreamkit/ioc").IocParams<{
+    options: import("@dreamkit/ioc/params.js").IocParamBuilder<{
+        value: typeof NodeSettingsHandlerOptions;
+        optional: true;
+    }>;
+}>>;
+export declare class NodeSettingsHandler extends NodeSettingsHandler_base {
+    protected onLoad(): Promise<{}>;
+    protected onSave(): Promise<{
+        "settings-data": {
+            path: string;
+            changed: boolean;
+        };
+        "settings-schema": {
+            path: string;
+            changed: boolean;
+        };
+    }>;
+    protected getSettingsPath(): string;
+    protected getSettingsSchemaPath(): string;
+    protected getSettingsSchema(): Record<string, any>;
+}
+export {};
+//# sourceMappingURL=NodeSettingsHandler.d.ts.map

package/lib/NodeSettingsHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NodeSettingsHandler.d.ts","sourceRoot":"","sources":["../src/NodeSettingsHandler.ts"],"names":[],"mappings":"AAOA,qBAAa,0BAA0B;IAKnC,QAAQ,CAAC,IAAI,EAAE;QACb,IAAI,EAAE,MAAM,CAAC;KACd;gBAFQ,IAAI,EAAE;QACb,IAAI,EAAE,MAAM,CAAC;KACd;CAEJ;;;;;;;;;;;;AAED,qBAAa,mBAAoB,SAAQ,wBAEvC;cAIgB,MAAM;cAIG,MAAM;;;;;;;;;;IA8B/B,SAAS,CAAC,eAAe;IAOzB,SAAS,CAAC,qBAAqB;IAG/B,SAAS,CAAC,iBAAiB,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAoBnD"}

package/lib/NodeSettingsHandler.js

@@ -0,0 +1,68 @@
+import { tryReadJsonFile, writeFileIfDifferent } from "./utils/fs.js";
+import { SettingsHandlerClass } from "@dreamkit/app";
+import { iocParam } from "@dreamkit/ioc";
+import { kind } from "@dreamkit/kind";
+import { basename } from "path";
+export class NodeSettingsHandlerOptions {
+    data;
+    static {
+        kind(this, "@dreamkit/node-app/NodeSettingsHandlerOptions");
+    }
+    constructor(data) {
+        this.data = data;
+    }
+}
+export class NodeSettingsHandler extends SettingsHandlerClass({
+    options: iocParam(NodeSettingsHandlerOptions).optional(),
+}) {
+    static {
+        kind(this, "@dreamkit/node-app/NodeSettingsHandler");
+    }
+    async onLoad() {
+        const settingsPath = this.getSettingsPath();
+        return (await tryReadJsonFile(settingsPath)) || {};
+    }
+    async onSave() {
+        const { prev, next } = await this.getData();
+        const schemaPath = this.getSettingsSchemaPath();
+        return {
+            "settings-data": {
+                path: this.getSettingsPath(),
+                changed: !!next &&
+                    (await writeFileIfDifferent(this.getSettingsPath(), JSON.stringify({
+                        $schema: `./${basename(schemaPath)}`,
+                        ...next,
+                    }, null, 2), prev ? JSON.stringify(prev, null, 2) : undefined)),
+            },
+            "settings-schema": {
+                path: schemaPath,
+                changed: await writeFileIfDifferent(schemaPath, JSON.stringify(this.getSettingsSchema(), null, 2)),
+            },
+        };
+    }
+    getSettingsPath() {
+        return (this.options?.data.path ??
+            process.env.DK_SETTINGS_PATH ??
+            "./settings.json");
+    }
+    getSettingsSchemaPath() {
+        return this.getSettingsPath().replace(/\.json$/, ".schema.json");
+    }
+    getSettingsSchema() {
+        const schema = {
+            type: "object",
+            additionalProperties: false,
+            required: [],
+            properties: {
+                $schema: { type: "string" },
+            },
+        };
+        for (const value of this.settings) {
+            const options = value.options;
+            if (!options.optional)
+                schema.required.push(options.name);
+            schema.properties[options.name] = options.params.toJsonSchema();
+        }
+        return schema;
+    }
+}

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+export { IocClass } from "@dreamkit/ioc";
+export { NodeSettingsHandler } from "./NodeSettingsHandler.js";
+export { NodeSettingsHandlerOptions } from "./NodeSettingsHandler.js";
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAC"}

package/lib/index.js

@@ -0,0 +1,3 @@
+export { IocClass } from "@dreamkit/ioc";
+export { NodeSettingsHandler } from "./NodeSettingsHandler.js";
+export { NodeSettingsHandlerOptions } from "./NodeSettingsHandler.js";

package/lib/utils/fs.d.ts

@@ -0,0 +1,5 @@
+export declare function writeFileIfDifferent(path: string, content: string, prev?: string): Promise<boolean>;
+export declare function tryReadFile(path: string): Promise<string | undefined>;
+export declare function tryReadTextFile(path: string): Promise<string | undefined>;
+export declare function tryReadJsonFile<T>(path: string): Promise<T | undefined>;
+//# sourceMappingURL=fs.d.ts.map

package/lib/utils/fs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../../src/utils/fs.ts"],"names":[],"mappings":"AAEA,wBAAsB,oBAAoB,CACxC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,MAAM,oBAMd;AAED,wBAAsB,WAAW,CAAC,IAAI,EAAE,MAAM,+BAM7C;AAED,wBAAsB,eAAe,CAAC,IAAI,EAAE,MAAM,+BAEjD;AAED,wBAAsB,eAAe,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAG7E"}

package/lib/utils/fs.js

@@ -0,0 +1,24 @@
+import { readFile, writeFile } from "fs/promises";
+export async function writeFileIfDifferent(path, content, prev) {
+    if (!prev)
+        prev = await tryReadFile(path);
+    const write = prev !== content;
+    if (write)
+        await writeFile(path, content);
+    return write;
+}
+export async function tryReadFile(path) {
+    try {
+        return (await readFile(path)).toString();
+    }
+    catch (_) {
+        return;
+    }
+}
+export async function tryReadTextFile(path) {
+    return (await tryReadFile(path))?.toString();
+}
+export async function tryReadJsonFile(path) {
+    const json = (await tryReadFile(path))?.toString();
+    return typeof json === "string" ? JSON.parse(json) : undefined;
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@dreamkit/node-app",
+  "version": "0.0.2-next.0",
+  "description": "DreamKit application for Node.js.",
+  "keywords": [],
+  "homepage": "https://dreamkit.dev",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/swordev/dreamkit/tree/main/packages/node-app"
+  },
+  "license": "MIT",
+  "author": "Juanra GM",
+  "contributors": [
+    {
+      "name": "Juanra GM",
+      "email": "juanrgm724@gmail.com",
+      "url": "https://github.com/juanrgm"
+    }
+  ],
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": "./lib/index.js",
+    "./*": "./lib/*"
+  },
+  "files": [
+    "lib"
+  ],
+  "dependencies": {
+    "@dreamkit/app": "0.0.7-next.1",
+    "@dreamkit/ioc": "0.0.2-next.0",
+    "@dreamkit/kind": "0.0.2",
+    "@dreamkit/schema": "0.0.5-next.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.9.0",
+    "@dreamkit/tsconfig": "0.0.1"
+  },
+  "x-dreamkit": {
+    "profile": "lib"
+  }
+}