chore: add @dotenvx/dotenvx TS declaration file

getlarge · Jun 25, 2024 · a448b55 · a448b55
1 parent 876e639
commit a448b55
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 2 deletions.
diff --git a/libs/ory-config-generators/src/lib/ory-config-generators.ts b/libs/ory-config-generators/src/lib/ory-config-generators.ts
@@ -1,4 +1,3 @@
-// @ts-expect-error - Type definitions for the @dotenvx/dotenvx package are not available.
 import * as dotenvX from '@dotenvx/dotenvx';
 import type { ClassConstructor } from 'class-transformer';
 import { dump, load } from 'js-yaml';

diff --git a/tsconfig.base.json b/tsconfig.base.json
@@ -29,7 +29,14 @@
       "@cat-fostering/ory-config-generators": [
         "libs/ory-config-generators/src/index.ts"
       ]
-    }
+    },
+    "typeRoots": [
+      "node_modules/@types",
+      "types"
+    ],
+    "types": [
+      "@dotenvx/dotenvx"
+    ],
   },
   "exclude": ["node_modules", "tmp"]
 }
diff --git a/types/@dotenvx/dotenvx/index.d.ts b/types/@dotenvx/dotenvx/index.d.ts
@@ -0,0 +1,17 @@
+declare module '@dotenvx/dotenvx' {
+  type DotenvxConfig = {
+    DOTENV_KEY?: string;
+    overload?: boolean;
+    override?: boolean;
+    convention?: boolean;
+    path?: string;
+    processEnv?: Record<string, string>;
+  };
+
+  type DotenvxResult = {
+    parsed: Record<string, string>;
+    error?: Error & { message?: string; code?: string; help?: string };
+  };
+
+  export function config(options?: DotenvxConfig): DotenvxResult;
+}