@valbuild/core 0.26.0 → 0.27.0

package/src/source/future/remote.ts

@@ -1,54 +0,0 @@
-import { SourcePrimitive, VAL_EXTENSION, PhantomType } from "..";
-import { FileSource } from "../file";
-import { I18nCompatibleSource, I18nSource } from "./i18n";
-import { AnyRichTextOptions, RichTextSource } from "../richtext";
-
-/**
- * Remote sources cannot include other remote sources.
- */
-export type RemoteCompatibleSource =
-  | SourcePrimitive
-  | RemoteObject
-  | RemoteArray
-  | RichTextSource<AnyRichTextOptions>
-  | FileSource
-  | I18nSource<string[], I18nCompatibleSource>;
-export type RemoteObject = { [key in string]: RemoteCompatibleSource };
-export type RemoteArray = readonly RemoteCompatibleSource[];
-
-export const REMOTE_REF_PROP = "_ref" as const; // TODO: same as FILE_REF_PROP so use same prop?
-
-declare const brand: unique symbol;
-export type RemoteRef = string & { readonly [brand]: "RemoteRef" };
-
-/**
- * A remote source is a hash that represents a remote object.
- *
- * It will be resolved into a ValRemote object.
- */
-export type RemoteSource<Src extends RemoteCompatibleSource> = {
-  readonly [REMOTE_REF_PROP]: RemoteRef;
-  readonly [VAL_EXTENSION]: "remote";
-} & PhantomType<Src>;
-
-export function remote<Src extends RemoteCompatibleSource>(
-  ref: string
-): RemoteSource<Src> {
-  return {
-    [REMOTE_REF_PROP]: ref as RemoteRef,
-    [VAL_EXTENSION]: "remote",
-  } as RemoteSource<Src>;
-}
-
-export function isRemote(
-  obj: unknown
-): obj is RemoteSource<RemoteCompatibleSource> {
-  return (
-    typeof obj === "object" &&
-    obj !== null &&
-    VAL_EXTENSION in obj &&
-    obj[VAL_EXTENSION] === "remote" &&
-    REMOTE_REF_PROP in obj &&
-    typeof obj[REMOTE_REF_PROP] === "string"
-  );
-}

package/src/source/index.ts

@@ -1,53 +0,0 @@
-import { FileSource } from "./file";
-import { I18nSource, I18nCompatibleSource } from "./future/i18n";
-import { RemoteSource, RemoteCompatibleSource } from "./future/remote";
-import { RichTextOptions, RichTextSource } from "./richtext";
-
-export type Source =
-  | SourcePrimitive
-  | SourceObject
-  | SourceArray
-  | I18nSource<string[], I18nCompatibleSource>
-  | RemoteSource<RemoteCompatibleSource>
-  | FileSource
-  | RichTextSource<RichTextOptions>;
-
-export type SourceObject = { [key in string]: Source } & {
-  // TODO: update these restricted parameters:
-  fold?: never;
-  assert?: never;
-  andThen?: never;
-  _ref?: never;
-  _type?: never;
-  val?: never;
-  valPath?: never; // used when serializing vals
-};
-export type SourceArray = readonly Source[];
-export type SourcePrimitive = string | number | boolean | null;
-
-/* Branded extension types: file, remote, i18n  */
-export const VAL_EXTENSION = "_type" as const;
-
-export function getValExtension(source: Source) {
-  return (
-    source &&
-    typeof source === "object" &&
-    VAL_EXTENSION in source &&
-    source[VAL_EXTENSION]
-  );
-}
-
-/**
- * A phantom type parameter is one that doesn't show up at runtime, but is checked statically (and only) at compile time.
- *
- * An example where this is useful is remote types, where the type of the remote source is known at compile time,
- * but the value is not there before it is fetched.
- *
- * @example
- * type Example<T> = string & PhantomType<T>;
- *
- **/
-declare const PhantomType: unique symbol;
-export type PhantomType<T> = {
-  [PhantomType]: T;
-};

package/src/source/link.ts

@@ -1,14 +0,0 @@
-import { VAL_EXTENSION } from ".";
-export type LinkSource = {
-  [VAL_EXTENSION]: "link";
-  href: string;
-  children: [string];
-};
-
-export function link(text: string, { href }: { href: string }): LinkSource {
-  return {
-    [VAL_EXTENSION]: "link",
-    href,
-    children: [text],
-  };
-}

package/src/source/richtext.ts

