npm - @valbuild/next - Versions diffs - 0.53.0 → 0.54.0 - Mend

@valbuild/next 0.53.0 → 0.54.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/README.md +16 -84
package/dist/declarations/src/index.d.ts +1 -4
package/dist/declarations/src/types.d.ts +4 -0
package/dist/valbuild-next.cjs.dev.js +2 -0
package/dist/valbuild-next.cjs.prod.js +2 -0
package/dist/valbuild-next.esm.js +2 -0
package/package.json +5 -5

package/README.md CHANGED Viewed

@@ -146,89 +146,21 @@ Check out this README or the [examples](./examples) directory for examples.
 ## Installation
 - Make sure you have TypeScript 5+, Next 13.4+ (other meta frameworks will come), React 18.20.+ (other frontend frameworks will come)
-- Install the package:
+- Install the packages (@valbuild/eslint-plugin is recommended but not required):
 ```sh
-npm install @valbuild/next@latest
+npm install @valbuild/next@latest @valbuild/eslint-plugin@latest
 ```
-- Create a `val.config.ts` file. **NOTE**: this file should be in the same directory as `tsconfig.json`:
+- Run the init script:
-```ts
-// ./val.config.ts
-import { initVal } from "@valbuild/next";
-const { s, val, config } = initVal();
-export { s, val, config };
-```
-- Create the endpoints file:
-```ts
-// ./src/pages/api/val/[...val].ts
-import { createRequestListener } from "@valbuild/server";
-import { NextApiHandler } from "next";
-const handler: NextApiHandler = createRequestListener("/api/val", {
-  valConfigPath: "./val.config",
-});
-export default handler;
-export const config = {
-  api: {
-    responseLimit: false,
-    bodyParser: false,
-    externalResolver: true,
-  },
-};
-```
-- Use the Val provider in the root layout file:
-```tsx
-// ./app/layout.tsx
-import { ValProvider } from "@valbuild/next";
-export default function RootLayout({
-  children,
-}: {
-  children: React.ReactNode;
-}) {
-  return (
-    <html lang="en">
-      <body className={inter.className}>
-        <ValProvider> {children}</ValProvider>
-      </body>
-    </html>
-  );
-}
-```
-### [OPTIONAL]: Setup eslint
-Install the eslint package:
-```bash
-npm install @valbuild/eslint-plugin@latest
-```
-Add the following to your `.eslintrc.json`:
-```json
-  "plugins": ["@valbuild"],
-  "rules": {
-    "@valbuild/no-illegal-module-ids": "error"
-  }
+```sh
+npx @valbuild/init
 ```
 ### Add editor support
-To make it possible to do non-local edits, head over to [val.build](https://val.build) and import your repository.
+To make it possible to do non-local edits, head over to [val.build](https://val.build), sign up and import your repository.
 **NOTE**: your content is yours. No subscription (or similar) is required to host content from your repository.
@@ -244,11 +176,11 @@ Content in Val is always defined in `.val.ts` files.
 **NOTE**: Val also works with `.js` files.
-They must export a default `val.content` where the first argument equals the path of the file relative to the `val.config.ts` file.
+They must export a default content definition (`c.define`) where the first argument equals the path of the file relative to the `val.config.ts` file.
 **NOTE**: `val.ts` files are _evaluated_ by Val, therefore they have a specific set of requirements:
-- They must have a default export that is `val.content`, they must have a `export const schema` with the Schema; and
+- They must have a default export that is `c.define`, they must have a `export const schema` with the Schema; and
 - they CANNOT import anything other than `val.config` and `@valbuild/core`
 ### Example of a `.val.ts` file
@@ -256,7 +188,7 @@ They must export a default `val.content` where the first argument equals the pat
 ```ts
 // ./src/app/content.val.ts
