@devx-retailos/cms 0.0.1

package/src/modules/cms/__tests__/cms-module-service.test.ts

@@ -0,0 +1,333 @@
+import { describe, it, expect, vi, beforeEach } from "vitest"
+import { createNoopLogger } from "@devx-retailos/core"
+import CmsModuleService from "../services/cms-module-service"
+
+// Test subclass that overrides all MedusaService base CRUD methods
+class TestCmsService extends (CmsModuleService as any) {
+  createCmsHandovers = vi.fn()
+  listCmsHandovers = vi.fn()
+  listAndCountCmsHandovers = vi.fn()
+  retrieveCmsHandover = vi.fn()
+  createCmsAccumulations = vi.fn()
+  listCmsAccumulations = vi.fn()
+  updateCmsAccumulations = vi.fn()
+  createPettyCashes = vi.fn()
+  listPettyCashes = vi.fn()
+  updatePettyCashes = vi.fn()
+  createPettyCashTransactions = vi.fn()
+  listPettyCashTransactions = vi.fn()
+
+  constructor() {
+    // Skip super() to avoid MedusaService container requirement
+    // We directly set the logger instead
+    Object.defineProperty(TestCmsService.prototype, "__skip_super__", { value: true })
+    try {
+      super({ logger: createNoopLogger() }, {}, {})
+    } catch {
+      // ignore container errors in test env
+    }
+    this.logger_ = createNoopLogger()
+  }
+}
+
+function makeService(): TestCmsService {
+  return new TestCmsService()
+}
+
+describe("CmsModuleService.dayStart", () => {
+  it("creates accumulation when none exists", async () => {
+    const service = makeService()
+    service.listCmsAccumulations.mockResolvedValue([])
+    service.createCmsAccumulations.mockResolvedValue([{ id: "cmsa_1", store_id: "s1", cash_in_store: 500 }])
+    service.createPettyCashTransactions.mockResolvedValue([{ id: "pct_1" }])
+
+    await service.dayStart({ store_id: "s1", employee_id: "emp_1", opening_amount: 500 })
+
+    expect(service.createCmsAccumulations).toHaveBeenCalledWith([
+      expect.objectContaining({ store_id: "s1", cash_in_store: 500 }),
+    ])
+    expect(service.createPettyCashTransactions).toHaveBeenCalledWith([
+      expect.objectContaining({ transaction_type: "open", entry_type: "CR", amount: 500 }),
+    ])
+  })
+
+  it("updates accumulation when already exists", async () => {
+    const service = makeService()
+    service.listCmsAccumulations.mockResolvedValue([{ id: "cmsa_1", store_id: "s1", cash_in_store: 0 }])
+    service.updateCmsAccumulations.mockResolvedValue([])
+    service.createPettyCashTransactions.mockResolvedValue([{ id: "pct_1" }])
+
+    await service.dayStart({ store_id: "s1", employee_id: "emp_1", opening_amount: 1000 })
+
+    expect(service.createCmsAccumulations).not.toHaveBeenCalled()
+    expect(service.updateCmsAccumulations).toHaveBeenCalled()
+  })
+
+  it("throws when opening_amount is negative", async () => {
+    const service = makeService()
+    await expect(
+      service.dayStart({ store_id: "s1", employee_id: "emp_1", opening_amount: -1 })
+    ).rejects.toThrow("opening_amount must be >= 0")
+  })
+})
+
+describe("CmsModuleService.dayEnd", () => {
+  it("records closing transaction with difference", async () => {
+    const service = makeService()
+    service.listCmsAccumulations.mockResolvedValue([{ id: "cmsa_1", store_id: "s1", cash_in_store: 1000 }])
+    service.createPettyCashTransactions.mockResolvedValue([{ id: "pct_2" }])
+
+    await service.dayEnd({ store_id: "s1", employee_id: "emp_1", closing_amount: 800 })
+
+    expect(service.createPettyCashTransactions).toHaveBeenCalledWith([
+      expect.objectContaining({
+        transaction_type: "close",
+        entry_type: "DB",
+        opening_balance: 1000,
+        closing_balance: 800,
+        difference_amount: -200,
+      }),
+    ])
+  })
+
+  it("throws when closing_amount is negative", async () => {
+    const service = makeService()
+    await expect(
+      service.dayEnd({ store_id: "s1", employee_id: "emp_1", closing_amount: -100 })
+    ).rejects.toThrow("closing_amount must be >= 0")
+  })
+})
+
+describe("CmsModuleService.handover", () => {
+  it("creates handover and increases accumulation for CR type", async () => {
+    const service = makeService()
+    service.createCmsHandovers.mockResolvedValue([{ id: "cmsh_1", store_id: "s1", handover_amount: 200, type: "CR" }])
+    service.listCmsAccumulations.mockResolvedValue([{ id: "cmsa_1", store_id: "s1", cash_in_store: 1000 }])
+    service.updateCmsAccumulations.mockResolvedValue([])
+
+    const result = await service.handover({
+      store_id: "s1",
+      employee_id: "emp_1",
+      handover_amount: 200,
+      type: "CR",
+    })
+
+    expect(result).toMatchObject({ id: "cmsh_1" })
+    expect(service.updateCmsAccumulations).toHaveBeenCalledWith([
+      expect.objectContaining({ id: "cmsa_1", cash_in_store: 1200 }),
+    ])
+  })
+
+  it("decreases accumulation for DB type", async () => {
+    const service = makeService()
+    service.createCmsHandovers.mockResolvedValue([{ id: "cmsh_2", store_id: "s1", handover_amount: 300, type: "DB" }])
+    service.listCmsAccumulations.mockResolvedValue([{ id: "cmsa_1", store_id: "s1", cash_in_store: 1000 }])
+    service.updateCmsAccumulations.mockResolvedValue([])
+
+    await service.handover({ store_id: "s1", employee_id: "emp_1", handover_amount: 300, type: "DB" })
+
+    expect(service.updateCmsAccumulations).toHaveBeenCalledWith([
+      expect.objectContaining({ id: "cmsa_1", cash_in_store: 700 }),
+    ])
+  })
+
+  it("throws when handover_amount is negative", async () => {
+    const service = makeService()
+    await expect(
+      service.handover({ store_id: "s1", employee_id: "emp_1", handover_amount: -50 })
+    ).rejects.toThrow("handover_amount must be >= 0")
+  })
+})
+
+describe("CmsModuleService.addPettyCash", () => {
+  it("creates petty cash record and transaction when none exists", async () => {
+    const service = makeService()
+    service.listPettyCashes.mockResolvedValue([])
+    service.createPettyCashes.mockResolvedValue([{ id: "pc_1", store_id: "s1", balance: 500 }])
+    service.createPettyCashTransactions.mockResolvedValue([{ id: "pct_3" }])
+
+    await service.addPettyCash({ store_id: "s1", employee_id: "emp_1", amount: 500 })
+
+    expect(service.createPettyCashes).toHaveBeenCalledWith([
+      expect.objectContaining({ store_id: "s1", balance: 500 }),
+    ])
+    expect(service.createPettyCashTransactions).toHaveBeenCalledWith([
+      expect.objectContaining({ entry_type: "CR", amount: 500 }),
+    ])
+  })
+
+  it("throws when amount is zero or negative", async () => {
+    const service = makeService()
+    await expect(
+      service.addPettyCash({ store_id: "s1", employee_id: "emp_1", amount: 0 })
+    ).rejects.toThrow("amount must be > 0")
+  })
+})
+
+describe("CmsModuleService.addExpense", () => {
+  it("debits petty cash and records transaction", async () => {
+    const service = makeService()
+    service.listPettyCashes.mockResolvedValue([{ id: "pc_1", store_id: "s1", balance: 500 }])
+    service.updatePettyCashes.mockResolvedValue([])
+    service.createPettyCashTransactions.mockResolvedValue([{ id: "pct_4" }])
+
+    await service.addExpense({ store_id: "s1", employee_id: "emp_1", amount: 100, category: "office" })
+
+    expect(service.updatePettyCashes).toHaveBeenCalledWith([
+      expect.objectContaining({ id: "pc_1", balance: 400 }),
+    ])
+    expect(service.createPettyCashTransactions).toHaveBeenCalledWith([
+      expect.objectContaining({ entry_type: "DB", expense_amount: 100, category: "office" }),
+    ])
+  })
+
+  it("throws when expense amount is zero or negative", async () => {
+    const service = makeService()
+    await expect(
+      service.addExpense({ store_id: "s1", employee_id: "emp_1", amount: -10 })
+    ).rejects.toThrow("expense amount must be > 0")
+  })
+})
+
+describe("CmsModuleService.getAccumulation", () => {
+  it("returns accumulation for store", async () => {
+    const service = makeService()
+    service.listCmsAccumulations.mockResolvedValue([{ id: "cmsa_1", store_id: "s1", cash_in_store: 750 }])
+
+    const result = await service.getAccumulation("s1")
+
+    expect(result).toMatchObject({ store_id: "s1", cash_in_store: 750 })
+  })
+
+  it("returns null when no accumulation exists", async () => {
+    const service = makeService()
+    service.listCmsAccumulations.mockResolvedValue([])
+
+    const result = await service.getAccumulation("s1")
+
+    expect(result).toBeNull()
+  })
+})
+
+describe("CmsModuleService.getShiftLogs", () => {
+  it("filters by transaction_type open and close", async () => {
+    const service = makeService()
+    const mockLogs = [
+      { id: "pct_1", transaction_type: "open", store_id: "s1" },
+      { id: "pct_2", transaction_type: "close", store_id: "s1" },
+    ]
+    service.listPettyCashTransactions.mockResolvedValue(mockLogs)
+
+    const result = await service.getShiftLogs({ store_id: "s1" })
+
+    expect(service.listPettyCashTransactions).toHaveBeenCalledWith(
+      expect.objectContaining({ transaction_type: ["open", "close"], store_id: ["s1"] }),
+      expect.any(Object)
+    )
+    expect(result).toHaveLength(2)
+  })
+
+  it("omits store_id filter when not provided", async () => {
+    const service = makeService()
+    service.listPettyCashTransactions.mockResolvedValue([])
+
+    await service.getShiftLogs({})
+
+    expect(service.listPettyCashTransactions).toHaveBeenCalledWith(
+      expect.not.objectContaining({ store_id: expect.anything() }),
+      expect.any(Object)
+    )
+  })
+
+  it("passes custom limit to listPettyCashTransactions", async () => {
+    const service = makeService()
+    service.listPettyCashTransactions.mockResolvedValue([])
+
+    await service.getShiftLogs({ store_id: "s1", limit: 10 })
+
+    expect(service.listPettyCashTransactions).toHaveBeenCalledWith(
+      expect.any(Object),
+      expect.objectContaining({ take: 10 })
+    )
+  })
+})
+
+describe("CmsModuleService.dayEnd - no prior accumulation", () => {
+  it("uses zero as current_cash when no accumulation exists", async () => {
+    const service = makeService()
+    service.listCmsAccumulations.mockResolvedValue([])
+    service.createPettyCashTransactions.mockResolvedValue([{ id: "pct_x" }])
+
+    await service.dayEnd({ store_id: "s1", employee_id: "emp_1", closing_amount: 300 })
+
+    expect(service.createPettyCashTransactions).toHaveBeenCalledWith([
+      expect.objectContaining({
+        opening_balance: 0,
+        closing_balance: 300,
+        difference_amount: 300,
+      }),
+    ])
+  })
+})
+
+describe("CmsModuleService.handover - edge cases", () => {
+  it("creates new accumulation when none exists", async () => {
+    const service = makeService()
+    service.createCmsHandovers.mockResolvedValue([{ id: "cmsh_3", store_id: "s1", handover_amount: 100, type: "CR" }])
+    service.listCmsAccumulations.mockResolvedValue([])
+    service.createCmsAccumulations.mockResolvedValue([])
+
+    await service.handover({ store_id: "s1", employee_id: "emp_1", handover_amount: 100, type: "CR" })
+
+    expect(service.createCmsAccumulations).toHaveBeenCalledWith([
+      expect.objectContaining({ store_id: "s1", cash_in_store: 100 }),
+    ])
+  })
+
+  it("does not change cash when type is null", async () => {
+    const service = makeService()
+    service.createCmsHandovers.mockResolvedValue([{ id: "cmsh_4", store_id: "s1", handover_amount: 50, type: null }])
+    service.listCmsAccumulations.mockResolvedValue([{ id: "cmsa_1", store_id: "s1", cash_in_store: 1000 }])
+    service.updateCmsAccumulations.mockResolvedValue([])
+
+    await service.handover({ store_id: "s1", employee_id: "emp_1", handover_amount: 50, type: null })
+
+    expect(service.updateCmsAccumulations).toHaveBeenCalledWith([
+      expect.objectContaining({ cash_in_store: 1000 }),
+    ])
+  })
+})
+
+describe("CmsModuleService.addPettyCash - update path", () => {
+  it("updates existing petty cash balance", async () => {
+    const service = makeService()
+    service.listPettyCashes.mockResolvedValue([{ id: "pc_1", store_id: "s1", balance: 200 }])
+    service.updatePettyCashes.mockResolvedValue([])
+    service.createPettyCashTransactions.mockResolvedValue([{ id: "pct_5" }])
+
+    await service.addPettyCash({ store_id: "s1", employee_id: "emp_1", amount: 300 })
+
+    expect(service.createPettyCashes).not.toHaveBeenCalled()
+    expect(service.updatePettyCashes).toHaveBeenCalledWith([
+      expect.objectContaining({ id: "pc_1", balance: 500 }),
+    ])
+    expect(service.createPettyCashTransactions).toHaveBeenCalledWith([
+      expect.objectContaining({ opening_balance: 200, closing_balance: 500 }),
+    ])
+  })
+})
+
+describe("CmsModuleService.addExpense - no existing petty cash", () => {
+  it("creates petty cash record when none exists", async () => {
+    const service = makeService()
+    service.listPettyCashes.mockResolvedValue([])
+    service.createPettyCashes.mockResolvedValue([{ id: "pc_new", store_id: "s1", balance: -100 }])
+    service.createPettyCashTransactions.mockResolvedValue([{ id: "pct_6" }])
+
+    await service.addExpense({ store_id: "s1", employee_id: "emp_1", amount: 100 })
+
+    expect(service.createPettyCashes).toHaveBeenCalledWith([
+      expect.objectContaining({ store_id: "s1", balance: -100 }),
+    ])
+  })
+})

