Type alias AssortmentsModule

Type declaration

• assortmentExists: ((query: { assortmentId?: string; slug?: string }) => Promise<boolean>)

  • • (query: { assortmentId?: string; slug?: string }): Promise<boolean>

    • Parameters

      • query: { assortmentId?: string; slug?: string }

        • Optional assortmentId?: string

        • Optional slug?: string

      Returns Promise<boolean>

• breadcrumbs: ((params: { assortmentId?: string; productId?: string }) => Promise<{ links: AssortmentPathLink[] }[]>)

  • • (params: { assortmentId?: string; productId?: string }): Promise<{ links: AssortmentPathLink[] }[]>

    • Parameters

      • params: { assortmentId?: string; productId?: string }

        • Optional assortmentId?: string

        • Optional productId?: string

      Returns Promise<{ links: AssortmentPathLink[] }[]>

• children: ((query: { assortmentId: string; includeInactive?: boolean }) => Promise<Assortment[]>)

  • • (query: { assortmentId: string; includeInactive?: boolean }): Promise<Assortment[]>

    • Parameters

      • query: { assortmentId: string; includeInactive?: boolean }

        • assortmentId: string

        • Optional includeInactive?: boolean

      Returns Promise<Assortment[]>

• count: ((query: AssortmentQuery) => Promise<number>)

  • • (query: AssortmentQuery): Promise<number>

    • Parameters

      • query: AssortmentQuery

      Returns Promise<number>

• create: ((doc: Assortment & { locale: string; title: string }, userId: string) => Promise<string>)

  • • (doc: Assortment & { locale: string; title: string }, userId: string): Promise<string>

    • Parameters

      • doc: Assortment & { locale: string; title: string }

      • userId: string

      Returns Promise<string>

