@happyvertical/smrt-ads 0.30.0

package/AGENTS.md

@@ -0,0 +1,47 @@
+# @happyvertical/smrt-ads
+
+Ad delivery with priority waterfall, weighted A/B testing, and immutable event tracking.
+
+## Models
+
+- **AdFormat**: IAB standard dimensions (width, height, type: banner/native/video)
+- **AdDeliveryTier**: priority levels — Sponsorship (1, FIXED pricing) > Standard (2, CPM) > House (3, fallback)
+- **AdGroup**: campaign with targeting, budget, zone restrictions
+- **AdVariation** (STI): creative variant with weighted selection for A/B. `weight=2` is 2x more likely than `weight=1`. Denormalized `impressions`/`clicks` fields.
+- **AdEvent** (STI, immutable): impression/click/conversion tracking. **Create-only** — no update/delete in API/MCP. `cli: false` (high-volume).
+
+## Cross-Package References (all plain string IDs)
+
+`contractId` → smrt-commerce, `zoneId`/`siteId` → smrt-properties, `assetId` → smrt-assets, `verticalSlug` → smrt-tags
+
+## Tenancy
+
+Optional tenancy via `@TenantScoped({ mode: 'optional' })` is applied to the
+three transactional models — `AdGroup`, `AdVariation`, and `AdEvent` — which
+participate in per-tenant ad serving and event tracking.
+
+`AdFormat` and `AdDeliveryTier` are deliberately **NOT** tenant-scoped: they
+are shared catalog/lookup tables.
+
+- `AdFormat` rows describe IAB standard ad dimensions (e.g. `728x90`
+  Leaderboard, `300x250` Medium Rectangle). The dimensions are an industry
+  standard, not a tenant-specific configuration.
+- `AdDeliveryTier` rows describe the priority waterfall for ad selection
+  (Sponsorship → Standard → House). Tiers are part of the package's
+  ad-serving contract; per-tenant tier definitions would fragment the
+  selection algorithm without a clear use case.
+
+Either model can still be filtered by tenant manually if a deployment ever
+needs tenant-specific overrides, but the default is global. This mirrors the
+documented exception pattern in `packages/secrets/AGENTS.md` (`TenantKey`).
+Each `@smrt(...)` block on these two classes carries an inline comment
+pointing back here.
+
+## Gotchas
+
+- **Priority waterfall**: lower priority number = higher priority in selection
+- **Weight is relative integer**: not percentage — probability calculated from total weight across variations
+- **Denormalized counts need async refresh**: impressions/clicks on AdVariation are eventually consistent
+- **No frequency capping or budget enforcement built-in**: external responsibility
+- **Targeting rules stored as JSON string**: no schema validation
+- **Optional tenancy** on `AdGroup`, `AdVariation`, `AdEvent` only — see Tenancy section above for `AdFormat`/`AdDeliveryTier` rationale

package/CLAUDE.md

@@ -0,0 +1 @@
+@AGENTS.md

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright <2025> <Happy Vertical Corporation>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,112 @@
+# @happyvertical/smrt-ads
+
+Advertising delivery and tracking models for the SMRT framework. Supports priority-based ad group delivery with a tier waterfall, IAB ad formats, weighted A/B variation testing, and immutable event tracking.
+
+## Installation
+
+```bash
+pnpm add @happyvertical/smrt-ads
+```
+
+## Usage
+
+```typescript
+import {
+  AdDeliveryTier, AdDeliveryTierCollection,
+  AdGroup, AdGroupCollection,
+  AdVariation, AdVariationCollection,
+  AdEvent, AdEventCollection,
+  AdEventType, PricingModel, AdGroupStatus
+} from '@happyvertical/smrt-ads';
+
+// Define delivery tiers (lower priority number = served first)
+const tiers = new AdDeliveryTierCollection(db);
+const sponsorship = await tiers.create({
+  name: 'Sponsorship',
+  priority: 1,
+  pricingModel: PricingModel.FIXED,
+});
+
+const standard = await tiers.create({
+  name: 'Standard',
+  priority: 2,
+  pricingModel: PricingModel.CPM,
+});
+
+// Create an ad group with targeting and budget
+const groups = new AdGroupCollection(db);
+const group = await groups.create({
+  name: 'Holiday Campaign',
+  tierId: sponsorship.id,
+  contractId: 'contract-uuid',
+  status: AdGroupStatus.ACTIVE,
+  dailyBudget: 100.00,
+  totalBudget: 3000.00,
+  startDate: new Date('2024-06-01'),
+  endDate: new Date('2024-08-31'),
+});
+group.setTargeting({ device: 'desktop', geo: 'US' });
+group.setZoneIds(['zone-1', 'zone-2']);
+await group.save();
+
+// Add variations with weights for A/B testing
+// weight=2 is selected 2x more often than weight=1
+const variations = new AdVariationCollection(db);
+const varA = await variations.create({
+  groupId: group.id,
+  name: 'Version A - Blue CTA',
+  weight: 2,
+  status: 'active',
+});
+
+// Track an immutable event (create-only, no update/delete)
+const events = new AdEventCollection(db);
+await events.create({
+  variationId: varA.id,
+  zoneId: 'zone-uuid',
+  siteId: 'site-uuid',
+  eventType: AdEventType.IMPRESSION,
+});
+```
+
+### Delivery Tier Waterfall
+
+Ads are selected by tier priority (lower number = higher priority):
+
+1. **Sponsorship** (priority 1) -- guaranteed premium placements, FIXED pricing
+2. **Standard** (priority 2) -- regular programmatic ads, CPM pricing
+3. **House** (priority 3) -- self-promotional fallback ads
+
+Within a tier, variations are selected by relative weight. A variation with `weight: 2` is twice as likely to be chosen as one with `weight: 1`.
+
+## API
+
+### Models
+
+| Export | Description |
+|--------|------------|
+| `AdDeliveryTier` | Priority tier for waterfall delivery (name, priority, pricingModel) |
+| `AdFormat` | IAB standard ad dimensions (width, height, formatType: banner/native/video) |
+| `AdGroup` | Campaign with targeting rules, budget, zone restrictions, and date range |
+| `AdVariation` | Creative variant within a group with weight for A/B distribution. Denormalized `impressions`/`clicks` counts |
+| `AdEvent` | Immutable tracking event (impression/click/conversion). Create-only -- no update/delete. `cli: false` (high-volume) |
+
+### Collections
+
+`AdDeliveryTierCollection`, `AdFormatCollection`, `AdGroupCollection`, `AdVariationCollection`, `AdEventCollection`
+
+### Enums
+
+| Export | Values |
+|--------|--------|
+| `AdEventType` | `impression`, `click`, `conversion` |
+| `AdFormatType` | `banner`, `native`, `video` |
+| `AdGroupStatus` | `draft`, `active`, `paused`, `completed` |
+| `AdVariationStatus` | `draft`, `active`, `paused` |
+| `PricingModel` | `fixed`, `cpm`, `cpc`, `cpa` |
+
+## Dependencies
+
+- `@happyvertical/smrt-core` -- ORM and code generation
+- `@happyvertical/smrt-tenancy` -- multi-tenant scoping (optional on AdGroup, AdVariation, AdEvent)
+- Peer: `@happyvertical/smrt-assets`, `@happyvertical/smrt-commerce`, `@happyvertical/smrt-properties`, `@happyvertical/smrt-tags`