@nice-code/action 0.9.0 → 0.11.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.
- package/build/{ActionDevtoolsCore-yfJ9tkvl.js → ActionDevtoolsCore-9PsnscvK.mjs} +2 -2
- package/build/ActionDevtoolsCore-9PsnscvK.mjs.map +1 -0
- package/build/{ActionDevtoolsCore-B4s6aGvI.d.ts → ActionDevtoolsCore-CCRLYASa.d.cts} +2 -2
- package/build/{ActionDevtoolsCore-Pg7ERO3L.d.ts → ActionDevtoolsCore-CYGD2o6C.d.mts} +2 -2
- package/build/{ActionDevtoolsCore-BLeY_N-3.js → ActionDevtoolsCore-DtgXwPBZ.cjs} +2 -2
- package/build/ActionDevtoolsCore-DtgXwPBZ.cjs.map +1 -0
- package/build/{ActionPayload.types-BN-rXFBK.d.ts → ActionPayload.types-BN-rXFBK.d.cts} +1 -1
- package/build/{ActionPayload.types-D28ELKXC.d.ts → ActionPayload.types-D28ELKXC.d.mts} +1 -1
- package/build/{RunningAction.types-C176rqHG.js → RunningAction.types-C176rqHG.mjs} +1 -1
- package/build/RunningAction.types-C176rqHG.mjs.map +1 -0
- package/build/{RunningAction.types-DjCX1xp5.js → RunningAction.types-DjCX1xp5.cjs} +1 -1
- package/build/RunningAction.types-DjCX1xp5.cjs.map +1 -0
- package/build/devtools/browser/index.cjs +3886 -0
- package/build/devtools/browser/index.cjs.map +1 -0
- package/build/devtools/browser/{index.d.ts → index.d.cts} +2 -2
- package/build/devtools/browser/index.d.mts +17 -0
- package/build/devtools/browser/{index.js → index.mjs} +2 -2
- package/build/devtools/browser/index.mjs.map +1 -0
- package/build/devtools/server/index.cjs +108 -0
- package/build/devtools/server/index.cjs.map +1 -0
- package/build/devtools/server/{index.d.ts → index.d.cts} +2 -2
- package/build/devtools/server/index.d.mts +35 -0
- package/build/devtools/server/{index.js → index.mjs} +3 -3
- package/build/devtools/server/index.mjs.map +1 -0
- package/build/index.cjs +4045 -0
- package/build/index.cjs.map +1 -0
- package/build/{index.d.ts → index.d.cts} +1 -1
- package/build/index.d.mts +2 -0
- package/build/{index.js → index.mjs} +2 -2
- package/build/index.mjs.map +1 -0
- package/build/react-query/index.cjs +70 -0
- package/build/react-query/index.cjs.map +1 -0
- package/build/react-query/{index.d.ts → index.d.cts} +2 -2
- package/build/react-query/index.d.mts +17 -0
- package/build/react-query/{index.js → index.mjs} +1 -1
- package/build/react-query/index.mjs.map +1 -0
- package/package.json +39 -16
- package/build/ActionDevtoolsCore-BLeY_N-3.js.map +0 -1
- package/build/ActionDevtoolsCore-yfJ9tkvl.js.map +0 -1
- package/build/RunningAction.types-C176rqHG.js.map +0 -1
- package/build/RunningAction.types-DjCX1xp5.js.map +0 -1
- package/build/devtools/browser/index.js.map +0 -1
- package/build/devtools/server/index.js.map +0 -1
- package/build/index.js.map +0 -1
- package/build/react-query/index.js.map +0 -1
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
|
+
require("../../RunningAction.types-DjCX1xp5.cjs");
|
|
3
|
+
const require_ActionDevtoolsCore = require("../../ActionDevtoolsCore-DtgXwPBZ.cjs");
|
|
4
|
+
//#region src/devtools/server/NiceActionServerDevtools.ts
|
|
5
|
+
var ActionServerDevtools = class {
|
|
6
|
+
_options;
|
|
7
|
+
_inFlight = /* @__PURE__ */ new Map();
|
|
8
|
+
constructor(options = {}) {
|
|
9
|
+
const defaultEnabled = typeof process !== "undefined" ? false : true;
|
|
10
|
+
this._options = {
|
|
11
|
+
logger: options.logger ?? defaultConsoleLogger,
|
|
12
|
+
format: options.format ?? "pretty",
|
|
13
|
+
logPayloads: options.logPayloads ?? true,
|
|
14
|
+
enabled: options.enabled ?? defaultEnabled
|
|
15
|
+
};
|
|
16
|
+
}
|
|
17
|
+
attachToDomain(domain) {
|
|
18
|
+
if (!this._options.enabled) return () => {};
|
|
19
|
+
return domain.addActionListener((update) => {
|
|
20
|
+
const { runningAction, type, time } = update;
|
|
21
|
+
const actionPath = [...runningAction.allDomains, runningAction.id].join(".");
|
|
22
|
+
if (type === "started") {
|
|
23
|
+
this._inFlight.set(runningAction.cuid, { startTime: time });
|
|
24
|
+
this._log("started", actionPath, runningAction.cuid, { ...this._options.logPayloads ? { input: runningAction.state?.request?.input } : {} });
|
|
25
|
+
} else if (type === "progress") this._log("progress", actionPath, runningAction.cuid, { progress: update.progress });
|
|
26
|
+
else if (type === "finished") {
|
|
27
|
+
const timing = this._inFlight.get(runningAction.cuid);
|
|
28
|
+
const duration = timing != null ? time - timing.startTime : void 0;
|
|
29
|
+
this._inFlight.delete(runningAction.cuid);
|
|
30
|
+
const finishType = update.finishType;
|
|
31
|
+
if (finishType === "success") {
|
|
32
|
+
const result = update.response?.result;
|
|
33
|
+
if (result != null && !result.ok) this._log("action-error", actionPath, runningAction.cuid, {
|
|
34
|
+
...duration != null ? { duration: `${duration}ms` } : {},
|
|
35
|
+
error: serializeError(result.error)
|
|
36
|
+
});
|
|
37
|
+
else this._log("success", actionPath, runningAction.cuid, {
|
|
38
|
+
...duration != null ? { duration: `${duration}ms` } : {},
|
|
39
|
+
...this._options.logPayloads ? { output: result?.output } : {}
|
|
40
|
+
});
|
|
41
|
+
} else if (finishType === "failed") this._log("failed", actionPath, runningAction.cuid, {
|
|
42
|
+
...duration != null ? { duration: `${duration}ms` } : {},
|
|
43
|
+
error: serializeError(update.error)
|
|
44
|
+
});
|
|
45
|
+
else this._log("aborted", actionPath, runningAction.cuid, {
|
|
46
|
+
...duration != null ? { duration: `${duration}ms` } : {},
|
|
47
|
+
...update.reason != null ? { reason: String(update.reason) } : {}
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
});
|
|
51
|
+
}
|
|
52
|
+
_log(event, actionPath, cuid, data) {
|
|
53
|
+
const { logger, format } = this._options;
|
|
54
|
+
if (format === "json") {
|
|
55
|
+
logger(JSON.stringify({
|
|
56
|
+
time: (/* @__PURE__ */ new Date()).toISOString(),
|
|
57
|
+
event,
|
|
58
|
+
action: actionPath,
|
|
59
|
+
cuid,
|
|
60
|
+
...data
|
|
61
|
+
}));
|
|
62
|
+
return;
|
|
63
|
+
}
|
|
64
|
+
logger(`${PRETTY_PREFIX[event] ?? `[${event}]`} ${actionPath} cuid=${cuid}${Object.keys(data).length > 0 ? ` ${formatPrettyData(data)}` : ""}`);
|
|
65
|
+
}
|
|
66
|
+
};
|
|
67
|
+
const PRETTY_PREFIX = {
|
|
68
|
+
started: "[nice-action] ►",
|
|
69
|
+
progress: "[nice-action] ",
|
|
70
|
+
success: "[nice-action] ✓",
|
|
71
|
+
failed: "[nice-action] ✗",
|
|
72
|
+
aborted: "[nice-action] ○"
|
|
73
|
+
};
|
|
74
|
+
function formatPrettyData(data) {
|
|
75
|
+
return Object.entries(data).map(([k, v]) => `${k}=${safeStringify(v)}`).join(" ");
|
|
76
|
+
}
|
|
77
|
+
function safeStringify(value) {
|
|
78
|
+
if (value === void 0) return "undefined";
|
|
79
|
+
if (value === null) return "null";
|
|
80
|
+
if (typeof value === "string") return `"${value}"`;
|
|
81
|
+
try {
|
|
82
|
+
return JSON.stringify(value);
|
|
83
|
+
} catch {
|
|
84
|
+
return String(value);
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
function serializeError(err) {
|
|
88
|
+
if (err == null) return err;
|
|
89
|
+
if (err instanceof Error) return {
|
|
90
|
+
message: err.message,
|
|
91
|
+
name: err.name,
|
|
92
|
+
stack: err.stack
|
|
93
|
+
};
|
|
94
|
+
if (typeof err === "object") try {
|
|
95
|
+
return JSON.parse(JSON.stringify(err));
|
|
96
|
+
} catch {
|
|
97
|
+
return String(err);
|
|
98
|
+
}
|
|
99
|
+
return err;
|
|
100
|
+
}
|
|
101
|
+
function defaultConsoleLogger(message) {
|
|
102
|
+
console.log(message);
|
|
103
|
+
}
|
|
104
|
+
//#endregion
|
|
105
|
+
exports.ActionDevtoolsCore = require_ActionDevtoolsCore.ActionDevtoolsCore;
|
|
106
|
+
exports.ActionServerDevtools = ActionServerDevtools;
|
|
107
|
+
|
|
108
|
+
//# sourceMappingURL=index.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.cjs","names":[],"sources":["../../../src/devtools/server/NiceActionServerDevtools.ts"],"sourcesContent":["import {\r\n ERunningActionFinishedType,\r\n ERunningActionUpdateType,\r\n} from \"../../ActionDefinition/Action/RunningAction.types\";\r\nimport type { IDevtoolsObservableDomain } from \"../core/ActionDevtools.types\";\r\n\r\nexport type TServerDevtoolsLogFn = (message: string, data?: Record<string, unknown>) => void;\r\n\r\nexport interface IActionServerDevtoolsOptions {\r\n /**\r\n * Custom logger function. Defaults to console.log / console.error.\r\n */\r\n logger?: TServerDevtoolsLogFn;\r\n /**\r\n * Output format.\r\n * - \"pretty\": human-readable lines (default)\r\n * - \"json\": newline-delimited JSON for log aggregators\r\n */\r\n format?: \"pretty\" | \"json\";\r\n /**\r\n * Whether to log action input/output payloads.\r\n * Disable if payloads may contain sensitive data. Defaults to true.\r\n */\r\n logPayloads?: boolean;\r\n /**\r\n * Whether devtools are active. Defaults to process.env.NODE_ENV !== \"production\".\r\n */\r\n enabled?: boolean;\r\n}\r\n\r\ninterface IStartedTiming {\r\n startTime: number;\r\n}\r\n\r\nexport class ActionServerDevtools {\r\n private readonly _options: Required<IActionServerDevtoolsOptions>;\r\n private readonly _inFlight: Map<string, IStartedTiming> = new Map();\r\n\r\n constructor(options: IActionServerDevtoolsOptions = {}) {\r\n const defaultEnabled =\r\n typeof process !== \"undefined\" ? process[\"env\"][\"NODE_ENV\"] !== \"production\" : true;\r\n\r\n this._options = {\r\n logger: options.logger ?? defaultConsoleLogger,\r\n format: options.format ?? \"pretty\",\r\n logPayloads: options.logPayloads ?? true,\r\n enabled: options.enabled ?? defaultEnabled,\r\n };\r\n }\r\n\r\n attachToDomain(domain: IDevtoolsObservableDomain): () => void {\r\n if (!this._options.enabled) {\r\n return () => {};\r\n }\r\n\r\n return domain.addActionListener((update) => {\r\n const { runningAction, type, time } = update;\r\n const actionPath = [...runningAction.allDomains, runningAction.id].join(\".\");\r\n\r\n if (type === ERunningActionUpdateType.started) {\r\n this._inFlight.set(runningAction.cuid, { startTime: time });\r\n this._log(\"started\", actionPath, runningAction.cuid, {\r\n ...(this._options.logPayloads ? { input: runningAction.state?.request?.input } : {}),\r\n });\r\n } else if (type === ERunningActionUpdateType.progress) {\r\n this._log(\"progress\", actionPath, runningAction.cuid, { progress: update.progress });\r\n } else if (type === ERunningActionUpdateType.finished) {\r\n const timing = this._inFlight.get(runningAction.cuid);\r\n const duration = timing != null ? time - timing.startTime : undefined;\r\n this._inFlight.delete(runningAction.cuid);\r\n\r\n const finishType: string = update.finishType;\r\n\r\n if (finishType === ERunningActionFinishedType.success) {\r\n const result = update.response?.result;\r\n if (result != null && !result.ok) {\r\n this._log(\"action-error\", actionPath, runningAction.cuid, {\r\n ...(duration != null ? { duration: `${duration}ms` } : {}),\r\n error: serializeError(result.error),\r\n });\r\n } else {\r\n this._log(\"success\", actionPath, runningAction.cuid, {\r\n ...(duration != null ? { duration: `${duration}ms` } : {}),\r\n ...(this._options.logPayloads ? { output: result?.output } : {}),\r\n });\r\n }\r\n } else if (finishType === ERunningActionFinishedType.failed) {\r\n this._log(\"failed\", actionPath, runningAction.cuid, {\r\n ...(duration != null ? { duration: `${duration}ms` } : {}),\r\n error: serializeError(update.error),\r\n });\r\n } else {\r\n this._log(\"aborted\", actionPath, runningAction.cuid, {\r\n ...(duration != null ? { duration: `${duration}ms` } : {}),\r\n ...(update.reason != null ? { reason: String(update.reason) } : {}),\r\n });\r\n }\r\n }\r\n });\r\n }\r\n\r\n private _log(\r\n event: string,\r\n actionPath: string,\r\n cuid: string,\r\n data: Record<string, unknown>,\r\n ): void {\r\n const { logger, format } = this._options;\r\n\r\n if (format === \"json\") {\r\n logger(\r\n JSON.stringify({\r\n time: new Date().toISOString(),\r\n event,\r\n action: actionPath,\r\n cuid,\r\n ...data,\r\n }),\r\n );\r\n return;\r\n }\r\n\r\n const prefix = PRETTY_PREFIX[event] ?? `[${event}]`;\r\n const suffix = Object.keys(data).length > 0 ? ` ${formatPrettyData(data)}` : \"\";\r\n logger(`${prefix} ${actionPath} cuid=${cuid}${suffix}`);\r\n }\r\n}\r\n\r\nconst PRETTY_PREFIX: Record<string, string> = {\r\n started: \"[nice-action] ►\",\r\n progress: \"[nice-action] \",\r\n success: \"[nice-action] ✓\",\r\n failed: \"[nice-action] ✗\",\r\n aborted: \"[nice-action] ○\",\r\n};\r\n\r\nfunction formatPrettyData(data: Record<string, unknown>): string {\r\n return Object.entries(data)\r\n .map(([k, v]) => `${k}=${safeStringify(v)}`)\r\n .join(\" \");\r\n}\r\n\r\nfunction safeStringify(value: unknown): string {\r\n if (value === undefined) return \"undefined\";\r\n if (value === null) return \"null\";\r\n if (typeof value === \"string\") return `\"${value}\"`;\r\n try {\r\n return JSON.stringify(value);\r\n } catch {\r\n return String(value);\r\n }\r\n}\r\n\r\nfunction serializeError(err: unknown): unknown {\r\n if (err == null) return err;\r\n if (err instanceof Error) return { message: err.message, name: err.name, stack: err.stack };\r\n if (typeof err === \"object\") {\r\n try {\r\n return JSON.parse(JSON.stringify(err));\r\n } catch {\r\n return String(err);\r\n }\r\n }\r\n return err;\r\n}\r\n\r\nfunction defaultConsoleLogger(message: string): void {\r\n console.log(message);\r\n}\r\n"],"mappings":";;;;AAkCA,IAAa,uBAAb,MAAkC;CAChC;CACA,4BAA0D,IAAI,IAAI;CAElE,YAAY,UAAwC,CAAC,GAAG;EACtD,MAAM,iBACJ,OAAO,YAAY,cAAc,QAA8C;EAEjF,KAAK,WAAW;GACd,QAAQ,QAAQ,UAAU;GAC1B,QAAQ,QAAQ,UAAU;GAC1B,aAAa,QAAQ,eAAe;GACpC,SAAS,QAAQ,WAAW;EAC9B;CACF;CAEA,eAAe,QAA+C;EAC5D,IAAI,CAAC,KAAK,SAAS,SACjB,aAAa,CAAC;EAGhB,OAAO,OAAO,mBAAmB,WAAW;GAC1C,MAAM,EAAE,eAAe,MAAM,SAAS;GACtC,MAAM,aAAa,CAAC,GAAG,cAAc,YAAY,cAAc,EAAE,CAAC,CAAC,KAAK,GAAG;GAE3E,IAAI,SAAA,WAA2C;IAC7C,KAAK,UAAU,IAAI,cAAc,MAAM,EAAE,WAAW,KAAK,CAAC;IAC1D,KAAK,KAAK,WAAW,YAAY,cAAc,MAAM,EACnD,GAAI,KAAK,SAAS,cAAc,EAAE,OAAO,cAAc,OAAO,SAAS,MAAM,IAAI,CAAC,EACpF,CAAC;GACH,OAAO,IAAI,SAAA,YACT,KAAK,KAAK,YAAY,YAAY,cAAc,MAAM,EAAE,UAAU,OAAO,SAAS,CAAC;QAC9E,IAAI,SAAA,YAA4C;IACrD,MAAM,SAAS,KAAK,UAAU,IAAI,cAAc,IAAI;IACpD,MAAM,WAAW,UAAU,OAAO,OAAO,OAAO,YAAY,KAAA;IAC5D,KAAK,UAAU,OAAO,cAAc,IAAI;IAExC,MAAM,aAAqB,OAAO;IAElC,IAAI,eAAA,WAAmD;KACrD,MAAM,SAAS,OAAO,UAAU;KAChC,IAAI,UAAU,QAAQ,CAAC,OAAO,IAC5B,KAAK,KAAK,gBAAgB,YAAY,cAAc,MAAM;MACxD,GAAI,YAAY,OAAO,EAAE,UAAU,GAAG,SAAS,IAAI,IAAI,CAAC;MACxD,OAAO,eAAe,OAAO,KAAK;KACpC,CAAC;UAED,KAAK,KAAK,WAAW,YAAY,cAAc,MAAM;MACnD,GAAI,YAAY,OAAO,EAAE,UAAU,GAAG,SAAS,IAAI,IAAI,CAAC;MACxD,GAAI,KAAK,SAAS,cAAc,EAAE,QAAQ,QAAQ,OAAO,IAAI,CAAC;KAChE,CAAC;IAEL,OAAO,IAAI,eAAA,UACT,KAAK,KAAK,UAAU,YAAY,cAAc,MAAM;KAClD,GAAI,YAAY,OAAO,EAAE,UAAU,GAAG,SAAS,IAAI,IAAI,CAAC;KACxD,OAAO,eAAe,OAAO,KAAK;IACpC,CAAC;SAED,KAAK,KAAK,WAAW,YAAY,cAAc,MAAM;KACnD,GAAI,YAAY,OAAO,EAAE,UAAU,GAAG,SAAS,IAAI,IAAI,CAAC;KACxD,GAAI,OAAO,UAAU,OAAO,EAAE,QAAQ,OAAO,OAAO,MAAM,EAAE,IAAI,CAAC;IACnE,CAAC;GAEL;EACF,CAAC;CACH;CAEA,KACE,OACA,YACA,MACA,MACM;EACN,MAAM,EAAE,QAAQ,WAAW,KAAK;EAEhC,IAAI,WAAW,QAAQ;GACrB,OACE,KAAK,UAAU;IACb,uBAAM,IAAI,KAAK,EAAA,CAAE,YAAY;IAC7B;IACA,QAAQ;IACR;IACA,GAAG;GACL,CAAC,CACH;GACA;EACF;EAIA,OAAO,GAFQ,cAAc,UAAU,IAAI,MAAM,GAEhC,GAAG,WAAW,SAAS,OADzB,OAAO,KAAK,IAAI,CAAC,CAAC,SAAS,IAAI,KAAK,iBAAiB,IAAI,MAAM,IACvB;CACzD;AACF;AAEA,MAAM,gBAAwC;CAC5C,SAAS;CACT,UAAU;CACV,SAAS;CACT,QAAQ;CACR,SAAS;AACX;AAEA,SAAS,iBAAiB,MAAuC;CAC/D,OAAO,OAAO,QAAQ,IAAI,CAAC,CACxB,KAAK,CAAC,GAAG,OAAO,GAAG,EAAE,GAAG,cAAc,CAAC,GAAG,CAAC,CAC3C,KAAK,GAAG;AACb;AAEA,SAAS,cAAc,OAAwB;CAC7C,IAAI,UAAU,KAAA,GAAW,OAAO;CAChC,IAAI,UAAU,MAAM,OAAO;CAC3B,IAAI,OAAO,UAAU,UAAU,OAAO,IAAI,MAAM;CAChD,IAAI;EACF,OAAO,KAAK,UAAU,KAAK;CAC7B,QAAQ;EACN,OAAO,OAAO,KAAK;CACrB;AACF;AAEA,SAAS,eAAe,KAAuB;CAC7C,IAAI,OAAO,MAAM,OAAO;CACxB,IAAI,eAAe,OAAO,OAAO;EAAE,SAAS,IAAI;EAAS,MAAM,IAAI;EAAM,OAAO,IAAI;CAAM;CAC1F,IAAI,OAAO,QAAQ,UACjB,IAAI;EACF,OAAO,KAAK,MAAM,KAAK,UAAU,GAAG,CAAC;CACvC,QAAQ;EACN,OAAO,OAAO,GAAG;CACnB;CAEF,OAAO;AACT;AAEA,SAAS,qBAAqB,SAAuB;CACnD,QAAQ,IAAI,OAAO;AACrB"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { a as TDevtoolsActionStatus, i as IDevtoolsObservableDomain, n as IActionDevtoolsCoreOptions, o as TDevtoolsListener, r as IDevtoolsActionEntry, t as ActionDevtoolsCore } from "../../ActionDevtoolsCore-
|
|
1
|
+
import { a as TDevtoolsActionStatus, i as IDevtoolsObservableDomain, n as IActionDevtoolsCoreOptions, o as TDevtoolsListener, r as IDevtoolsActionEntry, t as ActionDevtoolsCore } from "../../ActionDevtoolsCore-CCRLYASa.cjs";
|
|
2
2
|
|
|
3
3
|
//#region src/devtools/server/NiceActionServerDevtools.d.ts
|
|
4
4
|
type TServerDevtoolsLogFn = (message: string, data?: Record<string, unknown>) => void;
|
|
@@ -32,4 +32,4 @@ declare class ActionServerDevtools {
|
|
|
32
32
|
}
|
|
33
33
|
//#endregion
|
|
34
34
|
export { ActionDevtoolsCore, ActionServerDevtools, type IActionDevtoolsCoreOptions, type IActionServerDevtoolsOptions, type IDevtoolsActionEntry, type IDevtoolsObservableDomain, type TDevtoolsActionStatus, type TDevtoolsListener, type TServerDevtoolsLogFn };
|
|
35
|
-
//# sourceMappingURL=index.d.
|
|
35
|
+
//# sourceMappingURL=index.d.cts.map
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { a as TDevtoolsActionStatus, i as IDevtoolsObservableDomain, n as IActionDevtoolsCoreOptions, o as TDevtoolsListener, r as IDevtoolsActionEntry, t as ActionDevtoolsCore } from "../../ActionDevtoolsCore-CYGD2o6C.mjs";
|
|
2
|
+
|
|
3
|
+
//#region src/devtools/server/NiceActionServerDevtools.d.ts
|
|
4
|
+
type TServerDevtoolsLogFn = (message: string, data?: Record<string, unknown>) => void;
|
|
5
|
+
interface IActionServerDevtoolsOptions {
|
|
6
|
+
/**
|
|
7
|
+
* Custom logger function. Defaults to console.log / console.error.
|
|
8
|
+
*/
|
|
9
|
+
logger?: TServerDevtoolsLogFn;
|
|
10
|
+
/**
|
|
11
|
+
* Output format.
|
|
12
|
+
* - "pretty": human-readable lines (default)
|
|
13
|
+
* - "json": newline-delimited JSON for log aggregators
|
|
14
|
+
*/
|
|
15
|
+
format?: "pretty" | "json";
|
|
16
|
+
/**
|
|
17
|
+
* Whether to log action input/output payloads.
|
|
18
|
+
* Disable if payloads may contain sensitive data. Defaults to true.
|
|
19
|
+
*/
|
|
20
|
+
logPayloads?: boolean;
|
|
21
|
+
/**
|
|
22
|
+
* Whether devtools are active. Defaults to process.env.NODE_ENV !== "production".
|
|
23
|
+
*/
|
|
24
|
+
enabled?: boolean;
|
|
25
|
+
}
|
|
26
|
+
declare class ActionServerDevtools {
|
|
27
|
+
private readonly _options;
|
|
28
|
+
private readonly _inFlight;
|
|
29
|
+
constructor(options?: IActionServerDevtoolsOptions);
|
|
30
|
+
attachToDomain(domain: IDevtoolsObservableDomain): () => void;
|
|
31
|
+
private _log;
|
|
32
|
+
}
|
|
33
|
+
//#endregion
|
|
34
|
+
export { ActionDevtoolsCore, ActionServerDevtools, type IActionDevtoolsCoreOptions, type IActionServerDevtoolsOptions, type IDevtoolsActionEntry, type IDevtoolsObservableDomain, type TDevtoolsActionStatus, type TDevtoolsListener, type TServerDevtoolsLogFn };
|
|
35
|
+
//# sourceMappingURL=index.d.mts.map
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import "../../RunningAction.types-C176rqHG.
|
|
2
|
-
import { t as ActionDevtoolsCore } from "../../ActionDevtoolsCore-
|
|
1
|
+
import "../../RunningAction.types-C176rqHG.mjs";
|
|
2
|
+
import { t as ActionDevtoolsCore } from "../../ActionDevtoolsCore-9PsnscvK.mjs";
|
|
3
3
|
//#region src/devtools/server/NiceActionServerDevtools.ts
|
|
4
4
|
var ActionServerDevtools = class {
|
|
5
5
|
_options;
|
|
@@ -103,4 +103,4 @@ function defaultConsoleLogger(message) {
|
|
|
103
103
|
//#endregion
|
|
104
104
|
export { ActionDevtoolsCore, ActionServerDevtools };
|
|
105
105
|
|
|
106
|
-
//# sourceMappingURL=index.
|
|
106
|
+
//# sourceMappingURL=index.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","names":[],"sources":["../../../src/devtools/server/NiceActionServerDevtools.ts"],"sourcesContent":["import {\r\n ERunningActionFinishedType,\r\n ERunningActionUpdateType,\r\n} from \"../../ActionDefinition/Action/RunningAction.types\";\r\nimport type { IDevtoolsObservableDomain } from \"../core/ActionDevtools.types\";\r\n\r\nexport type TServerDevtoolsLogFn = (message: string, data?: Record<string, unknown>) => void;\r\n\r\nexport interface IActionServerDevtoolsOptions {\r\n /**\r\n * Custom logger function. Defaults to console.log / console.error.\r\n */\r\n logger?: TServerDevtoolsLogFn;\r\n /**\r\n * Output format.\r\n * - \"pretty\": human-readable lines (default)\r\n * - \"json\": newline-delimited JSON for log aggregators\r\n */\r\n format?: \"pretty\" | \"json\";\r\n /**\r\n * Whether to log action input/output payloads.\r\n * Disable if payloads may contain sensitive data. Defaults to true.\r\n */\r\n logPayloads?: boolean;\r\n /**\r\n * Whether devtools are active. Defaults to process.env.NODE_ENV !== \"production\".\r\n */\r\n enabled?: boolean;\r\n}\r\n\r\ninterface IStartedTiming {\r\n startTime: number;\r\n}\r\n\r\nexport class ActionServerDevtools {\r\n private readonly _options: Required<IActionServerDevtoolsOptions>;\r\n private readonly _inFlight: Map<string, IStartedTiming> = new Map();\r\n\r\n constructor(options: IActionServerDevtoolsOptions = {}) {\r\n const defaultEnabled =\r\n typeof process !== \"undefined\" ? process[\"env\"][\"NODE_ENV\"] !== \"production\" : true;\r\n\r\n this._options = {\r\n logger: options.logger ?? defaultConsoleLogger,\r\n format: options.format ?? \"pretty\",\r\n logPayloads: options.logPayloads ?? true,\r\n enabled: options.enabled ?? defaultEnabled,\r\n };\r\n }\r\n\r\n attachToDomain(domain: IDevtoolsObservableDomain): () => void {\r\n if (!this._options.enabled) {\r\n return () => {};\r\n }\r\n\r\n return domain.addActionListener((update) => {\r\n const { runningAction, type, time } = update;\r\n const actionPath = [...runningAction.allDomains, runningAction.id].join(\".\");\r\n\r\n if (type === ERunningActionUpdateType.started) {\r\n this._inFlight.set(runningAction.cuid, { startTime: time });\r\n this._log(\"started\", actionPath, runningAction.cuid, {\r\n ...(this._options.logPayloads ? { input: runningAction.state?.request?.input } : {}),\r\n });\r\n } else if (type === ERunningActionUpdateType.progress) {\r\n this._log(\"progress\", actionPath, runningAction.cuid, { progress: update.progress });\r\n } else if (type === ERunningActionUpdateType.finished) {\r\n const timing = this._inFlight.get(runningAction.cuid);\r\n const duration = timing != null ? time - timing.startTime : undefined;\r\n this._inFlight.delete(runningAction.cuid);\r\n\r\n const finishType: string = update.finishType;\r\n\r\n if (finishType === ERunningActionFinishedType.success) {\r\n const result = update.response?.result;\r\n if (result != null && !result.ok) {\r\n this._log(\"action-error\", actionPath, runningAction.cuid, {\r\n ...(duration != null ? { duration: `${duration}ms` } : {}),\r\n error: serializeError(result.error),\r\n });\r\n } else {\r\n this._log(\"success\", actionPath, runningAction.cuid, {\r\n ...(duration != null ? { duration: `${duration}ms` } : {}),\r\n ...(this._options.logPayloads ? { output: result?.output } : {}),\r\n });\r\n }\r\n } else if (finishType === ERunningActionFinishedType.failed) {\r\n this._log(\"failed\", actionPath, runningAction.cuid, {\r\n ...(duration != null ? { duration: `${duration}ms` } : {}),\r\n error: serializeError(update.error),\r\n });\r\n } else {\r\n this._log(\"aborted\", actionPath, runningAction.cuid, {\r\n ...(duration != null ? { duration: `${duration}ms` } : {}),\r\n ...(update.reason != null ? { reason: String(update.reason) } : {}),\r\n });\r\n }\r\n }\r\n });\r\n }\r\n\r\n private _log(\r\n event: string,\r\n actionPath: string,\r\n cuid: string,\r\n data: Record<string, unknown>,\r\n ): void {\r\n const { logger, format } = this._options;\r\n\r\n if (format === \"json\") {\r\n logger(\r\n JSON.stringify({\r\n time: new Date().toISOString(),\r\n event,\r\n action: actionPath,\r\n cuid,\r\n ...data,\r\n }),\r\n );\r\n return;\r\n }\r\n\r\n const prefix = PRETTY_PREFIX[event] ?? `[${event}]`;\r\n const suffix = Object.keys(data).length > 0 ? ` ${formatPrettyData(data)}` : \"\";\r\n logger(`${prefix} ${actionPath} cuid=${cuid}${suffix}`);\r\n }\r\n}\r\n\r\nconst PRETTY_PREFIX: Record<string, string> = {\r\n started: \"[nice-action] ►\",\r\n progress: \"[nice-action] \",\r\n success: \"[nice-action] ✓\",\r\n failed: \"[nice-action] ✗\",\r\n aborted: \"[nice-action] ○\",\r\n};\r\n\r\nfunction formatPrettyData(data: Record<string, unknown>): string {\r\n return Object.entries(data)\r\n .map(([k, v]) => `${k}=${safeStringify(v)}`)\r\n .join(\" \");\r\n}\r\n\r\nfunction safeStringify(value: unknown): string {\r\n if (value === undefined) return \"undefined\";\r\n if (value === null) return \"null\";\r\n if (typeof value === \"string\") return `\"${value}\"`;\r\n try {\r\n return JSON.stringify(value);\r\n } catch {\r\n return String(value);\r\n }\r\n}\r\n\r\nfunction serializeError(err: unknown): unknown {\r\n if (err == null) return err;\r\n if (err instanceof Error) return { message: err.message, name: err.name, stack: err.stack };\r\n if (typeof err === \"object\") {\r\n try {\r\n return JSON.parse(JSON.stringify(err));\r\n } catch {\r\n return String(err);\r\n }\r\n }\r\n return err;\r\n}\r\n\r\nfunction defaultConsoleLogger(message: string): void {\r\n console.log(message);\r\n}\r\n"],"mappings":";;;AAkCA,IAAa,uBAAb,MAAkC;CAChC;CACA,4BAA0D,IAAI,IAAI;CAElE,YAAY,UAAwC,CAAC,GAAG;EACtD,MAAM,iBACJ,OAAO,YAAY,cAAc,QAA8C;EAEjF,KAAK,WAAW;GACd,QAAQ,QAAQ,UAAU;GAC1B,QAAQ,QAAQ,UAAU;GAC1B,aAAa,QAAQ,eAAe;GACpC,SAAS,QAAQ,WAAW;EAC9B;CACF;CAEA,eAAe,QAA+C;EAC5D,IAAI,CAAC,KAAK,SAAS,SACjB,aAAa,CAAC;EAGhB,OAAO,OAAO,mBAAmB,WAAW;GAC1C,MAAM,EAAE,eAAe,MAAM,SAAS;GACtC,MAAM,aAAa,CAAC,GAAG,cAAc,YAAY,cAAc,EAAE,CAAC,CAAC,KAAK,GAAG;GAE3E,IAAI,SAAA,WAA2C;IAC7C,KAAK,UAAU,IAAI,cAAc,MAAM,EAAE,WAAW,KAAK,CAAC;IAC1D,KAAK,KAAK,WAAW,YAAY,cAAc,MAAM,EACnD,GAAI,KAAK,SAAS,cAAc,EAAE,OAAO,cAAc,OAAO,SAAS,MAAM,IAAI,CAAC,EACpF,CAAC;GACH,OAAO,IAAI,SAAA,YACT,KAAK,KAAK,YAAY,YAAY,cAAc,MAAM,EAAE,UAAU,OAAO,SAAS,CAAC;QAC9E,IAAI,SAAA,YAA4C;IACrD,MAAM,SAAS,KAAK,UAAU,IAAI,cAAc,IAAI;IACpD,MAAM,WAAW,UAAU,OAAO,OAAO,OAAO,YAAY,KAAA;IAC5D,KAAK,UAAU,OAAO,cAAc,IAAI;IAExC,MAAM,aAAqB,OAAO;IAElC,IAAI,eAAA,WAAmD;KACrD,MAAM,SAAS,OAAO,UAAU;KAChC,IAAI,UAAU,QAAQ,CAAC,OAAO,IAC5B,KAAK,KAAK,gBAAgB,YAAY,cAAc,MAAM;MACxD,GAAI,YAAY,OAAO,EAAE,UAAU,GAAG,SAAS,IAAI,IAAI,CAAC;MACxD,OAAO,eAAe,OAAO,KAAK;KACpC,CAAC;UAED,KAAK,KAAK,WAAW,YAAY,cAAc,MAAM;MACnD,GAAI,YAAY,OAAO,EAAE,UAAU,GAAG,SAAS,IAAI,IAAI,CAAC;MACxD,GAAI,KAAK,SAAS,cAAc,EAAE,QAAQ,QAAQ,OAAO,IAAI,CAAC;KAChE,CAAC;IAEL,OAAO,IAAI,eAAA,UACT,KAAK,KAAK,UAAU,YAAY,cAAc,MAAM;KAClD,GAAI,YAAY,OAAO,EAAE,UAAU,GAAG,SAAS,IAAI,IAAI,CAAC;KACxD,OAAO,eAAe,OAAO,KAAK;IACpC,CAAC;SAED,KAAK,KAAK,WAAW,YAAY,cAAc,MAAM;KACnD,GAAI,YAAY,OAAO,EAAE,UAAU,GAAG,SAAS,IAAI,IAAI,CAAC;KACxD,GAAI,OAAO,UAAU,OAAO,EAAE,QAAQ,OAAO,OAAO,MAAM,EAAE,IAAI,CAAC;IACnE,CAAC;GAEL;EACF,CAAC;CACH;CAEA,KACE,OACA,YACA,MACA,MACM;EACN,MAAM,EAAE,QAAQ,WAAW,KAAK;EAEhC,IAAI,WAAW,QAAQ;GACrB,OACE,KAAK,UAAU;IACb,uBAAM,IAAI,KAAK,EAAA,CAAE,YAAY;IAC7B;IACA,QAAQ;IACR;IACA,GAAG;GACL,CAAC,CACH;GACA;EACF;EAIA,OAAO,GAFQ,cAAc,UAAU,IAAI,MAAM,GAEhC,GAAG,WAAW,SAAS,OADzB,OAAO,KAAK,IAAI,CAAC,CAAC,SAAS,IAAI,KAAK,iBAAiB,IAAI,MAAM,IACvB;CACzD;AACF;AAEA,MAAM,gBAAwC;CAC5C,SAAS;CACT,UAAU;CACV,SAAS;CACT,QAAQ;CACR,SAAS;AACX;AAEA,SAAS,iBAAiB,MAAuC;CAC/D,OAAO,OAAO,QAAQ,IAAI,CAAC,CACxB,KAAK,CAAC,GAAG,OAAO,GAAG,EAAE,GAAG,cAAc,CAAC,GAAG,CAAC,CAC3C,KAAK,GAAG;AACb;AAEA,SAAS,cAAc,OAAwB;CAC7C,IAAI,UAAU,KAAA,GAAW,OAAO;CAChC,IAAI,UAAU,MAAM,OAAO;CAC3B,IAAI,OAAO,UAAU,UAAU,OAAO,IAAI,MAAM;CAChD,IAAI;EACF,OAAO,KAAK,UAAU,KAAK;CAC7B,QAAQ;EACN,OAAO,OAAO,KAAK;CACrB;AACF;AAEA,SAAS,eAAe,KAAuB;CAC7C,IAAI,OAAO,MAAM,OAAO;CACxB,IAAI,eAAe,OAAO,OAAO;EAAE,SAAS,IAAI;EAAS,MAAM,IAAI;EAAM,OAAO,IAAI;CAAM;CAC1F,IAAI,OAAO,QAAQ,UACjB,IAAI;EACF,OAAO,KAAK,MAAM,KAAK,UAAU,GAAG,CAAC;CACvC,QAAQ;EACN,OAAO,OAAO,GAAG;CACnB;CAEF,OAAO;AACT;AAEA,SAAS,qBAAqB,SAAuB;CACnD,QAAQ,IAAI,OAAO;AACrB"}
|