@khanacademy/perseus 7.2.1 → 9.0.0

package/dist/interaction-tracker.d.ts

@@ -2,10 +2,10 @@ import type { APIOptions, Tracking } from "./types";
 /**
  * Wrapper for the trackInteraction apiOption.
  */
-declare class InteractionTracker {
+declare class InteractionTracker<T> {
     _tracked: boolean;
     setting: Tracking;
-    track: (extraData?: any) => void;
+    track: (extraData?: T) => void;
     trackApi: any;
     widgetID: string;
     widgetType: string;
@@ -18,6 +18,6 @@ declare class InteractionTracker {
      * @param extraData Any extra data to track about the event.
      * @private
      */
-    _track: (extraData: Record<string, any>) => void;
+    _track: (extraData: T) => void;
 }
 export default InteractionTracker;

package/dist/item-renderer.d.ts

@@ -3,7 +3,7 @@ import HintsRenderer from "./hints-renderer";
 import Renderer from "./renderer";
 import type { KeypadProps } from "./mixins/provide-keypad";
 import type { PerseusItem } from "./perseus-types";
-import type { APIOptions, FocusPath, LinterContextProps } from "./types";
+import type { APIOptions, FocusPath, LinterContextProps, PerseusDependenciesV2 } from "./types";
 import type { KEScore } from "@khanacademy/perseus-core";
 type Props = // These props are used by the ProvideKeypad mixin.
 KeypadProps & {
@@ -23,6 +23,7 @@ KeypadProps & {
     savedState: any;
     linterContext: LinterContextProps;
     legacyPerseusLint?: ReadonlyArray<string>;
+    dependencies: PerseusDependenciesV2;
 };
 type DefaultProps = {
     apiOptions: Props["apiOptions"];

package/dist/mixins/provide-keypad.d.ts

@@ -9,7 +9,7 @@
  * `ItemRenderer` and friends are written as ES6 Classes, we can have them
  * extend a `ProvideKeypad` component instead of using this mixin.
  */
-import PropTypes from "prop-types";
+import type { APIOptions } from "../types";
 import type { CSSProperties } from "aphrodite";
 export type KeypadProps = {
     keypadStyle?: CSSProperties;
@@ -18,19 +18,22 @@ export type KeypadApiOptions = {
     customKeypad: boolean;
     nativeKeypadProxy: any;
 };
-declare const ProvideKeypad: {
-    readonly propTypes: {
-        readonly apiOptions: PropTypes.Requireable<PropTypes.InferProps<{
-            customKeypad: PropTypes.Requireable<boolean>;
-            nativeKeypadProxy: PropTypes.Requireable<(...args: any[]) => any>;
-        }>>;
-        readonly keypadStyle: PropTypes.Requireable<any>;
+type KeypadMixinHostComponent = {
+    _keypadContainer?: HTMLDivElement | null;
+    props: {
+        apiOptions: APIOptions;
+        blur?: () => void;
+    };
+    state: {
+        keypadElement: any | null;
     };
-    readonly getInitialState: () => {
+};
+declare const ProvideKeypad: {
+    readonly getInitialState: (this: KeypadMixinHostComponent) => {
         keypadElement: any | null;
     };
-    readonly componentDidMount: () => void;
-    readonly componentWillUnmount: () => void;
-    readonly keypadElement: () => any;
+    readonly componentDidMount: (this: KeypadMixinHostComponent) => void;
+    readonly componentWillUnmount: (this: KeypadMixinHostComponent) => void;
+    readonly keypadElement: (this: KeypadMixinHostComponent) => any;
 };
 export default ProvideKeypad;

package/dist/multi-items/multi-renderer.d.ts

@@ -1,7 +1,7 @@
 import * as React from "react";
 import Renderer from "../renderer";
 import type { Widget } from "../renderer";
-import type { APIOptions, FilterCriterion } from "../types";
+import type { APIOptions, FilterCriterion, PerseusDependenciesV2 } from "../types";
 import type { Item, ContentNode, HintNode, TagsNode } from "./item-types";
 import type { Shape, ArrayShape } from "./shape-types";
 import type { Tree } from "./tree-types";
@@ -47,6 +47,7 @@ type Props = {
     onInteractWithWidget?: (id: string) => void;
     apiOptions?: APIOptions;
     reviewMode?: boolean | null | undefined;
+    dependencies: PerseusDependenciesV2;
 };
 type State = {
     rendererDataTree: RendererDataTree | null | undefined;

package/dist/perseus-api.d.ts

@@ -83,10 +83,10 @@ export declare const ApiOptions: {
             type: string;
             id: string;
             correct?: boolean | undefined;
-        } & Record<string, unknown>) => void) | undefined;
+        } & Partial<import("./types").TrackingGradedGroupExtraArguments> & Partial<import("./types").TrackingSequenceExtraArguments>) => void) | undefined;
         customKeypad?: boolean | undefined;
         useV2Keypad?: boolean | undefined;
-        nativeKeypadProxy?: (() => unknown) | undefined;
+        nativeKeypadProxy?: ((blur: () => void) => import("@khanacademy/math-input").KeypadAPI) | undefined;
         isMobile?: boolean | undefined;
         setDrawingAreaAvailable?: ((arg1: boolean) => unknown) | undefined;
         useDraftEditor?: boolean | undefined;

package/dist/renderer.d.ts

@@ -93,7 +93,7 @@ declare class Renderer extends React.Component<Props, State> {
     _currentFocus: FocusPath | null | undefined;
     _foundTextNodes: boolean;
     _interactionTrackers: {
-        [id: string]: InteractionTracker;
+        [id: string]: InteractionTracker<any>;
     };
     _isMounted: boolean;
     _isTwoColumn: boolean;

package/dist/server-item-renderer.d.ts

@@ -9,7 +9,7 @@
 import * as React from "react";
 import Renderer from "./renderer";
 import type { KeypadProps } from "./mixins/provide-keypad";
-import type { APIOptions, FocusPath } from "./types";
+import type { APIOptions, FocusPath, PerseusDependenciesV2 } from "./types";
 import type { RendererInterface, KEScore } from "@khanacademy/perseus-core";
 type OwnProps = // These props are used by the ProvideKeypad mixin.
 KeypadProps & {
@@ -22,6 +22,7 @@ KeypadProps & {
     problemNum?: number;
     reviewMode?: boolean;
     keypadElement?: any | null | undefined;
+    dependencies: PerseusDependenciesV2;
 };
 type HOCProps = {
     onRendered: (isRendered: boolean) => void;
@@ -110,5 +111,6 @@ declare const ref: React.ForwardRefExoticComponent<Omit<KeypadProps & {
     problemNum?: number | undefined;
     reviewMode?: boolean | undefined;
     keypadElement?: any | null | undefined;
+    dependencies: PerseusDependenciesV2;
 } & HOCProps, "onRendered"> & React.RefAttributes<ServerItemRenderer>>;
 export default ref;

package/dist/types.d.ts

@@ -1,12 +1,14 @@
-import * as React from "react";
 import type { SerializedHighlightSet } from "./components/highlighting/types";
 import type { ILogger } from "./logging/log";
 import type { Item } from "./multi-items/item-types";
 import type { PerseusWidget } from "./perseus-types";
 import type { SizeClass } from "./util/sizing-utils";
-import type { SendEventFn } from "@khanacademy/perseus-core";
+import type { KeypadAPI } from "@khanacademy/math-input";
+import type { AnalyticsEventHandlerFn } from "@khanacademy/perseus-core";
 import type { Result } from "@khanacademy/wonder-blocks-data";
+import type * as React from "react";
 export type FocusPath = ReadonlyArray<string> | null | undefined;
+type Empty = Record<never, never>;
 export type Dimensions = {
     width?: number;
     height?: number;
@@ -74,6 +76,11 @@ export type ImageUploader = (file: string, callback: (url: string) => unknown) =
 export type WidgetSize = "normal" | "small" | "mini";
 export type Path = ReadonlyArray<string>;
 type StubTagEditorType = any;
+type TrackInteractionArgs = {
+    type: string;
+    id: string;
+    correct?: boolean;
+} & Partial<TrackingGradedGroupExtraArguments> & Partial<TrackingSequenceExtraArguments>;
 export type APIOptions = Readonly<{
     isArticle?: boolean;
     onInputError?: (widgetId: any, value: string, message?: string | null | undefined) => unknown;
@@ -91,14 +98,10 @@ export type APIOptions = Readonly<{
         Link: React.ComponentType<any>;
     };
     imagePreloader?: (dimensions: Dimensions) => React.ReactNode;
-    trackInteraction?: (args: {
-        type: string;
-        id: string;
-        correct?: boolean;
-    } & Record<string, unknown>) => void;
+    trackInteraction?: (args: TrackInteractionArgs) => void;
     customKeypad?: boolean;
     useV2Keypad?: boolean;
-    nativeKeypadProxy?: () => unknown;
+    nativeKeypadProxy?: (blur: () => void) => KeypadAPI;
     isMobile?: boolean;
     setDrawingAreaAvailable?: (arg1: boolean) => unknown;
     useDraftEditor?: boolean;
@@ -160,7 +163,6 @@ export type PerseusDependencies = {
     TeX: React.ComponentType<TeXProps>;
     staticUrl: StaticUrlFn;
     InitialRequestUrl: InitialRequestUrlInterface;
-    analytics: SendEventFn;
     useVideo(id: string, kind: VideoKind): Result<{
         video: VideoData | null | undefined;
     }>;
@@ -169,6 +171,19 @@ export type PerseusDependencies = {
     kaLocale: string;
     isMobile: boolean;
 };
+/**
+ * The modern iteration of Perseus Depedndencies. These dependencies are
+ * provided to Perseus through its entrypoints (for example:
+ * ServerItemRenderer) and then attached to the DependenciesContext so they are
+ * available anywhere down the React render tree.
+ *
+ * Prefer using this type over `PerseusDependencies` when possible.
+ */
+export type PerseusDependenciesV2 = {
+    analytics: {
+        onAnalyticsEvent: AnalyticsEventHandlerFn;
+    };
+};
 export type APIOptionsWithDefaults = Readonly<APIOptions & {
     GroupMetadataEditor: NonNullable<APIOptions["GroupMetadataEditor"]>;
     baseElements: NonNullable<APIOptions["baseElements"]>;
@@ -194,6 +209,12 @@ export type LinterContextProps = {
     stack: ReadonlyArray<string>;
 };
 export type Tracking = "" | "all";
+export type TrackingGradedGroupExtraArguments = {
+    status: "correct" | "incorrect" | "invalid";
+};
+export type TrackingSequenceExtraArguments = {
+    visible: number;
+};
 export type Alignment = "default" | "block" | "inline-block" | "inline" | "float-left" | "float-right" | "full-width";
 type WidgetOptions = any;
 export type WidgetTransform = (arg1: WidgetOptions, problemNumber?: number) => any;
@@ -219,7 +240,7 @@ export type WidgetExports<T extends React.ComponentType<any> = React.ComponentTy
 }>;
 export type WidgetInfo = PerseusWidget;
 export type FilterCriterion = string | ((id: string, widgetInfo: WidgetInfo, widget?: Widget | null | undefined) => boolean);
-export type WidgetProps<RenderProps, Rubric> = RenderProps & {
+export type WidgetProps<RenderProps, Rubric, TrackingExtraArgs = Empty> = RenderProps & {
     widgetId: string;
     alignment: string | null | undefined;
     static: boolean | null | undefined;
@@ -232,7 +253,7 @@ export type WidgetProps<RenderProps, Rubric> = RenderProps & {
     findWidgets: (arg1: FilterCriterion) => ReadonlyArray<Widget>;
     reviewModeRubric: Rubric;
     onChange: ChangeHandler;
-    trackInteraction: (extraData?: any) => void;
+    trackInteraction: (extraData?: TrackingExtraArgs) => void;
     isLastUsedWidget: boolean;
     linterContext: LinterContextProps;
     containerSizeClass: SizeClass;