@nyaruka/temba-components 0.106.0 → 0.107.1

package/src/progress/FlowStartProgress.ts

@@ -0,0 +1,76 @@
+import { html, PropertyValueMap, TemplateResult } from 'lit';
+import { RapidElement } from '../RapidElement';
+import { property } from 'lit/decorators.js';
+import { fetchResults } from '../utils';
+
+export class FlowStartProgress extends RapidElement {
+  @property({ type: String })
+  uuid: string;
+
+  @property({ type: Number })
+  started: number;
+
+  @property({ type: Number })
+  total: number;
+
+  @property({ type: Number })
+  refreshes: number = 0;
+
+  @property({ type: String })
+  eta: string;
+
+  public updated(
+    changes: PropertyValueMap<any> | Map<PropertyKey, unknown>
+  ): void {
+    super.updated(changes);
+    if (changes.has('uuid')) {
+      this.refresh();
+    }
+  }
+
+  public refresh(): void {
+    fetchResults(`/api/v2/flow_starts.json?uuid=${this.uuid}`).then(
+      (data: any) => {
+        if (data.length > 0) {
+          this.refreshes++;
+          const start = data[0];
+          this.started = start.progress.started;
+          this.total = start.progress.total;
+
+          const elapsed =
+            new Date().getTime() - new Date(start.created_on).getTime();
+          const rate = this.started / elapsed;
+
+          // calculate the estimated time of arrival
+          const eta = new Date(
+            new Date().getTime() + (this.total - this.started) / rate
+          );
+
+          // Don't bother with estimates months out
+          const nextMonth = new Date();
+          nextMonth.setMonth(nextMonth.getMonth() + 2);
+          if (eta > nextMonth) {
+            this.eta = null;
+          } else {
+            this.eta = eta.toISOString();
+          }
+
+          if (this.started < this.total) {
+            // refresh with a backoff up to 1 minute
+            setTimeout(() => {
+              this.refresh();
+            }, Math.min(1000 * this.refreshes, 60000));
+          }
+        }
+      }
+    );
+  }
+
+  public render(): TemplateResult {
+    return html`<temba-progress
+      total=${this.total}
+      current=${this.started}
+      eta=${this.eta}
+    ></temba-progress>`;
+  }
+}

package/src/progress/ProgressBar.ts

