@conform-ed/contracts 0.0.4 → 0.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@conform-ed/contracts",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "type": "module",
   "module": "src/index.ts",
   "exports": {

package/src/xapi/shared.ts

@@ -72,17 +72,21 @@ export const GroupSchema = strictObject({
   openid: UriSchema.optional(),
   account: AgentAccountSchema.optional(),
   member: z.array(AgentSchema).min(1).optional(),
-}).refine(
-  (value) =>
-    hasDefined(value.mbox) ||
-    hasDefined(value.mbox_sha1sum) ||
-    hasDefined(value.openid) ||
-    hasDefined(value.account) ||
-    hasDefined(value.member),
-  {
-    message: "An xAPI Group requires an identifier or member list",
-  },
-);
+}).superRefine((value, ctx) => {
+  const ifiCount = [value.mbox, value.mbox_sha1sum, value.openid, value.account].filter(hasDefined).length;
+  if (ifiCount > 1) {
+    ctx.addIssue({
+      code: z.ZodIssueCode.custom,
+      message: "An identified xAPI Group MUST have exactly one Inverse Functional Identifier",
+    });
+  }
+  if (ifiCount === 0 && !hasDefined(value.member)) {
+    ctx.addIssue({
+      code: z.ZodIssueCode.custom,
+      message: "An anonymous xAPI Group requires a member list",
+    });
+  }
+});
 
 export const PersonSchema = strictObject({
   objectType: z.literal("Person"),
@@ -132,6 +136,8 @@ export const InteractionComponentSchema = strictObject({
   description: LanguageMapSchema.optional(),
 });
 
+const interactionSubProperties = ["correctResponsesPattern", "choices", "scale", "source", "target", "steps"] as const;
+
 export const ActivityDefinitionSchema = strictObject({
   name: LanguageMapSchema.optional(),
   description: LanguageMapSchema.optional(),
@@ -145,6 +151,17 @@ export const ActivityDefinitionSchema = strictObject({
   target: z.array(InteractionComponentSchema).min(1).optional(),
   steps: z.array(InteractionComponentSchema).min(1).optional(),
   extensions: ExtensionsSchema.optional(),
+}).superRefine((value, ctx) => {
+  if (value.interactionType !== undefined) return;
+  for (const prop of interactionSubProperties) {
+    if (value[prop] !== undefined) {
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        message: `Activity definition property '${prop}' requires interactionType to be set`,
+        path: [prop],
+      });
+    }
+  }
 });
 
 export const ActivitySchema = strictObject({
@@ -163,6 +180,29 @@ export const ScoreSchema = strictObject({
   raw: z.number().optional(),
   min: z.number().optional(),
   max: z.number().optional(),
+}).superRefine((value, ctx) => {
+  const { min, max, raw } = value;
+  if (min !== undefined && max !== undefined && min >= max) {
+    ctx.addIssue({
+      code: z.ZodIssueCode.custom,
+      message: "Score max must be greater than min",
+      path: ["max"],
+    });
+  }
+  if (raw !== undefined && min !== undefined && raw < min) {
+    ctx.addIssue({
+      code: z.ZodIssueCode.custom,
+      message: "Score raw must be greater than or equal to min",
+      path: ["raw"],
+    });
+  }
+  if (raw !== undefined && max !== undefined && raw > max) {
+    ctx.addIssue({
+      code: z.ZodIssueCode.custom,
+      message: "Score raw must be less than or equal to max",
+      path: ["raw"],
+    });
+  }
 });
 
 export const ResultSchema = strictObject({
@@ -285,11 +325,16 @@ export const ActivityProfileDocumentListingQuerySchema = strictObject({
 
 export const XapiDocumentIdListSchema = z.array(NonEmptyStringSchema);
 
+// When Agent or Group is used as a Statement Object, objectType is required per spec.
+// "When Agent is used as a Statement Object, the objectType property MUST be included."
+export const AgentAsObjectSchema = AgentSchema.and(z.object({ objectType: z.literal("Agent") }));
+export const GroupAsObjectSchema = GroupSchema.and(z.object({ objectType: z.literal("Group") }));
+
 export const SubStatementSchema = strictObject({
   objectType: z.literal("SubStatement"),
   actor: z.union([AgentSchema, GroupSchema]),
   verb: VerbSchema,
-  object: z.union([ActivitySchema, AgentSchema, GroupSchema, StatementRefSchema]),
+  object: z.union([ActivitySchema, AgentAsObjectSchema, GroupAsObjectSchema, StatementRefSchema]),
   result: ResultSchema.optional(),
   context: ContextSchema.optional(),
   timestamp: Iso8601TimestampSchema.optional(),
@@ -297,8 +342,8 @@ export const SubStatementSchema = strictObject({
 
 export const StatementObjectSchema = z.union([
   ActivitySchema,
-  AgentSchema,
-  GroupSchema,
+  AgentAsObjectSchema,
+  GroupAsObjectSchema,
   StatementRefSchema,
   SubStatementSchema,
 ]);

package/src/xapi/v2_0/index.ts

@@ -47,6 +47,8 @@ import {
   XapiResourceSchema,
   XapiResponseHeaderSchema,
   XapiVersionSchema,
+  AgentAsObjectSchema,
+  GroupAsObjectSchema,
 } from "../shared";
 
 export const ContextAgentSchema = strictObject({
@@ -70,7 +72,7 @@ export const SubStatementV2Schema = strictObject({
   objectType: z.literal("SubStatement"),
   actor: z.union([AgentSchema, GroupSchema]),
   verb: VerbSchema,
-  object: z.union([ActivitySchema, AgentSchema, GroupSchema, StatementRefSchema]),
+  object: z.union([ActivitySchema, AgentAsObjectSchema, GroupAsObjectSchema, StatementRefSchema]),
   result: ResultSchema.optional(),
   context: ContextV2Schema.optional(),
   timestamp: Iso8601TimestampSchema.optional(),
@@ -78,8 +80,8 @@ export const SubStatementV2Schema = strictObject({
 
 export const StatementObjectV2Schema = z.union([
   ActivitySchema,
-  AgentSchema,
-  GroupSchema,
+  AgentAsObjectSchema,
+  GroupAsObjectSchema,
   StatementRefSchema,
   SubStatementV2Schema,
 ]);