@jskit-ai/connectors-catalog 0.1.1

package/src/shared/slack.js

@@ -0,0 +1,88 @@
+import { createSchema } from "json-rest-schema";
+import { secretReference } from "@jskit-ai/connectors-core/shared/configuration";
+
+const scopes = [
+  {"value": "channels:history", "label": "View messages and other content in public channels you are in", "actors": ["user", "bot"], "recommended": true},
+  {"value": "channels:read", "label": "View basic information about public channels in a workspace", "actors": ["user", "bot"], "recommended": true},
+  {"value": "bookmarks:read", "label": "List bookmarks", "actors": ["user", "bot"]},
+  {"value": "bookmarks:write", "label": "Create, edit, and remove bookmarks", "actors": ["user", "bot"]},
+  {"value": "calls:read", "label": "View information about ongoing and past calls", "actors": ["user", "bot"]},
+  {"value": "calls:write", "label": "Start and manage calls in a workspace", "actors": ["user", "bot"]},
+  {"value": "canvases:read", "label": "Access contents of canvases created inside Slack.", "actors": ["user", "bot"]},
+  {"value": "canvases:write", "label": "Create, edit and remove canvases", "actors": ["user", "bot"]},
+  {"value": "channels:write", "label": "Manage a user's public channels and create new ones on a user's behalf", "actors": ["user"]},
+  {"value": "channels:write.invites", "label": "Invite members to public channels", "actors": ["user", "bot"]},
+  {"value": "channels:write.topic", "label": "Set the description of public channels", "actors": ["user", "bot"]},
+  {"value": "chat:write", "label": "Send messages", "actors": ["user", "bot"]},
+  {"value": "dnd:read", "label": "View Do Not Disturb settings for people in a workspace", "actors": ["user", "bot"]},
+  {"value": "dnd:write", "label": "Edit a user's Do Not Disturb settings", "actors": ["user"]},
+  {"value": "emoji:read", "label": "View custom emoji in a workspace", "actors": ["user", "bot"]},
+  {"value": "files:read", "label": "View files shared in channels and conversations that your Slack app has been added to", "actors": ["user", "bot"]},
+  {"value": "files:write", "label": "Upload, edit, and delete files as your Slack app", "actors": ["user", "bot"]},
+  {"value": "groups:history", "label": "View messages and other content in private channels that your Slack app has been added to", "actors": ["user", "bot"]},
+  {"value": "groups:read", "label": "View basic information about private channels that your Slack app has been added to", "actors": ["user", "bot"]},
+  {"value": "groups:write", "label": "Manage private channels that your Slack app has been added to and create new ones", "actors": ["user", "bot"]},
+  {"value": "groups:write.invites", "label": "Invite members to private channels", "actors": ["user", "bot"]},
+  {"value": "groups:write.topic", "label": "Set the description of private channels", "actors": ["user", "bot"]},
+  {"value": "im:history", "label": "View messages and other content in direct messages you are in", "actors": ["user", "bot"]},
+  {"value": "im:read", "label": "View basic information about direct messages you are in", "actors": ["user", "bot"]},
+  {"value": "im:write", "label": "Start direct messages with people", "actors": ["user", "bot"]},
+  {"value": "im:write.topic", "label": "Set the description in direct messages", "actors": ["user", "bot"]},
+  {"value": "lists:read", "label": "View Slack Lists", "actors": ["user", "bot"]},
+  {"value": "lists:write", "label": "Create, edit, and delete Slack Lists", "actors": ["user", "bot"]},
+  {"value": "mpim:history", "label": "View messages and other content in group direct messages that your Slack app has been added to", "actors": ["user", "bot"]},
+  {"value": "mpim:read", "label": "View basic information about group direct messages that your Slack app has been added to", "actors": ["user", "bot"]},
+  {"value": "mpim:write", "label": "Start group direct messages with people", "actors": ["user", "bot"]},
+  {"value": "mpim:write.topic", "label": "Set the description in group direct messages", "actors": ["user", "bot"]},
+  {"value": "pins:read", "label": "View pinned content in channels and conversations that your Slack app has been added to", "actors": ["user", "bot"]},
+  {"value": "pins:write", "label": "Add and remove pinned messages and files", "actors": ["user", "bot"]},
+  {"value": "reactions:read", "label": "View emoji reactions", "actors": ["user", "bot"]},
+  {"value": "reactions:write", "label": "Add and edit emoji reactions", "actors": ["user", "bot"]},
+  {"value": "reminders:read", "label": "View reminders created by your Slack app", "actors": ["user"]},
+  {"value": "reminders:write", "label": "Add, remove, or mark reminders as complete", "actors": ["user"]},
+  {"value": "search:read.files", "label": "Search a workspace's content in files", "actors": ["user", "bot"]},
+  {"value": "search:read.im", "label": "Search a workspace's content in direct messages", "actors": ["user"]},
+  {"value": "search:read.mpim", "label": "Search a workspace's content in group direct messages", "actors": ["user"]},
+  {"value": "search:read.private", "label": "Search a workspace's content in private channels", "actors": ["user"]},
+  {"value": "search:read.public", "label": "Search a workspace's content in public channels", "actors": ["user", "bot"]},
+  {"value": "search:read.users", "label": "Search a workspace's users", "actors": ["user", "bot"]},
+  {"value": "team:read", "label": "View the name, email domain, and icon for workspaces your Slack app is connected to", "actors": ["user", "bot"]},
+  {"value": "usergroups:read", "label": "View user groups in a workspace", "actors": ["user", "bot"]},
+  {"value": "usergroups:write", "label": "Create and manage user groups", "actors": ["user", "bot"]},
+  {"value": "users:read", "label": "View people in a workspace", "actors": ["user", "bot"]},
+  {"value": "users:read.email", "label": "View email addresses of people in a workspace", "actors": ["user", "bot"]},
+  {"value": "users:write", "label": "Set presence for your Slack app", "actors": ["user", "bot"]},
+  {"value": "users.profile:read", "label": "View profile details about people in a workspace", "actors": ["user", "bot"]},
+  {"value": "users.profile:write", "label": "Edit a user's profile information and status", "actors": ["user"]},
+  {"value": "channels:join", "label": "Join public channels in a workspace", "actors": ["bot"]},
+  {"value": "channels:manage", "label": "Manage public channels that your Slack app has been added to and create new ones", "actors": ["bot"]},
+  {"value": "chat:write.customize", "label": "Customize the content of messages sent by your Slack app", "actors": ["bot"]},
+  {"value": "chat:write.public", "label": "Send messages to channels your Slack app isn't a member of", "actors": ["bot"]},
+  {"value": "metadata.message:read", "label": "Allows your Slack app to read message metadata in channels that your Slack app has been added to", "actors": ["bot"]}
+];
+
+const slackDefinition = Object.freeze({
+  id: "slack", name: "Slack", description: "Connect as a Slack user or install a bot to read conversations and send messages.",
+  accountModes: ["shared", "per-user", "assistant"], authenticationMethods: ["oauth2"],
+  scopes,
+  scopesForSettings: ({ actor = "user" } = {}) => scopes.filter((scope) => scope.actors.includes(actor)),
+  settingsSchema: createSchema({ signingSecretRef: { ...secretReference, required: false }, actor: { type: "string", enum: ["user", "bot"], defaultTo: "user" } }),
+  settingsFields: [{ name: "signingSecretRef", label: "Signing secret reference (optional)", placeholder: "env:SLACK_SIGNING_SECRET", hint: "For incoming events and interactions: Basic Information → App Credentials → Signing Secret. Keep the value in application Env, separate from Client Secret." }, { name: "actor", label: "Act in Slack as", items: [
+    { value: "user", title: "Connected user" }, { value: "bot", title: "Installed bot" }
+  ], hint: "User access acts as the person who connects. Bot access acts as the app in its installed workspace. Changing this choice removes permissions unavailable to that identity and requires reconnecting." }],
+  setup: {
+    url: "https://docs.slack.dev/authentication/installing-with-oauth/",
+    steps: [
+      "Open Your Apps in the Slack developer site. Choose Create New App, From scratch, name it, and select the development workspace.",
+      "Under OAuth & Permissions, add the exact HTTPS backend callback to Redirect URLs and save it.",
+      "Add the selected permissions under User Token Scopes for Connected user, or Bot Token Scopes for Installed bot. Channel listing requires channels:read; history needs the matching channels/groups/im/mpim:history permission, profiles users:read and sending chat:write. Reconnect after changing permissions.",
+      "Under Basic Information, copy Client ID and store Client Secret in the referenced Env variable. Also bind the HTTPS callback URL.",
+      "Enable token rotation before new installations if you want expiring tokens. The runtime handles new rotating or non-rotating grants; it does not convert an existing grant to rotation.",
+      "Use Manage Distribution for other workspaces. Workspace approval, Slack review and restricted scopes may require manual approval.",
+      "For incoming events, copy Signing Secret from Basic Information → App Credentials into application Env. In Event Subscriptions, enable events, enter your application HTTPS event route and select required events. For buttons or views, enable Interactivity & Shortcuts and enter the application interaction route. These routes are separate from the OAuth callback; the app must implement them first.",
+      "The application must verify signed raw request bytes, bind the Slack app/workspace, acknowledge promptly and deduplicate events before actions. Saving this form does not subscribe or deploy a callback. History reads one page of at most 15 messages; sends are not automatically retried. Invite bots to channels they need.",
+      "Save configuration, then complete the application's separate consent flow. Installing a bot is not logging into the application as a Slack user."
+    ]
+  }
+});
+export { slackDefinition };

