diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 2b757ed..cf96e58 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -5,6 +5,7 @@ import typedocSidebar from '../api/typedoc-sidebar.json'; export default defineConfig({ title: 'tsky', description: 'A Bluesky API client for nimble apps and tools', + ignoreDeadLinks: [/\/examples\//], themeConfig: { nav: [ { text: 'Home', link: '/' }, diff --git a/docs/examples.md b/docs/examples.md index 7045f03..49a5f46 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -4,4 +4,4 @@ outline: deep # Examples -TODO: Add examples here +- [User profile](/examples/user-profile/){target="_self"} diff --git a/docs/package.json b/docs/package.json index a23d3bf..f421959 100644 --- a/docs/package.json +++ b/docs/package.json @@ -3,15 +3,21 @@ "version": "1.0.0", "private": true, "main": "index.js", + "type": "module", "scripts": { "predev": "typedoc", "dev": "vitepress dev", "prebuild": "typedoc", "build": "vitepress build", + "postbuild": "pnpm build:examples && pnpm copy-example-apps", + "build:examples": "pnpm --filter 'examples-*' build", + "copy-example-apps": "tsx scripts/copy-example-apps.ts", "preview": "vitepress preview", "test": "echo \"Error: no test specified\"" }, "devDependencies": { + "@types/node": "^22.13.10", + "tsx": "^4.19.2", "typedoc": "^0.27.1", "typedoc-plugin-markdown": "^4.3.0", "typedoc-vitepress-theme": "^1.1.0", diff --git a/docs/scripts/copy-example-apps.ts b/docs/scripts/copy-example-apps.ts new file mode 100644 index 0000000..0ed27c8 --- /dev/null +++ b/docs/scripts/copy-example-apps.ts @@ -0,0 +1,10 @@ +import fs from 'node:fs/promises'; + +const apps = await fs.readdir('../examples'); + +for (const app of apps) { + console.log(`copying example app ${app} ...`); + fs.cp(`../examples/${app}/dist`, `./.vitepress/dist/examples/${app}`, { + recursive: true, + }); +} diff --git a/docs/tsconfig.json b/docs/tsconfig.json new file mode 100644 index 0000000..9fe1b83 --- /dev/null +++ b/docs/tsconfig.json @@ -0,0 +1,31 @@ +{ + "compilerOptions": { + "target": "ESNext", + "lib": ["ESNext", "DOM"], + "moduleDetection": "force", + "useDefineForClassFields": false, + "experimentalDecorators": true, + "baseUrl": ".", + "module": "ESNext", + "moduleResolution": "bundler", + "resolveJsonModule": true, + "allowJs": true, + "strict": true, + "noFallthroughCasesInSwitch": true, + "noImplicitOverride": true, + "noImplicitReturns": true, + "noUnusedLocals": true, + "noImplicitAny": true, + "noUnusedParameters": true, + "declaration": false, + "noEmit": true, + "outDir": "dist/", + "sourceMap": true, + "esModuleInterop": true, + "forceConsistentCasingInFileNames": true, + "isolatedModules": true, + "verbatimModuleSyntax": true, + "skipLibCheck": true + }, + "include": ["./scripts/**/*"], +} diff --git a/examples/user-profile/package.json b/examples/user-profile/package.json index 3833232..2c760aa 100644 --- a/examples/user-profile/package.json +++ b/examples/user-profile/package.json @@ -1,5 +1,5 @@ { - "name": "user-profile", + "name": "examples-user-profile", "private": true, "version": "0.0.0", "type": "module", @@ -25,4 +25,4 @@ "typescript-eslint": "^8.24.1", "vite": "^6.2.0" } -} \ No newline at end of file +} diff --git a/examples/user-profile/src/App.tsx b/examples/user-profile/src/App.tsx index dee8992..8d23a57 100644 --- a/examples/user-profile/src/App.tsx +++ b/examples/user-profile/src/App.tsx @@ -54,7 +54,7 @@ function App() { rel="noreferrer" > tsky logo diff --git a/examples/user-profile/vite.config.ts b/examples/user-profile/vite.config.ts index 6e7f528..24dc0b6 100644 --- a/examples/user-profile/vite.config.ts +++ b/examples/user-profile/vite.config.ts @@ -5,4 +5,5 @@ import tailwindcss from '@tailwindcss/vite'; // https://vite.dev/config/ export default defineConfig({ plugins: [react(), tailwindcss()], + base: '/examples/user-profile/', }); diff --git a/package.json b/package.json index 4ff1ca9..f0a988b 100644 --- a/package.json +++ b/package.json @@ -35,4 +35,4 @@ "biome check --write --" ] } -} \ No newline at end of file +} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 8bdeb1d..809dab8 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -26,6 +26,12 @@ importers: docs: devDependencies: + '@types/node': + specifier: ^22.13.10 + version: 22.13.10 + tsx: + specifier: ^4.19.2 + version: 4.19.2 typedoc: specifier: ^0.27.1 version: 0.27.6(typescript@5.7.2) @@ -37,7 +43,7 @@ importers: version: 1.1.2(typedoc-plugin-markdown@4.4.1(typedoc@0.27.6(typescript@5.7.2))) vitepress: specifier: ^1.5.0 - version: 1.5.0(@algolia/client-search@5.15.0)(@types/node@22.10.1)(axios@1.7.9)(lightningcss@1.29.2)(postcss@8.5.3)(search-insights@2.17.3)(typescript@5.7.2) + version: 1.5.0(@algolia/client-search@5.15.0)(@types/node@22.13.10)(axios@1.7.9)(lightningcss@1.29.2)(postcss@8.5.3)(search-insights@2.17.3)(typescript@5.7.2) examples/user-profile: dependencies: @@ -53,7 +59,7 @@ importers: devDependencies: '@tailwindcss/vite': specifier: ^4.0.12 - version: 4.0.12(vite@6.2.1(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0)) + version: 4.0.12(vite@6.2.1(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0)) '@tsky/lexicons': specifier: workspace:* version: link:../../packages/lexicons @@ -65,7 +71,7 @@ importers: version: 19.0.4(@types/react@19.0.10) '@vitejs/plugin-react': specifier: ^4.3.4 - version: 4.3.4(vite@6.2.1(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0)) + version: 4.3.4(vite@6.2.1(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0)) globals: specifier: ^15.15.0 version: 15.15.0 @@ -80,7 +86,7 @@ importers: version: 8.26.1(eslint@9.22.0(jiti@2.4.2))(typescript@5.7.2) vite: specifier: ^6.2.0 - version: 6.2.1(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0) + version: 6.2.1(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0) packages/client: dependencies: @@ -96,7 +102,7 @@ importers: version: link:../lexicons '@vitest/coverage-istanbul': specifier: ^3.0.6 - version: 3.0.6(vitest@3.0.6(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0)) + version: 3.0.6(vitest@3.0.6(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0)) globals: specifier: ^15.12.0 version: 15.12.0 @@ -111,7 +117,7 @@ importers: version: 5.7.2 vitest: specifier: ^3.0.6 - version: 3.0.6(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0) + version: 3.0.6(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0) packages/internal/dev-env: dependencies: @@ -2017,6 +2023,9 @@ packages: '@types/node@22.10.1': resolution: {integrity: sha512-qKgsUwfHZV2WCWLAnVP1JqnpE6Im6h3Y0+fYgMTasNQ7V++CBX5OT1as0g0f+OyubbFqhf6XVNIsmN4IIhEgGQ==} + '@types/node@22.13.10': + resolution: {integrity: sha512-I6LPUvlRH+O6VRUqYOcMudhaIdUVWfsjnZavnsraHvpBwaEyMN29ry+0UVJhImYL16xsscu0aske3yA+uPOWfw==} + '@types/react-dom@19.0.4': resolution: {integrity: sha512-4fSQ8vWFkg+TGhePfUzVmat3eC14TXYSsiiDSLI0dVLsrm9gZFABjPy/Qu6TKgl1tq1Bu1yDsuQgY3A3DOjCcg==} peerDependencies: @@ -6548,13 +6557,13 @@ snapshots: '@tailwindcss/oxide-win32-arm64-msvc': 4.0.12 '@tailwindcss/oxide-win32-x64-msvc': 4.0.12 - '@tailwindcss/vite@4.0.12(vite@6.2.1(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0))': + '@tailwindcss/vite@4.0.12(vite@6.2.1(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0))': dependencies: '@tailwindcss/node': 4.0.12 '@tailwindcss/oxide': 4.0.12 lightningcss: 1.29.2 tailwindcss: 4.0.12 - vite: 6.2.1(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0) + vite: 6.2.1(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0) '@tokenizer/token@0.3.0': {} @@ -6581,7 +6590,7 @@ snapshots: '@types/bn.js@5.1.6': dependencies: - '@types/node': 22.10.1 + '@types/node': 22.13.10 '@types/elliptic@6.4.18': dependencies: @@ -6612,6 +6621,10 @@ snapshots: dependencies: undici-types: 6.20.0 + '@types/node@22.13.10': + dependencies: + undici-types: 6.20.0 + '@types/react-dom@19.0.4(@types/react@19.0.10)': dependencies: '@types/react': 19.0.10 @@ -6705,23 +6718,23 @@ snapshots: '@ungap/structured-clone@1.2.0': {} - '@vitejs/plugin-react@4.3.4(vite@6.2.1(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0))': + '@vitejs/plugin-react@4.3.4(vite@6.2.1(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0))': dependencies: '@babel/core': 7.26.0 '@babel/plugin-transform-react-jsx-self': 7.25.9(@babel/core@7.26.0) '@babel/plugin-transform-react-jsx-source': 7.25.9(@babel/core@7.26.0) '@types/babel__core': 7.20.5 react-refresh: 0.14.2 - vite: 6.2.1(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0) + vite: 6.2.1(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0) transitivePeerDependencies: - supports-color - '@vitejs/plugin-vue@5.2.1(vite@5.4.11(@types/node@22.10.1)(lightningcss@1.29.2))(vue@3.5.13(typescript@5.7.2))': + '@vitejs/plugin-vue@5.2.1(vite@5.4.11(@types/node@22.13.10)(lightningcss@1.29.2))(vue@3.5.13(typescript@5.7.2))': dependencies: - vite: 5.4.11(@types/node@22.10.1)(lightningcss@1.29.2) + vite: 5.4.11(@types/node@22.13.10)(lightningcss@1.29.2) vue: 3.5.13(typescript@5.7.2) - '@vitest/coverage-istanbul@3.0.6(vitest@3.0.6(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0))': + '@vitest/coverage-istanbul@3.0.6(vitest@3.0.6(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0))': dependencies: '@istanbuljs/schema': 0.1.3 debug: 4.4.0 @@ -6733,7 +6746,7 @@ snapshots: magicast: 0.3.5 test-exclude: 7.0.1 tinyrainbow: 2.0.0 - vitest: 3.0.6(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0) + vitest: 3.0.6(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0) transitivePeerDependencies: - supports-color @@ -6744,13 +6757,13 @@ snapshots: chai: 5.2.0 tinyrainbow: 2.0.0 - '@vitest/mocker@3.0.6(vite@6.2.1(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0))': + '@vitest/mocker@3.0.6(vite@6.2.1(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0))': dependencies: '@vitest/spy': 3.0.6 estree-walker: 3.0.3 magic-string: 0.30.17 optionalDependencies: - vite: 6.2.1(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0) + vite: 6.2.1(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0) '@vitest/pretty-format@3.0.6': dependencies: @@ -8949,13 +8962,13 @@ snapshots: '@types/unist': 3.0.3 vfile-message: 4.0.2 - vite-node@3.0.6(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0): + vite-node@3.0.6(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0): dependencies: cac: 6.7.14 debug: 4.4.0 es-module-lexer: 1.6.0 pathe: 2.0.3 - vite: 6.2.1(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0) + vite: 6.2.1(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0) transitivePeerDependencies: - '@types/node' - jiti @@ -8970,30 +8983,30 @@ snapshots: - tsx - yaml - vite@5.4.11(@types/node@22.10.1)(lightningcss@1.29.2): + vite@5.4.11(@types/node@22.13.10)(lightningcss@1.29.2): dependencies: esbuild: 0.21.5 postcss: 8.4.49 rollup: 4.27.4 optionalDependencies: - '@types/node': 22.10.1 + '@types/node': 22.13.10 fsevents: 2.3.3 lightningcss: 1.29.2 - vite@6.2.1(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0): + vite@6.2.1(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0): dependencies: esbuild: 0.25.1 postcss: 8.5.3 rollup: 4.35.0 optionalDependencies: - '@types/node': 22.10.1 + '@types/node': 22.13.10 fsevents: 2.3.3 jiti: 2.4.2 lightningcss: 1.29.2 tsx: 4.19.2 yaml: 2.7.0 - vitepress@1.5.0(@algolia/client-search@5.15.0)(@types/node@22.10.1)(axios@1.7.9)(lightningcss@1.29.2)(postcss@8.5.3)(search-insights@2.17.3)(typescript@5.7.2): + vitepress@1.5.0(@algolia/client-search@5.15.0)(@types/node@22.13.10)(axios@1.7.9)(lightningcss@1.29.2)(postcss@8.5.3)(search-insights@2.17.3)(typescript@5.7.2): dependencies: '@docsearch/css': 3.8.0 '@docsearch/js': 3.8.0(@algolia/client-search@5.15.0)(search-insights@2.17.3) @@ -9002,7 +9015,7 @@ snapshots: '@shikijs/transformers': 1.24.0 '@shikijs/types': 1.24.0 '@types/markdown-it': 14.1.2 - '@vitejs/plugin-vue': 5.2.1(vite@5.4.11(@types/node@22.10.1)(lightningcss@1.29.2))(vue@3.5.13(typescript@5.7.2)) + '@vitejs/plugin-vue': 5.2.1(vite@5.4.11(@types/node@22.13.10)(lightningcss@1.29.2))(vue@3.5.13(typescript@5.7.2)) '@vue/devtools-api': 7.6.7 '@vue/shared': 3.5.13 '@vueuse/core': 11.3.0(vue@3.5.13(typescript@5.7.2)) @@ -9011,7 +9024,7 @@ snapshots: mark.js: 8.11.1 minisearch: 7.1.1 shiki: 1.24.0 - vite: 5.4.11(@types/node@22.10.1)(lightningcss@1.29.2) + vite: 5.4.11(@types/node@22.13.10)(lightningcss@1.29.2) vue: 3.5.13(typescript@5.7.2) optionalDependencies: postcss: 8.5.3 @@ -9043,10 +9056,10 @@ snapshots: - typescript - universal-cookie - vitest@3.0.6(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0): + vitest@3.0.6(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0): dependencies: '@vitest/expect': 3.0.6 - '@vitest/mocker': 3.0.6(vite@6.2.1(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0)) + '@vitest/mocker': 3.0.6(vite@6.2.1(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0)) '@vitest/pretty-format': 3.0.6 '@vitest/runner': 3.0.6 '@vitest/snapshot': 3.0.6 @@ -9062,11 +9075,11 @@ snapshots: tinyexec: 0.3.2 tinypool: 1.0.2 tinyrainbow: 2.0.0 - vite: 6.2.1(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0) - vite-node: 3.0.6(@types/node@22.10.1)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0) + vite: 6.2.1(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0) + vite-node: 3.0.6(@types/node@22.13.10)(jiti@2.4.2)(lightningcss@1.29.2)(tsx@4.19.2)(yaml@2.7.0) why-is-node-running: 2.3.0 optionalDependencies: - '@types/node': 22.10.1 + '@types/node': 22.13.10 transitivePeerDependencies: - jiti - less