@stryke/types 0.1.2 → 0.2.0

package/dist/utility-types/configuration.d.ts

@@ -23,14 +23,14 @@ export type TypeDefinition = {
 export type TypeDefinitionParameter = TypeDefinition | string;
 export interface DotenvTypeDefinitions {
     /**
-     * A path to the type definition for the expected env configuration parameters. This value can include both a path to the typescript file and the name of the type definition to use separated by a `":"` or `"#"` character. For example: `"./src/types/env.ts#DotenvConfiguration"`.
+     * A path to the type definition for the expected env configuration parameters. This value can include both a path to the typescript file and the name of the type definition to use separated by a `":"` or `"#"` character. For example: `"./src/types/env.ts#Variables"`.
      *
      * @remarks
      * If a value is not provided for this option, the plugin will attempt to infer the type definition from the `storm.dotenv.types.config` object in the project's `package.json` file.
      */
     variables?: TypeDefinitionParameter;
     /**
-     * A path to the type definition for the expected env secret parameters. This value can include both a path to the typescript file and the name of the type definition to use separated by a `":"` or `"#"` character. For example: `"./src/types/env.ts#DotenvSecrets"`.
+     * A path to the type definition for the expected env secret parameters. This value can include both a path to the typescript file and the name of the type definition to use separated by a `":"` or `"#"` character. For example: `"./src/types/env.ts#Secrets"`.
      *
      * @remarks
      * If a value is not provided for this option, the plugin will attempt to infer the type definition from the `storm.dotenv.types.secrets` object in the project's `package.json` file.
@@ -51,9 +51,17 @@ export interface DotenvConfiguration {
     additionalFiles?: string[];
     /**
      * The type definitions for the environment variables
+     *
+     * @remarks
+     * This value can be a {@link DotenvTypeDefinitions} or just a path to a typescript file and the `"name"` values are defaulted to the following:
+     * - {@link DotenvTypeDefinitions.variables} - `"Variables"`
+     * - {@link DotenvTypeDefinitions.secrets} - `"Secrets"`
      */
-    types?: DotenvTypeDefinitions;
+    types?: DotenvTypeDefinitions | string;
 }
 export interface StormConfigurationGroups {
-    dotenv?: DotenvConfiguration;
+    /**
+     * The configuration for the loading variable and secrets into the environment via `.env` files
+     */
+    env?: DotenvConfiguration;
 }

package/dist/utility-types/package-json.d.ts

@@ -497,8 +497,6 @@ export interface PackageJsonStormConfiguration {
 }
 /**
  * Type for [npm's `package.json` file](https://docs.npmjs.com/creating-a-package-json-file). Also includes types for fields used by other popular projects, like TypeScript and Yarn.
- *
- * @category File
  */
 export type PackageJson = JsonObject & PackageJsonNodeJsStandard & PackageJsonStandard & PackageJsonNonStandardEntryPoints & PackageJsonTypeScriptConfiguration & PackageJsonYarnConfiguration & PackageJsonJSPMConfiguration & PackageJsonStormConfiguration;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/types",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "type": "module",
   "description": "A package containing many base TypeScript type definitions that are shared across many projects.",
   "repository": {