@instructure/platform-block-content-editor 0.3.1 → 1.1.0

package/locales/en.json

@@ -17,5 +17,173 @@
   "videoBlockTitle": "Video",
   "accordionPlaceholder": "Add accordion...",
   "accordionItemPlaceholderTitle": "Accordion %{index}",
-  "accordionItemPlaceholderContent": "Your content here..."
+  "accordionItemPlaceholderContent": "Your content here...",
+  "tabsBlockItemPlaceholderTitle": "Tab %{index}",
+  "tabsBlockItemPlaceholderContent": "Your content here...",
+  "flashCardsTitle": "Flashcards",
+  "flashCardsPlaceholder": "Add flashcards...",
+  "flashCardsFrontLabel": "Front",
+  "flashCardsBackLabel": "Back",
+  "flashCardsFlipHint": "Click to flip",
+  "flashCardsCounter": "%{current} of %{total}",
+  "flashCardsCardAnnouncement": "Card %{current} of %{total}: %{question}",
+  "flashCardsPreviousCard": "Previous card",
+  "flashCardsNextCard": "Next card",
+  "flashCardsFrontAriaLabel": "Front: %{question}. Click to see answer.",
+  "flashCardsBackAriaLabel": "Back: %{answer}. Click to see question.",
+  "mixAndMatchTitle": "Mix and match",
+  "mixAndMatchPlaceholder": "Add mix and match...",
+  "mixAndMatchInstructions": "Click a card from the left and then right to pair.",
+  "mixAndMatchCompleteTitle": "Nice work!",
+  "mixAndMatchCompleteSubtitle": "You matched all the cards.",
+  "mixAndMatchPracticeAgain": "Practice again",
+  "mixAndMatchReset": "Reset",
+  "mixAndMatchCorrect": "Correct match!",
+  "mixAndMatchIncorrect": "Incorrect match, try again.",
+  "mixAndMatchCloseFeedback": "Close match feedback message",
+  "mixAndMatchTermAriaLabel": "Term: %{text}",
+  "mixAndMatchDefinitionAriaLabel": "Definition: %{text}",
+  "mixAndMatchProgress": "%{matched} of %{total} matched",
+  "mixAndMatchProgressShort": "%{matched}/%{total}",
+  "knowledgeCheckTitle": "Knowledge check",
+  "knowledgeCheckPlaceholder": "Add knowledge check...",
+  "knowledgeCheckQuestionPlaceholder": "Your question here",
+  "knowledgeCheckAnswerPlaceholder": "Answer %{index}",
+  "knowledgeCheckSelectOne": "Select one answer.",
+  "knowledgeCheckSelectAll": "Select all that apply.",
+  "knowledgeCheckCheckAnswer": "Check answer",
+  "knowledgeCheckTryAgain": "Try again",
+  "knowledgeCheckPracticeAgain": "Practice again",
+  "knowledgeCheckCorrect": "Nice work! You got the correct answer!",
+  "knowledgeCheckIncorrect": "Oops, that's incorrect.",
+  "knowledgeCheckAnswerCorrectLabel": "Correct",
+  "knowledgeCheckAnswerIncorrectLabel": "Incorrect",
+  "widgetBlockPlaceholder": "Add widget...",
+  "widgetBlockLoading": "Loading widget...",
+  "widgetBlockError": "Failed to load widget",
+  "item": "item",
+  "pickedUp": "Picked up %{label}. Use arrow keys to move, Space to drop, Escape to cancel.",
+  "notOverDropArea": "%{label} is not over a drop area.",
+  "leftColumn": "left column",
+  "rightColumn": "right column",
+  "isOverColumn": "%{label} is over %{columnName}.",
+  "isOver": "%{label} is over %{overLabel}.",
+  "wasDropped": "%{label} was dropped.",
+  "wasDroppedIntoColumn": "%{label} was dropped into %{columnName}.",
+  "dragCancelled": "Dragging was cancelled. %{label} was returned to its original position.",
+  "dragInstructions": "To pick up this component, press Space or Enter. Use arrow keys to move it up, down, or between columns. Press Space or Enter to drop, or Escape to cancel.",
+  "componentActions": "Component actions",
+  "dragToReorder": "Drag to reorder",
+  "dragAndDrop": "Drag and Drop",
+  "duplicateComponent": "Duplicate %{component}",
+  "duplicate": "Duplicate",
+  "deleteComponent": "Delete %{component}",
+  "delete": "Delete",
+  "deleteConfirmation": "Are you sure you want to delete this?",
+  "cancel": "Cancel",
+  "editComponent": "Edit %{component} component",
+  "componentGroup": "%{component} component",
+  "leftColumnLabel": "Left column",
+  "rightColumnLabel": "Right column",
+  "dropBlocksHere": "Drop blocks here",
+  "templatesComingSoon": "Coming soon: ready-made templates from your organization.",
+  "previous": "Previous",
+  "next": "Next",
+  "itemSubtitle": "%{itemName} %{number}",
+  "defaultItemName": "Item",
+  "dragToReorderItem": "Drag to reorder %{item}",
+  "editItem": "Edit %{item}",
+  "removeItem": "Remove %{item}",
+  "manageLabel": "Manage %{pluralLabel}",
+  "countLabel": "%{count} %{pluralLabel}",
+  "noItemsYet": "No items yet",
+  "addItem": "Add %{componentType}",
+  "answerTrue": "True",
+  "answerFalse": "False",
+  "optionLabel": "Option %{option}",
+  "removeOption": "Remove option %{option}",
+  "addOption": "Add option",
+  "arrayItemLabel": "Item %{index}",
+  "remove": "Remove",
+  "addPrimitiveItem": "Add item",
+  "dragAndDropOrBrowse": "Drag and drop or click to browse",
+  "chooseFile": "Choose file",
+  "loadingPreview": "Loading preview...",
+  "uploadFailed": "Upload failed",
+  "uploadImage": "Upload image",
+  "imageAcceptedTypes": "Accepted file types: PNG, JPG, GIF, WebP",
+  "imageMaxSize": "Max file size: 5MB",
+  "replaceImage": "Replace image",
+  "uploadingImage": "Uploading image...",
+  "imageSizeError": "File size must be less than 5MB",
+  "uploadVideo": "Upload video",
+  "videoAcceptedTypes": "Accepted file types: MP4, WebM, MOV, AVI",
+  "videoMaxSize": "Max file size: 500MB",
+  "replaceVideo": "Replace video",
+  "uploadingVideo": "Uploading video...",
+  "videoSizeError": "File size must be less than 500MB",
+  "videoSource": "Video source",
+  "sourceFile": "File",
+  "sourceLink": "Link",
+  "videoLink": "Video link",
+  "videoLinkPlaceholder": "https://...",
+  "loading": "Loading...",
+  "collapse": "Collapse",
+  "expand": "Expand",
+  "minimize": "Minimize",
+  "expandPanel": "Expand panel",
+  "minimizePanel": "Minimize panel",
+  "back": "Back",
+  "closePanel": "Close %{panelName}",
+  "resizeToolPanel": "Resize tool panel",
+  "basicBlocksTool": "Basic blocks",
+  "interactiveBlocksTool": "Interactive blocks",
+  "layoutBlocksTool": "Layout blocks",
+  "templatesTool": "Templates",
+  "basicBlocksIntro": "Format content with these basic blocks.",
+  "layoutBlocksIntro": "Organize your content into columns.",
+  "interactiveBlocksIntro": "Engage learners with interactive non-scored activities.",
+  "addBlock": "Add %{name}",
+  "skipToSelectedComponent": "Skip to selected component",
+  "desktop": "Desktop",
+  "mobile": "Mobile",
+  "viewportLabel": "Preview viewport",
+  "aiAssistFor": "AI assist for %{componentType}",
+  "aiActions": "AI Actions",
+  "backToMenu": "Back to menu",
+  "regenerateWithPrompt": "Regenerate with prompt",
+  "changeTone": "Change tone",
+  "changeLength": "Change length",
+  "changeReadingLevel": "Change reading level",
+  "toneMoreFormal": "More formal",
+  "toneMoreFun": "More fun",
+  "toneMoreCasual": "More casual",
+  "toneMoreTechnical": "More technical",
+  "lengthShorter": "Shorter",
+  "lengthLonger": "Longer",
+  "readingBeginning": "Beginning reader (0L - 760L)",
+  "readingNovice": "Novice reader (635L - 1160L)",
+  "readingIntermediate": "Intermediate reader (925L - 1295L)",
+  "readingAdvanced": "Advanced reader (1040L - 1440L)",
+  "promptPlaceholder": "What would you like to change?",
+  "previewFirst": "Preview first",
+  "send": "Send",
+  "thinking": "Thinking…",
+  "stop": "Stop",
+  "generationFailed": "Failed to generate. Please try again.",
+  "previewBlock": "Preview block",
+  "compareLabel": "Compare versions",
+  "both": "Both",
+  "before": "Before",
+  "after": "After",
+  "previewCancel": "Cancel",
+  "acceptAndReplace": "Accept and replace",
+  "refinementPlaceholder": "What changes would you like to make?",
+  "regenerate": "Regenerate",
+  "regenerating": "Regenerating...",
+  "generateAltText": "Generate alt text",
+  "generating": "Generating...",
+  "failedToLoadImage": "Failed to load image",
+  "failedToGenerate": "Failed to generate alt text",
+  "noDescription": "No description was returned"
 }

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@instructure/platform-block-content-editor",
-  "version": "0.3.1",
+  "version": "1.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",
   "module": "./dist/index.js",
