@openstax/ts-utils 1.4.1 → 1.5.1

package/dist/esm/config/envConfig.js

@@ -1,5 +1,4 @@
-import { assertDefined } from '../assertions';
-import { ifDefined } from '../guards';
+import { resolveConfigValue } from '.';
 /**
  * A list of environment variables that were requested at build time. Used by webpack to
  * capture build-time environment variables values.
@@ -32,6 +31,16 @@ export const envConfig = (name, type = 'build', defaultValue) => {
         // - https://github.com/webpack/webpack/issues/14800
         // - https://github.com/webpack/webpack/issues/5392
         const envs = { ...process.env, ...(typeof __PROCESS_ENV !== 'undefined' ? __PROCESS_ENV : {}) };
-        return assertDefined(ifDefined(envs[name], defaultValue), `expected to find environment variable with name: ${name}`);
+        if (envs[name] === undefined) {
+            if (defaultValue === undefined) {
+                throw new Error(`expected to find environment variable with name: ${name}`);
+            }
+            else {
+                return resolveConfigValue(defaultValue);
+            }
+        }
+        else {
+            return envs[name];
+        }
     };
 };

package/dist/esm/services/accountsGateway/index.d.ts

@@ -0,0 +1,77 @@
+import { ConfigProviderForConfig } from '../../config';
+import { GenericFetch } from '../../fetch';
+import { JsonCompatibleStruct } from '../../routing';
+import { ApiUser } from '../authProvider';
+import { Logger } from '../logger';
+export declare type Config = {
+    accountsBase: string;
+    accountsAuthToken: string;
+};
+interface Initializer<C> {
+    configSpace?: C;
+    fetch: GenericFetch;
+}
+export declare type FindUserPayload = ({
+    external_id: string;
+} | {
+    uuid: string;
+}) & {
+    sso?: string;
+};
+export declare type FindOrCreateUserPayload = {
+    external_id: string;
+    email?: string;
+    already_verified?: boolean;
+    first_name?: string;
+    last_name?: string;
+    full_name?: string;
+    salesforce_contact_id?: string;
+    faculty_status?: string;
+    role?: string;
+    school_type?: string;
+    is_test?: boolean;
+    sso?: string;
+};
+export declare type FindOrCreateUserResponse = {
+    id: number;
+    uuid: string;
+    external_ids: string[];
+    is_test: boolean;
+    sso: string;
+};
+export declare type FindUserResponse = (FindOrCreateUserResponse & {
+    external_ids: string[];
+}) | undefined;
+export declare type LinkUserPayload = {
+    userId: number;
+    externalId: string;
+};
+export declare type LinkUserResponse = {
+    user_id: number;
+    external_id: string;
+};
+export declare type SearchUsersPayload = {
+    q: string;
+    order_by?: string;
+};
+export declare type SearchUsersResponse = {
+    items: Array<ApiUser & {
+        external_ids: string[];
+    } & JsonCompatibleStruct>;
+    total_count: number;
+};
+export declare const accountsGateway: <C extends string = "accounts">(initializer: Initializer<C>) => (configProvider: { [key in C]: {
+    accountsBase: import("../../config").ConfigValueProvider<string>;
+    accountsAuthToken: import("../../config").ConfigValueProvider<string>;
+}; }) => {
+    findOrCreateUser: (body: FindOrCreateUserPayload) => Promise<FindOrCreateUserResponse>;
+    findUser: (body: FindUserPayload) => Promise<FindUserResponse>;
+    getUser: (token: string) => Promise<ApiUser & JsonCompatibleStruct>;
+    linkUser: (body: LinkUserPayload) => Promise<LinkUserResponse>;
+    mapUserUuids: <T>(userUuidsMap: {
+        [uuid: string]: T;
+    }, logger: Logger, platformId?: string | undefined) => Promise<[string, T][]>;
+    searchUsers: (payload: SearchUsersPayload) => Promise<SearchUsersResponse>;
+};
+export declare type AccountsGateway = ReturnType<ReturnType<typeof accountsGateway>>;
+export {};

package/dist/esm/services/accountsGateway/index.js

@@ -0,0 +1,103 @@
+import { chunk, isEqual } from 'lodash';
+import queryString from 'query-string';
+import { resolveConfigValue } from '../../config';
+import { ifDefined } from '../../guards';
+import { METHOD } from '../../routing';
+import { Level } from '../logger';
+class ApiError extends Error {
+    constructor(message, status) {
+        super(message);
+        this.status = status;
+    }
+}
+export const accountsGateway = (initializer) => (configProvider) => {
+    const config = configProvider[ifDefined(initializer.configSpace, 'accounts')];
+    const accountsBase = resolveConfigValue(config.accountsBase);
+    const accountsAuthToken = resolveConfigValue(config.accountsAuthToken);
+    const request = async (method, path, options, statuses = [200, 201]) => {
+        const host = (await accountsBase).replace(/\/+$/, '');
+        const url = `${host}/api/${path}`;
+        const config = {
+            headers: {
+                Authorization: `Bearer ${options.token || await accountsAuthToken}`,
+            },
+            method,
+        };
+        if (options.body) {
+            config.body = JSON.stringify(options.body);
+        }
+        const response = await initializer.fetch(url, config);
+        if (!statuses.includes(response.status)) {
+            throw new ApiError(`Received unexpected status code ${response.status} for Accounts API call: ${method} ${url}`, response.status);
+        }
+        return response.json();
+    };
+    const findOrCreateUser = async (body) => request(METHOD.POST, 'user/find-or-create', { body });
+    const findUser = async (body) => {
+        try {
+            return await request(METHOD.POST, 'user/find', { body });
+        }
+        catch (error) {
+            if (error instanceof ApiError && error.status === 404) {
+                return undefined;
+            }
+            else {
+                throw error;
+            }
+        }
+    };
+    const getUser = async (token) => request(METHOD.GET, 'user', { token });
+    const linkUser = async (body) => request(METHOD.POST, 'user/external-ids', {
+        body: {
+            external_id: body.externalId,
+            user_id: body.userId,
+        }
+    });
+    const searchUsers = async (payload) => request(METHOD.GET, `users?${queryString.stringify(payload)}`, {});
+    const getPlatformUserId = (externalIds, platformId) => {
+        for (const externalId of externalIds) {
+            const [userPlatformId, userId] = externalId.split('/', 2);
+            if (userPlatformId === platformId) {
+                return userId;
+            }
+        }
+    };
+    /*
+     * If a platformId is given, returns an array where
+     * the first element is the user id from the platform
+     * and the second is the value from the map
+     * Otherwise, returns an array where
+     * the first element is the user's full_name
+     * and the second is the value from the map
+     */
+    const mapUserUuids = async (userUuidsMap, logger, platformId) => {
+        const results = [];
+        // Accounts will not return any results if this search returns more than 10 users
+        const chunkedUuids = chunk(Object.keys(userUuidsMap), 10);
+        await Promise.all(chunkedUuids.map(async (uuids) => {
+            const { items } = await searchUsers({ q: uuids.map((uuid) => `uuid:${uuid}`).join(' ') });
+            const accountsUuids = items.map((user) => user.uuid);
+            if (!isEqual(accountsUuids.sort(), uuids.sort())) {
+                logger.logEvent(Level.Warn, {
+                    message: 'Unexpected Accounts user search results',
+                    uuids,
+                    accountsUuids,
+                });
+            }
+            items.forEach((user) => {
+                const userId = platformId ? getPlatformUserId(user.external_ids, platformId) : user.full_name;
+                if (!userId) {
+                    const missing = platformId ? 'external_id matching the given platformId' : 'full_name';
+                    logger.logEvent(Level.Warn, {
+                        message: `Accounts user has no ${missing}`,
+                        accountsUuid: user.uuid,
+                        platformId,
+                    });
+                }
+                results.push([userId || 'N/A', userUuidsMap[user.uuid]]);
+            });
+        }));
+        return results;
+    };
+    return { findOrCreateUser, findUser, getUser, linkUser, mapUserUuids, searchUsers };
+};

