mirror of
https://github.com/fsolla/teqo.git
synced 2026-11-19 08:03:06 +00:00
`municipality.engagementLevel` (staff-only, no default) records what the campaign decided to invest in a município, next to the E8/E10 metrics that describe what it knows. Moving it is a reallocation decision, so only unrestricted staff may, every move carries a rationale plus the signals that would reverse it, and the write files an `allocationDecision` in the same transaction under an advisory lock taken before the current level is read — otherwise the snapshot's `from` is a guess. The enum gains `movimento`: a level move is neither `aceita` nor `descarta`. No backfill. Null is "Sem nível", and filtering by it is the triage queue. That is also why the list sorts `nivel` in memory rather than in the query: Postgres puts NULLs first on DESC, so a native sort would open "N4 primeiro" on a page of municípios nobody has decided about yet. The filter stays native. The hysteresis rules from research §6.8 are pure and client-safe, so the Popover explains a block before submitting and the server re-runs them anyway; a blocked move answers 409 with typed violations and the override is recorded with exactly the rules it contradicted.
243 lines
8.1 KiB
TypeScript
243 lines
8.1 KiB
TypeScript
// ---------------------------------------------------------------------------
|
|
// Municipalities (Municípios)
|
|
// ---------------------------------------------------------------------------
|
|
|
|
import type { Access, FieldAccess, Payload, PayloadRequest } from 'payload'
|
|
|
|
import type {
|
|
CampaignActor,
|
|
CampaignTransactionRequest,
|
|
DynamicFind,
|
|
} from '@/utilities/access/shared'
|
|
import {
|
|
getFreshCampaignUser,
|
|
isCampaignLeader,
|
|
isCampaignUnrestricted,
|
|
isCampaignUser,
|
|
isPayloadAdmin,
|
|
} from '@/utilities/access/shared'
|
|
import { relationshipId } from '@/utilities/relationship'
|
|
|
|
type MunicipalityID = number
|
|
type AccessibleMunicipalityIDs = MunicipalityID[] | null
|
|
|
|
const ACCESSIBLE_MUNICIPALITY_IDS_CONTEXT_KEY = 'campaignAccessibleMunicipalityIds'
|
|
const OWN_LEADERSHIP_CONTEXT_KEY = 'campaignOwnLeadership'
|
|
|
|
/**
|
|
* Municipality IDs where `advisorID` is an assigned advisor, without requiring a
|
|
* `PayloadRequest`. Canonical implementation of the "advisors contains
|
|
* user.id" lookup; `getAccessibleMunicipalityIds` uses it for its (request-scoped,
|
|
* context-cached) advisor branch.
|
|
*/
|
|
export const getAdvisorMunicipalityIds = async (
|
|
payload: Pick<Payload, 'find'>,
|
|
advisorID: number,
|
|
req?: CampaignTransactionRequest,
|
|
): Promise<number[]> => {
|
|
const find = payload.find.bind(payload) as unknown as DynamicFind
|
|
const result = await find({
|
|
collection: 'municipality',
|
|
where: { advisors: { contains: advisorID } },
|
|
depth: 0,
|
|
limit: 0,
|
|
pagination: false,
|
|
select: { id: true },
|
|
overrideAccess: true,
|
|
...(req ? { req } : {}),
|
|
})
|
|
|
|
return result.docs.map((doc) => relationshipId(doc.id)).filter((id): id is number => id !== null)
|
|
}
|
|
|
|
/**
|
|
* Municipality IDs linked to `userID`'s engaged leadership, without requiring a
|
|
* `PayloadRequest`. Transaction-safe counterpart of the leader branch in
|
|
* `getAccessibleMunicipalityIds`, for server actions running inside
|
|
* `withPayloadTransaction` (where only `{ transactionID }` is available).
|
|
*/
|
|
export const getEngagedLeaderMunicipalityIds = async (
|
|
payload: Pick<Payload, 'find'>,
|
|
userID: number,
|
|
req?: CampaignTransactionRequest,
|
|
): Promise<number[]> => {
|
|
const find = payload.find.bind(payload) as unknown as DynamicFind
|
|
const result = await find({
|
|
collection: 'leadership',
|
|
where: {
|
|
and: [{ user: { equals: userID } }, { supportStatus: { equals: 'engajado' } }],
|
|
},
|
|
depth: 0,
|
|
limit: 1,
|
|
pagination: false,
|
|
select: { municipalities: true },
|
|
overrideAccess: true,
|
|
...(req ? { req } : {}),
|
|
})
|
|
|
|
const doc = result.docs[0]
|
|
return (Array.isArray(doc?.municipalities) ? doc.municipalities : [])
|
|
.map(relationshipId)
|
|
.filter((id): id is number => id !== null)
|
|
}
|
|
|
|
type OwnLeadership = { id: number; municipalityIDs: number[]; organizationIDs: number[] } | null
|
|
|
|
/**
|
|
* The engaged leadership record linked to the authenticated leader account
|
|
* (contact is unique per person, so there is at most one). Cached per request.
|
|
*/
|
|
const getOwnEngagedLeadership = async (
|
|
req: PayloadRequest,
|
|
user: CampaignActor = req.user,
|
|
): Promise<OwnLeadership> => {
|
|
const currentUser =
|
|
isCampaignUser(user) && user === req.user ? await getFreshCampaignUser(req, user) : user
|
|
if (!isCampaignUser(currentUser)) return null
|
|
|
|
const context = req.context as Record<string, unknown>
|
|
const cacheKey = `${OWN_LEADERSHIP_CONTEXT_KEY}:${currentUser.id}`
|
|
if (cacheKey in context) return context[cacheKey] as OwnLeadership
|
|
|
|
const collections = req.payload.collections as Record<string, unknown>
|
|
let ownLeadership: OwnLeadership = null
|
|
|
|
if (collections.leadership) {
|
|
const find = req.payload.find.bind(req.payload) as unknown as DynamicFind
|
|
const result = await find({
|
|
collection: 'leadership',
|
|
depth: 0,
|
|
limit: 1,
|
|
overrideAccess: true,
|
|
pagination: false,
|
|
req,
|
|
select: { municipalities: true, organizations: true },
|
|
where: {
|
|
and: [{ user: { equals: currentUser.id } }, { supportStatus: { equals: 'engajado' } }],
|
|
},
|
|
})
|
|
|
|
const doc = result.docs[0]
|
|
if (doc) {
|
|
const id = relationshipId(doc.id)
|
|
if (id !== null) {
|
|
ownLeadership = {
|
|
id,
|
|
municipalityIDs: (Array.isArray(doc.municipalities) ? doc.municipalities : [])
|
|
.map(relationshipId)
|
|
.filter((value): value is number => value !== null),
|
|
organizationIDs: (Array.isArray(doc.organizations) ? doc.organizations : [])
|
|
.map(relationshipId)
|
|
.filter((value): value is number => value !== null),
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
context[cacheKey] = ownLeadership
|
|
return ownLeadership
|
|
}
|
|
|
|
/**
|
|
* Returns null for the unrestricted coordinator, otherwise the municipality IDs the
|
|
* authenticated campaign user can operate on: administered municipalities for an
|
|
* advisor, linked (engaged) municipalities for a leader.
|
|
*/
|
|
export const getAccessibleMunicipalityIds = async (
|
|
req: PayloadRequest,
|
|
user: CampaignActor = req.user,
|
|
): Promise<AccessibleMunicipalityIDs> => {
|
|
const currentUser =
|
|
isCampaignUser(user) && user === req.user ? await getFreshCampaignUser(req, user) : user
|
|
|
|
if (!isCampaignUser(currentUser)) return []
|
|
if (isCampaignUnrestricted(currentUser)) return null
|
|
|
|
const context = req.context as Record<string, unknown>
|
|
const cacheKey = `${ACCESSIBLE_MUNICIPALITY_IDS_CONTEXT_KEY}:${currentUser.id}:${currentUser.role}`
|
|
const cached = context[cacheKey]
|
|
|
|
if (Array.isArray(cached)) {
|
|
return cached.filter((id): id is number => typeof id === 'number')
|
|
}
|
|
|
|
const collections = req.payload.collections as Record<string, unknown>
|
|
let ids: MunicipalityID[] = []
|
|
|
|
if (currentUser.role === 'advisor' && collections.municipality) {
|
|
ids = await getAdvisorMunicipalityIds(req.payload, currentUser.id, req)
|
|
}
|
|
|
|
if (currentUser.role === 'leader') {
|
|
const ownLeadership = await getOwnEngagedLeadership(req, currentUser)
|
|
ids = ownLeadership?.municipalityIDs ?? []
|
|
}
|
|
|
|
const uniqueIDs = [...new Set(ids)]
|
|
context[cacheKey] = uniqueIDs
|
|
|
|
return uniqueIDs
|
|
}
|
|
|
|
/** Municipalities are seeded by migration; nobody creates or deletes them in the app. */
|
|
export const canCreateMunicipality: Access = ({ req }) => isPayloadAdmin(req.user)
|
|
|
|
export const canReadMunicipality: Access = async ({ req }) => {
|
|
if (isPayloadAdmin(req.user)) return true
|
|
|
|
const currentUser = await getFreshCampaignUser(req)
|
|
// Editors (and any non-campaign actor) must not see Municípios in /admin.
|
|
if (!currentUser) return false
|
|
if (isCampaignLeader(currentUser)) return false
|
|
|
|
const ids = await getAccessibleMunicipalityIds(req, currentUser)
|
|
if (ids === null) return true
|
|
|
|
return {
|
|
id: {
|
|
in: ids,
|
|
},
|
|
}
|
|
}
|
|
|
|
export const canUpdateMunicipality: Access = async ({ req }) => {
|
|
if (isPayloadAdmin(req.user)) return true
|
|
|
|
const currentUser = await getFreshCampaignUser(req)
|
|
if (!currentUser) return false
|
|
if (isCampaignUnrestricted(currentUser)) return true
|
|
if (currentUser.role !== 'advisor') return false
|
|
|
|
return {
|
|
advisors: {
|
|
contains: currentUser.id,
|
|
},
|
|
}
|
|
}
|
|
|
|
export const canDeleteMunicipality: Access = ({ req }) => isPayloadAdmin(req.user)
|
|
|
|
/**
|
|
* Fields only the coordination itself may write. The two policies below are
|
|
* named apart because they answer different questions and can diverge, but
|
|
* they resolve "unrestricted staff" once so a change to what that means is
|
|
* made in one place.
|
|
*/
|
|
const unrestrictedCampaignFieldAccess: FieldAccess = async ({ req }) => {
|
|
if (isPayloadAdmin(req.user)) return true
|
|
|
|
return isCampaignUnrestricted(await getFreshCampaignUser(req))
|
|
}
|
|
|
|
/** Advisor assignment is unrestricted staff (coordinator + candidate; actions use overrideAccess). */
|
|
export const canAssignMunicipalityAdvisors = unrestrictedCampaignFieldAccess
|
|
|
|
export const canManageMunicipalityAdvisors: FieldAccess = ({ req }) => isPayloadAdmin(req.user)
|
|
|
|
/**
|
|
* E14 — moving a município between engagement levels is a reallocation
|
|
* decision, so it is unrestricted staff only; the advisor proposes it through
|
|
* a signal. Reading stays with `canReadCampaignStaffField` like the rest of
|
|
* the staff block.
|
|
*/
|
|
export const canManageMunicipalityEngagementLevel = unrestrictedCampaignFieldAccess
|