@homebridge-plugins/homebridge-august 3.0.4-beta.4 → 3.0.4

package/docs/index.html

@@ -36,11 +36,5 @@ plugin allows you to access your <a href="https://august.com">August</a> &amp; <
 <li>Yale Assure Lock 2 (YDR410)</li>
 <li>Yale Assure Lock SL (YDR256)</li>
 </ul>
-<a id="troubleshooting" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Troubleshooting<a href="#troubleshooting" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="lock-is-detected-but-doesnt-appear-in-homekit" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Lock is detected but doesn't appear in HomeKit<a href="#lock-is-detected-but-doesnt-appear-in-homekit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>If you see "Total August Locks Found: 1" in the logs but your lock doesn't appear in HomeKit, it's likely because your August lock already has HomeKit enabled. Pro models often have this enabled by default.</p>
-<p><strong>Solution:</strong> Add the following to your device configuration:</p>
-<pre><code class="json"><span class="hl-0">{</span><br><span class="hl-0">  </span><span class="hl-1">"name"</span><span class="hl-0">: </span><span class="hl-2">"August"</span><span class="hl-0">,</span><br><span class="hl-0">  </span><span class="hl-1">"platform"</span><span class="hl-0">: </span><span class="hl-2">"August"</span><span class="hl-0">,</span><br><span class="hl-0">  </span><span class="hl-1">"credentials"</span><span class="hl-0">: { </span><span class="hl-3">...</span><span class="hl-0"> },</span><br><span class="hl-0">  </span><span class="hl-1">"options"</span><span class="hl-0">: {</span><br><span class="hl-0">    </span><span class="hl-1">"devices"</span><span class="hl-0">: [</span><br><span class="hl-0">      {</span><br><span class="hl-0">        </span><span class="hl-1">"lockId"</span><span class="hl-0">: </span><span class="hl-2">"YOUR_LOCK_ID"</span><span class="hl-0">,</span><br><span class="hl-0">        </span><span class="hl-1">"overrideHomeKitEnabled"</span><span class="hl-0">: </span><span class="hl-4">true</span><br><span class="hl-0">      }</span><br><span class="hl-0">    ]</span><br><span class="hl-0">  }</span><br><span class="hl-0">}</span>
-</code><button type="button">Copy</button></pre>
-
-<p>You can find your lock ID in the Homebridge logs.</p>
 <a id="thanks" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Thanks<a href="#thanks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Thank you to <a href="https://github.com/hufftheweevil">hufftheweevil</a> for the <a href="https://github.com/hufftheweevil/august-api">august-api</a> module.</p>
-</div></div><div class="col-sidebar" tabindex="-1"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked=""><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open="" class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details" tabindex="-1"><a href="#homebridge-august"><span>Homebridge <wbr>August</span></a><ul><li><a href="#installation"><span>Installation</span></a></li><li><a href="#configuration"><span>Configuration</span></a></li><li><a href="#supported-august-devices"><span>Supported <wbr>August <wbr>Devices</span></a></li><li><a href="#troubleshooting"><span>Troubleshooting</span></a></li><li><ul><li><a href="#lock-is-detected-but-doesnt-appear-in-homekit"><span>Lock is detected but doesn't appear in <wbr>Home<wbr>Kit</span></a></li></ul></li><li><a href="#thanks"><span>Thanks</span></a></li></ul></div></details></div><div class="site-menu" tabindex="-1"><nav class="tsd-navigation"><a href="modules.html">@homebridge-plugins/homebridge-august</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"></ul></nav></div></div></div></main></body></html>
+</div></div><div class="col-sidebar" tabindex="-1"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked=""><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open="" class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details" tabindex="-1"><a href="#homebridge-august"><span>Homebridge <wbr>August</span></a><ul><li><a href="#installation"><span>Installation</span></a></li><li><a href="#configuration"><span>Configuration</span></a></li><li><a href="#supported-august-devices"><span>Supported <wbr>August <wbr>Devices</span></a></li><li><a href="#thanks"><span>Thanks</span></a></li></ul></div></details></div><div class="site-menu" tabindex="-1"><nav class="tsd-navigation"><a href="modules.html">@homebridge-plugins/homebridge-august</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"></ul></nav></div></div></div></main></body></html>

package/package.json

@@ -2,7 +2,7 @@
   "name": "@homebridge-plugins/homebridge-august",
   "displayName": "August",
   "type": "module",
