Class CatalogDefaultAdapter

Implements

Constructors

constructor

HandlerAndValidators

createAttachment createAttribute createCategory createFollow createLocation createManyProductVariants createManyProducts createProduct createProductVariant deleteAttachment deleteAttribute deleteCategory deleteFollow deleteLocation deleteManyProductVariants deleteManyProducts deleteProduct deleteProductVariant duplicateProduct getAttachment getAttachmentUploadUrl getCategory getCategoryProductCount getCategoryTree getLocation getLocationProductCount getLocationTree getProduct getProductVariant listAttachments listAttachmentsForOrganization listAttributes listCategories listFollowers listFollowsForUser listLocations listProductVariants listProducts listProductsForActiveStatus listProductsForOrganization listRailAreas listRailCompanies listRailLines listRailStations updateAttribute updateCategory updateLocation updateManyProductVariants updateManyProducts updateProduct updateProductVariant

Properties

adapterName authSecrets dataServices dependencies opts

Constructors

constructor

HandlerAndValidators

createAttachment

createAttachment: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    emailVerified: undefined | Predicate;
    organizationExists: undefined | Predicate;
    organizationHasNormalStatus: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create attachment handler and validators

handler: createAttachmentHandler

validators:

createAttribute

createAttribute: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create attribute handler and validators

handler: createAttributeHandler

validators:

createCategory

createCategory: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create category handler and validators

handler: createCategoryHandler

validators:

createFollow

