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

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

@@ -0,0 +1,202 @@
+/**
+ * @fileoverview Type definitions for Current User in the Sharetribe Marketplace API.
+ */
+import { ApiParameter, ExtraParameterType, Relationship, RelationshipTypeMap, UUID } from "../sharetribe";
+import { Permissions } from "./user";
+/**
+ * Available endpoints
+ */
+export type CurrentUserEndpoints = "show" | "delete" | "create" | "create_with_idp" | "update_profile" | "change_password" | "change_email" | "verify_email" | "send_verification_email";
+/**
+ * Relationship fields
+ */
+export type CurrentUserRelationshipsFields = "marketplace" | "profileImage" | "stripeAccount" | "stripeCustomer" | "stripeCustomer.defaultPaymentMethod" | "effectivePermissionSet";
+/**
+ * Current User resource
+ */
+export interface CurrentUser {
+    id: UUID;
+    type: "currentUser";
+    attributes: {
+        banned: boolean;
+        deleted: boolean;
+        createdAt: string;
+        email: string;
+        emailVerified: boolean;
+        pendingEmail: string | null;
+        stripeConnected: boolean;
+        stripePayoutsEnabled: boolean;
+        stripeChargesEnabled: boolean;
+        identityProviders: {
+            idpId: string;
+            userId: string;
+        }[];
+        profile: {
+            firstName: string;
+            lastName: string;
+            displayName: string;
+            abbreviatedName: string;
+            bio: string | null;
+            publicData: CurrentUserPublicData & CurrentUserCustomPublicData;
+            protectedData: CurrentUserProtectedData & CurrentUserCustomProtectedData;
+            privateData: CurrentUserPrivateData & CurrentUserCustomPrivateData;
+            metadata: CurrentUserMetadata & CurrentUserCustomMetadata;
+        };
+    };
+}
+/**
+ * Deleted user representation
+ */
+export type DeletedCurrentUser = {
+    id: UUID;
+    type: "currentUser";
+    attributes: {
+        banned: false;
+        deleted: true;
+        createdAt: null;
+        email: null;
+        emailVerified: false;
+        pendingEmail: null;
+        stripeConnected: false;
+        stripePayoutsEnabled: false;
+        stripeChargesEnabled: false;
+        identityProviders: null;
+        profile: {
+            firstName: null;
+            lastName: null;
+            displayName: null;
+            abbreviatedName: null;
+            bio: null;
+            publicData: null;
+            protectedData: null;
+            privateData: null;
+            metadata: null;
+        };
+    };
+};
+/**
+ * Current User permission set
+ */
+export type CurrentUserPermissionSet = {
+    postListings: Permissions;
+    initiateTransactions: Permissions;
+    read: Permissions;
+};
+/**
+ * With relationships
+ */
+export interface CurrentUserWithRelationships extends CurrentUser {
+    relationships: {
+        marketplace: Relationship<false, "marketplace">;
+        profileImage?: Relationship<false, "profileImage">;
+        stripeAccount?: Relationship<false, "stripeAccount">;
+        stripeCustomer?: Relationship<false, "stripeCustomer">;
+        effectivePermissionSet: Relationship<false, "effectivePermissionSet">;
+    };
+}
+export type CurrentUserResource<R extends boolean> = R extends true ? CurrentUserWithRelationships : CurrentUser;
+/**
+ * Base request parameters
+ */
+export interface CurrentUserParameter extends ApiParameter {
+    include?: CurrentUserRelationshipsFields[];
+}
+/**
+ * Endpoint parameters
+ */
+export type CurrentUserShowParameter = CurrentUserParameter;
+export type CurrentUserDeleteParameter = void;
+export type CurrentUserSendVerificationEmailParameter = void;
+export interface CurrentUserCreateParameter extends CurrentUserParameter {
+    email: string;
+    password: string;
+    firstName: string;
+    lastName: string;
+    displayName?: string;
+    bio?: string;
+    publicData?: CurrentUserPublicData & CurrentUserCustomPublicData;
+    protectedData?: CurrentUserProtectedData & CurrentUserCustomProtectedData;
+    privateData?: CurrentUserPrivateData & CurrentUserCustomPrivateData;
+}
+export interface CurrentUserCreateWithIdpParameter extends CurrentUserCreateParameter {
+    idpId: string;
+    idpClientId: string;
+    idpToken: string;
+}
+export interface CurrentUserUpdateProfileParameter extends CurrentUserParameter {
+    firstName?: string;
+    lastName?: string;
+    displayName?: string;
+    bio?: string | null;
+    publicData?: CurrentUserPublicData & CurrentUserCustomPublicData;
+    protectedData?: CurrentUserProtectedData & CurrentUserCustomProtectedData;
+    privateData?: CurrentUserPrivateData & CurrentUserCustomPrivateData;
+    profileImageId?: UUID | string;
+}
+export interface CurrentUserChangePasswordParameter {
+    currentPassword: string;
+    newPassword: string;
+}
+export interface CurrentUserChangeEmailParameter {
+    currentPassword: string;
+    email: string;
+}
+export interface CurrentUserVerifyEmailParameter {
+    verificationToken: string;
+}
+/**
+ * Custom profile data
+ */
+export interface CurrentUserPublicData {
+    [key: string]: any;
+}
+export interface CurrentUserCustomPublicData extends Record<string, unknown> {
+}
+export interface CurrentUserProtectedData {
+    [key: string]: any;
+}
+export interface CurrentUserCustomProtectedData extends Record<string, unknown> {
+}
+export interface CurrentUserPrivateData {
+    [key: string]: any;
+}
+export interface CurrentUserCustomPrivateData extends Record<string, unknown> {
+}
+export interface CurrentUserMetadata {
+    [key: string]: any;
+}
+export interface CurrentUserCustomMetadata extends Record<string, unknown> {
+}
+/**
+ * All parameter types
+ */
+type AllCurrentUserParameter = CurrentUserShowParameter | CurrentUserDeleteParameter | CurrentUserCreateParameter | CurrentUserCreateWithIdpParameter | CurrentUserUpdateProfileParameter | CurrentUserChangePasswordParameter | CurrentUserChangeEmailParameter | CurrentUserVerifyEmailParameter | CurrentUserSendVerificationEmailParameter;
+/**
+ * Include detection — fixes TS2536
+ */
+type HasInclude<P> = P extends {
+    include: infer I extends readonly CurrentUserRelationshipsFields[];
+} ? I : never;
+type IncludesRelationships<P> = HasInclude<P> extends never ? false : true;
+type IncludedResources<P> = HasInclude<P> extends infer Fields extends CurrentUserRelationshipsFields[] ? 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 CurrentUserEndpoints, P extends AllCurrentUserParameter, EP extends ExtraParameterType | undefined> = E extends "show" ? CurrentUserResource<IncludesRelationships<P>> : E extends "delete" ? Pick<DeletedCurrentUser, "id" | "type"> : E extends "create" | "create_with_idp" | "update_profile" | "change_password" | "change_email" | "verify_email" | "send_verification_email" ? ExpandResult<CurrentUserResource<IncludesRelationships<P>>, EP> : never;
+/**
+ * Final response type
+ */
+export type CurrentUserResponse<E extends CurrentUserEndpoints, P extends AllCurrentUserParameter, EP extends ExtraParameterType | undefined = undefined> = {
+    data: ResponseData<E, P, EP>;
+} & (IncludesRelationships<P> extends true ? {
+    included: IncludedResources<P>;
+} : {});
+export {};

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

