feat(homepage): add typedoc reference for @pod-os/core

Author: angelo-v

core/package.json

@@ -17,6 +17,7 @@
     "build:types": "rimraf types && tsc --emitDeclarationOnly --outDir types",
     "build:types:watch": "rimraf types && tsc --emitDeclarationOnly --outDir types --watch",
     "build:watch": "node esbuild/watch-esm.mjs",
+    "build:doc": "typedoc",
     "dev": "run-p build:types:watch build:watch",
     "build": " npm run build:bundle && npm run build:types && npm run build:esm"
   },
@@ -40,6 +41,8 @@
     "prettier": "^3.6.2",
     "rimraf": "^6.0.1",
     "sparqljs": "^3.7.3",
+    "typedoc": "^0.28.12",
+    "typedoc-plugin-markdown": "^4.8.1",
     "typescript": "5.9.2",
     "typescript-eslint": "^8.41.0"
   },

core/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "plugin": ["typedoc-plugin-markdown"],
+  "entryPoints": ["src/index.ts"],
+  "out": "../homepage/docs/reference/core"
+}

homepage/docs/reference/.nav.yml

@@ -9,4 +9,5 @@ nav:
       - elements/apps
       - elements/components
   - '@pod-os/core':
-      - core/index.md
+      - core/index.md
+      - core/*

homepage/docs/reference/core/classes/AnonymousSession.md

@@ -0,0 +1,103 @@
+[**@pod-os/core**](../README.md)
+
+***
+
+[@pod-os/core](../globals.md) / AnonymousSession
+
+# Class: AnonymousSession
+
+Defined in: [authentication/index.ts:20](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/authentication/index.ts#L20)
+
+## Implements
+
+- [`PodOsSession`](../interfaces/PodOsSession.md)
+
+## Constructors
+
+### Constructor
+
+> **new AnonymousSession**(): `AnonymousSession`
+
+#### Returns
+
+`AnonymousSession`
+
+## Accessors
+
+### authenticatedFetch
+
+#### Get Signature
+
+> **get** **authenticatedFetch**(): (`url`, `init?`) => `Promise`\<`Response`\>
+
+Defined in: [authentication/index.ts:27](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/authentication/index.ts#L27)
+
+##### Returns
+
+> (`url`, `init?`): `Promise`\<`Response`\>
+
+###### Parameters
+
+###### url
+
+`RequestInfo`
+
+###### init?
+
+`RequestInit`
+
+###### Returns
+
+`Promise`\<`Response`\>
+
+#### Implementation of
+
+[`PodOsSession`](../interfaces/PodOsSession.md).[`authenticatedFetch`](../interfaces/PodOsSession.md#authenticatedfetch)
+
+## Methods
+
+### login()
+
+> **login**(): `Promise`\<`void`\>
+
+Defined in: [authentication/index.ts:38](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/authentication/index.ts#L38)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`PodOsSession`](../interfaces/PodOsSession.md).[`login`](../interfaces/PodOsSession.md#login)
+
+***
+
+### logout()
+
+> **logout**(): `Promise`\<`void`\>
+
+Defined in: [authentication/index.ts:42](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/authentication/index.ts#L42)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`PodOsSession`](../interfaces/PodOsSession.md).[`logout`](../interfaces/PodOsSession.md#logout)
+
+***
+
+### observeSession()
+
+> **observeSession**(): `BehaviorSubject`\<[`SessionInfo`](../type-aliases/SessionInfo.md)\>
+
+Defined in: [authentication/index.ts:34](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/authentication/index.ts#L34)
+
+#### Returns
+
+`BehaviorSubject`\<[`SessionInfo`](../type-aliases/SessionInfo.md)\>
+
+#### Implementation of
+
+[`PodOsSession`](../interfaces/PodOsSession.md).[`observeSession`](../interfaces/PodOsSession.md#observesession)

homepage/docs/reference/core/classes/AssumeAlwaysOnline.md

@@ -0,0 +1,39 @@
+[**@pod-os/core**](../README.md)
+
+***
+
+[@pod-os/core](../globals.md) / AssumeAlwaysOnline
+
+# Class: AssumeAlwaysOnline
+
+Defined in: [offline-cache/OnlineStatus.ts:5](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/offline-cache/OnlineStatus.ts#L5)
+
+## Implements
+
+- [`OnlineStatus`](../interfaces/OnlineStatus.md)
+
+## Constructors
+
+### Constructor
+
+> **new AssumeAlwaysOnline**(): `AssumeAlwaysOnline`
+
+#### Returns
+
+`AssumeAlwaysOnline`
+
+## Methods
+
+### isOnline()
+
+> **isOnline**(): `boolean`
+
+Defined in: [offline-cache/OnlineStatus.ts:6](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/offline-cache/OnlineStatus.ts#L6)
+
+#### Returns
+
+`boolean`
+
+#### Implementation of
+
+[`OnlineStatus`](../interfaces/OnlineStatus.md).[`isOnline`](../interfaces/OnlineStatus.md#isonline)

homepage/docs/reference/core/classes/BinaryFile.md

@@ -0,0 +1,63 @@
+[**@pod-os/core**](../README.md)
+
+***
+
+[@pod-os/core](../globals.md) / BinaryFile
+
+# Class: BinaryFile
+
+Defined in: [files/BinaryFile.ts:3](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BinaryFile.ts#L3)
+
+## Implements
+
+- [`SolidFile`](../interfaces/SolidFile.md)
+
+## Constructors
+
+### Constructor
+
+> **new BinaryFile**(`url`, `data`): `BinaryFile`
+
+Defined in: [files/BinaryFile.ts:4](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BinaryFile.ts#L4)
+
+#### Parameters
+
+##### url
+
+`string`
+
+##### data
+
+`Blob`
+
+#### Returns
+
+`BinaryFile`
+
+## Properties
+
+### url
+
+> `readonly` **url**: `string`
+
+Defined in: [files/BinaryFile.ts:5](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BinaryFile.ts#L5)
+
+#### Implementation of
+
+[`SolidFile`](../interfaces/SolidFile.md).[`url`](../interfaces/SolidFile.md#url)
+
+## Methods
+
+### blob()
+
+> **blob**(): `Blob`
+
+Defined in: [files/BinaryFile.ts:9](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BinaryFile.ts#L9)
+
+#### Returns
+
+`Blob`
+
+#### Implementation of
+
+[`SolidFile`](../interfaces/SolidFile.md).[`blob`](../interfaces/SolidFile.md#blob)

homepage/docs/reference/core/classes/BrokenFile.md

@@ -0,0 +1,85 @@
+[**@pod-os/core**](../README.md)
+
+***
+
+[@pod-os/core](../globals.md) / BrokenFile
+
+# Class: BrokenFile
+
+Defined in: [files/BrokenFile.ts:4](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BrokenFile.ts#L4)
+
+## Implements
+
+- [`SolidFile`](../interfaces/SolidFile.md)
+
+## Constructors
+
+### Constructor
+
+> **new BrokenFile**(`url`, `status`): `BrokenFile`
+
+Defined in: [files/BrokenFile.ts:5](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BrokenFile.ts#L5)
+
+#### Parameters
+
+##### url
+
+`string`
+
+##### status
+
+[`HttpStatus`](HttpStatus.md)
+
+#### Returns
+
+`BrokenFile`
+
+## Properties
+
+### status
+
+> `readonly` **status**: [`HttpStatus`](HttpStatus.md)
+
+Defined in: [files/BrokenFile.ts:7](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BrokenFile.ts#L7)
+
+***
+
+### url
+
+> `readonly` **url**: `string`
+
+Defined in: [files/BrokenFile.ts:6](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BrokenFile.ts#L6)
+
+#### Implementation of
+
+[`SolidFile`](../interfaces/SolidFile.md).[`url`](../interfaces/SolidFile.md#url)
+
+## Methods
+
+### blob()
+
+> **blob**(): `null` \| `Blob`
+
+Defined in: [files/BrokenFile.ts:14](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BrokenFile.ts#L14)
+
+#### Returns
+
+`null` \| `Blob`
+
+#### Implementation of
+
+[`SolidFile`](../interfaces/SolidFile.md).[`blob`](../interfaces/SolidFile.md#blob)
+
+***
+
+### toString()
+
+> **toString**(): `string`
+
+Defined in: [files/BrokenFile.ts:10](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BrokenFile.ts#L10)
+
+Returns a string representation of an object.
+
+#### Returns
+
+`string`

homepage/docs/reference/core/classes/HttpStatus.md

@@ -0,0 +1,59 @@
+[**@pod-os/core**](../README.md)
+
+***
+
+[@pod-os/core](../globals.md) / HttpStatus
+
+# Class: HttpStatus
+
+Defined in: [files/HttpStatus.ts:1](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/HttpStatus.ts#L1)
+
+## Constructors
+
+### Constructor
+
+> **new HttpStatus**(`code`, `text?`): `HttpStatus`
+
+Defined in: [files/HttpStatus.ts:2](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/HttpStatus.ts#L2)
+
+#### Parameters
+
+##### code
+
+`number`
+
+##### text?
+
+`string`
+
+#### Returns
+
+`HttpStatus`
+
+## Properties
+
+### code
+
+> `readonly` **code**: `number`
+
+Defined in: [files/HttpStatus.ts:3](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/HttpStatus.ts#L3)
+
+***
+
+### text?
+
+> `readonly` `optional` **text**: `string`
+
+Defined in: [files/HttpStatus.ts:4](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/HttpStatus.ts#L4)
+
+## Methods
+
+### toString()
+
+> **toString**(): `string`
+
+Defined in: [files/HttpStatus.ts:7](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/HttpStatus.ts#L7)
+
+#### Returns
+
+`string`