@qrush/types 2.1.42 → 2.1.44

package/dist/Events.d.ts

@@ -6,7 +6,6 @@ import { LocationTypeArray, LocationTypeSlugArray } from "./Location.js";
 import { Features, Location, EventCategory, EventCategorySlug, TranslationMap, SupportedLanguage } from "./Common.js";
 import { PromotionTeaser } from "./Promotion.js";
 import { EventArtist } from "./Artist.js";
-import { TrackingStatus } from "./TrackingStats.js";
 export { EventCategory, EventCategorySlug, eventCategories, Features, Location, } from "./Common.js";
 export interface IFireEvent {
     id: string;
@@ -33,11 +32,11 @@ export interface IFireEvent {
     demoEvent: boolean;
     draftMode: boolean;
     status: "auto_draft" | "draft" | "published";
+    /**
+     * @deprecated Use placement document in /placements collection instead.
+     * Will be removed in future version.
+     */
     topPickEvent?: boolean | undefined;
-    topPickStatus?: TrackingStatus;
-    topPickStartsAt?: Timestamp;
-    topPickExpiresAt?: Timestamp;
-    topPickAdvertiserId?: string;
     promotedBy?: "LFF" | "DFF" | undefined;
     isPersonalEvent?: boolean | undefined;
     tags: string[] | IFireMetaPossibleTags["tags"];

package/dist/Placements.d.ts

@@ -0,0 +1,47 @@
+import { Timestamp } from './firebase.js';
+export type PlacementType = 'toppick' | 'banner';
+export type PlacementStatus = 'active' | 'paused' | 'expired' | 'disabled';
+interface IFirePlacementBase {
+    id: string;
+    type: PlacementType;
+    status: PlacementStatus;
+    citySlug: string;
+    startsAt: Timestamp;
+    expiresAt: Timestamp;
+    creditsTotal: number;
+    creditsRemaining: number;
+    impressions: number;
+    clicks: number;
+    impressions_web: number;
+    impressions_app: number;
+    clicks_web: number;
+    clicks_app: number;
+    advertiserId: string;
+    createdAt: Timestamp;
+    lastStatUpdate: Timestamp;
+}
+export interface IFirePlacementTopPick extends IFirePlacementBase {
+    type: 'toppick';
+    eventId: string;
+    eventName?: string;
+    eventImageUrl?: string;
+}
+export interface IFirePlacementBanner extends IFirePlacementBase {
+    type: 'banner';
+    imageUrl: string;
+    clickUrl: string;
+    position?: 'top' | 'inline' | 'bottom';
+}
+export type IFirePlacement = IFirePlacementTopPick | IFirePlacementBanner;
+export interface IFirePlacementSnapshot {
+    placementId: string;
+    hour: Timestamp;
+    impressions: number;
+    clicks: number;
+    impressions_web: number;
+    impressions_app: number;
+    clicks_web: number;
+    clicks_app: number;
+    creditsAtSnapshot: number;
+}
+export {};

package/dist/Placements.js

@@ -0,0 +1 @@
+export {};

package/dist/TrackingStats.d.ts

@@ -1,13 +1,10 @@
 import { Timestamp } from './firebase.js';
-export type TrackingEntityType = 'toppick' | 'event' | 'promotion' | 'location';
-export type TrackingStatus = 'active' | 'paused' | 'expired' | 'disabled';
+export type TrackingEntityType = 'event' | 'promotion' | 'location';
 export interface IFireTrackingStats {
     entityType: TrackingEntityType;
     entityId: string;
     impressions: number;
     clicks: number;
-    creditsRemaining?: number;
-    status: TrackingStatus;
     lastSynced: Timestamp;
     impressions_web?: number;
     impressions_app?: number;

package/dist/index.d.ts

@@ -12,3 +12,4 @@ export * from './Artist.js';
 export * from './CSVImport.js';
 export * from './ApiKeys.js';
 export * from './TrackingStats.js';
+export * from './Placements.js';

package/dist/index.js

@@ -12,3 +12,4 @@ export * from './Artist.js';
 export * from './CSVImport.js';
 export * from './ApiKeys.js';
 export * from './TrackingStats.js';
+export * from './Placements.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qrush/types",
-  "version": "2.1.42",
+  "version": "2.1.44",
   "description": "Shared TypeScript types for the QRush ecosystem",
   "type": "module",
   "main": "./dist/index.js",
@@ -112,6 +112,12 @@
       "react-native": "./dist/ApiKeys.js",
       "import": "./dist/ApiKeys.js",
       "require": "./dist/ApiKeys.js"
+    },
+    "./Placements": {
+      "types": "./dist/Placements.d.ts",
+      "react-native": "./dist/Placements.js",
+      "import": "./dist/Placements.js",
+      "require": "./dist/Placements.js"
     }
   }
 }