@c15t/scripts 3.0.0-alpha.2 → 3.0.0-alpha.4

package/dist-types/registry.d.ts

@@ -1,485 +1,2 @@
-/**
- * High-level product area for a built-in script integration.
- *
- * Used for discovery surfaces such as docs navigation and CLI grouping. This is
- * intentionally separate from a manifest consent category.
- */
-export type IntegrationCategory = 'analytics' | 'ads-and-pixels' | 'functional' | 'tag-manager';
-/**
- * Consent bucket that a built-in integration maps to by default.
- *
- * These values mirror c15t's consent categories without importing core types, so
- * the registry stays safe to consume from docs and CLI code.
- */
-export type IntegrationConsentCategory = 'necessary' | 'functionality' | 'experience' | 'measurement' | 'marketing';
-/**
- * Display metadata for an integration category.
- *
- * @example
- * ```ts
- * const label = BUILT_IN_INTEGRATION_CATEGORIES[0]?.label;
- * ```
- */
-export interface IntegrationCategoryEntry {
-    /** Stable category key used by registry entries. */
-    key: IntegrationCategory;
-    /** Human-readable label for display surfaces. */
-    label: string;
-}
-/**
- * Identity and discovery metadata for a built-in script integration.
- *
- * All fields are required except `hint`, which is optional short help text for
- * picker UIs. Do not add runtime behavior, disclosure metadata, or vendor
- * implementation details here.
- */
-export interface IntegrationRegistryEntry {
-    /** Stable key used by tests and generated metadata. */
-    key: string;
-    /** Script id emitted by the resolved helper. */
-    vendor: string;
-    /** Human-readable integration name. */
-    label: string;
-    /** Optional short description for CLI or docs picker UIs. */
-    hint?: string;
-    /** Docs route slug for this integration. */
-    docsSlug: string;
-    /** Package subpath, e.g. `meta-pixel` for `@c15t/scripts/meta-pixel`. */
-    packageSubpath: string;
-    /** Product area used for grouping and discovery. */
-    integrationCategory: IntegrationCategory;
-    /** Default consent bucket expected from the generated script. */
-    consentCategory: IntegrationConsentCategory;
-}
-/**
- * Canonical display list for built-in integration categories.
- *
- * Consumers should use this list for category labels and ordering instead of
- * re-declaring category names.
- */
-export declare const BUILT_IN_INTEGRATION_CATEGORIES: readonly [{
-    readonly key: 'analytics';
-    readonly label: 'Analytics';
-}, {
-    readonly key: 'ads-and-pixels';
-    readonly label: 'Ads & Pixels';
-}, {
-    readonly key: 'functional';
-    readonly label: 'Functional';
-}, {
-    readonly key: 'tag-manager';
-    readonly label: 'Tag Managers';
-}];
-/**
- * Canonical identity catalog for built-in `@c15t/scripts` integrations.
- *
- * Adding a new built-in integration should add one row here so docs, tests, and
- * the CLI can discover it from the same source.
- */
-export declare const builtInScriptIntegrations: readonly [{
-    readonly consentCategory: 'necessary';
-    readonly docsSlug: 'cloudflare-zaraz';
-    readonly hint: 'Consent bridge for tools managed by Zaraz';
-    readonly integrationCategory: 'tag-manager';
-    readonly key: 'cloudflareZaraz';
-    readonly label: 'Cloudflare Zaraz';
-    readonly packageSubpath: 'cloudflare-zaraz';
-    readonly vendor: 'cloudflare-zaraz';
-}, {
-    readonly consentCategory: 'necessary';
-    readonly docsSlug: 'google-tag-manager';
-    readonly hint: 'GTM container script';
-    readonly integrationCategory: 'tag-manager';
-    readonly key: 'googleTagManager';
-    readonly label: 'Google Tag Manager';
-    readonly packageSubpath: 'google-tag-manager';
-    readonly vendor: 'google-tag-manager';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'google-tag';
-    readonly hint: 'Google Analytics 4';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'gtag';
-    readonly label: 'Google Tag (gtag.js)';
-    readonly packageSubpath: 'google-tag';
-    readonly vendor: 'gtag';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'ahrefs-analytics';
-    readonly hint: 'Cookieless web analytics from Ahrefs';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'ahrefsAnalytics';
-    readonly label: 'Ahrefs Analytics';
-    readonly packageSubpath: 'ahrefs-analytics';
-    readonly vendor: 'ahrefs-analytics';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'adobe-analytics';
-    readonly hint: 'Adobe Experience Platform tags';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'adobeAnalytics';
-    readonly label: 'Adobe Analytics';
-    readonly packageSubpath: 'adobe-analytics';
-    readonly vendor: 'adobe-analytics';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'amplitude';
-    readonly hint: 'Product analytics';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'amplitude';
-    readonly label: 'Amplitude';
-    readonly packageSubpath: 'amplitude';
-    readonly vendor: 'amplitude';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'cloudflare-web-analytics';
-    readonly hint: 'Cookieless analytics from Cloudflare';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'cloudflareWebAnalytics';
-    readonly label: 'Cloudflare Web Analytics';
-    readonly packageSubpath: 'cloudflare-web-analytics';
-    readonly vendor: 'cloudflare-web-analytics';
-}, {
-    readonly consentCategory: 'marketing';
-    readonly docsSlug: 'clearbit';
-    readonly hint: 'Visitor and company enrichment';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'clearbit';
-    readonly label: 'Clearbit';
-    readonly packageSubpath: 'clearbit';
-    readonly vendor: 'clearbit';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'microsoft-clarity';
-    readonly hint: 'Session replay and heatmaps';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'microsoft-clarity';
-    readonly label: 'Microsoft Clarity';
-    readonly packageSubpath: 'microsoft-clarity';
-    readonly vendor: 'microsoft-clarity';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'databuddy';
-    readonly hint: 'Data collection';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'databuddy';
-    readonly label: 'Databuddy';
-    readonly packageSubpath: 'databuddy';
-    readonly vendor: 'databuddy';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'fathom-analytics';
-    readonly hint: 'Privacy-friendly cookieless analytics';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'fathomAnalytics';
-    readonly label: 'Fathom Analytics';
-    readonly packageSubpath: 'fathom-analytics';
-    readonly vendor: 'fathom-analytics';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'heap';
-    readonly hint: 'Autocapture product analytics';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'heap';
-    readonly label: 'Heap';
-    readonly packageSubpath: 'heap';
-    readonly vendor: 'heap';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'mixpanel-analytics';
-    readonly hint: 'Product analytics and funnels';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'mixpanelAnalytics';
-    readonly label: 'Mixpanel Analytics';
-    readonly packageSubpath: 'mixpanel-analytics';
-    readonly vendor: 'mixpanel-analytics';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'one-dollar-stats';
-    readonly hint: 'Website analytics with no API key';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'oneDollarStats';
-    readonly label: 'OneDollarStats';
-    readonly packageSubpath: 'one-dollar-stats';
-    readonly vendor: 'one-dollar-stats';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'hotjar';
-    readonly hint: 'Heatmaps and session recordings';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'hotjar';
-    readonly label: 'Hotjar';
-    readonly packageSubpath: 'hotjar';
-    readonly vendor: 'hotjar';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'hightouch';
-    readonly hint: 'Customer data platform events';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'hightouch';
-    readonly label: 'Hightouch';
-    readonly packageSubpath: 'hightouch';
-    readonly vendor: 'hightouch';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'rudderstack';
-    readonly hint: 'Customer data platform events';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'rudderstack';
-    readonly label: 'RudderStack';
-    readonly packageSubpath: 'rudderstack';
-    readonly vendor: 'rudderstack';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'logrocket';
-    readonly hint: 'Session replay and monitoring';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'logRocket';
-    readonly label: 'LogRocket';
-    readonly packageSubpath: 'logrocket';
-    readonly vendor: 'logrocket';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'matomo-analytics';
-    readonly hint: 'Self-hosted privacy analytics';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'matomoAnalytics';
-    readonly label: 'Matomo Analytics';
-    readonly packageSubpath: 'matomo-analytics';
-    readonly vendor: 'matomo-analytics';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'posthog';
-    readonly hint: 'Product analytics';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'posthog';
-    readonly label: 'PostHog';
-    readonly packageSubpath: 'posthog';
-    readonly vendor: 'posthog';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'promptwatch';
-    readonly hint: 'AI traffic analytics';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'promptwatch';
-    readonly label: 'Promptwatch';
-    readonly packageSubpath: 'promptwatch';
-    readonly vendor: 'promptwatch';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'pirsch';
-    readonly hint: 'Privacy-friendly cookieless analytics';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'pirsch';
-    readonly label: 'Pirsch';
-    readonly packageSubpath: 'pirsch';
-    readonly vendor: 'pirsch';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'segment';
-    readonly hint: 'Customer data platform';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'segment';
-    readonly label: 'Segment';
-    readonly packageSubpath: 'segment';
-    readonly vendor: 'segment';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'rybbit-analytics';
-    readonly hint: 'Privacy-friendly web analytics';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'rybbitAnalytics';
-    readonly label: 'Rybbit Analytics';
-    readonly packageSubpath: 'rybbit-analytics';
-    readonly vendor: 'rybbit-analytics';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'plausible-analytics';
-    readonly hint: 'Privacy-friendly cookieless analytics';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'plausibleAnalytics';
-    readonly label: 'Plausible Analytics';
-    readonly packageSubpath: 'plausible-analytics';
-    readonly vendor: 'plausible-analytics';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'umami-analytics';
-    readonly hint: 'Open-source cookieless analytics';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'umamiAnalytics';
-    readonly label: 'Umami Analytics';
-    readonly packageSubpath: 'umami-analytics';
-    readonly vendor: 'umami-analytics';
-}, {
-    readonly consentCategory: 'measurement';
-    readonly docsSlug: 'vercel-analytics';
-    readonly hint: 'Vercel web analytics';
-    readonly integrationCategory: 'analytics';
-    readonly key: 'vercelAnalytics';
-    readonly label: 'Vercel Analytics';
-    readonly packageSubpath: 'vercel-analytics';
-    readonly vendor: 'vercel-analytics';
-}, {
-    readonly consentCategory: 'functionality';
-    readonly docsSlug: 'crisp';
-    readonly hint: 'Live chat widget';
-    readonly integrationCategory: 'functional';
-    readonly key: 'crisp';
-    readonly label: 'Crisp';
-    readonly packageSubpath: 'crisp';
-    readonly vendor: 'crisp';
-}, {
-    readonly consentCategory: 'functionality';
-    readonly docsSlug: 'front-chat';
-    readonly hint: 'Live chat widget';
-    readonly integrationCategory: 'functional';
-    readonly key: 'frontChat';
-    readonly label: 'Front Chat';
-    readonly packageSubpath: 'front-chat';
-    readonly vendor: 'front-chat';
-}, {
-    readonly consentCategory: 'functionality';
-    readonly docsSlug: 'intercom';
-    readonly hint: 'Messenger and live chat widget';
-    readonly integrationCategory: 'functional';
-    readonly key: 'intercom';
-    readonly label: 'Intercom';
-    readonly packageSubpath: 'intercom';
-    readonly vendor: 'intercom';
-}, {
-    readonly consentCategory: 'marketing';
-    readonly docsSlug: 'meta-pixel';
-    readonly hint: 'Facebook/Instagram tracking';
-    readonly integrationCategory: 'ads-and-pixels';
-    readonly key: 'metaPixel';
-    readonly label: 'Meta Pixel';
-    readonly packageSubpath: 'meta-pixel';
-    readonly vendor: 'meta-pixel';
-}, {
-    readonly consentCategory: 'marketing';
-    readonly docsSlug: 'openai-pixel';
-    readonly hint: 'ChatGPT Ads conversion measurement';
-    readonly integrationCategory: 'ads-and-pixels';
-    readonly key: 'openaiPixel';
-    readonly label: 'OpenAI Pixel (ChatGPT Ads)';
-    readonly packageSubpath: 'openai-pixel';
-    readonly vendor: 'openai-pixel';
-}, {
-    readonly consentCategory: 'marketing';
-    readonly docsSlug: 'pinterest-tag';
-    readonly hint: 'Pinterest ads tracking';
-    readonly integrationCategory: 'ads-and-pixels';
-    readonly key: 'pinterestTag';
-    readonly label: 'Pinterest Tag';
-    readonly packageSubpath: 'pinterest-tag';
-    readonly vendor: 'pinterest-tag';
-}, {
-    readonly consentCategory: 'marketing';
-    readonly docsSlug: 'reddit-pixel';
-    readonly hint: 'Reddit ads tracking';
-    readonly integrationCategory: 'ads-and-pixels';
-    readonly key: 'redditPixel';
-    readonly label: 'Reddit Pixel';
-    readonly packageSubpath: 'reddit-pixel';
-    readonly vendor: 'reddit-pixel';
-}, {
-    readonly consentCategory: 'marketing';
-    readonly docsSlug: 'tiktok-pixel';
-    readonly hint: 'TikTok ads tracking';
-    readonly integrationCategory: 'ads-and-pixels';
-    readonly key: 'tiktokPixel';
-    readonly label: 'TikTok Pixel';
-    readonly packageSubpath: 'tiktok-pixel';
-    readonly vendor: 'tiktok-pixel';
-}, {
-    readonly consentCategory: 'marketing';
-    readonly docsSlug: 'linkedin-insights';
-    readonly hint: 'LinkedIn conversion tracking';
-    readonly integrationCategory: 'ads-and-pixels';
-    readonly key: 'linkedinInsights';
-    readonly label: 'LinkedIn Insight Tag';
-    readonly packageSubpath: 'linkedin-insights';
-    readonly vendor: 'linkedin-insights';
-}, {
-    readonly consentCategory: 'marketing';
-    readonly docsSlug: 'microsoft-uet';
-    readonly hint: 'Bing Ads tracking';
-    readonly integrationCategory: 'ads-and-pixels';
-    readonly key: 'microsoftUet';
-    readonly label: 'Microsoft UET';
-    readonly packageSubpath: 'microsoft-uet';
-    readonly vendor: 'microsoft-uet';
-}, {
-    readonly consentCategory: 'marketing';
-    readonly docsSlug: 'snapchat-pixel';
-    readonly hint: 'Snapchat ads tracking';
-    readonly integrationCategory: 'ads-and-pixels';
-    readonly key: 'snapchatPixel';
-    readonly label: 'Snapchat Pixel';
-    readonly packageSubpath: 'snapchat-pixel';
-    readonly vendor: 'snapchat-pixel';
-}, {
-    readonly consentCategory: 'marketing';
-    readonly docsSlug: 'x-pixel';
-    readonly hint: 'X/Twitter conversion tracking';
-    readonly integrationCategory: 'ads-and-pixels';
-    readonly key: 'xPixel';
-    readonly label: 'X (Twitter) Pixel';
-    readonly packageSubpath: 'x-pixel';
-    readonly vendor: 'x-pixel';
-}];
-/**
- * Concrete registry entry type inferred from `builtInScriptIntegrations`.
- */
-export type BuiltInScriptIntegration = (typeof builtInScriptIntegrations)[number];
-/**
- * Union of stable keys for built-in integrations.
- */
-export type BuiltInScriptIntegrationKey = BuiltInScriptIntegration['key'];
-/**
- * Union of public package subpaths for built-in integrations.
- */
-export type BuiltInScriptIntegrationSubpath = BuiltInScriptIntegration['packageSubpath'];
-/**
- * Looks up a built-in integration by its registry key.
- *
- * @param key - Stable integration key.
- * @returns The matching built-in integration entry.
- * @throws {Error}("Unknown built-in script integration: <key>")` when the key is
- * not present. Catch this when accepting untrusted or user-provided keys.
- *
- * @example
- * ```ts
- * const integration = getBuiltInScriptIntegration('metaPixel');
- * console.log(integration.packageSubpath); // "meta-pixel"
- * ```
- */
-export declare const getBuiltInScriptIntegration: (key: BuiltInScriptIntegrationKey) => BuiltInScriptIntegration;
-/**
- * Finds a built-in integration by its public package subpath.
- *
- * @param subpath - Kebab-case subpath such as `google-tag`.
- * @returns The matching integration, or `undefined` when no entry matches.
- *
- * @example
- * ```ts
- * const integration = getBuiltInScriptIntegrationBySubpath('meta-pixel');
- * console.log(integration?.label); // "Meta Pixel"
- * ```
- */
-export declare const getBuiltInScriptIntegrationBySubpath: (subpath: string) => BuiltInScriptIntegration | undefined;
-/**
- * Finds a built-in integration by the emitted script vendor id.
- *
- * Use this to connect a resolved manifest/script id back to registry metadata.
- *
- * @param vendor - Vendor id emitted as `Script.id`.
- * @returns The matching integration, or `undefined` when no entry matches.
- *
- * @example
- * ```ts
- * const integration = getBuiltInScriptIntegrationByVendor('google-tag-manager');
- * console.log(integration?.label); // "Google Tag Manager"
- * ```
- */
-export declare const getBuiltInScriptIntegrationByVendor: (vendor: string) => BuiltInScriptIntegration | undefined;
+/** @deprecated Use @c15t/integrations/registry. Compatibility ends in v4. */
+export * from '@c15t/integrations/registry';

