@valbuild/next 0.50.0 → 0.51.0

package/README.md

@@ -159,9 +159,9 @@ npm install @valbuild/next@latest
 
 import { initVal } from "@valbuild/next";
 
-const { s, val } = initVal();
+const { s, val, config } = initVal();
 
-export { s, val };
+export { s, val, config };
 ```
 
 - Create the endpoints file:
@@ -501,6 +501,46 @@ const image = useVal(imageVal);
 return <img src={image.url} />;
 ```
 
+## Union
+
+The union schema can be used to create either "tagged unions" or a union of string literals.
+
+### Union Schema tagged unions
+
+A tagged union is a union of objects which all have the same field (of the same type). This field can be used to determine (or "discriminate") the exact type of one of the types of the union.
+
+It is useful when editors should be able to chose from a set of objects that are different.
+
+Example: let us say you have a page that can be one of the following: blog (page) or product (page). In this case your schema could look like this:
+
+```ts
+s.union(
+  "type", // the key of the "discriminator"
+  s.object({
+    type: s.literal("blogPage"), // <- each type must have a UNIQUE value
+    author: s.string(),
+    // ...
+  }),
+  s.object({
+    type: s.literal("productPage"),
+    sku: s.number(),
+    // ...
+  })
+); // <- Schema<{ type: "blogPage", author: string } | { type: "productPage", sku: number }>
+```
+
+## Union Schema: union of string literals
+
+You can also use a union to create a union of string literals. This is useful if you want a type-safe way to describe a set of valid strings that can be chosen by an editor.
+
+```ts
+s.union(
+  s.literal("one"),
+  s.literal("two")
+  //...
+); // <- Schema<"one" | "two">
+```
+
 ## KeyOf
 
 If you need to reference content in another `.val` file you can use the `keyOf` schema.

package/dist/ValApp-09d3eba7.cjs.js

@@ -0,0 +1,7 @@
+'use strict';
+
+if (process.env.NODE_ENV === "production") {
+  module.exports = require("./ValApp-09d3eba7.cjs.prod.js");
+} else {
+  module.exports = require("./ValApp-09d3eba7.cjs.dev.js");
+}

package/dist/ValApp-09d3eba7.cjs.prod.js

@@ -0,0 +1,37 @@
+'use client';
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var ui = require('@valbuild/ui');
+var Script = require('next/script');
+var jsxRuntime = require('react/jsx-runtime');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
+
+var Script__default = /*#__PURE__*/_interopDefault(Script);
+
+function _objectDestructuringEmpty(obj) {
+  if (obj == null) throw new TypeError("Cannot destructure " + obj);
+}
+
+var ValApp = function ValApp(_ref) {
+  _objectDestructuringEmpty(_ref);
+  var route = "/api/val";
+  return /*#__PURE__*/jsxRuntime.jsxs("div", {
+    children: [/*#__PURE__*/jsxRuntime.jsx("link", {
+      rel: "stylesheet",
+      href: "".concat(route , "/static").concat(ui.VAL_CSS_PATH)
+    }), ui.IS_DEV && /*#__PURE__*/jsxRuntime.jsx(Script__default["default"], {
+      type: "module",
+      children: "import RefreshRuntime from \"".concat(route, "/static/@react-refresh\"\nif (RefreshRuntime.injectIntoGlobalHook) {\n  RefreshRuntime.injectIntoGlobalHook(window)\n  window.$RefreshReg$ = () => {}\n  window.$RefreshSig$ = () => (type) => type\n  window.__vite_plugin_react_preamble_installed__ = true\n}")
+    }), /*#__PURE__*/jsxRuntime.jsx(Script__default["default"], {
+      type: "module",
+      src: "".concat(route, "/static").concat(ui.VAL_APP_PATH)
+    }), /*#__PURE__*/jsxRuntime.jsx("div", {
+      id: ui.VAL_APP_ID
+    })]
+  });
+};
+
+exports.ValApp = ValApp;

package/dist/ValApp-6827827a.esm.js

@@ -0,0 +1,29 @@
+'use client';
+import { VAL_CSS_PATH, IS_DEV, VAL_APP_PATH, VAL_APP_ID } from '@valbuild/ui';
+import Script from 'next/script';
+import { jsxs, jsx } from 'react/jsx-runtime';
+
+function _objectDestructuringEmpty(obj) {
+  if (obj == null) throw new TypeError("Cannot destructure " + obj);
+}
+
+var ValApp = function ValApp(_ref) {
+  _objectDestructuringEmpty(_ref);
+  var route = "/api/val";
+  return /*#__PURE__*/jsxs("div", {
+    children: [/*#__PURE__*/jsx("link", {
+      rel: "stylesheet",
+      href: "".concat(route , "/static").concat(VAL_CSS_PATH)
+    }), IS_DEV && /*#__PURE__*/jsx(Script, {
+      type: "module",
+      children: "import RefreshRuntime from \"".concat(route, "/static/@react-refresh\"\nif (RefreshRuntime.injectIntoGlobalHook) {\n  RefreshRuntime.injectIntoGlobalHook(window)\n  window.$RefreshReg$ = () => {}\n  window.$RefreshSig$ = () => (type) => type\n  window.__vite_plugin_react_preamble_installed__ = true\n}")
+    }), /*#__PURE__*/jsx(Script, {
+      type: "module",
+      src: "".concat(route, "/static").concat(VAL_APP_PATH)
+    }), /*#__PURE__*/jsx("div", {
+      id: VAL_APP_ID
+    })]
+  });
+};
+
+export { ValApp };

