@livon/client 0.27.0-rc.5 → 0.28.0-rc.4

package/README.md

@@ -1,8 +1,21 @@
+<!-- Generated from website/docs/packages/*.md. Do not edit directly. -->
+
 # @livon/client
 
+
+[![npm](https://img.shields.io/npm/v/%40livon%2Fclient)](https://www.npmjs.com/package/@livon/client)
+[![dependencies](https://img.shields.io/librariesio/release/npm/%40livon%2Fclient?label=dependencies)](https://libraries.io/npm/%40livon%2Fclient)
+[![code quality](https://img.shields.io/github/actions/workflow/status/live-input-vector-output-node/livon-ts/code-quality.yml?branch=main&label=code%20quality)](https://github.com/live-input-vector-output-node/livon-ts/actions/workflows/code-quality.yml)
+[![package size](https://img.shields.io/npm/unpacked-size/%40livon%2Fclient?label=package%20size)](https://www.npmjs.com/package/@livon/client)
+[![license](https://img.shields.io/github/license/live-input-vector-output-node/livon-ts)](https://github.com/live-input-vector-output-node/livon-ts)
+
 ## Purpose
 
-[@livon/client](https://live-input-vector-output-node.github.io/livon-ts/docs/packages/client) provides deterministic client interface execution and generated-client foundations.
+[@livon/client](https://livon.tech/docs/packages/client) provides deterministic client interface execution and generated-client foundations.
+
+## Best for
+
+Use this package when frontend apps consume generated LIVON APIs and typed subscription handlers.
 
 Exports include:
 
@@ -10,6 +23,28 @@ Exports include:
 - `createClientModule`
 - `clientModule`
 
+## Generator sync policy
+
+Generated client surfaces and hover docs are built from the client generator.
+When generator output changes, docs must be updated in sync.
+
+- Rule source: `packages/client/PROMPT.md`
+- JSDoc reference: [SchemaDoc & Generated JSDoc](https://livon.tech/docs/core/schema-doc-and-generated-jsdoc)
+
+Current generated typing behavior to keep in sync:
+
+- `and(...)` schema nodes are emitted as TypeScript intersections (`Left & Right`).
+- If schema composition passes an explicit `name`, that name is used as the generated type name.
+
+### Central TypeScript surface template
+
+Generated interface and signature syntax is centralized in:
+
+- `packages/client/src/typeScriptSurfaceTemplate.ts`
+
+Use this file when TypeScript surface style should change globally (for example interface member syntax, callable signatures, or method/property signature formatting).
+This avoids editing many render call sites in `packages/client/src/generate.ts`.
+
 ## Install
 
 ```sh
@@ -103,7 +138,8 @@ runtime(transport, module);
 
 ## Related pages
 
-- [@livon/runtime](https://live-input-vector-output-node.github.io/livon-ts/docs/packages/runtime)
-- [@livon/client-ws-transport](https://live-input-vector-output-node.github.io/livon-ts/docs/packages/client-ws-transport)
-- [@livon/schema](https://live-input-vector-output-node.github.io/livon-ts/docs/packages/schema)
-- [Schema APIs](https://live-input-vector-output-node.github.io/livon-ts/docs/schema)
+- [@livon/runtime](https://livon.tech/docs/packages/runtime)
+- [@livon/client-ws-transport](https://livon.tech/docs/packages/client-ws-transport)
+- [@livon/schema](https://livon.tech/docs/packages/schema)
+- [SchemaDoc & Generated JSDoc](https://livon.tech/docs/core/schema-doc-and-generated-jsdoc)
+- [Schema APIs](https://livon.tech/docs/schema)

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1 @@
+No third-party notices are required for this package at this time.

package/dist/client.cjs

@@ -1,85 +1,55 @@
 "use strict";
-const __rslib_import_meta_url__ = /*#__PURE__*/ (function () {
-  return typeof document === 'undefined'
-    ? new (require('url'.replace('', '')).URL)('file:' + __filename).href
-    : (document.currentScript && document.currentScript.src) ||
-      new URL('main.js', document.baseURI).href;
-})();
-;
-// The require scope
 var __webpack_require__ = {};
