@next-box/appsettings 0.0.6 → 0.0.8

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@next-box/appsettings",
   "description": "A configuration management library for TypeScript applications, inspired by .NET’s appsettings.json.",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "author": "miami-man",
   "license": "MIT",
   "homepage": "https://github.com/badbatch/next-box",

package/src/components/AppSettingsProvider.test.tsx

@@ -2,9 +2,12 @@
 
 import { describe, expect, it } from '@jest/globals';
 import { render, screen } from '@testing-library/react';
-import { useAppSetting } from '../hooks/useAppSetting.ts';
+import { createUseSetting } from '../hooks/createUseSetting.ts';
 import { AppSettingsProvider } from './AppSettingsProvider.tsx';
 
+type Settings = { Api: { Timeout: number } };
+
+const useAppSetting = createUseSetting<Settings>();
 const SettingsOutput = () => <span>{String(useAppSetting('Api.Timeout'))}</span>;
 
 describe('AppSettingsProvider', () => {

package/src/hooks/{useAppSetting.test.tsx → createUseAppSetting.test.tsx}

@@ -2,23 +2,24 @@
 
 import { describe, expect, it } from '@jest/globals';
 import { renderHook } from '@testing-library/react';
-import { type ReactNode } from 'react';
+import { type PropsWithChildren } from 'react';
 import { AppSettingsProvider } from '../components/AppSettingsProvider.tsx';
-import { useAppSetting } from './useAppSetting.ts';
+import { createUseSetting } from './createUseSetting.ts';
 
 const settings = { Api: { Missing: undefined, Timeout: 5000 } };
+const useSetting = createUseSetting<typeof settings>();
 
-const createWrapper = ({ children }: { children: ReactNode }) => (
+const createWrapper = ({ children }: PropsWithChildren) => (
   <AppSettingsProvider settings={settings}>{children}</AppSettingsProvider>
 );
 
-describe('useAppSetting', () => {
+describe('useSetting', () => {
   it('When used within a provider, then it returns the value at the requested leaf path', () => {
     // Arrange
     const path = 'Api.Timeout';
 
     // Act
-    const { result } = renderHook(() => useAppSetting(path), { wrapper: createWrapper });
+    const { result } = renderHook(() => useSetting(path), { wrapper: createWrapper });
 
     // Assert
     expect(result.current).toBe(5000);
@@ -29,7 +30,12 @@ describe('useAppSetting', () => {
     const path = 'Api.Missing';
 
     // Act
-    const { result } = renderHook(() => useAppSetting(path), { wrapper: createWrapper });
+    const { result } = renderHook(
+      () => {
+        useSetting(path);
+      },
+      { wrapper: createWrapper },
+    );
 
     // Assert
     expect(result.current).toBeUndefined();

package/src/hooks/{useAppSettings.test.tsx → createUseAppSettings.test.tsx}

@@ -2,13 +2,14 @@
 
 import { describe, expect, it } from '@jest/globals';
 import { renderHook } from '@testing-library/react';
-import { type ReactNode } from 'react';
+import { type PropsWithChildren } from 'react';
 import { AppSettingsProvider } from '../components/AppSettingsProvider.tsx';
-import { useAppSettings } from './useAppSettings.ts';
+import { createUseAppSettings } from './createUseAppSettings.ts';
 
 const settings = { Api: { Timeout: 5000 } };
+const useAppSettings = createUseAppSettings<typeof settings>();
 
-const createWrapper = ({ children }: { children: ReactNode }) => (
+const createWrapper = ({ children }: PropsWithChildren) => (
   <AppSettingsProvider settings={settings}>{children}</AppSettingsProvider>
 );
 
@@ -29,6 +30,7 @@ describe('useAppSettings', () => {
     const path = 'Missing';
 
     // Act
+    // @ts-expect-error Intended for test
     const { result } = renderHook(() => useAppSettings(path), { wrapper: createWrapper });
 
     // Assert

package/src/hooks/createUseAppSettings.ts

@@ -0,0 +1,12 @@
+import { type Get } from 'type-fest';
+import { type SettingSectionPath } from '#types/Config.types.ts';
+import { useAppSettingsContext } from './useAppSettingsContext.ts';
+
+export const createUseAppSettings = <T extends object>() => {
+  return <P extends SettingSectionPath<T>>(path: P): Get<T, P> | undefined => {
+    const settings = useAppSettingsContext();
+    // Assert the resolved settings type based on the caller-provided schema and path.
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    return settings.read(path) as Get<T, P> | undefined;
+  };
+};

package/src/hooks/createUseSetting.ts

@@ -0,0 +1,12 @@
+import { type Get } from 'type-fest';
+import { useAppSettingsContext } from '#hooks/useAppSettingsContext.ts';
+import { type SettingPath } from '#types/Config.types.ts';
+
+export const createUseSetting = <T extends object>() => {
+  return <P extends SettingPath<T>>(path: P): Get<T, P> | undefined => {
+    const settings = useAppSettingsContext();
+    // Assert the resolved setting type based on the caller-provided schema and path.
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    return settings.read(path) as Get<T, P> | undefined;
+  };
+};

package/src/index.ts

@@ -1,12 +1,7 @@
 export { AppSettingsProvider } from '#components/AppSettingsProvider.tsx';
 export { Setting } from '#components/Setting.tsx';
-export { useAppSetting } from '#hooks/useAppSetting.ts';
-export { useAppSettings } from '#hooks/useAppSettings.ts';
+export { createUseSetting } from '#hooks/createUseSetting.ts';
+export { createUseAppSettings } from '#hooks/createUseAppSettings.ts';
 export { useAppSettingsContext } from '#hooks/useAppSettingsContext.ts';
 export type { AppSettings, ScopedSettings } from '#types/AppSettings.types.ts';
 export type { SettingPath, SettingSectionPath, SettingValue } from '#types/Config.types.ts';
-
-// Consumers can augment this interface through the package's public entry point.
-export interface AppSettingsSchema {
-  readonly __appSettingsSchema?: never;
-}

package/src/types/Config.types.ts

@@ -17,12 +17,11 @@ export type SettingPath<T extends object, Depth extends number = 5> = Depth exte
 export type SettingSectionPath<T extends object, Depth extends number = 5> = Depth extends 0
   ? never
   : {
-      [K in Exclude<Extract<keyof T, string>, '__appSettingsSchema'>]: NonNullable<T[K]> extends
-        Primitive | readonly Primitive[]
+      [K in Extract<keyof T, string>]: NonNullable<T[K]> extends Primitive | readonly Primitive[]
         ? never
         : NonNullable<T[K]> extends object
           ? K | `${K}.${SettingSectionPath<NonNullable<T[K]>, PreviousDepth[Depth]>}`
           : never;
-    }[Exclude<Extract<keyof T, string>, '__appSettingsSchema'>];
+    }[Extract<keyof T, string>];
 
 export type SettingValue<T extends object, P extends SettingPath<T>> = Get<T, P>;

package/dist/cjs/hooks/useAppSetting.cjs

@@ -1,2 +0,0 @@
-"use strict";var t=require("./useAppSettingsContext.cjs");exports.useAppSetting=function(e){return t.useAppSettingsContext().read(e)};
-//# sourceMappingURL=useAppSetting.cjs.map

package/dist/cjs/hooks/useAppSetting.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"useAppSetting.cjs","sources":["../../../src/hooks/useAppSetting.ts"],"sourcesContent":["import { type Get } from 'type-fest';\nimport { type AppSettingsSchema } from '../index.ts';\nimport { type SettingPath } from '../types/Config.types.ts';\nimport { useAppSettingsContext } from './useAppSettingsContext.ts';\n\nexport function useAppSetting<P extends SettingPath<AppSettingsSchema>>(path: P): Get<AppSettingsSchema, P> | undefined;\nexport function useAppSetting<T extends object, P extends SettingPath<T>>(path: P): Get<T, P> | undefined;\n\n// Required for overloads\n// eslint-disable-next-line prefer-arrow/prefer-arrow-functions\nexport function useAppSetting(path: string): unknown {\n  const settings = useAppSettingsContext();\n  return settings.read(path);\n}\n"],"names":["path","useAppSettingsContext","read"],"mappings":"gFAUO,SAAuBA,GAE5B,OADiBC,EAAAA,wBACDC,KAAKF,EACvB"}

package/dist/cjs/hooks/useAppSettings.cjs

@@ -1,2 +0,0 @@
-"use strict";var t=require("./useAppSettingsContext.cjs");exports.useAppSettings=function(e){return t.useAppSettingsContext().read(e)};
-//# sourceMappingURL=useAppSettings.cjs.map

package/dist/cjs/hooks/useAppSettings.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"useAppSettings.cjs","sources":["../../../src/hooks/useAppSettings.ts"],"sourcesContent":["import { type Get } from 'type-fest';\nimport { type SettingSectionPath } from '#types/Config.types.ts';\nimport { type AppSettingsSchema } from '../index.ts';\nimport { useAppSettingsContext } from './useAppSettingsContext.ts';\n\nexport function useAppSettings<\n  P extends SettingSectionPath<{\n    [K in keyof AppSettingsSchema]: AppSettingsSchema[K];\n  }>,\n>(path: P): Get<AppSettingsSchema, P> | undefined;\n\nexport function useAppSettings<T extends object, P extends SettingSectionPath<T>>(path: P): Get<T, P> | undefined;\n\n// Required for overloads\n// eslint-disable-next-line prefer-arrow/prefer-arrow-functions\nexport function useAppSettings(path: string): unknown {\n  const settings = useAppSettingsContext();\n  return settings.read(path);\n}\n"],"names":["path","useAppSettingsContext","read"],"mappings":"iFAeO,SAAwBA,GAE7B,OADiBC,EAAAA,wBACDC,KAAKF,EACvB"}

package/dist/esm/hooks/useAppSetting.mjs

@@ -1,2 +0,0 @@
-import{useAppSettingsContext as t}from"./useAppSettingsContext.mjs";function e(e){return t().read(e)}export{e as useAppSetting};
-//# sourceMappingURL=useAppSetting.mjs.map

package/dist/esm/hooks/useAppSetting.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"useAppSetting.mjs","sources":["../../../src/hooks/useAppSetting.ts"],"sourcesContent":["import { type Get } from 'type-fest';\nimport { type AppSettingsSchema } from '../index.ts';\nimport { type SettingPath } from '../types/Config.types.ts';\nimport { useAppSettingsContext } from './useAppSettingsContext.ts';\n\nexport function useAppSetting<P extends SettingPath<AppSettingsSchema>>(path: P): Get<AppSettingsSchema, P> | undefined;\nexport function useAppSetting<T extends object, P extends SettingPath<T>>(path: P): Get<T, P> | undefined;\n\n// Required for overloads\n// eslint-disable-next-line prefer-arrow/prefer-arrow-functions\nexport function useAppSetting(path: string): unknown {\n  const settings = useAppSettingsContext();\n  return settings.read(path);\n}\n"],"names":["useAppSetting","path","useAppSettingsContext","read"],"mappings":"oEAUO,SAASA,EAAcC,GAE5B,OADiBC,IACDC,KAAKF,EACvB"}

package/dist/esm/hooks/useAppSettings.mjs

@@ -1,2 +0,0 @@
-import{useAppSettingsContext as t}from"./useAppSettingsContext.mjs";function e(e){return t().read(e)}export{e as useAppSettings};
-//# sourceMappingURL=useAppSettings.mjs.map

package/dist/esm/hooks/useAppSettings.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"useAppSettings.mjs","sources":["../../../src/hooks/useAppSettings.ts"],"sourcesContent":["import { type Get } from 'type-fest';\nimport { type SettingSectionPath } from '#types/Config.types.ts';\nimport { type AppSettingsSchema } from '../index.ts';\nimport { useAppSettingsContext } from './useAppSettingsContext.ts';\n\nexport function useAppSettings<\n  P extends SettingSectionPath<{\n    [K in keyof AppSettingsSchema]: AppSettingsSchema[K];\n  }>,\n>(path: P): Get<AppSettingsSchema, P> | undefined;\n\nexport function useAppSettings<T extends object, P extends SettingSectionPath<T>>(path: P): Get<T, P> | undefined;\n\n// Required for overloads\n// eslint-disable-next-line prefer-arrow/prefer-arrow-functions\nexport function useAppSettings(path: string): unknown {\n  const settings = useAppSettingsContext();\n  return settings.read(path);\n}\n"],"names":["useAppSettings","path","useAppSettingsContext","read"],"mappings":"oEAeO,SAASA,EAAeC,GAE7B,OADiBC,IACDC,KAAKF,EACvB"}

package/dist/types/cjs/hooks/useAppSetting.d.cts

@@ -1,6 +0,0 @@
-import { type Get } from 'type-fest';
-import { type AppSettingsSchema } from '../index.cts';
-import { type SettingPath } from '../types/Config.types.cts';
-export declare function useAppSetting<P extends SettingPath<AppSettingsSchema>>(path: P): Get<AppSettingsSchema, P> | undefined;
-export declare function useAppSetting<T extends object, P extends SettingPath<T>>(path: P): Get<T, P> | undefined;
-//# sourceMappingURL=useAppSetting.d.cts.map

package/dist/types/cjs/hooks/useAppSetting.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useAppSetting.d.cts","sourceRoot":"","sources":["../../../../src/hooks/useAppSetting.cts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAG5D,wBAAgB,aAAa,CAAC,CAAC,SAAS,WAAW,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,iBAAiB,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC;AACxH,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC"}

package/dist/types/cjs/hooks/useAppSettings.d.cts

@@ -1,8 +0,0 @@
-import { type Get } from 'type-fest';
-import { type SettingSectionPath } from '#types/Config.types.cts';
-import { type AppSettingsSchema } from '../index.cts';
-export declare function useAppSettings<P extends SettingSectionPath<{
-    [K in keyof AppSettingsSchema]: AppSettingsSchema[K];
-}>>(path: P): Get<AppSettingsSchema, P> | undefined;
-export declare function useAppSettings<T extends object, P extends SettingSectionPath<T>>(path: P): Get<T, P> | undefined;
-//# sourceMappingURL=useAppSettings.d.cts.map

package/dist/types/cjs/hooks/useAppSettings.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useAppSettings.d.cts","sourceRoot":"","sources":["../../../../src/hooks/useAppSettings.cts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAGrD,wBAAgB,cAAc,CAC5B,CAAC,SAAS,kBAAkB,CAAC;KAC1B,CAAC,IAAI,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,CAAC,CAAC;CACrD,CAAC,EACF,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,iBAAiB,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC;AAElD,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,kBAAkB,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC"}

package/dist/types/esm/hooks/useAppSetting.d.ts

@@ -1,6 +0,0 @@
-import { type Get } from 'type-fest';
-import { type AppSettingsSchema } from '../index.ts';
-import { type SettingPath } from '../types/Config.types.ts';
-export declare function useAppSetting<P extends SettingPath<AppSettingsSchema>>(path: P): Get<AppSettingsSchema, P> | undefined;
-export declare function useAppSetting<T extends object, P extends SettingPath<T>>(path: P): Get<T, P> | undefined;
-//# sourceMappingURL=useAppSetting.d.ts.map

package/dist/types/esm/hooks/useAppSetting.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useAppSetting.d.ts","sourceRoot":"","sources":["../../../../src/hooks/useAppSetting.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAG5D,wBAAgB,aAAa,CAAC,CAAC,SAAS,WAAW,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,iBAAiB,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC;AACxH,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC"}

package/dist/types/esm/hooks/useAppSettings.d.ts

@@ -1,8 +0,0 @@
-import { type Get } from 'type-fest';
-import { type SettingSectionPath } from '#types/Config.types.ts';
-import { type AppSettingsSchema } from '../index.ts';
-export declare function useAppSettings<P extends SettingSectionPath<{
-    [K in keyof AppSettingsSchema]: AppSettingsSchema[K];
-}>>(path: P): Get<AppSettingsSchema, P> | undefined;
-export declare function useAppSettings<T extends object, P extends SettingSectionPath<T>>(path: P): Get<T, P> | undefined;
-//# sourceMappingURL=useAppSettings.d.ts.map

package/dist/types/esm/hooks/useAppSettings.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useAppSettings.d.ts","sourceRoot":"","sources":["../../../../src/hooks/useAppSettings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAGrD,wBAAgB,cAAc,CAC5B,CAAC,SAAS,kBAAkB,CAAC;KAC1B,CAAC,IAAI,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,CAAC,CAAC;CACrD,CAAC,EACF,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,iBAAiB,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC;AAElD,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,kBAAkB,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC"}

package/src/hooks/useAppSetting.ts

@@ -1,14 +0,0 @@
-import { type Get } from 'type-fest';
-import { type AppSettingsSchema } from '../index.ts';
-import { type SettingPath } from '../types/Config.types.ts';
-import { useAppSettingsContext } from './useAppSettingsContext.ts';
-
-export function useAppSetting<P extends SettingPath<AppSettingsSchema>>(path: P): Get<AppSettingsSchema, P> | undefined;
-export function useAppSetting<T extends object, P extends SettingPath<T>>(path: P): Get<T, P> | undefined;
-
-// Required for overloads
-// eslint-disable-next-line prefer-arrow/prefer-arrow-functions
-export function useAppSetting(path: string): unknown {
-  const settings = useAppSettingsContext();
-  return settings.read(path);
-}

package/src/hooks/useAppSettings.ts

@@ -1,19 +0,0 @@
-import { type Get } from 'type-fest';
-import { type SettingSectionPath } from '#types/Config.types.ts';
-import { type AppSettingsSchema } from '../index.ts';
-import { useAppSettingsContext } from './useAppSettingsContext.ts';
-
-export function useAppSettings<
-  P extends SettingSectionPath<{
-    [K in keyof AppSettingsSchema]: AppSettingsSchema[K];
-  }>,
->(path: P): Get<AppSettingsSchema, P> | undefined;
-
-export function useAppSettings<T extends object, P extends SettingSectionPath<T>>(path: P): Get<T, P> | undefined;
-
-// Required for overloads
-// eslint-disable-next-line prefer-arrow/prefer-arrow-functions
-export function useAppSettings(path: string): unknown {
-  const settings = useAppSettingsContext();
-  return settings.read(path);
-}