orbitx-core-models 11.103.0 → 11.112.0

package/dist/permissions/trees/ops.tree.js

@@ -0,0 +1,173 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.opsTree = void 0;
+// Transcribed from the client's "Role & Access" spec (Ops Dashboard section).
+// "Billing" (Invoices / Payment Method / Adjust Billing Cycle) is a Company
+// concept only -- companies are billed for the product, partners are paid
+// out (see partners.payouts). The spec's global-admin listing nested a
+// "Billing" step under Partners, but per the client that's a doc typo
+// (confirmed 2026-09-12): partners have earnings/payouts, not billing.
+exports.opsTree = [
+    {
+        key: "profile",
+        label: "Profile",
+        children: [
+            { key: "profile.editPersonalInformation", label: "Edit Personal Information" },
+            { key: "profile.updatePassword", label: "Update Password" },
+            { key: "profile.twoFactorAuthentication", label: "Two Factor Authentication" },
+            { key: "profile.viewSessions", label: "View Sessions" },
+        ],
+    },
+    { key: "status", label: "Status" },
+    {
+        key: "dashboard",
+        label: "Dashboard",
+        children: [
+            { key: "dashboard.liveChat", label: "Live Chat" },
+            { key: "dashboard.companies", label: "Companies" },
+            { key: "dashboard.partners", label: "Partners" },
+            { key: "dashboard.revenue", label: "Revenue" },
+        ],
+    },
+    {
+        key: "companies",
+        label: "Companies",
+        children: [
+            { key: "companies.createCompany", label: "Create Company" },
+            {
+                key: "companies.account",
+                label: "Account",
+                children: [
+                    { key: "companies.account.basicInformation", label: "Basic Information" },
+                    { key: "companies.account.contactInformation", label: "Contact Information" },
+                    { key: "companies.account.hoursCallConnect", label: "Hours/Call Connect" },
+                    { key: "companies.account.leadForm", label: "Lead Form" },
+                    { key: "companies.account.users", label: "Users" },
+                    { key: "companies.account.script", label: "Script" },
+                    { key: "companies.account.appointmentScheduling", label: "Appointment Scheduling" },
+                    { key: "companies.account.retainerScheduling", label: "Retainer Scheduling" },
+                ],
+            },
+            {
+                key: "companies.branding",
+                label: "Branding",
+                children: [
+                    { key: "companies.branding.widget", label: "Widget" },
+                    { key: "companies.branding.aliases", label: "Aliases" },
+                    { key: "companies.branding.exitPopUp", label: "Exit Pop Up" },
+                    { key: "companies.branding.appearance", label: "Appearance" },
+                ],
+            },
+            {
+                key: "companies.plansAddOns",
+                label: "Plans & Add Ons",
+                children: [
+                    { key: "companies.plansAddOns.chatX", label: "CHAT-X" },
+                    { key: "companies.plansAddOns.addOns", label: "Add Ons" },
+                ],
+            },
+            { key: "companies.integrations", label: "Integrations" },
+        ],
+    },
+    {
+        key: "partners",
+        label: "Partners",
+        children: [
+            { key: "partners.createPartner", label: "Create Partner" },
+            {
+                key: "partners.account",
+                label: "Account",
+                children: [
+                    { key: "partners.account.basicInformation", label: "Basic Information" },
+                    { key: "partners.account.contactInformation", label: "Contact Information" },
+                    { key: "partners.account.users", label: "Users" },
+                    { key: "partners.account.bankInformation", label: "Bank Information" },
+                ],
+            },
+            {
+                key: "partners.payouts",
+                label: "Payouts",
+                children: [
+                    { key: "partners.payouts.transfers", label: "Transfers" },
+                    { key: "partners.payouts.withdrawals", label: "Withdrawals" },
+                    { key: "partners.payouts.processPayout", label: "Process Payout" },
+                ],
+            },
+        ],
+    },
+    {
+        key: "billing",
+        label: "Billing",
+        children: [
+            { key: "billing.invoices", label: "Invoices" },
+            { key: "billing.paymentMethod", label: "Payment Method" },
+            { key: "billing.adjustBillingCycle", label: "Adjust Billing Cycle" },
+        ],
+    },
+    {
+        key: "invoices",
+        label: "Invoices",
+        children: [{ key: "invoices.createNewInvoice", label: "Create New Invoice" }],
+    },
+    { key: "inbox", label: "Inbox" },
+    {
+        key: "leads",
+        label: "Leads",
+        children: [
+            { key: "leads.forward", label: "Forward" },
+            { key: "leads.viewScript", label: "View Script" },
+            { key: "leads.viewConversation", label: "View Conversation" },
+            { key: "leads.company", label: "Company" },
+            { key: "leads.chatHistory", label: "Chat History" },
+        ],
+    },
+    {
+        key: "conversations",
+        label: "Conversations",
+        children: [{ key: "conversations.viewLead", label: "View Lead" }],
+    },
+    {
+        key: "tickets",
+        label: "Tickets",
+        children: [{ key: "tickets.updateTicket", label: "Update Ticket" }],
+    },
+    {
+        key: "requests",
+        label: "Requests",
+        children: [{ key: "requests.updateRequest", label: "Update Request" }],
+    },
+    {
+        key: "reviews",
+        label: "Reviews",
+        children: [{ key: "reviews.updateReview", label: "Update Review" }],
+    },
+    {
+        key: "logs",
+        label: "Logs",
+        children: [{ key: "logs.detailedLogView", label: "Detailed Log View" }],
+    },
+    {
+        key: "profiles",
+        label: "Profiles",
+        children: [{ key: "profiles.createProfile", label: "Create Profile" }],
+    },
+    { key: "employees", label: "Employees" },
+    {
+        key: "groups",
+        label: "Groups",
+        children: [{ key: "groups.createGroup", label: "Create Group" }],
+    },
+    {
+        key: "scripts",
+        label: "Scripts",
+        children: [
+            { key: "scripts.createVertical", label: "Create Vertical" },
+            { key: "scripts.updateVertical", label: "Update Vertical" },
+            { key: "scripts.deleteVertical", label: "Delete Vertical" },
+        ],
+    },
+    { key: "updates", label: "Updates" },
+    { key: "settings", label: "Settings" },
+    // Reserved: feature not yet specified/built. No route is gated on this today.
+    { key: "chatFlux", label: "Chat Flux" },
+];

