@stacksjs/env 0.72.98 → 0.72.99

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/types.d.ts +10 -11
  2. package/package.json +3 -3
package/dist/types.d.ts CHANGED
@@ -149,7 +149,7 @@ export declare interface FrameworkEnv {
149
149
  CONNECT_INSTANCE_ALIAS: string | undefined
150
150
  PHONE_NOTIFY_EMAIL: string | undefined
151
151
  PHONE_FORWARD_NUMBER: string | undefined
152
- STORAGE_DRIVER: string | undefined
152
+ STORAGE_DRIVER: 'local' | 'public' | 's3' | undefined
153
153
  STORAGE_ROOT: string | undefined
154
154
  STORAGE_PUBLIC_URL: string | undefined
155
155
  QUEUE_DRIVER: string | undefined
@@ -258,22 +258,21 @@ export declare interface FrameworkEnv {
258
258
  /**
259
259
  * Every environment variable the application can read through `env`.
260
260
  *
261
- * Extends the framework's own set; an application adds its variables by
262
- * augmenting this interface from `config/env.ts`, which is the file that
263
- * already declares them:
261
+ * Extends the framework's own set. An application adds its variables by
262
+ * declaring them in `config/env.ts` and nothing else:
264
263
  *
265
264
  * ```ts
266
- * const envSchema = defineEnv({
265
+ * export default defineEnv({
267
266
  * STRIPE_WEBHOOK_SECRET: { validation: schema.string(), default: '' },
268
267
  * })
269
- *
270
- * declare module '@stacksjs/env' {
271
- * interface StacksEnv extends InferEnv<typeof envSchema> {}
272
- * }
273
- *
274
- * export default envSchema
275
268
  * ```
276
269
  *
270
+ * `storage/framework/types/env.d.ts` reads that schema and augments this
271
+ * interface. It cannot live in this package: a published `.d.ts` naming
272
+ * `../../../config/env` resolves to nothing under `node_modules/`. Applications
273
+ * used to write the augmentation themselves, which is boilerplate with one
274
+ * correct spelling that silently types nothing when omitted.
275
+ *
277
276
  * Nothing is generated: the types follow the schema, so they are the same on a
278
277
  * fresh clone, in CI, and in production. They used to come from a generated
279
278
  * `storage/framework/types/env.d.ts` whose key set was scraped from whichever
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@stacksjs/env",
3
3
  "type": "module",
4
4
  "sideEffects": false,
5
- "version": "0.72.98",
5
+ "version": "0.72.99",
6
6
  "description": "Stacks env helper methods.",
7
7
  "author": "Chris Breuer",
8
8
  "contributors": [
@@ -56,10 +56,10 @@
56
56
  "prepublishOnly": "bun run build"
57
57
  },
58
58
  "dependencies": {
59
- "@stacksjs/path": "0.72.98"
59
+ "@stacksjs/path": "0.72.99"
60
60
  },
61
61
  "devDependencies": {
62
62
  "better-dx": "^0.2.24",
63
- "@stacksjs/validation": "0.72.98"
63
+ "@stacksjs/validation": "0.72.99"
64
64
  }
65
65
  }