@learncard/core 6.3.1 → 6.4.0

package/dist/core.d.ts

@@ -4645,23 +4645,18 @@ declare const VerificationItemValidator: z.ZodObject<{
 	check: string;
 }>;
 export declare type VerificationItem = z.infer<typeof VerificationItemValidator>;
-declare const IDXCredentialValidator: z.ZodObject<{
-	id: z.ZodString;
-	title: z.ZodString;
-	storageType: z.ZodOptional<z.ZodEnum<[
-		"ceramic"
-	]>>;
-}, "strip", z.ZodTypeAny, {
-	storageType?: "ceramic" | undefined;
-	id: string;
-	title: string;
-}, {
-	storageType?: "ceramic" | undefined;
+declare const StorageTypeValidator: z.ZodEnum<[
+	"ceramic"
+]>;
+/** @group IDXPlugin */
+export declare type StorageType = z.infer<typeof StorageTypeValidator>;
+/** @group IDXPlugin */
+export declare type IDXCredential<Metadata extends Record<string, any> = Record<never, never>> = {
 	id: string;
 	title: string;
-}>;
-/** @group IDXPlugin */
-export declare type IDXCredential = z.infer<typeof IDXCredentialValidator>;
+	storageType?: StorageType;
+	[key: string]: any;
+} & Metadata;
 declare const JWKValidator: z.ZodObject<{
 	kty: z.ZodString;
 	crv: z.ZodString;
@@ -4764,46 +4759,20 @@ export declare type CeramicIDXArgs = {
 };
 /** @group IDXPlugin */
 export declare type IDXPluginMethods = {
-	getCredentialsListFromIdx: (alias?: string) => Promise<CredentialsList>;
+	getCredentialsListFromIdx: <Metadata extends Record<string, any> = Record<never, never>>(alias?: string) => Promise<CredentialsList<Metadata>>;
 	publishContentToCeramic: (cred: any) => Promise<string>;
 	readContentFromCeramic: (streamId: string) => Promise<any>;
 	getVerifiableCredentialFromIdx: (title: string) => Promise<VC>;
 	getVerifiableCredentialsFromIdx: () => Promise<VC[]>;
-	addVerifiableCredentialInIdx: (cred: IDXCredential) => Promise<StreamID>;
+	addVerifiableCredentialInIdx: <Metadata extends Record<string, any> = Record<never, never>>(cred: IDXCredential<Metadata>) => Promise<StreamID>;
 	removeVerifiableCredentialInIdx: (title: string) => Promise<StreamID>;
 };
 /** @group IDXPlugin */
-export declare const CredentialsListValidator: z.ZodObject<{
-	credentials: z.ZodArray<z.ZodObject<{
-		id: z.ZodString;
-		title: z.ZodString;
-		storageType: z.ZodOptional<z.ZodEnum<[
-			"ceramic"
-		]>>;
-	}, "strip", z.ZodTypeAny, {
-		storageType?: "ceramic" | undefined;
-		id: string;
-		title: string;
-	}, {
-		storageType?: "ceramic" | undefined;
-		id: string;
-		title: string;
-	}>, "many">;
-}, "strict", z.ZodTypeAny, {
-	credentials: {
-		storageType?: "ceramic" | undefined;
-		id: string;
-		title: string;
-	}[];
-}, {
-	credentials: {
-		storageType?: "ceramic" | undefined;
-		id: string;
-		title: string;
-	}[];
-}>;
+export declare type CredentialsList<Metadata extends Record<string, any> = Record<never, never>> = {
+	credentials: Array<IDXCredential<Metadata>>;
+};
 /** @group IDXPlugin */
-export declare type CredentialsList = z.infer<typeof CredentialsListValidator>;
+export declare const CredentialsListValidator: z.ZodType<CredentialsList>;
 export declare type Last<T extends any[]> = T extends [
 	...any[],
 	infer R
@@ -5090,7 +5059,7 @@ export declare type GetCredentials = () => Promise<VC[]>;
  *
  * @group LearnCard Methods
  */
-export declare type GetCredentialsList = () => Promise<IDXCredential[]>;
+export declare type GetCredentialsList = <Metadata extends Record<string, any> = Record<never, never>>() => Promise<IDXCredential<Metadata>[]>;
 /**
  * Publishes a credential to Ceramic, returning the credential's stream ID
  *
@@ -5110,7 +5079,7 @@ export declare type PublishCredential = (credential: VC) => Promise<string>;
  *
  * @group LearnCard Methods
  */
-export declare type AddCredential = (credential: IDXCredential) => Promise<void>;
+export declare type AddCredential = <Metadata extends Record<string, any> = Record<never, never>>(credential: IDXCredential<Metadata>) => Promise<void>;
 /**
  * Adds a stream ID  pointing to a credential (such as the one returned by `publishCredential`)
  * to IDX with a bespoke title

package/dist/core.esm.js

@@ -42181,7 +42181,7 @@ var AlignmentValidator = mod.object({
   targetType: AlignmentTargetTypeValidator.optional(),
   targetUrl: mod.string()
 });
-var AchievementTypeValidator = mod.enum([
+var KnownAchievementTypeValidator = mod.enum([
   "Achievement",
   "ApprenticeshipCertificate",
   "Assessment",
@@ -42213,7 +42213,8 @@ var AchievementTypeValidator = mod.enum([
   "MicroCredential",
   "ResearchDoctorate",
   "SecondarySchoolDiploma"
-]).or(mod.string());
+]);
+var AchievementTypeValidator = KnownAchievementTypeValidator.or(mod.string());
 var CriteriaValidator = mod.object({ id: mod.string().optional(), narrative: mod.string().optional() }).catchall(mod.any());
 var EndorsementSubjectValidator = mod.object({
   id: mod.string(),
@@ -42372,7 +42373,7 @@ var IDXCredentialValidator = mod.object({
   id: mod.string(),
   title: mod.string(),
   storageType: StorageTypeValidator.optional()
-});
+}).catchall(mod.any());
 var JWKValidator = mod.object({
   kty: mod.string(),
   crv: mod.string(),