feat: add custom links property

Author: mattkhan

lib/anchor/concerns/custom_linkable.rb

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

lib/anchor/concerns/schema_serializable.rb

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

lib/anchor/resource.rb

@@ -13,6 +13,7 @@ def initialize(resource_klass)
       @anchor_attributes_descriptions = resource_klass.try(:anchor_attributes_descriptions) || {}
       @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
     end
 
     def express(...)
@@ -108,6 +109,12 @@ def anchor_relationships_property(included_fields:)
       end
     end
 
+    def anchor_links_property
+      if @anchor_links_schema
+        Anchor::Types::Property.new("links", @anchor_links_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,7 @@ 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:))
+        Array.wrap(anchor_relationships_property(included_fields:)) + [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

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

spec/example/app/resources/exhaustive_resource.rb

@@ -43,6 +43,13 @@ class AssertedObject < Types::Object
   attribute :resource_overridden
   attribute :with_comment
 
+  class LinkSchema < Anchor::Types::Object
+    property :self, Anchor::Types::String
+    property :some_url, Anchor::Types::String
+  end
+
+  anchor_links_schema LinkSchema
+
   def asserted_string = "asserted_string"
 
   def asserted_number = 1

spec/example/test/files/all_fields_false_schema.ts

@@ -87,4 +87,8 @@ export type Exhaustive = {
   resourceOverridden: unknown;
   /** This is a comment. */
   withComment: Maybe<string>;
+  links: {
+    self: string;
+    some_url: string;
+  };
 };

spec/example/test/files/excluded_fields_schema.ts

@@ -85,4 +85,8 @@ export type Exhaustive = {
   resourceOverridden: unknown;
   /** This is a comment. */
   withComment: Maybe<string>;
+  links: {
+    self: string;
+    some_url: string;
+  };
 };

spec/example/test/files/schema.ts

@@ -95,4 +95,8 @@ export type Exhaustive = {
   resourceOverridden: unknown;
   /** This is a comment. */
   withComment: Maybe<string>;
+  links: {
+    self: string;
+    some_url: string;
+  };
 };

spec/example/test/files/test_schema.ts

@@ -92,4 +92,8 @@ export type Exhaustive = {
   resourceOverridden: unknown;
   /** This is a comment. */
   withComment: Maybe<string>;
+  links: {
+    self: string;
+    some_url: string;
+  };
 };