moku6 0.1.0

data/sig/generated/moku6/config.rbs

@@ -0,0 +1,43 @@
+# Generated from lib/moku6/config.rb with RBS::Inline
+
+module Moku6
+  class Config
+    DEFAULTS: Hash[String, untyped]
+
+    DEFAULT_CONFIG_PATH: String
+
+    # : (?Hash[Symbol, untyped] options) -> Config
+    def self.load: (?Hash[Symbol, untyped] options) -> Config
+
+    # : (Hash[String, untyped] base, Hash[String, untyped] override) -> Hash[String, untyped]
+    def self.deep_merge: (Hash[String, untyped] base, Hash[String, untyped] override) -> Hash[String, untyped]
+
+    attr_reader data: Hash[String, untyped]
+
+    attr_reader options: Hash[Symbol, untyped]
+
+    # : (Hash[String, untyped] data, ?Hash[Symbol, untyped] options) -> void
+    def initialize: (Hash[String, untyped] data, ?Hash[Symbol, untyped] options) -> void
+
+    # : () -> String?
+    def catalog_dir: () -> String?
+
+    # : () -> String?
+    def output_dir: () -> String?
+
+    # : () -> String?
+    def naming_pattern: () -> String?
+
+    # : () -> bool
+    def strict?: () -> bool
+
+    # : () -> bool
+    def warn_pii_field_names?: () -> bool
+
+    # : () -> String
+    def examples_dir: () -> String
+
+    # : (String | Symbol name) -> String?
+    def generator_out: (String | Symbol name) -> String?
+  end
+end

data/sig/generated/moku6/differ.rbs

@@ -0,0 +1,28 @@
+# Generated from lib/moku6/differ.rb with RBS::Inline
+
+module Moku6
+  # Detects breaking changes between two catalogs (design sections 13 / 16).
+  # Breaking changes (error): action removed, required field added, field type changed.
+  class Differ
+    @old: Catalog
+
+    @new: Catalog
+
+    # : (Catalog old_catalog, Catalog new_catalog) -> void
+    def initialize: (Catalog old_catalog, Catalog new_catalog) -> void
+
+    # : () -> Result
+    def run: () -> Result
+
+    private
+
+    # : () -> Array[Offense]
+    def removed_actions: () -> Array[Offense]
+
+    # : (Event old_event, Event new_event) -> Array[Offense]
+    def field_changes: (Event old_event, Event new_event) -> Array[Offense]
+
+    # : (Event event, String message, String rule) -> Offense
+    def breaking: (Event event, String message, String rule) -> Offense
+  end
+end

data/sig/generated/moku6/envelope_schema.rbs

@@ -0,0 +1,19 @@
+# Generated from lib/moku6/envelope_schema.rb with RBS::Inline
+
+module Moku6
+  # Builds the runtime event (envelope) validation JSON Schema from a definition.
+  # Shared by JsonSchemaGenerator and ExampleConsistencyRule (see design sections 8 / 12.2).
+  module EnvelopeSchema
+    TYPE_MAP: Hash[String, Hash[String, String]]
+
+    # : (Event event) -> Hash[String, untyped]
+    def self?.for: (Event event) -> Hash[String, untyped]
+
+    # The schema for the `metadata` object (the definition's fields).
+    # : (Event event) -> Hash[String, untyped]
+    def self?.metadata_schema: (Event event) -> Hash[String, untyped]
+
+    # : (Hash[String, untyped] f) -> Hash[String, untyped]
+    def self?.field_type: (Hash[String, untyped] f) -> Hash[String, untyped]
+  end
+end

data/sig/generated/moku6/event.rbs

@@ -0,0 +1,51 @@
+# Generated from lib/moku6/event.rb with RBS::Inline
+
+module Moku6
+  class Event
+    attr_reader data: Hash[String, untyped]
+
+    attr_reader source_path: String
+
+    # : (Hash[String, untyped]? data, source_path: String) -> void
+    def initialize: (Hash[String, untyped]? data, source_path: String) -> void
+
+    # : () -> String?
+    def action: () -> String?
+
+    # : () -> String?
+    def label: () -> String?
+
+    # : () -> String?
+    def description: () -> String?
+
+    # : () -> String?
+    def category: () -> String?
+
+    # : () -> bool
+    def required?: () -> bool
+
+    # : () -> untyped
+    def actor: () -> untyped
+
+    # : () -> untyped
+    def target: () -> untyped
+
+    # : () -> Hash[String, untyped]
+    def fields: () -> Hash[String, untyped]
+
+    # : () -> untyped
+    def privacy: () -> untyped
+
+    # : () -> untyped
+    def visibility: () -> untyped
+
+    # : () -> untyped
+    def retention: () -> untyped
+
+    # : () -> Array[untyped]
+    def examples: () -> Array[untyped]
+
+    # : () -> Hash[String, untyped]
+    def to_h: () -> Hash[String, untyped]
+  end
+end

