Skip to content

feat: add web api methods chat.postMessage and blocks.validate with example placeholders - #138

Draft
zimeg wants to merge 18 commits into
mainfrom
methods-examples
Draft

feat: add web api methods chat.postMessage and blocks.validate with example placeholders#138
zimeg wants to merge 18 commits into
mainfrom
methods-examples

Conversation

@zimeg

@zimeg zimeg commented Jul 14, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Summary

This PR adds methods to examples with placeholder values for arguments in hopes of quick copies and paste. For now two methods are added:

  • blocks.validate
  • chat.postMessage

These are separated as method "families" for: blocks or chat or conversations and such. All methods share project files such as linting and dependencies. App specific files existing within each of the method families for a separate app manifest scope definition. Unit tests stub "fetch" exist aside each method - this requires the RC now available as "@v8".

Notes

Super open to opinion on the following uncertain ideas:

  • Is "chat-post-message.js" format ideal for these methods? The requests of @slack/web-api are grouped in families and responses use capital casing.
  • Does testing HTTP request values seem excessive? IMHO it's nice confirmation of the packaging of the SDK exports! Extending this to adjacent runtimes might challenge this.

zimeg and others added 13 commits July 13, 2026 17:00
@zimeg Claude
feat(methods): Scaffold methods example set tooling
6b268d7 
Add shared package.json (ESM, @slack/web-api v8 RC, lint/check/test
scripts), biome.json, .gitignore, and an index README for the new
methods/ example set.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg Claude
feat(methods): Add chat.postMessage example
93125a7 
Add a runnable chat.postMessage example, a fetch-stub test asserting the
exact request URL and body, and a chat family README documenting the
required chat:write scope.

Also add methods/tsconfig.json (enables checkJs with include globs) and
fix the check script to run `tsc -p tsconfig.json`, since npm does not
expand the previous inline `**` globs and left type-checking inert.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg Claude
chore(methods): list methods example set in README and CI
2ccd69e 
Add the methods/ example set to the repo README's demonstrations list
and to the JS examples CI matrix so it is linted, type-checked, and tested
on every push.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg Claude
feat(methods): add blocks.validate example
91424a7 
Adds a new blocks/ family with a blocks.validate example using
client.apiCall since blocks.validate is not yet a typed method
in @slack/web-api@8.0.0-rc.2. Includes the implementation,
a fetch-stub test, and a README.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg Claude
docs(methods): list blocks family in methods index
e4c5979 
Add the blocks.validate example to the methods/ index README so the new
blocks family is discoverable alongside chat.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg Claude
refactor(methods): remove comments from method tests
c56d618 
Strip the explanatory comments from the chat.postMessage and
blocks.validate fetch-stub tests; the assertions are self-explanatory.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg Claude
refactor(methods): shorten test name and expand blocks JSON
6ef31bd 
Rename the it() case to "sends" (the describe already names the method),
and format the blocks.validate payload multi-line for readability.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg Claude
refactor(methods): inline expected params and drop assert messages
f2da9c4 
Inline the expected blocks payload directly into the deepStrictEqual, and
remove the assert.ok description string in both method tests.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg Claude
refactor(methods): inline params assert and move init guard
76f91d8 
Move assert.ok(init) to just before the body assertion and inline the
URLSearchParams decode directly into deepStrictEqual in both method tests.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg Claude
style(methods): remove blank lines between test assertions
b12e26f 
Tighten the assertion block in both method tests.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg Claude
docs(methods): align READMEs with block-kit and ai format
3e7a6c3 
Rework the methods index and family READMEs to match the house style used
by block-kit and ai: matching one-line description, a "Read the docs" link,
a "What's on display" bullet list with [Implementation] links, and a
"Running an example" section instead of the ad hoc scopes tables.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg Claude
refactor(methods): inline blocks payload in blocks.validate example
7f42349 
Pass the blocks payload directly into apiCall, matching the inline style of
the chat.postMessage example, instead of a separate const.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg Claude
refactor(methods): drop apiCall note comment from blocks example
1817f5e 
Remove the inline comment explaining the apiCall escape hatch; the blocks
README already covers why blocks.validate uses client.apiCall.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg zimeg self-assigned this Jul 14, 2026
@zimeg zimeg added the enhancement New feature or request label Jul 14, 2026
@zimeg zimeg changed the title feat: add methods example set with chat.postMessage feat: add web api methods chat.postMessage and blocks.validate with example placeholders Jul 14, 2026
@zimeg zimeg mentioned this pull request Jul 14, 2026
Draft
zimeg and others added 5 commits July 14, 2026 22:26
@zimeg Claude
chore(methods): pin @slack/web-api to stable ^8.0.0
40ec202 
@slack/web-api v8 is now GA; move off the 8.0.0-rc.2 release candidate to
the stable ^8.0.0 range, matching the caret style used by block-kit.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg Claude
feat(methods): add per-family manifests; align README copy
441f58a 
Add a per-family manifest.json to each method family requesting only that
family's scopes (chat -> chat:write; blocks -> none), delivering the
"no god apps" goal as runnable app config. Move scope documentation out of
the README bullets into the manifest, and use the methods' exact docs
descriptions.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg Claude
feat(methods): make each family a scoped Slack CLI app
79a7f02 
Turn each method family into a self-contained Slack CLI app: add
@slack/cli-hooks, a per-family .slack/ workspace (config + hooks, with
local state gitignored), and a manifest.json requesting only that family's
scopes (chat -> chat:write; blocks -> none). This delivers the
"no god apps" goal as runnable, minimally-scoped app config. READMEs use
the methods' exact docs descriptions and document the `slack install`
flow.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg Claude
chore(methods): bump cli-hooks to ^2.0.0; enable skipLibCheck
69801cb 
Move @slack/cli-hooks to the stable ^2.0.0 (the get-hooks bin is unchanged,
so .slack/hooks.json still works). Set skipLibCheck: false so tsc fully
type-checks the SDK's declarations too — verified the @slack/web-api v8 and
@types/node types pass cleanly.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg Claude
chore(methods): drop explicit skipLibCheck (use default)
b7615ff 
Remove the skipLibCheck option entirely; it defaults to false, so tsc fully
type-checks library declarations — matching block-kit (which sets no
tsconfig and relies on the same default). The example type-checks against
the real SDK declarations, which matters for trustworthy documentation.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@zimeg zimeg

Labels

enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@zimeg