@vansite/ts-sharetribe-flex-sdk 1.0.34 → 3.0.0

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 (274) hide show
  1. package/README.md +1 -1
  2. package/dist/endpoints/assets/index.d.ts +47 -0
  3. package/dist/endpoints/auth/index.d.ts +45 -0
  4. package/dist/endpoints/integrationApi/AvailabilityExceptions.d.ts +66 -0
  5. package/dist/endpoints/integrationApi/Events.d.ts +43 -0
  6. package/dist/endpoints/integrationApi/Images.d.ts +36 -0
  7. package/dist/endpoints/integrationApi/Listings.d.ts +87 -0
  8. package/dist/endpoints/integrationApi/Marketplace.d.ts +30 -0
  9. package/dist/endpoints/integrationApi/Stock.d.ts +42 -0
  10. package/dist/endpoints/integrationApi/StockAdjustments.d.ts +64 -0
  11. package/dist/{types/endpoints/integrationApi/StockReservation.d.ts → endpoints/integrationApi/StockReservations.d.ts} +3 -4
  12. package/dist/endpoints/integrationApi/Transactions.d.ts +76 -0
  13. package/dist/endpoints/integrationApi/Users.d.ts +72 -0
  14. package/dist/endpoints/integrationApi/index.d.ts +58 -0
  15. package/dist/endpoints/marketplace/AvailabilityExceptions.d.ts +69 -0
  16. package/dist/endpoints/marketplace/Bookings.d.ts +45 -0
  17. package/dist/endpoints/marketplace/CurrentUser.d.ts +110 -0
  18. package/dist/endpoints/marketplace/Images.d.ts +38 -0
  19. package/dist/endpoints/marketplace/Listings.d.ts +52 -0
  20. package/dist/endpoints/marketplace/Marketplace.d.ts +33 -0
  21. package/dist/endpoints/marketplace/Messages.d.ts +51 -0
  22. package/dist/endpoints/marketplace/OwnListings.d.ts +116 -0
  23. package/dist/endpoints/marketplace/PasswordReset.d.ts +50 -0
  24. package/dist/endpoints/marketplace/ProcessTransitions.d.ts +42 -0
  25. package/dist/endpoints/marketplace/Reviews.d.ts +49 -0
  26. package/dist/endpoints/marketplace/SitemapData.d.ts +60 -0
  27. package/dist/endpoints/marketplace/Stock.d.ts +50 -0
  28. package/dist/endpoints/marketplace/StockAdjustments.d.ts +64 -0
  29. package/dist/endpoints/marketplace/StripeAccount.d.ts +56 -0
  30. package/dist/endpoints/marketplace/StripeAccountLinks.d.ts +42 -0
  31. package/dist/endpoints/marketplace/StripeCustomer.d.ts +62 -0
  32. package/dist/endpoints/marketplace/StripePersons.d.ts +37 -0
  33. package/dist/endpoints/marketplace/StripeSetupIntents.d.ts +42 -0
  34. package/dist/endpoints/marketplace/TimeSlots.d.ts +40 -0
  35. package/dist/endpoints/marketplace/Transactions.d.ts +89 -0
  36. package/dist/endpoints/marketplace/Users.d.ts +34 -0
  37. package/dist/endpoints/marketplace/index.d.ts +82 -0
  38. package/dist/index.d.ts +161 -0
  39. package/dist/index.js +3 -0
  40. package/dist/{ts-sharetribe-flex-sdk.cjs.LICENSE.txt → index.js.LICENSE.txt} +35 -5
  41. package/dist/index.js.map +1 -0
  42. package/dist/index.mjs +3 -0
  43. package/dist/{ts-sharetribe-flex-sdk.js.LICENSE.txt → index.mjs.LICENSE.txt} +35 -5
  44. package/dist/index.mjs.map +1 -0
  45. package/dist/index.umd.js +3 -0
  46. package/dist/{ts-sharetribe-flex-sdk.mjs.LICENSE.txt → index.umd.js.LICENSE.txt} +35 -5
  47. package/dist/index.umd.js.map +1 -0
  48. package/dist/integrationSdk.d.ts +119 -0
  49. package/dist/sdk.d.ts +211 -0
  50. package/dist/sdkTypes/BigDecimal.d.ts +30 -0
  51. package/dist/sdkTypes/LatLng.d.ts +34 -0
  52. package/dist/sdkTypes/LatLngBounds.d.ts +51 -0
  53. package/dist/sdkTypes/Money.d.ts +35 -0
  54. package/dist/sdkTypes/UUID.d.ts +45 -0
  55. package/dist/types/apiConfigs.d.ts +104 -0
  56. package/dist/types/assets/index.d.ts +101 -0
  57. package/dist/types/authentication/index.d.ts +152 -0
  58. package/dist/types/axios.d.ts +10 -0
  59. package/dist/types/config.d.ts +99 -0
  60. package/dist/types/endpoints/assets/index.d.ts +22 -36
  61. package/dist/types/endpoints/assets/index.d.ts.map +1 -1
  62. package/dist/types/endpoints/auth/index.d.ts +20 -41
  63. package/dist/types/endpoints/auth/index.d.ts.map +1 -1
  64. package/dist/types/endpoints/integrationApi/AvailabilityExceptions.d.ts +30 -49
  65. package/dist/types/endpoints/integrationApi/AvailabilityExceptions.d.ts.map +1 -1
  66. package/dist/types/endpoints/integrationApi/Events.d.ts +23 -27
  67. package/dist/types/endpoints/integrationApi/Events.d.ts.map +1 -1
  68. package/dist/types/endpoints/integrationApi/Images.d.ts +17 -28
  69. package/dist/types/endpoints/integrationApi/Images.d.ts.map +1 -1
  70. package/dist/types/endpoints/integrationApi/Listings.d.ts +42 -104
  71. package/dist/types/endpoints/integrationApi/Listings.d.ts.map +1 -1
  72. package/dist/types/endpoints/integrationApi/Marketplace.d.ts +12 -20
  73. package/dist/types/endpoints/integrationApi/Marketplace.d.ts.map +1 -1
  74. package/dist/types/endpoints/integrationApi/Stock.d.ts +22 -28
  75. package/dist/types/endpoints/integrationApi/Stock.d.ts.map +1 -1
  76. package/dist/types/endpoints/integrationApi/StockAdjustments.d.ts +35 -35
  77. package/dist/types/endpoints/integrationApi/StockAdjustments.d.ts.map +1 -1
  78. package/dist/types/endpoints/integrationApi/StockReservations.d.ts +43 -0
  79. package/dist/types/endpoints/integrationApi/StockReservations.d.ts.map +1 -0
  80. package/dist/types/endpoints/integrationApi/Transactions.d.ts +36 -80
  81. package/dist/types/endpoints/integrationApi/Transactions.d.ts.map +1 -1
  82. package/dist/types/endpoints/integrationApi/Users.d.ts +35 -70
  83. package/dist/types/endpoints/integrationApi/Users.d.ts.map +1 -1
  84. package/dist/types/endpoints/integrationApi/index.d.ts +40 -40
  85. package/dist/types/endpoints/integrationApi/index.d.ts.map +1 -1
  86. package/dist/types/endpoints/marketplace/AvailabilityExceptions.d.ts +34 -48
  87. package/dist/types/endpoints/marketplace/AvailabilityExceptions.d.ts.map +1 -1
  88. package/dist/types/endpoints/marketplace/Bookings.d.ts +24 -23
  89. package/dist/types/endpoints/marketplace/Bookings.d.ts.map +1 -1
  90. package/dist/types/endpoints/marketplace/CurrentUser.d.ts +54 -125
  91. package/dist/types/endpoints/marketplace/CurrentUser.d.ts.map +1 -1
  92. package/dist/types/endpoints/marketplace/Images.d.ts +19 -27
  93. package/dist/types/endpoints/marketplace/Images.d.ts.map +1 -1
  94. package/dist/types/endpoints/marketplace/Listings.d.ts +26 -25
  95. package/dist/types/endpoints/marketplace/Listings.d.ts.map +1 -1
  96. package/dist/types/endpoints/marketplace/Marketplace.d.ts +15 -19
  97. package/dist/types/endpoints/marketplace/Marketplace.d.ts.map +1 -1
  98. package/dist/types/endpoints/marketplace/Messages.d.ts +24 -29
  99. package/dist/types/endpoints/marketplace/Messages.d.ts.map +1 -1
  100. package/dist/types/endpoints/marketplace/OwnListings.d.ts +55 -119
  101. package/dist/types/endpoints/marketplace/OwnListings.d.ts.map +1 -1
  102. package/dist/types/endpoints/marketplace/PasswordReset.d.ts +23 -35
  103. package/dist/types/endpoints/marketplace/PasswordReset.d.ts.map +1 -1
  104. package/dist/types/endpoints/marketplace/ProcessTransitions.d.ts +22 -22
  105. package/dist/types/endpoints/marketplace/ProcessTransitions.d.ts.map +1 -1
  106. package/dist/types/endpoints/marketplace/Reviews.d.ts +23 -25
  107. package/dist/types/endpoints/marketplace/Reviews.d.ts.map +1 -1
  108. package/dist/types/endpoints/marketplace/SitemapData.d.ts +61 -0
  109. package/dist/types/endpoints/marketplace/SitemapData.d.ts.map +1 -0
  110. package/dist/types/endpoints/marketplace/Stock.d.ts +30 -26
  111. package/dist/types/endpoints/marketplace/Stock.d.ts.map +1 -1
  112. package/dist/types/endpoints/marketplace/StockAdjustments.d.ts +36 -34
  113. package/dist/types/endpoints/marketplace/StockAdjustments.d.ts.map +1 -1
  114. package/dist/types/endpoints/marketplace/StripeAccount.d.ts +28 -49
  115. package/dist/types/endpoints/marketplace/StripeAccount.d.ts.map +1 -1
  116. package/dist/types/endpoints/marketplace/StripeAccountLinks.d.ts +22 -31
  117. package/dist/types/endpoints/marketplace/StripeAccountLinks.d.ts.map +1 -1
  118. package/dist/types/endpoints/marketplace/StripeCustomer.d.ts +32 -46
  119. package/dist/types/endpoints/marketplace/StripeCustomer.d.ts.map +1 -1
  120. package/dist/types/endpoints/marketplace/StripePersons.d.ts +17 -25
  121. package/dist/types/endpoints/marketplace/StripePersons.d.ts.map +1 -1
  122. package/dist/types/endpoints/marketplace/StripeSetupIntents.d.ts +24 -24
  123. package/dist/types/endpoints/marketplace/StripeSetupIntents.d.ts.map +1 -1
  124. package/dist/types/endpoints/marketplace/TimeSlots.d.ts +20 -23
  125. package/dist/types/endpoints/marketplace/TimeSlots.d.ts.map +1 -1
  126. package/dist/types/endpoints/marketplace/Transactions.d.ts +45 -81
  127. package/dist/types/endpoints/marketplace/Transactions.d.ts.map +1 -1
  128. package/dist/types/endpoints/marketplace/Users.d.ts +15 -22
  129. package/dist/types/endpoints/marketplace/Users.d.ts.map +1 -1
  130. package/dist/types/endpoints/marketplace/index.d.ts +52 -40
  131. package/dist/types/endpoints/marketplace/index.d.ts.map +1 -1
  132. package/dist/types/index.d.ts +15 -30
  133. package/dist/types/index.d.ts.map +1 -1
  134. package/dist/types/integration/events.d.ts +87 -0
  135. package/dist/types/integrationSdk.d.ts +4 -5
  136. package/dist/types/integrationSdk.d.ts.map +1 -1
  137. package/dist/types/marketplace/availabilityExceptions.d.ts +99 -0
  138. package/dist/types/marketplace/availabilityPlan.d.ts +17 -0
  139. package/dist/types/marketplace/bookings.d.ts +80 -0
  140. package/dist/types/marketplace/currentUser.d.ts +202 -0
  141. package/dist/types/marketplace/images.d.ts +65 -0
  142. package/dist/types/marketplace/listings.d.ts +169 -0
  143. package/dist/types/marketplace/marketplace.d.ts +30 -0
  144. package/dist/types/marketplace/messages.d.ts +87 -0
  145. package/dist/types/marketplace/ownListings.d.ts +155 -0
  146. package/dist/types/marketplace/passwordReset.d.ts +54 -0
  147. package/dist/types/marketplace/processTransitions.d.ts +56 -0
  148. package/dist/types/marketplace/reviews.d.ts +108 -0
  149. package/dist/types/marketplace/sitemapData.d.ts +47 -0
  150. package/dist/types/marketplace/stock.d.ts +45 -0
  151. package/dist/types/marketplace/stockAdjustment.d.ts +97 -0
  152. package/dist/types/marketplace/stockReservations.d.ts +89 -0
  153. package/dist/types/marketplace/stripeAccount.d.ts +67 -0
  154. package/dist/types/marketplace/stripeAccountLinks.d.ts +55 -0
  155. package/dist/types/marketplace/stripeCustomer.d.ts +94 -0
  156. package/dist/types/marketplace/stripePaymentMethod.d.ts +21 -0
  157. package/dist/types/marketplace/stripePersons.d.ts +48 -0
  158. package/dist/types/marketplace/stripeSetupIntents.d.ts +48 -0
  159. package/dist/types/marketplace/timeSlots.d.ts +51 -0
  160. package/dist/types/marketplace/transactions.d.ts +200 -0
  161. package/dist/types/marketplace/user.d.ts +200 -0
  162. package/dist/types/sdk-types.d.ts +10 -0
  163. package/dist/types/sdk.d.ts +6 -7
  164. package/dist/types/sdk.d.ts.map +1 -1
  165. package/dist/types/sdkTypes/BigDecimal.d.ts +1 -1
  166. package/dist/types/sdkTypes/BigDecimal.d.ts.map +1 -1
  167. package/dist/types/sdkTypes/LatLng.d.ts +1 -1
  168. package/dist/types/sdkTypes/LatLng.d.ts.map +1 -1
  169. package/dist/types/sdkTypes/LatLngBounds.d.ts +1 -1
  170. package/dist/types/sdkTypes/LatLngBounds.d.ts.map +1 -1
  171. package/dist/types/sdkTypes/Money.d.ts +9 -2
  172. package/dist/types/sdkTypes/Money.d.ts.map +1 -1
  173. package/dist/types/sdkTypes/UUID.d.ts +8 -1
  174. package/dist/types/sdkTypes/UUID.d.ts.map +1 -1
  175. package/dist/types/sharetribe.d.ts +227 -0
  176. package/dist/types/store.d.ts +22 -0
  177. package/dist/types/types/apiConfigs.d.ts.map +1 -1
  178. package/dist/types/types/assets/index.d.ts +74 -36
  179. package/dist/types/types/assets/index.d.ts.map +1 -1
  180. package/dist/types/types/authentication/index.d.ts +111 -60
  181. package/dist/types/types/authentication/index.d.ts.map +1 -1
  182. package/dist/types/types/axios.d.ts.map +1 -1
  183. package/dist/types/types/config.d.ts +1 -39
  184. package/dist/types/types/config.d.ts.map +1 -1
  185. package/dist/types/types/integration/events.d.ts +52 -20
  186. package/dist/types/types/integration/events.d.ts.map +1 -1
  187. package/dist/types/types/marketplace/availabilityExceptions.d.ts +59 -16
  188. package/dist/types/types/marketplace/availabilityExceptions.d.ts.map +1 -1
  189. package/dist/types/types/marketplace/availabilityPlan.d.ts +18 -0
  190. package/dist/types/types/marketplace/availabilityPlan.d.ts.map +1 -0
  191. package/dist/types/types/marketplace/bookings.d.ts +48 -14
  192. package/dist/types/types/marketplace/bookings.d.ts.map +1 -1
  193. package/dist/types/types/marketplace/currentUser.d.ts +99 -55
  194. package/dist/types/types/marketplace/currentUser.d.ts.map +1 -1
  195. package/dist/types/types/marketplace/images.d.ts +40 -14
  196. package/dist/types/types/marketplace/images.d.ts.map +1 -1
  197. package/dist/types/types/marketplace/listings.d.ts +96 -66
  198. package/dist/types/types/marketplace/listings.d.ts.map +1 -1
  199. package/dist/types/types/marketplace/marketplace.d.ts +16 -6
  200. package/dist/types/types/marketplace/marketplace.d.ts.map +1 -1
  201. package/dist/types/types/marketplace/messages.d.ts +53 -15
  202. package/dist/types/types/marketplace/messages.d.ts.map +1 -1
  203. package/dist/types/types/marketplace/ownListings.d.ts +92 -65
  204. package/dist/types/types/marketplace/ownListings.d.ts.map +1 -1
  205. package/dist/types/types/marketplace/passwordReset.d.ts +32 -9
  206. package/dist/types/types/marketplace/passwordReset.d.ts.map +1 -1
  207. package/dist/types/types/marketplace/processTransitions.d.ts +33 -14
  208. package/dist/types/types/marketplace/processTransitions.d.ts.map +1 -1
  209. package/dist/types/types/marketplace/reviews.d.ts +72 -23
  210. package/dist/types/types/marketplace/reviews.d.ts.map +1 -1
  211. package/dist/types/types/marketplace/sitemapData.d.ts +48 -0
  212. package/dist/types/types/marketplace/sitemapData.d.ts.map +1 -0
  213. package/dist/types/types/marketplace/stock.d.ts +23 -6
  214. package/dist/types/types/marketplace/stock.d.ts.map +1 -1
  215. package/dist/types/types/marketplace/stockAdjustment.d.ts +60 -14
  216. package/dist/types/types/marketplace/stockAdjustment.d.ts.map +1 -1
  217. package/dist/types/types/marketplace/stockReservations.d.ts +59 -14
  218. package/dist/types/types/marketplace/stockReservations.d.ts.map +1 -1
  219. package/dist/types/types/marketplace/stripeAccount.d.ts +28 -5
  220. package/dist/types/types/marketplace/stripeAccount.d.ts.map +1 -1
  221. package/dist/types/types/marketplace/stripeAccountLinks.d.ts +26 -6
  222. package/dist/types/types/marketplace/stripeAccountLinks.d.ts.map +1 -1
  223. package/dist/types/types/marketplace/stripeCustomer.d.ts +60 -13
  224. package/dist/types/types/marketplace/stripeCustomer.d.ts.map +1 -1
  225. package/dist/types/types/marketplace/stripePaymentMethod.d.ts +1 -2
  226. package/dist/types/types/marketplace/stripePaymentMethod.d.ts.map +1 -1
  227. package/dist/types/types/marketplace/stripePersons.d.ts +17 -15
  228. package/dist/types/types/marketplace/stripePersons.d.ts.map +1 -1
  229. package/dist/types/types/marketplace/stripeSetupIntents.d.ts +16 -14
  230. package/dist/types/types/marketplace/stripeSetupIntents.d.ts.map +1 -1
  231. package/dist/types/types/marketplace/timeSlots.d.ts +13 -15
  232. package/dist/types/types/marketplace/timeSlots.d.ts.map +1 -1
  233. package/dist/types/types/marketplace/transactions.d.ts +77 -83
  234. package/dist/types/types/marketplace/transactions.d.ts.map +1 -1
  235. package/dist/types/types/marketplace/user.d.ts +85 -64
  236. package/dist/types/types/marketplace/user.d.ts.map +1 -1
  237. package/dist/types/types/sharetribe.d.ts +130 -92
  238. package/dist/types/types/sharetribe.d.ts.map +1 -1
  239. package/dist/types/types/store.d.ts +3 -14
  240. package/dist/types/types/store.d.ts.map +1 -1
  241. package/dist/types/utils/apis.d.ts +1 -1
  242. package/dist/types/utils/apis.d.ts.map +1 -1
  243. package/dist/types/utils/config.d.ts.map +1 -1
  244. package/dist/types/utils/prepare-axios-instance.d.ts +1 -1
  245. package/dist/types/utils/prepare-axios-instance.d.ts.map +1 -1
  246. package/dist/types/utils/stores/BrowserStore.d.ts +17 -4
  247. package/dist/types/utils/stores/BrowserStore.d.ts.map +1 -1
  248. package/dist/types/utils/stores/ExpressStore.d.ts +26 -8
  249. package/dist/types/utils/stores/ExpressStore.d.ts.map +1 -1
  250. package/dist/types/utils/stores/MemoryStore.d.ts +1 -2
  251. package/dist/types/utils/stores/MemoryStore.d.ts.map +1 -1
  252. package/dist/types/utils/transit.d.ts +1 -1
  253. package/dist/types/utils/transit.d.ts.map +1 -1
  254. package/dist/types/utils/util.d.ts +2 -2
  255. package/dist/types/utils/util.d.ts.map +1 -1
  256. package/dist/utils/apis.d.ts +8 -0
  257. package/dist/utils/config.d.ts +32 -0
  258. package/dist/utils/convert-types.d.ts +13 -0
  259. package/dist/utils/parameter-serializer.d.ts +23 -0
  260. package/dist/utils/prepare-axios-instance.d.ts +14 -0
  261. package/dist/utils/stores/BrowserStore.d.ts +51 -0
  262. package/dist/utils/stores/ExpressStore.d.ts +67 -0
  263. package/dist/utils/stores/MemoryStore.d.ts +23 -0
  264. package/dist/utils/stores/store.d.ts +8 -0
  265. package/dist/utils/transit.d.ts +28 -0
  266. package/dist/utils/util.d.ts +15 -0
  267. package/package.json +16 -14
  268. package/dist/ts-sharetribe-flex-sdk.cjs +0 -3
  269. package/dist/ts-sharetribe-flex-sdk.cjs.map +0 -1
  270. package/dist/ts-sharetribe-flex-sdk.js +0 -3
  271. package/dist/ts-sharetribe-flex-sdk.js.map +0 -1
  272. package/dist/ts-sharetribe-flex-sdk.mjs +0 -3
  273. package/dist/ts-sharetribe-flex-sdk.mjs.map +0 -1
  274. package/dist/types/endpoints/integrationApi/StockReservation.d.ts.map +0 -1
