@instructure/platform-block-content-editor 3.1.0 → 3.3.0

package/dist/registry/index.d.ts

@@ -3,5 +3,6 @@ export { BLOCK_CATALOGUE, BlockCategory, type BlockCatalogueEntry, type BlockNam
 export { type BlockDefinition, type BlockFactoryOptions, defineBlock, type UntranslatedBlockFactoryOptions, } from './defineBlock';
 export { getMergedProps } from './getMergedProps';
 export { resolveBlockEntry } from './resolveBlockEntry';
-export type { GridPositionProps, LayoutNode, TemplateData, TemplateDataFor, TemplateLayoutFor, } from './templateTypes';
+export { TemplateIdSchema, TemplateLayoutSchema } from './templateTypes';
+export type { GridPositionProps, LayoutNode, TemplateData, TemplateDataFor, TemplateLayout, TemplateLayoutFor, } from './templateTypes';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/registry/index.ts"],"names":[],"mappings":"AAkBA,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,iBAAiB,EACjB,cAAc,EACd,KAAK,OAAO,GACb,MAAM,iBAAiB,CAAA;AACxB,OAAO,EACL,eAAe,EACf,aAAa,EACb,KAAK,mBAAmB,EACxB,KAAK,SAAS,EACd,iBAAiB,EACjB,YAAY,EACZ,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,gBAAgB,GACjB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,WAAW,EACX,KAAK,+BAA+B,GACrC,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,YAAY,EACV,iBAAiB,EACjB,UAAU,EACV,YAAY,EACZ,eAAe,EACf,iBAAiB,GAClB,MAAM,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/registry/index.ts"],"names":[],"mappings":"AAkBA,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,iBAAiB,EACjB,cAAc,EACd,KAAK,OAAO,GACb,MAAM,iBAAiB,CAAA;AACxB,OAAO,EACL,eAAe,EACf,aAAa,EACb,KAAK,mBAAmB,EACxB,KAAK,SAAS,EACd,iBAAiB,EACjB,YAAY,EACZ,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,gBAAgB,GACjB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,WAAW,EACX,KAAK,+BAA+B,GACrC,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AACxE,YAAY,EACV,iBAAiB,EACjB,UAAU,EACV,YAAY,EACZ,eAAe,EACf,cAAc,EACd,iBAAiB,GAClB,MAAM,iBAAiB,CAAA"}

package/dist/registry/templateLayoutSchema.test.d.ts

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

package/dist/registry/templateLayoutSchema.test.d.ts.map

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

package/dist/registry/templateTypes.d.ts

@@ -1,29 +1,39 @@
+import { z } from 'zod';
 import { BlockRegistry, PropsOf } from './blockRegistry';
+declare const GridPositionPropsSchema: z.ZodObject<{
+    gridColumn: z.ZodOptional<z.ZodNumber>;
+    gridRow: z.ZodOptional<z.ZodNumber>;
+    columnSpan: z.ZodOptional<z.ZodNumber>;
+    rowSpan: z.ZodOptional<z.ZodNumber>;
+    order: z.ZodOptional<z.ZodNumber>;
+}, "strict", z.ZodTypeAny, {
+    rowSpan?: number | undefined;
+    order?: number | undefined;
+    columnSpan?: number | undefined;
+    gridColumn?: number | undefined;
+    gridRow?: number | undefined;
+}, {
+    rowSpan?: number | undefined;
+    order?: number | undefined;
+    columnSpan?: number | undefined;
+    gridColumn?: number | undefined;
+    gridRow?: number | undefined;
+}>;
 /**
  * Where a node sits in the designer's grid. Structure, never content — see the
  * TemplateLayout/TemplateData split below.
  */
-export interface GridPositionProps {
-    gridColumn?: number;
-    gridRow?: number;
-    columnSpan?: number;
-    rowSpan?: number;
-    order?: number;
-}
-/**
- * The structural minimum every layout node satisfies, and what this package's own code
- * works against.
- *
- * `props?: object`, not `Record<string, unknown>`: a host block whose props are declared
- * as an `interface` gets no implicit index signature and would fail to assign, while a
- * `z.infer`'d type alias would pass — an arbitrary distinction to inflict on a host.
- */
-export interface LayoutNode {
+export type GridPositionProps = z.infer<typeof GridPositionPropsSchema>;
+export interface LayoutNode<P = object> {
     component: string;
     id: string;
-    props?: object;
-    children?: LayoutNode[];
+    props?: P;
+    children?: LayoutNode<P>[];
 }
+export declare const TemplateIdSchema: z.ZodBranded<z.ZodString, "TemplateId">;
+type PersistedLayoutNode = LayoutNode<GridPositionProps>;
+export declare const TemplateLayoutSchema: z.ZodBranded<z.ZodArray<z.ZodType<PersistedLayoutNode, z.ZodTypeDef, PersistedLayoutNode>, "many">, "TemplateLayout">;
+export type TemplateLayout = z.infer<typeof TemplateLayoutSchema>;
 /**
  * Content props keyed by node id: `{ 'text-1': { content: '…' } }`.
  *
@@ -58,4 +68,5 @@ export type TemplateDataFor<R extends BlockRegistry> = {
         [K in keyof R]: Partial<PropsOf<R[K]>>;
     }[keyof R];
 };
+export {};
 //# sourceMappingURL=templateTypes.d.ts.map

package/dist/registry/templateTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"templateTypes.d.ts","sourceRoot":"","sources":["../../src/registry/templateTypes.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE7D;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAA;CACxB;AAED;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAEjD;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,aAAa,IAAI;KACtD,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,GAAG;QACvB,SAAS,EAAE,CAAC,CAAA;QACZ,EAAE,EAAE,MAAM,CAAA;QACV,KAAK,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAA;QAClD,QAAQ,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAA;KAClC;CACF,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAA;AAEnB,iEAAiE;AACjE,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,aAAa,IAAI;IACrD,CAAC,UAAU,EAAE,MAAM,GAAG;SAAG,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE,CAAC,MAAM,CAAC,CAAC,CAAA;CAC1E,CAAA"}
+{"version":3,"file":"templateTypes.d.ts","sourceRoot":"","sources":["../../src/registry/templateTypes.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE7D,QAAA,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;EAQlB,CAAA;AAEX;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AACvE,MAAM,WAAW,UAAU,CAAC,CAAC,GAAG,MAAM;IACpC,SAAS,EAAE,MAAM,CAAA;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,CAAC,EAAE,CAAC,CAAA;IACT,QAAQ,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAA;CAC3B;AAGD,eAAO,MAAM,gBAAgB,yCAGL,CAAA;AAGxB,KAAK,mBAAmB,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAA;AAYxD,eAAO,MAAM,oBAAoB,uHAGL,CAAA;AAE5B,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEjE;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAEjD;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,aAAa,IAAI;KACtD,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,GAAG;QACvB,SAAS,EAAE,CAAC,CAAA;QACZ,EAAE,EAAE,MAAM,CAAA;QACV,KAAK,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAA;QAClD,QAAQ,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAA;KAClC;CACF,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAA;AAEnB,iEAAiE;AACjE,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,aAAa,IAAI;IACrD,CAAC,UAAU,EAAE,MAAM,GAAG;SAAG,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE,CAAC,MAAM,CAAC,CAAC,CAAA;CAC1E,CAAA"}

package/locales/en.json

@@ -82,6 +82,7 @@
   "deleteComponent": "Delete %{component}",
   "delete": "Delete",
   "editComponent": "Edit %{component} component",
+  "editBlock": "Edit block",
   "componentGroup": "%{component} component",
   "leftColumnLabel": "Left column",
   "rightColumnLabel": "Right column",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/platform-block-content-editor",
-  "version": "3.1.0",
+  "version": "3.3.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",