smplkit 3.0.91 → 3.0.93

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 301ddc72ec1ff5b4553afe63a79d4261f17e77e14d1ac7c983f55f7198a180ea
-  data.tar.gz: 1cb536c2f6741ec074f5655d73af264c27ff5f77f71a099f87259e69c525c79b
+  metadata.gz: 892be2c4c6e0ddaab8b5ad36cb4248c08243c9309f45740963adbe009f3af8e4
+  data.tar.gz: 7dcdf94dff55e949983960a66a2fb80134c34ff362e69a00af8ac7322c136b88
 SHA512:
-  metadata.gz: 6adb6bdd03c07571e9aca3f8532114005ef7eb29a986f1b301d7af991e3301f4fcc0300a44671675b45a7ea5fa139080ee6f7fccda9fc21fb286304d9d6a92df
-  data.tar.gz: 4857e66bd1eed6dfe98cc510e47e0f6ff109cbe8273e85c44a599d1a97ca6c9c3b2b56bed5400f6a7ea7526dbfc7671c65b097f4e3eaf64bfb94dd6b227e97dc
+  metadata.gz: 91f79728ddb170cd32dbc70b009a1efaa1360838d7863e8167a1cf4b57bedca985ff33222eb50712f5fcb388466504cf6d8ddac389924ac408324417caa3561d
+  data.tar.gz: 3e662575d14354902eace0bc5af02abc3ebbfdc1a2debd634cd3f36cfd84e9d214f34b547819d029622e07c5ff11f11f86d989f6c3ee1453fc2321fd048119d8

data/lib/smplkit/audit/categories.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Smplkit
+  module Audit
+    # +client.audit.categories.list+ — distinct +category+ values seen for
+    # the account.
+    #
+    # Backed by a maintain-by-write side table populated whenever an event
+    # is recorded with a non-null +category+ (ADR-047 §2.5), so the response
+    # time is independent of how many years of events the account has
+    # accumulated. Sorted alphabetically; offset pagination (+page_number+ /
+    # +page_size+) per ADR-014.
+    class Categories
+      def initialize(api)
+        @api = api
+      end
+
+      # +environments+ is an optional array of environment keys (and/or the
+      # reserved +"smplkit"+ control-plane bucket) used to scope the read;
+      # the values are comma-joined into +filter[environment]+. Omitting it
+      # (or passing an empty array) leaves the filter unset — identical to
+      # the prior behavior on the wire.
+      def list(page_number: nil, page_size: nil, meta_total: nil, environments: nil)
+        opts = {}
+        opts[:page_number] = page_number if page_number
+        opts[:page_size] = page_size if page_size
+        opts[:meta_total] = meta_total unless meta_total.nil?
+        joined_environments = Smplkit::Audit.join_environments(environments)
+        opts[:filter_environment] = joined_environments if joined_environments
+
+        resp = Smplkit::Audit.call_api { @api.list_categories(opts) }
+        rows = (resp.data || []).map { |r| Category.from_resource(r) }
+        CategoryListPage.new(rows, Smplkit::Audit.extract_pagination(resp.meta))
+      end
+    end
+
+    CategoryListPage = Struct.new(:categories, :pagination)
+  end
+end

data/lib/smplkit/audit/client.rb

@@ -6,13 +6,14 @@ module Smplkit
     #
     # Owns event recording and read-side queries: fire-and-forget
     # +#events.record+, plus the audit-log +list+ / +get+ and the
-    # distinct-value listings that back the Activity tab filter
-    # dropdowns. ADR-047 §2.7.
+    # distinct-value listings (+resource_types+, +event_types+,
+    # +categories+) that back the Activity tab filter dropdowns.
+    # ADR-047 §2.7.
     #
     # SIEM forwarder CRUD lives on {Smplkit::ManagementClient} under
     # +mgmt.audit.forwarders.*+.
     class AuditClient
-      attr_reader :events, :resource_types, :event_types
+      attr_reader :events, :resource_types, :event_types, :categories
 
       SDK_OWNED_HEADERS = %w[authorization content-type user-agent].freeze
 
