@storecraft/database-sql-base/types.sql.tables.d.ts

Official SQL Database driver for storecraft

import { 
  AttributeType, AuthUserType, Role, TagType, 
  CollectionType, ProductType, ShippingMethodType,
  VariantOption, PostType, CustomerType,
  VariantOptionSelection, OrderData, StorefrontType,
  AddressType, ImageType, OrderContact,
  LineItem, OrderStatus, DiscountType,
  PricingData, ValidationEntry,
  OrderPaymentGatewayData, NotificationType,
  NotificationAction, DiscountInfo,
  DiscountApplicationEnum
} from '@storecraft/core/api'
import {
  ColumnType,
  Generated,
  JSONColumnType,
} from 'kysely'

export interface Database {
  auth_users: AuthUserTypeTable,
  tags: TagsTable
  chats: ChatsTable
  collections: CollectionsTable,
  shipping_methods: ShippingMethodsTable;
  posts: PostsTable;
  customers: CustomersTable;
  orders: OrdersTable;
  notifications: NotificationsTable;
  images: ImagesTable;
  discounts: DiscountsTable;
  templates: TemplatesTable;

  storefronts: StorefrontsTable;
  storefronts_to_other: storefronts_to_other;

  products: ProductsTable,
  products_to_collections: products_to_collections;
  products_to_discounts: products_to_discounts;
  products_to_variants: products_to_variants;
  products_to_related_products: products_to_related_products;
  
  entity_to_media: entity_to_media,
  entity_to_tags_projections: entity_to_tags_projections,
  entity_to_search_terms: entity_to_search_terms,
}

export interface entity_to_value {
  id: Generated<number>,
  /** The entity ID */
  entity_id: string,
  /** The entity handle */
  entity_handle: string | undefined,
  /** The value reported */
  value: string
  /** reporter is a segmentation technique, it adds another dimension.
   *  If reporter is `null`, then it means the `entity_id` was the reporter */
  reporter: string | undefined;
  /** The context of the values */
  context: string | undefined;
}

export interface entity_to_media extends entity_to_value {}

/**
 * **Here**:
 * - (`entity_id`, `entity_handle`) = (entity id, entity handle) of the resource for example (product id, product handle)
 * - (`value`) = search term , for example 'game', 'shoes'
 * - (`context`) = the resource name `tags` / `collections` / `products` / `posts` / `discounts` / `shipping` / `storefronts` / `notifications` / 'auth_users' etc...)
 * 
 * **Note**:
 * - `entity_id` ALWAYS IDENTIFIES THE ENTITY
 * - `entity_handle` DOES NOT IDENTIFY (imagine a product and collection with same handle)
 * - `entity_handle` + `context` ALWAYS IDENTIFIES AN ENTITY
 */
export interface entity_to_search_terms extends entity_to_value {}

/**
 * Here:
 * - (`entity_id`, `entity_handle`) = (entity id, entity handle) of the resource for example (product id, product handle)
 * - (`value`) = search term , for example 'game', 'shoes'
 * - (`context`) = the resource name `tags` / `collections` / `products` / `posts` / `discounts` / `shipping` / `storefronts` / `notifications` / 'auth_users' etc...)
 * 
 * Note:
 * - `entity_id` ALWAYS IDENTIFIES AN ENTITY
 * - `entity_handle` DOES NOT IDENTIFY AN ENTITY (imagine a product and collection with same handle)
 * - `entity_handle` + `context` ALWAYS IDENTIFIES AN ENTITY
 */
export interface entity_to_tags_projections extends entity_to_value {}

/**
 * here:
 * - (`entity_id`, `entity_handle`) = (product id, product handle)
 * - (`value`, `reporter`) = (collection id, collection handle)
 * - (`context`) = NULL
 * 
 * NOTE:
 * - `entity_id` ALWAYS IDENTIFIES AN ENTITY
 * - `entity_handle` ALWAYS IDENTIFIES AN ENTITY
 * - `value` ALWAYS IDENTIFIES AN ENTITY
 * - `reporter` ALWAYS IDENTIFIES AN ENTITY
 */
export interface products_to_collections extends entity_to_value {}

/**
 * here:
 * - (`entity_id`, `entity_handle`) = (product id, product handle)
 * - (`value`, `reporter`) = (discount id,  discount handle)
 * 
 * NOTE:
 * - `entity_id` ALWAYS IDENTIFIES AN ENTITY
 * - `entity_handle` ALWAYS IDENTIFIES AN ENTITY
 * - `value` ALWAYS IDENTIFIES AN ENTITY
 * - `reporter` ALWAYS IDENTIFIES AN ENTITY
 */
export interface products_to_discounts extends entity_to_value {}

/**
 * here:
 * - (`entity_id`, `entity_handle`) = (parent product id, parent product handle)
 * - (`value`, `reporter`) = (variant product id,  variant product handle)
 * 
 * NOTE:
 * - `entity_id` ALWAYS IDENTIFIES AN ENTITY
 * - `entity_handle` ALWAYS IDENTIFIES AN ENTITY
 * - `value` ALWAYS IDENTIFIES AN ENTITY
 * - `reporter` ALWAYS IDENTIFIES AN ENTITY
 */
export interface products_to_variants extends entity_to_value {}

