codeforlife 2.9.0 → 2.9.1

package/dist/features/InactiveDialog.d.ts

@@ -0,0 +1,7 @@
+import { FC } from 'react';
+export interface InactiveDialogProps {
+    open: boolean;
+    onClose: () => void;
+}
+declare const InactiveDialog: FC<InactiveDialogProps>;
+export default InactiveDialog;

package/dist/features/ScreenTimeDialog.d.ts

@@ -0,0 +1,7 @@
+import { FC } from 'react';
+export interface ScreenTimeDialogProps {
+    open: boolean;
+    onClose: () => void;
+}
+declare const ScreenTimeDialog: FC<ScreenTimeDialogProps>;
+export default ScreenTimeDialog;

package/dist/features/index.d.ts

@@ -2,75 +2,3 @@ export * from './InactiveDialog';
 export { default as InactiveDialog } from './InactiveDialog';
 export * from './ScreenTimeDialog';
 export { default as ScreenTimeDialog } from './ScreenTimeDialog';
-
-
-declare module "@mui/material/styles" {
-    interface CustomPaletteColors {
-        tertiary: PaletteColor;
-        white: PaletteColor;
-        black: PaletteColor;
-        teacher: PaletteColor;
-        student: PaletteColor;
-        indy: PaletteColor;
-    }
-    interface Palette extends CustomPaletteColors {
-    }
-    interface PaletteOptions extends CustomPaletteColors {
-    }
-}
-
-
-declare module "@mui/material" {
-    interface FabPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface CardPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ChipPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface IconPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface AlertPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface BadgePropsColorOverrides extends PropsColorOverrides {
-    }
-    interface RadioPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface AppBarPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ButtonPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface SliderPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface SwitchPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface SvgIconPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface CheckboxPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface FormLabelPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface InputBasePropsColorOverrides extends PropsColorOverrides {
-    }
-    interface TextFieldPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface IconButtonPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface PaginationPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ButtonGroupPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface FormControlPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ToggleButtonPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface LinearProgressPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface PaginationItemPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface CircularProgressPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface TabsPropsIndicatorColorOverrides extends PropsColorOverrides {
-    }
-    interface ToggleButtonGroupPropsColorOverrides extends PropsColorOverrides {
-    }
-}

package/dist/hooks/api.d.ts

@@ -0,0 +1,15 @@
+import { Dispatch, SetStateAction } from 'react';
+export type Pagination = {
+    page: number;
+    limit: number;
+    offset: number;
+};
+export type SetPagination = Dispatch<SetStateAction<{
+    page: number;
+    limit: number;
+}>>;
+export type UsePaginationOptions = Partial<{
+    page: number;
+    limit: number;
+}>;
+export declare function usePagination(options?: UsePaginationOptions): [Pagination, SetPagination];

package/dist/hooks/auth.d.ts

