Document common package, include interfaces

docs/.gitignore

@@ -17,17 +17,7 @@
 
 npm-debug.log*
 
-docs/capacitor-sdk/
-docs/attachments-sdk/
-docs/common-sdk/
-docs/node-sdk/
-docs/react-native-sdk/
-docs/react-sdk/
-docs/vue-sdk/
-docs/web-sdk/
-docs/tanstack-react-query-sdk
-docs/node-sdk
-docs/nuxt-sdk
-docs/tauri-plugin
+docs/*
+!docs/README.md
 
 .env

docs/docusaurus.config.ts

@@ -4,34 +4,44 @@ import type { PluginOptions } from 'docusaurus-plugin-typedoc';
 import 'dotenv/config';
 import { themes as prismThemes } from 'prism-react-renderer';
 import type { TypeDocOptionMap } from 'typedoc';
-import { DOC_FOLDER, packageMap } from './utils/packageMap';
+import { DOC_FOLDER, packageMap, Packages } from './utils/packageMap';
 
 const PROJECT_NAME = process.env.GH_PROJECT_NAME;
 
-const plugins = Object.entries(packageMap).map(([id, config]) => [
-  'docusaurus-plugin-typedoc',
-  {
-    id,
-    excludeExternals: true,
-    entryPoints: config.entryPoints,
-    tsconfig: config.tsconfig,
-    out: `${DOC_FOLDER}/${config.dirName}`,
-    parametersFormat: 'table',
-    propertiesFormat: 'table',
-    enumMembersFormat: 'table',
-    excludeProtected: true,
-    excludePrivate: true,
-    indexFormat: 'table',
-    disableSources: true,
-    expandObjects: true,
-    useCodeBlocks: true,
-    typeDeclarationFormat: 'table',
-    membersWithOwnFile: ['Class', 'Enum', 'Function'],
-    textContentMappings: {
-      'title.memberPage': '{name}'
-    }
-  } as Partial<PluginOptions | TypeDocOptionMap>
-]);
+const plugins = Object.entries(packageMap).map(([id, config]) => {
+  const isCommon = config.id == Packages.Common;
+  const membersWithOwnFile: PluginOptions['membersWithOwnFile'] = ['Class', 'Enum', 'Function'];
+  if (isCommon) {
+    membersWithOwnFile.push('Interface');
+  }
+
+  return [
+    'docusaurus-plugin-typedoc',
+    {
+      // @ts-ignore
+      id,
+      entryPoints: config.entryPoints,
+      tsconfig: config.tsconfig,
+      out: `${DOC_FOLDER}/${config.dirName}`,
+      parametersFormat: 'table',
+      propertiesFormat: 'table',
+      enumMembersFormat: 'table',
+      excludeExternals: true,
+      excludeProtected: true,
+      excludePrivate: true,
+      excludeInternal: true,
+      indexFormat: 'table',
+      disableSources: true,
+      expandObjects: true,
+      useCodeBlocks: true,
+      typeDeclarationFormat: 'table',
+      membersWithOwnFile: membersWithOwnFile,
+      textContentMappings: {
+        'title.memberPage': '{name}'
+      }
+    } satisfies Partial<PluginOptions | TypeDocOptionMap>
+  ];
+});
 
 const config: Config = {
   title: 'PowerSync JS SDK Docs',

docs/package.json

@@ -10,24 +10,24 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "^3.7.0",
-    "@docusaurus/preset-classic": "^3.7.0",
-    "@mdx-js/react": "^3.1.0",
-    "dotenv": "^16.4.7",
+    "@docusaurus/core": "^3.10.2",
+    "@docusaurus/preset-classic": "^3.10.2",
+    "@mdx-js/react": "^3.1.1",
+    "dotenv": "^17.4.2",
     "prism-react-renderer": "^2.4.1",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0"
+    "react": "^19.2.8",
+    "react-dom": "^19.2.8"
   },
   "devDependencies": {
-    "@docusaurus/faster": "^3.7.0",
-    "@docusaurus/module-type-aliases": "^3.7.0",
-    "@docusaurus/theme-classic": "^3.7.0",
-    "@docusaurus/tsconfig": "3.7.0",
-    "@docusaurus/types": "3.7.0",
+    "@docusaurus/faster": "^3.10.2",
+    "@docusaurus/module-type-aliases": "^3.10.2",
+    "@docusaurus/theme-classic": "^3.10.2",
+    "@docusaurus/tsconfig": "3.10.2",
+    "@docusaurus/types": "3.10.2",
     "@types/node": "catalog:",
-    "docusaurus-plugin-typedoc": "^1.2.1",
-    "typedoc": "~0.27.6",
-    "typedoc-plugin-markdown": "~4.4.1",
+    "docusaurus-plugin-typedoc": "^1.4.2",
+    "typedoc": "^0.28.20",
+    "typedoc-plugin-markdown": "~4.12.0",
     "typescript": "catalog:"
   },
   "browserslist": {
@@ -41,8 +41,5 @@
       "last 3 firefox version",
       "last 5 safari version"
     ]
-  },
-  "engines": {
-    "node": ">=18.0"
   }
 }

docs/tsconfig.json

@@ -2,5 +2,7 @@
   // This file is not used in compilation. It is here just for a nice editor experience.
   "extends": "@docusaurus/tsconfig",
   "compilerOptions": {
+    // To silence an issue from @docusaurus/tsconfig
+    "ignoreDeprecations": "6.0"
   }
 }

docs/utils/packageMap.ts

@@ -1,6 +1,7 @@
 export const DOC_FOLDER = 'docs';
 
-enum Packages {
+export enum Packages {
+  Common = 'common',
   CapacitorSdk = 'capacitor-sdk',
   ReactNativeSdk = 'react-native-sdk',
   ReactSdk = 'react-sdk',
@@ -26,6 +27,13 @@ type PackageMap = {
 };
 
 export const packageMap: PackageMap = {
+  [Packages.Common]: {
+    name: 'Cross-Platform definitions',
+    dirName: Packages.Common,
+    entryPoints: ['../packages/common/src/'],
+    tsconfig: '../packages/common/tsconfig.json',
+    id: Packages.Common
+  },
   [Packages.CapacitorSdk]: {
     name: 'Capacitor SDK',
     dirName: Packages.CapacitorSdk,