@learncard/types 5.13.4 → 5.14.0

package/dist/types.cjs.development.js

@@ -42,6 +42,8 @@ __export(index_exports, {
   AppStoreListingSubmitterValidator: () => AppStoreListingSubmitterValidator,
   AppStoreListingUpdateValidator: () => AppStoreListingUpdateValidator,
   AppStoreListingValidator: () => AppStoreListingValidator,
+  AssociationTypeValidator: () => AssociationTypeValidator,
+  AssociationValidator: () => AssociationValidator,
   AuthGrantQueryValidator: () => AuthGrantQueryValidator,
   AuthGrantStatusValidator: () => AuthGrantStatusValidator,
   AuthGrantValidator: () => AuthGrantValidator,
@@ -60,6 +62,8 @@ __export(index_exports, {
   ClaimHookValidator: () => ClaimHookValidator,
   ClaimInboxCredentialValidator: () => ClaimInboxCredentialValidator,
   ClaimTokenValidator: () => ClaimTokenValidator,
+  ClrCredentialValidator: () => ClrCredentialValidator,
+  ClrSubjectValidator: () => ClrSubjectValidator,
   ConsentFlowContractDataForDidValidator: () => ConsentFlowContractDataForDidValidator,
   ConsentFlowContractDataValidator: () => ConsentFlowContractDataValidator,
   ConsentFlowContractDetailsValidator: () => ConsentFlowContractDetailsValidator,
@@ -118,17 +122,21 @@ __export(index_exports, {
   FrameworkWithSkillsValidator: () => FrameworkWithSkillsValidator,
   FullClaimHookValidator: () => FullClaimHookValidator,
   GeoCoordinatesValidator: () => GeoCoordinatesValidator,
+  GetCounterEventValidator: () => GetCounterEventValidator,
+  GetCountersEventValidator: () => GetCountersEventValidator,
   GetFullSkillTreeInputValidator: () => GetFullSkillTreeInputValidator,
   GetFullSkillTreeResultValidator: () => GetFullSkillTreeResultValidator,
   GetSkillPathInputValidator: () => GetSkillPathInputValidator,
   GetSkillPathResultValidator: () => GetSkillPathResultValidator,
   GetTemplateRecipientsEventValidator: () => GetTemplateRecipientsEventValidator,
+  GuardianStatusValidator: () => GuardianStatusValidator,
   IdentifierEntryValidator: () => IdentifierEntryValidator,
   IdentifierTypeValidator: () => IdentifierTypeValidator,
   IdentityObjectValidator: () => IdentityObjectValidator,
   ImageValidator: () => ImageValidator,
   InboxCredentialQueryValidator: () => InboxCredentialQueryValidator,
   InboxCredentialValidator: () => InboxCredentialValidator,
+  IncrementCounterEventValidator: () => IncrementCounterEventValidator,
   InstalledAppValidator: () => InstalledAppValidator,
   IssueInboxCredentialResponseValidator: () => IssueInboxCredentialResponseValidator,
   IssueInboxCredentialValidator: () => IssueInboxCredentialValidator,
@@ -203,17 +211,20 @@ __export(index_exports, {
   RelatedValidator: () => RelatedValidator,
   ReplaceSkillFrameworkSkillsInputValidator: () => ReplaceSkillFrameworkSkillsInputValidator,
   ReplaceSkillFrameworkSkillsResultValidator: () => ReplaceSkillFrameworkSkillsResultValidator,
+  RequestLearnerContextEventValidator: () => RequestLearnerContextEventValidator,
   ResultDescriptionValidator: () => ResultDescriptionValidator,
   ResultStatusTypeValidator: () => ResultStatusTypeValidator,
   ResultTypeValidator: () => ResultTypeValidator,
   ResultValidator: () => ResultValidator,
   RubricCriterionValidator: () => RubricCriterionValidator,
+  SendAiSessionCredentialEventValidator: () => SendAiSessionCredentialEventValidator,
   SendBoostInputValidator: () => SendBoostInputValidator,
   SendBoostResponseValidator: () => SendBoostResponseValidator,
   SendBrandingOptionsValidator: () => SendBrandingOptionsValidator,
   SendCredentialEventValidator: () => SendCredentialEventValidator,
   SendInboxResponseValidator: () => SendInboxResponseValidator,
   SendInputValidator: () => SendInputValidator,
+  SendNotificationEventValidator: () => SendNotificationEventValidator,
   SendOptionsValidator: () => SendOptionsValidator,
   SendResponseValidator: () => SendResponseValidator,
   SentCredentialInfoValidator: () => SentCredentialInfoValidator,
@@ -235,10 +246,13 @@ __export(index_exports, {
   SkillTreeNodeValidator: () => SkillTreeNodeValidator,
   SkillValidator: () => SkillValidator,
   StringQuery: () => StringQuery,
+  SummaryCredentialDataValidator: () => SummaryCredentialDataValidator,
+  SummaryCredentialKeywordValidator: () => SummaryCredentialKeywordValidator,
   SyncFrameworkInputValidator: () => SyncFrameworkInputValidator,
   TagValidator: () => TagValidator,
   TermsOfUseValidator: () => TermsOfUseValidator,
   UnsignedAchievementCredentialValidator: () => UnsignedAchievementCredentialValidator,
+  UnsignedClrCredentialValidator: () => UnsignedClrCredentialValidator,
   UnsignedVCValidator: () => UnsignedVCValidator,
   UnsignedVPValidator: () => UnsignedVPValidator,
   UpdateFrameworkInputValidator: () => UpdateFrameworkInputValidator,
@@ -13737,6 +13751,44 @@ var AchievementCredentialValidator = UnsignedAchievementCredentialValidator.exte
   proof: ProofValidator.or(ProofValidator.array())
 });
 
+// src/clr.ts
+var AssociationTypeValidator = external_exports.enum([
+  "exactMatchOf",
+  "extends",
+  "isChildOf",
+  "isParentOf",
+  "isPartOf",
+  "isPeerOf",
+  "isRelatedTo",
+  "precedes",
+  "replacedBy"
+]).or(external_exports.string());
+var AssociationValidator = external_exports.object({
+  type: external_exports.string().array().nonempty(),
+  associationType: AssociationTypeValidator,
+  sourceId: external_exports.string().optional(),
+  targetId: external_exports.string()
+}).catchall(external_exports.any());
+var ClrSubjectValidator = external_exports.object({
+  id: external_exports.string().optional(),
+  type: external_exports.string().array().nonempty(),
+  identifier: external_exports.any().array().optional(),
+  achievement: AchievementValidator.array().optional(),
+  association: AssociationValidator.array().optional(),
+  verifiableCredential: external_exports.any().array().optional()
+}).catchall(external_exports.any());
+var UnsignedClrCredentialValidator = UnsignedVCValidator.extend({
+  name: external_exports.string().optional(),
+  description: external_exports.string().optional(),
+  image: ImageValidator.optional(),
+  credentialSubject: ClrSubjectValidator.or(ClrSubjectValidator.array()),
+  endorsement: EndorsementCredentialValidator.array().optional(),
+  partial: external_exports.boolean().optional()
+});
+var ClrCredentialValidator = UnsignedClrCredentialValidator.extend({
+  proof: ProofValidator.or(ProofValidator.array())
+});
+
 // src/learncard.ts
 var VerificationCheckValidator = external_exports.object({
   checks: external_exports.string().array(),
@@ -14097,10 +14149,16 @@ var SendBrandingOptionsValidator = external_exports.object({
   credentialName: external_exports.string().optional().describe("Display name for the credential"),
   recipientName: external_exports.string().optional().describe("Name of the recipient for personalization")
 });
+var GuardianStatusValidator = external_exports.enum([
+  "AWAITING_GUARDIAN",
+  "GUARDIAN_APPROVED",
+  "GUARDIAN_REJECTED"
+]);
 var SendOptionsValidator = external_exports.object({
   webhookUrl: external_exports.string().url().optional().describe("Webhook URL to receive claim notifications"),
   suppressDelivery: external_exports.boolean().optional().describe("If true, returns claimUrl without sending email/SMS"),
-  branding: SendBrandingOptionsValidator.optional().describe("Branding for email/SMS delivery")
+  branding: SendBrandingOptionsValidator.optional().describe("Branding for email/SMS delivery"),
+  guardianEmail: external_exports.string().email().optional().describe("Guardian email that must approve before student can claim")
 });
 var SendBoostInputValidator = external_exports.object({
   type: external_exports.literal("boost"),
@@ -14117,11 +14175,25 @@ var SendBoostInputValidator = external_exports.object({
 }).refine((data) => data.templateUri || data.template || data.signedCredential, {
   message: "Either templateUri, template, or signedCredential must be provided.",
   path: ["templateUri"]
-});
+}).refine(
+  (data) => {
+    if (data.options?.guardianEmail) {
+      return data.options.guardianEmail.toLowerCase() !== data.recipient.toLowerCase();
+    }
+    return true;
+  },
+  {
+    message: "guardianEmail must differ from recipient (self-approval not allowed)",
+    path: ["options", "guardianEmail"]
+  }
+);
 var SendInboxResponseValidator = external_exports.object({
   issuanceId: external_exports.string(),
   status: external_exports.enum(["PENDING", "ISSUED", "EXPIRED", "DELIVERED", "CLAIMED"]),
-  claimUrl: external_exports.string().url().optional().describe("Present when suppressDelivery=true")
+  claimUrl: external_exports.string().url().optional().describe("Present when suppressDelivery=true"),
+  guardianStatus: GuardianStatusValidator.optional().describe(
+    "Present when guardianEmail was specified"
+  )
 });
 var SendBoostResponseValidator = external_exports.object({
   type: external_exports.literal("boost"),
@@ -14358,7 +14430,11 @@ var LCNNotificationTypeEnumValidator = external_exports.enum([
   "APP_LISTING_APPROVED",
   "APP_LISTING_REJECTED",
   "APP_LISTING_WITHDRAWN",
-  "DEVICE_LINK_REQUEST"
+  "DEVICE_LINK_REQUEST",
+  "GUARDIAN_APPROVAL_PENDING",
+  "GUARDIAN_APPROVED",
+  "GUARDIAN_REJECTED",
+  "APP_NOTIFICATION"
 ]);
 var LCNNotificationMessageValidator = external_exports.object({
   title: external_exports.string().optional(),
@@ -14396,7 +14472,10 @@ var LCNNotificationDataValidator = external_exports.object({
 var LCNNotificationValidator = external_exports.object({
   type: LCNNotificationTypeEnumValidator,
   to: LCNProfileValidator.partial().and(external_exports.object({ did: external_exports.string() })),
-  from: LCNProfileValidator.partial().and(external_exports.object({ did: external_exports.string() })),
+  from: external_exports.union([
+    external_exports.string(),
+    LCNProfileValidator.partial().and(external_exports.object({ did: external_exports.string() }))
+  ]),
   message: LCNNotificationMessageValidator.optional(),
   data: LCNNotificationDataValidator.optional(),
   sent: external_exports.iso.datetime().optional(),
@@ -14501,7 +14580,12 @@ var InboxCredentialValidator = external_exports.object({
   signingAuthority: external_exports.object({
     endpoint: external_exports.string().optional(),
     name: external_exports.string().optional()
-  }).optional()
+  }).optional(),
+  // Guardian gate fields (all optional — absent on pre-existing credentials)
+  guardianEmail: external_exports.string().email().optional(),
+  guardianStatus: GuardianStatusValidator.optional(),
+  guardianApprovedAt: external_exports.string().optional(),
+  guardianApprovedByDid: external_exports.string().optional()
 });
 var PaginatedInboxCredentialsValidator = external_exports.object({
   hasMore: external_exports.boolean(),
@@ -14969,11 +15053,86 @@ var GetTemplateRecipientsEventValidator = external_exports.object({
 }).refine((input) => Boolean(input.templateAlias) !== Boolean(input.boostUri), {
   message: "Exactly one of templateAlias or boostUri is required"
 });
+var RequestLearnerContextEventValidator = external_exports.object({
+  type: external_exports.literal("request-learner-context"),
+  includeCredentials: external_exports.boolean().optional().default(true),
+  includePersonalData: external_exports.boolean().optional().default(false),
+  format: external_exports.enum(["prompt", "structured"]).optional().default("prompt"),
+  instructions: external_exports.string().optional(),
+  detailLevel: external_exports.enum(["compact", "expanded"]).optional().default("compact")
+});
+var SummaryCredentialKeywordValidator = external_exports.object({
+  occupations: external_exports.array(external_exports.string()).nullable(),
+  careers: external_exports.array(external_exports.string()).nullable(),
+  jobs: external_exports.array(external_exports.string()).nullable(),
+  skills: external_exports.array(external_exports.string()).nullable(),
+  fieldOfStudy: external_exports.string().nullable()
+});
+var SummaryCredentialDataValidator = external_exports.object({
+  title: external_exports.string().describe("Short, concise title for the learning session or credential"),
+  summary: external_exports.string().describe("Comprehensive summary of what happened during the session"),
+  learned: external_exports.array(external_exports.string()).describe("Bullet points of key knowledge gained"),
+  skills: external_exports.array(
+    external_exports.object({
+      title: external_exports.string().describe("Name of the skill category"),
+      description: external_exports.string().describe("Detailed description of what this skill category involves")
+    })
+  ).describe("Categorized skills learned during the session"),
+  nextSteps: external_exports.array(
+    external_exports.object({
+      title: external_exports.string().describe("Title of the suggested next step"),
+      description: external_exports.string().describe("Description explaining why this next step is recommended"),
+      keywords: SummaryCredentialKeywordValidator.optional().describe(
+        "Optional taxonomy keywords for occupations/careers/jobs/skills/fieldOfStudy. Omit if not relevant."
+      )
+    })
+  ).describe("Recommended follow-up activities or learning modules"),
+  reflections: external_exports.array(
+    external_exports.object({
+      title: external_exports.string().describe("Title of the reflection"),
+      description: external_exports.string().describe("Detailed description of what this reflection involves")
+    })
+  ).describe("Reflections on the learning experience")
+});
+var SendAiSessionCredentialEventValidator = external_exports.object({
+  type: external_exports.literal("send-ai-session-credential"),
+  sessionTitle: external_exports.string(),
+  summaryData: SummaryCredentialDataValidator,
+  metadata: external_exports.record(external_exports.string(), external_exports.unknown()).optional()
+});
+var SendNotificationEventValidator = external_exports.object({
+  type: external_exports.literal("send-notification"),
+  title: external_exports.string().optional(),
+  body: external_exports.string().optional(),
+  actionPath: external_exports.string().optional(),
+  category: external_exports.string().optional(),
+  priority: external_exports.enum(["normal", "high"]).optional()
+});
+var counterKeyValidator = external_exports.string().min(1).max(64).regex(/^[a-zA-Z0-9_-]+$/, "Key must be alphanumeric with _ or -");
+var IncrementCounterEventValidator = external_exports.object({
+  type: external_exports.literal("increment-counter"),
+  key: counterKeyValidator,
+  amount: external_exports.number().int().finite()
+});
+var GetCounterEventValidator = external_exports.object({
+  type: external_exports.literal("get-counter"),
+  key: counterKeyValidator
+});
+var GetCountersEventValidator = external_exports.object({
+  type: external_exports.literal("get-counters"),
+  keys: external_exports.array(counterKeyValidator).min(1).max(50).optional()
+});
 var AppEventValidator = external_exports.discriminatedUnion("type", [
   SendCredentialEventValidator,
   CheckCredentialEventValidator,
   CheckIssuanceStatusEventValidator,
-  GetTemplateRecipientsEventValidator
+  GetTemplateRecipientsEventValidator,
+  RequestLearnerContextEventValidator,
+  SendAiSessionCredentialEventValidator,
+  SendNotificationEventValidator,
+  IncrementCounterEventValidator,
+  GetCounterEventValidator,
+  GetCountersEventValidator
 ]);
 var AppEventInputValidator = external_exports.object({
   listingId: external_exports.string(),
@@ -15004,7 +15163,7 @@ var CredentialActivityValidator = external_exports.object({
   activityId: external_exports.string(),
   eventType: CredentialActivityEventTypeValidator,
   timestamp: external_exports.string(),
-  actorProfileId: external_exports.string(),
+  actorProfileId: external_exports.string().optional(),
   recipientType: CredentialActivityRecipientTypeValidator,
   recipientIdentifier: external_exports.string(),
   boostUri: external_exports.string().optional(),