@valbuild/shared 0.33.0

package/README.md

@@ -0,0 +1,23 @@
+# Shared types and utils
+
+This package contains internal Val types and utils that are shared between other packages.
+
+Since Val has many runtimes (node, browser, QuickJS) and is bundled in different ways and executed different modes (client, SSR, RSC), we need to be careful about how code is bundled. This package gives us an extra place to put code that is shared between all platforms, but that can be run in all runtimes and bundlers.
+
+## What is goes into this package?
+
+Generally speaking, code that are shared between other packages belongs in this package. Specifically:
+
+- Types and utility functions that does **NOT** belong in core because they:
+  1. is not required to execute Val files; or
+  1. have dependency on a lib
+- Types and utility functions that does **NOT** semantically belong in any other package. Examples:
+  1. parser tools
+  1. API layer
+
+See the rules to what does NOT belong in this package below.
+
+## What **DOES NOT** go into this package?
+
+- Any function / type that depends on a UI framework, even transitively (React, Lexical, NextJS, Vite...).
+- Any function that cannot execute both on server-side and client-side.

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

@@ -0,0 +1,10 @@
+/**
+ * Val React **shared** types and utils.
+ *
+ * @remarks
+ * This package includes only internal entry points and should only be used by internal packages.
+ *
+ * @packageDocumentation
+ */
+declare const _default: {};
+export default _default;

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

@@ -0,0 +1,2 @@
+export * from "./richtext/conversion/index.js";
+export * from "./mimeType/index.js";

package/dist/declarations/src/internal/mimeType/imageMimeType.d.ts

@@ -0,0 +1,2 @@
+export declare function getMimeType(base64Url: string): string | undefined;
+export declare function mimeTypeToFileExt(mimeType: string): string;

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

@@ -0,0 +1 @@
+export * from "./imageMimeType.js";

package/dist/declarations/src/internal/richtext/conversion/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./lexicalToRichTextSource.js";
+export * from "./richTextSourceToLexical.js";
+export * from "./parseRichTextSource.js";

package/dist/declarations/src/internal/richtext/conversion/lexicalToRichTextSource.d.ts

@@ -0,0 +1,12 @@
+import { RichTextSource, AnyRichTextOptions } from "@valbuild/core";
+import { LexicalRootNode } from "./richTextSourceToLexical.js";
+export declare function lexicalToRichTextSource(node: LexicalRootNode): Promise<RichTextSource<AnyRichTextOptions> & {
+    files: Record<string, string>;
+}>;
+declare const FORMAT_MAPPING: {
+    bold: number;
+    italic: number;
+    "line-through": number;
+};
+export declare function fromLexicalFormat(format: number): (keyof typeof FORMAT_MAPPING)[];
+export {};

package/dist/declarations/src/internal/richtext/conversion/parseRichTextSource.d.ts

@@ -0,0 +1,2 @@
+import { RichTextOptions, RichTextSource, RichText } from "@valbuild/core";
+export declare function parseRichTextSource<O extends RichTextOptions>({ templateStrings, exprs: nodes, }: RichTextSource<O>): RichText<O>;

package/dist/declarations/src/internal/richtext/conversion/richTextSourceToLexical.d.ts

