feat: meta property

Author: mattkhan

lib/anchor/concerns/custom_meta.rb

@@ -0,0 +1,14 @@
+module Anchor
+  module CustomMeta
+    extend ActiveSupport::Concern
+
+    included do
+      class << self
+        # @param type [Anchor::Types]
+        def anchor_meta_schema(type = nil)
+          @anchor_meta_schema ||= type
+        end
+      end
+    end
+  end
+end

lib/anchor/concerns/schema_serializable.rb

@@ -5,5 +5,6 @@ module SchemaSerializable
     include Anchor::StaticContext
     include Anchor::Annotatable
     include Anchor::CustomLinkable
+    include Anchor::CustomMeta
   end
 end

lib/anchor/resource.rb

@@ -14,6 +14,7 @@ def initialize(resource_klass)
       @anchor_relationships_descriptions = resource_klass.try(:anchor_relationships_descriptions) || {}
       @anchor_method_added_count = resource_klass.anchor_method_added_count || Hash.new(0)
       @anchor_links_schema = resource_klass.try(:anchor_links_schema) || nil
+      @anchor_meta_schema = resource_klass.try(:anchor_meta_schema) || nil
     end
 
     def express(...)
@@ -115,6 +116,12 @@ def anchor_links_property
       end
     end
 
+    def anchor_meta_property
+      if @anchor_meta_schema
+        Anchor::Types::Property.new("meta", @anchor_meta_schema, false)
+      end
+    end
+
     # @param included_fields [Array<Symbol>]
     # @return [Array<Anchor::Types::Property>]
     def anchor_relationships_properties(included_fields:)

lib/anchor/type_script/resource.rb

@@ -6,7 +6,8 @@ def express(context: {}, include_all_fields:, exclude_fields:)
 
       properties = [id_property, type_property] +
         Array.wrap(anchor_attributes_properties(included_fields:)) +
-        Array.wrap(anchor_relationships_property(included_fields:)) + [anchor_links_property].compact
+        Array.wrap(anchor_relationships_property(included_fields:)) +
+        [anchor_meta_property].compact + [anchor_links_property].compact
 
       expression = Anchor::TypeScript::Serializer.type_string(Anchor::Types::Object.new(properties))
       "export type #{anchor_schema_name} = " + expression + ";"

lib/jsonapi-resources-anchor.rb

@@ -5,6 +5,7 @@
 require "anchor/schema_generator"
 require "anchor/concerns/annotatable"
 require "anchor/concerns/custom_linkable"
+require "anchor/concerns/custom_meta"
 require "anchor/concerns/static_context"
 require "anchor/concerns/type_inferable"
 require "anchor/concerns/schema_serializable"

spec/example/app/resources/exhaustive_resource.rb

@@ -47,9 +47,14 @@ class LinkSchema < Anchor::Types::Object
     property :self, Anchor::Types::String
     property :some_url, Anchor::Types::String
   end
-
   anchor_links_schema LinkSchema
 
+  class MetaSchema < Anchor::Types::Object
+    property :some_count, Anchor::Types::Integer
+    property :extra_stuff, Anchor::Types::String
+  end
+  anchor_meta_schema MetaSchema
+
   def asserted_string = "asserted_string"
 
   def asserted_number = 1

spec/example/test/files/all_fields_false_schema.ts

@@ -87,6 +87,10 @@ export type Exhaustive = {
   resourceOverridden: unknown;
   /** This is a comment. */
   withComment: Maybe<string>;
+  meta: {
+    some_count: number;
+    extra_stuff: string;
+  };
   links: {
     self: string;
     some_url: string;

spec/example/test/files/excluded_fields_schema.ts

@@ -85,6 +85,10 @@ export type Exhaustive = {
   resourceOverridden: unknown;
   /** This is a comment. */
   withComment: Maybe<string>;
+  meta: {
+    some_count: number;
+    extra_stuff: string;
+  };
   links: {
     self: string;
     some_url: string;

spec/example/test/files/schema.ts

@@ -95,6 +95,10 @@ export type Exhaustive = {
   resourceOverridden: unknown;
   /** This is a comment. */
   withComment: Maybe<string>;
+  meta: {
+    some_count: number;
+    extra_stuff: string;
+  };
   links: {
     self: string;
     some_url: string;

spec/example/test/files/test_schema.ts

@@ -92,6 +92,10 @@ export type Exhaustive = {
   resourceOverridden: unknown;
   /** This is a comment. */
   withComment: Maybe<string>;
+  meta: {
+    some_count: number;
+    extra_stuff: string;
+  };
   links: {
     self: string;
     some_url: string;