@openstax/ts-utils 1.34.0 → 1.35.0

package/packages/frontend/src/example/screens/ThingView.tsx

@@ -1,47 +0,0 @@
-import React from 'react';
-import { createRoute, makeScreen } from "../../core/services";
-import { Layout } from "../components/Layout";
-import {
-  FetchState,
-  fetchLoading,
-  fetchError,
-  fetchSuccess,
-  stateHasData,
-  stateHasError
-} from "@openstax/ts-utils/fetch";
-import { useApiClient } from "../api";
-import {
-  ExampleDocument
-} from "@project/lambdas/build/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware";
-
-const useGetDocument = (id: string) => {
-  const apiClient = useApiClient();
-  const [data, setData] = React.useState<FetchState<ExampleDocument, string>>(fetchLoading());
-
-  React.useEffect(() => {
-    apiClient.apiV0GetExampleDoc({params: {key: id}})
-      .then(response => response.acceptStatus(200, 404))
-      .then(response => response.status === 200 ? response.load() : undefined)
-      .then(data => data !== undefined
-        ? setData(fetchSuccess(data))
-        : setData(previous => fetchError('item not found', previous))
-      )
-      .catch(() => setData(previous => fetchError('connection failed', previous)))
-    ;
-  }, [apiClient, id]);
-
-  return data;
-};
-
-export const ThingView = ({id}: {id: string}) => {
-  const state = useGetDocument(id);
-
-  return <Layout title={`Thing: ${stateHasData(state) ? state.data.name : ''}`}>
-    {stateHasError(state) ? state.error : null}
-    {stateHasData(state) ? <pre>{JSON.stringify(state.data, null, 2)}</pre> : null}
-  </Layout>;
-};
-
-export const thingViewScreen = createRoute({name: 'ThingView', path: '/things/:id',
-  handler: makeScreen(ThingView),
-});

package/packages/frontend/src/example/screens/index.ts

@@ -1,9 +0,0 @@
-import {homeScreen} from './Home';
-import { thingListScreen } from "./ThingList";
-import { thingViewScreen } from "./ThingView";
-
-export const exampleRoutes = () => ([
-  homeScreen,
-  thingListScreen,
-  thingViewScreen,
-]);

package/packages/frontend/src/index.css

