@oauth2-cli/sky-api 0.4.1 → 0.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/README.md +6 -12
- package/dist/SkyAPI.js +2 -0
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
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.
|
|
4
4
|
|
|
5
|
+
## [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)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
### Features
|
|
9
|
+
|
|
10
|
+
* add scope support ([dae9f5a](https://github.com/groton-school/myschoolapp-reporting/commit/dae9f5aa7c2527f8fbf84184f19bc07c40001502))
|
|
11
|
+
|
|
5
12
|
## [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)
|
|
6
13
|
|
|
7
14
|
|
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@ Acquire SKY API access tokens via OAuth 2.0 within CLI tools
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
7
7
|
```sh
|
|
8
|
-
npm i @oauth2-cli/sky-api
|
|
8
|
+
npm i @oauth2-cli/sky-api @qui-cli/core
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
## Usage
|
|
@@ -13,17 +13,11 @@ npm i @oauth2-cli/sky-api
|
|
|
13
13
|
Configure your SKY API app credentials somewhere relatively secure (e.g. your environment) and then...
|
|
14
14
|
|
|
15
15
|
```ts
|
|
16
|
-
import dotenv from 'dotenv';
|
|
17
16
|
import { SkyAPI } from '@oauth2-cli/sky-api';
|
|
17
|
+
import { Core } from '@qui-cli/core';
|
|
18
18
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
client_secret: process.env.CLIENT_SECRET,
|
|
24
|
-
subscription_key: process.env.SUBSCRIPTION_KEY,
|
|
25
|
-
redirect_uri: process.env.REDIRECT_URI
|
|
26
|
-
});
|
|
27
|
-
const calendar = await sky.fetch('school/v1/events/calendar');
|
|
28
|
-
})();
|
|
19
|
+
await Core.run();
|
|
20
|
+
console.log(
|
|
21
|
+
await sky.fetchJSON('https://api.sky.blackbaud.com/school/v1/users/me')
|
|
22
|
+
);
|
|
29
23
|
```
|
package/dist/SkyAPI.js
CHANGED
|
@@ -17,11 +17,13 @@ export class SkyAPIPlugin extends OAuth2.OAuth2Plugin {
|
|
|
17
17
|
opt: {
|
|
18
18
|
clientId: 'skyClientId',
|
|
19
19
|
clientSecret: 'skyClientSecret',
|
|
20
|
+
scope: 'skyScope',
|
|
20
21
|
redirectUri: 'skyRedirectUri'
|
|
21
22
|
},
|
|
22
23
|
env: {
|
|
23
24
|
clientId: 'SKY_CLIENT_ID',
|
|
24
25
|
clientSecret: 'SKY_CLIENT_SECRET',
|
|
26
|
+
scope: 'SKY_SCOPE',
|
|
25
27
|
redirectUri: 'SKY_REDIRECT_URI',
|
|
26
28
|
tokenPath: 'SKY_TOKEN_PATH',
|
|
27
29
|
accessToken: 'SKY_ACCESS_TOKEN'
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@oauth2-cli/sky-api",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.2",
|
|
4
4
|
"keywords": [
|
|
5
5
|
"blackbaud",
|
|
6
6
|
"sky",
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"main": "./dist/index.js",
|
|
23
23
|
"types": "./dist/index.d.ts",
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@oauth2-cli/qui-cli": "^0.5.
|
|
25
|
+
"@oauth2-cli/qui-cli": "^0.5.9",
|
|
26
26
|
"node-fetch": "^3.3.2",
|
|
27
27
|
"oauth2-cli": "^0.2.3"
|
|
28
28
|
},
|
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
"@qui-cli/colors": "^3.2.2",
|
|
33
33
|
"@qui-cli/env-1password": "^1.2.6",
|
|
34
34
|
"@qui-cli/plugin": "^4.0.0",
|
|
35
|
-
"@tsconfig/node24": "^24.0.
|
|
35
|
+
"@tsconfig/node24": "^24.0.4",
|
|
36
36
|
"commit-and-tag-version": "^12.6.1",
|
|
37
37
|
"del-cli": "^6.0.0",
|
|
38
38
|
"npm-run-all": "^4.1.5",
|