@daffodil/category 0.75.0 → 0.76.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +20 -8
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,15 +1,27 @@
1
1
  # @daffodil/category
2
+ `@daffodil/category` manages the graphQL calls, state, selectors, and models for single category calls.
2
3
 
3
- Building and maintaining a model and code for an ecommerce store is complex and mentally taxing. `@daffodil/category`
4
- provides clear interfaces, models, and factories for the frontend of an ecommerce store so that you don't have to.
5
-
6
- The category module manages the graphQL calls, state, selectors, and models for single category calls. Requests for a category should be made with a `DaffCategoryLoad(id)` action through the `DaffCategoryFacade`. Selection of the retrieved category and its loading state can also be done through the `DaffCategoryFacade` with the `category$` and `loading$` attributes.
7
-
8
- Right now, the `@daffodil/category` package supports an in-memory for developing locally and a magento driver.
4
+ ## Overview
5
+ `@daffodil/category` currently supports both a Magento driver and an in-memory driver for local development.
9
6
 
10
7
  ## Installation
8
+ To install `@daffodil/category`, use the following commands in the terminal.
9
+
10
+ Install with npm:
11
+ ```bash
12
+ npm install @daffodil/category --save
11
13
  ```
12
- npm install @daffodil/category
14
+
15
+ Install with yarn:
16
+
17
+ ```bash
18
+ yarn add @daffodil/category
13
19
  ```
14
20
 
