@openstax/ts-utils 1.2.8 → 1.3.0

package/dist/esm/misc/partitionSequence.d.ts

@@ -1,3 +1,34 @@
+/**
+ * partitions a sequence based on a partition function returning {value: any; matches?: boolean}
+ *  - if the function returns `matches` explicitly then adjacent matching elements will
+ *    be grouped and the predicate value in the result will be from the last item in the group
+ *  - if the function returns only a value then matching will be evaluated based on the deep
+ *    equality of the value with its neighbors
+ *
+ * this is different from lodash/partition and lodash/groupBy because:
+ *  - it preserves the order of the items, items will only be grouped if they are already adjacent
+ *  - there can be any number of groups
+ *  - it tells you the partition value
+ *  - the partition value can be reduced, if you care (so you can like, partition on sequential values)
+ *
+ *  simple predicate:
+ *    returns: [[0, [1,2]], [1, [3,4,5]]]
+ *    partitionSequence((n: number) => ({value: Math.floor(n / 3)}), [1,2,3,4,5])
+ *
+ *  mutating partition:
+ *    returns: [
+ *      [{min: 1,max: 3}, [1,2,3]],
+ *      [{min: 5,max: 6}, [5,6]],
+ *      [{min: 8,max: 8}, [8]],
+ *    ]
+ *    partitionSequence(
+ *      (n: number, p?: {min: number; max: number}) =>
+ *        p && p.max + 1 === n
+ *          ? {value: {...p, max: n}, matches: true}
+ *          : {value: {min: n, max: n}, matches: false}
+ *      , [1,2,3,5,6,8]
+ *    )
+ */
 export declare const partitionSequence: <T, P>(getPartition: (thing: T, previous?: P | undefined) => {
     matches?: boolean | undefined;
     value: P;

package/dist/esm/misc/partitionSequence.js

@@ -1,5 +1,5 @@
 import deepEqual from 'deep-equal';
-/*
+/**
  * partitions a sequence based on a partition function returning {value: any; matches?: boolean}
  *  - if the function returns `matches` explicitly then adjacent matching elements will
  *    be grouped and the predicate value in the result will be from the last item in the group

package/dist/esm/pagination.d.ts

@@ -2,6 +2,26 @@ import { QueryParams, RouteMatchRecord } from './routing';
 export declare type PaginationHandler<Pa, Q extends QueryParams> = <R>(queryParams: Q, match: RouteMatchRecord<R>) => Pa & {
     getUnusedQueryParams: () => Q;
 };
+/**
+ * helper to create middleware with the given paginator. aside from taking care of annoying to write pagination logic, these helpers also make
+ * sure that all item list responses have the same formatting.
+ *
+ * eg:
+ *   const getQueryParams = getKeyValueOr('queryStringParameters', {} as QueryParams);
+ *   const setUnusedQueryParams = putKeyValue('queryStringParameters');
+ *
+ *   export const loadMorePaginationMiddleware = createPaginationMiddleware<ApiRouteRequest>()({getQueryParams, setUnusedQueryParams, paginator: loadMorePagination});
+ *   export const pageNumberPaginationMiddleware = createPaginationMiddleware<ApiRouteRequest>()({getQueryParams, setUnusedQueryParams, paginator: pageNumberPagination});
+ *
+ * eg the pagination middleware then provides your necessary inputs (getPageToken... in this case) and formats the response:
+ *  const result = await services.myDocumentStore.getVersions(key, services.pagination.getPageTokenNumber());
+ *
+ *  if (!result) {
+ *    throw new NotFoundError('requested item not found');
+ *  }
+ *
+ *  return apiJsonResponse(200, services.pagination.getPaginationResponse(result));
+ */
 export declare const createPaginationMiddleware: <Ri, Q extends QueryParams = {
     [key: string]: string | undefined;
 }, R = any>() => <Pa>({ getQueryParams, setUnusedQueryParams, paginator }: {
@@ -29,6 +49,10 @@ export declare const loadMorePagination: <R, Q extends QueryParams>(queryParams:
         };
     };
 };
+/**
+ * if you're writing a data loader, this is what you need to return to be compatible with the loadMore style paginator.
+ * this is how the response formatter knows the token for the next page to put in the response metadata.
+ * */
 export interface LoadMorePaginationResultInput<T> {
     items: T[];
     nextPageToken: string | number | undefined;
@@ -54,6 +78,10 @@ export declare const pageNumberPagination: <R, Q extends QueryParams>(queryParam
         };
     };
 };
+/**
+ * if you're writing a data loader, this is what you need to return to be compatible with the pageNumber style paginator.
+ * this is how the response formatter knows the information to put in the response metadata.
+ * */
 export interface PageNumberPaginationResultInput<T> {
     items: T[];
     pageSize: number;

package/dist/esm/pagination.js

@@ -1,7 +1,7 @@
 import { notNaN } from './assertions';
 import { InvalidRequestError } from './errors';
 import { renderAnyRouteUrl } from './routing';
-/*
+/**
  * helper to create middleware with the given paginator. aside from taking care of annoying to write pagination logic, these helpers also make
  * sure that all item list responses have the same formatting.
  *

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

@@ -1,10 +1,55 @@
 import type { HttpHeaders } from '.';
+/**
+ * Get the value of a header, case insensitive; note if there are multiple headers of the same
+ * value, this only returns the first value
+ *
+ * @param headers
+ * @param name the name of the header, case ignored
+ */
 export declare const getHeader: (headers: HttpHeaders, name: string) => string | undefined;
+/**
+ * Gets the body of a request
+ * @param request
+ * @throws InvalidRequestError if the content type is not application/json or not parsable
+ */
 export declare const getRequestBody: (request: {
     headers: HttpHeaders;
     body?: string | undefined;
 }) => any;
+/**
+ * stub validator because writing validators is annoying
+ */
 export declare const unsafePayloadValidator: <T>() => (input: any) => input is T;
+/**
+ * Middleware that validates the request payload and adds it to the middleware (with key `payload`)
+ * so it can be accessed downstream.
+ *
+ * This middleware accomplishes a few things:
+ *   - establishes type of payload for route body logic
+ *   - validates the payload for route logic
+ *   - establishes type of payload for client logic calling this route
+ *
+ * @param validator a guard function that takes the request payload and returns true if it is valid,
+ * narrowing the type of the payload to the correct type
+ * @throws InvalidRequestError if the payload is not valid
+ *
+ * @example
+ * export const exampleRoute = createRoute({
+ *   name: 'exampleRoute', method: METHOD.POST, path: '/example/:id',
+ *   requestServiceProvider: composeServiceMiddleware(
+ *     // here we are adding to previously composed middleware
+ *     requestServiceProvider,
+ *     requestPayloadProvider(validatePayload)
+ *   )},
+ *   async(params: {id: string}, services) => {
+ *     const result = await services.myDocumentStore.putItem({
+ *       ...services.payload,
+ *       id: params.id,
+ *     });
+ *     return apiJsonResponse(201, result);
+ *   }
+ * );
+ */
 export declare const requestPayloadProvider: <T>(validator: (input: any) => input is T) => () => <M extends {
     request: Parameters<typeof getRequestBody>[0];
 }>(requestServices: M) => M & {

package/dist/esm/routing/helpers.js

@@ -1,8 +1,13 @@
 import { assertErrorInstanceOf } from '../assertions';
 import { InvalidRequestError } from '../errors';
 import { isPlainObject } from '../guards';
-// use this to support case insensitive header keys
-// note if there are multiple headers of the same value, this only returns the first value
+/**
+ * Get the value of a header, case insensitive; note if there are multiple headers of the same
+ * value, this only returns the first value
+ *
+ * @param headers
+ * @param name the name of the header, case ignored
+ */
 export const getHeader = (headers, name) => {
     const key = Object.keys(headers).find(header => header.toLowerCase() === name.toLowerCase());
     const value = key ? headers[key] : undefined;
@@ -10,6 +15,11 @@ export const getHeader = (headers, name) => {
         ? value[0]
         : value;
 };
+/**
+ * Gets the body of a request
+ * @param request
+ * @throws InvalidRequestError if the content type is not application/json or not parsable
+ */
 export const getRequestBody = (request) => {
     if (getHeader(request.headers, 'content-type') !== 'application/json') {
         throw new InvalidRequestError('unknown content type: ' + getHeader(request.headers, 'content-type'));
@@ -27,34 +37,42 @@ export const getRequestBody = (request) => {
     }
 };
 /* utils and middleware for loading request payload (must follow this pattern for `PayloadForRoute` to work) */
-// stub validator because writing validators is annoying
+/**
+ * stub validator because writing validators is annoying
+ */
 export const unsafePayloadValidator = () => (input) => {
     return isPlainObject(input) && Object.keys(input).length > 0;
 };
-/*
- * the given validator is a guard, which provides the correct type this helper loads the body, runs the validator, throws if it isn't valid, or returns it as
- * the correct type if it is valid.
+/**
+ * Middleware that validates the request payload and adds it to the middleware (with key `payload`)
+ * so it can be accessed downstream.
  *
- * this accomplishes a few things:
+ * This middleware accomplishes a few things:
  *   - establishes type of payload for route body logic
  *   - validates the payload for route logic
  *   - establishes type of payload for client logic calling this route
  *
- * eg:
- *   export const exampleRoute = createRoute({name: 'exampleRoute', method: METHOD.POST, path: '/example/:id',
- *     requestServiceProvider: composeServiceMiddleware(
- *       requestServiceProvider, // previously compiled middleware can be re-composed if you have something to add
- *       requestPayloadProvider(validatePayload)
- *     )},
- *     async(params: {id: string}, services) => {
- *       const result = await services.myDocumentStore.putItem({
- *         ...services.payload,
- *         id: params.id,
- *       });
- *       return apiJsonResponse(201, result);
- *     }
- *   );
- * */
+ * @param validator a guard function that takes the request payload and returns true if it is valid,
+ * narrowing the type of the payload to the correct type
+ * @throws InvalidRequestError if the payload is not valid
+ *
+ * @example
+ * export const exampleRoute = createRoute({
+ *   name: 'exampleRoute', method: METHOD.POST, path: '/example/:id',
+ *   requestServiceProvider: composeServiceMiddleware(
+ *     // here we are adding to previously composed middleware
+ *     requestServiceProvider,
+ *     requestPayloadProvider(validatePayload)
+ *   )},
+ *   async(params: {id: string}, services) => {
+ *     const result = await services.myDocumentStore.putItem({
+ *       ...services.payload,
+ *       id: params.id,
+ *     });
+ *     return apiJsonResponse(201, result);
+ *   }
+ * );
+ */
 export const requestPayloadProvider = (validator) => () => (requestServices) => {
     const payload = getRequestBody(requestServices.request);
     // for more precise error messages, throw your own InvalidRequestError from your validator function

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

@@ -1,19 +1,35 @@
 import { Track } from '../profile';
 import { Logger } from '../services/logger';
+/** HTTP query parameters */
 export declare type QueryParams = Record<string, string | undefined | string[] | null>;
+/**
+ * The type for a map of string substitutions to use when building route paths, e.g. a route may
+ * be defined as `'/api/:id'` and then rendered as `'/api/123'` when the `id` route param is set
+ * to `'123'`
+ */
 export declare type RouteParams = {
     [key: string]: string;
 };
+/** A type that is compatible with any `Route` type */
 export declare type AnyRoute<R> = R extends Route<infer N, infer P, infer Sa, infer Sr, infer Ri, infer Ro> ? Route<N, P, Sa, Sr, Ri, Ro> : never;
 export declare type AnySpecificRoute<R, Sa, Ri, Ro> = R extends Route<infer N, infer P, Sa, infer Sr, Ri, Ro> & infer E ? Route<N, P, Sa, Sr, Ri, Ro> & E : never;
+/** The inferred "route output" (`Ro`) type for a given route */
 export declare type OutputForRoute<R> = R extends Route<any, any, any, any, any, infer Ro> ? Ro : never;
+/** The inferred type for the params of the provided route type, `R`; may be undefined */
 export declare type ParamsForRoute<R> = R extends Route<any, infer P, any, any, any, any> ? P : never;
+/** The inferred type for the request services of the provided route type, `R`. */
 export declare type RequestServicesForRoute<R> = R extends Route<any, any, any, infer Sr, any, any> ? Sr : never;
+/** The type for the params of the provided route type, `R`; will be `{}` if undefined */
 export declare type ParamsForRouteOrEmpty<R> = ParamsForRoute<R> extends undefined ? {} : Exclude<ParamsForRoute<R>, undefined>;
+/** derives the route match type for this route, which includes the route itself and the matching params. */
 export declare type RouteMatchRecord<R> = R extends AnyRoute<R> ? {
     route: R;
     params: ParamsForRoute<R>;
 } : never;
+/**
+ * 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
+ */
 export declare type PayloadForRoute<R> = RequestServicesForRoute<R> extends {
     payload: any;
 } ? RequestServicesForRoute<R>['payload'] : undefined;
@@ -40,16 +56,105 @@ declare type CreateRouteConfig<Sa, Sr, Ri, N extends string, Ex> = (Sr extends u
     name: N;
     path: string;
 } & Ex;
+/**
+ * Interface for a function that creates a route. There are two overloaded signatures, because
+ * sometimes typescript can't figure out the value of `Sr` between the handler and the service
+ * provider. Forcing it through the provider types first by putting the handler in a subsequent
+ * argument seems to help.
+ */
 export interface CreateRoute<Sa, Ri, Ex> {
     <N extends string, Ro, Sr extends unknown | undefined = undefined, P extends RouteParams | undefined = undefined>(config: CreateRouteConfig<Sa, Sr, Ri, N, Ex> & {
         handler: RouteHandler<P, Sr, Ro>;
     }): Route<N, P, Sa, Sr, Ri, Ro> & Ex;
     <N extends string, Ro, Sr extends unknown | undefined, P extends RouteParams | undefined = undefined>(config: CreateRouteConfig<Sa, Sr, Ri, N, Ex>, handler: RouteHandler<P, Sr, Ro>): Route<N, P, Sa, Sr, Ri, Ro> & Ex;
 }
+/**
+ * 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
+ * set the types for the resulting `createRoute` function -- that latter function is called once
+ * per route. E.g. for the backend, the call could look like:
+ *
+ * ```
+ * export const createRoute = makeCreateRoute<AppServices, ApiRouteRequest, {
+ *   method: METHOD;
+ * }>();
+ * ```
+ *
+ * Notes:
+ * * The `{method: METHOD}` defines the `Ex` extension type; here, the `method` property is only
+ *   relevant to backend routes.
+ * * when defining the `createRoute` method, only the request input format is defined, the output
+ *   format is derived from the routes.
+ *
+ * When calling the resulting `createRoute` function, the only required params of the route are the
+ * name, path, and handler. Other params can be added to the type and then later used in the
+ * routeMatcher.
+ *
+ * eg when defining requestServiceProvider in line, the types have a hard time, it helps to put in another argument:
+ * ```
+ * export const exampleRoute = createRoute({
+ *   name: 'exampleRoute', method: METHOD.GET, path: '/api/example/:key',
+ *   requestServiceProvider: composeServiceMiddleware({
+ *     cookieAuthMiddleware,
+ *     documentStoreMiddleware,
+ *   }},
+ *   async(params: {key: string}, services) => {
+ *     const result = await services.myDocumentStore.getItem(params.key);
+ *
+ *     if (!result) {
+ *       throw new NotFoundError('requested item not found');
+ *     }
+ *
+ *     return apiJsonResponse(200, result);
+ *   }
+ * );
+ * ```
+ * eg when using a pre-existing provider variable the types work better:
+ * ```
+ * export const exampleRoute = createRoute({
+ *   name: 'exampleRoute', method: METHOD.GET, path: '/api/example/:key',
+ *   requestServiceProvider,
+ *   handler: async(params: {key: string}, services) => {
+ *     const result = await services.myDocumentStore.getItem(params.key);
+ *
+ *     if (!result) {
+ *       throw new NotFoundError('requested item not found');
+ *     }
+ *
+ *     return apiJsonResponse(200, result);
+ *   }
+ * });
+ * ```
+ */
 export declare const makeCreateRoute: <Sa, Ri, Ex = {}>() => CreateRoute<Sa, Ri, Ex>;
+/**
+ * Makes a renderRouteUrl function that can be used to render route paths (this is a factory
+ * factory). The returned function takes a `route`, `params`, and `query` and returns a string
+ * with the params and query substituted into the route path.
+ *
+ * this function is initialized using the Ru type which indicates the specific routes wired into
+ * the application, which means that if you try to build a url with a route which is not wired
+ * into the router you will get a type error. this is a feature to prevent referencing routes that
+ * don't exist or aren't handling requests properly.
+ *
+ * if you are making a helper function or need to render a route outside your application, you
+ * can use the `renderAnyRouteUrl` function
+ */
 export declare const makeRenderRouteUrl: <Ru extends {
     path: 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.
+ *
+ * prefer using `renderRouteUrl` initialized with your applications route union
+ * when possible to help catch improperly initialized routes.
+ *
+ * @param route the route that has a `path` to be interpolated
+ * @param params the parameters to interpolate into the route path
+ * @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;
 declare type RequestPathExtractor<Ri> = (request: Ri) => string;
 declare type RequestLogExtractor<Ri> = (request: Ri) => JsonCompatibleStruct;
@@ -67,6 +172,36 @@ declare type RequestResponder<Sa, Ri, Ro> = {
         logger: Logger;
     }) => RoF): (request: Ri) => RoF;
 };
+/**
+ * A factory factory for creating request responders (functions that take a request and return a
+ * response -- these functions let us implement Lambda `handler` functions).
+ *
+ * Use it in two steps. First, call it with the general business logic that defines routes, logs,
+ * errors, etc:
+ * ```
+ * const getRequestResponder = makeGetRequestResponder<
+ *    AppServices, TRoutes, ApiRouteRequest, Promise<ApiRouteResponse>
+ *   >()  // this empty invocation helps typescript mix defined and inferred types
+ *   ({
+ *     routes: apiRoutes, // the route definitions
+ *     pathExtractor,     // how to get the path out of the request format
+ *     routeMatcher,      // logic for matching route (beyond path matching, optional)
+ *     errorHandler,      // any special error handling
+ *   });
+ * ```
+ * Note here that among other things we're specifying a generic response format that the response
+ * and error handling middleware can use, if any routes have responses that don't adhere to this
+ * it'll complain about it.
+ *
+ * Next, we use the `getRequestResponder` to create a responder for a specific lambda entrypoint:
+ * ```
+ * export const handler: (request: APIGatewayProxyEventV2): Promise<ApiRouteResponse> =>
+ *   getRequestResponder(
+ *     lambdaServices,  // the AppServices for this entrypoint
+ *     lambdaMiddleware // environment specific response middleware (like cors)
+ *   );
+ * ```
+ */
 export declare const makeGetRequestResponder: <Sa, Ru, Ri, Ro>() => ({ routes, pathExtractor, routeMatcher, errorHandler, logExtractor }: {
     routes: () => AnySpecificRoute<Ru, Sa, Ri, Ro>[];
     pathExtractor: RequestPathExtractor<Ri>;
@@ -74,14 +209,19 @@ export declare const makeGetRequestResponder: <Sa, Ru, Ri, Ro>() => ({ routes, p
     routeMatcher?: RequestRouteMatcher<Ri, AnySpecificRoute<Ru, Sa, Ri, Ro>> | undefined;
     errorHandler?: ((e: Error, logger: Logger) => Ro) | undefined;
 }) => RequestResponder<Sa, Ri, Ro>;
+/** HTTP Headers */
 export declare type HttpHeaders = {
     [key: string]: string | undefined | string[];
 };
+/** A type that works in JSON */
 export declare type JsonCompatibleValue = string | number | null | undefined | boolean;
+/** A JSON array type */
 export declare type JsonCompatibleArray = Array<JsonCompatibleValue | JsonCompatibleStruct | JsonCompatibleStruct>;
+/** A JSON object type */
 export declare type JsonCompatibleStruct = {
     [key: string]: JsonCompatibleStruct | JsonCompatibleValue | JsonCompatibleArray;
 };
+/** The type for an API response */
 export declare type ApiResponse<S extends number, T> = {
     isBase64Encoded?: boolean;
     statusCode: S;
@@ -91,9 +231,38 @@ export declare type ApiResponse<S extends number, T> = {
         [key: string]: string;
     };
 };
+/**
+ * Returns a JSON response. Handles serializing the data to JSON and setting the content-type header.
+ * @param statusCode e.g. 201
+ * @param data the object to be serialized to JSON
+ * @param headers HTTP headers
+ * @example
+ * return apiJsonResponse(
+ *   200, {
+ *     message: "hello, world!",
+ *     foo: "bar",
+ *   },
+ *   { 'X-Frame-Options': 'DENY' }
+ * );
+ */
 export declare const apiJsonResponse: <S extends number, T extends JsonCompatibleStruct>(statusCode: S, data: T, headers?: HttpHeaders | undefined) => ApiResponse<S, T>;
+/**
+ * Returns a plain text response. Handles setting the content-type header.
+ * @param statusCode e.g. 201
+ * @param data some string
+ * @param headers HTTP headers
+ * @example return apiTextResponse(200, 'some text')
+ */
 export declare const apiTextResponse: <S extends number>(statusCode: S, data: string, headers?: HttpHeaders | undefined) => ApiResponse<S, string>;
+/**
+ * Returns an HTML response. Handles setting the content-type header.
+ * @param statusCode e.g. 201
+ * @param data some string
+ * @param headers HTTP headers
+ * @example return apiHtmlResponse(200, '<b>some text</b>')
+ */
 export declare const apiHtmlResponse: <S extends number>(statusCode: S, data: string, headers?: HttpHeaders | undefined) => ApiResponse<S, string>;
+/** HTTP method enum */
 export declare enum METHOD {
     GET = "GET",
     HEAD = "HEAD",