@clxmedia/credstore-client 1.0.24 → 2.0.0

package/README.md

@@ -1,10 +1,10 @@
 <h1 align="center"></h1>
 
-<h3 align="center">CLXperience CredStore Client</h3>
+<h3 align="center">CLXperience Credstore Client</h3>
 
 ## Usage
 
-Client connector for internal Conxversion Logix Xperience services.
+Reads and writes to the Xperience Credstore
 
 ## Change Log
 
@@ -16,4 +16,4 @@ See [Changelog](CHANGELOG.md) for more information.
 
 ## License
 
-Licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+Licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/dist/client.d.ts

@@ -1,109 +1,21 @@
+import { CredStoreBundle, CredStoreConfig, CredentialProvider, CredstoreCredential } from '@clxmedia/types/core/credstore';
 export declare const XperienceEntityKeyValidator: (entityId: string | number, entitySecret: string, availableEntityKeys: string[]) => boolean;
 export declare const XperienceEntityKeyGenerator: (entityId: string | number, xperienceEntityKey: string) => string;
-export interface CredStoreConfig {
-    api_server: string;
-    api_key?: string;
-}
-export declare enum CredentialProvider {
-    generic = "generic",
-    entrata = "entrata",
-    realpage = "realpage",
-    yardi = "yardi",
-    mailjet = "mailjet",
-    rentcafe_v2 = "rentcafe_v2",
-    welcome_home = "welcome_home"
-}
-export interface EntrataCredStoreBundle extends CredStoreBundle {
-    data: EntrataCredential;
-}
-export interface YardiCredStoreBundle extends CredStoreBundle {
-    data: YardiCredential;
-}
-export interface RealPageCredStoreBundle extends CredStoreBundle {
-    data: RealPageCredential;
-}
-export interface MailJetCredStoreBundle extends CredStoreBundle {
-    data: MailJetCredential;
-}
-export interface RentCafeV2CredStoreBundle extends CredStoreBundle {
-    data: RentCafeV2Credential;
-}
-export interface WelcomeHomeCredStoreBundle extends CredStoreBundle {
-    data: WelcomeHomeCredential;
-}
-export interface CredStoreBundle {
-    id: number;
-    description?: string;
-    guid: string;
-    secret?: string;
-    provider: CredentialProvider;
-    data: GenericCredential | EntrataCredential | RealPageCredential | YardiCredential | RentCafeV2Credential | MailJetCredential | WelcomeHomeCredential;
-    updated_at: string;
-    created_at: string;
-}
-export interface CredentialAttribute {
-    [x: string]: any;
-}
-export interface BaseCredential {
-    attributes?: Array<CredentialAttribute>;
-}
-export interface GenericCredential extends BaseCredential {
-    [x: string]: any;
-}
-export interface MailJetCredential extends BaseCredential {
-    username: string;
-    password: string;
-}
-export interface EntrataCredential extends BaseCredential {
-    domain: string;
-    username: string;
-    password: string;
-    property_id: string;
-}
-export interface RealPageCredential extends BaseCredential {
-    pmcid: string;
-    siteid: string;
-    username: string;
-    password: string;
-    licenseKey: string;
-}
-export interface RentCafeV2Credential extends BaseCredential {
-    company_api_key: string;
-    company_code: string;
-}
-export interface YardiCredential extends BaseCredential {
-    endpoint: string;
-    userName: string;
-    password: string;
-    serverName: string;
-    database: string;
-    platform: string;
-    yardiPropertyId: string;
-    interfaceEntity: string;
-    interfaceLicense: string;
-}
-export interface WelcomeHomeCredential extends BaseCredential {
-    api_key: string;
-    community_id: string;
-    lead_source_id: string;
-}
-export interface FetchOptions extends OptionsBase {
-    skipCache?: boolean;
-}
-export interface UpdateOptions extends OptionsBase {
-}
-export interface OptionsBase {
+export type OptionsBase = {
     guidSecret?: string;
-}
+};
+export type FetchOptions = OptionsBase & {
+    skipCache?: boolean;
+};
+export type UpdateOptions = OptionsBase;
 export declare class CredStoreClient {
     private apiServer;
     private apiKey?;
-    private httpService;
     constructor(config: CredStoreConfig);
     buildHeaders(guidSecret?: string, skipCache?: boolean): {
         [x: string]: string;
     };
     fetchCredential(guid: string, fetchOptions?: FetchOptions): Promise<CredStoreBundle>;
-    createCredential(provider: CredentialProvider, credData: EntrataCredential | RealPageCredential | YardiCredential | GenericCredential | MailJetCredential): Promise<any>;
+    createCredential(provider: CredentialProvider, credData: CredstoreCredential): Promise<any>;
     updateCredential(guid: string, data: any, updateOptions?: UpdateOptions): Promise<any>;
 }

