@eduware/oneroster 1.2.6 → 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.
Files changed (13) hide show
  1. package/dist/commonjs/clients/classlink.d.ts +2 -3
  2. package/dist/commonjs/clients/classlink.d.ts.map +1 -1
  3. package/dist/commonjs/clients/classlink.js.map +1 -1
  4. package/dist/commonjs/clients/types.d.ts +5 -3
  5. package/dist/commonjs/clients/types.d.ts.map +1 -1
  6. package/dist/esm/clients/classlink.d.ts +2 -3
  7. package/dist/esm/clients/classlink.d.ts.map +1 -1
  8. package/dist/esm/clients/classlink.js.map +1 -1
  9. package/dist/esm/clients/types.d.ts +5 -3
  10. package/dist/esm/clients/types.d.ts.map +1 -1
  11. package/package.json +1 -1
  12. package/src/clients/classlink.ts +2 -3
  13. package/src/clients/types.ts +5 -3
package/dist/commonjs/clients/classlink.d.ts CHANGED
@@ -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 { OneRoster } from '../sdk/sdk.js';
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) => OneRoster & IClassLinkProfile;
37
+ export declare const ClassLink: new (options: SDKOptions) => ClassLinkClient;
39
38
  //# sourceMappingURL=classlink.d.ts.map
package/dist/commonjs/clients/classlink.d.ts.map CHANGED
@@ -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;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,SAAS,EAAE,KAAK,OAAO,EAAE,UAAU,KAAK,SAAS,GAAG,iBAC7C,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"}
package/dist/commonjs/clients/classlink.js.map CHANGED
@@ -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,GAClB,kBAAgB,CAAC"}
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"}
package/dist/commonjs/clients/types.d.ts CHANGED
@@ -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 = OneRoster & IFullProfile;
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 = OneRoster & IClassLinkProfile;
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 & TProfile;
79
+ export type OneRosterClient<TProfile> = WithProfile<OneRoster, TProfile>;
80
+ export {};
79
81
  //# sourceMappingURL=types.d.ts.map
package/dist/commonjs/clients/types.d.ts.map CHANGED
@@ -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,SAAS,GAAG,YAAY,CAAC;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,iBAAiB,CAAC;AAM5D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,eAAe,CAAC,QAAQ,IAAI,SAAS,GAAG,QAAQ,CAAC"}
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"}
package/dist/esm/clients/classlink.d.ts CHANGED
@@ -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 { OneRoster } from '../sdk/sdk.js';
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) => OneRoster & IClassLinkProfile;
37
+ export declare const ClassLink: new (options: SDKOptions) => ClassLinkClient;
39
38
  //# sourceMappingURL=classlink.d.ts.map
package/dist/esm/clients/classlink.d.ts.map CHANGED
@@ -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;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,SAAS,EAAE,KAAK,OAAO,EAAE,UAAU,KAAK,SAAS,GAAG,iBAC7C,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"}
package/dist/esm/clients/classlink.js.map CHANGED
@@ -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,GAClB,SAAgB,CAAC"}
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"}
package/dist/esm/clients/types.d.ts CHANGED
@@ -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 = OneRoster & IFullProfile;
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 = OneRoster & IClassLinkProfile;
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 & TProfile;
79
+ export type OneRosterClient<TProfile> = WithProfile<OneRoster, TProfile>;
80
+ export {};
79
81
  //# sourceMappingURL=types.d.ts.map
package/dist/esm/clients/types.d.ts.map CHANGED
@@ -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,SAAS,GAAG,YAAY,CAAC;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,iBAAiB,CAAC;AAM5D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,eAAe,CAAC,QAAQ,IAAI,SAAS,GAAG,QAAQ,CAAC"}
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"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@eduware/oneroster",
3
- "version": "1.2.6",
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",
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 { IClassLinkProfile } from './profiles.js';
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 & IClassLinkProfile =
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 = OneRoster & IFullProfile;
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 = OneRoster & IClassLinkProfile;
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 & TProfile;
92
+ export type OneRosterClient<TProfile> = WithProfile<OneRoster, TProfile>;