diff --git a/CHANGELOG.md b/CHANGELOG.md index 4a0c381..a4e387d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,39 +4,16 @@ All notable changes to this project will be documented in this file. Dates are d Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog). -#### [v1.0.0](https://github.com/opengovsg/sgid-client/compare/v0.0.12...v1.0.0) +#### [v1.0.1](https://github.com/opengovsg/sgid-client/compare/v1.0.0...v1.0.1) -**BREAKING CHANGES** +- fix: constructor optional types [`073a814`](https://github.com/opengovsg/sgid-client/commit/073a814fce5fa25c4d4683c701c7e6ab3d4dbbe2) -- `SgidClient` constructor now accepts optional `hostname` and `apiVersion` params instead of required `endpoint` param +### [v1.0.0](https://github.com/opengovsg/sgid-client/compare/v0.0.12...v1.0.0) -Before: +> 11 May 2022 -```typescript -endpoint: 'https://api.id.gov.sg/v1/oauth' -``` - -After: - -```typescript -hostname: 'https://api.id.gov.sg', // default -apiVersion: 1 // default -``` - -- `authorizationUrl` and `callback` functions now accepts optional `redirectUrl` to override redirect url. -- Removal of the following functions: `createJWT` and `verifyJWT`. Import `jsonwebtoken` directly if you require them. -- `decodeIdToken` and `getRedirectUri` are now private functions - -##### Other changes - -- Replaced `node-jose` library with `jose` for better performance. - Ref: https://github.com/panva/jose#how-is-it-different-from-node-jose - -##### Commits - -- chore: migrate to jose, update implementation [`d29ca28`](https://github.com/opengovsg/sgid-client/commit/d29ca28671bcb256981b4c187cb20941fc83f7b5) -- chore: allow backward compatibility with pkcs1 keys [`efb9bb3`](https://github.com/opengovsg/sgid-client/commit/efb9bb3b0c533140f5243a457f24698b249b1f8f) -- doc: update readme [`8051d29`](https://github.com/opengovsg/sgid-client/commit/8051d29c6861a802b1a80c7a8f7168b1f7331bd0) +- Version 1.0.0 [`#6`](https://github.com/opengovsg/sgid-client/pull/6) +- chore: npm audit fix [`03b42cc`](https://github.com/opengovsg/sgid-client/commit/03b42cc6e2e9fd6fad71d22d48aa00e4c0a92147) #### [v0.0.12](https://github.com/opengovsg/sgid-client/compare/v0.0.11...v0.0.12) diff --git a/package-lock.json b/package-lock.json index 85a6784..8c8ba4c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@opengovsg/sgid-client", - "version": "1.0.0", + "version": "1.0.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@opengovsg/sgid-client", - "version": "1.0.0", + "version": "1.0.1", "license": "MIT", "dependencies": { "jose": "4.8.1", diff --git a/package.json b/package.json index 53c777a..3128c47 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@opengovsg/sgid-client", - "version": "1.0.0", + "version": "1.0.1", "description": "The official TypeScript/JavaScript SDK for sgID", "main": "dist/index.js", "types": "dist/index.d.ts",