@ampsec/platform-client 37.0.0 → 37.1.0

package/build/src/dto/constants.d.ts

@@ -0,0 +1,65 @@
+import { AuthRole } from './enums';
+/**
+ ** /=====================\
+ ** |== AGENT API ROLES ==|
+ ** \=====================/
+ */
+/**
+ * This is the set of roles that can be used to manage user access for a tenant in the agent API.
+ *
+ * Includes: [{@link AuthRole.OWNER}]
+ * @type {Set<AuthRole>}
+ */
+export declare const AGENT_OWNER_ROLES: Set<AuthRole>;
+/**
+ * This is the set of roles that can be used to administer a tenant in the agent API.
+ *
+ * Includes: [{@link AuthRole.ADMIN} {@link AuthRole.OWNER}]
+ * @type {Set<AuthRole>}
+ */
+export declare const AGENT_ADMIN_ROLES: Set<AuthRole>;
+/**
+ * This is the set of roles that can be used to view tenant data in the agent API.
+ *
+ * Includes: [{@link AuthRole.VIEWER}, {@link AuthRole.AGENT}, {@link AuthRole.ADMIN}, {@link AuthRole.OWNER}]
+ * @type {Set<AuthRole>}
+ */
+export declare const AGENT_VIEWER_ROLES: Set<AuthRole>;
+/**
+ * This is the set of roles that can be used to view tenant data summaries in the agent API.
+ *
+ * Includes: [{@link AuthRole.REPORT_VIEWER}, {@link AuthRole.VIEWER}, {@link AuthRole.AGENT}, {@link AuthRole.ADMIN}, {@link AuthRole.OWNER}]
+ * @type {Set<AuthRole>}
+ */
+export declare const AGENT_REPORT_VIEWER_ROLES: Set<AuthRole>;
+/**
+ ** /==========================\
+ ** |== ENGAGEMENT API ROLES ==|
+ ** \==========================/
+ */
+/**
+ * This is the set of roles that can be used by an end user in the engagement API.
+ *
+ * Includes: [{@link AuthRole.USER}]
+ * @type {Set<AuthRole>}
+ */
+export declare const ENGAGEMENT_END_USER_ROLES: Set<AuthRole>;
+/**
+ ** /========================\
+ ** |== PLATFORM API ROLES ==|
+ ** \========================/
+ */
+/**
+ * This is the set of roles that can be used by Amplifier Employees to view data in the Platform API.
+ *
+ * Includes: [{@link AuthRole.CUSTOMER_SUCCESS}, {@link AuthRole.SUPPORT}, {@link AuthRole.OPERATOR}, {@link AuthRole.SERVICE_ACCOUNT}]
+ * @type {Set<AuthRole>}
+ */
+export declare const PLATFORM_READ_ONLY_ROLES: Set<AuthRole>;
+/**
+ * This is the set of roles that can be used by Amplifier Employees to view data in the Platform API.
+ *
+ * Includes: [{@link AuthRole.CUSTOMER_SUCCESS}, {@link AuthRole.SUPPORT}, {@link AuthRole.OPERATOR}, {@link AuthRole.SERVICE_ACCOUNT}]
+ * @type {Set<AuthRole>}
+ */
+export declare const PLATFORM_READ_WRITE_ROLES: Set<AuthRole>;

