new and old build with updated api docs

docs/api/theemo.token.category.md → docs/api/theemo.basetoken.category.md

@@ -1,13 +1,13 @@
 ---
-id: theemo.token.category
-title: Token.category property
+id: theemo.basetoken.category
+title: BaseToken.category property
 hide_title: true
 ---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[theemo](./theemo.md) &gt; [Token](./theemo.token.md) &gt; [category](./theemo.token.category.md)
+[theemo](./theemo.md) &gt; [BaseToken](./theemo.basetoken.md) &gt; [category](./theemo.basetoken.category.md)
 
-## Token.category property
+## BaseToken.category property
 
 The category helps token manager tools to generate the respective value in the appropriate format.
 

docs/api/theemo.token.colorscheme.md → docs/api/theemo.basetoken.colorscheme.md

@@ -1,13 +1,13 @@
 ---
-id: theemo.token.colorscheme
-title: Token.colorScheme property
+id: theemo.basetoken.colorscheme
+title: BaseToken.colorScheme property
 hide_title: true
 ---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[theemo](./theemo.md) &gt; [Token](./theemo.token.md) &gt; [colorScheme](./theemo.token.colorscheme.md)
+[theemo](./theemo.md) &gt; [BaseToken](./theemo.basetoken.md) &gt; [colorScheme](./theemo.basetoken.colorscheme.md)
 
-## Token.colorScheme property
+## BaseToken.colorScheme property
 
 Indicates the color scheme, to which the token belongs
 

docs/api/theemo.basetoken.description.md

@@ -0,0 +1,18 @@
+---
+id: theemo.basetoken.description
+title: BaseToken.description property
+hide_title: true
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[theemo](./theemo.md) &gt; [BaseToken](./theemo.basetoken.md) &gt; [description](./theemo.basetoken.description.md)
+
+## BaseToken.description property
+
+The description for the token
+
+<b>Signature:</b>
+
+```typescript
+description?: string;
+```

docs/api/theemo.basetoken.md

@@ -0,0 +1,33 @@
+---
+id: theemo.basetoken
+title: BaseToken
+hide_title: true
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[theemo](./theemo.md) &gt; [BaseToken](./theemo.basetoken.md)
+
+## BaseToken interface
+
+The base token, with all properties shared amongst various token types used throughout theemo.
+
+<b>Signature:</b>
+
+```typescript
+export interface BaseToken 
+```
+
+## Remarks
+
+That is, figma is subclassing this with its own token and specific figma-related properties.
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [category](./theemo.basetoken.category.md) | <code>string</code> | The category helps token manager tools to generate the respective value in the appropriate format. |
+|  [colorScheme](./theemo.basetoken.colorscheme.md) | <code>string</code> | Indicates the color scheme, to which the token belongs |
+|  [description](./theemo.basetoken.description.md) | <code>string</code> | The description for the token |
+|  [name](./theemo.basetoken.name.md) | <code>string</code> | The tokens name |
+|  [reference](./theemo.basetoken.reference.md) | <code>string</code> | The name of the reference this token points to |
+|  [type](./theemo.basetoken.type.md) | <code>TokenType</code> | The type describes the usage level of a token |

docs/api/theemo.basetoken.name.md

@@ -0,0 +1,18 @@
+---
+id: theemo.basetoken.name
+title: BaseToken.name property
+hide_title: true
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[theemo](./theemo.md) &gt; [BaseToken](./theemo.basetoken.md) &gt; [name](./theemo.basetoken.name.md)
+
+## BaseToken.name property
+
+The tokens name
+
+<b>Signature:</b>
+
+```typescript
+name: string;
+```

docs/api/theemo.token.reference.md → docs/api/theemo.basetoken.reference.md

@@ -1,13 +1,13 @@
 ---
-id: theemo.token.reference
-title: Token.reference property
+id: theemo.basetoken.reference
+title: BaseToken.reference property
 hide_title: true
 ---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[theemo](./theemo.md) &gt; [Token](./theemo.token.md) &gt; [reference](./theemo.token.reference.md)
+[theemo](./theemo.md) &gt; [BaseToken](./theemo.basetoken.md) &gt; [reference](./theemo.basetoken.reference.md)
 
-## Token.reference property
+## BaseToken.reference property
 
 The name of the reference this token points to
 