@@ -1,129 +1,156 @@
1
1
  /**
2
2
  * @fileoverview Type definitions for Own Listings in the Sharetribe Marketplace API.
3
- * These types define the structure for own listing parameters, attributes, and responses.
4
3
  */
5
- import { ApiMeta, ApiParameter, ExtraParameter, UUID, LatLng, Money, Relationship, RelationshipTypeMap, ExtraParameterType } from "../sharetribe";
4
+ import { ApiMeta, ApiParameter, ExtraParameterType, LatLng, Money, Relationship, RelationshipTypeMap, UUID } from "../sharetribe";
5
+ import { AvailabilityPlan } from "./availabilityPlan";
6
+ /**
7
+ * Listing states
8
+ */
6
9
  export type OwnListingState = "draft" | "pendingApproval" | "published" | "closed";
10
+ /**
11
+ * Available endpoints
12
+ */
7
13
  export type OwnListingsEndpoints = "show" | "query" | "create" | "createDraft" | "update" | "publishDraft" | "discardDraft" | "close" | "open" | "addImage";
14
+ /**
15
+ * Relationship fields
16
+ */
8
17
  export type OwnListingsRelationshipsFields = "marketplace" | "author.profileImage" | "author.marketplace" | "author.stripeAccount" | "author.effectivePermissionSet" | "images" | "currentStock";
