@openstax/ts-utils 1.31.2 → 1.32.1

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

@@ -25,6 +25,20 @@ 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
@@ -140,7 +154,9 @@ export declare const makeCreateRoute: <Sa, Ri, Ex = {}>() => CreateRoute<Sa, Ri,
  */
 export declare const makeRenderRouteUrl: <Ru extends {
     path: string;
-}>() => <R extends Ru>(route: R, params: ParamsForRoute<R>, query?: QueryParams) => string;
+}>() => <R>(route: ExternalRoute<R> extends Ru ? R & {
+    path: string;
+} : R extends Ru ? R : never, params: ParamsForRoute<R>, query?: QueryParams) => string;
 /**
  * A pre-made result from `makeRenderRouteUrl`, this function interpolates parameter and query
  * arguments into a route path.
@@ -153,7 +169,9 @@ 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 extends any>(route: R, params: ParamsForRoute<R>, query?: QueryParams) => string;
+export declare const renderAnyRouteUrl: <R>(route: ExternalRoute<R> extends any ? R & {
+    path: string;
+} : R extends any ? R : never, 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,6 +2,14 @@ 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/authProvider/browser.d.ts

@@ -1,6 +1,6 @@
 import { ConfigProviderForConfig } from '../../config';
 import { FetchConfig, GenericFetch } from '../../fetch';
-import { User } from '.';
+import { ApiUser, User } from '.';
 type Config = {
     accountsBase: string;
 };
@@ -26,7 +26,7 @@ export interface Window {
     addEventListener: (event: 'message', callback: EventHandler) => void;
     removeEventListener: (event: 'message', callback: EventHandler) => void;
 }
-export type UpdatableUserFields = Partial<Pick<User, 'consent_preferences' | 'first_name' | 'last_name'>>;
+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
@@ -65,7 +65,7 @@ export declare const browserAuthProvider: <C extends string = "auth">({ window,
      * updates user settings, for example the cookie consent preferences
      */
     updateUser: (updates: UpdatableUserFields) => Promise<{
-        user: User;
+        user: ApiUser;
         token: string | null;
     }>;
 };

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

@@ -1,15 +1,19 @@
 import type { ConfigProviderForConfig } from '../../config';
