-
{title}
diff --git a/src/components/ScopeBadges.module.css b/src/components/ScopeBadges.module.css
index c727927..c762eef 100644
--- a/src/components/ScopeBadges.module.css
+++ b/src/components/ScopeBadges.module.css
@@ -12,5 +12,5 @@
border-radius: 4px;
background-color: transparent !important;
color: var(--ifm-color-primary);
- border: 2px solid var(--ifm-toc-border-color)
+ border: 2px solid var(--ifm-toc-border-color);
}
diff --git a/src/components/ScopeBadges.jsx b/src/components/ScopeBadges.tsx
similarity index 79%
rename from src/components/ScopeBadges.jsx
rename to src/components/ScopeBadges.tsx
index ebdbca2..e4ed840 100644
--- a/src/components/ScopeBadges.jsx
+++ b/src/components/ScopeBadges.tsx
@@ -10,9 +10,5 @@ export function ScopeBadges({ scope, read, write }) {
}
function Badge({ scope }) {
- return (
-
- {scope}
-
- )
+ return
{scope}
}
diff --git a/src/components/documentation/Sample.jsx b/src/components/documentation/Sample.tsx
similarity index 69%
rename from src/components/documentation/Sample.jsx
rename to src/components/documentation/Sample.tsx
index 9dd3243..ca8b4fc 100644
--- a/src/components/documentation/Sample.jsx
+++ b/src/components/documentation/Sample.tsx
@@ -1,8 +1,9 @@
-import { useState } from 'react'
import CodeBlock from '@theme/CodeBlock'
+import { useState } from 'react'
import styles from './Sample.module.css'
+import type { Sample as SampleType } from './useServiceDocs'
-export default function Sample({ sample }) {
+export function Sample({ sample }: { sample: SampleType }) {
const [shown, setShown] = useState(false)
const stringified = JSON.stringify(sample.sample, null, 2)
@@ -12,18 +13,12 @@ export default function Sample({ sample }) {
<>
{sample.title}
- setShown(!shown)}
- >
+ setShown(!shown)}>
{shown ? 'Hide' : 'Show'}
-
+
{shown ? content : '{ ... }'}
diff --git a/src/components/documentation/ServiceDocumentation.jsx b/src/components/documentation/ServiceDocumentation.jsx
deleted file mode 100644
index dbd7a16..0000000
--- a/src/components/documentation/ServiceDocumentation.jsx
+++ /dev/null
@@ -1,178 +0,0 @@
-import React from 'react'
-import useServiceDocs from './useServiceDocs'
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext'
-import styles from './ServiceDocumentation.module.css'
-import clsx from 'clsx'
-import Sample from './Sample'
-import Head from '@docusaurus/Head'
-import Heading from '@theme/Heading'
-import { ScopeBadges } from '../ScopeBadges'
-
-function slugify(text) {
- if (typeof text !== 'string' || text.length === 0) {
- return '';
- }
-
- // 1. Remove characters that are not a-z, 0-9, space, or dash
- let slug = text.toLowerCase().replace(/[^a-z0-9\s-]/g, '');
-
- // 2. Replace all remaining spaces and multiple dashes with a single dash
- slug = slug.replace(/[\s-]+/g, '-');
-
- // 3. Trim leading/trailing dashes
- slug = slug.replace(/^-+|-+$/g, '');
-
- return slug;
-}
-
-export default function ServiceDocumentation({ service, metaDescription }) {
- const { siteConfig } = useDocusaurusContext()
- const serviceData = useServiceDocs(service)
-
- if (!serviceData) {
- return Service "{service}" not found
- }
-
- const { routes } = serviceData
-
- const getParamRequiredText = (requiredType) => {
- if (requiredType === 'YES') return ✅ Yes❌ No⚠️ Sometimes${matchParts[0]} `)
- }
- }
-
- return transformed
- }
-
- const getSortOrder = (method) => {
- return ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'].indexOf(method)
- }
-
- const getRouteDescription = (route) => {
- return route.description?.split('\n').map((part, idx) => {
- if (idx === 0) return null
- return {part}
- }) ?? null
- }
-
- const getRouteTitle = (route) => {
- return route.description?.split('\n')[0] ?? 'No title'
- }
-
- return (
- <>
-
-
- {routeTitle}
-
- {Object.entries(scopeMap).map(([scope, { read, write }]) => (
-
- {route.method} {siteConfig.customFields.docs.baseUrl}{route.path}
-
-
- {getRouteDescription(route)}
-
- {sections.filter((section) => {
- if (route.method === 'GET') {
- return section.title !== 'Body keys'
- }
- return true
- }).map((section) => {
- return (
-
-
- {section.title}
-
-
-
- {section.params.length === 0 &&
None available
}
-
- {section.params.length > 0 &&
-
-
-
- Key
- Required
- Description
-
-
-
-
- {section.params.sort((a, b) => a.name.localeCompare(b.name)).map((param, idx) => (
-
- {param.name}{getParamRequiredText(param.required)}
-
- ))}
-
-
- }
-
-
- )
- })}
-
- )
-}
diff --git a/src/components/documentation/ServiceDocumentation.module.css b/src/components/documentation/ServiceDocumentation.module.css
index a7d98a7..a7b1bcc 100644
--- a/src/components/documentation/ServiceDocumentation.module.css
+++ b/src/components/documentation/ServiceDocumentation.module.css
@@ -1,7 +1,7 @@
.url {
display: inline-block;
padding: 8px;
- margin-bottom: calc(var(--ifm-heading-vertical-rhythm-top) * var(--ifm-leading))
+ margin-bottom: calc(var(--ifm-heading-vertical-rhythm-top) * var(--ifm-leading));
}
.descriptionText {
@@ -41,7 +41,8 @@
background-color: #b91c1c;
}
-.nameCell, .requiredCell {
+.nameCell,
+.requiredCell {
min-width: 140px;
}
diff --git a/src/components/documentation/ServiceDocumentation.tsx b/src/components/documentation/ServiceDocumentation.tsx
new file mode 100644
index 0000000..ee41999
--- /dev/null
+++ b/src/components/documentation/ServiceDocumentation.tsx
@@ -0,0 +1,251 @@
+import Head from '@docusaurus/Head'
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext'
+import Heading from '@theme/Heading'
+import clsx from 'clsx'
+import React from 'react'
+import { ScopeBadges } from '../ScopeBadges'
+import { Sample } from './Sample'
+import styles from './ServiceDocumentation.module.css'
+import { Docs, ServiceRoute, useServiceDocs } from './useServiceDocs'
+
+type ScopeMap = {
+ [scope: string]: {
+ read: boolean
+ write: boolean
+ }
+}
+
+function slugify(text?: string) {
+ if (typeof text !== 'string' || text.length === 0) {
+ return ''
+ }
+
+ // 1. Remove characters that are not a-z, 0-9, space, or dash
+ let slug = text.toLowerCase().replace(/[^a-z0-9\s-]/g, '')
+
+ // 2. Replace all remaining spaces and multiple dashes with a single dash
+ slug = slug.replace(/[\s-]+/g, '-')
+
+ // 3. Trim leading/trailing dashes
+ slug = slug.replace(/^-+|-+$/g, '')
+
+ return slug
+}
+
+function normaliseMethod(method: string) {
+ return method.toUpperCase()
+}
+
+export function ServiceDocumentation({
+ service,
+ metaDescription,
+}: {
+ service: string
+ metaDescription: string
+}) {
+ const { siteConfig } = useDocusaurusContext()
+ const serviceData = useServiceDocs(service)
+
+ if (!serviceData) {
+ return "{service}" not found
+ }
+
+ const { routes } = serviceData
+
+ const getParamRequiredText = (required: boolean) => {
+ if (required) {
+ return (
+
+ ✅ Yes
+
+ )
+ }
+
+ return (
+
+ ❌ No
+
+ )
+ }
+
+ const getParamDescriptionText = (description?: string) => {
+ if (!description) {
+ return ''
+ }
+
+ let transformed = description
+
+ const parts = description.split(' ')
+ for (const part of parts) {
+ if (part.startsWith('@type')) {
+ const innerMatch = part.match(/[^(]*:([^)]*)/)?.[0]
+ const fullMatch = part.match(/@type\((.*):(.*)\)/)?.[0]
+ if (innerMatch && fullMatch) {
+ const matchParts = innerMatch.split(':')
+ transformed = transformed.replace(
+ fullMatch,
+ `${matchParts[0]} `,
+ )
+ }
+ }
+ }
+
+ return transformed
+ }
+
+ const getSortOrder = (method) => {
+ return ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'].indexOf(normaliseMethod(method))
+ }
+
+ const getRouteDescription = (route: ServiceRoute) => {
+ return (
+ route.description?.split('\n').map((part, idx) => {
+ if (idx === 0) {
+ return null
+ }
+ return (
+
+ {part}
+
+ )
+ }) ?? null
+ )
+ }
+
+ const getRouteTitle = (route: ServiceRoute) => {
+ return route.description?.split('\n')[0] ?? 'No title'
+ }
+
+ const extractParamTypes = (params: ServiceRoute['params'], paramType: string) => {
+ return params.filter((param) => param.location === paramType)
+ }
+
+ return (
+ <>
+
+
+
+ {routeTitle}
+
+
+ {Object.entries(scopeMap).map(([scope, { read, write }]) => (
+
+
+ {normaliseMethod(route.method)}
+ {' '}
+
+ {(siteConfig.customFields.docs as Docs).baseUrl}
+ {route.path}
+
+
+
+ {getRouteDescription(route)}
+
+ {sections
+ .filter((section) => {
+ if (normaliseMethod(route.method) === 'GET') {
+ return section.title !== 'Body keys'
+ }
+ return true
+ })
+ .map((section) => {
+ return (
+
+
+ {section.title}
+
+
+
+ {section.params.length === 0 && (
+
None available
+ )}
+
+ {section.params.length > 0 && (
+
+
+
+ Key
+ Required
+ Description
+
+
+
+
+ {section.params
+ .sort((a, b) => a.name.localeCompare(b.name))
+ .map((param, idx) => (
+
+
+ {param.name}
+
+
+ {getParamRequiredText(param.required)}
+
+
+ ))}
+
+
+ )}
+
+
+ )
+ })}
+
+ )
+}
diff --git a/src/components/documentation/ServiceDocumentationWithTOC.jsx b/src/components/documentation/ServiceDocumentationWithTOC.jsx
deleted file mode 100644
index 1252eef..0000000
--- a/src/components/documentation/ServiceDocumentationWithTOC.jsx
+++ /dev/null
@@ -1,19 +0,0 @@
-import ServiceDocumentation, { generateTOCForService } from './ServiceDocumentation'
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext'
-import TOCInline from '@theme/TOCInline'
-
-/**
- * Wrapper component that renders ServiceDocumentation with an inline TOC
- * This allows the dynamically generated headings to appear in the right sidebar
- */
-export default function ServiceDocumentationWithTOC({ service, metaDescription }) {
- const { siteConfig } = useDocusaurusContext()
- const toc = generateTOCForService(service, siteConfig)
-
- return (
- <>
-
Talo Game Services
An open-source backend for your games.
-
Using Talo, you can integrate leaderboards, stats, event tracking, Steamworks and more with our Godot plugin, Unity package or API.
+
+ Using Talo, you can integrate leaderboards, stats, event tracking, Steamworks and more
+ with our Godot plugin, Unity package or API.
+
)
@@ -18,7 +21,8 @@ export default function Home() {
return (
+ description='Talo is an open-source backend for your game. You can integrate leaderboards, stats, event tracking, Steamworks and more with our Godot plugin or Unity package.'
+ >