@learncard/learn-cloud-plugin 1.0.6 → 1.1.0

package/dist/helpers.d.ts

@@ -1,7 +1,7 @@
-import { CredentialRecord, JWE, EncryptedCredentialRecord } from '@learncard/types';
+import { JWE, EncryptedRecord } from '@learncard/types';
 import { LearnCloudDependentLearnCard } from './types';
 export declare const hash: (learnCard: LearnCloudDependentLearnCard, message: string) => Promise<string>;
 export declare const generateJWE: (learnCard: LearnCloudDependentLearnCard, learnCloudDid: string, item: any) => Promise<JWE>;
 export declare const decryptJWE: <T>(learnCard: LearnCloudDependentLearnCard, jwe: JWE) => Promise<T>;
-export declare const generateEncryptedFieldsArray: (learnCard: LearnCloudDependentLearnCard, record: CredentialRecord, unencryptedFields?: string[]) => Promise<string[]>;
-export declare const generateEncryptedRecord: (learnCard: LearnCloudDependentLearnCard, record: CredentialRecord, unencryptedFields?: string[]) => Promise<Omit<EncryptedCredentialRecord, 'id'>>;
+export declare const generateEncryptedFieldsArray: (learnCard: LearnCloudDependentLearnCard, record: Record<string, any>, unencryptedFields?: string[]) => Promise<string[]>;
+export declare const generateEncryptedRecord: (learnCard: LearnCloudDependentLearnCard, record: Record<string, any>, unencryptedFields?: string[]) => Promise<EncryptedRecord>;

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