data/sig/generated/moku6/generators/base_generator.rbs

@@ -0,0 +1,22 @@
+# Generated from lib/moku6/generators/base_generator.rb with RBS::Inline
+
+module Moku6
+  module Generators
+    class BaseGenerator
+      AUTOGEN_NOTE: String
+
+      @catalog: Catalog
+
+      @config: Config
+
+      # : (Catalog catalog, Config config) -> void
+      def initialize: (Catalog catalog, Config config) -> void
+
+      # : () -> String
+      def render: () -> String
+
+      # : (String path) -> String
+      def write: (String path) -> String
+    end
+  end
+end

data/sig/generated/moku6/generators/bigquery_generator.rbs

@@ -0,0 +1,12 @@
+# Generated from lib/moku6/generators/bigquery_generator.rb with RBS::Inline
+
+module Moku6
+  module Generators
+    # Emits BigQuery DDL for the shared envelope (design section 12.5).
+    # Fields live in the `metadata JSON` column, consistent with section 8.
+    class BigQueryGenerator < BaseGenerator
+      # : () -> String
+      def render: () -> String
+    end
+  end
+end

data/sig/generated/moku6/generators/cloud_events_generator.rbs

@@ -0,0 +1,19 @@
+# Generated from lib/moku6/generators/cloud_events_generator.rb with RBS::Inline
+
+module Moku6
+  module Generators
+    # Emits a CloudEvents (v1.0, structured JSON mode) validation JSON Schema per
+    # action. The CloudEvents `type` maps to the action and `data` carries the
+    # definition's metadata (design section 13: CloudEvents conversion).
+    class CloudEventsGenerator < BaseGenerator
+      SPEC_VERSION: String
+
+      # : (String dir) -> String
+      def write: (String dir) -> String
+
+      private
+
+      def schema_for: (untyped e) -> untyped
+    end
+  end
+end

data/sig/generated/moku6/generators/docs_generator.rbs

@@ -0,0 +1,18 @@
+# Generated from lib/moku6/generators/docs_generator.rb with RBS::Inline
+
+module Moku6
+  module Generators
+    class DocsGenerator < BaseGenerator
+      # : () -> String
+      def render: () -> String
+
+      private
+
+      def summary_table: () -> untyped
+
+      def detail: (untyped e) -> untyped
+
+      def yn: (untyped v) -> untyped
+    end
+  end
+end

data/sig/generated/moku6/generators/event_catalog_generator.rbs

@@ -0,0 +1,16 @@
+# Generated from lib/moku6/generators/event_catalog_generator.rb with RBS::Inline
+
+module Moku6
+  module Generators
+    # Emits EventCatalog (eventcatalog.dev) compatible event documents, one per
+    # action at <action>/index.md (design section 13: EventCatalog integration).
+    class EventCatalogGenerator < BaseGenerator
+      # : (String dir) -> String
+      def write: (String dir) -> String
+
+      private
+
+      def document: (untyped e) -> untyped
+    end
+  end
+end

data/sig/generated/moku6/generators/example_generator.rbs

@@ -0,0 +1,23 @@
+# Generated from lib/moku6/generators/example_generator.rb with RBS::Inline
+
+module Moku6
+  module Generators
+    # Generates a minimal sample event (envelope) satisfying required fields per definition.
+    class ExampleGenerator < BaseGenerator
+      # : (String dir) -> String
+      def write: (String dir) -> String
+
+      private
+
+      def example_for: (untyped e) -> untyped
+
+      def actor_sample: (untyped e) -> untyped
+
+      def target_sample: (untyped e) -> untyped
+
+      def metadata_sample: (untyped e) -> untyped
+
+      def sample_value: (untyped type) -> untyped
+    end
+  end
+end

data/sig/generated/moku6/generators/json_schema_generator.rbs

