cordo 2.0.0 → 2.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cordo",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "A framework for handling complex discord api interactions",
   "exports": {
     ".": "./src/index.ts",
@@ -11,12 +11,7 @@
     "./http": "./src/http/index.ts"
   },
   "files": [
-    "src/index.ts",
-    "src/core/index.ts",
-    "src/components/index.ts",
-    "src/errors/index.ts",
-    "src/functions/index.ts",
-    "src/http/index.ts"
+    "src/*"
   ],
   "scripts": {
     "build": "tsc",

package/src/README.md

@@ -0,0 +1,3 @@
+/core includes all core components
+/lib includes helper functions etc
+/component contains default discord components

package/src/components/builtin/button.ts

@@ -0,0 +1,64 @@
+import { ButtonStyle, type APIEmoji } from "discord-api-types/v10"
+import { ComponentType, createComponent } from "../component"
+import { LibEmoji } from "../../lib/emoji"
+import { Hooks } from "../../core/hooks"
+import type { CordoFunct, CordoFunctRun } from "../../functions"
+import { FunctCompiler } from "../../functions/compiler"
+
+
+export function button() {
+  let labelVal: string | undefined = undefined
+  let emojiVal: APIEmoji | undefined = undefined
+  let disabledVal: boolean | undefined = undefined
+  let styleVal = ButtonStyle.Secondary
+  const functVal: CordoFunct[] = []
+
+  function getLabel() {
+    if (!labelVal)
+      return emojiVal ? '' : 'Click'
+
+    return Hooks.callHook(
+      'transformUserFacingText',
+      labelVal,
+      { component: 'Button', position: 'label' }
+    )
+  }
+
+  const out = {
+    ...createComponent('Button', () => ({
+      type: ComponentType.Button,
+      label: getLabel(),
+      emoji: emojiVal,
+      style: styleVal,
+      disabled: disabledVal,
+      custom_id: FunctCompiler.toCustomId(disabledVal ? [] : functVal)
+    })),
+
+    label: (text: string) => {
+      labelVal = text
+      return out
+    },
+    emoji: (emoji: LibEmoji.Input) => {
+      emojiVal = LibEmoji.read(emoji)
+      return out
+    },
+    style: (style: 'primary' | 'secondary' | 'success' | 'danger') => {
+      if (style === 'primary') styleVal = ButtonStyle.Primary
+      else if (style === 'secondary') styleVal = ButtonStyle.Secondary
+      else if (style === 'success') styleVal = ButtonStyle.Success
+      else if (style === 'danger') styleVal = ButtonStyle.Danger
+      return out
+    },
+    disabled(disabled = true, opts?: { greyOut?: boolean }) {
+      disabledVal = disabled
+      if (opts?.greyOut) styleVal = ButtonStyle.Secondary
+      return out
+    },
+    onClick: (...funct: CordoFunctRun) => {
+      functVal.push(...funct)
+      return out
+    }
+  }
+
+  return out
+}

package/src/components/builtin/collection.ts

@@ -0,0 +1,6 @@
+import type { CordoComponent } from "../component"
+
+
+export function collection(...components: CordoComponent[]) {
+  return components
+}

package/src/components/builtin/container.ts

@@ -0,0 +1,31 @@
+import { ComponentType, createComponent, renderComponentList, type CordoComponent } from "../component"
+import type { CordoModifier } from "../modifier"
+
+
+type AllowedComponents = CordoComponent<'ActionRow' | 'Button' | 'TextDisplay' | 'Section' | 'MediaGallery' | 'Seperator' | 'File' | 'StringSelect'> | CordoModifier
+type AllowedComponentArray = Array<AllowedComponents | AllowedComponents[]>
+
+export function container(...components: AllowedComponentArray) {
+  let accentColor: string | number | undefined = undefined
+  let spoiler: boolean | undefined = undefined
+
+  const out = {
+    ...createComponent('Container', ({ hirarchy, attributes }) => ({
+      type: ComponentType.Container,
+      components: renderComponentList(components.flat(), 'Container', hirarchy, attributes),
+      accent_color: typeof accentColor === 'string' ? parseInt(accentColor.slice(1), 16) : accentColor,
+      spoiler
+    })),
+
+    accentColor: (color: string | number) => {
+      accentColor = color
+      return out
+    },
+    spoiler: (value: boolean = true) => {
+      spoiler = value
+      return out
+    }
+  }
+
+  return out
+}

package/src/components/builtin/divider.ts

@@ -0,0 +1,25 @@
+import { ComponentType, createComponent } from "../component"
+
+
+export function divider() {
+  let spacing: number | undefined = undefined
+
+  const out = {
+    ...createComponent('Seperator', () => ({
+      type: ComponentType.Seperator,
+      spacing,
+      divider: true
+    })),
+
+    size: (size: 'small' | 'large') => {
+      spacing = (size === 'small')
+        ? 1
+        : (size === 'large')
+          ? 2
+          : undefined
+      return out
+    }
+  }
+  
+  return out
+}

package/src/components/builtin/gallery.ts

@@ -0,0 +1,13 @@
+import { ComponentType, createComponent, renderComponentList, type CordoComponent } from "../component"
+
+
+export function gallery(...items: CordoComponent<'Thumbnail'>[]) {
+  const out = {
+    ...createComponent('MediaGallery', ({ }) => ({
+      type: ComponentType.MediaGallery,
+      items: renderComponentList(items, 'MediaGallery')
+    })),
+  }
+
+  return out
+}

package/src/components/builtin/image.ts

@@ -0,0 +1,31 @@
+import { ComponentType, createComponent } from "../component"
+
+
+export function image(url: string) {
+  let description: string | undefined = undefined
+  let spoiler: boolean | undefined = undefined
+
+  const out = {
+    ...createComponent('Thumbnail', ({ hirarchy }) => ({
+      type: hirarchy[0] === 'MediaGallery' // if placed inside a media gallery we act as a media gallery item instead
+        ? undefined
+        : ComponentType.Thumbnail,
+      media: {
+        url
+      },
+      spoiler,
+      description
+    })),
+
+    description: (value: string) => {
+      description = value
+      return out
+    },
+    spoiler: (value: boolean = true) => {
+      spoiler = value
+      return out
+    }
+  }
+
+  return out
+}

package/src/components/builtin/link-button.ts

@@ -0,0 +1,42 @@
+import { ButtonStyle } from "discord-api-types/v10"
+import { ComponentType, createComponent } from "../component"
+import { Hooks } from "../../core/hooks"
+
+
+export function linkButton(url: string) {
+  let labelVal: string | undefined = undefined
+  let emojiVal: string | undefined = undefined
+
+
+  function getLabel() {
+    if (!labelVal)
+      return emojiVal ? '' : new URL(url).hostname
+
+    return Hooks.callHook(
+      'transformUserFacingText',
+      labelVal,
+      { component: 'Button', position: 'label' }
+    )
+  }
+
+  const out = {
+    ...createComponent('Button', () => ({
+      type: ComponentType.Button,
+      label: getLabel(),
+      emoji: emojiVal,
+      style: ButtonStyle.Link,
+      url
+    })),
+
+    label: (text: string) => {
+      labelVal = text
+      return out
+    },
+    emoji: (emoji: string) => {
+      emojiVal = emoji
+      return out
+    },
+  }
+
+  return out
+}

package/src/components/builtin/row.ts

@@ -0,0 +1,19 @@
+import { ComponentType, createComponent, renderComponentList, type CordoComponent } from "../component"
+
+
+type AllowedComponents = CordoComponent<'Button' | 'StringSelect'>
+type AllowedComponentArray
+  = [ AllowedComponents ]
+  | [ AllowedComponents, AllowedComponents ]
+  | [ AllowedComponents, AllowedComponents, AllowedComponents ]
+  | [ AllowedComponents, AllowedComponents, AllowedComponents, AllowedComponents ]
+  | [ AllowedComponents, AllowedComponents, AllowedComponents, AllowedComponents, AllowedComponents ]
+
+export function row(...components: AllowedComponentArray | [ AllowedComponentArray ]) {
+  if (Array.isArray(components[0]))
+    components = components[0]
+  return createComponent('ActionRow', ({ hirarchy, attributes }) => ({
+    type: ComponentType.ActionRow,
+    components: renderComponentList(components as AllowedComponentArray, 'ActionRow', hirarchy, attributes)
+  }))
+}

package/src/components/builtin/section.ts

@@ -0,0 +1,24 @@
+import { ComponentType, createComponent, renderComponent, renderComponentList, type CordoComponent } from "../component"
+
+
+type AllowedComponentsContent = CordoComponent<'TextDisplay'>
+type AllowedComponentsAccessory = CordoComponent<'Thumbnail' | 'Button'>
+
+export function section(...components: AllowedComponentsContent[]) {
+  let accessory: AllowedComponentsAccessory | undefined = undefined
+
+  const out = {
+    ...createComponent('Section', ({ hirarchy, attributes }) => ({
+      type: ComponentType.Section,
+      components: renderComponentList(components, 'Section', hirarchy, attributes),
+      accessory: accessory ? renderComponent(accessory, 'Section', hirarchy, attributes) : undefined
+    })),
+
+    decorate(component: AllowedComponentsAccessory) {
+      accessory = component
+      return out
+    }
+  }
+
+  return out
+}

package/src/components/builtin/select-string.ts

@@ -0,0 +1,92 @@
+import { type APISelectMenuOption } from "discord-api-types/v10"
+import { ComponentType, createComponent } from "../component"
+import { Hooks } from "../../core/hooks"
+import { value, type CordoFunct, type CordoFunctRun } from "../../functions"
+import { FunctCompiler } from "../../functions/compiler"
+
+
+type SelectMenuOption<Value extends string = string> = Omit<APISelectMenuOption, 'value'> & ({
+  value?: Value
+  onClick?: CordoFunct | CordoFunctRun
+})
+
+export function selectString<Values extends string = string>() {
+  let placeholderVal: string | undefined = undefined
+  let minValues: number | undefined = undefined
+  let maxValues: number | undefined = undefined
+  let optionsVal: SelectMenuOption[] = []
+  let disabledVal: boolean | undefined = undefined
+  const functVal: CordoFunct[] = []
+
+  function getPlaceholder() {
+    if (!placeholderVal)
+      return undefined
+    return Hooks.callHook(
+      'transformUserFacingText',
+      placeholderVal,
+      { component: 'StringSelect', position: 'placeholder' }
+    )
+  }
+
+  function getOptions(): SelectMenuOption[] {
+    return optionsVal.slice(0, 25).map(o => ({
+      ...o,
+      label: Hooks.callHook('transformUserFacingText', o.label, { component: 'StringSelect', position: 'option.label' }),
+      description: o.description
+        ? Hooks.callHook('transformUserFacingText', o.description, { component: 'StringSelect', position: 'option.description' })
+        : undefined,
+      value: FunctCompiler.toCustomId([
+        ...(o.onClick
+          ? Array.isArray(o.onClick)
+            ? o.onClick
+            : [ o.onClick ]
+          : []
+        ),
+        o.value ? value(o.value) : null
+      ])
+    }))
+  }
+
+  const out = {
+    ...createComponent('StringSelect', () => ({
+      type: ComponentType.StringSelect,
+      placeholder: getPlaceholder(),
+      min_values: minValues,
+      max_values: maxValues ? Math.min(optionsVal.length, maxValues) : undefined,
+      disabled: disabledVal,
+      options: getOptions(),
+      custom_id: FunctCompiler.toCustomId(disabledVal ? [] : functVal)
+    })),
+
+    placeholder: (text: string) => {
+      placeholderVal = text
+      return out
+    },
+    min: (num: number = 1) => {
+      minValues = num
+      return out
+    },
+    max: (num: number = 25) => {
+      maxValues = num
+      return out
+    },
+    disabled(disabled = true) {
+      disabledVal = disabled
+      return out
+    },
+    onSubmit: (...funct: CordoFunctRun) => {
+      functVal.push(...funct)
+      return out
+    },
+    setOptions(options: Array<SelectMenuOption<Values>>) {
+      optionsVal = options
+      return out
+    },
+    addOption(o: SelectMenuOption<Values>) {
+      optionsVal.push(o)
+      return out
+    }
+  }
+
+  return out
+}

package/src/components/builtin/spacer.ts

@@ -0,0 +1,25 @@
+import { ComponentType, createComponent } from "../component"
+
+
+export function spacer() {
+  let spacing: number | undefined = undefined
+
+  const out = {
+    ...createComponent('Seperator', () => ({
+      type: ComponentType.Seperator,
+      spacing,
+      divider: false
+    })),
+
+    size: (size: 'small' | 'large') => {
+      spacing = (size === 'small')
+        ? 1
+        : (size === 'large')
+          ? 2
+          : undefined
+      return out
+    }
+  }
+  
+  return out
+}

package/src/components/builtin/text.ts

@@ -0,0 +1,94 @@
+import { Hooks } from "../../core/hooks"
+import { ComponentType, createComponent } from "../component"
+
+
+export function text(...content: Array<string | { toString: () => string }>) {
+  let outerPrefix: string = ''
+  let innerPrefix: string = ''
+  let innerSuffix: string = ''
+  let linkUrl: string | null = null
+
+  function toString(attributes: Record<string, any> = {}): string {
+    const stringContent = content
+      .map(c => typeof c === 'string' ? c : c.toString())
+      .map(c => Hooks.callHook('transformUserFacingText', c, { ...attributes, component: 'TextDisplay', position: null }))
+    const innerContent = (innerPrefix ?? '') + stringContent.join(' ').replace(/^ +| +$/mg, '') + (innerSuffix ?? '')
+    const outerContent = linkUrl
+      ? `[${innerContent}](${linkUrl})`
+      : innerContent
+    return outerPrefix + outerContent as string
+  }
+
+  const out = {
+    ...createComponent('TextDisplay', ({ attributes }) => ({
+      type: ComponentType.TextDisplay,
+      content: toString(attributes)
+    })),
+
+    toString,
+
+    size: (size: 'h1' | 'h2' | 'h3' | 'small' | 'default') => {
+      if (size === 'h1') outerPrefix = '# '
+      else if (size === 'h2') outerPrefix = '## '
+      else if (size === 'h3') outerPrefix = '### '
+      else if (size === 'small') outerPrefix = '-# '
+      else outerPrefix = ''
+      return out
+    },
+
+    link: (url: string) => {
+      linkUrl = url
+      return out
+    },
+
+    bold: (val = true) => {
+      if (val) {
+        innerPrefix = innerPrefix + '**'
+        innerSuffix = '**' + innerSuffix
+      }
+      return out
+    },
+    italic: (val = true) => {
+      if (val) {
+        innerPrefix = innerPrefix + '*'
+        innerSuffix = '*' + innerSuffix
+      }
+      return out
+    },
+    underline: (val = true) => {
+      if (val) {
+        innerPrefix = innerPrefix + '__'
+        innerSuffix = '__' + innerSuffix
+      }
+      return out
+    },
+    strike: (val = true) => {
+      if (val) {
+        innerPrefix = innerPrefix + '~~'
+        innerSuffix = '~~' + innerSuffix
+      }
+      return out
+    },
+    quote: (val = true) => {
+      if (val)
+        outerPrefix = '> '
+      return out
+    },
+    code: (val = true) => {
+      if (val) {
+        innerPrefix = innerPrefix + '`'
+        innerSuffix = '`' + innerSuffix
+      }
+      return out
+    },
+    codeBlock: (language = '', val = true) => {
+      if (val) {
+        innerPrefix = innerPrefix + '```' + (language ? language + '\n' : '')
+        innerSuffix = '```' + innerSuffix
+      }
+      return out
+    }
+  }
+  
+  return out
+}

package/src/components/component.ts

@@ -0,0 +1,170 @@
+import defu from "defu"
+import { row } from "./builtin/row"
+import { readModifier, type CordoModifier } from "./modifier"
+
+
+const CordoComponentSymbol = Symbol('CordoComponent')
+
+export const ComponentType = {
+  ActionRow: 1,
+  Button: 2,
+  StringSelect: 3,
+  TextInput: 4,
+  UserSelect: 5,
+  RoleSelect: 6,
+  MentionableSelect: 7,
+  ChannelSelect: 8,
+  Section: 9,
+  TextDisplay: 10,
+  Thumbnail: 11,
+  MediaGallery: 12,
+  File: 13,
+  Seperator: 14,
+  Container: 17
+} as const
+export type StringComponentType = keyof typeof ComponentType
+export type ComponentIdFromName<Name extends StringComponentType> = typeof ComponentType[Name]
+
+export type CordoComponent<Type extends StringComponentType = StringComponentType> = {
+  [CordoComponentSymbol]: {
+    nativeName: Type
+    nativeType: typeof ComponentType[Type]
+    visible: boolean
+    attributes: Record<string, any>
+    render: (meta: {
+      hirarchy: Array<StringComponentType>
+      attributes: Record<string, any>
+    }) => Record<string, any> | null
+  }
+  visible: (value: boolean) => CordoComponent<Type>
+  attributes: (attrs: Record<string, any>) => CordoComponent<Type>
+}
+export type CordoComponentPayload<Type extends StringComponentType> = CordoComponent<Type>[typeof CordoComponentSymbol]
+
+export function createComponent<Type extends StringComponentType>(
+  type: Type,
+  render: CordoComponentPayload<Type>['render']
+): CordoComponent<Type> {
+  const comp = {
+    nativeName: type,
+    nativeType: ComponentType[type],
+    visible: true,
+    attributes: {},
+    render
+  }
+  const out = {
+    [CordoComponentSymbol]: comp,
+    visible(value: boolean) {
+      comp.visible = value
+      return this
+    },
+    attributes(attrs: Record<string, any>) {
+      comp.attributes = defu(attrs, comp.attributes)
+      return this
+    }
+  }
+  return out
+}
+
+export function readComponent<T extends CordoComponent<StringComponentType>>(comp: T): T[typeof CordoComponentSymbol] {
+  return comp[CordoComponentSymbol]!
+}
+
+export function isComponent(t: Record<string, any>): t is CordoComponent<StringComponentType> {
+  return !!t && CordoComponentSymbol in t
+}
+
+export function renderComponent(
+  c: CordoComponent<StringComponentType> | CordoComponentPayload<StringComponentType>,
+  parent: StringComponentType | null,
+  hirarchy: Array<StringComponentType> = [],
+  inheritAttributes: Record<string, any> = {}
+) {
+  const extracted = CordoComponentSymbol in c ? readComponent(c) : c
+  if (!extracted.visible)
+    return null
+  return extracted.render({
+    hirarchy: parent
+      ? [ parent, ...hirarchy ]
+      : hirarchy,
+    attributes: defu(extracted.attributes, inheritAttributes)
+  })
+}
+
+export function renderComponentList(
+  list: Array<CordoComponent<StringComponentType> | CordoModifier>,
+  parent: StringComponentType | null,
+  hirarchy: Array<StringComponentType> = [],
+  inheritAttributes: Record<string, any> = {}
+) {
+  let pipeline: Array<CordoComponentPayload<StringComponentType>> = []
+  const rowBuilder: Array<CordoComponent<StringComponentType>> = []
+  const modifiers: Array<ReturnType<typeof readModifier>> = []
+
+  for (const item of list) {
+    if (!item)
+      continue
+
+    if (!isComponent(item)) {
+      const mod = readModifier(item)
+      if (!modifiers.some(m => m.name === mod.name))
+        modifiers.push(mod)
+      continue
+    }
+
+    let parsed = readComponent(item)
+    for (const mod of modifiers) {
+      if (mod.hooks?.onRender)
+        parsed = mod.hooks.onRender(parsed)
+    }
+
+    if (parent !== 'ActionRow') {
+      if (parsed.nativeName === 'Button') {
+        rowBuilder.push(item)
+        if (rowBuilder.length === 5) {
+          pipeline.push(readComponent(row(...rowBuilder as any)))
+          rowBuilder.splice(0)
+        }
+        continue
+      }
+
+      if (parsed.nativeName === 'StringSelect') {
+        if (rowBuilder.length > 0) {
+          pipeline.push(readComponent(row(...rowBuilder as any)))
+          rowBuilder.splice(0)
+        }
+
+        pipeline.push(readComponent(row(item as any)))
+        continue
+      }
+    }
+
+    if (rowBuilder.length > 0) {
+      pipeline.push(readComponent(row(...rowBuilder as any)))
+      rowBuilder.splice(0)
+    }
+
+    pipeline.push(parsed)
+  }
+
+  if (rowBuilder.length > 0) {
+    pipeline.push(readComponent(row(...rowBuilder as any)))
+    rowBuilder.splice(0)
+  }
+
+  for (const mod of modifiers) {
+    if (mod.hooks?.preRender)
+      pipeline = mod.hooks.preRender(pipeline)
+  }
+
+  let output = pipeline
+    .map(c => renderComponent(c, parent, hirarchy, inheritAttributes))
+    .filter(Boolean)
+
+  for (const mod of modifiers) {
+    if (mod.hooks?.postRender)
+      output = mod.hooks.postRender(output)
+  }
+
+  return output
+}