@superbuilders/primer-tives 1.1.2 → 1.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (78) hide show
  1. package/README.md +407 -359
  2. package/dist/client/choice-state.d.ts +9 -0
  3. package/dist/client/choice-state.d.ts.map +1 -0
  4. package/dist/client/consumed.d.ts +3 -0
  5. package/dist/client/consumed.d.ts.map +1 -0
  6. package/dist/client/create.d.ts +20 -0
  7. package/dist/client/create.d.ts.map +1 -0
  8. package/dist/client/extended-text-state.d.ts +9 -0
  9. package/dist/client/extended-text-state.d.ts.map +1 -0
  10. package/dist/client/feedback-state.d.ts +9 -0
  11. package/dist/client/feedback-state.d.ts.map +1 -0
  12. package/dist/client/index.d.ts +4 -0
  13. package/dist/client/index.d.ts.map +1 -0
  14. package/dist/client/index.js +1074 -0
  15. package/dist/client/index.js.map +25 -0
  16. package/dist/client/match-state.d.ts +9 -0
  17. package/dist/client/match-state.d.ts.map +1 -0
  18. package/dist/client/observation-state.d.ts +7 -0
  19. package/dist/client/observation-state.d.ts.map +1 -0
  20. package/dist/client/order-state.d.ts +9 -0
  21. package/dist/client/order-state.d.ts.map +1 -0
  22. package/dist/client/pci-state.d.ts +7 -0
  23. package/dist/client/pci-state.d.ts.map +1 -0
  24. package/dist/client/session-context.d.ts +20 -0
  25. package/dist/client/session-context.d.ts.map +1 -0
  26. package/dist/client/session.d.ts +18 -0
  27. package/dist/client/session.d.ts.map +1 -0
  28. package/dist/client/text-entry-state.d.ts +9 -0
  29. package/dist/client/text-entry-state.d.ts.map +1 -0
  30. package/dist/client/transport.d.ts +47 -0
  31. package/dist/client/transport.d.ts.map +1 -0
  32. package/dist/client/types.d.ts +144 -0
  33. package/dist/client/types.d.ts.map +1 -0
  34. package/dist/contracts/content.d.ts +20 -0
  35. package/dist/contracts/content.d.ts.map +1 -0
  36. package/dist/contracts/index.d.ts +8 -0
  37. package/dist/contracts/index.d.ts.map +1 -0
  38. package/dist/contracts/index.js +326 -0
  39. package/dist/contracts/index.js.map +12 -0
  40. package/dist/contracts/pci-schemas.d.ts +25 -0
  41. package/dist/contracts/pci-schemas.d.ts.map +1 -0
  42. package/dist/contracts/pci.d.ts +38 -0
  43. package/dist/contracts/pci.d.ts.map +1 -0
  44. package/dist/contracts/review.d.ts +55 -0
  45. package/dist/contracts/review.d.ts.map +1 -0
  46. package/dist/contracts/types.d.ts +118 -0
  47. package/dist/contracts/types.d.ts.map +1 -0
  48. package/dist/contracts/validation.d.ts +92 -0
  49. package/dist/contracts/validation.d.ts.map +1 -0
  50. package/dist/errors.d.ts +23 -0
  51. package/dist/errors.d.ts.map +1 -0
  52. package/dist/errors.js +48 -0
  53. package/dist/errors.js.map +10 -0
  54. package/dist/grade-level.d.ts +5 -0
  55. package/dist/grade-level.d.ts.map +1 -0
  56. package/dist/grade-level.js +7 -0
  57. package/dist/grade-level.js.map +10 -0
  58. package/dist/logger.d.ts +8 -0
  59. package/dist/logger.d.ts.map +1 -0
  60. package/dist/logger.js +2 -0
  61. package/dist/logger.js.map +9 -0
  62. package/dist/server/create-server.d.ts +44 -0
  63. package/dist/server/create-server.d.ts.map +1 -0
  64. package/dist/server/exchange.d.ts +22 -0
  65. package/dist/server/exchange.d.ts.map +1 -0
  66. package/dist/server/hints.d.ts +25 -0
  67. package/dist/server/hints.d.ts.map +1 -0
  68. package/dist/server/index.d.ts +5 -0
  69. package/dist/server/index.d.ts.map +1 -0
  70. package/dist/server/index.js +516 -0
  71. package/dist/server/index.js.map +15 -0
  72. package/dist/server/students.d.ts +12 -0
  73. package/dist/server/students.d.ts.map +1 -0
  74. package/dist/subject.d.ts +6 -0
  75. package/dist/subject.d.ts.map +1 -0
  76. package/dist/subject.js +7 -0
  77. package/dist/subject.js.map +10 -0
  78. package/package.json +14 -6
