From bb747f144abc3f971494cce7e05f4a25eef996df Mon Sep 17 00:00:00 2001
From: mgechev <mgechev@gmail.com>
Date: Thu, 26 Sep 2024 11:18:38 -0700
Subject: [PATCH] docs: add expiry to the top banner (#57981)

Adding an expiry date to the banner similarly to
aio so we can automatically hide it when we reach
a certain date.

PR Close #57981
---
 .../top-level-banner.component.ts             | 23 ++++++++++++++++---
 1 file changed, 20 insertions(+), 3 deletions(-)

diff --git a/adev/shared-docs/components/top-level-banner/top-level-banner.component.ts b/adev/shared-docs/components/top-level-banner/top-level-banner.component.ts
index a1e3dc89ebf..f2454c00f2f 100644
--- a/adev/shared-docs/components/top-level-banner/top-level-banner.component.ts
+++ b/adev/shared-docs/components/top-level-banner/top-level-banner.component.ts
@@ -27,15 +27,21 @@ export class TopLevelBannerComponent implements OnInit {
   link = input<string>();
   // Text content to be displayed in the banner.
   text = input.required<string>();
-
-  // Whether the user has closed the banner.
+  // Optional expiry date. Setting the default expiry as a future date so we
+  // don't have to deal with undefined signal values.
+  expiry = input(new Date('3000-01-01'), {transform: parseDate});
+  // Whether the user has closed the banner or the survey has expired.
   hasClosed = signal<boolean>(false);
 
   ngOnInit(): void {
+    const expired = Date.now() > this.expiry().getTime();
+
     // Needs to be in a try/catch, because some browsers will
     // throw when using `localStorage` in private mode.
     try {
-      this.hasClosed.set(this.localStorage?.getItem(this.getBannerStorageKey()) === 'true');
+      this.hasClosed.set(
+        this.localStorage?.getItem(this.getBannerStorageKey()) === 'true' || expired,
+      );
     } catch {
       this.hasClosed.set(false);
     }
@@ -50,3 +56,14 @@ export class TopLevelBannerComponent implements OnInit {
     return `${STORAGE_KEY_PREFIX}${this.id()}`;
   }
 }
+
+const parseDate = (inputDate: string | Date): Date => {
+  if (inputDate instanceof Date) {
+    return inputDate;
+  }
+  const outputDate = new Date(inputDate);
+  if (isNaN(outputDate.getTime())) {
+    throw new Error(`Invalid date string: ${inputDate}`);
+  }
+  return outputDate;
+};