Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: release #1515

Merged
merged 1 commit into from
Apr 10, 2024
Merged

ci: release #1515

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions .changeset/calm-berries-do.md
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/fifty-carpets-play.md
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/gold-elephants-rescue.md
View file
Open in desktop

This file was deleted.

117 changes: 116 additions & 1 deletion docs/content/5.api/magento-api.api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1251,10 +1251,125 @@
"endIndex": 12
}
},
{
"kind": "Function",
"canonicalReference": "@vue-storefront/magento-api!categories:function(1)",
"docComment": "/**\n * Fetches categories.\n *\n * @param context - Context\n *\n * @param params - \n *\n * @param customQuery - (optional) - custom GraphQL query that extends the default query\n *\n * @param customHeaders - (optional) - custom headers that extends the default headers\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export default function categories(context: "
},
{
"kind": "Reference",
"text": "Context",
"canonicalReference": "@vue-storefront/magento-api!Context:interface"
},
{
"kind": "Content",
"text": ", params: "
},
{
"kind": "Reference",
"text": "QueryCategoriesArgs",
"canonicalReference": "@vue-storefront/magento-types!QueryCategoriesArgs:interface"
},
{
"kind": "Content",
"text": ", customQuery?: "
},
{
"kind": "Reference",
"text": "CustomQuery",
"canonicalReference": "@vue-storefront/magento-types!CustomQuery:type"
},
{
"kind": "Content",
"text": ", customHeaders?: "
},
{
"kind": "Reference",
"text": "CustomHeaders",
"canonicalReference": "@vue-storefront/magento-types!CustomHeaders:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ApolloQueryResult",
"canonicalReference": "@apollo/client/core!ApolloQueryResult:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Query",
"canonicalReference": "@vue-storefront/magento-types!Query:interface"
},
{
"kind": "Content",
"text": "[\"categories\"]>>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "context",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "params",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"parameterName": "customQuery",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "customHeaders",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
}
}
],
"name": "categories"
},
{
"kind": "Function",
"canonicalReference": "@vue-storefront/magento-api!categoryList:function(1)",
"docComment": "/**\n * Fetches the category list.\n *\n * @param context - VSF Context\n *\n * @param params - \n *\n * @param customQuery - (optional) - custom GraphQL query that extends the default query\n *\n * @param customHeaders - (optional) - custom headers that extends the default headers\n */\n",
"docComment": "/**\n * Fetches the category list.\n *\n * @deprecated\n *\n * Use `categories` method instead\n *\n * @param context - VSF Context\n *\n * @param params - \n *\n * @param customQuery - (optional) - custom GraphQL query that extends the default query\n *\n * @param customHeaders - (optional) - custom headers that extends the default headers\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down
210 changes: 209 additions & 1 deletion docs/content/5.api/magento-sdk.api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1786,10 +1786,218 @@
"endIndex": 8
}
},
{
"kind": "Function",
"canonicalReference": "@vue-storefront/magento-sdk!categories:function(1)",
"docComment": "/**\n * Method to list of all categories matching specified filters\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/categories | categories} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/categories | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/categoriesResponse | categoriesResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch list of categories with default parameters\n * const categories = await sdk.magento.categories({});\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for fetching categories.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'categories-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query categories {\n * categories {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch categories.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * categories: 'categories-custom-query',\n * metadata: {\n * fields: 'items { uid name }'\n * }\n * };\n *\n * const categories = await sdk.magento.categories({}, { customQuery });\n *\n * // Category list will contain only the fields specified in the custom query.\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function categories<RES extends "
},
{
"kind": "Reference",
"text": "CategoriesResponse",
"canonicalReference": "@vue-storefront/magento-sdk!CategoriesResponse:type"
},
{
"kind": "Content",
"text": ">(params: "
},
{
"kind": "Reference",
"text": "QueryCategoriesArgs",
"canonicalReference": "@vue-storefront/magento-types!QueryCategoriesArgs:interface"
},
{
"kind": "Content",
"text": ", options?: "
},
{
"kind": "Reference",
"text": "MethodOptions",
"canonicalReference": "@vue-storefront/magento-sdk!MethodOptions:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "CustomQuery",
"canonicalReference": "@vue-storefront/magento-sdk!CustomQuery:type"
},
{
"kind": "Content",
"text": "<'categories'>>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<RES>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "params",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 9
}
}
],
"typeParameters": [
{
"typeParameterName": "RES",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "categories"
},
{
"kind": "TypeAlias",
"canonicalReference": "@vue-storefront/magento-sdk!CategoriesQuery:type",
"docComment": "/**\n * query type for the {@link categories} method.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type CategoriesQuery = "
},
{
"kind": "Content",
"text": "{\n categories: "
},
{
"kind": "Reference",
"text": "Query",
"canonicalReference": "@vue-storefront/magento-types!Query:interface"
},
{
"kind": "Content",
"text": "['categories'];\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "CategoriesQuery",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@vue-storefront/magento-sdk!CategoriesResponse:type",
"docComment": "/**\n * Category result response type\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type CategoriesResponse<T extends "
},
{
"kind": "Reference",
"text": "DeepPartial",
"canonicalReference": "ts-essentials!DeepPartial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "CategoriesQuery",
"canonicalReference": "@vue-storefront/magento-sdk!CategoriesQuery:type"
},
{
"kind": "Content",
"text": "> "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Reference",
"text": "CategoriesQuery",
"canonicalReference": "@vue-storefront/magento-sdk!CategoriesQuery:type"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Reference",
"text": "ApolloQueryResult",
"canonicalReference": "@apollo/client/core!ApolloQueryResult:type"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "CategoriesResponse",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
}
}
],
"typeTokenRange": {
"startIndex": 8,
"endIndex": 10
}
},
{
"kind": "Function",
"canonicalReference": "@vue-storefront/magento-sdk!categoryList:function(1)",
"docComment": "/**\n * Method to list of all categories without filters\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/categoryList | categoryList} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/categoryList | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CategoryListResponse | CategoryListResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch list of categories with default parameters\n * const categoryList = await sdk.magento.categoryList({});\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for adding product details.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'category-list-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query categoryList {\n * categories {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch product details.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * categoryList: 'category-list-custom-query',\n * metadata: {\n * fields: 'items { uid name }'\n * }\n * };\n *\n * const categoryList = await sdk.magento.categoryList({}, { customQuery });\n *\n * // Category list will contain only the fields specified in the custom query.\n * ```\n *\n */\n",
"docComment": "/**\n * Method to list of all categories without filters\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/categoryList | categoryList} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/categoryList | here}.\n *\n * @deprecated\n *\n * Use `categories` method instead\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CategoryListResponse | CategoryListResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch list of categories with default parameters\n * const categoryList = await sdk.magento.categoryList({});\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for adding product details.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'category-list-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query categoryList {\n * categories {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch product details.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * categoryList: 'category-list-custom-query',\n * metadata: {\n * fields: 'items { uid name }'\n * }\n * };\n *\n * const categoryList = await sdk.magento.categoryList({}, { customQuery });\n *\n * // Category list will contain only the fields specified in the custom query.\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down
Loading
Loading