@@ -6972,6 +6972,7 @@ var require_types_cjs_development = __commonJS2({
       CredentialSubjectValidator: () => CredentialSubjectValidator2,
       CriteriaValidator: () => CriteriaValidator2,
       EncryptedCredentialRecordValidator: () => EncryptedCredentialRecordValidator2,
+      EncryptedRecordValidator: () => EncryptedRecordValidator2,
       EndorsementCredentialValidator: () => EndorsementCredentialValidator2,
       EndorsementSubjectValidator: () => EndorsementSubjectValidator2,
       EvidenceValidator: () => EvidenceValidator2,
@@ -6997,6 +6998,7 @@ var require_types_cjs_development = __commonJS2({
       LCNSigningAuthorityForUserValidator: () => LCNSigningAuthorityForUserValidator2,
       LCNSigningAuthorityValidator: () => LCNSigningAuthorityValidator2,
       PaginatedEncryptedCredentialRecordsValidator: () => PaginatedEncryptedCredentialRecordsValidator2,
+      PaginatedEncryptedRecordsValidator: () => PaginatedEncryptedRecordsValidator2,
       PaginationOptionsValidator: () => PaginationOptionsValidator2,
       PaginationResponseValidator: () => PaginationResponseValidator2,
       ProfileValidator: () => ProfileValidator2,
@@ -10762,11 +10764,13 @@ var require_types_cjs_development = __commonJS2({
       aad: mod2.string().optional(),
       recipients: JWERecipientValidator2.array().optional()
     });
-    var EncryptedCredentialRecordValidator2 = mod2.object({
-      encryptedRecord: JWEValidator2,
-      fields: mod2.string().array(),
+    var EncryptedRecordValidator2 = mod2.object({ encryptedRecord: JWEValidator2, fields: mod2.string().array() }).catchall(mod2.any());
+    var PaginatedEncryptedRecordsValidator2 = PaginationResponseValidator2.extend({
+      records: EncryptedRecordValidator2.array()
+    });
+    var EncryptedCredentialRecordValidator2 = EncryptedRecordValidator2.extend({
       id: mod2.string()
-    }).catchall(mod2.any());
+    });
     var PaginatedEncryptedCredentialRecordsValidator2 = PaginationResponseValidator2.extend({
       records: EncryptedCredentialRecordValidator2.array()
     });
@@ -14584,11 +14588,13 @@ var JWEValidator = mod.object({
   aad: mod.string().optional(),
   recipients: JWERecipientValidator.array().optional()
 });
-var EncryptedCredentialRecordValidator = mod.object({
-  encryptedRecord: JWEValidator,
-  fields: mod.string().array(),
+var EncryptedRecordValidator = mod.object({ encryptedRecord: JWEValidator, fields: mod.string().array() }).catchall(mod.any());
+var PaginatedEncryptedRecordsValidator = PaginationResponseValidator.extend({
+  records: EncryptedRecordValidator.array()
+});
+var EncryptedCredentialRecordValidator = EncryptedRecordValidator.extend({
   id: mod.string()
-}).catchall(mod.any());
+});
 var PaginatedEncryptedCredentialRecordsValidator = PaginationResponseValidator.extend({
   records: EncryptedCredentialRecordValidator.array()
 });
@@ -14791,7 +14797,7 @@ var getLearnCloudClient = /* @__PURE__ */ __name(async (url, learnCard) => {
     return jwt;
   });
 }, "getLearnCloudClient");
-var getLearnCloudPlugin = /* @__PURE__ */ __name(async (initialLearnCard, url, unencryptedFields = []) => {
+var getLearnCloudPlugin = /* @__PURE__ */ __name(async (initialLearnCard, url, unencryptedFields = [], unencryptedCustomFields = []) => {
   let learnCard = initialLearnCard;
   learnCard.debug?.("Adding LearnCloud Plugin");
   let client = await getLearnCloudClient(url, learnCard);
@@ -14817,7 +14823,166 @@ var getLearnCloudPlugin = /* @__PURE__ */ __name(async (initialLearnCard, url, u
     name: "LearnCloud",
     displayName: "LearnCloud",
     description: "LearnCloud Integration",
-    methods: {},
+    methods: {
+      learnCloudCreate: async (_learnCard, document) => {
+        await updateLearnCard(_learnCard);
+        const item = await generateEncryptedRecord(
+          _learnCard,
+          document,
+          unencryptedCustomFields
+        );
+        return client.customStorage.create.mutate({
+          item: await generateJWE(_learnCard, learnCloudDid, item)
+        });
+      },
+      learnCloudCreateMany: async (_learnCard, documents) => {
+        await updateLearnCard(_learnCard);
+        const items = await Promise.all(
+          documents.map(
+            async (document) => generateEncryptedRecord(_learnCard, document, unencryptedCustomFields)
+          )
+        );
+        return client.customStorage.createMany.mutate({
+          items: await generateJWE(_learnCard, learnCloudDid, items)
+        });
+      },
+      learnCloudRead: async (_learnCard, query, includeAssociatedDids) => {
+        await updateLearnCard(_learnCard);
+        const documents = [];
+        let result = await _learnCard.invoke.learnCloudReadPage(
+          query,
+          {},
+          includeAssociatedDids
+        );
+        documents.push(...result.records);
+        while (result.hasMore) {
+          result = await _learnCard.invoke.learnCloudReadPage(
+            query,
+            {},
+            includeAssociatedDids
+          );
+          documents.push(...result.records);
+        }
+        return documents;
+      },
+      learnCloudReadPage: async (_learnCard, query, paginationOptions, includeAssociatedDids) => {
+        await updateLearnCard(_learnCard);
+        if (!query) {
+          const jwe2 = await client.customStorage.read.query({
+            includeAssociatedDids,
+            ...paginationOptions
+          });
+          const encryptedRecords2 = isEncrypted(jwe2) ? await decryptJWE(_learnCard, jwe2) : jwe2;
+          return {
+            ...encryptedRecords2,
+            records: await Promise.all(
+              encryptedRecords2.records.map(async (record) => ({
+                ...await decryptJWE(
+                  _learnCard,
+                  record.encryptedRecord
+                ),
+                _id: record._id
+              }))
+            )
+          };
+        }
+        const fields = await generateEncryptedFieldsArray(_learnCard, query, [
+          ...unencryptedCustomFields,
+          "_id"
+        ]);
+        const unencryptedEntries = Object.fromEntries(
+          Object.entries(query).filter(
+            ([key]) => [...unencryptedCustomFields, "_id"].includes(key)
+          )
+        );
+        const jwe = await client.customStorage.read.query({
+          query: await generateJWE(_learnCard, learnCloudDid, {
+            ...unencryptedEntries,
+            ...fields.length > 0 ? { fields: { $in: fields } } : {}
+          }),
+          ...paginationOptions,
+          includeAssociatedDids
+        });
+        const encryptedRecords = isEncrypted(jwe) ? await decryptJWE(_learnCard, jwe) : jwe;
+        return {
+          ...encryptedRecords,
+          records: await Promise.all(
+            encryptedRecords.records.map(async (record) => ({
+              ...await decryptJWE(
+                _learnCard,
+                record.encryptedRecord
+              ),
+              _id: record._id
+            }))
+          )
+        };
+      },
+      learnCloudCount: async (_learnCard, query, includeAssociatedDids) => {
+        await updateLearnCard(_learnCard);
+        if (!query)
+          return client.customStorage.count.query({ includeAssociatedDids });
+        const fields = await generateEncryptedFieldsArray(_learnCard, query, [
+          ...unencryptedCustomFields,
+          "_id"
+        ]);
+        const unencryptedEntries = Object.fromEntries(
+          Object.entries(query).filter(
+            ([key]) => [...unencryptedCustomFields, "_id"].includes(key)
+          )
+        );
+        return client.customStorage.count.query({
+          query: await generateJWE(_learnCard, learnCloudDid, {
+            ...unencryptedEntries,
+            ...fields.length > 0 ? { fields: { $in: fields } } : {}
+          }),
+          includeAssociatedDids
+        });
+      },
+      learnCloudUpdate: async (_learnCard, query, update) => {
+        await updateLearnCard(_learnCard);
+        const documents = await _learnCard.invoke.learnCloudRead(query);
+        const updates = await Promise.all(
+          documents.map(
+            async (document) => client.customStorage.update.mutate({
+              query: await generateJWE(_learnCard, learnCloudDid, {
+                _id: document._id
+              }),
+              update: await generateJWE(
+                _learnCard,
+                learnCloudDid,
+                await generateEncryptedRecord(
+                  _learnCard,
+                  { ...document, ...update },
+                  unencryptedCustomFields
+                )
+              )
+            })
+          )
+        );
+        return updates.reduce((sum, current) => current + sum, 0);
+      },
+      learnCloudDelete: async (_learnCard, query, includeAssociatedDids) => {
+        await updateLearnCard(_learnCard);
+        if (!query)
+          return client.customStorage.delete.mutate({ includeAssociatedDids });
+        const fields = await generateEncryptedFieldsArray(_learnCard, query, [
+          ...unencryptedCustomFields,
+          "_id"
+        ]);
+        const unencryptedEntries = Object.fromEntries(
+          Object.entries(query).filter(
+            ([key]) => [...unencryptedCustomFields, "_id"].includes(key)
+          )
+        );
+        return client.customStorage.delete.mutate({
+          query: await generateJWE(_learnCard, learnCloudDid, {
+            ...unencryptedEntries,
+            ...fields.length > 0 ? { fields: { $in: fields } } : {}
+          }),
+          includeAssociatedDids
+        });
+      }
+    },
     read: {
       get: async (_learnCard, uri) => {
         if (!uri)
@@ -14901,7 +15066,7 @@ var getLearnCloudPlugin = /* @__PURE__ */ __name(async (initialLearnCard, url, u
         const jwe = await client.index.get.query({
           query: await generateJWE(_learnCard, learnCloudDid, {
             ...unencryptedEntries,
-            fields: { $in: fields }
+            ...fields.length > 0 ? { fields: { $in: fields } } : {}
           }),
           ...paginationOptions
         });
@@ -14947,7 +15112,7 @@ var getLearnCloudPlugin = /* @__PURE__ */ __name(async (initialLearnCard, url, u
         const jwe = await client.index.count.query({
           query: await generateJWE(_learnCard, learnCloudDid, {
             ...unencryptedEntries,
-            fields: { $in: fields }
+            ...fields.length > 0 ? { fields: { $in: fields } } : {}
           })
         });
         _learnCard.debug?.("LearnCloud index.count (query response)", jwe);