@wix/auto_sdk_editor-branches_branches 1.0.26 → 1.0.28

package/build/cjs/index.d.ts

@@ -1,14 +1,13 @@
 import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { Branch, CreateBranchApplicationErrors, UpdateBranch, UpdateBranchApplicationErrors, DeleteBranchApplicationErrors, BranchesQueryBuilder, BranchCreatedEnvelope, BranchDeletedEnvelope, BranchUpdatedEnvelope } from './index.typings.js';
-export { ActionEvent, Asset, BaseEventMetadata, BranchSourceOneOf, BranchesQueryResult, CreateBranchRequest, CreateBranchResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteBranchRequest, DeleteBranchResponse, DeleteContext, DeleteStatus, DeleteStatusWithLiterals, DomainEvent, DomainEventBodyOneOf, EditorType, EditorTypeOptions, EditorTypeOptionsWithLiterals, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, GetBranchRequest, GetBranchResponse, GetDefaultBranchRequest, GetDefaultBranchResponse, HtmlSitePublished, IdentificationData, IdentificationDataIdOneOf, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Namespace, NamespaceChanged, NamespaceWithLiterals, OdeditorAssigned, OdeditorUnassigned, Page, PicassoAssigned, PicassoUnassigned, QueryBranchesRequest, QueryBranchesResponse, RestoreInfo, ServiceProvisioned, ServiceRemoved, SetDefaultBranchRequest, SetDefaultBranchResponse, SiteCreated, SiteCreatedContext, SiteCreatedContextWithLiterals, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SortOrder, SortOrderWithLiterals, Sorting, SourceBranch, SourceTemplate, SourceType, SourceTypeWithLiterals, State, StateWithLiterals, StudioAssigned, StudioTwoAssigned, StudioTwoUnassigned, StudioUnassigned, Type, TypeWithLiterals, UpdateBranchRequest, UpdateBranchResponse, UpdateExtendedFieldsRequest, UpdateExtendedFieldsResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WixelAssigned, WixelUnassigned } from './index.typings.js';
+import { Branch, CreateBranchApplicationErrors, UpdateBranch, UpdateBranchApplicationErrors, DeleteBranchApplicationErrors, SetDefaultBranchResponse, GetDefaultBranchResponse, BranchCreatedEnvelope, BranchDeletedEnvelope, BranchUpdatedEnvelope, BranchesQueryBuilder, CursorQuery, typedQueryBranches } from './index.typings.js';
+export { ActionEvent, Asset, BaseEventMetadata, BranchSourceOneOf, BranchesQueryResult, CreateBranchRequest, CreateBranchResponse, CursorPaging, CursorPagingMetadata, CursorQueryPagingMethodOneOf, Cursors, DeleteBranchRequest, DeleteBranchResponse, DeleteContext, DeleteStatus, DeleteStatusWithLiterals, DomainEvent, DomainEventBodyOneOf, EditorType, EditorTypeOptions, EditorTypeOptionsWithLiterals, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, GetBranchRequest, GetBranchResponse, GetDefaultBranchRequest, HtmlSitePublished, IdentificationData, IdentificationDataIdOneOf, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Namespace, NamespaceChanged, NamespaceWithLiterals, OdeditorAssigned, OdeditorUnassigned, Page, PicassoAssigned, PicassoUnassigned, QueryBranchesRequest, QueryBranchesResponse, RestoreInfo, ServiceProvisioned, ServiceRemoved, SetDefaultBranchRequest, SiteCreated, SiteCreatedContext, SiteCreatedContextWithLiterals, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SortOrder, SortOrderWithLiterals, Sorting, SourceBranch, SourceTemplate, SourceType, SourceTypeWithLiterals, State, StateWithLiterals, StudioAssigned, StudioTwoAssigned, StudioTwoUnassigned, StudioUnassigned, Type, TypeWithLiterals, UpdateBranchRequest, UpdateBranchResponse, UpdateExtendedFieldsRequest, UpdateExtendedFieldsResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WixelAssigned, WixelUnassigned } from './index.typings.js';
 
 declare function createBranch$1(httpClient: HttpClient): CreateBranchSignature;
 interface CreateBranchSignature {
     /**
      * Creates a branch.
-     * If a source branch is not provided, the branch will include a blank website.
      *
-     * If a source branch is not provided, the branch will include a blank website.
+     * If a source branch isn't provided, the branch will include a blank website.
      *
      * > **Important:** Align the `sourceType` field with its corresponding source properties:
      * > - When `sourceType` is `SOURCE_BRANCH`, provide `sourceBranchProperties`.
@@ -54,22 +53,36 @@ interface DeleteBranchSignature {
         __applicationErrorsType?: DeleteBranchApplicationErrors;
     }>;
 }
-declare function queryBranches$1(httpClient: HttpClient): QueryBranchesSignature;
-interface QueryBranchesSignature {
+declare function setDefaultBranch$1(httpClient: HttpClient): SetDefaultBranchSignature;
+interface SetDefaultBranchSignature {
     /**
-     * Retrieves a list of branches, given the specified [paging, filtering, and sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
+     * Sets the specified branch as the default.
+     * @param - Branch ID.
      */
-    (): BranchesQueryBuilder;
+    (branchId: string): Promise<NonNullablePaths<SetDefaultBranchResponse, `branch.sourceBranchProperties.branchId` | `branch.sourceTemplateProperties.templateId` | `branch.type` | `branch.sourceType` | `branch.editorType.editorTypeOptions`, 4>>;
+}
+declare function getDefaultBranch$1(httpClient: HttpClient): GetDefaultBranchSignature;
+interface GetDefaultBranchSignature {
+    /**
+     * Retrieves the default branch.
+     */
+    (): Promise<NonNullablePaths<GetDefaultBranchResponse, `branch.sourceBranchProperties.branchId` | `branch.sourceTemplateProperties.templateId` | `branch.type` | `branch.sourceType` | `branch.editorType.editorTypeOptions`, 4>>;
 }
 declare const onBranchCreated$1: EventDefinition<BranchCreatedEnvelope, "wix.editor.branches.v1.branch_created">;
 declare const onBranchDeleted$1: EventDefinition<BranchDeletedEnvelope, "wix.editor.branches.v1.branch_deleted">;
 declare const onBranchUpdated$1: EventDefinition<BranchUpdatedEnvelope, "wix.editor.branches.v1.branch_updated">;
 
