@stacksjs/env 0.59.11 → 0.61.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/env",
   "type": "module",
-  "version": "0.59.11",
+  "version": "0.61.1",
   "description": "Stacks env helper methods.",
   "author": "Chris Breuer",
   "license": "MIT",

package/src/index.ts

@@ -1,7 +1,7 @@
 import p from 'node:process'
-import fs from 'fs-extra'
 import { projectPath } from '@stacksjs/path'
 import { ValidationBoolean, ValidationEnum, ValidationNumber } from '@stacksjs/validation'
+import fs from 'fs-extra'
 import type { EnvKey } from '../../../env'
 import type { Env } from './types'
 
@@ -9,11 +9,11 @@ interface EnumObject {
   [key: string]: string[]
 }
 
-export const enums: EnumObject = {
+export const envEnum: EnumObject = {
   APP_ENV: ['local', 'dev', 'development', 'staging', 'prod', 'production'],
-  DB_CONNECTION: ['mysql', 'sqlite', 'postgres', 'planetscale'],
+  DB_CONNECTION: ['mysql', 'sqlite', 'postgres', 'dynamodb'],
   MAIL_MAILER: ['smtp', 'mailgun', 'ses', 'postmark', 'sendmail', 'log'],
-  SEARCH_ENGINE_DRIVER: ['meilisearch', 'algolia', 'typesense'],
+  SEARCH_ENGINE_DRIVER: ['opensearch'],
   FRONTEND_APP_ENV: ['development', 'staging', 'production'],
 }
 
@@ -22,31 +22,24 @@ const handler = {
     const value = target[key] as any
 
     // if value is a string but only contains numbers, and the key is not AWS_ACCOUNT_ID, return it as a number
-    if (typeof value === 'string' && /^\d+$/.test(value) && key !== 'AWS_ACCOUNT_ID')
-      return Number(value)
+    if (typeof value === 'string' && /^\d+$/.test(value) && key !== 'AWS_ACCOUNT_ID') return Number(value)
 
     // if value is a string but only contains boolean values, return it as a boolean
-    if (typeof value === 'string' && /^(true|false)$/.test(value))
-      return value === 'true'
+    if (typeof value === 'string' && /^(true|false)$/.test(value)) return value === 'true'
 
     // at some point, let's see if we can remove the need for below
-    if (value instanceof ValidationEnum)
-      return target[key] as string
+    if (value instanceof ValidationEnum) return target[key] as string
 
-    if (value instanceof ValidationBoolean)
-      return !!target[key]
+    if (value instanceof ValidationBoolean) return !!target[key]
 
-    if (value instanceof ValidationNumber)
-      return Number(target[key])
+    if (value instanceof ValidationNumber) return Number(target[key])
 
     return value as string
   },
 }
 
 export function process() {
-  return typeof Bun !== 'undefined'
-    ? Bun.env as Env
-    : p.env as unknown as Env
+  return typeof Bun !== 'undefined' ? (Bun.env as unknown as Env) : (p.env as unknown as Env)
 }
 
 export const env: Env = new Proxy(process(), handler)
@@ -59,15 +52,12 @@ export function writeEnv(key: EnvKey, value: string, options?: { path: string })
   const lines = env.split('\n')
 
   // Find the line with the variable we want to update
-  const index = lines.findIndex(line => line.startsWith(`${key}=`))
+  const index = lines.findIndex((line) => line.startsWith(`${key}=`))
 
   // If the variable exists, update it
-  if (index !== -1)
-    lines[index] = `${key}=${value}`
-
+  if (index !== -1) lines[index] = `${key}=${value}`
   // Otherwise, add a new line
-  else
-    lines.push(`${key}=${value}`)
+  else lines.push(`${key}=${value}`)
 
   // Join the lines back into a string and write it to the .env file
   fs.writeFileSync(envPath, lines.join('\n'))

package/src/types.ts

@@ -1,18 +1,24 @@
+import { log } from '@stacksjs/logging'
+import { schema } from '@stacksjs/validation'
 import type { Infer, VineBoolean, VineEnum, VineNumber, VineString } from '@stacksjs/validation'
-import { validator } from '@stacksjs/validation'
-import type { EnvKey } from '../../../env'
 import env from '~/config/env'
-
-// import type { Validate } from '@stacksjs/validation'
+import type { EnvKey } from '../../../env'
 
 // we need to get this just into right format so we can infer the type
 type EnvValue = string | boolean | number | readonly string[]
 type EnvType = typeof env
 type EnvKeys = keyof EnvType
-type EnvMap = { [K in EnvKeys]: EnvType[K] extends string ? VineString :
-  EnvType[K] extends number ? VineNumber :
-    EnvType[K] extends boolean ? VineBoolean :
-      EnvType[K] extends readonly string[] ? VineEnum<string[]> : unknown }
+type EnvMap = {
+  [K in EnvKeys]: EnvType[K] extends string
+    ? VineString
+    : EnvType[K] extends number
+      ? VineNumber
+      : EnvType[K] extends boolean
+        ? VineBoolean
+        : EnvType[K] extends readonly string[]
+          ? VineEnum<string[]>
+          : unknown
+}
 
 type ValidatorType = VineString | VineNumber | VineBoolean | VineEnum<string[]>
 
