monora-ai 2.0.0 → 2.1.3

package/dist/attestation.js

@@ -208,12 +208,34 @@ function extractComplianceSummary(report) {
     const tokenUsage = report.token_usage || {};
     return {
         policy_violations: Array.isArray(violations) ? violations.length : 0,
-        data_handling_issues: 0, // TODO: Extract from data handling events
+        data_handling_issues: countDataHandlingIssues(violations),
         unknown_models: modelCompliance.unknown_models_used || [],
         forbidden_models_blocked: (modelCompliance.forbidden_models_blocked || []).length,
         total_tokens: tokenUsage.total_tokens || 0,
     };
 }
+function countDataHandlingIssues(violations) {
+    if (!Array.isArray(violations)) {
+        return 0;
+    }
+    let count = 0;
+    for (const violation of violations) {
+        if (!violation || typeof violation !== 'object') {
+            continue;
+        }
+        const policy = violation.policy ||
+            violation.policy_name ||
+            violation.policyId ||
+            violation.policy_id;
+        if (!policy) {
+            continue;
+        }
+        if (String(policy).toLowerCase().startsWith('data_handling')) {
+            count += 1;
+        }
+    }
+    return count;
+}
 function findGpg() {
     const candidates = ['gpg', 'gpg2'];
     for (const candidate of candidates) {

package/dist/attribution.d.ts

@@ -0,0 +1,349 @@
+/**
+ * Attribution and project registration for Monora SDK.
+ *
+ * This module provides opt-in attribution and telemetry features to help
+ * improve the SDK and understand usage patterns.
+ *
+ * @example
+ * ```typescript
+ * import { registerProject, reportUsage, enableTelemetry } from 'monora-ai';
+ *
+ * // Register your project (optional but encouraged)
+ * registerProject({
+ *   company: 'Acme Corp',
+ *   role: 'ML Engineer',
+ *   email: 'dev@acme.com',
+ *   source: 'npm',
+ *   useCase: 'Customer Support AI',
+ * });
+ *
+ * // Enable and report usage (opt-in)
+ * enableTelemetry({ sendData: true });
+ * reportUsage({ framework: 'nextjs', environment: 'production' });
+ * ```
+ */
+/**
+ * Project registration data.
+ */
+export interface ProjectRegistration {
+    /** Company or organization name */
+    company?: string;
+    /** Your role (e.g., "ML Engineer", "DevOps", "CTO") */
+    role?: string;
+    /** Work email for best practices updates (included in registration payload when enabled) */
+    email?: string;
+    /** How you found Monora (npm, pypi, github, blog, referral) */
+    source?: string;
+    /** Brief description of your use case */
+    useCase?: string;
+    /** Team size (solo, small, medium, large) */
+    teamSize?: 'solo' | 'small' | 'medium' | 'large' | string;
+    /** Business owner for compliance/audit purposes */
+    businessOwner?: string;
+    /** Data categories touched (e.g., ["PII", "financial"]) */
+    dataCategories?: string[];
+    /** Additional metadata tags */
+    tags?: Record<string, string>;
+    /** Registration timestamp */
+    registeredAt?: string;
+}
+/**
+ * Anonymous usage report data.
+ */
+export interface UsageReport {
+    /** Anonymous installation ID */
+    installId: string;
+    /** SDK version */
+    sdkVersion: string;
+    /** Node.js version */
+    nodeVersion: string;
+    /** Operating system name */
+    osName: string;
+    /** Operating system version */
+    osVersion: string;
+    /** Framework being used */
+    framework?: string;
+    /** Features used in this session */
+    featuresUsed: string[];
+    /** Deployment environment */
+    environment: string;
+    /** Report timestamp */
+    reportedAt?: string;
+}
+/**
+ * Audit metadata for compliance purposes.
+ */
+export interface AuditMetadata {
+    /** Name of the AI use case */
+    useCaseName?: string;
+    /** Business owner responsible for this use case */
+    businessOwner?: string;
+    /** Categories of data processed */
+    dataCategories?: string[];
+    /** Risk level */
+    riskLevel?: 'low' | 'medium' | 'high' | 'critical';
+    /** Applicable compliance frameworks */
+    complianceFrameworks?: string[];
+    /** Date of last compliance review */
+    reviewDate?: string;
+    /** Name of reviewer */
+    reviewer?: string;
+    /** Additional notes */
+    notes?: string;
+}
+/**
+ * Attribution event data.
+ */
+export interface AttributionEvent {
+    type: 'project_registered' | 'usage_reported';
+    data: ProjectRegistration | UsageReport;
+}
+/**
+ * Attribution event callback.
+ */
+export type AttributionCallback = (event: AttributionEvent) => void;
+/**
+ * Get or create a persistent anonymous installation ID.
+ *
+ * The ID is a hash of a random UUID, stored locally.
+ * No personally identifiable information is included.
+ *
+ * @returns Anonymous installation ID string.
+ */
+export declare function getInstallId(): string;
+/**
+ * Register your project with Monora (optional but encouraged).
+ *
+ * This helps us understand who is using the SDK and improve the product.
+ * All fields are optional. Data is only sent if telemetry is enabled.
+ *
+ * @param options - Registration options.
+ * @returns ProjectRegistration object.
+ *
+ * @example
+ * ```typescript
+ * registerProject({
+ *   company: 'Acme Corp',
+ *   role: 'ML Engineer',
+ *   useCase: 'Customer Support AI',
+ *   dataCategories: ['customer_data'],
+ * });
+ * ```
+ */
+export declare function registerProject(options: Omit<ProjectRegistration, 'registeredAt'>): ProjectRegistration;
+/**
+ * Get the current project registration.
+ *
+ * @returns Current ProjectRegistration or null if not registered.
+ */
+export declare function getRegistration(): ProjectRegistration | null;
+/**
+ * Telemetry options.
+ */
+export interface TelemetryOptions {
+    /** Whether to send anonymous data to Monora */
+    sendData?: boolean;
+    /** Data residency region ("us", "eu", or null) */
+    dataResidency?: string | null;
+}
+/**
+ * Enable anonymous usage telemetry.
+ *
+ * By default, telemetry data stays local. Set sendData=true to
+ * share anonymous usage data with Monora to help improve the SDK.
+ *
+ * @param options - Telemetry options.
+ *
+ * @example
+ * ```typescript
+ * enableTelemetry({ sendData: true, dataResidency: 'eu' });
+ * ```
+ */
+export declare function enableTelemetry(options?: TelemetryOptions): void;
+/**
+ * Disable usage telemetry.
+ *
+ * No data will be collected or sent after this call.
+ */
+export declare function disableTelemetry(): void;
+/**
+ * Check if telemetry is enabled.
+ *
+ * @returns True if telemetry is enabled.
+ */
+export declare function isTelemetryEnabled(): boolean;
+/**
+ * Record that a feature was used (internal).
+ *
+ * This is called internally by SDK components to track which
+ * features are being used. No sensitive data is recorded.
+ *
+ * @param feature - Feature name (e.g., "signing", "wal", "circuit_breaker").
+ */
+export declare function recordFeatureUsage(feature: string): void;
+/**
+ * Get list of features used in this session.
+ *
+ * @returns Sorted list of feature names.
+ */
+export declare function getFeaturesUsed(): string[];
+/**
+ * Usage report options.
+ */
+export interface UsageReportOptions {
+    /** Framework being used (e.g., "nextjs", "express") */
+    framework?: string;
+    /** Deployment environment */
+    environment?: string;
+}
+/**
+ * Build an anonymous usage report.
+ *
+ * @param options - Report options.
+ * @returns UsageReport object with anonymous data.
+ */
+export declare function buildUsageReport(options?: UsageReportOptions): UsageReport;
+/**
+ * Report anonymous usage data (if telemetry enabled).
+ *
+ * This sends anonymous usage data to help improve the SDK.
+ * Only called if telemetry is enabled with sendData=true.
+ *
+ * @param options - Report options.
+ * @returns UsageReport object.
+ *
+ * @example
+ * ```typescript
+ * enableTelemetry({ sendData: true });
+ * reportUsage({ framework: 'nextjs', environment: 'production' });
+ * ```
+ */
+export declare function reportUsage(options?: UsageReportOptions): UsageReport;
+/**
+ * Register a callback for attribution events.
+ *
+ * Use this to hook into attribution events for your own logging
+ * or monitoring stack.
+ *
+ * @param callback - Function called with event data.
+ * @returns Unsubscribe function.
+ *
+ * @example
+ * ```typescript
+ * const unsubscribe = onAttributionEvent((event) => {
+ *   console.log(`Attribution event: ${event.type}`);
+ * });
+ * // Later: unsubscribe();
+ * ```
+ */
+export declare function onAttributionEvent(callback: AttributionCallback): () => void;
+/**
+ * Set data residency region.
+ *
+ * @param region - Region code ("us", "eu", or "none" to disable sending).
+ */
+export declare function setDataResidency(region: string): void;
+/**
+ * Get current data residency setting.
+ *
+ * @returns Region code or null.
+ */
+export declare function getDataResidency(): string | null;
+/**
+ * Configure HTTP settings from Monora config (internal).
+ *
+ * Called by runtime.init() to pass endpoint configuration.
+ */
+export declare function configureHttp(config: {
+    endpoints?: {
+        us?: string;
+        eu?: string;
+    };
+    apiKeyEnv?: string;
+    timeoutSec?: number;
+    retryAttempts?: number;
+    backoffBaseSec?: number;
+}): void;
+/**
+ * Send a telemetry event (e.g., startup, shutdown, error).
+ *
+ * This is called internally by the SDK to track usage patterns.
+ * Only sends if telemetry is enabled with sendData=true.
+ *
+ * @param options - Event options.
+ */
+export declare function sendTelemetryEvent(options: {
+    eventType: 'startup' | 'shutdown' | 'heartbeat' | 'error';
+    eventData?: Record<string, unknown>;
+    framework?: string;
+    environment?: string;
+}): void;
+/**
+ * Set audit metadata for compliance purposes.
+ *
+ * This metadata is included in compliance reports and can be used
+ * to satisfy audit requirements for SOC 2, GDPR, ISO 27001, etc.
+ *
+ * @param metadata - Audit metadata.
+ * @returns AuditMetadata object.
+ *
+ * @example
+ * ```typescript
+ * setAuditMetadata({
+ *   useCaseName: 'Customer Support AI',
+ *   businessOwner: 'Jane Smith',
+ *   dataCategories: ['customer_data', 'PII'],
+ *   riskLevel: 'medium',
+ *   complianceFrameworks: ['SOC2', 'GDPR'],
+ * });
+ * ```
+ */
+export declare function setAuditMetadata(metadata: AuditMetadata): AuditMetadata;
+/**
+ * Get current audit metadata.
+ *
+ * @returns AuditMetadata object or null.
+ */
+export declare function getAuditMetadata(): AuditMetadata | null;
+/**
+ * Check if first-run registration prompt has been shown.
+ *
+ * @returns True if already prompted, false otherwise.
+ */
+export declare function hasShownFirstRunPrompt(): boolean;
+/**
+ * Check if user has registered (either via postinstall or programmatically).
+ *
+ * @returns True if registered, false otherwise.
+ */
+export declare function hasRegistration(): boolean;
+/**
+ * Prompt the user to register their project (interactive, optional).
+ *
+ * @param options - Optional context about the environment.
+ * @returns True if registration was completed, false otherwise.
+ */
+export declare function promptForRegistration(options?: {
+    environment?: string;
+    force?: boolean;
+    silent?: boolean;
+}): Promise<boolean>;
+/**
+ * Show first-run registration prompt if needed.
+ *
+ * This logs a one-time message suggesting the user run `npx monora init`
+ * to register their project for best practices updates. The message is
+ * only shown once per installation.
+ *
+ * @param options - Optional context about the environment.
+ * @returns True if prompt was shown, false if skipped.
+ */
+export declare function showFirstRunPromptIfNeeded(options?: {
+    environment?: string;
+    silent?: boolean;
+}): boolean;
+/**
+ * Reset the first-run prompt state (for testing).
+ */
+export declare function resetFirstRunPrompt(): void;
+//# sourceMappingURL=attribution.d.ts.map

package/dist/attribution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attribution.d.ts","sourceRoot":"","sources":["../src/attribution.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAmDH;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,mCAAmC;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4FAA4F;IAC5F,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAC;IAC1D,mDAAmD;IACnD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,2DAA2D;IAC3D,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,+BAA+B;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B,6BAA6B;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,kBAAkB;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,sBAAsB;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,2BAA2B;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oCAAoC;IACpC,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,6BAA6B;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,uBAAuB;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mDAAmD;IACnD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mCAAmC;IACnC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,iBAAiB;IACjB,SAAS,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,UAAU,CAAC;IACnD,uCAAuC;IACvC,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,qCAAqC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uBAAuB;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uBAAuB;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,oBAAoB,GAAG,gBAAgB,CAAC;IAC9C,IAAI,EAAE,mBAAmB,GAAG,WAAW,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAC;AA8LpE;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,MAAM,CAuBrC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,mBAAmB,EAAE,cAAc,CAAC,GAAG,mBAAmB,CA2BvG;AAED;;;;GAIG;AACH,wBAAgB,eAAe,IAAI,mBAAmB,GAAG,IAAI,CAG5D;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kDAAkD;IAClD,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAAC,OAAO,GAAE,gBAAqB,GAAG,IAAI,CAUpE;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAKvC;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,IAAI,OAAO,CAG5C;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAExD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,IAAI,MAAM,EAAE,CAE1C;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,uDAAuD;IACvD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,6BAA6B;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,GAAE,kBAAuB,GAAG,WAAW,CAa9E;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,CAAC,OAAO,GAAE,kBAAuB,GAAG,WAAW,CAmBzE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,MAAM,IAAI,CAS5E;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAIrD;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,MAAM,GAAG,IAAI,CAGhD;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE;IACpC,SAAS,CAAC,EAAE;QAAE,EAAE,CAAC,EAAE,MAAM,CAAC;QAAC,EAAE,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,GAAG,IAAI,CAWP;AAoND;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE;IAC1C,SAAS,EAAE,SAAS,GAAG,UAAU,GAAG,WAAW,GAAG,OAAO,CAAC;IAC1D,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GAAG,IAAI,CAoBP;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,aAAa,GAAG,aAAa,CAKvE;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,aAAa,GAAG,IAAI,CAGvD;AA0CD;;;;GAIG;AACH,wBAAgB,sBAAsB,IAAI,OAAO,CAGhD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,IAAI,OAAO,CAGzC;AAED;;;;;GAKG;AACH,wBAAsB,qBAAqB,CAAC,OAAO,CAAC,EAAE;IACpD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,GAAG,OAAO,CAAC,OAAO,CAAC,CAkEnB;AAED;;;;;;;;;GASG;AACH,wBAAgB,0BAA0B,CAAC,OAAO,CAAC,EAAE;IACnD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,GAAG,OAAO,CA4CV;AAED;;GAEG;AACH,wBAAgB,mBAAmB,IAAI,IAAI,CAQ1C"}