@wix/auto_sdk_blog_posts 1.0.35 → 1.0.37

package/build/cjs/index.d.ts

@@ -1,7 +1,8 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { QueryPostCountStatsOptions, QueryPostCountStatsResponse, GetTotalPostsOptions, GetTotalPostsResponse, GetPostOptions, GetPostResponse, GetPostBySlugOptions, GetPostBySlugResponse, ListPostsOptions, ListPostsResponse, QueryPostsOptions, PostsQueryBuilder, GetPostMetricsResponse, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope } from './index.typings.js';
-export { ActionEvent, Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, CaptionData, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CoverMedia, CoverMediaMediaOneOf, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, Design, Dimensions, Direction, DividerData, DocumentStyle, DomainEvent, DomainEventBodyOneOf, DraftPost, DraftPostTranslation, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, Field, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontSizeData, FontType, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GetPostBySlugRequest, GetPostMetricsRequest, GetPostRequest, GetPostTemplatesSort, GetPostsSort, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsRequest, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, InitialExpandedItems, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutType, LikePostRequest, LikePostResponse, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsRequest, ListTemplatesRequest, ListTemplatesResponse, ListValue, MapData, MapSettings, MapType, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, ModerationStatusStatus, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Oembed, OldBlogMigratedEvent, Option, OptionDesign, OptionLayout, Order, OrderedListData, Orientation, Origin, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, PollSettings, Position, Post, PostCategoriesUpdated, PostCountInfo, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostFieldField, PostLiked, PostLikedInitiatorOneOf, PostOwnerChanged, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedInitiatorOneOf, PostsQueryResult, QueryPostCountStatsRequest, QueryPostsRequest, QueryPostsResponse, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsResponse, Reactions, Rel, RestoreInfo, RichContent, ScheduledPostPublished, SeoSchema, Settings, SortOrder, Sorting, Source, Spoiler, SpoilerData, Status, Styles, StylesBorder, TableCellData, TableData, Tag, Target, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Type, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, VerticalAlignment, Video, VideoData, VideoResolution, ViewMode, ViewPostRequest, ViewPostResponse, ViewRole, VoteRole, WebhookIdentityType, Width, WidthType, WixMedia } from './index.typings.js';
+export { ActionEvent, Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AspectRatio, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, ButtonDataType, ButtonStyles, CaptionData, CardStyles, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CoverMedia, CoverMediaMediaOneOf, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, Design, Dimensions, Direction, DividerData, DividerDataAlignment, DocumentStyle, DomainEvent, DomainEventBodyOneOf, DraftPost, DraftPostTranslation, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, Field, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontSizeData, FontType, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GalleryOptionsLayout, GetPostBySlugRequest, GetPostMetricsRequest, GetPostRequest, GetPostTemplatesSort, GetPostsSort, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsRequest, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, ImageStyles, InitialExpandedItems, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutType, LikePostRequest, LikePostResponse, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsRequest, ListTemplatesRequest, ListTemplatesResponse, ListValue, MapData, MapSettings, MapType, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, ModerationStatusStatus, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Oembed, OldBlogMigratedEvent, Option, OptionDesign, OptionLayout, Order, OrderedListData, Orientation, Origin, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, Placement, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, PollSettings, Position, Post, PostCategoriesUpdated, PostCountInfo, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostFieldField, PostLiked, PostLikedInitiatorOneOf, PostOwnerChanged, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedInitiatorOneOf, PostsQueryResult, QueryPostCountStatsRequest, QueryPostsRequest, QueryPostsResponse, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsResponse, Reactions, Rel, Resizing, RestoreInfo, RibbonStyles, RichContent, ScheduledPostPublished, SeoSchema, Settings, SortOrder, Sorting, Source, Spoiler, SpoilerData, Status, Styles, StylesBorder, StylesPosition, TableCellData, TableData, Tag, Target, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Type, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, VerticalAlignment, Video, VideoData, VideoResolution, ViewMode, ViewPostRequest, ViewPostResponse, ViewRole, VoteRole, WebhookIdentityType, Width, WidthType, WixMedia } from './index.typings.js';
 