@@ -20,19 +26,56 @@ const envStructure = Object.entries(env).reduce((acc, [key, value]) => {
   let validatorType: ValidatorType
   switch (typeof value) {
     case 'string':
-      validatorType = validator.string()
+      validatorType = schema.string()
       break
     case 'number':
-      validatorType = validator.number()
+      validatorType = schema.number()
       break
     case 'boolean':
-      validatorType = validator.boolean()
+      validatorType = schema.boolean()
       break
     default:
       if (Array.isArray(value)) {
-        validatorType = validator.enum(value as string[])
+        validatorType = schema.enum(value as string[])
         break
       }
+
+      // check if is on object
+      if (typeof value === 'object') {
+        const schemaNameSymbol = Symbol.for('schema_name')
+        const schemaName = value[schemaNameSymbol]
+        log.debug('value', value)
+        log.debug('schemaName', schemaName)
+
+        if (schemaName === 'vine.string') {
+          validatorType = schema.string()
+          break
+        }
+
+        if (schemaName === 'vine.number') {
+          validatorType = schema.number()
+          break
+        }
+
+        if (schemaName === 'vine.boolean') {
+          validatorType = schema.boolean()
+          break
+        }
+
+        // if (schemaName === 'vine.enum') {
+        //   validatorType = schema.enum(value as string[])
+        //   break
+        // }
+
+        // oddly, enums don't trigger schemaName === 'vine.enum'
+        if (!schemaName) {
+          validatorType = schema.enum(value as string[])
+          break
+        }
+
+        console.error('Unknown env value type', typeof value)
+      }
+
       throw new Error(`Invalid env value for ${key}`)
   }
   const envKey = key as EnvKeys
@@ -41,7 +84,7 @@ const envStructure = Object.entries(env).reduce((acc, [key, value]) => {
   return acc
 }, {} as EnvMap)
 
-export const envSchema = validator.object(envStructure)
+export const envSchema = schema.object(envStructure)
 export type Env = Infer<typeof envSchema>
 
 export type EnvOptions = Env

package/src/utils.ts

@@ -1 +1,18 @@
-export { platform, isCI, hasTTY, hasWindow, isDebug, isMinimal, isWindows, isLinux, isMacOS, isColorSupported, providerInfo, provider, isBun, isNode, runtimeInfo, runtime } from 'std-env'
+export {
+  platform,
+  isCI,
+  hasTTY,
+  hasWindow,
+  isDebug,
+  isMinimal,
+  isWindows,
+  isLinux,
+  isMacOS,
+  isColorSupported,
+  providerInfo,
+  provider,
+  isBun,
+  isNode,
+  runtimeInfo,
+  runtime,
+} from 'std-env'

package/dist/index.d.ts

@@ -1,16 +0,0 @@
-import type { EnvKey } from '../../../env';
-import type { Env } from './types';
-interface EnumObject {
-    [key: string]: string[];
-}
-export declare const enums: EnumObject;
-export declare function process(): {
-    [x: string]: any;
-    [x: number]: any;
-    [x: symbol]: any;
-};
-export declare const env: Env;
-export declare function writeEnv(key: EnvKey, value: string, options?: {
-    path: string;
-}): void;
-export * from './types';

package/dist/types.d.ts

@@ -1,25 +0,0 @@
-import type { Infer, VineBoolean, VineEnum, VineNumber, VineString } from '@stacksjs/validation';
-import type { EnvKey } from '../../../env';
-import env from '~/config/env';
-type EnvValue = string | boolean | number | readonly string[];
-type EnvType = typeof env;
-type EnvKeys = keyof EnvType;
-type EnvMap = {
-    [K in EnvKeys]: EnvType[K] extends string ? VineString : EnvType[K] extends number ? VineNumber : EnvType[K] extends boolean ? VineBoolean : EnvType[K] extends readonly string[] ? VineEnum<string[]> : unknown;
-};
-export declare const envSchema: import("@vinejs/vine").VineObject<EnvMap, {
-    [x: string]: any;
-    [x: number]: any;
-    [x: symbol]: any;
-}, {
-    [x: string]: any;
-}>;
-export type Env = Infer<typeof envSchema>;
-export type EnvOptions = Env;
-export type EnvConfig = Partial<Record<EnvKey, EnvValue>>;
-export interface FrontendEnv {
-    FRONTEND_APP_ENV: 'local' | 'development' | 'staging' | 'production';
-    FRONTEND_APP_URL: string;
-}
-export type FrontendEnvKeys = keyof FrontendEnv;
-export {};