@valbuild/core 0.87.4 → 0.88.0

package/README.md

@@ -0,0 +1,5 @@
+# @valbuild/core
+
+Core library for Val, providing schema definitions and content validation for type-safe, hard-coded content management.
+
+See the [documentation](https://val.build/docs) for more information.

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

@@ -52,7 +52,7 @@ export { type SerializedRichTextSchema, RichTextSchema, } from "./schema/richtex
 export { type SerializedUnionSchema, UnionSchema, type SerializedStringUnionSchema, type SerializedObjectUnionSchema, } from "./schema/union.js";
 export { type SerializedLiteralSchema, LiteralSchema } from "./schema/literal.js";
 export { deserializeSchema } from "./schema/deserialize.js";
-export { type ListRecordRender, type ListArrayRender, type ReifiedRender, } from "./render.js";
+export { type ListRecordRender, type ListArrayRender, type ReifiedRender, type CodeLanguage, type CodeRender, } from "./render.js";
 export type { ValRouter, RouteValidationError } from "./router.js";
 export declare const FATAL_ERROR_TYPES: readonly ["no-schema", "no-source", "invalid-id", "no-module", "invalid-patch"];
 export type FatalErrorType = (typeof FATAL_ERROR_TYPES)[number];

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

@@ -12,12 +12,83 @@ import { record } from "./schema/record.js";
 import { file } from "./schema/file.js";
 import { date } from "./schema/date.js";
 export type InitSchema = {
+    /**
+     * Define a string.
+     *
+     * @example
+     * const schema = s.string();
+     * export default c.define("/example.val.ts", schema, "test");
+     *
+     */
     readonly string: typeof string;
+    /**
+     * Define a boolean.
+     *
+     * @example
+     * const schema = s.boolean();
+     * export default c.define("/example.val.ts", schema, true);
+     *
+     */
     readonly boolean: typeof boolean;
+    /**
+     * Define an array.
+     *
+     * @example
+     * const schema = s.array(s.string());
+     * export default c.define("/example.val.ts", schema, ["test", "test2"]);
+     *
+     */
     readonly array: typeof array;
+    /**
+     * Define an object.
+     *
+     * @example
+     * const schema = s.object({
+     *  text: s.string(),
+     * });
+     * export default c.define("/example.val.ts", schema, { text: "test" });
+     */
     readonly object: typeof object;
+    /**
+     * Define a number.
+     *
+     * @example
+     * const schema = s.number();
+     * export default c.define("/example.val.ts", schema, 1);
+     *
+     */
     readonly number: typeof number;
+    /**
+     * Define a union.
+     *
+     * @example // union of string literals
+     * const schema = s.union(s.literal("test"), s.literal("test2"));
+     * export default c.define("/example.val.ts", schema, "test");
+     *
+     * @example // union of string literals
+     * const schema = s.union("type", s.object({
+     *   type: s.literal("test"),
+     *   value: s.string()
+     * }), s.object({
+     *   type: s.literal("test2"),
+     *   value: s.string()
+     * }));
+     * export default c.define("/example.val.ts", schema, {
+     *   type: "test",
+     *   value: "test"
+     * });
+     *
+     */
     readonly union: typeof union;
+    /**
+     * Define a rich text.
+     *
+     * @example
+     * const schema = s.richtext();
+     * export default c.define("/example.val.ts", schema, [
+     *   { tag: "h1", children: ["Title 1"] },
+     * ]);
+     */
     readonly richtext: typeof richtext;
     /**
      * Define an image.
@@ -38,10 +109,52 @@ export type InitSchema = {
      *
      */
     readonly image: typeof image;
+    /**
+     * Define a literal.
+     *
+     * @example
+     * const schema = s.literal("test");
+     * export default c.define("/example.val.ts", schema, "test");
+     *
+     */
     readonly literal: typeof literal;
+    /**
+     * Define a key of.
+     *
+     * @example
+     * const schema = s.keyOf(s.string());
+     * export default c.define("/example.val.ts", schema, "test");
+     *
+     */
     readonly keyOf: typeof keyOf;
+    /**
+     * Define a record.
+     *
+     * @example
+     * const schema = s.record(s.string());
+     * export default c.define("/example.val.ts", schema, { "test": "test" });
+     *
+     */
     readonly record: typeof record;
+    /**
+     * Define a file.
+     *
+     * Use `c.file` to create a file source.
+     *
+     * @example
+     * const schema = s.file();
+     * export default c.define("/example.val.ts", schema, c.file("/public/val/example.png"));
+     *
+     */
     readonly file: typeof file;
+    /**
+     * Define a date.
+     *
+     * @example
+     * const schema = s.date();
+     * export default c.define("/example.val.ts", schema, "2025-01-01");
+     *
+     */
     readonly date: typeof date;
 };
 export declare function initSchema(): {

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

@@ -28,7 +28,12 @@ export type ListArrayRender = {
 export type TextareaRender = {
     layout: "textarea";
 };
-type RenderTypes = ListRecordRender | ListArrayRender | TextareaRender;
+export type CodeLanguage = "typescript" | "javascript" | "javascriptreact" | "typescriptreact" | "json" | "java" | "html" | "css" | "xml" | "markdown" | "sql" | "python" | "rust" | "php" | "go" | "cpp" | "sass" | "vue" | "angular";
+export type CodeRender = {
+    layout: "code";
+    language: CodeLanguage;
+};
+type RenderTypes = ListRecordRender | ListArrayRender | TextareaRender | CodeRender;
 type WithStatus<T> = {
     status: "error";
     message: string;

package/dist/declarations/src/schema/string.d.ts

@@ -1,5 +1,5 @@
 import { Schema, SchemaAssertResult, SerializedSchema } from "./index.js";
-import { ReifiedRender } from "../render.js";
+import { CodeLanguage, ReifiedRender } from "../render.js";
 import { ModuleFilePath, SourcePath } from "../val/index.js";
 import { ValidationErrors } from "./validation/ValidationError.js";
 type StringOptions = {
@@ -36,6 +36,9 @@ export declare class StringSchema<Src extends string | null> extends Schema<Src>
     private readonly renderInput;
     constructor(options?: StringOptions | undefined, opt?: boolean, isRaw?: boolean, customValidateFunctions?: ((src: Src) => false | string)[], renderInput?: {
         as: "textarea";
+    } | {
+        as: "code";
+        language: CodeLanguage;
     } | null);
     /**
      * @deprecated Use `minLength` instead
@@ -56,6 +59,9 @@ export declare class StringSchema<Src extends string | null> extends Schema<Src>
     protected executeSerialize(): SerializedSchema;
     render(input: {
         as: "textarea";
+    } | {
+        as: "code";
+        language: CodeLanguage;
     }): StringSchema<Src>;
     protected executeRender(sourcePath: SourcePath | ModuleFilePath, src: Src): ReifiedRender;
 }

package/dist/{index-2b6db652.esm.js → index-11591a0b.esm.js}

@@ -832,6 +832,15 @@ var StringSchema = /*#__PURE__*/function (_Schema) {
     key: "executeRender",
     value: function executeRender(sourcePath, src) {
       if (this.renderInput) {
+        if (this.renderInput.as === "code") {
+          return _defineProperty({}, sourcePath, {
+            status: "success",
+            data: {
+              layout: this.renderInput.as,
+              language: this.renderInput.language
+            }
+          });
+        }
         return _defineProperty({}, sourcePath, {
           status: "success",
           data: {

package/dist/{index-b20e3bab.cjs.prod.js → index-34063fba.cjs.prod.js}

@@ -834,6 +834,15 @@ var StringSchema = /*#__PURE__*/function (_Schema) {
     key: "executeRender",
     value: function executeRender(sourcePath, src) {
       if (this.renderInput) {
+        if (this.renderInput.as === "code") {
+          return _defineProperty({}, sourcePath, {
+            status: "success",
+            data: {
+              layout: this.renderInput.as,
+              language: this.renderInput.language
+            }
+          });
+        }
         return _defineProperty({}, sourcePath, {
           status: "success",
           data: {

package/dist/{index-e3cd5eca.cjs.dev.js → index-eb1a6b1f.cjs.dev.js}

@@ -834,6 +834,15 @@ var StringSchema = /*#__PURE__*/function (_Schema) {
     key: "executeRender",
     value: function executeRender(sourcePath, src) {
       if (this.renderInput) {
+        if (this.renderInput.as === "code") {
+          return _defineProperty({}, sourcePath, {
+            status: "success",
+            data: {
+              layout: this.renderInput.as,
+              language: this.renderInput.language
+            }
+          });
+        }
         return _defineProperty({}, sourcePath, {
           status: "success",
           data: {

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

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var dist_valbuildCore = require('./index-e3cd5eca.cjs.dev.js');
+var dist_valbuildCore = require('./index-eb1a6b1f.cjs.dev.js');
 require('./result-bb1f436e.cjs.dev.js');
 
 

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

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var dist_valbuildCore = require('./index-b20e3bab.cjs.prod.js');
+var dist_valbuildCore = require('./index-34063fba.cjs.prod.js');
 require('./result-787e35f6.cjs.prod.js');
 
 

package/dist/valbuild-core.esm.js

@@ -1,2 +1,2 @@
-export { A as ArraySchema, B as BooleanSchema, e as DEFAULT_APP_HOST, D as DEFAULT_CONTENT_HOST, f as DEFAULT_VAL_REMOTE_HOST, o as DateSchema, F as FATAL_ERROR_TYPES, g as FILE_REF_PROP, h as FILE_REF_SUBTYPE_TAG, n as FileSchema, G as GenericSelector, l as ImageSchema, I as Internal, K as KeyOfSchema, L as LiteralSchema, M as ModuleFilePathSep, N as NumberSchema, O as ObjectSchema, R as RecordSchema, p as RichTextSchema, S as Schema, k as StringSchema, U as UnionSchema, V as VAL_EXTENSION, j as derefPatch, q as deserializeSchema, i as initVal, m as modules } from './index-2b6db652.esm.js';
+export { A as ArraySchema, B as BooleanSchema, e as DEFAULT_APP_HOST, D as DEFAULT_CONTENT_HOST, f as DEFAULT_VAL_REMOTE_HOST, o as DateSchema, F as FATAL_ERROR_TYPES, g as FILE_REF_PROP, h as FILE_REF_SUBTYPE_TAG, n as FileSchema, G as GenericSelector, l as ImageSchema, I as Internal, K as KeyOfSchema, L as LiteralSchema, M as ModuleFilePathSep, N as NumberSchema, O as ObjectSchema, R as RecordSchema, p as RichTextSchema, S as Schema, k as StringSchema, U as UnionSchema, V as VAL_EXTENSION, j as derefPatch, q as deserializeSchema, i as initVal, m as modules } from './index-11591a0b.esm.js';
 import './result-daff1cae.esm.js';

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@valbuild/core",
-  "version": "0.87.4",
+  "version": "0.88.0",
   "private": false,
   "description": "Val - supercharged hard-coded content",
   "repository": {
     "type": "git",
-    "url": "https://github.com/valbuild/val.git"
+    "url": "git+https://github.com/valbuild/val.git"
   },
   "scripts": {
     "typecheck": "tsc --noEmit",

package/patch/dist/valbuild-core-patch.cjs.dev.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var dist_valbuildCore = require('../../dist/index-e3cd5eca.cjs.dev.js');
+var dist_valbuildCore = require('../../dist/index-eb1a6b1f.cjs.dev.js');
 var result = require('../../dist/result-bb1f436e.cjs.dev.js');
 var util = require('../../dist/util-b213092b.cjs.dev.js');
 

package/patch/dist/valbuild-core-patch.cjs.prod.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var dist_valbuildCore = require('../../dist/index-b20e3bab.cjs.prod.js');
+var dist_valbuildCore = require('../../dist/index-34063fba.cjs.prod.js');
 var result = require('../../dist/result-787e35f6.cjs.prod.js');
 var util = require('../../dist/util-030d8a1f.cjs.prod.js');
 

package/patch/dist/valbuild-core-patch.esm.js

@@ -1,5 +1,5 @@
-import { _ as _typeof, a as _slicedToArray, P as PatchError, s as splitModuleFilePathAndModulePath, b as _createClass, c as _classCallCheck, d as _toConsumableArray } from '../../dist/index-2b6db652.esm.js';
-export { P as PatchError } from '../../dist/index-2b6db652.esm.js';
+import { _ as _typeof, a as _slicedToArray, P as PatchError, s as splitModuleFilePathAndModulePath, b as _createClass, c as _classCallCheck, d as _toConsumableArray } from '../../dist/index-11591a0b.esm.js';
+export { P as PatchError } from '../../dist/index-11591a0b.esm.js';
 import { f as isNonEmpty, e as err, o as ok, m as map, g as flatMap, i as isErr, h as flatMapReduce, j as filterOrElse, k as mapErr, l as map$1, n as all, p as flatten, q as allT } from '../../dist/result-daff1cae.esm.js';
 import { p as pipe } from '../../dist/util-18613e99.esm.js';