@spacemade/ui 0.0.1

package/src/store/model/product-plan.model.ts

@@ -0,0 +1,120 @@
+// src/store/model/product-plan.ts
+
+import { EntityStatus, Product } from '@store/model' // if this is circular, split shared enums
+
+/** Usage tiers (read model) */
+export interface ProductPlanUsageTier {
+  id: string
+  productPlanId: string
+  rank: number
+  firstUnit: number            // computed/maintained server-side
+  lastUnit: number | null      // null = infinity
+  unitAmount: number           // $ per unit
+  flatFee: number | null       // optional $ per block
+  createdAt: string
+  updatedAt: string
+}
+
+export enum ProductPlanType {
+  Recurring = 'recurring',
+  OneTime = 'one_time',
+}
+
+export enum ProductPlanBillingPeriod {
+  Daily = 'day',
+  Weekly = 'week',
+  Monthly = 'month',
+  Yearly = 'year',
+}
+
+export enum ProductPlanPricingModel {
+  Fixed = 'fixed',
+  Usage = 'usage',
+}
+
+export enum ProductPlanBillingUnitType {
+  Agent = 'agent',
+  Request = 'request',
+  InputToken = 'input-token',
+  OutputToken = 'output-token',
+  User = 'user',
+  Second = 'second',
+}
+
+/** Plan (read model) */
+export interface ProductPlan {
+  id: string
+  slug: string
+  name: string
+  status: EntityStatus
+  description: string | null
+
+  /** Price id representing the plan’s base price (not per-feature overage) */
+  stripePriceId: string | null
+  /** Optional meter for plan-level usage pricing (tiers), not per-feature */
+  stripeMeterId: string | null
+
+  rank: number
+  amount: number
+  type: ProductPlanType
+  billingPeriod: ProductPlanBillingPeriod
+  pricingModel: ProductPlanPricingModel
+  billingUnitType: ProductPlanBillingUnitType | null
+  isDefaultPlanForUsers: boolean
+  updatedAt: string
+  createdAt: string
+  productId: string
+  product?: Product
+
+  // Plan-managed usage tiers
+  usageTiers?: ProductPlanUsageTier[]
+}
+
+/** Plan (write/upsert payload) */
+export interface ProductPlanPayload {
+  id?: string
+  slug?: string
+  name?: string
+  status?: EntityStatus
+  description?: string
+  rank?: number
+  amount?: number
+  type?: ProductPlanType
+  billingPeriod?: ProductPlanBillingPeriod
+  pricingModel?: ProductPlanPricingModel
+  billingUnitType?: ProductPlanBillingUnitType | null
+  stripeMeterId?: string | null
+  stripePriceId?: string | null
+  isDefaultPlanForUsers?: boolean
+  productId?: string
+
+  // Usage tiers upsert
+  usageTiers?: Array<{
+    rank: number
+    firstUnit?: number
+    lastUnit: number | null
+    unitAmount: number
+    flatFee?: number | null
+  }>
+}
+
+export const PRODUCT_PLAN_TYPE_LABEL_MAP = {
+  [ProductPlanType.Recurring]: {
+    label: 'Recurring',
+    description: 'Charge an ongoing fee',
+  },
+  [ProductPlanType.OneTime]: {
+    label: 'One Time',
+    description: 'Charge a one-time fee',
+  },
+}
+
+export function getKeyFromProductPlanBillingPeriodValue(value: string): string | undefined {
+  const keys = Object.keys(ProductPlanBillingPeriod)
+  for (const key of keys) {
+    if (ProductPlanBillingPeriod[key as keyof typeof ProductPlanBillingPeriod] === value) {
+      return key
+    }
+  }
+  return undefined
+}

package/src/store/model/product-version.model.ts

