@wix/payments 1.0.1 → 1.0.3

package/context/package.json

@@ -2,5 +2,6 @@
   "sideEffects": false,
   "module": "../build/es/context.js",
   "main": "../build/cjs/context.js",
-  "typings": "../build/cjs/context.d.ts"
+  "typings": "../build/cjs/context.d.ts",
+  "typesBundle": "../type-bundles/context.bundle.d.ts"
 }

package/meta/package.json

@@ -2,5 +2,6 @@
   "sideEffects": false,
   "module": "../build/es/meta.js",
   "main": "../build/cjs/meta.js",
-  "typings": "../build/cjs/meta.d.ts"
+  "typings": "../build/cjs/meta.d.ts",
+  "typesBundle": "../type-bundles/meta.bundle.d.ts"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/payments",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -9,21 +9,26 @@
   "module": "build/es/index.js",
   "main": "build/cjs/index.js",
   "typings": "./build/cjs/index.d.ts",
+  "typesBundle": "./type-bundles/index.bundle.d.ts",
   "files": [
     "build",
     "frontend/package.json",
     "meta",
-    "context"
+    "context",
+    "type-bundles"
   ],
   "dependencies": {
-    "@wix/payments_refunds": "1.0.1"
+    "@wix/payments_refunds": "1.0.3"
   },
   "devDependencies": {
-    "@wix/sdk": "https://cdn.dev.wixpress.com/@wix/sdk/02e8069ab2fd783e0e6a080fc7d590e76cb26ab93c8389574286305b.tar.gz",
+    "glob": "^10.4.1",
+    "rollup": "^4.18.0",
+    "rollup-plugin-dts": "^6.1.1",
     "typescript": "^5.3.2"
   },
   "scripts": {
-    "build": "tsc -b tsconfig.json tsconfig.esm.json",
+    "build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles",
+    "build:dts-bundles": "test -f config/rollup-config.js && rollup --config config/rollup-config.js || echo 'Warning: config/rollup-config.js not found!'",
     "test": ":"
   },
   "wix": {
@@ -37,5 +42,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "c9bebcf0b65ee237ea6b26f01fbfd70e9d3def328574a030f02424f7"
+  "falconPackageHash": "bb89c54e2fe412112a0ff60b85758c01fb7cbf452226065ad2662f1d"
 }

package/type-bundles/context.bundle.d.ts