package/dist/permissions/trees/partner.tree.d.ts

@@ -0,0 +1,3 @@
+import { PermissionNode } from "../types";
+export declare const partnerTree: PermissionNode[];
+//# sourceMappingURL=partner.tree.d.ts.map

package/dist/permissions/trees/partner.tree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"partner.tree.d.ts","sourceRoot":"","sources":["../../../src/permissions/trees/partner.tree.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAM1C,eAAO,MAAM,WAAW,EAAE,cAAc,EA+DvC,CAAC"}

package/dist/permissions/trees/partner.tree.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.partnerTree = void 0;
+// Transcribed from the client's "Role & Access" spec (Partner Dashboard section).
+// Only one predefined role exists here ("admin", full tree) -- the doc's own note:
+// "An admin can control custom access from the above tree of a new or old user,
+// there are no more pre-made roles for partner dashboard."
+exports.partnerTree = [
+    {
+        key: "profile",
+        label: "Profile",
+        children: [
+            { key: "profile.editPersonalInformation", label: "Edit Personal Information" },
+            { key: "profile.updatePassword", label: "Update Password" },
+            { key: "profile.twoFactorAuthentication", label: "Two Factor Authentication" },
+            { key: "profile.viewSessions", label: "View Sessions" },
+        ],
+    },
+    {
+        key: "dashboard",
+        label: "Dashboard",
+        children: [
+            { key: "dashboard.analytics", label: "Analytics" },
+            { key: "dashboard.estimator", label: "Estimator" },
+        ],
+    },
+    { key: "referrals", label: "Referrals" },
+    { key: "leads", label: "Leads" },
+    {
+        key: "account",
+        label: "Account",
+        children: [
+            {
+                key: "account.details",
+                label: "Account",
+                children: [
+                    { key: "account.details.basicInformation", label: "Basic Information" },
+                    { key: "account.details.contactInformation", label: "Contact Information" },
+                    { key: "account.details.users", label: "Users" },
+                    { key: "account.details.bankInformation", label: "Bank Information" },
+                ],
+            },
+            {
+                key: "account.branding",
+                label: "Branding",
+                children: [{ key: "account.branding.appearance", label: "Appearance" }],
+            },
+        ],
+    },
+    {
+        key: "wallet",
+        label: "Wallet",
+        children: [{ key: "wallet.withdrawFunds", label: "Withdraw Funds" }],
+    },
+    {
+        key: "reviews",
+        label: "Reviews",
+        children: [{ key: "reviews.submitReviews", label: "Submit Reviews" }],
+    },
+    {
+        key: "requests",
+        label: "Requests",
+        children: [{ key: "requests.createRequest", label: "Create Request" }],
+    },
+    {
+        key: "tickets",
+        label: "Tickets",
+        children: [{ key: "tickets.createTicket", label: "Create Ticket" }],
+    },
+    { key: "leadTarget", label: "Lead Target" },
+];

package/dist/permissions/types.d.ts

@@ -0,0 +1,9 @@
+export type Dashboard = "ops" | "employee" | "partner" | "client";
+export interface PermissionNode {
+    /** Dot-path unique within a dashboard's tree, e.g. "companies.account.leadForm" */
+    key: string;
+    label: string;
+    children?: PermissionNode[];
+}
+export declare const DASHBOARDS: Dashboard[];
+//# sourceMappingURL=types.d.ts.map

package/dist/permissions/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/permissions/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,CAAC;AAElE,MAAM,WAAW,cAAc;IAC7B,mFAAmF;IACnF,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;CAC7B;AAED,eAAO,MAAM,UAAU,EAAE,SAAS,EAA6C,CAAC"}

package/dist/permissions/types.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DASHBOARDS = void 0;
+exports.DASHBOARDS = ["ops", "employee", "partner", "client"];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orbitx-core-models",
-  "version": "11.103.0",
+  "version": "11.112.0",
   "description": "Shared Mongoose models and interfaces for OrbitX services",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",