envapt 6.0.0 → 6.0.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # envapt
 
+## 6.0.1
+
+### Patch Changes
+
+- 40c3e4b: Reword the package description to lead with typed config from any source rather than .env loading, because that's what envapt is about and the .env cascade is just one feature of the default Node source.
+
 ## 6.0.0
 
 ### Major Changes

package/README.md

@@ -3,8 +3,8 @@
 <h3>envapt</h3>
 
 <p>
-  <strong>The apt way to handle environment variables.</strong><br/>
-  Read them as typed values, with zero runtime dependencies.
+  <strong>The apt way to read typed config.</strong><br/>
+  Read config from any source as real typed values, with zero runtime dependencies.
 </p>
 
 <p>
@@ -17,9 +17,10 @@
 
 <br clear="left"/>
 
-`process.env` always hands you a `string | undefined`. envapt returns the type you asked for, with a
-fallback that removes `undefined` from the return type. On Node, Bun, and Deno it reads `process.env`
-and your `.env` files; on Cloudflare Workers and in the browser you bind the source with
+envapt returns config as the type you asked for instead of the `string | undefined` you get raw, with
+a fallback that removes `undefined` from the return type. It reads from whatever source you bind. On
+Node, Bun, and Deno that is `process.env` and your `.env` files, bound on import. On Cloudflare
+Workers, in the browser, or for a secrets object you fetched at boot, you bind the source with
 `Envapter.useSource(...)`.
 
 ```ts
@@ -35,14 +36,17 @@ const port = Envapter.getNumber('PORT', 3000); // number, not string | undefined
 - **Typed values.** A fallback removes `undefined` from the return type. Built-in converters cover
   numbers, booleans, bigint, JSON, URLs, regular expressions, dates, durations, and arrays, or pass
   your own function or a Standard Schema validator (zod, valibot, arktype).
-- **Zero runtime dependencies.** envapt ships its own `.env` parser, so nothing is added to your
-  dependency tree.
+- **Any source.** A source is any object with a `readVars()` method, so you can bind `process.env`, a
+  Cloudflare Workers binding, a browser bundle, or a secrets payload you fetched from a store at boot.
+  On Node, Bun, and Deno one binds on import.
+- **Zero runtime dependencies.** The reader, converters, and built-in `.env` parser are self-contained,
+  so nothing is added to your dependency tree.
 - **Runs on Node, Bun, Deno, Cloudflare Workers, and the browser.** Node `>=20`, Bun `>=1.3`, Deno
-  `>=2.5` (ESM and CJS); the Workers and browser builds resolve through the package `exports`
+  `>=2.5` (ESM and CJS). The Workers and browser builds resolve through the package `exports`
   conditions.
-- **`.env` loading on Node, Bun, and Deno.** A per-environment file cascade, `${VAR}` templates, and
-  strict / required checks. Off Node there is no filesystem, so you bind a source with
-  `Envapter.useSource(...)` and read with the same typed API.
+- **`.env` loading built in on Node.** The default Node source adds a per-environment file cascade,
+  `${VAR}` templates, and strict / required checks. Off Node there is no filesystem, so you bind
+  another source with `Envapter.useSource(...)` and read with the same typed API.
 
 ## Install
 
@@ -62,7 +66,7 @@ Both share the same parsing, converters, and cache.
 ### Functional
 
 Read a value from any call site, in JavaScript or TypeScript. No build step. On Node the source is
-bound for you; on Workers and in the browser, call `Envapter.useSource(...)` first.
+bound for you. On Workers and in the browser, call `Envapter.useSource(...)` first.
 
 ```ts
 import { Envapter, Converters } from 'envapt';

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "envapt",
   "type": "module",
