@cursor/bdk 0.2.14 → 0.2.16

package/dist/internal/convert-grokbot/bot.js

@@ -0,0 +1,72 @@
+/**
+ * The bot a recipe describes. Slugs are claimed here once, so questions,
+ * answers, and output paths all name items the same way. Names become one
+ * printable line and prose loses unprintable characters, so recipe text is
+ * safe to show in a terminal or a list.
+ */
+import { parseYamlFrontmatter } from "../frontmatter.js";
+import { isRecord } from "../is-record.js";
+import { SlugRegistry, slugify } from "../slug.js";
+import { plainText, singleLine } from "./checks.js";
+import { parseRoutineContent, routineFillIns, } from "./routine.js";
+/** List answers read these as keywords, so no item slug may take them. */
+const LIST_KEYWORDS = ["all", "none"];
+/** Connection file names a plugin slug may not take. */
+const RESERVED_CONNECTIONS = ["cursor", "account"];
+export function botFromRecipe(recipe, unknownFields = []) {
+    const skillSlugs = slugRegistry();
+    const skills = recipe.skills.map((skill) => {
+        const { data, body } = parseYamlFrontmatter(skill.content);
+        const trigger = isRecord(data.trigger) ? data.trigger : {};
+        const name = singleLine(skill.name);
+        return {
+            slug: skillSlugs.claim(slugify(name, "skill")),
+            name,
+            description: plainText(skill.description),
+            body: body.trim(),
+            triggers: typeof trigger.schedule === "string"
+                ? [{ kind: "cron", cron: trigger.schedule, paused: trigger.enabled === false }]
+                : [],
+        };
+    });
+    const routineSlugs = slugRegistry();
+    const routines = recipe.routines.map((routine) => {
+        const parsed = parseRoutineContent(routine.content);
+        return {
+            slug: routineSlugs.claim(slugify(routine.slug, "routine")),
+            name: singleLine(routine.name),
+            description: plainText(routine.description),
+            job: parsed.job,
+            triggers: parsed.triggers,
+            fillIns: routineFillIns([parsed.job, routine.description], parsed.askFor),
+        };
+    });
+    const start = recipe.gettingStarted === undefined ? undefined : singleLine(recipe.gettingStarted.skill);
+    return {
+        name: singleLine(recipe.profile.name),
+        description: plainText(recipe.profile.description),
+        avatar: recipe.profile.avatarColor === undefined && recipe.profile.avatarShape === undefined
+            ? undefined
+            : { color: recipe.profile.avatarColor, shape: recipe.profile.avatarShape },
+        skills,
+        routines,
+        plugins: pluginsFrom(recipe.plugins),
+        memory: recipe.memory,
+        gettingStarted: skills.find((skill) => skill.name === start)?.slug,
+        unknownFields,
+    };
+}
+function slugRegistry(reserved = []) {
+    const slugs = new SlugRegistry();
+    for (const slug of [...LIST_KEYWORDS, ...reserved]) {
+        slugs.claim(slug);
+    }
+    return slugs;
+}
+function pluginsFrom(plugins) {
+    const slugs = slugRegistry(RESERVED_CONNECTIONS);
+    return plugins.map((plugin) => {
+        const name = singleLine(plugin.name);
+        return { slug: slugs.claim(slugify(name, "connector")), name };
+    });
+}

package/dist/internal/convert-grokbot/checks.d.ts

@@ -0,0 +1,26 @@
+/** Validation for export answers that land in names, URLs, and review text. */
+export declare const SLACK_BOT_NAME_MAX = 80;
+/** Recipe text for a name or list item: one line, nothing unprintable. */
+export declare function singleLine(text: string): string;
+/** Recipe prose: line breaks and tabs kept, anything else unprintable dropped. */
+export declare function plainText(text: string): string;
+/** Text as a markdown code span, so it reads as data; a backtick would end the span. */
+export declare function code(text: string): string;
+/**
+ * A Slack bot name starts with the team prefix and never reads as "Grok",
+ * including through separators, accents, or look-alike letters.
+ */
+export declare function slackBotNameError(name: string, teamPrefix?: string): string | undefined;
+/** The recipe name under the team prefix, or `Bot` when that name cannot pass. */
+export declare function defaultSlackBotName(name: string, teamPrefix?: string): string;
+/** Remote MCP URL: https, with credentials kept out of it. */
+export declare function connectorUrlError(url: string): string | undefined;
+export declare function repoNameError(name: string): string | undefined;
+export declare function namespaceError(name: string): string | undefined;
+export declare function redactSecretValues(text: string): {
+    text: string;
+    redacted: number;
+};
+/** Every string in a JSON-shaped value, redacted. */
+export declare function redactDeep<T>(value: T): T;
+//# sourceMappingURL=checks.d.ts.map

