payment-kit 1.13.15

package/api/src/store/models/setup-intent.ts

@@ -0,0 +1,206 @@
+/* eslint-disable @typescript-eslint/lines-between-class-members */
+/* eslint-disable @typescript-eslint/indent */
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+
+import { createEvent, createStatusEvent } from '../../libs/audit';
+import { createIdGenerator } from '../../libs/util';
+import type { PaymentError, PaymentMethodOptions } from './types';
+
+const nextId = createIdGenerator('seti', 24);
+
+// @link https://stripe.com/docs/api/setup_intents
+// eslint-disable-next-line prettier/prettier
+export class SetupIntent extends Model<InferAttributes<SetupIntent>, InferCreationAttributes<SetupIntent>> {
+  // Unique identifier for the object.
+  declare id: CreationOptional<string>;
+
+  declare livemode: boolean;
+  declare description: string;
+
+  declare currency_id: string;
+  declare customer_id: string;
+
+  // The setup error encountered in the previous SetupIntent confirmation
+  declare last_setup_error?: PaymentError;
+
+  declare metadata?: Record<string, any>;
+
+  declare status: LiteralUnion<
+    | 'requires_payment_method'
+    | 'requires_confirmation'
+    | 'requires_action'
+    | 'processing'
+    | 'requires_capture'
+    | 'canceled'
+    | 'succeeded',
+    string
+  >;
+
+  declare usage: LiteralUnion<'on_session' | 'off_session', string>;
+
+  declare canceled_at?: number;
+  declare cancellation_reason?: LiteralUnion<'abandoned' | 'duplicate' | 'requested_by_customer', string>;
+
+  declare flow_directions: LiteralUnion<'inbound' | 'outbound', string>[];
+
+  declare payment_method_options?: PaymentMethodOptions;
+  declare payment_method_types?: string[];
+  declare payment_method_id: string;
+
+  // 3rd party payment tx hash
+  declare setup_details?: {
+    tx_hash?: string;
+    payer?: string;
+  };
+
+  // TODO: following fields not supported yet
+  // application
+  // attach_to_self
+  // client_secret
+  // latest_attempt
+  // mandate
+  // next_action
+  // on_behalf_of
+  // single_use_mandate
+
+  declare created_at: CreationOptional<Date>;
+  declare updated_at: CreationOptional<Date>;
+
+  public static readonly GENESIS_ATTRIBUTES = {
+    id: {
+      type: DataTypes.STRING(30),
+      primaryKey: true,
+      allowNull: false,
+      defaultValue: nextId,
+    },
+    livemode: {
+      type: DataTypes.BOOLEAN,
+      allowNull: false,
+    },
+    currency_id: {
+      type: DataTypes.STRING(16),
+      allowNull: false,
+    },
+    customer_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    description: {
+      type: DataTypes.STRING(512),
+      allowNull: true,
+    },
+    last_setup_error: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    last_attempt: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    metadata: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    status: {
+      type: DataTypes.ENUM(
+        'requires_payment_method',
+        'requires_confirmation',
+        'requires_action',
+        'processing',
+        'requires_capture',
+        'canceled',
+        'succeeded'
+      ),
+      allowNull: false,
+    },
+    usage: {
+      type: DataTypes.ENUM('on_session', 'off_session'),
+      allowNull: false,
+    },
+    canceled_at: {
+      type: DataTypes.INTEGER,
+      allowNull: true,
+    },
+    cancellation_reason: {
+      type: DataTypes.ENUM('abandoned', 'duplicate', 'requested_by_customer'),
+      allowNull: true,
+    },
+    flow_directions: {
+      type: DataTypes.JSON,
+      defaultValue: ['inbound', 'outbound'],
+    },
+    payment_method_types: {
+      type: DataTypes.JSON,
+      defaultValue: [],
+    },
+    payment_method_options: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    payment_method_id: {
+      type: DataTypes.STRING(30),
+      allowNull: false,
+    },
+    setup_details: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    created_at: {
+      type: DataTypes.DATE,
+      defaultValue: DataTypes.NOW,
+      allowNull: false,
+    },
+    updated_at: {
+      type: DataTypes.DATE,
+      defaultValue: DataTypes.NOW,
+      allowNull: false,
+    },
+  };
+
+  public static initialize(sequelize: any) {
+    this.init(SetupIntent.GENESIS_ATTRIBUTES, {
+      sequelize,
+      modelName: 'SetupIntent',
+      tableName: 'setup_intents',
+      createdAt: 'created_at',
+      updatedAt: 'updated_at',
+      hooks: {
+        afterCreate: (model: SetupIntent, options) =>
+          createEvent('SetupIntent', 'setup_intent.created', model, options).catch(console.error),
+        afterUpdate: (model: SetupIntent, options) =>
+          createStatusEvent(
+            'SetupIntent',
+            'setup_intent',
+            {
+              requires_action: 'requires_action',
+              canceled: 'canceled',
+              succeeded: 'succeeded',
+            },
+            model,
+            options
+          ),
+      },
+    });
+  }
+
+  public static associate(models: any) {
+    this.hasOne(models.PaymentCurrency, {
+      sourceKey: 'currency_id',
+      foreignKey: 'id',
+      as: 'paymentCurrency',
+    });
+    this.hasOne(models.PaymentMethod, {
+      sourceKey: 'payment_method_id',
+      foreignKey: 'id',
+      as: 'paymentMethod',
+    });
+    this.hasOne(models.Customer, {
+      sourceKey: 'customer_id',
+      foreignKey: 'id',
+      as: 'customer',
+    });
+  }
+}
+
+export type TSetupIntent = InferAttributes<SetupIntent>;

