@learncard/types 2.1.1 → 2.2.0

package/README.md

@@ -1,11 +1,15 @@
+[<img src="https://user-images.githubusercontent.com/2185016/176284693-4ca14052-d067-4ea5-b170-c6cd2594ee23.png" width="400"/>](image.png)
 # @learncard/types
-
-> Shared types for learn card
-
 [![npm version](https://img.shields.io/npm/v/@learncard/types)](https://www.npmjs.com/package/@learncard/types)
 [![npm downloads](https://img.shields.io/npm/dw/@learncard/types)](https://www.npmjs.com/package/@learncard/types)
 [![vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/@learncard/types)](https://www.npmjs.com/package/@learncard/types)
 
+Shared types for learn card
+
+## Documentation
+All LearnCard documentation can be found at:
+https://docs.learncard.com
+
 ## Install
 
 ```bash
@@ -18,8 +22,18 @@ pnpm install @learncard/types
 import { VC } from "@learncard/types";
 ```
 
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+## Who is Learning Economy Foundation?
+
+**[Learning Economy Foundation (LEF)](https://www.learningeconomy.io)** is a 501(c)(3) non-profit organization leveraging global standards and web3 protocols to bring quality skills and equal opportunity to every human on earth, and address the persistent inequities that exist around the globe in education and employment. We help you build the future of education and work with:
+
+
 ## License
 
-MIT © [Taylor Beeston <beeston.taylor@gmail.com>](https://github.com/TaylorBeeston)
+MIT © [Learning Economy Foundation](https://github.com/Learning-Economy-Foundation)
 
-[Created with aqu 🌊](https://github.com/ArtiomTr/aqu#readme)

package/dist/idx.d.ts

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+export declare const StorageTypeValidator: z.ZodEnum<["ceramic"]>;
+export declare const StorageTypeEnum: {
+    ceramic: "ceramic";
+};
+export declare type StorageType = z.infer<typeof StorageTypeValidator>;
+export 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;
+    id: string;
+    title: string;
+}>;
+export declare type IDXCredential = z.infer<typeof IDXCredentialValidator>;

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from './vc';
 export * from './obv3';
 export * from './learncard';
+export * from './idx';

package/dist/learncard.d.ts

@@ -1,4 +1,18 @@
 import { z } from 'zod';
+export declare const VerificationCheckValidator: z.ZodObject<{
+    checks: z.ZodArray<z.ZodString, "many">;
+    warnings: z.ZodArray<z.ZodString, "many">;
+    errors: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    checks: string[];
+    warnings: string[];
+    errors: string[];
+}, {
+    checks: string[];
+    warnings: string[];
+    errors: string[];
+}>;
+export declare type VerificationCheck = z.infer<typeof VerificationCheckValidator>;
 export declare const VerificationStatusValidator: z.ZodEnum<["Success", "Failed", "Error"]>;
 export declare type VerificationStatus = z.infer<typeof VerificationStatusValidator>;
 export declare const VerificationStatusEnum: {
@@ -28,7 +42,7 @@ export declare const CredentialInfoValidator: z.ZodObject<{
     createdAt: z.ZodOptional<z.ZodString>;
     issuer: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
         id: z.ZodOptional<z.ZodString>;
-        type: z.ZodArray<z.ZodString, "atleastone">;
+        type: z.ZodOptional<z.ZodArray<z.ZodString, "atleastone">>;
         name: z.ZodOptional<z.ZodString>;
         url: z.ZodOptional<z.ZodString>;
         phone: z.ZodOptional<z.ZodString>;
@@ -124,6 +138,7 @@ export declare const CredentialInfoValidator: z.ZodObject<{
         dateOfBirth: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodAny, {
         [x: string]: any;
+        type?: [string, ...string[]] | undefined;
         id?: string | undefined;
         name?: string | undefined;
         url?: string | undefined;
@@ -166,9 +181,9 @@ export declare const CredentialInfoValidator: z.ZodObject<{
         honorificSuffix?: string | undefined;
         familyNamePrefix?: string | undefined;
         dateOfBirth?: string | undefined;
-        type: [string, ...string[]];
     }, {
         [x: string]: any;
+        type?: [string, ...string[]] | undefined;
         id?: string | undefined;
         name?: string | undefined;
         url?: string | undefined;
@@ -211,11 +226,10 @@ export declare const CredentialInfoValidator: z.ZodObject<{
         honorificSuffix?: string | undefined;
         familyNamePrefix?: string | undefined;
         dateOfBirth?: string | undefined;
-        type: [string, ...string[]];
     }>]>>;
     issuee: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
         id: z.ZodOptional<z.ZodString>;
-        type: z.ZodArray<z.ZodString, "atleastone">;
+        type: z.ZodOptional<z.ZodArray<z.ZodString, "atleastone">>;
         name: z.ZodOptional<z.ZodString>;
         url: z.ZodOptional<z.ZodString>;
         phone: z.ZodOptional<z.ZodString>;
@@ -311,6 +325,7 @@ export declare const CredentialInfoValidator: z.ZodObject<{
         dateOfBirth: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodAny, {
         [x: string]: any;
+        type?: [string, ...string[]] | undefined;
         id?: string | undefined;
         name?: string | undefined;
         url?: string | undefined;
@@ -353,9 +368,9 @@ export declare const CredentialInfoValidator: z.ZodObject<{
         honorificSuffix?: string | undefined;
         familyNamePrefix?: string | undefined;
         dateOfBirth?: string | undefined;
-        type: [string, ...string[]];
     }, {
         [x: string]: any;
+        type?: [string, ...string[]] | undefined;
         id?: string | undefined;
         name?: string | undefined;
         url?: string | undefined;
@@ -398,7 +413,6 @@ export declare const CredentialInfoValidator: z.ZodObject<{
         honorificSuffix?: string | undefined;
         familyNamePrefix?: string | undefined;
         dateOfBirth?: string | undefined;
-        type: [string, ...string[]];
     }>]>>;
     credentialSubject: z.ZodOptional<z.ZodObject<{
         id: z.ZodOptional<z.ZodString>;
@@ -412,6 +426,7 @@ export declare const CredentialInfoValidator: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     issuer?: string | {
         [x: string]: any;
+        type?: [string, ...string[]] | undefined;
         id?: string | undefined;
         name?: string | undefined;
         url?: string | undefined;
@@ -454,7 +469,6 @@ export declare const CredentialInfoValidator: z.ZodObject<{
         honorificSuffix?: string | undefined;
         familyNamePrefix?: string | undefined;
         dateOfBirth?: string | undefined;
-        type: [string, ...string[]];
     } | undefined;
     credentialSubject?: {
         [x: string]: any;
@@ -464,6 +478,7 @@ export declare const CredentialInfoValidator: z.ZodObject<{
     createdAt?: string | undefined;
     issuee?: string | {
         [x: string]: any;
+        type?: [string, ...string[]] | undefined;
         id?: string | undefined;
         name?: string | undefined;
         url?: string | undefined;
@@ -506,11 +521,11 @@ export declare const CredentialInfoValidator: z.ZodObject<{
         honorificSuffix?: string | undefined;
         familyNamePrefix?: string | undefined;
         dateOfBirth?: string | undefined;
-        type: [string, ...string[]];
     } | undefined;
 }, {
     issuer?: string | {
         [x: string]: any;
+        type?: [string, ...string[]] | undefined;
         id?: string | undefined;
         name?: string | undefined;
         url?: string | undefined;
@@ -553,7 +568,6 @@ export declare const CredentialInfoValidator: z.ZodObject<{
         honorificSuffix?: string | undefined;
         familyNamePrefix?: string | undefined;
         dateOfBirth?: string | undefined;
-        type: [string, ...string[]];
     } | undefined;
     credentialSubject?: {
         [x: string]: any;
@@ -563,6 +577,7 @@ export declare const CredentialInfoValidator: z.ZodObject<{
     createdAt?: string | undefined;
     issuee?: string | {
         [x: string]: any;
+        type?: [string, ...string[]] | undefined;
         id?: string | undefined;
         name?: string | undefined;
         url?: string | undefined;
@@ -605,7 +620,6 @@ export declare const CredentialInfoValidator: z.ZodObject<{
         honorificSuffix?: string | undefined;
         familyNamePrefix?: string | undefined;
         dateOfBirth?: string | undefined;
-        type: [string, ...string[]];
     } | undefined;
 }>;
 export declare type CredentialInfo = z.infer<typeof CredentialInfoValidator>;