Interface TripsRepository

interface TripsRepository {
    modelName: string;
    countDocuments(query?: FilterQuery<models.trips.Trip>): Promise<number>;
    create(entity: models.trips.Trip): Promise<Saved<models.trips.Trip>>;
    createMany(
        entity: models.trips.Trip[],
        options?: CreateManyOptions,
    ): Promise<string[]>;
    deleteById(id: string): Promise<null | Saved<models.trips.Trip>>;
    destroyById(id: string): Promise<null | Saved<models.trips.Trip>>;
    findById(
        id: string,
        fields?: SelectQuery<models.trips.Trip>[],
        ListQueryOptions?: ListQueryOptions<models.trips.Trip>,
    ): Promise<null | Saved<models.trips.Trip>>;
    findOne(
        query?: FilterQuery<models.trips.Trip>,
        fields?: SelectQuery<models.trips.Trip>[],
        ListQueryOptions?: ListQueryOptions<models.trips.Trip>,
    ): Promise<null | Saved<models.trips.Trip>>;
    list(
        query?: FilterQuery<models.trips.Trip>,
        fields?: SelectQuery<models.trips.Trip>[],
        ListQueryOptions?: ListQueryOptions<models.trips.Trip>,
    ): Promise<Saved<models.trips.Trip>[]>;
    listTripsForGuide(
        tripFilterQuery?: FilterQuery<models.trips.Trip>,
        sortOptions?: SortOptions<models.trips.Trip>,
    ): Promise<SavedTrip[]>;
    listTripsForHost(
        tripFilterQuery?: FilterQuery<models.trips.Trip>,
        sortOptions?: SortOptions<models.trips.Trip>,
    ): Promise<SavedTrip[]>;
    listTripsForTraveler(
        travelerFilterQuery?: FilterQuery<models.travelers.Traveler>,
        bookingFilterQuery?: FilterQuery<
            Required<Omit<BaseBooking, bookingFieldToOmit>>,
        >,
        tripFilterQuery?: FilterQuery<models.trips.Trip>,
        sortOptions?: SortOptions<models.trips.Trip>,
    ): Promise<SavedTrip[]>;
    listTripsToLaunch(
        minLaunchDate: Date,
        maxLaunchDate: Date,
    ): Promise<SavedTrip[]>;
    paginate(
        options?: PaginateQueryOptions<models.trips.Trip>,
    ): Promise<PaginationResponse<Saved<models.trips.Trip>>>;
    updateById(
        id: string,
        entity: PartialQuery<models.trips.Trip>,
        options?: UpdateOptions,
    ): Promise<null | Saved<models.trips.Trip>>;
    updateMany(
        filter: FilterQuery<models.trips.Trip>,
        update: PartialQuery<models.trips.Trip>,
    ): Promise<number>;
    updateOne(
        filter: FilterQuery<models.trips.Trip>,
        update: PartialQuery<models.trips.Trip>,
        options?: UpdateOneOptions,
    ): Promise<null | Saved<models.trips.Trip>>;
    upsertOne(
        filter: FilterQuery<models.trips.Trip>,
        entity: PartialQuery<models.trips.Trip>,
    ): Promise<null | string>;
    useView(name: keyof TripViewMappings): ViewRepo<FinancialTrip | SavedTrip>;
}

Hierarchy (View Summary)

BaseRepo<Trip>
UseView<TripViewMappings>
- TripsRepository

Index

Properties

modelName

Methods

countDocuments create createMany deleteById destroyById findById findOne list listTripsForGuide listTripsForHost listTripsForTraveler listTripsToLaunch paginate updateById updateMany updateOne upsertOne useView

Properties

modelName

modelName: string

The name of the model.

Methods

countDocuments

countDocuments(query?: FilterQuery<models.trips.Trip>): Promise<number>
Count the number of documents matching the query.
Parameters
- Optionalquery: FilterQuery<models.trips.Trip>
Returns Promise<number>
- A promise that resolves to the count of matching documents.
Inherited from BaseRepo.countDocuments
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:40

create

create(entity: models.trips.Trip): Promise<Saved<models.trips.Trip>>
Create a new entity.
Parameters
- entity: models.trips.Trip
  The entity to create.
Returns Promise<Saved<models.trips.Trip>>
- A promise that resolves to the saved entity.
Inherited from BaseRepo.create
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:27

createMany

createMany(
entity: models.trips.Trip[],
options?: CreateManyOptions,
): Promise<string[]>
Create multiple entities.
Parameters
- entity: models.trips.Trip[]
  An array of entities to create.
- Optionaloptions: CreateManyOptions
Returns Promise<string[]>
- A promise that resolves to an array of created entity IDs.
Inherited from BaseRepo.createMany
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:34

deleteById

deleteById(id: string): Promise<null | Saved<models.trips.Trip>>
Soft delete an entity by its ID. This operation marks the entity as deleted without permanently destroying the record.
Parameters
- id: string
  The ID of the entity to delete. @returns- A promise that resolves to the deleted entity or null if not found.
