@myapihq/sdk 1.1.0-wip.4 → 1.2.0

package/dist/services.js

@@ -0,0 +1,190 @@
+"use strict";
+// Canonical service registry — the single source of truth for everything
+// downstream (skill plugin.json generators, mirror-repo publisher, docs site,
+// scaffolders, etc.).
+//
+// To add a service: append an entry here. To rename, change description, or
+// re-categorize: edit here. Run `npm run canonical-sync` to propagate to
+// every rendered artifact (plugin.json files today; npm/PyPI metadata,
+// GitHub repo descriptions, docs site landing pages tomorrow).
+//
+// CI enforces no drift: `services-sync.test.ts` runs `canonical-sync
+// --check` and fails on any difference.
+//
+// Skill names MUST match the directory names under skills/<name>/ and the
+// repo names we want to claim on GitHub/npm. Don't paraphrase.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SERVICES = void 0;
+const SHARED_KEYWORDS = ['mcp', 'claude-skill', 'ai-agent', 'cli', 'myapi'];
+const k = (...extra) => [...SHARED_KEYWORDS, ...extra];
+exports.SERVICES = [
+    // ── identity / infra ────────────────────────────────────────────────
+    {
+        module: 'hq',
+        skill: 'my-api-hq',
+        domain: 'myapihq.com',
+        description: 'Core identity and billing hub. Manage auth, organizations, and billing.',
+        category: 'identity',
+        status: 'ga',
+        keywords: k('auth', 'identity', 'billing', 'organization'),
+    },
+    {
+        module: 'domain',
+        skill: 'my-domain-api',
+        domain: 'mydomainapi.com',
+        description: 'Domain registration and check with automated DNS and email infrastructure.',
+        category: 'infra',
+        status: 'ga',
+        keywords: k('domain', 'dns', 'registration'),
+    },
+    // ── send ────────────────────────────────────────────────────────────
+    {
+        // Customer-facing email surface (mailboxes, campaigns, templates,
+        // warmup) is gated pre-launch — 503 SERVICE_NOT_LAUNCHED. Sibling
+        // `my-email-verify-api` stays GA and remains the discoverable entry
+        // point for the email primitive today.
+        module: 'email',
+        skill: 'my-email-api',
+        domain: 'myemailapi.com',
+        description: 'Send transactional and bulk email from your own domain. Mailboxes, AI templates, drip campaigns, and warmup.',
+        category: 'send',
+        status: 'preview',
+        keywords: k('email', 'transactional', 'campaign', 'smtp'),
+    },
+    {
+        module: 'email',
+        skill: 'my-email-verify-api',
+        domain: 'myemailapi.com',
+        description: 'Sync single-address email verification — syntax + DNS + Microsoft probe. Pre-send quality gate for campaigns.',
+        category: 'send',
+        status: 'ga',
+        keywords: k('email', 'verification', 'deliverability', 'syntax', 'dns'),
+    },
+    {
+        module: 'funnel',
+        skill: 'my-funnel-api',
+        domain: 'myfunnelapi.com',
+        description: 'Build multi-page sites and funnels with headless HTML upload.',
+        category: 'send',
+        status: 'ga',
+        keywords: k('funnel', 'landing-page', 'website', 'static-site'),
+    },
+    {
+        module: 'url',
+        skill: 'my-url-to',
+        domain: 'myurlto.com',
+        description: 'Stateless link routing and URL shortening for the MyAPI ecosystem.',
+        category: 'send',
+        status: 'preview',
+        keywords: k('url', 'shortener', 'redirect', 'link'),
+    },
+    {
+        module: 'image',
+        skill: 'my-image-api',
+        domain: 'myimageapi.com',
+        description: 'Generate AI images from a text prompt. Async, polls until ready, returns a public CDN URL.',
+        category: 'compute',
+        status: 'ga',
+        keywords: k('image', 'ai-image', 'gemini', 'text-to-image'),
+    },
+    // ── capture ─────────────────────────────────────────────────────────
+    {
+        module: 'webhook',
+        skill: 'my-webhook-api',
+        domain: 'mywebhookapi.com',
+        description: 'Receive inbound HTTP webhooks. Per-org endpoints with full delivery history.',
+        category: 'capture',
+        status: 'ga',
+        keywords: k('webhook', 'inbound', 'event'),
+    },
+    {
+        module: 'pixel',
+        skill: 'my-pixel-api',
+        domain: 'mypixelapi.com',
+        description: 'Tracking pixel + identity resolution. Capture visits, events, and stitch known users to anonymous sessions.',
+        category: 'capture',
+        status: 'planned',
+        keywords: k('pixel', 'analytics', 'tracking', 'visit', 'identity'),
+    },
+    // ── data ────────────────────────────────────────────────────────────
+    {
+        // Goldfox-backed people search is gated pre-launch — 503 SERVICE_NOT_LAUNCHED.
+        // Internal Goldfox lookups still work (`crm contacts promote` resolves a
+        // goldfox_person_id server-side), but the agent-facing search/get path
+        // is hidden until backend lifts the gate.
+        module: 'people',
+        skill: 'my-people-api',
+        domain: 'mypeopleapi.com',
+        description: 'Contact database backed by the Goldfox crawl. Filter people by confidence tier, seniority, email type, country, link confidence, plus rich behavioral company signals (has_c_level, has_careers_page, has_decision_maker). The targeting layer for outbound campaigns.',
+        category: 'data',
+        status: 'preview',
+        keywords: k('people', 'contact', 'b2b', 'targeting', 'goldfox'),
+    },
+    {
+        // Goldfox-backed company search gated pre-launch (same reason as people).
+        module: 'company',
+        skill: 'my-company-api',
+        domain: 'mycompanyapi.com',
+        description: 'Company database backed by the Goldfox crawl. Filter companies by confidence tier, country/TLD consistency, behavioral page signals (has_careers_page, has_investors_page, has_shop_page, has_c_level, has_decision_maker), legal-entity status, headcount, and source-URL count.',
+        category: 'data',
+        status: 'preview',
+        keywords: k('company', 'firmographics', 'b2b', 'goldfox'),
+    },
+    {
+        // Saved audiences sit on top of people/company — gated together with them.
+        module: 'audience',
+        skill: 'my-audience-api',
+        domain: 'myaudienceapi.com',
+        description: 'Saved audiences = named filter snapshots over people/company database. Reuse across campaigns; refresh re-evaluates against current data.',
+        category: 'data',
+        status: 'preview',
+        keywords: k('audience', 'segment', 'filter'),
+    },
+    {
+        module: 'crm',
+        skill: 'my-crm-api',
+        domain: 'mycrmapi.com',
+        description: 'The canonical store of engaged people + companies. Auto-ingest from inbound webhooks (configurable dot-path). Fixed lifecycle_stage enum, soft delete, event timeline.',
+        category: 'data',
+        status: 'ga',
+        keywords: k('crm', 'contact', 'pipeline', 'engagement'),
+    },
+    // ── store ───────────────────────────────────────────────────────────
+    {
+        module: 'storage',
+        skill: 'my-storage-api',
+        domain: 'mystorageapi.com',
+        description: 'Edge-hosted asset storage. Upload local files or ingest from URLs, each gets a stable public CDN URL.',
+        category: 'store',
+        status: 'ga',
+        keywords: k('storage', 'cdn', 'asset', 'upload'),
+    },
+    {
+        module: 'database',
+        skill: 'my-database-api',
+        domain: 'mydatabaseapi.com',
+        description: 'Per-org KV store with namespaces + compare-and-swap. JSON values up to 256 KB. The substrate for stateful agent-built apps.',
+        category: 'store',
+        status: 'ga',
+        keywords: k('kv-store', 'database', 'state'),
+    },
+    // ── compute ─────────────────────────────────────────────────────────
+    {
+        module: 'workflow',
+        skill: 'my-workflow-api',
+        domain: 'myworkflowapi.com',
+        description: 'React to inbound webhooks with step chains: send email, post to Slack, call HTTP URLs.',
+        category: 'compute',
+        status: 'ga',
+        keywords: k('workflow', 'automation', 'orchestration'),
+    },
+    {
+        module: 'llm',
+        skill: 'my-llm-api',
+        domain: 'myllmapi.com',
+        description: 'Provider-agnostic LLM completions + embeddings via MyAPI. Routes to managed models (Gemini today, more soon) at upstream cost. Use in workflow steps, not for your own reasoning.',
+        category: 'compute',
+        status: 'ga',
+        keywords: k('llm', 'completion', 'embedding', 'gemini'),
+    },
+];

