@simplysm/service-server 13.0.42 → 13.0.43

package/README.md

@@ -18,9 +18,12 @@ pnpm add @simplysm/service-server
 
 - [`createServiceServer`](#basic-server-configuration) - Factory function for creating a `ServiceServer` instance
 - [`ServiceServer`](docs/server.md#serviceserver) - Main server class. Creates a Fastify instance and configures routes/plugins
-- [`defineService`](#custom-services) - Defines a service with a factory function pattern
+- [`defineService`](#custom-services) - Defines a service with a name and factory function
 - [`ServiceContext`](docs/server.md#servicecontext) - Context object passed to service factory functions
-- `runServiceMethod` - Internal function that dispatches a service method call (auth checks + execution)
+- [`createServiceContext`](docs/server.md#createservicecontext) - Factory function that creates a `ServiceContext` (exported for advanced use)
+- [`runServiceMethod`](docs/server.md#runservicemethod) - Dispatches a service method call with auth checks and execution
+- [`ServiceDefinition`](docs/server.md#servicedefinition) - Type describing a registered service (name + factory + authPermissions)
+- [`ServiceMethods`](docs/server.md#servicemethods) - Type utility that extracts method signatures from a `ServiceDefinition`
 
 ### Authentication
 

package/docs/server.md

@@ -154,6 +154,81 @@ import { createServiceContext } from "@simplysm/service-server";
 const ctx = createServiceContext(server, socket, httpContext, legacyContext);
 ```
 
+| Parameter | Type | Description |
+|-----------|------|------|
+| `server` | `ServiceServer<TAuthInfo>` | The server instance |
+| `socket` | `ServiceSocket \| undefined` | WebSocket connection, or `undefined` for HTTP/legacy |
+| `http` | `{ clientName: string; authTokenPayload?: AuthTokenPayload<TAuthInfo> } \| undefined` | HTTP request context |
+| `legacy` | `{ clientName?: string } \| undefined` | V1 legacy context (auto-update only) |
+
+## ServiceDefinition
+
+Type describing a registered service. Created by `defineService()`.
+
+```typescript
+import type { ServiceDefinition } from "@simplysm/service-server";
+
+interface ServiceDefinition<TMethods = Record<string, (...args: any[]) => any>> {
+  /** Service name (used as RPC route prefix, e.g., "User" → "User.getProfile") */
+  name: string;
+  /** Factory function that returns the service's method object */
+  factory: (ctx: ServiceContext) => TMethods;
+  /** Auth permissions required at service level (set by wrapping factory with auth()) */
+  authPermissions?: string[];
+}
+```
+
+Pass `ServiceDefinition[]` to `ServiceServerOptions.services` when creating the server.
+
+## ServiceMethods
+
+Type utility that extracts method signatures from a `ServiceDefinition`. Use this to share method types with the client without exposing implementation details.
+
+```typescript
+import type { ServiceMethods } from "@simplysm/service-server";
+
+export const MyService = defineService("My", (ctx) => ({
+  hello: async (name: string): Promise<string> => `Hello, ${name}!`,
+}));
+
+// Export type for client-side type sharing
+export type MyServiceType = ServiceMethods<typeof MyService>;
+// Equivalent to: { hello: (name: string) => Promise<string> }
+
+// Client usage:
+// const service = client.getService<MyServiceType>("My");
+// const result = await service.hello("World");
+```
+
+## runServiceMethod
+
+Dispatches a single service method call. Performs auth checks and executes the method. Used internally by `ServiceServer` for both WebSocket and HTTP transports, but exported for advanced use cases such as custom transports or testing.
+
+```typescript
+import { runServiceMethod } from "@simplysm/service-server";
+
+const result = await runServiceMethod(server, {
+  serviceName: "My",
+  methodName: "hello",
+  params: ["World"],
+  socket: serviceSocket, // or undefined for HTTP
+  http: undefined,       // or { clientName, authTokenPayload } for HTTP
+});
+```
+
+| Parameter | Type | Description |
+|-----------|------|------|
+| `server` | `ServiceServer` | The server instance |
+| `def.serviceName` | `string` | Name of the service to dispatch to |
+| `def.methodName` | `string` | Name of the method to invoke |
+| `def.params` | `unknown[]` | Positional arguments for the method |
+| `def.socket` | `ServiceSocket \| undefined` | WebSocket context (for WebSocket requests) |
+| `def.http` | `{ clientName: string; authTokenPayload?: AuthTokenPayload } \| undefined` | HTTP context (for HTTP requests) |
+
+Returns: `Promise<unknown>` — the method's return value.
+
+Throws if the service or method is not found, or if the caller lacks required auth permissions.
+
 ## Config File Reference
 
 Read sections from `.config.json` files using `ctx.getConfig()`. Root and per-client configs are automatically merged.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simplysm/service-server",
-  "version": "13.0.42",
+  "version": "13.0.43",
   "description": "심플리즘 패키지 - 서비스 모듈 (server)",
   "author": "김석래",
   "license": "Apache-2.0",
@@ -34,11 +34,11 @@
     "semver": "^7.7.4",
     "utf-8-validate": "^6.0.6",
     "ws": "^8.19.0",
-    "@simplysm/core-common": "13.0.42",
-    "@simplysm/orm-common": "13.0.42",
-    "@simplysm/core-node": "13.0.42",
-    "@simplysm/service-common": "13.0.42",
-    "@simplysm/orm-node": "13.0.42"
+    "@simplysm/core-common": "13.0.43",
+    "@simplysm/core-node": "13.0.43",
+    "@simplysm/orm-node": "13.0.43",
+    "@simplysm/orm-common": "13.0.43",
+    "@simplysm/service-common": "13.0.43"
   },
   "devDependencies": {
     "@types/semver": "^7.7.1",