adapty 0.9.4 → 0.10.0

package/dist/lib/asa-client.js

@@ -49,3 +49,29 @@ export function noteReplay(replayed, log) {
         log('Already applied earlier — showing the stored result.');
     }
 }
+/** The ASA entities behind a segment source, with the Apple ids the portal filters on. */
+export async function fetchAsaSegmentEntities(client, selection) {
+    if (selection.source === 'campaign') {
+        const campaigns = await Promise.all(selection.ids.map(id => client.get(`/campaigns/${id}`)));
+        return campaigns.map(campaign => ({ id: String(campaign.campaign_id), name: campaign.name }));
+    }
+    if (selection.source === 'ad-group') {
+        const adGroups = await Promise.all(selection.ids.map(id => client.get(`/ad-groups/${id}`)));
+        return adGroups.map(adGroup => ({ id: String(adGroup.ad_group_id), name: adGroup.name }));
+    }
+    // No single-keyword read exists; the ad group is small, so one scoped page covers the lookup
+    const page = await client.get('/keywords', {
+        'ad_group_id': selection.scopeAdGroup,
+        'page[size]': '1000',
+    });
+    const byId = new Map(page.data.map(keyword => [keyword.internal_id, keyword]));
+    const missing = selection.ids.filter(id => !byId.has(id));
+    if (missing.length > 0) {
+        throw new Error(`Keyword(s) not found in ad group ${selection.scopeAdGroup}: ${missing.join(', ')}`);
+    }
+    return selection.ids.map((id) => {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- membership checked above
+        const keyword = byId.get(id);
+        return { id: String(keyword.keyword_id), name: keyword.text };
+    });
+}

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

@@ -131,4 +131,35 @@ type BulkOutcome = {
     kind: string;
 };
 export declare function reportBulkOutcome({ applied, errors, isValidationFailure, kind }: BulkOutcome, log: (msg: string) => void): void;
+export type AsaSegmentSource = 'ad-group' | 'campaign' | 'keyword';
+export declare const asaSegmentSourceFlags: {
+    'ad-group': 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>;
+    keyword: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+};
+export type AsaSegmentSourceFlags = {
+    'ad-group'?: string[] | undefined;
+    'campaign'?: string[] | undefined;
+    'keyword'?: string[] | undefined;
+};
+/**
+ * One source kind per segment, as in the Ads Manager modal. Keywords are looked up inside one ad group, so
+ * `--keyword` borrows `--ad-group` as its scope instead of competing with it.
+ */
+export type AsaSegmentSelection = {
+    ids: string[];
+    scopeAdGroup: string | undefined;
+    source: AsaSegmentSource;
+};
+export declare function resolveAsaSegmentSource(flags: AsaSegmentSourceFlags): AsaSegmentSelection;
+export declare const ASA_SEGMENT_FIELD: Record<AsaSegmentSource, string>;
+export type AsaSegmentEntity = {
+    id: string;
+    name: string;
+};
+/** The dashboard's own title and description for an Ads Manager segment, so it recognises the segment as its own. */
+export declare function buildAsaSegmentNaming(source: AsaSegmentSource, entities: AsaSegmentEntity[]): {
+    description: string;
+    title: string;
+};
 export {};

package/dist/lib/asa-flags.js

@@ -247,3 +247,72 @@ export function reportBulkOutcome({ applied, errors, isValidationFailure, kind }
         log(`  ${describeListedError(error).text}`);
     }
 }
+export const asaSegmentSourceFlags = {
+    'ad-group': idFilter('ad group'),
+    'campaign': idFilter('campaign'),
+    'keyword': idFilter('keyword'),
+};
+export function resolveAsaSegmentSource(flags) {
+    const keywords = flags.keyword ?? [];
+    const adGroups = flags['ad-group'] ?? [];
+    const campaigns = flags.campaign ?? [];
+    if (keywords.length > 0) {
+        const [scopeAdGroup] = adGroups;
+        if (campaigns.length > 0 || adGroups.length !== 1 || scopeAdGroup === undefined) {
+            throw new Error('--keyword takes exactly one --ad-group as the lookup scope and no --campaign.');
+        }
+        return { ids: [...new Set(keywords)], scopeAdGroup, source: 'keyword' };
+    }
+    if (campaigns.length > 0 && adGroups.length > 0) {
+        throw new Error('Pass either --campaign or --ad-group, not both: a segment is built from one kind of entity.');
+    }
+    if (campaigns.length > 0) {
+        return { ids: [...new Set(campaigns)], scopeAdGroup: undefined, source: 'campaign' };
+    }
+    if (adGroups.length > 0) {
+        return { ids: [...new Set(adGroups)], scopeAdGroup: undefined, source: 'ad-group' };
+    }
+    throw new Error('Pass at least one --campaign, --ad-group or --keyword.');
+}
+export const ASA_SEGMENT_FIELD = {
+    'ad-group': 'ad_group',
+    'campaign': 'campaign',
+    // The portal calls a keyword attribution "creative"
+    'keyword': 'creative',
+};
+const ASA_TITLE_MAX = 120;
+const ASA_DESCRIPTION_MAX = 240;
+const ASA_PREVIEW_COUNT = 3;
+const ASA_SOURCE_WORDS = {
+    'ad-group': { many: 'ad groups', one: 'ad group', title: 'Ad group' },
+    'campaign': { many: 'campaigns', one: 'campaign', title: 'Campaign' },
+    'keyword': { many: 'keywords', one: 'keyword', title: 'Keyword' },
+};
+function truncate(text, max) {
+    if (text.length <= max) {
+        return text;
+    }
+    return max <= 3 ? text.slice(0, max) : `${text.slice(0, max - 3)}...`;
+}
+function withRest(preview, rest) {
+    return rest > 0 ? `${preview} +${rest}...` : preview;
+}
+/** The dashboard's own title and description for an Ads Manager segment, so it recognises the segment as its own. */
+export function buildAsaSegmentNaming(source, entities) {
+    const words = ASA_SOURCE_WORDS[source];
+    if (entities.length === 1) {
+        const [entity] = entities;
+        return {
+            description: truncate(`Created from Apple Search Ads ${words.one} "${entity.name}".\n\nID: ${entity.id}`, ASA_DESCRIPTION_MAX),
+            title: truncate(`[ASA] ${words.title}: ${entity.name}`, ASA_TITLE_MAX),
+        };
+    }
+    const shown = entities.slice(0, ASA_PREVIEW_COUNT);
+    const rest = entities.length - shown.length;
+    const names = withRest(shown.map(entity => entity.name).join(', '), rest);
+    const ids = withRest(shown.map(entity => entity.id).join(', '), rest);
+    return {
+        description: truncate(`Created from Apple Search Ads ${words.many} (${entities.length}).\n\nPreview: ${names}\n\nIDs: ${ids}`, ASA_DESCRIPTION_MAX),
+        title: truncate(`[ASA] ${entities.length} ${words.many}: ${names}`, ASA_TITLE_MAX),
+    };
+}

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),