abseil 0.1.0-canary.1

package/README.md

@@ -0,0 +1,58 @@
+# Abseil
+
+Quickly traverse Discord [Components V2](https://docs.discord.com/developers/components/overview) trees.
+
+## Reference
+
+| function  | description                                                                                           |
+| --------- | ----------------------------------------------------------------------------------------------------- |
+| accessory | Access the accessory of a [Section](https://docs.discord.com/developers/components/reference#section) |
+| child     | Access the first child of a node                                                                      |
+| previous  | Return to the previous node                                                                           |
+| sibling   | Access the next node in an array                                                                      |
+| update    | Shallow merge with the current component in place                                                     |
+| value     | The current component                                                                                 |
+
+## Example
+
+```ts
+import { type APIMessage, ComponentType } from "discord-api-types/v10";
+import { Button, editMessage } from "dressed";
+import abseil from "abseil";
+
+const message = {
+  components: [
+    { type: ComponentType.TextDisplay },
+    {
+      type: ComponentType.Container,
+      components: [
+        {
+          type: ComponentType.Section,
+          accessory: { type: ComponentType.Thumbnail },
+          components: [{ type: ComponentType.TextDisplay }, { type: ComponentType.TextDisplay }],
+        },
+        { type: ComponentType.Separator },
+        { type: ComponentType.ActionRow, components: [{ type: ComponentType.UserSelect }] },
+      ],
+    },
+    {
+      type: ComponentType.ActionRow,
+      components: [{ type: ComponentType.Button }, { type: ComponentType.Button }],
+    },
+  ],
+} as APIMessage;
+
+abseil(message.components ?? [])
+  .initial("TextDisplay")
+  .sibling("Container")
+  .update({ spoiler: true })
+  .sibling("ActionRow")
+  .update((p) => ({
+    components: p.components.concat(Button({ custom_id: "new", label: "I'm new!" })),
+  }))
+  .previous.child("Section")
+  .accessory(["Button", "Thumbnail"])
+  .update({ id: 32 });
+
+editMessage("<CHANNEL_ID>", "<MESSAGE_ID>", message.components);
+```

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+/** biome-ignore-all lint/suspicious/noExplicitAny: Not worth my time */
+import { type APIComponentInContainer, type APIComponentInMessageActionRow, type APIMessageComponent, type APISectionAccessoryComponent, type APISelectMenuComponent, ComponentType } from "discord-api-types/v10";
+type CT = typeof ComponentType & {
+    "Button:URL": ComponentType.Button;
+    "Button:SKU": ComponentType.Button;
+};
+type IComponentType = {
+    [K in keyof CT as CT[K]]: K;
+};
+type Pop<T extends any[]> = T extends [...infer Rest, any] ? Rest : never;
+type Last<T extends any[]> = T extends [...any[], infer L] ? L : never;
+type Arrable<T> = T | T[];
+type Narr<T extends Arrable<string>> = T extends string ? T : T[number];
+type Overwriter<T> = Partial<T> | ((prev: T) => Partial<T>);
+interface ChildrenMap {
+    ActionRow: IComponentType[APIComponentInMessageActionRow["type"]] | "Button:URL" | "Button:SKU";
+    Container: IComponentType[APIComponentInContainer["type"]];
+    Section: "TextDisplay";
+}
+type TraverserFn<C extends keyof CT, H extends (keyof CT)[], O extends string = ""> = <const T extends Arrable<C>>(type: T) => Omit<Traverser<Narr<T>, H, C>, O>;
+type Component<T extends keyof CT> = Extract<APIMessageComponent, {
+    type: CT[T extends "Button:URL" | "Button:SKU" ? "Button" : T];
+} & (T extends "Button" ? {
+    custom_id: string;
+} : T extends "Button:URL" ? {
+    url: string;
+} : T extends "Button:SKU" ? {
+    sku_id: string;
+} : object)>;
+type Traverser<T extends keyof CT, H extends (keyof CT)[], ST extends keyof CT = keyof CT> = {
+    /** Shallow merge with the current component in place */
+    update: (value: Overwriter<Component<T>>) => Traverser<T, H, ST>;
+    /** The current component */
+    value: Component<T>;
+} & (T extends IComponentType[APISelectMenuComponent["type"]] ? object : {
+    /** Access the next node in an array */
+    sibling: TraverserFn<ST, [...H, T]>;
+}) & (T extends keyof ChildrenMap ? {
+    /** Access the first child of a node */
+    child: TraverserFn<ChildrenMap[T], [...H, T]>;
+} : object) & (T extends "Section" ? {
+    /** Access the accessory of a [Section](https://docs.discord.com/developers/components/reference#section) */
+    accessory: TraverserFn<IComponentType[APISectionAccessoryComponent["type"]], [...H, T], "sibling">;
+} : object) & (H extends [] ? object : {
+    /** Return to the previous node */
+    previous: Traverser<Last<H>, Pop<H>>;
+});
+declare const abseil: <T extends APIMessageComponent>(components: T[]) => {
+    initial: TraverserFn<IComponentType[T["type"]], [], "previous">;
+};
+export default abseil;

package/dist/index.js

@@ -0,0 +1,40 @@
+/** biome-ignore-all lint/suspicious/noExplicitAny: Not worth my time */
+import { ComponentType, } from "discord-api-types/v10";
+const withChildren = new Set([ComponentType.ActionRow, ComponentType.Section, ComponentType.Container]);
+function createTraverser(component, expected, previous, siblings) {
+    const expectedTypes = new Set(Array.isArray(expected) ? expected : [expected]);
+    let actualType = ComponentType[component.type];
+    if (actualType === "Button") {
+        if ("url" in component)
+            actualType += ":URL";
+        else if ("sku_id" in component)
+            actualType += ":SKU";
+    }
+    if (!expectedTypes.has(actualType)) {
+        throw new TypeError(`Type mismatch: expected ${[...expectedTypes].join(" or ")}, got ${actualType}`);
+    }
+    const traverser = {
+        value: component,
+        update(v) {
+            Object.assign(component, typeof v === "function" ? v(component) : v);
+            return traverser;
+        },
+    };
+    if (previous)
+        traverser.previous = previous;
+    if (siblings === null || siblings === void 0 ? void 0 : siblings.length) {
+        traverser.sibling = (t) => createTraverser(siblings[0], t, traverser, siblings.slice(1));
+    }
+    if (withChildren.has(component.type) && "components" in component) {
+        traverser.child = (t) => createTraverser(component.components[0], t, traverser, component.components.slice(1));
+    }
+    if (component.type === ComponentType.Section) {
+        traverser.accessory = (t) => createTraverser(component.accessory, t, traverser);
+    }
+    return traverser;
+}
+const abseil = (components) => ({
+    initial: ((t) => createTraverser(components[0], t, undefined, components.slice(1))),
+});
+export default abseil;
+//# 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,wEAAwE;AACxE,OAAO,EAML,aAAa,GACd,MAAM,uBAAuB,CAAC;AAmE/B,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,aAAa,CAAC,SAAS,EAAE,aAAa,CAAC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;AAExG,SAAS,eAAe,CACtB,SAAY,EACZ,QAA2B,EAC3B,QAA4C,EAC5C,QAAgC;IAEhC,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC/E,IAAI,UAAU,GAAG,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/C,IAAI,UAAU,KAAK,QAAQ,EAAE,CAAC;QAC5B,IAAI,KAAK,IAAI,SAAS;YAAE,UAAU,IAAI,MAAM,CAAC;aACxC,IAAI,QAAQ,IAAI,SAAS;YAAE,UAAU,IAAI,MAAM,CAAC;IACvD,CAAC;IACD,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,SAAS,CAAC,2BAA2B,CAAC,GAAG,aAAa,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,UAAU,EAAE,CAAC,CAAC;IACvG,CAAC;IACD,MAAM,SAAS,GAAQ;QACrB,KAAK,EAAE,SAAS;QAChB,MAAM,CAAC,CAAkC;YACvC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACrE,OAAO,SAAS,CAAC;QACnB,CAAC;KACF,CAAC;IACF,IAAI,QAAQ;QAAE,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC5C,IAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,MAAM,EAAE,CAAC;QACrB,SAAS,CAAC,OAAO,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACnG,CAAC;IACD,IAAI,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,YAAY,IAAI,SAAS,EAAE,CAAC;QAClE,SAAS,CAAC,KAAK,GAAG,CAAC,CAAS,EAAE,EAAE,CAC9B,eAAe,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1F,CAAC;IACD,IAAI,SAAS,CAAC,IAAI,KAAK,aAAa,CAAC,OAAO,EAAE,CAAC;QAC7C,SAAS,CAAC,SAAS,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,eAAe,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC;IAC1F,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,MAAM,GAAG,CAAgC,UAAe,EAAE,EAAE,CAAC,CAAC;IAClE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAIjF;CACF,CAAC,CAAC;AAEH,eAAe,MAAM,CAAC"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "abseil",
+  "version": "0.1.0-canary.1",
+  "description": "Quickly traverse Discord Components V2 trees.",
+  "scripts": {
+    "dist": "rm -fr dist && tsc",
+    "checks": "tsc --noEmit && biome check --write",
+    "dry-publish": "bun publish --dry-run"
+  },
+  "dependencies": {
+    "discord-api-types": "^0.38.42"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.8",
+    "@types/bun": "^1.3.11",
+    "typescript": "^5.9.3"
+  },
+  "exports": "./dist/index.js",
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "discord",
+    "components",
+    "components v2"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Inbestigator/abseil.git",
+    "directory": "packages/abseil"
+  }
+}