@superbuilders/primer-tives 2.0.0 → 2.2.1

package/dist/client/create.d.ts

@@ -1,20 +1,36 @@
 import type { PrimerLogger } from "../logger";
 import type { PciId } from "../contracts/pci";
-import type { SubjectScope } from "../subject";
 import type { PrimerState } from "./types";
-interface Config<Pcis extends PciId = PciId> {
+import type { SubjectScope } from "../subject";
+import { type RequiredPciForSubject } from "../subject-pcis";
+type SupportedPciForSubject<S extends SubjectScope, Pcis extends PciId> = Pcis | RequiredPciForSubject<S>;
+type ConfigFields<S extends SubjectScope> = {
     readonly accessToken: string;
-    readonly supportedPcis: readonly Pcis[];
+    readonly subject: S;
     readonly origin: string;
-    readonly subject: SubjectScope;
     readonly fetch?: typeof globalThis.fetch;
     readonly abort?: AbortController;
     readonly logger: PrimerLogger;
-}
+};
+type PciConfigForSubject<S extends SubjectScope, Pcis extends PciId> = [
+    RequiredPciForSubject<S>
+] extends [never] ? {
+    readonly supportedPcis?: readonly Pcis[];
+} : {
+    readonly supportedPcis: readonly [RequiredPciForSubject<S>, ...Pcis[]];
+};
+type Config<S extends SubjectScope, Pcis extends PciId = never> = ConfigFields<S> & PciConfigForSubject<S, Pcis>;
+type DynamicSubjectConfig<Pcis extends PciId = never> = ConfigFields<SubjectScope> & {
+    readonly supportedPcis: readonly [RequiredPciForSubject<"all">, ...Pcis[]];
+};
 interface Client<Pcis extends PciId = PciId> {
     start(): Promise<PrimerState<Pcis>>;
 }
-declare function create<const Pcis extends PciId>(config: Config<Pcis>): Client<Pcis>;
+type SubjectWithoutRequiredPcis = Exclude<SubjectScope, "all" | "math">;
+declare function create<const Pcis extends PciId = never>(config: Config<"math", Pcis>): Client<SupportedPciForSubject<"math", Pcis>>;
+declare function create<const Pcis extends PciId = never>(config: Config<"all", Pcis>): Client<SupportedPciForSubject<"all", Pcis>>;
+declare function create<const S extends SubjectWithoutRequiredPcis, const Pcis extends PciId = never>(config: Config<S, Pcis>): Client<SupportedPciForSubject<S, Pcis>>;
+declare function create<const Pcis extends PciId = never>(config: DynamicSubjectConfig<Pcis>): Client<SupportedPciForSubject<"all", Pcis>>;
 export { create };
 export type { Client, Config };
 //# sourceMappingURL=create.d.ts.map

