MOB-78 Update iOS SDK to 4.16.0 (#12)

Add justfile. Update CONTRIBUTING.
hypertrack · Jun 12, 2023 · 41477fe · 41477fe
1 parent bd3d40d
commit 41477fe
Show file tree

Hide file tree

Showing 15 changed files with 75 additions and 50 deletions.
diff --git a/.justfile b/.justfile
@@ -0,0 +1,8 @@
+docs:
+    npm run docgen
+
+release: docs
+    npm publish --dry-run
+    @echo "THIS IS DRY RUN. Check if everything is ok and then run 'npm publish'. Checklist:"
+    @echo "\t- check the release steps in CONTRIBUTING"
+    @echo "\t- docs are up to date"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,7 +3,15 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.1] - 2023-06-01
+
+### Changed
+- HyperTrack SDK iOS updated to 4.16.0
+
 ## [1.0.0] - 2023-02-10
 
-#### Added
-- Initial release
+### Added
+- Initial release
+
+[1.0.1] https://github.com/hypertrack/sdk-ionic-capacitor/releases/tag/1.0.1
+[1.0.0] https://github.com/hypertrack/sdk-ionic-capacitor/releases/tag/1.0.0
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -14,17 +14,26 @@
        - `s.dependency 'HyperTrack'`
 
 2. Increment wrapper version
+
    - `package.json`
      - `version`
+
 3. Update CHANGELOG.md
+
+   - Add the release link to the bottom
+
 4. Update badge in README.md
-5. Commit
-5. Create a version tag
-6. Push branch and tags
-7. Create a Github repo release
+
+5. Do the release dry run with `just release` and verify that the release is correct (checklist is in the command output)
+
+6. Commit and merge to master
+
+7. Create and push a new version tag
+
+8. Create a Github repo release
    - Release title should be the current version tag
-8. `npm release`
-9. `npm publish`
+  
+9. Run `npm publish` to publish the package to npm
 
 ## Scripts
 

diff --git a/HypertrackSdkIonicCapacitor.podspec b/HypertrackSdkIonicCapacitor.podspec
@@ -14,5 +14,5 @@ Pod::Spec.new do |s|
   s.ios.deployment_target  = '12.0'
   s.dependency 'Capacitor'
   s.swift_version = '5.1'
-  s.dependency 'HyperTrack','4.14.0'
+  s.dependency 'HyperTrack','4.16.0'
 end
diff --git a/docs/classes/HyperTrack.html b/docs/classes/HyperTrack.html
@@ -1,18 +1,18 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HyperTrack | HyperTrack Ionic Capacitor SDK API - v1.0.0</title><meta name="description" content="Documentation for HyperTrack Ionic Capacitor SDK API - v1.0.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HyperTrack | HyperTrack Ionic Capacitor SDK API - v1.0.1</title><meta name="description" content="Documentation for HyperTrack Ionic Capacitor SDK API - v1.0.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
 <div class="tsd-toolbar-contents container">
 <div class="table-cell" id="tsd-search" data-base="..">
 <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
 <div class="field">
 <div id="tsd-toolbar-links"></div></div>
 <ul class="results">
 <li class="state loading">Preparing search index...</li>
-<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">HyperTrack Ionic Capacitor SDK API - v1.0.0</a></div>
+<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">HyperTrack Ionic Capacitor SDK API - v1.0.1</a></div>
 <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
 <div class="container container-main">
 <div class="col-8 col-content">
 <div class="tsd-page-title">
 <ul class="tsd-breadcrumb">
-<li><a href="../index.html">HyperTrack Ionic Capacitor SDK API - v1.0.0</a></li>
+<li><a href="../index.html">HyperTrack Ionic Capacitor SDK API - v1.0.1</a></li>
 <li><a href="HyperTrack.html">HyperTrack</a></li></ul>
 <h1>Class HyperTrack</h1></div>
 <section class="tsd-panel tsd-hierarchy">
@@ -296,7 +296,7 @@ <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option
 <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
 <div class="tsd-accordion-details">
 <ul>
-<li><a href="../index.html">Hyper<wbr/>Track <wbr/>Ionic <wbr/>Capacitor SDK API -<wbr/> v1.0.0</a>
+<li><a href="../index.html">Hyper<wbr/>Track <wbr/>Ionic <wbr/>Capacitor SDK API -<wbr/> v1.0.1</a>
 <ul></ul></li></ul></div></details></nav>
 <nav class="tsd-navigation secondary menu-sticky">
 <ul>

diff --git a/docs/enums/HyperTrackError.html b/docs/enums/HyperTrackError.html
@@ -1,18 +1,18 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HyperTrackError | HyperTrack Ionic Capacitor SDK API - v1.0.0</title><meta name="description" content="Documentation for HyperTrack Ionic Capacitor SDK API - v1.0.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HyperTrackError | HyperTrack Ionic Capacitor SDK API - v1.0.1</title><meta name="description" content="Documentation for HyperTrack Ionic Capacitor SDK API - v1.0.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
 <div class="tsd-toolbar-contents container">
 <div class="table-cell" id="tsd-search" data-base="..">
 <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
 <div class="field">
 <div id="tsd-toolbar-links"></div></div>
 <ul class="results">
 <li class="state loading">Preparing search index...</li>
