@ohos-ports/cross-storage 1.0.0-beta.0

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,325 @@
+![cross-storage](https://github.com/zendesk/cross-storage/raw/master/media/logo.png)
+
+Cross domain local storage, with permissions. Enables multiple browser
+windows/tabs, across a variety of domains, to share a single localStorage.
+Features an API using ES6 promises.
+
+[![Build Status](https://travis-ci.org/zendesk/cross-storage.svg?branch=master)](https://travis-ci.org/zendesk/cross-storage)
+
+* [Overview](#overview)
+* [Installation](#installation)
+* [API](#api)
+  * [CrossStorageHub.init(permissions)](#crossstoragehubinitpermissions)
+  * [new CrossStorageClient(url, \[opts\])](#new-crossstorageclienturl-opts)
+  * [CrossStorageClient.prototype.onConnect()](#crossstorageclientprototypeonconnect)
+  * [CrossStorageClient.prototype.set(key, value)](#crossstorageclientprototypesetkey-value)
+  * [CrossStorageClient.prototype.get(key1, \[key2\], \[...\])](#crossstorageclientprototypegetkey1-key2-)
+  * [CrossStorageClient.prototype.del(key1, \[key2\], \[...\])](#crossstorageclientprototypedelkey1-key2-)
+  * [CrossStorageClient.prototype.getKeys()](#crossstorageclientprototypegetkeys)
+  * [CrossStorageClient.prototype.clear()](#crossstorageclientprototypeclear)
+  * [CrossStorageClient.prototype.close()](#crossstorageclientprototypeclose)
+* [Compatibility](#compatibility)
+* [Compression](#compression)
+* [Building](#building)
+* [Tests](#tests)
+* [Copyright and license](#copyright-and-license)
+
+## Overview
+
+The library is a convenient alternative to sharing a root domain cookie.
+Unlike cookies, your client-side data isn't limited to a few kilobytes - you
+get up to 2.49M chars. For a client-heavy application, you can potentially
+shave a few KB off your request headers by avoiding cookies. This is all thanks
+to LocalStorage, which is available in IE 8+, FF 3.5+, Chrome 4+, as well as a
+majority of mobile browsers. For a list of compatible browsers, refer to
+[caniuse](http://caniuse.com/#feat=namevalue-storage).
+
+How does it work? The library is divided into two types of components: hubs
+and clients. The hubs reside on a host of choice and interact directly with
+the LocalStorage API. The clients then load said hub over an embedded iframe
+and post messages, requesting data to be stored, retrieved, and deleted. This
+allows multiple clients to access and share the data located in a single store.
+
+Care should be made to limit the origins of the bidirectional communication.
+As such, when initializing the hub, an array of permissions objects is passed.
+Any messages from clients whose origin does not match the pattern are ignored,
+as well as those not within the allowed set of methods. The set of permissions
+are enforced thanks to the same-origin policy. However, keep in mind that any
+user has full control of their local storage data - it's still client data.
+This only restricts access on a per-domain or web app level.
+
+**Hub**
+
+``` javascript
+// Config s.t. subdomains can get, but only the root domain can set and del
+CrossStorageHub.init([
+  {origin: /\.example.com$/,            allow: ['get']},
+  {origin: /:\/\/(www\.)?example.com$/, allow: ['get', 'set', 'del']}
+]);
+```
+
+Note the $ for matching the end of the string. The RegExps in the above example
+will match origins such as valid.example.com, but not
+invalid.example.com.malicious.com.
+
+**Client**
+
+``` javascript
+var storage = new CrossStorageClient('https://store.example.com/hub.html');
+
+storage.onConnect().then(function() {
+  return storage.set('newKey', 'foobar');
+}).then(function() {
+  return storage.get('existingKey', 'newKey');
+}).then(function(res) {
+  console.log(res.length); // 2
+}).catch(function(err) {
+  // Handle error
+});
+```
+
+## Installation
+
+The library can be installed via bower:
+
+``` bash
+bower install cross-storage
+```
+
+Or using npm:
+
+``` bash
+npm install cross-storage
+```
+
+along with browserify:
+
+``` javascript
+var CrossStorageClient = require('cross-storage').CrossStorageClient;
+var CrossStorageHub    = require('cross-storage').CrossStorageHub;
+```
+
+When serving the hub, you may want to set the CORS and CSP headers for your
+server depending on client/hub location. For example:
+
+``` javascript
+{
+  'Access-Control-Allow-Origin':  '*',
+  'Access-Control-Allow-Methods': 'GET,PUT,POST,DELETE',
+  'Access-Control-Allow-Headers': 'X-Requested-With',
+  'Content-Security-Policy':      "default-src 'unsafe-inline' *",
+  'X-Content-Security-Policy':    "default-src 'unsafe-inline' *",
+  'X-WebKit-CSP':                 "default-src 'unsafe-inline' *",
+}
+```
+
+If using inline JS to create the hub, you'll need to specify `unsafe-inline`
+for the CSP headers. Otherwise, it can be left out if simply including the
+init code via another resource.
+
+## API
+
+#### CrossStorageHub.init(permissions)
+
+Accepts an array of objects with two keys: origin and allow. The value
+of origin is expected to be a RegExp, and allow, an array of strings.
+The cross storage hub is then initialized to accept requests from any of
+the matching origins, allowing access to the associated lists of methods.
+Methods may include any of: get, set, del, getKeys and clear. A 'ready'
+message is sent to the parent window once complete.
+
+``` javascript
+CrossStorageHub.init([
+  {origin: /localhost:3000$/, allow: ['get', 'set', 'del', 'getKeys', 'clear']}
+]);
+```
+
+#### new CrossStorageClient(url, [opts])
+
+Constructs a new cross storage client given the url to a hub. By default,
+an iframe is created within the document body that points to the url. It
+also accepts an options object, which may include a timeout, frameId, and
+promise. The timeout, in milliseconds, is applied to each request and
+defaults to 5000ms. The options object may also include a frameId,
+identifying an existing frame on which to install its listeners. If the
+promise key is supplied the constructor for a Promise, that Promise library
+will be used instead of the default window.Promise.
+
+``` javascript
+var storage = new CrossStorageClient('http://localhost:3000/hub.html');
+
+var storage = new CrossStorageClient('http://localhost:3000/hub.html', {
+  timeout: 5000,
+  frameId: 'storageFrame'
+});
+```
+
+#### CrossStorageClient.prototype.onConnect()
+
+Returns a promise that is fulfilled when a connection has been established
+with the cross storage hub. Its use is required to avoid sending any
+requests prior to initialization being complete.
+
+``` javascript
+storage.onConnect().then(function() {
+  // ready!
+});
+```
+
+#### CrossStorageClient.prototype.set(key, value)
+
+Sets a key to the specified value. Returns a promise that is fulfilled on
+success, or rejected if any errors setting the key occurred, or the request
+timed out.
+
+``` javascript
+storage.onConnect().then(function() {
+  return storage.set('key', JSON.stringify({foo: 'bar'}));
+});
+```
+
+#### CrossStorageClient.prototype.get(key1, [key2], [...])
+
+Accepts one or more keys for which to retrieve their values. Returns a
+promise that is settled on hub response or timeout. On success, it is
+fulfilled with the value of the key if only passed a single argument.
+Otherwise it's resolved with an array of values. On failure, it is rejected
+with the corresponding error message.
+
+``` javascript
+storage.onConnect().then(function() {
+  return storage.get('key1');
+}).then(function(res) {
+  return storage.get('key1', 'key2', 'key3');
+}).then(function(res) {
+  // ...
+});
+```
+
+#### CrossStorageClient.prototype.del(key1, [key2], [...])
+
+Accepts one or more keys for deletion. Returns a promise that is settled on
+hub response or timeout.
+
+``` javascript
+storage.onConnect().then(function() {
+  return storage.del('key1', 'key2');
+});
+```
+
+#### CrossStorageClient.prototype.getKeys()
+
+Returns a promise that, when resolved, passes an array of keys currently
+in storage.
+
+``` javascript
+storage.onConnect().then(function() {
+  return storage.getKeys();
+}).then(function(keys) {
+  // ['key1', 'key2', ...]
+});
+```
+
+#### CrossStorageClient.prototype.clear()
+
+Returns a promise that, when resolved, indicates that all localStorage
+data has been cleared.
+
+``` javascript
+storage.onConnect().then(function() {
+  return storage.clear();
+});
+```
+
+#### CrossStorageClient.prototype.close()
+
+Deletes the iframe and sets the connected state to false. The client can
+no longer be used after being invoked.
+
+``` javascript
+storage.onConnect().then(function() {
+  return storage.set('key1', 'key2');
+}).catch(function(err) {
+  // Handle error
+}).then(function() {
+  storage.close();
+});
+```
+
+## Compatibility
+
+For compatibility with older browsers, simply load a Promise polyfill such as
+[es6-promise](https://github.com/jakearchibald/es6-promise).
+
+``` html
+<script src="https://s3.amazonaws.com/es6-promises/promise-1.0.0.min.js"></script>
+```
+
+You can also use RSVP or any other ES6 compliant promise library. Supports IE8
+and up using the above polyfill. A JSON polyfill is also required
+for IE8 in Compatibility View. Also note that `catch` is a reserved word in IE8,
+and so error handling with promises can be done as:
+
+``` javascript
+storage.onConnect().then(function() {
+  return storage.get('key1');
+}).then(function(res) {
+  // ... on success
+})['catch'](function(err) {
+  // ... on error
+});
+```
+
+**Breaking Changes**
+
+API breaking changes were introduced in both 0.6 and 1.0. Refer to
+[releases](https://github.com/zendesk/cross-storage/releases) for details.
+
+**Notes on Safari 7+ (OSX, iOS)**
+
+All cross-domain local storage access is disabled by default with Safari 7+.
+This is a result of the "Block cookies and other website data" privacy setting
+being set to "From third parties and advertisers". Any cross-storage client
+code will not crash, however, it will only have access to a sandboxed, isolated
+local storage instance. As such, none of the data previously set by other
+origins will be accessible. If an option, one could fall back to using root
+cookies for those user agents, or requesting the data from a server-side store.
+
+## Compression
+
+Most localStorage-compatible browsers offer at least ~5Mb of storage. But keys
+and values are defined as DOMStrings, which are UTF-8 encoded using single
+16-bit sequences. That means a string of ~2.5 million ASCII characters will use
+up ~5Mb, since they're 2 bytes per char.
+
+If you need to maximize your storage space, consider using
+[lz-string](https://github.com/pieroxy/lz-string/). For smaller strings, it's
+not uncommon to see a 50% reduction in size when compressed, which will bring
+you a lot closer to 5 million characters. At that point, you're only limited by
+the average compression rate of your strings.
+
+## Building
+
+The minified, production JavaScript can be generated with gulp by running
+`gulp dist`. If not already on your system, gulp can be installed using
+`npm install -g gulp`
+
+## Tests
+
+Tests can be ran locally using `npm test`. Tests are ran using Zuul, and
+the Travis CI build uses Sauce Labs for multi-browser testing as well.
+
+## Copyright and license
+
+Copyright 2016 Zendesk
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.