package/dist/client/create.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../src/client/create.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAA;AACtE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,2CAA2C,CAAA;AACtE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAA;AACvE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0CAA0C,CAAA;AAM3E,UAAU,MAAM,CAAC,IAAI,SAAS,KAAK,GAAG,KAAK;IAC1C,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,aAAa,EAAE,SAAS,IAAI,EAAE,CAAA;IACvC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAA;IAC9B,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAA;IACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,eAAe,CAAA;IAChC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAA;CAC7B;AAED,UAAU,MAAM,CAAC,IAAI,SAAS,KAAK,GAAG,KAAK;IAC1C,KAAK,IAAI,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAA;CACnC;AAUD,iBAAS,MAAM,CAAC,KAAK,CAAC,IAAI,SAAS,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CA2C5E;AAED,OAAO,EAAE,MAAM,EAAE,CAAA;AACjB,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,CAAA"}
+{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../src/client/create.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAA;AACtE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,2CAA2C,CAAA;AACtE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0CAA0C,CAAA;AAG3E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAA;AACvE,OAAO,EAEN,KAAK,qBAAqB,EAC1B,MAAM,0CAA0C,CAAA;AAIjD,KAAK,sBAAsB,CAAC,CAAC,SAAS,YAAY,EAAE,IAAI,SAAS,KAAK,IACnE,IAAI,GACJ,qBAAqB,CAAC,CAAC,CAAC,CAAA;AAE3B,KAAK,YAAY,CAAC,CAAC,SAAS,YAAY,IAAI;IAC3C,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;IACnB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAA;IACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,eAAe,CAAA;IAChC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAA;CAC7B,CAAA;AAED,KAAK,mBAAmB,CAAC,CAAC,SAAS,YAAY,EAAE,IAAI,SAAS,KAAK,IAAI;IACtE,qBAAqB,CAAC,CAAC,CAAC;CACxB,SAAS,CAAC,KAAK,CAAC,GACd;IAAE,QAAQ,CAAC,aAAa,CAAC,EAAE,SAAS,IAAI,EAAE,CAAA;CAAE,GAC5C;IAAE,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,CAAA;CAAE,CAAA;AAE7E,KAAK,MAAM,CAAC,CAAC,SAAS,YAAY,EAAE,IAAI,SAAS,KAAK,GAAG,KAAK,IAAI,YAAY,CAAC,CAAC,CAAC,GAChF,mBAAmB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA;AAE7B,KAAK,oBAAoB,CAAC,IAAI,SAAS,KAAK,GAAG,KAAK,IAAI,YAAY,CAAC,YAAY,CAAC,GAAG;IACpF,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,CAAA;CAC1E,CAAA;AAMD,UAAU,MAAM,CAAC,IAAI,SAAS,KAAK,GAAG,KAAK;IAC1C,KAAK,IAAI,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAA;CACnC;AAED,KAAK,0BAA0B,GAAG,OAAO,CAAC,YAAY,EAAE,KAAK,GAAG,MAAM,CAAC,CAAA;AAUvE,iBAAS,MAAM,CAAC,KAAK,CAAC,IAAI,SAAS,KAAK,GAAG,KAAK,EAC/C,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAC1B,MAAM,CAAC,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAA;AAC/C,iBAAS,MAAM,CAAC,KAAK,CAAC,IAAI,SAAS,KAAK,GAAG,KAAK,EAC/C,MAAM,EAAE,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GACzB,MAAM,CAAC,sBAAsB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;AAC9C,iBAAS,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,0BAA0B,EAAE,KAAK,CAAC,IAAI,SAAS,KAAK,GAAG,KAAK,EAC3F,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,GACrB,MAAM,CAAC,sBAAsB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC1C,iBAAS,MAAM,CAAC,KAAK,CAAC,IAAI,SAAS,KAAK,GAAG,KAAK,EAC/C,MAAM,EAAE,oBAAoB,CAAC,IAAI,CAAC,GAChC,MAAM,CAAC,sBAAsB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;AAuD9C,OAAO,EAAE,MAAM,EAAE,CAAA;AACjB,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,CAAA"}

package/dist/client/index.js

@@ -3,6 +3,7 @@ import * as errors from "@superbuilders/errors";
 var ErrNetwork = errors.new("network");
 var ErrJsonParse = errors.new("json parse");
 var ErrUnsupportedPci = errors.new("unsupported pci");
+var ErrMissingRequiredPci = errors.new("missing required pci");
 var ErrInvalidAccessToken = errors.new("invalid access token");
 var ErrMalformedAccessToken = errors.new("malformed access token");
 var ErrTokenExpired = errors.new("access token expired");
@@ -12,16 +13,11 @@ var ErrTimeout = errors.new("timeout");
 var ErrForbidden = errors.new("forbidden");
 var ErrNotFound = errors.new("not found");
 var ErrConflict = errors.new("conflict");
-var ErrExternalAuthorityRequired = errors.new("external authority required");
 var ErrRateLimited = errors.new("rate limited");
 var ErrServiceUnavailable = errors.new("service unavailable");
 var ErrNotSerializable = errors.new("PrimerState is live in-memory state and must not be serialized or stored");
 var ErrInvalidSubmission = errors.new("invalid submission");
 var ErrInvalidSecretKey = errors.new("invalid secret key");
-var ErrStudentNotFound = errors.new("student not found");
-var ErrUnsupportedGrade = errors.new("unsupported grade");
-var ErrTimebackUnavailable = errors.new("timeback unavailable");
-var ErrNeedsHints = errors.new("student needs hints set before /advance");
 var ErrSdkUpgradeRequired = errors.new("sdk upgrade required");
 // src/contracts/content.ts
 function inlinesToPlainText(nodes) {
@@ -47,31 +43,44 @@ function blocksToPlainText(blocks) {
   }).join(`
 `);
 }
+// src/contracts/pci.ts
+var PCI_IDS = ["urn:primer:pci:fraction-input"];
+function isPciId(value) {
+  for (const id of PCI_IDS) {
+    if (id === value) {
+      return true;
+    }
+  }
+  return false;
+}
 // src/contracts/validation.ts
 import { z as z2 } from "zod";
 
 // src/contracts/pci-schemas.ts
 import { z } from "zod";
