@khanacademy/perseus 8.0.0 → 10.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,8 +3,9 @@ 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, PerseusDependenciesV2 } from "./types";
 import type { KEScore } from "@khanacademy/perseus-core";
+import type { LinterContextProps } from "@khanacademy/perseus-linter";
 type Props = // These props are used by the ProvideKeypad mixin.
 KeypadProps & {
     apiOptions: APIOptions;
@@ -23,6 +24,7 @@ KeypadProps & {
     savedState: any;
     linterContext: LinterContextProps;
     legacyPerseusLint?: ReadonlyArray<string>;
+    dependencies: PerseusDependenciesV2;
 };
 type DefaultProps = {
     apiOptions: Props["apiOptions"];

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

@@ -1,15 +1,16 @@
 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";
 import type { TreeMapper, ContentMapper, HintMapper, Path } from "./trees";
+import type { PropsFor } from "@khanacademy/wonder-blocks-core";
 type Hint = any;
 type Score = any;
 type SerializedState = any;
-type RendererProps = JSX.LibraryManagedAttributes<typeof Renderer, React.ComponentProps<typeof Renderer>>;
+type RendererProps = PropsFor<typeof Renderer>;
 type ContentRendererElement = React.ReactElement<any>;
 type HintRendererElement = React.ReactElement<any>;
 type ContentRendererData = {
@@ -47,6 +48,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,7 +83,7 @@ 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?: ((blur: () => void) => import("@khanacademy/math-input").KeypadAPI) | undefined;

package/dist/renderer.d.ts

@@ -2,7 +2,8 @@ import * as React from "react";
 import InteractionTracker from "./interaction-tracker";
 import TranslationLinter from "./translation-linter";
 import type { PerseusRenderer, PerseusWidgetOptions } from "./perseus-types";
-import type { APIOptions, APIOptionsWithDefaults, FilterCriterion, FocusPath, LinterContextProps, PerseusScore, WidgetInfo, WidgetProps } from "./types";
+import type { APIOptions, APIOptionsWithDefaults, FilterCriterion, FocusPath, PerseusScore, WidgetInfo, WidgetProps } from "./types";
+import type { LinterContextProps } from "@khanacademy/perseus-linter";
 import "./styles/perseus-renderer.less";
 type WidgetState = {
     isMobile?: boolean;
@@ -68,12 +69,6 @@ type State = {
     jiptContent: any;
     lastUsedWidgetId: string | null | undefined;
 };
-type Context = LinterContextProps & {
-    content: string;
-    widgets: {
-        [id: string]: any;
-    };
-};
 type DefaultProps = {
     alwaysUpdate: Props["alwaysUpdate"];
     content: Props["content"];
@@ -93,7 +88,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;
@@ -103,7 +98,7 @@ declare class Renderer extends React.Component<Props, State> {
     translationIndex: number;
     widgetIds: Array<string>;
     static defaultProps: DefaultProps;
-    constructor(props: Props, context: Context);
+    constructor(props: Props);
     componentDidMount(): void;
     UNSAFE_componentWillReceiveProps(nextProps: Props): void;
     shouldComponentUpdate(nextProps: Props, nextState: State): any | 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

@@ -4,10 +4,12 @@ import type { Item } from "./multi-items/item-types";
 import type { PerseusWidget } from "./perseus-types";
 import type { SizeClass } from "./util/sizing-utils";
 import type { KeypadAPI } from "@khanacademy/math-input";
-import type { SendEventFn } from "@khanacademy/perseus-core";
+import type { AnalyticsEventHandlerFn } from "@khanacademy/perseus-core";
+import type { LinterContextProps } from "@khanacademy/perseus-linter";
 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;
@@ -75,6 +77,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;
@@ -92,11 +99,7 @@ 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?: (blur: () => void) => KeypadAPI;
@@ -161,7 +164,6 @@ export type PerseusDependencies = {
     TeX: React.ComponentType<TeXProps>;
     staticUrl: StaticUrlFn;
     InitialRequestUrl: InitialRequestUrlInterface;
-    analytics: SendEventFn;
     useVideo(id: string, kind: VideoKind): Result<{
         video: VideoData | null | undefined;
     }>;
@@ -170,6 +172,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"]>;
@@ -188,13 +203,13 @@ export type APIOptionsWithDefaults = Readonly<APIOptions & {
     showAlignmentOptions: NonNullable<APIOptions["showAlignmentOptions"]>;
     useDraftEditor: NonNullable<APIOptions["useDraftEditor"]>;
 }>;
-export type LinterContextProps = {
-    contentType: string;
-    highlightLint: boolean;
-    paths: ReadonlyArray<string>;
-    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;
@@ -220,7 +235,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;
@@ -233,7 +248,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;

package/dist/widget-container.d.ts

@@ -1,6 +1,7 @@
 import * as React from "react";
 import type { PerseusWidgetOptions } from "./perseus-types";
-import type { LinterContextProps, WidgetProps } from "./types";
+import type { WidgetProps } from "./types";
+import type { LinterContextProps } from "@khanacademy/perseus-linter";
 type Props = {
     shouldHighlight: boolean;
     type: string;