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

package/dist/registry/blockCatalogue.d.ts

@@ -1,6 +1,7 @@
 /**
- * Every block name this version of the package knows about — strings only, no component
- * references, so a renderer can consult it without reaching for a block's implementation.
+ * Every block this version of the package knows about — strings and metadata only, no
+ * component references, so a renderer can consult it without reaching for a block's
+ * implementation.
  *
  * Its job is to tell two failure modes apart when a saved document names a block the
  * registry can't resolve: one the host deliberately left out, versus one nothing here has
@@ -16,80 +17,87 @@ export declare const BlockCategory: {
 };
 export type BlockCategory = (typeof BlockCategory)[keyof typeof BlockCategory];
 export interface BlockCatalogueEntry {
+    /**
+     * **Wire format** — the `component` string in stored `TemplateLayout` — and not always the
+     * component's name. `Header` renders `Banner`, `QuoteBlock` renders `Quote`,
+     * `KnowledgeCheckBlock` renders `KnowledgeCheck`. Renaming it orphans every document that
+     * used it.
+     */
+    wireName: string;
     category: BlockCategory;
     acceptsChildren: boolean;
 }
 /**
- * Keys are **wire format** — the `component` string in stored `TemplateLayout` — and are
- * not always the component's name. `Header` renders `Banner`, `QuoteBlock` renders
- * `Quote`, `KnowledgeCheckBlock` renders `KnowledgeCheck`. Renaming a key orphans every
- * document that used it.
+ * The package's block catalogue, one entry per shipped block. **Array position is this
+ * package's single canonical display/insertion order** — `blockDefinitions.tsx` derives its
+ * per-category tray order straight from this order, so reordering a block here is the only
+ * change needed to reorder it everywhere.
  *
  * No labels here: a label is user-facing text, so it arrives already translated when the
  * host registers the block (`create<Name>Block({ label })`). An unresolved block has no
  * label by definition.
  */
-export declare const BLOCK_CATALOGUE: {
-    readonly LayoutContainer: {
-        readonly category: "layout";
-        readonly acceptsChildren: true;
-    };
-    readonly TwoColumn: {
-        readonly category: "layout";
-        readonly acceptsChildren: true;
-    };
-    readonly Header: {
-        readonly category: "activityContent";
-        readonly acceptsChildren: false;
-    };
-    readonly Text: {
-        readonly category: "activityContent";
-        readonly acceptsChildren: false;
-    };
-    readonly QuoteBlock: {
-        readonly category: "activityContent";
-        readonly acceptsChildren: false;
-    };
-    readonly CodeBlock: {
-        readonly category: "activityContent";
-        readonly acceptsChildren: false;
-    };
-    readonly ImageBlock: {
-        readonly category: "activityContent";
-        readonly acceptsChildren: false;
-    };
-    readonly VideoBlock: {
-        readonly category: "activityContent";
-        readonly acceptsChildren: false;
-    };
-    readonly Accordion: {
-        readonly category: "interactiveContent";
-        readonly acceptsChildren: false;
-    };
-    readonly TabsBlock: {
-        readonly category: "interactiveContent";
-        readonly acceptsChildren: false;
-    };
-    readonly KnowledgeCheckBlock: {
-        readonly category: "interactiveContent";
-        readonly acceptsChildren: false;
-    };
-    readonly FlashCards: {
-        readonly category: "interactiveContent";
-        readonly acceptsChildren: false;
-    };
-    readonly MixAndMatch: {
-        readonly category: "interactiveContent";
-        readonly acceptsChildren: false;
-    };
-    readonly WidgetBlock: {
-        readonly category: "widget";
-        readonly acceptsChildren: false;
-    };
-};
+export declare const BLOCK_CATALOGUE: readonly [{
+    readonly wireName: "LayoutContainer";
+    readonly category: "layout";
+    readonly acceptsChildren: true;
+}, {
+    readonly wireName: "TwoColumn";
+    readonly category: "layout";
+    readonly acceptsChildren: true;
+}, {
+    readonly wireName: "Header";
+    readonly category: "activityContent";
+    readonly acceptsChildren: false;
+}, {
+    readonly wireName: "Text";
+    readonly category: "activityContent";
+    readonly acceptsChildren: false;
+}, {
+    readonly wireName: "QuoteBlock";
+    readonly category: "activityContent";
+    readonly acceptsChildren: false;
+}, {
+    readonly wireName: "CodeBlock";
+    readonly category: "activityContent";
+    readonly acceptsChildren: false;
+}, {
+    readonly wireName: "ImageBlock";
+    readonly category: "activityContent";
+    readonly acceptsChildren: false;
+}, {
+    readonly wireName: "VideoBlock";
+    readonly category: "activityContent";
+    readonly acceptsChildren: false;
+}, {
+    readonly wireName: "Accordion";
+    readonly category: "activityContent";
+    readonly acceptsChildren: false;
+}, {
+    readonly wireName: "TabsBlock";
+    readonly category: "activityContent";
+    readonly acceptsChildren: false;
+}, {
+    readonly wireName: "KnowledgeCheckBlock";
+    readonly category: "interactiveContent";
+    readonly acceptsChildren: false;
+}, {
+    readonly wireName: "FlashCards";
+    readonly category: "interactiveContent";
+    readonly acceptsChildren: false;
+}, {
+    readonly wireName: "MixAndMatch";
+    readonly category: "interactiveContent";
+    readonly acceptsChildren: false;
+}, {
+    readonly wireName: "WidgetBlock";
+    readonly category: "widget";
+    readonly acceptsChildren: false;
+}];
 /** Wire names of the blocks this package ships. */
