Skip to content

Commit

Permalink
Merge branch 'main' into metadata-component
Browse files Browse the repository at this point in the history
  • Loading branch information
@jacobmischka
jacobmischka committed Oct 27, 2022
2 parents 368b3ed + 4c5f2df commit 046933c
Show file tree
Hide file tree
Showing 3 changed files with 184 additions and 151 deletions.
27 changes: 23 additions & 4 deletions src/examples/app/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,29 @@ const hello_app = new Page({
label: 'Hello',
action: 'hello_app/hello_world',
},
// {
// label: 'Inline',
// action: async () => {},
// },
],
}),
io.display.heading('Section two', {
level: 3,
description: 'This table has the same data as the previous one.',
menuItems: [
{
label: 'Action link',
action: 'hello_app/hello_world',
},
],
}),
io.display.table('', {
data: [
{ a: 1, b: 2, c: 3 },
{ a: 1, b: 2, c: 3 },
{ a: 1, b: 2, c: 3 },
],
rowMenuItems: () => [
{
label: 'Hello',
action: 'hello_app/hello_world',
},
],
}),
],
Expand Down
21 changes: 21 additions & 0 deletions src/examples/basic/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,27 @@ const interval = new Interval({
logLevel: 'debug',
endpoint: 'ws://localhost:3000/websocket',
routes: {
section_heading: async io => {
await io.group([
io.display.heading('Section heading', {
level: 2,
description: 'A section heading here',
menuItems: [
{ label: 'Link', url: 'https://interval.com', theme: 'primary' },
{ label: 'Danger', action: 'disabled_inputs', theme: 'danger' },
],
}),
io.input.text('Text input'),
io.input.text('Multiline', {
multiline: true,
}),

io.display.heading('Sub-heading', {
level: 3,
description: 'A subsection',
}),
])
},
disabled_inputs: async io => {
await io.group([
io.display.heading('Here are a bunch of disabled inputs'),
Expand Down
287 changes: 140 additions & 147 deletions src/ioSchema.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,7 @@ export const DISPLAY_RENDER = z.object({
})

// `default` deprecated in 0.31.0
const buttonTheme = z
.enum(['default', 'primary', 'secondary', 'danger'])
.default('primary')
.optional()
const buttonTheme = z.enum(['default', 'primary', 'secondary', 'danger'])
export type ButtonTheme = 'primary' | 'secondary' | 'danger'

export const IO_RENDER = z.object({
Expand All @@ -44,7 +41,7 @@ export const IO_RENDER = z.object({
continueButton: z
.object({
label: z.string().optional(),
theme: buttonTheme,
theme: buttonTheme.optional(),
})
.optional(),
kind: z.literal('RENDER'),
Expand Down Expand Up @@ -230,7 +227,7 @@ export const menuItem = z.intersection(
export const buttonItem = z.intersection(
z.object({
label: z.string(),
theme: buttonTheme,
theme: buttonTheme.optional(),
}),
z.union([
z.object({
Expand Down Expand Up @@ -326,10 +323,136 @@ export const metaItemSchema = z.object({
error: z.string().nullish(),
})

/**
* IMPORTANT: When adding any new DISPLAY methods, be sure to also add their method names to T_IO_DISPLAY_METHOD_NAMES below.
*/
export const ioSchema = {
const DISPLAY_SCHEMA = {
DISPLAY_CODE: {
props: z.object({
code: z.string(),
language: z.string().optional(),
}),
state: z.null(),
returns: z.null(),
},
DISPLAY_HEADING: {
props: z.object({
level: z.union([z.literal(2), z.literal(3), z.literal(4)]).optional(),
description: z.string().optional(),
menuItems: z.array(buttonItem).optional(),
}),
state: z.null(),
returns: z.null(),
},
DISPLAY_METADATA: {
props: z.object({
data: z.array(metaItemSchema),
layout: z.enum(['grid', 'list', 'card']).optional().default('grid'),
}),
state: z.null(),
returns: z.null(),
},
DISPLAY_MARKDOWN: {
props: z.object({}),
state: z.null(),
returns: z.null(),
},
DISPLAY_IMAGE: {
props: z.object({
alt: z.string().optional(),
width: imageSize.optional(),
height: imageSize.optional(),
url: z.string(),
}),
state: z.null(),
returns: z.null(),
},
DISPLAY_LINK: {
props: z.intersection(
z.object({
theme: buttonTheme.optional(),
}),
z.union([
z.object({
href: z.string(),
}),
linkSchema,
])
),
state: z.null(),
returns: z.null(),
},
DISPLAY_OBJECT: {
props: z.object({
data: keyValueObject,
}),
state: z.null(),
returns: z.null(),
},
DISPLAY_TABLE: {
props: z.object({
helpText: z.optional(z.string()),
columns: z.array(internalTableColumn),
data: z.array(internalTableRow),
orientation: z.enum(['vertical', 'horizontal']).default('horizontal'),
defaultPageSize: z.number().optional(),
//== private props
// added in v0.28, optional until required by all active versions
totalRecords: z.optional(z.number().int()),
isAsync: z.optional(z.boolean().default(false)),
}),
state: z.object({
queryTerm: z.string().optional(),
sortColumn: z.string().optional(),
sortDirection: z.enum(['asc', 'desc']).optional(),
offset: z.number().int().default(0),
pageSize: z.number().int(),
}),
returns: z.null(),
},
DISPLAY_PROGRESS_STEPS: {
props: z.object({
steps: z.object({
completed: z.number(),
total: z.number(),
}),
currentStep: z.string().optional(),
subTitle: z.string().optional(),
}),
state: z.null(),
returns: z.null(),
immediate: z.literal(true),
},
DISPLAY_PROGRESS_INDETERMINATE: {
props: z.object({}),
state: z.null(),
returns: z.null(),
immediate: z.literal(true),
},
DISPLAY_PROGRESS_THROUGH_LIST: {
props: z.object({
items: z.array(
z.object({
label: z.string(),
isComplete: z.boolean(),
resultDescription: z.union([z.null(), z.string()]),
})
),
}),
state: z.null(),
returns: z.null(),
},
DISPLAY_VIDEO: {
props: z.object({
width: imageSize.optional(),
height: imageSize.optional(),
url: z.string(),
loop: z.boolean().optional(),
muted: z.boolean().optional(),
}),
state: z.null(),
returns: z.null(),
},
}

const INPUT_SCHEMA = {
INPUT_TEXT: {
props: z.object({
helpText: z.optional(z.string()),
Expand Down Expand Up @@ -547,128 +670,11 @@ export const ioSchema = {
state: z.null(),
returns: z.array(labelValue),
},
DISPLAY_CODE: {
props: z.object({
code: z.string(),
language: z.string().optional(),
}),
state: z.null(),
returns: z.null(),
},
DISPLAY_HEADING: {
props: z.object({}),
state: z.null(),
returns: z.null(),
},
DISPLAY_MARKDOWN: {
props: z.object({}),
state: z.null(),
returns: z.null(),
},
DISPLAY_IMAGE: {
props: z.object({
alt: z.string().optional(),
width: imageSize.optional(),
height: imageSize.optional(),
url: z.string(),
}),
state: z.null(),
returns: z.null(),
},
DISPLAY_LINK: {
props: z.intersection(
z.object({
theme: buttonTheme,
}),
z.union([
z.object({
href: z.string(),
}),
linkSchema,
])
),
state: z.null(),
returns: z.null(),
},
DISPLAY_OBJECT: {
props: z.object({
data: keyValueObject,
}),
state: z.null(),
returns: z.null(),
},
DISPLAY_TABLE: {
props: z.object({
helpText: z.optional(z.string()),
columns: z.array(internalTableColumn),
data: z.array(internalTableRow),
orientation: z.enum(['vertical', 'horizontal']).default('horizontal'),
defaultPageSize: z.number().optional(),
//== private props
// added in v0.28, optional until required by all active versions
totalRecords: z.optional(z.number().int()),
isAsync: z.optional(z.boolean().default(false)),
}),
state: z.object({
queryTerm: z.string().optional(),
sortColumn: z.string().optional(),
sortDirection: z.enum(['asc', 'desc']).optional(),
offset: z.number().int().default(0),
pageSize: z.number().int(),
}),
returns: z.null(),
},
DISPLAY_METADATA: {
props: z.object({
data: z.array(metaItemSchema),
layout: z.enum(['grid', 'list', 'card']).optional().default('grid'),
}),
state: z.null(),
returns: z.null(),
},
DISPLAY_PROGRESS_STEPS: {
props: z.object({
steps: z.object({
completed: z.number(),
total: z.number(),
}),
currentStep: z.string().optional(),
subTitle: z.string().optional(),
}),
state: z.null(),
returns: z.null(),
immediate: z.literal(true),
},
DISPLAY_PROGRESS_INDETERMINATE: {
props: z.object({}),
state: z.null(),
returns: z.null(),
immediate: z.literal(true),
},
DISPLAY_PROGRESS_THROUGH_LIST: {
props: z.object({
items: z.array(
z.object({
label: z.string(),
isComplete: z.boolean(),
resultDescription: z.union([z.null(), z.string()]),
})
),
}),
state: z.null(),
returns: z.null(),
},
DISPLAY_VIDEO: {
props: z.object({
width: imageSize.optional(),
height: imageSize.optional(),
url: z.string(),
loop: z.boolean().optional(),
muted: z.boolean().optional(),
}),
state: z.null(),
returns: z.null(),
},
}

export const ioSchema = {
...DISPLAY_SCHEMA,
...INPUT_SCHEMA,
}

export type IoMethod = {
Expand All @@ -680,21 +686,8 @@ export type IoMethod = {
export type T_IO_Schema = typeof ioSchema
export type T_IO_METHOD_NAMES = keyof T_IO_Schema

export type T_IO_DISPLAY_METHOD_NAMES =
| 'DISPLAY_CODE'
| 'DISPLAY_HEADING'
| 'DISPLAY_MARKDOWN'
| 'DISPLAY_LINK'
| 'DISPLAY_OBJECT'
| 'DISPLAY_METADATA'
| 'DISPLAY_TABLE'
| 'DISPLAY_IMAGE'
| 'DISPLAY_VIDEO'

export type T_IO_INPUT_METHOD_NAMES = Exclude<
T_IO_METHOD_NAMES,
T_IO_DISPLAY_METHOD_NAMES
>
export type T_IO_DISPLAY_METHOD_NAMES = keyof typeof DISPLAY_SCHEMA
export type T_IO_INPUT_METHOD_NAMES = keyof typeof INPUT_SCHEMA

type T_Fields = 'props' | 'state' | 'returns'

Expand Down

0 comments on commit 046933c

Please sign in to comment.