@buoy-gg/env 1.7.2

package/lib/typescript/env/utils/helpers.d.ts

@@ -0,0 +1,70 @@
+import { RequiredEnvVar, EnvVarType } from "../types";
+/**
+ * Helper to create a required env var configuration with type checking
+ *
+ * @example
+ * const config = envVar("EXPO_PUBLIC_API_URL")
+ *   .withType("string")
+ *   .withDescription("Backend API endpoint")
+ *   .build();
+ *
+ * @example
+ * const config = envVar("EXPO_PUBLIC_DEBUG_MODE")
+ *   .withDescription("Enable debug logging")
+ *   .withType("boolean")
+ *   .build();
+ */
+declare class EnvVarBuilder {
+    private key;
+    constructor(key: string);
+    private expectedType?;
+    private expectedValue?;
+    private description?;
+    /** Just check if the variable exists */
+    exists(): RequiredEnvVar;
+    /** Check for a specific value */
+    withValue(value: string): this;
+    /** Check for a specific type */
+    withType(type: EnvVarType): this;
+    /** Add a description for documentation */
+    withDescription(desc: string): this;
+    /** Build the final configuration */
+    build(): RequiredEnvVar;
+}
+/**
+ * Fluent builder for defining expected environment variables. Helps teams author readable
+ * `requiredEnvVars` arrays by chaining type/value/description requirements while keeping the
+ * final shape compatible with `EnvVarsModal` and related helpers.
+ *
+ * @param key - Environment variable name to validate.
+ * @returns Builder with convenience methods like `.withType()` and `.withValue()`.
+ */
+export declare function envVar(key: string): EnvVarBuilder;
+/**
+ * Normalizes `requiredEnvVars` definitions while documenting intent in code. The helper simply
+ * returns the provided array, but allows teams to co-locate examples and benefit from IDE hovers.
+ *
+ * @param vars - Collection of required environment variable definitions created manually or via `envVar()`.
+ * @returns The original array, unchanged, for ergonomic chaining and inference.
+ *
+ * @example
+ * const requiredEnvVars = createEnvVarConfig([
+ *   // Simple existence check
+ *   "EXPO_PUBLIC_API_URL",
+ *
+ *   // Type checking
+ *   { key: "EXPO_PUBLIC_DEBUG_MODE", expectedType: "boolean" },
+ *
+ *   // Value checking
+ *   { key: "EXPO_PUBLIC_ENVIRONMENT", expectedValue: "development" },
+ *
+ *   // With descriptions
+ *   envVar("EXPO_PUBLIC_MAX_RETRIES")
+ *     .withType("number")
+ *     .withDescription("Maximum number of API retry attempts")
+ *     .build(),
+ * ]);
+ */
+export declare function createEnvVarConfig(vars: RequiredEnvVar[]): RequiredEnvVar[];
+export {};
+//# sourceMappingURL=helpers.d.ts.map

package/lib/typescript/env/utils/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../../src/env/utils/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtD;;;;;;;;;;;;;;GAcG;AACH,cAAM,aAAa;IACL,OAAO,CAAC,GAAG;gBAAH,GAAG,EAAE,MAAM;IAE/B,OAAO,CAAC,YAAY,CAAC,CAAa;IAClC,OAAO,CAAC,aAAa,CAAC,CAAS;IAC/B,OAAO,CAAC,WAAW,CAAC,CAAS;IAE7B,wCAAwC;IACxC,MAAM,IAAI,cAAc;IAIxB,iCAAiC;IACjC,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAM9B,gCAAgC;IAChC,QAAQ,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI;IAMhC,0CAA0C;IAC1C,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAKnC,oCAAoC;IACpC,KAAK,IAAI,cAAc;CAwBxB;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,iBAEjC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,cAAc,EAAE,GAAG,cAAc,EAAE,CAE3E"}

package/lib/typescript/env/utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./envTypeDetector";
+export * from "./helpers";
+export * from "./utils";
+//# sourceMappingURL=index.d.ts.map

package/lib/typescript/env/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/env/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC"}

package/lib/typescript/env/utils/utils.d.ts

@@ -0,0 +1,24 @@
+import { EnvVarInfo, RequiredEnvVar, EnvVarStats } from "../types";
+/**
+ * Combines the auto-detected runtime environment values with the declared `requiredEnvVars`
+ * configuration and produces categorized metadata for rendering in the UI.
+ *
+ * @param autoCollectedEnvVars - Values discovered via `useDynamicEnv` (key/value string map).
+ * @param requiredEnvVars - Optional list of required variables describing expectations to validate.
+ * @returns Required and optional variable collections annotated with validation status.
+ */
+export declare const processEnvVars: (autoCollectedEnvVars: Record<string, string>, requiredEnvVars?: RequiredEnvVar[]) => {
+    requiredVars: EnvVarInfo[];
+    optionalVars: EnvVarInfo[];
+};
+/**
+ * Derives aggregate statistics from the processed environment variable lists for health badges
+ * and summary chips in the modal UI.
+ *
+ * @param requiredVars - Processed required variables with validation state.
+ * @param optionalVars - Processed optional variables discovered at runtime.
+ * @param totalEnvVars - Raw key/value map of every detected environment variable.
+ * @returns Counts related to overall env health for display purposes.
+ */
+export declare const calculateStats: (requiredVars: EnvVarInfo[], optionalVars: EnvVarInfo[], totalEnvVars: Record<string, string>) => EnvVarStats;
+//# sourceMappingURL=utils.d.ts.map

