@learncard/network-plugin 3.0.1 → 3.1.0

package/src/test/inbox-finalize-crypto.test.ts

@@ -0,0 +1,61 @@
+import { readFile } from 'node:fs/promises';
+import { generateLearnCard } from '@learncard/core';
+import { getDidKitPlugin } from '@learncard/didkit-plugin';
+import { getDidKeyPlugin } from '@learncard/didkey-plugin';
+import { getVCPlugin } from '@learncard/vc-plugin';
+import { getClient as getBrainClient } from '@learncard/network-brain-client';
+import { vi, expect, it } from 'vitest';
+import { getLearnCardNetworkPlugin } from '../';
+import { SAMPLE_VCS } from './mocks/sample-vcs';
+
+vi.mock('@learncard/network-brain-client', () => ({
+    getClient: vi.fn(),
+    getApiTokenClient: vi.fn(),
+}));
+
+it('preserves valid siblings through finalization and recovery despite wrong-key and credential-validation failures', async () => {
+    const didkit = readFile(
+        require.resolve('@learncard/didkit-plugin/dist/didkit/didkit_wasm_bg.wasm')
+    );
+    const makeCard = async (seed: string) => {
+        const card = await (await generateLearnCard()).addPlugin(await getDidKitPlugin(didkit));
+        const identity = await card.addPlugin(await getDidKeyPlugin(card, seed, 'key'));
+        return identity.addPlugin(await getVCPlugin(identity));
+    };
+    const holder = await makeCard('a'.repeat(64));
+    const otherHolder = await makeCard('b'.repeat(64));
+    const credential = SAMPLE_VCS.VALID_BOOST;
+    const wrongHolderJwe = await holder.invoke.createDagJwe(credential, [otherHolder.id.did()]);
+    const validJwe = await holder.invoke.createDagJwe(credential, [holder.id.did()]);
+    const invalidCredentialJwe = await holder.invoke.createDagJwe({}, [holder.id.did()]);
+    const deliveries = [
+        { id: 'wrong-holder', credential: wrongHolderJwe },
+        { id: 'invalid-credential', credential: invalidCredentialJwe },
+        { id: 'valid-sibling', credential: validJwe },
+    ];
+    const client = {
+        profile: { getProfile: { query: vi.fn().mockResolvedValue({ did: holder.id.did() }) } },
+        inbox: {
+            finalize: {
+                mutate: vi
+                    .fn()
+                    .mockResolvedValue({ processed: 3, claimed: 3, errors: 0, deliveries }),
+            },
+            getMyInboxDeliveries: {
+                query: vi.fn().mockResolvedValue({ records: deliveries, hasMore: false }),
+            },
+        },
+    };
+    vi.mocked(getBrainClient).mockResolvedValue(client as never);
+    const plugin = await getLearnCardNetworkPlugin(holder, 'https://network.example');
+    const network = await holder.addPlugin(plugin);
+
+    const result = await network.invoke.finalizeInboxCredentials();
+    expect(result.deliveries).toEqual([{ id: 'valid-sibling', credential }]);
+    expect(result.verifiableCredentials).toEqual([credential]);
+    expect(result.errors).toBe(2);
+
+    const recovery = await network.invoke.recoverInboxCredentials({});
+    expect(recovery.records).toEqual([{ id: 'valid-sibling', credential }]);
+    expect(recovery.failed).toBe(2);
+});

package/src/test/index.test.ts

@@ -757,36 +757,3 @@ describe.skip('LearnCard Network Plugin', () => {
         });
     });
 });
-
-it('recovers valid deliveries despite decryption and validation failures on the page', async () => {
-    const client = {
-        ...getMockClient(),
-        inbox: {
-            getMyInboxDeliveries: {
-                query: vi.fn().mockResolvedValue({
-                    records: [
-                        { id: 'bad-decrypt', credential: 'broken' },
-                        { id: 'bad-vc', credential: {} },
-                        { id: 'good', credential: { type: ['VerifiableCredential'] } },
-                    ],
-                    hasMore: true,
-                    cursor: 'good',
-                }),
-            },
-        },
-    };
-    vi.mocked(getBrainClient).mockResolvedValue(client as any);
-    const wallet = getMockLearnCard();
-    wallet.id.keypair = () => ({ publicKey: 'key' });
-    wallet.invoke.decryptDagJwe = vi.fn(async (credential: any) => {
-        if (credential === 'broken') throw new Error('Cannot decrypt');
-        return credential;
-    });
-    const plugin = await getLearnCardNetworkPlugin(wallet, 'https://network.example');
-    expect(await plugin.methods?.recoverInboxCredentials(wallet, {})).toEqual({
-        records: [{ id: 'good', credential: { type: ['VerifiableCredential'] } }],
-        failed: 2,
-        hasMore: true,
-        cursor: 'good',
-    });
-});

