@instructure/platform-rce-adapter 0.3.0

package/dist/RceEditor.d.ts

@@ -0,0 +1,13 @@
+import { default as RCEWrapper } from '@instructure/canvas-rce/es/rce/RCEWrapper.js';
+import { ForwardRefExoticComponent, RefAttributes } from 'react';
+import { RceEditorProps } from './types';
+/**
+ * Host-agnostic wrapper around `@instructure/canvas-rce`'s `RCE`. All Canvas
+ * config that used to be read from `window.ENV` / `window.INST` / the DOM is
+ * supplied by the host through the `config` prop (see `RceConfig`). This is the
+ * de-canvased port of `canvas-lms/ui/shared/rce/react/CanvasRce.tsx`.
+ *
+ * The ref forwards to the underlying `RCEWrapper` (available after `onInit`).
+ */
+export declare const RceEditor: ForwardRefExoticComponent<RceEditorProps & RefAttributes<RCEWrapper>>;
+//# sourceMappingURL=RceEditor.d.ts.map

package/dist/RceEditor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RceEditor.d.ts","sourceRoot":"","sources":["../src/RceEditor.tsx"],"names":[],"mappings":"AAmBA,OAAO,KAAK,UAAU,MAAM,8CAA8C,CAAA;AAC1E,OAAO,EAEL,KAAK,yBAAyB,EAG9B,KAAK,aAAa,EAInB,MAAM,OAAO,CAAA;AACd,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAI7C;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,EAAE,yBAAyB,CAAC,cAAc,GAAG,aAAa,CAAC,UAAU,CAAC,CAqHxF,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { RceEditor } from './RceEditor';
+export type { RceConfig, RceContainingContext, RceEditorProps, } from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,YAAY,EACV,SAAS,EACT,oBAAoB,EACpB,cAAc,GACf,MAAM,SAAS,CAAA"}

package/dist/index.js

@@ -0,0 +1,83 @@
+import { jsx as y } from "react/jsx-runtime";
+import b from "@instructure/canvas-rce/es/rce/RCE.js";
+import { forwardRef as w, useRef as U, useState as O, useCallback as M } from "react";
+const _ = 36e5, j = w(function(r, s) {
+  const {
+    config: e,
+    autosave: l,
+    defaultContent: c,
+    editorOptions: u,
+    height: d,
+    maxInitRenderedRCEs: f,
+    mirroredAttrs: g,
+    onBlur: C,
+    onContentChange: m,
+    onFocus: x,
+    onInit: T,
+    readOnly: h,
+    textareaClassName: v,
+    textareaId: R,
+    variant: A
+  } = r, n = s, a = U(null), [I] = O(() => ({
+    enabled: l ?? !0,
+    maxAge: e.autosaveMaxAge ?? _
+  })), p = M(
+    (t) => {
+      var o, i;
+      n && (n.current = t), t ? t.getTextarea().remoteEditor = t : (i = (o = a.current) == null ? void 0 : o.destroy) == null || i.call(o), a.current = t;
+    },
+    [n]
+  ), S = {
+    canUploadFiles: e.canUploadFiles,
+    containingContext: e.containingContext,
+    contextId: e.contextId ?? e.containingContext.contextId,
+    contextType: e.contextType ?? e.containingContext.contextType,
+    filesTabDisabled: e.filesTabDisabled,
+    host: e.host,
+    jwt: e.jwt,
+    refreshToken: e.refreshToken,
+    themeUrl: e.themeUrl
+  }, E = e.ltiIframeAllowances !== void 0 || e.maxMruTools !== void 0 || e.resourceSelectionUrl != null || e.containingCanvasLtiToolId !== void 0 || e.isA2StudentView !== void 0 ? {
+    ltiIframeAllowances: e.ltiIframeAllowances ?? [],
+    containingCanvasLtiToolId: e.containingCanvasLtiToolId ?? "",
+    resourceSelectionUrlOverride: e.resourceSelectionUrl ?? "",
+    isA2StudentView: e.isA2StudentView ?? !1,
+    maxMruTools: e.maxMruTools ?? 0
+  } : void 0;
+  return /* @__PURE__ */ y(
+    b,
+    {
+      ref: p,
+      autosave: I,
+      canvasOrigin: e.canvasOrigin,
+      defaultContent: c,
+      editorOptions: u ?? {},
+      externalToolsConfig: E,
+      features: e.features ?? {},
+      fontFamily: e.fontFamily,
+      height: d,
+      highContrastCSS: e.highContrastCSS ?? [],
+      instRecordDisabled: e.instRecordDisabled,
+      language: e.language ?? "en",
+      liveRegion: e.liveRegion,
+      ltiTools: e.ltiTools ?? [],
+      maxInitRenderedRCEs: f ?? -1,
+      mirroredAttrs: g ?? {},
+      onBlur: C,
+      onContentChange: m,
+      onFocus: x,
+      onInit: T,
+      rcsProps: S,
+      readOnly: h ?? !1,
+      textareaClassName: v ?? "input-block-level",
+      textareaId: R,
+      variant: A,
+      use_rce_icon_maker: e.useRceIconMaker,
+      useHighContrast: e.useHighContrast ?? !1,
+      userCacheKey: e.userCacheKey
+    }
+  );
+});
+export {
+  j as RceEditor
+};

package/dist/types.d.ts

