@dealsystem/site 0.0.0-stage → 0.2.1
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/README.md +145 -2
- package/agent-files/claude/skills/angebote-einbauen/SKILL.md +30 -0
- package/agent-files/claude/skills/bild-einbauen/SKILL.md +43 -0
- package/agent-files/claude/skills/domain-verbinden/SKILL.md +23 -0
- package/agent-files/claude/skills/erster-entwurf/SKILL.md +54 -0
- package/agent-files/claude/skills/extern-einbinden/SKILL.md +37 -0
- package/agent-files/claude/skills/formular-anbinden/SKILL.md +34 -0
- package/agent-files/claude/skills/funnel-mehrstufig/BewertungFunnel.svelte +220 -0
- package/agent-files/claude/skills/funnel-mehrstufig/SKILL.md +101 -0
- package/agent-files/claude/skills/neue-seite/SKILL.md +47 -0
- package/agent-files/claude/skills/prueffehler-beheben/SKILL.md +31 -0
- package/agent-files/claude/skills/termin-buchung/SKILL.md +51 -0
- package/agent-files/claude/skills/veroeffentlichen/SKILL.md +38 -0
- package/agent-files/cursor/rules/dealsystem.mdc +7 -0
- package/agent-files/manifest.json +101 -0
- package/contract/README.md +41 -0
- package/contract/ds-content.v1.json +2355 -0
- package/contract/external-presets.v1.json +65 -0
- package/contract/funnel-code-config.md +87 -0
- package/contract/site-api.v1.json +3916 -0
- package/dist/client/altcha-workers.d.ts +10 -0
- package/dist/client/attribution.d.ts +119 -0
- package/dist/client/attribution.js +341 -0
- package/dist/client/bookingClient.svelte.d.ts +166 -0
- package/dist/client/bookingClient.svelte.js +369 -0
- package/dist/client/bookingTime.d.ts +46 -0
- package/dist/client/bookingTime.js +109 -0
- package/dist/client/captcha.d.ts +26 -0
- package/dist/client/captcha.js +71 -0
- package/dist/client/captchaSession.d.ts +21 -0
- package/dist/client/captchaSession.js +105 -0
- package/dist/client/collections.d.ts +34 -0
- package/dist/client/collections.js +40 -0
- package/dist/client/externalScript.d.ts +20 -0
- package/dist/client/externalScript.js +36 -0
- package/dist/client/funnelState.svelte.d.ts +47 -0
- package/dist/client/funnelState.svelte.js +81 -0
- package/dist/client/leadClient.svelte.d.ts +131 -0
- package/dist/client/leadClient.svelte.js +250 -0
- package/dist/client/pageview.d.ts +7 -0
- package/dist/client/pageview.js +44 -0
- package/dist/client/siteApi.d.ts +211 -0
- package/dist/client/siteApi.js +320 -0
- package/dist/client/tracking.d.ts +18 -0
- package/dist/client/tracking.js +93 -0
- package/dist/client/validation.d.ts +10 -0
- package/dist/client/validation.js +66 -0
- package/dist/components/Booker.svelte +729 -0
- package/dist/components/Booker.svelte.d.ts +42 -0
- package/dist/components/CollectionList.svelte +122 -0
- package/dist/components/CollectionList.svelte.d.ts +65 -0
- package/dist/components/ConsentGate.svelte +68 -0
- package/dist/components/ConsentGate.svelte.d.ts +44 -0
- package/dist/components/CookieBanner.svelte +303 -0
- package/dist/components/CookieBanner.svelte.d.ts +29 -0
- package/dist/components/Datenschutz.svelte +84 -0
- package/dist/components/Datenschutz.svelte.d.ts +26 -0
- package/dist/components/Embed.svelte +263 -0
- package/dist/components/Embed.svelte.d.ts +41 -0
- package/dist/components/ExternalScript.svelte +94 -0
- package/dist/components/ExternalScript.svelte.d.ts +41 -0
- package/dist/components/Impressum.svelte +59 -0
- package/dist/components/Impressum.svelte.d.ts +25 -0
- package/dist/components/LeadForm.svelte +475 -0
- package/dist/components/LeadForm.svelte.d.ts +35 -0
- package/dist/components/LeadHoneypot.svelte +43 -0
- package/dist/components/LeadHoneypot.svelte.d.ts +18 -0
- package/dist/components/Link.svelte +48 -0
- package/dist/components/Link.svelte.d.ts +30 -0
- package/dist/components/MapEmbed.svelte +154 -0
- package/dist/components/MapEmbed.svelte.d.ts +28 -0
- package/dist/components/MediaImage.svelte +218 -0
- package/dist/components/MediaImage.svelte.d.ts +128 -0
- package/dist/components/MediaVideo.svelte +103 -0
- package/dist/components/MediaVideo.svelte.d.ts +20 -0
- package/dist/components/RichText.svelte +105 -0
- package/dist/components/RichText.svelte.d.ts +55 -0
- package/dist/components/Seo.svelte +89 -0
- package/dist/components/Seo.svelte.d.ts +45 -0
- package/dist/components/SiteFooterLegal.svelte +75 -0
- package/dist/components/SiteFooterLegal.svelte.d.ts +22 -0
- package/dist/components/SiteHead.svelte +79 -0
- package/dist/components/SiteHead.svelte.d.ts +32 -0
- package/dist/components/Text.svelte +100 -0
- package/dist/components/Text.svelte.d.ts +55 -0
- package/dist/components/Tracking.svelte +30 -0
- package/dist/components/Tracking.svelte.d.ts +14 -0
- package/dist/components/Zeitfenster.svelte +92 -0
- package/dist/components/Zeitfenster.svelte.d.ts +34 -0
- package/dist/components/legal.d.ts +12 -0
- package/dist/components/legal.js +27 -0
- package/dist/config/index.d.ts +121 -0
- package/dist/config/index.js +602 -0
- package/dist/config/static/index.d.ts +3 -0
- package/dist/config/static/index.js +5 -0
- package/dist/config/static/lines.d.ts +9 -0
- package/dist/config/static/lines.js +22 -0
- package/dist/config/static/literal.d.ts +45 -0
- package/dist/config/static/literal.js +175 -0
- package/dist/config/static/siteConfig.d.ts +39 -0
- package/dist/config/static/siteConfig.js +150 -0
- package/dist/consent/consent.svelte.d.ts +91 -0
- package/dist/consent/consent.svelte.js +221 -0
- package/dist/content/index.d.ts +123 -0
- package/dist/content/index.js +247 -0
- package/dist/contentBlock.d.ts +45 -0
- package/dist/contentBlock.js +78 -0
- package/dist/csp/index.d.ts +27 -0
- package/dist/csp/index.js +74 -0
- package/dist/external/csp.d.ts +25 -0
- package/dist/external/csp.js +104 -0
- package/dist/external/hosts.d.ts +30 -0
- package/dist/external/hosts.js +128 -0
- package/dist/external/presets.d.ts +54 -0
- package/dist/external/presets.js +212 -0
- package/dist/external/resolve.d.ts +39 -0
- package/dist/external/resolve.js +254 -0
- package/dist/index.d.ts +32 -0
- package/dist/index.js +32 -0
- package/dist/internal/consentNeed.d.ts +21 -0
- package/dist/internal/consentNeed.js +50 -0
- package/dist/internal/dealsystem-legal-imprint.d.ts +2 -0
- package/dist/internal/dealsystem-legal-imprint.js +5 -0
- package/dist/internal/dealsystem-legal-privacy.d.ts +2 -0
- package/dist/internal/dealsystem-legal-privacy.js +5 -0
- package/dist/internal/dealsystem-site-data.d.ts +3 -0
- package/dist/internal/dealsystem-site-data.js +2 -0
- package/dist/internal/imprint.d.ts +4 -0
- package/dist/internal/imprint.js +10 -0
- package/dist/internal/mediaImage.d.ts +15 -0
- package/dist/internal/mediaImage.js +22 -0
- package/dist/internal/privacy.d.ts +4 -0
- package/dist/internal/privacy.js +10 -0
- package/dist/internal/providers.d.ts +9 -0
- package/dist/internal/providers.js +44 -0
- package/dist/internal/reload.d.ts +2 -0
- package/dist/internal/reload.js +5 -0
- package/dist/internal/seo.d.ts +41 -0
- package/dist/internal/seo.js +79 -0
- package/dist/internal/siteData.d.ts +7 -0
- package/dist/internal/siteData.js +39 -0
- package/dist/internal/usage.d.ts +7 -0
- package/dist/internal/usage.js +13 -0
- package/dist/keys.d.ts +20 -0
- package/dist/keys.js +58 -0
- package/dist/leadmagnet.d.ts +16 -0
- package/dist/leadmagnet.js +28 -0
- package/dist/paths.d.ts +8 -0
- package/dist/paths.js +9 -0
- package/dist/richtext/escape.d.ts +4 -0
- package/dist/richtext/escape.js +18 -0
- package/dist/richtext/server.d.ts +16 -0
- package/dist/richtext/server.js +123 -0
- package/dist/schedule.d.ts +23 -0
- package/dist/schedule.js +67 -0
- package/dist/slots.d.ts +9 -0
- package/dist/slots.js +38 -0
- package/dist/snapshot.d.ts +14 -0
- package/dist/snapshot.js +214 -0
- package/dist/types.d.ts +550 -0
- package/dist/types.js +4 -0
- package/dist/version.d.ts +2 -0
- package/dist/version.js +2 -0
- package/dist/vite/index.d.ts +85 -0
- package/dist/vite/index.js +641 -0
- package/dist/vite/scan.d.ts +47 -0
- package/dist/vite/scan.js +355 -0
- package/dist/vite/zeitfenster.d.ts +18 -0
- package/dist/vite/zeitfenster.js +76 -0
- package/docs/ablauf.md +191 -0
- package/docs/agents-block.md +101 -0
- package/docs/befehle.md +103 -0
- package/docs/extern.md +143 -0
- package/docs/gestaltung.md +139 -0
- package/docs/inhalte.md +224 -0
- package/docs/komponenten.md +1273 -0
- package/docs/konfiguration.md +310 -0
- package/docs/llms.txt +19 -0
- package/docs/rechtstexte.md +84 -0
- package/docs/regeln.md +108 -0
- package/docs/seo.md +55 -0
- package/docs/termine.md +73 -0
- package/package.json +115 -5
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
// Sicherheitsprüfung (ALTCHA) einer Einsendung, gemeinsam für `createLeadClient` und `createBookingClient`:
|
|
2
|
+
// startet beim ersten Anfassen, löst unsichtbar im Web Worker, eine Lösung gilt genau einmal. Ein Weg für
|
|
3
|
+
// Formular und Buchung, damit beide denselben Schutz haben.
|
|
4
|
+
import { captchaAdapter } from './captcha.js';
|
|
5
|
+
import { captchaChallengeUrl } from './siteApi.js';
|
|
6
|
+
const CAPTCHA_TIMEOUT_MS = 60_000;
|
|
7
|
+
/** @internal */
|
|
8
|
+
export function createCaptchaSession(options) {
|
|
9
|
+
let state = 'idle';
|
|
10
|
+
let solution = null;
|
|
11
|
+
let handle = null;
|
|
12
|
+
let host = null;
|
|
13
|
+
let ownHost = false;
|
|
14
|
+
let destroyed = false;
|
|
15
|
+
const waiters = [];
|
|
16
|
+
function settle(value) {
|
|
17
|
+
for (const resolve of waiters.splice(0))
|
|
18
|
+
resolve(value);
|
|
19
|
+
}
|
|
20
|
+
function captchaHost() {
|
|
21
|
+
const given = options.element?.();
|
|
22
|
+
if (given)
|
|
23
|
+
return given;
|
|
24
|
+
if (!host) {
|
|
25
|
+
host = document.createElement('div');
|
|
26
|
+
host.hidden = true;
|
|
27
|
+
host.dataset.dsCaptcha = options.name;
|
|
28
|
+
document.body.append(host);
|
|
29
|
+
ownHost = true;
|
|
30
|
+
}
|
|
31
|
+
return host;
|
|
32
|
+
}
|
|
33
|
+
async function start() {
|
|
34
|
+
if (state !== 'idle' || destroyed || typeof window === 'undefined')
|
|
35
|
+
return;
|
|
36
|
+
state = 'loading';
|
|
37
|
+
try {
|
|
38
|
+
handle = await captchaAdapter()(captchaHost(), captchaChallengeUrl(), {
|
|
39
|
+
onSolved(payload) {
|
|
40
|
+
solution = payload;
|
|
41
|
+
state = 'ready';
|
|
42
|
+
settle(payload);
|
|
43
|
+
},
|
|
44
|
+
onCleared() {
|
|
45
|
+
solution = null;
|
|
46
|
+
state = 'expired';
|
|
47
|
+
},
|
|
48
|
+
onError() {
|
|
49
|
+
solution = null;
|
|
50
|
+
state = 'failed';
|
|
51
|
+
settle(null);
|
|
52
|
+
},
|
|
53
|
+
});
|
|
54
|
+
if (state === 'loading')
|
|
55
|
+
state = 'solving';
|
|
56
|
+
}
|
|
57
|
+
catch {
|
|
58
|
+
state = 'failed';
|
|
59
|
+
settle(null);
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
return {
|
|
63
|
+
start() {
|
|
64
|
+
void start();
|
|
65
|
+
},
|
|
66
|
+
solution() {
|
|
67
|
+
if (state === 'ready' && solution)
|
|
68
|
+
return Promise.resolve(solution);
|
|
69
|
+
const waiting = new Promise((resolve) => {
|
|
70
|
+
waiters.push(resolve);
|
|
71
|
+
setTimeout(() => resolve(null), CAPTCHA_TIMEOUT_MS);
|
|
72
|
+
});
|
|
73
|
+
if (state === 'failed') {
|
|
74
|
+
handle?.destroy();
|
|
75
|
+
handle = null;
|
|
76
|
+
state = 'idle';
|
|
77
|
+
}
|
|
78
|
+
if (state === 'idle')
|
|
79
|
+
void start();
|
|
80
|
+
else if (state === 'expired' || (state === 'ready' && !solution)) {
|
|
81
|
+
state = 'solving';
|
|
82
|
+
handle?.reset();
|
|
83
|
+
}
|
|
84
|
+
return waiting;
|
|
85
|
+
},
|
|
86
|
+
consume() {
|
|
87
|
+
solution = null;
|
|
88
|
+
if (handle && state !== 'failed') {
|
|
89
|
+
state = 'solving';
|
|
90
|
+
handle.reset();
|
|
91
|
+
}
|
|
92
|
+
},
|
|
93
|
+
clear() {
|
|
94
|
+
solution = null;
|
|
95
|
+
},
|
|
96
|
+
destroy() {
|
|
97
|
+
destroyed = true;
|
|
98
|
+
handle?.destroy();
|
|
99
|
+
handle = null;
|
|
100
|
+
if (ownHost)
|
|
101
|
+
host?.remove();
|
|
102
|
+
settle(null);
|
|
103
|
+
},
|
|
104
|
+
};
|
|
105
|
+
}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import type { CollectionEntry, CollectionKey } from '../types.js';
|
|
2
|
+
import { type SiteApiResult } from './siteApi.js';
|
|
3
|
+
/** Ergebnis von `loadCollection`. */
|
|
4
|
+
export interface LoadedCollection<K extends string> {
|
|
5
|
+
entries: CollectionEntry<K>[];
|
|
6
|
+
/** Gesamtzahl der veröffentlichten Einträge, `null` wenn unbekannt. */
|
|
7
|
+
total: number | null;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Lädt Einträge einer Sammlung **im Browser** über die Site-API, z. B. für
|
|
11
|
+
* „Mehr laden“. Wirft nie: das Ergebnis ist `{ ok: true, data }` oder
|
|
12
|
+
* `{ ok: false, error }`. Ohne `limit` kommen 20 Einträge, höchstens 100 je
|
|
13
|
+
* Abruf; `total` nennt die Gesamtzahl, weitere holt `offset`. Inhalte, die Suchmaschinen sehen sollen, lädt
|
|
14
|
+
* stattdessen `getCollection()` aus `@dealsystem/site/content` beim Build.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* const result = await loadCollection('angebote', { limit: 12, offset: 12 });
|
|
18
|
+
* if (result.ok) angebote.push(...result.data.entries);
|
|
19
|
+
* else meldung = result.error.message;
|
|
20
|
+
*/
|
|
21
|
+
export declare function loadCollection<K extends CollectionKey>(key: K, query?: {
|
|
22
|
+
limit?: number;
|
|
23
|
+
offset?: number;
|
|
24
|
+
sort?: 'newest' | 'oldest';
|
|
25
|
+
}): Promise<SiteApiResult<LoadedCollection<K>>>;
|
|
26
|
+
/**
|
|
27
|
+
* Lädt einen Eintrag **im Browser** über die Site-API. Wirft nie; ein
|
|
28
|
+
* unbekannter Slug ergibt `{ ok: false, error: { kind: 'not_found' } }`.
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
* const result = await loadEntry('angebote', 'altbau-leipzig');
|
|
32
|
+
* if (result.ok) angebot = result.data;
|
|
33
|
+
*/
|
|
34
|
+
export declare function loadEntry<K extends CollectionKey>(key: K, slug: string): Promise<SiteApiResult<CollectionEntry<K>>>;
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { siteApi } from './siteApi.js';
|
|
2
|
+
// Richtext-Felder liefert die Site-API schon als bereinigtes HTML.
|
|
3
|
+
function toEntry(raw) {
|
|
4
|
+
return raw;
|
|
5
|
+
}
|
|
6
|
+
/**
|
|
7
|
+
* Lädt Einträge einer Sammlung **im Browser** über die Site-API, z. B. für
|
|
8
|
+
* „Mehr laden“. Wirft nie: das Ergebnis ist `{ ok: true, data }` oder
|
|
9
|
+
* `{ ok: false, error }`. Ohne `limit` kommen 20 Einträge, höchstens 100 je
|
|
10
|
+
* Abruf; `total` nennt die Gesamtzahl, weitere holt `offset`. Inhalte, die Suchmaschinen sehen sollen, lädt
|
|
11
|
+
* stattdessen `getCollection()` aus `@dealsystem/site/content` beim Build.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* const result = await loadCollection('angebote', { limit: 12, offset: 12 });
|
|
15
|
+
* if (result.ok) angebote.push(...result.data.entries);
|
|
16
|
+
* else meldung = result.error.message;
|
|
17
|
+
*/
|
|
18
|
+
export async function loadCollection(key, query = {}) {
|
|
19
|
+
const result = await siteApi().getCollection(key, query);
|
|
20
|
+
if (!result.ok)
|
|
21
|
+
return result;
|
|
22
|
+
return {
|
|
23
|
+
ok: true,
|
|
24
|
+
data: { entries: result.data.entries.map((e) => toEntry(e)), total: result.data.total },
|
|
25
|
+
};
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Lädt einen Eintrag **im Browser** über die Site-API. Wirft nie; ein
|
|
29
|
+
* unbekannter Slug ergibt `{ ok: false, error: { kind: 'not_found' } }`.
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* const result = await loadEntry('angebote', 'altbau-leipzig');
|
|
33
|
+
* if (result.ok) angebot = result.data;
|
|
34
|
+
*/
|
|
35
|
+
export async function loadEntry(key, slug) {
|
|
36
|
+
const result = await siteApi().getEntry(key, slug);
|
|
37
|
+
if (!result.ok)
|
|
38
|
+
return result;
|
|
39
|
+
return { ok: true, data: toEntry(result.data) };
|
|
40
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/** Zusätzliche Attribute eines Skripts. Nur diese, damit kein Inline-Code und keine Event-Handler entstehen. */
|
|
2
|
+
export interface ExternalScriptAttrs {
|
|
3
|
+
async?: boolean;
|
|
4
|
+
defer?: boolean;
|
|
5
|
+
/** Manche Anbieter erwarten eine feste Kennung, z. B. `hs-script-loader`. */
|
|
6
|
+
id?: string;
|
|
7
|
+
type?: 'module' | 'text/javascript';
|
|
8
|
+
crossorigin?: 'anonymous' | 'use-credentials';
|
|
9
|
+
referrerpolicy?: 'no-referrer' | 'origin' | 'strict-origin' | 'strict-origin-when-cross-origin';
|
|
10
|
+
[data: `data-${string}`]: string;
|
|
11
|
+
}
|
|
12
|
+
/** Attribute, die nicht erlaubt sind. Leere Liste heißt: alles in Ordnung. */
|
|
13
|
+
export declare function invalidScriptAttrs(attrs: Record<string, unknown> | undefined): string[];
|
|
14
|
+
/**
|
|
15
|
+
* Hängt das Skript einmal je Seite an `<head>`. Gibt `true` zurück, wenn es neu angehängt wurde.
|
|
16
|
+
* @internal
|
|
17
|
+
*/
|
|
18
|
+
export declare function loadExternalScript(src: string, attrs?: ExternalScriptAttrs): boolean;
|
|
19
|
+
/** @internal Nur für Tests. */
|
|
20
|
+
export declare function resetExternalScriptsForTests(): void;
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
// Lädt ein fremdes oder eigenes Skript für <ExternalScript>. Aufruf nur nach der Einwilligung der Kategorie.
|
|
2
|
+
const ALLOWED = new Set(['async', 'defer', 'id', 'type', 'crossorigin', 'referrerpolicy']);
|
|
3
|
+
const DATA_ATTR = /^data-[a-z0-9-]{1,64}$/;
|
|
4
|
+
/** Attribute, die nicht erlaubt sind. Leere Liste heißt: alles in Ordnung. */
|
|
5
|
+
export function invalidScriptAttrs(attrs) {
|
|
6
|
+
return Object.keys(attrs ?? {}).filter((name) => !ALLOWED.has(name) && !DATA_ATTR.test(name));
|
|
7
|
+
}
|
|
8
|
+
const loaded = new Set();
|
|
9
|
+
/**
|
|
10
|
+
* Hängt das Skript einmal je Seite an `<head>`. Gibt `true` zurück, wenn es neu angehängt wurde.
|
|
11
|
+
* @internal
|
|
12
|
+
*/
|
|
13
|
+
export function loadExternalScript(src, attrs = {}) {
|
|
14
|
+
if (typeof document === 'undefined' || loaded.has(src))
|
|
15
|
+
return false;
|
|
16
|
+
loaded.add(src);
|
|
17
|
+
const script = document.createElement('script');
|
|
18
|
+
script.src = src;
|
|
19
|
+
// Ohne Angabe wie die Snippets der Anbieter: asynchron, blockiert die Seite nicht.
|
|
20
|
+
script.async = attrs.async ?? !attrs.defer;
|
|
21
|
+
if (attrs.defer)
|
|
22
|
+
script.defer = true;
|
|
23
|
+
for (const [name, value] of Object.entries(attrs)) {
|
|
24
|
+
if (name === 'async' || name === 'defer' || typeof value !== 'string')
|
|
25
|
+
continue;
|
|
26
|
+
if (ALLOWED.has(name) || DATA_ATTR.test(name))
|
|
27
|
+
script.setAttribute(name, value);
|
|
28
|
+
}
|
|
29
|
+
script.setAttribute('data-ds-external-script', '');
|
|
30
|
+
document.head.append(script);
|
|
31
|
+
return true;
|
|
32
|
+
}
|
|
33
|
+
/** @internal Nur für Tests. */
|
|
34
|
+
export function resetExternalScriptsForTests() {
|
|
35
|
+
loaded.clear();
|
|
36
|
+
}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import type { LeadClient } from './leadClient.svelte.js';
|
|
2
|
+
import type { LeadValues } from '../types.js';
|
|
3
|
+
/** Ein Schritt: eine Überschrift und die Felder, die auf ihm stehen. */
|
|
4
|
+
export interface FunnelStep {
|
|
5
|
+
/** Eindeutig, z. B. `objekt`. */
|
|
6
|
+
id: string;
|
|
7
|
+
/** Überschrift des Schritts, z. B. „Um welche Immobilie geht es?“. */
|
|
8
|
+
title: string;
|
|
9
|
+
/** Namen der Felder aus `dealsystem.config.ts`, die auf diesem Schritt stehen. Leer = ein Schritt ohne Felder. */
|
|
10
|
+
fields: readonly string[];
|
|
11
|
+
}
|
|
12
|
+
export interface FunnelState<K extends string = string> {
|
|
13
|
+
readonly steps: readonly FunnelStep[];
|
|
14
|
+
/** Antworten, für `bind:value`. Bleiben beim Zurückgehen erhalten. */
|
|
15
|
+
readonly values: LeadValues<K>;
|
|
16
|
+
/** Fehler je Feld des aktuellen Schritts, nach `next()` oder `submit()`. */
|
|
17
|
+
readonly errors: Record<string, string>;
|
|
18
|
+
/** 0-basiert. */
|
|
19
|
+
readonly index: number;
|
|
20
|
+
readonly step: FunnelStep;
|
|
21
|
+
readonly isFirst: boolean;
|
|
22
|
+
readonly isLast: boolean;
|
|
23
|
+
/** Für die Anzeige „Schritt 2 von 4“: 1-basiert. */
|
|
24
|
+
readonly progress: {
|
|
25
|
+
current: number;
|
|
26
|
+
total: number;
|
|
27
|
+
percent: number;
|
|
28
|
+
};
|
|
29
|
+
/** Prüft den Schritt und geht weiter. `false`, wenn etwas fehlt (dann stehen die Texte in `errors`). */
|
|
30
|
+
next(): boolean;
|
|
31
|
+
back(): void;
|
|
32
|
+
/** Prüft alles und sendet über den Client. Fehler bei Feldern führen zum ersten Schritt mit Fehler. */
|
|
33
|
+
submit(): ReturnType<LeadClient<K>['submit']>;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Hilfe für mehrstufige Formulare mit `createLeadClient()`: Schritte, Prüfung je Schritt, Fortschritt. Die
|
|
37
|
+
* Oberfläche baust du selbst; setze beim Schrittwechsel den Fokus auf die Überschrift des neuen Schritts.
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* const lead = createLeadClient('bewertung');
|
|
41
|
+
* const funnel = createFunnelState(lead, [
|
|
42
|
+
* { id: 'objekt', title: 'Um welche Immobilie geht es?', fields: ['objektart', 'wohnflaeche'] },
|
|
43
|
+
* { id: 'kontakt', title: 'Wohin dürfen wir die Einschätzung schicken?', fields: ['firstName', 'email'] },
|
|
44
|
+
* ]);
|
|
45
|
+
* // <input bind:value={funnel.values.wohnflaeche} />, <button onclick={() => funnel.next()}>Weiter</button>
|
|
46
|
+
*/
|
|
47
|
+
export declare function createFunnelState<K extends string>(client: LeadClient<K>, steps: readonly FunnelStep[]): FunnelState<K>;
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Hilfe für mehrstufige Formulare mit `createLeadClient()`: Schritte, Prüfung je Schritt, Fortschritt. Die
|
|
3
|
+
* Oberfläche baust du selbst; setze beim Schrittwechsel den Fokus auf die Überschrift des neuen Schritts.
|
|
4
|
+
*
|
|
5
|
+
* @example
|
|
6
|
+
* const lead = createLeadClient('bewertung');
|
|
7
|
+
* const funnel = createFunnelState(lead, [
|
|
8
|
+
* { id: 'objekt', title: 'Um welche Immobilie geht es?', fields: ['objektart', 'wohnflaeche'] },
|
|
9
|
+
* { id: 'kontakt', title: 'Wohin dürfen wir die Einschätzung schicken?', fields: ['firstName', 'email'] },
|
|
10
|
+
* ]);
|
|
11
|
+
* // <input bind:value={funnel.values.wohnflaeche} />, <button onclick={() => funnel.next()}>Weiter</button>
|
|
12
|
+
*/
|
|
13
|
+
export function createFunnelState(client, steps) {
|
|
14
|
+
if (steps.length === 0)
|
|
15
|
+
throw new Error('[dealsystem] createFunnelState braucht mindestens einen Schritt.');
|
|
16
|
+
const known = client.fields.map((f) => f.name);
|
|
17
|
+
for (const step of steps) {
|
|
18
|
+
for (const name of step.fields) {
|
|
19
|
+
if (!known.includes(name)) {
|
|
20
|
+
throw new Error(`[dealsystem] createFunnelState: Schritt "${step.id}" nennt das Feld "${name}", das im Formular "${client.funnel}" fehlt oder versteckt ist.`);
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
const values = $state({});
|
|
25
|
+
let errors = $state({});
|
|
26
|
+
let index = $state(0);
|
|
27
|
+
const progress = $derived({
|
|
28
|
+
current: index + 1,
|
|
29
|
+
total: steps.length,
|
|
30
|
+
percent: Math.round(((index + 1) / steps.length) * 100),
|
|
31
|
+
});
|
|
32
|
+
return {
|
|
33
|
+
steps,
|
|
34
|
+
values,
|
|
35
|
+
get errors() {
|
|
36
|
+
return errors;
|
|
37
|
+
},
|
|
38
|
+
get index() {
|
|
39
|
+
return index;
|
|
40
|
+
},
|
|
41
|
+
get step() {
|
|
42
|
+
return steps[index];
|
|
43
|
+
},
|
|
44
|
+
get isFirst() {
|
|
45
|
+
return index === 0;
|
|
46
|
+
},
|
|
47
|
+
get isLast() {
|
|
48
|
+
return index === steps.length - 1;
|
|
49
|
+
},
|
|
50
|
+
get progress() {
|
|
51
|
+
return progress;
|
|
52
|
+
},
|
|
53
|
+
next() {
|
|
54
|
+
client.prepare();
|
|
55
|
+
errors = client.validate(values, steps[index].fields);
|
|
56
|
+
if (Object.keys(errors).length > 0)
|
|
57
|
+
return false;
|
|
58
|
+
if (index < steps.length - 1)
|
|
59
|
+
index += 1;
|
|
60
|
+
return true;
|
|
61
|
+
},
|
|
62
|
+
back() {
|
|
63
|
+
errors = {};
|
|
64
|
+
if (index > 0)
|
|
65
|
+
index -= 1;
|
|
66
|
+
},
|
|
67
|
+
async submit() {
|
|
68
|
+
const result = await client.submit(values);
|
|
69
|
+
if (!result.ok && result.reason === 'validation') {
|
|
70
|
+
errors = result.fields;
|
|
71
|
+
const first = steps.findIndex((s) => s.fields.some((f) => f in result.fields));
|
|
72
|
+
if (first >= 0)
|
|
73
|
+
index = first;
|
|
74
|
+
}
|
|
75
|
+
else {
|
|
76
|
+
errors = {};
|
|
77
|
+
}
|
|
78
|
+
return result;
|
|
79
|
+
},
|
|
80
|
+
};
|
|
81
|
+
}
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
import { type SiteApiError } from './siteApi.js';
|
|
2
|
+
import type { FunnelFieldDef, FunnelKey, FunnelLeadmagnetConfig, LeadValues } from '../types.js';
|
|
3
|
+
/** Ausweichkontakt aus den Firmendaten im CRM. Leere Angaben sind `null`. Zeig ihn bei jedem Fehler außer `validation`. */
|
|
4
|
+
export interface LeadFallback {
|
|
5
|
+
phone: string | null;
|
|
6
|
+
email: string | null;
|
|
7
|
+
}
|
|
8
|
+
/** Warum eine Einsendung nicht angekommen ist. */
|
|
9
|
+
export type LeadFailureReason =
|
|
10
|
+
/** Angaben fehlen oder passen nicht: `fields` nennt je Feld den Text, `message` den für das ganze Formular. */
|
|
11
|
+
'validation'
|
|
12
|
+
/** Die Sicherheitsprüfung (Captcha) ließ sich nicht durchführen. */
|
|
13
|
+
| 'captcha'
|
|
14
|
+
/** Zu viele Anfragen; `retryAfterSeconds` sagt, wann es wieder geht. */
|
|
15
|
+
| 'rate_limited'
|
|
16
|
+
/** Keine Verbindung. */
|
|
17
|
+
| 'network'
|
|
18
|
+
/** Formular abgeschaltet, Server gestört oder Antwort unbrauchbar. */
|
|
19
|
+
| 'unavailable';
|
|
20
|
+
/** Ergebnis von `submit()`. */
|
|
21
|
+
export type LeadResult = {
|
|
22
|
+
ok: true;
|
|
23
|
+
/** `true` in der Vorschau: geprüft, aber nicht gespeichert. Zeig dann einen Hinweis. */
|
|
24
|
+
dryRun: boolean;
|
|
25
|
+
submissionId: string;
|
|
26
|
+
} | {
|
|
27
|
+
ok: false;
|
|
28
|
+
reason: 'validation';
|
|
29
|
+
/** Text für Besucher, auf Deutsch. */
|
|
30
|
+
message: string;
|
|
31
|
+
/** Je abgelehntem Feld ein Text, z. B. `{ email: 'Bitte geben Sie …' }`. */
|
|
32
|
+
fields: Record<string, string>;
|
|
33
|
+
fallback: null;
|
|
34
|
+
/** @internal Fehler der Site-API, wenn der Server abgelehnt hat. */
|
|
35
|
+
error: SiteApiError | null;
|
|
36
|
+
} | {
|
|
37
|
+
ok: false;
|
|
38
|
+
reason: Exclude<LeadFailureReason, 'validation'>;
|
|
39
|
+
message: string;
|
|
40
|
+
fields: Record<string, never>;
|
|
41
|
+
/** Telefon und E-Mail aus dem CRM. Zeig sie, damit der Besucher trotzdem anfragen kann. */
|
|
42
|
+
fallback: LeadFallback;
|
|
43
|
+
retryAfterSeconds: number | null;
|
|
44
|
+
/** @internal */
|
|
45
|
+
error: SiteApiError;
|
|
46
|
+
};
|
|
47
|
+
/** Was der Client gerade tut, reaktiv. `captcha`: wartet auf die Sicherheitsprüfung; `sending`: sendet. */
|
|
48
|
+
export type LeadClientStatus = 'idle' | 'captcha' | 'sending';
|
|
49
|
+
export interface LeadClientOptions {
|
|
50
|
+
/** Element für das unsichtbare Captcha. Standard: ein verstecktes Element am Ende von `<body>`. @internal */
|
|
51
|
+
captchaElement?: () => HTMLElement | null;
|
|
52
|
+
/** Wie der Aufruf in Fehlermeldungen heißt. @internal */
|
|
53
|
+
caller?: string;
|
|
54
|
+
}
|
|
55
|
+
/** Ein Client für ein Formular aus `dealsystem.config.ts`. */
|
|
56
|
+
export interface LeadClient<K extends string = string> {
|
|
57
|
+
readonly funnel: K;
|
|
58
|
+
/** Beschriftung des Formulars aus `dealsystem.config.ts`. */
|
|
59
|
+
readonly label: string;
|
|
60
|
+
/** `false`, wenn das Formular fehlt oder im CRM ausgeschaltet ist: zeig dann den Ausweichkontakt. */
|
|
61
|
+
readonly available: boolean;
|
|
62
|
+
/** Die sichtbaren Felder in der Reihenfolge der Konfiguration (ohne `hidden`). */
|
|
63
|
+
readonly fields: readonly FunnelFieldDef[];
|
|
64
|
+
readonly fallback: LeadFallback;
|
|
65
|
+
/** Datei, die das Formular verspricht (`leadmagnet` in `dealsystem.config.ts`), sonst `null`. */
|
|
66
|
+
readonly leadmagnet: FunnelLeadmagnetConfig | null;
|
|
67
|
+
/**
|
|
68
|
+
* Standardtext nach erfolgreichem Versand. Mit Leadmagnet kündigt er die Datei per E-Mail an und nennt den
|
|
69
|
+
* Spam-Ordner; ohne: „Vielen Dank. Ihre Anfrage ist bei uns angekommen.“ Eigener Text ist erlaubt.
|
|
70
|
+
*/
|
|
71
|
+
readonly successMessage: string;
|
|
72
|
+
/** Was der Client gerade tut (reaktiv), z. B. für „Die Sicherheitsprüfung läuft“. */
|
|
73
|
+
readonly status: LeadClientStatus;
|
|
74
|
+
/** Ein sichtbares Feld nach Namen. */
|
|
75
|
+
field(name: string): FunnelFieldDef | undefined;
|
|
76
|
+
/** Startet die Sicherheitsprüfung im Hintergrund. Beim ersten Schritt aufrufen; mehrfach aufrufbar. */
|
|
77
|
+
prepare(): void;
|
|
78
|
+
/**
|
|
79
|
+
* Prüft Werte wie der Server. Mit `only` nur diese Felder (ein Schritt eines Funnels). Leeres Objekt = alles in
|
|
80
|
+
* Ordnung, sonst je Feld ein Text für Besucher.
|
|
81
|
+
*/
|
|
82
|
+
validate(values: LeadValues<K>, only?: readonly string[]): Record<string, string>;
|
|
83
|
+
/** Wert der Bot-Falle (`<LeadHoneypot>`). Echte Besucher lassen sie leer. */
|
|
84
|
+
setHoneypot(value: string): void;
|
|
85
|
+
/**
|
|
86
|
+
* Sendet die Anfrage. Wartet auf die Sicherheitsprüfung, hängt versteckte Felder, Herkunft und Einwilligung an
|
|
87
|
+
* und wiederholt bei einem Serverfehler einmal. Läuft schon eine Einsendung, gibt es deren Ergebnis zurück.
|
|
88
|
+
*/
|
|
89
|
+
submit(values: LeadValues<K>): Promise<LeadResult>;
|
|
90
|
+
/** Räumt das Captcha ab. In `onMount` als Rückgabe verwenden. */
|
|
91
|
+
destroy(): void;
|
|
92
|
+
}
|
|
93
|
+
/** Standard-Erfolgstext ohne Leadmagnet (auch in `<LeadForm>`). */
|
|
94
|
+
export declare const DEFAULT_SUCCESS_MESSAGE = "Vielen Dank. Ihre Anfrage ist bei uns angekommen.";
|
|
95
|
+
/**
|
|
96
|
+
* Formular ohne `<LeadForm>`: für eigene Oberflächen wie mehrstufige Funnels. Nimmt den Schlüssel aus
|
|
97
|
+
* `dealsystem.config.ts`. Kein eigenes `fetch` an DealSystem, das ist verboten (`SEC-004`).
|
|
98
|
+
*
|
|
99
|
+
* Zeig bei jedem Fehler außer `validation` den Ausweichkontakt `res.fallback` (`QUA-008`) und
|
|
100
|
+
* setz `<LeadHoneypot client={lead} />` in die Oberfläche (Bot-Falle). Nach Erfolg passt `lead.successMessage`;
|
|
101
|
+
* verspricht das Formular eine Datei (`leadmagnet`), kündigt dieser Text sie an.
|
|
102
|
+
*
|
|
103
|
+
* @example
|
|
104
|
+
* <script lang="ts">
|
|
105
|
+
* import { createLeadClient, LeadHoneypot } from '@dealsystem/site';
|
|
106
|
+
* import { onMount } from 'svelte';
|
|
107
|
+
*
|
|
108
|
+
* const lead = createLeadClient('bewertung');
|
|
109
|
+
* onMount(() => () => lead.destroy());
|
|
110
|
+
* let email = $state('');
|
|
111
|
+
* let result = $state<Awaited<ReturnType<typeof lead.submit>> | null>(null);
|
|
112
|
+
*
|
|
113
|
+
* // Eigenes <form>: Enter sendet, der Browser prüft `required`. Ohne `action`, Absenden nur hier (SEC-007).
|
|
114
|
+
* async function senden(event: SubmitEvent) {
|
|
115
|
+
* event.preventDefault();
|
|
116
|
+
* result = await lead.submit({ email });
|
|
117
|
+
* }
|
|
118
|
+
* </script>
|
|
119
|
+
*
|
|
120
|
+
* <form onsubmit={senden}>
|
|
121
|
+
* <label for="email">E-Mail</label>
|
|
122
|
+
* <input id="email" type="email" autocomplete="email" required bind:value={email} onfocus={() => lead.prepare()} />
|
|
123
|
+
* <LeadHoneypot client={lead} />
|
|
124
|
+
* <button type="submit">Senden</button>
|
|
125
|
+
* </form>
|
|
126
|
+
* {#if result && !result.ok}
|
|
127
|
+
* <p role="alert">{result.message}</p>
|
|
128
|
+
* {#if result.fallback?.phone}<a href="tel:{result.fallback.phone}">{result.fallback.phone}</a>{/if}
|
|
129
|
+
* {/if}
|
|
130
|
+
*/
|
|
131
|
+
export declare function createLeadClient<K extends FunnelKey>(funnel: K, options?: LeadClientOptions): LeadClient<K>;
|