Class VaccineDataService

Implements iVaccineService, is used to apply logic to external APIs and internal databases/filestorage

Implements

iVaccineDataService

Index

Constructors

Methods

checkExistingVaccines compareExternalPDFs deleteVaccines downloadVaccinePDF getLocalPDFFilenames getProductIDs getVaccineJSONSHA getVaccineListRemote getVaccineListVersionLocal getVaccineListVersionRemote getVaccineSheets storeVaccineListLocal storeVaccineListVersionLocal updateLocalPDFFilenames vaccineQuery

Constructors

constructor

new VaccineDataService(): VaccineDataService
Returns VaccineDataService

Methods

checkExistingVaccines

checkExistingVaccines(vaccineList: VaccineInfoJSON[]): Promise<number[]>
Compares the local productIds with the remote and collects the ids which are no longer existing remotely. These are then returned to be deleted.
Parameters
- vaccineList: VaccineInfoJSON[]
  a list of VaccineInfoJSON objects to insert into the vaccine data table.
Returns Promise<number[]>
the productIds which exist locally and no longer remotely
- Defined in services/vaccineDataService.ts:290

compareExternalPDFs

compareExternalPDFs(): Promise<VaccinePDFData[]>
Compares the filenames of external and intneral PDFs to check for file changes/updates

Returns Promise<VaccinePDFData[]>
a promise containaing a list of data relating to externa, pdfs. This consists of the filenames of the external files as well as the local name comparisons
Implementation of iVaccineDataService.compareExternalPDFs
- Defined in services/vaccineDataService.ts:422

deleteVaccines

deleteVaccines(idsToRemove: number[]): Promise<void>
Deletes the vaccines corresponding to the given product ids from the database. The PDFs related to this id are also removed.
Parameters
- idsToRemove: number[]
  a list of product ids of the vaccines to remove.
Returns Promise<void>
Precondition
a table must exist on the VaccineEntity
- Defined in services/vaccineDataService.ts:318

downloadVaccinePDF

downloadVaccinePDF(productId: number, formatId: number): Promise<string>
This will take the provided ids and download the related pdf from the saskatchewn publications api
Parameters
- productId: number
  the Id of the vaccine being updated, used to build the path, cannot be zero, must exist in the database
- formatId: number
  the format id, this refers to the id of the english or french PDF, used to build the path cannot be 0
Returns Promise<string>
a promise containing a string, this string is the path to the pdf within the mobile device
Implementation of iVaccineDataService.downloadVaccinePDF
- Defined in services/vaccineDataService.ts:381

getLocalPDFFilenames

getLocalPDFFilenames(productId: number): Promise<default>
Retrieves the names of the local PDFs of both the english and french versions
Parameters
- productId: number
  the vaccine to check, a number greater than 0 and existing in the database
Returns Promise<default>
an promise containing an object with the english and french PDF names, both in the form of strings
- Defined in services/vaccineDataService.ts:499

getProductIDs

getProductIDs(): Promise<VaccineProduct[]>
Gets all of the SHA vaccine JSON ids as well as the ids for the language specific formats.

Returns Promise<VaccineProduct[]>
a list of all vaccine product ids and format ids.

Precondition
database must be initialized
- Defined in services/vaccineDataService.ts:111

getVaccineJSONSHA

getVaccineJSONSHA(): Promise<Response[]>
Gets the entire JSON sheet for each product ID from the Government of Saskatchewan publications api

Returns Promise<Response[]>
A list of responses in the form of the JSON received. It is much too large to warrant its own type

!! This is going to be removed, it is not needed and cannot test reliably !!
- Defined in services/vaccineDataService.ts:576

getVaccineListRemote

getVaccineListRemote(): Promise<VaccineListResponse>
Retrieves the remote vaccine list hosted as a JSON file

Returns Promise<VaccineListResponse>
a promise containing the updated vaccine list

Precondition
Internet connectivity must be present
Implementation of iVaccineDataService.getVaccineListRemote
- Defined in services/vaccineDataService.ts:227

getVaccineListVersionLocal

getVaccineListVersionLocal(): Promise<number>
Gets the local version of the Vaccine List. This version number is obtained from the vaccine list JSON endpoint and store in async storage

If the version number is not present in storage a -1 is returned to ensure that it is always less than the new version

Returns Promise<number>
A promise containing the version number. It is type casted as AsyncStorage can only store strings
Implementation of iVaccineDataService.getVaccineListVersionLocal
- Defined in services/vaccineDataService.ts:200

getVaccineListVersionRemote