@@ -19,42 +20,77 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "build": "vite build",
-    "dev": "vite build --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:coverage": "vitest run --coverage",
-    "lint": "oxlint -c ../../oxlint.json && ast-grep scan . --report-style=short",
-    "lint:fix": "oxlint -c ../../oxlint.json --fix && biome format --write .",
-    "type-check": "tsc -p tsconfig.check.json",
-    "pack:tarball": "pnpm build && pnpm pack"
-  },
   "peerDependencies": {
+    "@instructure/emotion": "^11.0.0",
+    "@instructure/ui-a11y-content": "^11.0.0",
+    "@instructure/ui-alerts": "^11.0.0",
+    "@instructure/ui-buttons": "^11.0.0",
+    "@instructure/ui-checkbox": "^11.0.0",
+    "@instructure/ui-file-drop": "^11.0.0",
     "@instructure/ui-flex": "^11.0.0",
+    "@instructure/ui-form-field": "^11.0.0",
     "@instructure/ui-heading": "^11.0.0",
     "@instructure/ui-icons": "^11.0.0",
     "@instructure/ui-img": "^11.0.0",
+    "@instructure/ui-modal": "^11.0.0",
+    "@instructure/ui-number-input": "^11.0.0",
+    "@instructure/ui-popover": "^11.0.0",
+    "@instructure/ui-progress": "^11.0.0",
+    "@instructure/ui-radio-input": "^11.0.0",
+    "@instructure/ui-range-input": "^11.0.0",
+    "@instructure/ui-simple-select": "^11.0.0",
+    "@instructure/ui-source-code-editor": "^11.0.0",
     "@instructure/ui-spinner": "^11.0.0",
     "@instructure/ui-text": "^11.0.0",
+    "@instructure/ui-text-area": "^11.0.0",
+    "@instructure/ui-text-input": "^11.0.0",
     "@instructure/ui-toggle-details": "^11.0.0",
+    "@instructure/ui-tooltip": "^11.0.0",
     "@instructure/ui-view": "^11.0.0",
-    "react": "^18.0.0",
-    "react-dom": "^18.0.0",
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0",
     "zod": "^3.23.8"
   },
   "dependencies": {
-    "@instructure/platform-sanitize": "workspace:*"
+    "@dnd-kit/core": "^6.3.1",
+    "@dnd-kit/modifiers": "^9.0.0",
+    "@dnd-kit/sortable": "^10.0.0",
+    "@dnd-kit/utilities": "^3.2.2",
+    "@hookform/resolvers": "^5.2.2",
+    "lodash": "^4.17.21",
+    "react-hook-form": "^7.68.0",
+    "uuid": "^11.1.1",
+    "@instructure/platform-sanitize": "^0.7.0"
   },
   "devDependencies": {
-    "@instructure/ui-flex": "11.6.0",
-    "@instructure/ui-heading": "11.6.0",
-    "@instructure/ui-icons": "11.6.0",
-    "@instructure/ui-img": "11.6.0",
-    "@instructure/ui-spinner": "11.6.0",
-    "@instructure/ui-text": "11.6.0",
-    "@instructure/ui-toggle-details": "11.6.0",
-    "@instructure/ui-view": "11.6.0",
+    "@instructure/emotion": "11.7.4",
+    "@types/lodash": "^4.17.24",
+    "@instructure/ui-a11y-content": "11.7.4",
+    "@instructure/ui-alerts": "11.7.4",
+    "@instructure/ui-buttons": "11.7.4",
+    "@instructure/ui-checkbox": "11.7.4",
+    "@instructure/ui-file-drop": "11.7.4",
+    "@instructure/ui-flex": "11.7.4",
+    "@instructure/ui-form-field": "11.7.4",
+    "@instructure/ui-heading": "11.7.4",
+    "@instructure/ui-icons": "11.7.4",
+    "@instructure/ui-img": "11.7.4",
+    "@instructure/ui-modal": "11.7.4",
+    "@instructure/ui-number-input": "11.7.4",
+    "@instructure/ui-popover": "11.7.4",
+    "@instructure/ui-progress": "11.7.4",
+    "@instructure/ui-radio-input": "11.7.4",
+    "@instructure/ui-range-input": "11.7.4",
+    "@instructure/ui-simple-select": "11.7.4",
+    "@instructure/ui-source-code-editor": "11.7.4",
+    "@instructure/ui-spinner": "11.7.4",
+    "@instructure/ui-text": "11.7.4",
+    "@instructure/ui-text-area": "11.7.4",
+    "@instructure/ui-text-input": "11.7.4",
+    "@instructure/ui-themes": "11.7.4",
+    "@instructure/ui-toggle-details": "11.7.4",
+    "@instructure/ui-tooltip": "11.7.4",
+    "@instructure/ui-view": "11.7.4",
     "@storybook/react": "^10.0.8",
     "@testing-library/jest-dom": "^6.9.1",
     "@testing-library/react": "^16.3.0",
@@ -69,5 +105,17 @@
     "vite-plugin-dts": "^4.0.0",
     "vitest": "^4.0.0",
     "zod": "^3.23.8"
+  },
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite build --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "oxlint -c ../../oxlint.json && ast-grep scan . --report-style=short",
+    "lint:fix": "oxlint -c ../../oxlint.json --fix && biome format --write .",
+    "type-check": "tsc -p tsconfig.check.json",
+    "check:consumer": "pnpm build && tsc -p consumer/tsconfig.json",
+    "pack:tarball": "pnpm build && pnpm pack"
   }