package/build/src/dto/constants.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PLATFORM_READ_WRITE_ROLES = exports.PLATFORM_READ_ONLY_ROLES = exports.ENGAGEMENT_END_USER_ROLES = exports.AGENT_REPORT_VIEWER_ROLES = exports.AGENT_VIEWER_ROLES = exports.AGENT_ADMIN_ROLES = exports.AGENT_OWNER_ROLES = void 0;
+const enums_1 = require("./enums");
+/**
+ ** /=====================\
+ ** |== AGENT API ROLES ==|
+ ** \=====================/
+ */
+/**
+ * This is the set of roles that can be used to manage user access for a tenant in the agent API.
+ *
+ * Includes: [{@link AuthRole.OWNER}]
+ * @type {Set<AuthRole>}
+ */
+exports.AGENT_OWNER_ROLES = new Set([enums_1.AuthRole.OWNER]);
+/**
+ * This is the set of roles that can be used to administer a tenant in the agent API.
+ *
+ * Includes: [{@link AuthRole.ADMIN} {@link AuthRole.OWNER}]
+ * @type {Set<AuthRole>}
+ */
+exports.AGENT_ADMIN_ROLES = new Set([enums_1.AuthRole.ADMIN, enums_1.AuthRole.OWNER]);
+/**
+ * This is the set of roles that can be used to view tenant data in the agent API.
+ *
+ * Includes: [{@link AuthRole.VIEWER}, {@link AuthRole.AGENT}, {@link AuthRole.ADMIN}, {@link AuthRole.OWNER}]
+ * @type {Set<AuthRole>}
+ */
+exports.AGENT_VIEWER_ROLES = new Set([enums_1.AuthRole.VIEWER, enums_1.AuthRole.AGENT, enums_1.AuthRole.ADMIN, enums_1.AuthRole.OWNER]);
+/**
+ * This is the set of roles that can be used to view tenant data summaries in the agent API.
+ *
+ * Includes: [{@link AuthRole.REPORT_VIEWER}, {@link AuthRole.VIEWER}, {@link AuthRole.AGENT}, {@link AuthRole.ADMIN}, {@link AuthRole.OWNER}]
+ * @type {Set<AuthRole>}
+ */
+exports.AGENT_REPORT_VIEWER_ROLES = new Set([enums_1.AuthRole.REPORT_VIEWER, enums_1.AuthRole.VIEWER, enums_1.AuthRole.AGENT, enums_1.AuthRole.ADMIN, enums_1.AuthRole.OWNER]);
+/**
+ ** /==========================\
+ ** |== ENGAGEMENT API ROLES ==|
+ ** \==========================/
+ */
+/**
+ * This is the set of roles that can be used by an end user in the engagement API.
+ *
+ * Includes: [{@link AuthRole.USER}]
+ * @type {Set<AuthRole>}
+ */
+exports.ENGAGEMENT_END_USER_ROLES = new Set([enums_1.AuthRole.USER]);
+/**
+ ** /========================\
+ ** |== PLATFORM API ROLES ==|
+ ** \========================/
+ */
+/**
+ * This is the set of roles that can be used by Amplifier Employees to view data in the Platform API.
+ *
+ * Includes: [{@link AuthRole.CUSTOMER_SUCCESS}, {@link AuthRole.SUPPORT}, {@link AuthRole.OPERATOR}, {@link AuthRole.SERVICE_ACCOUNT}]
+ * @type {Set<AuthRole>}
+ */
+exports.PLATFORM_READ_ONLY_ROLES = new Set([enums_1.AuthRole.CUSTOMER_SUCCESS, enums_1.AuthRole.SUPPORT, enums_1.AuthRole.OPERATOR, enums_1.AuthRole.SERVICE_ACCOUNT]);
+/**
+ * This is the set of roles that can be used by Amplifier Employees to view data in the Platform API.
+ *
+ * Includes: [{@link AuthRole.CUSTOMER_SUCCESS}, {@link AuthRole.SUPPORT}, {@link AuthRole.OPERATOR}, {@link AuthRole.SERVICE_ACCOUNT}]
+ * @type {Set<AuthRole>}
+ */
+exports.PLATFORM_READ_WRITE_ROLES = new Set([enums_1.AuthRole.OPERATOR, enums_1.AuthRole.SERVICE_ACCOUNT]);
+//# sourceMappingURL=constants.js.map

