@openstax/ts-utils 1.32.1 → 1.32.3

package/dist/esm/routing/index.d.ts

@@ -25,20 +25,6 @@ export type RouteMatchRecord<R> = R extends AnyRoute<R> ? {
     route: R;
     params: ParamsForRoute<R>;
 } : never;
-type Flatten<T> = T extends any ? {
-    [K in keyof T]: T[K];
-} : never;
-export type ExternalRoute<R> = R extends Route<infer N, infer P, infer Sa, infer Sr, infer Ri, infer Ro> & infer E ? Route<N, P, Sa, Sr extends {
-    payload: any;
-} ? Flatten<Pick<Sr, 'payload'>> : Record<string, never>, Ri, Ro> & Flatten<Omit<E, 'name' | 'path' | 'handler' | 'requestServiceProvider'>> : never;
-/** this utility simplifies the route type to remove stuff that is only
- * relevant internal to the route, like the service types, keeping only
- * the payload type which is necessary for the apiGateway
- *
- * this helps avoid the "type too complicated" error that typescript throws
- * when there are a lot of routes with complex services
- **/
-export declare const routesList: <R>(routes: R[]) => ExternalRoute<R>[];
 /**
  * The conditional type for the payload for a given route, `R`. This isn't a route structure, its
  * a convention based on the request middleware
@@ -154,9 +140,7 @@ export declare const makeCreateRoute: <Sa, Ri, Ex = {}>() => CreateRoute<Sa, Ri,
  */
 export declare const makeRenderRouteUrl: <Ru extends {
     path: string;
-}>() => <R>(route: ExternalRoute<R> extends Ru ? R & {
-    path: string;
-} : R extends Ru ? R : never, params: ParamsForRoute<R>, query?: QueryParams) => string;
+}>() => <R extends Ru>(route: R, params: ParamsForRoute<R>, query?: QueryParams) => string;
 /**
  * A pre-made result from `makeRenderRouteUrl`, this function interpolates parameter and query
  * arguments into a route path.
@@ -169,9 +153,7 @@ export declare const makeRenderRouteUrl: <Ru extends {
  * @param query the query parameters to add to the route path
  * @returns the interpolated route path
  */
-export declare const renderAnyRouteUrl: <R>(route: ExternalRoute<R> extends any ? R & {
-    path: string;
-} : R extends any ? R : never, params: ParamsForRoute<R>, query?: QueryParams) => string;
+export declare const renderAnyRouteUrl: <R extends any>(route: R, params: ParamsForRoute<R>, query?: QueryParams) => string;
 type RequestPathExtractor<Ri> = (request: Ri) => string;
 type RequestLogExtractor<Ri> = (request: Ri) => JsonCompatibleStruct;
 type RequestRouteMatcher<Ri, R> = (request: Ri, route: R) => boolean;

package/dist/esm/routing/index.js

@@ -2,14 +2,6 @@ import * as pathToRegexp from 'path-to-regexp';
 import queryString from 'query-string';
 import { mapFind, memoize } from '../misc/helpers';
 import { createConsoleLogger } from '../services/logger/console';