-var DivisionRemainderPropsSchema = z.object({
-  dividend: z.number(),
-  divisor: z.number()
-});
-var DivisionRemainderSubmissionSchema = z.object({
-  quotient: z.string(),
-  remainder: z.string()
-});
-var FractionOperandSchema = z.object({
-  numerator: z.number(),
-  denominator: z.number()
-});
-var FractionAdditionPropsSchema = z.object({
-  left: FractionOperandSchema,
-  right: FractionOperandSchema
-});
-var FractionAdditionSubmissionSchema = z.object({
-  numerator: z.string(),
-  denominator: z.string()
+var FractionInputPropsSchema = z.object({
+  form: z.enum(["whole", "proper", "improper", "mixed"]),
+  requireSimplified: z.boolean()
 });
+var FractionInputSubmissionSchema = z.discriminatedUnion("form", [
+  z.object({ form: z.literal("whole"), whole: z.string() }),
+  z.object({
+    form: z.literal("proper"),
+    numerator: z.string(),
+    denominator: z.string()
+  }),
+  z.object({
+    form: z.literal("improper"),
+    numerator: z.string(),
+    denominator: z.string()
+  }),
+  z.object({
+    form: z.literal("mixed"),
+    whole: z.string(),
+    numerator: z.string(),
+    denominator: z.string()
+  })
+]);
 
 // src/contracts/validation.ts
 var MatchPairSchema = z2.object({
@@ -98,15 +107,10 @@ var MatchSubmissionSchema = z2.object({
   type: z2.literal("match"),
   pairs: z2.array(MatchPairSchema)
 });
-var DivisionRemainderPciSubmissionSchema = z2.object({
-  type: z2.literal("portable-custom"),
-  pciId: z2.literal("urn:primer:pci:division-remainder"),
-  value: DivisionRemainderSubmissionSchema
-});
-var FractionAdditionPciSubmissionSchema = z2.object({
+var FractionInputPciSubmissionSchema = z2.object({
   type: z2.literal("portable-custom"),
-  pciId: z2.literal("urn:primer:pci:fraction-addition"),
-  value: FractionAdditionSubmissionSchema
+  pciId: z2.literal("urn:primer:pci:fraction-input"),
+  value: FractionInputSubmissionSchema
 });
 var RendererSubmissionSchema = z2.union([
   ChoiceSubmissionSchema,
@@ -114,8 +118,7 @@ var RendererSubmissionSchema = z2.union([
   ExtendedTextSubmissionSchema,
   OrderSubmissionSchema,
   MatchSubmissionSchema,
-  DivisionRemainderPciSubmissionSchema,
-  FractionAdditionPciSubmissionSchema
+  FractionInputPciSubmissionSchema
 ]);
 function duplicates(values, keyOf) {
   const seen = new Set;
@@ -167,10 +170,8 @@ function validateUsageBounds(choices, counts, side) {
 }
 function pciSubmissionSchema(pciId) {
   switch (pciId) {
-    case "urn:primer:pci:division-remainder":
-      return DivisionRemainderSubmissionSchema;
-    case "urn:primer:pci:fraction-addition":
-      return FractionAdditionSubmissionSchema;
+    case "urn:primer:pci:fraction-input":
+      return FractionInputSubmissionSchema;
   }
   const exhaustiveCheck = pciId;
   return exhaustiveCheck;
@@ -332,6 +333,8 @@ function validateSubmissionForInteraction(interaction, submission) {
 function submissionValidationMessage(result) {
   return result.issues.join("; ");
 }
+// src/subject.ts
+var SUBJECTS = ["math", "vocabulary", "science"];
 // src/client/create.ts
 import * as errors10 from "@superbuilders/errors";
 
@@ -339,7 +342,7 @@ import * as errors10 from "@superbuilders/errors";
 import * as errors2 from "@superbuilders/errors";
 
 // src/version.ts
-var SDK_VERSION = "2.0.0";
+var SDK_VERSION = "2.2.1";
 var NPM_PACKAGE_URL = "https://www.npmjs.com/package/@superbuilders/primer-tives";
 
 // src/client/transport.ts
@@ -415,9 +418,6 @@ function httpSentinel(status, body) {
   if (status === 409) {
     return ErrConflict;
   }
-  if (status === 412) {
-    return ErrNeedsHints;
-  }
   if (status === 429) {
     return ErrRateLimited;
   }
@@ -504,12 +504,15 @@ function createTransport(tc) {
       const text = await res.text().catch(function fallback() {
         return "";
       });
-      const sentinel = res.status === 422 ? ErrUnsupportedPci : httpSentinel(res.status, text);
+      const sentinel = httpSentinel(res.status, text);
       if (errors2.is(sentinel, ErrSdkUpgradeRequired)) {
         return { ok: false, error: buildSdkUpgradeRequiredError(sentinel, text, logger) };
       }
       logger.error("transport http error", {
-        status: res.status
+        status: res.status,
+        body: text,
+        intentKind: body.intent.kind,
+        subject: body.subject
       });
       return { ok: false, error: errors2.wrap(sentinel, text) };
     }
@@ -984,7 +987,6 @@ var FATAL_SENTINELS = [
   ErrTokenExpired,
   ErrForbidden,
   ErrNotFound,
-  ErrNeedsHints,
   ErrSdkUpgradeRequired,
   ErrUnsupportedPci
 ];
@@ -1046,20 +1048,40 @@ function makeSession(sc) {
     return state;
   }
   async function execute(intent, phase) {
-    const body = {
-      supportedPcis: sc.supportedPcis,
-      intent,
+    logger.debug("session execute", {
+      phase,
+      intentKind: intent.kind,
       subject: sc.subject
+    });
+    const body = {
+      subject: sc.subject,
+      intent
     };
     const result = await sc.transport(body);
     if (!result.ok) {
       if (isFatalError(result.error)) {
-        logger.error("fatal transport error", { error: result.error, phase });
+        logger.error("fatal transport error", {
+          error: result.error,
+          phase,
+          intentKind: intent.kind
+        });
         return { phase: "fatal", error: result.error, retriable: false, toJSON: poisonToJSON };
       }
+      logger.warn("retriable transport error", {
+        error: result.error,
+        phase,
+        intentKind: intent.kind
+      });
       return errored(result.error, phase, intent);
     }
-    return resolve(result.data);
+    const next = resolve(result.data);
+    logger.debug("session execute resolved", {
+      phase,
+      intentKind: intent.kind,
+      outcome: result.data.outcome,
+      nextPhase: next.phase
+    });
+    return next;
   }
   function isPciSupported(pciId) {
     for (const id of sc.supportedPcis) {
@@ -1106,6 +1128,37 @@ function makeSession(sc) {
   return { execute };
 }
 
+// src/subject-pcis.ts
+var REQUIRED_PCIS_BY_SUBJECT = {
+  math: ["urn:primer:pci:fraction-input"],
+  vocabulary: [],
+  science: []
+};
+function requiredPcisForSubject(subject) {
+  if (subject === "all") {
+    const all = [];
+    for (const s of SUBJECTS) {
+      for (const pci of REQUIRED_PCIS_BY_SUBJECT[s]) {
+        if (!all.includes(pci)) {
+          all.push(pci);
+        }
+      }
+    }
+    return all;
+  }
+  return REQUIRED_PCIS_BY_SUBJECT[subject];
+}
+function missingPcisForSubject(subject, provided) {
+  const required = requiredPcisForSubject(subject);
+  const missing = [];
+  for (const pci of required) {
+    if (provided === undefined || !provided.includes(pci)) {
+      missing.push(pci);
+    }
+  }
+  return missing;
+}
+
 // src/client/create.ts
 var ACCESS_TOKEN_PREFIX = "eyJ";
 function isMalformedJws(token) {
@@ -1117,13 +1170,22 @@ function isMalformedJws(token) {
 }
 function create(config) {
   const logger = config.logger;
+  let supportedPcis = [];
+  if (config.supportedPcis !== undefined) {
+    supportedPcis = config.supportedPcis;
+  }
+  const missingPcis = missingPcisForSubject(config.subject, supportedPcis);
+  if (missingPcis.length > 0) {
+    logger.error("renderer missing required pcis", { subject: config.subject, missingPcis });
+    throw errors10.wrap(ErrMissingRequiredPci, `subject '${config.subject}'`);
+  }
   if (isMalformedJws(config.accessToken)) {
     logger.error("malformed access token", { prefix: ACCESS_TOKEN_PREFIX });
     throw errors10.wrap(ErrMalformedAccessToken, `token must start with '${ACCESS_TOKEN_PREFIX}' and contain two dots`);
   }
   const transport = createTransport({
     accessToken: config.accessToken,
-    supportedPcis: config.supportedPcis,
+    subject: config.subject,
     origin: config.origin,
     fetch: config.fetch,
     abort: config.abort,
@@ -1131,10 +1193,10 @@ function create(config) {
   });
   let startPromise;
   async function doStart() {
-    logger.debug("start", { subject: config.subject });
+    logger.debug("start");
     const s = makeSession({
-      supportedPcis: config.supportedPcis,
       subject: config.subject,
+      supportedPcis,
       logger,
       transport
     });
@@ -1155,4 +1217,4 @@ export {
   create
 };
 
-//# debugId=5A77D78E02028F9D64756E2164756E21
+//# debugId=859C0D980BD7BD1D64756E2164756E21