@forge/lint 3.0.0-next.7 → 3.0.1-next.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/CHANGELOG.md +74 -0
  2. package/out/lint/linters/permission-linter/permission-linter.d.ts +1 -0
  3. package/out/lint/linters/permission-linter/permission-linter.d.ts.map +1 -1
  4. package/out/lint/linters/permission-linter/permission-linter.js +19 -4
  5. package/out/lint/linters/permission-linter/verifiers/product-verifier.js +5 -5
  6. package/package.json +5 -5
package/CHANGELOG.md CHANGED
@@ -1,5 +1,79 @@
1
1
  # @forge/lint
2
2
 
3
+ ## 3.0.1-next.0
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies [2c635f9]
8
+ - @forge/manifest@3.1.1-next.0
9
+ - @forge/cli-shared@2.2.2-next.0
10
+
11
+ ## 3.0.0
12
+
13
+ ### Major Changes
14
+
15
+ - 4922d09: Only errors set the process exitCode to 1, warnings do not anymore.
16
+
17
+ ### Minor Changes
18
+
19
+ - 83ca609: Adding environment variables to override production swagger with local files.
20
+ - 037c31a5: Upgrade webpack from 4 to 5 and other relavent packages to fix the issue for node17+ (openssl change)
21
+
22
+ ### Patch Changes
23
+
24
+ - ffa0050: Accept both deprecated scopes and granular scopes when verifying scopes required for Forge UI hooks.
25
+ - f5d4a63: Fix unhandled error when invalid method used for Product REST API endpoint.
26
+ - 1f7c428: Accept both deprecated scopes and granular scopes when verifying scopes required for REST product endpoints.
27
+ - 2e70a0b: Accept both granular and deprecated scopes when verifying scopes required for Content Properties.
28
+ - Updated dependencies [debe251]
29
+ - Updated dependencies [037c31a5]
30
+ - Updated dependencies [f6901fd]
31
+ - Updated dependencies [813f8f3]
32
+ - Updated dependencies [8ee1c58]
33
+ - Updated dependencies [67d2e17]
34
+ - Updated dependencies [14102be]
35
+ - Updated dependencies [7b2d17a]
36
+ - Updated dependencies [8aaa65c]
37
+ - Updated dependencies [d3ccc04]
38
+ - Updated dependencies [5152239]
39
+ - @forge/manifest@3.1.0
40
+ - @forge/cli-shared@2.2.1
41
+
42
+ ## 3.0.0-next.11
43
+
44
+ ### Patch Changes
45
+
46
+ - Updated dependencies [8aaa65c]
47
+ - @forge/manifest@3.1.0-next.9
48
+ - @forge/cli-shared@2.2.1-next.9
49
+
50
+ ## 3.0.0-next.10
51
+
52
+ ### Patch Changes
53
+
54
+ - f5d4a636: Fix unhandled error when invalid method used for Product REST API endpoint.
55
+ - Updated dependencies [67d2e17c]
56
+ - @forge/manifest@3.1.0-next.8
57
+ - @forge/cli-shared@2.2.1-next.8
58
+
59
+ ## 3.0.0-next.9
60
+
61
+ ### Minor Changes
62
+
63
+ - 037c31a: Upgrade webpack from 4 to 5 and other relavent packages to fix the issue for node17+ (openssl change)
64
+
65
+ ### Patch Changes
66
+
67
+ - Updated dependencies [037c31a]
68
+ - @forge/manifest@3.1.0-next.7
69
+ - @forge/cli-shared@2.2.1-next.7
70
+
71
+ ## 3.0.0-next.8
72
+
73
+ ### Minor Changes
74
+
75
+ - 83ca609e: Adding environment variables to override production swagger with local files.
76
+
3
77
  ## 3.0.0-next.7
4
78
 
5
79
  ### Patch Changes
package/out/lint/linters/permission-linter/permission-linter.d.ts CHANGED
@@ -32,6 +32,7 @@ export declare class PermissionLinter extends BaseLinter<ApiCall, PermissionLint
32
32
  protected getFixer(): ((errors: LintResultRule[], warnings: LintResultRule[], state: LintFixState) => Promise<LintFixState>) | undefined;
