@openstax/ts-utils 1.29.0 → 1.30.0
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/assertions/index.d.ts +7 -3
- package/dist/cjs/config/envConfig.d.ts +1 -1
- package/dist/cjs/config/index.d.ts +7 -7
- package/dist/cjs/config/resolveConfigValue.d.ts +2 -2
- package/dist/cjs/fetch/index.d.ts +16 -16
- package/dist/cjs/fetch/index.js +1 -1
- package/dist/cjs/middleware/apiErrorHandler.d.ts +3 -3
- package/dist/cjs/middleware/apiSlowResponseMiddleware.d.ts +1 -1
- package/dist/cjs/middleware/index.d.ts +7 -7
- package/dist/cjs/middleware/lambdaCorsResponseMiddleware.d.ts +1 -1
- package/dist/cjs/misc/hashValue.d.ts +2 -2
- package/dist/cjs/misc/helpers.d.ts +11 -11
- package/dist/cjs/misc/merge.d.ts +2 -2
- package/dist/cjs/misc/partitionSequence.d.ts +2 -2
- package/dist/cjs/pagination/index.d.ts +1 -1
- package/dist/cjs/routing/index.d.ts +30 -30
- package/dist/cjs/routing/index.js +18 -8
- package/dist/cjs/routing/validators/zod.d.ts +1 -1
- package/dist/cjs/routing/validators/zod.js +3 -1
- package/dist/cjs/services/accountsGateway/index.d.ts +17 -20
- package/dist/cjs/services/apiGateway/index.d.ts +10 -10
- package/dist/cjs/services/apiGateway/index.js +17 -7
- package/dist/cjs/services/authProvider/browser.d.ts +5 -7
- package/dist/cjs/services/authProvider/decryption.d.ts +3 -7
- package/dist/cjs/services/authProvider/index.d.ts +8 -8
- package/dist/cjs/services/authProvider/subrequest.d.ts +2 -5
- package/dist/cjs/services/authProvider/utils/decryptAndVerify.d.ts +1 -2
- package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.d.ts +4 -4
- package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.js +1 -1
- package/dist/cjs/services/authProvider/utils/userRoleValidator.d.ts +2 -2
- package/dist/cjs/services/documentStore/index.d.ts +7 -7
- package/dist/cjs/services/documentStore/unversioned/dynamodb.d.ts +7 -9
- package/dist/cjs/services/documentStore/unversioned/file-system.d.ts +7 -9
- package/dist/cjs/services/documentStore/unversioned/file-system.js +17 -7
- package/dist/cjs/services/documentStore/unversioned/index.d.ts +1 -1
- package/dist/cjs/services/documentStore/versioned/dynamodb.d.ts +7 -9
- package/dist/cjs/services/documentStore/versioned/file-system.d.ts +6 -8
- package/dist/cjs/services/documentStore/versioned/index.d.ts +4 -4
- package/dist/cjs/services/exercisesGateway/index.d.ts +9 -13
- package/dist/cjs/services/exercisesGateway/index.js +17 -7
- package/dist/cjs/services/fileServer/index.d.ts +2 -3
- package/dist/cjs/services/fileServer/localFileServer.d.ts +2 -6
- package/dist/cjs/services/fileServer/s3FileServer.d.ts +2 -5
- package/dist/cjs/services/launchParams/signer.d.ts +4 -9
- package/dist/cjs/services/launchParams/verifier.d.ts +4 -7
- package/dist/cjs/services/launchParams/verifier.js +17 -7
- package/dist/cjs/services/logger/index.d.ts +2 -2
- package/dist/cjs/services/logger/index.js +1 -1
- package/dist/cjs/services/lrsGateway/addStatementDefaultFields.d.ts +1 -1
- package/dist/cjs/services/lrsGateway/attempt-utils.d.ts +34 -34
- package/dist/cjs/services/lrsGateway/file-system.d.ts +2 -4
- package/dist/cjs/services/lrsGateway/file-system.js +17 -7
- package/dist/cjs/services/lrsGateway/index.d.ts +29 -32
- package/dist/cjs/services/lrsGateway/index.js +17 -7
- package/dist/cjs/services/lrsGateway/xapiUtils.d.ts +23 -23
- package/dist/cjs/services/postgresConnection/index.d.ts +3 -10
- package/dist/cjs/services/searchProvider/index.d.ts +7 -7
- package/dist/cjs/services/searchProvider/memorySearchTheBadWay.d.ts +1 -1
- package/dist/cjs/services/searchProvider/openSearch.d.ts +3 -6
- package/dist/cjs/services/searchProvider/openSearch.js +7 -3
- package/dist/cjs/tsconfig.without-specs.cjs.tsbuildinfo +1 -1
- package/dist/cjs/types.d.ts +5 -5
- package/dist/esm/assertions/index.d.ts +7 -3
- package/dist/esm/config/envConfig.d.ts +1 -1
- package/dist/esm/config/index.d.ts +7 -7
- package/dist/esm/config/resolveConfigValue.d.ts +2 -2
- package/dist/esm/fetch/index.d.ts +16 -16
- package/dist/esm/middleware/apiErrorHandler.d.ts +3 -3
- package/dist/esm/middleware/apiSlowResponseMiddleware.d.ts +1 -1
- package/dist/esm/middleware/index.d.ts +7 -7
- package/dist/esm/middleware/lambdaCorsResponseMiddleware.d.ts +1 -1
- package/dist/esm/misc/hashValue.d.ts +2 -2
- package/dist/esm/misc/helpers.d.ts +11 -11
- package/dist/esm/misc/merge.d.ts +2 -2
- package/dist/esm/misc/partitionSequence.d.ts +2 -2
- package/dist/esm/pagination/index.d.ts +1 -1
- package/dist/esm/routing/index.d.ts +30 -30
- package/dist/esm/routing/validators/zod.d.ts +1 -1
- package/dist/esm/routing/validators/zod.js +3 -1
- package/dist/esm/services/accountsGateway/index.d.ts +17 -20
- package/dist/esm/services/apiGateway/index.d.ts +10 -10
- package/dist/esm/services/authProvider/browser.d.ts +5 -7
- package/dist/esm/services/authProvider/decryption.d.ts +3 -7
- package/dist/esm/services/authProvider/index.d.ts +8 -8
- package/dist/esm/services/authProvider/subrequest.d.ts +2 -5
- package/dist/esm/services/authProvider/utils/decryptAndVerify.d.ts +1 -2
- package/dist/esm/services/authProvider/utils/embeddedAuthProvider.d.ts +4 -4
- package/dist/esm/services/authProvider/utils/userRoleValidator.d.ts +2 -2
- package/dist/esm/services/documentStore/index.d.ts +7 -7
- package/dist/esm/services/documentStore/unversioned/dynamodb.d.ts +7 -9
- package/dist/esm/services/documentStore/unversioned/file-system.d.ts +7 -9
- package/dist/esm/services/documentStore/unversioned/index.d.ts +1 -1
- package/dist/esm/services/documentStore/versioned/dynamodb.d.ts +7 -9
- package/dist/esm/services/documentStore/versioned/file-system.d.ts +6 -8
- package/dist/esm/services/documentStore/versioned/index.d.ts +4 -4
- package/dist/esm/services/exercisesGateway/index.d.ts +9 -13
- package/dist/esm/services/fileServer/index.d.ts +2 -3
- package/dist/esm/services/fileServer/localFileServer.d.ts +2 -6
- package/dist/esm/services/fileServer/s3FileServer.d.ts +2 -5
- package/dist/esm/services/launchParams/signer.d.ts +4 -9
- package/dist/esm/services/launchParams/verifier.d.ts +4 -7
- package/dist/esm/services/logger/index.d.ts +2 -2
- package/dist/esm/services/lrsGateway/addStatementDefaultFields.d.ts +1 -1
- package/dist/esm/services/lrsGateway/attempt-utils.d.ts +34 -34
- package/dist/esm/services/lrsGateway/file-system.d.ts +2 -4
- package/dist/esm/services/lrsGateway/index.d.ts +29 -32
- package/dist/esm/services/lrsGateway/xapiUtils.d.ts +23 -23
- package/dist/esm/services/postgresConnection/index.d.ts +3 -10
- package/dist/esm/services/searchProvider/index.d.ts +7 -7
- package/dist/esm/services/searchProvider/memorySearchTheBadWay.d.ts +1 -1
- package/dist/esm/services/searchProvider/openSearch.d.ts +3 -6
- package/dist/esm/services/searchProvider/openSearch.js +7 -3
- package/dist/esm/tsconfig.without-specs.esm.tsbuildinfo +1 -1
- package/dist/esm/types.d.ts +5 -5
- package/package.json +6 -6
- package/script/bin/.init-params-script.bash.swp +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { ConfigProviderForConfig } from '../../config';
|
|
2
2
|
import { GenericFetch } from '../../fetch';
|
|
3
|
-
export
|
|
3
|
+
export type Config = {
|
|
4
4
|
defaultCorrectness?: string;
|
|
5
5
|
exercisesHost: string;
|
|
6
6
|
exercisesAuthToken: string;
|
|
@@ -9,18 +9,18 @@ interface Initializer<C> {
|
|
|
9
9
|
configSpace?: C;
|
|
10
10
|
fetch: GenericFetch;
|
|
11
11
|
}
|
|
12
|
-
export
|
|
12
|
+
export type Answer = {
|
|
13
13
|
id: number;
|
|
14
14
|
content_html: string;
|
|
15
15
|
correctness?: string;
|
|
16
16
|
feedback_html?: string;
|
|
17
17
|
};
|
|
18
|
-
export
|
|
18
|
+
export type Solution = {
|
|
19
19
|
images: any[];
|
|
20
20
|
solution_type: string;
|
|
21
21
|
content_html: string;
|
|
22
22
|
};
|
|
23
|
-
export
|
|
23
|
+
export type Question = {
|
|
24
24
|
id: number;
|
|
25
25
|
is_answer_order_important: boolean;
|
|
26
26
|
stimulus_html: string;
|
|
@@ -32,7 +32,7 @@ export declare type Question = {
|
|
|
32
32
|
collaborator_solutions?: Solution[];
|
|
33
33
|
community_solutions?: Solution[];
|
|
34
34
|
};
|
|
35
|
-
export
|
|
35
|
+
export type Exercise = {
|
|
36
36
|
images: any[];
|
|
37
37
|
tags: string[];
|
|
38
38
|
uuid: string;
|
|
@@ -51,21 +51,17 @@ export declare type Exercise = {
|
|
|
51
51
|
versions: number[];
|
|
52
52
|
stimulus_html: string;
|
|
53
53
|
};
|
|
54
|
-
export
|
|
54
|
+
export type ExercisesSearchResults = {
|
|
55
55
|
total_count: number;
|
|
56
56
|
items: Exercise[];
|
|
57
57
|
};
|
|
58
|
-
export
|
|
58
|
+
export type ExercisesSearchResultsWithDigest = ExercisesSearchResults & {
|
|
59
59
|
digest: string;
|
|
60
60
|
};
|
|
61
|
-
export declare const exercisesGateway: <C extends string = "exercises">(initializer: Initializer<C>) => (configProvider: { [
|
|
62
|
-
defaultCorrectness?: import("../../config").ConfigValueProvider<string> | undefined;
|
|
63
|
-
exercisesHost: import("../../config").ConfigValueProvider<string>;
|
|
64
|
-
exercisesAuthToken: import("../../config").ConfigValueProvider<string>;
|
|
65
|
-
}; }) => (_: {}) => {
|
|
61
|
+
export declare const exercisesGateway: <C extends string = "exercises">(initializer: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => (_: {}) => {
|
|
66
62
|
searchDigest: (query: string, page?: number, per_page?: number) => Promise<string>;
|
|
67
63
|
get: (uuid: string) => Promise<Exercise | undefined>;
|
|
68
64
|
search: (query: string, page?: number, per_page?: number) => Promise<ExercisesSearchResultsWithDigest>;
|
|
69
65
|
};
|
|
70
|
-
export
|
|
66
|
+
export type ExercisesGateway = ReturnType<ReturnType<ReturnType<typeof exercisesGateway>>>;
|
|
71
67
|
export {};
|
|
@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
|
|
|
15
15
|
}) : function(o, v) {
|
|
16
16
|
o["default"] = v;
|
|
17
17
|
});
|
|
18
|
-
var __importStar = (this && this.__importStar) || function (
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
};
|
|
18
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
19
|
+
var ownKeys = function(o) {
|
|
20
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
21
|
+
var ar = [];
|
|
22
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
23
|
+
return ar;
|
|
24
|
+
};
|
|
25
|
+
return ownKeys(o);
|
|
26
|
+
};
|
|
27
|
+
return function (mod) {
|
|
28
|
+
if (mod && mod.__esModule) return mod;
|
|
29
|
+
var result = {};
|
|
30
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
31
|
+
__setModuleDefault(result, mod);
|
|
32
|
+
return result;
|
|
33
|
+
};
|
|
34
|
+
})();
|
|
25
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
36
|
exports.exercisesGateway = void 0;
|
|
27
37
|
const queryString = __importStar(require("query-string"));
|
|
@@ -1,11 +1,10 @@
|
|
|
1
|
-
|
|
2
|
-
export declare type FileValue = {
|
|
1
|
+
export type FileValue = {
|
|
3
2
|
dataType: 'file';
|
|
4
3
|
mimeType: string;
|
|
5
4
|
path: string;
|
|
6
5
|
label: string;
|
|
7
6
|
};
|
|
8
|
-
export
|
|
7
|
+
export type FolderValue = {
|
|
9
8
|
dataType: 'folder';
|
|
10
9
|
files: FileValue[];
|
|
11
10
|
};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { ConfigProviderForConfig } from '../../config';
|
|
2
2
|
import { FileServerAdapter } from '.';
|
|
3
|
-
export
|
|
3
|
+
export type Config = {
|
|
4
4
|
port?: string;
|
|
5
5
|
host?: string;
|
|
6
6
|
storagePrefix: string;
|
|
@@ -9,9 +9,5 @@ interface Initializer<C> {
|
|
|
9
9
|
dataDir: string;
|
|
10
10
|
configSpace?: C;
|
|
11
11
|
}
|
|
12
|
-
export declare const localFileServer: <C extends string = "local">(initializer: Initializer<C>) => (configProvider: { [
|
|
13
|
-
port?: import("../../config").ConfigValueProvider<string> | undefined;
|
|
14
|
-
host?: import("../../config").ConfigValueProvider<string> | undefined;
|
|
15
|
-
storagePrefix: import("../../config").ConfigValueProvider<string>;
|
|
16
|
-
}; }) => FileServerAdapter;
|
|
12
|
+
export declare const localFileServer: <C extends string = "local">(initializer: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => FileServerAdapter;
|
|
17
13
|
export {};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { S3Client } from '@aws-sdk/client-s3';
|
|
2
2
|
import { ConfigProviderForConfig } from '../../config';
|
|
3
3
|
import { FileServerAdapter } from '.';
|
|
4
|
-
export
|
|
4
|
+
export type Config = {
|
|
5
5
|
bucketName: string;
|
|
6
6
|
bucketRegion: string;
|
|
7
7
|
};
|
|
@@ -9,8 +9,5 @@ interface Initializer<C> {
|
|
|
9
9
|
configSpace?: C;
|
|
10
10
|
getS3Client?: (...args: ConstructorParameters<typeof S3Client>) => S3Client;
|
|
11
11
|
}
|
|
12
|
-
export declare const s3FileServer: <C extends string = "deployed">(initializer: Initializer<C>) => (configProvider: { [
|
|
13
|
-
bucketName: import("../../config").ConfigValueProvider<string>;
|
|
14
|
-
bucketRegion: import("../../config").ConfigValueProvider<string>;
|
|
15
|
-
}; }) => FileServerAdapter;
|
|
12
|
+
export declare const s3FileServer: <C extends string = "deployed">(initializer: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => FileServerAdapter;
|
|
16
13
|
export {};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { JWK } from 'node-jose';
|
|
2
2
|
import { ConfigProviderForConfig } from '../../config';
|
|
3
3
|
import type { JsonCompatibleValue } from '../../routing';
|
|
4
|
-
|
|
4
|
+
type Config = {
|
|
5
5
|
alg: string;
|
|
6
6
|
expiresIn: string;
|
|
7
7
|
iss: string;
|
|
@@ -13,16 +13,11 @@ interface Initializer<C> {
|
|
|
13
13
|
/**
|
|
14
14
|
* Creates a class that can sign launch params
|
|
15
15
|
*/
|
|
16
|
-
export declare const createLaunchSigner: <C extends string = "launch">({ configSpace }: Initializer<C>) => (configProvider: { [
|
|
17
|
-
alg: import("../../config").ConfigValueProvider<string>;
|
|
18
|
-
expiresIn: import("../../config").ConfigValueProvider<string>;
|
|
19
|
-
iss: import("../../config").ConfigValueProvider<string>;
|
|
20
|
-
privateKey: import("../../config").ConfigValueProvider<string>;
|
|
21
|
-
}; }) => {
|
|
16
|
+
export declare const createLaunchSigner: <C extends string = "launch">({ configSpace }: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => {
|
|
22
17
|
jwks: () => Promise<{
|
|
23
18
|
keys: JWK.RawKey[];
|
|
24
19
|
}>;
|
|
25
|
-
sign: (data: Record<string, JsonCompatibleValue>, subject: string, maxExp?: number | null
|
|
20
|
+
sign: (data: Record<string, JsonCompatibleValue>, subject: string, maxExp?: number | null) => Promise<string>;
|
|
26
21
|
};
|
|
27
|
-
export
|
|
22
|
+
export type LaunchSigner = ReturnType<ReturnType<typeof createLaunchSigner>>;
|
|
28
23
|
export {};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import jwt from 'jsonwebtoken';
|
|
2
2
|
import type { JWK } from 'node-jose';
|
|
3
3
|
import { ConfigProviderForConfig } from '../../config';
|
|
4
|
-
|
|
4
|
+
type Config = {
|
|
5
5
|
trustedDomain: string;
|
|
6
6
|
bypassSignatureVerification: string;
|
|
7
7
|
};
|
|
@@ -14,11 +14,8 @@ interface Initializer<C> {
|
|
|
14
14
|
/**
|
|
15
15
|
* Creates a class that can verify launch params
|
|
16
16
|
*/
|
|
17
|
-
export declare const createLaunchVerifier: <C extends string = "launch">({ configSpace, fetcher }: Initializer<C>) => (configProvider: { [
|
|
18
|
-
|
|
19
|
-
bypassSignatureVerification: import("../../config").ConfigValueProvider<string>;
|
|
20
|
-
}; }) => (_services: {}, getDefaultToken?: (() => string) | undefined) => {
|
|
21
|
-
verify: <T = undefined>(...args: T extends undefined ? [] | [string] : [(input: any) => T] | [string, (input: any) => T]) => Promise<T extends undefined ? jwt.JwtPayload : T>;
|
|
17
|
+
export declare const createLaunchVerifier: <C extends string = "launch">({ configSpace, fetcher }: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => (_services: {}, getDefaultToken?: () => string) => {
|
|
18
|
+
verify: <T = undefined>(...args: T extends undefined ? ([] | [string]) : ([(input: any) => T] | [string, (input: any) => T])) => Promise<T extends undefined ? jwt.JwtPayload : T>;
|
|
22
19
|
};
|
|
23
|
-
export
|
|
20
|
+
export type LaunchVerifier = ReturnType<ReturnType<ReturnType<typeof createLaunchVerifier>>>;
|
|
24
21
|
export {};
|
|
@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
|
|
|
15
15
|
}) : function(o, v) {
|
|
16
16
|
o["default"] = v;
|
|
17
17
|
});
|
|
18
|
-
var __importStar = (this && this.__importStar) || function (
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
};
|
|
18
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
19
|
+
var ownKeys = function(o) {
|
|
20
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
21
|
+
var ar = [];
|
|
22
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
23
|
+
return ar;
|
|
24
|
+
};
|
|
25
|
+
return ownKeys(o);
|
|
26
|
+
};
|
|
27
|
+
return function (mod) {
|
|
28
|
+
if (mod && mod.__esModule) return mod;
|
|
29
|
+
var result = {};
|
|
30
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
31
|
+
__setModuleDefault(result, mod);
|
|
32
|
+
return result;
|
|
33
|
+
};
|
|
34
|
+
})();
|
|
25
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
36
|
exports.createLaunchVerifier = void 0;
|
|
27
37
|
const jsonwebtoken_1 = __importStar(require("jsonwebtoken"));
|
|
@@ -13,7 +13,7 @@ export declare enum Level {
|
|
|
13
13
|
* @param level - log level
|
|
14
14
|
* @param event - event to log
|
|
15
15
|
*/
|
|
16
|
-
export
|
|
16
|
+
export type LogEvent = (level: Level, event: JsonCompatibleStruct) => void;
|
|
17
17
|
/**
|
|
18
18
|
* A logger that can be used to log events.
|
|
19
19
|
*
|
|
@@ -36,4 +36,4 @@ export interface Logger {
|
|
|
36
36
|
* (the context is returned when messages are logged with the logger)
|
|
37
37
|
* @returns a Logger
|
|
38
38
|
*/
|
|
39
|
-
export declare const createCoreLogger: (driver: LogEvent, getParentContext?: (
|
|
39
|
+
export declare const createCoreLogger: (driver: LogEvent, getParentContext?: () => JsonCompatibleStruct) => Logger;
|
|
@@ -9,7 +9,7 @@ var Level;
|
|
|
9
9
|
Level["Info"] = "info";
|
|
10
10
|
Level["Warn"] = "warn";
|
|
11
11
|
Level["Error"] = "error";
|
|
12
|
-
})(Level
|
|
12
|
+
})(Level || (exports.Level = Level = {}));
|
|
13
13
|
/**
|
|
14
14
|
* Creates a logger that logs events using the given driver and context provider.
|
|
15
15
|
*
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { User } from '../authProvider';
|
|
2
2
|
import { EagerXapiStatement, UXapiStatement, XapiStatement } from '.';
|
|
3
|
-
export declare const addStatementDefaultFields: (statement: (Pick<XapiStatement,
|
|
3
|
+
export declare const addStatementDefaultFields: (statement: (Pick<XapiStatement, "object" | "verb" | "context" | "result"> & {
|
|
4
4
|
id?: string;
|
|
5
5
|
}) | UXapiStatement, user: User) => EagerXapiStatement;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { LrsGateway, UXapiStatement } from '.';
|
|
2
|
-
export
|
|
2
|
+
export type ActivityState = {
|
|
3
3
|
attempts: number;
|
|
4
4
|
completedAttempts: number;
|
|
5
5
|
currentAttempt?: UXapiStatement;
|
|
@@ -11,60 +11,60 @@ export declare type ActivityState = {
|
|
|
11
11
|
export declare const matchAttempt: (statement: UXapiStatement) => boolean;
|
|
12
12
|
export declare const matchAttemptCompleted: (attempt: UXapiStatement) => (statement: UXapiStatement) => boolean;
|
|
13
13
|
export declare const resolveAttempts: (statements: UXapiStatement[], options?: {
|
|
14
|
-
activityIRI?: string
|
|
15
|
-
parentActivityAttempt?: string
|
|
16
|
-
}
|
|
17
|
-
export declare const resolveCompletedForAttempt: (statements: UXapiStatement[], attempt: UXapiStatement, activityIRI?: string
|
|
14
|
+
activityIRI?: string;
|
|
15
|
+
parentActivityAttempt?: string;
|
|
16
|
+
}) => UXapiStatement[];
|
|
17
|
+
export declare const resolveCompletedForAttempt: (statements: UXapiStatement[], attempt: UXapiStatement, activityIRI?: string) => UXapiStatement | undefined;
|
|
18
18
|
export declare const oldestStatement: (statements: UXapiStatement[]) => UXapiStatement | undefined;
|
|
19
19
|
export declare const mostRecentStatement: (statements: UXapiStatement[]) => UXapiStatement | undefined;
|
|
20
20
|
export declare const resolveAttemptInfo: (statements: UXapiStatement[], options?: {
|
|
21
|
-
activityIRI?: string
|
|
22
|
-
currentAttempt?: string
|
|
23
|
-
parentActivityAttempt?: string
|
|
24
|
-
currentPreference?: "latest" | "oldest"
|
|
25
|
-
}
|
|
21
|
+
activityIRI?: string;
|
|
22
|
+
currentAttempt?: string;
|
|
23
|
+
parentActivityAttempt?: string;
|
|
24
|
+
currentPreference?: "latest" | "oldest";
|
|
25
|
+
}) => ActivityState;
|
|
26
26
|
export declare const loadStatementsForActivityAndFirstChildren: (gateway: LrsGateway, activityIRI: string, options?: {
|
|
27
|
-
anyUser?: boolean
|
|
28
|
-
attempt?: string
|
|
29
|
-
ensureSync?: boolean
|
|
30
|
-
user?: string
|
|
31
|
-
}
|
|
27
|
+
anyUser?: boolean;
|
|
28
|
+
attempt?: string;
|
|
29
|
+
ensureSync?: boolean;
|
|
30
|
+
user?: string;
|
|
31
|
+
}) => Promise<import(".").XapiStatement[]>;
|
|
32
32
|
export declare const loadActivityAttemptInfo: (gateway: LrsGateway, activityIRI: string, options?: {
|
|
33
|
-
currentAttempt?: string
|
|
34
|
-
parentActivityAttempt?: string
|
|
35
|
-
ensureSync?: boolean
|
|
36
|
-
}
|
|
37
|
-
export declare const createStatement: (verb: UXapiStatement[
|
|
33
|
+
currentAttempt?: string;
|
|
34
|
+
parentActivityAttempt?: string;
|
|
35
|
+
ensureSync?: boolean;
|
|
36
|
+
}) => Promise<ActivityState>;
|
|
37
|
+
export declare const createStatement: (verb: UXapiStatement["verb"], activity: {
|
|
38
38
|
iri: string;
|
|
39
39
|
type: string;
|
|
40
40
|
name: string;
|
|
41
41
|
extensions?: {
|
|
42
42
|
[key: string]: string;
|
|
43
|
-
}
|
|
44
|
-
}, attempt: string, parentActivityIRI?: string
|
|
43
|
+
};
|
|
44
|
+
}, attempt: string, parentActivityIRI?: string) => Pick<UXapiStatement, "object" | "verb" | "context">;
|
|
45
45
|
export declare const createAttemptStatement: (activity: {
|
|
46
46
|
iri: string;
|
|
47
47
|
type: string;
|
|
48
48
|
name: string;
|
|
49
49
|
extensions?: {
|
|
50
50
|
[key: string]: string;
|
|
51
|
-
}
|
|
51
|
+
};
|
|
52
52
|
}, parentActivity?: {
|
|
53
|
-
iri?: string
|
|
54
|
-
attempt?: string
|
|
55
|
-
}
|
|
53
|
+
iri?: string;
|
|
54
|
+
attempt?: string;
|
|
55
|
+
}) => Pick<UXapiStatement, "object" | "verb" | "context">;
|
|
56
56
|
export declare const putAttemptStatement: (gateway: LrsGateway, activity: {
|
|
57
57
|
iri: string;
|
|
58
58
|
type: string;
|
|
59
59
|
name: string;
|
|
60
60
|
extensions?: {
|
|
61
61
|
[key: string]: string;
|
|
62
|
-
}
|
|
62
|
+
};
|
|
63
63
|
}, parentActivity?: {
|
|
64
|
-
iri?: string
|
|
65
|
-
attempt?: string
|
|
66
|
-
}
|
|
67
|
-
export declare const createAttemptActivityStatement: (attemptStatement: UXapiStatement, verb: UXapiStatement[
|
|
68
|
-
export declare const putAttemptActivityStatement: (gateway: LrsGateway, attemptStatement: UXapiStatement, verb: UXapiStatement[
|
|
69
|
-
export declare const createCompletedStatement: (attemptStatement: UXapiStatement, result?: UXapiStatement[
|
|
70
|
-
export declare const putCompletedStatement: (gateway: LrsGateway, attemptStatement: UXapiStatement, result: UXapiStatement[
|
|
64
|
+
iri?: string;
|
|
65
|
+
attempt?: string;
|
|
66
|
+
}) => Promise<import(".").EagerXapiStatement>;
|
|
67
|
+
export declare const createAttemptActivityStatement: (attemptStatement: UXapiStatement, verb: UXapiStatement["verb"], result?: UXapiStatement["result"]) => Pick<UXapiStatement, "object" | "verb" | "context" | "result">;
|
|
68
|
+
export declare const putAttemptActivityStatement: (gateway: LrsGateway, attemptStatement: UXapiStatement, verb: UXapiStatement["verb"], result?: UXapiStatement["result"]) => Promise<import(".").EagerXapiStatement>;
|
|
69
|
+
export declare const createCompletedStatement: (attemptStatement: UXapiStatement, result?: UXapiStatement["result"]) => Pick<UXapiStatement, "object" | "verb" | "context" | "result">;
|
|
70
|
+
export declare const putCompletedStatement: (gateway: LrsGateway, attemptStatement: UXapiStatement, result: UXapiStatement["result"]) => Promise<import(".").EagerXapiStatement>;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { ConfigProviderForConfig } from '../../config';
|
|
2
2
|
import { AuthProvider } from '../authProvider';
|
|
3
3
|
import { LrsGateway } from '.';
|
|
4
|
-
|
|
4
|
+
type Config = {
|
|
5
5
|
name: string;
|
|
6
6
|
};
|
|
7
7
|
interface Initializer<C> {
|
|
@@ -9,9 +9,7 @@ interface Initializer<C> {
|
|
|
9
9
|
fs?: Pick<typeof import('fs'), 'readFile' | 'writeFile'>;
|
|
10
10
|
configSpace?: C;
|
|
11
11
|
}
|
|
12
|
-
export declare const fileSystemLrsGateway: <C extends string = "fileSystem">(initializer: Initializer<C>) => (configProvider: { [
|
|
13
|
-
name: import("../../config").ConfigValueProvider<string>;
|
|
14
|
-
}; }) => ({ authProvider }: {
|
|
12
|
+
export declare const fileSystemLrsGateway: <C extends string = "fileSystem">(initializer: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => ({ authProvider }: {
|
|
15
13
|
authProvider: AuthProvider;
|
|
16
14
|
}) => LrsGateway;
|
|
17
15
|
export {};
|
|
@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
|
|
|
15
15
|
}) : function(o, v) {
|
|
16
16
|
o["default"] = v;
|
|
17
17
|
});
|
|
18
|
-
var __importStar = (this && this.__importStar) || function (
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
};
|
|
18
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
19
|
+
var ownKeys = function(o) {
|
|
20
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
21
|
+
var ar = [];
|
|
22
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
23
|
+
return ar;
|
|
24
|
+
};
|
|
25
|
+
return ownKeys(o);
|
|
26
|
+
};
|
|
27
|
+
return function (mod) {
|
|
28
|
+
if (mod && mod.__esModule) return mod;
|
|
29
|
+
var result = {};
|
|
30
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
31
|
+
__setModuleDefault(result, mod);
|
|
32
|
+
return result;
|
|
33
|
+
};
|
|
34
|
+
})();
|
|
25
35
|
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
26
36
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
27
37
|
};
|
|
@@ -3,7 +3,7 @@ import { GenericFetch } from '../../fetch';
|
|
|
3
3
|
import { WithRequired } from '../../types';
|
|
4
4
|
import { AuthProvider } from '../authProvider';
|
|
5
5
|
import { Logger } from '../logger';
|
|
6
|
-
|
|
6
|
+
type Config = {
|
|
7
7
|
lrsHost: string;
|
|
8
8
|
lrsAuthorization: string;
|
|
9
9
|
};
|
|
@@ -73,32 +73,29 @@ export interface XapiStatement {
|
|
|
73
73
|
timestamp: string;
|
|
74
74
|
stored?: string;
|
|
75
75
|
}
|
|
76
|
-
export
|
|
77
|
-
export
|
|
78
|
-
export
|
|
79
|
-
export
|
|
80
|
-
export
|
|
81
|
-
export declare const lrsGateway: <C extends string = "lrs">(initializer: Initializer<C>) => (configProvider: { [
|
|
82
|
-
lrsHost: import("../../config").ConfigValueProvider<string>;
|
|
83
|
-
lrsAuthorization: import("../../config").ConfigValueProvider<string>;
|
|
84
|
-
}; }) => ({ authProvider, logger }: {
|
|
76
|
+
export type SavedXapiStatement = WithRequired<XapiStatement, 'stored'>;
|
|
77
|
+
export type EagerXapiStatement = Omit<XapiStatement, 'stored'>;
|
|
78
|
+
export type UXapiStatement = XapiStatement | EagerXapiStatement | SavedXapiStatement;
|
|
79
|
+
export type LrsGateway = ReturnType<ReturnType<ReturnType<typeof lrsGateway>>>;
|
|
80
|
+
export type LrsProvider = ReturnType<ReturnType<typeof lrsGateway>>;
|
|
81
|
+
export declare const lrsGateway: <C extends string = "lrs">(initializer: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => ({ authProvider, logger }: {
|
|
85
82
|
authProvider: AuthProvider;
|
|
86
83
|
logger: Logger;
|
|
87
84
|
}) => {
|
|
88
|
-
putXapiStatements: (statements: Array<(Pick<XapiStatement,
|
|
85
|
+
putXapiStatements: (statements: Array<(Pick<XapiStatement, "object" | "verb" | "context" | "result"> & {
|
|
89
86
|
id?: string;
|
|
90
87
|
}) | UXapiStatement>) => Promise<EagerXapiStatement[]>;
|
|
91
88
|
getXapiStatements: (params: {
|
|
92
|
-
verb?: string
|
|
93
|
-
activity?: string
|
|
94
|
-
registration?: string
|
|
95
|
-
related_activities?: boolean
|
|
96
|
-
user?: string
|
|
97
|
-
anyUser?: boolean
|
|
98
|
-
since?: string
|
|
99
|
-
until?: string
|
|
89
|
+
verb?: string;
|
|
90
|
+
activity?: string;
|
|
91
|
+
registration?: string;
|
|
92
|
+
related_activities?: boolean;
|
|
93
|
+
user?: string;
|
|
94
|
+
anyUser?: boolean;
|
|
95
|
+
since?: string;
|
|
96
|
+
until?: string;
|
|
100
97
|
} & {
|
|
101
|
-
ensureSync?: boolean
|
|
98
|
+
ensureSync?: boolean;
|
|
102
99
|
}) => Promise<{
|
|
103
100
|
more: string;
|
|
104
101
|
statements: XapiStatement[];
|
|
@@ -107,19 +104,19 @@ export declare const lrsGateway: <C extends string = "lrs">(initializer: Initial
|
|
|
107
104
|
more: string;
|
|
108
105
|
statements: XapiStatement[];
|
|
109
106
|
}>;
|
|
110
|
-
getAllXapiStatements: ({ fetchUntil, ...params }: {
|
|
111
|
-
verb?: string
|
|
112
|
-
activity?: string
|
|
113
|
-
registration?: string
|
|
114
|
-
related_activities?: boolean
|
|
115
|
-
user?: string
|
|
116
|
-
anyUser?: boolean
|
|
117
|
-
since?: string
|
|
118
|
-
until?: string
|
|
119
|
-
} & {
|
|
120
|
-
ensureSync?: boolean | undefined;
|
|
107
|
+
getAllXapiStatements: ({ fetchUntil, ...params }: ({
|
|
108
|
+
verb?: string;
|
|
109
|
+
activity?: string;
|
|
110
|
+
registration?: string;
|
|
111
|
+
related_activities?: boolean;
|
|
112
|
+
user?: string;
|
|
113
|
+
anyUser?: boolean;
|
|
114
|
+
since?: string;
|
|
115
|
+
until?: string;
|
|
121
116
|
} & {
|
|
122
|
-
|
|
117
|
+
ensureSync?: boolean;
|
|
118
|
+
}) & {
|
|
119
|
+
fetchUntil?: (statements: XapiStatement[]) => boolean;
|
|
123
120
|
}) => Promise<XapiStatement[]>;
|
|
124
121
|
};
|
|
125
122
|
export {};
|
|
@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
|
|
|
15
15
|
}) : function(o, v) {
|
|
16
16
|
o["default"] = v;
|
|
17
17
|
});
|
|
18
|
-
var __importStar = (this && this.__importStar) || function (
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
};
|
|
18
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
19
|
+
var ownKeys = function(o) {
|
|
20
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
21
|
+
var ar = [];
|
|
22
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
23
|
+
return ar;
|
|
24
|
+
};
|
|
25
|
+
return ownKeys(o);
|
|
26
|
+
};
|
|
27
|
+
return function (mod) {
|
|
28
|
+
if (mod && mod.__esModule) return mod;
|
|
29
|
+
var result = {};
|
|
30
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
31
|
+
__setModuleDefault(result, mod);
|
|
32
|
+
return result;
|
|
33
|
+
};
|
|
34
|
+
})();
|
|
25
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
36
|
exports.lrsGateway = void 0;
|
|
27
37
|
const queryString = __importStar(require("query-string"));
|
|
@@ -11,12 +11,12 @@ export interface Grade {
|
|
|
11
11
|
userId?: string;
|
|
12
12
|
}
|
|
13
13
|
export declare const getRegistrationAttemptInfo: (lrs: LrsGateway, registration: string, options?: {
|
|
14
|
-
activity?: string
|
|
15
|
-
anyUser?: boolean
|
|
16
|
-
currentPreference?: "latest" | "oldest"
|
|
17
|
-
ensureSync?: boolean
|
|
18
|
-
user?: string
|
|
19
|
-
}
|
|
14
|
+
activity?: string;
|
|
15
|
+
anyUser?: boolean;
|
|
16
|
+
currentPreference?: "latest" | "oldest";
|
|
17
|
+
ensureSync?: boolean;
|
|
18
|
+
user?: string;
|
|
19
|
+
}) => Promise<{
|
|
20
20
|
[key: string]: ActivityState;
|
|
21
21
|
}>;
|
|
22
22
|
export declare const getScoreGrade: (score: {
|
|
@@ -24,13 +24,13 @@ export declare const getScoreGrade: (score: {
|
|
|
24
24
|
raw?: number;
|
|
25
25
|
min?: number;
|
|
26
26
|
max?: number;
|
|
27
|
-
}, completed: boolean, userId?: string
|
|
28
|
-
export
|
|
27
|
+
}, completed: boolean, userId?: string, maxScore?: number) => Grade;
|
|
28
|
+
export type Progress = {
|
|
29
29
|
scaled: number;
|
|
30
30
|
max?: number;
|
|
31
31
|
raw?: number;
|
|
32
32
|
};
|
|
33
|
-
export
|
|
33
|
+
export type GradeAndProgress = {
|
|
34
34
|
grade: Grade;
|
|
35
35
|
progress: Progress;
|
|
36
36
|
name?: string;
|
|
@@ -39,21 +39,21 @@ export declare const getCurrentGrade: (services: {
|
|
|
39
39
|
lrs: LrsGateway;
|
|
40
40
|
ltiAuthProvider: AuthProvider;
|
|
41
41
|
}, registration: string, options?: {
|
|
42
|
-
currentPreference?: "latest" | "oldest"
|
|
43
|
-
incompleteAttemptCallback?: (
|
|
44
|
-
name?: string
|
|
45
|
-
scoreMaximum?: number
|
|
46
|
-
userId?: string
|
|
47
|
-
}
|
|
48
|
-
export
|
|
42
|
+
currentPreference?: "latest" | "oldest";
|
|
43
|
+
incompleteAttemptCallback?: (info: ActivityState) => Promise<GradeAndProgress>;
|
|
44
|
+
name?: string;
|
|
45
|
+
scoreMaximum?: number;
|
|
46
|
+
userId?: string;
|
|
47
|
+
}) => Promise<GradeAndProgress | null>;
|
|
48
|
+
export type UserActivityInfo = MappedUserInfo<ActivityState>;
|
|
49
49
|
export declare const getAssignmentGrades: (services: {
|
|
50
50
|
accountsGateway: AccountsGateway;
|
|
51
51
|
lrs: LrsGateway;
|
|
52
52
|
}, assignmentIRI: string, registration: string, options?: {
|
|
53
|
-
anyUser?: boolean
|
|
54
|
-
currentPreference?: "latest" | "oldest"
|
|
55
|
-
incompleteAttemptsCallback?: (
|
|
56
|
-
platformId?: string
|
|
57
|
-
scoreMaximum?: number
|
|
58
|
-
user?: string
|
|
59
|
-
}
|
|
53
|
+
anyUser?: boolean;
|
|
54
|
+
currentPreference?: "latest" | "oldest";
|
|
55
|
+
incompleteAttemptsCallback?: (mappedInfo: UserActivityInfo[]) => Promise<GradeAndProgress[]>;
|
|
56
|
+
platformId?: string;
|
|
57
|
+
scoreMaximum?: number;
|
|
58
|
+
user?: string;
|
|
59
|
+
}) => Promise<GradeAndProgress[]>;
|