Merge pull request #55 from returntocorp/brandon/remedy-interfaces

chore: make engine_kind optional

Author: aryx

semgrep_output_v1.atd

@@ -600,7 +600,7 @@ type cli_match_extra <ocaml attr="deriving show"> = {
    * later on. *)
   ?dataflow_trace: cli_match_dataflow_trace option;
 
-  engine_kind: engine_kind;
+  ?engine_kind: engine_kind option;
 }
 
 type fix_regex <ocaml attr="deriving show"> = {

semgrep_output_v1.jsonschema

@@ -57,7 +57,7 @@
     },
     "core_match_extra": {
       "type": "object",
-      "required": [ "metavars", "engine_kind" ],
+      "required": [ "metavars" ],
       "properties": {
         "message": { "type": "string" },
         "metavars": { "$ref": "#/definitions/metavars" },
@@ -495,8 +495,7 @@
     "cli_match_extra": {
       "type": "object",
       "required": [
-        "fingerprint", "lines", "message", "metadata", "severity",
-        "engine_kind"
+        "fingerprint", "lines", "message", "metadata", "severity"
       ],
       "properties": {
         "metavars": { "$ref": "#/definitions/metavars" },

semgrep_output_v1.py

@@ -918,34 +918,35 @@ class CoreMatchExtra:
     """Original type: core_match_extra = { ... }"""
 
     metavars: Metavars
-    engine_kind: EngineKind
     message: Optional[str] = None
     dataflow_trace: Optional[CoreMatchDataflowTrace] = None
     rendered_fix: Optional[str] = None
+    engine_kind: Optional[EngineKind] = None
 
     @classmethod
     def from_json(cls, x: Any) -> 'CoreMatchExtra':
         if isinstance(x, dict):
             return cls(
                 metavars=Metavars.from_json(x['metavars']) if 'metavars' in x else _atd_missing_json_field('CoreMatchExtra', 'metavars'),
-                engine_kind=EngineKind.from_json(x['engine_kind']) if 'engine_kind' in x else _atd_missing_json_field('CoreMatchExtra', 'engine_kind'),
                 message=_atd_read_string(x['message']) if 'message' in x else None,
                 dataflow_trace=CoreMatchDataflowTrace.from_json(x['dataflow_trace']) if 'dataflow_trace' in x else None,
                 rendered_fix=_atd_read_string(x['rendered_fix']) if 'rendered_fix' in x else None,
+                engine_kind=EngineKind.from_json(x['engine_kind']) if 'engine_kind' in x else None,
             )
         else:
             _atd_bad_json('CoreMatchExtra', x)
 
     def to_json(self) -> Any:
         res: Dict[str, Any] = {}
         res['metavars'] = (lambda x: x.to_json())(self.metavars)
-        res['engine_kind'] = (lambda x: x.to_json())(self.engine_kind)
         if self.message is not None:
             res['message'] = _atd_write_string(self.message)
         if self.dataflow_trace is not None:
             res['dataflow_trace'] = (lambda x: x.to_json())(self.dataflow_trace)
         if self.rendered_fix is not None:
             res['rendered_fix'] = _atd_write_string(self.rendered_fix)
+        if self.engine_kind is not None:
+            res['engine_kind'] = (lambda x: x.to_json())(self.engine_kind)
         return res
 
     @classmethod
@@ -2906,14 +2907,14 @@ class CliMatchExtra:
     message: str
     metadata: RawJson
     severity: str
-    engine_kind: EngineKind
     metavars: Optional[Metavars] = None
     fix: Optional[str] = None
     fix_regex: Optional[FixRegex] = None
     is_ignored: Optional[bool] = None
     sca_info: Optional[ScaInfo] = None
     fixed_lines: Optional[List[str]] = None
     dataflow_trace: Optional[CliMatchDataflowTrace] = None
+    engine_kind: Optional[EngineKind] = None
 
     @classmethod
     def from_json(cls, x: Any) -> 'CliMatchExtra':
@@ -2924,14 +2925,14 @@ def from_json(cls, x: Any) -> 'CliMatchExtra':
                 message=_atd_read_string(x['message']) if 'message' in x else _atd_missing_json_field('CliMatchExtra', 'message'),
                 metadata=RawJson.from_json(x['metadata']) if 'metadata' in x else _atd_missing_json_field('CliMatchExtra', 'metadata'),
                 severity=_atd_read_string(x['severity']) if 'severity' in x else _atd_missing_json_field('CliMatchExtra', 'severity'),
-                engine_kind=EngineKind.from_json(x['engine_kind']) if 'engine_kind' in x else _atd_missing_json_field('CliMatchExtra', 'engine_kind'),
                 metavars=Metavars.from_json(x['metavars']) if 'metavars' in x else None,
                 fix=_atd_read_string(x['fix']) if 'fix' in x else None,
                 fix_regex=FixRegex.from_json(x['fix_regex']) if 'fix_regex' in x else None,
                 is_ignored=_atd_read_bool(x['is_ignored']) if 'is_ignored' in x else None,
                 sca_info=ScaInfo.from_json(x['sca_info']) if 'sca_info' in x else None,
                 fixed_lines=_atd_read_list(_atd_read_string)(x['fixed_lines']) if 'fixed_lines' in x else None,
                 dataflow_trace=CliMatchDataflowTrace.from_json(x['dataflow_trace']) if 'dataflow_trace' in x else None,
+                engine_kind=EngineKind.from_json(x['engine_kind']) if 'engine_kind' in x else None,
             )
         else:
             _atd_bad_json('CliMatchExtra', x)
@@ -2943,7 +2944,6 @@ def to_json(self) -> Any:
         res['message'] = _atd_write_string(self.message)
         res['metadata'] = (lambda x: x.to_json())(self.metadata)
         res['severity'] = _atd_write_string(self.severity)
-        res['engine_kind'] = (lambda x: x.to_json())(self.engine_kind)
         if self.metavars is not None:
             res['metavars'] = (lambda x: x.to_json())(self.metavars)
         if self.fix is not None:
@@ -2958,6 +2958,8 @@ def to_json(self) -> Any:
             res['fixed_lines'] = _atd_write_list(_atd_write_string)(self.fixed_lines)
         if self.dataflow_trace is not None:
             res['dataflow_trace'] = (lambda x: x.to_json())(self.dataflow_trace)
+        if self.engine_kind is not None:
+            res['engine_kind'] = (lambda x: x.to_json())(self.engine_kind)
         return res
 
     @classmethod

semgrep_output_v1.ts

@@ -1,16 +1,12 @@
-/*
-  Generated by atdts from type definitions in 'semgrep_output_v1.atd'.
+// Generated by atdts from type definitions in 'semgrep_output_v1.atd'.
+//
+// Type-safe translations from/to JSON
+//
+// For each type 'Foo', there is a pair of functions:
+// - 'writeFoo': convert a 'Foo' value into a JSON-compatible value.
+// - 'readFoo': convert a JSON-compatible value into a TypeScript value
+//   of type 'Foo'.
 
-  Type-safe translations from/to JSON
-
-  For each type 'Foo', there is a pair of functions:
-  - 'writeFoo': convert a 'Foo' value into a JSON-compatible value.
-  - 'readFoo': convert a JSON-compatible value into a TypeScript value
-    of type 'Foo'.
-*/
-
-/* tslint:disable */
-/* eslint-disable */
 
 export type RawJson = any
 
@@ -45,7 +41,7 @@ export type CoreMatchExtra = {
   metavars: Metavars;
   dataflow_trace?: CoreMatchDataflowTrace;
   rendered_fix?: string;
-  engine_kind: EngineKind;
+  engine_kind?: EngineKind;
 }
 
 export type CoreMatchCallTrace =
@@ -264,7 +260,7 @@ export type CliMatchExtra = {
   sca_info?: ScaInfo;
   fixed_lines?: string[];
   dataflow_trace?: CliMatchDataflowTrace;
-  engine_kind: EngineKind;
+  engine_kind?: EngineKind;
 }
 
 export type FixRegex = {
@@ -490,7 +486,7 @@ export function writeCoreMatchExtra(x: CoreMatchExtra, context: any = x): any {
     'metavars': _atd_write_required_field('CoreMatchExtra', 'metavars', writeMetavars, x.metavars, x),
     'dataflow_trace': _atd_write_optional_field(writeCoreMatchDataflowTrace, x.dataflow_trace, x),
     'rendered_fix': _atd_write_optional_field(_atd_write_string, x.rendered_fix, x),
-    'engine_kind': _atd_write_required_field('CoreMatchExtra', 'engine_kind', writeEngineKind, x.engine_kind, x),
+    'engine_kind': _atd_write_optional_field(writeEngineKind, x.engine_kind, x),
   };
 }
 
@@ -500,7 +496,7 @@ export function readCoreMatchExtra(x: any, context: any = x): CoreMatchExtra {
     metavars: _atd_read_required_field('CoreMatchExtra', 'metavars', readMetavars, x['metavars'], x),
     dataflow_trace: _atd_read_optional_field(readCoreMatchDataflowTrace, x['dataflow_trace'], x),
     rendered_fix: _atd_read_optional_field(_atd_read_string, x['rendered_fix'], x),
-    engine_kind: _atd_read_required_field('CoreMatchExtra', 'engine_kind', readEngineKind, x['engine_kind'], x),
+    engine_kind: _atd_read_optional_field(readEngineKind, x['engine_kind'], x),
   };
 }
 
@@ -1174,7 +1170,7 @@ export function writeCliMatchExtra(x: CliMatchExtra, context: any = x): any {
     'sca_info': _atd_write_optional_field(writeScaInfo, x.sca_info, x),
     'fixed_lines': _atd_write_optional_field(_atd_write_array(_atd_write_string), x.fixed_lines, x),
     'dataflow_trace': _atd_write_optional_field(writeCliMatchDataflowTrace, x.dataflow_trace, x),
-    'engine_kind': _atd_write_required_field('CliMatchExtra', 'engine_kind', writeEngineKind, x.engine_kind, x),
+    'engine_kind': _atd_write_optional_field(writeEngineKind, x.engine_kind, x),
   };
 }
 
@@ -1192,7 +1188,7 @@ export function readCliMatchExtra(x: any, context: any = x): CliMatchExtra {
     sca_info: _atd_read_optional_field(readScaInfo, x['sca_info'], x),
     fixed_lines: _atd_read_optional_field(_atd_read_array(_atd_read_string), x['fixed_lines'], x),
     dataflow_trace: _atd_read_optional_field(readCliMatchDataflowTrace, x['dataflow_trace'], x),
-    engine_kind: _atd_read_required_field('CliMatchExtra', 'engine_kind', readEngineKind, x['engine_kind'], x),
+    engine_kind: _atd_read_optional_field(readEngineKind, x['engine_kind'], x),
   };
 }