@@ -0,0 +1,67 @@
+import { AnyRichTextOptions, RichTextNode as ValRichTextNode, RichText } from "@valbuild/core";
+export type LexicalTextNode = CommonLexicalProps & {
+    type: "text";
+    text: string;
+    format: "" | number;
+};
+type InlineNode = LexicalTextNode | LexicalLinkNode;
+export type LexicalParagraphNode = CommonLexicalProps & {
+    type: "paragraph";
+    children: (InlineNode | LexicalLineBreakNode)[];
+};
+export type LexicalHeadingNode = CommonLexicalProps & {
+    type: "heading";
+    tag: "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
+    children: InlineNode[];
+};
+export type LexicalListItemNode = CommonLexicalProps & {
+    type: "listitem";
+    children: (InlineNode | LexicalListNode | LexicalLineBreakNode)[];
+};
+export type LexicalListNode = CommonLexicalProps & {
+    type: "list";
+    listType: "bullet" | "number" | "checked";
+    direction: "ltr" | "rtl" | null;
+    children: LexicalListItemNode[];
+};
+export type LexicalImagePayload = {
+    src: string;
+    altText?: string;
+    height?: number;
+    width?: number;
+};
+export type LexicalImageNode = CommonLexicalProps & {
+    type: "image";
+} & LexicalImagePayload;
+export type LexicalLinkNode = CommonLexicalProps & {
+    type: "link";
+    url: string;
+    children: LexicalTextNode[];
+};
+export type LexicalLineBreakNode = CommonLexicalProps & {
+    type: "linebreak";
+};
+export type LexicalNode = LexicalTextNode | LexicalParagraphNode | LexicalHeadingNode | LexicalListItemNode | LexicalListNode | LexicalImageNode | LexicalLineBreakNode | LexicalLinkNode;
+export type LexicalRootNode = {
+    type: "root";
+    children: (LexicalHeadingNode | LexicalParagraphNode | LexicalListNode)[];
+    version: 1;
+    format: "left" | "start" | "center" | "right" | "end" | "justify" | "";
+    direction: null | "ltr" | "rtl";
+} & CommonLexicalProps;
+export declare const COMMON_LEXICAL_PROPS: {
+    readonly version: 1;
+    readonly format: number | "";
+    readonly indent: 0;
+    readonly direction: "ltr" | "rtl" | null;
+};
+type CommonLexicalProps = typeof COMMON_LEXICAL_PROPS;
+export declare function toLexicalNode(node: ValRichTextNode<AnyRichTextOptions>, useBreakNode?: boolean): LexicalNode;
+export declare function richTextSourceToLexical(richtext: RichText<AnyRichTextOptions>): LexicalRootNode;
+declare const FORMAT_MAPPING: {
+    bold: number;
+    italic: number;
+    "line-through": number;
+};
+export declare function toLexicalFormat(classes: (keyof typeof FORMAT_MAPPING)[]): number;
+export {};

package/dist/valbuild-shared.cjs.d.ts

@@ -0,0 +1,3 @@
+export * from "./declarations/src/index";
+export { default } from "./declarations/src/index";
+//# sourceMappingURL=valbuild-shared.cjs.d.ts.map

package/dist/valbuild-shared.cjs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"valbuild-shared.cjs.d.ts","sourceRoot":"","sources":["./declarations/src/index.d.ts"],"names":[],"mappings":"AAAA"}

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

@@ -0,0 +1,15 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * Val React **shared** types and utils.
+ *
+ * @remarks
+ * This package includes only internal entry points and should only be used by internal packages.
+ *
+ * @packageDocumentation
+ */
+var index = {};
+
+exports["default"] = index;

package/dist/valbuild-shared.cjs.js

@@ -0,0 +1,7 @@
+'use strict';
+
+if (process.env.NODE_ENV === "production") {
+  module.exports = require("./valbuild-shared.cjs.prod.js");
+} else {
+  module.exports = require("./valbuild-shared.cjs.dev.js");
+}

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

@@ -0,0 +1,15 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * Val React **shared** types and utils.
+ *
+ * @remarks
+ * This package includes only internal entry points and should only be used by internal packages.
+ *
+ * @packageDocumentation
+ */
+var index = {};
+
+exports["default"] = index;

package/dist/valbuild-shared.esm.js

@@ -0,0 +1,11 @@
+/**
+ * Val React **shared** types and utils.
+ *
+ * @remarks
+ * This package includes only internal entry points and should only be used by internal packages.
+ *
+ * @packageDocumentation
+ */
+var index = {};
+
+export { index as default };

package/internal/dist/valbuild-shared-internal.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "../../dist/declarations/src/internal/index";
+//# sourceMappingURL=valbuild-shared-internal.cjs.d.ts.map

package/internal/dist/valbuild-shared-internal.cjs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"valbuild-shared-internal.cjs.d.ts","sourceRoot":"","sources":["../../dist/declarations/src/internal/index.d.ts"],"names":[],"mappings":"AAAA"}