-export type BlockName = keyof typeof BLOCK_CATALOGUE;
+export type BlockName = (typeof BLOCK_CATALOGUE)[number]['wireName'];
 export declare function isKnownBlock(name: string): name is BlockName;
+export declare function getCatalogueEntry(wireName: string): BlockCatalogueEntry | undefined;
 /**
  * Why a renderer could not resolve a node.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"blockCatalogue.d.ts","sourceRoot":"","sources":["../../src/registry/blockCatalogue.ts"],"names":[],"mappings":"AAkBA;;;;;;;;GAQG;AAEH,qDAAqD;AACrD,eAAO,MAAM,aAAa;;;;;CAKhB,CAAA;AAEV,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAA;AAE9E,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,aAAa,CAAA;IACvB,eAAe,EAAE,OAAO,CAAA;CACzB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkB4B,CAAA;AAExD,mDAAmD;AACnD,MAAM,MAAM,SAAS,GAAG,MAAM,OAAO,eAAe,CAAA;AAEpD,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,SAAS,CAI5D;AAED;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG,gBAAgB,GAAG,SAAS,CAAA;AAEhE,MAAM,WAAW,eAAe;IAC9B,+BAA+B;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,qDAAqD;IACrD,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,qBAAqB,CAAA;CAC9B;AAED,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,qBAAqB,CAEzE"}
+{"version":3,"file":"blockCatalogue.d.ts","sourceRoot":"","sources":["../../src/registry/blockCatalogue.ts"],"names":[],"mappings":"AAkBA;;;;;;;;;GASG;AAEH,qDAAqD;AACrD,eAAO,MAAM,aAAa;;;;;CAKhB,CAAA;AAEV,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAA;AAE9E,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,aAAa,CAAA;IACvB,eAAe,EAAE,OAAO,CAAA;CACzB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmBuB,CAAA;AAEnD,mDAAmD;AACnD,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,CAAA;AAWpE,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,SAAS,CAI5D;AAED,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS,CAEnF;AAED;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG,gBAAgB,GAAG,SAAS,CAAA;AAEhE,MAAM,WAAW,eAAe;IAC9B,+BAA+B;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,qDAAqD;IACrD,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,qBAAqB,CAAA;CAC9B;AAED,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,qBAAqB,CAEzE"}

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

@@ -1 +1 @@
-{"version":3,"file":"defineBlock.d.ts","sourceRoot":"","sources":["../../src/registry/defineBlock.tsx"],"names":[],"mappings":"AAkBA,OAAO,EAAE,KAAK,aAAa,EAAiB,KAAK,SAAS,EAAE,MAAM,OAAO,CAAA;AACzE,OAAO,EACL,KAAK,eAAe,EAErB,MAAM,sCAAsC,CAAA;AAE7C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAA;AAC/E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AAC3E,OAAO,EAAmB,KAAK,SAAS,EAAgB,MAAM,kBAAkB,CAAA;AAChF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAYzD,gEAAgE;AAChE,MAAM,WAAW,eAAe,CAAC,MAAM;IACrC;;;;;;;;OAQG;IACH,QAAQ,EAAE,SAAS,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;IACnC,SAAS,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAChC,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC,CAAA;IACzC,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;IAC7B,6EAA6E;IAC7E,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,SAAS,CAAA;IACzD,yBAAyB,CAAC,EAAE,MAAM,CAAA;CACnC;AAED,4DAA4D;AAC5D,MAAM,WAAW,mBAAmB,CAAC,aAAa;IAChD,2EAA2E;IAC3E,KAAK,EAAE,MAAM,CAAA;IACb,oEAAoE;IACpE,YAAY,EAAE,aAAa,CAAA;IAC3B,qGAAqG;IACrG,aAAa,CAAC,EAAE,kBAAkB,EAAE,CAAA;CACrC;AAED,qEAAqE;AACrE,MAAM,WAAW,+BAA+B;IAC9C,2EAA2E;IAC3E,KAAK,EAAE,MAAM,CAAA;IACb,qGAAqG;IACrG,aAAa,CAAC,EAAE,kBAAkB,EAAE,CAAA;CACrC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,QAAQ,SAAS,eAAe,CAAC,QAAQ,CAAC,EAC5E,UAAU,EAAE,eAAe,CAAC,MAAM,CAAC,GAAG;IAAE,OAAO,EAAE,QAAQ,CAAA;CAAE,GAC1D,CAAC,OAAO,EAAE,mBAAmB,CAAC,QAAQ,CAAC,KAAK,kBAAkB,CAAC,MAAM,CAAC,CAAA;AACzE,wBAAgB,WAAW,CAAC,MAAM,EAChC,UAAU,EAAE,eAAe,CAAC,MAAM,CAAC,GAAG;IAAE,OAAO,CAAC,EAAE,KAAK,CAAA;CAAE,GACxD,CAAC,OAAO,EAAE,+BAA+B,KAAK,kBAAkB,CAAC,MAAM,CAAC,CAAA"}
+{"version":3,"file":"defineBlock.d.ts","sourceRoot":"","sources":["../../src/registry/defineBlock.tsx"],"names":[],"mappings":"AAkBA,OAAO,EAAE,KAAK,aAAa,EAAiB,KAAK,SAAS,EAAE,MAAM,OAAO,CAAA;AACzE,OAAO,EACL,KAAK,eAAe,EAErB,MAAM,sCAAsC,CAAA;AAE7C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAA;AAC/E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AAC3E,OAAO,EAAqB,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACpE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAYzD,gEAAgE;AAChE,MAAM,WAAW,eAAe,CAAC,MAAM;IACrC;;;;;;;;OAQG;IACH,QAAQ,EAAE,SAAS,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;IACnC,SAAS,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAChC,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC,CAAA;IACzC,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;IAC7B,6EAA6E;IAC7E,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,SAAS,CAAA;IACzD,yBAAyB,CAAC,EAAE,MAAM,CAAA;CACnC;AAED,4DAA4D;AAC5D,MAAM,WAAW,mBAAmB,CAAC,aAAa;IAChD,2EAA2E;IAC3E,KAAK,EAAE,MAAM,CAAA;IACb,oEAAoE;IACpE,YAAY,EAAE,aAAa,CAAA;IAC3B,qGAAqG;IACrG,aAAa,CAAC,EAAE,kBAAkB,EAAE,CAAA;CACrC;AAED,qEAAqE;AACrE,MAAM,WAAW,+BAA+B;IAC9C,2EAA2E;IAC3E,KAAK,EAAE,MAAM,CAAA;IACb,qGAAqG;IACrG,aAAa,CAAC,EAAE,kBAAkB,EAAE,CAAA;CACrC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,QAAQ,SAAS,eAAe,CAAC,QAAQ,CAAC,EAC5E,UAAU,EAAE,eAAe,CAAC,MAAM,CAAC,GAAG;IAAE,OAAO,EAAE,QAAQ,CAAA;CAAE,GAC1D,CAAC,OAAO,EAAE,mBAAmB,CAAC,QAAQ,CAAC,KAAK,kBAAkB,CAAC,MAAM,CAAC,CAAA;AACzE,wBAAgB,WAAW,CAAC,MAAM,EAChC,UAAU,EAAE,eAAe,CAAC,MAAM,CAAC,GAAG;IAAE,OAAO,CAAC,EAAE,KAAK,CAAA;CAAE,GACxD,CAAC,OAAO,EAAE,+BAA+B,KAAK,kBAAkB,CAAC,MAAM,CAAC,CAAA"}

package/dist/registry/index.d.ts

@@ -1,5 +1,5 @@
 export { type BlockRegistry, type BlockRegistryEntry, COLUMN_STACK_ATTR, defineRegistry, type PropsOf, } from './blockRegistry';
-export { BLOCK_CATALOGUE, BlockCategory, type BlockCatalogueEntry, type BlockName, isKnownBlock, type UnresolvedBlock, type UnresolvedBlockReason, unresolvedReason, } from './blockCatalogue';
+export { BLOCK_CATALOGUE, BlockCategory, type BlockCatalogueEntry, type BlockName, getCatalogueEntry, isKnownBlock, type UnresolvedBlock, type UnresolvedBlockReason, unresolvedReason, } from './blockCatalogue';
 export { type BlockDefinition, type BlockFactoryOptions, defineBlock, type UntranslatedBlockFactoryOptions, } from './defineBlock';
 export { getMergedProps } from './getMergedProps';
 export { resolveBlockEntry } from './resolveBlockEntry';

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,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,YAAY,EACV,iBAAiB,EACjB,UAAU,EACV,YAAY,EACZ,eAAe,EACf,iBAAiB,GAClB,MAAM,iBAAiB,CAAA"}

package/package.json

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