@canonmsg/backend-contracts 2.0.0 → 2.1.0

package/dist/cjs/diffRedaction.js

@@ -0,0 +1,73 @@
+"use strict";
+// Sensitive-content protection for approval diffs.
+//
+// Approval diffs include PRE-IMAGE context lines and ride on a message readable
+// by every conversation member, so a secret-bearing file would leak existing
+// secrets. The emitting host applies this before sending (it owns the file
+// context); the server (@canonmsg/functions) mirrors the same suppression
+// defensively. Single-sourced here in the zero-dependency backend-contracts
+// leaf so @canonmsg/core (client-side sanitizer) and Functions (server mirror)
+// share one implementation — Functions deliberately does not depend on core.
+//
+// Two deliberately narrow mechanisms so ordinary code diffs stay readable:
+//   1. Path suppression — files whose path screams "secret store" lose their
+//      hunk text entirely; entry/status/counts survive.
+//   2. High-confidence token redaction — prefix-anchored credential shapes
+//      (AWS/GitHub/Slack/Google/OpenAI-style keys, JWTs) are replaced with
+//      `[redacted]` inside remaining hunks. Private-key blocks suppress the
+//      whole file (redacting a PEM body line-by-line is fragile).
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PRIVATE_KEY_BLOCK = void 0;
+exports.isSensitiveDiffPath = isSensitiveDiffPath;
+exports.redactSecretTokens = redactSecretTokens;
+const SENSITIVE_DIFF_BASENAME_PATTERNS = [
+    /^\.env(\..+)?$/i,
+    /^\.npmrc$/i,
+    /^\.netrc$/i,
+    /^\.pgpass$/i,
+    /^\.git-credentials$/i,
+    /^\.htpasswd$/i,
+    /\.(pem|key|p12|pfx|keystore|jks|tfvars)$/i,
+    /^id_(rsa|dsa|ecdsa|ed25519)(\..+)?$/i,
+    // Word-bounded so "secrets.json" and "client_secret.yaml" match but
+    // "secretary.ts" does not.
+    /(^|[-_.])(credentials?|secrets?)([-_.]|$)/i,
+    /^serviceaccount.*\.json$/i,
+    /^kubeconfig(\..+)?$/i,
+];
+// Directory components that mark everything beneath them sensitive
+// (~/.ssh/config, .aws/credentials, infra/secrets/db.yaml, …).
+const SENSITIVE_DIFF_SEGMENT_PATTERNS = [
+    /^\.ssh$/i,
+    /^\.aws$/i,
+    /^\.gnupg$/i,
+    /^\.kube$/i,
+    /^secrets?$/i,
+    /^credentials?$/i,
+];
+const SECRET_TOKEN_PATTERNS = [
+    /AKIA[0-9A-Z]{16}/g,
+    /gh[pousr]_[A-Za-z0-9]{36,255}/g,
+    /github_pat_[A-Za-z0-9_]{22,255}/g,
+    /xox[baprs]-[A-Za-z0-9-]{10,250}/g,
+    /AIza[0-9A-Za-z_-]{35}/g,
+    /sk-[A-Za-z0-9_-]{20,250}/g,
+    /eyJ[A-Za-z0-9_-]{10,}\.eyJ[A-Za-z0-9_-]{10,}\.[A-Za-z0-9_-]{10,}/g,
+];
+/** Matches the header line of a PEM private-key block. */
+exports.PRIVATE_KEY_BLOCK = /-----BEGIN [A-Z0-9 ]*PRIVATE KEY( BLOCK)?-----/;
+/** True when a diff file path (or rename source) matches the sensitive list. */
+function isSensitiveDiffPath(path) {
+    const segments = path.split('/').filter(Boolean);
+    const basename = segments.pop() ?? path;
+    return SENSITIVE_DIFF_BASENAME_PATTERNS.some((pattern) => pattern.test(basename))
+        || segments.some((segment) => SENSITIVE_DIFF_SEGMENT_PATTERNS.some((pattern) => pattern.test(segment)));
+}
+/** Replace high-confidence credential shapes inside hunk text with `[redacted]`. */
+function redactSecretTokens(text) {
+    let redacted = text;
+    for (const pattern of SECRET_TOKEN_PATTERNS) {
+        redacted = redacted.replace(pattern, '[redacted]');
+    }
+    return redacted;
+}

