@openstax/ts-utils 1.44.1 → 1.44.3

package/dist/esm/services/lrsGateway/attempt-utils.js

@@ -11,6 +11,18 @@ import intervalToDuration from 'date-fns/intervalToDuration';
 import isAfter from 'date-fns/isAfter';
 import isBefore from 'date-fns/isBefore';
 import parseISO from 'date-fns/parseISO';
+export const formatAgent = (agent) => {
+    if (typeof agent === 'string') {
+        return {
+            objectType: 'Agent',
+            account: {
+                homePage: 'https://openstax.org',
+                name: agent,
+            },
+        };
+    }
+    return agent;
+};
 var Verb;
 (function (Verb) {
     Verb["Attempted"] = "http://adlnet.gov/expapi/verbs/attempted";
@@ -153,7 +165,7 @@ export const loadActivityAttemptInfo = async (gateway, activityIRI, options) =>
     const loadOptions = parentActivityAttempt ? { ...partialOptions, registration: parentActivityAttempt } : partialOptions;
     return resolveAttemptInfo(await gateway.getAllXapiStatements({ ...loadOptions, activity: activityIRI }), { ...options, activityIRI });
 };
-export const createStatement = (verb, activity, attempt, parentActivityIRI) => {
+export const createStatement = (verb, activity, attempt, parentActivityIRI, instructor) => {
     return {
         context: {
             ...(parentActivityIRI ? {
@@ -167,6 +179,7 @@ export const createStatement = (verb, activity, attempt, parentActivityIRI) => {
                 },
             } : {}),
             registration: attempt,
+            ...(instructor ? { instructor: formatAgent(instructor) } : {}),
         },
         object: {
             definition: {
@@ -210,7 +223,7 @@ export const createAttemptStatement = (activity, parentActivity) => {
                 } : {}),
                 ...(parentActivity.attempt ? {
                     registration: parentActivity.attempt,
-                } : {})
+                } : {}),
             },
         } : {}),
         object: {
@@ -276,7 +289,7 @@ export const createCompletedStatement = (attemptStatement, result) => {
             statement: {
                 objectType: 'StatementRef',
                 id: attemptStatement.id,
-            }
+            },
         },
         object: attemptStatement.object,
         verb: {
@@ -304,7 +317,7 @@ export const putCompletedPendingScoringStatement = async (gateway, attemptStatem
     ], user))[0];
 };
 // scored statement for when the open written response has been graded.
