@coframe/sdk 1.1.0

package/dist/pkg/types/react.d.ts

@@ -0,0 +1,303 @@
+import React, { ReactNode } from 'react';
+export { init, onLog, onTreatmentApplied, setConsent, setFeatureFlag, setPageHydrated, setUserToken, trackConversion } from '@coframe/sdk';
+
+interface UniversalSelector {
+    t: string;
+    fingerprint?: string;
+    id?: string;
+    dataTestId?: string;
+    n?: {
+        i: number;
+        t: number;
+    };
+    text?: string;
+    href?: string;
+    ariaLabel?: string;
+    p?: UniversalSelector;
+    descendants?: {
+        depth: number;
+        sel: UniversalSelector;
+    }[];
+    isShadowRoot?: boolean;
+}
+
+type ElementStyles = Record<string, string | undefined>;
+type ElementAttributes = {
+    src?: string;
+    innerHTML?: string;
+    styles?: ElementStyles;
+    onClick?: string;
+    textContent?: string;
+    role?: string;
+    disabled?: boolean;
+};
+type ProjectTag = {
+    js: string | null;
+};
+
+type Modification = ModificationUpdate | ModificationInsertInto | ModificationInsertBy | ModificationDelete | ModificationAddBanner | ModificationAddModal | ModificationExecuteJs;
+type Modifications = {
+    [elementId: string]: Array<Modification>;
+};
+type NewElementAttributes = ElementAttributes & {
+    tagName?: 'h1' | 'p' | 'div' | 'span' | 'button' | 'input' | 'img' | 'div';
+};
+type ModificationUpdate = {
+    type: 'update';
+    attributes: ElementAttributes;
+};
+type ModificationInsertInto = {
+    type: 'insert_into';
+    child_position: 'first' | 'last';
+    new_element: NewElementAttributes;
+};
+type ModificationInsertBy = {
+    type: 'insert_by';
+    position: 'before' | 'after';
+    new_element: NewElementAttributes;
+};
+type ModificationDelete = {
+    type: 'delete';
+};
+type ModificationAddModal = {
+    type: 'add_modal';
+    modal_content: NewElementAttributes;
+    trigger: ModalTrigger;
+};
+type ModificationAddBanner = {
+    type: 'add_banner';
+    banner_content: NewElementAttributes;
+};
+type ModificationExecuteJs = {
+    type: 'execute_js';
+    js: string;
+};
+type ModalTrigger = 'exit' | 'scroll' | 'enter' | 'timer';
+
+interface AnalyticsCallback {
+    callback: string;
+}
+interface TreatmentData {
+    impressionId: string;
+    userToken: string;
+    experimentId: string;
+    variantId: string;
+    inGlobalHoldout: boolean;
+    isBaseline: boolean;
+    holdoutExperimentId?: string;
+}
+interface TreatmentDataV2 {
+    coframe_experiment_id: string;
+    coframe_experiment_slug: string;
+    coframe_variant_id: string;
+    coframe_variant_slug: string;
+    coframe_user_token: string;
+    coframe_impression_id: string;
+    coframe_in_global_holdout: boolean;
+    coframe_in_exp_baseline: boolean;
+}
+declare const GLOBAL_HOLDOUT: "global_holdout";
+declare const EXPERIMENT_HOLDOUT: "experiment_holdout";
+declare const EXPERIMENT: "experiment";
+type ExperimentLevel = typeof GLOBAL_HOLDOUT | typeof EXPERIMENT_HOLDOUT | typeof EXPERIMENT;
+interface ExperimentInfo {
+    variant_id: string;
+    variant_slug: string;
+    experiment_id: string;
+    experiment_slug: string;
+    iteration_id: string;
+    level: ExperimentLevel;
+    final_state: boolean;
+    holdout_experiment_id?: string;
+    holdout_experiment_slug?: string;
+}
+interface Audience {
+    selector: ActivationCondition;
+}
+interface LaneMember {
+    experiment_id: string;
+    iteration_id: string;
+}
+interface LaneStatus {
+    seed: number;
+    members: LaneMember[];
+}
+interface HoldoutInfo {
+    holdout_experiment_id: string;
+    holdout_experiment_slug: string;
+    holdout_variant_id: string;
+    holdout_variant_slug: string;
+    treatment_variant_id: string;
+    treatment_variant_slug: string;
+    seed: number;
+    variant_bins: Allocation;
+}
+interface Metric {
+    id: string;
+    selector: SelectorCondition;
+    js_binder?: string;
+}
+interface ProjectSettings {
+    mutation_observer_active: boolean;
+    track_only_activated_frames?: boolean;
+    blocklist_ips?: string[];
+    bot_cloaking_enabled?: boolean;
+    bot_score_threshold?: number;
+    analytics_callback?: AnalyticsCallback;
+}
+interface Project {
+    org_id: string;
+    holdout_info: HoldoutInfo;
+    audiences: Record<string, Audience>;
+    frames: Frame[];
+    metrics?: Metric[];
+    settings: ProjectSettings;
+    tags?: ProjectTag[];
+    lanes?: Record<string, LaneStatus>;
+}
+interface Frame {
+    activation_condition: ActivationCondition;
+    experiments: Experiment[];
+    elements: CoframeElements;
+}
+interface Experiment {
+    metadata: ExperimentMetadata;
+    variants: Variant[];
+}
+interface ExperimentMetadata {
+    experiment_id: string;
+    slug: string;
+    iteration_id: string;
+    seed: number;
+    holdout_info: HoldoutInfo;
+    allocation: Allocation;
+    activation_condition: {
+        audience_ids?: string[];
+    };
+    lane_ids?: string[];
+}
+interface Allocation {
+    [variantId: string]: number[][];
+}
+interface Variant {
+    id: string;
+    slug: string;
+    experiment_id: string;
+    modifications: Modifications;
+}
+interface CoframeElements {
+    [elementId: string]: SelectorCondition[];
+}
+type SelectorCondition = {
+    and?: SelectorCondition[];
+    or?: SelectorCondition[];
+    name?: string;
+    url?: string;
+    url_starts_with?: string;
+    navigate_to_url_starts_with?: string;
+    css?: string;
+    universal?: UniversalSelector;
+    js?: string;
+};
+type Operator = 'equals' | 'contains' | 'not_contains';
+type SegmentCondition = {
+    operator: Operator;
+    operand: string;
+    key?: string;
+};
+type ActivationConditionAllocation = {
+    seed: number;
+    allocation_bins: number[][];
+    allocation_scale: number;
+};
+type ActivationCondition = {
+    and?: ActivationCondition[];
+    or?: ActivationCondition[];
+    device?: string[];
+    platform?: string[];
+    language?: string[];
+    country?: string[];
+    region?: string[];
+    city?: string[];
+    search?: SegmentCondition[];
+    user_context?: SegmentCondition[];
+    first_time_vs_returning?: string[];
+    url?: string;
+    base_url_matches?: string;
+    url_regex?: string;
+    contains?: string;
+    time?: {
+        before?: Date;
+        after?: Date;
+    };
+    allocation?: ActivationConditionAllocation;
+    js_function?: string;
+};
+type CoframeConfig = {
+    projectId: string;
+    trackingOnly?: boolean;
+    enableAntiFlickering?: boolean;
+    waitForHydration?: boolean;
+    waitForCookiesEnabled?: boolean;
+    waitForFeatureFlag?: boolean;
+    waitForUserToken?: boolean;
+    batchSize?: number;
+    startTime?: number;
+    timeoutMs?: number;
+    timeoutBehavior?: 'exclude';
+    currentUrl?: string;
+    userContext?: Record<string, unknown>;
+    nonce?: string;
+};
+type BotReason = 'none' | 'cf_bot_score' | 'cf_verified_bot' | 'force_bot_param';
+type PersonalizationHeaders = {
+    'x-device-type': string;
+    'x-is-mobile-viewer': string;
+    'x-viewer-city': string;
+    'x-viewer-country': string;
+    'x-viewer-region': string;
+    'x-is-bot': string;
+    'x-is-blocklist-ip': string;
+    'x-cf-bot-score': string;
+    'x-cf-verified-bot-category': string;
+    'x-bot-reason': BotReason;
+};
+
+interface ProjectData {
+    project: Project;
+    personalizationHeaders?: Partial<PersonalizationHeaders>;
+}
+type LogPayload = {
+    kind: 'warn' | 'error' | 'exception';
+    org_id: string;
+    project_id: string;
+    event_id: string;
+    variant_id: string;
+    experiment_id: string;
+    session_id: string;
+    url: string;
+    monitoring_type: string;
+    local_time: string;
+    metadata: Record<string, unknown>;
+    variant_ids?: string[];
+};
+
+interface CoframeProviderProps {
+    projectConfig: CoframeConfig;
+    projectData?: ProjectData | null;
+    onTreatmentApplied?: (data: TreatmentData) => void;
+    onTreatmentAppliedBulk?: (data: TreatmentData[]) => void;
+    onTreatmentAppliedBulkV2?: (data: TreatmentDataV2[], rawIds: ExperimentInfo[]) => void;
+    onLog?: (payload: LogPayload) => void;
+    children: ReactNode;
+}
+interface CoframeContextValue {
+    treatments: TreatmentData[] | null;
+}
+declare function CoframeProvider({ projectConfig, projectData, onTreatmentApplied: onTreatmentAppliedProp, onTreatmentAppliedBulk: onTreatmentAppliedBulkProp, onTreatmentAppliedBulkV2, onLog: onLogProp, children, }: CoframeProviderProps): React.FunctionComponentElement<React.ProviderProps<CoframeContextValue>>;
+declare function useCoframeTreatments(): TreatmentData[] | null;
+declare function useCoframeTreatment(experimentId: string): TreatmentData | undefined;
+declare function useCoframeVariant(experimentId: string): string | undefined;
+
+export { CoframeProvider, useCoframeTreatment, useCoframeTreatments, useCoframeVariant };
+export type { CoframeProviderProps };

