@sweepbright/api-client 0.30.2 → 0.30.4

package/.circleci/config.yml

@@ -0,0 +1,102 @@
+version: 2.1
+
+executors:
+  node:
+    docker:
+      - image: cimg/node:16.15.0
+
+x-definitions:
+  - &filters-only-tags
+    branches:
+      ignore: /.*/
+    tags:
+      only: /^v.*/
+  - &filters-any
+      branches:
+        only: /.*/
+      tags:
+        only: /^v.*/
+
+jobs:
+
+  build:
+    executor: node
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - yarn-v1-{{ checksum "yarn.lock" }}
+            - yarn-v1-
+      - run:
+          name: Authenticate with registry
+          command: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > ~/.npmrc
+      - run: yarn install
+      - save_cache:
+          key: yarn-v1-{{ checksum "yarn.lock" }}
+          paths:
+          - node_modules
+      - persist_to_workspace:
+          root: ~/project
+          paths:
+            - .
+      - run: yarn build
+      - run:
+          name: List build artifacts
+          command: ls -al ~/project/dist
+
+  lint:
+    executor: node
+    steps:
+      - attach_workspace:
+          at: ~/project
+      - run: yarn lint
+
+  test:
+    executor: node
+    steps:
+      - attach_workspace:
+          at: ~/project
+      - run: yarn test
+
+  deploy:
+    executor: node
+    steps:
+      - attach_workspace:
+          at: ~/project
+      - run:
+          name: Authenticate with registry
+          command: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > ~/.npmrc
+      - run:
+          name: List build artifacts
+          command: ls -al ~/project
+      - run:
+          name: Publish package
+          command: yarn publish
+
+workflows:
+  version: 2
+  test-deploy:
+    jobs:
+      - build:
+          context: npm-context
+          filters: *filters-any
+      - lint:
+          context: npm-context
+          filters: *filters-any
+          requires:
+            - build
+      - test:
+          context: npm-context
+          filters: *filters-any
+          requires:
+            - lint
+      - approve:
+          name: approve
+          type: approval
+          filters: *filters-any
+      - deploy:
+          context: npm-publish
+          requires:
+            - test
+            - approve
+          filters: *filters-any

package/.devcontainer/Dockerfile

@@ -0,0 +1,23 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.202.5/containers/typescript-node/.devcontainer/base.Dockerfile
+
+# [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 16, 14, 12, 16-bullseye, 14-bullseye, 12-bullseye, 16-buster, 14-buster, 12-buster
+ARG VARIANT="14-bullseye"
+FROM mcr.microsoft.com/vscode/devcontainers/typescript-node:0-${VARIANT}
+
+# Add repository for GitHub CLI
+RUN curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo gpg --dearmor -o /usr/share/keyrings/githubcli-archive-keyring.gpg \
+    && echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
+
+# [Optional] Uncomment this section to install additional OS packages.
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+    && apt-get -y install --no-install-recommends python2 htop mc gh
+
+# Install Phrase client binary
+RUN wget https://github.com/phrase/phrase-cli/releases/download/2.3.0/phrase_linux_amd64 -O /usr/bin/phrase && chmod a+x /usr/bin/phrase
+
+# [Optional] Uncomment if you want to install an additional version of node using nvm
+# ARG EXTRA_NODE_VERSION=10
+# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"
+
+# [Optional] Uncomment if you want to install more global node packages
+# RUN su node -c "npm install -g <your-package-list -here>"

package/.devcontainer/devcontainer.json

@@ -0,0 +1,59 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.202.5/containers/typescript-node
+{
+	"name": "Node.js & TypeScript",
+	"runArgs": [
+		"--init"
+	],
+	"build": {
+		"dockerfile": "Dockerfile",
+		// Update 'VARIANT' to pick a Node version: 16, 14, 12.
+		// Append -bullseye or -buster to pin to an OS version.
+		// Use -bullseye variants on local on arm64/Apple Silicon.
+		"args": {
+			"VARIANT": "14-bullseye"
+		}
+	},
+	// Set *default* container specific settings.json values on container create.
+	"settings": {},
+	// Add the IDs of extensions you want installed when the container is created.
+	"mounts": [
+		//For deploying with Serverless
+		"source=${localEnv:HOME}/.aws,target=/home/node/.aws,type=bind,consistency=cached"
+	],
+	"extensions": [
+		"dbaeumer.vscode-eslint",
+		"maptz.regionfolder",
+		"wmaurer.change-case",
+		"jvandyke.vscode-circleci",
+		"anseki.vscode-color",
+		"nemesv.copy-file-name",
+		"ryanluker.vscode-coverage-gutters",
+		"aeschli.vscode-css-formatter",
+		"jpruliere.env-autocomplete",
+		"waderyan.gitblame",
+		"github.vscode-pull-request-github",
+		"eamodio.gitlens",
+		"pushqrdx.inline-html",
+		"orta.vscode-jest",
+		"cmstead.js-codeformer",
+		"eg2.vscode-npm-script",
+		"silvenga.positions",
+		"esbenp.prettier-vscode",
+		"2gua.rainbow-brackets",
+		"unional.vscode-sort-package-json",
+		"hbenl.vscode-test-explorer"
+	],
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	"forwardPorts": [
+		3000,
+		3001
+	],
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "yarn",
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "node",
+	"containerEnv": {
+		"NPM_TOKEN": "${localEnv:NPM_TOKEN}"
+	}
+}

