@nuxt/scripts 1.0.0-beta.2 → 1.0.0-beta.20
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 +3 -3
- package/dist/client/200.html +1 -1
- package/dist/client/404.html +1 -1
- package/dist/client/_nuxt/{B66N9HCo.js → 9LJPrOyI.js} +1 -1
- package/dist/client/_nuxt/DFEfk2pB.js +162 -0
- package/dist/client/_nuxt/{DvH517bE.js → DMlY-BNa.js} +1 -1
- package/dist/client/_nuxt/{DfLgoB--.js → __ZZTkMj.js} +1 -1
- package/dist/client/_nuxt/builds/latest.json +1 -1
- package/dist/client/_nuxt/builds/meta/8212d4fa-7985-421b-815a-03a886e667d4.json +1 -0
- package/dist/client/_nuxt/entry.CACgbLJl.css +1 -0
- package/dist/client/_nuxt/error-404.CHeaW3dp.css +1 -0
- package/dist/client/_nuxt/error-500.DvOvWme_.css +1 -0
- package/dist/client/index.html +1 -1
- package/dist/module.d.mts +27 -18
- package/dist/module.d.ts +178 -0
- package/dist/module.json +1 -1
- package/dist/module.mjs +747 -527
- package/dist/registry.d.ts +6 -0
- package/dist/registry.mjs +74 -21
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMaps.d.vue.ts +2 -2
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMaps.vue +7 -7
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMaps.vue.d.ts +2 -2
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsAdvancedMarkerElement.vue +6 -6
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsCircle.vue +7 -7
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsHeatmapLayer.vue +6 -6
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsInfoWindow.vue +12 -12
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsMarker.vue +6 -6
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsMarkerClusterer.d.vue.ts +1 -1
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsMarkerClusterer.vue +6 -6
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsMarkerClusterer.vue.d.ts +1 -1
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsPinElement.vue +5 -5
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsPolygon.vue +7 -7
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsPolyline.vue +7 -7
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsRectangle.vue +7 -7
- package/dist/runtime/components/ScriptCrisp.vue +1 -1
- package/dist/runtime/components/ScriptGoogleAdsense.vue +1 -1
- package/dist/runtime/components/ScriptGravatar.d.vue.ts +22 -0
- package/dist/runtime/components/ScriptGravatar.vue +46 -0
- package/dist/runtime/components/ScriptGravatar.vue.d.ts +22 -0
- package/dist/runtime/components/ScriptInstagramEmbed.vue +1 -1
- package/dist/runtime/components/ScriptIntercom.vue +4 -3
- package/dist/runtime/components/ScriptPayPalButtons.d.vue.ts +43 -32
- package/dist/runtime/components/ScriptPayPalButtons.vue +48 -79
- package/dist/runtime/components/ScriptPayPalButtons.vue.d.ts +43 -32
- package/dist/runtime/components/ScriptPayPalMessages.d.vue.ts +37 -23
- package/dist/runtime/components/ScriptPayPalMessages.vue +46 -50
- package/dist/runtime/components/ScriptPayPalMessages.vue.d.ts +37 -23
- package/dist/runtime/components/ScriptStripePricingTable.vue +2 -2
- package/dist/runtime/components/ScriptVimeoPlayer.d.vue.ts +9 -0
- package/dist/runtime/components/ScriptVimeoPlayer.vue +13 -10
- package/dist/runtime/components/ScriptVimeoPlayer.vue.d.ts +9 -0
- package/dist/runtime/components/ScriptXEmbed.d.vue.ts +1 -1
- package/dist/runtime/components/ScriptXEmbed.vue +1 -1
- package/dist/runtime/components/ScriptXEmbed.vue.d.ts +1 -1
- package/dist/runtime/components/ScriptYouTubePlayer.d.vue.ts +2 -2
- package/dist/runtime/components/ScriptYouTubePlayer.vue +11 -5
- package/dist/runtime/components/ScriptYouTubePlayer.vue.d.ts +2 -2
- package/dist/runtime/composables/useScript.js +11 -6
- package/dist/runtime/composables/useScriptEventPage.js +2 -2
- package/dist/runtime/composables/useScriptTriggerConsent.js +1 -1
- package/dist/runtime/composables/useScriptTriggerElement.js +1 -1
- package/dist/runtime/composables/useScriptTriggerIdleTimeout.js +1 -1
- package/dist/runtime/registry/clarity.d.ts +10 -15
- package/dist/runtime/registry/clarity.js +22 -31
- package/dist/runtime/registry/cloudflare-web-analytics.d.ts +2 -13
- package/dist/runtime/registry/cloudflare-web-analytics.js +2 -14
- package/dist/runtime/registry/crisp.d.ts +9 -39
- package/dist/runtime/registry/crisp.js +2 -33
- package/dist/runtime/registry/databuddy-analytics.d.ts +2 -35
- package/dist/runtime/registry/databuddy-analytics.js +20 -45
- package/dist/runtime/registry/fathom-analytics.d.ts +6 -25
- package/dist/runtime/registry/fathom-analytics.js +2 -24
- package/dist/runtime/registry/google-adsense.d.ts +2 -10
- package/dist/runtime/registry/google-adsense.js +2 -11
- package/dist/runtime/registry/google-analytics.d.ts +3 -5
- package/dist/runtime/registry/google-analytics.js +3 -8
- package/dist/runtime/registry/google-maps.d.ts +3 -9
- package/dist/runtime/registry/google-maps.js +2 -8
- package/dist/runtime/registry/google-recaptcha.d.ts +2 -6
- package/dist/runtime/registry/google-recaptcha.js +4 -12
- package/dist/runtime/registry/google-sign-in.d.ts +2 -13
- package/dist/runtime/registry/google-sign-in.js +2 -22
- package/dist/runtime/registry/google-tag-manager.d.ts +3 -28
- package/dist/runtime/registry/google-tag-manager.js +4 -27
- package/dist/runtime/registry/gravatar.d.ts +25 -0
- package/dist/runtime/registry/gravatar.js +32 -0
- package/dist/runtime/registry/hotjar.d.ts +3 -5
- package/dist/runtime/registry/hotjar.js +2 -5
- package/dist/runtime/registry/instagram-embed.d.ts +2 -17
- package/dist/runtime/registry/instagram-embed.js +4 -19
- package/dist/runtime/registry/intercom.d.ts +3 -11
- package/dist/runtime/registry/intercom.js +2 -12
- package/dist/runtime/registry/matomo-analytics.d.ts +2 -11
- package/dist/runtime/registry/matomo-analytics.js +3 -12
- package/dist/runtime/registry/meta-pixel.d.ts +3 -5
- package/dist/runtime/registry/meta-pixel.js +2 -4
- package/dist/runtime/registry/npm.d.ts +2 -6
- package/dist/runtime/registry/npm.js +2 -9
- package/dist/runtime/registry/paypal.d.ts +4 -25
- package/dist/runtime/registry/paypal.js +3 -66
- package/dist/runtime/registry/plausible-analytics.js +18 -13
- package/dist/runtime/registry/posthog.d.ts +10 -11
- package/dist/runtime/registry/posthog.js +7 -20
- package/dist/runtime/registry/reddit-pixel.d.ts +4 -5
- package/dist/runtime/registry/reddit-pixel.js +2 -4
- package/dist/runtime/registry/rybbit-analytics.d.ts +2 -14
- package/dist/runtime/registry/rybbit-analytics.js +7 -19
- package/dist/runtime/registry/schemas.d.ts +946 -0
- package/dist/runtime/registry/schemas.js +901 -0
- package/dist/runtime/registry/segment.d.ts +2 -5
- package/dist/runtime/registry/segment.js +2 -5
- package/dist/runtime/registry/snapchat-pixel.d.ts +3 -32
- package/dist/runtime/registry/snapchat-pixel.js +2 -20
- package/dist/runtime/registry/stripe.d.ts +3 -4
- package/dist/runtime/registry/stripe.js +2 -4
- package/dist/runtime/registry/tiktok-pixel.d.ts +3 -6
- package/dist/runtime/registry/tiktok-pixel.js +2 -6
- package/dist/runtime/registry/umami-analytics.d.ts +2 -31
- package/dist/runtime/registry/umami-analytics.js +2 -36
- package/dist/runtime/registry/vercel-analytics.d.ts +29 -0
- package/dist/runtime/registry/vercel-analytics.js +84 -0
- package/dist/runtime/registry/vimeo-player.d.ts +2 -2
- package/dist/runtime/registry/vimeo-player.js +1 -1
- package/dist/runtime/registry/x-embed.d.ts +2 -16
- package/dist/runtime/registry/x-embed.js +2 -17
- package/dist/runtime/registry/x-pixel.d.ts +3 -6
- package/dist/runtime/registry/x-pixel.js +2 -5
- package/dist/runtime/registry/youtube-player.d.ts +7 -7
- package/dist/runtime/registry/youtube-player.js +1 -1
- package/dist/runtime/server/google-static-maps-proxy.js +1 -1
- package/dist/runtime/server/{sw-handler.d.ts → gravatar-proxy.d.ts} +1 -1
- package/dist/runtime/server/gravatar-proxy.js +62 -0
- package/dist/runtime/server/instagram-embed-asset.js +2 -1
- package/dist/runtime/server/instagram-embed-image.js +2 -1
- package/dist/runtime/server/instagram-embed.js +22 -13
- package/dist/runtime/server/proxy-handler.js +161 -117
- package/dist/runtime/server/utils/privacy.d.ts +45 -1
- package/dist/runtime/server/utils/privacy.js +103 -40
- package/dist/runtime/server/x-embed.js +3 -2
- package/dist/runtime/types.d.ts +30 -24
- package/dist/runtime/utils/pure.d.ts +0 -4
- package/dist/runtime/utils/pure.js +0 -67
- package/dist/runtime/utils.d.ts +3 -3
- package/dist/runtime/utils.js +12 -7
- package/dist/shared/scripts.Crpn87WB.mjs +318 -0
- package/dist/stats.d.mts +39 -0
- package/dist/stats.d.ts +39 -0
- package/dist/stats.mjs +772 -0
- package/dist/types-source.d.mts +19 -0
- package/dist/types-source.d.ts +19 -0
- package/dist/types-source.mjs +975 -0
- package/package.json +42 -31
- package/dist/client/_nuxt/B8XOar-X.js +0 -162
- package/dist/client/_nuxt/builds/meta/133a46c5-a5c1-4a63-87d1-037947a5bcdb.json +0 -1
- package/dist/client/_nuxt/entry.D45OuV0w.css +0 -1
- package/dist/client/_nuxt/error-404.B57D-jUQ.css +0 -1
- package/dist/client/_nuxt/error-500.DTHUW7BI.css +0 -1
- package/dist/runtime/components/ScriptPayPalMarks.d.vue.ts +0 -52
- package/dist/runtime/components/ScriptPayPalMarks.vue +0 -69
- package/dist/runtime/components/ScriptPayPalMarks.vue.d.ts +0 -52
- package/dist/runtime/plugins/sw-register.client.d.ts +0 -2
- package/dist/runtime/plugins/sw-register.client.js +0 -12
- package/dist/runtime/server/sw-handler.js +0 -25
- package/dist/runtime/sw/proxy-sw.template.d.ts +0 -1
- package/dist/runtime/sw/proxy-sw.template.js +0 -54
|
@@ -0,0 +1,975 @@
|
|
|
1
|
+
import * as schemas_js from '../dist/runtime/registry/schemas.js';
|
|
2
|
+
export * from '../dist/runtime/registry/schemas.js';
|
|
3
|
+
|
|
4
|
+
function _mergeNamespaces(n, m) {
|
|
5
|
+
for (var i = 0; i < m.length; i++) {
|
|
6
|
+
const e = m[i];
|
|
7
|
+
if (typeof e !== 'string' && !Array.isArray(e)) { for (const k in e) {
|
|
8
|
+
if (k !== 'default' && !(k in n)) {
|
|
9
|
+
n[k] = e[k];
|
|
10
|
+
}
|
|
11
|
+
} }
|
|
12
|
+
}
|
|
13
|
+
return n;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
const schemas = /*#__PURE__*/_mergeNamespaces({
|
|
17
|
+
__proto__: null
|
|
18
|
+
}, [schemas_js]);
|
|
19
|
+
|
|
20
|
+
const clarity = [
|
|
21
|
+
{
|
|
22
|
+
name: "ClarityOptions",
|
|
23
|
+
kind: "const",
|
|
24
|
+
code: "export const ClarityOptions = object({\n /**\n * The Clarity token.\n * @see https://learn.microsoft.com/en-us/clarity/setup-clarity\n */\n id: pipe(string(), minLength(10)),\n})"
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
name: "ClarityFunctions",
|
|
28
|
+
kind: "type",
|
|
29
|
+
code: "type ClarityFunctions = ((fn: 'start', options?: { content?: boolean, cookies?: string[], dob?: number, expire?: number, projectId?: string, upload?: string }) => void)\n & ((fn: 'identify', id: string, session?: string, page?: string, userHint?: string) => Promise<{\n id: string\n session: string\n page: string\n userHint: string\n }>)\n & ((fn: 'consent', enabled?: boolean | Record<string, string>) => void)\n & ((fn: 'set', key: string, value: string | string[]) => void)\n & ((fn: 'event', value: string) => void)\n & ((fn: 'upgrade', upgradeReason: string) => void)\n & ((fn: (string & {}), ...args: any[]) => void)"
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
name: "ClarityApi",
|
|
33
|
+
kind: "interface",
|
|
34
|
+
code: "export interface ClarityApi {\n clarity: ClarityFunctions & {\n q: any[]\n v: string\n }\n}"
|
|
35
|
+
}
|
|
36
|
+
];
|
|
37
|
+
const crisp = [
|
|
38
|
+
{
|
|
39
|
+
name: "CrispOptions",
|
|
40
|
+
kind: "const",
|
|
41
|
+
code: "export const CrispOptions = object({\n /**\n * The Crisp ID.\n */\n id: string(),\n /**\n * Extra configuration options. Used to configure the locale.\n * Same as CRISP_RUNTIME_CONFIG.\n * @see https://docs.crisp.chat/guides/chatbox-sdks/web-sdk/language-customization/\n */\n runtimeConfig: optional(object({\n locale: optional(string()),\n })),\n /**\n * Associated a session, equivalent to using CRISP_TOKEN_ID variable.\n * Same as CRISP_TOKEN_ID.\n * @see https://docs.crisp.chat/guides/chatbox-sdks/web-sdk/session-continuity/\n */\n tokenId: optional(string()),\n /**\n * Restrict the domain that the Crisp cookie is set on.\n * Same as CRISP_COOKIE_DOMAIN.\n * @see https://docs.crisp.chat/guides/chatbox-sdks/web-sdk/cookie-policies/\n */\n cookieDomain: optional(string()),\n /**\n * The cookie expiry in seconds.\n * Same as CRISP_COOKIE_EXPIRATION.\n * @see https://docs.crisp.chat/guides/chatbox-sdks/web-sdk/cookie-policies/#change-cookie-expiration-date\n */\n cookieExpiry: optional(number()),\n})"
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
name: "CrispApi",
|
|
45
|
+
kind: "interface",
|
|
46
|
+
code: "export interface CrispApi {\n push: (...args: any[]) => void\n is: (name: 'chat:opened' | 'chat:closed' | 'chat:visible' | 'chat:hidden' | 'chat:small' | 'chat:large' | 'session:ongoing' | 'website:available' | 'overlay:opened' | 'overlay:closed' | (string & {})) => boolean\n set: ((name: 'message:text' | 'user:email' | 'user:phone' | 'user:nickname' | 'user:avatar' | 'user:company', value: string) => void)\n & ((name: 'session:data', value: [[string, string | number | boolean], ...[string, string | number | boolean][]]) => void)\n & ((name: 'session:segments', value: string[]) => void)\n & ((name: 'session:event', value: [[string, Record<string, any>?, string?]]) => void)\n & ((name: (string & {}), value: any) => void)\n get: ((name: 'chat:unread:count') => number)\n & ((name: 'message:text' | 'session:identifier' | 'user:email' | 'user:phone' | 'user:nickname' | 'user:avatar' | 'user:company') => string)\n & ((name: 'session:data', key: string) => string | number | boolean)\n & ((name: (string & {})) => any)\n do: (name: 'chat:open' | 'chat:close' | 'chat:toggle' | 'chat:show' | 'chat:hide' | 'helpdesk:search' | 'helpdesk:article:open' | 'helpdesk:query' | 'overlay:open' | 'overlay:close' | 'message:send' | 'message:show' | 'message:read' | 'message:thread:start' | 'message:thread:end' | 'session:reset' | 'trigger:run', arg2?: any) => any\n on: (name: 'session:loaded' | 'chat:initiated' | 'chat:opened' | 'chat:closed' | 'message:sent' | 'message:received' | 'message:compose:sent' | 'message:compose:received' | 'user:email:changed' | 'user:phone:changed' | 'user:nickname:changed' | 'user:avatar:changed' | 'website:availability:changed' | 'helpdesk:queried' | (string & {}), callback: (...args: any[]) => any) => void\n off: (name: 'session:loaded' | 'chat:initiated' | 'chat:opened' | 'chat:closed' | 'message:sent' | 'message:received' | 'message:compose:sent' | 'message:compose:received' | 'user:email:changed' | 'user:phone:changed' | 'user:nickname:changed' | 'user:avatar:changed' | 'website:availability:changed' | 'helpdesk:queried' | (string & {}), callback: (...args: any[]) => any) => void\n config: ((name: 'container:index', value: number) => void)\n & ((name: 'color:theme', value: 'default' | 'amber' | 'black' | 'blue' | 'blue_grey' | 'light_blue' | 'brown' | 'cyan' | 'green' | 'light_green' | 'grey' | 'indigo' | 'orange' | 'deep_orange' | 'pink' | 'purple' | 'deep_purple' | 'red' | 'teal') => void)\n & ((name: 'position:reverse' | 'hide:on:mobile' | 'hide:on:away' | 'lock:maximized' | 'lock:fullview' | 'show:operator:count' | 'sound:mute', value: boolean) => void)\n & ((name: (string & {}), value: any) => void)\n help: () => void\n [key: string]: any\n}"
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
name: "ScriptCrispProps",
|
|
50
|
+
kind: "interface",
|
|
51
|
+
code: "interface ScriptCrispProps {\n /**\n * Defines the trigger event to load the script.\n */\n trigger?: ElementScriptTrigger\n id: string\n runtimeConfig?: {\n locale: string\n }\n tokenId?: string\n cookieDomain?: string\n cookieExpiry?: number\n}"
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
name: "ScriptCrispDefaults",
|
|
55
|
+
kind: "const",
|
|
56
|
+
code: "const ScriptCrispDefaults = {\n \"trigger\": \"'click'\"\n}"
|
|
57
|
+
}
|
|
58
|
+
];
|
|
59
|
+
const gravatar = [
|
|
60
|
+
{
|
|
61
|
+
name: "GravatarApi",
|
|
62
|
+
kind: "interface",
|
|
63
|
+
code: "export interface GravatarApi {\n /**\n * Get a proxied avatar URL for a given SHA256 email hash.\n * When firstParty mode is enabled, this routes through your server.\n */\n getAvatarUrl: (hash: string, options?: { size?: number, default?: string, rating?: string }) => string\n /**\n * Get a proxied avatar URL using the server-side hashing endpoint.\n * The email is sent to YOUR server (not Gravatar) for hashing.\n * Only available when the gravatar proxy is enabled.\n */\n getAvatarUrlFromEmail: (email: string, options?: { size?: number, default?: string, rating?: string }) => string\n}"
|
|
64
|
+
}
|
|
65
|
+
];
|
|
66
|
+
const hotjar = [
|
|
67
|
+
{
|
|
68
|
+
name: "HotjarOptions",
|
|
69
|
+
kind: "const",
|
|
70
|
+
code: "export const HotjarOptions = object({\n /**\n * Your Hotjar Site ID.\n * @see https://help.hotjar.com/hc/en-us/articles/115012039247-Hotjar-Tracking-Code\n */\n id: number(),\n /**\n * The Hotjar snippet version.\n * @default 6\n */\n sv: optional(number()),\n})"
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
name: "HotjarApi",
|
|
74
|
+
kind: "interface",
|
|
75
|
+
code: "export interface HotjarApi {\n hj: ((event: 'identify', userId: string, attributes?: Record<string, any>) => void) & ((event: 'stateChange', path: string) => void) & ((event: 'vPageView', path: string) => void) & ((event: 'event', eventName: string) => void) & ((event: (string & {}), ...args: any[]) => void) & {\n q: any[]\n }\n}"
|
|
76
|
+
}
|
|
77
|
+
];
|
|
78
|
+
const intercom = [
|
|
79
|
+
{
|
|
80
|
+
name: "IntercomOptions",
|
|
81
|
+
kind: "const",
|
|
82
|
+
code: "export const IntercomOptions = object({\n /**\n * Your Intercom app ID.\n * @see https://developers.intercom.com/installing-intercom/docs/javascript-api-attributes-objects\n */\n app_id: string(),\n /**\n * The regional API base URL. Choose based on your Intercom data hosting region.\n */\n api_base: optional(union([literal('https://api-iam.intercom.io'), literal('https://api-iam.eu.intercom.io'), literal('https://api-iam.au.intercom.io')])),\n /**\n * The name of the logged-in user.\n */\n name: optional(string()),\n /**\n * The email address of the logged-in user.\n */\n email: optional(string()),\n /**\n * A unique identifier for the logged-in user.\n */\n user_id: optional(string()),\n /**\n * The horizontal alignment of the Intercom messenger launcher.\n * @default 'right'\n */\n alignment: optional(union([literal('left'), literal('right')])),\n /**\n * The horizontal padding (in px) of the messenger launcher from the edge of the page.\n * @default 20\n */\n horizontal_padding: optional(number()),\n /**\n * The vertical padding (in px) of the messenger launcher from the bottom of the page.\n * @default 20\n */\n vertical_padding: optional(number()),\n})"
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
name: "IntercomApi",
|
|
86
|
+
kind: "interface",
|
|
87
|
+
code: "export interface IntercomApi {\n Intercom: ((event: 'boot', data?: InferInput<typeof IntercomOptions>) => void)\n & ((event: 'shutdown') => void)\n & ((event: 'update', options?: InferInput<typeof IntercomOptions>) => void)\n & ((event: 'hide') => void)\n & ((event: 'show') => void)\n & ((event: 'showSpace', spaceName: 'home' | 'messages' | 'help' | 'news' | 'tasks' | 'tickets' | (string & {})) => void)\n & ((event: 'showMessages') => void)\n & ((event: 'showNewMessage', content?: string) => void)\n & ((event: 'onHide', fn: () => void) => void)\n & ((event: 'onShow', fn: () => void) => void)\n & ((event: 'onUnreadCountChange', fn: () => void) => void)\n & ((event: 'trackEvent', eventName: string, metadata?: Record<string, any>) => void)\n & ((event: 'getVisitorId') => Promise<string>)\n & ((event: 'startTour', tourId: string | number) => void)\n & ((event: 'showArticle', articleId: string | number) => void)\n & ((event: 'showNews', newsItemId: string | number) => void)\n & ((event: 'startSurvey', surveyId: string | number) => void)\n & ((event: 'startChecklist', checklistId: string | number) => void)\n & ((event: 'showTicket', ticketId: string | number) => void)\n & ((event: 'showConversation', conversationId: string | number) => void)\n & ((event: 'onUserEmailSupplied', fn: () => void) => void)\n & ((event: (string & {}), ...params: any[]) => void)\n}"
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
name: "ScriptIntercomProps",
|
|
91
|
+
kind: "interface",
|
|
92
|
+
code: "interface ScriptIntercomProps {\n appId: string\n apiBase?: string\n name?: string\n email?: string\n userId?: string\n // customizing the messenger\n alignment?: 'left' | 'right'\n horizontalPadding?: number\n verticalPadding?: number\n /**\n * Defines the trigger event to load the script.\n */\n trigger?: ElementScriptTrigger\n}"
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
name: "ScriptIntercomDefaults",
|
|
96
|
+
kind: "const",
|
|
97
|
+
code: "const ScriptIntercomDefaults = {\n \"trigger\": \"'click'\"\n}"
|
|
98
|
+
}
|
|
99
|
+
];
|
|
100
|
+
const npm = [
|
|
101
|
+
{
|
|
102
|
+
name: "NpmOptions",
|
|
103
|
+
kind: "const",
|
|
104
|
+
code: "export const NpmOptions = object({\n /**\n * The npm package name to load.\n * @example 'lodash'\n */\n packageName: string(),\n /**\n * The specific file path within the package to load.\n * @example '/dist/lodash.min.js'\n */\n file: optional(string()),\n /**\n * The package version to load.\n * @default 'latest'\n */\n version: optional(string()),\n /**\n * The CDN provider to use for loading the package.\n * @default 'unpkg'\n * @see https://unpkg.com\n * @see https://www.jsdelivr.com\n * @see https://cdnjs.com\n */\n provider: optional(union([literal('jsdelivr'), literal('cdnjs'), literal('unpkg')])),\n})"
|
|
105
|
+
},
|
|
106
|
+
{
|
|
107
|
+
name: "Provider",
|
|
108
|
+
kind: "type",
|
|
109
|
+
code: "type Provider = 'jsdelivr' | 'cdnjs' | 'unpkg'"
|
|
110
|
+
}
|
|
111
|
+
];
|
|
112
|
+
const paypal = [
|
|
113
|
+
{
|
|
114
|
+
name: "PayPalOptions",
|
|
115
|
+
kind: "const",
|
|
116
|
+
code: "export const PayPalOptions = union([\n object({\n /**\n * Your PayPal client ID.\n * @see https://developer.paypal.com/sdk/js/reference/\n */\n clientId: string(),\n clientToken: optional(string()),\n /**\n * Use the PayPal sandbox environment. Defaults to `true` in development.\n */\n sandbox: optional(boolean()),\n }),\n object({\n clientId: optional(string()),\n /**\n * A server-generated client token for authentication.\n * @see https://docs.paypal.ai/payments/methods/paypal/sdk/js/v6/paypal-checkout\n */\n clientToken: string(),\n /**\n * Use the PayPal sandbox environment. Defaults to `true` in development.\n */\n sandbox: optional(boolean()),\n }),\n])"
|
|
117
|
+
},
|
|
118
|
+
{
|
|
119
|
+
name: "PayPalApi",
|
|
120
|
+
kind: "interface",
|
|
121
|
+
code: "export interface PayPalApi {\n paypal: PayPalV6Namespace\n}"
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
name: "ScriptPayPalButtonsProps",
|
|
125
|
+
kind: "interface",
|
|
126
|
+
code: "interface ScriptPayPalButtonsProps {\n /**\n * Customize the root element attributes.\n */\n rootAttrs?: HTMLAttributes & ReservedProps & Record<string, unknown>\n /**\n * Defines the trigger event to load the script.\n */\n trigger?: ElementScriptTrigger\n /**\n * Client ID or client token for PayPal SDK v6 authentication.\n */\n clientId?: string\n /**\n * Server-generated client token for SDK v6.\n */\n clientToken?: string\n /**\n * The v6 SDK components to load.\n * @default ['paypal-payments']\n */\n components?: Components[]\n /**\n * The page type context hint.\n */\n pageType?: PageTypes\n /**\n * The locale for the SDK (BCP-47 code).\n */\n locale?: string\n /**\n * The merchant ID(s).\n */\n merchantId?: string | string[]\n /**\n * Partner attribution ID for revenue sharing.\n */\n partnerAttributionId?: string\n /**\n * The paypal script options.\n */\n paypalScriptOptions?: Partial<PayPalInput>\n}"
|
|
127
|
+
},
|
|
128
|
+
{
|
|
129
|
+
name: "ScriptPayPalButtonsDefaults",
|
|
130
|
+
kind: "const",
|
|
131
|
+
code: "const ScriptPayPalButtonsDefaults = {\n \"trigger\": \"'visible'\",\n \"clientId\": \"'test'\",\n \"components\": \"() => ['paypal-payments'] as Components[]\",\n \"paypalScriptOptions\": \"() => ({})\"\n}"
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
name: "ScriptPayPalMessagesProps",
|
|
135
|
+
kind: "interface",
|
|
136
|
+
code: "interface ScriptPayPalMessagesProps {\n /**\n * Customize the root element attributes.\n */\n rootAttrs?: HTMLAttributes & ReservedProps & Record<string, unknown>\n /**\n * Defines the trigger event to load the script.\n */\n trigger?: ElementScriptTrigger\n /**\n * Client ID or client token for PayPal SDK v6 authentication.\n */\n clientId?: string\n /**\n * Server-generated client token for SDK v6.\n */\n clientToken?: string\n /**\n * The merchant ID for the paypal script.\n */\n merchantId?: string | string[]\n /**\n * The partner attribution ID.\n */\n partnerAttributionId?: string\n /**\n * The page type context hint.\n */\n pageType?: PageTypes\n /**\n * The locale for the SDK (BCP-47 code).\n */\n locale?: string\n /**\n * Options for the PayPal Messages session.\n */\n messagesOptions?: PayPalMessagesOptions\n /**\n * The paypal script options.\n */\n paypalScriptOptions?: Partial<PayPalInput>\n}"
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
name: "ScriptPayPalMessagesDefaults",
|
|
140
|
+
kind: "const",
|
|
141
|
+
code: "const ScriptPayPalMessagesDefaults = {\n \"trigger\": \"'visible'\",\n \"clientId\": \"'test'\",\n \"paypalScriptOptions\": \"() => ({})\",\n \"messagesOptions\": \"() => ({})\"\n}"
|
|
142
|
+
}
|
|
143
|
+
];
|
|
144
|
+
const posthog = [
|
|
145
|
+
{
|
|
146
|
+
name: "PostHogOptions",
|
|
147
|
+
kind: "const",
|
|
148
|
+
code: "export const PostHogOptions = object({\n /**\n * Your PostHog project API key.\n * @see https://posthog.com/docs/libraries/js#usage\n */\n apiKey: string(),\n /**\n * Your PostHog data region.\n * @default 'us'\n * @see https://posthog.com/docs/libraries/js#config\n */\n region: optional(union([literal('us'), literal('eu')])),\n /**\n * Custom API host URL. Overrides the default derived from `region`.\n * Useful for self-hosted instances or reverse proxies.\n */\n apiHost: optional(string()),\n /**\n * Enable autocapture of clicks, form submissions, and page views.\n * @default true\n */\n autocapture: optional(boolean()),\n /**\n * Capture page views automatically. Set to `'history_change'` to only capture on history changes.\n * @default true\n */\n capturePageview: optional(union([boolean(), literal('history_change')])),\n /**\n * Capture page leave events automatically.\n * @default true\n */\n capturePageleave: optional(boolean()),\n /**\n * Disable session recording.\n */\n disableSessionRecording: optional(boolean()),\n /**\n * Additional PostHog configuration options passed directly to `posthog.init()`.\n * @see https://posthog.com/docs/libraries/js#config\n */\n config: optional(record(string(), any())),\n})"
|
|
149
|
+
},
|
|
150
|
+
{
|
|
151
|
+
name: "PostHogApi",
|
|
152
|
+
kind: "interface",
|
|
153
|
+
code: "export interface PostHogApi {\n posthog: PostHog\n}"
|
|
154
|
+
}
|
|
155
|
+
];
|
|
156
|
+
const segment = [
|
|
157
|
+
{
|
|
158
|
+
name: "SegmentOptions",
|
|
159
|
+
kind: "const",
|
|
160
|
+
code: "export const SegmentOptions = object({\n /**\n * Your Segment write key.\n * @see https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/quickstart/\n */\n writeKey: string(),\n /**\n * The global variable name for the analytics instance.\n * @default 'analytics'\n */\n analyticsKey: optional(string()),\n})"
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
name: "AnalyticsApi",
|
|
164
|
+
kind: "interface",
|
|
165
|
+
code: "interface AnalyticsApi {\n track: (event: string, properties?: Record<string, any>) => void\n page: (name?: string, properties?: Record<string, any>) => void\n identify: (userId: string, traits?: Record<string, any>, options?: Record<string, any>) => void\n group: (groupId: string, traits?: Record<string, any>, options?: Record<string, any>) => void\n alias: (userId: string, previousId: string, options?: Record<string, any>) => void\n reset: () => void\n /**\n * @internal\n */\n methods: string[]\n /**\n * @internal\n */\n factory: (method: string) => (...args: any[]) => AnalyticsApi\n /**\n * @internal\n */\n push: (args: any[]) => void\n}"
|
|
166
|
+
},
|
|
167
|
+
{
|
|
168
|
+
name: "SegmentApi",
|
|
169
|
+
kind: "type",
|
|
170
|
+
code: "export type SegmentApi = Pick<AnalyticsApi, 'track' | 'page' | 'identify' | 'group' | 'alias' | 'reset'>"
|
|
171
|
+
}
|
|
172
|
+
];
|
|
173
|
+
const stripe = [
|
|
174
|
+
{
|
|
175
|
+
name: "StripeOptions",
|
|
176
|
+
kind: "const",
|
|
177
|
+
code: "export const StripeOptions = object({\n /**\n * Whether to load Stripe's advanced fraud detection signals.\n * Set to `false` to opt out.\n * @default true\n * @see https://docs.stripe.com/disputes/prevention/advanced-fraud-detection\n */\n advancedFraudSignals: optional(boolean()),\n})"
|
|
178
|
+
},
|
|
179
|
+
{
|
|
180
|
+
name: "StripeApi",
|
|
181
|
+
kind: "interface",
|
|
182
|
+
code: "export interface StripeApi {\n Stripe: StripeConstructor\n}"
|
|
183
|
+
},
|
|
184
|
+
{
|
|
185
|
+
name: "ScriptStripePricingTableProps",
|
|
186
|
+
kind: "interface",
|
|
187
|
+
code: "interface ScriptStripePricingTableProps {\n trigger?: ElementScriptTrigger\n publishableKey: string\n pricingTableId: string\n clientReferenceId?: string\n customerEmail?: string\n customerSessionClientSecret?: string\n}"
|
|
188
|
+
},
|
|
189
|
+
{
|
|
190
|
+
name: "ScriptStripePricingTableDefaults",
|
|
191
|
+
kind: "const",
|
|
192
|
+
code: "const ScriptStripePricingTableDefaults = {\n \"trigger\": \"'visible'\"\n}"
|
|
193
|
+
}
|
|
194
|
+
];
|
|
195
|
+
const registryTypes = {
|
|
196
|
+
clarity: clarity,
|
|
197
|
+
"cloudflare-web-analytics": [
|
|
198
|
+
{
|
|
199
|
+
name: "CloudflareWebAnalyticsOptions",
|
|
200
|
+
kind: "const",
|
|
201
|
+
code: "export const CloudflareWebAnalyticsOptions = object({\n /**\n * The Cloudflare Web Analytics token.\n * @see https://developers.cloudflare.com/analytics/web-analytics/get-started/\n */\n token: pipe(string(), minLength(32)),\n /**\n * Cloudflare Web Analytics enables measuring SPAs automatically by overriding the History API's pushState function\n * and listening to the onpopstate. Hash-based router is not supported.\n *\n * @default true\n * @see https://developers.cloudflare.com/analytics/web-analytics/get-started/#spa-tracking\n */\n spa: optional(boolean()),\n})"
|
|
202
|
+
},
|
|
203
|
+
{
|
|
204
|
+
name: "CloudflareWebAnalyticsApi",
|
|
205
|
+
kind: "interface",
|
|
206
|
+
code: "export interface CloudflareWebAnalyticsApi {\n __cfBeacon: {\n load: 'single'\n spa: boolean\n token: string\n }\n}"
|
|
207
|
+
}
|
|
208
|
+
],
|
|
209
|
+
crisp: crisp,
|
|
210
|
+
"databuddy-analytics": [
|
|
211
|
+
{
|
|
212
|
+
name: "DatabuddyAnalyticsOptions",
|
|
213
|
+
kind: "const",
|
|
214
|
+
code: "export const DatabuddyAnalyticsOptions = object({\n /**\n * Your Databuddy client ID.\n */\n clientId: string(),\n\n /**\n * Custom script URL for the Databuddy SDK.\n * @default 'https://cdn.databuddy.cc/databuddy.js'\n */\n scriptUrl: optional(string()),\n /**\n * Custom API URL for sending analytics data.\n * @default 'https://basket.databuddy.cc'\n */\n apiUrl: optional(string()),\n /**\n * Disable all tracking when set to `true`.\n */\n disabled: optional(boolean()),\n\n /**\n * Track screen/page views automatically.\n * @default true\n * @see https://www.databuddy.cc/docs/sdk#track-screen-views\n */\n trackScreenViews: optional(boolean()),\n /**\n * Track page performance metrics.\n * @default true\n * @see https://www.databuddy.cc/docs/sdk#track-performance\n */\n trackPerformance: optional(boolean()),\n /**\n * Track user sessions.\n * @default true\n * @see https://www.databuddy.cc/docs/sdk#track-sessions\n */\n trackSessions: optional(boolean()),\n\n /**\n * Track Web Vitals (LCP, FID, CLS, etc.).\n */\n trackWebVitals: optional(boolean()),\n /**\n * Track JavaScript errors.\n */\n trackErrors: optional(boolean()),\n /**\n * Track outgoing link clicks.\n */\n trackOutgoingLinks: optional(boolean()),\n /**\n * Track scroll depth.\n */\n trackScrollDepth: optional(boolean()),\n /**\n * Track user engagement time.\n */\n trackEngagement: optional(boolean()),\n /**\n * Track user interactions (clicks, form submissions, etc.).\n */\n trackInteractions: optional(boolean()),\n /**\n * Track element attributes for detailed interaction context.\n */\n trackAttributes: optional(boolean()),\n /**\n * Track hash changes in the URL.\n */\n trackHashChanges: optional(boolean()),\n /**\n * Track exit intent behavior.\n */\n trackExitIntent: optional(boolean()),\n /**\n * Track bounce rate metrics.\n */\n trackBounceRate: optional(boolean()),\n\n /**\n * Enable event batching for better performance.\n */\n enableBatching: optional(boolean()),\n /**\n * Maximum number of events per batch.\n */\n batchSize: optional(number()),\n /**\n * Timeout (in ms) before flushing a batch.\n */\n batchTimeout: optional(number()),\n /**\n * Enable automatic retries for failed requests.\n */\n enableRetries: optional(boolean()),\n /**\n * Maximum number of retry attempts.\n */\n maxRetries: optional(number()),\n /**\n * Initial delay (in ms) before the first retry.\n */\n initialRetryDelay: optional(number()),\n /**\n * Sampling rate (0 to 1). Set to `0.5` to track ~50% of sessions.\n */\n samplingRate: optional(number()),\n\n /**\n * Custom SDK identifier.\n */\n sdk: optional(string()),\n /**\n * Custom SDK version string.\n */\n sdkVersion: optional(string()),\n\n /**\n * Enable observability/monitoring features.\n */\n enableObservability: optional(boolean()),\n /**\n * The service name for observability reporting.\n */\n observabilityService: optional(string()),\n /**\n * The environment name for observability (e.g., `'production'`, `'staging'`).\n */\n observabilityEnvironment: optional(string()),\n /**\n * The version string for observability reporting.\n */\n observabilityVersion: optional(string()),\n /**\n * Enable console logging for debugging.\n */\n enableLogging: optional(boolean()),\n /**\n * Enable request tracing.\n */\n enableTracing: optional(boolean()),\n /**\n * Enable error tracking via observability.\n */\n enableErrorTracking: optional(boolean()),\n})"
|
|
215
|
+
},
|
|
216
|
+
{
|
|
217
|
+
name: "DatabuddyAnalyticsApi",
|
|
218
|
+
kind: "interface",
|
|
219
|
+
code: "export interface DatabuddyAnalyticsApi {\n /**\n * Track a custom event.\n * @param eventName Name of the event (use snake_case)\n * @param properties Optional event properties\n */\n track: (eventName: string, properties?: Record<string, any>) => Promise<any> | any | void\n\n /**\n * Manually record a page / screen view. Useful for SPA route changes.\n * @param path Optional path to record (defaults to current location)\n * @param properties Optional additional properties for the screen view\n */\n screenView: (path?: string, properties?: Record<string, any>) => void\n\n /**\n * Set properties that will be attached to all future events (e.g. user_id).\n * @param properties Key/value map of properties to attach globally\n */\n setGlobalProperties: (properties: Record<string, any>) => void\n\n /**\n * Track a custom event alias (compatibility helper present on the global)\n * @param eventName Name of the event\n * @param properties Optional event properties\n */\n trackCustomEvent: (eventName: string, properties?: Record<string, any>) => void\n\n /**\n * Clears session and anonymous identifiers (useful on logout).\n */\n clear: () => void\n\n /**\n * Force immediate sending of any queued/batched events.\n */\n flush: () => void\n}"
|
|
220
|
+
}
|
|
221
|
+
],
|
|
222
|
+
"fathom-analytics": [
|
|
223
|
+
{
|
|
224
|
+
name: "FathomAnalyticsOptions",
|
|
225
|
+
kind: "const",
|
|
226
|
+
code: "export const FathomAnalyticsOptions = object({\n /**\n * The Fathom Analytics site ID.\n * @see https://usefathom.com/docs/script/script-settings\n */\n site: string(),\n /**\n * The Fathom Analytics tracking mode.\n * @default 'auto'\n */\n spa: optional(union([literal('auto'), literal('history'), literal('hash')])),\n /**\n * Automatically track page views.\n * @default true\n */\n auto: optional(boolean()),\n /**\n * Enable canonical URL tracking.\n * @default true\n */\n canonical: optional(boolean()),\n /**\n * Honor Do Not Track requests.\n * @default false\n */\n honorDnt: optional(boolean()),\n})"
|
|
227
|
+
},
|
|
228
|
+
{
|
|
229
|
+
name: "FathomAnalyticsApi",
|
|
230
|
+
kind: "interface",
|
|
231
|
+
code: "export interface FathomAnalyticsApi {\n beacon: (ctx: { url: string, referrer?: string }) => void\n blockTrackingForMe: () => void\n enableTrackingForMe: () => void\n isTrackingEnabled: () => boolean\n send: (type: string, data: unknown) => void\n setSite: (siteId: string) => void\n siteId: string\n trackPageview: (ctx?: { url: string, referrer?: string }) => void\n trackGoal: (goalId: string, cents: number) => void\n trackEvent: (eventName: string, value?: { _value?: number, _site_id?: string }) => void\n}"
|
|
232
|
+
}
|
|
233
|
+
],
|
|
234
|
+
"google-adsense": [
|
|
235
|
+
{
|
|
236
|
+
name: "GoogleAdsenseOptions",
|
|
237
|
+
kind: "const",
|
|
238
|
+
code: "export const GoogleAdsenseOptions = object({\n /**\n * The Google Adsense ID.\n * @example 'ca-pub-XXXXXXXXXXXXXXXX'\n */\n client: optional(string()),\n /**\n * Enable or disable Auto Ads.\n * @default false\n * @see https://support.google.com/adsense/answer/9261805\n */\n autoAds: optional(boolean()),\n})"
|
|
239
|
+
},
|
|
240
|
+
{
|
|
241
|
+
name: "GoogleAdsenseApi",
|
|
242
|
+
kind: "interface",
|
|
243
|
+
code: "export interface GoogleAdsenseApi {\n /**\n * The Google Adsense API.\n */\n adsbygoogle: any[] & { loaded?: boolean }\n}"
|
|
244
|
+
},
|
|
245
|
+
{
|
|
246
|
+
name: "ScriptGoogleAdsenseProps",
|
|
247
|
+
kind: "interface",
|
|
248
|
+
code: "interface ScriptGoogleAdsenseProps {\n dataAdClient: string\n dataAdSlot: string\n dataAdFormat?: 'auto' | 'rectangle' | 'vertical' | 'horizontal' | 'fluid' | 'autorelaxed'\n dataAdLayout?: 'in-article' | 'in-feed' | 'fixed'\n dataFullWidthResponsive?: boolean\n /**\n * Defines the trigger event to load the script.\n */\n trigger?: ElementScriptTrigger\n}"
|
|
249
|
+
},
|
|
250
|
+
{
|
|
251
|
+
name: "ScriptGoogleAdsenseDefaults",
|
|
252
|
+
kind: "const",
|
|
253
|
+
code: "const ScriptGoogleAdsenseDefaults = {\n \"dataFullWidthResponsive\": \"true\",\n \"dataAdFormat\": \"undefined\"\n}"
|
|
254
|
+
}
|
|
255
|
+
],
|
|
256
|
+
"google-analytics": [
|
|
257
|
+
{
|
|
258
|
+
name: "GtagCustomParams",
|
|
259
|
+
kind: "type",
|
|
260
|
+
code: "export type GtagCustomParams = Record<string, any>"
|
|
261
|
+
},
|
|
262
|
+
{
|
|
263
|
+
name: "ConsentStatus",
|
|
264
|
+
kind: "type",
|
|
265
|
+
code: "export type ConsentStatus = 'granted' | 'denied'"
|
|
266
|
+
},
|
|
267
|
+
{
|
|
268
|
+
name: "ConsentOptions",
|
|
269
|
+
kind: "interface",
|
|
270
|
+
code: "export interface ConsentOptions {\n ad_user_data?: ConsentStatus\n ad_personalization?: ConsentStatus\n ad_storage?: ConsentStatus\n analytics_storage?: ConsentStatus\n functionality_storage?: ConsentStatus\n personalization_storage?: ConsentStatus\n security_storage?: ConsentStatus\n wait_for_update?: number\n region?: string[]\n}"
|
|
271
|
+
},
|
|
272
|
+
{
|
|
273
|
+
name: "ConfigParams",
|
|
274
|
+
kind: "interface",
|
|
275
|
+
code: "export interface ConfigParams extends GtagCustomParams {\n send_page_view?: boolean\n transport_url?: string\n cookie_domain?: string\n cookie_prefix?: string\n cookie_expires?: number\n cookie_update?: boolean\n cookie_flags?: string\n user_id?: string\n}"
|
|
276
|
+
},
|
|
277
|
+
{
|
|
278
|
+
name: "EventParameters",
|
|
279
|
+
kind: "interface",
|
|
280
|
+
code: "export interface EventParameters extends GtagCustomParams {\n value?: number\n currency?: string\n transaction_id?: string\n items?: Array<{\n item_id?: string\n item_name?: string\n item_category?: string\n item_variant?: string\n price?: number\n quantity?: number\n [key: string]: any\n }>\n [key: string]: any\n}"
|
|
281
|
+
},
|
|
282
|
+
{
|
|
283
|
+
name: "DefaultEventName",
|
|
284
|
+
kind: "type",
|
|
285
|
+
code: "export type DefaultEventName\n = | 'add_payment_info'\n | 'add_shipping_info'\n | 'add_to_cart'\n | 'add_to_wishlist'\n | 'begin_checkout'\n | 'purchase'\n | 'refund'\n | 'remove_from_cart'\n | 'select_item'\n | 'select_promotion'\n | 'view_cart'\n | 'view_item'\n | 'view_item_list'\n | 'view_promotion'\n | 'login'\n | 'sign_up'\n | 'search'\n | 'page_view'\n | 'screen_view'\n | (string & {})"
|
|
286
|
+
},
|
|
287
|
+
{
|
|
288
|
+
name: "GTag",
|
|
289
|
+
kind: "interface",
|
|
290
|
+
code: "export interface GTag {\n // Initialize gtag.js with timestamp\n (command: 'js', value: Date): void\n\n // Configure a GA4 property\n (command: 'config', targetId: string, configParams?: ConfigParams): void\n\n // Get a value from gtag\n (command: 'get', targetId: string, fieldName: string, callback?: (field: any) => void): void\n\n // Send an event to GA4\n (command: 'event', eventName: DefaultEventName, eventParams?: EventParameters): void\n\n // Set default parameters for all subsequent events\n (command: 'set', params: GtagCustomParams): void\n\n // Update consent state\n (command: 'consent', consentArg: 'default' | 'update', consentParams: ConsentOptions): void\n}"
|
|
291
|
+
},
|
|
292
|
+
{
|
|
293
|
+
name: "DataLayerObject",
|
|
294
|
+
kind: "interface",
|
|
295
|
+
code: "export interface DataLayerObject {\n event?: string\n [key: string]: any\n}"
|
|
296
|
+
},
|
|
297
|
+
{
|
|
298
|
+
name: "DataLayer",
|
|
299
|
+
kind: "type",
|
|
300
|
+
code: "export type DataLayer = Array<DataLayerObject>"
|
|
301
|
+
},
|
|
302
|
+
{
|
|
303
|
+
name: "GoogleAnalyticsApi",
|
|
304
|
+
kind: "interface",
|
|
305
|
+
code: "export interface GoogleAnalyticsApi {\n gtag: GTag\n dataLayer: DataLayer\n}"
|
|
306
|
+
},
|
|
307
|
+
{
|
|
308
|
+
name: "GoogleAnalyticsOptions",
|
|
309
|
+
kind: "const",
|
|
310
|
+
code: "export const GoogleAnalyticsOptions = object({\n /**\n * The GA4 measurement ID.\n * @example 'G-XXXXXXXX'\n * @see https://developers.google.com/analytics/devguides/collection/gtagjs\n */\n id: optional(string()),\n /**\n * Global name for the dataLayer variable.\n * @default 'dataLayer'\n * @see https://developers.google.com/analytics/devguides/collection/gtagjs/setting-up-gtag#rename_the_data_layer\n */\n l: optional(string()),\n})"
|
|
311
|
+
}
|
|
312
|
+
],
|
|
313
|
+
"google-maps": [
|
|
314
|
+
{
|
|
315
|
+
name: "GoogleMapsOptions",
|
|
316
|
+
kind: "const",
|
|
317
|
+
code: "export const GoogleMapsOptions = object({\n /**\n * Your Google Maps API key.\n */\n apiKey: string(),\n /**\n * The Google Maps libraries to load.\n * @default ['places']\n * @see https://developers.google.com/maps/documentation/javascript/libraries\n */\n libraries: optional(array(string())),\n /**\n * The language code for the map UI and geocoding results.\n * @see https://developers.google.com/maps/faq#languagesupport\n */\n language: optional(string()),\n /**\n * The region code to bias geocoding results.\n * @see https://developers.google.com/maps/documentation/javascript/localization#Region\n */\n region: optional(string()),\n /**\n * The Google Maps JS API version to load.\n * @default 'weekly'\n * @see https://developers.google.com/maps/documentation/javascript/versions\n */\n v: optional(union([literal('weekly'), literal('quarterly'), literal('beta'), literal('alpha'), string()])),\n})"
|
|
318
|
+
},
|
|
319
|
+
{
|
|
320
|
+
name: "MapsNamespace",
|
|
321
|
+
kind: "type",
|
|
322
|
+
code: "type MapsNamespace = typeof window.google.maps"
|
|
323
|
+
},
|
|
324
|
+
{
|
|
325
|
+
name: "GoogleMapsApi",
|
|
326
|
+
kind: "interface",
|
|
327
|
+
code: "export interface GoogleMapsApi {\n maps: Promise<MapsNamespace>\n}"
|
|
328
|
+
},
|
|
329
|
+
{
|
|
330
|
+
name: "ScriptGoogleMapsProps",
|
|
331
|
+
kind: "interface",
|
|
332
|
+
code: "interface ScriptGoogleMapsProps {\n /**\n * Defines the trigger event to load the script.\n */\n trigger?: ElementScriptTrigger\n /**\n * Is Google Maps being rendered above the fold?\n * This will load the placeholder image with higher priority.\n */\n aboveTheFold?: boolean\n /**\n * Defines the Google Maps API key. Must have access to the Static Maps API as well.\n */\n apiKey?: string\n /**\n * A latitude / longitude of where to focus the map.\n */\n center?: google.maps.LatLng | google.maps.LatLngLiteral | `${string},${string}`\n /**\n * Should a marker be displayed on the map where the centre is.\n */\n centerMarker?: boolean\n /**\n * Options for the map.\n */\n mapOptions?: google.maps.MapOptions\n /**\n * Defines the region of the map.\n */\n region?: string\n /**\n * Defines the language of the map\n */\n language?: string\n /**\n * Defines the version of google maps js API\n */\n version?: string\n /**\n * Defines the width of the map.\n */\n width?: number | string\n /**\n * Defines the height of the map\n */\n height?: number | string\n /**\n * Customize the placeholder image attributes.\n *\n * @see https://developers.google.com/maps/documentation/maps-static/start.\n */\n placeholderOptions?: PlaceholderOptions\n /**\n * Customize the placeholder image attributes.\n */\n placeholderAttrs?: ImgHTMLAttributes & ReservedProps & Record<string, unknown>\n /**\n * Customize the root element attributes.\n */\n rootAttrs?: HTMLAttributes & ReservedProps & Record<string, unknown>\n /**\n * Extra Markers to add to the map.\n */\n markers?: (`${string},${string}` | google.maps.marker.AdvancedMarkerElementOptions)[]\n /**\n * Map IDs for light and dark color modes.\n * When provided, the map will automatically switch styles based on color mode.\n * Requires @nuxtjs/color-mode or manual colorMode prop.\n */\n mapIds?: { light?: string, dark?: string }\n /**\n * Manual color mode control. When provided, overrides auto-detection from @nuxtjs/color-mode.\n * Accepts 'light', 'dark', or a reactive ref.\n */\n colorMode?: 'light' | 'dark'\n}"
|
|
333
|
+
},
|
|
334
|
+
{
|
|
335
|
+
name: "ScriptGoogleMapsDefaults",
|
|
336
|
+
kind: "const",
|
|
337
|
+
code: "const ScriptGoogleMapsDefaults = {\n \"trigger\": \"['mouseenter', 'mouseover', 'mousedown']\",\n \"width\": \"640\",\n \"height\": \"400\",\n \"centerMarker\": \"true\"\n}"
|
|
338
|
+
},
|
|
339
|
+
{
|
|
340
|
+
name: "ScriptGoogleMapsAdvancedMarkerElementProps",
|
|
341
|
+
kind: "interface",
|
|
342
|
+
code: "interface ScriptGoogleMapsAdvancedMarkerElementProps {\n options?: Omit<google.maps.marker.AdvancedMarkerElementOptions, 'map'>\n}"
|
|
343
|
+
},
|
|
344
|
+
{
|
|
345
|
+
name: "ScriptGoogleMapsCircleProps",
|
|
346
|
+
kind: "interface",
|
|
347
|
+
code: "interface ScriptGoogleMapsCircleProps {\n options?: Omit<google.maps.CircleOptions, 'map'>\n}"
|
|
348
|
+
},
|
|
349
|
+
{
|
|
350
|
+
name: "ScriptGoogleMapsHeatmapLayerProps",
|
|
351
|
+
kind: "interface",
|
|
352
|
+
code: "interface ScriptGoogleMapsHeatmapLayerProps {\n options?: Omit<google.maps.visualization.HeatmapLayerOptions, 'map'>\n}"
|
|
353
|
+
},
|
|
354
|
+
{
|
|
355
|
+
name: "ScriptGoogleMapsInfoWindowProps",
|
|
356
|
+
kind: "interface",
|
|
357
|
+
code: "interface ScriptGoogleMapsInfoWindowProps {\n options?: google.maps.InfoWindowOptions\n}"
|
|
358
|
+
},
|
|
359
|
+
{
|
|
360
|
+
name: "ScriptGoogleMapsMarkerProps",
|
|
361
|
+
kind: "interface",
|
|
362
|
+
code: "interface ScriptGoogleMapsMarkerProps {\n options?: Omit<google.maps.MarkerOptions, 'map'>\n}"
|
|
363
|
+
},
|
|
364
|
+
{
|
|
365
|
+
name: "ScriptGoogleMapsMarkerClustererProps",
|
|
366
|
+
kind: "interface",
|
|
367
|
+
code: "interface ScriptGoogleMapsMarkerClustererProps {\n options?: Omit<MarkerClustererOptions, 'map'>\n}"
|
|
368
|
+
},
|
|
369
|
+
{
|
|
370
|
+
name: "ScriptGoogleMapsPinElementProps",
|
|
371
|
+
kind: "interface",
|
|
372
|
+
code: "interface ScriptGoogleMapsPinElementProps {\n options?: Omit<google.maps.marker.PinElementOptions, 'map'>\n}"
|
|
373
|
+
},
|
|
374
|
+
{
|
|
375
|
+
name: "ScriptGoogleMapsPolygonProps",
|
|
376
|
+
kind: "interface",
|
|
377
|
+
code: "interface ScriptGoogleMapsPolygonProps {\n options?: Omit<google.maps.PolygonOptions, 'map'>\n}"
|
|
378
|
+
},
|
|
379
|
+
{
|
|
380
|
+
name: "ScriptGoogleMapsPolylineProps",
|
|
381
|
+
kind: "interface",
|
|
382
|
+
code: "interface ScriptGoogleMapsPolylineProps {\n options?: Omit<google.maps.PolylineOptions, 'map'>\n}"
|
|
383
|
+
},
|
|
384
|
+
{
|
|
385
|
+
name: "ScriptGoogleMapsRectangleProps",
|
|
386
|
+
kind: "interface",
|
|
387
|
+
code: "interface ScriptGoogleMapsRectangleProps {\n options?: Omit<google.maps.RectangleOptions, 'map'>\n}"
|
|
388
|
+
}
|
|
389
|
+
],
|
|
390
|
+
"google-recaptcha": [
|
|
391
|
+
{
|
|
392
|
+
name: "GoogleRecaptchaOptions",
|
|
393
|
+
kind: "const",
|
|
394
|
+
code: "export const GoogleRecaptchaOptions = object({\n /**\n * Your reCAPTCHA site key.\n * @see https://developers.google.com/recaptcha/docs/display#render_param\n */\n siteKey: string(),\n /**\n * Use the Enterprise version of reCAPTCHA (enterprise.js instead of api.js).\n * @see https://cloud.google.com/recaptcha-enterprise/docs/introduction\n */\n enterprise: optional(boolean()),\n /**\n * Use recaptcha.net instead of google.com domain. Useful for regions where google.com is blocked.\n */\n recaptchaNet: optional(boolean()),\n /**\n * Language code for the reCAPTCHA widget.\n * @see https://developers.google.com/recaptcha/docs/language\n */\n hl: optional(string()),\n})"
|
|
395
|
+
},
|
|
396
|
+
{
|
|
397
|
+
name: "GoogleRecaptchaApi",
|
|
398
|
+
kind: "interface",
|
|
399
|
+
code: "export interface GoogleRecaptchaApi {\n grecaptcha: {\n ready: (callback: () => void) => void\n execute: (siteKey: string, options: { action: string }) => Promise<string>\n enterprise?: {\n ready: (callback: () => void) => void\n execute: (siteKey: string, options: { action: string }) => Promise<string>\n }\n }\n}"
|
|
400
|
+
}
|
|
401
|
+
],
|
|
402
|
+
"google-sign-in": [
|
|
403
|
+
{
|
|
404
|
+
name: "CredentialResponse",
|
|
405
|
+
kind: "interface",
|
|
406
|
+
code: "export interface CredentialResponse {\n credential: string // JWT token\n select_by: 'auto' | 'user' | 'user_1tap' | 'user_2tap' | 'btn' | 'btn_confirm' | 'btn_add_session' | 'btn_confirm_add_session'\n clientId?: string\n}"
|
|
407
|
+
},
|
|
408
|
+
{
|
|
409
|
+
name: "IdConfiguration",
|
|
410
|
+
kind: "interface",
|
|
411
|
+
code: "export interface IdConfiguration {\n client_id: string\n auto_select?: boolean\n callback?: (response: CredentialResponse) => void\n login_uri?: string\n native_callback?: (response: CredentialResponse) => void\n cancel_on_tap_outside?: boolean\n prompt_parent_id?: string\n nonce?: string\n context?: 'signin' | 'signup' | 'use'\n state_cookie_domain?: string\n ux_mode?: 'popup' | 'redirect'\n allowed_parent_origin?: string | string[]\n intermediate_iframe_close_callback?: () => void\n itp_support?: boolean\n login_hint?: string\n hd?: string\n use_fedcm_for_prompt?: boolean\n}"
|
|
412
|
+
},
|
|
413
|
+
{
|
|
414
|
+
name: "GsiButtonConfiguration",
|
|
415
|
+
kind: "interface",
|
|
416
|
+
code: "export interface GsiButtonConfiguration {\n type?: 'standard' | 'icon'\n theme?: 'outline' | 'filled_blue' | 'filled_black'\n size?: 'large' | 'medium' | 'small'\n text?: 'signin_with' | 'signup_with' | 'continue_with' | 'signin'\n shape?: 'rectangular' | 'pill' | 'circle' | 'square'\n logo_alignment?: 'left' | 'center'\n width?: string | number\n locale?: string\n click_listener?: () => void\n // FedCM support for button flow (mandatory from August 2025)\n use_fedcm?: boolean\n}"
|
|
417
|
+
},
|
|
418
|
+
{
|
|
419
|
+
name: "MomentType",
|
|
420
|
+
kind: "type",
|
|
421
|
+
code: "export type MomentType\n = | 'display'\n | 'skipped'\n | 'dismissed'"
|
|
422
|
+
},
|
|
423
|
+
{
|
|
424
|
+
name: "MomentNotification",
|
|
425
|
+
kind: "interface",
|
|
426
|
+
code: "export interface MomentNotification {\n isDisplayMoment: () => boolean\n isDisplayed: () => boolean\n isNotDisplayed: () => boolean\n getNotDisplayedReason: () =>\n | 'browser_not_supported'\n | 'invalid_client'\n | 'missing_client_id'\n | 'opt_out_or_no_session'\n | 'secure_http_required'\n | 'suppressed_by_user'\n | 'unregistered_origin'\n | 'unknown_reason'\n isSkippedMoment: () => boolean\n getSkippedReason: () =>\n | 'auto_cancel'\n | 'user_cancel'\n | 'tap_outside'\n | 'issuing_failed'\n isDismissedMoment: () => boolean\n getDismissedReason: () =>\n | 'credential_returned'\n | 'cancel_called'\n | 'flow_restarted'\n getMomentType: () => MomentType\n}"
|
|
427
|
+
},
|
|
428
|
+
{
|
|
429
|
+
name: "RevocationResponse",
|
|
430
|
+
kind: "interface",
|
|
431
|
+
code: "export interface RevocationResponse {\n successful: boolean\n error?: string\n}"
|
|
432
|
+
},
|
|
433
|
+
{
|
|
434
|
+
name: "AccountsNamespace",
|
|
435
|
+
kind: "type",
|
|
436
|
+
code: "type AccountsNamespace = typeof google.accounts"
|
|
437
|
+
},
|
|
438
|
+
{
|
|
439
|
+
name: "GoogleSignInApi",
|
|
440
|
+
kind: "interface",
|
|
441
|
+
code: "export interface GoogleSignInApi {\n accounts: AccountsNamespace\n}"
|
|
442
|
+
},
|
|
443
|
+
{
|
|
444
|
+
name: "GoogleSignInOptions",
|
|
445
|
+
kind: "const",
|
|
446
|
+
code: "export const GoogleSignInOptions = object({\n /**\n * Your Google API client ID.\n * @example 'XXXXXXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.apps.googleusercontent.com'\n * @see https://developers.google.com/identity/gsi/web/guides/get-google-api-clientid\n */\n clientId: string(),\n /**\n * Auto-select credentials when only one Google account is available.\n * @see https://developers.google.com/identity/gsi/web/reference/js-reference#auto_select\n */\n autoSelect: optional(boolean()),\n /**\n * The context text for the One Tap prompt.\n * @see https://developers.google.com/identity/gsi/web/reference/js-reference#context\n */\n context: optional(union([literal('signin'), literal('signup'), literal('use')])),\n /**\n * Enable FedCM (Federated Credential Management) API support. Mandatory from August 2025.\n * @see https://developers.google.com/identity/gsi/web/guides/fedcm-migration\n */\n useFedcmForPrompt: optional(boolean()),\n /**\n * Cancel the One Tap prompt if the user clicks outside.\n * @default true\n * @see https://developers.google.com/identity/gsi/web/reference/js-reference#cancel_on_tap_outside\n */\n cancelOnTapOutside: optional(boolean()),\n /**\n * The UX mode for the sign-in flow.\n * @see https://developers.google.com/identity/gsi/web/reference/js-reference#ux_mode\n */\n uxMode: optional(union([literal('popup'), literal('redirect')])),\n /**\n * The URI to redirect to after sign-in when using redirect UX mode.\n * @see https://developers.google.com/identity/gsi/web/reference/js-reference#login_uri\n */\n loginUri: optional(string()),\n /**\n * Enable Intelligent Tracking Prevention (ITP) support for Safari.\n * @see https://developers.google.com/identity/gsi/web/reference/js-reference#itp_support\n */\n itpSupport: optional(boolean()),\n /**\n * Allowed parent origin(s) for iframe embedding.\n * @see https://developers.google.com/identity/gsi/web/reference/js-reference#allowed_parent_origin\n */\n allowedParentOrigin: optional(union([string(), array(string())])),\n /**\n * Restrict sign-in to a specific Google Workspace hosted domain.\n * @example 'example.com'\n * @see https://developers.google.com/identity/gsi/web/reference/js-reference#hd\n */\n hd: optional(string()),\n})"
|
|
447
|
+
}
|
|
448
|
+
],
|
|
449
|
+
"google-tag-manager": [
|
|
450
|
+
{
|
|
451
|
+
name: "DataLayerItem",
|
|
452
|
+
kind: "type",
|
|
453
|
+
code: "export type DataLayerItem = Parameters<GTag> | Record<string, unknown>"
|
|
454
|
+
},
|
|
455
|
+
{
|
|
456
|
+
name: "DataLayer",
|
|
457
|
+
kind: "type",
|
|
458
|
+
code: "export type DataLayer = Array<DataLayerItem>"
|
|
459
|
+
},
|
|
460
|
+
{
|
|
461
|
+
name: "DataLayerPush",
|
|
462
|
+
kind: "interface",
|
|
463
|
+
code: "export interface DataLayerPush {\n (...args: Parameters<GTag>): void\n (obj: Record<string, unknown> | any[]): void\n}"
|
|
464
|
+
},
|
|
465
|
+
{
|
|
466
|
+
name: "GoogleTagManagerDataLayerApi",
|
|
467
|
+
kind: "interface",
|
|
468
|
+
code: "export interface GoogleTagManagerDataLayerApi {\n name: string\n push: DataLayerPush\n set: (config: Record<string, unknown>) => void\n get: <T = unknown>(key: string) => T\n reset: () => void\n listeners: Array<() => void>\n}"
|
|
469
|
+
},
|
|
470
|
+
{
|
|
471
|
+
name: "GoogleTagManagerDataLayerStatus",
|
|
472
|
+
kind: "interface",
|
|
473
|
+
code: "export interface GoogleTagManagerDataLayerStatus {\n dataLayer: {\n gtmDom: boolean\n gtmLoad: boolean\n subscribers: number\n [key: string]: unknown\n }\n}"
|
|
474
|
+
},
|
|
475
|
+
{
|
|
476
|
+
name: "GoogleTagManagerContainer",
|
|
477
|
+
kind: "interface",
|
|
478
|
+
code: "export interface GoogleTagManagerContainer {\n callback: () => void\n dataLayer: GoogleTagManagerDataLayerApi\n state: Record<string, unknown>\n}"
|
|
479
|
+
},
|
|
480
|
+
{
|
|
481
|
+
name: "GoogleTagManagerInstance",
|
|
482
|
+
kind: "interface",
|
|
483
|
+
code: "export interface GoogleTagManagerInstance extends GoogleTagManagerDataLayerStatus {\n [containerId: string]: GoogleTagManagerContainer | any\n}"
|
|
484
|
+
},
|
|
485
|
+
{
|
|
486
|
+
name: "GoogleTagManagerApi",
|
|
487
|
+
kind: "interface",
|
|
488
|
+
code: "export interface GoogleTagManagerApi {\n google_tag_manager: GoogleTagManagerInstance\n dataLayer: DataLayer & {\n push: DataLayerPush\n }\n}"
|
|
489
|
+
},
|
|
490
|
+
{
|
|
491
|
+
name: "GoogleTagManagerOptions",
|
|
492
|
+
kind: "const",
|
|
493
|
+
code: "export const GoogleTagManagerOptions = object({\n /**\n * GTM container ID (format: GTM-XXXXXX)\n * @see https://developers.google.com/tag-platform/tag-manager/web#install-the-container\n */\n id: string(),\n\n /**\n * Optional dataLayer variable name\n * @default 'dataLayer'\n * @see https://developers.google.com/tag-platform/tag-manager/web/datalayer#rename_the_data_layer\n */\n l: optional(string()),\n\n /**\n * Authentication token for environment-specific container versions\n * @see https://support.google.com/tagmanager/answer/6328337\n */\n auth: optional(string()),\n\n /**\n * Preview environment name\n * @see https://support.google.com/tagmanager/answer/6328337\n */\n preview: optional(string()),\n\n /** Forces GTM cookies to take precedence when true */\n cookiesWin: optional(union([boolean(), literal('x')])),\n\n /**\n * Enables debug mode when true\n * @see https://support.google.com/tagmanager/answer/6107056\n */\n debug: optional(union([boolean(), literal('x')])),\n\n /**\n * No Personal Advertising - disables advertising features when true\n * @see https://developers.google.com/tag-platform/tag-manager/templates/consent-apis\n */\n npa: optional(union([boolean(), literal('1')])),\n\n /** Custom dataLayer name (alternative to \"l\" property) */\n dataLayer: optional(string()),\n\n /**\n * Environment name for environment-specific container\n * @see https://support.google.com/tagmanager/answer/6328337\n */\n envName: optional(string()),\n\n /** Referrer policy for analytics requests */\n authReferrerPolicy: optional(string()),\n\n /**\n * Default consent settings for GTM\n * @see https://developers.google.com/tag-platform/tag-manager/templates/consent-apis\n */\n defaultConsent: optional(record(string(), union([string(), number()]))),\n})"
|
|
494
|
+
}
|
|
495
|
+
],
|
|
496
|
+
gravatar: gravatar,
|
|
497
|
+
hotjar: hotjar,
|
|
498
|
+
"instagram-embed": [
|
|
499
|
+
{
|
|
500
|
+
name: "InstagramEmbedOptions",
|
|
501
|
+
kind: "const",
|
|
502
|
+
code: "export const InstagramEmbedOptions = object({\n /**\n * The Instagram post URL to embed.\n * @example 'https://www.instagram.com/p/C_XXXXXXXXX/'\n * @see https://developers.facebook.com/docs/instagram/oembed/\n */\n postUrl: string(),\n /**\n * Whether to include captions in the embed.\n * @default true\n */\n captions: optional(boolean()),\n /**\n * Custom API endpoint for fetching embed HTML.\n * @default '/api/_scripts/instagram-embed'\n */\n apiEndpoint: optional(string()),\n})"
|
|
503
|
+
},
|
|
504
|
+
{
|
|
505
|
+
name: "ScriptInstagramEmbedProps",
|
|
506
|
+
kind: "interface",
|
|
507
|
+
code: "interface ScriptInstagramEmbedProps {\n /**\n * The Instagram post URL to embed\n * e.g., https://www.instagram.com/p/ABC123/\n */\n postUrl: string\n /**\n * Whether to include captions in the embed\n * @default true\n */\n captions?: boolean\n /**\n * Custom API endpoint for fetching embed HTML\n * @default '/api/_scripts/instagram-embed'\n */\n apiEndpoint?: string\n /**\n * Root element attributes\n */\n rootAttrs?: HTMLAttributes\n}"
|
|
508
|
+
},
|
|
509
|
+
{
|
|
510
|
+
name: "ScriptInstagramEmbedDefaults",
|
|
511
|
+
kind: "const",
|
|
512
|
+
code: "const ScriptInstagramEmbedDefaults = {\n \"captions\": \"true\",\n \"apiEndpoint\": \"'/api/_scripts/instagram-embed'\"\n}"
|
|
513
|
+
}
|
|
514
|
+
],
|
|
515
|
+
intercom: intercom,
|
|
516
|
+
"lemon-squeezy": [
|
|
517
|
+
{
|
|
518
|
+
name: "LemonSqueezyEventPayload",
|
|
519
|
+
kind: "type",
|
|
520
|
+
code: "export type LemonSqueezyEventPayload = { event: 'Checkout.Success', data: Record<string, any> }\n & { event: 'Checkout.ViewCart', data: Record<string, any> }\n & { event: 'GA.ViewCart', data: Record<string, any> }\n & { event: 'PaymentMethodUpdate.Mounted' }\n & { event: 'PaymentMethodUpdate.Closed' }\n & { event: 'PaymentMethodUpdate.Updated' }\n & { event: string }"
|
|
521
|
+
},
|
|
522
|
+
{
|
|
523
|
+
name: "LemonSqueezyApi",
|
|
524
|
+
kind: "interface",
|
|
525
|
+
code: "export interface LemonSqueezyApi {\n /**\n * Initialises Lemon.js on your page.\n */\n Setup: (options: {\n eventHandler: (event: LemonSqueezyEventPayload) => void\n }) => void\n /**\n * Refreshes `lemonsqueezy-button` listeners on the page.\n */\n Refresh: () => void\n\n Url: {\n /**\n * Opens a given Lemon Squeezy URL, typically these are Checkout or Payment Details Update overlays.\n * @param url - The URL to open.\n */\n Open: (url: string) => void\n\n /**\n * Closes the current opened Lemon Squeezy overlay checkout window.\n */\n Close: () => void\n }\n Affiliate: {\n /**\n * Retrieve the affiliate tracking ID\n */\n GetID: () => string\n\n /**\n * Append the affiliate tracking parameter to the given URL\n * @param url - The URL to append the affiliate tracking parameter to.\n */\n Build: (url: string) => string\n }\n Loader: {\n /**\n * Show the Lemon.js loader.\n */\n Show: () => void\n\n /**\n * Hide the Lemon.js loader.\n */\n Hide: () => void\n }\n}"
|
|
526
|
+
},
|
|
527
|
+
{
|
|
528
|
+
name: "ScriptLemonSqueezyProps",
|
|
529
|
+
kind: "interface",
|
|
530
|
+
code: "interface ScriptLemonSqueezyProps {\n trigger?: ElementScriptTrigger\n}"
|
|
531
|
+
},
|
|
532
|
+
{
|
|
533
|
+
name: "ScriptLemonSqueezyDefaults",
|
|
534
|
+
kind: "const",
|
|
535
|
+
code: "const ScriptLemonSqueezyDefaults = {\n \"trigger\": \"'visible'\"\n}"
|
|
536
|
+
}
|
|
537
|
+
],
|
|
538
|
+
"matomo-analytics": [
|
|
539
|
+
{
|
|
540
|
+
name: "MatomoAnalyticsOptions",
|
|
541
|
+
kind: "const",
|
|
542
|
+
code: "export const MatomoAnalyticsOptions = object({\n /**\n * The URL of your self-hosted Matomo instance.\n * Either `matomoUrl` or `cloudId` is required.\n * @example 'https://matomo.example.com'\n * @see https://developer.matomo.org/guides/tracking-javascript-guide\n */\n matomoUrl: optional(string()),\n /**\n * Your Matomo site ID.\n * @default '1'\n */\n siteId: optional(union([string(), number()])),\n /**\n * Your Matomo Cloud ID (the subdomain portion of your `*.matomo.cloud` URL).\n * Either `matomoUrl` or `cloudId` is required.\n * @example 'mysite.matomo.cloud'\n */\n cloudId: optional(string()),\n /**\n * A custom tracker URL. Overrides the default tracker endpoint derived from `matomoUrl` or `cloudId`.\n */\n trackerUrl: optional(string()),\n /**\n * Whether to track the initial page view on load.\n * @deprecated Use `watch: true` (default) for automatic page view tracking.\n */\n trackPageView: optional(boolean()),\n /**\n * Enable download and outlink tracking.\n */\n enableLinkTracking: optional(boolean()),\n /**\n * Disable all tracking cookies for cookieless analytics.\n */\n disableCookies: optional(boolean()),\n /**\n * Automatically track page views on route change.\n * @default true\n */\n watch: optional(boolean()),\n})"
|
|
543
|
+
},
|
|
544
|
+
{
|
|
545
|
+
name: "MatomoAnalyticsApi",
|
|
546
|
+
kind: "interface",
|
|
547
|
+
code: "interface MatomoAnalyticsApi {\n _paq: unknown[]\n}"
|
|
548
|
+
}
|
|
549
|
+
],
|
|
550
|
+
"meta-pixel": [
|
|
551
|
+
{
|
|
552
|
+
name: "StandardEvents",
|
|
553
|
+
kind: "type",
|
|
554
|
+
code: "type StandardEvents = 'AddPaymentInfo' | 'AddToCart' | 'AddToWishlist' | 'CompleteRegistration' | 'Contact' | 'CustomizeProduct' | 'Donate' | 'FindLocation' | 'InitiateCheckout' | 'Lead' | 'Purchase' | 'Schedule' | 'Search' | 'StartTrial' | 'SubmitApplication' | 'Subscribe' | 'ViewContent'"
|
|
555
|
+
},
|
|
556
|
+
{
|
|
557
|
+
name: "EventObjectProperties",
|
|
558
|
+
kind: "interface",
|
|
559
|
+
code: "interface EventObjectProperties {\n content_category?: string\n content_ids?: string[]\n content_name?: string\n content_type?: string\n contents?: { id: string, quantity: number }[]\n currency?: string\n delivery_category?: 'in_store' | 'curbside' | 'home_delivery'\n num_items?: number\n predicted_ltv?: number\n search_string?: string\n status?: 'completed' | 'updated' | 'viewed' | 'added_to_cart' | 'removed_from_cart' | (string & {})\n value?: number\n [key: string]: any\n}"
|
|
560
|
+
},
|
|
561
|
+
{
|
|
562
|
+
name: "ConsentAction",
|
|
563
|
+
kind: "type",
|
|
564
|
+
code: "type ConsentAction = 'grant' | 'revoke'"
|
|
565
|
+
},
|
|
566
|
+
{
|
|
567
|
+
name: "FbqArgs",
|
|
568
|
+
kind: "type",
|
|
569
|
+
code: "type FbqArgs\n = | ['track', StandardEvents, EventObjectProperties?]\n | ['trackCustom', string, EventObjectProperties?]\n | ['trackSingle', string, StandardEvents, EventObjectProperties?]\n | ['trackSingleCustom', string, string, EventObjectProperties?]\n | ['init', string]\n | ['init', number, Record<string, any>?]\n | ['consent', ConsentAction]\n // fallback: allow any fbq call signature not covered above\n | [string, ...any[]]"
|
|
570
|
+
},
|
|
571
|
+
{
|
|
572
|
+
name: "FbqFns",
|
|
573
|
+
kind: "type",
|
|
574
|
+
code: "type FbqFns = (...args: FbqArgs) => void"
|
|
575
|
+
},
|
|
576
|
+
{
|
|
577
|
+
name: "MetaPixelApi",
|
|
578
|
+
kind: "interface",
|
|
579
|
+
code: "export interface MetaPixelApi {\n fbq: FbqFns & {\n push: FbqFns\n loaded: boolean\n version: string\n queue: any[]\n }\n _fbq: MetaPixelApi['fbq']\n callMethod?: FbqFns\n}"
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
name: "MetaPixelOptions",
|
|
583
|
+
kind: "const",
|
|
584
|
+
code: "export const MetaPixelOptions = object({\n /**\n * Your Meta (Facebook) Pixel ID.\n * @see https://developers.facebook.com/docs/meta-pixel/get-started\n */\n id: union([string(), number()]),\n})"
|
|
585
|
+
}
|
|
586
|
+
],
|
|
587
|
+
npm: npm,
|
|
588
|
+
paypal: paypal,
|
|
589
|
+
"plausible-analytics": [
|
|
590
|
+
{
|
|
591
|
+
name: "PlausibleAnalyticsOptions",
|
|
592
|
+
kind: "interface",
|
|
593
|
+
code: "export interface PlausibleAnalyticsOptions {\n /**\n * Unique script ID for your site (recommended - new format as of October 2025)\n * Get this from your Plausible dashboard under Site Installation\n *\n * Extract it from your Plausible script URL:\n * ```\n * <script src=\"https://plausible.io/js/pa-gYyxvZhkMzdzXBAtSeSNz.js\"></script>\n * ^^^^^^^^^^^^^^^^^^^^^^^^^^\n * scriptId: 'gYyxvZhkMzdzXBAtSeSNz'\n * ```\n * @example 'gYyxvZhkMzdzXBAtSeSNz'\n */\n scriptId?: string\n /**\n * Your site domain\n * @deprecated Use `scriptId` instead (new October 2025 format)\n * @example 'example.com'\n */\n domain?: string\n /**\n * Script extensions for additional features\n * @deprecated Use init options like `hashBasedRouting`, `captureOnLocalhost`, etc. instead (new October 2025 format)\n */\n extension?: 'hash' | 'outbound-links' | 'file-downloads' | 'tagged-events' | 'revenue' | 'pageview-props' | 'compat' | 'local' | 'manual' | Array<'hash' | 'outbound-links' | 'file-downloads' | 'tagged-events' | 'revenue' | 'pageview-props' | 'compat' | 'local' | 'manual'>\n /** Custom properties to track with every pageview */\n customProperties?: Record<string, any>\n /** Custom tracking endpoint URL */\n endpoint?: string\n /** Configure file download tracking */\n fileDownloads?: {\n /** File extensions to track (default: pdf, xlsx, docx, txt, rtf, csv, exe, key, pps, ppt, pptx, 7z, pkg, rar, gz, zip, avi, mov, mp4, mpeg, wmv, midi, mp3, wav, wma, dmg) */\n fileExtensions?: string[]\n }\n /** Enable hash-based routing for single-page apps */\n hashBasedRouting?: boolean\n /** Set to false to manually trigger pageviews */\n autoCapturePageviews?: boolean\n /** Enable tracking on localhost */\n captureOnLocalhost?: boolean\n /** Enable form submission tracking */\n trackForms?: boolean\n}"
|
|
594
|
+
},
|
|
595
|
+
{
|
|
596
|
+
name: "PlausibleInitOptions",
|
|
597
|
+
kind: "interface",
|
|
598
|
+
code: "export interface PlausibleInitOptions {\n customProperties?: Record<string, any>\n endpoint?: string\n fileDownloads?: {\n fileExtensions?: string[]\n }\n hashBasedRouting?: boolean\n autoCapturePageviews?: boolean\n captureOnLocalhost?: boolean\n}"
|
|
599
|
+
},
|
|
600
|
+
{
|
|
601
|
+
name: "PlausibleFunction",
|
|
602
|
+
kind: "type",
|
|
603
|
+
code: "export type PlausibleFunction = ((event: '404', options: Record<string, any>) => void)\n & ((event: 'event', options: Record<string, any>) => void)\n & ((...params: any[]) => void) & {\n q: any[]\n init: (options: PlausibleInitOptions) => void\n }"
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
name: "PlausibleAnalyticsApi",
|
|
607
|
+
kind: "interface",
|
|
608
|
+
code: "export interface PlausibleAnalyticsApi {\n plausible: PlausibleFunction\n}"
|
|
609
|
+
}
|
|
610
|
+
],
|
|
611
|
+
posthog: posthog,
|
|
612
|
+
"reddit-pixel": [
|
|
613
|
+
{
|
|
614
|
+
name: "StandardEvents",
|
|
615
|
+
kind: "type",
|
|
616
|
+
code: "type StandardEvents = 'PageVisit' | 'ViewContent' | 'Search' | 'AddToCart' | 'AddToWishlist' | 'Purchase' | 'Lead' | 'SignUp'"
|
|
617
|
+
},
|
|
618
|
+
{
|
|
619
|
+
name: "RdtFns",
|
|
620
|
+
kind: "type",
|
|
621
|
+
code: "type RdtFns\n = & ((event: 'init', id: string) => void)\n & ((event: 'track', eventName: StandardEvents | (string & {}), properties?: Record<string, any>) => void)"
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
name: "RedditPixelApi",
|
|
625
|
+
kind: "interface",
|
|
626
|
+
code: "export interface RedditPixelApi {\n rdt: RdtFns & {\n sendEvent: (rdt: RedditPixelApi['rdt'], args: unknown[]) => void\n callQueue: unknown[]\n }\n}"
|
|
627
|
+
},
|
|
628
|
+
{
|
|
629
|
+
name: "RedditPixelOptions",
|
|
630
|
+
kind: "const",
|
|
631
|
+
code: "export const RedditPixelOptions = object({\n /**\n * Your Reddit Pixel advertiser ID.\n * @see https://reddithelp.com/en/categories/advertising/managing-ads/installing-reddit-pixel\n */\n id: string(),\n})"
|
|
632
|
+
}
|
|
633
|
+
],
|
|
634
|
+
"rybbit-analytics": [
|
|
635
|
+
{
|
|
636
|
+
name: "RybbitAnalyticsOptions",
|
|
637
|
+
kind: "const",
|
|
638
|
+
code: "export const RybbitAnalyticsOptions = object({\n /**\n * Your Rybbit site ID.\n * @see https://rybbit.io/docs\n */\n siteId: union([string(), number()]),\n /**\n * Automatically track page views.\n * @default true\n */\n autoTrackPageview: optional(boolean()),\n /**\n * Enable SPA (single-page app) route tracking.\n * @default true\n */\n trackSpa: optional(boolean()),\n /**\n * Include query parameters in tracked URLs.\n */\n trackQuery: optional(boolean()),\n /**\n * Track outbound link clicks.\n */\n trackOutbound: optional(boolean()),\n /**\n * Track JavaScript errors.\n */\n trackErrors: optional(boolean()),\n /**\n * Enable session replay recording.\n */\n sessionReplay: optional(boolean()),\n /**\n * Enable Web Vitals tracking (LCP, FID, CLS, etc.).\n */\n webVitals: optional(boolean()),\n /**\n * URL patterns to skip from tracking (glob syntax).\n */\n skipPatterns: optional(array(string())),\n /**\n * URL patterns to mask in tracked data (glob syntax).\n */\n maskPatterns: optional(array(string())),\n /**\n * Debounce interval (in ms) for page view tracking.\n */\n debounce: optional(number()),\n /**\n * API key for authenticated tracking.\n */\n apiKey: optional(string()),\n /**\n * Override the analytics host URL. When first-party mode is enabled, this is\n * auto-injected to route through the proxy. The SDK derives its API endpoint\n * from the script src, so this changes the script src to `${analyticsHost}/script.js`.\n */\n analyticsHost: optional(string()),\n})"
|
|
639
|
+
},
|
|
640
|
+
{
|
|
641
|
+
name: "RybbitAnalyticsApi",
|
|
642
|
+
kind: "interface",
|
|
643
|
+
code: "export interface RybbitAnalyticsApi {\n /**\n * Tracks a page view\n */\n pageview: () => void\n\n /**\n * Tracks a custom event\n * @param name Name of the event\n * @param properties Optional properties for the event\n */\n event: (name: string, properties?: Record<string, any>) => void\n\n /**\n * Sets a custom user ID for tracking logged-in users\n * @param userId The user ID to set (will be stored in localStorage)\n */\n identify: (userId: string) => void\n\n /**\n * Clears the stored user ID\n */\n clearUserId: () => void\n\n /**\n * Gets the currently set user ID\n * @returns The current user ID or null if not set\n */\n getUserId: () => string | null\n /**\n * @deprecated use top level functions instead\n */\n rybbit: RybbitAnalyticsApi\n}"
|
|
644
|
+
},
|
|
645
|
+
{
|
|
646
|
+
name: "RybbitQueueState",
|
|
647
|
+
kind: "interface",
|
|
648
|
+
code: "interface RybbitQueueState {\n queue: Array<[string, ...any[]]>\n flushed: boolean\n}"
|
|
649
|
+
}
|
|
650
|
+
],
|
|
651
|
+
segment: segment,
|
|
652
|
+
"snapchat-pixel": [
|
|
653
|
+
{
|
|
654
|
+
name: "InitObjectPropertiesSchema",
|
|
655
|
+
kind: "const",
|
|
656
|
+
code: "export const InitObjectPropertiesSchema = object({\n /**\n * The user's email address (for matching).\n */\n user_email: optional(string()),\n /**\n * The user's IP address.\n */\n ip_address: optional(string()),\n /**\n * The user's phone number (for matching).\n */\n user_phone_number: optional(string()),\n /**\n * SHA-256 hashed email address.\n */\n user_hashed_email: optional(string()),\n /**\n * SHA-256 hashed phone number.\n */\n user_hashed_phone_number: optional(string()),\n /**\n * The user's first name.\n */\n firstname: optional(string()),\n /**\n * The user's last name.\n */\n lastname: optional(string()),\n /**\n * The user's city.\n */\n geo_city: optional(string()),\n /**\n * The user's region/state.\n */\n geo_region: optional(string()),\n /**\n * The user's postal/zip code.\n */\n geo_postal_code: optional(string()),\n /**\n * The user's country code.\n */\n geo_country: optional(string()),\n /**\n * The user's age.\n */\n age: optional(string()),\n})"
|
|
657
|
+
},
|
|
658
|
+
{
|
|
659
|
+
name: "SnapTrPixelOptions",
|
|
660
|
+
kind: "const",
|
|
661
|
+
code: "export const SnapTrPixelOptions = object({\n /**\n * Your Snapchat Pixel ID.\n * @see https://businesshelp.snapchat.com/s/article/pixel-website-install\n */\n id: string(),\n /**\n * Whether to automatically track a `PAGE_VIEW` event on initialization.\n */\n trackPageView: optional(boolean()),\n ...(InitObjectPropertiesSchema?.entries || {}),\n})"
|
|
662
|
+
},
|
|
663
|
+
{
|
|
664
|
+
name: "StandardEvents",
|
|
665
|
+
kind: "type",
|
|
666
|
+
code: "type StandardEvents = 'PAGE_VIEW' | 'VIEW_CONTENT' | 'ADD_CART' | 'SIGN_UP' | 'SAVE' | 'START_CHECKOUT' | 'APP_OPEN' | 'ADD_BILLING' | 'SEARCH' | 'SUBSCRIBE' | 'AD_CLICK' | 'AD_VIEW' | 'COMPLETE_TUTORIAL' | 'LEVEL_COMPLETE' | 'INVITE' | 'LOGIN' | 'SHARE' | 'RESERVE' | 'ACHIEVEMENT_UNLOCKED' | 'ADD_TO_WISHLIST' | 'SPENT_CREDITS' | 'RATE' | 'START_TRIAL' | 'LIST_VIEW'"
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
name: "EventObjectProperties",
|
|
670
|
+
kind: "interface",
|
|
671
|
+
code: "interface EventObjectProperties {\n price?: number\n client_dedup_id?: string\n currency?: string\n transaction_id?: string\n item_ids?: string[]\n item_category?: string\n description?: string\n search_string?: string\n number_items?: number\n payment_info_available?: 0 | 1\n sign_up_method?: string\n success?: 0 | 1\n brands?: string[]\n delivery_method?: 'in_store' | 'curbside' | 'delivery'\n customer_status?: 'new' | 'returning' | 'reactivated'\n event_tag?: string\n [key: string]: any\n}"
|
|
672
|
+
},
|
|
673
|
+
{
|
|
674
|
+
name: "InitObjectProperties",
|
|
675
|
+
kind: "type",
|
|
676
|
+
code: "type InitObjectProperties = InferInput<typeof InitObjectPropertiesSchema>"
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
name: "SnapTrFns",
|
|
680
|
+
kind: "type",
|
|
681
|
+
code: "type SnapTrFns\n = ((event: 'track', eventName: StandardEvents | (string & {}), data?: EventObjectProperties) => void)\n & ((event: 'init', id: string, data?: Record<string, any>) => void)\n & ((event: 'init', id: string, data?: InitObjectProperties) => void)\n & ((event: (string & {}), ...params: any[]) => void)"
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
name: "SnapPixelApi",
|
|
685
|
+
kind: "interface",
|
|
686
|
+
code: "export interface SnapPixelApi {\n snaptr: SnapTrFns & {\n push: SnapTrFns\n loaded: boolean\n version: string\n queue: any[]\n }\n _snaptr: SnapPixelApi['snaptr']\n handleRequest?: SnapTrFns\n}"
|
|
687
|
+
}
|
|
688
|
+
],
|
|
689
|
+
stripe: stripe,
|
|
690
|
+
"tiktok-pixel": [
|
|
691
|
+
{
|
|
692
|
+
name: "StandardEvents",
|
|
693
|
+
kind: "type",
|
|
694
|
+
code: "type StandardEvents\n = 'ViewContent'\n | 'ClickButton'\n | 'Search'\n | 'AddToWishlist'\n | 'AddToCart'\n | 'InitiateCheckout'\n | 'AddPaymentInfo'\n | 'CompletePayment'\n | 'PlaceAnOrder'\n | 'Contact'\n | 'Download'\n | 'SubmitForm'\n | 'CompleteRegistration'\n | 'Subscribe'"
|
|
695
|
+
},
|
|
696
|
+
{
|
|
697
|
+
name: "EventProperties",
|
|
698
|
+
kind: "interface",
|
|
699
|
+
code: "interface EventProperties {\n content_id?: string\n content_type?: string\n content_name?: string\n contents?: Array<{ content_id: string, content_type?: string, content_name?: string, price?: number, quantity?: number }>\n currency?: string\n value?: number\n description?: string\n query?: string\n [key: string]: any\n}"
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
name: "IdentifyProperties",
|
|
703
|
+
kind: "interface",
|
|
704
|
+
code: "interface IdentifyProperties {\n email?: string\n phone_number?: string\n external_id?: string\n}"
|
|
705
|
+
},
|
|
706
|
+
{
|
|
707
|
+
name: "TtqFns",
|
|
708
|
+
kind: "type",
|
|
709
|
+
code: "type TtqFns\n = ((cmd: 'track', event: StandardEvents | (string & {}), properties?: EventProperties) => void)\n & ((cmd: 'page') => void)\n & ((cmd: 'identify', properties: IdentifyProperties) => void)\n & ((cmd: (string & {}), ...args: any[]) => void)"
|
|
710
|
+
},
|
|
711
|
+
{
|
|
712
|
+
name: "TikTokPixelApi",
|
|
713
|
+
kind: "interface",
|
|
714
|
+
code: "export interface TikTokPixelApi {\n ttq: TtqFns & {\n push: TtqFns\n loaded: boolean\n queue: any[]\n }\n}"
|
|
715
|
+
},
|
|
716
|
+
{
|
|
717
|
+
name: "TikTokPixelOptions",
|
|
718
|
+
kind: "const",
|
|
719
|
+
code: "export const TikTokPixelOptions = object({\n /**\n * Your TikTok Pixel ID.\n * @see https://ads.tiktok.com/help/article/get-started-pixel\n */\n id: string(),\n /**\n * Whether to automatically track a page view on initialization.\n * @default true\n */\n trackPageView: optional(boolean()),\n})"
|
|
720
|
+
}
|
|
721
|
+
],
|
|
722
|
+
"umami-analytics": [
|
|
723
|
+
{
|
|
724
|
+
name: "UmamiAnalyticsOptions",
|
|
725
|
+
kind: "const",
|
|
726
|
+
code: "export const UmamiAnalyticsOptions = object({\n /**\n * Your Umami website ID.\n * @see https://umami.is/docs/tracker-config\n */\n websiteId: string(), // required\n /**\n * By default, Umami will send data to wherever the script is located.\n * You can override this to send data to another location.\n * @see https://umami.is/docs/tracker-config#data-host-url\n */\n hostUrl: optional(string()),\n /**\n * By default, Umami tracks all pageviews and events for you automatically.\n * You can disable this behavior and track events yourself using the tracker functions.\n * @default true\n * @see https://umami.is/docs/tracker-functions\n */\n autoTrack: optional(boolean()),\n /**\n * If you want the tracker to only run on specific domains, you can add them to your tracker script.\n * This is a comma delimited list of domain names.\n * Helps if you are working in a staging/development environment.\n * @see https://umami.is/docs/tracker-config#data-domains\n */\n domains: optional(array(string())),\n /**\n * If you want the tracker to collect events under a specific tag.\n * Events can be filtered in the dashboard by a specific tag.\n * @see https://umami.is/docs/tracker-config#data-tag\n */\n tag: optional(string()),\n /**\n * Function that will be called before data is sent to Umami.\n * The function takes two parameters: type and payload.\n * Return the payload to continue sending, or return a falsy value to cancel.\n * @see https://umami.is/docs/tracker-config#data-before-send\n */\n beforeSend: optional(union([\n custom<(type: string, payload: Record<string, any>) => Record<string, any> | null | false>(input => typeof input === 'function'),\n string(),\n ])),\n})"
|
|
727
|
+
},
|
|
728
|
+
{
|
|
729
|
+
name: "UmamiAnalyticsApi",
|
|
730
|
+
kind: "interface",
|
|
731
|
+
code: "export interface UmamiAnalyticsApi {\n track: ((payload?: Record<string, any>) => void) & ((event_name: string, event_data: Record<string, any>) => void)\n identify: (session_data?: Record<string, any> | string) => void\n}"
|
|
732
|
+
}
|
|
733
|
+
],
|
|
734
|
+
"vercel-analytics": [
|
|
735
|
+
{
|
|
736
|
+
name: "VercelAnalyticsOptions",
|
|
737
|
+
kind: "const",
|
|
738
|
+
code: "export const VercelAnalyticsOptions = object({\n /**\n * The DSN of the project to send events to.\n * Only required when self-hosting or deploying outside of Vercel.\n */\n dsn: optional(string()),\n /**\n * Whether to disable automatic page view tracking on route changes.\n * Set to true if you want to manually call pageview().\n */\n disableAutoTrack: optional(boolean()),\n /**\n * The mode to use for the analytics script.\n * - `auto` - Automatically detect the environment (default)\n * - `production` - Always use production script\n * - `development` - Always use development script (logs to console)\n */\n mode: optional(union([literal('auto'), literal('development'), literal('production')])),\n /**\n * Whether to enable debug logging.\n * Automatically enabled in development/test environments.\n */\n debug: optional(boolean()),\n /**\n * Custom endpoint for data collection.\n * Useful for self-hosted or proxied setups.\n */\n endpoint: optional(string()),\n})"
|
|
739
|
+
},
|
|
740
|
+
{
|
|
741
|
+
name: "AllowedPropertyValues",
|
|
742
|
+
kind: "type",
|
|
743
|
+
code: "export type AllowedPropertyValues = string | number | boolean | null"
|
|
744
|
+
},
|
|
745
|
+
{
|
|
746
|
+
name: "VercelAnalyticsMode",
|
|
747
|
+
kind: "type",
|
|
748
|
+
code: "export type VercelAnalyticsMode = 'auto' | 'development' | 'production'"
|
|
749
|
+
},
|
|
750
|
+
{
|
|
751
|
+
name: "BeforeSendEvent",
|
|
752
|
+
kind: "interface",
|
|
753
|
+
code: "export interface BeforeSendEvent {\n type: 'pageview' | 'event'\n url: string\n}"
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
name: "BeforeSend",
|
|
757
|
+
kind: "type",
|
|
758
|
+
code: "export type BeforeSend = (event: BeforeSendEvent) => BeforeSendEvent | null"
|
|
759
|
+
},
|
|
760
|
+
{
|
|
761
|
+
name: "VercelAnalyticsApi",
|
|
762
|
+
kind: "interface",
|
|
763
|
+
code: "export interface VercelAnalyticsApi {\n va: (event: string, properties?: unknown) => void\n track: (name: string, properties?: Record<string, AllowedPropertyValues>) => void\n pageview: (options?: { route?: string | null, path?: string }) => void\n}"
|
|
764
|
+
}
|
|
765
|
+
],
|
|
766
|
+
"vimeo-player": [
|
|
767
|
+
{
|
|
768
|
+
name: "Constructor",
|
|
769
|
+
kind: "type",
|
|
770
|
+
code: "type Constructor<T extends new (...args: any) => any> = T extends new (...args: infer A) => infer R ? new (...args: A) => R : never"
|
|
771
|
+
},
|
|
772
|
+
{
|
|
773
|
+
name: "VimeoPlayerApi",
|
|
774
|
+
kind: "interface",
|
|
775
|
+
code: "export interface VimeoPlayerApi {\n Vimeo: {\n Player: Constructor<typeof Vimeo>\n }\n}"
|
|
776
|
+
},
|
|
777
|
+
{
|
|
778
|
+
name: "ScriptVimeoPlayerProps",
|
|
779
|
+
kind: "interface",
|
|
780
|
+
code: "interface ScriptVimeoPlayerProps {\n // custom\n trigger?: ElementScriptTrigger\n placeholderAttrs?: ImgHTMLAttributes\n rootAttrs?: HTMLAttributes\n aboveTheFold?: boolean\n vimeoOptions?: VimeoOptions\n id?: number | undefined\n url?: string | undefined\n ratio?: string\n /**\n * Object-fit for the placeholder image.\n *\n * @default 'contain'\n */\n placeholderObjectFit?: 'cover' | 'contain' | 'fill' | 'none' | 'scale-down'\n}"
|
|
781
|
+
},
|
|
782
|
+
{
|
|
783
|
+
name: "ScriptVimeoPlayerDefaults",
|
|
784
|
+
kind: "const",
|
|
785
|
+
code: "const ScriptVimeoPlayerDefaults = {\n \"trigger\": \"'mousedown'\",\n \"ratio\": \"'16/9'\",\n \"placeholderObjectFit\": \"'contain'\"\n}"
|
|
786
|
+
}
|
|
787
|
+
],
|
|
788
|
+
"x-embed": [
|
|
789
|
+
{
|
|
790
|
+
name: "XEmbedOptions",
|
|
791
|
+
kind: "const",
|
|
792
|
+
code: "export const XEmbedOptions = object({\n /**\n * The tweet ID to embed.\n * @example '1754336034228171055'\n * @see https://developer.x.com/en/docs/twitter-for-websites/embedded-tweets/overview\n */\n tweetId: string(),\n /**\n * Optional: Custom API endpoint for fetching tweet data.\n * @default '/api/_scripts/x-embed'\n */\n apiEndpoint: optional(string()),\n /**\n * Optional: Custom image proxy endpoint.\n * @default '/api/_scripts/x-embed-image'\n */\n imageProxyEndpoint: optional(string()),\n})"
|
|
793
|
+
},
|
|
794
|
+
{
|
|
795
|
+
name: "XEmbedTweetData",
|
|
796
|
+
kind: "interface",
|
|
797
|
+
code: "export interface XEmbedTweetData {\n id_str: string\n text: string\n created_at: string\n favorite_count: number\n conversation_count: number\n user: {\n name: string\n screen_name: string\n profile_image_url_https: string\n verified?: boolean\n is_blue_verified?: boolean\n }\n entities?: {\n media?: Array<{\n media_url_https: string\n type: string\n sizes: Record<string, { w: number, h: number }>\n }>\n urls?: Array<{\n url: string\n expanded_url: string\n display_url: string\n }>\n }\n photos?: Array<{\n url: string\n width: number\n height: number\n }>\n video?: {\n poster: string\n variants: Array<{ type: string, src: string }>\n }\n quoted_tweet?: XEmbedTweetData\n parent?: {\n user: {\n screen_name: string\n }\n }\n}"
|
|
798
|
+
},
|
|
799
|
+
{
|
|
800
|
+
name: "ScriptXEmbedProps",
|
|
801
|
+
kind: "interface",
|
|
802
|
+
code: "interface ScriptXEmbedProps {\n /**\n * The tweet ID to embed\n */\n tweetId: string\n /**\n * Custom API endpoint for fetching tweet data\n * @default '/api/_scripts/x-embed'\n */\n apiEndpoint?: string\n /**\n * Custom image proxy endpoint\n * @default '/_scripts/x-embed-image'\n */\n imageProxyEndpoint?: string\n /**\n * Root element attributes\n */\n rootAttrs?: HTMLAttributes\n}"
|
|
803
|
+
},
|
|
804
|
+
{
|
|
805
|
+
name: "ScriptXEmbedDefaults",
|
|
806
|
+
kind: "const",
|
|
807
|
+
code: "const ScriptXEmbedDefaults = {\n \"apiEndpoint\": \"'/api/_scripts/x-embed'\",\n \"imageProxyEndpoint\": \"'/api/_scripts/x-embed-image'\"\n}"
|
|
808
|
+
}
|
|
809
|
+
],
|
|
810
|
+
"x-pixel": [
|
|
811
|
+
{
|
|
812
|
+
name: "ContentProperties",
|
|
813
|
+
kind: "interface",
|
|
814
|
+
code: "interface ContentProperties {\n content_type?: string | null\n content_id?: string | number | null\n content_name?: string | null\n content_price?: string | number | null\n num_items?: string | number | null\n content_group_id?: string | number | null\n}"
|
|
815
|
+
},
|
|
816
|
+
{
|
|
817
|
+
name: "EventObjectProperties",
|
|
818
|
+
kind: "interface",
|
|
819
|
+
code: "interface EventObjectProperties {\n // this is the same as Twitter events\n value?: string | number | null\n currency?: string | null\n conversion_id?: string | number | null\n email_address?: string | null\n phone_number?: string | null\n contents: ContentProperties[]\n}"
|
|
820
|
+
},
|
|
821
|
+
{
|
|
822
|
+
name: "TwqFns",
|
|
823
|
+
kind: "type",
|
|
824
|
+
code: "type TwqFns\n = ((event: 'event', eventId: string, data?: EventObjectProperties) => void)\n & ((event: 'config', id: string) => void)\n & ((event: (string & {}), ...params: any[]) => void)"
|
|
825
|
+
},
|
|
826
|
+
{
|
|
827
|
+
name: "XPixelApi",
|
|
828
|
+
kind: "interface",
|
|
829
|
+
code: "export interface XPixelApi {\n twq: TwqFns & {\n loaded: boolean\n version: string\n queue: any[]\n }\n}"
|
|
830
|
+
},
|
|
831
|
+
{
|
|
832
|
+
name: "XPixelOptions",
|
|
833
|
+
kind: "const",
|
|
834
|
+
code: "export const XPixelOptions = object({\n /**\n * Your X (Twitter) Pixel ID.\n * @see https://business.twitter.com/en/help/campaign-measurement-and-analytics/conversion-tracking-for-websites.html\n */\n id: string(),\n /**\n * The X Pixel script version.\n * @default '1.1'\n */\n version: optional(string()),\n})"
|
|
835
|
+
}
|
|
836
|
+
],
|
|
837
|
+
"youtube-player": [
|
|
838
|
+
{
|
|
839
|
+
name: "YouTubePlayerApi",
|
|
840
|
+
kind: "interface",
|
|
841
|
+
code: "export interface YouTubePlayerApi {\n YT: MaybePromise<{\n Player: YT.Player\n PlayerState: YT.PlayerState\n get: (k: string) => any\n loaded: 0 | 1\n loading: 0 | 1\n ready: (f: () => void) => void\n scan: () => void\n setConfig: (config: YT.PlayerOptions) => void\n subscribe: <EventName extends keyof YT.Events>(\n event: EventName,\n listener: YT.Events[EventName],\n context?: any,\n ) => void\n unsubscribe: <EventName extends keyof YT.Events>(\n event: EventName,\n listener: YT.Events[EventName],\n context?: any,\n ) => void\n }>\n}"
|
|
842
|
+
},
|
|
843
|
+
{
|
|
844
|
+
name: "ScriptYouTubePlayerProps",
|
|
845
|
+
kind: "interface",
|
|
846
|
+
code: "interface ScriptYouTubePlayerProps {\n placeholderAttrs?: ImgHTMLAttributes\n rootAttrs?: HTMLAttributes\n aboveTheFold?: boolean\n trigger?: ElementScriptTrigger\n videoId: string\n playerVars?: YT.PlayerVars\n width?: number\n height?: number\n ratio?: string\n /**\n * Whether to use youtube-nocookie.com for embedding.\n *\n * @default false\n */\n cookies?: boolean\n playerOptions?: YT.PlayerOptions\n thumbnailSize?: YoutubeThumbnailSize\n webp?: boolean\n /**\n * Object-fit for the placeholder image.\n *\n * @default 'cover'\n */\n placeholderObjectFit?: 'cover' | 'contain' | 'fill' | 'none' | 'scale-down'\n}"
|
|
847
|
+
},
|
|
848
|
+
{
|
|
849
|
+
name: "ScriptYouTubePlayerDefaults",
|
|
850
|
+
kind: "const",
|
|
851
|
+
code: "const ScriptYouTubePlayerDefaults = {\n \"cookies\": \"false\",\n \"trigger\": \"'mousedown'\",\n \"thumbnailSize\": \"'hq720'\",\n \"webp\": \"true\",\n \"playerVars\": \"{ autoplay: 0, playsinline: 1 }\",\n \"width\": \"640\",\n \"height\": \"360\",\n \"ratio\": \"'16/9'\",\n \"placeholderObjectFit\": \"'cover'\"\n}"
|
|
852
|
+
}
|
|
853
|
+
],
|
|
854
|
+
"carbon-ads": [
|
|
855
|
+
{
|
|
856
|
+
name: "ScriptCarbonAdsProps",
|
|
857
|
+
kind: "interface",
|
|
858
|
+
code: "interface ScriptCarbonAdsProps {\n serve: string\n placement: string\n format: string\n /**\n * Defines the trigger event to load the script.\n */\n trigger?: ElementScriptTrigger\n}"
|
|
859
|
+
}
|
|
860
|
+
]
|
|
861
|
+
};
|
|
862
|
+
|
|
863
|
+
const JSDOC_START_RE = /^\s*\/\*\*/;
|
|
864
|
+
const JSDOC_END_RE = /^\s*\*\//;
|
|
865
|
+
const DOC_LINE_RE = /^\s*\*\s?(.*)/;
|
|
866
|
+
const DEFAULT_TAG_RE = /^@default\s*/;
|
|
867
|
+
const NAME_MATCH_RE = /^\s*(\w+)/;
|
|
868
|
+
const FIELD_MATCH_RE = /^\s*(\w+)\s*:/;
|
|
869
|
+
function getRegistryTypes() {
|
|
870
|
+
return registryTypes;
|
|
871
|
+
}
|
|
872
|
+
function resolveType(schema) {
|
|
873
|
+
if (!schema)
|
|
874
|
+
return "unknown";
|
|
875
|
+
switch (schema.type) {
|
|
876
|
+
case "string":
|
|
877
|
+
return "string";
|
|
878
|
+
case "number":
|
|
879
|
+
return "number";
|
|
880
|
+
case "boolean":
|
|
881
|
+
return "boolean";
|
|
882
|
+
case "array":
|
|
883
|
+
return `${resolveType(schema.item)}[]`;
|
|
884
|
+
case "object":
|
|
885
|
+
return "object";
|
|
886
|
+
case "union":
|
|
887
|
+
return schema.options?.map((o) => resolveType(o)).join(" | ") || "unknown";
|
|
888
|
+
case "literal":
|
|
889
|
+
return typeof schema.literal === "string" ? `'${schema.literal}'` : String(schema.literal);
|
|
890
|
+
case "record":
|
|
891
|
+
return `Record<${resolveType(schema.key)}, ${resolveType(schema.value)}>`;
|
|
892
|
+
case "custom":
|
|
893
|
+
return "Function";
|
|
894
|
+
case "any":
|
|
895
|
+
return "any";
|
|
896
|
+
default:
|
|
897
|
+
return schema.type || "unknown";
|
|
898
|
+
}
|
|
899
|
+
}
|
|
900
|
+
function parseComments(code) {
|
|
901
|
+
const result = {};
|
|
902
|
+
const lines = code.split("\n");
|
|
903
|
+
let desc = "";
|
|
904
|
+
let def = "";
|
|
905
|
+
for (const line of lines) {
|
|
906
|
+
if (JSDOC_START_RE.test(line)) {
|
|
907
|
+
desc = "";
|
|
908
|
+
def = "";
|
|
909
|
+
continue;
|
|
910
|
+
}
|
|
911
|
+
if (JSDOC_END_RE.test(line))
|
|
912
|
+
continue;
|
|
913
|
+
const docLine = line.match(DOC_LINE_RE);
|
|
914
|
+
if (docLine) {
|
|
915
|
+
const content = docLine[1].trim();
|
|
916
|
+
if (content.startsWith("@default"))
|
|
917
|
+
def = content.replace(DEFAULT_TAG_RE, "");
|
|
918
|
+
else if (!content.startsWith("@") && content)
|
|
919
|
+
desc += (desc ? " " : "") + content;
|
|
920
|
+
continue;
|
|
921
|
+
}
|
|
922
|
+
const colonIdx = line.indexOf(":");
|
|
923
|
+
const commentIdx = colonIdx > 0 ? line.indexOf("//", colonIdx) : -1;
|
|
924
|
+
if (colonIdx > 0 && commentIdx > colonIdx) {
|
|
925
|
+
const nameMatch = line.match(NAME_MATCH_RE);
|
|
926
|
+
if (nameMatch) {
|
|
927
|
+
const comment = line.slice(commentIdx + 2).trim();
|
|
928
|
+
result[nameMatch[1]] = { description: desc || comment, defaultValue: def || void 0 };
|
|
929
|
+
desc = "";
|
|
930
|
+
def = "";
|
|
931
|
+
continue;
|
|
932
|
+
}
|
|
933
|
+
}
|
|
934
|
+
const fieldMatch = line.match(FIELD_MATCH_RE);
|
|
935
|
+
if (fieldMatch) {
|
|
936
|
+
if (desc || def)
|
|
937
|
+
result[fieldMatch[1]] = { description: desc || void 0, defaultValue: def || void 0 };
|
|
938
|
+
desc = "";
|
|
939
|
+
def = "";
|
|
940
|
+
}
|
|
941
|
+
}
|
|
942
|
+
return result;
|
|
943
|
+
}
|
|
944
|
+
function getRegistrySchemaFields() {
|
|
945
|
+
const types = registryTypes;
|
|
946
|
+
const result = {};
|
|
947
|
+
for (const declarations of Object.values(types)) {
|
|
948
|
+
for (const decl of declarations) {
|
|
949
|
+
if (decl.kind !== "const" || decl.name.endsWith("Defaults"))
|
|
950
|
+
continue;
|
|
951
|
+
const schema = schemas[decl.name];
|
|
952
|
+
if (!schema?.entries)
|
|
953
|
+
continue;
|
|
954
|
+
const comments = parseComments(decl.code);
|
|
955
|
+
const fields = [];
|
|
956
|
+
for (const [name, entry] of Object.entries(schema.entries)) {
|
|
957
|
+
const e = entry;
|
|
958
|
+
const isOptional = e.type === "optional";
|
|
959
|
+
const inner = isOptional ? e.wrapped : e;
|
|
960
|
+
fields.push({
|
|
961
|
+
name,
|
|
962
|
+
type: resolveType(inner),
|
|
963
|
+
required: !isOptional,
|
|
964
|
+
description: comments[name]?.description,
|
|
965
|
+
defaultValue: comments[name]?.defaultValue
|
|
966
|
+
});
|
|
967
|
+
}
|
|
968
|
+
if (fields.length)
|
|
969
|
+
result[decl.name] = fields;
|
|
970
|
+
}
|
|
971
|
+
}
|
|
972
|
+
return result;
|
|
973
|
+
}
|
|
974
|
+
|
|
975
|
+
export { getRegistrySchemaFields, getRegistryTypes };
|