@clxmedia/xperience-rights-client 1.1.9 → 1.1.11

package/dist/client.d.ts

@@ -1,5 +1,5 @@
-import { CLiQUserLocator, XperienceAbility, XperienceRightsData, XperienceScopes } from '@clxmedia/types/core/auth';
-import { FeatureFlagStrategyDefinition } from '@clxmedia/types/core/features';
+import { CLiQUserLocator, XperienceAbility, XperienceRightsData, XperienceScopes } from "@clxmedia/types/core/auth";
+import { FeatureFlagStrategyDefinition } from "@clxmedia/types/core/features";
 export type OdooRole = {
     id: number;
     slug: string;
@@ -23,7 +23,7 @@ export declare class XperienceRightsClient {
     static featureFlagEnabled(data: XperienceRightsData, strategies: FeatureFlagStrategyDefinition[], qualifier?: number): boolean;
     static isGroupMember(data: XperienceRightsData, group: string, qualifier?: number): boolean;
     static abilityValue(ability: XperienceAbility): number;
-    static compareAbilities(a: XperienceAbility, b: XperienceAbility, comparison?: 'enough' | 'better'): boolean;
+    static compareAbilities(a: XperienceAbility, b: XperienceAbility, comparison?: "enough" | "better"): boolean;
     static bestAbility(...abilities: XperienceAbility[]): XperienceAbility;
     static xperienceScopeName(scope: XperienceScopes): string;
 }

package/dist/client.js

@@ -4,109 +4,114 @@ exports.XperienceRightsClient = exports.FRIENDLY_SCOPE_NAMES = exports.CLIQ_ROLE
 exports.ODOO_ROLES = {
     proofing_contact: {
         id: 2,
-        name: 'Proofing Contact',
-        slug: 'proofing_contact',
+        name: "Proofing Contact",
+        slug: "proofing_contact",
     },
     reporting_contact: {
         id: 3,
-        name: 'Reporting Contact',
-        slug: 'reporting_contact',
+        name: "Reporting Contact",
+        slug: "reporting_contact",
     },
-    billing_contact: { id: 4, name: 'Billing Contact', slug: 'billing_contact' },
+    billing_contact: { id: 4, name: "Billing Contact", slug: "billing_contact" },
     marketing_contact: {
         id: 5,
-        name: 'Marketing Contact',
-        slug: 'marketing_contact',
+        name: "Marketing Contact",
+        slug: "marketing_contact",
     },
-    video_producer: { id: 8, name: 'Video Producer', slug: 'video_producer' },
+    video_producer: { id: 8, name: "Video Producer", slug: "video_producer" },
     regional_contact: {
         id: 9,
-        name: 'Regional Contact',
-        slug: 'regional_contact',
+        name: "Regional Contact",
+        slug: "regional_contact",
     },
     accounts_payable: {
         id: 16,
-        name: 'Accounts Payable',
-        slug: 'accounts_payable',
+        name: "Accounts Payable",
+        slug: "accounts_payable",
     },
-    main: { id: 17, name: 'Main', slug: 'main' },
-    website_contact: { id: 18, name: 'Website Contact', slug: 'website_contact' },
-    gtm_contact: { id: 19, name: 'GTM Contact', slug: 'gtm_contact' },
-    ga_contact: { id: 20, name: 'GA Contact', slug: 'ga_contact' },
-    gbp_contact: { id: 21, name: 'GBP Contact', slug: 'gbp_contact' },
-    fb_contact: { id: 22, name: 'FB Contact', slug: 'fb_contact' },
-    crm_contact: { id: 23, name: 'CRM Contact', slug: 'crm_contact' },
+    main: { id: 17, name: "Main", slug: "main" },
+    website_contact: { id: 18, name: "Website Contact", slug: "website_contact" },
+    gtm_contact: { id: 19, name: "GTM Contact", slug: "gtm_contact" },
+    ga_contact: { id: 20, name: "GA Contact", slug: "ga_contact" },
+    gbp_contact: { id: 21, name: "GBP Contact", slug: "gbp_contact" },
+    fb_contact: { id: 22, name: "FB Contact", slug: "fb_contact" },
+    crm_contact: { id: 23, name: "CRM Contact", slug: "crm_contact" },
     tcc_chat_contact: {
         id: 24,
-        name: 'TCC/Chat Contact',
-        slug: 'tcc_chat_contact',
+        name: "TCC/Chat Contact",
+        slug: "tcc_chat_contact",
     },
     leasing_community_manager: {
         id: 25,
-        name: 'Leasing/Community Manager',
-        slug: 'leasing_community_manager',
+        name: "Leasing/Community Manager",
+        slug: "leasing_community_manager",
     },
     pausing_notifications_contact: {
         id: 27,
-        name: 'Pausing Notifications Contact',
-        slug: 'pausing_notifications_contact',
+        name: "Pausing Notifications Contact",
+        slug: "pausing_notifications_contact",
     },
-    bov_contact: { id: 28, name: 'BOV Contact', slug: 'bov_contact' },
-    contract_signee: { id: 29, name: 'Contract Signee', slug: 'contract_signee' },
+    bov_contact: { id: 28, name: "BOV Contact", slug: "bov_contact" },
+    contract_signee: { id: 29, name: "Contract Signee", slug: "contract_signee" },
     onboarding_contact: {
         id: 30,
-        name: 'Onboarding Contact',
-        slug: 'onboarding_contact',
+        name: "Onboarding Contact",
+        slug: "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',
+    account_manager: "Account Managers",
+    accounting: "Conversion Logix Accounting",
+    ad_reviewer: "Client Ad Approvers",
+    ad_viewer: "Client Ad Viewer",
+    clx_staff: "Conversion Logix Staff",
+    company_billing: "Property Billing Admins",
+    company_user: "Property Users",
+    cs_group: "CS Group",
+    design: "Design",
+    engineering: "Engineering",
+    implementation_group: "Implementation Group",
+    notifications_whitelist: "Notifications Whitelist",
+    operations: "Operations",
+    superuser: "Superusers",
 };
 exports.CLIQ_ROLES = {
-    client_service_analyst: 'Client Service Analyst',
-    implementation_specialist: 'Implementation Specialist',
-    account_manager: 'Account Manager',
+    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',
-    video: 'Video',
-    tcc: 'The Conversion Cloud',
-    search: 'Search Builder',
-    searchreview: 'Search Review',
-    pmaxreview: 'PMax Review',
+    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",
+    video: "Video",
+    tcc: "The Conversion Cloud",
+    search: "Search Builder",
+    searchreview: "Search Review",
+    pmaxreview: "PMax Review",
 };
 class XperienceRightsClient {
     static findAbility(data, scope, qualifier) {
         if (!data || !data.rights) {
-            return 'none';
+            return "none";
         }
         const abilities = data.rights[scope];
         if (!abilities) {
-            return 'none';
+            return "none";
         }
         if (!qualifier) {
             qualifier = 0;
@@ -125,29 +130,29 @@ class XperienceRightsClient {
                 return XperienceRightsClient.bestAbility(ability, best);
             }
             return best;
-        }, 'none');
+        }, "none");
     }
     static cliqLocatorDescription(locator, long = false) {
         if (!locator || !locator.type) {
             return null;
         }
-        if (locator.type === 'user') {
+        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 === "group") {
+            return `${long ? "any user in the group: " : ""}${exports.CLIQ_GROUPS[locator.value] || locator.value}`;
         }
-        if (locator.type === 'role') {
+        if (locator.type === "role") {
             return `${exports.CLIQ_ROLES[locator.value] || locator.value}`;
         }
-        if (locator.type === 'right') {
-            const [scope, ability] = locator.value.split('@');
+        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})` : ''}`;
+                ? `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]
+        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}`;
         }
