@clxmedia/xperience-rights-client 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 John Biundo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,19 @@
+<h1 align="center"></h1>
+
+<h3 align="center">CLXperience Rights Client</h3>
+
+## Usage
+
+Helper class for Xperience apps that use XperienceRightsData.
+
+## Change Log
+
+See [Changelog](CHANGELOG.md) for more information.
+
+## Author
+
+**Brandon Thompson**
+
+## License
+
+Licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/dist/client.d.ts

@@ -0,0 +1,8 @@
+import { XperienceAbility, XperienceRightsData, XperienceScopes } from '@clxmedia/types/core/auth';
+export declare class XperienceRightsClient {
+    static findAbility(data: XperienceRightsData, scope: XperienceScopes, qualifier?: number): XperienceAbility;
+    static abilityValue(ability: XperienceAbility): number;
+    static compareAbilities(a: XperienceAbility, b: XperienceAbility, comparison?: 'enough' | 'better'): boolean;
+    static bestAbility(...abilities: XperienceAbility[]): XperienceAbility;
+    static xperienceScopeName(scope: XperienceScopes): string;
+}

package/dist/client.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XperienceRightsClient = void 0;
+class XperienceRightsClient {
+    static findAbility(data, scope, qualifier) {
+        if (!data || !data.rights) {
+            return 'none';
+        }
+        const abilities = data.rights[scope];
+        if (!abilities) {
+            return 'none';
+        }
+        if (!qualifier) {
+            qualifier = 0;
+        }
+        const settingsIncludeQualifier = (settings, qualifier) => {
+            if (!qualifier) {
+                qualifier = 0;
+            }
+            if ([0, qualifier].some((q) => settings.qualifiers.includes(q))) {
+                return true;
+            }
+            return settings.common && data.commonQualifiers.includes(qualifier);
+        };
+        return Object.entries(abilities).reduce((best, [ability, settings]) => {
+            if (settingsIncludeQualifier(settings, qualifier)) {
+                return XperienceRightsClient.bestAbility(ability, best);
+            }
+            return best;
+        }, 'none');
+    }
+    static abilityValue(ability) {
+        switch (ability) {
+            case 'none':
+                return 0;
+            case 'view':
+                return 1;
+            case 'edit':
+                return 2;
+            case 'admin':
+                return 3;
+            default:
+                return 0;
+        }
+    }
+    static compareAbilities(a, b, comparison = 'enough') {
+        const aValue = XperienceRightsClient.abilityValue(a);
+        const bValue = XperienceRightsClient.abilityValue(b);
+        if (comparison === 'enough') {
+            return aValue >= bValue;
+        }
+        return aValue > bValue;
+    }
+    static bestAbility(...abilities) {
+        return abilities.reduce((best, current) => {
+            return XperienceRightsClient.compareAbilities(current, best, 'better') ? current : best;
+        }, 'none');
+    }
+    static xperienceScopeName(scope) {
+        switch (scope) {
+            case 'company':
+                return 'Company';
+            case 'displayreview':
+                return 'Display Review';
+            case 'platform':
+                return 'Xperience Platform';
+            case 'users':
+                return 'Users';
+            case 'forms':
+                return 'Forms';
+            case 'gbpreview':
+                return 'GBP Review';
+            case 'gbpa':
+                return 'GBPA';
+            case 'insights':
+                return 'Insights';
+            case 'mac':
+                return 'MAC';
+            case 'macreview':
+                return 'MAC Review';
+            case 'mediahub':
+                return 'Media Hub';
+            case 'onboarding':
+                return 'Onboarding';
+            case 'dashboard':
+                return 'Dashboard';
+            default:
+                return 'Unknown';
+        }
+    }
+}
+exports.XperienceRightsClient = XperienceRightsClient;

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { XperienceRightsClient } from './client';

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XperienceRightsClient = void 0;
+var client_1 = require("./client");
+Object.defineProperty(exports, "XperienceRightsClient", { enumerable: true, get: function () { return client_1.XperienceRightsClient; } });

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@clxmedia/xperience-rights-client",
+  "version": "1.0.0",
+  "description": "CLXperience Rights Client",
+  "author": "Brandon Thompson <brandont@clxmedia.com>",
+  "license": "MIT",
+  "readmeFilename": "README.md",
+  "main": "dist/client.js",
+  "typings": "dist/client.d.ts",
+  "packageManager": "yarn@1.22.18",
+  "files": [
+    "dist/**/*",
+    "*.md"
+  ],
+  "scripts": {
+    "start:dev": "tsc -w",
+    "build": "tsc",
+    "prepare": "npm run build",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "tslint -p tsconfig.json -c tslint.json",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:e2e": "jest --config ./test/jest-e2e.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/adsupnow/xperience-library/xperience-rights-client"
+  },
+  "bugs": "https://github.com/adsupnow/xperience-library/xperience-rights-client",
+  "dependencies": {
+    "@clxmedia/types": "1.0.52"
+  },
+  "devDependencies": {
+    "@types/jest": "29.5.11",
+    "@types/js-yaml": "4.0.9",
+    "@types/node": "^20.10",
+    "@types/supertest": "2.0.16",
+    "jest": "29.7.0",
+    "prettier": "3.1.0",
+    "rxjs": "7.8.1",
+    "supertest": "6.3.3",
+    "ts-jest": "29.1.1",
+    "ts-node": "10.9.2",
+    "tsc-watch": "6.0.4",
+    "tsconfig-paths": "4.2.0",
+    "tslint": "6.1.3",
+    "typescript": "5.3.3"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".spec.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}