@zyphr-dev/mcp-server 0.1.0 → 0.1.1

package/src/integration/quickstart/inbox.ts

@@ -1,222 +0,0 @@
-import type { QuickstartChannelMap } from '../quickstart-types.js';
-
-const DOCS = 'https://docs.zyphr.dev/channels/in-app-messaging';
-const ENV: string[] = ['ZYPHR_API_KEY'];
-const NEXT_STEPS = [
-  'Add ZYPHR_API_KEY to your .env file.',
-  'Use the matching subscriberId on the client (e.g. @zyphr-dev/inbox-react) to display the message.',
-];
-
-export const inboxChannel: QuickstartChannelMap = {
-  node: {
-    sdk: {
-      channel: 'inbox',
-      language: 'node',
-      framework: null,
-      variant: 'sdk',
-      files: [
-        {
-          path: 'src/services/inbox.ts',
-          purpose: 'Send an in-app inbox message through Zyphr',
-          contents:
-            "import { Zyphr } from '@zyphr-dev/node-sdk';\n\n" +
-            'const zyphr = new Zyphr({ apiKey: process.env.ZYPHR_API_KEY! });\n\n' +
-            'export async function notifyReportReady(subscriberId: string, reportId: string) {\n' +
-            '  return await zyphr.inbox.sendInApp({\n' +
-            '    subscriberId,\n' +
-            "    title: 'New report ready',\n" +
-            "    body: 'Your report finished processing — click to view.',\n" +
-            '    actionUrl: `/reports/${reportId}`,\n' +
-            "    actionLabel: 'View report',\n" +
-            '  });\n' +
-            '}\n',
-          overwrite: false,
-        },
-      ],
-      envVarsNeeded: ENV,
-      nextSteps: NEXT_STEPS,
-      docsUrl: DOCS,
-    },
-  },
-  python: {
-    sdk: {
-      channel: 'inbox',
-      language: 'python',
-      framework: null,
-      variant: 'sdk',
-      files: [
-        {
-          path: 'app/inbox.py',
-          purpose: 'Send an in-app inbox message through Zyphr',
-          contents:
-            'from .zyphr_client import zyphr_request\n\n' +
-            'def notify_report_ready(subscriber_id: str, report_id: str) -> dict:\n' +
-            '    return zyphr_request("POST", "/inbox", json={\n' +
-            '        "subscriberId": subscriber_id,\n' +
-            '        "title": "New report ready",\n' +
-            '        "body": "Your report finished processing — click to view.",\n' +
-            '        "actionUrl": f"/reports/{report_id}",\n' +
-            '        "actionLabel": "View report",\n' +
-            '    })\n',
-          overwrite: false,
-        },
-      ],
-      envVarsNeeded: ENV,
-      nextSteps: NEXT_STEPS,
-      docsUrl: DOCS,
-    },
-  },
-  ruby: {
-    sdk: {
-      channel: 'inbox',
-      language: 'ruby',
-      framework: null,
-      variant: 'sdk',
-      files: [
-        {
-          path: 'app/services/inbox_service.rb',
-          purpose: 'Send an in-app inbox message through Zyphr',
-          contents:
-            'class InboxService\n' +
-            '  def self.notify_report_ready(subscriber_id:, report_id:)\n' +
-            '    Zyphr::InboxApi.new.send_in_app(\n' +
-            '      Zyphr::SendInAppRequest.new(\n' +
-            '        subscriber_id: subscriber_id,\n' +
-            "        title: 'New report ready',\n" +
-            "        body: 'Your report finished processing — click to view.',\n" +
-            "        action_url: \"/reports/#{report_id}\",\n" +
-            "        action_label: 'View report'\n" +
-            '      )\n' +
-            '    )\n' +
-            '  end\n' +
-            'end\n',
-          overwrite: false,
-        },
-      ],
-      envVarsNeeded: ENV,
-      nextSteps: NEXT_STEPS,
-      docsUrl: DOCS,
-    },
-  },
-  go: {
-    sdk: {
-      channel: 'inbox',
-      language: 'go',
-      framework: null,
-      variant: 'sdk',
-      files: [
-        {
-          path: 'internal/notify/inbox.go',
-          purpose: 'Send an in-app inbox message through Zyphr',
-          contents:
-            'package notify\n\n' +
-            'import "yourapp/internal/zyphr"\n\n' +
-            'func NotifyReportReady(client *zyphr.Client, subscriberID, reportID string) ([]byte, error) {\n' +
-            '\treturn client.Do("POST", "/inbox", map[string]any{\n' +
-            '\t\t"subscriberId": subscriberID,\n' +
-            '\t\t"title":        "New report ready",\n' +
-            '\t\t"body":         "Your report finished processing — click to view.",\n' +
-            '\t\t"actionUrl":    "/reports/" + reportID,\n' +
-            '\t\t"actionLabel":  "View report",\n' +
-            '\t})\n' +
-            '}\n',
-          overwrite: false,
-        },
-      ],
-      envVarsNeeded: ENV,
-      nextSteps: NEXT_STEPS,
-      docsUrl: DOCS,
-    },
-  },
-  php: {
-    sdk: {
-      channel: 'inbox',
-      language: 'php',
-      framework: null,
-      variant: 'sdk',
-      files: [
-        {
-          path: 'app/Services/InboxService.php',
-          purpose: 'Send an in-app inbox message through Zyphr',
-          contents:
-            '<?php\n\n' +
-            'namespace App\\Services;\n\n' +
-            'use GuzzleHttp\\Client;\n\n' +
-            'class InboxService\n' +
-            '{\n' +
-            '    public function notifyReportReady(string $subscriberId, string $reportId): array\n' +
-            '    {\n' +
-            "        $http = new Client([\n" +
-            "            'base_uri' => 'https://api.zyphr.dev/v1/',\n" +
-            "            'headers' => [\n" +
-            "                'X-API-Key' => getenv('ZYPHR_API_KEY'),\n" +
-            "                'Content-Type' => 'application/json',\n" +
-            '            ],\n' +
-            "        ]);\n" +
-            "        $r = $http->post('inbox', ['json' => [\n" +
-            "            'subscriberId' => $subscriberId,\n" +
-            "            'title' => 'New report ready',\n" +
-            "            'body' => 'Your report finished processing — click to view.',\n" +
-            "            'actionUrl' => \"/reports/{$reportId}\",\n" +
-            "            'actionLabel' => 'View report',\n" +
-            '        ]]);\n' +
-            "        return json_decode((string) $r->getBody(), true);\n" +
-            '    }\n' +
-            '}\n',
-          overwrite: false,
-        },
-      ],
-      envVarsNeeded: ENV,
-      nextSteps: NEXT_STEPS,
-      docsUrl: DOCS,
-    },
-  },
-  csharp: {
-    sdk: {
-      channel: 'inbox',
-      language: 'csharp',
-      framework: null,
-      variant: 'sdk',
-      files: [
-        {
-          path: 'Services/InboxService.cs',
-          purpose: 'Send an in-app inbox message through Zyphr',
-          contents:
-            'using ZyphrDev.SDK.Api;\n' +
-            'using ZyphrDev.SDK.Client;\n' +
-            'using ZyphrDev.SDK.Model;\n\n' +
-            'namespace YourApp.Services;\n\n' +
-            'public class InboxService\n' +
-            '{\n' +
-            '    private readonly InboxApi _inbox;\n' +
-            '    public InboxService()\n' +
-            '    {\n' +
-            '        var config = new Configuration\n' +
-            '        {\n' +
-            '            ApiKey = new Dictionary<string, string>\n' +
-            '            {\n' +
-            '                { "X-API-Key", Environment.GetEnvironmentVariable("ZYPHR_API_KEY")! }\n' +
-            '            }\n' +
-            '        };\n' +
-            '        _inbox = new InboxApi(config);\n' +
-            '    }\n\n' +
-            '    public Task<SendInAppResponse> NotifyReportReadyAsync(string subscriberId, string reportId)\n' +
-            '    {\n' +
-            '        return _inbox.SendInAppAsync(new SendInAppRequest(\n' +
-            '            subscriberId: subscriberId,\n' +
-            '            title: "New report ready",\n' +
-            '            body: "Your report finished processing — click to view.",\n' +
-            '            actionUrl: $"/reports/{reportId}",\n' +
-            '            actionLabel: "View report"\n' +
-            '        ));\n' +
-            '    }\n' +
-            '}\n',
-          overwrite: false,
-        },
-      ],
-      envVarsNeeded: ENV,
-      nextSteps: NEXT_STEPS,
-      docsUrl: DOCS,
-    },
-  },
-};

