@instructure/platform-block-content-editor 2.0.0 → 2.1.0

package/dist/schema/index.d.ts

@@ -2,4 +2,5 @@ export { parseDescription, type ZodFormMetadata, type ZodRangeConfig, type ZodHi
 export { validateComponentSchema, type ValidationError, type ValidationIssue, type ValidationResult, } from './schemaValidator';
 export { registerComponentSchema, type RegisteredComponentSchema, } from './registeredSchema';
 export { FormFieldType, type FormFieldMetadata, extractFieldMetadata, extractFormMetadata, } from './zodUtils';
+export { getBlockSchema, mapFieldsWithMetadata, type BlockSchema, type MetadataKey, } from './schemaRegistry';
 //# sourceMappingURL=index.d.ts.map

package/dist/schema/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/schema/index.ts"],"names":[],"mappings":"AAmBA,OAAO,iBAAiB,CAAA;AAExB,OAAO,EACL,gBAAgB,EAChB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,GAC3B,MAAM,iBAAiB,CAAA;AAGxB,OAAO,EACL,uBAAuB,EACvB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,gBAAgB,GACtB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EACL,uBAAuB,EACvB,KAAK,yBAAyB,GAC/B,MAAM,oBAAoB,CAAA;AAK3B,OAAO,EACL,aAAa,EACb,KAAK,iBAAiB,EACtB,oBAAoB,EACpB,mBAAmB,GACpB,MAAM,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/schema/index.ts"],"names":[],"mappings":"AAmBA,OAAO,iBAAiB,CAAA;AAExB,OAAO,EACL,gBAAgB,EAChB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,GAC3B,MAAM,iBAAiB,CAAA;AAGxB,OAAO,EACL,uBAAuB,EACvB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,gBAAgB,GACtB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EACL,uBAAuB,EACvB,KAAK,yBAAyB,GAC/B,MAAM,oBAAoB,CAAA;AAK3B,OAAO,EACL,aAAa,EACb,KAAK,iBAAiB,EACtB,oBAAoB,EACpB,mBAAmB,GACpB,MAAM,YAAY,CAAA;AAEnB,OAAO,EACL,cAAc,EACd,qBAAqB,EACrB,KAAK,WAAW,EAChB,KAAK,WAAW,GACjB,MAAM,kBAAkB,CAAA"}

package/dist/schema/schemaRegistry.d.ts

@@ -0,0 +1,173 @@
+import { BlockName } from '../registry/blockCatalogue';
+import { RegisteredComponentSchema } from './registeredSchema';
+declare const BLOCK_SCHEMAS: {
+    Accordion: RegisteredComponentSchema<{
+        items: {
+            id: string;
+            title: string;
+            content: string;
+        }[];
+        title?: string | undefined;
+        variant?: "h2" | "h3" | "h4" | undefined;
+        supportingText?: string | undefined;
+        accordionStyle?: "outline" | "solid" | undefined;
+        colorTheme?: "light" | "dark" | "neutral" | undefined;
+        connection?: "connected" | "separated" | undefined;
+        cornerStyle?: "rounded" | "square" | undefined;
+        dropdownPlacement?: "left" | "right" | undefined;
+        dropdownDirection?: "center" | "down" | undefined;
+    }>;
+    Header: RegisteredComponentSchema<{
+        title: string;
+        variant: "h2" | "h3" | "h4";
+        content?: string | undefined;
+        cornerStyle?: "rounded" | "square" | undefined;
+        alt?: string | undefined;
+        style?: "image" | "none" | "outline" | "solid" | undefined;
+        color?: "light" | "dark" | "neutral" | undefined;
+        align?: "left" | "center" | "right" | undefined;
+        subtitle?: string | undefined;
+        eyebrowStyle?: "all-caps" | "sentence-case" | "capitalized" | undefined;
+        imagePlacement?: "background" | "above" | "below" | undefined;
+        asset_id?: string | undefined;
+        isDecorative?: boolean | undefined;
+    }>;
+    CodeBlock: RegisteredComponentSchema<{
+        code: string;
+        language: "html" | "text" | "javascript" | "json" | "css" | "bash" | "yaml";
+        cornerStyle?: "rounded" | "square" | undefined;
+        header?: string | undefined;
+    }>;
+    FlashCards: RegisteredComponentSchema<{
+        cards: {
+            front: string;
+            back: string;
+        }[];
+        colorTheme?: "light" | "dark" | "neutral" | undefined;
+        cornerStyle?: "rounded" | "square" | undefined;
+        randomize?: boolean | undefined;
+    }>;
+    ImageBlock: RegisteredComponentSchema<{
+        alt: string;
+        size: number;
+        align: "left" | "center" | "right";
+        asset_id: string;
+        isDecorative: boolean;
+        ratio: "square" | "circle" | "landscape" | "portrait";
+        cornerStyle?: "rounded" | "square" | undefined;
+    }>;
+    KnowledgeCheckBlock: RegisteredComponentSchema<{
+        answers: {
+            id: string;
+            label: string;
+            isCorrect: boolean;
+        }[];
+        question: string;
+        cornerStyle?: "rounded" | "square" | undefined;
+        questionType?: "Multiple choice" | "True or false" | undefined;
+        answerOrder?: "set" | "random" | undefined;
+        headerStyle?: "light" | "dark" | "none" | undefined;
+    }>;
+    LayoutContainer: RegisteredComponentSchema<{
+        children?: any;
+        rowSpan?: number | undefined;
+        margin?: {
+            left?: "small" | "none" | "medium" | "large" | "xsmall" | "xlarge" | "xxlarge" | undefined;
+            right?: "small" | "none" | "medium" | "large" | "xsmall" | "xlarge" | "xxlarge" | undefined;
+            bottom?: "small" | "none" | "medium" | "large" | "xsmall" | "xlarge" | "xxlarge" | undefined;
+            top?: "small" | "none" | "medium" | "large" | "xsmall" | "xlarge" | "xxlarge" | undefined;
+        } | undefined;
+        order?: number | undefined;
+        columnSpan?: number | undefined;
+        gridColumn?: number | undefined;
+        gridRow?: number | undefined;
+        horizontalPosition?: "left" | "center" | "right" | undefined;
+        verticalPosition?: "normal" | "middle" | "bottom" | "top" | undefined;
+        backgroundStyle?: "none" | "primary" | "secondary" | undefined;
+    }>;
+    MixAndMatch: RegisteredComponentSchema<{
+        pairs: {
+            definition: string;
+            term: string;
+        }[];
+        colorTheme?: "light" | "dark" | "neutral" | undefined;
+        cornerStyle?: "rounded" | "square" | undefined;
+        randomizeCards?: "off" | "on" | undefined;
+    }>;
+    QuoteBlock: RegisteredComponentSchema<{
+        content: string;
+        cornerStyle?: "rounded" | "square" | undefined;
+        author?: string | undefined;
+        decorationStyle?: "none" | "background-secondary" | "background-grey" | "border-primary" | undefined;
+    }>;
+    TabsBlock: RegisteredComponentSchema<{
+        tabs: {
+            id: string;
+            content: string;
+            label: string;
+        }[];
+        outline?: "none" | "outline" | undefined;
+        title?: string | undefined;
+        variant?: "h2" | "h3" | "h4" | undefined;
+        supportingText?: string | undefined;
+        cornerStyle?: "rounded" | "square" | undefined;
+        style?: "simple" | "folder" | "segments" | undefined;
+        color?: "light" | "dark" | "neutral" | undefined;
+        tabsRowBackground?: "none" | "filled" | undefined;
+        tabsWidth?: "relative" | "full-width" | undefined;
+        alignment?: "left" | "center" | undefined;
+        selectedTabStyle?: "outline" | "filled" | undefined;
+        selectedTabCorners?: "rounded" | "square" | "pill" | undefined;
+    }>;
+    Text: RegisteredComponentSchema<{
+        content: string;
+        colorTheme?: "light" | "dark" | "neutral" | undefined;
+        cornerStyle?: "rounded" | "square" | undefined;
+        textStyle?: "fill" | "none" | "outline" | undefined;
+    }>;
+    TwoColumn: RegisteredComponentSchema<{
+        children?: any;
+        cornerStyle?: "rounded" | "square" | undefined;
+        leftColumnWidth?: number | undefined;
+        mobileStackingOrder?: "left-first" | "right-first" | undefined;
+        gapSpacing?: "small" | "none" | "medium" | "large" | undefined;
+        containerStyle?: "none" | "outline" | "solid" | undefined;
+        backgroundColor?: "light" | "dark" | "neutral" | "none" | undefined;
+    }>;
+    VideoBlock: RegisteredComponentSchema<{
+        alt: string;
+        size: number;
+        source: "link" | "file";
+        align: "left" | "center" | "right";
+        asset_id: string;
+        cornerStyle?: "rounded" | "square" | undefined;
+        video_url?: string | undefined;
+    }>;
+    WidgetBlock: RegisteredComponentSchema<{
+        widgetType: string;
+    }>;
+};
+export type BlockSchema = (typeof BLOCK_SCHEMAS)[BlockName];
+export declare function getBlockSchema(blockName: BlockName): BlockSchema | undefined;
+/**
+ * The name of a boolean marker a prop's metadata can carry (e.g. `richtext`
+ * boolean marker from `.zodRichText()`).
+ */
+export type MetadataKey = 'richtext' | 'attachmentIdField';
+/**
+ * Apply `fn` to every value whose field metadata has `metadataKey` set in a block's props (nested
+ * fields included), and return a cloned, transformed props object (the input is not mutated). `fn`
+ * receives `{ key, value }` for each matching field and returns the new value.
+ *
+ * @example
+ * // sanitize every rich-text field's HTML in a stored block's props
+ * const clean = mapFieldsWithMetadata(schema, props, 'richtext', ({ value }) =>
+ *   typeof value === 'string' ? sanitizeHtml(value) : value,
+ * )
+ */
+export declare function mapFieldsWithMetadata<T extends object>(schema: BlockSchema, props: T, metadataKey: MetadataKey, fn: (field: {
+    key: string;
+    value: unknown;
+}) => unknown): T;
+export {};
+//# sourceMappingURL=schemaRegistry.d.ts.map

package/dist/schema/schemaRegistry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemaRegistry.d.ts","sourceRoot":"","sources":["../../src/schema/schemaRegistry.ts"],"names":[],"mappings":"AAgCA,OAAO,EAAE,KAAK,SAAS,EAAgB,MAAM,4BAA4B,CAAA;AACzE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAA;AAGnE,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAe8C,CAAA;AAEjE,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,SAAS,CAAC,CAAA;AAE3D,wBAAgB,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,WAAW,GAAG,SAAS,CAE5E;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,mBAAmB,CAAA;AAoD1D;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,MAAM,EACpD,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,CAAC,EACR,WAAW,EAAE,WAAW,EACxB,EAAE,EAAE,CAAC,KAAK,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,KAAK,OAAO,GACtD,CAAC,CAMH"}

package/dist/schema/schemaRegistry.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=schemaRegistry.test.d.ts.map

package/dist/schema/schemaRegistry.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemaRegistry.test.d.ts","sourceRoot":"","sources":["../../src/schema/schemaRegistry.test.ts"],"names":[],"mappings":""}

package/dist/schema/zodUtils.d.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { RegisteredComponentSchema } from './registeredSchema';
 import { ZodFormMetadata } from './zodExtensions';
 /**
  * Unwraps ZodOptional, ZodDefault, ZodNullable wrappers to get the inner type
@@ -86,5 +87,5 @@ export declare function extractFieldMetadata(name: string, zodType: z.ZodTypeAny
  * This is the main function for generating forms from Zod schemas.
  * It returns metadata for each field that can be used to render form inputs.
  */
-export declare function extractFormMetadata(schema: z.ZodObject<z.ZodRawShape>): Record<string, FormFieldMetadata>;
+export declare function extractFormMetadata(schema: z.ZodObject<z.ZodRawShape> | RegisteredComponentSchema<unknown>): Record<string, FormFieldMetadata>;
 //# sourceMappingURL=zodUtils.d.ts.map

package/dist/schema/zodUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"zodUtils.d.ts","sourceRoot":"","sources":["../../src/schema/zodUtils.ts"],"names":[],"mappings":"AAkBA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,EAAoB,KAAK,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAExE;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,CAajE;AAED;;GAEG;AACH,oBAAY,aAAa;IACvB,IAAI,SAAS;IACb,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,KAAK,UAAU;IACf,UAAU,eAAe;IACzB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACxD,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,aAAa,CAAA;IACnB,QAAQ,EAAE,OAAO,CAAA;IACjB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,OAAO,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAC1D,UAAU,CAAC,EAAE;QACX,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,qFAAqF;QACrF,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,qFAAqF;QACrF,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,KAAK,CAAC,EAAE,OAAO,CAAA;QACf,GAAG,CAAC,EAAE,OAAO,CAAA;KACd,CAAA;IACD,0DAA0D;IAC1D,UAAU,CAAC,EAAE,CAAC,CAAC,UAAU,CAAA;IACzB,yFAAyF;IACzF,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;IAClD,uBAAuB;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;CAC/C;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,GAAG,aAAa,CAyEpE;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,GAAG,iBAAiB,CAAC,YAAY,CAAC,CAsD7F;AA+FD;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,UAAU,GAAG,iBAAiB,CAmD3F;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,GACjC,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CASnC"}
+{"version":3,"file":"zodUtils.d.ts","sourceRoot":"","sources":["../../src/schema/zodUtils.ts"],"names":[],"mappings":"AAkBA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAA;AACnE,OAAO,EAAoB,KAAK,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAExE;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,CAajE;AAED;;GAEG;AACH,oBAAY,aAAa;IACvB,IAAI,SAAS;IACb,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,KAAK,UAAU;IACf,UAAU,eAAe;IACzB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACxD,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,aAAa,CAAA;IACnB,QAAQ,EAAE,OAAO,CAAA;IACjB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,OAAO,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAC1D,UAAU,CAAC,EAAE;QACX,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,qFAAqF;QACrF,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,qFAAqF;QACrF,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,KAAK,CAAC,EAAE,OAAO,CAAA;QACf,GAAG,CAAC,EAAE,OAAO,CAAA;KACd,CAAA;IACD,0DAA0D;IAC1D,UAAU,CAAC,EAAE,CAAC,CAAC,UAAU,CAAA;IACzB,yFAAyF;IACzF,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;IAClD,uBAAuB;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;CAC/C;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,GAAG,aAAa,CAyEpE;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,GAAG,iBAAiB,CAAC,YAAY,CAAC,CAsD7F;AA+FD;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,UAAU,GAAG,iBAAiB,CAmD3F;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,yBAAyB,CAAC,OAAO,CAAC,GACtE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAWnC"}

package/locales/en.json

@@ -2,6 +2,8 @@
   "placeholderContent": "Your content here...",
   "bannerPlaceholderTitle": "Your banner",
   "bannerPlaceholderSubtitle": "Your optional eyebrow text",
+  "bannerImageLoading": "Loading image...",
+  "bannerImageError": "Failed to load image",
   "quotePlaceholderContent": "Your quote here",
   "quotePlaceholderAuthor": "Author",
   "codeBlockPlaceholder": "// Your code here",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/platform-block-content-editor",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Host-agnostic block content editor for Canvas activities — the blocks, the read-path viewer, and the write-path editor, all on native InstUI.",
   "type": "module",
   "main": "./dist/index.js",
@@ -9,7 +9,8 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
     },
     "./locales/en.json": "./locales/en.json"
   },