@@ -0,0 +1,82 @@
+import { EditorOptions } from '@instructure/canvas-rce/es/rce/RCEWrapperProps.js';
+import { RCEVariant } from '@instructure/canvas-rce/es/rce/RCEVariants.js';
+export type { RCEVariant };
+/** The course/user context the RCS is scoped to. */
+export interface RceContainingContext {
+    contextType: string;
+    contextId: string;
+    userId: string;
+}
+/**
+ * Host-supplied RCE configuration. Every field here is something canvas
+ * historically read from `window.ENV` / `window.INST` / the DOM; the host
+ * now computes them and passes them in, keeping this package host-agnostic.
+ */
+export interface RceConfig {
+    host: string;
+    jwt: string;
+    refreshToken: (done?: (token: string) => void) => void;
+    containingContext: RceContainingContext;
+    /**
+     * RCS context type/id. Defaults to `containingContext`'s, but the host can
+     * override — canvas deliberately swaps these to the user context for account
+     * contexts / when the user can't upload files (see `getRCSProps`).
+     */
+    contextType?: string;
+    contextId?: string;
+    canUploadFiles: boolean;
+    filesTabDisabled?: boolean;
+    themeUrl?: string;
+    ltiIframeAllowances?: string[];
+    maxMruTools?: number;
+    /** Override URL for the external-tool resource picker (was a DOM read). */
+    resourceSelectionUrl?: string | null;
+    containingCanvasLtiToolId?: string;
+    isA2StudentView?: boolean;
+    canvasOrigin: string;
+    language?: string;
+    userCacheKey?: string;
+    useHighContrast?: boolean;
+    highContrastCSS?: string[];
+    fontFamily?: string;
+    ltiTools?: unknown[];
+    instRecordDisabled?: boolean;
+    autosaveMaxAge?: number;
+    features?: Record<string, boolean>;
+    useRceIconMaker?: boolean;
+    /**
+     * Returns the live-region element for screen-reader announcements. Required —
+     * canvas-rce always expects one and uses it for its InstUI alerts.
+     */
+    liveRegion: () => HTMLElement | null;
+}
+export interface RceEditorProps {
+    /** Host-supplied configuration (RCS connection + editor chrome). */
+    config: RceConfig;
+    /** Initial editor content (HTML). */
+    defaultContent?: string;
+    /** Called with the editor HTML whenever content changes. */
+    onContentChange?: (content: string) => void;
+    /** id applied to the backing textarea (must be selector-safe — no colons). */
+    textareaId: string;
+    /** Height of the editor; number = px. */
+    height?: number | string;
+    /** Whether the editor is read-only. */
+    readOnly?: boolean;
+    /** Attributes mirrored onto the backing textarea (e.g. aria-required). */
+    mirroredAttrs?: Record<string, string>;
+    /** Whether to autosave to localStorage as the user types. */
+    autosave?: boolean;
+    /** tinymce configuration overrides (host-built EditorConfig output). */
+    editorOptions?: EditorOptions;
+    /** RCE variant — e.g. 'block-content-editor' for the block editor. Defaults to the classic RCE. */
+    variant?: RCEVariant;
+    /** Max RCEs rendered on load before deferring; defaults to -1 (render all). */
+    maxInitRenderedRCEs?: number;
+    /** Class applied to the backing textarea; defaults to 'input-block-level'. */
+    textareaClassName?: string;
+    onFocus?: (rce: unknown) => void;
+    onBlur?: (event: unknown) => void;
+    onInit?: (...args: unknown[]) => void;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mDAAmD,CAAA;AACtF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+CAA+C,CAAA;AAE/E,YAAY,EAAE,UAAU,EAAE,CAAA;AAE1B,oDAAoD;AACpD,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IAExB,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,YAAY,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,KAAK,IAAI,CAAA;IACtD,iBAAiB,EAAE,oBAAoB,CAAA;IACvC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,cAAc,EAAE,OAAO,CAAA;IACvB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAA;IAKjB,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,2EAA2E;IAC3E,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpC,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAClC,eAAe,CAAC,EAAE,OAAO,CAAA;IAGzB,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;;OAGG;IACH,UAAU,EAAE,MAAM,WAAW,GAAG,IAAI,CAAA;CACrC;AAED,MAAM,WAAW,cAAc;IAC7B,oEAAoE;IACpE,MAAM,EAAE,SAAS,CAAA;IACjB,qCAAqC;IACrC,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,4DAA4D;IAC5D,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;IAC3C,8EAA8E;IAC9E,UAAU,EAAE,MAAM,CAAA;IAClB,yCAAyC;IACzC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACxB,uCAAuC;IACvC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,0EAA0E;IAC1E,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACtC,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,wEAAwE;IACxE,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,mGAAmG;IACnG,OAAO,CAAC,EAAE,UAAU,CAAA;IACpB,+EAA+E;IAC/E,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,8EAA8E;IAC9E,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAA;IAChC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAA;IACjC,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;CACtC"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@instructure/platform-rce-adapter",
+  "version": "0.3.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite build --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "type-check": "tsc -p tsconfig.check.json"
+  },
+  "peerDependencies": {
+    "@instructure/canvas-rce": "^8.1.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "tinymce": "^5.9"
+  },
+  "devDependencies": {
+    "@instructure/canvas-rce": "^8.1.0",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.0.0",
+    "@testing-library/user-event": "^14.0.0",
+    "@types/react": "^18.3.0",
+    "@types/react-dom": "^18.3.0",
+    "@vitejs/plugin-react": "^4.0.0",
+    "@vitest/coverage-v8": "^4.0.0",
+    "jsdom": "^25.0.0",
+    "tinymce": "^5.9",
+    "typescript": "^5.3.0",
+    "vite": "^6.0.0",
+    "vite-plugin-dts": "^4.0.0",
+    "vitest": "^4.0.0"
+  }
+}