+declare function customQueryBranches(httpClient: HttpClient): {
+    (): BranchesQueryBuilder;
+    (query: CursorQuery): ReturnType<typeof typedQueryBranches>;
+};
 declare const createBranch: MaybeContext<BuildRESTFunction<typeof createBranch$1> & typeof createBranch$1>;
 declare const getBranch: MaybeContext<BuildRESTFunction<typeof getBranch$1> & typeof getBranch$1>;
 declare const updateBranch: MaybeContext<BuildRESTFunction<typeof updateBranch$1> & typeof updateBranch$1>;
 declare const deleteBranch: MaybeContext<BuildRESTFunction<typeof deleteBranch$1> & typeof deleteBranch$1>;
-declare const queryBranches: MaybeContext<BuildRESTFunction<typeof queryBranches$1> & typeof queryBranches$1>;
+declare const setDefaultBranch: MaybeContext<BuildRESTFunction<typeof setDefaultBranch$1> & typeof setDefaultBranch$1>;
+declare const getDefaultBranch: MaybeContext<BuildRESTFunction<typeof getDefaultBranch$1> & typeof getDefaultBranch$1>;
+declare const queryBranches: MaybeContext<BuildRESTFunction<typeof customQueryBranches> & typeof customQueryBranches>;
 /**
  * Triggered when a branch is created.
  */
@@ -83,4 +96,4 @@ declare const onBranchDeleted: BuildEventDefinition<typeof onBranchDeleted$1> &
  */
 declare const onBranchUpdated: BuildEventDefinition<typeof onBranchUpdated$1> & typeof onBranchUpdated$1;
 
-export { Branch, BranchCreatedEnvelope, BranchDeletedEnvelope, BranchUpdatedEnvelope, BranchesQueryBuilder, CreateBranchApplicationErrors, DeleteBranchApplicationErrors, UpdateBranch, UpdateBranchApplicationErrors, createBranch, deleteBranch, getBranch, onBranchCreated, onBranchDeleted, onBranchUpdated, queryBranches, updateBranch };
+export { Branch, BranchCreatedEnvelope, BranchDeletedEnvelope, BranchUpdatedEnvelope, BranchesQueryBuilder, CreateBranchApplicationErrors, CursorQuery, DeleteBranchApplicationErrors, GetDefaultBranchResponse, SetDefaultBranchResponse, UpdateBranch, UpdateBranchApplicationErrors, createBranch, deleteBranch, getBranch, getDefaultBranch, onBranchCreated, onBranchDeleted, onBranchUpdated, queryBranches, setDefaultBranch, updateBranch };

package/build/cjs/index.js

@@ -572,6 +572,29 @@ function queryBranches2() {
     transformationPaths: {}
   });
 }
+async function typedQueryBranches(query) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({ query });
+  const reqOpts = queryBranches(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { query: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["query"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 async function setDefaultBranch2(branchId) {
   const { httpClient, sideEffects } = arguments[1];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({ branchId });
@@ -655,6 +678,13 @@ function queryBranches3(httpClient) {
     { httpClient }
   );
 }
+function typedQueryBranches2(httpClient) {
+  return (query) => typedQueryBranches(
+    query,
+    // @ts-ignore
+    { httpClient }
+  );
+}
 function setDefaultBranch3(httpClient) {
   return (branchId) => setDefaultBranch2(
     branchId,
@@ -720,13 +750,25 @@ var onBranchUpdated = (0, import_sdk_types.EventDefinition)(
 // src/editor-branches-v1-branch-branches.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 customQueryBranches(httpClient) {
+  const router = (0, import_query_method_router.createQueryOverloadRouter)({
+    builderQueryFunction: () => queryBranches3(httpClient)(),
+    typedQueryFunction: (query) => typedQueryBranches2(httpClient)(query),
+    hasOptionsParameter: false
+  });
+  function overloadedQuery(query) {
+    return router(...arguments);
+  }
+  return overloadedQuery;
+}
 var createBranch4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(createBranch3);
 var getBranch4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getBranch3);
 var updateBranch4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(updateBranch3);
 var deleteBranch4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(deleteBranch3);
-var queryBranches4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(queryBranches3);
 var setDefaultBranch4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(setDefaultBranch3);
 var getDefaultBranch4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getDefaultBranch3);
+var queryBranches4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(customQueryBranches);
 var onBranchCreated2 = (0, import_event_definition_modules.createEventModule)(onBranchCreated);
 var onBranchDeleted2 = (0, import_event_definition_modules.createEventModule)(onBranchDeleted);
 var onBranchUpdated2 = (0, import_event_definition_modules.createEventModule)(onBranchUpdated);