npm - @clxmedia/xperience-rights-client - Versions diffs - 1.0.8 → 1.0.10 - Mend

@clxmedia/xperience-rights-client 1.0.8 → 1.0.10

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 (5) hide show

package/dist/client.d.ts CHANGED Viewed

@@ -1,6 +1,24 @@
-import { XperienceAbility, XperienceRightsData, XperienceScopes } from '@clxmedia/types/core/auth';
+import { CLiQUserLocator, XperienceAbility, XperienceRightsData, XperienceScopes } from '@clxmedia/types/core/auth';
+export type OdooRole = {
+    id: number;
+    slug: string;
+    name: string;
+};
+export declare const ODOO_ROLES: {
+    [x: string]: OdooRole;
+};
+export declare const CLIQ_GROUPS: {
+    [x: string]: string;
+};
+export declare const CLIQ_ROLES: {
+    [x: string]: string;
+};
+export declare const FRIENDLY_SCOPE_NAMES: {
+    [key in XperienceScopes]: string;
+};
 export declare class XperienceRightsClient {
     static findAbility(data: XperienceRightsData, scope: XperienceScopes, qualifier?: number): XperienceAbility;
+    static cliqLocatorDescription(locator: CLiQUserLocator | null, long?: boolean): string | null;
     static isGroupMember(data: XperienceRightsData, group: string, qualifier?: number): boolean;
     static abilityValue(ability: XperienceAbility): number;
     static compareAbilities(a: XperienceAbility, b: XperienceAbility, comparison?: 'enough' | 'better'): boolean;

package/dist/client.js CHANGED Viewed

@@ -1,6 +1,68 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.XperienceRightsClient = void 0;
+exports.XperienceRightsClient = exports.FRIENDLY_SCOPE_NAMES = exports.CLIQ_ROLES = exports.CLIQ_GROUPS = exports.ODOO_ROLES = void 0;
+exports.ODOO_ROLES = {
+    '2-Proofing Contact': { id: 2, name: 'Proofing Contact', slug: '2-Proofing Contact' },
+    '3-Reporting Contact': { id: 3, name: 'Reporting Contact', slug: '3-Reporting Contact' },
+    '4-Billing Contact': { id: 4, name: 'Billing Contact', slug: '4-Billing Contact' },
+    '5-Marketing Contact': { id: 5, name: 'Marketing Contact', slug: '5-Marketing Contact' },
+    '8-Video Producer': { id: 8, name: 'Video Producer', slug: '8-Video Producer' },
+    '9-Regional Contact': { id: 9, name: 'Regional Contact', slug: '9-Regional Contact' },
+    '16-Accounts Payable': { id: 16, name: 'Accounts Payable', slug: '16-Accounts Payable' },
+    '17-Main': { id: 17, name: 'Main', slug: '17-Main' },
+    '18-Website Contact': { id: 18, name: 'Website Contact', slug: '18-Website Contact' },
+    '19-GTM Contact': { id: 19, name: 'GTM Contact', slug: '19-GTM Contact' },
+    '20-GA Contact': { id: 20, name: 'GA Contact', slug: '20-GA Contact' },
+    '21-GBP Contact': { id: 21, name: 'GBP Contact', slug: '21-GBP Contact' },
+    '22-FB Contact': { id: 22, name: 'FB Contact', slug: '22-FB Contact' },
+    '23-CRM Contact': { id: 23, name: 'CRM Contact', slug: '23-CRM Contact' },
+    '24-TCC/Chat Contact': { id: 24, name: 'TCC/Chat Contact', slug: '24-TCC/Chat Contact' },
+    '25-Leasing/Community Manager': { id: 25, name: 'Leasing/Community Manager', slug: '25-Leasing/Community Manager' },
+    '27-Pausing Notifications Contact': {
+        id: 27,
+        name: 'Pausing Notifications Contact',
+        slug: '27-Pausing Notifications Contact',
+    },
+    '28-BOV Contact': { id: 28, name: 'BOV Contact', slug: '28-BOV Contact' },
+    '29-Contract Signee': { id: 29, name: 'Contract Signee', slug: '29-Contract Signee' },
+    '30-Onboarding Contact': { id: 30, name: 'Onboarding Contact', slug: '30-Onboarding Contact' },
+};
+exports.CLIQ_GROUPS = {
+    ad_reviewer: 'Property Ad Reviewers',
+    company_billing: 'Property Billing Admins',
+    company_user: 'Property Users',
+    accounting: 'Conversion Logix Accounting',
+    cs_group: 'CS Group',
+    superuser: 'Superusers',
+    account_manager: 'Account Managers',
+    clx_staff: 'Conversion Logix Staff',
+    implementation_group: 'Implementation Group',
+};
+exports.CLIQ_ROLES = {
+    client_service_analyst: 'Client Service Analyst',
+    implementation_specialist: 'Implementation Specialist',
+    account_manager: 'Account Manager',
+};
+exports.FRIENDLY_SCOPE_NAMES = {
+    company: 'Property',
+    tasks: 'Tasks',
+    displayreview: 'Display Review',
+    platform: 'Platform',
+    users: 'Users',
+    forms: 'Forms',
+    gbpreview: 'GBP Review',
+    gbpa: 'GBPA',
+    insights: 'Insights',
+    mac: 'Meta',
+    macreview: 'MAC Review',
+    billing: 'Billing',
+    mediahub: 'Media Hub',
+    onboarding: 'Onboarding',
+    adrequests: 'Ad Requests',
+    dashboard: 'Dashboard',
+    videoreview: 'Video Review',
+    tcc: 'The Conversion Cloud',
+};
 class XperienceRightsClient {
     static findAbility(data, scope, qualifier) {
         if (!data || !data.rights) {
@@ -29,6 +91,28 @@ class XperienceRightsClient {
             return best;
         }, 'none');
     }
+    static cliqLocatorDescription(locator, long = false) {
+        if (!locator || !locator.type) {
+            return null;
+        }
+        if (locator.type === 'user') {
+            return locator.value;
+        }
+        if (locator.type === 'group') {
+            return `${long ? 'any user in the group: ' : ''}${exports.CLIQ_GROUPS[locator.value] || locator.value}`;
+        }
+        if (locator.type === 'role') {
+            return `${exports.CLIQ_ROLES[locator.value] || locator.value}`;
+        }
+        if (locator.type === 'right') {
+            const [scope, ability] = locator.value.split('@');
+            return long ? `any ${locator.constraint ? `${locator.constraint} ` : ''}user with the ${exports.FRIENDLY_SCOPE_NAMES[scope]} ${ability} rights` : `${exports.FRIENDLY_SCOPE_NAMES[scope]} ${ability}${locator.constraint ? ` (${locator.constraint})` : ''}`;
+        }
+        if (locator.type === 'odoo_role') {
+            return `${long ? 'any user with the Odoo role: ' : ''}${exports.ODOO_ROLES[locator.value] ? exports.ODOO_ROLES[locator.value].name : locator.value}`;
+        }
+    }
+    ;
     static isGroupMember(data, group, qualifier) {
         if (!data || !data.groups || !data.groups[group]) {
             return false;
@@ -66,46 +150,7 @@ class XperienceRightsClient {
         }, 'none');
     }
     static xperienceScopeName(scope) {
-        switch (scope) {
-            case 'company':
-                return 'Company';
-            case 'displayreview':
-                return 'Display Review';
-            case 'tasks':
-                return 'Tasks';
-            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';
-            case 'billing':
-                return 'Billing';
-            case 'adrequests':
-                return 'Ad Requests';
-            case 'videoreview':
-                return 'Video Review';
-            case 'tcc':
-                return 'The Conversion Cloud';
-            default:
-                return 'Unknown';
-        }
+        return exports.FRIENDLY_SCOPE_NAMES[scope] || 'Unknown';
     }
 }
 exports.XperienceRightsClient = XperienceRightsClient;

package/dist/index.d.ts CHANGED Viewed

	@@ -1 +1 @@
1	- export { XperienceRightsClient } from './client';
1	+ export { XperienceRightsClient, CLIQ_GROUPS, CLIQ_ROLES, FRIENDLY_SCOPE_NAMES, ODOO_ROLES, OdooRole, } from './client';

package/dist/index.js CHANGED Viewed

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

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@clxmedia/xperience-rights-client",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "CLXperience Rights Client",
   "author": "Brandon Thompson <brandont@clxmedia.com>",
   "license": "MIT",
@@ -32,7 +32,7 @@
   },
   "bugs": "https://github.com/adsupnow/xperience-library/xperience-rights-client",
   "dependencies": {
-    "@clxmedia/types": "1.0.122"
+    "@clxmedia/types": "1.0.153"
   },
   "devDependencies": {
     "@types/jest": "29.5.11",