@sincpro/client-framework 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,15 +7,15 @@ import type { Span } from "../observability/ports.js";
7
7
  * nothing like it that survives an `await` (AsyncContext is a proposal, Zone.js patches the
8
8
  * world), and a global stack mixes the parents of two use cases running at once — which a
9
9
  * screen with several windows does all the time. So an execution is a value, handed to what
10
- * the use case calls: its Features (`ApplicationService`) and its dependencies (`BIND`).
10
+ * the use case calls: its Features (`this.feature`) and its dependencies (`BIND`).
11
11
  */
12
12
  export type Execution = {
13
13
  /** UUID v7, as 32 hex: this run. */
14
14
  readonly id: string;
15
- /** `<domain>/<Feature>` — the span's name, as the backend names its own. */
15
+ /** `<bounded context>.<Service>[.<method>]` — the use case's identity, as the backend names its own. */
16
16
  readonly useCase: string;
17
- /** The bounded context the use case belongs to, when it was bound to one. */
18
- readonly domain: string | undefined;
17
+ /** The bounded context the use case belongs to. */
18
+ readonly boundedContext: string;
19
19
  /** The run that executed this one: an ApplicationService, for its Features. */
20
20
  readonly parent: Execution | undefined;
21
21
  readonly span: Span;
@@ -25,7 +25,7 @@ export type Execution = {
25
25
  /**
26
26
  * A dependency that has something to say about the execution it is used in: given that
27
27
  * execution, it answers itself bound to it. The transport and every generated client are;
28
- * anything else in a Feature's `deps` is handed as it is.
28
+ * any other dependency of a bounded context is handed as it is.
29
29
  */
30
30
  export declare const BIND: unique symbol;
31
31
  export type Bindable<T> = {
@@ -49,7 +49,7 @@ export declare function bindTransport(transport: Transport, execution: Execution
49
49
  /**
50
50
  * A client made over a transport, made again over the transport bound to each execution it is
51
51
  * used in. What a generated `clientOf(transport)` answers, so a Feature that calls
52
- * `this.deps.project.sendIssue(…)` sends that request with its own trace.
52
+ * `this.client.sendIssue(…)` sends that request with its own trace.
53
53
  *
54
54
  * export function clientOf(transport: Transport) {
55
55
  * return bindable(transport, (transport) => ({ sendIssue: (body) => transport.send(…) }));
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * A dependency that has something to say about the execution it is used in: given that
3
3
  * execution, it answers itself bound to it. The transport and every generated client are;
4
- * anything else in a Feature's `deps` is handed as it is.
4
+ * any other dependency of a bounded context is handed as it is.
5
5
  */
6
6
  export const BIND = Symbol.for("sincpro.client-framework.bind");
7
7
  function isBindable(value) {
@@ -61,7 +61,7 @@ export function bindTransport(transport, execution) {
61
61
  /**
62
62
  * A client made over a transport, made again over the transport bound to each execution it is
63
63
  * used in. What a generated `clientOf(transport)` answers, so a Feature that calls
64
- * `this.deps.project.sendIssue(…)` sends that request with its own trace.
64
+ * `this.client.sendIssue(…)` sends that request with its own trace.
65
65
  *
66
66
  * export function clientOf(transport: Transport) {
67
67
  * return bindable(transport, (transport) => ({ sendIssue: (body) => transport.send(…) }));
@@ -1,60 +1,82 @@
1
- import { type Runtime } from "./runtime.js";
1
+ import type { ContextValues } from "../context/store.js";
2
2
  /**
3
- * One use case. What it needs from outside — the generated client of its domain, another
4
- * adapter — comes in `deps`, typed by the subclass.
3
+ * `Feature` and `ApplicationService`: the two kinds of service a bounded context holds, as in
4
+ * sincpro_framework. Each bounded context gives them its dependencies once, in its own base:
5
5
  *
6
- * export class SendIssue extends Feature<{ project: ProjectClient }> {
7
- * execute(input: dto.CommandSendIssue) {
8
- * return this.deps.project.sendIssue(input);
6
+ * // domains/project/infrastructure/bounded_context.ts
7
+ * export class Feature extends BaseFeature<ProjectDependencies> {}
8
+ * export class ApplicationService extends BaseApplicationService<ProjectDependencies, ProjectFeatures> {}
9
+ *
10
+ * // domains/project/services/issues.ts
11
+ * export class Issues extends Feature {
12
+ * close(input: dto.CommandCloseIssue) {
13
+ * this.session.require(); // each dependency is a property — typed
14
+ * return this.client.closeIssue(input);
9
15
  * }
10
16
  * }
11
17
  *
12
- * Context: all of a client's logic lives in Features and ApplicationServices, as in
13
- * sincpro_framework and @sincpro/mobile, and none of them writes a span or catches an error to
14
- * report it: `new` answers the instance behind interceptors, and every public method runs
15
- * inside its own execution — a span named `<domain>/<name>`, the context it runs with, its
16
- * report if nobody expected how it failed. `execute` is a use case's entry; another public
17
- * method is traced as `<name>.<method>`, and a name that starts with `_` is not traced at all.
18
- *
19
- * Inside a method, `this.deps` and `this.context` are this run's own: each dependency that can
20
- * be (the transport, a generated client) is bound to the execution, so its requests carry this
21
- * run's trace. So a Feature keeps nothing of a request on `this`, and declares no `#private`
22
- * fields — the run sees the instance through a view of its own, and `#private` refuses views;
23
- * TypeScript's `private` is the same promise without that.
24
- */
25
- export declare class Feature<Deps extends object = Record<string, never>> {
26
- protected readonly deps: Deps;
27
- /** What this run executes with (`RuntimeOptions.context`): empty outside a run. */
28
- protected readonly context: Readonly<Record<string, unknown>>;
29
- constructor(deps?: Deps);
30
- }
31
- /**
32
- * A use case that composes the Features of its own domain — the only difference with a
33
- * Feature. Each call to one of them is a child of this run: its span under this span, the same
34
- * context, the same trace on the wire.
35
- *
36
- * export class CloseIssue extends ApplicationService<{ preview: PreviewClose; send: SendIssue }> {
37
- * async execute(input: CloseIssueInput) {
38
- * const preview = await this.features.preview.execute(input);
39
- * if (preview.warnings.length > 0) return { blocked: preview };
40
- * return this.features.send.execute({ ...input, message: "cerrado" });
18
+ * // domains/project/services/close_and_notify.ts
19
+ * export class CloseAndNotify extends ApplicationService {
20
+ * async execute(input: dto.CommandCloseIssue) {
21
+ * await this.feature.Issues.close(input); // a child of this run, on the same trace
22
+ * return this.feature.Notices.tell(input);
41
23
  * }
42
24
  * }
43
25
  *
44
- * Context: it never executes another ApplicationService — sincpro_framework's rule, refused here
45
- * when it is constructed rather than found in a trace later.
26
+ * Context: a Feature is a facade — the operations of one part of the domain, each a public
27
+ * method; an ApplicationService composes the Features of its own bounded context and never
28
+ * another ApplicationService (sincpro_framework's rule). Neither writes a span nor catches an
29
+ * error to report it: the bounded context runs every public method inside its own execution
30
+ * (`UseBoundedContext`).
31
+ *
32
+ * The dependencies are typed, not declared: `BaseFeature<ProjectDependencies>` types
33
+ * `this.client` and `this.session` from the bounded context's dependency type — sincpro_framework's
34
+ * `DependencyContextType` — and the bounded context hands them in on each run. So a service
35
+ * constructs with nothing, keeps no dependency on `this`, and declares no `#private` field: a run
36
+ * sees the instance through a view of its own (its dependencies bound to its trace), and
37
+ * `#private` refuses views. TypeScript's `private` is the same promise without that.
46
38
  */
47
- export declare class ApplicationService<Features extends Readonly<Record<string, Feature<object>>>, Deps extends object = Record<string, never>> extends Feature<Deps> {
48
- protected readonly features: Features;
49
- constructor(features: Features, deps?: Deps);
39
+ declare class FeatureCore {
40
+ }
41
+ declare class ApplicationServiceCore extends FeatureCore {
50
42
  }
43
+ /** What every service sees on `this` inside a method. */
44
+ type Within<D extends object, C extends object> = Readonly<D> & {
45
+ /**
46
+ * What this run executes with: the process's context, its bounded context's, its scope's —
47
+ * read once where the gesture started and the same for every Feature it runs.
48
+ */
49
+ readonly context: Readonly<Partial<C>>;
50
+ };
51
+ /** Service classes by the name a bounded context gives them: `{ Issues, Notices }`. */
52
+ export type ServiceClasses = Readonly<Record<string, new () => object>>;
51
53
  /**
52
- * The services of a bounded context, each running in this runtime under that domain: traced as
53
- * `<domain>/<key>`, reported by its reporter, with its context.
54
- *
55
- * const project = bindServices(runtime, "project", { sendIssue, closeIssue });
56
- *
57
- * Context: a span is named by the key it is bound with, not by the class — a production build
58
- * renames classes, never the keys of an object.
54
+ * What a service offers to whoever holds it — `project.Issues`, `this.feature.Issues`: its public
55
+ * methods, without its dependencies, its context or its `_` helpers.
56
+ */
57
+ export type ServiceMethods<I, D> = {
58
+ readonly [M in keyof I as M extends keyof D | "context" | "feature" | `_${string}` ? never : I[M] extends (...args: never[]) => unknown ? M : never]: I[M];
59
+ };
60
+ /** The services of a set of classes, by their names. */
61
+ export type Services<S extends ServiceClasses, D> = {
62
+ readonly [K in keyof S]: ServiceMethods<InstanceType<S[K]>, D>;
63
+ };
64
+ type FeatureClass = abstract new <D extends object = Record<never, never>, C extends object = ContextValues>() => FeatureCore & Within<D, C>;
65
+ type ApplicationServiceClass = abstract new <D extends object = Record<never, never>, F extends ServiceClasses = Record<never, never>, C extends object = ContextValues>() => ApplicationServiceCore & Within<D, C> & {
66
+ /** The Features of this bounded context, each run a child of this one. */
67
+ readonly feature: Services<F, D>;
68
+ };
69
+ /** The base of a bounded context's Features: `class Feature extends BaseFeature<Deps> {}`. */
70
+ export declare const Feature: FeatureClass;
71
+ /**
72
+ * The base of a bounded context's ApplicationServices:
73
+ * `class ApplicationService extends BaseApplicationService<Deps, typeof features> {}`.
59
74
  */
60
- export declare function bindServices<Services extends Readonly<Record<string, Feature<object>>>>(runtime: Runtime, domain: string, services: Services): Services;
75
+ export declare const ApplicationService: ApplicationServiceClass;
76
+ /** Whether a class is a Feature — and not an ApplicationService. */
77
+ export declare function isFeatureClass(service: new () => object): boolean;
78
+ export declare function isApplicationServiceClass(service: new () => object): boolean;
79
+ /** Whether a service composes Features — an ApplicationService. */
80
+ export declare function composes(service: object): boolean;
81
+ export declare function methodsOf(service: object): ReadonlySet<string>;
82
+ export {};
@@ -1,95 +1,79 @@
1
- import { newEntityId } from "../client/ids.js";
2
- import { bindDependency } from "./execution.js";
3
- import { DETACHED } from "./runtime.js";
4
1
  /**
5
- * One use case. What it needs from outside — the generated client of its domain, another
6
- * adapter — comes in `deps`, typed by the subclass.
2
+ * `Feature` and `ApplicationService`: the two kinds of service a bounded context holds, as in
3
+ * sincpro_framework. Each bounded context gives them its dependencies once, in its own base:
7
4
  *
8
- * export class SendIssue extends Feature<{ project: ProjectClient }> {
9
- * execute(input: dto.CommandSendIssue) {
10
- * return this.deps.project.sendIssue(input);
5
+ * // domains/project/infrastructure/bounded_context.ts
6
+ * export class Feature extends BaseFeature<ProjectDependencies> {}
7
+ * export class ApplicationService extends BaseApplicationService<ProjectDependencies, ProjectFeatures> {}
8
+ *
9
+ * // domains/project/services/issues.ts
10
+ * export class Issues extends Feature {
11
+ * close(input: dto.CommandCloseIssue) {
12
+ * this.session.require(); // each dependency is a property — typed
13
+ * return this.client.closeIssue(input);
11
14
  * }
12
15
  * }
13
16
  *
14
- * Context: all of a client's logic lives in Features and ApplicationServices, as in
15
- * sincpro_framework and @sincpro/mobile, and none of them writes a span or catches an error to
16
- * report it: `new` answers the instance behind interceptors, and every public method runs
17
- * inside its own execution — a span named `<domain>/<name>`, the context it runs with, its
18
- * report if nobody expected how it failed. `execute` is a use case's entry; another public
19
- * method is traced as `<name>.<method>`, and a name that starts with `_` is not traced at all.
20
- *
21
- * Inside a method, `this.deps` and `this.context` are this run's own: each dependency that can
22
- * be (the transport, a generated client) is bound to the execution, so its requests carry this
23
- * run's trace. So a Feature keeps nothing of a request on `this`, and declares no `#private`
24
- * fields — the run sees the instance through a view of its own, and `#private` refuses views;
25
- * TypeScript's `private` is the same promise without that.
26
- */
27
- export class Feature {
28
- deps;
29
- /** What this run executes with (`RuntimeOptions.context`): empty outside a run. */
30
- context = NO_CONTEXT;
31
- constructor(deps) {
32
- this.deps = deps ?? {};
33
- // A class constructor that answers another object hands THAT to `new` and to every subclass
34
- // constructor after it: their fields land on the instance through the proxy.
35
- return intercepted(this, { runtime: DETACHED, domain: undefined, name: undefined });
36
- }
37
- }
38
- /**
39
- * A use case that composes the Features of its own domain — the only difference with a
40
- * Feature. Each call to one of them is a child of this run: its span under this span, the same
41
- * context, the same trace on the wire.
42
- *
43
- * export class CloseIssue extends ApplicationService<{ preview: PreviewClose; send: SendIssue }> {
44
- * async execute(input: CloseIssueInput) {
45
- * const preview = await this.features.preview.execute(input);
46
- * if (preview.warnings.length > 0) return { blocked: preview };
47
- * return this.features.send.execute({ ...input, message: "cerrado" });
17
+ * // domains/project/services/close_and_notify.ts
18
+ * export class CloseAndNotify extends ApplicationService {
19
+ * async execute(input: dto.CommandCloseIssue) {
20
+ * await this.feature.Issues.close(input); // a child of this run, on the same trace
21
+ * return this.feature.Notices.tell(input);
48
22
  * }
49
23
  * }
50
24
  *
51
- * Context: it never executes another ApplicationService — sincpro_framework's rule, refused here
52
- * when it is constructed rather than found in a trace later.
25
+ * Context: a Feature is a facade — the operations of one part of the domain, each a public
26
+ * method; an ApplicationService composes the Features of its own bounded context and never
27
+ * another ApplicationService (sincpro_framework's rule). Neither writes a span nor catches an
28
+ * error to report it: the bounded context runs every public method inside its own execution
29
+ * (`UseBoundedContext`).
30
+ *
31
+ * The dependencies are typed, not declared: `BaseFeature<ProjectDependencies>` types
32
+ * `this.client` and `this.session` from the bounded context's dependency type — sincpro_framework's
33
+ * `DependencyContextType` — and the bounded context hands them in on each run. So a service
34
+ * constructs with nothing, keeps no dependency on `this`, and declares no `#private` field: a run
35
+ * sees the instance through a view of its own (its dependencies bound to its trace), and
36
+ * `#private` refuses views. TypeScript's `private` is the same promise without that.
53
37
  */
54
- export class ApplicationService extends Feature {
55
- features;
56
- constructor(features, deps) {
57
- super(deps);
58
- for (const [name, feature] of Object.entries(features))
59
- if (targetOf(feature) instanceof ApplicationService)
60
- throw new Error(`${this.constructor.name}: "${name}" is an ApplicationService — an ApplicationService executes Features, never another ApplicationService`);
61
- this.features = features;
62
- }
38
+ class FeatureCore {
39
+ }
40
+ class ApplicationServiceCore extends FeatureCore {
63
41
  }
42
+ /** The base of a bounded context's Features: `class Feature extends BaseFeature<Deps> {}`. */
43
+ export const Feature = FeatureCore;
64
44
  /**
65
- * The services of a bounded context, each running in this runtime under that domain: traced as
66
- * `<domain>/<key>`, reported by its reporter, with its context.
67
- *
68
- * const project = bindServices(runtime, "project", { sendIssue, closeIssue });
69
- *
70
- * Context: a span is named by the key it is bound with, not by the class — a production build
71
- * renames classes, never the keys of an object.
45
+ * The base of a bounded context's ApplicationServices:
46
+ * `class ApplicationService extends BaseApplicationService<Deps, typeof features> {}`.
72
47
  */
73
- export function bindServices(runtime, domain, services) {
74
- return Object.fromEntries(Object.entries(services).map(([name, service]) => [
75
- name,
76
- intercepted(targetOf(service), { runtime, domain, name }),
77
- ]));
48
+ export const ApplicationService = ApplicationServiceCore;
49
+ /** Whether a class is a Feature — and not an ApplicationService. */
50
+ export function isFeatureClass(service) {
51
+ return (service.prototype instanceof FeatureCore &&
52
+ !(service.prototype instanceof ApplicationServiceCore));
78
53
  }
79
- const NO_CONTEXT = Object.freeze({});
80
- const TARGETS = new WeakMap();
81
- function targetOf(feature) {
82
- return TARGETS.get(feature) ?? feature;
54
+ export function isApplicationServiceClass(service) {
55
+ return service.prototype instanceof ApplicationServiceCore;
83
56
  }
84
- /** The methods a class adds over Feature — what is traced — read once per class. */
57
+ /** Whether a service composes Features — an ApplicationService. */
58
+ export function composes(service) {
59
+ return service instanceof ApplicationServiceCore;
60
+ }
61
+ /**
62
+ * The methods a class adds over its base — what is traced — read once per class: every public
63
+ * method of the class and its parents up to `Feature`, but `constructor` and a name that starts
64
+ * with `_`.
65
+ */
85
66
  const METHODS = new WeakMap();
86
- function methodsOf(target) {
87
- const prototype = Object.getPrototypeOf(target);
67
+ export function methodsOf(service) {
68
+ const prototype = Object.getPrototypeOf(service);
88
69
  const known = METHODS.get(prototype);
89
70
  if (known !== undefined)
90
71
  return known;
91
72
  const names = new Set();
92
- for (let level = prototype; level !== null && level !== Feature.prototype && level !== Object.prototype; level = Object.getPrototypeOf(level))
73
+ for (let level = prototype; level !== null &&
74
+ level !== ApplicationServiceCore.prototype &&
75
+ level !== FeatureCore.prototype &&
76
+ level !== Object.prototype; level = Object.getPrototypeOf(level))
93
77
  for (const name of Object.getOwnPropertyNames(level)) {
94
78
  const descriptor = Object.getOwnPropertyDescriptor(level, name);
95
79
  if (name !== "constructor" &&
@@ -100,121 +84,3 @@ function methodsOf(target) {
100
84
  METHODS.set(prototype, names);
101
85
  return names;
102
86
  }
103
- function intercepted(target, binding) {
104
- const proxy = new Proxy(target, {
105
- get(held, property) {
106
- const value = Reflect.get(held, property, held);
107
- if (typeof property !== "string" || typeof value !== "function")
108
- return value;
109
- if (!methodsOf(held).has(property))
110
- return value;
111
- return (...args) => run(held, property, value, args, binding);
112
- },
113
- });
114
- TARGETS.set(proxy, target);
115
- return proxy;
116
- }
117
- /**
118
- * Whether this is the first run to report this error. A Feature that fails inside an
119
- * ApplicationService throws through it: the error is reported once, by the run where it
120
- * happened — its span is the one that says where — and every run around it still ends `failed`.
121
- */
122
- const REPORTED = new WeakSet();
123
- function firstReport(error) {
124
- if (error === null || (typeof error !== "object" && typeof error !== "function"))
125
- return true;
126
- if (REPORTED.has(error))
127
- return false;
128
- REPORTED.add(error);
129
- return true;
130
- }
131
- function quietly(work, otherwise) {
132
- try {
133
- return work();
134
- }
135
- catch {
136
- return otherwise;
137
- }
138
- }
139
- const NO_SPAN = {
140
- traceId: "",
141
- spanId: "",
142
- sampled: false,
143
- set: () => undefined,
144
- end: () => undefined,
145
- };
146
- function run(target, method, body, args, binding) {
147
- const { runtime, domain, parent } = binding;
148
- const name = binding.name ?? target.constructor.name;
149
- const useCase = `${domain === undefined ? "" : `${domain}/`}${name}${method === "execute" ? "" : `.${method}`}`;
150
- const context = parent?.context ?? quietly(() => runtime.context(), NO_CONTEXT);
151
- const composes = target instanceof ApplicationService;
152
- const id = newEntityId();
153
- const attributes = {
154
- "sincpro.use_case": useCase,
155
- "sincpro.layer": composes ? "application_service" : "feature",
156
- "sincpro.execution_id": id,
157
- ...(domain === undefined ? {} : { "sincpro.domain": domain }),
158
- };
159
- const span = quietly(() => runtime.tracer.start(useCase, {
160
- ...(parent === undefined ? {} : { parent: parent.span }),
161
- attributes,
162
- }), NO_SPAN);
163
- const execution = { id, useCase, domain, parent, span, context };
164
- // The run's own view of the instance: its dependencies bound to this execution, its context,
165
- // and — for an ApplicationService — its Features as children of this run.
166
- const own = target;
167
- const view = Object.create(target, {
168
- deps: {
169
- value: Object.fromEntries(Object.entries(own.deps ?? {}).map(([key, dependency]) => [
170
- key,
171
- bindDependency(dependency, execution),
172
- ])),
173
- },
174
- context: { value: context },
175
- ...(composes
176
- ? {
177
- features: {
178
- value: Object.fromEntries(Object.entries(own.features ?? {}).map(([key, feature]) => [
179
- key,
180
- intercepted(targetOf(feature), {
181
- runtime,
182
- domain,
183
- name: key,
184
- parent: execution,
185
- }),
186
- ])),
187
- },
188
- }
189
- : {}),
190
- });
191
- const finish = (failed, error) => {
192
- const outcome = failed ? quietly(() => runtime.outcomeOf(error), "failed") : "ok";
193
- quietly(() => span.end(outcome, error), undefined);
194
- if (outcome === "failed" && firstReport(error))
195
- quietly(() => runtime.reporter?.report(error, {
196
- useCase,
197
- traceId: span.traceId,
198
- executionId: id,
199
- context,
200
- }), undefined);
201
- };
202
- let answer;
203
- try {
204
- answer = body.apply(view, args);
205
- }
206
- catch (error) {
207
- finish(true, error);
208
- throw error;
209
- }
210
- if (answer instanceof Promise)
211
- return answer.then((value) => {
212
- finish(false);
213
- return value;
214
- }, (error) => {
215
- finish(true, error);
216
- throw error;
217
- });
218
- finish(false);
219
- return answer;
220
- }
@@ -0,0 +1,60 @@
1
+ import { type Context, type StoreSource } from "../context/context.js";
2
+ import { type ContextStore } from "../context/store.js";
3
+ import { type ErrorReporter, type Outcome, type Tracer } from "../observability/ports.js";
4
+ /**
5
+ * What every bounded context of this process runs with — set once, in `main`, the way
6
+ * sincpro_framework's process is: who traces, who reports, where the context lives.
7
+ *
8
+ * // entrypoints/main.tsx — the platform's pieces, built from the application's settings
9
+ * configureProcess({
10
+ * tracer: browserTracer({ endpoint: settings.otlp, service: "forge-web" }),
11
+ * reporter: glitchtipReporter({ dsn: settings.glitchtip }),
12
+ * context: memoryContexts(),
13
+ * });
14
+ *
15
+ * Context: everything is optional, and nothing breaks without it. A process that never configures
16
+ * runs every use case untraced, unreported, with its context in memory — so a bounded context is
17
+ * usable the moment it is imported, and `main` adds what it watches with. The bounded contexts
18
+ * read the process on every call, never at import: `project` may be defined before `main` runs.
19
+ *
20
+ * It replaces everything at once: what is not given goes back to its default — a test calls it
21
+ * with its own tracer and starts from a clean context.
22
+ */
23
+ export type ProcessOptions = {
24
+ /** The platform's (OpenTelemetry in a browser, a queue on a phone, memory in a test). */
25
+ tracer?: Tracer;
26
+ /** The platform's (GlitchTip, Sentry, memory in a test). Only what nobody expected reaches it. */
27
+ reporter?: ErrorReporter;
28
+ /** Where the context lives (`memoryContexts()` by default). */
29
+ context?: ContextStore;
30
+ /** How an error ended a use case (`outcomeOf` by default). Only `failed` is reported. */
31
+ outcomeOf?: (error: unknown) => Outcome;
32
+ };
33
+ /** The process as a use case reads it. Not public: `configureProcess` is the way in. */
34
+ export type Process = {
35
+ readonly tracer: Tracer;
36
+ readonly reporter: ErrorReporter | undefined;
37
+ readonly store: ContextStore;
38
+ readonly outcomeOf: (error: unknown) => Outcome;
39
+ };
40
+ export declare function configureProcess(options?: ProcessOptions): void;
41
+ /** The process's store as every level of the context reads it — the process's and each bounded context's. */
42
+ export declare const processStore: StoreSource;
43
+ /** What the process runs with now. */
44
+ export declare function processNow(): Process;
45
+ /**
46
+ * The process's level of the context: what every use case of every bounded context runs with —
47
+ * the tenant, the company, the language.
48
+ *
49
+ * processContext.set({ tenant_id: "acme" });
50
+ */
51
+ export declare const processContext: Context;
52
+ /**
53
+ * How an error ended a use case, by default.
54
+ *
55
+ * Context: the backend reports what nobody expected and only that — a refusal it explained is
56
+ * the business answering, not a fault. Here the same: a `TransportError` the server answered
57
+ * with a 4xx is `refused`; a request the caller stopped waiting for is `aborted`; everything
58
+ * else — a bug, a 5xx, a server nobody could reach — is `failed`, and reported.
59
+ */
60
+ export declare function outcomeOf(error: unknown): Outcome;
@@ -0,0 +1,57 @@
1
+ import { TransportError } from "../client/transport.js";
2
+ import { contextAt, } from "../context/context.js";
3
+ import { memoryContexts } from "../context/store.js";
4
+ import { NO_TRACER, } from "../observability/ports.js";
5
+ function settled(options) {
6
+ return {
7
+ tracer: options.tracer ?? NO_TRACER,
8
+ reporter: options.reporter,
9
+ store: options.context ?? memoryContexts(),
10
+ outcomeOf: options.outcomeOf ?? outcomeOf,
11
+ };
12
+ }
13
+ let current = settled({});
14
+ const replacing = new Set();
15
+ export function configureProcess(options = {}) {
16
+ const before = current.store;
17
+ current = settled(options);
18
+ if (current.store !== before)
19
+ for (const listener of [...replacing])
20
+ listener();
21
+ }
22
+ /** The process's store as every level of the context reads it — the process's and each bounded context's. */
23
+ export const processStore = {
24
+ current: () => current.store,
25
+ replaced(listener) {
26
+ replacing.add(listener);
27
+ return () => void replacing.delete(listener);
28
+ },
29
+ };
30
+ /** What the process runs with now. */
31
+ export function processNow() {
32
+ return current;
33
+ }
34
+ /**
35
+ * The process's level of the context: what every use case of every bounded context runs with —
36
+ * the tenant, the company, the language.
37
+ *
38
+ * processContext.set({ tenant_id: "acme" });
39
+ */
40
+ export const processContext = contextAt("process", processStore);
41
+ /**
42
+ * How an error ended a use case, by default.
43
+ *
44
+ * Context: the backend reports what nobody expected and only that — a refusal it explained is
45
+ * the business answering, not a fault. Here the same: a `TransportError` the server answered
46
+ * with a 4xx is `refused`; a request the caller stopped waiting for is `aborted`; everything
47
+ * else — a bug, a 5xx, a server nobody could reach — is `failed`, and reported.
48
+ */
49
+ export function outcomeOf(error) {
50
+ if (error instanceof TransportError && error.status !== null)
51
+ return error.status >= 400 && error.status < 500 ? "refused" : "failed";
52
+ if (error !== null &&
53
+ typeof error === "object" &&
54
+ error.name === "AbortError")
55
+ return "aborted";
56
+ return "failed";
57
+ }
@@ -3,9 +3,9 @@ import type { ErrorAbout, ErrorReporter, Outcome, Tracer } from "../observabilit
3
3
  * A tracer and a reporter that keep what they were told, so a test reads it back.
4
4
  *
5
5
  * const tracer = memoryTracer();
6
- * const project = bindServices(createRuntime({ tracer }), "project", { closeIssue });
7
- * await project.closeIssue.execute(input);
8
- * tracer.spans.map((one) => one.name); // ["project/closeIssue", "project/send", …]
6
+ * configureProcess({ tracer });
7
+ * await project.CloseIssue.execute(input);
8
+ * tracer.spans.map((one) => one.name); // ["project/CloseIssue", "project/Issues.close", …]
9
9
  *
10
10
  * Context: a use case is proven in Node with nothing of a platform; these are the platform's
11
11
  * part, held in memory. Not test doubles of this package — real implementations of its ports.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sincpro/client-framework",
3
- "version": "0.2.0",
3
+ "version": "0.3.0",
4
4
  "description": "The client side of sincpro_framework, for every platform: Feature and ApplicationService traced and reported by default, applications made of domains, and the typed client generated from a service's contract. No React, no DOM.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -67,7 +67,7 @@
67
67
  "printWidth": 94
68
68
  },
69
69
  "peerDependencies": {
70
- "@opentelemetry/api": "^1.10.0",
70
+ "@opentelemetry/api": "^1.9.0",
71
71
  "@sincpro/criteria": "^2.0.0"
72
72
  },
73
73
  "peerDependenciesMeta": {