@timeback/oneroster 0.1.5 → 0.1.7-beta.20260219190739
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/dist/client.d.ts +12 -6
- package/dist/client.d.ts.map +1 -1
- package/dist/client.type-test.d.ts +2 -0
- package/dist/client.type-test.d.ts.map +1 -0
- package/dist/errors.d.ts +1 -7
- package/dist/errors.js +487 -41
- package/dist/factory.d.ts +4 -2
- package/dist/factory.d.ts.map +1 -1
- package/dist/index.d.ts +5245 -18
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1053 -305
- package/dist/public-types.d.ts +1885 -0
- package/dist/public-types.d.ts.map +1 -0
- package/package.json +4 -3
- /package/dist/{types.js → public-types.js} +0 -0
package/dist/client.d.ts
CHANGED
|
@@ -9,8 +9,9 @@
|
|
|
9
9
|
* Provides access to all OneRoster v1.2 resources including users, classes,
|
|
10
10
|
* enrollments, courses, grades, and assessments.
|
|
11
11
|
*
|
|
12
|
-
* @example
|
|
12
|
+
* @example
|
|
13
13
|
* ```typescript
|
|
14
|
+
* // Environment mode (Timeback APIs)
|
|
14
15
|
* const client = new OneRosterClient({
|
|
15
16
|
* env: 'staging', // or 'production'
|
|
16
17
|
* auth: {
|
|
@@ -20,8 +21,9 @@
|
|
|
20
21
|
* })
|
|
21
22
|
* ```
|
|
22
23
|
*
|
|
23
|
-
* @example
|
|
24
|
+
* @example
|
|
24
25
|
* ```typescript
|
|
26
|
+
* // Platform selection
|
|
25
27
|
* const client = new OneRosterClient({
|
|
26
28
|
* platform: 'LEARNWITH_AI', // or 'BEYOND_AI' (default)
|
|
27
29
|
* env: 'production',
|
|
@@ -32,8 +34,9 @@
|
|
|
32
34
|
* })
|
|
33
35
|
* ```
|
|
34
36
|
*
|
|
35
|
-
* @example
|
|
37
|
+
* @example
|
|
36
38
|
* ```typescript
|
|
39
|
+
* // Provider mode (pre-built provider)
|
|
37
40
|
* import { TimebackProvider } from '@timeback/internal-client-infra'
|
|
38
41
|
*
|
|
39
42
|
* const provider = new TimebackProvider({
|
|
@@ -45,8 +48,9 @@
|
|
|
45
48
|
* const client = new OneRosterClient({ provider })
|
|
46
49
|
* ```
|
|
47
50
|
*
|
|
48
|
-
* @example
|
|
51
|
+
* @example
|
|
49
52
|
* ```typescript
|
|
53
|
+
* // Explicit mode (custom OneRoster API)
|
|
50
54
|
* const client = new OneRosterClient({
|
|
51
55
|
* baseUrl: 'https://api.example.com',
|
|
52
56
|
* auth: {
|
|
@@ -57,15 +61,17 @@
|
|
|
57
61
|
* })
|
|
58
62
|
* ```
|
|
59
63
|
*
|
|
60
|
-
* @example
|
|
64
|
+
* @example
|
|
61
65
|
* ```typescript
|
|
66
|
+
* // Environment variables fallback
|
|
62
67
|
* // Set ONEROSTER_BASE_URL, ONEROSTER_TOKEN_URL,
|
|
63
68
|
* // ONEROSTER_CLIENT_ID, ONEROSTER_CLIENT_SECRET
|
|
64
69
|
* const client = new OneRosterClient()
|
|
65
70
|
* ```
|
|
66
71
|
*
|
|
67
|
-
* @example
|
|
72
|
+
* @example
|
|
68
73
|
* ```typescript
|
|
74
|
+
* // Nested resources
|
|
69
75
|
* const classes = await client.schools.for('school-id').classes()
|
|
70
76
|
* const students = await client.classes.for('class-id').students()
|
|
71
77
|
* ```
|
package/dist/client.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoFG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;CAA0B,CAAA;AAEtD;;;;;;;;;;;GAWG;AACH,YAAY,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.type-test.d.ts","sourceRoot":"","sources":["../src/client.type-test.ts"],"names":[],"mappings":"AAmDA,OAAO,EAAE,CAAA"}
|
package/dist/errors.d.ts
CHANGED
|
@@ -1,7 +1 @@
|
|
|
1
|
-
|
|
2
|
-
* OneRoster Error Classes
|
|
3
|
-
*
|
|
4
|
-
* Re-exports common API errors with IMS Global parsing.
|
|
5
|
-
*/
|
|
6
|
-
export { ApiError as OneRosterError, ForbiddenError, NotFoundError, UnauthorizedError, ValidationError, } from '@timeback/internal-client-infra';
|
|
7
|
-
//# sourceMappingURL=errors.d.ts.map
|
|
1
|
+
export { ForbiddenError, NotFoundError, ApiError as OneRosterError, UnauthorizedError, ValidationError } from '@timeback/internal-client-infra';
|