createFollow: HandlerAndValidators<{
    authentication: undefined | Predicate;
    followExists: undefined | Predicate;
    validBody: undefined | Predicate;
    validFollowerId: undefined | Predicate;
    validFollowerType: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create follower handler and validators

handler: createFollowerHandler

validators:

createLocation

createLocation: HandlerAndValidators<{
    authorization: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create location handler and validators

handler: createLocationHandler

validators:

createManyProductVariants

createManyProductVariants: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create many product variants handler and validators

handler: createManyProductVariantsHandler

validators:

createManyProducts

createManyProducts: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    organizationExists: undefined | Predicate;
    organizationHasNormalStatus: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create many products handler and validators

handler: createManyProductsHandler

validators:

createProduct

createProduct: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    organizationExists: undefined | Predicate;
    organizationHasNormalStatus: undefined | Predicate;
    validAttributes: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create product handler and validators

handler: createProductHandler

validators:

createProductVariant

createProductVariant: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create product variant handler and validators

handler: createProductVariantHandler

validators:

deleteAttachment

deleteAttachment: HandlerAndValidators<{
    attachmentExists: undefined | Predicate;
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    emailVerified: undefined | Predicate;
    organizationExists: undefined | Predicate;
    organizationHasNormalStatus: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete attachment handler and validators

handler: deleteAttachmentHandler

validators:

deleteAttribute

deleteAttribute: HandlerAndValidators<{
    attributeExists: undefined | Predicate;
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete attribute handler and validators

handler: deleteAttributeHandler

validators:

deleteCategory

deleteCategory: HandlerAndValidators<{
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete one category handler and validators

handler: deleteCategoryHandler

validators:

  • authorization: UserDefaultAdapterAPI.createIsAdminUserValidator

deleteFollow

deleteFollow: HandlerAndValidators<{
    authentication: undefined | Predicate;
    validBody: undefined | Predicate;
    validFollowerId: undefined | Predicate;
    validFollowerType: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete follower handler and validators

handler: deleteFollowerHandler

validators:

deleteLocation

deleteLocation: HandlerAndValidators<{
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete one location handler and validators

handler: deleteLocationHandler

validators:

  • authorization: UserDefaultAdapterAPI.createIsAdminUserValidator

deleteManyProductVariants

deleteManyProductVariants: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    variantExists: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete many product variants handler and validators

handler: deleteManyProductVariantsHandler

validators:

deleteManyProducts

deleteManyProducts: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    organizationExists: undefined | Predicate;
    productsBelongsToOrg: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete many products handler and validators

handler: deleteManyProductsHandler

validators:

deleteProduct

deleteProduct: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete one product handler and validators

handler: deleteProductHandler

validators:

deleteProductVariant

deleteProductVariant: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    variantExists: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete one product variant handler and validators

handler: deleteProductVariantHandler

validators:

duplicateProduct

duplicateProduct: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Copy product handler and validators

handler: duplicateProductHandler

validators:

  • authentication: UserDefaultAdapterAPI.createIsEmailVerifiedUserValidator
  • authorization: UserDefaultAdapterAPI.createIsAdminUserValidator || isUserOrganizationOwnerOrAdmin

getAttachment

getAttachment: HandlerAndValidators<{
    attachmentExists: undefined | Predicate;
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    emailVerified: undefined | Predicate;
    organizationExists: undefined | Predicate;
    organizationHasNormalStatus: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get attachment handler and validators

handler: getAttachmentHandler

validators:

getAttachmentUploadUrl

getAttachmentUploadUrl: HandlerAndValidators<{
    authentication: undefined | Predicate;
    emailVerified: undefined | Predicate;
    organizationExists: undefined | Predicate;
    organizationHasNormalStatus: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get attachment upload url handler and validators

handler: getAttachmentUploadUrlHandler

validators:

  • authentication: createIsAuthenticatedValidator
  • organizationExists: isOrganizationExists
  • organizationHasNormalStatus: OrganizationDefaultAdapterAPI.createIsNormalStatusOrganizationValidator
  • emailVerified: UserDefaultAdapterAPI.createIsEmailVerifiedUserValidator

getCategory

getCategory: HandlerAndValidators<Record<string, Predicate>>

Description

Get one category handler and validators

handler: getCategoryHandler

getCategoryProductCount

getCategoryProductCount: HandlerAndValidators<Record<string, Predicate>>

Description

Get category product count handler and validators

handler: getCategoryProductCountHandler

getCategoryTree

getCategoryTree: HandlerAndValidators<Record<string, Predicate>>

Description

Get category tree handler and validators

handler: getCategoryTreeHandler

getLocation

getLocation: HandlerAndValidators<Record<string, Predicate>>

Description

Get one location handler and validators

handler: getLocationHandler

getLocationProductCount

getLocationProductCount: HandlerAndValidators<Record<string, Predicate>>

Description

Get location product count handler and validators

handler: getLocationProductCountHandler

getLocationTree

getLocationTree: HandlerAndValidators<Record<string, Predicate>>

Description

Get location tree handler and validators

handler: getLocationTreeHandler

getProduct

getProduct: HandlerAndValidators<Record<string, Predicate>>

Description

Get one product handler and validators

handler: getProductHandler

getProductVariant

getProductVariant: HandlerAndValidators<{
    authentication: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get one product variant handler and validators

handler: getProductVariantHandler

validators:

listAttachments

listAttachments: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    emailVerified: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get attachments handler and validators

handler: getAttachmentsHandler

validators:

  • authentication: createIsAuthenticatedValidator
  • authorization: UserDefaultAdapterAPI.createIsAdminUserValidator
  • emailVerified: UserDefaultAdapterAPI.createIsEmailVerifiedUserValidator

listAttachmentsForOrganization

listAttachmentsForOrganization: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    emailVerified: undefined | Predicate;
    organizationExists: undefined | Predicate;
    organizationHasNormalStatus: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get attachments by organization handler and validators

handler: getAttachmentsByOwnerHandler

validators:

listAttributes

listAttributes: HandlerAndValidators<Record<string, Predicate>>

Description

Get attributes handler and validators

handler: listAttributesHandler

listCategories

listCategories: HandlerAndValidators<Record<string, Predicate>>

Description

Get categories handler and validators

handler: listCategoriesHandler

listFollowers

listFollowers: HandlerAndValidators<{
    authentication: undefined | Predicate;
    validFollowerType: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get followers handler and validators

handler: getFollowersHandler

validators:

listFollowsForUser

listFollowsForUser: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get user follows handler and validators

handler: getUserFollowsHandler

validators:

listLocations

listLocations: HandlerAndValidators<Record<string, Predicate>>

Description

Get locations handler and validators

handler: listLocationsHandler

listProductVariants

listProductVariants: HandlerAndValidators<{
    productExists: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get product variants handler and validators

handler: listProductVariantsHandler

validators:

listProducts

listProducts: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get products for admin handler and validators handler: listProductsHandler validators:

Memberof

ProductDefaultAdapterAPI

listProductsForActiveStatus

listProductsForActiveStatus: HandlerAndValidators<Record<string, Predicate>>

Description

Get products handler and validators

handler: listProductsForActiveStatusHandler

listProductsForOrganization

listProductsForOrganization: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    organizationExists: undefined | Predicate;
    organizationHasNormalStatus: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get products by organization handler and validators

handler: listProductsForOrganizationHandler

validators:

listRailAreas

listRailAreas: HandlerAndValidators<Record<string, Predicate>>

Description

Get rail area list handler and validators

handler: listRailAreasHandler

listRailCompanies

listRailCompanies: HandlerAndValidators<Record<string, Predicate>>

Description

Get rail company list handler and validators

handler: listRailCompaniesHandler

listRailLines

listRailLines: HandlerAndValidators<Record<string, Predicate>>

Description

Get rail line list handler and validators

handler: listRailLinesHandler

listRailStations

listRailStations: HandlerAndValidators<Record<string, Predicate>>

Description

Get rail station list handler and validators

handler: listRailStationsHandler

updateAttribute

updateAttribute: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Update attribute handler and validators

handler: updateAttributeHandler

validators:

updateCategory

updateCategory: HandlerAndValidators<{
    authorization: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Update one category handler and validators

handler: updateCategoryHandler

validators:

updateLocation

updateLocation: HandlerAndValidators<{
    authorization: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Update one location handler and validators

handler: updateLocationHandler

validators:

updateManyProductVariants

updateManyProductVariants: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    validBody: undefined | Predicate;
    variantExists: undefined | Predicate;
} & Record<string, Predicate>>

Description

Update many product variants handler and validators

handler: updateManyProductVariantsHandler

validators:

updateManyProducts

updateManyProducts: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    hasSuperAdminOnlyField: undefined | Predicate;
    organizationExists: undefined | Predicate;
    productsBelongsToOrg: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Update many products handler and validators

handler: updateManyProductsHandler

validators:

updateProduct

updateProduct: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    hasSuperAdminOnlyField: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Update one product handler and validators

handler: updateProductHandler

validators:

updateProductVariant

updateProductVariant: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    validBody: undefined | Predicate;
    variantExists: undefined | Predicate;
} & Record<string, Predicate>>

Description

Update one product variant handler and validators

handler: updateProductVariantHandler

validators:

Properties

adapterName

adapterName: string = ADAPTER_NAME

authSecrets

authSecrets: AuthSecrets

dataServices

dataServices: {
    attachment: AttachmentService;
    attribute: AttributeDataService;
    category: CategoryDataService;
    follower: FollowerService;
    location: LocationDataService;
    product: ProductDataService;
    productExpandPipeline: ProductExpandPipelineDataService;
    productStatistics: ProductStatisticsDataService;
    productVariant: ProductVariantDataService;
    railArea: RailAreaDataService;
    railCompany: RailCompanyDataService;
    railLine: RailLineDataService;
    railStation: RailStationDataService;
}

Type declaration

dependencies

dependencies: CatalogDefaultAdapterDependencies

opts

opts: Required<Omit<CatalogDefaultAdapterOptions, keyof AuthSecrets>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc