Introduce raw result types

Author: koesie10

extensions/ql-vscode/src/common/bqrs-cli-types.ts

@@ -13,7 +13,7 @@ export namespace ColumnKindCode {
   export const ENTITY = "e";
 }
 
-type ColumnKind =
+export type ColumnKind =
   | typeof ColumnKindCode.FLOAT
   | typeof ColumnKindCode.INTEGER
   | typeof ColumnKindCode.STRING

extensions/ql-vscode/src/common/bqrs-result.ts

@@ -0,0 +1,124 @@
+import {
+  CellValue as BqrsCellValue,
+  ColumnKind as BqrsColumnKind,
+  ColumnKindCode,
+  DecodedBqrsChunk,
+  EntityValue as BqrsEntityValue,
+  ResultSetSchema,
+  UrlValue as BqrsUrlValue,
+} from "./bqrs-cli-types";
+import {
+  CellValue,
+  Column,
+  ColumnKind,
+  EntityValue,
+  RawResultSet,
+  Tuple,
+  UrlValue,
+} from "./raw-result-types";
+import { assertNever } from "./helpers-pure";
+
+export function bqrsToResultSet(
+  schema: ResultSetSchema,
+  chunk: DecodedBqrsChunk,
+): RawResultSet {
+  const name = schema.name;
+  const rows = schema.rows;
+  const nextPageOffset = chunk.next;
+
+  const columns = schema.columns.map(
+    (column): Column => ({
+      kind: mapColumnKind(column.kind),
+      name: column.name,
+    }),
+  );
+
+  const tuples = chunk.tuples.map(
+    (tuple): Tuple => tuple.map((cell): CellValue => mapCellValue(cell)),
+  );
+
+  return {
+    name,
+    rows,
+    columns,
+    tuples,
+    nextPageOffset,
+  };
+}
+
+function mapColumnKind(kind: BqrsColumnKind): ColumnKind {
+  switch (kind) {
+    case ColumnKindCode.STRING:
+      return ColumnKind.String;
+    case ColumnKindCode.FLOAT:
+      return ColumnKind.Float;
+    case ColumnKindCode.INTEGER:
+      return ColumnKind.Integer;
+    case ColumnKindCode.BOOLEAN:
+      return ColumnKind.Boolean;
+    case ColumnKindCode.DATE:
+      return ColumnKind.Date;
+    case ColumnKindCode.ENTITY:
+      return ColumnKind.Entity;
+    default:
+      assertNever(kind);
+  }
+}
+
+function mapCellValue(cellValue: BqrsCellValue): CellValue {
+  switch (typeof cellValue) {
+    case "string":
+      return {
+        type: "string",
+        value: cellValue,
+      };
+    case "number":
+      return {
+        type: "number",
+        value: cellValue,
+      };
+    case "boolean":
+      return {
+        type: "boolean",
+        value: cellValue,
+      };
+    case "object":
+      return {
+        type: "entity",
+        value: mapEntityValue(cellValue),
+      };
+  }
+}
+
+function mapEntityValue(cellValue: BqrsEntityValue): EntityValue {
+  return {
+    url: cellValue.url === undefined ? undefined : mapUrlValue(cellValue.url),
+    label: cellValue.label,
+    id: cellValue.id,
+  };
+}
+
+function mapUrlValue(urlValue: BqrsUrlValue): UrlValue {
+  if (typeof urlValue === "string") {
+    return {
+      type: "string",
+      value: urlValue,
+    };
+  }
+
+  if (urlValue.startLine) {
+    return {
+      type: "lineColumnLocation",
+      uri: urlValue.uri,
+      startLine: urlValue.startLine,
+      startColumn: urlValue.startColumn,
+      endLine: urlValue.endLine,
+      endColumn: urlValue.endColumn,
+    };
+  }
+
+  return {
+    type: "wholeFileLocation",
+    uri: urlValue.uri,
+  };
+}

extensions/ql-vscode/src/common/raw-result-types.ts

@@ -0,0 +1,81 @@
+export enum ColumnKind {
+  String = "string",
+  Float = "float",
+  Integer = "integer",
+  Boolean = "boolean",
+  Date = "date",
+  Entity = "entity",
+}
+
+export type Column = {
+  name?: string;
+  kind: ColumnKind;
+};
+
+export type UrlValueString = {
+  type: "string";
+  value: string;
+};
+
+export type UrlValueWholeFileLocation = {
+  type: "wholeFileLocation";
+  uri: string;
+};
+
+export type UrlValueLineColumnLocation = {
+  type: "lineColumnLocation";
+  uri: string;
+  startLine: number;
+  startColumn: number;
+  endLine: number;
+  endColumn: number;
+};
+
+export type UrlValue =
+  | UrlValueString
+  | UrlValueWholeFileLocation
+  | UrlValueLineColumnLocation;
+
+export type EntityValue = {
+  url?: UrlValue;
+  label?: string;
+  id?: number;
+};
+
+export type CellValueEntity = {
+  type: "entity";
+  value: EntityValue;
+};
+
+export type CellValueNumber = {
+  type: "number";
+  value: number;
+};
+
+export type CellValueString = {
+  type: "string";
+  value: string;
+};
+
+export type CellValueBoolean = {
+  type: "boolean";
+  value: boolean;
+};
+
+export type CellValue =
+  | CellValueEntity
+  | CellValueNumber
+  | CellValueString
+  | CellValueBoolean;
+
+export type Tuple = CellValue[];
+
+export type RawResultSet = {
+  name: string;
+  rows: number;
+
+  columns: Column[];
+  tuples: Tuple[];
+
+  nextPageOffset?: number;
+};