package/src/modules/cms/__tests__/permissions.test.ts

@@ -0,0 +1,36 @@
+import { describe, it, expect } from "vitest"
+import { CMS_PERMISSIONS } from "../permissions"
+
+describe("CMS_PERMISSIONS", () => {
+  const EXPECTED_KEYS = [
+    "cms.handover.read",
+    "cms.handover.create",
+    "cms.shift.operate",
+    "cms.petty_cash.read",
+    "cms.petty_cash.operate",
+    "cms.accumulation.read",
+  ]
+
+  it("exports exactly 6 permission keys", () => {
+    expect(CMS_PERMISSIONS).toHaveLength(6)
+  })
+
+  it("contains all required permission keys", () => {
+    const keys = CMS_PERMISSIONS.map((p) => p.key)
+    for (const expected of EXPECTED_KEYS) {
+      expect(keys).toContain(expected)
+    }
+  })
+
+  it("all permissions have registered_by set to 'cms'", () => {
+    for (const p of CMS_PERMISSIONS) {
+      expect(p.registered_by).toBe("cms")
+    }
+  })
+
+  it("all permissions have a non-empty description", () => {
+    for (const p of CMS_PERMISSIONS) {
+      expect(p.description.length).toBeGreaterThan(0)
+    }
+  })
+})