@@ -1,178 +0,0 @@
-import { FileSource } from "./file";
-import { VAL_EXTENSION } from ".";
-import { LinkSource } from "./link";
-import { ImageMetadata } from "../schema/image";
-
-export type RichTextOptions = {
-  headings?: ("h1" | "h2" | "h3" | "h4" | "h5" | "h6")[];
-  img?: boolean;
-  a?: boolean;
-  ul?: boolean;
-  ol?: boolean;
-  lineThrough?: boolean;
-  bold?: boolean;
-  italic?: boolean;
-};
-export type AnyRichTextOptions = {
-  headings: ("h1" | "h2" | "h3" | "h4" | "h5" | "h6")[];
-  img: true;
-  a: true;
-  ul: true;
-  ol: true;
-  lineThrough: true;
-  bold: true;
-  italic: true;
-};
-
-// Classes
-export type LineThrough<O extends RichTextOptions> =
-  O["lineThrough"] extends true ? "line-through" : never;
-
-export type Italic<O extends RichTextOptions> = O["italic"] extends true
-  ? "italic"
-  : never;
-
-export type Bold<O extends RichTextOptions> = O["bold"] extends true
-  ? "bold"
-  : never;
-
-export type Classes<O extends RichTextOptions> =
-  | LineThrough<O>
-  | Italic<O>
-  | Bold<O>;
-
-/// Paragraph
-export type ParagraphNode<O extends RichTextOptions> = {
-  tag: "p";
-  children: (string | SpanNode<O> | BrNode | LinkNode<O> | ImageNode<O>)[];
-};
-
-/// Break
-export type BrNode = {
-  tag: "br";
-  children: [];
-};
-
-/// Span
-export type SpanNode<O extends RichTextOptions> = {
-  tag: "span";
-  classes: Classes<O>[];
-  children: [string | SpanNode<O>];
-};
-
-/// Image
-type ImageTagNode = {
-  tag: "img";
-  src: string;
-  height?: number;
-  width?: number;
-  children: [];
-};
-export type ImageNode<O extends RichTextOptions> = O["img"] extends true
-  ? ImageTagNode
-  : never;
-
-/// Link
-type LinkTagNode<O extends RichTextOptions> = {
-  tag: "a";
-  href: string;
-  children: (string | SpanNode<O>)[];
-};
-export type LinkNode<O extends RichTextOptions> = O["a"] extends true
-  ? LinkTagNode<O>
-  : never;
-
-/// List
-export type ListItemNode<O extends RichTextOptions> = {
-  tag: "li";
-  children: (
-    | string
-    | SpanNode<O>
-    | LinkNode<O>
-    | BrNode
-    | UnorderedListNode<O>
-    | OrderedListNode<O>
-  )[];
-};
-
-export type UnorderedListNode<O extends RichTextOptions> = O["ul"] extends true
-  ? {
-      tag: "ul";
-      dir?: "ltr" | "rtl";
-      children: ListItemNode<O>[];
-    }
-  : never;
-
-export type OrderedListNode<O extends RichTextOptions> = O["ol"] extends true
-  ? {
-      tag: "ol";
-      dir?: "ltr" | "rtl";
-      children: ListItemNode<O>[];
-    }
-  : never;
-
-/// Heading
-export type HeadingNode<O extends RichTextOptions> = O["headings"] extends (
-  | "h1"
-  | "h2"
-  | "h3"
-  | "h4"
-  | "h5"
-  | "h6"
-)[]
-  ? {
-      tag: O["headings"][number];
-      children: (string | SpanNode<O>)[];
-    }
-  : never;
-
-/// Root and nodes
-export type RichTextNode<O extends RichTextOptions> =
-  | string
-  | RootNode<O>
-  | ListItemNode<O>
-  | BrNode
-  | SpanNode<O>
-  | LinkNode<O>
-  | ImageNode<O>;
-
-export type RootNode<O extends RichTextOptions> =
-  | HeadingNode<O>
-  | ParagraphNode<O>
-  | BrNode
-  | UnorderedListNode<O>
-  | OrderedListNode<O>;
-
-/// Main types
-
-/**
- * RichTextSource is defined in ValModules
- **/
-export type RichTextSource<O extends RichTextOptions> = {
-  [VAL_EXTENSION]: "richtext";
-  templateStrings: string[];
-  exprs: (
-    | (O["img"] extends true ? FileSource<ImageMetadata> : never)
-    | (O["a"] extends true ? LinkSource : never)
-  )[];
-};
-/**
- * RichText is accessible by users (after conversion via useVal / fetchVal)
- * Internally it is a Selector
- **/
-export type RichText<O extends RichTextOptions> = {
-  [VAL_EXTENSION]: "richtext";
-  children: RootNode<O>[];
-};
-
-export function richtext<O extends RichTextOptions>(
-  templateStrings: TemplateStringsArray,
-  ...nodes: (FileSource<ImageMetadata> | LinkSource)[]
-): RichTextSource<O> {
-  return {
-    [VAL_EXTENSION]: "richtext",
-    templateStrings: templateStrings as unknown as string[],
-    exprs:
-      nodes as RichTextSource<AnyRichTextOptions>["exprs"] as RichTextSource<O>["exprs"],
-  };
-}

