feat(path): no regression from npm-ramda

ikatyang · Aug 6, 2017 · c5ea9ed · c5ea9ed
1 parent c6ea915
commit c5ea9ed
Show file tree

Hide file tree

Showing 7 changed files with 82 additions and 4 deletions.
diff --git a/snapshots/path.ts b/snapshots/path.ts
@@ -19,5 +19,5 @@ R_path(path, object);
 
 // @dts-jest:pass -> any
 R_path(['a', 'b', 'c'])(a_1_b_2_c_3);
-// @dts-jest:pass -> any
+// @dts-jest:pass -> 1 | 2 | 3
 R_path(['a', 'b', 'c'], a_1_b_2_c_3);
diff --git a/snapshots/ramda-tests.ts b/snapshots/ramda-tests.ts
@@ -2127,7 +2127,7 @@ import * as R from '../ramda/dist/index';
 
 // @dts-jest:group path
 (() => {
-  // @dts-jest:pass -> any
+  // @dts-jest:pass -> number
   R.path(['a', 'b'], { a: { b: 2 } }); //=> 2
   // @dts-jest:pass -> any
   R.path(['a', 'b'])({ a: { b: 2 } }); //=> 2

diff --git a/tasks/mixins/path.d.ts b/tasks/mixins/path.d.ts
@@ -0,0 +1,38 @@
+// tslint:disable:prettier naming-convention
+
+// in-based
+declare function path<T1 extends string, T2 extends string, TResult>(path: [T1, T2], obj: {[K1 in T1]: {[K2 in T2]: TResult}}): TResult;
+declare function path<T1 extends string, T2 extends string, T3 extends string, TResult>(path: [T1, T2, T3], obj: {[K1 in T1]: {[K2 in T2]: {[K3 in T3]: TResult}}}): TResult;
+declare function path<T1 extends string, T2 extends string, T3 extends string, T4 extends string, TResult>(path: [T1, T2, T3, T4], obj: {[K1 in T1]: {[K2 in T2]: {[K3 in T3]: {[K4 in T4]: TResult}}}}): TResult;
+declare function path<T1 extends string, T2 extends string, T3 extends string, T4 extends string, T5 extends string, TResult>(path: [T1, T2, T3, T4, T5], obj: {[K1 in T1]: {[K2 in T2]: {[K3 in T3]: {[K4 in T4]: {[K5 in T5]: TResult}}}}}): TResult;
+declare function path<T1 extends string, T2 extends string, T3 extends string, T4 extends string, T5 extends string, T6 extends string, TResult>(path: [T1, T2, T3, T4, T5, T6], obj: {[K1 in T1]: {[K2 in T2]: {[K3 in T3]: {[K4 in T4]: {[K5 in T5]: {[K6 in T6]: TResult}}}}}}): TResult;
+declare function path<T1 extends string, T2 extends string, T3 extends string, T4 extends string, T5 extends string, T6 extends string, T7 extends string, TResult>(path: [T1, T2, T3, T4, T5, T6, T7], obj: {[K1 in T1]: {[K2 in T2]: {[K3 in T3]: {[K4 in T4]: {[K5 in T5]: {[K6 in T6]: {[K7 in T7]: TResult}}}}}}}): TResult;
+declare function path<T1 extends string, T2 extends string, T3 extends string, T4 extends string, T5 extends string, T6 extends string, T7 extends string, T8 extends string, TResult>(path: [T1, T2, T3, T4, T5, T6, T7, T8], obj: {[K1 in T1]: {[K2 in T2]: {[K3 in T3]: {[K4 in T4]: {[K5 in T5]: {[K6 in T6]: {[K7 in T7]: {[K8 in T8]: TResult}}}}}}}}): TResult;
+declare function path<T1 extends string, T2 extends string, T3 extends string, T4 extends string, T5 extends string, T6 extends string, T7 extends string, T8 extends string, T9 extends string, TResult>(path: [T1, T2, T3, T4, T5, T6, T7, T8, T9], obj: {[K1 in T1]: {[K2 in T2]: {[K3 in T3]: {[K4 in T4]: {[K5 in T5]: {[K6 in T6]: {[K7 in T7]: {[K8 in T8]: {[K9 in T9]: TResult}}}}}}}}}): TResult;
+
+// Record-based
+declare function path<K1 extends string, K2 extends string, TResult>(path: [K1, K2], obj: Record<K1,Record<K2,TResult>>): TResult;
+declare function path<K1 extends string, K2 extends string, K3 extends string, TResult>(path: [K1, K2, K3], obj: Record<K1,Record<K2,Record<K3,TResult>>>): TResult;
+declare function path<K1 extends string, K2 extends string, K3 extends string, K4 extends string, TResult>(path: [K1, K2, K3, K4], obj: Record<K1,Record<K2,Record<K3,Record<K4,TResult>>>>): TResult;
+declare function path<K1 extends string, K2 extends string, K3 extends string, K4 extends string, K5 extends string, TResult>(path: [K1, K2, K3, K4, K5], obj: Record<K1,Record<K2,Record<K3,Record<K4,Record<K5,TResult>>>>>): TResult;
+declare function path<K1 extends string, K2 extends string, K3 extends string, K4 extends string, K5 extends string, K6 extends string, TResult>(path: [K1, K2, K3, K4, K5, K6], obj: Record<K1,Record<K2,Record<K3,Record<K4,Record<K5,Record<K6,TResult>>>>>>): TResult;
+declare function path<K1 extends string, K2 extends string, K3 extends string, K4 extends string, K5 extends string, K6 extends string, K7 extends string, TResult>(path: [K1, K2, K3, K4, K5, K6, K7], obj: Record<K1,Record<K2,Record<K3,Record<K4,Record<K5,Record<K6,Record<K7,TResult>>>>>>>): TResult;
+declare function path<K1 extends string, K2 extends string, K3 extends string, K4 extends string, K5 extends string, K6 extends string, K7 extends string, K8 extends string, TResult>(path: [K1, K2, K3, K4, K5, K6, K7, K8], obj: Record<K1,Record<K2,Record<K3,Record<K4,Record<K5,Record<K6,Record<K7,Record<K8,TResult>>>>>>>>): TResult;
+declare function path<K1 extends string, K2 extends string, K3 extends string, K4 extends string, K5 extends string, K6 extends string, K7 extends string, K8 extends string, K9 extends string, TResult>(path: [K1, K2, K3, K4, K5, K6, K7, K8, K9], obj: Record<K1,Record<K2,Record<K3,Record<K4,Record<K5,Record<K6,Record<K7,Record<K8,Record<K9,TResult>>>>>>>>>): TResult;
+
+// for each path length list all combinations of objects and homogeneous arrays... tuples not supported yet.
+
+declare function path<T1 extends string, TResult>(path: [T1], obj: {[K1 in T1]: TResult}): TResult;
+declare function path<T1 extends number, TResult>(path: [T1], obj: TResult[]): TResult;
+declare function path<T1 extends string, T2 extends string, TResult>(path: [T1, T2], obj: {[K1 in T1]: {[K2 in T2]: TResult}}): TResult;
+declare function path<T1 extends string, T2 extends number, TResult>(path: [T1, T2], obj: {[K1 in T1]: TResult[]}): TResult;
+declare function path<T1 extends number, T2 extends string, TResult>(path: [T1, T2], obj: {[K2 in T2]: TResult}[]): TResult;
+declare function path<T1 extends number, T2 extends number, TResult>(path: [T1, T2], obj: TResult[][]): TResult;
+declare function path<T1 extends string, T2 extends string, T3 extends string, TResult>(path: [T1, T2, T3], obj: {[K1 in T1]: {[K2 in T2]: {[K3 in T3]: TResult}}}): TResult;
+declare function path<T1 extends string, T2 extends string, T3 extends number, TResult>(path: [T1, T2, T3], obj: {[K1 in T1]: {[K2 in T2]: TResult[]}}): TResult;
+declare function path<T1 extends string, T2 extends number, T3 extends string, TResult>(path: [T1, T2, T3], obj: {[K1 in T1]: {[K3 in T3]: TResult}[]}): TResult;
+declare function path<T1 extends string, T2 extends number, T3 extends number, TResult>(path: [T1, T2, T3], obj: {[K1 in T1]: TResult[][]}): TResult;
+declare function path<T1 extends number, T2 extends string, T3 extends string, TResult>(path: [T1, T2, T3], obj: {[K2 in T2]: {[K3 in T3]: TResult}}[]): TResult;
+declare function path<T1 extends number, T2 extends string, T3 extends number, TResult>(path: [T1, T2, T3], obj: {[K2 in T2]: TResult[]}[]): TResult;
+declare function path<T1 extends number, T2 extends number, T3 extends string, TResult>(path: [T1, T2, T3], obj: {[K3 in T3]: TResult}[][]): TResult;
+declare function path<T1 extends number, T2 extends number, T3 extends number, TResult>(path: [T1, T2, T3], obj: TResult[][][]): TResult;
diff --git a/tasks/utils/bind-mixin.ts b/tasks/utils/bind-mixin.ts
@@ -0,0 +1,24 @@
+import * as dts from 'dts-element';
+
+export const bind_mixin = (
+  members: dts.ITopLevelMember[],
+  function_types: dts.IFunctionType[],
+) => {
+  const main_type_declaration = members.find(
+    dts.is_type_declaration,
+  ) as dts.ITypeDeclaration;
+
+  const type = main_type_declaration.type as dts.IObjectType;
+  type.members!.splice(
+    1,
+    0,
+    ...function_types.map(function_type =>
+      dts.create_object_member({
+        owned: dts.create_function_declaration({
+          name: undefined,
+          type: function_type,
+        }),
+      }),
+    ),
+  );
+};
diff --git a/tasks/utils/generate-file-content.ts b/tasks/utils/generate-file-content.ts
@@ -7,6 +7,7 @@ import {
   placeholder_name_abbr,
 } from '../../templates/utils/constants';
 import { bind_jsdoc } from './bind-jsdoc';
+import { bind_mixin } from './bind-mixin';
 import { placeholder, selectable } from './constants';
 
 export function generate_file_content(filename: string) {
@@ -40,6 +41,21 @@ function get_top_level_members(filename: string): dts.ITopLevelMember[] {
     bind_member_jsdoc_and_add_export_equal();
   }
 
+  if (function_name === 'path') {
+    bind_mixin(
+      members,
+      dts
+        .parse(
+          fs.readFileSync(
+            path.resolve(__dirname, '../mixins/path.d.ts'),
+            'utf8',
+          ),
+        )
+        .members.filter(dts.is_function_declaration)
+        .map(function_declaration => function_declaration.type!),
+    );
+  }
+
   return members;
 
   function bind_member_jsdoc_and_add_export_equal() {

diff --git a/tests/__snapshots__/path.ts.snap b/tests/__snapshots__/path.ts.snap
@@ -2,7 +2,7 @@
 
 exports[`R_path(['a', 'b', 'c'])(a_1_b_2_c_3) 1`] = `"any"`;
 
-exports[`R_path(['a', 'b', 'c'], a_1_b_2_c_3) 1`] = `"any"`;
+exports[`R_path(['a', 'b', 'c'], a_1_b_2_c_3) 1`] = `"1 | 2 | 3"`;
 
 exports[`R_path(path) 1`] = `"(object: {}) => any"`;
 

diff --git a/tests/__snapshots__/ramda-tests.ts.snap b/tests/__snapshots__/ramda-tests.ts.snap
@@ -995,7 +995,7 @@ exports[`partition R.partition(R.contains('s'), { a: 'sss', b: 'ttt', foo: 'bars
 
 exports[`path R.path(['a', 'b'])({ a: { b: 2 } }) 1`] = `"any"`;
 
-exports[`path R.path(['a', 'b'], { a: { b: 2 } }) 1`] = `"any"`;
+exports[`path R.path(['a', 'b'], { a: { b: 2 } }) 1`] = `"number"`;
 
 exports[`pathEq R.filter<User>(isFamous, users) 1`] = `"User[]"`;