@@ -0,0 +1,65 @@
+/**
+ * @fileoverview Type definitions for Images in the Sharetribe Marketplace API.
+ */
+import { ApiParameter, ExtraParameterType, UUID } from "../sharetribe";
+/**
+ * Available endpoints
+ */
+export type ImagesEndpoints = "upload";
+/**
+ * Standard image variant names
+ */
+export type ImageVariantName = "default" | "landscape-crop" | "landscape-crop2x" | "landscape-crop4x" | "landscape-crop6x" | "scaled-small" | "scaled-medium" | "scaled-large" | "scaled-xlarge" | "square-small" | "square-small2x" | "facebook" | "twitter";
+/**
+ * Image variant object
+ */
+export interface ImageVariant {
+    width: number;
+    height: number;
+    url: string;
+    name: ImageVariantName;
+}
+/**
+ * Image resource
+ */
+export interface Image {
+    id: UUID;
+    type: "image";
+    attributes: {
+        variants: {
+            [K in ImageVariantName]?: ImageVariant;
+        } & {
+            [key: string]: ImageVariant | undefined;
+        };
+    };
+}
+/**
+ * Base request parameters
+ */
+export interface ImagesParameter extends ApiParameter {
+}
+/**
+ * Upload endpoint parameters
+ */
+export interface ImagesUploadParameter extends ImagesParameter {
+    image: File;
+}
+/**
+ * Expand behavior
+ */
+type ExpandResult<EP extends ExtraParameterType | undefined> = EP extends {
+    expand: true;
+} ? Image : EP extends {
+    expand: false;
+} ? Omit<Image, "attributes"> : Omit<Image, "attributes">;
+/**
+ * Response data per endpoint
+ */
+type ResponseData<E extends ImagesEndpoints, EP extends ExtraParameterType | undefined> = E extends "upload" ? ExpandResult<EP> : never;
+/**
+ * Final response type
+ */
+export type ImagesResponse<E extends ImagesEndpoints = "upload", EP extends ExtraParameterType | undefined = undefined> = {
+    data: ResponseData<E, EP>;
+};
+export {};

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

