@swisspost/design-system-components 1.3.7 → 1.3.8

package/dist/docs.d.ts

@@ -3,48 +3,170 @@
  * This is an autogenerated file created by the Stencil compiler.
  * DO NOT MODIFY IT MANUALLY
  */
+import { ComponentCompilerEventComplexType, ComponentCompilerMethodComplexType, ComponentCompilerPropertyComplexType, ComponentCompilerReferencedType } from './stencil-private';
+/**
+ * The Type Library holds information about the types which are used in a
+ * Stencil project. During compilation, Stencil gathers information about the
+ * types which form part of a component's public API, such as properties
+ * decorated with `@Prop`, `@Event`, `@Watch`, etc. This type information is
+ * then added to the Type Library, where it can be accessed later on for
+ * generating documentation.
+ *
+ * This information is included in the file written by the `docs-json` output
+ * target (see {@link JsonDocs.typeLibrary}).
+ */
+export type JsonDocsTypeLibrary = Record<string, ComponentCompilerReferencedType>;
+/**
+ * A container for JSDoc metadata for a project
+ */
 export interface JsonDocs {
+    /**
+     * The metadata for the JSDocs for each component in a Stencil project
+     */
     components: JsonDocsComponent[];
+    /**
+     * The timestamp at which the metadata was generated, in the format YYYY-MM-DDThh:mm:ss
+     */
     timestamp: string;
     compiler: {
+        /**
+         * The name of the compiler that generated the metadata
+         */
         name: string;
+        /**
+         * The version of the Stencil compiler that generated the metadata
+         */
         version: string;
+        /**
+         * The version of TypeScript that was used to generate the metadata
+         */
         typescriptVersion: string;
     };
+    typeLibrary: JsonDocsTypeLibrary;
 }
+/**
+ * Container for JSDoc metadata for a single Stencil component
+ */
 export interface JsonDocsComponent {
+    /**
+     * The directory containing the Stencil component, minus the file name.
+     *
+     * @example /workspaces/stencil-project/src/components/my-component
+     */
     dirPath?: string;
+    /**
+     * The name of the file containing the Stencil component, with no path
+     *
+     * @example my-component.tsx
+     */
     fileName?: string;
+    /**
+     * The full path of the file containing the Stencil component
+     *
+     * @example /workspaces/stencil-project/src/components/my-component/my-component.tsx
+     */
     filePath?: string;
+    /**
+     * The path to the component's `readme.md` file, including the filename
+     *
+     * @example /workspaces/stencil-project/src/components/my-component/readme.md
+     */
     readmePath?: string;
+    /**
+     * The path to the component's `usage` directory
+     *
+     * @example /workspaces/stencil-project/src/components/my-component/usage/
+     */
     usagesDir?: string;
+    /**
+     * The encapsulation strategy for a component
+     */
     encapsulation: 'shadow' | 'scoped' | 'none';
+    /**
+     * The tag name for the component, for use in HTML
+     */
     tag: string;
+    /**
+     * The contents of a component's `readme.md` that are user generated.
+     *
+     * Auto-generated contents are not stored in this reference.
+     */
     readme: string;
+    /**
+     * The description of a Stencil component, found in the JSDoc that sits above the component's declaration
+     */
     docs: string;
+    /**
+     * JSDoc tags found in the JSDoc comment written atop a component's declaration
+     */
     docsTags: JsonDocsTag[];
     /**
      * The text from the class-level JSDoc for a Stencil component, if present.
      */
     overview?: string;
+    /**
+     * A mapping of usage example file names to their contents for the component.
+     */
     usage: JsonDocsUsage;
+    /**
+     * Array of metadata for a component's `@Prop`s
+     */
     props: JsonDocsProp[];
+    /**
+     * Array of metadata for a component's `@Method`s
+     */
     methods: JsonDocsMethod[];
+    /**
+     * Array of metadata for a component's `@Event`s
+     */
     events: JsonDocsEvent[];
+    /**
+     * Array of metadata for a component's `@Listen` handlers
+     */
     listeners: JsonDocsListener[];
+    /**
+     * Array of metadata for a component's CSS styling information
+     */
     styles: JsonDocsStyle[];
+    /**
+     * Array of component Slot information, generated from `@slot` tags
+     */
     slots: JsonDocsSlot[];
+    /**
+     * Array of component Parts information, generate from `@part` tags
+     */
     parts: JsonDocsPart[];
+    /**
+     * Array of metadata describing where the current component is used
+     */
     dependents: string[];
+    /**
+     * Array of metadata listing the components which are used in current component
+     */
     dependencies: string[];
+    /**
+     * Describes a tree of components coupling
+     */
     dependencyGraph: JsonDocsDependencyGraph;
+    /**
+     * A deprecation reason/description found following a `@deprecated` tag
+     */
     deprecation?: string;
 }
 export interface JsonDocsDependencyGraph {
     [tagName: string]: string[];
 }
