@tightknitai/slack-block-kit-validator 0.1.0-alpha.0

package/dist/helpers/check-surface-compatibility.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"check-surface-compatibility.d.ts","sourceRoot":"","sources":["../../src/helpers/check-surface-compatibility.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,CAAC;AAyDnD;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,SAAS;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,EAAE,EACjE,OAAO,EAAE,OAAO,GACf,MAAM,EAAE,CAsBV"}

package/dist/helpers/check-surface-compatibility.js

@@ -0,0 +1,81 @@
+// Source of truth: https://docs.slack.dev/blocks.json — the canonical JSON
+// that powers the "Surfaces" column on each block's reference page. Every
+// block entry there has an `available-in-surfaces` array valued with some
+// subset of ["Modals", "Messages", "Home tabs"]. Whatever's missing from
+// that array is what we forbid here.
+// `file` is only produced by Slack when retrieving messages that contain
+// remote files; apps cannot send it outbound on any surface
+// (https://docs.slack.dev/reference/block-kit/blocks/file-block:
+// "You can't add this block to app surfaces directly...").
+const BLOCKS_NOT_ALLOWED_IN_MESSAGE = new Set(["alert", "file"]);
+// carousel/card are listed as modal-available in Slack's blocks.json but
+// empirically fail to render inside modal views — confirmed by the PR author
+// against the live API. They work in messages and home tabs.
+const BLOCKS_NOT_ALLOWED_IN_MODAL = new Set([
+    "card",
+    "carousel",
+    "context_actions",
+    "file",
+    "markdown",
+    "plan",
+    "table",
+    "task_card",
+]);
+const BLOCKS_NOT_ALLOWED_IN_HOME = new Set([
+    "alert",
+    "context_actions",
+    "file",
+    "markdown",
+    "plan",
+    "table",
+    "task_card",
+]);
+const FORBIDDEN_BY_SURFACE = {
+    message: BLOCKS_NOT_ALLOWED_IN_MESSAGE,
+    modal: BLOCKS_NOT_ALLOWED_IN_MODAL,
+    home: BLOCKS_NOT_ALLOWED_IN_HOME,
+};
+/**
+ * Per-surface block-count caps. Per
+ * https://docs.slack.dev/reference/block-kit/blocks:
+ * "You can include up to 50 blocks in each message, and 100 blocks in modals
+ * or Home tabs." The top-level schema enforces the looser 100 cap
+ * unconditionally so that modal/home payloads validate; the stricter message
+ * cap is applied here once the surface is known.
+ */
+const MAX_BLOCKS_BY_SURFACE = {
+    message: 50,
+    modal: 100,
+    home: 100,
+};
+/**
+ * Reports any blocks whose type is not allowed on the given surface. Slack's
+ * surface compatibility matrix is documented at
+ * https://docs.slack.dev/surfaces/. Element-level restrictions (e.g. `file_input`
+ * only valid in modals) are checked here by looking at each input block's inner
+ * `element.type`.
+ * @param blocks - array of Block Kit blocks
+ * @param surface - target surface
+ * @returns array of error messages (empty when all blocks are surface-compatible)
+ */
+export function checkSurfaceCompatibility(blocks, surface) {
+    const forbidden = FORBIDDEN_BY_SURFACE[surface];
+    const errors = [];
+    const maxBlocks = MAX_BLOCKS_BY_SURFACE[surface];
+    if (blocks.length > maxBlocks) {
+        errors.push(`surface '${surface}' allows at most ${maxBlocks} blocks (got ${blocks.length})`);
+    }
+    blocks.forEach((block, i) => {
+        if (block?.type && forbidden.has(block.type)) {
+            errors.push(`blocks[${i}].type '${block.type}' is not allowed on surface '${surface}'`);
+            // Block itself is already rejected — element-level errors would be
+            // redundant noise for the same misuse.
+            return;
+        }
+        if (block?.type === "input" && block.element?.type === "file_input" && surface !== "modal") {
+            errors.push(`blocks[${i}].element.type 'file_input' is only allowed in modal surfaces (got '${surface}')`);
+        }
+    });
+    return errors;
+}
+//# sourceMappingURL=check-surface-compatibility.js.map