-export const createScoredStatement = (attemptStatement, result) => {
+export const createScoredStatement = (attemptStatement, result, instructor) => {
     var _a, _b;
     return {
         context: {
@@ -317,7 +330,8 @@ export const createScoredStatement = (attemptStatement, result) => {
             statement: {
                 objectType: 'StatementRef',
                 id: attemptStatement.id,
-            }
+            },
+            ...(instructor ? { instructor: formatAgent(instructor) } : {}),
         },
         object: attemptStatement.object,
         verb: {
@@ -330,8 +344,8 @@ export const createScoredStatement = (attemptStatement, result) => {
         }
     };
 };
-export const putScoredStatement = async (gateway, attemptStatement, result, user) => {
-    return (await gateway.putXapiStatements([createScoredStatement(attemptStatement, result)], user))[0];
+export const putScoredStatement = async (gateway, attemptStatement, result, user, instructor) => {
+    return (await gateway.putXapiStatements([createScoredStatement(attemptStatement, result, instructor)], user))[0];
 };
 // scored statement for retry assessments - records a score but marks the attempt as still pending scoring
 export const createScoredPendingScoringStatement = (attemptStatement, result) => createScoredStatement(attemptStatement, {

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

@@ -1,5 +1,5 @@
-import { GenericFetch, Response } from '../../fetch';
-import { METHOD } from '../../routing';
+import { GenericFetch, Response } from '../../fetch/index.js';
+import { METHOD } from '../../routing/index.js';
 export interface BatchRequest {
     id: string;
     path: string;

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

@@ -1,4 +1,4 @@
-import { METHOD } from '../../routing';
+import { METHOD } from '../../routing/index.js';
 /**
  * Handles automatic request batching using microtask queue scheduling.
  * Batches concurrent requests within the same event loop tick.

package/dist/esm/services/lrsGateway/file-system.d.ts

@@ -1,6 +1,6 @@
-import { ConfigProviderForConfig } from '../../config';
-import { AuthProvider } from '../authProvider';
-import { LrsGateway } from '.';
+import { ConfigProviderForConfig } from '../../config/index.js';
+import { AuthProvider } from '../authProvider/index.js';
+import { LrsGateway } from './index.js';
 type Config = {
     name: string;
 };

package/dist/esm/services/lrsGateway/file-system.js

@@ -2,11 +2,12 @@ import * as fsModule from 'fs';
 import path from 'path';
 import formatISO from 'date-fns/formatISO';
 import { v4 as uuid } from 'uuid';
-import { assertDefined } from '../../assertions';
-import { resolveConfigValue } from '../../config';
-import { UnauthorizedError } from '../../errors';
-import { ifDefined } from '../../guards';
-import { hashValue } from '../../misc/hashValue';
+import { assertDefined } from '../../assertions/index.js';
+import { resolveConfigValue } from '../../config/index.js';
+import { UnauthorizedError } from '../../errors/index.js';
+import { ifDefined } from '../../guards/index.js';
+import { hashValue } from '../../misc/hashValue.js';
+import { formatAgent } from './attempt-utils.js';
 const pageSize = 5;
 export const fileSystemLrsGateway = (initializer) => (configProvider) => ({ authProvider }) => {
     const name = resolveConfigValue(configProvider[initializer.configSpace || 'fileSystem'].name);
@@ -69,13 +70,7 @@ export const fileSystemLrsGateway = (initializer) => (configProvider) => ({ auth
         const statementsWithDefaults = statements.map(statement => ({
             ...statement,
             id: uuid(),
-            actor: {
-                account: {
-                    homePage: 'https://openstax.org',
-                    name: author.uuid,
-                },
-                objectType: 'Agent',
-            },
+            actor: formatAgent(author.uuid),
             timestamp: formatISO(new Date()),
         }));
         await load;

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

@@ -1,8 +1,8 @@
-import { ConfigProviderForConfig } from '../../config';
-import { GenericFetch } from '../../fetch';
-import { WithRequired } from '../../types';
-import { AuthProvider } from '../authProvider';
-import { Logger } from '../logger';
+import { ConfigProviderForConfig } from '../../config/index.js';
+import { GenericFetch } from '../../fetch/index.js';
+import { WithRequired } from '../../types.js';
+import { AuthProvider } from '../authProvider/index.js';
+import { Logger } from '../logger/index.js';
 type Config = {
     lrsHost: string;
     lrsAuthorization: string;
@@ -23,13 +23,7 @@ export interface StateDocument {
     [key: string]: any;
 }
 export interface XapiStatement {
-    actor: {
-        account: {
-            homePage: 'https://openstax.org';
-            name: string;
-        };
-        objectType: 'Agent';
-    };
+    actor: XapiAgent;
     id: string;
     context?: {
         contextActivities?: {
@@ -46,6 +40,7 @@ export interface XapiStatement {
         };
         registration?: string;
         platform?: string;
+        instructor?: XapiAgent;
     };
     object: {
         definition?: {

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

@@ -1,13 +1,14 @@
-import { once } from '../..';
-import { assertDefined } from '../../assertions';
-import { resolveConfigValue } from '../../config';
-import { UnauthorizedError } from '../../errors';
-import { fetchStatusRetry } from '../../fetch/fetchStatusRetry';
-import { ifDefined } from '../../guards';
-import { retryWithDelay } from '../../misc/helpers';
-import { METHOD } from '../../routing';
-import { addStatementDefaultFields } from './addStatementDefaultFields';
-import { RequestBatcher } from './batching';
+import { assertDefined } from '../../assertions/index.js';
+import { resolveConfigValue } from '../../config/index.js';
+import { UnauthorizedError } from '../../errors/index.js';
+import { fetchStatusRetry } from '../../fetch/fetchStatusRetry.js';
+import { ifDefined } from '../../guards/index.js';
+import { once } from '../../index.js';
+import { retryWithDelay } from '../../misc/helpers.js';
+import { METHOD } from '../../routing/index.js';
+import { addStatementDefaultFields } from './addStatementDefaultFields.js';
+import { formatAgent } from './attempt-utils.js';
+import { RequestBatcher } from './batching.js';
 export const lrsGateway = (initializer) => (configProvider) => {
     const config = configProvider[ifDefined(initializer.configSpace, 'lrs')];
     const lrsHost = once(() => resolveConfigValue(config.lrsHost));
@@ -33,22 +34,6 @@ export const lrsGateway = (initializer) => (configProvider) => {
         const makeFetch = async (options) => {
             return enableBatching ? batcher.queueRequest(options) : batcher.singleRequest(options);
         };
-        /**
-         * Formats an agent parameter into a full XapiAgent object.
-         * Accepts either a UUID string or a full XapiAgent object.
-         */
-        const formatAgent = (agent) => {
-            if (typeof agent === 'string') {
-                return {
-                    objectType: 'Agent',
-                    account: {
-                        homePage: 'https://openstax.org',
-                        name: agent,
-                    },
-                };
-            }
-            return agent;
-        };
         // Note: This method actually uses POST
         const putXapiStatements = async (statements, user) => {
             const userObj = user
@@ -110,13 +95,7 @@ ${await response.text()}`);
                 queryParams.until = options.until;
             // Add agent unless anyUser is true
             if (anyUser !== true) {
-                queryParams.agent = JSON.stringify({
-                    account: {
-                        homePage: 'https://openstax.org',
-                        name: user || assertDefined(await authProvider.getUser(), new UnauthorizedError()).uuid,
-                    },
-                    objectType: 'Agent',
-                });
+                queryParams.agent = JSON.stringify(formatAgent(user || assertDefined(await authProvider.getUser(), new UnauthorizedError()).uuid));
             }
             return makeFetch({
                 path: '/data/xAPI/statements',

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

@@ -1,7 +1,7 @@
-import { AccountsGateway, MappedUserInfo } from '../accountsGateway';
-import { AuthProvider } from '../authProvider';
-import { ActivityState, AttemptEntry } from './attempt-utils';
-import { LrsGateway } from '.';
+import { AccountsGateway, MappedUserInfo } from '../accountsGateway/index.js';
+import { AuthProvider } from '../authProvider/index.js';
+import { ActivityState, AttemptEntry } from './attempt-utils.js';
+import { LrsGateway } from './index.js';
 export interface Grade {
     activityProgress: 'Initialized' | 'Started' | 'inProgress' | 'Submitted' | 'Completed';
     comment?: string;

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

@@ -1,6 +1,6 @@
 import partition from 'lodash/fp/partition';
-import { roundToPrecision } from '../..';
-import { getStatementTimeString, resolveAttemptInfo } from './attempt-utils';
+import { roundToPrecision } from '../../index.js';
+import { getStatementTimeString, resolveAttemptInfo } from './attempt-utils.js';
 export const getRegistrationAttemptInfo = async (lrs, registration, options) => {
     const { currentPreference, ...xapiOptions } = options !== null && options !== void 0 ? options : {};
     const allStatements = await lrs.getAllXapiStatements({ ...xapiOptions, registration });

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

@@ -1,6 +1,6 @@
 import postgres, { Sql } from 'postgres';
-import { ConfigProviderForConfig } from '../../config';
-import type { Logger } from '../logger';
+import { ConfigProviderForConfig } from '../../config/index.js';
+import type { Logger } from '../logger/index.js';
 type Config = {
     host: string;
     readHost: string;

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

@@ -1,8 +1,8 @@
 import postgres from 'postgres';
-import { assertNotNaN } from '../../assertions';
-import { resolveConfigValue } from '../../config';
-import { ifDefined } from '../../guards';
-import { once } from '../../misc/helpers';
+import { assertNotNaN } from '../../assertions/index.js';
+import { resolveConfigValue } from '../../config/index.js';
+import { ifDefined } from '../../guards/index.js';
+import { once } from '../../misc/helpers.js';
 export const postgresConnection = (initializer) => (configProvider) => {
     const config = configProvider[ifDefined(initializer.configSpace, 'local')];
     const host = once(() => resolveConfigValue(config.host));

package/dist/esm/services/queueProvider/local.d.ts

@@ -1,5 +1,5 @@
-import { ConfigProviderForConfig } from '../../config';
-import { QueueProvider } from '.';
+import { ConfigProviderForConfig } from '../../config/index.js';
+import { QueueProvider } from './index.js';
 export type Config = {
     handlerModulePath: string;
 };

package/dist/esm/services/queueProvider/local.js

@@ -1,6 +1,6 @@
-import { resolveConfigValue } from '../../config';
-import { ifDefined } from '../../guards';
-import { once } from '../../misc/helpers';
+import { resolveConfigValue } from '../../config/index.js';
+import { ifDefined } from '../../guards/index.js';
+import { once } from '../../misc/helpers.js';
 export const localQueueProvider = (initializer) => {
     const init = ifDefined(initializer, {});
     return () => (configProvider) => {
@@ -9,7 +9,6 @@ export const localQueueProvider = (initializer) => {
         return {
             enqueueMessage: async (payload, _options) => {
                 const modulePath = await handlerModulePath();
-                // eslint-disable-next-line @typescript-eslint/no-var-requires
                 const module = require(modulePath);
                 await module.handler(payload);
             },

package/dist/esm/services/queueProvider/sqs.d.ts

@@ -1,6 +1,6 @@
 import { SQS } from '@aws-sdk/client-sqs';
-import { ConfigProviderForConfig } from '../../config';
-import { QueueProvider } from '.';
+import { ConfigProviderForConfig } from '../../config/index.js';
+import { QueueProvider } from './index.js';
 export type Config = {
     queueUrl: string;
 };

package/dist/esm/services/queueProvider/sqs.js

@@ -1,7 +1,7 @@
 import { SendMessageCommand, SQS } from '@aws-sdk/client-sqs';
-import { resolveConfigValue } from '../../config';
-import { ifDefined } from '../../guards';
-import { once } from '../../misc/helpers';
+import { resolveConfigValue } from '../../config/index.js';
+import { ifDefined } from '../../guards/index.js';
+import { once } from '../../misc/helpers.js';
 export const sqsQueueProvider = (initializer) => {
     const init = ifDefined(initializer, {});
     const sqs = once(() => { var _a; return (_a = init.sqsClient) !== null && _a !== void 0 ? _a : new SQS({ apiVersion: '2012-11-05' }); });

package/dist/esm/services/searchProvider/memorySearchTheBadWay.d.ts

@@ -1,4 +1,4 @@
-import { FieldMappings, IndexOptions, SearchOptions } from '.';
+import { FieldMappings, IndexOptions, SearchOptions } from './index.js';
 export type Config<T> = {
     mappings: FieldMappings;
     store: {

package/dist/esm/services/searchProvider/memorySearchTheBadWay.js

@@ -1,6 +1,6 @@
-import { coerceArray } from '../..';
-import { InvalidRequestError } from '../../errors';
-import { isDefined } from '../../guards';
+import { InvalidRequestError } from '../../errors/index.js';
+import { isDefined } from '../../guards/index.js';
+import { coerceArray } from '../../index.js';
 const MIN_MATCH = 0.5;
 const MAX_RESULTS = 10;
 var MatchType;

package/dist/esm/services/searchProvider/openSearch.d.ts

@@ -1,5 +1,5 @@
-import { ConfigProviderForConfig } from '../../config';
-import { FieldMappings, IndexOptions, SearchOptions } from '.';
+import { ConfigProviderForConfig } from '../../config/index.js';
+import { FieldMappings, IndexOptions, SearchOptions } from './index.js';
 export type Config = {
     node: string;
     region: string;

package/dist/esm/services/searchProvider/openSearch.js

@@ -1,10 +1,10 @@
-// cspell:ignore opensearch, Sigv
+/* spell-checker: ignore opensearch Sigv */
 import { defaultProvider } from '@aws-sdk/credential-provider-node';
 import { Client } from '@opensearch-project/opensearch';
 import { AwsSigv4Signer } from '@opensearch-project/opensearch/aws';
-import { resolveConfigValue } from '../../config';
-import { ifDefined, isDefined } from '../../guards';
-import { once } from '../../misc/helpers';
+import { resolveConfigValue } from '../../config/index.js';
+import { ifDefined, isDefined } from '../../guards/index.js';
+import { once } from '../../misc/helpers.js';
 const mapFilter = (filter) => {
     if ('key' in filter && 'value' in filter) {
         const { key } = filter;

package/dist/esm/services/searchProvider/streamIndexer.d.ts

@@ -1,6 +1,6 @@
 import { DynamoDBRecord } from 'aws-lambda';
-import { Logger } from '../logger';
-import { IndexOptions } from '../searchProvider';
+import { Logger } from '../logger/index.js';
+import { IndexOptions } from '../searchProvider/index.js';
 export interface SearchProvider<T> {
     index: (options: IndexOptions<T>) => Promise<void>;
     bulkIndex: (items: IndexOptions<T>[]) => Promise<void>;

package/dist/esm/services/searchProvider/streamIndexer.js

@@ -1,5 +1,5 @@
 import { unmarshall } from '@aws-sdk/util-dynamodb';
-import { Level } from '../logger';
+import { Level } from '../logger/index.js';
 const VALID_EVENTS = new Set(['INSERT', 'MODIFY']);
 /**
  * Function to update search index from DynamoDB Stream records.