@ampsec/platform-client 24.3.1 → 25.0.0

package/build/src/dto/enums/{agent.role.d.ts → auth.role.d.ts}

@@ -1,4 +1,6 @@
-export declare enum AgentRole {
+export declare enum AuthRole {
+    /** User can only their own data. */
+    USER = "USER",
     /** Agent can only read data. */
     REPORT_VIEWER = "REPORT_VIEWER",
     /** Agent can only read data. */
@@ -9,6 +11,10 @@ export declare enum AgentRole {
     ADMIN = "ADMIN",
     /** Agent owns organization. */
     OWNER = "OWNER",
+    /** Token belongs to a customer success manager */
+    CUSTOMER_SUCCESS = "CUSTOMER_SUCCESS",
+    /** Token belongs to a customer success manager */
+    SUPPORT = "SUPPORT",
     /** Token belongs to an operator. */
     OPERATOR = "OPERATOR",
     /** Token belongs to a service account. */
@@ -16,5 +22,4 @@ export declare enum AgentRole {
     /** Unknown role. Used for validation */
     UNKNOWN = "UNKNOWN"
 }
-export declare function lookupAgentRole(role: string): AgentRole;
-export declare function lookupAgentRoleOrdinal(role: string): number;
+export declare function lookupAuthRole(role: string): AuthRole;

package/build/src/dto/enums/auth.role.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lookupAuthRole = exports.AuthRole = void 0;
+/* eslint-disable no-unused-vars */
+var AuthRole;
+(function (AuthRole) {
+    /*
+     * ========= END USER ROLES =========
+     * - Chrome Extension
+     */
+    /** User can only their own data. */
+    AuthRole["USER"] = "USER";
+    /*
+     * ========= AGENT ROLES =========
+     * - Security Hub
+     */
+    /** Agent can only read data. */
+    AuthRole["REPORT_VIEWER"] = "REPORT_VIEWER";
+    /** Agent can only read data. */
+    AuthRole["VIEWER"] = "VIEWER";
+    /** Agent can read and write data. */
+    AuthRole["AGENT"] = "AGENT";
+    /** Agent can read and write data and manage other agents. */
+    AuthRole["ADMIN"] = "ADMIN";
+    /** Agent owns organization. */
+    AuthRole["OWNER"] = "OWNER";
+    /*
+     * ========= PLATFORM ROLES ========
+     * - Admin Portal
+     */
+    /** Token belongs to a customer success manager */
+    AuthRole["CUSTOMER_SUCCESS"] = "CUSTOMER_SUCCESS";
+    /** Token belongs to a customer success manager */
+    AuthRole["SUPPORT"] = "SUPPORT";
+    /** Token belongs to an operator. */
+    AuthRole["OPERATOR"] = "OPERATOR";
+    /** Token belongs to a service account. */
+    AuthRole["SERVICE_ACCOUNT"] = "SERVICE_ACCOUNT";
+    /** Unknown role. Used for validation */
+    AuthRole["UNKNOWN"] = "UNKNOWN";
+})(AuthRole || (exports.AuthRole = AuthRole = {}));
+const authRoleLookupMap = {
+    USER: AuthRole.USER,
+    REPORT_VIEWER: AuthRole.REPORT_VIEWER,
+    VIEWER: AuthRole.VIEWER,
+    AGENT: AuthRole.AGENT,
+    ADMIN: AuthRole.ADMIN,
+    OWNER: AuthRole.OWNER,
+    CUSTOMER_SUCCESS: AuthRole.CUSTOMER_SUCCESS,
+    SUPPORT: AuthRole.SUPPORT,
+    OPERATOR: AuthRole.OPERATOR,
+    SERVICE_ACCOUNT: AuthRole.SERVICE_ACCOUNT,
+};
+function lookupAuthRole(role) {
+    return authRoleLookupMap[role] || AuthRole.UNKNOWN;
+}
+exports.lookupAuthRole = lookupAuthRole;
+//# sourceMappingURL=auth.role.js.map

package/build/src/dto/enums/auth.role.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.role.js","sourceRoot":"","sources":["../../../../src/dto/enums/auth.role.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,QAmCX;AAnCD,WAAY,QAAQ;IAClB;;;OAGG;IACH,oCAAoC;IACpC,yBAAa,CAAA;IACb;;;OAGG;IACH,gCAAgC;IAChC,2CAA+B,CAAA;IAC/B,gCAAgC;IAChC,6BAAiB,CAAA;IACjB,qCAAqC;IACrC,2BAAe,CAAA;IACf,6DAA6D;IAC7D,2BAAe,CAAA;IACf,+BAA+B;IAC/B,2BAAe,CAAA;IACf;;;OAGG;IACH,kDAAkD;IAClD,iDAAqC,CAAA;IACrC,kDAAkD;IAClD,+BAAmB,CAAA;IACnB,oCAAoC;IACpC,iCAAqB,CAAA;IACrB,0CAA0C;IAC1C,+CAAmC,CAAA;IACnC,wCAAwC;IACxC,+BAAmB,CAAA;AACrB,CAAC,EAnCW,QAAQ,wBAAR,QAAQ,QAmCnB;AAED,MAAM,iBAAiB,GAA8B;IACnD,IAAI,EAAE,QAAQ,CAAC,IAAI;IACnB,aAAa,EAAE,QAAQ,CAAC,aAAa;IACrC,MAAM,EAAE,QAAQ,CAAC,MAAM;IACvB,KAAK,EAAE,QAAQ,CAAC,KAAK;IACrB,KAAK,EAAE,QAAQ,CAAC,KAAK;IACrB,KAAK,EAAE,QAAQ,CAAC,KAAK;IACrB,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB;IAC3C,OAAO,EAAE,QAAQ,CAAC,OAAO;IACzB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;IAC3B,eAAe,EAAE,QAAQ,CAAC,eAAe;CAC1C,CAAC;AAEF,SAAgB,cAAc,CAAC,IAAY;IACzC,OAAO,iBAAiB,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC;AACrD,CAAC;AAFD,wCAEC"}

package/build/src/dto/enums/index.d.ts

@@ -1,4 +1,4 @@
-export * from './agent.role';
+export * from './auth.role';
 export * from './agent.status';
 export * from './category';
 export * from './connector.status';

package/build/src/dto/enums/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./agent.role"), exports);
+__exportStar(require("./auth.role"), exports);
 __exportStar(require("./agent.status"), exports);
 __exportStar(require("./category"), exports);
 __exportStar(require("./connector.status"), exports);

package/build/src/dto/enums/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/dto/enums/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,iDAA+B;AAC/B,6CAA2B;AAC3B,qDAAmC;AACnC,gDAA8B;AAC9B,qDAAmC;AACnC,mDAAiC;AACjC,wDAAsC;AACtC,yDAAuC;AACvC,sDAAoC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/dto/enums/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,iDAA+B;AAC/B,6CAA2B;AAC3B,qDAAmC;AACnC,gDAA8B;AAC9B,qDAAmC;AACnC,mDAAiC;AACjC,wDAAsC;AACtC,yDAAuC;AACvC,sDAAoC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ampsec/platform-client",
-  "version": "24.3.1",
+  "version": "25.0.0",
   "description": "",
   "main": "build/src/index.js",
   "runkitExampleFilename": "example/main.js",

package/src/dto/enums/auth.role.ts

@@ -0,0 +1,54 @@
+/* eslint-disable no-unused-vars */
+export enum AuthRole {
+  /*
+   * ========= END USER ROLES =========
+   * - Chrome Extension
+   */
+  /** User can only their own data. */
+  USER = 'USER',
+  /*
+   * ========= AGENT ROLES =========
+   * - Security Hub
+   */
+  /** Agent can only read data. */
+  REPORT_VIEWER = 'REPORT_VIEWER',
+  /** Agent can only read data. */
+  VIEWER = 'VIEWER',
+  /** Agent can read and write data. */
+  AGENT = 'AGENT',
+  /** Agent can read and write data and manage other agents. */
+  ADMIN = 'ADMIN',
+  /** Agent owns organization. */
+  OWNER = 'OWNER',
+  /*
+   * ========= PLATFORM ROLES ========
+   * - Admin Portal
+   */
+  /** Token belongs to a customer success manager */
+  CUSTOMER_SUCCESS = 'CUSTOMER_SUCCESS',
+  /** Token belongs to a customer success manager */
+  SUPPORT = 'SUPPORT',
+  /** Token belongs to an operator. */
+  OPERATOR = 'OPERATOR',
+  /** Token belongs to a service account. */
+  SERVICE_ACCOUNT = 'SERVICE_ACCOUNT',
+  /** Unknown role. Used for validation */
+  UNKNOWN = 'UNKNOWN',
+}
+
+const authRoleLookupMap: {[key: string]: AuthRole} = {
+  USER: AuthRole.USER,
+  REPORT_VIEWER: AuthRole.REPORT_VIEWER,
+  VIEWER: AuthRole.VIEWER,
+  AGENT: AuthRole.AGENT,
+  ADMIN: AuthRole.ADMIN,
+  OWNER: AuthRole.OWNER,
+  CUSTOMER_SUCCESS: AuthRole.CUSTOMER_SUCCESS,
+  SUPPORT: AuthRole.SUPPORT,
+  OPERATOR: AuthRole.OPERATOR,
+  SERVICE_ACCOUNT: AuthRole.SERVICE_ACCOUNT,
+};
+
+export function lookupAuthRole(role: string): AuthRole {
+  return authRoleLookupMap[role] || AuthRole.UNKNOWN;
+}

package/src/dto/enums/index.ts

@@ -1,4 +1,4 @@
-export * from './agent.role';
+export * from './auth.role';
 export * from './agent.status';
 export * from './category';
 export * from './connector.status';

package/build/src/dto/enums/agent.role.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.lookupAgentRoleOrdinal = exports.lookupAgentRole = exports.AgentRole = void 0;
-/* eslint-disable no-unused-vars */
-var AgentRole;
-(function (AgentRole) {
-    /** Agent can only read data. */
-    AgentRole["REPORT_VIEWER"] = "REPORT_VIEWER";
-    /** Agent can only read data. */
-    AgentRole["VIEWER"] = "VIEWER";
-    /** Agent can read and write data. */
-    AgentRole["AGENT"] = "AGENT";
-    /** Agent can read and write data and manage other agents. */
-    AgentRole["ADMIN"] = "ADMIN";
-    /** Agent owns organization. */
-    AgentRole["OWNER"] = "OWNER";
-    /** Token belongs to an operator. */
-    AgentRole["OPERATOR"] = "OPERATOR";
-    /** Token belongs to a service account. */
-    AgentRole["SERVICE_ACCOUNT"] = "SERVICE_ACCOUNT";
-    /** Unknown role. Used for validation */
-    AgentRole["UNKNOWN"] = "UNKNOWN";
-})(AgentRole || (exports.AgentRole = AgentRole = {}));
-const agentRoleLookupMap = {
-    REPORT_VIEWER: AgentRole.REPORT_VIEWER,
-    VIEWER: AgentRole.VIEWER,
-    AGENT: AgentRole.AGENT,
-    ADMIN: AgentRole.ADMIN,
-    OWNER: AgentRole.OWNER,
-    OPERATOR: AgentRole.OPERATOR,
-    SERVICE_ACCOUNT: AgentRole.SERVICE_ACCOUNT,
-};
-function lookupAgentRole(role) {
-    return agentRoleLookupMap[role] || AgentRole.UNKNOWN;
-}
-exports.lookupAgentRole = lookupAgentRole;
-const UNKNOWN_ORDINAL = -99;
-const agentRoleOrdinalMap = new Map([
-    [AgentRole.REPORT_VIEWER, 0],
-    [AgentRole.VIEWER, 1],
-    [AgentRole.AGENT, 2],
-    [AgentRole.ADMIN, 3],
-    [AgentRole.OWNER, 4],
-    [AgentRole.OPERATOR, 5],
-    [AgentRole.SERVICE_ACCOUNT, 6],
-    [AgentRole.UNKNOWN, UNKNOWN_ORDINAL],
-]);
-function lookupAgentRoleOrdinal(role) {
-    return agentRoleOrdinalMap.get(lookupAgentRole(role)) || UNKNOWN_ORDINAL;
-}
-exports.lookupAgentRoleOrdinal = lookupAgentRoleOrdinal;
-//# sourceMappingURL=agent.role.js.map

package/build/src/dto/enums/agent.role.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"agent.role.js","sourceRoot":"","sources":["../../../../src/dto/enums/agent.role.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,SAiBX;AAjBD,WAAY,SAAS;IACnB,gCAAgC;IAChC,4CAA+B,CAAA;IAC/B,gCAAgC;IAChC,8BAAiB,CAAA;IACjB,qCAAqC;IACrC,4BAAe,CAAA;IACf,6DAA6D;IAC7D,4BAAe,CAAA;IACf,+BAA+B;IAC/B,4BAAe,CAAA;IACf,oCAAoC;IACpC,kCAAqB,CAAA;IACrB,0CAA0C;IAC1C,gDAAmC,CAAA;IACnC,wCAAwC;IACxC,gCAAmB,CAAA;AACrB,CAAC,EAjBW,SAAS,yBAAT,SAAS,QAiBpB;AAED,MAAM,kBAAkB,GAA+B;IACrD,aAAa,EAAE,SAAS,CAAC,aAAa;IACtC,MAAM,EAAE,SAAS,CAAC,MAAM;IACxB,KAAK,EAAE,SAAS,CAAC,KAAK;IACtB,KAAK,EAAE,SAAS,CAAC,KAAK;IACtB,KAAK,EAAE,SAAS,CAAC,KAAK;IACtB,QAAQ,EAAE,SAAS,CAAC,QAAQ;IAC5B,eAAe,EAAE,SAAS,CAAC,eAAe;CAC3C,CAAC;AAEF,SAAgB,eAAe,CAAC,IAAY;IAC1C,OAAO,kBAAkB,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,OAAO,CAAC;AACvD,CAAC;AAFD,0CAEC;AAED,MAAM,eAAe,GAAG,CAAC,EAAE,CAAC;AAC5B,MAAM,mBAAmB,GAA2B,IAAI,GAAG,CAAC;IAC1D,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC;IAC5B,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;IACrB,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;IACpB,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;IACpB,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;IACpB,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;IACvB,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC;IAC9B,CAAC,SAAS,CAAC,OAAO,EAAE,eAAe,CAAC;CACrC,CAAC,CAAC;AAEH,SAAgB,sBAAsB,CAAC,IAAY;IACjD,OAAO,mBAAmB,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,IAAI,eAAe,CAAC;AAC3E,CAAC;AAFD,wDAEC"}

package/src/dto/enums/agent.role.ts

@@ -1,49 +0,0 @@
-/* eslint-disable no-unused-vars */
-export enum AgentRole {
-  /** Agent can only read data. */
-  REPORT_VIEWER = 'REPORT_VIEWER',
-  /** Agent can only read data. */
-  VIEWER = 'VIEWER',
-  /** Agent can read and write data. */
-  AGENT = 'AGENT',
-  /** Agent can read and write data and manage other agents. */
-  ADMIN = 'ADMIN',
-  /** Agent owns organization. */
-  OWNER = 'OWNER',
-  /** Token belongs to an operator. */
-  OPERATOR = 'OPERATOR',
-  /** Token belongs to a service account. */
-  SERVICE_ACCOUNT = 'SERVICE_ACCOUNT',
-  /** Unknown role. Used for validation */
-  UNKNOWN = 'UNKNOWN',
-}
-
-const agentRoleLookupMap: {[key: string]: AgentRole} = {
-  REPORT_VIEWER: AgentRole.REPORT_VIEWER,
-  VIEWER: AgentRole.VIEWER,
-  AGENT: AgentRole.AGENT,
-  ADMIN: AgentRole.ADMIN,
-  OWNER: AgentRole.OWNER,
-  OPERATOR: AgentRole.OPERATOR,
-  SERVICE_ACCOUNT: AgentRole.SERVICE_ACCOUNT,
-};
-
-export function lookupAgentRole(role: string): AgentRole {
-  return agentRoleLookupMap[role] || AgentRole.UNKNOWN;
-}
-
-const UNKNOWN_ORDINAL = -99;
-const agentRoleOrdinalMap: Map<AgentRole, number> = new Map([
-  [AgentRole.REPORT_VIEWER, 0],
-  [AgentRole.VIEWER, 1],
-  [AgentRole.AGENT, 2],
-  [AgentRole.ADMIN, 3],
-  [AgentRole.OWNER, 4],
-  [AgentRole.OPERATOR, 5],
-  [AgentRole.SERVICE_ACCOUNT, 6],
-  [AgentRole.UNKNOWN, UNKNOWN_ORDINAL],
-]);
-
-export function lookupAgentRoleOrdinal(role: string): number {
-  return agentRoleOrdinalMap.get(lookupAgentRole(role)) || UNKNOWN_ORDINAL;
-}