package/dist-types/resolve.d.ts

@@ -1,9 +1,2 @@
-import type { Script } from '@c15t/core';
-import type { VendorManifest } from './types.js';
-/**
- * Compiles a `VendorManifest` + config into a `Script` object.
- *
- * This compatibility wrapper preserves the existing public resolver API while
- * delegating to the new compile and runtime conversion phases internally.
- */
-export declare const resolveManifest: (manifest: VendorManifest, config?: Record<string, unknown>) => Script;
+/** @deprecated Use @c15t/integrations/resolve. Compatibility ends in v4. */
+export * from '@c15t/integrations/resolve';

package/dist-types/rudderstack.d.ts

@@ -0,0 +1,2 @@
+/** @deprecated Use @c15t/integrations/rudderstack. Compatibility ends in v4. */
+export * from '@c15t/integrations/rudderstack';

package/dist-types/rybbit-analytics.d.ts

@@ -0,0 +1,2 @@
+/** @deprecated Use @c15t/integrations/rybbit-analytics. Compatibility ends in v4. */
+export * from '@c15t/integrations/rybbit-analytics';

package/dist-types/segment.d.ts

@@ -0,0 +1,2 @@
+/** @deprecated Use @c15t/integrations/segment. Compatibility ends in v4. */
+export * from '@c15t/integrations/segment';

package/dist-types/snapchat-pixel.d.ts

@@ -0,0 +1,2 @@
+/** @deprecated Use @c15t/integrations/snapchat-pixel. Compatibility ends in v4. */
+export * from '@c15t/integrations/snapchat-pixel';

package/dist-types/tiktok-pixel.d.ts

@@ -0,0 +1,2 @@
+/** @deprecated Use @c15t/integrations/tiktok-pixel. Compatibility ends in v4. */
+export * from '@c15t/integrations/tiktok-pixel';