@@ -1,159 +0,0 @@
-html {
-  font-family: "Neue Helvetica W01", Helvetica, Arial, sans-serif;
-  font-size: 62.5%;
-  text-size-adjust: 100%; /* Prevent font scaling in landscape while allowing user zoom */
-}
-
-body {
-  margin: 0;
-  -webkit-font-smoothing: antialiased;
-  -moz-osx-font-smoothing: grayscale;
-}
-
-code {
-  font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
-    monospace;
-}
-
-#root, body, html {
-  margin: 0;
-  padding: 0;
-  height: 100%;
-}
-
-#root {
-  display: flex;
-  flex-direction: column;
-}
-
-* {
-  box-sizing: border-box;
-}
-
-.visually-hidden {
-  clip: rect(0 0 0 0);
-  clip-path: inset(50%);
-  height: 1px;
-  overflow: hidden;
-  position: absolute;
-  white-space: nowrap;
-  width: 1px;
-}
-
-@import url('https://fonts.googleapis.com/css2?family=Libre+Baskerville:wght@700&display=swap');
-@import url("https://fast.fonts.net/t/1.css?apiType=css&projectid=437b6557-ce99-4f35-97ff-64a93247731f");
-@font-face {
-  font-display: swap;
-  font-family: 'Neue Helvetica W01';
-  src: url("https://openstax.org/cms/assets/fonts/e206f16e-f3ae-45eb-b7a9-c0a42ed7537f.woff2") format("woff2"), url("https://openstax.org/cms/assets/fonts/f4d1bafa-befd-4f3f-ba25-7c0f77c6651e.woff") format("woff");
-  font-weight: 100;
-  font-style: normal; }
-
-@font-face {
-  font-display: swap;
-  font-family: 'Neue Helvetica W01';
-  src: url("https://openstax.org/cms/assets/fonts/91faf02a-e602-411f-8235-45b42c914e41.woff2") format("woff2"), url("https://openstax.org/cms/assets/fonts/a5919350-0aef-4bd2-9809-88c50c764770.woff") format("woff");
-  font-weight: 100;
-  font-style: italic; }
-
-@font-face {
-  font-display: swap;
-  font-family: 'Neue Helvetica W01';
-  src: url("https://openstax.org/cms/assets/fonts/4ff9f3fa-9221-4fc5-97e6-93572b6efa24.woff2") format("woff2"), url("https://openstax.org/cms/assets/fonts/ca8d25cd-e264-4404-b271-4afc45c779c4.woff") format("woff");
-  font-weight: 200;
-  font-style: normal; }
-
-@font-face {
-  font-display: swap;
-  font-family: 'Neue Helvetica W01';
-  src: url("https://openstax.org/cms/assets/fonts/a9445981-191b-46c7-866c-acb67f9cc1db.woff2") format("woff2"), url("https://openstax.org/cms/assets/fonts/a0e9ae86-436e-483a-8201-6c694e90e9ee.woff") format("woff");
-  font-weight: 200;
-  font-style: italic; }
-
-@font-face {
-  font-display: swap;
-  font-family: 'Neue Helvetica W01';
-  src: url("https://openstax.org/cms/assets/fonts/3a46542f-f429-4821-9a88-62e3be54a640.woff2") format("woff2"), url("https://openstax.org/cms/assets/fonts/50ac1699-f3d2-47b6-878f-67a368a17c41.woff") format("woff");
-  font-weight: 300;
-  font-style: normal; }
-
-@font-face {
-  font-display: swap;
-  font-family: 'Neue Helvetica W01';
-  src: url("https://openstax.org/cms/assets/fonts/261b4efb-3d70-4965-977d-38af9422700d.woff2") format("woff2"), url("https://openstax.org/cms/assets/fonts/2e00514e-1764-4250-a0c5-aca3e5a8d133.woff") format("woff");
-  font-weight: 300;
-  font-style: italic; }
-
-@font-face {
-  font-display: swap;
-  font-family: 'Neue Helvetica W01';
-  src: local('Helvetica Neue'),
-  url("https://openstax.org/cms/assets/fonts/3dac71eb-afa7-4c80-97f0-599202772905.woff2") format("woff2"), url("https://openstax.org/cms/assets/fonts/34e0e4c0-c294-49bb-9a8e-1b2cafd54e32.woff") format("woff");
-  font-weight: 400;
-  font-style: normal; }
-
-@font-face {
-  font-display: swap;
-  font-family: 'Neue Helvetica W01';
-  src: local('Helvetica Neue Italic'),
-  url("https://openstax.org/cms/assets/fonts/21c44514-f4d6-4cff-a5de-e4cac5e61aff.woff2") format("woff2"), url("https://openstax.org/cms/assets/fonts/e7c4b231-76ad-47c7-a54b-5d84dcd78d0f.woff") format("woff");
-  font-weight: 400;
-  font-style: italic; }
-
-@font-face {
-  font-display: swap;
-  font-family: 'Neue Helvetica W01';
-  src: url("https://openstax.org/cms/assets/fonts/5b1fbd62-45dc-4433-a7df-a2b24a146411.woff2") format("woff2"), url("https://openstax.org/cms/assets/fonts/050b1948-f226-4d20-a65a-15d8ed031222.woff") format("woff");
-  font-weight: 500;
-  font-style: normal; }
-
-@font-face {
-  font-display: swap;
-  font-family: 'Neue Helvetica W01';
-  src: url("https://openstax.org/cms/assets/fonts/657c2fa4-585b-4761-9e2e-65ab13159323.woff2") format("woff2"), url("https://openstax.org/cms/assets/fonts/400869f0-f0d5-49a0-8a11-f4fb4279d125.woff") format("woff");
-  font-weight: 500;
-  font-style: italic; }
-
-@font-face {
-  font-display: swap;
-  font-family: 'Neue Helvetica W01';
-  src: local('Helvetica Neue Bold'),
-  url("https://openstax.org/cms/assets/fonts/531c5a28-5575-4f58-96d4-a80f7b702d7b.woff2") format("woff2"), url("https://openstax.org/cms/assets/fonts/439c5962-f9fe-4eaf-a1f6-f41d42edba75.woff") format("woff");
-  font-weight: 700;
-  font-style: normal; }
-
-@font-face {
-  font-display: swap;
-  font-family: 'Neue Helvetica W01';
-  src: local('Helvetica Neue Bold Italic'),
-  url("https://openstax.org/cms/assets/fonts/ade4dbae-c607-4c84-a375-f0c4de0cc357.woff2") format("woff2"), url("https://openstax.org/cms/assets/fonts/5b864741-6f14-4ed9-a297-27a4d73edf51.woff") format("woff");
-  font-weight: 700;
-  font-style: italic; }
-
-@font-face {
-  font-display: swap;
-  font-family: 'Neue Helvetica W01';
-  src: url("https://openstax.org/cms/assets/fonts/dd7814bd-8abf-46c5-a4be-db0977de2cca.woff2") format("woff2"), url("https://openstax.org/cms/assets/fonts/20ffa4b4-0154-4ca6-800c-468cecbd60f1.woff") format("woff");
-  font-weight: 800;
-  font-style: normal; }
-
-@font-face {
-  font-display: swap;
-  font-family: 'Neue Helvetica W01';
-  src: url("https://openstax.org/cms/assets/fonts/a1ce96fc-e8fa-4118-8a5c-e06d8d094e56.woff2") format("woff2"), url("https://openstax.org/cms/assets/fonts/c577fdb4-0e4a-4767-aa14-5510cf2c8fa4.woff") format("woff");
-  font-weight: 800;
-  font-style: italic; }
-
-@font-face {
-  font-display: swap;
-  font-family: 'Neue Helvetica W01';
-  src: url("https://openstax.org/cms/assets/fonts/bd8486cc-4614-412d-ba1d-15e1a7c9fada.woff2") format("woff2"), url("https://openstax.org/cms/assets/fonts/a7bdf5a9-752e-4e69-b17c-b7e62575b07a.woff") format("woff");
-  font-weight: 900;
-  font-style: normal; }
-
-@font-face {
-  font-display: swap;
-  font-family: 'Neue Helvetica W01';
-  src: url("https://openstax.org/cms/assets/fonts/42535969-7bc6-4047-b3ce-bd8aea29420c.woff2") format("woff2"), url("https://openstax.orghttps://openstax.org/cms/assets/fonts/35e69fef-20b6-4357-b3a2-075224efa08a.woff") format("woff");
-  font-weight: 900;
-  font-style: italic; }