@@ -0,0 +1,12 @@
+# Generated from lib/moku6/generators/json_schema_generator.rb with RBS::Inline
+
+module Moku6
+  module Generators
+    # Emits a runtime event (envelope) validation JSON Schema per action.
+    # write(dir) takes a directory and writes multiple files.
+    class JsonSchemaGenerator < BaseGenerator
+      # : (String dir) -> String
+      def write: (String dir) -> String
+    end
+  end
+end

data/sig/generated/moku6/generators/open_api_generator.rbs

@@ -0,0 +1,20 @@
+# Generated from lib/moku6/generators/open_api_generator.rb with RBS::Inline
+
+module Moku6
+  module Generators
+    # Emits a single OpenAPI 3.1 document describing audit events as webhooks,
+    # with one component schema per action (design section 13: OpenAPI output).
+    class OpenApiGenerator < BaseGenerator
+      # : () -> String
+      def render: () -> String
+
+      private
+
+      def document: () -> untyped
+
+      def webhooks: () -> untyped
+
+      def schemas: () -> untyped
+    end
+  end
+end

data/sig/generated/moku6/generators/outbox_generator.rbs

@@ -0,0 +1,23 @@
+# Generated from lib/moku6/generators/outbox_generator.rb with RBS::Inline
+
+module Moku6
+  module Generators
+    # Emits a sample Rails transactional outbox for audit events: a migration,
+    # an ActiveRecord model, and a dispatcher (design section 13: Outbox sample).
+    # The files are a starting point and are meant to be edited.
+    class OutboxGenerator < BaseGenerator
+      FILES: Hash[String, Symbol]
+
+      # : (String dir) -> String
+      def write: (String dir) -> String
+
+      private
+
+      def migration: () -> untyped
+
+      def model: () -> untyped
+
+      def dispatcher: () -> untyped
+    end
+  end
+end

data/sig/generated/moku6/generators/rails_generator.rbs

@@ -0,0 +1,23 @@
+# Generated from lib/moku6/generators/rails_generator.rb with RBS::Inline
+
+module Moku6
+  module Generators
+    # Emits a Ruby SDK with one typed emitter method per action. Each method
+    # builds the canonical envelope and hands it to a configurable sink, so a
+    # Rails app can wire it to an outbox (design section 13: Rails SDK).
+    class RailsGenerator < BaseGenerator
+      # : () -> String
+      def render: () -> String
+
+      private
+
+      def sink_block: () -> untyped
+
+      def emitter_method: (untyped e) -> untyped
+
+      def method_name: (untyped e) -> untyped
+
+      def masked_fields: (untyped e) -> untyped
+    end
+  end
+end

data/sig/generated/moku6/generators/ruby_generator.rbs

@@ -0,0 +1,15 @@
+# Generated from lib/moku6/generators/ruby_generator.rb with RBS::Inline
+
+module Moku6
+  module Generators
+    # Emits Ruby constants for every action (design section 12.4).
+    class RubyGenerator < BaseGenerator
+      # : () -> String
+      def render: () -> String
+
+      private
+
+      def const_name: (untyped e) -> untyped
+    end
+  end
+end

data/sig/generated/moku6/generators/typescript_generator.rbs

@@ -0,0 +1,20 @@
+# Generated from lib/moku6/generators/typescript_generator.rb with RBS::Inline
+
+module Moku6
+  module Generators
+    class TypeScriptGenerator < BaseGenerator
+      # : () -> String
+      def render: () -> String
+
+      private
+
+      def union_type: (untyped events) -> untyped
+
+      def interface: (untyped e) -> untyped
+
+      def iface_name: (untyped e) -> untyped
+
+      def ts: (untyped f) -> untyped
+    end
+  end
+end

data/sig/generated/moku6/generators.rbs

@@ -0,0 +1,13 @@
+# Generated from lib/moku6/generators.rb with RBS::Inline
+
+module Moku6
+  module Generators
+    REGISTRY: Hash[Symbol, untyped]
+
+    # : (String | Symbol name, untyped klass) -> untyped
+    def self.register: (String | Symbol name, untyped klass) -> untyped
+
+    # : (String | Symbol name, Catalog catalog, Config config) -> untyped
+    def self.build: (String | Symbol name, Catalog catalog, Config config) -> untyped
+  end
+end

data/sig/generated/moku6/initializer.rbs

