ad2app-lib 1.49.0 → 1.59.0

package/src/types/dealroom.test.ts

@@ -0,0 +1,231 @@
+/**
+ * Spec 148 (Dealroom), T060: the additive types on top of 175's agency files.
+ *
+ * Two kinds of pin live here. The ADDITIONS (brand type, the `deals`
+ * delegation scope, application origins, the `apply` act, the Dealroom codes
+ * and the dormant money states) and the NON-CHANGES that make them safe: 175's
+ * offer status list and the scope set an organization may ask for stay
+ * byte-identical to 1.50.0.
+ */
+import { test } from "node:test";
+import assert from "node:assert/strict";
+
+import {
+  AGENCY_GRANT_SCOPES,
+  AGENCY_ORGANIZATION_TYPES,
+  CREATOR_ACCESS_GRANT_ORIGINS,
+  DELEGATION_SCOPES,
+  isAgencyGrantScope,
+  isGrantScope,
+} from "./agency";
+import {
+  AGENCY_CAMPAIGN_MEMBER_ORIGINS,
+  AGENCY_OFFER_ACTIONS,
+  AGENCY_OFFER_STATUSES,
+  CampaignOfferActDto,
+} from "./agency-campaigns";
+import { I_OfferStatus } from "./I_Offer";
+import {
+  CAMPAIGN_VISIBILITIES,
+  COMMISSION_AD_SPACE_DECISIONS,
+  COMMISSION_AD_SPACE_STATES,
+  COMMISSION_JOIN_STATES,
+  COMMISSION_LINK_MODES,
+  COMMISSION_LINK_STATES,
+  COMMISSION_MATERIAL_KINDS,
+  COMMISSION_NETWORKS,
+  ReviewCommissionAdSpaceDto,
+  COMMISSION_OFFER_STATES,
+  DEALROOM_CODES,
+  DEALROOM_PROFILE_FIELDS,
+  DEAL_MONEY_STATES,
+  DEAL_PAYOUT_STATES,
+  PAYOUT_BILLING_VARIANTS,
+  PAYOUT_LEDGER_SOURCES,
+  PAYOUT_LEDGER_STATES,
+  isCampaignVisibility,
+} from "./dealroom";
+import * as typesIndex from "./index";
+import { EVENTS } from "../analytics";
+
+// ── Non-changes (the 175 contract stays intact) ─────────────────────────────
+
+test("AGENCY_OFFER_STATUSES is byte-identical to 1.50.0: no offer status is added or remodeled", () => {
+  assert.deepEqual(
+    [...AGENCY_OFFER_STATUSES],
+    [
+      I_OfferStatus.SENT,
+      I_OfferStatus.INFLUENCER_NEGOTIATED,
+      I_OfferStatus.AGENCY_NEGOTIATED,
+      I_OfferStatus.ACCEPTED,
+      I_OfferStatus.CONFIRMED,
+      I_OfferStatus.REJECTED,
+      I_OfferStatus.WITHDRAWN,
+    ],
+  );
+  assert.deepEqual(
+    Object.entries(I_OfferStatus),
+    [
+      ["DRAFT", "draft"],
+      ["SENT", "sent"],
+      ["DELETED", "deleted"],
+      ["ACCEPTED", "accepted"],
+      ["REJECTED", "rejected"],
+      ["INFLUENCER_NEGOTIATED", "influencerNegotiated"],
+      ["AGENCY_NEGOTIATED", "agencyNegotiated"],
+      ["CONFIRMED", "confirmed"],
+      ["ALTERNATIVE_SUGGESTED", "alternativeSuggested"],
+      ["WITHDRAWN", "withdrawn"],
+    ],
+  );
+});
+
+test("AGENCY_GRANT_SCOPES (what an organization may ask for) is unchanged and never carries `deals`", () => {
+  assert.deepEqual([...AGENCY_GRANT_SCOPES], ["analytics", "comments", "posts"]);
+  assert.equal(isAgencyGrantScope("deals"), false);
+});
+
+// ── Additions in 175's files ────────────────────────────────────────────────
+
+test("an organization is an agency or a brand", () => {
+  assert.deepEqual([...AGENCY_ORGANIZATION_TYPES], ["agency", "brand"]);
+});
+
+test("a grant may originate from a Dealroom application", () => {
+  assert.deepEqual([...CREATOR_ACCESS_GRANT_ORIGINS], ["invite_link", "agency_request", "dealroom_application"]);
+});
+
+test("delegation is one creator-only scope, `deals`, kept out of the organization's ask", () => {
+  assert.deepEqual([...DELEGATION_SCOPES], ["deals"]);
+  for (const scope of [...AGENCY_GRANT_SCOPES, ...DELEGATION_SCOPES]) assert.equal(isGrantScope(scope), true);
+  for (const notAScope of ["publish", "payouts", "contract", "settings", "", "Deals"]) {
+    assert.equal(isGrantScope(notAScope), false, `must refuse: ${notAScope}`);
+  }
+});
+
+test("a campaign membership comes from an invitation or an application", () => {
+  assert.deepEqual([...AGENCY_CAMPAIGN_MEMBER_ORIGINS], ["invitation", "application"]);
+});
+
+test("`apply` is an offer act, appended after 175's four", () => {
+  assert.deepEqual([...AGENCY_OFFER_ACTIONS], ["accept", "counter", "confirm", "reject", "apply"]);
+  assert.equal(new CampaignOfferActDto({ action: "apply" }).action, "apply");
+});
+
+// ── dealroom.ts ─────────────────────────────────────────────────────────────
+
+test("a campaign is private (every 175 campaign today) or open (listed in the feed)", () => {
+  assert.deepEqual([...CAMPAIGN_VISIBILITIES], ["private", "open"]);
+  assert.equal(isCampaignVisibility("open"), true);
+  assert.equal(isCampaignVisibility("public"), false);
+});
+
+test("the incomplete-profile state names the two fields that can be missing", () => {
+  assert.deepEqual([...DEALROOM_PROFILE_FIELDS], ["country", "niches"]);
+});
+
+test("DEALROOM_CODES are exactly the contract's thirteen, wave 4's four, the commission lane's four and review 148's three", () => {
+  assert.deepEqual(Object.values(DEALROOM_CODES).sort(), [
+    "commission-ad-space-decision-closed",
+    "commission-ad-space-pending",
+    "commission-ad-space-unavailable",
+    "commission-network-unavailable",
+    "dealroom-brand-door-closed",
+    "dealroom-brand-no-roster",
+    "dealroom-config-missing",
+    "dealroom-contract-exists",
+    "dealroom-contract-unsigned",
+    "dealroom-deal-below-minimum",
+    "dealroom-delegate-consent-forbidden",
+    "dealroom-delegate-forbidden",
+    "dealroom-delegate-own-deal",
+    "dealroom-deposit-required",
+    "dealroom-guarantee-unavailable",
+    "dealroom-listing-frozen",
+    "dealroom-logo-required",
+    "dealroom-money-disabled",
+    "dealroom-money-wrong-step",
+    "dealroom-near-match-not-appliable",
+    "dealroom-not-funded",
+    "dealroom-offer-filled",
+    "dealroom-profile-incomplete",
+    "dealroom-template-pending",
+  ]);
+});
+
+test("the deal money states mirror data-model's state machine exactly; payout is its own column", () => {
+  assert.deepEqual(
+    [...DEAL_MONEY_STATES],
+    [
+      "awaiting_material",
+      "material_submitted",
+      "deposit_paid",
+      "funded",
+      "approved",
+      "published",
+      "closed_unviewed",
+      "refund_pending",
+      "refunded",
+      "guarantee_claimed",
+    ],
+  );
+  assert.deepEqual([...DEAL_PAYOUT_STATES], ["none", "initiated", "paid"]);
+});
+
+test("payout profiles and the ledger carry the data-model's values", () => {
+  assert.deepEqual([...PAYOUT_BILLING_VARIANTS], ["faktura_vat", "umowa_o_dzielo", "international"]);
+  assert.deepEqual([...PAYOUT_LEDGER_SOURCES], ["deal", "pot", "commission"]);
+  assert.deepEqual([...PAYOUT_LEDGER_STATES], ["earned", "validated", "paid"]);
+});
+
+test("the commission lane carries the two networks and its own states", () => {
+  assert.deepEqual([...COMMISSION_NETWORKS], ["awin", "admitad"]);
+  assert.deepEqual([...COMMISSION_OFFER_STATES], ["live", "paused", "gone"]);
+  assert.deepEqual([...COMMISSION_LINK_STATES], ["active", "suspended"]);
+  assert.deepEqual([...COMMISSION_LINK_MODES], ["subnetwork", "deeplink"]);
+});
+
+// ── Commission lane, amended 2026-10-07 (Admitad Ad Space, Awin consent) ────
+
+test("an Admitad Ad Space is reviewed, registered, rejected or suspended, never anything else", () => {
+  assert.deepEqual([...COMMISSION_AD_SPACE_STATES], ["pending_review", "registered", "rejected", "suspended"]);
+  assert.deepEqual([...COMMISSION_AD_SPACE_DECISIONS], ["approve", "reject", "suspend"]);
+});
+
+test("a join answers a link, a deep link, or an Ad Space under review", () => {
+  assert.deepEqual([...COMMISSION_JOIN_STATES], ["link", "deeplink", "ad_space_pending"]);
+});
+
+test("advertiser materials have named kinds", () => {
+  assert.deepEqual([...COMMISSION_MATERIAL_KINDS], ["logo", "banner", "landing_preview", "coupon"]);
+});
+
+test("ReviewCommissionAdSpaceDto carries the admin's decision", () => {
+  assert.equal(new ReviewCommissionAdSpaceDto({ decision: "approve" }).decision, "approve");
+  assert.equal(new ReviewCommissionAdSpaceDto().decision, undefined);
+});
+
+test("dealroom.ts is exported from the types index", () => {
+  assert.equal((typesIndex as Record<string, unknown>).DEALROOM_CODES, DEALROOM_CODES);
+});
+
+// ── Analytics: Dealroom-only events ─────────────────────────────────────────
+
+test("Dealroom adds only the events 175 has none for", () => {
+  const dealroom = Object.entries(EVENTS)
+    .filter(([key]) => key.startsWith("DEALROOM_"))
+    .map(([, value]) => value)
+    .sort();
+  assert.deepEqual(dealroom, [
+    "dealroom_applied",
+    "dealroom_broaden_toggled",
+    "dealroom_connect_from_near_match_clicked",
+    "dealroom_deal_money_state_changed",
+    "dealroom_deal_payout_state_changed",
+    "dealroom_delegation_changed",
+    "dealroom_feed_viewed",
+    "dealroom_listing_opened",
+    "dealroom_near_match_promoted",
+    "dealroom_near_match_shown",
+  ]);
+});