-import { AuthProvider, CookieAuthProvider } from '.';
+import { GenericFetch } from '../../fetch';
+import { ApiUser, AuthProvider, CookieAuthProvider } from '.';
 type Config = {
+    accountsBase: string;
     cookieName: string;
     encryptionPrivateKey: string;
     signaturePublicKey: string;
 };
 interface Initializer<C> {
     configSpace?: C;
+    fetch: GenericFetch;
 }
 export type DecryptionAuthProvider = AuthProvider & {
     getTokenExpiration: (tokenString?: string) => Promise<number | null | undefined>;
+    loadUserData: () => Promise<ApiUser | undefined>;
 };
 export declare const decryptionAuthProvider: <C extends string = "decryption">(initializer: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => CookieAuthProvider<DecryptionAuthProvider>;
 export {};

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

@@ -3,14 +3,17 @@ import { SessionExpiredError } from '../../errors';
 import { ifDefined } from '../../guards';
 import { once } from '../../misc/helpers';
 import { decryptAndVerify } from './utils/decryptAndVerify';
+import { loadUserData } from './utils/userSubrequest';
 import { getAuthTokenOrCookie } from '.';
 export const decryptionAuthProvider = (initializer) => (configProvider) => {
     const config = configProvider[ifDefined(initializer.configSpace, 'decryption')];
+    const accountsBase = once(() => resolveConfigValue(config.accountsBase));
     const cookieName = once(() => resolveConfigValue(config.cookieName));
     const encryptionPrivateKey = once(() => resolveConfigValue(config.encryptionPrivateKey));
     const signaturePublicKey = once(() => resolveConfigValue(config.signaturePublicKey));
     return ({ request, logger }) => {
         let user;
+        let userData;
         const getAuthToken = async () => getAuthTokenOrCookie(request, await cookieName())[0];
         const getAuthorizedFetchConfig = async () => {
             const [token, headers] = getAuthTokenOrCookie(request, await cookieName());
@@ -19,40 +22,47 @@ export const decryptionAuthProvider = (initializer) => (configProvider) => {
             }
             return { headers };
         };
-        const getPayload = async (tokenString) => {
+        const getDecryptedPayload = async (tokenString) => {
             const token = tokenString !== null && tokenString !== void 0 ? tokenString : await getAuthToken();
             if (!token) {
                 return undefined;
             }
             return decryptAndVerify(token, await encryptionPrivateKey(), await signaturePublicKey());
         };
-        const loadUser = async () => {
-            const result = await getPayload();
-            if (!result) {
-                return undefined;
-            }
-            if ('error' in result && result.error == 'expired token') {
-                throw new SessionExpiredError();
-            }
-            if ('user' in result) {
-                logger.setContext({ user: result.user.uuid });
-                return result.user;
+        const getUser = async () => {
+            if (!user) {
+                const result = await getDecryptedPayload();
+                if (!result) {
+                    return undefined;
+                }
+                if ('error' in result && result.error == 'expired token') {
+                    throw new SessionExpiredError();
+                }
+                if ('user' in result) {
+                    logger.setContext({ user: result.user.uuid });
+                    user = result.user;
+                }
             }
-            return undefined;
+            return user;
         };
         return {
             getAuthToken,
             getAuthorizedFetchConfig,
             getTokenExpiration: async (tokenString) => {
                 var _a;
-                const payload = await getPayload(tokenString);
+                const payload = await getDecryptedPayload(tokenString);
                 return payload ? ((_a = payload.exp) !== null && _a !== void 0 ? _a : null) : undefined;
             },
-            getUser: async () => {
-                if (!user) {
-                    user = await loadUser();
+            getUser,
+            loadUserData: async () => {
+                if (!userData) {
+                    const token = await getAuthToken();
+                    if (!token) {
+                        return undefined;
+                    }
+                    userData = await loadUserData(initializer.fetch, await accountsBase(), await cookieName(), token);
                 }
-                return user;
+                return userData;
             },
         };
     };

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

@@ -10,14 +10,14 @@ export type ConsentPreferences = {
 export type TokenUser = {
     id: number;
     name: string;
+    uuid: string;
+    faculty_status: string;
+    is_admin: boolean;
+};
+export type ApiUser = TokenUser & {
     first_name: string;
     last_name: string;
     full_name: string;
-    uuid: string;
-    faculty_status: string;
-    is_administrator: boolean;
-} & Partial<ConsentPreferences>;
-export interface ApiUser extends TokenUser {
     contact_infos: Array<{
         type: string;
         value: string;
@@ -34,7 +34,7 @@ export interface ApiUser extends TokenUser {
     self_reported_role: string;
     signed_contract_names: string[];
     using_openstax: boolean;
-}
+} & Partial<ConsentPreferences>;
 export type User = TokenUser | ApiUser;
 export type AuthProvider = {
     getAuthToken: () => Promise<string | null>;

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

@@ -2,8 +2,8 @@ import { ConfigProviderForConfig } from '../../config';
 import { GenericFetch } from '../../fetch';
 import { CookieAuthProvider } from '.';
 type Config = {
-    cookieName: string;
     accountsBase: string;
+    cookieName: string;
 };
 interface Initializer<C> {
     configSpace?: C;

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

@@ -1,7 +1,7 @@
-import cookie from 'cookie';
 import { once } from '../..';
 import { resolveConfigValue } from '../../config';
 import { ifDefined } from '../../guards';
+import { loadUserData } from './utils/userSubrequest';
 import { getAuthTokenOrCookie } from '.';
 export const subrequestAuthProvider = (initializer) => (configProvider) => {
     const config = configProvider[ifDefined(initializer.configSpace, 'subrequest')];
@@ -23,9 +23,7 @@ export const subrequestAuthProvider = (initializer) => (configProvider) => {
             if (!token) {
                 return undefined;
             }
-            const headers = { cookie: cookie.serialize(resolvedCookieName, token) };
-            const user = await initializer.fetch((await accountsBase()).replace(/\/+$/, '') + '/api/user', { headers })
-                .then(response => response.json());
+            const user = await loadUserData(initializer.fetch, await accountsBase(), resolvedCookieName, token);
             if (user) {
                 logger.setContext({ user: user.uuid });
             }

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

@@ -0,0 +1,3 @@
+import { ApiUser } from '..';
+import { GenericFetch } from '../../../fetch';
+export declare const loadUserData: (fetch: GenericFetch, accountsBase: string, cookieName: string, token: string) => Promise<ApiUser | undefined>;

package/dist/esm/services/authProvider/utils/userSubrequest.js

@@ -0,0 +1,6 @@
+import cookie from 'cookie';
+export const loadUserData = (fetch, accountsBase, cookieName, token) => {
+    const headers = { cookie: cookie.serialize(cookieName, token) };
+    return fetch(accountsBase.replace(/\/+$/, '') + '/api/user', { headers })
+        .then(response => response.json());
+};

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

@@ -1,8 +1,8 @@
 /* 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 { getSignedUrl } from '@aws-sdk/s3-request-presigner';
-import path from 'path';
 import { v4 as uuid } from 'uuid';
 import { once } from '../..';
 import { assertDefined } from '../../assertions';