Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@shopware/api-client
Advanced tools
@shopware/api-client - npm Package Compare versions
Comparing version 0.0.0-canary-20240805063723 to 0.0.0-canary-20240925111008
| { | ||
| "components": {}, | ||
| "components": { | ||
| "Include": { | ||
| "type": "object", | ||
| "additionalProperties": { | ||
| "type": "array", | ||
| "items": { "type": "string" } | ||
| } | ||
| }, | ||
| "Filters": { | ||
| "type": "array", | ||
| "items": { | ||
| "anyOf": [ | ||
| { "$ref": "#/components/schemas/SimpleFilter" }, | ||
| { "$ref": "#/components/schemas/EqualsFilter" }, | ||
| { "$ref": "#/components/schemas/MultiNotFilter" }, | ||
| { "$ref": "#/components/schemas/RangeFilter" } | ||
| ] | ||
| } | ||
| }, | ||
| "SimpleFilter": { | ||
| "type": "object", | ||
| "properties": { | ||
| "type": { | ||
| "type": "string", | ||
| "enum": ["contains", "equalsAny", "prefix", "suffix"] | ||
| }, | ||
| "field": { "type": "string" }, | ||
| "value": { "type": "string" } | ||
| }, | ||
| "required": ["type", "field", "value"] | ||
| }, | ||
| "EqualsFilter": { | ||
| "type": "object", | ||
| "properties": { | ||
| "type": { "type": "string", "enum": ["equals"] }, | ||
| "field": { "type": "string" }, | ||
| "value": { | ||
| "oneOf": [ | ||
| { "type": "string" }, | ||
| { "type": "number" }, | ||
| { "type": "boolean" }, | ||
| { "type": "null" } | ||
| ] | ||
| } | ||
| }, | ||
| "required": ["type", "field", "value"] | ||
| }, | ||
| "MultiNotFilter": { | ||
| "type": "object", | ||
| "properties": { | ||
| "type": { "type": "string", "enum": ["multi", "not"] }, | ||
| "operator": { "type": "string", "enum": ["AND", "and", "OR", "or"] }, | ||
| "queries": { "$ref": "#/components/schemas/Filters" } | ||
| }, | ||
| "required": ["type", "operator", "queries"] | ||
| }, | ||
| "RangeFilter": { | ||
| "type": "object", | ||
| "properties": { | ||
| "type": { "type": "string", "enum": ["range"] }, | ||
| "field": { "type": "string" }, | ||
| "parameters": { | ||
| "type": "object", | ||
| "properties": { | ||
| "gte": { "type": "number" }, | ||
| "gt": { "type": "number" }, | ||
| "lte": { "type": "number" }, | ||
| "lt": { "type": "number" } | ||
| } | ||
| } | ||
| }, | ||
| "required": ["type", "field", "parameters"] | ||
| }, | ||
| "Sort": { | ||
| "type": "object", | ||
| "properties": { | ||
| "field": { "type": "string" }, | ||
| "order": { "type": "string", "enum": ["ASC", "DESC"] }, | ||
| "naturalSorting": { "type": "boolean" }, | ||
| "type": { "type": "string" } | ||
| }, | ||
| "required": ["field", "order"] | ||
| }, | ||
| "Association": { | ||
| "type": "object", | ||
| "additionalProperties": { "$ref": "#/components/schemas/Criteria" } | ||
| }, | ||
| "Aggregations": { | ||
| "type": "array", | ||
| "items": { | ||
| "anyOf": [ | ||
| { "$ref": "#/components/schemas/AggregationMetrics" }, | ||
| { | ||
| "title": "AggregationEntity", | ||
| "allOf": [ | ||
| { "$ref": "#/components/schemas/AggregationEntity" }, | ||
| { "$ref": "#/components/schemas/SubAggregations" } | ||
| ] | ||
| }, | ||
| { | ||
| "title": "AggregationFilter", | ||
| "allOf": [ | ||
| { "$ref": "#/components/schemas/AggregationFilter" }, | ||
| { "$ref": "#/components/schemas/SubAggregations" } | ||
| ] | ||
| }, | ||
| { | ||
| "title": "AggregationTerms", | ||
| "allOf": [ | ||
| { "$ref": "#/components/schemas/AggregationTerms" }, | ||
| { "$ref": "#/components/schemas/SubAggregations" } | ||
| ] | ||
| }, | ||
| { | ||
| "title": "AggregationHistogram", | ||
| "allOf": [ | ||
| { "$ref": "#/components/schemas/AggregationHistogram" }, | ||
| { "$ref": "#/components/schemas/SubAggregations" } | ||
| ] | ||
| }, | ||
| { | ||
| "title": "AggregationRange", | ||
| "allOf": [ | ||
| { "$ref": "#/components/schemas/AggregationRange" }, | ||
| { "$ref": "#/components/schemas/SubAggregations" } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| "SubAggregations": { | ||
| "type": "object", | ||
| "properties": { | ||
| "aggregation": { | ||
| "anyOf": [ | ||
| { "$ref": "#/components/schemas/AggregationMetrics" }, | ||
| { "$ref": "#/components/schemas/AggregationEntity" }, | ||
| { "$ref": "#/components/schemas/AggregationFilter" }, | ||
| { "$ref": "#/components/schemas/AggregationTerms" }, | ||
| { "$ref": "#/components/schemas/AggregationHistogram" }, | ||
| { "$ref": "#/components/schemas/AggregationRange" } | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| "AggregationEntity": { | ||
| "title": "AggregationEntity", | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { | ||
| "description": "Give your aggregation an identifier, so you can find it easier", | ||
| "type": "string" | ||
| }, | ||
| "type": { | ||
| "description": "The type of aggregation", | ||
| "type": "string", | ||
| "enum": ["entity"] | ||
| }, | ||
| "field": { | ||
| "description": "The field you want to aggregate over.", | ||
| "type": "string" | ||
| }, | ||
| "definition": { | ||
| "description": "The entity definition e.g \"product_manufacturer\".", | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "required": ["name", "type", "field", "definition"] | ||
| }, | ||
| "AggregationFilter": { | ||
| "title": "AggregationFilter", | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { | ||
| "description": "Give your aggregation an identifier, so you can find it easier", | ||
| "type": "string" | ||
| }, | ||
| "type": { | ||
| "description": "The type of aggregation", | ||
| "type": "string", | ||
| "enum": ["filter"] | ||
| }, | ||
| "filter": { | ||
| "type": "array", | ||
| "items": { "$ref": "#/components/schemas/Filters" } | ||
| } | ||
| }, | ||
| "required": ["name", "type", "filter"] | ||
| }, | ||
| "AggregationTerms": { | ||
| "title": "AggregationTerms", | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { | ||
| "description": "Give your aggregation an identifier, so you can find it easier", | ||
| "type": "string" | ||
| }, | ||
| "type": { | ||
| "description": "The type of aggregation", | ||
| "type": "string", | ||
| "enum": ["terms"] | ||
| }, | ||
| "field": { | ||
| "description": "The field you want to aggregate over.", | ||
| "type": "string" | ||
| }, | ||
| "limit": { | ||
| "description": "The number of terms to return", | ||
| "type": "number" | ||
| }, | ||
| "sort": { | ||
| "type": "array", | ||
| "description": "Sorting the aggregation result.", | ||
| "items": { "$ref": "#/components/schemas/Sort" } | ||
| } | ||
| }, | ||
| "required": ["name", "type", "field"] | ||
| }, | ||
| "AggregationHistogram": { | ||
| "title": "AggregationHistogram", | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { | ||
| "description": "Give your aggregation an identifier, so you can find it easier", | ||
| "type": "string" | ||
| }, | ||
| "type": { | ||
| "description": "The type of aggregation", | ||
| "type": "string", | ||
| "enum": ["histogram"] | ||
| }, | ||
| "field": { | ||
| "description": "The field you want to aggregate over.", | ||
| "type": "string" | ||
| }, | ||
| "interval": { | ||
| "description": "The interval of the histogram", | ||
| "type": "number" | ||
| }, | ||
| "format": { | ||
| "description": "The format of the histogram", | ||
| "type": "string" | ||
| }, | ||
| "timeZone": { | ||
| "description": "The timezone of the histogram", | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "required": ["name", "type", "field"] | ||
| }, | ||
| "AggregationRange": { | ||
| "title": "AggregationRange", | ||
| "description": "For more information, see [Aggregations Reference > Range Aggregation](https://developer.shopware.com/docs/resources/references/core-reference/dal-reference/aggregations-reference.html#range-aggregations)", | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { | ||
| "description": "Give your aggregation an identifier, so you can find it easier", | ||
| "type": "string" | ||
| }, | ||
| "type": { | ||
| "description": "The type of aggregation", | ||
| "type": "string", | ||
| "enum": ["range"] | ||
| }, | ||
| "field": { | ||
| "description": "The field you want to aggregate over.", | ||
| "type": "string" | ||
| }, | ||
| "ranges": { | ||
| "description": "The ranges of the aggregation", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object", | ||
| "anyOf": [ | ||
| { | ||
| "type": "object", | ||
| "title": "From and to", | ||
| "properties": { | ||
| "from": { | ||
| "type": "number", | ||
| "description": "The lower bound of the range" | ||
| }, | ||
| "to": { | ||
| "type": "number", | ||
| "description": "The upper bound of the range" | ||
| } | ||
| }, | ||
| "required": ["from", "to"] | ||
| }, | ||
| { | ||
| "type": "object", | ||
| "title": "From only", | ||
| "properties": { | ||
| "from": { | ||
| "type": "string", | ||
| "description": "The lower bound of the range" | ||
| } | ||
| }, | ||
| "required": ["from"] | ||
| }, | ||
| { | ||
| "type": "object", | ||
| "title": "To only", | ||
| "properties": { | ||
| "to": { | ||
| "type": "string", | ||
| "description": "The upper bound of the range" | ||
| } | ||
| }, | ||
| "required": ["to"] | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| "required": ["name", "type", "field", "ranges"] | ||
| }, | ||
| "AggregationMetrics": { | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { "type": "string" }, | ||
| "type": { | ||
| "type": "string", | ||
| "enum": ["avg", "count", "max", "min", "stats", "sum"] | ||
| }, | ||
| "field": { "type": "string" } | ||
| }, | ||
| "required": ["name", "type", "field"] | ||
| }, | ||
| "Criteria": [ | ||
| { | ||
| "properties": { | ||
| "query": { | ||
| "type": "string", | ||
| "items": "_DELETE_", | ||
| "description": "The query string to search for" | ||
| }, | ||
| "filter": { | ||
| "type": "array", | ||
| "description": "List of filters to restrict the search result. For more information, see [Search Queries > Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#filter)", | ||
| "items": { | ||
| "anyOf": [ | ||
| { "$ref": "#/components/schemas/SimpleFilter" }, | ||
| { "$ref": "#/components/schemas/EqualsFilter" }, | ||
| { "$ref": "#/components/schemas/MultiNotFilter" }, | ||
| { "$ref": "#/components/schemas/RangeFilter" } | ||
| ] | ||
| } | ||
| }, | ||
| "post-filter": { | ||
| "type": "array", | ||
| "description": "Filters that applied without affecting aggregations. For more information, see [Search Queries > Post Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#post-filter)", | ||
| "items": { | ||
| "anyOf": [ | ||
| { "$ref": "#/components/schemas/SimpleFilter" }, | ||
| { "$ref": "#/components/schemas/EqualsFilter" }, | ||
| { "$ref": "#/components/schemas/MultiNotFilter" }, | ||
| { "$ref": "#/components/schemas/RangeFilter" } | ||
| ] | ||
| } | ||
| }, | ||
| "aggregations": { "$ref": "#/components/schemas/Aggregations" }, | ||
| "ids": { | ||
| "type": "array", | ||
| "description": "List of ids to search for", | ||
| "items": { "type": "string" } | ||
| }, | ||
| "includes": { "$ref": "#/components/schemas/Include" } | ||
| } | ||
| }, | ||
| { | ||
| "properties": { | ||
| "associations": { | ||
| "$ref": "#/components/schemas/Association", | ||
| "type": "_DELETE_", | ||
| "items": "_DELETE_" | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| "paths": {} | ||
| } |
| { | ||
| "name": "@shopware/api-client", | ||
| "version": "0.0.0-canary-20240805063723", | ||
| "version": "0.0.0-canary-20240925111008", | ||
| "description": "Shopware client for API connection.", | ||
@@ -47,7 +47,7 @@ "author": "Shopware", | ||
| "@types/prettier": "3.0.0", | ||
| "@vitest/coverage-v8": "2.0.4", | ||
| "@vitest/coverage-v8": "2.0.5", | ||
| "prettier": "3.3.3", | ||
| "unbuild": "2.0.0", | ||
| "vitest": "2.0.4", | ||
| "eslint-config-shopware": "0.0.0-canary-20240805063723", | ||
| "vitest": "2.0.5", | ||
| "eslint-config-shopware": "1.0.0", | ||
| "tsconfig": "0.0.0" | ||
@@ -54,0 +54,0 @@ }, |
@@ -266,8 +266,6 @@ # shopware/frontends - api-client | ||
| ### Latest changes: 0.0.0-canary-20240805063723 | ||
| ### Latest changes: 0.0.0-canary-20240925111008 | ||
| ### Patch Changes | ||
| - [#1089](https://github.com/shopware/frontends/pull/1089) [`db7c93f`](https://github.com/shopware/frontends/commit/db7c93ff8cbb581221c11a492e77068af8faa8d6) Thanks [@mkucmus](https://github.com/mkucmus)! - Migrate eslint config to flat format | ||
| - [#1074](https://github.com/shopware/frontends/pull/1074) [`b688163`](https://github.com/shopware/frontends/commit/b68816391ee8ed1ac94a6462a2a016d708f259b4) Thanks [@mkucmus](https://github.com/mkucmus)! - Update default schemas' `translated` properties as required | ||
| - [#1316](https://github.com/shopware/frontends/pull/1316) [`15bebee`](https://github.com/shopware/frontends/commit/15bebee0daefacc078ac99fea8725b95fdbc1cc7) Thanks [@mkucmus](https://github.com/mkucmus)! - Extend Criteria type in exported admin API schema |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.16%
17069657
- Lines of code
- increased by0.35%
206830
Worsened metrics
- Number of lines in readme file
- decreased by-0.73%
271
No dependency changes