@every-app/sdk 0.2.0 → 0.3.0-rc.10

package/dist/internal/catalog/comms.d.ts

@@ -0,0 +1,375 @@
+export declare const COMMS: {
+    readonly postmark: {
+        readonly mode: "api_key";
+        readonly label: "Postmark";
+        readonly description: "Transactional email: single, batch and templated messages from one Postmark server.";
+        readonly auth: {
+            readonly kind: "header";
+            readonly secret: "POSTMARK_API_TOKEN";
+            readonly header: "X-Postmark-Server-Token";
+        };
+        readonly docs: "https://postmarkapp.com/support/article/1008-what-are-the-account-and-server-api-tokens";
+        readonly api: "https://postmarkapp.com/developer/api/overview";
+        readonly hosts: readonly ["api.postmarkapp.com"];
+        readonly data: "account";
+        readonly access: readonly ["write"];
+        readonly readMethods: readonly [];
+        readonly writeMethods: readonly ["POST"];
+        readonly accountWidePaths: readonly [readonly ["server"], readonly ["servers"], readonly ["domains"], readonly ["senders"], readonly ["webhooks"], readonly ["message-streams"], readonly ["triggers"], readonly ["data-removals"]];
+        readonly hint: "A Server API token from the API Tokens tab of the Postmark server the app sends from; the Gateway sends it in the X-Postmark-Server-Token header.";
+        readonly secrets: readonly [{
+            readonly name: "POSTMARK_API_TOKEN";
+            readonly hint: "A Server API token from the server's API Tokens tab, never the Account API token.";
+        }];
+        readonly smoke: {
+            readonly method: "GET";
+            readonly path: "/server";
+            readonly expect: readonly [200];
+            readonly free: true;
+            readonly note: "Returns the server's settings; account-wide, so run it from a terminal.";
+        };
+        readonly example: "send a password reset email";
+        readonly verified: {
+            readonly on: "2026-10-25";
+            readonly how: "docs";
+        };
+        readonly tags: readonly ["email", "transactional"];
+    };
+    readonly sendgrid: {
+        readonly mode: "api_key";
+        readonly label: "SendGrid";
+        readonly description: "Twilio SendGrid email: send transactional and marketing mail through the v3 Mail Send API.";
+        readonly auth: {
+            readonly kind: "bearer";
+            readonly secret: "SENDGRID_API_KEY";
+        };
+        readonly docs: "https://app.sendgrid.com/settings/api_keys";
+        readonly api: "https://www.twilio.com/docs/sendgrid/api-reference";
+        readonly hosts: readonly ["api.sendgrid.com", "api.eu.sendgrid.com"];
+        readonly data: "account";
+        readonly access: readonly ["write"];
+        readonly readMethods: readonly [];
+        readonly writeMethods: readonly ["POST"];
+        readonly accountWidePaths: readonly [readonly ["api_keys"], readonly ["scopes"], readonly ["user"], readonly ["subusers"], readonly ["teammates"], readonly ["sso"], readonly ["access_settings"], readonly ["whitelabel"], readonly ["ips"], readonly ["send_ips"], readonly ["partners"], readonly ["partner_settings"], readonly ["alerts"], readonly ["mail_settings"], readonly ["tracking_settings"], readonly ["verified_senders"], readonly ["senders"], readonly ["marketing", "integrations"], readonly ["recipients", "erasejob"]];
+        readonly hint: "An API key from Settings > API Keys in SendGrid, sent as a bearer token; Custom Access with Mail Send alone is enough to send. EU regional subusers call api.eu.sendgrid.com.";
+        readonly secrets: readonly [{
+            readonly name: "SENDGRID_API_KEY";
+            readonly hint: "A Custom Access key with Mail Send only, never a Full Access key.";
+        }];
+        readonly smoke: {
+            readonly method: "GET";
+            readonly path: "/v3/scopes";
+            readonly expect: readonly [200];
+            readonly free: true;
+            readonly note: "Lists the key's own scopes (the docs don't say whether a Mail-Send-only key may call it); account-wide, so run it from a terminal.";
+        };
+        readonly rate: {
+            readonly note: "Each endpoint has its own limit; answers carry X-RateLimit-Limit, -Remaining and -Reset.";
+        };
+        readonly example: "send an order confirmation email";
+        readonly verified: {
+            readonly on: "2026-10-25";
+            readonly how: "docs";
+        };
+        readonly tags: readonly ["email", "transactional", "marketing"];
+    };
+    readonly twilio: {
+        readonly mode: "api_key";
+        readonly label: "Twilio";
+        readonly description: "SMS, MMS and voice: send text messages and place calls from your Twilio numbers.";
+        readonly auth: {
+            readonly kind: "basic";
+            readonly secret: "TWILIO_API_SECRET";
+            readonly as: "password";
+            readonly user: {
+                readonly secret: "TWILIO_API_KEY";
+            };
+        };
+        readonly docs: "https://www.twilio.com/docs/iam/api-keys/keys-in-console";
+        readonly api: "https://www.twilio.com/docs/usage/requests-to-twilio";
+        readonly hosts: readonly ["api.twilio.com"];
+        readonly data: "account";
+        readonly access: readonly ["write"];
+        readonly readMethods: readonly [];
+        readonly writeMethods: readonly ["POST"];
+        readonly accountWidePaths: readonly [readonly ["keys"], readonly ["signingkeys"], readonly ["incomingphonenumbers"], readonly ["outgoingcallerids"], readonly ["applications"], readonly ["connectapps"], readonly ["authorizedconnectapps"], readonly ["addresses"], readonly ["sip"], readonly ["usage"], readonly ["balance"]];
+        readonly hint: "A Standard or Restricted API key from Account settings > API keys & auth tokens in the Twilio Console, sent as HTTP Basic (the key's SID and secret); a Standard key can't reach the Accounts or Keys resources. Every path names the account, so the app puts its Account SID in it: /2010-04-01/Accounts/<Account SID>/Messages.json, with a form-encoded body.";
+        readonly secrets: readonly [{
+            readonly name: "TWILIO_API_SECRET";
+            readonly hint: "The API key's secret, shown once when the key is created.";
+        }, {
+            readonly name: "TWILIO_API_KEY";
+            readonly hint: "The SID of a Standard or Restricted API key, never a Main key or the Auth Token.";
+        }];
+        readonly example: "text a reminder to a customer's phone number";
+        readonly verified: {
+            readonly on: "2026-10-25";
+            readonly how: "docs";
+        };
+        readonly tags: readonly ["sms", "voice", "messaging"];
+    };
+    readonly intercom: {
+        readonly mode: "api_key";
+        readonly label: "Intercom";
+        readonly description: "Customer messaging: contacts, companies, conversations, tickets and help center articles.";
+        readonly auth: {
+            readonly kind: "bearer";
+            readonly secret: "INTERCOM_API_TOKEN";
+        };
+        readonly docs: "https://app.intercom.com/a/apps/_/developer-hub";
+        readonly api: "https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis";
+        readonly hosts: readonly ["api.intercom.io", "api.eu.intercom.io", "api.au.intercom.io"];
+        readonly data: "account";
+        readonly access: readonly ["read", "write"];
+        readonly readMethods: readonly ["GET", "HEAD"];
+        readonly writeMethods: readonly ["POST", "PUT", "PATCH", "DELETE"];
+        readonly accountWidePaths: readonly [readonly ["me"], readonly ["admins"], readonly ["teams"], readonly ["export"], readonly ["download"], readonly ["ip_allowlist"]];
+        readonly hint: "The Access Token of a private app in your workspace's Developer Hub, sent as a bearer token. Searching contacts, conversations or tickets is a POST, so an app that searches asks for write.";
+        readonly secrets: readonly [{
+            readonly name: "INTERCOM_API_TOKEN";
+            readonly hint: "The Access Token on your private app's Configure > Authentication page in the Developer Hub.";
+        }];
+        readonly smoke: {
+            readonly method: "GET";
+            readonly path: "/me";
+            readonly expect: readonly [200];
+            readonly free: true;
+            readonly note: "Returns the admin behind the token; account-wide, so run it from a terminal.";
+        };
+        readonly rate: {
+            readonly perMinute: 10000;
+            readonly note: "Per workspace, shared by its private apps; 25,000 a minute across all apps; counted in 10-second windows.";
+        };
+        readonly example: "list the latest open conversations";
+        readonly verified: {
+            readonly on: "2026-10-25";
+            readonly how: "docs";
+        };
+        readonly tags: readonly ["support", "crm", "messaging"];
+    };
+    readonly crisp: {
+        readonly mode: "api_key";
+        readonly label: "Crisp";
+        readonly description: "Customer chat: conversations, messages, people and visitors of one Crisp workspace.";
+        readonly auth: {
+            readonly kind: "basic";
+            readonly secret: "CRISP_API_KEY";
+            readonly as: "password";
+            readonly user: {
+                readonly secret: "CRISP_API_IDENTIFIER";
+            };
+        };
+        readonly docs: "https://docs.crisp.chat/guides/rest-api/authentication/website-token/";
+        readonly api: "https://docs.crisp.chat/references/rest-api/v1/";
+        readonly hosts: readonly ["api.crisp.chat"];
+        readonly data: "account";
+        readonly access: readonly ["read", "write"];
+        readonly readMethods: readonly ["GET", "HEAD"];
+        readonly writeMethods: readonly ["POST", "PUT", "PATCH", "DELETE"];
+        readonly accountWidePaths: readonly [readonly ["operators"], readonly ["operator"], readonly ["teams"], readonly ["team"], readonly ["settings"], readonly ["verify"], readonly ["audit"], readonly ["plans"], readonly ["plugins"], readonly ["plugin"], readonly ["connect"]];
+        readonly hint: "A website token, which the workspace owner generates under Settings > Workspace Settings > Advanced configuration > API Token. The Gateway sends the identifier and key as HTTP Basic; the app sends X-Crisp-Tier: website on every call.";
+        readonly secrets: readonly [{
+            readonly name: "CRISP_API_KEY";
+            readonly hint: "The token's key, shown once when the workspace owner generates it.";
+        }, {
+            readonly name: "CRISP_API_IDENTIFIER";
+            readonly hint: "The token's identifier, shown beside the key.";
+        }];
+        readonly rate: {
+            readonly perDay: 10000;
+            readonly note: "The website token's daily quota.";
+        };
+        readonly example: "list the latest chat conversations on my website";
+        readonly verified: {
+            readonly on: "2026-10-25";
+            readonly how: "docs";
+        };
+        readonly tags: readonly ["support", "chat", "messaging"];
+    };
+    readonly granola: {
+        readonly mode: "api_key";
+        readonly label: "Granola";
+        readonly description: "Meeting notes: list, search and read notes with their AI summaries, transcripts, folders and spaces.";
+        readonly auth: {
+            readonly kind: "bearer";
+            readonly secret: "GRANOLA_API_KEY";
+        };
+        readonly docs: "https://docs.granola.ai/help-center/sharing/integrations/granola-api";
+        readonly api: "https://docs.granola.ai/introduction";
+        readonly hosts: readonly ["public-api.granola.ai"];
+        readonly data: "account";
+        readonly access: readonly ["read"];
+        readonly readMethods: readonly ["GET", "POST"];
+        readonly accountWidePaths: readonly [readonly ["audit"], readonly ["webhook-endpoints"], readonly ["legal-holds"]];
+        readonly hint: "An API key (grn_...) from the Granola desktop app's Settings > Connectors > API keys, on a Business or Enterprise plan; the Gateway sends it as a bearer token. It reads only the notes its scopes allow.";
+        readonly secrets: readonly [{
+            readonly name: "GRANOLA_API_KEY";
+            readonly hint: "A personal or workspace API key (grn_...), with only the note scopes the apps need.";
+        }];
+        readonly rate: {
+            readonly perSecond: 5;
+            readonly note: "Bursts of 25 requests in 5 seconds; per user or per workspace, by the key's scope.";
+        };
+        readonly smoke: {
+            readonly method: "GET";
+            readonly path: "/v1/notes?page_size=1";
+            readonly expect: readonly [200];
+            readonly free: true;
+        };
+        readonly example: "summarize what we decided in this week's customer calls";
+        readonly verified: {
+            readonly on: "2026-10-30";
+            readonly how: "docs";
+        };
+        readonly tags: readonly ["meetings", "notes", "transcripts"];
+    };
+    readonly linear: {
+        readonly mode: "api_key";
+        readonly label: "Linear";
+        readonly description: "Issue tracking over GraphQL: issues, projects, cycles, comments and teams.";
+        readonly auth: {
+            readonly kind: "header";
+            readonly secret: "LINEAR_API_KEY";
+            readonly header: "Authorization";
+        };
+        readonly docs: "https://linear.app/settings/account/security";
+        readonly api: "https://linear.app/developers/graphql";
+        readonly hosts: readonly ["api.linear.app"];
+        readonly data: "account";
+        readonly access: readonly ["write"];
+        readonly readMethods: readonly [];
+        readonly writeMethods: readonly ["POST"];
+        readonly accountWidePaths: readonly [];
+        readonly hint: "A personal API key from Settings > Account > Security & access; the Gateway sends it as the Authorization header with no Bearer word. Every call is a POST to /graphql, queries included, so the app asks for write.";
+        readonly secrets: readonly [{
+            readonly name: "LINEAR_API_KEY";
+            readonly hint: "A personal API key, restricted to the permissions and teams the app needs.";
+        }];
+        readonly rate: {
+            readonly note: "2,500 requests and 3,000,000 complexity points an hour per API key.";
+        };
+        readonly example: "create an issue for this bug in the Engineering team";
+        readonly verified: {
+            readonly on: "2026-10-25";
+            readonly how: "docs";
+        };
+        readonly tags: readonly ["issues", "project-management", "graphql"];
+    };
+    readonly github: {
+        readonly mode: "api_key";
+        readonly label: "GitHub";
+        readonly description: "Code hosting: repositories, issues, pull requests, Actions and releases through the REST API.";
+        readonly auth: {
+            readonly kind: "bearer";
+            readonly secret: "GITHUB_API_TOKEN";
+        };
+        readonly docs: "https://github.com/settings/personal-access-tokens/new";
+        readonly api: "https://docs.github.com/en/rest";
+        readonly hosts: readonly ["api.github.com"];
+        readonly data: "account";
+        readonly access: readonly ["read", "write"];
+        readonly readMethods: readonly ["GET", "HEAD"];
+        readonly writeMethods: readonly ["POST", "PUT", "PATCH", "DELETE"];
+        readonly accountWidePaths: readonly [readonly ["user", "email"], readonly ["user", "emails"], readonly ["user", "public_emails"], readonly ["user", "gpg_keys"], readonly ["user", "ssh_signing_keys"], readonly ["user", "social_accounts"], readonly ["keys"], readonly ["hooks"], readonly ["secrets"], readonly ["members"], readonly ["memberships"], readonly ["invitations"], readonly ["failed_invitations"], readonly ["collaborators"], readonly ["outside_collaborators"], readonly ["blocks"], readonly ["installations"], readonly ["personal-access-tokens"], readonly ["personal-access-token-requests"], readonly ["credential-authorizations"], readonly ["audit-log"], readonly ["billing"]];
+        readonly hint: "A fine-grained personal access token from Settings > Developer settings, limited to one owner, the repositories the app needs and the least permissions; sent as a bearer token. GraphQL is a POST to /graphql, so it needs write.";
+        readonly secrets: readonly [{
+            readonly name: "GITHUB_API_TOKEN";
+            readonly hint: "A fine-grained personal access token limited to the repositories and permissions the app needs.";
+        }];
+        readonly smoke: {
+            readonly method: "GET";
+            readonly path: "/user";
+            readonly expect: readonly [200];
+            readonly free: true;
+            readonly note: "Returns the token's owner; 401 means the token is wrong.";
+        };
+        readonly rate: {
+            readonly note: "5,000 requests an hour per token; at most 100 concurrent requests and 900 points a minute across REST endpoints.";
+        };
+        readonly example: "list the open pull requests in my repository";
+        readonly verified: {
+            readonly on: "2026-10-25";
+            readonly how: "docs";
+        };
+        readonly tags: readonly ["code", "git", "issues"];
+    };
+    readonly gitlab: {
+        readonly mode: "api_key";
+        readonly label: "GitLab";
+        readonly description: "Code hosting on GitLab.com: projects, issues, merge requests, pipelines and releases.";
+        readonly auth: {
+            readonly kind: "header";
+            readonly secret: "GITLAB_API_TOKEN";
+            readonly header: "PRIVATE-TOKEN";
+        };
+        readonly docs: "https://gitlab.com/-/user_settings/personal_access_tokens";
+        readonly api: "https://docs.gitlab.com/api/rest/";
+        readonly hosts: readonly ["gitlab.com"];
+        readonly data: "account";
+        readonly access: readonly ["read", "write"];
+        readonly readMethods: readonly ["GET", "HEAD"];
+        readonly writeMethods: readonly ["POST", "PUT", "PATCH", "DELETE"];
+        readonly accountWidePaths: readonly [readonly ["user"], readonly ["personal_access_tokens"], readonly ["access_tokens"], readonly ["deploy_tokens"], readonly ["deploy_keys"], readonly ["project_deploy_keys"], readonly ["hooks"], readonly ["members"], readonly ["pending_members"], readonly ["billable_members"], readonly ["invitations"], readonly ["variables"], readonly ["audit_events"]];
+        readonly hint: "A personal, project or group access token from GitLab.com, sent in the PRIVATE-TOKEN header; read_api is enough to read. Paths start with /api/v4. A self-managed GitLab needs its own registered provider.";
+        readonly secrets: readonly [{
+            readonly name: "GITLAB_API_TOKEN";
+            readonly hint: "A personal, project or group access token with read_api, or api when the app writes.";
+        }];
+        readonly smoke: {
+            readonly method: "GET";
+            readonly path: "/api/v4/personal_access_tokens/self";
+            readonly expect: readonly [200];
+            readonly free: true;
+            readonly note: "Describes a personal access token itself (401 when it is wrong or revoked); account-wide, so run it from a terminal.";
+        };
+        readonly rate: {
+            readonly perMinute: 2000;
+            readonly note: "Authenticated API traffic per user on GitLab.com.";
+        };
+        readonly example: "list the open merge requests in my project";
+        readonly verified: {
+            readonly on: "2026-10-25";
+            readonly how: "docs";
+        };
+        readonly tags: readonly ["code", "git", "ci"];
+    };
+    readonly vercel: {
+        readonly mode: "api_key";
+        readonly label: "Vercel";
+        readonly description: "Frontend hosting: projects, deployments, domains and logs through the Vercel REST API.";
+        readonly auth: {
+            readonly kind: "bearer";
+            readonly secret: "VERCEL_API_TOKEN";
+        };
+        readonly docs: "https://vercel.com/account/tokens";
+        readonly api: "https://vercel.com/docs/rest-api";
+        readonly hosts: readonly ["api.vercel.com"];
+        readonly data: "account";
+        readonly access: readonly ["read", "write"];
+        readonly readMethods: readonly ["GET", "HEAD"];
+        readonly writeMethods: readonly ["POST", "PUT", "PATCH", "DELETE"];
+        readonly accountWidePaths: readonly [readonly ["user"], readonly ["teams"], readonly ["members"], readonly ["organizations"], readonly ["access-groups"], readonly ["billing"], readonly ["webhooks"], readonly ["drains"], readonly ["env"], readonly ["v3", "events"], readonly ["v1", "events"], readonly ["v1", "integrations"], readonly ["installations"], readonly ["connect"], readonly ["kms"], readonly ["api-keys"], readonly ["ai-gateway"], readonly ["token"], readonly ["tokens"], readonly ["registrar"], readonly ["transfer-request"]];
+        readonly hint: "An access token from your account's Tokens page, sent as a bearer token; scope it to one team or one project. A team- or project-scoped token needs no teamId parameter.";
+        readonly secrets: readonly [{
+            readonly name: "VERCEL_API_TOKEN";
+            readonly hint: "An access token scoped to one team or one project, never Full Account.";
+        }];
+        readonly smoke: {
+            readonly method: "GET";
+            readonly path: "/v10/projects";
+            readonly expect: readonly [200];
+            readonly free: true;
+            readonly note: "Lists the projects the token can reach.";
+        };
+        readonly rate: {
+            readonly note: "Limits are per action (deployments, domains, teams), listed on Vercel's limits page.";
+        };
+        readonly example: "list the latest deployments of my project";
+        readonly verified: {
+            readonly on: "2026-10-25";
+            readonly how: "docs";
+        };
+        readonly tags: readonly ["hosting", "deploy", "frontend"];
+    };
+};
+//# sourceMappingURL=comms.d.ts.map

package/dist/internal/catalog/comms.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"comms.d.ts","sourceRoot":"","sources":["../../../src/internal/catalog/comms.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAihBmC,CAAC"}