@happyvertical/smrt-ads 0.57.36 → 0.57.37

package/dist/recipes.d.ts

@@ -0,0 +1,192 @@
+/**
+ * Declared recipes for smrt-ads (#4409, #4437): user-facing units of
+ * functionality an app or agent can pick instead of the whole package.
+ * The scanner reads these statics into the `recipes` array of `manifest.json`
+ * and `smrt-knowledge.json`; nothing here runs at that point.
+ *
+ * @packageDocumentation
+ */
+import { SmrtRecipe } from '@happyvertical/smrt-core';
+import { AdDeliveryTier } from './models/AdDeliveryTier.js';
+import { AdFormat } from './models/AdFormat.js';
+import { AdGroup } from './models/AdGroup.js';
+import { AdVariation } from './models/AdVariation.js';
+/**
+ * Ads: run ad campaigns on your site and see which ads get clicked.
+ *
+ * `AdEvent` is left out on purpose: it is the append-only record of every
+ * showing and click the app writes while serving ads (create and list only,
+ * no CLI, high volume). Nobody opens it as a list; the counts a person reads
+ * live on the ad itself (`AdVariation.impressions` / `clicks`).
+ */
+export declare class AdsCampaignsRecipe extends SmrtRecipe {
+    static id: string;
+    static help: string;
+    static label: string;
+    static summary: string;
+    static synonyms: string[];
+    static section: {
+        id: string;
+        label: string;
+        icon: string;
+        description: string;
+    };
+    static models: (typeof AdDeliveryTier | typeof AdFormat | typeof AdGroup | typeof AdVariation)[];
+    static nav: ({
+        label: string;
+        model: typeof AdGroup;
+        icon: string;
+        description: string;
+        noun: string;
+    } | {
+        label: string;
+        model: typeof AdVariation;
+        icon: string;
+        description: string;
+        noun: string;
+    } | {
+        label: string;
+        model: typeof AdFormat;
+        icon: string;
+        description: string;
+        noun: string;
+    } | {
+        label: string;
+        model: typeof AdDeliveryTier;
+        icon: string;
+        description: string;
+        noun: string;
+    })[];
+    static options: {
+        readonly AdGroup: {
+            readonly fields: {
+                readonly name: {
+                    readonly order: 1;
+                };
+                readonly status: {
+                    readonly order: 2;
+                };
+                readonly tierId: {
+                    readonly label: "Priority tier";
+                    readonly order: 3;
+                };
+                readonly startDate: {
+                    readonly label: "Starts on";
+                    readonly order: 4;
+                };
+                readonly endDate: {
+                    readonly label: "Ends on";
+                    readonly order: 5;
+                };
+                readonly dailyBudget: {
+                    readonly label: "Daily budget";
+                    readonly order: 6;
+                };
+                readonly totalBudget: {
+                    readonly label: "Total budget";
+                    readonly order: 7;
+                };
+                readonly tenantId: {
+                    readonly visibility: "hidden";
+                };
+                readonly contractId: {
+                    readonly label: "Sales contract";
+                    readonly visibility: "advanced";
+                };
+                readonly verticalSlug: {
+                    readonly label: "Category";
+                    readonly visibility: "advanced";
+                };
+                readonly targeting: {
+                    readonly visibility: "hidden";
+                };
+                readonly zoneIds: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly AdVariation: {
+            readonly fields: {
+                readonly name: {
+                    readonly order: 1;
+                };
+                readonly groupId: {
+                    readonly label: "Ad campaign";
+                    readonly order: 2;
+                };
+                readonly formatId: {
+                    readonly label: "Ad size";
+                    readonly order: 3;
+                };
+                readonly assetId: {
+                    readonly label: "Picture";
+                    readonly order: 4;
+                };
+                readonly clickUrl: {
+                    readonly label: "Link to";
+                    readonly order: 5;
+                };
+                readonly altText: {
+                    readonly label: "Words for the picture";
+                    readonly order: 6;
+                };
+                readonly weight: {
+                    readonly order: 7;
+                };
+                readonly status: {
+                    readonly order: 8;
+                };
+                readonly tenantId: {
+                    readonly visibility: "hidden";
+                };
+                readonly impressions: {
+                    readonly label: "Times shown";
+                    readonly locked: true;
+                    readonly visibility: "advanced";
+                };
+                readonly clicks: {
+                    readonly locked: true;
+                    readonly visibility: "advanced";
+                };
+            };
+        };
+        readonly AdFormat: {
+            readonly fields: {
+                readonly name: {
+                    readonly order: 1;
+                };
+                readonly width: {
+                    readonly order: 2;
+                };
+                readonly height: {
+                    readonly order: 3;
+                };
+                readonly formatType: {
+                    readonly label: "Kind";
+                    readonly order: 4;
+                };
+                readonly description: {
+                    readonly order: 5;
+                };
+            };
+        };
+        readonly AdDeliveryTier: {
+            readonly fields: {
+                readonly name: {
+                    readonly order: 1;
+                };
+                readonly priority: {
+                    readonly order: 2;
+                };
+                readonly pricingModel: {
+                    readonly label: "How it is charged";
+                    readonly order: 3;
+                };
+                readonly description: {
+                    readonly order: 4;
+                };
+            };
+        };
+    };
+}
+//# sourceMappingURL=recipes.d.ts.map

package/dist/recipes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recipes.d.ts","sourceRoot":"","sources":["../src/recipes.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD;;;;;;;GAOG;AACH,qBAAa,kBAAmB,SAAQ,UAAU;IAChD,MAAM,CAAC,EAAE,SAAmB;IAC5B,MAAM,CAAC,IAAI,SAA2B;IACtC,MAAM,CAAC,KAAK,SAAS;IACrB,MAAM,CAAC,OAAO,SACkF;IAChG,MAAM,CAAC,QAAQ,WAOb;IACF,MAAM,CAAC,OAAO;;;;;MAKZ;IACF,MAAM,CAAC,MAAM,oFAAoD;IACjE,MAAM,CAAC,GAAG;;;;;;;;;;;;;;;;;;;;;;;;SAiCR;IACF,MAAM,CAAC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAqDH;CACZ"}