package/dist/pkg/types/server.d.ts

@@ -0,0 +1,229 @@
+interface UniversalSelector {
+    t: string;
+    fingerprint?: string;
+    id?: string;
+    dataTestId?: string;
+    n?: {
+        i: number;
+        t: number;
+    };
+    text?: string;
+    href?: string;
+    ariaLabel?: string;
+    p?: UniversalSelector;
+    descendants?: {
+        depth: number;
+        sel: UniversalSelector;
+    }[];
+    isShadowRoot?: boolean;
+}
+
+type ElementStyles = Record<string, string | undefined>;
+type ElementAttributes = {
+    src?: string;
+    innerHTML?: string;
+    styles?: ElementStyles;
+    onClick?: string;
+    textContent?: string;
+    role?: string;
+    disabled?: boolean;
+};
+type ProjectTag = {
+    js: string | null;
+};
+
+type Modification = ModificationUpdate | ModificationInsertInto | ModificationInsertBy | ModificationDelete | ModificationAddBanner | ModificationAddModal | ModificationExecuteJs;
+type Modifications = {
+    [elementId: string]: Array<Modification>;
+};
+type NewElementAttributes = ElementAttributes & {
+    tagName?: 'h1' | 'p' | 'div' | 'span' | 'button' | 'input' | 'img' | 'div';
+};
+type ModificationUpdate = {
+    type: 'update';
+    attributes: ElementAttributes;
+};
+type ModificationInsertInto = {
+    type: 'insert_into';
+    child_position: 'first' | 'last';
+    new_element: NewElementAttributes;
+};
+type ModificationInsertBy = {
+    type: 'insert_by';
+    position: 'before' | 'after';
+    new_element: NewElementAttributes;
+};
+type ModificationDelete = {
+    type: 'delete';
+};
+type ModificationAddModal = {
+    type: 'add_modal';
+    modal_content: NewElementAttributes;
+    trigger: ModalTrigger;
+};
+type ModificationAddBanner = {
+    type: 'add_banner';
+    banner_content: NewElementAttributes;
+};
+type ModificationExecuteJs = {
+    type: 'execute_js';
+    js: string;
+};
+type ModalTrigger = 'exit' | 'scroll' | 'enter' | 'timer';
+
+interface AnalyticsCallback {
+    callback: string;
+}
+interface Audience {
+    selector: ActivationCondition;
+}
+interface LaneMember {
+    experiment_id: string;
+    iteration_id: string;
+}
+interface LaneStatus {
+    seed: number;
+    members: LaneMember[];
+}
+interface HoldoutInfo {
+    holdout_experiment_id: string;
+    holdout_experiment_slug: string;
+    holdout_variant_id: string;
+    holdout_variant_slug: string;
+    treatment_variant_id: string;
+    treatment_variant_slug: string;
+    seed: number;
+    variant_bins: Allocation;
+}
+interface Metric {
+    id: string;
+    selector: SelectorCondition;
+    js_binder?: string;
+}
+interface ProjectSettings {
+    mutation_observer_active: boolean;
+    track_only_activated_frames?: boolean;
+    blocklist_ips?: string[];
+    bot_cloaking_enabled?: boolean;
+    bot_score_threshold?: number;
+    analytics_callback?: AnalyticsCallback;
+}
+interface Project {
+    org_id: string;
+    holdout_info: HoldoutInfo;
+    audiences: Record<string, Audience>;
+    frames: Frame[];
+    metrics?: Metric[];
+    settings: ProjectSettings;
+    tags?: ProjectTag[];
+    lanes?: Record<string, LaneStatus>;
+}
+interface Frame {
+    activation_condition: ActivationCondition;
+    experiments: Experiment[];
+    elements: CoframeElements;
+}
+interface Experiment {
+    metadata: ExperimentMetadata;
+    variants: Variant[];
+}
+interface ExperimentMetadata {
+    experiment_id: string;
+    slug: string;
+    iteration_id: string;
+    seed: number;
+    holdout_info: HoldoutInfo;
+    allocation: Allocation;
+    activation_condition: {
+        audience_ids?: string[];
+    };
+    lane_ids?: string[];
+}
+interface Allocation {
+    [variantId: string]: number[][];
+}
+interface Variant {
+    id: string;
+    slug: string;
+    experiment_id: string;
+    modifications: Modifications;
+}
+interface CoframeElements {
+    [elementId: string]: SelectorCondition[];
+}
+type SelectorCondition = {
+    and?: SelectorCondition[];
+    or?: SelectorCondition[];
+    name?: string;
+    url?: string;
+    url_starts_with?: string;
+    navigate_to_url_starts_with?: string;
+    css?: string;
+    universal?: UniversalSelector;
+    js?: string;
+};
+type Operator = 'equals' | 'contains' | 'not_contains';
+type SegmentCondition = {
+    operator: Operator;
+    operand: string;
+    key?: string;
+};
+type ActivationConditionAllocation = {
+    seed: number;
+    allocation_bins: number[][];
+    allocation_scale: number;
+};
+type ActivationCondition = {
+    and?: ActivationCondition[];
+    or?: ActivationCondition[];
+    device?: string[];
+    platform?: string[];
+    language?: string[];
+    country?: string[];
+    region?: string[];
+    city?: string[];
+    search?: SegmentCondition[];
+    user_context?: SegmentCondition[];
+    first_time_vs_returning?: string[];
+    url?: string;
+    base_url_matches?: string;
+    url_regex?: string;
+    contains?: string;
+    time?: {
+        before?: Date;
+        after?: Date;
+    };
+    allocation?: ActivationConditionAllocation;
+    js_function?: string;
+};
+type BotReason = 'none' | 'cf_bot_score' | 'cf_verified_bot' | 'force_bot_param';
+type PersonalizationHeaders = {
+    'x-device-type': string;
+    'x-is-mobile-viewer': string;
+    'x-viewer-city': string;
+    'x-viewer-country': string;
+    'x-viewer-region': string;
+    'x-is-bot': string;
+    'x-is-blocklist-ip': string;
+    'x-cf-bot-score': string;
+    'x-cf-verified-bot-category': string;
+    'x-bot-reason': BotReason;
+};
+
+interface GetProjectDataOptions {
+    projectId: string;
+    currentUrl: string;
+    userContext?: Record<string, unknown>;
+    headers: Headers | Record<string, string>;
+    includeProject?: boolean;
+    includeCSS?: boolean;
+}
+interface CoframeProjectPayload {
+    project?: Project;
+    personalizationHeaders?: PersonalizationHeaders;
+    antiflickerCSS?: string;
+}
+declare function getProjectData(options: GetProjectDataOptions): Promise<CoframeProjectPayload | null>;
+
+export { getProjectData };
+export type { CoframeProjectPayload, GetProjectDataOptions };