package/.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

package/.eslintrc.json

@@ -0,0 +1,6 @@
+{
+    "extends": "@sweepbright/eslint-config-shared",
+    "rules": {
+      "@typescript-eslint/ban-ts-comment": "off"
+    }
+  }

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,40 @@
+### Add any information and/or comments that might be useful to your reviewer:
+
+*For example: what is the current behaviour?*
+
+*How has this change.*
+
+---
+### Please check the type of change your PR introduces:
+- [ ] Bugfix
+- [ ] Feature
+- [ ] CI improvement
+- [ ] Refactoring (no functional changes, no api changes)
+- [ ] Build related changes
+- [ ] Documentation content changes
+- [ ] Other (please describe)
+---
+### Checklist before requesting a review:
+- [ ] I have performed a self-review of my code
+- [ ] I have improved the technical debt/and not created more
+- [ ] I have increased test coverage.
+- [ ] I have made corresponding changes to the documentation or created an issue for this.
+- [ ] Changing documentation was not necessary - but I considered if it was important for this change.
+---
+### How has this been Tested?
+- [ ] WebApp
+- [ ] iOS
+- [ ] Android
+- [ ] Other - *need to comment*
+
+*I tested this by...*
+ 
+*going to...and typing/clicking...it can be reproduced by...*
+ 
+*creating the unit tests...*
+ 
+*see the images/video here that show...*
+ 
+*I consider the edge cases...*
+ 
+*I know my tests don't cover...*

package/.nvmrc

@@ -0,0 +1 @@
+16

package/.prettierignore

@@ -0,0 +1 @@
+dist

package/jest.config.js

@@ -0,0 +1,7 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testTimeout: 30000,
+  setupFilesAfterEnv: ['./setupTests.ts'],
+};

package/mockServer.ts

@@ -0,0 +1,44 @@
+import { rest } from 'msw';
+import { setupServer } from 'msw/node';
+
+const server = setupServer(
+  rest.post('*', (req, res, ctx) => {
+    return res(
+      ctx.status(500),
+      ctx.json({ error: 'Mock this request ' + req.url.toString() })
+    );
+  }),
+  rest.get('*', (req, res, ctx) => {
+    return res(
+      ctx.status(500),
+      ctx.json({ error: 'Mock this request ' + req.url.toString() })
+    );
+  }),
+  rest.put('*', (req, res, ctx) => {
+    return res(
+      ctx.status(500),
+      ctx.json({ error: 'Mock this request ' + req.url.toString() })
+    );
+  })
+);
+
+beforeAll(() => server.listen());
+afterAll(() => server.close());
+beforeEach(() => server.resetHandlers());
+
+const handlers = {
+  authHandler: rest.post(
+    'https://api.sweepbright.com/auth/access-token',
+    (_req, res, ctx) => {
+      return res(
+        ctx.status(200),
+        ctx.json({
+          access_token: 'FAKE_TOKEN',
+          expires_in: Date.now(),
+        })
+      );
+    }
+  ),
+};
+
+export { server, rest, handlers };

package/package.json

