@valbuild/core 0.16.0 → 0.18.0

package/src/{fetchVal.test.ts → future/fetchVal.test.ts}

@@ -1,9 +1,9 @@
-import { initSchema } from "./initSchema";
-import { content } from "./module";
-import { getValPath } from "./val";
+import { initSchema } from "../initSchema";
+import { content } from "../module";
+import { getValPath } from "../val";
 import { serializedValOfSelectorSource, fetchVal } from "./fetchVal";
 
-const s = initSchema(["en_US", "no_NB"]);
+const s = initSchema();
 // const i18n = initI18n(["en_US", "no_NB"]);
 
 describe("serialization of val", () => {
@@ -108,57 +108,57 @@ describe("fetchVal", () => {
     expect(getValPath(test.foo.bar[1])).toStrictEqual('/app."foo"."bar".1');
   });
 
-  test("valuate: array with map", async () => {
-    const schema = s.array(s.string());
-
-    const testVal = content("/app", schema, ["foo", "bar"]);
-
-    const test = await fetchVal({
-      //    ^? should be Val<{ title: string }[]>
-      foo: testVal.map((v) => ({ title: v })),
-      test: testVal,
-    });
-    expect(test.val).toStrictEqual({
-      foo: [{ title: "foo" }, { title: "bar" }],
-      test: ["foo", "bar"],
-    });
-  });
-
-  test("valuate: 2 modules with oneOf", async () => {
-    const testVal1 = content("/testVal1", s.array(s.string()), [
-      "test-val-1-0",
-      "test-val-1-1",
-    ]);
-    const testVal2 = content(
-      "/testVal2",
-      s.object({ test1: s.oneOf(testVal1), test2: s.string() }),
-      {
-        test2: "test2 value",
-        test1: testVal1[0],
-      }
-    );
-
-    const test = await fetchVal({
-      //    ^?
-      testVal1: testVal1.map((v) => ({ title: v, otherModule: testVal2 })),
-      testVal2: testVal2,
-    });
-    expect(test.val).toStrictEqual({
-      testVal1: [
-        {
-          title: "test-val-1-0",
-          otherModule: { test2: "test2 value", test1: "test-val-1-0" },
-        },
-        {
-          title: "test-val-1-1",
-          otherModule: { test2: "test2 value", test1: "test-val-1-0" },
-        },
-      ],
-      testVal2: { test2: "test2 value", test1: "test-val-1-0" },
-    });
-    expect(getValPath(test.testVal1[0].otherModule.test1)).toStrictEqual(
-      "/testVal1.0"
-    );
-    expect(getValPath(test.testVal2.test2)).toStrictEqual('/testVal2."test2"');
-  });
+  // test("valuate: array with map", async () => {
+  //   const schema = s.array(s.string());
+
+  //   const testVal = content("/app", schema, ["foo", "bar"]);
+
+  //   const test = await fetchVal({
+  //     //    ^? should be Val<{ title: string }[]>
+  //     foo: testVal.map((v) => ({ title: v })),
+  //     test: testVal,
+  //   });
+  //   expect(test.val).toStrictEqual({
+  //     foo: [{ title: "foo" }, { title: "bar" }],
+  //     test: ["foo", "bar"],
+  //   });
+  // });
+
+  // test("valuate: 2 modules with oneOf", async () => {
+  //   const testVal1 = content("/testVal1", s.array(s.string()), [
+  //     "test-val-1-0",
+  //     "test-val-1-1",
+  //   ]);
+  //   const testVal2 = content(
+  //     "/testVal2",
+  //     s.object({ test1: s.oneOf(testVal1), test2: s.string() }),
+  //     {
+  //       test2: "test2 value",
+  //       test1: testVal1[0],
+  //     }
+  //   );
+
+  //   const test = await fetchVal({
+  //     //    ^?
+  //     testVal1: testVal1.map((v) => ({ title: v, otherModule: testVal2 })),
+  //     testVal2: testVal2,
+  //   });
+  //   expect(test.val).toStrictEqual({
+  //     testVal1: [
+  //       {
+  //         title: "test-val-1-0",
+  //         otherModule: { test2: "test2 value", test1: "test-val-1-0" },
+  //       },
+  //       {
+  //         title: "test-val-1-1",
+  //         otherModule: { test2: "test2 value", test1: "test-val-1-0" },
+  //       },
+  //     ],
+  //     testVal2: { test2: "test2 value", test1: "test-val-1-0" },
+  //   });
+  //   expect(getValPath(test.testVal1[0].otherModule.test1)).toStrictEqual(
+  //     "/testVal1.0"
+  //   );
+  //   expect(getValPath(test.testVal2.test2)).toStrictEqual('/testVal2."test2"');
+  // });
 });

