spearkit 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -0
- package/dist/index.cjs +1767 -228
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1223 -361
- package/dist/index.d.ts +1223 -361
- package/dist/index.js +1726 -233
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -22,6 +22,15 @@ npm install spearkit discord.js
|
|
|
22
22
|
- **Usage tracking** — record who used what to a database and/or a Discord channel ([guide](./docs/usage.md)).
|
|
23
23
|
- **dotenv built in** — auto-load `.env` and read typed env vars ([guide](./docs/env.md)).
|
|
24
24
|
- **Plugins & file-based loading** for organising larger bots.
|
|
25
|
+
- **Guards** — declarative `requireAnyRole`/`requireUserPermissions`/`guildOnly`/`requireOwner` preconditions on commands, components and prefix commands ([API ref](./docs/api-reference.md#guards--declarative-preconditions)).
|
|
26
|
+
- **Context-menu commands** — `userCommand` / `messageCommand` with typed `targetUser` / `targetMessage` ([API ref](./docs/api-reference.md#context-menu-commands)).
|
|
27
|
+
- **Preset embeds** — `ctx.success/info/warn/error` and `client.embeds` factory with configurable colors/icons ([API ref](./docs/api-reference.md#embeds--preset-replies)).
|
|
28
|
+
- **Pagination & confirmation** — `paginate(...)` and `confirm(...)` button flows with user-only filter and timeout.
|
|
29
|
+
- **Typed prefix args** — `prefixCommand({ args: a => a.snowflake("target").duration("d").rest("reason"), run: ctx => ctx.options })`.
|
|
30
|
+
- **Primitives** — `KeyedLock`, `safeFetch.{member,channel,...}`, `formatDuration`/`parseDuration`/`discordTimestamp`, `MemoryCache` (TTL + counters + rate limit), `loadConfig` (JSON/JSON5/YAML).
|
|
31
|
+
- **Logger transports** — multi-sink (`consoleSink`, `jsonlSink`, `webhookSink`); per-level routing.
|
|
32
|
+
- **Scheduler extras** — `scheduler.delay/followUp/reconcile` for one-shot jobs and on-ready recovery.
|
|
33
|
+
- **Deploy strategy** — `deployAllCommands({ dryRun, strategy: "diff" })` for safe CI deploys.
|
|
25
34
|
|
|
26
35
|
## Documentation
|
|
27
36
|
|