package/dist/client.js

@@ -1,21 +1,8 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CredStoreClient = exports.CredentialProvider = exports.XperienceEntityKeyGenerator = exports.XperienceEntityKeyValidator = void 0;
-const axios_1 = require("@nestjs/axios");
-const rxjs_1 = require("rxjs");
-const luxon_1 = require("luxon");
-const crypto_1 = require("crypto");
-const XperienceEntityKeyValidator = (entityId, entitySecret, availableEntityKeys) => {
-    const now = luxon_1.DateTime.local().startOf('minute').toSeconds();
+import { DateTime } from 'luxon';
+import { createHash } from 'crypto';
+import axios from 'axios';
+export const XperienceEntityKeyValidator = (entityId, entitySecret, availableEntityKeys) => {
+    const now = DateTime.local().startOf('minute').toSeconds();
     const timeRange = Array.from(Array(9).keys()).map((i) => now + (i - 4) * 60);
     return timeRange.some((timeSalt) => {
         return availableEntityKeys.some((entityKey) => {
@@ -23,38 +10,24 @@ const XperienceEntityKeyValidator = (entityId, entitySecret, availableEntityKeys
         });
     });
 };
-exports.XperienceEntityKeyValidator = XperienceEntityKeyValidator;
-const XperienceEntityKeyGenerator = (entityId, xperienceEntityKey) => {
-    const timeSalt = luxon_1.DateTime.local().startOf('minute').toSeconds();
+export const XperienceEntityKeyGenerator = (entityId, xperienceEntityKey) => {
+    const timeSalt = DateTime.local().startOf('minute').toSeconds();
     return sha256Hash(`${entityId}:${xperienceEntityKey}`, timeSalt.toString());
 };
-exports.XperienceEntityKeyGenerator = XperienceEntityKeyGenerator;
 const sha256Hash = (input, salt) => {
-    return (0, crypto_1.createHash)("sha256")
+    return createHash('sha256')
         .update(input)
-        .update((0, crypto_1.createHash)("sha256").update(salt, "utf8").digest("hex"))
-        .digest("hex");
+        .update(createHash('sha256').update(salt, 'utf8').digest('hex'))
+        .digest('hex');
 };
-var CredentialProvider;
-(function (CredentialProvider) {
-    CredentialProvider["generic"] = "generic";
-    CredentialProvider["entrata"] = "entrata";
-    CredentialProvider["realpage"] = "realpage";
-    CredentialProvider["yardi"] = "yardi";
-    CredentialProvider["mailjet"] = "mailjet";
-    CredentialProvider["rentcafe_v2"] = "rentcafe_v2";
-    CredentialProvider["welcome_home"] = "welcome_home";
-})(CredentialProvider = exports.CredentialProvider || (exports.CredentialProvider = {}));
-;
-class CredStoreClient {
+export class CredStoreClient {
     constructor(config) {
-        this.httpService = new axios_1.HttpService();
         this.apiServer = config.api_server;
         this.apiKey = config.api_key;
     }
     buildHeaders(guidSecret, skipCache) {
         const headers = {
-            'x-credstore-skip-cache': `${skipCache}`
+            'x-credstore-skip-cache': `${skipCache}`,
         };
         if (this.apiKey) {
             headers['x-credstore-admin-key'] = this.apiKey;
@@ -64,28 +37,30 @@ class CredStoreClient {
         }
         return headers;
     }
-    fetchCredential(guid, fetchOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { guidSecret, skipCache } = fetchOptions;
-            return yield (0, rxjs_1.lastValueFrom)(this.httpService.get(`${this.apiServer}/credstore/credentials/${guid}`, { headers: this.buildHeaders(guidSecret, skipCache) }).pipe((0, rxjs_1.map)((response) => {
-                return response.data;
-            })));
+    async fetchCredential(guid, fetchOptions) {
+        if (!fetchOptions) {
+            throw new Error('fetchOptions is required');
+        }
+        const { guidSecret, skipCache } = fetchOptions;
+        const response = await axios.get(`${this.apiServer}/credstore/credentials/${guid}`, {
+            headers: this.buildHeaders(guidSecret, skipCache),
         });
+        return response.data;
     }
-    createCredential(provider, credData) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield (0, rxjs_1.lastValueFrom)(this.httpService.post(`${this.apiServer}/credstore/credentials/${provider}`, credData, { headers: this.buildHeaders() }).pipe((0, rxjs_1.map)((response) => {
-                return response.data;
-            })));
+    async createCredential(provider, credData) {
+        const response = await axios.post(`${this.apiServer}/credstore/credentials/${provider}`, credData, {
+            headers: this.buildHeaders(),
         });
+        return response.data;
     }
-    updateCredential(guid, data, updateOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { guidSecret } = updateOptions;
-            return yield (0, rxjs_1.lastValueFrom)(this.httpService.patch(`${this.apiServer}/credstore/credentials/${guid}`, data, { headers: this.buildHeaders(guidSecret) }).pipe((0, rxjs_1.map)((response) => {
-                return response.data;
-            })));
+    async updateCredential(guid, data, updateOptions) {
+        if (!updateOptions) {
+            throw new Error('updateOptions is required');
+        }
+        const { guidSecret } = updateOptions;
+        const response = await axios.patch(`${this.apiServer}/credstore/credentials/${guid}`, data, {
+            headers: this.buildHeaders(guidSecret),
         });
+        return response.data;
     }
 }
-exports.CredStoreClient = CredStoreClient;

package/dist/index.d.ts

@@ -1 +1 @@
-export { CredStoreClient, CredStoreConfig, CredentialAttribute, BaseCredential, EntrataCredential, RealPageCredential, YardiCredential, MailJetCredential, GenericCredential, CredStoreBundle, EntrataCredStoreBundle, RealPageCredStoreBundle, YardiCredStoreBundle, MailJetCredStoreBundle, CredentialProvider, FetchOptions, UpdateOptions, OptionsBase, XperienceEntityKeyValidator, XperienceEntityKeyGenerator } from './client';
+export * from './client';

package/dist/index.js

@@ -1,8 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.XperienceEntityKeyGenerator = exports.XperienceEntityKeyValidator = exports.CredentialProvider = exports.CredStoreClient = void 0;
-var client_1 = require("./client");
-Object.defineProperty(exports, "CredStoreClient", { enumerable: true, get: function () { return client_1.CredStoreClient; } });
-Object.defineProperty(exports, "CredentialProvider", { enumerable: true, get: function () { return client_1.CredentialProvider; } });
-Object.defineProperty(exports, "XperienceEntityKeyValidator", { enumerable: true, get: function () { return client_1.XperienceEntityKeyValidator; } });
-Object.defineProperty(exports, "XperienceEntityKeyGenerator", { enumerable: true, get: function () { return client_1.XperienceEntityKeyGenerator; } });
+export * from './client';

package/package.json

@@ -1,19 +1,26 @@
 {
   "name": "@clxmedia/credstore-client",
-  "version": "1.0.24",
-  "description": "CLXperience CredStore Client",
+  "version": "2.0.0",
+  "description": "CLXperience Credstore Client",
   "author": "Brandon Thompson <brandont@clxmedia.com>",
   "license": "MIT",
   "readmeFilename": "README.md",
-  "main": "dist/client.js",
-  "typings": "dist/client.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
     "dist/**/*",
     "*.md"
   ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./client": "./dist/client.js"
+  },
   "scripts": {
     "start:dev": "tsc -w",
-    "build": "tsc",
+    "build": "rm -Rf dist && tsc",
     "prepare": "npm run build",
     "format": "prettier --write \"src/**/*.ts\"",
     "lint": "tslint -p tsconfig.json -c tslint.json",
@@ -30,36 +37,25 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/adsupnow/xperience-cred-store/client"
-  },
-  "bugs": "https://github.com/adsupnow/xperience-cred-store/client",
-  "peerDependencies": {
-    "@nestjs/common": "^8.1.1"
+    "url": "https://github.com/adsupnow/xperience-clients/credstore"
   },
+  "bugs": "https://github.com/adsupnow/xperience-clients/credstore",
+  "peerDependencies": {},
   "dependencies": {
-    "@nestjs/axios": "^0.1.0",
-    "crypto": "^1.0.1",
-    "luxon": "^3.3.0"
+    "@clxmedia/types": "1.0.15",
+    "axios": "1.6.8",
+    "jsonwebtoken": "9.0.2",
+    "luxon": "3.4.4"
   },
   "devDependencies": {
-    "@nestjs/common": "^8.1.1",
-    "@nestjs/core": "^8.1.1",
-    "@nestjs/platform-express": "^8.1.1",
-    "@nestjs/testing": "8.1.1",
-    "@types/jest": "28.1.7",
-    "@types/luxon": "^3.3.0",
-    "@types/node": "16.11.7",
-    "@types/supertest": "2.0.12",
-    "jest": "28.1.3",
-    "prettier": "2.7.1",
-    "rxjs": "7.5.7",
-    "supertest": "6.2.4",
-    "ts-jest": "28.0.8",
-    "ts-node": "10.9.1",
-    "tsc-watch": "5.0.3",
-    "tsconfig-paths": "4.1.0",
+    "typescript": "^5.2.2",
+    "@types/node": "^20",
+    "@types/jsonwebtoken": "9.0.6",
+    "jest": "29.7.0",
+    "ts-jest": "29.1.2",
+    "nock": "13.5.4",
     "tslint": "6.1.3",
-    "typescript": "4.7.4"
+    "@types/luxon": "3.4.2"
   },
   "jest": {
     "moduleFileExtensions": [
@@ -75,4 +71,4 @@
     "coverageDirectory": "../coverage",
     "testEnvironment": "node"
   }
-}
+}

package/CHANGELOG.md

@@ -1,8 +0,0 @@
-RELEASE 1.0.14
-
-- Adds MailJet as new credential type
-- Adds ability to tell CredStore to forcibly skip the cache and grab latest credential from db
-
-RELEASE 1.0.15
-
-- Adds guid secrets to client interface

package/CONTRIBUTING.md

@@ -1,31 +0,0 @@
-# Contributing
-
-1. [Fork it](https://help.github.com/articles/fork-a-repo/)
-2. Install dependencies (`npm install`)
-3. Create your feature branch (`git checkout -b my-new-feature`)
-4. Commit your changes (`git commit -am 'Added some feature'`)
-5. Test your changes (`npm test`)
-6. Push to the branch (`git push origin my-new-feature`)
-7. [Create new Pull Request](https://help.github.com/articles/creating-a-pull-request/)
-
-## Testing
-
-We use [Jest](https://github.com/facebook/jest) to write tests. Run our test suite with this command:
-
-```
-npm test
-```
-
-## Code Style
-
-We use [Prettier](https://prettier.io/) and tslint to maintain code style and best practices.
-Please make sure your PR adheres to the guides by running:
-
-```
-npm run format
-```
-
-and
-```
-npm run lint
-```