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

package/dist/types/marketplace/ownListings.d.ts

@@ -0,0 +1,155 @@
+/**
+ * @fileoverview Type definitions for Own Listings in the Sharetribe Marketplace API.
+ */
+import { ApiMeta, ApiParameter, ExtraParameterType, LatLng, Money, Relationship, RelationshipTypeMap, UUID } from "../sharetribe";
+import { AvailabilityPlan } from "./availabilityPlan";
+/**
+ * Listing states
+ */
+export type OwnListingState = "draft" | "pendingApproval" | "published" | "closed";
+/**
+ * Available endpoints
+ */
+export type OwnListingsEndpoints = "show" | "query" | "create" | "createDraft" | "update" | "publishDraft" | "discardDraft" | "close" | "open" | "addImage";
+/**
+ * Relationship fields
+ */
+export type OwnListingsRelationshipsFields = "marketplace" | "author.profileImage" | "author.marketplace" | "author.stripeAccount" | "author.effectivePermissionSet" | "images" | "currentStock";
+/**
+ * Own Listing resource
+ */
+export interface OwnListing {
+    id: UUID;
+    type: "ownListing";
+    attributes: {
+        title: string;
+        description: string;
+        price: Money;
+        geolocation: LatLng;
+        state: OwnListingState;
+        deleted: boolean;
+        createdAt: Date;
+        availabilityPlan: AvailabilityPlan | null;
+        publicData: OwnListingPublicData & OwnListingCustomPublicData;
+        privateData: OwnListingPrivateData & OwnListingCustomPrivateData;
+        metadata: OwnListingMetadata & OwnListingCustomMetadata;
+    };
+}
+/**
+ * With relationships
+ */
+export interface OwnListingWithRelationships extends OwnListing {
+    relationships: {
+        marketplace: Relationship<false, "marketplace">;
+        author: Relationship<false, "author">;
+        images: Relationship<true, "images">;
+        currentStock?: Relationship<false, "currentStock">;
+    };
+}
+export type OwnListingResource<R extends boolean> = R extends true ? OwnListingWithRelationships : OwnListing;
+/**
+ * Base request parameters
+ */
+export interface OwnListingsParameter extends ApiParameter {
+    include?: OwnListingsRelationshipsFields[];
+}
+/**
+ * Endpoint-specific parameters
+ */
+export type OwnListingsShowParameter = OwnListingsParameter & {
+    id: UUID | string;
+};
+export type OwnListingsQueryParameter = OwnListingsParameter;
+export interface OwnListingsCreateParameter extends OwnListingsParameter {
+    title: string;
+    description?: string;
+    price?: Money;
+    geolocation?: LatLng;
+    availabilityPlan?: AvailabilityPlan | null;
+    publicData?: OwnListingPublicData & OwnListingCustomPublicData;
+    privateData?: OwnListingPrivateData & OwnListingCustomPrivateData;
+    metadata?: OwnListingMetadata & OwnListingCustomMetadata;
+    images?: string[];
+}
+export type OwnListingsCreateDraftParameter = OwnListingsCreateParameter;
+export interface OwnListingsUpdateParameter extends OwnListingsParameter {
+    id: UUID | string;
+    title?: string;
+    description?: string;
+    price?: Money;
+    geolocation?: LatLng;
+    availabilityPlan?: AvailabilityPlan | null;
+    publicData?: OwnListingPublicData & OwnListingCustomPublicData;
+    privateData?: OwnListingPrivateData & OwnListingCustomPrivateData;
+    metadata?: OwnListingMetadata & OwnListingCustomMetadata;
+    images?: string[];
+}
+export type OwnListingsPublishDraftParameter = OwnListingsParameter & {
+    id: UUID | string;
+};
+export type OwnListingsDiscardDraftParameter = OwnListingsParameter & {
+    id: UUID | string;
+};
+export type OwnListingsCloseParameter = OwnListingsParameter & {
+    id: UUID | string;
+};
+export type OwnListingsOpenParameter = OwnListingsParameter & {
+    id: UUID | string;
+};
+export type OwnListingsAddImageParameter = OwnListingsParameter & {
+    id: UUID | string;
+    imageId: UUID | string;
+};
+/**
+ * Custom data
+ */
+export interface OwnListingPublicData {
+    [key: string]: any;
+}
+export interface OwnListingCustomPublicData extends Record<string, unknown> {
+}
+export interface OwnListingPrivateData {
+    [key: string]: any;
+}
+export interface OwnListingCustomPrivateData extends Record<string, unknown> {
+}
+export interface OwnListingMetadata {
+    [key: string]: any;
+}
+export interface OwnListingCustomMetadata extends Record<string, unknown> {
+}
+/**
+ * All parameter types
+ */
+type AllOwnListingsParameter = OwnListingsShowParameter | OwnListingsQueryParameter | OwnListingsCreateParameter | OwnListingsCreateDraftParameter | OwnListingsUpdateParameter | OwnListingsPublishDraftParameter | OwnListingsDiscardDraftParameter | OwnListingsCloseParameter | OwnListingsOpenParameter | OwnListingsAddImageParameter;
+/**
+ * Include detection — fixes TS2536
+ */
+type HasInclude<P> = P extends {
+    include: infer I extends readonly OwnListingsRelationshipsFields[];
+} ? I : never;
+type IncludesRelationships<P> = HasInclude<P> extends never ? false : true;
+type IncludedResources<P> = HasInclude<P> extends infer Fields extends OwnListingsRelationshipsFields[] ? RelationshipTypeMap[Fields[number]][] : never;
+/**
+ * Expand behavior
+ */
+type ExpandResult<T, EP extends ExtraParameterType | undefined> = EP extends {
+    expand: true;
+} ? T : EP extends {
+    expand: false;
+} ? Omit<T, "attributes"> : Omit<T, "attributes">;
+/**
+ * Response data per endpoint
+ */
+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;
+/**
+ * Final response
+ */
+export type OwnListingsResponse<E extends OwnListingsEndpoints, P extends AllOwnListingsParameter, EP extends ExtraParameterType | undefined = undefined> = {
+    data: ResponseData<E, P, EP>;
+} & (IncludesRelationships<P> extends true ? {
+    included: IncludedResources<P>;
+} : {}) & (E extends "query" ? {
+    meta: ApiMeta;
+} : {});
+export {};