@@ -38,6 +39,7 @@ module Smplkit
         @events = Events.new(SmplkitGeneratedClient::Audit::EventsApi.new(api_client))
         @resource_types = ResourceTypes.new(SmplkitGeneratedClient::Audit::ResourceTypesApi.new(api_client))
         @event_types = EventTypes.new(SmplkitGeneratedClient::Audit::EventTypesApi.new(api_client))
+        @categories = Categories.new(SmplkitGeneratedClient::Audit::CategoriesApi.new(api_client))
       end
 
       def _close

data/lib/smplkit/audit/event_types.rb

@@ -18,12 +18,19 @@ module Smplkit
         @api = api
       end
 
-      def list(filter_resource_type: nil, page_number: nil, page_size: nil, meta_total: nil)
+      # +environments+ is an optional array of environment keys (and/or the
+      # reserved +"smplkit"+ control-plane bucket) used to scope the read;
+      # the values are comma-joined into +filter[environment]+. Omitting it
+      # (or passing an empty array) leaves the filter unset — identical to
+      # the prior behavior on the wire.
+      def list(filter_resource_type: nil, page_number: nil, page_size: nil, meta_total: nil, environments: nil)
         opts = {}
         opts[:filter_resource_type] = filter_resource_type if filter_resource_type
         opts[:page_number] = page_number if page_number
         opts[:page_size] = page_size if page_size
         opts[:meta_total] = meta_total unless meta_total.nil?
+        joined_environments = Smplkit::Audit.join_environments(environments)
+        opts[:filter_environment] = joined_environments if joined_environments
 
         resp = Smplkit::Audit.call_api { @api.list_event_types(opts) }
         rows = (resp.data || []).map { |r| EventType.from_resource(r) }

data/lib/smplkit/audit/events.rb

@@ -79,9 +79,15 @@ module Smplkit
       # List events with filters and cursor pagination. Returns a
       # +Smplkit::Audit::ListEventsPage+ whose +#events+ is the page and
       # +#next_cursor+ is the opaque token for the next page (or nil).
+      #
+      # +environments+ is an optional array of environment keys (and/or the
+      # reserved +"smplkit"+ control-plane bucket) used to scope the read; the
+      # values are comma-joined into +filter[environment]+. Omitting it (or
+      # passing an empty array) leaves the filter unset — identical to the
+      # prior behavior on the wire.
       def list(event_type: nil, resource_type: nil, resource_id: nil,
                actor_type: nil, actor_id: nil, occurred_at_range: nil,
-               search: nil, page_size: nil, page_after: nil)
+               search: nil, environments: nil, page_size: nil, page_after: nil)
         # Generated client opts use snake_case keys that internally map
         # to the JSON:API ``filter[*]`` / ``page[*]`` query-string format
         # (see default_api.rb#list_events_with_http_info). Without the
@@ -95,6 +101,8 @@ module Smplkit
         opts[:filter_actor_id] = actor_id if actor_id
         opts[:filter_occurred_at] = occurred_at_range if occurred_at_range
         opts[:filter_search] = search if search
+        joined_environments = Smplkit::Audit.join_environments(environments)
+        opts[:filter_environment] = joined_environments if joined_environments
         opts[:page_size] = page_size if page_size
         opts[:page_after] = page_after if page_after
 

data/lib/smplkit/audit/models.rb

@@ -49,6 +49,28 @@ module Smplkit
       out
     end
 
+    # Coerce a caller-supplied +environments+ value into the comma-separated
+    # string the audit read endpoints expect for +filter[environment]+, or
+    # +nil+ when no filter should be sent.
+    #
+    # The audit read endpoints (events list, the resource_type / event_type /
+    # category discovery lists) accept an optional comma-separated
+    # +filter[environment]+ of real environment keys and/or the reserved
+    # +"smplkit"+ control-plane bucket (ADR-055). The wrapper takes an
+    # array of keys for an ergonomic surface and joins it here.
+    #
+    # +nil+ or an empty array (or one whose entries are all blank) returns
+    # +nil+ so the caller omits the query param entirely and behaves exactly
+    # as before — existing callers are byte-for-byte unchanged on the wire.
+    # +"smplkit"+ is passed through like any other key; it carries no special
+    # handling in the SDK.
+    def self.join_environments(environments)
+      return nil if environments.nil?
+
+      values = Array(environments).map { |e| e.to_s.strip }.reject(&:empty?)
+      values.empty? ? nil : values.join(",")
+    end
+
     # Supported SIEM forwarder destination types (ADR-047 §2.12).
     #
     # Members are declared in alphabetical order. Customers pass these
