@timeback/oneroster 0.1.3 → 0.1.4
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/index.js +165 -135
- package/dist/resources/assessment/results.d.ts +2 -2
- package/dist/resources/assessment/results.d.ts.map +1 -1
- package/dist/resources/base.d.ts +10 -10
- package/dist/resources/base.d.ts.map +1 -1
- package/dist/resources/gradebook/categories.d.ts +3 -3
- package/dist/resources/gradebook/categories.d.ts.map +1 -1
- package/dist/resources/gradebook/results.d.ts +2 -2
- package/dist/resources/gradebook/results.d.ts.map +1 -1
- package/dist/resources/gradebook/score-scales.d.ts +2 -2
- package/dist/resources/gradebook/score-scales.d.ts.map +1 -1
- package/dist/resources/rostering/academic-sessions.d.ts +7 -8
- package/dist/resources/rostering/academic-sessions.d.ts.map +1 -1
- package/dist/resources/rostering/classes.d.ts +19 -19
- package/dist/resources/rostering/classes.d.ts.map +1 -1
- package/dist/resources/rostering/courses.d.ts +7 -7
- package/dist/resources/rostering/courses.d.ts.map +1 -1
- package/dist/resources/rostering/demographics.d.ts +2 -2
- package/dist/resources/rostering/demographics.d.ts.map +1 -1
- package/dist/resources/rostering/enrollments.d.ts +2 -2
- package/dist/resources/rostering/enrollments.d.ts.map +1 -1
- package/dist/resources/rostering/orgs.d.ts +2 -2
- package/dist/resources/rostering/orgs.d.ts.map +1 -1
- package/dist/resources/rostering/schools.d.ts +23 -23
- package/dist/resources/rostering/schools.d.ts.map +1 -1
- package/dist/resources/rostering/users.d.ts +10 -11
- package/dist/resources/rostering/users.d.ts.map +1 -1
- package/dist/types/callable.d.ts +25 -24
- package/dist/types/callable.d.ts.map +1 -1
- package/dist/types/index.d.ts +1 -0
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/list-params.d.ts +15 -0
- package/dist/types/list-params.d.ts.map +1 -0
- package/package.json +1 -1
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
*/
|
|
6
6
|
import { Paginator } from '../../lib';
|
|
7
7
|
import type { LineItemCreateInput } from '@timeback/types/zod';
|
|
8
|
-
import type {
|
|
8
|
+
import type { ListParamsNoSearch } from '../../types';
|
|
9
9
|
import type { AcademicSession, AcademicSessionFilterFields, Class, ClassFilterFields, Course, CourseFilterFields, CreateResponse, Enrollment, EnrollmentFilterFields, LineItem, LineItemFilterFields, OneRosterTransportLike, Organization, SchoolsCallable, ScoreScale, ScoreScaleFilterFields, User, UserFilterFields } from '../../types';
|
|
10
10
|
/**
|
|
11
11
|
* Scoped resource for a specific class within a school.
|
|
@@ -26,37 +26,37 @@ export declare class ScopedSchoolClassResource {
|
|
|
26
26
|
* @param params - Optional filter and pagination parameters
|
|
27
27
|
* @returns Promise resolving to enrollment array
|
|
28
28
|
*/
|
|
29
|
-
enrollments(params?:
|
|
29
|
+
enrollments(params?: ListParamsNoSearch<EnrollmentFilterFields>): Promise<Enrollment[]>;
|
|
30
30
|
/**
|
|
31
31
|
* Stream enrollments with lazy pagination.
|
|
32
32
|
* @param params - Optional filter and pagination parameters
|
|
33
33
|
* @returns Paginator for streaming enrollments
|
|
34
34
|
*/
|
|
35
|
-
streamEnrollments(params?:
|
|
35
|
+
streamEnrollments(params?: ListParamsNoSearch<EnrollmentFilterFields>): Paginator<Enrollment, EnrollmentFilterFields>;
|
|
36
36
|
/**
|
|
37
37
|
* List students in this class at this school.
|
|
38
38
|
* @param params - Optional filter and pagination parameters
|
|
39
39
|
* @returns Promise resolving to user array
|
|
40
40
|
*/
|
|
41
|
-
students(params?:
|
|
41
|
+
students(params?: ListParamsNoSearch<UserFilterFields>): Promise<User[]>;
|
|
42
42
|
/**
|
|
43
43
|
* Stream students with lazy pagination.
|
|
44
44
|
* @param params - Optional filter and pagination parameters
|
|
45
45
|
* @returns Paginator for streaming students
|
|
46
46
|
*/
|
|
47
|
-
streamStudents(params?:
|
|
47
|
+
streamStudents(params?: ListParamsNoSearch<UserFilterFields>): Paginator<User, UserFilterFields>;
|
|
48
48
|
/**
|
|
49
49
|
* List teachers for this class at this school.
|
|
50
50
|
* @param params - Optional filter and pagination parameters
|
|
51
51
|
* @returns Promise resolving to user array
|
|
52
52
|
*/
|
|
53
|
-
teachers(params?:
|
|
53
|
+
teachers(params?: ListParamsNoSearch<UserFilterFields>): Promise<User[]>;
|
|
54
54
|
/**
|
|
55
55
|
* Stream teachers with lazy pagination.
|
|
56
56
|
* @param params - Optional filter and pagination parameters
|
|
57
57
|
* @returns Paginator for streaming teachers
|
|
58
58
|
*/
|
|
59
|
-
streamTeachers(params?:
|
|
59
|
+
streamTeachers(params?: ListParamsNoSearch<UserFilterFields>): Paginator<User, UserFilterFields>;
|
|
60
60
|
}
|
|
61
61
|
/**
|
|
62
62
|
* Scoped resource for operations on a specific school.
|
|
@@ -95,85 +95,85 @@ export declare class ScopedSchoolResource {
|
|
|
95
95
|
* @param params - Optional filter and pagination parameters
|
|
96
96
|
* @returns Promise resolving to class array
|
|
97
97
|
*/
|
|
98
|
-
classes(params?:
|
|
98
|
+
classes(params?: ListParamsNoSearch<ClassFilterFields>): Promise<Class[]>;
|
|
99
99
|
/**
|
|
100
100
|
* Stream classes with lazy pagination.
|
|
101
101
|
* @param params - Optional filter and pagination parameters
|
|
102
102
|
* @returns Paginator for streaming classes
|
|
103
103
|
*/
|
|
104
|
-
streamClasses(params?:
|
|
104
|
+
streamClasses(params?: ListParamsNoSearch<ClassFilterFields>): Paginator<Class, ClassFilterFields>;
|
|
105
105
|
/**
|
|
106
106
|
* List enrollments in this school.
|
|
107
107
|
* @param params - Optional filter and pagination parameters
|
|
108
108
|
* @returns Promise resolving to enrollment array
|
|
109
109
|
*/
|
|
110
|
-
enrollments(params?:
|
|
110
|
+
enrollments(params?: ListParamsNoSearch<EnrollmentFilterFields>): Promise<Enrollment[]>;
|
|
111
111
|
/**
|
|
112
112
|
* Stream enrollments with lazy pagination.
|
|
113
113
|
* @param params - Optional filter and pagination parameters
|
|
114
114
|
* @returns Paginator for streaming enrollments
|
|
115
115
|
*/
|
|
116
|
-
streamEnrollments(params?:
|
|
116
|
+
streamEnrollments(params?: ListParamsNoSearch<EnrollmentFilterFields>): Paginator<Enrollment, EnrollmentFilterFields>;
|
|
117
117
|
/**
|
|
118
118
|
* List students in this school.
|
|
119
119
|
* @param params - Optional filter and pagination parameters
|
|
120
120
|
* @returns Promise resolving to user array
|
|
121
121
|
*/
|
|
122
|
-
students(params?:
|
|
122
|
+
students(params?: ListParamsNoSearch<UserFilterFields>): Promise<User[]>;
|
|
123
123
|
/**
|
|
124
124
|
* Stream students with lazy pagination.
|
|
125
125
|
* @param params - Optional filter and pagination parameters
|
|
126
126
|
* @returns Paginator for streaming students
|
|
127
127
|
*/
|
|
128
|
-
streamStudents(params?:
|
|
128
|
+
streamStudents(params?: ListParamsNoSearch<UserFilterFields>): Paginator<User, UserFilterFields>;
|
|
129
129
|
/**
|
|
130
130
|
* List teachers in this school.
|
|
131
131
|
* @param params - Optional filter and pagination parameters
|
|
132
132
|
* @returns Promise resolving to user array
|
|
133
133
|
*/
|
|
134
|
-
teachers(params?:
|
|
134
|
+
teachers(params?: ListParamsNoSearch<UserFilterFields>): Promise<User[]>;
|
|
135
135
|
/**
|
|
136
136
|
* Stream teachers with lazy pagination.
|
|
137
137
|
* @param params - Optional filter and pagination parameters
|
|
138
138
|
* @returns Paginator for streaming teachers
|
|
139
139
|
*/
|
|
140
|
-
streamTeachers(params?:
|
|
140
|
+
streamTeachers(params?: ListParamsNoSearch<UserFilterFields>): Paginator<User, UserFilterFields>;
|
|
141
141
|
/**
|
|
142
142
|
* List courses in this school.
|
|
143
143
|
* @param params - Optional filter and pagination parameters
|
|
144
144
|
* @returns Promise resolving to course array
|
|
145
145
|
*/
|
|
146
|
-
courses(params?:
|
|
146
|
+
courses(params?: ListParamsNoSearch<CourseFilterFields>): Promise<Course[]>;
|
|
147
147
|
/**
|
|
148
148
|
* Stream courses with lazy pagination.
|
|
149
149
|
* @param params - Optional filter and pagination parameters
|
|
150
150
|
* @returns Paginator for streaming courses
|
|
151
151
|
*/
|
|
152
|
-
streamCourses(params?:
|
|
152
|
+
streamCourses(params?: ListParamsNoSearch<CourseFilterFields>): Paginator<Course, CourseFilterFields>;
|
|
153
153
|
/**
|
|
154
154
|
* List terms/academic sessions for this school.
|
|
155
155
|
* @param params - Optional filter and pagination parameters
|
|
156
156
|
* @returns Promise resolving to academic session array
|
|
157
157
|
*/
|
|
158
|
-
terms(params?:
|
|
158
|
+
terms(params?: ListParamsNoSearch<AcademicSessionFilterFields>): Promise<AcademicSession[]>;
|
|
159
159
|
/**
|
|
160
160
|
* Stream terms with lazy pagination.
|
|
161
161
|
* @param params - Optional filter and pagination parameters
|
|
162
162
|
* @returns Paginator for streaming academic sessions
|
|
163
163
|
*/
|
|
164
|
-
streamTerms(params?:
|
|
164
|
+
streamTerms(params?: ListParamsNoSearch<AcademicSessionFilterFields>): Paginator<AcademicSession, AcademicSessionFilterFields>;
|
|
165
165
|
/**
|
|
166
166
|
* List line items (assignments) in this school.
|
|
167
167
|
* @param params - Optional filter and pagination parameters
|
|
168
168
|
* @returns Promise resolving to line item array
|
|
169
169
|
*/
|
|
170
|
-
lineItems(params?:
|
|
170
|
+
lineItems(params?: ListParamsNoSearch<LineItemFilterFields>): Promise<LineItem[]>;
|
|
171
171
|
/**
|
|
172
172
|
* Stream line items with lazy pagination.
|
|
173
173
|
* @param params - Optional filter and pagination parameters
|
|
174
174
|
* @returns Paginator for streaming line items
|
|
175
175
|
*/
|
|
176
|
-
streamLineItems(params?:
|
|
176
|
+
streamLineItems(params?: ListParamsNoSearch<LineItemFilterFields>): Paginator<LineItem, LineItemFilterFields>;
|
|
177
177
|
/**
|
|
178
178
|
* Create a line item (assignment) in this school.
|
|
179
179
|
*
|
|
@@ -198,13 +198,13 @@ export declare class ScopedSchoolResource {
|
|
|
198
198
|
* @param params - Optional filter and pagination parameters
|
|
199
199
|
* @returns Promise resolving to score scale array
|
|
200
200
|
*/
|
|
201
|
-
scoreScales(params?:
|
|
201
|
+
scoreScales(params?: ListParamsNoSearch<ScoreScaleFilterFields>): Promise<ScoreScale[]>;
|
|
202
202
|
/**
|
|
203
203
|
* Stream score scales with lazy pagination.
|
|
204
204
|
* @param params - Optional filter and pagination parameters
|
|
205
205
|
* @returns Paginator for streaming score scales
|
|
206
206
|
*/
|
|
207
|
-
streamScoreScales(params?:
|
|
207
|
+
streamScoreScales(params?: ListParamsNoSearch<ScoreScaleFilterFields>): Paginator<ScoreScale, ScoreScaleFilterFields>;
|
|
208
208
|
}
|
|
209
209
|
/**
|
|
210
210
|
* Create a callable schools resource.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schools.d.ts","sourceRoot":"","sources":["../../../src/resources/rostering/schools.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAKrC,OAAO,KAAK,EAAE,mBAAmB,EAAqB,MAAM,qBAAqB,CAAA;AACjF,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"schools.d.ts","sourceRoot":"","sources":["../../../src/resources/rostering/schools.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAKrC,OAAO,KAAK,EAAE,mBAAmB,EAAqB,MAAM,qBAAqB,CAAA;AACjF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACrD,OAAO,KAAK,EACX,eAAe,EACf,2BAA2B,EAC3B,KAAK,EACL,iBAAiB,EACjB,MAAM,EACN,kBAAkB,EAClB,cAAc,EACd,UAAU,EACV,sBAAsB,EACtB,QAAQ,EACR,oBAAoB,EACpB,sBAAsB,EACtB,YAAY,EAEZ,eAAe,EACf,UAAU,EACV,sBAAsB,EACtB,IAAI,EACJ,gBAAgB,EAChB,MAAM,aAAa,CAAA;AAMpB;;;;;;;;;GASG;AACH,qBAAa,yBAAyB;IAIpC,OAAO,CAAC,QAAQ,CAAC,SAAS;IAH3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IAEjC,YACkB,SAAS,EAAE,sBAAsB,EAClD,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAKf;IAED;;;;OAIG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,sBAAsB,CAAC,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAEtF;IAED;;;;OAIG;IACH,iBAAiB,CAChB,MAAM,CAAC,EAAE,kBAAkB,CAAC,sBAAsB,CAAC,GACjD,SAAS,CAAC,UAAU,EAAE,sBAAsB,CAAC,CAO/C;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAEvE;IAED;;;;OAIG;IACH,cAAc,CACb,MAAM,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,GAC3C,SAAS,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAOnC;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAEvE;IAED;;;;OAIG;IACH,cAAc,CACb,MAAM,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,GAC3C,SAAS,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAOnC;CACD;AAMD;;;;;;;;;;;;;;GAcG;AACH,qBAAa,oBAAoB;IAM/B,OAAO,CAAC,QAAQ,CAAC,SAAS;IAL3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IACjC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAQ;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IAEjC,YACkB,SAAS,EAAE,sBAAsB,EAClD,QAAQ,EAAE,MAAM,EAMhB;IAED;;;OAGG;IACG,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,CAGjC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,yBAAyB,CAEhD;IAED;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAExE;IAED;;;;OAIG;IACH,aAAa,CACZ,MAAM,CAAC,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,GAC5C,SAAS,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAOrC;IAED;;;;OAIG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,sBAAsB,CAAC,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAEtF;IAED;;;;OAIG;IACH,iBAAiB,CAChB,MAAM,CAAC,EAAE,kBAAkB,CAAC,sBAAsB,CAAC,GACjD,SAAS,CAAC,UAAU,EAAE,sBAAsB,CAAC,CAO/C;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAEvE;IAED;;;;OAIG;IACH,cAAc,CACb,MAAM,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,GAC3C,SAAS,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAOnC;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAEvE;IAED;;;;OAIG;IACH,cAAc,CACb,MAAM,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,GAC3C,SAAS,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAOnC;IAED;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAE1E;IAED;;;;OAIG;IACH,aAAa,CACZ,MAAM,CAAC,EAAE,kBAAkB,CAAC,kBAAkB,CAAC,GAC7C,SAAS,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAOvC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,2BAA2B,CAAC,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC,CAE1F;IAED;;;;OAIG;IACH,WAAW,CACV,MAAM,CAAC,EAAE,kBAAkB,CAAC,2BAA2B,CAAC,GACtD,SAAS,CAAC,eAAe,EAAE,2BAA2B,CAAC,CAYzD;IAED;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,oBAAoB,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAEhF;IAED;;;;OAIG;IACH,eAAe,CACd,MAAM,CAAC,EAAE,kBAAkB,CAAC,oBAAoB,CAAC,GAC/C,SAAS,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAO3C;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,cAAc,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,cAAc,CAAC,CAMjE;IAED;;;;OAIG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,sBAAsB,CAAC,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAEtF;IAED;;;;OAIG;IACH,iBAAiB,CAChB,MAAM,CAAC,EAAE,kBAAkB,CAAC,sBAAsB,CAAC,GACjD,SAAS,CAAC,UAAU,EAAE,sBAAsB,CAAC,CAO/C;CACD;AAsCD;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,sBAAsB,GAAG,eAAe,CAexF"}
|
|
@@ -3,10 +3,9 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Access all users regardless of role.
|
|
5
5
|
*/
|
|
6
|
-
import type { AgentInput } from '@timeback/types/zod';
|
|
7
6
|
import { Paginator } from '../../lib';
|
|
8
|
-
import type {
|
|
9
|
-
import type { Class, ClassFilterFields, CredentialCreateResponse, DecryptedCredential, OneRosterTransportLike, Resource, ResourceFilterFields, StudentsCallable, TeachersCallable, User, UserProfileCredential, UsersCallable } from '../../types';
|
|
7
|
+
import type { AgentInput } from '@timeback/types/zod';
|
|
8
|
+
import type { Class, ClassFilterFields, CredentialCreateResponse, DecryptedCredential, ListParamsNoSearch, OneRosterTransportLike, Resource, ResourceFilterFields, StudentsCallable, TeachersCallable, User, UserProfileCredential, UsersCallable } from '../../types';
|
|
10
9
|
/**
|
|
11
10
|
* Scoped resource for operations on a specific user.
|
|
12
11
|
*
|
|
@@ -41,25 +40,25 @@ export declare class ScopedUserResource {
|
|
|
41
40
|
* @param params - Optional filter and pagination parameters
|
|
42
41
|
* @returns Promise resolving to resource array
|
|
43
42
|
*/
|
|
44
|
-
resources(params?:
|
|
43
|
+
resources(params?: ListParamsNoSearch<ResourceFilterFields>): Promise<Resource[]>;
|
|
45
44
|
/**
|
|
46
45
|
* Stream resources with lazy pagination.
|
|
47
46
|
* @param params - Optional filter and pagination parameters
|
|
48
47
|
* @returns Paginator for streaming resources
|
|
49
48
|
*/
|
|
50
|
-
streamResources(params?:
|
|
49
|
+
streamResources(params?: ListParamsNoSearch<ResourceFilterFields>): Paginator<Resource, ResourceFilterFields>;
|
|
51
50
|
/**
|
|
52
51
|
* List classes for this user.
|
|
53
52
|
* @param params - Optional filter and pagination parameters
|
|
54
53
|
* @returns Promise resolving to class array
|
|
55
54
|
*/
|
|
56
|
-
classes(params?:
|
|
55
|
+
classes(params?: ListParamsNoSearch<ClassFilterFields>): Promise<Class[]>;
|
|
57
56
|
/**
|
|
58
57
|
* Stream classes with lazy pagination.
|
|
59
58
|
* @param params - Optional filter and pagination parameters
|
|
60
59
|
* @returns Paginator for streaming classes
|
|
61
60
|
*/
|
|
62
|
-
streamClasses(params?:
|
|
61
|
+
streamClasses(params?: ListParamsNoSearch<ClassFilterFields>): Paginator<Class, ClassFilterFields>;
|
|
63
62
|
/**
|
|
64
63
|
* Get users that this user is an agent (guardian/parent) for.
|
|
65
64
|
*
|
|
@@ -140,13 +139,13 @@ export declare class ScopedStudentResource {
|
|
|
140
139
|
* @param params - Optional filter and pagination parameters
|
|
141
140
|
* @returns Promise resolving to class array
|
|
142
141
|
*/
|
|
143
|
-
classes(params?:
|
|
142
|
+
classes(params?: ListParamsNoSearch<ClassFilterFields>): Promise<Class[]>;
|
|
144
143
|
/**
|
|
145
144
|
* Stream classes with lazy pagination.
|
|
146
145
|
* @param params - Optional filter and pagination parameters
|
|
147
146
|
* @returns Paginator for streaming classes
|
|
148
147
|
*/
|
|
149
|
-
streamClasses(params?:
|
|
148
|
+
streamClasses(params?: ListParamsNoSearch<ClassFilterFields>): Paginator<Class, ClassFilterFields>;
|
|
150
149
|
}
|
|
151
150
|
/**
|
|
152
151
|
* Scoped resource for operations on a specific teacher.
|
|
@@ -173,13 +172,13 @@ export declare class ScopedTeacherResource {
|
|
|
173
172
|
* @param params - Optional filter and pagination parameters
|
|
174
173
|
* @returns Promise resolving to class array
|
|
175
174
|
*/
|
|
176
|
-
classes(params?:
|
|
175
|
+
classes(params?: ListParamsNoSearch<ClassFilterFields>): Promise<Class[]>;
|
|
177
176
|
/**
|
|
178
177
|
* Stream classes with lazy pagination.
|
|
179
178
|
* @param params - Optional filter and pagination parameters
|
|
180
179
|
* @returns Paginator for streaming classes
|
|
181
180
|
*/
|
|
182
|
-
streamClasses(params?:
|
|
181
|
+
streamClasses(params?: ListParamsNoSearch<ClassFilterFields>): Paginator<Class, ClassFilterFields>;
|
|
183
182
|
}
|
|
184
183
|
/**
|
|
185
184
|
* Create a callable students resource.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/resources/rostering/users.ts"],"names":[],"mappings":"AAAA;;;;GAIG;
|
|
1
|
+
{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/resources/rostering/users.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AASH,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAKrC,OAAO,KAAK,EAAE,UAAU,EAAmB,MAAM,qBAAqB,CAAA;AACtE,OAAO,KAAK,EACX,KAAK,EACL,iBAAiB,EACjB,wBAAwB,EACxB,mBAAmB,EACnB,kBAAkB,EAClB,sBAAsB,EACtB,QAAQ,EACR,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,IAAI,EAEJ,qBAAqB,EACrB,aAAa,EACb,MAAM,aAAa,CAAA;AAMpB;;;;;;;;;;GAUG;AACH,qBAAa,kBAAkB;IAK7B,OAAO,CAAC,QAAQ,CAAC,SAAS;IAJ3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IACjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAE/B,YACkB,SAAS,EAAE,sBAAsB,EAClD,MAAM,EAAE,MAAM,EAKd;IAED;;;OAGG;IACG,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAOzB;IAED;;;;;;OAMG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CASlC;IAED;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,oBAAoB,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAEhF;IAED;;;;OAIG;IACH,eAAe,CACd,MAAM,CAAC,EAAE,kBAAkB,CAAC,oBAAoB,CAAC,GAC/C,SAAS,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAO3C;IAED;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAExE;IAED;;;;OAIG;IACH,aAAa,CACZ,MAAM,CAAC,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,GAC5C,SAAS,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAOrC;IAID;;;;;;OAMG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,CAShC;IAED;;;;;;OAMG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,CAO9B;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAMxC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAKjD;IAID;;;;;;OAMG;IACH,gBAAgB,CACf,UAAU,EAAE,OAAO,CAAC,qBAAqB,CAAC,GACxC,OAAO,CAAC,wBAAwB,CAAC,CAMnC;IAED;;;;;;OAMG;IACH,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAMpE;CACD;AA4CD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,sBAAsB,GAAG,aAAa,CAepF;AAUD;;;;;;;;;;GAUG;AACH,qBAAa,qBAAqB;IAIhC,OAAO,CAAC,QAAQ,CAAC,SAAS;IAH3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IAEjC,YACkB,SAAS,EAAE,sBAAsB,EAClD,SAAS,EAAE,MAAM,EAIjB;IAED;;;OAGG;IACG,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAOzB;IAED;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAExE;IAED;;;;OAIG;IACH,aAAa,CACZ,MAAM,CAAC,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,GAC5C,SAAS,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAOrC;CACD;AAMD;;;;;;;;;;GAUG;AACH,qBAAa,qBAAqB;IAIhC,OAAO,CAAC,QAAQ,CAAC,SAAS;IAH3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IAEjC,YACkB,SAAS,EAAE,sBAAsB,EAClD,SAAS,EAAE,MAAM,EAIjB;IAED;;;OAGG;IACG,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAOzB;IAED;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAExE;IAED;;;;OAIG;IACH,aAAa,CACZ,MAAM,CAAC,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,GAC5C,SAAS,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAOrC;CACD;AA6BD;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,sBAAsB,GAAG,gBAAgB,CAY1F;AAiCD;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,sBAAsB,GAAG,gBAAgB,CAY1F"}
|
package/dist/types/callable.d.ts
CHANGED
|
@@ -16,6 +16,7 @@ import type { ScopedClassResource } from '../resources/rostering/classes';
|
|
|
16
16
|
import type { ScopedCourseResource } from '../resources/rostering/courses';
|
|
17
17
|
import type { ScopedSchoolResource } from '../resources/rostering/schools';
|
|
18
18
|
import type { ScopedStudentResource, ScopedTeacherResource, ScopedUserResource } from '../resources/rostering/users';
|
|
19
|
+
import type { ListParamsNoSearch, ListParamsWithSearch } from './list-params';
|
|
19
20
|
import type { AcademicSession, AcademicSessionFilterFields, AssessmentLineItem, AssessmentLineItemFilterFields, Base, Class, ClassFilterFields, ComponentResource, ComponentResourceFilterFields, Course, CourseComponent, CourseComponentFilterFields, CourseFilterFields, CreateResponse, LineItem, LineItemFilterFields, Organization, OrganizationFilterFields, Resource, ResourceFilterFields, User, UserFilterFields } from './index';
|
|
20
21
|
/**
|
|
21
22
|
* Base interface for callable resources.
|
|
@@ -26,17 +27,17 @@ import type { AcademicSession, AcademicSessionFilterFields, AssessmentLineItem,
|
|
|
26
27
|
* @template S - Scoped resource type returned when called with an ID
|
|
27
28
|
* @template I - Input type for create/update (defaults to Partial<T>)
|
|
28
29
|
*/
|
|
29
|
-
export interface CallableResource<T extends Base, F, S, I = Partial<T>> {
|
|
30
|
+
export interface CallableResource<T extends Base, F, S, I = Partial<T>, P extends ListParams<F> = ListParams<F>> {
|
|
30
31
|
/** Get a scoped resource for a specific entity */
|
|
31
32
|
(id: string): S;
|
|
32
33
|
/** List the first page of entities */
|
|
33
|
-
list(params?:
|
|
34
|
+
list(params?: P): Promise<import('@timeback/internal-client-infra').PageResult<T>>;
|
|
34
35
|
/** List all entities (fetches all pages) */
|
|
35
|
-
listAll(params?:
|
|
36
|
+
listAll(params?: P): Promise<T[]>;
|
|
36
37
|
/** Get the first matching entity, or undefined if none match */
|
|
37
|
-
first(params?:
|
|
38
|
+
first(params?: P): Promise<T | undefined>;
|
|
38
39
|
/** Stream entities with lazy pagination */
|
|
39
|
-
stream(params?:
|
|
40
|
+
stream(params?: P): Paginator<T, F>;
|
|
40
41
|
/** Get a single entity by ID */
|
|
41
42
|
get(id: string): Promise<T>;
|
|
42
43
|
/** Create a new entity */
|
|
@@ -53,17 +54,17 @@ export interface CallableResource<T extends Base, F, S, I = Partial<T>> {
|
|
|
53
54
|
* @template F - Filter fields type
|
|
54
55
|
* @template S - Scoped resource type returned when called with an ID
|
|
55
56
|
*/
|
|
56
|
-
export interface ReadOnlyCallableResource<T extends Base, F, S> {
|
|
57
|
+
export interface ReadOnlyCallableResource<T extends Base, F, S, P extends ListParams<F> = ListParams<F>> {
|
|
57
58
|
/** Get a scoped resource for a specific entity */
|
|
58
59
|
(id: string): S;
|
|
59
60
|
/** List the first page of entities */
|
|
60
|
-
list(params?:
|
|
61
|
+
list(params?: P): Promise<import('@timeback/internal-client-infra').PageResult<T>>;
|
|
61
62
|
/** List all entities (fetches all pages) */
|
|
62
|
-
listAll(params?:
|
|
63
|
+
listAll(params?: P): Promise<T[]>;
|
|
63
64
|
/** Get the first matching entity, or undefined if none match */
|
|
64
|
-
first(params?:
|
|
65
|
+
first(params?: P): Promise<T | undefined>;
|
|
65
66
|
/** Stream entities with lazy pagination */
|
|
66
|
-
stream(params?:
|
|
67
|
+
stream(params?: P): Paginator<T, F>;
|
|
67
68
|
/** Get a single entity by ID */
|
|
68
69
|
get(id: string): Promise<T>;
|
|
69
70
|
}
|
|
@@ -80,11 +81,11 @@ export interface ReadOnlyCallableResource<T extends Base, F, S> {
|
|
|
80
81
|
* const classes = await client.courses(courseId).classes()
|
|
81
82
|
* ```
|
|
82
83
|
*/
|
|
83
|
-
export interface CoursesCallable extends CallableResource<Course, CourseFilterFields, ScopedCourseResource, CourseCreateInput
|
|
84
|
+
export interface CoursesCallable extends CallableResource<Course, CourseFilterFields, ScopedCourseResource, CourseCreateInput, ListParamsWithSearch<CourseFilterFields>> {
|
|
84
85
|
/** List all course components */
|
|
85
|
-
components(params?:
|
|
86
|
+
components(params?: ListParamsNoSearch<CourseComponentFilterFields>): Promise<CourseComponent[]>;
|
|
86
87
|
/** Stream course components with lazy pagination */
|
|
87
|
-
streamComponents(params?:
|
|
88
|
+
streamComponents(params?: ListParamsNoSearch<CourseComponentFilterFields>): Paginator<CourseComponent, CourseComponentFilterFields>;
|
|
88
89
|
/** Get a specific course component */
|
|
89
90
|
getComponent(sourcedId: string): Promise<CourseComponent>;
|
|
90
91
|
/** Create a new course component */
|
|
@@ -94,9 +95,9 @@ export interface CoursesCallable extends CallableResource<Course, CourseFilterFi
|
|
|
94
95
|
/** Delete a course component */
|
|
95
96
|
deleteComponent(sourcedId: string): Promise<void>;
|
|
96
97
|
/** List all component resources */
|
|
97
|
-
componentResources(params?:
|
|
98
|
+
componentResources(params?: ListParamsNoSearch<ComponentResourceFilterFields>): Promise<ComponentResource[]>;
|
|
98
99
|
/** Stream component resources with lazy pagination */
|
|
99
|
-
streamComponentResources(params?:
|
|
100
|
+
streamComponentResources(params?: ListParamsNoSearch<ComponentResourceFilterFields>): Paginator<ComponentResource, ComponentResourceFilterFields>;
|
|
100
101
|
/** Get a specific component resource */
|
|
101
102
|
getComponentResource(sourcedId: string): Promise<ComponentResource>;
|
|
102
103
|
/** Create a new component resource */
|
|
@@ -122,7 +123,7 @@ export interface CoursesCallable extends CallableResource<Course, CourseFilterFi
|
|
|
122
123
|
* const lineItems = await client.classes(classId).lineItems()
|
|
123
124
|
* ```
|
|
124
125
|
*/
|
|
125
|
-
export type ClassesCallable = CallableResource<Class, ClassFilterFields, ScopedClassResource, ClassCreateInput
|
|
126
|
+
export type ClassesCallable = CallableResource<Class, ClassFilterFields, ScopedClassResource, ClassCreateInput, ListParamsNoSearch<ClassFilterFields>>;
|
|
126
127
|
/**
|
|
127
128
|
* Callable schools resource.
|
|
128
129
|
*
|
|
@@ -137,7 +138,7 @@ export type ClassesCallable = CallableResource<Class, ClassFilterFields, ScopedC
|
|
|
137
138
|
* const students = await client.schools(schoolId).students()
|
|
138
139
|
* ```
|
|
139
140
|
*/
|
|
140
|
-
export type SchoolsCallable = CallableResource<Organization, OrganizationFilterFields, ScopedSchoolResource, SchoolCreateInput
|
|
141
|
+
export type SchoolsCallable = CallableResource<Organization, OrganizationFilterFields, ScopedSchoolResource, SchoolCreateInput, ListParamsNoSearch<OrganizationFilterFields>>;
|
|
141
142
|
/**
|
|
142
143
|
* Callable users resource.
|
|
143
144
|
*
|
|
@@ -152,7 +153,7 @@ export type SchoolsCallable = CallableResource<Organization, OrganizationFilterF
|
|
|
152
153
|
* const classes = await client.users(userId).classes()
|
|
153
154
|
* ```
|
|
154
155
|
*/
|
|
155
|
-
export type UsersCallable = CallableResource<User, UserFilterFields, ScopedUserResource, UserCreateInput
|
|
156
|
+
export type UsersCallable = CallableResource<User, UserFilterFields, ScopedUserResource, UserCreateInput, ListParamsWithSearch<UserFilterFields>>;
|
|
156
157
|
/**
|
|
157
158
|
* Callable students resource (read-only).
|
|
158
159
|
*
|
|
@@ -166,7 +167,7 @@ export type UsersCallable = CallableResource<User, UserFilterFields, ScopedUserR
|
|
|
166
167
|
* const classes = await client.students(studentId).classes()
|
|
167
168
|
* ```
|
|
168
169
|
*/
|
|
169
|
-
export type StudentsCallable = ReadOnlyCallableResource<User, UserFilterFields, ScopedStudentResource
|
|
170
|
+
export type StudentsCallable = ReadOnlyCallableResource<User, UserFilterFields, ScopedStudentResource, ListParamsWithSearch<UserFilterFields>>;
|
|
170
171
|
/**
|
|
171
172
|
* Callable teachers resource (read-only).
|
|
172
173
|
*
|
|
@@ -180,7 +181,7 @@ export type StudentsCallable = ReadOnlyCallableResource<User, UserFilterFields,
|
|
|
180
181
|
* const classes = await client.teachers(teacherId).classes()
|
|
181
182
|
* ```
|
|
182
183
|
*/
|
|
183
|
-
export type TeachersCallable = ReadOnlyCallableResource<User, UserFilterFields, ScopedTeacherResource
|
|
184
|
+
export type TeachersCallable = ReadOnlyCallableResource<User, UserFilterFields, ScopedTeacherResource, ListParamsNoSearch<UserFilterFields>>;
|
|
184
185
|
/**
|
|
185
186
|
* Callable terms resource (read-only).
|
|
186
187
|
*
|
|
@@ -194,7 +195,7 @@ export type TeachersCallable = ReadOnlyCallableResource<User, UserFilterFields,
|
|
|
194
195
|
* const classes = await client.terms(termId).classes()
|
|
195
196
|
* ```
|
|
196
197
|
*/
|
|
197
|
-
export type TermsCallable = ReadOnlyCallableResource<AcademicSession, AcademicSessionFilterFields, ScopedTermResource
|
|
198
|
+
export type TermsCallable = ReadOnlyCallableResource<AcademicSession, AcademicSessionFilterFields, ScopedTermResource, ListParamsNoSearch<AcademicSessionFilterFields>>;
|
|
198
199
|
/**
|
|
199
200
|
* Callable line items resource.
|
|
200
201
|
*
|
|
@@ -208,7 +209,7 @@ export type TermsCallable = ReadOnlyCallableResource<AcademicSession, AcademicSe
|
|
|
208
209
|
* const results = await client.lineItems(lineItemId).results()
|
|
209
210
|
* ```
|
|
210
211
|
*/
|
|
211
|
-
export interface LineItemsCallable extends CallableResource<LineItem, LineItemFilterFields, ScopedLineItemResource, LineItemCreateInput
|
|
212
|
+
export interface LineItemsCallable extends CallableResource<LineItem, LineItemFilterFields, ScopedLineItemResource, LineItemCreateInput, ListParamsNoSearch<LineItemFilterFields>> {
|
|
212
213
|
}
|
|
213
214
|
/**
|
|
214
215
|
* Callable assessment line items resource.
|
|
@@ -223,7 +224,7 @@ export interface LineItemsCallable extends CallableResource<LineItem, LineItemFi
|
|
|
223
224
|
* await client.assessmentLineItems.patch(id, { score: 95 })
|
|
224
225
|
* ```
|
|
225
226
|
*/
|
|
226
|
-
export interface AssessmentLineItemsCallable extends CallableResource<AssessmentLineItem, AssessmentLineItemFilterFields, ScopedAssessmentLineItemResource, AssessmentLineItemCreateInput
|
|
227
|
+
export interface AssessmentLineItemsCallable extends CallableResource<AssessmentLineItem, AssessmentLineItemFilterFields, ScopedAssessmentLineItemResource, AssessmentLineItemCreateInput, ListParamsNoSearch<AssessmentLineItemFilterFields>> {
|
|
227
228
|
/** Partially update an assessment line item (only specified fields are changed) */
|
|
228
229
|
patch(id: string, data: Partial<AssessmentLineItem>): Promise<void>;
|
|
229
230
|
}
|
|
@@ -245,7 +246,7 @@ export interface AssessmentLineItemsCallable extends CallableResource<Assessment
|
|
|
245
246
|
* await client.resources.export(resourceId)
|
|
246
247
|
* ```
|
|
247
248
|
*/
|
|
248
|
-
export interface ResourcesCallable extends CallableResource<Resource, ResourceFilterFields, ScopedResourceResource, ResourceCreateInput
|
|
249
|
+
export interface ResourcesCallable extends CallableResource<Resource, ResourceFilterFields, ScopedResourceResource, ResourceCreateInput, ListParamsNoSearch<ResourceFilterFields>> {
|
|
249
250
|
/** Export a resource to Common Cartridge (.zip) as an ArrayBuffer */
|
|
250
251
|
export(resourceId: string): Promise<ArrayBuffer>;
|
|
251
252
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"callable.d.ts","sourceRoot":"","sources":["../../src/types/callable.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AACjE,OAAO,KAAK,EACX,6BAA6B,EAC7B,gBAAgB,EAChB,4BAA4B,EAC5B,0BAA0B,EAC1B,iBAAiB,EACjB,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,eAAe,EACf,MAAM,qBAAqB,CAAA;AAC5B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AACvC,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAA;AAC1F,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAA;AAC/E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAA;AAC9E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0CAA0C,CAAA;AAClF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAA;AACzE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAA;AAC1E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAA;AAC1E,OAAO,KAAK,EACX,qBAAqB,EACrB,qBAAqB,EACrB,kBAAkB,EAClB,MAAM,8BAA8B,CAAA;AACrC,OAAO,KAAK,EACX,eAAe,EACf,2BAA2B,EAC3B,kBAAkB,EAClB,8BAA8B,EAC9B,IAAI,EACJ,KAAK,EACL,iBAAiB,EACjB,iBAAiB,EACjB,6BAA6B,EAC7B,MAAM,EACN,eAAe,EACf,2BAA2B,EAC3B,kBAAkB,EAClB,cAAc,EACd,QAAQ,EACR,oBAAoB,EACpB,YAAY,EACZ,wBAAwB,EACxB,QAAQ,EACR,oBAAoB,EACpB,IAAI,EACJ,gBAAgB,EAChB,MAAM,SAAS,CAAA;AAMhB;;;;;;;;GAQG;AACH,MAAM,WAAW,gBAAgB,
|
|
1
|
+
{"version":3,"file":"callable.d.ts","sourceRoot":"","sources":["../../src/types/callable.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AACjE,OAAO,KAAK,EACX,6BAA6B,EAC7B,gBAAgB,EAChB,4BAA4B,EAC5B,0BAA0B,EAC1B,iBAAiB,EACjB,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,eAAe,EACf,MAAM,qBAAqB,CAAA;AAC5B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AACvC,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAA;AAC1F,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAA;AAC/E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAA;AAC9E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0CAA0C,CAAA;AAClF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAA;AACzE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAA;AAC1E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAA;AAC1E,OAAO,KAAK,EACX,qBAAqB,EACrB,qBAAqB,EACrB,kBAAkB,EAClB,MAAM,8BAA8B,CAAA;AACrC,OAAO,KAAK,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAC7E,OAAO,KAAK,EACX,eAAe,EACf,2BAA2B,EAC3B,kBAAkB,EAClB,8BAA8B,EAC9B,IAAI,EACJ,KAAK,EACL,iBAAiB,EACjB,iBAAiB,EACjB,6BAA6B,EAC7B,MAAM,EACN,eAAe,EACf,2BAA2B,EAC3B,kBAAkB,EAClB,cAAc,EACd,QAAQ,EACR,oBAAoB,EACpB,YAAY,EACZ,wBAAwB,EACxB,QAAQ,EACR,oBAAoB,EACpB,IAAI,EACJ,gBAAgB,EAChB,MAAM,SAAS,CAAA;AAMhB;;;;;;;;GAQG;AACH,MAAM,WAAW,gBAAgB,CAChC,CAAC,SAAS,IAAI,EACd,CAAC,EACD,CAAC,EACD,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EACd,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IAEvC,kDAAkD;IAClD,CAAC,EAAE,EAAE,MAAM,GAAG,CAAC,CAAA;IAEf,sCAAsC;IACtC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,iCAAiC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;IAElF,4CAA4C;IAC5C,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAA;IAEjC,gEAAgE;IAChE,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAA;IAEzC,2CAA2C;IAC3C,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAEnC,gCAAgC;IAChC,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IAE3B,0BAA0B;IAC1B,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;IAExC,gCAAgC;IAChC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEnD,uBAAuB;IACvB,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACjC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,wBAAwB,CACxC,CAAC,SAAS,IAAI,EACd,CAAC,EACD,CAAC,EACD,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IAEvC,kDAAkD;IAClD,CAAC,EAAE,EAAE,MAAM,GAAG,CAAC,CAAA;IAEf,sCAAsC;IACtC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,iCAAiC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;IAElF,4CAA4C;IAC5C,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAA;IAEjC,gEAAgE;IAChE,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAA;IAEzC,2CAA2C;IAC3C,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAEnC,gCAAgC;IAChC,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;CAC3B;AAMD;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,eAAgB,SAAQ,gBAAgB,CACxD,MAAM,EACN,kBAAkB,EAClB,oBAAoB,EACpB,iBAAiB,EACjB,oBAAoB,CAAC,kBAAkB,CAAC,CACxC;IACA,iCAAiC;IACjC,UAAU,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,2BAA2B,CAAC,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAEhG,oDAAoD;IACpD,gBAAgB,CACf,MAAM,CAAC,EAAE,kBAAkB,CAAC,2BAA2B,CAAC,GACtD,SAAS,CAAC,eAAe,EAAE,2BAA2B,CAAC,CAAA;IAE1D,sCAAsC;IACtC,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;IAEzD,oCAAoC;IACpC,eAAe,CAAC,IAAI,EAAE,0BAA0B,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;IAE1E,gCAAgC;IAChC,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEjF,gCAAgC;IAChC,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEjD,mCAAmC;IACnC,kBAAkB,CACjB,MAAM,CAAC,EAAE,kBAAkB,CAAC,6BAA6B,CAAC,GACxD,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAA;IAE/B,sDAAsD;IACtD,wBAAwB,CACvB,MAAM,CAAC,EAAE,kBAAkB,CAAC,6BAA6B,CAAC,GACxD,SAAS,CAAC,iBAAiB,EAAE,6BAA6B,CAAC,CAAA;IAE9D,wCAAwC;IACxC,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAEnE,sCAAsC;IACtC,uBAAuB,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;IAEpF,kCAAkC;IAClC,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE3F,kCAAkC;IAClC,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzD,+CAA+C;IAC/C,eAAe,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;CACpE;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,eAAe,GAAG,gBAAgB,CAC7C,KAAK,EACL,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,CAAC,iBAAiB,CAAC,CACrC,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,eAAe,GAAG,gBAAgB,CAC7C,YAAY,EACZ,wBAAwB,EACxB,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,CAAC,wBAAwB,CAAC,CAC5C,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,aAAa,GAAG,gBAAgB,CAC3C,IAAI,EACJ,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,oBAAoB,CAAC,gBAAgB,CAAC,CACtC,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,gBAAgB,GAAG,wBAAwB,CACtD,IAAI,EACJ,gBAAgB,EAChB,qBAAqB,EACrB,oBAAoB,CAAC,gBAAgB,CAAC,CACtC,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,gBAAgB,GAAG,wBAAwB,CACtD,IAAI,EACJ,gBAAgB,EAChB,qBAAqB,EACrB,kBAAkB,CAAC,gBAAgB,CAAC,CACpC,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,aAAa,GAAG,wBAAwB,CACnD,eAAe,EACf,2BAA2B,EAC3B,kBAAkB,EAClB,kBAAkB,CAAC,2BAA2B,CAAC,CAC/C,CAAA;AAMD;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB,CAC1D,QAAQ,EACR,oBAAoB,EACpB,sBAAsB,EACtB,mBAAmB,EACnB,kBAAkB,CAAC,oBAAoB,CAAC,CACxC;CAAG;AAMJ;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,2BAA4B,SAAQ,gBAAgB,CACpE,kBAAkB,EAClB,8BAA8B,EAC9B,gCAAgC,EAChC,6BAA6B,EAC7B,kBAAkB,CAAC,8BAA8B,CAAC,CAClD;IACA,mFAAmF;IACnF,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACnE;AAMD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB,CAC1D,QAAQ,EACR,oBAAoB,EACpB,sBAAsB,EACtB,mBAAmB,EACnB,kBAAkB,CAAC,oBAAoB,CAAC,CACxC;IACA,qEAAqE;IACrE,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;CAChD"}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -2,5 +2,6 @@ export * from '@timeback/types/protocols/oneroster';
|
|
|
2
2
|
export * from './streamable';
|
|
3
3
|
export * from './callable';
|
|
4
4
|
export * from './client';
|
|
5
|
+
export * from './list-params';
|
|
5
6
|
export type { AcademicSessionCreateInput, AgentInput, AssessmentLineItemCreateInput, AssessmentResultCreateInput, BulkResultsInput, CategoryCreateInput, ClassCreateInput, ComponentResourceCreateInput, CourseComponentCreateInput, CourseCreateInput, CourseStructureInput, DemographicsCreateInput, EnrollInput, EnrollmentCreateInput, LineItemCreateInput, OrgCreateInput, ResourceCreateInput, ResultCreateInput, SchoolCreateInput, ScoreScaleCreateInput, UserCreateInput, UserRoleInput, } from '@timeback/types/zod';
|
|
6
7
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAA;AACnD,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAA;AACnD,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA;AAE7B,YAAY,EACX,0BAA0B,EAC1B,UAAU,EACV,6BAA6B,EAC7B,2BAA2B,EAC3B,gBAAgB,EAChB,mBAAmB,EACnB,gBAAgB,EAChB,4BAA4B,EAC5B,0BAA0B,EAC1B,iBAAiB,EACjB,oBAAoB,EACpB,uBAAuB,EACvB,WAAW,EACX,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACd,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,EACrB,eAAe,EACf,aAAa,GACb,MAAM,qBAAqB,CAAA"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { ListParams } from '@timeback/internal-client-infra';
|
|
2
|
+
/**
|
|
3
|
+
* List params for endpoints that support the `search` query param.
|
|
4
|
+
*
|
|
5
|
+
* NOTE: Timeback currently only honors `search` on a small subset of
|
|
6
|
+
* OneRoster endpoints. Use `ListParamsNoSearch` everywhere else to avoid
|
|
7
|
+
* misleading/ignored params.
|
|
8
|
+
*/
|
|
9
|
+
export type ListParamsWithSearch<F> = ListParams<F>;
|
|
10
|
+
/**
|
|
11
|
+
* List params for endpoints that do NOT support the `search` query param.
|
|
12
|
+
* Passing `search` should be a type error.
|
|
13
|
+
*/
|
|
14
|
+
export type ListParamsNoSearch<F> = Omit<ListParams<F>, 'search'>;
|
|
15
|
+
//# sourceMappingURL=list-params.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"list-params.d.ts","sourceRoot":"","sources":["../../src/types/list-params.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AAEjE;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAA;AAEnD;;;GAGG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAA"}
|