@forge/manifest 11.0.0-next.0 → 11.0.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @forge/manifest
 
+## 11.0.0-next.2
+
+### Major Changes
+
+- 260eb24: Adding support for new module fifoConsumer
+
+## 11.0.0-next.1
+
+### Minor Changes
+
+- 9a6d346: Add standalone trigger scope validation API (only event name and scopes required)
+
 ## 11.0.0-next.0
 
 ### Major Changes

package/README.md

@@ -17,6 +17,28 @@ const results = ProcessorBuilder.instance()
 console.log(`Valid manifest ? ${results.success}`);
 ```
 
+## Simple Trigger Scopes Validation
+
+For validating trigger event scopes, use the simple validation API that only requires the event name and scopes:
+
+```typescript
+import { validateTriggerScopes } from '@forge/manifest';
+
+// Simple: just pass event and scopes
+const result = await validateTriggerScopes(
+  'avi:jira:assigned:issue',
+  ['read:jira-work']
+);
+
+if (!result.valid) {
+  console.error(`Missing scopes: ${result.missingScopes.join(', ')}`);
+}
+```
+
+This is useful for:
+- External tools that need to verify scope requirements
+- Any service that validates event-scope mappings
+
 ## How to check the errors
 
 In case of an invalid `manifest.yml`, the following information will be populated:

package/out/types/validation-types.d.ts

@@ -1,3 +1,4 @@
+import { RequiredScopes } from '../scopes';
 export declare enum ValidationTypes {
     BASIC = "basic",
     FULL = "full",
@@ -6,4 +7,10 @@ export declare enum ValidationTypes {
     FORGE_REMOTE_COMPUTE = "forge-remote-compute",
     DEPRECATED_EGRESS_PERMISSIONS = "deprecated-egress-permissions"
 }
+export interface TriggerScopeValidationResult {
+    valid: boolean;
+    event: string;
+    missingScopes: string[];
+    requiredScopes: RequiredScopes | null;
+}
 //# sourceMappingURL=validation-types.d.ts.map

package/out/types/validation-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validation-types.d.ts","sourceRoot":"","sources":["../../src/types/validation-types.ts"],"names":[],"mappings":"AAAA,oBAAY,eAAe;IACzB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,eAAe,oBAAoB;IACnC,qBAAqB,0BAA0B;IAC/C,oBAAoB,yBAAyB;IAC7C,6BAA6B,kCAAkC;CAChE"}
+{"version":3,"file":"validation-types.d.ts","sourceRoot":"","sources":["../../src/types/validation-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAE3C,oBAAY,eAAe;IACzB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,eAAe,oBAAoB;IACnC,qBAAqB,0BAA0B;IAC/C,oBAAoB,yBAAyB;IAC7C,6BAA6B,kCAAkC;CAChE;AAKD,MAAM,WAAW,4BAA4B;IAC3C,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,cAAc,EAAE,cAAc,GAAG,IAAI,CAAC;CACvC"}

package/out/validators/index.d.ts

@@ -7,6 +7,7 @@ export * from './validator-interface';
 export * from './resources-validator';
 export * from './display-conditions-validator';
 export * from './product-trigger-scopes-validator';
+export * from './simple-trigger-scope-validator';
 export * from './providers-validator';
 export * from './permissions-validator';
 export * from './connect-remote-validator';

package/out/validators/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/validators/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC;AACnD,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oCAAoC,CAAC;AACnD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/validators/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oCAAoC,CAAC;AACnD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC"}

package/out/validators/index.js

@@ -10,6 +10,7 @@ tslib_1.__exportStar(require("./validator-interface"), exports);
 tslib_1.__exportStar(require("./resources-validator"), exports);
 tslib_1.__exportStar(require("./display-conditions-validator"), exports);
 tslib_1.__exportStar(require("./product-trigger-scopes-validator"), exports);
+tslib_1.__exportStar(require("./simple-trigger-scope-validator"), exports);
 tslib_1.__exportStar(require("./providers-validator"), exports);
 tslib_1.__exportStar(require("./permissions-validator"), exports);
 tslib_1.__exportStar(require("./connect-remote-validator"), exports);

package/out/validators/product-trigger-scopes-validator.d.ts

@@ -1,6 +1,6 @@
 import { ManifestObject, ManifestValidationResult } from '../types';
 import { ValidatorInterface } from './validator-interface';
-import { ManifestSchema } from '../schema/manifest';
+import { ManifestSchema, Scopes } from '../schema/manifest';
 import { RequiredScopes } from '../scopes';
 export interface MappingEntry {
     productEvent: string;
@@ -9,6 +9,10 @@ export interface MappingEntry {
 export interface MappingConfig {
     mapping: MappingEntry[];
 }
+export declare function validateEventScopes(event: string, scopes: Scopes | undefined, config: MappingConfig): Promise<{
+    requiredScopes: RequiredScopes;
+    missingScopes: string[];
+}>;
 export declare class ProductTriggerScopesValidator<T> implements ValidatorInterface<ManifestObject<ManifestSchema> | undefined, ManifestSchema> {
     private readonly config;
     constructor(config: MappingConfig);

package/out/validators/product-trigger-scopes-validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"product-trigger-scopes-validator.d.ts","sourceRoot":"","sources":["../../src/validators/product-trigger-scopes-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,wBAAwB,EAAmB,MAAM,UAAU,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAGpD,OAAO,EAAoB,cAAc,EAAE,MAAM,WAAW,CAAC;AAE7D,MAAM,WAAW,YAAY;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,cAAc,CAAC;CAC7B;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,YAAY,EAAE,CAAC;CACzB;AAED,qBAAa,6BAA6B,CAAC,CAAC,CAC1C,YAAW,kBAAkB,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,SAAS,EAAE,cAAc,CAAC;IAE7E,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,aAAa;IAE5C,QAAQ,CACZ,QAAQ,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,SAAS,GACnD,OAAO,CAAC,wBAAwB,CAAC,cAAc,CAAC,CAAC;CAoDrD"}
+{"version":3,"file":"product-trigger-scopes-validator.d.ts","sourceRoot":"","sources":["../../src/validators/product-trigger-scopes-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,wBAAwB,EAAmB,MAAM,UAAU,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAG5D,OAAO,EAAoB,cAAc,EAAE,MAAM,WAAW,CAAC;AAE7D,MAAM,WAAW,YAAY;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,cAAc,CAAC;CAC7B;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,YAAY,EAAE,CAAC;CACzB;AAcD,wBAAsB,mBAAmB,CACvC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,MAAM,EAAE,aAAa,GACpB,OAAO,CAAC;IAAE,cAAc,EAAE,cAAc,CAAC;IAAC,aAAa,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC,CAStE;AAED,qBAAa,6BAA6B,CAAC,CAAC,CAC1C,YAAW,kBAAkB,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,SAAS,EAAE,cAAc,CAAC;IAE7E,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,aAAa;IAE5C,QAAQ,CACZ,QAAQ,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,SAAS,GACnD,OAAO,CAAC,wBAAwB,CAAC,cAAc,CAAC,CAAC;CA6CrD"}

package/out/validators/product-trigger-scopes-validator.js

@@ -1,9 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProductTriggerScopesValidator = void 0;
+exports.ProductTriggerScopesValidator = exports.validateEventScopes = void 0;
 const text_1 = require("../text");
 const utils_1 = require("../utils");
 const scopes_1 = require("../scopes");
+async function validateEventScopes(event, scopes, config) {
+    const emptyRequiredScopes = { current: [] };
+    const requiredScopes = config.mapping.find((entry) => entry.productEvent === event)?.oAuthScopes || emptyRequiredScopes;
+    const missingScopes = await (0, scopes_1.getMissingScopes)(scopes, requiredScopes);
+    return { requiredScopes, missingScopes };
+}
+exports.validateEventScopes = validateEventScopes;
 class ProductTriggerScopesValidator {
     config;
     constructor(config) {
@@ -17,10 +24,6 @@ class ProductTriggerScopesValidator {
             };
         }
         const validationErrors = [];
-        const getRequiredScopes = (productEvent) => {
-            const emptyRequiredScopes = { current: [] };
-            return (this.config.mapping.find((value) => value.productEvent == productEvent)?.oAuthScopes || emptyRequiredScopes);
-        };
         const addValidationError = (scope, event) => {
             validationErrors.push({
                 message: text_1.errors.permissions.missingPermissionFromScope(scope, event),
@@ -41,8 +44,7 @@ class ProductTriggerScopesValidator {
         const manifestScopes = manifest.typedContent.permissions?.scopes || [];
         for (const element of manifest.typedContent.modules.trigger) {
             for (const event of element.events) {
-                const requiredScopes = getRequiredScopes(event);
-                const missingScopes = await (0, scopes_1.getMissingScopes)(manifestScopes, requiredScopes);
+                const { missingScopes } = await validateEventScopes(event, manifestScopes, this.config);
                 missingScopes.forEach((scope) => addValidationError(scope, event));
             }
         }

package/out/validators/simple-trigger-scope-validator.d.ts

@@ -0,0 +1,3 @@
+import { TriggerScopeValidationResult } from '../types/validation-types';
+export declare function validateTriggerScopes(event: string, scopes: string[]): Promise<TriggerScopeValidationResult>;
+//# sourceMappingURL=simple-trigger-scope-validator.d.ts.map

package/out/validators/simple-trigger-scope-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-trigger-scope-validator.d.ts","sourceRoot":"","sources":["../../src/validators/simple-trigger-scope-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,2BAA2B,CAAC;AA4BzE,wBAAsB,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAgBlH"}

package/out/validators/simple-trigger-scope-validator.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateTriggerScopes = void 0;
+const tslib_1 = require("tslib");
+const product_trigger_scopes_validator_1 = require("./product-trigger-scopes-validator");
+const EVENT_SCOPE_MAPPING = tslib_1.__importStar(require("../mapping/product-event-to-scope-mapping.json"));
+async function validateTriggerScopes(event, scopes) {
+    const { requiredScopes, missingScopes } = await (0, product_trigger_scopes_validator_1.validateEventScopes)(event, scopes, EVENT_SCOPE_MAPPING);
+    const hasRequirements = requiredScopes.current.length > 0;
+    return {
+        valid: missingScopes.length === 0,
+        event,
+        missingScopes,
+        requiredScopes: hasRequirements ? requiredScopes : null
+    };
+}
+exports.validateTriggerScopes = validateTriggerScopes;

package/package.json

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