package/dist/types/marketplace/passwordReset.d.ts

@@ -0,0 +1,54 @@
+/**
+ * @fileoverview Type definitions for Password Reset operations in the Sharetribe Marketplace API.
+ */
+import { ApiParameter, ExtraParameterType, UUID } from "../sharetribe";
+/**
+ * Available endpoints
+ */
+export type PasswordResetEndpoints = "request" | "reset";
+/**
+ * Password reset resource (usually empty or minimal)
+ */
+export interface PasswordReset {
+    id: UUID;
+    type: "passwordReset";
+    attributes?: Record<string, never>;
+}
+/**
+ * Base request parameters
+ */
+export interface PasswordResetParameter extends ApiParameter {
+}
+/**
+ * Request password reset (send email)
+ */
+export interface PasswordResetRequestParameter extends PasswordResetParameter {
+    email: string;
+}
+/**
+ * Complete password reset using token
+ */
+export interface PasswordResetResetParameter extends PasswordResetParameter {
+    email: string;
+    passwordResetToken: string;
+    newPassword: string;
+}
+/**
+ * Expand behavior
+ */
+type ExpandResult<EP extends ExtraParameterType | undefined> = EP extends {
+    expand: true;
+} ? PasswordReset : EP extends {
+    expand: false;
+} ? Omit<PasswordReset, "attributes"> : Omit<PasswordReset, "attributes">;
+/**
+ * Response data per endpoint
+ */
+type ResponseData<E extends PasswordResetEndpoints, EP extends ExtraParameterType | undefined> = E extends "request" | "reset" ? ExpandResult<EP> : never;
+/**
+ * Final response type
+ */
+export type PasswordResetResponse<E extends PasswordResetEndpoints, EP extends ExtraParameterType | undefined = undefined> = {
+    data: ResponseData<E, EP>;
+};
+export {};