@@ -0,0 +1,24 @@
+import type { Product } from '@store/model/product.model'
+
+export enum ProductVersionStatus {
+  Draft = 'draft',
+  Active = 'active',
+  Deprecated = 'deprecated',
+}
+
+export interface ProductVersion {
+  id: string
+  productId: string
+  product?: Product
+  name: string
+  description: string
+  resourceUrl: string | null
+  resourceSpec: string | null
+  resourceParams: string | null
+  versionStatus: ProductVersionStatus
+  rank: number
+  createdAt: string
+  updatedAt: string
+}
+
+export type ProductVersionPayload = Partial<ProductVersion>

package/src/store/model/product.model.ts

@@ -0,0 +1,91 @@
+// src/store/model/product.ts
+
+import { EntityStatus, MediaAttachment, ProductPlan } from '@store/model'
+import type { ProductFeatureEntitlement } from '@store/model/product-feature-entitlement'
+import type { ProductVersion } from '@store/model/product-version.model'
+
+export interface Product {
+  id: string
+  productId?: string
+  slug: string
+  name: string
+  status: EntityStatus
+  type: ProductType
+  intro: string | null
+  formSpecs: Record<string, unknown> | Record<string, unknown>[] | null
+  screenshots?: MediaAttachment[]
+  description: string | null
+  stripeProductId: string
+  rank: number
+  productIconMediaId: string
+  productIconMedia?: MediaAttachment | null
+
+  /** Plans remain, but no longer contain feature joins */
+  plans?: ProductPlan[]
+  versions?: ProductVersion[]
+
+  /** 🔵 NEW: product-level feature entitlements */
+  featureEntitlements?: ProductFeatureEntitlement[]
+
+  updatedAt: string
+  createdAt: string
+  isPublic: boolean
+  isSubscribed: boolean | null
+  deletionStatus?: {
+    canDelete: boolean
+    message: string
+  }
+}
+
+export interface ProductPayload {
+  id?: string
+  slug?: string
+  name?: string
+  status?: EntityStatus
+  description?: string
+  rank?: number
+  productIconMediaId?: string
+  screenshotMediaIds?: string[]
+  type?: ProductType
+  intro?: string
+  formSpecs?: Record<string, unknown> | Record<string, unknown>[]
+
+  /** Optional: upsert product-level entitlements alongside product */
+  featureEntitlements?: Array<{
+    id?: string | null
+    featureId: string
+    slug?: string
+    isEnabled: boolean
+    includedUnits: number | null
+    /** DECIMAL(10,4) as string: "2.0000" / "0.0100" */
+    overageUnitAmount: string | null
+    hardCap: boolean
+    stripeMeterId?: string | null
+    stripePriceId?: string | null
+  }>
+}
+
+export enum ProductType {
+  /**
+   * Osirus Specific
+   * App in the system like chat, search, etc.
+   */
+  App = 'app',
+  /**
+   * General
+   * Any standard product that we could sell without any further process in the system. eg T-shirts.
+   */
+  Item = 'item',
+  /**
+   * General
+   * Product with a set of measured units attached to the plans (aka bundles).
+   * Each user subscription is limited to a single plan for this product, users are allowed to upgrade or downgrade among the plans.
+   */
+  Plan = 'plan',
+  /**
+   * General
+   * Designed for per-measured-unit billing, user can purchase the same plans
+   * multiple times to expand their measured unit limits.
+   */
+  AddOn = 'add-on',
+}

package/src/store/model/project-file.model.ts

@@ -0,0 +1,18 @@
+export interface ProjectFile {
+  id: string
+  fileName: string
+  fileStatus: 'completed' | 'pending' | 'failed' | 'ready'
+  fileSizeBytes?: number | null
+  mimeType?: string | null
+  vectorStoreFileId?: string | null
+  user?: {
+    id: string
+    profileMedia?: {
+      media?: {
+        sourceUrl: string
+      }
+    }
+  } | null
+  createdAt: string
+  updatedAt: string
+}

package/src/store/model/project-user-permission.model.ts