@@ -1,11 +1,8 @@
 {
-  "version": "0.30.2",
+  "version": "0.30.4",
   "license": "UNLICENCED",
-  "main": "dist/src/index.js",
-  "typings": "dist/src/types.js",
-  "files": [
-    "dist"
-  ],
+  "main": "/src/index.js",
+  "typings": "/src/types.js",
   "scripts": {
     "build": "yarn tsc",
     "test": "yarn jest --forceExit --detectOpenHandles",

package/setupTests.ts

@@ -0,0 +1 @@
+import './mockServer';

package/src/__tests__/auth.test.ts

@@ -0,0 +1,14 @@
+import { createClient } from '../';
+import { handlers, server } from '../../mockServer';
+
+describe('authorization', () => {
+  it('can fetch an auth token', async () => {
+    const client = createClient({
+      clientId: 'FAKE_ID',
+      clientSecret: 'FAKE_SECRET',
+    });
+
+    server.use(handlers.authHandler);
+    await client.authorize({});
+  });
+});

package/src/__tests__/channels.test.ts

@@ -0,0 +1,104 @@
+import { createClient } from '../';
+import { handlers, rest, server } from '../../mockServer';
+
+describe('channels', () => {
+  it('can fetch a references list', async () => {
+    const client = createClient({
+      clientId: 'FAKE_ID',
+      clientSecret: 'FAKE_SECRET',
+    });
+    server.use(handlers.authHandler);
+    await client.authorize();
+
+    const estateId = 'FAKE_ESTATE_ID';
+    const reference = 'FAKE_REFERENCE';
+    const channelAccountId = 'FAKE_CHANNEL_ACCOUNT_ID';
+    const companyId = 'FAKE_COMPANY_ID';
+    const channelId = 'FAKE_CHANNEL_ID';
+
+    server.use(
+      rest.get(
+        'https://api.sweepbright.com/services/channel-references',
+        (req, res, ctx) => {
+          return res(
+            ctx.status(200),
+            ctx.json({
+              data: [
+                {
+                  reference_code: req.url.searchParams.get('reference_code'),
+                  company_id: req.url.searchParams.get('company_id'),
+                  channel_id: req.url.searchParams.get('channel_id'),
+                  estate_id: estateId,
+                  channel_account_id: channelAccountId,
+                },
+              ],
+            })
+          );
+        }
+      )
+    );
+
+    const result = await client.channels.resolveReferences(
+      channelId,
+      reference,
+      companyId
+    );
+    expect(result).toEqual({
+      data: [
+        {
+          reference_code: reference,
+          estate_id: estateId,
+          channel_account_id: channelAccountId,
+          channel_id: channelId,
+          company_id: companyId,
+        },
+      ],
+    });
+  });
+
+  it('it does not send a company_id when not set', async () => {
+    const client = createClient({
+      clientId: 'FAKE_ID',
+      clientSecret: 'FAKE_SECRET',
+    });
+    server.use(handlers.authHandler);
+    await client.authorize();
+
+    const estateId = 'FAKE_ESTATE_ID';
+    const reference = 'FAKE_REFERENCE';
+    const channelAccountId = 'FAKE_CHANNEL_ACCOUNT_ID';
+    const channelId = 'FAKE_CHANNEL_ID';
+
+    server.use(
+      rest.get(
+        'https://api.sweepbright.com/services/channel-references',
+        (req, res, ctx) => {
+          try {
+            expect(req.url.search).toEqual(
+              `?channel_id=${channelId}&reference_code=${reference}`
+            );
+          } catch (e) {
+            return res(ctx.status(500), ctx.json({ error: e }));
+          }
+
+          return res(
+            ctx.status(200),
+            ctx.json({
+              data: [
+                {
+                  reference_code: req.url.searchParams.get('reference_code'),
+                  company_id: 'FAKE',
+                  channel_id: req.url.searchParams.get('channel_id'),
+                  estate_id: estateId,
+                  channel_account_id: channelAccountId,
+                },
+              ],
+            })
+          );
+        }
+      )
+    );
+
+    await client.channels.resolveReferences(channelId, reference, undefined);
+  });
+});

package/src/__tests__/contacts.test.ts

@@ -0,0 +1,85 @@
+import { createClient } from '../';
+import { handlers, rest, server } from '../../mockServer';
+
+describe('contacts', () => {
+  it('requires authentication', async () => {
+    const client = createClient({
+      clientId: 'FAKE_ID',
+      clientSecret: 'FAKE_SECRET',
+    });
+
+    try {
+      await client.contacts.getOne({
+        contactId: 'foo',
+      });
+    } catch (err: any) {
+      expect(err.message).toEqual('client is not authenticated');
+    }
+  });
+
+  it('can fetch a contact', async () => {
+    const client = createClient({
+      clientId: 'FAKE_ID',
+      clientSecret: 'FAKE_SECRET',
+    });
+
+    server.use(handlers.authHandler);
+    await client.authorize();
+
+    const contactId = 'FAKE_CONTACT_ID';
+    server.use(
+      rest.get(
+        'https://api.sweepbright.com/services/contacts/:contactId',
+        (req, res, ctx) => {
+          return res(
+            ctx.status(200),
+            ctx.json({
+              data: {
+                id: req.params.contactId,
+              },
+            })
+          );
+        }
+      )
+    );
+
+    const result = await client.contacts.getOne({
+      contactId: contactId,
+    });
+
+    expect(result).toEqual({ data: { id: contactId } });
+  });
+
+  it('can fetch a contact with negotiators', async () => {
+    const client = createClient({
+      clientId: 'FAKE_ID',
+      clientSecret: 'FAKE_SECRET',
+    });
+
+    server.use(handlers.authHandler);
+    await client.authorize();
+
+    const contactId = 'FAKE_CONTACT_ID';
+    server.use(
+      rest.get(
+        'https://api.sweepbright.com/services/contacts/:contactId?includes=negotiators',
+        (req, res, ctx) => {
+          return res(
+            ctx.status(200),
+            ctx.json({
+              data: {
+                id: req.params.contactId,
+              },
+            })
+          );
+        }
+      )
+    );
+
+    const result = await client.contacts.getOneWithNegotiators({
+      contactId: contactId,
+    });
+
+    expect(result).toEqual({ data: { id: contactId } });
+  });
+});

package/src/__tests__/estates.test.ts

@@ -0,0 +1,50 @@
+import { createClient } from '../';
+import { handlers, rest, server } from '../../mockServer';
+
+describe('estates', () => {
+  it('requires authentication', async () => {
+    const client = createClient({
+      clientId: 'FAKE_ID',
+      clientSecret: 'FAKE_SECRET',
+    });
+    try {
+      await client.estates.getOne({
+        estateId: 'FAKE_ESTATE_ID',
+        companyId: 'FAKE_COMPANY_ID',
+      });
+    } catch (err) {
+      await expect((err as any).message).toEqual('client is not authenticated');
+    }
+  });
+
+  it('can fetch a estate', async () => {
+    const client = createClient({
+      clientId: 'FAKE_ID',
+      clientSecret: 'FAKE_SECRET',
+    });
+    server.use(handlers.authHandler);
+    await client.authorize();
+
+    const estateId = 'FAKE_ESTATE_ID';
+    server.use(
+      rest.get(
+        'https://api.sweepbright.com/services/estates/:estateId',
+        (req, res, ctx) => {
+          return res(
+            ctx.status(200),
+            ctx.json({
+              data: {
+                id: req.params.estateId,
+              },
+            })
+          );
+        }
+      )
+    );
+    const result = await client.estates.getOne({
+      estateId: estateId,
+      companyId: 'FAKE_COMPANY_ID',
+    });
+    expect(result).toEqual({ id: estateId });
+  });
+});

package/src/__tests__/leads.test.ts

@@ -0,0 +1,67 @@
+import { createClient } from '../';
+import { handlers, rest, server } from '../../mockServer';
+
+describe('leads', () => {
+  it('requires authentication', async () => {
+    const client = createClient({
+      clientId: 'FAKE_ID',
+      clientSecret: 'FAKE_SECRET',
+    });
+
+    try {
+      await client.leads.createLead({
+        firstName: 'foo',
+        lastName: 'bar',
+        propertyId: 'baz',
+        email: 'john@example.com',
+        phone: '999',
+        message: "I'm not authenticated",
+        portal: 'portal',
+      });
+    } catch (err: any) {
+      expect(err.message).toEqual('client is not authenticated');
+    }
+  });
+
+  it('can put a lead', async () => {
+    const client = createClient({
+      clientId: 'FAKE_ID',
+      clientSecret: 'FAKE_SECRET',
+    });
+
+    server.use(handlers.authHandler);
+    await client.authorize();
+
+    const lead = {
+      firstName: 'foo',
+      lastName: 'bar',
+      propertyId: 'PROPERTY_ID',
+      email: 'john@example.com',
+      phone: '999',
+      message: "I'm authenticated",
+      portal: 'portal',
+      location_preference: {
+        country: 'BR',
+        postal_codes: ['06010'],
+      },
+    };
+
+    server.use(
+      rest.put(
+        'https://api.sweepbright.com/estates/PROPERTY_ID/leads',
+        (_, res, ctx) => {
+          return res(
+            ctx.status(200),
+            ctx.json({
+              data: lead,
+            })
+          );
+        }
+      )
+    );
+
+    const result = await client.leads.createLead(lead);
+
+    expect(result).toEqual({ data: lead });
+  });
+});