@forge/egress 1.0.1-next.0

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+# @forge/egress
+
+## 1.0.1-next.0
+### Patch Changes
+
+- 3c0ac54: Move egress related services out of @forge/csp into new @forge/egress package

package/out/egress/egress-filtering-service.d.ts

@@ -0,0 +1,11 @@
+export declare class EgressFilteringService {
+    private readonly URLs;
+    private readonly wildcardDomains;
+    private readonly allowsEverything;
+    constructor(allowList: string[]);
+    private safeURL;
+    isValidUrl(url: string): boolean;
+    private domainCheck;
+    private domainIsAllowed;
+}
+//# sourceMappingURL=egress-filtering-service.d.ts.map

package/out/egress/egress-filtering-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"egress-filtering-service.d.ts","sourceRoot":"","sources":["../../src/egress/egress-filtering-service.ts"],"names":[],"mappings":"AAGA,qBAAa,sBAAsB;IACjC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAQ;IAC7B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAQ;IACxC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAU;gBAE/B,SAAS,EAAE,MAAM,EAAE;IAY/B,OAAO,CAAC,OAAO;IAOR,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAQvC,OAAO,CAAC,WAAW;IAWnB,OAAO,CAAC,eAAe;CAWxB"}

package/out/egress/egress-filtering-service.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EgressFilteringService = void 0;
+const tslib_1 = require("tslib");
+const micromatch_1 = tslib_1.__importDefault(require("micromatch"));
+const url_1 = require("url");
+class EgressFilteringService {
+    constructor(allowList) {
+        this.URLs = allowList
+            .filter((domainOrURL) => !domainOrURL.startsWith('*'))
+            .map((url) => this.safeURL(url));
+        this.wildcardDomains = allowList
+            .filter((domainOrURL) => domainOrURL !== '*')
+            .map((url) => this.safeURL(url))
+            .filter((url) => url.hostname.startsWith('*'));
+        this.allowsEverything = allowList.includes('*');
+    }
+    safeURL(url, defaultProtocol = 'https://') {
+        const protocolRegex = /^(.*:\/\/)/;
+        return new url_1.URL(protocolRegex.test(url) ? url : `${defaultProtocol}${url}`);
+    }
+    isValidUrl(url) {
+        if (this.allowsEverything) {
+            return true;
+        }
+        return this.domainIsAllowed(this.safeURL(url));
+    }
+    domainCheck(domain, allowList) {
+        const hostnameMatchedProtocol = allowList
+            .filter((allowed) => allowed.protocol === domain.protocol)
+            .map((url) => url.hostname);
+        return (micromatch_1.default([domain.hostname], hostnameMatchedProtocol, {
+            dot: true
+        }).length > 0);
+    }
+    domainIsAllowed(domain) {
+        if (this.domainCheck(domain, this.URLs)) {
+            return true;
+        }
+        if (this.domainCheck(domain, this.wildcardDomains)) {
+            return true;
+        }
+        return false;
+    }
+}
+exports.EgressFilteringService = EgressFilteringService;

package/out/egress/index.d.ts

@@ -0,0 +1,3 @@
+export * from './egress-filtering-service';
+export * from './utils';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/egress/index.ts"],"names":[],"mappings":"AAEA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,SAAS,CAAC"}

package/out/egress/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./egress-filtering-service"), exports);
+tslib_1.__exportStar(require("./utils"), exports);

package/out/egress/utils.d.ts

@@ -0,0 +1,3 @@
+declare const sortAndGroupEgressPermissionsByDomain: (egressAddresses: string[]) => Array<string>;
+export { sortAndGroupEgressPermissionsByDomain };
+//# sourceMappingURL=utils.d.ts.map

package/out/egress/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/egress/utils.ts"],"names":[],"mappings":"AAGA,QAAA,MAAM,qCAAqC,oBAAqB,MAAM,EAAE,KAAG,KAAK,CAAC,MAAM,CA2BtF,CAAC;AAEF,OAAO,EAAE,qCAAqC,EAAE,CAAC"}

package/out/egress/utils.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sortAndGroupEgressPermissionsByDomain = void 0;
+const tslib_1 = require("tslib");
+const micromatch_1 = tslib_1.__importDefault(require("micromatch"));
+const url_1 = require("url");
+const sortAndGroupEgressPermissionsByDomain = (egressAddresses) => {
+    const protocolRegex = /^(.*?:\/\/)/;
+    const domainSet = new Set();
+    const groupSet = new Set();
+    const removeSet = new Set();
+    if ((egressAddresses === null || egressAddresses === void 0 ? void 0 : egressAddresses.length) === 0) {
+        return [];
+    }
+    egressAddresses.forEach((item) => {
+        const itemWithProtocol = protocolRegex.test(item) ? item : `https://${item}`;
+        const url = new url_1.URL(itemWithProtocol);
+        if (url.hostname.startsWith('*')) {
+            groupSet.add(url.hostname.substring(2));
+            removeSet.add('!' + url.hostname);
+        }
+        else {
+            domainSet.add(url.hostname);
+        }
+    });
+    if (removeSet.size === 0) {
+        return [...domainSet];
+    }
+    return [...new Set(micromatch_1.default([...domainSet], [...removeSet]).concat([...groupSet]))].sort();
+};
+exports.sortAndGroupEgressPermissionsByDomain = sortAndGroupEgressPermissionsByDomain;

package/out/index.d.ts

@@ -0,0 +1,2 @@
+export * from './egress';
+//# sourceMappingURL=index.d.ts.map

package/out/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC"}

package/out/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./egress"), exports);

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@forge/egress",
+  "version": "1.0.1-next.0",
+  "description": "Helpers and utils for egress implementation in Forge apps",
+  "main": "out/index.js",
+  "author": "Atlassian",
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "yarn run clean && yarn run compile",
+    "compile": "tsc -b -v",
+    "clean": "rm -rf ./out && rm -f tsconfig.tsbuildinfo"
+  },
+  "devDependencies": {
+    "@types/jest": "^26.0.0"
+  },
+  "dependencies": {
+    "micromatch": "^4.0.2"
+  }
+}