@veap/settings 0.1.0 → 0.1.1

package/README.md

@@ -1,5 +1,6 @@
-[![CI](https://github.com/veapjs/veap-settings/actions/workflows/ci.yml/badge.svg)](https://github.com/veapjs/veap-settings/actions/workflows/ci.yml)
-[![Release](https://github.com/veapjs/veap-settings/actions/workflows/release.yml/badge.svg)](https://github.com/veapjs/veap-settings/actions/workflows/release.yml)
+[![CI](https://github.com/veapjs/veap-settings/actions/workflows/CI.yml/badge.svg)](https://github.com/veapjs/veap-settings/actions/workflows/CI.yml)
+[![Release](https://github.com/veapjs/veap-settings/actions/workflows/RELEASE.yml/badge.svg)](https://github.com/veapjs/veap-settings/actions/workflows/RELEASE.yml)
+[![Version](https://img.shields.io/npm/v/@veap/settings?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/@veap/settings)
 
 # @veap/settings
 

package/dist/composition.d.ts

@@ -0,0 +1,15 @@
+import { type SettingsConfig } from "./providers/settings.provider.js";
+declare module "@veap/kernel" {
+    interface ApplicationBuilder {
+        /**
+         * Registers the SettingsServiceProvider into the application.
+         */
+        withSettings(config?: SettingsConfig): this;
+    }
+    interface VeapConfig {
+        /**
+         * Configuration options for @veap/settings.
+         */
+        settings?: SettingsConfig;
+    }
+}

package/dist/composition.js

@@ -0,0 +1,5 @@
+import { ApplicationBuilder } from "@veap/kernel";
+import { SettingsServiceProvider, } from "./providers/settings.provider.js";
+ApplicationBuilder.prototype.withSettings = function (config) {
+    return this.use((c) => new SettingsServiceProvider(c, config));
+};

package/dist/contracts/index.d.ts

@@ -1 +1 @@
-export { type ISettingsRepository, SETTINGS_REPOSITORY, } from "./settings.repository";
+export { type ISettingsRepository, type ISettingsService, SETTINGS_REPOSITORY, SETTINGS_SERVICE, } from "./settings.repository.js";

package/dist/contracts/index.js

@@ -1 +1 @@
-export { SETTINGS_REPOSITORY, } from "./settings.repository";
+export { SETTINGS_REPOSITORY, SETTINGS_SERVICE, } from "./settings.repository.js";

package/dist/contracts/settings.repository.d.ts

@@ -1,3 +1,4 @@
+import type { Token } from "@veap/kernel";
 /**
  * Settings persistence port.
  */
@@ -6,8 +7,24 @@ export interface ISettingsRepository {
     set(key: string, value: unknown): Promise<void>;
     delete(key: string): Promise<void>;
     clear(): Promise<void>;
+    all?(): Promise<Record<string, unknown>>;
 }
 /**
  * Injection token for the settings repository port.
  */
-export declare const SETTINGS_REPOSITORY: unique symbol;
+export declare const SETTINGS_REPOSITORY: Token<ISettingsRepository>;
+/**
+ * Forward type reference for SettingsService in IoC tokens.
+ */
+export interface ISettingsService {
+    get<T>(key: string, defaultValue?: T | null): Promise<T | null>;
+    set(key: string, value: unknown): Promise<void>;
+    remove(key: string): Promise<void>;
+    clear(): Promise<void>;
+    has(key: string): Promise<boolean>;
+    all(): Promise<Record<string, unknown>>;
+}
+/**
+ * Injection token for the settings application service.
+ */
+export declare const SETTINGS_SERVICE: Token<ISettingsService>;

package/dist/contracts/settings.repository.js

@@ -2,3 +2,7 @@
  * Injection token for the settings repository port.
  */
 export const SETTINGS_REPOSITORY = Symbol.for("veap:settings:repository");
+/**
+ * Injection token for the settings application service.
+ */
+export const SETTINGS_SERVICE = Symbol.for("veap:settings:service");

package/dist/index.d.ts

@@ -1,6 +1,7 @@
-export * from "./contracts";
-export * from "./migrations";
-export * from "./models";
-export * from "./providers";
-export * from "./repositories";
-export * from "./services";
+export * from "./composition.js";
+export * from "./contracts/index.js";
+export * from "./migrations/index.js";
+export * from "./models/index.js";
+export * from "./providers/index.js";
+export * from "./repositories/index.js";
+export * from "./services/index.js";

package/dist/index.js

@@ -1,6 +1,7 @@
-export * from "./contracts";
-export * from "./migrations";
-export * from "./models";
-export * from "./providers";
-export * from "./repositories";
-export * from "./services";
+export * from "./composition.js";
+export * from "./contracts/index.js";
+export * from "./migrations/index.js";
+export * from "./models/index.js";
+export * from "./providers/index.js";
+export * from "./repositories/index.js";
+export * from "./services/index.js";

package/dist/migrations/index.d.ts

@@ -1,4 +1,4 @@
-import * as m0001 from "./0001_create_settings_table";
+import * as m0001 from "./0001_create_settings_table.js";
 export declare const settingsMigrations: (typeof m0001)[];
 export declare function runSettingsMigrations(): Promise<void>;
 export default settingsMigrations;

package/dist/migrations/index.js

@@ -1,5 +1,5 @@
 import { runMigrations } from "@veap/database";
-import * as m0001 from "./0001_create_settings_table";
+import * as m0001 from "./0001_create_settings_table.js";
 export const settingsMigrations = [m0001];
 export async function runSettingsMigrations() {
     await runMigrations("settings", settingsMigrations);

package/dist/models/index.d.ts

@@ -1 +1 @@
-export { Setting, type SettingAttributes, } from "./Setting";
+export { Setting, type SettingAttributes, } from "./Setting.js";

package/dist/models/index.js

@@ -1 +1 @@
-export { Setting, } from "./Setting";
+export { Setting, } from "./Setting.js";

package/dist/models.d.ts

@@ -1 +1 @@
-export * from "./models/index";
+export * from "./models/index.js";

package/dist/models.js

@@ -1 +1 @@
-export * from "./models/index";
+export * from "./models/index.js";

package/dist/providers/index.d.ts

@@ -1 +1 @@
-export { type SettingsConfig, SettingsServiceProvider, } from "./settings.provider";
+export { type SettingsConfig, SettingsServiceProvider, } from "./settings.provider.js";

package/dist/providers/index.js

@@ -1 +1 @@
-export { SettingsServiceProvider, } from "./settings.provider";
+export { SettingsServiceProvider, } from "./settings.provider.js";

package/dist/providers/settings.provider.js

@@ -1,9 +1,9 @@
 import { isDatabaseInitialized } from "@veap/database";
-import { logger, ServiceProvider } from "@veap/kernel";
-import { SETTINGS_REPOSITORY } from "../contracts/settings.repository";
-import { runSettingsMigrations } from "../migrations";
-import { ActiveRecordSettingsRepository } from "../repositories/setting.repository";
-import { SettingsService } from "../services/settings.service";
+import { ConfigService, logger, ServiceProvider, } from "@veap/kernel";
+import { SETTINGS_REPOSITORY, SETTINGS_SERVICE, } from "../contracts/settings.repository.js";
+import { runSettingsMigrations } from "../migrations/index.js";
+import { ActiveRecordSettingsRepository } from "../repositories/setting.repository.js";
+import { SettingsService } from "../services/settings.service.js";
 export class SettingsServiceProvider extends ServiceProvider {
     config;
     constructor(container, config) {
@@ -21,9 +21,26 @@ export class SettingsServiceProvider extends ServiceProvider {
             useClass: SettingsService,
             singleton: true,
         });
+        this.container.register({
+            token: SETTINGS_SERVICE,
+            useFactory: (service) => service,
+            inject: [SettingsService],
+            singleton: true,
+        });
     }
     async boot() {
-        if (this.config?.autoMigrate !== false && isDatabaseInitialized()) {
+        const configService = this.container.has(ConfigService)
+            ? await this.container.resolve(ConfigService)
+            : undefined;
+        const envAutoMigrate = configService?.get("SETTINGS_AUTO_MIGRATE") ??
+            (typeof process !== "undefined"
+                ? process.env.SETTINGS_AUTO_MIGRATE
+                : undefined);
+        const shouldAutoMigrate = this.config?.autoMigrate ??
+            (envAutoMigrate !== undefined
+                ? envAutoMigrate === "true" || envAutoMigrate === "1"
+                : true);
+        if (shouldAutoMigrate !== false && isDatabaseInitialized()) {
             try {
                 await runSettingsMigrations();
             }

package/dist/repositories/index.d.ts

@@ -1 +1 @@
-export { ActiveRecordSettingsRepository } from "./setting.repository";
+export { ActiveRecordSettingsRepository } from "./setting.repository.js";

package/dist/repositories/index.js

@@ -1 +1 @@
-export { ActiveRecordSettingsRepository } from "./setting.repository";
+export { ActiveRecordSettingsRepository } from "./setting.repository.js";

package/dist/repositories/setting.repository.d.ts

@@ -1,4 +1,4 @@
-import type { ISettingsRepository } from "../contracts/settings.repository";
+import type { ISettingsRepository } from "../contracts/settings.repository.js";
 /**
  * `ISettingsRepository` adapter backed by the `Setting` ActiveRecord model.
  */
@@ -7,4 +7,5 @@ export declare class ActiveRecordSettingsRepository implements ISettingsReposito
     set(key: string, value: unknown): Promise<void>;
     delete(key: string): Promise<void>;
     clear(): Promise<void>;
+    all(): Promise<Record<string, unknown>>;
 }

package/dist/repositories/setting.repository.js

@@ -1,4 +1,4 @@
-import { Setting } from "../models/Setting";
+import { Setting } from "../models/Setting.js";
 /**
  * `ISettingsRepository` adapter backed by the `Setting` ActiveRecord model.
  */
@@ -15,4 +15,15 @@ export class ActiveRecordSettingsRepository {
     async clear() {
         await Setting.query().delete();
     }
+    async all() {
+        const settings = await Setting.all();
+        const result = {};
+        for (const s of settings) {
+            const k = s.getAttribute("key");
+            if (k) {
+                result[k] = s.getAttribute("value");
+            }
+        }
+        return result;
+    }
 }

package/dist/server.d.ts

@@ -1 +1 @@
-export * from "./index";
+export * from "./index.js";

package/dist/server.js

@@ -1 +1 @@
-export * from "./index";
+export * from "./index.js";

package/dist/services/index.d.ts

@@ -1 +1 @@
-export { SettingsService } from "./settings.service";
+export { SettingsService } from "./settings.service.js";

package/dist/services/index.js

@@ -1 +1 @@
-export { SettingsService } from "./settings.service";
+export { SettingsService } from "./settings.service.js";

package/dist/services/settings.service.d.ts

@@ -1,21 +1,27 @@
 import { type ICacheProvider } from "@veap/kernel";
-import { type ISettingsRepository } from "../contracts/settings.repository";
+import { type ISettingsRepository, type ISettingsService } from "../contracts/settings.repository.js";
 /**
  * Application service for reading and writing settings.
  *
  * It depends exclusively on ports (ICacheProvider, ISettingsRepository)
  * that are injected through the constructor.
  */
-export declare class SettingsService {
+export declare class SettingsService implements ISettingsService {
     private cache;
     private repository;
     constructor(cache: ICacheProvider, repository: ISettingsRepository);
     /**
      * Get a setting value by key.
      * @param key Setting key (e.g., "system:page")
-     * @returns Value as T or null
+     * @param defaultValue Optional fallback value if the key does not exist
+     * @returns Value as T or defaultValue / null
      */
-    get<T>(key: string): Promise<T | null>;
+    get<T>(key: string, defaultValue?: T | null): Promise<T | null>;
+    /**
+     * Check if a setting exists.
+     * @param key Setting key
+     */
+    has(key: string): Promise<boolean>;
     /**
      * Set a setting value.
      * @param key Setting key
@@ -31,4 +37,8 @@ export declare class SettingsService {
      * Clear all settings.
      */
     clear(): Promise<void>;
+    /**
+     * Retrieve all settings as a key-value map.
+     */
+    all(): Promise<Record<string, unknown>>;
 }

package/dist/services/settings.service.js

@@ -11,7 +11,7 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
 import { CACHE_PROVIDER, Inject, Injectable, } from "@veap/kernel";
-import { SETTINGS_REPOSITORY, } from "../contracts/settings.repository";
+import { SETTINGS_REPOSITORY, } from "../contracts/settings.repository.js";
 /**
  * Application service for reading and writing settings.
  *
@@ -28,9 +28,10 @@ let SettingsService = class SettingsService {
     /**
      * Get a setting value by key.
      * @param key Setting key (e.g., "system:page")
-     * @returns Value as T or null
+     * @param defaultValue Optional fallback value if the key does not exist
+     * @returns Value as T or defaultValue / null
      */
-    async get(key) {
+    async get(key, defaultValue = null) {
         const cacheKey = `settings:${key}`;
         const cached = await this.cache.get(cacheKey);
         if (cached !== null)
@@ -38,8 +39,16 @@ let SettingsService = class SettingsService {
         const value = await this.repository.get(key);
         if (value !== null) {
             await this.cache.set(cacheKey, value);
+            return value;
         }
-        return value;
+        return defaultValue;
+    }
+    /**
+     * Check if a setting exists.
+     * @param key Setting key
+     */
+    async has(key) {
+        return (await this.get(key)) !== null;
     }
     /**
      * Set a setting value.
@@ -65,6 +74,15 @@ let SettingsService = class SettingsService {
         await this.repository.clear();
         await this.cache.clear();
     }
+    /**
+     * Retrieve all settings as a key-value map.
+     */
+    async all() {
+        if (this.repository.all) {
+            return this.repository.all();
+        }
+        return {};
+    }
 };
 SettingsService = __decorate([
     Injectable(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veap/settings",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Application settings management, caching, and persistence for Veap",
   "bugs": "https://github.com/veapjs/veap-settings/issues",
   "repository": {
@@ -40,8 +40,8 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@veap/database": "0.1.0",
-    "@veap/kernel": "0.1.0"
+    "@veap/database": "0.1.1",
+    "@veap/kernel": "0.1.1"
   },
   "devDependencies": {
     "@types/node": "^22.20.2",