@superbuilders/primer-tives 5.1.0 → 6.1.0

package/dist/client/index.js

@@ -7289,7 +7289,6 @@ var FORBIDDEN_JOURNEY_KEYS = new Set([
   "handle",
   "cursor",
   "delta",
-  "revision",
   "standard",
   "prerequisite",
   "theme",
@@ -7518,27 +7517,37 @@ function choiceState(ctx, journey, body, stimulus, interaction, options, maxChoi
 
 // src/client/extended-text-state.ts
 import * as errors6 from "@superbuilders/errors";
-function extendedTextState(ctx, journey, body, stimulus, interaction, feedback) {
+function extendedTextIntent(submission, nextSubmissionRole) {
+  if (nextSubmissionRole === "revision") {
+    return { kind: "interaction", submission, submissionRole: "revision" };
+  }
+  return { kind: "interaction", submission };
+}
+function extendedTextState(ctx, journey, body, stimulus, interaction, feedback, options = {}) {
   if (interaction.cardinality === "single") {
     let submitText = function(value) {
-      const submission = { type: "extended-text", values: [value] };
+      const submission = {
+        type: "extended-text",
+        values: [value]
+      };
+      const intent = extendedTextIntent(submission, options.nextSubmissionRole);
       const key = JSON.stringify(submission);
       if (timeoutPending2) {
-        return Promise.resolve(ctx.errored(errors6.wrap(ErrConflict, "cannot submit while timeout is in flight"), "interaction", { kind: "interaction", submission }));
+        return Promise.resolve(ctx.errored(errors6.wrap(ErrConflict, "cannot submit while timeout is in flight"), "interaction", intent));
       }
       if (submitPending2) {
         if (submitKey2 === key) {
           return submitPending2;
         }
-        return Promise.resolve(ctx.errored(errors6.wrap(ErrConflict, "cannot submit a different extended-text payload while submit is in flight"), "interaction", { kind: "interaction", submission }));
+        return Promise.resolve(ctx.errored(errors6.wrap(ErrConflict, "cannot submit a different extended-text payload while submit is in flight"), "interaction", intent));
       }
       const validation = validateSubmissionForInteraction(interaction, submission);
       if (!validation.ok) {
         ctx.logger.error({ value, issues: validation.issues }, "extended-text submit invalid");
-        return Promise.resolve(ctx.errored(errors6.wrap(ErrInvalidSubmission, submissionValidationMessage(validation)), "interaction", { kind: "interaction", submission }));
+        return Promise.resolve(ctx.errored(errors6.wrap(ErrInvalidSubmission, submissionValidationMessage(validation)), "interaction", intent));
       }
       submitKey2 = key;
-      submitPending2 = ctx.execute({ kind: "interaction", submission }, "interaction").finally(function clearPending() {
+      submitPending2 = ctx.execute(intent, "interaction").finally(function clearPending() {
         submitPending2 = undefined;
         submitKey2 = undefined;
       });
@@ -7568,6 +7577,7 @@ function extendedTextState(ctx, journey, body, stimulus, interaction, feedback)
       stimulus,
       interaction,
       feedback,
+      initialValue: options.initialValue,
       submitText,
       timeout: timeout2,
       toJSON: poisonToJSON
@@ -7578,24 +7588,28 @@ function extendedTextState(ctx, journey, body, stimulus, interaction, feedback)
   let submitKey;
   let timeoutPending;
   function submitTexts(values) {
-    const submission = { type: "extended-text", values };
+    const submission = {
+      type: "extended-text",
+      values
+    };
+    const intent = extendedTextIntent(submission, options.nextSubmissionRole);
     const key = JSON.stringify(submission);
     if (timeoutPending) {
-      return Promise.resolve(ctx.errored(errors6.wrap(ErrConflict, "cannot submit while timeout is in flight"), "interaction", { kind: "interaction", submission }));
+      return Promise.resolve(ctx.errored(errors6.wrap(ErrConflict, "cannot submit while timeout is in flight"), "interaction", intent));
     }
     if (submitPending) {
       if (submitKey === key) {
         return submitPending;
       }
-      return Promise.resolve(ctx.errored(errors6.wrap(ErrConflict, "cannot submit a different extended-text payload while submit is in flight"), "interaction", { kind: "interaction", submission }));
+      return Promise.resolve(ctx.errored(errors6.wrap(ErrConflict, "cannot submit a different extended-text payload while submit is in flight"), "interaction", intent));
     }
     const validation = validateSubmissionForInteraction(multi, submission);
     if (!validation.ok) {
       ctx.logger.error({ values, issues: validation.issues }, "extended-text submit invalid");
-      return Promise.resolve(ctx.errored(errors6.wrap(ErrInvalidSubmission, submissionValidationMessage(validation)), "interaction", { kind: "interaction", submission }));
+      return Promise.resolve(ctx.errored(errors6.wrap(ErrInvalidSubmission, submissionValidationMessage(validation)), "interaction", intent));
     }
     submitKey = key;
-    submitPending = ctx.execute({ kind: "interaction", submission }, "interaction").finally(function clearPending() {
+    submitPending = ctx.execute(intent, "interaction").finally(function clearPending() {
       submitPending = undefined;
       submitKey = undefined;
     });
@@ -7623,6 +7637,7 @@ function extendedTextState(ctx, journey, body, stimulus, interaction, feedback)
     stimulus,
     interaction: multi,
     feedback,
+    initialValues: options.initialValues,
     maxStrings: multi.maxStrings,
     minStrings: multi.minStrings,
     submitTexts,
@@ -7642,7 +7657,7 @@ function createAdvance(ctx) {
     return pending;
   };
 }
-function submittedFeedbackState(ctx, journey, body, stimulus, interaction, submission, assessmentOutcome, feedbackContent, review) {
+function submittedFeedbackState(ctx, journey, body, stimulus, interaction, submission, isCorrect, feedbackContent, review) {
   return {
     phase: "feedback",
     feedbackKind: "submitted",
@@ -7651,7 +7666,7 @@ function submittedFeedbackState(ctx, journey, body, stimulus, interaction, submi
     stimulus,
     interaction,
     submission,
-    assessmentOutcome,
+    isCorrect,
     feedbackContent,
     review,
     advance: createAdvance(ctx),
@@ -7871,29 +7886,39 @@ function pciInteractionState(ctx, journey, body, stimulus, interaction, feedback
 
 // src/client/text-entry-state.ts
 import * as errors10 from "@superbuilders/errors";
-function textEntryState(ctx, journey, body, stimulus, interaction, feedback) {
+function textEntryIntent(submission, nextSubmissionRole) {
+  if (nextSubmissionRole === "revision") {
+    return { kind: "interaction", submission, submissionRole: "revision" };
+  }
+  return { kind: "interaction", submission };
+}
+function textEntryState(ctx, journey, body, stimulus, interaction, feedback, options = {}) {
   let submitPending;
   let submitKey;
   let timeoutPending;
   function submitText(value) {
-    const submission = { type: "text-entry", value };
+    const submission = {
+      type: "text-entry",
+      value
+    };
+    const intent = textEntryIntent(submission, options.nextSubmissionRole);
     const key = JSON.stringify(submission);
     if (timeoutPending) {
-      return Promise.resolve(ctx.errored(errors10.wrap(ErrConflict, "cannot submit while timeout is in flight"), "interaction", { kind: "interaction", submission }));
+      return Promise.resolve(ctx.errored(errors10.wrap(ErrConflict, "cannot submit while timeout is in flight"), "interaction", intent));
     }
     if (submitPending) {
       if (submitKey === key) {
         return submitPending;
       }
-      return Promise.resolve(ctx.errored(errors10.wrap(ErrConflict, "cannot submit a different text payload while submit is in flight"), "interaction", { kind: "interaction", submission }));
+      return Promise.resolve(ctx.errored(errors10.wrap(ErrConflict, "cannot submit a different text payload while submit is in flight"), "interaction", intent));
     }
     const validation = validateSubmissionForInteraction(interaction, submission);
     if (!validation.ok) {
       ctx.logger.error({ value, issues: validation.issues }, "text-entry submit invalid");
-      return Promise.resolve(ctx.errored(errors10.wrap(ErrInvalidSubmission, submissionValidationMessage(validation)), "interaction", { kind: "interaction", submission }));
+      return Promise.resolve(ctx.errored(errors10.wrap(ErrInvalidSubmission, submissionValidationMessage(validation)), "interaction", intent));
     }
     submitKey = key;
-    submitPending = ctx.execute({ kind: "interaction", submission }, "interaction").finally(function clearPending() {
+    submitPending = ctx.execute(intent, "interaction").finally(function clearPending() {
       submitPending = undefined;
       submitKey = undefined;
     });
@@ -7920,6 +7945,7 @@ function textEntryState(ctx, journey, body, stimulus, interaction, feedback) {
     stimulus,
     interaction,
     feedback,
+    initialValue: options.initialValue,
     submitText,
     timeout,
     toJSON: poisonToJSON
@@ -7955,11 +7981,29 @@ function isRetriableError(err) {
 function makeSession(sc) {
   const logger = sc.logger;
   let latestJourney = ONBOARDING_JOURNEY;
-  function resolve(result) {
+  function advancedPreservedSubmission(result, intent) {
+    if (result.outcome !== "advanced") {
+      return;
+    }
+    if (result.frame.feedback === null) {
+      return;
+    }
+    if (intent.kind !== "interaction") {
+      return;
+    }
+    if (intent.submission.type === "text-entry" || intent.submission.type === "extended-text") {
+      return intent.submission;
+    }
+    return;
+  }
+  function resolve(result, intent) {
     latestJourney = result.journey;
     switch (result.outcome) {
-      case "advanced":
-        return fromAdvanced(result.journey, result.frame.body, result.frame.stimulus, result.frame.interaction, result.frame.feedback);
+      case "advanced": {
+        const preservedSubmission = advancedPreservedSubmission(result, intent);
+        const nextSubmissionRole = preservedSubmission === undefined ? undefined : "revision";
+        return fromAdvanced(result.journey, result.frame.body, result.frame.stimulus, result.frame.interaction, result.frame.feedback, preservedSubmission, nextSubmissionRole);
+      }
       case "submitted": {
         const interaction = result.frame.interaction;
         if (interaction === null) {
@@ -7972,14 +8016,7 @@ function makeSession(sc) {
             toJSON: poisonToJSON
           };
         }
-        if (result.assessmentOutcome.value === "revisionRequested") {
-          const feedback = {
-            assessmentOutcome: result.assessmentOutcome,
-            feedbackContent: result.feedbackContent
-          };
-          return fromAdvanced(result.journey, result.frame.body, result.frame.stimulus, interaction, feedback);
-        }
-        return submittedFeedbackState(ctx, result.journey, result.frame.body, result.frame.stimulus, interaction, result.submission, result.assessmentOutcome, result.feedbackContent, result.review);
+        return submittedFeedbackState(ctx, result.journey, result.frame.body, result.frame.stimulus, interaction, result.submission, result.isCorrect, result.feedbackContent, result.review);
       }
       case "timedOut": {
         const interaction = result.frame.interaction;
@@ -8032,10 +8069,12 @@ function makeSession(sc) {
     logger.debug({
       phase,
       intentKind: intent.kind,
-      subject: sc.subject
+      subject: sc.subject,
+      mode: sc.mode
     }, "session execute");
     const body = {
       subject: sc.subject,
+      mode: sc.mode,
       intent
     };
     const result = await sc.transport(body);
@@ -8065,7 +8104,7 @@ function makeSession(sc) {
       }, "retriable transport error");
       return errored(result.error, phase, intent);
     }
-    const next = resolve(result.data);
+    const next = resolve(result.data, intent);
     logger.debug({
       phase,
       intentKind: intent.kind,
@@ -8082,7 +8121,7 @@ function makeSession(sc) {
     }
     return false;
   }
-  function fromAdvanced(journey, body, stimulus, interaction, feedback) {
+  function fromAdvanced(journey, body, stimulus, interaction, feedback, preservedSubmission, nextSubmissionRole) {
     if (interaction === null) {
       return observationState(ctx, journey, body, stimulus);
     }
@@ -8098,9 +8137,9 @@ function makeSession(sc) {
         };
       }
     }
-    return pendingInteractionState(journey, body, stimulus, interaction, feedback);
+    return pendingInteractionState(journey, body, stimulus, interaction, feedback, preservedSubmission, nextSubmissionRole);
   }
-  function extendedTextInteractionState(journey, body, stimulus, interaction, feedback) {
+  function extendedTextInteractionState(journey, body, stimulus, interaction, feedback, preservedSubmission, nextSubmissionRole) {
     if (!("cardinality" in interaction)) {
       logger.error("extended-text interaction is unsupported");
       return {
@@ -8112,16 +8151,39 @@ function makeSession(sc) {
       };
     }
     const extendedInteraction = interaction;
-    return extendedTextState(ctx, journey, body, stimulus, extendedInteraction, feedback);
+    if (preservedSubmission?.type === "extended-text") {
+      if (extendedInteraction.cardinality === "single") {
+        const [initialValue] = preservedSubmission.values;
+        return extendedTextState(ctx, journey, body, stimulus, extendedInteraction, feedback, {
+          initialValue,
+          nextSubmissionRole
+        });
+      }
+      return extendedTextState(ctx, journey, body, stimulus, extendedInteraction, feedback, {
+        initialValues: preservedSubmission.values,
+        nextSubmissionRole
+      });
+    }
+    return extendedTextState(ctx, journey, body, stimulus, extendedInteraction, feedback, {
+      nextSubmissionRole
+    });
   }
-  function pendingInteractionState(journey, body, stimulus, interaction, feedback) {
+  function pendingInteractionState(journey, body, stimulus, interaction, feedback, preservedSubmission, nextSubmissionRole) {
     switch (interaction.type) {
       case "choice":
         return choiceState(ctx, journey, body, stimulus, interaction, interaction.options, interaction.maxChoices, interaction.minChoices, feedback);
       case "text-entry":
-        return textEntryState(ctx, journey, body, stimulus, interaction, feedback);
+        if (preservedSubmission?.type === "text-entry") {
+          return textEntryState(ctx, journey, body, stimulus, interaction, feedback, {
+            initialValue: preservedSubmission.value,
+            nextSubmissionRole
+          });
+        }
+        return textEntryState(ctx, journey, body, stimulus, interaction, feedback, {
+          nextSubmissionRole
+        });
       case "extended-text":
-        return extendedTextInteractionState(journey, body, stimulus, interaction, feedback);
+        return extendedTextInteractionState(journey, body, stimulus, interaction, feedback, preservedSubmission, nextSubmissionRole);
       case "order":
         return orderState(ctx, journey, body, stimulus, interaction, feedback);
       case "match":
@@ -8138,11 +8200,21 @@ function makeSession(sc) {
 import * as errors12 from "@superbuilders/errors";
 
 // src/version.ts
-var SDK_VERSION = "5.1.0";
+var SDK_VERSION = "6.1.0";
 var NPM_PACKAGE_URL = "https://www.npmjs.com/package/@superbuilders/primer-tives";
 
 // src/client/transport.ts
 var ADVANCE_PATH = "/api/v0/advance";
+function readNumberField(value, key) {
+  if (!(key in value)) {
+    return;
+  }
+  const v = Reflect.get(value, key);
+  if (typeof v !== "number") {
+    return;
+  }
+  return v;
+}
 function readStringField(value, key) {
   if (!(key in value)) {
     return;
@@ -8176,9 +8248,9 @@ function parseAdvanceErrorBody(body) {
   if (detail !== undefined) {
     result.detail = detail;
   }
-  const minimumSdkVersion = readStringField(raw, "minimumSdkVersion");
-  if (minimumSdkVersion !== undefined) {
-    result.minimumSdkVersion = minimumSdkVersion;
+  const minimumSdkMajor = readNumberField(raw, "minimumSdkMajor");
+  if (minimumSdkMajor !== undefined) {
+    result.minimumSdkMajor = minimumSdkMajor;
   }
   const receivedSdkVersion = readStringField(raw, "receivedSdkVersion");
   if (receivedSdkVersion !== undefined) {
@@ -8251,22 +8323,24 @@ function buildSdkUpgradeRequiredError(sentinel, text, logger) {
   if (parsed === null) {
     logger.error({
       receivedSdkVersion: null,
-      minimumSdkVersion: "<unknown>",
+      minimumSdkMajor: "<unknown>",
       upgradeUrl: NPM_PACKAGE_URL
     }, "sdk upgrade required");
-    const message2 = `<missing> < <unknown>; bump @superbuilders/primer-tives at ${NPM_PACKAGE_URL}`;
+    const message2 = `major < <unknown>; bump @superbuilders/primer-tives at ${NPM_PACKAGE_URL}`;
     return errors12.wrap(sentinel, message2);
   }
-  const minimumSdkVersion = parsed.minimumSdkVersion === undefined ? "<unknown>" : parsed.minimumSdkVersion;
+  let minimumSdkMajor = "<unknown>";
+  if (parsed.minimumSdkMajor !== undefined) {
+    minimumSdkMajor = String(parsed.minimumSdkMajor);
+  }
   const receivedSdkVersion = parsed.receivedSdkVersion === undefined ? null : parsed.receivedSdkVersion;
-  const receivedDisplay = receivedSdkVersion === null ? "<missing>" : receivedSdkVersion;
   const upgradeUrl = parsed.upgradeUrl === undefined ? NPM_PACKAGE_URL : parsed.upgradeUrl;
   logger.error({
     receivedSdkVersion,
-    minimumSdkVersion,
+    minimumSdkMajor,
     upgradeUrl
   }, "sdk upgrade required");
-  const message = `${receivedDisplay} < ${minimumSdkVersion}; bump @superbuilders/primer-tives at ${upgradeUrl}`;
+  const message = `major < ${minimumSdkMajor}; bump @superbuilders/primer-tives at ${upgradeUrl}`;
   return errors12.wrap(sentinel, message);
 }
 function isAbortError(err) {
@@ -8291,7 +8365,8 @@ function createTransport(tc) {
   async function transport(body) {
     logger.debug({
       intentKind: body.intent.kind,
-      subject: body.subject
+      subject: body.subject,
+      mode: body.mode
     }, "transport request");
     const fetchResult = await fetchFn(advanceUrl, {
       method: "POST",
@@ -8403,6 +8478,7 @@ async function startRuntime(config, resolved) {
     accessToken: resolved.accessToken,
     publishableKey: config.publishableKey,
     subject: config.subject,
+    mode: config.mode,
     origin: config.origin,
     fetch: config.fetch,
     abort: config.abort,
@@ -8410,6 +8486,7 @@ async function startRuntime(config, resolved) {
   });
   const session = makeSession({
     subject: config.subject,
+    mode: config.mode,
     supportedPcis: config.supportedPcis,
     logger: config.logger,
     transport,
@@ -8462,6 +8539,7 @@ async function start(options) {
     publishableKey: options.publishableKey,
     origin,
     authOrigin: primerAuthOrigin(options.authOrigin, origin),
+    mode: options.mode,
     fetch: options.fetch,
     abort: options.abort,
     logger,
@@ -8495,4 +8573,4 @@ export {
   start
 };
 
-//# debugId=5A8CDF1A8AF453E464756E2164756E21
+//# debugId=F3719A08107CFFB264756E2164756E21