@oauth2-cli/sky-api 0.2.2 → 0.3.0

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 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.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)
+
+
+### ⚠ BREAKING CHANGES
+
+* rewritten as cleaner extension of @oauth2-cli/qui-cli-plugin
+* re-type section assignments to map more clearly to API documentation
+* rename school API to match Blackbaud documentation
+
+### Features
+
+* allow typing fetch response ([e93a758](https://github.com/groton-school/myschoolapp-reporting/commit/e93a7583ca781410ca88f0856ddbdd86ba5a95c5))
+* async iterate across paginated responses ([9d0cbfb](https://github.com/groton-school/myschoolapp-reporting/commit/9d0cbfb5e0c72229e44315ede6a0ff4e4d7cecd8))
+* content management announcements ([fc724d1](https://github.com/groton-school/myschoolapp-reporting/commit/fc724d1440de4e04b63a8d5b492bec8af28b8e56))
+* content management news ([3bc3cd0](https://github.com/groton-school/myschoolapp-reporting/commit/3bc3cd0042f3d20b8779b0ba8bcece482dffd0f0))
+* contentmenagement.photoalbums.categories and contentmanagement.photoalbums.list types ([881851f](https://github.com/groton-school/myschoolapp-reporting/commit/881851fcef2b801b622301621789b942b1d39c01))
+* expose endpoints as async methods ([b4d40a2](https://github.com/groton-school/myschoolapp-reporting/commit/b4d40a2ffb561c763a8e3b6ee73af85f73560107))
+* re-type section assignments to map more clearly to API documentation ([36c8ca9](https://github.com/groton-school/myschoolapp-reporting/commit/36c8ca94e2beb4a3cef95cce42f6a501d134d491))
+* rewritten as cleaner extension of @oauth2-cli/qui-cli-plugin ([e623f8a](https://github.com/groton-school/myschoolapp-reporting/commit/e623f8a5b3a08a28a832002176e76d2a4e6d1823))
+
+
+### Bug Fixes
+
+* rename school API to match Blackbaud documentation ([ba25292](https://github.com/groton-school/myschoolapp-reporting/commit/ba25292e37ec66d1b53b5ca6af6ce88af6e6aea6))
+
 ## [0.2.2](https://github.com/battis/oauth2-cli/compare/sky-api/0.2.1...sky-api/0.2.2) (2025-09-11)
 
 

package/dist/Client.d.ts

@@ -0,0 +1,15 @@
+import { OAuth2 } from '@oauth2-cli/qui-cli-plugin';
+import * as Plugin from '@qui-cli/plugin';
+export type Configuration = Plugin.Configuration & {
+    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;

package/dist/Client.js

@@ -0,0 +1,56 @@
+import { OAuth2 } from '@oauth2-cli/qui-cli-plugin';
+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 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];
+        }
+    }
+}
+export function options() {
+    return {
+        opt: {
+            subscriptionKey: {
+                description: `Blackbaud subscription access key; will use environment variable ${Colors.varName(config.subscriptionKeyEnvVar)} if present`,
+                secret: true,
+                default: config.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 }
+    });
+}
+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/Credentials.d.ts

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

package/dist/Paginated.d.ts

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

package/dist/Paginated.js

@@ -0,0 +1,37 @@
+import * as Client from './Client.js';
+export class Paginated {
+    data;
+    constructor(data) {
+        this.data = data;
+    }
+    [Symbol.asyncIterator]() {
+        let index = 0;
+        let data = this.data;
+        return {
+            next: async () => {
+                if (index === data.value?.length && data.next_link) {
+                    data = await Client.requestJSON(data.next_link);
+                    index = 0;
+                }
+                if (data.value && index < data.value.length) {
+                    const value = data.value[index];
+                    index++;
+                    return {
+                        value,
+                        done: false
+                    };
+                }
+                else {
+                    return {
+                        value: undefined,
+                        done: true
+                    };
+                }
+            },
+            return: async () => ({
+                value: undefined,
+                done: true
+            })
+        };
+    }
+}

package/dist/SkyAPI.d.ts

@@ -0,0 +1,2 @@
+export * from './Client.js';
+export * as school from './school/index.js';

package/dist/SkyAPI.js

@@ -0,0 +1,2 @@
+export * from './Client.js';
+export * as school from './school/index.js';

package/dist/buildQuery.d.ts

@@ -0,0 +1 @@
+export declare function buildQuery(params: Record<string, unknown>): string;

package/dist/buildQuery.js

@@ -0,0 +1,7 @@
+export function buildQuery(params) {
+    const search = new URLSearchParams();
+    for (const key in params) {
+        search.append(key, `${params[key]}`);
+    }
+    return search.toString();
+}

package/dist/index.d.ts

@@ -1,14 +1 @@
-import { RequestInfo, RequestInit } from 'node-fetch';
-import * as OAuth2 from 'oauth2-cli';
-export * as School from './School/index.js';
-export type Credentials = Omit<OAuth2.Credentials, 'authorization_endpoint' | 'token_endpoint'> & {
-    subscription_key: string;
-};
-export declare class SkyAPI {
-    private client;
-    private token?;
-    private subscription_key;
-    constructor({ subscription_key, ...credentials }: Credentials);
-    getToken(): Promise<OAuth2.Token | undefined>;
-    fetch(endpoint: URL | RequestInfo, init?: RequestInit): Promise<unknown>;
-}
+export * as SkyAPI from './SkyAPI.js';

package/dist/index.js

@@ -1,37 +1,4 @@
-// TODO replace node-fetch dependency with native fetch when bumping to node@>=21
-import nodeFetch from 'node-fetch';
-import * as OAuth2 from 'oauth2-cli';
-export * as School from './School/index.js';
-const SUBSCRIPTION_HEADER = 'Bb-Api-Subscription-Key';
-export class SkyAPI {
-    client;
-    token;
-    subscription_key;
-    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]: this.subscription_key }
-        });
-    }
-    async getToken() {
-        this.token = await this.client.getToken();
-        return this.token;
-    }
-    async fetch(endpoint, init) {
-        await this.getToken();
-        if (!this.token) {
-            throw new Error('No access token');
-        }
-        return await (await nodeFetch(new URL(endpoint, 'https://api.sky.blackbaud.com'), {
-            ...init,
-            headers: {
-                ...init?.headers,
-                Authorization: `Bearer ${this.token.access_token}`,
-                [SUBSCRIPTION_HEADER]: this.subscription_key
-            }
-        })).json();
-    }
-}
+import { register } from '@qui-cli/plugin';
+import * as Client from './Client.js';
+export * as SkyAPI from './SkyAPI.js';
+await register(Client);

package/dist/school/index.d.ts

@@ -0,0 +1 @@
+export * as v1 from './v1/index.js';

package/dist/school/index.js

@@ -0,0 +1 @@
+export * as v1 from './v1/index.js';

package/dist/school/v1/academics/index.d.ts

@@ -0,0 +1 @@
+export * as sections from './sections/index.js';

package/dist/school/v1/academics/index.js

@@ -0,0 +1 @@
+export * as sections from './sections/index.js';

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

@@ -0,0 +1,21 @@
+import { DateTimeString } from '@battis/descriptive-types';
+import { IdDescriptorField } from './IdDescriptorField.js';
+export type Assignment = {
+    id?: number;
+    date?: DateTimeString<'ISO'>;
+    description?: string;
+    discussion?: boolean;
+    due_date?: DateTimeString<'ISO'>;
+    enrolled?: number;
+    graded_count?: number;
+    index_id?: number;
+    major?: boolean;
+    name?: string;
+    publish_on_assigned?: boolean;
+    published?: boolean;
+    rank?: number;
+    status?: 0 | 1 | 2 | -1;
+    type?: string;
+    type_id?: number;
+    rubric: IdDescriptorField;
+};

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

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

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

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

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

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

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

@@ -0,0 +1,4 @@
+export type IdDescriptorField = {
+    id?: number;
+    description?: string;
+};

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

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

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

@@ -0,0 +1,11 @@
+import { Paginated } from '../../../../../Paginated.js';
+import { Assignment } from './Assignment.js';
+type Options = {
+    types?: string;
+    status?: '0' | '1' | '2' | '-1';
+    persona_id?: 2 | 3;
+    filter?: 'expired' | 'future' | 'all';
+    search?: string;
+};
+export declare function assignmentsBySection(section_id: number, params?: Options): Promise<Paginated<Assignment>>;
+export {};

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

@@ -0,0 +1,6 @@
+import { buildQuery } from '../../../../../buildQuery.js';
+import * as SkyAPI from '../../../../../Client.js';
+import { Paginated } from '../../../../../Paginated.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)}`));
+}

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

@@ -0,0 +1,4 @@
+export * from './Assignment.js';
+export * from './AssignmentCollection.js';
+export * from './IdDescriptorField.js';
+export * from './assignmentsBySection.js';

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

@@ -0,0 +1,4 @@
+export * from './Assignment.js';
+export * from './AssignmentCollection.js';
+export * from './IdDescriptorField.js';
+export * from './assignmentsBySection.js';

package/dist/school/v1/academics/sections/index.d.ts

@@ -0,0 +1 @@
+export * as assignments from './assignments/index.js';

package/dist/school/v1/academics/sections/index.js

@@ -0,0 +1 @@
+export * as assignments from './assignments/index.js';

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

@@ -0,0 +1,4 @@
+export type BaseRole = {
+    id?: number;
+    name?: string;
+};

package/dist/school/v1/contentmanagement/BaseRole.js

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

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

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

package/dist/school/v1/contentmanagement/CategoryRequest.js

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

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

@@ -0,0 +1,9 @@
+import { DateTimeString } from '@battis/descriptive-types';
+export type ContentCategory = {
+    id?: number;
+    name?: string;
+    type?: string;
+    primary?: boolean;
+    publish_date?: DateTimeString;
+    expire_date?: DateTimeString;
+};

package/dist/school/v1/contentmanagement/ContentCategory.js

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

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

@@ -0,0 +1,8 @@
+import { DateTimeString } from '@battis/descriptive-types';
+import { CategoryRequest } from './CategoryRequest.js';
+export type ContentManagementRequest = {
+    categories: CategoryRequest[];
+    as_of_date?: DateTimeString<'ISO'>;
+    last_modified?: DateTimeString<'ISO'>;
+    show_secured?: boolean;
+};

package/dist/school/v1/contentmanagement/ContentManagementRequest.js

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

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

@@ -0,0 +1,6 @@
+import { BaseRole } from './BaseRole.js';
+export type RoleModel = {
+    id?: number;
+    name?: string;
+    base_role?: BaseRole;
+};

package/dist/school/v1/contentmanagement/RoleModel.js

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

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

@@ -0,0 +1,14 @@
+import { DateTimeString } from '@battis/descriptive-types';
+import { ContentCategory } from '../ContentCategory.js';
+export type ContentAnnouncement = {
+    id?: number;
+    headline?: string;
+    author?: string;
+    description?: string;
+    send_notification?: boolean;
+    created_date?: DateTimeString;
+    modified_date?: DateTimeString;
+    created_by?: number;
+    modified_by?: number;
+    categories?: ContentCategory[];
+};

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

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

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

@@ -0,0 +1,11 @@
+import { URLString } from '@battis/descriptive-types';
+import { RoleModel } from '../RoleModel.js';
+export type ContentAnnouncementCategory = {
+    category_id?: number;
+    category_name?: string;
+    allow_user_management?: boolean;
+    rss_enabled?: boolean;
+    rss_feed?: URLString;
+    is_public?: boolean;
+    access_roles?: RoleModel;
+};

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

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

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

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

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

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

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

@@ -0,0 +1,9 @@
+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<ContentAnnouncementCategory>>;
+export declare function list(request: ContentManagementRequest): Promise<ContentAnnouncement[]>;

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

@@ -0,0 +1,11 @@
+import * as SkyAPI from '../../../../Client.js';
+import { Paginated } from '../../../../Paginated.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'));
+}
+export async function list(request) {
+    return SkyAPI.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/announcements/list', 'POST', JSON.stringify(request));
+}

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

@@ -0,0 +1,8 @@
+export * as announcements from './announcements/index.js';
+export * from './BaseRole.js';
+export * from './CategoryRequest.js';
+export * from './ContentCategory.js';
+export * from './ContentManagementRequest.js';
+export * as news from './news/index.js';
+export * as photoalbums from './photoalbums/index.js';
+export * from './RoleModel.js';

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

@@ -0,0 +1,8 @@
+export * as announcements from './announcements/index.js';
+export * from './BaseRole.js';
+export * from './CategoryRequest.js';
+export * from './ContentCategory.js';
+export * from './ContentManagementRequest.js';
+export * as news from './news/index.js';
+export * as photoalbums from './photoalbums/index.js';
+export * from './RoleModel.js';

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

@@ -0,0 +1,19 @@
+import { URLString } from '@battis/descriptive-types';
+import { RoleModel } from '../RoleModel.js';
+import { ImageSettings } from '../photoalbums/ImageSettings.js';
+export type NewsCategory = {
+    category_id?: number;
+    category_name?: string;
+    allow_user_management?: boolean;
+    show_brief_description?: boolean;
+    show_long_description?: boolean;
+    association_id?: number;
+    association_name?: string;
+    rss_ind?: boolean;
+    allow_coments?: string;
+    comment_approval?: string;
+    rss_feed?: URLString;
+    is_public?: boolean;
+    access_roles?: RoleModel[];
+    image_settings?: ImageSettings;
+};

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

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

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

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

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

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

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

@@ -0,0 +1,20 @@
+import { DateTimeString } from '@battis/descriptive-types';
+import { ContentCategory } from '../ContentCategory.js';
+import { MediaItem } from '../photoalbums/MediaItem.js';
+export type NewsItem = {
+    id?: number;
+    headline?: string;
+    author?: string;
+    short_description?: string;
+    long_description?: string;
+    featured?: boolean;
+    media_item?: MediaItem[];
+    categories?: ContentCategory[];
+    send_notification?: boolean;
+    show_brief_description?: boolean;
+    show_long_description?: boolean;
+    created_by?: number;
+    created_date?: DateTimeString;
+    modified_by?: number;
+    modified_date?: DateTimeString;
+};

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

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

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

@@ -0,0 +1,9 @@
+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<NewsCategory>>;
+export declare function list(request: ContentManagementRequest): Promise<NewsItem[]>;

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

@@ -0,0 +1,11 @@
+import * as SkyAPI from '../../../../Client.js';
+import { Paginated } from '../../../../Paginated.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'));
+}
+export async function list(request) {
+    return await SkyAPI.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/news/list', 'POST', JSON.stringify(request));
+}

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

@@ -0,0 +1,5 @@
+export type ImageDimension = {
+    include?: boolean;
+    max_width?: number;
+    max_height?: number;
+};

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

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

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

@@ -0,0 +1,10 @@
+import { ImageDimension } from './ImageDimension.js';
+export type ImageSettings = {
+    max_allowed?: number;
+    allow_title?: boolean;
+    allow_captions?: boolean;
+    allow_descriptions?: boolean;
+    standard?: ImageDimension;
+    zoom?: ImageDimension;
+    thumbnail?: ImageDimension;
+};

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

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

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

@@ -0,0 +1,12 @@
+import { URLString } from '@battis/descriptive-types';
+export type MediaItem = {
+    id?: number;
+    type?: string;
+    title?: string;
+    caption?: string;
+    tags?: string;
+    description?: string;
+    is_cover?: boolean;
+    url?: URLString;
+    thumbnail_url?: URLString;
+};

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

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

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

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

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

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

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

@@ -0,0 +1,11 @@
+import { URLString } from '@battis/descriptive-types';
+import { ContentCategory } from '../ContentCategory.js';
+export type PhotoAlbum = {
+    id?: number;
+    title?: string;
+    description?: string;
+    allow_downloads?: boolean;
+    featured?: boolean;
+    categories?: ContentCategory[];
+    url?: URLString;
+};

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

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

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

@@ -0,0 +1,10 @@
+import { RoleModel } from '../RoleModel.js';
+import { ImageSettings } from './ImageSettings.js';
+export type PhotoCategory = {
+    id?: number;
+    description?: string;
+    include_description_for_photos?: boolean;
+    is_public?: boolean;
+    access_roles?: RoleModel[];
+    image_settings?: ImageSettings;
+};

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

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

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

@@ -0,0 +1,6 @@
+import { PhotoCategory } from './PhotoCategory.js';
+export type PhotoCategoryCollection = {
+    count?: number;
+    next_link?: string;
+    value: PhotoCategory[];
+};

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

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

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

@@ -0,0 +1,15 @@
+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';
+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>>;

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

@@ -0,0 +1,18 @@
+import * as SkyAPI from '../../../../Client.js';
+import { Paginated } from '../../../../Paginated.js';
+export * from './ImageDimension.js';
+export * from './ImageSettings.js';
+export * from './MediaItem.js';
+export * from './MediaItemCollection.js';
+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'));
+}
+export async function list(request) {
+    return await SkyAPI.requestJSON('https://api.sky.blackbaud.com/school/v1/contentmanagement/photoalbums/list', 'POST', JSON.stringify(request));
+}
+export async function photosById(album_id) {
+    return new Paginated(await SkyAPI.requestJSON(`https://api.sky.blackbaud.com/school/v1/contentmanagement/photoalbums/${album_id}`));
+}

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

@@ -0,0 +1,2 @@
+export * as academics from './academics/index.js';
+export * as contentmanagement from './contentmanagement/index.js';

package/dist/school/v1/index.js

@@ -0,0 +1,2 @@
+export * as academics from './academics/index.js';
+export * as contentmanagement from './contentmanagement/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oauth2-cli/sky-api",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "keywords": [
     "blackbaud",
     "sky",
@@ -8,30 +8,38 @@
     "oauth",
     "cli"
   ],
-  "homepage": "https://github.com/battis/oauth2-cli/tree/main/packages/sky-api#readme",
+  "homepage": "https://github.com/groton-school/myschoolapp-reporting/tree/main/packages/oauth2-cli/sky-api#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/battis/oauth2-cli.git",
-    "directory": "packages/sky-api"
+    "url": "https://github.com/groton-school/myschoolapp-reporting.git",
+    "directory": "packages/oauth2-cli/sky-api"
   },
   "author": {
     "name": "Seth Battis",
-    "url": "https://github.com/battis"
+    "email": "sbattis@groton.org"
   },
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
     "node-fetch": "^3.3.2",