package/src/modules/cms/constants.ts

@@ -0,0 +1 @@
+export const CMS_MODULE = "cms"

package/src/modules/cms/index.ts

@@ -0,0 +1,24 @@
+import { Module } from "@medusajs/framework/utils"
+import { CMS_MODULE } from "./constants"
+import CmsModuleService from "./services/cms-module-service"
+
+export default Module(CMS_MODULE, {
+  service: CmsModuleService,
+})
+
+export { CMS_MODULE } from "./constants"
+export { CmsModuleService } from "./services"
+export type {
+  DayStartInput,
+  DayEndInput,
+  HandoverInput,
+  AddPettyCashInput,
+  AddExpenseInput,
+  ShiftLogFilters,
+  HandoverType,
+  TransactionType,
+  EntryType,
+  PettyCashSource,
+} from "./services"
+export { CMS_PERMISSIONS } from "./permissions"
+export * as models from "./models"

package/src/modules/cms/migrations/Migration20260622000000.ts

@@ -0,0 +1,58 @@
+import { Migration } from "@medusajs/framework/mikro-orm/migrations"
+
+export class Migration20260622000000 extends Migration {
+  override async up(): Promise<void> {
+    this.addSql(
+      `create table if not exists "retailos_cms_handover" ("id" text not null, "store_id" text not null, "employee_id" text not null, "handover_id" text null, "handover_amount" integer null, "total_cash" integer null, "type" text null, "image_url" text null, "remark" text null, "metadata" jsonb null, "created_at" timestamptz not null default now(), "updated_at" timestamptz not null default now(), "deleted_at" timestamptz null, constraint "retailos_cms_handover_pkey" primary key ("id"));`
+    )
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_retailos_cms_handover_store_id" ON "retailos_cms_handover" ("store_id") WHERE deleted_at IS NULL;`
+    )
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_retailos_cms_handover_employee_id" ON "retailos_cms_handover" ("employee_id") WHERE deleted_at IS NULL;`
+    )
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_retailos_cms_handover_deleted_at" ON "retailos_cms_handover" ("deleted_at") WHERE deleted_at IS NULL;`
+    )
+
+    this.addSql(
+      `create table if not exists "retailos_cms_accumulation" ("id" text not null, "store_id" text not null, "cash_in_store" integer not null default 0, "created_at" timestamptz not null default now(), "updated_at" timestamptz not null default now(), "deleted_at" timestamptz null, constraint "retailos_cms_accumulation_pkey" primary key ("id"));`
+    )
+    this.addSql(
+      `CREATE UNIQUE INDEX IF NOT EXISTS "IDX_retailos_cms_accumulation_store_id_unique" ON "retailos_cms_accumulation" ("store_id") WHERE deleted_at IS NULL;`
+    )
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_retailos_cms_accumulation_deleted_at" ON "retailos_cms_accumulation" ("deleted_at") WHERE deleted_at IS NULL;`
+    )
+
+    this.addSql(
+      `create table if not exists "retailos_petty_cash" ("id" text not null, "store_id" text not null, "balance" integer not null default 0, "created_at" timestamptz not null default now(), "updated_at" timestamptz not null default now(), "deleted_at" timestamptz null, constraint "retailos_petty_cash_pkey" primary key ("id"));`
+    )
+    this.addSql(
+      `CREATE UNIQUE INDEX IF NOT EXISTS "IDX_retailos_petty_cash_store_id_unique" ON "retailos_petty_cash" ("store_id") WHERE deleted_at IS NULL;`
+    )
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_retailos_petty_cash_deleted_at" ON "retailos_petty_cash" ("deleted_at") WHERE deleted_at IS NULL;`
+    )
+
+    this.addSql(
+      `create table if not exists "retailos_petty_cash_transaction" ("id" text not null, "store_id" text not null, "employee_id" text not null, "transaction_type" text not null, "entry_type" text null, "source" text null, "amount" integer not null default 0, "opening_balance" integer null, "closing_balance" integer null, "expense_amount" integer not null default 0, "difference_amount" integer not null default 0, "category" text null, "sub_category" text null, "reason" text null, "image_url" text null, "date" timestamptz null, "metadata" jsonb null, "created_at" timestamptz not null default now(), "updated_at" timestamptz not null default now(), "deleted_at" timestamptz null, constraint "retailos_petty_cash_transaction_pkey" primary key ("id"));`
+    )
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_retailos_petty_cash_transaction_store_id" ON "retailos_petty_cash_transaction" ("store_id") WHERE deleted_at IS NULL;`
+    )
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_retailos_petty_cash_transaction_type" ON "retailos_petty_cash_transaction" ("transaction_type") WHERE deleted_at IS NULL;`
+    )
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_retailos_petty_cash_transaction_deleted_at" ON "retailos_petty_cash_transaction" ("deleted_at") WHERE deleted_at IS NULL;`
+    )
+  }
+
+  override async down(): Promise<void> {
+    this.addSql(`drop table if exists "retailos_petty_cash_transaction" cascade;`)
+    this.addSql(`drop table if exists "retailos_petty_cash" cascade;`)
+    this.addSql(`drop table if exists "retailos_cms_accumulation" cascade;`)
+    this.addSql(`drop table if exists "retailos_cms_handover" cascade;`)
+  }
+}

