@oauth2-cli/sky-api 0.1.1 → 0.2.0

package/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [0.2.0](https://github.com/battis/oauth2-cli/compare/sky-api/0.1.2...sky-api/0.2.0) (2025-03-09)
+
+### Features
+
+- **oauth2-cli:** detect and warn about reused localhost ports ([3431d84](https://github.com/battis/oauth2-cli/commit/3431d84d47251dd9fba47b23bbfd3dcf653fc7d3))
+
+### Bug Fixes
+
+- **sky-api:** limit excess subscription key copying ([e8a76c8](https://github.com/battis/oauth2-cli/commit/e8a76c814fe9bcbfb7de0ce3b40f7373b3e9787d))
+- **oauth2-configure:** remove redundant caching ([7294e6a](https://github.com/battis/oauth2-cli/commit/7294e6a7aec373f72abc7c9e7c2ce4c659e3cba5))
+
+## [0.1.2](https://github.com/battis/oauth2-cli/compare/sky-api/0.1.1...sky-api/0.1.2) (2025-03-08)
+
+### Features
+
+- **oauth2-cli:** export Credentials type for convenience ([f000b56](https://github.com/battis/oauth2-cli/commit/f000b56a587c021d64a294ff33d42fa3966afd38))
+
+### Bug Fixes
+
+- **sky-api:** update from deprecated TokenManager to Client ([3685ede](https://github.com/battis/oauth2-cli/commit/3685edeacd7d5d2b05e4259dcd6f2ae15babb74a))
+
 ## [0.1.1](https://github.com/battis/oauth2-cli/compare/sky-api/0.1.0...sky-api/0.1.1) (2025-03-06)
 
 ### Patch Changes

package/README.md

@@ -1,11 +1,11 @@
-# sky-oauth2-cli
+# @oauth2-cli/sky-api
 
 Acquire SKY API access tokens via OAuth 2.0 within CLI tools
 
 ## Install
 
 ```sh
-npm i sky-oauth2-cli
+npm i @oauth2-cli/sky-api
 ```
 
 ## Usage
@@ -14,7 +14,7 @@ Configure your SKY API app credentials somewhere relatively secure (e.g. your en
 
 ```ts
 import dotenv from 'dotenv';
-import { SkyAPI } from 'sky-oauth2-cli';
+import { SkyAPI } from '@oauth2-cli/sky-api';
 
 (async () => {
   dotenv.config();

package/dist/index.d.ts

@@ -1,17 +1,13 @@
 import { RequestInfo, RequestInit } from 'node-fetch';
-import * as oauth from 'oauth2-cli';
-export type SkyAPICredentials = {
-    client_id: string;
-    client_secret: string;
+import * as OAuth2 from 'oauth2-cli';
+export type Credentials = Omit<OAuth2.Credentials, 'authorization_endpoint' | 'token_endpoint'> & {
     subscription_key: string;
-    redirect_uri: string;
-    store?: oauth.TokenStorage | string;
 };
 export declare class SkyAPI {
-    private tokenManager;
+    private client;
     private token?;
     private subscription_key;
-    constructor(credentials: SkyAPICredentials);
-    getToken(): Promise<oauth.Token | undefined>;
+    constructor({ subscription_key, ...credentials }: Credentials);
+    getToken(): Promise<OAuth2.Token | undefined>;
     fetch(endpoint: URL | RequestInfo, init?: RequestInit): Promise<unknown>;
 }

package/dist/index.js

@@ -1,25 +1,22 @@
 // TODO replace node-fetch dependency with native fetch when bumping to node@>=21
 import nodeFetch from 'node-fetch';
-import * as oauth from 'oauth2-cli';
+import * as OAuth2 from 'oauth2-cli';
 const SUBSCRIPTION_HEADER = 'Bb-Api-Subscription-Key';
 export class SkyAPI {
-    tokenManager;
+    client;
     token;
     subscription_key;
-    constructor(credentials) {
-        this.tokenManager = new oauth.TokenManager({
-            client_id: credentials.client_id,
-            client_secret: credentials.client_secret,
-            redirect_uri: credentials.redirect_uri,
+    constructor({ subscription_key, ...credentials }) {
+        this.subscription_key = subscription_key;
+        this.client = new OAuth2.Client({
+            ...credentials,
             authorization_endpoint: 'https://app.blackbaud.com/oauth/authorize',
             token_endpoint: 'https://oauth2.sky.blackbaud.com/token',
-            headers: { [SUBSCRIPTION_HEADER]: credentials.subscription_key },
-            store: credentials.store
+            headers: { [SUBSCRIPTION_HEADER]: this.subscription_key }
         });
-        this.subscription_key = credentials.subscription_key;
     }
     async getToken() {
-        this.token = await this.tokenManager.getToken();
+        this.token = await this.client.getToken();
         return this.token;
     }
     async fetch(endpoint, init) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oauth2-cli/sky-api",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "keywords": [
     "blackbaud",
     "sky",
@@ -23,14 +23,14 @@
   "types": "./dist/index.d.ts",
   "dependencies": {
     "node-fetch": "^3.3.2",
-    "oauth2-cli": "0.1.3"
+    "oauth2-cli": "0.2.0"
   },
   "devDependencies": {
     "@tsconfig/node20": "^20.1.4",
     "commit-and-tag-version": "^12.5.0",
     "del-cli": "^6.0.0",
     "npm-run-all": "^4.1.5",
-    "typescript": "^5.7.2"
+    "typescript": "^5.8.2"
   },
   "scripts": {
     "clean": "del ./dist",

package/src/index.ts

@@ -1,37 +1,33 @@
 // TODO replace node-fetch dependency with native fetch when bumping to node@>=21
 import nodeFetch, { RequestInfo, RequestInit } from 'node-fetch';
-import * as oauth from 'oauth2-cli';
+import * as OAuth2 from 'oauth2-cli';
 
-export type SkyAPICredentials = {
-  client_id: string;
-  client_secret: string;
+export type Credentials = Omit<
+  OAuth2.Credentials,
+  'authorization_endpoint' | 'token_endpoint'
+> & {
   subscription_key: string;
-  redirect_uri: string;
-  store?: oauth.TokenStorage | string;
 };
 
 const SUBSCRIPTION_HEADER = 'Bb-Api-Subscription-Key';
 
 export class SkyAPI {
-  private tokenManager: oauth.TokenManager;
-  private token?: oauth.Token;
+  private client: OAuth2.Client;
+  private token?: OAuth2.Token;
   private subscription_key: string;
 
-  public constructor(credentials: SkyAPICredentials) {
-    this.tokenManager = new oauth.TokenManager({
-      client_id: credentials.client_id,
-      client_secret: credentials.client_secret,
-      redirect_uri: credentials.redirect_uri,
+  public constructor({ subscription_key, ...credentials }: Credentials) {
+    this.subscription_key = subscription_key;
+    this.client = new OAuth2.Client({
+      ...credentials,
       authorization_endpoint: 'https://app.blackbaud.com/oauth/authorize',
       token_endpoint: 'https://oauth2.sky.blackbaud.com/token',
-      headers: { [SUBSCRIPTION_HEADER]: credentials.subscription_key },
-      store: credentials.store
+      headers: { [SUBSCRIPTION_HEADER]: this.subscription_key }
     });
-    this.subscription_key = credentials.subscription_key;
   }
 
   public async getToken() {
-    this.token = await this.tokenManager.getToken();
+    this.token = await this.client.getToken();
     return this.token;
   }