package/src/{fetchVal.ts → future/fetchVal.ts}

@@ -3,39 +3,36 @@ import {
   Path,
   SelectorOf,
   SelectorSource,
-  SourceOrExpr,
-} from "./selector";
+  GetSource,
+} from "../selector";
 import {
   isSerializedVal,
   JsonOfSource,
   SerializedVal,
   SourcePath,
   Val,
-} from "./val";
+} from "../val";
 import {
   createValPathOfItem,
   isSelector,
   newSelectorProxy,
-} from "./selector/SelectorProxy";
-import { Json } from "./Json";
+} from "../selector/SelectorProxy";
+import { Json } from "../Json";
 
 export function fetchVal<T extends SelectorSource>(
-  selector: T,
-  locale?: string
+  selector: T
 ): SelectorOf<T> extends GenericSelector<infer S>
   ? Promise<Val<JsonOfSource<S>>>
   : never {
   return Promise.resolve(
-    getVal(selector, locale) as unknown
+    getVal(selector) as unknown
   ) as SelectorOf<T> extends GenericSelector<infer S>
     ? Promise<Val<JsonOfSource<S>>>
     : never;
 }
 
 export function getVal<T extends SelectorSource>(
-  selector: T,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  locale?: string
+  selector: T
 ): SelectorOf<T> extends GenericSelector<infer S>
   ? Val<JsonOfSource<S>>
   : never {
@@ -50,9 +47,9 @@ export function getVal<T extends SelectorSource>(
 function isArrayOrArraySelector(child: any) {
   if (isSelector(child)) {
     return (
-      typeof child[SourceOrExpr] === "object" &&
-      typeof child[SourceOrExpr] !== null &&
-      Array.isArray(child[SourceOrExpr])
+      typeof child[GetSource] === "object" &&
+      typeof child[GetSource] !== null &&
+      Array.isArray(child[GetSource])
     );
   }
   return Array.isArray(child);
@@ -62,9 +59,9 @@ function isArrayOrArraySelector(child: any) {
 function isObjectOrObjectSelector(child: any) {
   if (isSelector(child)) {
     return (
-      typeof child[SourceOrExpr] === "object" &&
-      typeof child[SourceOrExpr] !== null &&
-      !Array.isArray(child[SourceOrExpr])
+      typeof child[GetSource] === "object" &&
+      typeof child[GetSource] !== null &&
+      !Array.isArray(child[GetSource])
     );
   }
   return typeof child === "object";
@@ -80,7 +77,7 @@ export function serializedValOfSelectorSource<T extends SelectorSource>(
     const isObject = isObjectOrObjectSelector(child);
     if (isArray) {
       const array = (
-        SourceOrExpr in child ? child[SourceOrExpr] : child
+        GetSource in child ? child[GetSource] : child
       ) as Array<unknown>;
       const valPath = Path in child ? (child[Path] as SourcePath) : undefined;
       return {
@@ -94,9 +91,7 @@ export function serializedValOfSelectorSource<T extends SelectorSource>(
         valPath,
       };
     } else if (isObject) {
-      const obj = (
-        SourceOrExpr in child ? child[SourceOrExpr] : child
-      ) as object;
+      const obj = (GetSource in child ? child[GetSource] : child) as object;
       const valPath = Path in child ? (child[Path] as SourcePath) : undefined;
       return {
         val:
@@ -115,7 +110,7 @@ export function serializedValOfSelectorSource<T extends SelectorSource>(
       };
     } else if (isSelector(child)) {
       return {
-        val: rec(child[SourceOrExpr]),
+        val: rec(child[GetSource]),
         valPath: child[Path],
       };
     } else {

package/src/index.ts

@@ -4,7 +4,6 @@ export { Schema, type SerializedSchema } from "./schema";
 export type { ValModule, SerializedModule } from "./module";
 export type { SourceObject, SourcePrimitive, Source } from "./source";
 export type { FileSource } from "./source/file";
-export type { RemoteSource } from "./source/remote";
 export type {
   RichTextSource,
   RichText,
@@ -31,34 +30,67 @@ export type { ValidationFix } from "./schema/validation/ValidationFix";
 export * as expr from "./expr/";
 export { FILE_REF_PROP } from "./source/file";
 export { VAL_EXTENSION, type SourceArray } from "./source";
-export type { I18nSource } from "./source/i18n";
 export { derefPatch } from "./patch/deref";
 export {
   type SelectorSource,
   type SelectorOf,
   GenericSelector,
 } from "./selector";
-import { getVal } from "./fetchVal";
-import {
-  getRawSource,
-  resolvePath,
-  splitModuleIdAndModulePath,
-} from "./module";
+import { getSource, resolvePath, splitModuleIdAndModulePath } from "./module";
 import { getSchema } from "./selector";
-import { getValPath, isVal } from "./val";
-import { convertImageSource } from "./schema/image";
-import { fetchVal } from "./fetchVal";
+import { ModuleId, ModulePath, getValPath, isVal } from "./val";
+import { convertFileSource } from "./schema/image";
+import { createValPathOfItem } from "./selector/SelectorProxy";
+import { getVal } from "./future/fetchVal";
+import { Json } from "./Json";
+import { SerializedSchema } from "./schema";
+export { ValApi } from "./ValApi";
+
+export type ApiTreeResponse = {
+  git: {
+    commit?: string;
+    branch?: string;
+  };
+  modules: Record<
+    ModuleId,
+    {
+      schema?: SerializedSchema;
+      patches?: {
+        applied: string[];
+        failed?: string[];
+      };
+      source?: Json;
+    }
+  >;
+};
+
+export type ApiPatchResponse = Record<ModuleId, string[]>;
 
 const Internal = {
-  convertImageSource,
+  convertFileSource,
   getSchema,
   getValPath,
   getVal,
-  getRawSource,
+  getSource,
   resolvePath,
   splitModuleIdAndModulePath,
-  fetchVal,
   isVal,
+  createValPathOfItem,
+  createPatchJSONPath: (modulePath: ModulePath) =>
+    `/${modulePath
+      .split(".")
+      .map((segment) => JSON.parse(segment))
+      .join("/")}`,
+  /**
+   * Enables draft mode: updates all Val modules with patches
+   */
+  VAL_DRAFT_MODE_COOKIE: "val_draft_mode",
+  /**
+   * Enables Val: show the overlay / menu
+   */
+  VAL_ENABLE_COOKIE_NAME: "val_enable",
+  VAL_STATE_COOKIE: "val_state",
+  VAL_SESSION_COOKIE: "val_session",
 };
 
 export { Internal };

package/src/initSchema.ts

@@ -1,15 +1,17 @@
-import { F } from "ts-toolbelt";
+// import type { F } from "ts-toolbelt";
 import { array } from "./schema/array";
 import { number } from "./schema/number";
 import { object } from "./schema/object";
 import { string } from "./schema/string";
 import { boolean } from "./schema/boolean";
-import { oneOf } from "./schema/oneOf";
 import { union } from "./schema/union";
-import { i18n, I18n } from "./schema/i18n";
 import { richtext } from "./schema/richtext";
 import { image } from "./schema/image";
 import { literal } from "./schema/literal";
+import { keyOf } from "./schema/keyOf";
+import { record } from "./schema/record";
+// import { i18n, I18n } from "./schema/future/i18n";
+// import { oneOf } from "./schema/future/oneOf";
 
 export type InitSchema = {
   readonly string: typeof string;
@@ -18,17 +20,18 @@ export type InitSchema = {
   readonly object: typeof object;
   readonly number: typeof number;
   readonly union: typeof union;
-  readonly oneOf: typeof oneOf;
+  // readonly oneOf: typeof oneOf;
   readonly richtext: typeof richtext;
   readonly image: typeof image;
   readonly literal: typeof literal;
+  readonly keyOf: typeof keyOf;
+  readonly record: typeof record;
 };
-export type InitSchemaLocalized<Locales extends readonly string[]> = {
-  readonly i18n: I18n<Locales>;
-};
-export function initSchema<Locales extends readonly string[]>(
-  locales: F.Narrow<Locales>
-) {
+// export type InitSchemaLocalized<Locales extends readonly string[]> = {
+//   readonly i18n: I18n<Locales>;
+// };
+export function initSchema() {
+  // locales: F.Narrow<Locales>
   return {
     string,
     boolean,
@@ -36,10 +39,12 @@ export function initSchema<Locales extends readonly string[]>(
     object,
     number,
     union,
-    oneOf,
+    // oneOf,
     richtext,
     image,
     literal,
-    i18n: i18n(locales),
+    keyOf,
+    record,
+    // i18n: i18n(locales),
   };
 }

package/src/initVal.ts

@@ -1,79 +1,69 @@
 /* eslint-disable @typescript-eslint/ban-types */
 /* eslint-disable @typescript-eslint/no-unnecessary-type-constraint */
 import { content } from "./module";
-import { i18n, I18n } from "./source/i18n";
-import { InitSchema, initSchema, InitSchemaLocalized } from "./initSchema";
+import { InitSchema, initSchema } from "./initSchema";
 import { getValPath as getPath } from "./val";
-import { remote } from "./source/remote";
 import { file } from "./source/file";
 import { richtext } from "./source/richtext";
+// import { i18n, I18n } from "./source/future/i18n";
+// import { remote } from "./source/future/remote";
 
 type ValConstructor = {
   content: typeof content;
   getPath: typeof getPath;
-  remote: typeof remote;
+  // remote: typeof remote;
   file: typeof file;
   richtext: typeof richtext;
 };
-export type InitVal<Locales extends readonly string[] | undefined> = [
-  Locales
-] extends [readonly string[]]
-  ? {
-      val: ValConstructor & {
-        i18n: I18n<Locales>;
-      };
-      s: InitSchema & InitSchemaLocalized<Locales>;
-    }
-  : {
-      val: ValConstructor;
-      s: InitSchema;
-    };
+export type InitVal = {
+  val: ValConstructor;
+  s: InitSchema;
+};
 
-type NarrowStrings<A> =
-  | (A extends [] ? [] : never)
-  | (A extends string ? A : never)
-  | {
-      [K in keyof A]: NarrowStrings<A[K]>;
-    };
+// type NarrowStrings<A> =
+//   | (A extends [] ? [] : never)
+//   | (A extends string ? A : never)
+//   | {
+//       [K in keyof A]: NarrowStrings<A[K]>;
+//     };
 
-export const initVal = <
-  Locales extends readonly string[] | undefined
->(options?: {
-  readonly locales?: NarrowStrings<{
-    readonly required: Locales;
-    readonly default: Locales extends readonly string[]
-      ? Locales[number]
-      : never;
-  }>;
-}): InitVal<Locales> => {
-  const locales = options?.locales;
-  const s = initSchema(locales?.required as readonly string[]);
-  if (locales?.required) {
-    console.error("Locales / i18n currently not implemented");
-    return {
-      val: {
-        content,
-        i18n,
-        remote,
-        getPath,
-        file,
-        richtext,
-      },
-      s,
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    } as any;
-  }
+// TODO: Rename to createValSystem (only to be used by internal things), we can then export * from '@valbuild/core' in the next package then.
+export const initVal = (): //   options?: {
+//   readonly locales?: NarrowStrings<{
+//     readonly required: Locales;
+//     readonly default: Locales extends readonly string[]
+//       ? Locales[number]
+//       : never;
+//   }>;
+// }
+InitVal => {
+  // const locales = options?.locales;
+  const s = initSchema();
+  // if (locales?.required) {
+  //   console.error("Locales / i18n currently not implemented");
+  //   return {
+  //     val: {
+  //       content,
+  //       i18n,
+  //       remote,
+  //       getPath,
+  //       file,
+  //       richtext,
+  //     },
+  //     s,
+  //     // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  //   } as any;
+  // }
   return {
     val: {
       content,
-      remote,
+      // remote,
       getPath,
       file,
       richtext,
     },
     s: {
       ...s,
-      i18n: undefined,
     },
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
   } as any;

package/src/module.test.ts

@@ -6,21 +6,21 @@ import {
 } from "./module";
 import { SchemaTypeOf } from "./schema";
 import { array } from "./schema/array";
-import { i18n as initI18nSchema } from "./schema/i18n";
-import { i18n as initI18nSource } from "./source/i18n";
 import { number } from "./schema/number";
 import { object } from "./schema/object";
 import { string, StringSchema } from "./schema/string";
 import { union } from "./schema/union";
-import { SourceOrExpr } from "./selector";
+import { GetSource } from "./selector";
 import { newSelectorProxy } from "./selector/SelectorProxy";
 import { ModulePath, SourcePath } from "./val";
 import { literal } from "./schema/literal";
 
-const i18n = initI18nSchema(["en_US", "nb_NO"] as const);
-const val = {
-  i18n: initI18nSource(["en_US", "nb_NO"] as const),
-};
+// import { i18n as initI18nSchema } from "./schema/i18n";
+// import { i18n as initI18nSource } from "./source/i18n";
+// const i18n = initI18nSchema(["en_US", "nb_NO"] as const);
+// const val = {
+//   i18n: initI18nSource(["en_US", "nb_NO"] as const),
+// };
 describe("module", () => {
   test("parse path", () => {
     expect(parsePath('"foo"."bar".1."zoo"' as ModulePath)).toStrictEqual([
@@ -58,7 +58,7 @@ describe("module", () => {
         },
       })
     );
-    expect(resolvedModuleAtPath[SourceOrExpr]).toStrictEqual("zoo2");
+    expect(resolvedModuleAtPath[GetSource]).toStrictEqual("zoo2");
   });
 
   test("getSourceAtPath: basic source", () => {
@@ -82,7 +82,7 @@ describe("module", () => {
         },
       })
     );
-    expect(resolvedModuleAtPath[SourceOrExpr]).toStrictEqual("zoo2");
+    expect(resolvedModuleAtPath[GetSource]).toStrictEqual("zoo2");
   });
 
   test("getSchemaAtPath: array & object", () => {
@@ -110,37 +110,37 @@ describe("module", () => {
     expect(source).toStrictEqual("bar1");
   });
 
-  test("getSchemaAtPath: i18n", () => {
-    const basicSchema = array(
-      object({
-        foo: i18n(array(object({ bar: string() }))),
-        zoo: number(),
-      })
-    );
-    const res = resolveAtPath(
-      '0."foo"."nb_NO".0."bar"' as ModulePath,
-      [
-        {
-          foo: val.i18n({
-            en_US: [
-              {
-                bar: "dive",
-              },
-            ],
-            nb_NO: [
-              {
-                bar: "brun",
-              },
-            ],
-          }),
-          zoo: 1,
-        },
-      ] as SchemaTypeOf<typeof basicSchema>,
-      basicSchema.serialize()
-    );
-    expect(res.schema).toStrictEqual(string().serialize());
-    expect(res.source).toStrictEqual("brun");
-  });
+  // test("getSchemaAtPath: i18n", () => {
+  //   const basicSchema = array(
+  //     object({
+  //       foo: i18n(array(object({ bar: string() }))),
+  //       zoo: number(),
+  //     })
+  //   );
+  //   const res = resolveAtPath(
+  //     '0."foo"."nb_NO".0."bar"' as ModulePath,
+  //     [
+  //       {
+  //         foo: val.i18n({
+  //           en_US: [
+  //             {
+  //               bar: "dive",
+  //             },
+  //           ],
+  //           nb_NO: [
+  //             {
+  //               bar: "brun",
+  //             },
+  //           ],
+  //         }),
+  //         zoo: 1,
+  //       },
+  //     ] as SchemaTypeOf<typeof basicSchema>,
+  //     basicSchema.serialize()
+  //   );
+  //   expect(res.schema).toStrictEqual(string().serialize());
+  //   expect(res.source).toStrictEqual("brun");
+  // });
 
   test("getSchemaAtPath: union", () => {
     const basicSchema = array(