@forge/manifest 5.0.1 → 5.0.2-next.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @forge/manifest
 
+## 5.0.2-next.1
+
+### Patch Changes
+
+- ee296e3: changed validation for autoUserConsent to become deprecated
+
+## 5.0.2-next.0
+
+### Patch Changes
+
+- e06a091: Update manifest definitions
+
 ## 5.0.1
 
 ### Patch Changes

package/out/processor/full-validation-processor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"full-validation-processor.d.ts","sourceRoot":"","sources":["../../src/processor/full-validation-processor.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAIpD,qBAAa,uBAAwB,SAAQ,2BAA2B,CAAC,cAAc,CAAC;;CAqBvF"}
+{"version":3,"file":"full-validation-processor.d.ts","sourceRoot":"","sources":["../../src/processor/full-validation-processor.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAKpD,qBAAa,uBAAwB,SAAQ,2BAA2B,CAAC,cAAc,CAAC;;CAsBvF"}

package/out/processor/full-validation-processor.js

@@ -8,6 +8,7 @@ const DISPLAY_CONDITIONS_SCHEMA = tslib_1.__importStar(require("../schema/displa
 const abstract_validation_processor_1 = require("./abstract-validation-processor");
 const storage_validator_1 = require("../validators/storage-validator");
 const jql_function_validator_1 = require("../validators/jql-function-validator");
+const app_features_validator_1 = require("../validators/app-features-validator");
 class FullValidationProcessor extends abstract_validation_processor_1.AbstractValidationProcessor {
     constructor() {
         super([
@@ -26,7 +27,8 @@ class FullValidationProcessor extends abstract_validation_processor_1.AbstractVa
             new validators_1.EntityPropertyValidator(),
             new validators_1.SnapshotValidator(),
             new jql_function_validator_1.JqlFunctionValidator(),
-            new validators_1.PackageValidator()
+            new validators_1.PackageValidator(),
+            new app_features_validator_1.AppFeaturesValidator()
         ]);
     }
 }

package/out/schema/basic-manifest-schema.json

@@ -67,7 +67,7 @@
                             "type": "boolean",
                             "default": false,
                             "title": "autoUserConsent",
-                            "description": "Whether user consent should be automatic. If set to false or no value is specified for this property in the manifest, user consent will be interactive."
+                            "description": "This property is deprecated and no longer required to use simplified user consent. Please remove it from your manifest as in a future release this will become an error."
                         }
                     }
                 },

package/out/schema/basic-manifest.d.ts