@@ -246,6 +268,30 @@ module Smplkit
       end
     end
 
+    # A distinct +category+ value seen for the account.
+    #
+    # Same shape as {ResourceType}/{EventType} — +id+ and +category+ are the
+    # same value (JSON:API surfaces the customer-facing key as the resource
+    # id, ADR-014). +created_at+ is the earliest sighting of this category
+    # for the account.
+    #
+    # @!attribute [rw] id
+    #   @return [String] JSON:API resource id (same as +category+).
+    # @!attribute [rw] category
+    #   @return [String] The distinct category value.
+    # @!attribute [rw] created_at
+    #   @return [String] ISO-8601 timestamp of the earliest sighting for this value.
+    Category = Struct.new(:id, :category, :created_at, keyword_init: true) do
+      def self.from_resource(resource)
+        attrs = resource.attributes
+        new(
+          id: resource.id,
+          category: attrs.category || resource.id,
+          created_at: attrs.created_at
+        )
+      end
+    end
+
     # A single name/value HTTP header on a forwarder destination.
     #
     # @!attribute [rw] name
@@ -401,6 +447,16 @@ module Smplkit
       #   the server.
       attr_accessor :enabled
 
+      # @return [Boolean] When +true+, this forwarder also receives platform
+      #   change events that smplkit records about your own resources (flag,
+      #   configuration, and similar changes). Each such event is delivered
+      #   through every environment this forwarder is enabled in, using that
+      #   environment's resolved configuration. Defaults to +false+ — platform
+      #   change events are not forwarded unless you opt in. Independent of the
+      #   per-environment +enabled+ settings, since platform change events are
+      #   not tied to a deployment environment.
+      attr_accessor :forward_smplkit_events
+
       # @return [Hash{String => ForwarderEnvironment}] Per-environment overrides
       #   keyed by environment key (e.g. +"production"+, +"staging"+). A
       #   forwarder delivers in an environment only when
@@ -445,7 +501,8 @@ module Smplkit
       attr_accessor :version
 
       def initialize(client = nil, name:, forwarder_type:, configuration:,
-                     id: nil, enabled: false, environments: nil, description: nil,
+                     id: nil, enabled: false, forward_smplkit_events: false,
+                     environments: nil, description: nil,
                      filter: nil, transform: nil, transform_type: nil,
                      created_at: nil, updated_at: nil, deleted_at: nil, version: nil)
         @client = client
@@ -457,6 +514,7 @@ module Smplkit
         # round-trip the server value, but enablement is driven by
         # ``environments`` (see the class docstring).
         @enabled = enabled
+        @forward_smplkit_events = forward_smplkit_events
         @environments = environments || {}
         @description = description
         @filter = filter
@@ -507,6 +565,7 @@ module Smplkit
         @forwarder_type = other.forwarder_type
         @configuration = other.configuration
         @enabled = other.enabled
+        @forward_smplkit_events = other.forward_smplkit_events
         @environments = other.environments
         @description = other.description
         @filter = other.filter
@@ -553,6 +612,9 @@ module Smplkit
           # the server returned (always false) without assuming a default of
           # true.
           enabled: a.enabled.nil? ? false : a.enabled,
+          # ``forward_smplkit_events`` defaults to false; a forwarder persisted
+          # before the field landed reads back as not opted in.
+          forward_smplkit_events: a.forward_smplkit_events.nil? ? false : a.forward_smplkit_events,
           environments: environments,
           filter: a.filter.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.filter),
           transform_type: a.transform_type,

data/lib/smplkit/audit/resource_types.rb

