bookmark-client
v0.1.7
Published
A JS client SDK that manages API calls to bookmark
Downloads
5
Readme
Bookmark Client
A JS client SDK that manages API calls to bookmark
Getting Started
npm install
npm start
docker-compose build --no-cache
docker-compose up
will provide an interface in which to test the various endpoints
local.cuisineactuelle.fr should be mapped to 127.0.0.1 in hosts file on local machine
Prerequisites
Docker is required for client interface
docker, node
Installing
Builds the dev server (allows for proxy from webpack dev server with port to domain name - local.cuisineactuelle.fr)
docker-compose build --no-cache
docker-compose up
This will start the dev server and run npm start
from within docker
Usage
Via SCDS in a project or via npm (although this might make more work for future updates)
Arguments
brand
required A 3 letter string denoting a site brand for example cac
, geo
, fac
, gal
environment
required must resolve to either dev
or recette
in order to call the recette
subdomain of the Bookmark
version
required an integer > 2 as 2.0 is the minimum version supported
connectionObj
required
const isConnected = pmcstarter.isConnected()
const pmcConnection = {
isConnected,
jwt: isConnected && pmcstarter.getJwtCookie() ? pmcstarter.getJwtCookie() : null
}
Available Methods
getBookmarks (type, offset, limit)
Returns: Promise
postBookmark (type, contentId)
Returns: Promise
deleteBookmark (type, contentId)
Returns: Promise
getTopBookmarks (type = 'bookmark', offset = 0, limit = 10)
Returns: Promise
getBookmarkers (type = 'bookmark', ids)
Returns: Promise
getStatus (ids)
Returns: Promise
getStats ()
Returns: Promise
getContents (ids)
Returns: Promise
getCount (ids)
Returns: Promise
migrateAlertBookmarks ()
Returns: Promise
Testing
Linting is currently available npm run lint
or npm run format
to fix automatic errors.
Other testing and auditing is on its way...
Deployment
SCDS
Built With
Webpack
Contributing
PR's welcome