@wix/auto_sdk_blog_categories 1.0.24 → 1.0.26

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { Category, CreateCategoryOptions, UpdateCategory, UpdateCategoryOptions, GetCategoryOptions, GetCategoryResponse, GetCategoryBySlugOptions, GetCategoryBySlugResponse, ListCategoriesOptions, ListCategoriesResponse, QueryCategoriesOptions, CategoriesQueryBuilder, CategoryCreatedEnvelope, CategoryDeletedEnvelope, CategoryUpdatedEnvelope } from './index.typings.js';
-export { ActionEvent, ApplicationError, BaseEventMetadata, BlogPaging, BulkActionMetadata, BulkCategoryResult, BulkCreateCategoriesRequest, BulkCreateCategoriesResponse, BulkDeleteCategoryRequest, BulkDeleteCategoryResponse, BulkUpdateCategoriesRequest, BulkUpdateCategoriesResponse, CategoriesQueryResult, CategoryLanguageCount, CategoryTranslation, CreateCategoryRequest, CreateCategoryResponse, CursorPaging, Cursors, DeleteCategoryRequest, DeleteCategoryResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, Field, FieldWithLiterals, FocalPoint, GetCategoriesCountByLanguageRequest, GetCategoriesCountByLanguageResponse, GetCategoryBySlugRequest, GetCategoryRequest, IdentificationData, IdentificationDataIdOneOf, InitialCategoriesCopied, ItemMetadata, Keyword, ListCategoriesRequest, MaskedCategory, MessageEnvelope, MetaData, Paging, PagingMetadataV2, PlatformQuery, PlatformQueryPagingMethodOneOf, QueryCategoriesRequest, QueryCategoriesResponse, RestoreInfo, SeoSchema, Settings, SortOrder, SortOrderWithLiterals, Sorting, Tag, UpdateCategoryRequest, UpdateCategoryResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
+import { Category, CreateCategoryOptions, UpdateCategory, UpdateCategoryOptions, GetCategoryOptions, GetCategoryResponse, GetCategoryBySlugOptions, GetCategoryBySlugResponse, ListCategoriesOptions, ListCategoriesResponse, CategoryCreatedEnvelope, CategoryDeletedEnvelope, CategoryUpdatedEnvelope, PlatformQuery, typedQueryCategories, QueryCategoriesOptions, CategoriesQueryBuilder } from './index.typings.js';
+export { ActionEvent, ApplicationError, BaseEventMetadata, BlogPaging, BulkActionMetadata, BulkCategoryResult, BulkCreateCategoriesRequest, BulkCreateCategoriesResponse, BulkDeleteCategoryRequest, BulkDeleteCategoryResponse, BulkUpdateCategoriesRequest, BulkUpdateCategoriesResponse, CategoriesQueryResult, CategoryLanguageCount, CategoryTranslation, CreateCategoryRequest, CreateCategoryResponse, CursorPaging, Cursors, DeleteCategoryRequest, DeleteCategoryResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, Field, FieldWithLiterals, FocalPoint, GetCategoriesCountByLanguageRequest, GetCategoriesCountByLanguageResponse, GetCategoryBySlugRequest, GetCategoryRequest, IdentificationData, IdentificationDataIdOneOf, InitialCategoriesCopied, ItemMetadata, Keyword, ListCategoriesRequest, MaskedCategory, MessageEnvelope, MetaData, Paging, PagingMetadataV2, PlatformQueryPagingMethodOneOf, QueryCategoriesRequest, QueryCategoriesResponse, RestoreInfo, SeoSchema, Settings, SortOrder, SortOrderWithLiterals, Sorting, Tag, UpdateCategoryRequest, UpdateCategoryResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
 
 declare function createCategory$1(httpClient: HttpClient): CreateCategorySignature;
 interface CreateCategorySignature {
@@ -63,27 +63,6 @@ interface ListCategoriesSignature {
      */
     (options?: ListCategoriesOptions): Promise<NonNullablePaths<ListCategoriesResponse, `categories` | `categories.${number}._id` | `categories.${number}.label` | `categories.${number}.postCount` | `categories.${number}.title` | `categories.${number}.slug` | `categories.${number}.seoData.settings.preventAutoRedirect` | `metaData.count` | `metaData.offset` | `metaData.total`, 6>>;
 }
-declare function queryCategories$1(httpClient: HttpClient): QueryCategoriesSignature;
-interface QueryCategoriesSignature {
-    /**
-     * Creates a query to retrieve a list of categories.
-     *
-     *
-     * The Query Categories method builds a query to retrieve a list of up to 100 categories per language, and returns a [`CategoriesQueryBuilder`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/ascending) object.
-     *
-     * The response contains the query definition, which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/find) method.
-     *
-     * You can refine the query by chaining `CategoriesQueryBuilder` methods to the query. `CategoriesQueryBuilder` methods enable you to sort, filter, and control the results that Query Categories returns. Any methods chained to the Query Categories method are applied in the order that they are called.
-     *
-     * Query Categories runs with these `CategoriesQueryBuilder` defaults, which you can override.
-     * - [`limit(100)`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/limit)
-     * - [`ascending(displayPosition)`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/ascending)
-     *
-     * The following `CategoriesQueryBuilder` methods are supported for Query Categories. For a full description of the `Categories` object, see the response for the [`items`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-result/items) property in [`CategoriesQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesqueryresult).
-     * @param - Options specifying which fields to return.
-     */
-    (options?: QueryCategoriesOptions): CategoriesQueryBuilder;
-}
 declare function deleteCategory$1(httpClient: HttpClient): DeleteCategorySignature;
 interface DeleteCategorySignature {
     /**
@@ -96,13 +75,19 @@ declare const onCategoryCreated$1: EventDefinition<CategoryCreatedEnvelope, "wix
 declare const onCategoryDeleted$1: EventDefinition<CategoryDeletedEnvelope, "wix.blog.v3.category_deleted">;
 declare const onCategoryUpdated$1: EventDefinition<CategoryUpdatedEnvelope, "wix.blog.v3.category_updated">;
 
+declare function customQueryCategories(httpClient: HttpClient): {
+    (query: PlatformQuery): ReturnType<typeof typedQueryCategories>;
+    (query: PlatformQuery, options: QueryCategoriesOptions): ReturnType<typeof typedQueryCategories>;
+    (): CategoriesQueryBuilder;
+    (options: QueryCategoriesOptions): CategoriesQueryBuilder;
+};
 declare const createCategory: MaybeContext<BuildRESTFunction<typeof createCategory$1> & typeof createCategory$1>;
 declare const updateCategory: MaybeContext<BuildRESTFunction<typeof updateCategory$1> & typeof updateCategory$1>;
 declare const getCategory: MaybeContext<BuildRESTFunction<typeof getCategory$1> & typeof getCategory$1>;
 declare const getCategoryBySlug: MaybeContext<BuildRESTFunction<typeof getCategoryBySlug$1> & typeof getCategoryBySlug$1>;
 declare const listCategories: MaybeContext<BuildRESTFunction<typeof listCategories$1> & typeof listCategories$1>;
-declare const queryCategories: MaybeContext<BuildRESTFunction<typeof queryCategories$1> & typeof queryCategories$1>;
 declare const deleteCategory: MaybeContext<BuildRESTFunction<typeof deleteCategory$1> & typeof deleteCategory$1>;
+declare const queryCategories: MaybeContext<BuildRESTFunction<typeof customQueryCategories> & typeof customQueryCategories>;
 /**
  * Triggered when a category is created.
  */
@@ -116,4 +101,4 @@ declare const onCategoryDeleted: BuildEventDefinition<typeof onCategoryDeleted$1
  */
 declare const onCategoryUpdated: BuildEventDefinition<typeof onCategoryUpdated$1> & typeof onCategoryUpdated$1;
 
-export { CategoriesQueryBuilder, Category, CategoryCreatedEnvelope, CategoryDeletedEnvelope, CategoryUpdatedEnvelope, CreateCategoryOptions, GetCategoryBySlugOptions, GetCategoryBySlugResponse, GetCategoryOptions, GetCategoryResponse, ListCategoriesOptions, ListCategoriesResponse, QueryCategoriesOptions, UpdateCategory, UpdateCategoryOptions, createCategory, deleteCategory, getCategory, getCategoryBySlug, listCategories, onCategoryCreated, onCategoryDeleted, onCategoryUpdated, queryCategories, updateCategory };
+export { CategoriesQueryBuilder, Category, CategoryCreatedEnvelope, CategoryDeletedEnvelope, CategoryUpdatedEnvelope, CreateCategoryOptions, GetCategoryBySlugOptions, GetCategoryBySlugResponse, GetCategoryOptions, GetCategoryResponse, ListCategoriesOptions, ListCategoriesResponse, PlatformQuery, QueryCategoriesOptions, UpdateCategory, UpdateCategoryOptions, createCategory, deleteCategory, getCategory, getCategoryBySlug, listCategories, onCategoryCreated, onCategoryDeleted, onCategoryUpdated, queryCategories, updateCategory };

package/build/cjs/index.js

@@ -774,6 +774,46 @@ function queryCategories2(options) {
     transformationPaths: {}
   });
 }
+async function typedQueryCategories(query, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    query,
+    ...options
+  });
+  const reqOpts = queryCategories(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(
+      (0, import_transform_paths2.transformPaths)(result.data, [
+        {
+          transformFn: import_page_url2.transformRESTPageURLToSDKPageURL,
+          paths: [
+            { path: "categories.url" },
+            { path: "categories.translations.url" }
+          ]
+        },
+        {
+          transformFn: import_image2.transformRESTImageToSDKImage,
+          paths: [{ path: "categories.coverImage" }]
+        }
+      ])
+    );
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { query: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["query", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 async function deleteCategory2(categoryId) {
   const { httpClient, sideEffects } = arguments[1];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
@@ -847,6 +887,14 @@ function queryCategories3(httpClient) {
     { httpClient }
   );
 }
+function typedQueryCategories2(httpClient) {
+  return (query, options) => typedQueryCategories(
+    query,
+    options,
+    // @ts-ignore
+    { httpClient }
+  );
+}
 function deleteCategory3(httpClient) {
   return (categoryId) => deleteCategory2(
     categoryId,
@@ -930,13 +978,25 @@ var onCategoryUpdated = (0, import_sdk_types.EventDefinition)(
 // src/blog-v3-category-categories.context.ts
 var import_rest_modules3 = require("@wix/sdk-runtime/rest-modules");
 var import_event_definition_modules = require("@wix/sdk-runtime/event-definition-modules");
+var import_query_method_router = require("@wix/sdk-runtime/query-method-router");
+function customQueryCategories(httpClient) {
+  const router = (0, import_query_method_router.createQueryOverloadRouter)({
+    builderQueryFunction: (options) => queryCategories3(httpClient)(options),
+    typedQueryFunction: (query, options) => typedQueryCategories2(httpClient)(query, options),
+    hasOptionsParameter: true
+  });
+  function overloadedQuery(queryOrOptions, options) {
+    return router(...arguments);
+  }
+  return overloadedQuery;
+}
 var createCategory4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(createCategory3);
 var updateCategory4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(updateCategory3);
 var getCategory4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getCategory3);
 var getCategoryBySlug4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getCategoryBySlug3);
 var listCategories4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(listCategories3);
-var queryCategories4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(queryCategories3);
 var deleteCategory4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(deleteCategory3);
+var queryCategories4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(customQueryCategories);
 var onCategoryCreated2 = (0, import_event_definition_modules.createEventModule)(onCategoryCreated);
 var onCategoryDeleted2 = (0, import_event_definition_modules.createEventModule)(onCategoryDeleted);
 var onCategoryUpdated2 = (0, import_event_definition_modules.createEventModule)(onCategoryUpdated);