openapi_generate_typescript_fetch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6c88d2001fe469f8df04f3e11f72debff180b87dbcd66dcf0e9b6f0804a789f7
+  data.tar.gz: 6fcc50af48f8b2b82cfeee034b9aa412def76f031931fc1dc657bc733e856e50
+SHA512:
+  metadata.gz: 4897d3b2c4f0c6ef83efa29d801f0282e40611d7f8c7ae867ae1ab7ca7aa370845d88f2fe45036293d69cf9e7b2ee214d4e16745c772e45e0ae172cd695c9a88
+  data.tar.gz: 3237efee6086d9772723d474fa7653d135134ae68a3b4b2cb97b604db02196d92a57b60817eb0e74fd3550f66e55ae334bb789f29c63d79dceb8fffbeeb0c40a

data/LICENSE.txt

@@ -0,0 +1,17 @@
+Copyright (c) 2025-2026 Ismo Kärkkäinen
+
+The Universal Permissive License (UPL), Version 1.0
+
+Subject to the condition set forth below, permission is hereby granted to any person obtaining a copy of this software, associated documentation and/or data (collectively the "Software"), free of charge and under any and all copyright rights in the Software, and any and all patent rights owned or freely licensable by each licensor hereunder covering either (i) the unmodified Software as contributed to or provided by such licensor, or (ii) the Larger Works (as defined below), to deal in both
+
+(a) the Software, and
+
+(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if one is included with the Software (each a “Larger Work” to which the Software is contributed by such licensors),
+
+without restriction, including without limitation the rights to copy, create derivative works of, display, perform, and distribute the Software and make, use, sell, offer for sale, import, export, have made, and have sold the Software and the Larger Work(s), and to sublicense the foregoing rights on either these or other terms.
+
+This license is subject to the following condition:
+
+The above copyright notice and either this complete permission notice or at a minimum a reference to the UPL must be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/openapi_generate_typescript_fetch/schema.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+# Copyright © 2025 Ismo Kärkkäinen
+# Licensed under Universal Permissive License. See LICENSE.txt.
+
+require 'lucky_case'
+
+# Namespace for functions with supposedly only internal use.
+module OpenAPIGenerateTypeScriptFetch
+  # Contains info about a property of an object schema.
+  class ObjectSchemaProperty
+    include Comparable
+
+    attr_reader :name, :req, :type, :pattern, :additional, :spec
+
+    def initialize(type:, spec:, name: nil, req: false, pattern: false, additional: false)
+      @name = name
+      @req = req
+      @type = type
+      @pattern = pattern
+      @additional = additional
+      @spec = spec
+    end
+
+    def <=>(other)
+      return -1 if !@name.nil? && other.name.nil?
+      return 1 if @name.nil? && !other.name.nil?
+      d = @name <=> other.name
+      return d unless d.zero?
+      d = @pattern <=> other.pattern
+      return d unless d.zero?
+      d = @additional <=> other.additional
+      return d unless d.zero?
+      d = @type <=> other.type
+      return d unless d.zero?
+      @spec <=> other.spec
+    end
+
+    def to_s
+      "ObjectSchemaProperty(name: #{@name}, req: #{@req}, type: #{@type}, pattern: #{@pattern}, additional: #{@additional}, spec: #{@spec})"
+    end
+  end
+
+  # Common info about schema, used in multiple places so gathered here to shorten templates.
+  class ObjectSchema
+    attr_reader :props, :additional, :schema, :unknown_names
+    def initialize(schema)
+      raise ArgumentError, "#{schema['type']} not an object" unless schema['type'] == 'object'
+      @schema = schema
+      @props = []
+      props = schema['properties'] || {}
+      pat_props = schema['patternProperties'] || {}
+      add_props = schema['additionalProperties']
+      reqd = schema['required'] || []
+      props.each do |name, spec|
+        @props.push(ObjectSchemaProperty.new(
+          name: name,
+          req: reqd.include?(name),
+          type: (Gen.h.category_and_name(spec) || [ spec['type'] ]).last,
+          spec: spec
+        ))
+      end
+      pat_props.each do |pattern, spec|
+        @props.push(ObjectSchemaProperty.new(
+          name: pattern,
+          type: (Gen.h.category_and_name(spec) || [ spec['type'] ]).last,
+          pattern: true,
+          spec: spec
+        ))
+      end
+      if add_props.is_a?(Hash)
+        @additional = true
+        @props.push(ObjectSchemaProperty.new(
+          type: (Gen.h.category_and_name(add_props) || [ add_props['type'] ]).last,
+          additional: true,
+          spec: add_props
+        ))
+      elsif add_props.nil? || add_props == true
+        @additional = true
+        @props.push(ObjectSchemaProperty.new(
+          type: nil,
+          additional: true,
+          spec: add_props
+        ))
+      else
+        @additional = false
+      end
+      @props.sort!
+      return if @additional
+      if !pat_props.empty?
+        # All patterns must have same failure cases.
+        tps = Gen.x.cfg.dig(*%w[tests patterns])
+        return if tps.nil?
+        cands = nil
+        @props.select(&:pattern).each do |p|
+          pt = tps.index { |pc| pc['pattern'] == p.name }
+          return if pt.nil?
+          fails = tps[pt]['fail']
+          return if fails.nil?
+          cands = cands.nil? ? Set.new(fails) : cands & Set.new(fails)
+          return if cands.empty?
+        end
+        cands -= Set.new(@props.reject(&:pattern).map(&:name))
+        @unknown_names = cands.empty? ? nil : cands.to_a.sort!
+      elsif !props.empty?
+        fixed = @props.reject(&:pattern).map(&:name).map(&:size)
+        @unknown_names = [ 'a' * (fixed.max + 1) ]
+        @unknown_names.push('a') if fixed.min > 1
+      else
+        # No properties, pattern properties, no additional properties.
+        @unknown_names = [ 'a' ]
+      end
+    end
+  end
+end

data/lib/openapi_generate_typescript_fetch/taskinfo.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Copyright © 2025 Ismo Kärkkäinen
+# Licensed under Universal Permissive License. See LICENSE.txt.
+
+require_relative 'version'
+
+module OpenAPIGenerateTypeScriptFetch
+  # For storing names for imports.
+  class ExportedNames
+    attr_reader :basename, :types, :functions, :consts, :interfaces, :enums, :classes
+
+    def initialize(basename)
+      @basename = basename
+      @types = []
+      @functions = []
+      @consts = []
+      @interfaces = []
+      @enums = []
+      @classes = []
+    end
+
+    def imports
+      [].concat(@functions, @consts, @interfaces, @enums, @classes).sort!
+    end
+
+    def import_types
+      @types.sort
+    end
+  end
+
+  # For use as Gen.x.
+  class TaskInfo
+    attr_reader :cfg, :order, :gem_name, :gem_version
+    attr_accessor :generator_info
+    attr_reader :schemas, :servers, :shared, :callclasses, :makers
+    attr_accessor :server_data
+
+    def initialize(config, order)
+      @cfg = config
+      @order = order
+      @gem_name = OpenAPIGenerateTypeScriptFetch::NAME
+      @gem_version = OpenAPIGenerateTypeScriptFetch::VERSION
+      @schemas = ExportedNames.new('schemas')
+      @servers = ExportedNames.new('servers')
+      @shared = ExportedNames.new('shared')
+      @callclasses = ExportedNames.new('callclasses')
+      @makers = ExportedNames.new('makers')
+      @server_data = nil
+    end
+  end
+end

data/lib/openapi_generate_typescript_fetch/tasks.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Copyright © 2024-2026 Ismo Kärkkäinen
+# Licensed under Universal Permissive License. See LICENSE.txt.
+
+require_relative 'schema' # For templates.
+require 'lucky_case'
+require 'uri'
+
+# Namespace for functions with supposedly only internal use.
+module OpenAPIGenerateTypeScriptFetch
+  def self.template_directory
+    File.join(File.dirname(__FILE__), '..', '..', 'template')
+  end
+  private_class_method :template_directory
+
+  def self.template_names
+    [ # Consider import order when ordering these files.
+      'package.json.erb',
+      'tsconfig.json.erb',
+      'src/helpers.ts.erb',
+      'src/servers.ts.erb',
+      'src/schemas.ts.erb',
+      'src/shared.ts.erb',
+      'src/callclasses.ts.erb',
+      'src/index.ts.erb',
+      'test/helpers.ts.erb',
+      'test/makers.ts.erb',
+      'test/schemas.ts.erb',
+      'test/shared.ts.erb',
+      'test/servers.ts.erb',
+      'test/callclasses.ts.erb'
+    ]
+  end
+
+  def self.full_template_name(template_name)
+    File.join(template_directory, template_name)
+  end
+
+  def self.license
+    File.read(File.join(template_directory, '..', 'LICENSE.txt'))
+  end
+end

data/lib/openapi_generate_typescript_fetch/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Copyright © 2025 Ismo Kärkkäinen
+# Licensed under Universal Permissive License. See LICENSE.txt.
+
+module OpenAPIGenerateTypeScriptFetch
+  NAME = 'openapi_generate_typescript_fetch'
+  VERSION = '0.1.0'
+end

data/lib/openapi_generate_typescript_fetch.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+# Copyright © 2024-2026 Ismo Kärkkäinen
+# Licensed under Universal Permissive License. See LICENSE.txt.
+
+require_relative 'openapi_generate_typescript_fetch/tasks'
+require_relative 'openapi_generate_typescript_fetch/version'
+require_relative 'openapi_generate_typescript_fetch/taskinfo'
+require 'openapi/sourcetools'
+require 'openapi/arrangement'
+require 'date'
+require 'base64'
+
+# Task initialization and helper code.
+module OpenAPIGenerateTypeScriptFetch
+  COPYRIGHT_DEFAULT = "Copyright #{Date.today.year} by the respective holders.
+This is a default copyright notice. Substitute with your own in configuration.
+(Use 'copyright' configuration key.)".freeze
+
+  def self.config_defaults(cfg)
+    ds = {
+      'subdir' => '.',
+      'copy' => [],
+      'copyright' => COPYRIGHT_DEFAULT,
+      'ts_indentation' => {
+        'indent_character' => ' ',
+        'indent_step' => 2,
+        'tab' => "\t",
+        'tab_replaces_count' => 0
+      }
+    }
+    ds.each do |key, value|
+      cfg[key] = value unless cfg.key?(key)
+    end
+    cfg
+  end
+
+  def self.setup_tasks
+    # Configurations are read at this point to catch errors early.
+    cfg = config_defaults(Gen.load_config(Gen.config || OpenAPIGenerateTypeScriptFetch::NAME))
+    Gen.x = TaskInfo.new(cfg, OpenAPIArrangement::Schema.alphabetical(Gen.doc))
+    cr = cfg['copyright'].lines.map! { |x| "// #{x}".rstrip }
+    Gen.x.generator_info = <<EOB
+#{cr.join("\n")}
+//
+// Generated code. Do not edit.
+//
+// Generated from #{Gen.doc.dig('info', 'title')} version #{Gen.doc.dig('info', 'version')}
+// Gem name: #{OpenAPIGenerateTypeScriptFetch::NAME}
+// Gem version: #{OpenAPIGenerateTypeScriptFetch::VERSION}
+EOB
+    setup_templates(OpenAPIGenerateTypeScriptFetch.template_names, cfg['subdir'])
+    setup_copies(cfg['copy'], cfg['subdir'])
+  end
+
+  def self.gitignore
+    <<EOB
+coverage
+coverage-reports
+node_modules
+pkg
+EOB
+  end
+
+  def self.setup_templates(names, subdir)
+    names.each do |template_name|
+      f = OpenAPIGenerateTypeScriptFetch.full_template_name(template_name)
+      template = File.read(f)
+      name = File.join(subdir, template_name[0..-5]) # Drop '.erb'
+      executable = name.upcase.end_with?('.SH')
+      Gen.add(source: Gen.doc, template:, template_name:, name:, executable:)
+    end
+  end
+
+  def self.obtain_content(root, info)
+    # Expects 'target' and either 'content' or 'source'.
+    content = info['content']
+    return content unless content.nil?
+    src = info['source']
+    raise StandardError, "No copy file content or source name provided, copy target: #{info['target']}" if src.nil?
+    begin
+      File.binread(File.join(root, src))
+    rescue Exception => e
+      $stderr.puts("Failed to read copy file from source: '#{src}', copy target: #{info['target']}")
+      raise e
+    end
+  end
+
+  def self.setup_copies(copies, subdir)
+    own_copies = [{
+      'target' => 'mcr.config.json',
+      'content' => '{"reports":["text","v8","v8-json","raw"],"entryFilter":"**/pkg/src/**"}'
+    }]
+    # Order allows easy overwrites from user's config.
+    copies = [].concat(own_copies, copies)
+    copies.size.times do |k|
+      info = copies[k]
+      name = info['target']
+      raise StandardError, "No copy file target name provided, copy index: #{k - own_copies.size}" if name.nil?
+      content = obtain_content(Gen.wd, info)
+      Gen.add_write_content(name: File.join(subdir, name), content: content)
+    end
+  end
+end
+
+# Runs when the gem is loaded the first time from openapi-generate.
+OpenAPIGenerateTypeScriptFetch.setup_tasks if defined?(Gen)

data/template/package.json.erb

@@ -0,0 +1,48 @@
+<%=
+tgt = Gen.x.cfg.fetch('target', 'browser')
+defaults = {
+  "main" => "pkg/src/index.js",
+  "files" => [
+    "pkg/src/*.js",
+    "pkg/src/*.d.ts"
+  ],
+  "type" => "module",
+  "scripts" => {
+    "build" => "tsc",
+    "test" => "tsc && mcr mocha pkg/test"
+  }
+}
+devDeps = {
+  "chai" => "6.2.2",
+  "mocha" => "11.7.6",
+  "monocart-coverage-reports" => "2.12.12",
+  "typescript" => "7.0.2",
+  "@types/chai" => "5.2.3",
+  "@types/mocha" => "10.0.10"
+}
+if tgt == 'node'
+  devDeps.merge!({
+    "@types/node" => "24.12.4",
+    "@tsconfig/node-lts" => "24.0.0",
+    "@tsconfig/node-ts" => "23.6.4"    
+  })
+elsif tgt == 'browser'
+  devDeps.merge!({
+    "@types/web" => "0.0.354",
+    "@tsconfig/recommended" => "1.0.13"
+  })
+end
+defaults['devDependencies'] = devDeps
+begin
+  cfg = Gen.x.cfg['package'] || {}
+  cfg = JSON.parse(cfg) unless cfg.is_a?(Hash)
+rescue StandardError => e
+  raise StandardError, "#{OpenAPIGenerateTypeScriptFetch::NAME}: Error parsing package.json: #{e.message}"
+end
+%w[scripts devDependencies].each do |key|
+  next unless cfg.key?(key) && defaults.key?(key)
+  cfg[key].merge!(defaults[key]) { |_key, cfg_value, _default_value| cfg_value }
+end
+cfg.merge!(defaults) { |_key, cfg_value, _default_value| cfg_value }
+Gen.output.pretty_json(cfg)
+%>