@stackfactor/client-api 1.19.3 → 1.20.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/dist/cjs/lib/constants.d.ts +2 -1
- package/dist/cjs/lib/constants.d.ts.map +1 -1
- package/dist/cjs/lib/constants.js +3 -1
- package/dist/cjs/lib/constants.js.map +1 -1
- package/dist/cjs/lib/knowledgeAssessmentAttempts.d.ts +22 -0
- package/dist/cjs/lib/knowledgeAssessmentAttempts.d.ts.map +1 -1
- package/dist/cjs/lib/knowledgeAssessmentAttempts.js +44 -1
- package/dist/cjs/lib/knowledgeAssessmentAttempts.js.map +1 -1
- package/dist/cjs/lib/knowledgeBase/documents.d.ts +127 -0
- package/dist/cjs/lib/knowledgeBase/documents.d.ts.map +1 -0
- package/dist/cjs/lib/knowledgeBase/documents.js +114 -0
- package/dist/cjs/lib/knowledgeBase/documents.js.map +1 -0
- package/dist/cjs/lib/knowledgeBase/knowledgeBases.d.ts +118 -0
- package/dist/cjs/lib/knowledgeBase/knowledgeBases.d.ts.map +1 -0
- package/dist/cjs/lib/knowledgeBase/knowledgeBases.js +256 -0
- package/dist/cjs/lib/knowledgeBase/knowledgeBases.js.map +1 -0
- package/dist/cjs/lib/knowledgeBase/review.d.ts +184 -0
- package/dist/cjs/lib/knowledgeBase/review.d.ts.map +1 -0
- package/dist/cjs/lib/knowledgeBase/review.js +413 -0
- package/dist/cjs/lib/knowledgeBase/review.js.map +1 -0
- package/dist/cjs/lib/knowledgeBase/skills.d.ts +247 -0
- package/dist/cjs/lib/knowledgeBase/skills.d.ts.map +1 -0
- package/dist/cjs/lib/knowledgeBase/skills.js +199 -0
- package/dist/cjs/lib/knowledgeBase/skills.js.map +1 -0
- package/dist/cjs/lib/knowledgeBase/sources.d.ts +136 -0
- package/dist/cjs/lib/knowledgeBase/sources.d.ts.map +1 -0
- package/dist/cjs/lib/knowledgeBase/sources.js +234 -0
- package/dist/cjs/lib/knowledgeBase/sources.js.map +1 -0
- package/dist/cjs/lib/knowledgeBase.d.ts +5 -785
- package/dist/cjs/lib/knowledgeBase.d.ts.map +1 -1
- package/dist/cjs/lib/knowledgeBase.js +32 -1229
- package/dist/cjs/lib/knowledgeBase.js.map +1 -1
- package/dist/cjs/lib/knowledgeBaseAgent.d.ts +109 -2
- package/dist/cjs/lib/knowledgeBaseAgent.d.ts.map +1 -1
- package/dist/cjs/lib/knowledgeBaseAgent.js +71 -8
- package/dist/cjs/lib/knowledgeBaseAgent.js.map +1 -1
- package/dist/cjs/lib/learningContent.d.ts.map +1 -1
- package/dist/cjs/lib/learningContent.js +12 -2
- package/dist/cjs/lib/learningContent.js.map +1 -1
- package/dist/cjs/lib/learningContentCohorts.d.ts +80 -0
- package/dist/cjs/lib/learningContentCohorts.d.ts.map +1 -1
- package/dist/cjs/lib/learningContentCohorts.js +80 -1
- package/dist/cjs/lib/learningContentCohorts.js.map +1 -1
- package/dist/esm/lib/constants.d.ts +2 -1
- package/dist/esm/lib/constants.d.ts.map +1 -1
- package/dist/esm/lib/constants.js +3 -1
- package/dist/esm/lib/constants.js.map +1 -1
- package/dist/esm/lib/knowledgeAssessmentAttempts.d.ts +22 -0
- package/dist/esm/lib/knowledgeAssessmentAttempts.d.ts.map +1 -1
- package/dist/esm/lib/knowledgeAssessmentAttempts.js +40 -0
- package/dist/esm/lib/knowledgeAssessmentAttempts.js.map +1 -1
- package/dist/esm/lib/knowledgeBase/documents.d.ts +127 -0
- package/dist/esm/lib/knowledgeBase/documents.d.ts.map +1 -0
- package/dist/esm/lib/knowledgeBase/documents.js +107 -0
- package/dist/esm/lib/knowledgeBase/documents.js.map +1 -0
- package/dist/esm/lib/knowledgeBase/knowledgeBases.d.ts +118 -0
- package/dist/esm/lib/knowledgeBase/knowledgeBases.d.ts.map +1 -0
- package/dist/esm/lib/knowledgeBase/knowledgeBases.js +242 -0
- package/dist/esm/lib/knowledgeBase/knowledgeBases.js.map +1 -0
- package/dist/esm/lib/knowledgeBase/review.d.ts +184 -0
- package/dist/esm/lib/knowledgeBase/review.d.ts.map +1 -0
- package/dist/esm/lib/knowledgeBase/review.js +392 -0
- package/dist/esm/lib/knowledgeBase/review.js.map +1 -0
- package/dist/esm/lib/knowledgeBase/skills.d.ts +247 -0
- package/dist/esm/lib/knowledgeBase/skills.d.ts.map +1 -0
- package/dist/esm/lib/knowledgeBase/skills.js +189 -0
- package/dist/esm/lib/knowledgeBase/skills.js.map +1 -0
- package/dist/esm/lib/knowledgeBase/sources.d.ts +136 -0
- package/dist/esm/lib/knowledgeBase/sources.d.ts.map +1 -0
- package/dist/esm/lib/knowledgeBase/sources.js +221 -0
- package/dist/esm/lib/knowledgeBase/sources.js.map +1 -0
- package/dist/esm/lib/knowledgeBase.d.ts +5 -785
- package/dist/esm/lib/knowledgeBase.d.ts.map +1 -1
- package/dist/esm/lib/knowledgeBase.js +18 -1175
- package/dist/esm/lib/knowledgeBase.js.map +1 -1
- package/dist/esm/lib/knowledgeBaseAgent.d.ts +109 -2
- package/dist/esm/lib/knowledgeBaseAgent.d.ts.map +1 -1
- package/dist/esm/lib/knowledgeBaseAgent.js +66 -7
- package/dist/esm/lib/knowledgeBaseAgent.js.map +1 -1
- package/dist/esm/lib/learningContent.d.ts.map +1 -1
- package/dist/esm/lib/learningContent.js +12 -2
- package/dist/esm/lib/learningContent.js.map +1 -1
- package/dist/esm/lib/learningContentCohorts.d.ts +80 -0
- package/dist/esm/lib/learningContentCohorts.d.ts.map +1 -1
- package/dist/esm/lib/learningContentCohorts.js +66 -0
- package/dist/esm/lib/learningContentCohorts.js.map +1 -1
- package/package.json +1 -3
|
@@ -8,13 +8,60 @@ export interface LearningContentCohortInput {
|
|
|
8
8
|
endsAt?: string | null;
|
|
9
9
|
seats?: number;
|
|
10
10
|
instructors?: string[];
|
|
11
|
+
/** 1 in person, 2 online, 3 hybrid */
|
|
12
|
+
format?: number;
|
|
13
|
+
/** A room or an address; required unless online */
|
|
11
14
|
location?: string;
|
|
15
|
+
/** The call tool, e.g. Zoom; for online and hybrid classes */
|
|
16
|
+
platform?: string;
|
|
17
|
+
/** The link learners join; required for online and hybrid classes */
|
|
18
|
+
meetingUrl?: string;
|
|
19
|
+
/** The instructors' private notes; never shown to learners */
|
|
20
|
+
notes?: string;
|
|
21
|
+
}
|
|
22
|
+
/** One learner's attendance mark, as the attendance screen records it. */
|
|
23
|
+
export interface LearningContentCohortAttendanceMark {
|
|
24
|
+
userId: string;
|
|
25
|
+
/** 1 enrolled, 2 attended, 3 no-show, 4 cancelled */
|
|
26
|
+
status?: number;
|
|
27
|
+
/** Met the session's completion rules; only kept for an attended learner */
|
|
28
|
+
signedOff?: boolean;
|
|
12
29
|
}
|
|
13
30
|
/**
|
|
14
31
|
* Every cohort of a learning content, with attendees. For instructors of
|
|
15
32
|
* the content and those who manage learning content; others get 403.
|
|
16
33
|
*/
|
|
17
34
|
export declare const getCohorts: (learningContentId: string, token: string) => Promise<object>;
|
|
35
|
+
/**
|
|
36
|
+
* Every cohort an instructor runs across the tenant's content. The
|
|
37
|
+
* instructor and content managers get full records; others get summaries.
|
|
38
|
+
*/
|
|
39
|
+
export declare const getInstructorCohorts: (userId: string, token: string) => Promise<object>;
|
|
40
|
+
/**
|
|
41
|
+
* Every upcoming class across the tenant, soonest first, each with the
|
|
42
|
+
* signed-in learner's own standing (`me`, `waitlistPosition`).
|
|
43
|
+
*/
|
|
44
|
+
export declare const getUpcomingCohorts: (token: string) => Promise<object>;
|
|
45
|
+
/**
|
|
46
|
+
* Every class a learner is in, was in, or waits for. A learner reads their
|
|
47
|
+
* own; content managers may read anyone's.
|
|
48
|
+
*/
|
|
49
|
+
export declare const getLearnerCohorts: (userId: string, token: string) => Promise<object>;
|
|
50
|
+
/**
|
|
51
|
+
* Take a seat in a class, or a place on its waitlist when it is full.
|
|
52
|
+
* Resolves with the class as the learner reads it plus `waitlisted`.
|
|
53
|
+
*/
|
|
54
|
+
export declare const enrolSelf: (learningContentId: string, cohortId: string, token: string) => Promise<object>;
|
|
55
|
+
/** Give up a seat, or a place on the waitlist. */
|
|
56
|
+
export declare const leaveSelf: (learningContentId: string, cohortId: string, token: string) => Promise<object>;
|
|
57
|
+
/**
|
|
58
|
+
* Set how a learner completes the course's live sessions: every one, or at
|
|
59
|
+
* least `minimumAttendance` percent of them. Resolves with the saved rules.
|
|
60
|
+
*/
|
|
61
|
+
export declare const setCourseRules: (learningContentId: string, rules: {
|
|
62
|
+
allSessionsRequired?: boolean;
|
|
63
|
+
minimumAttendance?: number;
|
|
64
|
+
}, token: string) => Promise<object>;
|
|
18
65
|
/** Create a cohort for one of the content's live sessions. */
|
|
19
66
|
export declare const createCohort: (learningContentId: string, cohort: LearningContentCohortInput, token: string) => Promise<object>;
|
|
20
67
|
/** Change a cohort's details. */
|
|
@@ -27,6 +74,39 @@ export declare const deleteCohort: (learningContentId: string, cohortId: string,
|
|
|
27
74
|
* enrolment finds no seat left.
|
|
28
75
|
*/
|
|
29
76
|
export declare const setAttendee: (learningContentId: string, cohortId: string, userId: string, status: number | undefined, token: string) => Promise<object>;
|
|
77
|
+
/** Cancel a class. Its attendees and waitlist are kept. */
|
|
78
|
+
export declare const cancelCohort: (learningContentId: string, cohortId: string, token: string) => Promise<object>;
|
|
79
|
+
/**
|
|
80
|
+
* Record attendance for a class in one go. Learners not in the list keep
|
|
81
|
+
* their status.
|
|
82
|
+
*/
|
|
83
|
+
export declare const setAttendance: (learningContentId: string, cohortId: string, marks: LearningContentCohortAttendanceMark[], token: string) => Promise<object>;
|
|
84
|
+
/**
|
|
85
|
+
* Grade one learner against the session's completion requirements: which
|
|
86
|
+
* evidence was met or not met (status 1 met, 2 not met, 0 clears), a note
|
|
87
|
+
* to the learner, and the instructor's sign-off. The learner must be marked
|
|
88
|
+
* as attended.
|
|
89
|
+
*/
|
|
90
|
+
export declare const gradeAttendee: (learningContentId: string, cohortId: string, userId: string, grade: {
|
|
91
|
+
evidence?: {
|
|
92
|
+
type: number;
|
|
93
|
+
status: number;
|
|
94
|
+
details?: string[];
|
|
95
|
+
}[];
|
|
96
|
+
note?: string;
|
|
97
|
+
signedOff?: boolean;
|
|
98
|
+
}, token: string) => Promise<object>;
|
|
99
|
+
/**
|
|
100
|
+
* Email everyone enrolled a reminder with the instructor's message. Resolves
|
|
101
|
+
* with the cohort plus `sent` and `failed` counts.
|
|
102
|
+
*/
|
|
103
|
+
export declare const remindAttendees: (learningContentId: string, cohortId: string, message: string, token: string) => Promise<object>;
|
|
104
|
+
/** Put a learner on the waitlist; seated at once if a seat is free. */
|
|
105
|
+
export declare const addToWaitlist: (learningContentId: string, cohortId: string, userId: string, token: string) => Promise<object>;
|
|
106
|
+
/** Take a learner off the waitlist. */
|
|
107
|
+
export declare const removeFromWaitlist: (learningContentId: string, cohortId: string, userId: string, token: string) => Promise<object>;
|
|
108
|
+
/** Give a waiting learner a seat. Rejects with 409 when none is free. */
|
|
109
|
+
export declare const promoteFromWaitlist: (learningContentId: string, cohortId: string, userId: string, token: string) => Promise<object>;
|
|
30
110
|
/** Remove a learner from a cohort. */
|
|
31
111
|
export declare const removeAttendee: (learningContentId: string, cohortId: string, userId: string, token: string) => Promise<object>;
|
|
32
112
|
//# sourceMappingURL=learningContentCohorts.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"learningContentCohorts.d.ts","sourceRoot":"","sources":["../../../src/lib/learningContentCohorts.ts"],"names":[],"mappings":"AAGA,qDAAqD;AACrD,MAAM,WAAW,0BAA0B;IACzC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,eAAe;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iCAAiC;IACjC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"learningContentCohorts.d.ts","sourceRoot":"","sources":["../../../src/lib/learningContentCohorts.ts"],"names":[],"mappings":"AAGA,qDAAqD;AACrD,MAAM,WAAW,0BAA0B;IACzC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,eAAe;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iCAAiC;IACjC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mDAAmD;IACnD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,8DAA8D;IAC9D,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,0EAA0E;AAC1E,MAAM,WAAW,mCAAmC;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,qDAAqD;IACrD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAYD;;;GAGG;AACH,eAAO,MAAM,UAAU,GACrB,mBAAmB,MAAM,EACzB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAGd,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,oBAAoB,GAC/B,QAAQ,MAAM,EACd,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAKd,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,kBAAkB,GAAI,OAAO,MAAM,KAAG,OAAO,CAAC,MAAM,CAK9D,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAC5B,QAAQ,MAAM,EACd,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAKd,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,SAAS,GACpB,mBAAmB,MAAM,EACzB,UAAU,MAAM,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAOd,CAAC;AAEJ,kDAAkD;AAClD,eAAO,MAAM,SAAS,GACpB,mBAAmB,MAAM,EACzB,UAAU,MAAM,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAKd,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,cAAc,GACzB,mBAAmB,MAAM,EACzB,OAAO;IAAE,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAAE,EACpE,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAKd,CAAC;AAEJ,8DAA8D;AAC9D,eAAO,MAAM,YAAY,GACvB,mBAAmB,MAAM,EACzB,QAAQ,0BAA0B,EAClC,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAKd,CAAC;AAEJ,iCAAiC;AACjC,eAAO,MAAM,YAAY,GACvB,mBAAmB,MAAM,EACzB,UAAU,MAAM,EAChB,QAAQ,0BAA0B,EAClC,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAKd,CAAC;AAEJ,uBAAuB;AACvB,eAAO,MAAM,YAAY,GACvB,mBAAmB,MAAM,EACzB,UAAU,MAAM,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAKd,CAAC;AAEJ;;;;GAIG;AACH,eAAO,MAAM,WAAW,GACtB,mBAAmB,MAAM,EACzB,UAAU,MAAM,EAChB,QAAQ,MAAM,EACd,QAAQ,MAAM,GAAG,SAAS,EAC1B,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAOd,CAAC;AAEJ,2DAA2D;AAC3D,eAAO,MAAM,YAAY,GACvB,mBAAmB,MAAM,EACzB,UAAU,MAAM,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CASd,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,aAAa,GACxB,mBAAmB,MAAM,EACzB,UAAU,MAAM,EAChB,OAAO,mCAAmC,EAAE,EAC5C,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAOd,CAAC;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GACxB,mBAAmB,MAAM,EACzB,UAAU,MAAM,EAChB,QAAQ,MAAM,EACd,OAAO;IACL,QAAQ,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,EAAE,CAAC;IAClE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,EACD,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAOd,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,eAAe,GAC1B,mBAAmB,MAAM,EACzB,UAAU,MAAM,EAChB,SAAS,MAAM,EACf,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAOd,CAAC;AAEJ,uEAAuE;AACvE,eAAO,MAAM,aAAa,GACxB,mBAAmB,MAAM,EACzB,UAAU,MAAM,EAChB,QAAQ,MAAM,EACd,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAOd,CAAC;AAEJ,uCAAuC;AACvC,eAAO,MAAM,kBAAkB,GAC7B,mBAAmB,MAAM,EACzB,UAAU,MAAM,EAChB,QAAQ,MAAM,EACd,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAKd,CAAC;AAEJ,yEAAyE;AACzE,eAAO,MAAM,mBAAmB,GAC9B,mBAAmB,MAAM,EACzB,UAAU,MAAM,EAChB,QAAQ,MAAM,EACd,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAOd,CAAC;AAEJ,sCAAsC;AACtC,eAAO,MAAM,cAAc,GACzB,mBAAmB,MAAM,EACzB,UAAU,MAAM,EAChB,QAAQ,MAAM,EACd,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAQd,CAAC"}
|
|
@@ -10,6 +10,43 @@ const call = (request) => new Promise((resolve, reject) => {
|
|
|
10
10
|
* the content and those who manage learning content; others get 403.
|
|
11
11
|
*/
|
|
12
12
|
export const getCohorts = (learningContentId, token) => call(client.get(base(learningContentId), { headers: { authorization: token } }));
|
|
13
|
+
/**
|
|
14
|
+
* Every cohort an instructor runs across the tenant's content. The
|
|
15
|
+
* instructor and content managers get full records; others get summaries.
|
|
16
|
+
*/
|
|
17
|
+
export const getInstructorCohorts = (userId, token) => call(client.get(`/api/v1/exceed/learningcontentcohorts/instructor/${userId}`, {
|
|
18
|
+
headers: { authorization: token },
|
|
19
|
+
}));
|
|
20
|
+
/**
|
|
21
|
+
* Every upcoming class across the tenant, soonest first, each with the
|
|
22
|
+
* signed-in learner's own standing (`me`, `waitlistPosition`).
|
|
23
|
+
*/
|
|
24
|
+
export const getUpcomingCohorts = (token) => call(client.get(`/api/v1/exceed/learningcontentcohorts/upcoming`, {
|
|
25
|
+
headers: { authorization: token },
|
|
26
|
+
}));
|
|
27
|
+
/**
|
|
28
|
+
* Every class a learner is in, was in, or waits for. A learner reads their
|
|
29
|
+
* own; content managers may read anyone's.
|
|
30
|
+
*/
|
|
31
|
+
export const getLearnerCohorts = (userId, token) => call(client.get(`/api/v1/exceed/learningcontentcohorts/learner/${userId}`, {
|
|
32
|
+
headers: { authorization: token },
|
|
33
|
+
}));
|
|
34
|
+
/**
|
|
35
|
+
* Take a seat in a class, or a place on its waitlist when it is full.
|
|
36
|
+
* Resolves with the class as the learner reads it plus `waitlisted`.
|
|
37
|
+
*/
|
|
38
|
+
export const enrolSelf = (learningContentId, cohortId, token) => call(client.post(`${base(learningContentId)}/${cohortId}/enrol`, {}, { headers: { authorization: token } }));
|
|
39
|
+
/** Give up a seat, or a place on the waitlist. */
|
|
40
|
+
export const leaveSelf = (learningContentId, cohortId, token) => call(client.delete(`${base(learningContentId)}/${cohortId}/enrol`, {
|
|
41
|
+
headers: { authorization: token },
|
|
42
|
+
}));
|
|
43
|
+
/**
|
|
44
|
+
* Set how a learner completes the course's live sessions: every one, or at
|
|
45
|
+
* least `minimumAttendance` percent of them. Resolves with the saved rules.
|
|
46
|
+
*/
|
|
47
|
+
export const setCourseRules = (learningContentId, rules, token) => call(client.put(`${base(learningContentId)}/rules`, rules, {
|
|
48
|
+
headers: { authorization: token },
|
|
49
|
+
}));
|
|
13
50
|
/** Create a cohort for one of the content's live sessions. */
|
|
14
51
|
export const createCohort = (learningContentId, cohort, token) => call(client.post(base(learningContentId), cohort, {
|
|
15
52
|
headers: { authorization: token },
|
|
@@ -28,6 +65,35 @@ export const deleteCohort = (learningContentId, cohortId, token) => call(client.
|
|
|
28
65
|
* enrolment finds no seat left.
|
|
29
66
|
*/
|
|
30
67
|
export const setAttendee = (learningContentId, cohortId, userId, status, token) => call(client.post(`${base(learningContentId)}/${cohortId}/attendees`, { userId, status }, { headers: { authorization: token } }));
|
|
68
|
+
/** Cancel a class. Its attendees and waitlist are kept. */
|
|
69
|
+
export const cancelCohort = (learningContentId, cohortId, token) => call(client.post(`${base(learningContentId)}/${cohortId}/cancel`, {}, {
|
|
70
|
+
headers: { authorization: token },
|
|
71
|
+
}));
|
|
72
|
+
/**
|
|
73
|
+
* Record attendance for a class in one go. Learners not in the list keep
|
|
74
|
+
* their status.
|
|
75
|
+
*/
|
|
76
|
+
export const setAttendance = (learningContentId, cohortId, marks, token) => call(client.put(`${base(learningContentId)}/${cohortId}/attendance`, { marks }, { headers: { authorization: token } }));
|
|
77
|
+
/**
|
|
78
|
+
* Grade one learner against the session's completion requirements: which
|
|
79
|
+
* evidence was met or not met (status 1 met, 2 not met, 0 clears), a note
|
|
80
|
+
* to the learner, and the instructor's sign-off. The learner must be marked
|
|
81
|
+
* as attended.
|
|
82
|
+
*/
|
|
83
|
+
export const gradeAttendee = (learningContentId, cohortId, userId, grade, token) => call(client.put(`${base(learningContentId)}/${cohortId}/attendees/${userId}/grade`, grade, { headers: { authorization: token } }));
|
|
84
|
+
/**
|
|
85
|
+
* Email everyone enrolled a reminder with the instructor's message. Resolves
|
|
86
|
+
* with the cohort plus `sent` and `failed` counts.
|
|
87
|
+
*/
|
|
88
|
+
export const remindAttendees = (learningContentId, cohortId, message, token) => call(client.post(`${base(learningContentId)}/${cohortId}/remind`, { message }, { headers: { authorization: token } }));
|
|
89
|
+
/** Put a learner on the waitlist; seated at once if a seat is free. */
|
|
90
|
+
export const addToWaitlist = (learningContentId, cohortId, userId, token) => call(client.post(`${base(learningContentId)}/${cohortId}/waitlist`, { userId }, { headers: { authorization: token } }));
|
|
91
|
+
/** Take a learner off the waitlist. */
|
|
92
|
+
export const removeFromWaitlist = (learningContentId, cohortId, userId, token) => call(client.delete(`${base(learningContentId)}/${cohortId}/waitlist/${userId}`, {
|
|
93
|
+
headers: { authorization: token },
|
|
94
|
+
}));
|
|
95
|
+
/** Give a waiting learner a seat. Rejects with 409 when none is free. */
|
|
96
|
+
export const promoteFromWaitlist = (learningContentId, cohortId, userId, token) => call(client.post(`${base(learningContentId)}/${cohortId}/waitlist/${userId}/promote`, {}, { headers: { authorization: token } }));
|
|
31
97
|
/** Remove a learner from a cohort. */
|
|
32
98
|
export const removeAttendee = (learningContentId, cohortId, userId, token) => call(client.delete(`${base(learningContentId)}/${cohortId}/attendees/${userId}`, {
|
|
33
99
|
headers: { authorization: token },
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"learningContentCohorts.js","sourceRoot":"","sources":["../../../src/lib/learningContentCohorts.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;
|
|
1
|
+
{"version":3,"file":"learningContentCohorts.js","sourceRoot":"","sources":["../../../src/lib/learningContentCohorts.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAiC1C,MAAM,IAAI,GAAG,CAAC,iBAAyB,EAAE,EAAE,CACzC,yCAAyC,iBAAiB,EAAE,CAAC;AAE/D,MAAM,IAAI,GAAG,CAAC,OAA+B,EAAmB,EAAE,CAChE,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;IAC9B,OAAO;SACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;SACzD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AACjD,CAAC,CAAC,CAAC;AAEL;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,iBAAyB,EACzB,KAAa,EACI,EAAE,CACnB,IAAI,CACF,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CAC3E,CAAC;AAEJ;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,MAAc,EACd,KAAa,EACI,EAAE,CACnB,IAAI,CACF,MAAM,CAAC,GAAG,CAAC,oDAAoD,MAAM,EAAE,EAAE;IACvE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CAAC,CACH,CAAC;AAEJ;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,KAAa,EAAmB,EAAE,CACnE,IAAI,CACF,MAAM,CAAC,GAAG,CAAC,gDAAgD,EAAE;IAC3D,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CAAC,CACH,CAAC;AAEJ;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,MAAc,EACd,KAAa,EACI,EAAE,CACnB,IAAI,CACF,MAAM,CAAC,GAAG,CAAC,iDAAiD,MAAM,EAAE,EAAE;IACpE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CAAC,CACH,CAAC;AAEJ;;;GAGG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,iBAAyB,EACzB,QAAgB,EAChB,KAAa,EACI,EAAE,CACnB,IAAI,CACF,MAAM,CAAC,IAAI,CACT,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,QAAQ,QAAQ,EAC9C,EAAE,EACF,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CACtC,CACF,CAAC;AAEJ,kDAAkD;AAClD,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,iBAAyB,EACzB,QAAgB,EAChB,KAAa,EACI,EAAE,CACnB,IAAI,CACF,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,QAAQ,QAAQ,EAAE;IAC5D,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CAAC,CACH,CAAC;AAEJ;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,iBAAyB,EACzB,KAAoE,EACpE,KAAa,EACI,EAAE,CACnB,IAAI,CACF,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,KAAK,EAAE;IACpD,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CAAC,CACH,CAAC;AAEJ,8DAA8D;AAC9D,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,iBAAyB,EACzB,MAAkC,EAClC,KAAa,EACI,EAAE,CACnB,IAAI,CACF,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,MAAM,EAAE;IAC3C,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CAAC,CACH,CAAC;AAEJ,iCAAiC;AACjC,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,iBAAyB,EACzB,QAAgB,EAChB,MAAkC,EAClC,KAAa,EACI,EAAE,CACnB,IAAI,CACF,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,QAAQ,EAAE,EAAE,MAAM,EAAE;IAC3D,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CAAC,CACH,CAAC;AAEJ,uBAAuB;AACvB,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,iBAAyB,EACzB,QAAgB,EAChB,KAAa,EACI,EAAE,CACnB,IAAI,CACF,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,QAAQ,EAAE,EAAE;IACtD,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CAAC,CACH,CAAC;AAEJ;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,iBAAyB,EACzB,QAAgB,EAChB,MAAc,EACd,MAA0B,EAC1B,KAAa,EACI,EAAE,CACnB,IAAI,CACF,MAAM,CAAC,IAAI,CACT,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,QAAQ,YAAY,EAClD,EAAE,MAAM,EAAE,MAAM,EAAE,EAClB,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CACtC,CACF,CAAC;AAEJ,2DAA2D;AAC3D,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,iBAAyB,EACzB,QAAgB,EAChB,KAAa,EACI,EAAE,CACnB,IAAI,CACF,MAAM,CAAC,IAAI,CACT,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,QAAQ,SAAS,EAC/C,EAAE,EACF;IACE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CACF,CACF,CAAC;AAEJ;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,iBAAyB,EACzB,QAAgB,EAChB,KAA4C,EAC5C,KAAa,EACI,EAAE,CACnB,IAAI,CACF,MAAM,CAAC,GAAG,CACR,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,QAAQ,aAAa,EACnD,EAAE,KAAK,EAAE,EACT,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CACtC,CACF,CAAC;AAEJ;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,iBAAyB,EACzB,QAAgB,EAChB,MAAc,EACd,KAIC,EACD,KAAa,EACI,EAAE,CACnB,IAAI,CACF,MAAM,CAAC,GAAG,CACR,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,QAAQ,cAAc,MAAM,QAAQ,EAClE,KAAK,EACL,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CACtC,CACF,CAAC;AAEJ;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,iBAAyB,EACzB,QAAgB,EAChB,OAAe,EACf,KAAa,EACI,EAAE,CACnB,IAAI,CACF,MAAM,CAAC,IAAI,CACT,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,QAAQ,SAAS,EAC/C,EAAE,OAAO,EAAE,EACX,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CACtC,CACF,CAAC;AAEJ,uEAAuE;AACvE,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,iBAAyB,EACzB,QAAgB,EAChB,MAAc,EACd,KAAa,EACI,EAAE,CACnB,IAAI,CACF,MAAM,CAAC,IAAI,CACT,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,QAAQ,WAAW,EACjD,EAAE,MAAM,EAAE,EACV,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CACtC,CACF,CAAC;AAEJ,uCAAuC;AACvC,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,iBAAyB,EACzB,QAAgB,EAChB,MAAc,EACd,KAAa,EACI,EAAE,CACnB,IAAI,CACF,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,QAAQ,aAAa,MAAM,EAAE,EAAE;IACzE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CAAC,CACH,CAAC;AAEJ,yEAAyE;AACzE,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,iBAAyB,EACzB,QAAgB,EAChB,MAAc,EACd,KAAa,EACI,EAAE,CACnB,IAAI,CACF,MAAM,CAAC,IAAI,CACT,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,QAAQ,aAAa,MAAM,UAAU,EACnE,EAAE,EACF,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CACtC,CACF,CAAC;AAEJ,sCAAsC;AACtC,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,iBAAyB,EACzB,QAAgB,EAChB,MAAc,EACd,KAAa,EACI,EAAE,CACnB,IAAI,CACF,MAAM,CAAC,MAAM,CACX,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,QAAQ,cAAc,MAAM,EAAE,EAC5D;IACE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CACF,CACF,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stackfactor/client-api",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.20.2",
|
|
4
4
|
"description": "Node.js library for the StackFactor API",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
@@ -54,7 +54,6 @@
|
|
|
54
54
|
"dependencies": {
|
|
55
55
|
"axios": "^1.20.0",
|
|
56
56
|
"dotenv": "^18.0.4",
|
|
57
|
-
"https": "latest",
|
|
58
57
|
"node-html-parser": "^9.0.4",
|
|
59
58
|
"socket.io-client": "^4.8.4"
|
|
60
59
|
},
|
|
@@ -63,7 +62,6 @@
|
|
|
63
62
|
},
|
|
64
63
|
"devDependencies": {
|
|
65
64
|
"@eslint/js": "^10.0.1",
|
|
66
|
-
"@types/axios": "^0.14.4",
|
|
67
65
|
"@types/node": "^26.6.3",
|
|
68
66
|
"@typescript-eslint/eslint-plugin": "^8.71.0",
|
|
69
67
|
"@typescript-eslint/parser": "^8.71.0",
|