v0.3.0

BREAD5940 · Nov 6, 2021 · d1b8a2a · d1b8a2a
1 parent a3a8a43
commit d1b8a2a
Show file tree

Hide file tree

Showing 26 changed files with 56 additions and 289 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changelog
 
+### v0.3.0
+- Teams no longer have their own SQL table; you will need to `DROP COLUMN associated_team` on your `matches` tables if you use SQLite as a backend.
+  - Many methods that work with teams have been removed; instead, manipulate matches.
+- The JSON backend is no longer supported; it may work but should not be relied upon in production. SQLite is simple enough to install and set up that it should not present a barrier to usage
+- As per the [semver specification](https://semver.org/), "[the] major version zero (0.y.z) is for initial development ... [t]he public API SHOULD NOT be considered stable." Thus, this **breaking change** does not necessitate a v1 release.
+- `StorageBackend#getMatchByNumber` has been removed.
+
 ### 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

diff --git a/docs/README.md b/docs/README.md
@@ -1,4 +1,4 @@
-frc-scouting / [Exports](modules.md)
+@bread5940/frc-scouting / [Exports](modules.md)
 
 # frc-scouting
 ![tests](https://github.com/TheAnnalyst/frc-scouting/workflows/tests/badge.svg?branch=main) [![coverage](https://codecov.io/gh/TheAnnalyst/frc-scouting/branch/main/graph/badge.svg?token=AL02Q8BYwp)](https://codecov.io/gh/TheAnnalyst/frc-scouting) [![npm version](https://badge.fury.io/js/frc-scouting.svg)](https://badge.fury.io/js/frc-scouting)

diff --git a/docs/classes/DeepSpace.CargoTracker.md b/docs/classes/DeepSpace.CargoTracker.md
@@ -1,4 +1,4 @@
-[frc-scouting](../README.md) / [Exports](../modules.md) / [DeepSpace](../modules/DeepSpace.md) / CargoTracker
+[@bread5940/frc-scouting](../README.md) / [Exports](../modules.md) / [DeepSpace](../modules/DeepSpace.md) / CargoTracker
 
 # Class: CargoTracker
 

diff --git a/docs/classes/DeepSpace.DeepSpaceJSON.md b/docs/classes/DeepSpace.DeepSpaceJSON.md
@@ -1,4 +1,4 @@
-[frc-scouting](../README.md) / [Exports](../modules.md) / [DeepSpace](../modules/DeepSpace.md) / DeepSpaceJSON
+[@bread5940/frc-scouting](../README.md) / [Exports](../modules.md) / [DeepSpace](../modules/DeepSpace.md) / DeepSpaceJSON
 
 # Class: DeepSpaceJSON
 
@@ -51,7 +51,7 @@ Checks if this storage plan applies
 
 #### Defined in
 
-games/deep-space.ts:288
+games/deep-space.ts:278
 
 ___
 
@@ -77,4 +77,4 @@ JSON => Match
 
 #### Defined in
 
-games/deep-space.ts:295
+games/deep-space.ts:285
diff --git a/docs/classes/DeepSpace.DeepSpaceMatch.md b/docs/classes/DeepSpace.DeepSpaceMatch.md
@@ -1,4 +1,4 @@
-[frc-scouting](../README.md) / [Exports](../modules.md) / [DeepSpace](../modules/DeepSpace.md) / DeepSpaceMatch
+[@bread5940/frc-scouting](../README.md) / [Exports](../modules.md) / [DeepSpace](../modules/DeepSpace.md) / DeepSpaceMatch
 
 # Class: DeepSpaceMatch
 

diff --git a/docs/classes/DeepSpace.DeepSpaceSQL.md b/docs/classes/DeepSpace.DeepSpaceSQL.md
@@ -1,4 +1,4 @@
-[frc-scouting](../README.md) / [Exports](../modules.md) / [DeepSpace](../modules/DeepSpace.md) / DeepSpaceSQL
+[@bread5940/frc-scouting](../README.md) / [Exports](../modules.md) / [DeepSpace](../modules/DeepSpace.md) / DeepSpaceSQL
 
 # Class: DeepSpaceSQL
 
@@ -30,12 +30,9 @@ Stores Deep Space teams/matches in SQLite
 - [dbDataToMatch](DeepSpace.DeepSpaceSQL.md#dbdatatomatch)
 - [dbDataToTeam](DeepSpace.DeepSpaceSQL.md#dbdatatoteam)
 - [deleteMatches](DeepSpace.DeepSpaceSQL.md#deletematches)
-- [deleteTeams](DeepSpace.DeepSpaceSQL.md#deleteteams)
 - [getMatches](DeepSpace.DeepSpaceSQL.md#getmatches)
 - [getStatement](DeepSpace.DeepSpaceSQL.md#getstatement)
-- [getTeams](DeepSpace.DeepSpaceSQL.md#getteams)
 - [insertMatch](DeepSpace.DeepSpaceSQL.md#insertmatch)
-- [insertTeam](DeepSpace.DeepSpaceSQL.md#insertteam)
 
 ## Constructors
 
@@ -203,32 +200,6 @@ storage/sqlite.ts:63
 
 ___
 
-### deleteTeams
-
-▸ **deleteTeams**(`conditions`): `void`
-
-deletes teams
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `conditions` | { `column`: `string` ; `value`: `string` \| `number`  }[] |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[SQLStoragePlan](SQLStoragePlan.md).[deleteTeams](SQLStoragePlan.md#deleteteams)
-
-#### Defined in
-
-storage/sqlite.ts:80
-
-___
-
 ### getMatches
 
 ▸ **getMatches**(`conditions`): [`DeepSpaceMatch`](DeepSpace.DeepSpaceMatch.md)[]
@@ -281,32 +252,6 @@ storage/sqlite.ts:38
 
 ___
 
-### getTeams
-
-▸ **getTeams**(`conditions`): [`Team`](Team.md)<[`DeepSpaceMatch`](DeepSpace.DeepSpaceMatch.md)\>[]
-
-gets teams
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `conditions` | { `column`: `string` ; `value`: `string` \| `number`  }[] |
-
-#### Returns
-
-[`Team`](Team.md)<[`DeepSpaceMatch`](DeepSpace.DeepSpaceMatch.md)\>[]
-
-#### Inherited from
-
-[SQLStoragePlan](SQLStoragePlan.md).[getTeams](SQLStoragePlan.md#getteams)
-
-#### Defined in
-
-storage/sqlite.ts:73
-
-___
-
 ### insertMatch
 
 ▸ **insertMatch**(`match`): `void`
@@ -330,29 +275,3 @@ Inserts a match
 #### Defined in
 
 games/deep-space.ts:270
-
-___
-
-### insertTeam
-
-▸ **insertTeam**(`team`): `void`
-
-Inserts a team
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `team` | [`Team`](Team.md)<[`DeepSpaceMatch`](DeepSpace.DeepSpaceMatch.md)\> |
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-[SQLStoragePlan](SQLStoragePlan.md).[insertTeam](SQLStoragePlan.md#insertteam)
-
-#### Defined in
-
-games/deep-space.ts:275
diff --git a/docs/classes/DeepSpace.HatchPanelTracker.md b/docs/classes/DeepSpace.HatchPanelTracker.md
@@ -1,4 +1,4 @@
-[frc-scouting](../README.md) / [Exports](../modules.md) / [DeepSpace](../modules/DeepSpace.md) / HatchPanelTracker
+[@bread5940/frc-scouting](../README.md) / [Exports](../modules.md) / [DeepSpace](../modules/DeepSpace.md) / HatchPanelTracker
 
 # Class: HatchPanelTracker
 

diff --git a/docs/classes/GamePieceTracker.md b/docs/classes/GamePieceTracker.md
@@ -1,4 +1,4 @@
-[frc-scouting](../README.md) / [Exports](../modules.md) / GamePieceTracker
+[@bread5940/frc-scouting](../README.md) / [Exports](../modules.md) / GamePieceTracker
 
 # Class: GamePieceTracker
 

diff --git a/docs/classes/InfiniteRecharge.ColorWheel.md b/docs/classes/InfiniteRecharge.ColorWheel.md
@@ -1,4 +1,4 @@
-[frc-scouting](../README.md) / [Exports](../modules.md) / [InfiniteRecharge](../modules/InfiniteRecharge.md) / ColorWheel
+[@bread5940/frc-scouting](../README.md) / [Exports](../modules.md) / [InfiniteRecharge](../modules/InfiniteRecharge.md) / ColorWheel
 
 # Class: ColorWheel
 

diff --git a/docs/classes/InfiniteRecharge.InfiniteRechargeJSON.md b/docs/classes/InfiniteRecharge.InfiniteRechargeJSON.md
@@ -1,4 +1,4 @@
-[frc-scouting](../README.md) / [Exports](../modules.md) / [InfiniteRecharge](../modules/InfiniteRecharge.md) / InfiniteRechargeJSON
+[@bread5940/frc-scouting](../README.md) / [Exports](../modules.md) / [InfiniteRecharge](../modules/InfiniteRecharge.md) / InfiniteRechargeJSON
 
 # Class: InfiniteRechargeJSON
 
@@ -51,7 +51,7 @@ Checks if it applies
 
 #### Defined in
 
-games/infinite-recharge.ts:328
+games/infinite-recharge.ts:319
 
 ___
 
@@ -77,4 +77,4 @@ JSON => match
 
 #### Defined in
 
-games/infinite-recharge.ts:337
+games/infinite-recharge.ts:328
diff --git a/docs/classes/InfiniteRecharge.InfiniteRechargeMatch.md b/docs/classes/InfiniteRecharge.InfiniteRechargeMatch.md
@@ -1,4 +1,4 @@
-[frc-scouting](../README.md) / [Exports](../modules.md) / [InfiniteRecharge](../modules/InfiniteRecharge.md) / InfiniteRechargeMatch
+[@bread5940/frc-scouting](../README.md) / [Exports](../modules.md) / [InfiniteRecharge](../modules/InfiniteRecharge.md) / InfiniteRechargeMatch
 
 # Class: InfiniteRechargeMatch
 

diff --git a/docs/classes/InfiniteRecharge.InfiniteRechargeSQL.md b/docs/classes/InfiniteRecharge.InfiniteRechargeSQL.md
@@ -1,4 +1,4 @@
-[frc-scouting](../README.md) / [Exports](../modules.md) / [InfiniteRecharge](../modules/InfiniteRecharge.md) / InfiniteRechargeSQL
+[@bread5940/frc-scouting](../README.md) / [Exports](../modules.md) / [InfiniteRecharge](../modules/InfiniteRecharge.md) / InfiniteRechargeSQL
 
 # Class: InfiniteRechargeSQL
 
@@ -30,12 +30,9 @@ Stores Infinite Recharge teams/matches in SQL
 - [dbDataToMatch](InfiniteRecharge.InfiniteRechargeSQL.md#dbdatatomatch)
 - [dbDataToTeam](InfiniteRecharge.InfiniteRechargeSQL.md#dbdatatoteam)
 - [deleteMatches](InfiniteRecharge.InfiniteRechargeSQL.md#deletematches)
-- [deleteTeams](InfiniteRecharge.InfiniteRechargeSQL.md#deleteteams)
 - [getMatches](InfiniteRecharge.InfiniteRechargeSQL.md#getmatches)
 - [getStatement](InfiniteRecharge.InfiniteRechargeSQL.md#getstatement)
-- [getTeams](InfiniteRecharge.InfiniteRechargeSQL.md#getteams)
 - [insertMatch](InfiniteRecharge.InfiniteRechargeSQL.md#insertmatch)
-- [insertTeam](InfiniteRecharge.InfiniteRechargeSQL.md#insertteam)
 
 ## Constructors
 
@@ -203,32 +200,6 @@ storage/sqlite.ts:63
 
 ___
 
-### deleteTeams
-
-▸ **deleteTeams**(`conditions`): `void`
-
-deletes teams
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `conditions` | { `column`: `string` ; `value`: `string` \| `number`  }[] |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[SQLStoragePlan](SQLStoragePlan.md).[deleteTeams](SQLStoragePlan.md#deleteteams)
-
-#### Defined in
-
-storage/sqlite.ts:80
-
-___
-
 ### getMatches
 
 ▸ **getMatches**(`conditions`): [`InfiniteRechargeMatch`](InfiniteRecharge.InfiniteRechargeMatch.md)[]
@@ -281,32 +252,6 @@ storage/sqlite.ts:38
 
 ___
 
-### getTeams
-
-▸ **getTeams**(`conditions`): [`Team`](Team.md)<[`InfiniteRechargeMatch`](InfiniteRecharge.InfiniteRechargeMatch.md)\>[]
-
-gets teams
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `conditions` | { `column`: `string` ; `value`: `string` \| `number`  }[] |
-
-#### Returns
-
-[`Team`](Team.md)<[`InfiniteRechargeMatch`](InfiniteRecharge.InfiniteRechargeMatch.md)\>[]
-
-#### Inherited from
-
-[SQLStoragePlan](SQLStoragePlan.md).[getTeams](SQLStoragePlan.md#getteams)
-
-#### Defined in
-
-storage/sqlite.ts:73
-
-___
-
 ### insertMatch
 
 ▸ **insertMatch**(`match`): `void`
@@ -330,29 +275,3 @@ Inserts a match
 #### Defined in
 
 games/infinite-recharge.ts:269
-
-___
-
-### insertTeam
-
-▸ **insertTeam**(`team`): `void`
-
-Inserts a team
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `team` | [`Team`](Team.md)<[`InfiniteRechargeMatch`](InfiniteRecharge.InfiniteRechargeMatch.md)\> |
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-[SQLStoragePlan](SQLStoragePlan.md).[insertTeam](SQLStoragePlan.md#insertteam)
-
-#### Defined in
-
-games/infinite-recharge.ts:274
diff --git a/docs/classes/InfiniteRecharge.PowerCellTracker.md b/docs/classes/InfiniteRecharge.PowerCellTracker.md
@@ -1,4 +1,4 @@
-[frc-scouting](../README.md) / [Exports](../modules.md) / [InfiniteRecharge](../modules/InfiniteRecharge.md) / PowerCellTracker
+[@bread5940/frc-scouting](../README.md) / [Exports](../modules.md) / [InfiniteRecharge](../modules/InfiniteRecharge.md) / PowerCellTracker
 
 # Class: PowerCellTracker
 

diff --git a/docs/classes/InfiniteRecharge.ShieldGenerator.md b/docs/classes/InfiniteRecharge.ShieldGenerator.md
@@ -1,4 +1,4 @@
-[frc-scouting](../README.md) / [Exports](../modules.md) / [InfiniteRecharge](../modules/InfiniteRecharge.md) / ShieldGenerator
+[@bread5940/frc-scouting](../README.md) / [Exports](../modules.md) / [InfiniteRecharge](../modules/InfiniteRecharge.md) / ShieldGenerator
 
 # Class: ShieldGenerator
 

diff --git a/docs/classes/JSONBackend.md b/docs/classes/JSONBackend.md
@@ -1,4 +1,4 @@
-[frc-scouting](../README.md) / [Exports](../modules.md) / JSONBackend
+[@bread5940/frc-scouting](../README.md) / [Exports](../modules.md) / JSONBackend
 
 # Class: JSONBackend
 

diff --git a/docs/classes/Match.md b/docs/classes/Match.md
@@ -1,4 +1,4 @@
-[frc-scouting](../README.md) / [Exports](../modules.md) / Match
+[@bread5940/frc-scouting](../README.md) / [Exports](../modules.md) / Match
 
 # Class: Match