@conform-ed/contracts 0.0.13 → 0.0.14

package/src/lti/v1_3/index.ts

@@ -30,29 +30,29 @@ export const CoreLaunchRequestSchema = strictObject({
   name: NonEmptyStringSchema.optional(),
   givenName: NonEmptyStringSchema.optional(),
   familyName: NonEmptyStringSchema.optional(),
-  email: z.string().email().optional(),
+  email: z.email().optional(),
   locale: NonEmptyStringSchema.optional(),
 });
 
 export const CoreLaunchClaimsSchema = CoreLaunchRequestSchema;
 
-export namespace LtiV1_3 {
-  export namespace Schemas {
-    export const ResourceLink = ResourceLinkSchema;
-    export const Context = ContextSchema;
-    export const LaunchPresentation = LaunchPresentationSchema;
-    export const Lis = LisSchema;
-    export const CoreLaunchRequest = CoreLaunchRequestSchema;
-    export const CoreLaunchClaims = CoreLaunchClaimsSchema;
-  }
+export const LtiV1_3 = {
+  Schemas: {
+    ResourceLink: ResourceLinkSchema,
+    Context: ContextSchema,
+    LaunchPresentation: LaunchPresentationSchema,
+    Lis: LisSchema,
+    CoreLaunchRequest: CoreLaunchRequestSchema,
+    CoreLaunchClaims: CoreLaunchClaimsSchema,
+  },
 
-  export namespace Shared {
-    export const Version = LtiVersionSchema;
-    export const Url = UrlSchema;
-    export const NonEmptyString = NonEmptyStringSchema;
-    export const Roles = RolesSchema;
-  }
-}
+  Shared: {
+    Version: LtiVersionSchema,
+    Url: UrlSchema,
+    NonEmptyString: NonEmptyStringSchema,
+    Roles: RolesSchema,
+  },
+} as const;
 
 export type LtiV1_3Schemas = typeof LtiV1_3.Schemas;
 

package/src/oneroster/v1_2/index.ts

@@ -7,51 +7,6 @@ export * from "./or_v1p2_gradebook_restbinding_schema";
 export * from "./or_v1p2_resource_restbinding_schema";
 export * from "./or_v1p2_csv_binding_schema";
 
