@andrew_l/service-actor 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2024 Andrew L. <andrew.io.dev@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,59 @@
+# Description
+
+This package aims to avoid passing data like trace IDs between functions.
+
+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.
+
+[Documentation](https://men232.github.io/toolkit/reference/@andrew_l/service-actor/)
+
+# Example
+
+```js
+import { serviceActor } from '@andrew_l/service-actor';
+
+let traceIdSec = 0;
+
+const { with: withServiceActor, inject: injectServiceActor } = serviceActor(
+  () => ({
+    traceId: `trace-${++traceIdSec}`,
+    ipAddress: '0.0.0.0',
+  }),
+);
+
+// Bind actor context to the request
+app.use((ctx, next) => {
+  return withServiceActor(
+    {
+      traceId: ctx.headers['x-request-id'],
+      ipAddress: ctx.headers['x-forwarded-for'],
+    },
+    next,
+  );
+});
+
+app.patch('/users/:id', async ctx => {
+  const actor = injectServiceActor(); // Inject service actor
+
+  console.log('Updating user with', actor);
+
+  await UserService.updateById(ctx.params.id, ctx.request.body);
+  ctx.body = 'ok';
+});
+```
+
+# Usage
+
+```js
+class UserService {
+  static async updateById(targetId, data) {
+    // Get the service actor from the context or create a new one if none exists
+    const actor = useServiceActor({ actorType: 'service' });
+
+    console.info('Updating user by id', { targetId, actor });
+
+    await db.users.updateOne({ _id: targetId }, data);
+  }
+}
+```

package/dist/index.cjs

@@ -0,0 +1,126 @@
+'use strict';
+
+const context = require('@andrew_l/context');
+const toolkit = require('@andrew_l/toolkit');
+
+const SYM_MARKER = Symbol();
+const SYM_RAW = Symbol();
+const SYM_DATA = Symbol();
+const SYM_API = Symbol();
+function serviceActor(factory) {
+  const injectKey = Symbol();
+  let idSeq = 0;
+  const createActor = () => {
+    const actor = createServiceActor();
+    actor.traceId = `trace-${++idSeq}`;
+    if (factory) {
+      actor.assign(factory());
+    }
+    return actor;
+  };
+  const withHook = (fn, params) => {
+    return context.withContext(() => {
+      const parentActor = context.inject(injectKey);
+      const actor = createActor();
+      if (parentActor) {
+        actor.assign(parentActor);
+      }
+      if (params) {
+        actor.assign(params);
+      }
+      context.provide(injectKey, actor);
+      return fn();
+    });
+  };
+  const injectHook = () => {
+    return context.hasInjectionContext() ? context.inject(injectKey) : void 0;
+  };
+  const useHok = () => {
+    if (!context.hasInjectionContext()) {
+      const actor2 = createActor();
+      context.provide(injectKey, actor2, true);
+      return actor2;
+    }
+    const existed = context.inject(injectKey);
+    if (existed) return existed;
+    const actor = createActor();
+    context.provide(injectKey, actor);
+    return actor;
+  };
+  return { with: withHook, use: useHok, inject: injectHook };
+}
+function createServiceActor() {
+  const actor = {
+    traceId: "",
+    actorId: null,
+    actorType: "unknown",
+    [SYM_API]: {
+      assign
+    },
+    [SYM_DATA]: {},
+    [SYM_RAW]: null,
+    [SYM_MARKER]: true
+  };
+  const reservedKeys = new Set(Object.keys(actor));
+  actor[SYM_RAW] = actor;
+  const newProxy = new Proxy(actor[SYM_DATA], {
+    defineProperty(target, key, value) {
+      if (key in actor) {
+        actor[key] = value;
+      } else {
+        target[key] = value;
+      }
+      return true;
+    },
+    deleteProperty(target, key) {
+      if (key in actor) {
+        delete actor[key];
+      } else {
+        delete target[key];
+      }
+      return true;
+    },
+    has(target, key) {
+      return key in actor || key in target;
+    },
+    ownKeys(target) {
+      return [...reservedKeys, ...Object.keys(target)];
+    },
+    set: function(target, key, value) {
+      if (key in actor[SYM_API]) return false;
+      if (key in actor) {
+        Reflect.set(actor, key, value);
+      } else if (toolkit.isFunction(value)) {
+        Reflect.set(actor[SYM_API], key, value);
+      } else {
+        Reflect.set(target, key, value);
+      }
+      return true;
+    },
+    get: (target, key) => {
+      let value;
+      if (key in actor) {
+        value = Reflect.get(actor, key, value);
+      } else if (key in actor[SYM_API]) {
+        value = Reflect.get(actor[SYM_API], key, value).bind(newProxy);
+      } else {
+        value = Reflect.get(target, key);
+      }
+      return value;
+    },
+    getOwnPropertyDescriptor(k) {
+      return {
+        enumerable: true,
+        configurable: true
+      };
+    }
+  });
+  return newProxy;
+}
+function assign(params) {
+  Object.assign(this, params);
+  return this;
+}
+
+exports.serviceActor = serviceActor;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/index.ts"],"sourcesContent":["import {\n  hasInjectionContext,\n  inject,\n  provide,\n  withContext,\n} from '@andrew_l/context';\nimport { type OverwriteWith, isFunction } from '@andrew_l/toolkit';\n\ntype ServiceActorInternal = {\n  traceId: unknown;\n  actorId: unknown;\n  actorType: unknown;\n  [SYM_API]: Record<PropertyKey, Function>;\n  [SYM_MARKER]: boolean;\n  [SYM_RAW]: any;\n  [SYM_DATA]: Record<PropertyKey, unknown>;\n};\n\nexport type AnyServiceActor = {\n  traceId: any;\n  actorId: any;\n  actorType: any;\n  [x: PropertyKey]: any;\n};\n\nexport type ServiceActorData<T extends Record<PropertyKey, any> = {}> =\n  OverwriteWith<\n    {\n      traceId: string;\n      actorId: string | null;\n      actorType: 'unknown' | string;\n    },\n    T\n  >;\n\nexport type ServiceActor<T extends Record<PropertyKey, any> = {}> =\n  ServiceActorData<T> & {\n    assign(params: Partial<ServiceActorData<T>>): ServiceActor<T>;\n  };\n\nconst SYM_MARKER = Symbol();\nconst SYM_RAW = Symbol();\nconst SYM_DATA = Symbol();\nconst SYM_API = Symbol();\n\n/**\n * Create service actor hooks\n *\n * @example\n * const { use: useServiceActor, with: withServiceActor } = serviceActor(() => ({\n *   actorType: 'http-request',\n *   ipAddress: '',\n *  }));\n *\n * app.use((ctx, next) => {\n *   return withServiceActor(\n *     {\n *       traceId: ctx.headers['x-request-id'],\n *       ipAddress: ctx.headers['x-forwarded-for'],\n *     },\n *     next,\n *   );\n * });\n *\n * app.get('/', () => {\n *   const actor = useServiceActor();\n *\n *   // { traceId: 'req_35123', actorId: null, actorType: 'http-request', ipAddress: '::' }\n *   console.log(actor);\n * });\n *\n * @group Main\n */\nexport function serviceActor<T extends Record<PropertyKey, any> = {}>(\n  factory?: () => T,\n): {\n  /**\n   * Wrap a function to execute it with service actor providers\n   */\n  with: <R extends Partial<ServiceActor<T>>>(fn: () => R) => () => R;\n\n  /**\n   * Returns the service actor instance from the current context.\n   */\n  inject: () => ServiceActor<T> | undefined;\n\n  /**\n   * Returns the service actor instance from the context, or creates and binds a new instance if none exists.\n   */\n  use: () => ServiceActor<T>;\n} {\n  const injectKey = Symbol();\n\n  let idSeq = 0;\n\n  const createActor = (): AnyServiceActor => {\n    const actor = createServiceActor();\n\n    actor.traceId = `trace-${++idSeq}`;\n\n    if (factory) {\n      actor.assign(factory());\n    }\n\n    return actor;\n  };\n\n  const withHook = <T extends Record<PropertyKey, any> = {}>(\n    fn: () => T,\n    params?: Partial<ServiceActor<T>>,\n  ): (() => T) => {\n    return withContext(() => {\n      const parentActor = inject<ServiceActor>(injectKey);\n      const actor = createActor();\n\n      if (parentActor) {\n        actor.assign(parentActor);\n      }\n\n      if (params) {\n        actor.assign(params);\n      }\n\n      provide(injectKey, actor);\n\n      return fn();\n    });\n  };\n\n  const injectHook = (): AnyServiceActor | undefined => {\n    return hasInjectionContext() ? inject<ServiceActor>(injectKey) : undefined;\n  };\n\n  const useHok = (): AnyServiceActor => {\n    if (!hasInjectionContext()) {\n      const actor = createActor();\n      provide(injectKey, actor, true);\n\n      return actor;\n    }\n\n    const existed = inject<AnyServiceActor>(injectKey);\n\n    if (existed) return existed;\n\n    const actor = createActor();\n    provide(injectKey, actor);\n\n    return actor;\n  };\n\n  return { with: withHook, use: useHok as any, inject: injectHook as any };\n}\n\nfunction createServiceActor(): ServiceActor {\n  const actor: ServiceActorInternal = {\n    traceId: '',\n    actorId: null,\n    actorType: 'unknown',\n    [SYM_API]: {\n      assign,\n    },\n    [SYM_DATA]: {},\n    [SYM_RAW]: null,\n    [SYM_MARKER]: true,\n  };\n\n  const reservedKeys = new Set(Object.keys(actor));\n\n  actor[SYM_RAW] = actor;\n\n  const newProxy = new Proxy(actor[SYM_DATA], {\n    defineProperty(target, key, value) {\n      if (key in actor) {\n        (actor as any)[key] = value;\n      } else {\n        target[key] = value;\n      }\n\n      return true;\n    },\n    deleteProperty(target, key) {\n      if (key in actor) {\n        delete (actor as any)[key];\n      } else {\n        delete target[key];\n      }\n\n      return true;\n    },\n    has(target, key) {\n      return key in actor || key in target;\n    },\n    ownKeys(target) {\n      return [...reservedKeys, ...Object.keys(target)];\n    },\n    set: function (target, key, value) {\n      if (key in actor[SYM_API]) return false;\n\n      if (key in actor) {\n        Reflect.set(actor, key, value);\n      } else if (isFunction(value)) {\n        Reflect.set(actor[SYM_API], key, value);\n      } else {\n        Reflect.set(target, key, value);\n      }\n\n      return true;\n    },\n    get: (target, key) => {\n      let value: any;\n\n      if (key in actor) {\n        value = Reflect.get(actor, key, value);\n      } else if (key in actor[SYM_API]) {\n        value = Reflect.get(actor[SYM_API], key, value).bind(newProxy);\n      } else {\n        value = Reflect.get(target, key);\n      }\n\n      return value;\n    },\n    getOwnPropertyDescriptor(k) {\n      return {\n        enumerable: true,\n        configurable: true,\n      };\n    },\n  });\n\n  return newProxy as ServiceActor;\n}\n\nfunction assign(this: ServiceActor, params: Record<any, any>) {\n  Object.assign(this, params);\n  return this;\n}\n"],"names":["withContext","inject","provide","hasInjectionContext","actor","isFunction"],"mappings":";;;;;AAwCA,MAAM,aAAa,MAAO,EAAA,CAAA;AAC1B,MAAM,UAAU,MAAO,EAAA,CAAA;AACvB,MAAM,WAAW,MAAO,EAAA,CAAA;AACxB,MAAM,UAAU,MAAO,EAAA,CAAA;AA8BhB,SAAS,aACd,OAgBA,EAAA;AACA,EAAA,MAAM,YAAY,MAAO,EAAA,CAAA;AAEzB,EAAA,IAAI,KAAQ,GAAA,CAAA,CAAA;AAEZ,EAAA,MAAM,cAAc,MAAuB;AACzC,IAAA,MAAM,QAAQ,kBAAmB,EAAA,CAAA;AAEjC,IAAM,KAAA,CAAA,OAAA,GAAU,CAAS,MAAA,EAAA,EAAE,KAAK,CAAA,CAAA,CAAA;AAEhC,IAAA,IAAI,OAAS,EAAA;AACX,MAAM,KAAA,CAAA,MAAA,CAAO,SAAS,CAAA,CAAA;AAAA,KACxB;AAEA,IAAO,OAAA,KAAA,CAAA;AAAA,GACT,CAAA;AAEA,EAAM,MAAA,QAAA,GAAW,CACf,EAAA,EACA,MACc,KAAA;AACd,IAAA,OAAOA,oBAAY,MAAM;AACvB,MAAM,MAAA,WAAA,GAAcC,eAAqB,SAAS,CAAA,CAAA;AAClD,MAAA,MAAM,QAAQ,WAAY,EAAA,CAAA;AAE1B,MAAA,IAAI,WAAa,EAAA;AACf,QAAA,KAAA,CAAM,OAAO,WAAW,CAAA,CAAA;AAAA,OAC1B;AAEA,MAAA,IAAI,MAAQ,EAAA;AACV,QAAA,KAAA,CAAM,OAAO,MAAM,CAAA,CAAA;AAAA,OACrB;AAEA,MAAAC,eAAA,CAAQ,WAAW,KAAK,CAAA,CAAA;AAExB,MAAA,OAAO,EAAG,EAAA,CAAA;AAAA,KACX,CAAA,CAAA;AAAA,GACH,CAAA;AAEA,EAAA,MAAM,aAAa,MAAmC;AACpD,IAAA,OAAOC,2BAAoB,EAAA,GAAIF,cAAqB,CAAA,SAAS,CAAI,GAAA,KAAA,CAAA,CAAA;AAAA,GACnE,CAAA;AAEA,EAAA,MAAM,SAAS,MAAuB;AACpC,IAAI,IAAA,CAACE,6BAAuB,EAAA;AAC1B,MAAA,MAAMC,SAAQ,WAAY,EAAA,CAAA;AAC1B,MAAQF,eAAA,CAAA,SAAA,EAAWE,QAAO,IAAI,CAAA,CAAA;AAE9B,MAAOA,OAAAA,MAAAA,CAAAA;AAAA,KACT;AAEA,IAAM,MAAA,OAAA,GAAUH,eAAwB,SAAS,CAAA,CAAA;AAEjD,IAAA,IAAI,SAAgB,OAAA,OAAA,CAAA;AAEpB,IAAA,MAAM,QAAQ,WAAY,EAAA,CAAA;AAC1B,IAAAC,eAAA,CAAQ,WAAW,KAAK,CAAA,CAAA;AAExB,IAAO,OAAA,KAAA,CAAA;AAAA,GACT,CAAA;AAEA,EAAA,OAAO,EAAE,IAAM,EAAA,QAAA,EAAU,GAAK,EAAA,MAAA,EAAe,QAAQ,UAAkB,EAAA,CAAA;AACzE,CAAA;AAEA,SAAS,kBAAmC,GAAA;AAC1C,EAAA,MAAM,KAA8B,GAAA;AAAA,IAClC,OAAS,EAAA,EAAA;AAAA,IACT,OAAS,EAAA,IAAA;AAAA,IACT,SAAW,EAAA,SAAA;AAAA,IACX,CAAC,OAAO,GAAG;AAAA,MACT,MAAA;AAAA,KACF;AAAA,IACA,CAAC,QAAQ,GAAG,EAAC;AAAA,IACb,CAAC,OAAO,GAAG,IAAA;AAAA,IACX,CAAC,UAAU,GAAG,IAAA;AAAA,GAChB,CAAA;AAEA,EAAA,MAAM,eAAe,IAAI,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,KAAK,CAAC,CAAA,CAAA;AAE/C,EAAA,KAAA,CAAM,OAAO,CAAI,GAAA,KAAA,CAAA;AAEjB,EAAA,MAAM,QAAW,GAAA,IAAI,KAAM,CAAA,KAAA,CAAM,QAAQ,CAAG,EAAA;AAAA,IAC1C,cAAA,CAAe,MAAQ,EAAA,GAAA,EAAK,KAAO,EAAA;AACjC,MAAA,IAAI,OAAO,KAAO,EAAA;AAChB,QAAC,KAAA,CAAc,GAAG,CAAI,GAAA,KAAA,CAAA;AAAA,OACjB,MAAA;AACL,QAAA,MAAA,CAAO,GAAG,CAAI,GAAA,KAAA,CAAA;AAAA,OAChB;AAEA,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AAAA,IACA,cAAA,CAAe,QAAQ,GAAK,EAAA;AAC1B,MAAA,IAAI,OAAO,KAAO,EAAA;AAChB,QAAA,OAAQ,MAAc,GAAG,CAAA,CAAA;AAAA,OACpB,MAAA;AACL,QAAA,OAAO,OAAO,GAAG,CAAA,CAAA;AAAA,OACnB;AAEA,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AAAA,IACA,GAAA,CAAI,QAAQ,GAAK,EAAA;AACf,MAAO,OAAA,GAAA,IAAO,SAAS,GAAO,IAAA,MAAA,CAAA;AAAA,KAChC;AAAA,IACA,QAAQ,MAAQ,EAAA;AACd,MAAA,OAAO,CAAC,GAAG,YAAA,EAAc,GAAG,MAAO,CAAA,IAAA,CAAK,MAAM,CAAC,CAAA,CAAA;AAAA,KACjD;AAAA,IACA,GAAK,EAAA,SAAU,MAAQ,EAAA,GAAA,EAAK,KAAO,EAAA;AACjC,MAAA,IAAI,GAAO,IAAA,KAAA,CAAM,OAAO,CAAA,EAAU,OAAA,KAAA,CAAA;AAElC,MAAA,IAAI,OAAO,KAAO,EAAA;AAChB,QAAQ,OAAA,CAAA,GAAA,CAAI,KAAO,EAAA,GAAA,EAAK,KAAK,CAAA,CAAA;AAAA,OAC/B,MAAA,IAAWG,kBAAW,CAAA,KAAK,CAAG,EAAA;AAC5B,QAAA,OAAA,CAAQ,GAAI,CAAA,KAAA,CAAM,OAAO,CAAA,EAAG,KAAK,KAAK,CAAA,CAAA;AAAA,OACjC,MAAA;AACL,QAAQ,OAAA,CAAA,GAAA,CAAI,MAAQ,EAAA,GAAA,EAAK,KAAK,CAAA,CAAA;AAAA,OAChC;AAEA,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AAAA,IACA,GAAA,EAAK,CAAC,MAAA,EAAQ,GAAQ,KAAA;AACpB,MAAI,IAAA,KAAA,CAAA;AAEJ,MAAA,IAAI,OAAO,KAAO,EAAA;AAChB,QAAA,KAAA,GAAQ,OAAQ,CAAA,GAAA,CAAI,KAAO,EAAA,GAAA,EAAK,KAAK,CAAA,CAAA;AAAA,OAC5B,MAAA,IAAA,GAAA,IAAO,KAAM,CAAA,OAAO,CAAG,EAAA;AAChC,QAAQ,KAAA,GAAA,OAAA,CAAQ,IAAI,KAAM,CAAA,OAAO,GAAG,GAAK,EAAA,KAAK,CAAE,CAAA,IAAA,CAAK,QAAQ,CAAA,CAAA;AAAA,OACxD,MAAA;AACL,QAAQ,KAAA,GAAA,OAAA,CAAQ,GAAI,CAAA,MAAA,EAAQ,GAAG,CAAA,CAAA;AAAA,OACjC;AAEA,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AAAA,IACA,yBAAyB,CAAG,EAAA;AAC1B,MAAO,OAAA;AAAA,QACL,UAAY,EAAA,IAAA;AAAA,QACZ,YAAc,EAAA,IAAA;AAAA,OAChB,CAAA;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AAED,EAAO,OAAA,QAAA,CAAA;AACT,CAAA;AAEA,SAAS,OAA2B,MAA0B,EAAA;AAC5D,EAAO,MAAA,CAAA,MAAA,CAAO,MAAM,MAAM,CAAA,CAAA;AAC1B,EAAO,OAAA,IAAA,CAAA;AACT;;;;"}

package/dist/index.d.cts

@@ -0,0 +1,60 @@
+import { OverwriteWith } from '@andrew_l/toolkit';
+
+type AnyServiceActor = {
+    traceId: any;
+    actorId: any;
+    actorType: any;
+    [x: PropertyKey]: any;
+};
+type ServiceActorData<T extends Record<PropertyKey, any> = {}> = OverwriteWith<{
+    traceId: string;
+    actorId: string | null;
+    actorType: 'unknown' | string;
+}, T>;
+type ServiceActor<T extends Record<PropertyKey, any> = {}> = ServiceActorData<T> & {
+    assign(params: Partial<ServiceActorData<T>>): ServiceActor<T>;
+};
+/**
+ * Create service actor hooks
+ *
+ * @example
+ * const { use: useServiceActor, with: withServiceActor } = serviceActor(() => ({
+ *   actorType: 'http-request',
+ *   ipAddress: '',
+ *  }));
+ *
+ * app.use((ctx, next) => {
+ *   return withServiceActor(
+ *     {
+ *       traceId: ctx.headers['x-request-id'],
+ *       ipAddress: ctx.headers['x-forwarded-for'],
+ *     },
+ *     next,
+ *   );
+ * });
+ *
+ * app.get('/', () => {
+ *   const actor = useServiceActor();
+ *
+ *   // { traceId: 'req_35123', actorId: null, actorType: 'http-request', ipAddress: '::' }
+ *   console.log(actor);
+ * });
+ *
+ * @group Main
+ */
+declare function serviceActor<T extends Record<PropertyKey, any> = {}>(factory?: () => T): {
+    /**
+     * Wrap a function to execute it with service actor providers
+     */
+    with: <R extends Partial<ServiceActor<T>>>(fn: () => R) => () => R;
+    /**
+     * Returns the service actor instance from the current context.
+     */
+    inject: () => ServiceActor<T> | undefined;
+    /**
+     * Returns the service actor instance from the context, or creates and binds a new instance if none exists.
+     */
+    use: () => ServiceActor<T>;
+};
+
+export { type AnyServiceActor, type ServiceActor, type ServiceActorData, serviceActor };

package/dist/index.d.mts

@@ -0,0 +1,60 @@
+import { OverwriteWith } from '@andrew_l/toolkit';
+
+type AnyServiceActor = {
+    traceId: any;
+    actorId: any;
+    actorType: any;
+    [x: PropertyKey]: any;
+};
+type ServiceActorData<T extends Record<PropertyKey, any> = {}> = OverwriteWith<{
+    traceId: string;
+    actorId: string | null;
+    actorType: 'unknown' | string;
+}, T>;
+type ServiceActor<T extends Record<PropertyKey, any> = {}> = ServiceActorData<T> & {
+    assign(params: Partial<ServiceActorData<T>>): ServiceActor<T>;
+};
+/**
+ * Create service actor hooks
+ *
+ * @example
+ * const { use: useServiceActor, with: withServiceActor } = serviceActor(() => ({
+ *   actorType: 'http-request',
+ *   ipAddress: '',
+ *  }));
+ *
+ * app.use((ctx, next) => {
+ *   return withServiceActor(
+ *     {
+ *       traceId: ctx.headers['x-request-id'],
+ *       ipAddress: ctx.headers['x-forwarded-for'],
+ *     },
+ *     next,
+ *   );
+ * });
+ *
+ * app.get('/', () => {
+ *   const actor = useServiceActor();
+ *
+ *   // { traceId: 'req_35123', actorId: null, actorType: 'http-request', ipAddress: '::' }
+ *   console.log(actor);
+ * });
+ *
+ * @group Main
+ */
+declare function serviceActor<T extends Record<PropertyKey, any> = {}>(factory?: () => T): {
+    /**
+     * Wrap a function to execute it with service actor providers
+     */
+    with: <R extends Partial<ServiceActor<T>>>(fn: () => R) => () => R;
+    /**
+     * Returns the service actor instance from the current context.
+     */
+    inject: () => ServiceActor<T> | undefined;
+    /**
+     * Returns the service actor instance from the context, or creates and binds a new instance if none exists.
+     */
+    use: () => ServiceActor<T>;
+};
+
+export { type AnyServiceActor, type ServiceActor, type ServiceActorData, serviceActor };

package/dist/index.d.ts

@@ -0,0 +1,60 @@
+import { OverwriteWith } from '@andrew_l/toolkit';
+
+type AnyServiceActor = {
+    traceId: any;
+    actorId: any;
+    actorType: any;
+    [x: PropertyKey]: any;
+};
+type ServiceActorData<T extends Record<PropertyKey, any> = {}> = OverwriteWith<{
+    traceId: string;
+    actorId: string | null;
+    actorType: 'unknown' | string;
+}, T>;
+type ServiceActor<T extends Record<PropertyKey, any> = {}> = ServiceActorData<T> & {
+    assign(params: Partial<ServiceActorData<T>>): ServiceActor<T>;
+};
+/**
+ * Create service actor hooks
+ *
+ * @example
+ * const { use: useServiceActor, with: withServiceActor } = serviceActor(() => ({
+ *   actorType: 'http-request',
+ *   ipAddress: '',
+ *  }));
+ *
+ * app.use((ctx, next) => {
+ *   return withServiceActor(
+ *     {
+ *       traceId: ctx.headers['x-request-id'],
+ *       ipAddress: ctx.headers['x-forwarded-for'],
+ *     },
+ *     next,
+ *   );
+ * });
+ *
+ * app.get('/', () => {
+ *   const actor = useServiceActor();
+ *
+ *   // { traceId: 'req_35123', actorId: null, actorType: 'http-request', ipAddress: '::' }
+ *   console.log(actor);
+ * });
+ *
+ * @group Main
+ */
+declare function serviceActor<T extends Record<PropertyKey, any> = {}>(factory?: () => T): {
+    /**
+     * Wrap a function to execute it with service actor providers
+     */
+    with: <R extends Partial<ServiceActor<T>>>(fn: () => R) => () => R;
+    /**
+     * Returns the service actor instance from the current context.
+     */
+    inject: () => ServiceActor<T> | undefined;
+    /**
+     * Returns the service actor instance from the context, or creates and binds a new instance if none exists.
+     */
+    use: () => ServiceActor<T>;
+};
+
+export { type AnyServiceActor, type ServiceActor, type ServiceActorData, serviceActor };

package/dist/index.mjs

@@ -0,0 +1,124 @@
+import { withContext, inject, provide, hasInjectionContext } from '@andrew_l/context';
+import { isFunction } from '@andrew_l/toolkit';
+
+const SYM_MARKER = Symbol();
+const SYM_RAW = Symbol();
+const SYM_DATA = Symbol();
+const SYM_API = Symbol();
+function serviceActor(factory) {
+  const injectKey = Symbol();
+  let idSeq = 0;
+  const createActor = () => {
+    const actor = createServiceActor();
+    actor.traceId = `trace-${++idSeq}`;
+    if (factory) {
+      actor.assign(factory());
+    }
+    return actor;
+  };
+  const withHook = (fn, params) => {
+    return withContext(() => {
+      const parentActor = inject(injectKey);
+      const actor = createActor();
+      if (parentActor) {
+        actor.assign(parentActor);
+      }
+      if (params) {
+        actor.assign(params);
+      }
+      provide(injectKey, actor);
+      return fn();
+    });
+  };
+  const injectHook = () => {
+    return hasInjectionContext() ? inject(injectKey) : void 0;
+  };
+  const useHok = () => {
+    if (!hasInjectionContext()) {
+      const actor2 = createActor();
+      provide(injectKey, actor2, true);
+      return actor2;
+    }
+    const existed = inject(injectKey);
+    if (existed) return existed;
+    const actor = createActor();
+    provide(injectKey, actor);
+    return actor;
+  };
+  return { with: withHook, use: useHok, inject: injectHook };
+}
+function createServiceActor() {
+  const actor = {
+    traceId: "",
+    actorId: null,
+    actorType: "unknown",
+    [SYM_API]: {
+      assign
+    },
+    [SYM_DATA]: {},
+    [SYM_RAW]: null,
+    [SYM_MARKER]: true
+  };
+  const reservedKeys = new Set(Object.keys(actor));
+  actor[SYM_RAW] = actor;
+  const newProxy = new Proxy(actor[SYM_DATA], {
+    defineProperty(target, key, value) {
+      if (key in actor) {
+        actor[key] = value;
+      } else {
+        target[key] = value;
+      }
+      return true;
+    },
+    deleteProperty(target, key) {
+      if (key in actor) {
+        delete actor[key];
+      } else {
+        delete target[key];
+      }
+      return true;
+    },
+    has(target, key) {
+      return key in actor || key in target;
+    },
+    ownKeys(target) {
+      return [...reservedKeys, ...Object.keys(target)];
+    },
+    set: function(target, key, value) {
+      if (key in actor[SYM_API]) return false;
+      if (key in actor) {
+        Reflect.set(actor, key, value);
+      } else if (isFunction(value)) {
+        Reflect.set(actor[SYM_API], key, value);
+      } else {
+        Reflect.set(target, key, value);
+      }
+      return true;
+    },
+    get: (target, key) => {
+      let value;
+      if (key in actor) {
+        value = Reflect.get(actor, key, value);
+      } else if (key in actor[SYM_API]) {
+        value = Reflect.get(actor[SYM_API], key, value).bind(newProxy);
+      } else {
+        value = Reflect.get(target, key);
+      }
+      return value;
+    },
+    getOwnPropertyDescriptor(k) {
+      return {
+        enumerable: true,
+        configurable: true
+      };
+    }
+  });
+  return newProxy;
+}
+function assign(params) {
+  Object.assign(this, params);
+  return this;
+}
+
+export { serviceActor };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../src/index.ts"],"sourcesContent":["import {\n  hasInjectionContext,\n  inject,\n  provide,\n  withContext,\n} from '@andrew_l/context';\nimport { type OverwriteWith, isFunction } from '@andrew_l/toolkit';\n\ntype ServiceActorInternal = {\n  traceId: unknown;\n  actorId: unknown;\n  actorType: unknown;\n  [SYM_API]: Record<PropertyKey, Function>;\n  [SYM_MARKER]: boolean;\n  [SYM_RAW]: any;\n  [SYM_DATA]: Record<PropertyKey, unknown>;\n};\n\nexport type AnyServiceActor = {\n  traceId: any;\n  actorId: any;\n  actorType: any;\n  [x: PropertyKey]: any;\n};\n\nexport type ServiceActorData<T extends Record<PropertyKey, any> = {}> =\n  OverwriteWith<\n    {\n      traceId: string;\n      actorId: string | null;\n      actorType: 'unknown' | string;\n    },\n    T\n  >;\n\nexport type ServiceActor<T extends Record<PropertyKey, any> = {}> =\n  ServiceActorData<T> & {\n    assign(params: Partial<ServiceActorData<T>>): ServiceActor<T>;\n  };\n\nconst SYM_MARKER = Symbol();\nconst SYM_RAW = Symbol();\nconst SYM_DATA = Symbol();\nconst SYM_API = Symbol();\n\n/**\n * Create service actor hooks\n *\n * @example\n * const { use: useServiceActor, with: withServiceActor } = serviceActor(() => ({\n *   actorType: 'http-request',\n *   ipAddress: '',\n *  }));\n *\n * app.use((ctx, next) => {\n *   return withServiceActor(\n *     {\n *       traceId: ctx.headers['x-request-id'],\n *       ipAddress: ctx.headers['x-forwarded-for'],\n *     },\n *     next,\n *   );\n * });\n *\n * app.get('/', () => {\n *   const actor = useServiceActor();\n *\n *   // { traceId: 'req_35123', actorId: null, actorType: 'http-request', ipAddress: '::' }\n *   console.log(actor);\n * });\n *\n * @group Main\n */\nexport function serviceActor<T extends Record<PropertyKey, any> = {}>(\n  factory?: () => T,\n): {\n  /**\n   * Wrap a function to execute it with service actor providers\n   */\n  with: <R extends Partial<ServiceActor<T>>>(fn: () => R) => () => R;\n\n  /**\n   * Returns the service actor instance from the current context.\n   */\n  inject: () => ServiceActor<T> | undefined;\n\n  /**\n   * Returns the service actor instance from the context, or creates and binds a new instance if none exists.\n   */\n  use: () => ServiceActor<T>;\n} {\n  const injectKey = Symbol();\n\n  let idSeq = 0;\n\n  const createActor = (): AnyServiceActor => {\n    const actor = createServiceActor();\n\n    actor.traceId = `trace-${++idSeq}`;\n\n    if (factory) {\n      actor.assign(factory());\n    }\n\n    return actor;\n  };\n\n  const withHook = <T extends Record<PropertyKey, any> = {}>(\n    fn: () => T,\n    params?: Partial<ServiceActor<T>>,\n  ): (() => T) => {\n    return withContext(() => {\n      const parentActor = inject<ServiceActor>(injectKey);\n      const actor = createActor();\n\n      if (parentActor) {\n        actor.assign(parentActor);\n      }\n\n      if (params) {\n        actor.assign(params);\n      }\n\n      provide(injectKey, actor);\n\n      return fn();\n    });\n  };\n\n  const injectHook = (): AnyServiceActor | undefined => {\n    return hasInjectionContext() ? inject<ServiceActor>(injectKey) : undefined;\n  };\n\n  const useHok = (): AnyServiceActor => {\n    if (!hasInjectionContext()) {\n      const actor = createActor();\n      provide(injectKey, actor, true);\n\n      return actor;\n    }\n\n    const existed = inject<AnyServiceActor>(injectKey);\n\n    if (existed) return existed;\n\n    const actor = createActor();\n    provide(injectKey, actor);\n\n    return actor;\n  };\n\n  return { with: withHook, use: useHok as any, inject: injectHook as any };\n}\n\nfunction createServiceActor(): ServiceActor {\n  const actor: ServiceActorInternal = {\n    traceId: '',\n    actorId: null,\n    actorType: 'unknown',\n    [SYM_API]: {\n      assign,\n    },\n    [SYM_DATA]: {},\n    [SYM_RAW]: null,\n    [SYM_MARKER]: true,\n  };\n\n  const reservedKeys = new Set(Object.keys(actor));\n\n  actor[SYM_RAW] = actor;\n\n  const newProxy = new Proxy(actor[SYM_DATA], {\n    defineProperty(target, key, value) {\n      if (key in actor) {\n        (actor as any)[key] = value;\n      } else {\n        target[key] = value;\n      }\n\n      return true;\n    },\n    deleteProperty(target, key) {\n      if (key in actor) {\n        delete (actor as any)[key];\n      } else {\n        delete target[key];\n      }\n\n      return true;\n    },\n    has(target, key) {\n      return key in actor || key in target;\n    },\n    ownKeys(target) {\n      return [...reservedKeys, ...Object.keys(target)];\n    },\n    set: function (target, key, value) {\n      if (key in actor[SYM_API]) return false;\n\n      if (key in actor) {\n        Reflect.set(actor, key, value);\n      } else if (isFunction(value)) {\n        Reflect.set(actor[SYM_API], key, value);\n      } else {\n        Reflect.set(target, key, value);\n      }\n\n      return true;\n    },\n    get: (target, key) => {\n      let value: any;\n\n      if (key in actor) {\n        value = Reflect.get(actor, key, value);\n      } else if (key in actor[SYM_API]) {\n        value = Reflect.get(actor[SYM_API], key, value).bind(newProxy);\n      } else {\n        value = Reflect.get(target, key);\n      }\n\n      return value;\n    },\n    getOwnPropertyDescriptor(k) {\n      return {\n        enumerable: true,\n        configurable: true,\n      };\n    },\n  });\n\n  return newProxy as ServiceActor;\n}\n\nfunction assign(this: ServiceActor, params: Record<any, any>) {\n  Object.assign(this, params);\n  return this;\n}\n"],"names":["actor"],"mappings":";;;AAwCA,MAAM,aAAa,MAAO,EAAA,CAAA;AAC1B,MAAM,UAAU,MAAO,EAAA,CAAA;AACvB,MAAM,WAAW,MAAO,EAAA,CAAA;AACxB,MAAM,UAAU,MAAO,EAAA,CAAA;AA8BhB,SAAS,aACd,OAgBA,EAAA;AACA,EAAA,MAAM,YAAY,MAAO,EAAA,CAAA;AAEzB,EAAA,IAAI,KAAQ,GAAA,CAAA,CAAA;AAEZ,EAAA,MAAM,cAAc,MAAuB;AACzC,IAAA,MAAM,QAAQ,kBAAmB,EAAA,CAAA;AAEjC,IAAM,KAAA,CAAA,OAAA,GAAU,CAAS,MAAA,EAAA,EAAE,KAAK,CAAA,CAAA,CAAA;AAEhC,IAAA,IAAI,OAAS,EAAA;AACX,MAAM,KAAA,CAAA,MAAA,CAAO,SAAS,CAAA,CAAA;AAAA,KACxB;AAEA,IAAO,OAAA,KAAA,CAAA;AAAA,GACT,CAAA;AAEA,EAAM,MAAA,QAAA,GAAW,CACf,EAAA,EACA,MACc,KAAA;AACd,IAAA,OAAO,YAAY,MAAM;AACvB,MAAM,MAAA,WAAA,GAAc,OAAqB,SAAS,CAAA,CAAA;AAClD,MAAA,MAAM,QAAQ,WAAY,EAAA,CAAA;AAE1B,MAAA,IAAI,WAAa,EAAA;AACf,QAAA,KAAA,CAAM,OAAO,WAAW,CAAA,CAAA;AAAA,OAC1B;AAEA,MAAA,IAAI,MAAQ,EAAA;AACV,QAAA,KAAA,CAAM,OAAO,MAAM,CAAA,CAAA;AAAA,OACrB;AAEA,MAAA,OAAA,CAAQ,WAAW,KAAK,CAAA,CAAA;AAExB,MAAA,OAAO,EAAG,EAAA,CAAA;AAAA,KACX,CAAA,CAAA;AAAA,GACH,CAAA;AAEA,EAAA,MAAM,aAAa,MAAmC;AACpD,IAAA,OAAO,mBAAoB,EAAA,GAAI,MAAqB,CAAA,SAAS,CAAI,GAAA,KAAA,CAAA,CAAA;AAAA,GACnE,CAAA;AAEA,EAAA,MAAM,SAAS,MAAuB;AACpC,IAAI,IAAA,CAAC,qBAAuB,EAAA;AAC1B,MAAA,MAAMA,SAAQ,WAAY,EAAA,CAAA;AAC1B,MAAQ,OAAA,CAAA,SAAA,EAAWA,QAAO,IAAI,CAAA,CAAA;AAE9B,MAAOA,OAAAA,MAAAA,CAAAA;AAAA,KACT;AAEA,IAAM,MAAA,OAAA,GAAU,OAAwB,SAAS,CAAA,CAAA;AAEjD,IAAA,IAAI,SAAgB,OAAA,OAAA,CAAA;AAEpB,IAAA,MAAM,QAAQ,WAAY,EAAA,CAAA;AAC1B,IAAA,OAAA,CAAQ,WAAW,KAAK,CAAA,CAAA;AAExB,IAAO,OAAA,KAAA,CAAA;AAAA,GACT,CAAA;AAEA,EAAA,OAAO,EAAE,IAAM,EAAA,QAAA,EAAU,GAAK,EAAA,MAAA,EAAe,QAAQ,UAAkB,EAAA,CAAA;AACzE,CAAA;AAEA,SAAS,kBAAmC,GAAA;AAC1C,EAAA,MAAM,KAA8B,GAAA;AAAA,IAClC,OAAS,EAAA,EAAA;AAAA,IACT,OAAS,EAAA,IAAA;AAAA,IACT,SAAW,EAAA,SAAA;AAAA,IACX,CAAC,OAAO,GAAG;AAAA,MACT,MAAA;AAAA,KACF;AAAA,IACA,CAAC,QAAQ,GAAG,EAAC;AAAA,IACb,CAAC,OAAO,GAAG,IAAA;AAAA,IACX,CAAC,UAAU,GAAG,IAAA;AAAA,GAChB,CAAA;AAEA,EAAA,MAAM,eAAe,IAAI,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,KAAK,CAAC,CAAA,CAAA;AAE/C,EAAA,KAAA,CAAM,OAAO,CAAI,GAAA,KAAA,CAAA;AAEjB,EAAA,MAAM,QAAW,GAAA,IAAI,KAAM,CAAA,KAAA,CAAM,QAAQ,CAAG,EAAA;AAAA,IAC1C,cAAA,CAAe,MAAQ,EAAA,GAAA,EAAK,KAAO,EAAA;AACjC,MAAA,IAAI,OAAO,KAAO,EAAA;AAChB,QAAC,KAAA,CAAc,GAAG,CAAI,GAAA,KAAA,CAAA;AAAA,OACjB,MAAA;AACL,QAAA,MAAA,CAAO,GAAG,CAAI,GAAA,KAAA,CAAA;AAAA,OAChB;AAEA,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AAAA,IACA,cAAA,CAAe,QAAQ,GAAK,EAAA;AAC1B,MAAA,IAAI,OAAO,KAAO,EAAA;AAChB,QAAA,OAAQ,MAAc,GAAG,CAAA,CAAA;AAAA,OACpB,MAAA;AACL,QAAA,OAAO,OAAO,GAAG,CAAA,CAAA;AAAA,OACnB;AAEA,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AAAA,IACA,GAAA,CAAI,QAAQ,GAAK,EAAA;AACf,MAAO,OAAA,GAAA,IAAO,SAAS,GAAO,IAAA,MAAA,CAAA;AAAA,KAChC;AAAA,IACA,QAAQ,MAAQ,EAAA;AACd,MAAA,OAAO,CAAC,GAAG,YAAA,EAAc,GAAG,MAAO,CAAA,IAAA,CAAK,MAAM,CAAC,CAAA,CAAA;AAAA,KACjD;AAAA,IACA,GAAK,EAAA,SAAU,MAAQ,EAAA,GAAA,EAAK,KAAO,EAAA;AACjC,MAAA,IAAI,GAAO,IAAA,KAAA,CAAM,OAAO,CAAA,EAAU,OAAA,KAAA,CAAA;AAElC,MAAA,IAAI,OAAO,KAAO,EAAA;AAChB,QAAQ,OAAA,CAAA,GAAA,CAAI,KAAO,EAAA,GAAA,EAAK,KAAK,CAAA,CAAA;AAAA,OAC/B,MAAA,IAAW,UAAW,CAAA,KAAK,CAAG,EAAA;AAC5B,QAAA,OAAA,CAAQ,GAAI,CAAA,KAAA,CAAM,OAAO,CAAA,EAAG,KAAK,KAAK,CAAA,CAAA;AAAA,OACjC,MAAA;AACL,QAAQ,OAAA,CAAA,GAAA,CAAI,MAAQ,EAAA,GAAA,EAAK,KAAK,CAAA,CAAA;AAAA,OAChC;AAEA,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AAAA,IACA,GAAA,EAAK,CAAC,MAAA,EAAQ,GAAQ,KAAA;AACpB,MAAI,IAAA,KAAA,CAAA;AAEJ,MAAA,IAAI,OAAO,KAAO,EAAA;AAChB,QAAA,KAAA,GAAQ,OAAQ,CAAA,GAAA,CAAI,KAAO,EAAA,GAAA,EAAK,KAAK,CAAA,CAAA;AAAA,OAC5B,MAAA,IAAA,GAAA,IAAO,KAAM,CAAA,OAAO,CAAG,EAAA;AAChC,QAAQ,KAAA,GAAA,OAAA,CAAQ,IAAI,KAAM,CAAA,OAAO,GAAG,GAAK,EAAA,KAAK,CAAE,CAAA,IAAA,CAAK,QAAQ,CAAA,CAAA;AAAA,OACxD,MAAA;AACL,QAAQ,KAAA,GAAA,OAAA,CAAQ,GAAI,CAAA,MAAA,EAAQ,GAAG,CAAA,CAAA;AAAA,OACjC;AAEA,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AAAA,IACA,yBAAyB,CAAG,EAAA;AAC1B,MAAO,OAAA;AAAA,QACL,UAAY,EAAA,IAAA;AAAA,QACZ,YAAc,EAAA,IAAA;AAAA,OAChB,CAAA;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AAED,EAAO,OAAA,QAAA,CAAA;AACT,CAAA;AAEA,SAAS,OAA2B,MAA0B,EAAA;AAC5D,EAAO,MAAA,CAAA,MAAA,CAAO,MAAM,MAAM,CAAA,CAAA;AAC1B,EAAO,OAAA,IAAA,CAAA;AACT;;;;"}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@andrew_l/service-actor",
+  "version": "0.0.1",
+  "license": "MIT",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/men232/toolkit.git",
+    "directory": "packages/service-actor"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "unbuild": "3.0.0-rc.11",
+    "@types/node": "^20.16.10",
+    "typescript": "~5.6.2",
+    "vitest": "^2.1.3"
+  },
+  "dependencies": {
+    "@andrew_l/toolkit": "0.0.1",
+    "@andrew_l/context": "0.0.1"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "test": "vitest run --typecheck",
+    "test:watch": "vitest watch --typecheck"
+  }
+}