package/dist/internal/convert-grokbot/checks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checks.d.ts","sourceRoot":"","sources":["../../../src/internal/convert-grokbot/checks.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAI/E,eAAO,MAAM,kBAAkB,KAAK,CAAC;AAMrC,0EAA0E;AAC1E,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED,kFAAkF;AAClF,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAI9C;AAED,wFAAwF;AACxF,wBAAgB,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEzC;AAmCD;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAmBvF;AAED,kFAAkF;AAClF,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAS7E;AA6BD,8DAA8D;AAC9D,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAoBjE;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAI9D;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAI/D;AAeD,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAOnF;AAED,qDAAqD;AACrD,wBAAgB,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAazC"}

package/dist/internal/convert-grokbot/checks.js

@@ -0,0 +1,170 @@
+/** Validation for export answers that land in names, URLs, and review text. */
+import { isRecord } from "../is-record.js";
+export const SLACK_BOT_NAME_MAX = 80;
+/** Control, line-separator, and bidi-override characters. */
+const UNPRINTABLE = /[\p{Cc}\u2028\u2029\u202A-\u202E\u2066-\u2069]/u;
+const UNPRINTABLE_RUNS = new RegExp(`${UNPRINTABLE.source}+`, "gu");
+/** Recipe text for a name or list item: one line, nothing unprintable. */
+export function singleLine(text) {
+    return text.replace(UNPRINTABLE_RUNS, " ").replace(/\s+/g, " ").trim();
+}
+/** Recipe prose: line breaks and tabs kept, anything else unprintable dropped. */
+export function plainText(text) {
+    return text
+        .replace(/\r\n?/g, "\n")
+        .replace(UNPRINTABLE_RUNS, (run) => run.replace(/[^\n\t]/g, ""));
+}
+/** Text as a markdown code span, so it reads as data; a backtick would end the span. */
+export function code(text) {
+    return `\`${singleLine(text).replaceAll("`", "'")}\``;
+}
+/** Characters that read as g, r, o, or k but survive NFKD. Keys are uppercase where a case exists. */
+const LOOKALIKES = {
+    "0": "o",
+    Ø: "o",
+    ɢ: "g",
+    Ɡ: "g",
+    ʀ: "r",
+    ᴏ: "o",
+    ᴑ: "o",
+    Ɵ: "o",
+    Ꝋ: "o",
+    ᴋ: "k",
+    ĸ: "k",
+    Օ: "o",
+    Ꮐ: "g",
+    Ꮢ: "r",
+    Ꮎ: "o",
+    Ꮶ: "k",
+};
+const LOOKALIKE_SCRIPTS = /[\p{Script=Cyrillic}\p{Script=Greek}\p{Script=Armenian}\p{Script=Cherokee}]/u;
+function plain(value) {
+    return value.trim().normalize("NFKD").replace(/\p{M}/gu, "");
+}
+function fold(value) {
+    return [...plain(value)]
+        .map((char) => LOOKALIKES[char] ?? LOOKALIKES[char.toUpperCase()] ?? char)
+        .join("")
+        .toLowerCase();
+}
+/**
+ * A Slack bot name starts with the team prefix and never reads as "Grok",
+ * including through separators, accents, or look-alike letters.
+ */
+export function slackBotNameError(name, teamPrefix) {
+    if ([...name.trim()].length > SLACK_BOT_NAME_MAX) {
+        return `must be at most ${SLACK_BOT_NAME_MAX} characters.`;
+    }
+    if (UNPRINTABLE.test(name)) {
+        return "must be one line of printable text.";
+    }
+    const folded = fold(name);
+    if (teamPrefix !== undefined && !folded.startsWith(fold(teamPrefix))) {
+        return `must start with the team prefix ${JSON.stringify(teamPrefix)}.`;
+    }
+    if (folded.replace(/[^\p{L}\p{N}]/gu, "").includes("grok")) {
+        return 'must not contain "Grok".';
+    }
+    const text = plain(name);
+    if (/\p{Script=Latin}/u.test(text) && LOOKALIKE_SCRIPTS.test(text)) {
+        return "must not mix Latin letters with look-alike letters from other scripts.";
+    }
+    return undefined;
+}
+/** The recipe name under the team prefix, or `Bot` when that name cannot pass. */
+export function defaultSlackBotName(name, teamPrefix) {
+    const prefix = teamPrefix?.trim() ?? "";
+    const prefixed = (base) => {
+        const joined = prefix === "" || /[\s\-_:·|/]$/.test(prefix) ? `${prefix}${base}` : `${prefix} ${base}`;
+        return [...joined].slice(0, SLACK_BOT_NAME_MAX).join("").trim();
+    };
+    const candidate = prefixed(name.replace(/grok/gi, " ").replace(/\s+/g, " ").trim() || "Bot");
+    return slackBotNameError(candidate, teamPrefix) === undefined ? candidate : prefixed("Bot");
+}
+const CREDENTIAL_WORDS = new Set([
+    "key",
+    "apikey",
+    "token",
+    "accesstoken",
+    "secret",
+    "password",
+    "passwd",
+    "pat",
+    "sig",
+    "signature",
+    "credential",
+    "credentials",
+    "auth",
+    "authorization",
+    "jwt",
+]);
+/** A parameter named for a credential, word by word (`x-api-key`, `accessToken`), or `code`. */
+function credentialParam(name) {
+    const words = name
+        .replace(/([a-z0-9])([A-Z])/g, "$1 $2")
+        .toLowerCase()
+        .split(/[^a-z0-9]+/);
+    return name.toLowerCase() === "code" || words.some((word) => CREDENTIAL_WORDS.has(word));
+}
+/** Remote MCP URL: https, with credentials kept out of it. */
+export function connectorUrlError(url) {
+    if (!URL.canParse(url)) {
+        return "must be an absolute URL.";
+    }
+    const parsed = new URL(url);
+    if (parsed.protocol !== "https:") {
+        return "must use https.";
+    }
+    if (parsed.username !== "" || parsed.password !== "") {
+        return "must not carry credentials; name a secret instead.";
+    }
+    const params = [
+        ...parsed.searchParams.keys(),
+        ...new URLSearchParams(parsed.hash.slice(1)).keys(),
+    ];
+    const leaked = params.find(credentialParam);
+    if (leaked !== undefined) {
+        return `must not carry credentials (parameter ${JSON.stringify(leaked)}); name a secret instead.`;
+    }
+    return undefined;
+}
+export function repoNameError(name) {
+    return /^[A-Za-z0-9._-]{1,100}$/.test(name) && name !== "." && name !== ".."
+        ? undefined
+        : "must be 1–100 letters, digits, '.', '_' or '-'.";
+}
+export function namespaceError(name) {
+    return /^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$/.test(name)
+        ? undefined
+        : "must start with a letter or digit and use letters, digits, '.', '_' or '-'.";
+}
+/** Token shapes that must not reach a committed file. */
+const SECRET_VALUE = new RegExp([
+    String.raw `\b(?:crsr_|xox[abeprs]-|xapp-|ghp_|gho_|ghu_|ghs_|github_pat_|glpat-|sk-(?:ant-|proj-)?|[sr]k_(?:live|test)_|lin_api_|ntn_|AIza)[A-Za-z0-9_-]{16,}`,
+    String.raw `\bxai-[A-Za-z0-9]{32,}`,
+    String.raw `\bgrok_[0-9A-Fa-f]{32}_[0-9A-Fa-f]{64}\b`,
+    String.raw `\bAKIA[0-9A-Z]{16}\b`,
+    String.raw `\beyJ[A-Za-z0-9_-]{10,}\.eyJ[A-Za-z0-9_-]{10,}\.[A-Za-z0-9_-]{10,}`,
+    String.raw `hooks\.slack\.com/services/[A-Za-z0-9/]+`,
+].join("|"), "g");
+export function redactSecretValues(text) {
+    let redacted = 0;
+    const next = text.replace(SECRET_VALUE, () => {
+        redacted++;
+        return "[redacted]";
+    });
+    return { text: next, redacted };
+}
+/** Every string in a JSON-shaped value, redacted. */
+export function redactDeep(value) {
+    if (typeof value === "string") {
+        return redactSecretValues(value).text;
+    }
+    if (Array.isArray(value)) {
+        return value.map(redactDeep);
+    }
+    if (isRecord(value)) {
+        return Object.fromEntries(Object.entries(value).map(([key, nested]) => [key, redactDeep(nested)]));
+    }
+    return value;
+}

