@khanacademy/perseus-core 7.1.1 → 8.0.0

package/dist/parse-perseus-json/general-purpose-parsers/object-types.d.ts

@@ -0,0 +1,11 @@
+/**
+ * These types were inspired by:
+ * - https://stackoverflow.com/questions/56863875/typescript-how-do-you-filter-a-types-properties-to-those-of-a-certain-type
+ *   (public domain)
+ * - https://github.com/ianstormtaylor/superstruct/blob/e414c8afd3b69f6bc0173b8ee25f71d8e5694f01/src/utils.ts
+ *   (MIT license)
+ */
+export type OptionalizeProperties<T extends object> = Omit<T, OptionalKeysOf<T>> & Partial<Pick<T, OptionalKeysOf<T>>>;
+export type OptionalKeysOf<T extends object> = {
+    [K in keyof T]-?: undefined extends T[K] ? K : never;
+}[keyof T];

package/dist/parse-perseus-json/general-purpose-parsers/object-types.typetest.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/parse-perseus-json/general-purpose-parsers/object.d.ts

@@ -1,6 +1,10 @@
+import type { OptionalizeProperties } from "./object-types";
 import type { ParsedValue, Parser } from "../parser-types";
 type ObjectSchema = Record<keyof any, Parser<any>>;
-export declare function object<S extends ObjectSchema>(schema: S): Parser<{
+export declare function objectWithAllPropertiesRequired<S extends ObjectSchema>(schema: S): Parser<{
     [K in keyof S]: ParsedValue<S[K]>;
 }>;
+export declare function object<S extends ObjectSchema>(schema: S): Parser<OptionalizeProperties<{
+    [K in keyof S]: ParsedValue<S[K]>;
+}>>;
 export {};

package/dist/parse-perseus-json/perseus-parsers/dropdown-user-input.d.ts

@@ -1,3 +1,3 @@
-export declare const parseDropdownUserInput: import("../parser-types").Parser<{
+export declare const parseDropdownUserInput: import("../parser-types").Parser<import("../general-purpose-parsers/object-types").OptionalizeProperties<{
     value: number;
-}>;
+}>>;

package/dist/parse-perseus-json/perseus-parsers/graded-group-widget.d.ts

@@ -1,6 +1,6 @@
 import type { GradedGroupWidget } from "../../data-schema";
 import type { Parser } from "../parser-types";
-export declare const parseGradedGroupWidgetOptions: Parser<{
+export declare const parseGradedGroupWidgetOptions: Parser<import("../general-purpose-parsers/object-types").OptionalizeProperties<{
     title: string;
     hasHint: boolean | null | undefined;
     hint: import("../..").PerseusRenderer | null | undefined;
@@ -8,9 +8,9 @@ export declare const parseGradedGroupWidgetOptions: Parser<{
     widgets: import("../..").MakeWidgetMap<import("../..").PerseusWidgetTypes>;
     widgetEnabled: boolean | null | undefined;
     immutableWidgets: boolean | null | undefined;
-    images: Record<string, {
+    images: Record<string, import("../general-purpose-parsers/object-types").OptionalizeProperties<{
         width: number;
         height: number;
-    }>;
-}>;
+    }>>;
+}>>;
 export declare const parseGradedGroupWidget: Parser<GradedGroupWidget>;

package/dist/parse-perseus-json/perseus-parsers/numeric-input-user-input.d.ts

@@ -1,3 +1,3 @@
-export declare const parseNumericInputUserInput: import("../parser-types").Parser<{
+export declare const parseNumericInputUserInput: import("../parser-types").Parser<import("../general-purpose-parsers/object-types").OptionalizeProperties<{
     currentValue: string;
-}>;
+}>>;

package/dist/parse-perseus-json/perseus-parsers/radio-user-input.d.ts

@@ -1,3 +1,3 @@
-export declare const parseRadioUserInput: import("../parser-types").Parser<{
+export declare const parseRadioUserInput: import("../parser-types").Parser<import("../general-purpose-parsers/object-types").OptionalizeProperties<{
     choicesSelected: boolean[];
-}>;
+}>>;

package/dist/parse-perseus-json/perseus-parsers/radio-widget.d.ts

@@ -1,3 +1,18 @@
-import type { RadioWidget } from "../../data-schema";
-import type { Parser } from "../parser-types";
-export declare const parseRadioWidget: Parser<RadioWidget>;
+export declare const parseRadioWidget: import("../parser-types").Parser<import("../..").WidgetOptions<"radio", import("../general-purpose-parsers/object-types").OptionalizeProperties<{
+    numCorrect: number | undefined;
+    choices: import("../general-purpose-parsers/object-types").OptionalizeProperties<{
+        content: string;
+        clue: string | undefined;
+        correct: boolean | undefined;
+        isNoneOfTheAbove: boolean | undefined;
+        widgets: import("../..").MakeWidgetMap<import("../..").PerseusWidgetTypes> | undefined;
+    }>[];
+    hasNoneOfTheAbove: boolean | undefined;
+    countChoices: boolean | undefined;
+    randomize: boolean | undefined;
+    multipleSelect: boolean | undefined;
+    deselectEnabled: boolean | undefined;
+    onePerLine: boolean | undefined;
+    displayCount: any;
+    noneOfTheAbove: false | undefined;
+}>>>;

package/dist/parse-perseus-json/perseus-parsers/radio-widget.typetest.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/parse-perseus-json/perseus-parsers/widget.d.ts

@@ -1,7 +1,7 @@
 import type { WidgetOptions } from "../../data-schema";
 import type { Parser } from "../parser-types";
-export declare function parseWidget<Type extends string, Options>(parseType: Parser<Type>, parseOptions: Parser<Options>): Parser<WidgetOptions<Type, Options>>;
+export declare function parseWidget<Type extends string, Options extends object>(parseType: Parser<Type>, parseOptions: Parser<Options>): Parser<WidgetOptions<Type, Options>>;
 export declare function parseWidgetWithVersion<Version extends {
     major: number;
     minor: number;
-} | undefined, Type extends string, Options>(parseVersion: Parser<Version>, parseType: Parser<Type>, parseOptions: Parser<Options>): Parser<WidgetOptions<Type, Options>>;
+} | undefined, Type extends string, Options extends object>(parseVersion: Parser<Version>, parseType: Parser<Type>, parseOptions: Parser<Options>): Parser<WidgetOptions<Type, Options>>;

package/dist/utils/split-perseus-item.d.ts

@@ -1,7 +1,7 @@
-import type { PerseusRenderer } from "../data-schema";
+import type { PerseusItem } from "../data-schema";
 /**
  * Return a copy of a Perseus item with rubric data removed (ie answers)
  *
  * @param originalItem - the original, full Perseus item (which includes the rubric - aka answer data)
  */
-export default function splitPerseusItem(originalItem: PerseusRenderer): PerseusRenderer;
+export default function splitPerseusItem(originalItem: PerseusItem): PerseusItem;

package/dist/utils/test-utils.d.ts

@@ -0,0 +1,11 @@
+import type { PerseusItem } from "../data-schema";
+/**
+ * Generate a Perseus item object for testing purposes.
+ *
+ * In order to better type Perseus objects used in testing, this function
+ * uses a basic Perseus object and updates it with custom values as needed.
+ *
+ * @param {Partial<PerseusItem>} customFields
+ * @returns {PerseusItem}
+ */
+export declare function generateTestPerseusItem(customFields?: Partial<PerseusItem>): PerseusItem;

package/package.json

@@ -3,7 +3,7 @@
   "description": "Shared Perseus infrastructure",
   "author": "Khan Academy",
   "license": "MIT",
-  "version": "7.1.1",
+  "version": "8.0.0",
   "publishConfig": {
     "access": "public"
   },
@@ -22,13 +22,13 @@
     "dist"
   ],
   "dependencies": {
-    "@khanacademy/kas": "2.0.1",
+    "@khanacademy/kas": "2.0.2",
     "@khanacademy/perseus-utils": "2.0.1"
   },
   "devDependencies": {
     "@khanacademy/wonder-stuff-core": "1.5.4",
     "underscore": "^1.4.4",
-    "perseus-build-settings": "0.6.0"
+    "perseus-build-settings": "0.6.1"
   },
   "peerDependencies": {
     "@khanacademy/wonder-stuff-core": "1.5.4",