docs/api/theemo.token.type.md → docs/api/theemo.basetoken.type.md

@@ -1,13 +1,13 @@
 ---
-id: theemo.token.type
-title: Token. property
+id: theemo.basetoken.type
+title: BaseToken. property
 hide_title: true
 ---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[theemo](./theemo.md) &gt; [Token](./theemo.token.md) &gt; [type](./theemo.token.type.md)
+[theemo](./theemo.md) &gt; [BaseToken](./theemo.basetoken.md) &gt; [type](./theemo.basetoken.type.md)
 
-## Token.type property
+## BaseToken.type property
 
 The type describes the usage level of a token
 

docs/api/theemo.buildertool.build.md

@@ -0,0 +1,21 @@
+---
+id: theemo.buildertool.build
+title: BuilderTool.build() method
+hide_title: true
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[theemo](./theemo.md) &gt; [BuilderTool](./theemo.buildertool.md) &gt; [build](./theemo.buildertool.build.md)
+
+## BuilderTool.build() method
+
+Executes the build of the tool
+
+<b>Signature:</b>
+
+```typescript
+build(): void;
+```
+<b>Returns:</b>
+
+`void`

docs/api/theemo.buildertool.md

@@ -0,0 +1,28 @@
+---
+id: theemo.buildertool
+title: BuilderTool
+hide_title: true
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[theemo](./theemo.md) &gt; [BuilderTool](./theemo.buildertool.md)
+
+## BuilderTool interface
+
+This is for tools used during the `build` command and trigger the execution of that tool.
+
+<b>Signature:</b>
+
+```typescript
+export interface BuilderTool 
+```
+
+## Example
+
+Style Dictionary may be your builder tool and executes the build process
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [build()](./theemo.buildertool.build.md) | Executes the build of the tool |

docs/api/theemo.figmareaderconfig.figmafile.md

@@ -0,0 +1,18 @@
+---
+id: theemo.figmareaderconfig.figmafile
+title: FigmaReaderConfig.figmaFile property
+hide_title: true
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[theemo](./theemo.md) &gt; [FigmaReaderConfig](./theemo.figmareaderconfig.md) &gt; [figmaFile](./theemo.figmareaderconfig.figmafile.md)
+
+## FigmaReaderConfig.figmaFile property
+
+The URL for the figma file, get it though ENV
+
+<b>Signature:</b>
+
+```typescript
+figmaFile: string;
+```

docs/api/theemo.figmareaderconfig.figmasecret.md

@@ -0,0 +1,18 @@
+---
+id: theemo.figmareaderconfig.figmasecret
+title: FigmaReaderConfig.figmaSecret property
+hide_title: true
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[theemo](./theemo.md) &gt; [FigmaReaderConfig](./theemo.figmareaderconfig.md) &gt; [figmaSecret](./theemo.figmareaderconfig.figmasecret.md)
+
+## FigmaReaderConfig.figmaSecret property
+
+The secret for the figma file, get it though ENV
+
+<b>Signature:</b>
+
+```typescript
+figmaSecret: string;
+```

docs/api/theemo.figmareaderconfig.getnamefromtext.md

@@ -0,0 +1,18 @@
+---
+id: theemo.figmareaderconfig.getnamefromtext
+title: FigmaReaderConfig.getNameFromText property
+hide_title: true
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[theemo](./theemo.md) &gt; [FigmaReaderConfig](./theemo.figmareaderconfig.md) &gt; [getNameFromText](./theemo.figmareaderconfig.getnamefromtext.md)
+
+## FigmaReaderConfig.getNameFromText property
+
+To retrieve the name for a token from a `Node`
+
+<b>Signature:</b>
+
+```typescript
+getNameFromText?: (node: Node<'TEXT'>) => string;
+```

docs/api/theemo.figmareaderconfig.getvaluefromtext.md

@@ -0,0 +1,18 @@
+---
+id: theemo.figmareaderconfig.getvaluefromtext
+title: FigmaReaderConfig.getValueFromText property
+hide_title: true
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[theemo](./theemo.md) &gt; [FigmaReaderConfig](./theemo.figmareaderconfig.md) &gt; [getValueFromText](./theemo.figmareaderconfig.getvaluefromtext.md)
+
+## FigmaReaderConfig.getValueFromText property
+
+To retrieve the value for a token from a `Node`
+
+<b>Signature:</b>
+
+```typescript
+getValueFromText?: (node: Node<'TEXT'>) => string;
+```