-  "version": "6.0.0",
-  "description": "Type-safe environment variables for TypeScript. Zero-dependency .env loader and parser with one API across Node, Bun, Deno, Cloudflare Workers, and the Browser. Decorators, converters, Standard Schema (zod/valibot/arktype) validation, and much more.",
+  "version": "6.0.1",
+  "description": "Type-safe config for TypeScript. Read typed values from any source, process.env, .env files, Cloudflare Workers bindings, browser bundles, or any object you supply. Zero runtime dependencies, one API across Node, Bun, Deno, Workers, and the browser. Decorators, converters, and Standard Schema (zod/valibot/arktype) validation.",
   "types": "./dist/node/index.d.mts",
   "exports": {
     ".": {
@@ -146,5 +146,5 @@
     "bump": "pnpm tsx ../../scripts/bump-jsr.ts",
     "release": "pnpm run cs:publish"
   },
-  "readme": "<img src=\"https://raw.githubusercontent.com/materwelonDhruv/envapt/main/.github/assets/logo.png\" width=\"120\" align=\"left\" alt=\"envapt logo\" />\n\n<h3>envapt</h3>\n\n<p>\n  <strong>The apt way to handle environment variables.</strong><br/>\n  Read them as typed values, with zero runtime dependencies.\n</p>\n\n<p>\n  <a href=\"https://www.npmjs.com/package/envapt\"><img alt=\"npm\" src=\"https://img.shields.io/npm/v/envapt?logo=npm&logoColor=cb3838&label=%20&labelColor=103544&color=cb3838\"></a>\n  <a href=\"https://www.npmjs.com/package/envapt\"><img alt=\"downloads\" src=\"https://img.shields.io/npm/dm/envapt?style=flat&color=f7f6e8&labelColor=103544&label=downloads\"></a>\n  <a href=\"https://jsr.io/@materwelon/envapt\"><img alt=\"jsr\" src=\"https://jsr.io/badges/@materwelon/envapt\"></a>\n  <img alt=\"CI\" src=\"https://img.shields.io/github/actions/workflow/status/materwelonDhruv/envapt/checks.yml?branch=main&label=tests&style=flat&logo=github&color=3fb950&labelColor=103544\">\n  <a href=\"LICENSE\"><img alt=\"License\" src=\"https://img.shields.io/npm/l/envapt?style=flat&color=e97826&logo=apache&label=\"></a>\n</p>\n\n<br clear=\"left\"/>\n\n`process.env` always hands you a `string | undefined`. envapt returns the type you asked for, with a\nfallback that removes `undefined` from the return type. On Node, Bun, and Deno it reads `process.env`\nand your `.env` files; on Cloudflare Workers and in the browser you bind the source with\n`Envapter.useSource(...)`.\n\n```ts\nimport { Envapter } from 'envapt';\n\nconst port = Envapter.getNumber('PORT', 3000); // number, not string | undefined\n```\n\n**[Read the docs →](https://envapt.materwelon.dev)**\n\n## What you get\n\n- **Typed values.** A fallback removes `undefined` from the return type. Built-in converters cover\n  numbers, booleans, bigint, JSON, URLs, regular expressions, dates, durations, and arrays, or pass\n  your own function or a Standard Schema validator (zod, valibot, arktype).\n- **Zero runtime dependencies.** envapt ships its own `.env` parser, so nothing is added to your\n  dependency tree.\n- **Runs on Node, Bun, Deno, Cloudflare Workers, and the browser.** Node `>=20`, Bun `>=1.3`, Deno\n  `>=2.5` (ESM and CJS); the Workers and browser builds resolve through the package `exports`\n  conditions.\n- **`.env` loading on Node, Bun, and Deno.** A per-environment file cascade, `${VAR}` templates, and\n  strict / required checks. Off Node there is no filesystem, so you bind a source with\n  `Envapter.useSource(...)` and read with the same typed API.\n\n## Install\n\n```sh\nnpm install envapt\npnpm add envapt\nyarn add envapt\nbun add envapt\ndeno add jsr:@materwelon/envapt\n```\n\n## Quick start\n\nRead values functionally with `Envapter`, or bind them to class fields with the `@Envapt` decorator.\nBoth share the same parsing, converters, and cache.\n\n### Functional\n\nRead a value from any call site, in JavaScript or TypeScript. No build step. On Node the source is\nbound for you; on Workers and in the browser, call `Envapter.useSource(...)` first.\n\n```ts\nimport { Envapter, Converters } from 'envapt';\n\nconst port = Envapter.getNumber('PORT', 3000);\nconst origins = Envapter.getUsing('ALLOWED_ORIGINS', Converters.array(), []);\n```\n\nOn Cloudflare Workers, `env` is importable at module scope, so bind it once in a config module; in the\nbrowser, seed a `ManualEnvSource` from the object your bundler injects.\n\n```ts\nimport { env } from 'cloudflare:workers';\nimport { Envapter, WorkerEnvSource } from 'envapt';\n\nEnvapter.useSource(new WorkerEnvSource(env));\n\nexport const apiToken = Envapter.get('API_TOKEN');\n```\n\n### Decorator\n\nBind a value to a class field. TypeScript, with `experimentalDecorators` in your `tsconfig.json`.\n\n```ts\nimport { Envapt, Converters } from 'envapt';\n\nclass Config {\n    @Envapt('PORT', { converter: Converters.Number, fallback: 3000 })\n    declare static readonly port: number;\n}\n```\n\n## Documentation\n\nThe guide, converter reference, validation, configuration, and the v4 to v5 migration live at\n**[envapt.materwelon.dev](https://envapt.materwelon.dev)**.\n\n## Agent skill\n\nInstall the envapt agent skill so AI coding tools use the correct API:\n\n```sh\nnpx skills add materwelonDhruv/envapt\n```\n\n---\n\n<p align=\"center\"><sub>Built by <a href=\"https://github.com/materwelondhruv\">@materwelonDhruv</a> · Apache 2.0</sub></p>\n"
+  "readme": "<img src=\"https://raw.githubusercontent.com/materwelonDhruv/envapt/main/.github/assets/logo.png\" width=\"120\" align=\"left\" alt=\"envapt logo\" />\n\n<h3>envapt</h3>\n\n<p>\n  <strong>The apt way to read typed config.</strong><br/>\n  Read config from any source as real typed values, with zero runtime dependencies.\n</p>\n\n<p>\n  <a href=\"https://www.npmjs.com/package/envapt\"><img alt=\"npm\" src=\"https://img.shields.io/npm/v/envapt?logo=npm&logoColor=cb3838&label=%20&labelColor=103544&color=cb3838\"></a>\n  <a href=\"https://www.npmjs.com/package/envapt\"><img alt=\"downloads\" src=\"https://img.shields.io/npm/dm/envapt?style=flat&color=f7f6e8&labelColor=103544&label=downloads\"></a>\n  <a href=\"https://jsr.io/@materwelon/envapt\"><img alt=\"jsr\" src=\"https://jsr.io/badges/@materwelon/envapt\"></a>\n  <img alt=\"CI\" src=\"https://img.shields.io/github/actions/workflow/status/materwelonDhruv/envapt/checks.yml?branch=main&label=tests&style=flat&logo=github&color=3fb950&labelColor=103544\">\n  <a href=\"LICENSE\"><img alt=\"License\" src=\"https://img.shields.io/npm/l/envapt?style=flat&color=e97826&logo=apache&label=\"></a>\n</p>\n\n<br clear=\"left\"/>\n\nenvapt returns config as the type you asked for instead of the `string | undefined` you get raw, with\na fallback that removes `undefined` from the return type. It reads from whatever source you bind. On\nNode, Bun, and Deno that is `process.env` and your `.env` files, bound on import. On Cloudflare\nWorkers, in the browser, or for a secrets object you fetched at boot, you bind the source with\n`Envapter.useSource(...)`.\n\n```ts\nimport { Envapter } from 'envapt';\n\nconst port = Envapter.getNumber('PORT', 3000); // number, not string | undefined\n```\n\n**[Read the docs →](https://envapt.materwelon.dev)**\n\n## What you get\n\n- **Typed values.** A fallback removes `undefined` from the return type. Built-in converters cover\n  numbers, booleans, bigint, JSON, URLs, regular expressions, dates, durations, and arrays, or pass\n  your own function or a Standard Schema validator (zod, valibot, arktype).\n- **Any source.** A source is any object with a `readVars()` method, so you can bind `process.env`, a\n  Cloudflare Workers binding, a browser bundle, or a secrets payload you fetched from a store at boot.\n  On Node, Bun, and Deno one binds on import.\n- **Zero runtime dependencies.** The reader, converters, and built-in `.env` parser are self-contained,\n  so nothing is added to your dependency tree.\n- **Runs on Node, Bun, Deno, Cloudflare Workers, and the browser.** Node `>=20`, Bun `>=1.3`, Deno\n  `>=2.5` (ESM and CJS). The Workers and browser builds resolve through the package `exports`\n  conditions.\n- **`.env` loading built in on Node.** The default Node source adds a per-environment file cascade,\n  `${VAR}` templates, and strict / required checks. Off Node there is no filesystem, so you bind\n  another source with `Envapter.useSource(...)` and read with the same typed API.\n\n## Install\n\n```sh\nnpm install envapt\npnpm add envapt\nyarn add envapt\nbun add envapt\ndeno add jsr:@materwelon/envapt\n```\n\n## Quick start\n\nRead values functionally with `Envapter`, or bind them to class fields with the `@Envapt` decorator.\nBoth share the same parsing, converters, and cache.\n\n### Functional\n\nRead a value from any call site, in JavaScript or TypeScript. No build step. On Node the source is\nbound for you. On Workers and in the browser, call `Envapter.useSource(...)` first.\n\n```ts\nimport { Envapter, Converters } from 'envapt';\n\nconst port = Envapter.getNumber('PORT', 3000);\nconst origins = Envapter.getUsing('ALLOWED_ORIGINS', Converters.array(), []);\n```\n\nOn Cloudflare Workers, `env` is importable at module scope, so bind it once in a config module; in the\nbrowser, seed a `ManualEnvSource` from the object your bundler injects.\n\n```ts\nimport { env } from 'cloudflare:workers';\nimport { Envapter, WorkerEnvSource } from 'envapt';\n\nEnvapter.useSource(new WorkerEnvSource(env));\n\nexport const apiToken = Envapter.get('API_TOKEN');\n```\n\n### Decorator\n\nBind a value to a class field. TypeScript, with `experimentalDecorators` in your `tsconfig.json`.\n\n```ts\nimport { Envapt, Converters } from 'envapt';\n\nclass Config {\n    @Envapt('PORT', { converter: Converters.Number, fallback: 3000 })\n    declare static readonly port: number;\n}\n```\n\n## Documentation\n\nThe guide, converter reference, validation, configuration, and the v4 to v5 migration live at\n**[envapt.materwelon.dev](https://envapt.materwelon.dev)**.\n\n## Agent skill\n\nInstall the envapt agent skill so AI coding tools use the correct API:\n\n```sh\nnpx skills add materwelonDhruv/envapt\n```\n\n---\n\n<p align=\"center\"><sub>Built by <a href=\"https://github.com/materwelondhruv\">@materwelonDhruv</a> · Apache 2.0</sub></p>\n"
 }