Class LocationDataService

constructor

• new LocationDataService(db): LocationDataService

• Parameters

  • db: Db

  Returns LocationDataService

createLocation

• createLocation(location): Promise<{
      id: string;
  }>

• Create location into database

  Parameters

  • location: CreateLocationDto

  Returns Promise<{
      id: string;
  }>

  Promise<{id: string}> id of created location record blocks-2055

deleteLocation

• deleteLocation(id): Promise<boolean>

• Delete the location by id. Also need to delete all the locations which location path contains the id. e.g. Assume, Prefecture A have children City X, City Y, and City X have Ward 1, Ward 2 if delete Prefecture A, City X, City Y, Ward 1, Ward 2 all deleted

  Parameters

  • id: string

    location Id to delete

  Returns Promise<boolean>

  true if deleted, false if delete failed blocks-2055

doesLocationExist

• doesLocationExist(id): Promise<boolean>

• Check if location exists

  Parameters

  • id: string

  Returns Promise<boolean>

  true if location exists, false if location not exist blocks-2055

getLocation

• getLocation(id): Promise<null | LocationEntity>

• Get location from database

  Parameters

  • id: string

  Returns Promise<null | LocationEntity>

  Promise<Location | undefined> Location data if fetched successfully, or null if data not found by id blocks-2055

getLocationTree

• getLocationTree(parentId, orderParams, paginationOptions): Promise<{
      count: number;
      limit?: number;
      nextToken?: string;
      previousToken?: string;
      result: LocationTree[];
      total: number;
  }>

• Return two layer location tree. Location object with a children property, which is a locationList

  Parameters

  • parentId: string

    parentId of a locationTreeList

  • orderParams: OrderParam<string>[]

  • paginationOptions: PaginationOptions

  Returns Promise<{
      count: number;
      limit?: number;
      nextToken?: string;
      previousToken?: string;
      result: LocationTree[];
      total: number;
  }>

  locationTree blocks-6a17

listPaginatedLocations

• listPaginatedLocations(opts): Promise<PaginatedFindResult<LocationEntity>>

• List paginated locations

  Parameters

  • opts: ParsedPaginatedListQuery

    paginated list query options

  Returns Promise<PaginatedFindResult<LocationEntity>>

  paginated locations list query result

normalizeLocationResponse

• normalizeLocationResponse(location): Promise<LocationResponse>

• Normalize location to response format

  Parameters

  • location: Location

  Returns Promise<LocationResponse>

  LocationResponse which aligns with the API docs format to return to frontend blocks-2055

normalizeLocationResponses

• normalizeLocationResponses(locations): Promise<LocationResponse[]>

• Normalize list of location responses

  Parameters

  • locations: Location[]

    location models

  Returns Promise<LocationResponse[]>

normalizeLocationTreeResponse

• normalizeLocationTreeResponse(location): Promise<LocationTreeResponse>

• Normalize location to response format

  Parameters

  • location: LocationTree

  Returns Promise<LocationTreeResponse>

  LocationResponse which aligns with the API docs format to return to frontend blocks-2055

normalizeLocationTreeResponses

• normalizeLocationTreeResponses(locations): Promise<LocationTreeResponse[]>

• Normalize list of location tree responses

  Parameters

  • locations: LocationTree[]

    location models

  Returns Promise<LocationTreeResponse[]>

updateLocation

• updateLocation(id, locationInfo): Promise<{
      id: string;
  }>

• Update location data. If location parentId is updated, all the location have this location id in path, will get updated.

  Parameters

  • id: string

    blocks-2055

  • locationInfo: Partial<Location>

  Returns Promise<{
      id: string;
  }>

Static Readonly COLLECTION_LOCATION

Static Readonly LOCATION_STATUS_ACTIVE