@valbuild/next 0.13.4

package/src/hooks/useVal.ts

@@ -0,0 +1,14 @@
+import { GenericSelector, SelectorOf, SelectorSource } from "@valbuild/core";
+import { useVal as useReactVal } from "@valbuild/react";
+import { stegaEncodeVal, StegaOfSource } from "../stegaEncode";
+
+export function useVal<T extends SelectorSource>(
+  selector: T,
+  locale?: string
+): SelectorOf<T> extends GenericSelector<infer S> ? StegaOfSource<S> : never {
+  return stegaEncodeVal(
+    useReactVal(selector, locale)
+  ) as SelectorOf<T> extends GenericSelector<infer S>
+    ? StegaOfSource<S>
+    : never;
+}

package/src/index.ts

@@ -0,0 +1,8 @@
+import "./autoTagJSX";
+
+export { ValProvider } from "@valbuild/react";
+export { useVal } from "./hooks/useVal";
+export { type ValEncodedString } from "./stegaEncode";
+export * from "@valbuild/core";
+export { fetchVal } from "./fetchVal";
+export { ValRichText } from "./ValRichText";

package/src/stegaEncode.ts

@@ -0,0 +1,76 @@
+import { Json, Val, Internal, RichTextSource, RichText } from "@valbuild/core";
+import { vercelStegaCombine } from "@vercel/stega";
+import { FileSource, RemoteSource, Source, SourceObject } from "@valbuild/core";
+import { JsonPrimitive } from "@valbuild/core/src/Json";
+import { SourceArray } from "@valbuild/core/src/source";
+import { I18nSource } from "@valbuild/core/src/source/i18n";
+
+declare const brand: unique symbol;
+
+/**
+ * ValEncodedString is a string that is encoded using steganography.
+ *
+ * This means that there is a hidden / non-visible object embedded in the string.
+ * This object includes a path, which is used to automatically tag
+ * where the content comes from for contextual editing.
+ *
+ */
+export type ValEncodedString = string & {
+  [brand]: "ValEncodedString";
+};
+
+export type StegaOfSource<T extends Source> = Json extends T
+  ? Json
+  : T extends I18nSource<readonly string[], infer U>
+  ? StegaOfSource<U>
+  : T extends RemoteSource<infer U>
+  ? StegaOfSource<U>
+  : T extends RichTextSource
+  ? RichText
+  : T extends FileSource
+  ? { url: ValEncodedString }
+  : T extends SourceObject
+  ? {
+      [key in keyof T]: StegaOfSource<T[key]>;
+    }
+  : T extends SourceArray
+  ? StegaOfSource<T[number]>[]
+  : T extends string
+  ? ValEncodedString
+  : T extends JsonPrimitive
+  ? T
+  : never;
+
+export function stegaEncodeVal<T extends Json>(val: Val<T>): T {
+  if (typeof val.val === "object") {
+    if (Array.isArray(val)) {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      return val.map(stegaEncodeVal) as any;
+    }
+
+    if (
+      typeof val.val === "object" &&
+      val.val &&
+      "_type" in val.val &&
+      val.val["_type"] === "richtext"
+    ) {
+      return {
+        ...val.val,
+        valPath: Internal.getValPath(val),
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      } as any;
+    }
+
+    return Object.fromEntries(
+      Object.entries(val).map(([key, value]) => [key, stegaEncodeVal(value)])
+    ) as T;
+  }
+  if (typeof val.val === "string") {
+    return vercelStegaCombine(val.val, {
+      origin: "app.val.build",
+      data: { valPath: Internal.getValPath(val) },
+    }) as T; // TODO: skip should false at least for URLs? Dates...?
+  }
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  return val.val as any;
+}

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "strict": true,
+    "allowJs": true,
+    "isolatedModules": true,
+    "jsx": "react-jsx",
+    "lib": ["es6", "dom"],
+    "module": "CommonJS",
+    "noEmit": true,
+    "target": "ES5",
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["dist/**"]
+}