The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Progressive-Web-Application-0.08
River stage zero No dependents
1 ++
/ Progressive::Web::Application::Template::GeneralDeferred

NAME

Progressive::Web::Application::Template::GeneralDeferred - A Progressive::Web::Application Template, cache then network, network then cache, offline mode and deferred install prompt.

SYNOPSIS

        my $pwa = Progressive::Web::Application->new(
                template => 'GeneralDeferred',
                params => {
                        scope => '/payment',
                        push_button_selector => '#install-pwa', 
                        offline_path => '/offline',
                        cache_name => 'my-cache-name-v1',
                        files_to_cache => [qw/.../],
                }
        );

Description

This template implements two types of caching:

1) cache then network

All resources/request uri's that are defined in the files_to_cache param will always be retrieved from the browser cache if they exists, if they do not exist, the pwa is still loading, then they will be retrieved from the network.

2) network then cache

All other resources/requests, that are not defined in files_to_cache, will be fetched via the network and then added to the cache for when the client losses connectivity.

The template implements a functional offline mode, it first checks the cache for a response for the passed request if found then this is returned else it will fall back to either a JSON response or the Response that is cached via the 'offline_path' param based upon the requestWith header.

It also allows you specify a scope for your application which will control when/where the service worker will activate within your application/domain.

Finally it implements a hook around the install application prompt, so that it does not show onload but defers until input from the user input (clicking on the specified node).

Methods

required_params

scope

A string representing a URL that defines a service worker's registration scope; that is, what range of URLs a service worker can control. This is usually a relative URL. It is relative to the base URL of the application.

https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerContainer/register

push_button_selector

A css selector to a button or node that on click triggers the 'Install Application' prompt.

offline_path

The offline endpoint that should be cached and retrieved when the client losses connectivity and the request is not retrievable from the cache.

cache_name

A cache name that is checked per 'active' state to ensure the client has the latest resources cached. If the cache name changes then the client will clear the existing cache and re-fetch resources from the server.

files_to_cache

An array of files/resources to pre-cache on install.

AUTHOR

LNATION, <thisusedtobeanemail at gmail.com>

BUGS

Please report any bugs or feature requests to bug-progressive-web-application at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Progressive-Web-Application. I will be notifie d, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

        perldoc Progressive::Web::Application

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2019 LNATION.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.