@apia/theme 0.2.2 → 0.3.0

package/LICENSE.md

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) [year] [fullname]
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/cleanDist.json

@@ -0,0 +1,3 @@
+{
+  "cleanDist": 0.006456232710121412
+}

package/dist/index.d.ts

@@ -90,11 +90,11 @@ interface TStates {
 }
 type TGetColorStateDefinition = Pick<ThemeUICSSObject, 'backgroundColor' | 'borderColor' | 'borderLeftColor' | 'borderRightColor' | 'borderBottomColor' | 'borderTopColor' | 'color'>;
 type TParsedPaletteColorStateRetriever = (color: string, state: keyof TStates) => string;
-type TColorStateRetriever = (color: string, state: keyof TStates, theme: Theme) => string;
+type TColorStateRetriever = (color: string, state: keyof TStates, palette: TParsedPalette) => string;
 type TParsedPaletteStateRetriever = (definition: Partial<TGetColorStateDefinition>, state: keyof TStates) => TGetColorStateDefinition;
-type TStateRetriever = (definition: Partial<TGetColorStateDefinition>, state: keyof TStates, theme: Theme) => TGetColorStateDefinition;
+type TStateRetriever = (definition: Partial<TGetColorStateDefinition>, state: keyof TStates, palette: TParsedPalette) => TGetColorStateDefinition;
 type TParsedPaletteStatesRetriever = (definition: Partial<TGetColorStateDefinition>, states?: TStates) => ThemeUICSSObject;
-type TStatesRetriever = (definition: Partial<TGetColorStateDefinition>, theme: Theme, states?: TStates) => ThemeUICSSObject;
+type TStatesRetriever = (definition: Partial<TGetColorStateDefinition>, palette: TParsedPalette, states?: TStates) => ThemeUICSSObject;
 type TParsedPaletteStatesByDefinition = (definition: Partial<TGetColorStateDefinition>, options?: TGetColorsAndStatesOptions) => ThemeUICSSObject;
 type TApplyStates = (properties: Record<string, TColorDefinition | string | Record<string, unknown>>[], theme: Theme, states?: TStates) => void;
 interface TActionDefinition<OpacityColor = undefined | string | IActionOpacity> {
@@ -122,6 +122,7 @@ interface TPalette<ColorDefinition = IColorDefinition, ColorModifier = TColorMod
     border: {
         article: string;
         field: string;
+        ghost: string;
         section: string;
     };
     common: {
@@ -191,7 +192,11 @@ type TParsedPalette = Required<TPalette<Required<IColorDefinition>, TColorModifi
     getStatesFromDefinition: TParsedPaletteStatesByDefinition;
     getStatesFromPath: typeof getColorsAndStatesByPath;
     getSelectedColors: () => ThemeUICSSObject;
+    getColorsByPath: (path: string, options?: {
+        mergeObject?: Record<string, any>;
+    }) => TGetColorStateDefinition & Record<string, any>;
 };
+type TCustomPalette = Partial<TPalette> & Partial<Pick<TParsedPalette, 'applyStates' | 'buildColorsObject' | 'buildStateObject' | 'getColor' | 'getColorStates' | 'getSelectedColors' | 'getContrastText' | 'getOneState' | 'getStatesForColors' | 'getStatesFromDefinition' | 'getStatesFromPath'>>;
 type TColorDefinitionPrimitive = Pick<ThemeUICSSObject, 'color' | 'backgroundColor' | 'borderColor'>;
 type TColorDefinition = TColorDefinitionPrimitive & {
     active?: TColorDefinitionPrimitive;
@@ -208,9 +213,10 @@ declare global {
         customPalette?: TPalette;
         defaultPalette?: TPalette;
     }
-}
+}
+type TThemeModifier = (theme: Theme) => Theme;
 
-declare function parsePalette(palette: TPalette, theme: Theme): TParsedPalette;
+declare function parsePalette(palette: TCustomPalette): TParsedPalette;
 
 type CustomTheme = Omit<Theme, 'palette'>;
 
@@ -245,7 +251,7 @@ declare const getColorStates: TStatesRetriever;
  * Esta función calcula los colores de los estados a partir de la definición
  * pasada.
  */
-declare function getColorsAndStatesByDefinition(definition: Partial<TGetColorStateDefinition>, theme: Theme, options?: TGetColorsAndStatesOptions): ThemeUICSSObject;
+declare function getColorsAndStatesByDefinition(definition: Partial<TGetColorStateDefinition>, palette: TParsedPalette, options?: TGetColorsAndStatesOptions): ThemeUICSSObject;
 
 /**
  * Esta función arma un objeto con los colores que se deben aplicar para
@@ -291,7 +297,7 @@ declare function getColorsByPath(path: string, options?: {
  */
 declare const getOneColorState: TColorStateRetriever;
 
-declare function useMainTheme(customTheme?: CustomTheme, customPalette?: TPalette): Theme;
+declare function useMainTheme(customTheme?: () => CustomTheme, customPalette?: TCustomPalette, themeModifier?: TThemeModifier): Theme;
 
 /**
  * Permite crear un componente cuyos estilos pueden ser redefinidos por un
@@ -346,12 +352,34 @@ declare function injectStyles(path: string, styles: ThemeUICSSObject): void;
  */
 declare function injectStyles(styles: ThemeUICSSObject): void;
 
+declare const spacingLayouts: readonly ["dense", "clever", "vertical__clever", "horizontal__clever"];
+type TSpacingLayout = (typeof spacingLayouts)[number];
+declare function getSpacingLayouts(): {
+    '&.dense': {
+        px: number;
+        py: number;
+    };
+    '&.horizontal__clever': {
+        px: number;
+        py: number;
+    };
+    '&.vertical__clever': {
+        px: number;
+        py: number;
+    };
+    '&.clever': {
+        px: number;
+        py: number;
+    };
+};
+
 interface TThemeProvider {
     children: ReactNode;
-    customTheme?: Omit<Theme, 'palette'>;
-    customPalette?: TPalette;
+    customTheme?: () => Omit<Theme, 'palette'>;
+    customPalette?: TCustomPalette;
+    themeModifier?: TThemeModifier;
 }
-declare const ApiaThemeProvider: ({ children, customTheme, customPalette, }: TThemeProvider) => react.JSX.Element;
+declare const ApiaThemeProvider: ({ children, customTheme, customPalette, themeModifier, }: TThemeProvider) => react.JSX.Element;
 
 declare module 'theme-ui' {
     interface Theme {
@@ -359,4 +387,4 @@ declare module 'theme-ui' {
     }
 }
 
-export { ApiaThemeProvider, CustomTheme, TColorDefinition, TPalette, TParsedPalette, applyStatesGetColor, focusOutline, getColorState, getColorStates, getColorsAndStatesByDefinition, getColorsAndStatesByPath, getColorsByDefinition, getColorsByPath, getOneColorState, getVariant, injectStyles, makeStyledComponent, parsePalette, responsive, smallButton, spacing, useMainTheme };
+export { ApiaThemeProvider, CustomTheme, TColorDefinition, TPalette, TParsedPalette, TSpacingLayout, TThemeModifier, applyStatesGetColor, focusOutline, getColorState, getColorStates, getColorsAndStatesByDefinition, getColorsAndStatesByPath, getColorsByDefinition, getColorsByPath, getOneColorState, getSpacingLayouts, getVariant, injectStyles, makeStyledComponent, parsePalette, responsive, smallButton, spacing, spacingLayouts, useMainTheme };