@superbuilders/primer-tives 0.9.0 → 1.1.0

package/dist/contracts/validation.d.ts

@@ -0,0 +1,132 @@
+import { z } from "zod";
+import type { MatchPair, PciInteraction, RendererInteraction, RendererSubmission } from "./types";
+import type { PciId } from "../client/pci";
+declare const MatchPairSchema: z.ZodObject<{
+    source: z.ZodString;
+    target: z.ZodString;
+}, z.core.$strip>;
+declare const ChoiceSubmissionSchema: z.ZodObject<{
+    type: z.ZodLiteral<"choice">;
+    selectedKeys: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+declare const TextEntrySubmissionSchema: z.ZodObject<{
+    type: z.ZodLiteral<"text-entry">;
+    value: z.ZodString;
+}, z.core.$strip>;
+declare const ExtendedTextSubmissionSchema: z.ZodObject<{
+    type: z.ZodLiteral<"extended-text">;
+    values: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+declare const OrderSubmissionSchema: z.ZodObject<{
+    type: z.ZodLiteral<"order">;
+    orderedKeys: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+declare const MatchSubmissionSchema: z.ZodObject<{
+    type: z.ZodLiteral<"match">;
+    pairs: z.ZodArray<z.ZodObject<{
+        source: z.ZodString;
+        target: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const DivisionRemainderPciSubmissionSchema: z.ZodObject<{
+    type: z.ZodLiteral<"portable-custom">;
+    pciId: z.ZodLiteral<"urn:primer:pci:division-remainder">;
+    value: z.ZodObject<{
+        quotient: z.ZodString;
+        remainder: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+declare const FractionAdditionPciSubmissionSchema: z.ZodObject<{
+    type: z.ZodLiteral<"portable-custom">;
+    pciId: z.ZodLiteral<"urn:primer:pci:fraction-addition">;
+    value: z.ZodObject<{
+        numerator: z.ZodString;
+        denominator: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+declare const RendererSubmissionSchema: z.ZodUnion<readonly [z.ZodObject<{
+    type: z.ZodLiteral<"choice">;
+    selectedKeys: z.ZodArray<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"text-entry">;
+    value: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"extended-text">;
+    values: z.ZodArray<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"order">;
+    orderedKeys: z.ZodArray<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"match">;
+    pairs: z.ZodArray<z.ZodObject<{
+        source: z.ZodString;
+        target: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"portable-custom">;
+    pciId: z.ZodLiteral<"urn:primer:pci:division-remainder">;
+    value: z.ZodObject<{
+        quotient: z.ZodString;
+        remainder: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"portable-custom">;
+    pciId: z.ZodLiteral<"urn:primer:pci:fraction-addition">;
+    value: z.ZodObject<{
+        numerator: z.ZodString;
+        denominator: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>]>;
+declare const validatedSubmissionBrand: unique symbol;
+type RendererSubmissionFor<I extends RendererInteraction = RendererInteraction> = I extends {
+    type: "choice";
+} ? {
+    type: "choice";
+    selectedKeys: string[];
+} : I extends {
+    type: "text-entry";
+} ? {
+    type: "text-entry";
+    value: string;
+} : I extends {
+    type: "extended-text";
+} ? {
+    type: "extended-text";
+    values: string[];
+} : I extends {
+    type: "order";
+} ? {
+    type: "order";
+    orderedKeys: string[];
+} : I extends {
+    type: "match";
+} ? {
+    type: "match";
+    pairs: MatchPair[];
+} : I extends PciInteraction<infer SupportedPcis extends PciId> ? {
+    [K in SupportedPcis]: {
+        type: "portable-custom";
+        pciId: K;
+        value: Extract<RendererSubmission, {
+            type: "portable-custom";
+            pciId: K;
+        }>["value"];
+    };
+}[SupportedPcis] : never;
+type ValidatedRendererSubmission<I extends RendererInteraction = RendererInteraction> = RendererSubmissionFor<I> & {
+    readonly [validatedSubmissionBrand]: true;
+};
+type SubmissionValidationSuccess<I extends RendererInteraction = RendererInteraction> = {
+    ok: true;
+    value: ValidatedRendererSubmission<I>;
+};
+type SubmissionValidationFailure = {
+    ok: false;
+    issues: string[];
+};
+type SubmissionValidationResult<I extends RendererInteraction = RendererInteraction> = SubmissionValidationSuccess<I> | SubmissionValidationFailure;
+declare function validateSubmissionForInteraction<I extends RendererInteraction>(interaction: I, submission: RendererSubmission): SubmissionValidationResult<I>;
+declare function submissionValidationMessage(result: SubmissionValidationFailure): string;
+export { ChoiceSubmissionSchema, DivisionRemainderPciSubmissionSchema, ExtendedTextSubmissionSchema, FractionAdditionPciSubmissionSchema, MatchPairSchema, MatchSubmissionSchema, OrderSubmissionSchema, RendererSubmissionSchema, TextEntrySubmissionSchema, submissionValidationMessage, validateSubmissionForInteraction };
+export type { RendererSubmissionFor, SubmissionValidationFailure, SubmissionValidationResult, SubmissionValidationSuccess, ValidatedRendererSubmission };
+//# sourceMappingURL=validation.d.ts.map

package/dist/contracts/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/contracts/validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAMvB,OAAO,KAAK,EACX,SAAS,EACT,cAAc,EAEd,mBAAmB,EAEnB,kBAAkB,EAClB,MAAM,6CAA6C,CAAA;AACpD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wCAAwC,CAAA;AAEnE,QAAA,MAAM,eAAe;;;iBAGnB,CAAA;AAEF,QAAA,MAAM,sBAAsB;;;iBAG1B,CAAA;AAEF,QAAA,MAAM,yBAAyB;;;iBAG7B,CAAA;AAEF,QAAA,MAAM,4BAA4B;;;iBAGhC,CAAA;AAEF,QAAA,MAAM,qBAAqB;;;iBAGzB,CAAA;AAEF,QAAA,MAAM,qBAAqB;;;;;;iBAGzB,CAAA;AAEF,QAAA,MAAM,oCAAoC;;;;;;;iBAIxC,CAAA;AAEF,QAAA,MAAM,mCAAmC;;;;;;;iBAIvC,CAAA;AAEF,QAAA,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAQ5B,CAAA;AAEF,OAAO,CAAC,MAAM,wBAAwB,EAAE,OAAO,MAAM,CAAA;AAErD,KAAK,qBAAqB,CAAC,CAAC,SAAS,mBAAmB,GAAG,mBAAmB,IAAI,CAAC,SAAS;IAC3F,IAAI,EAAE,QAAQ,CAAA;CACd,GACE;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,YAAY,EAAE,MAAM,EAAE,CAAA;CAAE,GAC1C,CAAC,SAAS;IAAE,IAAI,EAAE,YAAY,CAAA;CAAE,GAC/B;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACrC,CAAC,SAAS;IAAE,IAAI,EAAE,eAAe,CAAA;CAAE,GAClC;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,GAC3C,CAAC,SAAS;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GAC1B;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,WAAW,EAAE,MAAM,EAAE,CAAA;CAAE,GACxC,CAAC,SAAS;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GAC1B;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,SAAS,EAAE,CAAA;CAAE,GACrC,CAAC,SAAS,cAAc,CAAC,MAAM,aAAa,SAAS,KAAK,CAAC,GAC1D;KACC,CAAC,IAAI,aAAa,GAAG;QACrB,IAAI,EAAE,iBAAiB,CAAA;QACvB,KAAK,EAAE,CAAC,CAAA;QACR,KAAK,EAAE,OAAO,CAAC,kBAAkB,EAAE;YAAE,IAAI,EAAE,iBAAiB,CAAC;YAAC,KAAK,EAAE,CAAC,CAAA;SAAE,CAAC,CAAC,OAAO,CAAC,CAAA;KAClF;CACD,CAAC,aAAa,CAAC,GACf,KAAK,CAAA;AAEb,KAAK,2BAA2B,CAAC,CAAC,SAAS,mBAAmB,GAAG,mBAAmB,IACnF,qBAAqB,CAAC,CAAC,CAAC,GAAG;IAAE,QAAQ,CAAC,CAAC,wBAAwB,CAAC,EAAE,IAAI,CAAA;CAAE,CAAA;AAEzE,KAAK,2BAA2B,CAAC,CAAC,SAAS,mBAAmB,GAAG,mBAAmB,IAAI;IACvF,EAAE,EAAE,IAAI,CAAA;IACR,KAAK,EAAE,2BAA2B,CAAC,CAAC,CAAC,CAAA;CACrC,CAAA;AAED,KAAK,2BAA2B,GAAG;IAClC,EAAE,EAAE,KAAK,CAAA;IACT,MAAM,EAAE,MAAM,EAAE,CAAA;CAChB,CAAA;AAED,KAAK,0BAA0B,CAAC,CAAC,SAAS,mBAAmB,GAAG,mBAAmB,IAChF,2BAA2B,CAAC,CAAC,CAAC,GAC9B,2BAA2B,CAAA;AAgQ9B,iBAAS,gCAAgC,CAAC,CAAC,SAAS,mBAAmB,EACtE,WAAW,EAAE,CAAC,EACd,UAAU,EAAE,kBAAkB,GAC5B,0BAA0B,CAAC,CAAC,CAAC,CAqB/B;AAED,iBAAS,2BAA2B,CAAC,MAAM,EAAE,2BAA2B,GAAG,MAAM,CAEhF;AAED,OAAO,EACN,sBAAsB,EACtB,oCAAoC,EACpC,4BAA4B,EAC5B,mCAAmC,EACnC,eAAe,EACf,qBAAqB,EACrB,qBAAqB,EACrB,wBAAwB,EACxB,yBAAyB,EACzB,2BAA2B,EAC3B,gCAAgC,EAChC,CAAA;AACD,YAAY,EACX,qBAAqB,EACrB,2BAA2B,EAC3B,0BAA0B,EAC1B,2BAA2B,EAC3B,2BAA2B,EAC3B,CAAA"}

package/dist/errors.d.ts

@@ -10,6 +10,7 @@ declare const ErrTimeout: Error;
 declare const ErrForbidden: Error;
 declare const ErrNotFound: Error;
 declare const ErrConflict: Error;
+declare const ErrExternalAuthorityRequired: Error;
 declare const ErrRateLimited: Error;
 declare const ErrServiceUnavailable: Error;
 declare const ErrNotSerializable: Error;
@@ -18,5 +19,5 @@ declare const ErrInvalidSecretKey: Error;
 declare const ErrStudentNotFound: Error;
 declare const ErrUnsupportedGrade: Error;
 declare const ErrTimebackUnavailable: Error;
-export { ErrBadRequest, ErrConflict, ErrForbidden, ErrInvalidAccessToken, ErrInvalidSecretKey, ErrInvalidSubmission, ErrJsonParse, ErrMalformedAccessToken, ErrNetwork, ErrNotFound, ErrNotSerializable, ErrRateLimited, ErrServerError, ErrServiceUnavailable, ErrStudentNotFound, ErrTimebackUnavailable, ErrTimeout, ErrTokenExpired, ErrUnsupportedGrade, ErrUnsupportedPci };
+export { ErrBadRequest, ErrConflict, ErrExternalAuthorityRequired, ErrForbidden, ErrInvalidAccessToken, ErrInvalidSecretKey, ErrInvalidSubmission, ErrJsonParse, ErrMalformedAccessToken, ErrNetwork, ErrNotFound, ErrNotSerializable, ErrRateLimited, ErrServerError, ErrServiceUnavailable, ErrStudentNotFound, ErrTimebackUnavailable, ErrTimeout, ErrTokenExpired, ErrUnsupportedGrade, ErrUnsupportedPci };
 //# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,UAAU,OAAwB,CAAA;AACxC,QAAA,MAAM,YAAY,OAA2B,CAAA;AAC7C,QAAA,MAAM,iBAAiB,OAAgC,CAAA;AACvD,QAAA,MAAM,qBAAqB,OAAqC,CAAA;AAChE,QAAA,MAAM,uBAAuB,OAAuC,CAAA;AACpE,QAAA,MAAM,eAAe,OAAqC,CAAA;AAC1D,QAAA,MAAM,aAAa,OAA4B,CAAA;AAC/C,QAAA,MAAM,cAAc,OAA6B,CAAA;AACjD,QAAA,MAAM,UAAU,OAAwB,CAAA;AACxC,QAAA,MAAM,YAAY,OAA0B,CAAA;AAC5C,QAAA,MAAM,WAAW,OAA0B,CAAA;AAC3C,QAAA,MAAM,WAAW,OAAyB,CAAA;AAC1C,QAAA,MAAM,cAAc,OAA6B,CAAA;AACjD,QAAA,MAAM,qBAAqB,OAAoC,CAAA;AAC/D,QAAA,MAAM,kBAAkB,OAEvB,CAAA;AACD,QAAA,MAAM,oBAAoB,OAAmC,CAAA;AAE7D,QAAA,MAAM,mBAAmB,OAAmC,CAAA;AAC5D,QAAA,MAAM,kBAAkB,OAAkC,CAAA;AAC1D,QAAA,MAAM,mBAAmB,OAAkC,CAAA;AAC3D,QAAA,MAAM,sBAAsB,OAAqC,CAAA;AAEjE,OAAO,EACN,aAAa,EACb,WAAW,EACX,YAAY,EACZ,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,YAAY,EACZ,uBAAuB,EACvB,UAAU,EACV,WAAW,EACX,kBAAkB,EAClB,cAAc,EACd,cAAc,EACd,qBAAqB,EACrB,kBAAkB,EAClB,sBAAsB,EACtB,UAAU,EACV,eAAe,EACf,mBAAmB,EACnB,iBAAiB,EACjB,CAAA"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,UAAU,OAAwB,CAAA;AACxC,QAAA,MAAM,YAAY,OAA2B,CAAA;AAC7C,QAAA,MAAM,iBAAiB,OAAgC,CAAA;AACvD,QAAA,MAAM,qBAAqB,OAAqC,CAAA;AAChE,QAAA,MAAM,uBAAuB,OAAuC,CAAA;AACpE,QAAA,MAAM,eAAe,OAAqC,CAAA;AAC1D,QAAA,MAAM,aAAa,OAA4B,CAAA;AAC/C,QAAA,MAAM,cAAc,OAA6B,CAAA;AACjD,QAAA,MAAM,UAAU,OAAwB,CAAA;AACxC,QAAA,MAAM,YAAY,OAA0B,CAAA;AAC5C,QAAA,MAAM,WAAW,OAA0B,CAAA;AAC3C,QAAA,MAAM,WAAW,OAAyB,CAAA;AAC1C,QAAA,MAAM,4BAA4B,OAA4C,CAAA;AAC9E,QAAA,MAAM,cAAc,OAA6B,CAAA;AACjD,QAAA,MAAM,qBAAqB,OAAoC,CAAA;AAC/D,QAAA,MAAM,kBAAkB,OAEvB,CAAA;AACD,QAAA,MAAM,oBAAoB,OAAmC,CAAA;AAE7D,QAAA,MAAM,mBAAmB,OAAmC,CAAA;AAC5D,QAAA,MAAM,kBAAkB,OAAkC,CAAA;AAC1D,QAAA,MAAM,mBAAmB,OAAkC,CAAA;AAC3D,QAAA,MAAM,sBAAsB,OAAqC,CAAA;AAEjE,OAAO,EACN,aAAa,EACb,WAAW,EACX,4BAA4B,EAC5B,YAAY,EACZ,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,YAAY,EACZ,uBAAuB,EACvB,UAAU,EACV,WAAW,EACX,kBAAkB,EAClB,cAAc,EACd,cAAc,EACd,qBAAqB,EACrB,kBAAkB,EAClB,sBAAsB,EACtB,UAAU,EACV,eAAe,EACf,mBAAmB,EACnB,iBAAiB,EACjB,CAAA"}

package/dist/errors.js

@@ -0,0 +1,48 @@
+// src/errors.ts
+import * as errors from "@superbuilders/errors";
+var ErrNetwork = errors.new("network");
+var ErrJsonParse = errors.new("json parse");
+var ErrUnsupportedPci = errors.new("unsupported pci");
+var ErrInvalidAccessToken = errors.new("invalid access token");
+var ErrMalformedAccessToken = errors.new("malformed access token");
+var ErrTokenExpired = errors.new("access token expired");
+var ErrBadRequest = errors.new("bad request");
+var ErrServerError = errors.new("server error");
+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");
+export {
+  ErrUnsupportedPci,
+  ErrUnsupportedGrade,
+  ErrTokenExpired,
+  ErrTimeout,
+  ErrTimebackUnavailable,
+  ErrStudentNotFound,
+  ErrServiceUnavailable,
+  ErrServerError,
+  ErrRateLimited,
+  ErrNotSerializable,
+  ErrNotFound,
+  ErrNetwork,
+  ErrMalformedAccessToken,
+  ErrJsonParse,
+  ErrInvalidSubmission,
+  ErrInvalidSecretKey,
+  ErrInvalidAccessToken,
+  ErrForbidden,
+  ErrExternalAuthorityRequired,
+  ErrConflict,
+  ErrBadRequest
+};
+
+//# debugId=4F60AD86845EC38864756E2164756E21

package/dist/errors.js.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "sources": ["../src/errors.ts"],
+  "sourcesContent": [
+    "import * as errors from \"@superbuilders/errors\"\n\nconst ErrNetwork = errors.new(\"network\")\nconst ErrJsonParse = errors.new(\"json parse\")\nconst ErrUnsupportedPci = errors.new(\"unsupported pci\")\nconst ErrInvalidAccessToken = errors.new(\"invalid access token\")\nconst ErrMalformedAccessToken = errors.new(\"malformed access token\")\nconst ErrTokenExpired = errors.new(\"access token expired\")\nconst ErrBadRequest = errors.new(\"bad request\")\nconst ErrServerError = errors.new(\"server error\")\nconst ErrTimeout = errors.new(\"timeout\")\nconst ErrForbidden = errors.new(\"forbidden\")\nconst ErrNotFound = errors.new(\"not found\")\nconst ErrConflict = errors.new(\"conflict\")\nconst ErrExternalAuthorityRequired = errors.new(\"external authority required\")\nconst ErrRateLimited = errors.new(\"rate limited\")\nconst ErrServiceUnavailable = errors.new(\"service unavailable\")\nconst ErrNotSerializable = errors.new(\n\t\"PrimerState is live in-memory state and must not be serialized or stored\"\n)\nconst ErrInvalidSubmission = errors.new(\"invalid submission\")\n\nconst ErrInvalidSecretKey = errors.new(\"invalid secret key\")\nconst ErrStudentNotFound = errors.new(\"student not found\")\nconst ErrUnsupportedGrade = errors.new(\"unsupported grade\")\nconst ErrTimebackUnavailable = errors.new(\"timeback unavailable\")\n\nexport {\n\tErrBadRequest,\n\tErrConflict,\n\tErrExternalAuthorityRequired,\n\tErrForbidden,\n\tErrInvalidAccessToken,\n\tErrInvalidSecretKey,\n\tErrInvalidSubmission,\n\tErrJsonParse,\n\tErrMalformedAccessToken,\n\tErrNetwork,\n\tErrNotFound,\n\tErrNotSerializable,\n\tErrRateLimited,\n\tErrServerError,\n\tErrServiceUnavailable,\n\tErrStudentNotFound,\n\tErrTimebackUnavailable,\n\tErrTimeout,\n\tErrTokenExpired,\n\tErrUnsupportedGrade,\n\tErrUnsupportedPci\n}\n"
+  ],
+  "mappings": ";AAAA;AAEA,IAAM,aAAoB,WAAI,SAAS;AACvC,IAAM,eAAsB,WAAI,YAAY;AAC5C,IAAM,oBAA2B,WAAI,iBAAiB;AACtD,IAAM,wBAA+B,WAAI,sBAAsB;AAC/D,IAAM,0BAAiC,WAAI,wBAAwB;AACnE,IAAM,kBAAyB,WAAI,sBAAsB;AACzD,IAAM,gBAAuB,WAAI,aAAa;AAC9C,IAAM,iBAAwB,WAAI,cAAc;AAChD,IAAM,aAAoB,WAAI,SAAS;AACvC,IAAM,eAAsB,WAAI,WAAW;AAC3C,IAAM,cAAqB,WAAI,WAAW;AAC1C,IAAM,cAAqB,WAAI,UAAU;AACzC,IAAM,+BAAsC,WAAI,6BAA6B;AAC7E,IAAM,iBAAwB,WAAI,cAAc;AAChD,IAAM,wBAA+B,WAAI,qBAAqB;AAC9D,IAAM,qBAA4B,WACjC,0EACD;AACA,IAAM,uBAA8B,WAAI,oBAAoB;AAE5D,IAAM,sBAA6B,WAAI,oBAAoB;AAC3D,IAAM,qBAA4B,WAAI,mBAAmB;AACzD,IAAM,sBAA6B,WAAI,mBAAmB;AAC1D,IAAM,yBAAgC,WAAI,sBAAsB;",
+  "debugId": "4F60AD86845EC38864756E2164756E21",
+  "names": []
+}

package/dist/server/create-server.d.ts

@@ -1,40 +1,42 @@
-import type { GradeLevel } from "../grade-level";
 import type { PrimerLogger } from "../logger";
-import { type SessionToken } from "./exchange";
+import { type SessionToken, type TimebackSession } from "./exchange";
+import { type PlacementHints, type PlacementHintsResult } from "./hints";
 interface PrimerServerConfig {
     readonly origin: string;
     readonly secretKey: string;
     readonly fetch?: typeof globalThis.fetch;
     readonly abort?: AbortController;
-    readonly logger?: PrimerLogger;
+    readonly logger: PrimerLogger;
 }
 interface PrimerServer {
     /**
-     * Native only: provision a new Primer-owned student. Returns a stable
-     * studentId string you persist in your own DB keyed by your user. Pair
-     * this value with `exchangeNativeStudentForAccessToken` on every
-     * session start. Timeback integrations do NOT call this — they
-     * provision automatically on exchange.
+     * Provisions a frontend-owned Primer student and returns the stable
+     * student id you persist in your own DB keyed by your user. Native
+     * students are created hint-less; call `setStudentHints` at least
+     * once (with a `gradeLevel`) before the student's first session, or
+     * the first `/advance` call will 500.
      */
-    createNativeStudent(gradeLevel: GradeLevel): Promise<string>;
+    createStudent(): Promise<string>;
     /**
-     * Native only: update an existing Primer student's grade level. For
-     * Timeback, grade changes flow from the SIS — do not call this.
+     * Partial update of a student's placement-routing hints. Pass only
+     * the fields you want to set; omitted fields are left untouched.
+     * Returns the persisted state after upsert. Today the only hint is
+     * `gradeLevel`; future hint kinds (raw context, interests, etc.)
+     * will appear as additional optional fields.
      */
-    updateNativeStudentGradeLevel(studentId: string, gradeLevel: GradeLevel): Promise<void>;
+    setStudentHints(studentId: string, hints: PlacementHints): Promise<PlacementHintsResult>;
     /**
-     * Native only: exchange a Primer-minted studentId for a short-lived
+     * Exchanges a frontend-owned native/manual student id for a short-lived
      * access token. Pass `accessToken` from the returned `SessionToken` to
      * `create()` on the browser SDK.
      */
-    exchangeNativeStudentForAccessToken(studentId: string): Promise<SessionToken>;
+    exchangeStudentForAccessToken(studentId: string): Promise<SessionToken>;
     /**
-     * Timeback only: exchange a OneRoster sourcedId for a short-lived
-     * access token. The underlying Primer student is auto-provisioned on
-     * first exchange. Pass `accessToken` from the returned `SessionToken`
-     * to `create()` on the browser SDK.
+     * Verifies the learner against live Timeback authority, resolves or
+     * provisions the corresponding frontend-owned Primer student, and
+     * returns both the stable student id and a short-lived access token.
      */
-    exchangeTimebackStudentForAccessToken(sourcedId: string): Promise<SessionToken>;
+    exchangeTimebackStudentForAccessToken(sourcedId: string): Promise<TimebackSession>;
 }
 declare function createPrimerServer(config: PrimerServerConfig): PrimerServer;
 export type { PrimerServer, PrimerServerConfig };

package/dist/server/create-server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-server.d.ts","sourceRoot":"","sources":["../../src/server/create-server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAA;AACzE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAA;AACtE,OAAO,EAAE,KAAK,YAAY,EAAiB,MAAM,6CAA6C,CAAA;AAG9F,UAAU,kBAAkB;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAA;IACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,eAAe,CAAA;IAChC,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;CAC9B;AAED,UAAU,YAAY;IACrB;;;;;;OAMG;IACH,mBAAmB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAE5D;;;OAGG;IACH,6BAA6B,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEvF;;;;OAIG;IACH,mCAAmC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;IAE7E;;;;;OAKG;IACH,qCAAqC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;CAC/E;AAED,iBAAS,kBAAkB,CAAC,MAAM,EAAE,kBAAkB,GAAG,YAAY,CAepE;AAED,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,CAAA;AAChD,OAAO,EAAE,kBAAkB,EAAE,CAAA"}
+{"version":3,"file":"create-server.d.ts","sourceRoot":"","sources":["../../src/server/create-server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAA;AACtE,OAAO,EACN,KAAK,YAAY,EACjB,KAAK,eAAe,EAGpB,MAAM,6CAA6C,CAAA;AAEpD,OAAO,EACN,KAAK,cAAc,EACnB,KAAK,oBAAoB,EAEzB,MAAM,0CAA0C,CAAA;AAGjD,UAAU,kBAAkB;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,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,YAAY;IACrB;;;;;;OAMG;IACH,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;IAEhC;;;;;;OAMG;IACH,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAExF;;;;OAIG;IACH,6BAA6B,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;IAEvE;;;;OAIG;IACH,qCAAqC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;CAClF;AAED,iBAAS,kBAAkB,CAAC,MAAM,EAAE,kBAAkB,GAAG,YAAY,CAepE;AAED,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,CAAA;AAChD,OAAO,EAAE,kBAAkB,EAAE,CAAA"}

package/dist/server/exchange.d.ts

@@ -1,17 +1,22 @@
 import type { PrimerLogger } from "../logger";
-type Provider = "native" | "timeback";
 interface ExchangeConfig {
     readonly origin: string;
     readonly secretKey: string;
     readonly fetch?: typeof globalThis.fetch;
     readonly abort?: AbortController;
-    readonly logger?: PrimerLogger;
+    readonly logger: PrimerLogger;
 }
 interface SessionToken {
     readonly accessToken: string;
     readonly expiresInSeconds: number;
 }
-declare function exchangeToken(config: ExchangeConfig, provider: Provider, studentId: string): Promise<SessionToken>;
-export type { ExchangeConfig, SessionToken };
-export { exchangeToken };
+interface TimebackSession {
+    readonly studentId: string;
+    readonly accessToken: string;
+    readonly expiresInSeconds: number;
+}
+declare function exchangeStudent(config: ExchangeConfig, studentId: string): Promise<SessionToken>;
+declare function exchangeTimebackStudent(config: ExchangeConfig, sourcedId: string): Promise<TimebackSession>;
+export type { ExchangeConfig, SessionToken, TimebackSession };
+export { exchangeStudent, exchangeTimebackStudent };
 //# sourceMappingURL=exchange.d.ts.map

package/dist/server/exchange.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"exchange.d.ts","sourceRoot":"","sources":["../../src/server/exchange.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAA;AAItE,KAAK,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAA;AAErC,UAAU,cAAc;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAA;IACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,eAAe,CAAA;IAChC,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;CAC9B;AAED,UAAU,YAAY;IACrB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAA;CACjC;AAgED,iBAAe,aAAa,CAC3B,MAAM,EAAE,cAAc,EACtB,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,MAAM,GACf,OAAO,CAAC,YAAY,CAAC,CAoEvB;AAED,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,CAAA;AAC5C,OAAO,EAAE,aAAa,EAAE,CAAA"}
+{"version":3,"file":"exchange.d.ts","sourceRoot":"","sources":["../../src/server/exchange.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAA;AAKtE,UAAU,cAAc;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,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,YAAY;IACrB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAA;CACjC;AAED,UAAU,eAAe;IACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAA;CACjC;AA8OD,iBAAe,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAmB/F;AAED,iBAAe,uBAAuB,CACrC,MAAM,EAAE,cAAc,EACtB,SAAS,EAAE,MAAM,GACf,OAAO,CAAC,eAAe,CAAC,CAmB1B;AAED,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,eAAe,EAAE,CAAA;AAC7D,OAAO,EAAE,eAAe,EAAE,uBAAuB,EAAE,CAAA"}

package/dist/server/hints.d.ts

@@ -0,0 +1,25 @@
+import { type GradeLevel } from "../grade-level";
+import type { PrimerLogger } from "../logger";
+interface HintsConfig {
+    readonly origin: string;
+    readonly secretKey: string;
+    readonly fetch?: typeof globalThis.fetch;
+    readonly abort?: AbortController;
+    readonly logger: PrimerLogger;
+}
+/**
+ * Partial update of a student's placement hints. Pass only the fields
+ * you want to set; omitted fields are left untouched. The server
+ * returns the persisted state after upsert.
+ */
+interface PlacementHints {
+    readonly gradeLevel?: GradeLevel;
+}
+interface PlacementHintsResult {
+    readonly studentId: string;
+    readonly gradeLevel: GradeLevel | null;
+}
+declare function setStudentHints(config: HintsConfig, studentId: string, hints: PlacementHints): Promise<PlacementHintsResult>;
+export type { HintsConfig, PlacementHints, PlacementHintsResult };
+export { setStudentHints };
+//# sourceMappingURL=hints.d.ts.map

package/dist/server/hints.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hints.d.ts","sourceRoot":"","sources":["../../src/server/hints.ts"],"names":[],"mappings":"AAUA,OAAO,EAAgB,KAAK,UAAU,EAAE,MAAM,yCAAyC,CAAA;AACvF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAA;AAItE,UAAU,WAAW;IACpB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,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;;;;GAIG;AACH,UAAU,cAAc;IACvB,QAAQ,CAAC,UAAU,CAAC,EAAE,UAAU,CAAA;CAChC;AAED,UAAU,oBAAoB;IAC7B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAA;CACtC;AAwKD,iBAAe,eAAe,CAC7B,MAAM,EAAE,WAAW,EACnB,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,cAAc,GACnB,OAAO,CAAC,oBAAoB,CAAC,CAkB/B;AAED,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,oBAAoB,EAAE,CAAA;AACjE,OAAO,EAAE,eAAe,EAAE,CAAA"}

package/dist/server/index.d.ts

@@ -1,8 +1,9 @@
 export { createPrimerServer } from "./create-server";
 export type { PrimerServer, PrimerServerConfig } from "./create-server";
-export type { SessionToken } from "./exchange";
-export type { PrimerLogger } from "../logger";
+export type { SessionToken, TimebackSession } from "./exchange";
+export type { PlacementHints, PlacementHintsResult } from "./hints";
 export type { GradeLevel } from "../grade-level";
 export { GRADE_LEVELS } from "../grade-level";
-export { ErrBadRequest, ErrInvalidSecretKey, ErrJsonParse, ErrNetwork, ErrServerError, ErrStudentNotFound, ErrTimebackUnavailable, ErrTimeout, ErrUnsupportedGrade } from "../errors";
+export type { PrimerLogger } from "../logger";
+export { ErrBadRequest, ErrConflict, ErrExternalAuthorityRequired, ErrInvalidSecretKey, ErrJsonParse, ErrNetwork, ErrServerError, ErrStudentNotFound, ErrTimebackUnavailable, ErrTimeout, ErrUnsupportedGrade } from "../errors";
 //# sourceMappingURL=index.d.ts.map

package/dist/server/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/server/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kDAAkD,CAAA;AACrF,YAAY,EACX,YAAY,EACZ,kBAAkB,EAClB,MAAM,kDAAkD,CAAA;AAEzD,YAAY,EAAE,YAAY,EAAE,MAAM,6CAA6C,CAAA;AAE/E,YAAY,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAA;AACtE,YAAY,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAA;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAA;AAEtE,OAAO,EACN,aAAa,EACb,mBAAmB,EACnB,YAAY,EACZ,UAAU,EACV,cAAc,EACd,kBAAkB,EAClB,sBAAsB,EACtB,UAAU,EACV,mBAAmB,EACnB,MAAM,oCAAoC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/server/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kDAAkD,CAAA;AACrF,YAAY,EACX,YAAY,EACZ,kBAAkB,EAClB,MAAM,kDAAkD,CAAA;AAEzD,YAAY,EACX,YAAY,EACZ,eAAe,EACf,MAAM,6CAA6C,CAAA;AAEpD,YAAY,EACX,cAAc,EACd,oBAAoB,EACpB,MAAM,0CAA0C,CAAA;AACjD,YAAY,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAA;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAA;AACtE,YAAY,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAA;AAEtE,OAAO,EACN,aAAa,EACb,WAAW,EACX,4BAA4B,EAC5B,mBAAmB,EACnB,YAAY,EACZ,UAAU,EACV,cAAc,EACd,kBAAkB,EAClB,sBAAsB,EACtB,UAAU,EACV,mBAAmB,EACnB,MAAM,oCAAoC,CAAA"}