@eduware/oneroster 1.2.5 → 1.2.7
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/FUNCTIONS.md +232 -0
- package/README.md +490 -342
- package/dist/commonjs/clients/classlink.d.ts +2 -3
- package/dist/commonjs/clients/classlink.d.ts.map +1 -1
- package/dist/commonjs/clients/classlink.js.map +1 -1
- package/dist/commonjs/clients/types.d.ts +5 -3
- package/dist/commonjs/clients/types.d.ts.map +1 -1
- package/dist/commonjs/enums/index.d.ts +2 -0
- package/dist/commonjs/enums/index.d.ts.map +1 -0
- package/dist/commonjs/enums/index.js +18 -0
- package/dist/commonjs/enums/index.js.map +1 -0
- package/dist/commonjs/models/index.d.ts +2 -0
- package/dist/commonjs/models/index.d.ts.map +1 -0
- package/dist/commonjs/models/index.js +18 -0
- package/dist/commonjs/models/index.js.map +1 -0
- package/dist/commonjs/types/index.d.ts +1 -0
- package/dist/commonjs/types/index.d.ts.map +1 -1
- package/dist/commonjs/types/index.js +16 -0
- package/dist/commonjs/types/index.js.map +1 -1
- package/dist/esm/clients/classlink.d.ts +2 -3
- package/dist/esm/clients/classlink.d.ts.map +1 -1
- package/dist/esm/clients/classlink.js.map +1 -1
- package/dist/esm/clients/types.d.ts +5 -3
- package/dist/esm/clients/types.d.ts.map +1 -1
- package/dist/esm/enums/index.d.ts +2 -0
- package/dist/esm/enums/index.d.ts.map +1 -0
- package/dist/esm/enums/index.js +2 -0
- package/dist/esm/enums/index.js.map +1 -0
- package/dist/esm/models/index.d.ts +2 -0
- package/dist/esm/models/index.d.ts.map +1 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/esm/models/index.js.map +1 -0
- package/dist/esm/types/index.d.ts +1 -0
- package/dist/esm/types/index.d.ts.map +1 -1
- package/dist/esm/types/index.js +2 -0
- package/dist/esm/types/index.js.map +1 -1
- package/package.json +37 -79
- package/src/clients/classlink.ts +2 -3
- package/src/clients/types.ts +5 -3
- package/src/enums/index.ts +1 -0
- package/src/models/index.ts +1 -0
- package/src/types/index.ts +3 -0
- package/vitest.config.ts +2 -2
- package/test/summary-reporter.ts +0 -114
|
@@ -6,8 +6,7 @@
|
|
|
6
6
|
* available methods to read-only operations that ClassLink supports.
|
|
7
7
|
*/
|
|
8
8
|
import type { SDKOptions } from '../lib/config.js';
|
|
9
|
-
import {
|
|
10
|
-
import type { IClassLinkProfile } from './profiles.js';
|
|
9
|
+
import type { ClassLinkClient } from './types.js';
|
|
11
10
|
/**
|
|
12
11
|
* ClassLink OneRoster client - read-only access.
|
|
13
12
|
*
|
|
@@ -35,5 +34,5 @@ import type { IClassLinkProfile } from './profiles.js';
|
|
|
35
34
|
* // client.usersManagement.createUser({}); // Error!
|
|
36
35
|
* ```
|
|
37
36
|
*/
|
|
38
|
-
export declare const ClassLink: new (options: SDKOptions) =>
|
|
37
|
+
export declare const ClassLink: new (options: SDKOptions) => ClassLinkClient;
|
|
39
38
|
//# sourceMappingURL=classlink.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"classlink.d.ts","sourceRoot":"","sources":["../../../src/clients/classlink.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;
|
|
1
|
+
{"version":3,"file":"classlink.d.ts","sourceRoot":"","sources":["../../../src/clients/classlink.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,SAAS,EAAE,KAAK,OAAO,EAAE,UAAU,KAAK,eAAkC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"classlink.js","sourceRoot":"","sources":["../../../src/clients/classlink.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAGH,0CAA0C;AAG1C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACU,QAAA,SAAS,
|
|
1
|
+
{"version":3,"file":"classlink.js","sourceRoot":"","sources":["../../../src/clients/classlink.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAGH,0CAA0C;AAG1C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACU,QAAA,SAAS,GAAiD,kBAAgB,CAAC"}
|
|
@@ -26,11 +26,12 @@
|
|
|
26
26
|
*/
|
|
27
27
|
import type { OneRoster } from '../sdk/sdk.js';
|
|
28
28
|
import type { IClassLinkProfile, IFullProfile } from './profiles.js';
|
|
29
|
+
type WithProfile<TBase, TProfile> = Omit<TBase, keyof TProfile> & TProfile;
|
|
29
30
|
/**
|
|
30
31
|
* Full OneRoster client with all capabilities.
|
|
31
32
|
* This is equivalent to using OneRoster directly without any profile constraint.
|
|
32
33
|
*/
|
|
33
|
-
export type FullClient =
|
|
34
|
+
export type FullClient = OneRosterClient<IFullProfile>;
|
|
34
35
|
/**
|
|
35
36
|
* ClassLink OneRoster client - read-only access.
|
|
36
37
|
*
|
|
@@ -57,7 +58,7 @@ export type FullClient = OneRoster & IFullProfile;
|
|
|
57
58
|
* // client.usersManagement.createUser({}); // Error!
|
|
58
59
|
* ```
|
|
59
60
|
*/
|
|
60
|
-
export type ClassLinkClient =
|
|
61
|
+
export type ClassLinkClient = OneRosterClient<IClassLinkProfile>;
|
|
61
62
|
/**
|
|
62
63
|
* Helper type to create a custom OneRoster client with a specific profile.
|
|
63
64
|
*
|
|
@@ -75,5 +76,6 @@ export type ClassLinkClient = OneRoster & IClassLinkProfile;
|
|
|
75
76
|
* const client: MyCustomClient = new OneRoster({...});
|
|
76
77
|
* ```
|
|
77
78
|
*/
|
|
78
|
-
export type OneRosterClient<TProfile> = OneRoster
|
|
79
|
+
export type OneRosterClient<TProfile> = WithProfile<OneRoster, TProfile>;
|
|
80
|
+
export {};
|
|
79
81
|
//# sourceMappingURL=types.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/clients/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAMrE;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/clients/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAMrE,KAAK,WAAW,CAAC,KAAK,EAAE,QAAQ,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,QAAQ,CAAC,GAAG,QAAQ,CAAC;AAE3E;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,MAAM,eAAe,GAAG,eAAe,CAAC,iBAAiB,CAAC,CAAC;AAMjE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,eAAe,CAAC,QAAQ,IAAI,WAAW,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/enums/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("../models/shared/index.js"), exports);
|
|
18
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/enums/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAA0C"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./components/index.js"), exports);
|
|
18
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC"}
|
|
@@ -5,4 +5,5 @@ export type { Result } from './fp.js';
|
|
|
5
5
|
export type { PageIterator, Paginator } from './operations.js';
|
|
6
6
|
export { createPageIterator } from './operations.js';
|
|
7
7
|
export { RFCDate } from './rfcdate.js';
|
|
8
|
+
export * from '../models/operations/index.js';
|
|
8
9
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxD,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,YAAY,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACtC,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxD,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,YAAY,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACtC,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC,cAAc,+BAA+B,CAAC"}
|
|
@@ -1,4 +1,18 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
2
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
17
|
exports.RFCDate = exports.createPageIterator = exports.catchUnrecognizedEnum = exports.isBlobLike = exports.blobLikeSchema = void 0;
|
|
4
18
|
var blobs_js_1 = require("./blobs.js");
|
|
@@ -10,4 +24,6 @@ var operations_js_1 = require("./operations.js");
|
|
|
10
24
|
Object.defineProperty(exports, "createPageIterator", { enumerable: true, get: function () { return operations_js_1.createPageIterator; } });
|
|
11
25
|
var rfcdate_js_1 = require("./rfcdate.js");
|
|
12
26
|
Object.defineProperty(exports, "RFCDate", { enumerable: true, get: function () { return rfcdate_js_1.RFCDate; } });
|
|
27
|
+
// Re-export API operations for a single runtime-compatible import path.
|
|
28
|
+
__exportStar(require("../models/operations/index.js"), exports);
|
|
13
29
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,uCAAwD;AAA/C,0GAAA,cAAc,OAAA;AAAE,sGAAA,UAAU,OAAA;AAEnC,uCAAmD;AAA1C,iHAAA,qBAAqB,OAAA;AAG9B,iDAAqD;AAA5C,mHAAA,kBAAkB,OAAA;AAC3B,2CAAuC;AAA9B,qGAAA,OAAO,OAAA;AAEhB,wEAAwE;AACxE,gEAA8C"}
|
|
@@ -6,8 +6,7 @@
|
|
|
6
6
|
* available methods to read-only operations that ClassLink supports.
|
|
7
7
|
*/
|
|
8
8
|
import type { SDKOptions } from '../lib/config.js';
|
|
9
|
-
import {
|
|
10
|
-
import type { IClassLinkProfile } from './profiles.js';
|
|
9
|
+
import type { ClassLinkClient } from './types.js';
|
|
11
10
|
/**
|
|
12
11
|
* ClassLink OneRoster client - read-only access.
|
|
13
12
|
*
|
|
@@ -35,5 +34,5 @@ import type { IClassLinkProfile } from './profiles.js';
|
|
|
35
34
|
* // client.usersManagement.createUser({}); // Error!
|
|
36
35
|
* ```
|
|
37
36
|
*/
|
|
38
|
-
export declare const ClassLink: new (options: SDKOptions) =>
|
|
37
|
+
export declare const ClassLink: new (options: SDKOptions) => ClassLinkClient;
|
|
39
38
|
//# sourceMappingURL=classlink.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"classlink.d.ts","sourceRoot":"","sources":["../../../src/clients/classlink.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;
|
|
1
|
+
{"version":3,"file":"classlink.d.ts","sourceRoot":"","sources":["../../../src/clients/classlink.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,SAAS,EAAE,KAAK,OAAO,EAAE,UAAU,KAAK,eAAkC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"classlink.js","sourceRoot":"","sources":["../../../src/clients/classlink.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAG1C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,MAAM,SAAS,
|
|
1
|
+
{"version":3,"file":"classlink.js","sourceRoot":"","sources":["../../../src/clients/classlink.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAG1C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,MAAM,SAAS,GAAiD,SAAgB,CAAC"}
|
|
@@ -26,11 +26,12 @@
|
|
|
26
26
|
*/
|
|
27
27
|
import type { OneRoster } from '../sdk/sdk.js';
|
|
28
28
|
import type { IClassLinkProfile, IFullProfile } from './profiles.js';
|
|
29
|
+
type WithProfile<TBase, TProfile> = Omit<TBase, keyof TProfile> & TProfile;
|
|
29
30
|
/**
|
|
30
31
|
* Full OneRoster client with all capabilities.
|
|
31
32
|
* This is equivalent to using OneRoster directly without any profile constraint.
|
|
32
33
|
*/
|
|
33
|
-
export type FullClient =
|
|
34
|
+
export type FullClient = OneRosterClient<IFullProfile>;
|
|
34
35
|
/**
|
|
35
36
|
* ClassLink OneRoster client - read-only access.
|
|
36
37
|
*
|
|
@@ -57,7 +58,7 @@ export type FullClient = OneRoster & IFullProfile;
|
|
|
57
58
|
* // client.usersManagement.createUser({}); // Error!
|
|
58
59
|
* ```
|
|
59
60
|
*/
|
|
60
|
-
export type ClassLinkClient =
|
|
61
|
+
export type ClassLinkClient = OneRosterClient<IClassLinkProfile>;
|
|
61
62
|
/**
|
|
62
63
|
* Helper type to create a custom OneRoster client with a specific profile.
|
|
63
64
|
*
|
|
@@ -75,5 +76,6 @@ export type ClassLinkClient = OneRoster & IClassLinkProfile;
|
|
|
75
76
|
* const client: MyCustomClient = new OneRoster({...});
|
|
76
77
|
* ```
|
|
77
78
|
*/
|
|
78
|
-
export type OneRosterClient<TProfile> = OneRoster
|
|
79
|
+
export type OneRosterClient<TProfile> = WithProfile<OneRoster, TProfile>;
|
|
80
|
+
export {};
|
|
79
81
|
//# sourceMappingURL=types.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/clients/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAMrE;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/clients/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAMrE,KAAK,WAAW,CAAC,KAAK,EAAE,QAAQ,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,QAAQ,CAAC,GAAG,QAAQ,CAAC;AAE3E;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,MAAM,eAAe,GAAG,eAAe,CAAC,iBAAiB,CAAC,CAAC;AAMjE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,eAAe,CAAC,QAAQ,IAAI,WAAW,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/enums/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/enums/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC"}
|
|
@@ -5,4 +5,5 @@ export type { Result } from './fp.js';
|
|
|
5
5
|
export type { PageIterator, Paginator } from './operations.js';
|
|
6
6
|
export { createPageIterator } from './operations.js';
|
|
7
7
|
export { RFCDate } from './rfcdate.js';
|
|
8
|
+
export * from '../models/operations/index.js';
|
|
8
9
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxD,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,YAAY,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACtC,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxD,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,YAAY,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACtC,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC,cAAc,+BAA+B,CAAC"}
|
package/dist/esm/types/index.js
CHANGED
|
@@ -2,4 +2,6 @@ export { blobLikeSchema, isBlobLike } from './blobs.js';
|
|
|
2
2
|
export { catchUnrecognizedEnum } from './enums.js';
|
|
3
3
|
export { createPageIterator } from './operations.js';
|
|
4
4
|
export { RFCDate } from './rfcdate.js';
|
|
5
|
+
// Re-export API operations for a single runtime-compatible import path.
|
|
6
|
+
export * from '../models/operations/index.js';
|
|
5
7
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExD,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAGnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExD,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAGnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,wEAAwE;AACxE,cAAc,+BAA+B,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@eduware/oneroster",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.7",
|
|
4
4
|
"description": "A TypeScript/JavaScript SDK for the OneRoster API standard - manage students, teachers, classes, enrollments, and academic data for K-12 education systems",
|
|
5
5
|
"author": "Eduware",
|
|
6
6
|
"license": "MIT",
|
|
@@ -51,13 +51,10 @@
|
|
|
51
51
|
"./package.json": "./package.json",
|
|
52
52
|
"./types": "./src/types/index.ts",
|
|
53
53
|
"./clients": "./src/clients/index.ts",
|
|
54
|
-
"./
|
|
55
|
-
"./models
|
|
56
|
-
"./
|
|
57
|
-
"./
|
|
58
|
-
"./models/shared": "./src/models/shared/index.ts",
|
|
59
|
-
"./*.js": "./src/*.ts",
|
|
60
|
-
"./*": "./src/*.ts"
|
|
54
|
+
"./enums": "./src/enums/index.ts",
|
|
55
|
+
"./models": "./src/models/index.ts",
|
|
56
|
+
"./core.js": "./src/core.ts",
|
|
57
|
+
"./funcs/*": "./src/funcs/*.ts"
|
|
61
58
|
}
|
|
62
59
|
},
|
|
63
60
|
"sideEffects": false,
|
|
@@ -144,81 +141,48 @@
|
|
|
144
141
|
"default": "./dist/commonjs/clients/index.js"
|
|
145
142
|
}
|
|
146
143
|
},
|
|
147
|
-
"./
|
|
144
|
+
"./enums": {
|
|
148
145
|
"import": {
|
|
149
|
-
"@eduware/oneroster/source": "./src/
|
|
150
|
-
"types": "./dist/esm/
|
|
151
|
-
"default": "./dist/esm/
|
|
146
|
+
"@eduware/oneroster/source": "./src/enums/index.ts",
|
|
147
|
+
"types": "./dist/esm/enums/index.d.ts",
|
|
148
|
+
"default": "./dist/esm/enums/index.js"
|
|
152
149
|
},
|
|
153
150
|
"require": {
|
|
154
|
-
"types": "./dist/commonjs/
|
|
155
|
-
"default": "./dist/commonjs/
|
|
151
|
+
"types": "./dist/commonjs/enums/index.d.ts",
|
|
152
|
+
"default": "./dist/commonjs/enums/index.js"
|
|
156
153
|
}
|
|
157
154
|
},
|
|
158
|
-
"./models
|
|
155
|
+
"./models": {
|
|
159
156
|
"import": {
|
|
160
|
-
"@eduware/oneroster/source": "./src/models/
|
|
161
|
-
"types": "./dist/esm/models/
|
|
162
|
-
"default": "./dist/esm/models/
|
|
157
|
+
"@eduware/oneroster/source": "./src/models/index.ts",
|
|
158
|
+
"types": "./dist/esm/models/index.d.ts",
|
|
159
|
+
"default": "./dist/esm/models/index.js"
|
|
163
160
|
},
|
|
164
161
|
"require": {
|
|
165
|
-
"types": "./dist/commonjs/models/
|
|
166
|
-
"default": "./dist/commonjs/models/
|
|
162
|
+
"types": "./dist/commonjs/models/index.d.ts",
|
|
163
|
+
"default": "./dist/commonjs/models/index.js"
|
|
167
164
|
}
|
|
168
165
|
},
|
|
169
|
-
"./
|
|
166
|
+
"./core.js": {
|
|
170
167
|
"import": {
|
|
171
|
-
"@eduware/oneroster/source": "./src/
|
|
172
|
-
"types": "./dist/esm/
|
|
173
|
-
"default": "./dist/esm/
|
|
168
|
+
"@eduware/oneroster/source": "./src/core.ts",
|
|
169
|
+
"types": "./dist/esm/core.d.ts",
|
|
170
|
+
"default": "./dist/esm/core.js"
|
|
174
171
|
},
|
|
175
172
|
"require": {
|
|
176
|
-
"types": "./dist/commonjs/
|
|
177
|
-
"default": "./dist/commonjs/
|
|
173
|
+
"types": "./dist/commonjs/core.d.ts",
|
|
174
|
+
"default": "./dist/commonjs/core.js"
|
|
178
175
|
}
|
|
179
176
|
},
|
|
180
|
-
"./
|
|
177
|
+
"./funcs/*": {
|
|
181
178
|
"import": {
|
|
182
|
-
"@eduware/oneroster/source": "./src/
|
|
183
|
-
"types": "./dist/esm/
|
|
184
|
-
"default": "./dist/esm/
|
|
179
|
+
"@eduware/oneroster/source": "./src/funcs/*.ts",
|
|
180
|
+
"types": "./dist/esm/funcs/*.d.ts",
|
|
181
|
+
"default": "./dist/esm/funcs/*.js"
|
|
185
182
|
},
|
|
186
183
|
"require": {
|
|
187
|
-
"types": "./dist/commonjs/
|
|
188
|
-
"default": "./dist/commonjs/
|
|
189
|
-
}
|
|
190
|
-
},
|
|
191
|
-
"./models/shared": {
|
|
192
|
-
"import": {
|
|
193
|
-
"@eduware/oneroster/source": "./src/models/shared/index.ts",
|
|
194
|
-
"types": "./dist/esm/models/shared/index.d.ts",
|
|
195
|
-
"default": "./dist/esm/models/shared/index.js"
|
|
196
|
-
},
|
|
197
|
-
"require": {
|
|
198
|
-
"types": "./dist/commonjs/models/shared/index.d.ts",
|
|
199
|
-
"default": "./dist/commonjs/models/shared/index.js"
|
|
200
|
-
}
|
|
201
|
-
},
|
|
202
|
-
"./*.js": {
|
|
203
|
-
"import": {
|
|
204
|
-
"@eduware/oneroster/source": "./src/*.ts",
|
|
205
|
-
"types": "./dist/esm/*.d.ts",
|
|
206
|
-
"default": "./dist/esm/*.js"
|
|
207
|
-
},
|
|
208
|
-
"require": {
|
|
209
|
-
"types": "./dist/commonjs/*.d.ts",
|
|
210
|
-
"default": "./dist/commonjs/*.js"
|
|
211
|
-
}
|
|
212
|
-
},
|
|
213
|
-
"./*": {
|
|
214
|
-
"import": {
|
|
215
|
-
"@eduware/oneroster/source": "./src/*.ts",
|
|
216
|
-
"types": "./dist/esm/*.d.ts",
|
|
217
|
-
"default": "./dist/esm/*.js"
|
|
218
|
-
},
|
|
219
|
-
"require": {
|
|
220
|
-
"types": "./dist/commonjs/*.d.ts",
|
|
221
|
-
"default": "./dist/commonjs/*.js"
|
|
184
|
+
"types": "./dist/commonjs/funcs/*.d.ts",
|
|
185
|
+
"default": "./dist/commonjs/funcs/*.js"
|
|
222
186
|
}
|
|
223
187
|
}
|
|
224
188
|
},
|
|
@@ -230,26 +194,20 @@
|
|
|
230
194
|
"clients": [
|
|
231
195
|
"./dist/esm/clients/index.d.ts"
|
|
232
196
|
],
|
|
233
|
-
"sdk": [
|
|
234
|
-
"./dist/esm/sdk/index.d.ts"
|
|
235
|
-
],
|
|
236
197
|
"types": [
|
|
237
198
|
"./dist/esm/types/index.d.ts"
|
|
238
199
|
],
|
|
239
|
-
"
|
|
240
|
-
"./dist/esm/
|
|
241
|
-
],
|
|
242
|
-
"models/components": [
|
|
243
|
-
"./dist/esm/models/components/index.d.ts"
|
|
200
|
+
"enums": [
|
|
201
|
+
"./dist/esm/enums/index.d.ts"
|
|
244
202
|
],
|
|
245
|
-
"models
|
|
246
|
-
"./dist/esm/models/
|
|
203
|
+
"models": [
|
|
204
|
+
"./dist/esm/models/index.d.ts"
|
|
247
205
|
],
|
|
248
|
-
"
|
|
249
|
-
"./dist/esm/
|
|
206
|
+
"core.js": [
|
|
207
|
+
"./dist/esm/core.d.ts"
|
|
250
208
|
],
|
|
251
|
-
"
|
|
252
|
-
"./dist/esm/*.d.ts"
|
|
209
|
+
"funcs/*": [
|
|
210
|
+
"./dist/esm/funcs/*.d.ts"
|
|
253
211
|
]
|
|
254
212
|
}
|
|
255
213
|
},
|
package/src/clients/classlink.ts
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
import type { SDKOptions } from '../lib/config.js';
|
|
10
10
|
import { OneRoster } from '../sdk/sdk.js';
|
|
11
|
-
import type {
|
|
11
|
+
import type { ClassLinkClient } from './types.js';
|
|
12
12
|
|
|
13
13
|
/**
|
|
14
14
|
* ClassLink OneRoster client - read-only access.
|
|
@@ -37,5 +37,4 @@ import type { IClassLinkProfile } from './profiles.js';
|
|
|
37
37
|
* // client.usersManagement.createUser({}); // Error!
|
|
38
38
|
* ```
|
|
39
39
|
*/
|
|
40
|
-
export const ClassLink: new (options: SDKOptions) => OneRoster
|
|
41
|
-
OneRoster as any;
|
|
40
|
+
export const ClassLink: new (options: SDKOptions) => ClassLinkClient = OneRoster as any;
|
package/src/clients/types.ts
CHANGED
|
@@ -32,11 +32,13 @@ import type { IClassLinkProfile, IFullProfile } from './profiles.js';
|
|
|
32
32
|
// Client Type Aliases
|
|
33
33
|
// ============================================================================
|
|
34
34
|
|
|
35
|
+
type WithProfile<TBase, TProfile> = Omit<TBase, keyof TProfile> & TProfile;
|
|
36
|
+
|
|
35
37
|
/**
|
|
36
38
|
* Full OneRoster client with all capabilities.
|
|
37
39
|
* This is equivalent to using OneRoster directly without any profile constraint.
|
|
38
40
|
*/
|
|
39
|
-
export type FullClient =
|
|
41
|
+
export type FullClient = OneRosterClient<IFullProfile>;
|
|
40
42
|
|
|
41
43
|
/**
|
|
42
44
|
* ClassLink OneRoster client - read-only access.
|
|
@@ -64,7 +66,7 @@ export type FullClient = OneRoster & IFullProfile;
|
|
|
64
66
|
* // client.usersManagement.createUser({}); // Error!
|
|
65
67
|
* ```
|
|
66
68
|
*/
|
|
67
|
-
export type ClassLinkClient =
|
|
69
|
+
export type ClassLinkClient = OneRosterClient<IClassLinkProfile>;
|
|
68
70
|
|
|
69
71
|
// ============================================================================
|
|
70
72
|
// Helper Type for Custom Profiles
|
|
@@ -87,4 +89,4 @@ export type ClassLinkClient = OneRoster & IClassLinkProfile;
|
|
|
87
89
|
* const client: MyCustomClient = new OneRoster({...});
|
|
88
90
|
* ```
|
|
89
91
|
*/
|
|
90
|
-
export type OneRosterClient<TProfile> = OneRoster
|
|
92
|
+
export type OneRosterClient<TProfile> = WithProfile<OneRoster, TProfile>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from '../models/shared/index.js';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './components/index.js';
|
package/src/types/index.ts
CHANGED
|
@@ -5,3 +5,6 @@ export type { Result } from './fp.js';
|
|
|
5
5
|
export type { PageIterator, Paginator } from './operations.js';
|
|
6
6
|
export { createPageIterator } from './operations.js';
|
|
7
7
|
export { RFCDate } from './rfcdate.js';
|
|
8
|
+
|
|
9
|
+
// Re-export API operations for a single runtime-compatible import path.
|
|
10
|
+
export * from '../models/operations/index.js';
|
package/vitest.config.ts
CHANGED
|
@@ -19,8 +19,8 @@ export default defineConfig({
|
|
|
19
19
|
DOTENV_CONFIG_PATH: './test/.env',
|
|
20
20
|
},
|
|
21
21
|
|
|
22
|
-
// Reporter options
|
|
23
|
-
reporters: ['default'
|
|
22
|
+
// Reporter options
|
|
23
|
+
reporters: ['default'],
|
|
24
24
|
|
|
25
25
|
// Globals (describe, it, expect, etc.)
|
|
26
26
|
globals: true,
|