npm - @wix/blog - Versions diffs - 1.0.113 - Mend

@wix/blog 1.0.113

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.

Files changed (79) hide show

package/build/cjs/index.d.ts +3 -0
package/build/cjs/index.js +26 -0
package/build/cjs/index.js.map +1 -0
package/build/cjs/src/blog-v3-category.http.d.ts +50 -0
package/build/cjs/src/blog-v3-category.http.js +421 -0
package/build/cjs/src/blog-v3-category.http.js.map +1 -0
package/build/cjs/src/blog-v3-category.public.d.ts +11 -0
package/build/cjs/src/blog-v3-category.public.js +50 -0
package/build/cjs/src/blog-v3-category.public.js.map +1 -0
package/build/cjs/src/blog-v3-category.types.d.ts +391 -0
package/build/cjs/src/blog-v3-category.types.js +22 -0
package/build/cjs/src/blog-v3-category.types.js.map +1 -0
package/build/cjs/src/blog-v3-category.universal.d.ts +582 -0
package/build/cjs/src/blog-v3-category.universal.js +460 -0
package/build/cjs/src/blog-v3-category.universal.js.map +1 -0
package/build/cjs/src/blog-v3-post.http.d.ts +81 -0
package/build/cjs/src/blog-v3-post.http.js +844 -0
package/build/cjs/src/blog-v3-post.http.js.map +1 -0
package/build/cjs/src/blog-v3-post.public.d.ts +11 -0
package/build/cjs/src/blog-v3-post.public.js +86 -0
package/build/cjs/src/blog-v3-post.public.js.map +1 -0
package/build/cjs/src/blog-v3-post.types.d.ts +2227 -0
package/build/cjs/src/blog-v3-post.types.js +464 -0
package/build/cjs/src/blog-v3-post.types.js.map +1 -0
package/build/cjs/src/blog-v3-post.universal.d.ts +2488 -0
package/build/cjs/src/blog-v3-post.universal.js +935 -0
package/build/cjs/src/blog-v3-post.universal.js.map +1 -0
package/build/cjs/src/blog-v3-tag.http.d.ts +45 -0
package/build/cjs/src/blog-v3-tag.http.js +385 -0
package/build/cjs/src/blog-v3-tag.http.js.map +1 -0
package/build/cjs/src/blog-v3-tag.public.d.ts +10 -0
package/build/cjs/src/blog-v3-tag.public.js +44 -0
package/build/cjs/src/blog-v3-tag.public.js.map +1 -0
package/build/cjs/src/blog-v3-tag.types.d.ts +345 -0
package/build/cjs/src/blog-v3-tag.types.js +15 -0
package/build/cjs/src/blog-v3-tag.types.js.map +1 -0
package/build/cjs/src/blog-v3-tag.universal.d.ts +512 -0
package/build/cjs/src/blog-v3-tag.universal.js +390 -0
package/build/cjs/src/blog-v3-tag.universal.js.map +1 -0
package/build/es/index.d.ts +3 -0
package/build/es/index.js +4 -0
package/build/es/index.js.map +1 -0
package/build/es/src/blog-v3-category.http.d.ts +50 -0
package/build/es/src/blog-v3-category.http.js +411 -0
package/build/es/src/blog-v3-category.http.js.map +1 -0
package/build/es/src/blog-v3-category.public.d.ts +11 -0
package/build/es/src/blog-v3-category.public.js +38 -0
package/build/es/src/blog-v3-category.public.js.map +1 -0
package/build/es/src/blog-v3-category.types.d.ts +391 -0
package/build/es/src/blog-v3-category.types.js +19 -0
package/build/es/src/blog-v3-category.types.js.map +1 -0
package/build/es/src/blog-v3-category.universal.d.ts +582 -0
package/build/es/src/blog-v3-category.universal.js +431 -0
package/build/es/src/blog-v3-category.universal.js.map +1 -0
package/build/es/src/blog-v3-post.http.d.ts +81 -0
package/build/es/src/blog-v3-post.http.js +834 -0
package/build/es/src/blog-v3-post.http.js.map +1 -0
package/build/es/src/blog-v3-post.public.d.ts +11 -0
package/build/es/src/blog-v3-post.public.js +38 -0
package/build/es/src/blog-v3-post.public.js.map +1 -0
package/build/es/src/blog-v3-post.types.d.ts +2227 -0
package/build/es/src/blog-v3-post.types.js +461 -0
package/build/es/src/blog-v3-post.types.js.map +1 -0
package/build/es/src/blog-v3-post.universal.d.ts +2488 -0
package/build/es/src/blog-v3-post.universal.js +906 -0
package/build/es/src/blog-v3-post.universal.js.map +1 -0
package/build/es/src/blog-v3-tag.http.d.ts +45 -0
package/build/es/src/blog-v3-tag.http.js +376 -0
package/build/es/src/blog-v3-tag.http.js.map +1 -0
package/build/es/src/blog-v3-tag.public.d.ts +10 -0
package/build/es/src/blog-v3-tag.public.js +33 -0
package/build/es/src/blog-v3-tag.public.js.map +1 -0
package/build/es/src/blog-v3-tag.types.d.ts +345 -0
package/build/es/src/blog-v3-tag.types.js +12 -0
package/build/es/src/blog-v3-tag.types.js.map +1 -0
package/build/es/src/blog-v3-tag.universal.d.ts +512 -0
package/build/es/src/blog-v3-tag.universal.js +362 -0
package/build/es/src/blog-v3-tag.universal.js.map +1 -0
package/package.json +37 -0