@@ -0,0 +1,23 @@
+# Generated from lib/moku6/initializer.rb with RBS::Inline
+
+module Moku6
+  # Backs `moku6 init`. Copies templates/init into ./ (never overwrites existing files).
+  class Initializer
+    TEMPLATE_DIR: String
+
+    @options: Hash[Symbol, untyped]
+
+    @dest_root: String
+
+    # : (?Hash[Symbol, untyped] options) -> void
+    def initialize: (?Hash[Symbol, untyped] options) -> void
+
+    # : () -> void
+    def run: () -> void
+
+    private
+
+    # : () -> Array[String]
+    def entries: () -> Array[String]
+  end
+end

data/sig/generated/moku6/linter.rbs

@@ -0,0 +1,31 @@
+# Generated from lib/moku6/linter.rb with RBS::Inline
+
+module Moku6
+  class Linter
+    EVENT_RULES: Array[singleton(Rules::BaseRule)]
+
+    CATALOG_RULES: Array[singleton(Rules::BaseRule)]
+
+    @catalog: Catalog
+
+    @config: Config
+
+    # : (singleton(Rules::BaseRule) klass) -> Array[singleton(Rules::BaseRule)]
+    def self.register_event_rule: (singleton(Rules::BaseRule) klass) -> Array[singleton(Rules::BaseRule)]
+
+    # : (singleton(Rules::BaseRule) klass) -> Array[singleton(Rules::BaseRule)]
+    def self.register_catalog_rule: (singleton(Rules::BaseRule) klass) -> Array[singleton(Rules::BaseRule)]
+
+    # : () -> Array[singleton(Rules::BaseRule)]
+    def self.custom_event_rules: () -> Array[singleton(Rules::BaseRule)]
+
+    # : () -> Array[singleton(Rules::BaseRule)]
+    def self.custom_catalog_rules: () -> Array[singleton(Rules::BaseRule)]
+
+    # : (Catalog catalog, Config config) -> void
+    def initialize: (Catalog catalog, Config config) -> void
+
+    # : () -> Result
+    def run: () -> Result
+  end
+end

data/sig/generated/moku6/loader.rbs

@@ -0,0 +1,15 @@
+# Generated from lib/moku6/loader.rb with RBS::Inline
+
+module Moku6
+  class Loader
+    PERMITTED_CLASSES: Array[Class]
+
+    @catalog_dir: String
+
+    # : (String catalog_dir) -> void
+    def initialize: (String catalog_dir) -> void
+
+    # : () -> Catalog
+    def load: () -> Catalog
+  end
+end

data/sig/generated/moku6/reporter.rbs

@@ -0,0 +1,30 @@
+# Generated from lib/moku6/reporter.rb with RBS::Inline
+
+module Moku6
+  module Reporter
+    # : (String? format) -> untyped
+    def self.for: (String? format) -> untyped
+
+    module Text
+      # : (Result result) -> void
+      def self.report: (Result result) -> void
+    end
+
+    module Json
+      # : (Result result) -> void
+      def self.report: (Result result) -> void
+    end
+
+    # Review-friendly Markdown report (e.g. for posting as a PR comment).
+    module Markdown
+      # : (Result result) -> void
+      def self.report: (Result result) -> void
+
+      # : (Result result) -> String
+      def self.render: (Result result) -> String
+
+      # : (String title, Array[Offense] offenses) -> Array[String]
+      def self.section: (String title, Array[Offense] offenses) -> Array[String]
+    end
+  end
+end

data/sig/generated/moku6/result.rbs

@@ -0,0 +1,22 @@
+# Generated from lib/moku6/result.rb with RBS::Inline
+
+module Moku6
+  class Result
+    attr_reader offenses: Array[Offense]
+
+    # : (Array[Offense] offenses) -> void
+    def initialize: (Array[Offense] offenses) -> void
+
+    # : () -> Array[Offense]
+    def errors: () -> Array[Offense]
+
+    # : () -> Array[Offense]
+    def warnings: () -> Array[Offense]
+
+    # : () -> bool
+    def errors?: () -> bool
+
+    # : () -> bool
+    def empty?: () -> bool
+  end
+end

data/sig/generated/moku6/rules/action_naming_rule.rbs

@@ -0,0 +1,10 @@
+# Generated from lib/moku6/rules/action_naming_rule.rb with RBS::Inline
+
+module Moku6
+  module Rules
+    class ActionNamingRule < BaseRule
+      # : (Event event) -> Array[Offense]
+      def check: (Event event) -> Array[Offense]
+    end
+  end
+end

data/sig/generated/moku6/rules/base_rule.rbs

