moovy2 · pull · Jan 9, 2022 · Jan 26, 2022 · Jan 26, 2022 · Jan 30, 2022
diff --git a/.babelrc.json b/.babelrc.json
diff --git a/.commitlintrc.json b/.commitlintrc.json
@@ -0,0 +1,3 @@
+{
+  "extends": ["@commitlint/config-conventional"]
+}
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,14 +1,28 @@
 module.exports = {
-    "ignorePatterns": ["/dist"],
-    "env": {
-      "browser": true
+  ignorePatterns: ['/dist'],
+  env: {
+    browser: true,
+  },
+  extends: ['airbnb-base', 'prettier'],
+  parserOptions: {
+    project: './tsconfig.json',
+  },
+  overrides: [
+    {
+      files: ['src/**/*.ts', 'test/**/*.ts'],
+      extends: ['airbnb-base', 'airbnb-typescript/base', 'prettier'],
+      rules: {
+        'import/no-extraneous-dependencies': [
+          'error',
+          {
+            devDependencies: true,
+            optionalDependencies: false,
+            peerDependencies: false,
+          },
+        ],
+        'no-underscore-dangle': 0,
+        'no-return-assign': ['error', 'except-parens'],
+      },
     },
-    "extends": [
-      "airbnb-base",
-      "prettier"
-    ],
-    "rules": {
-      "import/no-extraneous-dependencies": ["error", {"devDependencies": true, "optionalDependencies": false, "peerDependencies": false}],
-      "no-underscore-dangle": 0
-    }
+  ],
 };
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,7 +1,15 @@
 version: 2
 updates:
-  - package-ecosystem: "npm"
-    directory: "/"
+  - package-ecosystem: 'npm'
+    directory: '/'
     schedule:
-      interval: "daily"
-    versioning-strategy: increase-if-necessary
+      interval: 'monthly'
+    target-branch: 'master'
+    versioning-strategy: increase-if-necessary
+    allow:
+      # Allow both direct and indirect updates for all packages
+      - dependency-type: "direct"
+    commit-message:
+      prefix: fix
+      prefix-development: chore
+      include: scope      
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -1,5 +1,10 @@
 name: CI
-on: [pull_request]
+on:
+  pull_request: ~
+  push:
+    branches:
+      - develop
+      - master
 jobs:
   run:
     runs-on: ubuntu-latest
@@ -10,7 +15,7 @@ jobs:
       - name: Set up Node
         uses: actions/setup-node@v2
         with:
-          node-version: 14
+          node-version: 18
           check-latest: true
 
       - name: Cache dependencies
@@ -32,3 +37,8 @@ jobs:
 
       - name: test
         run: npm run test
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/[email protected]
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,41 @@
+name: Release
+
+on: workflow_dispatch
+permissions:
+  contents: read # for checkout
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for npm provenance
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: 20
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Pack
+        run: npm pack
+
+
+      - name: Semantic Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,6 @@ node_modules
 npm-debug.log
 .eslintcache
 /.vscode
+/tmp/**
+!/tmp/.gitkeep
+coverage
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit $1
diff --git a/.npmignore b/.npmignore
@@ -5,3 +5,4 @@ npm-debug.log
 docs
 .vscode
 .eslintcache
+tmp
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+lts/hydrogen
diff --git a/.releaserc.json b/.releaserc.json
@@ -0,0 +1,14 @@
+{
+  "branches": ["master"],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/github",
+      {
+        "assets": ["leaflet.offline*.tgz"]
+      }
+    ],
+    "@semantic-release/npm"
+  ]
+}
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
-# leaflet.offline version 2.x
+# leaflet.offline
 
 [![npm version](https://badge.fury.io/js/leaflet.offline.svg)](https://badge.fury.io/js/leaflet.offline)
+[![codecov](https://codecov.io/github/allartk/leaflet.offline/graph/badge.svg?token=dy1uNlSvsh)](https://codecov.io/github/allartk/leaflet.offline)
 [![Build Status](https://travis-ci.org/allartk/leaflet.offline.png?branch=master)](https://travis-ci.org/allartk/leaflet.offline)
 
 This library can be used to create maps, which are still available when you are offline and are fast when your connection is not. It works in the browser or can be used in an mobile app based on html and in progressive webapps.
@@ -42,16 +43,15 @@ For running the example locally, you'll need to clone the project and run:
 ```
 npm i && npm run build
 cd docs
-npm install && npm run serve
+npm install && npm run start
 ```
 
-You can test your code with `npm test`. Please configure eslint in your editor if you wish to contribute.
-
 **pull requests welcome**
 
-Please one feature at a time, if you can split your PR, please do so.
-
-Also, do not mix a feature with package updates.
+* You MUST test your code with `npm test` and  `npm run lint`. 
+* Please one feature at a time, if you can split your PR, please do so.
+* Also, do not mix a feature with package updates.
+* [Use commit message conventions](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#rules)
 
 ## Api
 

diff --git a/changelog.md b/changelog.md
@@ -0,0 +1,10 @@
+# Version 3
+
+- Removal of setOption method on the control
+- getTile is now getBlobByKey
+- openTilesDataBase is now an export function to get whole idb database
+- New control option alwaysDownload, if false, the control will not redownload tiles already in the db (and the savetile\* event do not fire)
+
+# Version 4
+
+- Changed arguments of getStoredTilesAsJson: send an object with tilesize instead of the full layer
diff --git a/docs/.eslintrc.js b/docs/.eslintrc.js
@@ -1,5 +1,12 @@
 module.exports = {
+  root: true,
+  ignorePatterns: ['/dist'],
+  env: {
+    browser: true,
+  },
+  extends: ['airbnb-base', 'prettier'],
   rules: {
     'no-console': ['error', { allow: ['debug'] }],
+    'no-underscore-dangle': 0,
   },
 };
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,2 +1,4 @@
 _site
-.jekyll-cache
+.jekyll-cache
+dist/*.hot-update.js
+dist/*.hot-update.json
diff --git a/docs/README.md b/docs/README.md
@@ -1,7 +1,10 @@
 # Examples website
 
+Requires docker to run jekyll
+
 ```bash
+npm i
 npm start
 ```
 
-http://localhost:4000
+http://localhost:4000
diff --git a/docs/_includes/head.html b/docs/_includes/head.html
@@ -0,0 +1,18 @@
+<title>Leaflet.offline | Examples</title>
+<meta charset="UTF-8" />
+<link rel="stylesheet" href="{{ site.assets_base_url }}assets/styles.css">
+<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+<link rel="stylesheet" href="https://unpkg.com/[email protected]/dist/leaflet.css" />
+<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.15.4/css/all.css">
+<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.15.4/css/v4-shims.css">
+<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css"
+    integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous" />
+<script src="https://code.jquery.com/jquery-3.3.1.slim.min.js"
+    integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo"
+    crossorigin="anonymous"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js"
+    integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1"
+    crossorigin="anonymous"></script>
+<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js"
+    integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM"
+    crossorigin="anonymous"></script>
diff --git a/docs/_includes/navbar.html b/docs/_includes/navbar.html
@@ -19,9 +19,13 @@
                 <li class="nav-item {% if page.url == '/list.html' %}active{% endif %}">
                     <a class="nav-link" href="list.html">Storage</a>
                 </li>
+                <li class="nav-item {% if page.url == '/iife.html' %}active{% endif %}">
+                    <a class="nav-link" href="iife.html">NoModules</a>
+                </li>
                 <li class="nav-item">
                     <a class="nav-link"
-                        href="https://github.com/allartk/leaflet.offline/blob/master/docs/api.md" target="_blank">Api Docs</a>
+                        href="https://github.com/allartk/leaflet.offline/blob/master/docs/typedoc/modules.md"
+                        target="_blank">Api Docs</a>
                 </li>
             </ul>
             <a href="https://twitter.com/allartk" class="mx-1">
@@ -30,7 +34,7 @@
             <a href="https://github.com/allartk/leaflet.offline" class="mx-1">
                 <i class="fab fa-github text-light"></i>
             </a>
-            
+
         </div>
     </div>
 </nav>
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -2,26 +2,7 @@
 <html>
 
 <head>
-  <title>Leaflet.offline | Examples</title>
-  <meta charset="UTF-8" />
-  <link rel="stylesheet" href="{{ site.assets_base_url }}assets/styles.css">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <link rel="stylesheet" href="https://unpkg.com/[email protected]/dist/leaflet.css" />
-  <script src="https://unpkg.com/[email protected]/dist/leaflet.js"></script>
-  <script src="https://unpkg.com/[email protected]/build/iife/index-min.js"></script>
-  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.15.4/css/all.css">
-  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.15.4/css/v4-shims.css">
-  <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css"
-    integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous" />
-  <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js"
-    integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo"
-    crossorigin="anonymous"></script>
-  <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js"
-    integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1"
-    crossorigin="anonymous"></script>
-  <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js"
-    integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM"
-    crossorigin="anonymous"></script>
+  {% include head.html %}
 </head>
 
 <body>
@@ -31,7 +12,8 @@
       <div class="col-md-12">
         <h1>{{ page.title }}</h1>
         <p>
-          <a href="https://github.com/allartk/leaflet.offline/blob/master/docs/src/{{ page.script }}" class="btn btn-outline-info" target="_blank">
+          <a href="https://github.com/allartk/leaflet.offline/blob/master/docs/src/{{ page.script }}"
+            class="btn btn-outline-info" target="_blank">
             <i class="fas fa-code"></i>
             View source
           </a>
@@ -43,4 +25,4 @@ <h1>{{ page.title }}</h1>
   <script src="{{ site.assets_base_url }}dist/{{ page.script }}"></script>
 </body>
 
-</html>
+</html>
diff --git a/docs/_layouts/iife.html b/docs/_layouts/iife.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+    {% include head.html %}
+    <link rel="stylesheet" href="https://unpkg.com/[email protected]/dist/leaflet.css"
+        integrity="sha256-kLaT2GOSpHechhsozzB+flnD+zUyjE2LlfWPgU04xyI=" crossorigin="" />
+    <script src="https://unpkg.com/[email protected]/dist/leaflet.js"
+        integrity="sha256-WBkoXOwTeyKclOHuWtc+i2uENFpDZ9YPdf5Hf+D7ewM=" crossorigin=""></script>
+    <script src="dist/leaflet.offline.bundle.js"></script>
+
+</head>
+
+<body>
+    {% include navbar.html %}
+    <div class="container-fluid py-md-3" style="max-width:1200px">
+        <div class="row">
+            <div class="col-md-12">
+                <h1>{{ page.title }}</h1>
+                <p>
+                    <a href="https://github.com/allartk/leaflet.offline/blob/master/docs/{{ page.script }}"
+                        class="btn btn-outline-info" target="_blank">
+                        <i class="fas fa-code"></i>
+                        View source
+                    </a>
+                </p>
+                {{ content }}
+            </div>
+        </div>
+    </div>
+    <script src="{{ site.assets_base_url }}{{ page.script }}"></script>
+</body>
+
+</html>
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,3 +5,4 @@ npm-debug.log @@
     docs
     .vscode
     .eslintcache
+    tmp