-import { s, val } from "../../../val.config";
+import { s, c } from "../../../val.config";
 export const schema = s.object({
   title: s.string().optional(), //  <- NOTE: optional()
@@ -270,7 +202,7 @@ export const schema = s.object({
   ),
 });
-export default val.content(
+export default c.define(
   "/src/app/content", // <- NOTE: this must be the same path as the file
   schema,
   {
@@ -278,7 +210,7 @@ export default val.content(
     sections: [
       {
         title: "Section 1",
-        text: val.richtext`
+        text: c.richtext`
 RichText is **awesome**`,
       },
     ],
@@ -413,7 +345,7 @@ s.richtext({
 To initialize some text content using a RichText schema, you can use follow the example below:
 ```ts
-import { s, val } from "./val.config";
+import { s, c } from "./val.config";
 export const schema = s.richtext({
   // styling:
@@ -428,10 +360,10 @@ export const schema = s.richtext({
   //ol: true, // enables ordered lists
 });
-export default val.content(
+export default c.define(
   "/src/app/content",
   schema,
-  val.richtext`
+  c.richtext`
 NOTE: this is markdown.
 **Bold** text.
@@ -479,11 +411,11 @@ s.image();
 Local images must be stored under the `.public` folder.
 ```ts
-import { s, val } from "../val.config";
+import { s, c } from "../val.config";
 export const schema = s.image();
-export default val.content("/image", schema, val.file("/public/myfile.jpg"));
+export default c.define("/image", schema, c.file("/public/myfile.jpg"));
 ```
 **NOTE**: This will not validate, since images requires `width`, `height` and a `sha256` checksum. You can fix this validation in the UI by opening the image and clicking the Fix button.

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

@@ -18,7 +18,4 @@ 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";
-import { SelectorOfSchema } from "@valbuild/core";
-export type InferSchemaType<S extends Schema<SelectorSource>> = UseValType<SelectorOfSchema<S>>;
+export type * as t from "./types.js";

package/dist/declarations/src/types.d.ts ADDED Viewed

@@ -0,0 +1,4 @@
+import type { UseValType } from "./client/initValClient.js";
+import { Schema, SelectorSource } from "@valbuild/core";
+import { SelectorOfSchema } from "@valbuild/core";
+export type inferSchema<S extends Schema<SelectorSource>> = UseValType<SelectorOfSchema<S>>;

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

@@ -168,6 +168,7 @@ function ValImage(props) {
 var initVal = function initVal(config) {
   var _createValSystem = core.initVal(),
     s = _createValSystem.s,
+    c = _createValSystem.c,
     val = _createValSystem.val,
     systemConfig = _createValSystem.config;
   var currentConfig = _objectSpread2(_objectSpread2(_objectSpread2({}, systemConfig), config), {}, {
@@ -175,6 +176,7 @@ var initVal = function initVal(config) {
   });
   return {
     s: s,
+    c: c,
     val: _objectSpread2(_objectSpread2({}, val), {}, {
       decodeValPathOfString: decodeValPathOfString,
       raw: raw

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

@@ -168,6 +168,7 @@ function ValImage(props) {
 var initVal = function initVal(config) {
   var _createValSystem = core.initVal(),
     s = _createValSystem.s,
+    c = _createValSystem.c,
     val = _createValSystem.val,
     systemConfig = _createValSystem.config;
   var currentConfig = _objectSpread2(_objectSpread2(_objectSpread2({}, systemConfig), config), {}, {
@@ -175,6 +176,7 @@ var initVal = function initVal(config) {
   });
   return {
     s: s,
+    c: c,
     val: _objectSpread2(_objectSpread2({}, val), {}, {
       decodeValPathOfString: decodeValPathOfString,
       raw: raw

package/dist/valbuild-next.esm.js CHANGED Viewed

@@ -144,6 +144,7 @@ function ValImage(props) {
 var initVal = function initVal(config) {
   var _createValSystem = initVal$1(),
     s = _createValSystem.s,
+    c = _createValSystem.c,
     val = _createValSystem.val,
     systemConfig = _createValSystem.config;
   var currentConfig = _objectSpread2(_objectSpread2(_objectSpread2({}, systemConfig), config), {}, {
@@ -151,6 +152,7 @@ var initVal = function initVal(config) {
   });
   return {
     s: s,
+    c: c,
     val: _objectSpread2(_objectSpread2({}, val), {}, {
       decodeValPathOfString: decodeValPathOfString,
       raw: raw

package/package.json CHANGED Viewed

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