package/dist/internal/convert-grokbot/convert.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Pure Grok Bot → BDK project mapping. Takes the recipe's bot and resolved
+ * answers; returns the project files as an in-memory tree plus a preview a
+ * client renders before confirming. No I/O and no clock: `generatedAt`
+ * comes from the caller.
+ */
+import { type ProjectRoot } from "../project-layout.js";
+import type { Resolved } from "./answers.js";
+import type { Bot } from "./bot.js";
+export declare const EXPORT_RECORD_VERSION = 1;
+export declare const PREVIEW_VERSION = 1;
+export interface ConvertGrokbotInput {
+    bot: Bot;
+    resolved: Resolved;
+    /** ISO 8601 timestamp for the export record. */
+    generatedAt: string;
+    packageVersion: string;
+    /** Basename of the target directory; `bdk slack create` derives the env prefix from it. */
+    directoryName?: string;
+    projectRoot?: ProjectRoot;
+}
+export interface ConvertedFile {
+    path: string;
+    contents: string;
+}
+/** A recipe item, answer, or scaffold step: `skills/<slug>`, `routines/<slug>`, `profile`, ... */
+export type Source = string;
+export interface PreviewFillIn {
+    routine: string;
+    id: string;
+    label: string;
+    value?: string;
+}
+export interface GrokbotPreview extends Resolved {
+    version: number;
+    name: string;
+    files: Array<{
+        path: string;
+        from: Source[];
+    }>;
+    /** Recipe items the answers left out. */
+    excluded: Source[];
+    unmapped: Array<{
+        from: Source;
+        reason: string;
+    }>;
+    fillIns: PreviewFillIn[];
+    secrets: {
+        names: string[];
+        reauth: string[];
+    };
+    warnings: string[];
+    setupSteps: string[];
+}
+export interface GrokbotConversion {
+    files: ConvertedFile[];
+    preview: GrokbotPreview;
+}
+export declare function convertGrokbot(input: ConvertGrokbotInput): GrokbotConversion;
+//# sourceMappingURL=convert.d.ts.map

package/dist/internal/convert-grokbot/convert.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert.d.ts","sourceRoot":"","sources":["../../../src/internal/convert-grokbot/convert.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAqBH,OAAO,EAAuC,KAAK,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAE7F,OAAO,KAAK,EAEV,QAAQ,EAIT,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,GAAG,EAAoC,MAAM,UAAU,CAAC;AAmBtE,eAAO,MAAM,qBAAqB,IAAI,CAAC;AACvC,eAAO,MAAM,eAAe,IAAI,CAAC;AAEjC,MAAM,WAAW,mBAAmB;IAClC,GAAG,EAAE,GAAG,CAAC;IACT,QAAQ,EAAE,QAAQ,CAAC;IACnB,gDAAgD;IAChD,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,2FAA2F;IAC3F,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,kGAAkG;AAClG,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC;AAE5B,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,cAAe,SAAQ,QAAQ;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAC;IAC/C,yCAAyC;IACzC,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAClD,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAC/C,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,OAAO,EAAE,cAAc,CAAC;CACzB;AAeD,wBAAgB,cAAc,CAAC,KAAK,EAAE,mBAAmB,GAAG,iBAAiB,CAqG5E"}