package/packages/frontend/src/index.tsx

@@ -1,67 +0,0 @@
-import { createApiGateway } from "@openstax/ts-utils/services/apiGateway";
-import { createUserRoleValidator } from "@openstax/ts-utils/services/authProvider/utils/userRoleValidator";
-import { ErrorBoundary, createSentryLogger } from "@openstax/ui-components";
-import { createBrowserHistory, Location } from "history";
-import React from 'react';
-import ReactDOM from 'react-dom';
-import { createAuthProvider } from "./auth/authProvider";
-import { frontendConfigProvider } from "./configProvider";
-import { getRequestResponder } from "./core";
-import { serviceProviderMiddleware } from "./core/context/services";
-import { composeResponseServiceMiddleware } from "./core/services";
-import './index.css';
-
-/*
- * the use of the service container pattern in an app that only
- * has one entry point is pretty academic. it might become relevant
- * if you had some external dependencies the FE accessed directly
- * that you wanted to use a fake driver for in dev (or something like that)
- */
-const makeApiGateway = createApiGateway({fetch: fetch.bind(window)});
-const configProvider = frontendConfigProvider(makeApiGateway);
-const authProvider = createAuthProvider({window})(configProvider);
-const services = {
-  authProvider,
-  logger: createSentryLogger(),
-  roleValidator: createUserRoleValidator(authProvider, {application: () => configProvider.getValue('roleApplication')}),
-  history: createBrowserHistory(),
-  createApiGateway: makeApiGateway,
-  configProvider,
-};
-
-export type BrowserServices = typeof services;
-
-const handler = getRequestResponder(services, composeResponseServiceMiddleware(
-  serviceProviderMiddleware,
-));
-
-const Router = () => {
-  const [location, setLocation] = React.useState<Location>(services.history.location);
-
-  React.useEffect(() => {
-    return services.history.listen((locationChange) => {
-      setLocation(locationChange.location);
-    });
-  }, []);
-
-  return <>{handler(location)}</>;
-};
-
-const ErrorBoundaryComponent = () => {
-  return (
-    <ErrorBoundary
-      renderFallback
-      // sentryDsn='https://examplePublicKey@o0.ingest.sentry.io/0'
-
-    >
-      <Router />
-    </ErrorBoundary>
-  );
-};
-
-ReactDOM.render(
-  <React.StrictMode>
-    <ErrorBoundaryComponent />
-  </React.StrictMode>,
-  document.getElementById('root')
-);

