@dreamsengine/dreams-ad-engine 0.1.6 → 0.2.1

package/package.json

@@ -1,13 +1,23 @@
 {
 	"name": "@dreamsengine/dreams-ad-engine",
-	"version": "0.1.6",
+	"version": "0.2.1",
 	"type": "module",
 	"license": "GPL-3.0",
 	"main": "./dist/dreams-ad-engine.js",
 	"module": "./dist/dreams-ad-engine.js",
+	"types": "./types/main.d.ts",
+	"exports": {
+		".": {
+			"types": "./types/main.d.ts",
+			"import": "./dist/dreams-ad-engine.js",
+			"default": "./dist/dreams-ad-engine.js"
+		},
+		"./dist/*": "./dist/*"
+	},
 	"description": "A component to render Google Ads",
 	"files": [
 		"dist",
+		"types",
 		"CHANGELOG.md"
 	],
 	"scripts": {

package/types/features/config/config.provider.d.ts

@@ -0,0 +1,20 @@
+import type { DreamsAdMapping } from "../dreamsAdEngine/types/interfaces";
+import type { AdConfigInit, LazyLoadConfig, SlotConfig } from "./config.types";
+export declare class DreamsAdConfig {
+    private static instance;
+    static init(config: AdConfigInit): void;
+    static isInitialized(): boolean;
+    static getNetworkId(): string;
+    static getSitePrefix(): string;
+    static getPubId(): string | undefined;
+    static getBidTimeout(): number;
+    static getDefaultLazyLoad(): LazyLoadConfig;
+    static getSlot(slotName: string): SlotConfig | undefined;
+    static getSlotMapping(slotName: string): DreamsAdMapping[];
+    static getSlotSizing(slotName: string): number[][];
+    static getSlotPosition(slotName: string): string;
+    static buildAdUnit(slotName: string): string;
+    static registerSlot(name: string, config: SlotConfig): void;
+    static reset(): void;
+    private static assertInitialized;
+}

package/types/features/config/config.types.d.ts

@@ -0,0 +1,22 @@
+import type { DreamsAdMapping } from "../dreamsAdEngine/types/interfaces";
+export interface LazyLoadConfig {
+    fetchMarginPercent: number;
+    renderMarginPercent: number;
+    mobileScaling: number;
+}
+export interface SlotConfig {
+    mapping: DreamsAdMapping[];
+    sizing: number[][];
+    position?: "top" | "box" | "footer" | "interstitial";
+}
+export interface AdConfigInit {
+    networkId: string;
+    sitePrefix: string;
+    pubId?: string;
+    bidTimeout?: number;
+    defaultLazyLoad?: LazyLoadConfig;
+    slots?: Record<string, SlotConfig>;
+}
+export interface AdConfigData extends Required<Omit<AdConfigInit, "slots">> {
+    slots: Record<string, SlotConfig>;
+}

package/types/features/config/default-mappings.d.ts

@@ -0,0 +1,2 @@
+import type { SlotConfig } from "./config.types";
+export declare const DEFAULT_SLOTS: Record<string, SlotConfig>;

package/types/features/config/index.d.ts

@@ -0,0 +1,3 @@
+export { DreamsAdConfig } from "./config.provider";
+export { DEFAULT_SLOTS } from "./default-mappings";
+export type { AdConfigInit, LazyLoadConfig, SlotConfig, } from "./config.types";

package/types/features/dreamsAdEngine/components/ad.component.d.ts

@@ -0,0 +1,37 @@
+import { LitElement } from "lit";
+import type { TemplateResult } from "lit/html.js";
+import "../types/interfaces";
+import { DreamsAdMapping, DreamsAdTargeting } from "../types/interfaces";
+export declare class DreamsAdComponent extends LitElement {
+    #private;
+    static styles: import("lit").CSSResult;
+    static initialized: boolean;
+    static old_url: string;
+    static initialized_aps: boolean;
+    networkId: string;
+    adUnit: string;
+    divId: string;
+    slot: string;
+    mapping: DreamsAdMapping[];
+    sizing: number[][];
+    targeting: DreamsAdTargeting[];
+    autoTargeting: boolean;
+    private resolvedTargeting;
+    setCentering: boolean;
+    enableLazyLoad: boolean;
+    configLazyLoad: {
+        fetchMarginPercent: number;
+        renderMarginPercent: number;
+        mobileScaling: number;
+    };
+    refresh: boolean;
+    enableTitle: boolean;
+    apstag: boolean;
+    pubId: string;
+    bidTimeout: number;
+    title: string;
+    adLoaded: boolean;
+    connectedCallback(): void;
+    firstUpdated(): Promise<void>;
+    protected render(): TemplateResult;
+}

package/types/features/dreamsAdEngine/index.d.ts

@@ -0,0 +1 @@
+export * from './components/ad.component';

package/types/features/dreamsAdEngine/types/interfaces.d.ts

@@ -0,0 +1,50 @@
+export interface Googletag {
+    cmd: Array<() => void>;
+    pubads: () => PubAdsService;
+    defineSlot: (adUnitPath: string, size: Array<number> | Array<Array<number>>, divId: string) => Slot;
+    display: (divId: string) => void;
+    enableServices: () => void;
+    sizeMapping: () => SizeMappingArray;
+    destroySlots: (slots?: Slot[]) => void;
+}
+export interface DreamsAdMapping {
+    viewport: [number, number];
+    sizing: [number, number][];
+}
+export interface DreamsAdTargeting {
+    key: string;
+    value: string;
+}
+interface SizeMappingArray {
+    addSize(viewportSize: [number, number], slotSize: [number, number][]): SizeMappingArray;
+    build(): SizeMappingArray[];
+}
+interface LazyLoadObject {
+    fetchMarginPercent: number;
+    renderMarginPercent: number;
+    mobileScaling: number;
+}
+interface PubAdsService {
+    disableInitialLoad: () => void;
+    enableSingleRequest: () => void;
+    refresh: (slots?: Slot[]) => void;
+    addService: (service: ServiceType) => Slot;
+    addEventListener: (eventType: string, handler: (event: any) => void) => void;
+    setCentering: (centerAds: boolean) => void;
+    enableLazyLoad: (config: LazyLoadObject) => void;
+}
+interface Slot {
+    setTargeting: (key: string, value: string) => Slot;
+    addService: (service: ServiceType) => Slot;
+    defineSizeMapping(sizeMapping: SizeMappingArray[]): Slot;
+}
+type ServiceType = PubAdsService;
+declare global {
+    interface Window {
+        googletag: Googletag;
+        dreamsSlotsToUpdate: Slot[];
+        dreamsAllSlots: Slot[];
+        apstag: any;
+    }
+}
+export {};

package/types/features/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./dreamsAdEngine/";
+export * from "./targeting/";
+export * from "./config/";

package/types/features/targeting/index.d.ts

@@ -0,0 +1,2 @@
+export { DreamsTargetingService } from "./targeting.service";
+export type { DFPContext, TargetingOptions, TargetingResult, } from "./targeting.types";

package/types/features/targeting/targeting.service.d.ts

@@ -0,0 +1,12 @@
+import type { DreamsAdTargeting } from "../dreamsAdEngine/types/interfaces";
+import type { DFPContext, TargetingOptions, TargetingResult } from "./targeting.types";
+export declare class DreamsTargetingService {
+    private static cache;
+    private static cacheUrl;
+    private static pendingPromise;
+    static getTargeting(options?: TargetingOptions): Promise<TargetingResult>;
+    private static pollForContext;
+    static buildFromContext(ctx: DFPContext, options?: TargetingOptions): DreamsAdTargeting[];
+    static clearCache(): void;
+    static getTargetingSync(): DreamsAdTargeting[] | null;
+}

package/types/features/targeting/targeting.types.d.ts

@@ -0,0 +1,29 @@
+import type { DreamsAdTargeting } from "../dreamsAdEngine/types/interfaces";
+export interface TargetingOptions {
+    contextKey?: string;
+    maxRetries?: number;
+    retryInterval?: number;
+    includeUrl?: boolean;
+    customSegmentFn?: string;
+}
+export interface DFPContext {
+    postId?: string;
+    catId?: string;
+    tagId?: string;
+    typeId?: string;
+    taxId?: string;
+    dataSection?: {
+        catName?: string;
+        author?: string;
+    };
+}
+export interface TargetingResult {
+    targeting: DreamsAdTargeting[];
+    source: "cache" | "context" | "timeout";
+}
+declare global {
+    interface Window {
+        dfp?: Record<string, DFPContext>;
+        _rl_gen_sg?: () => string;
+    }
+}

package/types/main.d.ts

@@ -0,0 +1 @@
+export * from "./features/";

package/dist/index.html

@@ -1,62 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-	<head>
-		<meta charset="UTF-8" />
-		<link rel="icon" type="image/svg+xml" href="/vite.svg" />
-		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
-		<title>Dreams Ad Engine</title>
-		<script
-			async
-			id="gads-js"
-			src="https://securepubads.g.doubleclick.net/tag/js/gpt.js"
-			defer
-		></script>
-		<script
-			async
-			id="apstag-js"
-			src="https://c.amazon-adsystem.com/aax2/apstag.js"
-			defer
-		></script>
-		<script type="module" crossorigin src="./dreams-ad-engine.js"></script>
-	</head>
-	<body>
-		<!-- apstag
-			pubId="1d96f569-faca-48fb-8e78-c679f28ea4a2" -->
-		<dreams-ad-engine
-			networkId="270959339"
-			adUnit="fco-is-t-02"
-			mapping='[{"viewport":[320,0],"sizing":[[300,250],[320,50]]},{"viewport":[760,0],"sizing":[[728,90]]},{"viewport":[970,0],"sizing":[[970,90],[728,90],[728,90]]}]'
-			sizing="[[300,250],[320,50],[728,90],[970,90]]"
-			minHeight="600"
-			apstag
-			pubId="1d96f569-faca-48fb-8e78-c679f28ea4a2"
-			targeting='[{"key":"url","value": "/"},{"key":"catName","value":"Home"}]'
-		>
-		</dreams-ad-engine>
-		<dreams-ad-engine
-			networkId="270959339"
-			adUnit="fco-is-t-03"
-			mapping='[{"viewport":[320,0],"sizing":[[300,250],[320,50]]},{"viewport":[760,0],"sizing":[[728,90]]},{"viewport":[970,0],"sizing":[[970,90],[728,90],[728,90]]}]'
-			sizing="[[300,250],[320,50],[728,90],[970,90]]"
-			apstag
-			pubId="1d96f569-faca-48fb-8e78-c679f28ea4a2"
-		>
-		</dreams-ad-engine>
-		<dreams-ad-engine
-			networkId="270959339"
-			adUnit="fco-is-t-04"
-			mapping='[{"viewport":[320,0],"sizing":[[300,250],[320,50]]},{"viewport":[760,0],"sizing":[[728,90]]},{"viewport":[970,0],"sizing":[[970,90],[728,90],[728,90]]}]'
-			sizing="[[300,250],[320,50],[728,90],[970,90]]"
-		>
-		</dreams-ad-engine>
-		<dreams-ad-engine
-			networkId="270959339"
-			adUnit="fco-is-b-01"
-			mapping='[{"viewport":[320,0],"sizing":[[300,250],[300,600]]}]'
-			sizing="[[300,250],[300,600]]"
-			enableTitle="false"
-			minHeight="600"
-		>
-		</dreams-ad-engine>
-	</body>
-</html>