Skip to content

Latest commit

 

History

History
174 lines (125 loc) · 4.9 KB

README.md

File metadata and controls

174 lines (125 loc) · 4.9 KB
Raw

Test, Lint & Deploy NPM Version affinity-node

Node module for the Affinity CRM.

Supports both V1 and V2 of the Affinity API.

This module is incomplete for V1; not all API endpoints are implemented. It is in active development and the API might change without notice. Contributions welcome.

Usage

import { Affinity } from '@planet-a/affinity-node/v1'

const { user } = await new Affinity(YOUR_API_KEY).auth.whoAmI()
console.log(`Hello ${user.firstName}`)

Have a look at the autogenerated docs for examples, etc.

API completeness

V1

V2

V2 is generated via OpenAPITools/openapi-generator.

The command:

nix develop --command deno task generate-v2-client

will generate an OpenAPI client for Node in Typescript.

Sample usage:

import { AuthApi, createConfiguration } from '@planet-a/affinity-node/v2'

const config = createConfiguration({
    authMethods: {
        bearerAuth: {
            tokenProvider: {
                getToken: async () => Promise.resolve('API_KEY'),
            },
        },
    },
})
const authApi = new ObjectAuthApi(config)
const { tenant } = await authApi.getV2AuthWhoami()
console.log(tenant.name)

An up-to-date OpenAPI spec can be downloaded from here. Drop it into ./openapi before you run the command above (remove the old version beforehand).

Paging

This module comes with a pagination helper for the V2 API. Sample usage:

import { CompaniesApi, helpers } from '@planet-a/affinity-node/v2'
const { paginator: { paginated } } = helpers

const companiesApi = new CompaniesApi(config)

for await (
    const page of paginated(
        companiesApi.getV2Companies.bind(companiesApi),
    )({
        limit: 10,
    })
) {
    // Fetch 10 companies at a time, print, repeat
    console.log(page)
}

Similar projects

Development

Note on deno: This repository is using Deno heavily for anything dev-related. The resulting node package is meant to be agnostic of the runtime used, so there shouldn't be any deno-specific references. For the tests, etc. Deno-specific APIs, libraries and imports may be used.

  1. Install nix
  2. Run nix develop
  3. Run any deno task, e.g. deno task test

Hint: you can do a live run via API_KEY=<your-api-key> deno task snapshot-update to update snapshots from your actual Affinity instance during development.

⚠️ Make sure you do not commit any unsanitized data.

Direnv

This repo is direnv-enabled. If you have Nix and direnv on your system, you can ignore any nix develop --command prefixes and just work in the folder as if you were inside the nix flake environment. This is the recommended way, as it greatly simplifies the handling of dev tasks and pre-commit checks.

Commands

Build the library

  1. nix develop --command deno task build

Run tests with coverage

  1. nix develop --command deno task test:coverage

Format code

  1. nix develop --command deno task format

Lint code

  1. nix develop --command deno task lint

Generate documentation

  1. nix develop --command deno task docs
  2. open ./docs/index.html

Style

  • File names are snake_case
  • Symbols are camelCase
  • Symbols inherited from the Affinity API documentation, such as path and query parameters adopt the API documentation style, snake_case
  • Enum values are SNAKE_UPPERCASE

Commits

This repo follows the conventional commits format. Run nix develop --command cz commit after staging some changes to be guided through the process if you're unfamiliar with it.

Pre commit hooks

Pre-commit hooks are managed by Nix. Once you run your commit, it will analyze the changes and run required hooks.