package/packages/frontend/src/react-app-env.d.ts

@@ -1 +0,0 @@
-/// <reference types="react-scripts" />

package/packages/frontend/src/routing/components/RouteLink.spec.tsx

@@ -1,55 +0,0 @@
-import { render, screen, fireEvent } from '@testing-library/react';
-import { createRouteLink } from "./RouteLink";
-import { TestServiceProvider, testServices } from "../../tests/testServices";
-import { createRoute } from "../../core/services";
-
-const testRoute = createRoute({name: 'TestScreen', path: '/', handler: () => <div />});
-const testPropsRoute = createRoute({
-  name: 'TestPropsScreen',
-  path: '/:prop',
-  handler: (props: {prop: string}) => <div />
-});
-
-type RouteUnion = (typeof testRoute) | (typeof testPropsRoute);
-
-const RouteLink = createRouteLink<RouteUnion>();
-
-describe('RouteLink', () => {
-  it('renders a link', () => {
-    render(<TestServiceProvider><RouteLink route={testRoute}>link text</RouteLink></TestServiceProvider>);
-    expect(screen.getByText(/link text/i)).toMatchInlineSnapshot(`
-<a
-  href="/"
->
-  link text
-</a>
-`);
-  });
-
-  it('renders a link with props', () => {
-    render(<TestServiceProvider>
-      <RouteLink route={testPropsRoute} params={{prop: 'value'}}>link text</RouteLink>
-    </TestServiceProvider>);
-    expect(screen.getByText(/link text/i)).toMatchInlineSnapshot(`
-<a
-  href="/value"
->
-  link text
-</a>
-`);
-  });
-
-  it('pushes history', () => {
-    render(
-      <TestServiceProvider>
-        <RouteLink route={testPropsRoute} params={{prop: 'value'}}>link text</RouteLink>
-      </TestServiceProvider>
-    );
-
-    const pushSpy = jest.spyOn(testServices.history, 'push');
-
-    fireEvent.click(screen.getByText(/link text/i));
-
-    expect(pushSpy).toHaveBeenCalledWith('/value');
-  });
-});

package/packages/frontend/src/routing/components/RouteLink.tsx

@@ -1,35 +0,0 @@
-import React from 'react';
-import { ParamsForRoute, renderAnyRouteUrl, AnyRoute, QueryParams } from "@openstax/ts-utils/routing";
-import { useServices } from "core/context/services";
-import { TRoutes } from "core";
-
-export const isClickWithModifierKeys = (e: React.MouseEvent | MouseEvent) =>
-  e.shiftKey || e.ctrlKey || e.metaKey || e.altKey;
-
-export function useRouteLinkOnClick() {
-  const {history} = useServices();
-
-  return (e: React.MouseEvent<HTMLAnchorElement>) => {
-    if (isClickWithModifierKeys(e) || e.currentTarget.getAttribute('target') === '_blank') {
-      return;
-    }
-    e.preventDefault();
-    const {pathname, search, hash} = new URL(e.currentTarget.href);
-    const target = `${pathname}${search}${hash}`;
-    history.push(target);
-  };
-}
-
-export const createRouteLink = <Ru,>() => <R extends Ru>(
-  {
-    route, params, query, children, ...props
-  }: React.PropsWithChildren<{route: R extends AnyRoute<R> ? R : never; query?: QueryParams}> & (
-    ParamsForRoute<R> extends undefined ? {params?: undefined} : {params: ParamsForRoute<R>}
-  ) & React.HTMLProps<HTMLAnchorElement>
-) => {
-  const url = renderAnyRouteUrl<R>(route, params as ParamsForRoute<R>, query);
-
-  return <a {...props} href={url} onClick={useRouteLinkOnClick()}>{children}</a>;
-};
-
-export const RouteLink = createRouteLink<TRoutes>();