package/src/integration/quickstart/index.ts

@@ -1,45 +0,0 @@
-import type { SdkLanguage, QuickstartChannel } from '../../schemas.js';
-import type { QuickstartChannelMap, QuickstartResult } from '../quickstart-types.js';
-import { emailChannel } from './email.js';
-import { inboxChannel } from './inbox.js';
-import { pushChannel } from './push.js';
-import { smsChannel } from './sms.js';
-import { webhookChannel } from './webhook.js';
-
-const REGISTRY: Record<QuickstartChannel, QuickstartChannelMap> = {
-  email: emailChannel,
-  push: pushChannel,
-  sms: smsChannel,
-  inbox: inboxChannel,
-  webhook: webhookChannel,
-};
-
-export interface ResolveQuickstartArgs {
-  channel: QuickstartChannel;
-  language: SdkLanguage;
-  framework?: string;
-}
-
-export interface ResolveQuickstartResult {
-  result: QuickstartResult;
-  frameworkRecognized: boolean;
-}
-
-export function resolveQuickstart(
-  args: ResolveQuickstartArgs,
-): ResolveQuickstartResult | null {
-  const langMap = REGISTRY[args.channel]?.[args.language];
-  if (!langMap) return null;
-
-  if (args.framework) {
-    const key = args.framework.trim().toLowerCase();
-    const fw = langMap.frameworks?.[key];
-    if (fw) return { result: fw, frameworkRecognized: true };
-    // unknown framework → fall back to plain SDK variant, signal recognition status
-    return { result: langMap.sdk, frameworkRecognized: false };
-  }
-
-  return { result: langMap.sdk, frameworkRecognized: true };
-}
-
-export const QUICKSTART_REGISTRY = REGISTRY;

package/src/integration/quickstart/push.ts

@@ -1,216 +0,0 @@
-import type { QuickstartChannelMap } from '../quickstart-types.js';
-
-const DOCS = 'https://docs.zyphr.dev/channels/push-notifications';
-const ENV: string[] = ['ZYPHR_API_KEY'];
-const NEXT_STEPS = [
-  'Add ZYPHR_API_KEY to your .env file.',
-  'Register at least one device for the target subscriber (via the SDK or dashboard) before sending.',
-  'Verify your push provider credentials (APNs/FCM) are configured in the Zyphr dashboard.',
-];
-
-export const pushChannel: QuickstartChannelMap = {
-  node: {
-    sdk: {
-      channel: 'push',
-      language: 'node',
-      framework: null,
-      variant: 'sdk',
-      files: [
-        {
-          path: 'src/services/push.ts',
-          purpose: 'Send a push notification through Zyphr',
-          contents:
-            "import { Zyphr } from '@zyphr-dev/node-sdk';\n\n" +
-            'const zyphr = new Zyphr({ apiKey: process.env.ZYPHR_API_KEY! });\n\n' +
-            'export async function pushOrderShipped(subscriberId: string, orderId: string) {\n' +
-            '  return await zyphr.push.sendPush({\n' +
-            '    subscriberId,\n' +
-            "    title: 'Order shipped',\n" +
-            '    body: `Order ${orderId} is on its way.`,\n' +
-            '    data: { orderId },\n' +
-            '  });\n' +
-            '}\n',
-          overwrite: false,
-        },
-      ],
-      envVarsNeeded: ENV,
-      nextSteps: NEXT_STEPS,
-      docsUrl: DOCS,
-    },
-  },
-  python: {
-    sdk: {
-      channel: 'push',
-      language: 'python',
-      framework: null,
-      variant: 'sdk',
-      files: [
-        {
-          path: 'app/push.py',
-          purpose: 'Send a push notification through Zyphr',
-          contents:
-            'from .zyphr_client import zyphr_request\n\n' +
-            'def push_order_shipped(subscriber_id: str, order_id: str) -> dict:\n' +
-            '    return zyphr_request("POST", "/push", json={\n' +
-            '        "subscriberId": subscriber_id,\n' +
-            '        "title": "Order shipped",\n' +
-            '        "body": f"Order {order_id} is on its way.",\n' +
-            '        "data": {"orderId": order_id},\n' +
-            '    })\n',
-          overwrite: false,
-        },
-      ],
-      envVarsNeeded: ENV,
-      nextSteps: NEXT_STEPS,
-      docsUrl: DOCS,
-    },
-  },
-  ruby: {
-    sdk: {
-      channel: 'push',
-      language: 'ruby',
-      framework: null,
-      variant: 'sdk',
-      files: [
-        {
-          path: 'app/services/push_service.rb',
-          purpose: 'Send a push notification through Zyphr',
-          contents:
-            'class PushService\n' +
-            '  def self.order_shipped(subscriber_id:, order_id:)\n' +
-            '    Zyphr::PushApi.new.send_push(\n' +
-            '      Zyphr::SendPushRequest.new(\n' +
-            '        subscriber_id: subscriber_id,\n' +
-            "        title: 'Order shipped',\n" +
-            "        body: \"Order #{order_id} is on its way.\",\n" +
-            '        data: { orderId: order_id }\n' +
-            '      )\n' +
-            '    )\n' +
-            '  end\n' +
-            'end\n',
-          overwrite: false,
-        },
-      ],
-      envVarsNeeded: ENV,
-      nextSteps: NEXT_STEPS,
-      docsUrl: DOCS,
-    },
-  },
-  go: {
-    sdk: {
-      channel: 'push',
-      language: 'go',
-      framework: null,
-      variant: 'sdk',
-      files: [
-        {
-          path: 'internal/notify/push.go',
-          purpose: 'Send a push notification through Zyphr',
-          contents:
-            'package notify\n\n' +
-            'import "yourapp/internal/zyphr"\n\n' +
-            'func PushOrderShipped(client *zyphr.Client, subscriberID, orderID string) ([]byte, error) {\n' +
-            '\treturn client.Do("POST", "/push", map[string]any{\n' +
-            '\t\t"subscriberId": subscriberID,\n' +
-            '\t\t"title":        "Order shipped",\n' +
-            '\t\t"body":         "Order " + orderID + " is on its way.",\n' +
-            '\t\t"data":         map[string]string{"orderId": orderID},\n' +
-            '\t})\n' +
-            '}\n',
-          overwrite: false,
-        },
-      ],
-      envVarsNeeded: ENV,
-      nextSteps: NEXT_STEPS,
-      docsUrl: DOCS,
-    },
-  },
-  php: {
-    sdk: {
-      channel: 'push',
-      language: 'php',
-      framework: null,
-      variant: 'sdk',
-      files: [
-        {
-          path: 'app/Services/PushService.php',
-          purpose: 'Send a push notification through Zyphr',
-          contents:
-            '<?php\n\n' +
-            'namespace App\\Services;\n\n' +
-            'use GuzzleHttp\\Client;\n\n' +
-            'class PushService\n' +
-            '{\n' +
-            '    public function orderShipped(string $subscriberId, string $orderId): array\n' +
-            '    {\n' +
-            "        $http = new Client([\n" +
-            "            'base_uri' => 'https://api.zyphr.dev/v1/',\n" +
-            "            'headers' => [\n" +
-            "                'X-API-Key' => getenv('ZYPHR_API_KEY'),\n" +
-            "                'Content-Type' => 'application/json',\n" +
-            '            ],\n' +
-            "        ]);\n" +
-            "        $r = $http->post('push', ['json' => [\n" +
-            "            'subscriberId' => $subscriberId,\n" +
-            "            'title' => 'Order shipped',\n" +
-            "            'body' => \"Order {$orderId} is on its way.\",\n" +
-            "            'data' => ['orderId' => $orderId],\n" +
-            '        ]]);\n' +
-            "        return json_decode((string) $r->getBody(), true);\n" +
-            '    }\n' +
-            '}\n',
-          overwrite: false,
-        },
-      ],
-      envVarsNeeded: ENV,
-      nextSteps: NEXT_STEPS,
-      docsUrl: DOCS,
-    },
-  },
-  csharp: {
-    sdk: {
-      channel: 'push',
-      language: 'csharp',
-      framework: null,
-      variant: 'sdk',
-      files: [
-        {
-          path: 'Services/PushService.cs',
-          purpose: 'Send a push notification through Zyphr',
-          contents:
-            'using ZyphrDev.SDK.Api;\n' +
-            'using ZyphrDev.SDK.Client;\n' +
-            'using ZyphrDev.SDK.Model;\n\n' +
-            'namespace YourApp.Services;\n\n' +
-            'public class PushService\n' +
-            '{\n' +
-            '    private readonly PushApi _push;\n' +
-            '    public PushService()\n' +
-            '    {\n' +
-            '        var config = new Configuration\n' +
-            '        {\n' +
-            '            ApiKey = new Dictionary<string, string>\n' +
-            '            {\n' +
-            '                { "X-API-Key", Environment.GetEnvironmentVariable("ZYPHR_API_KEY")! }\n' +
-            '            }\n' +
-            '        };\n' +
-            '        _push = new PushApi(config);\n' +
-            '    }\n\n' +
-            '    public Task<SendPushResponse> OrderShippedAsync(string subscriberId, string orderId)\n' +
-            '    {\n' +
-            '        return _push.SendPushAsync(new SendPushRequest(\n' +
-            '            subscriberId: subscriberId,\n' +
-            '            title: "Order shipped",\n' +
-            '            body: $"Order {orderId} is on its way."\n' +
-            '        ));\n' +
-            '    }\n' +
-            '}\n',
-          overwrite: false,
-        },
-      ],
-      envVarsNeeded: ENV,
-      nextSteps: NEXT_STEPS,
-      docsUrl: DOCS,
-    },
-  },
-};

