SDKore

Install

yarn add sdkore

Commands

# Build src
yarn build

# Test src
yarn test

# Generate doc
yarn doc

# Lint code (--fix to auto fix)
yarn lint

# Build examples
yarn build:examples

Usage

See examples folder for common usage.

Upgrade

Be sure to check any changes in the Upgrade doc

Contribution

Please see the Contribution guide

Changelog

Please see the Changelog file

Roadmap

1.0.0

• Documentation
• Tests
• AbstractAccessor
• AbstractCombinedAccessor
• Custom header management (token customer, pagination)
• Image upload (customer image)
• Criteria management (findByLabel > findByCriteria({label: 'whatever'}))
• Sort, search, filter management
• Better PSR-16 like cache adapters
• Better error handling
• Auto generated code doc
• Pagination

1.21.x - API Sync

• Cache Request System
• Cancellable requests
• Better annotations
• Any resource identifier support (id, uuid, etc..)

1.22.x

• Simple CachePolicy
• API token in Client constructor

2.0.0

• Split business logic and go open source
• Monorepo
• SDK base + SDK Plugin

Next

• Functional tests
• Business Layer Plugin
• Server fallback (+ business layer fallback) (+ websocket fallback)
• Change request mocker from nock to sinon