package/packages/frontend/src/routing/middleware.ts

@@ -1,6 +0,0 @@
-import queryString from 'query-string';
-import { AppServices } from "../core/types";
-
-export const getQuery = ({history}: AppServices) => {
-  return queryString.parse(history.location.search);
-};

package/packages/frontend/src/routing/useQuery.ts

@@ -1,14 +0,0 @@
-import React from 'react';
-import { useServices } from "../core/context/services";
-import { getQuery } from "./middleware";
-
-export const useQuery = () => {
-  const services = useServices();
-  const [query, setQuery] = React.useState(getQuery(services));
-
-  React.useEffect(() => 
-    services.history.listen(() => setQuery(getQuery(services)))
-  , [services, setQuery]);
-
-  return query;
-};

package/packages/frontend/src/setupProxy.js

@@ -1,19 +0,0 @@
-const proxy = require('http-proxy-middleware');
-const lambdaLocalProxy = require('@project/lambdas/build/script/lambdaLocalProxy');
-
-module.exports = function(app) {
-  accountsProxy(app);
-  lambdaLocalProxy(app, 'serviceApi');
-};
-
-function accountsProxy(app) {
-  app.use(proxy('/accounts', {
-    target: 'https://dev.openstax.org',
-    changeOrigin: true,
-    autoRewrite: true,
-    cookieDomainRewrite: "",
-    onProxyReq: (proxyRequest, request, response) => {
-      proxyRequest.setHeader('X-Forwarded-Host', request.headers.host);
-    }
-  }));
-}

package/packages/frontend/src/setupTests.ts

@@ -1,9 +0,0 @@
-// jest-dom adds custom jest matchers for asserting on DOM nodes.
-// allows you to do things like:
-// expect(element).toHaveTextContent(/react/i)
-// learn more: https://github.com/testing-library/jest-dom
-import '@testing-library/jest-dom';
-
-
-
-jest.mock('!!val-loader!@project/lambdas/build/script/utils/routeDataLoader', () => ({}), {virtual: true});

package/packages/frontend/src/tests/testServices.tsx

@@ -1,23 +0,0 @@
-import React from 'react';
-import { createUserRoleValidator } from "@openstax/ts-utils/services/authProvider/utils/userRoleValidator";
-import { createMemoryHistory } from "history";
-import { stubAuthProvider } from '@openstax/ts-utils/services/authProvider';
-import { ServiceContext } from "../core/context/services";
-import { AppServices } from "../core/types";
-
-export const testApiGateway: {[key: string]: any} = {};
-
-const authProvider = stubAuthProvider();
-export const testServices = {
-  createApiGateway: () => testApiGateway,
-  history: createMemoryHistory(),
-  authProvider,
-  roleValidator: createUserRoleValidator(authProvider, {application: 'test'}),
-  configProvider: { getConfig: async() => {}, getValue: async(_name: string) => undefined }
-} as any as AppServices;
-
-export const TestServiceProvider = ({children, ...services}: React.PropsWithChildren<Partial<AppServices>>) =>
-  <ServiceContext.Provider value={() => ({...testServices, ...services})}>
-    {children}
-  </ServiceContext.Provider>
-;

package/packages/frontend/tsconfig.json

@@ -1,27 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es5",
-    "lib": [
-      "dom",
-      "dom.iterable",
-      "esnext"
-    ],
-    "baseUrl": "src",
-    "allowJs": true,
-    "skipLibCheck": true,
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "strict": true,
-    "forceConsistentCasingInFileNames": true,
-    "noFallthroughCasesInSwitch": true,
-    "module": "esnext",
-    "moduleResolution": "node",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "noEmit": true,
-    "jsx": "react-jsx"
-  },
-  "include": [
-    "src"
-  ]
-}

