Skip to content

feat(skills): ship a consumer skill with the package - #4

Merged
Upd4ting merged 3 commits into
mainfrom
feat/package-shipped-skill
Jul 20, 2026
Merged

feat(skills): ship a consumer skill with the package#4
Upd4ting merged 3 commits into
mainfrom
feat/package-shipped-skill

Conversation

@Upd4ting

@Upd4ting Upd4ting commented Jul 19, 2026

Copy link
Copy Markdown
Member

Summary

  • Adds skills/<name>-interface/SKILL.md: a lean, source-grounded consumer guide (imports per subpath, minimal example, gotchas, pointer to the shipped .d.ts)
  • Wires it for distribution: antelopeJs.skills: ["./skills"] + skills in the files array
  • Consumers get it automatically: the antelopejs Claude Code plugin syncs package-shipped skills into .claude/skills/; the cms-ai chatbox loads them at runtime
  • Content fact-checked against src//docs/ by an adversarial review pass (imports validated against the exports map, examples verified against real signatures)

Test plan

N/A (documentation artifact; frontmatter and import paths validated mechanically)

Greptile Summary

This PR ships a consumer-facing skill document for @antelopejs/interface-auth and wires it for distribution by extending the files array and adding a skills key to the antelopeJs config in package.json. The SKILL.md content was verified against the actual source (header/cookie names, export paths, decorator dispatch model all match).

  • package.json: adds docs and skills to the npm files list — docs was previously unpublished, so this increases the installed footprint. The antelopeJs.skills field points to ./skills so the AntelopeJS plugin can sync the guide automatically.
  • skills/auth-interface/SKILL.md: new skill guide covering imports, a consuming example, a provider boilerplate, and a gotchas section; import paths and decorator behavior align with src/index.ts.

Confidence Score: 5/5

Safe to merge — purely additive documentation and packaging changes with no logic modifications.

The change adds a skill guide and updates the npm files list. No runtime code is touched. The SKILL.md claims (header/cookie names, export shape, decorator dispatch) were verified against src/index.ts and all match.

No files require special attention.

Important Files Changed

Filename Overview
package.json Adds docs and skills to the npm files array and registers ./skills under antelopeJs.skills; both additions are intentional and consistent with the PR goals.
skills/auth-interface/SKILL.md New consumer skill guide; key claims (header name x-antelopejs-auth, cookie name ANTELOPEJS_AUTH, single root export, decorator dispatch) all verified against src/index.ts.

Sequence Diagram

%%{init: {'theme': 'neutral'}}%%
sequenceDiagram
    participant Consumer as Consumer Module
    participant AntelopePlugin as AntelopeJS Plugin
    participant NPM as npm registry
    participant Claude as Claude Code / cms-ai

    Consumer->>NPM: "npm install @antelopejs/interface-auth"
    NPM-->>Consumer: dist/ + docs/ + skills/
    AntelopePlugin->>Consumer: sync skills/auth-interface/SKILL.md
    AntelopePlugin-->>Claude: .claude/skills/auth-interface/SKILL.md

    Note over Claude: Skill loaded at runtime

    Consumer->>Consumer: "import { Authentication, SignRaw } from "@antelopejs/interface-auth""
    Consumer->>Consumer: "@Authentication() injects verified payload"
    Consumer->>Consumer: SignRaw(payload, options) → proxy → auth provider → token
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
sequenceDiagram
    participant Consumer as Consumer Module
    participant AntelopePlugin as AntelopeJS Plugin
    participant NPM as npm registry
    participant Claude as Claude Code / cms-ai

    Consumer->>NPM: "npm install @antelopejs/interface-auth"
    NPM-->>Consumer: dist/ + docs/ + skills/
    AntelopePlugin->>Consumer: sync skills/auth-interface/SKILL.md
    AntelopePlugin-->>Claude: .claude/skills/auth-interface/SKILL.md

    Note over Claude: Skill loaded at runtime

    Consumer->>Consumer: "import { Authentication, SignRaw } from "@antelopejs/interface-auth""
    Consumer->>Consumer: "@Authentication() injects verified payload"
    Consumer->>Consumer: SignRaw(payload, options) → proxy → auth provider → token
Loading

Reviews (5): Last reviewed commit: "docs(skills): use fictional domains in c..." | Re-trigger Greptile

Add skills/<name>-interface/SKILL.md — a lean, source-grounded guide for
agents consuming this interface (imports, minimal example, gotchas) —
declared via antelopeJs.skills and published through the files array.
Consumers receive it automatically: the antelopejs Claude Code plugin
syncs package-shipped skills into a project's .claude/skills/, and the
cms-ai chatbox loads them at runtime.

Content was fact-checked against src/ and docs/ by an adversarial
review pass (imports validated against the exports map, examples
verified against real signatures).
Comment thread skills/auth-interface/SKILL.md Outdated
@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

1 similar comment
@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

…otcha

Queuing only holds while a provider module is loaded but not yet attached; when no loaded module provides the interface (stubbed optional dependency), the core neutralizes the async proxies and calls reject.
@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting
Upd4ting merged commit 2fd479c into main Jul 20, 2026
3 checks passed
@Upd4ting
Upd4ting deleted the feat/package-shipped-skill branch July 20, 2026 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant