@skyux/indicators 6.17.1 → 6.18.0

package/documentation.json

@@ -32,7 +32,9 @@
     "SkyIconVariantType": "type-alias-skyiconvarianttype",
     "SkyIndicatorDescriptionType": "type-alias-skyindicatordescriptiontype",
     "SkyIndicatorIconType": "type-alias-skyindicatoricontype",
-    "SkyLabelType": "type-alias-skylabeltype"
+    "SkyLabelType": "type-alias-skylabeltype",
+    "SkyAlertHarness": "class-skyalertharness",
+    "SkyAlertHarnessFilters": "interface-skyalertharnessfilters"
   },
   "typedoc": {
     "id": 0,
@@ -6123,6 +6125,515 @@
             }
           ]
         }
+      },
+      {
+        "id": 565,
+        "name": "SkyAlertHarness",
+        "kind": 128,
+        "kindString": "Class",
+        "flags": {},
+        "comment": {
+          "shortText": "Harness for interacting with an alert component in tests."
+        },
+        "children": [
+          {
+            "id": 566,
+            "name": "hostSelector",
+            "kind": 1024,
+            "kindString": "Property",
+            "flags": {
+              "isPublic": true,
+              "isStatic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/indicators/src/testing/alert/alert-harness.ts",
+                "line": 11,
+                "character": 16
+              }
+            ],
+            "type": {
+              "type": "intrinsic",
+              "name": "string"
+            },
+            "defaultValue": "'sky-alert'"
+          },
+          {
+            "id": 585,
+            "name": "close",
+            "kind": 2048,
+            "kindString": "Method",
+            "flags": {
+              "isPublic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/indicators/src/testing/alert/alert-harness.ts",
+                "line": 62,
+                "character": 15
+              }
+            ],
+            "signatures": [
+              {
+                "id": 586,
+                "name": "close",
+                "kind": 4096,
+                "kindString": "Call signature",
+                "flags": {},
+                "comment": {
+                  "shortText": "Closes the alert."
+                },
+                "type": {
+                  "type": "reference",
+                  "typeArguments": [
+                    {
+                      "type": "intrinsic",
+                      "name": "void"
+                    }
+                  ],
+                  "qualifiedName": "Promise",
+                  "package": "typescript",
+                  "name": "Promise"
+                }
+              }
+            ]
+          },
+          {
+            "id": 581,
+            "name": "getAlertType",
+            "kind": 2048,
+            "kindString": "Method",
+            "flags": {
+              "isPublic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/indicators/src/testing/alert/alert-harness.ts",
+                "line": 30,
+                "character": 15
+              }
+            ],
+            "signatures": [
+              {
+                "id": 582,
+                "name": "getAlertType",
+                "kind": 4096,
+                "kindString": "Call signature",
+                "flags": {},
+                "comment": {
+                  "shortText": "Gets the current alert type."
+                },
+                "type": {
+                  "type": "reference",
+                  "typeArguments": [
+                    {
+                      "type": "reference",
+                      "id": 360,
+                      "name": "SkyIndicatorIconType"
+                    }
+                  ],
+                  "qualifiedName": "Promise",
+                  "package": "typescript",
+                  "name": "Promise"
+                }
+              }
+            ]
+          },
+          {
+            "id": 583,
+            "name": "getText",
+            "kind": 2048,
+            "kindString": "Method",
+            "flags": {
+              "isPublic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/indicators/src/testing/alert/alert-harness.ts",
+                "line": 55,
+                "character": 15
+              }
+            ],
+            "signatures": [
+              {
+                "id": 584,
+                "name": "getText",
+                "kind": 4096,
+                "kindString": "Call signature",
+                "flags": {},
+                "comment": {
+                  "shortText": "Gets the current alert text."
+                },
+                "type": {
+                  "type": "reference",
+                  "typeArguments": [
+                    {
+                      "type": "intrinsic",
+                      "name": "string"
+                    }
+                  ],
+                  "qualifiedName": "Promise",
+                  "package": "typescript",
+                  "name": "Promise"
+                }
+              }
+            ]
+          },
+          {
+            "id": 594,
+            "name": "host",
+            "kind": 2048,
+            "kindString": "Method",
+            "flags": {},
+            "sources": [
+              {
+                "fileName": "node_modules/@angular/cdk/testing/component-harness.d.ts",
+                "line": 221,
+                "character": 4
+              }
+            ],
+            "signatures": [
+              {
+                "id": 595,
+                "name": "host",
+                "kind": 4096,
+                "kindString": "Call signature",
+                "flags": {},
+                "comment": {
+                  "shortText": "Gets a `Promise` for the `TestElement` representing the host element of the component."
+                },
+                "type": {
+                  "type": "reference",
+                  "typeArguments": [
+                    {
+                      "type": "reference",
+                      "qualifiedName": "TestElement",
+                      "package": "@angular/cdk",
+                      "name": "TestElement"
+                    }
+                  ],
+                  "qualifiedName": "Promise",
+                  "package": "typescript",
+                  "name": "Promise"
+                },
+                "inheritedFrom": {
+                  "type": "reference",
+                  "name": "SkyComponentHarness.host"
+                }
+              }
+            ],
+            "inheritedFrom": {
+              "type": "reference",
+              "name": "SkyComponentHarness.host"
+            }
+          },
+          {
+            "id": 589,
+            "name": "isCloseable",
+            "kind": 2048,
+            "kindString": "Method",
+            "flags": {
+              "isPublic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/indicators/src/testing/alert/alert-harness.ts",
+                "line": 82,
+                "character": 15
+              }
+            ],
+            "signatures": [
+              {
+                "id": 590,
+                "name": "isCloseable",
+                "kind": 4096,
+                "kindString": "Call signature",
+                "flags": {},
+                "comment": {
+                  "shortText": "Indicates whether the user can close the alert."
+                },
+                "type": {
+                  "type": "reference",
+                  "typeArguments": [
+                    {
+                      "type": "intrinsic",
+                      "name": "boolean"
+                    }
+                  ],
+                  "qualifiedName": "Promise",
+                  "package": "typescript",
+                  "name": "Promise"
+                }
+              }
+            ]
+          },
+          {
+            "id": 587,
+            "name": "isClosed",
+            "kind": 2048,
+            "kindString": "Method",
+            "flags": {
+              "isPublic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/indicators/src/testing/alert/alert-harness.ts",
+                "line": 73,
+                "character": 15
+              }
+            ],
+            "signatures": [
+              {
+                "id": 588,
+                "name": "isClosed",
+                "kind": 4096,
+                "kindString": "Call signature",
+                "flags": {},
+                "comment": {
+                  "shortText": "Indicates whether the user has closed the alert."
+                },
+                "type": {
+                  "type": "reference",
+                  "typeArguments": [
+                    {
+                      "type": "intrinsic",
+                      "name": "boolean"
+                    }
+                  ],
+                  "qualifiedName": "Promise",
+                  "package": "typescript",
+                  "name": "Promise"
+                }
+              }
+            ]
+          },
+          {
+            "id": 567,
+            "name": "with",
+            "kind": 2048,
+            "kindString": "Method",
+            "flags": {
+              "isPublic": true,
+              "isStatic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/indicators/src/testing/alert/alert-harness.ts",
+                "line": 21,
+                "character": 16
+              }
+            ],
+            "signatures": [
+              {
+                "id": 568,
+                "name": "with",
+                "kind": 4096,
+                "kindString": "Call signature",
+                "flags": {},
+                "comment": {
+                  "shortText": "Gets a `HarnessPredicate` that can be used to search for a\n`SkyAlertHarness` that meets certain criteria."
+                },
+                "parameters": [
+                  {
+                    "id": 569,
+                    "name": "filters",
+                    "kind": 32768,
+                    "kindString": "Parameter",
+                    "flags": {},
+                    "type": {
+                      "type": "reference",
+                      "id": 614,
+                      "name": "SkyAlertHarnessFilters"
+                    }
+                  }
+                ],
+                "type": {
+                  "type": "reference",
+                  "typeArguments": [
+                    {
+                      "type": "reference",
+                      "id": 565,
+                      "name": "SkyAlertHarness"
+                    }
+                  ],
+                  "qualifiedName": "HarnessPredicate",
+                  "package": "@angular/cdk",
+                  "name": "HarnessPredicate"
+                }
+              }
+            ]
+          }
+        ],
+        "groups": [
+          {
+            "title": "Constructors",
+            "kind": 512,
+            "children": [
+              575
+            ]
+          },
+          {
+            "title": "Properties",
+            "kind": 1024,
+            "children": [
+              566
+            ]
+          },
+          {
+            "title": "Methods",
+            "kind": 2048,
+            "children": [
+              585,
+              581,
+              583,
+              594,
+              589,
+              587,
+              567
+            ]
+          }
+        ],
+        "sources": [
+          {
+            "fileName": "projects/indicators/src/testing/alert/alert-harness.ts",
+            "line": 10,
+            "character": 13
+          }
+        ],
+        "extendedTypes": [
+          {
+            "type": "reference",
+            "name": "SkyComponentHarness"
+          }
+        ]
+      },
+      {
+        "id": 614,
+        "name": "SkyAlertHarnessFilters",
+        "kind": 256,
+        "kindString": "Interface",
+        "flags": {},
+        "comment": {
+          "shortText": "A set of criteria that can be used to filter a list of SkyAlertHarness instances."
+        },
+        "children": [
+          {
+            "id": 617,
+            "name": "ancestor",
+            "kind": 1024,
+            "kindString": "Property",
+            "flags": {
+              "isOptional": true
+            },
+            "comment": {
+              "shortText": "Only find instances that are nested under an element with the given selector."
+            },
+            "sources": [
+              {
+                "fileName": "node_modules/@angular/cdk/testing/component-harness.d.ts",
+                "line": 351,
+                "character": 4
+              }
+            ],
+            "type": {
+              "type": "intrinsic",
+              "name": "string"
+            },
+            "inheritedFrom": {
+              "type": "reference",
+              "name": "SkyHarnessFilters.ancestor"
+            }
+          },
+          {
+            "id": 615,
+            "name": "dataSkyId",
+            "kind": 1024,
+            "kindString": "Property",
+            "flags": {
+              "isOptional": true
+            },
+            "comment": {
+              "shortText": "Only find instances whose `data-sky-id` attribute matches the given value."
+            },
+            "sources": [
+              {
+                "fileName": "libs/components/core/testing/src/shared/harness-filters.ts",
+                "line": 11,
+                "character": 2
+              }
+            ],
+            "type": {
+              "type": "union",
+              "types": [
+                {
+                  "type": "intrinsic",
+                  "name": "string"
+                },
+                {
+                  "type": "reference",
+                  "qualifiedName": "RegExp",
+                  "package": "typescript",
+                  "name": "RegExp"
+                }
+              ]
+            },
+            "inheritedFrom": {
+              "type": "reference",
+              "name": "SkyHarnessFilters.dataSkyId"
+            }
+          },
+          {
+            "id": 616,
+            "name": "selector",
+            "kind": 1024,
+            "kindString": "Property",
+            "flags": {
+              "isOptional": true
+            },
+            "comment": {
+              "shortText": "Only find instances whose host element matches the given selector."
+            },
+            "sources": [
+              {
+                "fileName": "node_modules/@angular/cdk/testing/component-harness.d.ts",
+                "line": 349,
+                "character": 4
+              }
+            ],
+            "type": {
+              "type": "intrinsic",
+              "name": "string"
+            },
+            "inheritedFrom": {
+              "type": "reference",
+              "name": "SkyHarnessFilters.selector"
+            }
+          }
+        ],
+        "groups": [
+          {
+            "title": "Properties",
+            "kind": 1024,
+            "children": [
+              617,
+              615,
+              616
+            ]
+          }
+        ],
+        "sources": [
+          {
+            "fileName": "projects/indicators/src/testing/alert/alert-harness-filters.ts",
+            "line": 7,
+            "character": 17
+          }
+        ],
+        "extendedTypes": [
+          {
+            "type": "reference",
+            "name": "SkyHarnessFilters"
+          }
+        ]
       }
     ],
     "groups": [
@@ -6140,12 +6651,17 @@
     {
       "fileName": "alert-demo.component.html",
       "filePath": "/projects/indicators/documentation/code-examples/alert/basic/alert-demo.component.html",
-      "rawContents": "<sky-alert\n  alertType=\"info\"\n  [closeable]=\"true\"\n  (closedChange)=\"onClosedChange($event)\"\n  descriptionType=\"important-info\"\n>\n  Info alert message\n</sky-alert>\n"
+      "rawContents": "<sky-alert\n  data-sky-id=\"alert-demo\"\n  [alertType]=\"days < 8 ? 'danger' : 'warning'\"\n  [closeable]=\"days >= 8\"\n  [descriptionType]=\"days < 8 ? 'danger' : 'important-warning'\"\n  (closedChange)=\"onClosedChange($event)\"\n>\n  Your password expires in {{ days }} day(s)!\n</sky-alert>\n"
+    },
+    {
+      "fileName": "alert-demo.component.spec.ts",
+      "filePath": "/projects/indicators/documentation/code-examples/alert/basic/alert-demo.component.spec.ts",
+      "rawContents": "import { TestbedHarnessEnvironment } from '@angular/cdk/testing/testbed';\nimport { TestBed } from '@angular/core/testing';\nimport { SkyAlertHarness } from '@skyux/indicators/testing';\n\nimport { AlertDemoComponent } from './alert-demo.component';\nimport { AlertDemoModule } from './alert-demo.module';\n\ndescribe('Basic alert', () => {\n  async function setupTest(options?: { days?: number }) {\n    const fixture = TestBed.createComponent(AlertDemoComponent);\n\n    if (options?.days !== undefined) {\n      fixture.componentInstance.days = options.days;\n    }\n\n    const loader = TestbedHarnessEnvironment.loader(fixture);\n\n    const alertHarness = await loader.getHarness(\n      SkyAlertHarness.with({ dataSkyId: 'alert-demo' })\n    );\n\n    return { alertHarness, fixture };\n  }\n\n  beforeEach(() => {\n    TestBed.configureTestingModule({\n      imports: [AlertDemoModule],\n    });\n  });\n\n  it('should show the expected alert when the number of days is 8 or more', async () => {\n    const { alertHarness, fixture } = await setupTest({ days: 8 });\n    fixture.detectChanges();\n\n    await expectAsync(alertHarness.getAlertType()).toBeResolvedTo('warning');\n    await expectAsync(alertHarness.getText()).toBeResolvedTo(\n      'Your password expires in 8 day(s)!'\n    );\n    await expectAsync(alertHarness.isCloseable()).toBeResolvedTo(true);\n  });\n\n  it('should show the expected alert when the number of days is 7 or fewer', async () => {\n    const { alertHarness, fixture } = await setupTest({ days: 7 });\n    fixture.detectChanges();\n\n    await expectAsync(alertHarness.getAlertType()).toBeResolvedTo('danger');\n    await expectAsync(alertHarness.getText()).toBeResolvedTo(\n      'Your password expires in 7 day(s)!'\n    );\n    await expectAsync(alertHarness.isCloseable()).toBeResolvedTo(false);\n  });\n});\n"
     },
     {
       "fileName": "alert-demo.component.ts",
       "filePath": "/projects/indicators/documentation/code-examples/alert/basic/alert-demo.component.ts",
-      "rawContents": "import { Component } from '@angular/core';\n\n@Component({\n  selector: 'app-alert-demo',\n  templateUrl: './alert-demo.component.html',\n})\nexport class AlertDemoComponent {\n  public onClosedChange(event: boolean): void {\n    alert(`Alert closed with: ${event}`);\n  }\n}\n"
+      "rawContents": "import { ChangeDetectionStrategy, Component, Input } from '@angular/core';\n\n@Component({\n  selector: 'app-alert-demo',\n  templateUrl: './alert-demo.component.html',\n  changeDetection: ChangeDetectionStrategy.OnPush,\n})\nexport class AlertDemoComponent {\n  @Input()\n  public days = 9;\n\n  public onClosedChange(event: boolean): void {\n    alert(`Alert closed with: ${event}`);\n  }\n}\n"
     },
     {
       "fileName": "alert-demo.module.ts",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/indicators",
-  "version": "6.17.1",
+  "version": "6.18.0",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -45,10 +45,10 @@
     "@angular/common": "^13.3.2",
     "@angular/core": "^13.3.2",
     "@angular/platform-browser": "^13.3.2",
-    "@skyux-sdk/testing": "6.17.1",
-    "@skyux/core": "6.17.1",
-    "@skyux/i18n": "6.17.1",
-    "@skyux/theme": "6.17.1"
+    "@skyux-sdk/testing": "6.18.0",
+    "@skyux/core": "6.18.0",
+    "@skyux/i18n": "6.18.0",
+    "@skyux/theme": "6.18.0"
   },
   "dependencies": {
     "tslib": "^2.3.1"