package/dist/cjs/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./diffRedaction.js"), exports);
 __exportStar(require("./media.js"), exports);
 __exportStar(require("./message.js"), exports);
 __exportStar(require("./runtimeCardFields.js"), exports);

package/dist/cjs/message.js

@@ -61,7 +61,8 @@ function normalizeContentType(value) {
         || value === 'audio'
         || value === 'video'
         || value === 'file'
-        || value === 'contact_card') {
+        || value === 'contact_card'
+        || value === 'interaction') {
         return value;
     }
     throw new Error('Message is missing canonical contentType');
@@ -110,6 +111,41 @@ function normalizeContactCard(value) {
         card.lifecycleState = value.lifecycleState;
     return card;
 }
+const INTERACTION_KINDS = [
+    'contact', 'approval', 'input', 'plan', 'card',
+];
+function normalizeInteraction(value) {
+    if (!isRecord(value))
+        return undefined;
+    if (!INTERACTION_KINDS.includes(value.kind))
+        return undefined;
+    if (typeof value.requestId !== 'string' || value.requestId.length === 0)
+        return undefined;
+    const envelope = {
+        kind: value.kind,
+        requestId: value.requestId,
+        interactive: value.interactive === true,
+    };
+    if (typeof value.responseUserId === 'string')
+        envelope.responseUserId = value.responseUserId;
+    if (typeof value.expiresAt === 'string')
+        envelope.expiresAt = value.expiresAt;
+    if (typeof value.schemaVersion === 'string')
+        envelope.schemaVersion = value.schemaVersion;
+    if (isRecord(value.preview)) {
+        const preview = {};
+        if (typeof value.preview.title === 'string')
+            preview.title = value.preview.title;
+        if (Array.isArray(value.preview.blockKinds)) {
+            preview.blockKinds = value.preview.blockKinds.filter((entry) => typeof entry === 'string');
+        }
+        envelope.preview = preview;
+    }
+    if (isRecord(value.response)) {
+        envelope.response = value.response;
+    }
+    return envelope;
+}
 function serializeStoredMessage(input) {
     const { data } = input;
     const attachments = data.attachments === undefined
@@ -153,6 +189,13 @@ function serializeStoredMessage(input) {
     if (runtimeCard) {
         result.runtimeCard = runtimeCard;
     }
+    const interaction = normalizeInteraction(data.interaction);
+    if (interaction) {
+        result.interaction = interaction;
+    }
+    if (typeof data.body === 'string') {
+        result.body = data.body;
+    }
     const reactions = normalizeReactions(data.reactions);
     if (reactions) {
         result.reactions = reactions;

package/dist/diffRedaction.d.ts

@@ -0,0 +1,6 @@
+/** Matches the header line of a PEM private-key block. */
+export declare const PRIVATE_KEY_BLOCK: RegExp;
+/** True when a diff file path (or rename source) matches the sensitive list. */
+export declare function isSensitiveDiffPath(path: string): boolean;
+/** Replace high-confidence credential shapes inside hunk text with `[redacted]`. */
+export declare function redactSecretTokens(text: string): string;

package/dist/diffRedaction.js

@@ -0,0 +1,68 @@
+// Sensitive-content protection for approval diffs.
+//
+// Approval diffs include PRE-IMAGE context lines and ride on a message readable
+// by every conversation member, so a secret-bearing file would leak existing
+// secrets. The emitting host applies this before sending (it owns the file
+// context); the server (@canonmsg/functions) mirrors the same suppression
+// defensively. Single-sourced here in the zero-dependency backend-contracts
+// leaf so @canonmsg/core (client-side sanitizer) and Functions (server mirror)
+// share one implementation — Functions deliberately does not depend on core.
+//
+// Two deliberately narrow mechanisms so ordinary code diffs stay readable:
+//   1. Path suppression — files whose path screams "secret store" lose their
+//      hunk text entirely; entry/status/counts survive.
+//   2. High-confidence token redaction — prefix-anchored credential shapes
+//      (AWS/GitHub/Slack/Google/OpenAI-style keys, JWTs) are replaced with
+//      `[redacted]` inside remaining hunks. Private-key blocks suppress the
+//      whole file (redacting a PEM body line-by-line is fragile).
+const SENSITIVE_DIFF_BASENAME_PATTERNS = [
+    /^\.env(\..+)?$/i,
+    /^\.npmrc$/i,
+    /^\.netrc$/i,
+    /^\.pgpass$/i,
+    /^\.git-credentials$/i,
+    /^\.htpasswd$/i,
+    /\.(pem|key|p12|pfx|keystore|jks|tfvars)$/i,
+    /^id_(rsa|dsa|ecdsa|ed25519)(\..+)?$/i,
+    // Word-bounded so "secrets.json" and "client_secret.yaml" match but
+    // "secretary.ts" does not.
+    /(^|[-_.])(credentials?|secrets?)([-_.]|$)/i,
+    /^serviceaccount.*\.json$/i,
+    /^kubeconfig(\..+)?$/i,
+];
+// Directory components that mark everything beneath them sensitive
+// (~/.ssh/config, .aws/credentials, infra/secrets/db.yaml, …).
+const SENSITIVE_DIFF_SEGMENT_PATTERNS = [
+    /^\.ssh$/i,
+    /^\.aws$/i,
+    /^\.gnupg$/i,
+    /^\.kube$/i,
+    /^secrets?$/i,
+    /^credentials?$/i,
+];
+const SECRET_TOKEN_PATTERNS = [
+    /AKIA[0-9A-Z]{16}/g,
+    /gh[pousr]_[A-Za-z0-9]{36,255}/g,
+    /github_pat_[A-Za-z0-9_]{22,255}/g,
+    /xox[baprs]-[A-Za-z0-9-]{10,250}/g,
+    /AIza[0-9A-Za-z_-]{35}/g,
+    /sk-[A-Za-z0-9_-]{20,250}/g,
+    /eyJ[A-Za-z0-9_-]{10,}\.eyJ[A-Za-z0-9_-]{10,}\.[A-Za-z0-9_-]{10,}/g,
+];
+/** Matches the header line of a PEM private-key block. */
+export const PRIVATE_KEY_BLOCK = /-----BEGIN [A-Z0-9 ]*PRIVATE KEY( BLOCK)?-----/;
+/** True when a diff file path (or rename source) matches the sensitive list. */
+export function isSensitiveDiffPath(path) {
+    const segments = path.split('/').filter(Boolean);
+    const basename = segments.pop() ?? path;
+    return SENSITIVE_DIFF_BASENAME_PATTERNS.some((pattern) => pattern.test(basename))
+        || segments.some((segment) => SENSITIVE_DIFF_SEGMENT_PATTERNS.some((pattern) => pattern.test(segment)));
+}
+/** Replace high-confidence credential shapes inside hunk text with `[redacted]`. */
+export function redactSecretTokens(text) {
+    let redacted = text;
+    for (const pattern of SECRET_TOKEN_PATTERNS) {
+        redacted = redacted.replace(pattern, '[redacted]');
+    }
+    return redacted;
+}

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export * from './diffRedaction.js';
 export * from './media.js';
 export * from './message.js';
 export * from './runtimeCardFields.js';

package/dist/index.js

@@ -1,3 +1,4 @@
+export * from './diffRedaction.js';
 export * from './media.js';
 export * from './message.js';
 export * from './runtimeCardFields.js';

package/dist/message.d.ts

@@ -1,7 +1,7 @@
 import { MediaAttachment } from './media.js';
 export type SerializedSenderType = 'human' | 'ai_agent';
 export type SerializedAgentClientType = 'claude-code' | 'openclaw' | 'codex' | 'hermes' | 'generic';
-export type SerializedContentType = 'text' | 'image' | 'audio' | 'video' | 'file' | 'contact_card';
+export type SerializedContentType = 'text' | 'image' | 'audio' | 'video' | 'file' | 'contact_card' | 'interaction';
 export interface ForwardedFrom {
     sourceConversationId: string;
     messageId: string;
@@ -40,8 +40,38 @@ export interface SerializedMessage {
     contactCard?: SerializedContactCard;
     /** Durable canon.card.v1 runtime card content, passed through opaquely. */
     runtimeCard?: Record<string, unknown>;
+    /**
+     * Plaintext, server-authorized interaction envelope for `contentType:
+     * 'interaction'` messages (card / input / approval / plan / contact). The
+     * authorization contract (`response`) and preview live here; the opaque
+     * request payload rides in `body`.
+     */
+    interaction?: SerializedInteraction;
+    /** Opaque interaction payload (JSON string or ciphertext); never parsed here. */
+    body?: string;
     reactions?: SerializedReactions;
 }
+export type SerializedInteractionKind = 'contact' | 'approval' | 'input' | 'plan' | 'card';
+export interface SerializedInteraction {
+    kind: SerializedInteractionKind;
+    requestId: string;
+    interactive: boolean;
+    responseUserId?: string;
+    expiresAt?: string;
+    schemaVersion?: string;
+    preview?: {
+        title?: string;
+        blockKinds?: string[];
+    };
+    response?: {
+        actionIds?: string[];
+        actionFields?: Record<string, unknown>;
+        questions?: Array<{
+            id: string;
+            sensitive?: boolean;
+        }>;
+    };
+}
 export interface SerializeMessageInput {
     id: string;
     data: Record<string, unknown>;

package/dist/message.js

@@ -58,7 +58,8 @@ function normalizeContentType(value) {
         || value === 'audio'
         || value === 'video'
         || value === 'file'
-        || value === 'contact_card') {
+        || value === 'contact_card'
+        || value === 'interaction') {
         return value;
     }
     throw new Error('Message is missing canonical contentType');
@@ -107,6 +108,41 @@ function normalizeContactCard(value) {
         card.lifecycleState = value.lifecycleState;
     return card;
 }
+const INTERACTION_KINDS = [
+    'contact', 'approval', 'input', 'plan', 'card',
+];
+function normalizeInteraction(value) {
+    if (!isRecord(value))
+        return undefined;
+    if (!INTERACTION_KINDS.includes(value.kind))
+        return undefined;
+    if (typeof value.requestId !== 'string' || value.requestId.length === 0)
+        return undefined;
+    const envelope = {
+        kind: value.kind,
+        requestId: value.requestId,
+        interactive: value.interactive === true,
+    };
+    if (typeof value.responseUserId === 'string')
+        envelope.responseUserId = value.responseUserId;
+    if (typeof value.expiresAt === 'string')
+        envelope.expiresAt = value.expiresAt;
+    if (typeof value.schemaVersion === 'string')
+        envelope.schemaVersion = value.schemaVersion;
+    if (isRecord(value.preview)) {
+        const preview = {};
+        if (typeof value.preview.title === 'string')
+            preview.title = value.preview.title;
+        if (Array.isArray(value.preview.blockKinds)) {
+            preview.blockKinds = value.preview.blockKinds.filter((entry) => typeof entry === 'string');
+        }
+        envelope.preview = preview;
+    }
+    if (isRecord(value.response)) {
+        envelope.response = value.response;
+    }
+    return envelope;
+}
 export function serializeStoredMessage(input) {
     const { data } = input;
     const attachments = data.attachments === undefined
@@ -150,6 +186,13 @@ export function serializeStoredMessage(input) {
     if (runtimeCard) {
         result.runtimeCard = runtimeCard;
     }
+    const interaction = normalizeInteraction(data.interaction);
+    if (interaction) {
+        result.interaction = interaction;
+    }
+    if (typeof data.body === 'string') {
+        result.body = data.body;
+    }
     const reactions = normalizeReactions(data.reactions);
     if (reactions) {
         result.reactions = reactions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canonmsg/backend-contracts",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Canon backend contract helpers shared by Functions and stream-service",
   "type": "module",
   "main": "dist/cjs/index.js",