typed-settings 0.1.0 → 0.1.4

package/dist/vault/http.d.cts

@@ -1,15 +1,33 @@
-import { F as Flat, a as SecretProvider } from '../types-BswIPp7U.cjs';
-import { F as FetchFn } from '../shared-DBcV6jIy.cjs';
+import { F as Flat, a as SecretProvider } from '../types-B_Dc2L4T.cjs';
+import { F as FetchFn } from '../shared-CucO_XsG.cjs';
 import '@standard-schema/spec';
 
+/**
+ * Generic HTTP secret provider: GETs a JSON endpoint and reads a dot-path
+ * (`jsonPath`, default `'data'`) into a flat map. Auth rides in `headers`.
+ *
+ * @module
+ */
+
+/** Options for {@link httpProvider}. */
 interface HttpProviderOptions {
+    /** Endpoint URL. */
     url: string;
+    /** Extra headers. Feed auth from env-injected values, never CLI args. */
     headers?: Flat;
+    /** Dot path into the JSON body. Default `'data'`; `''` reads the whole body. */
     jsonPath?: string;
+    /** Request timeout in ms. Default 5000. */
     timeoutMs?: number;
+    /** Injectable fetch for tests. */
     fetchFn?: FetchFn;
+    /** Response body cap in bytes. Default 1 MiB. */
     maxBytes?: number;
 }
+/**
+ * GETs a JSON endpoint and reads `jsonPath` into a flat map. Concurrent loads
+ * share one in-flight request; failures reset so the next call retries.
+ */
 declare function httpProvider(opts: HttpProviderOptions): SecretProvider;
 
 export { type HttpProviderOptions, httpProvider };

package/dist/vault/http.d.ts

@@ -1,15 +1,33 @@
-import { F as Flat, a as SecretProvider } from '../types-BswIPp7U.js';
-import { F as FetchFn } from '../shared-DBcV6jIy.js';
+import { F as Flat, a as SecretProvider } from '../types-B_Dc2L4T.js';
+import { F as FetchFn } from '../shared-CucO_XsG.js';
 import '@standard-schema/spec';
 
+/**
+ * Generic HTTP secret provider: GETs a JSON endpoint and reads a dot-path
+ * (`jsonPath`, default `'data'`) into a flat map. Auth rides in `headers`.
+ *
+ * @module
+ */
+
+/** Options for {@link httpProvider}. */
 interface HttpProviderOptions {
+    /** Endpoint URL. */
     url: string;
+    /** Extra headers. Feed auth from env-injected values, never CLI args. */
     headers?: Flat;
+    /** Dot path into the JSON body. Default `'data'`; `''` reads the whole body. */
     jsonPath?: string;
+    /** Request timeout in ms. Default 5000. */
     timeoutMs?: number;
+    /** Injectable fetch for tests. */
     fetchFn?: FetchFn;
+    /** Response body cap in bytes. Default 1 MiB. */
     maxBytes?: number;
 }
+/**
+ * GETs a JSON endpoint and reads `jsonPath` into a flat map. Concurrent loads
+ * share one in-flight request; failures reset so the next call retries.
+ */
 declare function httpProvider(opts: HttpProviderOptions): SecretProvider;
 
 export { type HttpProviderOptions, httpProvider };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typed-settings",
-  "version": "0.1.0",
+  "version": "0.1.4",
   "description": "One-call typed config for TS: env + .env + yaml/toml/json + secrets-dir + vault -> frozen object. Standard Schema + legacy bridges.",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -89,6 +89,14 @@
     "standard-schema"
   ],
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/prosubodh/typed-settings"
+  },
+  "homepage": "https://github.com/prosubodh/typed-settings#readme",
+  "bugs": {
+    "url": "https://github.com/prosubodh/typed-settings/issues"
+  },
   "engines": {
     "node": ">=20"
   },

package/dist/types-BswIPp7U.d.cts

@@ -1,41 +0,0 @@
-import { StandardSchemaV1 } from '@standard-schema/spec';
-
-type Flat = Record<string, string | undefined>;
-interface SecretProvider {
-    name: string;
-    load(): Promise<Flat> | Flat;
-}
-type SourceInput = 'env' | '.env' | '.env.local' | {
-    text: string;
-} | {
-    file: string;
-} | {
-    dir: string;
-} | {
-    map: Flat;
-    prefix?: string;
-} | {
-    provider: SecretProvider;
-    prefix?: string;
-} | SecretProvider | Flat | string;
-type ArrayStrategy = 'replace' | 'concat' | 'mergeIndex';
-type UnknownKeys = 'strip' | 'preserve' | 'reject';
-interface SettingsOptions<S extends StandardSchemaV1 = StandardSchemaV1> {
-    schema: S;
-    sources?: SourceInput[];
-    prefix?: string;
-    separator?: '__';
-    coerce?: boolean;
-    expand?: boolean;
-    expandSecrets?: boolean;
-    arrayStrategy?: ArrayStrategy;
-    unknownKeys?: UnknownKeys;
-    freeze?: boolean;
-    timeoutMs?: number;
-    maxBytes?: number;
-    envMap?: Record<string, string>;
-    allowUnresolved?: boolean;
-    env?: Flat;
-}
-
-export type { ArrayStrategy as A, Flat as F, SettingsOptions as S, UnknownKeys as U, SecretProvider as a, SourceInput as b };

package/dist/types-BswIPp7U.d.ts

@@ -1,41 +0,0 @@
-import { StandardSchemaV1 } from '@standard-schema/spec';
-
-type Flat = Record<string, string | undefined>;
-interface SecretProvider {
-    name: string;
-    load(): Promise<Flat> | Flat;
-}
-type SourceInput = 'env' | '.env' | '.env.local' | {
-    text: string;
-} | {
-    file: string;
-} | {
-    dir: string;
-} | {
-    map: Flat;
-    prefix?: string;
-} | {
-    provider: SecretProvider;
-    prefix?: string;
-} | SecretProvider | Flat | string;
-type ArrayStrategy = 'replace' | 'concat' | 'mergeIndex';
-type UnknownKeys = 'strip' | 'preserve' | 'reject';
-interface SettingsOptions<S extends StandardSchemaV1 = StandardSchemaV1> {
-    schema: S;
-    sources?: SourceInput[];
-    prefix?: string;
-    separator?: '__';
-    coerce?: boolean;
-    expand?: boolean;
-    expandSecrets?: boolean;
-    arrayStrategy?: ArrayStrategy;
-    unknownKeys?: UnknownKeys;
-    freeze?: boolean;
-    timeoutMs?: number;
-    maxBytes?: number;
-    envMap?: Record<string, string>;
-    allowUnresolved?: boolean;
-    env?: Flat;
-}
-
-export type { ArrayStrategy as A, Flat as F, SettingsOptions as S, UnknownKeys as U, SecretProvider as a, SourceInput as b };