@@ -26,7 +26,7 @@ export type Name = 'sandbox' | 'nodejs18.x';
  */
 export type Enabled = boolean;
 /**
- * Whether user consent should be automatic. If set to false or no value is specified for this property in the manifest, user consent will be interactive.
+ * This property is deprecated and no longer required to use simplified user consent. Please remove it from your manifest as in a future release this will become an error.
  */
 export type AutoUserConsent = boolean;
 /**

package/out/schema/manifest-schema.json

@@ -67,7 +67,7 @@
                             "type": "boolean",
                             "default": false,
                             "title": "autoUserConsent",
-                            "description": "Whether user consent should be automatic. If set to false or no value is specified for this property in the manifest, user consent will be interactive."
+                            "description": "This property is deprecated and no longer required to use simplified user consent. Please remove it from your manifest as in a future release this will become an error."
                         }
                     }
                 },
@@ -861,23 +861,31 @@
                                         ]
                                     },
                                     "config": {
-                                        "type": "object",
-                                        "properties": {
-                                            "function": {
-                                                "type": "string",
-                                                "minLength": 1,
-                                                "maxLength": 255,
-                                                "pattern": "^[a-zA-Z0-9-_]+$"
+                                        "oneOf": [
+                                            {
+                                                "type": "boolean",
+                                                "description": "Enable config for UI Kit 2"
                                             },
-                                            "render": {
-                                                "enum": [
-                                                    "native",
-                                                    "default"
-                                                ],
-                                                "type": "string",
-                                                "default": "default"
+                                            {
+                                                "type": "object",
+                                                "properties": {
+                                                    "function": {
+                                                        "type": "string",
+                                                        "minLength": 1,
+                                                        "maxLength": 255,
+                                                        "pattern": "^[a-zA-Z0-9-_]+$"
+                                                    },
+                                                    "render": {
+                                                        "enum": [
+                                                            "native",
+                                                            "default"
+                                                        ],
+                                                        "type": "string",
+                                                        "default": "default"
+                                                    }
+                                                }
                                             }
-                                        }
+                                        ]
                                     },
                                     "data": {
                                         "type": "object",

package/out/schema/manifest.d.ts

@@ -26,7 +26,7 @@ export type Name = 'sandbox' | 'nodejs18.x';
  */
 export type Enabled = boolean;
 /**
- * Whether user consent should be automatic. If set to false or no value is specified for this property in the manifest, user consent will be interactive.
+ * This property is deprecated and no longer required to use simplified user consent. Please remove it from your manifest as in a future release this will become an error.
  */
 export type AutoUserConsent = boolean;
 /**
@@ -644,11 +644,13 @@ export interface Modules {
           refDataSchema?: {
             inputType: string;
           };
-          config?: {
-            function?: string;
-            render?: 'native' | 'default';
-            [k: string]: unknown;
-          };
+          config?:
+            | boolean
+            | {
+                function?: string;
+                render?: 'native' | 'default';
+                [k: string]: unknown;
+              };
           data?: {
             function?: string;
             schema?: string;
@@ -696,11 +698,13 @@ export interface Modules {
           refDataSchema?: {
             inputType: string;
           };
-          config?: {
-            function?: string;
-            render?: 'native' | 'default';
-            [k: string]: unknown;
-          };
+          config?:
+            | boolean
+            | {
+                function?: string;
+                render?: 'native' | 'default';
+                [k: string]: unknown;
+              };
           data?: {
             function?: string;
             schema?: string;

package/out/text/errors.d.ts

@@ -120,6 +120,9 @@ export declare const errors: {
         missingAppConnectRemote: () => string;
         missingRemoteForConnect: (key: string) => string;
         missingConnectModules: () => string;
+        features: {
+            deprecatedAutoUserConsent: () => string;
+        };
         storage: {
             missingStorageInformation: () => string;
             entities: {

package/out/text/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/text/errors.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,MAAM;8BACS,MAAM,KAAG,MAAM;2BACpB,MAAM;yBAEN,MAAM,GAAG,SAAS,QAAQ,MAAM,EAAE,UAAU,MAAM,GAAG,SAAS,KAAG,MAAM;;uBAO3E,MAAM,EAAE,EAAE,GAAG,SAAS,KAAG,MAAM;4BAI1B,MAAM,EAAE,KAAG,MAAM;mCACV,MAAM,SAAS,MAAM,mBAAmB,MAAM,KAAG,MAAM;mDAIvC,MAAM,KAAG,MAAM;4BAEtC,MAAM,EAAE,GAAG,SAAS,KAAG,MAAM;;;qCAMpB,MAAM,SAAS,MAAM,KAAG,MAAM;4CAEvB,MAAM,SAAS,MAAM,KAAG,MAAM;oDAEtB,MAAM,OAAO,MAAM,KAAG,MAAM;wCAExC,MAAM,SAAS,MAAM,EAAE,KAAG,MAAM;;;uCAMjC,MAAM,KAAG,MAAM;oCACpB,MAAM;iCAEP,MAAM,KAAG,MAAM;4CACJ,MAAM,KAAG,MAAM;;;gCAG3B,MAAM,KAAG,MAAM;6BACpB,MAAM;+BACJ,MAAM;iCACF,MAAM,KAAG,MAAM;yCACP,MAAM,eAAe,MAAM,KAAG,MAAM;yCAEpC,MAAM,eAAe,MAAM,KAAG,MAAM;yCAEpC,MAAM,eAAe,MAAM,KAAG,MAAM;oCAEzC,MAAM;6CACG,MAAM,KAAG,MAAM;0EAEc,MAAM,KAAG,MAAM;4DAE7B,MAAM,KAAG,MAAM;6DAEd,MAAM,KAAG,MAAM;;yCAGrC,MAAM,KAAG,MAAM;iCAEvB,MAAM,KAAG,MAAM;4CACJ,MAAM,gBAAgB,MAAM,KAAG,MAAM;sCAE3C,MAAM,gBAAgB,MAAM,gBAAgB,MAAM,KAAG,MAAM;;;yCAIxD,MAAM,aAAa,MAAM,QAAQ,MAAM,EAAE,KAAG,MAAM;2CAIhD,MAAM,aAAa,MAAM,QAAQ,MAAM,EAAE,KAAG,MAAM;sDAEvC,MAAM,QAAQ,MAAM,EAAE,KAAG,MAAM;8DAEvB,MAAM,aAAa,MAAM,cAAc,MAAM,KAAG,MAAM;6EAEvC,MAAM,qBAAqB,MAAM,KAAG,MAAM;yEAE9C,MAAM,qBAAqB,MAAM,KAAG,MAAM;;wCAG/E,MAAM;sDACU,MAAM,KAAG,MAAM;iDAEpB,MAAM,KAAG,MAAM;2DAEL,MAAM,KAAG,MAAM;0CAEhC,MAAM,OAAO,MAAM,KAAG,MAAM;yDAEb,MAAM,KAAG,MAAM;uEAED,MAAM,KAAG,MAAM;;;;mCAKjD,MAAM,KAAG,MAAM;mCAEf,MAAM,KAAG,MAAM;;;qCAIb,MAAM,KAAG,MAAM;;;0CAIV,MAAM,KAAG,MAAM;;;4CAIb,MAAM,EAAE,KAAG,MAAM;;;mCAI1B,MAAM,EAAE,KAAG,MAAM;;;4DAIQ,MAAM,KAAG,MAAM;qCAEtC,MAAM,KAAG,MAAM;2CAET,MAAM,KAAG,MAAM;;;oCAGtB,MAAM,KAAG,MAAM;;oCAEjB,MAAM,SAAS,MAAM,KAAG,MAAM;qCAI7B,MAAM,YAAY,MAAM,KAAG,MAAM;;;;;iCAQrC,MAAM,KAAG,MAAM;;;;oDAKI,MAAM;8DACM,MAAM,qBAAqB,MAAM,KAAG,MAAM;;;wDAIhD,MAAM,KAAG,MAAM;;;;kCAKnC,MAAM,OAAO,MAAM,KAAG,MAAM;iCAE7B,MAAM,OAAO,MAAM,KAAG,MAAM;oCAEzB,MAAM,OAAO,MAAM,KAAG,MAAM;gDAEhB,MAAM,KAAG,MAAM;uCAExB,MAAM,KAAG,MAAM;+BACvB,MAAM,OAAO,MAAM,KAAG,MAAM;;;;;;;;kCASzB,MAAM,UAAU,MAAM,KAAG,MAAM;gCAEjC,MAAM,KAAG,MAAM;2CAEJ,MAAM,eAAe,MAAM,KAAG,MAAM;;;uCAI1C,MAAM;uCAEJ,MAAM,KAAG,MAAM;qCAEnB,MAAM;;6CAGA,MAAM;;4CAGP,MAAM,SAAS,MAAM,KAAG,MAAM;4CAE9B,MAAM,KAAG,MAAM;4CACf,MAAM,SAAS,MAAM,KAAG,MAAM;+CAE3B,MAAM,aAAa,MAAM,SAAS,MAAM,KAAG,MAAM;yCAEvD,MAAM,SAAS,MAAM,KAAG,MAAM;4CAE3B,MAAM,SAAS,MAAM,KAAG,MAAM;gDAE1B,MAAM,aAAa,MAAM,KAAG,MAAM;4CAEtC,MAAM,SAAS,MAAM,KAAG,MAAM;;;2CAI7B,MAAM;;;gCAInB,MAAM;;;;CAI7B,CAAC;AAEF,oBAAY,UAAU;IACpB,eAAe,2BAA2B;IAC1C,eAAe,wBAAwB;IACvC,WAAW,4BAA4B;IACvC,WAAW,+BAA+B;IAC1C,aAAa,8BAA8B;IAC3C,OAAO,0BAA0B;IACjC,cAAc,kCAAkC;IAChD,mBAAmB,0BAA0B;IAC7C,SAAS,4BAA4B;IACrC,SAAS,4BAA4B;IACrC,UAAU,wBAAwB;IAClC,GAAG,8BAA8B;IACjC,eAAe,0BAA0B;CAC1C"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/text/errors.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,MAAM;8BACS,MAAM,KAAG,MAAM;2BACpB,MAAM;yBAEN,MAAM,GAAG,SAAS,QAAQ,MAAM,EAAE,UAAU,MAAM,GAAG,SAAS,KAAG,MAAM;;uBAO3E,MAAM,EAAE,EAAE,GAAG,SAAS,KAAG,MAAM;4BAI1B,MAAM,EAAE,KAAG,MAAM;mCACV,MAAM,SAAS,MAAM,mBAAmB,MAAM,KAAG,MAAM;mDAIvC,MAAM,KAAG,MAAM;4BAEtC,MAAM,EAAE,GAAG,SAAS,KAAG,MAAM;;;qCAMpB,MAAM,SAAS,MAAM,KAAG,MAAM;4CAEvB,MAAM,SAAS,MAAM,KAAG,MAAM;oDAEtB,MAAM,OAAO,MAAM,KAAG,MAAM;wCAExC,MAAM,SAAS,MAAM,EAAE,KAAG,MAAM;;;uCAMjC,MAAM,KAAG,MAAM;oCACpB,MAAM;iCAEP,MAAM,KAAG,MAAM;4CACJ,MAAM,KAAG,MAAM;;;gCAG3B,MAAM,KAAG,MAAM;6BACpB,MAAM;+BACJ,MAAM;iCACF,MAAM,KAAG,MAAM;yCACP,MAAM,eAAe,MAAM,KAAG,MAAM;yCAEpC,MAAM,eAAe,MAAM,KAAG,MAAM;yCAEpC,MAAM,eAAe,MAAM,KAAG,MAAM;oCAEzC,MAAM;6CACG,MAAM,KAAG,MAAM;0EAEc,MAAM,KAAG,MAAM;4DAE7B,MAAM,KAAG,MAAM;6DAEd,MAAM,KAAG,MAAM;;yCAGrC,MAAM,KAAG,MAAM;iCAEvB,MAAM,KAAG,MAAM;4CACJ,MAAM,gBAAgB,MAAM,KAAG,MAAM;sCAE3C,MAAM,gBAAgB,MAAM,gBAAgB,MAAM,KAAG,MAAM;;;yCAIxD,MAAM,aAAa,MAAM,QAAQ,MAAM,EAAE,KAAG,MAAM;2CAIhD,MAAM,aAAa,MAAM,QAAQ,MAAM,EAAE,KAAG,MAAM;sDAEvC,MAAM,QAAQ,MAAM,EAAE,KAAG,MAAM;8DAEvB,MAAM,aAAa,MAAM,cAAc,MAAM,KAAG,MAAM;6EAEvC,MAAM,qBAAqB,MAAM,KAAG,MAAM;yEAE9C,MAAM,qBAAqB,MAAM,KAAG,MAAM;;wCAG/E,MAAM;sDACU,MAAM,KAAG,MAAM;iDAEpB,MAAM,KAAG,MAAM;2DAEL,MAAM,KAAG,MAAM;0CAEhC,MAAM,OAAO,MAAM,KAAG,MAAM;yDAEb,MAAM,KAAG,MAAM;uEAED,MAAM,KAAG,MAAM;;;;mCAKjD,MAAM,KAAG,MAAM;mCAEf,MAAM,KAAG,MAAM;;;qCAIb,MAAM,KAAG,MAAM;;;0CAIV,MAAM,KAAG,MAAM;;;4CAIb,MAAM,EAAE,KAAG,MAAM;;;mCAI1B,MAAM,EAAE,KAAG,MAAM;;;4DAIQ,MAAM,KAAG,MAAM;qCAEtC,MAAM,KAAG,MAAM;2CAET,MAAM,KAAG,MAAM;;;oCAGtB,MAAM,KAAG,MAAM;;oCAEjB,MAAM,SAAS,MAAM,KAAG,MAAM;qCAI7B,MAAM,YAAY,MAAM,KAAG,MAAM;;;;;iCAQrC,MAAM,KAAG,MAAM;;;;oDAKI,MAAM;8DACM,MAAM,qBAAqB,MAAM,KAAG,MAAM;;;wDAIhD,MAAM,KAAG,MAAM;;;;kCAKnC,MAAM,OAAO,MAAM,KAAG,MAAM;iCAE7B,MAAM,OAAO,MAAM,KAAG,MAAM;oCAEzB,MAAM,OAAO,MAAM,KAAG,MAAM;gDAEhB,MAAM,KAAG,MAAM;uCAExB,MAAM,KAAG,MAAM;+BACvB,MAAM,OAAO,MAAM,KAAG,MAAM;;;;;;;;kCASzB,MAAM,UAAU,MAAM,KAAG,MAAM;gCAEjC,MAAM,KAAG,MAAM;2CAEJ,MAAM,eAAe,MAAM,KAAG,MAAM;;;uCAI1C,MAAM;uCAEJ,MAAM,KAAG,MAAM;qCAEnB,MAAM;;6CAGA,MAAM;;;6CAIN,MAAM;;4CAGP,MAAM,SAAS,MAAM,KAAG,MAAM;4CAE9B,MAAM,KAAG,MAAM;4CACf,MAAM,SAAS,MAAM,KAAG,MAAM;+CAE3B,MAAM,aAAa,MAAM,SAAS,MAAM,KAAG,MAAM;yCAEvD,MAAM,SAAS,MAAM,KAAG,MAAM;4CAE3B,MAAM,SAAS,MAAM,KAAG,MAAM;gDAE1B,MAAM,aAAa,MAAM,KAAG,MAAM;4CAEtC,MAAM,SAAS,MAAM,KAAG,MAAM;;;2CAI7B,MAAM;;;gCAInB,MAAM;;;;CAI7B,CAAC;AAEF,oBAAY,UAAU;IACpB,eAAe,2BAA2B;IAC1C,eAAe,wBAAwB;IACvC,WAAW,4BAA4B;IACvC,WAAW,+BAA+B;IAC1C,aAAa,8BAA8B;IAC3C,OAAO,0BAA0B;IACjC,cAAc,kCAAkC;IAChD,mBAAmB,0BAA0B;IAC7C,SAAS,4BAA4B;IACrC,SAAS,4BAA4B;IACrC,UAAU,wBAAwB;IAClC,GAAG,8BAA8B;IACjC,eAAe,0BAA0B;CAC1C"}

package/out/text/errors.js

@@ -134,6 +134,9 @@ exports.errors = {
         missingAppConnectRemote: () => `missing app.connect.remote. app.connect.remote is required if connectModules are present.`,
         missingRemoteForConnect: (key) => `no remote found with key '${key}' matching app.connect.remote value.`,
         missingConnectModules: () => 'Missing connectModules. When app.connect.authentication is present, connectModules is required.',
+        features: {
+            deprecatedAutoUserConsent: () => 'The autoUserConsent feature flag is no longer required to use automatic user consent and should be removed from the manifest.'
+        },
         storage: {
             missingStorageInformation: () => 'Missing storage configuration. When app.storage is present, either entities or classifications is required.',
             entities: {

package/out/validators/app-features-validator.d.ts

@@ -0,0 +1,7 @@
+import { ManifestObject, ManifestValidationResult } from '../types';
+import { ManifestSchema } from '../schema/manifest';
+import { ValidatorInterface } from './validator-interface';
+export declare class AppFeaturesValidator implements ValidatorInterface<ManifestObject<ManifestSchema> | undefined, ManifestSchema> {
+    validate(manifest: ManifestObject<ManifestSchema> | undefined): Promise<ManifestValidationResult<ManifestSchema>>;
+}
+//# sourceMappingURL=app-features-validator.d.ts.map

package/out/validators/app-features-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-features-validator.d.ts","sourceRoot":"","sources":["../../src/validators/app-features-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,wBAAwB,EAAmB,MAAM,UAAU,CAAC;AACrF,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAGpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE3D,qBAAa,oBACX,YAAW,kBAAkB,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,SAAS,EAAE,cAAc,CAAC;IAEnF,QAAQ,CACZ,QAAQ,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,SAAS,GACnD,OAAO,CAAC,wBAAwB,CAAC,cAAc,CAAC,CAAC;CAmBrD"}

package/out/validators/app-features-validator.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppFeaturesValidator = void 0;
+const text_1 = require("../text");
+const utils_1 = require("../utils");
+class AppFeaturesValidator {
+    async validate(manifest) {
+        var _a, _b;
+        const app = (_a = manifest === null || manifest === void 0 ? void 0 : manifest.typedContent) === null || _a === void 0 ? void 0 : _a.app;
+        const validationErrors = [];
+        if (((_b = app === null || app === void 0 ? void 0 : app.features) === null || _b === void 0 ? void 0 : _b.autoUserConsent) !== undefined) {
+            validationErrors.push(Object.assign({ message: text_1.errors.app.features.deprecatedAutoUserConsent(), reference: text_1.References.Deprecated, level: 'warning' }, (0, utils_1.findPosition)('autoUserConsent', manifest === null || manifest === void 0 ? void 0 : manifest.yamlContentByLine)));
+        }
+        return {
+            success: validationErrors.length === 0,
+            manifestObject: manifest,
+            errors: validationErrors
+        };
+    }
+}
+exports.AppFeaturesValidator = AppFeaturesValidator;

package/package.json

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