feat: descriptive props on the test page

fixes #5

.build.yml

@@ -0,0 +1,11 @@
+image: alpine/edge
+secrets:
+  - bbfcb6dc-7c4a-42ee-a11a-022f0339a133
+environment:
+  REPO: astro-resume
+  GH_USER: ayoayco
+tasks:
+  - push-mirror: |
+      cd ~/"${REPO}"
+      git config --global credential.helper store
+      git push --mirror "https://github.com/${GH_USER}/${REPO}"

README.md

@@ -1,11 +1,20 @@
+> [!NOTE]
+> This project moved to [SourceHut](https://git.sr.ht/~ayoayco/astro-resume).
+
 # Astro Resume
 
+[![Package information: NPM version](https://img.shields.io/npm/v/@ayco/astro-resume)](https://www.npmjs.com/package/@ayco/astro-resume)
+[![Package information: NPM license](https://img.shields.io/npm/l/@ayco/astro-resume)](https://www.npmjs.com/package/@ayco/astro-resume)
+[![Package information: NPM downloads](https://img.shields.io/npm/dt/@ayco/astro-resume)](https://www.npmjs.com/package/@ayco/astro-resume)
+
 Utilities for serializing data from server for use in the client.
 
-1. `Resumable` Astro component takes `id` and `data`
+1. `Serialize` - Astro component that takes `id` and `data`
-1. `resume(id: string): Object` function for use int he client takes an `id` string and returns the `data` as Object
+1. `deserialize()` - a function for use in the client that takes an `id` string and returns the `data` object
 
-## Intallation
+## Install via npm
+
+On your [Astro](https://astro.build) project:
 
 ```
 npm i @ayco/astro-resume
@@ -13,26 +22,186 @@ npm i @ayco/astro-resume
 
 ## Usage
 
+Serializing and deserializing basic primitive data
+
 ```astro
 ---
-import Resumable from "@ayco/astro-resume";
+import Serialize from "@ayco/astro-resume";
+
 const data = {
-	hello: 'world'
+	hello: 'world',
 }
 ---
 
-<Resumable id="astro-obj" data={data} />
+<Serialize id="my-data" data={data} />
 
 <script>
-	import {resume} from '@ayco/astro-resume';
+import {deserialize} from '@ayco/astro-resume';
-	console.log(
+const data = deserialize('my-data');
-		resume('astro-obj')
+console.log(data) // {hello: 'world'}
-	)
 </script>
 
 ```
 
-## Found issues?
+## Type Safety
 
-Send a plain text email to [~ayoayco/astro-resume@todo.sr.ht](mailto:~ayoayco/astro-resume@todo.sr.ht) or report via [SourceHut](https://todo.sr.ht/~ayoayco/astro-resume)
+You can define a type for the data and use it in the client script.
 
+```astro
+---
+import Serialize from "@ayco/astro-resume";
+
+const data = {
+	hello: 'world',
+	isOkay: true
+}
+// define the type of data to be serialized
+export type Data = typeof data;
+---
+
+<Serialize id="my-data" data={data} />
+
+<script>
+import {deserialize} from '@ayco/astro-resume';
+
+/**
+* reuse the type in the client
+* assuming this component's name is `ThisComponent.astro`
+*/
+import type {Data} from './ThisComponent.astro';
+
+const data = deserialize<Data>('my-data');
+
+console.log(data) // {hello: 'world', isOkay: true}
+</script>
+```
+
+## Passing all Astro.props to client
+
+If you need to make all the component props to the client script:
+
+```astro
+---
+import Serialize from "@ayco/astro-resume";
+export interface Props {
+	hello: string;
+	isOkay: boolean;
+}
+---
+
+<Serialize id="preferences" data={{...Astro.props}} />
+
+<script>
+import {deserialize} from '@ayco/astro-resume';
+import type {Props} from './ThisComponent.astro';
+const {hello, isOkay} = deserialize<Props>('preferences');
+console.log(hello, isOkay);
+</script>
+```
+
+## Serialize server data once, access everywhere
+
+If you have shared data that needs to be initialized from the server and accessed in several places on the client-side, you can use `Serialize` once and `deserialize` in any number of Astro components as long as they are in the same page.
+
+In this example, an appConfig object is built and serialized in index.astro and accessed in child Astro components.
+
+In index.astro:
+```astro
+import Serialize from "@ayco/astro-resume";
+
+const appConfig = {
+	someClientSideKey: '1234hello',
+}
+export type AppConfig = typeof appConfig;
+---
+
+<Serialize id="app-config" data={appConfig} />
+<Child />
+```
+
+In Child.astro:
+```astro
+<h1>I'm a child. I have access to the appConfig in index!</h1>
+<GrandChild />
+<script>
+import {deserialize} from '@ayco/astro-resume';
+import type {AppConfig} from '..pages/index.astro';
+const data = deserialize<AppConfig>('app-config');
+
+// ... do something with the app config
+</script>
+```
+
+In GrandChild.astro:
+```astro
+<h1>I'm a grand child. I also have access to the appConfig in index!</h1>
+<script>
+import {deserialize} from '@ayco/astro-resume';
+import type {AppConfig} from '..pages/index.astro';
+const data = deserialize<AppConfig>('app-config');
+
+// ... do something with the app config
+</script>
+```
+
+## Using a custom serializer and parser
+
+You can bring your own custom serializer/parser if you want to opt for more complex data handling.
+
+Here's an example of serializing data that `JSON.stringify` cannot (e.g., Date or BigInt) using Rich Harris' [`devalue`](https://github.com/Rich-Harris/devalue):
+
+```astro
+---
+import {stringify} from 'devalue';
+import Serialize from "@ayco/astro-resume";
+const data = {
+    now: new Date(),
+    age: BigInt('3218378192378')
+}
+export type Data = typeof data;
+---
+
+<Serialize data={data} id="my-data" use={stringify} />
+
+<script>
+import {parse} from 'devalue';
+import {deserialize} from '@ayco/astro-resume';
+import type {Data} from './index.astro';
+
+const {age, now} = deserialize<Data>('my-data', parse);
+console.log(typeof age); // 'bigint'
+console.log(now instanceof Date); // true
+</script>
+```
+
+## Errors & Warning in `deserialize()`
+
+The `deserialize()` function may give you the following:
+1. **ERR: No match found** - there are no `JSON` scripts with the given ID
+1. **WARNING: Multiple matches for <id>** - there were multiple `JSON` scripts found with the same ID
+
+## About
+
+This is a quick and easy pattern to embed serialized information into your HTML and make it available in the client-side script with type safety.
+
+The `Serialize` component will write the data as JSON wrapped in a `<script type="application/json">` element to hold the string.
+
+The `deserialize()` function can then parse the value string for use in your client script.
+
+There is also a pattern [given in the Astro docs](https://docs.astro.build/en/guides/client-side-scripts/#pass-frontmatter-variables-to-scripts) to use a Custom Element that takes a `data-` prop which properly protects the scope of your component. That is a good pattern to follow for complex applications that don't use UI frameworks.
+
+## Trade-Off
+
+Some other frameworks themselves will manage serialized information and the IDs for you, but we don't have access to this in Astro as we are not really shipping a framework to the browser.
+
+That's nice and ideal (in my opinion), as we are aware of how the HTML is formed and what we are shipping to our users. The trade off is that we do have to manage things ourselves.
+
+You have to manage the IDs (i.e., make sure they are unique) and understand that the `deserialize()` function will crawl the whole document incurring a minimal performance cost depending on how big your HTML is.
+
+## Road Map
+
+See the [TODO tracker](https://todo.sr.ht/~ayoayco/astro-resume) for planned work items.
+
+## Reporting Issues
+
+To report issues or request features, send a plain text email to [~ayoayco/astro-resume@todo.sr.ht](mailto:~ayoayco/astro-resume@todo.sr.ht) or file a ticket via [SourceHut](https://todo.sr.ht/~ayoayco/astro-resume)

astro.config.mjs

@@ -1,4 +1,6 @@
 import { defineConfig } from 'astro/config';
 
 // https://astro.build/config
-export default defineConfig({});
+export default defineConfig({
+  output: "server",
+});

index.ts

@@ -1,5 +1,5 @@
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
-import Resumable from './src/Resumable.astro';
+import Serialize from './src/Serialize.astro';
-export default Resumable;
+export default Serialize;
-export * from './src/resume';
+export * from './src/deserialize';

package.json

@@ -1,9 +1,13 @@
 {
   "name": "@ayco/astro-resume",
   "author": "Ayo Ayco",
-  "homepage": "https://sr.ht/~ayoayco/astro-resume",
+  "homepage": "https://ayco.io/sh/astro-resume",
+  "repository": {
+    "type": "git",
+    "url": "https://git.sr.ht/~ayoayco/astro-resume"
+  },
   "type": "module",
-  "version": "0.0.7",
+  "version": "0.4.3",
   "keywords": [
     "astro-component",
     "css",
@@ -14,8 +18,8 @@
     ".": "./index.ts"
   },
   "files": [
-    "src/Resumable.astro",
+    "src/Serialize.astro",
-    "src/resume.ts",
+    "src/deserialize.ts",
     "index.ts"
   ],
   "scripts": {
@@ -23,9 +27,14 @@
     "start": "astro dev",
     "build": "astro build",
     "preview": "astro preview",
-    "astro": "astro"
+    "astro": "astro",
+    "publish:patch": "npm version patch && npm publish --access public",
+    "publish:minor": "npm version minor && npm publish --access public"
   },
-  "dependencies": {
+  "devDependencies": {
-    "astro": "^2.8.3"
+    "devalue": "^5.1.1"
+  },
+  "peerDependencies": {
+    "astro": "^5"
   }
 }

src/Resumable.astro

@@ -1,9 +0,0 @@
----
-export interface Props {
-    id: string;
-    data: Object;
-}
-const {id, data} = Astro.props;
----
-
-<textarea hidden id={id}>{JSON.stringify(data)}</textarea>

src/Serialize.astro

@@ -0,0 +1,36 @@
+---
+// type Primitive = string | number | boolean | null | undefined;
+
+export interface Props {
+    /**
+     * The id that the client script will pass to the `deserialize()` function
+     */
+    id: string;
+    /**
+     * The data to be serialized and accessed in the client script with `deserialize()`
+     */
+    data: Record<string, any>;
+    /**
+     * Custom serializer to be used
+     * @param data 
+     */
+    use?: (data: Record<string, any>) => string;
+}
+const {id, data, use} = Astro.props;
+let serializedData = '{}'
+try {
+    serializedData = use ? use(data) : JSON.stringify(data);
+} catch(err) {
+    /**
+     *  ERR: data is unserializable
+     *  - You might need a custom serializer/parser for complex data
+     *  - Usage examples in 👉 https://git.sr.ht/~ayoayco/astro-resume#astro-resume
+     */
+    throw Error(`astro-resume ERR: Data unserializable
+- You might need a custom serializer/parser for complex data
+- Usage examples in 👉 https://git.sr.ht/~ayoayco/astro-resume#astro-resume
+    `, err)
+}
+---
+
+<script type="application/json" id={id} set:html={serializedData}></script>

src/deserialize.ts

@@ -0,0 +1,31 @@
+/**
+ * Function to find and deserialize JSON data from the HTML
+ * @param id The id of the Serialize component, used to find the serialized data in the HTML
+ * @param parser Custom parser to be used
+ * @returns The deserialized JSON data
+ * @see Usage examples in 👉 https://git.sr.ht/~ayoayco/astro-resume#astro-resume
+**/
+export function deserialize<T = any>(id: string, parser?: (serialized: string)=>any): T {
+    const elements = document.querySelectorAll<HTMLScriptElement>(`script#${id}[type="application/json"]`);
+
+    if (elements?.length > 0) {
+        if (elements?.length > 1)
+            console.warn(`astro-resume WARN: Multiple matches for "${id}". The function will parse the first one.`)
+
+        const element = elements[0];
+
+        if (element?.textContent)
+            return parser
+                ? parser(element.textContent)
+                : JSON.parse(element.textContent)
+    }
+        
+    throw Error(`astro-resume ERR: No match found.
+    "deserialize('${id}')" did not find any data.
+    Check that the following are correct:
+    - The Serialize component is used with correct props
+    - "data" prop is not undefined
+    - "${id}" is the "id" of the Serialize component
+    See examples: https://sr.ht/~ayoayco/astro-resume/#usage
+Stack trace: `)
+}

src/env.d.ts

@@ -1 +1,2 @@
+/// <reference path="../.astro/types.d.ts" />
 /// <reference types="astro/client" />

src/pages/index.astro

@@ -1,19 +1,44 @@
 ---
-import Resumable from '../Resumable.astro';
+import Serialize from "../Serialize.astro";
+import { stringify } from "devalue";
 const data = {
-    hello: 'world'
+  nameStr: "John Doe",
-}
+  isOkayBool: true,
+  moodNull: null,
+  nowDate: new Date(),
+  ageBigInt: BigInt("3218378192378"),
+};
+export type Data = typeof data;
 ---
 
-<Resumable id="astro-obj" data={data} />
-
 <div id="render-here"></div>
+<Serialize data={data} id="my-data" use={stringify} />
 
 <script>
-    import {resume} from '../resume';
+  import { deserialize } from "../deserialize";
-    console.log(resume('astro-obj'));
+  import { parse } from "devalue";
-    const renderDiv = document.querySelector('#render-here');
+  import type { Data } from "./index.astro";
-    if (renderDiv) {
+
-        renderDiv.innerHTML =  JSON.stringify(resume('astro-obj'))
+  const data = deserialize<Data>("my-data", parse);
-    }
+  console.log(data);
-</script>
+
+  Object.keys(data).forEach((key) =>
+    console.log(key, data[key], typeof data[key])
+  );
+
+  // render table to render-here
+  const table = document.createElement("table");
+  const tbody = document.createElement("tbody");
+  table.appendChild(tbody);
+  Object.keys(data).forEach((key) => {
+    const tr = document.createElement("tr");
+    const tdKey = document.createElement("td");
+    const tdValue = document.createElement("td");
+    tdKey.textContent = key;
+    tdValue.textContent = data[key];
+    tr.appendChild(tdKey);
+    tr.appendChild(tdValue);
+    tbody.appendChild(tr);
+  });
+  document.getElementById("render-here").appendChild(table);
+</script>

src/registry.ts

@@ -0,0 +1,12 @@
+export class SerializedRegistry {
+    private _registeredIds: string[]
+    constructor() {}
+    get registeredIds() {
+        return this._registeredIds;
+    }
+    public register(id: string) {
+        if (this._registeredIds.includes(id))
+            throw Error(`${id} is already used`)
+        this._registeredIds.push(id);
+    }
+}

src/resume.ts

@@ -1,3 +0,0 @@
-export function resume(id: string): Object {
-    return JSON.parse(document.querySelector<HTMLTextAreaElement>(`#${id}`)?.value ?? '')
-}