@@ -0,0 +1,46 @@
+import { ReactNode, ReactPortal, ReactElement, JSXElementConstructor } from 'react';
+import { TypedUseMutation } from '@reduxjs/toolkit/query/react';
+import { AuthFactor, User } from '../api';
+import { OAuth2CodeChallenge, OAuth2CodeChallengeLengths, OAuth2RequestCodeUrlSearchParams } from '../utils/auth';
+import { ExchangeOAuth2CodeArg } from '../api/endpoints/session';
+export interface SessionMetadata {
+    user_id: User["id"];
+    user_type: "teacher" | "student" | "indy";
+    auth_factors: Array<AuthFactor["type"]>;
+    otp_bypass_token_exists: boolean;
+}
+export declare function useSessionMetadata<T = SessionMetadata>(cookieName?: string): T | undefined;
+export declare namespace useSessionMetadata {
+    var predefine: <SessionMetadata>(cookieName?: string) => () => SessionMetadata | undefined;
+}
+export type UseSessionChildrenFunction<Required extends boolean> = (metadata: Required extends true ? SessionMetadata : SessionMetadata | undefined) => ReactNode;
+export type UseSessionChildren<UserType extends SessionMetadata["user_type"] | undefined> = ReactNode | (UserType extends undefined ? UseSessionChildrenFunction<false> : UseSessionChildrenFunction<true>);
+export type UseSessionOptions<UserType extends SessionMetadata["user_type"] | undefined> = Partial<{
+    userType: UserType;
+    next: boolean;
+}>;
+export declare function useSession<UserType extends SessionMetadata["user_type"] | undefined = undefined>(children: UseSessionChildren<UserType>, options?: UseSessionOptions<UserType>): string | number | bigint | boolean | import("react/jsx-runtime").JSX.Element | Iterable<ReactNode> | Promise<string | number | bigint | boolean | ReactPortal | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null | undefined;
+export declare function useOAuth2State(provider: string, length?: number, storageKey?: string): [string | undefined, () => void];
+export declare function useOAuth2CodeChallenge(provider: string, length?: OAuth2CodeChallengeLengths, storageKey?: string): [OAuth2CodeChallenge | undefined, () => void];
+interface BaseUseOAuth2KwArgs<SessionMetadata> {
+    provider: string;
+    authUri: string;
+    clientId: string;
+    redirectUri: string;
+    scope: string;
+    responseType?: "code";
+    accessType?: "offline";
+    prompt?: string;
+    useLoginMutation: TypedUseMutation<SessionMetadata, ExchangeOAuth2CodeArg, any>;
+    onCreateSession: (result: SessionMetadata) => void;
+    onRetrieveSession: (metadata: SessionMetadata) => void;
+}
+interface UseOAuth2KwArgs<SessionMetadata> extends BaseUseOAuth2KwArgs<SessionMetadata> {
+    useSessionMetadata: () => SessionMetadata | undefined;
+}
+export type OAuth2 = [string, OAuth2RequestCodeUrlSearchParams] | [];
+export declare const useOAuth2: {
+    <SessionMetadata>(kwargs: UseOAuth2KwArgs<SessionMetadata>): OAuth2;
+    (kwargs: BaseUseOAuth2KwArgs<SessionMetadata>): OAuth2;
+};
+export {};

package/dist/hooks/form.d.ts

@@ -0,0 +1,8 @@
+import { RefObject } from 'react';
+/**
+ * Shorthand for a reference to a HTML input element since this is so common for
+ * forms.
+ *
+ * @returns Ref object to a HTML input element.
+ */
+export declare function useInputRef(): RefObject<HTMLInputElement | null>;

package/dist/hooks/general.d.ts

@@ -0,0 +1,13 @@
+import { DependencyList, Dispatch, SetStateAction } from 'react';
+export declare function useExternalScript<EventType extends keyof HTMLElementEventMap>({ props, attrs, eventTypes, }: {
+    props: Partial<HTMLScriptElement> & {
+        src: string;
+    };
+    attrs?: Record<string, string>;
+    eventTypes?: EventType[];
+}): EventType | undefined;
+export declare function useCountdown(seconds: number, interval?: number): [number, Dispatch<SetStateAction<number>>];
+export declare function useEventListener<EventType extends keyof HTMLElementEventMap>(element: HTMLElement, type: EventType, listener: (this: HTMLElement, ev: HTMLElementEventMap[EventType]) => any, kwArgs?: {
+    options?: boolean | AddEventListenerOptions;
+    deps?: DependencyList;
+}): void;

package/dist/hooks/index.d.ts

@@ -3,75 +3,3 @@ export * from './auth';
 export * from './form';
 export * from './general';
 export * from './router';