package/src/shared/snowflake.js

@@ -0,0 +1,55 @@
+import { createSchema } from "json-rest-schema";
+
+const rolePattern = /^[\x20-\x21\x23-\x5b\x5d-\x7e]{1,255}$/u;
+function snowflakeRoleScope(role) {
+  if (!role || !rolePattern.test(role)) return null;
+  return /^[A-Za-z0-9_.~-]+$/u.test(role) ? `session:role:${role}`
+    : `session:role-encoded:${encodeURIComponent(role).replace(/[!'()*]/gu, (character) => `%${character.charCodeAt(0).toString(16).toUpperCase()}`)}`;
+}
+const snowflakeDefinition = Object.freeze({
+  id: "snowflake", name: "Snowflake", description: "Query data and manage warehouses with a connected Snowflake role.",
+  accountModes: ["shared", "per-user", "assistant"], authenticationMethods: ["oauth2"],
+  oauthClientAuthenticationMethods: ["client_secret_post", "client_secret_basic"],
+  settingsSchema: createSchema({
+    warehouse: { type: "string", minLength: 1, maxLength: 255, noTrim: true },
+    database: { type: "string", minLength: 1, maxLength: 255, noTrim: true },
+    schema: { type: "string", minLength: 1, maxLength: 255, noTrim: true },
+    accountUrl: { type: "string", required: true, maxLength: 253,
+      validator: (value) => /^https:\/\/[a-z0-9][a-z0-9_-]*(?:\.[a-z0-9][a-z0-9-]*){0,3}\.snowflakecomputing\.com\/?$/u.test(value) ||
+        "Enter the HTTPS Snowflake account URL, without a port, path, query or fragment." },
+    role: { type: "string", minLength: 1, maxLength: 255,
+      validator: (value) => rolePattern.test(value) && !["ACCOUNTADMIN", "SECURITYADMIN", "ORGADMIN", "GLOBALORGADMIN"].includes(value.toUpperCase()) ||
+        "Use a non-administrator role name in ASCII, with exact case and without quotes or backslashes." }
+  }),
+  settingsFields: [
+    { name: "warehouse", label: "Warehouse (optional)", placeholder: "APP_WAREHOUSE",
+      hint: "Exact case-sensitive warehouse name for SQL execution. Blank uses the connected user's default. Queries may resume compute and incur Snowflake charges." },
+    { name: "database", label: "Database (optional)", placeholder: "APP_DATABASE",
+      hint: "Exact case-sensitive database name for SQL execution; blank uses the user's default namespace. This is a default, not an access boundary: Snowflake role grants control access." },
+    { name: "schema", label: "Schema (optional)", placeholder: "PUBLIC",
+      hint: "Exact case-sensitive schema name for SQL execution; blank uses the user's default namespace." },
+    { name: "accountUrl", label: "Account URL", placeholder: "https://myorg-myaccount.snowflakecomputing.com",
+      hint: "Copy the account URL from Snowflake. Snowsight browser paths and organization-console URLs are not API addresses." },
+    { name: "role", label: "Role", placeholder: "VIBE64_READER",
+      hint: "Use the exact name from SHOW ROLES, normally uppercase. Leave blank to use each connected user's default role. Shared accounts should use a dedicated role." }
+  ],
+  scopes: [{ value: "refresh_token", label: "Keep access between visits (required)", recommended: true, required: true }],
+  scopesForSettings: ({ role } = {}) => [
+    { value: "refresh_token", label: snowflakeRoleScope(role) ? "Keep access between visits" : "Keep access between visits (required)", recommended: true, required: !snowflakeRoleScope(role) },
+    ...(snowflakeRoleScope(role) ? [{ value: snowflakeRoleScope(role), label: `Use role ${role} (required)`, recommended: true, required: true }] : [])
+  ],
+  permissionsHint: "The role's Snowflake grants control access. SQL and warehouse actions use those grants and may incur compute charges. Connecting Snowflake does not sign users into your application.",
+  setup: { url: "https://docs.snowflake.com/en/user-guide/oauth-custom", steps: [
+    "Sign into the target account in Snowsight. Open account details and copy Account URL into this form. Do not use the browser's app.snowflake.com address. Each Snowflake account needs its own registration.",
+    "Ask an administrator with CREATE INTEGRATION to open Projects → Worksheets → + → SQL Worksheet (or a SQL file in Workspaces). Use a new integration name; do not replace an existing production registration.",
+    "Implement the application's callback first. Use its assigned hosting origin and actual backend callback path, save that full HTTPS URL in application Env, and enter its env: reference in Callback URL reference. Paste the same URL in the SQL below in place of YOUR_CALLBACK_URL.",
+    "Run: CREATE SECURITY INTEGRATION APP_CONNECTOR TYPE = OAUTH ENABLED = TRUE OAUTH_CLIENT = CUSTOM OAUTH_CLIENT_TYPE = 'CONFIDENTIAL' OAUTH_REDIRECT_URI = 'YOUR_CALLBACK_URL' OAUTH_ENFORCE_PKCE = TRUE OAUTH_ISSUE_REFRESH_TOKENS = TRUE OAUTH_REFRESH_TOKEN_VALIDITY = 86400 OAUTH_USE_SECONDARY_ROLES = NONE;",
+    "Run SELECT SYSTEM$SHOW_OAUTH_CLIENT_SECRETS('APP_CONNECTOR'); Copy OAUTH_CLIENT_ID to Client ID. Save one returned client secret in application Env and enter only its env: reference in Client secret reference. Keep this query result out of source files, logs and chat.",
+    "Have the administrator grant the intended user a dedicated role and enter its exact name in Role. Blank uses that user's default role. ACCOUNTADMIN, SECURITYADMIN, ORGADMIN and GLOBALORGADMIN are excluded. OAuth registration privileges do not grant access to data.",
+    "For SQL, enter exact Warehouse, Database and Schema names from Snowsight or your administrator, without surrounding quotes. The role needs USAGE on the warehouse, database and schema plus SELECT on intended tables for reads, or the applicable write grants. These fields are defaults, not an access boundary.",
+    "Warehouse management needs separate grants: CREATE WAREHOUSE on the account to create, MODIFY to resize, OPERATE to resume/suspend, and OWNERSHIP to drop. Keep these out of reader roles. Resume, resize and query execution can incur Snowflake charges. New warehouses created by this connector start suspended with auto-resume disabled.",
+    "Save and connect the intended account. Per-user consent happens in the generated application's account screen. Verification lists visible databases: an empty successful list does not prove SQL access. Test an approved small query through your application; it owns query and warehouse permissions, polling and cancellation.",
+    "If consent expires or is revoked, reconnect. After a domain change, update OAUTH_REDIRECT_URI on the security integration and the application's callback Env together. Disconnect removes this application's stored connection; revoke delegated authorization in Snowflake separately when needed."
+  ] }
+});
+export { snowflakeDefinition, snowflakeRoleScope };

