@ampsec/platform-client 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Fast-and-Reliable-Technologies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,59 @@
+# Amplifier Security - Data Library
+
+Collection of data models used by our Platform API.
+
+## Install
+
+```sh
+npm install @ampsec/platform-data
+```
+
+## Usage
+
+You can use the types by simply importing them.
+
+```ts
+import {UpsertUserDto} from '@ampsec/platform-data'
+
+const user: UpsertUserDto = {
+   id?: number;
+   etag: string;
+   department?: string;
+    emails: string[];
+    firstName: string;
+    lastName: string;
+    oid: number;
+    startDate?: string;
+}
+```
+
+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-data
+```
+
+### Generating Docs
+
+Published to <https://amplifier-security.gitlab.io/amp-data-lib/>
+
+```sh
+npm run docs
+# preview before deploying
+npm run docs:serve
+```
+
+### Upgrade the dependencies
+
+```sh
+npm upgrade
+```

package/build/src/EntityIdLookupMap.d.ts

@@ -0,0 +1,11 @@
+export type EntityIds = {
+    id: number;
+    etag: string;
+};
+/**
+ * A lookup table used during ingestion pipeline to efficiently
+ * drop unmodified data and duplicate events.
+ */
+export type EntityIdLookupMap = {
+    [extId: string]: EntityIds;
+};

package/build/src/EntityIdLookupMap.js

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

package/build/src/EntityIdLookupMap.js.map

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

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

@@ -0,0 +1,18 @@
+export type BaseUpsertDto = {
+    /** Unique Row Identifier. Populated for entity updates. */
+    id?: number;
+    /** MD5 hash of a subset of properties to deted field level changes. */
+    etag: string;
+};
+export type BaseDto = {
+    /** Unique Row Identifier */
+    id: number;
+    /** MD5 hash of a subset of properties to deted field level changes. */
+    etag: string;
+    /** Record creation date in database. */
+    createdAt: string;
+    /** Last record update date in database. */
+    updatedAt: string;
+    /** Record creation date in database. Only present on soft deleted, i.e. `null => active` */
+    deletedAt: string | null;
+};

package/build/src/dto/base.dto.js

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

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

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

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

@@ -0,0 +1,14 @@
+import { BaseDto, BaseUpsertDto } from './base.dto';
+export type UpsertSaaSComponentDto = BaseUpsertDto & {
+    /** Organization ID */
+    oid: number;
+    /** Connector ID */
+    cid: number;
+    /** External ID */
+    extKey: string;
+    /** Owner ID */
+    uid: number | null;
+    /** Provider Specific Data */
+    meta: unknown;
+};
+export type SaaSComponentDto = BaseDto & UpsertSaaSComponentDto;

package/build/src/dto/components.dto.js

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

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

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

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

@@ -0,0 +1,23 @@
+import { BaseDto, BaseUpsertDto } from './base.dto';
+export type UpsertDeviceDto = BaseUpsertDto & {
+    /** Organization ID */
+    oid: number;
+    /** External ID: Serial Number */
+    sn: string;
+    /** Owner ID */
+    uid: number | null;
+};
+export type DeviceDto = BaseDto & UpsertDeviceDto;
+export type UpsertSaaSDeviceDto = BaseUpsertDto & {
+    /** Organization ID */
+    oid: number;
+    /** External ID: Serial Number */
+    sn: string;
+    /** Owner ID */
+    uid: number | null;
+    /** Connector ID */
+    cid: number;
+    /** Provider Specific Data */
+    meta: unknown;
+};
+export type SaaSDeviceDto = BaseDto & UpsertSaaSDeviceDto;

package/build/src/dto/devices.dto.js

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

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

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

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

@@ -0,0 +1,3 @@
+export * from './base.dto';
+export * from './page.dto';
+export * from './users.dto';

package/build/src/dto/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./base.dto"), exports);
+__exportStar(require("./page.dto"), exports);
+__exportStar(require("./users.dto"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/dto/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,6CAA2B;AAC3B,8CAA4B"}

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

@@ -0,0 +1,4 @@
+export type Page<T> = {
+    items: T[];
+    hasMore: boolean;
+};

package/build/src/dto/page.dto.js

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

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

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

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

@@ -0,0 +1,26 @@
+import { BaseDto, BaseUpsertDto } from './base.dto';
+export type UpsertUserDto = BaseUpsertDto & {
+    /** Organization ID */
+    oid: number;
+    /** External ID: list of emails, allows or merging users across email aliases */
+    emails: string[];
+    firstName: string;
+    lastName: string;
+    department?: string;
+    /** Employment start date used for calculating tenure */
+    startDate?: string;
+};
+export type UserDto = BaseDto & UpsertUserDto;
+export type UpsertSaaSUserDto = BaseUpsertDto & {
+    /** Organization ID */
+    oid: number;
+    /** Connector ID */
+    cid: number;
+    /** Global User ID */
+    uid: number;
+    /** External ID */
+    email: string;
+    /** Provider Specific Data */
+    meta: unknown;
+};
+export type SaaSUserDto = BaseDto & UpsertSaaSUserDto;

package/build/src/dto/users.dto.js

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

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

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

package/build/src/etag.d.ts

@@ -0,0 +1,3 @@
+import { BaseDto, BaseUpsertDto } from './';
+export declare function calculateEtag(model: unknown): string;
+export declare function withEtag(model: BaseDto | BaseUpsertDto): void;

package/build/src/etag.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withEtag = exports.calculateEtag = void 0;
+const blueimp_md5_1 = __importDefault(require("blueimp-md5"));
+function calculateEtag(model) {
+    const hashObject = { ...model };
+    delete hashObject.etag;
+    return (0, blueimp_md5_1.default)(JSON.stringify(hashObject));
+}
+exports.calculateEtag = calculateEtag;
+function withEtag(model) {
+    model.etag = calculateEtag(model);
+}
+exports.withEtag = withEtag;
+//# sourceMappingURL=etag.js.map

package/build/src/etag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"etag.js","sourceRoot":"","sources":["../../src/etag.ts"],"names":[],"mappings":";;;;;;AAAA,8DAA8B;AAG9B,SAAgB,aAAa,CAAC,KAAc;IAC1C,MAAM,UAAU,GAAoB,EAAC,GAAI,KAAgB,EAAC,CAAC;IAC3D,OAAO,UAAU,CAAC,IAAI,CAAC;IACvB,OAAO,IAAA,qBAAG,EAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;AACzC,CAAC;AAJD,sCAIC;AAED,SAAgB,QAAQ,CAAC,KAA8B;IACrD,KAAK,CAAC,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;AACpC,CAAC;AAFD,4BAEC"}

package/build/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from './dto';
+export * from './etag';
+export * from './EntityIdLookupMap';

package/build/src/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./dto"), exports);
+__exportStar(require("./etag"), exports);
+__exportStar(require("./EntityIdLookupMap"), exports);
+//# sourceMappingURL=index.js.map

package/build/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,yCAAuB;AACvB,sDAAoC"}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@ampsec/platform-client",
+  "version": "0.1.0",
+  "description": "",
+  "main": "build/src/index.js",
+  "scripts": {
+    "dev": "tsc --watch",
+    "prebuild": "rimraf build",
+    "build": "tsc",
+    "predocs": "rimraf public",
+    "docs": "typedoc --out public src/index.ts",
+    "docs:serve": "serve public -p 3080",
+    "lint": "gts lint",
+    "clean": "gts clean",
+    "fix": "gts fix",
+    "test": "jest"
+  },
+  "keywords": [],
+  "author": "Amplifier Security <engineering@amplifiersecurity.com>",
+  "license": "MIT",
+  "dependencies": {
+    "blueimp-md5": "^2.19.0",
+    "lodash.omit": "^4.5.0"
+  },
+  "devDependencies": {
+    "@jest/types": "^29.5.0",
+    "@types/blueimp-md5": "^2.18.0",
+    "@types/jest": "^29.5.1",
+    "@types/lodash.omit": "^4.5.7",
+    "gts": "^3.1.1",
+    "jest": "^29.5.0",
+    "rimraf": "^5.0.0",
+    "serve": "^14.2.0",
+    "ts-jest": "^29.1.0",
+    "ts-node": "^10.9.1",
+    "typedoc": "^0.24.7",
+    "typescript": "^5.0.4"
+  },
+  "files": [
+    "/build/src"
+  ]
+}