+type PostNonNullablePaths = `_id` | `title` | `excerpt` | `slug` | `featured` | `pinned` | `categoryIds` | `coverMedia.enabled` | `coverMedia.displayed` | `coverMedia.custom` | `memberId` | `hashtags` | `commentingEnabled` | `minutesToRead` | `tagIds` | `relatedPostIds` | `pricingPlanIds` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `preview` | `moderationDetails.submittedBy` | `moderationDetails.status` | `media.embedMedia.thumbnail.url` | `media.embedMedia.thumbnail.width` | `media.embedMedia.thumbnail.height` | `media.embedMedia.video.url` | `media.embedMedia.video.width` | `media.embedMedia.video.height` | `media.displayed` | `media.custom` | `hasUnpublishedChanges`;
 declare function queryPostCountStats$1(httpClient: HttpClient): QueryPostCountStatsSignature;
 interface QueryPostCountStatsSignature {
     /**
@@ -16,7 +17,7 @@ interface QueryPostCountStatsSignature {
      * @param - Options specifying time frame, sort, and filter.
      * @returns Get Blog Post Count Stats response
      */
-    (options?: QueryPostCountStatsOptions | undefined): Promise<QueryPostCountStatsResponse>;
+    (options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`>>;
 }
 declare function getTotalPosts$1(httpClient: HttpClient): GetTotalPostsSignature;
 interface GetTotalPostsSignature {
@@ -24,7 +25,7 @@ interface GetTotalPostsSignature {
      * Retrieves the total amount of published posts of the blog.
      * @param - Language Options.
      */
-    (options?: GetTotalPostsOptions | undefined): Promise<GetTotalPostsResponse>;
+    (options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`>>;
 }
 declare function getPost$1(httpClient: HttpClient): GetPostSignature;
 interface GetPostSignature {
@@ -33,7 +34,9 @@ interface GetPostSignature {
      * @param - Post ID.
      * @param - Options specifying which fields to return.
      */
-    (postId: string, options?: GetPostOptions | undefined): Promise<GetPostResponse>;
+    (postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, {
+        [P in PostNonNullablePaths]: `post.${P}`;
+    }[PostNonNullablePaths]>>;
 }
 declare function getPostBySlug$1(httpClient: HttpClient): GetPostBySlugSignature;
 interface GetPostBySlugSignature {
@@ -47,7 +50,9 @@ interface GetPostBySlugSignature {
      * @param - Slug of the post to retrieve.
      * @param - Options specifying which fields to return.
      */
-    (slug: string, options?: GetPostBySlugOptions | undefined): Promise<GetPostBySlugResponse>;
+    (slug: string, options?: GetPostBySlugOptions): Promise<NonNullablePaths<GetPostBySlugResponse, {
+        [P in PostNonNullablePaths]: `post.${P}`;
+    }[PostNonNullablePaths]>>;
 }
 declare function listPosts$1(httpClient: HttpClient): ListPostsSignature;
 interface ListPostsSignature {
@@ -60,7 +65,9 @@ interface ListPostsSignature {
      * - `paging.offset` is `0`.
      * @param - Sort, filter, and paging options.
      */
-    (options?: ListPostsOptions | undefined): Promise<ListPostsResponse>;
+    (options?: ListPostsOptions): Promise<NonNullablePaths<ListPostsResponse, {
+        [P in PostNonNullablePaths]: `posts.${number}.${P}`;
+    }[PostNonNullablePaths] | `metaData.count` | `metaData.offset` | `metaData.total`>>;
 }
 declare function queryPosts$1(httpClient: HttpClient): QueryPostsSignature;
 interface QueryPostsSignature {
@@ -85,7 +92,7 @@ interface QueryPostsSignature {
      * The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the `items` property in `PostsQueryResult`.
      * @param - Options specifying which fields to return.
      */
-    (options?: QueryPostsOptions | undefined): PostsQueryBuilder;
+    (options?: QueryPostsOptions): PostsQueryBuilder;
 }
 declare function getPostMetrics$1(httpClient: HttpClient): GetPostMetricsSignature;
 interface GetPostMetricsSignature {
@@ -95,7 +102,7 @@ interface GetPostMetricsSignature {
      * A post's metrics include the comments, likes, and views the post receives.
      * @param - Post ID to retrieve metrics for.
      */
-    (postId: string): Promise<GetPostMetricsResponse>;
+    (postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`>>;
 }
 declare const onPostCreated$1: EventDefinition<PostCreatedEnvelope, "wix.blog.v3.post_created">;
 declare const onPostDeleted$1: EventDefinition<PostDeletedEnvelope, "wix.blog.v3.post_deleted">;

package/build/cjs/index.js

@@ -22,16 +22,20 @@ var index_exports = {};
 __export(index_exports, {
   Alignment: () => Alignment,
   AppType: () => AppType,
+  AspectRatio: () => AspectRatio,
   BackgroundType: () => BackgroundType,
+  ButtonDataType: () => ButtonDataType,
   Crop: () => Crop,
   DecorationType: () => DecorationType,
   Direction: () => Direction,
+  DividerDataAlignment: () => DividerDataAlignment,
   Field: () => Field,
   FontType: () => FontType,
   GIFType: () => GIFType,
   GetPostTemplatesSort: () => GetPostTemplatesSort,
   GetPostsSort: () => GetPostsSort,
   InitialExpandedItems: () => InitialExpandedItems,
+  Layout: () => Layout,
   LayoutType: () => LayoutType,
   LineStyle: () => LineStyle,
   MapType: () => MapType,
@@ -41,15 +45,18 @@ __export(index_exports, {
   Order: () => Order,
   Orientation: () => Orientation,
   Origin: () => Origin,
+  Placement: () => Placement,
   PluginContainerDataAlignment: () => PluginContainerDataAlignment,
   PollLayoutDirection: () => PollLayoutDirection,
   PollLayoutType: () => PollLayoutType,
   Position: () => Position,
   PostFieldField: () => PostFieldField,
   QueryPublicationsCountStatsRequestOrder: () => QueryPublicationsCountStatsRequestOrder,
+  Resizing: () => Resizing,
   SortOrder: () => SortOrder,
   Source: () => Source,
   Status: () => Status,
+  StylesPosition: () => StylesPosition,
   Target: () => Target,
   TextAlignment: () => TextAlignment,
   ThumbnailsAlignment: () => ThumbnailsAlignment,
@@ -980,11 +987,11 @@ var PluginContainerDataAlignment = /* @__PURE__ */ ((PluginContainerDataAlignmen
   PluginContainerDataAlignment2["RIGHT"] = "RIGHT";
   return PluginContainerDataAlignment2;
 })(PluginContainerDataAlignment || {});
-var Type = /* @__PURE__ */ ((Type2) => {
-  Type2["LINK"] = "LINK";
-  Type2["ACTION"] = "ACTION";
-  return Type2;
-})(Type || {});
+var ButtonDataType = /* @__PURE__ */ ((ButtonDataType2) => {
+  ButtonDataType2["LINK"] = "LINK";
+  ButtonDataType2["ACTION"] = "ACTION";
+  return ButtonDataType2;
+})(ButtonDataType || {});
 var Target = /* @__PURE__ */ ((Target2) => {
   Target2["SELF"] = "SELF";
   Target2["BLANK"] = "BLANK";
@@ -1013,12 +1020,12 @@ var Width = /* @__PURE__ */ ((Width2) => {
   Width2["SMALL"] = "SMALL";
   return Width2;
 })(Width || {});
-var Alignment = /* @__PURE__ */ ((Alignment2) => {
-  Alignment2["CENTER"] = "CENTER";
-  Alignment2["LEFT"] = "LEFT";
-  Alignment2["RIGHT"] = "RIGHT";
-  return Alignment2;
-})(Alignment || {});
+var DividerDataAlignment = /* @__PURE__ */ ((DividerDataAlignment2) => {
+  DividerDataAlignment2["CENTER"] = "CENTER";
+  DividerDataAlignment2["LEFT"] = "LEFT";
+  DividerDataAlignment2["RIGHT"] = "RIGHT";
+  return DividerDataAlignment2;
+})(DividerDataAlignment || {});
 var ViewMode = /* @__PURE__ */ ((ViewMode2) => {
   ViewMode2["NONE"] = "NONE";
   ViewMode2["FULL"] = "FULL";
@@ -1066,13 +1073,13 @@ var Source = /* @__PURE__ */ ((Source2) => {
   Source2["ADSENSE"] = "ADSENSE";
   return Source2;
 })(Source || {});
-var Position = /* @__PURE__ */ ((Position2) => {
-  Position2["START"] = "START";
-  Position2["END"] = "END";
-  Position2["TOP"] = "TOP";
-  Position2["HIDDEN"] = "HIDDEN";
-  return Position2;
-})(Position || {});
+var StylesPosition = /* @__PURE__ */ ((StylesPosition2) => {
+  StylesPosition2["START"] = "START";
+  StylesPosition2["END"] = "END";
+  StylesPosition2["TOP"] = "TOP";
+  StylesPosition2["HIDDEN"] = "HIDDEN";
+  return StylesPosition2;
+})(StylesPosition || {});
 var MapType = /* @__PURE__ */ ((MapType2) => {
   MapType2["ROADMAP"] = "ROADMAP";
   MapType2["SATELITE"] = "SATELITE";
@@ -1125,6 +1132,43 @@ var FontType = /* @__PURE__ */ ((FontType2) => {
   FontType2["EM"] = "EM";
   return FontType2;
 })(FontType || {});
+var Position = /* @__PURE__ */ ((Position2) => {
+  Position2["START"] = "START";
+  Position2["END"] = "END";
+  Position2["TOP"] = "TOP";
+  return Position2;
+})(Position || {});
+var AspectRatio = /* @__PURE__ */ ((AspectRatio2) => {
+  AspectRatio2["SQUARE"] = "SQUARE";
+  AspectRatio2["RECTANGLE"] = "RECTANGLE";
+  return AspectRatio2;
+})(AspectRatio || {});
+var Resizing = /* @__PURE__ */ ((Resizing2) => {
+  Resizing2["FILL"] = "FILL";
+  Resizing2["FIT"] = "FIT";
+  return Resizing2;
+})(Resizing || {});
+var Placement = /* @__PURE__ */ ((Placement2) => {
+  Placement2["IMAGE"] = "IMAGE";
+  Placement2["PRODUCT_INFO"] = "PRODUCT_INFO";
+  return Placement2;
+})(Placement || {});
+var Type = /* @__PURE__ */ ((Type2) => {
+  Type2["CONTAINED"] = "CONTAINED";
+  Type2["FRAMELESS"] = "FRAMELESS";
+  return Type2;
+})(Type || {});
+var Alignment = /* @__PURE__ */ ((Alignment2) => {
+  Alignment2["START"] = "START";
+  Alignment2["CENTER"] = "CENTER";
+  Alignment2["END"] = "END";
+  return Alignment2;
+})(Alignment || {});
+var Layout = /* @__PURE__ */ ((Layout2) => {
+  Layout2["STACKED"] = "STACKED";
+  Layout2["SIDE_BY_SIDE"] = "SIDE_BY_SIDE";
+  return Layout2;
+})(Layout || {});
 var AppType = /* @__PURE__ */ ((AppType2) => {
   AppType2["PRODUCT"] = "PRODUCT";
   AppType2["EVENT"] = "EVENT";
@@ -1920,16 +1964,20 @@ var onPostUpdated2 = (0, import_event_definition_modules.createEventModule)(onPo
 0 && (module.exports = {
   Alignment,
   AppType,
+  AspectRatio,
   BackgroundType,
+  ButtonDataType,
   Crop,
   DecorationType,
   Direction,
+  DividerDataAlignment,
   Field,
   FontType,
   GIFType,
   GetPostTemplatesSort,
   GetPostsSort,
   InitialExpandedItems,
+  Layout,
   LayoutType,
   LineStyle,
   MapType,
@@ -1939,15 +1987,18 @@ var onPostUpdated2 = (0, import_event_definition_modules.createEventModule)(onPo
   Order,
   Orientation,
   Origin,
+  Placement,
   PluginContainerDataAlignment,
   PollLayoutDirection,
   PollLayoutType,
   Position,
   PostFieldField,
   QueryPublicationsCountStatsRequestOrder,
+  Resizing,
   SortOrder,
   Source,
   Status,
+  StylesPosition,
   Target,
   TextAlignment,
   ThumbnailsAlignment,