9
- type OwnListingsAvailabilityPlanTypes = "availability-plan/day" | "availability-plan/time";
10
- type OwnListingsAvailabilityPlanEntry<T extends OwnListingsAvailabilityPlanTypes> = {
11
- dayOfWeek: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
12
- seats: number;
13
- } & T extends "availability-plan/time" ? {
14
- startTime: string;
15
- endTime: string;
16
- } : {};
17
- export type OwnListingsAvailabilityPlan<T extends OwnListingsAvailabilityPlanTypes = "availability-plan/day"> = {
18
- type: T;
19
- timezone?: string;
20
- entries: Array<OwnListingsAvailabilityPlanEntry<T>>;
21
- };
18
+ /**
19
+ * Own Listing resource
20
+ */
22
21
  export interface OwnListing {
23
22
  id: UUID;
24
23
  type: "ownListing";
25
24
  attributes: {
25
+ title: string;
26
26
  description: string;
27
- deleted: boolean;
27
+ price: Money;
28
28
  geolocation: LatLng;
29
- createdAt: Date;
30
29
  state: OwnListingState;
31
- title: string;
32
- availabilityPlan: OwnListingsAvailabilityPlan;
30
+ deleted: boolean;
31
+ createdAt: Date;
32
+ availabilityPlan: AvailabilityPlan | null;
33
+ publicData: OwnListingPublicData & OwnListingCustomPublicData;
33
34
  privateData: OwnListingPrivateData & OwnListingCustomPrivateData;
34
- publicData: OwnListingOwnListingPublicData & OwnListingCustomPublicData;
35
35
  metadata: OwnListingMetadata & OwnListingCustomMetadata;
36
- price: Money;
37
36
  };
38
37
  }
38
+ /**
39
+ * With relationships
40
+ */
39
41
  export interface OwnListingWithRelationships extends OwnListing {
40
42
  relationships: {
41
43
  marketplace: Relationship<false, "marketplace">;
42
- author: Relationship<false, "user">;
43
- images: Relationship<true, "image">;
44
- currentStock: Relationship<false, "currentStock">;
44
+ author: Relationship<false, "author">;
45
+ images: Relationship<true, "images">;
46
+ currentStock?: Relationship<false, "currentStock">;
45
47
  };
46
48
  }
47
- export type OwnListingType<R extends boolean> = R extends true ? OwnListingWithRelationships : OwnListing;
49
+ export type OwnListingResource<R extends boolean> = R extends true ? OwnListingWithRelationships : OwnListing;
50
+ /**
51
+ * Base request parameters
52
+ */
48
53
  export interface OwnListingsParameter extends ApiParameter {
49
54
  include?: OwnListingsRelationshipsFields[];
50
55
  }
51
- export interface OwnListingsShowParameter extends OwnListingsParameter {
56
+ /**
57
+ * Endpoint-specific parameters
58
+ */
59
+ export type OwnListingsShowParameter = OwnListingsParameter & {
52
60
  id: UUID | string;
53
- }
54
- export interface OwnListingsQueryParameter extends OwnListingsParameter {
55
- }
61
+ };
62
+ export type OwnListingsQueryParameter = OwnListingsParameter;
56
63
  export interface OwnListingsCreateParameter extends OwnListingsParameter {
57
64
  title: string;
58
65
  description?: string;
59
- geolocation?: LatLng;
60
66
  price?: Money;
61
- availabilityPlan?: OwnListingsAvailabilityPlan;
67
+ geolocation?: LatLng;
68
+ availabilityPlan?: AvailabilityPlan | null;
69
+ publicData?: OwnListingPublicData & OwnListingCustomPublicData;
62
70
  privateData?: OwnListingPrivateData & OwnListingCustomPrivateData;
63
- publicData?: OwnListingOwnListingPublicData & OwnListingCustomPublicData;
64
- metaData?: OwnListingMetadata & OwnListingCustomMetadata;
71
+ metadata?: OwnListingMetadata & OwnListingCustomMetadata;
65
72
  images?: string[];
66
73
  }
67
- export interface OwnListingsCreateDraftParameter extends OwnListingsCreateParameter {
68
- }
74
+ export type OwnListingsCreateDraftParameter = OwnListingsCreateParameter;
69
75
  export interface OwnListingsUpdateParameter extends OwnListingsParameter {
70
76
  id: UUID | string;
71
77
  title?: string;
72
78
  description?: string;
73
- geolocation?: LatLng;
74
79
  price?: Money;
75
- availabilityPlan?: OwnListingsAvailabilityPlan;
80
+ geolocation?: LatLng;
81
+ availabilityPlan?: AvailabilityPlan | null;
82
+ publicData?: OwnListingPublicData & OwnListingCustomPublicData;
76
83
  privateData?: OwnListingPrivateData & OwnListingCustomPrivateData;
77
- publicData?: OwnListingOwnListingPublicData & OwnListingCustomPublicData;
78
- metaData?: OwnListingMetadata & OwnListingCustomMetadata;
84
+ metadata?: OwnListingMetadata & OwnListingCustomMetadata;
79
85
  images?: string[];
80
86
  }