@@ -0,0 +1,41 @@
+import { User } from '@store/model'
+import type { OrgGroup } from '@store/model/org-group.model'
+
+export enum ProjectUserRole {
+  admin = 'admin',
+  editor = 'editor',
+  viewer = 'viewer',
+}
+
+export enum ProjectUserPermissionStatus {
+  pending = 'pending',
+  active = 'active',
+}
+
+export interface ProjectUserPermission {
+  id: string
+
+  projectId: string
+  userId?: string
+  orgGroupId?: string
+  invitedByUserId?: string | null
+
+  role: ProjectUserRole
+  status?: ProjectUserPermissionStatus
+  inviteAccepted?: boolean
+  permissionType?: 'user' | 'group'
+
+  createdAt: string
+  updatedAt: string
+
+  user?: User
+  group?: OrgGroup
+  inviter?: User
+}
+
+export interface ProjectUserPermissionPayload {
+  projectId: string
+  userId?: string
+  orgGroupId?: string
+  role: ProjectUserRole
+}

package/src/store/model/project.model.ts

@@ -0,0 +1,48 @@
+import type { User } from '@store/model'
+import type { MediaAttachment } from '@store/model/media.model'
+
+export enum ProjectType {
+  BUSINESS = 'business',
+  PERSONAL = 'personal',
+  FAMILY = 'family',
+  PLEASURE = 'pleasure',
+}
+
+export interface Project {
+  id: string
+  name: string
+  description: string | null
+  instructions: string | null
+  type: ProjectType | string | null
+
+  ownerId: string | null
+  owner?: User | null
+
+  modifiedBy: string | null
+  modifier?: User | null
+
+  providerSettingId?: string | null
+  vectorStoreId?: string | null
+  orgId?: string | null
+
+  featuredMediaId?: string | null
+  featuredMedia?: MediaAttachment | null
+
+  createdAt: string
+  updatedAt: string
+}
+
+export interface ProjectPayload {
+  id?: string
+  name?: string
+  description?: string | null
+  instructions?: string | null
+  type?: ProjectType | null
+
+  providerSettingId?: string | null
+  vectorStoreId?: string | null
+  addProjectStorage?: boolean
+  orgId?: string | null
+
+  featuredMediaId?: string | null
+}

package/src/store/model/provider.model.ts

@@ -0,0 +1,118 @@
+import { MediaAttachment } from '@store/model'
+import type { ComponentType } from 'react'
+
+/**
+ * Enum representing supported model providers.
+ * Keys match backend identifiers (snake/lowercase)
+ */
+export enum ProviderKey {
+  AWS = 'aws',
+  Anthropic = 'anthropic',
+  HuggingFace = 'huggingface',
+  OpenAI = 'openai',
+  Google = 'google',
+  Nvidia = 'nvidia',
+  Custom = 'custom',
+}
+
+/**
+ * Allowed provider statuses.
+ */
+export type ProviderStatus = 'active' | 'disabled' | 'deprecated'
+
+/**
+ * Represents a model provider entity in the system.
+ * (Parity with Post entity)
+ */
+export interface ModelProviderEntity {
+  id: string
+  key: ProviderKey | string
+  label: string
+  status: ProviderStatus
+  rank?: number
+  description?: string | null
+  websiteUrl?: string | null
+  isFeatured: boolean
+  isHidden?: boolean
+  featuredMediaId?: string | null
+  featuredMedia?: MediaAttachment | null
+  iconMediaId?: string | null
+  iconMedia?: MediaAttachment | null
+  hasStorage?: boolean
+  hasAgent?: boolean
+  hasProject?: boolean
+  hasChat?: boolean
+  hasSearch?: boolean
+  hasImage?: boolean
+  hasVideo?: boolean
+  hasModel?: boolean
+  hasSpeech?:boolean
+  createdAt: string
+  updatedAt: string
+}
+
+export interface ModelProviderPayload {
+  id?: string
+  key: ProviderKey | string
+  label: string
+  status?: ProviderStatus
+  rank?: number
+  description?: string
+  websiteUrl?: string
+  isFeatured?: boolean
+  isHidden?: boolean
+  featuredMediaId?: string | null
+
+  iconMediaId?: string | null
+
+  hasStorage?: boolean
+  hasAgent?: boolean
+  hasProject?: boolean
+  hasChat?: boolean
+  hasSearch?: boolean
+  hasImage?: boolean
+  hasVideo?: boolean
+  hasModel?: boolean
+  hasSpeech?:boolean
+}
+
+/**
+ * Mapping of provider key → icon component or path.
+ * Used for fallback/default logos (NOT featured media).
+ */
+export const ProviderIconMap: Record<
+  ProviderKey,
+  string | ComponentType<{ width?: number | string; height?: number | string }>
+> = {
+  [ProviderKey.HuggingFace]: 'huggingface',
+  [ProviderKey.OpenAI]: 'openai',
+  [ProviderKey.AWS]: 'aws',
+  [ProviderKey.Anthropic]: 'anthropic',
+  [ProviderKey.Google]: 'google',
+  [ProviderKey.Nvidia]: 'nvidia',
+  [ProviderKey.Custom]: 'custom',
+}
+
+/**
+ * A user's provider connection/settings
+ */
+export interface UserModelProviderSetting {
+  id: string
+  userId: string
+  providerId: string
+  settings: Record<string, any>
+  isDefault: boolean
+  createdAt: string
+  updatedAt: string
+}
+
+/**
+ * Payload used to create or update user provider settings.
+ */
+export interface UserModelProviderSettingPayload {
+  id?: string
+  userId: string
+  providerId: string
+  settings: Record<string, any>
+  isDefault?: boolean
+}