docs/api/theemo.figmareaderconfig.istokenbystyle.md

@@ -0,0 +1,18 @@
+---
+id: theemo.figmareaderconfig.istokenbystyle
+title: FigmaReaderConfig.isTokenByStyle property
+hide_title: true
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[theemo](./theemo.md) &gt; [FigmaReaderConfig](./theemo.figmareaderconfig.md) &gt; [isTokenByStyle](./theemo.figmareaderconfig.istokenbystyle.md)
+
+## FigmaReaderConfig.isTokenByStyle property
+
+This is to verify that a given `Style` node found in figmas node tree is considered to be a token or not
+
+<b>Signature:</b>
+
+```typescript
+isTokenByStyle?: (style: Style) => boolean;
+```

docs/api/theemo.figmareaderconfig.istokenbytext.md

@@ -0,0 +1,18 @@
+---
+id: theemo.figmareaderconfig.istokenbytext
+title: FigmaReaderConfig.isTokenByText property
+hide_title: true
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[theemo](./theemo.md) &gt; [FigmaReaderConfig](./theemo.figmareaderconfig.md) &gt; [isTokenByText](./theemo.figmareaderconfig.istokenbytext.md)
+
+## FigmaReaderConfig.isTokenByText property
+
+This is to verify that a given `Node`<!-- -->found in figmas node tree is considered to be a token or not, depending on the name of the node
+
+<b>Signature:</b>
+
+```typescript
+isTokenByText?: (node: Node<'TEXT'>) => boolean;
+```

docs/api/theemo.figmareaderconfig.md

@@ -0,0 +1,31 @@
+---
+id: theemo.figmareaderconfig
+title: FigmaReaderConfig
+hide_title: true
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[theemo](./theemo.md) &gt; [FigmaReaderConfig](./theemo.figmareaderconfig.md)
+
+## FigmaReaderConfig interface
+
+Config for Figma as a `ReaderTool`
+
+<b>Signature:</b>
+
+```typescript
+export interface FigmaReaderConfig 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [figmaFile](./theemo.figmareaderconfig.figmafile.md) | <code>string</code> | The URL for the figma file, get it though ENV |
+|  [figmaSecret](./theemo.figmareaderconfig.figmasecret.md) | <code>string</code> | The secret for the figma file, get it though ENV |
+|  [getNameFromText](./theemo.figmareaderconfig.getnamefromtext.md) | <code>(node: Node&lt;'TEXT'&gt;) =&gt; string</code> | To retrieve the name for a token from a <code>Node</code> |
+|  [getValueFromText](./theemo.figmareaderconfig.getvaluefromtext.md) | <code>(node: Node&lt;'TEXT'&gt;) =&gt; string</code> | To retrieve the value for a token from a <code>Node</code> |
+|  [isTokenByStyle](./theemo.figmareaderconfig.istokenbystyle.md) | <code>(style: Style) =&gt; boolean</code> | This is to verify that a given <code>Style</code> node found in figmas node tree is considered to be a token or not |
+|  [isTokenByText](./theemo.figmareaderconfig.istokenbytext.md) | <code>(node: Node&lt;'TEXT'&gt;) =&gt; boolean</code> | This is to verify that a given <code>Node</code>found in figmas node tree is considered to be a token or not, depending on the name of the node |
+|  [referencer](./theemo.figmareaderconfig.referencer.md) | <code>FigmaReferencerConfig</code> | The config for the referencer |
+|  [tool](./theemo.figmareaderconfig.tool.md) | <code>Tools.Figma</code> |  |

docs/api/theemo.figmareaderconfig.referencer.md

@@ -0,0 +1,18 @@
+---
+id: theemo.figmareaderconfig.referencer
+title: FigmaReaderConfig.referencer property
+hide_title: true
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[theemo](./theemo.md) &gt; [FigmaReaderConfig](./theemo.figmareaderconfig.md) &gt; [referencer](./theemo.figmareaderconfig.referencer.md)
+
+## FigmaReaderConfig.referencer property
+
+The config for the referencer
+
+<b>Signature:</b>
+
+```typescript
+referencer?: FigmaReferencerConfig;
+```