package/api/src/store/models/subscription-item.ts

@@ -0,0 +1,103 @@
+/* eslint-disable @typescript-eslint/lines-between-class-members */
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+
+import { createIdGenerator } from '../../libs/util';
+
+const nextId = createIdGenerator('si', 14);
+
+// eslint-disable-next-line prettier/prettier
+export class SubscriptionItem extends Model<InferAttributes<SubscriptionItem>, InferCreationAttributes<SubscriptionItem>> {
+  declare id: CreationOptional<string>;
+  declare livemode: boolean;
+
+  // The identifier of the subscription this item belongs to.
+  declare subscription_id: string;
+
+  // The price the customer is subscribed to.
+  declare price_id: string;
+
+  declare quantity: number;
+
+  declare metadata: Record<string, any>;
+
+  declare billing_thresholds?: {
+    usage_gte: number;
+  };
+
+  // Fields exists on creation
+  // declare proration_behavior: LiteralUnion<'always_invoice' | 'create_prorations' | 'none', string>;
+  // declare payment_behavior: LiteralUnion<'allow_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete', string>;
+
+  // TODO: following fields not supported
+  // tax_rates
+
+  declare created_at: CreationOptional<Date>;
+  declare updated_at: CreationOptional<Date>;
+
+  public static readonly GENESIS_ATTRIBUTES = {
+    id: {
+      type: DataTypes.STRING(18),
+      primaryKey: true,
+      allowNull: false,
+      defaultValue: nextId,
+    },
+    livemode: {
+      type: DataTypes.BOOLEAN,
+      allowNull: false,
+    },
+    subscription_id: {
+      type: DataTypes.STRING(30),
+      allowNull: false,
+    },
+    price_id: {
+      type: DataTypes.STRING(30),
+      allowNull: false,
+    },
+    quantity: {
+      type: DataTypes.INTEGER,
+      allowNull: false,
+    },
+    metadata: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    billing_threshold: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    created_at: {
+      type: DataTypes.DATE,
+      defaultValue: DataTypes.NOW,
+      allowNull: false,
+    },
+    updated_at: {
+      type: DataTypes.DATE,
+      defaultValue: DataTypes.NOW,
+      allowNull: false,
+    },
+  };
+
+  public static initialize(sequelize: any) {
+    this.init(SubscriptionItem.GENESIS_ATTRIBUTES, {
+      sequelize,
+      modelName: 'SubscriptionItem',
+      tableName: 'subscription_items',
+      createdAt: 'created_at',
+      updatedAt: 'updated_at',
+    });
+  }
+
+  public static associate(models: any) {
+    this.belongsTo(models.Subscription, {
+      foreignKey: 'subscription_id',
+      as: 'subscription',
+    });
+    this.hasOne(models.Price, {
+      sourceKey: 'price_id',
+      foreignKey: 'id',
+      as: 'price',
+    });
+  }
+}
+
+export type TSubscriptionItem = InferAttributes<SubscriptionItem>;

package/api/src/store/models/subscription-schedule.ts