package/src/store/model/purchase.model.ts

@@ -0,0 +1,19 @@
+import { ProductPlan, User } from '@store/model'
+
+export interface Purchase {
+	id: string
+	stripePaymentId: string
+	status: StripePurchaseStatus
+	createdAt: string
+	updatedAt: string
+	productPlans?: ProductPlan[]
+	userId: string
+	user?: User
+}
+
+export enum StripePurchaseStatus {
+	Succeeded = 'succeeded',
+	AmountCapturableUpdated = 'amount_capturable_updated',
+	PaymentFailed = 'payment_failed',
+	Processing = 'processing',
+}

package/src/store/model/site-crawl-job.model.ts

@@ -0,0 +1,31 @@
+export type SiteCrawlJobStatus = 'pending' | 'running' | 'completed' | 'failed' | 'cancelled'
+
+export interface SiteCrawlJob {
+  id: string
+  siteId: string
+  createdBy?: string | null
+  orgId?: string | null
+  baseUrl: string
+  maxPages: number
+  maxDepth: number
+  pathPattern?: string | null
+  status: SiteCrawlJobStatus
+  pagesFound: number
+  pagesIndexed: number
+  pagesFailed: number
+  errorMessage?: string | null
+  embeddingProvider?: string | null
+  bullJobId?: string | null
+  startedAt?: string | null
+  completedAt?: string | null
+  createdAt: string
+  updatedAt: string
+}
+
+export interface SiteCrawlJobPayload {
+  baseUrl: string
+  maxPages?: number
+  maxDepth?: number
+  pathPattern?: string
+  embeddingProvider?: string
+}

package/src/store/model/site-page.model.ts

@@ -0,0 +1,37 @@
+export type SitePageSource = 'manual' | 'tracker' | 'crawl'
+export type SitePageStatus = 'pending' | 'indexed' | 'stale' | 'failed' | 'excluded'
+
+export interface SitePage {
+  id: string
+  siteId: string
+  ownerId?: string | null
+  crawlJobId?: string | null
+  orgId?: string | null
+  url: string
+  path?: string | null
+  title?: string | null
+  contentLlm?: string | null
+  metaDescription?: string | null
+  wordCount?: number | null
+  source: SitePageSource
+  status: SitePageStatus
+  lastError?: string | null
+  lastCrawledAt?: string | null
+  createdAt: string
+  updatedAt: string
+}
+
+export interface SitePagePayload {
+  url: string
+  title?: string
+  source?: SitePageSource
+}
+
+export interface SitePageUpdatePayload {
+  id: string
+  siteId: string
+  url?: string
+  title?: string
+  status?: SitePageStatus
+  contentLlm?: string
+}

