rails_audit_log-graphql 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c89d640d69c533ded27f477ed99b03275c34b4564c90e6eaccfe86a131f2447
-  data.tar.gz: d34b732d907a2db6b9c6c0bfba266933aaf6f21be9c8770caa8c64b50a81c870
+  metadata.gz: e8365cc8fe6ee9823f9cc1ec386fe119675e60fb70214e4fd91e3133c4b1c208
+  data.tar.gz: 89251a109b0d83c5150fd3b93253a8152421c9eb5bb2ef6ddc2be7304761e451
 SHA512:
-  metadata.gz: faa1b363d2aaebc1b3f5573f0b6c757a5d6b4d1fe8b6a1af7d906bd9877f23cecf897b75640b9f61e24e622d06c4233825be5047bada0d92371f954749a2499f
-  data.tar.gz: '08c32d0f02192b6db82d11e414ac04beb42a54ce61bb6dd8b025b2866f1569bc65b7b177ba308a4c0d241d7486029741e03abf082af38726fa2bbd30d6d2c6f4'
+  metadata.gz: dc978f7e8627a1f0449ee93e0abe737eb1e4a5b348d66295fb9630a5714553ea2b4d594a69e55fc682724fbc689493592ad656b217cb17f5150614746416224c
+  data.tar.gz: b93fdc0c1577144640b5475c7af57407827ffe015d3579aa2d4fd2c1d3b58ccd5b31c891b66790a9c75e745eb4b5c674172d79c0fdd9c3a2dc8a26caa3b00356

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.3.0] - 2026-06-03
+
+### Added
+
+- `ActorType` (`AuditLogActor`) — new object type with `id` and `typeName` fields exposing the polymorphic actor reference; adds `actor: AuditLogActor` field on `AuditLogEntry`
+- `AuditedResourceType` (`AuditedResource`) — new object type with `id` and `typeName` fields exposing the audited model reference; adds `auditedResource: AuditedResource!` field on `AuditLogEntry`
+- `DiffType` (`AuditLogDiff`) — new object type with `attribute`, `from`, and `to` fields; adds `diff: [AuditLogDiff!]` field on `AuditLogEntry` parsed from `objectChanges`
+
 ## [0.2.0] - 2026-06-03
 
 ### Added

data/README.md

