@learncard/types 5.8.11 → 5.9.0

package/dist/types.esm.js

@@ -452,6 +452,7 @@ var PaginatedEncryptedCredentialRecordsValidator = PaginationResponseValidator.e
 });
 
 // src/lcn.ts
+import { extendZodWithOpenApi } from "zod-openapi";
 import { z as z9 } from "zod";
 
 // src/queries.ts
@@ -484,9 +485,16 @@ var RegExpValidator = z8.instanceof(RegExp).or(
     }
   })
 );
-var StringQuery = z8.string().or(z8.object({ $in: z8.string().array() })).or(z8.object({ $regex: RegExpValidator }));
+var BaseStringQuery = z8.string().or(z8.object({ $in: z8.string().array() })).or(z8.object({ $regex: RegExpValidator }));
+var StringQuery = z8.union([
+  BaseStringQuery,
+  z8.object({
+    $or: BaseStringQuery.array()
+  })
+]);
 
 // src/lcn.ts
+extendZodWithOpenApi(z9);
 var LCNProfileDisplayValidator = z9.object({
   backgroundColor: z9.string().optional(),
   backgroundImage: z9.string().optional(),
@@ -644,7 +652,7 @@ var BoostValidator = z9.object({
   claimPermissions: BoostPermissionsValidator.optional(),
   allowAnyoneToCreateChildren: z9.boolean().optional()
 });
-var BoostQueryValidator = z9.object({
+var BaseBoostQueryValidator = z9.object({
   uri: StringQuery,
   name: StringQuery,
   type: StringQuery,
@@ -653,6 +661,12 @@ var BoostQueryValidator = z9.object({
   status: LCNBoostStatus.or(z9.object({ $in: LCNBoostStatus.array() })),
   autoConnectRecipients: z9.boolean()
 }).partial();
+var BoostQueryValidator = z9.union([
+  z9.object({
+    $or: BaseBoostQueryValidator.array()
+  }),
+  BaseBoostQueryValidator
+]);
 var PaginatedBoostsValidator = PaginationResponseValidator.extend({
   records: BoostValidator.array()
 });
@@ -708,11 +722,25 @@ var ConsentFlowTermsStatusValidator = z9.enum(["live", "stale", "withdrawn"]);
 var ConsentFlowContractValidator = z9.object({
   read: z9.object({
     anonymize: z9.boolean().optional(),
-    credentials: z9.object({ categories: z9.record(z9.object({ required: z9.boolean(), defaultEnabled: z9.boolean().optional() })).default({}) }).default({}),
+    credentials: z9.object({
+      categories: z9.record(
+        z9.object({
+          required: z9.boolean(),
+          defaultEnabled: z9.boolean().optional()
+        })
+      ).default({})
+    }).default({}),
     personal: z9.record(z9.object({ required: z9.boolean(), defaultEnabled: z9.boolean().optional() })).default({})
   }).default({}),
   write: z9.object({
-    credentials: z9.object({ categories: z9.record(z9.object({ required: z9.boolean(), defaultEnabled: z9.boolean().optional() })).default({}) }).default({}),
+    credentials: z9.object({
+      categories: z9.record(
+        z9.object({
+          required: z9.boolean(),
+          defaultEnabled: z9.boolean().optional()
+        })
+      ).default({})
+    }).default({}),
     personal: z9.record(z9.object({ required: z9.boolean(), defaultEnabled: z9.boolean().optional() })).default({})
   }).default({})
 });
@@ -855,6 +883,17 @@ var ConsentFlowTransactionValidator = z9.object({
 var PaginatedConsentFlowTransactionsValidator = PaginationResponseValidator.extend({
   records: ConsentFlowTransactionValidator.array()
 });
+var BaseSkillFrameworkQueryValidator = z9.object({
+  id: StringQuery,
+  name: StringQuery,
+  description: StringQuery,
+  sourceURI: StringQuery,
+  status: StringQuery
+}).partial();
+var SkillFrameworkQueryValidator = z9.union([
+  z9.object({ $or: BaseSkillFrameworkQueryValidator.array() }),
+  BaseSkillFrameworkQueryValidator
+]);
 var ContractCredentialValidator = z9.object({
   credentialUri: z9.string(),
   termsUri: z9.string(),
@@ -1038,37 +1077,61 @@ var IssueInboxCredentialValidator = z9.object({
   // === CORE DATA (Required) ===
   // WHAT is being sent and WHO is it for?
   recipient: ContactMethodQueryValidator.describe("The recipient of the credential"),
-  credential: VCValidator.passthrough().or(VPValidator.passthrough()).or(UnsignedVCValidator.passthrough()).describe("The credential to issue. If not signed, the users default signing authority will be used, or the specified signing authority in the configuration."),
+  credential: VCValidator.passthrough().or(VPValidator.passthrough()).or(UnsignedVCValidator.passthrough()).describe(
+    "The credential to issue. If not signed, the users default signing authority will be used, or the specified signing authority in the configuration."
+  ),
   // === OPTIONAL FEATURES ===
   // Add major, distinct features at the top level.
   //consentRequest: ConsentRequestValidator.optional(),
   // === PROCESS CONFIGURATION (Optional) ===
   // HOW should this issuance be handled?
   configuration: z9.object({
-    signingAuthority: IssueInboxSigningAuthorityValidator.optional().describe("The signing authority to use for the credential. If not provided, the users default signing authority will be used if the credential is not signed."),
+    signingAuthority: IssueInboxSigningAuthorityValidator.optional().describe(
+      "The signing authority to use for the credential. If not provided, the users default signing authority will be used if the credential is not signed."
+    ),
     webhookUrl: z9.string().url().optional().describe("The webhook URL to receive credential issuance events."),
     expiresInDays: z9.number().min(1).max(365).optional().describe("The number of days the credential will be valid for."),
     // --- For User-Facing Delivery (Email/SMS) ---
     delivery: z9.object({
-      suppress: z9.boolean().optional().default(false).describe("Whether to suppress delivery of the credential to the recipient. If true, the email/sms will not be sent to the recipient. Useful if you would like to manually send claim link to your users."),
+      suppress: z9.boolean().optional().default(false).describe(
+        "Whether to suppress delivery of the credential to the recipient. If true, the email/sms will not be sent to the recipient. Useful if you would like to manually send claim link to your users."
+      ),
       template: z9.object({
-        id: z9.enum(["universal-inbox-claim"]).optional().describe("The template ID to use for the credential delivery. If not provided, the default template will be used."),
+        id: z9.enum(["universal-inbox-claim"]).optional().describe(
+          "The template ID to use for the credential delivery. If not provided, the default template will be used."
+        ),
         model: z9.object({
           issuer: z9.object({
-            name: z9.string().optional().describe('The name of the organization (e.g., "State University").'),
+            name: z9.string().optional().describe(
+              'The name of the organization (e.g., "State University").'
+            ),
             logoUrl: z9.string().url().optional().describe("The URL of the organization's logo.")
           }).optional(),
           credential: z9.object({
-            name: z9.string().optional().describe('The name of the credential (e.g., "Bachelor of Science").'),
-            type: z9.string().optional().describe('The type of the credential (e.g., "degree", "certificate").')
+            name: z9.string().optional().describe(
+              'The name of the credential (e.g., "Bachelor of Science").'
+            ),
+            type: z9.string().optional().describe(
+              'The type of the credential (e.g., "degree", "certificate").'
+            )
           }).optional(),
           recipient: z9.object({
-            name: z9.string().optional().describe('The name of the recipient (e.g., "John Doe").')
+            name: z9.string().optional().describe(
+              'The name of the recipient (e.g., "John Doe").'
+            )
           }).optional()
-        }).describe("The template model to use for the credential delivery. Injects via template variables into email/sms templates. If not provided, the default template will be used.")
-      }).optional().describe("The template to use for the credential delivery. If not provided, the default template will be used.")
-    }).optional().describe("Configuration for the credential delivery i.e. email or SMS. When credentials are sent to a user who has a verified email or phone associated with their account, delivery is skipped, and the credential will be sent using in-app notifications. If not provided, the default configuration will be used.")
-  }).optional().describe("Configuration for the credential issuance. If not provided, the default configuration will be used.")
+        }).describe(
+          "The template model to use for the credential delivery. Injects via template variables into email/sms templates. If not provided, the default template will be used."
+        )
+      }).optional().describe(
+        "The template to use for the credential delivery. If not provided, the default template will be used."
+      )
+    }).optional().describe(
+      "Configuration for the credential delivery i.e. email or SMS. When credentials are sent to a user who has a verified email or phone associated with their account, delivery is skipped, and the credential will be sent using in-app notifications. If not provided, the default configuration will be used."
+    )
+  }).optional().describe(
+    "Configuration for the credential issuance. If not provided, the default configuration will be used."
+  )
 });
 var IssueInboxCredentialResponseValidator = z9.object({
   issuanceId: z9.string(),
@@ -1130,6 +1193,191 @@ var ClaimTokenValidator = z9.object({
   expiresAt: z9.string(),
   used: z9.boolean()
 });
+var TagValidator = z9.object({
+  id: z9.string(),
+  name: z9.string().min(1),
+  slug: z9.string().min(1),
+  createdAt: z9.string().optional(),
+  updatedAt: z9.string().optional()
+});
+var SkillStatusEnum = z9.enum(["active", "archived"]);
+var SkillValidator = z9.object({
+  id: z9.string(),
+  statement: z9.string(),
+  description: z9.string().optional(),
+  code: z9.string().optional(),
+  icon: z9.string().optional(),
+  type: z9.string().default("skill"),
+  status: SkillStatusEnum.default("active"),
+  frameworkId: z9.string().optional(),
+  createdAt: z9.string().optional(),
+  updatedAt: z9.string().optional()
+});
+var BaseSkillQueryValidator = z9.object({
+  id: StringQuery,
+  statement: StringQuery,
+  description: StringQuery,
+  code: StringQuery,
+  type: StringQuery,
+  status: SkillStatusEnum.or(z9.object({ $in: SkillStatusEnum.array() }))
+}).partial();
+var SkillQueryValidator = z9.union([
+  z9.object({
+    $or: BaseSkillQueryValidator.array()
+  }),
+  BaseSkillQueryValidator
+]);
+var SkillFrameworkStatusEnum = z9.enum(["active", "archived"]);
+var SkillFrameworkValidator = z9.object({
+  id: z9.string(),
+  name: z9.string(),
+  description: z9.string().optional(),
+  image: z9.string().optional(),
+  sourceURI: z9.string().url().optional(),
+  status: SkillFrameworkStatusEnum.default("active"),
+  createdAt: z9.string().optional(),
+  updatedAt: z9.string().optional()
+});
+var PaginatedSkillFrameworksValidator = PaginationResponseValidator.extend({
+  records: SkillFrameworkValidator.array()
+});
+var SkillTreeNodeValidator = SkillValidator.extend({
+  children: z9.array(z9.lazy(() => SkillTreeNodeValidator)),
+  hasChildren: z9.boolean(),
+  childrenCursor: z9.string().nullable().optional()
+}).openapi({ ref: "SkillTreeNode" });
+var PaginatedSkillTreeValidator = z9.object({
+  hasMore: z9.boolean(),
+  cursor: z9.string().nullable(),
+  records: z9.array(SkillTreeNodeValidator)
+});
+var SkillTreeNodeInputValidator = z9.lazy(
+  () => z9.object({
+    id: z9.string().optional(),
+    statement: z9.string(),
+    description: z9.string().optional(),
+    code: z9.string().optional(),
+    icon: z9.string().optional(),
+    type: z9.string().optional(),
+    status: SkillStatusEnum.optional(),
+    children: z9.array(SkillTreeNodeInputValidator).optional()
+  })
+).openapi({ ref: "SkillTreeNodeInput" });
+var LinkProviderFrameworkInputValidator = z9.object({
+  frameworkId: z9.string()
+});
+var CreateManagedFrameworkInputValidator = z9.object({
+  id: z9.string().optional(),
+  name: z9.string().min(1),
+  description: z9.string().optional(),
+  image: z9.string().optional(),
+  sourceURI: z9.string().url().optional(),
+  status: SkillFrameworkStatusEnum.optional(),
+  skills: z9.array(SkillTreeNodeInputValidator).optional(),
+  boostUris: z9.array(z9.string()).optional()
+});
+var UpdateFrameworkInputValidator = z9.object({
+  id: z9.string(),
+  name: z9.string().min(1).optional(),
+  description: z9.string().optional(),
+  image: z9.string().optional(),
+  sourceURI: z9.string().url().optional(),
+  status: SkillFrameworkStatusEnum.optional()
+}).refine(
+  (data) => data.name !== void 0 || data.description !== void 0 || data.image !== void 0 || data.sourceURI !== void 0 || data.status !== void 0,
+  {
+    message: "At least one field must be provided to update",
+    path: ["name"]
+  }
+);
+var DeleteFrameworkInputValidator = z9.object({ id: z9.string() });
+var CreateManagedFrameworkBatchInputValidator = z9.object({
+  frameworks: z9.array(
+    CreateManagedFrameworkInputValidator.extend({
+      skills: z9.array(SkillTreeNodeInputValidator).optional()
+    })
+  ).min(1)
+});
+var SkillFrameworkAdminInputValidator = z9.object({
+  frameworkId: z9.string(),
+  profileId: z9.string()
+});
+var SkillFrameworkIdInputValidator = z9.object({ frameworkId: z9.string() });
+var SkillFrameworkAdminsValidator = LCNProfileValidator.array();
+var SyncFrameworkInputValidator = z9.object({ id: z9.string() });
+var AddTagInputValidator = z9.object({
+  slug: z9.string().min(1),
+  name: z9.string().min(1)
+});
+var CreateSkillInputValidator = z9.object({
+  frameworkId: z9.string(),
+  skill: SkillTreeNodeInputValidator,
+  parentId: z9.string().nullable().optional()
+});
+var UpdateSkillInputValidator = z9.object({
+  frameworkId: z9.string(),
+  id: z9.string(),
+  statement: z9.string().optional(),
+  description: z9.string().optional(),
+  code: z9.string().optional(),
+  icon: z9.string().optional(),
+  type: z9.string().optional(),
+  status: SkillStatusEnum.optional()
+}).refine(
+  (data) => data.statement !== void 0 || data.description !== void 0 || data.code !== void 0 || data.icon !== void 0 || data.type !== void 0 || data.status !== void 0,
+  {
+    message: "At least one field must be provided to update a skill",
+    path: ["statement"]
+  }
+);
+var SkillDeletionStrategyValidator = z9.enum(["recursive", "reparent"]);
+var DeleteSkillInputValidator = z9.object({
+  frameworkId: z9.string(),
+  id: z9.string(),
+  strategy: SkillDeletionStrategyValidator.optional().default("reparent")
+});
+var CreateSkillsBatchInputValidator = z9.object({
+  frameworkId: z9.string(),
+  skills: z9.array(SkillTreeNodeInputValidator).min(1),
+  parentId: z9.string().nullable().optional()
+});
+var ReplaceSkillFrameworkSkillsInputValidator = z9.object({
+  frameworkId: z9.string(),
+  skills: z9.array(SkillTreeNodeInputValidator).min(0)
+});
+var ReplaceSkillFrameworkSkillsResultValidator = z9.object({
+  created: z9.number().int().min(0),
+  updated: z9.number().int().min(0),
+  deleted: z9.number().int().min(0),
+  unchanged: z9.number().int().min(0),
+  total: z9.number().int().min(0)
+});
+var CountSkillsInputValidator = z9.object({
+  frameworkId: z9.string(),
+  skillId: z9.string().optional(),
+  recursive: z9.boolean().optional().default(false),
+  onlyCountCompetencies: z9.boolean().optional().default(false)
+});
+var CountSkillsResultValidator = z9.object({
+  count: z9.number().int().min(0)
+});
+var GetFullSkillTreeInputValidator = z9.object({
+  frameworkId: z9.string()
+});
+var GetFullSkillTreeResultValidator = z9.object({
+  skills: z9.array(SkillTreeNodeValidator)
+});
+var GetSkillPathInputValidator = z9.object({
+  frameworkId: z9.string(),
+  skillId: z9.string()
+});
+var GetSkillPathResultValidator = z9.object({
+  path: z9.array(SkillValidator)
+});
+var FrameworkWithSkillsValidator = z9.object({
+  framework: SkillFrameworkValidator,
+  skills: PaginatedSkillTreeValidator
+});
 export {
   AUTH_GRANT_AUDIENCE_DOMAIN_PREFIX,
   AchievementCredentialValidator,
@@ -1137,6 +1385,7 @@ export {
   AchievementSubjectValidator,
   AchievementTypeValidator,
   AchievementValidator,
+  AddTagInputValidator,
   AddressValidator,
   AlignmentTargetTypeValidator,
   AlignmentValidator,
@@ -1176,14 +1425,22 @@ export {
   ContactMethodVerificationValidator,
   ContextValidator,
   ContractCredentialValidator,
+  CountSkillsInputValidator,
+  CountSkillsResultValidator,
   CreateContactMethodSessionResponseValidator,
   CreateContactMethodSessionValidator,
+  CreateManagedFrameworkBatchInputValidator,
+  CreateManagedFrameworkInputValidator,
+  CreateSkillInputValidator,
+  CreateSkillsBatchInputValidator,
   CredentialInfoValidator,
   CredentialRecordValidator,
   CredentialSchemaValidator,
   CredentialStatusValidator,
   CredentialSubjectValidator,
   CriteriaValidator,
+  DeleteFrameworkInputValidator,
+  DeleteSkillInputValidator,
   DidDocumentValidator,
   EncryptedCredentialRecordValidator,
   EncryptedRecordValidator,
@@ -1191,8 +1448,13 @@ export {
   EndorsementSubjectValidator,
   EvidenceValidator,
   FlatAuthGrantValidator,
+  FrameworkWithSkillsValidator,
   FullClaimHookValidator,
   GeoCoordinatesValidator,
+  GetFullSkillTreeInputValidator,
+  GetFullSkillTreeResultValidator,
+  GetSkillPathInputValidator,
+  GetSkillPathResultValidator,
   IdentifierEntryValidator,
   IdentifierTypeValidator,
   IdentityObjectValidator,
@@ -1231,6 +1493,7 @@ export {
   LCNProfileValidator,
   LCNSigningAuthorityForUserValidator,
   LCNSigningAuthorityValidator,
+  LinkProviderFrameworkInputValidator,
   PaginatedBoostRecipientsValidator,
   PaginatedBoostRecipientsWithChildrenValidator,
   PaginatedBoostsValidator,
@@ -1248,6 +1511,8 @@ export {
   PaginatedLCNProfileManagersValidator,
   PaginatedLCNProfilesAndManagersValidator,
   PaginatedLCNProfilesValidator,
+  PaginatedSkillFrameworksValidator,
+  PaginatedSkillTreeValidator,
   PaginationOptionsValidator,
   PaginationResponseValidator,
   ProfileValidator,
@@ -1255,6 +1520,8 @@ export {
   RefreshServiceValidator,
   RegExpValidator,
   RelatedValidator,
+  ReplaceSkillFrameworkSkillsInputValidator,
+  ReplaceSkillFrameworkSkillsResultValidator,
   ResultDescriptionValidator,
   ResultStatusTypeValidator,
   ResultTypeValidator,
@@ -1263,11 +1530,27 @@ export {
   SentCredentialInfoValidator,
   ServiceValidator,
   SetPrimaryContactMethodValidator,
+  SkillDeletionStrategyValidator,
+  SkillFrameworkAdminInputValidator,
+  SkillFrameworkAdminsValidator,
+  SkillFrameworkIdInputValidator,
+  SkillFrameworkQueryValidator,
+  SkillFrameworkStatusEnum,
+  SkillFrameworkValidator,
+  SkillQueryValidator,
+  SkillStatusEnum,
+  SkillTreeNodeInputValidator,
+  SkillTreeNodeValidator,
+  SkillValidator,
   StringQuery,
+  SyncFrameworkInputValidator,
+  TagValidator,
   TermsOfUseValidator,
   UnsignedAchievementCredentialValidator,
   UnsignedVCValidator,
   UnsignedVPValidator,
+  UpdateFrameworkInputValidator,
+  UpdateSkillInputValidator,
   VC2EvidenceValidator,
   VCValidator,
   VPValidator,