Skip to content

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

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

feat(skills): ship a consumer skill with the package#5
Upd4ting merged 4 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 (skills/stripe-interface/SKILL.md) alongside packaging updates that include docs and skills directories in the npm bundle and register the skills directory via antelopeJs.skills. The SKILL.md content was verified against src/index.ts and all function signatures, parameter descriptions, and behavioral gotchas are accurate.

  • skills/stripe-interface/SKILL.md: New skill file covering imports, usage examples for all six exported functions, and a detailed gotchas section — all verified against the actual implementation.
  • package.json: Adds docs and skills to the files array (both directories exist) and registers "./skills" under antelopeJs.skills for automatic syncing by the AntelopeJS Claude Code plugin.

Confidence Score: 5/5

Safe to merge — this is a documentation and packaging-only change with no runtime code modifications.

All function signatures, parameter types, behavioral descriptions, and gotchas in SKILL.md were verified against src/index.ts and match the implementation exactly. The WatchAllPayments example correctly addresses the prior review feedback by splitting into two clearly labelled, mutually exclusive alternatives. Both docs/ and skills/ directories exist in the repo, so adding them to the npm files array is sound. No logic changes were made.

No files require special attention.

Important Files Changed

Filename Overview
skills/stripe-interface/SKILL.md New consumer skill guide; all imports, function signatures, and behavioral claims verified against src/index.ts; WatchAllPayments example correctly shows two mutually exclusive alternatives addressing prior review feedback.
package.json Adds existing docs/ and new skills/ directories to npm files array and registers the skills path under antelopeJs config; both directories confirmed to exist in the repo.

Sequence Diagram

%%{init: {'theme': 'neutral'}}%%
sequenceDiagram
    participant Consumer
    participant Interface as @antelopejs/interface-stripe
    participant Provider as Stripe Provider Module
    participant Stripe as Stripe API

    Provider->>Interface: SetClient(stripeInstance)
    Note over Interface: internal.client resolves

    Consumer->>Interface: InitializePayment(id, params)
    Interface->>Stripe: paymentIntents.create(params)
    Stripe-->>Interface: PaymentIntent
    Interface-->>Consumer: PaymentIntent

    Consumer->>Interface: WaitForPayment(intentId)
    Interface->>Stripe: paymentIntents.retrieve(intentId)
    Stripe-->>Interface: PaymentIntent (status check)

    Provider->>Interface: intentChanges.emit(intent, context)
    Note over Interface: Dispatches to WatchAllPayments,<br/>WatchPayment, WaitForPayment listeners

    Interface-->>Consumer: "resolved PaymentIntent (succeeded)<br/>or throws cancellation_reason (canceled)"
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
    participant Interface as @antelopejs/interface-stripe
    participant Provider as Stripe Provider Module
    participant Stripe as Stripe API

    Provider->>Interface: SetClient(stripeInstance)
    Note over Interface: internal.client resolves

    Consumer->>Interface: InitializePayment(id, params)
    Interface->>Stripe: paymentIntents.create(params)
    Stripe-->>Interface: PaymentIntent
    Interface-->>Consumer: PaymentIntent

    Consumer->>Interface: WaitForPayment(intentId)
    Interface->>Stripe: paymentIntents.retrieve(intentId)
    Stripe-->>Interface: PaymentIntent (status check)

    Provider->>Interface: intentChanges.emit(intent, context)
    Note over Interface: Dispatches to WatchAllPayments,<br/>WatchPayment, WaitForPayment listeners

    Interface-->>Consumer: "resolved PaymentIntent (succeeded)<br/>or throws cancellation_reason (canceled)"
Loading

Reviews (6): Last reviewed commit: "docs(skills): use fictional domain value..." | 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/stripe-interface/SKILL.md Outdated
@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

2 similar comments
@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting
Upd4ting merged commit 9a2375b into main Jul 20, 2026
2 checks passed
@Upd4ting
Upd4ting deleted the feat/package-shipped-skill branch July 20, 2026 19:50
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