package/src/integration/quickstart/quickstart.test.ts

@@ -1,108 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import {
-  quickstartChannels,
-  sdkLanguages,
-  type QuickstartChannel,
-  type SdkLanguage,
-} from '../../schemas.js';
-import { resolveQuickstart, QUICKSTART_REGISTRY } from './index.js';
-
-const ALL_PAIRS = quickstartChannels.flatMap((c) =>
-  sdkLanguages.map((l) => [c, l] as [QuickstartChannel, SdkLanguage]),
-);
-
-const SCOPED_FRAMEWORKS: Array<[QuickstartChannel, SdkLanguage, string]> = [
-  ['email', 'node', 'express'],
-  ['email', 'node', 'nextjs'],
-  ['email', 'python', 'flask'],
-  ['email', 'python', 'fastapi'],
-  ['email', 'ruby', 'rails'],
-  ['email', 'php', 'laravel'],
-  ['email', 'csharp', 'aspnetcore'],
-  ['webhook', 'node', 'express'],
-  ['webhook', 'node', 'nextjs'],
-  ['webhook', 'python', 'flask'],
-  ['webhook', 'python', 'fastapi'],
-  ['webhook', 'ruby', 'rails'],
-  ['webhook', 'php', 'laravel'],
-  ['webhook', 'csharp', 'aspnetcore'],
-];
-
-const VERIFY_PATTERN = /verify|VerifyWebhook|verify_zyphr_webhook|verifyZyphrWebhook|FixedTimeEquals|hash_equals|secure_compare|timingSafeEqual|compare_digest|hmac\.Equal/;
-
-describe('QUICKSTART_REGISTRY', () => {
-  it.each(ALL_PAIRS)('returns at least one file for channel=%s language=%s', (channel, language) => {
-    const entry = QUICKSTART_REGISTRY[channel][language];
-    expect(entry).toBeDefined();
-    expect(entry!.sdk.files.length).toBeGreaterThanOrEqual(1);
-    for (const f of entry!.sdk.files) {
-      expect(f.path).toMatch(/\S/);
-      expect(f.contents).toMatch(/\S/);
-      expect(f.contents.length).toBeGreaterThan(40);
-    }
-  });
-
-  it.each(ALL_PAIRS)('declares ZYPHR_* env vars for channel=%s language=%s', (channel, language) => {
-    const entry = QUICKSTART_REGISTRY[channel][language]!.sdk;
-    expect(entry.envVarsNeeded.some((v) => v.startsWith('ZYPHR_'))).toBe(true);
-    if (channel === 'webhook') {
-      expect(entry.envVarsNeeded).toContain('ZYPHR_WEBHOOK_SECRET');
-    } else {
-      expect(entry.envVarsNeeded).toContain('ZYPHR_API_KEY');
-    }
-  });
-
-  it.each(sdkLanguages.map((l) => [l]))(
-    'webhook handler for %s verifies the signature (safety AC)',
-    (language) => {
-      const entry = QUICKSTART_REGISTRY.webhook[language]!.sdk;
-      const allCode = entry.files.map((f) => f.contents).join('\n');
-      expect(allCode).toMatch(VERIFY_PATTERN);
-    },
-  );
-
-  it.each(SCOPED_FRAMEWORKS)(
-    'has a framework variant for channel=%s language=%s framework=%s',
-    (channel, language, framework) => {
-      const fw = QUICKSTART_REGISTRY[channel][language]!.frameworks?.[framework];
-      expect(fw).toBeDefined();
-      expect(fw!.framework).toBe(framework);
-      expect(fw!.files.length).toBeGreaterThanOrEqual(1);
-    },
-  );
-
-  it('webhook framework variants ALL verify the signature (safety AC)', () => {
-    for (const [, language, framework] of SCOPED_FRAMEWORKS.filter(([c]) => c === 'webhook')) {
-      const fw = QUICKSTART_REGISTRY.webhook[language]!.frameworks?.[framework];
-      expect(fw, `missing webhook framework ${language}/${framework}`).toBeDefined();
-      const code = fw!.files.map((f) => f.contents).join('\n');
-      expect(code, `webhook ${language}/${framework} must verify`).toMatch(VERIFY_PATTERN);
-    }
-  });
-});
-
-describe('resolveQuickstart', () => {
-  it('returns plain SDK variant when no framework is provided', () => {
-    const r = resolveQuickstart({ channel: 'email', language: 'node' });
-    expect(r).not.toBeNull();
-    expect(r!.frameworkRecognized).toBe(true);
-    expect(r!.result.framework).toBeNull();
-  });
-
-  it('returns framework variant when recognized (case-insensitive)', () => {
-    const r = resolveQuickstart({ channel: 'email', language: 'node', framework: 'EXPRESS' });
-    expect(r!.frameworkRecognized).toBe(true);
-    expect(r!.result.framework).toBe('express');
-  });
-
-  it('falls back to plain SDK when framework is unrecognized', () => {
-    const r = resolveQuickstart({ channel: 'email', language: 'node', framework: 'lol-no' });
-    expect(r!.frameworkRecognized).toBe(false);
-    expect(r!.result.framework).toBeNull();
-  });
-
-  it('returns the webhook-handler variant for the webhook channel', () => {
-    const r = resolveQuickstart({ channel: 'webhook', language: 'python' });
-    expect(r!.result.variant).toBe('webhook-handler');
-  });
-});