@pod-point/rfid-api-js

Pod Point RFID API SDK (JS)

A JavaScript wrapper for the Pod Point RFID API built with TypeScript.

Installation

To install this package, run the following command:

npm install --save @pod-point/rfid-api-js

Usage

This package contains a client, repositories, services, models and factories.

Client

First, you will want to create a new client instance.

// path/to/client.js
import { Client } from '@pod-point/rfid-api-js';

const client = new Client(userAgent, domain, prefix);

Repositories & Services

Next, you can start creating and using repository and service instances with the client you have just created.

// path/to/anywhere.js
import { CardRepository } from '@pod-point/rfid-api-js';
import client from 'path/to/client';

const cardRepository = new CardRepository(client);

Factories

Lastly, you can use the factories to create fake resources.

import { CardFactory } from '@pod-point/rfid-api-js';

const cardFactory = new CardFactory();
const fakeCard = cardFactory.make();

Development

Testing

This package uses jest. To run the test suites for this project, run the following command:

npm run test

Releases

This package is distributed via NPM and published automatically by Travis when creating a tagged commit. This can be done in one of 2 ways:

1. Pre-merge via the CLI

Before merging your PR following code review & QA, run the following commands to update the package version and create a new release/tag.

npm version <major|minor|patch|prerelease>
git push && git push --tags

If you forget to do this before merging, this is not a problem, just create a new branch from master and run these same commands, remembering to open and merge a PR for this branch so that the package.json file is updated, alternatively, see option 2.

2. Post-merge via code & GitHub

After merging your code changes, create a new branch/PR from master and update the package version in package.json to whatever you wish the next release to be.

Before merging this PR, create a release via GitHub with a tag version to match this package version number, this will trigger the tagged commit and in turn the automatic deployment to NPM.