Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add string-union FhirResourceType #71

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add string-union FhirResourceType #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
72b2f9f
Cleaning code warnings...
GinoCanessa Jul 22, 2021
d21fea0
Added FhirResourceType string-union type with names of known Resources
GinoCanessa Jul 22, 2021
5d389f6
Added undefined type to optional elements.
GinoCanessa Jul 26, 2021
8bc0ed3
Merge branch 'main' into typescript
GinoCanessa Aug 5, 2021
c92b508
Working with .d.ts
GinoCanessa Aug 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6,432 changes: 3,265 additions & 3,167 deletions generated/TypeScript_R2.ts
View file
Open in desktop

Large diffs are not rendered by default.

10,143 changes: 5,132 additions & 5,011 deletions generated/TypeScript_R3.ts
View file
Open in desktop

Large diffs are not rendered by default.

28,262 changes: 28,262 additions & 0 deletions generated/TypeScript_R4.d.ts
View file
Open in desktop

Large diffs are not rendered by default.

13,672 changes: 6,911 additions & 6,761 deletions generated/TypeScript_R4.ts
View file
Open in desktop

Large diffs are not rendered by default.

15,254 changes: 7,703 additions & 7,551 deletions generated/TypeScript_R5.ts
View file
Open in desktop

Large diffs are not rendered by default.

170 changes: 132 additions & 38 deletions src/Microsoft.Health.Fhir.SpecManager/Language/TypeScript.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,18 @@ public sealed class TypeScript : ILanguage
/// <summary>True to export enums.</summary>
private bool _exportEnums;

/// <summary>The namespace to use when exporting files.</summary>
private string _namespace;

/// <summary>The directory root.</summary>
private string _directoryRoot;

/// <summary>Pathname of the model directory.</summary>
private string _directoryModels;

/// <summary>Pathname of the value set directory.</summary>
private string _directoryValueSets;

/// <summary>The exported codes.</summary>
private HashSet<string> _exportedCodes = new HashSet<string>();

Expand All @@ -79,8 +91,8 @@ public sealed class TypeScript : ILanguage
/// <summary>Name of the language.</summary>
private const string _languageName = "TypeScript";

/// <summary>The single file export extension.</summary>
private const string _singleFileExportExtension = ".ts";
/// <summary>The single file export extension - requires directory export.</summary>
private const string _singleFileExportExtension = ".d.ts";

/// <summary>The minimum type script version.</summary>
private const string _minimumTypeScriptVersion = "3.7";
Expand Down Expand Up @@ -152,7 +164,6 @@ public sealed class TypeScript : ILanguage
IncludeBase = false,
}
},

};

/// <summary>Gets the name of the language.</summary>
Expand Down Expand Up @@ -192,7 +203,10 @@ public sealed class TypeScript : ILanguage
};

/// <summary>Gets language-specific options and their descriptions.</summary>
Dictionary<string, string> ILanguage.LanguageOptions => new Dictionary<string, string>();
Dictionary<string, string> ILanguage.LanguageOptions => new Dictionary<string, string>()
{
{ "namespace", "Export namespace for TypeScript files (default: fhir{VersionNumber})." },
};

/// <summary>Export the passed FHIR version into the specified directory.</summary>
/// <param name="info"> The information.</param>
Expand Down Expand Up @@ -222,6 +236,29 @@ void ILanguage.Export(
_exportEnums = false;
}

_namespace = options.GetParam("namespace", $"fhir{info.MajorVersion}");

//_directoryRoot = exportDirectory;
//if (!Directory.Exists(_directoryRoot))
//{
// Directory.CreateDirectory(_directoryRoot);
//}

//_directoryModels = Path.Combine(exportDirectory, "Models");
//if (!Directory.Exists(_directoryModels))
//{
// Directory.CreateDirectory(_directoryModels);
//}

//_directoryValueSets = Path.Combine(exportDirectory, "ValueSets");
//if (_exportEnums)
//{
// if (!Directory.Exists(_directoryValueSets))
// {
// Directory.CreateDirectory(_directoryValueSets);
// }
//}

// create a filename for writing (single file for now)
string filename = Path.Combine(exportDirectory, $"R{info.MajorVersion}.ts");

Expand All @@ -241,9 +278,77 @@ void ILanguage.Export(
}

WriteExpandedResourceInterfaceBinding();
WriteExpandedResourceEnum();

WriteFooter();
}

// WriteMainDefinitionFile();
}

/// <summary>Writes the main definition file.</summary>
private void WriteMainDefinitionFile()
{
// create a filename for writing
string filename = Path.Combine(_directoryRoot, $"fhir.d.ts");

using (FileStream stream = new FileStream(filename, FileMode.Create))
using (ExportStreamWriter writer = new ExportStreamWriter(stream))
{
_writer = writer;

WriteHeader();

WriteExpandedResourceInterfaceBinding();
WriteExpandedResourceEnum();

WriteFooter();
}
}