package/src/store/model/site.model.ts

@@ -0,0 +1,15 @@
+import { User } from '@store/model'
+
+export interface Site {
+	id: string
+	name: string
+	updatedAt: string
+	createdAt: string
+	userId: string
+	user?: User
+}
+
+export interface SitePayload {
+	id: string
+	name: string
+}

package/src/store/model/subscription.model.ts

@@ -0,0 +1,60 @@
+import { ProductPlan } from '@store/model'
+
+export interface Subscription {
+  id: string
+  stripeSubscriptionId: string
+  subscriptionItemId: string
+  status: StripeSubscriptionStatus
+  emailInvoice: boolean
+
+  currentPeriodEnd: number | null
+  amount: number | null
+  billingCycle: string | null
+
+  // 🔹 New: scheduled cancel date (ISO string from API)
+  cancelAt: string | null
+
+  // already existed – kept for compatibility
+  cancelAtPeriodEnd: boolean | null
+
+  createdAt: string
+  updatedAt: string
+  productPlans?: ProductPlan[]
+  userId: string
+  isDefaultSubscription?: boolean
+}
+
+export enum StripeSubscriptionStatus {
+  Incomplete = 'incomplete',
+  IncompleteExpired = 'incomplete_expired',
+  Trialing = 'trialing',
+  Active = 'active',
+  PastDue = 'past_due',
+  Canceled = 'canceled',
+  Unpaid = 'unpaid',
+}
+
+export enum PaymentMethodCardType {
+  Amex = 'amex',
+  Mastercard = 'mastercard',
+  Visa = 'visa',
+  Discover = 'discover',
+  Diners = 'diners',
+  EftposAu = 'eftpos_au',
+  Jcb = 'jcb',
+  Unionpay = 'unionpay',
+  Unknown = 'unknown',
+}
+
+export const getIconFromPaymentMethodCardType = (value: string) => {
+  switch (value) {
+    case PaymentMethodCardType.Amex:
+    case PaymentMethodCardType.Mastercard:
+    case PaymentMethodCardType.Visa:
+    case PaymentMethodCardType.Jcb:
+    case PaymentMethodCardType.Discover:
+      return 'bi bi-credit-card' // all map to generic card
+    default:
+      return 'bi bi-credit-card'
+  }
+}

package/src/store/model/tag.model.ts

@@ -0,0 +1,18 @@
+import { Post } from '@store/model'
+
+export interface Tag {
+	id: string
+	slug: string
+	name: string
+	adsCount: number
+	postsCount: number
+	productsCount: number
+	totalCount: number
+	posts?: Post[]
+}
+
+export interface TagPayload {
+	id?: string
+	slug?: string
+	name?: string
+}

package/src/store/model/user-permission.model.ts

@@ -0,0 +1,21 @@
+export type PermissionRole = 'admin' | 'editor' | 'viewer' | 'none' | 'custom'
+export type PermissionAction = 'read' | 'create' | 'update' | 'delete'
+
+export interface UserPermissionRow {
+  id: string
+  userId: string
+  orgId: string              
+  appKey: string
+  action: string
+  allowed: boolean
+  role?: PermissionRole | string | null 
+  createdAt: string
+  updatedAt: string
+}
+
+export interface UserPermissionBundle {
+  permissions: UserPermissionRow[]
+  directPermissions: UserPermissionRow[]
+  groupPermissions: UserPermissionRow[]
+  groupPermissionsByGroup: Array<{ groupId: string; permissions: UserPermissionRow[] }>
+}