Skip to content

A free and open-source block-based email template builder.

Adding buildBlockConfigurationDictionary to document-core (#54)

cohitrecf9b89ae2e37
diff --git a/packages/document-core/package-lock.json b/packages/document-core/package-lock.json
index a90cee9..18f6a2f 100644
--- a/packages/document-core/package-lock.json
+++ b/packages/document-core/package-lock.json
@@ -1,12 +1,12 @@
{
"name": "@usewaypoint/document-core",
- "version": "0.0.2",
+ "version": "0.0.4",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "@usewaypoint/document-core",
- "version": "0.0.2",
+ "version": "0.0.4",
"license": "MIT",
"peerDependencies": {
"react": "^16 || ^17 || ^18",
diff --git a/packages/document-core/package.json b/packages/document-core/package.json
index 2689af6..070692f 100644
--- a/packages/document-core/package.json
+++ b/packages/document-core/package.json
@@ -1,6 +1,6 @@
{
"name": "@usewaypoint/document-core",
- "version": "0.0.2",
+ "version": "0.0.4",
"description": "Tools to render waypoint-style documents (core package)",
"main": "dist/index.js",
"types": "dist/index.d.ts",
diff --git a/packages/document-core/src/builders/buildBlockConfigurationDictionary.ts b/packages/document-core/src/builders/buildBlockConfigurationDictionary.ts
new file mode 100644
index 0000000..de3657f
--- /dev/null
+++ b/packages/document-core/src/builders/buildBlockConfigurationDictionary.ts
@@ -0,0 +1,12 @@
+import { BaseZodDictionary, DocumentBlocksDictionary } from '../utils';
+
+/**
+ * Identity function to type a DocumentBlocksDictionary
+ * @param blocks Main DocumentBlocksDictionary
+ * @returns typed DocumentBlocksDictionary
+ */
+export default function buildBlockConfigurationDictionary<T extends BaseZodDictionary>(
+ blocks: DocumentBlocksDictionary<T>
+) {
+ return blocks;
+}
diff --git a/packages/document-core/src/index.ts b/packages/document-core/src/index.ts
index 02801d2..a1cb39a 100644
--- a/packages/document-core/src/index.ts
+++ b/packages/document-core/src/index.ts
@@ -1,4 +1,5 @@
export { default as buildBlockComponent } from './builders/buildBlockComponent';
export { default as buildBlockConfigurationSchema } from './builders/buildBlockConfigurationSchema';
+export { default as buildBlockConfigurationDictionary } from './builders/buildBlockConfigurationDictionary';
export { BlockConfiguration, DocumentBlocksDictionary } from './utils';
diff --git a/packages/editor-sample/package-lock.json b/packages/editor-sample/package-lock.json
index fb3c6c4..91a82ab 100644
--- a/packages/editor-sample/package-lock.json
+++ b/packages/editor-sample/package-lock.json
@@ -22,7 +22,7 @@
"@usewaypoint/block-image": "^0.0.4",
"@usewaypoint/block-spacer": "^0.0.2",
"@usewaypoint/block-text": "^0.0.2",
- "@usewaypoint/document-core": "^0.0.1",
+ "@usewaypoint/document-core": "^0.0.4",
"codemirror": "^6.0.1",
"highlight.js": "^11.9.0",
"js-beautify": "^1.15.1",
@@ -2102,9 +2102,9 @@
}
},
"node_modules/@usewaypoint/document-core": {
- "version": "0.0.1",
- "resolved": "https://registry.npmjs.org/@usewaypoint/document-core/-/document-core-0.0.1.tgz",
- "integrity": "sha512-DD6h3ObcDPq3POCi3IbjRUCYBUeqnJIzvrZ2gIRGVV4yd0XCXx6to02FDu33rH8zmsLWtx9NOyfXDlchybfzbw==",
+ "version": "0.0.4",
+ "resolved": "https://registry.npmjs.org/@usewaypoint/document-core/-/document-core-0.0.4.tgz",
+ "integrity": "sha512-xlPM5zexUhuRDsSwPVZ8cvemmsffLDb4wxlaAVMXi4ayO7ZHHrc9SiLiBkR8cnfQ3OvnHlZaO8YDsGmnckGqYw==",
"peerDependencies": {
"react": "^16 || ^17 || ^18",
"zod": "^1 || ^2 || ^3"
diff --git a/packages/editor-sample/package.json b/packages/editor-sample/package.json
index bd63c7c..a6b64b8 100644
--- a/packages/editor-sample/package.json
+++ b/packages/editor-sample/package.json
@@ -22,7 +22,7 @@
"@usewaypoint/block-image": "^0.0.4",
"@usewaypoint/block-spacer": "^0.0.2",
"@usewaypoint/block-text": "^0.0.2",
- "@usewaypoint/document-core": "^0.0.1",
+ "@usewaypoint/document-core": "^0.0.4",
"codemirror": "^6.0.1",
"highlight.js": "^11.9.0",
"js-beautify": "^1.15.1",
diff --git a/packages/editor-sample/src/documents/editor/core.tsx b/packages/editor-sample/src/documents/editor/core.tsx
index dbb8075..056119d 100644
--- a/packages/editor-sample/src/documents/editor/core.tsx
+++ b/packages/editor-sample/src/documents/editor/core.tsx
@@ -1,30 +1,32 @@
import React from 'react';
import { z } from 'zod';
-import { Avatar, AvatarProps, AvatarPropsSchema } from '@usewaypoint/block-avatar';
-import { Button, ButtonProps, ButtonPropsSchema } from '@usewaypoint/block-button';
-import { Divider, DividerProps, DividerPropsSchema } from '@usewaypoint/block-divider';
-import { Heading, HeadingProps, HeadingPropsSchema } from '@usewaypoint/block-heading';
-import { Html, HtmlProps, HtmlPropsSchema } from '@usewaypoint/block-html';
-import { Image, ImageProps, ImagePropsSchema } from '@usewaypoint/block-image';
-import { Spacer, SpacerProps, SpacerPropsSchema } from '@usewaypoint/block-spacer';
-import { Text, TextProps, TextPropsSchema } from '@usewaypoint/block-text';
-import { buildBlockComponent, buildBlockConfigurationSchema } from '@usewaypoint/document-core';
+import { Avatar, AvatarPropsSchema } from '@usewaypoint/block-avatar';
+import { Button, ButtonPropsSchema } from '@usewaypoint/block-button';
+import { Divider, DividerPropsSchema } from '@usewaypoint/block-divider';
+import { Heading, HeadingPropsSchema } from '@usewaypoint/block-heading';
+import { Html, HtmlPropsSchema } from '@usewaypoint/block-html';
+import { Image, ImagePropsSchema } from '@usewaypoint/block-image';
+import { Spacer, SpacerPropsSchema } from '@usewaypoint/block-spacer';
+import { Text, TextPropsSchema } from '@usewaypoint/block-text';
+import {
+ buildBlockComponent,
+ buildBlockConfigurationDictionary,
+ buildBlockConfigurationSchema,
+} from '@usewaypoint/document-core';
import { EditorColumnsContainer } from '../blocks/ColumnsContainer';
-import ColumnsContainerPropsSchema, {
- ColumnsContainerProps,
-} from '../blocks/ColumnsContainer/ColumnsContainerPropsSchema';
+import ColumnsContainerPropsSchema from '../blocks/ColumnsContainer/ColumnsContainerPropsSchema';
import { EditorContainer } from '../blocks/Container';
-import { ContainerProps, ContainerPropsSchema } from '../blocks/Container/ContainerPropsSchema';
-import { EditorEmailLayout, EmailLayoutProps } from '../blocks/EmailLayout';
+import { ContainerPropsSchema } from '../blocks/Container/ContainerPropsSchema';
+import { EditorEmailLayout } from '../blocks/EmailLayout';
import { EmailLayoutPropsSchema } from '../blocks/EmailLayout/EmailLayoutPropsSchema';
import EditorBlockWrapper from '../blocks/helpers/block-wrappers/EditorBlockWrapper';
-const EDITOR_DICTIONARY = {
+const EDITOR_DICTIONARY = buildBlockConfigurationDictionary({
Avatar: {
schema: AvatarPropsSchema,
- Component: (props: AvatarProps) => (
+ Component: (props) => (
<EditorBlockWrapper>
<Avatar {...props} />
</EditorBlockWrapper>
@@ -32,7 +34,7 @@ const EDITOR_DICTIONARY = {
},
Button: {
schema: ButtonPropsSchema,
- Component: (props: ButtonProps) => (
+ Component: (props) => (
<EditorBlockWrapper>
<Button {...props} />
</EditorBlockWrapper>
@@ -40,7 +42,7 @@ const EDITOR_DICTIONARY = {
},
Container: {
schema: ContainerPropsSchema,
- Component: (props: ContainerProps) => (
+ Component: (props) => (
<EditorBlockWrapper>
<EditorContainer {...props} />
</EditorBlockWrapper>
@@ -48,7 +50,7 @@ const EDITOR_DICTIONARY = {
},
ColumnsContainer: {
schema: ColumnsContainerPropsSchema,
- Component: (props: ColumnsContainerProps) => (
+ Component: (props) => (
<EditorBlockWrapper>
<EditorColumnsContainer {...props} />
</EditorBlockWrapper>
@@ -56,7 +58,7 @@ const EDITOR_DICTIONARY = {
},
Heading: {
schema: HeadingPropsSchema,
- Component: (props: HeadingProps) => (
+ Component: (props) => (
<EditorBlockWrapper>
<Heading {...props} />
</EditorBlockWrapper>
@@ -64,7 +66,7 @@ const EDITOR_DICTIONARY = {
},
Html: {
schema: HtmlPropsSchema,
- Component: (props: HtmlProps) => (
+ Component: (props) => (
<EditorBlockWrapper>
<Html {...props} />
</EditorBlockWrapper>
@@ -72,7 +74,7 @@ const EDITOR_DICTIONARY = {
},
Image: {
schema: ImagePropsSchema,
- Component: (data: ImageProps) => {
+ Component: (data) => {
const props = {
...data,
props: {
@@ -89,7 +91,7 @@ const EDITOR_DICTIONARY = {
},
Text: {
schema: TextPropsSchema,
- Component: (props: TextProps) => (
+ Component: (props) => (
<EditorBlockWrapper>
<Text {...props} />
</EditorBlockWrapper>
@@ -97,7 +99,7 @@ const EDITOR_DICTIONARY = {
},
EmailLayout: {
schema: EmailLayoutPropsSchema,
- Component: (p: EmailLayoutProps) => (
+ Component: (p) => (
<div style={{ height: '100%' }}>
<EditorEmailLayout {...p} />
</div>
@@ -105,7 +107,7 @@ const EDITOR_DICTIONARY = {
},
Spacer: {
schema: SpacerPropsSchema,
- Component: (props: SpacerProps) => (
+ Component: (props) => (
<EditorBlockWrapper>
<Spacer {...props} />
</EditorBlockWrapper>
@@ -113,13 +115,13 @@ const EDITOR_DICTIONARY = {
},
Divider: {
schema: DividerPropsSchema,
- Component: (props: DividerProps) => (
+ Component: (props) => (
<EditorBlockWrapper>
<Divider {...props} />
</EditorBlockWrapper>
),
},
-};
+});
export const EditorBlock = buildBlockComponent(EDITOR_DICTIONARY);
export const EditorBlockSchema = buildBlockConfigurationSchema(EDITOR_DICTIONARY);
diff --git a/packages/editor-sample/src/documents/reader/core.tsx b/packages/editor-sample/src/documents/reader/core.tsx
index fad1659..f40582b 100644
--- a/packages/editor-sample/src/documents/reader/core.tsx
+++ b/packages/editor-sample/src/documents/reader/core.tsx
@@ -8,7 +8,11 @@ import { Html, HtmlPropsSchema } from '@usewaypoint/block-html';
import { Image, ImagePropsSchema } from '@usewaypoint/block-image';
import { Spacer, SpacerPropsSchema } from '@usewaypoint/block-spacer';
import { Text, TextPropsSchema } from '@usewaypoint/block-text';
-import { buildBlockComponent, buildBlockConfigurationSchema } from '@usewaypoint/document-core';
+import {
+ buildBlockComponent,
+ buildBlockConfigurationDictionary,
+ buildBlockConfigurationSchema,
+} from '@usewaypoint/document-core';
import { ColumnsContainer } from '../blocks/ColumnsContainer';
import ColumnsContainerPropsSchema from '../blocks/ColumnsContainer/ColumnsContainerPropsSchema';
@@ -17,7 +21,7 @@ import { ContainerPropsSchema } from '../blocks/Container/ContainerPropsSchema';
import { EmailLayout } from '../blocks/EmailLayout';
import { EmailLayoutPropsSchema } from '../blocks/EmailLayout/EmailLayoutPropsSchema';
-const READER_DICTIONARY = {
+const READER_DICTIONARY = buildBlockConfigurationDictionary({
Avatar: {
schema: AvatarPropsSchema,
Component: Avatar,
@@ -62,7 +66,7 @@ const READER_DICTIONARY = {
schema: SpacerPropsSchema,
Component: Spacer,
},
-};
+});
const ReaderBlockSchema = buildBlockConfigurationSchema(READER_DICTIONARY);
const ReaderDocumentSchema = z.record(z.string(), ReaderBlockSchema);