ContractSpec docs

OSS-first docs

These docs teach the open system first: contracts, generated surfaces, runtimes, governance, and incremental adoption. Studio shows up as the operating layer on top, not as the source of truth.

audit-trail

Audit logging, querying, export, and compliance reporting

  • Type: feature
  • Version: 1.0.0
  • Stability: stable
  • Owners: @platform.audit-trail
  • Tags: audit, compliance, logging, security
  • field.key.label
    audit-trail
    field.version.label
    1.0.0
    field.type.label
    feature
    field.title.label
    audit-trail
    field.description.label

    Audit logging, querying, export, and compliance reporting

  • Type: feature
  • Version: 1.0.0
  • Stability: stable
  • Owners: @platform.audit-trail
  • Tags: audit, compliance, logging, security
  • field.tags.label
    audit,compliance,logging,security
    field.owners.label
    @platform.audit-trail
    field.stability.label
    stable

    Audit logging, querying, export, and compliance reporting

    Operations (5)

    `audit.logs.export` (v1.0.0)

    `audit.logs.query` (v1.0.0)

    `audit.logs.get` (v1.0.0)

    `audit.trace.get` (v1.0.0)

    `audit.stats` (v1.0.0)

    Source Definition

    /**
     * Audit Trail Feature Module Specification
     *
     * Defines the feature module for audit logging and compliance.
     */
    import { defineFeature } from '@lssm-tech/lib.contracts-spec';
    
    /**
     * Audit Trail feature module that bundles audit log querying,
     * export, and statistics capabilities.
     */
    export const AuditTrailFeature = defineFeature({
    	meta: {
    		key: 'audit-trail',
    		title: 'Audit Trail',
    		description: 'Audit logging, querying, export, and compliance reporting',
    		domain: 'platform',
    		version: '1.0.0',
    		owners: ['@platform.audit-trail'],
    		tags: ['audit', 'compliance', 'logging', 'security'],
    		stability: 'stable',
    	},
    
    	// All contract operations included in this feature
    	operations: [
    		{ key: 'audit.logs.export', version: '1.0.0' },
    		{ key: 'audit.logs.query', version: '1.0.0' },
    		{ key: 'audit.logs.get', version: '1.0.0' },
    		{ key: 'audit.trace.get', version: '1.0.0' },
    		{ key: 'audit.stats', version: '1.0.0' },
    	],
    
    	// No events for this feature - it consumes events, doesn't emit them
    	events: [],
    
    	// No presentations for this module feature
    	presentations: [],
    	opToPresentation: [],
    	presentationsTargets: [],
    
    	// Capability definitions
    	capabilities: {
    		provides: [{ key: 'audit-trail', version: '1.0.0' }],
    		requires: [],
    	},
    });