@oauth2-cli/sky-api 0.3.2 → 0.4.1

package/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 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.4.1](https://github.com/groton-school/myschoolapp-reporting/compare/oauth2-cli/sky-api/0.4.0...oauth2-cli/sky-api/0.4.1) (2026-01-15)
+
+
+### Bug Fixes
+
+* further reorg of internals ([adc4330](https://github.com/groton-school/myschoolapp-reporting/commit/adc4330a346c7547be2e702730e2bcb510873b4c))
+
+## [0.4.0](https://github.com/groton-school/myschoolapp-reporting/compare/oauth2-cli/sky-api/0.3.2...oauth2-cli/sky-api/0.4.0) (2026-01-15)
+
+
+### ⚠ BREAKING CHANGES
+
+* pre-registered plugin is ESM module, updated option arg names
+
+### Features
+
+* compile against Node.js v24 (current active version) ([dc67440](https://github.com/groton-school/myschoolapp-reporting/commit/dc6744054bc42139c4d17b1aca2ef9b057827f7f))
+
+
+### Bug Fixes
+
+* pre-registered plugin is ESM module, updated option arg names ([50ff079](https://github.com/groton-school/myschoolapp-reporting/commit/50ff079a5849ccc30c41e86d7b1d72d340fe9b87))
+
 ## [0.3.2](https://github.com/groton-school/myschoolapp-reporting/compare/oauth2-cli/sky-api/0.3.1...oauth2-cli/sky-api/0.3.2) (2026-01-04)
 
 

package/dist/Client.d.ts

@@ -1,19 +1,9 @@
 import * as OAuth2 from '@oauth2-cli/qui-cli/dist/OAuth2.js';
-import * as Plugin from '@qui-cli/plugin';
-type SkyConfiguration = {
-    subscription_key?: string;
-    subscriptionKeyEnvVar: string;
-};
 export type Credentials = OAuth2.Credentials & {
     subscription_key: string;
 };
-export type Configuration = OAuth2.Configuration & SkyConfiguration;
-export type ConfigurationProposal = OAuth2.ConfigurationProposal & Partial<SkyConfiguration>;
-export declare class Client extends OAuth2.OAuth2 {
-    private skyConfig;
-    constructor(name?: string);
-    configure({ subscription_key, subscriptionKeyEnvVar, ...proposal }?: ConfigurationProposal): void;
-    options(): Plugin.Options;
-    init({ values }: Plugin.ExpectedArguments<typeof this.options>): Promise<void>;
+export declare class Client extends OAuth2.Client {
+    private subscription_key;
+    constructor({ subscription_key, ...credentials }: Credentials);
+    request(...args: Parameters<OAuth2.Client['request']>): Promise<Response>;
 }
-export {};

package/dist/Client.js

@@ -1,59 +1,13 @@
 import * as OAuth2 from '@oauth2-cli/qui-cli/dist/OAuth2.js';
-import { Colors } from '@qui-cli/colors';
-import { Env } from '@qui-cli/env-1password';
-export class Client extends OAuth2.OAuth2 {
-    skyConfig = {
-        subscriptionKeyEnvVar: 'SKY_SUBSCRIPTION_KEY'
-    };
-    constructor(name = '@oauth2-cli/sky-api') {
-        super(name);
-        super.configure({
-            authorization_endpoint: 'https://app.blackbaud.com/oauth/authorize',
-            token_endpoint: 'https://oauth2.sky.blackbaud.com/token',
-            env: {
-                client_id: 'SKY_CLIENT_ID',
-                client_secret: 'SKY_CLIENT_SECRET',
-                redirect_uri: 'SKY_REDIRECT_URI',
-                token_path: 'SKY_TOKEN_PATH',
-                access_token: 'SKY_ACCESS_TOKEN'
-            },
-            man: { heading: 'Sky API options' },
-            suppress: {
-                authorizationEndpoint: true,
-                tokenEndpoint: true,
-                tokenPath: true
-            }
-        });
-    }
-    configure({ subscription_key, subscriptionKeyEnvVar, ...proposal } = {}) {
-        super.configure(proposal);
-        this.skyConfig.subscription_key =
-            subscription_key || this.skyConfig.subscription_key;
-        this.skyConfig.subscriptionKeyEnvVar =
-            subscriptionKeyEnvVar || this.skyConfig.subscriptionKeyEnvVar;
-    }
-    options() {
-        const options = super.options();
-        options.opt = {
-            ...options.opt,
-            subscriptionKey: {
-                description: `Blackbaud subscription access key; will use environment ` +
-                    `variable ${Colors.varName(this.skyConfig.subscriptionKeyEnvVar)} ` +
-                    `if present`,
-                secret: true,
-                default: this.skyConfig.subscription_key
-            }
-        };
-        return options;
-    }
-    async init({ values }) {
-        const { subscriptionKey: subscription_key = await Env.get({
-            key: this.skyConfig.subscriptionKeyEnvVar
-        }) } = values;
-        this.configure({
-            subscription_key,
-            ...values,
-            headers: { 'Bb-Api-Subscription-Key': this.skyConfig.subscription_key }
-        });
+export class Client extends OAuth2.Client {
+    subscription_key;
+    constructor({ subscription_key, ...credentials }) {
+        super(credentials);
+        this.subscription_key = subscription_key;
+    }
+    request(...args) {
+        const [url, method, body, headers = new Headers(), dPoPOptions] = args;
+        headers.set('Bb-Api-Subscription-Key', this.subscription_key);
+        return super.request(url, method, body, headers, dPoPOptions);
     }
 }

package/dist/Module.d.ts

@@ -0,0 +1,13 @@
+import { SkyAPIPlugin } from './SkyAPI.js';
+export * from './SkyAPI.js';
+declare const sky: SkyAPIPlugin;
+export declare const name: string;
+export declare const configure: ({ subscription_key, subscriptionKeyEnvVar, ...proposal }?: import("./SkyAPI.js").ConfigurationProposal) => void;
+export declare const options: () => import("@qui-cli/plugin").Options;
+export declare const init: ({ values }: import("@qui-cli/plugin").ExpectedArguments<typeof this.options>) => Promise<void>;
+export declare const getToken: typeof sky.getToken;
+export declare const getClient: typeof sky.getClient;
+export declare const request: typeof sky.request;
+export declare const requestJSON: typeof sky.requestJSON;
+export declare const fetch: typeof sky.fetch;
+export declare const fetchJSON: typeof sky.fetchJSON;

package/dist/Module.js

@@ -0,0 +1,13 @@
+import { SkyAPIPlugin } from './SkyAPI.js';
+export * from './SkyAPI.js';
+const sky = new SkyAPIPlugin();
+export const name = sky.name;
+export const configure = sky.configure.bind(sky);
+export const options = sky.options.bind(sky);
+export const init = sky.init.bind(sky);
+export const getToken = sky.getToken.bind(sky);
+export const getClient = sky.getClient.bind(sky);
+export const request = sky.request.bind(sky);
+export const requestJSON = sky.requestJSON.bind(sky);
+export const fetch = sky.fetch.bind(sky);
+export const fetchJSON = sky.fetchJSON.bind(sky);

package/dist/Paginated.js

@@ -1,4 +1,4 @@
-import { Client } from './SkyAPI.js';
+import * as Client from './Module.js';
 export class Paginated {
     data;
     constructor(data) {

package/dist/SkyAPI.d.ts

@@ -1,3 +1,20 @@
-import { Client as C } from './Client.js';
-export declare const Client: C;
+import * as OAuth2 from '@oauth2-cli/qui-cli/dist/OAuth2.js';
+import * as Plugin from '@qui-cli/plugin';
+import { Client } from './Client.js';
+export { EnvironmentStorage, FileStorage, TokenStorage } from '@oauth2-cli/qui-cli/dist/OAuth2.js';
+export * from './Client.js';
 export * as school from './school/index.js';
+type SkyConfiguration = {
+    subscription_key?: string;
+    subscriptionKeyEnvVar: string;
+};
+export type Configuration = OAuth2.Configuration & SkyConfiguration;
+export type ConfigurationProposal = OAuth2.ConfigurationProposal & Partial<SkyConfiguration>;
+export declare class SkyAPIPlugin extends OAuth2.OAuth2Plugin<Client> {
+    private skyConfig;
+    constructor(name?: string);
+    configure({ subscription_key, subscriptionKeyEnvVar, ...proposal }?: ConfigurationProposal): void;
+    options(): Plugin.Options;
+    init({ values }: Plugin.ExpectedArguments<typeof this.options>): Promise<void>;
+    protected instantiateClient(credentials: OAuth2.Credentials): Client;
+}

package/dist/SkyAPI.js

@@ -1,3 +1,77 @@
-import { Client as C } from './Client.js';
-export const Client = new C();
+import * as OAuth2 from '@oauth2-cli/qui-cli/dist/OAuth2.js';
+import { Colors } from '@qui-cli/colors';
+import { Env } from '@qui-cli/env-1password';
+import { Client } from './Client.js';
+export { EnvironmentStorage, FileStorage } from '@oauth2-cli/qui-cli/dist/OAuth2.js';
+export * from './Client.js';
 export * as school from './school/index.js';
+export class SkyAPIPlugin extends OAuth2.OAuth2Plugin {
+    skyConfig = {
+        subscriptionKeyEnvVar: 'SKY_SUBSCRIPTION_KEY'
+    };
+    constructor(name = '@oauth2-cli/sky-api') {
+        super(name);
+        super.configure({
+            authorization_endpoint: 'https://app.blackbaud.com/oauth/authorize',
+            token_endpoint: 'https://oauth2.sky.blackbaud.com/token',
+            opt: {
+                clientId: 'skyClientId',
+                clientSecret: 'skyClientSecret',
+                redirectUri: 'skyRedirectUri'
+            },
+            env: {
+                clientId: 'SKY_CLIENT_ID',
+                clientSecret: 'SKY_CLIENT_SECRET',
+                redirectUri: 'SKY_REDIRECT_URI',
+                tokenPath: 'SKY_TOKEN_PATH',
+                accessToken: 'SKY_ACCESS_TOKEN'
+            },
+            man: { heading: 'Sky API options' },
+            suppress: {
+                authorizationEndpoint: true,
+                tokenEndpoint: true,
+                tokenPath: true,
+                accessToken: true
+            }
+        });
+    }
+    configure({ subscription_key, subscriptionKeyEnvVar, ...proposal } = {}) {
+        super.configure(proposal);
+        this.skyConfig.subscription_key =
+            subscription_key || this.skyConfig.subscription_key;
+        this.skyConfig.subscriptionKeyEnvVar =
+            subscriptionKeyEnvVar || this.skyConfig.subscriptionKeyEnvVar;
+    }
+    options() {
+        const options = super.options();
+        options.opt = {
+            ...options.opt,
+            subscriptionKey: {
+                description: `Blackbaud subscription access key; will use environment ` +
+                    `variable ${Colors.varName(this.skyConfig.subscriptionKeyEnvVar)} ` +
+                    `if present`,
+                secret: true,
+                default: this.skyConfig.subscription_key
+            }
+        };
+        return options;
+    }
+    async init({ values }) {
+        const { subscriptionKey: subscription_key = await Env.get({
+            key: this.skyConfig.subscriptionKeyEnvVar
+        }) } = values;
+        this.configure({
+            subscription_key,
+            ...values
+        });
+    }
+    instantiateClient(credentials) {
+        if (!this.skyConfig.subscription_key) {
+            throw new Error('No subscription access key is defined.');
+        }
+        return new Client({
+            subscription_key: this.skyConfig.subscription_key,
+            ...credentials
+        });
+    }
+}

package/dist/index.d.ts

@@ -1 +1,2 @@
-export * as SkyAPI from './SkyAPI.js';
+import * as SkyAPI from './Module.js';
+export { SkyAPI };

package/dist/index.js

@@ -1,4 +1,4 @@
 import { register } from '@qui-cli/plugin';
-import { Client } from './SkyAPI.js';
-export * as SkyAPI from './SkyAPI.js';
-await register(Client);
+import * as SkyAPI from './Module.js';
+export { SkyAPI };
+await register(SkyAPI);

package/dist/school/v1/academics/sections/assignments/assignmentsBySection.d.ts

@@ -1,5 +1,5 @@
+import * as SkyAPI from '../../../../../Module.js';
 import { Paginated } from '../../../../../Paginated.js';
-import * as SkyAPI from '../../../../../SkyAPI.js';
 type Options = {
     types?: string;
     status?: '0' | '1' | '2' | '-1';

package/dist/school/v1/academics/sections/assignments/assignmentsBySection.js

@@ -1,6 +1,6 @@
 import { buildQuery } from '../../../../../buildQuery.js';
+import * as SkyAPI from '../../../../../Module.js';
 import { Paginated } from '../../../../../Paginated.js';
-import * as SkyAPI from '../../../../../SkyAPI.js';
 export async function assignmentsBySection(section_id, params = {}) {
-    return new Paginated(await SkyAPI.Client.requestJSON(`https://api.sky.blackbaud.com/school/v1/academics/sections/${section_id}/assignments?${buildQuery(params)}`));
+    return new Paginated(await SkyAPI.requestJSON(`https://api.sky.blackbaud.com/school/v1/academics/sections/${section_id}/assignments?${buildQuery(params)}`));
 }

package/dist/school/v1/contentmanagement/announcements/index.d.ts

@@ -1,5 +1,5 @@
+import * as SkyAPI from '../../../../Module.js';
 import { Paginated } from '../../../../Paginated.js';
-import * as SkyAPI from '../../../../SkyAPI.js';
 import { ContentManagementRequest } from '../ContentManagementRequest.js';
 export * from './ContentAnnouncement.js';
 export * from './ContentAnnouncementCategory.js';

package/dist/school/v1/contentmanagement/announcements/index.js

@@ -1,11 +1,11 @@
+import * as SkyAPI from '../../../../Module.js';
 import { Paginated } from '../../../../Paginated.js';
-import * as SkyAPI from '../../../../SkyAPI.js';
 export * from './ContentAnnouncement.js';
 export * from './ContentAnnouncementCategory.js';
 export * from './ContentAnnouncementCategoryCollection.js';
 export async function categories() {
-    return new Paginated(await SkyAPI.Client.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/announcements/categories'));
+    return new Paginated(await SkyAPI.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/announcements/categories'));
 }
 export async function list(request) {
-    return SkyAPI.Client.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/announcements/list', 'POST', JSON.stringify(request), new Headers({ 'Content-Type': 'application/json' }));
+    return SkyAPI.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/announcements/list', 'POST', JSON.stringify(request), new Headers({ 'Content-Type': 'application/json' }));
 }

package/dist/school/v1/contentmanagement/news/index.d.ts

@@ -1,5 +1,5 @@
+import * as SkyAPI from '../../../../Module.js';
 import { Paginated } from '../../../../Paginated.js';
-import * as SkyAPI from '../../../../SkyAPI.js';
 import { ContentManagementRequest } from '../ContentManagementRequest.js';
 export * from './NewsCategory.js';
 export * from './NewsCategoryCollection.js';

package/dist/school/v1/contentmanagement/news/index.js

@@ -1,11 +1,11 @@
+import * as SkyAPI from '../../../../Module.js';
 import { Paginated } from '../../../../Paginated.js';
-import * as SkyAPI from '../../../../SkyAPI.js';
 export * from './NewsCategory.js';
 export * from './NewsCategoryCollection.js';
 export * from './NewsItem.js';
 export async function categories() {
-    return new Paginated(await SkyAPI.Client.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/news/categories'));
+    return new Paginated(await SkyAPI.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/news/categories'));
 }
 export async function list(request) {
-    return await SkyAPI.Client.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/news/list', 'POST', JSON.stringify(request), new Headers({ 'Content-Type': 'application/json' }));
+    return await SkyAPI.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/news/list', 'POST', JSON.stringify(request), new Headers({ 'Content-Type': 'application/json' }));
 }

package/dist/school/v1/contentmanagement/photoalbums/index.d.ts

@@ -1,5 +1,5 @@
+import * as SkyAPI from '../../../../Module.js';
 import { Paginated } from '../../../../Paginated.js';
-import * as SkyAPI from '../../../../SkyAPI.js';
 import { ContentManagementRequest } from '../ContentManagementRequest.js';
 export * from './ImageDimension.js';
 export * from './ImageSettings.js';

package/dist/school/v1/contentmanagement/photoalbums/index.js

@@ -1,5 +1,5 @@
+import * as SkyAPI from '../../../../Module.js';
 import { Paginated } from '../../../../Paginated.js';
-import * as SkyAPI from '../../../../SkyAPI.js';
 export * from './ImageDimension.js';
 export * from './ImageSettings.js';
 export * from './MediaItem.js';
@@ -8,11 +8,11 @@ export * from './PhotoAlbum.js';
 export * from './PhotoCategory.js';
 export * from './PhotoCategoryCollection.js';
 export async function categories() {
-    return new Paginated(await SkyAPI.Client.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/photoalbums/categories'));
+    return new Paginated(await SkyAPI.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/photoalbums/categories'));
 }
 export async function list(request) {
-    return new Paginated(await SkyAPI.Client.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/photoalbums/list', 'POST', JSON.stringify(request), new Headers({ 'Content-Type': 'application/json' })));
+    return new Paginated(await SkyAPI.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/photoalbums/list', 'POST', JSON.stringify(request), new Headers({ 'Content-Type': 'application/json' })));
 }
 export async function photosById(album_id) {
-    return new Paginated(await SkyAPI.Client.requestJSON(`https://api.sky.blackbaud.com/school/v1/contentmanagement/photoalbums/${album_id}`));
+    return new Paginated(await SkyAPI.requestJSON(`https://api.sky.blackbaud.com/school/v1/contentmanagement/photoalbums/${album_id}`));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oauth2-cli/sky-api",
-  "version": "0.3.2",
+  "version": "0.4.1",
   "keywords": [
     "blackbaud",
     "sky",
@@ -22,24 +22,23 @@
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
+    "@oauth2-cli/qui-cli": "^0.5.6",
     "node-fetch": "^3.3.2",
     "oauth2-cli": "^0.2.3"
   },
   "devDependencies": {
     "@battis/descriptive-types": "^0.2.6",
     "@battis/typescript-tricks": "^0.7.6",
-    "@oauth2-cli/qui-cli": "^0.4.1",
-    "@qui-cli/colors": "^3.2.1",
-    "@qui-cli/env-1password": "^1.2.5",
+    "@qui-cli/colors": "^3.2.2",
+    "@qui-cli/env-1password": "^1.2.6",
     "@qui-cli/plugin": "^4.0.0",
-    "@tsconfig/node20": "^20.1.8",
+    "@tsconfig/node24": "^24.0.3",
     "commit-and-tag-version": "^12.6.1",
     "del-cli": "^6.0.0",
     "npm-run-all": "^4.1.5",
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@oauth2-cli/qui-cli": "0.4.x",
     "@qui-cli/plugin": ">=3"
   },
   "scripts": {
@@ -47,6 +46,6 @@
     "build": "run-s build:*",
     "build:clean": "run-s clean",
     "build:compile": "tsc",
-    "release": "commit-and-tag-version"
+    "version": "commit-and-tag-version"
   }
 }