Add Typescript support

[fedeci]

Description

This pull request adds index.d.ts file to provide typescript type information about contrast-colors module.
This closes #74

Motivation

This simplify the use of the module in typescript projects.

Screenshots

To-do list

• I have read the CONTRIBUTING document.

• This pull request is ready to merge.

[NateBaldwinDesign]

Thank you for this contribution @fedeci !

[fedeci]

You're welcome!

[NateBaldwinDesign]

FYI this feature added to release 1.0.0-alpha.7

[KirdesMF]

is it possible to create an interface for the colorScales parameter in the generateAdaptiveTheme function ?
for example :

const uiRatios = [1, 1.5, 2, 2.5, 3, 4.5, 7, 11, 16];

const redScale: ColorScales = {
   name: 'red',
   ratios: uiRatios,
   colorKeys:  [],
   colorspace: 'HEX'

}

const blueScale: ColorScales = {
   name: 'blue',
   ratios: uiRatios,
   colorKeys:  [],
   colorspace: 'HEX'
}

generateAdaptiveTheme({
   colorScales: [redScale, blueScale],
   baseScale: "red"
})

for now I'm just extending the ContrastColors module

import '@adobe/leonardo-contrast-colors';
declare module '@adobe/leonardo-contrast-colors' {
   export interface ColorScales {
      name: string;
      colorKeys: string[];
      colorspace: Colorspace;
      ratios: number[] | { [key: string]: number };
   }
}

btw really great work, impressive !!

[KirdesMF]

and there is an issue with the Colorspace union type:

  type Colorspace = 'CAM02' | 'CAM02p' | 'LCH' | 'LAB' | 'HSL' | 'HSLuv' | 'RGB' | 'HSV' | 'HEX';

HEX provides an issue.

then rn I'm good with :

import '@adobe/leonardo-contrast-colors';
declare module '@adobe/leonardo-contrast-colors' {
   export type ColorScales = {
      name: string;
      colorKeys: string[];
      colorspace: Exclude<Colorspace, 'HEX'>;
      ratios: number[] | { [key: string]: number };
   };
}

[KirdesMF]

Thx ! Next time time should I create an issue ?

[fedeci]

If the PR has already been merged it is better to create an issue. 👍