@@ -0,0 +1,23 @@
+# Generated from lib/moku6/rules/base_rule.rb with RBS::Inline
+
+module Moku6
+  module Rules
+    class BaseRule
+      @config: Config
+
+      # : (Config config) -> void
+      def initialize: (Config config) -> void
+
+      # : (Event event) -> Array[Offense]
+      def check: (Event event) -> Array[Offense]
+
+      private
+
+      # : (Event event, Symbol severity, String message, ?rule: String) -> Offense
+      def offense: (Event event, Symbol severity, String message, ?rule: String) -> Offense
+
+      # : () -> String
+      def rule_id: () -> String
+    end
+  end
+end

data/sig/generated/moku6/rules/example_consistency_rule.rbs

@@ -0,0 +1,18 @@
+# Generated from lib/moku6/rules/example_consistency_rule.rb with RBS::Inline
+
+module Moku6
+  module Rules
+    class ExampleConsistencyRule < BaseRule
+      # : (Event event) -> Array[Offense]
+      def check: (Event event) -> Array[Offense]
+
+      private
+
+      # : (Event event) -> Array[untyped]
+      def collect_examples: (Event event) -> Array[untyped]
+
+      # : (Event event) -> String?
+      def external_path: (Event event) -> String?
+    end
+  end
+end

data/sig/generated/moku6/rules/label_description_rule.rbs

@@ -0,0 +1,15 @@
+# Generated from lib/moku6/rules/label_description_rule.rb with RBS::Inline
+
+module Moku6
+  module Rules
+    class LabelDescriptionRule < BaseRule
+      # : (Event event) -> Array[Offense]
+      def check: (Event event) -> Array[Offense]
+
+      private
+
+      # : (untyped value) -> bool
+      def blank?: (untyped value) -> bool
+    end
+  end
+end

data/sig/generated/moku6/rules/pii_field_name_heuristic_rule.rbs

@@ -0,0 +1,21 @@
+# Generated from lib/moku6/rules/pii_field_name_heuristic_rule.rb with RBS::Inline
+
+module Moku6
+  module Rules
+    # Warns when a field name looks like PII (email/phone/ssn, ...) but is not
+    # covered by privacy.masked_fields (design section 10.1, v0.2).
+    class PiiFieldNameHeuristicRule < BaseRule
+      PII_PATTERN: Regexp
+
+      # : (Event event) -> Array[Offense]
+      def check: (Event event) -> Array[Offense]
+
+      private
+
+      # Tokens that count a field as masked: the full masked path and each of its
+      # dot-separated segments (e.g. "before.email" covers "email").
+      # : (Event event) -> Array[String]
+      def masked_field_tokens: (Event event) -> Array[String]
+    end
+  end
+end

data/sig/generated/moku6/rules/privacy_masking_rule.rbs

@@ -0,0 +1,10 @@
+# Generated from lib/moku6/rules/privacy_masking_rule.rb with RBS::Inline
+
+module Moku6
+  module Rules
+    class PrivacyMaskingRule < BaseRule
+      # : (Event event) -> Array[Offense]
+      def check: (Event event) -> Array[Offense]
+    end
+  end
+end

data/sig/generated/moku6/rules/retention_rule.rbs

@@ -0,0 +1,10 @@
+# Generated from lib/moku6/rules/retention_rule.rb with RBS::Inline
+
+module Moku6
+  module Rules
+    class RetentionRule < BaseRule
+      # : (Event event) -> Array[Offense]
+      def check: (Event event) -> Array[Offense]
+    end
+  end
+end

data/sig/generated/moku6/rules/schema_rule.rbs

@@ -0,0 +1,15 @@
+# Generated from lib/moku6/rules/schema_rule.rb with RBS::Inline
+
+module Moku6
+  module Rules
+    class SchemaRule < BaseRule
+      SCHEMA_PATH: String
+
+      # : () -> untyped
+      def self.schemer: () -> untyped
+
+      # : (Event event) -> Array[Offense]
+      def check: (Event event) -> Array[Offense]
+    end
+  end
+end

data/sig/generated/moku6/rules/uniqueness_rule.rbs

@@ -0,0 +1,11 @@
+# Generated from lib/moku6/rules/uniqueness_rule.rb with RBS::Inline
+
+module Moku6
+  module Rules
+    class UniquenessRule < BaseRule
+      # catalog-level rule
+      # : (Catalog catalog) -> Array[Offense]
+      def check_catalog: (Catalog catalog) -> Array[Offense]
+    end
+  end
+end