? ArgumentsCamelCase : never
28 |
29 | // See http://stackoverflow.com/questions/51465182/how-to-remove-index-signature-using-mapped-types
30 | type RemoveIndex = {
31 | [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K]
32 | }
33 | /**
34 | * Given some Yargs Options function factory, extract the interface
35 | * that corresponds to the yargs arguments, remove index types, and only allow camelCase
36 | */
37 | export type StrictYargsOptionsToInterface Argv> = T extends (
38 | yargs: CommonYargsArgv
39 | ) => Argv
40 | ? RemoveIndex>
41 | : never
42 |
43 | export interface CommandProps {
44 | yargs: Argv
45 | argv: string[]
46 | cwd: string
47 | }
48 |
--------------------------------------------------------------------------------
/site/src/css/menu.css:
--------------------------------------------------------------------------------
1 | .menu__list-item .menu__link:not(.menu__link--sublist-caret) {
2 | text-overflow: ellipsis;
3 | white-space: nowrap;
4 | max-width: 100%;
5 | overflow: hidden;
6 | display: flex !important;
7 | }
8 |
9 | .menu__link,
10 | .menu__caret {
11 | border-radius: 0;
12 | }
13 |
14 | .menu__list-item:not(:first-child) {
15 | margin-top: 1rem;
16 | }
17 |
18 | .theme-doc-sidebar-item-category-level-1 > .menu__list,
19 | .theme-doc-sidebar-item-category-level-2 > .menu__list {
20 | margin-top: 0.5rem;
21 | }
22 |
23 | .theme-doc-sidebar-item-category-level-1 > .menu__list-item-collapsible .menu__link:hover,
24 | .theme-doc-sidebar-item-category-level-1 > .menu__list-item-collapsible .menu__link--active,
25 | .menu__link:not([href]) {
26 | color: var(--ifm-color-content-inverse);
27 |
28 | --ifm-menu-color-background: var(--nirrius-red-dark);
29 | --ifm-menu-color-background-hover: var(--nirrius-red-base) !important;
30 | --ifm-menu-border-color: var(--nirrius-green-light);
31 | --nirrius-shadow: var(--nirrius-red-dark);
32 |
33 | transform: none;
34 | opacity: 0.5;
35 | z-index: 1;
36 | }
37 |
38 | .menu__list-item-collapsible .menu__link:hover,
39 | .menu__link:not([href]):hover {
40 | background-color: var(--ifm-menu-color-background-hover) !important;
41 | opacity: 1;
42 | }
43 |
44 | .menu__link:not([href]):hover {
45 | --ifm-menu-color-background-hover: var(--nirrius-red-dark) !important;
46 |
47 | opacity: 0.5 !important;
48 | }
49 |
50 | .menu__list-item-collapsible--active {
51 | background-color: unset;
52 | }
53 |
54 | .menu__list-item--collapsed .menu__list {
55 | display: none !important;
56 | overflow: unset !important;
57 | }
58 |
59 | .menu__list {
60 | overflow: unset !important;
61 | height: auto !important;
62 | }
63 |
64 |
--------------------------------------------------------------------------------
/utils/constants.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * @file This file is part of the Keywork project.
3 | * @copyright Nirrius, LLC. All rights reserved.
4 | * @author Teffen Ellis, et al.
5 | * @license AGPL-3.0
6 | *
7 | * @remarks Keywork is free software for non-commercial purposes.
8 | * You can be released from the requirements of the license by purchasing a commercial license.
9 | * Buying such a license is mandatory as soon as you develop commercial activities
10 | * involving the Keywork software without disclosing the source code of your own applications.
11 | *
12 | * @see LICENSE.md in the project root for further licensing information.
13 | */
14 |
15 | /**
16 | * The default ID assigned to the React root element.
17 | *
18 | * ```tsx
19 | * {children}
20 | * ```
21 | * @ignore
22 | */
23 | export const KEYWORK_APP_ROOT = 'app-root'
24 |
25 | /**
26 | * The default ID assigned to the React root style element.
27 | *
28 | * ```tsx
29 | * {children}
30 | * ```
31 | * @ignore
32 | */
33 | export const KEYWORK_STYLE_ROOT = 'style-root'
34 |
35 | export type KeyworkSSRPropsKey = ':KeyworkSSRProps:'
36 |
37 | /**
38 | * The global key where the SSR props are assigned.
39 | * This includes a ':' character to prevent `document.querySelector` from matching this key.
40 | * @internal
41 | */
42 | export const KEYWORK_SSR_PROPS_KEY: KeyworkSSRPropsKey = ':KeyworkSSRProps:'
43 |
44 | export type KeyworkSSRInitKey = ':KeyworkSSREventInit:'
45 |
46 | /**
47 | * The global key where the SSR event init is assigned.
48 | * This includes a ':' character to prevent `document.querySelector` from matching this key.
49 | * @internal
50 | */
51 | export const KEYWORK_SSR_INIT_KEY: KeyworkSSRInitKey = ':KeyworkSSREventInit:'
52 |
--------------------------------------------------------------------------------
/http/responses/HTMLResponse.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * @file This file is part of the Keywork project.
3 | * @copyright Nirrius, LLC. All rights reserved.
4 | * @author Teffen Ellis, et al.
5 | * @license AGPL-3.0
6 | *
7 | * @remarks Keywork is free software for non-commercial purposes.
8 | * You can be released from the requirements of the license by purchasing a commercial license.
9 | * Buying such a license is mandatory as soon as you develop commercial activities
10 | * involving the Keywork software without disclosing the source code of your own applications.
11 | *
12 | * @see LICENSE.md in the project root for further licensing information.
13 | */
14 |
15 | import { CacheControlDirectives, fileExtensionToContentTypeHeader } from '../../http/headers/index.js'
16 | import { CachableResponse } from './CachableResponse.js'
17 |
18 | /**
19 | * A response that returns a full HTML document.
20 | *
21 | * `HTMLResponse` automatically handles several types of HTML response bodies.
22 | *
23 | * @see {JSXResponse}
24 | * @category HTTP Response
25 | * @public
26 | */
27 | export class HTMLResponse extends CachableResponse {
28 | constructor(
29 | /**
30 | * A string containing a full HTML document, or a readable stream.
31 | */
32 | htmlLike: BodyInit,
33 | /** An optional request to check for etag headers. */
34 | request?: Request,
35 | /** An optional etag for the given `json` parameter. */
36 | etag?: string,
37 | /** Options to generate a cache control header. */
38 | cacheControlOptions?: CacheControlDirectives,
39 | /** Headers to add to the response. */
40 | headersInit?: HeadersInit
41 | ) {
42 | super(htmlLike, request, etag, cacheControlOptions, {
43 | ...fileExtensionToContentTypeHeader('html'),
44 | ...headersInit,
45 | })
46 | }
47 | }
48 |
--------------------------------------------------------------------------------
/site/src/css/fonts.css:
--------------------------------------------------------------------------------
1 | @font-face {
2 | font-family: Go;
3 | font-style: normal;
4 | font-weight: normal;
5 | src: url('/fonts/go/Go-Regular.ttf') format('truetype');
6 | }
7 |
8 | @font-face {
9 | font-family: Go;
10 | font-style: italic;
11 | font-weight: normal;
12 | src: url('/fonts/go/Go-Italic.ttf') format('truetype');
13 | }
14 |
15 | @font-face {
16 | font-family: Go;
17 | font-style: normal;
18 | font-weight: bold;
19 | src: url('/fonts/go/Go-Bold.ttf') format('truetype');
20 | }
21 |
22 | @font-face {
23 | font-family: Go;
24 | font-style: italic;
25 | font-weight: bold;
26 | src: url('/fonts/go/Go-Bold-Italic.ttf') format('truetype');
27 | }
28 |
29 | @font-face {
30 | font-family: Go;
31 | font-style: normal;
32 | font-weight: medium;
33 | src: url('/fonts/go/Go-Medium.ttf') format('truetype');
34 | }
35 |
36 | @font-face {
37 | font-family: Go;
38 | font-style: italic;
39 | font-weight: medium;
40 | src: url('/fonts/go/Go-Medium-Italic.ttf') format('truetype');
41 | }
42 |
43 | /*
44 | @font-face {
45 | font-family: 'Go Mono';
46 | font-style: normal;
47 | font-weight: normal;
48 | src: local('Go Mono'), url('/fonts/go/Go-Mono.ttf') format('truetype');
49 | }
50 |
51 | @font-face {
52 | font-family: 'Go Mono';
53 | font-style: italic;
54 | font-weight: normal;
55 | src: local('Go Mono'), url('/fonts/go/Go-Mono-Italic.ttf') format('truetype');
56 | }
57 |
58 | @font-face {
59 | font-family: 'Go Mono';
60 | font-style: normal;
61 | font-weight: bold;
62 | src: local('Go Mono'), url('/fonts/go/Go-Mono-Bold.ttf') format('truetype');
63 | }
64 |
65 | @font-face {
66 | font-family: 'Go Mono';
67 | font-style: italic;
68 | font-weight: bold;
69 | src: local('Go Mono'), url('/fonts/go/Go-Mono-Bold-Italic.ttf') format('truetype');
70 | } */
71 |
--------------------------------------------------------------------------------
/client/animation.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * @file This file is part of the Keywork project.
3 | * @copyright Nirrius, LLC. All rights reserved.
4 | * @author Teffen Ellis, et al.
5 | * @license AGPL-3.0
6 | *
7 | * @remarks Keywork is free software for non-commercial purposes.
8 | * You can be released from the requirements of the license by purchasing a commercial license.
9 | * Buying such a license is mandatory as soon as you develop commercial activities
10 | * involving the Keywork software without disclosing the source code of your own applications.
11 | *
12 | * @see LICENSE.md in the project root for further licensing information.
13 | */
14 |
15 | import { readGlobalScope } from '../utils/index.js'
16 |
17 | /** @internal */
18 | type FrameRequestCallbackFn = (timestamp: number) => unknown
19 |
20 | /** @internal */
21 | type RequestAnimationFrameFn = (callback: FrameRequestCallbackFn) => number
22 |
23 | /** @internal */
24 | interface AnimationFramer {
25 | requestAnimationFrame: RequestAnimationFrameFn
26 | }
27 |
28 | /**
29 | * Predicate function to determine if the given object can invoke `requestAnimationFrame`
30 | * @internal
31 | */
32 | export function isAnimationFramer(windowOrGlobal: any = readGlobalScope()): windowOrGlobal is AnimationFramer {
33 | return typeof windowOrGlobal.requestAnimationFrame === 'function'
34 | }
35 |
36 | /**
37 | * Promise wrapper around `requestAnimationFrame`
38 | */
39 | export function requestAnimationFramePromise(windowOrGlobal: any = readGlobalScope()): Promise {
40 | return new Promise((resolve) => {
41 | if (!isAnimationFramer(windowOrGlobal)) {
42 | setTimeout(() => resolve(-1), 1)
43 | return
44 | }
45 |
46 | const frameNumber = windowOrGlobal.requestAnimationFrame(() => {
47 | resolve(frameNumber)
48 | })
49 | })
50 | }
51 |
--------------------------------------------------------------------------------
/docs/getting-started/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: install
3 | title: Install
4 | sidebar_position: 0
5 | sidebar_label: Quick Start
6 | ---
7 |
8 | import Tabs from '@theme/Tabs'
9 | import TabItem from '@theme/TabItem'
10 |
11 | The Keywork library is framework agnostic, modular,
12 | and compatible with Cloudflare Workers, Deno, and Node.js.
13 |
14 | ## Creating a new app from scratch
15 |
16 | If you're using Cloudflare, or would like to start from a template,
17 | checkout the [Keywork Starter Kit](https://github.com/sister-software/keywork-starter-kit).
18 | The kit includes support for React, TypeScript, and ESBuild.
19 |
20 | ## Adding Keywork to your existing codebase
21 |
22 | Keywork is often added to an existing web app when a developer wants to migrate
23 | their deployment to a V8 Isolate runtime, such as Cloudflare Workers or Deno.
24 |
25 |
26 |
27 |
28 | Let's start by adding Keywork to your project via [Yarn](https://yarnpkg.com/):
29 |
30 | ```shell title="Run in the root of your project."
31 | $ yarn add keywork
32 | ```
33 |
34 |
35 |
36 |
37 |
38 | Let's start by adding Keywork to your project via NPM:
39 |
40 | ```shell title="Run in the root of your project."
41 | $ npm install keywork
42 | ```
43 |
44 |
45 |
46 |
47 |
48 | ### If your app uses React...
49 |
50 | You'll need additional peer dependencies:
51 |
52 |
53 |
54 |
55 |
56 | ```shell title="Run in the root of your project."
57 | $ npm install --save react react-dom
58 | ```
59 |
60 |
61 |
62 |
63 |
64 | ```shell title="Run in the root of your project."
65 | $ yarn add react react-dom
66 | ```
67 |
68 |
69 |
70 |
--------------------------------------------------------------------------------
/http/index.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * Keywork includes utilities for working with incoming HTTP requests,
3 | * and extends the native [`Request` class](https://developer.mozilla.org/en-US/docs/Web/API/Request)
4 | * for use with [Cloudflare Workers](https://developers.cloudflare.com/workers/runtime-apis/request/#requestinitcfproperties)
5 | *
6 | * See each of HTTP's submodules for additional details.
7 | *
8 | * @packageDocumentation
9 | * @module Keywork#HTTP
10 | *
11 | * @file This file is part of the Keywork project.
12 | * @copyright Nirrius, LLC. All rights reserved.
13 | * @author Teffen Ellis, et al.
14 | * @license AGPL-3.0
15 | *
16 | * @remarks Keywork is free software for non-commercial purposes.
17 | * You can be released from the requirements of the license by purchasing a commercial license.
18 | * Buying such a license is mandatory as soon as you develop commercial activities
19 | * involving the Keywork software without disclosing the source code of your own applications.
20 | *
21 | * @see LICENSE.md in the project root for further licensing information.
22 | */
23 | /* eslint-disable header/header */
24 |
25 | export * from './HTTPMethod.js'
26 | export * from './IncomingRequestCfProperties.js'
27 | export * from './RequestContext.js'
28 | export * from './RouterMethod.js'
29 | export * from './accepts.js'
30 | export * from './castToResponse.js'
31 | export * from './cloneAsMutableResponse.js'
32 | export * from './cors.js'
33 | export * from './headers/index.js'
34 | export * from './isCompressable.js'
35 | export * from './isInstanceOfRequest.js'
36 | export * from './isInstanceOfResponse.js'
37 | export * from './isRequestLike.js'
38 | export * from './methodVerbToRouterMethod.js'
39 | export * from './responses/index.js'
40 | export * from './routerMethodToHTTPMethod.js'
41 | export * from './shouldCompress.js'
42 |
--------------------------------------------------------------------------------
/site/src/theme/DocPage/Layout/index.tsx:
--------------------------------------------------------------------------------
1 | /**
2 | * @file This file is part of the Keywork project.
3 | * @copyright Nirrius, LLC. All rights reserved.
4 | * @author Teffen Ellis, et al.
5 | * @license AGPL-3.0
6 | *
7 | * @remarks Keywork is free software for non-commercial purposes.
8 | * You can be released from the requirements of the license by purchasing a commercial license.
9 | * Buying such a license is mandatory as soon as you develop commercial activities
10 | * involving the Keywork software without disclosing the source code of your own applications.
11 | *
12 | * @see LICENSE.md in the project root for further licensing information.
13 | */
14 |
15 | // @ts-expect-error internal
16 | import { useDocsSidebar } from '@docusaurus/theme-common/internal'
17 | import BackToTopButton from '@theme/BackToTopButton'
18 | import DocPageLayoutMain from '@theme/DocPage/Layout/Main'
19 | import DocPageLayoutSidebar from '@theme/DocPage/Layout/Sidebar'
20 | import Layout from '@theme/Layout'
21 | import React, { useState } from 'react'
22 | import styles from './styles.module.css'
23 |
24 | export default function DocPageLayout({ children }) {
25 | const sidebar = useDocsSidebar()
26 | const [hiddenSidebarContainer, setHiddenSidebarContainer] = useState(false)
27 | return (
28 |
29 |
30 |
31 | {sidebar && (
32 |
37 | )}
38 | {children}
39 |
40 |
41 | )
42 | }
43 |
--------------------------------------------------------------------------------
/site/src/theme/Heading/index.tsx:
--------------------------------------------------------------------------------
1 | /**
2 | * @file This file is part of the Keywork project.
3 | * @copyright Nirrius, LLC. All rights reserved.
4 | * @author Teffen Ellis, et al.
5 | * @license AGPL-3.0
6 | *
7 | * @remarks Keywork is free software for non-commercial purposes.
8 | * You can be released from the requirements of the license by purchasing a commercial license.
9 | * Buying such a license is mandatory as soon as you develop commercial activities
10 | * involving the Keywork software without disclosing the source code of your own applications.
11 | *
12 | * @see LICENSE.md in the project root for further licensing information.
13 | */
14 |
15 | import { useThemeConfig } from '@docusaurus/theme-common'
16 | import { translate } from '@docusaurus/Translate'
17 | import clsx from 'clsx'
18 | import React from 'react'
19 | import styles from './styles.module.css'
20 |
21 | export default function Heading({ as: As, id, ...props }) {
22 | const {
23 | navbar: { hideOnScroll },
24 | } = useThemeConfig()
25 | // H1 headings do not need an id because they don't appear in the TOC.
26 | if (As === 'h1' || !id) {
27 | return
28 | }
29 | return (
30 |
39 | {props.children}
40 |
49 |
50 |
51 |
52 | )
53 | }
54 |
--------------------------------------------------------------------------------
/node/createServerHandler.test.tsx:
--------------------------------------------------------------------------------
1 | /**
2 | * @file This file is part of the Keywork project.
3 | * @copyright Nirrius, LLC. All rights reserved.
4 | * @author Teffen Ellis, et al.
5 | * @license AGPL-3.0
6 | *
7 | * @remarks Keywork is free software for non-commercial purposes.
8 | * You can be released from the requirements of the license by purchasing a commercial license.
9 | * Buying such a license is mandatory as soon as you develop commercial activities
10 | * involving the Keywork software without disclosing the source code of your own applications.
11 | *
12 | * @see LICENSE.md in the project root for further licensing information.
13 | */
14 |
15 | import * as http from 'node:http'
16 | import { KeyworkLogLevel, KeyworkLogger } from '../logging/index.js'
17 | import { RequestRouter } from '../router/index.js'
18 | import { createNodeServerHandler } from './createServerHandler.js'
19 | import { applyNodeKeyworkPolyfills } from './polyfills.js'
20 |
21 | await applyNodeKeyworkPolyfills()
22 |
23 | const logger = new KeyworkLogger('Test Server')
24 |
25 | // Create a router as you usually do...
26 | const router = new RequestRouter({
27 | logLevel: KeyworkLogLevel.Debug,
28 | })
29 | router.get('/', () => 'Hello from Node')
30 |
31 | // And then wrap the router with `createServerHandler`
32 | const server = http.createServer(createNodeServerHandler(router))
33 |
34 | const host = process.env.KEYWORK_HOST || 'localhost'
35 | const port = process.env.KEYWORK_PORT || '8080'
36 |
37 | const serverURL = new URL(`http://${host}:${port}`)
38 |
39 | logger.info('Starting server...')
40 |
41 | server.listen(parseInt(serverURL.port, 10), serverURL.hostname, () => {
42 | logger.info(`Listening on ${serverURL}`)
43 | })
44 |
45 | process.on('SIGINT', () => {
46 | router.dispose('Server is shutting down...')
47 | server.close()
48 | })
49 |
--------------------------------------------------------------------------------
/docs/THIRD_PARTY_NOTICES.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Acknowledgements
3 | sidebar_label: Third Party Notices
4 | id: third-party-notices
5 | ---
6 |
7 | Keywork is distributed under the [AGPL-3.0 license](https://www.gnu.org/licenses/agpl-3.0.html),
8 | and is made possible through the countless contributions of the open-source community.
9 |
10 | ## Third Party Notices
11 |
12 | Keywork includes or partly uses code from the following open source software
13 | subject to the following open source licenses.
14 |
15 | ### MDN Web Docs
16 |
17 | Keywork includes documentation and examples from [MDN](https://developer.mozilla.org//en-US/docs/MDN/About)
18 | by [Mozilla Contributors](https://developer.mozilla.org//en-US/docs/MDN/About/contributors.txt),
19 | and is licensed under [CC-BY-SA 2.5](https://creativecommons.org/licenses/by-sa/2.5/).
20 |
21 | ### TypeDoc
22 |
23 | Keywork uses [TypeDoc](https://typedoc.org) and the [TypeDoc Markdown Plugin](https://github.com/tgreyuk/typedoc-plugin-markdown) to generate documentation.
24 |
25 | ### Miniflare
26 |
27 | Keywork uses [Miniflare](https://miniflare.dev/), a simulator for developing and testing Cloudflare Workers.
28 | It's written in TypeScript, and runs your code in a sandbox implementing Workers' runtime APIs.
29 | Miniflare is licensed under [MIT](https://github.com/cloudflare/miniflare/blob/master/LICENSE)
30 |
31 | ## A special thanks to...
32 |
33 | - MrBBot and the developers of [Miniflare](https://miniflare.dev/)
34 | - The folks at [Cloudflare](https://cloudflare.com) and the Workers team 💞
35 | - The visionaries at [Deno](https://deno.land) for all their inspiration
36 | - The brilliant engineers and maintainers of [code-server](https://github.com/coder/code-server)
37 | - And [all the wonderful people](https://github.com/sister-software/keywork/graphs/contributors) who've contributed to Keywork
38 |
--------------------------------------------------------------------------------
/middleware/SessionMiddleware.test.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * @file This file is part of the Keywork project.
3 | * @copyright Nirrius, LLC. All rights reserved.
4 | * @author Teffen Ellis, et al.
5 | * @license AGPL-3.0
6 | *
7 | * @remarks Keywork is free software for non-commercial purposes.
8 | * You can be released from the requirements of the license by purchasing a commercial license.
9 | * Buying such a license is mandatory as soon as you develop commercial activities
10 | * involving the Keywork software without disclosing the source code of your own applications.
11 | *
12 | * @see LICENSE.md in the project root for further licensing information.
13 | */
14 |
15 | import { Deno } from '@deno/shim-deno'
16 | import { parse as parseCookies } from 'cookie'
17 | import { CookieHeaders } from '../http/index.js'
18 | import { RequestRouter } from '../router/index.js'
19 | import { assert, assertEquals } from '../testing/index.js'
20 | import { SessionMiddleware } from './SessionMiddleware.js'
21 |
22 | Deno.test('Session Middleware', async () => {
23 | const sessionMiddleware = new SessionMiddleware()
24 | const app = new RequestRouter({
25 | displayName: 'Session Tester',
26 | middleware: [sessionMiddleware],
27 | })
28 |
29 | app.get('/', (event) => {
30 | const url = new URL(event.request.url)
31 |
32 | return `Hello from ${url.pathname}`
33 | })
34 |
35 | const rootResponse = await app.fetch(new Request('http://localhost/'))
36 | assertEquals(await rootResponse.text(), `Hello from /`, 'Response has body')
37 |
38 | // @ts-ignore Type annotation
39 | const cookieDough = rootResponse.headers.get('Set-Cookie')!
40 |
41 | assert(cookieDough, 'Request has cookie')
42 | const cookies = parseCookies(cookieDough)
43 |
44 | assert(cookies[sessionMiddleware.cookieKey], 'Cookies have session ID')
45 | })
46 |
--------------------------------------------------------------------------------
/examples/simple/_worker.tsx:
--------------------------------------------------------------------------------
1 | /**
2 | * @file This file is part of the Keywork project.
3 | * @copyright Nirrius, LLC. All rights reserved.
4 | * @author Teffen Ellis, et al.
5 | * @license AGPL-3.0
6 | *
7 | * @remarks Keywork is free software for non-commercial purposes.
8 | * You can be released from the requirements of the license by purchasing a commercial license.
9 | * Buying such a license is mandatory as soon as you develop commercial activities
10 | * involving the Keywork software without disclosing the source code of your own applications.
11 | *
12 | * @see LICENSE.md in the project root for further licensing information.
13 | */
14 |
15 | import { KeyworkResourceError, RequestRouter } from 'keywork'
16 | import { TodoItemPageProps } from './public/pages/TodoItem.js'
17 |
18 | const router = new RequestRouter({
19 | document: {
20 | title: 'Keywork example app',
21 | themeColor: '#65b9e2',
22 | },
23 | })
24 |
25 | router.get('/', ({ document }) => {
26 | document.author = 'Teffen Ellis'
27 |
28 | return {
29 | renderTimestamp: new Date().toISOString(),
30 | }
31 | })
32 |
33 | const mockTodos = new Map([
34 | [
35 | '1',
36 | {
37 | id: '1',
38 | title: 'Todo 1',
39 | completed: false,
40 | },
41 | ],
42 | [
43 | '2',
44 | {
45 | id: '2',
46 | title: 'Todo 2',
47 | completed: false,
48 | },
49 | ],
50 | [
51 | '3',
52 | {
53 | id: '3',
54 | title: 'Todo 3',
55 | completed: true,
56 | },
57 | ],
58 | ])
59 |
60 | router.get<{ id: string }>('/todo/:id', ({ params }) => {
61 | const todo = mockTodos.get(params.id)
62 |
63 | if (!todo) {
64 | return new KeyworkResourceError(`Todo ${params.id} not found`, 404)
65 | }
66 |
67 | return todo
68 | })
69 |
70 | export default router
71 |
--------------------------------------------------------------------------------
/docgen/utils/front-matter.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * @file This file is part of the Keywork project.
3 | * @copyright Nirrius, LLC. All rights reserved.
4 | * @author Teffen Ellis, et al.
5 | * @license AGPL-3.0
6 | *
7 | * @remarks Keywork is free software for non-commercial purposes.
8 | * You can be released from the requirements of the license by purchasing a commercial license.
9 | * Buying such a license is mandatory as soon as you develop commercial activities
10 | * involving the Keywork software without disclosing the source code of your own applications.
11 | *
12 | * @see LICENSE.md in the project root for further licensing information.
13 | */
14 |
15 | import Handlebars from 'handlebars'
16 | import { PageEvent } from 'typedoc'
17 |
18 | export interface FrontMatterVars {
19 | [key: string]: string | number | boolean
20 | }
21 |
22 | /**
23 | * Prepends YAML block to a string
24 | * @param contents - the string to prepend
25 | * @param vars - object of required front matter variables
26 | */
27 | export const prependYAML = (contents: string, vars: FrontMatterVars) => {
28 | return contents.replace(/^/, toYAML(vars) + '\n\n').replace(/[\r\n]{3,}/g, '\n\n')
29 | }
30 |
31 | /**
32 | * Returns the page title as rendered in the document h1(# title)
33 | * @param page
34 | */
35 | export const getPageTitle = (page: PageEvent) => {
36 | return Handlebars.helpers.reflectionTitle.call(page, false)
37 | }
38 |
39 | /**
40 | * Converts YAML object to a YAML string
41 | * @param vars
42 | */
43 | const toYAML = (vars: FrontMatterVars) => {
44 | const yaml = `---
45 | ${Object.entries(vars)
46 | .map(([key, value]) => `${key}: ${typeof value === 'string' ? `"${escapeString(value)}"` : value}`)
47 | .join('\n')}
48 | ---`
49 | return yaml
50 | }
51 |
52 | // prettier-ignore
53 | const escapeString=(str: string) => str.replace(/"/g, '\\"');
54 |
--------------------------------------------------------------------------------
/site/algolia.json:
--------------------------------------------------------------------------------
1 | {
2 | "settings": {
3 | "advancedSyntax": true,
4 | "allowTyposOnNumericTokens": false,
5 | "attributeCriteriaComputedByMinProximity": true,
6 | "attributeForDistinct": "url",
7 | "attributesForFaceting": [
8 | "type",
9 | "lang",
10 | "language",
11 | "version",
12 | "docusaurus_tag"
13 | ],
14 | "attributesToHighlight": [
15 | "hierarchy",
16 | "content"
17 | ],
18 | "attributesToRetrieve": [
19 | "hierarchy",
20 | "content",
21 | "anchor",
22 | "url",
23 | "url_without_anchor",
24 | "type"
25 | ],
26 | "attributesToSnippet": [
27 | "content:10"
28 | ],
29 | "camelCaseAttributes": [
30 | "hierarchy",
31 | "content"
32 | ],
33 | "customRanking": [
34 | "desc(weight.pageRank)",
35 | "desc(weight.level)",
36 | "asc(weight.position)"
37 | ],
38 | "distinct": true,
39 | "highlightPostTag": "",
40 | "highlightPreTag": "",
41 | "ignorePlurals": true,
42 | "minProximity": 1,
43 | "minWordSizefor1Typo": 3,
44 | "minWordSizefor2Typos": 7,
45 | "ranking": [
46 | "words",
47 | "filters",
48 | "typo",
49 | "attribute",
50 | "proximity",
51 | "exact",
52 | "custom"
53 | ],
54 | "removeWordsIfNoResults": "allOptional",
55 | "searchableAttributes": [
56 | "unordered(hierarchy.lvl0)",
57 | "unordered(hierarchy.lvl1)",
58 | "unordered(hierarchy.lvl2)",
59 | "unordered(hierarchy.lvl3)",
60 | "unordered(hierarchy.lvl4)",
61 | "unordered(hierarchy.lvl5)",
62 | "unordered(hierarchy.lvl6)",
63 | "content"
64 | ],
65 | "separatorsToIndex": "_"
66 | },
67 | "rules": [],
68 | "synonyms": []
69 | }
70 |
--------------------------------------------------------------------------------
/http/IncomingRequestCfProperties.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * @file This file is part of the Keywork project.
3 | * @copyright Nirrius, LLC. All rights reserved.
4 | * @author Teffen Ellis, et al.
5 | * @license AGPL-3.0
6 | *
7 | * @remarks Keywork is free software for non-commercial purposes.
8 | * You can be released from the requirements of the license by purchasing a commercial license.
9 | * Buying such a license is mandatory as soon as you develop commercial activities
10 | * involving the Keywork software without disclosing the source code of your own applications.
11 | *
12 | * @see LICENSE.md in the project root for further licensing information.
13 | */
14 |
15 | /** @ignore */
16 | export interface IncomingRequestCfProperties {
17 | asn: number
18 | botManagement?: IncomingRequestCfPropertiesBotManagement
19 | city?: string
20 | clientTcpRtt: number
21 | clientTrustScore?: number
22 | colo: string
23 | continent?: string
24 | country: string
25 | httpProtocol: string
26 | latitude?: string
27 | longitude?: string
28 | metroCode?: string
29 | postalCode?: string
30 | region?: string
31 | regionCode?: string
32 | requestPriority: string
33 | timezone?: string
34 | tlsVersion: string
35 | tlsCipher: string
36 | tlsClientAuth: IncomingRequestCfPropertiesTLSClientAuth
37 | }
38 |
39 | /** @ignore */
40 | export interface IncomingRequestCfPropertiesBotManagement {
41 | score: number
42 | staticResource: boolean
43 | verifiedBot: boolean
44 | }
45 |
46 | /** @ignore */
47 | export interface IncomingRequestCfPropertiesTLSClientAuth {
48 | certIssuerDNLegacy: string
49 | certIssuerDN: string
50 | certPresented: '0' | '1'
51 | certSubjectDNLegacy: string
52 | certSubjectDN: string
53 | certNotBefore: string
54 | certNotAfter: string
55 | certSerial: string
56 | certFingerprintSHA1: string
57 | certVerified: string
58 | }
59 |
--------------------------------------------------------------------------------
/docgen/helpers/comments.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * @file This file is part of the Keywork project.
3 | * @copyright Nirrius, LLC. All rights reserved.
4 | * @author Teffen Ellis, et al.
5 | * @license AGPL-3.0
6 | *
7 | * @remarks Keywork is free software for non-commercial purposes.
8 | * You can be released from the requirements of the license by purchasing a commercial license.
9 | * Buying such a license is mandatory as soon as you develop commercial activities
10 | * involving the Keywork software without disclosing the source code of your own applications.
11 | *
12 | * @see LICENSE.md in the project root for further licensing information.
13 | */
14 |
15 | import Handlebars from 'handlebars'
16 | import { Comment } from 'typedoc'
17 | import { camelToTitleCase } from '../utils/index.js'
18 |
19 | export function commentsHelper() {
20 | Handlebars.registerHelper('comments', function (comment: Comment, includeHTMLWrappers = true) {
21 | const md: string[] = []
22 | const blockTags = comment.blockTags?.filter((tag) => tag.tag !== '@returns') || []
23 |
24 | if (comment.summary && includeHTMLWrappers) {
25 | md.push(
26 | //
27 | ``,
28 | Handlebars.helpers.comment(comment.summary),
29 | '
'
30 | )
31 | }
32 |
33 | for (const tag of blockTags) {
34 | const tagID = tag.tag.slice(1)
35 | const tagName = camelToTitleCase(tagID)
36 |
37 | if (includeHTMLWrappers) {
38 | md.push(
39 | `#### ${tagName}`,
40 | ``,
41 | Handlebars.helpers.comment(tag.content),
42 | '
'
43 | )
44 | } else {
45 | md.push(`**\`${tagName}\`**\n\n${Handlebars.helpers.comment(tag.content)}`)
46 | }
47 | }
48 |
49 | return md.join('\n\n')
50 | })
51 | }
52 |
--------------------------------------------------------------------------------
/docgen/helpers/index.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * @file This file is part of the Keywork project.
3 | * @copyright Nirrius, LLC. All rights reserved.
4 | * @author Teffen Ellis, et al.
5 | * @license AGPL-3.0
6 | *
7 | * @remarks Keywork is free software for non-commercial purposes.
8 | * You can be released from the requirements of the license by purchasing a commercial license.
9 | * Buying such a license is mandatory as soon as you develop commercial activities
10 | * involving the Keywork software without disclosing the source code of your own applications.
11 | *
12 | * @see LICENSE.md in the project root for further licensing information.
13 | */
14 |
15 | export * from './attemptExternalResolution.js'
16 | export * from './breadcrumbs.js'
17 | export * from './comment.js'
18 | export * from './comments.js'
19 | export * from './declaration-title.js'
20 | export * from './escape.js'
21 | export * from './frontmatter.js'
22 | export * from './hierarchy.js'
23 | export * from './humanizeReflectionName.js'
24 | export * from './if-is-reference.js'
25 | export * from './if-named-anchors.js'
26 | export * from './if-show-breadcrumbs.js'
27 | export * from './if-show-named-anchors.js'
28 | export * from './if-show-page-title.js'
29 | export * from './if-show-returns.js'
30 | export * from './if-show-type-hierarchy.js'
31 | export * from './index-signature-title.js'
32 | export * from './index.js'
33 | export * from './parameter-table.js'
34 | export * from './property-table.js'
35 | export * from './reference-member.js'
36 | export * from './reflection-path.js'
37 | export * from './reflection-title.js'
38 | export * from './relative-url.js'
39 | export * from './returns.js'
40 | export * from './signature-title.js'
41 | export * from './toc.js'
42 | export * from './type-and-parent.js'
43 | export * from './type-parameter-table.js'
44 | export * from './type.js'
45 | export * from './usage-tabs.js'
46 |
--------------------------------------------------------------------------------
/utils/map.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * @file This file is part of the Keywork project.
3 | * @copyright Nirrius, LLC. All rights reserved.
4 | * @author Teffen Ellis, et al.
5 | * @license AGPL-3.0
6 | *
7 | * @remarks Keywork is free software for non-commercial purposes.
8 | * You can be released from the requirements of the license by purchasing a commercial license.
9 | * Buying such a license is mandatory as soon as you develop commercial activities
10 | * involving the Keywork software without disclosing the source code of your own applications.
11 | *
12 | * @see LICENSE.md in the project root for further licensing information.
13 | */
14 |
15 | /**
16 | * @see {@linkcode ImmutableMap}
17 | *
18 | * @internal
19 | */
20 | export type ImmutableMapLike = Omit, 'set' | 'clear' | 'delete'>
21 |
22 | interface ImmutableMapConstructor {
23 | new (): ImmutableMapLike
24 | new (entries?: readonly (readonly [K, V])[] | null): ImmutableMapLike
25 | readonly prototype: ImmutableMapLike
26 | }
27 |
28 | const NativeMap = Map as ImmutableMapConstructor
29 |
30 | /**
31 | * A variant of the native Map class, constructed from an array of key-value pairs.
32 | *
33 | * This is useful when you want to create a map from a list of key-value pairs but
34 | * want to avoid type-checking when getting values from the map.
35 | */
36 | export class ImmutableMap extends NativeMap {
37 | public override get = (key: K): V => {
38 | if (!super.has(key)) {
39 | throw new Error(`Key ${key} not found in readonly map.`)
40 | }
41 |
42 | return super.get(key)!
43 | }
44 |
45 | protected clear(): void {
46 | throw new Error('Attempted to invoke `clear` on readonly Map.')
47 | }
48 |
49 | protected delete(_key: K): boolean {
50 | throw new Error('Attempted to invoke `delete` on readonly Map.')
51 | }
52 | }
53 |
--------------------------------------------------------------------------------
/node/index.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * The {@link Keywork#Router.RequestRouter `RequestRouter`}
3 | * can be made compatible with Node.js
4 | * via the {@link Keywork#Router#Node.createServerHandler `createServerHandler`} wrapper function:
5 | *
6 | * ```ts showLineNumbers
7 | * import * as http from 'node:http'
8 | * import { RequestRouter } from './router/index.js'
9 | * import { createServerHandler } from './router/node/index.js'
10 | *
11 | * // Create a router as you usually do...
12 | * // highlight-next-line
13 | * const router = new RequestRouter()
14 | * router.get('/', () => 'Hello from Node')
15 | *
16 | * // And then wrap the router with `createServerHandler`
17 | * // highlight-next-line
18 | * http.createServer(createServerHandler(router))
19 | * ```
20 | *
21 | * :::caution
22 | * Node support is currently experimental and may change in the near future.
23 | * :::
24 | *
25 | * @packageDocumentation
26 | * @module Keywork#Router#Node
27 | * @tag Node
28 | * @tag Routing
29 | * @file This file is part of the Keywork project.
30 | * @copyright Nirrius, LLC. All rights reserved.
31 | * @author Teffen Ellis, et al.
32 | * @license AGPL-3.0
33 | *
34 | * @remarks Keywork is free software for non-commercial purposes.
35 | * You can be released from the requirements of the license by purchasing a commercial license.
36 | * Buying such a license is mandatory as soon as you develop commercial activities
37 | * involving the Keywork software without disclosing the source code of your own applications.
38 | *
39 | * @see LICENSE.md in the project root for further licensing information.
40 | */
41 | /* eslint-disable header/header */
42 |
43 | export * from './createServerHandler.js'
44 | export * from './files.js'
45 | export * from './import-map.js'
46 | export * from './paths.js'
47 | export * from './polyfills.js'
48 | export * from './respondWithRouter.js'
49 | export * from './static.js'
50 |
--------------------------------------------------------------------------------
/docgen/theme/navigation-item.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * @file This file is part of the Keywork project.
3 | * @copyright Nirrius, LLC. All rights reserved.
4 | * @author Teffen Ellis, et al.
5 | * @license AGPL-3.0
6 | *
7 | * @remarks Keywork is free software for non-commercial purposes.
8 | * You can be released from the requirements of the license by purchasing a commercial license.
9 | * Buying such a license is mandatory as soon as you develop commercial activities
10 | * involving the Keywork software without disclosing the source code of your own applications.
11 | *
12 | * @see LICENSE.md in the project root for further licensing information.
13 | */
14 |
15 | import { Reflection } from 'typedoc'
16 |
17 | export class NavigationItem {
18 | title: string
19 | url: string
20 | dedicatedUrls?: string[]
21 | parent?: NavigationItem
22 | children?: NavigationItem[]
23 | isLabel?: boolean
24 | isVisible?: boolean
25 | isCurrent?: boolean
26 | isModules?: boolean
27 | isInPath?: boolean
28 | reflection?: Reflection
29 |
30 | constructor(title?: string, url?: string, parent?: NavigationItem, reflection?: Reflection) {
31 | this.title = title || ''
32 | this.url = url || ''
33 | this.parent = parent
34 | this.reflection = reflection
35 |
36 | if (!url) {
37 | this.isLabel = true
38 | }
39 |
40 | if (this.parent) {
41 | if (!this.parent.children) {
42 | this.parent.children = []
43 | }
44 | this.parent.children.push(this)
45 | }
46 | }
47 |
48 | static create(reflection: Reflection, parent?: NavigationItem, useShortNames?: boolean) {
49 | let name: string
50 | if (useShortNames || (parent && parent.parent)) {
51 | name = reflection.name
52 | } else {
53 | name = reflection.getFullName()
54 | }
55 |
56 | name = name.trim()
57 |
58 | return new NavigationItem(name, reflection.url, parent, reflection)
59 | }
60 | }
61 |
--------------------------------------------------------------------------------
/router/createRouteRedirect.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * @file This file is part of the Keywork project.
3 | * @copyright Nirrius, LLC. All rights reserved.
4 | * @author Teffen Ellis, et al.
5 | * @license AGPL-3.0
6 | *
7 | * @remarks Keywork is free software for non-commercial purposes.
8 | * You can be released from the requirements of the license by purchasing a commercial license.
9 | * Buying such a license is mandatory as soon as you develop commercial activities
10 | * involving the Keywork software without disclosing the source code of your own applications.
11 | *
12 | * @see LICENSE.md in the project root for further licensing information.
13 | */
14 |
15 | import { KeyworkLogger } from '../logging/index.js'
16 | import type { RouteRequestHandler } from './RouteRequestHandler.js'
17 |
18 | /** @ignore */
19 | export type ResponseRedirectStatus = 301 | 302 | 303 | 307 | 308
20 | /**
21 | * A route request handler for redirecting requests.
22 | *
23 | * @returns The incoming request handler.
24 | *
25 | * ### Creating a Worker that just redirects incoming requests.
26 | *
27 | * ```ts
28 | * const redirectToExample = new RedirectHandler('https://example.com')
29 | *
30 | * export default redirectToExample
31 | * ```
32 | *
33 | * @category Request Handler
34 | * @public
35 | */
36 | export function createRouteRedirect(
37 | /** URL A url-like string or URL object */
38 | destinationURL: string | URL,
39 | /**
40 | * An optional status code.
41 | * @defaultValue `302` MOVED_TEMPORARILY
42 | */
43 | statusCode: ResponseRedirectStatus = 302,
44 | logger?: KeyworkLogger
45 | ): RouteRequestHandler {
46 | const routeRequestHandler: RouteRequestHandler = ({ request }) => {
47 | logger?.info(`Redirecting from ${request.url} to ${destinationURL.toString()}`)
48 |
49 | return Response.redirect(destinationURL.toString(), statusCode)
50 | }
51 |
52 | return routeRequestHandler
53 | }
54 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "baseUrl": ".",
4 | "rootDir": ".",
5 | "outDir": "dist",
6 | "jsx": "react-jsx",
7 | "target": "ESNext",
8 | "module": "NodeNext",
9 | "resolveJsonModule": true,
10 | "moduleResolution": "NodeNext",
11 | "skipLibCheck": true,
12 | "sourceMap": true,
13 | "allowJs": false,
14 | "declarationMap": true,
15 | "allowSyntheticDefaultImports": true,
16 | "declaration": true,
17 | "strict": true,
18 | "isolatedModules": true,
19 | "paths": {
20 | "keywork": ["./index.ts"],
21 | "keywork/cli": ["./cli/index.ts"],
22 | "keywork/client": ["./client/index.ts"],
23 | "keywork/logging": ["./logging/index.ts"],
24 | "keywork/node": ["./node/index.ts"],
25 | "keywork/errors": ["./errors/index.ts"],
26 | "keywork/docgen": ["./docgen/index.ts"],
27 | "keywork/docgen/utils": ["./docgen/utils/index.ts"],
28 | "keywork/docgen/helpers": ["docgen/helpers/index.ts"],
29 | "keywork/docgen/theme": ["./docgen/theme/index.ts"],
30 | "keywork/events": ["./events/index.ts"],
31 | "keywork/files": ["./files/index.ts"],
32 | "keywork/files/extensions": ["./files/extensions/index.ts"],
33 | "keywork/http": ["./http/index.ts"],
34 | "keywork/http/headers": ["./http/headers/index.ts"],
35 | "keywork/http/responses": ["./http/responses/index.ts"],
36 | "keywork/lifecycle": ["./lifecycle/index.ts"],
37 | "keywork/middleware": ["./middleware/index.ts"],
38 | "keywork/router": ["./router/index.ts"],
39 | "keywork/ssr": ["./ssr/index.ts"],
40 | "keywork/cloudflare": ["./cloudflare/index.ts"],
41 | "keywork/testing": ["./testing/index.ts"],
42 | "keywork/utils": ["./utils/index.ts"],
43 | "keywork/uri": ["./uri/index.ts"]
44 | },
45 | },
46 | "exclude": [
47 | "node_modules",
48 | "dist",
49 | "site"
50 | ]
51 | }
52 |
53 |
--------------------------------------------------------------------------------
/router/RouteRequestHandler.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * @file This file is part of the Keywork project.
3 | * @copyright Nirrius, LLC. All rights reserved.
4 | * @author Teffen Ellis, et al.
5 | * @license AGPL-3.0
6 | *
7 | * @remarks Keywork is free software for non-commercial purposes.
8 | * You can be released from the requirements of the license by purchasing a commercial license.
9 | * Buying such a license is mandatory as soon as you develop commercial activities
10 | * involving the Keywork software without disclosing the source code of your own applications.
11 | *
12 | * @see LICENSE.md in the project root for further licensing information.
13 | */
14 |
15 | import type { IsomorphicFetchEvent } from '../events/index.js'
16 | import type { ResponseLike } from '../http/index.js'
17 | import type { MiddlewareFetch, MiddlewareReturnTypes } from './MiddlewareFetch.js'
18 |
19 | /**
20 | * A function or method that handles incoming requests and replies with a `Response`.
21 | *
22 | * Generally, this is interface is assigned to a RequestRouter method, such as `onRequestGet`
23 | * The `IsomorphicFetchEvent` argument is provided by the router's `fetch` method.
24 | *
25 | * @typeParam BoundAliases The bound aliases, usually defined in your wrangler.toml file.
26 | * @typeParam ExpectedParams Optional string union of route path parameters. Only supported in Cloudflare Pages.
27 | *
28 | * @typeParam Data Optional extra data to be passed to a route handler, usually from {@link Keywork#Middleware middleware}.
29 | *
30 | * @category Request Handler
31 | */
32 | export interface RouteRequestHandler<
33 | BoundAliases = {},
34 | ExpectedParams = {},
35 | Data = Record,
36 | ExpectedReturn extends ResponseLike = ResponseLike,
37 | > {
38 | (
39 | event: IsomorphicFetchEvent,
40 | next: MiddlewareFetch
41 | ): Promise | ExpectedReturn
42 | }
43 |
--------------------------------------------------------------------------------