package/dist/esm/services/apiGateway/index.d.ts

@@ -1,3 +1,4 @@
+import { Headers } from 'node-fetch';
 import { ConfigProviderForConfig } from '../../config';
 import { ConfigForFetch, GenericFetch, Response } from '../../fetch';
 import { AnyRoute, ApiResponse, OutputForRoute, ParamsForRoute, PayloadForRoute, QueryParams } from '../../routing';
@@ -24,11 +25,13 @@ interface AcceptStatus<Ro> {
     <S extends number[]>(...args: S): ApiClientResponse<any>;
 }
 declare type UnsafeApiClientResponse<Ro> = {
+    headers: Headers;
     load: () => Promise<any>;
     status: number;
     acceptStatus: AcceptStatus<Ro>;
 };
 declare type ApiClientResponse<Ro> = Ro extends any ? {
+    headers: Headers;
     status: TResponseStatus<Ro>;
     load: () => Promise<TResponsePayload<Ro>>;
 } : never;

package/dist/esm/services/authProvider/browser.d.ts

@@ -2,7 +2,7 @@ import { ConfigProviderForConfig } from '../../config';
 import { FetchConfig, GenericFetch } from '../../fetch';
 import { User } from '.';
 declare type Config = {
-    accountsUrl: string;
+    accountsBase: string;
 };
 interface Initializer<C> {
     configSpace?: C;
@@ -28,7 +28,7 @@ export interface Window {
     removeEventListener: (event: 'message', callback: EventHandler) => void;
 }
 export declare const browserAuthProvider: <C extends string = "auth">({ window, configSpace }: Initializer<C>) => (configProvider: { [key in C]: {
-    accountsUrl: import("../../config").ConfigValueProvider<string>;
+    accountsBase: import("../../config").ConfigValueProvider<string>;
 }; }) => {
     /**
      * adds auth parameters to the url. this is only safe to use when using javascript to navigate

package/dist/esm/services/authProvider/browser.js

@@ -4,7 +4,7 @@ import { ifDefined } from '../../guards';
 import { embeddedAuthProvider, PostMessageTypes } from './utils/embeddedAuthProvider';
 export const browserAuthProvider = ({ window, configSpace }) => (configProvider) => {
     const config = configProvider[ifDefined(configSpace, 'auth')];
-    const accountsUrl = once(() => resolveConfigValue(config.accountsUrl));
+    const accountsBase = once(() => resolveConfigValue(config.accountsBase));
     const queryString = window.location.search;
     const queryKey = 'auth';
     const authQuery = new URLSearchParams(queryString).get(queryKey);
@@ -68,7 +68,7 @@ export const browserAuthProvider = ({ window, configSpace }) => (configProvider)
      * requests user identity from accounts api using given token or cookie
      */
     const getFetchUser = async () => {
-        const response = await window.fetch((await accountsUrl()).replace(/\/+$/, '') + '/accounts/api/user', getAuthorizedFetchConfigFromData(userData));
+        const response = await window.fetch((await accountsBase()).replace(/\/+$/, '') + '/api/user', getAuthorizedFetchConfigFromData(userData));
         if (response.status === 200) {
             return { ...userData, user: await response.json() };
         }

package/dist/esm/services/authProvider/subrequest.d.ts

@@ -3,7 +3,7 @@ import { GenericFetch } from '../../fetch';
 import { CookieAuthProvider } from '.';
 declare type Config = {
     cookieName: string;
-    accountsUrl: string;
+    accountsBase: string;
 };
 interface Initializer<C> {
     configSpace?: C;
@@ -11,6 +11,6 @@ interface Initializer<C> {
 }
 export declare const subrequestAuthProvider: <C extends string = "subrequest">(initializer: Initializer<C>) => (configProvider: { [key in C]: {
     cookieName: import("../../config").ConfigValueProvider<string>;
-    accountsUrl: import("../../config").ConfigValueProvider<string>;
+    accountsBase: import("../../config").ConfigValueProvider<string>;
 }; }) => CookieAuthProvider;
 export {};

package/dist/esm/services/authProvider/subrequest.js

@@ -5,7 +5,7 @@ import { getAuthTokenOrCookie } from '.';
 export const subrequestAuthProvider = (initializer) => (configProvider) => {
     const config = configProvider[ifDefined(initializer.configSpace, 'subrequest')];
     const cookieName = once(() => resolveConfigValue(config.cookieName));
-    const accountsUrl = once(() => resolveConfigValue(config.accountsUrl));
+    const accountsBase = once(() => resolveConfigValue(config.accountsBase));
     return ({ request, profile }) => {
         let user;
         const getAuthorizedFetchConfig = profile.track('getAuthorizedFetchConfig', () => async () => {
@@ -20,7 +20,7 @@ export const subrequestAuthProvider = (initializer) => (configProvider) => {
             if (!token) {
                 return undefined;
             }
-            return p.trackFetch(initializer.fetch)(await accountsUrl(), { headers })
+            return p.trackFetch(initializer.fetch)((await accountsBase()).replace(/\/+$/, '') + '/api/user', { headers })
                 .then(response => response.json());
         });
         return {

package/dist/esm/services/lrsGateway/xapiUtils.d.ts

@@ -0,0 +1,32 @@
+import { AccountsGateway } from '../accountsGateway';
+import { AuthProvider } from '../authProvider';
+import { Logger } from '../logger';
+import { LrsGateway } from '.';
+export interface Grade {
+    scoreGiven: number;
+    scoreMaximum: number;
+    comment?: string;
+    activityProgress: 'Initialized' | 'Started' | 'inProgress' | 'Submitted' | 'Completed';
+    gradingProgress: 'FullyGraded' | 'Pending' | 'PendingManual' | 'Failed' | 'NotReady';
+    userId: string;
+}
+export declare const getRegistrationAttemptInfo: (lrs: LrsGateway, registration: string, options?: {
+    anyUser?: boolean | undefined;
+} | undefined) => Promise<{
+    [key: string]: import("./attempt-utils").ActivityState;
+}>;
+export declare const getCurrentGrade: (services: {
+    lrs: LrsGateway;
+    ltiAuthProvider: AuthProvider;
+}, registration: string, options?: {
+    scoreMaximum?: number | undefined;
+    userId?: string | undefined;
+} | undefined) => Promise<Grade | null>;
+export declare const getAllGradesForAssignment: (services: {
+    accountsGateway: AccountsGateway;
+    lrs: LrsGateway;
+    logger: Logger;
+}, registration: string, options?: {
+    platformId?: string | undefined;
+    scoreMaximum?: number | undefined;
+} | undefined) => Promise<Grade[]>;

package/dist/esm/services/lrsGateway/xapiUtils.js

@@ -0,0 +1,55 @@
+import { roundToPrecision } from '../..';
+import { resolveAttemptInfo } from './attempt-utils';
+export const getRegistrationAttemptInfo = async (lrs, registration, options) => {
+    const allStatements = await lrs.getAllXapiStatements({ ...options, registration, ensureSync: true });
+    // Partition statements for each user
+    const statementsPerUser = {};
+    allStatements.forEach((statement) => {
+        var _a;
+        // If we ever support accounts from different statement.actor.account.homePage, this method may need changes
+        // (unless we can guarantee the statement.actor.account.name are unique)
+        statementsPerUser[_a = statement.actor.account.name] || (statementsPerUser[_a] = []);
+        statementsPerUser[statement.actor.account.name].push(statement);
+    });
+    const result = {};
+    for (const [userUuid, userStatements] of Object.entries(statementsPerUser)) {
+        result[userUuid] = resolveAttemptInfo(userStatements);
+    }
+    return result;
+};
+// generates a payload that can be sent to the LMS, documentation here:
+// lti: http://www.imsglobal.org/spec/lti-ags/v2p0#score-publish-service
+// ltijs: https://cvmcosta.me/ltijs/#/grading
+const getInfoGrade = (info, userId, maxScore) => {
+    var _a;
+    const completed = info.currentAttemptCompleted;
+    const { raw, scaled, max } = ((_a = completed === null || completed === void 0 ? void 0 : completed.result) === null || _a === void 0 ? void 0 : _a.score) || {};
+    const scoreMaximum = maxScore !== null && maxScore !== void 0 ? maxScore : 100;
+    const scoreGiven = raw && max
+        ? scoreMaximum / max * raw
+        : scaled
+            ? scaled * scoreMaximum
+            : 0;
+    return {
+        userId,
+        activityProgress: completed ? 'Completed' : 'Started',
+        gradingProgress: completed ? 'FullyGraded' : 'NotReady',
+        scoreMaximum,
+        scoreGiven: roundToPrecision(scoreGiven, -2),
+    };
+};
+export const getCurrentGrade = async (services, registration, options) => {
+    var _a;
+    const user = await services.ltiAuthProvider.getUser();
+    if (!user) {
+        return null;
+    }
+    const infoPerUser = await getRegistrationAttemptInfo(services.lrs, registration);
+    const userInfo = infoPerUser[user.uuid];
+    return getInfoGrade(userInfo !== null && userInfo !== void 0 ? userInfo : resolveAttemptInfo([]), (_a = options === null || options === void 0 ? void 0 : options.userId) !== null && _a !== void 0 ? _a : user.uuid, options === null || options === void 0 ? void 0 : options.scoreMaximum);
+};
+export const getAllGradesForAssignment = async (services, registration, options) => {
+    const infoPerUserUuid = await getRegistrationAttemptInfo(services.lrs, registration, { anyUser: true });
+    const mappedResults = await services.accountsGateway.mapUserUuids(infoPerUserUuid, services.logger, options === null || options === void 0 ? void 0 : options.platformId);
+    return mappedResults.map(([userId, userInfo]) => getInfoGrade(userInfo, userId, options === null || options === void 0 ? void 0 : options.scoreMaximum));
+};