package/build/src/dto/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/dto/constants.ts"],"names":[],"mappings":";;;AAAA,mCAAiC;AAEjC;;;;GAIG;AAEH;;;;;GAKG;AACU,QAAA,iBAAiB,GAAG,IAAI,GAAG,CAAW,CAAC,gBAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;AACrE;;;;;GAKG;AACU,QAAA,iBAAiB,GAAG,IAAI,GAAG,CAAW,CAAC,gBAAQ,CAAC,KAAK,EAAE,gBAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;AACrF;;;;;GAKG;AACU,QAAA,kBAAkB,GAAG,IAAI,GAAG,CAAW,CAAC,gBAAQ,CAAC,MAAM,EAAE,gBAAQ,CAAC,KAAK,EAAE,gBAAQ,CAAC,KAAK,EAAE,gBAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;AACvH;;;;;GAKG;AACU,QAAA,yBAAyB,GAAG,IAAI,GAAG,CAAW,CAAC,gBAAQ,CAAC,aAAa,EAAE,gBAAQ,CAAC,MAAM,EAAE,gBAAQ,CAAC,KAAK,EAAE,gBAAQ,CAAC,KAAK,EAAE,gBAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;AAEtJ;;;;GAIG;AAEH;;;;;GAKG;AACU,QAAA,yBAAyB,GAAG,IAAI,GAAG,CAAW,CAAC,gBAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;AAE5E;;;;GAIG;AAEH;;;;;GAKG;AACU,QAAA,wBAAwB,GAAG,IAAI,GAAG,CAAW,CAAC,gBAAQ,CAAC,gBAAgB,EAAE,gBAAQ,CAAC,OAAO,EAAE,gBAAQ,CAAC,QAAQ,EAAE,gBAAQ,CAAC,eAAe,CAAC,CAAC,CAAC;AACtJ;;;;;GAKG;AACU,QAAA,yBAAyB,GAAG,IAAI,GAAG,CAAW,CAAC,gBAAQ,CAAC,QAAQ,EAAE,gBAAQ,CAAC,eAAe,CAAC,CAAC,CAAC"}

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

@@ -3,6 +3,7 @@ export * from './assets.dto';
 export * from './assetKeys';
 export * from './base.dto';
 export * from './connectors.dto';
+export * from './constants';
 export * from './enum.dto';
 export * from './enums';
 export * from './extKeyMap.dto';

package/build/src/dto/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./assets.dto"), exports);
 __exportStar(require("./assetKeys"), exports);
 __exportStar(require("./base.dto"), exports);
 __exportStar(require("./connectors.dto"), exports);
+__exportStar(require("./constants"), exports);
 __exportStar(require("./enum.dto"), exports);
 __exportStar(require("./enums"), exports);
 __exportStar(require("./extKeyMap.dto"), exports);

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/dto/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,+CAA6B;AAC7B,8CAA4B;AAC5B,6CAA2B;AAC3B,mDAAiC;AACjC,6CAA2B;AAC3B,0CAAwB;AACxB,kDAAgC;AAChC,iDAA+B;AAC/B,wCAAsB;AACtB,gDAA8B;AAC9B,qDAAmC;AACnC,6CAA2B;AAC3B,6CAA2B;AAC3B,kDAAgC;AAChC,sDAAoC;AACpC,yDAAuC;AACvC,mDAAiC;AACjC,uDAAqC;AACrC,kDAAgC;AAChC,mDAAiC;AACjC,gDAA8B;AAC9B,8CAA4B;AAC5B,iDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/dto/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,+CAA6B;AAC7B,8CAA4B;AAC5B,6CAA2B;AAC3B,mDAAiC;AACjC,8CAA4B;AAC5B,6CAA2B;AAC3B,0CAAwB;AACxB,kDAAgC;AAChC,iDAA+B;AAC/B,wCAAsB;AACtB,gDAA8B;AAC9B,qDAAmC;AACnC,6CAA2B;AAC3B,6CAA2B;AAC3B,kDAAgC;AAChC,sDAAoC;AACpC,yDAAuC;AACvC,mDAAiC;AACjC,uDAAqC;AACrC,kDAAgC;AAChC,mDAAiC;AACjC,gDAA8B;AAC9B,8CAA4B;AAC5B,iDAA+B"}

package/package.json

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

package/src/dto/constants.ts