-}
+}

package/dist/contexts/TranslationsContext.d.ts

@@ -1,70 +0,0 @@
-import { ReactNode } from 'react';
-/**
- * Translate function for dynamic interpolation. The consuming app provides this
- * to handle i18n with variable substitution.
- *
- * `key` is a key of `BlockContentEditorTranslations`, not an English source string —
- * the host resolves it against its own translations map, then substitutes `%{name}`
- * placeholders in the resulting value.
- *
- * Example: with `accordionItemPlaceholderTitle: 'Accordion %{index}'`,
- * translate('accordionItemPlaceholderTitle', { index: 2 }) => 'Accordion 2'
- */
-export type TranslateFunction = (key: string, options?: Record<string, unknown>) => string;
-/**
- * Translation keys used by the block content editor. The consuming app is
- * responsible for providing translated strings (see `locales/en.json`).
- */
-export interface BlockContentEditorTranslations {
-    /** Placeholder shown in the designer when a Text block has no content. */
-    placeholderContent: string;
-    /** Placeholder heading shown in the designer when a Banner block is empty. */
-    bannerPlaceholderTitle: string;
-    /** Placeholder eyebrow shown in the designer when a Banner block is empty. */
-    bannerPlaceholderSubtitle: string;
-    /** Placeholder quote shown in the designer when a Quote block has no content. */
-    quotePlaceholderContent: string;
-    /** Placeholder author shown in the designer when a Quote block has no content. */
-    quotePlaceholderAuthor: string;
-    /** Placeholder code shown in the designer when a CodeBlock has no content. */
-    codeBlockPlaceholder: string;
-    /** Placeholder shown in the designer when an ImageBlock has no image. */
-    imageBlockPlaceholder: string;
-    /** Announced while an ImageBlock's image is loading. */
-    imageBlockLoading: string;
-    /** Shown when an ImageBlock's image fails to load. */
-    imageBlockError: string;
-    /** Placeholder shown when a VideoBlock has no video (designer / empty link). */
-    videoBlockPlaceholder: string;
-    /** Announced while a VideoBlock's file is loading. */
-    videoBlockLoading: string;
-    /** Shown when a VideoBlock's video fails to load. */
-    videoBlockError: string;
-    /** Shown when a VideoBlock's link is not a supported provider. */
-    videoBlockUnsupportedProvider: string;
-    /** Heading shown while a VideoBlock's media is still processing. */
-    videoBlockProcessing: string;
-    /** Sub-message shown while a VideoBlock's media is still processing. */
-    videoBlockProcessingSubtitle: string;
-    /** Fallback iframe title when a VideoBlock has no alt text. */
-    videoBlockTitle: string;
-    /** Placeholder shown in the designer when an Accordion has no sections at all. */
-    accordionPlaceholder: string;
-    /** Placeholder title for an empty Accordion section; interpolates `%{index}` via `translate`. */
-    accordionItemPlaceholderTitle: string;
-    /** Placeholder body shown in the designer when an Accordion section has no content. */
-    accordionItemPlaceholderContent: string;
-    [key: string]: string;
-}
-export interface BlockContentEditorTranslationsContext {
-    translations: BlockContentEditorTranslations;
-    translate: TranslateFunction;
-}
-export interface TranslationsProviderProps {
-    translations: BlockContentEditorTranslations;
-    translate: TranslateFunction;
-    children: ReactNode;
-}
-export declare function TranslationsProvider({ translations, translate, children, }: TranslationsProviderProps): import("react/jsx-runtime").JSX.Element;
-export declare function useTranslations(): BlockContentEditorTranslationsContext;
-//# sourceMappingURL=TranslationsContext.d.ts.map

