@erudit-js/prose 4.0.0-dev.1 → 4.0.0-dev.2

package/dist/elements/problem/problems.d.ts

@@ -127,7 +127,7 @@ export declare const Problems: import("@jsprose/core").Tag<"Problems", {
     applied?: true | undefined;
     method?: true | undefined;
     inter?: true | undefined;
-} & TagChildren & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet & import("../../snippet.js").ObjPropSearch & import("../../snippet.js").ObjPropQuick & import("../../snippet.js").ObjPropSeo>;
+} & TagChildren & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet>;
 export declare const problemsRegistryItem: import("@jsprose/core").RegistryItem<{
     name: "problems";
     type: "block";
@@ -166,7 +166,7 @@ export declare const problemsRegistryItem: import("@jsprose/core").RegistryItem<
         applied?: true | undefined;
         method?: true | undefined;
         inter?: true | undefined;
-    } & TagChildren & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet & import("../../snippet.js").ObjPropSearch & import("../../snippet.js").ObjPropQuick & import("../../snippet.js").ObjPropSeo>;
+    } & TagChildren & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet>;
 }, undefined>;
 export declare const problemsCoreElement: {
     registryItem: import("@jsprose/core").RegistryItem<{
@@ -207,6 +207,6 @@ export declare const problemsCoreElement: {
             applied?: true | undefined;
             method?: true | undefined;
             inter?: true | undefined;
-        } & TagChildren & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet & import("../../snippet.js").ObjPropSearch & import("../../snippet.js").ObjPropQuick & import("../../snippet.js").ObjPropSeo>;
+        } & TagChildren & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet>;
     }, undefined>;
 };

package/dist/elements/problem/problems.js

