@sweepbright/api-client 0.30.4 → 0.30.6

package/.devcontainer/devcontainer.json

@@ -1,59 +0,0 @@
-// 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

@@ -1,11 +0,0 @@
-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

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

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,40 +0,0 @@
-### 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

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

package/.prettierignore

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

package/jest.config.js

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

package/mockServer.ts

@@ -1,44 +0,0 @@
-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/setupTests.ts

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

package/src/__tests__/auth.test.ts

@@ -1,14 +0,0 @@
-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

@@ -1,104 +0,0 @@
-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

@@ -1,85 +0,0 @@
-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

@@ -1,50 +0,0 @@
-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

@@ -1,67 +0,0 @@
-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 });
-  });
-});

package/src/common/currencies.ts

@@ -1,50 +0,0 @@
-export enum Currency {
-  EUR = 'EUR',
-  AUD = 'AUD',
-  USD = 'USD',
-  AFN = 'AFN',
-  GBP = 'GBP',
-  XPF = 'XPF',
-  MXN = 'MXN',
-  PHP = 'PHP',
-  CAD = 'CAD',
-  RON = 'RON',
-  BRL = 'BRL',
-  UYU = 'UYU',
-  HRK = 'HRK',
-  GEL = 'GEL',
-  RSD = 'RSD',
-  ILS = 'ILS',
-  ARS = 'ARS',
-  NZD = 'NZD',
-  ZAR = 'ZAR',
-  INR = 'INR',
-  DZD = 'DZD',
-  LKR = 'LKR',
-  CLP = 'CLP',
-  ALL = 'ALL',
-  RUB = 'RUB',
-  TRY = 'TRY',
-  UAH = 'UAH',
-  MUR = 'MUR',
-  COP = 'COP',
-  AED = 'AED',
-  MZN = 'MZN',
-  EGP = 'EGP',
-  AOA = 'AOA',
-  XOF = 'XOF',
-  CNY = 'CNY',
-  XCD = 'XCD',
-  VND = 'VND',
-  JPY = 'JPY',
-  MAD = 'MAD',
-  CHF = 'CHF',
-  IRR = 'IRR',
-  KHR = 'KHR',
-  XAF = 'XAF',
-  AMD = 'AMD',
-  ETB = 'ETB',
-  SGD = 'SGD',
-  NGN = 'NGN',
-  PKP = 'PKP',
-}

package/src/common/types.ts

@@ -1 +0,0 @@
-export type Maybe<T> = T | null | undefined;