-/** this utility simplifies the route type to remove stuff that is only
- * relevant internal to the route, like the service types, keeping only
- * the payload type which is necessary for the apiGateway
- *
- * this helps avoid the "type too complicated" error that typescript throws
- * when there are a lot of routes with complex services
- **/
-export const routesList = (routes) => routes;
 /**
  * Makes a createRoute function that can be used to create routes (this is a factory factory). The
  * `makeCreateRoute` function is typically called once in the backend and once in the frontend to

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

@@ -38,7 +38,7 @@ export type ApiClientResponse<Ro> = Ro extends any ? {
 } : never;
 export type ExpandRoute<T> = T extends ((...args: infer A) => infer R) & {
     renderUrl: (...args: infer Ar) => Promise<string>;
-} ? ((...args: A) => R) & {
+} ? (...args: A) => R & {
     renderUrl: (...args: Ar) => Promise<string>;
 } : never;
 export type MapRoutesToClient<Ru> = [Ru] extends [AnyRoute<Ru>] ? {

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

@@ -1,6 +1,7 @@
 import { ConfigProviderForConfig } from '../../config';
-import { FetchConfig, GenericFetch } from '../../fetch';
-import { ApiUser, User } from '.';
+import { GenericFetch } from '../../fetch';
+import { UserData } from './utils/embeddedAuthProvider';
+import { ApiUser, AuthProvider } from '.';
 type Config = {
     accountsBase: string;
 };
@@ -27,46 +28,13 @@ export interface Window {
     removeEventListener: (event: 'message', callback: EventHandler) => void;
 }
 export type UpdatableUserFields = Partial<Pick<ApiUser, 'consent_preferences' | 'first_name' | 'last_name'>>;
-export declare const browserAuthProvider: <C extends string = "auth">({ window, configSpace }: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => {
-    /**
-     * gets the authentication token
-     */
-    getAuthToken: () => Promise<string | null>;
-    /**
-     * adds auth parameters to the url. this is only safe to use when using javascript to navigate
-     * within the current window, eg `window.location = 'https://my.otherservice.com';` anchors
-     * should use getAuthorizedLinkUrl for their href.
-     *
-     * result unreliable unless `getUser` is resolved first.
-     */
+export type BrowserAuthProvider = AuthProvider & {
     getAuthorizedUrl: (urlString: string) => string;
-    /**
-     * all link href-s must be rendered with auth tokens so that they work when opened in a new tab
-     *
-     * result unreliable unless `getUser` is resolved first.
-     */
     getAuthorizedLinkUrl: (urlString: string) => string;
-    /**
-     * gets an authorized url for an iframe src. sets params on the url and saves its
-     * origin to trust releasing user identity to it
-     */
     getAuthorizedEmbedUrl: (urlString: string, extraParams?: {
         [key: string]: string;
     }) => string;
-    /**
-     * gets second argument for `fetch` that has authentication token or cookie
-     */
-    getAuthorizedFetchConfig: () => Promise<FetchConfig>;
-    /**
-     * loads current user identity. does not reflect changes in identity after being called the first time.
-     */
-    getUser: () => Promise<User | undefined>;
-    /**
-     * updates user settings, for example the cookie consent preferences
-     */
-    updateUser: (updates: UpdatableUserFields) => Promise<{
-        user: ApiUser;
-        token: string | null;
-    }>;
+    updateUser: (updates: UpdatableUserFields) => Promise<UserData<ApiUser>>;
 };
+export declare const browserAuthProvider: <C extends string = "auth">({ window, configSpace }: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => BrowserAuthProvider;
 export {};

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

@@ -142,6 +142,7 @@ export const browserAuthProvider = ({ window, configSpace }) => (configProvider)
          * loads current user identity. does not reflect changes in identity after being called the first time.
          */
         getUser,
+        loadUserData: getUser,
         /**
          * updates user settings, for example the cookie consent preferences
          */

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

@@ -43,6 +43,7 @@ export type AuthProvider = {
      * gets second argument for `fetch` that has authentication token or cookie
      */
     getAuthorizedFetchConfig: () => Promise<FetchConfig>;
+    loadUserData: () => Promise<ApiUser | undefined>;
 };
 export type CookieAuthProviderRequest = {
     cookies?: string[];

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

@@ -1,11 +1,16 @@
 import cookie from 'cookie';
 import { tuple } from '../../misc/helpers';
 import { getHeader } from '../../routing/helpers';
-export const stubAuthProvider = (user) => ({
-    getAuthToken: () => Promise.resolve('authToken'),
-    getUser: () => Promise.resolve(user),
-    getAuthorizedFetchConfig: () => Promise.resolve(user ? { headers: { Authorization: user.uuid } } : {})
-});
+export const stubAuthProvider = (user) => {
+    const getUser = () => Promise.resolve(user);
+    return {
+        getAuthToken: () => Promise.resolve('authToken'),
+        getUser,
+        getAuthorizedFetchConfig: () => Promise.resolve(user ? { headers: { Authorization: user.uuid } } : {}),
+        // This is not technically correct, but most tests won't care
+        loadUserData: getUser
+    };
+};
 export const getAuthTokenOrCookie = (request, cookieName, queryKey = 'auth') => {
     var _a, _b;
     const authParam = request.queryStringParameters ? request.queryStringParameters[queryKey] : undefined;

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

@@ -29,15 +29,17 @@ export const subrequestAuthProvider = (initializer) => (configProvider) => {
             }
             return user;
         };
+        const getUser = async () => {
+            if (!user) {
+                user = await loadUser();
+            }
+            return user;
+        };
         return {
             getAuthToken,
             getAuthorizedFetchConfig,
-            getUser: async () => {
-                if (!user) {
-                    user = await loadUser();
-                }
-                return user;
-            }
+            getUser,
+            loadUserData: getUser
         };
     };
 };

