@openstax/ts-utils 1.7.0 → 1.8.0

package/dist/esm/types.d.ts

@@ -7,6 +7,10 @@
  * There may be a better way to do this; `T1 extends T2` doesn't work
  */
 export declare type TupleExtends<T1, T2> = T1 extends [infer T1Head, ...infer T1Tail] ? T2 extends [infer T2Head, ...infer T2Tail] ? T1Head extends T2Head ? TupleExtends<T1Tail, T2Tail> extends 'yes' ? 'yes' : 'no' : 'no' : T2 extends [] ? 'yes' : 'no' : T1 extends [] ? T2 extends [] ? 'yes' : 'no' : 'no';
+/**
+ * unions each member of the tuple
+ */
+export declare type TupleZip<T1, T2> = T1 extends [infer T1Head, ...infer T1Tail] ? T2 extends [infer T2Head, ...infer T2Tail] ? [T1Head & T2Head, ...TupleZip<T1Tail, T2Tail>] : T2 extends [] ? T1 : never : T1 extends [] ? T2 extends any[] ? T2 : never : never;
 /**
  * If `R` is `Promise<I>`, returns `I`, otherwise returns `R`
  * @deprecated use TypeScript builtin Awaited instead:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openstax/ts-utils",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "bin": {
     "ts-utils": "./script/bin-entry.bash"
   },
@@ -50,20 +50,115 @@
       "import": "./dist/esm/index.js",
       "require": "./dist/cjs/index.js"
     },
-    "./": {
-      "browser": "./dist/cjs/",
-      "import": "./dist/esm/",
-      "require": "./dist/cjs/"
+    "./*": {
+      "browser": "./dist/cjs/*.js",
+      "import": "./dist/esm/*.js",
+      "require": "./dist/cjs/*.js"
     },
-    "./**": {
-      "browser": "./dist/cjs/**.js",
-      "import": "./dist/esm/**.js",
-      "require": "./dist/cjs/**.js"
+    "./assertions": {
+      "browser": "./dist/cjs/assertions/index.js",
+      "import": "./dist/esm/assertions/index.js",
+      "require": "./dist/cjs/assertions/index.js"
     },
-    "./**/": {
-      "browser": "./dist/cjs/**/index.js",
-      "import": "./dist/esm/**/index.js",
-      "require": "./dist/cjs/**/index.js"
+    "./aws": {
+      "browser": "./dist/cjs/aws/index.js",
+      "import": "./dist/esm/aws/index.js",
+      "require": "./dist/cjs/aws/index.js"
+    },
+    "./config": {
+      "browser": "./dist/cjs/config/index.js",
+      "import": "./dist/esm/config/index.js",
+      "require": "./dist/cjs/config/index.js"
+    },
+    "./errors": {
+      "browser": "./dist/cjs/errors/index.js",
+      "import": "./dist/esm/errors/index.js",
+      "require": "./dist/cjs/errors/index.js"
+    },
+    "./fetch": {
+      "browser": "./dist/cjs/fetch/index.js",
+      "import": "./dist/esm/fetch/index.js",
+      "require": "./dist/cjs/fetch/index.js"
+    },
+    "./guards": {
+      "browser": "./dist/cjs/guards/index.js",
+      "import": "./dist/esm/guards/index.js",
+      "require": "./dist/cjs/guards/index.js"
+    },
+    "./middleware": {
+      "browser": "./dist/cjs/middleware/index.js",
+      "import": "./dist/esm/middleware/index.js",
+      "require": "./dist/cjs/middleware/index.js"
+    },
+    "./misc": {
+      "browser": "./dist/cjs/misc/index.js",
+      "import": "./dist/esm/misc/index.js",
+      "require": "./dist/cjs/misc/index.js"
+    },
+    "./pagination": {
+      "browser": "./dist/cjs/pagination/index.js",
+      "import": "./dist/esm/pagination/index.js",
+      "require": "./dist/cjs/pagination/index.js"
+    },
+    "./routing": {
+      "browser": "./dist/cjs/routing/index.js",
+      "import": "./dist/esm/routing/index.js",
+      "require": "./dist/cjs/routing/index.js"
+    },
+    "./services": {
+      "browser": "./dist/cjs/services/index.js",
+      "import": "./dist/esm/services/index.js",
+      "require": "./dist/cjs/services/index.js"
+    },
+    "./services/launchParams": {
+      "browser": "./dist/cjs/services/launchParams/index.js",
+      "import": "./dist/esm/services/launchParams/index.js",
+      "require": "./dist/cjs/services/launchParams/index.js"
+    },
+    "./services/exercisesGateway": {
+      "browser": "./dist/cjs/services/exercisesGateway/index.js",
+      "import": "./dist/esm/services/exercisesGateway/index.js",
+      "require": "./dist/cjs/services/exercisesGateway/index.js"
+    },
+    "./services/accountsGateway": {
+      "browser": "./dist/cjs/services/accountsGateway/index.js",
+      "import": "./dist/esm/services/accountsGateway/index.js",
+      "require": "./dist/cjs/services/accountsGateway/index.js"
+    },
+    "./services/logger": {
+      "browser": "./dist/cjs/services/logger/index.js",
+      "import": "./dist/esm/services/logger/index.js",
+      "require": "./dist/cjs/services/logger/index.js"
+    },
+    "./services/searchProvider": {
+      "browser": "./dist/cjs/services/searchProvider/index.js",
+      "import": "./dist/esm/services/searchProvider/index.js",
+      "require": "./dist/cjs/services/searchProvider/index.js"
+    },
+    "./services/versionedDocumentStore": {
+      "browser": "./dist/cjs/services/versionedDocumentStore/index.js",
+      "import": "./dist/esm/services/versionedDocumentStore/index.js",
+      "require": "./dist/cjs/services/versionedDocumentStore/index.js"
+    },
+    "./services/lrsGateway": {
+      "browser": "./dist/cjs/services/lrsGateway/index.js",
+      "import": "./dist/esm/services/lrsGateway/index.js",
+      "require": "./dist/cjs/services/lrsGateway/index.js"
+    },
+    "./services/authProvider": {
+      "browser": "./dist/cjs/services/authProvider/index.js",
+      "import": "./dist/esm/services/authProvider/index.js",
+      "require": "./dist/cjs/services/authProvider/index.js"
+    },
+    "./services/authProvider/utils": {
+      "browser": "./dist/cjs/services/authProvider/utils/index.js",
+      "import": "./dist/esm/services/authProvider/utils/index.js",
+      "require": "./dist/cjs/services/authProvider/utils/index.js"
+    },
+    "./services/apiGateway": {
+      "browser": "./dist/cjs/services/apiGateway/index.js",
+      "import": "./dist/esm/services/apiGateway/index.js",
+      "require": "./dist/cjs/services/apiGateway/index.js"
     }
   },
   "files": [

package/dist/cjs/profile.d.ts

@@ -1,61 +0,0 @@
-import { GenericFetch } from './fetch';
-import { ApiResponse, HttpHeaders } from './routing';
-import { Logger } from './services/logger';
-export interface Call {
-    start: number;
-    end?: number;
-    children: Array<Profile | ProfileData>;
-}
-export declare type ProfileFunction = <Fn extends (...args: any[]) => any>(trackName: string, fn: (p: Track) => Fn) => Fn;
-export interface Track {
-    track: ProfileFunction;
-    trackFetch: <F extends GenericFetch>(fetch: F) => F;
-    setTracing: (tracing: boolean | Promise<boolean>) => void;
-    getTracing: () => Promise<undefined | boolean>;
-    data: () => Call;
-    report: () => CallReport;
-    adopt: (child: Profile) => void;
-}
-export interface ProfileData {
-    name: string;
-    calls: Call[];
-}
-export interface Profile extends ProfileData {
-    report: () => ProfileReport;
-    start: () => Track & {
-        end: () => void;
-    };
-}
-interface CallReport {
-    time: number | string;
-    children: ProfileReport[];
-    coverage: 'unknown' | {
-        accountedTime: number;
-        unaccountedTime: number;
-        accountedPercent: number;
-    };
-}
-interface ProfileReport {
-    name: string;
-    time: 'unknown' | {
-        total: number;
-        min: number;
-        max: number;
-        avg: number;
-    };
-    calls: CallReport[];
-}
-export declare const createProfile: (name: string, options?: {
-    trace?: boolean | Promise<boolean>;
-}) => Profile;
-export declare const makeProfileApiResponseMiddleware: <Ri extends {
-    headers: HttpHeaders;
-}>(showReport: (request: Ri) => string | boolean) => () => (responsePromise: Promise<ApiResponse<number, any>> | undefined, { request, profile }: {
-    request: Ri;
-    profile: Track;
-    logger: Logger;
-}) => Promise<ApiResponse<number, any>> | undefined;
-export declare const makeHtmlReport: (report: CallReport) => string;
-export declare const makeHtmlProfileReport: (report: ProfileReport) => string;
-export declare const makeHtmlCallReport: (report: CallReport, index: number) => string;
-export {};

package/dist/cjs/profile.js

@@ -1,199 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeHtmlCallReport = exports.makeHtmlProfileReport = exports.makeHtmlReport = exports.makeProfileApiResponseMiddleware = exports.createProfile = void 0;
-const guards_1 = require("./guards");
-const routing_1 = require("./routing");
-const _1 = require(".");
-const callReport = (call) => {
-    const time = call.start && call.end
-        ? call.end - call.start
-        : 'unknown';
-    const children = call.children
-        .filter(profile => profile.calls.length > 0)
-        .map(profileReport);
-    const accountedTime = children.reduce((result, profile) => typeof profile.time === 'string' ? result : result + profile.time.total, 0);
-    const coverage = typeof time === 'number' && children.length > 0 ? {
-        accountedTime,
-        unaccountedTime: time - accountedTime,
-        accountedPercent: (0, _1.roundToPrecision)(accountedTime / time, -2),
-    } : 'unknown';
-    return { time, children, coverage };
-};
-const profileReport = (profile) => {
-    const calls = profile.calls.map(callReport);
-    const times = calls
-        .map(call => call.time)
-        .filter(guards_1.isNumber);
-    const time = times.length > 0 ? {
-        total: times.reduce((result, item) => result + item, 0),
-        min: Math.min(...times),
-        max: Math.max(...times),
-        avg: Math.round(times.reduce((result, item) => result + item, 0) / times.length),
-    } : 'unknown';
-    return {
-        name: profile.name, calls, time
-    };
-};
-const createProfile = (name, options = {}) => {
-    const profile = {
-        name,
-        calls: [],
-        report: () => profileReport(profile),
-        start: () => {
-            const call = { start: Date.now(), children: [] };
-            profile.calls.push(call);
-            return {
-                end: () => { call.end = Date.now(); },
-                report: () => callReport({ end: Date.now(), ...call }),
-                data: () => ({ end: Date.now(), ...call }),
-                adopt: (childProfile) => { call.children.push(childProfile); },
-                setTracing: (tracing) => { options.trace = tracing; },
-                getTracing: async () => options.trace,
-                trackFetch: (fetch) => {
-                    const trackProfile = (0, exports.createProfile)('fetch', options);
-                    call.children.push(trackProfile);
-                    return (async (url, config) => {
-                        const { end, ...track } = trackProfile.start();
-                        const fetchConfig = await options.trace
-                            ? (0, _1.merge)(config || {}, {
-                                headers: { 'x-application-profile': 'trace' }
-                            })
-                            : config;
-                        return fetch(url, fetchConfig).then(response => {
-                            const fetchProfileJson = response.headers.get('x-application-profile');
-                            const fetchProfile = fetchProfileJson ? JSON.parse(fetchProfileJson) : undefined;
-                            end();
-                            if (fetchProfile) {
-                                const subrequestProfile = (0, exports.createProfile)(url, options);
-                                subrequestProfile.calls.push(fetchProfile);
-                                track.adopt(subrequestProfile);
-                            }
-                            return response;
-                        });
-                    });
-                },
-                track: (trackName, fn) => {
-                    const trackProfile = (0, exports.createProfile)(trackName, options);
-                    call.children.push(trackProfile);
-                    return ((...args) => {
-                        const { end, ...track } = trackProfile.start();
-                        const result = fn(track)(...args);
-                        if (result instanceof Promise) {
-                            return result.finally(() => { end(); });
-                        }
-                        else {
-                            end();
-                            return result;
-                        }
-                    });
-                }
-            };
-        },
-    };
-    return profile;
-};
-exports.createProfile = createProfile;
-const makeProfileApiResponseMiddleware = (showReport) => () => (responsePromise, { request, profile }) => {
-    if (responsePromise) {
-        return responsePromise.then(async (response) => {
-            const reportFormat = showReport(request);
-            const enabled = await profile.getTracing();
-            // profiling is disabled, return original response
-            if (!enabled) {
-                return response;
-            }
-            // there is no report format, return original response but
-            // add sub-request trace response if necessary
-            if (reportFormat === false) {
-                if ((0, routing_1.getHeader)(request.headers, 'x-application-profile')) {
-                    return {
-                        ...response,
-                        headers: {
-                            ...response.headers,
-                            'x-application-profile': JSON.stringify(profile.data())
-                        }
-                    };
-                }
-                return response;
-                // override response with html report
-            }
-            else if (reportFormat === 'html') {
-                return (0, routing_1.apiHtmlResponse)(200, (0, exports.makeHtmlReport)(profile.report()));
-            }
-            // override response with json report
-            return (0, routing_1.apiJsonResponse)(200, profile.report());
-        });
-    }
-    return responsePromise;
-};
-exports.makeProfileApiResponseMiddleware = makeProfileApiResponseMiddleware;
-const makeHtmlReport = (report) => `
-<head>
-  <style>
-    table {
-      border-collapse: collapse;
-    }
-    table td,th {
-      border: 1px solid #ccc;
-      padding: 10px;
-    }
-    summary {
-      padding: 10px 0;
-    }
-  </style>
-</head>
-<body>
-  ${(0, exports.makeHtmlCallReport)(report, 0)}
-</body>
-`;
-exports.makeHtmlReport = makeHtmlReport;
-const makeHtmlProfileReport = (report) => `
-<details>
-  <summary>Profile: ${report.name}</summary>
-  <table>
-    <thead>
-      <tr>
-        <th>call #</th>
-        <th>children</th>
-        <th>time</th>
-        <th>time coverage (accounted/unaccounted/percent)</th>
-      </tr>
-    </thead>
-    <tbody>
-      ${report.calls.map((call, i) => `<tr>
-        <td>${i + 1}</td>
-        <td>${call.children.length}</td>
-        <td>${call.time}</td>
-        <td>${typeof call.coverage === 'string' ? call.coverage : `${call.coverage.accountedTime}/${call.coverage.unaccountedTime}/${call.coverage.accountedPercent}`}</td>
-      </tr>`)}
-    </tbody>
-  </table>
-  <div style="padding-left: 20px; border-left: 1px solid #ccc;">
-    ${report.calls.map(exports.makeHtmlCallReport).join('')}
-  </div>
-</details>
-`;
-exports.makeHtmlProfileReport = makeHtmlProfileReport;
-const makeHtmlCallReport = (report, index) => `
-<h4>call # ${index + 1} children<h4>
-<table>
-  <thead>
-    <tr>
-      <th>name</th>
-      <th>calls</th>
-      <th>time (total (min/max/avg))</th>
-    </tr>
-  </thead>
-  <tbody>
-    ${report.children.map(profile => `<tr>
-      <td>${profile.name}</td>
-      <td>${profile.calls.length}</td>
-      <td>${typeof profile.time === 'string' ? profile.time : `${profile.time.total} (${profile.time.min}/${profile.time.max}/${profile.time.avg})`}</td>
-    </tr>`).join('')}
-  </tbody>
-</table>
-<div style="margin-left: 20px">
-  ${report.children.map(exports.makeHtmlProfileReport).join('')}
-</div>
-`;
-exports.makeHtmlCallReport = makeHtmlCallReport;

package/dist/esm/profile.d.ts

@@ -1,61 +0,0 @@
-import { GenericFetch } from './fetch';
-import { ApiResponse, HttpHeaders } from './routing';
-import { Logger } from './services/logger';
-export interface Call {
-    start: number;
-    end?: number;
-    children: Array<Profile | ProfileData>;
-}
-export declare type ProfileFunction = <Fn extends (...args: any[]) => any>(trackName: string, fn: (p: Track) => Fn) => Fn;
-export interface Track {
-    track: ProfileFunction;
-    trackFetch: <F extends GenericFetch>(fetch: F) => F;
-    setTracing: (tracing: boolean | Promise<boolean>) => void;
-    getTracing: () => Promise<undefined | boolean>;
-    data: () => Call;
-    report: () => CallReport;
-    adopt: (child: Profile) => void;
-}
-export interface ProfileData {
-    name: string;
-    calls: Call[];
-}
-export interface Profile extends ProfileData {
-    report: () => ProfileReport;
-    start: () => Track & {
-        end: () => void;
-    };
-}
-interface CallReport {
-    time: number | string;
-    children: ProfileReport[];
-    coverage: 'unknown' | {
-        accountedTime: number;
-        unaccountedTime: number;
-        accountedPercent: number;
-    };
-}
-interface ProfileReport {
-    name: string;
-    time: 'unknown' | {
-        total: number;
-        min: number;
-        max: number;
-        avg: number;
-    };
-    calls: CallReport[];
-}
-export declare const createProfile: (name: string, options?: {
-    trace?: boolean | Promise<boolean>;
-}) => Profile;
-export declare const makeProfileApiResponseMiddleware: <Ri extends {
-    headers: HttpHeaders;
-}>(showReport: (request: Ri) => string | boolean) => () => (responsePromise: Promise<ApiResponse<number, any>> | undefined, { request, profile }: {
-    request: Ri;
-    profile: Track;
-    logger: Logger;
-}) => Promise<ApiResponse<number, any>> | undefined;
-export declare const makeHtmlReport: (report: CallReport) => string;
-export declare const makeHtmlProfileReport: (report: ProfileReport) => string;
-export declare const makeHtmlCallReport: (report: CallReport, index: number) => string;
-export {};

package/dist/esm/profile.js

@@ -1,191 +0,0 @@
-import { isNumber } from './guards';
-import { apiHtmlResponse, apiJsonResponse, getHeader } from './routing';
-import { merge, roundToPrecision } from '.';
-const callReport = (call) => {
-    const time = call.start && call.end
-        ? call.end - call.start
-        : 'unknown';
-    const children = call.children
-        .filter(profile => profile.calls.length > 0)
-        .map(profileReport);
-    const accountedTime = children.reduce((result, profile) => typeof profile.time === 'string' ? result : result + profile.time.total, 0);
-    const coverage = typeof time === 'number' && children.length > 0 ? {
-        accountedTime,
-        unaccountedTime: time - accountedTime,
-        accountedPercent: roundToPrecision(accountedTime / time, -2),
-    } : 'unknown';
-    return { time, children, coverage };
-};
-const profileReport = (profile) => {
-    const calls = profile.calls.map(callReport);
-    const times = calls
-        .map(call => call.time)
-        .filter(isNumber);
-    const time = times.length > 0 ? {
-        total: times.reduce((result, item) => result + item, 0),
-        min: Math.min(...times),
-        max: Math.max(...times),
-        avg: Math.round(times.reduce((result, item) => result + item, 0) / times.length),
-    } : 'unknown';
-    return {
-        name: profile.name, calls, time
-    };
-};
-export const createProfile = (name, options = {}) => {
-    const profile = {
-        name,
-        calls: [],
-        report: () => profileReport(profile),
-        start: () => {
-            const call = { start: Date.now(), children: [] };
-            profile.calls.push(call);
-            return {
-                end: () => { call.end = Date.now(); },
-                report: () => callReport({ end: Date.now(), ...call }),
-                data: () => ({ end: Date.now(), ...call }),
-                adopt: (childProfile) => { call.children.push(childProfile); },
-                setTracing: (tracing) => { options.trace = tracing; },
-                getTracing: async () => options.trace,
-                trackFetch: (fetch) => {
-                    const trackProfile = createProfile('fetch', options);
-                    call.children.push(trackProfile);
-                    return (async (url, config) => {
-                        const { end, ...track } = trackProfile.start();
-                        const fetchConfig = await options.trace
-                            ? merge(config || {}, {
-                                headers: { 'x-application-profile': 'trace' }
-                            })
-                            : config;
-                        return fetch(url, fetchConfig).then(response => {
-                            const fetchProfileJson = response.headers.get('x-application-profile');
-                            const fetchProfile = fetchProfileJson ? JSON.parse(fetchProfileJson) : undefined;
-                            end();
-                            if (fetchProfile) {
-                                const subrequestProfile = createProfile(url, options);
-                                subrequestProfile.calls.push(fetchProfile);
-                                track.adopt(subrequestProfile);
-                            }
-                            return response;
-                        });
-                    });
-                },
-                track: (trackName, fn) => {
-                    const trackProfile = createProfile(trackName, options);
-                    call.children.push(trackProfile);
-                    return ((...args) => {
-                        const { end, ...track } = trackProfile.start();
-                        const result = fn(track)(...args);
-                        if (result instanceof Promise) {
-                            return result.finally(() => { end(); });
-                        }
-                        else {
-                            end();
-                            return result;
-                        }
-                    });
-                }
-            };
-        },
-    };
-    return profile;
-};
-export const makeProfileApiResponseMiddleware = (showReport) => () => (responsePromise, { request, profile }) => {
-    if (responsePromise) {
-        return responsePromise.then(async (response) => {
-            const reportFormat = showReport(request);
-            const enabled = await profile.getTracing();
-            // profiling is disabled, return original response
-            if (!enabled) {
-                return response;
-            }
-            // there is no report format, return original response but
-            // add sub-request trace response if necessary
-            if (reportFormat === false) {
-                if (getHeader(request.headers, 'x-application-profile')) {
-                    return {
-                        ...response,
-                        headers: {
-                            ...response.headers,
-                            'x-application-profile': JSON.stringify(profile.data())
-                        }
-                    };
-                }
-                return response;
-                // override response with html report
-            }
-            else if (reportFormat === 'html') {
-                return apiHtmlResponse(200, makeHtmlReport(profile.report()));
-            }
-            // override response with json report
-            return apiJsonResponse(200, profile.report());
-        });
-    }
-    return responsePromise;
-};
-export const makeHtmlReport = (report) => `
-<head>
-  <style>
-    table {
-      border-collapse: collapse;
-    }
-    table td,th {
-      border: 1px solid #ccc;
-      padding: 10px;
-    }
-    summary {
-      padding: 10px 0;
-    }
-  </style>
-</head>
-<body>
-  ${makeHtmlCallReport(report, 0)}
-</body>
-`;
-export const makeHtmlProfileReport = (report) => `
-<details>
-  <summary>Profile: ${report.name}</summary>
-  <table>
-    <thead>
-      <tr>
-        <th>call #</th>
-        <th>children</th>
-        <th>time</th>
-        <th>time coverage (accounted/unaccounted/percent)</th>
-      </tr>
-    </thead>
-    <tbody>
-      ${report.calls.map((call, i) => `<tr>
-        <td>${i + 1}</td>
-        <td>${call.children.length}</td>
-        <td>${call.time}</td>
-        <td>${typeof call.coverage === 'string' ? call.coverage : `${call.coverage.accountedTime}/${call.coverage.unaccountedTime}/${call.coverage.accountedPercent}`}</td>
-      </tr>`)}
-    </tbody>
-  </table>
-  <div style="padding-left: 20px; border-left: 1px solid #ccc;">
-    ${report.calls.map(makeHtmlCallReport).join('')}
-  </div>
-</details>
-`;
-export const makeHtmlCallReport = (report, index) => `
-<h4>call # ${index + 1} children<h4>
-<table>
-  <thead>
-    <tr>
-      <th>name</th>
-      <th>calls</th>
-      <th>time (total (min/max/avg))</th>
-    </tr>
-  </thead>
-  <tbody>
-    ${report.children.map(profile => `<tr>
-      <td>${profile.name}</td>
-      <td>${profile.calls.length}</td>
-      <td>${typeof profile.time === 'string' ? profile.time : `${profile.time.total} (${profile.time.min}/${profile.time.max}/${profile.time.avg})`}</td>
-    </tr>`).join('')}
-  </tbody>
-</table>
-<div style="margin-left: 20px">
-  ${report.children.map(makeHtmlProfileReport).join('')}
-</div>
-`;