Skip to content

Commit

Permalink
v1.0.2.
Browse files Browse the repository at this point in the history
  • Loading branch information
hjdhjd committed Mar 16, 2024
1 parent ea613dd commit a5ef7c4
Show file tree
Hide file tree
Showing 24 changed files with 336 additions and 333 deletions.
7 changes: 5 additions & 2 deletions docs/Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@

All notable changes to this project will be documented in this file. This project uses [semantic versioning](https://semver.org/).

## 1.0.2 (2024-03-16)
* Fix: more robust exception handling.

## 1.0.1 (2024-03-15)
* Housekeeping.

## 1.0.0 (2024-03-12)
* New feature: The UniFi Access controller property and API reply JSONs are now available.
* Improvement: The `unlock` API endpoint has been enhanced to allow for arbitrary time periods.
* New feature: the UniFi Access controller property and API reply JSONs are now available.
* Improvement: the `unlock` API endpoint has been enhanced to allow for arbitrary time periods.
* Housekeeping.

## 0.2.0 (2024-03-06)
Expand Down
36 changes: 18 additions & 18 deletions docs/classes/AccessApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ EventEmitter.constructor

#### Defined in

[src/access-api.ts:65](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-api.ts#L65)
[src/access-api.ts:65](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-api.ts#L65)

## Properties

Expand Down Expand Up @@ -248,7 +248,7 @@ Returns the bootstrap JSON if the Access controller has been bootstrapped, `null

#### Defined in

[src/access-api.ts:1028](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-api.ts#L1028)
[src/access-api.ts:1030](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-api.ts#L1030)

___

Expand All @@ -266,7 +266,7 @@ Returns the controller information JSON if the Access controller has been bootst

#### Defined in

[src/access-api.ts:1017](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-api.ts#L1017)
[src/access-api.ts:1019](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-api.ts#L1019)

___

Expand All @@ -284,7 +284,7 @@ Returns an array of all the devices from all the UniFi Access hubs associated wi

#### Defined in

[src/access-api.ts:1039](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-api.ts#L1039)
[src/access-api.ts:1041](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-api.ts#L1041)

___

Expand All @@ -302,7 +302,7 @@ Returns an array of all the doors from all the UniFi Access hubs associated with

#### Defined in

[src/access-api.ts:1050](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-api.ts#L1050)
[src/access-api.ts:1052](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-api.ts#L1052)

___

Expand All @@ -320,7 +320,7 @@ Returns an array of all the floors from all the UniFi Access hubs associated wit

#### Defined in

[src/access-api.ts:1061](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-api.ts#L1061)
[src/access-api.ts:1063](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-api.ts#L1063)

___

Expand All @@ -338,7 +338,7 @@ Returns `true` if the logged in user has administrative privileges, `false` othe

#### Defined in

[src/access-api.ts:1072](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-api.ts#L1072)
[src/access-api.ts:1074](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-api.ts#L1074)

___

Expand All @@ -357,7 +357,7 @@ Returns the Access controller name in the following format:

#### Defined in

[src/access-api.ts:1084](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-api.ts#L1084)
[src/access-api.ts:1086](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-api.ts#L1086)

## Methods

Expand Down Expand Up @@ -566,7 +566,7 @@ Valid API endpoints are `bootstrap`, `device`, `login`, `self`, and `websocket`.

#### Defined in

[src/access-api.ts:955](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-api.ts#L955)
[src/access-api.ts:957](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-api.ts#L957)

___

Expand Down Expand Up @@ -649,7 +649,7 @@ process.stdout.write(util.inspect(ufa.bootstrap, { colors: true, depth: null, so

#### Defined in

[src/access-api.ts:512](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-api.ts#L512)
[src/access-api.ts:514](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-api.ts#L514)

___

Expand Down Expand Up @@ -679,7 +679,7 @@ The example above assumed the `deviceInfo` parameter is set to `true`.

#### Defined in

[src/access-api.ts:672](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-api.ts#L672)
[src/access-api.ts:674](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-api.ts#L674)

___

Expand All @@ -704,7 +704,7 @@ Returns the Access device name in the following format:

#### Defined in

[src/access-api.ts:698](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-api.ts#L698)
[src/access-api.ts:700](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-api.ts#L700)

___

Expand Down Expand Up @@ -871,7 +871,7 @@ if(!(await ufa.login("access-controller.local", "username", "password"))) {

#### Defined in

[src/access-api.ts:152](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-api.ts#L152)
[src/access-api.ts:152](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-api.ts#L152)

___

Expand All @@ -887,7 +887,7 @@ Clear the login credentials and terminate any open connection to the UniFi Acces

#### Defined in

[src/access-api.ts:731](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-api.ts#L731)
[src/access-api.ts:733](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-api.ts#L733)

___

Expand Down Expand Up @@ -1369,7 +1369,7 @@ Terminate any open connection to the UniFi Access API.

#### Defined in

[src/access-api.ts:710](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-api.ts#L710)
[src/access-api.ts:712](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-api.ts#L712)

___

Expand Down Expand Up @@ -1400,7 +1400,7 @@ This method should be used when direct access to the Access controller is needed

#### Defined in

[src/access-api.ts:766](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-api.ts#L766)
[src/access-api.ts:768](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-api.ts#L768)

___

Expand Down Expand Up @@ -1465,7 +1465,7 @@ are `Infinity` - remain unlocked until reset, `0` - reset lock to secure state,

#### Defined in

[src/access-api.ts:530](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-api.ts#L530)
[src/access-api.ts:532](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-api.ts#L532)

___

Expand Down Expand Up @@ -1501,7 +1501,7 @@ Use this method to change the configuration of a given Access device or controll

#### Defined in

[src/access-api.ts:621](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-api.ts#L621)
[src/access-api.ts:623](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-api.ts#L623)

___

Expand Down
24 changes: 12 additions & 12 deletions docs/interfaces/AccessBootstrapConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

#### Defined in

[src/access-types.ts:71](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L71)
[src/access-types.ts:71](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L71)

___

Expand All @@ -37,7 +37,7 @@ ___

#### Defined in

[src/access-types.ts:72](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L72)
[src/access-types.ts:72](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L72)

___

Expand All @@ -47,7 +47,7 @@ ___

#### Defined in

[src/access-types.ts:73](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L73)
[src/access-types.ts:73](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L73)

___

Expand All @@ -57,7 +57,7 @@ ___

#### Defined in

[src/access-types.ts:74](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L74)
[src/access-types.ts:74](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L74)

___

Expand All @@ -67,7 +67,7 @@ ___

#### Defined in

[src/access-types.ts:75](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L75)
[src/access-types.ts:75](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L75)

___

Expand All @@ -77,7 +77,7 @@ ___

#### Defined in

[src/access-types.ts:76](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L76)
[src/access-types.ts:76](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L76)

___

Expand All @@ -87,7 +87,7 @@ ___

#### Defined in

[src/access-types.ts:77](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L77)
[src/access-types.ts:77](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L77)

___

Expand All @@ -97,7 +97,7 @@ ___

#### Defined in

[src/access-types.ts:78](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L78)
[src/access-types.ts:78](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L78)

___

Expand All @@ -107,7 +107,7 @@ ___

#### Defined in

[src/access-types.ts:79](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L79)
[src/access-types.ts:79](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L79)

___

Expand All @@ -117,7 +117,7 @@ ___

#### Defined in

[src/access-types.ts:80](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L80)
[src/access-types.ts:80](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L80)

___

Expand All @@ -127,7 +127,7 @@ ___

#### Defined in

[src/access-types.ts:82](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L82)
[src/access-types.ts:82](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L82)

___

Expand All @@ -137,4 +137,4 @@ ___

#### Defined in

[src/access-types.ts:81](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L81)
[src/access-types.ts:81](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L81)
24 changes: 12 additions & 12 deletions docs/interfaces/AccessBootstrapConfigInterface.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

#### Defined in

[src/access-types.ts:71](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L71)
[src/access-types.ts:71](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L71)

___

Expand All @@ -37,7 +37,7 @@ ___

#### Defined in

[src/access-types.ts:72](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L72)
[src/access-types.ts:72](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L72)

___

Expand All @@ -47,7 +47,7 @@ ___

#### Defined in

[src/access-types.ts:73](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L73)
[src/access-types.ts:73](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L73)

___

Expand All @@ -57,7 +57,7 @@ ___

#### Defined in

[src/access-types.ts:74](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L74)
[src/access-types.ts:74](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L74)

___

Expand All @@ -67,7 +67,7 @@ ___

#### Defined in

[src/access-types.ts:75](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L75)
[src/access-types.ts:75](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L75)

___

Expand All @@ -77,7 +77,7 @@ ___

#### Defined in

[src/access-types.ts:76](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L76)
[src/access-types.ts:76](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L76)

___

Expand All @@ -87,7 +87,7 @@ ___

#### Defined in

[src/access-types.ts:77](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L77)
[src/access-types.ts:77](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L77)

___

Expand All @@ -97,7 +97,7 @@ ___

#### Defined in

[src/access-types.ts:78](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L78)
[src/access-types.ts:78](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L78)

___

Expand All @@ -107,7 +107,7 @@ ___

#### Defined in

[src/access-types.ts:79](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L79)
[src/access-types.ts:79](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L79)

___

Expand All @@ -117,7 +117,7 @@ ___

#### Defined in

[src/access-types.ts:80](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L80)
[src/access-types.ts:80](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L80)

___

Expand All @@ -127,7 +127,7 @@ ___

#### Defined in

[src/access-types.ts:82](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L82)
[src/access-types.ts:82](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L82)

___

Expand All @@ -137,4 +137,4 @@ ___

#### Defined in

[src/access-types.ts:81](https://github.com/hjdhjd/unifi-access/blob/197fbda/src/access-types.ts#L81)
[src/access-types.ts:81](https://github.com/hjdhjd/unifi-access/blob/ea613dd/src/access-types.ts#L81)

0 comments on commit a5ef7c4

Please sign in to comment.