adapty 0.9.5 → 0.11.0

package/README.md

@@ -293,6 +293,21 @@ When several agents are found, the command asks which to install into; with no o
 `npx skills add adaptyteam/adapty-skills --all --global`, which covers the other agents. Restart an agent to
 load the skills. Exit **1** means an install failed.
 
+### Feedback
+
+A short report to Adapty on how a task with the CLI or an Adapty skill went. Leave out secrets and personal
+data. There is no `--app`: put app, flow or other ids into the message when they matter:
+
+```sh
+adapty feedback --sentiment positive --message "Imported the paywall from Canva in one pass"
+adapty feedback --sentiment negative --message "flows config update rejected a valid button twice" \
+  --feature flow-generator --context "editing the paywall screen"
+```
+
+`--sentiment` is `positive`, `neutral` or `negative`. `--feature` takes letters, digits, `.`, `_` and `-`;
+Adapty records `unknown` when it is left out. The CLI won't send a report containing something that looks like
+an API key, a bearer token, a JWT or an email address; it exits 2 and names the flag to fix.
+
 ### Apple Search Ads
 
 Apple Search Ads commands live under `adapty asa` and talk to the ASA service rather than the Developer

package/bin/dev.js

@@ -1,5 +1,11 @@
 #!/usr/bin/env -S node --loader ts-node/esm --disable-warning=ExperimentalWarning
 
+import net from 'node:net';
+
 import { execute } from '@oclif/core';
 
+// Node abandons every address but the last after 250ms. On a slow link the working address is
+// dropped and the last one, e.g. IPv6 with no route, fails. Never lower a user-set value.
+net.setDefaultAutoSelectFamilyAttemptTimeout(Math.max(net.getDefaultAutoSelectFamilyAttemptTimeout(), 1000));
+
 await execute({ development: true, dir: import.meta.url });

package/bin/run.js

@@ -1,5 +1,11 @@
 #!/usr/bin/env node
 
+import net from 'node:net';
+
 import { execute } from '@oclif/core';
 
+// Node abandons every address but the last after 250ms. On a slow link the working address is
+// dropped and the last one, e.g. IPv6 with no route, fails. Never lower a user-set value.
+net.setDefaultAutoSelectFamilyAttemptTimeout(Math.max(net.getDefaultAutoSelectFamilyAttemptTimeout(), 1000));
+
 await execute({ dir: import.meta.url });

package/dist/cli/commands/feedback.d.ts

@@ -0,0 +1,16 @@
+import { AdaptyCommand } from '../base/adapty/index.js';
+type Result = {
+    status: 'sent';
+};
+export default class Feedback extends AdaptyCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        sentiment: import("@oclif/core/interfaces").OptionFlag<"positive" | "neutral" | "negative", import("@oclif/core/interfaces").CustomOptions>;
+        message: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        feature: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        context: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<Result>;
+}
+export {};

package/dist/cli/commands/feedback.js

@@ -0,0 +1,36 @@
+import { Flags } from '@oclif/core';
+import { validateSendFeedback } from '../../sdk/adapty/feedback/index.js';
+import { sentiments } from '../../sdk/adapty/index.js';
+import { assertValid } from '../../sdk/core/validation.js';
+import { AdaptyCommand } from '../base/adapty/index.js';
+export default class Feedback extends AdaptyCommand {
+    static description = [
+        'Send a short report on how a task with the Adapty CLI or an Adapty skill went.',
+        'Meant for AI agents: say what worked, what failed or confused you. Put app, flow and other ids into the message if they matter.',
+        'Leave out secrets and personal data.',
+    ].join('\n');
+    static examples = [
+        '<%= config.bin %> feedback --sentiment negative --feature flow-generator --message "flows config update rejected a valid button component twice"',
+        '<%= config.bin %> feedback --sentiment positive --message "Imported the paywall from Canva in one pass" --context "Building an onboarding flow from a Canva file"',
+    ];
+    static flags = {
+        sentiment: Flags.option({ description: 'How the task went', options: sentiments, required: true })(),
+        message: Flags.string({ description: 'The report: a few sentences on what happened', required: true }),
+        feature: Flags.string({ description: 'Feature or skill the report comes from; Adapty records "unknown" when omitted' }),
+        context: Flags.string({ description: 'What you were doing at that moment' }),
+    };
+    async run() {
+        const { flags } = await this.parse(Feedback);
+        const input = {
+            context: flags.context,
+            feature: flags.feature,
+            message: flags.message,
+            sentiment: flags.sentiment,
+        };
+        assertValid(validateSendFeedback(input));
+        await this.adapty.feedback.send(input);
+        const result = { status: 'sent' };
+        this.render(result, () => 'Feedback sent. Thank you!');
+        return result;
+    }
+}

