@oauth2-cli/sky-api 0.4.2 → 0.5.1

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 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.5.1](https://github.com/groton-school/myschoolapp-reporting/compare/oauth2-cli/sky-api/0.5.0...oauth2-cli/sky-api/0.5.1) (2026-02-18)
+
+
+### Bug Fixes
+
+* use @oauth2-cli/qui-cli's `Unregistered` namespace ([20a2bae](https://github.com/groton-school/myschoolapp-reporting/commit/20a2bae1a34ae91d20efaaef96f727678cafbda1))
+
+## [0.5.0](https://github.com/groton-school/myschoolapp-reporting/compare/oauth2-cli/sky-api/0.4.2...oauth2-cli/sky-api/0.5.0) (2026-02-17)
+
+
+### ⚠ BREAKING CHANGES
+
+* update to @oauth2-cli/qui-cli
+
+### Features
+
+* update to @oauth2-cli/qui-cli ([2240c56](https://github.com/groton-school/myschoolapp-reporting/commit/2240c5653e9e4af08e71036264735c47b68936d3))
+
 ## [0.4.2](https://github.com/groton-school/myschoolapp-reporting/compare/oauth2-cli/sky-api/0.4.1...oauth2-cli/sky-api/0.4.2) (2026-01-17)
 
 

package/dist/Paginated.js

@@ -1,4 +1,4 @@
-import * as Client from './Module.js';
+import { client } from './SkyAPI.js';
 export class Paginated {
     data;
     constructor(data) {
@@ -10,7 +10,7 @@ export class Paginated {
         return {
             next: async () => {
                 if (index === data.value?.length && data.next_link) {
-                    data = await Client.requestJSON(data.next_link);
+                    data = await client.requestJSON(data.next_link);
                     index = 0;
                 }
                 if (data.value && index < data.value.length) {

package/dist/SkyAPI.d.ts

@@ -1,20 +1,3 @@
-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';
+import { SkyAPIPlugin } from './SkyAPIPlugin.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;
-}
+export declare const client: SkyAPIPlugin;

package/dist/SkyAPI.js

@@ -1,79 +1,3 @@
-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';
+import { SkyAPIPlugin } from './SkyAPIPlugin.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',
-                scope: 'skyScope',
-                redirectUri: 'skyRedirectUri'
-            },
-            env: {
-                clientId: 'SKY_CLIENT_ID',
-                clientSecret: 'SKY_CLIENT_SECRET',
-                scope: 'SKY_SCOPE',
-                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
-        });
-    }
-}
+export const client = new SkyAPIPlugin();

package/dist/SkyAPIPlugin.d.ts

@@ -0,0 +1,16 @@
+import * as OAuth2CLI from '@oauth2-cli/qui-cli/dist/Unregistered.js';
+import * as Plugin from '@qui-cli/plugin';
+type Credentials = OAuth2CLI.Credentials & {
+    subscription_key: string;
+};
+export type Configuration = OAuth2CLI.Configuration & {
+    credentials?: Partial<Credentials>;
+};
+export declare class SkyAPIPlugin extends OAuth2CLI.OAuth2Plugin<Credentials, OAuth2CLI.Client<Credentials>> {
+    private subscription_key?;
+    constructor();
+    configure({ credentials, ...options }?: Configuration): void;
+    init(args: Plugin.ExpectedArguments<typeof this.options>): Promise<void>;
+    protected instantiateClient(options: OAuth2CLI.ClientOptions<Credentials>): OAuth2CLI.Client<Credentials>;
+}
+export {};

package/dist/SkyAPIPlugin.js

@@ -0,0 +1,74 @@
+import * as OAuth2CLI from '@oauth2-cli/qui-cli/dist/Unregistered.js';
+import { Colors } from '@qui-cli/colors';
+import { Env } from '@qui-cli/env';
+import * as Plugin from '@qui-cli/plugin';
+import * as requestish from 'requestish';
+export class SkyAPIPlugin extends OAuth2CLI.OAuth2Plugin {
+    subscription_key = undefined;
+    constructor() {
+        super('@oauth2-cli/sky-api');
+        super.configure({
+            credentials: {
+                issuer: 'https://oauth2.sky.blackbaud.com'
+            },
+            base_url: 'https://api.sky.blackbaud.com',
+            man: {
+                heading: 'Sky API options',
+                text: [
+                    `The Sky API ${Colors.keyword('subscription_key')} is read from the ` +
+                        `${Colors.varName('SKY_SUBSCRIPTION_KEY')} environment variable, if ` +
+                        `present. See ` +
+                        `${Colors.url('https://developer.blackbaud.com/subscriptions/')} ` +
+                        `for more information.`,
+                    `The OAuth 2.0 ${Colors.keyword('refresh_token')} is read from the ` +
+                        `${Colors.varName('SKY_REFRESH_TOKEN')} environment variable, if ` +
+                        `present.`
+                ]
+            },
+            url: {
+                client_id: 'https://developer.blackbaud.com/apps/'
+            },
+            env: {
+                client_id: 'SKY_CLIENT_ID',
+                client_secret: 'SKY_CLIENT_SECRET',
+                scope: 'SKY_SCOPE',
+                redirect_uri: 'SKY_REDIRECT_URI'
+            },
+            suppress: {
+                issuer: true,
+                authorization_endpoint: true,
+                token_endpoint: true,
+                base_url: true
+            },
+            storage: new OAuth2CLI.Token.EnvironmentStorage('SKY_REFRESH_TOKEN')
+        });
+    }
+    configure({ credentials, ...options } = {}) {
+        const { subscription_key, ...rest } = credentials || {};
+        super.configure({ credentials: rest, ...options });
+        this.subscription_key = Plugin.hydrate(subscription_key, this.subscription_key);
+    }
+    async init(args) {
+        await super.init(args);
+        this.configure({
+            credentials: {
+                subscription_key: await Env.get({ key: 'SKY_SUBSCRIPTION_KEY' })
+            }
+        });
+    }
+    instantiateClient(options) {
+        if (!this.subscription_key) {
+            throw new Error('No subscription access key is defined.');
+        }
+        let { headers } = options.inject || {};
+        headers = requestish.Headers.merge(headers, {
+            'Bb-Api-Subscription-Key': this.subscription_key
+        });
+        return new OAuth2CLI.Client({
+            ...options,
+            inject: {
+                headers
+            }
+        });
+    }
+}

package/dist/index.d.ts

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

package/dist/index.js

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

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 { Assignment } from './Assignment.js';
 type Options = {
     types?: string;
     status?: '0' | '1' | '2' | '-1';
@@ -7,5 +7,5 @@ type Options = {
     filter?: 'expired' | 'future' | 'all';
     search?: string;
 };
-export declare function assignmentsBySection(section_id: number, params?: Options): Promise<Paginated<SkyAPI.school.v1.academics.sections.assignments.Assignment>>;
+export declare function assignmentsBySection(section_id: number, params?: Options): Promise<Paginated<Assignment>>;
 export {};

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 { client } from '../../../../../SkyAPI.js';
 export async function assignmentsBySection(section_id, params = {}) {
-    return new Paginated(await SkyAPI.requestJSON(`https://api.sky.blackbaud.com/school/v1/academics/sections/${section_id}/assignments?${buildQuery(params)}`));
+    return new Paginated(await client.requestJSON(`school/v1/academics/sections/${section_id}/assignments?${buildQuery(params)}`));
 }

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

@@ -1,8 +1,9 @@
-import * as SkyAPI from '../../../../Module.js';
 import { Paginated } from '../../../../Paginated.js';
 import { ContentManagementRequest } from '../ContentManagementRequest.js';
+import { ContentAnnouncement } from './ContentAnnouncement.js';
+import { ContentAnnouncementCategory } from './ContentAnnouncementCategory.js';
 export * from './ContentAnnouncement.js';
 export * from './ContentAnnouncementCategory.js';
 export * from './ContentAnnouncementCategoryCollection.js';
-export declare function categories(): Promise<Paginated<SkyAPI.school.v1.contentmanagement.announcements.ContentAnnouncementCategory>>;
-export declare function list(request: ContentManagementRequest): Promise<SkyAPI.school.v1.contentmanagement.announcements.ContentAnnouncement[]>;
+export declare function categories(): Promise<Paginated<ContentAnnouncementCategory>>;
+export declare function list(request: ContentManagementRequest): Promise<ContentAnnouncement[]>;

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

@@ -1,11 +1,11 @@
-import * as SkyAPI from '../../../../Module.js';
 import { Paginated } from '../../../../Paginated.js';
+import { client } from '../../../../SkyAPI.js';
 export * from './ContentAnnouncement.js';
 export * from './ContentAnnouncementCategory.js';
 export * from './ContentAnnouncementCategoryCollection.js';
 export async function categories() {
-    return new Paginated(await SkyAPI.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/announcements/categories'));
+    return new Paginated(await client.requestJSON('school/v1/contentmanagement/announcements/categories'));
 }
 export async function list(request) {
-    return SkyAPI.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/announcements/list', 'POST', JSON.stringify(request), new Headers({ 'Content-Type': 'application/json' }));
+    return client.requestJSON('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,8 +1,9 @@
-import * as SkyAPI from '../../../../Module.js';
 import { Paginated } from '../../../../Paginated.js';
 import { ContentManagementRequest } from '../ContentManagementRequest.js';
+import { NewsCategory } from './NewsCategory.js';
+import { NewsItem } from './NewsItem.js';
 export * from './NewsCategory.js';
 export * from './NewsCategoryCollection.js';
 export * from './NewsItem.js';
-export declare function categories(): Promise<Paginated<SkyAPI.school.v1.contentmanagement.news.NewsCategory>>;
-export declare function list(request: ContentManagementRequest): Promise<SkyAPI.school.v1.contentmanagement.news.NewsItem[]>;
+export declare function categories(): Promise<Paginated<NewsCategory>>;
+export declare function list(request: ContentManagementRequest): Promise<NewsItem[]>;

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

@@ -1,11 +1,11 @@
-import * as SkyAPI from '../../../../Module.js';
 import { Paginated } from '../../../../Paginated.js';
+import { client } from '../../../../SkyAPI.js';
 export * from './NewsCategory.js';
 export * from './NewsCategoryCollection.js';
 export * from './NewsItem.js';
 export async function categories() {
-    return new Paginated(await SkyAPI.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/news/categories'));
+    return new Paginated(await client.requestJSON('school/v1/contentmanagement/news/categories'));
 }
 export async function list(request) {
-    return await SkyAPI.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/news/list', 'POST', JSON.stringify(request), new Headers({ 'Content-Type': 'application/json' }));
+    return await client.requestJSON('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,6 +1,8 @@
-import * as SkyAPI from '../../../../Module.js';
 import { Paginated } from '../../../../Paginated.js';
 import { ContentManagementRequest } from '../ContentManagementRequest.js';
+import { MediaItem } from './MediaItem.js';
+import { PhotoAlbum } from './PhotoAlbum.js';
+import { PhotoCategory } from './PhotoCategory.js';
 export * from './ImageDimension.js';
 export * from './ImageSettings.js';
 export * from './MediaItem.js';
@@ -8,6 +10,6 @@ export * from './MediaItemCollection.js';
 export * from './PhotoAlbum.js';
 export * from './PhotoCategory.js';
 export * from './PhotoCategoryCollection.js';
-export declare function categories(): Promise<Paginated<SkyAPI.school.v1.contentmanagement.photoalbums.PhotoCategory>>;
-export declare function list(request: ContentManagementRequest): Promise<Paginated<SkyAPI.school.v1.contentmanagement.photoalbums.PhotoAlbum>>;
-export declare function photosById(album_id: number): Promise<Paginated<SkyAPI.school.v1.contentmanagement.photoalbums.MediaItem>>;
+export declare function categories(): Promise<Paginated<PhotoCategory>>;
+export declare function list(request: ContentManagementRequest): Promise<Paginated<PhotoAlbum>>;
+export declare function photosById(album_id: number): Promise<Paginated<MediaItem>>;

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

@@ -1,5 +1,5 @@
-import * as SkyAPI from '../../../../Module.js';
 import { Paginated } from '../../../../Paginated.js';
+import { client } 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.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/photoalbums/categories'));
+    return new Paginated(await client.requestJSON('school/v1/contentmanagement/photoalbums/categories'));
 }
 export async function list(request) {
-    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' })));
+    return new Paginated(await client.requestJSON('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.requestJSON(`https://api.sky.blackbaud.com/school/v1/contentmanagement/photoalbums/${album_id}`));
+    return new Paginated(await client.requestJSON(`school/v1/contentmanagement/photoalbums/${album_id}`));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oauth2-cli/sky-api",
-  "version": "0.4.2",
+  "version": "0.5.1",
   "keywords": [
     "blackbaud",
     "sky",
@@ -22,16 +22,16 @@
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@oauth2-cli/qui-cli": "^0.5.9",
+    "@oauth2-cli/qui-cli": "^0.7.2",
     "node-fetch": "^3.3.2",
-    "oauth2-cli": "^0.2.3"
+    "requestish": "^0.1.1"
   },
   "devDependencies": {
     "@battis/descriptive-types": "^0.2.6",
-    "@battis/typescript-tricks": "^0.7.6",
-    "@qui-cli/colors": "^3.2.2",
-    "@qui-cli/env-1password": "^1.2.6",
-    "@qui-cli/plugin": "^4.0.0",
+    "@battis/typescript-tricks": "^0.7.7",
+    "@qui-cli/colors": "^3.2.3",
+    "@qui-cli/env": "^5.1.1",
+    "@qui-cli/plugin": "^4.1.0",
     "@tsconfig/node24": "^24.0.4",
     "commit-and-tag-version": "^12.6.1",
     "del-cli": "^6.0.0",
@@ -39,6 +39,7 @@
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
+    "@qui-cli/env": ">=5",
     "@qui-cli/plugin": ">=3"
   },
   "scripts": {

package/dist/Client.d.ts

@@ -1,9 +0,0 @@
-import * as OAuth2 from '@oauth2-cli/qui-cli/dist/OAuth2.js';
-export type Credentials = OAuth2.Credentials & {
-    subscription_key: string;
-};
-export declare class Client extends OAuth2.Client {
-    private subscription_key;
-    constructor({ subscription_key, ...credentials }: Credentials);
-    request(...args: Parameters<OAuth2.Client['request']>): Promise<Response>;
-}

package/dist/Client.js

@@ -1,13 +0,0 @@
-import * as OAuth2 from '@oauth2-cli/qui-cli/dist/OAuth2.js';
-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/Credentials.d.ts

@@ -1,4 +0,0 @@
-import * as OAuth2 from 'oauth2-cli';
-export type Credentials = Omit<OAuth2.Credentials, 'authorization_endpoint' | 'token_endpoint'> & {
-    subscription_key: string;
-};

package/dist/Credentials.js

@@ -1 +0,0 @@
-export {};

package/dist/Module.d.ts

@@ -1,13 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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);