@@ -0,0 +1,455 @@
+/**
+ * A refund a record of an attempt of
+ * returning funds for a charge from a merchant to a customer to who has made a purchase.
+ * Read more about refunds in this [article](<https://dev.wix.com/docs/rest/business-management/payments/refunds/introduction>).
+ */
+interface Refund {
+    /**
+     * Refund ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the refund is updated.
+     *
+     * Ignored when creating a refund.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the refund was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date and time the refund was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields;
+    /** ID of charge for which the funds are returned by this refund. */
+    chargeId?: string | null;
+    /** Currency of refund, should be the same as currency of charge. */
+    currency?: string | null;
+    /**
+     * Amount of refund in base units, what's returned to the customer.
+     * E.g. "12.95".
+     */
+    amount?: string | null;
+    /**
+     * Application fee returned to merchant from Wix.
+     * In base units, e.g. "12.95".
+     * Not present when no application fee was returned.
+     * @readonly
+     */
+    returnedApplicationFee?: string | null;
+    /**
+     * Processing fee returned to merchant from provider.
+     * In base units, e.g. "12.95".
+     * Applicable only to Wix Payments provider.
+     * Not present when no processing fee was returned.
+     * @readonly
+     */
+    returnedProcessingFee?: string | null;
+    /**
+     * True when refund returns all funds for a charge.
+     * @readonly
+     */
+    full?: boolean | null;
+    /**
+     * Status of the refund.
+     * Read more about statuses in this [article](<https://dev.wix.com/docs/rest/business-management/payments/refunds/introduction#lifecycle-of-a-refund>).
+     * @readonly
+     */
+    status?: Status;
+    /**
+     * ID of the refund on the PSP side.
+     * @readonly
+     */
+    providerRefundId?: string | null;
+    /** Reason why this refund was issued. */
+    reason?: string | null;
+    /**
+     * Details about refund status.
+     * Mostly used with statuses `FAILED` and `REVERSED`.
+     * @readonly
+     */
+    statusInfo?: StatusInfo;
+    /**
+     * Acquirer Reference Number.
+     * @readonly
+     */
+    acquirerReferenceNumber?: string | null;
+    /** Optional free-text note about this refund. */
+    note?: string | null;
+}
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+declare enum Status {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /**
+     * Initial status for all refunds.
+     * Provisional, refund should be in this status for less than a minute.
+     */
+    STARTING = "STARTING",
+    /** Status right after STARTED for asynchronous refunds. */
+    PENDING = "PENDING",
+    /**
+     * Refund was successful.
+     * Can transition to REVERSED in corner cases.
+     */
+    SUCCEEDED = "SUCCEEDED",
+    /** Regular error, terminal status. */
+    FAILED = "FAILED",
+    /**
+     * Either refund reversal
+     * or any other error that comes after success, terminal status.
+     */
+    REVERSED = "REVERSED"
+}
+interface StatusInfo {
+    /**
+     * Reason code.
+     * [Read more about reason codes.](https://dev.wix.com/docs/rest/api-reference/payment-provider-spi/reason-codes)
+     */
+    code?: string;
+    /** Free-text description. */
+    description?: string | null;
+}
+interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+interface UpdateExtendedFieldsResponse {
+    /** Updated refund. */
+    refund?: Refund;
+}
+interface GetRefundabilityResponse {
+    /** Refundability for the charge. */
+    refundability?: Refundability;
+}
+/**
+ * Internal notes:
+ *
+ * Instead of separate Refundability and PartialRefundability, we provide min and max refund amount.
+ * If only full refund is possible, min_refund_amount = max_refund_amount = charge amount.
+ */
+interface Refundability extends RefundabilityDetailsOneOf {
+    /** When charge is refundable, specifies what amounts are allowed for refund. */
+    refundOptions?: RefundOptions;
+    /** When charge is not refundable, specifies why refund is not allowed. */
+    rejection?: Rejection;
+    /** Whether the caller is allowed to refund the charge. */
+    refundable?: boolean;
+    /** Currency of the charge. */
+    currency?: string | null;
+    /**
+     * Sum of amounts of `SUCCEEDED` refunds for this charge in base units, e.g. "6.47".
+     * Used to prevent unintended refunds, read more in this
+     * [article](<https://dev.wix.com/docs/rest/business-management/payments/refunds/introduction#preventing-unintended-refunds>).
+     */
+    previouslyRefundedAmount?: string | null;
+}
+/** @oneof */
+interface RefundabilityDetailsOneOf {
+    /** When charge is refundable, specifies what amounts are allowed for refund. */
+    refundOptions?: RefundOptions;
+    /** When charge is not refundable, specifies why refund is not allowed. */
+    rejection?: Rejection;
+}
+interface RefundOptions {
+    /** Minimum amount allowed to be refunded in base units, e.g. "0.50". */
+    minRefundAmount?: string | null;
+    /** Maximum amount allowed to be refunded in base units, e.g. "12.95". */
+    maxRefundAmount?: string | null;
+}
+interface Rejection {
+    /**
+     * Following reasons are possible:
+     * - `CHARGE_REFUNDED` — charge is already fully refunded.
+     * - `CHARGE_REFUND_IN_PROGRESS` — another refund was initiated for this charge
+     * and is waiting for confirmation from the provider.
+     * - `CHARGE_DISPUTED` — charge was disputed.
+     * - `CHARGE_REFUND_PERIOD_ENDED` — charge is too old to be refunded.
+     * - `CHARGE_UNPAID` — charge is unpaid.
+     * - `PROVIDER_DOWN` — PSP is temporarily down.
+     * - `PROVIDER_NOT_SUPPORTED` — provider doesn't support refunds at the moment,
+     * charge is in the wrong state,
+     * or we don't have required information for this transaction.
+     * - `PAYMENT_METHOD_NOT_SUPPORTED` — payment method of a charge doesn't support refunds.
+     * - `MERCHANT_ACCOUNT_NOT_SUPPORTED` — merchant account doesn't support refunds at the moment.
+     * - `MERCHANT_BALANCE_INSUFFICIENT` — merchant doesn't have enough balance to issue a refund for this charge.
+     * - `NOT_AUTHORIZED` — logged in merchant has no permission to refund this charge.
+     */
+    reason?: RejectionReason;
+}
+declare enum RejectionReason {
+    UNKNOWN_REJECTION_REASON = "UNKNOWN_REJECTION_REASON",
+    /** Charge is already fully refunded. */
+    CHARGE_REFUNDED = "CHARGE_REFUNDED",
+    /** Another refund was initiated for this charge and is waiting for confirmation from the provider. */
+    CHARGE_REFUND_IN_PROGRESS = "CHARGE_REFUND_IN_PROGRESS",
+    /** Charge was disputed. */
+    CHARGE_DISPUTED = "CHARGE_DISPUTED",
+    /** Charge is too old to be refunded. */
+    CHARGE_REFUND_PERIOD_ENDED = "CHARGE_REFUND_PERIOD_ENDED",
+    /** Charge is unpaid. */
+    CHARGE_UNPAID = "CHARGE_UNPAID",
+    /** PSP is temporarily down. */
+    PROVIDER_DOWN = "PROVIDER_DOWN",
+    /**
+     * Provider doesn't support refunds at the moment, transaction in a wrong state or we don't
+     * have required information for this transaction.
+     */
+    PROVIDER_NOT_SUPPORTED = "PROVIDER_NOT_SUPPORTED",
+    /** Payment method of a charge doesn't support refunds. */
+    PAYMENT_METHOD_NOT_SUPPORTED = "PAYMENT_METHOD_NOT_SUPPORTED",
+    /** Merchant account doesn't support refunds at the moment. */
+    MERCHANT_ACCOUNT_NOT_SUPPORTED = "MERCHANT_ACCOUNT_NOT_SUPPORTED",
+    /** Merchant doesn't have enough balance to issue a refund for this charge. */
+    MERCHANT_BALANCE_INSUFFICIENT = "MERCHANT_BALANCE_INSUFFICIENT",
+    /** Logged in merchant has no permission to refund this charge. */
+    NOT_AUTHORIZED = "NOT_AUTHORIZED"
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface UpdateExtendedFieldsResponseNonNullableFields {
+    refund?: {
+        status: Status;
+        statusInfo?: {
+            code: string;
+        };
+    };
+}
+interface GetRefundabilityResponseNonNullableFields {
+    refundability?: {
+        rejection?: {
+            reason: RejectionReason;
+        };
+        refundable: boolean;
+    };
+}
+interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+interface RefundCreatedEnvelope {
+    entity: Refund;
+    metadata: EventMetadata;
+}
+interface RefundUpdatedEnvelope {
+    entity: Refund;
+    metadata: EventMetadata;
+}
+interface CreateRefundOptions {
+    /**
+     * Optional parameter used to prevent unintended refunds.
+     * Used to check previously refunded amount according to the client
+     * against the amount from server perspective.
+     * If they don't match, error with code `PREVIOUSLY_REFUNDED_AMOUNT_MISMATCH` is returned.
+     *
+     * Read more about preventing unintended refunds in this
+     * [article](<https://dev.wix.com/docs/rest/business-management/payments/refunds/introduction#preventing-unintended-refunds>).
+     */
+    previouslyRefundedAmount?: string | null;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface RefundsQueryResult extends QueryCursorResult {
+    items: Refund[];
+    query: RefundsQueryBuilder;
+    next: () => Promise<RefundsQueryResult>;
+    prev: () => Promise<RefundsQueryResult>;
+}
+interface RefundsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: 'chargeId', value: any) => RefundsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: 'chargeId', value: any) => RefundsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => RefundsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => RefundsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<RefundsQueryResult>;
+}
+interface UpdateExtendedFieldsOptions {
+    /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
+    namespaceData: Record<string, any> | null;
+}
+
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+declare function createRefund$1(httpClient: HttpClient): (refund: Refund, options?: CreateRefundOptions) => Promise<Refund & {
+    status: Status;
+    statusInfo?: {
+        code: string;
+    } | undefined;
+}>;
+declare function getRefund$1(httpClient: HttpClient): (refundId: string) => Promise<Refund & {
+    status: Status;
+    statusInfo?: {
+        code: string;
+    } | undefined;
+}>;
+declare function queryRefunds$1(httpClient: HttpClient): () => RefundsQueryBuilder;
+declare function updateExtendedFields$1(httpClient: HttpClient): (_id: string, namespace: string, options: UpdateExtendedFieldsOptions) => Promise<UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields>;
+declare function getRefundability$1(httpClient: HttpClient): (chargeId: string) => Promise<GetRefundabilityResponse & GetRefundabilityResponseNonNullableFields>;
+declare const onRefundCreated$1: EventDefinition<RefundCreatedEnvelope, "wix.payments.refunds.v1.refund_created">;
+declare const onRefundUpdated$1: EventDefinition<RefundUpdatedEnvelope, "wix.payments.refunds.v1.refund_updated">;
+
+declare const createRefund: BuildRESTFunction<typeof createRefund$1>;
+declare const getRefund: BuildRESTFunction<typeof getRefund$1>;
+declare const queryRefunds: BuildRESTFunction<typeof queryRefunds$1>;
+declare const updateExtendedFields: BuildRESTFunction<typeof updateExtendedFields$1>;
+declare const getRefundability: BuildRESTFunction<typeof getRefundability$1>;
+declare const onRefundCreated: BuildEventDefinition<typeof onRefundCreated$1>;
+declare const onRefundUpdated: BuildEventDefinition<typeof onRefundUpdated$1>;
+
+declare const context_createRefund: typeof createRefund;
+declare const context_getRefund: typeof getRefund;
+declare const context_getRefundability: typeof getRefundability;
+declare const context_onRefundCreated: typeof onRefundCreated;
+declare const context_onRefundUpdated: typeof onRefundUpdated;
+declare const context_queryRefunds: typeof queryRefunds;
+declare const context_updateExtendedFields: typeof updateExtendedFields;
+declare namespace context {
+  export { context_createRefund as createRefund, context_getRefund as getRefund, context_getRefundability as getRefundability, context_onRefundCreated as onRefundCreated, context_onRefundUpdated as onRefundUpdated, context_queryRefunds as queryRefunds, context_updateExtendedFields as updateExtendedFields };
+}
+
+export { context as refunds };