Returns Promise<null | Saved<models.trips.Trip>>
Inherited from BaseRepo.deleteById
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:47

destroyById

destroyById(id: string): Promise<null | Saved<models.trips.Trip>>
Destroy an entity by its ID (permanently deletes it).
Parameters
- id: string
  The ID of the entity to destroy.
Returns Promise<null | Saved<models.trips.Trip>>
- A promise that resolves to the destroyed entity or null if not found.
Inherited from BaseRepo.destroyById
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:53

findById

findById(
    id: string,
    fields?: SelectQuery<models.trips.Trip>[],
    ListQueryOptions?: ListQueryOptions<models.trips.Trip>,
): Promise<null | Saved<models.trips.Trip>>
Find an entity by its ID.
Parameters
- id: string
  The ID of the entity to find.
- Optionalfields: SelectQuery<models.trips.Trip>[]
  Fields to select in the returned entity.
- OptionalListQueryOptions: ListQueryOptions<models.trips.Trip>
  Options for listing queries.
Returns Promise<null | Saved<models.trips.Trip>>
- A promise that resolves to the found entity or null if not found.
Inherited from BaseRepo.findById
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:61

findOne

findOne(
    query?: FilterQuery<models.trips.Trip>,
    fields?: SelectQuery<models.trips.Trip>[],
    ListQueryOptions?: ListQueryOptions<models.trips.Trip>,
): Promise<null | Saved<models.trips.Trip>>
Find one entity matching the query.
Parameters
- Optionalquery: FilterQuery<models.trips.Trip>
- Optionalfields: SelectQuery<models.trips.Trip>[]
- OptionalListQueryOptions: ListQueryOptions<models.trips.Trip>
Returns Promise<null | Saved<models.trips.Trip>>
- A promise that resolves to the found entity or null if not found.
Inherited from BaseRepo.findOne
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:73

list

list(
    query?: FilterQuery<models.trips.Trip>,
    fields?: SelectQuery<models.trips.Trip>[],
    ListQueryOptions?: ListQueryOptions<models.trips.Trip>,
): Promise<Saved<models.trips.Trip>[]>
List entities matching the query.
Parameters
- Optionalquery: FilterQuery<models.trips.Trip>
  The query to filter documents.
- Optionalfields: SelectQuery<models.trips.Trip>[]
  Fields to select in the returned entities.
- OptionalListQueryOptions: ListQueryOptions<models.trips.Trip>
  Options for listing queries.
Returns Promise<Saved<models.trips.Trip>[]>
- A promise that resolves to an array of found entities.
Inherited from BaseRepo.list
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:85

listTripsForGuide

listTripsForGuide(
tripFilterQuery?: FilterQuery<models.trips.Trip>,
sortOptions?: SortOptions<models.trips.Trip>,
): Promise<SavedTrip[]>
Returns trips for a guide
Parameters
- OptionaltripFilterQuery: FilterQuery<models.trips.Trip>
  trip filter params.
- OptionalsortOptions: SortOptions<models.trips.Trip>
Returns Promise<SavedTrip[]>
trips for a guide.
- Defined in packages/data-access/src/repositories/TripsRepo/TripsRepo.types.ts:51

listTripsForHost

listTripsForHost(
tripFilterQuery?: FilterQuery<models.trips.Trip>,
sortOptions?: SortOptions<models.trips.Trip>,
): Promise<SavedTrip[]>
Returns trips for a host.
Parameters
- OptionaltripFilterQuery: FilterQuery<models.trips.Trip>
  trip filter params.
- OptionalsortOptions: SortOptions<models.trips.Trip>
Returns Promise<SavedTrip[]>
trips for a host.
- Defined in packages/data-access/src/repositories/TripsRepo/TripsRepo.types.ts:29

listTripsForTraveler

listTripsForTraveler(
    travelerFilterQuery?: FilterQuery<models.travelers.Traveler>,
    bookingFilterQuery?: FilterQuery<
        Required<Omit<BaseBooking, bookingFieldToOmit>>,
    >,
    tripFilterQuery?: FilterQuery<models.trips.Trip>,
    sortOptions?: SortOptions<models.trips.Trip>,
): Promise<SavedTrip[]>
Returns trips for a traveler
Parameters
- OptionaltravelerFilterQuery: FilterQuery<models.travelers.Traveler>
  traveler filter params.
- OptionalbookingFilterQuery: FilterQuery<Required<Omit<BaseBooking, bookingFieldToOmit>>>
  booking filter params.
- OptionaltripFilterQuery: FilterQuery<models.trips.Trip>
  trip filter params.
- OptionalsortOptions: SortOptions<models.trips.Trip>
Returns Promise<SavedTrip[]>
trips for a traveler.
- Defined in packages/data-access/src/repositories/TripsRepo/TripsRepo.types.ts:40

listTripsToLaunch

listTripsToLaunch(
minLaunchDate: Date,
maxLaunchDate: Date,
): Promise<SavedTrip[]>
Returns trips within the specified date range for launching
Parameters
- minLaunchDate: Date
  The minimum launch date for the trips, exclusive.