package/dist/esm/services/authProvider/utils/embeddedAuthProvider.d.ts

@@ -1,7 +1,7 @@
 import { User } from '..';
 import { Window } from '../browser';
-export type UserData = {
-    user?: User;
+export type UserData<T = User> = {
+    user?: T;
     token: string | null;
 };
 type UserDataLoader = () => Promise<UserData>;

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

@@ -13,18 +13,6 @@ export declare const isFolderValue: (thing: any) => thing is FolderValue;
 export interface FileServerAdapter {
     putFileContent: (source: FileValue, content: string) => Promise<FileValue>;
     getSignedViewerUrl: (source: FileValue) => Promise<string>;
-    getPublicViewerUrl: (source: FileValue) => Promise<string>;
     getFileContent: (source: FileValue) => Promise<Buffer>;
-    getSignedFileUploadConfig: () => Promise<{
-        url: string;
-        payload: {
-            [key: string]: string;
-        };
-    }>;
-    copyFileTo: (source: FileValue, destinationPath: string) => Promise<FileValue>;
-    copyFileToDirectory: (source: FileValue, destinationDirectory: string) => Promise<FileValue>;
-    isTemporaryUpload: (source: FileValue) => boolean;
-    getFileChecksum: (source: FileValue) => Promise<string>;
-    filesEqual: (sourceA: FileValue, sourceB: FileValue) => Promise<boolean>;
 }
 export declare const isFileOrFolder: (thing: any) => thing is FileValue | FolderValue;

package/dist/esm/services/fileServer/localFileServer.js

@@ -1,18 +1,16 @@
 /* cspell:ignore originalname */
-import crypto from 'crypto';
 import fs from 'fs';
 import https from 'https';
 import path from 'path';
 import cors from 'cors';
 import express from 'express';
 import multer from 'multer';
-import { v4 as uuid } from 'uuid';
 import { assertString } from '../../assertions';
 import { resolveConfigValue } from '../../config';
 import { ifDefined } from '../../guards';
-import { memoize } from '../../misc/helpers';
+import { once } from '../../misc/helpers';
 /* istanbul ignore next */
-const startServer = memoize((port, uploadDir) => {
+const startServer = once((port, uploadDir) => {
     // TODO - re-evaluate the `preservePath` behavior to match whatever s3 does
     const upload = multer({ dest: uploadDir, preservePath: true });
     const fileServerApp = express();
@@ -57,9 +55,6 @@ export const localFileServer = (initializer) => (configProvider) => {
     const getSignedViewerUrl = async (source) => {
         return `https://${await host}:${await port}/${source.path}`;
     };
-    const getPublicViewerUrl = async (source) => {
-        return `https://${await host}:${await port}/${source.path}`;
-    };
     const getFileContent = async (source) => {
         const filePath = path.join(await fileDir, source.path);
         return fs.promises.readFile(filePath);
@@ -71,55 +66,9 @@ export const localFileServer = (initializer) => (configProvider) => {
         await fs.promises.writeFile(filePath, content);
         return source;
     };
-    const getSignedFileUploadConfig = async () => {
-        const prefix = 'uploads/' + uuid();
-        return {
-            url: `https://${await host}:${await port}/`,
-            payload: {
-                key: prefix + '/${filename}',
-            }
-        };
-    };
-    const copyFileTo = async (source, destinationPath) => {
-        const sourcePath = path.join(await fileDir, source.path);
-        const destPath = path.join(await fileDir, destinationPath);
-        const destDirectory = path.dirname(destPath);
-        await fs.promises.mkdir(destDirectory, { recursive: true });
-        await fs.promises.copyFile(sourcePath, destPath);
-        return {
-            ...source,
-            path: destinationPath
-        };
-    };
-    const copyFileToDirectory = async (source, destination) => {
-        const destinationPath = path.join(destination, source.label);
-        return copyFileTo(source, destinationPath);
-    };
-    const isTemporaryUpload = (source) => {
-        return source.path.indexOf('uploads/') === 0;
-    };
-    const getFileChecksum = async (source) => {
-        const filePath = path.join(await fileDir, source.path);
-        const fileContent = await fs.promises.readFile(filePath);
-        return crypto.createHash('md5').update(fileContent).digest('hex');
-    };
-    const filesEqual = async (sourceA, sourceB) => {
-        const [aSum, bSum] = await Promise.all([
-            getFileChecksum(sourceA),
-            getFileChecksum(sourceB)
-        ]);
-        return aSum === bSum;
-    };
     return {
         getSignedViewerUrl,
-        getPublicViewerUrl,
         getFileContent,
         putFileContent,
-        getSignedFileUploadConfig,
-        copyFileTo,
-        copyFileToDirectory,
-        isTemporaryUpload,
-        getFileChecksum,
-        filesEqual,
     };
 };

package/dist/esm/services/fileServer/s3FileServer.d.ts

@@ -4,7 +4,6 @@ import { FileServerAdapter } from '.';
 export type Config = {
     bucketName: string;
     bucketRegion: string;
-    publicViewerDomain?: string;
 };
 interface Initializer<C> {
     configSpace?: C;

package/dist/esm/services/fileServer/s3FileServer.js

@@ -1,9 +1,6 @@
 /* cspell:ignore presigner */
-import path from 'path';
-import { CopyObjectCommand, GetObjectCommand, HeadObjectCommand, PutObjectCommand, S3Client } from '@aws-sdk/client-s3';
-import { createPresignedPost } from '@aws-sdk/s3-presigned-post';
+import { GetObjectCommand, PutObjectCommand, S3Client } from '@aws-sdk/client-s3';
 import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
-import { v4 as uuid } from 'uuid';
 import { once } from '../..';
 import { assertDefined } from '../../assertions';
 import { resolveConfigValue } from '../../config';
@@ -12,9 +9,6 @@ export const s3FileServer = (initializer) => (configProvider) => {
     const config = configProvider[ifDefined(initializer.configSpace, 'deployed')];
     const bucketName = once(() => resolveConfigValue(config.bucketName));
     const bucketRegion = once(() => resolveConfigValue(config.bucketRegion));
-    const publicViewerDomain = once(() => 'publicViewerDomain' in config && config.publicViewerDomain
-        ? resolveConfigValue(config.publicViewerDomain)
-        : undefined);
     const s3Service = once(async () => {
         var _a, _b;
         const args = { apiVersion: '2012-08-10', region: await bucketRegion() };
@@ -30,10 +24,6 @@ export const s3FileServer = (initializer) => (configProvider) => {
             expiresIn: 3600, // 1 hour
         });
     };
-    const getPublicViewerUrl = async (source) => {
-        const host = assertDefined(await publicViewerDomain(), new Error(`Tried to get public viewer URL for ${source.path} but no publicViewerDomain configured`));
-        return `https://${host}/${source.path}`;
-    };
     const getFileContent = async (source) => {
         const bucket = await bucketName();
         const command = new GetObjectCommand({ Bucket: bucket, Key: source.path });
@@ -51,74 +41,9 @@ export const s3FileServer = (initializer) => (configProvider) => {
         await (await s3Service()).send(command);
         return source;
     };
-    /*
-     * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_s3_presigned_post.html
-     * https://docs.aws.amazon.com/AmazonS3/latest/userguide/HTTPPOSTExamples.html
-     * https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-post-example.html
-     */
-    const getSignedFileUploadConfig = async () => {
-        const prefix = 'uploads/' + uuid();
-        const bucket = (await bucketName());
-        const Conditions = [
-            { acl: 'private' },
-            { bucket },
-            ['starts-with', '$key', prefix]
-        ];
-        const defaultFields = {
-            acl: 'private',
-        };
-        const { url, fields } = await createPresignedPost(await s3Service(), {
-            Bucket: bucket,
-            Key: prefix + '/${filename}',
-            Conditions,
-            Fields: defaultFields,
-            Expires: 3600, // 1 hour
-        });
-        return {
-            url, payload: fields
-        };
-    };
-    const copyFileTo = async (source, destinationPath) => {
-        const bucket = (await bucketName());
-        const destinationPathWithoutLeadingSlash = destinationPath.replace(/^\//, '');
-        const command = new CopyObjectCommand({
-            Bucket: bucket,
-            Key: destinationPathWithoutLeadingSlash,
-            CopySource: path.join(bucket, source.path),
-        });
-        await (await s3Service()).send(command);
-        return {
-            ...source,
-            path: destinationPathWithoutLeadingSlash
-        };
-    };
-    const copyFileToDirectory = async (source, destination) => {
-        const destinationPath = path.join(destination, source.label);
-        return copyFileTo(source, destinationPath);
-    };
-    const isTemporaryUpload = (source) => {
-        return source.path.indexOf('uploads/') === 0;
-    };
-    const getFileChecksum = async (source) => {
-        const bucket = (await bucketName());
-        const command = new HeadObjectCommand({ Bucket: bucket, Key: source.path });
-        const response = await (await s3Service()).send(command);
-        return assertDefined(response.ETag);
-    };
-    const filesEqual = async (sourceA, sourceB) => {
-        const [aSum, bSum] = await Promise.all([getFileChecksum(sourceA), getFileChecksum(sourceB)]);
-        return aSum === bSum;
-    };
     return {
         getFileContent,
         putFileContent,
         getSignedViewerUrl,
-        getPublicViewerUrl,
-        getSignedFileUploadConfig,
-        copyFileTo,
-        copyFileToDirectory,
-        isTemporaryUpload,
-        getFileChecksum,
-        filesEqual,
     };
 };

package/dist/esm/services/launchParams/signer.d.ts

@@ -1,6 +1,6 @@
 import { JWK } from 'node-jose';
 import { ConfigProviderForConfig } from '../../config';
-import type { JsonCompatibleValue } from '../../routing';
+import type { JsonCompatibleStruct } from '../../routing';
 type Config = {
     alg: string;
     expiresIn: string;
@@ -17,7 +17,7 @@ export declare const createLaunchSigner: <C extends string = "launch">({ configS
     jwks: () => Promise<{
         keys: JWK.RawKey[];
     }>;
-    sign: (data: Record<string, JsonCompatibleValue>, subject: string, maxExp?: number | null) => Promise<string>;
+    sign: (data: JsonCompatibleStruct, subject: string, maxExp?: number | null) => Promise<string>;
 };
 export type LaunchSigner = ReturnType<ReturnType<typeof createLaunchSigner>>;
 export {};

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

@@ -26,6 +26,10 @@ export const openSearchService = (initializer = {}) => (configProvider) => {
         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 resolveConfigValue(config.node),
     }));
     return (indexConfig) => {
@@ -61,9 +65,6 @@ export const openSearchService = (initializer = {}) => (configProvider) => {
                 body: params.body,
                 id: params.id,
                 refresh: true
-            }, {
-                requestTimeout: 10000,
-                maxRetries: 1,
             });
         };
         const bulkIndex = async (items) => {
@@ -75,9 +76,6 @@ export const openSearchService = (initializer = {}) => (configProvider) => {
                     item.body
                 ]),
                 refresh: true
-            }, {
-                requestTimeout: 10000,
-                maxRetries: 1,
             });
         };
         const search = async (options) => {