Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: merchant package #973

Merged
merged 3 commits into from
Dec 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions apps/storefront/src/app.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { appBuilder } from '@spryker-oryx/application';
import { labsFeatures } from '@spryker-oryx/labs';
import { merchantFeature } from '@spryker-oryx/merchant';
import { b2bStorefrontFeatures } from '@spryker-oryx/presets/b2b-storefront';
import { storefrontFeatures } from '@spryker-oryx/presets/storefront';
import { storefrontTheme } from '@spryker-oryx/themes';
Expand All @@ -10,6 +11,8 @@ const features = [
...(env.ORYX_PRESET && env.ORYX_PRESET === 'b2b'
? b2bStorefrontFeatures
: storefrontFeatures),
// TODO: use feature flag
merchantFeature,
...(env.ORYX_LABS ? labsFeatures : []),
];

Expand Down
1 change: 1 addition & 0 deletions libs/domain/merchant/.constants.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export const storybookPrefix = 'Merchant';
5 changes: 5 additions & 0 deletions libs/domain/merchant/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Change Log

All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

7 changes: 7 additions & 0 deletions libs/domain/merchant/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Oryx Merchant package

Provides components and services related to merchant feature for marketplace scenarios.

## Installation

`npm install @spryker-oryx/merchant`
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { MerchantMixin } from '@spryker-oryx/merchant';
import { LitElement, TemplateResult, html } from 'lit';
import { MerchantMixin } from '../../src/merchant/mixins';

