adapty 0.8.3 → 0.8.4-beta.1

package/dist/commands/flows/update.js

@@ -0,0 +1,28 @@
+import { Args, Command, Flags } from '@oclif/core';
+import { createAuthenticatedClient } from '../../lib/client-from-config.js';
+import { appFlag, isValidUuid } from '../../lib/flags.js';
+import { printResponse } from '../../lib/output.js';
+export default class FlowsUpdate extends Command {
+    static args = {
+        flow_id: Args.string({ description: 'Flow ID (UUID)', required: true }),
+    };
+    static description = 'Rename a flow';
+    static enableJsonFlag = true;
+    static examples = ['<%= config.bin %> flows update --app UUID 550e8400-e29b-41d4-a716-446655440000 --name "Onboarding v2"'];
+    static flags = {
+        ...appFlag,
+        name: Flags.string({ description: 'New flow name', required: true }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(FlowsUpdate);
+        if (!isValidUuid(args.flow_id)) {
+            this.error('Invalid flow ID format.', { exit: 2 });
+        }
+        const body = { name: flags.name };
+        const client = await createAuthenticatedClient(this.config);
+        const result = await client.put(`/apps/${flags.app}/flows/${args.flow_id}/`, body);
+        this.log('Flow updated!');
+        printResponse(result, this.log.bind(this));
+        return result;
+    }
+}

package/dist/commands/placements/create.js

@@ -1,18 +1,24 @@
 import { Command, Flags } from '@oclif/core';
 import { createAuthenticatedClient } from '../../lib/client-from-config.js';
 import { appFlag } from '../../lib/flags.js';
+import { draftFlowError } from '../../lib/flow-help.js';
 import { printResponse } from '../../lib/output.js';
+import { audienceEntryProblem } from '../../lib/placement-audiences.js';
 export default class PlacementsCreate extends Command {
     static description = 'Create a placement with a paywall';
     static enableJsonFlag = true;
     static examples = [
-        '<%= config.bin %> placements create --app UUID --title "Default" --developer-id default --audiences \'[{"segment_ids":[],"paywall_id":"PAYWALL_UUID","priority":0}]\'',
+        '<%= config.bin %> placements create --app UUID --title "Default" --developer-id default --audiences \'[{"content_type":"paywall","segment_ids":[],"paywall_id":"PAYWALL_UUID","priority":0}]\'',
+        '<%= config.bin %> placements create --app UUID --title "Default" --developer-id default --audiences \'[{"content_type":"flow","segment_ids":[],"flow_id":"FLOW_UUID","priority":0}]\'',
         '<%= config.bin %> placements create --app UUID --title "Default" --developer-id default --paywall-id PAYWALL_UUID',
     ];
     static flags = {
         ...appFlag,
         audiences: Flags.string({
-            description: 'JSON array of audience entries: [{segment_ids, paywall_id, priority}]',
+            description: 'JSON array of audience entries. Every entry needs an explicit content_type. ' +
+                'Paywall: {content_type:"paywall", segment_ids, paywall_id, priority}. ' +
+                'Flow: {content_type:"flow", segment_ids, flow_id, priority}. ' +
+                'A flow must be published first (flows publish) — attaching a draft flow returns 400.',
             exactlyOne: ['paywall-id', 'audiences'],
         }),
         'developer-id': Flags.string({ description: 'Developer ID for the placement', required: true }),
@@ -36,15 +42,34 @@ export default class PlacementsCreate extends Command {
             body.paywall_id = flags['paywall-id'];
         }
         else {
+            let parsed;
             try {
-                body.audiences = JSON.parse(flags.audiences);
+                parsed = JSON.parse(flags.audiences);
             }
             catch (error) {
                 this.error(`Invalid --audiences JSON: ${error instanceof Error ? error.message : String(error)}`, { exit: 2 });
             }
+            if (!Array.isArray(parsed)) {
+                this.error('--audiences must be a JSON array of audience entries.', { exit: 2 });
+            }
+            for (const [index, entry] of parsed.entries()) {
+                const problem = audienceEntryProblem(entry);
+                if (problem)
+                    this.error(`--audiences[${index}]: ${problem}`, { exit: 2 });
+            }
+            body.audiences = parsed;
         }
         const client = await createAuthenticatedClient(this.config);
-        const result = await client.post(`/apps/${flags.app}/placements`, body);
+        let result;
+        try {
+            result = await client.post(`/apps/${flags.app}/placements`, body);
+        }
+        catch (error) {
+            const message = draftFlowError(error, flags.app, body.audiences);
+            if (message)
+                this.error(message, { exit: 2 });
+            throw error;
+        }
         this.log('Placement created!');
         printResponse(result, this.log.bind(this));
         return result;

package/dist/commands/placements/update.js

@@ -1,7 +1,9 @@
 import { Args, Command, Flags } from '@oclif/core';
 import { createAuthenticatedClient } from '../../lib/client-from-config.js';
 import { appFlag, isValidUuid } from '../../lib/flags.js';
+import { draftFlowError } from '../../lib/flow-help.js';
 import { printResponse } from '../../lib/output.js';
+import { audienceEntryProblem } from '../../lib/placement-audiences.js';
 export default class PlacementsUpdate extends Command {
     static args = {
         placement_id: Args.string({ description: 'Placement ID (UUID)', required: true }),
@@ -9,13 +11,17 @@ export default class PlacementsUpdate extends Command {
     static description = 'Update a placement';
     static enableJsonFlag = true;
     static examples = [
-        '<%= config.bin %> placements update --app UUID 550e8400-... --title "Default" --developer-id default --audiences \'[{"segment_ids":[],"paywall_id":"PAYWALL_UUID","priority":0}]\'',
+        '<%= config.bin %> placements update --app UUID 550e8400-... --title "Default" --developer-id default --audiences \'[{"content_type":"paywall","segment_ids":[],"paywall_id":"PAYWALL_UUID","priority":0}]\'',
+        '<%= config.bin %> placements update --app UUID 550e8400-... --title "Default" --developer-id default --audiences \'[{"content_type":"flow","segment_ids":[],"flow_id":"FLOW_UUID","priority":0}]\'',
         '<%= config.bin %> placements update --app UUID 550e8400-... --title "Default" --developer-id default --paywall-id PAYWALL_UUID',
     ];
     static flags = {
         ...appFlag,
         audiences: Flags.string({
-            description: 'JSON array of audience entries: [{segment_ids, paywall_id, priority}]',
+            description: 'JSON array of audience entries. Every entry needs an explicit content_type. ' +
+                'Paywall: {content_type:"paywall", segment_ids, paywall_id, priority}. ' +
+                'Flow: {content_type:"flow", segment_ids, flow_id, priority}. ' +
+                'A flow must be published first (flows publish) — attaching a draft flow returns 400.',
             exactlyOne: ['paywall-id', 'audiences'],
         }),
         'developer-id': Flags.string({ description: 'Developer ID for the placement', required: true }),
@@ -45,15 +51,34 @@ export default class PlacementsUpdate extends Command {
             body.paywall_id = flags['paywall-id'];
         }
         else {
+            let parsed;
             try {
-                body.audiences = JSON.parse(flags.audiences);
+                parsed = JSON.parse(flags.audiences);
             }
             catch (error) {
                 this.error(`Invalid --audiences JSON: ${error instanceof Error ? error.message : String(error)}`, { exit: 2 });
             }
+            if (!Array.isArray(parsed)) {
+                this.error('--audiences must be a JSON array of audience entries.', { exit: 2 });
+            }
+            for (const [index, entry] of parsed.entries()) {
+                const problem = audienceEntryProblem(entry);
+                if (problem)
+                    this.error(`--audiences[${index}]: ${problem}`, { exit: 2 });
+            }
+            body.audiences = parsed;
         }
         const client = await createAuthenticatedClient(this.config);
-        const result = await client.put(`/apps/${flags.app}/placements/${args.placement_id}`, body);
+        let result;
+        try {
+            result = await client.put(`/apps/${flags.app}/placements/${args.placement_id}`, body);
+        }
+        catch (error) {
+            const message = draftFlowError(error, flags.app, body.audiences);
+            if (message)
+                this.error(message, { exit: 2 });
+            throw error;
+        }
         this.log('Placement updated!');
         printResponse(result, this.log.bind(this));
         return result;

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

@@ -87,8 +87,14 @@ export interface FlowRemoteConfigDTO {
 }
 export interface FlowConfigDTO {
     config: Record<string, unknown>;
+    /** Human message for a failed publication (raw passthrough from the flow version). */
+    publication_error?: null | string;
+    /** Publication lifecycle of the flow version: transforming|transformed|uploading|uploaded|published|failed. */
+    publication_status?: string;
     remote_configs: FlowRemoteConfigDTO[];
     status: FlowStatus;
+    /** Raw transform failure: a JSON issues payload or a summary string. Parse with `parseFlowPublicationError`. */
+    transform_error?: null | string;
     /** Millisecond timestamp of the last content change; the value `expected_updated_at` is compared against on write. */
     updated_at: number;
 }
@@ -129,20 +135,33 @@ export interface SegmentDTO {
     id: string;
     title: string;
 }
-export interface PlacementAudienceEntryDTO {
+export interface PlacementPaywallAudienceEntryDTO {
+    content_type: 'paywall';
     paywall_id: string;
     priority: number;
     segment_ids?: string[];
 }
+export interface PlacementFlowAudienceEntryDTO {
+    content_type: 'flow';
+    /** The flow must be `published` (not draft) — the backend returns 400 otherwise. */
+    flow_id: string;
+    priority: number;
+    segment_ids?: string[];
+}
+export type PlacementAudienceEntryDTO = PlacementFlowAudienceEntryDTO | PlacementPaywallAudienceEntryDTO;
 export interface PlacementSummaryDTO {
     developer_id: string;
     id: string;
+    /** Placement activation state: true = Live, false = Inactive. */
+    is_active: boolean;
     title: string;
 }
 export interface PlacementDetailDTO {
     audiences?: PlacementAudienceEntryDTO[];
     developer_id: string;
     id: string;
+    /** Placement activation state: true = Live, false = Inactive. */
+    is_active: boolean;
     title: string;
 }
 export interface PlacementWriteRequestDTO {

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

@@ -44,20 +44,6 @@ export declare const adScopeFlags: {
     campaign: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
     'campaign-group': import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
 };
-export declare const metricsScopeFlags: {
-    'ad-group': import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    app: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    campaign: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
-};
-export declare function metricsScopeBody(flags: {
-    'ad-group'?: string[];
-    app?: string[];
-    campaign?: string[];
-}): {
-    campaign_id?: string[] | undefined;
-    app_id?: string[] | undefined;
-    ad_group_id?: string[] | undefined;
-};
 export declare const statusFilter: (options: string[]) => {
     status: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
 };
@@ -89,16 +75,6 @@ export declare function moneyFlag(description: string, opts?: {
 export declare const currencyFlag: {
     currency: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
 };
-export declare const addKeywordActionFlags: {
-    'cpt-bid': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    'cpt-bid-type': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    'match-type': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    negate: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    'no-negate': import("@oclif/core/interfaces").BooleanFlag<boolean>;
-    'pause-original': import("@oclif/core/interfaces").BooleanFlag<boolean>;
-    'skip-enable-duplicates': import("@oclif/core/interfaces").BooleanFlag<boolean>;
-    'target-ad-group': import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
-};
 export declare const idempotencyFlags: {
     'idempotency-key': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
 };

package/dist/lib/asa-flags.js

@@ -1,5 +1,4 @@
 import { Flags } from '@oclif/core';
-import { CPT_BID_TYPES, KEYWORD_MATCH_TYPES, NEGATE_TYPES } from './asa-keyword-action.js';
 import { describeListedError } from './errors.js';
 import { isValidUuid } from './flags.js';
 const DATE_REGEX = /^\d{4}-\d{2}-\d{2}$/;
@@ -64,18 +63,6 @@ export const adScopeFlags = {
     'campaign-group': idFilter('campaign group'),
     ...searchFilter,
 };
-export const metricsScopeFlags = {
-    'ad-group': idFilter('ad group'),
-    app: idFilter('app'),
-    campaign: idFilter('campaign'),
-};
-export function metricsScopeBody(flags) {
-    return {
-        ...(flags['ad-group'] === undefined ? {} : { ad_group_id: flags['ad-group'] }),
-        ...(flags.app === undefined ? {} : { app_id: flags.app }),
-        ...(flags.campaign === undefined ? {} : { campaign_id: flags.campaign }),
-    };
-}
 export const statusFilter = (options) => ({
     status: Flags.string({ description: 'Keep only rows in this state', options }),
 });
@@ -129,47 +116,6 @@ export function moneyFlag(description, opts = {}) {
 export const currencyFlag = {
     currency: Flags.string({ default: 'USD', description: 'Currency code for the amounts in this call' }),
 };
-// Params of the add-as-keyword-to action, shared by `automations create` and `automations update`.
-// The API picks the params variant by shape, so which of these apply depends on the rule's
-// operate_with: --negate/--no-negate/--skip-enable-duplicates are search-term only,
-// --pause-original is targeting-keyword only. See lib/asa-keyword-action.ts.
-export const addKeywordActionFlags = {
-    'cpt-bid': Flags.string({
-        description: 'cpt_bid.value: the bid itself with --cpt-bid-type set_to, or a percent markup on the entity bid with ' +
-            'search_term_current_cpt / keyword_current_bid; not accepted with ad_group_default_bid',
-        parse: parseMoney,
-    }),
-    'cpt-bid-type': Flags.string({
-        description: 'Where the bid of the created keyword comes from; the API has no default',
-        options: CPT_BID_TYPES,
-    }),
-    'match-type': Flags.string({
-        description: 'Match type of the created keyword; the API has no default',
-        options: KEYWORD_MATCH_TYPES,
-    }),
-    negate: Flags.string({
-        description: 'Also add the search term as a negative keyword at this level (search-term rules)',
-        exclusive: ['no-negate'],
-        options: NEGATE_TYPES,
-    }),
-    'no-negate': Flags.boolean({
-        description: 'Leave no negative keyword behind (search-term rules)',
-        exclusive: ['negate'],
-    }),
-    'pause-original': Flags.boolean({
-        allowNo: true,
-        description: 'Pause the source keyword in its own ad group (targeting-keyword rules)',
-    }),
-    'skip-enable-duplicates': Flags.boolean({
-        allowNo: true,
-        description: 'Skip a keyword that already exists in the target ad group instead of enabling it (search-term rules)',
-    }),
-    'target-ad-group': Flags.string({
-        description: 'Ad group the keyword is added to (UUID), repeatable; a rule without one does nothing',
-        multiple: true,
-        parse: parseId,
-    }),
-};
 export const idempotencyFlags = {
     'idempotency-key': Flags.string({
         description: 'Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice',

package/dist/lib/errors.js

@@ -2,8 +2,7 @@ export function describeListedError(error) {
     const code = error.error_code ?? error.apple_error_code ?? error.validation_error_code ?? undefined;
     const reason = error.message ?? error.apple_error_message ?? error.validation_error_message ?? code ?? 'rejected';
     const position = error.input_ref === null || error.input_ref === undefined ? '' : ` (item ${error.input_ref + 1})`;
-    const field = error.field_name ? `${error.field_name}: ` : '';
-    return { code, text: `${field}${reason}${position}` };
+    return { code, text: `${reason}${position}` };
 }
 export class ApiError extends Error {
     statusCode;

package/dist/lib/flow-help.d.ts

@@ -0,0 +1,12 @@
+export declare function builderUrl(flowId: string): string;
+/** The two "• …" footer lines pointing at the Builder UI and the flows agent skill. */
+export declare function flowFixLinks(flowId: string): string;
+/**
+ * When `error` is the backend's draft-flow rejection, returns an enriched message with the
+ * publish command and fix links; otherwise returns null so the caller rethrows unchanged.
+ * `flowId` is taken from the single flow audience, or `<FLOW_ID>` when it is ambiguous.
+ */
+export declare function draftFlowError(error: unknown, app: string, audiences: null | {
+    content_type?: string;
+    flow_id?: string;
+}[]): null | string;

package/dist/lib/flow-help.js

@@ -0,0 +1,27 @@
+// Shared "how to fix a flow" links, used by `flows publish` (config-error message)
+// and by `placements create`/`update` (draft-attach error). One source for both URLs.
+import { ApiError } from './errors.js';
+export function builderUrl(flowId) {
+    return `https://app.adapty.io/flows/${flowId}/builder`;
+}
+/** The two "• …" footer lines pointing at the Builder UI and the flows agent skill. */
+export function flowFixLinks(flowId) {
+    return `  • Builder UI: ${builderUrl(flowId)}\n  • Adapty flows agent skill: https://adapty.io/docs/flow-generator-skill`;
+}
+// The backend message when a placement tries to attach an unpublished flow. There is no
+// distinct error_code (it comes back as generic validation_error), so match on the text.
+const DRAFT_FLOW_MARKER = 'Flow must be published before placing in a placement';
+/**
+ * When `error` is the backend's draft-flow rejection, returns an enriched message with the
+ * publish command and fix links; otherwise returns null so the caller rethrows unchanged.
+ * `flowId` is taken from the single flow audience, or `<FLOW_ID>` when it is ambiguous.
+ */
+export function draftFlowError(error, app, audiences) {
+    if (!(error instanceof ApiError) || !error.message.includes(DRAFT_FLOW_MARKER))
+        return null;
+    const flows = (audiences ?? []).filter((a) => a.content_type === 'flow' && typeof a.flow_id === 'string');
+    const flowId = flows.length === 1 ? flows[0].flow_id : '<FLOW_ID>';
+    return ('Cannot attach a draft flow to a placement — publish it first.\n' +
+        `Publish:  adapty flows publish --app ${app} ${flowId}\n` +
+        flowFixLinks(flowId));
+}

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;
+}