package/dist/types/marketplace/processTransitions.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @fileoverview Type definitions for Process Transitions in the Sharetribe Marketplace API.
+ */
+import { ApiParameter, UUID } from "../sharetribe";
+/**
+ * Available endpoints
+ */
+export type ProcessTransitionsEndpoints = "query";
+/**
+ * Actors that can trigger a transition
+ */
+type Actor = "customer" | "provider" | "operator" | "system";
+/**
+ * Supported parameter types in transition requests
+ */
+type ParamType = "uuid" | "string" | "integer" | "timestamp" | "boolean" | "object" | "money" | ["lineItem"];
+/**
+ * Process Transition resource
+ */
+export interface ProcessTransition {
+    id: UUID;
+    type: "processTransition";
+    attributes: {
+        name: string;
+        actor: Actor[];
+        actions: string[];
+        params: {
+            req: Record<string, ParamType>;
+            opt: Record<string, ParamType> | null;
+        };
+    };
+}
+/**
+ * Base request parameters
+ */
+export interface ProcessTransitionsParameter extends ApiParameter {
+}
+/**
+ * Query parameters
+ */
+export interface ProcessTransitionsQueryParameter extends ProcessTransitionsParameter {
+    processAlias?: string;
+    lastTransition?: string;
+    transactionId?: UUID | string;
+}
+/**
+ * Response data per endpoint
+ */
+type ResponseData<E extends ProcessTransitionsEndpoints> = E extends "query" ? ProcessTransition[] : never;
+/**
+ * Final response type
+ */
+export type ProcessTransitionsResponse<E extends ProcessTransitionsEndpoints = "query"> = {
+    data: ResponseData<E>;
+};
+export {};

package/dist/types/marketplace/reviews.d.ts

@@ -0,0 +1,108 @@
+/**
+ * @fileoverview Type definitions for Reviews in the Sharetribe Marketplace API.
+ */
+import { ApiMeta, ApiParameter, ExtraParameterType, Relationship, RelationshipTypeMap, UUID } from "../sharetribe";
+/**
+ * Available endpoints
+ */
+export type ReviewsEndpoints = "show" | "query";
+/**
+ * Relationship fields that can be included
+ */
+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";
+/**
+ * Review types and states
+ */
+export type ReviewType = "ofProvider" | "ofCustomer";
+export type ReviewState = "public" | "pending";
+/**
+ * Review resource
+ */
+export interface Review {
+    id: UUID;
+    type: "review";
+    attributes: {
+        type: ReviewType;
+        state: ReviewState;
+        rating: number;
+        content: string;
+        createdAt: Date;
+        deleted: boolean;
+    };
+}
+/**
+ * With relationships
+ */
+export interface ReviewWithRelationships extends Review {
+    relationships: {
+        author: Relationship<false, "author">;
+        listing?: Relationship<false, "listing">;
+        subject: Relationship<false, "subject">;
+    };
+}
+/**
+ * Select type based on include
+ */
+export type ReviewResource<R extends boolean> = R extends true ? ReviewWithRelationships : Review;
+/**
+ * Base request parameters
+ */
+export interface ReviewsParameter extends ApiParameter {
+    include?: ReviewsRelationshipsFields[];
+}
+/**
+ * Show endpoint
+ */
+export interface ReviewsShowParameter extends ReviewsParameter {
+    id: UUID | string;
+}
+/**
+ * Query endpoint
+ */
+export interface ReviewsQueryParameter extends ReviewsParameter {
+    transactionId?: UUID | string;
+    listingId?: UUID | string;
+    subjectId?: UUID | string;
+    type?: ReviewType;
+    state?: ReviewState;
+}
+/**
+ * All parameter types
+ */
+type AllReviewsParameter = ReviewsShowParameter | ReviewsQueryParameter;
+/**
+ * Detect include — fixed for TS2536
+ */
+type HasInclude<P> = P extends {
+    include: infer I extends readonly ReviewsRelationshipsFields[];
+} ? I : never;
+type IncludesRelationships<P> = HasInclude<P> extends never ? false : true;
+/**
+ * Included resources — bulletproof
+ */
+type IncludedResources<P> = P extends {
+    include: infer I extends readonly ReviewsRelationshipsFields[];
+} ? RelationshipTypeMap[I[number]][] : never;
+/**
+ * Expand behavior
+ */
+type ExpandResult<T, EP extends ExtraParameterType | undefined> = EP extends {
+    expand: true;
+} ? T : EP extends {
+    expand: false;
+} ? Omit<T, "attributes"> : Omit<T, "attributes">;
+/**
+ * Response data per endpoint
+ */
+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;
+/**
+ * Final response type
+ */
+export type ReviewsResponse<E extends ReviewsEndpoints, P extends AllReviewsParameter, EP extends ExtraParameterType | undefined = undefined> = {
+    data: ResponseData<E, P, EP>;
+} & (IncludesRelationships<P> extends true ? {
+    included: IncludedResources<P>;
+} : {}) & (E extends "query" ? {
+    meta: ApiMeta;
+} : {});
+export {};

