sigcord 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,256 @@
+# Sigcord
+
+Stateful and interactive menus for Discord, utilizing signals for simple state management.
+
+Integrates with [Discord.js](https://discord.js.org) under the hood.
+
+## Installation
+
+Add `sigcord` as a dependency to your `package.json`. JSX is recommended, but not required.
+
+**Note that [Discord.js](https://discord.js.org) is required.**
+
+```shell
+npm install sigcord @sigcord/jsx discord.js
+yarn add sigcord @sigcord/jsx discord.js
+pnpm add sigcord @sigcord/jsx discord.js
+bun add sigcord @sigcord/jsx discord.js
+
+# Without JSX
+npm install sigcord discord.js
+yarn add sigcord discord.js
+pnpm add sigcord discord.js
+bun add sigcord discord.js
+```
+
+### JSX (React syntax)
+
+Sigcord comes with an optional JSX wrapper, types and batteries included. First, install the peer dependency:
+
+```shell
+npm install @sigcord/jsx
+yarn add @sigcord/jsx
+pnpm add @sigcord/jsx
+bun add @sigcord/jsx
+```
+
+Then configure your JSX to be `react-jsx`, pointing at `@sigcord/jsx` as the import source. For `tsconfig.json`, this
+would look something like:
+
+```json
+{
+  "compilerOptions": {
+    "jsx": "react-jsx",
+    "jsxImportSource": "@sigcord/jsx"
+  }
+}
+```
+
+### Example Usage
+
+> *Full documentation is planned, but with no set timeline.*
+
+Menus are made of views, but a view can be used standalone. Since the library has evolved to being
+functional-component-forward, abandoning the original class-based architecture, let's look at defining and using views
+alone.
+
+Views support V1 and V2 components with `defineView` and `defineViewV2` respectively; *you cannot mix-and-match*. Views
+take a single type parameter defining the props it accepts, which is useful for dynamically setting up initial state.
+Each view takes an `id`, followed by the factory function, and lastly some default options (i.e. `flags` for ephemeral).
+
+```tsx
+import {defineView, defineViewV2} from "./defineReactiveView";
+import {ActionRowBuilder, ButtonBuilder, EmbedBuilder, MessageFlags} from "discord.js";
+
+interface Props {
+  name: string;
+}
+
+const HelloWorldV2 = defineViewV2('hello-world-v2', (props) => {
+  return (
+    <container>
+      <h1>Hello World</h1>
+      <text>
+        Hello, {props.name}, it's great to have you here!
+      </text>
+      <row>
+        <button>{/* ... */}</button>
+      </row>
+    </container>
+  )
+}, {flags: MessageFlags.Ephemeral}); // default attributes
+
+const HelloWorld = defineView('hello-world', (props) => {
+  return {
+    content: 'Some text content',
+    embeds: [
+      new EmbedBuilder()
+        .setTitle('Hello World')
+        .setDescription(`Hello, ${props.name}, it's great to have you here!`),
+    ],
+    components: [
+      new ActionRowBuilder().setComponents(
+        new ButtonBuilder() //...
+      ),
+    ],
+  };
+}, {flags: MessageFlags.Ephemeral}); // default attributes
+```
+
+These view functions return a factory that can be invoked directly. It accepts an interaction, followed by an object
+that accepts common attributes like `flags` (i.e., `MessageFlags.Ephemeral`) and any props the view accepts:
+
+```ts
+import {HelloWorld} from './helloWorld.js';
+import type {ChatInputCommandInteraction} from "discord.js";
+
+async function handleInteraction(interaction: ChatInputCommandInteraction): Promise<void> {
+  const menuInstance = HelloWorld(interaction, {
+    // props
+    name: interaction.member.displayName,
+    
+    // attributes; these override any defaults defined by the view itself.
+    flags: MessageFlags.Ephemeral,
+  });
+  await menuInstance.start();
+}
+```
+
+Here's a more involved example:
+
+```ts
+const menu = SheetEditorV2(lastInteraction, {
+  // props
+  server: server.document,
+  sheet: character,
+  viewer: interaction.member,
+  author: target,
+  wantEdit: true,
+  
+  // attributes
+  renderAfterHandledInteraction: true,
+  initialMessage: message,
+  flags: MessageFlags.Ephemeral
+});
+await menu.start();
+```
+
+#### Reusable Components
+
+Components are just functions! This approach is pretty similar to React and Solid.
+
+JSX comes preloaded with all available Discord components (including V2 components, e.g. `<container>`). All state
+updates are handled by the library itself, no need to define your own `effect()` calls!
+
+```tsx
+import {signal} from "sigcord";
+import {type ButtonInteraction, ButtonStyle} from "discord.js";
+import {computed} from "./computed";
+
+const ButtonMenu = defineViewV2('button-menu', () => {
+  return (
+    <>
+      <h1>Button Clicker!!!</h1>
+      <container>
+        <row>
+          <ClicksButton style={ButtonStyle.Primary} />
+          <HotButton hotCount={100} />
+        </row>
+      </container>
+    </>
+  );
+});
+
+function ClicksButton({style}: { style: ButtonStyle }) {
+  const [clicks, setClicks] = signal(0);
+
+  return (
+    <button
+      id={'click-button'} // optional
+      style={style}
+      on:click={(b) => setClicks(clicks() + 1)}>
+      You have clicked me {clicks} times.
+    </button>
+  );
+}
+
+function HotButton({hotCount}: { hotCount: number }) {
+  const [clicks, setClicks] = signal(0);
+  const isHot = computed(() => clicks() >= hotCount);
+  const onClick = (b: ButtonInteraction) => {
+    setClicks(clicks() + 1);
+  };
+
+  return (
+    <button
+      style={() => isHot() ? ButtonStyle.Danger : ButtonStyle.Primary}
+      on:click={onClick}
+    >
+      {() =>
+        isHot()
+          ? `${clicks()} is a lot of clicks!`
+          : `You have clicked me ${clicks()} times.`
+      }
+    </button>
+  )
+}
+```
+
+If you prefer to gradually adopt this library into existing code, however, the same can be achieved with the underlying
+`component()` function! This function takes an optional `id`, a component builder for the actual component to display,
+and an event handler. The component builder is returned as-is.
+
+Signal-based libraries typically ban asynchronous event handlers, but all global state is saved to
+[`AsyncLocalStorage`](https://nodejs.org/api/async_context.html)! So feel free to `async`/`await` as much as you want :)
+
+`patchEffect(() => {...})` subscribes to signals that are called within it, rerunning each time one of them has changed.
+It also notifies the library that each time it reruns, something might have changed, kicking off an edit to the message
+with the newly-modified content. Since signals are granular, only the relevant code dependent on a signal reruns rather
+than reexecuting the entire component!
+
+There is a non-patch version `effect()` that may be useful for logging.
+
+```ts
+import {ButtonBuilder, ButtonStyle} from "discord.js";
+import {patchEffect} from "./builtins";
+import {computed} from "./computed";
+
+function HotButton({hotCount}: { hotCount: number }) {
+  const [clicks, setClicks] = signal(0);
+  const isHot = computed(() => clicks() >= hotCount);
+
+  const button = new ButtonBuilder();
+  patchEffect(() => {
+    button
+      .setStyle(isHot() ? ButtonStyle.Danger : ButtonStyle.Primary)
+      .setLabel(
+        isHot()
+          ? `${clicks()} is a lot of clicks!`
+          : `You have clicked me ${clicks()} times.`
+      )
+  });
+
+  return component({
+    component: button,
+    handler: (b) => setClicks(clicks() + 1),
+  });
+}
+```
+
+
+## Help
+
+Support Discord server coming soon. While open-sourced and provided as an npm package, this library is mainly servicing
+bots that I have built. Testing is virtually non-existent.
+
+That being said, please feel free to open issues, I'll be sure to take a look and see what I can do :)
+
+Full documentation is planned, but with no set timeline.
+
+## Author
+
+[@raspberry-varg](https://github.com/raspberry-varg)
+
+## License
+
+This project is licensed under the **Apache 2.0 License** - see the [LICENSE](LICENSE) file for details.

package/dist/components/index.d.ts

@@ -0,0 +1,2 @@
+export * from '@sigcord/jsx/components';
+//# sourceMappingURL=index.d.ts.map

package/dist/components/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC"}

package/dist/components/index.js

@@ -0,0 +1,2 @@
+export * from '@sigcord/jsx/components';
+//# sourceMappingURL=index.js.map

package/dist/components/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC"}

package/dist/flow/index.d.ts

@@ -0,0 +1,2 @@
+export * from '@sigcord/jsx/flow';
+//# sourceMappingURL=index.d.ts.map

package/dist/flow/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/flow/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC"}

package/dist/flow/index.js

@@ -0,0 +1,2 @@
+export * from '@sigcord/jsx/flow';
+//# sourceMappingURL=index.js.map

package/dist/flow/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/flow/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from '@sigcord/core';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from '@sigcord/core';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC"}

package/dist/jsx-runtime.d.ts

@@ -0,0 +1,2 @@
+export * from '@sigcord/jsx/jsx-runtime';
+//# sourceMappingURL=jsx-runtime.d.ts.map

package/dist/jsx-runtime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsx-runtime.d.ts","sourceRoot":"","sources":["../src/jsx-runtime.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC"}

package/dist/jsx-runtime.js

@@ -0,0 +1,2 @@
+export * from '@sigcord/jsx/jsx-runtime';
+//# sourceMappingURL=jsx-runtime.js.map

package/dist/jsx-runtime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsx-runtime.js","sourceRoot":"","sources":["../src/jsx-runtime.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC"}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "sigcord",
+  "version": "1.0.0",
+  "description": "Build interactive and stateful menus for Discord.",
+  "directories": {
+    "lib": "dist"
+  },
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "keywords": [],
+  "license": "ISC",
+  "dependencies": {
+    "@sigcord/core": "7.0.0"
+  },
+  "devDependencies": {
+    "nx": "22.0.3",
+    "prettier": "^3.6.2",
+    "typescript": "^5.9.3",
+    "@sigcord/jsx": "1.0.0"
+  },
+  "peerDependencies": {
+    "@sigcord/jsx": "1.0.0"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "default": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./jsx": {
+      "default": "./dist/jsx-runtime.js",
+      "types": "./dist/jsx-runtime.d.ts"
+    },
+    "./jsx-runtime": {
+      "default": "./dist/jsx-runtime.js",
+      "types": "./dist/jsx-runtime.d.ts"
+    },
+    "./jsx-dev-runtime": {
+      "default": "./dist/jsx-runtime.js",
+      "types": "./dist/jsx-runtime.d.ts"
+    },
+    "./components": {
+      "default": "./dist/components/index.js",
+      "types": "./dist/components/index.d.ts"
+    },
+    "./flow": {
+      "default": "./dist/flow/index.js",
+      "types": "./dist/flow/index.d.ts"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "nx": {},
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "eslint .",
+    "format": "npx prettier --write src",
+    "prebuild": "pnpm run clean",
+    "build": "tsc",
+    "clean": "rm -rf dist"
+  }
+}