package/packages/lambda/.eslintrc.js

@@ -1,64 +0,0 @@
-module.exports = {
-  root: true,
-  env: { node: true, es6: true },
-  parserOptions: {
-    ecmaVersion: 2018
-  },
-  overrides: [
-    {
-      files: ['**/*.ts?(x)'],
-      parser: '@typescript-eslint/parser',
-      parserOptions: {
-        project: 'tsconfig.json',
-        tsconfigRootDir: __dirname,
-        ecmaVersion: 2018,
-        sourceType: 'module',
-        warnOnUnsupportedTypeScriptVersion: true
-      },
-      plugins: ['@typescript-eslint'],
-      extends: [
-        'eslint:recommended',
-        'plugin:import/typescript'
-      ],
-      rules: {
-        '@typescript-eslint/ban-ts-comment': 'off',
-        '@typescript-eslint/no-inferrable-types': [
-          'warn',
-          { ignoreParameters: true }
-        ],
-        semi: 'off',
-        '@typescript-eslint/semi': ['warn'],
-        '@typescript-eslint/member-delimiter-style': ['warn'],
-        'no-unused-vars': 'off',
-        '@typescript-eslint/no-unused-vars': [
-          'warn',
-          {
-            args: 'none',
-            ignoreRestSiblings: true,
-            varsIgnorePattern: '^_',
-          }
-        ],
-        '@typescript-eslint/no-explicit-any': 'off'
-      }
-    }
-  ],
-  ignorePatterns: ['node_modules', 'dist', 'build', 'coverage'],
-  plugins: ['import', 'jest'],
-  extends: [
-    'eslint:recommended',
-    'plugin:jest/recommended',
-    'plugin:jest/style'
-  ],
-  rules: {
-    quotes: ['warn', 'single'],
-    'quote-props': ['warn', 'as-needed'],
-    'import/order': [
-      'warn',
-      { 'newlines-between': 'never', alphabetize: { order: 'asc' } }
-    ],
-    'sort-imports': [
-      'warn',
-      { ignoreDeclarationSort: true, ignoreCase: true }
-    ]
-  }
-}

package/packages/lambda/jest-global-setup.js

@@ -1,3 +0,0 @@
-module.exports = async () => {
-  process.env.TZ = 'UTC';
-};

package/packages/lambda/jest-setup-after-env.js

@@ -1 +0,0 @@
-// use this file for any global mocks or shared setup

package/packages/lambda/jest.config.js

@@ -1,31 +0,0 @@
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  globalSetup: './jest-global-setup.js',
-  setupFilesAfterEnv: ['./jest-setup-after-env.js'],
-  testMatch: [
-    '**/(src|script)/**/?(*.)+(spec).ts'
-  ],
-  collectCoverageFrom: [
-    'src/**/*.{js,ts}',
-    'script/**/*.{js,ts}',
-  ],
-  coveragePathIgnorePatterns: [
-    '/node_modules/',
-    '/test/',
-  ],
-  coverageReporters: [
-    'text-summary',
-    'html',
-    'lcovonly'
-  ],
-  coverageThreshold: {
-    global: {
-      branches: 100,
-      functions: 100,
-      lines: 100,
-      statements: 100
-    }
-  },
-  resolver: './jest.resolver.js'
-};

package/packages/lambda/jest.resolver.js

@@ -1,17 +0,0 @@
-// https://github.com/cloudflare/miniflare/issues/271#issuecomment-1255544333
-//
-// the uuid package says that it fixed this in v9 here https://github.com/uuidjs/uuid/pull/616#issuecomment-1237428554
-// but i tired it and was still getting the error. try removing this hack in the future and
-// see if it got figured out.
-module.exports = (path, options) => {
-  return options.defaultResolver(path, {
-    ...options,
-    packageFilter: pkg => {
-      if (pkg.name === 'uuid') {
-        delete pkg['exports'];
-        delete pkg['module'];
-      }
-      return pkg;
-    },
-  });
-};