@wix/forum_categories - npm Package Compare versions

Comparing version 1.0.18 to 1.0.19

build/cjs/src/forum-v1-category-categories.public.d.ts

 import { HttpClient, EventDefinition } from '@wix/sdk-types';
-import { Category, DomainCreatedEvent, DomainDeletedEvent, DomainUpdatedEvent, GetCategoryBySlugOptions, GetCategoryOptions, QueryCategoriesOptions, SubscribeContactToCategoryOptions, UnsubscribeContactFromCategoryOptions } from './forum-v1-category-categories.universal';
+import { CategoryCreatedEvent, CategoryDeletedEvent, CategoryUpdatedEvent, GetCategoryBySlugOptions, GetCategoryOptions, QueryCategoriesOptions, SubscribeContactToCategoryOptions, UnsubscribeContactFromCategoryOptions } from './forum-v1-category-categories.universal';
 export declare const __metadata: {
     PACKAGE_NAME: string;
 };
-export declare function getCategory(httpClient: HttpClient): (categoryId: string, options?: GetCategoryOptions) => Promise<Category & {
+export declare function getCategory(httpClient: HttpClient): (categoryId: string, options?: GetCategoryOptions) => Promise<import("./forum-v1-category-categories.universal").Category & {
     headerType: import("./forum-v1-category-categories.universal").HeaderType;
@@ -34,6 +34,6 @@ headerImage: string;
 export declare function unsubscribeContactFromCategory(httpClient: HttpClient): (categoryId: string, options?: UnsubscribeContactFromCategoryOptions) => Promise<void>;
-export declare const onCategoryCreated: EventDefinition<DomainCreatedEvent<Category>, "wix.forum.category_created">;
-export declare const onCategoryUpdated: EventDefinition<DomainUpdatedEvent<Category>, "wix.forum.category_updated">;
-export declare const onCategoryDeleted: EventDefinition<DomainDeletedEvent<Category>, "wix.forum.category_deleted">;
+export declare const onCategoryCreated: EventDefinition<CategoryCreatedEvent, "wix.forum.category_created">;
+export declare const onCategoryUpdated: EventDefinition<CategoryUpdatedEvent, "wix.forum.category_updated">;
+export declare const onCategoryDeleted: EventDefinition<CategoryDeletedEvent, "wix.forum.category_deleted">;
 export { HeaderType, PostType, Access, Interaction, Type, PostInteraction, CommentOrder, CategoryFieldField, Field, Order, WebhookIdentityType, } from './forum-v1-category-categories.universal';
-export { Category, ColorComponent, Reaction, ReactionReactionOneOf, SeoSchema, Keyword, Tag, Settings, CategoryRequest, CategoryResponse, CategorySlugRequest, QueryCategoriesRequest, CategoriesPaging, CategoriesSort, QueryCategoriesResponse, QueryCategoriesResponseMetaData, MarkCategoryReadRequest, MarkCategoryReadResponse, MarkAllPostsAsReadRequest, MarkAllPostsAsReadResponse, CreateCategoryRequest, UpdateCategoryRequest, DeleteCategoryRequest, DeleteCategoryResponse, SubscribeContactToCategoryRequest, SubscribeContactToCategoryResponse, UnsubscribeContactFromCategoryRequest, UnsubscribeContactFromCategoryResponse, DomainEvent, DomainCreatedEvent, DomainDeletedEvent, DomainUpdatedEvent, DomainActionEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, CategoryResponseNonNullableFields, QueryCategoriesResponseNonNullableFields, EventMetadata, GetCategoryOptions, GetCategoryBySlugOptions, QueryCategoriesOptions, SubscribeContactToCategoryOptions, UnsubscribeContactFromCategoryOptions, } from './forum-v1-category-categories.universal';
+export { Category, ColorComponent, Reaction, ReactionReactionOneOf, SeoSchema, Keyword, Tag, Settings, CategoryRequest, CategoryResponse, CategorySlugRequest, QueryCategoriesRequest, CategoriesPaging, CategoriesSort, QueryCategoriesResponse, QueryCategoriesResponseMetaData, MarkCategoryReadRequest, MarkCategoryReadResponse, MarkAllPostsAsReadRequest, MarkAllPostsAsReadResponse, CreateCategoryRequest, UpdateCategoryRequest, DeleteCategoryRequest, DeleteCategoryResponse, SubscribeContactToCategoryRequest, SubscribeContactToCategoryResponse, UnsubscribeContactFromCategoryRequest, UnsubscribeContactFromCategoryResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, CategoryResponseNonNullableFields, QueryCategoriesResponseNonNullableFields, BaseEventMetadata, EventMetadata, CategoryCreatedEvent, CategoryUpdatedEvent, CategoryDeletedEvent, GetCategoryOptions, GetCategoryBySlugOptions, QueryCategoriesOptions, SubscribeContactToCategoryOptions, UnsubscribeContactFromCategoryOptions, } from './forum-v1-category-categories.universal';

build/cjs/src/forum-v1-category-categories.universal.d.ts

@@ -328,7 +328,7 @@ export interface Category {
 }
-export interface DomainEvent<T = string> extends DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
     /**
@@ -371,21 +371,13 @@ * Unique event ID.
 }
-export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
-}
-export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
-}
 /** @oneof */
-export interface DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent<T> {
-    entity?: T;
+export interface EntityCreatedEvent {
+    entity?: string;
 }
-export interface EntityUpdatedEvent<T> {
+export interface EntityUpdatedEvent {
     /**
@@ -396,10 +388,10 @@ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
      */
-    currentEntity?: T;
+    currentEntity?: string;
 }
-export interface EntityDeletedEvent<T> {
+export interface EntityDeletedEvent {
     /** Entity that was deleted */
-    deletedEntity?: T | null;
+    deletedEntity?: string | null;
 }
-export interface ActionEvent<T> {
-    body?: T;
+export interface ActionEvent {
+    body?: string;
 }
@@ -503,3 +495,11 @@ export interface MessageEnvelope {
 }
-export interface EventMetadata {
+export interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+export interface EventMetadata extends BaseEventMetadata {
     /**
@@ -541,9 +541,7 @@ * Unique event ID.
     entityEventSequence?: string | null;
-    /** App instance ID. */
-    instanceId?: string | null;
-    /** Event type. */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
 }
+export interface CategoryCreatedEvent {
+    entity: Category;
+    metadata: EventMetadata;
+}
 /**
@@ -556,5 +554,10 @@ * A new category was created.
  * @webhook
+ * @eventType wix.forum.category_created
  * @documentationMaturity preview
  */
-export declare function onCategoryCreated(handler: (event: Category, metadata: EventMetadata) => void | Promise<void>): void;
+export declare function onCategoryCreated(handler: (event: CategoryCreatedEvent) => void | Promise<void>): void;
+export interface CategoryUpdatedEvent {
+    entity: Category;
+    metadata: EventMetadata;
+}
 /**
@@ -567,5 +570,9 @@ * An existing category was updated.
  * @webhook
+ * @eventType wix.forum.category_updated
  * @documentationMaturity preview
  */
-export declare function onCategoryUpdated(handler: (event: Category, metadata: EventMetadata) => void | Promise<void>): void;
+export declare function onCategoryUpdated(handler: (event: CategoryUpdatedEvent) => void | Promise<void>): void;
+export interface CategoryDeletedEvent {
+    metadata: EventMetadata;
+}
 /**
@@ -578,5 +585,6 @@ * An existing category was removed.
  * @webhook
+ * @eventType wix.forum.category_deleted
  * @documentationMaturity preview
  */
-export declare function onCategoryDeleted(handler: (event: Category, metadata: EventMetadata) => void | Promise<void>): void;
+export declare function onCategoryDeleted(handler: (event: CategoryDeletedEvent) => void | Promise<void>): void;
 /**
@@ -583,0 +591,0 @@ * Returns a single category by ID.

build/es/src/forum-v1-category-categories.public.d.ts

 import { HttpClient, EventDefinition } from '@wix/sdk-types';
-import { Category, DomainCreatedEvent, DomainDeletedEvent, DomainUpdatedEvent, GetCategoryBySlugOptions, GetCategoryOptions, QueryCategoriesOptions, SubscribeContactToCategoryOptions, UnsubscribeContactFromCategoryOptions } from './forum-v1-category-categories.universal';
+import { CategoryCreatedEvent, CategoryDeletedEvent, CategoryUpdatedEvent, GetCategoryBySlugOptions, GetCategoryOptions, QueryCategoriesOptions, SubscribeContactToCategoryOptions, UnsubscribeContactFromCategoryOptions } from './forum-v1-category-categories.universal';
 export declare const __metadata: {
     PACKAGE_NAME: string;
 };
-export declare function getCategory(httpClient: HttpClient): (categoryId: string, options?: GetCategoryOptions) => Promise<Category & {
+export declare function getCategory(httpClient: HttpClient): (categoryId: string, options?: GetCategoryOptions) => Promise<import("./forum-v1-category-categories.universal").Category & {
     headerType: import("./forum-v1-category-categories.universal").HeaderType;
@@ -34,6 +34,6 @@ headerImage: string;
 export declare function unsubscribeContactFromCategory(httpClient: HttpClient): (categoryId: string, options?: UnsubscribeContactFromCategoryOptions) => Promise<void>;
-export declare const onCategoryCreated: EventDefinition<DomainCreatedEvent<Category>, "wix.forum.category_created">;
-export declare const onCategoryUpdated: EventDefinition<DomainUpdatedEvent<Category>, "wix.forum.category_updated">;
-export declare const onCategoryDeleted: EventDefinition<DomainDeletedEvent<Category>, "wix.forum.category_deleted">;
+export declare const onCategoryCreated: EventDefinition<CategoryCreatedEvent, "wix.forum.category_created">;
+export declare const onCategoryUpdated: EventDefinition<CategoryUpdatedEvent, "wix.forum.category_updated">;
+export declare const onCategoryDeleted: EventDefinition<CategoryDeletedEvent, "wix.forum.category_deleted">;
 export { HeaderType, PostType, Access, Interaction, Type, PostInteraction, CommentOrder, CategoryFieldField, Field, Order, WebhookIdentityType, } from './forum-v1-category-categories.universal';
-export { Category, ColorComponent, Reaction, ReactionReactionOneOf, SeoSchema, Keyword, Tag, Settings, CategoryRequest, CategoryResponse, CategorySlugRequest, QueryCategoriesRequest, CategoriesPaging, CategoriesSort, QueryCategoriesResponse, QueryCategoriesResponseMetaData, MarkCategoryReadRequest, MarkCategoryReadResponse, MarkAllPostsAsReadRequest, MarkAllPostsAsReadResponse, CreateCategoryRequest, UpdateCategoryRequest, DeleteCategoryRequest, DeleteCategoryResponse, SubscribeContactToCategoryRequest, SubscribeContactToCategoryResponse, UnsubscribeContactFromCategoryRequest, UnsubscribeContactFromCategoryResponse, DomainEvent, DomainCreatedEvent, DomainDeletedEvent, DomainUpdatedEvent, DomainActionEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, CategoryResponseNonNullableFields, QueryCategoriesResponseNonNullableFields, EventMetadata, GetCategoryOptions, GetCategoryBySlugOptions, QueryCategoriesOptions, SubscribeContactToCategoryOptions, UnsubscribeContactFromCategoryOptions, } from './forum-v1-category-categories.universal';
+export { Category, ColorComponent, Reaction, ReactionReactionOneOf, SeoSchema, Keyword, Tag, Settings, CategoryRequest, CategoryResponse, CategorySlugRequest, QueryCategoriesRequest, CategoriesPaging, CategoriesSort, QueryCategoriesResponse, QueryCategoriesResponseMetaData, MarkCategoryReadRequest, MarkCategoryReadResponse, MarkAllPostsAsReadRequest, MarkAllPostsAsReadResponse, CreateCategoryRequest, UpdateCategoryRequest, DeleteCategoryRequest, DeleteCategoryResponse, SubscribeContactToCategoryRequest, SubscribeContactToCategoryResponse, UnsubscribeContactFromCategoryRequest, UnsubscribeContactFromCategoryResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, CategoryResponseNonNullableFields, QueryCategoriesResponseNonNullableFields, BaseEventMetadata, EventMetadata, CategoryCreatedEvent, CategoryUpdatedEvent, CategoryDeletedEvent, GetCategoryOptions, GetCategoryBySlugOptions, QueryCategoriesOptions, SubscribeContactToCategoryOptions, UnsubscribeContactFromCategoryOptions, } from './forum-v1-category-categories.universal';

build/es/src/forum-v1-category-categories.universal.d.ts

@@ -328,7 +328,7 @@ export interface Category {
 }
-export interface DomainEvent<T = string> extends DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
     /**
@@ -371,21 +371,13 @@ * Unique event ID.
 }
-export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
-}
-export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
-}
 /** @oneof */
-export interface DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent<T> {
-    entity?: T;
+export interface EntityCreatedEvent {
+    entity?: string;
 }
-export interface EntityUpdatedEvent<T> {
+export interface EntityUpdatedEvent {
     /**
@@ -396,10 +388,10 @@ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
      */
-    currentEntity?: T;
+    currentEntity?: string;
 }
-export interface EntityDeletedEvent<T> {
+export interface EntityDeletedEvent {
     /** Entity that was deleted */
-    deletedEntity?: T | null;
+    deletedEntity?: string | null;
 }
-export interface ActionEvent<T> {
-    body?: T;
+export interface ActionEvent {
+    body?: string;
 }
@@ -503,3 +495,11 @@ export interface MessageEnvelope {
 }
-export interface EventMetadata {
+export interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+export interface EventMetadata extends BaseEventMetadata {
     /**
@@ -541,9 +541,7 @@ * Unique event ID.
     entityEventSequence?: string | null;
-    /** App instance ID. */
-    instanceId?: string | null;
-    /** Event type. */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
 }
+export interface CategoryCreatedEvent {
+    entity: Category;
+    metadata: EventMetadata;
+}
 /**
@@ -556,5 +554,10 @@ * A new category was created.
  * @webhook
+ * @eventType wix.forum.category_created
  * @documentationMaturity preview
  */
-export declare function onCategoryCreated(handler: (event: Category, metadata: EventMetadata) => void | Promise<void>): void;
+export declare function onCategoryCreated(handler: (event: CategoryCreatedEvent) => void | Promise<void>): void;
+export interface CategoryUpdatedEvent {
+    entity: Category;
+    metadata: EventMetadata;
+}
 /**
@@ -567,5 +570,9 @@ * An existing category was updated.
  * @webhook
+ * @eventType wix.forum.category_updated
  * @documentationMaturity preview
  */
-export declare function onCategoryUpdated(handler: (event: Category, metadata: EventMetadata) => void | Promise<void>): void;
+export declare function onCategoryUpdated(handler: (event: CategoryUpdatedEvent) => void | Promise<void>): void;
+export interface CategoryDeletedEvent {
+    metadata: EventMetadata;
+}
 /**
@@ -578,5 +585,6 @@ * An existing category was removed.
  * @webhook
+ * @eventType wix.forum.category_deleted
  * @documentationMaturity preview
  */
-export declare function onCategoryDeleted(handler: (event: Category, metadata: EventMetadata) => void | Promise<void>): void;
+export declare function onCategoryDeleted(handler: (event: CategoryDeletedEvent) => void | Promise<void>): void;
 /**
@@ -583,0 +591,0 @@ * Returns a single category by ID.

package.json

 {
   "name": "@wix/forum_categories",
-  "version": "1.0.18",
+  "version": "1.0.19",
   "publishConfig": {
@@ -22,3 +22,3 @@ "registry": "https://registry.npmjs.org/",
     "@wix/sdk-runtime": "^0.2.10",
-    "@wix/sdk-types": "^1.6.0"
+    "@wix/sdk-types": "^1.6.2"
   },
@@ -43,3 +43,3 @@ "devDependencies": {
   },
-  "falconPackageHash": "d978580bab8d7e7ff0574f35fbde09826fd2cac590e5570f1c26e5e1"
+  "falconPackageHash": "16d3d97da02e82d6ad2843c3f96d055eafb4b787e2fbcfe0c64d0756"
 }

No alert changes

Improved metrics

Lines of code

5125

increased by0.27%

Worsened metrics

Total package byte prevSize

243340

decreased by-0.07%

Dependency changes

• Updated@wix/sdk-types@^1.6.2