package/dist/storage.d.ts

@@ -1,3 +1,5 @@
+import type { Exposes } from './exposes';
+export declare const EXPOSES: Exposes;
 export interface Asset {
     asset_id: string;
     url: string;
@@ -5,7 +7,7 @@ export interface Asset {
     created_at: string;
 }
 export declare function ingestAsset(apiKey: string, orgId: string, url: string, name?: string): Promise<Asset>;
-export type UploadContentType = 'image/jpeg' | 'image/png' | 'image/gif' | 'image/webp';
+export type UploadContentType = 'image/jpeg' | 'image/png' | 'image/gif' | 'image/webp' | 'video/mp4' | 'video/webm';
 export declare function uploadAsset(apiKey: string, orgId: string, file: Blob | Buffer, contentType: UploadContentType, name?: string): Promise<Asset>;
 export declare function listAssets(apiKey: string, orgId: string): Promise<Asset[]>;
 export declare function deleteAsset(apiKey: string, orgId: string, assetId: string): Promise<void>;

package/dist/storage.js

@@ -1,11 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.EXPOSES = void 0;
 exports.ingestAsset = ingestAsset;
 exports.uploadAsset = uploadAsset;
 exports.listAssets = listAssets;
 exports.deleteAsset = deleteAsset;
 const client_1 = require("./client");
 const config_1 = require("./config");
+exports.EXPOSES = [
+    'POST /storage/orgs/{org_id}/assets/ingest',
+    'POST /storage/orgs/{org_id}/assets/upload',
+    'GET /storage/orgs/{org_id}/assets',
+    'DELETE /storage/orgs/{org_id}/assets/{asset_id}',
+];
 async function ingestAsset(apiKey, orgId, url, name) {
     return (0, client_1.request)('POST', `${config_1.STORAGE_BASE}/storage/orgs/${encodeURIComponent(orgId)}/assets/ingest`, apiKey, { url, name });
 }

package/dist/url.d.ts

@@ -1,3 +1,5 @@
+import type { Exposes } from './exposes';
+export declare const EXPOSES: Exposes;
 export interface ShortenResponse {
     short_code: string;
     short_url: string;

package/dist/url.js

@@ -1,8 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.EXPOSES = void 0;
 exports.shortenUrl = shortenUrl;
 const client_1 = require("./client");
 const config_1 = require("./config");
+exports.EXPOSES = [
+    'POST /url/orgs/{org_id}/shorten',
+];
 async function shortenUrl(apiKey, orgId, url) {
     return (0, client_1.request)('POST', `${config_1.URL_BASE}/url/orgs/${encodeURIComponent(orgId)}/shorten`, apiKey, { url });
 }

package/dist/webhook.d.ts

@@ -1,3 +1,5 @@
+import type { Exposes } from './exposes';
+export declare const EXPOSES: Exposes;
 export interface WebhookEndpoint {
     id: string;
     org_id: string;
@@ -5,6 +7,7 @@ export interface WebhookEndpoint {
     description?: string;
     slug: string;
     url: string;
+    crm_email_path?: string;
     created_at: string;
 }
 export interface Delivery {
@@ -13,7 +16,11 @@ export interface Delivery {
     payload: unknown;
     received_at: string;
 }
-export declare function createEndpoint(apiKey: string, orgId: string, name: string, description?: string): Promise<WebhookEndpoint>;
+export interface CreateEndpointOptions {
+    description?: string;
+    crm_email_path?: string;
+}
+export declare function createEndpoint(apiKey: string, orgId: string, name: string, opts?: CreateEndpointOptions): Promise<WebhookEndpoint>;
 export declare function listEndpoints(apiKey: string, orgId: string): Promise<WebhookEndpoint[]>;
 export declare function deleteEndpoint(apiKey: string, orgId: string, endpointId: string): Promise<void>;
 export declare function getDelivery(apiKey: string, orgId: string, deliveryId: string): Promise<Delivery>;

package/dist/webhook.js

@@ -1,13 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.EXPOSES = void 0;
 exports.createEndpoint = createEndpoint;
 exports.listEndpoints = listEndpoints;
 exports.deleteEndpoint = deleteEndpoint;
 exports.getDelivery = getDelivery;
 const client_1 = require("./client");
 const config_1 = require("./config");
-async function createEndpoint(apiKey, orgId, name, description) {
-    return (0, client_1.request)('POST', `${config_1.WEBHOOK_BASE}/webhook/orgs/${encodeURIComponent(orgId)}/endpoints`, apiKey, { name, description });
+exports.EXPOSES = [
+    'POST /webhook/orgs/{org_id}/endpoints',
+    'GET /webhook/orgs/{org_id}/endpoints',
+    'DELETE /webhook/orgs/{org_id}/endpoints/{endpoint_id}',
+    'GET /webhook/orgs/{org_id}/deliveries/{delivery_id}',
+];
+async function createEndpoint(apiKey, orgId, name, opts = {}) {
+    const body = { name };
+    if (opts.description !== undefined)
+        body.description = opts.description;
+    if (opts.crm_email_path !== undefined)
+        body.crm_email_path = opts.crm_email_path;
+    return (0, client_1.request)('POST', `${config_1.WEBHOOK_BASE}/webhook/orgs/${encodeURIComponent(orgId)}/endpoints`, apiKey, body);
 }
 async function listEndpoints(apiKey, orgId) {
     return (0, client_1.request)('GET', `${config_1.WEBHOOK_BASE}/webhook/orgs/${encodeURIComponent(orgId)}/endpoints`, apiKey);

package/dist/workflow.d.ts

@@ -1,3 +1,5 @@
+import type { Exposes } from './exposes';
+export declare const EXPOSES: Exposes;
 /**
  * A single step in a workflow.
  *

package/dist/workflow.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.EXPOSES = void 0;
 exports.createWorkflow = createWorkflow;
 exports.listWorkflows = listWorkflows;
 exports.getWorkflow = getWorkflow;
@@ -11,6 +12,17 @@ exports.listWorkflowRuns = listWorkflowRuns;
 exports.getWorkflowRun = getWorkflowRun;
 const client_1 = require("./client");
 const config_1 = require("./config");
+exports.EXPOSES = [
+    'POST /workflow/orgs/{org_id}/workflows',
+    'GET /workflow/orgs/{org_id}/workflows',
+    'GET /workflow/orgs/{org_id}/workflows/{workflow_id}',
+    'PATCH /workflow/orgs/{org_id}/workflows/{workflow_id}',
+    'DELETE /workflow/orgs/{org_id}/workflows/{workflow_id}',
+    'POST /workflow/orgs/{org_id}/workflows/{workflow_id}/enable',
+    'POST /workflow/orgs/{org_id}/workflows/{workflow_id}/disable',
+    'GET /workflow/orgs/{org_id}/workflows/{workflow_id}/runs',
+    'GET /workflow/orgs/{org_id}/runs/{run_id}',
+];
 async function createWorkflow(apiKey, orgId, payload) {
     return (0, client_1.request)('POST', `${config_1.WORKFLOW_BASE}/workflow/orgs/${encodeURIComponent(orgId)}/workflows`, apiKey, payload);
 }

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@myapihq/sdk",
-  "version": "1.1.0-wip.4",
+  "license": "Apache-2.0",
+  "version": "1.2.0",
   "description": "TypeScript SDK for the MyAPI ecosystem",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",