package/src/shared/tiktok.js

@@ -0,0 +1,22 @@
+const tiktokDefinition = Object.freeze({
+  id: "tiktok", name: "TikTok", description: "Read a connected creator's profile and public video metadata.",
+  accountModes: ["shared", "per-user", "assistant"], authenticationMethods: ["oauth2"],
+  clientIdLabel: "Client key", clientIdHint: "Use the Client key from TikTok's app credentials, not its App ID.",
+  scopes: [
+    { value: "user.info.basic", label: "Read basic profile information (required)", required: true, recommended: true },
+    { value: "user.info.stats", label: "Read user statistics", recommended: true },
+    { value: "user.info.profile", label: "Read extended profile information", recommended: true },
+    { value: "video.list", label: "Read published video metadata", recommended: true }
+  ],
+  permissionsHint: "Basic profile access is required for verification. Users can decline the other permissions during consent; the corresponding operations then stay unavailable.",
+  setup: { url: "https://developers.tiktok.com/docs/en/getting-started-create-an-app", steps: [
+    "Sign into TikTok for Developers. Open your profile menu, choose Manage apps, then Connect an app and select its owner.",
+    "Complete the app's basic information and Web platform settings. Add Login Kit and Display API in Products, then add the required permissions under Scopes.",
+    "In Login Kit, configure Web and register the backend's exact HTTPS redirect URI. It must be static, contain no query or fragment, and be shorter than 512 characters.",
+    "Copy Client key into this form. Store Client secret and the approved callback URL in the referenced backend Env variables; keep secrets out of browser and desktop bundles.",
+    "Use Sandbox with designated test users during development. Complete URL ownership and app review requirements before production access.",
+    "Saving only writes configuration. The application runtime performs consent, refresh and profile/video reads; posting, Research API and application login are separate work."
+  ] }
+});
+
+export { tiktokDefinition };