@@ -62,8 +62,9 @@ export const Problems = defineEruditTag({
 		throw new ProseError(`<${tagName}> must have at least one <SubProblem> child!`);
 	}
 	element.children = [...otherChildren, ...subProblemChildren];
-	element.data = problemProps2Info(props);
-	element.title = element.data.title;
+	const problemInfo = problemProps2Info(props);
+	element.data = problemInfo;
+	element.title = problemInfo.title;
 });
 export const problemsRegistryItem = defineRegistryItem({
 	schema: problemsSchema,

package/dist/elements/table/Table.vue

@@ -31,16 +31,14 @@ const rows = computed(() =>
                 :class="[
                     $style.table,
                     `text-main-sm bg-bg-main m-auto max-w-full border-separate
-                    border-spacing-[3px] rounded border border-(--tableBorder)
-                    transition-[background,border]`,
+                    border-spacing-[3px] rounded border border-(--tableBorder)`,
                 ]"
             >
                 <tbody>
                     <tr
                         v-for="row in rows"
                         :key="row.id"
-                        class="transition-[background] odd:bg-(--oddCellBg)
-                            even:bg-(--evenCellBg)"
+                        class="odd:bg-(--oddCellBg) even:bg-(--evenCellBg)"
                     >
                         <td
                             v-for="cell in row.children"

package/dist/elements/table/core.d.ts

@@ -150,7 +150,7 @@ export declare const Table: import("@jsprose/core").Tag<"Table", {
             Children: InlinerSchema[];
         }[];
     })[];
-}, TagChildren & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet & import("../../snippet.js").ObjPropSearch & import("../../snippet.js").ObjPropQuick & import("../../snippet.js").ObjPropSeo>;
+}, TagChildren & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet>;
 export declare const tableRegistryItem: import("@jsprose/core").RegistryItem<{
     name: "table";
     type: "block";
@@ -208,7 +208,7 @@ export declare const tableRegistryItem: import("@jsprose/core").RegistryItem<{
                 Children: InlinerSchema[];
             }[];
         })[];
-    }, TagChildren & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet & import("../../snippet.js").ObjPropSearch & import("../../snippet.js").ObjPropQuick & import("../../snippet.js").ObjPropSeo>;
+    }, TagChildren & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet>;
 }, undefined>;
 declare const _default: [{
     registryItem: import("@jsprose/core").RegistryItem<{
@@ -318,7 +318,7 @@ declare const _default: [{
                     Children: InlinerSchema[];
                 }[];
             })[];
-        }, TagChildren & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet & import("../../snippet.js").ObjPropSearch & import("../../snippet.js").ObjPropQuick & import("../../snippet.js").ObjPropSeo>;
+        }, TagChildren & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet>;
     }, undefined>;
 }];
 export default _default;

package/dist/elements/video/core.d.ts

@@ -43,7 +43,7 @@ export declare const Video: import("@jsprose/core").Tag<"Video", {
     invert?: Invert;
     width?: string;
     children?: {};
-} & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet & import("../../snippet.js").ObjPropSearch & import("../../snippet.js").ObjPropQuick & import("../../snippet.js").ObjPropSeo>;
+} & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet>;
 export declare const videoRegistryItem: import("@jsprose/core").RegistryItem<{
     name: "video";
     type: "block";
@@ -79,7 +79,7 @@ export declare const videoRegistryItem: import("@jsprose/core").RegistryItem<{
         invert?: Invert;
         width?: string;
         children?: {};
-    } & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet & import("../../snippet.js").ObjPropSearch & import("../../snippet.js").ObjPropQuick & import("../../snippet.js").ObjPropSeo>;
+    } & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet>;
 }, undefined>;
 declare const _default: {
     registryItem: import("@jsprose/core").RegistryItem<{
@@ -117,7 +117,7 @@ declare const _default: {
             invert?: Invert;
             width?: string;
             children?: {};
-        } & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet & import("../../snippet.js").ObjPropSearch & import("../../snippet.js").ObjPropQuick & import("../../snippet.js").ObjPropSeo>;
+        } & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet>;
     }, undefined>;
 };
 export default _default;

package/dist/include.js

@@ -25,7 +25,6 @@ export function Include(props) {
 			delete element.toc;
 		}
 		delete element.snippet;
-		delete element.snippetFlags;
 		delete element.uniqueName;
 		element[includedKey] = true;
 		if (element.children) {

package/dist/snippet.d.ts

@@ -4,60 +4,50 @@ import type { EruditRawElement } from './rawElement.js';
 /**
  * Snippet attribute - only contains title and description
  */
-export interface SnippetProp {
+export interface SnippetData {
+    /** General snippet title. Used as fallback value for flags. */
     title?: string;
+    /** General snippet description. Used as fallback value for flags. */
     description?: string;
-}
-export type ObjPropSnippet = {
-    /**
-     * Compact summary of the element with title and description.
-     */
-    snippet?: SnippetProp;
-};
-export type ObjPropSearch = {
     /**
      * Show element in search results.
-     * Can be a boolean to enable/disable, or an object with synonyms.
      */
-    search?: boolean | {
-        synonyms: string[];
+    search?: boolean | string | string[] | {
+        title?: string;
+        description?: string;
+        synonyms?: string[];
     };
-};
-export type ObjPropQuick = {
     /**
      * Show element in "Quick Links" sections at start of the page and also in TOC.
      */
-    quick?: boolean;
-};
-export type ObjPropSeo = {
+    quick?: boolean | string | {
+        title?: string;
+        description?: string;
+    };
     /**
      * When targeting this element with '#' anchor, adjust SEO metadata (like title and description).
      * Search engines should treat it as a different "page" and therefore show it as a standalone search result.
      */
-    seo?: boolean;
+    seo?: boolean | string | {
+        title?: string;
+        description?: string;
+    };
+}
+export type ObjPropSnippet = {
+    /**
+     * Compact summary of the element and where to show it (search, quick links, SEO).
+     */
+    snippet?: SnippetData;
 };
 export type ObjRawElementSnippet = {
-    snippet?: SnippetProp;
-    snippetFlags?: {
-        quick?: boolean;
-        search?: boolean | {
-            synonyms: string[];
-        };
-        seo?: boolean;
-    };
+    snippet?: SnippetData;
 };
-export declare function finalizeSnippet(processTagArgs: EruditProcessTagArgs): SnippetProp | undefined;
+export declare function finalizeSnippet(processTagArgs: EruditProcessTagArgs): SnippetData | undefined;
 export interface ResolvedSnippet {
-    title: string;
-    description?: string;
-    quick?: boolean;
-    search?: boolean | {
-        synonyms: string[];
-    };
-    seo?: boolean;
     schemaName: string;
     isUnique: boolean;
     elementId: string;
+    snippetData: SnippetData;
 }
 export declare const snippetStep: ({ rawElement, proseElement }: {
     context: import("./context.js").EruditProseContext;

package/dist/snippet.js

@@ -1,56 +1,85 @@
 import { ProseError } from "@jsprose/core";
 import { defineResolveStep } from "./resolveStep.js";
 export function finalizeSnippet(processTagArgs) {
-	const quick = processTagArgs.props.quick ?? processTagArgs.element.snippetFlags?.quick;
-	const search = processTagArgs.props.search ?? processTagArgs.element.snippetFlags?.search;
-	let seo = processTagArgs.props.seo ?? processTagArgs.element.snippetFlags?.seo;
+	const finalSnippet = {};
+	const propsSnippet = processTagArgs.props.snippet;
+	const builtinSnippet = processTagArgs.element.snippet;
+	//
+	const quick = propsSnippet?.quick ?? builtinSnippet?.quick;
+	if (quick) {
+		finalSnippet.quick = quick;
+	}
+	//
+	const search = propsSnippet?.search ?? builtinSnippet?.search;
+	if (search) {
+		finalSnippet.search = search;
+	}
+	//
+	let seo = propsSnippet?.seo ?? builtinSnippet?.seo;
 	// If none of the flags are set to true, no snippet is created
 	if (!quick && !search && !seo) {
 		return undefined;
 	}
 	// Enable SEO if either quick or search is enabled unless SEO is explicitly disabled
 	// Check both element defaults and props - if either explicitly disables seo, don't auto-enable
-	const seoExplicitlyDisabled = processTagArgs.element.snippetFlags?.seo === false || processTagArgs.props.seo === false;
-	if (!seoExplicitlyDisabled) {
-		if (quick || search) {
-			seo = true;
+	const seoExplicitlyDisabled = builtinSnippet?.seo === false || propsSnippet?.seo === false;
+	if (!seo) {
+		if (!seoExplicitlyDisabled) {
+			if (quick || search) {
+				seo = true;
+			}
 		}
 	}
-	const title = finalizeTitle(processTagArgs);
-	const description = finalizeDescription(processTagArgs);
-	const snippet = { title };
+	if (seo) {
+		finalSnippet.seo = seo;
+	}
+	//
+	const title = getGenericTitle(processTagArgs);
+	if (title) {
+		finalSnippet.title = title;
+	}
+	const description = getGenericDescription(processTagArgs);
 	if (description) {
-		snippet.description = description;
-	}
-	// Store flags on element for later resolution
-	processTagArgs.element.snippetFlags = {
-		quick,
-		search,
-		seo
-	};
-	return snippet;
+		finalSnippet.description = description;
+	}
+	//
+	if (!finalSnippet.title) {
+		let titlessFlags = [];
+		if (quick && typeof quick !== "string") {
+			if (quick === true || !quick.title) {
+				titlessFlags.push("quick");
+			}
+		}
+		if (search && typeof search !== "string") {
+			if (search === true || Array.isArray(search) || !search.title) {
+				titlessFlags.push("search");
+			}
+		}
+		if (seo && typeof seo !== "string") {
+			if (seo === true || !seo.title) {
+				titlessFlags.push("seo");
+			}
+		}
+		throw new ProseError(`Unable to get title for snippet flags (${titlessFlags.join(", ")}) because no explicit, general inherited title was provided!`);
+	}
+	//
+	processTagArgs.element.snippet = finalSnippet;
+	return finalSnippet;
 }
-function finalizeTitle(processTagArgs) {
+function getGenericTitle(processTagArgs) {
 	const title = processTagArgs.props.snippet?.title?.trim() || processTagArgs.element.snippet?.title?.trim() || processTagArgs.element.title?.trim();
-	if (!title) {
-		throw new ProseError(`Unable to finalize snippet title!`);
-	}
 	return title;
 }
-function finalizeDescription(processTagArgs) {
+function getGenericDescription(processTagArgs) {
 	return processTagArgs.props.snippet?.description?.trim() || processTagArgs.element.snippet?.description?.trim();
 }
 export const snippetStep = defineResolveStep(({ rawElement, proseElement }) => {
-	if (rawElement.snippet && proseElement.id && rawElement.snippet.title) {
+	if (rawElement.snippet && proseElement.id) {
 		const resolvedSnippet = {
-			title: rawElement.snippet.title,
-			description: rawElement.snippet.description,
-			quick: rawElement.snippetFlags?.quick,
-			search: rawElement.snippetFlags?.search,
-			seo: rawElement.snippetFlags?.seo,
 			schemaName: rawElement.schemaName,
 			isUnique: Boolean(rawElement.uniqueName),
-			elementId: proseElement.id
+			elementId: proseElement.id,
+			snippetData: rawElement.snippet
 		};
 		return resolvedSnippet;
 	}

package/dist/tag.d.ts

@@ -1,6 +1,6 @@
 import { Registry, type AnySchema, type ConfigurableTagProps, type NormalizedChildren, type ProcessTagFunction, type TagDefinition } from '@jsprose/core';
 import type { EruditRawElement } from './rawElement.js';
-import { type ObjPropSnippet, type ObjPropSearch, type ObjPropQuick, type ObjPropSeo } from './snippet.js';
+import { type ObjPropSnippet } from './snippet.js';
 import { type ObjPropToc } from './toc.js';
 declare const NoTocSymbol: unique symbol;
 declare const NoSnippetSymbol: unique symbol;
@@ -10,11 +10,11 @@ export type NoToc = {
 export type NoSnippet = {
     readonly [NoSnippetSymbol]?: never;
 };
-export type EruditTagProps<TProps extends Record<string, unknown>> = (TProps extends NoToc ? {} : ObjPropToc) & (TProps extends NoSnippet ? {} : ObjPropSnippet & ObjPropSearch & ObjPropQuick & ObjPropSeo);
+export type EruditTagProps<TProps extends Record<string, unknown>> = (TProps extends NoToc ? {} : ObjPropToc) & (TProps extends NoSnippet ? {} : ObjPropSnippet);
 export type EruditProcessTagArgs = {
     tagName: string;
     element: EruditRawElement<AnySchema>;
-    props: ConfigurableTagProps & ObjPropSnippet & ObjPropToc & ObjPropSearch & ObjPropQuick & ObjPropSeo;
+    props: ConfigurableTagProps & ObjPropSnippet & ObjPropToc;
     children: NormalizedChildren;
     registry: Registry;
 };

package/dist/tag.js

@@ -12,7 +12,7 @@ export function defineEruditTag(definition) {
 			args.element.snippet = finalizeSnippet(args);
 			args.element.toc = finalizeToc(args);
 			// Use every possibility to get human-readable slug whether it is set manually or taken from snippet or toc
-			args.element.slug ||= args.element.snippet?.title || args.element.toc?.title;
+			args.element.slug ||= args.element.snippet?.title || args.element.toc?.title || args.element.title;
 		});
 		return eruditTag;
 	}

package/package.json

@@ -1,7 +1,7 @@
 {
     "type": "module",
     "name": "@erudit-js/prose",
-    "version": "4.0.0-dev.1",
+    "version": "4.0.0-dev.2",
     "description": "📝 JSX prose subsystem for Erudit sites",
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
@@ -32,7 +32,7 @@
         "prepack": "bun run build"
     },
     "dependencies": {
-        "@erudit-js/core": "4.0.0-dev.1",
+        "@erudit-js/core": "4.0.0-dev.2",
         "@jsprose/core": "^1.0.0",
         "vue": "latest",
         "@floating-ui/vue": "^1.1.9",