package/dist/helpers/check-surface-compatibility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"check-surface-compatibility.js","sourceRoot":"","sources":["../../src/helpers/check-surface-compatibility.ts"],"names":[],"mappings":"AAMA,2EAA2E;AAC3E,0EAA0E;AAC1E,0EAA0E;AAC1E,yEAAyE;AACzE,qCAAqC;AACrC,yEAAyE;AACzE,4DAA4D;AAC5D,iEAAiE;AACjE,2DAA2D;AAC3D,MAAM,6BAA6B,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AAEjE,yEAAyE;AACzE,6EAA6E;AAC7E,6DAA6D;AAC7D,MAAM,2BAA2B,GAAG,IAAI,GAAG,CAAC;IAC1C,MAAM;IACN,UAAU;IACV,iBAAiB;IACjB,MAAM;IACN,UAAU;IACV,MAAM;IACN,OAAO;IACP,WAAW;CACZ,CAAC,CAAC;AAEH,MAAM,0BAA0B,GAAG,IAAI,GAAG,CAAC;IACzC,OAAO;IACP,iBAAiB;IACjB,MAAM;IACN,UAAU;IACV,MAAM;IACN,OAAO;IACP,WAAW;CACZ,CAAC,CAAC;AAEH,MAAM,oBAAoB,GAAiC;IACzD,OAAO,EAAE,6BAA6B;IACtC,KAAK,EAAE,2BAA2B;IAClC,IAAI,EAAE,0BAA0B;CACjC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,qBAAqB,GAA4B;IACrD,OAAO,EAAE,EAAE;IACX,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,GAAG;CACV,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,UAAU,yBAAyB,CACvC,MAAiE,EACjE,OAAgB;IAEhB,MAAM,SAAS,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAChD,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,MAAM,SAAS,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;IACjD,IAAI,MAAM,CAAC,MAAM,GAAG,SAAS,EAAE,CAAC;QAC9B,MAAM,CAAC,IAAI,CAAC,YAAY,OAAO,oBAAoB,SAAS,gBAAgB,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IAChG,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;QAC1B,IAAI,KAAK,EAAE,IAAI,IAAI,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7C,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,KAAK,CAAC,IAAI,gCAAgC,OAAO,GAAG,CAAC,CAAC;YACxF,mEAAmE;YACnE,uCAAuC;YACvC,OAAO;QACT,CAAC;QACD,IAAI,KAAK,EAAE,IAAI,KAAK,OAAO,IAAI,KAAK,CAAC,OAAO,EAAE,IAAI,KAAK,YAAY,IAAI,OAAO,KAAK,OAAO,EAAE,CAAC;YAC3F,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,uEAAuE,OAAO,IAAI,CAAC,CAAC;QAC7G,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/helpers/find-duplicate-block-ids.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Returns error messages describing any duplicate `block_id` values across the
+ * given blocks array. Pairs with the JSON Schema (draft 2020-12) in this
+ * package — JSON Schema can't express per-property uniqueness across items, so
+ * this check sits alongside structural validation.
+ *
+ * Skips `markdown` blocks: Slack drops their `block_id` on send ("The block_id
+ * is ignored in markdown blocks and will not be retained" per docs), so
+ * duplicates involving markdown blocks are false positives from Slack's POV.
+ * @param blocks - array of Block Kit blocks (or anything with an optional `block_id`)
+ * @returns array of human-readable error messages (empty when no duplicates)
+ */
+export declare function findDuplicateBlockIds(blocks: readonly {
+    type?: string;
+    block_id?: string;
+}[]): string[];
+//# sourceMappingURL=find-duplicate-block-ids.d.ts.map

package/dist/helpers/find-duplicate-block-ids.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"find-duplicate-block-ids.d.ts","sourceRoot":"","sources":["../../src/helpers/find-duplicate-block-ids.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,SAAS;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,EAAE,GAAG,MAAM,EAAE,CAgBvG"}

package/dist/helpers/find-duplicate-block-ids.js

@@ -0,0 +1,31 @@
+/**
+ * Returns error messages describing any duplicate `block_id` values across the
+ * given blocks array. Pairs with the JSON Schema (draft 2020-12) in this
+ * package — JSON Schema can't express per-property uniqueness across items, so
+ * this check sits alongside structural validation.
+ *
+ * Skips `markdown` blocks: Slack drops their `block_id` on send ("The block_id
+ * is ignored in markdown blocks and will not be retained" per docs), so
+ * duplicates involving markdown blocks are false positives from Slack's POV.
+ * @param blocks - array of Block Kit blocks (or anything with an optional `block_id`)
+ * @returns array of human-readable error messages (empty when no duplicates)
+ */
+export function findDuplicateBlockIds(blocks) {
+    const seen = new Map();
+    const errors = [];
+    blocks.forEach((block, i) => {
+        const id = block?.block_id;
+        if (id == null || block?.type === "markdown") {
+            return;
+        }
+        const prev = seen.get(id);
+        if (prev !== undefined) {
+            errors.push(`blocks[${i}].block_id must be unique — '${id}' appears at index ${prev} and ${i}`);
+        }
+        else {
+            seen.set(id, i);
+        }
+    });
+    return errors;
+}
+//# sourceMappingURL=find-duplicate-block-ids.js.map

package/dist/helpers/find-duplicate-block-ids.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"find-duplicate-block-ids.js","sourceRoot":"","sources":["../../src/helpers/find-duplicate-block-ids.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,qBAAqB,CAAC,MAAuD;IAC3F,MAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IACvC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;QAC1B,MAAM,EAAE,GAAG,KAAK,EAAE,QAAQ,CAAC;QAC3B,IAAI,EAAE,IAAI,IAAI,IAAI,KAAK,EAAE,IAAI,KAAK,UAAU,EAAE,CAAC;YAC7C,OAAO;QACT,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC1B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,gCAAgC,EAAE,sBAAsB,IAAI,QAAQ,CAAC,EAAE,CAAC,CAAC;QAClG,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./helpers/check-card-actions-max";
+export * from "./helpers/check-cumulative-markdown-length";
+export * from "./helpers/check-focus-on-load-uniqueness";
+export * from "./helpers/check-number-input-bounds";
+export * from "./helpers/check-response-url-enabled-context";
+export * from "./helpers/check-single-table-block";
+export * from "./helpers/check-surface-compatibility";
+export * from "./helpers/find-duplicate-block-ids";
+export { default as slackBlockKitSchema } from "./slack-block-kit.schema.json";
+export * from "./validate-block-kit";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAC;AACjD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,0CAA0C,CAAC;AACzD,cAAc,qCAAqC,CAAC;AACpD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,oCAAoC,CAAC;AACnD,cAAc,uCAAuC,CAAC;AACtD,cAAc,oCAAoC,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAC/E,cAAc,sBAAsB,CAAC"}

package/dist/index.js

@@ -0,0 +1,11 @@
+export * from "./helpers/check-card-actions-max";
+export * from "./helpers/check-cumulative-markdown-length";
+export * from "./helpers/check-focus-on-load-uniqueness";
+export * from "./helpers/check-number-input-bounds";
+export * from "./helpers/check-response-url-enabled-context";
+export * from "./helpers/check-single-table-block";
+export * from "./helpers/check-surface-compatibility";
+export * from "./helpers/find-duplicate-block-ids";
+export { default as slackBlockKitSchema } from "./slack-block-kit.schema.json";
+export * from "./validate-block-kit";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAC;AACjD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,0CAA0C,CAAC;AACzD,cAAc,qCAAqC,CAAC;AACpD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,oCAAoC,CAAC;AACnD,cAAc,uCAAuC,CAAC;AACtD,cAAc,oCAAoC,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAC/E,cAAc,sBAAsB,CAAC"}