@lacspace/env 1.0.0 → 1.0.2

package/LICENSE

@@ -1,21 +1,51 @@
-MIT License
+Lacspace Free Licence
+Version 1.0, August 2026
 
 Copyright (c) 2026 Lacspace
 
-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:
+PREAMBLE
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+This software is published by Lacspace under the Lacspace Free Licence — a free,
+permissive licence that lets you use this software for any purpose, including in
+commercial products and services, at no cost. It grants the same freedoms as
+common permissive open-source licences; the only condition is that this notice
+travels with the software. The canonical, always-current text of this licence is
+maintained at https://lacspace.com/licenses/lacspace-free-1.0
+
+GRANT OF RIGHTS
+
+Permission is hereby granted, free of charge, to any person or organisation
+obtaining a copy of this software and its associated documentation and data 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 conditions below. These rights are
+granted for any purpose, personal or commercial, and are perpetual, worldwide,
+non-exclusive, and royalty-free.
+
+CONDITIONS
+
+The above copyright notice, this permission notice, and the name of this licence
+("Lacspace Free Licence") shall be included in all copies or substantial portions
+of the Software.
+
+TRADEMARKS
+
+This licence does not grant permission to use the trade names, trademarks, service
+marks, logos, or product names of Lacspace, except as required to reproduce the
+notice above or to describe the origin of the Software in a truthful manner.
+
+DISCLAIMER OF WARRANTY AND LIMITATION OF LIABILITY
 
 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.
+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.
+
+---
+
+The Lacspace Free Licence is a source-available, permissive licence and is not (as
+of this version) an OSI-approved licence. In substance it grants the same freedoms
+as the MIT Licence. Learn more at https://lacspace.com/licenses

package/README.md

@@ -0,0 +1,91 @@
+<div align="center">
+
+# @lacspace/env
+
+**Typed, validated environment variables — fail fast at boot, not in production.**
+
+[![npm version](https://img.shields.io/npm/v/@lacspace/env?color=%230ea5e9&label=npm)](https://www.npmjs.com/package/@lacspace/env)
+[![install size](https://packagephobia.com/badge?p=@lacspace/env)](https://packagephobia.com/result?p=@lacspace/env)
+[![minzipped](https://img.shields.io/bundlephobia/minzip/@lacspace/env?label=minzip)](https://bundlephobia.com/package/@lacspace/env)
+[![types](https://img.shields.io/badge/types-included-blue)](https://www.npmjs.com/package/@lacspace/env)
+[![license](https://img.shields.io/npm/l/@lacspace/env?color=green)](https://github.com/lacspace/npm-packages/blob/main/LICENSE)
+
+</div>
+
+> Declare a schema, validate `process.env` once at startup, and get a **typed, frozen** object. Missing or malformed variables throw **one clear error listing everything wrong** — so a bad deploy fails immediately instead of 500-ing at 2am. A zero-dependency [t3-env](https://env.t3.gg) / [envalid](https://github.com/af/envalid) alternative.
+
+- 🔒 Types inferred from the schema — `env.PORT` is a `number`, guaranteed present
+- 💥 Fail-fast with an aggregated, readable error
+- 🧰 Validators: `str` · `num` · `int` · `port` · `bool` · `url` · `email` · `oneOf` · `json`
+- 🎚️ `default`, `optional`, `min`/`max` per field
+- ⚡ Zero dependencies · 🌍 isomorphic · 📦 ESM + CJS · fully typed
+
+## Install
+
+```bash
+npm install @lacspace/env      # or pnpm add / yarn add / bun add
+```
+
+## Define once, use everywhere
+
+```ts
+// env.ts
+import { createEnv, str, port, url, bool, oneOf } from "@lacspace/env";
+
+export const env = createEnv({
+  NODE_ENV: oneOf(["development", "production", "test"], { default: "development" }),
+  PORT: port({ default: 3000 }),
+  DATABASE_URL: url(),
+  SMTP_HOST: str(),
+  SMTP_PORT: port({ default: 587 }),
+  DEBUG: bool({ default: false }),
+  ADMIN_EMAILS: str({ optional: true }),
+});
+```
+
+```ts
+import { env } from "./env";
+
+env.PORT;      // number — 3000 unless set
+env.DEBUG;     // boolean
+env.NODE_ENV;  // "development" | "production" | "test"
+```
+
+If `DATABASE_URL` is missing and `SMTP_PORT` is `"abc"`, startup throws:
+
+```
+EnvError: Invalid environment variables:
+  • "DATABASE_URL" is required but was not set
+  • "SMTP_PORT" must be a number, got "abc"
+```
+
+## Validators
+
+| Validator | Parses to | Options |
+| --- | --- | --- |
+| `str(opts?)` | string | `default`, `optional`, `allowEmpty` |
+| `num` / `int` | number | `default`, `optional`, `min`, `max` |
+| `port(opts?)` | number (1–65535) | `default`, `optional` |
+| `bool(opts?)` | boolean | accepts `true/1/yes/on`, `false/0/no/off` |
+| `url` / `email` | validated string | `default`, `optional` |
+| `oneOf(values, opts?)` | union of literals | `default`, `optional` |
+| `json<T>(opts?)` | parsed JSON | `default`, `optional` |
+
+## Not just `process.env`
+
+```ts
+createEnv(schema, import.meta.env); // Vite
+createEnv(schema, Deno.env.toObject());
+```
+
+## The Lacspace WebKit
+
+| Package | For |
+| --- | --- |
+| [`@lacspace/seo`](https://www.npmjs.com/package/@lacspace/seo) | Metadata & JSON-LD |
+| **`@lacspace/env`** | Typed env variables (this package) |
+| [`@lacspace/rate-limit`](https://www.npmjs.com/package/@lacspace/rate-limit) | Rate limiting |
+| [`@lacspace/otp`](https://www.npmjs.com/package/@lacspace/otp) | TOTP/HOTP 2FA |
+| [`@lacspace/next`](https://www.npmjs.com/package/@lacspace/next) | Next.js SDK integration |
+
+<div align="center"><sub>Built with care by <a href="https://lacspace.com">Lacspace</a> · Lacspace Free Licence · <a href="https://github.com/lacspace/npm-packages">source</a></sub></div>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lacspace/env",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Typed, validated environment variables — declare a schema, validate process.env at boot, get a typed frozen object or a clear fail-fast error. A zero-dependency t3-env / envalid alternative.",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -38,7 +38,7 @@
     "typescript"
   ],
   "author": "Lacspace <contact@lacspace.com>",
-  "license": "MIT",
+  "license": "SEE LICENSE IN LICENSE",
   "homepage": "https://lacspace.com/packages",
   "repository": {
     "type": "git",