/// <summary>Writes the expanded resource enum.</summary>
private void WriteExpandedResourceEnum()
{
if (_exportedResources.Count == 0)
{
return;
}

_exportedResources.Sort();

WriteIndentedComment("String enum/union covering all known resource types.");

if (_exportedResources.Count == 1)
{
_writer.WriteLineIndented($"export type FhirResourceType = '{_exportedResources[0]}';");
return;
}

_writer.WriteLineIndented("export type FhirResourceType = ");

_writer.IncreaseIndent();

int index = 0;
int last = _exportedResources.Count - 1;
foreach (string exportedName in _exportedResources)
{
if (index == 0)
{
_writer.WriteLineIndented("'" + exportedName + "'");
}
else if (index == last)
{
_writer.WriteLineIndented(" | '" + exportedName + "';");
}
else
{
_writer.WriteLineIndented(" | '" + exportedName + "'");
}

index++;
}

_writer.DecreaseIndent();
}

/// <summary>Writes the expanded resource interface binding.</summary>
Expand Down Expand Up @@ -381,7 +486,7 @@ private void WriteValueSet(
new WrittenCodeInfo() { Name = codeName, ConstName = constName });
writtenNames.Add(constName);

_writer.WriteLineIndented($"const {constName}: Coding = {{");
_writer.WriteLineIndented($"declare const {constName}: Coding = {{");
_writer.IncreaseIndent();