package/src/modules/cms/migrations/Migration20260622000001.ts

@@ -0,0 +1,17 @@
+import { Migration } from "@medusajs/framework/mikro-orm/migrations"
+
+export class Migration20260622000001 extends Migration {
+  override async up(): Promise<void> {
+    this.addSql(
+      `alter table if exists "retailos_cms_accumulation" add column if not exists "metadata" jsonb null;`
+    )
+    this.addSql(
+      `alter table if exists "retailos_petty_cash" add column if not exists "metadata" jsonb null;`
+    )
+  }
+
+  override async down(): Promise<void> {
+    this.addSql(`alter table if exists "retailos_cms_accumulation" drop column if exists "metadata";`)
+    this.addSql(`alter table if exists "retailos_petty_cash" drop column if exists "metadata";`)
+  }
+}

package/src/modules/cms/models/cms-accumulation.ts

@@ -0,0 +1,10 @@
+import { model } from "@medusajs/framework/utils"
+
+const CmsAccumulation = model.define("retailos_cms_accumulation", {
+  id: model.id({ prefix: "cmsa" }).primaryKey(),
+  store_id: model.text().searchable(),
+  cash_in_store: model.number(),
+  metadata: model.json().nullable(),
+})
+
+export default CmsAccumulation

package/src/modules/cms/models/cms-handover.ts