getVaccineListVersionRemote(): Promise<number>
Gets the remote version of the Vaccine List. This version number is obtained from the vaccine list JSON endpoint and store in async storage

If the version number is not present in storage a -1 is returned to ensure that it is always less than the new version

Returns Promise<number>
A promise containing the version number.
- Defined in services/vaccineDataService.ts:126

getVaccineSheets

getVaccineSheets(language: "english" | "french"): Promise<VaccineSheet[]>
Gets a list of VaccineSheet object which contain the local vaccine information PDFs and other related info. Retrieves it in either english or french
Parameters
- language: "english" | "french"
  must be english or french, this is required
Returns Promise<VaccineSheet[]>
A promise containing a list of VaccineSheet objects
- Defined in services/vaccineDataService.ts:154

storeVaccineListLocal

storeVaccineListLocal(vaccineList: VaccineInfoJSON[]): Promise<void>
Stores the remote vaccine list locally, returns a promise
Parameters
- vaccineList: VaccineInfoJSON[]
  a list of VaccineInfoJSON objects to insert into the vaccine data table. This will also update and existing row if a row with the productId already exists.
Returns Promise<void>
a void promise
Implementation of iVaccineDataService.storeVaccineListLocal
- Defined in services/vaccineDataService.ts:257

storeVaccineListVersionLocal

storeVaccineListVersionLocal(version: number): Promise<void>
Stores the version of the Vaccine List. This version number is obtained from the vaccine list JSON endpoint
Parameters
- version: number
  a string representing the version number to set
Returns Promise<void>
Implementation of iVaccineDataService.storeVaccineListVersionLocal
- Defined in services/vaccineDataService.ts:183

updateLocalPDFFilenames

updateLocalPDFFilenames(
    productId: number,
    englishFilename?: string,
    frenchFilename?: string,
    englishFormatId?: number,
    frenchFormatId?: number,
): Promise<void>
Takes in a product id and potentially an english and french filename. Filenames that exist are updated in the row linked to the product Id
Parameters
- productId: number
  the id of the row to update, a vaccine entry This must be a positive number which already exists in the table.
- OptionalenglishFilename: string
  the new name of the remote vaccine pdf in english This must be a string.
- OptionalfrenchFilename: string
  the new name of the remote vaccine pdf in french This must be a string.
- OptionalenglishFormatId: number
- OptionalfrenchFormatId: number
Returns Promise<void>
A void promise.
Implementation of iVaccineDataService.updateLocalPDFFilenames
- Defined in services/vaccineDataService.ts:527

vaccineQuery

vaccineQuery(
    language?: "english" | "french",
    input?: string,
    searchColumn?: string,
    order?: {
        ascending: boolean;
        column: "vaccineName" | "associatedDiseases" | "starting";
    },
): Promise<VaccineQueryResult[]>
Builds and runs a query against the vaccine data table returning the filtered rows
Parameters
- language: "english" | "french" = "english"
  if a default language is not provided it will use english
- Optionalinput: string
  if not given it will return all results,
- OptionalsearchColumn: string
  search by a specific column
- Optionalorder: {
  ascending: boolean;
  column: "vaccineName" | "associatedDiseases" | "starting";
  }
  if not given the default orfer will be given
Returns Promise<VaccineQueryResult[]>
Implementation of iVaccineDataService.vaccineQuery
- Defined in services/vaccineDataService.ts:46

Class VaccineDataService

Implements

Index

Constructors

Methods

Constructors

constructor

Returns VaccineDataService

Methods

checkExistingVaccines

Parameters

Returns Promise<number[]>

compareExternalPDFs

Returns Promise<VaccinePDFData[]>

deleteVaccines

Parameters

Returns Promise<void>

Precondition

downloadVaccinePDF

Parameters

Returns Promise<string>

getLocalPDFFilenames

Parameters

Returns Promise<default>

getProductIDs

Returns Promise<VaccineProduct[]>

Precondition

getVaccineJSONSHA

Returns Promise<Response[]>

getVaccineListRemote

Returns Promise<VaccineListResponse>

Precondition

getVaccineListVersionLocal

Returns Promise<number>

getVaccineListVersionRemote

Returns Promise<number>

getVaccineSheets

Parameters

Returns Promise<VaccineSheet[]>

storeVaccineListLocal

Parameters

Returns Promise<void>

storeVaccineListVersionLocal

Parameters

Returns Promise<void>

updateLocalPDFFilenames

Parameters

Returns Promise<void>

vaccineQuery

Parameters

Returns Promise<VaccineQueryResult[]>

Settings

On This Page