@learncard/helpers 1.1.29 → 1.1.31

package/dist/helpers.d.ts

@@ -4280,5 +4280,7 @@ export declare const RegExpTransformer: DataTransformer;
  * Determines if a credential uses VC 2.0 format by checking the @context array
  */
 export declare const isVC2Format: (credential: UnsignedVC | VC) => boolean;
+/** Unwraps a boost credential from a CertifiedBoostCredential, if it is one */
+export declare const unwrapBoostCredential: (vc?: VC | UnsignedVC) => any;
 
 export {};

package/dist/helpers.esm.js

@@ -51,6 +51,7 @@ var require_types_cjs_development = __commonJS({
       AchievementSubjectValidator: () => AchievementSubjectValidator,
       AchievementTypeValidator: () => AchievementTypeValidator,
       AchievementValidator: () => AchievementValidator,
+      AddTagInputValidator: () => AddTagInputValidator,
       AddressValidator: () => AddressValidator,
       AlignmentTargetTypeValidator: () => AlignmentTargetTypeValidator,
       AlignmentValidator: () => AlignmentValidator,
@@ -90,14 +91,22 @@ var require_types_cjs_development = __commonJS({
       ContactMethodVerificationValidator: () => ContactMethodVerificationValidator,
       ContextValidator: () => ContextValidator,
       ContractCredentialValidator: () => ContractCredentialValidator,
+      CountSkillsInputValidator: () => CountSkillsInputValidator,
+      CountSkillsResultValidator: () => CountSkillsResultValidator,
       CreateContactMethodSessionResponseValidator: () => CreateContactMethodSessionResponseValidator,
       CreateContactMethodSessionValidator: () => CreateContactMethodSessionValidator,
+      CreateManagedFrameworkBatchInputValidator: () => CreateManagedFrameworkBatchInputValidator,
+      CreateManagedFrameworkInputValidator: () => CreateManagedFrameworkInputValidator,
+      CreateSkillInputValidator: () => CreateSkillInputValidator,
+      CreateSkillsBatchInputValidator: () => CreateSkillsBatchInputValidator,
       CredentialInfoValidator: () => CredentialInfoValidator,
       CredentialRecordValidator: () => CredentialRecordValidator,
       CredentialSchemaValidator: () => CredentialSchemaValidator,
       CredentialStatusValidator: () => CredentialStatusValidator,
       CredentialSubjectValidator: () => CredentialSubjectValidator,
       CriteriaValidator: () => CriteriaValidator,
+      DeleteFrameworkInputValidator: () => DeleteFrameworkInputValidator,
+      DeleteSkillInputValidator: () => DeleteSkillInputValidator,
       DidDocumentValidator: () => DidDocumentValidator,
       EncryptedCredentialRecordValidator: () => EncryptedCredentialRecordValidator,
       EncryptedRecordValidator: () => EncryptedRecordValidator,
@@ -105,8 +114,13 @@ var require_types_cjs_development = __commonJS({
       EndorsementSubjectValidator: () => EndorsementSubjectValidator,
       EvidenceValidator: () => EvidenceValidator,
       FlatAuthGrantValidator: () => FlatAuthGrantValidator,
+      FrameworkWithSkillsValidator: () => FrameworkWithSkillsValidator,
       FullClaimHookValidator: () => FullClaimHookValidator,
       GeoCoordinatesValidator: () => GeoCoordinatesValidator,
+      GetFullSkillTreeInputValidator: () => GetFullSkillTreeInputValidator,
+      GetFullSkillTreeResultValidator: () => GetFullSkillTreeResultValidator,
+      GetSkillPathInputValidator: () => GetSkillPathInputValidator,
+      GetSkillPathResultValidator: () => GetSkillPathResultValidator,
       IdentifierEntryValidator: () => IdentifierEntryValidator,
       IdentifierTypeValidator: () => IdentifierTypeValidator,
       IdentityObjectValidator: () => IdentityObjectValidator,
@@ -145,6 +159,7 @@ var require_types_cjs_development = __commonJS({
       LCNProfileValidator: () => LCNProfileValidator,
       LCNSigningAuthorityForUserValidator: () => LCNSigningAuthorityForUserValidator,
       LCNSigningAuthorityValidator: () => LCNSigningAuthorityValidator,
+      LinkProviderFrameworkInputValidator: () => LinkProviderFrameworkInputValidator,
       PaginatedBoostRecipientsValidator: () => PaginatedBoostRecipientsValidator,
       PaginatedBoostRecipientsWithChildrenValidator: () => PaginatedBoostRecipientsWithChildrenValidator,
       PaginatedBoostsValidator: () => PaginatedBoostsValidator,
@@ -162,6 +177,8 @@ var require_types_cjs_development = __commonJS({
       PaginatedLCNProfileManagersValidator: () => PaginatedLCNProfileManagersValidator,
       PaginatedLCNProfilesAndManagersValidator: () => PaginatedLCNProfilesAndManagersValidator,
       PaginatedLCNProfilesValidator: () => PaginatedLCNProfilesValidator,
+      PaginatedSkillFrameworksValidator: () => PaginatedSkillFrameworksValidator,
+      PaginatedSkillTreeValidator: () => PaginatedSkillTreeValidator,
       PaginationOptionsValidator: () => PaginationOptionsValidator,
       PaginationResponseValidator: () => PaginationResponseValidator,
       ProfileValidator: () => ProfileValidator,
@@ -169,6 +186,8 @@ var require_types_cjs_development = __commonJS({
       RefreshServiceValidator: () => RefreshServiceValidator,
       RegExpValidator: () => RegExpValidator,
       RelatedValidator: () => RelatedValidator,
+      ReplaceSkillFrameworkSkillsInputValidator: () => ReplaceSkillFrameworkSkillsInputValidator,
+      ReplaceSkillFrameworkSkillsResultValidator: () => ReplaceSkillFrameworkSkillsResultValidator,
       ResultDescriptionValidator: () => ResultDescriptionValidator,
       ResultStatusTypeValidator: () => ResultStatusTypeValidator,
       ResultTypeValidator: () => ResultTypeValidator,
@@ -177,11 +196,27 @@ var require_types_cjs_development = __commonJS({
       SentCredentialInfoValidator: () => SentCredentialInfoValidator,
       ServiceValidator: () => ServiceValidator,
       SetPrimaryContactMethodValidator: () => SetPrimaryContactMethodValidator,
+      SkillDeletionStrategyValidator: () => SkillDeletionStrategyValidator,
+      SkillFrameworkAdminInputValidator: () => SkillFrameworkAdminInputValidator,
+      SkillFrameworkAdminsValidator: () => SkillFrameworkAdminsValidator,
+      SkillFrameworkIdInputValidator: () => SkillFrameworkIdInputValidator,
+      SkillFrameworkQueryValidator: () => SkillFrameworkQueryValidator,
+      SkillFrameworkStatusEnum: () => SkillFrameworkStatusEnum,
+      SkillFrameworkValidator: () => SkillFrameworkValidator,
+      SkillQueryValidator: () => SkillQueryValidator,
+      SkillStatusEnum: () => SkillStatusEnum,
+      SkillTreeNodeInputValidator: () => SkillTreeNodeInputValidator,
+      SkillTreeNodeValidator: () => SkillTreeNodeValidator,
+      SkillValidator: () => SkillValidator,
       StringQuery: () => StringQuery,
+      SyncFrameworkInputValidator: () => SyncFrameworkInputValidator,
+      TagValidator: () => TagValidator,
       TermsOfUseValidator: () => TermsOfUseValidator,
       UnsignedAchievementCredentialValidator: () => UnsignedAchievementCredentialValidator,
       UnsignedVCValidator: () => UnsignedVCValidator,
       UnsignedVPValidator: () => UnsignedVPValidator,
+      UpdateFrameworkInputValidator: () => UpdateFrameworkInputValidator,
+      UpdateSkillInputValidator: () => UpdateSkillInputValidator,
       VC2EvidenceValidator: () => VC2EvidenceValidator,
       VCValidator: () => VCValidator,
       VPValidator: () => VPValidator,
@@ -4641,7 +4676,14 @@ var require_types_cjs_development = __commonJS({
         }
       })
     );
-    var StringQuery = z.string().or(z.object({ $in: z.string().array() })).or(z.object({ $regex: RegExpValidator }));
+    var BaseStringQuery = z.string().or(z.object({ $in: z.string().array() })).or(z.object({ $regex: RegExpValidator }));
+    var StringQuery = z.union([
+      BaseStringQuery,
+      z.object({
+        $or: BaseStringQuery.array()
+      })
+    ]);
+    extendZodWithOpenApi(z);
     var LCNProfileDisplayValidator = z.object({
       backgroundColor: z.string().optional(),
       backgroundImage: z.string().optional(),
@@ -4726,7 +4768,8 @@ var require_types_cjs_development = __commonJS({
       to: z.string(),
       from: z.string(),
       sent: z.string().datetime(),
-      received: z.string().datetime().optional()
+      received: z.string().datetime().optional(),
+      metadata: z.record(z.unknown()).optional()
     });
     var BoostPermissionsValidator = z.object({
       role: z.string(),
@@ -4799,7 +4842,7 @@ var require_types_cjs_development = __commonJS({
       claimPermissions: BoostPermissionsValidator.optional(),
       allowAnyoneToCreateChildren: z.boolean().optional()
     });
-    var BoostQueryValidator = z.object({
+    var BaseBoostQueryValidator = z.object({
       uri: StringQuery,
       name: StringQuery,
       type: StringQuery,
@@ -4808,6 +4851,12 @@ var require_types_cjs_development = __commonJS({
       status: LCNBoostStatus.or(z.object({ $in: LCNBoostStatus.array() })),
       autoConnectRecipients: z.boolean()
     }).partial();
+    var BoostQueryValidator = z.union([
+      z.object({
+        $or: BaseBoostQueryValidator.array()
+      }),
+      BaseBoostQueryValidator
+    ]);
     var PaginatedBoostsValidator = PaginationResponseValidator.extend({
       records: BoostValidator.array()
     });
@@ -4863,11 +4912,25 @@ var require_types_cjs_development = __commonJS({
     var ConsentFlowContractValidator = z.object({
       read: z.object({
         anonymize: z.boolean().optional(),
-        credentials: z.object({ categories: z.record(z.object({ required: z.boolean(), defaultEnabled: z.boolean().optional() })).default({}) }).default({}),
+        credentials: z.object({
+          categories: z.record(
+            z.object({
+              required: z.boolean(),
+              defaultEnabled: z.boolean().optional()
+            })
+          ).default({})
+        }).default({}),
         personal: z.record(z.object({ required: z.boolean(), defaultEnabled: z.boolean().optional() })).default({})
       }).default({}),
       write: z.object({
-        credentials: z.object({ categories: z.record(z.object({ required: z.boolean(), defaultEnabled: z.boolean().optional() })).default({}) }).default({}),
+        credentials: z.object({
+          categories: z.record(
+            z.object({
+              required: z.boolean(),
+              defaultEnabled: z.boolean().optional()
+            })
+          ).default({})
+        }).default({}),
         personal: z.record(z.object({ required: z.boolean(), defaultEnabled: z.boolean().optional() })).default({})
       }).default({})
     });
@@ -5010,6 +5073,17 @@ var require_types_cjs_development = __commonJS({
     var PaginatedConsentFlowTransactionsValidator = PaginationResponseValidator.extend({
       records: ConsentFlowTransactionValidator.array()
     });
+    var BaseSkillFrameworkQueryValidator = z.object({
+      id: StringQuery,
+      name: StringQuery,
+      description: StringQuery,
+      sourceURI: StringQuery,
+      status: StringQuery
+    }).partial();
+    var SkillFrameworkQueryValidator = z.union([
+      z.object({ $or: BaseSkillFrameworkQueryValidator.array() }),
+      BaseSkillFrameworkQueryValidator
+    ]);
     var ContractCredentialValidator = z.object({
       credentialUri: z.string(),
       termsUri: z.string(),
@@ -5064,8 +5138,9 @@ var require_types_cjs_development = __commonJS({
       vcUris: z.array(z.string()).optional(),
       vpUris: z.array(z.string()).optional(),
       transaction: ConsentFlowTransactionValidator.optional(),
-      inbox: LCNNotificationInboxValidator.optional()
-    });
+      inbox: LCNNotificationInboxValidator.optional(),
+      metadata: z.record(z.unknown()).optional()
+    }).passthrough();
     var LCNNotificationValidator = z.object({
       type: LCNNotificationTypeEnumValidator,
       to: LCNProfileValidator.partial().and(z.object({ did: z.string() })),
@@ -5188,31 +5263,55 @@ var require_types_cjs_development = __commonJS({
     });
     var IssueInboxCredentialValidator = z.object({
       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."
+      ),
       configuration: z.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: z.string().url().optional().describe("The webhook URL to receive credential issuance events."),
         expiresInDays: z.number().min(1).max(365).optional().describe("The number of days the credential will be valid for."),
         delivery: z.object({
-          suppress: z.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: z.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: z.object({
-            id: z.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: z.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: z.object({
               issuer: z.object({
-                name: z.string().optional().describe('The name of the organization (e.g., "State University").'),
+                name: z.string().optional().describe(
+                  'The name of the organization (e.g., "State University").'
+                ),
                 logoUrl: z.string().url().optional().describe("The URL of the organization's logo.")
               }).optional(),
               credential: z.object({
-                name: z.string().optional().describe('The name of the credential (e.g., "Bachelor of Science").'),
-                type: z.string().optional().describe('The type of the credential (e.g., "degree", "certificate").')
+                name: z.string().optional().describe(
+                  'The name of the credential (e.g., "Bachelor of Science").'
+                ),
+                type: z.string().optional().describe(
+                  'The type of the credential (e.g., "degree", "certificate").'
+                )
               }).optional(),
               recipient: z.object({
-                name: z.string().optional().describe('The name of the recipient (e.g., "John Doe").')
+                name: z.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 = z.object({
       issuanceId: z.string(),
@@ -5274,6 +5373,191 @@ var require_types_cjs_development = __commonJS({
       expiresAt: z.string(),
       used: z.boolean()
     });
+    var TagValidator = z.object({
+      id: z.string(),
+      name: z.string().min(1),
+      slug: z.string().min(1),
+      createdAt: z.string().optional(),
+      updatedAt: z.string().optional()
+    });
+    var SkillStatusEnum = z.enum(["active", "archived"]);
+    var SkillValidator = z.object({
+      id: z.string(),
+      statement: z.string(),
+      description: z.string().optional(),
+      code: z.string().optional(),
+      icon: z.string().optional(),
+      type: z.string().default("skill"),
+      status: SkillStatusEnum.default("active"),
+      frameworkId: z.string().optional(),
+      createdAt: z.string().optional(),
+      updatedAt: z.string().optional()
+    });
+    var BaseSkillQueryValidator = z.object({
+      id: StringQuery,
+      statement: StringQuery,
+      description: StringQuery,
+      code: StringQuery,
+      type: StringQuery,
+      status: SkillStatusEnum.or(z.object({ $in: SkillStatusEnum.array() }))
+    }).partial();
+    var SkillQueryValidator = z.union([
+      z.object({
+        $or: BaseSkillQueryValidator.array()
+      }),
+      BaseSkillQueryValidator
+    ]);
+    var SkillFrameworkStatusEnum = z.enum(["active", "archived"]);
+    var SkillFrameworkValidator = z.object({
+      id: z.string(),
+      name: z.string(),
+      description: z.string().optional(),
+      image: z.string().optional(),
+      sourceURI: z.string().url().optional(),
+      status: SkillFrameworkStatusEnum.default("active"),
+      createdAt: z.string().optional(),
+      updatedAt: z.string().optional()
+    });
+    var PaginatedSkillFrameworksValidator = PaginationResponseValidator.extend({
+      records: SkillFrameworkValidator.array()
+    });
+    var SkillTreeNodeValidator = SkillValidator.extend({
+      children: z.array(z.lazy(() => SkillTreeNodeValidator)),
+      hasChildren: z.boolean(),
+      childrenCursor: z.string().nullable().optional()
+    }).openapi({ ref: "SkillTreeNode" });
+    var PaginatedSkillTreeValidator = z.object({
+      hasMore: z.boolean(),
+      cursor: z.string().nullable(),
+      records: z.array(SkillTreeNodeValidator)
+    });
+    var SkillTreeNodeInputValidator = z.lazy(
+      () => z.object({
+        id: z.string().optional(),
+        statement: z.string(),
+        description: z.string().optional(),
+        code: z.string().optional(),
+        icon: z.string().optional(),
+        type: z.string().optional(),
+        status: SkillStatusEnum.optional(),
+        children: z.array(SkillTreeNodeInputValidator).optional()
+      })
+    ).openapi({ ref: "SkillTreeNodeInput" });
+    var LinkProviderFrameworkInputValidator = z.object({
+      frameworkId: z.string()
+    });
+    var CreateManagedFrameworkInputValidator = z.object({
+      id: z.string().optional(),
+      name: z.string().min(1),
+      description: z.string().optional(),
+      image: z.string().optional(),
+      sourceURI: z.string().url().optional(),
+      status: SkillFrameworkStatusEnum.optional(),
+      skills: z.array(SkillTreeNodeInputValidator).optional(),
+      boostUris: z.array(z.string()).optional()
+    });
+    var UpdateFrameworkInputValidator = z.object({
+      id: z.string(),
+      name: z.string().min(1).optional(),
+      description: z.string().optional(),
+      image: z.string().optional(),
+      sourceURI: z.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 = z.object({ id: z.string() });
+    var CreateManagedFrameworkBatchInputValidator = z.object({
+      frameworks: z.array(
+        CreateManagedFrameworkInputValidator.extend({
+          skills: z.array(SkillTreeNodeInputValidator).optional()
+        })
+      ).min(1)
+    });
+    var SkillFrameworkAdminInputValidator = z.object({
+      frameworkId: z.string(),
+      profileId: z.string()
+    });
+    var SkillFrameworkIdInputValidator = z.object({ frameworkId: z.string() });
+    var SkillFrameworkAdminsValidator = LCNProfileValidator.array();
+    var SyncFrameworkInputValidator = z.object({ id: z.string() });
+    var AddTagInputValidator = z.object({
+      slug: z.string().min(1),
+      name: z.string().min(1)
+    });
+    var CreateSkillInputValidator = z.object({
+      frameworkId: z.string(),
+      skill: SkillTreeNodeInputValidator,
+      parentId: z.string().nullable().optional()
+    });
+    var UpdateSkillInputValidator = z.object({
+      frameworkId: z.string(),
+      id: z.string(),
+      statement: z.string().optional(),
+      description: z.string().optional(),
+      code: z.string().optional(),
+      icon: z.string().optional(),
+      type: z.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 = z.enum(["recursive", "reparent"]);
+    var DeleteSkillInputValidator = z.object({
+      frameworkId: z.string(),
+      id: z.string(),
+      strategy: SkillDeletionStrategyValidator.optional().default("reparent")
+    });
+    var CreateSkillsBatchInputValidator = z.object({
+      frameworkId: z.string(),
+      skills: z.array(SkillTreeNodeInputValidator).min(1),
+      parentId: z.string().nullable().optional()
+    });
+    var ReplaceSkillFrameworkSkillsInputValidator = z.object({
+      frameworkId: z.string(),
+      skills: z.array(SkillTreeNodeInputValidator).min(0)
+    });
+    var ReplaceSkillFrameworkSkillsResultValidator = z.object({
+      created: z.number().int().min(0),
+      updated: z.number().int().min(0),
+      deleted: z.number().int().min(0),
+      unchanged: z.number().int().min(0),
+      total: z.number().int().min(0)
+    });
+    var CountSkillsInputValidator = z.object({
+      frameworkId: z.string(),
+      skillId: z.string().optional(),
+      recursive: z.boolean().optional().default(false),
+      onlyCountCompetencies: z.boolean().optional().default(false)
+    });
+    var CountSkillsResultValidator = z.object({
+      count: z.number().int().min(0)
+    });
+    var GetFullSkillTreeInputValidator = z.object({
+      frameworkId: z.string()
+    });
+    var GetFullSkillTreeResultValidator = z.object({
+      skills: z.array(SkillTreeNodeValidator)
+    });
+    var GetSkillPathInputValidator = z.object({
+      frameworkId: z.string(),
+      skillId: z.string()
+    });
+    var GetSkillPathResultValidator = z.object({
+      path: z.array(SkillValidator)
+    });
+    var FrameworkWithSkillsValidator = z.object({
+      framework: SkillFrameworkValidator,
+      skills: PaginatedSkillTreeValidator
+    });
   }
 });
 
@@ -5328,9 +5612,17 @@ var isVC2Format = /* @__PURE__ */ __name((credential) => {
   }
   return credential["@context"].includes("https://www.w3.org/ns/credentials/v2");
 }, "isVC2Format");
+var unwrapBoostCredential = /* @__PURE__ */ __name((vc) => {
+  if (vc?.type?.includes("CertifiedBoostCredential") && vc?.boostCredential) {
+    return vc.boostCredential;
+  } else {
+    return vc;
+  }
+}, "unwrapBoostCredential");
 export {
   RegExpTransformer,
   isEncrypted,
   isHex,
-  isVC2Format
+  isVC2Format,
+  unwrapBoostCredential
 };