@@ -0,0 +1,71 @@
+import {AuthRole} from './enums';
+
+/**
+ ** /=====================\
+ ** |== AGENT API ROLES ==|
+ ** \=====================/
+ */
+
+/**
+ * This is the set of roles that can be used to manage user access for a tenant in the agent API.
+ *
+ * Includes: [{@link AuthRole.OWNER}]
+ * @type {Set<AuthRole>}
+ */
+export const AGENT_OWNER_ROLES = new Set<AuthRole>([AuthRole.OWNER]);
+/**
+ * This is the set of roles that can be used to administer a tenant in the agent API.
+ *
+ * Includes: [{@link AuthRole.ADMIN} {@link AuthRole.OWNER}]
+ * @type {Set<AuthRole>}
+ */
+export const AGENT_ADMIN_ROLES = new Set<AuthRole>([AuthRole.ADMIN, AuthRole.OWNER]);
+/**
+ * This is the set of roles that can be used to view tenant data in the agent API.
+ *
+ * Includes: [{@link AuthRole.VIEWER}, {@link AuthRole.AGENT}, {@link AuthRole.ADMIN}, {@link AuthRole.OWNER}]
+ * @type {Set<AuthRole>}
+ */
+export const AGENT_VIEWER_ROLES = new Set<AuthRole>([AuthRole.VIEWER, AuthRole.AGENT, AuthRole.ADMIN, AuthRole.OWNER]);
+/**
+ * This is the set of roles that can be used to view tenant data summaries in the agent API.
+ *
+ * Includes: [{@link AuthRole.REPORT_VIEWER}, {@link AuthRole.VIEWER}, {@link AuthRole.AGENT}, {@link AuthRole.ADMIN}, {@link AuthRole.OWNER}]
+ * @type {Set<AuthRole>}
+ */
+export const AGENT_REPORT_VIEWER_ROLES = new Set<AuthRole>([AuthRole.REPORT_VIEWER, AuthRole.VIEWER, AuthRole.AGENT, AuthRole.ADMIN, AuthRole.OWNER]);
+
+/**
+ ** /==========================\
+ ** |== ENGAGEMENT API ROLES ==|
+ ** \==========================/
+ */
+
+/**
+ * This is the set of roles that can be used by an end user in the engagement API.
+ *
+ * Includes: [{@link AuthRole.USER}]
+ * @type {Set<AuthRole>}
+ */
+export const ENGAGEMENT_END_USER_ROLES = new Set<AuthRole>([AuthRole.USER]);
+
+/**
+ ** /========================\
+ ** |== PLATFORM API ROLES ==|
+ ** \========================/
+ */
+
+/**
+ * This is the set of roles that can be used by Amplifier Employees to view data in the Platform API.
+ *
+ * Includes: [{@link AuthRole.CUSTOMER_SUCCESS}, {@link AuthRole.SUPPORT}, {@link AuthRole.OPERATOR}, {@link AuthRole.SERVICE_ACCOUNT}]
+ * @type {Set<AuthRole>}
+ */
+export const PLATFORM_READ_ONLY_ROLES = new Set<AuthRole>([AuthRole.CUSTOMER_SUCCESS, AuthRole.SUPPORT, AuthRole.OPERATOR, AuthRole.SERVICE_ACCOUNT]);
+/**
+ * This is the set of roles that can be used by Amplifier Employees to view data in the Platform API.
+ *
+ * Includes: [{@link AuthRole.CUSTOMER_SUCCESS}, {@link AuthRole.SUPPORT}, {@link AuthRole.OPERATOR}, {@link AuthRole.SERVICE_ACCOUNT}]
+ * @type {Set<AuthRole>}
+ */
+export const PLATFORM_READ_WRITE_ROLES = new Set<AuthRole>([AuthRole.OPERATOR, AuthRole.SERVICE_ACCOUNT]);

package/src/dto/index.ts

@@ -3,6 +3,7 @@ export * from './assets.dto';
 export * from './assetKeys';
 export * from './base.dto';
 export * from './connectors.dto';
+export * from './constants';
 export * from './enum.dto';
 export * from './enums';
 export * from './extKeyMap.dto';