@empathyco/x-components 3.0.0-alpha.201 → 3.0.0-alpha.202

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.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,15 @@
3
3
  All notable changes to this project will be documented in this file. See
4
4
  [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [3.0.0-alpha.202](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.201...@empathyco/x-components@3.0.0-alpha.202) (2022-10-24)
7
+
8
+ **Note:** Version bump only for package @empathyco/x-components
9
+
10
+ # Change Log
11
+
12
+ All notable changes to this project will be documented in this file. See
13
+ [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
14
+
6
15
  ## [3.0.0-alpha.201](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.200...@empathyco/x-components@3.0.0-alpha.201) (2022-10-21)
7
16
 
8
17
  ### ⚠ BREAKING CHANGES
@@ -114,6 +114,13 @@
114
114
  --x-size-border-radius-bottom-left-button-card
115
115
  );
116
116
  }
117
+ :root {
118
+ --x-size-border-radius-button-card: var(--x-size-border-radius-base-s);
119
+ --x-size-border-radius-top-left-button-card: var(--x-size-border-radius-button-card);
120
+ --x-size-border-radius-top-right-button-card: var(--x-size-border-radius-button-card);
121
+ --x-size-border-radius-bottom-right-button-card: var(--x-size-border-radius-button-card);
122
+ --x-size-border-radius-bottom-left-button-card: var(--x-size-border-radius-button-card);
123
+ }
117
124
  [dir="ltr"] .x-button {
118
125
  padding-right: var(--x-size-padding-right-button-default);
119
126
  }
@@ -7485,11 +7492,3 @@
7485
7492
  .x-normal-case {
7486
7493
  text-transform: none;
7487
7494
  }
7488
-
7489
- :root {
7490
- --x-size-border-radius-button-card: var(--x-size-border-radius-base-s);
7491
- --x-size-border-radius-top-left-button-card: var(--x-size-border-radius-button-card);
7492
- --x-size-border-radius-top-right-button-card: var(--x-size-border-radius-button-card);
7493
- --x-size-border-radius-bottom-right-button-card: var(--x-size-border-radius-button-card);
7494
- --x-size-border-radius-bottom-left-button-card: var(--x-size-border-radius-button-card);
7495
- }
@@ -9,14 +9,14 @@ Returns the facet's config.
9
9
  <b>Signature:</b>
10
10
 
11
11
  ```typescript
12
- export declare function getFacetConfig(facet: string): FacetConfig;
12
+ export declare function getFacetConfig(type: PlatformFacetType): FacetConfig;
13
13
  ```
14
14
 
15
15
  ## Parameters
16
16
 
17
17
  | Parameter | Type | Description |
18
18
  | --- | --- | --- |
19
- | facet | string | The facet to resolve the configuration. |
19
+ | type | [PlatformFacetType](./x-adapter-platform.platformfacettype.md) | The facet type to resolve the configuration. |
20
20
 
21
21
  <b>Returns:</b>
22
22
 
@@ -9,7 +9,7 @@
9
9
  | Function | Description |
10
10
  | --- | --- |
11
11
  | [extractUrlParameters(url)](./x-adapter-platform.extracturlparameters.md) | Returns the base url path and an object with the query parameters. |
12
- | [getFacetConfig(facet)](./x-adapter-platform.getfacetconfig.md) | Returns the facet's config. |
12
+ | [getFacetConfig(type)](./x-adapter-platform.getfacetconfig.md) | Returns the facet's config. |
13
13
  | [getTaggingInfoFromUrl(taggingUrl)](./x-adapter-platform.gettagginginfofromurl.md) | Extracts the tagging info from a URL. |
14
14
 
15
15
  ## Interfaces
@@ -17,7 +17,6 @@
17
17
  | Interface | Description |
18
18
  | --- | --- |
19
19
  | [FacetConfig](./x-adapter-platform.facetconfig.md) | Facet configuration containing the model name and the schema. |
20
- | [FacetsConfig](./x-adapter-platform.facetsconfig.md) | Dictionary grouping facets configurations. |
21
20
  | [PlatformAdapter](./x-adapter-platform.platformadapter.md) | |
22
21
  | [PlatformBanner](./x-adapter-platform.platformbanner.md) | Banner model for the <code>platform</code> API. |
23
22
  | [PlatformFacet](./x-adapter-platform.platformfacet.md) | Facet model for the <code>platform</code> API. |
@@ -52,7 +51,6 @@
52
51
  | --- | --- |
53
52
  | [bannerSchema](./x-adapter-platform.bannerschema.md) | |
54
53
  | [facetSchema](./x-adapter-platform.facetschema.md) | |
55
- | [facetsConfig](./x-adapter-platform.facetsconfig.md) | |
56
54
  | [hierarchicalFilterSchema](./x-adapter-platform.hierarchicalfilterschema.md) | |
57
55
  | [identifierResultsEndpointAdapter](./x-adapter-platform.identifierresultsendpointadapter.md) | |
