v0.2.0

BREAD5940 · Oct 26, 2021 · 7ca046d · 7ca046d
1 parent b78d4f5
commit 7ca046d
Show file tree

Hide file tree

Showing 8 changed files with 107 additions and 23 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+### v0.2.0
+- Support TypeScript 4.4 and Node.js versions 16.x and 17.x
+- Add `StorageBackend#getMatchesByNumber` and support associating multiple `Match` objects with one match
+  - SQLite makes it difficult to drop constraints, so you'll need to migrate your data if you used the SQLite backend and want to store multiple scouted teams per match
+- Deprecate `StorageBackend#getMatchByNumber`
 ### v0.1.1
 - Fixed bugs with the JSON storage backend
 

diff --git a/docs/classes/InfiniteRecharge.ColorWheel.md b/docs/classes/InfiniteRecharge.ColorWheel.md
@@ -37,7 +37,7 @@ Represents the color wheel in Infinite Recharge
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `state` | ``null`` \| ``"SPECIFIC_COLOR"`` \| ``"ROTATED_X_TIMES"`` | - |
+| `state` | ``null`` \| `ColorWheelPosition` | - |
 | `cells?` | [`PowerCellTracker`](InfiniteRecharge.PowerCellTracker.md) | PowerCellTracker for validation |
 
 #### Overrides
@@ -66,7 +66,7 @@ ___
 
 ### state
 
-• **state**: ``null`` \| ``"SPECIFIC_COLOR"`` \| ``"ROTATED_X_TIMES"``
+• **state**: ``null`` \| `ColorWheelPosition`
 
 null = no special state
 

diff --git a/docs/classes/InfiniteRecharge.ShieldGenerator.md b/docs/classes/InfiniteRecharge.ShieldGenerator.md
@@ -42,8 +42,8 @@ construction owo
 
 | Name | Type |
 | :------ | :------ |
-| `hangingBots` | `HABLevel` |
-| `floorBots` | `HABLevel` |
+| `hangingBots` | `NumberOfBots` |
+| `floorBots` | `NumberOfBots` |
 | `isLevel` | `boolean` |
 
 #### Overrides
@@ -58,7 +58,7 @@ games/infinite-recharge.ts:115
 
 ### floorBots
 
-• **floorBots**: `HABLevel`
+• **floorBots**: `NumberOfBots`
 
 #### Defined in
 
@@ -68,7 +68,7 @@ ___
 
 ### hangingBots
 
-• **hangingBots**: `HABLevel`
+• **hangingBots**: `NumberOfBots`
 
 #### Defined in
 