@@ -14,11 +14,18 @@ module Smplkit
         @api = api
       end
 
-      def list(page_number: nil, page_size: nil, meta_total: nil)
+      # +environments+ is an optional array of environment keys (and/or the
+      # reserved +"smplkit"+ control-plane bucket) used to scope the read;
+      # the values are comma-joined into +filter[environment]+. Omitting it
+      # (or passing an empty array) leaves the filter unset — identical to
+      # the prior behavior on the wire.
+      def list(page_number: nil, page_size: nil, meta_total: nil, environments: nil)
         opts = {}
         opts[:page_number] = page_number if page_number
         opts[:page_size] = page_size if page_size
         opts[:meta_total] = meta_total unless meta_total.nil?
+        joined_environments = Smplkit::Audit.join_environments(environments)
+        opts[:filter_environment] = joined_environments if joined_environments
 
         resp = Smplkit::Audit.call_api { @api.list_resource_types(opts) }
         rows = (resp.data || []).map { |r| ResourceType.from_resource(r) }

data/lib/smplkit/management/audit.rb

@@ -48,6 +48,11 @@ module Smplkit
       #   {Smplkit::Audit::HttpConfiguration} override). Omit to create a
       #   forwarder that delivers nowhere until enabled per environment.
       # @param description [String, nil] Optional free-text description.
+      # @param forward_smplkit_events [Boolean] When +true+, the forwarder also
+      #   receives platform change events that smplkit records about the
+      #   account's own resources (flag, configuration, and similar changes),
+      #   delivered through every environment the forwarder is enabled in.
+      #   Defaults to +false+ — omit to leave platform change events unforwarded.
       # @param filter [Hash, nil] Optional JSON Logic filter; events that don't
       #   match are recorded as +filtered_out+ deliveries.
       # @param transform [Object, nil] Optional template applied to each event
@@ -65,6 +70,7 @@ module Smplkit
       # @return [Smplkit::Audit::Forwarder]
       def new_forwarder(id, forwarder_type:, configuration:, name: nil,
                         environments: nil, description: nil,
+                        forward_smplkit_events: false,
                         filter: nil, transform: nil, transform_type: nil)
         Smplkit::Audit::Forwarder.send(:validate_transform_pair!, transform, transform_type)
         Smplkit::Audit::Forwarder.new(
@@ -75,6 +81,7 @@ module Smplkit
           configuration: configuration,
           environments: normalize_environments(environments),
           description: description,
+          forward_smplkit_events: forward_smplkit_events,
           filter: filter,
           transform: transform,
           transform_type: transform_type
@@ -191,6 +198,7 @@ module Smplkit
           name: forwarder.name,
           description: forwarder.description,
           forwarder_type: Smplkit::Audit::ForwarderType.coerce(forwarder.forwarder_type),
+          forward_smplkit_events: forwarder.forward_smplkit_events,
           environments: environments_to_wire(forwarder.environments),
           filter: forwarder.filter,
           transform_type: Smplkit::Audit::TransformType.coerce(forwarder.transform_type),

data/lib/smplkit.rb

@@ -64,6 +64,7 @@ require_relative "smplkit/audit/buffer"
 require_relative "smplkit/audit/events"
 require_relative "smplkit/audit/resource_types"
 require_relative "smplkit/audit/event_types"
+require_relative "smplkit/audit/categories"
 require_relative "smplkit/audit/client"
 require_relative "smplkit/jobs/models"
 require_relative "smplkit/management/types"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smplkit
 version: !ruby/object:Gem::Version
-  version: 3.0.91
+  version: 3.0.93
 platform: ruby
 authors:
 - Smpl Solutions LLC
@@ -860,6 +860,7 @@ files:
 - lib/smplkit/_generated/logging/spec/models/usage_resource_spec.rb
 - lib/smplkit/_generated/logging/spec/spec_helper.rb
 - lib/smplkit/audit/buffer.rb
+- lib/smplkit/audit/categories.rb
 - lib/smplkit/audit/client.rb
 - lib/smplkit/audit/event_types.rb
 - lib/smplkit/audit/events.rb