@erudit-js/prose 3.0.0-dev.25

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

@@ -0,0 +1,106 @@
+import { type AnyUnique } from '@jsprose/core';
+import { type ProblemInfo } from './shared.js';
+import { type ProblemContentChild } from './problemContent.js';
+import { type ProblemScriptStorage } from './storage.js';
+import { type ProblemScriptInstance } from './problemScript.js';
+export interface ProblemData {
+    info: ProblemInfo;
+    scriptUniques?: Record<string, AnyUnique>;
+}
+export declare const problemSchema: {
+    name: "problem";
+    type: "block";
+    linkable: true;
+    Data: ProblemData;
+    Storage: ProblemScriptStorage;
+    Children: ProblemContentChild[];
+};
+export declare const Problem: import("@jsprose/core").Tag<"Problem", {
+    name: "problem";
+    type: "block";
+    linkable: true;
+    Data: ProblemData;
+    Storage: ProblemScriptStorage;
+    Children: ProblemContentChild[];
+}, ({
+    title: string;
+    level: import("./shared.js").ProblemLevel;
+    attributes?: (import("./shared.js").ProblemAttribute | import("./shared.js").ProblemCustomAttribute)[];
+} & {
+    pretty?: true | undefined;
+    applied?: true | undefined;
+    method?: true | undefined;
+    inter?: true | undefined;
+} & ({
+    children: {};
+    script?: undefined;
+} | {
+    script: ProblemScriptInstance;
+    children?: undefined;
+})) & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet & import("../../snippet.js").ObjPropSearch & import("../../snippet.js").ObjPropQuick & import("../../snippet.js").ObjPropSeo>;
+export declare const problemRegistryItem: import("@jsprose/core").RegistryItem<{
+    name: "problem";
+    type: "block";
+    linkable: true;
+    Data: ProblemData;
+    Storage: ProblemScriptStorage;
+    Children: ProblemContentChild[];
+}, {
+    Problem: import("@jsprose/core").Tag<"Problem", {
+        name: "problem";
+        type: "block";
+        linkable: true;
+        Data: ProblemData;
+        Storage: ProblemScriptStorage;
+        Children: ProblemContentChild[];
+    }, ({
+        title: string;
+        level: import("./shared.js").ProblemLevel;
+        attributes?: (import("./shared.js").ProblemAttribute | import("./shared.js").ProblemCustomAttribute)[];
+    } & {
+        pretty?: true | undefined;
+        applied?: true | undefined;
+        method?: true | undefined;
+        inter?: true | undefined;
+    } & ({
+        children: {};
+        script?: undefined;
+    } | {
+        script: ProblemScriptInstance;
+        children?: undefined;
+    })) & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet & import("../../snippet.js").ObjPropSearch & import("../../snippet.js").ObjPropQuick & import("../../snippet.js").ObjPropSeo>;
+}, undefined>;
+export declare const problemCoreElement: {
+    registryItem: import("@jsprose/core").RegistryItem<{
+        name: "problem";
+        type: "block";
+        linkable: true;
+        Data: ProblemData;
+        Storage: ProblemScriptStorage;
+        Children: ProblemContentChild[];
+    }, {
+        Problem: import("@jsprose/core").Tag<"Problem", {
+            name: "problem";
+            type: "block";
+            linkable: true;
+            Data: ProblemData;
+            Storage: ProblemScriptStorage;
+            Children: ProblemContentChild[];
+        }, ({
+            title: string;
+            level: import("./shared.js").ProblemLevel;
+            attributes?: (import("./shared.js").ProblemAttribute | import("./shared.js").ProblemCustomAttribute)[];
+        } & {
+            pretty?: true | undefined;
+            applied?: true | undefined;
+            method?: true | undefined;
+            inter?: true | undefined;
+        } & ({
+            children: {};
+            script?: undefined;
+        } | {
+            script: ProblemScriptInstance;
+            children?: undefined;
+        })) & import("../../toc.js").ObjPropToc & import("../../snippet.js").ObjPropSnippet & import("../../snippet.js").ObjPropSearch & import("../../snippet.js").ObjPropQuick & import("../../snippet.js").ObjPropSeo>;
+    }, undefined>;
+};

package/dist/elements/problem/problem.js

