@daffodil/product-composite 0.58.10 → 0.59.0

package/models/selection-payload.type.d.ts

@@ -0,0 +1,5 @@
+import { DaffCompositeProductItem, DaffCompositeProductItemOption } from './composite-product-item';
+/**
+ * Denotes a particular configuration for a composite item.
+ */
+export declare type DaffProductCompositeSelectionPayload = Record<DaffCompositeProductItem['id'], DaffCompositeProductItemOption['id'][]>;

package/package.json

@@ -9,7 +9,7 @@
       }
     }
   },
-  "version": "0.58.10",
+  "version": "0.59.0",
   "description": "Interfaces built for daffodil/state",
   "repository": {
     "type": "git",
@@ -27,8 +27,8 @@
   "peerDependencies": {
     "@angular/common": "^13.0.0",
     "@angular/core": "^13.0.0",
-    "@daffodil/core": "0.58.10",
-    "@daffodil/product": "0.58.10",
+    "@daffodil/core": "0.59.0",
+    "@daffodil/product": "0.59.0",
     "@ngrx/effects": "^13.0.0",
     "@ngrx/entity": "^13.0.0",
     "@ngrx/store": "^13.0.0",
@@ -36,8 +36,8 @@
   },
   "optionalDependencies": {
     "@apollo/client": "^3.0.0",
-    "@daffodil/driver": "0.58.10",
-    "@daffodil/product": "0.58.10",
+    "@daffodil/driver": "0.59.0",
+    "@daffodil/product": "0.59.0",
     "angular-in-memory-web-api": "^0.13.0",
     "apollo-angular": "^3.0.1",
     "@faker-js/faker": "^7.6.0"
@@ -92,6 +92,14 @@
       "node": "./fesm2015/daffodil-product-composite-driver-testing.mjs",
       "default": "./fesm2020/daffodil-product-composite-driver-testing.mjs"
     },
+    "./routing": {
+      "types": "./routing/daffodil-product-composite-routing.d.ts",
+      "esm2020": "./esm2020/routing/daffodil-product-composite-routing.mjs",
+      "es2020": "./fesm2020/daffodil-product-composite-routing.mjs",
+      "es2015": "./fesm2015/daffodil-product-composite-routing.mjs",
+      "node": "./fesm2015/daffodil-product-composite-routing.mjs",
+      "default": "./fesm2020/daffodil-product-composite-routing.mjs"
+    },
     "./state": {
       "types": "./state/daffodil-product-composite-state.d.ts",
       "esm2020": "./esm2020/state/daffodil-product-composite-state.mjs",

package/public_api.d.ts

@@ -1,3 +1,2 @@
-export * from './models/composite-configuration-item';
-export * from './models/composite-product';
-export * from './models/composite-product-item';
+export * from './helpers/public_api';
+export * from './models/public_api';

package/routing/config/default.d.ts

@@ -0,0 +1,6 @@
+import { DaffBase64Service } from '@daffodil/core';
+import { DaffProductCompositeRoutingConfig } from './interface';
+/**
+ * The default configuration for the {@link DaffProductCompositeRoutingConfig}.
+ */
+export declare const daffProductCompositeRoutingConfigDefaultFactory: (base64: DaffBase64Service) => DaffProductCompositeRoutingConfig;

package/routing/config/interface.d.ts

@@ -0,0 +1,20 @@
+import { DaffCompositeProduct, DaffProductCompositeSelectionPayload } from '@daffodil/product-composite';
+/**
+ * An interface for providing `@daffodil/product-composite/routing` with necessary config values.
+ */
+export interface DaffProductCompositeRoutingConfig {
+    /**
+     * The name of the query param for which a composite product page preselection can be defined.
+     * The value of this query param should be a {@link DaffProductCompositeSelectionPayload} after being base64 decoded and JSON parsed.
+     *
+     * Defaults to `composite_selection`.
+     */
+    compositeSelectionQueryParam?: string;
+    /**
+     * The function used to decode the value of the {@link DaffProductCompositeStateConfig#compositeSelectionQueryParam}
+     * into a {@link DaffProductCompositeSelectionPayload}.
+     *
+     * Defaults to `(queryParam: string) => JSON.parse(atob(queryParam))`.
+     */
+    compositeSelectionQueryParamDecode?: (queryParam: string, product: DaffCompositeProduct) => DaffProductCompositeSelectionPayload;
+}

package/routing/config/public_api.d.ts

@@ -0,0 +1,3 @@
+export { daffProductCompositeRoutingConfigDefaultFactory } from './default';
+export { DaffProductCompositeRoutingConfig } from './interface';
+export { DAFF_PRODUCT_COMPOSITE_ROUTING_CONFIG, daffProductCompositeRoutingProvideConfig, } from './token';

package/routing/config/token.d.ts

@@ -0,0 +1,10 @@
+import { FactoryProvider, InjectionToken } from '@angular/core';
+import { DaffProductCompositeRoutingConfig } from './interface';
+/**
+ * The token used to provide @daffodil/product-composite/routing config data.
+ */
+export declare const DAFF_PRODUCT_COMPOSITE_ROUTING_CONFIG: InjectionToken<DaffProductCompositeRoutingConfig>;
+/**
+ * Provides the {@link DAFF_PRODUCT_COMPOSITE_ROUTING_CONFIG} token.
+ */
+export declare function daffProductCompositeRoutingProvideConfig(config: Partial<DaffProductCompositeRoutingConfig>): FactoryProvider;

package/routing/daffodil-product-composite-routing.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
+/// <amd-module name="@daffodil/product-composite/routing" />
+export * from './index';

package/routing/effects/product-page.effects.d.ts

@@ -0,0 +1,26 @@
+import { ActivatedRoute } from '@angular/router';
+import { Actions } from '@ngrx/effects';
+import { EMPTY, Observable } from 'rxjs';
+import { DaffCompositeProduct } from '@daffodil/product-composite';
+import { DaffCompositeProductApplyOption } from '@daffodil/product-composite/state';
+import { DaffProductCompositeRoutingConfig } from '../config/public_api';
+import * as i0 from "@angular/core";
+/**
+ * Handles composite product specific actions for the product page.
+ */
+export declare class DaffProductCompositePageEffects<T extends DaffCompositeProduct = DaffCompositeProduct> {
+    private actions$;
+    private route;
+    private config;
+    constructor(actions$: Actions, route: ActivatedRoute, config: DaffProductCompositeRoutingConfig);
+    /**
+     * Get the value of the configured composite selection query param.
+     */
+    private getQueryParam;
+    /**
+     * Applies composite item options based on the value of the configured query param.
+     */
+    preselectCompositeOptions$: Observable<typeof EMPTY | DaffCompositeProductApplyOption<T>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DaffProductCompositePageEffects<any>, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DaffProductCompositePageEffects<any>>;
+}

package/routing/effects/public_api.d.ts

@@ -0,0 +1 @@
+export { DaffProductCompositePageEffects } from './product-page.effects';

package/routing/index.d.ts

@@ -0,0 +1 @@
+export * from './public_api';

package/routing/module.d.ts

@@ -0,0 +1,10 @@
+import { ModuleWithProviders } from '@angular/core';
+import { DaffProductCompositeRoutingConfig } from './config/public_api';
+import * as i0 from "@angular/core";
+import * as i1 from "@ngrx/effects";
+export declare class DaffProductCompositeRoutingModule {
+    static withConfig(config?: DaffProductCompositeRoutingConfig): ModuleWithProviders<DaffProductCompositeRoutingModule>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DaffProductCompositeRoutingModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<DaffProductCompositeRoutingModule, never, [typeof i1.EffectsFeatureModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<DaffProductCompositeRoutingModule>;
+}

package/routing/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@daffodil/product-composite/routing",
+  "module": "../fesm2015/daffodil-product-composite-routing.mjs",
+  "es2020": "../fesm2020/daffodil-product-composite-routing.mjs",
+  "esm2020": "../esm2020/routing/daffodil-product-composite-routing.mjs",
+  "fesm2020": "../fesm2020/daffodil-product-composite-routing.mjs",
+  "fesm2015": "../fesm2015/daffodil-product-composite-routing.mjs",
+  "typings": "daffodil-product-composite-routing.d.ts",
+  "sideEffects": false
+}

package/routing/public_api.d.ts

@@ -0,0 +1,3 @@
+export * from './config/public_api';
+export * from './effects/public_api';
+export * from './module';

package/state/actions/composite-product.actions.d.ts

@@ -13,7 +13,7 @@ export declare enum DaffCompositeProductActionTypes {
  * @param itemId - Id of the product item.
  * @param optionId - Id of the option of the product item that is chosen.
  */
-export declare class DaffCompositeProductApplyOption<T extends DaffCompositeProduct> implements Action {
+export declare class DaffCompositeProductApplyOption<T extends DaffCompositeProduct = DaffCompositeProduct> implements Action {
     id: T['id'];
     itemId: DaffCompositeProductItem['id'];
     optionId: DaffCompositeProductItemOption['id'];

package/testing/factories/composite-product-item-option.factory.d.ts

@@ -0,0 +1,19 @@
+import { DaffModelFactory } from '@daffodil/core/testing';
+import { DaffCompositeProductItemOption } from '@daffodil/product-composite';
+import { MockProduct } from '@daffodil/product/testing';
+import * as i0 from "@angular/core";
+/**
+ * Mocked DaffCompositeProductItemOption object.
+ */
+export declare class MockCompositeProductItemOption extends MockProduct implements DaffCompositeProductItemOption {
+    quantity: number;
+    is_default: boolean;
+}
+/**
+ * Factory for creating DaffCompositeProductItemOptions.
+ */
+export declare class DaffCompositeProductItemOptionFactory extends DaffModelFactory<DaffCompositeProductItemOption> {
+    constructor();
+    static ɵfac: i0.ɵɵFactoryDeclaration<DaffCompositeProductItemOptionFactory, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DaffCompositeProductItemOptionFactory>;
+}

package/testing/factories/composite-product-item.factory.d.ts

@@ -0,0 +1,25 @@
+import { DaffModelFactory } from '@daffodil/core/testing';
+import { DaffCompositeProductItem, DaffCompositeProductItemInputEnum } from '@daffodil/product-composite';
+import { DaffCompositeProductItemOptionFactory } from './composite-product-item-option.factory';
+import * as i0 from "@angular/core";
+/**
+ * Mocked DaffCompositeProductItem object.
+ */
+export declare class MockCompositeProductItem implements DaffCompositeProductItem {
+    protected optionFactory: DaffCompositeProductItemOptionFactory;
+    id: string;
+    url: string;
+    required: boolean;
+    title: string;
+    input_type: DaffCompositeProductItemInputEnum;
+    options: import("@daffodil/product-composite").DaffCompositeProductItemOption[];
+    constructor(optionFactory: DaffCompositeProductItemOptionFactory);
+}
+/**
+ * Factory for creating DaffCompositeProductItems.
+ */
+export declare class DaffCompositeProductItemFactory extends DaffModelFactory<DaffCompositeProductItem> {
+    constructor(optionFactory: DaffCompositeProductItemOptionFactory);
+    static ɵfac: i0.ɵɵFactoryDeclaration<DaffCompositeProductItemFactory, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DaffCompositeProductItemFactory>;
+}

package/testing/factories/composite-product.factory.d.ts

@@ -1,46 +1,23 @@
 import { DaffModelFactory } from '@daffodil/core/testing';
 import { DaffProductTypeEnum } from '@daffodil/product';
-import { DaffCompositeProduct, DaffCompositeProductItemInputEnum } from '@daffodil/product-composite';
+import { DaffCompositeProduct } from '@daffodil/product-composite';
 import { MockProduct } from '@daffodil/product/testing';
+import { DaffCompositeProductItemFactory } from './composite-product-item.factory';
 import * as i0 from "@angular/core";
 /**
  * Mocked DaffCompositeProduct object.
- *
- * @deprecated import from @daffodil/product-composite/testing instead.
  */
 export declare class MockCompositeProduct extends MockProduct implements DaffCompositeProduct {
+    protected itemFactory: DaffCompositeProductItemFactory;
     type: DaffProductTypeEnum;
-    items: {
-        id: string;
-        url: string;
-        required: boolean;
-        title: string;
-        input_type: DaffCompositeProductItemInputEnum;
-        options: {
-            id: string;
-            type: DaffProductTypeEnum;
-            url: string;
-            name: string;
-            price: number;
-            images: any[];
-            thumbnail: any;
-            discount: {
-                amount: number;
-                percent: number;
-            };
-            quantity: number;
-            is_default: boolean;
-            in_stock: boolean;
-            related: any[];
-            upsell: any[];
-        }[];
-    }[];
+    items: import("@daffodil/product-composite").DaffCompositeProductItem[];
+    constructor(itemFactory: DaffCompositeProductItemFactory);
 }
 /**
  * Factory for creating DaffCompositeProducts.
  */
 export declare class DaffCompositeProductFactory extends DaffModelFactory<DaffCompositeProduct> {
-    constructor();
+    constructor(itemFactory: DaffCompositeProductItemFactory);
     static ɵfac: i0.ɵɵFactoryDeclaration<DaffCompositeProductFactory, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<DaffCompositeProductFactory>;
 }

package/testing/factories/public_api.d.ts

@@ -1 +1,3 @@
 export * from './composite-product.factory';
+export * from './composite-product-item.factory';
+export * from './composite-product-item-option.factory';