@cocreate/local-storage 1.22.0 → 2.0.0

package/CONTRIBUTING.md

@@ -1,19 +1,19 @@
 # Contributing to CoCreate-local-storage
 
-This project is work of [many contributors](https://github.com/CoCreate-app/CoCreate-local-storage/graphs/contributors).
-You're encouraged to submit [pull requests](https://github.com/CoCreate-app/CoCreate-local-storage/pulls),
-[propose features and discuss issues](https://github.com/CoCreate-app/CoCreate-local-storage/issues).
+This project is work of [many contributors](https://github.com/CoCreateJS/local-storage/graphs/contributors).
+You're encouraged to submit [pull requests](https://github.com/CoCreateJS/local-storage/pulls),
+[propose features and discuss issues](https://github.com/CoCreateJS/local-storage/issues).
 
 In the examples below, substitute your Github username for `contributor` in URLs.
 
 ## Fork the Project
 
-Fork the [project on Github](https://github.com/CoCreate-app/CoCreate-local-storage) and check out your copy.
+Fork the [project on Github](https://github.com/CoCreateJS/local-storage) and check out your copy.
 
 ```
 git local-storage https://github.com/contributor/CoCreate-local-storage.git
 cd CoCreate-local-storage
-git remote add upstream https://gitlab.com/cocreatejs/CoCreate-local-storage.git
+git remote add upstream https://github.com/CoCreateJS/local-storage.git
 ```
 
 ## Create a Topic Branch
@@ -75,7 +75,7 @@ git push origin my-feature-branch
 
 ## Make a Pull Request
 
-Go to [https://github.com/CoCreate-app/CoCreate-local-storage](https://github.com/CoCreate-app/CoCreate-local-storage) and select your feature branch.
+Go to [https://github.com/CoCreateJS/local-storage](https://github.com/CoCreateJS/local-storage) and select your feature branch.
 Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
 
 ## Rebase

package/README.md

@@ -1,28 +1,28 @@
 # CoCreate-local-storage
 
-A Simple component similar to CoCreate-input & CoCreate-fetch which Save and fetch data for inputs, textarea, selects from localstorage. Easily configured using HTML5 attributes and/or JavaScript API Take it for a spin in our [playground!](https://cocreate.app/docs/local-storage)
+A Simple component similar to CoCreate-input & CoCreate-fetch which Save and fetch data for inputs, textarea, selects from localstorage. Easily configured using HTML5 attributes and/or JavaScript API Take it for a spin in our [playground!](https://CoCreateJS.com/docs/local-storage)
 
-![minified](https://img.badgesize.io/https://cdn.cocreate.app/local-storage/latest/CoCreate-local-storage.min.js?style=flat-square&label=minified&color=orange)
-![gzip](https://img.badgesize.io/https://cdn.cocreate.app/local-storage/latest/CoCreate-local-storage.min.js?compression=gzip&style=flat-square&label=gzip&color=yellow)
-![brotli](https://img.badgesize.io/https://cdn.cocreate.app/local-storage/latest/CoCreate-local-storage.min.js?compression=brotli&style=flat-square&label=brotli)
-![GitHub latest release](https://img.shields.io/github/v/release/CoCreate-app/CoCreate-local-storage?style=flat-square)
-![License](https://img.shields.io/github/license/CoCreate-app/CoCreate-local-storage?style=flat-square)
+![minified](https://img.badgesize.io/https://cdn.CoCreateJS.com/local-storage/latest/CoCreate-local-storage.min.js?style=flat-square&label=minified&color=orange)
+![gzip](https://img.badgesize.io/https://cdn.CoCreateJS.com/local-storage/latest/CoCreate-local-storage.min.js?compression=gzip&style=flat-square&label=gzip&color=yellow)
+![brotli](https://img.badgesize.io/https://cdn.CoCreateJS.com/local-storage/latest/CoCreate-local-storage.min.js?compression=brotli&style=flat-square&label=brotli)
+![GitHub latest release](https://img.shields.io/github/v/release/CoCreateJS/local-storage?style=flat-square)
+![License](https://img.shields.io/github/license/CoCreateJS/local-storage?style=flat-square)
 ![Hiring](https://img.shields.io/static/v1?style=flat-square&label=&message=Hiring&color=blueviolet)
 
-![CoCreate-local-storage](https://cdn.cocreate.app/docs/CoCreate-local-storage.gif)
+![CoCreate-local-storage](https://cdn.CoCreateJS.com/docs/CoCreate-local-storage.gif)
 
-## [Docs & Demo](https://cocreate.app/docs/local-storage)
+## [Docs & Demo](https://CoCreateJS.com/docs/local-storage)
 
-For a complete guide and working demo refer to the [doumentation](https://cocreate.app/docs/local-storage)
+For a complete guide and working demo refer to the [doumentation](https://CoCreateJS.com/docs/local-storage)
 
 ## CDN
 
 ```html
-<script src="https://cdn.cocreate.app/local-storage/latest/CoCreate-local-storage.min.js"></script>
+<script src="https://cdn.CoCreateJS.com/local-storage/latest/CoCreate-local-storage.min.js"></script>
 ```
 
 ```html
-<script src="https://cdn.cocreate.app/local-storage/latest/CoCreate-local-storage.min.css"></script>
+<script src="https://cdn.CoCreateJS.com/local-storage/latest/CoCreate-local-storage.min.css"></script>
 ```
 
 ## NPM
@@ -50,13 +50,13 @@ $ yarn install @cocreate/local-storage
 
 # Announcements
 
-All updates to this library are documented in our [CHANGELOG](https://github.com/CoCreate-app/CoCreate-local-storage/blob/master/CHANGELOG.md) and [releases](https://github.com/CoCreate-app/CoCreate-local-storage/releases). You may also subscribe to email for releases and breaking changes.
+All updates to this library are documented in our [CHANGELOG](https://github.com/CoCreateJS/local-storage/blob/master/CHANGELOG.md) and [releases](https://github.com/CoCreateJS/local-storage/releases). You may also subscribe to email for releases and breaking changes.
 
 <a name="roadmap"></a>
 
 # Roadmap
 
-If you are interested in the future direction of this project, please take a look at our open [issues](https://github.com/CoCreate-app/CoCreate-local-storage/issues) and [pull requests](https://github.com/CoCreate-app/CoCreate-local-storage/pulls). We would love to hear your feedback.
+If you are interested in the future direction of this project, please take a look at our open [issues](https://github.com/CoCreateJS/local-storage/issues) and [pull requests](https://github.com/CoCreateJS/local-storage/pulls). We would love to hear your feedback.
 
 <a name="about"></a>
 
@@ -64,7 +64,7 @@ If you are interested in the future direction of this project, please take a loo
 
 CoCreate-local-storage is guided and supported by the CoCreate Developer Experience Team.
 
-Please Email the Developer Experience Team [here](mailto:develop@cocreate.app) in case of any queries.
+Please Email the Developer Experience Team [here](mailto:develop@CoCreateJS.com) in case of any queries.
 
 CoCreate-local-storage is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC.
 
@@ -72,9 +72,9 @@ CoCreate-local-storage is maintained and funded by CoCreate. The names and logos
 
 # How to Contribute
 
-We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/CoCreate-app/CoCreate-local-storage/blob/master/CONTRIBUTING.md) guide for details.
+We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/CoCreateJS/local-storage/blob/master/CONTRIBUTING.md) guide for details.
 
-We want this library to be community-driven, and CoCreate led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/CoCreate-app/CoCreate-local-storage/issues) and [pull requests](https://github.com/CoCreate-app/CoCreate-local-storage/pulls) or merely upvote or comment on existing issues or pull requests.
+We want this library to be community-driven, and CoCreate led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/CoCreateJS/local-storage/issues) and [pull requests](https://github.com/CoCreateJS/local-storage/pulls) or merely upvote or comment on existing issues or pull requests.
 
 We appreciate your continued support, thank you!
 
@@ -82,4 +82,4 @@ We appreciate your continued support, thank you!
 <a name="license"></a>
 # License
 
-[The MIT License (MIT)](https://github.com/CoCreate-app/CoCreate-local-storage/blob/master/LICENSE)
+[The MIT License (MIT)](https://github.com/CoCreateJS/local-storage/blob/master/LICENSE)

package/demo/index.html

@@ -86,6 +86,6 @@
         </form>
 
         <!--<script src="../dist/CoCreate-local-storage.js"></script>-->
-        <script src="https://CoCreate.app/dist/CoCreate.js"></script>
+        <script src="https://CoCreateJS.com/dist/CoCreate.js"></script>
     </body>
 </html>

package/docs/index.html

@@ -9,7 +9,7 @@
 			rel="icon"
 			type="image/png"
 			sizes="32x32"
-			href="https://cocreate.app/images/favicon.ico" />
+			href="https://CoCreateJS.com/images/favicon.ico" />
 		<meta
 			name="description"
 			content="Simple component to save and fetch data for inputs, textarea, selects from localstorage. easilly configuable with attributes and/or JavaScript API." />
@@ -19,13 +19,13 @@
 		<meta name="robots" content="index,follow" />
 		<meta
 			property="og:image"
-			content="https://cdn.cocreate.app/docs/local-storage.png" />
+			content="https://cdn.CoCreateJS.com/docs/local-storage.png" />
 
 		<!-- CoCreate CSS CDN-->
 
 		<link
 			rel="stylesheet"
-			href="https://ws.cocreate.app/docs.css"
+			href="https://ws.CoCreateJS.com/docs.css"
 			array="apples"
 			object="6069ff5042ef8ff5175a5c8d"
 			key="css"
@@ -74,7 +74,7 @@
 						share-title="CoCreate-local-storage"
 						share-height="600"
 						share-width="700"
-						share-media="https://cdn.cocreate.app/docs/local-storage.png"
+						share-media="https://cdn.CoCreateJS.com/docs/local-storage.png"
 						hover="display:block!important"
 						hover-query=".social-networks">
 						<div class="display:none social-networks">
@@ -105,7 +105,7 @@
 						></a>
 					</div>
 					<a
-						href="https://github.com/CoCreate-app/CoCreate-local-storage"
+						href="https://github.com/CoCreateJS/CoCreate-local-storage"
 						target="_blank"
 						class="margin-right:15px"
 						><i src="/assets/svg/github.svg"></i
@@ -144,7 +144,7 @@
 					<p class="padding:10px_0px line-height:1.5">
 						Or you can use cdn link:
 					</p>
-					<pre><code class="language-html">&lt;script&gt;https://cdn.cocreate.app/local-storage/latest/CoCreate-local-storage.min.js&lt;/script&gt;</code></pre>
+					<pre><code class="language-html">&lt;script&gt;https://cdn.CoCreateJS.com/local-storage/latest/CoCreate-local-storage.min.js&lt;/script&gt;</code></pre>
 
 					<div
 						id="local-storage-usage"
@@ -329,13 +329,13 @@
 				</div>
 			</div>
 			<button
-				href="https://github.com/CoCreate-app/CoCreate-local-storage/tree/master/docs/index.html?message=docs%3A%20describe%20your%20change..."
+				href="https://github.com/CoCreateJS/CoCreate-local-storage/tree/master/docs/index.html?message=docs%3A%20describe%20your%20change..."
 				target="_blank"
 				class="display:flex justify-content:center align-items:center position:fixed bottom:15px right:15px height:50px width:50px border-radius:50% box-shadow:0px_2px_10px_0px_rgba(0,_0,_0,_0.4)">
 				<i src="../assets/svg/pencil-alt.svg"></i>
 			</button>
 		</main>
 
-		<script src="https://CoCreate.app/dist/CoCreate.js"></script>
+		<script src="https://CoCreateJS.com/dist/CoCreate.js"></script>
 	</body>
 </html>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cocreate/local-storage",
-  "version": "1.22.0",
+  "version": "2.0.0",
   "description": "A Simple component similar to CoCreate-input & CoCreate-fetch which Save and fetch data for inputs, textarea, selects from localstorage. Easily configured using HTML5 attributes and/or JavaScript API",
   "keywords": [
     "local-storage",
@@ -22,17 +22,17 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://gitlab.com/cocreatejs/CoCreate-local-storage.git"
+    "url": "git+https://github.com/CoCreateJS/local-storage.git"
   },
   "author": "CoCreate LLC",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/CoCreate-app/CoCreate-local-storage/issues"
+    "url": "https://github.com/CoCreateJS/local-storage/issues"
   },
-  "homepage": "https://cocreate.app/docs/local-storage",
+  "homepage": "https://CoCreateJS.com/docs/local-storage",
   "funding": {
     "type": "GitHub Sponsors ❤",
-    "url": "https://github.com/sponsors/CoCreate-app"
+    "url": "https://github.com/sponsors/CoCreateJS"
   },
   "main": "./src/index.js",
   "dependencies": {

package/src/index.js

@@ -4,6 +4,11 @@ import Actions from "@cocreate/actions";
 let support = true;
 const storage = new Map();
 
+/**
+ *
+ * @public
+ * @environment client
+ */
 function init() {
     var elements = document.querySelectorAll(
         "[localstorage-set], [localstorage-get], [sessionstorage-set], [sessionstorage-get]"
@@ -36,6 +41,8 @@ function init() {
 /**
  * Initializes a collection of elements.
  * @param {Array<Element>} elements - An array of elements to be initialized.
+ * @public
+ * @environment client
  */
 function initElements(elements) {
     for (let element of elements) initElement(element);
@@ -44,6 +51,8 @@ function initElements(elements) {
 /**
  * Initializes a single element.
  * @param {Element} element - The element to initialize. This function expects an 'Element' type.
+ * @public
+ * @environment client
  */
 function initElement(element) {
     const types = ["localstorage", "sessionstorage"];
@@ -104,6 +113,8 @@ function initElement(element) {
  * @param key
  * @param type - 'localstorage' or 'sessionstorage'
  * @return { Mixed } The value associated with the key or undefined if not found.
+ * @public
+ * @environment client
  */
 function getItem(key, type = "localstorage") {
     if (support) {
@@ -117,6 +128,8 @@ function getItem(key, type = "localstorage") {
  * @param key - key name to store the value under
  * @param value - value to store
  * @param type - 'localstorage' or 'sessionstorage'
+ * @public
+ * @environment client
  */
 function setItem(key, value, type = "localstorage") {
     try {
@@ -161,6 +174,8 @@ function setItem(key, value, type = "localstorage") {
 /**
  * @param key - The key name to delete from the storage
  * @param type - 'localstorage' or 'sessionstorage'
+ * @public
+ * @environment client
  */
 function removeItem(key, type = "localstorage") {
     if (support) {
@@ -175,6 +190,8 @@ function removeItem(key, type = "localstorage") {
  * @param action
  *
  * @return { undefined } No return
+ * @public
+ * @environment client
  */
 async function runStorage(action) {
     const form = action.form;
@@ -219,18 +236,33 @@ async function runStorage(action) {
     );
 }
 
+/**
+ *
+ * @public
+ * @environment client
+ */
 const localStorage = {
     getItem: (key) => getItem(key, "localstorage"),
     setItem: (key, value) => setItem(key, value, "localstorage"),
     removeItem: (key) => removeItem(key, "localstorage")
 };
 
+/**
+ *
+ * @public
+ * @environment client
+ */
 const sessionStorage = {
     getItem: (key) => getItem(key, "sessionstorage"),
     setItem: (key, value) => setItem(key, value, "sessionstorage"),
     removeItem: (key) => removeItem(key, "sessionstorage")
 };
 
+/**
+ *
+ * @public
+ * @environment client
+ */
 function checkSupport() {
     // Check if the browser supports Web Storage.
     if (!("localStorage" in window) || !("sessionStorage" in window)) {
@@ -310,4 +342,51 @@ export default {
     checkSupport,
     localStorage,
     sessionStorage
-};
+};
+
+/**
+ *
+ * @name realtime
+ * @kind member
+ * @attribute
+ * @environment client
+ */
+
+/**
+ * A Simple component similar to CoCreate-input & CoCreate-fetch which Save and fetch data for inputs, textarea, selects from localstorage. Easily configured using HTML5 attributes and/or JavaScript API
+ *
+ * @module local-storage
+ * @environment client
+ */
+
+/**
+ * Declarative selectors recognized by this module.
+ *
+ * @name declarative-selectors
+ * @kind member
+ * @selectors
+ * @environment client
+ * @example
+ * ```json
+ * [
+ *   "[localstorage-set], [sessionstorage-set]"
+ * ]
+ * ```
+ */
+
+/**
+ * Declarative actions supported or registered by this module.
+ *
+ * @name declarative-actions
+ * @kind member
+ * @actions
+ * @environment client
+ * @example
+ * ```json
+ * [
+ *   {
+ *     "name": "localStorage"
+ *   }
+ * ]
+ * ```
+ */