@diagonal-hq/cli 0.1.0 → 0.3.0

package/dist/capabilities.generated.d.ts

@@ -0,0 +1,397 @@
+// Generated by `artisan app:generate-custom-typescript` from CapabilityType. Do not edit.
+// The `capabilities` key of defineResource, one settings type for each capability.
+
+import type { FieldDefinition, FieldType } from './fields.generated';
+import type { StaticValue } from './index';
+
+/** The keys of the fields whose type is one of `TTypes`. */
+export type FieldKeyOf<TFields, TTypes extends FieldType = FieldType> = {
+  [TKey in keyof TFields]: TFields[TKey] extends FieldDefinition<infer TType> ? (TType extends TTypes ? TKey : never) : never;
+}[keyof TFields] &
+  string;
+
+/** A capability that a resource file can declare. */
+export type CapabilityType = "authenticatable" | "availability" | "booking" | "eventable" | "itemizable" | "lockable" | "notifiable" | "payable" | "payable_adjustment" | "payer" | "payer_balance_entry" | "payment" | "payment_method" | "price" | "product" | "refund" | "revenue_accounting" | "schedulable" | "subscription" | "subscription_discount" | "subscription_item" | "subscription_period";
+
+/** Authenticatable: Enable authentication for this resource */
+export type AuthenticatableCapabilitySettings<TFields> = {
+  "email_field": FieldKeyOf<TFields, "email">;
+  "password_field": FieldKeyOf<TFields, "password">;
+  "authentication_enabled_field"?: FieldKeyOf<TFields, "boolean"> | null;
+  "two_factor_enabled"?: boolean | null;
+  "magic_link_enabled"?: boolean | null;
+};
+
+/** Availability: Records of this resource open, close, or replace the regular hours of Schedulable records on some dates, such as time off or a holiday. Needs the Eventable capability */
+export type AvailabilityCapabilitySettings<TFields> = {
+  "schedulable_relation": FieldKeyOf<TFields, "relation">;
+  "effect_field": FieldKeyOf<TFields, "select">;
+};
+
+/** Booking: Records of this resource take capacity from Schedulable records and are refused when none is left. Changing how places are counted briefly pauses new bookings */
+export type BookingCapabilitySettings<TFields> = {
+  "bookable_relations": readonly (FieldKeyOf<TFields>)[];
+  "quantity_field"?: FieldKeyOf<TFields, "number"> | null;
+  "status_field"?: FieldKeyOf<TFields, "select" | "text"> | null;
+  "status_effects"?: readonly ({
+    "value": string;
+    "effect": "takes" | "held" | "waiting" | "released";
+  })[] | null;
+  "expired_status"?: string | null;
+  "needs_rescheduling_status"?: string | null;
+  "hold_expires_field"?: FieldKeyOf<TFields, "datetime"> | null;
+  "time_source_relation"?: FieldKeyOf<TFields, "relation"> | null;
+  "start_field"?: FieldKeyOf<TFields, "datetime"> | null;
+  "end_field"?: FieldKeyOf<TFields, "datetime"> | null;
+  "status_source_relation"?: FieldKeyOf<TFields, "relation"> | null;
+  "source_status_field"?: FieldKeyOf<TFields, "text" | "select"> | null;
+  "buffer_before_minutes"?: number | null;
+  "buffer_after_minutes"?: number | null;
+  "idempotency_field"?: FieldKeyOf<TFields, "text"> | null;
+  "require_availability"?: boolean | null;
+  "min_notice_minutes"?: number | null;
+  "max_advance_days"?: number | null;
+};
+
+/** Eventable: Enable calendar event functionality for records of this resource */
+export type EventableCapabilitySettings<TFields> = {
+  "event_schedule_field": FieldKeyOf<TFields, "event_schedule">;
+  "label_field"?: FieldKeyOf<TFields, "text"> | null;
+  "location_field"?: FieldKeyOf<TFields, "location" | "text"> | null;
+  "video_conference_link_field"?: FieldKeyOf<TFields, "text"> | null;
+  "engine"?: "series" | null;
+  "repeat_horizon_days"?: number | null;
+  "repeat_excluded_fields"?: readonly (FieldKeyOf<TFields>)[] | null;
+  "repeat_owner_relation"?: FieldKeyOf<TFields, "relation"> | null;
+  "timezone_field"?: FieldKeyOf<TFields, "text"> | null;
+  "respect_closures"?: boolean | null;
+  "repeat_record_workflows"?: boolean | null;
+  "closures_role"?: boolean | null;
+  "description_template"?: string | null;
+  "calendar_sync"?: boolean | null;
+  "calendar_owner_relation"?: FieldKeyOf<TFields, "relation"> | null;
+  "calendar_title_template"?: string | null;
+  "calendar_description_template"?: string | null;
+  "location_select_field"?: FieldKeyOf<TFields, "select"> | null;
+  "calendar_event_color"?: "banana" | "basil" | "blueberry" | "flamingo" | "grape" | "graphite" | "lavender" | "peacock" | "sage" | "tangerine" | "tomato" | null;
+  "calendar_reminder_minutes"?: number | null;
+  "calendar_meeting_links"?: boolean | null;
+  "calendar_meeting_link_condition_field"?: FieldKeyOf<TFields, "boolean"> | null;
+  "calendar_attendee_paths"?: readonly (string)[] | null;
+  "calendar_status_field"?: FieldKeyOf<TFields, "select" | "text"> | null;
+  "calendar_status_meanings"?: readonly ({
+    "value": string;
+    "meaning": "cancelled" | "tentative";
+  })[] | null;
+  "calendar_status_colors"?: readonly ({
+    "value": string;
+    "color": "banana" | "basil" | "blueberry" | "flamingo" | "grape" | "graphite" | "lavender" | "peacock" | "sage" | "tangerine" | "tomato";
+  })[] | null;
+};
+
+/** Itemizable: Configure this resource as a line item belonging to a payable record */
+export type ItemizableCapabilitySettings<TFields> = {
+  "accounting_source_field"?: FieldKeyOf<TFields, "select"> | null;
+  "recognition_date_field"?: FieldKeyOf<TFields, "date" | "datetime"> | null;
+  "service_period_start_field"?: FieldKeyOf<TFields, "date" | "datetime"> | null;
+  "service_period_end_field"?: FieldKeyOf<TFields, "date" | "datetime"> | null;
+  "accounting_sources"?: readonly ({
+    "key": string;
+    "label": string;
+    "source_paths"?: readonly ({
+      "fields"?: readonly string[] | null;
+      "component"?: "start" | "end" | null;
+    })[] | null;
+    "inline"?: {
+      "recognition_method_field": FieldKeyOf<TFields, "select">;
+      "revenue_account_field": FieldKeyOf<TFields, "wallet_accounting_account">;
+      "deferred_revenue_account_field"?: FieldKeyOf<TFields, "wallet_accounting_account"> | null;
+    } | null;
+    "recognition_date"?: {
+      "fields"?: readonly string[] | null;
+      "component"?: "start" | "end" | null;
+    } | null;
+    "service_period_start"?: {
+      "fields"?: readonly string[] | null;
+      "component"?: "start" | "end" | null;
+    } | null;
+    "service_period_end"?: {
+      "fields"?: readonly string[] | null;
+      "component"?: "start" | "end" | null;
+    } | null;
+  })[] | null;
+  "subscription_accounting_source"?: string | null;
+  "parent_relation_field": FieldKeyOf<TFields, "relation">;
+  "revenue_account_field"?: FieldKeyOf<TFields, "wallet_accounting_account"> | null;
+  "description_field": FieldKeyOf<TFields, "text">;
+  "quantity_field"?: FieldKeyOf<TFields, "number"> | null;
+  "unit_price_field": FieldKeyOf<TFields, "money">;
+  "total_field": FieldKeyOf<TFields, "money">;
+  "price_field"?: FieldKeyOf<TFields, "relation"> | null;
+  "source_subscription_item_field"?: FieldKeyOf<TFields, "relation"> | null;
+};
+
+/** Lockable: Lock fields from being changed once a record matches a configured filter */
+export type LockableCapabilitySettings<TFields> = {
+  "rules"?: readonly ({
+    "filter": StaticValue;
+    "fields": readonly (FieldKeyOf<TFields>)[];
+  })[] | null;
+};
+
+/** Notifiable: Enable notifications for this resource */
+export type NotifiableCapabilitySettings<TFields> = {
+  "email_field"?: FieldKeyOf<TFields, "email"> | null;
+  "phone_field"?: FieldKeyOf<TFields, "phone" | "text"> | null;
+};
+
+/** Payable: Configure this resource as an invoiceable record that tracks amounts due, paid, and payment status */
+export type PayableCapabilitySettings<TFields> = {
+  "status_field": FieldKeyOf<TFields, "select">;
+  "amount_total_field": FieldKeyOf<TFields, "money">;
+  "amount_paid_field": FieldKeyOf<TFields, "money">;
+  "amount_subtotal_field"?: FieldKeyOf<TFields, "money"> | null;
+  "amount_adjustment_field"?: FieldKeyOf<TFields, "money"> | null;
+  "amount_credit_adjustment_field"?: FieldKeyOf<TFields, "money"> | null;
+  "amount_charge_adjustment_field"?: FieldKeyOf<TFields, "money"> | null;
+  "amount_written_off_field"?: FieldKeyOf<TFields, "money"> | null;
+  "amount_outstanding_field"?: FieldKeyOf<TFields, "money"> | null;
+  "amount_overpaid_field"?: FieldKeyOf<TFields, "money"> | null;
+  "currency_field": FieldKeyOf<TFields, "text">;
+  "paid_at_field"?: FieldKeyOf<TFields, "datetime"> | null;
+  "due_at_field"?: FieldKeyOf<TFields, "date" | "datetime"> | null;
+  "period_start_field"?: FieldKeyOf<TFields, "date" | "datetime"> | null;
+  "period_end_field"?: FieldKeyOf<TFields, "date" | "datetime"> | null;
+  "payer_field"?: FieldKeyOf<TFields, "relation"> | null;
+  "exclude_from_subscription_status_field"?: FieldKeyOf<TFields, "boolean"> | null;
+  "source_subscription_field"?: FieldKeyOf<TFields, "relation"> | null;
+  "source_subscription_period_field"?: FieldKeyOf<TFields, "relation"> | null;
+  "accounting_entity_field"?: FieldKeyOf<TFields, "wallet_accounting_entity"> | null;
+};
+
+/** Payable Adjustment: Configure this resource as an adjustment record that increases or decreases a payable total */
+export type PayableAdjustmentCapabilitySettings<TFields> = {
+  "corrects_operation_field"?: FieldKeyOf<TFields, "uuid"> | null;
+  "line_allocations_field"?: FieldKeyOf<TFields, "list"> | null;
+  "accounting_account_field"?: FieldKeyOf<TFields, "wallet_accounting_account"> | null;
+  "source_line_field"?: FieldKeyOf<TFields, "relation"> | null;
+  "covered_start_field"?: FieldKeyOf<TFields, "date"> | null;
+  "covered_end_field"?: FieldKeyOf<TFields, "date"> | null;
+  "payable_field": FieldKeyOf<TFields, "relation">;
+  "payment_field"?: FieldKeyOf<TFields, "relation"> | null;
+  "kind_field": FieldKeyOf<TFields, "select">;
+  "status_field": FieldKeyOf<TFields, "select">;
+  "calculation_type_field": FieldKeyOf<TFields, "select">;
+  "amount_field": FieldKeyOf<TFields, "money">;
+  "fixed_amount_field"?: FieldKeyOf<TFields, "money"> | null;
+  "percent_field"?: FieldKeyOf<TFields, "number"> | null;
+  "description_field": FieldKeyOf<TFields, "text">;
+  "effective_at_field"?: FieldKeyOf<TFields, "date" | "datetime"> | null;
+};
+
+/** Payer: Configure this resource as a payment customer whose Stripe Customer ID is automatically managed */
+export type PayerCapabilitySettings<TFields> = {
+  "email_field"?: FieldKeyOf<TFields, "email"> | null;
+  "name_field"?: FieldKeyOf<TFields, "text"> | null;
+  "balance_field"?: FieldKeyOf<TFields, "money"> | null;
+  "default_payment_method_field"?: FieldKeyOf<TFields, "relation"> | null;
+};
+
+/** Payer Balance Entry: Configure this resource as an immutable ledger of credits and debits against payer balances */
+export type PayerBalanceEntryCapabilitySettings<TFields> = {
+  "accounting_entity_field"?: FieldKeyOf<TFields, "wallet_accounting_entity"> | null;
+  "description_field"?: FieldKeyOf<TFields, "text"> | null;
+  "source_payable_field"?: FieldKeyOf<TFields, "relation"> | null;
+  "payer_field": FieldKeyOf<TFields, "relation">;
+  "direction_field": FieldKeyOf<TFields, "select">;
+  "amount_field": FieldKeyOf<TFields, "money">;
+  "effective_at_field"?: FieldKeyOf<TFields, "date" | "datetime"> | null;
+  "payment_field"?: FieldKeyOf<TFields, "relation"> | null;
+};
+
+/** Payment: Configure this resource as a payment record that tracks individual transactions against a payable */
+export type PaymentCapabilitySettings<TFields> = {
+  "payable_field": FieldKeyOf<TFields, "relation">;
+  "payer_field"?: FieldKeyOf<TFields, "relation"> | null;
+  "amount_field": FieldKeyOf<TFields, "money">;
+  "currency_field": FieldKeyOf<TFields, "text">;
+  "method_field": FieldKeyOf<TFields, "select">;
+  "status_field": FieldKeyOf<TFields, "select">;
+  "failure_reason_field"?: FieldKeyOf<TFields, "text"> | null;
+  "refunded_amount_field"?: FieldKeyOf<TFields, "money"> | null;
+  "diagonal_fee_field": FieldKeyOf<TFields, "money">;
+  "diagonal_fee_refunded_field": FieldKeyOf<TFields, "money">;
+  "diagonal_fee_net_field": FieldKeyOf<TFields, "money">;
+  "notes_field"?: FieldKeyOf<TFields, "text"> | null;
+  "paid_at_field"?: FieldKeyOf<TFields, "datetime"> | null;
+};
+
+/** Payment Method: Configure this resource as a saved payment method synced from Stripe for a payer */
+export type PaymentMethodCapabilitySettings<TFields> = {
+  "payer_field": FieldKeyOf<TFields, "relation">;
+  "type_field": FieldKeyOf<TFields, "select">;
+  "display_name_field": FieldKeyOf<TFields, "text">;
+  "brand_field"?: FieldKeyOf<TFields, "text"> | null;
+  "last4_field"?: FieldKeyOf<TFields, "text"> | null;
+  "exp_month_field"?: FieldKeyOf<TFields, "number"> | null;
+  "exp_year_field"?: FieldKeyOf<TFields, "number"> | null;
+  "bank_name_field"?: FieldKeyOf<TFields, "text"> | null;
+};
+
+/** Price: Configure this resource as product pricing records with an amount and billing cadence */
+export type PriceCapabilitySettings<TFields> = {
+  "product_field": FieldKeyOf<TFields, "relation">;
+  "amount_field": FieldKeyOf<TFields, "money">;
+  "recurrence_field": FieldKeyOf<TFields, "select">;
+};
+
+/** Product: Configure this resource as sellable catalog items that prices and subscriptions can reference */
+export type ProductCapabilitySettings<TFields> = {
+  "name_field": FieldKeyOf<TFields, "text">;
+  "accounting_entity_field"?: FieldKeyOf<TFields, "wallet_accounting_entity"> | null;
+  "revenue_account_field"?: FieldKeyOf<TFields, "wallet_accounting_account"> | null;
+  "description_field"?: FieldKeyOf<TFields, "text"> | null;
+};
+
+/** Refund: Configure this resource as a refund record that reverses part or all of a payment */
+export type RefundCapabilitySettings<TFields> = {
+  "payment_field": FieldKeyOf<TFields, "relation">;
+  "amount_field": FieldKeyOf<TFields, "money">;
+  "currency_field": FieldKeyOf<TFields, "text">;
+  "reason_field"?: FieldKeyOf<TFields, "text"> | null;
+  "status_field": FieldKeyOf<TFields, "select">;
+  "failure_reason_field"?: FieldKeyOf<TFields, "text"> | null;
+  "refunded_at_field": FieldKeyOf<TFields, "datetime">;
+};
+
+/** Revenue accounting: Supply revenue accounts and recognition rules for purchases of this record. Purchase dates are mapped on Itemizable. */
+export type RevenueAccountingCapabilitySettings<TFields> = {
+  "recognition_method_field": FieldKeyOf<TFields, "select">;
+  "revenue_account_field": FieldKeyOf<TFields, "wallet_accounting_account">;
+  "deferred_revenue_account_field"?: FieldKeyOf<TFields, "wallet_accounting_account"> | null;
+};
+
+/** Schedulable: Mark this resource as an availability-bearing participant such as a person, room, event, or ticket type, with an optional capacity that Bookings take from */
+export type SchedulableCapabilitySettings<TFields> = {
+  "color_field"?: FieldKeyOf<TFields, "color"> | null;
+  "name_field"?: FieldKeyOf<TFields, "text"> | null;
+  "capacity_field"?: FieldKeyOf<TFields, "number"> | null;
+  "seats_left_field"?: FieldKeyOf<TFields, "number"> | null;
+  "timezone_field"?: FieldKeyOf<TFields, "text"> | null;
+  "regular_hours_field"?: FieldKeyOf<TFields, "regular_hours"> | null;
+  "hours_within_relation"?: FieldKeyOf<TFields, "relation"> | null;
+  "limits"?: readonly ({
+    "period": "day" | "week" | "month";
+    "max": number;
+    "measure"?: "bookings" | "minutes" | null;
+  })[] | null;
+};
+
+/** Subscription: Configure this resource as a recurring agreement that generates payable invoices each billing period */
+export type SubscriptionCapabilitySettings<TFields> = {
+  "payer_field": FieldKeyOf<TFields, "relation">;
+  "status_field": FieldKeyOf<TFields, "select">;
+  "collection_method_field": FieldKeyOf<TFields, "select">;
+  "interval_field"?: FieldKeyOf<TFields, "select"> | null;
+  "started_at_field": FieldKeyOf<TFields, "datetime">;
+  "activated_at_field"?: FieldKeyOf<TFields, "datetime"> | null;
+  "current_period_start_field": FieldKeyOf<TFields, "datetime">;
+  "current_period_end_field": FieldKeyOf<TFields, "datetime">;
+  "next_invoice_at_field": FieldKeyOf<TFields, "datetime">;
+  "canceled_at_field"?: FieldKeyOf<TFields, "datetime"> | null;
+  "cancel_at_period_end_field"?: FieldKeyOf<TFields, "boolean"> | null;
+  "latest_invoice_field"?: FieldKeyOf<TFields, "relation"> | null;
+  "periods_field"?: FieldKeyOf<TFields, "relation"> | null;
+  "grace_period_days_field"?: FieldKeyOf<TFields, "number"> | null;
+  "activation_policy_field"?: FieldKeyOf<TFields, "select"> | null;
+  "initial_term_anchor_field"?: FieldKeyOf<TFields, "select"> | null;
+  "initial_payment_window_days_field"?: FieldKeyOf<TFields, "number"> | null;
+  "trial_started_at_field"?: FieldKeyOf<TFields, "datetime"> | null;
+  "trial_ends_at_field"?: FieldKeyOf<TFields, "datetime"> | null;
+  "trial_payment_method_policy_field"?: FieldKeyOf<TFields, "select"> | null;
+  "lapse_billing_behavior_field"?: FieldKeyOf<TFields, "select"> | null;
+  "billing_cycle_mode_field"?: FieldKeyOf<TFields, "select"> | null;
+  "billing_anchor_month_field"?: FieldKeyOf<TFields, "number"> | null;
+  "billing_anchor_day_field"?: FieldKeyOf<TFields, "number"> | null;
+  "billing_timezone_field"?: FieldKeyOf<TFields, "text"> | null;
+  "accounting_entity_field"?: FieldKeyOf<TFields, "wallet_accounting_entity"> | null;
+  "period_planning_lead_days"?: number | null;
+  "default_billing_cycle_mode"?: "anniversary" | "calendar_aligned" | null;
+  "default_billing_anchor_month"?: number | null;
+  "default_billing_anchor_day"?: number | null;
+  "default_billing_timezone"?: string | null;
+  "allowed_billing_anchors"?: readonly ({
+    "month": number;
+    "day": number;
+  })[] | null;
+  "default_activation_policy"?: "after_first_payment" | "immediate" | null;
+  "default_initial_term_anchor"?: "first_payment_at" | "subscription_created_at" | null;
+  "default_initial_payment_window_days"?: number | null;
+  "default_trial_days"?: number | null;
+  "default_trial_payment_method_policy"?: "optional" | "required" | null;
+  "default_grace_period_days"?: number | null;
+  "default_lapse_billing_behavior"?: "continue_billing" | "suspend_renewals" | "cancel" | null;
+};
+
+/** Subscription Discount: Apply a discount to the first invoice, every invoice, or one billing period of a subscription */
+export type SubscriptionDiscountCapabilitySettings<TFields> = {
+  "subscription_field": FieldKeyOf<TFields, "relation">;
+  "status_field": FieldKeyOf<TFields, "select">;
+  "duration_field": FieldKeyOf<TFields, "select">;
+  "calculation_type_field": FieldKeyOf<TFields, "select">;
+  "percent_field"?: FieldKeyOf<TFields, "number"> | null;
+  "fixed_amount_field"?: FieldKeyOf<TFields, "money"> | null;
+  "description_field": FieldKeyOf<TFields, "text">;
+  "period_start_field"?: FieldKeyOf<TFields, "date"> | null;
+};
+
+/** Subscription Item: Configure this resource as a recurring line in a subscription that renews each billing period */
+export type SubscriptionItemCapabilitySettings<TFields> = {
+  "subscription_field": FieldKeyOf<TFields, "relation">;
+  "price_field": FieldKeyOf<TFields, "relation">;
+  "product_field"?: FieldKeyOf<TFields, "relation"> | null;
+  "quantity_field"?: FieldKeyOf<TFields, "number"> | null;
+  "price_snapshot_field": FieldKeyOf<TFields, "money">;
+  "description_snapshot_field": FieldKeyOf<TFields, "text">;
+  "starts_at_field"?: FieldKeyOf<TFields, "datetime"> | null;
+  "ends_at_field"?: FieldKeyOf<TFields, "datetime"> | null;
+  "status_field": FieldKeyOf<TFields, "select">;
+};
+
+/** Subscription Period: Track a billable subscription period with a stable identity. */
+export type SubscriptionPeriodCapabilitySettings<TFields> = {
+  "subscription_field": FieldKeyOf<TFields, "relation">;
+  "billing_key_field": FieldKeyOf<TFields, "text">;
+  "kind_field": FieldKeyOf<TFields, "select">;
+  "period_start_field": FieldKeyOf<TFields, "datetime">;
+  "period_end_field": FieldKeyOf<TFields, "datetime">;
+  "lifecycle_field": FieldKeyOf<TFields, "select">;
+  "primary_invoice_field": FieldKeyOf<TFields, "relation">;
+  "superseded_by_field": FieldKeyOf<TFields, "relation">;
+};
+
+/** The capabilities of a resource. A field reference names a field of the resource by its key. */
+export type ResourceCapabilities<TFields> = {
+  authenticatable?: AuthenticatableCapabilitySettings<TFields>;
+  availability?: AvailabilityCapabilitySettings<TFields>;
+  booking?: BookingCapabilitySettings<TFields>;
+  eventable?: EventableCapabilitySettings<TFields>;
+  itemizable?: ItemizableCapabilitySettings<TFields>;
+  lockable?: LockableCapabilitySettings<TFields>;
+  notifiable?: NotifiableCapabilitySettings<TFields>;
+  payable?: PayableCapabilitySettings<TFields>;
+  payable_adjustment?: PayableAdjustmentCapabilitySettings<TFields>;
+  payer?: PayerCapabilitySettings<TFields>;
+  payer_balance_entry?: PayerBalanceEntryCapabilitySettings<TFields>;
+  payment?: PaymentCapabilitySettings<TFields>;
+  payment_method?: PaymentMethodCapabilitySettings<TFields>;
+  price?: PriceCapabilitySettings<TFields>;
+  product?: ProductCapabilitySettings<TFields>;
+  refund?: RefundCapabilitySettings<TFields>;
+  revenue_accounting?: RevenueAccountingCapabilitySettings<TFields>;
+  schedulable?: SchedulableCapabilitySettings<TFields>;
+  subscription?: SubscriptionCapabilitySettings<TFields>;
+  subscription_discount?: SubscriptionDiscountCapabilitySettings<TFields>;
+  subscription_item?: SubscriptionItemCapabilitySettings<TFields>;
+  subscription_period?: SubscriptionPeriodCapabilitySettings<TFields>;
+};