@wix/auto_sdk_blog_posts 1.0.48 → 1.0.50
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 +31 -24
- package/build/cjs/index.js +15 -10
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +31 -36
- package/build/cjs/index.typings.js +5 -5
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +31 -24
- package/build/es/index.mjs +15 -10
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +31 -36
- package/build/es/index.typings.mjs +5 -5
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +31 -24
- package/build/internal/cjs/index.js +15 -10
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +31 -36
- package/build/internal/cjs/index.typings.js +5 -5
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +31 -24
- package/build/internal/es/index.mjs +15 -10
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +31 -36
- package/build/internal/es/index.typings.mjs +5 -5
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
@@ -3172,18 +3172,6 @@ interface GetPostMetricsResponse {
|
|
3172
3172
|
/** Retrieved post metrics. */
|
3173
3173
|
metrics?: Metrics;
|
3174
3174
|
}
|
3175
|
-
interface BulkGetPostMetricsRequest {
|
3176
|
-
/**
|
3177
|
-
* Post IDs.
|
3178
|
-
* @maxSize 500
|
3179
|
-
* @maxLength 38
|
3180
|
-
*/
|
3181
|
-
postIds?: string[];
|
3182
|
-
}
|
3183
|
-
interface BulkGetPostMetricsResponse {
|
3184
|
-
/** Map of post.id to metrics */
|
3185
|
-
metrics?: Record<string, Metrics>;
|
3186
|
-
}
|
3187
3175
|
interface ViewPostRequest {
|
3188
3176
|
/**
|
3189
3177
|
* Post ID.
|
@@ -3623,13 +3611,14 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
|
|
3623
3611
|
/**
|
3624
3612
|
* Retrieves the number of published posts per month within a specified time range.
|
3625
3613
|
*
|
3626
|
-
*
|
3627
|
-
* The
|
3628
|
-
*
|
3629
|
-
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
3630
|
-
*
|
3631
|
-
*
|
3614
|
+
*
|
3615
|
+
* The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
|
3616
|
+
*
|
3617
|
+
* 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.
|
3618
|
+
*
|
3619
|
+
* >**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.
|
3632
3620
|
* @public
|
3621
|
+
* @param options - Options specifying time frame, sort, and filter.
|
3633
3622
|
* @permissionId BLOG.READ-PUBLICATION
|
3634
3623
|
* @applicableIdentity APP
|
3635
3624
|
* @returns Get Blog Post Count Stats response
|
@@ -3670,6 +3659,7 @@ interface QueryPostCountStatsOptions {
|
|
3670
3659
|
/**
|
3671
3660
|
* Retrieves the total amount of published posts of the blog.
|
3672
3661
|
* @public
|
3662
|
+
* @param options - Language Options.
|
3673
3663
|
* @permissionId BLOG.READ-PUBLICATION
|
3674
3664
|
* @applicableIdentity APP
|
3675
3665
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
@@ -3690,12 +3680,12 @@ interface GetTotalPostsOptions {
|
|
3690
3680
|
* @param postId - Post ID.
|
3691
3681
|
* @public
|
3692
3682
|
* @requiredField postId
|
3683
|
+
* @param options - Options specifying which fields to return.
|
3693
3684
|
* @permissionId BLOG.READ-PUBLICATION
|
3694
3685
|
* @applicableIdentity APP
|
3695
|
-
* @returns Retrieved post info.
|
3696
3686
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
3697
3687
|
*/
|
3698
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
3688
|
+
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>>;
|
3699
3689
|
interface GetPostOptions {
|
3700
3690
|
/**
|
3701
3691
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
@@ -3715,6 +3705,7 @@ interface GetPostOptions {
|
|
3715
3705
|
* @param slug - Slug of the post to retrieve.
|
3716
3706
|
* @public
|
3717
3707
|
* @requiredField slug
|
3708
|
+
* @param options - Options specifying which fields to return.
|
3718
3709
|
* @permissionId BLOG.READ-PUBLICATION
|
3719
3710
|
* @applicableIdentity APP
|
3720
3711
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
@@ -3742,6 +3733,7 @@ interface GetPostBySlugOptions {
|
|
3742
3733
|
* - `paging.limit` is `50`.
|
3743
3734
|
* - `paging.offset` is `0`.
|
3744
3735
|
* @public
|
3736
|
+
* @param options - Sort, filter, and paging options.
|
3745
3737
|
* @permissionId BLOG.READ-PUBLICATION
|
3746
3738
|
* @applicableIdentity APP
|
3747
3739
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
@@ -3812,23 +3804,26 @@ interface ListPostsOptions {
|
|
3812
3804
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3813
3805
|
}
|
3814
3806
|
/**
|
3815
|
-
*
|
3807
|
+
* Creates a query to retrieve a list of posts.
|
3816
3808
|
*
|
3817
|
-
* Query Posts runs with these defaults, which you can override:
|
3818
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
3819
|
-
* - `paging.limit` is `50`.
|
3820
|
-
* - `paging.offset` is `0`.
|
3821
3809
|
*
|
3822
|
-
*
|
3823
|
-
*
|
3810
|
+
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
3811
|
+
*
|
3812
|
+
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
3813
|
+
*
|
3814
|
+
* 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.
|
3815
|
+
*
|
3816
|
+
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
|
3817
|
+
* + `limit(50)`
|
3818
|
+
* + `descending('firstPublishedDate')`
|
3819
|
+
*
|
3820
|
+
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
3821
|
+
*
|
3822
|
+
* To learn how to query posts, refer to the table below.
|
3824
3823
|
*
|
3825
|
-
*
|
3826
|
-
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
3827
|
-
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
|
3828
|
-
* [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
3829
|
-
* For a detailed list of supported filters and sortable fields, see
|
3830
|
-
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
3824
|
+
* 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`.
|
3831
3825
|
* @public
|
3826
|
+
* @param options - Options specifying which fields to return.
|
3832
3827
|
* @permissionId BLOG.READ-PUBLICATION
|
3833
3828
|
* @applicableIdentity APP
|
3834
3829
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
@@ -3860,11 +3855,11 @@ interface PostsQueryBuilder {
|
|
3860
3855
|
/** @param propertyName - Property whose value is compared with `value`.
|
3861
3856
|
* @param value - Value to compare against.
|
3862
3857
|
*/
|
3863
|
-
eq: (propertyName: '_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'coverMedia.enabled' | 'memberId' | 'commentingEnabled' | 'minutesToRead' | 'translationId' | 'language' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
|
3858
|
+
eq: (propertyName: '_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'coverMedia.enabled' | 'memberId' | 'commentingEnabled' | 'minutesToRead' | 'translationId' | 'language' | 'metrics.comments' | 'metrics.likes' | 'metrics.views' | 'media.displayed', value: any) => PostsQueryBuilder;
|
3864
3859
|
/** @param propertyName - Property whose value is compared with `value`.
|
3865
3860
|
* @param value - Value to compare against.
|
3866
3861
|
*/
|
3867
|
-
ne: (propertyName: '_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'coverMedia.enabled' | 'memberId' | 'commentingEnabled' | 'minutesToRead' | 'translationId' | 'language' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
|
3862
|
+
ne: (propertyName: '_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'coverMedia.enabled' | 'memberId' | 'commentingEnabled' | 'minutesToRead' | 'translationId' | 'language' | 'metrics.comments' | 'metrics.likes' | 'metrics.views' | 'media.displayed', value: any) => PostsQueryBuilder;
|
3868
3863
|
/** @param propertyName - Property whose value is compared with `value`.
|
3869
3864
|
* @param value - Value to compare against.
|
3870
3865
|
*/
|
@@ -3918,4 +3913,4 @@ interface PostsQueryBuilder {
|
|
3918
3913
|
*/
|
3919
3914
|
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
|
3920
3915
|
|
3921
|
-
export { type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, BackgroundType, type BackgroundTypeWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type
|
3916
|
+
export { type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, 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, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, 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, type RestoreInfo, type RibbonStyles, type RichContent, 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, 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 };
|
@@ -1313,8 +1313,8 @@ async function getPost2(postId, options) {
|
|
1313
1313
|
paths: [{ path: "post.media.wixMedia.videoV2" }]
|
1314
1314
|
}
|
1315
1315
|
]),
|
1316
|
-
["post.richContent"]
|
1317
|
-
)
|
1316
|
+
["post.richContent", "post.rich_content"]
|
1317
|
+
);
|
1318
1318
|
} catch (err) {
|
1319
1319
|
const transformedError = sdkTransformError(
|
1320
1320
|
err,
|
@@ -1366,7 +1366,7 @@ async function getPostBySlug2(slug, options) {
|
|
1366
1366
|
paths: [{ path: "post.media.wixMedia.videoV2" }]
|
1367
1367
|
}
|
1368
1368
|
]),
|
1369
|
-
["post.richContent"]
|
1369
|
+
["post.richContent", "post.rich_content"]
|
1370
1370
|
);
|
1371
1371
|
} catch (err) {
|
1372
1372
|
const transformedError = sdkTransformError(
|
@@ -1430,7 +1430,7 @@ async function listPosts2(options) {
|
|
1430
1430
|
paths: [{ path: "posts.media.wixMedia.videoV2" }]
|
1431
1431
|
}
|
1432
1432
|
]),
|
1433
|
-
["posts.richContent"]
|
1433
|
+
["posts.richContent", "posts.rich_content"]
|
1434
1434
|
);
|
1435
1435
|
} catch (err) {
|
1436
1436
|
const transformedError = sdkTransformError(
|
@@ -1505,7 +1505,7 @@ function queryPosts2(options) {
|
|
1505
1505
|
paths: [{ path: "posts.media.wixMedia.videoV2" }]
|
1506
1506
|
}
|
1507
1507
|
]),
|
1508
|
-
["posts.richContent"]
|
1508
|
+
["posts.richContent", "posts.rich_content"]
|
1509
1509
|
);
|
1510
1510
|
return {
|
1511
1511
|
items: transformedData?.posts,
|