Types: Add couple of tests, move utils to new file (#8526)

chartjs · Feb 26, 2021 · 3460ef1 · 3460ef1
1 parent bd303f4
commit 3460ef1
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 16 deletions.
diff --git a/types/index.esm.d.ts b/types/index.esm.d.ts
@@ -12,6 +12,8 @@
  * }
  */
 
+import { DeepPartial, DistributiveArray } from './utils';
+
 import { TimeUnit } from './adapters';
 import { AnimationEvent } from './animation';
 import { AnyObject, EmptyObject } from './basic';
@@ -3085,21 +3087,6 @@ export const RadialLinearScale: ChartComponent & {
   new <O extends RadialLinearScaleOptions = RadialLinearScaleOptions>(cfg: AnyObject): RadialLinearScale<O>;
 };
 
-// DeepPartial implementation taken from the utility-types NPM package, which is
-// Copyright (c) 2016 Piotr Witek <piotrek.witek@gmail.com> (http://piotrwitek.github.io)
-// and used under the terms of the MIT license
-export type DeepPartial<T> = T extends Function
-  ? T
-  : T extends Array<infer U>
-  ? _DeepPartialArray<U>
-  : T extends object
-  ? _DeepPartialObject<T>
-  : T | undefined;
-  type _DeepPartialArray<T> = Array<DeepPartial<T>>
-  type _DeepPartialObject<T> = { [P in keyof T]?: DeepPartial<T[P]> };
-
-export type DistributiveArray<T> = T extends unknown ? T[] : never
-
 export interface CartesianScaleTypeRegistry {
   linear: {
     options: LinearScaleOptions;
@@ -3254,7 +3241,6 @@ export type DefaultDataPoint<TType extends ChartType> = DistributiveArray<ChartT
 
 export type ParsedDataType<TType extends ChartType = ChartType> = ChartTypeRegistry[TType]['parsedDataType'];
 
-
 export interface ChartDatasetProperties<TType extends ChartType, TData> {
   type?: TType;
   data: TData;

diff --git a/types/tests/parsed.data.type.ts b/types/tests/parsed.data.type.ts
@@ -0,0 +1,18 @@
+import { ParsedDataType } from '../index.esm';
+
+interface test {
+  pie: ParsedDataType<'pie'>,
+  line: ParsedDataType<'line'>,
+  testA: ParsedDataType<'pie' | 'line' | 'bar'>
+  testB: ParsedDataType<'pie' | 'line' | 'bar'>
+  testC: ParsedDataType<'pie' | 'line' | 'bar'>
+}
+
+export const testImpl: test = {
+  pie: 1,
+  line: { x: 1, y: 2 },
+  testA: 1,
+  testB: { x: 1, y: 2 },
+  // @ts-expect-error testC should be limited to pie/line datatypes
+  testC: 'test'
+};
diff --git a/types/tests/scriptable.ts b/types/tests/scriptable.ts
@@ -0,0 +1,21 @@
+import { Scriptable } from '../index.esm';
+
+interface test {
+  pie?: Scriptable<number, 'pie'>,
+  line?: Scriptable<number, 'line'>,
+  testA?: Scriptable<number, 'pie' | 'line' | 'bar'>
+  testB?: Scriptable<number, 'pie' | 'line' | 'bar'>
+  testC?: Scriptable<number, 'pie' | 'line' | 'bar'>
+}
+
+const pieScriptable: Scriptable<number, 'pie'> = (ctx) => ctx.parsed;
+const lineScriptable: Scriptable<number, 'line'> = (ctx) => ctx.parsed.x + ctx.parsed.y;
+
+export const testImpl: test = {
+  pie: (ctx) => ctx.parsed,
+  line: (ctx) => ctx.parsed.x + ctx.parsed.y,
+  testA: pieScriptable,
+  testB: lineScriptable,
+  // @FIXME ts-expect-error combined type should not be any
+  testC: (ctx) => ctx.fail
+};
diff --git a/types/utils.d.ts b/types/utils.d.ts
@@ -0,0 +1,15 @@
+
+// DeepPartial implementation taken from the utility-types NPM package, which is
+// Copyright (c) 2016 Piotr Witek <piotrek.witek@gmail.com> (http://piotrwitek.github.io)
+// and used under the terms of the MIT license
+export type DeepPartial<T> = T extends Function
+  ? T
+  : T extends Array<infer U>
+  ? _DeepPartialArray<U>
+  : T extends object
+  ? _DeepPartialObject<T>
+  : T | undefined;
+  type _DeepPartialArray<T> = Array<DeepPartial<T>>
+type _DeepPartialObject<T> = { [P in keyof T]?: DeepPartial<T[P]> };
+
+export type DistributiveArray<T> = T extends unknown ? T[] : never