cordo 2.2.4 → 2.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cordo",
-  "version": "2.2.4",
+  "version": "2.3.0",
   "description": "A framework for handling complex discord api interactions",
   "exports": {
     ".": "./src/index.ts",

package/src/components/builtin/container.ts

@@ -17,8 +17,8 @@ export function container(...components: AllowedComponentArray) {
       spoiler
     })),
 
-    accentColor: (color: string | number) => {
-      accentColor = color
+    accentColor: (color: string | number | null) => {
+      accentColor = color ?? undefined
       return out
     },
     spoiler: (value: boolean = true) => {

package/src/components/builtin/modal.ts

@@ -0,0 +1,53 @@
+import { Hooks } from "../../core/hooks"
+import type { CordoFunct, CordoFunctRun } from "../../functions"
+import { FunctCompiler } from "../../functions/compiler"
+import { ComponentType, createComponent, renderComponentList, type CordoComponent } from "../component"
+import type { CordoModifier } from "../modifier"
+
+
+export type AllowedComponents = CordoComponent<'TextInput'> | CordoModifier
+type AllowedComponentArray = Array<AllowedComponents | AllowedComponents[]>
+
+export function modal(...components: AllowedComponentArray) {
+  let titleVal: string | undefined = undefined
+  const functVal: CordoFunct[] = []
+
+  function getTitle() {
+    if (!titleVal)
+      return 'Modal'
+
+    return Hooks.callHook(
+      'transformUserFacingText',
+      titleVal,
+      { component: 'Modal', position: 'title' }
+    )
+  }
+
+  const out = {
+    ...createComponent('Modal', ({ hirarchy, attributes }) => ({
+      type: ComponentType.Modal,
+      components: renderComponentList(components.flat(), 'Modal', hirarchy, attributes),
+      title: getTitle(),
+      custom_id: FunctCompiler.toCustomId(functVal)
+    })),
+
+    title: (value: string) => {
+      titleVal = value
+      return out
+    },
+    onClick: (...funct: CordoFunctRun) => {
+      functVal.push(...funct)
+      return out
+    },
+    *[Symbol.iterator]() {
+      for (const component of components) {
+        if (Array.isArray(component))
+          yield* component
+        else
+          yield component
+      }
+    }
+  }
+
+  return out
+}

package/src/components/component.ts

@@ -2,6 +2,7 @@ import defu from "defu"
 import { row } from "./builtin/row"
 import { readModifier, type CordoModifier } from "./modifier"
 import type { AllowedComponents as ContainerAllowedComponents } from "./builtin/container"
+import type { AllowedComponents as ModalAllowedComponents } from "./builtin/modal"
 
 
 const CordoComponentSymbol = Symbol.for('CordoComponent')
@@ -21,7 +22,9 @@ export const ComponentType = {
   MediaGallery: 12,
   File: 13,
   Seperator: 14,
-  Container: 17
+  Container: 17,
+
+  Modal: -1, // This is a special type that is not used in the API, but for Cordo's internal use
 } as const
 export type StringComponentType = keyof typeof ComponentType
 export type ComponentIdFromName<Name extends StringComponentType> = typeof ComponentType[Name]
@@ -42,7 +45,9 @@ export type CordoComponent<Type extends StringComponentType = StringComponentTyp
 } & (
   Type extends 'Container'
     ? { [Symbol.iterator]: () => Iterator<ContainerAllowedComponents> }
-    : { [Symbol.iterator]: never }
+    : Type extends 'Modal'
+      ? { [Symbol.iterator]: () => Iterator<ModalAllowedComponents> }
+      : { [Symbol.iterator]: never }
 )
 export type CordoComponentPayload<Type extends StringComponentType> = CordoComponent<Type>[typeof CordoComponentSymbol]
 

package/src/components/index.ts

@@ -16,6 +16,7 @@ export { divider } from './builtin/divider'
 export { gallery } from './builtin/gallery'
 export { image } from './builtin/image'
 export { linkButton } from './builtin/link-button'
+export { modal } from './builtin/modal'
 export { row } from './builtin/row'
 export { section } from './builtin/section'
 export { selectString } from './builtin/select-string'

package/src/core/files/route.ts

@@ -105,6 +105,8 @@ export type RouteRequest = {
   ack: () => void
   /** render the provided components */
   render: (...response: RouteResponse) => void
+  /** open a modal with the provided components */
+  prompt: (modal: CordoComponent<'Modal'>) => void
   /** run a different route. use await to await the call. Returns whether successful, null if not run */
   run: (...params: Parameters<typeof run>) => Promise<boolean | null>
   /** let a different route handle this. Returns whether successful, null if not run */
@@ -133,7 +135,7 @@ export function assertCordoRequest<
 >(request: RouteRequest, assumptions: {
   location: Location
   source: Source
-}): request is RouteRequest & (
+}): asserts request is RouteRequest & (
   Location extends 'guild'
     ? RouteRequestInGuild
     : RouteRequestInDM
@@ -148,7 +150,6 @@ export function assertCordoRequest<
     throw new RouteAssumptionFailedError(request, assumptions)
   if (assumptions.source && request.source !== assumptions.source)
     throw new RouteAssumptionFailedError(request, assumptions)
-  return true
 }
 
 export namespace RouteInternals {

package/src/core/routing/respond.ts

@@ -1,6 +1,6 @@
-import { ApplicationCommandType, ComponentType, InteractionContextType, InteractionResponseType, InteractionType, MessageFlags, type APIUser } from "discord-api-types/v10"
+import { ApplicationCommandType, InteractionContextType, InteractionResponseType, InteractionType, MessageFlags, type APIUser } from "discord-api-types/v10"
 import { disableAllComponents } from "../../components"
-import { isComponent, renderComponentList } from "../../components/component"
+import { ComponentType, isComponent, renderComponent, renderComponentList, type CordoComponent } from "../../components/component"
 import type { RouteInternals, RouteRequest, RouteResponse } from "../files/route"
 import { InteractionInternals, type CordoInteraction } from "../interaction"
 import { CordoMagic } from "../magic"
@@ -60,6 +60,23 @@ export namespace RoutingRespond {
     }
   }
 
+  export function renderModal(modal: CordoComponent<'Modal'>) {
+    CordoMagic.resetIdCounter()
+    const rendered = renderComponent(modal, null)
+
+    if (!rendered || rendered.type !== ComponentType.Modal)
+      return null
+
+    return {
+      type: InteractionResponseType.Modal,
+      data: {
+        custom_id: rendered.custom_id,
+        title: rendered.title,
+        components: rendered.components,
+      }
+    }
+  }
+
   export function buildRouteRequest(
     route: RouteInternals.ParsedRoute,
     args: string[],
@@ -117,6 +134,10 @@ export namespace RoutingRespond {
         const rendered = renderRouteResponse(response, interaction, opts)
         CordoGateway.respondTo(interaction, rendered)
       },
+      prompt: opts.disableRendering ? noOp : (modal) => {
+        const rendered = renderModal(modal)
+        CordoGateway.respondTo(interaction, rendered)
+      },
       goto: opts.disableRendering ? noOp(Promise.resolve(null)) : (...args) => FunctInternals.evalFunct(goto(...args), interaction),
       run: opts.disableRendering ? noOp(Promise.resolve(null)) : (...args) => FunctInternals.evalFunct(run(...args), interaction),
 

package/src/errors/handle.ts

@@ -68,6 +68,7 @@ export namespace HandleErrors {
   }
 
   export function handleNonCordoError(error: any) {
+    console.error('(dev) Non cordo error:')
     console.error(error)
   }