package/build/cjs/src/blog-v3-category.types.d.ts ADDED Viewed

@@ -0,0 +1,391 @@
+export interface Category {
+    /**
+     * Category ID.
+     * @readonly
+     */
+    id?: string;
+    /** Category label. Displayed in the Category Menu. */
+    label?: string;
+    /**
+     * Number of posts in the category.
+     * @readonly
+     */
+    postCount?: number;
+    /**
+     * Category URL.
+     * @readonly
+     */
+    url?: PageUrl;
+    /** Category description. */
+    description?: string | null;
+    /** Category title. */
+    title?: string;
+    /**
+     * __Deprecated.__ Use `displayPosition` instead.
+     * This property will be removed on March 2, 2023.
+     *
+     * Category position in sequence.
+     */
+    rank?: number | null;
+    /**
+     * Category position in sequence. Categories with lower display position are displayed first. A position of `-1` will be at the end of the sequence.
+     *
+     * Default: `-1`
+     */
+    displayPosition?: number | null;
+    /** ID of the category's translations. All translations of a single category will share the same `translationId`. */
+    translationId?: string | null;
+    /** Category language.Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
+    language?: string;
+    /** Category slug. For example, 'category-slug'. */
+    slug?: string;
+    /** SEO data. */
+    seoData?: SeoSchema;
+    /** Category cover image. */
+    coverImage?: Image;
+}
+export interface PageUrl {
+    /** The base URL. For premium sites, this will be the domain. For free sites, this would be site URL (e.g mysite.wixsite.com/mysite) */
+    base?: string;
+    /** The path to that page - e.g /product-page/a-product */
+    path?: string;
+}
+export interface CoverMedia extends CoverMediaMediaOneOf {
+    /** Whether cover media is displayed. */
+    displayed?: boolean;
+    /** Whether cover media is custom. If `false` the cover image is set to the first media item that appears in the content. */
+    custom?: boolean;
+    /** Image url. */
+    image?: Image;
+    /** Video url. */
+    video?: Video;
+}
+/** @oneof */
+export interface CoverMediaMediaOneOf {
+    /** Image url. */
+    image?: Image;
+    /** Video url. */
+    video?: Video;
+}
+export interface Image {
+    /** WixMedia image ID. */
+    id?: string;
+    /** Image URL. */
+    url?: string;
+    /**
+     * Original image height.
+     * @readonly
+     */
+    height?: number;
+    /**
+     * Original image width.
+     * @readonly
+     */
+    width?: number;
+    /** Image alt text. */
+    altText?: string | null;
+    /**
+     * Image filename.
+     * @readonly
+     */
+    filename?: string | null;
+}
+/** Deprecated - use VideoV2 */
+export interface Video {
+    /** WixMedia ID */
+    id?: string;
+    /** URL of video */
+    url?: string;
+    /**
+     * Original image height
+     * @readonly
+     */
+    height?: number;
+    /**
+     * Original image width
+     * @readonly
+     */
+    width?: number;
+    /** Video poster */
+    thumbnail?: Image;
+}
+/**
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
+ * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
+ */
+export interface SeoSchema {
+    /** SEO tags information. */
+    tags?: Tag[];
+    /** SEO general settings. */
+    settings?: Settings;
+}
+export interface Tag {
+    /** SEO tag type. Supported values: `title`, `meta`, `script`, `link`. */
+    type?: string;
+    /** SEO tag attributes/properties (name, content, rel, href). */
+    props?: Record<string, any> | null;
+    /** Tag meta data, e.g. {height: 300, width: 240}. */
+    meta?: Record<string, any> | null;
+    /** Tag inner content e.g. `<title> inner content </title>`. */
+    children?: string;
+    /** Whether the tag is a custom tag. */
+    custom?: boolean;
+    /** Whether the tag is disabled. */
+    disabled?: boolean;
+}
+export interface Settings {
+    /** disable auto creation of 301 redirects on slug changes (enabled by default). */
+    preventAutoRedirect?: boolean;
+}
+export interface CreateCategoryRequest {
+    /** Category info. */
+    category: Category;
+    /**
+     * List of category fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core category properties.
+     * Example: When URL fieldset is selected, returned category will have a set of base properties and category url.
+     */
+    fieldsets?: Field[];
+}
+export declare enum Field {
+    UNKNOWN = "UNKNOWN",
+    /** Includes Category url. */
+    URL = "URL",
+    /**
+     * Includes internal id field.
+     * Reserved for internal use
+     */
+    INTERNAL_ID = "INTERNAL_ID",
+    /** Includes SEO data. */
+    SEO = "SEO"
+}
+export interface CreateCategoryResponse {
+    /** Category info. */
+    category?: Category;
+}
+export interface BulkCreateCategoriesRequest {
+    /** Categories to create. */
+    categories?: Category[];
+    /** Whether to return the full created category entities in the response. */
+    returnFullEntity?: boolean;
+    /**
+     * List of category fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core category properties.
+     * Example: When URL fieldset is selected, returned category will have a set of base properties and category url.
+     */
+    fieldsets?: Field[];
+}
+export interface BulkCreateCategoriesResponse {
+    /** Categories created by bulk action. */
+    results?: BulkCategoryResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkCategoryResult {
+    /** Bulk actions metadata for category. */
+    itemMetadata?: ItemMetadata;
+    /** Optional created category. */
+    item?: Category;
+}
+export interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+export interface ApplicationError {
+    code?: string;
+    description?: string;
+    data?: Record<string, any> | null;
+}
+export interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+export interface UpdateCategoryRequest {
+    /** Category info. */
+    category: Category;
+    /** Field mask of fields to update. */
+    fieldMask?: string[];
+    /**
+     * List of category fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core category properties.
+     * Example: When URL fieldset is selected, returned category will have a set of base properties and category url.
+     */
+    fieldsets?: Field[];
+}
+export interface UpdateCategoryResponse {
+    /** Category info. */
+    category?: Category;
+}
+export interface GetCategoryRequest {
+    /** Category ID. */
+    categoryId: string;
+    /**
+     * List of category fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core category properties.
+     * Example: When URL fieldset is selected, returned category will have a set of base properties and category url.
+     */
+    fieldsets?: Field[];
+}
+export interface GetCategoryResponse {
+    /** Category info. */
+    category?: Category;
+}
+export interface GetCategoryBySlugRequest {
+    /** Slug of the category to retrieve. */
+    slug: string;
+    /**
+     * List of category fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core category properties.
+     * Example: When URL fieldset is selected, returned category will have a set of base properties and category url.
+     */
+    fieldsets?: Field[];
+}
+export interface GetCategoryBySlugResponse {
+    /** Category info. */
+    category?: Category;
+}
+export interface ListCategoriesRequest {
+    /** Pagination options. */
+    paging?: BlogPaging;
+    /**
+     * List of category fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core category properties.
+     * Example: When URL fieldset is selected, returned category will have a set of base properties and category url.
+     */
+    fieldsets?: Field[];
+}
+export interface BlogPaging {
+    /** Number of items to skip in the current sort order. */
+    offset?: number;
+    /**
+     * Number of items to return.
+     *
+     *
+     * Default:`50`.
+     */
+    limit?: number;
+    /** Pointer to the next or previous page in the list of results. */
+    cursor?: string | null;
+}
+export interface ListCategoriesResponse {
+    /** List of categories. */
+    categories?: Category[];
+    /** Details on the paged set of results returned. */
+    metaData?: MetaData;
+}
+export interface MetaData {
+    /** Number of items returned in this response. */
+    count?: number;
+    /** Requested offset. */
+    offset?: number;
+    /** Total number of items that match the query. */
+    total?: number;
+    /** Pointer to the next or previous page in the list of results. */
+    cursor?: string | null;
+}
+export interface QueryCategoriesRequest {
+    /** Query options. */
+    query?: PlatformQuery;
+    /**
+     * List of category fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core category properties.
+     * Example: When URL fieldset is selected, returned category will have a set of base properties and category url.
+     */
+    fieldsets?: Field[];
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+/** @oneof */
+export interface PlatformQueryPagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface CursorPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+export interface QueryCategoriesResponse {
+    /** List of categories. */
+    categories?: Category[];
+    /** Details on the paged set of results returned. */
+    pagingMetadata?: PagingMetadataV2;
+}
+export interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+export interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+export interface DeleteCategoryRequest {
+    /** Category ID. */
+    categoryId: string;
+}
+export interface DeleteCategoryResponse {
+}

package/build/cjs/src/blog-v3-category.types.js ADDED Viewed

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortOrder = exports.Field = void 0;
+var Field;
+(function (Field) {
+    Field["UNKNOWN"] = "UNKNOWN";
+    /** Includes Category url. */
+    Field["URL"] = "URL";
+    /**
+     * Includes internal id field.
+     * Reserved for internal use
+     */
+    Field["INTERNAL_ID"] = "INTERNAL_ID";
+    /** Includes SEO data. */
+    Field["SEO"] = "SEO";
+})(Field = exports.Field || (exports.Field = {}));
+var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder = exports.SortOrder || (exports.SortOrder = {}));
+//# sourceMappingURL=blog-v3-category.types.js.map

package/build/cjs/src/blog-v3-category.types.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"blog-v3-category.types.js","sourceRoot":"","sources":["../../../src/blog-v3-category.types.ts"],"names":[],"mappings":";;;AAgKA,IAAY,KAWX;AAXD,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,6BAA6B;IAC7B,oBAAW,CAAA;IACX;;;OAGG;IACH,oCAA2B,CAAA;IAC3B,yBAAyB;IACzB,oBAAW,CAAA;AACb,CAAC,EAXW,KAAK,GAAL,aAAK,KAAL,aAAK,QAWhB;AA2KD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB"}