package/src/types.ts

@@ -1,3 +1,4 @@
+import type { SendContractRequest, ConsentFlowContractRequestForProfile } from '@learncard/types';
 import type { LCNClient } from '@learncard/network-brain-client';
 import {
     LCNProfile,
@@ -22,6 +23,10 @@ import {
     ShareLinkOwnerRecoveryOutput,
     ShareLinkPublicState,
     ShareLinkPublicContentView,
+    PutShareLinkAttachmentChunkInput,
+    DeleteShareLinkAttachmentChunksInput,
+    GetShareLinkAttachmentChunkInput,
+    ShareLinkAttachmentChunkOutput,
     AcknowledgeViewOutput,
     Boost,
     BoostQuery,
@@ -113,6 +118,9 @@ import {
     AppStoreListing,
     AppStoreListingCreateType,
     AppStoreListingUpdateType,
+    AppManifest,
+    AppManifestVersion,
+    AppManifestDiff,
     AppListingStatus,
     PromotionLevel,
     PaginatedAppStoreListings,
@@ -309,6 +317,13 @@ export type LearnCardNetworkPluginMethods = {
      * no caller-supplied owner/namespace/object authority is accepted.
      */
     createShareLink: (input: CreateShareLinkInput) => Promise<ShareLinkOwnerCommitOutput>;
+    putShareLinkAttachmentChunk: (input: PutShareLinkAttachmentChunkInput) => Promise<{ ok: true }>;
+    deleteShareLinkAttachmentChunks: (
+        input: DeleteShareLinkAttachmentChunksInput
+    ) => Promise<{ ok: boolean }>;
+    getShareLinkAttachmentChunk: (
+        input: GetShareLinkAttachmentChunkInput
+    ) => Promise<ShareLinkAttachmentChunkOutput>;
     updateShareLink: (input: UpdateShareLinkInput) => Promise<ShareLinkOwnerCommitOutput>;
     revokeShareLink: (input: {
         id: string;
@@ -639,6 +654,7 @@ export type LearnCardNetworkPluginMethods = {
         image?: string;
         expiresAt?: string;
         writers?: string[];
+        recipients?: string[];
         autoboosts?: AutoBoostConfig[];
     }) => Promise<string>;
     addAutoBoostsToContract: (
@@ -646,6 +662,8 @@ export type LearnCardNetworkPluginMethods = {
         autoboosts: AutoBoostConfig[]
     ) => Promise<boolean>;
     removeAutoBoostsFromContract: (contractUri: string, boostUris: string[]) => Promise<boolean>;
+    addContractRecipient: (contractUri: string, recipient: string) => Promise<boolean>;
+    removeContractRecipient: (contractUri: string, recipient: string) => Promise<boolean>;
     getContract: (uri: string) => Promise<ConsentFlowContractDetails>;
     getContracts: (
         options?: Partial<PaginationOptionsType> & { query?: ConsentFlowContractQuery }
@@ -676,6 +694,9 @@ export type LearnCardNetworkPluginMethods = {
             terms: ConsentFlowTerms;
             expiresAt?: string;
             oneTime?: boolean;
+            audienceVersion?: number;
+            /** Bind acceptance to the pending referral the learner reviewed. */
+            expectedRequestId?: string;
         },
         recipientToken?: string
     ) => Promise<{ termsUri: string; redirectUrl?: string }>;
@@ -688,6 +709,7 @@ export type LearnCardNetworkPluginMethods = {
             terms: ConsentFlowTerms;
             expiresAt?: string;
             oneTime?: boolean;
+            audienceVersion?: number;
         }
     ) => Promise<boolean>;
     withdrawConsent: (uri: string) => Promise<boolean>;
@@ -708,7 +730,8 @@ export type LearnCardNetworkPluginMethods = {
 
     syncCredentialsToContract: (
         termsUri: string,
-        categories: Record<string, string[]>
+        categories: Record<string, string[]>,
+        audienceVersion?: number
     ) => Promise<boolean>;
 
     deleteCredentialFromAllContracts: (deletedUris: string[]) => Promise<{
@@ -716,6 +739,11 @@ export type LearnCardNetworkPluginMethods = {
         removedSharedUris: number;
     }>;
 
+    /** Sends one attributed request; identical pending retries are idempotent. */
+    sendContractRequest: (request: SendContractRequest) => Promise<boolean>;
+    /** Target-only denial preserves the request and its referral reference. */
+    denyContractRequest: (contractUri: string) => Promise<boolean>;
+
     sendAiInsightsContractRequest: (
         contractUri: string,
         targetProfileId: string,
@@ -728,31 +756,25 @@ export type LearnCardNetworkPluginMethods = {
         childProfileId?: string
     ) => Promise<boolean>;
 
-    getContractSentRequests: (contractUri: string) => Promise<
-        {
-            profile: LCNProfile;
-            status: 'pending' | 'accepted' | 'denied' | null;
-            readStatus?: 'unseen' | 'seen' | null;
-        }[]
-    >;
+    getContractSentRequests: (
+        contractUri: string
+    ) => Promise<ConsentFlowContractRequestForProfile[]>;
 
     getRequestStatusForProfile: (
         targetProfileId: string,
-        contractId?: string | undefined,
-        contractUri?: string | undefined
-    ) => Promise<{
-        profile: LCNProfile;
-        status: 'pending' | 'accepted' | 'denied' | null;
-        readStatus?: 'unseen' | 'seen' | null;
-    } | null>;
+        contractId?: string,
+        contractUri?: string
+    ) => Promise<ConsentFlowContractRequestForProfile | null>;
 
     getAllContractRequestsForProfile: (targetProfileId: string) => Promise<
-        {
-            contract: ConsentFlowContract & { uri: string };
-            profile: LCNProfile;
-            status: 'pending' | 'accepted' | 'denied' | null;
-            readStatus?: 'unseen' | 'seen' | null;
-        }[]
+        (ConsentFlowContractRequestForProfile & {
+            contract: ConsentFlowContract & {
+                uri: string;
+                name?: string;
+                image?: string;
+                description?: string;
+            };
+        })[]
     >;
 
     getSharedInsightsRequestsForProfile: (targetProfileId: string) => Promise<
@@ -993,12 +1015,63 @@ export type LearnCardNetworkPluginMethods = {
     deleteAppStoreListing: (listingId: string) => Promise<boolean>;
     submitAppStoreListingForReview: (listingId: string) => Promise<boolean>;
     unsubmitAppStoreListing: (listingId: string) => Promise<boolean>;
+    /** Sends held changes to a live app for review; the live listing is unchanged until approval. */
+    submitAppStoreListingUpdate: (listingId: string) => Promise<boolean>;
+    withdrawAppStoreListingUpdate: (listingId: string) => Promise<boolean>;
+    discardAppStoreListingUpdate: (listingId: string) => Promise<boolean>;
     getListingsForIntegration: (
         integrationId: string,
         options?: Partial<PaginationOptionsType>
     ) => Promise<PaginatedAppStoreListings>;
     countListingsForIntegration: (integrationId: string) => Promise<number>;
 
+    submitAppManifest: (
+        integrationId: string,
+        manifest: AppManifest
+    ) => Promise<{
+        version: number;
+        manifestHash: string;
+        diff: AppManifestDiff | null;
+        noop: boolean;
+    }>;
+    getManifestVersions: (
+        integrationId: string,
+        options?: { limit?: number; cursor?: string }
+    ) => Promise<{
+        hasMore: boolean;
+        cursor?: string;
+        records: Pick<
+            AppManifestVersion,
+            'id' | 'version' | 'manifestHash' | 'status' | 'createdAt' | 'activatedAt'
+        >[];
+    }>;
+    getManifestVersion: (
+        integrationId: string,
+        version: number
+    ) => Promise<AppManifestVersion | undefined>;
+    getManifestDiff: (
+        integrationId: string,
+        toVersion: number,
+        fromVersion?: number
+    ) => Promise<AppManifestDiff>;
+    applyManifestVersion: (
+        integrationId: string,
+        version: number,
+        listingId?: string
+    ) => Promise<{
+        applied: boolean;
+        /** True when the listing is live and the new version is waiting for review. */
+        pendingReview?: boolean;
+        version: number;
+        reconciled: {
+            templatesUpserted: number;
+            templatesSkipped: number;
+            contractsUpserted: number;
+            contractsSkipped: number;
+            signingAuthorityEnsured: boolean;
+        };
+    }>;
+
     browseAppStore: (options?: {
         limit?: number;
         cursor?: string;
@@ -1042,7 +1115,9 @@ export type LearnCardNetworkPluginMethods = {
         limit?: number;
         cursor?: string;
         status?: AppListingStatus;
+        pendingUpdatesOnly?: boolean;
     }) => Promise<PaginatedAppStoreListings>;
+    adminReviewListingUpdate: (listingId: string, approve: boolean) => Promise<boolean>;
 
     // App Store Boost Management
     addBoostToApp: (listingId: string, boostUri: string, templateAlias: string) => Promise<boolean>;