• delete: ((assortmentId: string, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<number>)

  • • (assortmentId: string, options?: { skipInvalidation?: boolean }, userId?: string): Promise<number>

    • Parameters

      • assortmentId: string

      • Optional options: { skipInvalidation?: boolean }

        • Optional skipInvalidation?: boolean

      • Optional userId: string

      Returns Promise<number>

• filters: { create: ((doc: AssortmentFilter, userId?: string) => Promise<AssortmentFilter>); delete: ((assortmentFilterId: string, userId?: string) => Promise<{ _id: _ID }[]>); deleteMany: ((selector: Filter<AssortmentFilter>, userId?: string) => Promise<{ _id: _ID }[]>); findFilter: ((params: { assortmentFilterId: string }, options?: { skipInvalidation?: boolean }) => Promise<AssortmentFilter>); findFilterIds: ((params: { assortmentId: string }) => Promise<string[]>); findFilters: ((params: { assortmentId: string }, options?: FindOptions) => Promise<AssortmentFilter[]>); update: ((assortmentFilterId: string, doc: AssortmentFilter) => Promise<AssortmentFilter>); updateManualOrder: ((params: { sortKeys: { assortmentFilterId: string; sortKey: number }[] }, userId?: string) => Promise<AssortmentFilter[]>) }

  • create: ((doc: AssortmentFilter, userId?: string) => Promise<AssortmentFilter>)

    • • (doc: AssortmentFilter, userId?: string): Promise<AssortmentFilter>

      • Parameters

        • doc: AssortmentFilter

        • Optional userId: string

        Returns Promise<AssortmentFilter>

  • delete: ((assortmentFilterId: string, userId?: string) => Promise<{ _id: _ID }[]>)

    • • (assortmentFilterId: string, userId?: string): Promise<{ _id: _ID }[]>

      • Parameters

        • assortmentFilterId: string

        • Optional userId: string

        Returns Promise<{ _id: _ID }[]>

  • deleteMany: ((selector: Filter<AssortmentFilter>, userId?: string) => Promise<{ _id: _ID }[]>)

    • • (selector: Filter<AssortmentFilter>, userId?: string): Promise<{ _id: _ID }[]>

      • Parameters

        • selector: Filter<AssortmentFilter>

        • Optional userId: string

        Returns Promise<{ _id: _ID }[]>

  • findFilter: ((params: { assortmentFilterId: string }, options?: { skipInvalidation?: boolean }) => Promise<AssortmentFilter>)

    • • (params: { assortmentFilterId: string }, options?: { skipInvalidation?: boolean }): Promise<AssortmentFilter>

      • Parameters

        • params: { assortmentFilterId: string }

          • assortmentFilterId: string

        • Optional options: { skipInvalidation?: boolean }

          • Optional skipInvalidation?: boolean

        Returns Promise<AssortmentFilter>

  • findFilterIds: ((params: { assortmentId: string }) => Promise<string[]>)

    • • (params: { assortmentId: string }): Promise<string[]>

      • Parameters

        • params: { assortmentId: string }

          • assortmentId: string

        Returns Promise<string[]>

  • findFilters: ((params: { assortmentId: string }, options?: FindOptions) => Promise<AssortmentFilter[]>)

    • • (params: { assortmentId: string }, options?: FindOptions): Promise<AssortmentFilter[]>

      • Parameters

        • params: { assortmentId: string }

          • assortmentId: string

        • Optional options: FindOptions

        Returns Promise<AssortmentFilter[]>

  • update: ((assortmentFilterId: string, doc: AssortmentFilter) => Promise<AssortmentFilter>)

    • • (assortmentFilterId: string, doc: AssortmentFilter): Promise<AssortmentFilter>

      • Parameters

        • assortmentFilterId: string

        • doc: AssortmentFilter

        Returns Promise<AssortmentFilter>

  • updateManualOrder: ((params: { sortKeys: { assortmentFilterId: string; sortKey: number }[] }, userId?: string) => Promise<AssortmentFilter[]>)

    • • (params: { sortKeys: { assortmentFilterId: string; sortKey: number }[] }, userId?: string): Promise<AssortmentFilter[]>

      • Parameters

        • params: { sortKeys: { assortmentFilterId: string; sortKey: number }[] }

          • sortKeys: { assortmentFilterId: string; sortKey: number }[]

        • Optional userId: string

        Returns Promise<AssortmentFilter[]>

• findAssortment: ((query: { assortmentId?: string; slug?: string }) => Promise<Assortment>)

  • • (query: { assortmentId?: string; slug?: string }): Promise<Assortment>

    • Parameters

      • query: { assortmentId?: string; slug?: string }

        • Optional assortmentId?: string

        • Optional slug?: string

      Returns Promise<Assortment>

• findAssortments: ((query: AssortmentQuery & { limit?: number; offset?: number; sort?: SortOption[] }, options?: FindOptions) => Promise<Assortment[]>)

  • • (query: AssortmentQuery & { limit?: number; offset?: number; sort?: SortOption[] }, options?: FindOptions): Promise<Assortment[]>

    • Parameters

      • query: AssortmentQuery & { limit?: number; offset?: number; sort?: SortOption[] }

      • Optional options: FindOptions

      Returns Promise<Assortment[]>

• findProductIds: ((params: { assortmentId: string; forceLiveCollection?: boolean; ignoreChildAssortments?: boolean }) => Promise<string[]>)

  • • (params: { assortmentId: string; forceLiveCollection?: boolean; ignoreChildAssortments?: boolean }): Promise<string[]>

    • Parameters

      • params: { assortmentId: string; forceLiveCollection?: boolean; ignoreChildAssortments?: boolean }

        • assortmentId: string

        • Optional forceLiveCollection?: boolean

        • Optional ignoreChildAssortments?: boolean

      Returns Promise<string[]>

• invalidateCache: ((params: AssortmentQuery, options?: { skipUpstreamTraversal: boolean }) => void)

  • • (params: AssortmentQuery, options?: { skipUpstreamTraversal: boolean }): void

    • Parameters

      • params: AssortmentQuery

      • Optional options: { skipUpstreamTraversal: boolean }

        • skipUpstreamTraversal: boolean

      Returns void

• links: { create: ((doc: AssortmentLink, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<AssortmentLink>); delete: ((assortmentLinkId: string, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<AssortmentLink>); deleteMany: ((selector: Filter<AssortmentLink>, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<AssortmentLink[]>); findLink: ((query: { assortmentLinkId?: string; childAssortmentId?: string; parentAssortmentId?: string }, options?: { skipInvalidation?: boolean }) => Promise<AssortmentLink>); findLinks: ((query: { assortmentId?: string; parentAssortmentId?: string }, options?: FindOptions) => Promise<AssortmentLink[]>); update: ((assortmentLinkId: string, doc: AssortmentLink, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<AssortmentLink>); updateManualOrder: ((params: { sortKeys: { assortmentLinkId: string; sortKey: number }[] }, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<AssortmentLink[]>) }

  • create: ((doc: AssortmentLink, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<AssortmentLink>)

    • • (doc: AssortmentLink, options?: { skipInvalidation?: boolean }, userId?: string): Promise<AssortmentLink>

      • Parameters

        • doc: AssortmentLink

        • Optional options: { skipInvalidation?: boolean }

          • Optional skipInvalidation?: boolean

        • Optional userId: string

        Returns Promise<AssortmentLink>

  • delete: ((assortmentLinkId: string, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<AssortmentLink>)

    • • (assortmentLinkId: string, options?: { skipInvalidation?: boolean }, userId?: string): Promise<AssortmentLink>

      • Parameters

        • assortmentLinkId: string

        • Optional options: { skipInvalidation?: boolean }

          • Optional skipInvalidation?: boolean

        • Optional userId: string

        Returns Promise<AssortmentLink>

  • deleteMany: ((selector: Filter<AssortmentLink>, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<AssortmentLink[]>)

    • • (selector: Filter<AssortmentLink>, options?: { skipInvalidation?: boolean }, userId?: string): Promise<AssortmentLink[]>

      • Parameters

        • selector: Filter<AssortmentLink>

        • Optional options: { skipInvalidation?: boolean }

          • Optional skipInvalidation?: boolean

        • Optional userId: string

        Returns Promise<AssortmentLink[]>

  • findLink: ((query: { assortmentLinkId?: string; childAssortmentId?: string; parentAssortmentId?: string }, options?: { skipInvalidation?: boolean }) => Promise<AssortmentLink>)

    • • (query: { assortmentLinkId?: string; childAssortmentId?: string; parentAssortmentId?: string }, options?: { skipInvalidation?: boolean }): Promise<AssortmentLink>

      • Parameters

        • query: { assortmentLinkId?: string; childAssortmentId?: string; parentAssortmentId?: string }

          • Optional assortmentLinkId?: string

          • Optional childAssortmentId?: string

          • Optional parentAssortmentId?: string

        • Optional options: { skipInvalidation?: boolean }

          • Optional skipInvalidation?: boolean

        Returns Promise<AssortmentLink>

  • findLinks: ((query: { assortmentId?: string; parentAssortmentId?: string }, options?: FindOptions) => Promise<AssortmentLink[]>)

    • • (query: { assortmentId?: string; parentAssortmentId?: string }, options?: FindOptions): Promise<AssortmentLink[]>

      • Parameters

        • query: { assortmentId?: string; parentAssortmentId?: string }

          • Optional assortmentId?: string

          • Optional parentAssortmentId?: string

        • Optional options: FindOptions

        Returns Promise<AssortmentLink[]>

  • update: ((assortmentLinkId: string, doc: AssortmentLink, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<AssortmentLink>)

    • • (assortmentLinkId: string, doc: AssortmentLink, options?: { skipInvalidation?: boolean }, userId?: string): Promise<AssortmentLink>

      • Parameters

        • assortmentLinkId: string

        • doc: AssortmentLink

        • Optional options: { skipInvalidation?: boolean }

          • Optional skipInvalidation?: boolean

        • Optional userId: string

        Returns Promise<AssortmentLink>

  • updateManualOrder: ((params: { sortKeys: { assortmentLinkId: string; sortKey: number }[] }, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<AssortmentLink[]>)

    • • (params: { sortKeys: { assortmentLinkId: string; sortKey: number }[] }, options?: { skipInvalidation?: boolean }, userId?: string): Promise<AssortmentLink[]>

      • Parameters

        • params: { sortKeys: { assortmentLinkId: string; sortKey: number }[] }

          • sortKeys: { assortmentLinkId: string; sortKey: number }[]

        • Optional options: { skipInvalidation?: boolean }

          • Optional skipInvalidation?: boolean

        • Optional userId: string

        Returns Promise<AssortmentLink[]>

• media: AssortmentMediaModule

• products: { create: ((doc: AssortmentProduct, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<AssortmentProduct>); delete: ((assortmentProductId: string, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<{ _id: _ID; assortmentId: string }[]>); deleteMany: ((selector: Filter<AssortmentProduct>, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<{ _id: _ID; assortmentId: string }[]>); findAssortmentIds: ((params: { productId: string; tags?: string[] }) => Promise<string[]>); findProduct: ((params: { assortmentProductId: string }) => Promise<AssortmentProduct>); findProductIds: ((params: { assortmentId: string; tags?: string[] }) => Promise<string[]>); findProductSiblings: ((params: { assortmentIds: string[]; productId: string }) => Promise<string[]>); findProducts: ((params: { assortmentId: string }, options?: FindOptions) => Promise<AssortmentProduct[]>); update: ((assortmentProductId: string, doc: AssortmentProduct, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<AssortmentProduct>); updateManualOrder: ((params: { sortKeys: { assortmentProductId: string; sortKey: number }[] }, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<AssortmentProduct[]>) }

  • create: ((doc: AssortmentProduct, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<AssortmentProduct>)

    • • (doc: AssortmentProduct, options?: { skipInvalidation?: boolean }, userId?: string): Promise<AssortmentProduct>

      • Parameters

        • doc: AssortmentProduct

        • Optional options: { skipInvalidation?: boolean }

          • Optional skipInvalidation?: boolean

        • Optional userId: string

        Returns Promise<AssortmentProduct>

  • delete: ((assortmentProductId: string, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<{ _id: _ID; assortmentId: string }[]>)

    • • (assortmentProductId: string, options?: { skipInvalidation?: boolean }, userId?: string): Promise<{ _id: _ID; assortmentId: string }[]>

      • Parameters

        • assortmentProductId: string

        • Optional options: { skipInvalidation?: boolean }

          • Optional skipInvalidation?: boolean

        • Optional userId: string

        Returns Promise<{ _id: _ID; assortmentId: string }[]>

  • deleteMany: ((selector: Filter<AssortmentProduct>, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<{ _id: _ID; assortmentId: string }[]>)

    • • (selector: Filter<AssortmentProduct>, options?: { skipInvalidation?: boolean }, userId?: string): Promise<{ _id: _ID; assortmentId: string }[]>

      • Parameters

        • selector: Filter<AssortmentProduct>

        • Optional options: { skipInvalidation?: boolean }

          • Optional skipInvalidation?: boolean

        • Optional userId: string

        Returns Promise<{ _id: _ID; assortmentId: string }[]>

  • findAssortmentIds: ((params: { productId: string; tags?: string[] }) => Promise<string[]>)

    • • (params: { productId: string; tags?: string[] }): Promise<string[]>

      • Parameters

        • params: { productId: string; tags?: string[] }

          • productId: string

          • Optional tags?: string[]

        Returns Promise<string[]>

  • findProduct: ((params: { assortmentProductId: string }) => Promise<AssortmentProduct>)

    • • (params: { assortmentProductId: string }): Promise<AssortmentProduct>

      • Parameters

        • params: { assortmentProductId: string }

          • assortmentProductId: string

        Returns Promise<AssortmentProduct>

  • findProductIds: ((params: { assortmentId: string; tags?: string[] }) => Promise<string[]>)

    • • (params: { assortmentId: string; tags?: string[] }): Promise<string[]>

      • Parameters

        • params: { assortmentId: string; tags?: string[] }

          • assortmentId: string

          • Optional tags?: string[]

        Returns Promise<string[]>

  • findProductSiblings: ((params: { assortmentIds: string[]; productId: string }) => Promise<string[]>)

    • • (params: { assortmentIds: string[]; productId: string }): Promise<string[]>

      • Parameters

        • params: { assortmentIds: string[]; productId: string }

          • assortmentIds: string[]

          • productId: string

        Returns Promise<string[]>

  • findProducts: ((params: { assortmentId: string }, options?: FindOptions) => Promise<AssortmentProduct[]>)

    • • (params: { assortmentId: string }, options?: FindOptions): Promise<AssortmentProduct[]>

      • Parameters

        • params: { assortmentId: string }

          • assortmentId: string

        • Optional options: FindOptions

        Returns Promise<AssortmentProduct[]>

  • update: ((assortmentProductId: string, doc: AssortmentProduct, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<AssortmentProduct>)

    • • (assortmentProductId: string, doc: AssortmentProduct, options?: { skipInvalidation?: boolean }, userId?: string): Promise<AssortmentProduct>

      • Parameters

        • assortmentProductId: string

        • doc: AssortmentProduct

        • Optional options: { skipInvalidation?: boolean }

          • Optional skipInvalidation?: boolean

        • Optional userId: string

        Returns Promise<AssortmentProduct>

  • updateManualOrder: ((params: { sortKeys: { assortmentProductId: string; sortKey: number }[] }, options?: { skipInvalidation?: boolean }, userId?: string) => Promise<AssortmentProduct[]>)

    • • (params: { sortKeys: { assortmentProductId: string; sortKey: number }[] }, options?: { skipInvalidation?: boolean }, userId?: string): Promise<AssortmentProduct[]>

      • Parameters

        • params: { sortKeys: { assortmentProductId: string; sortKey: number }[] }

          • sortKeys: { assortmentProductId: string; sortKey: number }[]

        • Optional options: { skipInvalidation?: boolean }

          • Optional skipInvalidation?: boolean

        • Optional userId: string

        Returns Promise<AssortmentProduct[]>

• search: { findFilteredAssortments: ((params: { assortmentIds: string[]; assortmentSelector: Query; limit: number; offset: number; sort: FindOptions["sort"] }) => Promise<Assortment[]>) }

  • findFilteredAssortments: ((params: { assortmentIds: string[]; assortmentSelector: Query; limit: number; offset: number; sort: FindOptions["sort"] }) => Promise<Assortment[]>)

    • • (params: { assortmentIds: string[]; assortmentSelector: Query; limit: number; offset: number; sort: FindOptions["sort"] }): Promise<Assortment[]>

      • Parameters

        • params: { assortmentIds: string[]; assortmentSelector: Query; limit: number; offset: number; sort: FindOptions["sort"] }

          • assortmentIds: string[]

          • assortmentSelector: Query

          • limit: number

          • offset: number

          • sort: FindOptions["sort"]

        Returns Promise<Assortment[]>

• setBase: ((assortmentId: string, userId?: string) => Promise<void>)

  • • (assortmentId: string, userId?: string): Promise<void>

    • Parameters

      • assortmentId: string

      • Optional userId: string

      Returns Promise<void>

• texts: { deleteMany: (({ assortmentId: string }: any, userId?: string) => Promise<number>); findLocalizedText: ((params: { assortmentId: string; locale?: string }) => Promise<AssortmentText>); findTexts: ((query: Query, options?: FindOptions) => Promise<AssortmentText[]>); makeSlug: ((data: { assortmentId: string; slug?: string; title: string }) => Promise<string>); searchTexts: (({ searchText: string }: any) => Promise<string[]>); updateTexts: ((assortmentId: string, texts: Omit<AssortmentText, "assortmentId" | "authorId">[], userId?: string) => Promise<AssortmentText[]>); upsertLocalizedText: ((assortmentId: string, locale: string, text: Omit<AssortmentText, "assortmentId" | "authorId" | "locale">, userId?: string) => Promise<AssortmentText>) }

  • deleteMany: (({ assortmentId: string }: any, userId?: string) => Promise<number>)

    • • ({ assortmentId: string }: any, userId?: string): Promise<number>

      • Parameters

        • { assortmentId: string }: any

        • Optional userId: string

        Returns Promise<number>

  • findLocalizedText: ((params: { assortmentId: string; locale?: string }) => Promise<AssortmentText>)

    • • (params: { assortmentId: string; locale?: string }): Promise<AssortmentText>

      • Parameters

        • params: { assortmentId: string; locale?: string }

          • assortmentId: string

          • Optional locale?: string

        Returns Promise<AssortmentText>

  • findTexts: ((query: Query, options?: FindOptions) => Promise<AssortmentText[]>)

    • • (query: Query, options?: FindOptions): Promise<AssortmentText[]>

      • Parameters

        • query: Query

        • Optional options: FindOptions

        Returns Promise<AssortmentText[]>

  • makeSlug: ((data: { assortmentId: string; slug?: string; title: string }) => Promise<string>)

    • • (data: { assortmentId: string; slug?: string; title: string }): Promise<string>

      • Parameters

        • data: { assortmentId: string; slug?: string; title: string }

          • assortmentId: string

          • Optional slug?: string

          • title: string

        Returns Promise<string>

  • searchTexts: (({ searchText: string }: any) => Promise<string[]>)

    • • ({ searchText: string }: any): Promise<string[]>

      • Parameters

        • { searchText: string }: any

        Returns Promise<string[]>

  • updateTexts: ((assortmentId: string, texts: Omit<AssortmentText, "assortmentId" | "authorId">[], userId?: string) => Promise<AssortmentText[]>)

    • • (assortmentId: string, texts: Omit<AssortmentText, "assortmentId" | "authorId">[], userId?: string): Promise<AssortmentText[]>

      • Parameters

        • assortmentId: string

        • texts: Omit<AssortmentText, "assortmentId" | "authorId">[]

        • Optional userId: string

        Returns Promise<AssortmentText[]>

  • upsertLocalizedText: ((assortmentId: string, locale: string, text: Omit<AssortmentText, "assortmentId" | "authorId" | "locale">, userId?: string) => Promise<AssortmentText>)

    • • (assortmentId: string, locale: string, text: Omit<AssortmentText, "assortmentId" | "authorId" | "locale">, userId?: string): Promise<AssortmentText>

      • Parameters

        • assortmentId: string

        • locale: string

        • text: Omit<AssortmentText, "assortmentId" | "authorId" | "locale">

        • Optional userId: string

        Returns Promise<AssortmentText>

• update: ((assortmentId: string, doc: Assortment, userId: string, options?: { skipInvalidation?: boolean }) => Promise<string>)

  • • (assortmentId: string, doc: Assortment, userId: string, options?: { skipInvalidation?: boolean }): Promise<string>

    • Parameters

      • assortmentId: string

      • doc: Assortment

      • userId: string

      • Optional options: { skipInvalidation?: boolean }

        • Optional skipInvalidation?: boolean

      Returns Promise<string>