package/dist/ValApp-cbf9b1c3.cjs.dev.js

@@ -0,0 +1,37 @@
+'use client';
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var ui = require('@valbuild/ui');
+var Script = require('next/script');
+var jsxRuntime = require('react/jsx-runtime');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
+
+var Script__default = /*#__PURE__*/_interopDefault(Script);
+
+function _objectDestructuringEmpty(obj) {
+  if (obj == null) throw new TypeError("Cannot destructure " + obj);
+}
+
+var ValApp = function ValApp(_ref) {
+  _objectDestructuringEmpty(_ref);
+  var route = "/api/val";
+  return /*#__PURE__*/jsxRuntime.jsxs("div", {
+    children: [/*#__PURE__*/jsxRuntime.jsx("link", {
+      rel: "stylesheet",
+      href: "".concat(route , "/static").concat(ui.VAL_CSS_PATH)
+    }), ui.IS_DEV && /*#__PURE__*/jsxRuntime.jsx(Script__default["default"], {
+      type: "module",
+      children: "import RefreshRuntime from \"".concat(route, "/static/@react-refresh\"\nif (RefreshRuntime.injectIntoGlobalHook) {\n  RefreshRuntime.injectIntoGlobalHook(window)\n  window.$RefreshReg$ = () => {}\n  window.$RefreshSig$ = () => (type) => type\n  window.__vite_plugin_react_preamble_installed__ = true\n}")
+    }), /*#__PURE__*/jsxRuntime.jsx(Script__default["default"], {
+      type: "module",
+      src: "".concat(route, "/static").concat(ui.VAL_APP_PATH)
+    }), /*#__PURE__*/jsxRuntime.jsx("div", {
+      id: ui.VAL_APP_ID
+    })]
+  });
+};
+
+exports.ValApp = ValApp;

package/dist/declarations/src/ValApp.d.ts

@@ -0,0 +1,4 @@
+import { ValConfig } from "@valbuild/core";
+export declare const ValApp: ({}: {
+    config: ValConfig;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/declarations/src/index.d.ts

@@ -16,6 +16,7 @@ export { ValRichText } from "@valbuild/react/internal";
 export { type ValEncodedString, type Image } from "@valbuild/react/stega";
 export { ValProvider } from "./ValProvider.js";
 export { ValImage, type ValImageProps } from "./ValImage.js";
+export { ValApp } from "./ValApp.js";
 export { initVal } from "./initVal.js";
 import type { UseValType } from "./client/initValClient.js";
 import { Schema, SelectorSource } from "@valbuild/core";

package/dist/valbuild-next.cjs.dev.js

@@ -8,6 +8,7 @@ var ValNextProvider = require('./ValNextProvider-49d2bec1.cjs.dev.js');
 var NextImage = require('next/image');
 var stega = require('@valbuild/react/stega');
 var jsxRuntime = require('react/jsx-runtime');
+var ValApp = require('./ValApp-cbf9b1c3.cjs.dev.js');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
 
@@ -214,6 +215,10 @@ Object.defineProperty(exports, 'ValRichText', {
   enumerable: true,
   get: function () { return internal.ValRichText; }
 });
+Object.defineProperty(exports, 'ValApp', {
+  enumerable: true,
+  get: function () { return ValApp.ValApp; }
+});
 exports.ValImage = ValImage;
 exports.ValProvider = ValProvider;
 exports.initVal = initVal;

package/dist/valbuild-next.cjs.prod.js

@@ -8,6 +8,7 @@ var ValNextProvider = require('./ValNextProvider-7750e412.cjs.prod.js');
 var NextImage = require('next/image');
 var stega = require('@valbuild/react/stega');
 var jsxRuntime = require('react/jsx-runtime');
+var ValApp = require('./ValApp-09d3eba7.cjs.prod.js');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
 
@@ -214,6 +215,10 @@ Object.defineProperty(exports, 'ValRichText', {
   enumerable: true,
   get: function () { return internal.ValRichText; }
 });
+Object.defineProperty(exports, 'ValApp', {
+  enumerable: true,
+  get: function () { return ValApp.ValApp; }
+});
 exports.ValImage = ValImage;
 exports.ValProvider = ValProvider;
 exports.initVal = initVal;

package/dist/valbuild-next.esm.js

@@ -7,6 +7,7 @@ import { ValNextProvider } from './ValNextProvider-c5c9fcb0.esm.js';
 import NextImage from 'next/image';
 import { stegaClean, stegaDecodeString, autoTagJSX } from '@valbuild/react/stega';
 import { jsx } from 'react/jsx-runtime';
+export { ValApp } from './ValApp-6827827a.esm.js';
 
 var ValProvider = ValNextProvider;
 

package/package.json

@@ -8,7 +8,7 @@
     "next",
     "react"
   ],
-  "version": "0.50.0",
+  "version": "0.51.0",
   "scripts": {
     "typecheck": "tsc --noEmit",
     "test": "jest"
@@ -45,9 +45,10 @@
     "exports": true
   },
   "dependencies": {
-    "@valbuild/core": "~0.50.0",
-    "@valbuild/react": "~0.50.0",
-    "@valbuild/server": "~0.50.0",
+    "@valbuild/core": "~0.51.0",
+    "@valbuild/react": "~0.51.0",
+    "@valbuild/server": "~0.51.0",
+    "@valbuild/ui": "~0.51.0",
     "client-only": "^0.0.1",
     "server-only": "^0.0.1"
   },