ad2app-lib 1.49.0 → 1.50.0

package/dist/analytics/index.d.ts

@@ -120,6 +120,17 @@ export declare const EVENTS: {
     readonly AGENCY_CAMPAIGN_MILESTONE_CONFIRMED: "agency_campaign_milestone_confirmed";
     readonly AGENCY_THREAD_STARTED: "agency_thread_started";
     readonly AGENCY_THREAD_MESSAGE_SENT: "agency_thread_message_sent";
+    readonly AGENCY_POT_APPLIED: "agency_pot_applied";
+    readonly AGENCY_POT_APPLICATION_DECIDED: "agency_pot_application_decided";
+    readonly AGENCY_POT_REFILLED: "agency_pot_refilled";
+    readonly AGENCY_POT_MOVED: "agency_pot_moved";
+    readonly AGENCY_POT_PUBLISH_TIME_CONFIRMED: "agency_pot_publish_time_confirmed";
+    readonly AGENCY_POT_PUBLISHED: "agency_pot_published";
+    readonly AGENCY_POT_BONUS_HELD: "agency_pot_bonus_held";
+    readonly AGENCY_POT_BONUS_DECIDED: "agency_pot_bonus_decided";
+    readonly AGENCY_POT_REMOVAL_DECIDED: "agency_pot_removal_decided";
+    readonly AGENCY_POT_EXPORTED: "agency_pot_exported";
+    readonly AGENCY_POT_FILE_UPLOADED: "agency_pot_file_uploaded";
 };
 export type EventName = (typeof EVENTS)[keyof typeof EVENTS];
 /** Which email program a send belongs to (spec 120). Wire values — do not rename. */
