@learncard/cli 3.6.8 → 4.0.0

package/src/clr.ts

@@ -1,119 +0,0 @@
-import fs from 'node:fs/promises';
-import type { Command } from 'commander';
-
-import {
-    connect,
-    loadProject,
-    resolveServices,
-    PRODUCTION_NETWORK,
-    type ProjectOptions,
-} from './project';
-import { out } from './out';
-import { validateClr, type ClrValidationProfile } from './clr/validate';
-
-export type ClrValidateOptions = ProjectOptions & {
-    profile?: string;
-    dryRunSign?: boolean;
-    allowProduction?: boolean;
-};
-
-const PROFILES: readonly ClrValidationProfile[] = ['provisional', 'official'];
-
-const parseProfile = (value?: string): ClrValidationProfile | undefined => {
-    if (value === undefined) return undefined;
-    if ((PROFILES as readonly string[]).includes(value)) return value as ClrValidationProfile;
-    throw new Error(`Unknown --profile "${value}". Use provisional or official.`);
-};
-
-/**
- * The signing key is derived from `credential.issuer`, so a transcript that
- * still carries a placeholder issuer would fail to sign for a reason unrelated
- * to its content. The dry run signs as this project's wallet instead.
- */
-export const withIssuer = (
-    credential: Record<string, unknown>,
-    did: string
-): Record<string, unknown> => {
-    const issuer = credential.issuer;
-    if (issuer && typeof issuer === 'object' && !Array.isArray(issuer))
-        return { ...credential, issuer: { ...(issuer as Record<string, unknown>), id: did } };
-    return { ...credential, issuer: did };
-};
-
-export const runClrValidate = async (file: string, options: ClrValidateOptions): Promise<void> => {
-    const text = await fs.readFile(file, 'utf8');
-    let json: unknown;
-    try {
-        json = JSON.parse(text);
-    } catch (error) {
-        const message = error instanceof Error ? error.message : String(error);
-        throw new Error(`Invalid JSON in ${file}: ${message}`, { cause: error });
-    }
-
-    const profile = parseProfile(options.profile);
-    const { errors, warnings, summary } = validateClr(json, { profile });
-
-    for (const error of errors) out.log(`✖ ${error}`);
-    for (const warning of warnings) out.log(`⚠ ${warning}`);
-
-    const ok = errors.length === 0;
-    if (!ok) process.exitCode = 1;
-    let signOk = true;
-
-    if (options.dryRunSign) {
-        if (!ok) {
-            out.log('Skipping --dry-run-sign: fix validation errors first.');
-        } else {
-            const project = await loadProject(process.cwd());
-            const services = resolveServices(project.env, options.network);
-            if (services.network === PRODUCTION_NETWORK && !options.allowProduction) {
-                throw new Error(
-                    'Refusing --dry-run-sign against production. Pass --network staging or --allow-production.'
-                );
-            }
-            const learnCard = await connect(project, options);
-            const signed = await learnCard.invoke.issueCredential(
-                withIssuer(json as Record<string, unknown>, learnCard.id.did()) as never
-            );
-            const verification = await learnCard.invoke.verifyCredential(signed);
-            out.log('Signed: true (dry run only — nothing was sent or stored)');
-            for (const check of verification.checks) out.log(`✓ ${check}`);
-            for (const warning of verification.warnings) out.log(`! ${warning}`);
-            for (const error of verification.errors) out.log(`✗ ${error}`);
-            if (verification.errors.length) {
-                signOk = false;
-                process.exitCode = 1;
-            }
-            out.set({ signed: true, verification });
-        }
-    }
-
-    out.set({ ok: ok && signOk, errors, warnings, summary });
-};
-
-export const registerClrCommand = (
-    program: Command,
-    run: (
-        command: string,
-        options: { json?: boolean },
-        action: (didkit: Promise<Buffer>) => Promise<void>,
-        wrap?: boolean
-    ) => Promise<void>
-): void => {
-    const clr = program.command('clr').description('CLR 2.0 transcript tools.');
-    clr.command('validate <file>')
-        .description('Validate a CLR 2.0 transcript file against schema and issuer-profile rules.')
-        .option('--profile <name>', 'provisional or official profile checks')
-        .option(
-            '--dry-run-sign',
-            'sign + verify in memory to catch signing failures; never sends or stores'
-        )
-        .option('--allow-production', 'allow --dry-run-sign against the production network')
-        .option('--network <url>', 'network tRPC URL or staging (default: production)')
-        .option('--json', 'print a single JSON result on stdout')
-        .action((file, options) =>
-            run('clr validate', options, async didkit => {
-                await runClrValidate(file, { ...options, didkit });
-            })
-        );
-};