58
56
  | [identifierResultsRequestMapper](./x-adapter-platform.identifierresultsrequestmapper.md) | |
@@ -102,3 +100,9 @@
102
100
  | [taggingEndpointAdapter](./x-adapter-platform.taggingendpointadapter.md) | |
103
101
  | [taggingRequestMapper](./x-adapter-platform.taggingrequestmapper.md) | |
104
102
 
103
+ ## Type Aliases
104
+
105
+ | Type Alias | Description |
106
+ | --- | --- |
107
+ | [PlatformFacetType](./x-adapter-platform.platformfacettype.md) | Facet type for the <code>platform</code> API. It can be: value, hierarchical or range. |
108
+
@@ -17,5 +17,6 @@ export interface PlatformFacet
17
17
  | Property | Type | Description |
18
18
  | --- | --- | --- |
19
19
  | [facet](./x-adapter-platform.platformfacet.facet.md) | string | |
20
+ | [type](./x-adapter-platform.platformfacet.type.md) | [PlatformFacetType](./x-adapter-platform.platformfacettype.md) | |
20
21
  | [values](./x-adapter-platform.platformfacet.values.md) | [PlatformFilter](./x-adapter-platform.platformfilter.md)<!-- -->\[\] | |
21
22
 
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformFacet](./x-adapter-platform.platformfacet.md) &gt; [type](./x-adapter-platform.platformfacet.type.md)
4
+
5
+ ## PlatformFacet.type property
6
+
7
+ <b>Signature:</b>
8
+
9
+ ```typescript
10
+ type: PlatformFacetType;
11
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformFacetType](./x-adapter-platform.platformfacettype.md)
4
+
5
+ ## PlatformFacetType type
6
+
7
+ Facet type for the `platform` API. It can be: value, hierarchical or range.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ export declare type PlatformFacetType = 'value' | 'hierarchical' | 'range';
13
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@empathyco/x-components",
3
- "version": "3.0.0-alpha.201",
3
+ "version": "3.0.0-alpha.202",
4
4
  "description": "Empathy X Components",
5
5
  "author": "Empathy Systems Corporation S.L.",
6
6
  "license": "Apache-2.0",
@@ -85,7 +85,7 @@
85
85
  "devDependencies": {
86
86
  "@cypress/vue": "~2.2.4",
87
87
  "@cypress/webpack-dev-server": "~1.8.4",
88
- "@empathyco/x-adapter-platform": "^1.0.0-alpha.38",
88
+ "@empathyco/x-adapter-platform": "^1.0.0-alpha.39",
89
89
  "@empathyco/x-tailwindcss": "^0.2.0-alpha.22",
90
90
  "@microsoft/api-documenter": "~7.15.3",
91
91
  "@microsoft/api-extractor": "~7.19.4",
@@ -136,5 +136,5 @@
136
136
  "access": "public",
137
137
  "directory": "dist"
138
138
  },
139
- "gitHead": "a10f63bb6ffc498d465ec3aaf17c24e76732869f"
139
+ "gitHead": "a7c306fd475bd3d2d74dcd8f314d37d766a6e782"
140
140
  }
@@ -432,104 +432,19 @@
432
432
  "endIndex": 16
433
433
  }
434
434
  },
435
- {
436
- "kind": "Interface",
437
- "canonicalReference": "@empathyco/x-adapter-platform!FacetsConfig:interface",
438
- "docComment": "/**\n * Dictionary grouping facets configurations.\n */\n",
439
- "excerptTokens": [
440
- {
441
- "kind": "Content",
442
- "text": "export interface FacetsConfig "
443
- }
444
- ],
445
- "releaseTag": "Public",
446
- "name": "FacetsConfig",
447
- "members": [
448
- {
449
- "kind": "IndexSignature",
450
- "canonicalReference": "@empathyco/x-adapter-platform!FacetsConfig:index(1)",
451
- "docComment": "",
452
- "excerptTokens": [
453
- {
454
- "kind": "Content",
455
- "text": "[key: "
456
- },
457
- {
458
- "kind": "Reference",
459
- "text": "Facet",
460
- "canonicalReference": "@empathyco/x-adapter-platform!Facet:interface"
461
- },
462
- {
463
- "kind": "Content",
464
- "text": "['id']"
465
- },
466
- {
467
- "kind": "Content",
468
- "text": "]: "
469
- },
470
- {
471
- "kind": "Reference",
472
- "text": "FacetConfig",
473
- "canonicalReference": "@empathyco/x-adapter-platform!FacetConfig:interface"
474
- },
475
- {
476
- "kind": "Content",
477
- "text": ";"
478
- }
479
- ],
480
- "returnTypeTokenRange": {
481
- "startIndex": 4,
482
- "endIndex": 5
483
- },
484
- "releaseTag": "Public",
485
- "overloadIndex": 1,
486
- "parameters": [
487
- {
488
- "parameterName": "key",
489
- "parameterTypeTokenRange": {
490
- "startIndex": 1,
491
- "endIndex": 3
492
- }
493
- }
494
- ]
495
- }
496
- ],
497
- "extendsTokenRanges": []
498
- },
499
- {
500
- "kind": "Variable",
501
- "canonicalReference": "@empathyco/x-adapter-platform!facetsConfig:var",
502
- "docComment": "",
503
- "excerptTokens": [
504
- {
505
- "kind": "Content",
506
- "text": "facetsConfig: "
507
- },
508
- {
509
- "kind": "Reference",
510
- "text": "FacetsConfig",
511
- "canonicalReference": "@empathyco/x-adapter-platform!FacetsConfig:interface"
512
- }
513
- ],
514
- "releaseTag": "Public",
515
- "name": "facetsConfig",
516
- "variableTypeTokenRange": {
517
- "startIndex": 1,
518
- "endIndex": 2
519
- }
520
- },
521
435
  {
522
436
  "kind": "Function",
523
437
  "canonicalReference": "@empathyco/x-adapter-platform!getFacetConfig:function(1)",
524
- "docComment": "/**\n * Returns the facet's config.\n *\n * @param facet - The facet to resolve the configuration.\n *\n * @returns The facet's config.\n */\n",
438
+ "docComment": "/**\n * Returns the facet's config.\n *\n * @param type - The facet type to resolve the configuration.\n *\n * @returns The facet's config.\n */\n",
525
439
  "excerptTokens": [
526
440
  {
527
441
  "kind": "Content",
528
- "text": "export declare function getFacetConfig(facet: "
442
+ "text": "export declare function getFacetConfig(type: "
529
443
  },
530
444
  {
531
- "kind": "Content",
532
- "text": "string"
445
+ "kind": "Reference",
446
+ "text": "PlatformFacetType",
447
+ "canonicalReference": "@empathyco/x-adapter-platform!PlatformFacetType:type"
533
448
  },
534
449
  {
535
450
  "kind": "Content",
@@ -553,7 +468,7 @@
553
468
  "overloadIndex": 1,
554
469
  "parameters": [
555
470
  {
556
- "parameterName": "facet",
471
+ "parameterName": "type",
557
472
  "parameterTypeTokenRange": {
558
473
  "startIndex": 1,
559
474
  "endIndex": 2
@@ -1970,6 +1885,33 @@
1970
1885
  "endIndex": 2
1971
1886
  }
1972
1887
  },
1888
+ {
1889
+ "kind": "PropertySignature",
1890
+ "canonicalReference": "@empathyco/x-adapter-platform!PlatformFacet#type:member",
1891
+ "docComment": "",
1892
+ "excerptTokens": [
1893
+ {
1894
+ "kind": "Content",
1895
+ "text": "type: "
1896
+ },
1897
+ {
1898
+ "kind": "Reference",
1899
+ "text": "PlatformFacetType",
1900
+ "canonicalReference": "@empathyco/x-adapter-platform!PlatformFacetType:type"
1901
+ },
1902
+ {
1903
+ "kind": "Content",
1904
+ "text": ";"
1905
+ }
1906
+ ],
1907
+ "isOptional": false,
1908
+ "releaseTag": "Public",
1909
+ "name": "type",
1910
+ "propertyTypeTokenRange": {
1911
+ "startIndex": 1,
1912
+ "endIndex": 2
1913
+ }
1914
+ },
1973
1915
  {
1974
1916
  "kind": "PropertySignature",
1975
1917
  "canonicalReference": "@empathyco/x-adapter-platform!PlatformFacet#values:member",
@@ -2004,6 +1946,31 @@
2004
1946
  ],
2005
1947
  "extendsTokenRanges": []
2006
1948
  },
1949
+ {
1950
+ "kind": "TypeAlias",
1951
+ "canonicalReference": "@empathyco/x-adapter-platform!PlatformFacetType:type",
1952
+ "docComment": "/**\n * Facet type for the `platform` API. It can be: value, hierarchical or range.\n *\n * @public\n */\n",
1953
+ "excerptTokens": [
1954
+ {
1955
+ "kind": "Content",
1956
+ "text": "export declare type PlatformFacetType = "
1957
+ },
1958
+ {
1959
+ "kind": "Content",
1960
+ "text": "'value' | 'hierarchical' | 'range'"
1961
+ },
1962
+ {
1963
+ "kind": "Content",
1964
+ "text": ";"
1965
+ }
1966
+ ],
1967
+ "releaseTag": "Public",
1968
+ "name": "PlatformFacetType",
1969
+ "typeTokenRange": {
1970
+ "startIndex": 1,
1971
+ "endIndex": 2
1972
+ }
1973
+ },
2007
1974
  {
2008
1975
  "kind": "Interface",
2009
1976
  "canonicalReference": "@empathyco/x-adapter-platform!PlatformFilter:interface",
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [facetsConfig](./x-adapter-platform.facetsconfig.md)
4
-
5
- ## facetsConfig variable
6
-
7
- <b>Signature:</b>
8
-
9
- ```typescript
10
- facetsConfig: FacetsConfig
11
- ```