package/dist/commands/feedback.d.ts

@@ -0,0 +1 @@
+export { default } from '../cli/commands/feedback.js';

package/dist/commands/feedback.js

@@ -0,0 +1 @@
+export { default } from '../cli/commands/feedback.js';

package/dist/commands/placements/create.js

@@ -18,6 +18,10 @@ export default class PlacementsCreate extends Command {
             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/B test (as `placements get` shows it): {content_type:"ab_test" | "flow_ab_test", ab_test_id, segment_ids, priority}; '
+                + 'crossplacement entries ("cross_ab_test", "flow_cross_ab_test") are read-only, the API keeps the stored ones. '
+                + 'Write the entries of `placements get` back unchanged to keep a running test: a write that removes or replaces '
+                + 'an A/B test entry stops that test with no winner. '
                 + 'A flow must be published first (flows publish) — attaching a draft flow returns 400.',
             exactlyOne: ['paywall-id', 'audiences'],
         }),

package/dist/commands/placements/update.js

@@ -22,6 +22,10 @@ export default class PlacementsUpdate extends Command {
             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/B test (as `placements get` shows it): {content_type:"ab_test" | "flow_ab_test", ab_test_id, segment_ids, priority}; '
+                + 'crossplacement entries ("cross_ab_test", "flow_cross_ab_test") are read-only, the API keeps the stored ones. '
+                + 'Write the entries of `placements get` back unchanged to keep a running test: a write that removes or replaces '
+                + 'an A/B test entry stops that test with no winner. '
                 + 'A flow must be published first (flows publish) — attaching a draft flow returns 400.',
             exactlyOne: ['paywall-id', 'audiences'],
         }),

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

@@ -173,7 +173,30 @@ export type PlacementFlowAudienceEntryDTO = {
     priority: number;
     segment_ids?: string[];
 };