package/dist/types/marketplace/sitemapData.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @fileoverview Type definitions for SitemapData in the Sharetribe Marketplace API.
+ *
+ * The sitemap_data endpoints provide data for generating XML sitemaps:
+ * - queryListings: Returns up to 10,000 most recent public listings
+ * - queryAssets: Returns CMS pages/assets created in Console
+ *
+ * @see https://www.sharetribe.com/docs/concepts/sitemap-in-sharetribe/
+ */
+import { ApiMeta, UUID } from "../sharetribe";
+/**
+ * Minimal listing data for sitemap generation
+ */
+export interface SitemapListing {
+    id: UUID;
+    type: "listing";
+}
+/**
+ * CMS asset data for sitemap generation
+ */
+export interface SitemapAsset {
+    id: UUID;
+    type: "asset";
+    attributes: {
+        assetPath: string;
+    };
+}
+/**
+ * Response from sitemap_data/query_listings
+ *
+ * Returns up to 10,000 most recent public listings.
+ * Results are cached for 1 day.
+ */
+export interface SitemapListingsResponse {
+    data: SitemapListing[];
+    meta: ApiMeta;
+}
+/**
+ * Response from sitemap_data/query_assets
+ *
+ * Returns CMS pages created in Console.
+ * Excludes pages with built-in/custom paths.
+ */
+export interface SitemapAssetsResponse {
+    data: SitemapAsset[];
+    meta: ApiMeta;
+}

package/dist/types/marketplace/stock.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @fileoverview Type definitions for Stock operations in the Sharetribe Marketplace API.
+ */
+import { ExtraParameterType, UUID } from "../sharetribe";
+/**
+ * Available endpoints
+ */
+export type StockEndpoints = "compareAndSet";
+/**
+ * Stock resource
+ */
+export interface Stock {
+    id: UUID;
+    type: "stock";
+    attributes: {
+        quantity: number;
+    };
+}
+/**
+ * Parameters for compare-and-set operation
+ */
+export interface StockCompareAndSetParameter {
+    listingId: UUID | string;
+    oldTotal: number;
+    newTotal: number;
+}
+/**
+ * Expand behavior
+ */
+type ExpandResult<EP extends ExtraParameterType | undefined> = EP extends {
+    expand: true;
+} ? Stock : EP extends {
+    expand: false;
+} ? Omit<Stock, "attributes"> : Omit<Stock, "attributes">;
+/**
+ * Response data per endpoint
+ */
+type ResponseData<E extends StockEndpoints, EP extends ExtraParameterType | undefined> = E extends "compareAndSet" ? ExpandResult<EP> : never;
+/**
+ * Final response type
+ */
+export type StockResponse<E extends StockEndpoints = "compareAndSet", EP extends ExtraParameterType | undefined = undefined> = {
+    data: ResponseData<E, EP>;
+};
+export {};