package/package.json

@@ -0,0 +1,130 @@
+{
+  "name": "@coframe/sdk",
+  "version": "1.1.0",
+  "description": "Coframe optimizes your website using generative AI to deliver maximum impact to your audience and allow your site to improve itself as you sleep. Learn more at coframe.com.",
+  "main": "dist/pkg/cf.cjs.js",
+  "module": "dist/pkg/cf.esm.mjs",
+  "types": "dist/pkg/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/pkg/cf.esm.mjs",
+      "require": "./dist/pkg/cf.cjs.js",
+      "types": "./dist/pkg/types/index.d.ts"
+    },
+    "./server": {
+      "import": "./dist/pkg/server.esm.mjs",
+      "require": "./dist/pkg/server.cjs.js",
+      "types": "./dist/pkg/types/server.d.ts"
+    },
+    "./react": {
+      "import": "./dist/pkg/react.esm.mjs",
+      "require": "./dist/pkg/react.cjs.js",
+      "types": "./dist/pkg/types/react.d.ts"
+    }
+  },
+  "files": [
+    "dist/pkg"
+  ],
+  "scripts": {
+    "test:jest": "jest --maxWorkers=2",
+    "test:playwright": "npx playwright test --retries=5 --reporter=list",
+    "test:browserstack:full": "jest --config jest.browserstack.config.js --suite=full",
+    "test:browserstack:small": "jest --config jest.browserstack.config.js --suite=small",
+    "test": "npm run test:jest && npm run test:playwright",
+    "build:stage": "SDK_ENV=stage npm run build",
+    "build:prod": "SDK_ENV=prod npm run build",
+    "build": "NODE_ENV=production rollup -c",
+    "prod": "npm run format:fix && npm run build",
+    "watch": "NODE_ENV=production rollup -c -w",
+    "lint": "biome ci",
+    "lint:fix": "biome check --write .",
+    "lint:fix!": "biome check --write --unsafe .",
+    "deploy:cdn": "./bin/publish.sh",
+    "deploy:cdn:prod": "SDK_ENV=prod ./bin/publish.sh",
+    "dev": "NODE_ENV=production EXTERNAL_PORT=3004 rollup -c -w"
+  },
+  "author": "Coframe",
+  "keywords": [
+    "coframe",
+    "optimization",
+    "AI",
+    "artificial intelligence",
+    "generative AI",
+    "website optimization",
+    "conversion rate",
+    "A/B testing",
+    "personalization",
+    "content optimization",
+    "copy optimization"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Coframe/coframe-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Coframe/coframe-js/issues"
+  },
+  "homepage": "https://coframe.com",
+  "resolutions": {
+    "**/test-exclude": "^8.0.0",
+    "**/minimatch": "^10.0.0",
+    "**/glob": "^11.0.0",
+    "**/anymatch/picomatch": "2.3.2",
+    "**/micromatch/picomatch": "2.3.2",
+    "**/@rollup/plugin-commonjs/picomatch": "4.0.4",
+    "**/jest-config/picomatch": "4.0.4",
+    "**/jest-haste-map/picomatch": "4.0.4",
+    "**/jest-runner/picomatch": "4.0.4",
+    "**/jest-runtime/picomatch": "4.0.4",
+    "**/jest-util/picomatch": "4.0.4",
+    "js-yaml": "3.14.2",
+    "**/brace-expansion": "^5.0.6",
+    "**/@babel/plugin-transform-modules-systemjs": "^7.29.4"
+  },
+  "peerDependencies": {
+    "react": ">=17.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "typescript": "^6.0.2"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.29.0",
+    "@babel/preset-env": "^7.29.2",
+    "@biomejs/biome": "^2.4.8",
+    "@playwright/test": "1.58.2",
+    "@rollup/plugin-babel": "^7.0.0",
+    "@rollup/plugin-commonjs": "^29.0.2",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-replace": "^6.0.3",
+    "@rollup/plugin-terser": "^1.0.0",
+    "@types/jest": "^30.0.0",
+    "@types/react": "^18.0.0",
+    "@types/selenium-webdriver": "^4.35.5",
+    "dotenv": "^17.3.1",
+    "jest": "^30.3.0",
+    "jest-environment-jsdom": "^30.3.0",
+    "jest-environment-jsdom-global": "^4.0.0",
+    "jest-expect-message": "^1.1.3",
+    "jest-localstorage-mock": "^2.4.26",
+    "jest-raw-loader": "^1.0.1",
+    "path-exists-cli": "^2.0.0",
+    "playwright": "1.58.2",
+    "prettier": "^3.8.1",
+    "rollup": "^4.60.0",
+    "rollup-plugin-dts": "^6.4.1",
+    "rollup-plugin-json": "^4.0.0",
+    "rollup-plugin-serve": "^2.0.0",
+    "rollup-plugin-string": "^3.0.0",
+    "rollup-plugin-typescript2": "^0.36.0",
+    "selenium-webdriver": "^4.41.0",
+    "terser": "^5.46.1",
+    "ts-jest": "^29.4.6",
+    "tslib": "^2.8.1",
+    "ua-parser-js": "^2.0.9"
+  }
+}