@contractspec/lib.personalization 0.0.0-canary-20260113162409
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/LICENSE +21 -0
- package/README.md +30 -0
- package/dist/adapter.d.ts +22 -0
- package/dist/adapter.d.ts.map +1 -0
- package/dist/adapter.js +42 -0
- package/dist/adapter.js.map +1 -0
- package/dist/analyzer.d.ts +23 -0
- package/dist/analyzer.d.ts.map +1 -0
- package/dist/analyzer.js +55 -0
- package/dist/analyzer.js.map +1 -0
- package/dist/docs/behavior-tracking.docblock.d.ts +7 -0
- package/dist/docs/behavior-tracking.docblock.d.ts.map +1 -0
- package/dist/docs/behavior-tracking.docblock.js +18 -0
- package/dist/docs/behavior-tracking.docblock.js.map +1 -0
- package/dist/docs/index.d.ts +3 -0
- package/dist/docs/index.js +3 -0
- package/dist/docs/overlay-engine.docblock.d.ts +7 -0
- package/dist/docs/overlay-engine.docblock.d.ts.map +1 -0
- package/dist/docs/overlay-engine.docblock.js +18 -0
- package/dist/docs/overlay-engine.docblock.js.map +1 -0
- package/dist/docs/workflow-composition.docblock.d.ts +7 -0
- package/dist/docs/workflow-composition.docblock.d.ts.map +1 -0
- package/dist/docs/workflow-composition.docblock.js +18 -0
- package/dist/docs/workflow-composition.docblock.js.map +1 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.js +7 -0
- package/dist/store.d.ts +21 -0
- package/dist/store.d.ts.map +1 -0
- package/dist/store.js +59 -0
- package/dist/store.js.map +1 -0
- package/dist/tracker.d.ts +53 -0
- package/dist/tracker.d.ts.map +1 -0
- package/dist/tracker.js +93 -0
- package/dist/tracker.js.map +1 -0
- package/dist/types.d.ts +59 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +0 -0
- package/package.json +86 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Chaman Ventures, SASU
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# @contractspec/lib.personalization
|
|
2
|
+
|
|
3
|
+
Website: https://contractspec.io/
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
Composable behavior tracking and personalization primitives for ContractSpec applications. The library provides trackers that capture feature usage, analyzers that transform raw events into adaptation hints, and adapters that feed personalized overlays or workflow tweaks.
|
|
7
|
+
|
|
8
|
+
## Modules
|
|
9
|
+
|
|
10
|
+
- `tracker` – lightweight tracker helpers that record field/feature/workflow usage.
|
|
11
|
+
- `store` – store abstractions plus an in-memory implementation.
|
|
12
|
+
- `analyzer` – stateless analyzers that convert usage data into insights.
|
|
13
|
+
- `adapter` – bridges insights into OverlaySpecs or WorkflowComposer extensions.
|
|
14
|
+
|
|
15
|
+
See `docs/tech/personalization/behavior-tracking.md` for full usage notes.
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { BehaviorInsights } from "./types.js";
|
|
2
|
+
import { OverlaySpec } from "@contractspec/lib.overlay-engine";
|
|
3
|
+
|
|
4
|
+
//#region src/adapter.d.ts
|
|
5
|
+
interface OverlaySuggestionOptions {
|
|
6
|
+
overlayId: string;
|
|
7
|
+
tenantId: string;
|
|
8
|
+
capability: string;
|
|
9
|
+
userId?: string;
|
|
10
|
+
role?: string;
|
|
11
|
+
version?: string;
|
|
12
|
+
}
|
|
13
|
+
interface WorkflowAdaptation {
|
|
14
|
+
workflow: string;
|
|
15
|
+
step: string;
|
|
16
|
+
note: string;
|
|
17
|
+
}
|
|
18
|
+
declare function insightsToOverlaySuggestion(insights: BehaviorInsights, options: OverlaySuggestionOptions): OverlaySpec | null;
|
|
19
|
+
declare function insightsToWorkflowAdaptations(insights: BehaviorInsights): WorkflowAdaptation[];
|
|
20
|
+
//#endregion
|
|
21
|
+
export { OverlaySuggestionOptions, WorkflowAdaptation, insightsToOverlaySuggestion, insightsToWorkflowAdaptations };
|
|
22
|
+
//# sourceMappingURL=adapter.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"adapter.d.ts","names":[],"sources":["../src/adapter.ts"],"sourcesContent":[],"mappings":";;;;UAMiB,wBAAA;;EAAA,QAAA,EAAA,MAAA;EASA,UAAA,EAAA,MAAA;EAMD,MAAA,CAAA,EAAA,MAAA;EACJ,IAAA,CAAA,EAAA,MAAA;EACD,OAAA,CAAA,EAAA,MAAA;;AACG,UATG,kBAAA,CASH;EAuCE,QAAA,EAAA,MAAA;;;;iBA1CA,2BAAA,WACJ,2BACD,2BACR;iBAuCa,6BAAA,WACJ,mBACT"}
|
package/dist/adapter.js
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
//#region src/adapter.ts
|
|
2
|
+
function insightsToOverlaySuggestion(insights, options) {
|
|
3
|
+
const modifications = [];
|
|
4
|
+
insights.suggestedHiddenFields.forEach((field) => {
|
|
5
|
+
modifications.push({
|
|
6
|
+
type: "hideField",
|
|
7
|
+
field,
|
|
8
|
+
reason: "Automatically hidden because usage is near zero"
|
|
9
|
+
});
|
|
10
|
+
});
|
|
11
|
+
if (insights.frequentlyUsedFields.length) modifications.push({
|
|
12
|
+
type: "reorderFields",
|
|
13
|
+
fields: insights.frequentlyUsedFields
|
|
14
|
+
});
|
|
15
|
+
if (!modifications.length) return null;
|
|
16
|
+
return {
|
|
17
|
+
overlayId: options.overlayId,
|
|
18
|
+
version: options.version ?? "1.0.0",
|
|
19
|
+
appliesTo: {
|
|
20
|
+
tenantId: options.tenantId,
|
|
21
|
+
capability: options.capability,
|
|
22
|
+
userId: options.userId,
|
|
23
|
+
role: options.role
|
|
24
|
+
},
|
|
25
|
+
modifications,
|
|
26
|
+
metadata: {
|
|
27
|
+
generatedAt: (/* @__PURE__ */ new Date()).toISOString(),
|
|
28
|
+
automated: true
|
|
29
|
+
}
|
|
30
|
+
};
|
|
31
|
+
}
|
|
32
|
+
function insightsToWorkflowAdaptations(insights) {
|
|
33
|
+
return insights.workflowBottlenecks.map((bottleneck) => ({
|
|
34
|
+
workflow: bottleneck.workflow,
|
|
35
|
+
step: bottleneck.step,
|
|
36
|
+
note: `High drop rate (${Math.round(bottleneck.dropRate * 100)}%) detected`
|
|
37
|
+
}));
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
//#endregion
|
|
41
|
+
export { insightsToOverlaySuggestion, insightsToWorkflowAdaptations };
|
|
42
|
+
//# sourceMappingURL=adapter.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"adapter.js","names":[],"sources":["../src/adapter.ts"],"sourcesContent":["import type {\n OverlayModification,\n OverlaySpec,\n} from '@contractspec/lib.overlay-engine';\nimport type { BehaviorInsights } from './types';\n\nexport interface OverlaySuggestionOptions {\n overlayId: string;\n tenantId: string;\n capability: string;\n userId?: string;\n role?: string;\n version?: string;\n}\n\nexport interface WorkflowAdaptation {\n workflow: string;\n step: string;\n note: string;\n}\n\nexport function insightsToOverlaySuggestion(\n insights: BehaviorInsights,\n options: OverlaySuggestionOptions\n): OverlaySpec | null {\n const modifications: OverlayModification[] = [];\n\n insights.suggestedHiddenFields.forEach((field) => {\n modifications.push({\n type: 'hideField',\n field,\n reason: 'Automatically hidden because usage is near zero',\n });\n });\n\n if (insights.frequentlyUsedFields.length) {\n modifications.push({\n type: 'reorderFields',\n fields: insights.frequentlyUsedFields,\n });\n }\n\n if (!modifications.length) {\n return null;\n }\n\n return {\n overlayId: options.overlayId,\n version: options.version ?? '1.0.0',\n appliesTo: {\n tenantId: options.tenantId,\n capability: options.capability,\n userId: options.userId,\n role: options.role,\n },\n modifications,\n metadata: {\n generatedAt: new Date().toISOString(),\n automated: true,\n },\n };\n}\n\nexport function insightsToWorkflowAdaptations(\n insights: BehaviorInsights\n): WorkflowAdaptation[] {\n return insights.workflowBottlenecks.map((bottleneck) => ({\n workflow: bottleneck.workflow,\n step: bottleneck.step,\n note: `High drop rate (${Math.round(bottleneck.dropRate * 100)}%) detected`,\n }));\n}\n"],"mappings":";AAqBA,SAAgB,4BACd,UACA,SACoB;CACpB,MAAM,gBAAuC,EAAE;AAE/C,UAAS,sBAAsB,SAAS,UAAU;AAChD,gBAAc,KAAK;GACjB,MAAM;GACN;GACA,QAAQ;GACT,CAAC;GACF;AAEF,KAAI,SAAS,qBAAqB,OAChC,eAAc,KAAK;EACjB,MAAM;EACN,QAAQ,SAAS;EAClB,CAAC;AAGJ,KAAI,CAAC,cAAc,OACjB,QAAO;AAGT,QAAO;EACL,WAAW,QAAQ;EACnB,SAAS,QAAQ,WAAW;EAC5B,WAAW;GACT,UAAU,QAAQ;GAClB,YAAY,QAAQ;GACpB,QAAQ,QAAQ;GAChB,MAAM,QAAQ;GACf;EACD;EACA,UAAU;GACR,8BAAa,IAAI,MAAM,EAAC,aAAa;GACrC,WAAW;GACZ;EACF;;AAGH,SAAgB,8BACd,UACsB;AACtB,QAAO,SAAS,oBAAoB,KAAK,gBAAgB;EACvD,UAAU,WAAW;EACrB,MAAM,WAAW;EACjB,MAAM,mBAAmB,KAAK,MAAM,WAAW,WAAW,IAAI,CAAC;EAChE,EAAE"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { BehaviorInsights } from "./types.js";
|
|
2
|
+
import { BehaviorStore } from "./store.js";
|
|
3
|
+
|
|
4
|
+
//#region src/analyzer.d.ts
|
|
5
|
+
interface BehaviorAnalyzerOptions {
|
|
6
|
+
fieldInactivityThreshold?: number;
|
|
7
|
+
minSamples?: number;
|
|
8
|
+
}
|
|
9
|
+
interface AnalyzeParams {
|
|
10
|
+
tenantId: string;
|
|
11
|
+
userId?: string;
|
|
12
|
+
role?: string;
|
|
13
|
+
windowMs?: number;
|
|
14
|
+
}
|
|
15
|
+
declare class BehaviorAnalyzer {
|
|
16
|
+
private readonly store;
|
|
17
|
+
private readonly options;
|
|
18
|
+
constructor(store: BehaviorStore, options?: BehaviorAnalyzerOptions);
|
|
19
|
+
analyze(params: AnalyzeParams): Promise<BehaviorInsights>;
|
|
20
|
+
}
|
|
21
|
+
//#endregion
|
|
22
|
+
export { AnalyzeParams, BehaviorAnalyzer, BehaviorAnalyzerOptions };
|
|
23
|
+
//# sourceMappingURL=analyzer.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"analyzer.d.ts","names":[],"sources":["../src/analyzer.ts"],"sourcesContent":[],"mappings":";;;;UAGiB,uBAAA;;EAAA,UAAA,CAAA,EAAA,MAAA;AAKjB;AASa,UATI,aAAA,CASY;EAED,QAAA,EAAA,MAAA;EACE,MAAA,CAAA,EAAA,MAAA;EAGN,IAAA,CAAA,EAAA,MAAA;EAAwB,QAAA,CAAA,EAAA,MAAA;;AAAD,cANlC,gBAAA,CAMkC;;;qBAJnB,yBACE;kBAGN,gBAAgB,QAAQ"}
|
package/dist/analyzer.js
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
//#region src/analyzer.ts
|
|
2
|
+
const DEFAULT_THRESHOLD = 3;
|
|
3
|
+
var BehaviorAnalyzer = class {
|
|
4
|
+
constructor(store, options = {}) {
|
|
5
|
+
this.store = store;
|
|
6
|
+
this.options = options;
|
|
7
|
+
}
|
|
8
|
+
async analyze(params) {
|
|
9
|
+
const query = {
|
|
10
|
+
tenantId: params.tenantId,
|
|
11
|
+
userId: params.userId,
|
|
12
|
+
role: params.role
|
|
13
|
+
};
|
|
14
|
+
if (params.windowMs) query.since = Date.now() - params.windowMs;
|
|
15
|
+
return buildInsights(await this.store.summarize(query), this.options);
|
|
16
|
+
}
|
|
17
|
+
};
|
|
18
|
+
function buildInsights(summary, options) {
|
|
19
|
+
const threshold = options.fieldInactivityThreshold ?? DEFAULT_THRESHOLD;
|
|
20
|
+
const minSamples = options.minSamples ?? 10;
|
|
21
|
+
const ignoredFields = [];
|
|
22
|
+
const frequentlyUsedFields = [];
|
|
23
|
+
for (const [field, count] of Object.entries(summary.fieldCounts)) {
|
|
24
|
+
if (count <= threshold) ignoredFields.push(field);
|
|
25
|
+
if (count >= threshold * 4) frequentlyUsedFields.push(field);
|
|
26
|
+
}
|
|
27
|
+
const workflowBottlenecks = Object.entries(summary.workflowStepCounts).flatMap(([workflow, steps]) => {
|
|
28
|
+
const total = Object.values(steps).reduce((acc, value) => acc + value, 0);
|
|
29
|
+
if (!total || total < minSamples) return [];
|
|
30
|
+
return Object.entries(steps).filter(([, count]) => count / total < .4).map(([step, count]) => ({
|
|
31
|
+
workflow,
|
|
32
|
+
step,
|
|
33
|
+
dropRate: 1 - count / total
|
|
34
|
+
}));
|
|
35
|
+
});
|
|
36
|
+
const layoutPreference = detectLayout(summary);
|
|
37
|
+
return {
|
|
38
|
+
unusedFields: ignoredFields,
|
|
39
|
+
suggestedHiddenFields: ignoredFields.slice(0, 5),
|
|
40
|
+
frequentlyUsedFields: frequentlyUsedFields.slice(0, 10),
|
|
41
|
+
workflowBottlenecks,
|
|
42
|
+
layoutPreference
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
function detectLayout(summary) {
|
|
46
|
+
const fieldCount = Object.keys(summary.fieldCounts).length;
|
|
47
|
+
if (!fieldCount) return;
|
|
48
|
+
if (fieldCount >= 15) return "table";
|
|
49
|
+
if (fieldCount >= 8) return "grid";
|
|
50
|
+
return "form";
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
//#endregion
|
|
54
|
+
export { BehaviorAnalyzer };
|
|
55
|
+
//# sourceMappingURL=analyzer.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"analyzer.js","names":[],"sources":["../src/analyzer.ts"],"sourcesContent":["import type { BehaviorStore } from './store';\nimport type { BehaviorInsights, BehaviorQuery, BehaviorSummary } from './types';\n\nexport interface BehaviorAnalyzerOptions {\n fieldInactivityThreshold?: number;\n minSamples?: number;\n}\n\nexport interface AnalyzeParams {\n tenantId: string;\n userId?: string;\n role?: string;\n windowMs?: number;\n}\n\nconst DEFAULT_THRESHOLD = 3;\n\nexport class BehaviorAnalyzer {\n constructor(\n private readonly store: BehaviorStore,\n private readonly options: BehaviorAnalyzerOptions = {}\n ) {}\n\n async analyze(params: AnalyzeParams): Promise<BehaviorInsights> {\n const query: BehaviorQuery = {\n tenantId: params.tenantId,\n userId: params.userId,\n role: params.role,\n };\n\n if (params.windowMs) {\n query.since = Date.now() - params.windowMs;\n }\n\n const summary = await this.store.summarize(query);\n return buildInsights(summary, this.options);\n }\n}\n\nfunction buildInsights(\n summary: BehaviorSummary,\n options: BehaviorAnalyzerOptions\n): BehaviorInsights {\n const threshold = options.fieldInactivityThreshold ?? DEFAULT_THRESHOLD;\n const minSamples = options.minSamples ?? 10;\n\n const ignoredFields: string[] = [];\n const frequentlyUsedFields: string[] = [];\n\n for (const [field, count] of Object.entries(summary.fieldCounts)) {\n if (count <= threshold) {\n ignoredFields.push(field);\n }\n if (count >= threshold * 4) {\n frequentlyUsedFields.push(field);\n }\n }\n\n const workflowBottlenecks = Object.entries(\n summary.workflowStepCounts\n ).flatMap(([workflow, steps]) => {\n const total = Object.values(steps).reduce((acc, value) => acc + value, 0);\n if (!total || total < minSamples) {\n return [];\n }\n return Object.entries(steps)\n .filter(([, count]) => count / total < 0.4)\n .map(([step, count]) => ({\n workflow,\n step,\n dropRate: 1 - count / total,\n }));\n });\n\n const layoutPreference = detectLayout(summary);\n\n return {\n unusedFields: ignoredFields,\n suggestedHiddenFields: ignoredFields.slice(0, 5),\n frequentlyUsedFields: frequentlyUsedFields.slice(0, 10),\n workflowBottlenecks,\n layoutPreference,\n };\n}\n\nfunction detectLayout(\n summary: BehaviorSummary\n): BehaviorInsights['layoutPreference'] {\n const fieldCount = Object.keys(summary.fieldCounts).length;\n if (!fieldCount) {\n return undefined;\n }\n\n if (fieldCount >= 15) {\n return 'table';\n }\n if (fieldCount >= 8) {\n return 'grid';\n }\n return 'form';\n}\n"],"mappings":";AAeA,MAAM,oBAAoB;AAE1B,IAAa,mBAAb,MAA8B;CAC5B,YACE,AAAiB,OACjB,AAAiB,UAAmC,EAAE,EACtD;EAFiB;EACA;;CAGnB,MAAM,QAAQ,QAAkD;EAC9D,MAAM,QAAuB;GAC3B,UAAU,OAAO;GACjB,QAAQ,OAAO;GACf,MAAM,OAAO;GACd;AAED,MAAI,OAAO,SACT,OAAM,QAAQ,KAAK,KAAK,GAAG,OAAO;AAIpC,SAAO,cADS,MAAM,KAAK,MAAM,UAAU,MAAM,EACnB,KAAK,QAAQ;;;AAI/C,SAAS,cACP,SACA,SACkB;CAClB,MAAM,YAAY,QAAQ,4BAA4B;CACtD,MAAM,aAAa,QAAQ,cAAc;CAEzC,MAAM,gBAA0B,EAAE;CAClC,MAAM,uBAAiC,EAAE;AAEzC,MAAK,MAAM,CAAC,OAAO,UAAU,OAAO,QAAQ,QAAQ,YAAY,EAAE;AAChE,MAAI,SAAS,UACX,eAAc,KAAK,MAAM;AAE3B,MAAI,SAAS,YAAY,EACvB,sBAAqB,KAAK,MAAM;;CAIpC,MAAM,sBAAsB,OAAO,QACjC,QAAQ,mBACT,CAAC,SAAS,CAAC,UAAU,WAAW;EAC/B,MAAM,QAAQ,OAAO,OAAO,MAAM,CAAC,QAAQ,KAAK,UAAU,MAAM,OAAO,EAAE;AACzE,MAAI,CAAC,SAAS,QAAQ,WACpB,QAAO,EAAE;AAEX,SAAO,OAAO,QAAQ,MAAM,CACzB,QAAQ,GAAG,WAAW,QAAQ,QAAQ,GAAI,CAC1C,KAAK,CAAC,MAAM,YAAY;GACvB;GACA;GACA,UAAU,IAAI,QAAQ;GACvB,EAAE;GACL;CAEF,MAAM,mBAAmB,aAAa,QAAQ;AAE9C,QAAO;EACL,cAAc;EACd,uBAAuB,cAAc,MAAM,GAAG,EAAE;EAChD,sBAAsB,qBAAqB,MAAM,GAAG,GAAG;EACvD;EACA;EACD;;AAGH,SAAS,aACP,SACsC;CACtC,MAAM,aAAa,OAAO,KAAK,QAAQ,YAAY,CAAC;AACpD,KAAI,CAAC,WACH;AAGF,KAAI,cAAc,GAChB,QAAO;AAET,KAAI,cAAc,EAChB,QAAO;AAET,QAAO"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { DocBlock } from "@contractspec/lib.contracts/docs";
|
|
2
|
+
|
|
3
|
+
//#region src/docs/behavior-tracking.docblock.d.ts
|
|
4
|
+
declare const personalization_behavior_tracking_DocBlocks: DocBlock[];
|
|
5
|
+
//#endregion
|
|
6
|
+
export { personalization_behavior_tracking_DocBlocks };
|
|
7
|
+
//# sourceMappingURL=behavior-tracking.docblock.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"behavior-tracking.docblock.d.ts","names":[],"sources":["../../src/docs/behavior-tracking.docblock.ts"],"sourcesContent":[],"mappings":";;;cAGa,6CAA6C"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
|
|
2
|
+
|
|
3
|
+
//#region src/docs/behavior-tracking.docblock.ts
|
|
4
|
+
const personalization_behavior_tracking_DocBlocks = [{
|
|
5
|
+
id: "docs.personalization.behavior-tracking",
|
|
6
|
+
title: "Behavior Tracking",
|
|
7
|
+
summary: "`@contractspec/lib.personalization` provides primitives to observe how tenants/users interact with specs and turn that telemetry into personalization insights.",
|
|
8
|
+
kind: "reference",
|
|
9
|
+
visibility: "public",
|
|
10
|
+
route: "/docs/personalization/behavior-tracking",
|
|
11
|
+
tags: ["personalization", "behavior-tracking"],
|
|
12
|
+
body: "# Behavior Tracking\n\n`@contractspec/lib.personalization` provides primitives to observe how tenants/users interact with specs and turn that telemetry into personalization insights.\n\n## Tracker\n\n```ts\nimport { createBehaviorTracker } from '@contractspec/lib.personalization';\nimport { InMemoryBehaviorStore } from '@contractspec/lib.personalization/store';\n\nconst tracker = createBehaviorTracker({\n store: new InMemoryBehaviorStore(),\n context: { tenantId: ctx.tenant.id, userId: ctx.identity.userId },\n autoFlushIntervalMs: 5000,\n});\n\ntracker.trackFieldAccess({ operation: 'billing.createOrder', field: 'internalNotes' });\ntracker.trackFeatureUsage({ feature: 'workflow-editor', action: 'opened' });\ntracker.trackWorkflowStep({ workflow: 'invoice-approval', step: 'review', status: 'entered' });\n```\n\nAll events are buffered and flushed either when the buffer hits 25 entries or when `autoFlushIntervalMs` elapses. Tracked metrics flow to OpenTelemetry via the meter/counter built into the tracker.\n\n## Analyzer\n\n```ts\nimport { BehaviorAnalyzer } from '@contractspec/lib.personalization/analyzer';\n\nconst analyzer = new BehaviorAnalyzer(store, { fieldInactivityThreshold: 2 });\nconst insights = await analyzer.analyze({ tenantId: 'acme', userId: 'manager-42', windowMs: 7 * 24 * 60 * 60 * 1000 });\n\n/*\n{\n unusedFields: ['internalNotes'],\n suggestedHiddenFields: ['internalNotes'],\n frequentlyUsedFields: ['customerReference', 'items'],\n workflowBottlenecks: [{ workflow: 'invoice-approval', step: 'finance-review', dropRate: 0.6 }],\n layoutPreference: 'table'\n}\n*/\n```\n\nUse the analyzer output with the overlay adapter to generate suggestions automatically.\n\n## Adapter\n\n```ts\nimport { insightsToOverlaySuggestion } from '@contractspec/lib.personalization/adapter';\n\nconst overlay = insightsToOverlaySuggestion(insights, {\n overlayId: 'acme-order-form',\n tenantId: 'acme',\n capability: 'billing.createOrder',\n});\n```\n\nWhen the adapter returns an overlay spec, pass it to the overlay engine to register or sign it.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"
|
|
13
|
+
}];
|
|
14
|
+
registerDocBlocks(personalization_behavior_tracking_DocBlocks);
|
|
15
|
+
|
|
16
|
+
//#endregion
|
|
17
|
+
export { personalization_behavior_tracking_DocBlocks };
|
|
18
|
+
//# sourceMappingURL=behavior-tracking.docblock.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"behavior-tracking.docblock.js","names":[],"sources":["../../src/docs/behavior-tracking.docblock.ts"],"sourcesContent":["import type { DocBlock } from '@contractspec/lib.contracts/docs';\nimport { registerDocBlocks } from '@contractspec/lib.contracts/docs';\n\nexport const personalization_behavior_tracking_DocBlocks: DocBlock[] = [\n {\n id: 'docs.personalization.behavior-tracking',\n title: 'Behavior Tracking',\n summary:\n '`@contractspec/lib.personalization` provides primitives to observe how tenants/users interact with specs and turn that telemetry into personalization insights.',\n kind: 'reference',\n visibility: 'public',\n route: '/docs/personalization/behavior-tracking',\n tags: ['personalization', 'behavior-tracking'],\n body: \"# Behavior Tracking\\n\\n`@contractspec/lib.personalization` provides primitives to observe how tenants/users interact with specs and turn that telemetry into personalization insights.\\n\\n## Tracker\\n\\n```ts\\nimport { createBehaviorTracker } from '@contractspec/lib.personalization';\\nimport { InMemoryBehaviorStore } from '@contractspec/lib.personalization/store';\\n\\nconst tracker = createBehaviorTracker({\\n store: new InMemoryBehaviorStore(),\\n context: { tenantId: ctx.tenant.id, userId: ctx.identity.userId },\\n autoFlushIntervalMs: 5000,\\n});\\n\\ntracker.trackFieldAccess({ operation: 'billing.createOrder', field: 'internalNotes' });\\ntracker.trackFeatureUsage({ feature: 'workflow-editor', action: 'opened' });\\ntracker.trackWorkflowStep({ workflow: 'invoice-approval', step: 'review', status: 'entered' });\\n```\\n\\nAll events are buffered and flushed either when the buffer hits 25 entries or when `autoFlushIntervalMs` elapses. Tracked metrics flow to OpenTelemetry via the meter/counter built into the tracker.\\n\\n## Analyzer\\n\\n```ts\\nimport { BehaviorAnalyzer } from '@contractspec/lib.personalization/analyzer';\\n\\nconst analyzer = new BehaviorAnalyzer(store, { fieldInactivityThreshold: 2 });\\nconst insights = await analyzer.analyze({ tenantId: 'acme', userId: 'manager-42', windowMs: 7 * 24 * 60 * 60 * 1000 });\\n\\n/*\\n{\\n unusedFields: ['internalNotes'],\\n suggestedHiddenFields: ['internalNotes'],\\n frequentlyUsedFields: ['customerReference', 'items'],\\n workflowBottlenecks: [{ workflow: 'invoice-approval', step: 'finance-review', dropRate: 0.6 }],\\n layoutPreference: 'table'\\n}\\n*/\\n```\\n\\nUse the analyzer output with the overlay adapter to generate suggestions automatically.\\n\\n## Adapter\\n\\n```ts\\nimport { insightsToOverlaySuggestion } from '@contractspec/lib.personalization/adapter';\\n\\nconst overlay = insightsToOverlaySuggestion(insights, {\\n overlayId: 'acme-order-form',\\n tenantId: 'acme',\\n capability: 'billing.createOrder',\\n});\\n```\\n\\nWhen the adapter returns an overlay spec, pass it to the overlay engine to register or sign it.\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\",\n },\n];\nregisterDocBlocks(personalization_behavior_tracking_DocBlocks);\n"],"mappings":";;;AAGA,MAAa,8CAA0D,CACrE;CACE,IAAI;CACJ,OAAO;CACP,SACE;CACF,MAAM;CACN,YAAY;CACZ,OAAO;CACP,MAAM,CAAC,mBAAmB,oBAAoB;CAC9C,MAAM;CACP,CACF;AACD,kBAAkB,4CAA4C"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { DocBlock } from "@contractspec/lib.contracts/docs";
|
|
2
|
+
|
|
3
|
+
//#region src/docs/overlay-engine.docblock.d.ts
|
|
4
|
+
declare const personalization_overlay_engine_DocBlocks: DocBlock[];
|
|
5
|
+
//#endregion
|
|
6
|
+
export { personalization_overlay_engine_DocBlocks };
|
|
7
|
+
//# sourceMappingURL=overlay-engine.docblock.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"overlay-engine.docblock.d.ts","names":[],"sources":["../../src/docs/overlay-engine.docblock.ts"],"sourcesContent":[],"mappings":";;;cAGa,0CAA0C"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
|
|
2
|
+
|
|
3
|
+
//#region src/docs/overlay-engine.docblock.ts
|
|
4
|
+
const personalization_overlay_engine_DocBlocks = [{
|
|
5
|
+
id: "docs.personalization.overlay-engine",
|
|
6
|
+
title: "Overlay Engine",
|
|
7
|
+
summary: "`@contractspec/lib.overlay-engine` is the canonical runtime for OverlaySpecs. It validates specs, tracks scope precedence, and exposes hooks for React renderers.",
|
|
8
|
+
kind: "reference",
|
|
9
|
+
visibility: "public",
|
|
10
|
+
route: "/docs/personalization/overlay-engine",
|
|
11
|
+
tags: ["personalization", "overlay-engine"],
|
|
12
|
+
body: "# Overlay Engine\n\n`@contractspec/lib.overlay-engine` is the canonical runtime for OverlaySpecs. It validates specs, tracks scope precedence, and exposes hooks for React renderers.\n\n## Key APIs\n\n- `defineOverlay(spec)` – helper to keep specs typed.\n- `OverlayRegistry` – register signed overlays and retrieve them per context.\n- `OverlayEngine` – apply overlays to renderable targets, emit audit events, and merge modifications deterministically.\n- `signOverlay(spec, privateKey)` – Ed25519/RSA-PSS signer.\n- `verifyOverlaySignature(overlay)` – verify public key signatures.\n- `useOverlay(engine, params)` – client hook that returns `{ target, overlaysApplied }`.\n\n## Scope Precedence\n\nRegistrations are sorted by specificity:\n\n1. Tenant overlays\n2. Role overlays\n3. User overlays\n4. Device overlays\n\nLess specific overlays run first; more specific overlays override later.\n\n## Example\n\n```ts\nconst registry = new OverlayRegistry();\nconst engine = new OverlayEngine({\n registry,\n audit: (event) => auditLogService.record(event),\n});\n\nconst overlay = defineOverlay({\n overlayId: 'acme-order-form',\n version: '1.0.0',\n appliesTo: {\n capability: 'billing.createOrder',\n tenantId: 'acme',\n },\n modifications: [\n { type: 'hideField', field: 'internalNotes' },\n { type: 'renameLabel', field: 'customerReference', newLabel: 'PO Number' },\n ],\n});\n\nconst signedOverlay = await signOverlay(overlay, privateKeyPem);\nregistry.register(signedOverlay);\n\nconst result = engine.apply({\n target: { fields: baseFields },\n capability: 'billing.createOrder',\n tenantId: 'acme',\n userId: 'manager-7',\n});\n```\n\n`result.target.fields` now carries the hidden and renamed outputs ready for rendering.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"
|
|
13
|
+
}];
|
|
14
|
+
registerDocBlocks(personalization_overlay_engine_DocBlocks);
|
|
15
|
+
|
|
16
|
+
//#endregion
|
|
17
|
+
export { personalization_overlay_engine_DocBlocks };
|
|
18
|
+
//# sourceMappingURL=overlay-engine.docblock.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"overlay-engine.docblock.js","names":[],"sources":["../../src/docs/overlay-engine.docblock.ts"],"sourcesContent":["import type { DocBlock } from '@contractspec/lib.contracts/docs';\nimport { registerDocBlocks } from '@contractspec/lib.contracts/docs';\n\nexport const personalization_overlay_engine_DocBlocks: DocBlock[] = [\n {\n id: 'docs.personalization.overlay-engine',\n title: 'Overlay Engine',\n summary:\n '`@contractspec/lib.overlay-engine` is the canonical runtime for OverlaySpecs. It validates specs, tracks scope precedence, and exposes hooks for React renderers.',\n kind: 'reference',\n visibility: 'public',\n route: '/docs/personalization/overlay-engine',\n tags: ['personalization', 'overlay-engine'],\n body: \"# Overlay Engine\\n\\n`@contractspec/lib.overlay-engine` is the canonical runtime for OverlaySpecs. It validates specs, tracks scope precedence, and exposes hooks for React renderers.\\n\\n## Key APIs\\n\\n- `defineOverlay(spec)` \\u2013 helper to keep specs typed.\\n- `OverlayRegistry` \\u2013 register signed overlays and retrieve them per context.\\n- `OverlayEngine` \\u2013 apply overlays to renderable targets, emit audit events, and merge modifications deterministically.\\n- `signOverlay(spec, privateKey)` \\u2013 Ed25519/RSA-PSS signer.\\n- `verifyOverlaySignature(overlay)` \\u2013 verify public key signatures.\\n- `useOverlay(engine, params)` \\u2013 client hook that returns `{ target, overlaysApplied }`.\\n\\n## Scope Precedence\\n\\nRegistrations are sorted by specificity:\\n\\n1. Tenant overlays\\n2. Role overlays\\n3. User overlays\\n4. Device overlays\\n\\nLess specific overlays run first; more specific overlays override later.\\n\\n## Example\\n\\n```ts\\nconst registry = new OverlayRegistry();\\nconst engine = new OverlayEngine({\\n registry,\\n audit: (event) => auditLogService.record(event),\\n});\\n\\nconst overlay = defineOverlay({\\n overlayId: 'acme-order-form',\\n version: '1.0.0',\\n appliesTo: {\\n capability: 'billing.createOrder',\\n tenantId: 'acme',\\n },\\n modifications: [\\n { type: 'hideField', field: 'internalNotes' },\\n { type: 'renameLabel', field: 'customerReference', newLabel: 'PO Number' },\\n ],\\n});\\n\\nconst signedOverlay = await signOverlay(overlay, privateKeyPem);\\nregistry.register(signedOverlay);\\n\\nconst result = engine.apply({\\n target: { fields: baseFields },\\n capability: 'billing.createOrder',\\n tenantId: 'acme',\\n userId: 'manager-7',\\n});\\n```\\n\\n`result.target.fields` now carries the hidden and renamed outputs ready for rendering.\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\",\n },\n];\nregisterDocBlocks(personalization_overlay_engine_DocBlocks);\n"],"mappings":";;;AAGA,MAAa,2CAAuD,CAClE;CACE,IAAI;CACJ,OAAO;CACP,SACE;CACF,MAAM;CACN,YAAY;CACZ,OAAO;CACP,MAAM,CAAC,mBAAmB,iBAAiB;CAC3C,MAAM;CACP,CACF;AACD,kBAAkB,yCAAyC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { DocBlock } from "@contractspec/lib.contracts/docs";
|
|
2
|
+
|
|
3
|
+
//#region src/docs/workflow-composition.docblock.d.ts
|
|
4
|
+
declare const personalization_workflow_composition_DocBlocks: DocBlock[];
|
|
5
|
+
//#endregion
|
|
6
|
+
export { personalization_workflow_composition_DocBlocks };
|
|
7
|
+
//# sourceMappingURL=workflow-composition.docblock.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"workflow-composition.docblock.d.ts","names":[],"sources":["../../src/docs/workflow-composition.docblock.ts"],"sourcesContent":[],"mappings":";;;cAGa,gDAAgD"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
|
|
2
|
+
|
|
3
|
+
//#region src/docs/workflow-composition.docblock.ts
|
|
4
|
+
const personalization_workflow_composition_DocBlocks = [{
|
|
5
|
+
id: "docs.personalization.workflow-composition",
|
|
6
|
+
title: "Workflow Composition",
|
|
7
|
+
summary: "`@contractspec/lib.workflow-composer` composes base WorkflowSpecs with tenant/role/device-specific extensions.",
|
|
8
|
+
kind: "reference",
|
|
9
|
+
visibility: "public",
|
|
10
|
+
route: "/docs/personalization/workflow-composition",
|
|
11
|
+
tags: ["personalization", "workflow-composition"],
|
|
12
|
+
body: "# Workflow Composition\n\n`@contractspec/lib.workflow-composer` composes base WorkflowSpecs with tenant/role/device-specific extensions.\n\n## Extensions\n\n```ts\nimport { WorkflowComposer } from '@contractspec/lib.workflow-composer';\nimport { approvalStepTemplate } from '@contractspec/lib.workflow-composer/templates';\n\nconst composer = new WorkflowComposer();\n\ncomposer.register({\n workflow: 'billing.invoiceApproval',\n tenantId: 'acme',\n priority: 10,\n customSteps: [\n {\n after: 'validate-invoice',\n inject: approvalStepTemplate({\n id: 'acme-legal-review',\n label: 'Legal Review (ACME)',\n description: 'Tenant-specific compliance step.',\n }),\n transitionTo: 'final-approval',\n },\n ],\n hiddenSteps: ['internal-audit'],\n});\n```\n\n## Compose\n\n```ts\nconst runtimeSpec = composer.compose({\n base: BaseInvoiceWorkflow,\n tenantId: 'acme',\n});\n\nworkflowRunner.execute(runtimeSpec, ctx);\n```\n\nThe composer uses anchor references (`after`/`before`) to place injected steps and cleans up transitions when steps are hidden.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"
|
|
13
|
+
}];
|
|
14
|
+
registerDocBlocks(personalization_workflow_composition_DocBlocks);
|
|
15
|
+
|
|
16
|
+
//#endregion
|
|
17
|
+
export { personalization_workflow_composition_DocBlocks };
|
|
18
|
+
//# sourceMappingURL=workflow-composition.docblock.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"workflow-composition.docblock.js","names":[],"sources":["../../src/docs/workflow-composition.docblock.ts"],"sourcesContent":["import type { DocBlock } from '@contractspec/lib.contracts/docs';\nimport { registerDocBlocks } from '@contractspec/lib.contracts/docs';\n\nexport const personalization_workflow_composition_DocBlocks: DocBlock[] = [\n {\n id: 'docs.personalization.workflow-composition',\n title: 'Workflow Composition',\n summary:\n '`@contractspec/lib.workflow-composer` composes base WorkflowSpecs with tenant/role/device-specific extensions.',\n kind: 'reference',\n visibility: 'public',\n route: '/docs/personalization/workflow-composition',\n tags: ['personalization', 'workflow-composition'],\n body: \"# Workflow Composition\\n\\n`@contractspec/lib.workflow-composer` composes base WorkflowSpecs with tenant/role/device-specific extensions.\\n\\n## Extensions\\n\\n```ts\\nimport { WorkflowComposer } from '@contractspec/lib.workflow-composer';\\nimport { approvalStepTemplate } from '@contractspec/lib.workflow-composer/templates';\\n\\nconst composer = new WorkflowComposer();\\n\\ncomposer.register({\\n workflow: 'billing.invoiceApproval',\\n tenantId: 'acme',\\n priority: 10,\\n customSteps: [\\n {\\n after: 'validate-invoice',\\n inject: approvalStepTemplate({\\n id: 'acme-legal-review',\\n label: 'Legal Review (ACME)',\\n description: 'Tenant-specific compliance step.',\\n }),\\n transitionTo: 'final-approval',\\n },\\n ],\\n hiddenSteps: ['internal-audit'],\\n});\\n```\\n\\n## Compose\\n\\n```ts\\nconst runtimeSpec = composer.compose({\\n base: BaseInvoiceWorkflow,\\n tenantId: 'acme',\\n});\\n\\nworkflowRunner.execute(runtimeSpec, ctx);\\n```\\n\\nThe composer uses anchor references (`after`/`before`) to place injected steps and cleans up transitions when steps are hidden.\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\\n\",\n },\n];\nregisterDocBlocks(personalization_workflow_composition_DocBlocks);\n"],"mappings":";;;AAGA,MAAa,iDAA6D,CACxE;CACE,IAAI;CACJ,OAAO;CACP,SACE;CACF,MAAM;CACN,YAAY;CACZ,OAAO;CACP,MAAM,CAAC,mBAAmB,uBAAuB;CACjD,MAAM;CACP,CACF;AACD,kBAAkB,+CAA+C"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { BehaviorEvent, BehaviorEventBase, BehaviorEventType, BehaviorInsights, BehaviorQuery, BehaviorSummary, FeatureUsageEvent, FieldAccessEvent, WorkflowStepEvent } from "./types.js";
|
|
2
|
+
import { OverlaySuggestionOptions, WorkflowAdaptation, insightsToOverlaySuggestion, insightsToWorkflowAdaptations } from "./adapter.js";
|
|
3
|
+
import { BehaviorStore, InMemoryBehaviorStore } from "./store.js";
|
|
4
|
+
import { AnalyzeParams, BehaviorAnalyzer, BehaviorAnalyzerOptions } from "./analyzer.js";
|
|
5
|
+
import "./docs/index.js";
|
|
6
|
+
import { BehaviorTracker, BehaviorTrackerContext, BehaviorTrackerOptions, TrackFeatureUsageInput, TrackFieldAccessInput, TrackWorkflowStepInput, createBehaviorTracker } from "./tracker.js";
|
|
7
|
+
export { AnalyzeParams, BehaviorAnalyzer, BehaviorAnalyzerOptions, BehaviorEvent, BehaviorEventBase, BehaviorEventType, BehaviorInsights, BehaviorQuery, BehaviorStore, BehaviorSummary, BehaviorTracker, BehaviorTrackerContext, BehaviorTrackerOptions, FeatureUsageEvent, FieldAccessEvent, InMemoryBehaviorStore, OverlaySuggestionOptions, TrackFeatureUsageInput, TrackFieldAccessInput, TrackWorkflowStepInput, WorkflowAdaptation, WorkflowStepEvent, createBehaviorTracker, insightsToOverlaySuggestion, insightsToWorkflowAdaptations };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { insightsToOverlaySuggestion, insightsToWorkflowAdaptations } from "./adapter.js";
|
|
2
|
+
import { BehaviorAnalyzer } from "./analyzer.js";
|
|
3
|
+
import { InMemoryBehaviorStore } from "./store.js";
|
|
4
|
+
import { BehaviorTracker, createBehaviorTracker } from "./tracker.js";
|
|
5
|
+
import "./docs/index.js";
|
|
6
|
+
|
|
7
|
+
export { BehaviorAnalyzer, BehaviorTracker, InMemoryBehaviorStore, createBehaviorTracker, insightsToOverlaySuggestion, insightsToWorkflowAdaptations };
|
package/dist/store.d.ts
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { BehaviorEvent, BehaviorQuery, BehaviorSummary } from "./types.js";
|
|
2
|
+
|
|
3
|
+
//#region src/store.d.ts
|
|
4
|
+
interface BehaviorStore {
|
|
5
|
+
record(event: BehaviorEvent): Promise<void> | void;
|
|
6
|
+
bulkRecord(events: BehaviorEvent[]): Promise<void> | void;
|
|
7
|
+
query(query: BehaviorQuery): Promise<BehaviorEvent[]>;
|
|
8
|
+
summarize(query: BehaviorQuery): Promise<BehaviorSummary>;
|
|
9
|
+
clear?(): Promise<void> | void;
|
|
10
|
+
}
|
|
11
|
+
declare class InMemoryBehaviorStore implements BehaviorStore {
|
|
12
|
+
private events;
|
|
13
|
+
record(event: BehaviorEvent): Promise<void>;
|
|
14
|
+
bulkRecord(events: BehaviorEvent[]): Promise<void>;
|
|
15
|
+
query(query: BehaviorQuery): Promise<BehaviorEvent[]>;
|
|
16
|
+
summarize(query: BehaviorQuery): Promise<BehaviorSummary>;
|
|
17
|
+
clear(): Promise<void>;
|
|
18
|
+
}
|
|
19
|
+
//#endregion
|
|
20
|
+
export { BehaviorStore, InMemoryBehaviorStore };
|
|
21
|
+
//# sourceMappingURL=store.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"store.d.ts","names":[],"sources":["../src/store.ts"],"sourcesContent":[],"mappings":";;;UAEiB,aAAA;gBACD,gBAAgB;EADf,UAAA,CAAA,MAAa,EAET,aAFS,EAAA,CAAA,EAES,OAFT,CAAA,IAAA,CAAA,GAAA,IAAA;EACd,KAAA,CAAA,KAAA,EAED,aAFC,CAAA,EAEe,OAFf,CAEuB,aAFvB,EAAA,CAAA;EAAgB,SAAA,CAAA,KAAA,EAGb,aAHa,CAAA,EAGG,OAHH,CAGW,eAHX,CAAA;EACX,KAAA,GAAA,EAGT,OAHS,CAAA,IAAA,CAAA,GAAA,IAAA;;AACN,cAKF,qBAAA,YAAiC,aAL/B,CAAA;EAAwB,QAAA,MAAA;EAAR,MAAA,CAAA,KAAA,EAQT,aARS,CAAA,EAQO,OARP,CAAA,IAAA,CAAA;EACZ,UAAA,CAAA,MAAA,EAWQ,aAXR,EAAA,CAAA,EAW0B,OAX1B,CAAA,IAAA,CAAA;EAAwB,KAAA,CAAA,KAAA,EAetB,aAfsB,CAAA,EAeN,OAfM,CAeE,aAfF,EAAA,CAAA;EAAR,SAAA,CAAA,KAAA,EAmBV,aAnBU,CAAA,EAmBM,OAnBN,CAmBc,eAnBd,CAAA;EACvB,KAAA,CAAA,CAAA,EAkDK,OAlDL,CAAA,IAAA,CAAA"}
|
package/dist/store.js
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
//#region src/store.ts
|
|
2
|
+
var InMemoryBehaviorStore = class {
|
|
3
|
+
events = [];
|
|
4
|
+
async record(event) {
|
|
5
|
+
this.events.push(event);
|
|
6
|
+
}
|
|
7
|
+
async bulkRecord(events) {
|
|
8
|
+
this.events.push(...events);
|
|
9
|
+
}
|
|
10
|
+
async query(query) {
|
|
11
|
+
return filterEvents(this.events, query);
|
|
12
|
+
}
|
|
13
|
+
async summarize(query) {
|
|
14
|
+
const events = await this.query(query);
|
|
15
|
+
const summary = {
|
|
16
|
+
fieldCounts: {},
|
|
17
|
+
featureCounts: {},
|
|
18
|
+
workflowStepCounts: {},
|
|
19
|
+
totalEvents: events.length
|
|
20
|
+
};
|
|
21
|
+
events.forEach((event) => {
|
|
22
|
+
switch (event.type) {
|
|
23
|
+
case "field_access":
|
|
24
|
+
summary.fieldCounts[event.field] = (summary.fieldCounts[event.field] ?? 0) + 1;
|
|
25
|
+
break;
|
|
26
|
+
case "feature_usage":
|
|
27
|
+
summary.featureCounts[event.feature] = (summary.featureCounts[event.feature] ?? 0) + 1;
|
|
28
|
+
break;
|
|
29
|
+
case "workflow_step": {
|
|
30
|
+
const workflow = summary.workflowStepCounts[event.workflow] ??= {};
|
|
31
|
+
workflow[event.step] = (workflow[event.step] ?? 0) + 1;
|
|
32
|
+
break;
|
|
33
|
+
}
|
|
34
|
+
default: break;
|
|
35
|
+
}
|
|
36
|
+
});
|
|
37
|
+
return summary;
|
|
38
|
+
}
|
|
39
|
+
async clear() {
|
|
40
|
+
this.events = [];
|
|
41
|
+
}
|
|
42
|
+
};
|
|
43
|
+
function filterEvents(events, query) {
|
|
44
|
+
return events.filter((event) => {
|
|
45
|
+
if (query.tenantId && event.tenantId !== query.tenantId) return false;
|
|
46
|
+
if (query.userId && event.userId !== query.userId) return false;
|
|
47
|
+
if (query.role && event.role !== query.role) return false;
|
|
48
|
+
if (query.since && event.timestamp < query.since) return false;
|
|
49
|
+
if (query.until && event.timestamp > query.until) return false;
|
|
50
|
+
if (query.operation && event.type === "field_access" && event.operation !== query.operation) return false;
|
|
51
|
+
if (query.feature && event.type === "feature_usage" && event.feature !== query.feature) return false;
|
|
52
|
+
if (query.workflow && event.type === "workflow_step" && event.workflow !== query.workflow) return false;
|
|
53
|
+
return true;
|
|
54
|
+
});
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
//#endregion
|
|
58
|
+
export { InMemoryBehaviorStore };
|
|
59
|
+
//# sourceMappingURL=store.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"store.js","names":[],"sources":["../src/store.ts"],"sourcesContent":["import type { BehaviorEvent, BehaviorQuery, BehaviorSummary } from './types';\n\nexport interface BehaviorStore {\n record(event: BehaviorEvent): Promise<void> | void;\n bulkRecord(events: BehaviorEvent[]): Promise<void> | void;\n query(query: BehaviorQuery): Promise<BehaviorEvent[]>;\n summarize(query: BehaviorQuery): Promise<BehaviorSummary>;\n clear?(): Promise<void> | void;\n}\n\nexport class InMemoryBehaviorStore implements BehaviorStore {\n private events: BehaviorEvent[] = [];\n\n async record(event: BehaviorEvent): Promise<void> {\n this.events.push(event);\n }\n\n async bulkRecord(events: BehaviorEvent[]): Promise<void> {\n this.events.push(...events);\n }\n\n async query(query: BehaviorQuery): Promise<BehaviorEvent[]> {\n return filterEvents(this.events, query);\n }\n\n async summarize(query: BehaviorQuery): Promise<BehaviorSummary> {\n const events = await this.query(query);\n const summary: BehaviorSummary = {\n fieldCounts: {},\n featureCounts: {},\n workflowStepCounts: {},\n totalEvents: events.length,\n };\n\n events.forEach((event) => {\n switch (event.type) {\n case 'field_access':\n summary.fieldCounts[event.field] =\n (summary.fieldCounts[event.field] ?? 0) + 1;\n break;\n case 'feature_usage':\n summary.featureCounts[event.feature] =\n (summary.featureCounts[event.feature] ?? 0) + 1;\n break;\n case 'workflow_step': {\n const workflow = (summary.workflowStepCounts[event.workflow] ??= {});\n workflow[event.step] = (workflow[event.step] ?? 0) + 1;\n break;\n }\n default:\n break;\n }\n });\n\n return summary;\n }\n\n async clear(): Promise<void> {\n this.events = [];\n }\n}\n\nfunction filterEvents(\n events: BehaviorEvent[],\n query: BehaviorQuery\n): BehaviorEvent[] {\n return events.filter((event) => {\n if (query.tenantId && event.tenantId !== query.tenantId) {\n return false;\n }\n if (query.userId && event.userId !== query.userId) {\n return false;\n }\n if (query.role && event.role !== query.role) {\n return false;\n }\n if (query.since && event.timestamp < query.since) {\n return false;\n }\n if (query.until && event.timestamp > query.until) {\n return false;\n }\n\n if (\n query.operation &&\n event.type === 'field_access' &&\n event.operation !== query.operation\n ) {\n return false;\n }\n if (\n query.feature &&\n event.type === 'feature_usage' &&\n event.feature !== query.feature\n ) {\n return false;\n }\n if (\n query.workflow &&\n event.type === 'workflow_step' &&\n event.workflow !== query.workflow\n ) {\n return false;\n }\n return true;\n });\n}\n"],"mappings":";AAUA,IAAa,wBAAb,MAA4D;CAC1D,AAAQ,SAA0B,EAAE;CAEpC,MAAM,OAAO,OAAqC;AAChD,OAAK,OAAO,KAAK,MAAM;;CAGzB,MAAM,WAAW,QAAwC;AACvD,OAAK,OAAO,KAAK,GAAG,OAAO;;CAG7B,MAAM,MAAM,OAAgD;AAC1D,SAAO,aAAa,KAAK,QAAQ,MAAM;;CAGzC,MAAM,UAAU,OAAgD;EAC9D,MAAM,SAAS,MAAM,KAAK,MAAM,MAAM;EACtC,MAAM,UAA2B;GAC/B,aAAa,EAAE;GACf,eAAe,EAAE;GACjB,oBAAoB,EAAE;GACtB,aAAa,OAAO;GACrB;AAED,SAAO,SAAS,UAAU;AACxB,WAAQ,MAAM,MAAd;IACE,KAAK;AACH,aAAQ,YAAY,MAAM,UACvB,QAAQ,YAAY,MAAM,UAAU,KAAK;AAC5C;IACF,KAAK;AACH,aAAQ,cAAc,MAAM,YACzB,QAAQ,cAAc,MAAM,YAAY,KAAK;AAChD;IACF,KAAK,iBAAiB;KACpB,MAAM,WAAY,QAAQ,mBAAmB,MAAM,cAAc,EAAE;AACnE,cAAS,MAAM,SAAS,SAAS,MAAM,SAAS,KAAK;AACrD;;IAEF,QACE;;IAEJ;AAEF,SAAO;;CAGT,MAAM,QAAuB;AAC3B,OAAK,SAAS,EAAE;;;AAIpB,SAAS,aACP,QACA,OACiB;AACjB,QAAO,OAAO,QAAQ,UAAU;AAC9B,MAAI,MAAM,YAAY,MAAM,aAAa,MAAM,SAC7C,QAAO;AAET,MAAI,MAAM,UAAU,MAAM,WAAW,MAAM,OACzC,QAAO;AAET,MAAI,MAAM,QAAQ,MAAM,SAAS,MAAM,KACrC,QAAO;AAET,MAAI,MAAM,SAAS,MAAM,YAAY,MAAM,MACzC,QAAO;AAET,MAAI,MAAM,SAAS,MAAM,YAAY,MAAM,MACzC,QAAO;AAGT,MACE,MAAM,aACN,MAAM,SAAS,kBACf,MAAM,cAAc,MAAM,UAE1B,QAAO;AAET,MACE,MAAM,WACN,MAAM,SAAS,mBACf,MAAM,YAAY,MAAM,QAExB,QAAO;AAET,MACE,MAAM,YACN,MAAM,SAAS,mBACf,MAAM,aAAa,MAAM,SAEzB,QAAO;AAET,SAAO;GACP"}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { BehaviorStore } from "./store.js";
|
|
2
|
+
|
|
3
|
+
//#region src/tracker.d.ts
|
|
4
|
+
interface BehaviorTrackerContext {
|
|
5
|
+
tenantId: string;
|
|
6
|
+
userId?: string;
|
|
7
|
+
role?: string;
|
|
8
|
+
device?: string;
|
|
9
|
+
metadata?: Record<string, unknown>;
|
|
10
|
+
}
|
|
11
|
+
interface BehaviorTrackerOptions {
|
|
12
|
+
store: BehaviorStore;
|
|
13
|
+
context: BehaviorTrackerContext;
|
|
14
|
+
tracerName?: string;
|
|
15
|
+
autoFlushIntervalMs?: number;
|
|
16
|
+
bufferSize?: number;
|
|
17
|
+
}
|
|
18
|
+
interface TrackFieldAccessInput {
|
|
19
|
+
operation: string;
|
|
20
|
+
field: string;
|
|
21
|
+
metadata?: Record<string, unknown>;
|
|
22
|
+
}
|
|
23
|
+
interface TrackFeatureUsageInput {
|
|
24
|
+
feature: string;
|
|
25
|
+
action: 'opened' | 'completed' | 'dismissed';
|
|
26
|
+
metadata?: Record<string, unknown>;
|
|
27
|
+
}
|
|
28
|
+
interface TrackWorkflowStepInput {
|
|
29
|
+
workflow: string;
|
|
30
|
+
step: string;
|
|
31
|
+
status: 'entered' | 'completed' | 'skipped' | 'errored';
|
|
32
|
+
metadata?: Record<string, unknown>;
|
|
33
|
+
}
|
|
34
|
+
declare class BehaviorTracker {
|
|
35
|
+
private readonly store;
|
|
36
|
+
private readonly context;
|
|
37
|
+
private readonly tracer;
|
|
38
|
+
private readonly counter;
|
|
39
|
+
private buffer;
|
|
40
|
+
private readonly bufferSize;
|
|
41
|
+
private flushTimer?;
|
|
42
|
+
constructor(options: BehaviorTrackerOptions);
|
|
43
|
+
trackFieldAccess(input: TrackFieldAccessInput): void;
|
|
44
|
+
trackFeatureUsage(input: TrackFeatureUsageInput): void;
|
|
45
|
+
trackWorkflowStep(input: TrackWorkflowStepInput): void;
|
|
46
|
+
flush(): Promise<void>;
|
|
47
|
+
dispose(): Promise<void>;
|
|
48
|
+
private enqueue;
|
|
49
|
+
}
|
|
50
|
+
declare const createBehaviorTracker: (options: BehaviorTrackerOptions) => BehaviorTracker;
|
|
51
|
+
//#endregion
|
|
52
|
+
export { BehaviorTracker, BehaviorTrackerContext, BehaviorTrackerOptions, TrackFeatureUsageInput, TrackFieldAccessInput, TrackWorkflowStepInput, createBehaviorTracker };
|
|
53
|
+
//# sourceMappingURL=tracker.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tracker.d.ts","names":[],"sources":["../src/tracker.ts"],"sourcesContent":[],"mappings":";;;UAIiB,sBAAA;;EAAA,MAAA,CAAA,EAAA,MAAA;EAQA,IAAA,CAAA,EAAA,MAAA;EAUA,MAAA,CAAA,EAAA,MAAA;EAMA,QAAA,CAAA,EAnBJ,MAmBI,CAAA,MAAA,EAAsB,OAAA,CAAA;AAMvC;AAOa,UA7BI,sBAAA,CA6BW;EAcL,KAAA,EA1Cd,aA0Cc;EAYG,OAAA,EArDf,sBAqDe;EAYC,UAAA,CAAA,EAAA,MAAA;EAYA,mBAAA,CAAA,EAAA,MAAA;EAaV,UAAA,CAAA,EAAA,MAAA;;AAOS,UAzFT,qBAAA,CAyFS;EA4Bb,SAAA,EAAA,MAAA;;aAlHA;;UAGI,sBAAA;;;aAGJ;;UAGI,sBAAA;;;;aAIJ;;cAGA,eAAA;;;;;;;;uBAcU;0BAYG;2BAYC;2BAYA;WAaV;aAOE;;;cA4BN,iCAAkC,2BAAsB"}
|
package/dist/tracker.js
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
import { metrics, trace } from "@opentelemetry/api";
|
|
2
|
+
|
|
3
|
+
//#region src/tracker.ts
|
|
4
|
+
const DEFAULT_BUFFER_SIZE = 25;
|
|
5
|
+
var BehaviorTracker = class {
|
|
6
|
+
store;
|
|
7
|
+
context;
|
|
8
|
+
tracer = trace.getTracer("lssm.personalization", "1.0.0");
|
|
9
|
+
counter = metrics.getMeter("lssm.personalization", "1.0.0").createCounter("lssm.personalization.events", { description: "Behavior events tracked for personalization" });
|
|
10
|
+
buffer = [];
|
|
11
|
+
bufferSize;
|
|
12
|
+
flushTimer;
|
|
13
|
+
constructor(options) {
|
|
14
|
+
this.store = options.store;
|
|
15
|
+
this.context = options.context;
|
|
16
|
+
this.bufferSize = options.bufferSize ?? DEFAULT_BUFFER_SIZE;
|
|
17
|
+
if (options.autoFlushIntervalMs) this.flushTimer = setInterval(() => {
|
|
18
|
+
this.flush();
|
|
19
|
+
}, options.autoFlushIntervalMs);
|
|
20
|
+
}
|
|
21
|
+
trackFieldAccess(input) {
|
|
22
|
+
const event = {
|
|
23
|
+
type: "field_access",
|
|
24
|
+
operation: input.operation,
|
|
25
|
+
field: input.field,
|
|
26
|
+
timestamp: Date.now(),
|
|
27
|
+
...this.context,
|
|
28
|
+
metadata: {
|
|
29
|
+
...this.context.metadata,
|
|
30
|
+
...input.metadata
|
|
31
|
+
}
|
|
32
|
+
};
|
|
33
|
+
this.enqueue(event);
|
|
34
|
+
}
|
|
35
|
+
trackFeatureUsage(input) {
|
|
36
|
+
const event = {
|
|
37
|
+
type: "feature_usage",
|
|
38
|
+
feature: input.feature,
|
|
39
|
+
action: input.action,
|
|
40
|
+
timestamp: Date.now(),
|
|
41
|
+
...this.context,
|
|
42
|
+
metadata: {
|
|
43
|
+
...this.context.metadata,
|
|
44
|
+
...input.metadata
|
|
45
|
+
}
|
|
46
|
+
};
|
|
47
|
+
this.enqueue(event);
|
|
48
|
+
}
|
|
49
|
+
trackWorkflowStep(input) {
|
|
50
|
+
const event = {
|
|
51
|
+
type: "workflow_step",
|
|
52
|
+
workflow: input.workflow,
|
|
53
|
+
step: input.step,
|
|
54
|
+
status: input.status,
|
|
55
|
+
timestamp: Date.now(),
|
|
56
|
+
...this.context,
|
|
57
|
+
metadata: {
|
|
58
|
+
...this.context.metadata,
|
|
59
|
+
...input.metadata
|
|
60
|
+
}
|
|
61
|
+
};
|
|
62
|
+
this.enqueue(event);
|
|
63
|
+
}
|
|
64
|
+
async flush() {
|
|
65
|
+
if (!this.buffer.length) return;
|
|
66
|
+
const events = this.buffer;
|
|
67
|
+
this.buffer = [];
|
|
68
|
+
await this.store.bulkRecord(events);
|
|
69
|
+
}
|
|
70
|
+
async dispose() {
|
|
71
|
+
if (this.flushTimer) clearInterval(this.flushTimer);
|
|
72
|
+
await this.flush();
|
|
73
|
+
}
|
|
74
|
+
enqueue(event) {
|
|
75
|
+
this.buffer.push(event);
|
|
76
|
+
this.counter.add(1, {
|
|
77
|
+
tenantId: this.context.tenantId,
|
|
78
|
+
type: event.type
|
|
79
|
+
});
|
|
80
|
+
this.tracer.startActiveSpan(`personalization.${event.type}`, (span) => {
|
|
81
|
+
span.setAttribute("tenant.id", this.context.tenantId);
|
|
82
|
+
if (this.context.userId) span.setAttribute("user.id", this.context.userId);
|
|
83
|
+
span.setAttribute("personalization.event_type", event.type);
|
|
84
|
+
span.end();
|
|
85
|
+
});
|
|
86
|
+
if (this.buffer.length >= this.bufferSize) this.flush();
|
|
87
|
+
}
|
|
88
|
+
};
|
|
89
|
+
const createBehaviorTracker = (options) => new BehaviorTracker(options);
|
|
90
|
+
|
|
91
|
+
//#endregion
|
|
92
|
+
export { BehaviorTracker, createBehaviorTracker };
|
|
93
|
+
//# sourceMappingURL=tracker.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tracker.js","names":[],"sources":["../src/tracker.ts"],"sourcesContent":["import { trace, metrics } from '@opentelemetry/api';\nimport type { BehaviorEvent } from './types';\nimport type { BehaviorStore } from './store';\n\nexport interface BehaviorTrackerContext {\n tenantId: string;\n userId?: string;\n role?: string;\n device?: string;\n metadata?: Record<string, unknown>;\n}\n\nexport interface BehaviorTrackerOptions {\n store: BehaviorStore;\n context: BehaviorTrackerContext;\n tracerName?: string;\n autoFlushIntervalMs?: number;\n bufferSize?: number;\n}\n\nconst DEFAULT_BUFFER_SIZE = 25;\n\nexport interface TrackFieldAccessInput {\n operation: string;\n field: string;\n metadata?: Record<string, unknown>;\n}\n\nexport interface TrackFeatureUsageInput {\n feature: string;\n action: 'opened' | 'completed' | 'dismissed';\n metadata?: Record<string, unknown>;\n}\n\nexport interface TrackWorkflowStepInput {\n workflow: string;\n step: string;\n status: 'entered' | 'completed' | 'skipped' | 'errored';\n metadata?: Record<string, unknown>;\n}\n\nexport class BehaviorTracker {\n private readonly store: BehaviorStore;\n private readonly context: BehaviorTrackerContext;\n private readonly tracer = trace.getTracer('lssm.personalization', '1.0.0');\n private readonly counter = metrics\n .getMeter('lssm.personalization', '1.0.0')\n .createCounter('lssm.personalization.events', {\n description: 'Behavior events tracked for personalization',\n });\n\n private buffer: BehaviorEvent[] = [];\n private readonly bufferSize: number;\n private flushTimer?: ReturnType<typeof setInterval>;\n\n constructor(options: BehaviorTrackerOptions) {\n this.store = options.store;\n this.context = options.context;\n this.bufferSize = options.bufferSize ?? DEFAULT_BUFFER_SIZE;\n\n if (options.autoFlushIntervalMs) {\n this.flushTimer = setInterval(() => {\n void this.flush();\n }, options.autoFlushIntervalMs);\n }\n }\n\n trackFieldAccess(input: TrackFieldAccessInput) {\n const event = {\n type: 'field_access',\n operation: input.operation,\n field: input.field,\n timestamp: Date.now(),\n ...this.context,\n metadata: { ...this.context.metadata, ...input.metadata },\n } as BehaviorEvent;\n this.enqueue(event);\n }\n\n trackFeatureUsage(input: TrackFeatureUsageInput) {\n const event = {\n type: 'feature_usage',\n feature: input.feature,\n action: input.action,\n timestamp: Date.now(),\n ...this.context,\n metadata: { ...this.context.metadata, ...input.metadata },\n } as BehaviorEvent;\n this.enqueue(event);\n }\n\n trackWorkflowStep(input: TrackWorkflowStepInput) {\n const event = {\n type: 'workflow_step',\n workflow: input.workflow,\n step: input.step,\n status: input.status,\n timestamp: Date.now(),\n ...this.context,\n metadata: { ...this.context.metadata, ...input.metadata },\n } as BehaviorEvent;\n this.enqueue(event);\n }\n\n async flush(): Promise<void> {\n if (!this.buffer.length) return;\n const events = this.buffer;\n this.buffer = [];\n await this.store.bulkRecord(events);\n }\n\n async dispose(): Promise<void> {\n if (this.flushTimer) {\n clearInterval(this.flushTimer);\n }\n await this.flush();\n }\n\n private enqueue(event: BehaviorEvent) {\n this.buffer.push(event);\n this.counter.add(1, {\n tenantId: this.context.tenantId,\n type: event.type,\n });\n\n this.tracer.startActiveSpan(`personalization.${event.type}`, (span) => {\n span.setAttribute('tenant.id', this.context.tenantId);\n if (this.context.userId)\n span.setAttribute('user.id', this.context.userId);\n span.setAttribute('personalization.event_type', event.type);\n span.end();\n });\n\n if (this.buffer.length >= this.bufferSize) {\n void this.flush();\n }\n }\n}\n\nexport const createBehaviorTracker = (options: BehaviorTrackerOptions) =>\n new BehaviorTracker(options);\n"],"mappings":";;;AAoBA,MAAM,sBAAsB;AAqB5B,IAAa,kBAAb,MAA6B;CAC3B,AAAiB;CACjB,AAAiB;CACjB,AAAiB,SAAS,MAAM,UAAU,wBAAwB,QAAQ;CAC1E,AAAiB,UAAU,QACxB,SAAS,wBAAwB,QAAQ,CACzC,cAAc,+BAA+B,EAC5C,aAAa,+CACd,CAAC;CAEJ,AAAQ,SAA0B,EAAE;CACpC,AAAiB;CACjB,AAAQ;CAER,YAAY,SAAiC;AAC3C,OAAK,QAAQ,QAAQ;AACrB,OAAK,UAAU,QAAQ;AACvB,OAAK,aAAa,QAAQ,cAAc;AAExC,MAAI,QAAQ,oBACV,MAAK,aAAa,kBAAkB;AAClC,GAAK,KAAK,OAAO;KAChB,QAAQ,oBAAoB;;CAInC,iBAAiB,OAA8B;EAC7C,MAAM,QAAQ;GACZ,MAAM;GACN,WAAW,MAAM;GACjB,OAAO,MAAM;GACb,WAAW,KAAK,KAAK;GACrB,GAAG,KAAK;GACR,UAAU;IAAE,GAAG,KAAK,QAAQ;IAAU,GAAG,MAAM;IAAU;GAC1D;AACD,OAAK,QAAQ,MAAM;;CAGrB,kBAAkB,OAA+B;EAC/C,MAAM,QAAQ;GACZ,MAAM;GACN,SAAS,MAAM;GACf,QAAQ,MAAM;GACd,WAAW,KAAK,KAAK;GACrB,GAAG,KAAK;GACR,UAAU;IAAE,GAAG,KAAK,QAAQ;IAAU,GAAG,MAAM;IAAU;GAC1D;AACD,OAAK,QAAQ,MAAM;;CAGrB,kBAAkB,OAA+B;EAC/C,MAAM,QAAQ;GACZ,MAAM;GACN,UAAU,MAAM;GAChB,MAAM,MAAM;GACZ,QAAQ,MAAM;GACd,WAAW,KAAK,KAAK;GACrB,GAAG,KAAK;GACR,UAAU;IAAE,GAAG,KAAK,QAAQ;IAAU,GAAG,MAAM;IAAU;GAC1D;AACD,OAAK,QAAQ,MAAM;;CAGrB,MAAM,QAAuB;AAC3B,MAAI,CAAC,KAAK,OAAO,OAAQ;EACzB,MAAM,SAAS,KAAK;AACpB,OAAK,SAAS,EAAE;AAChB,QAAM,KAAK,MAAM,WAAW,OAAO;;CAGrC,MAAM,UAAyB;AAC7B,MAAI,KAAK,WACP,eAAc,KAAK,WAAW;AAEhC,QAAM,KAAK,OAAO;;CAGpB,AAAQ,QAAQ,OAAsB;AACpC,OAAK,OAAO,KAAK,MAAM;AACvB,OAAK,QAAQ,IAAI,GAAG;GAClB,UAAU,KAAK,QAAQ;GACvB,MAAM,MAAM;GACb,CAAC;AAEF,OAAK,OAAO,gBAAgB,mBAAmB,MAAM,SAAS,SAAS;AACrE,QAAK,aAAa,aAAa,KAAK,QAAQ,SAAS;AACrD,OAAI,KAAK,QAAQ,OACf,MAAK,aAAa,WAAW,KAAK,QAAQ,OAAO;AACnD,QAAK,aAAa,8BAA8B,MAAM,KAAK;AAC3D,QAAK,KAAK;IACV;AAEF,MAAI,KAAK,OAAO,UAAU,KAAK,WAC7B,CAAK,KAAK,OAAO;;;AAKvB,MAAa,yBAAyB,YACpC,IAAI,gBAAgB,QAAQ"}
|
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
//#region src/types.d.ts
|
|
2
|
+
type BehaviorEventType = 'field_access' | 'feature_usage' | 'workflow_step';
|
|
3
|
+
interface BehaviorEventBase {
|
|
4
|
+
id?: string;
|
|
5
|
+
tenantId: string;
|
|
6
|
+
userId?: string;
|
|
7
|
+
role?: string;
|
|
8
|
+
device?: string;
|
|
9
|
+
timestamp: number;
|
|
10
|
+
metadata?: Record<string, unknown>;
|
|
11
|
+
}
|
|
12
|
+
interface FieldAccessEvent extends BehaviorEventBase {
|
|
13
|
+
type: 'field_access';
|
|
14
|
+
operation: string;
|
|
15
|
+
field: string;
|
|
16
|
+
}
|
|
17
|
+
interface FeatureUsageEvent extends BehaviorEventBase {
|
|
18
|
+
type: 'feature_usage';
|
|
19
|
+
feature: string;
|
|
20
|
+
action: 'opened' | 'completed' | 'dismissed';
|
|
21
|
+
}
|
|
22
|
+
interface WorkflowStepEvent extends BehaviorEventBase {
|
|
23
|
+
type: 'workflow_step';
|
|
24
|
+
workflow: string;
|
|
25
|
+
step: string;
|
|
26
|
+
status: 'entered' | 'completed' | 'skipped' | 'errored';
|
|
27
|
+
}
|
|
28
|
+
type BehaviorEvent = FieldAccessEvent | FeatureUsageEvent | WorkflowStepEvent;
|
|
29
|
+
interface BehaviorQuery {
|
|
30
|
+
tenantId?: string;
|
|
31
|
+
userId?: string;
|
|
32
|
+
role?: string;
|
|
33
|
+
feature?: string;
|
|
34
|
+
operation?: string;
|
|
35
|
+
workflow?: string;
|
|
36
|
+
since?: number;
|
|
37
|
+
until?: number;
|
|
38
|
+
limit?: number;
|
|
39
|
+
}
|
|
40
|
+
interface BehaviorSummary {
|
|
41
|
+
fieldCounts: Record<string, number>;
|
|
42
|
+
featureCounts: Record<string, number>;
|
|
43
|
+
workflowStepCounts: Record<string, Record<string, number>>;
|
|
44
|
+
totalEvents: number;
|
|
45
|
+
}
|
|
46
|
+
interface BehaviorInsights {
|
|
47
|
+
unusedFields: string[];
|
|
48
|
+
frequentlyUsedFields: string[];
|
|
49
|
+
suggestedHiddenFields: string[];
|
|
50
|
+
workflowBottlenecks: {
|
|
51
|
+
workflow: string;
|
|
52
|
+
step: string;
|
|
53
|
+
dropRate: number;
|
|
54
|
+
}[];
|
|
55
|
+
layoutPreference?: 'form' | 'grid' | 'list' | 'table';
|
|
56
|
+
}
|
|
57
|
+
//#endregion
|
|
58
|
+
export { BehaviorEvent, BehaviorEventBase, BehaviorEventType, BehaviorInsights, BehaviorQuery, BehaviorSummary, FeatureUsageEvent, FieldAccessEvent, WorkflowStepEvent };
|
|
59
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","names":[],"sources":["../src/types.ts"],"sourcesContent":[],"mappings":";KAAY,iBAAA;AAAA,UAKK,iBAAA,CALY;EAKZ,EAAA,CAAA,EAAA,MAAA;EAUA,QAAA,EAAA,MAAA;EAMA,MAAA,CAAA,EAAA,MAAA;EAMA,IAAA,CAAA,EAAA,MAAA;EAOL,MAAA,CAAA,EAAA,MAAA;EACR,SAAA,EAAA,MAAA;EACA,QAAA,CAAA,EAxBS,MAwBT,CAAA,MAAA,EAAA,OAAA,CAAA;;AACiB,UAtBJ,gBAAA,SAAyB,iBAsBrB,CAAA;EAEJ,IAAA,EAAA,cAAa;EAYb,SAAA,EAAA,MAAA;EACF,KAAA,EAAA,MAAA;;AAEsB,UAjCpB,iBAAA,SAA0B,iBAiCN,CAAA;EAAf,IAAA,EAAA,eAAA;EAAM,OAAA,EAAA,MAAA;EAIX,MAAA,EAAA,QAAA,GAAgB,WAAA,GAAA,WAAA;;UA/BhB,iBAAA,SAA0B;;;;;;KAO/B,aAAA,GACR,mBACA,oBACA;UAEa,aAAA;;;;;;;;;;;UAYA,eAAA;eACF;iBACE;sBACK,eAAe;;;UAIpB,gBAAA"}
|
package/dist/types.js
ADDED
|
File without changes
|
package/package.json
ADDED
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@contractspec/lib.personalization",
|
|
3
|
+
"version": "0.0.0-canary-20260113162409",
|
|
4
|
+
"description": "Behavior tracking, analysis, and adaptation helpers for ContractSpec personalization.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"contractspec",
|
|
7
|
+
"personalization",
|
|
8
|
+
"behavior",
|
|
9
|
+
"analytics",
|
|
10
|
+
"adaptation",
|
|
11
|
+
"typescript"
|
|
12
|
+
],
|
|
13
|
+
"type": "module",
|
|
14
|
+
"types": "./dist/index.d.ts",
|
|
15
|
+
"files": [
|
|
16
|
+
"dist",
|
|
17
|
+
"README.md"
|
|
18
|
+
],
|
|
19
|
+
"scripts": {
|
|
20
|
+
"publish:pkg": "bun publish --tolerate-republish --ignore-scripts --verbose",
|
|
21
|
+
"publish:pkg:canary": "bun publish:pkg --tag canary",
|
|
22
|
+
"build": "bun build:types && bun build:bundle",
|
|
23
|
+
"build:bundle": "tsdown",
|
|
24
|
+
"build:types": "tsc --noEmit",
|
|
25
|
+
"dev": "bun build:bundle --watch",
|
|
26
|
+
"clean": "rimraf dist .turbo",
|
|
27
|
+
"lint": "bun lint:fix",
|
|
28
|
+
"lint:fix": "eslint src --fix",
|
|
29
|
+
"lint:check": "eslint src",
|
|
30
|
+
"test": "bun test"
|
|
31
|
+
},
|
|
32
|
+
"dependencies": {
|
|
33
|
+
"@contractspec/lib.bus": "0.0.0-canary-20260113162409",
|
|
34
|
+
"@contractspec/lib.schema": "0.0.0-canary-20260113162409",
|
|
35
|
+
"@contractspec/lib.contracts": "0.0.0-canary-20260113162409",
|
|
36
|
+
"@contractspec/lib.knowledge": "0.0.0-canary-20260113162409",
|
|
37
|
+
"@contractspec/lib.overlay-engine": "0.0.0-canary-20260113162409",
|
|
38
|
+
"@opentelemetry/api": "^1.9.0"
|
|
39
|
+
},
|
|
40
|
+
"peerDependencies": {
|
|
41
|
+
"@opentelemetry/api": "^1.9.0"
|
|
42
|
+
},
|
|
43
|
+
"devDependencies": {
|
|
44
|
+
"@contractspec/tool.tsdown": "0.0.0-canary-20260113162409",
|
|
45
|
+
"@contractspec/tool.typescript": "0.0.0-canary-20260113162409",
|
|
46
|
+
"tsdown": "^0.19.0",
|
|
47
|
+
"typescript": "^5.9.3"
|
|
48
|
+
},
|
|
49
|
+
"exports": {
|
|
50
|
+
".": "./dist/index.js",
|
|
51
|
+
"./adapter": "./dist/adapter.js",
|
|
52
|
+
"./analyzer": "./dist/analyzer.js",
|
|
53
|
+
"./docs": "./dist/docs/index.js",
|
|
54
|
+
"./docs/behavior-tracking.docblock": "./dist/docs/behavior-tracking.docblock.js",
|
|
55
|
+
"./docs/overlay-engine.docblock": "./dist/docs/overlay-engine.docblock.js",
|
|
56
|
+
"./docs/workflow-composition.docblock": "./dist/docs/workflow-composition.docblock.js",
|
|
57
|
+
"./store": "./dist/store.js",
|
|
58
|
+
"./tracker": "./dist/tracker.js",
|
|
59
|
+
"./types": "./dist/types.js",
|
|
60
|
+
"./*": "./*"
|
|
61
|
+
},
|
|
62
|
+
"publishConfig": {
|
|
63
|
+
"access": "public",
|
|
64
|
+
"exports": {
|
|
65
|
+
".": "./dist/index.js",
|
|
66
|
+
"./adapter": "./dist/adapter.js",
|
|
67
|
+
"./analyzer": "./dist/analyzer.js",
|
|
68
|
+
"./docs": "./dist/docs/index.js",
|
|
69
|
+
"./docs/behavior-tracking.docblock": "./dist/docs/behavior-tracking.docblock.js",
|
|
70
|
+
"./docs/overlay-engine.docblock": "./dist/docs/overlay-engine.docblock.js",
|
|
71
|
+
"./docs/workflow-composition.docblock": "./dist/docs/workflow-composition.docblock.js",
|
|
72
|
+
"./store": "./dist/store.js",
|
|
73
|
+
"./tracker": "./dist/tracker.js",
|
|
74
|
+
"./types": "./dist/types.js",
|
|
75
|
+
"./*": "./*"
|
|
76
|
+
},
|
|
77
|
+
"registry": "https://registry.npmjs.org/"
|
|
78
|
+
},
|
|
79
|
+
"license": "MIT",
|
|
80
|
+
"repository": {
|
|
81
|
+
"type": "git",
|
|
82
|
+
"url": "https://github.com/lssm-tech/contractspec.git",
|
|
83
|
+
"directory": "packages/libs/personalization"
|
|
84
|
+
},
|
|
85
|
+
"homepage": "https://contractspec.io"
|
|
86
|
+
}
|