@wix/blog_categories - npm Package Compare versions

Comparing version 1.0.33 to 1.0.34

build/cjs/src/blog-v3-category-categories.types.d.ts

@@ -28,2 +28,5 @@ export interface Category {
      * Category cover image or video.
+     * @deprecated
+     * @replacedBy cover_image
+     * @removalDate 2024-06-30
      */
@@ -41,2 +44,8 @@ coverMedia?: CoverMedia;
      * Category position in sequence.
+     * @deprecated __Deprecated.__ Use `displayPosition` instead.
+     * This property will be removed on June 30, 2023.
+     *
+     * Category position in sequence.
+     * @replacedBy display_position
+     * @removalDate 2024-06-30
      */
@@ -89,2 +98,6 @@ rank?: number | null;
      * Selected by user whether to display cover media on the feed
+     * @deprecated Is cover media enabled.
+     * Selected by user whether to display cover media on the feed
+     * @replacedBy displayed
+     * @removalDate 2024-06-30
      */
@@ -344,2 +357,8 @@ enabled?: boolean;
      * List of category fields to be included in the response.
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
      */
@@ -366,2 +385,8 @@ fieldsToInclude?: Field[];
      * List of category fields to be included in the response.
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     *
+     * This parameter will be removed on June 30, 2023.
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
      */
@@ -394,2 +419,9 @@ fieldsToInclude?: Field[];
      * List of category fields to be included in the response.
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     *
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
      */
@@ -452,2 +484,8 @@ fieldsToInclude?: Field[];
      * Pagination options.
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Pagination options.
+     * @replacedBy query
+     * @removalDate 2024-06-30
      */
@@ -460,2 +498,8 @@ paging?: BlogPaging;
      * Filter object.
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Filter object.
+     * @replacedBy query
+     * @removalDate 2024-06-30
      */
@@ -468,2 +512,8 @@ filter?: Record<string, any> | null;
      * Sorting options.
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 3, 2023.
+     *
+     * Sorting options.
+     * @replacedBy query
+     * @removalDate 2024-06-30
      */
@@ -476,2 +526,8 @@ sort?: Sorting[];
      * List of category fields to be included in the response.
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
      */
@@ -551,2 +607,8 @@ fieldsToInclude?: Field[];
      * Details on the paged set of results returned.
+     * @deprecated __Deprecated.__ Use `pagingMetadata` instead.
+     * This property will be removed on June 30, 2023.
+     *
+     * Details on the paged set of results returned.
+     * @replacedBy pagingMetadata
+     * @removalDate 2024-06-30
      */
@@ -553,0 +615,0 @@ metaData?: MetaData;

build/cjs/src/blog-v3-category-categories.universal.d.ts

@@ -27,3 +27,8 @@ export interface Category {
     title?: string;
-    /** Reserved for internal use. */
+    /**
+     * Reserved for internal use.
+     * @deprecated
+     * @replacedBy cover_image
+     * @removalDate 2024-06-30
+     */
     coverMedia?: CoverMedia;
@@ -35,3 +40,11 @@ /**
     oldRank?: number;
-    /** Reserved for internal use. */
+    /**
+     * Reserved for internal use.
+     * @deprecated __Deprecated.__ Use `displayPosition` instead.
+     * This property will be removed on June 30, 2023.
+     *
+     * Category position in sequence.
+     * @replacedBy display_position
+     * @removalDate 2024-06-30
+     */
     rank?: number | null;
@@ -78,2 +91,6 @@ /** Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu). Categories with lower display position are displayed first. */
      * Selected by user whether to display cover media on the feed
+     * @deprecated Is cover media enabled.
+     * Selected by user whether to display cover media on the feed
+     * @replacedBy displayed
+     * @removalDate 2024-06-30
      */
@@ -291,2 +308,8 @@ enabled?: boolean;
      * List of category fields to be included in the response.
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
      */
@@ -313,2 +336,8 @@ fieldsToInclude?: Field[];
      * List of category fields to be included in the response.
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     *
+     * This parameter will be removed on June 30, 2023.
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
      */
@@ -341,2 +370,9 @@ fieldsToInclude?: Field[];
      * List of category fields to be included in the response.
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     *
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
      */
@@ -395,2 +431,8 @@ fieldsToInclude?: Field[];
      * Pagination options.
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Pagination options.
+     * @replacedBy query
+     * @removalDate 2024-06-30
      */
@@ -403,2 +445,8 @@ paging?: BlogPaging;
      * Filter object.
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Filter object.
+     * @replacedBy query
+     * @removalDate 2024-06-30
      */
@@ -411,2 +459,8 @@ filter?: Record<string, any> | null;
      * Sorting options.
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 3, 2023.
+     *
+     * Sorting options.
+     * @replacedBy query
+     * @removalDate 2024-06-30
      */
@@ -419,2 +473,8 @@ sort?: Sorting[];
      * List of category fields to be included in the response.
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
      */
@@ -494,2 +554,8 @@ fieldsToInclude?: Field[];
      * Details on the paged set of results returned.
+     * @deprecated __Deprecated.__ Use `pagingMetadata` instead.
+     * This property will be removed on June 30, 2023.
+     *
+     * Details on the paged set of results returned.
+     * @replacedBy pagingMetadata
+     * @removalDate 2024-06-30
      */
@@ -899,3 +965,11 @@ metaData?: MetaData;
 export interface GetCategoryOptions {
-    /** @internal */
+    /**
+     * @internal
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
+     */
     fieldsToInclude?: Field[];
@@ -930,3 +1004,11 @@ /** List of category fields to be included in the response. By default, any fields not passed are not returned. */
 export interface GetCategoryBySlugOptions {
-    /** @internal */
+    /**
+     * @internal
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     *
+     * This parameter will be removed on June 30, 2023.
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
+     */
     fieldsToInclude?: Field[];
@@ -961,3 +1043,12 @@ /** List of category fields to be included in the response. By default, any fields not passed are not returned. */
     paging?: BlogPaging;
-    /** @internal */
+    /**
+     * @internal
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     *
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
+     */
     fieldsToInclude?: Field[];
@@ -1003,9 +1094,41 @@ /** List of category fields to be included in the response. By default, any fields not passed are not returned. */
 export interface QueryCategoriesOptions {
-    /** @internal */
+    /**
+     * @internal
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Pagination options.
+     * @replacedBy query
+     * @removalDate 2024-06-30
+     */
     paging?: BlogPaging | undefined;
-    /** @internal */
+    /**
+     * @internal
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Filter object.
+     * @replacedBy query
+     * @removalDate 2024-06-30
+     */
     filter?: Record<string, any> | null | undefined;
-    /** @internal */
+    /**
+     * @internal
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 3, 2023.
+     *
+     * Sorting options.
+     * @replacedBy query
+     * @removalDate 2024-06-30
+     */
     sort?: Sorting[] | undefined;
-    /** @internal */
+    /**
+     * @internal
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
+     */
     fieldsToInclude?: Field[] | undefined;
@@ -1012,0 +1135,0 @@ /** List of category fields to be included in the response. By default, any fields not passed are not returned. */

build/es/src/blog-v3-category-categories.types.d.ts

@@ -28,2 +28,5 @@ export interface Category {
      * Category cover image or video.
+     * @deprecated
+     * @replacedBy cover_image
+     * @removalDate 2024-06-30
      */
@@ -41,2 +44,8 @@ coverMedia?: CoverMedia;
      * Category position in sequence.
+     * @deprecated __Deprecated.__ Use `displayPosition` instead.
+     * This property will be removed on June 30, 2023.
+     *
+     * Category position in sequence.
+     * @replacedBy display_position
+     * @removalDate 2024-06-30
      */
@@ -89,2 +98,6 @@ rank?: number | null;
      * Selected by user whether to display cover media on the feed
+     * @deprecated Is cover media enabled.
+     * Selected by user whether to display cover media on the feed
+     * @replacedBy displayed
+     * @removalDate 2024-06-30
      */
@@ -344,2 +357,8 @@ enabled?: boolean;
      * List of category fields to be included in the response.
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
      */
@@ -366,2 +385,8 @@ fieldsToInclude?: Field[];
      * List of category fields to be included in the response.
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     *
+     * This parameter will be removed on June 30, 2023.
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
      */
@@ -394,2 +419,9 @@ fieldsToInclude?: Field[];
      * List of category fields to be included in the response.
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     *
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
      */
@@ -452,2 +484,8 @@ fieldsToInclude?: Field[];
      * Pagination options.
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Pagination options.
+     * @replacedBy query
+     * @removalDate 2024-06-30
      */
@@ -460,2 +498,8 @@ paging?: BlogPaging;
      * Filter object.
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Filter object.
+     * @replacedBy query
+     * @removalDate 2024-06-30
      */
@@ -468,2 +512,8 @@ filter?: Record<string, any> | null;
      * Sorting options.
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 3, 2023.
+     *
+     * Sorting options.
+     * @replacedBy query
+     * @removalDate 2024-06-30
      */
@@ -476,2 +526,8 @@ sort?: Sorting[];
      * List of category fields to be included in the response.
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
      */
@@ -551,2 +607,8 @@ fieldsToInclude?: Field[];
      * Details on the paged set of results returned.
+     * @deprecated __Deprecated.__ Use `pagingMetadata` instead.
+     * This property will be removed on June 30, 2023.
+     *
+     * Details on the paged set of results returned.
+     * @replacedBy pagingMetadata
+     * @removalDate 2024-06-30
      */
@@ -553,0 +615,0 @@ metaData?: MetaData;

build/es/src/blog-v3-category-categories.universal.d.ts

@@ -27,3 +27,8 @@ export interface Category {
     title?: string;
-    /** Reserved for internal use. */
+    /**
+     * Reserved for internal use.
+     * @deprecated
+     * @replacedBy cover_image
+     * @removalDate 2024-06-30
+     */
     coverMedia?: CoverMedia;
@@ -35,3 +40,11 @@ /**
     oldRank?: number;
-    /** Reserved for internal use. */
+    /**
+     * Reserved for internal use.
+     * @deprecated __Deprecated.__ Use `displayPosition` instead.
+     * This property will be removed on June 30, 2023.
+     *
+     * Category position in sequence.
+     * @replacedBy display_position
+     * @removalDate 2024-06-30
+     */
     rank?: number | null;
@@ -78,2 +91,6 @@ /** Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu). Categories with lower display position are displayed first. */
      * Selected by user whether to display cover media on the feed
+     * @deprecated Is cover media enabled.
+     * Selected by user whether to display cover media on the feed
+     * @replacedBy displayed
+     * @removalDate 2024-06-30
      */
@@ -291,2 +308,8 @@ enabled?: boolean;
      * List of category fields to be included in the response.
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
      */
@@ -313,2 +336,8 @@ fieldsToInclude?: Field[];
      * List of category fields to be included in the response.
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     *
+     * This parameter will be removed on June 30, 2023.
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
      */
@@ -341,2 +370,9 @@ fieldsToInclude?: Field[];
      * List of category fields to be included in the response.
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     *
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
      */
@@ -395,2 +431,8 @@ fieldsToInclude?: Field[];
      * Pagination options.
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Pagination options.
+     * @replacedBy query
+     * @removalDate 2024-06-30
      */
@@ -403,2 +445,8 @@ paging?: BlogPaging;
      * Filter object.
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Filter object.
+     * @replacedBy query
+     * @removalDate 2024-06-30
      */
@@ -411,2 +459,8 @@ filter?: Record<string, any> | null;
      * Sorting options.
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 3, 2023.
+     *
+     * Sorting options.
+     * @replacedBy query
+     * @removalDate 2024-06-30
      */
@@ -419,2 +473,8 @@ sort?: Sorting[];
      * List of category fields to be included in the response.
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
      */
@@ -494,2 +554,8 @@ fieldsToInclude?: Field[];
      * Details on the paged set of results returned.
+     * @deprecated __Deprecated.__ Use `pagingMetadata` instead.
+     * This property will be removed on June 30, 2023.
+     *
+     * Details on the paged set of results returned.
+     * @replacedBy pagingMetadata
+     * @removalDate 2024-06-30
      */
@@ -899,3 +965,11 @@ metaData?: MetaData;
 export interface GetCategoryOptions {
-    /** @internal */
+    /**
+     * @internal
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
+     */
     fieldsToInclude?: Field[];
@@ -930,3 +1004,11 @@ /** List of category fields to be included in the response. By default, any fields not passed are not returned. */
 export interface GetCategoryBySlugOptions {
-    /** @internal */
+    /**
+     * @internal
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     *
+     * This parameter will be removed on June 30, 2023.
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
+     */
     fieldsToInclude?: Field[];
@@ -961,3 +1043,12 @@ /** List of category fields to be included in the response. By default, any fields not passed are not returned. */
     paging?: BlogPaging;
-    /** @internal */
+    /**
+     * @internal
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     *
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
+     */
     fieldsToInclude?: Field[];
@@ -1003,9 +1094,41 @@ /** List of category fields to be included in the response. By default, any fields not passed are not returned. */
 export interface QueryCategoriesOptions {
-    /** @internal */
+    /**
+     * @internal
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Pagination options.
+     * @replacedBy query
+     * @removalDate 2024-06-30
+     */
     paging?: BlogPaging | undefined;
-    /** @internal */
+    /**
+     * @internal
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Filter object.
+     * @replacedBy query
+     * @removalDate 2024-06-30
+     */
     filter?: Record<string, any> | null | undefined;
-    /** @internal */
+    /**
+     * @internal
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 3, 2023.
+     *
+     * Sorting options.
+     * @replacedBy query
+     * @removalDate 2024-06-30
+     */
     sort?: Sorting[] | undefined;
-    /** @internal */
+    /**
+     * @internal
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of category fields to be included in the response.
+     * @replacedBy fieldsets
+     * @removalDate 2024-06-30
+     */
     fieldsToInclude?: Field[] | undefined;
@@ -1012,0 +1135,0 @@ /** List of category fields to be included in the response. By default, any fields not passed are not returned. */

context/package.json

@@ -5,3 +5,4 @@ {
   "main": "../build/cjs/context.js",
-  "typings": "../build/cjs/context.d.ts"
+  "typings": "../build/cjs/context.d.ts",
+  "typesBundle": "../type-bundles/context.bundle.d.ts"
 }

meta/package.json

@@ -5,3 +5,4 @@ {
   "main": "../build/cjs/meta.js",
-  "typings": "../build/cjs/meta.d.ts"
+  "typings": "../build/cjs/meta.d.ts",
+  "typesBundle": "../type-bundles/meta.bundle.d.ts"
 }

package.json

 {
   "name": "@wix/blog_categories",
-  "version": "1.0.33",
+  "version": "1.0.34",
   "publishConfig": {
@@ -12,2 +12,3 @@ "registry": "https://registry.npmjs.org/",
   "typings": "./build/cjs/index.d.ts",
+  "typesBundle": "./type-bundles/index.bundle.d.ts",
   "files": [
@@ -17,3 +18,4 @@ "build",
     "meta",
-    "context"
+    "context",
+    "type-bundles"
   ],
@@ -28,6 +30,10 @@ "dependencies": {
     "@wix/sdk": "https://cdn.dev.wixpress.com/@wix/sdk/02e8069ab2fd783e0e6a080fc7d590e76cb26ab93c8389574286305b.tar.gz",
+    "glob": "^10.4.1",
+    "rollup": "^4.18.0",
+    "rollup-plugin-dts": "^6.1.1",
     "typescript": "^5.3.2"
   },
   "scripts": {
-    "build": "tsc -b tsconfig.json tsconfig.esm.json",
+    "build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles",
+    "build:dts-bundles": "test -f config/rollup-config.js && rollup --config config/rollup-config.js || echo 'Warning: config/rollup-config.js not found!'",
     "test": ":"
@@ -45,3 +51,3 @@ },
   },
-  "falconPackageHash": "26342144e9821742b379a02f4ec797a9a6ae31478a14d13ce62536c9"
+  "falconPackageHash": "5a72e3dd925d88a42c9b9c4e93d0d2ae1691d9acc0622104f494ee91"
 }

No alert changes

Improved metrics

Total package byte prevSize

452522

increased by57.94%

Number of package files

67

increased by6.35%

Lines of code

10877

increased by75.32%

Worsened metrics

Dev dependency count

5

increased by150%

No dependency changes