diff --git a/docs/classes/JSONBackend.md b/docs/classes/JSONBackend.md
@@ -33,6 +33,7 @@ The directory structure is as follows:
 - [deleteMatchByNumber](JSONBackend.md#deletematchbynumber)
 - [deleteMatchesByTeam](JSONBackend.md#deletematchesbyteam)
 - [deleteTeam](JSONBackend.md#deleteteam)
+- [getMatchByNumber](JSONBackend.md#getmatchbynumber)
 - [getMatchesByNumber](JSONBackend.md#getmatchesbynumber)
 - [getMatchesByTeam](JSONBackend.md#getmatchesbyteam)
 - [getTeam](JSONBackend.md#getteam)
@@ -104,7 +105,7 @@ deletes a match by number
 
 #### Defined in
 
-storage/json.ts:116
+storage/json.ts:121
 
 ___
 
@@ -130,7 +131,7 @@ deletes all matches associated with a given team
 
 #### Defined in
 
-storage/json.ts:124
+storage/json.ts:129
 
 ___
 
@@ -157,7 +158,33 @@ deletes a team
 
 #### Defined in
 
-storage/json.ts:109
+storage/json.ts:114
+
+___
+
+### getMatchByNumber
+
+▸ **getMatchByNumber**(`number`): ``null`` \| [`Match`](Match.md)
+
+gets one match
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `number` | `number` |
+
+#### Returns
+
+``null`` \| [`Match`](Match.md)
+
+#### Implementation of
+
+[StorageBackend](../interfaces/StorageBackend.md).[getMatchByNumber](../interfaces/StorageBackend.md#getmatchbynumber)
+
+#### Defined in
+
+storage/json.ts:94
 
 ___
 
@@ -209,7 +236,7 @@ gets matches by team
 
 #### Defined in
 
-storage/json.ts:94
+storage/json.ts:99
 
 ___
 
@@ -325,4 +352,4 @@ String representation
 
 #### Defined in
 
-storage/json.ts:168
+storage/json.ts:173
diff --git a/docs/classes/SQLBackend.md b/docs/classes/SQLBackend.md
@@ -23,6 +23,7 @@ Stores teams and matches from various games in SQL.
 - [deleteMatchByNumber](SQLBackend.md#deletematchbynumber)
 - [deleteMatchesByTeam](SQLBackend.md#deletematchesbyteam)
 - [deleteTeam](SQLBackend.md#deleteteam)
+- [getMatchByNumber](SQLBackend.md#getmatchbynumber)
 - [getMatchesByNumber](SQLBackend.md#getmatchesbynumber)
 - [getMatchesByTeam](SQLBackend.md#getmatchesbyteam)
 - [getTeam](SQLBackend.md#getteam)
@@ -83,7 +84,7 @@ deletes a match
 
 #### Defined in
 
-storage/sqlite.ts:178
+storage/sqlite.ts:183
 
 ___
 
@@ -109,7 +110,7 @@ deletes matches
 
 #### Defined in
 
-storage/sqlite.ts:185
+storage/sqlite.ts:190
 
 ___
 
@@ -140,6 +141,32 @@ storage/sqlite.ts:136
 
 ___
 
+### getMatchByNumber
+
+▸ **getMatchByNumber**(`number`): ``null`` \| [`Match`](Match.md)
+
+gets one match
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `number` | `number` |
+
+#### Returns
+
+``null`` \| [`Match`](Match.md)
+
+#### Implementation of
+
+[StorageBackend](../interfaces/StorageBackend.md).[getMatchByNumber](../interfaces/StorageBackend.md#getmatchbynumber)
+
+#### Defined in
+
+storage/sqlite.ts:167
+
+___
+
 ### getMatchesByNumber
 
 ▸ **getMatchesByNumber**(`number`): [`Match`](Match.md)[]
@@ -188,7 +215,7 @@ gets matches
 
 #### Defined in
 
-storage/sqlite.ts:167
+storage/sqlite.ts:172
 
 ___
 
@@ -304,4 +331,4 @@ String representation
 
 #### Defined in
 
-storage/sqlite.ts:193
+storage/sqlite.ts:198
diff --git a/docs/classes/Team.md b/docs/classes/Team.md
@@ -132,7 +132,7 @@ Gets the median of any match property
 
 | Name | Type |
 | :------ | :------ |
-| `property` | ``"number"`` \| ``"teamNumber"`` \| ``"type"`` \| ``"alliance"`` \| ``"pieceTrackers"`` \| ``"fouls"`` \| ``"cards"`` \| ``"emergencyStopped"`` \| ``"borked"`` \| ``"nonPieceTrackerRankingPoints"`` \| ``"pointsFromFouls"`` \| ``"bonusPoints"`` \| ``"crossedStartLineInAuto"`` \| ``"points"`` \| ``"rankingPoints"`` |
+| `property` | keyof [`Match`](Match.md) |
 
 #### Returns
 

diff --git a/docs/interfaces/StorageBackend.md b/docs/interfaces/StorageBackend.md
@@ -14,6 +14,7 @@
 - [deleteMatchByNumber](StorageBackend.md#deletematchbynumber)
 - [deleteMatchesByTeam](StorageBackend.md#deletematchesbyteam)
 - [deleteTeam](StorageBackend.md#deleteteam)
+- [getMatchByNumber](StorageBackend.md#getmatchbynumber)
 - [getMatchesByNumber](StorageBackend.md#getmatchesbynumber)
 - [getMatchesByTeam](StorageBackend.md#getmatchesbyteam)
 - [getTeam](StorageBackend.md#getteam)
@@ -38,7 +39,7 @@
 
 #### Defined in
 
-storage/backend.ts:24
+storage/backend.ts:30
 
 ___
 
@@ -58,7 +59,7 @@ ___
 
 #### Defined in
 
-storage/backend.ts:25
+storage/backend.ts:31
 
 ___
 
@@ -83,6 +84,30 @@ storage/backend.ts:13
 
 ___
 
+### getMatchByNumber
+
+▸ **getMatchByNumber**(`number`): ``null`` \| [`Match`](../classes/Match.md)
+
+Get only one match from a given match number.
+
+**`deprecated`** Use getMatchesByNumber instead.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `number` | `number` |
+
+#### Returns
+
+``null`` \| [`Match`](../classes/Match.md)
+
+#### Defined in
+
+storage/backend.ts:23
+
+___
+
 ### getMatchesByNumber
 
 ▸ **getMatchesByNumber**(`number`): [`Match`](../classes/Match.md)[]
@@ -125,7 +150,7 @@ what we actually want.
 
 #### Defined in
 
-storage/backend.ts:23
+storage/backend.ts:29
 
 ___
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "frc-scouting",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "A TypeScript library for handling FRC scouting data from robotics tournaments.",
   "main": "built/index.js",
   "types": "built/index.d.ts",
@@ -11,7 +11,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/TheAnnalyst/frc-scouting.git"
+    "url": "git+https://github.com/BREAD5940/frc-scouting.git"
   },
   "keywords": [
     "frc",
@@ -21,9 +21,9 @@
   "author": "Annika",
   "license": "Apache-2.0",
   "bugs": {
-    "url": "https://github.com/TheAnnalyst/frc-scouting/issues"
+    "url": "https://github.com/BREAD5940/frc-scouting/issues"
   },
-  "homepage": "https://github.com/TheAnnalyst/frc-scouting#readme",
+  "homepage": "https://github.com/BREAD5940/frc-scouting#readme",
   "devDependencies": {
     "@types/jest": "^26.0.15",
     "@typescript-eslint/eslint-plugin": "^4.8.1",