spearkit 0.1.0

package/LICENSE

@@ -0,0 +1,92 @@
+Copyright (c) 2026 byigitt
+
+spearkit is licensed under the PolyForm Noncommercial License 1.0.0.
+
+In plain terms: you may use, copy, modify, and distribute spearkit FREE OF
+CHARGE for any noncommercial purpose — personal projects, learning, research,
+experimentation, and use by nonprofit/educational/government organizations.
+
+You may NOT use spearkit for a commercial purpose. In particular, you may not
+use it in software, products, or projects that you sell, that are built for
+commercial advantage, or that are intended to generate monetary compensation,
+without obtaining a separate commercial license from the author.
+
+For a commercial license, contact the author via https://github.com/byigitt.
+
+Required Notice: Copyright (c) 2026 byigitt (https://github.com/byigitt)
+
+--------------------------------------------------------------------------------
+
+# PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose.  However, you may only distribute the software according to [Distribution License](#distribution-license) and make changes or new works based on the software according to [Changes and New Works License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software.  Your license to distribute covers distributing the software with changes and new works permitted by [Changes and New Works License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution is use for a permitted purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization.  **Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.

package/README.md

@@ -0,0 +1,228 @@
+# spearkit
+
+**discord.js++** — a developer-experience-first layer over [discord.js](https://discord.js.org).
+
+spearkit re-exports the entire discord.js surface (so it's a drop-in replacement) and
+adds an ergonomic, **fully type-safe** API for the things that are tedious in raw
+discord.js: setting up events, defining slash commands, and wiring interactive
+components. No `any`, no `unknown` leaking into your handlers — option values,
+custom-id params and modal fields are all inferred.
+
+```bash
+npm install spearkit discord.js
+```
+
+## Documentation
+
+- **Docs site** ([`website/`](./website)) — a [Fumadocs](https://fumadocs.dev) site themed like the discord.js docs. Run it with `cd website && pnpm install && pnpm dev`.
+- **Guides & API reference** ([`docs/`](./docs)) — the Markdown the site is built from.
+- **Examples** ([`examples/`](./examples)) — one folder per topic (commands, options, components, events, loading, …).
+
+## Quick start
+
+```ts
+import { SpearClient, Intents, command, option, event } from "spearkit";
+
+const client = new SpearClient({ intents: Intents.default });
+
+const ping = command({
+  name: "ping",
+  description: "Check latency",
+  run: (ctx) => ctx.reply(`Pong! ${ctx.client.ws.ping}ms`),
+});
+
+const ready = event("clientReady", (c) => console.log(`Online as ${c.user.tag}`));
+
+client.register(ping, ready);
+await client.start(process.env.DISCORD_TOKEN);
+await client.deployCommands({ guildId: "YOUR_GUILD_ID" }); // instant in one guild
+```
+
+## Slash commands with inferred options
+
+Option values are typed from your declaration. Required options are non-nullable;
+optional ones are `T | undefined`; `choices` narrow to a literal union.
+
+```ts
+import { command, option } from "spearkit";
+
+export default command({
+  name: "echo",
+  description: "Repeat a message",
+  options: {
+    text: option.string({ description: "What to say", required: true }),
+    times: option.integer({ description: "Repeat count", minValue: 1, maxValue: 5 }),
+    visibility: option.string({
+      description: "Who sees it",
+      choices: [
+        { name: "Everyone", value: "public" },
+        { name: "Just me", value: "private" },
+      ],
+    }),
+  },
+  run: (ctx) => {
+    ctx.options.text;       // string
+    ctx.options.times;      // number | undefined
+    ctx.options.visibility; // "public" | "private" | undefined
+    return ctx.reply({
+      content: ctx.options.text.repeat(ctx.options.times ?? 1),
+      ephemeral: ctx.options.visibility === "private",
+    });
+  },
+});
+```
+
+Builders: `string`, `integer`, `number`, `boolean`, `user`, `channel`, `role`,
+`mentionable`, `attachment`.
+
+### Autocomplete
+
+Co-locate the suggestion provider with the option:
+
+```ts
+option.string({
+  description: "Fruit",
+  required: true,
+  autocomplete: (ctx) =>
+    fruits.filter((f) => f.startsWith(ctx.value)).map((f) => ({ name: f, value: f })),
+});
+```
+
+### Subcommands
+
+```ts
+import { commandGroup, subcommand, subcommandGroup, option } from "spearkit";
+
+commandGroup({
+  name: "admin",
+  description: "Admin tools",
+  guildOnly: true,
+  subcommands: {
+    say: subcommand({
+      description: "Make the bot speak",
+      options: { message: option.string({ description: "Message", required: true }) },
+      run: (ctx) => ctx.reply(ctx.options.message),
+    }),
+  },
+  groups: {
+    users: subcommandGroup({
+      description: "Manage users",
+      subcommands: {
+        ban: subcommand({
+          description: "Ban a user",
+          options: { target: option.user({ description: "Who", required: true }) },
+          run: (ctx) => ctx.reply(`Banned ${ctx.options.target.tag}`),
+        }),
+      },
+    }),
+  },
+});
+```
+
+## Interactive components
+
+Define the component, its custom-id pattern and its handler in one place. Params
+in the custom-id pattern (`{name}`) are typed everywhere — both in the handler's
+`ctx.params` and in the `build()` call.
+
+```ts
+import { button, stringSelect, modal, textInput, row } from "spearkit";
+
+const vote = button({
+  id: "vote:{choice}",            // {choice} becomes a typed param
+  label: "Yes",
+  style: "Success",
+  run: (ctx) => ctx.update(`You chose ${ctx.params.choice}`), // ctx.params.choice: string
+});
+
+const colour = stringSelect({
+  id: "colour",
+  placeholder: "Pick a colour",
+  options: [
+    { label: "Red", value: "red" },
+    { label: "Blue", value: "blue" },
+  ],
+  run: (ctx) => ctx.reply({ content: ctx.values.join(", "), ephemeral: true }),
+});
+
+const feedback = modal({
+  id: "feedback:{ticket}",
+  title: "Feedback",
+  fields: {
+    summary: textInput({ label: "Summary", required: true }),
+    detail: textInput({ label: "Details", style: "Paragraph" }),
+  },
+  run: (ctx) =>
+    // ctx.params.ticket: string, ctx.fields.summary / ctx.fields.detail: string
+    ctx.reply({ content: `#${ctx.params.ticket}: ${ctx.fields.summary}`, ephemeral: true }),
+});
+
+client.register(vote, colour, feedback);
+
+// Use them in a message — build() requires exactly the params the pattern declares:
+await channel.send({
+  content: "Choose:",
+  components: [row(vote.build({ choice: "yes" })), row(colour.build())],
+});
+```
+
+Component builders: `button`, `linkButton`, `stringSelect`, `userSelect`,
+`roleSelect`, `channelSelect`, `mentionableSelect`, `modal` (+ `textInput`), `row`.
+
+spearkit routes interactions automatically by the custom-id namespace and decodes
+the params for you — no `interactionCreate` switch statements.
+
+## File-based loading
+
+Drop commands, events and components in a folder (default or named exports) and
+load them all:
+
+```ts
+await client.load(new URL("./commands", import.meta.url).pathname);
+```
+
+## Plugins
+
+```ts
+import { definePlugin } from "spearkit";
+
+const moderation = definePlugin({
+  name: "moderation",
+  setup(client) {
+    client.register(/* commands, events, components */);
+  },
+});
+
+await client.use(moderation);
+```
+
+## Drop-in replacement
+
+Everything discord.js exports is available from spearkit, so you can migrate
+incrementally:
+
+```ts
+import { Client, EmbedBuilder, GatewayIntentBits } from "spearkit"; // all from discord.js
+```
+
+## Error handling
+
+Handler errors never crash the process. Customise the response:
+
+```ts
+client.commands.onError((error, interaction) => {
+  console.error(error);
+  return interaction.reply({ content: "Oops.", flags: 64 });
+});
+client.components.onError((error) => console.error(error));
+```
+
+## License
+
+[PolyForm Noncommercial License 1.0.0](./LICENSE).
+
+spearkit is **free for noncommercial use** — personal projects, learning,
+research, and use by nonprofit/educational/government organizations. You may
+**not** use it in software or projects you sell or that are built for
+commercial advantage without a separate commercial license. See [`LICENSE`](./LICENSE)
+for the full terms, or open an issue to discuss a commercial license.