@boulevard/blvd-book-sdk - npm Package Compare versions

Comparing version 1.0.30 to 1.0.32

package.json

 {
   "name": "@boulevard/blvd-book-sdk",
-  "version": "1.0.30",
+  "version": "1.0.32",
   "description": "A JS client for the Boulevard API",
@@ -50,3 +50,3 @@ "main": "lib/blvd.js",
     "typedoc": "^0.20.36",
-    "typescript": "^4.5.5"
+    "typescript": "~4.2.3"
   },
@@ -53,0 +53,0 @@ "dependencies": {

README.md

@@ -1,7 +0,36 @@
-# Blvd Book SDK
+[![TypeScript](https://badgen.net/badge/icon/typescript?icon=typescript&label)](https://typescriptlang.org)
+[![GitHub license](https://img.shields.io/github/license/Boulevard/book-sdk)](https://github.com/Boulevard/book-sdk/blob/master/LICENSE.md)
+[![GitHub release](https://img.shields.io/github/release/Boulevard/book-sdk)](https://github.com/Boulevard/book-sdk/releases/)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/Boulevard/book-sdk/compare)
 
-Boulevard is an intelligent scheduling solution and comprehensive point of sale system that increases revenue and lowers costs for salons, spas, and other appointment-based businesses.
+<div align="center">
+  <h2 align="center">Boulevard Book Software Development Kit</h2>
 
-Use this SDK to create your own custom booking experiences for Boulevard.
+  <p align="center">
+    <a href="https://github.com/Boulevard/book-sdk/issues">Report a Bug</a>
+    ·
+    <a href="https://github.com/Boulevard/book-sdk/issues">Request a Feature</a>
+  </p>
+</div>
 
+
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li><a href="#getting-started">Getting Started</a></li>
+    <li><a href="#documentation">Documentation</a></li>
+    <li><a href="#development">Development</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#issues">Issues</a></li>
+  </ol>
+</details>
+
+<hr />
+
+## About the project
+
+[Boulevard](https://joinblvd.com) is an intelligent scheduling solution and comprehensive point of sale system that increases revenue and lowers costs for salons, spas, and other appointment-based businesses. 
+
+With this software development kit (SDK) you can create your own custom booking experiences for your business using Boulevard.
+
 ## Getting Started
@@ -11,3 +40,3 @@
 
-Head over to the [Boulevard Developer Portal](https://developers.joinblvd.com/getting-started/introduction) to get set up with a sandbox account and API application. You'll need your business ID and and API key to use this package:
+Head over to the [Boulevard Developer Portal](https://developers.joinblvd.com/getting-started/introduction) to get set up with a sandbox account and API application. You'll need your business ID and and API key to use this package.
 
@@ -22,5 +51,9 @@ ```js
 ```sh
-yarn -D add @boulevard/blvd-book-sdk
+npm --save install @boulevard/blvd-book-sdk
 ```
 
+```sh
+yarn add @boulevard/blvd-book-sdk
+```
+
 ### Client-Side
@@ -73,3 +106,8 @@
 
+## Documentation
 
+Package documentation is available [here](https://boulevard.github.io/book-sdk/index.html).
+
+To see available API operations browse the methods tied to class definitions. [Example - Cart operations](https://boulevard.github.io/book-sdk/classes/carts.cart.html)
+
 ## Development
@@ -84,8 +122,28 @@
 
+```
+yarn run gen
+```
+
 ### Run tests
 
+To be able to run tests you need `ts-node` installed globaly 
+
 ```
+npm -g install ts-node
+```
+
+```
+yarn global add ts-node
+```
+
+Then you can run the tests.
+
+```
 npm test
 ```
 
+```
+yarn test
+```
+
 ### Deployment
@@ -102,2 +160,9 @@
 
-Then Commit and push (inc tags).
+Then Commit and push (inc tags).
+
+## Contributing
+Pull requests are welcome. See the [contribution guidelines](https://github.com/Boulevard/book-sdk/blob/master/CONTRIBUTING.md) for more information.
+
+## Issues
+
+If you encounter any problems while trying to run the starter kit please create an issue.

tests/integration.test.ts

@@ -16,9 +16,7 @@ import { Blvd } from "../src/blvd";
 } from "../src/cart";
-import { Client } from "../src/clients";
 import { Location } from "../src/locations";
-import { Authentication } from "../src/platformClient";
 import { createHmac } from "crypto";
 
 const businessId = "63b60ecb-6d1e-4bb6-87ad-3cb52ffe09b4";
-const apiKey = "eb053fc4-e087-48ae-bc8f-3107ff06ddcb";
+const apiKey = process.env.SANDBOX_API_KEY;
 const anon = new Blvd(apiKey, businessId);
@@ -25,0 +23,0 @@

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

SPDX disjunction

License

SPDX disjunction for an artifact's license information

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

SPDX disjunction

License

SPDX disjunction for an artifact's license information

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

No License Found

License

(Experimental) License information could not be found

Found 1 instance in 1 package

Improved metrics

Number of low license alerts

1

decreased by-50%

Number of lines in readme file

164

increased by67.35%

Number of low supply chain risk alerts

0

decreased by-100%

Number of medium supply chain risk alerts

2

decreased by-83.33%

Worsened metrics

Total package byte prevSize

21223

decreased by-98.71%

Number of package files

9

decreased by-74.29%

Lines of code

272

decreased by-98.97%

No dependency changes