-
-// webpack/runtime/define_property_getters
-(() => {
-__webpack_require__.d = (exports, definition) => {
-	for(var key in definition) {
-        if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {
-            Object.defineProperty(exports, key, { enumerable: true, get: definition[key] });
-        }
-    }
-};
+(()=>{
+    __webpack_require__.d = (exports1, definition)=>{
+        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
+            enumerable: true,
+            get: definition[key]
+        });
+    };
 })();
-// webpack/runtime/has_own_property
-(() => {
-__webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))
+(()=>{
+    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
 })();
-// webpack/runtime/make_namespace_object
-(() => {
-// define __esModule on exports
-__webpack_require__.r = (exports) => {
-	if(typeof Symbol !== 'undefined' && Symbol.toStringTag) {
-		Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-	}
-	Object.defineProperty(exports, '__esModule', { value: true });
-};
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ("u" > typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
 })();
 var __webpack_exports__ = {};
 __webpack_require__.r(__webpack_exports__);
 __webpack_require__.d(__webpack_exports__, {
-  clientModule: () => (clientModule),
-  createClient: () => (createClient),
-  createClientModule: () => (createClientModule)
+    clientModule: ()=>clientModule,
+    createClient: ()=>createClient,
+    createClientModule: ()=>createClientModule
 });
 const DEFAULT_REQUEST_KEY = 'livon.client.request';
 const setClientRequest = ({ client, registry, requestKey })=>{
-    if (typeof client !== 'object' || client === null || !('setRequest' in client)) {
-        return;
-    }
+    if ('object' != typeof client || null === client || !('setRequest' in client)) return;
     const candidate = client;
-    if (typeof candidate.setRequest !== 'function') {
-        return;
-    }
+    if ('function' != typeof candidate.setRequest) return;
     candidate.setRequest((event, payload)=>{
         const request = registry.state.get(requestKey);
-        if (!request) {
-            throw new Error('Client request handler is not available.');
-        }
+        if (!request) throw new Error('Client request handler is not available.');
         return request(event, payload);
     });
 };
 const buildClientEventEnvelope = (envelope)=>{
-    if ('payload' in envelope) {
-        return {
-            ...envelope,
-            payload: envelope.payload
-        };
-    }
+    if ('payload' in envelope) return {
+        ...envelope,
+        payload: envelope.payload
+    };
     return {
         ...envelope,
         error: envelope.error
     };
 };
-/**
- * clientModule is part of the public LIVON API.
- *
- * @remarks
- * Parameter and return types are defined in the TypeScript signature.
- *
- * @see https://live-input-vector-output-node.github.io/livon-ts/docs/packages/client
- *
- * @example
- * const result = clientModule(undefined as never);
- */ const clientModule = (client, options = {})=>{
+const clientModule = (client, options = {})=>{
     const register = (registry)=>{
         const requestKey = options.requestKey ?? DEFAULT_REQUEST_KEY;
         setClientRequest({
@@ -97,9 +67,9 @@ const buildClientEventEnvelope = (envelope)=>{
         register
     };
 };
-const isRecord = (value)=>typeof value === 'object' && value !== null && !Array.isArray(value);
+const isRecord = (value)=>'object' == typeof value && null !== value && !Array.isArray(value);
 const isArray = (value)=>Array.isArray(value);
-const capitalize = (value)=>value.length === 0 ? value : value.slice(0, 1).toUpperCase() + value.slice(1);
+const capitalize = (value)=>0 === value.length ? value : value.slice(0, 1).toUpperCase() + value.slice(1);
 const camelCaseName = (value)=>{
     if (!value) return value;
     return value.replace(/[^a-zA-Z0-9]+(.)/g, (_, group)=>String(group).toUpperCase()).replace(/^./, (char)=>char.toLowerCase());
@@ -113,9 +83,7 @@ const walkAst = (node, visit)=>{
 const collectOperations = (root)=>{
     const operations = [];
     walkAst(root, (node)=>{
-        if (node.type !== 'operation' || !node.name) {
-            return;
-        }
+        if ('operation' !== node.type || !node.name) return;
         const input = node.children?.[0];
         const output = node.children?.[1];
         operations.push({
@@ -130,22 +98,16 @@ const collectOperations = (root)=>{
 const collectFieldOperations = (root)=>{
     const registry = new Map();
     walkAst(root, (node)=>{
-        if (node.type !== 'field') {
-            return;
-        }
+        if ('field' !== node.type) return;
         const constraints = node.constraints;
-        const owner = typeof constraints?.owner === 'string' ? constraints.owner : undefined;
-        const field = typeof constraints?.field === 'string' ? constraints.field : undefined;
-        if (!owner || !field) {
-            return;
-        }
+        const owner = 'string' == typeof constraints?.owner ? constraints.owner : void 0;
+        const field = 'string' == typeof constraints?.field ? constraints.field : void 0;
+        if (!owner || !field) return;
         const children = node.children ?? [];
         const dependsOn = children[0];
-        const input = children.length === 3 ? children[1] : undefined;
-        const output = children.length === 3 ? children[2] : children[1];
-        if (!dependsOn) {
-            return;
-        }
+        const input = 3 === children.length ? children[1] : void 0;
+        const output = 3 === children.length ? children[2] : children[1];
+        if (!dependsOn) return;
         const spec = {
             owner,
             field,
@@ -153,18 +115,14 @@ const collectFieldOperations = (root)=>{
             output,
             event: fieldEventName(owner, field)
         };
-        if (!registry.has(owner)) {
-            registry.set(owner, new Map());
-        }
+        if (!registry.has(owner)) registry.set(owner, new Map());
         registry.get(owner).set(field, spec);
     });
     return registry;
 };
 const hydrateByNode = ({ value, node, registry, request })=>{
-    if (!node) {
-        return value;
-    }
-    if (node.type === 'array' && isArray(value)) {
+    if (!node) return value;
+    if ('array' === node.type && isArray(value)) {
         const child = node.children?.[0];
         value.forEach((item, index)=>{
             value[index] = hydrateByNode({
@@ -176,7 +134,7 @@ const hydrateByNode = ({ value, node, registry, request })=>{
         });
         return value;
     }
-    if (node.type === 'tuple' && isArray(value)) {
+    if ('tuple' === node.type && isArray(value)) {
         const children = node.children ?? [];
         value.forEach((item, index)=>{
             value[index] = hydrateByNode({
@@ -188,33 +146,25 @@ const hydrateByNode = ({ value, node, registry, request })=>{
         });
         return value;
     }
-    if (node.type === 'and') {
-        return (node.children ?? []).reduce((current, child)=>hydrateByNode({
-                value: current,
-                node: child,
-                registry,
-                request
-            }), value);
-    }
-    if (node.type === 'object' && isRecord(value)) {
+    if ('and' === node.type) return (node.children ?? []).reduce((current, child)=>hydrateByNode({
+            value: current,
+            node: child,
+            registry,
+            request
+        }), value);
+    if ('object' === node.type && isRecord(value)) {
         const typeName = node.name;
-        if (typeName && registry.has(typeName)) {
-            attachFieldOperations({
-                target: value,
-                typeName,
-                registry,
-                request
-            });
-        }
+        if (typeName && registry.has(typeName)) attachFieldOperations({
+            target: value,
+            typeName,
+            registry,
+            request
+        });
         const fields = node.children ?? [];
         fields.forEach((fieldNode)=>{
-            if (fieldNode.type !== 'field' || !fieldNode.name) {
-                return;
-            }
+            if ('field' !== fieldNode.type || !fieldNode.name) return;
             const child = fieldNode.children?.[0];
-            if (!child) {
-                return;
-            }
+            if (!child) return;
             value[fieldNode.name] = hydrateByNode({
                 value: value[fieldNode.name],
                 node: child,
@@ -224,7 +174,7 @@ const hydrateByNode = ({ value, node, registry, request })=>{
         });
         return value;
     }
-    if (node.type === 'field') {
+    if ('field' === node.type) {
         const child = node.children?.[0];
         return hydrateByNode({
             value,
@@ -237,16 +187,10 @@ const hydrateByNode = ({ value, node, registry, request })=>{
 };
 const attachFieldOperations = ({ target, typeName, registry, request })=>{
     const operations = registry.get(typeName);
-    if (!operations) {
-        return;
-    }
-    if (!Object.isExtensible(target)) {
-        return;
-    }
+    if (!operations) return;
+    if (!Object.isExtensible(target)) return;
     operations.forEach((spec, fieldName)=>{
-        if (fieldName in target) {
-            return;
-        }
+        if (fieldName in target) return;
         Object.defineProperty(target, fieldName, {
             enumerable: false,
             configurable: true,
@@ -269,12 +213,10 @@ const attachFieldOperations = ({ target, typeName, registry, request })=>{
 const normalizeFieldPayload = (payload)=>{
     if (isRecord(payload) && 'dependsOn' in payload) {
         const dependsOn = payload.dependsOn;
-        const input = 'input' in payload ? payload.input : undefined;
-        if (input === undefined) {
-            return {
-                dependsOn
-            };
-        }
+        const input = 'input' in payload ? payload.input : void 0;
+        if (void 0 === input) return {
+            dependsOn
+        };
         return {
             dependsOn,
             input
@@ -297,17 +239,12 @@ const createClientCore = ({ ast })=>{
     const roomHandlers = new Map();
     const roomEnabled = new Map();
     const registerHandlers = (handlers, roomId)=>{
-        const entries = Object.entries(handlers).filter(([, handler])=>typeof handler === 'function');
-        if (entries.length === 0) {
-            return;
-        }
-        if (!roomId) {
-            entries.forEach(([event, handler])=>{
-                globalHandlers.set(event, handler);
-                globalEnabled.set(event, true);
-            });
-            return;
-        }
+        const entries = Object.entries(handlers).filter(([, handler])=>'function' == typeof handler);
+        if (0 === entries.length) return;
+        if (!roomId) return void entries.forEach(([event, handler])=>{
+            globalHandlers.set(event, handler);
+            globalEnabled.set(event, true);
+        });
         const roomMap = roomHandlers.get(roomId) ?? new Map();
         const enabledMap = roomEnabled.get(roomId) ?? new Map();
         entries.forEach(([event, handler])=>{
@@ -318,10 +255,7 @@ const createClientCore = ({ ast })=>{
         roomEnabled.set(roomId, enabledMap);
     };
     const toggleHandler = ({ enabled, event, roomId })=>{
-        if (!roomId) {
-            globalEnabled.set(event, enabled);
-            return;
-        }
+        if (!roomId) return void globalEnabled.set(event, enabled);
         const enabledMap = roomEnabled.get(roomId) ?? new Map();
         enabledMap.set(event, enabled);
         roomEnabled.set(roomId, enabledMap);
@@ -333,7 +267,7 @@ const createClientCore = ({ ast })=>{
             status: envelope.status,
             metadata: envelope.metadata,
             context: envelope.context,
-            room: typeof envelope.metadata?.room === 'string' ? String(envelope.metadata.room) : undefined
+            room: 'string' == typeof envelope.metadata?.room ? String(envelope.metadata.room) : void 0
         };
         const roomId = ctx.room;
         if (roomId) {
@@ -341,21 +275,15 @@ const createClientCore = ({ ast })=>{
             const roomMap = roomHandlers.get(roomId);
             const handler = roomMap?.get(envelope.event);
             const isEnabled = enabledMap?.get(envelope.event) ?? true;
-            if (handler && isEnabled) {
-                handler(envelope.payload, ctx);
-            }
+            if (handler && isEnabled) handler(envelope.payload, ctx);
         }
         const handler = globalHandlers.get(envelope.event);
         const isEnabled = globalEnabled.get(envelope.event) ?? true;
-        if (handler && isEnabled) {
-            handler(envelope.payload, ctx);
-        }
+        if (handler && isEnabled) handler(envelope.payload, ctx);
     };
     operations.forEach((op)=>{
         client[op.name] = async (input)=>{
-            if (!request) {
-                throw new Error('Client request handler is not available.');
-            }
+            if (!request) throw new Error('Client request handler is not available.');
             const result = await request(op.event, input);
             return hydrateByNode({
                 value: result,
@@ -368,14 +296,10 @@ const createClientCore = ({ ast })=>{
     fieldRegistry.forEach((fields, owner)=>{
         fields.forEach((spec, field)=>{
             const method = fieldMethodName(owner, field);
-            if (method in client) {
-                return;
-            }
+            if (method in client) return;
             client[method] = async (payload, input)=>{
                 const normalized = normalizeFieldPayload(payload);
-                if (!request) {
-                    throw new Error('Client request handler is not available.');
-                }
+                if (!request) throw new Error('Client request handler is not available.');
                 const result = await request(spec.event, {
                     dependsOn: normalized.dependsOn,
                     input: input ?? normalized.input
@@ -399,17 +323,7 @@ const createClientCore = ({ ast })=>{
         emitEvent: dispatch
     });
 };
-/**
- * createClient is part of the public LIVON API.
- *
- * @remarks
- * Parameter and return types are defined in the TypeScript signature.
- *
- * @see https://live-input-vector-output-node.github.io/livon-ts/docs/packages/client
- *
- * @example
- * const result = createClient(undefined as never);
- */ const createClient = (input)=>{
+const createClient = (input)=>{
     const client = createClientCore({
         ast: input.ast
     });
@@ -432,24 +346,15 @@ const createClientCore = ({ ast })=>{
     const moduleWithClient = Object.assign(moduleBase, client);
     return moduleWithClient;
 };
-/**
- * createClientModule is part of the public LIVON API.
- *
- * @remarks
- * Parameter and return types are defined in the TypeScript signature.
- *
- * @see https://live-input-vector-output-node.github.io/livon-ts/docs/packages/client
- *
- * @example
- * const result = createClientModule(undefined as never);
- */ const createClientModule = (input)=>createClient(input);
-
+const createClientModule = (input)=>createClient(input);
 exports.clientModule = __webpack_exports__.clientModule;
 exports.createClient = __webpack_exports__.createClient;
 exports.createClientModule = __webpack_exports__.createClientModule;
-for(var __rspack_i in __webpack_exports__) {
-  if(["clientModule","createClient","createClientModule"].indexOf(__rspack_i) === -1) {
-    exports[__rspack_i] = __webpack_exports__[__rspack_i];
-  }
-}
-Object.defineProperty(exports, '__esModule', { value: true });
+for(var __rspack_i in __webpack_exports__)if (-1 === [
+    "clientModule",
+    "createClient",
+    "createClientModule"
+].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/client.d.ts

@@ -64,7 +64,7 @@ export interface ClientModuleOptions {
  * @remarks
  * Parameter and return types are defined in the TypeScript signature.
  *
- * @see https://live-input-vector-output-node.github.io/livon-ts/docs/packages/client
+ * @see https://livon.tech/docs/packages/client
  *
  * @example
  * const result = clientModule(undefined as never);
@@ -76,7 +76,7 @@ export declare const clientModule: (client: ClientEventEmitter, options?: Client
  * @remarks
  * Parameter and return types are defined in the TypeScript signature.
  *
- * @see https://live-input-vector-output-node.github.io/livon-ts/docs/packages/client
+ * @see https://livon.tech/docs/packages/client
  *
  * @example
  * const result = createClient(undefined as never);
@@ -92,7 +92,7 @@ export declare const createClient: (input: ClientModuleInput) => ClientModule &
  * @remarks
  * Parameter and return types are defined in the TypeScript signature.
  *
- * @see https://live-input-vector-output-node.github.io/livon-ts/docs/packages/client
+ * @see https://livon.tech/docs/packages/client
  *
  * @example
  * const result = createClientModule(undefined as never);