-export type PlacementAudienceEntryDTO = PlacementFlowAudienceEntryDTO | PlacementPaywallAudienceEntryDTO;
+/**
+ * An audience that runs a regular A/B test: the running content of the audience is the test.
+ * `ab_test_title` is read-only: the API ignores it on a write. Writing the same `ab_test_id` back
+ * on the same segments keeps the test running; any other id or segment set starts or stops a test.
+ */
+export type PlacementABTestAudienceEntryDTO = {
+    ab_test_id: string;
+    ab_test_title?: string;
+    content_type: 'ab_test' | 'flow_ab_test';
+    priority: number;
+    segment_ids?: string[];
+};
+/**
+ * An audience that shows a crossplacement A/B test (`ab_test_id` is the parent test). Read-only:
+ * the API ignores these entries on a write and keeps the stored ones.
+ */
+export type PlacementCrossABTestAudienceEntryDTO = {
+    ab_test_id: string;
+    ab_test_title?: string;
+    content_type: 'cross_ab_test' | 'flow_cross_ab_test';
+    priority: number;
+    segment_ids?: string[];
+};
+export type PlacementAudienceEntryDTO = PlacementABTestAudienceEntryDTO | PlacementCrossABTestAudienceEntryDTO | PlacementFlowAudienceEntryDTO | PlacementPaywallAudienceEntryDTO;
 export type PlacementSummaryDTO = {
     developer_id: string;
     id: string;

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

@@ -1,6 +1,8 @@
 /**
  * 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.
+ * explicit `content_type`; there is no implicit paywall. A kind that this CLI does
+ * not know is refused with an "update the CLI" text, never with a text that invites
+ * deleting the entry: a write without a running A/B test entry stops that test.
  */
 export declare function audienceEntryProblem(entry: unknown): null | string;

package/dist/lib/placement-audiences.js

@@ -2,24 +2,31 @@
 // 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).
+/** The A/B test audience kinds: regular and crossplacement, paywall and flow. Each needs `ab_test_id`. */
+const A_B_TEST_KINDS = new Set(['ab_test', 'cross_ab_test', 'flow_ab_test', 'flow_cross_ab_test']);
 /**
  * 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.
+ * explicit `content_type`; there is no implicit paywall. A kind that this CLI does
+ * not know is refused with an "update the CLI" text, never with a text that invites
+ * deleting the entry: a write without a running A/B test entry stops that test.
  */
 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"';
+    const { ab_test_id: abTestId, content_type: contentType, flow_id: flowId, paywall_id: paywallId, } = entry;
+    if (typeof contentType !== 'string') {
+        return 'content_type is required: "paywall", "flow", "ab_test", "flow_ab_test", "cross_ab_test" or "flow_cross_ab_test"';
     }
-    if (contentType === 'paywall' && typeof paywallId !== 'string') {
-        return 'a paywall entry requires paywall_id';
+    if (contentType === 'paywall') {
+        return typeof paywallId === 'string' ? null : 'a paywall entry requires paywall_id';
     }
-    if (contentType === 'flow' && typeof flowId !== 'string') {
-        return 'a flow entry requires flow_id';
+    if (contentType === 'flow') {
+        return typeof flowId === 'string' ? null : 'a flow entry requires flow_id';
     }
-    return null;
+    if (!A_B_TEST_KINDS.has(contentType)) {
+        return 'this CLI does not know this audience kind; update the CLI';
+    }
+    return typeof abTestId === 'string' ? null : `an entry with content_type "${contentType}" requires ab_test_id`;
 }

package/dist/sdk/adapty/feedback/index.d.ts

@@ -0,0 +1,4 @@
+export { feedback } from './resource.js';
+export { sentiments, validateSendFeedback } from './send.js';
+export type { FeedbackApi } from './resource.js';
+export type { SendFeedbackInput, Sentiment } from './send.js';

package/dist/sdk/adapty/feedback/index.js

@@ -0,0 +1,2 @@
+export { feedback } from './resource.js';
+export { sentiments, validateSendFeedback } from './send.js';

package/dist/sdk/adapty/feedback/resource.d.ts

@@ -0,0 +1,6 @@
+import type { SendFeedbackInput } from './send.js';
+import type { Http } from '../../core/http/index.js';
+export declare const feedback: (http: Http) => {
+    send: (input: SendFeedbackInput) => Promise<void>;
+};
+export type FeedbackApi = ReturnType<typeof feedback>;

package/dist/sdk/adapty/feedback/resource.js

@@ -0,0 +1,8 @@
+import { assertValid } from '../../core/validation.js';
+import { toSendRequest, validateSendFeedback } from './send.js';
+export const feedback = (http) => ({
+    send: async (input) => {
+        assertValid(validateSendFeedback(input));
+        await http.post('/feedback', toSendRequest(input));
+    },
+});

package/dist/sdk/adapty/feedback/send.d.ts

@@ -0,0 +1,18 @@
+import type { Issue } from '../../core/errors.js';
+export declare const sentiments: readonly ["positive", "neutral", "negative"];
+export type Sentiment = (typeof sentiments)[number];
+export type SendFeedbackInput = {
+    context?: string | undefined;
+    feature?: string | undefined;
+    message: string;
+    sentiment: Sentiment;
+};
+type SendFeedbackRequest = {
+    context?: string;
+    feature?: string;
+    message: string;
+    sentiment: Sentiment;
+};
+export declare const validateSendFeedback: (input: SendFeedbackInput) => Issue[];
+export declare const toSendRequest: (input: SendFeedbackInput) => SendFeedbackRequest;
+export {};

package/dist/sdk/adapty/feedback/send.js

@@ -0,0 +1,36 @@
+export const sentiments = ['positive', 'neutral', 'negative'];
+// A coarse first pass: the server scrubs reports more thoroughly.
+const secrets = [
+    { kind: 'an API key or token', pattern: /(?<![a-z\d])(?:dev|secret|sk|pk|rk)_(?:live|test)_(?=[a-z\d]{0,64}\d)[a-z\d]{6,}/i },
+    { kind: 'a bearer token', pattern: /\bbearer\s+(?=[\w.~+-]{0,64}\d)[\w.~+-]{16,}/i },
+    { kind: 'a JWT', pattern: /(?<![\w-])eyJ[\w-]{8,}\.[\w-]{8,}\.[\w-]+/ },
+    // Lookbehinds and bounded repeats keep matching linear on a long pasted log.
+    { kind: 'an email address', pattern: /(?<![\w.%+-])(?!git@)[\w.%+-]{1,64}@[a-z][a-z\d-]*(?:\.[a-z\d-]+)*\.[a-z]{2,}\b/i },
+];
+const checkSecrets = (issues, path, value) => {
+    if (value === undefined) {
+        return;
+    }
+    for (const { kind, pattern } of secrets) {
+        if (pattern.test(value)) {
+            issues.push({ message: `looks like it contains ${kind}; remove it and send again`, path });
+        }
+    }
+};
+export const validateSendFeedback = (input) => {
+    const issues = [];
+    checkSecrets(issues, 'message', input.message);
+    checkSecrets(issues, 'context', input.context);
+    checkSecrets(issues, 'feature', input.feature);
+    return issues;
+};
+export const toSendRequest = (input) => {
+    const body = { message: input.message, sentiment: input.sentiment };
+    if (input.feature !== undefined) {
+        body.feature = input.feature;
+    }
+    if (input.context !== undefined) {
+        body.context = input.context;
+    }
+    return body;
+};

package/dist/sdk/adapty/index.d.ts

@@ -1,14 +1,17 @@
 import type { AccessLevelsApi } from './access-levels.js';
 import type { AppsApi } from './apps/index.js';
 import type { AuthApi } from './auth/index.js';
+import type { FeedbackApi } from './feedback/index.js';
 import type { MigrationApi } from './migrations/index.js';
 import type { Clock } from '../core/clock.js';
 import type { RetryAttempt } from '../core/http/index.js';
 export { platforms } from './apps/index.js';
 export { developerErrorParser } from './errors.js';
+export { sentiments } from './feedback/index.js';
 export type { AccessLevel, AccessLevelList, AccessLevelsApi } from './access-levels.js';
 export type { AppDetail, AppsApi, AppSummary, CreateAppInput, UpdateAppInput } from './apps/index.js';
 export type { AuthApi, AuthUser, IssuedToken } from './auth/index.js';
+export type { FeedbackApi, SendFeedbackInput, Sentiment } from './feedback/index.js';
 export type { Action, ActionKind, AvailableFlow, CreateMigrationInput, Envelope, Issue, JsonSchema, Migration, MigrationApi, MigrationList, MigrationState, Progress, ResourceRef, Step, StepStatus, WaitOptions, WizardError, } from './migrations/index.js';
 export type { PageParams, Paginated, Pagination } from './pagination.js';
 /** Exported because the adapter compares the resolved URL with it and warns when they differ. */
@@ -35,6 +38,7 @@ export type Adapty = {
     accessLevels: AccessLevelsApi;
     apps: AppsApi;
     auth: AuthApi;
+    feedback: FeedbackApi;
     migrations: MigrationApi;
 };
 /** The assembly point of the developer API: one transport, resources on top of it. */

package/dist/sdk/adapty/index.js

@@ -4,9 +4,11 @@ import { accessLevels } from './access-levels.js';
 import { apps } from './apps/index.js';
 import { auth } from './auth/index.js';
 import { developerErrorParser } from './errors.js';
+import { feedback } from './feedback/index.js';
 import { migrations } from './migrations/index.js';
 export { platforms } from './apps/index.js';
 export { developerErrorParser } from './errors.js';
+export { sentiments } from './feedback/index.js';
 /** Exported because the adapter compares the resolved URL with it and warns when they differ. */
 export const DEFAULT_ADAPTY_API_URL = 'https://api-admin.adapty.io/api/v1/developer';
 /**
@@ -46,6 +48,7 @@ export const createAdapty = (options = {}) => {
         accessLevels: accessLevels(http),
         apps: apps(http),
         auth: auth(http),
+        feedback: feedback(http),
         // The clock is a dependency here too, not only in the transport: `waitFor` sleeps
         // between polls, and a test must be able to do that instantly.
         migrations: migrations(wizard, options.clock ?? systemClock),