@affset/mcp 0.1.0 → 0.2.0

package/dist/types.d.ts

@@ -0,0 +1,210 @@
+/** Shapes of the affset tenant API responses this server consumes. */
+/** A single grouped row from `GET /api/stats`. */
+export interface StatRow {
+    date?: string;
+    campaign_id?: string;
+    campaign_name?: string | null;
+    zone_id?: string;
+    zone_name?: string | null;
+    country?: string | null;
+    conversion_type?: string | null;
+    publisher_email?: string | null;
+    advertiser_email?: string | null;
+    sub1?: string | null;
+    sub2?: string | null;
+    sub3?: string | null;
+    sub4?: string | null;
+    sub5?: string | null;
+    impressions: number;
+    fallbacks: number;
+    unsold: number;
+    clicks: number;
+    conversions: number;
+    spend?: number;
+    payout?: number;
+    media_cost?: number;
+    /** (payout - media_cost) / media_cost; null when the slice carries no cost. */
+    roi?: number | null;
+}
+export interface StatsResponse {
+    stats: StatRow[];
+    period: {
+        from: number;
+        to: number;
+    };
+    /** Tenant display names for sub1..sub5 (e.g. sub1 -> "Zone"); {} when none set. */
+    sub_labels?: SubLabels;
+}
+export interface Pagination {
+    total: number;
+    limit: number;
+    offset: number;
+    has_more: boolean;
+}
+/**
+ * One conversion from GET /api/conversions.
+ *
+ * spend/payout are absent (key missing) when the caller's role may not see them —
+ * publisher-side roles lose `spend`, advertiser-side roles lose `payout`. `null`
+ * is different: the column is visible and simply has no amount recorded. Consumers
+ * that treat "no payout" as a signal have to tell the two apart.
+ */
+export interface Conversion {
+    ad_event_id: string;
+    namespace?: string;
+    click_id: string | null;
+    payload: string | null;
+    spend?: number | null;
+    payout?: number | null;
+    source_click_id?: string | null;
+    sub1?: string | null;
+    sub2?: string | null;
+    sub3?: string | null;
+    sub4?: string | null;
+    sub5?: string | null;
+    /** Unix ms when the conversion was recorded. */
+    created_at: number;
+}
+export interface ConversionsResponse {
+    conversions: Conversion[];
+    pagination: Pagination;
+}
+/** Campaign row from list/get. */
+export interface Campaign {
+    id: number;
+    name: string;
+    status: string;
+    redirect_url?: string | null;
+    payment_model?: string;
+    rate?: number;
+    start_date?: number | null;
+    end_date?: number | null;
+    user_email?: string | null;
+    daily_budget?: number | null;
+    total_budget?: number | null;
+    pacing?: string;
+    budget_paused?: number;
+    budget_pause_reason?: string | null;
+    silent?: number;
+    payout_goal_type?: string | null;
+    created_at?: number;
+    updated_at?: number;
+    targeting_rules?: TargetingRule[];
+}
+/** Response of POST /api/campaigns. */
+export interface CreateCampaignResponse {
+    id: number;
+    name: string;
+    status: string;
+    created_at: number;
+}
+export interface CampaignsResponse {
+    campaigns: Campaign[];
+    pagination: Pagination;
+}
+export interface Zone {
+    id: string;
+    name: string;
+    status: string;
+    site_url?: string | null;
+    traffic_back_url?: string | null;
+    postback_url?: string | null;
+    user_email?: string | null;
+    manager_email?: string | null;
+    created_at?: number;
+    updated_at?: number;
+}
+export interface ZonesResponse {
+    zones: Zone[];
+    pagination: Pagination;
+}
+export interface CreateZoneResponse {
+    id: string;
+    status: string;
+    created_at: number;
+}
+export interface UpdateZoneResponse {
+    id: string;
+    updated_at: number;
+}
+export interface UpdateCampaignResponse {
+    id: number;
+    updated_at: number;
+}
+/** Subset of GET /api/tenant this server reads. */
+export interface TenantSettingsResponse {
+    company?: string;
+    /** IANA name; every date the tools render or resolve is in this zone. */
+    timezone?: string;
+    sub_labels?: SubLabels;
+    /** Tenant's own API domain; "" when unset. Integration URLs must use it. */
+    custom_api_domain?: string;
+}
+/** One payout rule from GET/POST /api/campaigns/{id}/payout_rules. */
+export interface PayoutRule {
+    id: number;
+    campaign_id: number;
+    zone_id: string | null;
+    payout: number;
+    created_at?: number;
+}
+export interface PayoutRulesResponse {
+    payout_rules: PayoutRule[];
+}
+/**
+ * One team member from GET /api/api-keys?type=user, or the response of
+ * POST /api/api-keys?type=user (create).
+ *
+ * `token` is present in both. It is not a one-time secret — affset returns it
+ * on every list call to a permitted role, same as the dashboard's "Copy token"
+ * button — but `list_team` deliberately never echoes it anyway, since a
+ * browsing-style "show my team" query is a bad place for live credentials to
+ * repeatedly pass through model context. `create_team_member` is the
+ * considered exception: it echoes the token exactly once, on the one call
+ * that just minted it for the operator to hand to that person.
+ */
+export interface TeamMember {
+    token?: string;
+    namespace?: string;
+    user_id?: string;
+    email: string | null;
+    role: string;
+    created_at: number;
+    expires_at?: number;
+    permissions?: string[];
+    manager_email?: string;
+}
+/** Response of POST /api/api-keys?type=user — same shape as TeamMember, token always present. */
+export type CreateTeamMemberResponse = TeamMember & {
+    token: string;
+};
+export interface TargetingRule {
+    id?: number;
+    campaign_id?: string | number;
+    targeting_rule_type_id: number;
+    targeting_method: "whitelist" | "blacklist";
+    rule: string;
+}
+export interface TargetingRulesResponse {
+    targeting_rules: TargetingRule[];
+}
+export interface TargetingRuleType {
+    id: number;
+    name: string;
+    description?: string | null;
+}
+export interface TargetingRuleTypesResponse {
+    targeting_rule_types: TargetingRuleType[];
+}
+/** The five traffic-source breakdown keys. */
+export declare const SUB_KEYS: readonly ["sub1", "sub2", "sub3", "sub4", "sub5"];
+export type SubKey = (typeof SUB_KEYS)[number];
+/** Tenant display names for sub slots; only labeled slots are present. */
+export type SubLabels = Partial<Record<SubKey, string>>;
+/** Valid `group_by` dimensions accepted by `GET /api/stats`. */
+export declare const GROUP_BY_VALUES: readonly ["date", "campaign_id", "zone_id", "country", "conversion_type", "publisher_email", "advertiser_email", "sub1", "sub2", "sub3", "sub4", "sub5"];
+export type GroupBy = (typeof GROUP_BY_VALUES)[number];
+export declare const CAMPAIGN_STATUSES: readonly ["active", "paused", "archived"];
+export declare const ZONE_STATUSES: readonly ["active", "inactive"];
+export declare const PAYMENT_MODELS: readonly ["cpa", "cpm"];
+export declare const PACING_VALUES: readonly ["asap", "even"];