@@ -0,0 +1,37 @@
+import { defineRegistryItem, defineSchema, ProseError } from "@jsprose/core";
+import { problemProps2Info } from "./shared.js";
+import { validateProblemContent } from "./problemContent.js";
+import { defineEruditTag } from "../../tag.js";
+import { defineEruditProseCoreElement } from "../../coreElement.js";
+import { problemScriptStorageKey } from "./storage.js";
+import "./problemScript.js";
+export const problemSchema = defineSchema({
+	name: "problem",
+	type: "block",
+	linkable: true
+})();
+export const Problem = defineEruditTag({
+	tagName: "Problem",
+	schema: problemSchema
+})(({ element, tagName, props, children }) => {
+	element.data = { info: problemProps2Info(props) };
+	element.title = element.data.info.title;
+	element.snippet = {};
+	element.toc = { add: true };
+	if (children && props.script) {
+		throw new ProseError(`<${tagName}> cannot have both script and children in Problem element!`);
+	}
+	if (props.script) {
+		element.data.scriptUniques = props.script.uniques;
+		element.storageKey = problemScriptStorageKey(props.script.scriptSrc);
+		element.children = props.script.generate().problemContent;
+	} else {
+		validateProblemContent(tagName, children);
+		element.children = children;
+	}
+});
+export const problemRegistryItem = defineRegistryItem({
+	schema: problemSchema,
+	tags: [Problem]
+});
+export const problemCoreElement = defineEruditProseCoreElement({ registryItem: problemRegistryItem });

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