@@ -0,0 +1,179 @@
+import { css, html, PropertyValueMap, TemplateResult } from 'lit';
+import { RapidElement } from '../RapidElement';
+import { property } from 'lit/decorators.js';
+
+export class ProgressBar extends RapidElement {
+  static styles = css`
+    .wrapper {
+      display: flex;
+      box-sizing: content-box;
+      background: #f1f1f1;
+      border-radius: var(--curvature);
+      box-shadow: inset 1px 1px 1px rgba(0, 0, 0, 0.05);
+    }
+
+    .meter {
+      flex-grow: 1;
+      display: flex;
+      box-sizing: content-box;
+      position: relative;
+      border-radius: var(--curvature);
+      border-top-right-radius: 0;
+      border-bottom-right-radius: 0;
+      padding: 4px;
+      min-height: 6px;
+    }
+    .meter > span {
+      display: block;
+      height: 100%;
+      border-radius: var(--curvature);
+      background-color: var(--color-primary-dark);
+      background-image: linear-gradient(
+        center bottom,
+        rgb(43, 194, 83) 37%,
+        rgb(84, 240, 83) 69%
+      );
+
+      position: relative;
+      overflow: hidden;
+      min-width: 3px;
+    }
+
+    .meter > span:after,
+    .animate > span > span {
+      content: '';
+      position: absolute;
+      top: 0;
+      left: 0;
+      bottom: 0;
+      right: 0;
+      background-image: linear-gradient(
+        -45deg,
+        rgba(255, 255, 255, 0.2) 25%,
+        transparent 25%,
+        transparent 50%,
+        rgba(255, 255, 255, 0.2) 50%,
+        rgba(255, 255, 255, 0.2) 75%,
+        transparent 75%,
+        transparent
+      );
+      z-index: 1;
+      background-size: 50px 50px;
+      animation: move 16s linear infinite;
+      border-top-right-radius: var(--curvature);
+      border-bottom-right-radius: var(--curvature);
+      border-top-left-radius: var(--curvature);
+      border-bottom-left-radius: var(--curvature);
+      overflow: hidden;
+    }
+
+    .animate > span:after {
+      display: none;
+    }
+
+    @keyframes move {
+      0% {
+        background-position: 0 0;
+      }
+      100% {
+        background-position: 50px 50px;
+      }
+    }
+
+    .complete {
+      transition: width 2s;
+    }
+
+    .incomplete {
+      flex-grow: 1;
+    }
+
+    .etc {
+      font-size: 0.7em;
+      background: rgba(0, 0, 0, 0.07);
+      font-weight: bold;
+      white-space: nowrap;
+      border-top-right-radius: var(--curvature);
+      border-bottom-right-radius: var(--curvature);
+      color: rgba(0, 0, 0, 0.5);
+      align-self: center;
+      padding: 2px 6px;
+    }
+
+    .meter.done > span:after,
+    .done .animate > span > span {
+      display: none;
+    }
+
+    .meter.done > span {
+      background: rgb(var(--success-rgb));
+    }
+  `;
+
+  @property({ type: Number })
+  total = 100;
+
+  @property({ type: Number })
+  current = 0;
+
+  @property({ type: Number })
+  pct = 0;
+
+  @property({ type: Boolean })
+  done = false;
+
+  @property({ type: String })
+  eta: string;
+
+  @property({ type: String, attribute: false })
+  estimatedCompletionDate: Date;
+
+  @property({ type: Boolean })
+  showEstimatedCompletion = false;
+
+  @property({ type: Boolean })
+  showPercentage = false;
+
+  public updated(
+    changes: PropertyValueMap<any> | Map<PropertyKey, unknown>
+  ): void {
+    if (changes.has('eta') && this.eta) {
+      this.estimatedCompletionDate = new Date(this.eta);
+      this.showEstimatedCompletion = this.estimatedCompletionDate > new Date();
+    }
+
+    if (changes.has('current')) {
+      const pct = Math.floor(Math.min((this.current / this.total) * 100, 100));
+      if (Number.isNaN(pct)) {
+        this.showPercentage = false;
+      } else {
+        this.pct = pct;
+        this.showPercentage = true;
+      }
+
+      this.done = this.pct >= 100;
+    }
+  }
+
+  public render(): TemplateResult {
+    return html`<div class="wrapper">
+      <div class="meter ${this.done ? 'done' : ''}">
+        <span class="complete" style="flex-basis: ${this.pct}%"></span>
+        <div class="incomplete"></div>
+      </div>
+
+      ${this.showPercentage || this.showEstimatedCompletion
+        ? html`<div class="etc">
+            ${this.estimatedCompletionDate &&
+            this.showEstimatedCompletion &&
+            !this.done
+              ? html`<temba-date
+                  value="${this.estimatedCompletionDate.toISOString()}"
+                  display="countdown"
+                ></temba-date>`
+              : html`${this.pct}%`}
+          </div>`
+        : null}
+    </div>`;
+  }
+}

package/src/store/Store.ts

@@ -289,6 +289,34 @@ export class Store extends RapidElement {
     });
   }
 
+  public shiftAndRound(duration, unit: string, singular: string) {
+    const value = Math.round(duration.shiftTo(unit).get(unit));
+    if (value == 1) {
+      return `1 ${singular}`;
+    } else {
+      return `${value} ${unit}`;
+    }
+  }
+
+  public getCountdown(futureDate: DateTime) {
+    const duration = futureDate.diff(DateTime.now());
+    const comps = duration.rescale();
+
+    if (comps.months > 0) {
+      return '> 1 month';
+    }
+
+    if (comps.days > 1) {
+      return `~ ${this.shiftAndRound(comps, 'days', 'day')}`;
+    }
+
+    if (comps.hours > 0) {
+      return `~ ${this.shiftAndRound(comps, 'hours', 'hour')}`;
+    }
+
+    return `~ ${this.shiftAndRound(comps, 'minutes', 'minute')}`;
+  }
+
   public getShortDuration(scheduled: DateTime, compareDate: DateTime = null) {
     const now = compareDate || DateTime.now();
     return scheduled

package/temba-modules.ts

@@ -59,6 +59,8 @@ import { Chat } from './src/chat/Chat';
 import { MediaPicker } from './src/mediapicker/MediaPicker';
 import { ContactNotepad } from './src/contacts/ContactNotepad';
 import { OutboxMonitor } from './src/outboxmonitor/OutboxMonitor';
+import { ProgressBar } from './src/progress/ProgressBar';
+import { FlowStartProgress } from './src/progress/FlowStartProgress';
 
 export function addCustomElement(name: string, comp: any) {
   if (!window.customElements.get(name)) {
@@ -128,3 +130,5 @@ addCustomElement('temba-chat', Chat);
 addCustomElement('temba-media-picker', MediaPicker);
 addCustomElement('temba-contact-notepad', ContactNotepad);
 addCustomElement('temba-outbox-monitor', OutboxMonitor);
+addCustomElement('temba-progress', ProgressBar);
+addCustomElement('temba-flowstart-progress', FlowStartProgress);