package/lib/typescript/env/utils/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/env/utils/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAGnE;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,GACzB,sBAAsB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC5C,kBAAkB,cAAc,EAAE;;;CA8FnC,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,GACzB,cAAc,UAAU,EAAE,EAC1B,cAAc,UAAU,EAAE,EAC1B,cAAc,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KACnC,WA0BF,CAAC"}

package/lib/typescript/index.d.ts

@@ -0,0 +1,5 @@
+export { envToolPreset, createEnvTool } from "./preset";
+export { EnvVarsModal } from "./env/components/EnvVarsModal";
+export * from "./env/types";
+export * from "./env/utils";
+//# sourceMappingURL=index.d.ts.map

package/lib/typescript/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGxD,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAG7D,cAAc,aAAa,CAAC;AAG5B,cAAc,aAAa,CAAC"}

package/lib/typescript/preset.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Pre-configured environment variables tool for FloatingDevTools
+ *
+ * This preset provides a zero-config way to add env var inspection to your dev tools.
+ * Just import and add it to your apps array!
+ *
+ * @example
+ * ```tsx
+ * import { envToolPreset } from '@buoy-gg/env';
+ *
+ * const installedApps = [
+ *   envToolPreset, // That's it!
+ *   // ...other tools
+ * ];
+ * ```
+ */
+import { EnvVarsModal } from "./env/components/EnvVarsModal";
+import type { RequiredEnvVar } from "./env/types";
+/**
+ * Pre-configured environment variables tool for FloatingDevTools.
+ * Includes:
+ * - Automatic env var discovery
+ * - Required variable validation
+ * - Search and filtering
+ * - Copy functionality
+ */
+export declare const envToolPreset: {
+    id: string;
+    name: string;
+    description: string;
+    slot: "both";
+    icon: ({ size }: {
+        size: number;
+    }) => import("react").JSX.Element;
+    component: typeof EnvVarsModal;
+    props: {
+        requiredEnvVars: RequiredEnvVar[];
+        enableSharedModalDimensions: boolean;
+    };
+};
+/**
+ * Create a custom environment variables tool configuration.
+ * Use this if you want to override default settings or provide required env vars.
+ *
+ * @example
+ * ```tsx
+ * import { createEnvTool, envVar, createEnvVarConfig } from '@buoy-gg/env';
+ *
+ * const requiredEnvVars = createEnvVarConfig([
+ *   envVar("EXPO_PUBLIC_API_URL").exists(),
+ *   envVar("EXPO_PUBLIC_DEBUG_MODE").withType("boolean").build(),
+ * ]);
+ *
+ * const myEnvTool = createEnvTool({
+ *   requiredEnvVars,
+ *   colorPreset: "cyan",
+ *   enableSharedModalDimensions: true,
+ * });
+ * ```
+ */
+export declare function createEnvTool(options?: {
+    /** Tool name (default: "ENV") */
+    name?: string;
+    /** Tool description */
+    description?: string;
+    /** Custom tool ID (default: "env") */
+    id?: string;
+    /** Array of required environment variables to validate */
+    requiredEnvVars?: RequiredEnvVar[];
+    /** Enable shared modal dimensions */
+    enableSharedModalDimensions?: boolean;
+}): {
+    id: string;
+    name: string;
+    description: string;
+    slot: "both";
+    icon: ({ size }: {
+        size: number;
+    }) => import("react").JSX.Element;
+    component: typeof EnvVarsModal;
+    props: {
+        requiredEnvVars: RequiredEnvVar[];
+        enableSharedModalDimensions: boolean;
+    };
+};
+//# sourceMappingURL=preset.d.ts.map

package/lib/typescript/preset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"preset.d.ts","sourceRoot":"","sources":["../../src/preset.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa;;;;;qBAKP;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;;;yBAGR,cAAc,EAAE;;;CAG1C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,aAAa,CAAC,OAAO,CAAC,EAAE;IACtC,iCAAiC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sCAAsC;IACtC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,0DAA0D;IAC1D,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC,qCAAqC;IACrC,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACvC;;;;;qBAOoB;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;;;;;;EASpC"}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@buoy-gg/env",
+  "version": "1.7.2",
+  "description": "Environment variables dev tooling",
+  "main": "lib/commonjs/index.js",
+  "module": "lib/module/index.js",
+  "types": "lib/typescript/index.d.ts",
+  "react-native": "src/index.tsx",
+  "source": "src/index.tsx",
+  "files": [
+    "lib"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "bob build",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "bob build",
+    "clean": "rimraf lib",
+    "test": "pnpm run typecheck"
+  },
+  "dependencies": {
+    "@buoy-gg/floating-tools-core": "workspace:*",
+    "@buoy-gg/shared-ui": "workspace:*"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "commonjs",
+        {
+          "sourceMaps": false
+        }
+      ],
+      [
+        "module",
+        {
+          "sourceMaps": false
+        }
+      ],
+      "typescript"
+    ]
+  },
+  "devDependencies": {
+    "@types/react": "^19.1.0",
+    "@types/react-native": "^0.73.0",
+    "typescript": "~5.8.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/LovesWorking/react-native-buoy.git",
+    "directory": "packages/env-tools"
+  },
+  "bugs": {
+    "url": "https://github.com/LovesWorking/react-native-buoy/issues"
+  },
+  "homepage": "https://github.com/LovesWorking/react-native-buoy/tree/main/packages/env-tools#readme",
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  }
+}