@@ -0,0 +1,16 @@
+import { model } from "@medusajs/framework/utils"
+
+const CmsHandover = model.define("retailos_cms_handover", {
+  id: model.id({ prefix: "cmsh" }).primaryKey(),
+  store_id: model.text().searchable(),
+  employee_id: model.text().searchable(),
+  handover_id: model.text().nullable(), // free-text correlation field: the brand can pass their own ID (e.g. a bank slip number, a vault reference, a POS transaction ID) so they can cross-reference this handover record with their own external system.
+  handover_amount: model.number().nullable(),
+  total_cash: model.number().nullable(),
+  type: model.text().nullable(),
+  image_url: model.text().nullable(),
+  remark: model.text().nullable(),
+  metadata: model.json().nullable(),
+})
+
+export default CmsHandover

package/src/modules/cms/models/index.ts

@@ -0,0 +1,4 @@
+export { default as CmsHandover } from "./cms-handover"
+export { default as CmsAccumulation } from "./cms-accumulation"
+export { default as PettyCash } from "./petty-cash"
+export { default as PettyCashTransaction } from "./petty-cash-transaction"

package/src/modules/cms/models/petty-cash-transaction.ts

@@ -0,0 +1,23 @@
+import { model } from "@medusajs/framework/utils"
+
+const PettyCashTransaction = model.define("retailos_petty_cash_transaction", {
+  id: model.id({ prefix: "pct" }).primaryKey(),
+  store_id: model.text().searchable(),
+  employee_id: model.text().searchable(),
+  transaction_type: model.text(),
+  entry_type: model.text().nullable(),
+  source: model.text().nullable(),
+  amount: model.number(),
+  opening_balance: model.number().nullable(),
+  closing_balance: model.number().nullable(),
+  expense_amount: model.number(),
+  difference_amount: model.number(),
+  category: model.text().nullable(),
+  sub_category: model.text().nullable(),
+  reason: model.text().nullable(),
+  image_url: model.text().nullable(),
+  date: model.dateTime().nullable(),
+  metadata: model.json().nullable(),
+})
+
+export default PettyCashTransaction

