Merge pull request #30 from empathyco/feature/EX-3850-add-search-types

Feature/ex 3850 add search types

packages/search-types/.gitignore

@@ -0,0 +1,30 @@
+.DS_Store
+node_modules
+/dist
+/report
+/types
+/temp
+/docs
+/schemas
+/*.tgz
+
+/tests/e2e/reports/
+selenium-debug.log
+
+# local env files
+.env.local
+.env.*.local
+
+# Log files
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Editor directories and files
+.idea
+.vscode
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw*

packages/search-types/BREAKING-CHANGES.md

@@ -0,0 +1,52 @@
+# Changelog
+
+## 9.0.0
+
+> EX-3917 Change `HierarchicalFilter` `children` prop to be optional.
+
+## 8.0.0
+
+> EX-3347 Remove `MultiSelect` model.
+> 
+> EX-3300 Transform `Sort` model into a string.
+> 
+> EX-3300 Remove `SortDirection` enum.
+
+## 7.0.0
+
+> EX-3222 Add `EditableNumberRangeFilter` model to represent range filters that the user can mutate its value.
+>
+> EX-3222 Add `BooleanFilter` model to share the properties of filters that the user can select or deselect. `SimpleFilter`, `HierarchicalFilter` and `NumberRangeFilter` now extend from `BooleanFilter`.
+>
+> EX-3222 `selected`, `totalResults` and `value` properties have been moved to `BooleanFilter` from `Filter`. It's necessary to replace `Filter` type references with `BooleanFilter`. Filters and facets schemas have been replaced accordingly.
+
+## 6.0.0
+
+> EX-2521 Remove `BaseFilter` and `Facet` from the possible model names.
+>
+> EX-2320 Split the facet model into `Facet`, `SimpleFacet`, `HierarchicalFacet` and `RangeFacet`.
+>
+> EX-2320 Split the filter model into `Filter`, `SimpleFilter`, `HierarchicalFilter` and `RangeFilter`. The `Filter` changed the `value` to be always unknown and the `HierarchicalFilter` changed the `parent` and the `facet` properties to be identifier strings.
+
+## 5.0.0
+
+> EX-1837 Changed next query schema facets to be an array instead of an object.
+>
+> EX-1693 Renamed `term` property to`query` in `HistoryTerm`, `PartialResult` and `Suggestion` models. 
+>
+> EX-1693 Renamed `resultsFacets` property to `facets` in `NextQuery` model.
+>
+> EX-1693 Renamed `HistoryTerm` model to `HistoryQuery`,
+>
+> EX-1693 Renamed `numFound` property to `totalResults` in `PartialResult` and `NextQuery` models.
+>
+> EX-1693 Remove `id` property from `NextQuery` model. The `query` should be unique, and can be used instead.
+>
+> EX-1693 Remove `html` field from `Suggestion` and `ResultIdentifier` models. This field should be calculated in the component that consumes the suggestion.
+
+## 4.0.0
+
+> EX-1437 Update TypeScript version to `^3.7.2`
+>
+> EX-1437 Concatenate types in a single file. Projects that augment the types of this project must update the files location.
+

packages/search-types/README.md

@@ -0,0 +1,77 @@
+# Changelog
+
+## 9.0.0 - 2021/05/19
+
+> EX-3917 Change `HierarchicalFilter` `children` prop to be optional.
+
+## 8.0.0 - 2021/04/16
+
+> EX-3347 Remove `MultiSelect` model.
+> 
+> EX-3347 Add type guards for filters and facets models.
+> 
+> EX-3347 Change `BooleanFilterModelName` to support any string.
+> 
+> EX-3300 Transform `Sort` model into a string.
+> 
+> EX-3473 Make `BooleanFilter`'s `totalResults` property optional.
+
+## 7.0.0 - 2021/03/03
+
+> EX-3291 Add `Identifiable` interface to  `Banner`, `Facet`, `Filter`, `Next-queries`, `Promoted`, `Redirection` and `Result`.
+> 
+> EX-3222 Add `BooleanFilter` and `EditableNumberRange`.
+>
+> EX-3222 Add `Banner` and `Promoted` to `ModelNameType`.
+
+## 6.0.0 - 2020/01/07
+
+> EX-2521 Remove `BaseFilter` and `Facet` from the possible model names.
+>
+> EX-2479 Added FacetModelName and FilterModelName types.
+>
+> EX-2447 Support null value in `parentId` for the `HierarchicalFilter` model.
+>
+> EX-2320 Refactor Facet & Filter models, renaming fields and splitting in different subtypes.
+
+## 5.0.1 - 2020/09/18
+
+> EX-2152 Fix api-extractor doc model and improve build
+
+## 5.0.0 - 2020/07/30
+
+> EX-1875 Close tags within the documentation between backslashes
+>
+> EX-1843 Add ESM build keeping also the old CommonJS
+>
+> EX-1837 Changed next query schema facets to be an array instead of an object.
+>
+> EX-1693 Unified Suggestion like models properties (RelatedTag, NextQuery, Suggestion, HistoryTerm, PartialResult)
+>
+> EX-1161 Add type to the attribute `modelName` in the interface `NamedModel`
+
+## 4.0.0 - 2020/02/04
+
+> EX-1506 Add `isWishlisted` field to result model
+>
+> EX-1437 Add RollupJS build process with document support
+>
+> EX-1437 Concatenate types in a single file
+
+## 3.1.1
+
+> EX-1540 Update `@empathy/jest-utils` to use minor version
+
+## 3.1.0
+
+> EX-1454 Add optional `callbackInfo` object to Promoted, Banner and Result models
+
+## 3.0.0
+
+> EX-1276 Add `checkout` to `ResultTagging` model
+>
+> EX-1355 Removed `preselected` property from `Facet`
+
+## 2.0.0
+
+> EX-1240 Removed `entityDetected` and `needParentFilter` properties from `Filter`

packages/search-types/api-extractor.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "mainEntryPointFilePath": "<projectFolder>/temp/types/api-extractor.d.ts",
+  "apiReport": {
+    "enabled": true,
+    "reportFolder": "<projectFolder>/report"
+  },
+  "docModel": {
+    "enabled": true,
+    "apiJsonFilePath": "<projectFolder>/report/<unscopedPackageName>.api.json"
+  },
+  "dtsRollup": {
+    "enabled": false
+  },
+  "tsdocMetadata": {
+    "enabled": true,
+    "tsdocMetadataFilePath": "<projectFolder>/report/tsdoc-metadata.json"
+  }
+}
+