-<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">HyperTrack Ionic Capacitor SDK API - v1.0.0</a></div>
+<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">HyperTrack Ionic Capacitor SDK API - v1.0.1</a></div>
 <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
 <div class="container container-main">
 <div class="col-8 col-content">
 <div class="tsd-page-title">
 <ul class="tsd-breadcrumb">
-<li><a href="../index.html">HyperTrack Ionic Capacitor SDK API - v1.0.0</a></li>
+<li><a href="../index.html">HyperTrack Ionic Capacitor SDK API - v1.0.1</a></li>
 <li><a href="HyperTrackError.html">HyperTrackError</a></li></ul>
 <h1>Enumeration HyperTrackError</h1></div>
 <section class="tsd-panel-group tsd-index-group">
@@ -116,7 +116,7 @@ <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option
 <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
 <div class="tsd-accordion-details">
 <ul>
-<li><a href="../index.html">Hyper<wbr/>Track <wbr/>Ionic <wbr/>Capacitor SDK API -<wbr/> v1.0.0</a>
+<li><a href="../index.html">Hyper<wbr/>Track <wbr/>Ionic <wbr/>Capacitor SDK API -<wbr/> v1.0.1</a>
 <ul></ul></li></ul></div></details></nav>
 <nav class="tsd-navigation secondary menu-sticky">
 <ul>

diff --git a/docs/index.html b/docs/index.html
@@ -1,17 +1,17 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HyperTrack Ionic Capacitor SDK API - v1.0.0</title><meta name="description" content="Documentation for HyperTrack Ionic Capacitor SDK API - v1.0.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HyperTrack Ionic Capacitor SDK API - v1.0.1</title><meta name="description" content="Documentation for HyperTrack Ionic Capacitor SDK API - v1.0.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
 <div class="tsd-toolbar-contents container">
 <div class="table-cell" id="tsd-search" data-base=".">
 <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
 <div class="field">
 <div id="tsd-toolbar-links"></div></div>
 <ul class="results">
 <li class="state loading">Preparing search index...</li>
-<li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">HyperTrack Ionic Capacitor SDK API - v1.0.0</a></div>
+<li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">HyperTrack Ionic Capacitor SDK API - v1.0.1</a></div>
 <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
 <div class="container container-main">
 <div class="col-8 col-content">
 <div class="tsd-page-title">
-<h2>HyperTrack Ionic Capacitor SDK API - v1.0.0</h2></div>
+<h2>HyperTrack Ionic Capacitor SDK API - v1.0.1</h2></div>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -65,7 +65,7 @@ <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option
 <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
 <div class="tsd-accordion-details">
 <ul>
-<li class="current selected"><a href="index.html">Hyper<wbr/>Track <wbr/>Ionic <wbr/>Capacitor SDK API -<wbr/> v1.0.0</a>
+<li class="current selected"><a href="index.html">Hyper<wbr/>Track <wbr/>Ionic <wbr/>Capacitor SDK API -<wbr/> v1.0.1</a>
 <ul></ul></li></ul></div></details></nav>
 <nav class="tsd-navigation secondary menu-sticky">
 <ul>

diff --git a/docs/interfaces/Subscription.html b/docs/interfaces/Subscription.html
@@ -1,18 +1,18 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Subscription | HyperTrack Ionic Capacitor SDK API - v1.0.0</title><meta name="description" content="Documentation for HyperTrack Ionic Capacitor SDK API - v1.0.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Subscription | HyperTrack Ionic Capacitor SDK API - v1.0.1</title><meta name="description" content="Documentation for HyperTrack Ionic Capacitor SDK API - v1.0.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
 <div class="tsd-toolbar-contents container">
 <div class="table-cell" id="tsd-search" data-base="..">
 <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
 <div class="field">
 <div id="tsd-toolbar-links"></div></div>
 <ul class="results">
 <li class="state loading">Preparing search index...</li>
-<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">HyperTrack Ionic Capacitor SDK API - v1.0.0</a></div>
+<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">HyperTrack Ionic Capacitor SDK API - v1.0.1</a></div>
 <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
 <div class="container container-main">
 <div class="col-8 col-content">
 <div class="tsd-page-title">
 <ul class="tsd-breadcrumb">
-<li><a href="../index.html">HyperTrack Ionic Capacitor SDK API - v1.0.0</a></li>
+<li><a href="../index.html">HyperTrack Ionic Capacitor SDK API - v1.0.1</a></li>
 <li><a href="Subscription.html">Subscription</a></li></ul>
 <h1>Interface Subscription</h1></div>
 <section class="tsd-panel tsd-hierarchy">
@@ -60,7 +60,7 @@ <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option
 <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
 <div class="tsd-accordion-details">
 <ul>
-<li><a href="../index.html">Hyper<wbr/>Track <wbr/>Ionic <wbr/>Capacitor SDK API -<wbr/> v1.0.0</a>
+<li><a href="../index.html">Hyper<wbr/>Track <wbr/>Ionic <wbr/>Capacitor SDK API -<wbr/> v1.0.1</a>
 <ul></ul></li></ul></div></details></nav>
 <nav class="tsd-navigation secondary menu-sticky">
 <ul>