@csg-org/document-core 0.0.7-alpha.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Waypoint (Metaccountant, Inc.)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,53 @@
+# @usewaypoint/document-core
+
+This is the core library used to build the email messages at [Waypoint](https://www.usewaypoint.com). It is non-opinionated and light on dependencies so that it can be used to compose complex documents.
+
+> [!WARNING]
+> This library is still under development and the final interface is subject
+> to change
+
+## Installation
+
+**Installation with npm**
+
+```
+npm install --save @usewaypoint/document-core
+```
+
+## Usage
+
+The root of the library is the `DocumentBlocksDictionary` dictionary. This is a mapping of block names to an object with a zod schema and a corresponding React Component.
+
+```
+const dictionary = {
+  Alert: {
+    schema: z.object({
+      message: z.string(),
+    }),
+    Component: ({ message }: { message: string }) => {
+      return <div>{message.toUpperCase()}</div>
+    }
+  }
+}
+```
+
+This dictionary object is passed as an argument to the builder functions.
+
+### `buildBlockComponent`
+
+```
+const Block = buildBlockComponent(dictionary);
+
+<Block type="Alert" data={{message: 'Hello World' }} />
+```
+
+### `buildBlockConfigurationSchema`
+
+```
+const Schema = buildBlockConfigurationSchema(dictionary);
+
+const parsedData = Schema.safeParse({
+  type: 'Alert',
+  data: { message: 'Hello World' },
+});
+```

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@csg-org/document-core",
+  "version": "0.0.7-alpha.3",
+  "description": "Tools to render waypoint-style documents (core package)",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "npx tsup src/index.ts --format cjs,esm --dts --clean"
+  },
+  "author": "carlos@usewaypoint.com",
+  "license": "MIT",
+  "peerDependencies": {
+    "react": "^16 || ^17 || ^18",
+    "zod": "^1 || ^2 || ^3"
+  }
+}