openapi_generate_typescript_fetch 0.1.0

data/template/test/servers.ts.erb

@@ -0,0 +1,109 @@
+<%=
+Gen.output.config = Gen.x.cfg['ts_indentation']
+Gen.x.generator_info
+%>
+
+import {expect} from 'chai';
+import type {<%= Gen.x.servers.import_types.join(', ') %>} from '../src/servers.d.ts';
+import {<%= Gen.x.servers.functions.sort.join(', ') %>} from '../src/servers.js';
+
+<%=
+out = []
+sos = Gen.x.server_data[:server_objects]
+so2checker = Gen.x.server_data[:checkers]
+so2args = Gen.x.server_data[:args]
+sos.each do |so|
+  out.push("describe('#{so2checker[so]}', function () {")
+  if so.variables.empty?
+    s = <<EOB
+  it('Returns server URL', function () {
+    expect(#{so2checker[so]}()).to.equal('#{so.url}');
+  });
+EOB
+    out.push(s)
+  else
+    v2pass = {}.compare_by_identity
+    v2fail = {}.compare_by_identity
+    so.variables.each do |svo|
+      if svo.enum.empty?
+        v2pass[svo] = [ svo.name.upcase ]
+        v2fail[svo] = []
+      else
+        v2pass[svo] = svo.enum
+        ml = svo.enum.map(&:size).max
+        v2fail[svo] = [ 'X' * (ml + 1) ]
+      end
+    end
+    s = <<EOB
+  it('Returns server URL with all arguments set', function () {
+    const args: #{so2args[so]} = {
+      #{so.variables.map { |v| "#{v.name}: '#{v2pass[v].first}'" }.join(",\n")}
+    };
+    const url: string = #{so2checker[so]}(args);
+    #{so.variables.map { |v| "expect(url).to.include('#{v2pass[v].first}');" }.join("\n")}
+  });
+EOB
+    out.push(s)
+    s = <<EOB
+  it('Returns server URL with no optional arguments set', function () {
+    const args: #{so2args[so]} = {
+      #{so.variables.reject { |v| v.default }.map { |v| "#{v.name}: '#{v2pass[v].first}'" }.join(",\n") || '// All optional.'}
+    };
+    const url: string = #{so2checker[so]}(args);
+    #{so.variables.reject { |v| v.default }.map { |v| "expect(url).to.include('#{v2pass[v].first}');" }.join("\n") || '// Nothing without default.'}
+    #{so.variables.reject { |v| v.default.nil? }.map { |v| "expect(url).to.include('#{v.default}');" }.join("\n") || '// Nothing with default.'}
+  });
+EOB
+    out.push(s)
+    # Pass all valid enums other than first.
+    firsts = so.variables.map { |v| "#{v.name}: '#{v2pass[v].first}'" }
+    so.variables.size.times do |chosen|
+      v = so.variables[chosen]
+      v.enum.size.times do |n|
+        next unless n.positive?
+        value = v.enum[n]
+        lines = []
+        so.variables.size.times do |k|
+          if k == chosen
+            lines.push("#{v.name}: '#{value}'")
+          else
+            lines.push(firsts[k])
+          end
+        end
+        s = <<EOB
+  it('Returns server URL with #{v.name} enum #{value}', function () {
+    const args: #{so2args[so]} = {
+      #{lines.join(",\n")}
+    };
+    const url: string = #{so2checker[so]}(args);
+    expect(url).to.include('#{value}');
+  });
+EOB
+        out.push(s)
+      end
+    end
+    # Fail each in turn, if possible.
+    so.variables.size.times do |chosen|
+      v = so.variables[chosen]
+      fails = v2fail[v]
+      next if fails.empty?
+      lines = []
+      so.variables.size.times do |k|
+        value = ((k == chosen) ? fails : v2pass[so.variables[k]]).first
+        lines.push("#{so.variables[k].name}: '#{value}'")
+      end
+      s = <<EOB
+  it('Throws when #{v.name} is #{fails.first}', function () {
+    const args: #{so2args[so]} = {
+      #{lines.join(",\n")}
+    };
+    expect(() => #{so2checker[so]}(args)).to.throw;
+  });
+EOB
+      out.push(s)
+    end
+  end
+  out.push('});')
+end
+Gen.output.join(out)
+%>

data/template/test/shared.ts.erb