-
-
-declare module "@mui/material/styles" {
-    interface CustomPaletteColors {
-        tertiary: PaletteColor;
-        white: PaletteColor;
-        black: PaletteColor;
-        teacher: PaletteColor;
-        student: PaletteColor;
-        indy: PaletteColor;
-    }
-    interface Palette extends CustomPaletteColors {
-    }
-    interface PaletteOptions extends CustomPaletteColors {
-    }
-}
-
-
-declare module "@mui/material" {
-    interface FabPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface CardPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ChipPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface IconPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface AlertPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface BadgePropsColorOverrides extends PropsColorOverrides {
-    }
-    interface RadioPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface AppBarPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ButtonPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface SliderPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface SwitchPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface SvgIconPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface CheckboxPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface FormLabelPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface InputBasePropsColorOverrides extends PropsColorOverrides {
-    }
-    interface TextFieldPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface IconButtonPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface PaginationPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ButtonGroupPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface FormControlPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ToggleButtonPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface LinearProgressPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface PaginationItemPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface CircularProgressPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface TabsPropsIndicatorColorOverrides extends PropsColorOverrides {
-    }
-    interface ToggleButtonGroupPropsColorOverrides extends PropsColorOverrides {
-    }
-}

package/dist/hooks/router.d.ts

@@ -0,0 +1,29 @@
+import { Location, Params, To, NavigateOptions as _NavigateOptions } from 'react-router-dom';
+import { ObjectShape } from 'yup';
+import { ReactNode, ReactPortal, ReactElement, JSXElementConstructor } from 'react';
+import { ObjectSchemaFromShape, TryValidateSyncOnErrorRT, TryValidateSyncOptions, TryValidateSyncRT } from '../utils/schema';
+import { PageState } from '../components/page';
+import { ReadOnly } from '../utils/router';
+export type NavigateOptions<State extends Record<string, any> = Record<string, any>> = Omit<_NavigateOptions, "state"> & {
+    state?: State & Partial<PageState>;
+    next?: boolean;
+};
+export type Navigate = {
+    <State extends Record<string, any> = Record<string, any>>(to: To, options?: NavigateOptions<State>): void;
+    (delta: number): void;
+};
+export declare function useNavigate(): Navigate;
+export declare function useLocation<State = {}>(): Location<null | Partial<PageState & State>>;
+export declare function useSearchParams(): {
+    [k: string]: string;
+};
+export declare function useSearchParams<OnErrorRT extends TryValidateSyncOnErrorRT<ObjectSchemaFromShape<Shape>>, Shape extends ObjectShape = {}>(shape: Shape, validateOptions?: TryValidateSyncOptions<ObjectSchemaFromShape<Shape>, OnErrorRT>): TryValidateSyncRT<ObjectSchemaFromShape<Shape>, OnErrorRT>;
+export declare function useParams(): ReadOnly<Params<string>>;
+export declare function useParams<OnErrorRT extends TryValidateSyncOnErrorRT<ObjectSchemaFromShape<Shape>>, Shape extends ObjectShape = {}>(shape: Shape, validateOptions?: TryValidateSyncOptions<ObjectSchemaFromShape<Shape>, OnErrorRT>): TryValidateSyncRT<ObjectSchemaFromShape<Shape>, OnErrorRT>;
+export declare function useParamsRequired<OnErrorRT extends TryValidateSyncOnErrorRT<ObjectSchemaFromShape<Shape>>, Shape extends ObjectShape = {}>({ shape, children, onValidationError, onValidationSuccess, validateOptions, }: {
+    shape: Shape;
+    children: (data: NonNullable<TryValidateSyncRT<ObjectSchemaFromShape<Shape>, OnErrorRT>>) => ReactNode;
+    onValidationError: (navigate: Navigate) => void;
+    onValidationSuccess?: (params: NonNullable<TryValidateSyncRT<ObjectSchemaFromShape<Shape>, OnErrorRT>>) => void;
+    validateOptions?: TryValidateSyncOptions<ObjectSchemaFromShape<Shape>, OnErrorRT>;
+}): string | number | bigint | boolean | import("react/jsx-runtime").JSX.Element | Iterable<ReactNode> | Promise<string | number | bigint | boolean | ReactPortal | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null | undefined;

package/dist/index.d.ts

