@andrew_l/service-actor 0.0.1 → 0.0.2

package/README.md

@@ -1,14 +1,25 @@
-# Description
+# Service Actor Toolkit <!-- omit in toc -->
 
-This package aims to avoid passing data like trace IDs between functions.
+![license](https://img.shields.io/npm/l/%40andrew_l%2Fservice-actor) <!-- omit in toc -->
+![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fservice-actor) <!-- omit in toc -->
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fservice-actor) <!-- omit in toc -->
 
-Actor object is structured like a simple, plain JavaScript object. This means it only contains properties (key-value pairs) without any special behaviors, so it can be used as a value in database queries without causing issues.
-
-It also means you can add functions (methods) to Actor object. These custom methods won’t interfere with the data stored in the object or show up when you loop through (iterate over) the object's properties.
+The package is designed to help manage contextual data, such as trace IDs, across functions without explicitly passing them around. This allows you to easily track and manage contexts (like user actions or requests) while keeping your code clean and decoupled from context-passing logic.
 
 [Documentation](https://men232.github.io/toolkit/reference/@andrew_l/service-actor/)
 
-# Example
+<!-- install placeholder -->
+
+## ✨ Features
+
+- **Contextual Data Management**: Allows you to manage context (such as trace IDs or user info) in a central "actor" object.
+- **No Context Passing**: Eliminates the need to manually pass context data between functions.
+- **Custom Methods**: Actor objects can contain custom methods without affecting the data or iteration logic.
+- **Compatible with Databases**: Actor objects are simple JavaScript objects and can be safely used in database queries.
+
+## 🚀 Example Usage
+
+### Setting up Actor Context
 
 ```js
 import { serviceActor } from '@andrew_l/service-actor';
@@ -22,7 +33,7 @@ const { with: withServiceActor, inject: injectServiceActor } = serviceActor(
   }),
 );
 
-// Bind actor context to the request
+// Bind actor context to the request in your middleware
 app.use((ctx, next) => {
   return withServiceActor(
     {
@@ -43,7 +54,9 @@ app.patch('/users/:id', async ctx => {
 });
 ```
 
-# Usage
+In the above example, the `traceId` and `ipAddress` are automatically associated with the current context (request), eliminating the need to manually pass them through function calls.
+
+### Using Service Actor in a Service
 
 ```js
 class UserService {
@@ -57,3 +70,12 @@ class UserService {
   }
 }
 ```
+
+In this example, the `UserService.updateById` method retrieves the `actor` object, which contains contextual information, such as the trace ID, without explicitly passing it as an argument.
+
+## 🤔 Why Use This Package?
+
+1. **No Context Passing:** Automatically manages contextual information (e.g., trace IDs, user info) across different parts of your application.
+2. **Cleaner Code:** Avoids cluttering your function signatures with unnecessary context arguments.
+3. **Flexible and Extendable:** Actor objects can be extended with custom methods to suit your application's needs without interfering with the data.
+4. **Database Safe:** Since the actor is just a plain object, it can be safely stored and used in database queries.

package/package.json

@@ -1,8 +1,15 @@
 {
   "name": "@andrew_l/service-actor",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "license": "MIT",
   "type": "module",
+  "keywords": [
+    "trace",
+    "id",
+    "provide",
+    "inject",
+    "hooks"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/men232/toolkit.git",
@@ -26,8 +33,8 @@
     "vitest": "^2.1.3"
   },
   "dependencies": {
-    "@andrew_l/toolkit": "0.0.1",
-    "@andrew_l/context": "0.0.1"
+    "@andrew_l/toolkit": "0.0.2",
+    "@andrew_l/context": "0.0.2"
   },
   "scripts": {
     "build": "unbuild",