- maxLaunchDate: Date
  The maximum launch date for the trips, inclusive.
Returns Promise<SavedTrip[]>
- Defined in packages/data-access/src/repositories/TripsRepo/TripsRepo.types.ts:61

paginate

paginate(
options?: PaginateQueryOptions<models.trips.Trip>,
): Promise<PaginationResponse<Saved<models.trips.Trip>>>
Retrieve paginated results. Only intended for use with the admin portal for performance reasons.
Parameters
- Optionaloptions: PaginateQueryOptions<models.trips.Trip>
  The pagination options
Returns Promise<PaginationResponse<Saved<models.trips.Trip>>>
Inherited from BaseRepo.paginate
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:94

updateById

updateById(
    id: string,
    entity: PartialQuery<models.trips.Trip>,
    options?: UpdateOptions,
): Promise<null | Saved<models.trips.Trip>>
Update an entity by its ID.
Parameters
- id: string
  The ID of the entity to update.
- entity: PartialQuery<models.trips.Trip>
  The partial entity to update.
- Optionaloptions: UpdateOptions
Returns Promise<null | Saved<models.trips.Trip>>
- A promise that resolves to the updated entity or null if not found.
Inherited from BaseRepo.updateById
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:104

updateMany

updateMany(
filter: FilterQuery<models.trips.Trip>,
update: PartialQuery<models.trips.Trip>,
): Promise<number>
Update multiple entities matching the filter.
Parameters
- filter: FilterQuery<models.trips.Trip>
  The filter to match documents.
- update: PartialQuery<models.trips.Trip>
  The partial update to apply.
Returns Promise<number>
- A promise that resolves to the number of documents updated.
Inherited from BaseRepo.updateMany
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:115

updateOne

updateOne(
    filter: FilterQuery<models.trips.Trip>,
    update: PartialQuery<models.trips.Trip>,
    options?: UpdateOneOptions,
): Promise<null | Saved<models.trips.Trip>>
Update a single entity matching the filter.
Parameters
- filter: FilterQuery<models.trips.Trip>
  The filter to match documents.
- update: PartialQuery<models.trips.Trip>
  The partial update to apply.
- Optionaloptions: UpdateOneOptions
  Options for updating a single document.
Returns Promise<null | Saved<models.trips.Trip>>
| null>} - A promise that resolves to the updated entity or null if not found.
Inherited from BaseRepo.updateOne
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:126

upsertOne

upsertOne(
filter: FilterQuery<models.trips.Trip>,
entity: PartialQuery<models.trips.Trip>,
): Promise<null | string>
Upsert a single record based on certain criteria.
Parameters
- filter: FilterQuery<models.trips.Trip>
  The filter to find the record to update or insert.
- entity: PartialQuery<models.trips.Trip>
  The entity to upsert.
Returns Promise<null | string>
The return types of this method align with the MongoDB UpdateResult interface
- Returns models.baseModel.Saved<T>['_id'] if the document did not exist (an upsert took place).
- Returns null if the document did exist before the upsert operation.
Inherited from BaseRepo.upsertOne
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:140

useView

useView(name: keyof TripViewMappings): ViewRepo<FinancialTrip | SavedTrip>
Parameters
- name: keyof TripViewMappings
Returns ViewRepo<FinancialTrip | SavedTrip>
Inherited from UseView.useView
- Defined in packages/data-access/src/repositories/baseRepo/ViewRepo.types.ts:29

Interface TripsRepository

Hierarchy (View Summary)

Index

Properties

Methods

Properties

modelName

Methods

countDocuments

Parameters

Returns Promise<number>

create

Parameters

Returns Promise<Saved<models.trips.Trip>>

createMany

Parameters

Returns Promise<string[]>

deleteById

Parameters

Returns Promise<null | Saved<models.trips.Trip>>

destroyById

Parameters

Returns Promise<null | Saved<models.trips.Trip>>

findById

Parameters

Returns Promise<null | Saved<models.trips.Trip>>

findOne

Parameters

Returns Promise<null | Saved<models.trips.Trip>>

list

Parameters

Returns Promise<Saved<models.trips.Trip>[]>

listTripsForGuide

Parameters

Returns Promise<SavedTrip[]>

listTripsForHost

Parameters

Returns Promise<SavedTrip[]>

listTripsForTraveler

Parameters

Returns Promise<SavedTrip[]>

listTripsToLaunch

Parameters

Returns Promise<SavedTrip[]>

paginate

Parameters

Returns Promise<PaginationResponse<Saved<models.trips.Trip>>>

updateById

Parameters

Returns Promise<null | Saved<models.trips.Trip>>

updateMany

Parameters

Returns Promise<number>

updateOne

Parameters

Returns Promise<null | Saved<models.trips.Trip>>

upsertOne

Parameters

Returns Promise<null | string>

useView

Parameters

Returns ViewRepo<FinancialTrip | SavedTrip>

Settings

On This Page