81
- export interface OwnListingsPublishDraftParameter extends OwnListingsParameter {
87
+ export type OwnListingsPublishDraftParameter = OwnListingsParameter & {
82
88
  id: UUID | string;
83
- }
84
- export interface OwnListingsDiscardDraftParameter extends OwnListingsParameter {
89
+ };
90
+ export type OwnListingsDiscardDraftParameter = OwnListingsParameter & {
85
91
  id: UUID | string;
86
- }
87
- export interface OwnListingsCloseParameter extends OwnListingsParameter {
92
+ };
93
+ export type OwnListingsCloseParameter = OwnListingsParameter & {
88
94
  id: UUID | string;
89
- }
90
- export interface OwnListingsOpenParameter extends OwnListingsParameter {
95
+ };
96
+ export type OwnListingsOpenParameter = OwnListingsParameter & {
91
97
  id: UUID | string;
92
- }
93
- export interface OwnListingsAddImageParameter extends OwnListingsParameter {
98
+ };
99
+ export type OwnListingsAddImageParameter = OwnListingsParameter & {
94
100
  id: UUID | string;
95
101
  imageId: UUID | string;
96
- }
97
- export interface OwnListingOwnListingPublicData {
102
+ };
103
+ /**
104
+ * Custom data
105
+ */
106
+ export interface OwnListingPublicData {
98
107
  [key: string]: any;
99
108
  }
100
- export interface OwnListingCustomPublicData {
109
+ export interface OwnListingCustomPublicData extends Record<string, unknown> {
101
110
  }
102
111
  export interface OwnListingPrivateData {
103
112
  [key: string]: any;
104
113
  }
105
- export interface OwnListingCustomPrivateData {
114
+ export interface OwnListingCustomPrivateData extends Record<string, unknown> {
106
115
  }
107
116
  export interface OwnListingMetadata {
108
117
  [key: string]: any;
109
118
  }
110
- export interface OwnListingCustomMetadata {
119
+ export interface OwnListingCustomMetadata extends Record<string, unknown> {
111
120
  }
121
+ /**
122
+ * All parameter types
123
+ */
112
124
  type AllOwnListingsParameter = OwnListingsShowParameter | OwnListingsQueryParameter | OwnListingsCreateParameter | OwnListingsCreateDraftParameter | OwnListingsUpdateParameter | OwnListingsPublishDraftParameter | OwnListingsDiscardDraftParameter | OwnListingsCloseParameter | OwnListingsOpenParameter | OwnListingsAddImageParameter;
113
- export type OwnListingsResponse<E extends OwnListingsEndpoints, P extends AllOwnListingsParameter, EP extends ExtraParameterType = undefined> = {
114
- data: DataType<E, P, EP>;
115
- } & ("include" extends keyof P ? {
116
- included: IncludedType<P>;
125
+ /**
126
+ * Include detection — fixes TS2536
127
+ */
128
+ type HasInclude<P> = P extends {
129
+ include: infer I extends readonly OwnListingsRelationshipsFields[];
130
+ } ? I : never;
131
+ type IncludesRelationships<P> = HasInclude<P> extends never ? false : true;
132
+ type IncludedResources<P> = HasInclude<P> extends infer Fields extends OwnListingsRelationshipsFields[] ? RelationshipTypeMap[Fields[number]][] : never;
133
+ /**
134
+ * Expand behavior
135
+ */
136
+ type ExpandResult<T, EP extends ExtraParameterType | undefined> = EP extends {
137
+ expand: true;
138
+ } ? T : EP extends {
139
+ expand: false;
140
+ } ? Omit<T, "attributes"> : Omit<T, "attributes">;
141
+ /**
142
+ * Response data per endpoint
143
+ */
144
+ type ResponseData<E extends OwnListingsEndpoints, P extends AllOwnListingsParameter, EP extends ExtraParameterType | undefined> = E extends "show" | "create" | "createDraft" | "update" | "publishDraft" | "close" | "open" | "addImage" ? ExpandResult<OwnListingResource<IncludesRelationships<P>>, EP> : E extends "query" ? OwnListingResource<IncludesRelationships<P>>[] : E extends "discardDraft" ? Pick<OwnListing, "id" | "type"> : never;
145
+ /**
146
+ * Final response
147
+ */
148
+ export type OwnListingsResponse<E extends OwnListingsEndpoints, P extends AllOwnListingsParameter, EP extends ExtraParameterType | undefined = undefined> = {
149
+ data: ResponseData<E, P, EP>;
150
+ } & (IncludesRelationships<P> extends true ? {
151
+ included: IncludedResources<P>;
117
152
  } : {}) & (E extends "query" ? {
118
153
  meta: ApiMeta;
119
154
  } : {});
120
- type DataType<E extends OwnListingsEndpoints, P extends AllOwnListingsParameter, EP extends ExtraParameter | undefined> = E extends "show" ? OwnListingType<OwnListingsType<P>> : E extends "query" ? OwnListingType<OwnListingsType<P>>[] : E extends "create" ? ExpandReturnType<P, EP> : E extends "createDraft" ? ExpandReturnType<P, EP> : E extends "update" ? ExpandReturnType<P, EP> : E extends "publishDraft" ? ExpandReturnType<P, EP> : E extends "discardDraft" ? Pick<OwnListing, "id" | "type"> : E extends "close" ? ExpandReturnType<P, EP> : E extends "open" ? ExpandReturnType<P, EP> : E extends "addImage" ? ExpandReturnType<P, EP> : never;
121
- type ExpandReturnType<P extends AllOwnListingsParameter, EP> = EP extends {
122
- expand: true;
123
- } ? OwnListingType<OwnListingsType<P>> : EP extends {
124
- expand: false;
125
- } ? Omit<OwnListingType<OwnListingsType<P>>, "attributes"> : Omit<OwnListingType<OwnListingsType<P>>, "attributes">;
126
- type OwnListingsType<P extends AllOwnListingsParameter> = "include" extends keyof P ? P["include"] extends OwnListingsRelationshipsFields[] ? true : false : false;
127
- type IncludedType<P extends AllOwnListingsParameter> = "include" extends keyof P ? P["include"] extends (keyof RelationshipTypeMap)[] ? Array<RelationshipTypeMap[P["include"][number]]> : never : never;
128
155
  export {};
129
156
  //# sourceMappingURL=ownListings.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ownListings.d.ts","sourceRoot":"","sources":["../../../../src/types/marketplace/ownListings.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,OAAO,EACP,YAAY,EACZ,cAAc,EACd,IAAI,EACJ,MAAM,EACN,KAAK,EACL,YAAY,EACZ,mBAAmB,EACnB,kBAAkB,EACnB,MAAM,eAAe,CAAC;AAGvB,MAAM,MAAM,eAAe,GACvB,OAAO,GACP,iBAAiB,GACjB,WAAW,GACX,QAAQ,CAAC;AAGb,MAAM,MAAM,oBAAoB,GAC5B,MAAM,GACN,OAAO,GACP,QAAQ,GACR,aAAa,GACb,QAAQ,GACR,cAAc,GACd,cAAc,GACd,OAAO,GACP,MAAM,GACN,UAAU,CAAC;AAGf,MAAM,MAAM,8BAA8B,GACtC,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,sBAAsB,GACtB,+BAA+B,GAC/B,QAAQ,GACR,cAAc,CAAC;AAGnB,KAAK,gCAAgC,GACjC,uBAAuB,GACvB,wBAAwB,CAAC;AAC7B,KAAK,gCAAgC,CACnC,CAAC,SAAS,gCAAgC,IACxC;IACF,SAAS,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IACjE,KAAK,EAAE,MAAM,CAAC;CACf,GAAG,CAAC,SAAS,wBAAwB,GAClC;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACtC,EAAE,CAAC;AAGP,MAAM,MAAM,2BAA2B,CACrC,CAAC,SAAS,gCAAgC,GAAG,uBAAuB,IAClE;IACF,IAAI,EAAE,CAAC,CAAC;IACR,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC,CAAC,CAAC,CAAC;CACrD,CAAC;AAGF,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,IAAI,CAAC;IACT,IAAI,EAAE,YAAY,CAAC;IACnB,UAAU,EAAE;QACV,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,IAAI,CAAC;QAChB,KAAK,EAAE,eAAe,CAAC;QACvB,KAAK,EAAE,MAAM,CAAC;QACd,gBAAgB,EAAE,2BAA2B,CAAC;QAC9C,WAAW,EAAE,qBAAqB,GAAG,2BAA2B,CAAC;QACjE,UAAU,EAAE,8BAA8B,GAAG,0BAA0B,CAAC;QACxE,QAAQ,EAAE,kBAAkB,GAAG,wBAAwB,CAAC;QACxD,KAAK,EAAE,KAAK,CAAC;KACd,CAAC;CACH;AAGD,MAAM,WAAW,2BAA4B,SAAQ,UAAU;IAC7D,aAAa,EAAE;QACb,WAAW,EAAE,YAAY,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;QAChD,MAAM,EAAE,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACpC,MAAM,EAAE,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACpC,YAAY,EAAE,YAAY,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;KACnD,CAAC;CACH;AAGD,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,OAAO,IAAI,CAAC,SAAS,IAAI,GAC1D,2BAA2B,GAC3B,UAAU,CAAC;AAGf,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACxD,OAAO,CAAC,EAAE,8BAA8B,EAAE,CAAC;CAC5C;AAGD,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,EAAE,EAAE,IAAI,GAAG,MAAM,CAAC;CACnB;AACD,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;CAAG;AAC1E,MAAM,WAAW,0BAA2B,SAAQ,oBAAoB;IACtE,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,gBAAgB,CAAC,EAAE,2BAA2B,CAAC;IAC/C,WAAW,CAAC,EAAE,qBAAqB,GAAG,2BAA2B,CAAC;IAClE,UAAU,CAAC,EAAE,8BAA8B,GAAG,0BAA0B,CAAC;IACzE,QAAQ,CAAC,EAAE,kBAAkB,GAAG,wBAAwB,CAAC;IACzD,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AACD,MAAM,WAAW,+BACf,SAAQ,0BAA0B;CAAG;AACvC,MAAM,WAAW,0BAA2B,SAAQ,oBAAoB;IACtE,EAAE,EAAE,IAAI,GAAG,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,gBAAgB,CAAC,EAAE,2BAA2B,CAAC;IAC/C,WAAW,CAAC,EAAE,qBAAqB,GAAG,2BAA2B,CAAC;IAClE,UAAU,CAAC,EAAE,8BAA8B,GAAG,0BAA0B,CAAC;IACzE,QAAQ,CAAC,EAAE,kBAAkB,GAAG,wBAAwB,CAAC;IACzD,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AACD,MAAM,WAAW,gCAAiC,SAAQ,oBAAoB;IAC5E,EAAE,EAAE,IAAI,GAAG,MAAM,CAAC;CACnB;AACD,MAAM,WAAW,gCAAiC,SAAQ,oBAAoB;IAC5E,EAAE,EAAE,IAAI,GAAG,MAAM,CAAC;CACnB;AACD,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE,EAAE,EAAE,IAAI,GAAG,MAAM,CAAC;CACnB;AACD,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,EAAE,EAAE,IAAI,GAAG,MAAM,CAAC;CACnB;AACD,MAAM,WAAW,4BAA6B,SAAQ,oBAAoB;IACxE,EAAE,EAAE,IAAI,GAAG,MAAM,CAAC;IAClB,OAAO,EAAE,IAAI,GAAG,MAAM,CAAC;CACxB;AAGD,MAAM,WAAW,8BAA8B;IAC7C,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AACD,MAAM,WAAW,0BAA0B;CAAG;AAC9C,MAAM,WAAW,qBAAqB;IACpC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AACD,MAAM,WAAW,2BAA2B;CAAG;AAC/C,MAAM,WAAW,kBAAkB;IACjC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AACD,MAAM,WAAW,wBAAwB;CAAG;AAE5C,KAAK,uBAAuB,GACxB,wBAAwB,GACxB,yBAAyB,GACzB,0BAA0B,GAC1B,+BAA+B,GAC/B,0BAA0B,GAC1B,gCAAgC,GAChC,gCAAgC,GAChC,yBAAyB,GACzB,wBAAwB,GACxB,4BAA4B,CAAC;AAGjC,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,oBAAoB,EAC9B,CAAC,SAAS,uBAAuB,EACjC,EAAE,SAAS,kBAAkB,GAAG,SAAS,IACvC;IACF,IAAI,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;CAC1B,GAAG,CAAC,SAAS,SAAS,MAAM,CAAC,GAAG;IAAE,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;CAAE,GAAG,EAAE,CAAC,GAClE,CAAC,CAAC,SAAS,OAAO,GAAG;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GAAG,EAAE,CAAC,CAAC;AAG/C,KAAK,QAAQ,CACX,CAAC,SAAS,oBAAoB,EAC9B,CAAC,SAAS,uBAAuB,EACjC,EAAE,SAAS,cAAc,GAAG,SAAS,IACnC,CAAC,SAAS,MAAM,GAChB,cAAc,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAClC,CAAC,SAAS,OAAO,GACjB,cAAc,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,GACpC,CAAC,SAAS,QAAQ,GAClB,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC,GACvB,CAAC,SAAS,aAAa,GACvB,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC,GACvB,CAAC,SAAS,QAAQ,GAClB,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC,GACvB,CAAC,SAAS,cAAc,GACxB,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC,GACvB,CAAC,SAAS,cAAc,GACxB,IAAI,CAAC,UAAU,EAAE,IAAI,GAAG,MAAM,CAAC,GAC/B,CAAC,SAAS,OAAO,GACjB,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC,GACvB,CAAC,SAAS,MAAM,GAChB,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC,GACvB,CAAC,SAAS,UAAU,GACpB,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC,GACvB,KAAK,CAAC;AAEV,KAAK,gBAAgB,CAAC,CAAC,SAAS,uBAAuB,EAAE,EAAE,IAAI,EAAE,SAAS;IACxE,MAAM,EAAE,IAAI,CAAC;CACd,GACG,cAAc,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAClC,EAAE,SAAS;IAAE,MAAM,EAAE,KAAK,CAAA;CAAE,GAC5B,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,GACtD,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;AAE3D,KAAK,eAAe,CAAC,CAAC,SAAS,uBAAuB,IACpD,SAAS,SAAS,MAAM,CAAC,GACrB,CAAC,CAAC,SAAS,CAAC,SAAS,8BAA8B,EAAE,GACnD,IAAI,GACJ,KAAK,GACP,KAAK,CAAC;AAEZ,KAAK,YAAY,CAAC,CAAC,SAAS,uBAAuB,IAAI,SAAS,SAAS,MAAM,CAAC,GAC5E,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,mBAAmB,CAAC,EAAE,GAChD,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAChD,KAAK,GACP,KAAK,CAAC"}
1
+ {"version":3,"file":"ownListings.d.ts","sourceRoot":"","sources":["../../../../src/types/marketplace/ownListings.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACL,OAAO,EACP,YAAY,EACZ,kBAAkB,EAClB,MAAM,EACN,KAAK,EACL,YAAY,EACZ,mBAAmB,EACnB,IAAI,EACL,MAAM,eAAe,CAAC;AACvB,OAAO,EAAC,gBAAgB,EAAC,MAAM,oBAAoB,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,OAAO,GACP,iBAAiB,GACjB,WAAW,GACX,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAC5B,MAAM,GACN,OAAO,GACP,QAAQ,GACR,aAAa,GACb,QAAQ,GACR,cAAc,GACd,cAAc,GACd,OAAO,GACP,MAAM,GACN,UAAU,CAAC;AAEf;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACtC,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,sBAAsB,GACtB,+BAA+B,GAC/B,QAAQ,GACR,cAAc,CAAC;AAEnB;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,IAAI,CAAC;IACT,IAAI,EAAE,YAAY,CAAC;IACnB,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,EAAE,KAAK,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,EAAE,eAAe,CAAC;QACvB,OAAO,EAAE,OAAO,CAAC;QACjB,SAAS,EAAE,IAAI,CAAC;QAChB,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAC;QAC1C,UAAU,EAAE,oBAAoB,GAAG,0BAA0B,CAAC;QAC9D,WAAW,EAAE,qBAAqB,GAAG,2BAA2B,CAAC;QACjE,QAAQ,EAAE,kBAAkB,GAAG,wBAAwB,CAAC;KACzD,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,UAAU;IAC7D,aAAa,EAAE;QACb,WAAW,EAAE,YAAY,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;QAChD,MAAM,EAAE,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACtC,MAAM,EAAE,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACrC,YAAY,CAAC,EAAE,YAAY,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;KACpD,CAAC;CACH;AAED,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,OAAO,IAC9C,CAAC,SAAS,IAAI,GAAG,2BAA2B,GAAG,UAAU,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACxD,OAAO,CAAC,EAAE,8BAA8B,EAAE,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,oBAAoB,GAAG;IAAE,EAAE,EAAE,IAAI,GAAG,MAAM,CAAA;CAAE,CAAC;AACpF,MAAM,MAAM,yBAAyB,GAAG,oBAAoB,CAAC;AAE7D,MAAM,WAAW,0BAA2B,SAAQ,oBAAoB;IACtE,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC3C,UAAU,CAAC,EAAE,oBAAoB,GAAG,0BAA0B,CAAC;IAC/D,WAAW,CAAC,EAAE,qBAAqB,GAAG,2BAA2B,CAAC;IAClE,QAAQ,CAAC,EAAE,kBAAkB,GAAG,wBAAwB,CAAC;IACzD,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,MAAM,+BAA+B,GAAG,0BAA0B,CAAC;AAEzE,MAAM,WAAW,0BAA2B,SAAQ,oBAAoB;IACtE,EAAE,EAAE,IAAI,GAAG,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC3C,UAAU,CAAC,EAAE,oBAAoB,GAAG,0BAA0B,CAAC;IAC/D,WAAW,CAAC,EAAE,qBAAqB,GAAG,2BAA2B,CAAC;IAClE,QAAQ,CAAC,EAAE,kBAAkB,GAAG,wBAAwB,CAAC;IACzD,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,MAAM,gCAAgC,GAAG,oBAAoB,GAAG;IAAE,EAAE,EAAE,IAAI,GAAG,MAAM,CAAA;CAAE,CAAC;AAC5F,MAAM,MAAM,gCAAgC,GAAG,oBAAoB,GAAG;IAAE,EAAE,EAAE,IAAI,GAAG,MAAM,CAAA;CAAE,CAAC;AAC5F,MAAM,MAAM,yBAAyB,GAAG,oBAAoB,GAAG;IAAE,EAAE,EAAE,IAAI,GAAG,MAAM,CAAA;CAAE,CAAC;AACrF,MAAM,MAAM,wBAAwB,GAAG,oBAAoB,GAAG;IAAE,EAAE,EAAE,IAAI,GAAG,MAAM,CAAA;CAAE,CAAC;AACpF,MAAM,MAAM,4BAA4B,GAAG,oBAAoB,GAAG;IAChE,EAAE,EAAE,IAAI,GAAG,MAAM,CAAC;IAClB,OAAO,EAAE,IAAI,GAAG,MAAM,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;AAED,MAAM,WAAW,0BAA2B,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAC1E;AAED,MAAM,WAAW,qBAAqB;IACpC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;AAED,MAAM,WAAW,2BAA4B,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAC3E;AAED,MAAM,WAAW,kBAAkB;IACjC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;AAED,MAAM,WAAW,wBAAyB,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CACxE;AAED;;GAEG;AACH,KAAK,uBAAuB,GACxB,wBAAwB,GACxB,yBAAyB,GACzB,0BAA0B,GAC1B,+BAA+B,GAC/B,0BAA0B,GAC1B,gCAAgC,GAChC,gCAAgC,GAChC,yBAAyB,GACzB,wBAAwB,GACxB,4BAA4B,CAAC;AAEjC;;GAEG;AACH,KAAK,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,OAAO,EAAE,MAAM,CAAC,SAAS,SAAS,8BAA8B,EAAE,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AAClH,KAAK,qBAAqB,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG,IAAI,CAAC;AAE3E,KAAK,iBAAiB,CAAC,CAAC,IACtB,UAAU,CAAC,CAAC,CAAC,SAAS,MAAM,MAAM,SAAS,8BAA8B,EAAE,GACvE,mBAAmB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,GACrC,KAAK,CAAC;AAGZ;;GAEG;AACH,KAAK,YAAY,CAAC,CAAC,EAAE,EAAE,SAAS,kBAAkB,GAAG,SAAS,IAC5D,EAAE,SAAS;IAAE,MAAM,EAAE,IAAI,CAAA;CAAE,GACvB,CAAC,GACD,EAAE,SAAS;IAAE,MAAM,EAAE,KAAK,CAAA;CAAE,GAC1B,IAAI,CAAC,CAAC,EAAE,YAAY,CAAC,GACrB,IAAI,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;AAE9B;;GAEG;AACH,KAAK,YAAY,CACf,CAAC,SAAS,oBAAoB,EAC9B,CAAC,SAAS,uBAAuB,EACjC,EAAE,SAAS,kBAAkB,GAAG,SAAS,IAEzC,CAAC,SAAS,MAAM,GAAG,QAAQ,GAAG,aAAa,GAAG,QAAQ,GAAG,cAAc,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GACnG,YAAY,CAAC,kBAAkB,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAC9D,CAAC,SAAS,OAAO,GACf,kBAAkB,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,EAAE,GAC9C,CAAC,SAAS,cAAc,GACtB,IAAI,CAAC,UAAU,EAAE,IAAI,GAAG,MAAM,CAAC,GAC/B,KAAK,CAAC;AAEhB;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,oBAAoB,EAC9B,CAAC,SAAS,uBAAuB,EACjC,EAAE,SAAS,kBAAkB,GAAG,SAAS,GAAG,SAAS,IACnD;IACF,IAAI,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;CAC9B,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG;IAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAA;CAAE,GAAG,EAAE,CAAC,GACnF,CAAC,CAAC,SAAS,OAAO,GAAG;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GAAG,EAAE,CAAC,CAAC"}
@@ -1,32 +1,55 @@
1
1
  /**
2
- * @fileoverview Type definitions for Password Reset functionality in the Sharetribe Marketplace API.
3
- * This file defines the structure of password reset parameters and responses for the API endpoints.
2
+ * @fileoverview Type definitions for Password Reset operations in the Sharetribe Marketplace API.
4
3
  */
5
4
  import { ApiParameter, ExtraParameterType, UUID } from "../sharetribe";
5
+ /**
6
+ * Available endpoints
7
+ */
6
8
  export type PasswordResetEndpoints = "request" | "reset";
9
+ /**
10
+ * Password reset resource (usually empty or minimal)
11
+ */
7
12
  export interface PasswordReset {
8
13
  id: UUID;
9
14
  type: "passwordReset";
10
- attributes?: unknown;
15
+ attributes?: Record<string, never>;
11
16
  }
17
+ /**
18
+ * Base request parameters
19
+ */
12
20
  export interface PasswordResetParameter extends ApiParameter {
13
21
  }
14
- export interface PasswordResetRequestParams extends PasswordResetParameter {
22
+ /**
23
+ * Request password reset (send email)
24
+ */
25
+ export interface PasswordResetRequestParameter extends PasswordResetParameter {
15
26
  email: string;
16
27
  }
17
- export interface PasswordResetResetParams extends PasswordResetParameter {
28
+ /**
29
+ * Complete password reset using token
30
+ */
31
+ export interface PasswordResetResetParameter extends PasswordResetParameter {
18
32
  email: string;
19
33
  passwordResetToken: string;
20
34
  newPassword: string;
21
35
  }
22
- type ExpandReturnType<EP> = EP extends {
36
+ /**
37
+ * Expand behavior
38
+ */
39
+ type ExpandResult<EP extends ExtraParameterType | undefined> = EP extends {
23
40
  expand: true;
24
41
  } ? PasswordReset : EP extends {
25
42
  expand: false;
26
43
  } ? Omit<PasswordReset, "attributes"> : Omit<PasswordReset, "attributes">;
27
- type DataType<E extends PasswordResetEndpoints, EP extends ExtraParameterType> = E extends "request" ? ExpandReturnType<EP> : E extends "reset" ? ExpandReturnType<EP> : never;
28
- export type PasswordResetResponse<E extends PasswordResetEndpoints, EP extends ExtraParameterType = undefined> = {
29
- data: DataType<E, EP>;
44
+ /**
45
+ * Response data per endpoint
46
+ */
47
+ type ResponseData<E extends PasswordResetEndpoints, EP extends ExtraParameterType | undefined> = E extends "request" | "reset" ? ExpandResult<EP> : never;
48
+ /**
49
+ * Final response type
50
+ */
51
+ export type PasswordResetResponse<E extends PasswordResetEndpoints, EP extends ExtraParameterType | undefined = undefined> = {
52
+ data: ResponseData<E, EP>;
30
53
  };
31
54
  export {};
32
55
  //# sourceMappingURL=passwordReset.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"passwordReset.d.ts","sourceRoot":"","sources":["../../../../src/types/marketplace/passwordReset.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAGvE,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,OAAO,CAAC;AAGzD,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,IAAI,CAAC;IACT,IAAI,EAAE,eAAe,CAAC;IACtB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAGD,MAAM,WAAW,sBAAuB,SAAQ,YAAY;CAAG;AAG/D,MAAM,WAAW,0BAA2B,SAAQ,sBAAsB;IACxE,KAAK,EAAE,MAAM,CAAC;CACf;AAGD,MAAM,WAAW,wBAAyB,SAAQ,sBAAsB;IACtE,KAAK,EAAE,MAAM,CAAC;IACd,kBAAkB,EAAE,MAAM,CAAC;IAC3B,WAAW,EAAE,MAAM,CAAC;CACrB;AAGD,KAAK,gBAAgB,CAAC,EAAE,IAAI,EAAE,SAAS;IAAE,MAAM,EAAE,IAAI,CAAA;CAAE,GACnD,aAAa,GACb,EAAE,SAAS;IAAE,MAAM,EAAE,KAAK,CAAA;CAAE,GAC5B,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,GACjC,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;AAEtC,KAAK,QAAQ,CACX,CAAC,SAAS,sBAAsB,EAChC,EAAE,SAAS,kBAAkB,IAC3B,CAAC,SAAS,SAAS,GACnB,gBAAgB,CAAC,EAAE,CAAC,GACpB,CAAC,SAAS,OAAO,GACjB,gBAAgB,CAAC,EAAE,CAAC,GACpB,KAAK,CAAC;AAGV,MAAM,MAAM,qBAAqB,CAC/B,CAAC,SAAS,sBAAsB,EAChC,EAAE,SAAS,kBAAkB,GAAG,SAAS,IACvC;IACF,IAAI,EAAE,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;CACvB,CAAC"}
1
+ {"version":3,"file":"passwordReset.d.ts","sourceRoot":"","sources":["../../../../src/types/marketplace/passwordReset.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAC,YAAY,EAAE,kBAAkB,EAAE,IAAI,EAAC,MAAM,eAAe,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,OAAO,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,IAAI,CAAC;IACT,IAAI,EAAE,eAAe,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,YAAY;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,sBAAsB;IAC3E,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,sBAAsB;IACzE,KAAK,EAAE,MAAM,CAAC;IACd,kBAAkB,EAAE,MAAM,CAAC;IAC3B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,KAAK,YAAY,CAAC,EAAE,SAAS,kBAAkB,GAAG,SAAS,IACzD,EAAE,SAAS;IAAE,MAAM,EAAE,IAAI,CAAA;CAAE,GACvB,aAAa,GACb,EAAE,SAAS;IAAE,MAAM,EAAE,KAAK,CAAA;CAAE,GAC1B,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,GACjC,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;AAE1C;;GAEG;AACH,KAAK,YAAY,CACf,CAAC,SAAS,sBAAsB,EAChC,EAAE,SAAS,kBAAkB,GAAG,SAAS,IACvC,CAAC,SAAS,SAAS,GAAG,OAAO,GAAG,YAAY,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,qBAAqB,CAC/B,CAAC,SAAS,sBAAsB,EAChC,EAAE,SAAS,kBAAkB,GAAG,SAAS,GAAG,SAAS,IACnD;IACF,IAAI,EAAE,YAAY,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;CAC3B,CAAC"}
@@ -1,38 +1,57 @@
1
1
  /**
2
- * @fileoverview Type definitions for Process Transitions functionality in the Sharetribe Marketplace API.
3
- * This file defines the structure of process transition parameters and responses for the API endpoints.
2
+ * @fileoverview Type definitions for Process Transitions in the Sharetribe Marketplace API.
4
3
  */
5
4
  import { ApiParameter, UUID } from "../sharetribe";
5
+ /**
6
+ * Available endpoints
7
+ */
6
8
  export type ProcessTransitionsEndpoints = "query";
7
- type Actors = "customer" | "provider" | "operator" | "system";
8
- type RequestTypes = "uuid" | "string" | "integer" | "timestamp" | "boolean" | "object" | "money" | ["lineItem"];
9
+ /**
10
+ * Actors that can trigger a transition
11
+ */
12
+ type Actor = "customer" | "provider" | "operator" | "system";
13
+ /**
14
+ * Supported parameter types in transition requests
15
+ */
16
+ type ParamType = "uuid" | "string" | "integer" | "timestamp" | "boolean" | "object" | "money" | ["lineItem"];
17
+ /**
18
+ * Process Transition resource
19
+ */
9
20
  export interface ProcessTransition {
10
21
  id: UUID;
11
22
  type: "processTransition";
12
23
  attributes: {
13
24
  name: string;
14
- actor: Actors[];
25
+ actor: Actor[];
15
26
  actions: string[];
16
27
  params: {
17
- req: {
18
- [key: string]: RequestTypes;
19
- };
20
- opt: {
21
- [key: string]: RequestTypes;
22
- } | null;
28
+ req: Record<string, ParamType>;
29
+ opt: Record<string, ParamType> | null;
23
30
  };
24
31
  };
25
32
  }
33
+ /**
34
+ * Base request parameters
35
+ */
26
36
  export interface ProcessTransitionsParameter extends ApiParameter {
27
37
  }
38
+ /**
39
+ * Query parameters
40
+ */
28
41
  export interface ProcessTransitionsQueryParameter extends ProcessTransitionsParameter {
29
42
  processAlias?: string;
30
43
  lastTransition?: string;
31
44
  transactionId?: UUID | string;
32
45
  }
33
- type DataType<E extends ProcessTransitionsEndpoints> = E extends "query" ? ProcessTransition : never;
34
- export type ProcessTransitionsResponse<E extends ProcessTransitionsEndpoints> = {
35
- data: DataType<E>;
46
+ /**
47
+ * Response data per endpoint
48
+ */
49
+ type ResponseData<E extends ProcessTransitionsEndpoints> = E extends "query" ? ProcessTransition[] : never;
50
+ /**
51
+ * Final response type
52
+ */
53
+ export type ProcessTransitionsResponse<E extends ProcessTransitionsEndpoints = "query"> = {
54
+ data: ResponseData<E>;
36
55
  };
37
56
  export {};
38
57
  //# sourceMappingURL=processTransitions.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"processTransitions.d.ts","sourceRoot":"","sources":["../../../../src/types/marketplace/processTransitions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAGnD,MAAM,MAAM,2BAA2B,GAAG,OAAO,CAAC;AAGlD,KAAK,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,CAAC;AAG9D,KAAK,YAAY,GACb,MAAM,GACN,QAAQ,GACR,SAAS,GACT,WAAW,GACX,SAAS,GACT,QAAQ,GACR,OAAO,GACP,CAAC,UAAU,CAAC,CAAC;AAGjB,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,IAAI,CAAC;IACT,IAAI,EAAE,mBAAmB,CAAC;IAC1B,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,OAAO,EAAE,MAAM,EAAE,CAAC;QAClB,MAAM,EAAE;YACN,GAAG,EAAE;gBACH,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAC;aAC7B,CAAC;YACF,GAAG,EAAE;gBACH,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAC;aAC7B,GAAG,IAAI,CAAC;SACV,CAAC;KACH,CAAC;CACH;AAGD,MAAM,WAAW,2BAA4B,SAAQ,YAAY;CAAG;AAGpE,MAAM,WAAW,gCACf,SAAQ,2BAA2B;IACnC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;CAC/B;AAGD,KAAK,QAAQ,CAAC,CAAC,SAAS,2BAA2B,IAAI,CAAC,SAAS,OAAO,GACpE,iBAAiB,GACjB,KAAK,CAAC;AAGV,MAAM,MAAM,0BAA0B,CAAC,CAAC,SAAS,2BAA2B,IAC1E;IACE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"processTransitions.d.ts","sourceRoot":"","sources":["../../../../src/types/marketplace/processTransitions.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAC,YAAY,EAAE,IAAI,EAAC,MAAM,eAAe,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,OAAO,CAAC;AAElD;;GAEG;AACH,KAAK,KAAK,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,CAAC;AAE7D;;GAEG;AACH,KAAK,SAAS,GACV,MAAM,GACN,QAAQ,GACR,SAAS,GACT,WAAW,GACX,SAAS,GACT,QAAQ,GACR,OAAO,GACP,CAAC,UAAU,CAAC,CAAC;AAEjB;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,IAAI,CAAC;IACT,IAAI,EAAE,mBAAmB,CAAC;IAC1B,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,KAAK,EAAE,CAAC;QACf,OAAO,EAAE,MAAM,EAAE,CAAC;QAClB,MAAM,EAAE;YACN,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAC/B,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC;SACvC,CAAC;KACH,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,YAAY;CAChE;AAED;;GAEG;AACH,MAAM,WAAW,gCACf,SAAQ,2BAA2B;IACnC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,KAAK,YAAY,CAAC,CAAC,SAAS,2BAA2B,IACrD,CAAC,SAAS,OAAO,GAAG,iBAAiB,EAAE,GAAG,KAAK,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,0BAA0B,CACpC,CAAC,SAAS,2BAA2B,GAAG,OAAO,IAC7C;IACF,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;CACvB,CAAC"}
@@ -1,58 +1,107 @@
1
1
  /**
2
- * @fileoverview Type definitions for Reviews functionality in the Sharetribe Marketplace API.
3
- * This file defines the structure of review parameters and responses for the API endpoints.
2
+ * @fileoverview Type definitions for Reviews in the Sharetribe Marketplace API.
3
+ */
4
+ import { ApiMeta, ApiParameter, ExtraParameterType, Relationship, RelationshipTypeMap, UUID } from "../sharetribe";
5
+ /**
6
+ * Available endpoints
4
7
  */
5
- import { ApiMeta, ApiParameter, ExtraParameter, UUID, Relationship, RelationshipTypeMap, ExtraParameterType } from "../sharetribe";
6
8
  export type ReviewsEndpoints = "show" | "query";
9
+ /**
10
+ * Relationship fields that can be included
11
+ */
7
12
  export type ReviewsRelationshipsFields = "author" | "author.profileImage" | "author.marketplace" | "author.stripeAccount" | "author.effectivePermissionSet" | "listing" | "listing.marketplace" | "listing.author" | "listing.images" | "listing.currentStock" | "subject" | "subject.profileImage" | "subject.marketplace" | "subject.stripeAccount" | "subject.effectivePermissionSet";
8
- export type ReviewTypes = "ofProvider" | "ofCustomer";
9
- export type ReviewStates = "public" | "pending";
13
+ /**
14
+ * Review types and states
15
+ */
16
+ export type ReviewType = "ofProvider" | "ofCustomer";
17
+ export type ReviewState = "public" | "pending";
18
+ /**
19
+ * Review resource
20
+ */
10
21
  export interface Review {
11
22
  id: UUID;
12
- type: "reviews";
23
+ type: "review";
13
24
  attributes: {
14
- type: 'ofProvider' | 'ofCustomer';
15
- state: "public" | "pending";
25
+ type: ReviewType;
26
+ state: ReviewState;
16
27
  rating: number;
17
28
  content: string;
18
29
  createdAt: Date;
19
30
  deleted: boolean;
20
31
  };
21
32
  }
33
+ /**
34
+ * With relationships
35
+ */
22
36
  export interface ReviewWithRelationships extends Review {
23
37
  relationships: {
24
- user?: Relationship<false, "user">;
38
+ author: Relationship<false, "author">;
25
39
  listing?: Relationship<false, "listing">;
26
- subject?: Relationship<false, "user">;
40
+ subject: Relationship<false, "subject">;
27
41
  };
28
42
  }
29
- export type ReviewType<R extends boolean> = R extends true ? ReviewWithRelationships : Review;
43
+ /**
44
+ * Select type based on include
45
+ */
46
+ export type ReviewResource<R extends boolean> = R extends true ? ReviewWithRelationships : Review;
47
+ /**
48
+ * Base request parameters
49
+ */
30
50
  export interface ReviewsParameter extends ApiParameter {
31
51
  include?: ReviewsRelationshipsFields[];
32
52
  }
53
+ /**
54
+ * Show endpoint
55
+ */
33
56
  export interface ReviewsShowParameter extends ReviewsParameter {
34
57
  id: UUID | string;
35
58
  }
59
+ /**
60
+ * Query endpoint
61
+ */
36
62
  export interface ReviewsQueryParameter extends ReviewsParameter {
37
63
  transactionId?: UUID | string;
38
64
  listingId?: UUID | string;
39
65
  subjectId?: UUID | string;
40
- type?: ReviewTypes;
41
- state?: ReviewStates;
66
+ type?: ReviewType;
67
+ state?: ReviewState;
42
68
  }
69
+ /**
70
+ * All parameter types
71
+ */
43
72
  type AllReviewsParameter = ReviewsShowParameter | ReviewsQueryParameter;
44
- type ReviewsType<P extends AllReviewsParameter> = "include" extends keyof P ? P["include"] extends ReviewsRelationshipsFields[] ? true : false : false;
45
- type IncludedType<P extends AllReviewsParameter> = "include" extends keyof P ? P["include"] extends (keyof RelationshipTypeMap)[] ? Array<RelationshipTypeMap[P["include"][number]]> : never : never;
46
- type ExpandReturnType<P extends AllReviewsParameter, EP> = EP extends {
73
+ /**
74
+ * Detect include fixed for TS2536
75
+ */
76
+ type HasInclude<P> = P extends {
77
+ include: infer I extends readonly ReviewsRelationshipsFields[];
78
+ } ? I : never;
79
+ type IncludesRelationships<P> = HasInclude<P> extends never ? false : true;
80
+ /**
81
+ * Included resources — bulletproof
82
+ */
83
+ type IncludedResources<P> = P extends {
84
+ include: infer I extends readonly ReviewsRelationshipsFields[];
85
+ } ? RelationshipTypeMap[I[number]][] : never;
86
+ /**
87
+ * Expand behavior
88
+ */
89
+ type ExpandResult<T, EP extends ExtraParameterType | undefined> = EP extends {
47
90
  expand: true;
48
- } ? ReviewType<ReviewsType<P>> : EP extends {
91
+ } ? T : EP extends {
49
92
  expand: false;
50
- } ? Omit<ReviewType<ReviewsType<P>>, "attributes"> : Omit<ReviewType<ReviewsType<P>>, "attributes">;
51
- type DataType<E extends ReviewsEndpoints, P extends AllReviewsParameter, EP extends ExtraParameter | undefined> = E extends "query" ? ReviewType<ReviewsType<P>>[] : E extends "show" ? ExpandReturnType<P, EP> : never;
52
- export type ReviewsResponse<E extends ReviewsEndpoints, P extends AllReviewsParameter, EP extends ExtraParameterType = undefined> = {
53
- data: DataType<E, P, EP>;
54
- } & ("include" extends keyof P ? {
55
- included: IncludedType<P>;
93
+ } ? Omit<T, "attributes"> : Omit<T, "attributes">;
94
+ /**
95
+ * Response data per endpoint
96
+ */
97
+ type ResponseData<E extends ReviewsEndpoints, P extends AllReviewsParameter, EP extends ExtraParameterType | undefined> = E extends "query" ? ReviewResource<IncludesRelationships<P>>[] : E extends "show" ? ExpandResult<ReviewResource<IncludesRelationships<P>>, EP> : never;
98
+ /**
99
+ * Final response type
100
+ */
101
+ export type ReviewsResponse<E extends ReviewsEndpoints, P extends AllReviewsParameter, EP extends ExtraParameterType | undefined = undefined> = {
102
+ data: ResponseData<E, P, EP>;
103
+ } & (IncludesRelationships<P> extends true ? {
104
+ included: IncludedResources<P>;
56
105
  } : {}) & (E extends "query" ? {
57
106
  meta: ApiMeta;
58
107
  } : {});
@@ -1 +1 @@
1
- {"version":3,"file":"reviews.d.ts","sourceRoot":"","sources":["../../../../src/types/marketplace/reviews.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,OAAO,EACP,YAAY,EACZ,cAAc,EACd,IAAI,EACJ,YAAY,EACZ,mBAAmB,EACnB,kBAAkB,EACnB,MAAM,eAAe,CAAC;AAGvB,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,OAAO,CAAC;AAGhD,MAAM,MAAM,0BAA0B,GAClC,QAAQ,GACR,qBAAqB,GACrB,oBAAoB,GACpB,sBAAsB,GACtB,+BAA+B,GAC/B,SAAS,GACT,qBAAqB,GACrB,gBAAgB,GAChB,gBAAgB,GAChB,sBAAsB,GACtB,SAAS,GACT,sBAAsB,GACtB,qBAAqB,GACrB,uBAAuB,GACvB,gCAAgC,CAAC;AAGrC,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,YAAY,CAAC;AACtD,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,SAAS,CAAC;AAGhD,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,IAAI,CAAC;IACT,IAAI,EAAE,SAAS,CAAC;IAChB,UAAU,EAAE;QACV,IAAI,EAAE,YAAY,GAAG,YAAY,CAAC;QAClC,KAAK,EAAE,QAAQ,GAAG,SAAS,CAAC;QAC5B,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,IAAI,CAAC;QAChB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAGD,MAAM,WAAW,uBAAwB,SAAQ,MAAM;IACrD,aAAa,EAAE;QACb,IAAI,CAAC,EAAE,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACnC,OAAO,CAAC,EAAE,YAAY,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACzC,OAAO,CAAC,EAAE,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;KACvC,CAAC;CACH;AAGD,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,OAAO,IAAI,CAAC,SAAS,IAAI,GACtD,uBAAuB,GACvB,MAAM,CAAC;AAGX,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD,OAAO,CAAC,EAAE,0BAA0B,EAAE,CAAC;CACxC;AAGD,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D,EAAE,EAAE,IAAI,GAAG,MAAM,CAAC;CACnB;AAGD,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,aAAa,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IAC9B,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IAC1B,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IAC1B,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,KAAK,CAAC,EAAE,YAAY,CAAC;CACtB;AAGD,KAAK,mBAAmB,GAAG,oBAAoB,GAAG,qBAAqB,CAAC;AAGxE,KAAK,WAAW,CAAC,CAAC,SAAS,mBAAmB,IAAI,SAAS,SAAS,MAAM,CAAC,GACvE,CAAC,CAAC,SAAS,CAAC,SAAS,0BAA0B,EAAE,GAC/C,IAAI,GACJ,KAAK,GACP,KAAK,CAAC;AAGV,KAAK,YAAY,CAAC,CAAC,SAAS,mBAAmB,IAAI,SAAS,SAAS,MAAM,CAAC,GACxE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,mBAAmB,CAAC,EAAE,GAChD,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAChD,KAAK,GACP,KAAK,CAAC;AAGV,KAAK,gBAAgB,CAAC,CAAC,SAAS,mBAAmB,EAAE,EAAE,IAAI,EAAE,SAAS;IACpE,MAAM,EAAE,IAAI,CAAC;CACd,GACG,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAC1B,EAAE,SAAS;IAAE,MAAM,EAAE,KAAK,CAAA;CAAE,GAC5B,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,GAC9C,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;AAGnD,KAAK,QAAQ,CACX,CAAC,SAAS,gBAAgB,EAC1B,CAAC,SAAS,mBAAmB,EAC7B,EAAE,SAAS,cAAc,GAAG,SAAS,IACnC,CAAC,SAAS,OAAO,GACjB,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,GAC5B,CAAC,SAAS,MAAM,GAChB,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC,GACvB,KAAK,CAAC;AAGV,MAAM,MAAM,eAAe,CACzB,CAAC,SAAS,gBAAgB,EAC1B,CAAC,SAAS,mBAAmB,EAC7B,EAAE,SAAS,kBAAkB,GAAG,SAAS,IACvC;IACF,IAAI,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;CAC1B,GAAG,CAAC,SAAS,SAAS,MAAM,CAAC,GAAG;IAAE,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;CAAE,GAAG,EAAE,CAAC,GAClE,CAAC,CAAC,SAAS,OAAO,GAAG;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GAAG,EAAE,CAAC,CAAC"}
1
+ {"version":3,"file":"reviews.d.ts","sourceRoot":"","sources":["../../../../src/types/marketplace/reviews.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAC,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAElH;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,OAAO,CAAC;AAEhD;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAClC,QAAQ,GACR,qBAAqB,GACrB,oBAAoB,GACpB,sBAAsB,GACtB,+BAA+B,GAC/B,SAAS,GACT,qBAAqB,GACrB,gBAAgB,GAChB,gBAAgB,GAChB,sBAAsB,GACtB,SAAS,GACT,sBAAsB,GACtB,qBAAqB,GACrB,uBAAuB,GACvB,gCAAgC,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,YAAY,GAAG,YAAY,CAAC;AACrD,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE/C;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,IAAI,CAAC;IACT,IAAI,EAAE,QAAQ,CAAC;IACf,UAAU,EAAE;QACV,IAAI,EAAE,UAAU,CAAC;QACjB,KAAK,EAAE,WAAW,CAAC;QACnB,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,IAAI,CAAC;QAChB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,MAAM;IACrD,aAAa,EAAE;QACb,MAAM,EAAE,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACtC,OAAO,CAAC,EAAE,YAAY,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACzC,OAAO,EAAE,YAAY,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;KACzC,CAAC;CACH;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,OAAO,IAC1C,CAAC,SAAS,IAAI,GAAG,uBAAuB,GAAG,MAAM,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD,OAAO,CAAC,EAAE,0BAA0B,EAAE,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D,EAAE,EAAE,IAAI,GAAG,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,aAAa,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IAC9B,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IAC1B,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IAC1B,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED;;GAEG;AACH,KAAK,mBAAmB,GAAG,oBAAoB,GAAG,qBAAqB,CAAC;AAExE;;GAEG;AACH,KAAK,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,OAAO,EAAE,MAAM,CAAC,SAAS,SAAS,0BAA0B,EAAE,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AAC9G,KAAK,qBAAqB,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG,IAAI,CAAC;AAE3E;;GAEG;AACH,KAAK,iBAAiB,CAAC,CAAC,IACtB,CAAC,SAAS;IAAE,OAAO,EAAE,MAAM,CAAC,SAAS,SAAS,0BAA0B,EAAE,CAAA;CAAE,GACxE,mBAAmB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAChC,KAAK,CAAC;AAEZ;;GAEG;AACH,KAAK,YAAY,CAAC,CAAC,EAAE,EAAE,SAAS,kBAAkB,GAAG,SAAS,IAC5D,EAAE,SAAS;IAAE,MAAM,EAAE,IAAI,CAAA;CAAE,GACvB,CAAC,GACD,EAAE,SAAS;IAAE,MAAM,EAAE,KAAK,CAAA;CAAE,GAC1B,IAAI,CAAC,CAAC,EAAE,YAAY,CAAC,GACrB,IAAI,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;AAE9B;;GAEG;AACH,KAAK,YAAY,CACf,CAAC,SAAS,gBAAgB,EAC1B,CAAC,SAAS,mBAAmB,EAC7B,EAAE,SAAS,kBAAkB,GAAG,SAAS,IAEzC,CAAC,SAAS,OAAO,GACb,cAAc,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,EAAE,GAC1C,CAAC,SAAS,MAAM,GACd,YAAY,CAAC,cAAc,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAC1D,KAAK,CAAC;AAEd;;GAEG;AACH,MAAM,MAAM,eAAe,CACzB,CAAC,SAAS,gBAAgB,EAC1B,CAAC,SAAS,mBAAmB,EAC7B,EAAE,SAAS,kBAAkB,GAAG,SAAS,GAAG,SAAS,IACnD;IACF,IAAI,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;CAC9B,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG;IAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAA;CAAE,GAAG,EAAE,CAAC,GACnF,CAAC,CAAC,SAAS,OAAO,GAAG;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GAAG,EAAE,CAAC,CAAC"}
@@ -0,0 +1,48 @@
1
+ /**
2
+ * @fileoverview Type definitions for SitemapData in the Sharetribe Marketplace API.
3
+ *
4
+ * The sitemap_data endpoints provide data for generating XML sitemaps:
5
+ * - queryListings: Returns up to 10,000 most recent public listings
6
+ * - queryAssets: Returns CMS pages/assets created in Console
7
+ *
8
+ * @see https://www.sharetribe.com/docs/concepts/sitemap-in-sharetribe/
9
+ */
10
+ import { ApiMeta, UUID } from "../sharetribe";
11
+ /**
12
+ * Minimal listing data for sitemap generation
13
+ */
14
+ export interface SitemapListing {
15
+ id: UUID;
16
+ type: "listing";
17
+ }
18
+ /**
19
+ * CMS asset data for sitemap generation
20
+ */
21
+ export interface SitemapAsset {
22
+ id: UUID;
23
+ type: "asset";
24
+ attributes: {
25
+ assetPath: string;
26
+ };
27
+ }
28
+ /**
29
+ * Response from sitemap_data/query_listings
30
+ *
31
+ * Returns up to 10,000 most recent public listings.
32
+ * Results are cached for 1 day.
33
+ */
34
+ export interface SitemapListingsResponse {
35
+ data: SitemapListing[];
36
+ meta: ApiMeta;
37
+ }
38
+ /**
39
+ * Response from sitemap_data/query_assets
40
+ *
41
+ * Returns CMS pages created in Console.
42
+ * Excludes pages with built-in/custom paths.
43
+ */
44
+ export interface SitemapAssetsResponse {
45
+ data: SitemapAsset[];
46
+ meta: ApiMeta;
47
+ }
48
+ //# sourceMappingURL=sitemapData.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sitemapData.d.ts","sourceRoot":"","sources":["../../../../src/types/marketplace/sitemapData.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAC,OAAO,EAAE,IAAI,EAAC,MAAM,eAAe,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,IAAI,CAAC;IACT,IAAI,EAAE,SAAS,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,IAAI,CAAC;IACT,IAAI,EAAE,OAAO,CAAC;IACd,UAAU,EAAE;QACV,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,cAAc,EAAE,CAAC;IACvB,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,YAAY,EAAE,CAAC;IACrB,IAAI,EAAE,OAAO,CAAC;CACf"}