15
- To use the `@daffodil/category` with an `in-memory-web-api`, import the `DaffCategoryInMemoryDriverModule.forRoot()` into your app.module. To use the `@daffodil/category` with a magento backend, import the `DaffCategoryMagentoDriverModule.forRoot()` into your app.module.
21
+ ## Getting started
22
+
23
+ ### Using in-memory web API
24
+ Import the `DaffCategoryInMemoryDriverModule.forRoot()` into your root component.
25
+
26
+ ### Using Magento backend
27
+ Import the `DaffCategoryMagentoDriverModule.forRoot()` into your root component.
package/package.json CHANGED
@@ -1 +1 @@
1
- {"name":"@daffodil/category","nx":{"targets":{"build":{"outputs":["{workspaceRoot}/dist/category"]}}},"version":"0.75.0","description":"An ecommerce categories package that has multi-platform support and state management features.","repository":{"type":"git","url":"https://github.com/graycoreio/daffodil"},"author":"Graycore LLC","license":"MIT","bugs":{"url":"https://github.com/graycoreio/daffodil/issues"},"publishConfig":{"directory":"../../dist/category"},"homepage":"https://github.com/graycoreio/daffodil","peerDependencies":{"@angular/common":"^17.0.0","@angular/core":"^17.0.0","@daffodil/core":"0.75.0","@daffodil/product":"0.75.0","@ngrx/effects":"^17.0.0","@ngrx/entity":"^17.0.0","@ngrx/store":"^17.0.0","rxjs":"7.8.1"},"optionalDependencies":{"@apollo/client":"^3.0.0","@daffodil/driver":"0.75.0","angular-in-memory-web-api":"^0.17.0","apollo-angular":"^6.0.0","@faker-js/faker":"^7.6.0"},"module":"fesm2022/daffodil-category.mjs","typings":"index.d.ts","exports":{"./package.json":{"default":"./package.json"},".":{"types":"./index.d.ts","esm2022":"./esm2022/daffodil-category.mjs","esm":"./esm2022/daffodil-category.mjs","default":"./fesm2022/daffodil-category.mjs"},"./driver":{"types":"./driver/index.d.ts","esm2022":"./esm2022/driver/daffodil-category-driver.mjs","esm":"./esm2022/driver/daffodil-category-driver.mjs","default":"./fesm2022/daffodil-category-driver.mjs"},"./routing":{"types":"./routing/index.d.ts","esm2022":"./esm2022/routing/daffodil-category-routing.mjs","esm":"./esm2022/routing/daffodil-category-routing.mjs","default":"./fesm2022/daffodil-category-routing.mjs"},"./state":{"types":"./state/index.d.ts","esm2022":"./esm2022/state/daffodil-category-state.mjs","esm":"./esm2022/state/daffodil-category-state.mjs","default":"./fesm2022/daffodil-category-state.mjs"},"./testing":{"types":"./testing/index.d.ts","esm2022":"./esm2022/testing/daffodil-category-testing.mjs","esm":"./esm2022/testing/daffodil-category-testing.mjs","default":"./fesm2022/daffodil-category-testing.mjs"},"./driver/in-memory":{"types":"./driver/in-memory/index.d.ts","esm2022":"./esm2022/driver/in-memory/daffodil-category-driver-in-memory.mjs","esm":"./esm2022/driver/in-memory/daffodil-category-driver-in-memory.mjs","default":"./fesm2022/daffodil-category-driver-in-memory.mjs"},"./driver/magento":{"types":"./driver/magento/index.d.ts","esm2022":"./esm2022/driver/magento/daffodil-category-driver-magento.mjs","esm":"./esm2022/driver/magento/daffodil-category-driver-magento.mjs","default":"./fesm2022/daffodil-category-driver-magento.mjs"},"./driver/testing":{"types":"./driver/testing/index.d.ts","esm2022":"./esm2022/driver/testing/daffodil-category-driver-testing.mjs","esm":"./esm2022/driver/testing/daffodil-category-driver-testing.mjs","default":"./fesm2022/daffodil-category-driver-testing.mjs"},"./state/testing":{"types":"./state/testing/index.d.ts","esm2022":"./esm2022/state/testing/daffodil-category-state-testing.mjs","esm":"./esm2022/state/testing/daffodil-category-state-testing.mjs","default":"./fesm2022/daffodil-category-state-testing.mjs"},"./driver/magento/testing":{"types":"./driver/magento/testing/index.d.ts","esm2022":"./esm2022/driver/magento/testing/daffodil-category-driver-magento-testing.mjs","esm":"./esm2022/driver/magento/testing/daffodil-category-driver-magento-testing.mjs","default":"./fesm2022/daffodil-category-driver-magento-testing.mjs"}},"sideEffects":false,"dependencies":{"tslib":"^2.3.0"}}
1
+ {"name":"@daffodil/category","nx":{"targets":{"build":{"outputs":["{workspaceRoot}/dist/category"]}}},"version":"0.76.0","description":"An ecommerce categories package that has multi-platform support and state management features.","repository":{"type":"git","url":"https://github.com/graycoreio/daffodil"},"author":"Graycore LLC","license":"MIT","bugs":{"url":"https://github.com/graycoreio/daffodil/issues"},"publishConfig":{"directory":"../../dist/category"},"homepage":"https://github.com/graycoreio/daffodil","peerDependencies":{"@angular/common":"^17.0.0","@angular/core":"^17.0.0","@daffodil/core":"0.76.0","@daffodil/product":"0.76.0","@ngrx/effects":"^17.0.0","@ngrx/entity":"^17.0.0","@ngrx/store":"^17.0.0","rxjs":"7.8.1"},"optionalDependencies":{"@apollo/client":"^3.0.0","@daffodil/driver":"0.76.0","angular-in-memory-web-api":"^0.17.0","apollo-angular":"^6.0.0","@faker-js/faker":"^7.6.0"},"module":"fesm2022/daffodil-category.mjs","typings":"index.d.ts","exports":{"./package.json":{"default":"./package.json"},".":{"types":"./index.d.ts","esm2022":"./esm2022/daffodil-category.mjs","esm":"./esm2022/daffodil-category.mjs","default":"./fesm2022/daffodil-category.mjs"},"./driver":{"types":"./driver/index.d.ts","esm2022":"./esm2022/driver/daffodil-category-driver.mjs","esm":"./esm2022/driver/daffodil-category-driver.mjs","default":"./fesm2022/daffodil-category-driver.mjs"},"./routing":{"types":"./routing/index.d.ts","esm2022":"./esm2022/routing/daffodil-category-routing.mjs","esm":"./esm2022/routing/daffodil-category-routing.mjs","default":"./fesm2022/daffodil-category-routing.mjs"},"./state":{"types":"./state/index.d.ts","esm2022":"./esm2022/state/daffodil-category-state.mjs","esm":"./esm2022/state/daffodil-category-state.mjs","default":"./fesm2022/daffodil-category-state.mjs"},"./testing":{"types":"./testing/index.d.ts","esm2022":"./esm2022/testing/daffodil-category-testing.mjs","esm":"./esm2022/testing/daffodil-category-testing.mjs","default":"./fesm2022/daffodil-category-testing.mjs"},"./driver/in-memory":{"types":"./driver/in-memory/index.d.ts","esm2022":"./esm2022/driver/in-memory/daffodil-category-driver-in-memory.mjs","esm":"./esm2022/driver/in-memory/daffodil-category-driver-in-memory.mjs","default":"./fesm2022/daffodil-category-driver-in-memory.mjs"},"./driver/magento":{"types":"./driver/magento/index.d.ts","esm2022":"./esm2022/driver/magento/daffodil-category-driver-magento.mjs","esm":"./esm2022/driver/magento/daffodil-category-driver-magento.mjs","default":"./fesm2022/daffodil-category-driver-magento.mjs"},"./driver/testing":{"types":"./driver/testing/index.d.ts","esm2022":"./esm2022/driver/testing/daffodil-category-driver-testing.mjs","esm":"./esm2022/driver/testing/daffodil-category-driver-testing.mjs","default":"./fesm2022/daffodil-category-driver-testing.mjs"},"./state/testing":{"types":"./state/testing/index.d.ts","esm2022":"./esm2022/state/testing/daffodil-category-state-testing.mjs","esm":"./esm2022/state/testing/daffodil-category-state-testing.mjs","default":"./fesm2022/daffodil-category-state-testing.mjs"},"./driver/magento/testing":{"types":"./driver/magento/testing/index.d.ts","esm2022":"./esm2022/driver/magento/testing/daffodil-category-driver-magento-testing.mjs","esm":"./esm2022/driver/magento/testing/daffodil-category-driver-magento-testing.mjs","default":"./fesm2022/daffodil-category-driver-magento-testing.mjs"}},"sideEffects":false,"dependencies":{"tslib":"^2.3.0"}}