@@ -0,0 +1,157 @@
+/* eslint-disable @typescript-eslint/lines-between-class-members */
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+
+import { createIdGenerator } from '../../libs/util';
+import type { SubscriptionSchedulePhase } from './types';
+
+const nextId = createIdGenerator('ss', 24);
+
+// eslint-disable-next-line prettier/prettier
+export class SubscriptionSchedule extends Model<InferAttributes<SubscriptionSchedule>, InferCreationAttributes<SubscriptionSchedule>> {
+  declare id: CreationOptional<string>;
+
+  declare livemode: boolean;
+
+  declare current_phase: {
+    end_date: Date;
+    start_date: Date;
+  };
+
+  declare customer_id: string;
+  declare subscription_id: string;
+
+  declare metadata: Record<string, any>;
+
+  declare status: LiteralUnion<'active' | 'canceled' | 'completed' | 'not_started' | 'released', string>;
+
+  declare phases?: SubscriptionSchedulePhase[];
+
+  // Object representing the subscription schedule’s default settings.
+  declare default_settings?: {
+    billing_cycle_anchor: LiteralUnion<'phase_start' | 'automatic', string>;
+    billing_thresholds: {
+      amount_gte: number;
+      reset_billing_cycle_anchor: boolean;
+    };
+    collection_method: LiteralUnion<'charge_automatically' | 'send_invoice', string>;
+    default_payment_method: string;
+    description: string;
+    invoice_settings: {
+      days_until_due: number;
+    };
+    // TODO: following fields not supported
+    // application_fee_percent?: number;
+    // automatic_tax?: {
+    //   enabled: boolean;
+    // };
+    // on_behalf_of?: string;
+    // transfer_data?: any;
+  };
+
+  declare end_behavior: LiteralUnion<'cancel' | 'release', string>;
+
+  declare released_subscription_id?: string;
+
+  declare test_clock_id?: string;
+
+  // TODO: following fields not supported
+  // application
+
+  declare canceled_at: number;
+  declare completed_at: number;
+  declare released_at: number;
+
+  declare created_at: CreationOptional<Date>;
+  declare updated_at: CreationOptional<Date>;
+
+  public static readonly GENESIS_ATTRIBUTES = {
+    id: {
+      type: DataTypes.STRING(30),
+      primaryKey: true,
+      allowNull: false,
+      defaultValue: nextId,
+    },
+    livemode: {
+      type: DataTypes.BOOLEAN,
+      allowNull: false,
+    },
+    current_phase: {
+      type: DataTypes.JSON,
+      allowNull: false,
+    },
+    customer_id: {
+      type: DataTypes.STRING(30),
+      allowNull: false,
+    },
+    subscription_id: {
+      type: DataTypes.STRING(30),
+      allowNull: false,
+    },
+    released_subscription_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    status: {
+      type: DataTypes.ENUM('active', 'canceled', 'completed', 'not_started', 'released'),
+      allowNull: false,
+    },
+    default_settings: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    end_behavior: {
+      type: DataTypes.ENUM('cancel', 'release'),
+      allowNull: false,
+    },
+    test_clock_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    metadata: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    canceled_at: {
+      type: DataTypes.INTEGER,
+      allowNull: true,
+    },
+    completed_at: {
+      type: DataTypes.INTEGER,
+      allowNull: true,
+    },
+    released_at: {
+      type: DataTypes.INTEGER,
+      allowNull: true,
+    },
+    created_at: {
+      type: DataTypes.DATE,
+      defaultValue: DataTypes.NOW,
+      allowNull: false,
+    },
+    updated_at: {
+      type: DataTypes.DATE,
+      defaultValue: DataTypes.NOW,
+      allowNull: false,
+    },
+  };
+
+  public static initialize(sequelize: any) {
+    this.init(SubscriptionSchedule.GENESIS_ATTRIBUTES, {
+      sequelize,
+      modelName: 'SubscriptionSchedule',
+      tableName: 'subscription_schedules',
+      createdAt: 'created_at',
+      updatedAt: 'updated_at',
+    });
+  }
+
+  public static associate(models: any) {
+    this.belongsTo(models.Subscription, {
+      foreignKey: 'subscription_id',
+      as: 'subscription',
+    });
+  }
+}
+
+export type TSubscriptionSchedule = InferAttributes<SubscriptionSchedule>;