adapty 0.5.0 → 0.6.0-beta.1

package/README.md

@@ -4,7 +4,7 @@
 
 # Adapty CLI
 
-[Adapty Developer CLI](https://adapty.io/docs/developer-cli). Manage apps, products, paywalls, placements, and access levels from your terminal.
+[Adapty Developer CLI](https://adapty.io/docs/developer-cli). Manage apps, products, paywalls, placements, flows, and access levels from your terminal.
 
 ## Installation
 
@@ -77,6 +77,20 @@ adapty placements create --app UUID [flags]
 adapty placements update --app UUID PLACEMENT_ID [flags]
 ```
 
+### Flows
+
+```sh
+adapty flows list --app UUID [--page N] [--page-size N]
+adapty flows get --app UUID FLOW_ID
+adapty flows create --app UUID --name "Name"
+adapty flows config get --app UUID FLOW_ID
+adapty flows config update --app UUID FLOW_ID (--config JSON | --config-file PATH|-) [--remote-configs JSON] [--expected-updated-at MS]
+```
+
+A freshly created flow has no config until the first `flows config update`; `flows config get` returns 404
+until then. Pass `--expected-updated-at` (the `updated_at` from a prior `config get`) to fail instead of
+overwriting a concurrent dashboard edit.
+
 ### Access Levels
 
 ```sh

package/dist/commands/asa/connect.js

@@ -17,7 +17,8 @@ export default class AsaConnect extends Command {
         this.log(`If the browser doesn't open, visit: ${authUrl}\n`);
         this.log('The link is valid for one hour. Sign in to the Adapty dashboard in that browser first — the last');
         this.log('step is authorized by the dashboard session, not by this CLI.');
-        await open(authUrl).catch(() => false);
+        if (process.stdin.isTTY === true)
+            await open(authUrl).catch(() => false);
         if (!flags.wait)
             return { auth_url: authUrl };
         const deadline = Date.now() + flags.timeout * 1000;

package/dist/commands/auth/login.js

@@ -29,11 +29,13 @@ export default class AuthLogin extends Command {
         }
         this.log(`\nYour code: ${device.user_code}\n`);
         this.log(`If browser doesn't open, visit: ${device.verification_uri_complete}\n`);
-        try {
-            await open(device.verification_uri_complete);
-        }
-        catch {
-            // browser open failed silently — URL already printed
+        if (process.stdin.isTTY === true) {
+            try {
+                await open(device.verification_uri_complete);
+            }
+            catch {
+                // browser open failed silently — URL already printed
+            }
         }
         this.log('Waiting for authorization...');
         let interval = Math.max((device.interval_seconds || 5) * 1000, 5000);

package/dist/commands/flows/config/get.d.ts

@@ -0,0 +1,14 @@
+import { Command } from '@oclif/core';
+import type { FlowConfigDTO } from '../../../lib/api-schemas.js';
+export default class FlowsConfigGet extends Command {
+    static args: {
+        flow_id: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static enableJsonFlag: boolean;
+    static examples: string[];
+    static flags: {
+        app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<FlowConfigDTO>;
+}

package/dist/commands/flows/config/get.js

@@ -0,0 +1,25 @@
+import { Args, Command } 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 FlowsConfigGet extends Command {
+    static args = {
+        flow_id: Args.string({ description: 'Flow ID (UUID)', required: true }),
+    };
+    static description = 'Read the flow builder config (404 until the config has been written at least once)';
+    static enableJsonFlag = true;
+    static examples = ['<%= config.bin %> flows config get --app UUID 550e8400-e29b-41d4-a716-446655440000'];
+    static flags = {
+        ...appFlag,
+    };
+    async run() {
+        const { args, flags } = await this.parse(FlowsConfigGet);
+        if (!isValidUuid(args.flow_id)) {
+            this.error('Invalid flow ID format.', { exit: 2 });
+        }
+        const client = await createAuthenticatedClient(this.config);
+        const result = await client.get(`/apps/${flags.app}/flows/${args.flow_id}/config`);
+        printResponse(result, this.log.bind(this));
+        return result;
+    }
+}

package/dist/commands/flows/config/update.d.ts

@@ -0,0 +1,21 @@
+import { Command } from '@oclif/core';
+import type { FlowConfigDTO } from '../../../lib/api-schemas.js';
+export default class FlowsConfigUpdate extends Command {
+    static args: {
+        flow_id: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static enableJsonFlag: boolean;
+    static examples: string[];
+    static flags: {
+        config: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'config-file': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'expected-updated-at': import("@oclif/core/interfaces").OptionFlag<number | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'remote-configs': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<FlowConfigDTO>;
+    private parseJson;
+    private readConfig;
+    private readStdin;
+}

package/dist/commands/flows/config/update.js

@@ -0,0 +1,84 @@
+import { Args, Command, Flags } from '@oclif/core';
+import { readFile } from 'node:fs/promises';
+import { createAuthenticatedClient } from '../../../lib/client-from-config.js';
+import { appFlag, isValidUuid } from '../../../lib/flags.js';
+import { printResponse } from '../../../lib/output.js';
+export default class FlowsConfigUpdate extends Command {
+    static args = {
+        flow_id: Args.string({ description: 'Flow ID (UUID)', required: true }),
+    };
+    static description = 'Write the flow builder config (creates the first version, or edits/forks the current one)';
+    static enableJsonFlag = true;
+    static examples = [
+        '<%= config.bin %> flows config update --app UUID FLOW_UUID --config-file config.json',
+        'cat config.json | <%= config.bin %> flows config update --app UUID FLOW_UUID --config-file -',
+        '<%= config.bin %> flows config update --app UUID FLOW_UUID --config \'{"screens":[],"locales":[]}\' --expected-updated-at 1755001800000',
+    ];
+    static flags = {
+        ...appFlag,
+        config: Flags.string({
+            description: 'Builder config as a JSON string',
+            exactlyOne: ['config', 'config-file'],
+        }),
+        'config-file': Flags.string({
+            description: 'JSON file with the builder config, or - to read stdin',
+            exactlyOne: ['config', 'config-file'],
+        }),
+        'expected-updated-at': Flags.integer({
+            description: 'Optimistic lock: the `updated_at` from a prior config read. Omit for last-write-wins.',
+        }),
+        'remote-configs': Flags.string({
+            description: 'JSON array of remote config entries: [{locale, data}]',
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(FlowsConfigUpdate);
+        if (!isValidUuid(args.flow_id)) {
+            this.error('Invalid flow ID format.', { exit: 2 });
+        }
+        const config = await this.readConfig(flags);
+        const body = { config };
+        if (flags['remote-configs'] !== undefined) {
+            body.remote_configs = this.parseJson(flags['remote-configs'], '--remote-configs');
+        }
+        if (flags['expected-updated-at'] !== undefined) {
+            body.expected_updated_at = flags['expected-updated-at'];
+        }
+        const client = await createAuthenticatedClient(this.config);
+        const result = await client.put(`/apps/${flags.app}/flows/${args.flow_id}/config`, body);
+        this.log('Flow config saved!');
+        printResponse(result, this.log.bind(this));
+        return result;
+    }
+    parseJson(raw, label) {
+        try {
+            return JSON.parse(raw);
+        }
+        catch (error) {
+            this.error(`Invalid ${label} JSON: ${error instanceof Error ? error.message : String(error)}`, { exit: 2 });
+        }
+    }
+    async readConfig(flags) {
+        if (flags.config !== undefined) {
+            return this.parseJson(flags.config, '--config');
+        }
+        const path = flags['config-file'];
+        if (path === undefined) {
+            this.error('Provide --config or --config-file.', { exit: 2 });
+        }
+        let raw;
+        try {
+            raw = path === '-' ? await this.readStdin() : await readFile(path, 'utf8');
+        }
+        catch {
+            this.error(`Could not read ${path}.`, { exit: 2 });
+        }
+        return this.parseJson(raw, path);
+    }
+    async readStdin() {
+        const chunks = [];
+        for await (const chunk of process.stdin)
+            chunks.push(chunk);
+        return Buffer.concat(chunks).toString('utf8');
+    }
+}

package/dist/commands/flows/create.d.ts

@@ -0,0 +1,12 @@
+import { Command } from '@oclif/core';
+import type { FlowDTO } from '../../lib/api-schemas.js';
+export default class FlowsCreate extends Command {
+    static description: string;
+    static enableJsonFlag: boolean;
+    static examples: string[];
+    static flags: {
+        name: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<FlowDTO>;
+}

package/dist/commands/flows/create.js

@@ -0,0 +1,22 @@
+import { Command, Flags } from '@oclif/core';
+import { createAuthenticatedClient } from '../../lib/client-from-config.js';
+import { appFlag } from '../../lib/flags.js';
+import { printResponse } from '../../lib/output.js';
+export default class FlowsCreate extends Command {
+    static description = 'Create a flow (row only — write its config with `flows config update`)';
+    static enableJsonFlag = true;
+    static examples = ['<%= config.bin %> flows create --app UUID --name "Onboarding"'];
+    static flags = {
+        ...appFlag,
+        name: Flags.string({ description: 'Flow name', required: true }),
+    };
+    async run() {
+        const { flags } = await this.parse(FlowsCreate);
+        const client = await createAuthenticatedClient(this.config);
+        const body = { name: flags.name };
+        const result = await client.post(`/apps/${flags.app}/flows`, body);
+        this.log('Flow created!');
+        printResponse(result, this.log.bind(this));
+        return result;
+    }
+}

package/dist/commands/flows/get.d.ts

@@ -0,0 +1,14 @@
+import { Command } from '@oclif/core';
+import type { FlowDTO } from '../../lib/api-schemas.js';
+export default class FlowsGet extends Command {
+    static args: {
+        flow_id: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static enableJsonFlag: boolean;
+    static examples: string[];
+    static flags: {
+        app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<FlowDTO>;
+}

package/dist/commands/flows/get.js

@@ -0,0 +1,25 @@
+import { Args, Command } 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 FlowsGet extends Command {
+    static args = {
+        flow_id: Args.string({ description: 'Flow ID (UUID)', required: true }),
+    };
+    static description = 'Get flow details';
+    static enableJsonFlag = true;
+    static examples = ['<%= config.bin %> flows get --app UUID 550e8400-e29b-41d4-a716-446655440000'];
+    static flags = {
+        ...appFlag,
+    };
+    async run() {
+        const { args, flags } = await this.parse(FlowsGet);
+        if (!isValidUuid(args.flow_id)) {
+            this.error('Invalid flow ID format.', { exit: 2 });
+        }
+        const client = await createAuthenticatedClient(this.config);
+        const result = await client.get(`/apps/${flags.app}/flows/${args.flow_id}`);
+        printResponse(result, this.log.bind(this));
+        return result;
+    }
+}

package/dist/commands/flows/list.d.ts

@@ -0,0 +1,14 @@
+import { Command } from '@oclif/core';
+import type { FlowDTO } from '../../lib/api-schemas.js';
+import { type PaginatedResponse } from '../../lib/flags.js';
+export default class FlowsList extends Command {
+    static description: string;
+    static enableJsonFlag: boolean;
+    static examples: string[];
+    static flags: {
+        page: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        'page-size': import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<PaginatedResponse<FlowDTO>>;
+}

package/dist/commands/flows/list.js

@@ -0,0 +1,20 @@
+import { Command } from '@oclif/core';
+import { createAuthenticatedClient } from '../../lib/client-from-config.js';
+import { appFlag, paginationFlags, paginationParams } from '../../lib/flags.js';
+import { printList } from '../../lib/output.js';
+export default class FlowsList extends Command {
+    static description = 'List flows for an app';
+    static enableJsonFlag = true;
+    static examples = ['<%= config.bin %> flows list --app 550e8400-...'];
+    static flags = {
+        ...appFlag,
+        ...paginationFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(FlowsList);
+        const client = await createAuthenticatedClient(this.config);
+        const result = await client.get(`/apps/${flags.app}/flows`, paginationParams(flags));
+        printList(result.data, this.log.bind(this), result.meta.pagination);
+        return result;
+    }
+}

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

@@ -73,6 +73,34 @@ export interface PaywallWriteRequestDTO {
     product_ids?: string[];
     title: string;
 }
+/** Flow lifecycle status. Values come from the server-side `FlowStatus` enum (e.g. draft, dirty, published). */
+export type FlowStatus = string;
+export interface FlowDTO {
+    id: string;
+    name: string;
+    status: FlowStatus;
+    updated_at: string;
+}
+export interface FlowRemoteConfigDTO {
+    data: string;
+    locale: string;
+}
+export interface FlowConfigDTO {
+    config: Record<string, unknown>;
+    remote_configs: FlowRemoteConfigDTO[];
+    status: FlowStatus;
+    /** Millisecond timestamp of the last content change; the value `expected_updated_at` is compared against on write. */
+    updated_at: number;
+}
+export interface FlowWriteRequestDTO {
+    name: string;
+}
+export interface FlowConfigWriteRequestDTO {
+    config: Record<string, unknown>;
+    /** Optimistic lock: the `updated_at` from a prior config read. Omit for last-write-wins. */
+    expected_updated_at?: null | number;
+    remote_configs?: FlowRemoteConfigDTO[];
+}
 export interface SegmentDTO {
     description: null | string;
     id: string;

package/dist/lib/errors.d.ts

@@ -29,9 +29,11 @@ export declare class ApiError extends Error {
     statusCode: number;
     errorCode: string;
     fieldErrors: Record<string, string[]>;
+    code?: string;
     detail?: string;
     retryAfterSeconds?: number;
     constructor(statusCode: number, errorCode: string, fieldErrors: Record<string, string[]>, opts?: ApiErrorOptions);
+    private static humanMessage;
     toHuman(): string;
     toJSON(): ApiErrorBody;
 }

package/dist/lib/errors.js

@@ -8,16 +8,34 @@ export class ApiError extends Error {
     statusCode;
     errorCode;
     fieldErrors;
+    // Read by oclif's prettyPrint to render a `Code: ...` line under the message.
+    code;
     detail;
     retryAfterSeconds;
     constructor(statusCode, errorCode, fieldErrors, opts = {}) {
-        super(opts.detail ?? errorCode);
+        // `message` is what oclif's default error renderer prints. Prefer the server's human text (an ASA
+        // `detail` or the developer API's field errors) over the bare code, which reads as gibberish on its own.
+        super(ApiError.humanMessage(errorCode, fieldErrors, opts.detail));
         this.statusCode = statusCode;
         this.errorCode = errorCode;
         this.fieldErrors = fieldErrors;
         this.name = 'ApiError';
         this.detail = opts.detail;
         this.retryAfterSeconds = opts.retryAfterSeconds;
+        // Surface real server codes as a secondary line; hide synthetic `http_<status>` fallbacks.
+        if (!errorCode.startsWith('http_'))
+            this.code = errorCode;
+    }
+    static humanMessage(errorCode, fieldErrors, detail) {
+        if (detail)
+            return detail;
+        const parts = [];
+        for (const [field, msgs] of Object.entries(fieldErrors)) {
+            for (const msg of msgs) {
+                parts.push(field === 'non_field_errors' ? msg : `${field}: ${msg}`);
+            }
+        }
+        return parts.length > 0 ? parts.join('; ') : errorCode;
     }
     toHuman() {
         const lines = [`Error: ${this.errorCode}`];