33
33
  protected addLintCriteriaMatch(apiCall: ApiCall, filepath: string): void;
34
34
  getProductPaths(cacheKey: string, url: string): Promise<SwaggerFormat>;
35
+ getProductPathsFile(url: string): Promise<SwaggerFormat>;
35
36
  private processPaths;
36
37
  }
37
38
  export {};
package/out/lint/linters/permission-linter/permission-linter.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"permission-linter.d.ts","sourceRoot":"","sources":["../../../../src/lint/linters/permission-linter/permission-linter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,IAAI,QAAQ,EAAe,MAAM,iBAAiB,CAAC;AAE/E,OAAO,UAAU,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAClF,OAAO,EACL,OAAO,EAEP,eAAe,EACf,cAAc,EACd,cAAc,EACd,aAAa,EACd,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAML,WAAW,EAGZ,MAAM,aAAa,CAAC;AASrB,UAAU,aAAa;IACrB,KAAK,EAAE;QACL,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;KAC7B,CAAC;CACH;AAED,eAAO,MAAM,mBAAmB,eAAe,CAAC;AAKhD,eAAO,MAAM,sBAAsB,WACzB,cAAc,EAAE,YACd,cAAc,EAAE,mBACT,mBAAmB,GAAG,gCAAgC,GAAG,+BAA+B,uCAExG,GAAG,CAAC,MAAM,CAkBZ,CAAC;AAEF,eAAO,MAAM,qBAAqB,WACxB,cAAc,EAAE,YACd,cAAc,EAAE,SACnB,YAAY,KAClB,OAAO,CAAC,YAAY,CAsEtB,CAAC;AAEF,UAAU,6BAA6B;IACrC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,EAAE,CAAC;IACzB,UAAU,EAAE,cAAc,EAAE,CAAC;IAC7B,IAAI,EAAE,cAAc,EAAE,CAAC;IACvB,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B;AAED,qBAAa,gBAAiB,SAAQ,UAAU,CAAC,OAAO,EAAE,6BAA6B,EAAE,OAAO,EAAE,CAAC;IAQhE,OAAO,CAAC,QAAQ;IAPjD,MAAM,CAAC,cAAc,SAAgC;IACrD,MAAM,CAAC,oBAAoB,SAAsC;IAEjE,OAAO,CAAC,IAAI,CAAC,CAA0B;IACvC,OAAO,CAAC,UAAU,CAAC,CAA0B;IAC7C,OAAO,CAAC,KAAK,CAAC,CAAa;gBAEf,WAAW,EAAE,MAAM,EAAU,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU;IAIlE,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAmCvC,SAAS,CAAC,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAajD,SAAS,CAAC,QAAQ,IACd,CAAC,CAAC,MAAM,EAAE,cAAc,EAAE,EAAE,QAAQ,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,YAAY,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC,GACtG,SAAS;IAIb,SAAS,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAsB3D,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAWnF,OAAO,CAAC,YAAY;CAarB"}
1
+ {"version":3,"file":"permission-linter.d.ts","sourceRoot":"","sources":["../../../../src/lint/linters/permission-linter/permission-linter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,IAAI,QAAQ,EAAe,MAAM,iBAAiB,CAAC;AAE/E,OAAO,UAAU,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAClF,OAAO,EACL,OAAO,EAEP,eAAe,EACf,cAAc,EACd,cAAc,EACd,aAAa,EACd,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAML,WAAW,EAGZ,MAAM,aAAa,CAAC;AAUrB,UAAU,aAAa;IACrB,KAAK,EAAE;QACL,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;KAC7B,CAAC;CACH;AAED,eAAO,MAAM,mBAAmB,eAAe,CAAC;AAKhD,eAAO,MAAM,sBAAsB,WACzB,cAAc,EAAE,YACd,cAAc,EAAE,mBACT,mBAAmB,GAAG,gCAAgC,GAAG,+BAA+B,uCAExG,GAAG,CAAC,MAAM,CAkBZ,CAAC;AAEF,eAAO,MAAM,qBAAqB,WACxB,cAAc,EAAE,YACd,cAAc,EAAE,SACnB,YAAY,KAClB,OAAO,CAAC,YAAY,CAsEtB,CAAC;AAEF,UAAU,6BAA6B;IACrC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,EAAE,CAAC;IACzB,UAAU,EAAE,cAAc,EAAE,CAAC;IAC7B,IAAI,EAAE,cAAc,EAAE,CAAC;IACvB,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B;AAED,qBAAa,gBAAiB,SAAQ,UAAU,CAAC,OAAO,EAAE,6BAA6B,EAAE,OAAO,EAAE,CAAC;IAQhE,OAAO,CAAC,QAAQ;IAPjD,MAAM,CAAC,cAAc,SAAgC;IACrD,MAAM,CAAC,oBAAoB,SAAsC;IAEjE,OAAO,CAAC,IAAI,CAAC,CAA0B;IACvC,OAAO,CAAC,UAAU,CAAC,CAA0B;IAC7C,OAAO,CAAC,KAAK,CAAC,CAAa;gBAEf,WAAW,EAAE,MAAM,EAAU,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU;IAIlE,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IA4CvC,SAAS,CAAC,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAajD,SAAS,CAAC,QAAQ,IACd,CAAC,CAAC,MAAM,EAAE,cAAc,EAAE,EAAE,QAAQ,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,YAAY,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC,GACtG,SAAS;IAIb,SAAS,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAsB3D,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAWtE,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAKrE,OAAO,CAAC,YAAY;CAarB"}
package/out/lint/linters/permission-linter/permission-linter.js CHANGED
@@ -8,6 +8,7 @@ const base_linter_1 = tslib_1.__importDefault(require("../../base-linter"));
8
8
  const api_call_interface_1 = require("./api-call-interface");
9
9
  const verifiers_1 = require("./verifiers");
10
10
  const visitors_1 = require("./visitors");
11
+ const fs_1 = tslib_1.__importDefault(require("fs"));
11
12
  exports.NON_FWD_SLASH_REGEX = '[^\\/\\s]*';
12
13
  const CACHE_KEY = 'PERMISSIONS_LINTER';
13
14
  const ONE_HOUR_MS = 1000 * 60 * 60;
@@ -81,10 +82,20 @@ class PermissionLinter extends base_linter_1.default {
81
82
  }
82
83
  async bootstrap() {
83
84
  this.cache = cli_shared_1.CachedConf.getCache(CACHE_KEY);
84
- const [jira, confluence] = await Promise.all([
85
- this.getProductPaths(PermissionLinter.JIRA_CACHE_KEY, 'https://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.json'),
86
- this.getProductPaths(PermissionLinter.CONFLUENCE_CACHE_KEY, 'https://developer.atlassian.com/cloud/confluence/swagger.v3.json')
87
- ]);
85
+ const LOCAL_CONF_SWAGGER = process.env.LOCAL_CONF_SWAGGER;
86
+ const LOCAL_JIRA_SWAGGER = process.env.LOCAL_JIRA_SWAGGER;
87
+ const USE_LOCAL_SWAGGER = process.env.USE_LOCAL_SWAGGER;
88
+ let swaggerFiles;
89
+ if (USE_LOCAL_SWAGGER && LOCAL_CONF_SWAGGER && LOCAL_JIRA_SWAGGER) {
90
+ swaggerFiles = [this.getProductPathsFile(LOCAL_JIRA_SWAGGER), this.getProductPathsFile(LOCAL_CONF_SWAGGER)];
91
+ }
92
+ else {
93
+ swaggerFiles = [
94
+ this.getProductPaths(PermissionLinter.JIRA_CACHE_KEY, 'https://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.json'),
95
+ this.getProductPaths(PermissionLinter.CONFLUENCE_CACHE_KEY, 'https://developer.atlassian.com/cloud/confluence/swagger.v3.json')
96
+ ];
97
+ }
98
+ const [jira, confluence] = await Promise.all(swaggerFiles);
88
99
  this.jira = this.processPaths(jira.paths);
89
100
  this.confluence = this.processPaths(confluence.paths);
90
101
  this.nodeVisitors = [
@@ -150,6 +161,10 @@ class PermissionLinter extends base_linter_1.default {
150
161
  }
151
162
  return cached;
152
163
  }
164
+ async getProductPathsFile(url) {
165
+ const response = fs_1.default.readFileSync(url);
166
+ return JSON.parse(response.toString());
167
+ }
153
168
  processPaths(paths) {
154
169
  const pathMap = new Map();
155
170
  Object.keys(paths).forEach((path) => {
package/out/lint/linters/permission-linter/verifiers/product-verifier.js CHANGED
@@ -73,23 +73,23 @@ class ProductVerifier extends verifier_interface_1.BaseLintIssueVerifier {
73
73
  return missingCurrentScopes;
74
74
  }
75
75
  getRequiredScopes({ regex, method }) {
76
- var _a, _b, _c;
76
+ var _a, _b, _c, _d;
77
77
  if (!regex)
78
78
  return [];
79
- const oAuth2Scopes = (_a = this.pathMap.get(regex)) === null || _a === void 0 ? void 0 : _a.methods[method]['x-atlassian-oauth2-scopes'];
79
+ const oAuth2Scopes = (_b = (_a = this.pathMap.get(regex)) === null || _a === void 0 ? void 0 : _a.methods[method]) === null || _b === void 0 ? void 0 : _b['x-atlassian-oauth2-scopes'];
80
80
  if (oAuth2Scopes) {
81
81
  return array_prototype_flatmap_1.default(oAuth2Scopes.filter((scope) => scope.state === 'Current').map((scope) => scope.scopes), (x) => x);
82
82
  }
83
- const swaggerEntries = (_c = (_b = this.pathMap.get(regex)) === null || _b === void 0 ? void 0 : _b.methods[method]) === null || _c === void 0 ? void 0 : _c.security;
83
+ const swaggerEntries = (_d = (_c = this.pathMap.get(regex)) === null || _c === void 0 ? void 0 : _c.methods[method]) === null || _d === void 0 ? void 0 : _d.security;
84
84
  if (!swaggerEntries)
85
85
  return [];
86
86
  return swaggerEntries === null || swaggerEntries === void 0 ? void 0 : swaggerEntries.reduce((prev, curr) => [...prev, ...(curr['OAuth2'] || []), ...(curr['oAuthDefinitions'] || [])], []);
87
87
  }
88
88
  getRequiredDeprecatedScopes({ regex, method }) {
89
- var _a;
89
+ var _a, _b;
90
90
  if (!regex)
91
91
  return [];
92
- const oAuth2Scopes = (_a = this.pathMap.get(regex)) === null || _a === void 0 ? void 0 : _a.methods[method]['x-atlassian-oauth2-scopes'];
92
+ const oAuth2Scopes = (_b = (_a = this.pathMap.get(regex)) === null || _a === void 0 ? void 0 : _a.methods[method]) === null || _b === void 0 ? void 0 : _b['x-atlassian-oauth2-scopes'];
93
93
  if (!oAuth2Scopes)
94
94
  return [];
95
95
  return array_prototype_flatmap_1.default(oAuth2Scopes.filter((scope) => scope.state === 'Deprecated').map((scope) => scope.scopes), (x) => x);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forge/lint",
3
- "version": "3.0.0-next.7",
3
+ "version": "3.0.1-next.0",
4
4
  "description": "Linting for forge apps",
5
5
  "main": "out/index.js",
6
6
  "license": "UNLICENSED",
@@ -11,16 +11,16 @@
11
11
  },
12
12
  "devDependencies": {
13
13
  "@types/cross-spawn": "^6.0.1",
14
- "@types/eslint": "^6.8.0",
14
+ "@types/eslint": "8.2.2",
15
15
  "@types/node-fetch": "^2.5.7"
16
16
  },
17
17
  "dependencies": {
18
- "@forge/cli-shared": "2.2.1-next.6",
18
+ "@forge/cli-shared": "2.2.2-next.0",
19
19
  "@forge/csp": "1.9.0",
20
- "@forge/manifest": "3.1.0-next.6",
20
+ "@forge/manifest": "3.1.1-next.0",
21
21
  "@typescript-eslint/typescript-estree": "^3.5.0",
22
22
  "cross-spawn": "^7.0.1",
23
- "node-fetch": "^2.6.1",
23
+ "node-fetch": "2.6.1",
24
24
  "atlassian-openapi": "^1.0.13"
25
25
  }
26
26
  }