package/dist/types/marketplace/stockAdjustment.d.ts

@@ -0,0 +1,97 @@
+/**
+ * @fileoverview Type definitions for Stock Adjustments in the Sharetribe Marketplace API.
+ */
+import { ApiMeta, ApiParameter, ExtraParameterType, Relationship, RelationshipTypeMap, UUID } from "../sharetribe";
+/**
+ * Available endpoints
+ */
+export type StockAdjustmentsEndpoints = "query" | "create" | "delete";
+/**
+ * Relationship fields that can be included
+ */
+export type StockAdjustmentsRelationshipsFields = "ownListing" | "ownListing.marketplace" | "ownListing.author" | "ownListing.images" | "ownListing.currentStock" | "stockReservation";
+/**
+ * Stock Adjustment resource
+ */
+export interface StockAdjustment {
+    id: UUID;
+    type: "stockAdjustment";
+    attributes: {
+        at: Date;
+        quantity: number;
+    };
+}
+/**
+ * With relationships
+ */
+export interface StockAdjustmentWithRelationships extends StockAdjustment {
+    relationships: {
+        ownListing: Relationship<false, "ownListing">;
+        stockReservation: Relationship<false, "stockReservation">;
+    };
+}
+/**
+ * Select type based on include
+ */
+export type StockAdjustmentType<R extends boolean> = R extends true ? StockAdjustmentWithRelationships : StockAdjustment;
+/**
+ * Base request parameters
+ */
+export interface StockAdjustmentsParameter extends ApiParameter {
+    include?: StockAdjustmentsRelationshipsFields[];
+}
+/**
+ * Query endpoint
+ */
+export interface StockAdjustmentsQueryParameter extends StockAdjustmentsParameter {
+    listingId: UUID | string;
+    start: Date | string;
+    end: Date | string;
+}
+/**
+ * Create endpoint
+ */
+export interface StockAdjustmentsCreateParameter extends StockAdjustmentsParameter {
+    listingId: UUID | string;
+    quantity: number;
+}
+/**
+ * All parameter types
+ */
+type AllStockAdjustmentsParameter = StockAdjustmentsQueryParameter | StockAdjustmentsCreateParameter;
+/**
+ * Detect include + fix TS2536
+ */
+type HasInclude<P> = P extends {
+    include: infer I extends readonly StockAdjustmentsRelationshipsFields[];
+} ? I : never;
+type IncludesRelationships<P> = HasInclude<P> extends never ? false : true;
+/**
+ * Included resources — bulletproof version (no TS2536)
+ */
+type IncludedResources<P> = P extends {
+    include: infer I extends readonly StockAdjustmentsRelationshipsFields[];
+} ? RelationshipTypeMap[I[number]][] : never;
+/**
+ * Expand behavior
+ */
+type ExpandResult<T, EP extends ExtraParameterType | undefined> = EP extends {
+    expand: true;
+} ? T : EP extends {
+    expand: false;
+} ? Omit<T, "attributes"> : Omit<T, "attributes">;
+/**
+ * Response data per endpoint
+ */
+type ResponseData<E extends StockAdjustmentsEndpoints, P extends AllStockAdjustmentsParameter, EP extends ExtraParameterType | undefined> = E extends "query" ? StockAdjustmentType<IncludesRelationships<P>>[] : E extends "create" ? ExpandResult<StockAdjustmentType<IncludesRelationships<P>>, EP> : E extends "delete" ? Pick<StockAdjustment, "id" | "type"> : never;
+/**
+ * Final response type
+ */
+export type StockAdjustmentsResponse<E extends StockAdjustmentsEndpoints, P extends AllStockAdjustmentsParameter, EP extends ExtraParameterType | undefined = undefined> = {
+    data: ResponseData<E, P, EP>;
+} & (IncludesRelationships<P> extends true ? {
+    included: IncludedResources<P>;
+} : {}) & (E extends "query" ? {
+    meta: ApiMeta;
+} : {});
+export {};