@@ -13,9 +13,13 @@ A [graphql-ruby](https://graphql-ruby.org) API layer for the [`rails_audit_log`]
 - [Installation](#installation)
 - [Usage](#usage)
   - [AuditLogEntryType](#auditlogentrytype)
+  - [AuditLogActor](#auditlogactor)
+  - [AuditedResource](#auditedresource)
+  - [AuditLogDiff](#auditlogdiff)
   - [AuditLogEntriesQueryMixin](#auditlogentriesquerymixin)
     - [auditLogEntry](#auditlogentryid-id-auditlogentry)
     - [auditLogEntries](#auditlogentries-auditlogentry)
+    - [auditLogEntriesConnection](#auditlogentriesconnection-auditlogentryconnection)
   - [Authentication](#authentication)
 - [Development](#development)
 - [Contributing](#contributing)
@@ -61,6 +65,57 @@ This injects `include RailsAuditLog::Graphql::Queries::AuditLogEntriesQueryMixin
 | `actorType` | `String` | yes |
 | `actorId` | `ID` | yes |
 | `tenantId` | `String` | yes |
+| `actor` | `AuditLogActor` | yes |
+| `auditedResource` | `AuditedResource` | no |
+| `diff` | `[AuditLogDiff!]` | yes |
+
+[↑ Back to top](#table-of-contents)
+
+### AuditLogActor
+
+`RailsAuditLog::Graphql::Types::ActorType` — a polymorphic reference to the actor who performed the audited action. Returned by the `actor` field on `AuditLogEntry`. `null` when no actor was recorded.
+
+| GraphQL field | Type | Nullable |
+|---|---|---|
+| `id` | `ID` | no |
+| `typeName` | `String` | no |
+
+[↑ Back to top](#table-of-contents)
+
+### AuditedResource
+
+`RailsAuditLog::Graphql::Types::AuditedResourceType` — a reference to the model record that was changed. Returned by the `auditedResource` field on `AuditLogEntry`. Always present.
+
+| GraphQL field | Type | Nullable |
+|---|---|---|
+| `id` | `ID` | no |
+| `typeName` | `String` | no |
+
+[↑ Back to top](#table-of-contents)
+
+### AuditLogDiff
+
+`RailsAuditLog::Graphql::Types::DiffType` — a single attribute change parsed from `objectChanges`. Returned as a list by the `diff` field on `AuditLogEntry`. `null` when `objectChanges` is not recorded (e.g. destroy events).
+
+| GraphQL field | Type | Nullable | Description |
+|---|---|---|---|
+| `attribute` | `String` | no | Name of the changed attribute |
+| `from` | `JSON` | yes | Value before the change |
+| `to` | `JSON` | yes | Value after the change |
+
+**Example:**
+
+```graphql
+{
+  auditLogEntries(event: "update") {
+    diff {
+      attribute
+      from
+      to
+    }
+  }
+}
+```
 
 [↑ Back to top](#table-of-contents)
 
@@ -89,10 +144,14 @@ List entries with optional filters and offset pagination.
 | `itemType` | `String` | — | Filter by audited model class name |
 | `itemId` | `ID` | — | Filter by audited record ID |
 | `actorId` | `ID` | — | Filter by actor ID |
+| `since` | `ISO8601DateTime` | — | Return entries created at or after this time |
+| `until` | `ISO8601DateTime` | — | Return entries created at or before this time |
+| `touching` | `String` | — | Filter to entries that changed a specific attribute |
+| `orderBy` | `AuditLogEntrySortInput` | `CREATED_AT DESC` | Sort field and direction |
 | `page` | `Int` | `1` | Page number (1-based) |
 | `perPage` | `Int` | `25` | Results per page |
 
-Results are ordered by `created_at DESC`.
+Results default to `created_at DESC` ordering.
 
 #### `auditLogEntriesConnection(...): AuditLogEntryConnection!`
 

data/ROADMAP.md

@@ -4,14 +4,6 @@ This gem adds a GraphQL API layer on top of [`rails_audit_log`](https://github.c
 
 ---
 
-## 0.3.0 — Actor & Resource Resolver Types
-
-- **`ActorType`** — resolve the polymorphic `actor` to the concrete type in the host app's schema (requires a configurable type resolver proc)
-- **`AuditedResourceType`** — resolve `item_type`/`item_id` to the concrete audited model type
-- **`diffType`** — structured `{ from, to }` diff type instead of raw `objectChanges` JSON
-
----
-
 ## 0.4.0 — Subscriptions
 
 Requires Action Cable in the host application.

data/lib/rails_audit_log/graphql/types/actor_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RailsAuditLog
+  module Graphql
+    module Types
+      class ActorType < BaseObject
+        graphql_name "AuditLogActor"
+        description "A polymorphic reference to the actor who performed the audited action."
+
+        field :id, GraphQL::Types::ID, null: false, description: "The actor's ID."
+        field :type_name, String, null: false, description: "The actor's model class name (e.g. \"User\")."
+
+        def id
+          object[:id]
+        end
+
+        def type_name
+          object[:type_name]
+        end
+      end
+    end
+  end
+end

data/lib/rails_audit_log/graphql/types/audit_log_entry_type.rb

@@ -20,6 +20,27 @@ module RailsAuditLog
         field :actor_id, GraphQL::Types::ID, null: true
         field :tenant_id, String, null: true
         field :created_at, GraphQL::Types::ISO8601DateTime, null: false
+        field :actor, Types::ActorType, null: true,
+          description: "The actor who performed this action, as a polymorphic reference."
+        field :audited_resource, Types::AuditedResourceType, null: false,
+          description: "The model type and ID of the record that was changed."
+        field :diff, [Types::DiffType, null: false], null: true,
+          description: "Structured per-attribute diffs parsed from objectChanges. Nil when no changes are recorded."
+
+        def actor
+          return nil if object.actor_id.nil? || object.actor_type.nil?
+          {id: object.actor_id, type_name: object.actor_type}
+        end
+
+        def audited_resource
+          {id: object.item_id, type_name: object.item_type}
+        end
+
+        def diff
+          changes = object.object_changes
+          return nil if changes.nil?
+          changes.map { |attr, (from_val, to_val)| {attribute: attr, from: from_val, to: to_val} }
+        end
       end
     end
   end

data/lib/rails_audit_log/graphql/types/audited_resource_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RailsAuditLog
+  module Graphql
+    module Types
+      class AuditedResourceType < BaseObject
+        graphql_name "AuditedResource"
+        description "A reference to the model record that was changed."
+
+        field :id, GraphQL::Types::ID, null: false, description: "The audited record's ID."
+        field :type_name, String, null: false, description: "The audited model class name (e.g. \"Post\")."
+
+        def id
+          object[:id]
+        end
+
+        def type_name
+          object[:type_name]
+        end
+      end
+    end
+  end
+end

data/lib/rails_audit_log/graphql/types/diff_type.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RailsAuditLog
+  module Graphql
+    module Types
+      class DiffType < BaseObject
+        graphql_name "AuditLogDiff"
+        description "A single attribute change with before and after values."
+
+        field :attribute, String, null: false, description: "The name of the changed attribute."
+        field :from, GraphQL::Types::JSON, null: true, description: "Value before the change."
+        field :to, GraphQL::Types::JSON, null: true, description: "Value after the change."
+
+        def attribute
+          object[:attribute]
+        end
+
+        def from
+          object[:from]
+        end
+
+        def to
+          object[:to]
+        end
+      end
+    end
+  end
+end

data/lib/rails_audit_log/graphql/version.rb

@@ -2,6 +2,6 @@
 
 module RailsAuditLog
   module Graphql
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/rails_audit_log/graphql.rb

@@ -3,6 +3,9 @@
 require "graphql"
 require_relative "graphql/version"
 require_relative "graphql/types/base_object"
+require_relative "graphql/types/diff_type"
+require_relative "graphql/types/actor_type"
+require_relative "graphql/types/audited_resource_type"
 require_relative "graphql/types/audit_log_entry_type"
 require_relative "graphql/types/sort_direction_enum"
 require_relative "graphql/types/audit_log_entry_sort_field_enum"

data/sig/rails_audit_log/graphql.rbs

@@ -6,7 +6,26 @@ module RailsAuditLog
       class BaseObject < GraphQL::Schema::Object
       end
 
+      class DiffType < BaseObject
+        def attribute: () -> String
+        def from: () -> untyped
+        def to: () -> untyped
+      end
+
+      class ActorType < BaseObject
+        def id: () -> String
+        def type_name: () -> String
+      end
+
+      class AuditedResourceType < BaseObject
+        def id: () -> String
+        def type_name: () -> String
+      end
+
       class AuditLogEntryType < BaseObject
+        def actor: () -> Hash[Symbol, untyped]?
+        def audited_resource: () -> Hash[Symbol, untyped]
+        def diff: () -> Array[Hash[Symbol, untyped]]?
       end
 
       class SortDirectionEnum < GraphQL::Schema::Enum

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_audit_log-graphql
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -86,9 +86,12 @@ files:
 - lib/rails_audit_log/graphql/input_objects/audit_log_entry_sort_input.rb
 - lib/rails_audit_log/graphql/queries/audit_log_entries_query_mixin.rb
 - lib/rails_audit_log/graphql/release_tooling.rb
+- lib/rails_audit_log/graphql/types/actor_type.rb
 - lib/rails_audit_log/graphql/types/audit_log_entry_sort_field_enum.rb
 - lib/rails_audit_log/graphql/types/audit_log_entry_type.rb
+- lib/rails_audit_log/graphql/types/audited_resource_type.rb
 - lib/rails_audit_log/graphql/types/base_object.rb
+- lib/rails_audit_log/graphql/types/diff_type.rb
 - lib/rails_audit_log/graphql/types/sort_direction_enum.rb
 - lib/rails_audit_log/graphql/version.rb
 - sig/rails_audit_log/graphql.rbs