package/dist/types.js

@@ -9,6 +9,7 @@ export const GROUP_BY_VALUES = [
     "country",
     "conversion_type",
     "publisher_email",
+    "advertiser_email",
     ...SUB_KEYS,
 ];
 export const CAMPAIGN_STATUSES = ["active", "paused", "archived"];

package/dist/version.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Package version, duplicated from package.json so the core stays importable
+ * on runtimes without Node's module APIs (Workers). createRequire-reading
+ * package.json here would break bundlers; a sync test guards the duplicate
+ * (see registerTools.test.ts).
+ */
+export declare const VERSION = "0.2.0";

package/dist/version.js

@@ -0,0 +1,8 @@
+/**
+ * Package version, duplicated from package.json so the core stays importable
+ * on runtimes without Node's module APIs (Workers). createRequire-reading
+ * package.json here would break bundlers; a sync test guards the duplicate
+ * (see registerTools.test.ts).
+ */
+export const VERSION = "0.2.0";
+//# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@affset/mcp",
-  "version": "0.1.0",
+  "version": "0.2.0",
+  "mcpName": "io.github.affset/mcp",
   "description": "MCP server for the affset ad platform — stats, campaigns, zones, payouts, targeting, sub labels, and team from your chat client.",
   "type": "module",
   "license": "MIT",
@@ -19,6 +20,19 @@
   "bin": {
     "affset-mcp": "dist/index.js"
   },
+  "main": "./dist/core.js",
+  "types": "./dist/core.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/core.d.ts",
+      "default": "./dist/core.js"
+    },
+    "./core": {
+      "types": "./dist/core.d.ts",
+      "default": "./dist/core.js"
+    },
+    "./package.json": "./package.json"
+  },
   "files": [
     "dist",
     "!dist/**/*.test.*",
@@ -27,7 +41,7 @@
     ".env.example"
   ],
   "engines": {
-    "node": ">=18"
+    "node": ">=22.13.0"
   },
   "scripts": {
     "build": "tsc",