package/dist/contexts/TranslationsContext.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"TranslationsContext.d.ts","sourceRoot":"","sources":["../../src/contexts/TranslationsContext.tsx"],"names":[],"mappings":"AAkBA,OAAO,EAAiB,KAAK,SAAS,EAAc,MAAM,OAAO,CAAA;AAEjE;;;;;;;;;;GAUG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,MAAM,CAAA;AAE1F;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,0EAA0E;IAC1E,kBAAkB,EAAE,MAAM,CAAA;IAC1B,8EAA8E;IAC9E,sBAAsB,EAAE,MAAM,CAAA;IAC9B,8EAA8E;IAC9E,yBAAyB,EAAE,MAAM,CAAA;IACjC,iFAAiF;IACjF,uBAAuB,EAAE,MAAM,CAAA;IAC/B,kFAAkF;IAClF,sBAAsB,EAAE,MAAM,CAAA;IAC9B,8EAA8E;IAC9E,oBAAoB,EAAE,MAAM,CAAA;IAC5B,yEAAyE;IACzE,qBAAqB,EAAE,MAAM,CAAA;IAC7B,wDAAwD;IACxD,iBAAiB,EAAE,MAAM,CAAA;IACzB,sDAAsD;IACtD,eAAe,EAAE,MAAM,CAAA;IACvB,gFAAgF;IAChF,qBAAqB,EAAE,MAAM,CAAA;IAC7B,sDAAsD;IACtD,iBAAiB,EAAE,MAAM,CAAA;IACzB,qDAAqD;IACrD,eAAe,EAAE,MAAM,CAAA;IACvB,kEAAkE;IAClE,6BAA6B,EAAE,MAAM,CAAA;IACrC,oEAAoE;IACpE,oBAAoB,EAAE,MAAM,CAAA;IAC5B,wEAAwE;IACxE,4BAA4B,EAAE,MAAM,CAAA;IACpC,+DAA+D;IAC/D,eAAe,EAAE,MAAM,CAAA;IACvB,kFAAkF;IAClF,oBAAoB,EAAE,MAAM,CAAA;IAC5B,iGAAiG;IACjG,6BAA6B,EAAE,MAAM,CAAA;IACrC,uFAAuF;IACvF,+BAA+B,EAAE,MAAM,CAAA;IAEvC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,qCAAqC;IACpD,YAAY,EAAE,8BAA8B,CAAA;IAC5C,SAAS,EAAE,iBAAiB,CAAA;CAC7B;AAMD,MAAM,WAAW,yBAAyB;IACxC,YAAY,EAAE,8BAA8B,CAAA;IAC5C,SAAS,EAAE,iBAAiB,CAAA;IAC5B,QAAQ,EAAE,SAAS,CAAA;CACpB;AAED,wBAAgB,oBAAoB,CAAC,EACnC,YAAY,EACZ,SAAS,EACT,QAAQ,GACT,EAAE,yBAAyB,2CAG3B;AAED,wBAAgB,eAAe,IAAI,qCAAqC,CAMvE"}