@learncard/learn-cloud-plugin 2.1.10 → 2.1.12

package/README.md

@@ -1,10 +1,10 @@
 [<img src="https://user-images.githubusercontent.com/2185016/190510561-294db809-09fd-4771-9749-6c0e0f4144fd.png" width="215"/>](https://learncard.com)
 
-# @learncard/core
+# @learncard/learn-cloud-plugin
 
-[![npm version](https://img.shields.io/npm/v/@learncard/core)](https://www.npmjs.com/package/@learncard/core)
-[![npm downloads](https://img.shields.io/npm/dw/@learncard/core)](https://www.npmjs.com/package/@learncard/core)
-[![vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/@learncard/core)](https://www.npmjs.com/package/@learncard/core)
+[![npm version](https://img.shields.io/npm/v/@learncard/learn-cloud-plugin)](https://www.npmjs.com/package/@learncard/learn-cloud-plugin)
+[![npm downloads](https://img.shields.io/npm/dw/@learncard/learn-cloud-plugin)](https://www.npmjs.com/package/@learncard/learn-cloud-plugin)
+[![vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/@learncard/learn-cloud-plugin)](https://www.npmjs.com/package/@learncard/learn-cloud-plugin)
 
 The LearnCard Core is a pluggable, open-source, universal digital wallet to enable any individual or organization to seamlessly **issue, earn, store, share, and spend currency and credentials** built for the future of education and work.
 
@@ -67,46 +67,42 @@ if (result.errors.length > 0) console.error('This presentation is not valid!', r
 else console.log('This presentation is valid!');
 ```
 
-### Storing/Retrieving/Sending Credentials
-
-#### Ceramic/IDX
+### Storing/Retrieving/Publishing Credentials with LearnCloud
 
 To maintain co-ownership of credentials, it is best to store credentials in a public place, and then
 store references to that public place. While this is not the only way to store credentials (and is
 also definitely not a silver bullet! E.g. credentials containing private data), it is the opinion of
-this library that it should be used by default. As a result, instantiating a wallet, will 
-automatically connect you to WeLibrary's ceramic node, and allow you to publish and retrieve 
-credentials there using IDX.
+this library that it should be used by default.
 
-#### Publish Credential
+#### Publish Credential 
 
-After signing a VC, you may choose to publish that credential to Ceramic. Doing so will return a
-stream ID, which you may share to the recipient. That stream ID can then be used to resolve the 
-issued credential. This means both the issuer and recipient may store the _stream ID_ instead of the
+After signing a VC, you may choose to publish that credential to LearnCloud. Doing so will return a
+URI, which you may share to the recipient. That URI can then be used to resolve the 
+issued credential. This means both the issuer and recipient may store the _URI_ instead of the
 credential itself.
 
 ```js
-const uri = await wallet.store.Ceramic.upload(vc);
+const uri = await wallet.store.LearnCloud.upload(vc);
 ```
 
-#### Reading From Ceramic
+#### Reading From LearnCloud
 
-To resolve a VC from a stream ID, simply call the `readFromCeramic` method:
+To resolve a VC from a URI:
 
 ```js
-const vcFromCeramic = await wallet.read.get(uri);
+const vcFromLearnCloud = await wallet.read.get(uri);
 ```
 
 #### Adding a Credential to a Wallet
 
-After receiving a streamID, you can _persist_ that streamID by calling `addCredential`, and giving
+After receiving a URI, you can _persist_ that URI by calling `add` and giving
 the credential a bespoke title
 
 ```js
-await wallet.index.IDX.add({ uri, id: 'Test VC' });
+await wallet.index.LearnCloud.add({ uri, id: 'Test VC' });
 ```
 
-This will add the streamId, which can be used to resolve the verifiable credential to IDX using the
+This will add the URI, which can be used to resolve the verifiable credential using the
 wallet's secret key. You can think of this as acting like the wallet's personal storage.
 
 #### Getting a credential from the Wallet
@@ -114,14 +110,15 @@ wallet's secret key. You can think of this as acting like the wallet's personal
 After calling `addCredential`, you can use the bespoke title to retrieve that credential at any time
 
 ```js
-const record = (await wallet.index.all.get()).find(record => record.id === 'Test VC');
-const vcFromIdx = await wallet.read.get(record.uri);
+const record = (await wallet.index.LearnCloud.get()).find(record => record.id === 'Test VC');
+const vcFromLearnCloud = await wallet.read.get(record.uri);
 ```
 
-Alternatively, you can get an array of _all_ credentials you have added using `getCredentials`
+Alternatively, you can get an array of _all_ your stored credentials:
 
 ```js
-const uris = (await wallet.index.all.get()).map(record => record.uri);
+const records = await wallet.index.LearnCloud.get();
+const uris = records.map(record => record.uri);
 const vcs = await Promise.all(uris.map(async uri => wallet.read.get(uri)));
 ```
 

package/dist/learn-cloud-plugin.cjs.development.js

@@ -11324,7 +11324,7 @@ var require_types_cjs_development = __commonJS2({
       canManageChildrenProfiles: mod2.boolean(),
       canViewAnalytics: mod2.boolean()
     }).partial();
-    var ClaimHookTypeValidator2 = mod2.enum(["GRANT_PERMISSIONS"]);
+    var ClaimHookTypeValidator2 = mod2.enum(["GRANT_PERMISSIONS", "ADD_ADMIN"]);
     var ClaimHookValidator2 = mod2.discriminatedUnion("type", [
       mod2.object({
         type: mod2.literal(ClaimHookTypeValidator2.Values.GRANT_PERMISSIONS),
@@ -11333,6 +11333,10 @@ var require_types_cjs_development = __commonJS2({
           targetUri: mod2.string(),
           permissions: BoostPermissionsValidator2.partial()
         })
+      }),
+      mod2.object({
+        type: mod2.literal(ClaimHookTypeValidator2.Values.ADD_ADMIN),
+        data: mod2.object({ claimUri: mod2.string(), targetUri: mod2.string() })
       })
     ]);
     var ClaimHookQueryValidator2 = mod2.object({
@@ -15443,7 +15447,7 @@ var BoostPermissionsQueryValidator = mod.object({
   canManageChildrenProfiles: mod.boolean(),
   canViewAnalytics: mod.boolean()
 }).partial();
-var ClaimHookTypeValidator = mod.enum(["GRANT_PERMISSIONS"]);
+var ClaimHookTypeValidator = mod.enum(["GRANT_PERMISSIONS", "ADD_ADMIN"]);
 var ClaimHookValidator = mod.discriminatedUnion("type", [
   mod.object({
     type: mod.literal(ClaimHookTypeValidator.Values.GRANT_PERMISSIONS),
@@ -15452,6 +15456,10 @@ var ClaimHookValidator = mod.discriminatedUnion("type", [
       targetUri: mod.string(),
       permissions: BoostPermissionsValidator.partial()
     })
+  }),
+  mod.object({
+    type: mod.literal(ClaimHookTypeValidator.Values.ADD_ADMIN),
+    data: mod.object({ claimUri: mod.string(), targetUri: mod.string() })
   })
 ]);
 var ClaimHookQueryValidator = mod.object({