@cssfn/css-types - npm Package Compare versions

Comparing version 2.0.7 to 2.1.0

dist/css-types.d.ts

@@ -290,4 +290,58 @@ import type { OptionalOrBoolean, SingleOrDeepArray, ProductOrFactoryOrDeepArray, PartialNullish, MapOf } from '@cssfn/types';
 export type CssStyle = CssProps & CssRule;
-export type CssStyleMap = CssPropsMap & CssRuleMap & CssFinalRuleMap;
-export type CssFinalStyleMap = CssPropsMap & CssFinalRuleMap;
+export type CssFinalStyle = CssProps & CssFinalRule;
+export type CssUnionKey = keyof CssCustomProps | keyof CssKnownProps | keyof CssRule;
+export type CssUnionValue = CssCustomProps[keyof CssCustomProps] | CssKnownProps[keyof CssKnownProps] | CssRule[keyof CssRule];
+export type CssUnionFinalValue = CssCustomProps[keyof CssCustomProps] | CssKnownProps[keyof CssKnownProps] | CssFinalRule[keyof CssFinalRule];
+export type CssStyleMapExcludeMembers = symbol | 'entries' | 'keys' | 'values' | 'delete' | 'get' | 'has' | 'set';
+export interface CssStyleMapFilteredKeys extends Omit<Map<keyof CssStyle, CssStyle[keyof CssStyle]>, CssStyleMapExcludeMembers> {
+    get ruleKeys(): Array<keyof CssRule>;
+    get propKeys(): Array<keyof CssCustomProps | keyof CssKnownProps>;
+    get hasRuleKeys(): boolean;
+    get hasPropKeys(): boolean;
+    readonly [Symbol.toStringTag]: string;
+}
+export interface CssStyleMapOverloads extends Omit<Map<keyof CssStyle, CssStyle[keyof CssStyle]>, CssStyleMapExcludeMembers> {
+    get rules(): Array<CssRuleData>;
+    [Symbol.iterator](): IterableIterator<[CssUnionKey, CssUnionValue]>;
+    entries(): IterableIterator<[CssUnionKey, CssUnionValue]>;
+    get keysAsArray(): Array<CssUnionKey>;
+    keys(): IterableIterator<CssUnionKey>;
+    values(): IterableIterator<CssUnionValue>;
+    delete(key: keyof CssCustomProps): boolean;
+    delete(key: keyof CssKnownProps): boolean;
+    delete(key: keyof CssRule): boolean;
+    get(key: keyof CssCustomProps): CssCustomProps[keyof CssCustomProps] | undefined;
+    get(key: keyof CssKnownProps): CssKnownProps[keyof CssKnownProps] | undefined;
+    get(key: keyof CssRule): CssRule[keyof CssRule] | undefined;
+    has(key: keyof CssCustomProps): boolean;
+    has(key: keyof CssKnownProps): boolean;
+    has(key: keyof CssRule): boolean;
+    set(key: keyof CssCustomProps | keyof CssKnownProps, value: CssCustomProps[keyof CssCustomProps] | CssKnownProps[keyof CssKnownProps]): this;
+    set(key: keyof CssCustomProps, value: CssCustomProps[keyof CssCustomProps]): this;
+    set(key: keyof CssKnownProps, value: CssKnownProps[keyof CssKnownProps]): this;
+    set(key: keyof CssRule, value: CssRule[keyof CssRule]): this;
+}
+export interface CssFinalStyleMapOverloads extends Omit<Map<keyof CssFinalStyle, CssFinalStyle[keyof CssFinalStyle]>, CssStyleMapExcludeMembers> {
+    get rules(): Array<CssFinalRuleData>;
+    [Symbol.iterator](): IterableIterator<[CssUnionKey, CssUnionFinalValue]>;
+    entries(): IterableIterator<[CssUnionKey, CssUnionFinalValue]>;
+    get keysAsArray(): Array<CssUnionKey>;
+    keys(): IterableIterator<CssUnionKey>;
+    values(): IterableIterator<CssUnionFinalValue>;
+    delete(key: keyof CssCustomProps): boolean;
+    delete(key: keyof CssKnownProps): boolean;
+    delete(key: keyof CssFinalRule): boolean;
+    get(key: keyof CssCustomProps): CssCustomProps[keyof CssCustomProps] | undefined;
+    get(key: keyof CssKnownProps): CssKnownProps[keyof CssKnownProps] | undefined;
+    get(key: keyof CssFinalRule): CssFinalRule[keyof CssFinalRule] | undefined;
+    has(key: keyof CssCustomProps): boolean;
+    has(key: keyof CssKnownProps): boolean;
+    has(key: keyof CssFinalRule): boolean;
+    set(key: keyof CssCustomProps | keyof CssKnownProps, value: CssCustomProps[keyof CssCustomProps] | CssKnownProps[keyof CssKnownProps]): this;
+    set(key: keyof CssCustomProps, value: CssCustomProps[keyof CssCustomProps]): this;
+    set(key: keyof CssKnownProps, value: CssKnownProps[keyof CssKnownProps]): this;
+    set(key: keyof CssFinalRule, value: CssFinalRule[keyof CssFinalRule]): this;
+}
+export type CssStyleMap = CssStyleMapFilteredKeys & CssStyleMapOverloads & Omit<CssPropsMap & CssRuleMap & CssFinalRuleMap, CssStyleMapExcludeMembers>;
+export type CssFinalStyleMap = CssStyleMapFilteredKeys & CssFinalStyleMapOverloads & Omit<CssPropsMap & CssFinalRuleMap, CssStyleMapExcludeMembers>;
 export type CssStyleCollection = ProductOrFactoryOrDeepArray<OptionalOrBoolean<CssStyle>>;