@@ -0,0 +1,439 @@
+import { type AnySchema, type BlockSchema, type NormalizedChildren, type NoTagChildren, type TagChildren } from '@jsprose/core';
+export declare const problemDescriptionSchema: {
+    name: "problemDescription";
+    type: "block";
+    linkable: false;
+    Data: undefined;
+    Storage: undefined;
+    Children: AnySchema[];
+};
+export declare const ProblemDescription: import("@jsprose/core").Tag<"ProblemDescription", {
+    name: "problemDescription";
+    type: "block";
+    linkable: false;
+    Data: undefined;
+    Storage: undefined;
+    Children: AnySchema[];
+}, TagChildren>;
+export declare const problemDescriptionRegistryItem: import("@jsprose/core").RegistryItem<{
+    name: "problemDescription";
+    type: "block";
+    linkable: false;
+    Data: undefined;
+    Storage: undefined;
+    Children: AnySchema[];
+}, {
+    ProblemDescription: import("@jsprose/core").Tag<"ProblemDescription", {
+        name: "problemDescription";
+        type: "block";
+        linkable: false;
+        Data: undefined;
+        Storage: undefined;
+        Children: AnySchema[];
+    }, TagChildren>;
+}, undefined>;
+export declare const problemDescriptionCoreElement: {
+    registryItem: import("@jsprose/core").RegistryItem<{
+        name: "problemDescription";
+        type: "block";
+        linkable: false;
+        Data: undefined;
+        Storage: undefined;
+        Children: AnySchema[];
+    }, {
+        ProblemDescription: import("@jsprose/core").Tag<"ProblemDescription", {
+            name: "problemDescription";
+            type: "block";
+            linkable: false;
+            Data: undefined;
+            Storage: undefined;
+            Children: AnySchema[];
+        }, TagChildren>;
+    }, undefined>;
+};
+export declare const problemHintSchema: {
+    name: "problemHint";
+    type: "block";
+    linkable: false;
+    Data: undefined;
+    Storage: undefined;
+    Children: AnySchema[];
+};
+export declare const ProblemHint: import("@jsprose/core").Tag<"ProblemHint", {
+    name: "problemHint";
+    type: "block";
+    linkable: false;
+    Data: undefined;
+    Storage: undefined;
+    Children: AnySchema[];
+}, TagChildren>;
+export declare const problemHintRegistryItem: import("@jsprose/core").RegistryItem<{
+    name: "problemHint";
+    type: "block";
+    linkable: false;
+    Data: undefined;
+    Storage: undefined;
+    Children: AnySchema[];
+}, {
+    ProblemHint: import("@jsprose/core").Tag<"ProblemHint", {
+        name: "problemHint";
+        type: "block";
+        linkable: false;
+        Data: undefined;
+        Storage: undefined;
+        Children: AnySchema[];
+    }, TagChildren>;
+}, undefined>;
+export declare const problemHintCoreElement: {
+    registryItem: import("@jsprose/core").RegistryItem<{
+        name: "problemHint";
+        type: "block";
+        linkable: false;
+        Data: undefined;
+        Storage: undefined;
+        Children: AnySchema[];
+    }, {
+        ProblemHint: import("@jsprose/core").Tag<"ProblemHint", {
+            name: "problemHint";
+            type: "block";
+            linkable: false;
+            Data: undefined;
+            Storage: undefined;
+            Children: AnySchema[];
+        }, TagChildren>;
+    }, undefined>;
+};
+export declare const problemSectionSchema: {
+    name: "problemSection";
+    type: "block";
+    linkable: false;
+    Data: string;
+    Storage: undefined;
+    Children: AnySchema[];
+};
+export declare const ProblemSection: import("@jsprose/core").Tag<"ProblemSection", {
+    name: "problemSection";
+    type: "block";
+    linkable: false;
+    Data: string;
+    Storage: undefined;
+    Children: AnySchema[];
+}, {
+    title: string;
+} & TagChildren>;
+export declare const problemSectionRegistryItem: import("@jsprose/core").RegistryItem<{
+    name: "problemSection";
+    type: "block";
+    linkable: false;
+    Data: string;
+    Storage: undefined;
+    Children: AnySchema[];
+}, {
+    ProblemSection: import("@jsprose/core").Tag<"ProblemSection", {
+        name: "problemSection";
+        type: "block";
+        linkable: false;
+        Data: string;
+        Storage: undefined;
+        Children: AnySchema[];
+    }, {
+        title: string;
+    } & TagChildren>;
+}, undefined>;
+export declare const problemSectionCoreElement: {
+    registryItem: import("@jsprose/core").RegistryItem<{
+        name: "problemSection";
+        type: "block";
+        linkable: false;
+        Data: string;
+        Storage: undefined;
+        Children: AnySchema[];
+    }, {
+        ProblemSection: import("@jsprose/core").Tag<"ProblemSection", {
+            name: "problemSection";
+            type: "block";
+            linkable: false;
+            Data: string;
+            Storage: undefined;
+            Children: AnySchema[];
+        }, {
+            title: string;
+        } & TagChildren>;
+    }, undefined>;
+};
+export declare const problemNote: {
+    schema: {
+        name: "problemNote";
+        type: "block";
+        linkable: false;
+        Data: undefined;
+        Storage: undefined;
+        Children: AnySchema[];
+    };
+    tag: import("@jsprose/core").Tag<"ProblemNote", {
+        name: "problemNote";
+        type: "block";
+        linkable: false;
+        Data: undefined;
+        Storage: undefined;
+        Children: AnySchema[];
+    }, TagChildren>;
+    registryItem: import("@jsprose/core").RegistryItem<{
+        name: "problemNote";
+        type: "block";
+        linkable: false;
+        Data: undefined;
+        Storage: undefined;
+        Children: AnySchema[];
+    }, {
+        ProblemNote: import("@jsprose/core").Tag<"ProblemNote", {
+            name: "problemNote";
+            type: "block";
+            linkable: false;
+            Data: undefined;
+            Storage: undefined;
+            Children: AnySchema[];
+        }, TagChildren>;
+    }, undefined>;
+    coreElement: {
+        registryItem: import("@jsprose/core").RegistryItem<{
+            name: "problemNote";
+            type: "block";
+            linkable: false;
+            Data: undefined;
+            Storage: undefined;
+            Children: AnySchema[];
+        }, {
+            ProblemNote: import("@jsprose/core").Tag<"ProblemNote", {
+                name: "problemNote";
+                type: "block";
+                linkable: false;
+                Data: undefined;
+                Storage: undefined;
+                Children: AnySchema[];
+            }, TagChildren>;
+        }, undefined>;
+    };
+};
+export declare const problemSolution: {
+    schema: {
+        name: "problemSolution";
+        type: "block";
+        linkable: false;
+        Data: undefined;
+        Storage: undefined;
+        Children: AnySchema[];
+    };
+    tag: import("@jsprose/core").Tag<"ProblemSolution", {
+        name: "problemSolution";
+        type: "block";
+        linkable: false;
+        Data: undefined;
+        Storage: undefined;
+        Children: AnySchema[];
+    }, TagChildren>;
+    registryItem: import("@jsprose/core").RegistryItem<{
+        name: "problemSolution";
+        type: "block";
+        linkable: false;
+        Data: undefined;
+        Storage: undefined;
+        Children: AnySchema[];
+    }, {
+        ProblemSolution: import("@jsprose/core").Tag<"ProblemSolution", {
+            name: "problemSolution";
+            type: "block";
+            linkable: false;
+            Data: undefined;
+            Storage: undefined;
+            Children: AnySchema[];
+        }, TagChildren>;
+    }, undefined>;
+    coreElement: {
+        registryItem: import("@jsprose/core").RegistryItem<{
+            name: "problemSolution";
+            type: "block";
+            linkable: false;
+            Data: undefined;
+            Storage: undefined;
+            Children: AnySchema[];
+        }, {
+            ProblemSolution: import("@jsprose/core").Tag<"ProblemSolution", {
+                name: "problemSolution";
+                type: "block";
+                linkable: false;
+                Data: undefined;
+                Storage: undefined;
+                Children: AnySchema[];
+            }, TagChildren>;
+        }, undefined>;
+    };
+};
+export declare const problemAnswer: {
+    schema: {
+        name: "problemAnswer";
+        type: "block";
+        linkable: false;
+        Data: undefined;
+        Storage: undefined;
+        Children: AnySchema[];
+    };
+    tag: import("@jsprose/core").Tag<"ProblemAnswer", {
+        name: "problemAnswer";
+        type: "block";
+        linkable: false;
+        Data: undefined;
+        Storage: undefined;
+        Children: AnySchema[];
+    }, TagChildren>;
+    registryItem: import("@jsprose/core").RegistryItem<{
+        name: "problemAnswer";
+        type: "block";
+        linkable: false;
+        Data: undefined;
+        Storage: undefined;
+        Children: AnySchema[];
+    }, {
+        ProblemAnswer: import("@jsprose/core").Tag<"ProblemAnswer", {
+            name: "problemAnswer";
+            type: "block";
+            linkable: false;
+            Data: undefined;
+            Storage: undefined;
+            Children: AnySchema[];
+        }, TagChildren>;
+    }, undefined>;
+    coreElement: {
+        registryItem: import("@jsprose/core").RegistryItem<{
+            name: "problemAnswer";
+            type: "block";
+            linkable: false;
+            Data: undefined;
+            Storage: undefined;
+            Children: AnySchema[];
+        }, {
+            ProblemAnswer: import("@jsprose/core").Tag<"ProblemAnswer", {
+                name: "problemAnswer";
+                type: "block";
+                linkable: false;
+                Data: undefined;
+                Storage: undefined;
+                Children: AnySchema[];
+            }, TagChildren>;
+        }, undefined>;
+    };
+};
+export type CheckFunction = (args: {
+    answer: string | undefined;
+    name: string;
+    answers: Record<string, string | undefined>;
+}) => boolean;
+export interface ProblemCheckData {
+    label?: string;
+    hint?: string;
+    placeholder?: string;
+    answers?: (string | undefined)[];
+    script?: string;
+}
+export declare const problemCheckSchema: {
+    name: "problemCheck";
+    type: "block";
+    linkable: false;
+    Data: ProblemCheckData;
+    Storage: undefined;
+    Children: BlockSchema[];
+};
+export declare const ProblemCheck: import("@jsprose/core").Tag<"ProblemCheck", {
+    name: "problemCheck";
+    type: "block";
+    linkable: false;
+    Data: ProblemCheckData;
+    Storage: undefined;
+    Children: BlockSchema[];
+}, ({
+    label?: string;
+    hint?: string;
+    placeholder?: string;
+} & (({
+    answer: string | number;
+    answers?: undefined;
+    script?: undefined;
+} | {
+    answers: (string | number)[];
+    answer?: undefined;
+    script?: undefined;
+} | {
+    script: string;
+    answers?: undefined;
+    answer?: undefined;
+}) & NoTagChildren)) & {}>;
+export declare const problemCheckRegistryItem: import("@jsprose/core").RegistryItem<{
+    name: "problemCheck";
+    type: "block";
+    linkable: false;
+    Data: ProblemCheckData;
+    Storage: undefined;
+    Children: BlockSchema[];
+}, {
+    ProblemCheck: import("@jsprose/core").Tag<"ProblemCheck", {
+        name: "problemCheck";
+        type: "block";
+        linkable: false;
+        Data: ProblemCheckData;
+        Storage: undefined;
+        Children: BlockSchema[];
+    }, ({
+        label?: string;
+        hint?: string;
+        placeholder?: string;
+    } & (({
+        answer: string | number;
+        answers?: undefined;
+        script?: undefined;
+    } | {
+        answers: (string | number)[];
+        answer?: undefined;
+        script?: undefined;
+    } | {
+        script: string;
+        answers?: undefined;
+        answer?: undefined;
+    }) & NoTagChildren)) & {}>;
+}, undefined>;
+export declare const problemCheckCoreElement: {
+    registryItem: import("@jsprose/core").RegistryItem<{
+        name: "problemCheck";
+        type: "block";
+        linkable: false;
+        Data: ProblemCheckData;
+        Storage: undefined;
+        Children: BlockSchema[];
+    }, {
+        ProblemCheck: import("@jsprose/core").Tag<"ProblemCheck", {
+            name: "problemCheck";
+            type: "block";
+            linkable: false;
+            Data: ProblemCheckData;
+            Storage: undefined;
+            Children: BlockSchema[];
+        }, ({
+            label?: string;
+            hint?: string;
+            placeholder?: string;
+        } & (({
+            answer: string | number;
+            answers?: undefined;
+            script?: undefined;
+        } | {
+            answers: (string | number)[];
+            answer?: undefined;
+            script?: undefined;
+        } | {
+            script: string;
+            answers?: undefined;
+            answer?: undefined;
+        }) & NoTagChildren)) & {}>;
+    }, undefined>;
+};
+export type ProblemContentChild = typeof problemDescriptionSchema | typeof problemHintSchema | typeof problemNote.schema | typeof problemSolution.schema | typeof problemAnswer.schema | typeof problemCheckSchema;
+export declare function validateProblemContent(source: string, children: NormalizedChildren): void;