openapi_generate_typescript_fetch 0.1.0

data/template/src/servers.ts.erb

@@ -0,0 +1,226 @@
+<%=
+Gen.output.config = Gen.x.cfg['ts_indentation']
+Gen.x.generator_info
+%>
+
+import type {CallExtras} from './schemas.d.ts';
+
+<%=
+# From https://stackoverflow.com/questions/1661197/what-characters-are-valid-for-javascript-variable-names#9337047
+# and later comment.
+# re = Regexp.new('^(?!(?:do|if|in|for|let|new|try|var|case|else|enum|eval|false|null|this|true|void|with|break|catch|class|const|super|throw|while|yield|delete|export|import|public|return|static|switch|typeof|default|extends|finally|package|private|continue|debugger|function|arguments|interface|protected|implements|instanceof)$)[$_\p{Lu}\p{Ll}\p{Lt}\p{Lm}\p{Lo}\p{Nl}][$_\p{Lu}\p{Ll}\p{Lt}\p{Lm}\p{Lo}\p{Nl}\u200C\u200D\p{Mn}\p{Mc}\p{Nd}\p{Pc}]*$')
+def allowed_name(str, default_name)
+  re = Regexp.new('^[$_\p{Lu}\p{Ll}\p{Lt}\p{Lm}\p{Lo}\p{Nl}][$_\p{Lu}\p{Ll}\p{Lt}\p{Lm}\p{Lo}\p{Nl}\u200C\u200D\p{Mn}\p{Mc}\p{Nd}\p{Pc}]*$')
+  ok = []
+  str.each_char do |char|
+    if ok.empty?
+      ok.push(char) if re.match(char)
+    else
+      if re.match('A' + char) # Not first so set something to precede.
+        ok.push(char)
+      else
+        ok.push('_') unless ok.last == '_'
+      end
+    end
+  end
+  ok.pop unless ok.empty? || ok.last != '_'
+  ok.join || default_name
+end
+
+out = []
+# Has any server at top level?
+# Default to server with '/' path.
+servers = Gen.doc['servers'] || []
+top = OpenAPISourceTools::ApiObjects::ServerAlternatives.new(servers)
+Gen.doc[:servers] = top
+Gen.doc[:servers].set_id = 0
+overrides = []
+opIds = []
+opId2group = {}
+group2opIds = {}
+security_schemes = {}
+(Gen.doc.dig('components', 'securitySchemes') || {}).each do |name, scheme|
+  security_schemes[name] = OpenAPISourceTools::ApiObjects::SecurityScheme.new(name, scheme)
+end
+security = OpenAPISourceTools::ApiObjects::SecurityAlternatives.new(
+  (Gen.doc['security'] || []).map { |s| OpenAPISourceTools::ApiObjects::SecurityRequirementObject.new(s, security_schemes) },
+  security_schemes)
+security.set_id = 0
+security_overrides = []
+opId2sec_group = {}
+sec_group2opIds = {}
+# Find server alternatives for each path item, or use top-level.
+# Set security for each operation object.
+Gen.doc['paths'].each do |path, path_item|
+  servers = path_item['servers']
+  if servers.nil?
+    srvs = top
+  else
+    # If servers is exactly as at top level, this keeps it in separate group.
+    # Either servers array is an error or duplication is intentional.
+    srvs = OpenAPISourceTools::ApiObjects::ServerAlternatives.new(servers)
+    idx = overrides.index(srvs)
+    if idx.nil?
+      overrides.push(srvs)
+      srvs.set_id = overrides.size
+    else
+      srvs = overrides[index]
+    end
+    warn("Servers at path #{path} are identical to top level.") if top == srvs
+  end
+  path_item[:servers] = srvs
+  oos = OpenAPISourceTools::ApiObjects.operation_objects(path_item).values
+  oos.each do |oo|
+    oid = oo['operationId']
+    next if oid.nil?
+    opIds.push(oid)
+    opId2group[oid] = srvs
+    group2opIds[srvs.set_id] = group2opIds.fetch(srvs.set_id, []).push(oid)
+    sec = oo['security']
+    if sec.nil?
+      sec = security
+    else
+      sec = OpenAPISourceTools::ApiObjects::SecurityAlternatives.new(
+        sec.map { |s| OpenAPISourceTools::ApiObjects::SecurityRequirementObject.new(s, security_schemes) },
+        security_schemes)
+      idx = security_overrides.index(sec)
+      if idx.nil?
+        security_overrides.push(sec)
+        sec.set_id = security_overrides.size
+      else
+        sec = security_overrides[idx]
+      end
+    end
+    oo[:security] = sec
+    opId2sec_group[oid] = sec
+    sec_group2opIds[sec.set_id] = sec_group2opIds.fetch(sec.set_id, []).push(oid)
+  end
+end
+
+# Make server variable types, var name to string but names vary.
+# ServerObject matches arguments type, function to use SVO checkers and make URL.
+svos = []
+svo2data = {}.compare_by_identity
+svo2checker = {}.compare_by_identity
+sos = []
+so2data = {}.compare_by_identity
+so2checker = {}.compare_by_identity
+consts = Set.new
+[ top ].concat(overrides).each do |sa|
+  sa.servers.each do |so|
+    index = sos.index(so)
+    if index.nil?
+      sos.push(so)
+      so2data[so] = so
+      index = sos.size
+    else
+      so2data[so] = sos[index]
+    end
+    so2checker[so] = LuckyCase.camel_case(allowed_name(so.url, "serverUrl#{index}"))
+    so.variables.each do |svo|
+      consts.add(svo.default)
+      svo.enum.each { |e| consts.add(e) }
+      index = svos.index { |x| x.default == svo.default && x.enum == svo.enum }
+      if index.nil?
+        index = svos.size
+        svos.push(svo)
+        svo2data[svo] = svo
+        svo2data[svo] = svos[index]
+      end
+      svo2checker[svo] = "serverVariable#{index}"
+    end
+  end
+end
+
+value2const = {}
+consts.to_a.sort!.each do |s|
+  value2const[s] = "srvVarConst#{value2const.size}"
+  out.push("const #{value2const[s]} = '#{s}';")
+end
+
+# Behind the scenes a mapping from operationId to server URL string?
+Gen.output.join(out)
+%>
+
+<%=
+out = [ '// Server variable enum constants.' ]
+enums2const = {}
+svos.each do |svo|
+  next if svo.enum.empty?
+  key = svo.enum.join(', ')
+  unless enums2const.key?(key)
+    name = "srvVarEnumsConst#{enums2const.size}"
+    c = "const #{name} = [ #{svo.enum.map { |e| value2const[e] }.join(', ')} ];"
+    enums2const[key] = name
+    out.push(c)
+  end
+end
+out = [ '// No server variable enum constants.' ] if out.size == 1
+Gen.output.join(out)
+%>
+<%=
+out = [ '// Server variable value check functions.' ]
+svos.each do |svo|
+  if svo.enum.empty?
+    s = <<EOB
+function #{svo2checker[svo]}(value: string|undefined): string {
+  return (value === undefined) ? #{value2const[svo.default]} : value;
+}
+EOB
+  else
+    key = svo.enum.join(', ')
+    s = <<EOB
+function #{svo2checker[svo]}(value: string|undefined): string {
+  if (value === undefined) {
+    return #{value2const[svo.default]};
+  }
+  if (#{enums2const[key]}.includes(value)) {
+    return value;
+  }
+  throw new Error(`Invalid server variable #{svo.name} value: ${value}`);
+}
+EOB
+  end
+  out.push(s)
+end
+out = [ '// No server variable value check functions.' ] if out.size == 1
+Gen.output.join(out)
+%>
+<%=
+out = [ '// Server URL assign argument types and functions.']
+so2args = {}.compare_by_identity
+sos.each do |so|
+  Gen.x.servers.functions.push(so2checker[so])
+  if so.variables.empty?
+    s = <<EOB
+// No variables.
+export function #{so2checker[so]}(): string {
+  return '#{so.url}';
+}
+EOB
+    out.push(s)
+    next
+  end
+  iname = "#{LuckyCase.pascal_case(so2checker[so])}Args"
+  so2args[so] = iname
+  Gen.x.servers.types.push(iname)
+  s = <<EOB
+export type #{iname} = {
+  #{so.variables.map { |v| "#{v.name}#{v.default ? '?' : ''}: string;" }.join("\n  ")}
+}
+
+export function #{so2checker[so]}(args: #{iname}): string {
+  #{so.variables.map { |v| "const #{v.name} = encodeURIComponent(#{svo2checker[v]}(args.#{v.name}));" }.join("\n  ")}
+  return `#{so.url.gsub('{', '${')}`;
+}
+EOB
+  out.push(s)
+end
+Gen.x.server_data = { # Store for test generation.
+  server_objects: sos,
+  checkers: so2checker,
+  args: so2args
+}
+out = [ '// No server URL compose argument types or functions.'] if out.size == 1
+Gen.output.join(out)
+%>