@@ -0,0 +1,107 @@
+<%=
+Gen.output.config = Gen.x.cfg['ts_indentation']
+Gen.x.generator_info
+%>
+
+import {expect} from 'chai';
+import type { AllParameters, Shared } from '../src/shared.d.ts';
+import { shared } from '../src/shared.js';
+import { <%= Gen.x.shared.functions.join(', ') %> } from '../src/shared.js';
+import type {CallExtras, String2String, <%= Gen.x.schemas.import_types.join(', ') %>} from '../src/schemas.d.ts';
+import {<%= Gen.x.schemas.functions.join(', ') %>} from '../src/schemas.js';
+
+
+// Fluffy scripting languages allow this despite types, handy.
+function orderlyGarbage(plain: boolean): AllParameters {
+    const out: AllParameters = {
+<%=
+out = []
+Gen.doc[:all_params].each do |name, types|
+  ti = types.first
+  out.push("#{name}: '#{name}' as any as #{ti[:type]}") unless ti[:majority]
+end
+out.join(",\n")
+%>
+    };
+<%=
+out = []
+Gen.doc[:all_params].each do |name, types|
+  ti = types.first
+  next unless ti[:majority]
+  next unless name == ti[:name]
+  typed = ti[:shared]
+  out.push("if (plain) out.#{name} = '#{name}' as any as #{ti[:type]}; else out.#{typed} = '#{typed}' as any as #{ti[:type]};")
+end
+Gen.output.join(out)
+%>
+    return out;
+}
+
+describe('orderlyGarbage', function () {
+  it('majority, unique', function () {
+    const r = orderlyGarbage(true);
+    const names: Array<string> = Object.keys(r);
+    for (const name of names) {
+      expect(r).to.have.property(name, name);
+      for (const other of names) {
+        if (name == other) continue;
+        expect(r).to.have.property(other).not.to.equal(name);
+      }
+    }
+  });
+  it('no majority, unique', function () {
+    const r = orderlyGarbage(false);
+    const names: Array<string> = Object.keys(r);
+    for (const name of names) {
+      expect(r).to.have.property(name, name);
+      for (const other of names) {
+        if (name == other) continue;
+        expect(r).to.have.property(other).not.to.equal(name);
+      }
+    }
+  });
+});
+
+<%=
+out = []
+Gen.doc['paths'].each do |path, path_item_object|
+  oos = OpenAPISourceTools::ApiObjects.operation_objects(path_item_object)
+  oos.each do |method, operation_object|
+    next if operation_object[:parameterless]
+    shared_func = operation_object[:shared]
+    related = []
+    Gen.doc[:all_params].each_value do |types|
+      types.each do |ti|
+        related.push(ti) if ti[:ooid] == operation_object.object_id
+      end
+    end
+    out.push("describe('#{shared_func}', function () {")
+    typed = related.map do |ti|
+      "expect(r).to.have.property('#{ti[:name]}', '#{ti[:shared]}');"
+    end.uniq
+    plain = related.map do |ti|
+      "expect(r).to.have.property('#{ti[:name]}', '#{ti[ti[:majority] ? :name : :shared]}');"
+    end.uniq
+    s = <<EOB
+  it('no majority', function () {
+    shared.params = orderlyGarbage(false);
+    const r = #{shared_func}();
+    #{typed.join("\n")}
+  });
+  it('majority', function () {
+    shared.params = orderlyGarbage(true);
+    const r = #{shared_func}();
+    #{plain.join("\n")}
+  });
+  it('both', function () {
+    shared.params = { ...orderlyGarbage(false), ...orderlyGarbage(true) };
+    const r = #{shared_func}();
+    #{typed.join("\n")}
+  });
+EOB
+    out.push(s)
+    out.push("});")
+  end
+end
+Gen.output.join(out)
+%>

data/template/tsconfig.json.erb

@@ -0,0 +1,51 @@
+<%=
+# Default tsconfig.json. You should provide your own.
+defaults = {
+  "compilerOptions" => {
+    "outDir" => "./pkg",
+    "noImplicitAny" => true,
+    "forceConsistentCasingInFileNames" => true,
+    "erasableSyntaxOnly" => false,
+    "declaration" => true,
+    "rootDir" => '.',
+    'sourceMap' => true
+  },
+  "include" => [
+    "src", "test"
+  ]
+}
+tgt = Gen.x.cfg.fetch('target', 'browser')
+if tgt == 'node'
+  defaults.merge!({
+    "extends" => ["@tsconfig/node-lts/tsconfig.json", "@tsconfig/node-ts/tsconfig.json"]
+  })
+  defaults['compilerOptions'].merge!({
+    "module" => "nodenext",
+    "moduleResolution" => "nodenext",
+    "exactOptionalPropertyTypes" => true,
+    "types" => ["node", "mocha"]
+  })
+elsif tgt == 'browser'
+  defaults.merge!({
+    "extends" => ["@tsconfig/recommended/tsconfig.json"],
+  })
+  defaults['compilerOptions'].merge!({
+    "module" => "es6",
+    "moduleResolution" => "bundler",
+    "exactOptionalPropertyTypes" => true,
+    "types" => ["web", "mocha"]
+  })
+end
+begin
+  cfg = Gen.x.cfg['tsconfig'] || {}
+  cfg = JSON.parse(cfg) unless cfg.is_a?(Hash)
+rescue StandardError => e
+  raise StandardError, "#{OpenAPISourceToolsFetchTypescript::NAME}: Error parsing tsconfig.json: #{e.message}"
+end
+%w[compilerOptions].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)
+%>

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: openapi_generate_typescript_fetch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ismo Kärkkäinen
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lucky_case
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: openapi-arrangement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: openapi-sourcetools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: |-
+  This is a processor gem for use with openapi-generate from gem
+  openapi-sourcetools.
+
+  Produces a Fetch API client in TypeScript wrapped into a NPM package.
+email: ismokarkkainen@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/openapi_generate_typescript_fetch.rb
+- lib/openapi_generate_typescript_fetch/schema.rb
+- lib/openapi_generate_typescript_fetch/taskinfo.rb
+- lib/openapi_generate_typescript_fetch/tasks.rb
+- lib/openapi_generate_typescript_fetch/version.rb
+- template/package.json.erb
+- template/src/callclasses.ts.erb
+- template/src/helpers.ts.erb
+- template/src/index.ts.erb
+- template/src/schemas.ts.erb
+- template/src/servers.ts.erb
+- template/src/shared.ts.erb
+- template/test/callclasses.ts.erb
+- template/test/helpers.ts.erb
+- template/test/makers.ts.erb
+- template/test/schemas.ts.erb
+- template/test/servers.ts.erb
+- template/test/shared.ts.erb
+- template/tsconfig.json.erb
+homepage: https://xn--ismo-krkkinen-gfbd.fi/openapi_generate_typescript_fetch/index.html
+licenses:
+- UPL-1.0
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Generate Typescript Fetch API client package using OpenAPI format API specification.
+test_files: []