adapty 0.8.1 → 0.8.3-beta.0

package/dist/lib/asa-flags.js

@@ -124,6 +124,53 @@ export const idempotencyFlags = {
 export function money(amount, currency) {
     return amount === undefined ? undefined : { amount, currency };
 }
+const INVOICE_FIELDS = {
+    'invoice-advertiser': 'client_name',
+    'invoice-billing-email': 'billing_contact_email',
+    'invoice-contact-email': 'buyer_email',
+    'invoice-contact-name': 'buyer_name',
+    'invoice-order-number': 'order_number',
+};
+const INVOICE_PREFIX = 'Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list)';
+function invoiceFlag(what) {
+    return Flags.string({ description: `${INVOICE_PREFIX}: ${what}` });
+}
+export const invoiceFlags = {
+    'invoice-advertiser': invoiceFlag('advertiser name'),
+    'invoice-billing-email': invoiceFlag('billing contact email'),
+    'invoice-contact-email': invoiceFlag('buyer contact email'),
+    'invoice-contact-name': invoiceFlag('buyer contact name'),
+    'invoice-order-number': invoiceFlag('order number'),
+};
+export function locInvoiceDetails(flags) {
+    const names = Object.keys(INVOICE_FIELDS);
+    const missing = names.filter((name) => flags[name] === undefined);
+    if (missing.length === names.length)
+        return undefined;
+    if (missing.length > 0) {
+        throw new Error(`Invoicing Options need all five flags; missing: ${missing.map((name) => `--${name}`).join(', ')}`);
+    }
+    return Object.fromEntries(names.map((name) => [INVOICE_FIELDS[name], flags[name]]));
+}
+const SERVING_HINTS = {
+    AUTOMATED_KEYWORDS_REQUIRED_AD_GROUP_MISSING: (campaignId) => `Max Conversions campaign needs an automated ad group: adapty asa ad-groups create --campaign ${campaignId} --name "Automated Max Conv" --automated`,
+    MISSING_BO_OR_INVOICING_FIELDS: (campaignId) => `This organization bills by line of credit — add Invoicing Options: adapty asa campaigns update ${campaignId} --invoice-advertiser ... --invoice-order-number ... --invoice-contact-name ... --invoice-contact-email ... --invoice-billing-email ...`,
+};
+export function reportServingState(campaign, warn) {
+    if (campaign?.serving_status !== 'NOT_RUNNING' || !campaign.serving_state_reasons?.length)
+        return;
+    const reasons = campaign.serving_state_reasons;
+    if (reasons.length === 1 && reasons[0] === 'PAUSED_BY_USER')
+        return;
+    for (const reason of reasons) {
+        const hint = SERVING_HINTS[reason];
+        if (hint)
+            warn(hint(campaign.internal_id));
+    }
+    const other = reasons.filter((reason) => !SERVING_HINTS[reason]);
+    if (other.length > 0)
+        warn(`Not serving: ${other.join(', ')}`);
+}
 export function reportBulkOutcome({ applied, errors, isValidationFailure, kind }, log) {
     if (isValidationFailure) {
         log(`Nothing was applied: the batch failed validation before Apple was called.`);

package/dist/lib/asa-schemas.d.ts

@@ -48,6 +48,13 @@ export interface AsaAppDTO {
     last_synced_at: string;
     name: string;
 }
+export interface AsaLocInvoiceDetails {
+    billing_contact_email: null | string;
+    buyer_email: null | string;
+    buyer_name: null | string;
+    client_name: null | string;
+    order_number: null | string;
+}
 export interface AsaCampaignGroupDTO {
     currency: string;
     internal_id: string;
@@ -55,6 +62,7 @@ export interface AsaCampaignGroupDTO {
     org_id: number;
     org_name: string;
     parent_org_id: number;
+    payment_model: null | string;
     time_zone: string;
 }
 export interface AsaCampaignDTO {
@@ -70,8 +78,12 @@ export interface AsaCampaignDTO {
     daily_budget_amount: AsaMoney | null;
     end_time: null | string;
     internal_id: string;
+    loc_invoice_details: AsaLocInvoiceDetails | null;
     name: string;
     org_id: number;
+    payment_model: null | string;
+    serving_state_reasons: null | string[];
+    serving_status: null | string;
     start_time: null | string;
     status: AsaStatus;
     supply_sources: string[];
@@ -81,6 +93,7 @@ export interface AsaAdGroupDTO {
     ad_group_id: number;
     app_id: string;
     automated_keywords_opt_in: boolean | null;
+    automated_keywords_required: boolean | null;
     bidding_strategy: null | string;
     campaign_group_id: string;
     campaign_id: string;
@@ -91,6 +104,8 @@ export interface AsaAdGroupDTO {
     name: string;
     payment_model: null | string;
     pricing_model: null | string;
+    serving_state_reasons: null | string[];
+    serving_status: null | string;
     start_time: null | string;
     status: AsaStatus | null;
     target_cpa: AsaMoney | null;
@@ -261,7 +276,11 @@ export interface AsaCampaignMutationEntity {
     campaign_group_id: string;
     campaign_id: number;
     internal_id: string;
+    loc_invoice_details: AsaLocInvoiceDetails | null;
     name: string;
+    payment_model: null | string;
+    serving_state_reasons: null | string[];
+    serving_status: null | string;
     status: AsaStatus;
 }
 export interface AsaAdGroupMutationDTO {

package/dist/lib/placement-audiences.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Returns a human-readable problem string when `entry` is not a valid placement
+ * audience entry, or `null` when it is well-formed. Every entry must carry an
+ * explicit `content_type` ('paywall' | 'flow'); there is no implicit paywall.
+ */
+export declare function audienceEntryProblem(entry: unknown): null | string;

package/dist/lib/placement-audiences.js

@@ -0,0 +1,25 @@
+// Runtime guard for --audiences entries parsed from user/agent-supplied JSON.
+// The DTO union in api-schemas.ts requires content_type, but a JSON.parse gives
+// back `unknown`, so the type alone cannot enforce it — this does, the same way
+// for humans and agents (no prompting).
+/**
+ * Returns a human-readable problem string when `entry` is not a valid placement
+ * audience entry, or `null` when it is well-formed. Every entry must carry an
+ * explicit `content_type` ('paywall' | 'flow'); there is no implicit paywall.
+ */
+export function audienceEntryProblem(entry) {
+    if (typeof entry !== 'object' || entry === null) {
+        return 'each entry must be a JSON object';
+    }
+    const { content_type: contentType, flow_id: flowId, paywall_id: paywallId } = entry;
+    if (contentType !== 'flow' && contentType !== 'paywall') {
+        return 'content_type is required and must be "paywall" or "flow"';
+    }
+    if (contentType === 'paywall' && typeof paywallId !== 'string') {
+        return 'a paywall entry requires paywall_id';
+    }
+    if (contentType === 'flow' && typeof flowId !== 'string') {
+        return 'a flow entry requires flow_id';
+    }
+    return null;
+}