@empathyco/x-adapter-platform 1.4.3 → 1.5.0

package/dist/cjs/schemas/models/facet.schema.js

@@ -10,7 +10,7 @@ const utils_1 = require("../facets/utils");
  */
 exports.facetSchema = (0, x_adapter_1.createMutableSchema)({
     id: 'facet',
-    label: 'facet',
+    label: 'label',
     // eslint-disable-next-line ts/no-unsafe-return
     modelName: ({ type }) => (0, utils_1.getFacetConfig)(type).modelName,
     filters: {

package/dist/cjs/schemas/models/facet.schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"facet.schema.js","sourceRoot":"","sources":["../../../../src/schemas/models/facet.schema.ts"],"names":[],"mappings":";;;AAOA,oDAA0D;AAC1D,2CAAgD;AAEhD;;;;GAIG;AACU,QAAA,WAAW,GAAG,IAAA,+BAAmB,EAG5C;IACA,EAAE,EAAE,OAAO;IACX,KAAK,EAAE,OAAO;IACd,+CAA+C;IAC/C,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAA,sBAAc,EAAC,IAAI,CAAC,CAAC,SAAgB;IAC9D,OAAO,EAAE;QACP,KAAK,EAAE,QAAQ;QACf,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAA,sBAAc,EAAC,IAAI,CAAC,CAAC,MAAM;QACrD,QAAQ,EAAE;YACR,OAAO,EAAE,OAAO;SACjB;KACF;CACF,CAAC,CAAA","sourcesContent":["import type {\n  EditableNumberRangeFacet,\n  HierarchicalFacet,\n  NumberRangeFacet,\n  SimpleFacet,\n} from '@empathyco/x-types'\nimport type { PlatformFacet } from '../../types/models/facet.model'\nimport { createMutableSchema } from '@empathyco/x-adapter'\nimport { getFacetConfig } from '../facets/utils'\n\n/**\n * Default implementation for the FacetSchema.\n *\n * @public\n */\nexport const facetSchema = createMutableSchema<\n  PlatformFacet,\n  HierarchicalFacet | NumberRangeFacet | SimpleFacet | EditableNumberRangeFacet\n>({\n  id: 'facet',\n  label: 'facet',\n  // eslint-disable-next-line ts/no-unsafe-return\n  modelName: ({ type }) => getFacetConfig(type).modelName as any,\n  filters: {\n    $path: 'values',\n    $subSchema: ({ type }) => getFacetConfig(type).schema,\n    $context: {\n      facetId: 'facet',\n    },\n  },\n})\n"]}
+{"version":3,"file":"facet.schema.js","sourceRoot":"","sources":["../../../../src/schemas/models/facet.schema.ts"],"names":[],"mappings":";;;AAOA,oDAA0D;AAC1D,2CAAgD;AAEhD;;;;GAIG;AACU,QAAA,WAAW,GAAG,IAAA,+BAAmB,EAG5C;IACA,EAAE,EAAE,OAAO;IACX,KAAK,EAAE,OAAO;IACd,+CAA+C;IAC/C,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAA,sBAAc,EAAC,IAAI,CAAC,CAAC,SAAgB;IAC9D,OAAO,EAAE;QACP,KAAK,EAAE,QAAQ;QACf,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAA,sBAAc,EAAC,IAAI,CAAC,CAAC,MAAM;QACrD,QAAQ,EAAE;YACR,OAAO,EAAE,OAAO;SACjB;KACF;CACF,CAAC,CAAA","sourcesContent":["import type {\n  EditableNumberRangeFacet,\n  HierarchicalFacet,\n  NumberRangeFacet,\n  SimpleFacet,\n} from '@empathyco/x-types'\nimport type { PlatformFacet } from '../../types/models/facet.model'\nimport { createMutableSchema } from '@empathyco/x-adapter'\nimport { getFacetConfig } from '../facets/utils'\n\n/**\n * Default implementation for the FacetSchema.\n *\n * @public\n */\nexport const facetSchema = createMutableSchema<\n  PlatformFacet,\n  HierarchicalFacet | NumberRangeFacet | SimpleFacet | EditableNumberRangeFacet\n>({\n  id: 'facet',\n  label: 'label',\n  // eslint-disable-next-line ts/no-unsafe-return\n  modelName: ({ type }) => getFacetConfig(type).modelName as any,\n  filters: {\n    $path: 'values',\n    $subSchema: ({ type }) => getFacetConfig(type).schema,\n    $context: {\n      facetId: 'facet',\n    },\n  },\n})\n"]}

package/dist/cjs/types/models/facet.model.js.map

@@ -1 +1 @@
-{"version":3,"file":"facet.model.js","sourceRoot":"","sources":["../../../../src/types/models/facet.model.ts"],"names":[],"mappings":"","sourcesContent":["import type { BooleanFilter, Facet, Filter } from '@empathyco/x-types'\n\n/**\n * Facet model for the `platform` API.\n *\n * @public\n */\nexport interface PlatformFacet {\n  facet: string\n  type: PlatformFacetType\n  values: PlatformFilter[]\n}\n\n/**\n * Facet type for the `platform` API. It can be: value, hierarchical or range.\n *\n * @public\n */\nexport type PlatformFacetType = 'value' | 'hierarchical' | 'range' | 'editable-range'\n\n/**\n * Filter model for the `platform` API.\n *\n * @public\n */\nexport interface PlatformFilter {\n  count: number\n  filter: string\n  id: string\n  value: string\n}\n\n/**\n * HierarchicalFilter model for the `platform` API.\n *\n * @public\n */\nexport interface PlatformHierarchicalFilter extends PlatformFilter {\n  children: PlatformFacet\n}\n\n/**\n * Hierarchical Facet model used when combining search response mappers.\n *\n * @internal\n */\nexport interface AdapterHierarchicalFacet extends Facet {\n  /** Model name to indicate the facet type. */\n  modelName: 'HierarchicalFacet'\n  /** Filters available for the facet. */\n  filters: AdapterHierarchicalFilter[]\n}\n\n/**\n * Hierarchical Filter model used when combining search response mappers.\n *\n * @internal\n */\nexport interface AdapterHierarchicalFilter extends BooleanFilter {\n  /** Model name to indicate the filter type. */\n  modelName: 'HierarchicalFilter'\n  /** A unique id used to reference the parent filter or null if it hasn't. */\n  parentId: Filter['id'] | null\n  /** Descendants filters. */\n  children?: AdapterHierarchicalFilter[]\n}\n"]}
+{"version":3,"file":"facet.model.js","sourceRoot":"","sources":["../../../../src/types/models/facet.model.ts"],"names":[],"mappings":"","sourcesContent":["import type { BooleanFilter, Facet, Filter } from '@empathyco/x-types'\n\n/**\n * Facet model for the `platform` API.\n *\n * @public\n */\nexport interface PlatformFacet {\n  label: string\n  facet: string\n  type: PlatformFacetType\n  values: PlatformFilter[]\n}\n\n/**\n * Facet type for the `platform` API. It can be: value, hierarchical or range.\n *\n * @public\n */\nexport type PlatformFacetType = 'value' | 'hierarchical' | 'range' | 'editable-range'\n\n/**\n * Filter model for the `platform` API.\n *\n * @public\n */\nexport interface PlatformFilter {\n  count: number\n  filter: string\n  id: string\n  value: string\n}\n\n/**\n * HierarchicalFilter model for the `platform` API.\n *\n * @public\n */\nexport interface PlatformHierarchicalFilter extends PlatformFilter {\n  children: PlatformFacet\n}\n\n/**\n * Hierarchical Facet model used when combining search response mappers.\n *\n * @internal\n */\nexport interface AdapterHierarchicalFacet extends Facet {\n  /** Model name to indicate the facet type. */\n  modelName: 'HierarchicalFacet'\n  /** Filters available for the facet. */\n  filters: AdapterHierarchicalFilter[]\n}\n\n/**\n * Hierarchical Filter model used when combining search response mappers.\n *\n * @internal\n */\nexport interface AdapterHierarchicalFilter extends BooleanFilter {\n  /** Model name to indicate the filter type. */\n  modelName: 'HierarchicalFilter'\n  /** A unique id used to reference the parent filter or null if it hasn't. */\n  parentId: Filter['id'] | null\n  /** Descendants filters. */\n  children?: AdapterHierarchicalFilter[]\n}\n"]}

package/dist/esm/schemas/models/facet.schema.js

@@ -7,7 +7,7 @@ import { getFacetConfig } from '../facets/utils';
  */
 export const facetSchema = createMutableSchema({
     id: 'facet',
-    label: 'facet',
+    label: 'label',
     // eslint-disable-next-line ts/no-unsafe-return
     modelName: ({ type }) => getFacetConfig(type).modelName,
     filters: {

package/dist/esm/schemas/models/facet.schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"facet.schema.js","sourceRoot":"","sources":["../../../../src/schemas/models/facet.schema.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAEhD;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,mBAAmB,CAG5C;IACA,EAAE,EAAE,OAAO;IACX,KAAK,EAAE,OAAO;IACd,+CAA+C;IAC/C,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,SAAgB;IAC9D,OAAO,EAAE;QACP,KAAK,EAAE,QAAQ;QACf,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,MAAM;QACrD,QAAQ,EAAE;YACR,OAAO,EAAE,OAAO;SACjB;KACF;CACF,CAAC,CAAA","sourcesContent":["import type {\n  EditableNumberRangeFacet,\n  HierarchicalFacet,\n  NumberRangeFacet,\n  SimpleFacet,\n} from '@empathyco/x-types'\nimport type { PlatformFacet } from '../../types/models/facet.model'\nimport { createMutableSchema } from '@empathyco/x-adapter'\nimport { getFacetConfig } from '../facets/utils'\n\n/**\n * Default implementation for the FacetSchema.\n *\n * @public\n */\nexport const facetSchema = createMutableSchema<\n  PlatformFacet,\n  HierarchicalFacet | NumberRangeFacet | SimpleFacet | EditableNumberRangeFacet\n>({\n  id: 'facet',\n  label: 'facet',\n  // eslint-disable-next-line ts/no-unsafe-return\n  modelName: ({ type }) => getFacetConfig(type).modelName as any,\n  filters: {\n    $path: 'values',\n    $subSchema: ({ type }) => getFacetConfig(type).schema,\n    $context: {\n      facetId: 'facet',\n    },\n  },\n})\n"]}
+{"version":3,"file":"facet.schema.js","sourceRoot":"","sources":["../../../../src/schemas/models/facet.schema.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAEhD;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,mBAAmB,CAG5C;IACA,EAAE,EAAE,OAAO;IACX,KAAK,EAAE,OAAO;IACd,+CAA+C;IAC/C,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,SAAgB;IAC9D,OAAO,EAAE;QACP,KAAK,EAAE,QAAQ;QACf,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,MAAM;QACrD,QAAQ,EAAE;YACR,OAAO,EAAE,OAAO;SACjB;KACF;CACF,CAAC,CAAA","sourcesContent":["import type {\n  EditableNumberRangeFacet,\n  HierarchicalFacet,\n  NumberRangeFacet,\n  SimpleFacet,\n} from '@empathyco/x-types'\nimport type { PlatformFacet } from '../../types/models/facet.model'\nimport { createMutableSchema } from '@empathyco/x-adapter'\nimport { getFacetConfig } from '../facets/utils'\n\n/**\n * Default implementation for the FacetSchema.\n *\n * @public\n */\nexport const facetSchema = createMutableSchema<\n  PlatformFacet,\n  HierarchicalFacet | NumberRangeFacet | SimpleFacet | EditableNumberRangeFacet\n>({\n  id: 'facet',\n  label: 'label',\n  // eslint-disable-next-line ts/no-unsafe-return\n  modelName: ({ type }) => getFacetConfig(type).modelName as any,\n  filters: {\n    $path: 'values',\n    $subSchema: ({ type }) => getFacetConfig(type).schema,\n    $context: {\n      facetId: 'facet',\n    },\n  },\n})\n"]}

package/dist/esm/types/models/facet.model.js.map

@@ -1 +1 @@
-{"version":3,"file":"facet.model.js","sourceRoot":"","sources":["../../../../src/types/models/facet.model.ts"],"names":[],"mappings":"","sourcesContent":["import type { BooleanFilter, Facet, Filter } from '@empathyco/x-types'\n\n/**\n * Facet model for the `platform` API.\n *\n * @public\n */\nexport interface PlatformFacet {\n  facet: string\n  type: PlatformFacetType\n  values: PlatformFilter[]\n}\n\n/**\n * Facet type for the `platform` API. It can be: value, hierarchical or range.\n *\n * @public\n */\nexport type PlatformFacetType = 'value' | 'hierarchical' | 'range' | 'editable-range'\n\n/**\n * Filter model for the `platform` API.\n *\n * @public\n */\nexport interface PlatformFilter {\n  count: number\n  filter: string\n  id: string\n  value: string\n}\n\n/**\n * HierarchicalFilter model for the `platform` API.\n *\n * @public\n */\nexport interface PlatformHierarchicalFilter extends PlatformFilter {\n  children: PlatformFacet\n}\n\n/**\n * Hierarchical Facet model used when combining search response mappers.\n *\n * @internal\n */\nexport interface AdapterHierarchicalFacet extends Facet {\n  /** Model name to indicate the facet type. */\n  modelName: 'HierarchicalFacet'\n  /** Filters available for the facet. */\n  filters: AdapterHierarchicalFilter[]\n}\n\n/**\n * Hierarchical Filter model used when combining search response mappers.\n *\n * @internal\n */\nexport interface AdapterHierarchicalFilter extends BooleanFilter {\n  /** Model name to indicate the filter type. */\n  modelName: 'HierarchicalFilter'\n  /** A unique id used to reference the parent filter or null if it hasn't. */\n  parentId: Filter['id'] | null\n  /** Descendants filters. */\n  children?: AdapterHierarchicalFilter[]\n}\n"]}
+{"version":3,"file":"facet.model.js","sourceRoot":"","sources":["../../../../src/types/models/facet.model.ts"],"names":[],"mappings":"","sourcesContent":["import type { BooleanFilter, Facet, Filter } from '@empathyco/x-types'\n\n/**\n * Facet model for the `platform` API.\n *\n * @public\n */\nexport interface PlatformFacet {\n  label: string\n  facet: string\n  type: PlatformFacetType\n  values: PlatformFilter[]\n}\n\n/**\n * Facet type for the `platform` API. It can be: value, hierarchical or range.\n *\n * @public\n */\nexport type PlatformFacetType = 'value' | 'hierarchical' | 'range' | 'editable-range'\n\n/**\n * Filter model for the `platform` API.\n *\n * @public\n */\nexport interface PlatformFilter {\n  count: number\n  filter: string\n  id: string\n  value: string\n}\n\n/**\n * HierarchicalFilter model for the `platform` API.\n *\n * @public\n */\nexport interface PlatformHierarchicalFilter extends PlatformFilter {\n  children: PlatformFacet\n}\n\n/**\n * Hierarchical Facet model used when combining search response mappers.\n *\n * @internal\n */\nexport interface AdapterHierarchicalFacet extends Facet {\n  /** Model name to indicate the facet type. */\n  modelName: 'HierarchicalFacet'\n  /** Filters available for the facet. */\n  filters: AdapterHierarchicalFilter[]\n}\n\n/**\n * Hierarchical Filter model used when combining search response mappers.\n *\n * @internal\n */\nexport interface AdapterHierarchicalFilter extends BooleanFilter {\n  /** Model name to indicate the filter type. */\n  modelName: 'HierarchicalFilter'\n  /** A unique id used to reference the parent filter or null if it hasn't. */\n  parentId: Filter['id'] | null\n  /** Descendants filters. */\n  children?: AdapterHierarchicalFilter[]\n}\n"]}

package/dist/types/types/models/facet.model.d.ts

@@ -5,6 +5,7 @@ import type { BooleanFilter, Facet, Filter } from '@empathyco/x-types';
  * @public
  */
 export interface PlatformFacet {
+    label: string;
     facet: string;
     type: PlatformFacetType;
     values: PlatformFilter[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empathyco/x-adapter-platform",
-  "version": "1.4.3",
+  "version": "1.5.0",
   "description": "A search client for the Empathy Platform API",
   "author": "Empathy Systems Corporation S.L.",
   "license": "Apache-2.0",
@@ -62,5 +62,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "bab968ddb9bdd0e4406d37ce4a026cc2fd1922e4"
+  "gitHead": "20dde8a5b68ef6e7855e96181ccf99b52922a619"
 }

package/report/x-adapter-platform.api.json

@@ -3569,6 +3569,33 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-adapter-platform!PlatformFacet#label:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "label: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "label",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-adapter-platform!PlatformFacet#type:member",

package/report/x-adapter-platform.api.md

@@ -338,6 +338,8 @@ export interface PlatformFacet {
     // (undocumented)
     facet: string;
     // (undocumented)
+    label: string;
+    // (undocumented)
     type: PlatformFacetType;
     // (undocumented)
     values: PlatformFilter[];