@mgdis/stencil-helpers 1.1.8 → 2.0.0

package/README.md

@@ -5,7 +5,7 @@ This package centralizes helper functions for your [Stencil](https://stenciljs.c
 - **Components**: Centralizes all component utilities.
 - **Locale**: Centralizes all necessary locale utilities for managing content translation.
 - **Storybook**: Centralizes all Storybook helpers useful for building your own Storybook.
-- **Test**: Centralizes all test utilities to simplify testing your components.
+- **Tests**: Centralizes all test utilities to simplify testing your components.
 
 ## Installation
 
@@ -15,4 +15,4 @@ pnpm i @mgdis/stencil-helpers
 
 ## Documentation
 
-Read the full [documentation](./doc/README.md)
+Read the full [documentation](./docs/README.md)

package/dist/components/index.d.ts

@@ -75,7 +75,13 @@ export declare const getParentWindows: (localWindow: Window, windows?: Window[])
  * @param value - value to check
  * @returns `true` if string is valid
  */
-export declare const isValidString: (value: unknown) => boolean;
+export declare const isValidString: (value: unknown) => value is string;
+/**
+ * Value to stringify
+ * @param value
+ * @returns stringified value
+ */
+export declare const toString: (value: unknown) => string;
 /**
  * Cleans string characters by removing special characters and converting to lowercase.
  * @param text - text to clean

package/dist/components/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,wCAA+B,MAWnD,CAAC;AAEF;;GAEG;AACH,qBAAa,SAAS;IACpB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;gBAEN,SAAS,GAAE,MAAM,EAAO;IAIpC;;;OAGG;IACH,GAAG,cAAe,MAAM,KAAG,IAAI,CAI7B;IAEF;;;OAGG;IACH,MAAM,cAAe,MAAM,KAAG,IAAI,CAKhC;IAEF;;;;OAIG;IACH,GAAG,cAAe,MAAM,KAAG,OAAO,CAEhC;IAEF;;;OAGG;IACH,IAAI,QAAO,MAAM,CAEf;CACH;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,UAAW,OAAO,KAAG,KAAK,IAAI,MAAM,EAA2E,CAAC;AAE9I;;;;;GAKG;AACH,eAAO,MAAM,SAAS,YAAa,OAAO,YAAY,MAAM,EAAE,KAAG,OAEhE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,kHAAgH,CAAC;AAE/I;;;;GAIG;AACH,eAAO,MAAM,UAAU,gBAAiB,MAAM,KAAG,MAAM,EAItD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,gBAAiB,MAAM,YAAW,MAAM,EAAE,KAAQ,MAAM,EAgBpF,CAAC;AAkBF;;;;GAIG;AACH,eAAO,MAAM,aAAa,UAAW,OAAO,KAAG,OAA2D,CAAC;AAE3G;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,SAAU,MAAM,KAAG,MAMjC,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,QAAQ,aAAoB,MAAM,IAAI,KAAG,OAAO,CAAC,IAAI,CAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,wCAA+B,MAWnD,CAAC;AAEF;;GAEG;AACH,qBAAa,SAAS;IACpB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;gBAEN,SAAS,GAAE,MAAM,EAAO;IAIpC;;;OAGG;IACH,GAAG,cAAe,MAAM,KAAG,IAAI,CAI7B;IAEF;;;OAGG;IACH,MAAM,cAAe,MAAM,KAAG,IAAI,CAKhC;IAEF;;;;OAIG;IACH,GAAG,cAAe,MAAM,KAAG,OAAO,CAEhC;IAEF;;;OAGG;IACH,IAAI,QAAO,MAAM,CAEf;CACH;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,UAAW,OAAO,sBAA6F,CAAC;AAE9I;;;;;GAKG;AACH,eAAO,MAAM,SAAS,YAAa,OAAO,YAAY,MAAM,EAAE,KAAG,OAEhE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,kHAAgH,CAAC;AAE/I;;;;GAIG;AACH,eAAO,MAAM,UAAU,gBAAiB,MAAM,KAAG,MAAM,EAItD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,gBAAiB,MAAM,YAAW,MAAM,EAAE,KAAQ,MAAM,EAgBpF,CAAC;AAkBF;;;;GAIG;AACH,eAAO,MAAM,aAAa,UAAW,OAAO,oBAAsE,CAAC;AAEnH;;;;GAIG;AACH,eAAO,MAAM,QAAQ,UAAW,OAAO,KAAG,MAGzC,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,SAAU,MAAM,KAAG,MAMjC,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,QAAQ,aAAoB,MAAM,IAAI,KAAG,QAAQ,IAAI,CAAe,CAAC"}

package/dist/ide/index.d.ts

@@ -49,23 +49,28 @@ export declare const webTypesGenerator: (name: string, version: string, jsonDocs
                         description: string;
                     }[];
                 };
+                css: {
+                    properties: {
+                        name: string;
+                        description: string;
+                    }[];
+                };
             }[];
         };
     };
 };
 /**
  * Generate custom HTML datasets for VS Code
- * @param version - Library version
  * @param jsonDocs - Stencil JSON doc
  * @param storybookBaseUrl - Storybook Base Url
  * @returns custom HTML datasets
  * @example
  * ```ts
- * const customDataJson = vsCodeGenerator('1.0.0', jsonDocs, 'https://storybook.example.com', 'https://sources.example.com');
+ * const customDataJson = vsCodeGenerator(jsonDocs, 'https://storybook.example.com', 'https://sources.example.com');
  * ```
  */
-export declare const vsCodeGenerator: (version: string, jsonDocs: JsonDocs, storybookBaseUrl: string, sourceBaseUrl: string) => {
-    version: string;
+export declare const vsCodeGenerator: (jsonDocs: JsonDocs, storybookBaseUrl: string, sourceBaseUrl: string) => {
+    version: number;
     tags: {
         name: string;
         description: string;
@@ -86,4 +91,20 @@ export declare const vsCodeGenerator: (version: string, jsonDocs: JsonDocs, stor
     globalAttributes: never[];
     valueSets: never[];
 };
+/**
+ * Generate custom CSS datasets for VS Code
+ * @param jsonDocs - Stencil JSON doc
+ * @returns custom CSS datasets
+ * @example
+ * ```ts
+ * const customDataJson = vsCodeCssGenerator(jsonDocs);
+ * ```
+ */
+export declare const vsCodeCssGenerator: (jsonDocs: JsonDocs) => {
+    version: number;
+    properties: {
+        name: string;
+        description: string;
+    }[];
+};
 //# sourceMappingURL=index.d.ts.map

package/dist/ide/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ide/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAmC,MAAM,wBAAwB,CAAC;AA2EnF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,iBAAiB,SAAU,MAAM,WAAW,MAAM,YAAY,QAAQ,oBAAoB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6C3G,CAAC;AA4BH;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,YAAa,MAAM,YAAY,QAAQ,oBAAoB,MAAM,iBAAiB,MAAM;;;;;;;;;;;;;;;;;;;;;CAkBlH,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ide/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAmC,MAAM,wBAAwB,CAAC;AA2EnF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,iBAAiB,SAAU,MAAM,WAAW,MAAM,YAAY,QAAQ,oBAAoB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmD3G,CAAC;AA4BH;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,aAAc,QAAQ,oBAAoB,MAAM,iBAAiB,MAAM;;;;;;;;;;;;;;;;;;;;;CAkBjG,CAAC;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,aAAc,QAAQ;;;;;;CAQnD,CAAC"}

package/dist/index.d.ts

@@ -2,5 +2,6 @@ export * from './components';
 export * from './ide';
 export * from './locale';
 export * from './storybook';
-export * from './test';
+export * from './tests';
+export * from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}