@openstax/ts-utils 1.29.0 → 1.30.1

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

@@ -3,7 +3,7 @@ import { GenericFetch } from '../../fetch';
 import { WithRequired } from '../../types';
 import { AuthProvider } from '../authProvider';
 import { Logger } from '../logger';
-declare type Config = {
+type Config = {
     lrsHost: string;
     lrsAuthorization: string;
 };
@@ -73,32 +73,29 @@ export interface XapiStatement {
     timestamp: string;
     stored?: string;
 }
-export declare type SavedXapiStatement = WithRequired<XapiStatement, 'stored'>;
-export declare type EagerXapiStatement = Omit<XapiStatement, 'stored'>;
-export declare type UXapiStatement = XapiStatement | EagerXapiStatement | SavedXapiStatement;
-export declare type LrsGateway = ReturnType<ReturnType<ReturnType<typeof lrsGateway>>>;
-export declare type LrsProvider = ReturnType<ReturnType<typeof lrsGateway>>;
-export declare const lrsGateway: <C extends string = "lrs">(initializer: Initializer<C>) => (configProvider: { [key in C]: {
-    lrsHost: import("../../config").ConfigValueProvider<string>;
-    lrsAuthorization: import("../../config").ConfigValueProvider<string>;
-}; }) => ({ authProvider, logger }: {
+export type SavedXapiStatement = WithRequired<XapiStatement, 'stored'>;
+export type EagerXapiStatement = Omit<XapiStatement, 'stored'>;
+export type UXapiStatement = XapiStatement | EagerXapiStatement | SavedXapiStatement;
+export type LrsGateway = ReturnType<ReturnType<ReturnType<typeof lrsGateway>>>;
+export type LrsProvider = ReturnType<ReturnType<typeof lrsGateway>>;
+export declare const lrsGateway: <C extends string = "lrs">(initializer: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => ({ authProvider, logger }: {
     authProvider: AuthProvider;
     logger: Logger;
 }) => {
-    putXapiStatements: (statements: Array<(Pick<XapiStatement, 'object' | 'verb' | 'context' | 'result'> & {
+    putXapiStatements: (statements: Array<(Pick<XapiStatement, "object" | "verb" | "context" | "result"> & {
         id?: string;
     }) | UXapiStatement>) => Promise<EagerXapiStatement[]>;
     getXapiStatements: (params: {
-        verb?: string | undefined;
-        activity?: string | undefined;
-        registration?: string | undefined;
-        related_activities?: boolean | undefined;
-        user?: string | undefined;
-        anyUser?: boolean | undefined;
-        since?: string | undefined;
-        until?: string | undefined;
+        verb?: string;
+        activity?: string;
+        registration?: string;
+        related_activities?: boolean;
+        user?: string;
+        anyUser?: boolean;
+        since?: string;
+        until?: string;
     } & {
-        ensureSync?: boolean | undefined;
+        ensureSync?: boolean;
     }) => Promise<{
         more: string;
         statements: XapiStatement[];
@@ -107,19 +104,19 @@ export declare const lrsGateway: <C extends string = "lrs">(initializer: Initial
         more: string;
         statements: XapiStatement[];
     }>;
-    getAllXapiStatements: ({ fetchUntil, ...params }: {
-        verb?: string | undefined;
-        activity?: string | undefined;
-        registration?: string | undefined;
-        related_activities?: boolean | undefined;
-        user?: string | undefined;
-        anyUser?: boolean | undefined;
-        since?: string | undefined;
-        until?: string | undefined;
-    } & {
-        ensureSync?: boolean | undefined;
+    getAllXapiStatements: ({ fetchUntil, ...params }: ({
+        verb?: string;
+        activity?: string;
+        registration?: string;
+        related_activities?: boolean;
+        user?: string;
+        anyUser?: boolean;
+        since?: string;
+        until?: string;
     } & {
-        fetchUntil?: ((statements: XapiStatement[]) => boolean) | undefined;
+        ensureSync?: boolean;
+    }) & {
+        fetchUntil?: (statements: XapiStatement[]) => boolean;
     }) => Promise<XapiStatement[]>;
 };
 export {};

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

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.lrsGateway = void 0;
 const queryString = __importStar(require("query-string"));

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

@@ -11,12 +11,12 @@ export interface Grade {
     userId?: string;
 }
 export declare const getRegistrationAttemptInfo: (lrs: LrsGateway, registration: string, options?: {
-    activity?: string | undefined;
-    anyUser?: boolean | undefined;
-    currentPreference?: "latest" | "oldest" | undefined;
-    ensureSync?: boolean | undefined;
-    user?: string | undefined;
-} | undefined) => Promise<{
+    activity?: string;
+    anyUser?: boolean;
+    currentPreference?: "latest" | "oldest";
+    ensureSync?: boolean;
+    user?: string;
+}) => Promise<{
     [key: string]: ActivityState;
 }>;
 export declare const getScoreGrade: (score: {
@@ -24,13 +24,13 @@ export declare const getScoreGrade: (score: {
     raw?: number;
     min?: number;
     max?: number;
-}, completed: boolean, userId?: string | undefined, maxScore?: number | undefined) => Grade;
-export declare type Progress = {
+}, completed: boolean, userId?: string, maxScore?: number) => Grade;
+export type Progress = {
     scaled: number;
     max?: number;
     raw?: number;
 };
-export declare type GradeAndProgress = {
+export type GradeAndProgress = {
     grade: Grade;
     progress: Progress;
     name?: string;
@@ -39,21 +39,21 @@ export declare const getCurrentGrade: (services: {
     lrs: LrsGateway;
     ltiAuthProvider: AuthProvider;
 }, registration: string, options?: {
-    currentPreference?: "latest" | "oldest" | undefined;
-    incompleteAttemptCallback?: ((info: ActivityState) => Promise<GradeAndProgress>) | undefined;
-    name?: string | undefined;
-    scoreMaximum?: number | undefined;
-    userId?: string | undefined;
-} | undefined) => Promise<GradeAndProgress | null>;
-export declare type UserActivityInfo = MappedUserInfo<ActivityState>;
+    currentPreference?: "latest" | "oldest";
+    incompleteAttemptCallback?: (info: ActivityState) => Promise<GradeAndProgress>;
+    name?: string;
+    scoreMaximum?: number;
+    userId?: string;
+}) => Promise<GradeAndProgress | null>;
+export type UserActivityInfo = MappedUserInfo<ActivityState>;
 export declare const getAssignmentGrades: (services: {
     accountsGateway: AccountsGateway;
     lrs: LrsGateway;
 }, assignmentIRI: string, registration: string, options?: {
-    anyUser?: boolean | undefined;
-    currentPreference?: "latest" | "oldest" | undefined;
-    incompleteAttemptsCallback?: ((mappedInfo: UserActivityInfo[]) => Promise<GradeAndProgress[]>) | undefined;
-    platformId?: string | undefined;
-    scoreMaximum?: number | undefined;
-    user?: string | undefined;
-} | undefined) => Promise<GradeAndProgress[]>;
+    anyUser?: boolean;
+    currentPreference?: "latest" | "oldest";
+    incompleteAttemptsCallback?: (mappedInfo: UserActivityInfo[]) => Promise<GradeAndProgress[]>;
+    platformId?: string;
+    scoreMaximum?: number;
+    user?: string;
+}) => Promise<GradeAndProgress[]>;

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

@@ -1,7 +1,7 @@
 import postgres, { Sql } from 'postgres';
 import { ConfigProviderForConfig } from '../../config';
 import type { Logger } from '../logger';
-declare type Config = {
+type Config = {
     host: string;
     readHost: string;
     port: string;
@@ -12,14 +12,7 @@ declare type Config = {
 interface Initializer<C> {
     configSpace?: C;
 }
-export declare const postgresConnection: <C extends string = "local">(initializer: Initializer<C>) => (configProvider: { [key in C]: {
-    host: import("../../config").ConfigValueProvider<string>;
-    readHost: import("../../config").ConfigValueProvider<string>;
-    port: import("../../config").ConfigValueProvider<string>;
-    database: import("../../config").ConfigValueProvider<string>;
-    username: import("../../config").ConfigValueProvider<string>;
-    password: import("../../config").ConfigValueProvider<string>;
-}; }) => (services: {
+export declare const postgresConnection: <C extends string = "local">(initializer: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => (services: {
     logger: Logger;
 }) => {
     db: () => Promise<postgres.Sql<{}>>;
@@ -27,7 +20,7 @@ export declare const postgresConnection: <C extends string = "local">(initialize
     migrate: (migrations: Migration[]) => Promise<void>;
     down: () => Promise<void[]>;
 };
-export declare type PostgresConnection = ReturnType<ReturnType<ReturnType<typeof postgresConnection>>>;
+export type PostgresConnection = ReturnType<ReturnType<ReturnType<typeof postgresConnection>>>;
 export interface Migration {
     name: string;
     up: (db: Sql) => Promise<void>;

package/dist/cjs/services/searchProvider/index.d.ts

@@ -1,5 +1,5 @@
-export declare type FieldType = string | string[] | number | boolean;
-export declare type ESFilter = {
+export type FieldType = string | string[] | number | boolean;
+export type ESFilter = {
     terms: Record<string, FieldType>;
 } | {
     term: Record<string, FieldType>;
@@ -15,18 +15,18 @@ export declare type ESFilter = {
 } | {
     bool: BoolFilter;
 };
-export declare type Filter = {
+export type Filter = {
     key: string;
     value: FieldType;
 } | ESFilter;
-export declare type BoolFilter = {
+export type BoolFilter = {
     must?: Filter[];
     must_not?: Filter[];
     should?: Filter[];
     filter?: Filter[];
     minimum_should_match?: number;
 };
-declare type Field = {
+type Field = {
     key: string;
     type?: 'text';
     weight: number;
@@ -41,7 +41,7 @@ export interface IndexOptions<T> {
     body: T;
     id: string;
 }
-export declare type FieldMapping = {
+export type FieldMapping = {
     type: 'keyword' | 'text' | 'boolean';
 } | {
     type: 'date';
@@ -50,7 +50,7 @@ export declare type FieldMapping = {
     type?: 'nested' | 'object';
     properties: Record<string, FieldMapping>;
 };
-export declare type FieldMappings = Record<string, FieldMapping>;
+export type FieldMappings = Record<string, FieldMapping>;
 export interface SearchOptions {
     page?: number;
     query: string | undefined;

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

@@ -1,5 +1,5 @@
 import { FieldMappings, IndexOptions, SearchOptions } from '.';
-export declare type Config<T> = {
+export type Config<T> = {
     mappings: FieldMappings;
     store: {
         loadAllDocumentsTheBadWay: () => Promise<T[]>;

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

@@ -1,21 +1,18 @@
 import { ConfigProviderForConfig } from '../../config';
 import { FieldMappings, IndexOptions, SearchOptions } from '.';
-export declare type Config = {
+export type Config = {
     node: string;
     region: string;
 };
 export interface Initializer<C> {
     configSpace?: C;
 }
-export declare type IndexConfig = {
+export type IndexConfig = {
     name: string;
     mappings: FieldMappings;
     pageSize?: number;
 };
-export declare const openSearchService: <C extends string = "deployed">(initializer?: Initializer<C>) => (configProvider: { [key in C]: {
-    node: import("../../config").ConfigValueProvider<string>;
-    region: import("../../config").ConfigValueProvider<string>;
-}; }) => <T>(indexConfig: IndexConfig) => {
+export declare const openSearchService: <C extends string = "deployed">(initializer?: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => <T>(indexConfig: IndexConfig) => {
     ensureIndexCreated: () => Promise<void>;
     deleteIndexIfExists: () => Promise<void>;
     index: (params: IndexOptions<T>) => Promise<void>;

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

@@ -26,9 +26,13 @@ const openSearchService = (initializer = {}) => (configProvider) => {
             region: await (0, config_1.resolveConfigValue)(config.region),
             service: 'es',
         }),
-        maxRetries: 3,
-        requestTimeout: 3000,
-        pingTimeout: 1000,
+        maxRetries: 4, // default is 3
+        requestTimeout: 5000, // default is 30000
+        pingTimeout: 2000, // default is 30000
+        sniffOnConnectionFault: true,
+        sniffOnStart: true,
+        resurrectStrategy: 'ping',
+        agent: { keepAlive: false },
         node: await (0, config_1.resolveConfigValue)(config.node),
     }));
     return (indexConfig) => {