-  "version": "3.0.4-beta.4",
+  "version": "3.0.4",
   "description": "The August plugin allows you to access your August & Yale device(s) from HomeKit.",
   "author": {
     "name": "donavanbecker",
@@ -88,4 +88,4 @@
     "typescript": "^5.8.2",
     "vitest": "^3.0.7"
   }
-}
+}

package/.github/npm-version-script-esm.js

@@ -1,97 +0,0 @@
-#!/bin/env node
-
-/**
- * This scripts queries the npm registry to pull out the latest version for a given tag.
- */
-
-import assert from 'node:assert'
-import child_process from 'node:child_process'
-import fs from 'node:fs'
-import process from 'node:process'
-
-const BRANCH_VERSION_PATTERN = /^([A-Z]+)-(\d+\.\d+\.\d+)$/i
-
-// Load the contents of the package.json file
-const packageJSON = JSON.parse(fs.readFileSync('package.json', 'utf8'))
-
-const refArgument = process.argv[2]
-const tagArgument = process.argv[3] || 'latest'
-
-if (!refArgument) {
-  console.error('ref argument is missing')
-  console.error('Usage: npm-version-script-esm.js <ref> [tag]')
-  process.exit(1)
-}
-
-/**
- * Queries the NPM registry for the latest version for the provided base version and tag.
- * If the tag is latest, then the base version is returned if it exists. For other tags, the latest
- * version found for that base version and tag is returned.
- * @param baseVersion The base version to query for, e.g. 2.0.0
- * @param tag The tag to query for, e.g. beta or latest
- * @returns {string} Returns the version, or '' if not found
- */
-function getTagVersionFromNpm(baseVersion, tag) {
-  try {
-    return JSON.parse(child_process.execSync(`npm info ${packageJSON.name} versions --json`).toString('utf8').trim())
-      .filter(v => tag === 'latest' ? v === baseVersion : v.startsWith(`${baseVersion}-${tag}.`)) // find all published versions for this base version and tag
-      .reduce((_, current) => current, '') // choose the last as they're sorted in ascending order, or '' if there are none
-  } catch (e) {
-    console.error(`Failed to query the npm registry for the latest version for tag: ${tag}`, e)
-    // throw e;
-    return ''
-  }
-}
-
-function desiredTargetVersion(ref) {
-  // ref is a GitHub action ref string
-  if (ref.startsWith('refs/pull/')) {
-    throw new Error('The version script was executed inside a PR!')
-  }
-
-  assert(ref.startsWith('refs/heads/'))
-  const branchName = ref.slice('refs/heads/'.length)
-
-  const results = branchName.match(BRANCH_VERSION_PATTERN)
-  if (results !== null) {
-    if (results[1] !== tagArgument) {
-      console.warn(`The base branch name (${results[1]}) differs from the tag name ${tagArgument}`)
-    }
-
-    return results[2]
-  }
-
-  throw new Error(`Malformed branch name for ref: ${ref}. Can't derive the base version. Use a branch name like: beta-x.x.x or alpha-x.x.x`)
-}
-
-// derive the base version from the branch ref
-const baseVersion = desiredTargetVersion(refArgument)
-
-// query the npm registry for the latest version of the provided tag name
-const latestReleasedVersion = getTagVersionFromNpm(baseVersion, tagArgument) // e.g. 0.7.0-beta.12
-
-let publishTag
-
-if (latestReleasedVersion) {
-  console.warn(`Latest published version for ${baseVersion} with tag ${tagArgument} is ${latestReleasedVersion}`)
-  publishTag = latestReleasedVersion // set this released beta or alpha to be incremented
-} else {
-  console.warn(`No published versions for ${baseVersion} with tag ${tagArgument}`)
-  publishTag = baseVersion // start off with a new beta or alpha version
-}
-
-if (packageJSON.version !== publishTag) {
-  // report the change for CI
-  console.warn(`Changing version in package.json from ${packageJSON.version} to ${publishTag}`)
-
-  // save the package.json
-  packageJSON.version = publishTag
-  fs.writeFileSync('package.json', JSON.stringify(packageJSON, null, 2))
-
-  // perform the same change to the package-lock.json
-  const packageLockJSON = JSON.parse(fs.readFileSync('package-lock.json', 'utf8'))
-  packageLockJSON.version = publishTag
-  fs.writeFileSync('package-lock.json', JSON.stringify(packageLockJSON, null, 2))
-} else {
-  console.warn(`Leaving version in package.json at ${packageJSON.version}`)
-}