export class MerchantBannerComponent extends MerchantMixin(LitElement) {
protected override render(): TemplateResult | void {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { ContentMixin } from '@spryker-oryx/experience';
import { MerchantMixin } from '@spryker-oryx/merchant';
import { LitElement, TemplateResult, html } from 'lit';
import { MerchantMixin } from '../../src/merchant/mixins';
import { merchantContactStyles } from './contact.styles';

export class MerchantContactComponent extends MerchantMixin(
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { MerchantMixin } from '@spryker-oryx/merchant';
import { LitElement, TemplateResult, html } from 'lit';
import { MerchantMixin } from '../../src/merchant/mixins';

export class MerchantDescriptionComponent extends MerchantMixin(LitElement) {
protected override render(): TemplateResult | void {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { MerchantMixin } from '@spryker-oryx/merchant';
import { LitElement, TemplateResult, html } from 'lit';
import { MerchantMixin } from '../../src/merchant/mixins';

export class MerchantLegalComponent extends MerchantMixin(LitElement) {
protected override render(): TemplateResult | void {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { MerchantMixin } from '@spryker-oryx/merchant';
import { LitElement, TemplateResult, html } from 'lit';
import { MerchantMixin } from '../../src/merchant/mixins';

export class MerchantLogoComponent extends MerchantMixin(LitElement) {
protected override render(): TemplateResult | void {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { ContentMixin } from '@spryker-oryx/experience';
import { LitElement, TemplateResult, html } from 'lit';
import { repeat } from 'lit/directives/repeat.js';
import {
MerchantMixin,
MerchantScheduleSlot,
TimeRange,
} from '../../src/merchant/merchant.model';
import { MerchantMixin } from '../../src/merchant/mixins';
} from '@spryker-oryx/merchant';
import { LitElement, TemplateResult, html } from 'lit';
import { repeat } from 'lit/directives/repeat.js';
import { openingHoursStyles } from './opening-hours.styles';

export class MerchantOpeningsHoursComponent extends MerchantMixin(
Expand Down
29 changes: 29 additions & 0 deletions libs/domain/merchant/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"name": "@spryker-oryx/merchant",
"type": "module",
"version": "1.3.1",
"description": "Merchant features for Oryx applications",
"author": "Spryker Systems GmbH",
"license": "See license in LICENSE",
"files": [
"**/*"
],
"main": "./src/index.js",
"typings": "./src/index.d.ts",
"publishConfig": {
"access": "public"
},
"dependencies": {
"@spryker-oryx/core": "1.3.1",
"@spryker-oryx/di": "1.3.1",
"@spryker-oryx/experience": "1.3.1",
"@spryker-oryx/product": "1.3.1",
"@spryker-oryx/router": "1.3.1",
"@spryker-oryx/utilities": "1.3.1"
},
"peerDependencies": {
"lit": "^2.4.0",
"rxjs": "^7.5.0",
"tslib": "^2.4.0"
}
}
51 changes: 51 additions & 0 deletions libs/domain/merchant/project.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
{
"$schema": "../../../node_modules/nx/schemas/project-schema.json",
"projectType": "library",
"sourceRoot": "libs/domain/merchant",
"prefix": "fes",
"targets": {
"build": {
"executor": "./tools/executors/components-library:build"
},
"paths": {
"executor": "./tools/executors/components-library:paths"
},
"test": {
"executor": "./tools/executors/oryx-vite:vitest"
},
"lint": {
"executor": "@nrwl/linter:eslint",
"options": {
"lintFilePatterns": ["libs/domain/merchant/**/*.ts"]
},
"outputs": ["{options.outputFile}"]
},
"storybook": {
"executor": "@nrwl/storybook:storybook",
"options": {
"uiFramework": "@storybook/web-components",
"port": 4400,
"config": {
"configFolder": "libs/domain/merchant/.storybook"
},
"staticDir": ["libs/domain/merchant/public"]
},
"configurations": {
"ci": {
"quiet": true
}
}
},
"stylelint": {
"executor": "nx-stylelint:lint",
"outputs": ["{options.outputFile}"],
"options": {
"lintFilePatterns": [
"libs/domain/merchant/**/*.css",
"libs/domain/merchant/**/*.styles.ts"
]
}
}
},
"tags": ["layer:domain"]
}
7 changes: 7 additions & 0 deletions libs/domain/merchant/src/components.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export * from '../banner/banner.def';
export * from '../contact/contact.def';
export * from '../description/description.def';
export * from '../legal/legal.def';
export * from '../logo/logo.def';
export * from '../opening-hours/opening-hours.def';
export * from '../title/title.def';
11 changes: 11 additions & 0 deletions libs/domain/merchant/src/feature.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { AppFeature } from '@spryker-oryx/core';
import * as components from './components';
import { merchantProviders } from './services';
export * from './components';

export const merchantComponents = Object.values(components);

export const merchantFeature: AppFeature = {
providers: merchantProviders,
components: merchantComponents,
};
5 changes: 5 additions & 0 deletions libs/domain/merchant/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export * from './components';
export * from './feature';
export * from './mixins';
export * from './models';
export * from './services';
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ import {
signalProperty,
} from '@spryker-oryx/utilities';
import { LitElement } from 'lit';
import { MerchantContext } from '../merchant.context';
import { Merchant, MerchantComponentProperties } from '../merchant.model';
import { MerchantService } from '../merchant.service';
import { Merchant, MerchantComponentProperties } from '../models';
import { MerchantContext, MerchantService } from '../services';

export declare class MerchantMixinInterface
implements MerchantComponentProperties
Expand Down
2 changes: 2 additions & 0 deletions libs/domain/merchant/src/models/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export * from './merchant.model';
export * from './merchant.model.api';
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import { ApiProductModel } from '@spryker-oryx/product';
import { Price } from '@spryker-oryx/site';
import { ProductAvailability } from '../models';

export module ApiMerchantModel {
import ProductAvailability = ApiProductModel.ProductAvailability;

export interface Merchant {
id: string;
merchantName: string;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
import { HttpService, JsonAPITransformerService } from '@spryker-oryx/core';
import { inject } from '@spryker-oryx/di';
import { Observable } from 'rxjs';
import { Merchant, MerchantQualifier } from '../merchant.model';
import { ApiMerchantModel } from '../merchant.model.api';
import { ApiMerchantModel, Merchant, MerchantQualifier } from '../../models';
import { MerchantAdapter, MerchantNormalizer } from './merchant.adapter';

export class DefaultMerchantAdapter implements MerchantAdapter {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
export * from './default-merchant.adapter';
export * from './merchant.adapter';
export * from './normalizers';
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Transformer } from '@spryker-oryx/core';
import { Observable } from 'rxjs';
import { Merchant, MerchantQualifier } from '../merchant.model';
import { Merchant, MerchantQualifier } from '../../models';

export const MerchantAdapter = 'oryx.MerchantAdapter';
export const MerchantNormalizer = 'oryx.MerchantNormalizer*';
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
export * from './merchant.normalizer';
export * from './offer.normalizer';
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import {
ApiMerchantModel,
Merchant,
MerchantLegal,
MerchantSchedule,
MerchantScheduleSlot,
} from '../../merchant.model';
import { ApiMerchantModel } from '../../merchant.model.api';
} from '../../../models';

function normalizeOpeningHours(
hours: ApiMerchantModel.MerchantOpeningHours
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
import { Transformer, TransformerService } from '@spryker-oryx/core';
import { AvailabilityNormalizer, PriceNormalizer } from '@spryker-oryx/product';
import { Observable, map } from 'rxjs';
import { MerchantNormalizer } from '../../../../merchant';
import { ApiMerchantModel } from '../../../../merchant/merchant.model.api';
import { ProductOffer } from '../../../../models';
import {
AvailabilityNormalizer,
DeserializedProduct,
PriceNormalizer,
Product,
ProductOffer,
} from '@spryker-oryx/product';
import { Observable, combineLatest, map, of } from 'rxjs';
import { ApiMerchantModel } from '../../../models';
import { MerchantNormalizer } from '../merchant.adapter';

export const OfferNormalizer = 'oryx.OfferNormalizer*';

Expand Down Expand Up @@ -43,6 +48,25 @@ export function offerMerchantNormalizer(
.pipe(map((merchant) => ({ merchant })));
}

export function productOfferNormalizer(
data: DeserializedProduct, // source
transformer: TransformerService
): Observable<Partial<Product>> {
const offers = data.productOffers as any as ApiMerchantModel.ProductOffer[];

if (!offers?.length) return of({});

return combineLatest(
offers.map((offer) => transformer.transform(offer, OfferNormalizer))
).pipe(
map((offers) => {
const defaultOffer = offers.find((offer) => offer.isDefault);
const price = defaultOffer?.price;
return { offers, ...(price ? { price } : {}) };
})
);
}

declare global {
interface InjectionTokensContractMap {
[OfferNormalizer]: Transformer<ProductOffer>;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { injectQuery, QueryState } from '@spryker-oryx/core';
import { Observable } from 'rxjs';
import { Merchant, MerchantQualifier } from './merchant.model';
import { Merchant, MerchantQualifier } from '../models';
import { MerchantService } from './merchant.service';
import { MerchantQuery } from './state';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ export * from './adapter';
export * from './default-merchant.service';
export * from './merchant.context';
export * from './merchant.service';
export * from './mixins';
export * from './providers';
export * from './routes';
export * from './state';
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { QueryState } from '@spryker-oryx/core';
import { Observable } from 'rxjs';
import { Merchant, MerchantQualifier } from './merchant.model';
import { Merchant, MerchantQualifier } from '../models';

export interface MerchantService {
get(qualifier: MerchantQualifier): Observable<Merchant | undefined>;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,47 @@
import { Provider } from '@spryker-oryx/di';
import { ProductNormalizer } from '@spryker-oryx/product';
import { provideLitRoutes } from '@spryker-oryx/router/lit';
import {
DefaultMerchantAdapter,
MerchantAdapter,
MerchantNormalizer,
OfferNormalizer,
productOfferNormalizer,
} from './adapter';
import { merchantNormalizer } from './adapter/normalizers';
import {
offerAvailabilityNormalizer,
offerMerchantNormalizer,
offerNormalizer,
offerPriceNormalizer,
} from './adapter/normalizers/offer.normalizer';
import { DefaultMerchantService } from './default-merchant.service';
import { MerchantContextFallback } from './merchant.context';
import { MerchantService } from './merchant.service';
import { merchantRoutes } from './routes';
import { merchantQueries, merchantsEffects } from './state';

export const merchantProviders: Provider[] = [
{
provide: OfferNormalizer,
useValue: offerNormalizer,
},
{
provide: OfferNormalizer,
useValue: offerPriceNormalizer,
},
{
provide: OfferNormalizer,
useValue: offerAvailabilityNormalizer,
},
{
provide: OfferNormalizer,
useValue: offerMerchantNormalizer,
},
{
provide: ProductNormalizer,
useValue: productOfferNormalizer,
},
{
provide: MerchantAdapter,
useClass: DefaultMerchantAdapter,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
import { provideEffect, QueryService } from '@spryker-oryx/core';
import { ProductOffer } from '../../models';
import { ProductLoaded, ProductsLoaded } from '../../services/state/events';
import {
ProductLoaded,
ProductOffer,
ProductsLoaded,
} from '@spryker-oryx/product';
import { MerchantQuery } from './queries';

function setMerchant(query: QueryService, offer: ProductOffer) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { provideQuery, Query } from '@spryker-oryx/core';
import { inject } from '@spryker-oryx/di';
import { EMPTY } from 'rxjs';
import { Merchant, MerchantQualifier } from '../../models';
import { MerchantAdapter } from '../adapter';
import { Merchant, MerchantQualifier } from '../merchant.model';

export const MerchantQuery = 'oryx.merchantQuery';

Expand Down
Loading
Loading