_writer.WriteLineIndented($"code: \"{codeValue}\",");
Expand Down Expand Up @@ -511,7 +616,6 @@ private void WriteComplex(
exportName = complex.NameForExport(FhirTypeBase.NamingConvention.PascalCase, true);
string typeName = complex.TypeForExport(FhirTypeBase.NamingConvention.PascalCase, _primitiveTypeMap, false);

//if (ShouldSupportGenerics(complex.Path))
if (_genericsAndTypeHints.ContainsKey(complex.Path))
{
_writer.WriteLineIndented(
Expand Down Expand Up @@ -570,9 +674,9 @@ private void WriteCode(
string.Empty,
FhirTypeBase.NamingConvention.PascalCase);

if (codeName.Contains("[x]"))
if (codeName.Contains("[x]", StringComparison.Ordinal))
{
codeName = codeName.Replace("[x]", string.Empty);
codeName = codeName.Replace("[x]", string.Empty, StringComparison.Ordinal);
}

if (_exportedCodes.Contains(codeName))
Expand All @@ -586,7 +690,7 @@ private void WriteCode(
_writer.WriteLineIndented($" * Code Values for the {element.Path} field");
_writer.WriteLineIndented($" */");

_writer.WriteLineIndented($"export enum {codeName} {{");
_writer.WriteLineIndented($"export const enum {codeName} {{");

_writer.IncreaseIndent();

Expand All @@ -596,7 +700,7 @@ private void WriteCode(
{
FhirUtils.SanitizeForCode(concept.Code, _reservedWords, out string name, out string value);

_writer.WriteLineIndented($"{name.ToUpperInvariant()} = \"{value}\",");
_writer.WriteLineIndented($"{name.ToUpperInvariant()} = '{value}',");
}
}
else
Expand All @@ -605,7 +709,7 @@ private void WriteCode(
{
FhirUtils.SanitizeForCode(code, _reservedWords, out string name, out string value);

_writer.WriteLineIndented($"{name.ToUpperInvariant()} = \"{value}\",");
_writer.WriteLineIndented($"{name.ToUpperInvariant()} = '{value}',");
}
}

Expand All @@ -631,22 +735,6 @@ private static bool ShouldWriteResourceType(string name)
return true;
}

/// <summary>Determine if the export should support generics</summary>
/// <param name="name">The name.</param>
/// <returns>True if it succeeds, false if it fails.</returns>
private static bool ShouldSupportGenerics(string name)
{
switch (name)
{
case "Bundle":
case "Bundle.entry":
case "Bundle.entry.resource":
return true;
}

return false;
}

/// <summary>Writes the elements.</summary>
/// <param name="complex"> The complex.</param>
/// <param name="elementsWithCodes">[out] The elements with codes.</param>
Expand Down Expand Up @@ -681,6 +769,7 @@ private void WriteElement(
{
string optionalFlagString = element.IsOptional ? "?" : string.Empty;
string arrayFlagString = element.IsArray ? "[]" : string.Empty;
string undefinedPostfix = element.IsOptional ? "|undefined" : string.Empty;

Dictionary<string, string> values = element.NamesAndTypesForExport(
FhirTypeBase.NamingConvention.CamelCase,
Expand All @@ -694,6 +783,7 @@ private void WriteElement(
string.IsNullOrEmpty(optionalFlagString))
{
optionalFlagString = "?";
undefinedPostfix = "|undefined";
}

foreach (KeyValuePair<string, string> kvp in values)
Expand Down Expand Up @@ -721,20 +811,19 @@ private void WriteElement(
string.Empty,
FhirTypeBase.NamingConvention.PascalCase);

_writer.WriteLineIndented($"{kvp.Key}{optionalFlagString}: {codeName}{arrayFlagString};");
_writer.WriteLineIndented($"{kvp.Key}{optionalFlagString}: {codeName}{arrayFlagString}{undefinedPostfix};");
}
else if (_info.TryGetValueSet(element.ValueSet, out FhirValueSet vs))
{
// use the full expansion
_writer.WriteLineIndented($"{kvp.Key}{optionalFlagString}: ({string.Join("|", vs.Concepts.Select(c => $"'{c.Code}'"))}){arrayFlagString};");
_writer.WriteLineIndented($"{kvp.Key}{optionalFlagString}: ({string.Join("|", vs.Concepts.Select(c => $"'{c.Code}'"))}){arrayFlagString}{undefinedPostfix};");
}
else
{
// otherwise, inline the required codes
_writer.WriteLineIndented($"{kvp.Key}{optionalFlagString}: ({string.Join("|", element.Codes.Select(c => $"'{c}'"))}){arrayFlagString};");
_writer.WriteLineIndented($"{kvp.Key}{optionalFlagString}: ({string.Join("|", element.Codes.Select(c => $"'{c}'"))}){arrayFlagString}{undefinedPostfix};");
}
}
//else if (ShouldSupportGenerics(element.Path))
else if (_genericsAndTypeHints.ContainsKey(element.Path))
{
GenericTypeHintInfo typeHint = _genericsAndTypeHints[element.Path];
Expand All @@ -744,29 +833,27 @@ private void WriteElement(
_writer.WriteLineIndented(
$"{kvp.Key}{optionalFlagString}:" +
$" {kvp.Value}" +
$"<{_genericsAndTypeHints[element.Path].Alias}>{arrayFlagString};");
$"<{_genericsAndTypeHints[element.Path].Alias}>{arrayFlagString}{undefinedPostfix};");
}
else
{
_writer.WriteLineIndented(
$"{kvp.Key}{optionalFlagString}:" +
$" {_genericsAndTypeHints[element.Path].Alias}{arrayFlagString};");
$" {_genericsAndTypeHints[element.Path].Alias}{arrayFlagString}{undefinedPostfix};");
}

//_writer.WriteLineIndented($"{kvp.Key}{optionalFlagString}: {kvp.Value}<T>{arrayFlagString};");
}
else if (kvp.Value.Equals("Resource", StringComparison.Ordinal))
{
_writer.WriteLineIndented($"{kvp.Key}{optionalFlagString}: FhirResource{arrayFlagString};");
_writer.WriteLineIndented($"{kvp.Key}{optionalFlagString}: FhirResource{arrayFlagString}{undefinedPostfix};");
}
else
{
_writer.WriteLineIndented($"{kvp.Key}{optionalFlagString}: {kvp.Value}{arrayFlagString};");
_writer.WriteLineIndented($"{kvp.Key}{optionalFlagString}: {kvp.Value}{arrayFlagString}{undefinedPostfix};");
}

if (RequiresExtension(kvp.Value))
{
_writer.WriteLineIndented($"_{kvp.Key}?: Element{arrayFlagString};");
_writer.WriteLineIndented($"_{kvp.Key}?: Element{arrayFlagString}|undefined;");
}
}
}
Expand Down Expand Up @@ -814,6 +901,13 @@ private void WriteHeader()
}

_writer.WriteLine($"// Minimum TypeScript Version: {_minimumTypeScriptVersion}");

if (!string.IsNullOrEmpty(_namespace))
{
_writer.WriteLine();
_writer.WriteLine($"export as namespace {_namespace};");
_writer.WriteLine();
}
}

/// <summary>Writes a footer.</summary>
Expand Down
3 changes: 3 additions & 0 deletions src/Microsoft.Health.Fhir.SpecManager/Manager/FhirVersionInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,9 @@ public class FhirVersionInfo
{
5,
new HashSet<string>()
{
"StructureDefinition-structuredefinition-conformance-derivedFrom.json",
}
},
};

Expand Down
2 changes: 1 addition & 1 deletion test/TypeScript_R4/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@
"noEmit": true
},
"files": [
"../../generated/TypeScript_R4.ts"
"../../generated/TypeScript_R4.d.ts"
]
}