@kasabeh/a3d-sdk 0.1.0

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@kasabeh/a3d-sdk",
+  "version": "0.1.0",
+  "description": "Native 3D advertising SDK for Three.js / React Three Fiber. OpenRTB 2.6 auction, GLB creative rendering, and IIG-aligned viewability.",
+  "type": "module",
+  "license": "MIT",
+  "author": "Kasabeh",
+  "homepage": "https://a3d.io",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kasabeh/a3d.git"
+  },
+  "bugs": {
+    "url": "https://github.com/kasabeh/a3d/issues"
+  },
+  "keywords": [
+    "3d",
+    "advertising",
+    "ads",
+    "three.js",
+    "react-three-fiber",
+    "webgl",
+    "openrtb",
+    "monetization",
+    "ad-tech",
+    "glb"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./a3d/index.d.ts",
+      "import": "./index.mjs",
+      "require": "./index.cjs"
+    }
+  },
+  "main": "./index.cjs",
+  "module": "./index.mjs",
+  "types": "./a3d/index.d.ts",
+  "files": [
+    "index.mjs",
+    "index.cjs",
+    "index.mjs.map",
+    "index.cjs.map",
+    "a3d/",
+    "hooks/",
+    "lib/",
+    "types/"
+  ],
+  "peerDependencies": {
+    "react": ">=18",
+    "react-dom": ">=18",
+    "three": ">=0.160",
+    "@react-three/fiber": ">=8",
+    "@react-three/drei": ">=9"
+  },
+  "peerDependenciesMeta": {
+    "@react-three/drei": {
+      "optional": false
+    },
+    "@react-three/fiber": {
+      "optional": false
+    }
+  }
+}

package/types/openrtb.d.ts

@@ -0,0 +1,156 @@
+export interface BidRequest {
+    id: string;
+    imp: Imp[];
+    site: SiteInfo;
+    device: Device;
+    /** Auction type: 1 = first price (we always declare 1). */
+    at: number;
+    /** Allowed currencies for bids. */
+    cur: string[];
+    /** Max milliseconds for bids to arrive, including network latency. */
+    tmax: number;
+    source?: Source;
+    regs?: Regs;
+    /** 1 = test mode, bids are not billable. */
+    test?: 0 | 1;
+}
+export interface Imp {
+    id: string;
+    bidfloor: number;
+    bidfloorcur: string;
+    /** 1 = creative assets must be served over HTTPS. */
+    secure?: 0 | 1;
+    ext: {
+        threeds: ImpThreeDS;
+    };
+}
+export interface ImpThreeDS {
+    max_width: number;
+    max_height: number;
+    max_depth: number;
+    scene_type: string;
+    surface_type: string;
+    tags: string[];
+    placement_type: 'static' | 'floating' | 'interactive';
+    interaction: string[];
+    anchor: [number, number, number];
+}
+export interface SiteInfo {
+    id?: string;
+    name: string;
+    domain: string;
+    page: string;
+    cat?: string[];
+    publisher?: {
+        id: string;
+    };
+}
+export interface Device {
+    ua: string;
+    w: number;
+    h: number;
+    language: string;
+    /** OpenRTB device type: 1 = mobile/tablet, 2 = personal computer. */
+    devicetype?: number;
+}
+/** Supply-chain transparency (source.schain) — one node: us, complete. */
+export interface Source {
+    /** Transaction ID common to all participants in this bid request. */
+    tid: string;
+    schain?: {
+        complete: 0 | 1;
+        ver: string;
+        nodes: Array<{
+            asi: string;
+            sid: string;
+            hp: 0 | 1;
+        }>;
+    };
+}
+/** Regulatory signals; GPP is the current umbrella consent string. */
+export interface Regs {
+    coppa?: 0 | 1;
+    gdpr?: 0 | 1;
+    gpp?: string;
+    gpp_sid?: number[];
+}
+export interface BidResponse {
+    id: string;
+    /** Absent (with nbr set) when there is no fill. */
+    seatbid?: SeatBid[];
+    bidid?: string;
+    cur?: string;
+    /** No-bid reason code when seatbid is absent. */
+    nbr?: number;
+}
+export interface SeatBid {
+    bid: Bid[];
+    seat: string;
+}
+export interface Bid {
+    id: string;
+    impid: string;
+    price: number;
+    adid: string;
+    /** Campaign ID (mirrors adid in our stack). */
+    cid?: string;
+    crid: string;
+    /** Advertiser domains for brand-safety/blocklist checks. */
+    adomain?: string[];
+    /** Win notice URL (win signal only — never billed). */
+    nurl?: string;
+    /**
+     * Billing notice URL — fired when the creative renders; supports the
+     * ${AUCTION_PRICE}/${AUCTION_ID}/${AUCTION_IMP_ID}/${AUCTION_CURRENCY} macros.
+     */
+    burl?: string;
+    /** Seconds the win may wait for render before the billing token lapses. */
+    exp?: number;
+    adm: string;
+    ext: {
+        threeds: BidThreeDS;
+    };
+}
+export interface BidThreeDS {
+    model_url: string;
+    file_type: 'glb' | 'gltf' | 'spline_url';
+    model_dimensions: {
+        width: number;
+        height: number;
+        depth: number;
+    };
+    click_url: string | null;
+    /** Tokenized server-side click tracker: records the click, then 302s to click_url. */
+    click_through_url: string | null;
+    campaign_name: string;
+    thumbnail_url: string | null;
+    compatible_scenes: string[];
+    tags: string[];
+}
+export interface AdEventPayload {
+    event_type: 'impression' | 'viewable' | 'click' | 'rotate' | 'zoom' | 'hover' | 'engagement';
+    campaign_id: string;
+    placement_id: string;
+    bid_price: number;
+    engagement_time_ms?: number;
+}
+export interface ResolvedAd {
+    placementId: string;
+    modelUrl: string;
+    fileType: 'glb' | 'gltf' | 'spline_url';
+    clickUrl: string | null;
+    /** Tracked redirect through the ad server (preferred over clickUrl). */
+    clickThroughUrl: string | null;
+    /** Billing notice (bid.burl, macros substituted) — fired once on render. */
+    billingUrl: string | null;
+    campaignId: string;
+    creativeId: string;
+    bidPrice: number;
+    campaignName: string;
+    thumbnailUrl: string | null;
+    modelDimensions: {
+        width: number;
+        height: number;
+        depth: number;
+    };
+}