@@ -1,78 +1,2 @@
-import { ThemeOptions } from '@mui/material';
-
-declare const components: ThemeOptions["components"];
-export default components;
-
-export { }
-
-
-declare module "@mui/material/styles" {
-    interface CustomPaletteColors {
-        tertiary: PaletteColor;
-        white: PaletteColor;
-        black: PaletteColor;
-        teacher: PaletteColor;
-        student: PaletteColor;
-        indy: PaletteColor;
-    }
-    interface Palette extends CustomPaletteColors {
-    }
-    interface PaletteOptions extends CustomPaletteColors {
-    }
-}
-
-
-declare module "@mui/material" {
-    interface FabPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface CardPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ChipPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface IconPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface AlertPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface BadgePropsColorOverrides extends PropsColorOverrides {
-    }
-    interface RadioPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface AppBarPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ButtonPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface SliderPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface SwitchPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface SvgIconPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface CheckboxPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface FormLabelPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface InputBasePropsColorOverrides extends PropsColorOverrides {
-    }
-    interface TextFieldPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface IconButtonPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface PaginationPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ButtonGroupPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface FormControlPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ToggleButtonPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface LinearProgressPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface PaginationItemPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface CircularProgressPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface TabsPropsIndicatorColorOverrides extends PropsColorOverrides {
-    }
-    interface ToggleButtonGroupPropsColorOverrides extends PropsColorOverrides {
-    }
-}
+export * from './theme';
+export { default as theme } from './theme';

package/dist/middlewares/index.d.ts

@@ -1,73 +1 @@
 export * from './session';
-
-
-declare module "@mui/material/styles" {
-    interface CustomPaletteColors {
-        tertiary: PaletteColor;
-        white: PaletteColor;
-        black: PaletteColor;
-        teacher: PaletteColor;
-        student: PaletteColor;
-        indy: PaletteColor;
-    }
-    interface Palette extends CustomPaletteColors {
-    }
-    interface PaletteOptions extends CustomPaletteColors {
-    }
-}
-
-
-declare module "@mui/material" {
-    interface FabPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface CardPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ChipPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface IconPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface AlertPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface BadgePropsColorOverrides extends PropsColorOverrides {
-    }
-    interface RadioPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface AppBarPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ButtonPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface SliderPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface SwitchPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface SvgIconPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface CheckboxPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface FormLabelPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface InputBasePropsColorOverrides extends PropsColorOverrides {
-    }
-    interface TextFieldPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface IconButtonPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface PaginationPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ButtonGroupPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface FormControlPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ToggleButtonPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface LinearProgressPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface PaginationItemPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface CircularProgressPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface TabsPropsIndicatorColorOverrides extends PropsColorOverrides {
-    }
-    interface ToggleButtonGroupPropsColorOverrides extends PropsColorOverrides {
-    }
-}

package/dist/middlewares/session.d.ts

@@ -0,0 +1,2 @@
+import { Middleware } from '@reduxjs/toolkit';
+export declare const logoutMiddleware: Middleware;

package/dist/server.d.ts