@@ -628,6 +639,27 @@ export interface EventProperties {
     [EVENTS.AGENCY_THREAD_MESSAGE_SENT]: AgencyEventProperties & {
         thread_id: string;
     };
+    [EVENTS.AGENCY_POT_APPLIED]: AgencyCampaignEventProperties;
+    [EVENTS.AGENCY_POT_APPLICATION_DECIDED]: AgencyCampaignEventProperties & {
+        action: 'accept' | 'decline';
+    };
+    [EVENTS.AGENCY_POT_REFILLED]: AgencyCampaignEventProperties;
+    [EVENTS.AGENCY_POT_MOVED]: AgencyCampaignEventProperties;
+    [EVENTS.AGENCY_POT_PUBLISH_TIME_CONFIRMED]: AgencyCampaignEventProperties;
+    [EVENTS.AGENCY_POT_PUBLISHED]: AgencyCampaignEventProperties;
+    [EVENTS.AGENCY_POT_BONUS_HELD]: AgencyCampaignEventProperties & {
+        reason: 'jump' | 'paid_delivery';
+    };
+    [EVENTS.AGENCY_POT_BONUS_DECIDED]: AgencyCampaignEventProperties & {
+        action: 'approve' | 'cap' | 'message';
+    };
+    [EVENTS.AGENCY_POT_REMOVAL_DECIDED]: AgencyCampaignEventProperties & {
+        decision: 'keep_base' | 'withhold_base';
+    };
+    [EVENTS.AGENCY_POT_EXPORTED]: AgencyCampaignEventProperties & {
+        format: 'csv' | 'xlsx' | 'report';
+    };
+    [EVENTS.AGENCY_POT_FILE_UPLOADED]: AgencyCampaignEventProperties;
 }
 /** Canonical person property keys (set via identify / $set). */
 export declare const PERSON_PROPS: {

package/dist/analytics/index.js

@@ -194,6 +194,18 @@ exports.EVENTS = {
     // Threads (175 US8). Never the message body: a conversation is not analytics.
     AGENCY_THREAD_STARTED: 'agency_thread_started',
     AGENCY_THREAD_MESSAGE_SENT: 'agency_thread_message_sent',
+    // Pot campaigns (175 US9). Never an amount: the pot's economics are the agency's.
+    AGENCY_POT_APPLIED: 'agency_pot_applied',
+    AGENCY_POT_APPLICATION_DECIDED: 'agency_pot_application_decided',
+    AGENCY_POT_REFILLED: 'agency_pot_refilled',
+    AGENCY_POT_MOVED: 'agency_pot_moved',
+    AGENCY_POT_PUBLISH_TIME_CONFIRMED: 'agency_pot_publish_time_confirmed',
+    AGENCY_POT_PUBLISHED: 'agency_pot_published',
+    AGENCY_POT_BONUS_HELD: 'agency_pot_bonus_held',
+    AGENCY_POT_BONUS_DECIDED: 'agency_pot_bonus_decided',
+    AGENCY_POT_REMOVAL_DECIDED: 'agency_pot_removal_decided',
+    AGENCY_POT_EXPORTED: 'agency_pot_exported',
+    AGENCY_POT_FILE_UPLOADED: 'agency_pot_file_uploaded',
 };
 /**
  * Canonical email event property KEYS (spec 120 T001). Emitters and tests

package/dist/types/agency-campaigns.d.ts

@@ -1,6 +1,7 @@
 import { I_MediaStage } from './I_Media';
 import { I_OfferStatus } from './I_Offer';
 import { type I_AgencyGrantScope } from './agency';
+import { PotFields, type I_AgencyPotView, type I_CampaignFile, type I_CreatorPotView, type I_DisclosureCheck } from './agency-pots';
 /**
  * The campaign loop (spec 175 US7) — an organization runs a campaign with the
  * creators on its roster or in the directory.
@@ -37,6 +38,13 @@ export declare const isCampaignPlacement: (platform: string, placement: string)
 /** The creator's own setting. The agency reads it and can never set it. */
 export declare const SETTLEMENT_FORMS: readonly ["invoice", "contract", "barter"];
 export type SettlementForm = (typeof SETTLEMENT_FORMS)[number];
+/**
+ * An offer campaign negotiates one price per creator (US7); a pot campaign pays
+ * from one pot on each creator's own terms (US9). Chosen at creation, fixed once
+ * the first creator is invited (FR-030).
+ */
+export declare const AGENCY_CAMPAIGN_KINDS: readonly ["offer", "pot"];
+export type AgencyCampaignKind = (typeof AGENCY_CAMPAIGN_KINDS)[number];
 export declare const AGENCY_CAMPAIGN_MEMBER_STATES: readonly ["invited", "joined", "declined", "left", "removed"];
 export type AgencyCampaignMemberState = (typeof AGENCY_CAMPAIGN_MEMBER_STATES)[number];
 /** The offer statuses the agency loop writes. `draft`, `deleted` and `alternativeSuggested` are legacy-only. */
@@ -68,7 +76,7 @@ export type AgencyMilestoneKind = (typeof AGENCY_MILESTONE_KINDS)[number];
 /** A milestone may wait on one rule: every ACTIVE offer at a status, or every active creator's latest material at a stage. */
 export declare const AGENCY_MILESTONE_OFFER_RULES: readonly [I_OfferStatus.CONFIRMED];
 export declare const AGENCY_MILESTONE_MEDIA_RULES: readonly [I_MediaStage.UPLOADED, I_MediaStage.ACCEPTED];
-export declare const AGENCY_CAMPAIGN_EVENT_KINDS: readonly ["invited", "joined", "declined", "left", "removed", "offer_sent", "offer_countered", "offer_accepted", "offer_confirmed", "offer_rejected", "offer_withdrawn", "material_uploaded", "material_approved", "material_changes_asked", "material_rejected", "published", "milestone_confirmed"];
+export declare const AGENCY_CAMPAIGN_EVENT_KINDS: readonly ["invited", "joined", "declined", "left", "removed", "offer_sent", "offer_countered", "offer_accepted", "offer_confirmed", "offer_rejected", "offer_withdrawn", "material_uploaded", "material_approved", "material_changes_asked", "material_rejected", "published", "milestone_confirmed", "pot_applied", "pot_application_withdrawn", "pot_accepted", "pot_declined", "pot_released", "pot_refilled", "pot_moved", "pot_deadline_moved", "pot_publish_time_set", "pot_publish_time_confirmed", "pot_publish_refused", "pot_published", "pot_counted", "pot_frozen", "pot_bonus_held", "pot_bonus_approved", "pot_bonus_capped", "pot_bonus_message", "pot_kept", "pot_broken", "pot_removal_decided", "caption_edited", "file_uploaded", "file_removed"];
 export type AgencyCampaignEventKind = (typeof AGENCY_CAMPAIGN_EVENT_KINDS)[number];
 /** Refusal codes the frontend owes its own copy for. */
 export declare const AGENCY_CAMPAIGN_CODES: {
@@ -131,6 +139,10 @@ export interface I_AgencyMaterial {
     uploadedAt: string;
     /** The note sent with a change request or a rejection of THIS version. */
     note: string | null;
+    /** The post's caption, uploaded with the material (US9, FR-032); the creator may edit it until publication. Optional: 1.49 backends omit it. */
+    caption?: string | null;
+    /** `checkDisclosure(caption)`, returned with every read (FR-040); null without a caption. Optional: 1.49 backends omit it. */
+    disclosure?: I_DisclosureCheck | null;
 }
 export interface I_AgencyMilestone {
     id: string;
@@ -148,8 +160,12 @@ export interface I_AgencyMilestone {
 export interface I_AgencyCampaignEvent {
     kind: AgencyCampaignEventKind;
     side: CampaignSide;
+    /** Done by ad2app itself (the daily pot job), not by a person on that side. */
+    byAd2app?: true;
     at: string;
     price?: I_Money;
+    /** A pot act's amount: a refill, a move, a reserved guarantee, an accrued bonus. */
+    amount?: I_Money;
     note?: string;
 }
 export interface I_CampaignCreatorIdentity {
@@ -194,6 +210,8 @@ export interface I_AgencyCampaignPipeline {
 export interface I_AgencyCampaignCard {
     id: string;
     name: string;
+    /** Absent from 1.49 backends: read as 'offer'. */
+    kind?: AgencyCampaignKind;
     isDraft: boolean;
     liveByAt: string | null;
     draftDueAt: string | null;
@@ -205,6 +223,10 @@ export interface I_AgencyCampaignCard {
 export interface I_AgencyCampaign {
     id: string;
     name: string;
+    /** Absent from 1.49 backends: read as 'offer'. */
+    kind?: AgencyCampaignKind;
+    /** Set on a pot campaign; the pot board itself is `GET /agency/campaigns/:id/pot/board`. */
+    pot?: I_AgencyPotView | null;
     isDraft: boolean;
     brief: I_AgencyCampaignBrief;
     members: I_AgencyCampaignMemberRow[];
@@ -225,6 +247,8 @@ export interface I_AgencyCampaignAttention {
     counterOffers: number;
     materialsToReview: number;
     milestonesReady: number;
+    /** US9: applications to answer, held bonuses to decide, and posts taken down after the bonus window. */
+    potDecisions?: number;
     total: number;
 }
 /** `GET /agency/panel` (FR-022). */
@@ -264,11 +288,17 @@ export interface I_CreatorCampaignView {
         id: string;
         name: string;
     };
+    /** `kind` is absent from 1.49 backends: read as 'offer'. */
     campaign: {
         id: string;
         name: string;
         brief: I_AgencyCampaignBrief;
+        kind?: AgencyCampaignKind;
     };
+    /** Set on a pot campaign: the creator's own terms, earnings and the two-valued availability, nothing pot-level (SC-016). */
+    pot?: I_CreatorPotView | null;
+    /** The agency's files for the campaign (FR-039): every one is for its creators; opened through a signed read. */
+    files?: I_CampaignFile[];
     creatorBrief: string | null;
     /** The access request folded into the invitation, while it is open. */
     requestedScopes: I_AgencyGrantScope[];
@@ -299,8 +329,8 @@ export interface I_SignedRead {
     url: string;
     expiresAt: string;
 }
-/** The brief's fields, shared by create and update. All optional on the wire. */
-declare class AgencyCampaignBriefFields {
+/** The brief's fields, shared by create and update. All optional on the wire. The pot's fields ride along (US9). */
+declare class AgencyCampaignBriefFields extends PotFields {
     text?: string;
     deliverables?: I_CampaignDeliverable[];
     draftDueAt?: string | null;
@@ -312,12 +342,16 @@ declare class AgencyCampaignBriefFields {
 }
 export declare class CreateAgencyCampaignDto extends AgencyCampaignBriefFields {
     name: string;
+    /** Absent = an offer campaign (US7). */
+    kind?: AgencyCampaignKind;
     constructor(data?: Partial<CreateAgencyCampaignDto>);
 }
 export declare class UpdateAgencyCampaignDto extends AgencyCampaignBriefFields {
     name?: string;
     /** Setting false publishes the draft; the brief text must then be present (FR-025). */
     isDraft?: boolean;
+    /** Switch offer ↔ pot; refused once the first creator is invited (FR-030). */
+    kind?: AgencyCampaignKind;
     constructor(data?: Partial<UpdateAgencyCampaignDto>);
 }
 export declare class InviteCampaignCreatorDto {
@@ -370,6 +404,8 @@ export declare class PrepareMaterialUploadDto {
 }
 export declare class ConfirmMaterialUploadDto {
     uploadId: string;
+    /** The post's caption, sent with the material on a pot campaign (FR-032). */
+    caption?: string;
     constructor(data?: Partial<ConfirmMaterialUploadDto>);
 }
 export declare class CreateAgencyMilestoneDto {

package/dist/types/agency-campaigns.js

@@ -9,11 +9,12 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpdateSettlementFormDto = exports.CreateAgencyMilestoneDto = exports.ConfirmMaterialUploadDto = exports.PrepareMaterialUploadDto = exports.MATERIAL_CONTENT_TYPE = exports.MATERIAL_IMAGE_TYPES = exports.MATERIAL_MAX_BYTES = exports.JoinCampaignDto = exports.CampaignMaterialActDto = exports.CampaignOfferActDto = exports.SendCampaignOfferDto = exports.InviteCampaignCreatorDto = exports.UpdateAgencyCampaignDto = exports.CreateAgencyCampaignDto = exports.AGENCY_CAMPAIGN_CODES = exports.AGENCY_CAMPAIGN_EVENT_KINDS = exports.AGENCY_MILESTONE_MEDIA_RULES = exports.AGENCY_MILESTONE_OFFER_RULES = exports.AGENCY_MILESTONE_KINDS = exports.AGENCY_CAMPAIGN_STEPS = exports.AGENCY_MATERIAL_ACTIONS = exports.AGENCY_OFFER_ACTIONS = exports.AGENCY_OFFER_STATUSES = exports.AGENCY_CAMPAIGN_MEMBER_STATES = exports.SETTLEMENT_FORMS = exports.isCampaignPlacement = exports.CAMPAIGN_PLATFORMS = exports.CAMPAIGN_PLACEMENTS = void 0;
+exports.UpdateSettlementFormDto = exports.CreateAgencyMilestoneDto = exports.ConfirmMaterialUploadDto = exports.PrepareMaterialUploadDto = exports.MATERIAL_CONTENT_TYPE = exports.MATERIAL_IMAGE_TYPES = exports.MATERIAL_MAX_BYTES = exports.JoinCampaignDto = exports.CampaignMaterialActDto = exports.CampaignOfferActDto = exports.SendCampaignOfferDto = exports.InviteCampaignCreatorDto = exports.UpdateAgencyCampaignDto = exports.CreateAgencyCampaignDto = exports.AGENCY_CAMPAIGN_CODES = exports.AGENCY_CAMPAIGN_EVENT_KINDS = exports.AGENCY_MILESTONE_MEDIA_RULES = exports.AGENCY_MILESTONE_OFFER_RULES = exports.AGENCY_MILESTONE_KINDS = exports.AGENCY_CAMPAIGN_STEPS = exports.AGENCY_MATERIAL_ACTIONS = exports.AGENCY_OFFER_ACTIONS = exports.AGENCY_OFFER_STATUSES = exports.AGENCY_CAMPAIGN_MEMBER_STATES = exports.AGENCY_CAMPAIGN_KINDS = exports.SETTLEMENT_FORMS = exports.isCampaignPlacement = exports.CAMPAIGN_PLATFORMS = exports.CAMPAIGN_PLACEMENTS = void 0;
 const class_validator_1 = require("class-validator");
 const I_Media_1 = require("./I_Media");
 const I_Offer_1 = require("./I_Offer");
 const agency_1 = require("./agency");
+const agency_pots_1 = require("./agency-pots");
 /**
  * The campaign loop (spec 175 US7) — an organization runs a campaign with the
  * creators on its roster or in the directory.
@@ -52,6 +53,12 @@ exports.isCampaignPlacement = isCampaignPlacement;
 /** The creator's own setting. The agency reads it and can never set it. */
 exports.SETTLEMENT_FORMS = ['invoice', 'contract', 'barter'];
 // ── States ───────────────────────────────────────────────────────────────────
+/**
+ * An offer campaign negotiates one price per creator (US7); a pot campaign pays
+ * from one pot on each creator's own terms (US9). Chosen at creation, fixed once
+ * the first creator is invited (FR-030).
+ */
+exports.AGENCY_CAMPAIGN_KINDS = ['offer', 'pot'];
 exports.AGENCY_CAMPAIGN_MEMBER_STATES = ['invited', 'joined', 'declined', 'left', 'removed'];
 /** The offer statuses the agency loop writes. `draft`, `deleted` and `alternativeSuggested` are legacy-only. */
 exports.AGENCY_OFFER_STATUSES = [
@@ -110,6 +117,32 @@ exports.AGENCY_CAMPAIGN_EVENT_KINDS = [
     'material_rejected',
     'published',
     'milestone_confirmed',
+    // US9: the pot. Every money act carries its amount (FR-021, FR-033).
+    'pot_applied',
+    'pot_application_withdrawn',
+    'pot_accepted',
+    'pot_declined',
+    'pot_released',
+    'pot_refilled',
+    'pot_moved',
+    'pot_deadline_moved',
+    'pot_publish_time_set',
+    'pot_publish_time_confirmed',
+    /** Zernio refused the post at scheduling; `note` carries its reason. */
+    'pot_publish_refused',
+    'pot_published',
+    'pot_counted',
+    'pot_frozen',
+    'pot_bonus_held',
+    'pot_bonus_approved',
+    'pot_bonus_capped',
+    'pot_bonus_message',
+    'pot_kept',
+    'pot_broken',
+    'pot_removal_decided',
+    'caption_edited',
+    'file_uploaded',
+    'file_removed',
 ];
 /** Refusal codes the frontend owes its own copy for. */
 exports.AGENCY_CAMPAIGN_CODES = {
@@ -132,9 +165,10 @@ exports.AGENCY_CAMPAIGN_CODES = {
 // linked lib carries its own copy whose metadata the backend's ValidationPipe
 // never reads. `deliverables` is an array of plain objects checked item by
 // item in the service against CAMPAIGN_PLACEMENTS — the pair is the rule.
-/** The brief's fields, shared by create and update. All optional on the wire. */
-class AgencyCampaignBriefFields {
+/** The brief's fields, shared by create and update. All optional on the wire. The pot's fields ride along (US9). */
+class AgencyCampaignBriefFields extends agency_pots_1.PotFields {
     assignBrief(data) {
+        this.assignPot(data);
         this.text = data?.text;
         this.deliverables = data?.deliverables;
         this.draftDueAt = data?.draftDueAt;
@@ -191,6 +225,7 @@ class CreateAgencyCampaignDto extends AgencyCampaignBriefFields {
     constructor(data) {
         super();
         this.name = data?.name ?? '';
+        this.kind = data?.kind;
         this.assignBrief(data);
     }
 }
@@ -201,11 +236,17 @@ __decorate([
     (0, class_validator_1.MaxLength)(128),
     __metadata("design:type", String)
 ], CreateAgencyCampaignDto.prototype, "name", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsIn)(exports.AGENCY_CAMPAIGN_KINDS),
+    __metadata("design:type", String)
+], CreateAgencyCampaignDto.prototype, "kind", void 0);
 class UpdateAgencyCampaignDto extends AgencyCampaignBriefFields {
     constructor(data) {
         super();
         this.name = data?.name;
         this.isDraft = data?.isDraft;
+        this.kind = data?.kind;
         this.assignBrief(data);
     }
 }
@@ -222,6 +263,11 @@ __decorate([
     (0, class_validator_1.IsBoolean)(),
     __metadata("design:type", Boolean)
 ], UpdateAgencyCampaignDto.prototype, "isDraft", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsIn)(exports.AGENCY_CAMPAIGN_KINDS),
+    __metadata("design:type", String)
+], UpdateAgencyCampaignDto.prototype, "kind", void 0);
 class InviteCampaignCreatorDto {
     constructor(data) {
         this.creatorUserId = data?.creatorUserId ?? '';
@@ -361,6 +407,7 @@ __decorate([
 class ConfirmMaterialUploadDto {
     constructor(data) {
         this.uploadId = data?.uploadId ?? '';
+        this.caption = data?.caption;
     }
 }
 exports.ConfirmMaterialUploadDto = ConfirmMaterialUploadDto;
@@ -370,6 +417,12 @@ __decorate([
     (0, class_validator_1.MaxLength)(512),
     __metadata("design:type", String)
 ], ConfirmMaterialUploadDto.prototype, "uploadId", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MaxLength)(2200),
+    __metadata("design:type", String)
+], ConfirmMaterialUploadDto.prototype, "caption", void 0);
 class CreateAgencyMilestoneDto {
     constructor(data) {
         this.kind = data?.kind ?? 'custom';