package/src/modules/cms/models/petty-cash.ts

@@ -0,0 +1,10 @@
+import { model } from "@medusajs/framework/utils"
+
+const PettyCash = model.define("retailos_petty_cash", {
+  id: model.id({ prefix: "pc" }).primaryKey(),
+  store_id: model.text().searchable(),
+  balance: model.number(),
+  metadata: model.json().nullable(),
+})
+
+export default PettyCash

package/src/modules/cms/permissions.ts

@@ -0,0 +1,34 @@
+import type { PermissionRegistration } from "@devx-retailos/core"
+
+export const CMS_PERMISSIONS: PermissionRegistration[] = [
+  {
+    key: "cms.handover.read",
+    description: "View cash handover records",
+    registered_by: "cms",
+  },
+  {
+    key: "cms.handover.create",
+    description: "Create a cash handover record",
+    registered_by: "cms",
+  },
+  {
+    key: "cms.shift.operate",
+    description: "Open and close shift (day start / day end)",
+    registered_by: "cms",
+  },
+  {
+    key: "cms.petty_cash.read",
+    description: "View petty cash balance and transactions",
+    registered_by: "cms",
+  },
+  {
+    key: "cms.petty_cash.operate",
+    description: "Add petty cash or record expenses",
+    registered_by: "cms",
+  },
+  {
+    key: "cms.accumulation.read",
+    description: "View current cash accumulation for a store",
+    registered_by: "cms",
+  },
+]