@@ -294,0 +348,0 @@ export type CssFontFaceStyleCollection = ProductOrFactoryOrDeepArray<OptionalOrBoolean<CssFontFaceProps>>;

package.json

 {
   "name": "@cssfn/css-types",
-  "version": "2.0.7",
+  "version": "2.1.0",
   "description": "CSS typescript definitions.",
@@ -34,3 +34,3 @@ "keywords": [
   },
-  "gitHead": "cb9755c614f545159f304f7db3753478955de44d"
+  "gitHead": "d34ea3aa8794a12f7f7d6f57e5c45cf308abc88b"
 }

src/css-types.ts

@@ -423,5 +423,151 @@ // cssfn:
 
-export type CssStyle                   = CssProps    & CssRule
-export type CssStyleMap                = CssPropsMap & CssRuleMap & CssFinalRuleMap
-export type CssFinalStyleMap           = CssPropsMap & CssFinalRuleMap
+export type CssStyle                   = CssProps & CssRule
+export type CssFinalStyle              = CssProps & CssFinalRule
+
+export type CssUnionKey                =
+    | keyof CssCustomProps
+    | keyof CssKnownProps
+    | keyof CssRule
+
+export type CssUnionValue              =
+    | CssCustomProps[keyof CssCustomProps]
+    | CssKnownProps[keyof CssKnownProps]
+    | CssRule[keyof CssRule]
+
+export type CssUnionFinalValue         =
+    | CssCustomProps[keyof CssCustomProps]
+    | CssKnownProps[keyof CssKnownProps]
+    | CssFinalRule[keyof CssFinalRule]
+
+export type CssStyleMapExcludeMembers  =
+    | symbol
+    |'entries'
+    |'keys'
+    |'values'
+    
+    |'delete'
+    // |'forEach' // conflict with vanilla Map!
+    |'get'
+    |'has'
+    |'set'
+
+export interface CssStyleMapFilteredKeys
+    extends
+        Omit<Map<keyof CssStyle, CssStyle[keyof CssStyle]>, CssStyleMapExcludeMembers>
+{
+    // filtered iterators:
+    get ruleKeys()      : Array<keyof CssRule>
+    get propKeys()      : Array<keyof CssCustomProps|keyof CssKnownProps>
+    get hasRuleKeys()   : boolean
+    get hasPropKeys()   : boolean
+    
+    
+    
+    // miscs:
+    readonly [Symbol.toStringTag]: string
+}
+export interface CssStyleMapOverloads
+    extends
+        Omit<Map<keyof CssStyle, CssStyle[keyof CssStyle]>, CssStyleMapExcludeMembers>
+{
+    // filtered iterators:
+    get rules() : Array<CssRuleData>
+    
+    
+    
+    // iterators:
+    [Symbol.iterator]() : IterableIterator<[CssUnionKey, CssUnionValue]>
+    entries()           : IterableIterator<[CssUnionKey, CssUnionValue]>
+    get keysAsArray()   : Array<CssUnionKey>
+    keys()              : IterableIterator<CssUnionKey>
+    values()            : IterableIterator<CssUnionValue>
+    
+    
+    
+    // deletes:
+    delete(key: keyof CssCustomProps): boolean
+    delete(key: keyof CssKnownProps ): boolean
+    delete(key: keyof CssRule       ): boolean
+    
+    
+    
+    // forEach:
+    // conflict with vanilla Map!
+    // forEach(callbackfn: ((value: CssUnionValue, key: CssUnionKey, map: CssStyleMap) => void), thisArg?: any): void
+    
+    
+    
+    // gets:
+    get(key: keyof CssCustomProps): CssCustomProps[keyof CssCustomProps] | undefined
+    get(key: keyof CssKnownProps ): CssKnownProps[keyof CssKnownProps]   | undefined
+    get(key: keyof CssRule       ): CssRule[keyof CssRule]               | undefined
+    
+    
+    
+    // hases:
+    has(key: keyof CssCustomProps): boolean
+    has(key: keyof CssKnownProps ): boolean
+    has(key: keyof CssRule       ): boolean
+    
+    
+    
+    // sets:
+    set(key: keyof CssCustomProps | keyof CssKnownProps, value: CssCustomProps[keyof CssCustomProps] | CssKnownProps[keyof CssKnownProps]): this
+    set(key: keyof CssCustomProps, value: CssCustomProps[keyof CssCustomProps]): this
+    set(key: keyof CssKnownProps , value: CssKnownProps[keyof CssKnownProps]  ): this
+    set(key: keyof CssRule       , value: CssRule[keyof CssRule]              ): this
+}
+export interface CssFinalStyleMapOverloads
+    extends
+        Omit<Map<keyof CssFinalStyle, CssFinalStyle[keyof CssFinalStyle]>, CssStyleMapExcludeMembers>
+{
+    // filtered iterators:
+    get rules() : Array<CssFinalRuleData>
+    
+    
+    
+    // iterators:
+    [Symbol.iterator]() : IterableIterator<[CssUnionKey, CssUnionFinalValue]>
+    entries()           : IterableIterator<[CssUnionKey, CssUnionFinalValue]>
+    get keysAsArray()   : Array<CssUnionKey>
+    keys()              : IterableIterator<CssUnionKey>
+    values()            : IterableIterator<CssUnionFinalValue>
+    
+    
+    
+    // deletes:
+    delete(key: keyof CssCustomProps): boolean
+    delete(key: keyof CssKnownProps ): boolean
+    delete(key: keyof CssFinalRule  ): boolean
+    
+    
+    
+    // forEach:
+    // conflict with vanilla Map!
+    // forEach(callbackfn: ((value: CssUnionFinalValue, key: CssUnionKey, map: CssStyleMap) => void), thisArg?: any): void
+    
+    
+    
+    // gets:
+    get(key: keyof CssCustomProps): CssCustomProps[keyof CssCustomProps] | undefined
+    get(key: keyof CssKnownProps ): CssKnownProps[keyof CssKnownProps]   | undefined
+    get(key: keyof CssFinalRule  ): CssFinalRule[keyof CssFinalRule]     | undefined
+    
+    
+    
+    // hases:
+    has(key: keyof CssCustomProps): boolean
+    has(key: keyof CssKnownProps ): boolean
+    has(key: keyof CssFinalRule  ): boolean
+    
+    
+    
+    // sets:
+    set(key: keyof CssCustomProps | keyof CssKnownProps, value: CssCustomProps[keyof CssCustomProps] | CssKnownProps[keyof CssKnownProps]): this
+    set(key: keyof CssCustomProps, value: CssCustomProps[keyof CssCustomProps]): this
+    set(key: keyof CssKnownProps , value: CssKnownProps[keyof CssKnownProps]  ): this
+    set(key: keyof CssFinalRule  , value: CssFinalRule[keyof CssFinalRule]    ): this
+}
+export type CssStyleMap                = CssStyleMapFilteredKeys & CssStyleMapOverloads      & Omit<CssPropsMap & CssRuleMap & CssFinalRuleMap, CssStyleMapExcludeMembers>
+export type CssFinalStyleMap           = CssStyleMapFilteredKeys & CssFinalStyleMapOverloads & Omit<CssPropsMap              & CssFinalRuleMap, CssStyleMapExcludeMembers>
 export type CssStyleCollection         = ProductOrFactoryOrDeepArray<OptionalOrBoolean<CssStyle>>
@@ -428,0 +574,0 @@ export type CssFontFaceStyleCollection = ProductOrFactoryOrDeepArray<OptionalOrBoolean<CssFontFaceProps>>

No alert changes

Improved metrics

Total package byte prevSize

44822

increased by24.63%

Lines of code

906

increased by20.64%

No dependency changes