@journeeze/sdk 0.0.0-stage → 0.1.0-rc.2
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/AGENTS.md +67 -0
- package/CHANGELOG.md +30 -0
- package/LICENSE.md +27 -0
- package/README.md +164 -2
- package/dist/THIRD_PARTY_LICENSES.txt +246 -0
- package/dist/consent-CoKD33Rm.js +170 -0
- package/dist/context-UnG6_X61.js +17 -0
- package/dist/contract.js +10 -0
- package/dist/feedback-C4CYtS2A.js +196 -0
- package/dist/help-C1x-y2f9.js +878 -0
- package/dist/hook-BdG4UL4k.js +91 -0
- package/dist/index-B_nob8S0.js +2091 -0
- package/dist/index-CfCbJJXa.js +20 -0
- package/dist/index.js +10 -0
- package/dist/loader-Ba4X-WNl.js +95 -0
- package/dist/react.js +70 -0
- package/dist/resolve-BfWByuTp.js +97 -0
- package/dist/script.js +13 -0
- package/dist/signals-E3VEdmWH.js +477 -0
- package/dist/telemetry-Cik-cYzw.js +140 -0
- package/dist/transport-B5YJFQEF.js +60 -0
- package/dist/types/config.d.ts +17 -0
- package/dist/types/context.d.ts +6 -0
- package/dist/types/contract.d.ts +13 -0
- package/dist/types/help/core/client.d.ts +26 -0
- package/dist/types/help/core/controller.d.ts +175 -0
- package/dist/types/help/core/events.d.ts +8 -0
- package/dist/types/help/core/help.d.ts +24 -0
- package/dist/types/help/core/highlight.d.ts +38 -0
- package/dist/types/help/core/panel.d.ts +11 -0
- package/dist/types/help/core/search.d.ts +7 -0
- package/dist/types/help/ui/callout.d.ts +2 -0
- package/dist/types/help/ui/panel.d.ts +3 -0
- package/dist/types/help/ui/request.d.ts +2 -0
- package/dist/types/help/ui/styles.d.ts +1 -0
- package/dist/types/index.d.ts +7 -0
- package/dist/types/invite.d.ts +4 -0
- package/dist/types/loader.d.ts +57 -0
- package/dist/types/mask.d.ts +10 -0
- package/dist/types/react.d.ts +9 -0
- package/dist/types/resolve/resolve.d.ts +12 -0
- package/dist/types/script.d.ts +6 -0
- package/dist/types/signals/cel.d.ts +8 -0
- package/dist/types/signals/hook.d.ts +10 -0
- package/dist/types/signals/signals.conformance.d.ts +2 -0
- package/dist/types/signals/signals.d.ts +145 -0
- package/dist/types/telemetry/telemetry.d.ts +63 -0
- package/dist/types/transport.d.ts +30 -0
- package/dist/types/types.d.ts +391 -0
- package/dist/types/widget/anchor.d.ts +11 -0
- package/dist/types/widget/capture.d.ts +28 -0
- package/dist/types/widget/consent.d.ts +25 -0
- package/dist/types/widget/feedback.d.ts +36 -0
- package/dist/types/widget/icons.d.ts +14 -0
- package/dist/types/widget/outbox.d.ts +69 -0
- package/dist/types/widget/styles.d.ts +1 -0
- package/dist/types/widget.d.ts +27 -0
- package/dist/types/wire.d.ts +66 -0
- package/dist/widget-DQZm8sAC.js +1599 -0
- package/package.json +68 -4
package/AGENTS.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Integrating Journeeze — guide for coding agents
|
|
2
|
+
|
|
3
|
+
Rules for an agent adding `@journeeze/sdk` to a host app. The Journeeze contracts are the source
|
|
4
|
+
of truth: SDK (C0a), transport (C0b), journeys (C0c) and signals (C0d), with the integration guide.
|
|
5
|
+
The public types in this package (`dist/types`) follow them.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
- Public on npm: `npm install @journeeze/sdk@<exact version>`. No registry config or token.
|
|
9
|
+
- Pin an exact version. `-rc.N` = release candidates (`rc` dist-tag), plain = stable (`latest`).
|
|
10
|
+
|
|
11
|
+
## Configuration
|
|
12
|
+
- `siteKey` (`pk_` + 32 hex, `SITE_KEY_PATTERN`) is **public** runtime config per site. It is not a secret.
|
|
13
|
+
- Direct mode is the default (browser → `app.journeeze.dev`, CORS for the site's allowlisted
|
|
14
|
+
origins). Set `apiHost`/`apiPath` **only** when the host runs a same-origin proxy
|
|
15
|
+
(docs/collector-proxy.md); `http:` is accepted only for `localhost`/`127.0.0.1`.
|
|
16
|
+
- CSP, if the host sends one: `script-src 'self' https://app.journeeze.dev` (+ `'wasm-unsafe-eval'`
|
|
17
|
+
only with signals), `connect-src 'self' https://app.journeeze.dev`, `img-src 'self' blob:
|
|
18
|
+
https://app.journeeze.dev`, `media-src 'self' https://app.journeeze.dev`, and pass your `nonce`.
|
|
19
|
+
Use `app.staging.journeeze.dev` for staging.
|
|
20
|
+
|
|
21
|
+
## Identity
|
|
22
|
+
- `userId` is optional. It must be `HMAC-SHA256(per-environment secret, internal user id)` computed
|
|
23
|
+
**on the server**, as 64 lowercase hex or 43 base64url characters (`USER_ID_PATTERN` from
|
|
24
|
+
`@journeeze/sdk/contract`). Never an email, name or raw id; never hashed in the browser.
|
|
25
|
+
- Deliver it only in an authenticated `Cache-Control: no-store` response for the signed-in user,
|
|
26
|
+
never in public runtime config.
|
|
27
|
+
- **Sign it (v1.3, sdk-v1.md §14).** In the same response, return `userIdExp` (Unix seconds, at
|
|
28
|
+
most 24 h ahead) and `userIdSig = base64url_nopad(HMAC-SHA256(site identity secret,
|
|
29
|
+
"jz-id-v1\n" + siteKey + "\n" + userId + "\n" + userIdExp))`, and pass both to the SDK
|
|
30
|
+
(`userIdSig`/`userIdExp` config or provider props, or `setUser(userId, { sig, exp })`). New sites
|
|
31
|
+
ignore unsigned ids: that feedback is anonymous and carries no screenshot. Check your
|
|
32
|
+
implementation against the published test vectors. The identity secret is a server secret, like
|
|
33
|
+
the HMAC secret above; re-issue the signature before it expires (the SDK never refreshes it).
|
|
34
|
+
|
|
35
|
+
## React
|
|
36
|
+
- `<JourneezeProvider siteKey={…} userId={…} context={…}>` at the app root. While `siteKey` is
|
|
37
|
+
`undefined` the provider renders with an **inert handle** (no-ops, nothing sent); the first
|
|
38
|
+
defined key creates the real handle. `useJourneeze()` never throws inside the provider.
|
|
39
|
+
- Logout is the provider's lifecycle: `userId` changing away from an id, or the provider
|
|
40
|
+
unmounting, calls `reset()`. Do **not** call `reset()` yourself inside the provider. Script-tag
|
|
41
|
+
hosts call `window.Journeeze.reset()` on every logout path.
|
|
42
|
+
- `onHelpStatus(status)` (handle option or provider prop) reports `{ available: true }` or
|
|
43
|
+
`{ available: false, reason: "disabled" | "audience" }`; hide the host's own Help control on
|
|
44
|
+
`available: false`.
|
|
45
|
+
|
|
46
|
+
## Context and privacy
|
|
47
|
+
- `context`: `persona`, `journeyId`, `journeyStep`, `device`, `businessType`, `state`.
|
|
48
|
+
`journeyId` is the journey's candidate id (C0c); `journeyStep` is a stable `stepRef` id such as
|
|
49
|
+
`route.projects.hub` — **never a URL, path or record id**. With route ids, set `pagePath: "none"`.
|
|
50
|
+
- Put `data-jz-mask` on every element showing customer content and `data-jz-block` on regions to
|
|
51
|
+
leave out of screenshots entirely. `maskSelectors` fail closed: one invalid selector disables
|
|
52
|
+
screenshots for that handle.
|
|
53
|
+
- The SDK asks for consent before any capture. Global Privacy Control is honoured
|
|
54
|
+
(`respectGlobalPrivacyControl`, default on); Do Not Track is ignored (deprecated).
|
|
55
|
+
- Give guided elements a stable `data-tflow-id`; guides fall back to test id, role + name, CSS.
|
|
56
|
+
|
|
57
|
+
## Signals (optional)
|
|
58
|
+
- `signals: { enabled: true, tflo: () => import("tflo-browser-events") }`. If the host already uses
|
|
59
|
+
`tflo-browser-events` (`>=0.1.0 <1`, optional peer dependency), **inject it** so the page has
|
|
60
|
+
one tflo runtime; otherwise the SDK lazy-loads its own copy after consent.
|
|
61
|
+
- Signals start only after the same consent as feedback, and stop when the site's kill switch is off.
|
|
62
|
+
|
|
63
|
+
## Never
|
|
64
|
+
- Put a secret in the bundle (the HMAC secret, tokens, gateway keys).
|
|
65
|
+
- Send raw user ids, emails, names, URLs or record ids anywhere (context, steps, rules, params).
|
|
66
|
+
- Load a second tflo runtime next to the host's.
|
|
67
|
+
- Disable masking or skip the consent step.
|
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## Unreleased
|
|
4
|
+
|
|
5
|
+
- **Public on npm:** published to the npm registry as `@journeeze/sdk` (no registry config or token), starting with 0.1.0-rc.2. GitHub Packages (`@matt-cochran-products/journeeze-sdk`) is no longer published. The package is licensed for use with the Journeeze service (`LICENSE.md`); it is not open source.
|
|
6
|
+
- **Signed host identity (contract C0a §4, v1.3):** `userIdSig` / `userIdExp` config fields and provider props, and `setUser(userId, { sig, exp })`. The signature is sent with feedback and end-user screenshot uploads while it is unexpired; the same id with a new signature only refreshes it. Sites that require signed identity treat an unsigned id as anonymous.
|
|
7
|
+
- The SDK's own lazy tflo copy (used only when the host injects none) is `tflo-browser-events@0.3.0`: no element text, no `document.title` and path-only URLs by default. Hosts that inject their own tflo are unaffected; the 0.1.0 capability floor is still tested.
|
|
8
|
+
|
|
9
|
+
## 0.1.0-rc.1
|
|
10
|
+
|
|
11
|
+
First release candidate of the v1 SDK (epic #75). Published to GitHub Packages as
|
|
12
|
+
`@matt-cochran-products/journeeze-sdk`; install it as `@journeeze/sdk` (see `docs/integrating.md`).
|
|
13
|
+
|
|
14
|
+
- **Contracts:** implements SDK contract v1 (C0a v1.1-r3 + v1.2), direct-mode transport (C0b v1.1-r3 +
|
|
15
|
+
v1.2), journey import (C0c v1.1-r3) and signals (C0d v1.1-r3 + v1.2), all signed off by Allumata.
|
|
16
|
+
- **Direct mode by default:** the browser talks to Journeeze directly (CORS for allowlisted origins,
|
|
17
|
+
`text/plain`, no preflight); `apiHost`/`apiPath` keep a same-origin proxy working. One 32 KiB
|
|
18
|
+
page-end budget, keepalive `fetch` first, retries honouring `Retry-After`, idempotent
|
|
19
|
+
`submissionId`.
|
|
20
|
+
- **Handle, identity and context:** `setContext`, opaque host-computed `userId` (HMAC digest only,
|
|
21
|
+
sent on feedback), `reset()` on logout, per-owner outbox and consent, React provider lifecycle
|
|
22
|
+
with an inert handle until `siteKey` is known, `pagePath: "redacted" | "none"`.
|
|
23
|
+
- **Feedback:** masked screenshots with preview before send; fail-closed `maskSelectors`;
|
|
24
|
+
`data-jz-block`; signed-in end users can attach screenshots (anonymous visitors never do).
|
|
25
|
+
- **Help:** in-app guides with fallback target resolution (tflo id → test id → role + name → CSS)
|
|
26
|
+
in its own lazy chunk; public or reviewers-only audience; `onHelpStatus` reports availability.
|
|
27
|
+
- **Signals:** opt-in, consent-gated derived signals via `tflo-browser-events` (host-injected or the
|
|
28
|
+
SDK's own lazy 0.2.0 copy); platform rules `jz-platform@1` plus registered site rules; no
|
|
29
|
+
session id, no sampling; the site kill switch is honoured.
|
|
30
|
+
- **Size:** entry ≤ 2 KiB gzipped; everything else loads lazily.
|
package/LICENSE.md
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Journeeze SDK License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Matt Cochran Products. All rights reserved.
|
|
4
|
+
|
|
5
|
+
This package (`@journeeze/sdk`) is proprietary software. It is not open source.
|
|
6
|
+
|
|
7
|
+
You may install this package and include it, unmodified, in websites and applications
|
|
8
|
+
(including bundled and minified builds) solely to connect them to the Journeeze service, under
|
|
9
|
+
the terms of your agreement for that service.
|
|
10
|
+
|
|
11
|
+
You may not:
|
|
12
|
+
|
|
13
|
+
- modify, adapt or create derivative works of this package, other than the bundling and
|
|
14
|
+
minification your build tools perform;
|
|
15
|
+
- distribute this package on its own, or as part of anything other than a website or
|
|
16
|
+
application that uses the Journeeze service;
|
|
17
|
+
- decompile, reverse engineer or otherwise attempt to derive source code from this package,
|
|
18
|
+
except to the extent applicable law expressly permits it;
|
|
19
|
+
- use this package to build or operate a product or service that competes with Journeeze.
|
|
20
|
+
|
|
21
|
+
Third-party components included in this package are licensed under their own terms; see
|
|
22
|
+
`dist/THIRD_PARTY_LICENSES.txt`.
|
|
23
|
+
|
|
24
|
+
THIS PACKAGE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
|
|
25
|
+
BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
26
|
+
NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR
|
|
27
|
+
OTHER LIABILITY ARISING FROM, OUT OF OR IN CONNECTION WITH THIS PACKAGE OR ITS USE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,165 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @journeeze/sdk
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Opt-in "suggest an improvement" mode for any website or app. A tiny loader (≤ 2 KB gz) holds
|
|
4
|
+
your options and context; the widget is lazy-loaded only when the mode is switched on.
|
|
5
|
+
Nothing observes the page while the mode is off. Inputs and editable regions are always masked,
|
|
6
|
+
and the widget asks for consent before anything is captured.
|
|
7
|
+
|
|
8
|
+
## Install and transport
|
|
9
|
+
|
|
10
|
+
Install from npm, or use the script tag served by Journeeze at `/sdk/`. The Journeeze
|
|
11
|
+
integration guide covers the full path (provisioning, CSP block, identity, help, signals,
|
|
12
|
+
checklist).
|
|
13
|
+
|
|
14
|
+
```sh
|
|
15
|
+
npm install @journeeze/sdk@<version>
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
**Direct mode (default since v1):** the SDK calls the Journeeze collector that issued your site
|
|
19
|
+
key (`https://app.journeeze.dev`) with CORS for your site's allowlisted origins
|
|
20
|
+
(`docs/contract/direct-mode-v1.md`). Requests never carry cookies or other credentials and are
|
|
21
|
+
never cached.
|
|
22
|
+
|
|
23
|
+
**Proxy mode (optional):** set `apiHost` to your own origin (`data-journeeze-api-host` on the
|
|
24
|
+
script tag; `apiPath` / `data-journeeze-api-path` for a sub-path) and proxy the collector paths
|
|
25
|
+
per `docs/collector-proxy.md`. A v0 host that relied on the old same-origin default must set
|
|
26
|
+
`apiHost: location.origin` before upgrading. `endpoint` / `data-journeeze-endpoint` still work
|
|
27
|
+
and are deprecated.
|
|
28
|
+
|
|
29
|
+
```html
|
|
30
|
+
<script type="module" src="https://app.journeeze.dev/sdk/script.js" data-journeeze-site-key="pk_..."></script>
|
|
31
|
+
<script>/* later, from your own control: */ window.Journeeze?.enable();</script>
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
```tsx
|
|
35
|
+
import { JourneezeProvider, useJourneeze } from "@journeeze/sdk/react";
|
|
36
|
+
|
|
37
|
+
<JourneezeProvider siteKey="pk_..." context={{ persona: "owner", journeyId: "r1-j09", journeyStep: "pay" }}>
|
|
38
|
+
<App />
|
|
39
|
+
</JourneezeProvider>;
|
|
40
|
+
|
|
41
|
+
const jz = useJourneeze(); jz.enable(); jz.setContext({ journeyStep: "confirm" });
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
- Keep `context` in sync with your router: the provider sets it on every change and clears values
|
|
45
|
+
a route no longer provides. The widget asks "Did this step make sense?" about the step the
|
|
46
|
+
reviewer just finished when `journeyStep` changes.
|
|
47
|
+
- Invited reviewers arrive with `?jz_invite=<token>`: the script tag and the provider read it once,
|
|
48
|
+
remove it from the URL and keep it for the tab's session (`takeReviewerToken`), unless you pass
|
|
49
|
+
`reviewerToken` yourself.
|
|
50
|
+
- `onModeChange(enabled)` tells you when the mode switches on or off, including from inside the
|
|
51
|
+
widget (Esc, Exit, "Not now").
|
|
52
|
+
|
|
53
|
+
## Signed-in users, logout and privacy options (contract v1.1)
|
|
54
|
+
|
|
55
|
+
The full contract is `docs/contract/sdk-v1.md`. The parts a host touches most:
|
|
56
|
+
|
|
57
|
+
```tsx
|
|
58
|
+
<JourneezeProvider
|
|
59
|
+
siteKey="pk_..."
|
|
60
|
+
apiHost="https://www.example.com" // proxy mode only; omit for direct mode (the default)
|
|
61
|
+
userId={user ? user.journeezeHash : undefined} // HMAC from YOUR server, never an email or raw id
|
|
62
|
+
pagePath="none" // you pass route ids (e.g. route.projects.hub) as journeyStep
|
|
63
|
+
maskSelectors={[".customer-name"]}
|
|
64
|
+
context={{ persona, journeyId, journeyStep: routeTemplate }}
|
|
65
|
+
>
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
- **`userId`** is `HMAC-SHA256(server_secret, internal_user_id)` as 64 hex or 43 base64url
|
|
69
|
+
characters, delivered in an authenticated `no-store` response. Anything else is ignored with a
|
|
70
|
+
warning; the SDK never hashes. `USER_ID_PATTERN` and the other patterns are exported from
|
|
71
|
+
`@journeeze/sdk/contract` for your server's tests.
|
|
72
|
+
- **Logout:** the provider handles it. `userId` changing away from an id, or the provider
|
|
73
|
+
unmounting, calls `reset()`. Script-tag hosts call `window.Journeeze.reset()` on every logout
|
|
74
|
+
path. `setUser(otherId)` resets first. `reset()` sends the user's unsent feedback once and
|
|
75
|
+
removes it from the device, clears context, consent and the reviewer token, and keeps help
|
|
76
|
+
available (empty) if it was on.
|
|
77
|
+
- **Masking:** inputs, editable regions, `[data-jz-mask]`, media and frames are always masked.
|
|
78
|
+
`maskSelectors` and `maskAllText` widen it; an invalid selector switches screenshots off (fails
|
|
79
|
+
closed). `[data-jz-block]` leaves an empty box and cannot be picked. Users can always send
|
|
80
|
+
without the screenshot, after seeing it full size.
|
|
81
|
+
- **Who sends a screenshot:** reviewers, and signed-in end users the host attributes with
|
|
82
|
+
`userId` on a site that accepts non-reviewer feedback; the upload is bound to that user. A fully
|
|
83
|
+
anonymous visitor never captures or sends one, and the consent copy says so (ADR 0013 §4).
|
|
84
|
+
- **`pagePath`:** `"redacted"` (default) replaces id-like path segments with `:id`; `"none"` sends
|
|
85
|
+
no path.
|
|
86
|
+
- **`nonce`** is set on the SDK's `<style>` elements for strict CSPs; Global Privacy Control turns
|
|
87
|
+
help telemetry off (`respectGlobalPrivacyControl`, default `true`).
|
|
88
|
+
|
|
89
|
+
## In-app help
|
|
90
|
+
|
|
91
|
+
Help is independent of the feedback mode. It shows a launcher that opens guides built from the
|
|
92
|
+
site's published journeys, with search, step-by-step guidance that outlines each step's element,
|
|
93
|
+
and an optional "Did this step make sense?" check-in. Reading guides needs no consent; nothing
|
|
94
|
+
of the help chunk loads or listens on the page until you switch it on.
|
|
95
|
+
|
|
96
|
+
```html
|
|
97
|
+
<script type="module" src="https://<cdn>/journeeze/script.js" data-journeeze-site-key="pk_..." data-journeeze-help></script>
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
```tsx
|
|
101
|
+
const jz = useJourneeze();
|
|
102
|
+
await jz.enableHelp(); // lazy-loads the help chunk and shows the launcher
|
|
103
|
+
jz.isHelpEnabled(); // true
|
|
104
|
+
jz.disableHelp(); // removes the launcher and panel
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
To hide your own Help control when help isn't for this user, pass `onHelpStatus` (or the React
|
|
108
|
+
provider's `onHelpStatus` prop). After `enableHelp()` checks the site it is called with
|
|
109
|
+
`{ available: true }`, or `{ available: false, reason: "disabled" }` (the site has help off) or
|
|
110
|
+
`{ available: false, reason: "audience" }` (reviewers-only help and no reviewer token), and again
|
|
111
|
+
if that changes.
|
|
112
|
+
|
|
113
|
+
- `data-journeeze-help` on the script tag calls `enableHelp()` for you; a failed chunk load never
|
|
114
|
+
surfaces as an unhandled rejection.
|
|
115
|
+
- Help reads guides with the collector RPCs `GetHelpIndex` and `GetGuide`, and loads step
|
|
116
|
+
screenshots, the guide video and its captions from `GET /journeeze.collector.v1/guide-assets/*`
|
|
117
|
+
(short-lived signed links). Your proxy must forward that prefix and `GET /sdk/*` (the chunks)
|
|
118
|
+
in addition to the feedback paths; see `docs/collector-proxy.md`.
|
|
119
|
+
- Steps are anchored to `data-tflow-id` names. A step whose element isn't on the current page
|
|
120
|
+
shows its text without an outline.
|
|
121
|
+
- If help is switched off for the site (the site's help settings on the board's **Settings** screen), the launcher renders nothing.
|
|
122
|
+
|
|
123
|
+
**Publishing guides.** Guides come from Jevitate journeys. An operator imports them into the
|
|
124
|
+
project with `journeeze import-journeys --project <id> <.jevitate/journeys dir>`; each journey
|
|
125
|
+
arrives as a draft. A triager reviews it on the board's **Journeys** screen (light edits to step
|
|
126
|
+
text are allowed) and publishes it. Only published guides appear in help; a guide whose source
|
|
127
|
+
journey changed goes stale until the new import is adopted.
|
|
128
|
+
|
|
129
|
+
Mark elements with `data-tflow-id="area.element"` to anchor feedback to stable names, and
|
|
130
|
+
`data-jz-mask` to mask extra regions (form fields and `contenteditable` regions are always masked).
|
|
131
|
+
|
|
132
|
+
License: undecided (`UNLICENSED`); packaged so it can be open-sourced later.
|
|
133
|
+
|
|
134
|
+
## Signals (signal contract C0d)
|
|
135
|
+
|
|
136
|
+
Aggregate-only behaviour signals (`docs/contract/signals-v1.md`): rage clicks, dead clicks,
|
|
137
|
+
hesitation, abandoned journey steps, and your own registered site signals. Raw events never
|
|
138
|
+
leave the page; only derived signals are sent, through a closed allowlist, with no URL, text,
|
|
139
|
+
user id or session id.
|
|
140
|
+
|
|
141
|
+
```ts
|
|
142
|
+
createJourneeze({
|
|
143
|
+
siteKey,
|
|
144
|
+
signals: {
|
|
145
|
+
enabled: true,
|
|
146
|
+
// Pass your own tflo module so the page runs one tflo runtime (recommended if you use tflo):
|
|
147
|
+
tflo: () => import("tflo-browser-events"),
|
|
148
|
+
// Optional site rules; each name must be registered for the site in Journeeze first.
|
|
149
|
+
rules: [{ name: "export_clicked", when: 'event.kind == "click" && event.fields.target == "export.button"' }],
|
|
150
|
+
},
|
|
151
|
+
});
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
- **When they run:** only after the visitor's consent, while help or feedback mode is on, with
|
|
155
|
+
`signals.enabled: true` and the site's signals switch on in Journeeze. Global Privacy Control
|
|
156
|
+
turns them off. Before that, no signals or tflo code is loaded.
|
|
157
|
+
- **What is tracked:** elements with a `data-tflow-id` (`[a-z0-9._:-]`, up to 96 characters)
|
|
158
|
+
outside `data-jz-mask` / `data-jz-block` regions and form fields. The SDK listens to `click`,
|
|
159
|
+
`pointerover`/`pointerout`, `focusin`/`focusout` and `change` only: never keys, input or pointer
|
|
160
|
+
moves, and it never patches `fetch` or XHR.
|
|
161
|
+
- **tflo:** without `signals.tflo` the SDK loads its own copy as a separate lazy chunk with the
|
|
162
|
+
WASM inlined. Under a Content-Security-Policy that needs `script-src 'wasm-unsafe-eval'` and
|
|
163
|
+
`connect-src data:`; injecting your own module avoids the second.
|
|
164
|
+
- **Journeys:** set `journeyId` and `journeyStep` with `setContext`; `journeyStep` must equal the
|
|
165
|
+
published journey's step ids (its `stepRef`s) for `abandoned_step` to apply.
|
|
@@ -0,0 +1,246 @@
|
|
|
1
|
+
Third-party software bundled in @journeeze/sdk. Each notice below applies to the named package.
|
|
2
|
+
|
|
3
|
+
------------------------------------------------------------------------
|
|
4
|
+
|
|
5
|
+
modern-screenshot@4.7.0 (MIT)
|
|
6
|
+
|
|
7
|
+
The MIT License (MIT)
|
|
8
|
+
|
|
9
|
+
Copyright (c) 2021-present wxm
|
|
10
|
+
|
|
11
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
12
|
+
|
|
13
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
16
|
+
|
|
17
|
+
------------------------------------------------------------------------
|
|
18
|
+
|
|
19
|
+
tflo-browser-events@0.3.0 ((MIT OR Apache-2.0))
|
|
20
|
+
|
|
21
|
+
LICENSE-APACHE:
|
|
22
|
+
|
|
23
|
+
Apache License
|
|
24
|
+
Version 2.0, January 2004
|
|
25
|
+
http://www.apache.org/licenses/
|
|
26
|
+
|
|
27
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
28
|
+
|
|
29
|
+
1. Definitions.
|
|
30
|
+
|
|
31
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
32
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
33
|
+
|
|
34
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
35
|
+
the copyright owner that is granting the License.
|
|
36
|
+
|
|
37
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
38
|
+
other entities that control, are controlled by, or are under common
|
|
39
|
+
control with that entity. For the purposes of this definition,
|
|
40
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
41
|
+
direction or management of such entity, whether by contract or
|
|
42
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
43
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
44
|
+
|
|
45
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
46
|
+
exercising permissions granted by this License.
|
|
47
|
+
|
|
48
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
49
|
+
including but not limited to software source code, documentation
|
|
50
|
+
source, and configuration files.
|
|
51
|
+
|
|
52
|
+
"Object" form shall mean any form resulting from mechanical
|
|
53
|
+
transformation or translation of a Source form, including but
|
|
54
|
+
not limited to compiled object code, generated documentation,
|
|
55
|
+
and conversions to other media types.
|
|
56
|
+
|
|
57
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
58
|
+
Object form, made available under the License, as indicated by a
|
|
59
|
+
copyright notice that is included in or attached to the work
|
|
60
|
+
(an example is provided in the Appendix below).
|
|
61
|
+
|
|
62
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
63
|
+
form, that is based on (or derived from) the Work and for which the
|
|
64
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
65
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
66
|
+
of this License, Derivative Works shall not include works that remain
|
|
67
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
68
|
+
the Work and Derivative Works thereof.
|
|
69
|
+
|
|
70
|
+
"Contribution" shall mean any work of authorship, including
|
|
71
|
+
the original version of the Work and any modifications or additions
|
|
72
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
73
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
74
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
75
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
76
|
+
means any form of electronic, verbal, or written communication sent
|
|
77
|
+
to the Licensor or its representatives, including but not limited to
|
|
78
|
+
communication on electronic mailing lists, source code control systems,
|
|
79
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
80
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
81
|
+
excluding communication that is conspicuously marked or otherwise
|
|
82
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
83
|
+
|
|
84
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
85
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
86
|
+
subsequently incorporated within the Work.
|
|
87
|
+
|
|
88
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
89
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
90
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
91
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
92
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
93
|
+
Work and such Derivative Works in Source or Object form.
|
|
94
|
+
|
|
95
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
96
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
97
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
98
|
+
(except as stated in this section) patent license to make, have made,
|
|
99
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
100
|
+
where such license applies only to those patent claims licensable
|
|
101
|
+
by such Contributor that are necessarily infringed by their
|
|
102
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
103
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
104
|
+
institute patent litigation against any entity (including a
|
|
105
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
106
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
107
|
+
or contributory patent infringement, then any patent licenses
|
|
108
|
+
granted to You under this License for that Work shall terminate
|
|
109
|
+
as of the date such litigation is filed.
|
|
110
|
+
|
|
111
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
112
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
113
|
+
modifications, and in Source or Object form, provided that You
|
|
114
|
+
meet the following conditions:
|
|
115
|
+
|
|
116
|
+
(a) You must give any other recipients of the Work or
|
|
117
|
+
Derivative Works a copy of this License; and
|
|
118
|
+
|
|
119
|
+
(b) You must cause any modified files to carry prominent notices
|
|
120
|
+
stating that You changed the files; and
|
|
121
|
+
|
|
122
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
123
|
+
that You distribute, all copyright, patent, trademark, and
|
|
124
|
+
attribution notices from the Source form of the Work,
|
|
125
|
+
excluding those notices that do not pertain to any part of
|
|
126
|
+
the Derivative Works; and
|
|
127
|
+
|
|
128
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
129
|
+
distribution, then any Derivative Works that You distribute must
|
|
130
|
+
include a readable copy of the attribution notices contained
|
|
131
|
+
within such NOTICE file, excluding those notices that do not
|
|
132
|
+
pertain to any part of the Derivative Works, in at least one
|
|
133
|
+
of the following places: within a NOTICE text file distributed
|
|
134
|
+
as part of the Derivative Works; within the Source form or
|
|
135
|
+
documentation, if provided along with the Derivative Works; or,
|
|
136
|
+
within a display generated by the Derivative Works, if and
|
|
137
|
+
wherever such third-party notices normally appear. The contents
|
|
138
|
+
of the NOTICE file are for informational purposes only and
|
|
139
|
+
do not modify the License. You may add Your own attribution
|
|
140
|
+
notices within Derivative Works that You distribute, alongside
|
|
141
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
142
|
+
that such additional attribution notices cannot be construed
|
|
143
|
+
as modifying the License.
|
|
144
|
+
|
|
145
|
+
You may add Your own copyright statement to Your modifications and
|
|
146
|
+
may provide additional or different license terms and conditions
|
|
147
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
148
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
149
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
150
|
+
the conditions stated in this License.
|
|
151
|
+
|
|
152
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
153
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
154
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
155
|
+
this License, without any additional terms or conditions.
|
|
156
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
157
|
+
the terms of any separate license agreement you may have executed
|
|
158
|
+
with Licensor regarding such Contributions.
|
|
159
|
+
|
|
160
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
161
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
162
|
+
except as required for reasonable and customary use in describing the
|
|
163
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
164
|
+
|
|
165
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
166
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
167
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
168
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
169
|
+
implied, including, without limitation, any warranties or conditions
|
|
170
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
171
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
172
|
+
appropriateness of using or redistributing the Work and assume any
|
|
173
|
+
risks associated with Your exercise of permissions under this License.
|
|
174
|
+
|
|
175
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
176
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
177
|
+
unless required by applicable law (such as deliberate and grossly
|
|
178
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
179
|
+
liable to You for damages, including any direct, indirect, special,
|
|
180
|
+
incidental, or consequential damages of any character arising as a
|
|
181
|
+
result of this License or out of the use or inability to use the
|
|
182
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
183
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
184
|
+
other commercial damages or losses), even if such Contributor
|
|
185
|
+
has been advised of the possibility of such damages.
|
|
186
|
+
|
|
187
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
188
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
189
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
190
|
+
or other liability obligations and/or rights consistent with this
|
|
191
|
+
License. However, in accepting such obligations, You may act only
|
|
192
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
193
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
194
|
+
defend, and hold each Contributor harmless for any liability
|
|
195
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
196
|
+
of your accepting any such warranty or additional liability.
|
|
197
|
+
|
|
198
|
+
END OF TERMS AND CONDITIONS
|
|
199
|
+
|
|
200
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
201
|
+
|
|
202
|
+
To apply the Apache License to your work, attach the following
|
|
203
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
204
|
+
replaced with your own identifying information. (Don't include
|
|
205
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
206
|
+
comment syntax for the file format. We also recommend that a
|
|
207
|
+
file or class name and description of purpose be included on the
|
|
208
|
+
same "printed page" as the copyright notice for easier
|
|
209
|
+
identification within third-party archives.
|
|
210
|
+
|
|
211
|
+
Copyright [yyyy] [name of copyright owner]
|
|
212
|
+
|
|
213
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
214
|
+
you may not use this file except in compliance with the License.
|
|
215
|
+
You may obtain a copy of the License at
|
|
216
|
+
|
|
217
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
218
|
+
|
|
219
|
+
Unless required by applicable law or agreed to in writing, software
|
|
220
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
221
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
222
|
+
See the License for the specific language governing permissions and
|
|
223
|
+
limitations under the License.
|
|
224
|
+
|
|
225
|
+
LICENSE-MIT:
|
|
226
|
+
|
|
227
|
+
Copyright (c) 2026 Matt Cochran
|
|
228
|
+
|
|
229
|
+
Permission is hereby granted, free of charge, to any person obtaining a
|
|
230
|
+
copy of this software and associated documentation files (the
|
|
231
|
+
"Software"), to deal in the Software without restriction, including
|
|
232
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
|
233
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
|
234
|
+
permit persons to whom the Software is furnished to do so, subject to
|
|
235
|
+
the following conditions:
|
|
236
|
+
|
|
237
|
+
The above copyright notice and this permission notice shall be included
|
|
238
|
+
in all copies or substantial portions of the Software.
|
|
239
|
+
|
|
240
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
241
|
+
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
242
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
243
|
+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
244
|
+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
245
|
+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
246
|
+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|