@meaple-com/types 2.0.0 → 3.0.0

package/README.md

@@ -0,0 +1,58 @@
+# @meaple-com/types
+
+TypeScript types and DTOs for the [Meaple](https://meaple.com) ticketing platform SDK.
+
+## Installation
+
+```bash
+npm install @meaple-com/types
+# or
+pnpm add @meaple-com/types
+# or
+bun add @meaple-com/types
+```
+
+## Usage
+
+Use these types in your app or in other Meaple packages for type-safe APIs:
+
+```ts
+import type {
+  EventProps,
+  FindEventsParams,
+  TicketProps,
+  OrderProps,
+  CreateOrderParams,
+  CouponProps,
+  UserProps,
+  CategoryProps,
+} from '@meaple-com/types';
+```
+
+### Exported namespaces
+
+- **Address** – `AddressProps`
+- **Category** – `CategoryProps`, `ChartCategoryProps`
+- **Channel** – `ChannelProps`, `GetChannelEventsProps`, `GetChannelEventProps`
+- **Coupon** – `CouponProps`, `CheckCouponProps`
+- **Event** – `EventProps`, `FindEventsParams`, `FindEventsResponseProps`, `GetEventTicketsResponseProps`, `GetEventProductsResponseProps`, `EventContact`, `ExternalAnalyticsProps`, `CreateEventReminderProps`
+- **File** – `FileProps`, `CreateTicketFileProps`
+- **Gauge** – `GaugeProps`
+- **Order** – `OrderProps`, `OrderItemProps`, `CreateOrderParams`, `CreatedOrderResponseProps`, `GetOrderResponseProps`, `BuyerProps`, `PaymentIntentProps`, `NominationProps`, `PlatformFeeProps`
+- **Payment** – `PlatformFeeProps`
+- **Tag** – `TagProps`
+- **Ticket** – `TicketProps`, `GroupProps`, `UpdateUserTicketProps`, `TransferTicketProps`, `TicketCustomFieldProps`
+- **User** – `UserProps`, `GetUserEventsProps`, `GetUserOrdersProps`
+- **User ticket** – `UserTicketProps`
+
+## Peer usage
+
+This package has no runtime code; it only provides type definitions. It is used by:
+
+- `@meaple-com/core` – API client types
+- `@meaple-com/react-query` – hook request/response types
+- `@meaple-com/react-headless-components` – component prop types
+
+## Documentation
+
+[https://docs.meaple.com.br/](https://docs.meaple.com.br/)

package/dist/index.d.mts

@@ -149,6 +149,47 @@ type CreateEventReminderProps = {
   phoneNumber: string;
 };
 
+type FindEventTagProps = Pick<
+  TagProps,
+  'id' | 'name' | 'description' | 'emoji' | 'parentId'
+>;
+
+type FindEventProps = Pick<
+  EventProps,
+  | 'id'
+  | 'name'
+  | 'slug'
+  | 'description'
+  | 'canceledAt'
+  | 'endsAt'
+  | 'startsAt'
+  | 'presaleStartsAt'
+  | 'timezone'
+  | 'status'
+  | 'categories'
+  | 'address'
+  | 'channel'
+> & {
+  image: FileProps | null;
+  tags: FindEventTagProps[];
+};
+
+type FindEventsResponseProps = {
+  events: FindEventProps[];
+  cursor?: string;
+};
+
+type FindEventsParams = {
+  orderBy?: 'START_DATE' | 'END_DATE' | 'MAX_PRICE' | 'MIN_PRICE';
+  channelSlugs?: string[];
+  limit?: number;
+  cursor?: string;
+  q?: string;
+  enabled?: boolean;
+  priority?: number;
+  categoryIds?: string[];
+};
+
 type GaugeProps = {
   totalAmount: number;
   usedAmount: number;
@@ -223,7 +264,7 @@ type TicketProps = {
   customFields?: TicketCustomField[];
 };
 
-type FindEventProductEventProps = Pick<
+type GetEventProductEventProps = Pick<
   EventProps,
   'id' | 'endsAt' | 'presaleStartsAt'
 > & {
@@ -231,7 +272,7 @@ type FindEventProductEventProps = Pick<
   maxBuyAmount: number | null;
 };
 
-type FindEventProductItemProps = Pick<
+type GetEventProductProps = Pick<
   TicketProps,
   | 'id'
   | 'name'
@@ -246,60 +287,19 @@ type FindEventProductItemProps = Pick<
   | 'maxBuy'
 >;
 
-type FindEventProductsProps = {
-  event: FindEventProductEventProps;
-  products: FindEventProductItemProps[];
-};
-
-type FindEventTagItemProps = Pick<
-  TagProps,
-  'id' | 'name' | 'description' | 'emoji' | 'parentId'
->;
-
-type FindEventItemProps = Pick<
-  EventProps,
-  | 'id'
-  | 'name'
-  | 'slug'
-  | 'description'
-  | 'canceledAt'
-  | 'endsAt'
-  | 'startsAt'
-  | 'presaleStartsAt'
-  | 'timezone'
-  | 'status'
-  | 'categories'
-  | 'address'
-  | 'channel'
-> & {
-  image: FileProps | null;
-  tags: FindEventTagItemProps[];
-};
-
-type FindEventsProps = {
-  events: FindEventItemProps[];
-  cursor?: string;
-};
-
-type FindEventsParams = {
-  orderBy?: 'START_DATE' | 'END_DATE' | 'MAX_PRICE' | 'MIN_PRICE';
-  channelSlugs?: string[];
-  limit?: number;
-  cursor?: string;
-  q?: string;
-  enabled?: boolean;
-  priority?: number;
-  categoryIds?: string[];
+type GetEventProductsResponseProps = {
+  event: GetEventProductEventProps;
+  products: GetEventProductProps[];
 };
 
-type FindEventTicketsEventProps = Pick<
+type GetEventTicketsEventProps = Pick<
   EventProps,
   'id' | 'startsAt' | 'endsAt' | 'presaleStartsAt'
 > & {
   maxBuyAmount: number | null;
 };
 
-type FindEventTicketItemProps = Pick<
+type GetEventTicketProps = Pick<
   TicketProps,
   | 'id'
   | 'type'
@@ -319,17 +319,17 @@ type FindEventTicketItemProps = Pick<
   | 'maxBuy'
 >;
 
-type FindEventTicketGroupProps = Pick<
+type GetEventTicketGroupProps = Pick<
   GroupProps,
   'id' | 'name' | 'description' | 'defaultOpen' | 'orderAt' | 'maxBuyAmount'
 > & {
-  tickets: FindEventTicketItemProps[];
+  tickets: GetEventTicketProps[];
 };
 
-type FindEventTicketsProps = {
-  event: FindEventTicketsEventProps;
-  tickets: FindEventTicketItemProps[];
-  groups: FindEventTicketGroupProps[];
+type GetEventTicketsResponseProps = {
+  event: GetEventTicketsEventProps;
+  tickets: GetEventTicketProps[];
+  groups: GetEventTicketGroupProps[];
 };
 
 type BuyerProps = {
@@ -442,7 +442,7 @@ type CreatedOrderItemProps = Pick<OrderItemProps, 'id' | 'amount'> & {
   ticket: CreatedOrderItemTicketProps;
 };
 
-type CreatedOrderOrderProps = Pick<
+type CreatedOrderProps = Pick<
   OrderProps,
   'id' | 'rawPrice' | 'totalPrice' | 'totalFee' | 'totalDiscount'
 > & {
@@ -454,9 +454,9 @@ type CreatedOrderOrderProps = Pick<
   info: Record<string, unknown>;
 };
 
-type CreatedOrderProps = {
+type CreatedOrderResponseProps = {
   type: 'success';
-  order: CreatedOrderOrderProps;
+  order: CreatedOrderProps;
   clientSecret: string;
 };
 
@@ -466,7 +466,7 @@ type CreateOrderTicketProps = {
   seatIds?: string[];
 };
 
-type CreateOrderProps = {
+type CreateOrderParams = {
   eventId: string;
   tickets: CreateOrderTicketProps[];
   couponId?: string;
@@ -567,7 +567,7 @@ type PaymentIntentProps = {
   | OrderWithBankSlipProps
 );
 
-type GetOrderProps = {
+type GetOrderResponseProps = {
   order: OrderProps & {
     items: OrderItemProps[];
     userTickets: UserTicketProps[];
@@ -691,4 +691,4 @@ type GetMeUserProps = Pick<
   | 'avatar'
 >;
 
-export type { AddressProps, BuyerProps, CategoryProps, ChannelProps, ChartCategoryProps, CheckCouponProps, CouponProps, CreateEventReminderProps, CreateOrderProps, CreateOrderTicketProps, CreateTicketFileProps, CreatedOrderEventProps, CreatedOrderGroupProps, CreatedOrderItemProps, CreatedOrderItemTicketProps, CreatedOrderOrderProps, CreatedOrderProps, EventAgePolicyType, EventContact, EventProps, EventReviewStats, ExternalAnalyticsProps, FileProps, FindEventItemProps, FindEventProductEventProps, FindEventProductItemProps, FindEventProductsProps, FindEventTagItemProps, FindEventTicketGroupProps, FindEventTicketItemProps, FindEventTicketsEventProps, FindEventTicketsProps, FindEventsParams, FindEventsProps, GaugeProps, GetChannelEventProps, GetChannelEventsProps, GetMeUserProps, GetOrderProps, GetUserEventsProps, GetUserOrdersProps, GroupProps, NominationProps, OrderEventProps, OrderItemProps, OrderItemTicketProps, OrderProps, PaymentIntentProps, PlatformFeeProps, TagProps, TicketCustomField, TicketCustomFieldType, TicketFileOutput, TicketProps, TransferTicketProps, TransferTicketRecipientProps, UpdateUserTicketProps, UserOrderItemProps, UserOrderProps, UserProps, UserTicketEventProps, UserTicketItemTicketProps, UserTicketProps };
+export type { AddressProps, BuyerProps, CategoryProps, ChannelProps, ChartCategoryProps, CheckCouponProps, CouponProps, CreateEventReminderProps, CreateOrderParams, CreateOrderTicketProps, CreateTicketFileProps, CreatedOrderEventProps, CreatedOrderGroupProps, CreatedOrderItemProps, CreatedOrderItemTicketProps, CreatedOrderProps, CreatedOrderResponseProps, EventAgePolicyType, EventContact, EventProps, EventReviewStats, ExternalAnalyticsProps, FileProps, FindEventProps, FindEventTagProps, FindEventsParams, FindEventsResponseProps, GaugeProps, GetChannelEventProps, GetChannelEventsProps, GetEventProductEventProps, GetEventProductProps, GetEventProductsResponseProps, GetEventTicketGroupProps, GetEventTicketProps, GetEventTicketsEventProps, GetEventTicketsResponseProps, GetMeUserProps, GetOrderResponseProps, GetUserEventsProps, GetUserOrdersProps, GroupProps, NominationProps, OrderEventProps, OrderItemProps, OrderItemTicketProps, OrderProps, PaymentIntentProps, PlatformFeeProps, TagProps, TicketCustomField, TicketCustomFieldType, TicketFileOutput, TicketProps, TransferTicketProps, TransferTicketRecipientProps, UpdateUserTicketProps, UserOrderItemProps, UserOrderProps, UserProps, UserTicketEventProps, UserTicketItemTicketProps, UserTicketProps };

package/dist/index.d.ts

@@ -149,6 +149,47 @@ type CreateEventReminderProps = {
   phoneNumber: string;
 };
 
+type FindEventTagProps = Pick<
+  TagProps,
+  'id' | 'name' | 'description' | 'emoji' | 'parentId'
+>;
+
+type FindEventProps = Pick<
+  EventProps,
+  | 'id'
+  | 'name'
+  | 'slug'
+  | 'description'
+  | 'canceledAt'
+  | 'endsAt'
+  | 'startsAt'
+  | 'presaleStartsAt'
+  | 'timezone'
+  | 'status'
+  | 'categories'
+  | 'address'
+  | 'channel'
+> & {
+  image: FileProps | null;
+  tags: FindEventTagProps[];
+};
+
+type FindEventsResponseProps = {
+  events: FindEventProps[];
+  cursor?: string;
+};
+
+type FindEventsParams = {
+  orderBy?: 'START_DATE' | 'END_DATE' | 'MAX_PRICE' | 'MIN_PRICE';
+  channelSlugs?: string[];
+  limit?: number;
+  cursor?: string;
+  q?: string;
+  enabled?: boolean;
+  priority?: number;
+  categoryIds?: string[];
+};
+
 type GaugeProps = {
   totalAmount: number;
   usedAmount: number;
@@ -223,7 +264,7 @@ type TicketProps = {
   customFields?: TicketCustomField[];
 };
 
-type FindEventProductEventProps = Pick<
+type GetEventProductEventProps = Pick<
   EventProps,
   'id' | 'endsAt' | 'presaleStartsAt'
 > & {
@@ -231,7 +272,7 @@ type FindEventProductEventProps = Pick<
   maxBuyAmount: number | null;
 };
 
-type FindEventProductItemProps = Pick<
+type GetEventProductProps = Pick<
   TicketProps,
   | 'id'
   | 'name'
@@ -246,60 +287,19 @@ type FindEventProductItemProps = Pick<
   | 'maxBuy'
 >;
 
-type FindEventProductsProps = {
-  event: FindEventProductEventProps;
-  products: FindEventProductItemProps[];
-};
-
-type FindEventTagItemProps = Pick<
-  TagProps,
-  'id' | 'name' | 'description' | 'emoji' | 'parentId'
->;
-
-type FindEventItemProps = Pick<
-  EventProps,
-  | 'id'
-  | 'name'
-  | 'slug'
-  | 'description'
-  | 'canceledAt'
-  | 'endsAt'
-  | 'startsAt'
-  | 'presaleStartsAt'
-  | 'timezone'
-  | 'status'
-  | 'categories'
-  | 'address'
-  | 'channel'
-> & {
-  image: FileProps | null;
-  tags: FindEventTagItemProps[];
-};
-
-type FindEventsProps = {
-  events: FindEventItemProps[];
-  cursor?: string;
-};
-
-type FindEventsParams = {
-  orderBy?: 'START_DATE' | 'END_DATE' | 'MAX_PRICE' | 'MIN_PRICE';
-  channelSlugs?: string[];
-  limit?: number;
-  cursor?: string;
-  q?: string;
-  enabled?: boolean;
-  priority?: number;
-  categoryIds?: string[];
+type GetEventProductsResponseProps = {
+  event: GetEventProductEventProps;
+  products: GetEventProductProps[];
 };
 
-type FindEventTicketsEventProps = Pick<
+type GetEventTicketsEventProps = Pick<
   EventProps,
   'id' | 'startsAt' | 'endsAt' | 'presaleStartsAt'
 > & {
   maxBuyAmount: number | null;
 };
 
-type FindEventTicketItemProps = Pick<
+type GetEventTicketProps = Pick<
   TicketProps,
   | 'id'
   | 'type'
@@ -319,17 +319,17 @@ type FindEventTicketItemProps = Pick<
   | 'maxBuy'
 >;
 
-type FindEventTicketGroupProps = Pick<
+type GetEventTicketGroupProps = Pick<
   GroupProps,
   'id' | 'name' | 'description' | 'defaultOpen' | 'orderAt' | 'maxBuyAmount'
 > & {
-  tickets: FindEventTicketItemProps[];
+  tickets: GetEventTicketProps[];
 };
 
-type FindEventTicketsProps = {
-  event: FindEventTicketsEventProps;
-  tickets: FindEventTicketItemProps[];
-  groups: FindEventTicketGroupProps[];
+type GetEventTicketsResponseProps = {
+  event: GetEventTicketsEventProps;
+  tickets: GetEventTicketProps[];
+  groups: GetEventTicketGroupProps[];
 };
 
 type BuyerProps = {
@@ -442,7 +442,7 @@ type CreatedOrderItemProps = Pick<OrderItemProps, 'id' | 'amount'> & {
   ticket: CreatedOrderItemTicketProps;
 };
 
-type CreatedOrderOrderProps = Pick<
+type CreatedOrderProps = Pick<
   OrderProps,
   'id' | 'rawPrice' | 'totalPrice' | 'totalFee' | 'totalDiscount'
 > & {
@@ -454,9 +454,9 @@ type CreatedOrderOrderProps = Pick<
   info: Record<string, unknown>;
 };
 
-type CreatedOrderProps = {
+type CreatedOrderResponseProps = {
   type: 'success';
-  order: CreatedOrderOrderProps;
+  order: CreatedOrderProps;
   clientSecret: string;
 };
 
@@ -466,7 +466,7 @@ type CreateOrderTicketProps = {
   seatIds?: string[];
 };
 
-type CreateOrderProps = {
+type CreateOrderParams = {
   eventId: string;
   tickets: CreateOrderTicketProps[];
   couponId?: string;
@@ -567,7 +567,7 @@ type PaymentIntentProps = {
   | OrderWithBankSlipProps
 );
 
-type GetOrderProps = {
+type GetOrderResponseProps = {
   order: OrderProps & {
     items: OrderItemProps[];
     userTickets: UserTicketProps[];
@@ -691,4 +691,4 @@ type GetMeUserProps = Pick<
   | 'avatar'
 >;
 
-export type { AddressProps, BuyerProps, CategoryProps, ChannelProps, ChartCategoryProps, CheckCouponProps, CouponProps, CreateEventReminderProps, CreateOrderProps, CreateOrderTicketProps, CreateTicketFileProps, CreatedOrderEventProps, CreatedOrderGroupProps, CreatedOrderItemProps, CreatedOrderItemTicketProps, CreatedOrderOrderProps, CreatedOrderProps, EventAgePolicyType, EventContact, EventProps, EventReviewStats, ExternalAnalyticsProps, FileProps, FindEventItemProps, FindEventProductEventProps, FindEventProductItemProps, FindEventProductsProps, FindEventTagItemProps, FindEventTicketGroupProps, FindEventTicketItemProps, FindEventTicketsEventProps, FindEventTicketsProps, FindEventsParams, FindEventsProps, GaugeProps, GetChannelEventProps, GetChannelEventsProps, GetMeUserProps, GetOrderProps, GetUserEventsProps, GetUserOrdersProps, GroupProps, NominationProps, OrderEventProps, OrderItemProps, OrderItemTicketProps, OrderProps, PaymentIntentProps, PlatformFeeProps, TagProps, TicketCustomField, TicketCustomFieldType, TicketFileOutput, TicketProps, TransferTicketProps, TransferTicketRecipientProps, UpdateUserTicketProps, UserOrderItemProps, UserOrderProps, UserProps, UserTicketEventProps, UserTicketItemTicketProps, UserTicketProps };
+export type { AddressProps, BuyerProps, CategoryProps, ChannelProps, ChartCategoryProps, CheckCouponProps, CouponProps, CreateEventReminderProps, CreateOrderParams, CreateOrderTicketProps, CreateTicketFileProps, CreatedOrderEventProps, CreatedOrderGroupProps, CreatedOrderItemProps, CreatedOrderItemTicketProps, CreatedOrderProps, CreatedOrderResponseProps, EventAgePolicyType, EventContact, EventProps, EventReviewStats, ExternalAnalyticsProps, FileProps, FindEventProps, FindEventTagProps, FindEventsParams, FindEventsResponseProps, GaugeProps, GetChannelEventProps, GetChannelEventsProps, GetEventProductEventProps, GetEventProductProps, GetEventProductsResponseProps, GetEventTicketGroupProps, GetEventTicketProps, GetEventTicketsEventProps, GetEventTicketsResponseProps, GetMeUserProps, GetOrderResponseProps, GetUserEventsProps, GetUserOrdersProps, GroupProps, NominationProps, OrderEventProps, OrderItemProps, OrderItemTicketProps, OrderProps, PaymentIntentProps, PlatformFeeProps, TagProps, TicketCustomField, TicketCustomFieldType, TicketFileOutput, TicketProps, TransferTicketProps, TransferTicketRecipientProps, UpdateUserTicketProps, UserOrderItemProps, UserOrderProps, UserProps, UserTicketEventProps, UserTicketItemTicketProps, UserTicketProps };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meaple-com/types",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "TypeScript types for Meaple SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",