@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
@@ -3165,18 +3165,6 @@ interface GetPostMetricsResponse {
|
|
3165
3165
|
/** Retrieved post metrics. */
|
3166
3166
|
metrics?: Metrics;
|
3167
3167
|
}
|
3168
|
-
interface BulkGetPostMetricsRequest {
|
3169
|
-
/**
|
3170
|
-
* Post IDs.
|
3171
|
-
* @maxSize 500
|
3172
|
-
* @maxLength 38
|
3173
|
-
*/
|
3174
|
-
postIds?: string[];
|
3175
|
-
}
|
3176
|
-
interface BulkGetPostMetricsResponse {
|
3177
|
-
/** Map of post.id to metrics */
|
3178
|
-
metrics?: Record<string, Metrics>;
|
3179
|
-
}
|
3180
3168
|
interface ViewPostRequest {
|
3181
3169
|
/**
|
3182
3170
|
* Post ID.
|
@@ -3616,13 +3604,14 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
|
|
3616
3604
|
/**
|
3617
3605
|
* Retrieves the number of published posts per month within a specified time range.
|
3618
3606
|
*
|
3619
|
-
*
|
3620
|
-
* The
|
3621
|
-
*
|
3622
|
-
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
3623
|
-
*
|
3624
|
-
*
|
3607
|
+
*
|
3608
|
+
* The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
|
3609
|
+
*
|
3610
|
+
* 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.
|
3611
|
+
*
|
3612
|
+
* >**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.
|
3625
3613
|
* @public
|
3614
|
+
* @param options - Options specifying time frame, sort, and filter.
|
3626
3615
|
* @permissionId BLOG.READ-PUBLICATION
|
3627
3616
|
* @applicableIdentity APP
|
3628
3617
|
* @returns Get Blog Post Count Stats response
|
@@ -3663,6 +3652,7 @@ interface QueryPostCountStatsOptions {
|
|
3663
3652
|
/**
|
3664
3653
|
* Retrieves the total amount of published posts of the blog.
|
3665
3654
|
* @public
|
3655
|
+
* @param options - Language Options.
|
3666
3656
|
* @permissionId BLOG.READ-PUBLICATION
|
3667
3657
|
* @applicableIdentity APP
|
3668
3658
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
@@ -3683,12 +3673,12 @@ interface GetTotalPostsOptions {
|
|
3683
3673
|
* @param postId - Post ID.
|
3684
3674
|
* @public
|
3685
3675
|
* @requiredField postId
|
3676
|
+
* @param options - Options specifying which fields to return.
|
3686
3677
|
* @permissionId BLOG.READ-PUBLICATION
|
3687
3678
|
* @applicableIdentity APP
|
3688
|
-
* @returns Retrieved post info.
|
3689
3679
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
3690
3680
|
*/
|
3691
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
3681
|
+
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>>;
|
3692
3682
|
interface GetPostOptions {
|
3693
3683
|
/**
|
3694
3684
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
@@ -3708,6 +3698,7 @@ interface GetPostOptions {
|
|
3708
3698
|
* @param slug - Slug of the post to retrieve.
|
3709
3699
|
* @public
|
3710
3700
|
* @requiredField slug
|
3701
|
+
* @param options - Options specifying which fields to return.
|
3711
3702
|
* @permissionId BLOG.READ-PUBLICATION
|
3712
3703
|
* @applicableIdentity APP
|
3713
3704
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
@@ -3735,6 +3726,7 @@ interface GetPostBySlugOptions {
|
|
3735
3726
|
* - `paging.limit` is `50`.
|
3736
3727
|
* - `paging.offset` is `0`.
|
3737
3728
|
* @public
|
3729
|
+
* @param options - Sort, filter, and paging options.
|
3738
3730
|
* @permissionId BLOG.READ-PUBLICATION
|
3739
3731
|
* @applicableIdentity APP
|
3740
3732
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
@@ -3805,23 +3797,26 @@ interface ListPostsOptions {
|
|
3805
3797
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3806
3798
|
}
|
3807
3799
|
/**
|
3808
|
-
*
|
3800
|
+
* Creates a query to retrieve a list of posts.
|
3809
3801
|
*
|
3810
|
-
* Query Posts runs with these defaults, which you can override:
|
3811
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
3812
|
-
* - `paging.limit` is `50`.
|
3813
|
-
* - `paging.offset` is `0`.
|
3814
3802
|
*
|
3815
|
-
*
|
3816
|
-
*
|
3803
|
+
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
3804
|
+
*
|
3805
|
+
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
3806
|
+
*
|
3807
|
+
* 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.
|
3808
|
+
*
|
3809
|
+
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
|
3810
|
+
* + `limit(50)`
|
3811
|
+
* + `descending('firstPublishedDate')`
|
3812
|
+
*
|
3813
|
+
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
3814
|
+
*
|
3815
|
+
* To learn how to query posts, refer to the table below.
|
3817
3816
|
*
|
3818
|
-
*
|
3819
|
-
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
3820
|
-
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
|
3821
|
-
* [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
3822
|
-
* For a detailed list of supported filters and sortable fields, see
|
3823
|
-
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
3817
|
+
* 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`.
|
3824
3818
|
* @public
|
3819
|
+
* @param options - Options specifying which fields to return.
|
3825
3820
|
* @permissionId BLOG.READ-PUBLICATION
|
3826
3821
|
* @applicableIdentity APP
|
3827
3822
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
@@ -3853,11 +3848,11 @@ interface PostsQueryBuilder {
|
|
3853
3848
|
/** @param propertyName - Property whose value is compared with `value`.
|
3854
3849
|
* @param value - Value to compare against.
|
3855
3850
|
*/
|
3856
|
-
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;
|
3851
|
+
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;
|
3857
3852
|
/** @param propertyName - Property whose value is compared with `value`.
|
3858
3853
|
* @param value - Value to compare against.
|
3859
3854
|
*/
|
3860
|
-
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;
|
3855
|
+
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;
|
3861
3856
|
/** @param propertyName - Property whose value is compared with `value`.
|
3862
3857
|
* @param value - Value to compare against.
|
3863
3858
|
*/
|
@@ -3911,4 +3906,4 @@ interface PostsQueryBuilder {
|
|
3911
3906
|
*/
|
3912
3907
|
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
|
3913
3908
|
|
3914
|
-
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
|
3909
|
+
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 };
|
@@ -1390,8 +1390,8 @@ async function getPost2(postId, options) {
|
|
1390
1390
|
paths: [{ path: "post.media.wixMedia.videoV2" }]
|
1391
1391
|
}
|
1392
1392
|
]),
|
1393
|
-
["post.richContent"]
|
1394
|
-
)
|
1393
|
+
["post.richContent", "post.rich_content"]
|
1394
|
+
);
|
1395
1395
|
} catch (err) {
|
1396
1396
|
const transformedError = (0, import_transform_error.transformError)(
|
1397
1397
|
err,
|
@@ -1443,7 +1443,7 @@ async function getPostBySlug2(slug, options) {
|
|
1443
1443
|
paths: [{ path: "post.media.wixMedia.videoV2" }]
|
1444
1444
|
}
|
1445
1445
|
]),
|
1446
|
-
["post.richContent"]
|
1446
|
+
["post.richContent", "post.rich_content"]
|
1447
1447
|
);
|
1448
1448
|
} catch (err) {
|
1449
1449
|
const transformedError = (0, import_transform_error.transformError)(
|
@@ -1507,7 +1507,7 @@ async function listPosts2(options) {
|
|
1507
1507
|
paths: [{ path: "posts.media.wixMedia.videoV2" }]
|
1508
1508
|
}
|
1509
1509
|
]),
|
1510
|
-
["posts.richContent"]
|
1510
|
+
["posts.richContent", "posts.rich_content"]
|
1511
1511
|
);
|
1512
1512
|
} catch (err) {
|
1513
1513
|
const transformedError = (0, import_transform_error.transformError)(
|
@@ -1582,7 +1582,7 @@ function queryPosts2(options) {
|
|
1582
1582
|
paths: [{ path: "posts.media.wixMedia.videoV2" }]
|
1583
1583
|
}
|
1584
1584
|
]),
|
1585
|
-
["posts.richContent"]
|
1585
|
+
["posts.richContent", "posts.rich_content"]
|
1586
1586
|
);
|
1587
1587
|
return {
|
1588
1588
|
items: transformedData?.posts,
|