@@ -164,20 +169,20 @@ class XperienceRightsClient {
             if (!strategy.enabled) {
                 return false;
             }
-            if (strategy.type === 'group') {
+            if (strategy.type === "group") {
                 return (_a = strategy.groups) === null || _a === void 0 ? void 0 : _a.some((group) => XperienceRightsClient.isGroupMember(data, group, qualifier));
             }
-            if (strategy.type === 'user') {
+            if (strategy.type === "user") {
                 return ((_b = strategy.users) === null || _b === void 0 ? void 0 : _b.includes(data.email)) || false;
             }
-            if (strategy.type === 'company') {
+            if (strategy.type === "company") {
                 return ((_c = strategy.master_ids) === null || _c === void 0 ? void 0 : _c.includes(qualifier)) || false;
             }
-            if (strategy.type === 'company_user') {
+            if (strategy.type === "company_user") {
                 return (((_d = strategy.master_ids) === null || _d === void 0 ? void 0 : _d.includes(qualifier)) &&
                     ((_e = strategy.users) === null || _e === void 0 ? void 0 : _e.includes(data.email)));
             }
-            if (strategy.type === 'company_group') {
+            if (strategy.type === "company_group") {
                 return (((_f = strategy.master_ids) === null || _f === void 0 ? void 0 : _f.includes(qualifier)) &&
                     ((_g = strategy.groups) === null || _g === void 0 ? void 0 : _g.some((group) => XperienceRightsClient.isGroupMember(data, group, qualifier))));
             }
@@ -199,35 +204,35 @@ class XperienceRightsClient {
     }
     static abilityValue(ability) {
         switch (ability) {
-            case 'none':
+            case "none":
                 return 0;
-            case 'view':
+            case "view":
                 return 1;
-            case 'edit':
+            case "edit":
                 return 2;
-            case 'admin':
+            case "admin":
                 return 3;
             default:
                 return 0;
         }
     }
-    static compareAbilities(a, b, comparison = 'enough') {
+    static compareAbilities(a, b, comparison = "enough") {
         const aValue = XperienceRightsClient.abilityValue(a);
         const bValue = XperienceRightsClient.abilityValue(b);
-        if (comparison === 'enough') {
+        if (comparison === "enough") {
             return aValue >= bValue;
         }
         return aValue > bValue;
     }
     static bestAbility(...abilities) {
         return abilities.reduce((best, current) => {
-            return XperienceRightsClient.compareAbilities(current, best, 'better')
+            return XperienceRightsClient.compareAbilities(current, best, "better")
                 ? current
                 : best;
-        }, 'none');
+        }, "none");
     }
     static xperienceScopeName(scope) {
-        return exports.FRIENDLY_SCOPE_NAMES[scope] || 'Unknown';
+        return exports.FRIENDLY_SCOPE_NAMES[scope] || "Unknown";
     }
 }
 exports.XperienceRightsClient = XperienceRightsClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clxmedia/xperience-rights-client",
-  "version": "1.1.9",
+  "version": "1.1.11",
   "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.187"
+    "@clxmedia/types": "1.2.0"
   },
   "devDependencies": {
     "@types/jest": "29.5.11",
@@ -64,4 +64,4 @@
     "coverageDirectory": "../coverage",
     "testEnvironment": "node"
   }
-}
+}