package/src/val/array.ts

@@ -1,10 +0,0 @@
-import { SourcePath, Val as UnknownVal } from ".";
-import { JsonArray } from "../Json";
-import { Path } from "../selector/index";
-
-export type Val<T extends JsonArray> = {
-  readonly [key in keyof T]: UnknownVal<T[key]>;
-} & {
-  readonly [Path]: SourcePath | undefined;
-  readonly val: T;
-};

package/src/val/index.ts

@@ -1,100 +0,0 @@
-import { Source, SourceArray, SourceObject } from "../source";
-import { Val as ObjectVal } from "./object";
-import { Val as ArrayVal } from "./array";
-import { Val as PrimitiveVal } from "./primitive";
-import { Json, JsonArray, JsonObject, JsonPrimitive } from "../Json";
-import { Path, Selector } from "../selector";
-import { I18nSource } from "../source/future/i18n";
-import { RemoteSource } from "../source/future/remote";
-import { FileSource } from "../source/file";
-
-export type SerializedVal = {
-  val: SerializedVal | Json;
-  valPath: SourcePath | undefined;
-};
-export function isSerializedVal(val: unknown): val is SerializedVal {
-  return (
-    typeof val === "object" &&
-    val !== null &&
-    val !== undefined &&
-    ("val" in val || "valPath" in val)
-  );
-}
-
-export type JsonOfSource<T extends Source> = Json extends T
-  ? Json
-  : T extends I18nSource<readonly string[], infer U>
-  ? JsonOfSource<U>
-  : T extends RemoteSource<infer U>
-  ? JsonOfSource<U>
-  : T extends FileSource
-  ? { url: string }
-  : T extends SourceObject
-  ? {
-      [key in keyof T]: JsonOfSource<T[key]>;
-    }
-  : T extends SourceArray
-  ? JsonOfSource<T[number]>[]
-  : T extends JsonPrimitive
-  ? T
-  : never;
-
-export type Val<T extends Json> = Json extends T
-  ? {
-      readonly [Path]: SourcePath | undefined;
-      readonly val: Source;
-    }
-  : T extends JsonObject
-  ? ObjectVal<T>
-  : T extends JsonArray
-  ? ArrayVal<T>
-  : T extends JsonPrimitive
-  ? PrimitiveVal<T>
-  : never;
-
-export function isVal<T extends Json>(val: unknown): val is Val<T> {
-  return (
-    typeof val === "object" &&
-    val !== null &&
-    val !== undefined &&
-    Path in val &&
-    "val" in val
-  );
-}
-
-declare const brand: unique symbol;
-/**
- * The path of the source value.
- *
- * @example
- * '/app/blogs.0.text' // the text property of the first element of the /app/blogs module
- */
-export type SourcePath = string & {
-  [brand]: "SourcePath";
-};
-
-/**
- * The path inside the module.
- *
- * @example
- * '0."text"' // the text property of the first element of the module
- */
-export type ModulePath = string & {
-  [brand]: "ModulePath";
-};
-
-/**
- * The id of the module.
- *
- * @example
- * '/app/blogs' // the /app/blogs module
- */
-export type ModuleId = string & {
-  [brand]: "ModuleId";
-};
-
-export function getValPath(
-  valOrSelector: Val<Json> | Selector<Source>
-): SourcePath | undefined {
-  return valOrSelector[Path];
-}

package/src/val/object.ts

@@ -1,13 +0,0 @@
-import { SourcePath, Val as UnknownVal } from ".";
-import { JsonObject } from "../Json";
-import { Path } from "../selector/index";
-
-export type Val<T extends JsonObject> = Omit<
-  {
-    readonly [key in keyof T]: UnknownVal<T[key]>;
-  },
-  "valPath" | "val"
-> & {
-  readonly [Path]: SourcePath | undefined;
-  readonly val: T;
-};

package/src/val/primitive.ts

@@ -1,8 +0,0 @@
-import { SourcePath } from ".";
-import { JsonPrimitive } from "../Json";
-import { Path } from "../selector";
-
-export type Val<T extends JsonPrimitive> = {
-  [Path]: SourcePath | undefined;
-  val: T;
-};

package/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "compilerOptions": {
-    "strict": true,
-    "isolatedModules": true,
-    "noEmit": true,
-    "skipLibCheck": true
-  }
-}