Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Implement base UI types #1009

Merged
merged 1 commit into from Nov 24, 2022
Merged

Implement base UI types #1009

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
60 changes: 30 additions & 30 deletions packages/snaps-ui/src/builder.test.ts
View file
Open in desktop
Expand Up @@ -11,38 +11,38 @@ import { NodeType } from './nodes';

describe('copyable', () => {
it('creates a copyable component', () => {
expect(copyable({ text: 'Hello, world!' })).toStrictEqual({
expect(copyable({ value: 'Hello, world!' })).toStrictEqual({
type: NodeType.Copyable,
text: 'Hello, world!',
value: 'Hello, world!',
});

expect(copyable({ text: 'foo bar' })).toStrictEqual({
expect(copyable({ value: 'foo bar' })).toStrictEqual({
type: NodeType.Copyable,
text: 'foo bar',
value: 'foo bar',
});
});

it('creates a copyable component using the shorthand form', () => {
expect(copyable('Hello, world!')).toStrictEqual({
type: NodeType.Copyable,
text: 'Hello, world!',
value: 'Hello, world!',
});

expect(copyable('foo bar')).toStrictEqual({
type: NodeType.Copyable,
text: 'foo bar',
value: 'foo bar',
});
});

it('validates the args', () => {
// @ts-expect-error - Invalid args.
expect(() => copyable({ text: 'foo', bar: 'baz' })).toThrow(
expect(() => copyable({ value: 'foo', bar: 'baz' })).toThrow(
'Invalid copyable component: At path: bar -- Expected a value of type `never`, but received: `"baz"`.',
);

// @ts-expect-error - Invalid args.
expect(() => copyable({})).toThrow(
'Invalid copyable component: At path: text -- Expected a string, but received: undefined.',
'Invalid copyable component: At path: value -- Expected a string, but received: undefined.',
);
});
});
Expand All @@ -64,59 +64,59 @@ describe('divider', () => {

describe('heading', () => {
it('creates a heading component', () => {
expect(heading({ text: 'Hello, world!' })).toStrictEqual({
expect(heading({ value: 'Hello, world!' })).toStrictEqual({
type: NodeType.Heading,
text: 'Hello, world!',
value: 'Hello, world!',
});

expect(heading({ text: 'foo bar' })).toStrictEqual({
expect(heading({ value: 'foo bar' })).toStrictEqual({
type: NodeType.Heading,
text: 'foo bar',
value: 'foo bar',
});
});

it('creates a heading component using the shorthand form', () => {
expect(heading('Hello, world!')).toStrictEqual({
type: NodeType.Heading,
text: 'Hello, world!',
value: 'Hello, world!',
});

expect(heading('foo bar')).toStrictEqual({
type: NodeType.Heading,
text: 'foo bar',
value: 'foo bar',
});
});

it('validates the args', () => {
// @ts-expect-error - Invalid args.
expect(() => heading({ text: 'foo', bar: 'baz' })).toThrow(
expect(() => heading({ value: 'foo', bar: 'baz' })).toThrow(
'Invalid heading component: At path: bar -- Expected a value of type `never`, but received: `"baz"`.',
);

// @ts-expect-error - Invalid args.
expect(() => heading({})).toThrow(
'Invalid heading component: At path: text -- Expected a string, but received: undefined.',
'Invalid heading component: At path: value -- Expected a string, but received: undefined.',
);
});
});

describe('panel', () => {
it('creates a panel component', () => {
expect(
panel({ children: [heading({ text: 'Hello, world!' })] }),
panel({ children: [heading({ value: 'Hello, world!' })] }),
).toStrictEqual({
type: NodeType.Panel,
children: [
{
type: NodeType.Heading,
text: 'Hello, world!',
value: 'Hello, world!',
},
],
});

expect(
panel({
children: [panel({ children: [heading({ text: 'Hello, world!' })] })],
children: [panel({ children: [heading({ value: 'Hello, world!' })] })],
}),
).toStrictEqual({
type: NodeType.Panel,
Expand All @@ -126,7 +126,7 @@ describe('panel', () => {
children: [
{
type: NodeType.Heading,
text: 'Hello, world!',
value: 'Hello, world!',
},
],
},
Expand All @@ -140,7 +140,7 @@ describe('panel', () => {
children: [
{
type: NodeType.Heading,
text: 'Hello, world!',
value: 'Hello, world!',
},
],
});
Expand All @@ -153,7 +153,7 @@ describe('panel', () => {
children: [
{
type: NodeType.Heading,
text: 'Hello, world!',
value: 'Hello, world!',
},
],
},
Expand Down Expand Up @@ -206,38 +206,38 @@ describe('spinner', () => {

describe('text', () => {
it('creates a text component', () => {
expect(text({ text: 'Hello, world!' })).toStrictEqual({
expect(text({ value: 'Hello, world!' })).toStrictEqual({
type: NodeType.Text,
text: 'Hello, world!',
value: 'Hello, world!',
});

expect(text({ text: 'foo bar' })).toStrictEqual({
expect(text({ value: 'foo bar' })).toStrictEqual({
type: NodeType.Text,
text: 'foo bar',
value: 'foo bar',
});
});

it('creates a text component using the shorthand form', () => {
expect(text('Hello, world!')).toStrictEqual({
type: NodeType.Text,
text: 'Hello, world!',
value: 'Hello, world!',
});

expect(text('foo bar')).toStrictEqual({
type: NodeType.Text,
text: 'foo bar',
value: 'foo bar',
});
});

it('validates the args', () => {
// @ts-expect-error - Invalid args.
expect(() => text({ text: 'foo', bar: 'baz' })).toThrow(
expect(() => text({ value: 'foo', bar: 'baz' })).toThrow(
'Invalid text component: At path: bar -- Expected a value of type `never`, but received: `"baz"`.',
);

// @ts-expect-error - Invalid args.
expect(() => text({})).toThrow(
'Invalid text component: At path: text -- Expected a string, but received: undefined.',
'Invalid text component: At path: value -- Expected a string, but received: undefined.',
);
});
});
8 changes: 5 additions & 3 deletions packages/snaps-ui/src/builder.ts
View file
Open in desktop
Expand Up @@ -101,7 +101,7 @@ function createBuilder<
* @returns A {@link Copyable} component.
*/
export const copyable = createBuilder(NodeType.Copyable, CopyableStruct, [
'text',
'value',
]);

/**
Expand All @@ -128,7 +128,9 @@ export const divider = createBuilder(NodeType.Divider, DividerStruct);
* const node = heading('Hello, world!');
* ```
*/
export const heading = createBuilder(NodeType.Heading, HeadingStruct, ['text']);
export const heading = createBuilder(NodeType.Heading, HeadingStruct, [
'value',
]);

/**
* Create a {@link Panel} node.
Expand Down Expand Up @@ -190,4 +192,4 @@ export const spinner = createBuilder(NodeType.Spinner, SpinnerStruct);
* const node = text('Hello, world!');
* ```
*/
export const text = createBuilder(NodeType.Text, TextStruct, ['text']);
export const text = createBuilder(NodeType.Text, TextStruct, ['value']);