📝 Add tsdoc

Author: jpolo

packages/application/package.json

@@ -33,7 +33,7 @@
   ],
   "scripts": {
     "build": "pnpm run \"/^build:.*/\"",
-    "build:tsc": "tsc -b tsconfig.build.json",
+    "build:tsc": "tsdown",
     "clean": "pnpm run \"/^clean:.*/\"",
     "clean:tsc": "rm -rf dist",
     "docs": "node '../../markdown.mjs'",
@@ -52,6 +52,8 @@
     "@w5s/global-storage": "workspace:^1.0.0-alpha.0"
   },
   "devDependencies": {
+    "@w5s/tsdown-config": "1.0.0-alpha.4",
+    "tsdown": "0.21.2",
     "typescript": "5.9.3",
     "vite": "latest",
     "vitest": "latest"

packages/application/src/Meta.ts

@@ -6,6 +6,7 @@ describe('index', () => {
     expect(Object.keys(Module).toSorted()).toEqual(
       [
         // public exports
+        'meta',
         'useRef',
         'useConfiguration',
         'useState',

packages/application/src/index.spec.ts

@@ -1,5 +1,5 @@
+export * from './meta.js';
 export * from './ConfigurationRef.js';
-export * from './Meta.js';
 export * from './State.js';
 export * from './StateKey.js';
 export * from './useConfiguration.js';

packages/application/src/index.ts

@@ -0,0 +1,10 @@
+export const meta = Object.freeze({
+  // @ts-ignore - these variables are injected at build time
+  name: (typeof __PACKAGE_NAME__ === 'undefined' ? '' : __PACKAGE_NAME__) as string,
+  // @ts-ignore - these variables are injected at build time
+  version: (typeof __PACKAGE_VERSION__ === 'undefined' ? '' : __PACKAGE_VERSION__) as string,
+});
+
+export interface Meta {
+  readonly name: string;
+}

packages/application/src/meta.ts

@@ -3,8 +3,21 @@ import { useRef } from './useRef.js';
 import { useNamespace } from './useNamespace.js';
 import type { Ref } from '@w5s/core';
 import type { State } from './State.js';
-import type { Meta } from './Meta.js';
+import type { Meta } from './meta.js';
 
+/**
+ *
+ * @example
+ * ```typescript
+ * const app = { name: 'my-app' };
+ * const configRef = useConfiguration(app, { mode: 'light', retries: 3 });
+ * configRef.update({ retries: 4 });
+ * console.log(configRef.current); // { mode: 'light', retries: 4 }
+ * ```
+ * @param meta
+ * @param initial
+ * @param store
+ */
 export function useConfiguration<Configuration>(
   meta: Meta,
   initial: Configuration,

packages/application/src/useConfiguration.ts

@@ -2,7 +2,7 @@ import { useRef } from './useRef.js';
 import { useStorage } from '@w5s/global-storage';
 import type { Ref } from '@w5s/core';
 import type { State } from './State.js';
-import type { Meta } from './Meta.js';
+import type { Meta } from './meta.js';
 
 /**
  * Return a new `Ref` containing the namespace for the given `meta.name`.

packages/application/src/useNamespace.ts

@@ -3,7 +3,7 @@ import { useNamespace } from './useNamespace.js';
 import { useRef } from './useRef.js';
 import type { State } from './State.js';
 import type { StateKey } from './StateKey.js';
-import type { Meta } from './Meta.js';
+import type { Meta } from './meta.js';
 
 /**
  * Return a new `Ref` containing the state for the given `meta.name` and `key`.

packages/application/src/useState.ts

@@ -0,0 +1,3 @@
+import { defineConfig } from '@w5s/tsdown-config';
+
+export default defineConfig({});