feat(types): loosening the Platform type to allow for extension (#926)

amzn · Mar 23, 2023 · c43263b · c43263b
1 parent c01f4cf
commit c43263b
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 12 deletions.
diff --git a/types/Platform.d.ts b/types/Platform.d.ts
@@ -14,7 +14,7 @@
 import { Options } from './Options';
 import { File } from './File';
 
-export interface Platform {
+export type Platform<PlatformType = Record<string, any>> = {
   transformGroup?: string;
   transforms?: string[];
   basePxFontSize?: number;
@@ -23,4 +23,4 @@ export interface Platform {
   files?: File[];
   actions?: string[];
   options?: Options;
-}
+} & PlatformType;
diff --git a/types/Transform.d.ts b/types/Transform.d.ts
@@ -15,32 +15,35 @@ import { Matcher } from './Matcher';
 import { TransformedToken } from './TransformedToken';
 import { Platform } from './Platform';
 
-export interface NameTransform {
+export interface NameTransform<PlatformType = Record<string,any>> {
   type: "name";
   matcher?: Matcher;
   transformer: (
     token: TransformedToken,
-    options?: Platform
+    options: Platform<PlatformType>
   ) => string;
 }
 
-export interface ValueTransform {
+export interface ValueTransform<PlatformType = Record<string,any>> {
   type: "value";
   transitive?: boolean;
   matcher?: Matcher;
   transformer: (
     token: TransformedToken,
-    options?: Platform
+    options: Platform<PlatformType>
   ) => any;
 }
 
-export interface AttributeTransform {
+export interface AttributeTransform<PlatformType = Record<string,any>> {
   type: "attribute";
   matcher?: Matcher;
   transformer: (
     token: TransformedToken,
-    options?: Platform
+    options: Platform<PlatformType>
   ) => { [key: string]: any };
 }
 
-export type Transform = NameTransform | ValueTransform | AttributeTransform;
+export type Transform<PlatformType = Record<string,any>> =
+  | NameTransform<PlatformType>
+  | ValueTransform<PlatformType>
+  | AttributeTransform<PlatformType>;
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -49,8 +49,8 @@ declare namespace StyleDictionary {
   type Matcher = _Matcher;
   type Options = _Options;
   type Parser = _Parser;
-  type Platform = _Platform;
-  type Transform = _Transform;
+  type Platform<PlatformType = Record<string,any>> = _Platform<PlatformType>;
+  type Transform<PlatformType = Record<string,any>> = _Transform<PlatformType>;
   type TransformedToken = _TransformedToken;
   type TransformedTokens = _TransformedTokens;
   type TransformGroup = _TransformGroup;
@@ -97,7 +97,7 @@ declare namespace StyleDictionary {
      * });
      * ```
      */
-    registerTransform(transform: Named<Transform>): this;
+    registerTransform<PlatformType>(transform: Named<Transform<PlatformType>>): this;
 
     /**
      * Add a custom transformGroup to the Style Dictionary, which is a

diff --git a/types/index.test-d.ts b/types/index.test-d.ts
@@ -101,6 +101,29 @@ expectType<StyleDictionary.Core>(
   })
 );
 
+type CustomPlatform = {
+  colorMode: 'light' | 'dark';
+}
+
+expectType<StyleDictionary.Core>(
+  StyleDictionary.registerTransform<CustomPlatform>({
+    name: "colormode",
+    type: "value",
+    matcher: function (token) {
+      return token.attributes?.category === "color";
+    },
+    transformer: function (token, platform) {
+      expectType<StyleDictionary.TransformedToken>(token);
+      expectType<StyleDictionary.Platform<CustomPlatform>>(platform);
+      if (platform.colorMode === 'light') {
+        return 'light'
+      } else {
+        return 'dark'
+      }
+    },
+  })
+);
+
 expectType<StyleDictionary.Core>(
   StyleDictionary.registerTransformGroup({
     name: "Swift",
@@ -154,6 +177,12 @@ expectAssignable<StyleDictionary.Platform>({
   transforms: [`attribute/cti`],
 });
 
+expectAssignable<StyleDictionary.Platform>({
+  colorMode: 'dark',
+  files: [],
+  transformGroup: 'scss',
+});
+
 expectAssignable<StyleDictionary.Platform>({
   transforms: [`attribute/cti`],
   files: [{