jamdesk 1.1.142 → 1.1.143
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/dist/commands/dev.d.ts.map +1 -1
- package/dist/commands/dev.js +20 -0
- package/dist/commands/dev.js.map +1 -1
- package/package.json +1 -1
- package/vendored/app/[[...slug]]/page.tsx +8 -1
- package/vendored/app/api/subscribe/[project]/route.ts +154 -0
- package/vendored/components/mdx/EmailSubscribe.tsx +167 -0
- package/vendored/components/mdx/MDXComponents.tsx +3 -0
- package/vendored/components/mdx/NativeSubscribeForm.tsx +172 -0
- package/vendored/lib/docs-types.ts +30 -0
- package/vendored/lib/email-subscribe-autoplacement.ts +46 -0
- package/vendored/lib/email-subscribe-providers.ts +120 -0
- package/vendored/lib/middleware-helpers.ts +21 -0
- package/vendored/lib/newsletter/adapters/beehiiv.ts +23 -0
- package/vendored/lib/newsletter/adapters/brevo.ts +31 -0
- package/vendored/lib/newsletter/adapters/kit.ts +35 -0
- package/vendored/lib/newsletter/adapters/loops.ts +22 -0
- package/vendored/lib/newsletter/adapters/mailchimp.ts +52 -0
- package/vendored/lib/newsletter/adapters/resend.ts +23 -0
- package/vendored/lib/newsletter/adapters/sendgrid.ts +23 -0
- package/vendored/lib/newsletter/descriptors.ts +84 -0
- package/vendored/lib/newsletter/http.ts +19 -0
- package/vendored/lib/newsletter/registry.ts +27 -0
- package/vendored/lib/newsletter/types.ts +52 -0
- package/vendored/lib/newsletter-display.ts +43 -0
- package/vendored/lib/render-doc-page.tsx +46 -2
- package/vendored/lib/seo.ts +13 -2
- package/vendored/lib/validate-content-images.ts +150 -0
- package/vendored/schema/docs-schema.json +28 -0
- package/vendored/shared/status-reporter.ts +1 -1
- package/vendored/workspace-package-lock.json +3 -87
- package/dist/__tests__/unit/dev-workspace-symlinks.test.d.ts +0 -2
- package/dist/__tests__/unit/dev-workspace-symlinks.test.d.ts.map +0 -1
- package/dist/__tests__/unit/dev-workspace-symlinks.test.js +0 -112
- package/dist/__tests__/unit/dev-workspace-symlinks.test.js.map +0 -1
- package/dist/__tests__/unit/language-filter.test.d.ts +0 -2
- package/dist/__tests__/unit/language-filter.test.d.ts.map +0 -1
- package/dist/__tests__/unit/language-filter.test.js +0 -166
- package/dist/__tests__/unit/language-filter.test.js.map +0 -1
- package/dist/lib/language-filter.d.ts +0 -31
- package/dist/lib/language-filter.d.ts.map +0 -1
- package/dist/lib/language-filter.js +0 -14
- package/dist/lib/language-filter.js.map +0 -1
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
// builder/build-service/components/mdx/NativeSubscribeForm.tsx
|
|
2
|
+
'use client';
|
|
3
|
+
|
|
4
|
+
import { useEffect, useState, type CSSProperties, type FormEvent } from 'react';
|
|
5
|
+
|
|
6
|
+
export interface NativeSubscribeFormProps {
|
|
7
|
+
provider: string; // 'resend'
|
|
8
|
+
title?: string;
|
|
9
|
+
description?: string;
|
|
10
|
+
/** Start collapsed: a compact button that expands to the form on click. */
|
|
11
|
+
collapsed?: boolean;
|
|
12
|
+
className?: string;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
// Solid primary button (the collapsed trigger and the form's submit share it).
|
|
16
|
+
// Kept compact — the iOS 16px-min rule is for inputs, not buttons.
|
|
17
|
+
const PRIMARY_BUTTON: CSSProperties = {
|
|
18
|
+
fontSize: '0.875rem', padding: '0.4rem 0.85rem', border: 0,
|
|
19
|
+
borderRadius: '0.375rem', cursor: 'pointer',
|
|
20
|
+
background: 'var(--color-primary, #2563eb)', color: '#fff',
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
// Inline text button for the "use a different email" escape hatch.
|
|
24
|
+
const LINK_BUTTON: CSSProperties = {
|
|
25
|
+
background: 'none', border: 0, padding: 0, color: 'var(--color-primary, #2563eb)',
|
|
26
|
+
cursor: 'pointer', textDecoration: 'underline', font: 'inherit',
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
/** Site-wide "this visitor already subscribed" flag. Per-origin (localStorage is
|
|
30
|
+
* already scoped to the published site), so one signup is remembered across
|
|
31
|
+
* every changelog page rather than re-nagging the same reader. */
|
|
32
|
+
const SUBSCRIBED_KEY = 'jd_subscribed';
|
|
33
|
+
|
|
34
|
+
function readSubscribed(): boolean {
|
|
35
|
+
try {
|
|
36
|
+
return typeof window !== 'undefined' &&
|
|
37
|
+
window.localStorage.getItem(SUBSCRIBED_KEY) === '1';
|
|
38
|
+
} catch {
|
|
39
|
+
// Private-mode / storage-disabled: fail open (show the form).
|
|
40
|
+
return false;
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
function rememberSubscribed(): void {
|
|
45
|
+
try {
|
|
46
|
+
window.localStorage.setItem(SUBSCRIBED_KEY, '1');
|
|
47
|
+
} catch {
|
|
48
|
+
// Best-effort — a storage failure just means we re-show next visit.
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/** Same-origin endpoint. Hosted-at-/docs sites serve the signup under /docs,
|
|
53
|
+
* mirroring useChat's `/docs/_chat` swap (builder/cli/vendored/hooks/useChat.ts). */
|
|
54
|
+
function subscribeEndpoint(): string {
|
|
55
|
+
if (typeof window !== 'undefined' && window.location.pathname.startsWith('/docs')) {
|
|
56
|
+
return '/docs/_jd/subscribe';
|
|
57
|
+
}
|
|
58
|
+
return '/_jd/subscribe';
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* On-brand, first-party signup form for native-capture providers (Resend). Posts
|
|
63
|
+
* the email to Jamdesk's same-origin /_jd/subscribe; the customer's API key stays
|
|
64
|
+
* server-side. No third-party script — safe to render anywhere the live component
|
|
65
|
+
* renders (published ISR + CLI dev; the editor uses the placeholder).
|
|
66
|
+
*
|
|
67
|
+
* Two display refinements, native-only (we control this DOM, unlike vendor
|
|
68
|
+
* embeds):
|
|
69
|
+
* - `collapsed`: render a compact button that expands to the form on click.
|
|
70
|
+
* - Already-subscribed memory: once a visitor subscribes, every later mount
|
|
71
|
+
* shows a one-line "you're subscribed" with a "use a different email" escape
|
|
72
|
+
* hatch instead of the full form. The flag is read AFTER mount (useEffect)
|
|
73
|
+
* so SSR/first-paint stays deterministic and hydration never mismatches.
|
|
74
|
+
*/
|
|
75
|
+
export function NativeSubscribeForm({ provider, title, description, collapsed, className }: NativeSubscribeFormProps) {
|
|
76
|
+
const [email, setEmail] = useState('');
|
|
77
|
+
const [status, setStatus] = useState<'idle' | 'submitting' | 'done' | 'error'>('idle');
|
|
78
|
+
// Set after mount only — keeps the server/first-client render deterministic.
|
|
79
|
+
const [remembered, setRemembered] = useState(false);
|
|
80
|
+
// The visitor explicitly opened the form (collapsed trigger or "different email").
|
|
81
|
+
const [forceOpen, setForceOpen] = useState(false);
|
|
82
|
+
|
|
83
|
+
useEffect(() => {
|
|
84
|
+
if (readSubscribed()) setRemembered(true);
|
|
85
|
+
}, []);
|
|
86
|
+
|
|
87
|
+
async function onSubmit(e: FormEvent<HTMLFormElement>) {
|
|
88
|
+
e.preventDefault();
|
|
89
|
+
if (status === 'submitting') return;
|
|
90
|
+
const jd_hp = (e.currentTarget.elements.namedItem('jd_hp') as HTMLInputElement | null)?.value ?? '';
|
|
91
|
+
setStatus('submitting');
|
|
92
|
+
try {
|
|
93
|
+
const res = await fetch(subscribeEndpoint(), {
|
|
94
|
+
method: 'POST',
|
|
95
|
+
headers: { 'Content-Type': 'application/json' },
|
|
96
|
+
body: JSON.stringify({ email, jd_hp, provider }),
|
|
97
|
+
});
|
|
98
|
+
if (res.ok) {
|
|
99
|
+
rememberSubscribed();
|
|
100
|
+
setRemembered(true);
|
|
101
|
+
setStatus('done');
|
|
102
|
+
} else {
|
|
103
|
+
setStatus('error');
|
|
104
|
+
}
|
|
105
|
+
} catch {
|
|
106
|
+
setStatus('error');
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
const wrapperClass = `jd-emailsubscribe not-prose my-6 ${className ?? ''}`.trim();
|
|
111
|
+
|
|
112
|
+
if (status === 'done') {
|
|
113
|
+
return (
|
|
114
|
+
<div className={wrapperClass} role="status">
|
|
115
|
+
{title && <p className="mb-1 font-semibold text-theme-text-primary">{title}</p>}
|
|
116
|
+
<p className="text-sm text-theme-text-secondary">Thanks — you’re subscribed.</p>
|
|
117
|
+
</div>
|
|
118
|
+
);
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
// Already-subscribed wins over the collapsed trigger: a returning subscriber
|
|
122
|
+
// sees the status line, not a generic "Subscribe" button.
|
|
123
|
+
if (remembered && !forceOpen) {
|
|
124
|
+
return (
|
|
125
|
+
<div className={wrapperClass}>
|
|
126
|
+
<p className="text-sm text-theme-text-secondary">
|
|
127
|
+
You’re subscribed to the newsletter.{' '}
|
|
128
|
+
<button type="button" onClick={() => { setEmail(''); setStatus('idle'); setForceOpen(true); }}
|
|
129
|
+
style={LINK_BUTTON}>
|
|
130
|
+
Use a different email?
|
|
131
|
+
</button>
|
|
132
|
+
</p>
|
|
133
|
+
</div>
|
|
134
|
+
);
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
// Collapsed: a compact button standing in for the whole form until clicked.
|
|
138
|
+
if (collapsed && !forceOpen) {
|
|
139
|
+
return (
|
|
140
|
+
<div className={wrapperClass}>
|
|
141
|
+
<button type="button" onClick={() => setForceOpen(true)} style={PRIMARY_BUTTON}>
|
|
142
|
+
{title || 'Subscribe to updates'}
|
|
143
|
+
</button>
|
|
144
|
+
</div>
|
|
145
|
+
);
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
return (
|
|
149
|
+
<div className={wrapperClass}>
|
|
150
|
+
{title && <p className="mb-1 font-semibold text-theme-text-primary">{title}</p>}
|
|
151
|
+
{description && <p className="mb-3 text-sm text-theme-text-secondary">{description}</p>}
|
|
152
|
+
<form onSubmit={onSubmit} style={{ display: 'flex', gap: '0.5rem', flexWrap: 'wrap', alignItems: 'center', maxWidth: '28rem' }}>
|
|
153
|
+
{/* Honeypot: a deliberately odd name (NOT website/url/email, which password
|
|
154
|
+
managers autofill — a filled honeypot silently drops a real user). Bots
|
|
155
|
+
fill it; humans can't see it. Off-screen + aria-hidden + tabIndex -1. */}
|
|
156
|
+
<input type="text" name="jd_hp" tabIndex={-1} autoComplete="off" aria-hidden="true"
|
|
157
|
+
defaultValue="" style={{ position: 'absolute', left: '-5000px' }} />
|
|
158
|
+
{/* font-size:16px avoids iOS auto-zoom (monorepo UI rule). */}
|
|
159
|
+
<input type="email" name="email" required value={email}
|
|
160
|
+
onChange={(e) => { setEmail(e.target.value); if (status === 'error') setStatus('idle'); }}
|
|
161
|
+
disabled={status === 'submitting'} placeholder="you@example.com" aria-label="Email address"
|
|
162
|
+
style={{ flex: 1, minWidth: 0, fontSize: '16px', padding: '0.4rem 0.75rem', border: '1px solid var(--color-border, #d4d4d8)', borderRadius: '0.375rem', background: 'var(--color-bg-primary, #fff)', color: 'var(--color-text-primary, #18181b)' }} />
|
|
163
|
+
<button type="submit" disabled={status === 'submitting'} style={PRIMARY_BUTTON}>
|
|
164
|
+
{status === 'submitting' ? 'Subscribing…' : 'Subscribe'}
|
|
165
|
+
</button>
|
|
166
|
+
</form>
|
|
167
|
+
{status === 'error' && (
|
|
168
|
+
<p className="mt-2 text-sm text-amber-700 dark:text-amber-400" role="alert">Something went wrong. Please try again.</p>
|
|
169
|
+
)}
|
|
170
|
+
</div>
|
|
171
|
+
);
|
|
172
|
+
}
|
|
@@ -614,6 +614,35 @@ export interface StylingConfig {
|
|
|
614
614
|
// INTEGRATIONS
|
|
615
615
|
// =============================================================================
|
|
616
616
|
|
|
617
|
+
/**
|
|
618
|
+
* Customer-facing newsletter / changelog-notification signup (rendered by
|
|
619
|
+
* <EmailSubscribe>). Fields mirror EmailSubscribeProps (see
|
|
620
|
+
* lib/email-subscribe-providers.ts); `placement` opts into auto-rendering on
|
|
621
|
+
* changelog (`rss: true`) pages.
|
|
622
|
+
*
|
|
623
|
+
* NOTE: distinct from the dashboard's internal `addUserToResendNewsletter`
|
|
624
|
+
* (Jamdesk's own signup list) — this is per docs-project config.
|
|
625
|
+
*/
|
|
626
|
+
export interface NewsletterConfig {
|
|
627
|
+
/** Shorthand provider: mailchimp | buttondown | substack | beehiiv (v1). */
|
|
628
|
+
provider?: string;
|
|
629
|
+
/** Mailchimp: full form POST action URL. */
|
|
630
|
+
action?: string;
|
|
631
|
+
/** Buttondown / Substack: account username. */
|
|
632
|
+
username?: string;
|
|
633
|
+
/** Beehiiv: full iframe embed src URL. */
|
|
634
|
+
src?: string;
|
|
635
|
+
/** Raw embed snippet (any vendor) — escape hatch. */
|
|
636
|
+
snippet?: string;
|
|
637
|
+
/** iframe height in px for iframe providers (substack/beehiiv). */
|
|
638
|
+
height?: number;
|
|
639
|
+
/** Optional heading shown above the embed. */
|
|
640
|
+
title?: string;
|
|
641
|
+
description?: string;
|
|
642
|
+
/** 'changelog' auto-mounts on `rss: true` pages; 'none' (default) = manual. */
|
|
643
|
+
placement?: 'none' | 'changelog';
|
|
644
|
+
}
|
|
645
|
+
|
|
617
646
|
/**
|
|
618
647
|
* Analytics and integration configurations (stubs - TODO: implement)
|
|
619
648
|
*/
|
|
@@ -629,6 +658,7 @@ export interface IntegrationsConfig {
|
|
|
629
658
|
hightouch?: { writeKey: string; apiHost?: string };
|
|
630
659
|
hotjar?: { hjid: string; hjsv: string };
|
|
631
660
|
crisp?: { websiteId: string };
|
|
661
|
+
newsletter?: NewsletterConfig;
|
|
632
662
|
intercom?: { appId: string };
|
|
633
663
|
koala?: { publicApiKey: string };
|
|
634
664
|
logrocket?: { appId: string };
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
// builder/build-service/lib/email-subscribe-autoplacement.ts
|
|
2
|
+
import type { EmailSubscribeProps } from './email-subscribe-providers';
|
|
3
|
+
|
|
4
|
+
/** Structural shape of the slice of config this resolver reads. Declared locally
|
|
5
|
+
* so Task 2 type-checks on its own, WITHOUT waiting for Task 5 to add
|
|
6
|
+
* `IntegrationsConfig.newsletter` — the real `DocsConfig` is structurally
|
|
7
|
+
* assignable to this, so render-doc-page (Task 6) can pass its full config. */
|
|
8
|
+
type NewsletterLike = EmailSubscribeProps & { placement?: 'none' | 'changelog' };
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Decide whether a changelog (`rss: true`) page should auto-render the
|
|
12
|
+
* configured signup. Returns the EmailSubscribe props (placement stripped) when
|
|
13
|
+
* `integrations.newsletter.placement === 'changelog'`, else null. Pure — so the
|
|
14
|
+
* gating is unit-tested without rendering the whole page.
|
|
15
|
+
*/
|
|
16
|
+
export function resolveAutoNewsletter(
|
|
17
|
+
rss: boolean | undefined,
|
|
18
|
+
config: { integrations?: { newsletter?: NewsletterLike } },
|
|
19
|
+
pageNewsletter?: boolean,
|
|
20
|
+
): EmailSubscribeProps | null {
|
|
21
|
+
// Per-page escape hatch: frontmatter `newsletter: false` suppresses the
|
|
22
|
+
// configured auto-placement on THIS page (e.g. a non-changelog page that
|
|
23
|
+
// happens to set rss:true, or a localized changelog placing its own translated
|
|
24
|
+
// <EmailSubscribe>). Only an explicit `false` opts out.
|
|
25
|
+
if (pageNewsletter === false) return null;
|
|
26
|
+
const n = config.integrations?.newsletter;
|
|
27
|
+
if (!rss || !n || n.placement !== 'changelog') return null;
|
|
28
|
+
const { placement: _placement, ...props } = n;
|
|
29
|
+
void _placement;
|
|
30
|
+
return props;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/** True when the page's raw MDX already hand-places an `<EmailSubscribe>` tag.
|
|
34
|
+
* Used to suppress auto-placement so an explicit author form isn't doubled.
|
|
35
|
+
*
|
|
36
|
+
* Code is stripped first — fenced blocks (```…```) then inline spans (`…`) — so
|
|
37
|
+
* a page that merely *documents* the component (a changelog entry or guide
|
|
38
|
+
* showing `<EmailSubscribe />` in an example) isn't mistaken for a hand-placed
|
|
39
|
+
* form and wrongly suppress its own `placement: changelog` auto-mount.
|
|
40
|
+
* The trailing char class avoids matching `<EmailSubscribeFoo`. */
|
|
41
|
+
export function mdxHasEmailSubscribe(rawContent: string): boolean {
|
|
42
|
+
const withoutCode = rawContent
|
|
43
|
+
.replace(/```[\s\S]*?```/g, '')
|
|
44
|
+
.replace(/`[^`\n]+`/g, '');
|
|
45
|
+
return /<EmailSubscribe[\s/>]/.test(withoutCode);
|
|
46
|
+
}
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
// builder/build-service/lib/email-subscribe-providers.ts
|
|
2
|
+
import { NATIVE_PROVIDER_IDS } from './newsletter/descriptors';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Props accepted by <EmailSubscribe> and (minus styling-only fields) by the
|
|
6
|
+
* docs.json `integrations.newsletter` block. All optional — the resolver
|
|
7
|
+
* decides what's renderable.
|
|
8
|
+
*/
|
|
9
|
+
export interface EmailSubscribeProps {
|
|
10
|
+
/** Shorthand provider key (case-insensitive). */
|
|
11
|
+
provider?: string;
|
|
12
|
+
/** Mailchimp: full form POST `action` URL. */
|
|
13
|
+
action?: string;
|
|
14
|
+
/** Buttondown / Substack: account username. */
|
|
15
|
+
username?: string;
|
|
16
|
+
/** Beehiiv: full iframe embed `src` URL. */
|
|
17
|
+
src?: string;
|
|
18
|
+
/** Raw embed snippet (any vendor) — escape hatch, takes priority. */
|
|
19
|
+
snippet?: string;
|
|
20
|
+
/** iframe height in px for iframe providers (substack/beehiiv). */
|
|
21
|
+
height?: number;
|
|
22
|
+
/** Optional on-brand heading above the embed. */
|
|
23
|
+
title?: string;
|
|
24
|
+
description?: string;
|
|
25
|
+
/** Start collapsed: render a compact "Subscribe" button that expands to the
|
|
26
|
+
* full form on click (native providers only — embeds can't be controlled). */
|
|
27
|
+
collapsed?: boolean;
|
|
28
|
+
/** Extra class on the wrapper. */
|
|
29
|
+
className?: string;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
export type ResolvedEmbed =
|
|
33
|
+
| { kind: 'snippet'; html: string }
|
|
34
|
+
| { kind: 'native'; provider: string } // Phase 2: real form + capture endpoint
|
|
35
|
+
| { kind: 'native-pending'; provider: string } // API-only, no native path yet
|
|
36
|
+
| { kind: 'none'; reason: string };
|
|
37
|
+
|
|
38
|
+
/** API-only ESPs with no native path yet — friendly notice, never an error. */
|
|
39
|
+
const NATIVE_PENDING_PROVIDERS = new Set(['mailersend']);
|
|
40
|
+
|
|
41
|
+
/** Escape a user value before interpolating into an HTML attribute so a stray
|
|
42
|
+
* quote/angle-bracket can't break out of the attribute or inject a tag.
|
|
43
|
+
* Escapes single quotes too, so it stays safe even if an attribute is later
|
|
44
|
+
* switched to single-quoted. */
|
|
45
|
+
function escapeAttr(value: string): string {
|
|
46
|
+
return value
|
|
47
|
+
.replace(/&/g, '&')
|
|
48
|
+
.replace(/"/g, '"')
|
|
49
|
+
.replace(/'/g, ''')
|
|
50
|
+
.replace(/</g, '<')
|
|
51
|
+
.replace(/>/g, '>');
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
const EMAIL_INPUT =
|
|
55
|
+
'<input type="email" name="EMAIL" required placeholder="you@example.com" ' +
|
|
56
|
+
'aria-label="Email address" ' +
|
|
57
|
+
'style="flex:1;min-width:0;font-size:16px;padding:0.5rem 0.75rem;border:1px solid var(--color-border, #d4d4d8);border-radius:0.375rem;background:var(--color-bg-primary, #fff);color:var(--color-text-primary, #18181b)" />';
|
|
58
|
+
|
|
59
|
+
const SUBMIT_BUTTON =
|
|
60
|
+
'<button type="submit" ' +
|
|
61
|
+
'style="font-size:16px;padding:0.5rem 1rem;border:0;border-radius:0.375rem;cursor:pointer;background:var(--color-primary, #2563eb);color:#fff">Subscribe</button>';
|
|
62
|
+
|
|
63
|
+
function formShell(action: string, emailName: string, target: string): string {
|
|
64
|
+
// `font-size:16px` on the input avoids iOS auto-zoom (monorepo UI rule).
|
|
65
|
+
// escapeAttr defends the field name even though callers pass literals today —
|
|
66
|
+
// a future provider deriving emailName from config can't inject an attribute.
|
|
67
|
+
const input = EMAIL_INPUT.replace('name="EMAIL"', `name="${escapeAttr(emailName)}"`);
|
|
68
|
+
return (
|
|
69
|
+
`<form action="${action}" method="post" target="${target}" ` +
|
|
70
|
+
`style="display:flex;gap:0.5rem;flex-wrap:wrap;align-items:center;max-width:28rem">` +
|
|
71
|
+
input +
|
|
72
|
+
SUBMIT_BUTTON +
|
|
73
|
+
`</form>`
|
|
74
|
+
);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
function iframe(src: string, height: number): string {
|
|
78
|
+
// Height is provider-defaulted + author-overridable (`height` prop): a single
|
|
79
|
+
// magic number clips Substack's taller widget or pads Beehiiv's compact one.
|
|
80
|
+
return (
|
|
81
|
+
`<iframe src="${src}" width="100%" height="${height}" frameborder="0" scrolling="no" ` +
|
|
82
|
+
`title="Subscribe" style="border:0;background:transparent;max-width:28rem"></iframe>`
|
|
83
|
+
);
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
/** Provider shorthands whose markup is fully reconstructable from documented,
|
|
87
|
+
* stable inputs. Mailchimp and beehiiv were here pre-native; they are now
|
|
88
|
+
* handled by the NATIVE_PROVIDER_IDS branch above. */
|
|
89
|
+
const PROVIDER_BUILDERS: Record<string, (p: EmailSubscribeProps) => ResolvedEmbed> = {
|
|
90
|
+
buttondown(p) {
|
|
91
|
+
if (!p.username) return { kind: 'none', reason: 'buttondown requires a "username"' };
|
|
92
|
+
const action = `https://buttondown.com/api/emails/embed-subscribe/${encodeURIComponent(p.username)}`;
|
|
93
|
+
return { kind: 'snippet', html: formShell(escapeAttr(action), 'email', 'popupwindow') };
|
|
94
|
+
},
|
|
95
|
+
substack(p) {
|
|
96
|
+
if (!p.username) return { kind: 'none', reason: 'substack requires a "username"' };
|
|
97
|
+
const sub = encodeURIComponent(p.username);
|
|
98
|
+
return { kind: 'snippet', html: iframe(escapeAttr(`https://${sub}.substack.com/embed`), p.height ?? 320) };
|
|
99
|
+
},
|
|
100
|
+
};
|
|
101
|
+
|
|
102
|
+
/** Turn EmailSubscribe props into a renderable embed decision. Pure. */
|
|
103
|
+
export function resolveEmailSubscribeEmbed(p: EmailSubscribeProps): ResolvedEmbed {
|
|
104
|
+
if (p.snippet && p.snippet.trim()) return { kind: 'snippet', html: p.snippet };
|
|
105
|
+
|
|
106
|
+
const provider = p.provider?.trim().toLowerCase();
|
|
107
|
+
if (!provider) return { kind: 'none', reason: 'no provider or snippet specified' };
|
|
108
|
+
// Migration note: sites whose docs.json still says provider:"mailchimp"/"beehiiv"
|
|
109
|
+
// now resolve to a native form. With no dashboard creds the submission returns the
|
|
110
|
+
// uniform 404 and the form shows a neutral message. Owners must configure the
|
|
111
|
+
// provider in the dashboard (agreed native-replaces-embed migration).
|
|
112
|
+
if (NATIVE_PROVIDER_IDS.has(provider)) return { kind: 'native', provider };
|
|
113
|
+
if (NATIVE_PENDING_PROVIDERS.has(provider)) return { kind: 'native-pending', provider };
|
|
114
|
+
|
|
115
|
+
const builder = PROVIDER_BUILDERS[provider];
|
|
116
|
+
if (!builder) {
|
|
117
|
+
return { kind: 'none', reason: `provider "${provider}" has no shorthand — paste its embed via the "snippet" prop` };
|
|
118
|
+
}
|
|
119
|
+
return builder(p);
|
|
120
|
+
}
|
|
@@ -393,6 +393,7 @@ export const INTERNAL_API_ROUTES = [
|
|
|
393
393
|
'/api/r2', // R2 content serving (app/api/r2/[project]/[...path]) — gated explicitly in proxy.ts
|
|
394
394
|
'/api/revalidate', // Cache revalidation (app/api/revalidate)
|
|
395
395
|
'/api/search-ev', // Search analytics proxy (app/api/search-ev)
|
|
396
|
+
'/api/subscribe', // Newsletter subscribe endpoint (app/api/subscribe/[project]) — gated by Origin in route
|
|
396
397
|
// NOTE: /api/jd is intentionally NOT here — /api/jd/unlock reads
|
|
397
398
|
// x-project-slug + x-host-at-docs headers that middleware sets.
|
|
398
399
|
// NOTE: /api/markdown-export is intentionally NOT here either — it serves
|
|
@@ -553,6 +554,26 @@ export function getChatApiPath(projectSlug: string): string {
|
|
|
553
554
|
return `/api/chat/${projectSlug}`;
|
|
554
555
|
}
|
|
555
556
|
|
|
557
|
+
/**
|
|
558
|
+
* Check if this is a newsletter subscribe request that needs routing.
|
|
559
|
+
*
|
|
560
|
+
* @param pathname - Request pathname
|
|
561
|
+
* @returns true if this is a subscribe request
|
|
562
|
+
*/
|
|
563
|
+
export function isSubscribeRequest(pathname: string): boolean {
|
|
564
|
+
return pathname === '/_jd/subscribe' || pathname === '/docs/_jd/subscribe';
|
|
565
|
+
}
|
|
566
|
+
|
|
567
|
+
/**
|
|
568
|
+
* Get the subscribe API path for a project.
|
|
569
|
+
*
|
|
570
|
+
* @param projectSlug - Project identifier
|
|
571
|
+
* @returns Subscribe API route path
|
|
572
|
+
*/
|
|
573
|
+
export function getSubscribeApiPath(projectSlug: string): string {
|
|
574
|
+
return `/api/subscribe/${projectSlug}`;
|
|
575
|
+
}
|
|
576
|
+
|
|
556
577
|
/**
|
|
557
578
|
* Check if this is a docs search request that needs routing.
|
|
558
579
|
*
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { NewsletterAdapter, NewsletterCreds } from '../types';
|
|
2
|
+
import { getDescriptor } from '../descriptors';
|
|
3
|
+
import { fetchJson } from '../http';
|
|
4
|
+
|
|
5
|
+
const BASE = 'https://api.beehiiv.com/v2';
|
|
6
|
+
const headers = (secret: string) => ({ Authorization: `Bearer ${secret}`, 'content-type': 'application/json' });
|
|
7
|
+
|
|
8
|
+
export const beehiivAdapter: NewsletterAdapter = {
|
|
9
|
+
descriptor: getDescriptor('beehiiv')!,
|
|
10
|
+
async validate(creds: NewsletterCreds) {
|
|
11
|
+
if (!creds.publicationId) return { ok: false, reason: 'publicationId required' };
|
|
12
|
+
const { status } = await fetchJson(`${BASE}/publications/${creds.publicationId}`, { method: 'GET', headers: headers(creds.secret) });
|
|
13
|
+
return status === 200 ? { ok: true } : { ok: false, reason: `publication ${status}` };
|
|
14
|
+
},
|
|
15
|
+
async addContact(email: string, creds: NewsletterCreds) {
|
|
16
|
+
if (!creds.publicationId) return { ok: false, code: 'misconfigured' };
|
|
17
|
+
const { status } = await fetchJson(`${BASE}/publications/${creds.publicationId}/subscriptions`, {
|
|
18
|
+
method: 'POST', headers: headers(creds.secret),
|
|
19
|
+
body: JSON.stringify({ email, reactivate_existing: false, send_welcome_email: false }),
|
|
20
|
+
});
|
|
21
|
+
return status >= 200 && status < 300 ? { ok: true } : { ok: false, status };
|
|
22
|
+
},
|
|
23
|
+
};
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type { NewsletterAdapter, NewsletterCreds } from '../types';
|
|
2
|
+
import { getDescriptor } from '../descriptors';
|
|
3
|
+
import { fetchJson } from '../http';
|
|
4
|
+
|
|
5
|
+
const BASE = 'https://api.brevo.com/v3';
|
|
6
|
+
const headers = (secret: string) => ({ 'api-key': secret, 'content-type': 'application/json' });
|
|
7
|
+
|
|
8
|
+
export const brevoAdapter: NewsletterAdapter = {
|
|
9
|
+
descriptor: getDescriptor('brevo')!,
|
|
10
|
+
async validate(creds: NewsletterCreds) {
|
|
11
|
+
if (!creds.listId) return { ok: false, reason: 'listId required' };
|
|
12
|
+
// Probe the LIST, not just /account: a valid key with a wrong listId would
|
|
13
|
+
// pass /account but then drop every signup. GET the list to prove both.
|
|
14
|
+
const { status } = await fetchJson(`${BASE}/contacts/lists/${creds.listId}`,
|
|
15
|
+
{ method: 'GET', headers: headers(creds.secret) });
|
|
16
|
+
return status === 200 ? { ok: true } : { ok: false, reason: `list ${status}` };
|
|
17
|
+
},
|
|
18
|
+
async addContact(email: string, creds: NewsletterCreds) {
|
|
19
|
+
if (!creds.listId) return { ok: false, code: 'misconfigured' };
|
|
20
|
+
const { status, json } = await fetchJson(`${BASE}/contacts`, {
|
|
21
|
+
method: 'POST', headers: headers(creds.secret),
|
|
22
|
+
// updateEnabled:false → never silently re-subscribes a contact who opted out.
|
|
23
|
+
body: JSON.stringify({ email, listIds: [Number(creds.listId)], updateEnabled: false }),
|
|
24
|
+
});
|
|
25
|
+
if (status >= 200 && status < 300) return { ok: true };
|
|
26
|
+
// A returning subscriber already on the list → idempotent success, not error.
|
|
27
|
+
const code = (json as { code?: string } | null)?.code;
|
|
28
|
+
if (status === 400 && code === 'duplicate_parameter') return { ok: true };
|
|
29
|
+
return { ok: false, status };
|
|
30
|
+
},
|
|
31
|
+
};
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import type { NewsletterAdapter, NewsletterCreds } from '../types';
|
|
2
|
+
import { getDescriptor } from '../descriptors';
|
|
3
|
+
import { fetchJson } from '../http';
|
|
4
|
+
|
|
5
|
+
const BASE = 'https://api.kit.com/v4';
|
|
6
|
+
const headers = (secret: string) => ({ 'X-Kit-Api-Key': secret, 'content-type': 'application/json' });
|
|
7
|
+
|
|
8
|
+
export const kitAdapter: NewsletterAdapter = {
|
|
9
|
+
descriptor: getDescriptor('kit')!,
|
|
10
|
+
async validate(creds: NewsletterCreds) {
|
|
11
|
+
if (!creds.formId) return { ok: false, reason: 'formId required' };
|
|
12
|
+
// Probe the FORM resource, NOT just /account: a key that can read the account
|
|
13
|
+
// may have a wrong/inaccessible formId, which /account wouldn't catch — then
|
|
14
|
+
// every real signup 404s.
|
|
15
|
+
const { status } = await fetchJson(`${BASE}/forms/${creds.formId}/subscribers?per_page=1`,
|
|
16
|
+
{ method: 'GET', headers: headers(creds.secret) });
|
|
17
|
+
return status === 200 ? { ok: true } : { ok: false, reason: `form ${status}` };
|
|
18
|
+
},
|
|
19
|
+
async addContact(email: string, creds: NewsletterCreds) {
|
|
20
|
+
if (!creds.formId) return { ok: false, code: 'misconfigured' };
|
|
21
|
+
// Kit v4 split subscriber-creation from form-attachment: POST /forms/{id}/subscribers
|
|
22
|
+
// ONLY attaches a subscriber that ALREADY exists ("The subscriber being added to the
|
|
23
|
+
// form must already exist") — for a brand-new email it returns 2xx without adding
|
|
24
|
+
// anyone. So upsert the subscriber first (idempotent: 201 new / 200 existing), then
|
|
25
|
+
// attach them to the form.
|
|
26
|
+
const created = await fetchJson(`${BASE}/subscribers`, {
|
|
27
|
+
method: 'POST', headers: headers(creds.secret), body: JSON.stringify({ email_address: email }),
|
|
28
|
+
});
|
|
29
|
+
if (created.status < 200 || created.status >= 300) return { ok: false, status: created.status };
|
|
30
|
+
const { status } = await fetchJson(`${BASE}/forms/${creds.formId}/subscribers`, {
|
|
31
|
+
method: 'POST', headers: headers(creds.secret), body: JSON.stringify({ email_address: email }),
|
|
32
|
+
});
|
|
33
|
+
return status >= 200 && status < 300 ? { ok: true } : { ok: false, status };
|
|
34
|
+
},
|
|
35
|
+
};
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type { NewsletterAdapter, NewsletterCreds } from '../types';
|
|
2
|
+
import { getDescriptor } from '../descriptors';
|
|
3
|
+
import { fetchJson } from '../http';
|
|
4
|
+
|
|
5
|
+
const BASE = 'https://app.loops.so/api/v1';
|
|
6
|
+
const headers = (secret: string) => ({ Authorization: `Bearer ${secret}`, 'content-type': 'application/json' });
|
|
7
|
+
|
|
8
|
+
export const loopsAdapter: NewsletterAdapter = {
|
|
9
|
+
descriptor: getDescriptor('loops')!,
|
|
10
|
+
async validate(creds: NewsletterCreds) {
|
|
11
|
+
const { status } = await fetchJson(`${BASE}/api-key`, { method: 'GET', headers: headers(creds.secret) });
|
|
12
|
+
return status === 200 ? { ok: true } : { ok: false, reason: `api-key ${status}` };
|
|
13
|
+
},
|
|
14
|
+
async addContact(email: string, creds: NewsletterCreds) {
|
|
15
|
+
const { status } = await fetchJson(`${BASE}/contacts/create`, {
|
|
16
|
+
method: 'POST', headers: headers(creds.secret), body: JSON.stringify({ email }),
|
|
17
|
+
});
|
|
18
|
+
// 409 = contact already exists → a successful (idempotent) signup.
|
|
19
|
+
if (status === 409) return { ok: true };
|
|
20
|
+
return status >= 200 && status < 300 ? { ok: true } : { ok: false, status };
|
|
21
|
+
},
|
|
22
|
+
};
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
// Node-runtime ONLY: uses node:crypto (MD5) + Buffer. Safe here — the subscribe
|
|
2
|
+
// route is `export const runtime = 'nodejs'` and the vendored functions copy runs
|
|
3
|
+
// on Node 24. Do NOT import the registry from an edge route.
|
|
4
|
+
import { createHash } from 'node:crypto';
|
|
5
|
+
import type { NewsletterAdapter, NewsletterCreds } from '../types';
|
|
6
|
+
import { getDescriptor } from '../descriptors';
|
|
7
|
+
import { fetchJson } from '../http';
|
|
8
|
+
|
|
9
|
+
// SECURITY: the datacenter suffix is interpolated straight into the request host
|
|
10
|
+
// (`https://${dc}.api.mailchimp.com`). The `/^[a-z]+\d+$/` test is the ONLY guard
|
|
11
|
+
// stopping a malicious or typo'd key suffix from redirecting the authenticated
|
|
12
|
+
// call to an attacker-controlled host (SSRF + key exfiltration). Do NOT loosen it.
|
|
13
|
+
function dc(secret: string): string | null {
|
|
14
|
+
const i = secret.lastIndexOf('-');
|
|
15
|
+
const suffix = i >= 0 ? secret.slice(i + 1) : '';
|
|
16
|
+
return /^[a-z]+\d+$/.test(suffix) ? suffix : null;
|
|
17
|
+
}
|
|
18
|
+
function authHeader(secret: string): string {
|
|
19
|
+
return 'Basic ' + Buffer.from(`any:${secret}`).toString('base64');
|
|
20
|
+
}
|
|
21
|
+
function memberHash(email: string): string {
|
|
22
|
+
return createHash('md5').update(email.trim().toLowerCase()).digest('hex');
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
export const mailchimpAdapter: NewsletterAdapter = {
|
|
26
|
+
descriptor: getDescriptor('mailchimp')!,
|
|
27
|
+
async validate(creds: NewsletterCreds) {
|
|
28
|
+
const d = dc(creds.secret);
|
|
29
|
+
if (!d) return { ok: false, reason: 'key has no -datacenter suffix' };
|
|
30
|
+
if (!creds.listId) return { ok: false, reason: 'listId required' };
|
|
31
|
+
const { status } = await fetchJson(
|
|
32
|
+
`https://${d}.api.mailchimp.com/3.0/lists/${creds.listId}`,
|
|
33
|
+
{ method: 'GET', headers: { Authorization: authHeader(creds.secret) } },
|
|
34
|
+
);
|
|
35
|
+
return status === 200 ? { ok: true } : { ok: false, reason: `list check ${status}` };
|
|
36
|
+
},
|
|
37
|
+
async addContact(email: string, creds: NewsletterCreds) {
|
|
38
|
+
const d = dc(creds.secret);
|
|
39
|
+
if (!d || !creds.listId) return { ok: false, code: 'misconfigured' };
|
|
40
|
+
const hash = memberHash(email);
|
|
41
|
+
const { status } = await fetchJson(
|
|
42
|
+
`https://${d}.api.mailchimp.com/3.0/lists/${creds.listId}/members/${hash}`,
|
|
43
|
+
{
|
|
44
|
+
method: 'PUT',
|
|
45
|
+
headers: { Authorization: authHeader(creds.secret), 'content-type': 'application/json' },
|
|
46
|
+
// status_if_new (not status) → never resurrects an unsubscribed member.
|
|
47
|
+
body: JSON.stringify({ email_address: email, status_if_new: 'subscribed' }),
|
|
48
|
+
},
|
|
49
|
+
);
|
|
50
|
+
return status >= 200 && status < 300 ? { ok: true } : { ok: false, status };
|
|
51
|
+
},
|
|
52
|
+
};
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { Resend } from 'resend';
|
|
2
|
+
import type { NewsletterAdapter, NewsletterCreds } from '../types';
|
|
3
|
+
import { getDescriptor } from '../descriptors';
|
|
4
|
+
|
|
5
|
+
// Resend keeps the SDK (already a dep of build-service AND functions). validate
|
|
6
|
+
// calls segments.get: Resend keys are binary (Full vs Sending) and a
|
|
7
|
+
// Sending-access key cannot call segments.* — success proves Full access AND a
|
|
8
|
+
// valid audience. addContact upserts WITHOUT unsubscribed:false (no resurrection).
|
|
9
|
+
export const resendAdapter: NewsletterAdapter = {
|
|
10
|
+
descriptor: getDescriptor('resend')!,
|
|
11
|
+
async validate(creds: NewsletterCreds) {
|
|
12
|
+
if (!creds.audienceId) return { ok: false, reason: 'audienceId required' };
|
|
13
|
+
const { error } = await new Resend(creds.secret).segments.get(creds.audienceId);
|
|
14
|
+
// Surface Resend's error.name (e.g. "restricted_api_key" = a Sending-only
|
|
15
|
+
// key, "not_found" = wrong audience) so a failed connect is debuggable from
|
|
16
|
+
// logs. error.name is a stable, key-safe category string.
|
|
17
|
+
return error ? { ok: false, reason: error.name || 'invalid_key_or_audience' } : { ok: true };
|
|
18
|
+
},
|
|
19
|
+
async addContact(email: string, creds: NewsletterCreds) {
|
|
20
|
+
const { error } = await new Resend(creds.secret).contacts.create({ email, audienceId: creds.audienceId! });
|
|
21
|
+
return error ? { ok: false, code: error.name } : { ok: true };
|
|
22
|
+
},
|
|
23
|
+
};
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { NewsletterAdapter, NewsletterCreds } from '../types';
|
|
2
|
+
import { getDescriptor } from '../descriptors';
|
|
3
|
+
import { fetchJson } from '../http';
|
|
4
|
+
|
|
5
|
+
const BASE = 'https://api.sendgrid.com/v3';
|
|
6
|
+
const headers = (secret: string) => ({ Authorization: `Bearer ${secret}`, 'content-type': 'application/json' });
|
|
7
|
+
|
|
8
|
+
export const sendgridAdapter: NewsletterAdapter = {
|
|
9
|
+
descriptor: getDescriptor('sendgrid')!,
|
|
10
|
+
async validate(creds: NewsletterCreds) {
|
|
11
|
+
if (!creds.listId) return { ok: false, reason: 'listId required' };
|
|
12
|
+
const { status } = await fetchJson(`${BASE}/marketing/lists/${creds.listId}`, { method: 'GET', headers: headers(creds.secret) });
|
|
13
|
+
return status === 200 ? { ok: true } : { ok: false, reason: `list ${status}` };
|
|
14
|
+
},
|
|
15
|
+
async addContact(email: string, creds: NewsletterCreds) {
|
|
16
|
+
if (!creds.listId) return { ok: false, code: 'misconfigured' };
|
|
17
|
+
const { status } = await fetchJson(`${BASE}/marketing/contacts`, {
|
|
18
|
+
method: 'PUT', headers: headers(creds.secret),
|
|
19
|
+
body: JSON.stringify({ list_ids: [creds.listId], contacts: [{ email }] }),
|
|
20
|
+
});
|
|
21
|
+
return status >= 200 && status < 300 ? { ok: true } : { ok: false, status };
|
|
22
|
+
},
|
|
23
|
+
};
|