From 178f528bf031efc2d89ae1a198a966e86318cdb2 Mon Sep 17 00:00:00 2001
From: Tony Garnock-Jones <tonyg@leastfixedpoint.com>
Date: Wed, 17 Mar 2021 12:20:06 +0100
Subject: [PATCH] Rearrange Dictionary type parameters for improved Record type
 inference

---
 .../javascript/packages/core/src/decoder.ts   |  4 ++--
 .../packages/core/src/dictionary.ts           | 10 +++++-----
 .../javascript/packages/core/src/fold.ts      |  8 ++++----
 .../javascript/packages/core/src/reader.ts    |  4 ++--
 .../javascript/packages/core/src/record.ts    | 19 +++++++++++++------
 .../javascript/packages/core/src/strip.ts     |  2 +-
 .../javascript/packages/core/src/values.ts    |  2 +-
 .../packages/core/test/codec.test.ts          |  6 +++---
 8 files changed, 31 insertions(+), 24 deletions(-)

diff --git a/implementations/javascript/packages/core/src/decoder.ts b/implementations/javascript/packages/core/src/decoder.ts
index 7680e34..b2c148b 100644
--- a/implementations/javascript/packages/core/src/decoder.ts
+++ b/implementations/javascript/packages/core/src/decoder.ts
@@ -122,8 +122,8 @@ export class Decoder<T = never> implements TypedDecoder<T> {
         return this.includeAnnotations ? new Annotated(v) : v;
     }
 