@@ -0,0 +1,169 @@
+/**
+ * @fileoverview Type definitions for Listings in the Sharetribe Marketplace API.
+ */
+import { ApiMeta, ApiParameter, ExtraParameterType, LatLng, LatLngBounds, Money, QueryMeta, QueryPub, Relationship, RelationshipTypeMap, UUID } from "../sharetribe";
+import { AvailabilityPlan } from "./availabilityPlan";
+/**
+ * Public listing states
+ */
+export type ListingState = "published" | "closed" | "draft" | "pendingApproval";
+/**
+ * Availability mode returned in query results
+ */
+export type ListingAvailability = "day-full" | "day-partial" | "time-full" | "time-partial";
+/**
+ * Listing resource
+ */
+export interface Listing<I extends boolean = false> {
+    id: UUID;
+    type: "listing";
+    attributes: {
+        title: string;
+        description: string;
+        price: Money;
+        geolocation: LatLng;
+        state: ListingState;
+        deleted: boolean;
+        createdAt: Date;
+        availabilityPlan: AvailabilityPlan | null;
+        publicData: ListingPublicData & ListingCustomPublicData;
+        metadata: ListingMetadata & ListingCustomMetadata;
+    } & (I extends true ? {
+        privateData: ListingPrivateData & ListingCustomPrivateData;
+    } : {});
+}
+/**
+ * With relationships
+ */
+export interface ListingWithRelationships<I extends boolean = false> extends Listing<I> {
+    relationships: {
+        marketplace: Relationship<false, "marketplace">;
+        author: Relationship<false, "author">;
+        images: Relationship<true, "images">;
+        currentStock?: Relationship<false, "currentStock">;
+    };
+}
+export type ListingResource<R extends boolean, I extends boolean = false> = R extends true ? ListingWithRelationships<I> : Listing<I>;
+/**
+ * Relationship fields
+ */
+export type ListingsRelationshipsFields = "marketplace" | "author" | "author.profileImage" | "author.marketplace" | "author.stripeAccount" | "author.effectivePermissionSet" | "images" | "currentStock";
+/**
+ * Available endpoints
+ */
+export type ListingsEndpoints = "show" | "query" | "create" | "update" | "close" | "open" | "approve";
+/**
+ * Base request parameters
+ */
+export interface ListingsParameter extends ApiParameter {
+    include?: ListingsRelationshipsFields[];
+}
+/**
+ * Endpoint parameters
+ */
+export type ListingsShowParameter = ListingsParameter & {
+    id: UUID | string;
+};
+export interface ListingsQueryParameter extends ListingsParameter {
+    authorId?: UUID | string;
+    ids?: UUID[] | string[];
+    keywords?: string;
+    origin?: LatLng | string;
+    bounds?: LatLngBounds | string;
+    price?: Money | [Money, Money] | string;
+    start?: Date | string;
+    end?: Date | string;
+    seats?: number;
+    availability?: ListingAvailability;
+    minDuration?: number;
+    minStock?: number;
+    sort?: string;
+    [keyof: QueryPub]: string | undefined;
+    [keyof: QueryMeta]: string | undefined;
+}
+export interface ListingsCreateParameter extends ListingsParameter {
+    title: string;
+    authorId: UUID | string;
+    state: ListingState;
+    description?: string;
+    geolocation?: LatLng | string;
+    price?: Money | string;
+    availabilityPlan?: AvailabilityPlan | null;
+    publicData?: ListingPublicData & ListingCustomPublicData;
+    privateData?: ListingPrivateData & ListingCustomPrivateData;
+    metadata?: ListingMetadata & ListingCustomMetadata;
+    images?: UUID[] | string[];
+}
+export type ListingsUpdateParameter = ListingsParameter & {
+    id: UUID | string;
+    title?: string;
+    description?: string;
+    price?: Money | string;
+    availabilityPlan?: AvailabilityPlan | null;
+    publicData?: ListingPublicData & ListingCustomPublicData;
+    privateData?: ListingPrivateData & ListingCustomPrivateData;
+    metadata?: ListingMetadata & ListingCustomMetadata;
+    images?: UUID[] | string[];
+};
+export type ListingsCloseParameter = ListingsParameter & {
+    id: UUID | string;
+};
+export type ListingsOpenParameter = ListingsParameter & {
+    id: UUID | string;
+};
+export type ListingsApproveParameter = ListingsParameter & {
+    id: UUID | string;
+};
+/**
+ * Custom data
+ */
+export interface ListingPublicData {
+    [key: string]: any;
+}
+export interface ListingCustomPublicData extends Record<string, unknown> {
+}
+export interface ListingPrivateData {
+    [key: string]: any;
+}
+export interface ListingCustomPrivateData extends Record<string, unknown> {
+}
+export interface ListingMetadata {
+    [key: string]: any;
+}
+export interface ListingCustomMetadata extends Record<string, unknown> {
+}
+/**
+ * All parameter types
+ */
+type AllListingsParameter = ListingsShowParameter | ListingsQueryParameter | ListingsCreateParameter | ListingsUpdateParameter | ListingsCloseParameter | ListingsOpenParameter | ListingsApproveParameter;
+/**
+ * Include detection — fixes TS2536
+ */
+type HasInclude<P> = P extends {
+    include: infer I extends readonly ListingsRelationshipsFields[];
+} ? I : never;
+type IncludesRelationships<P> = HasInclude<P> extends never ? false : true;
+type IncludedResources<P> = HasInclude<P> extends infer Fields extends ListingsRelationshipsFields[] ? 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 ListingsEndpoints, P extends AllListingsParameter, EP extends ExtraParameterType | undefined, I extends boolean = false> = E extends "query" ? ListingResource<IncludesRelationships<P>, I>[] : E extends "show" | "create" | "update" | "close" | "open" | "approve" ? ExpandResult<ListingResource<IncludesRelationships<P>, I>, EP> : never;
+/**
+ * Final response
+ */
+export type ListingsResponse<E extends ListingsEndpoints, P extends AllListingsParameter, EP extends ExtraParameterType | undefined = undefined, I extends boolean = false> = {
+    data: ResponseData<E, P, EP, I>;
+} & (IncludesRelationships<P> extends true ? {
+    included: IncludedResources<P>;
+} : {}) & (E extends "query" ? {
+    meta: ApiMeta;
+} : {});
+export {};

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

