@forge/manifest 10.0.1-next.7 → 10.1.0-next.8

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @forge/manifest
 
+## 10.1.0-next.8
+
+### Minor Changes
+
+- 46daa27: Added support for default environment variable declaration in the manifest
+
 ## 10.0.1-next.7
 
 ### Patch Changes

package/out/interpolator/environment-variable-interpolator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"environment-variable-interpolator.d.ts","sourceRoot":"","sources":["../../src/interpolator/environment-variable-interpolator.ts"],"names":[],"mappings":"AACA,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,oBAAoB,EACpB,yBAAyB,EAC1B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAIpD,qBAAa,oCAAqC,SAAQ,yBAAyB;gBACrE,OAAO,EAAE,MAAM;CAI5B;AAKD,qBAAa,+BAAgC,YAAW,oBAAoB;IAS9D,OAAO,CAAC,QAAQ,CAAC,aAAa;IAR1C,IAAI,EAAE,gBAAgB,CAAyC;IAI/D,6BAA6B,SAAqC;IAElE,OAAO,CAAC,gBAAgB,CAAW;gBAEN,aAAa,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAM;IAInF,WAAW,CAAC,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,cAAc;IAKjE,OAAO,CAAC,0BAA0B,CAkBhC;CACH"}
+{"version":3,"file":"environment-variable-interpolator.d.ts","sourceRoot":"","sources":["../../src/interpolator/environment-variable-interpolator.ts"],"names":[],"mappings":"AACA,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,oBAAoB,EACpB,yBAAyB,EAC1B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAIpD,qBAAa,oCAAqC,SAAQ,yBAAyB;gBACrE,OAAO,EAAE,MAAM;CAI5B;AAUD,qBAAa,+BAAgC,YAAW,oBAAoB;IAS9D,OAAO,CAAC,QAAQ,CAAC,aAAa;IAR1C,IAAI,EAAE,gBAAgB,CAAyC;IAI/D,6BAA6B,SAAqC;IAElE,OAAO,CAAC,gBAAgB,CAAsB;gBAEjB,aAAa,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAM;IAInF,WAAW,CAAC,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,cAAc;IAmBjE,OAAO,CAAC,0BAA0B,CAoBhC;CACH"}

package/out/interpolator/environment-variable-interpolator.js

@@ -23,7 +23,22 @@ class EnvironmentVariableInterpolator {
         this.envVarsToReplace = [];
     }
     interpolate({ manifest }) {
-        this.envVarsToReplace = manifest.environment?.variables ?? [];
+        this.envVarsToReplace = [];
+        if (manifest.environment && manifest.environment.variables) {
+            this.envVarsToReplace = manifest.environment.variables.map((manifestEnvVar) => {
+                if (typeof manifestEnvVar === 'string') {
+                    return {
+                        key: manifestEnvVar
+                    };
+                }
+                else {
+                    return {
+                        key: manifestEnvVar.key,
+                        default: manifestEnvVar.default
+                    };
+                }
+            });
+        }
         return (0, yaml_1.parse)(JSON.stringify(manifest), this.environmentVariableReviver);
     }
     environmentVariableReviver = (_, value) => {
@@ -31,10 +46,11 @@ class EnvironmentVariableInterpolator {
             return value;
         }
         value = value.replace(this.POSSIBLE_ENVIRONMENT_VARIABLE, (original, envVarName) => {
-            if (!this.envVarsToReplace.includes(envVarName)) {
+            const envVarToReplace = this.envVarsToReplace.find((envVar) => envVar.key === envVarName);
+            if (!envVarToReplace) {
                 return original;
             }
-            const envVar = this.envVarsRecord[envVarName];
+            const envVar = this.envVarsRecord[envVarName] ?? envVarToReplace.default;
             if (envVar === undefined) {
                 throw new EnvironmentVariableInterpolatorError(text_1.errors.schema.missingEnvironmentVariable(envVarName));
             }

package/out/schema/manifest-schema.json

@@ -27676,8 +27676,16 @@
                     "title": "variables",
                     "description": "Manifest environment variables",
                     "items": {
-                        "type": "string",
-                        "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$"
+                        "oneOf": [
+                            {
+                                "$ref": "#/definitions/EnvVarString",
+                                "title": "EnvVarString"
+                            },
+                            {
+                                "$ref": "#/definitions/EnvVarObject",
+                                "title": "EnvVarObject"
+                            }
+                        ]
                     }
                 }
             }
@@ -27835,6 +27843,28 @@
                 }
             }
         },
+        "EnvVarString": {
+            "type": "string",
+            "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$",
+            "description": "An environment variable name, which can be used in the manifest"
+        },
+        "EnvVarObject": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "key", "default"
+            ],
+            "properties": {
+                "key": {
+                    "$ref": "#/definitions/EnvVarString",
+                    "description": "The name of the environment variable"
+                },
+                "default": {
+                    "type": "string",
+                    "description": "The default value of the environment variable"
+                }
+            }
+        },
         "AuthProviderPredefined": {
             "type": "object",
             "additionalProperties": false,

package/out/schema/manifest.d.ts

@@ -721,10 +721,14 @@ export type OAuth2ScopeName = string;
  * External authentication providers
  */
 export type Auth = (AuthProviderCustom | AuthProviderPredefined)[];
+/**
+ * An environment variable name, which can be used in the manifest
+ */
+export type EnvVarString = string;
 /**
  * Manifest environment variables
  */
-export type Variables = string[];
+export type Variables = (EnvVarString | EnvVarObject)[];
 export type TranslationsResources = [
   {
     key: ForgeSupportedLocaleCode;
@@ -72678,6 +72682,16 @@ export interface AuthProviderPredefined {
 export interface Environment {
   variables?: Variables;
 }
+export interface EnvVarObject {
+  /**
+   * The name of the environment variable
+   */
+  key: string;
+  /**
+   * The default value of the environment variable
+   */
+  default: string;
+}
 export interface Translations {
   resources: TranslationsResources;
   fallback: TranslationsFallback;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/manifest",
-  "version": "10.0.1-next.7",
+  "version": "10.1.0-next.8",
   "description": "Definitions and validations of the Forge manifest",
   "main": "out/index.js",
   "scripts": {