-    static dictionaryFromArray<T>(vs: Value<T>[]): Dictionary<Value<T>, T> {
-        const d = new Dictionary<Value<T>, T>();
+    static dictionaryFromArray<T>(vs: Value<T>[]): Dictionary<T> {
+        const d = new Dictionary<T>();
         if (vs.length % 2) throw new DecodeError("Missing dictionary value");
         for (let i = 0; i < vs.length; i += 2) {
             d.set(vs[i], vs[i+1]);
diff --git a/implementations/javascript/packages/core/src/dictionary.ts b/implementations/javascript/packages/core/src/dictionary.ts
index fc4715c..4796330 100644
--- a/implementations/javascript/packages/core/src/dictionary.ts
+++ b/implementations/javascript/packages/core/src/dictionary.ts
@@ -75,14 +75,14 @@ export class KeyedDictionary<K extends Value<T>, V, T = DefaultPointer> extends
     }
 }
 
-export class Dictionary<V, T = DefaultPointer> extends KeyedDictionary<Value<T>, V, T> {
-    static isDictionary<V, T = DefaultPointer>(x: any): x is Dictionary<V, T> {
+export class Dictionary<T = DefaultPointer, V = Value<T>> extends KeyedDictionary<Value<T>, V, T> {
+    static isDictionary<T = DefaultPointer, V = Value<T>>(x: any): x is Dictionary<T, V> {
         return x?.[DictionaryType] === 'Dictionary';
     }
 
-    static fromJS<V = DefaultPointer, T = DefaultPointer>(x: object): Dictionary<Value<V>, T> {
-        if (Dictionary.isDictionary<Value<V>, T>(x)) return x as Dictionary<Value<V>, T>;
-        const d = new Dictionary<Value<V>, T>();
+    static fromJS<T = DefaultPointer, V = DefaultPointer>(x: object): Dictionary<T, Value<V>> {
+        if (Dictionary.isDictionary<T, Value<V>>(x)) return x;
+        const d = new Dictionary<T, Value<V>>();
         Object.entries(x).forEach(([key, value]) => d.set(key, fromJS(value)));
         return d;
     }
diff --git a/implementations/javascript/packages/core/src/fold.ts b/implementations/javascript/packages/core/src/fold.ts
index b4e7d25..147086b 100644
--- a/implementations/javascript/packages/core/src/fold.ts
+++ b/implementations/javascript/packages/core/src/fold.ts
@@ -19,7 +19,7 @@ export interface FoldMethods<T, R> {
     record(r: Record<Value<T>, Tuple<Value<T>>, T>, k: Fold<T, R>): R;
     array(a: Array<Value<T>>, k: Fold<T, R>): R;
     set(s: Set<T>, k: Fold<T, R>): R;
-    dictionary(d: Dictionary<Value<T>, T>, k: Fold<T, R>): R;
+    dictionary(d: Dictionary<T>, k: Fold<T, R>): R;
 
     annotated(a: Annotated<T>, k: Fold<T, R>): R;
 
@@ -57,7 +57,7 @@ export abstract class ValueFold<T, R = T> implements FoldMethods<T, Value<R>> {
     set(s: Set<T>, k: Fold<T, Value<R>>): Value<R> {
         return s.map(k);
     }
-    dictionary(d: Dictionary<Value<T>, T>, k: Fold<T, Value<R>>): Value<R> {
+    dictionary(d: Dictionary<T>, k: Fold<T, Value<R>>): Value<R> {
         return d.mapEntries(([key, value]) => [k(key), k(value)]);
     }
     annotated(a: Annotated<T>, k: Fold<T, Value<R>>): Value<R> {
@@ -110,7 +110,7 @@ export function fold<T, R>(v: Value<T>, o: FoldMethods<T, R>): R {
                     return o.array(v, walk);
                 } else if (Set.isSet<T>(v)) {
                     return o.set(v, walk);
-                } else if (Dictionary.isDictionary<Value<T>, T>(v)) {
+                } else if (Dictionary.isDictionary<T>(v)) {
                     return o.dictionary(v, walk);
                 } else if (Annotated.isAnnotated<T>(v)) {
                     return o.annotated(v, walk);
@@ -153,7 +153,7 @@ export function isPointer<T>(v: Value<T>): v is T {
         },
         array(_a: Array<Value<T>>, _k: Fold<T, boolean>): boolean { return false; },
         set(_s: Set<T>, _k: Fold<T, boolean>): boolean { return false; },
-        dictionary(_d: Dictionary<Value<T>, T>, _k: Fold<T, boolean>): boolean {
+        dictionary(_d: Dictionary<T>, _k: Fold<T, boolean>): boolean {
             return false;
         },
 
diff --git a/implementations/javascript/packages/core/src/reader.ts b/implementations/javascript/packages/core/src/reader.ts
index 4cc6467..3b1607f 100644
--- a/implementations/javascript/packages/core/src/reader.ts
+++ b/implementations/javascript/packages/core/src/reader.ts
@@ -227,8 +227,8 @@ export class Reader<T> {
         }
     }
 
-    readDictionary(): Dictionary<Value<T>, T> {
-        return this.seq(new Dictionary<Value<T>, T>(),
+    readDictionary(): Dictionary<T> {
+        return this.seq(new Dictionary<T>(),
                         (k, acc) => {
                             this.skipws();
                             switch (this.peek()) {
diff --git a/implementations/javascript/packages/core/src/record.ts b/implementations/javascript/packages/core/src/record.ts
index b7d84e3..23e1099 100644
--- a/implementations/javascript/packages/core/src/record.ts
+++ b/implementations/javascript/packages/core/src/record.ts
@@ -26,13 +26,20 @@ export interface RecordConstructorInfo<L extends Value<T>, T = DefaultPointer> {
     arity: number;
 }
 
+export type InferredRecordType<L, FieldsType extends Tuple<any>> =
+    L extends symbol ? (FieldsType extends Tuple<Value<infer T>>
+        ? (Exclude<T, never> extends symbol ? Record<L, FieldsType, never> : Record<L, FieldsType, T>)
+        : (FieldsType extends Tuple<Value<never>>
+            ? Record<L, FieldsType, never>
+            : "TYPE_ERROR_cannotInferFieldsType" & [never])) :
+    L extends Value<infer T> ? (FieldsType extends Tuple<Value<T>>
+        ? Record<L, FieldsType, T>
+        : "TYPE_ERROR_cannotMatchFieldsTypeToLabelType" & [never]) :
+    "TYPE_ERROR_cannotInferPointerType" & [never];
+
 export function Record<L, FieldsType extends Tuple<any>>(
-    label: L, fields: FieldsType):
-        L extends Value<infer T>
-            ? (FieldsType extends Tuple<Value<T>>
-                ? Record<L, FieldsType, T>
-                : never)
-            : never
+    label: L,
+    fields: FieldsType): InferredRecordType<L, FieldsType>
 {
     (fields as any).label = label;
     return fields as any;
diff --git a/implementations/javascript/packages/core/src/strip.ts b/implementations/javascript/packages/core/src/strip.ts
index 73dba52..6812498 100644
--- a/implementations/javascript/packages/core/src/strip.ts
+++ b/implementations/javascript/packages/core/src/strip.ts
@@ -33,7 +33,7 @@ export function strip<T = DefaultPointer>(
             return (v.item as Value<T>[]).map(walk);
         } else if (Set.isSet<T>(v.item)) {
             return v.item.map(walk);
-        } else if (Dictionary.isDictionary<Value<T>, T>(v.item)) {
+        } else if (Dictionary.isDictionary<T>(v.item)) {
             return v.item.mapEntries((e) => [walk(e[0]), walk(e[1])]);
         } else {
             return v.item;
diff --git a/implementations/javascript/packages/core/src/values.ts b/implementations/javascript/packages/core/src/values.ts
index 4e38593..f690a58 100644
--- a/implementations/javascript/packages/core/src/values.ts
+++ b/implementations/javascript/packages/core/src/values.ts
@@ -28,4 +28,4 @@ export type Compound<T = DefaultPointer> =
       // Value<T> to any.
     | Array<Value<T>>
     | Set<T>
-    | Dictionary<Value<T>, T>;
+    | Dictionary<T>;
diff --git a/implementations/javascript/packages/core/test/codec.test.ts b/implementations/javascript/packages/core/test/codec.test.ts
index 70678bf..8754e67 100644
--- a/implementations/javascript/packages/core/test/codec.test.ts
+++ b/implementations/javascript/packages/core/test/codec.test.ts
@@ -140,7 +140,7 @@ describe('encoding and decoding pointers', () => {
     it('should store pointers embedded in map keys correctly', () => {
         const A1 = ({a: 1});
         const A2 = ({a: 1});
-        const m = new Dictionary<number, object>();
+        const m = new Dictionary<object, number>();
         m.set([A1], 1);
         m.set([A2], 2);
         expect(m.get(A1)).toBeUndefined();
@@ -157,7 +157,7 @@ describe('common test suite', () => {
     const samples = decodeWithAnnotations(samples_bin, { decodePointer: decodeDefaultPointer });
 
     const TestCases = Record.makeConstructor<{
-        cases: Dictionary<Value<DefaultPointer>, DefaultPointer>
+        cases: Dictionary<DefaultPointer>
     }>()(Symbol.for('TestCases'), ['cases']);
     type TestCases = ReturnType<typeof TestCases>;
 
@@ -257,7 +257,7 @@ describe('common test suite', () => {
     }
 
     const tests = (peel(TestCases._.cases(peel(samples) as TestCases)) as
-                   Dictionary<Value<DefaultPointer>, DefaultPointer>);
+                   Dictionary<DefaultPointer>);
     tests.forEach((t0: Value<DefaultPointer>, tName0: Value<DefaultPointer>) => {
         const tName = Symbol.keyFor(strip(tName0) as symbol)!;
         const t = peel(t0) as Record<symbol, any, DefaultPointer>;