Prepare v3 docs update

kossnocorp · kossnocorp · commit 315fd94c045a · 2022-12-29T09:47:53.000+08:00
diff --git a/package.json b/package.json
@@ -14,7 +14,7 @@
     "start": "env NODE_ENV=development ts-node -r tsconfig-paths/register devServer.ts"
   },
   "dependencies": {
-    "@date-fns/date-fns-db": "^0.0.14",
+    "@date-fns/docs": "0.4.0",
     "@nyancss/css-modules-loader": "^1.1.0",
     "@nyancss/react": "^1.3.0",
     "@sentry/browser": "^5.30.0",
@@ -34,7 +34,7 @@
     "@types/webpack-dev-middleware": "^4.1.0",
     "@types/webpack-hot-middleware": "^2.25.3",
     "@types/webpack-node-externals": "^2.5.0",
-    "@typesaurus/preact": "^4.0.0",
+    "@typesaurus/preact": "6.0.0-alpha.4",
     "assets-webpack-plugin": "^7.0.0",
     "body-parser": "^1.19.0",
     "copy-webpack-plugin": "^7.0.0",
@@ -45,9 +45,9 @@
     "enzyme-adapter-preact-pure": "^2.2.3",
     "express": "^4.17.1",
     "file-loader": "^6.1.0",
-    "firebase": "^8.2.2",
-    "firebase-admin": "^9.4.2",
-    "firebase-functions": "^3.13.0",
+    "firebase": "^9.15.0",
+    "firebase-admin": "^11.4.1",
+    "firebase-functions": "^4.1.1",
     "firebase-tools": "^9.2.0",
     "html-webpack-plugin": "^5.2.0",
     "husky": "^4.3.0",
@@ -66,13 +66,14 @@
     "remarkable": "^2.0.1",
     "reset.css": "^2.0.2",
     "style-loader": "^1.2.1",
-    "ts-loader": "^8.0.3",
-    "ts-node": "^9.1.1",
+    "ts-loader": "^9.4.2",
+    "ts-node": "^10.9.1",
     "tsconfig-paths": "^3.9.0",
     "tsconfig-paths-webpack-plugin": "^3.3.0",
     "tslint": "~6.1.3",
-    "typesaurus": "^7.1.0",
-    "typescript": "^4.0.2",
+    "typeroo": "^0.9.0",
+    "typesaurus": "10.0.0-alpha.40",
+    "typescript": "^4.9.4",
     "webpack": "^5.24.2",
     "webpack-cli": "^4.1.0",
     "webpack-dev-middleware": "^4.1.0",
diff --git a/src/ui/components/DocParams/index.tsx b/src/ui/components/DocParams/index.tsx
@@ -1,5 +1,5 @@
 import { h, FunctionComponent, Fragment } from 'preact'
-import { JSDocParam, JSDocType } from '@date-fns/date-fns-db'
+import { JSDocParam, JSDocType } from '@date-fns/docs/db'
 import { Markdown } from '~/ui/components/Markdown'
 import { OptionalLabel, PropsLabel } from './style.css'
 
diff --git a/src/ui/index.tsx b/src/ui/index.tsx
@@ -6,7 +6,7 @@ import { Docs } from '~/ui/screens/Docs'
 import { NotFound } from '~/ui/screens/NotFound'
 import 'reset.css/reset.css?global'
 import './global.css?global'
-import { DEFAULT_SUBMODULE } from '@date-fns/date-fns-db'
+import { defaultSubmodule } from '@date-fns/docs/db'
 
 const win = typeof window !== 'undefined' ? window : undefined
 
@@ -24,7 +24,7 @@ export const UI = () => {
     case 'docs':
       return (
         <Docs
-          selectedSubmodule={DEFAULT_SUBMODULE}
+          selectedSubmodule={defaultSubmodule}
           selectedPage={location.params.page}
         />
       )
@@ -40,7 +40,7 @@ export const UI = () => {
     case 'versionDocs':
       return (
         <Docs
-          selectedSubmodule={DEFAULT_SUBMODULE}
+          selectedSubmodule={defaultSubmodule}
           selectedPage={location.params.page}
           selectedVersion={location.params.version}
         />
diff --git a/src/ui/router/DocLinkContext.ts b/src/ui/router/DocLinkContext.ts
@@ -1,7 +1,7 @@
 import { createContext } from 'preact'
-import { DEFAULT_SUBMODULE } from '@date-fns/date-fns-db'
+import { defaultSubmodule } from '@date-fns/docs/db'
 import { DocLinkParams } from '~/ui/router/docLink'
 
 export const DocLinkContext = createContext<Omit<DocLinkParams, 'page'>>({
-  submodule: DEFAULT_SUBMODULE,
+  submodule: defaultSubmodule,
 })
diff --git a/src/ui/router/docLink.ts b/src/ui/router/docLink.ts
@@ -1,4 +1,4 @@
-import { DEFAULT_SUBMODULE, Submodule } from '@date-fns/date-fns-db'
+import { defaultSubmodule, Submodule } from '@date-fns/docs/db'
 import { AppRouteRef } from '~/ui/router'
 
 export interface DocLinkParams {
@@ -11,7 +11,7 @@ export function docLink({
   submodule,
   version,
 }: DocLinkParams): AppRouteRef {
-  if (!submodule || submodule === DEFAULT_SUBMODULE) {
+  if (!submodule || submodule === defaultSubmodule) {
     return version
       ? {
           name: 'versionDocs',
diff --git a/src/ui/router/index.ts b/src/ui/router/index.ts
@@ -1,4 +1,4 @@
-import { Submodule } from '@date-fns/date-fns-db'
+import { Submodule } from '@date-fns/docs/db'
 import { createRouter, InferRouteRef, route } from '@switcher/preact'
 
 export const appRoutes = [
diff --git a/src/ui/screens/Docs/Doc/Content.tsx b/src/ui/screens/Docs/Doc/Content.tsx
@@ -1,6 +1,6 @@
 import { h, FunctionComponent } from 'preact'
-import { Page } from '@date-fns/date-fns-db'
-import { parse } from 'json-bond'
+import { Page } from '@date-fns/docs/db'
+import { parse } from 'typeroo/json'
 import { JSDoc } from './JSDoc'
 import { MarkdownDoc } from './MarkdownDoc'
 
@@ -10,8 +10,16 @@ interface Props {
 
 export const Content: FunctionComponent<Props> = ({ page }) => {
   switch (page.type) {
+    case 'tsdoc':
+      return (
+        <pre>
+          <code>{JSON.stringify(page)}</code>
+        </pre>
+      )
+
     case 'jsdoc':
       return <JSDoc doc={parse(page.doc)} />
+
     case 'markdown':
       return <MarkdownDoc markdown={page.markdown} />
   }
diff --git a/src/ui/screens/Docs/Doc/JSDoc/Arguments/index.tsx b/src/ui/screens/Docs/Doc/JSDoc/Arguments/index.tsx
@@ -1,5 +1,5 @@
 import { h, FunctionComponent } from 'preact'
-import { JSDocParam } from '@date-fns/date-fns-db'
+import { JSDocParam } from '@date-fns/docs/db'
 import { DocParams } from '~/ui/components/DocParams'
 import { DocHeaderAnchor } from '~/ui/components/DocHeaderAnchor'
 
diff --git a/src/ui/screens/Docs/Doc/JSDoc/Exceptions/index.tsx b/src/ui/screens/Docs/Doc/JSDoc/Exceptions/index.tsx
@@ -1,10 +1,10 @@
 import { h, FunctionComponent } from 'preact'
-import { JSDocTypedAttribute } from '@date-fns/date-fns-db'
+import { JSDocAttribute } from '@date-fns/docs/db'
 import { DocHeaderAnchor } from '~/ui/components/DocHeaderAnchor'
 import { Markdown } from '~/ui/components/Markdown'
 
 interface Props {
-  exceptions: JSDocTypedAttribute[]
+  exceptions: JSDocAttribute[]
 }
 
 export const Exceptions: FunctionComponent<Props> = ({ exceptions }) => (
diff --git a/src/ui/screens/Docs/Doc/JSDoc/Properties/index.tsx b/src/ui/screens/Docs/Doc/JSDoc/Properties/index.tsx
@@ -1,5 +1,5 @@
 import { h, FunctionComponent } from 'preact'
-import { JSDocParam } from '@date-fns/date-fns-db'
+import { JSDocParam } from '@date-fns/docs/db'
 import { DocParams } from '~/ui/components/DocParams'
 import { DocHeaderAnchor } from '~/ui/components/DocHeaderAnchor'
 
diff --git a/src/ui/screens/Docs/Doc/JSDoc/Returns/index.tsx b/src/ui/screens/Docs/Doc/JSDoc/Returns/index.tsx
@@ -1,10 +1,10 @@
 import { h, FunctionComponent } from 'preact'
-import { JSDocTypedAttribute } from '@date-fns/date-fns-db'
+import { JSDocAttribute } from '@date-fns/docs/db'
 import { DocHeaderAnchor } from '~/ui/components/DocHeaderAnchor'
 import { Markdown } from '~/ui/components/Markdown'
 
 interface Props {
-  returns: JSDocTypedAttribute[]
+  returns: JSDocAttribute[]
 }
 
 export const Returns: FunctionComponent<Props> = ({ returns }) => (
diff --git a/src/ui/screens/Docs/Doc/JSDoc/Usage/index.tsx b/src/ui/screens/Docs/Doc/JSDoc/Usage/index.tsx
@@ -1,6 +1,6 @@
 import { h, FunctionComponent } from 'preact'
 import { useEffect, useState } from 'preact/hooks'
-import { JSDocUsage } from '@date-fns/date-fns-db'
+import { JSDocUsage } from '@date-fns/docs/db'
 import { Options, Option, OptionLink } from './style.css'
 import { Content } from './Content'
 import { DocHeaderAnchor } from '~/ui/components/DocHeaderAnchor'
diff --git a/src/ui/screens/Docs/Doc/JSDoc/index.tsx b/src/ui/screens/Docs/Doc/JSDoc/index.tsx
@@ -1,4 +1,4 @@
-import { JSDocFunction } from '@date-fns/date-fns-db'
+import { JSDocFunction } from '@date-fns/docs/db'
 import { FunctionComponent, h } from 'preact'
 import { DocHeaderAnchor } from '~/ui/components/DocHeaderAnchor'
 import { Markdown } from '~/ui/components/Markdown'
diff --git a/src/ui/screens/Docs/Doc/index.tsx b/src/ui/screens/Docs/Doc/index.tsx
@@ -1,11 +1,10 @@
 import { h, FunctionComponent } from 'preact'
-import { useQuery } from '~/utils/useQuery'
-import { db, PACKAGE_NAME, Submodule } from '@date-fns/date-fns-db'
-import { where } from 'typesaurus'
 import { Container } from './style.css'
 import { Content } from './Content'
 import { DocLinkContext } from '~/ui/router/DocLinkContext'
 import { useEffect } from 'preact/hooks'
+import { useRead } from '@typesaurus/preact'
+import { db, Submodule, packageName } from '@date-fns/docs/db'
 
 const SCROLL_OFFSET = 35
 
@@ -20,12 +19,14 @@ export const Doc: FunctionComponent<Props> = ({
   selectedVersion,
   selectedSubmodule,
 }) => {
-  const [pages, { loading }] = useQuery(db.pages, [
-    where('package', '==', PACKAGE_NAME),
-    where('version', '==', selectedVersion),
-    where('slug', '==', selectedPage),
-    where('submodules', 'array-contains', selectedSubmodule),
-  ])
+  const [pages, { loading }] = useRead(
+    db.pages.query(($) => [
+      $.field('package').equal(packageName),
+      $.field('version').equal(selectedVersion),
+      $.field('slug').equal(selectedPage),
+      $.field('submodules').contains(selectedSubmodule),
+    ])
+  )
 
   useEffect(() => {
     if (pages && location.hash) {
diff --git a/src/ui/screens/Docs/Finder/Categories.tsx b/src/ui/screens/Docs/Finder/Categories.tsx
@@ -1,5 +1,5 @@
 import { h, FunctionComponent } from 'preact'
-import { PagePreview, Submodule } from '@date-fns/date-fns-db'
+import { PagePreview, Submodule } from '@date-fns/docs/db'
 import { Items } from './Items'
 import { CategoriesList, Category, CategoryHeader } from './style.css'
 
diff --git a/src/ui/screens/Docs/Finder/Items.tsx b/src/ui/screens/Docs/Finder/Items.tsx
@@ -1,5 +1,5 @@
 import { h, FunctionComponent, Fragment } from 'preact'
-import { PagePreview, Submodule } from '@date-fns/date-fns-db'
+import { PagePreview, Submodule } from '@date-fns/docs/db'
 import { RouterLink } from '~/ui/router'
 import { Item, ItemHeader, ItemText, ItemIcon } from './style.css'
 import { docLink } from '~/ui/router/docLink'
diff --git a/src/ui/screens/Docs/Finder/index.tsx b/src/ui/screens/Docs/Finder/index.tsx
@@ -8,9 +8,8 @@ import { NoResults } from './NoResults'
 import { Categories } from './Categories'
 import { Widget } from './Widget'
 import { filterPages } from './utils'
-import { useQuery } from '~/utils/useQuery'
-import { db, PACKAGE_NAME, Submodule } from '@date-fns/date-fns-db'
-import { where } from 'typesaurus'
+import { packageName, Submodule, db } from '@date-fns/docs/db'
+import { useRead } from '@typesaurus/preact'
 
 type FIXME = any
 
@@ -37,10 +36,12 @@ export const Finder: FunctionComponent<Props> = ({
     []
   )
 
-  const [versions, { loading }] = useQuery(db.versions, [
-    where('package', '==', PACKAGE_NAME),
-    where('version', '==', selectedVersion),
-  ])
+  const [versions, { loading }] = useRead(
+    db.versions.query(($) => [
+      $.field('package').equal(packageName),
+      $.field('version').equal(selectedVersion),
+    ])
+  )
 
   if (versions && versions.length >= 1) {
     const { pages, categories } = versions[0].data
diff --git a/src/ui/screens/Docs/Finder/utils.ts b/src/ui/screens/Docs/Finder/utils.ts
@@ -1,4 +1,4 @@
-import { PagePreview, Submodule } from '@date-fns/date-fns-db'
+import { PagePreview, Submodule } from '@date-fns/docs/db'
 
 export function filterPages(
   pages: PagePreview[],
diff --git a/src/ui/screens/Docs/NavBar/LatestVersionLink.tsx b/src/ui/screens/Docs/NavBar/LatestVersionLink.tsx
@@ -1,4 +1,4 @@
-import { Submodule } from '@date-fns/date-fns-db'
+import { Submodule } from '@date-fns/docs/db'
 import { h, FunctionComponent } from 'preact'
 import { RouterLink } from '~/ui/router'
 import { docLink } from '~/ui/router/docLink'
diff --git a/src/ui/screens/Docs/NavBar/SubmoduleSelector.tsx b/src/ui/screens/Docs/NavBar/SubmoduleSelector.tsx
@@ -1,13 +1,13 @@
 import { h, FunctionComponent } from 'preact'
 import { Label, Select, Selector } from './style.css'
-import { Submodule } from '@date-fns/date-fns-db'
+import { Submodule } from '@date-fns/docs/db'
 import { docLink } from '~/ui/router/docLink'
 import { useContext } from 'preact/hooks'
 import { RouterContext } from '~/ui/router'
 
-const SUBMODULE_LABELS: { [k in Submodule]: string } = {
-  [Submodule.Default]: 'Default',
-  [Submodule.FP]: 'FP',
+const SUBMODULE_LABELS: Record<Submodule, string> = {
+  default: 'Default',
+  fp: 'FP',
 }
 
 interface Props {
diff --git a/src/ui/screens/Docs/NavBar/VersionSelector.tsx b/src/ui/screens/Docs/NavBar/VersionSelector.tsx
@@ -1,5 +1,5 @@
 import { h, FunctionComponent } from 'preact'
-import { Submodule, VersionPreview } from '@date-fns/date-fns-db'
+import { Submodule, VersionPreview } from '@date-fns/docs/db'
 import { Selector, Label, Select } from './style.css'
 import { useContext } from 'preact/hooks'
 import { RouterContext } from '~/ui/router'
diff --git a/src/ui/screens/Docs/NavBar/index.tsx b/src/ui/screens/Docs/NavBar/index.tsx
@@ -10,11 +10,7 @@ import {
   MenuIcon,
 } from './style.css'
 import logoPath from './img/logo.svg'
-import {
-  DEFAULT_SUBMODULE,
-  Submodule,
-  VersionPreview,
-} from '@date-fns/date-fns-db'
+import { defaultSubmodule, Submodule, VersionPreview } from '@date-fns/docs/db'
 import { VersionSelector } from './VersionSelector'
 import { SubmoduleSelector } from './SubmoduleSelector'
 
@@ -38,7 +34,7 @@ export const NavBar: FunctionComponent<Props> = ({
   const versionPreview = versions.find(
     ({ version }) => version === selectedVersion
   )
-  const submodules = versionPreview?.submodules ?? [DEFAULT_SUBMODULE]
+  const submodules = versionPreview?.submodules ?? [defaultSubmodule]
 
   return (
     <Container>
diff --git a/src/ui/screens/Docs/index.tsx b/src/ui/screens/Docs/index.tsx
@@ -10,9 +10,6 @@ import {
   FinderContainer,
   NavBarContainer,
 } from './style.css'
-import { useQuery } from '~/utils/useQuery'
-import { where } from 'typesaurus'
-import { db, PACKAGE_NAME, Submodule } from '@date-fns/date-fns-db'
 import {
   filterPreReleaseVersions,
   getLatestVersion,
@@ -23,6 +20,8 @@ import { useContext, useEffect, useState } from 'preact/hooks'
 import { RouterContext } from '~/ui/router'
 import { docLink } from '~/ui/router/docLink'
 import { DEFAULT_PAGE } from '~/constants'
+import { useRead } from '@typesaurus/preact'
+import { Submodule, db, packageName } from '@date-fns/docs/db'
 
 interface Props {
   selectedSubmodule: Submodule
@@ -49,9 +48,9 @@ export const Docs: FunctionComponent<Props> = ({
     }
   })
 
-  const [packages, { loading }] = useQuery(db.packages, [
-    where('name', '==', PACKAGE_NAME),
-  ])
+  const [packages, { loading }] = useRead(
+    db.packages.query(($) => $.field('name').equal(packageName))
+  )
 
   const [menuOpen, setMenuOpen] = useState(false)
 
diff --git a/src/utils/useQuery/index.ts b/src/utils/useQuery/index.ts
@@ -1,3 +1,4 @@
+/* TODO: Recover this?
 import { useQuery as useFirestoreQuery } from '@typesaurus/preact'
 import { TypesaurusHookResult } from '@typesaurus/preact/types'
 import { useEffect } from 'preact/hooks'
@@ -20,4 +21,4 @@ export function useQuery<Model>(
   }, [result[1].error])
 
   return result
-}
+}*/
diff --git a/src/utils/versions/index.tsx b/src/utils/versions/index.tsx
@@ -1,4 +1,4 @@
-import { VersionPreview } from '@date-fns/date-fns-db'
+import { VersionPreview } from '@date-fns/docs/db'
 
 export function filterPreReleaseVersions(
   versions: VersionPreview[],
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { Submodule } from '@date-fns/date-fns-db'`
	`1`	`+import { Submodule } from '@date-fns/docs/db'`
`2`	`2`	`import { createRouter, InferRouteRef, route } from '@switcher/preact'`
`3`	`3`
`4`	`4`	`export const appRoutes = [`