@@ -0,0 +1,9 @@
1
+ import type { SessionContext } from "./session-context";
2
+ import type { PciId } from "../contracts/pci";
3
+ import type { RendererChoice, RendererInteraction, RendererStimulus } from "../contracts/types";
4
+ import type { PrimerState } from "./types";
5
+ declare function choiceState<Pcis extends PciId>(ctx: SessionContext<Pcis>, stimulus: RendererStimulus | null, interaction: Extract<RendererInteraction<Pcis>, {
6
+ type: "choice";
7
+ }>, options: RendererChoice[], maxChoices: number, minChoices: number): PrimerState<Pcis>;
8
+ export { choiceState };
9
+ //# sourceMappingURL=choice-state.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"choice-state.d.ts","sourceRoot":"","sources":["../../src/client/choice-state.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oDAAoD,CAAA;AACxF,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,2CAA2C,CAAA;AACtE,OAAO,KAAK,EACX,cAAc,EACd,mBAAmB,EACnB,gBAAgB,EAChB,MAAM,6CAA6C,CAAA;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0CAA0C,CAAA;AAG3E,iBAAS,WAAW,CAAC,IAAI,SAAS,KAAK,EACtC,GAAG,EAAE,cAAc,CAAC,IAAI,CAAC,EACzB,QAAQ,EAAE,gBAAgB,GAAG,IAAI,EACjC,WAAW,EAAE,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,EACnE,OAAO,EAAE,cAAc,EAAE,EACzB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,GAChB,WAAW,CAAC,IAAI,CAAC,CAqFnB;AAED,OAAO,EAAE,WAAW,EAAE,CAAA"}
@@ -0,0 +1,3 @@
1
+ declare function poisonToJSON(): never;
2
+ export { poisonToJSON };
3
+ //# sourceMappingURL=consumed.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"consumed.d.ts","sourceRoot":"","sources":["../../src/client/consumed.ts"],"names":[],"mappings":"AAEA,iBAAS,YAAY,IAAI,KAAK,CAG7B;AAED,OAAO,EAAE,YAAY,EAAE,CAAA"}
@@ -0,0 +1,20 @@
1
+ import type { PrimerLogger } from "../logger";
2
+ import type { PciId } from "../contracts/pci";
3
+ import type { SubjectScope } from "../subject";
4
+ import type { PrimerState } from "./types";
5
+ interface Config<Pcis extends PciId = PciId> {
6
+ readonly accessToken: string;
7
+ readonly supportedPcis: readonly Pcis[];
8
+ readonly origin: string;
9
+ readonly subject: SubjectScope;
10
+ readonly fetch?: typeof globalThis.fetch;
11
+ readonly abort?: AbortController;
12
+ readonly logger?: PrimerLogger;
13
+ }
14
+ interface Client<Pcis extends PciId = PciId> {
15
+ start(): Promise<PrimerState<Pcis>>;
16
+ }
17
+ declare function create<const Pcis extends PciId>(config: Config<Pcis>): Client<Pcis>;
18
+ export { create };
19
+ export type { Client, Config };
20
+ //# sourceMappingURL=create.d.ts.map
@@ -0,0 +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,CAAC,EAAE,YAAY,CAAA;CAC9B;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,CA4C5E;AAED,OAAO,EAAE,MAAM,EAAE,CAAA;AACjB,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,CAAA"}
@@ -0,0 +1,9 @@
1
+ import type { SessionContext } from "./session-context";
2
+ import type { PciId } from "../contracts/pci";
3
+ import type { RendererStimulus, StandardRendererInteraction } from "../contracts/types";
4
+ import type { PrimerState } from "./types";
5
+ declare function extendedTextState<Pcis extends PciId>(ctx: SessionContext<Pcis>, stimulus: RendererStimulus | null, interaction: Extract<StandardRendererInteraction, {
6
+ type: "extended-text";
7
+ }>): PrimerState<Pcis>;
8
+ export { extendedTextState };
9
+ //# sourceMappingURL=extended-text-state.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"extended-text-state.d.ts","sourceRoot":"","sources":["../../src/client/extended-text-state.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oDAAoD,CAAA;AACxF,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,2CAA2C,CAAA;AACtE,OAAO,KAAK,EACX,gBAAgB,EAChB,2BAA2B,EAC3B,MAAM,6CAA6C,CAAA;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0CAA0C,CAAA;AAG3E,iBAAS,iBAAiB,CAAC,IAAI,SAAS,KAAK,EAC5C,GAAG,EAAE,cAAc,CAAC,IAAI,CAAC,EACzB,QAAQ,EAAE,gBAAgB,GAAG,IAAI,EACjC,WAAW,EAAE,OAAO,CAAC,2BAA2B,EAAE;IAAE,IAAI,EAAE,eAAe,CAAA;CAAE,CAAC,GAC1E,WAAW,CAAC,IAAI,CAAC,CAqKnB;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAA"}
@@ -0,0 +1,9 @@
1
+ import type { ContentInline } from "../contracts/content";
2
+ import type { SessionContext } from "./session-context";
3
+ import type { PciId } from "../contracts/pci";
4
+ import type { RendererInteraction, RendererStimulus, RendererSubmission } from "../contracts/types";
5
+ import type { InteractionReview } from "../contracts/review";
6
+ import type { PrimerState } from "./types";
7
+ declare function feedbackState<Pcis extends PciId>(ctx: SessionContext<Pcis>, stimulus: RendererStimulus | null, interaction: RendererInteraction<Pcis>, submission: RendererSubmission<Pcis>, isCorrect: boolean, feedbackContent: ContentInline[], review: InteractionReview<Pcis> | null): PrimerState<Pcis>;
8
+ export { feedbackState };
9
+ //# sourceMappingURL=feedback-state.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"feedback-state.d.ts","sourceRoot":"","sources":["../../src/client/feedback-state.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+CAA+C,CAAA;AAClF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oDAAoD,CAAA;AACxF,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,2CAA2C,CAAA;AACtE,OAAO,KAAK,EACX,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,EAClB,MAAM,6CAA6C,CAAA;AACpD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8CAA8C,CAAA;AACrF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0CAA0C,CAAA;AAE3E,iBAAS,aAAa,CAAC,IAAI,SAAS,KAAK,EACxC,GAAG,EAAE,cAAc,CAAC,IAAI,CAAC,EACzB,QAAQ,EAAE,gBAAgB,GAAG,IAAI,EACjC,WAAW,EAAE,mBAAmB,CAAC,IAAI,CAAC,EACtC,UAAU,EAAE,kBAAkB,CAAC,IAAI,CAAC,EACpC,SAAS,EAAE,OAAO,EAClB,eAAe,EAAE,aAAa,EAAE,EAChC,MAAM,EAAE,iBAAiB,CAAC,IAAI,CAAC,GAAG,IAAI,GACpC,WAAW,CAAC,IAAI,CAAC,CAmBnB;AAED,OAAO,EAAE,aAAa,EAAE,CAAA"}
@@ -0,0 +1,4 @@
1
+ export { create } from "./create";
2
+ export type { Client, Config } from "./create";
3
+ export type { ChoiceState, CompletedState, ErroredState, ExtendedTextMultipleState, ExtendedTextSingleState, ExtendedTextState, FatalState, FeedbackState, InteractionState, MatchState, NonSerializable, ObservationState, OrderState, PciInteractionState, PciPendingRenderProps, PciRenderProps, PciSubmittedRenderProps, PrimerState, TextEntryState } from "./types";
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,2CAA2C,CAAA;AAClE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,2CAA2C,CAAA;AAE/E,YAAY,EACX,WAAW,EACX,cAAc,EACd,YAAY,EACZ,yBAAyB,EACzB,uBAAuB,EACvB,iBAAiB,EACjB,UAAU,EACV,aAAa,EACb,gBAAgB,EAChB,UAAU,EACV,eAAe,EACf,gBAAgB,EAChB,UAAU,EACV,mBAAmB,EACnB,qBAAqB,EACrB,cAAc,EACd,uBAAuB,EACvB,WAAW,EACX,cAAc,EACd,MAAM,0CAA0C,CAAA"}