@ampsec/platform-client 32.3.1 → 33.0.0

package/README.md

@@ -2,72 +2,47 @@
 
 Collection of data models, utilities, and clients used by and with our Platform API.
 
-## Install
+## Entry Points
 
-```sh
-npm install @ampsec/platform-client
-```
+### API Clients
+
+- Agents
+  - [src/services/AmpApi.ts](https://amplifier-security.gitlab.io/ampsec-platform/amp-platform-client/classes/AmpApi.html)
+- Service Accounts
+  - [src/services/AmpSdk.ts](https://amplifier-security.gitlab.io/ampsec-platform/amp-platform-client/classes/AmpSdk.html)
+- End Users
+  - [src/services/EngageApi.ts](https://amplifier-security.gitlab.io/ampsec-platform/amp-platform-client/classes/AmpSdk.html)
+
+### Services
 
-## Usage
+- Settings
+  - [AmpSettingsService - src/services/settings.service.ts](https://amplifier-security.gitlab.io/ampsec-platform/amp-platform-client/classes/AmpSettingsService.html)
+  - [AmpSettingsMap - src/services/settings.service.ts](https://amplifier-security.gitlab.io/ampsec-platform/amp-platform-client/classes/AmpSettingsMap.html)
 
-You can use the types by simply importing them.
+## Getting Started
 
 ```ts
 import {UpsertUserDto} from '@ampsec/platform-client'
 
-const user: UpsertUserDto = {
-    id?: number;
-    etag: string;
-    department?: string;
-    emails: string[];
-    firstName: string;
-    lastName: string;
-    oid: number;
-    startDate?: string;
+async function testAgentApi() {
+    const agentApi = AmpApi.instance({
+        baseUrl: process.env.PLATFORM_API_URL,
+        token: process.env.PLATFORM_TOKEN,
+    })
+    const me = await agentApi.identity.me();
+    console.log(me);
 }
-```
-
-TODO: deploy docs for refrence
-
-## Development
-
-```sh
-npm install
-npm run dev
-npm run test
-
-# Optional
-npm link
-cd /path/to/application
-npm link @ampsec/platform-client
-```
-
-## Testing
 
-Unit tests are written with [Jest](https://jestjs.io/). To run the tests:
-
-```sh
-npm run test
-```
-
-Integration tests are written with [Jest](https://jestjs.io/). To run the tests:
-
-```sh
-npm run test:integration
-```
-
-### Generating Docs
-
-Published to <https://amplifier-security.gitlab.io/ampsec-platform/amp-platform-client/>
-
-```sh
-npm run docs
-# preview before deploying
-npm run docs:serve
+async function testAgentApi() {
+    const sdk = AmpSdkServices.instance({
+        baseUrl: process.env.PLATFORM_API_URL,
+        token: process.env.PLATFORM_TOKEN,
+    })
+    const me = await agentApi.identity.me();
+    console.log(me);
+}
 ```
 
-### Upgrade the dependencies
+## Development
 
-```sh
-npm upgrade
-```
+See [DEVELOPMENT.md](DEVELOPMENT.md)

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

@@ -1,39 +1,58 @@
 import { ChangeAwareDto, ChangeAwareUpsertDto } from './base.dto';
 import { Category, FindingSeverity, SaasComponentKind } from './enums';
+export type RawUserIds = {
+    uid?: string;
+    /** Provider id used against the API */
+    extId?: string;
+    primaryEmail?: string;
+    emails?: string[];
+};
+export type RawAssetIds = {
+    aid?: string;
+    /** Provider id used against the API */
+    extId?: string;
+    /** Serial Number */
+    sn?: string;
+    /** Hostnames */
+    hostnames?: string[];
+    /** MAC Addresses */
+    macs?: string[];
+};
+export type RawTrainingContext = {
+    title?: string;
+    url?: string;
+    enrollDate?: string | null;
+};
+export type RawVulnerabilityContext = {
+    cve?: string;
+    cvss?: number;
+    description?: string;
+    solution?: string;
+};
+export type RawFindingsContext = {
+    /**
+     * 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;
+    loggedIn?: boolean;
+    overdue?: boolean;
+    severity?: FindingSeverity;
+    isExecutive?: boolean;
+    hasProdAccess?: boolean;
+    hasPrivilegedAccess?: boolean;
+};
 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;
-        loggedIn?: boolean;
-        overdue?: boolean;
-        severity?: FindingSeverity;
-        isExecutive?: boolean;
-        hasProdAccess?: boolean;
-        hasPrivilegedAccess?: boolean;
-    };
-    _asset?: {
-        extId?: string;
-        sn?: string;
-        hostnames?: string[];
-        macs?: string[];
-    };
-    _user?: {
-        extId?: string;
-        email?: string;
-    };
-    _training?: {
-        title?: string;
-        enrollDate?: string | null;
-        startDate?: string | null;
-    };
+    _findings: RawFindingsContext;
+    _asset?: RawAssetIds;
+    _user?: RawUserIds;
+    _training?: RawTrainingContext;
+    _vulnerability?: RawVulnerabilityContext;
     [propName: string]: unknown;
 };
 export type SaasComponentUpsertDto = ChangeAwareUpsertDto & {

package/package.json

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

package/src/dto/saasComponents.dto.ts

@@ -1,40 +1,64 @@
 import {ChangeAwareDto, ChangeAwareUpsertDto} from './base.dto';
 import {Category, FindingSeverity, SaasComponentKind} from './enums';
 
+export type RawUserIds = {
+  uid?: string;
+  /** Provider id used against the API */
+  extId?: string;
+  primaryEmail?: string;
+  emails?: string[];
+};
+
+export type RawAssetIds = {
+  aid?: string;
+  /** Provider id used against the API */
+  extId?: string;
+  /** Serial Number */
+  sn?: string;
+  /** Hostnames */
+  hostnames?: string[];
+  /** MAC Addresses */
+  macs?: string[];
+};
+
+export type RawTrainingContext = {
+  title?: string;
+  url?: string;
+  enrollDate?: string | null;
+};
+
+export type RawVulnerabilityContext = {
+  cve?: string;
+  cvss?: number;
+  description?: string;
+  solution?: string;
+};
+
+export type RawFindingsContext = {
+  /**
+   * 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;
+  loggedIn?: boolean;
+  overdue?: boolean;
+  severity?: FindingSeverity;
+  isExecutive?: boolean;
+  hasProdAccess?: boolean;
+  hasPrivilegedAccess?: boolean;
+};
+
 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;
-    loggedIn?: boolean;
-    overdue?: boolean;
-    severity?: FindingSeverity;
-    isExecutive?: boolean;
-    hasProdAccess?: boolean;
-    hasPrivilegedAccess?: boolean;
-  };
-  _asset?: {
-    extId?: string;
-    sn?: string;
-    hostnames?: string[];
-    macs?: string[];
-  };
-  _user?: {
-    extId?: string;
-    email?: string;
-  };
-  _training?: {
-    title?: string;
-    enrollDate?: string | null;
-    startDate?: string | null;
-  };
+  _findings: RawFindingsContext;
+  _asset?: RawAssetIds;
+  _user?: RawUserIds;
+  _training?: RawTrainingContext;
+  _vulnerability?: RawVulnerabilityContext;
   [propName: string]: unknown;
 };