@wix/auto_sdk_blog_posts 1.0.73 → 1.0.75
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +22 -34
- package/build/cjs/index.js +86 -11
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +56 -24
- package/build/cjs/index.typings.js +59 -7
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +22 -3
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +22 -34
- package/build/es/index.mjs +86 -11
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +56 -24
- package/build/es/index.typings.mjs +57 -6
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +22 -3
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +22 -34
- package/build/internal/cjs/index.js +86 -11
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +56 -24
- package/build/internal/cjs/index.typings.js +59 -7
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +22 -3
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +22 -34
- package/build/internal/es/index.mjs +86 -11
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +56 -24
- package/build/internal/es/index.typings.mjs +57 -6
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +22 -3
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -3
|
@@ -3101,7 +3101,7 @@ declare enum GetPostsSort {
|
|
|
3101
3101
|
VIEW_COUNT = "VIEW_COUNT",
|
|
3102
3102
|
/** Ordered by total number of likes in descending order. */
|
|
3103
3103
|
LIKE_COUNT = "LIKE_COUNT",
|
|
3104
|
-
/** Ordered by `title` in
|
|
3104
|
+
/** Ordered by `title` in ascending order. */
|
|
3105
3105
|
TITLE_ASC = "TITLE_ASC",
|
|
3106
3106
|
/** Ordered by `title` in descending order. */
|
|
3107
3107
|
TITLE_DESC = "TITLE_DESC"
|
|
@@ -3368,6 +3368,25 @@ interface ListPostsArchiveResponse {
|
|
|
3368
3368
|
/** Details on the paged set of results returned. */
|
|
3369
3369
|
pagingMetadata?: PagingMetadataV2;
|
|
3370
3370
|
}
|
|
3371
|
+
interface GetPostCountPerMonthRequest {
|
|
3372
|
+
/**
|
|
3373
|
+
* Optional post language filter.
|
|
3374
|
+
* @format LANGUAGE_TAG
|
|
3375
|
+
*/
|
|
3376
|
+
language?: string | null;
|
|
3377
|
+
}
|
|
3378
|
+
interface GetPostCountPerMonthResponse {
|
|
3379
|
+
/** Post count per month information. */
|
|
3380
|
+
postCountInfo?: PostCountPerMonth[];
|
|
3381
|
+
}
|
|
3382
|
+
interface PostCountPerMonth {
|
|
3383
|
+
/** Month in a YYYY-MM format, for example "2025-04". */
|
|
3384
|
+
month?: string;
|
|
3385
|
+
/** Number of posts published in the month. */
|
|
3386
|
+
posts?: number;
|
|
3387
|
+
/** Latest firstPublishedDate in the month. */
|
|
3388
|
+
latestFirstPublishedDate?: Date | null;
|
|
3389
|
+
}
|
|
3371
3390
|
interface BulkGetPostReactionsRequest {
|
|
3372
3391
|
/**
|
|
3373
3392
|
* Post IDs.
|
|
@@ -3429,7 +3448,7 @@ interface ListDemoPostsRequest {
|
|
|
3429
3448
|
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
|
3430
3449
|
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
|
3431
3450
|
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
|
3432
|
-
* - `TITLE_ASC`: Ordered by `title` in
|
|
3451
|
+
* - `TITLE_ASC`: Ordered by `title` in ascending order.
|
|
3433
3452
|
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
|
3434
3453
|
* - `RATING`: reserved for internal use.
|
|
3435
3454
|
*
|
|
@@ -3690,13 +3709,14 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
|
|
|
3690
3709
|
/**
|
|
3691
3710
|
* Retrieves the number of published posts per month within a specified time range.
|
|
3692
3711
|
*
|
|
3693
|
-
*
|
|
3694
|
-
* The
|
|
3695
|
-
*
|
|
3696
|
-
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
|
3697
|
-
*
|
|
3698
|
-
*
|
|
3712
|
+
*
|
|
3713
|
+
* The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
|
|
3714
|
+
*
|
|
3715
|
+
* You can set the time range using the `rangeStart` and `months` properties. The time range always starts on the 1st day of the month set in `rangeStart` and includes the number of `months` following `rangeStart`. For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`, the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range ends on the last day of the month.
|
|
3716
|
+
*
|
|
3717
|
+
* >**Note:** If there are no published posts in a specific month, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
|
|
3699
3718
|
* @public
|
|
3719
|
+
* @param options - Options specifying time frame, sort, and filter.
|
|
3700
3720
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3701
3721
|
* @applicableIdentity APP
|
|
3702
3722
|
* @returns Get Blog Post Count Stats response
|
|
@@ -3737,6 +3757,7 @@ interface QueryPostCountStatsOptions {
|
|
|
3737
3757
|
/**
|
|
3738
3758
|
* Retrieves the total amount of published posts of the blog.
|
|
3739
3759
|
* @public
|
|
3760
|
+
* @param options - Language Options.
|
|
3740
3761
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3741
3762
|
* @applicableIdentity APP
|
|
3742
3763
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
|
@@ -3757,12 +3778,12 @@ interface GetTotalPostsOptions {
|
|
|
3757
3778
|
* @param postId - Post ID.
|
|
3758
3779
|
* @public
|
|
3759
3780
|
* @requiredField postId
|
|
3781
|
+
* @param options - Options specifying which fields to return.
|
|
3760
3782
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3761
3783
|
* @applicableIdentity APP
|
|
3762
|
-
* @returns Retrieved post info.
|
|
3763
3784
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
|
3764
3785
|
*/
|
|
3765
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
|
3786
|
+
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.coverMedia.enabled` | `post.coverMedia.displayed` | `post.coverMedia.custom` | `post.memberId` | `post.hashtags` | `post.commentingEnabled` | `post.minutesToRead` | `post.tagIds` | `post.relatedPostIds` | `post.pricingPlanIds` | `post.seoData.tags` | `post.seoData.tags.${number}.type` | `post.seoData.tags.${number}.children` | `post.seoData.tags.${number}.custom` | `post.seoData.tags.${number}.disabled` | `post.seoData.settings.preventAutoRedirect` | `post.seoData.settings.keywords` | `post.seoData.settings.keywords.${number}.term` | `post.seoData.settings.keywords.${number}.isMain` | `post.preview` | `post.moderationDetails.submittedBy` | `post.moderationDetails.status` | `post.media.embedMedia.thumbnail.url` | `post.media.embedMedia.thumbnail.width` | `post.media.embedMedia.thumbnail.height` | `post.media.embedMedia.video.url` | `post.media.embedMedia.video.width` | `post.media.embedMedia.video.height` | `post.media.displayed` | `post.media.custom` | `post.hasUnpublishedChanges`, 7>>;
|
|
3766
3787
|
interface GetPostOptions {
|
|
3767
3788
|
/**
|
|
3768
3789
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -3782,6 +3803,7 @@ interface GetPostOptions {
|
|
|
3782
3803
|
* @param slug - Slug of the post to retrieve.
|
|
3783
3804
|
* @public
|
|
3784
3805
|
* @requiredField slug
|
|
3806
|
+
* @param options - Options specifying which fields to return.
|
|
3785
3807
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3786
3808
|
* @applicableIdentity APP
|
|
3787
3809
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
|
@@ -3809,6 +3831,7 @@ interface GetPostBySlugOptions {
|
|
|
3809
3831
|
* - `paging.limit` is `50`.
|
|
3810
3832
|
* - `paging.offset` is `0`.
|
|
3811
3833
|
* @public
|
|
3834
|
+
* @param options - Sort, filter, and paging options.
|
|
3812
3835
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3813
3836
|
* @applicableIdentity APP
|
|
3814
3837
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
|
@@ -3879,23 +3902,26 @@ interface ListPostsOptions {
|
|
|
3879
3902
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3880
3903
|
}
|
|
3881
3904
|
/**
|
|
3882
|
-
*
|
|
3905
|
+
* Creates a query to retrieve a list of posts.
|
|
3883
3906
|
*
|
|
3884
|
-
* Query Posts runs with these defaults, which you can override:
|
|
3885
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
|
3886
|
-
* - `paging.limit` is `50`.
|
|
3887
|
-
* - `paging.offset` is `0`.
|
|
3888
3907
|
*
|
|
3889
|
-
*
|
|
3890
|
-
*
|
|
3908
|
+
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
|
3909
|
+
*
|
|
3910
|
+
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
|
3911
|
+
*
|
|
3912
|
+
* You can refine the query by chaining `PostsQueryBuilder` functions onto the query. `PostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryPosts()` returns.
|
|
3913
|
+
*
|
|
3914
|
+
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
|
|
3915
|
+
* + `limit(50)`
|
|
3916
|
+
* + `descending('firstPublishedDate')`
|
|
3891
3917
|
*
|
|
3892
|
-
*
|
|
3893
|
-
*
|
|
3894
|
-
*
|
|
3895
|
-
*
|
|
3896
|
-
* For a
|
|
3897
|
-
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
|
3918
|
+
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
|
3919
|
+
*
|
|
3920
|
+
* To learn how to query posts, refer to the table below.
|
|
3921
|
+
*
|
|
3922
|
+
* 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`.
|
|
3898
3923
|
* @public
|
|
3924
|
+
* @param options - Options specifying which fields to return.
|
|
3899
3925
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3900
3926
|
* @applicableIdentity APP
|
|
3901
3927
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
|
@@ -3972,6 +3998,12 @@ interface PostsQueryBuilder {
|
|
|
3972
3998
|
skipTo: (cursor: string) => PostsQueryBuilder;
|
|
3973
3999
|
find: () => Promise<PostsQueryResult>;
|
|
3974
4000
|
}
|
|
4001
|
+
/**
|
|
4002
|
+
* @hidden
|
|
4003
|
+
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
|
4004
|
+
* @requiredField query
|
|
4005
|
+
*/
|
|
4006
|
+
declare function typedQueryPosts(query: PlatformQuery, options?: QueryPostsOptions): Promise<NonNullablePaths<QueryPostsResponse, `posts` | `posts.${number}._id` | `posts.${number}.title` | `posts.${number}.excerpt` | `posts.${number}.slug` | `posts.${number}.featured` | `posts.${number}.pinned` | `posts.${number}.coverMedia.enabled` | `posts.${number}.coverMedia.displayed` | `posts.${number}.coverMedia.custom` | `posts.${number}.memberId` | `posts.${number}.commentingEnabled` | `posts.${number}.minutesToRead` | `posts.${number}.seoData.settings.preventAutoRedirect` | `posts.${number}.preview` | `posts.${number}.moderationDetails.submittedBy` | `posts.${number}.moderationDetails.status` | `posts.${number}.media.displayed` | `posts.${number}.media.custom` | `posts.${number}.hasUnpublishedChanges`, 6>>;
|
|
3975
4007
|
/**
|
|
3976
4008
|
* Retrieves a post's metrics.
|
|
3977
4009
|
*
|
|
@@ -3985,4 +4017,4 @@ interface PostsQueryBuilder {
|
|
|
3985
4017
|
*/
|
|
3986
4018
|
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
|
|
3987
4019
|
|
|
3988
|
-
export { type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardStyles, type Category, type CategoryTranslation, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type ConvertDraftJsToRichContentRequest, type ConvertDraftJsToRichContentResponse, type ConvertRichContentToDraftJsRequest, type ConvertRichContentToDraftJsResponse, type CoverMedia, type CoverMediaMediaOneOf, type CreateDraftPostFromTemplateRequest, type CreateDraftPostFromTemplateResponse, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type Design, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type DraftPost, type DraftPostTranslation, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostTemplatesSort, type GetPostTemplatesSortWithLiterals, GetPostsSort, type GetPostsSortWithLiterals, type GetTemplateRequest, type GetTemplateResponse, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, ImagePosition, type ImagePositionWithLiterals, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, type ListTemplatesRequest, type ListTemplatesResponse, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, ModerationStatusStatus, type ModerationStatusStatusWithLiterals, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type OldBlogMigratedEvent, type Option, type OptionDesign, type OptionLayout, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCountInfo, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type ScheduledPostPublished, type SeoSchema, type Settings, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts };
|
|
4020
|
+
export { type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardStyles, type Category, type CategoryTranslation, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type ConvertDraftJsToRichContentRequest, type ConvertDraftJsToRichContentResponse, type ConvertRichContentToDraftJsRequest, type ConvertRichContentToDraftJsResponse, type CoverMedia, type CoverMediaMediaOneOf, type CreateDraftPostFromTemplateRequest, type CreateDraftPostFromTemplateResponse, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type Design, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type DraftPost, type DraftPostTranslation, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostCountPerMonthRequest, type GetPostCountPerMonthResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostTemplatesSort, type GetPostTemplatesSortWithLiterals, GetPostsSort, type GetPostsSortWithLiterals, type GetTemplateRequest, type GetTemplateResponse, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, ImagePosition, type ImagePositionWithLiterals, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, type ListTemplatesRequest, type ListTemplatesResponse, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, ModerationStatusStatus, type ModerationStatusStatusWithLiterals, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type OldBlogMigratedEvent, type Option, type OptionDesign, type OptionLayout, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCountInfo, type PostCountPerMonth, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type ScheduledPostPublished, type SeoSchema, type Settings, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, typedQueryPosts };
|
|
@@ -78,7 +78,8 @@ __export(index_typings_exports, {
|
|
|
78
78
|
getTotalPosts: () => getTotalPosts2,
|
|
79
79
|
listPosts: () => listPosts2,
|
|
80
80
|
queryPostCountStats: () => queryPostCountStats2,
|
|
81
|
-
queryPosts: () => queryPosts2
|
|
81
|
+
queryPosts: () => queryPosts2,
|
|
82
|
+
typedQueryPosts: () => typedQueryPosts
|
|
82
83
|
});
|
|
83
84
|
module.exports = __toCommonJS(index_typings_exports);
|
|
84
85
|
|
|
@@ -1268,8 +1269,8 @@ async function getPost2(postId, options) {
|
|
|
1268
1269
|
paths: [{ path: "post.media.wixMedia.videoV2" }]
|
|
1269
1270
|
}
|
|
1270
1271
|
]),
|
|
1271
|
-
["post.richContent"]
|
|
1272
|
-
)
|
|
1272
|
+
["post.richContent", "post.rich_content"]
|
|
1273
|
+
);
|
|
1273
1274
|
} catch (err) {
|
|
1274
1275
|
const transformedError = (0, import_transform_error.transformError)(
|
|
1275
1276
|
err,
|
|
@@ -1321,7 +1322,7 @@ async function getPostBySlug2(slug, options) {
|
|
|
1321
1322
|
paths: [{ path: "post.media.wixMedia.videoV2" }]
|
|
1322
1323
|
}
|
|
1323
1324
|
]),
|
|
1324
|
-
["post.richContent"]
|
|
1325
|
+
["post.richContent", "post.rich_content"]
|
|
1325
1326
|
);
|
|
1326
1327
|
} catch (err) {
|
|
1327
1328
|
const transformedError = (0, import_transform_error.transformError)(
|
|
@@ -1385,7 +1386,7 @@ async function listPosts2(options) {
|
|
|
1385
1386
|
paths: [{ path: "posts.media.wixMedia.videoV2" }]
|
|
1386
1387
|
}
|
|
1387
1388
|
]),
|
|
1388
|
-
["posts.richContent"]
|
|
1389
|
+
["posts.richContent", "posts.rich_content"]
|
|
1389
1390
|
);
|
|
1390
1391
|
} catch (err) {
|
|
1391
1392
|
const transformedError = (0, import_transform_error.transformError)(
|
|
@@ -1460,7 +1461,7 @@ function queryPosts2(options) {
|
|
|
1460
1461
|
paths: [{ path: "posts.media.wixMedia.videoV2" }]
|
|
1461
1462
|
}
|
|
1462
1463
|
]),
|
|
1463
|
-
["posts.richContent"]
|
|
1464
|
+
["posts.richContent", "posts.rich_content"]
|
|
1464
1465
|
);
|
|
1465
1466
|
return {
|
|
1466
1467
|
items: transformedData?.posts,
|
|
@@ -1479,6 +1480,56 @@ function queryPosts2(options) {
|
|
|
1479
1480
|
transformationPaths: {}
|
|
1480
1481
|
});
|
|
1481
1482
|
}
|
|
1483
|
+
async function typedQueryPosts(query, options) {
|
|
1484
|
+
const { httpClient, sideEffects } = arguments[2];
|
|
1485
|
+
const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)(
|
|
1486
|
+
{ query, ...options },
|
|
1487
|
+
[]
|
|
1488
|
+
);
|
|
1489
|
+
const reqOpts = queryPosts(payload);
|
|
1490
|
+
sideEffects?.onSiteCall?.();
|
|
1491
|
+
try {
|
|
1492
|
+
const result = await httpClient.request(reqOpts);
|
|
1493
|
+
sideEffects?.onSuccess?.(result);
|
|
1494
|
+
return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(
|
|
1495
|
+
(0, import_transform_paths2.transformPaths)(result.data, [
|
|
1496
|
+
{
|
|
1497
|
+
transformFn: import_page_url.transformRESTPageURLToSDKPageURL,
|
|
1498
|
+
paths: [{ path: "posts.url" }, { path: "posts.translations.url" }]
|
|
1499
|
+
},
|
|
1500
|
+
{
|
|
1501
|
+
transformFn: import_image.transformRESTImageToSDKImage,
|
|
1502
|
+
paths: [
|
|
1503
|
+
{ path: "posts.heroImage" },
|
|
1504
|
+
{ path: "posts.coverMedia.image" },
|
|
1505
|
+
{ path: "posts.media.wixMedia.image" }
|
|
1506
|
+
]
|
|
1507
|
+
},
|
|
1508
|
+
{
|
|
1509
|
+
transformFn: import_video.transformRESTVideoToSDKVideo,
|
|
1510
|
+
paths: [{ path: "posts.coverMedia.video" }]
|
|
1511
|
+
},
|
|
1512
|
+
{
|
|
1513
|
+
transformFn: import_video_v2.transformRESTVideoV2ToSDKVideoV2,
|
|
1514
|
+
paths: [{ path: "posts.media.wixMedia.videoV2" }]
|
|
1515
|
+
}
|
|
1516
|
+
]),
|
|
1517
|
+
["posts.richContent", "posts.rich_content"]
|
|
1518
|
+
);
|
|
1519
|
+
} catch (err) {
|
|
1520
|
+
const transformedError = (0, import_transform_error.transformError)(
|
|
1521
|
+
err,
|
|
1522
|
+
{
|
|
1523
|
+
spreadPathsToArguments: {},
|
|
1524
|
+
explicitPathsToArguments: { query: "$[0]" },
|
|
1525
|
+
singleArgumentUnchanged: false
|
|
1526
|
+
},
|
|
1527
|
+
["query", "options"]
|
|
1528
|
+
);
|
|
1529
|
+
sideEffects?.onError?.(err);
|
|
1530
|
+
throw transformedError;
|
|
1531
|
+
}
|
|
1532
|
+
}
|
|
1482
1533
|
async function getPostMetrics2(postId) {
|
|
1483
1534
|
const { httpClient, sideEffects } = arguments[1];
|
|
1484
1535
|
const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({ postId }, []);
|
|
@@ -1562,6 +1613,7 @@ async function getPostMetrics2(postId) {
|
|
|
1562
1613
|
getTotalPosts,
|
|
1563
1614
|
listPosts,
|
|
1564
1615
|
queryPostCountStats,
|
|
1565
|
-
queryPosts
|
|
1616
|
+
queryPosts,
|
|
1617
|
+
typedQueryPosts
|
|
1566
1618
|
});
|
|
1567
1619
|
//# sourceMappingURL=index.typings.js.map
|