@@ -0,0 +1,30 @@
+/**
+ * @fileoverview Type definitions for Marketplace in the Sharetribe Marketplace API.
+ */
+import { UUID } from "../sharetribe";
+/**
+ * Available endpoints
+ */
+export type MarketplaceEndpoints = "show";
+/**
+ * Marketplace resource
+ */
+export interface Marketplace {
+    id: UUID;
+    type: "marketplace";
+    attributes: {
+        name: string;
+        description: string;
+    };
+}
+/**
+ * Response data per endpoint
+ */
+type ResponseData<E extends MarketplaceEndpoints> = E extends "show" ? Marketplace : never;
+/**
+ * Final response type
+ */
+export type MarketplaceResponse<E extends MarketplaceEndpoints = "show"> = {
+    data: ResponseData<E>;
+};
+export {};

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

@@ -0,0 +1,87 @@
+/**
+ * @fileoverview Type definitions for Messages in the Sharetribe Marketplace API.
+ */
+import { ApiMeta, ApiParameter, ExtraParameterType, Relationship, RelationshipTypeMap, UUID } from "../sharetribe";
+/**
+ * Available endpoints
+ */
+export type MessagesEndpoints = "query" | "send";
+/**
+ * Relationship fields that can be included
+ */
+export type MessagesRelationshipsFields = "sender" | "sender.profileImage" | "sender.marketplace" | "transaction" | "transaction.marketplace" | "transaction.listing" | "transaction.provider" | "transaction.customer" | "transaction.booking" | "transaction.stockReservation" | "transaction.reviews" | "transaction.messages";
+/**
+ * Message resource
+ */
+export interface Message {
+    id: UUID;
+    type: "message";
+    attributes: {
+        content: string;
+        createdAt: Date;
+    };
+}
+/**
+ * With relationships
+ */
+export interface MessageWithRelationships extends Message {
+    relationships: {
+        sender: Relationship<false, "sender">;
+        transaction: Relationship<false, "transaction">;
+    };
+}
+export type MessageResource<R extends boolean> = R extends true ? MessageWithRelationships : Message;
+/**
+ * Base request parameters
+ */
+export interface MessagesParameter extends ApiParameter {
+    include?: MessagesRelationshipsFields[];
+}
+/**
+ * Query messages
+ */
+export interface MessagesQueryParameter extends MessagesParameter {
+    transactionId: UUID | string;
+}
+/**
+ * Send a message
+ */
+export interface MessagesSendParameter extends MessagesParameter {
+    transactionId: UUID | string;
+    content: string;
+}
+/**
+ * All parameter types
+ */
+type AllMessagesParameter = MessagesQueryParameter | MessagesSendParameter;
+/**
+ * Include detection — fixes TS2536
+ */
+type HasInclude<P> = P extends {
+    include: infer I extends readonly MessagesRelationshipsFields[];
+} ? I : never;
+type IncludesRelationships<P> = HasInclude<P> extends never ? false : true;
+type IncludedResources<P> = HasInclude<P> extends infer Fields extends MessagesRelationshipsFields[] ? 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 MessagesEndpoints, P extends AllMessagesParameter, EP extends ExtraParameterType | undefined> = E extends "query" ? MessageResource<IncludesRelationships<P>>[] : E extends "send" ? ExpandResult<MessageResource<IncludesRelationships<P>>, EP> : never;
+/**
+ * Final response type
+ */
+export type MessagesResponse<E extends MessagesEndpoints, P extends AllMessagesParameter, EP extends ExtraParameterType | undefined = undefined> = {
+    data: ResponseData<E, P, EP>;
+} & (IncludesRelationships<P> extends true ? {
+    included: IncludedResources<P>;
+} : {}) & (E extends "query" ? {
+    meta: ApiMeta;
+} : {});
+export {};