package/dist/types/marketplace/stockReservations.d.ts

@@ -0,0 +1,89 @@
+/**
+ * @fileoverview Type definitions for Stock Reservations in the Sharetribe Marketplace API.
+ */
+import { ApiParameter, ExtraParameterType, Relationship, RelationshipTypeMap, UUID } from "../sharetribe";
+/**
+ * Available endpoints
+ */
+export type StockReservationsEndpoints = "show";
+/**
+ * Relationship fields that can be included
+ */
+export type StockReservationsRelationshipsFields = "transaction" | "transaction.marketplace" | "transaction.listing" | "transaction.provider" | "transaction.customer" | "transaction.booking" | "transaction.stockReservation" | "transaction.reviews" | "transaction.messages";
+/**
+ * Possible reservation states
+ */
+export type StockReservationState = "pending" | "proposed" | "accepted" | "declined" | "cancelled";
+/**
+ * Stock Reservation resource
+ */
+export interface StockReservation {
+    id: UUID;
+    type: "stockReservation";
+    attributes: {
+        quantity: number;
+        state: StockReservationState;
+    };
+}
+/**
+ * With relationships
+ */
+export interface StockReservationWithRelationships extends StockReservation {
+    relationships: {
+        listing: Relationship<false, "listing">;
+        transaction: Relationship<false, "transaction">;
+        stockAdjustments: Relationship<true, "stockAdjustment">;
+    };
+}
+/**
+ * Select type based on include
+ */
+export type StockReservationType<R extends boolean> = R extends true ? StockReservationWithRelationships : StockReservation;
+/**
+ * Base request parameters
+ */
+export interface StockReservationParameter extends ApiParameter {
+    include?: StockReservationsRelationshipsFields[];
+}
+/**
+ * Show endpoint parameters
+ */
+export interface StockReservationShowParameter extends StockReservationParameter {
+    id: UUID | string;
+}
+/**
+ * All parameter types
+ */
+type AllStockReservationsParameter = StockReservationShowParameter;
+/**
+ * Detect include usage
+ */
+type HasInclude<P> = P extends {
+    include: infer I extends StockReservationsRelationshipsFields[];
+} ? I : never;
+type IncludesRelationships<P> = HasInclude<P> extends never ? false : true;
+/**
+ * Included resources — fixed version (no TS2536)
+ */
+type IncludedResources<P> = HasInclude<P> extends infer Fields extends StockReservationsRelationshipsFields[] ? RelationshipTypeMap[Fields[number]][] : never;
+/**
+ * Expand behavior
+ */
+type ExpandResult<T, EP extends ExtraParameterType | undefined> = EP extends {
+    expand: true;
+} ? T : EP extends {
+    expand: false;
+} ? Omit<T, "attributes"> : Omit<T, "attributes">;
+/**
+ * Response data
+ */
+type ResponseData<E extends StockReservationsEndpoints, P extends AllStockReservationsParameter, EP extends ExtraParameterType | undefined> = E extends "show" ? ExpandResult<StockReservationType<IncludesRelationships<P>>, EP> : never;
+/**
+ * Final response type
+ */
+export type StockReservationsResponse<E extends StockReservationsEndpoints = "show", P extends AllStockReservationsParameter = StockReservationShowParameter, EP extends ExtraParameterType | undefined = undefined> = {
+    data: ResponseData<E, P, EP>;
+} & (IncludesRelationships<P> extends true ? {
+    included: IncludedResources<P>;
+} : {});
+export {};