-import {
-  AcademicSessionSchema,
-  AcademicSessionSetSchema,
-  ClassSchema,
-  ClassSetSchema,
-  CourseSchema,
-  CourseSetSchema,
-  DemographicsSchema,
-  DemographicsSetSchema,
-  EnrollmentSchema,
-  EnrollmentSetSchema,
-  OrgSchema,
-  OrgSetSchema,
-  SingleAcademicSessionSchema,
-  SingleClassSchema,
-  SingleCourseSchema,
-  SingleDemographicsSchema,
-  SingleEnrollmentSchema,
-  SingleOrgSchema,
-  SingleUserSchema,
-  UserSchema,
-  UserSetSchema,
-} from "./or_v1p2_rostering_service_schema";
-import {
-  AssessmentLineItemSchema,
-  AssessmentLineItemSetSchema,
-  AssessmentResultSchema,
-  AssessmentResultSetSchema,
-  CategorySchema,
-  CategorySetSchema,
-  GuidPairSetSchema,
-  LineItemSchema,
-  LineItemSetSchema,
-  ResultSchema,
-  ResultSetSchema,
-  ScoreScaleSchema,
-  ScoreScaleSetSchema,
-  SingleAssessmentLineItemSchema,
-  SingleAssessmentResultSchema,
-  SingleCategorySchema,
-  SingleLineItemSchema,
-  SingleResultSchema,
-  SingleScoreScaleSchema,
-} from "./or_v1p2_gradebook_service_schema";
-import { ResourceSchema, ResourceSetSchema, SingleResourceSchema } from "./or_v1p2_resource_service_schema";
 import {
   AcademicSessionsCsvDocumentSchema,
   CategoriesCsvDocumentSchema,
@@ -78,8 +33,53 @@ import {
   UsersCsvDocumentSchema,
 } from "./or_v1p2_csv_binding_schema";
 import { GradebookRestBindingOperationSchemas } from "./or_v1p2_gradebook_restbinding_schema";
+import {
+  AssessmentLineItemSchema,
+  AssessmentLineItemSetSchema,
+  AssessmentResultSchema,
+  AssessmentResultSetSchema,
+  CategorySchema,
+  CategorySetSchema,
+  GuidPairSetSchema,
+  LineItemSchema,
+  LineItemSetSchema,
+  ResultSchema,
+  ResultSetSchema,
+  ScoreScaleSchema,
+  ScoreScaleSetSchema,
+  SingleAssessmentLineItemSchema,
+  SingleAssessmentResultSchema,
+  SingleCategorySchema,
+  SingleLineItemSchema,
+  SingleResultSchema,
+  SingleScoreScaleSchema,
+} from "./or_v1p2_gradebook_service_schema";
 import { ResourceRestBindingOperationSchemas } from "./or_v1p2_resource_restbinding_schema";
+import { ResourceSchema, ResourceSetSchema, SingleResourceSchema } from "./or_v1p2_resource_service_schema";
 import { RosteringRestBindingOperationSchemas } from "./or_v1p2_rostering_restbinding_schema";
+import {
+  AcademicSessionSchema,
+  AcademicSessionSetSchema,
+  ClassSchema,
+  ClassSetSchema,
+  CourseSchema,
+  CourseSetSchema,
+  DemographicsSchema,
+  DemographicsSetSchema,
+  EnrollmentSchema,
+  EnrollmentSetSchema,
+  OrgSchema,
+  OrgSetSchema,
+  SingleAcademicSessionSchema,
+  SingleClassSchema,
+  SingleCourseSchema,
+  SingleDemographicsSchema,
+  SingleEnrollmentSchema,
+  SingleOrgSchema,
+  SingleUserSchema,
+  UserSchema,
+  UserSetSchema,
+} from "./or_v1p2_rostering_service_schema";
 import { ImsxStatusInfoSchema } from "./shared";
 
 export const OneRoster12DerivedZodTemplates = {

package/src/oneroster/v1_2/or_v1p2_gradebook_restbinding_schema.ts

@@ -19,7 +19,7 @@ import { ImsxStatusInfoSchema } from "./shared";
 
 const EmptyPayloadSchema = z.undefined();
 
-function gradebookGetOperation(path: string, successResponsePayload: z.ZodTypeAny) {
+function gradebookGetOperation(path: string, successResponsePayload: z.ZodType) {
   return {
     method: "GET",
     path,
@@ -29,7 +29,7 @@ function gradebookGetOperation(path: string, successResponsePayload: z.ZodTypeAn
   } as const;
 }
 
-function gradebookPostOperation(path: string, requestPayload: z.ZodTypeAny, successResponsePayload: z.ZodTypeAny) {
+function gradebookPostOperation(path: string, requestPayload: z.ZodType, successResponsePayload: z.ZodType) {
   return {
     method: "POST",
     path,
@@ -39,7 +39,7 @@ function gradebookPostOperation(path: string, requestPayload: z.ZodTypeAny, succ
   } as const;
 }
 
-function gradebookPutOperation(path: string, requestPayload: z.ZodTypeAny) {
+function gradebookPutOperation(path: string, requestPayload: z.ZodType) {
   return {
     method: "PUT",
     path,

package/src/oneroster/v1_2/or_v1p2_resource_restbinding_schema.ts

@@ -5,7 +5,7 @@ import { ImsxStatusInfoSchema } from "./shared";
 
 const EmptyPayloadSchema = z.undefined();
 
-function resourceGetOperation(path: string, successResponsePayload: z.ZodTypeAny) {
+function resourceGetOperation(path: string, successResponsePayload: z.ZodType) {
   return {
     method: "GET",
     path,

package/src/oneroster/v1_2/or_v1p2_rostering_restbinding_schema.ts

@@ -20,7 +20,7 @@ import { ImsxStatusInfoSchema } from "./shared";
 
 const EmptyPayloadSchema = z.undefined();
 
-function rosteringGetOperation(path: string, successResponsePayload: z.ZodTypeAny) {
+function rosteringGetOperation(path: string, successResponsePayload: z.ZodType) {
   return {
     method: "GET",
     path,

package/src/oneroster/v1_2/or_v1p2_rostering_service_schema.ts

@@ -51,7 +51,7 @@ export const CredentialSchema = z
     username: z.string(),
     password: z.string().optional(),
   })
-  .passthrough();
+  .loose();
 
 export const UserIdSchema = strictObject({
   type: z.string(),

package/src/open-badges/v3_0/shared.ts

@@ -27,51 +27,53 @@ const OpenBadgesV30ContextUrlSchema = z
   .string()
   .regex(/^https:\/\/purl\.imsglobal\.org\/spec\/ob\/v3p0\/context(-3\.\d\.\d)*\.json$/u);
 
+// Declared output of a zod schema (z.ZodType<...>): zod's `.optional()` infers `| undefined`, so this must too.
 type Profile = {
   id: UriValue;
   type: unknown;
-  name?: TextValue;
-  url?: UriValue;
-  phone?: TextValue;
-  description?: TextValue;
-  endorsement?: OneOrManyValue<EndorsementCredential>;
-  endorsementJwt?: OneOrManyValue<CompactJwsValue>;
-  image?: Record<string, unknown>;
-  email?: TextValue;
-  address?: Record<string, unknown>;
-  otherIdentifier?: OneOrManyValue<Record<string, unknown>>;
-  official?: TextValue;
-  parentOrg?: Profile;
-  familyName?: TextValue;
-  givenName?: TextValue;
-  additionalName?: TextValue;
-  patronymicName?: TextValue;
-  honorificPrefix?: TextValue;
-  honorificSuffix?: TextValue;
-  familyNamePrefix?: TextValue;
-  dateOfBirth?: string;
+  name?: TextValue | undefined;
+  url?: UriValue | undefined;
+  phone?: TextValue | undefined;
+  description?: TextValue | undefined;
+  endorsement?: OneOrManyValue<EndorsementCredential> | undefined;
+  endorsementJwt?: OneOrManyValue<CompactJwsValue> | undefined;
+  image?: Record<string, unknown> | undefined;
+  email?: TextValue | undefined;
+  address?: Record<string, unknown> | undefined;
+  otherIdentifier?: OneOrManyValue<Record<string, unknown>> | undefined;
+  official?: TextValue | undefined;
+  parentOrg?: Profile | undefined;
+  familyName?: TextValue | undefined;
+  givenName?: TextValue | undefined;
+  additionalName?: TextValue | undefined;
+  patronymicName?: TextValue | undefined;
+  honorificPrefix?: TextValue | undefined;
+  honorificSuffix?: TextValue | undefined;
+  familyNamePrefix?: TextValue | undefined;
+  dateOfBirth?: string | undefined;
   [key: string]: unknown;
 };
 
 type ProfileRef = Profile | UriValue;
 
+// Declared output of a zod schema (z.ZodType<...>): zod's `.optional()` infers `| undefined`, so this must too.
 type EndorsementCredential = {
   "@context": JsonLdContextEntry[];
   type: unknown;
   id: UriValue;
   name: TextValue;
-  description?: TextValue;
+  description?: TextValue | undefined;
   credentialSubject: Record<string, unknown>;
-  awardedDate?: string;
+  awardedDate?: string | undefined;
   issuer: ProfileRef;
   validFrom: string;
-  validUntil?: string;
-  proof?: OneOrManyValue<Record<string, unknown>>;
-  credentialSchema?: OneOrManyValue<Record<string, unknown>>;
-  credentialStatus?: Record<string, unknown>;
-  refreshService?: Record<string, unknown>;
-  termsOfUse?: OneOrManyValue<Record<string, unknown>>;
-  evidence?: OneOrManyValue<Record<string, unknown>>;
+  validUntil?: string | undefined;
+  proof?: OneOrManyValue<Record<string, unknown>> | undefined;
+  credentialSchema?: OneOrManyValue<Record<string, unknown>> | undefined;
+  credentialStatus?: Record<string, unknown> | undefined;
+  refreshService?: Record<string, unknown> | undefined;
+  termsOfUse?: OneOrManyValue<Record<string, unknown>> | undefined;
+  evidence?: OneOrManyValue<Record<string, unknown>> | undefined;
   [key: string]: unknown;
 };
 

package/src/qti/v2-internal.ts

@@ -70,7 +70,7 @@ export function looseObject<T extends z.ZodRawShape>(shape: T) {
 
 export function addIssue(context: z.RefinementCtx, path: Array<string | number>, message: string) {
   context.addIssue({
-    code: z.ZodIssueCode.custom,
+    code: "custom",
     path,
     message,
   });
@@ -110,7 +110,8 @@ function uniqueIdentifiersRefinement(
 function validateDeclaredValues(
   cardinality: z.infer<typeof QtiCardinalitySchema>,
   baseType: z.infer<typeof QtiBaseTypeSchema> | undefined,
-  values: Array<{ fieldIdentifier?: string }>,
+  // Receives zod-parsed values; zod's `.optional()` infers `| undefined`, so this must too.
+  values: Array<{ fieldIdentifier?: string | undefined }>,
   path: Array<string | number>,
   context: z.RefinementCtx,
 ) {
@@ -147,7 +148,7 @@ export function createQti2Schemas(config: Qti2Config) {
     value: z.string(),
   });
 
-  const QtiContentNodeSchema: z.ZodTypeAny = z.lazy(() =>
+  const QtiContentNodeSchema: z.ZodType = z.lazy(() =>
     z.union([
       QtiTextNodeSchema,
       looseObject({
@@ -814,7 +815,7 @@ export function createQti2Schemas(config: Qti2Config) {
   ] as const;
   const manyKinds = ["and", "or", "sum", "product", "multiple", "ordered", "gcd", "lcm", "max", "min"] as const;
 
-  const QtiExpressionSchema: z.ZodTypeAny = z.lazy(() =>
+  const QtiExpressionSchema: z.ZodType = z.lazy(() =>
     z
       .union([
         QtiBaseValueExpressionSchema,
@@ -996,7 +997,7 @@ export function createQti2Schemas(config: Qti2Config) {
     }),
   ]);
 
-  const QtiResponseProcessingRuleSchema: z.ZodTypeAny = z.lazy(() =>
+  const QtiResponseProcessingRuleSchema: z.ZodType = z.lazy(() =>
     z.union([
       QtiSetOutcomeValueSchema,
       QtiLookupOutcomeValueRuleSchema,
@@ -1026,7 +1027,7 @@ export function createQti2Schemas(config: Qti2Config) {
     ]),
   );
 
-  const QtiOutcomeProcessingRuleSchema: z.ZodTypeAny = z.lazy(() =>
+  const QtiOutcomeProcessingRuleSchema: z.ZodType = z.lazy(() =>
     z.union([
       QtiSetOutcomeValueSchema,
       QtiLookupOutcomeValueRuleSchema,
@@ -1056,7 +1057,7 @@ export function createQti2Schemas(config: Qti2Config) {
     ]),
   );
 
-  const QtiTemplateProcessingRuleSchema: z.ZodTypeAny = z.lazy(() =>
+  const QtiTemplateProcessingRuleSchema: z.ZodType = z.lazy(() =>
     z.union([
       QtiSetTemplateValueSchema,
       QtiSetDefaultValueRuleSchema,
@@ -1192,7 +1193,7 @@ export function createQti2Schemas(config: Qti2Config) {
     category: z.array(NonEmptyStringSchema).optional(),
   });
 
-  const QtiAssessmentSectionRawSchema: z.ZodTypeAny = z.lazy(() =>
+  const QtiAssessmentSectionRawSchema: z.ZodType = z.lazy(() =>
     strictObject({
       identifier: QtiIdentifierSchema,
       title: z.string().optional(),
@@ -1220,7 +1221,7 @@ export function createQti2Schemas(config: Qti2Config) {
     }),
   );
 
-  const QtiAssessmentSectionSchema: z.ZodTypeAny = QtiAssessmentSectionRawSchema.superRefine((input, context) => {
+  const QtiAssessmentSectionSchema: z.ZodType = QtiAssessmentSectionRawSchema.superRefine((input, context) => {
     const value = input as { children?: unknown[] };
     const identifierValues = asArray(value.children).flatMap((child) => {
       if (!child || typeof child !== "object" || !("identifier" in child)) {
@@ -1276,7 +1277,7 @@ export function createQti2Schemas(config: Qti2Config) {
     uniqueIdentifiersRefinement(value.templateDeclarations, ["templateDeclarations"], "template declaration", context);
   });
 
-  const QtiAssessmentStimulusSchema: z.ZodTypeAny = config.includeAssessmentStimulus
+  const QtiAssessmentStimulusSchema: z.ZodType = config.includeAssessmentStimulus
     ? strictObject({
         identifier: QtiIdentifierSchema,
         title: z.string().optional(),
@@ -1547,7 +1548,7 @@ export function createQti2Schemas(config: Qti2Config) {
     assessmentSection: QtiAssessmentSectionSchema,
   });
 
-  const QtiAssessmentStimulusDocumentSchema: z.ZodTypeAny = config.includeAssessmentStimulus
+  const QtiAssessmentStimulusDocumentSchema: z.ZodType = config.includeAssessmentStimulus
     ? strictObject({
         assessmentStimulus: QtiAssessmentStimulusSchema,
       })