/**
 * here:
 * - (`entity_id`, `entity_handle`) = (parent product id, parent product handle)
 * - (`value`, `reporter`) = (related product id, related product handle)
 * 
 * NOTE:
 * - `entity_id` ALWAYS IDENTIFIES AN ENTITY
 * - `entity_handle` ALWAYS IDENTIFIES AN ENTITY
 * - `value` ALWAYS IDENTIFIES AN ENTITY
 * - `reporter` ALWAYS IDENTIFIES AN ENTITY
 */
export interface products_to_related_products extends entity_to_value {}

/**
 * storefronts to products/collections/posts/discounts/shipping
 * here:
 * - (entity_id, entity_handle) = (storefront id, storefront handle)
 * - (value, reporter) = (other entity id,  other entity handle), i.e(product_id, product_handle)
 * - (context) = `products` / `collections` / `posts` / `discounts` / `shipping`
 * 
 * This will probably be a small table hence everything is recorded in the same table.
 * Usually, a user will have:
 * - small number of storefronts
 * - small number of attached products/collections/posts/discounts/shipping per storefront
 * 
 * NOTE:
 * - `entity_id` ALWAYS IDENTIFIES AN ENTITY
 * - `entity_handle` ALWAYS IDENTIFIES AN ENTITY
 * - `value` ALWAYS IDENTIFIES AN ENTITY
 * - `reporter` DOES NOT IDENTIFY AN ENTITY (because you can have a product and a collection with the same handle for example)
 * - `reporter` + `context` ALWAYS IDENTIFIES AN ENTITY (in case you need to delete)
 */
export interface storefronts_to_other extends entity_to_value {}


export interface Base {
  attributes: JSONColumnType<AttributeType[] | undefined>;
  description: ColumnType<string | undefined>;
  active: ColumnType<number | undefined>;
  created_at: ColumnType<string>;
  updated_at: ColumnType<string>;
  id: string;
  handle: string;
}

export interface AuthUserTypeTable extends Base {
  email: string;
  password: string;
  confirmed_mail: number;
  roles: JSONColumnType<Role[]>;
  firstname: string;
  lastname: string;
}

export interface TagsTable extends Base {
  values: JSONColumnType<string[]>;
}

export interface ChatsTable extends Base {
  customer_id: string;
  customer_email: string;
  extra: JSONColumnType<object>;
}

export interface CollectionsTable extends Base {
  title: string;
  published: string | undefined;
}

export interface TemplatesTable extends Base {
  template_subject?: string;
  template_html?: string;
  template_text?: string;
  reference_example_input?: JSONColumnType<object>;
  title: string;
}

export interface ProductsTable extends Base {
  title: string;
  video: string;
  price: number;
  isbn: string;
  qty: number;
  compare_at_price: number;
  variants_options: JSONColumnType<VariantOption[]>;
  //for variant children
  parent_handle: string;
  parent_id: string;
  variant_hint: JSONColumnType<VariantOptionSelection[]>;
}

export interface ShippingMethodsTable extends Base {
  title: string;
  price: number;
}

export interface PostsTable extends Base {
  title: string;
  text: string;
}

export interface CustomersTable extends Base {
  auth_id: string;
  firstname: string;
  lastname: string;
  email: string;
  phone_number: string;
  address: JSONColumnType<AddressType>;
}

export interface OrdersTable extends Base {
  /** buyer info */
  contact: JSONColumnType<OrderContact>;
  /** shipping address info */
  address: JSONColumnType<AddressType>;
  /** line items is a list of the purchased products */
  line_items: JSONColumnType<LineItem[]>;
  /** notes for the order */
  notes: string; 
  /** shipping method info */
  shipping_method: JSONColumnType<ShippingMethodType>; 
  /** status of checkout, fulfillment and payment */
  status: JSONColumnType<OrderStatus>; 
  /** pricing information */
  pricing: JSONColumnType<PricingData>;
  /** in case the order went through validation  */
  validation: JSONColumnType<ValidationEntry[]>;
  /** payment gateway info and status */
  payment_gateway: JSONColumnType<OrderPaymentGatewayData>; 
  /** a list of manual coupons snapshots that were used */
  coupons: JSONColumnType<DiscountType[]>; 
  /** Internal for querying */
  _customer_id: string;
  _customer_email: string;
  _status_payment_id: number;
  _status_checkout_id: number;
  _status_fulfillment_id: number;
}

export interface StorefrontsTable extends Base {
  /** readable title */
  title: string;
  /** video url */
  video: string;
  /** exported storefront json */
  published: string;
}

export interface NotificationsTable extends Base {
  /** message of notification, can be markdown, markup or plain text */
  message: string;
  /** author of the notification */
  author: string;
  /** list of actions */
  actions: JSONColumnType<NotificationAction[]>;
  // for local usage as well
  search: JSONColumnType<string[]>; 
}

export interface ImagesTable extends Base {
  name: string;
  url: string;
}

export interface DiscountsTable extends Base {
  /** title */
  title: string;
  /** discount code */
  handle: string;
  priority: number;
  /** the collection handle that contains the applicable discount products */
  published?: string;
  /** details and filters of the discount */
  info: JSONColumnType<DiscountInfo>;
  /** discount application (automatic and coupons) */
  application: JSONColumnType<DiscountApplicationEnum[keyof DiscountApplicationEnum]>;
  /** internal usage, the application type id */
  _application_id: number;
  /** internal usage, the discount type id */
  _discount_type_id: number;
}