@@ -1,129 +1,44 @@
-import { CacheClass } from 'memory-cache';
-import { Express as Express_2 } from 'express';
-import { Request as Request_2 } from 'express';
-import { Response as Response_2 } from 'express';
-
-declare type GetRenderAndTemplate = (path: string) => Promise<RenderAndTemplate>;
-
-declare type HealthCheck = {
-    healthStatus: HealthStatus;
-    additionalInfo: string;
-    details?: Array<{
-        name: string;
-        description: string;
-        health: HealthStatus;
-    }>;
-};
-
-declare type HealthStatus = "healthy" | "startingUp" | "shuttingDown" | "unhealthy" | "unknown";
-
-declare type Mode = "development" | "staging" | "production";
-
-declare type OnServeError = (error: Error) => string | undefined;
-
-declare type Options = Partial<{
-    mode: Mode;
-    port: number;
-    base: string;
-}>;
-
-declare type Render = (path: string) => Promise<{
-    head?: string;
-    html?: string;
-}>;
-
-declare type RenderAndTemplate = [Render, string];
-
-declare class Server {
-    envIsProduction: boolean;
-    templateHtml: string;
-    hostname: string;
-    mode: Mode;
-    port: number;
-    base: string;
-    app: Express_2;
-    cache: CacheClass<string, any>;
-    healthCheckCacheKey: string;
-    healthCheckCacheTimeout: number;
-    healthCheckStatusCodes: Record<HealthStatus, number>;
-    constructor({ mode, port, base }?: Options);
-    getHealthCheck(request: Request_2): HealthCheck;
-    handleHealthCheck(request: Request_2, response: Response_2): void;
-    handleServeHtml(request: Request_2, response: Response_2, getRenderAndTemplate: GetRenderAndTemplate, onServeError: OnServeError): Promise<void>;
-    run(): Promise<void>;
-}
-export default Server;
-
-export { }
-
-
-declare module "@mui/material/styles" {
-    interface CustomPaletteColors {
-        tertiary: PaletteColor;
-        white: PaletteColor;
-        black: PaletteColor;
-        teacher: PaletteColor;
-        student: PaletteColor;
-        indy: PaletteColor;
-    }
-    interface Palette extends CustomPaletteColors {
-    }
-    interface PaletteOptions extends CustomPaletteColors {
-    }
-}
-
-
-declare module "@mui/material" {
-    interface FabPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface CardPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ChipPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface IconPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface AlertPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface BadgePropsColorOverrides extends PropsColorOverrides {
-    }
-    interface RadioPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface AppBarPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ButtonPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface SliderPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface SwitchPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface SvgIconPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface CheckboxPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface FormLabelPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface InputBasePropsColorOverrides extends PropsColorOverrides {
-    }
-    interface TextFieldPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface IconButtonPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface PaginationPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ButtonGroupPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface FormControlPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface ToggleButtonPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface LinearProgressPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface PaginationItemPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface CircularProgressPropsColorOverrides extends PropsColorOverrides {
-    }
-    interface TabsPropsIndicatorColorOverrides extends PropsColorOverrides {
-    }
-    interface ToggleButtonGroupPropsColorOverrides extends PropsColorOverrides {
-    }
+import { CacheClass } from 'memory-cache';
+import { Express, Request, Response } from 'express';
+type Mode = "development" | "staging" | "production";
+type Options = Partial<{
+    mode: Mode;
+    port: number;
+    base: string;
+}>;
+type HealthStatus = "healthy" | "startingUp" | "shuttingDown" | "unhealthy" | "unknown";
+type HealthCheck = {
+    healthStatus: HealthStatus;
+    additionalInfo: string;
+    details?: Array<{
+        name: string;
+        description: string;
+        health: HealthStatus;
+    }>;
+};
+type Render = (path: string) => Promise<{
+    head?: string;
+    html?: string;
+}>;
+type RenderAndTemplate = [Render, string];
+type GetRenderAndTemplate = (path: string) => Promise<RenderAndTemplate>;
+type OnServeError = (error: Error) => string | undefined;
+export default class Server {
+    envIsProduction: boolean;
+    templateHtml: string;
+    hostname: string;
+    mode: Mode;
+    port: number;
+    base: string;
+    app: Express;
+    cache: CacheClass<string, any>;
+    healthCheckCacheKey: string;
+    healthCheckCacheTimeout: number;
+    healthCheckStatusCodes: Record<HealthStatus, number>;
+    constructor({ mode, port, base }?: Options);
+    getHealthCheck(request: Request): HealthCheck;
+    handleHealthCheck(request: Request, response: Response): void;
+    handleServeHtml(request: Request, response: Response, getRenderAndTemplate: GetRenderAndTemplate, onServeError: OnServeError): Promise<void>;
+    run(): Promise<void>;
 }
+export {};

package/dist/settings/custom.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file contains all of our custom settings we define for our own purposes.
+ *
+ * This file is based on:
+ * https://github.com/ocadotechnology/codeforlife-package-python/blob/main/codeforlife/settings/custom.py
+ */
+export declare const SERVICE_NAME: string;
+export declare const SERVICE_API_URL: string;
+export declare const CSRF_COOKIE_NAME: string;
+export declare const SESSION_COOKIE_NAME: string;
+export declare const SESSION_METADATA_COOKIE_NAME: string;