-    "oauth2-cli": "0.2.1"
+    "oauth2-cli": "^0.2.3"
   },
   "devDependencies": {
-    "@battis/descriptive-types": "^0.2.3",
-    "@tsconfig/node20": "^20.1.6",
-    "commit-and-tag-version": "^12.6.0",
+    "@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",
+    "@qui-cli/plugin": "^4.0.0",
+    "@tsconfig/node20": "^20.1.8",
+    "commit-and-tag-version": "^12.6.1",
     "del-cli": "^6.0.0",
     "npm-run-all": "^4.1.5",
-    "typescript": "^5.9.2"
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "@oauth2-cli/qui-cli-plugin": "0.x",
+    "@qui-cli/plugin": "4.x"
   },
   "scripts": {
     "clean": "del ./dist",

package/.versionrc.json

@@ -1,5 +0,0 @@
-{
-  "path": ".",
-  "tag-prefix": "sky-api/",
-  "releaseCommitMessageFormat": "chore(sky-api): @oauth2-cli/sky-api@{{currentTag}}"
-}

package/dist/School/Assignment.d.ts

@@ -1,23 +0,0 @@
-import { DateTimeString } from '@battis/descriptive-types';
-export type Assignment = {
-    id: number;
-    date: DateTimeString;
-    description: string;
-    discussion: false;
-    due_date: DateTimeString;
-    enrolled: number;
-    graded_count: number;
-    index_id: number;
-    major: boolean;
-    name: string;
-    publish_on_assigned: boolean;
-    published: boolean;
-    rank: number;
-    status: number;
-    type: string;
-    type_id: number;
-};
-export type AssignmentList = {
-    count: number;
-    value: Assignment[];
-};

package/dist/School/index.d.ts

@@ -1 +0,0 @@
-export * from './Assignment.js';

package/dist/School/index.js

@@ -1 +0,0 @@
-export * from './Assignment.js';

package/src/School/Assignment.ts

@@ -1,25 +0,0 @@
-import { DateTimeString } from '@battis/descriptive-types';
-
-export type Assignment = {
-  id: number;
-  date: DateTimeString;
-  description: string;
-  discussion: false;
-  due_date: DateTimeString;
-  enrolled: number;
-  graded_count: number;
-  index_id: number;
-  major: boolean;
-  name: string;
-  publish_on_assigned: boolean;
-  published: boolean;
-  rank: number;
-  status: number;
-  type: string;
-  type_id: number;
-};
-
-export type AssignmentList = {
-  count: number;
-  value: Assignment[];
-};

package/src/School/index.ts

@@ -1 +0,0 @@
-export * from './Assignment.js';

package/src/index.ts

@@ -1,52 +0,0 @@
-// TODO replace node-fetch dependency with native fetch when bumping to node@>=21
-import nodeFetch, { RequestInfo, RequestInit } from 'node-fetch';
-import * as OAuth2 from 'oauth2-cli';
-
-export * as School from './School/index.js';
-
-export type Credentials = Omit<
-  OAuth2.Credentials,
-  'authorization_endpoint' | 'token_endpoint'
-> & {
-  subscription_key: string;
-};
-
-const SUBSCRIPTION_HEADER = 'Bb-Api-Subscription-Key';
-
-export class SkyAPI {
-  private client: OAuth2.Client;
-  private token?: OAuth2.Token;
-  private subscription_key: string;
-
-  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]: this.subscription_key }
-    });
-  }
-
-  public async getToken() {
-    this.token = await this.client.getToken();
-    return this.token;
-  }
-
-  public async fetch(endpoint: URL | RequestInfo, init?: RequestInit) {
-    await this.getToken();
-    if (!this.token) {
-      throw new Error('No access token');
-    }
-    return await (
-      await nodeFetch(new URL(endpoint, 'https://api.sky.blackbaud.com'), {
-        ...init,
-        headers: {
-          ...init?.headers,
-          Authorization: `Bearer ${this.token.access_token}`,
-          [SUBSCRIPTION_HEADER]: this.subscription_key
-        }
-      })
-    ).json();
-  }
-}

package/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "extends": "@tsconfig/node20/tsconfig.json",
-  "compilerOptions": {
-    "outDir": "./dist",
-    "declaration": true
-  },
-  "include": ["./src"]
-}