+/**
+ * A descriptor for a single JSDoc tag found in a block comment
+ */
 export interface JsonDocsTag {
+    /**
+     * The tag name (immediately following the '@')
+     */
     name: string;
+    /**
+     * The description that immediately follows the tag name
+     */
     text?: string;
 }
 export interface JsonDocsValue {
@@ -74,21 +196,65 @@ export interface JsonDocsValue {
 export interface JsonDocsUsage {
     [key: string]: string;
 }
+/**
+ * An intermediate representation of a `@Prop` decorated member's JSDoc
+ */
 export interface JsonDocsProp {
+    /**
+     * the name of the prop
+     */
     name: string;
+    complexType?: ComponentCompilerPropertyComplexType;
+    /**
+     * the type of the prop, in terms of the TypeScript type system (as opposed to JavaScript's or HTML's)
+     */
     type: string;
+    /**
+     * `true` if the prop was configured as "mutable" where it was declared, `false` otherwise
+     */
     mutable: boolean;
     /**
      * The name of the attribute that is exposed to configure a compiled web component
      */
     attr?: string;
+    /**
+     * `true` if the prop was configured to "reflect" back to HTML where it (the prop) was declared, `false` otherwise
+     */
     reflectToAttr: boolean;
+    /**
+     * the JSDoc description text associated with the prop
+     */
     docs: string;
+    /**
+     * JSDoc tags associated with the prop
+     */
     docsTags: JsonDocsTag[];
-    default: string;
+    /**
+     * The default value of the prop
+     */
+    default?: string;
+    /**
+     * Deprecation text associated with the prop. This is the text that immediately follows a `@deprecated` tag
+     */
     deprecation?: string;
     values: JsonDocsValue[];
+    /**
+     * `true` if a component is declared with a '?', `false` otherwise
+     *
+     * @example
+     * ```tsx
+     * @Prop() componentProps?: any;
+     * ```
+     */
     optional: boolean;
+    /**
+     * `true` if a component is declared with a '!', `false` otherwise
+     *
+     * @example
+     * ```tsx
+     * @Prop() componentProps!: any;
+     * ```
+     */
     required: boolean;
 }
 export interface JsonDocsMethod {
@@ -99,6 +265,7 @@ export interface JsonDocsMethod {
     signature: string;
     returns: JsonDocsMethodReturn;
     parameters: JsonDocMethodParameter[];
+    complexType: ComponentCompilerMethodComplexType;
 }
 export interface JsonDocsMethodReturn {
     type: string;
@@ -114,6 +281,7 @@ export interface JsonDocsEvent {
     bubbles: boolean;
     cancelable: boolean;
     composed: boolean;
+    complexType: ComponentCompilerEventComplexType;
     docs: string;
     docsTags: JsonDocsTag[];
     deprecation?: string;
@@ -130,12 +298,35 @@ export interface JsonDocsListener {
     capture: boolean;
     passive: boolean;
 }
+/**
+ * A descriptor for a slot
+ *
+ * Objects of this type are translated from the JSDoc tag, `@slot`
+ */
 export interface JsonDocsSlot {
+    /**
+     * The name of the slot. Defaults to an empty string for an unnamed slot.
+     */
     name: string;
+    /**
+     * A textual description of the slot.
+     */
     docs: string;
 }
+/**
+ * A descriptor of a CSS Shadow Part
+ *
+ * Objects of this type are translated from the JSDoc tag, `@part`, or the 'part'
+ * attribute on a component in TSX
+ */
 export interface JsonDocsPart {
+    /**
+     * The name of the Shadow part
+     */
     name: string;
+    /**
+     * A textual description of the Shadow part.
+     */
     docs: string;
 }
 export interface StyleDoc {

package/dist/docs.json

@@ -1,13 +1,13 @@
 {
-  "timestamp": "2023-07-03T08:30:13",
+  "timestamp": "2023-07-17T08:58:45",
   "compiler": {
     "name": "@stencil/core",
-    "version": "3.4.0",
+    "version": "4.0.1",
     "typescriptVersion": "5.0.4"
   },
   "components": [
     {
-      "filePath": "./src/components/post-collapsible/post-collapsible.tsx",
+      "filePath": "src/components/post-collapsible/post-collapsible.tsx",
       "encapsulation": "shadow",
       "tag": "post-collapsible",
       "readme": "# post-collapsible\n\n\n",
@@ -18,6 +18,11 @@
         {
           "name": "collapsed",
           "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
           "mutable": false,
           "attr": "collapsed",
           "reflectToAttr": false,
@@ -35,6 +40,11 @@
         {
           "name": "headingLevel",
           "type": "number",
+          "complexType": {
+            "original": "number",
+            "resolved": "number",
+            "references": {}
+          },
           "mutable": false,
           "attr": "heading-level",
           "reflectToAttr": false,
@@ -57,6 +67,22 @@
             "type": "Promise<boolean>",
             "docs": ""
           },
+          "complexType": {
+            "signature": "(open?: boolean) => Promise<boolean>",
+            "parameters": [
+              {
+                "tags": [],
+                "text": ""
+              }
+            ],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<boolean>"
+          },
           "signature": "toggle(open?: boolean) => Promise<boolean>",
           "parameters": [],
           "docs": "Triggers the collapse programmatically.",
@@ -73,7 +99,7 @@
       "dependencyGraph": {}
     },
     {
-      "filePath": "./src/components/post-icon/post-icon.tsx",
+      "filePath": "src/components/post-icon/post-icon.tsx",
       "encapsulation": "shadow",
       "tag": "post-icon",
       "readme": "# post-icon\n\nsome content\n",
@@ -89,6 +115,16 @@
         {
           "name": "animation",
           "type": "\"cylon\" | \"cylon-vertical\" | \"fade\" | \"spin\" | \"spin-reverse\" | \"throb\"",
+          "complexType": {
+            "original": "Animation | null",
+            "resolved": "\"cylon\" | \"cylon-vertical\" | \"fade\" | \"spin\" | \"spin-reverse\" | \"throb\"",
+            "references": {
+              "Animation": {
+                "location": "global",
+                "id": "global::Animation"
+              }
+            }
+          },
           "mutable": false,
           "attr": "animation",
           "reflectToAttr": false,
@@ -127,6 +163,11 @@
         {
           "name": "base",
           "type": "string",
+          "complexType": {
+            "original": "string | null",
+            "resolved": "string",
+            "references": {}
+          },
           "mutable": false,
           "attr": "base",
           "reflectToAttr": false,
@@ -144,6 +185,11 @@
         {
           "name": "flipH",
           "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
           "mutable": false,
           "attr": "flip-h",
           "reflectToAttr": false,
@@ -161,6 +207,11 @@
         {
           "name": "flipV",
           "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
           "mutable": false,
           "attr": "flip-v",
           "reflectToAttr": false,
@@ -178,6 +229,11 @@
         {
           "name": "name",
           "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
           "mutable": false,
           "attr": "name",
           "reflectToAttr": false,
@@ -194,6 +250,11 @@
         {
           "name": "rotate",
           "type": "number",
+          "complexType": {
+            "original": "number | null",
+            "resolved": "number",
+            "references": {}
+          },
           "mutable": false,
           "attr": "rotate",
           "reflectToAttr": false,
@@ -211,6 +272,11 @@
         {
           "name": "scale",
           "type": "number",
+          "complexType": {
+            "original": "number | null",
+            "resolved": "number",
+            "references": {}
+          },
           "mutable": false,
           "attr": "scale",
           "reflectToAttr": false,
@@ -236,5 +302,6 @@
       "dependencies": [],
       "dependencyGraph": {}
     }
-  ]
+  ],
+  "typeLibrary": {}
 }

package/dist/esm/{index-cfac2b9c.js → index-fc5f363d.js}

@@ -286,9 +286,9 @@ const registerStyle = (scopeId, cssText, allowCS) => {
     }
     styles.set(scopeId, style);
 };
-const addStyle = (styleContainerNode, cmpMeta, mode, hostElm) => {
+const addStyle = (styleContainerNode, cmpMeta, mode) => {
     var _a;
-    let scopeId = getScopeId(cmpMeta);
+    const scopeId = getScopeId(cmpMeta);
     const style = styles.get(scopeId);
     // if an element is NOT connected then getRootNode() will return the wrong root node
     // so the fallback is to always use the document for the root node in those cases
@@ -303,11 +303,8 @@ const addStyle = (styleContainerNode, cmpMeta, mode, hostElm) => {
             }
             if (!appliedStyles.has(scopeId)) {
                 {
-                    // TODO(STENCIL-659): Remove code implementing the CSS variable shim
-                    {
-                        styleElm = doc.createElement('style');
-                        styleElm.innerHTML = style;
-                    }
+                    styleElm = doc.createElement('style');
+                    styleElm.innerHTML = style;
                     // Apply CSP nonce to the style tag if it exists
                     const nonce = (_a = plt.$nonce$) !== null && _a !== void 0 ? _a : queryNonceMetaTagContent(doc);
                     if (nonce != null) {
@@ -332,7 +329,6 @@ const attachStyles = (hostRef) => {
     const flags = cmpMeta.$flags$;
     const endAttachStyles = createTime('attachStyles', cmpMeta.$tagName$);
     const scopeId = addStyle(elm.shadowRoot ? elm.shadowRoot : elm.getRootNode(), cmpMeta);
-    // TODO(STENCIL-662): Remove code related to deprecated shadowDomShim field
     if (flags & 10 /* CMP_FLAGS.needsScopedEncapsulation */) {
         // only required when we're NOT using native shadow dom (slot)
         // or this browser doesn't support native shadow dom
@@ -1587,4 +1583,4 @@ const writeTask = /*@__PURE__*/ queueTask(queueDomWrites, true);
 
 export { Host as H, bootstrapLazy as b, getElement as g, h, promiseResolve as p, registerInstance as r, setNonce as s };
 
-//# sourceMappingURL=index-cfac2b9c.js.map
+//# sourceMappingURL=index-fc5f363d.js.map