Class ProductDataService

constructor

• new ProductDataService(db, organizationEndpoint, expandPipelineService, attachmentService, organizationAPI): ProductDataService

• Parameters

  • db: Db

  • organizationEndpoint: string

  • expandPipelineService: ProductExpandPipelineDataService

  • attachmentService: AttachmentDefaultService

  • organizationAPI: OrganizationDefaultAdapterAPI

  Returns ProductDataService

bulkWriteProducts

• bulkWriteProducts(bulkUpdateList): Promise<number>

• Run a series of updates on multiple products. Updates will be performed using the bulkWrite method.

  Parameters

  • bulkUpdateList: {
        data: Partial<Partial<Omit<CreateProductDto, "variants"> & {
            variants: Partial<Partial<ProductVariantBasicInfo & WithPartialPriceField & {
                imageIds?: string[];
            }> & {
                id: string;
            }>[];
        }>>;
        ids: string[];
    }[]

    TODO: Add transaction support in the future

  Returns Promise<number>

cleanUpdateInfoForProduct

• cleanUpdateInfoForProduct(payload): Partial<Partial<Omit<CreateProductDto, "variants"> & {
      variants: Partial<Partial<ProductVariantBasicInfo & WithPartialPriceField & {
          imageIds?: string[];
      }> & {
          id: string;
      }>[];
  }>>

• Cleans an update payload for a product so that it can be saved into mongoDB.

  Parameters

  • payload: Partial<Partial<Omit<CreateProductDto, "variants"> & {
        variants: Partial<Partial<ProductVariantBasicInfo & WithPartialPriceField & {
            imageIds?: string[];
        }> & {
            id: string;
        }>[];
    }>>

  Returns Partial<Partial<Omit<CreateProductDto, "variants"> & {
      variants: Partial<Partial<ProductVariantBasicInfo & WithPartialPriceField & {
          imageIds?: string[];
      }> & {
          id: string;
      }>[];
  }>>

copyProduct

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

• Returns the result with the created product id.

  Parameters

  • id: string

    Id of the product to copy

  Returns Promise<{
      id: string;
  }>

  The result with the created product id

createManyProducts

• createManyProducts(productList): Promise<{
      id: string;
  }[]>

• Create multiple products in the database.

  Parameters

  • productList: Partial<CreateProductDto & {
        organizationId: string;
    }>[]

  Returns Promise<{
      id: string;
  }[]>

createProduct

• createProduct(product): Promise<{
      id: string;
  }>

• Create a single product in the database. Internally, this method calls createManyProducts with a single product.

  Parameters

  • product: Partial<CreateProductDto & {
        organizationId: string;
    }>

  Returns Promise<{
      id: string;
  }>

deleteManyProducts

• deleteManyProducts(productIds): Promise<number>

• Delete multiple products.

  Parameters

  • productIds: string[]

    ids of products to delete

  Returns Promise<number>

  true if deleted successfully, or false if failed

deleteProduct

• deleteProduct(productId): Promise<boolean>

• Delete product.

  Parameters

  • productId: string

    id of product to delete

  Returns Promise<boolean>

  true if deleted successfully, or false if failed blocks-99c0

expandImages

• expandImages(products, expand?): Promise<ProductResponse[]>

• Expand a list of products with image data from the attachment service

  Note: This expand always expands, as images are expanded by default

  Parameters

  • products: ProductResponse[]

  • Optional expand: Expand

  Returns Promise<ProductResponse[]>

expandOrganizations

• expandOrganizations(products, expand?): Promise<ProductResponse[]>

• Expand a list of products with organization data from the organization API

  Parameters

  • products: ProductResponse[]

  • Optional expand: Expand

  Returns Promise<ProductResponse[]>

  ProductResponse[]

expandProducts

• expandProducts(products, expand?, applyExpression?): Promise<ProductResponse[]>

• Expand the products with other microservices and data types

  Parameters

  • products: ProductResponse[]

  • Optional expand: Expand

  • Optional applyExpression: ApplyExpression

  Returns Promise<ProductResponse[]>

  ProductResponse[]

getIsAllProductsBelongsToOrganization

• getIsAllProductsBelongsToOrganization(productIds, orgId): Promise<boolean>

• Check that all products are belonging to the org

  Parameters

  • productIds: string[]

  • orgId: string

  Returns Promise<boolean>

  true if all products belongs to the org

getProduct

• getProduct(id, forOrganizationId?): Promise<null | ProductEntity>

• Get product from database. Optionally, you can pass forOrganizationId to filter products by organizationId.

  Parameters

  • id: string

  • Optional forOrganizationId: string

  Returns Promise<null | ProductEntity>

  Promise<Product | undefined> Product data if fetched successfully, or null if data not found by id

getProducts

• getProducts(productIds): Promise<ProductEntity[]>

• Get multiple specific products from database.

  Parameters

  • productIds: string[]

  Returns Promise<ProductEntity[]>

  Promise<Product[]>

hasApplyExpression

• hasApplyExpression(products, applyExpression?): products is {
      _id: string;
      top?: ProductResponse[];
  }[]

• Type guard to check if the products have been processed by the $apply param

  TODO: This method is a workaround for the current implementation of the $apply param, and isn't ideal. I think we should just not support $expand on $apply, but we need to provide backwards compatibility for existing clients on the list products endpoints. In future, let's remove this method and encourage customers to either use two queries or make their own custom endpoint.

  Parameters

  • products: unknown[]

  • Optional applyExpression: ApplyExpression

  Returns products is {
      _id: string;
      top?: ProductResponse[];
  }[]

listPaginatedProducts

• listPaginatedProducts(opts, extraFilters?, logger?): Promise<PaginatedFindResult<ProductEntity>>

• List paginated products. This also supports extra filters:

  • mustBePublishedToday: only return products that are published at the current date
  • searchKeyword: search keyword to filter products

  Parameters

  • opts: ParsedPaginatedListQuery

    paginated list query options

  • Optional extraFilters: {
        mustBePublishedToday?: boolean;
        organizationId?: string;
        productIds?: string[];
        searchKeyword?: string;
    }

    additional filters for certain endpoints

    • Optional mustBePublishedToday?: boolean

    • Optional organizationId?: string

    • Optional productIds?: string[]

    • Optional searchKeyword?: string

  • Optional logger: Logger

  Returns Promise<PaginatedFindResult<ProductEntity>>

  paginated product list query result

normalizeProductResponse

• normalizeProductResponse(product): Promise<ProductResponse>

• Normalize a single product response

  Parameters

  • product: ProductResponse

  Returns Promise<ProductResponse>

normalizeProductResponses

• normalizeProductResponses(products, applyExpression?): Promise<ProductResponse[]>

• Normalize a list of product responses

  Parameters

  • products: ProductResponse[]

  • Optional applyExpression: ApplyExpression

  Returns Promise<ProductResponse[]>

updateProduct

• updateProduct(productId, payload): Promise<{
      id: string;
  }>

• Update Product data

  Parameters

  • productId: string

    id of the product to update

  • payload: Partial<Partial<Omit<CreateProductDto, "variants"> & {
        variants: Partial<Partial<ProductVariantBasicInfo & WithPartialPriceField & {
            imageIds?: string[];
        }> & {
            id: string;
        }>[];
    }>>

    Data of product

  Returns Promise<{
      id: string;
  }>

  object contains id of the updated record blocks-58c1

productRepository

Static Readonly COLLECTION_PRODUCT

Static Readonly DEFAULT_PUBLICATION_STATUS