@govuk-one-login/frontend-ui 2.0.0 → 3.1.0

package/build/esm/frontend/spinner/spinner.d.ts

@@ -1,90 +1,64 @@
-export declare function useSpinner(): void;
-type TVDOM = {
-    classes: string[];
-    buttonDisabled?: boolean;
-    id?: string;
-    innerHTML?: string;
-    nodeName: string;
-    text?: string;
+export declare function useSpinner(containerId: string, pollingFunction: PollingFunction, successFunction: VoidFunction, errorFunction: VoidFunction): Promise<void>;
+export type PollingFunction = (abortSignal: AbortSignal) => Promise<PollResult>;
+export declare enum PollResult {
+    Success = 0,
+    Failure = 1,
+    Pending = 2,
+    Backoff = 3
+}
+declare enum SpinnerState {
+    Waiting = 0,
+    LongWaiting = 1,
+    Error = 2,
+    Complete = 3
+}
+type SpinnerConfig = {
+    msBeforeInformingOfLongWait: number;
+    msBeforeAbort: number;
+    msBetweenRequests: number;
+    msBetweenDomUpdate: number;
+    ariaAlertCompletionText?: string;
+    hideSpinnerOnError: boolean;
+    maxBackoffTries: number;
 };
 export declare class Spinner {
-    container: HTMLElement;
-    spinnerContainer: HTMLElement;
-    ariaLiveContainer: HTMLElement;
-    content: {
-        complete: {
-            ariaButtonEnabledMessage?: string;
-            spinnerState: string;
-        };
-        continueButton: {
-            text: string;
-        };
-        error: {
-            heading: string;
-            messageText: string;
-            whatYouCanDo: {
-                heading: string;
-                message: {
-                    text1: string;
-                    link: {
-                        href: string;
-                        text: string;
-                    };
-                    text2: string;
-                };
-            };
-        };
-        initial: {
-            heading: string;
-            spinnerStateText: string;
-            spinnerState: string;
-        };
-        longWait: {
-            spinnerStateText: string;
-        };
-    };
-    domRequirementsMet?: boolean;
-    state: {
-        ariaButtonEnabledMessage?: string;
-        buttonDisabled: boolean;
-        done: boolean;
-        error: boolean;
-        heading: string;
-        messageText?: string;
-        spinnerState: string;
-        spinnerStateText: string;
-        virtualDom: TVDOM[];
-    };
-    updateDomTimer: NodeJS.Timeout;
+    container: HTMLDivElement;
+    noJsContent: HTMLElement;
+    waitContent?: HTMLElement;
+    longWaitContent?: HTMLElement;
+    successContent?: HTMLElement;
+    errorContent?: HTMLElement;
+    ariaLiveContainer: HTMLDivElement;
+    visibleElementsContainer: HTMLDivElement;
+    state: SpinnerState;
+    displayState?: SpinnerState;
+    updateDomTimer?: NodeJS.Timeout;
     abortController: AbortController;
-    config: {
-        apiUrl: string;
-        ariaButtonEnabledMessage?: string;
-        msBeforeInformingOfLongWait: number;
-        msBeforeAbort: number;
-        msBetweenRequests: number;
-        msBetweenDomUpdate: number;
-    };
-    notInErrorOrDoneState: () => boolean;
-    reflectCompletion: () => void;
-    reflectError: () => void;
-    reflectLongWait(): void;
-    updateAccordingToTimeElapsed: (initTime: number) => void;
-    initialiseState(): void;
-    initialiseContent(element: HTMLElement): void;
-    createVirtualDom(): TVDOM[];
-    vDomHasChanged: (currentVDom: TVDOM[], nextVDom: TVDOM[]) => boolean;
-    convert: (node: TVDOM) => HTMLElement;
-    updateAriaAlert: (messageText: string) => void;
-    updateDom: () => void;
-    requestIDProcessingStatus(initTime: number): Promise<void>;
-    initialiseContainers: () => void;
-    getInitTime(): number;
-    initTimer: (initTime: number) => void;
-    handleAbort: () => void;
-    initialiseAbortController: () => void;
-    init(): void;
-    constructor(domContainer: HTMLElement);
+    config: SpinnerConfig;
+    backOffCount: number;
+    pollingFunction: PollingFunction;
+    onSuccess: VoidFunction;
+    onError: VoidFunction;
+    constructor(domContainer: HTMLDivElement, pollingFunction: PollingFunction, onSuccess: VoidFunction, onError: VoidFunction);
+    init(): Promise<void>;
+    private getElementOrThrow;
+    private getConfig;
+    private createAbortController;
+    private handleAbort;
+    private getInitTime;
+    private initTimer;
+    private hasCompleted;
+    private reflectSuccess;
+    private reflectError;
+    private reflectLongWait;
+    private updateStateAccordingToTimeElapsed;
+    private createSpinnerElement;
+    private updateDom;
+    private cloneAndAddIfExists;
+    private callPollingFunction;
+    private calculateBackoffTime;
+    private createAriaLiveContainer;
+    private updateAriaAlert;
 }
 export {};
 //# sourceMappingURL=spinner.d.ts.map

package/build/esm/frontend/spinner/spinner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"spinner.d.ts","sourceRoot":"","sources":["../../../../frontend-src/spinner/spinner.ts"],"names":[],"mappings":"AAAA,wBAAgB,UAAU,SAWzB;AAED,KAAK,KAAK,GAAG;IACX,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,qBAAa,OAAO;IAClB,SAAS,cAAC;IACV,gBAAgB,EAAE,WAAW,CAAC;IAC9B,iBAAiB,EAAE,WAAW,CAAC;IAC/B,OAAO,EAAE;QACP,QAAQ,EAAE;YACR,wBAAwB,CAAC,EAAE,MAAM,CAAC;YAClC,YAAY,EAAE,MAAM,CAAC;SACtB,CAAC;QACF,cAAc,EAAE;YACd,IAAI,EAAE,MAAM,CAAC;SACd,CAAC;QACF,KAAK,EAAE;YACL,OAAO,EAAE,MAAM,CAAC;YAChB,WAAW,EAAE,MAAM,CAAC;YACpB,YAAY,EAAE;gBACZ,OAAO,EAAE,MAAM,CAAC;gBAChB,OAAO,EAAE;oBACP,KAAK,EAAE,MAAM,CAAC;oBACd,IAAI,EAAE;wBACJ,IAAI,EAAE,MAAM,CAAC;wBACb,IAAI,EAAE,MAAM,CAAC;qBACd,CAAC;oBACF,KAAK,EAAE,MAAM,CAAC;iBACf,CAAC;aACH,CAAC;SACH,CAAC;QACF,OAAO,EAAE;YACP,OAAO,EAAE,MAAM,CAAC;YAChB,gBAAgB,EAAE,MAAM,CAAC;YACzB,YAAY,EAAE,MAAM,CAAC;SACtB,CAAC;QACF,QAAQ,EAAE;YACR,gBAAgB,EAAE,MAAM,CAAC;SAC1B,CAAC;KACH,CAAC;IACF,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,KAAK,EAAE;QACL,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAClC,cAAc,EAAE,OAAO,CAAC;QACxB,IAAI,EAAE,OAAO,CAAC;QACd,KAAK,EAAE,OAAO,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,YAAY,EAAE,MAAM,CAAC;QACrB,gBAAgB,EAAE,MAAM,CAAC;QACzB,UAAU,EAAE,KAAK,EAAE,CAAC;KACrB,CAAC;IACF,cAAc,EAAE,MAAM,CAAC,OAAO,CAAC;IAC/B,eAAe,EAAE,eAAe,CAAC;IACjC,MAAM,EAAE;QACN,MAAM,EAAE,MAAM,CAAC;QACf,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAClC,2BAA2B,EAAE,MAAM,CAAC;QACpC,aAAa,EAAE,MAAM,CAAC;QACtB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,kBAAkB,EAAE,MAAM,CAAC;KAC5B,CAMC;IAEF,qBAAqB,gBAEnB;IAEF,iBAAiB,aAQf;IAEF,YAAY,aAQV;IAEF,eAAe;IAMf,4BAA4B,GAAI,UAAU,MAAM,UAO9C;IAEF,eAAe;IAef,iBAAiB,CAAC,OAAO,EAAE,WAAW;IA8EtC,gBAAgB,IAAI,KAAK,EAAE;IAwD3B,cAAc,GAAI,aAAa,KAAK,EAAE,EAAE,UAAU,KAAK,EAAE,aAEvD;IAEF,OAAO,GAAI,MAAM,KAAK,iBASpB;IAEF,eAAe,GAAI,aAAa,MAAM,UAQpC;IAEF,SAAS,aA0BP;IAEI,yBAAyB,CAAC,QAAQ,EAAE,MAAM;IAgChD,oBAAoB,aAUlB;IAEF,WAAW;IAYX,SAAS,GAAI,UAAU,MAAM,UAO3B;IAEF,WAAW,aAET;IAEF,yBAAyB,aAIvB;IAEF,IAAI;gBAWQ,YAAY,EAAE,WAAW;CAMtC"}
+{"version":3,"file":"spinner.d.ts","sourceRoot":"","sources":["../../../../frontend-src/spinner/spinner.ts"],"names":[],"mappings":"AAAA,wBAAsB,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,iBAoBjJ;AAED,MAAM,MAAM,eAAe,GAAG,CAAC,WAAW,EAAE,WAAW,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;AAEhF,oBAAY,UAAU;IACpB,OAAO,IAAA;IACP,OAAO,IAAA;IACP,OAAO,IAAA;IACP,OAAO,IAAA;CACR;AAED,aAAK,YAAY;IACf,OAAO,IAAA;IACP,WAAW,IAAA;IACX,KAAK,IAAA;IACL,QAAQ,IAAA;CACT;AAED,KAAK,aAAa,GAAG;IACnB,2BAA2B,EAAE,MAAM,CAAC;IACpC,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,kBAAkB,EAAE,OAAO,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,qBAAa,OAAO;IAClB,SAAS,EAAE,cAAc,CAAC;IAC1B,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,eAAe,CAAC,EAAE,WAAW,CAAC;IAC9B,cAAc,CAAC,EAAE,WAAW,CAAC;IAC7B,YAAY,CAAC,EAAE,WAAW,CAAC;IAC3B,iBAAiB,EAAE,cAAc,CAAC;IAElC,wBAAwB,EAAE,cAAc,CAAC;IAEzC,KAAK,EAAE,YAAY,CAAwB;IAC3C,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;IAChC,eAAe,EAAE,eAAe,CAAC;IACjC,MAAM,EAAE,aAAa,CAAC;IACtB,YAAY,EAAE,MAAM,CAAK;IAEzB,eAAe,EAAE,eAAe,CAAC;IACjC,SAAS,EAAE,YAAY,CAAC;IACxB,OAAO,EAAE,YAAY,CAAC;gBAGpB,YAAY,EAAE,cAAc,EAC5B,eAAe,EAAE,eAAe,EAChC,SAAS,EAAE,YAAY,EACvB,OAAO,EAAE,YAAY;IA2CjB,IAAI;IAUV,OAAO,CAAC,iBAAiB;IAQzB,OAAO,CAAC,SAAS;IA0BjB,OAAO,CAAC,qBAAqB;IAO7B,OAAO,CAAC,WAAW,CAEjB;IAEF,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,SAAS,CAKf;IAEF,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,cAAc,CAGpB;IAEF,OAAO,CAAC,YAAY,CAIlB;IAEF,OAAO,CAAC,eAAe;IAMvB,OAAO,CAAC,iCAAiC,CAWvC;IAEF,OAAO,CAAC,oBAAoB;IAU5B,OAAO,CAAC,SAAS,CAkDf;IAEF,OAAO,CAAC,mBAAmB;YASb,mBAAmB;IA2CjC,OAAO,CAAC,oBAAoB;IAK5B,OAAO,CAAC,uBAAuB;IAS/B,OAAO,CAAC,eAAe;CAWxB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@govuk-one-login/frontend-ui",
-  "version": "2.0.0",
+  "version": "3.1.0",
   "description": "",
   "main": "build/cjs/backend/index.cjs",
   "module": "build/esm/backend/index.js",
@@ -22,7 +22,8 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/govuk-one-login/govuk-one-login-frontend.git"
+    "url": "git+https://github.com/govuk-one-login/govuk-one-login-frontend.git",
+    "directory": "packages/frontend-ui"
   },
   "keywords": [
     "govuk-one-login",

package/build/components/spinner/api.njk

@@ -1,27 +0,0 @@
-{% extends "layouts/main.njk" %}
-
-{% set url = "/api" %}
-
-{% block content %}
-
-    <div id="spinner-container"
-         data-initial-heading="Initial heading text"
-         data-initial-spinnerStateText="Initial spinner state text"
-         data-initial-spinnerState="pending"
-         data-error-heading="Error heading"
-         data-error-messageText="Error message text"
-         data-error-whatYouCanDo-heading="Error what you can do heading"
-         data-error-whatYouCanDo-message-text1="Error what you can do message text1"
-         data-error-whatYouCanDo-message-link-href="Error what you can do message link href"
-         data-error-whatYouCanDo-message-link-text="Error what you can do message link text"
-         data-error-whatYouCanDo-message-text2="Error what you can do message link text2"
-         data-complete-spinnerState="complete"
-         data-longWait-spinnerStateText="Long wait spinner state">
-    </div>
-
-{% endblock %}
-
-{% block pageScripts %}
-
-{% endblock %}
-