data/template/src/shared.ts.erb

@@ -0,0 +1,114 @@
+<%=
+Gen.output.config = Gen.x.cfg['ts_indentation']
+Gen.x.generator_info
+%>
+
+import type {<%= %w[CallExtras].concat(Gen.x.schemas.import_types).join(', ') %>} from './schemas.d.ts';
+import type { RequestInitModifier } from './callclasses.d.ts';
+import type { EncoderFunction } from './schemas.d.ts';
+// Type that holds all parameters suffixed by their type.
+
+export type AllParameters = {
+<%=
+name2types = {}
+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]
+    operation_object[:paraschemas].each do |ps|
+      types = name2types.fetch(ps[:param][:name], [])
+      types.push({
+        name: ps[:param][:name],
+        type: ps[:schema][:name],
+        ps: ps,
+        count: 0,
+        shared: '',
+        majority: false,
+        ooid: operation_object.object_id
+      })
+      name2types[ps[:param][:name]] = types
+      ps[:shared] = types.last
+    end
+  end
+end
+out = []
+ap = {}
+names = name2types.keys.sort!
+names.each do |name|
+  types = name2types[name]
+  uniqs = types.map { |ti| ti[:type] }.uniq
+  type2count = {}
+  uniqs.each do |type|
+    type2count[type] = types.count { |ti| ti[:type] == type }
+  end
+  uniqs.sort! { |a, b| type2count[b] <=> type2count[a] }
+  if uniqs.size == 1 || uniqs.size > 1 && type2count[uniqs.first] > type2count[uniqs[1]]
+    out.push("  #{name}?: #{uniqs.first};")
+    types.select { |ti| ti[:type] == uniqs.first }.each do |ti|
+      ti[:majority] = true
+      ap[name] = ap.fetch(name, []).push(ti)
+    end
+  end
+  uniqs.each do |type|
+    combo = name + type
+    out.push("  #{combo}?: #{type};")
+    types.select { |ti| ti[:type] == type }.each do |ti|
+      ti[:shared] = combo
+      ti[:count] = type2count[type]
+      ap[combo] = ap.fetch(combo, []).push(ti)
+    end
+  end
+end
+Gen.doc[:all_params] = ap
+Gen.output.join(out)
+%>
+}
+
+export type Shared = {
+    serverUrl?: string;
+    params: AllParameters;
+    extras: CallExtras;
+    modifier: RequestInitModifier|null;
+    abortSignalable: boolean;
+    encoder: EncoderFunction|null;
+}
+
+export const shared: Shared = {
+    params: {},
+    extras: {},
+    modifier: null,
+    abortSignalable: false,
+    encoder: null
+}
+
+// Functions to get a partial of shared that contains exactly what callclass args type has.
+
+<%=
+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]
+    assigns = []
+    operation_object[:paraschemas].each do |ps|
+      ti = ps[:shared]
+      assigns.push("  if (shared.params.#{ti[:shared]} !== undefined) out.#{ti[:name]} = shared.params.#{ti[:shared]};")
+      if ti[:majority]
+        assigns.push("  else if (shared.params.#{ti[:name]} !== undefined) out.#{ti[:name]} = shared.params.#{ti[:name]};")
+      end
+    end
+    func_name = "shared#{operation_object[:args_name]}"
+    Gen.x.shared.functions.push(func_name)
+    operation_object[:shared] = func_name
+    s = <<EOB
+export function #{func_name}(): Partial<#{operation_object[:args_name]}> {
+  const out: Partial<#{operation_object[:args_name]}> = {};
+#{assigns.join("\n")}
+  return out;
+}
+EOB
+    out.push(s)
+  end
+end
+Gen.output.join(out)
+%>