package/src/consent-contract.ts

@@ -1,116 +0,0 @@
-import {
-    connect,
-    createPrompts,
-    ensureIdentity,
-    ensureProfile,
-    KEYS,
-    loadProject,
-    localizeSnippet,
-    resolveServices,
-    saveProject,
-    STAGING_NETWORK,
-    PRODUCTION_NETWORK,
-    type ProjectOptions,
-    appUrlFor,
-} from './project';
-import {
-    CREATE_CONTRACT_MJS,
-    CONSENT_CALLBACK_MJS,
-    READ_USER_DATA_MJS,
-    ISSUE_THROUGH_CONTRACT_MJS,
-} from './generated/snippets';
-import { writeSnippet } from './snippet-files';
-import { out } from './out';
-
-export const consentUrl = (uri: string, returnTo: string, network: string): string => {
-    const url = new URL('/consent-flow', appUrlFor(network));
-    url.searchParams.set('uri', uri);
-    url.searchParams.set('returnTo', returnTo);
-    return url.toString();
-};
-
-export const runConsentContract = async (
-    options: ProjectOptions & {
-        redirectUrl?: string;
-        description?: string;
-        needsGuardianConsent?: boolean;
-    }
-): Promise<void> => {
-    const project = await loadProject(process.cwd());
-    const returnTo =
-        options.redirectUrl || project.env.RETURN_TO || 'http://localhost:3000/consent-callback';
-    if (!['http:', 'https:'].includes(new URL(returnTo).protocol)) {
-        throw new Error('Redirect URL must use HTTP or HTTPS.');
-    }
-    const identity = await ensureIdentity(project, options);
-    const learnCard = await connect(project, options);
-    await ensureProfile(learnCard, identity, project);
-    let uri = project.env[KEYS.CONTRACT_URI];
-    if (!uri) {
-        const prompts = createPrompts(options.yes);
-        let name: string;
-        try {
-            name = options.name ?? (await prompts.ask('Contract name', identity.displayName));
-        } finally {
-            prompts.close();
-        }
-        const contract = {
-            name,
-            description:
-                options.description ??
-                'Allow us to read your name and achievements and send achievements.',
-            ...(options.needsGuardianConsent ? { needsGuardianConsent: true } : {}),
-            redirectUrl: returnTo,
-            contract: {
-                read: {
-                    personal: { name: { required: false } },
-                    credentials: { categories: { Achievement: { required: false } } },
-                },
-                write: {
-                    personal: {},
-                    credentials: { categories: { Achievement: { required: false } } },
-                },
-            },
-        };
-        uri = await learnCard.invoke.createContract(contract);
-        out.log('Created your consent contract.');
-    } else {
-        out.log('Reusing your saved consent contract.');
-    }
-    await saveProject(project, { [KEYS.CONTRACT_URI]: uri, RETURN_TO: returnTo });
-    const services = resolveServices(project.env, options.network);
-    const files: string[] = [];
-    for (const [file, source] of Object.entries({
-        'create-contract.mjs': CREATE_CONTRACT_MJS,
-        'consent-callback.mjs': CONSENT_CALLBACK_MJS,
-        'read-user-data.mjs': READ_USER_DATA_MJS,
-        'issue-through-contract.mjs': ISSUE_THROUGH_CONTRACT_MJS,
-    })) {
-        // The canonical tutorial uses a destructured SECURE_SEED; normalize only for localization.
-        const localized =
-            services.network === PRODUCTION_NETWORK
-                ? source
-                : localizeSnippet(
-                      source.replaceAll(
-                          'seed: SECURE_SEED, network: true',
-                          'seed: process.env.SECURE_SEED, network: true'
-                      ),
-                      services
-                  );
-        if (await writeSnippet(file, localized)) files.push(`./${file}`);
-    }
-    const contractConsentUrl = consentUrl(uri, returnTo, services.network);
-    out.log(contractConsentUrl);
-    if (![PRODUCTION_NETWORK, STAGING_NETWORK].includes(services.network)) {
-        out.log(
-            'Note: this is a production app URL; use an app connected to your local network to consent.'
-        );
-    }
-    out.log(
-        'The tutorial create-contract.mjs creates a new contract and requires HTTPS; reuse CONTRACT_URI for this dev setup.'
-    );
-    out.log('Read scripts require a verified CONSENT_VP, not a bare DID.');
-    out.log('Next: node --env-file=.env consent-callback.mjs');
-    out.log('See the contract in the app: npx @learncard/cli open contract');
-    out.set({ contractUri: uri, consentUrl: contractConsentUrl, returnTo, files });
-};