@oauth2-cli/sky-api 0.3.0 → 0.3.2

package/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 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.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)
+
+
+### Features
+
+* update to instance-based @oauth2-cli/qui-cli ([fae38fb](https://github.com/groton-school/myschoolapp-reporting/commit/fae38fbcd3e6361af6ac5d37cf9e29a339ce95da))
+
+## [0.3.1](https://github.com/groton-school/myschoolapp-reporting/compare/oauth2-cli/sky-api/0.3.0...oauth2-cli/sky-api/0.3.1) (2025-12-26)
+
+
+### Bug Fixes
+
+* include Content-Type header when sending JSON bodies ([b06e18e](https://github.com/groton-school/myschoolapp-reporting/commit/b06e18e5136a08a00e251171348c9cf2325656ca))
+* update CategroyRequest typing to match observed reality ([89ad060](https://github.com/groton-school/myschoolapp-reporting/commit/89ad060476e7efed3430aff969b0dbdaa99692d1))
+* update Colors usage to match current version ([7a82e9f](https://github.com/groton-school/myschoolapp-reporting/commit/7a82e9f3e624992c8c2a0ba7241d82327913391f))
+* update photoalbum.list() to reflect actual behavior, rather than documentation ([e2f1708](https://github.com/groton-school/myschoolapp-reporting/commit/e2f170804f5338c54279b2ca095a075fdbc32fb6))
+
 ## [0.3.0](https://github.com/groton-school/myschoolapp-reporting/compare/oauth2-cli/sky-api/0.2.2...oauth2-cli/sky-api/0.3.0) (2025-12-24)
 
 

package/dist/Client.d.ts

@@ -1,15 +1,19 @@
-import { OAuth2 } from '@oauth2-cli/qui-cli-plugin';
+import * as OAuth2 from '@oauth2-cli/qui-cli/dist/OAuth2.js';
 import * as Plugin from '@qui-cli/plugin';
-export type Configuration = Plugin.Configuration & {
+type SkyConfiguration = {
     subscription_key?: string;
     subscriptionKeyEnvVar: string;
 };
-export declare const name = "@oauth2-cli/sky-api";
-export declare function configure(proposal?: Partial<Configuration>): void;
-export declare function options(): Plugin.Options;
-export declare function init({ values }: Plugin.ExpectedArguments<typeof options>): Promise<void>;
-export declare const getToken: typeof OAuth2.getToken;
-export declare const request: typeof OAuth2.request;
-export declare const requestJSON: typeof OAuth2.requestJSON;
-/** @deprecated Use {@link requestJSON} */
-export declare const fetch: typeof OAuth2.request;
+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 {};

package/dist/Client.js

@@ -1,56 +1,59 @@
-import { OAuth2 } from '@oauth2-cli/qui-cli-plugin';
+import * as OAuth2 from '@oauth2-cli/qui-cli/dist/OAuth2.js';
 import { Colors } from '@qui-cli/colors';
 import { Env } from '@qui-cli/env-1password';
-OAuth2.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
+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
+            }
+        });
     }
-});
-export const name = '@oauth2-cli/sky-api';
-const config = {
-    subscriptionKeyEnvVar: 'SKY_SUBSCRIPTION_KEY'
-};
-export function configure(proposal = {}) {
-    for (const key in proposal) {
-        if (proposal[key] !== undefined) {
-            config[key] = proposal[key];
-        }
+    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;
     }
-}
-export function options() {
-    return {
-        opt: {
+    options() {
+        const options = super.options();
+        options.opt = {
+            ...options.opt,
             subscriptionKey: {
-                description: `Blackbaud subscription access key; will use environment variable ${Colors.varName(config.subscriptionKeyEnvVar)} if present`,
+                description: `Blackbaud subscription access key; will use environment ` +
+                    `variable ${Colors.varName(this.skyConfig.subscriptionKeyEnvVar)} ` +
+                    `if present`,
                 secret: true,
-                default: config.subscription_key
+                default: this.skyConfig.subscription_key
             }
-        }
-    };
-}
-export async function init({ values }) {
-    const { subscriptionKey: subscription_key = await Env.get({
-        key: config.subscriptionKeyEnvVar
-    }) } = values;
-    configure({ subscription_key, ...values });
-    OAuth2.configure({
-        headers: { 'Bb-Api-Subscription-Key': config.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 const getToken = OAuth2.getToken;
-export const request = OAuth2.request;
-export const requestJSON = OAuth2.requestJSON;
-/** @deprecated Use {@link requestJSON} */
-export const fetch = OAuth2.request;

package/dist/Paginated.d.ts

@@ -1,10 +1,11 @@
 import { URLString } from '@battis/descriptive-types';
-type Data<T> = {
+import { JSONValue } from '@battis/typescript-tricks';
+type Data<T extends JSONValue> = {
     count?: number;
     next_link?: URLString;
     value?: T[];
 };
-export declare class Paginated<T> implements AsyncIterable<T> {
+export declare class Paginated<T extends JSONValue> implements AsyncIterable<T> {
     private data;
     constructor(data: Data<T>);
     [Symbol.asyncIterator](): AsyncIterator<T>;

package/dist/Paginated.js

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

package/dist/SkyAPI.d.ts

@@ -1,2 +1,3 @@
-export * from './Client.js';
+import { Client as C } from './Client.js';
+export declare const Client: C;
 export * as school from './school/index.js';

package/dist/SkyAPI.js

@@ -1,2 +1,3 @@
-export * from './Client.js';
+import { Client as C } from './Client.js';
+export const Client = new C();
 export * as school from './school/index.js';

package/dist/index.js

@@ -1,4 +1,4 @@
 import { register } from '@qui-cli/plugin';
-import * as Client from './Client.js';
+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 { Paginated } from '../../../../../Paginated.js';
-import { Assignment } from './Assignment.js';
+import * as SkyAPI from '../../../../../SkyAPI.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<Assignment>>;
+export declare function assignmentsBySection(section_id: number, params?: Options): Promise<Paginated<SkyAPI.school.v1.academics.sections.assignments.Assignment>>;
 export {};

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

@@ -1,6 +1,6 @@
 import { buildQuery } from '../../../../../buildQuery.js';
-import * as SkyAPI from '../../../../../Client.js';
 import { Paginated } from '../../../../../Paginated.js';
+import * as SkyAPI 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 SkyAPI.Client.requestJSON(`https://api.sky.blackbaud.com/school/v1/academics/sections/${section_id}/assignments?${buildQuery(params)}`));
 }

package/dist/school/v1/contentmanagement/CategoryRequest.d.ts

@@ -1,4 +1,4 @@
 export type CategoryRequest = {
-    id?: number;
-    type?: 'Page content' | 'Class' | 'Activity' | 'Advisory' | 'Team' | 'Dorm' | 'Community';
+    id?: number | string;
+    type?: 'PageContent' | 'Class' | 'Activity' | 'Advisory' | 'Team' | 'Dorm' | 'Community';
 };

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

@@ -1,9 +1,8 @@
 import { Paginated } from '../../../../Paginated.js';
+import * as SkyAPI from '../../../../SkyAPI.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<ContentAnnouncementCategory>>;
-export declare function list(request: ContentManagementRequest): Promise<ContentAnnouncement[]>;
+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[]>;

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

@@ -1,11 +1,11 @@
-import * as SkyAPI from '../../../../Client.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.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/announcements/categories'));
+    return new Paginated(await SkyAPI.Client.requestJSON('https://api.sky.blackbaud.com/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));
+    return SkyAPI.Client.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,9 +1,8 @@
 import { Paginated } from '../../../../Paginated.js';
+import * as SkyAPI from '../../../../SkyAPI.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<NewsCategory>>;
-export declare function list(request: ContentManagementRequest): Promise<NewsItem[]>;
+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[]>;

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

@@ -1,11 +1,11 @@
-import * as SkyAPI from '../../../../Client.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.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/news/categories'));
+    return new Paginated(await SkyAPI.Client.requestJSON('https://api.sky.blackbaud.com/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));
+    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' }));
 }

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

@@ -0,0 +1,7 @@
+import { URLString } from '@battis/descriptive-types';
+import { PhotoAlbum } from './PhotoAlbum.js';
+export type PhotoAlbumCollection = {
+    count?: number;
+    next_link?: URLString;
+    value?: PhotoAlbum[];
+};

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

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

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

@@ -1,8 +1,6 @@
 import { Paginated } from '../../../../Paginated.js';
+import * as SkyAPI from '../../../../SkyAPI.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';
@@ -10,6 +8,6 @@ export * from './MediaItemCollection.js';
 export * from './PhotoAlbum.js';
 export * from './PhotoCategory.js';
 export * from './PhotoCategoryCollection.js';
-export declare function categories(): Promise<Paginated<PhotoCategory>>;
-export declare function list(request: ContentManagementRequest): Promise<PhotoAlbum[]>;
-export declare function photosById(album_id: number): Promise<Paginated<MediaItem>>;
+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>>;

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

@@ -1,5 +1,5 @@
-import * as SkyAPI from '../../../../Client.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.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/photoalbums/categories'));
+    return new Paginated(await SkyAPI.Client.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/photoalbums/categories'));
 }
 export async function list(request) {
-    return await SkyAPI.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/photoalbums/list', 'POST', JSON.stringify(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' })));
 }
 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 SkyAPI.Client.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.0",
+  "version": "0.3.2",
   "keywords": [
     "blackbaud",
     "sky",
@@ -27,9 +27,10 @@
   },
   "devDependencies": {
     "@battis/descriptive-types": "^0.2.6",
-    "@oauth2-cli/qui-cli-plugin": "^0.3.0",
-    "@qui-cli/colors": "^3.1.1",
-    "@qui-cli/env-1password": "^1.2.2",
+    "@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/plugin": "^4.0.0",
     "@tsconfig/node20": "^20.1.8",
     "commit-and-tag-version": "^12.6.1",
@@ -38,8 +39,8 @@
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@oauth2-cli/qui-cli-plugin": "0.x",
-    "@qui-cli/plugin": "4.x"
+    "@oauth2-cli/qui-cli": "0.4.x",
+    "@qui-cli/plugin": ">=3"
   },
   "scripts": {
     "clean": "del ./dist",