@ampsec/platform-client 20.1.1 → 21.1.0

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

@@ -0,0 +1,6 @@
+export type AssetKeys = {
+    /** Serial Number */
+    sn?: string;
+    /** MAC Addresses. Note: could be empty */
+    macs: string[];
+};

package/build/src/dto/{assetKey.js → assetKeys.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=assetKey.js.map
+//# sourceMappingURL=assetKeys.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"assetKeys.js","sourceRoot":"","sources":["../../../src/dto/assetKeys.ts"],"names":[],"mappings":""}

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

@@ -1,7 +1,8 @@
+import { AssetKeys } from './assetKeys';
 import { ChangeAwareDto, ChangeAwareUpsertDto } from './base.dto';
 export type AssetUpsertDto = ChangeAwareUpsertDto & {
-    /** External Id */
-    sn: string;
+    /** External Keys */
+    extKeys: AssetKeys;
     /** User Id of the asset owner */
     uid?: string | undefined;
 };

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

@@ -1,6 +1,5 @@
 export * from './agent.role';
 export * from './agent.status';
-export * from './assetKeyKind';
 export * from './category';
 export * from './connector.status';
 export * from './findingKind';

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

@@ -16,7 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./agent.role"), exports);
 __exportStar(require("./agent.status"), exports);
-__exportStar(require("./assetKeyKind"), exports);
 __exportStar(require("./category"), exports);
 __exportStar(require("./connector.status"), exports);
 __exportStar(require("./findingKind"), 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,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,+CAA6B;AAC7B,iDAA+B;AAC/B,6CAA2B;AAC3B,qDAAmC;AACnC,gDAA8B;AAC9B,qDAAmC;AACnC,mDAAiC;AACjC,wDAAsC;AACtC,yDAAuC;AACvC,sDAAoC"}

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

@@ -1,6 +1,6 @@
 export * from './agents.dto';
 export * from './assets.dto';
-export * from './assetKey';
+export * from './assetKeys';
 export * from './base.dto';
 export * from './connectors.dto';
 export * from './enum.dto';

package/build/src/dto/index.js

@@ -16,7 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./agents.dto"), exports);
 __exportStar(require("./assets.dto"), exports);
-__exportStar(require("./assetKey"), exports);
+__exportStar(require("./assetKeys"), exports);
 __exportStar(require("./base.dto"), exports);
 __exportStar(require("./connectors.dto"), exports);
 __exportStar(require("./enum.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,6CAA2B;AAC3B,6CAA2B;AAC3B,mDAAiC;AACjC,6CAA2B;AAC3B,0CAAwB;AACxB,kDAAgC;AAChC,iDAA+B;AAC/B,wCAAsB;AACtB,gDAA8B;AAC9B,6CAA2B;AAC3B,6CAA2B;AAC3B,kDAAgC;AAChC,sDAAoC;AACpC,yDAAuC;AACvC,mDAAiC;AACjC,uDAAqC;AACrC,kDAAgC;AAChC,mDAAiC;AACjC,gDAA8B;AAC9B,8CAA4B"}
+{"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,6CAA2B;AAC3B,6CAA2B;AAC3B,kDAAgC;AAChC,sDAAoC;AACpC,yDAAuC;AACvC,mDAAiC;AACjC,uDAAqC;AACrC,kDAAgC;AAChC,mDAAiC;AACjC,gDAA8B;AAC9B,8CAA4B"}

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

@@ -1,7 +1,8 @@
+import { AssetKeys } from './assetKeys';
 import { ChangeAwareDto, ChangeAwareUpsertDto } from './base.dto';
 export type SaasAssetUpsertDto = ChangeAwareUpsertDto & {
-    /** External Id */
-    sn: string;
+    /** External Ids */
+    extKeys: AssetKeys;
     /** Connector Id */
     cid: string;
     /** Asset Id */

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

@@ -2,6 +2,13 @@ import { ChangeAwareDto, ChangeAwareUpsertDto } from './base.dto';
 import { Category, FindingSeverity, SaasComponentKind } from './enums';
 export type SaasComponentMeta = {
     _findings: {
+        /**
+         * Uses styling to display the finding in the UI
+         *   - `+` is used to denote success, e.g. `+ACTIVE`
+         *   - `-` is used to denote failure, e.g. `-FAILED`
+         *   - `?` is used to denote unknown, e.g. `?ASSIGNED` for a pending not-out-of-sla training
+         */
+        displayValue?: string;
         active?: boolean;
         enabled?: boolean;
         failedPhishing?: boolean;

package/package.json

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

package/src/dto/assetKeys.ts

@@ -0,0 +1,6 @@
+export type AssetKeys = {
+  /** Serial Number */
+  sn?: string;
+  /** MAC Addresses. Note: could be empty */
+  macs: string[];
+};

package/src/dto/assets.dto.ts

@@ -1,8 +1,9 @@
+import {AssetKeys} from './assetKeys';
 import {ChangeAwareDto, ChangeAwareUpsertDto} from './base.dto';
 
 export type AssetUpsertDto = ChangeAwareUpsertDto & {
-  /** External Id */
-  sn: string;
+  /** External Keys */
+  extKeys: AssetKeys;
   /** User Id of the asset owner */
   uid?: string | undefined;
 };

package/src/dto/enums/index.ts

@@ -1,6 +1,5 @@
 export * from './agent.role';
 export * from './agent.status';
-export * from './assetKeyKind';
 export * from './category';
 export * from './connector.status';
 export * from './findingKind';

package/src/dto/index.ts

@@ -1,6 +1,6 @@
 export * from './agents.dto';
 export * from './assets.dto';
-export * from './assetKey';
+export * from './assetKeys';
 export * from './base.dto';
 export * from './connectors.dto';
 export * from './enum.dto';

package/src/dto/saasAssets.dto.ts

@@ -1,8 +1,9 @@
+import {AssetKeys} from './assetKeys';
 import {ChangeAwareDto, ChangeAwareUpsertDto} from './base.dto';
 
 export type SaasAssetUpsertDto = ChangeAwareUpsertDto & {
-  /** External Id */
-  sn: string;
+  /** External Ids */
+  extKeys: AssetKeys;
   /** Connector Id */
   cid: string;
   /** Asset Id */

package/src/dto/saasComponents.dto.ts

@@ -3,6 +3,13 @@ import {Category, FindingSeverity, SaasComponentKind} from './enums';
 
 export type SaasComponentMeta = {
   _findings: {
+    /**
+     * Uses styling to display the finding in the UI
+     *   - `+` is used to denote success, e.g. `+ACTIVE`
+     *   - `-` is used to denote failure, e.g. `-FAILED`
+     *   - `?` is used to denote unknown, e.g. `?ASSIGNED` for a pending not-out-of-sla training
+     */
+    displayValue?: string;
     active?: boolean;
     enabled?: boolean;
     failedPhishing?: boolean;

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

@@ -1,5 +0,0 @@
-import { AssetKeyKind } from './enums/assetKeyKind';
-export type AssetKey = {
-    value: string;
-    kind: AssetKeyKind;
-};

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

@@ -1 +0,0 @@
-{"version":3,"file":"assetKey.js","sourceRoot":"","sources":["../../../src/dto/assetKey.ts"],"names":[],"mappings":""}

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

@@ -1,4 +0,0 @@
-export declare enum AssetKeyKind {
-    SERIAL_NUMBER = "SERIAL_NUMBER",
-    MAC_ADDRESS = "MAC_ADDRESS"
-}

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

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AssetKeyKind = void 0;
-/* eslint-disable no-unused-vars */
-var AssetKeyKind;
-(function (AssetKeyKind) {
-    AssetKeyKind["SERIAL_NUMBER"] = "SERIAL_NUMBER";
-    AssetKeyKind["MAC_ADDRESS"] = "MAC_ADDRESS";
-})(AssetKeyKind || (exports.AssetKeyKind = AssetKeyKind = {}));
-//# sourceMappingURL=assetKeyKind.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"assetKeyKind.js","sourceRoot":"","sources":["../../../../src/dto/enums/assetKeyKind.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,+CAA+B,CAAA;IAC/B,2CAA2B,CAAA;AAC7B,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB"}

package/src/dto/assetKey.ts

@@ -1,6 +0,0 @@
-import {AssetKeyKind} from './enums/assetKeyKind';
-
-export type AssetKey = {
-  value: string;
-  kind: AssetKeyKind;
-};

package/src/dto/enums/assetKeyKind.ts

@@ -1,5 +0,0 @@
-/* eslint-disable no-unused-vars */
-export enum AssetKeyKind {
-  SERIAL_NUMBER = 'SERIAL_NUMBER',
-  MAC_ADDRESS = 'MAC_ADDRESS',
-}