feat(supabase): V1-2.1 M4/M5 secure sheet access and review workflow
M4 20261028100000_sheet_access_hardening + M5 20261028110000_sheet_review_workflow (applied together; no unprotected window). Implements contract §5-§14. - Catalogue rights table + owner RPCs; has_mfa / has_aal2_session (live auth.sessions check); grant_active vs caller_has split; catalogue reader predicate; can_edit_sheet on the sheet_editor capability (F14). - AR-1 B: aal2 required on every platform role change, target verified factor, race-free last-owner guard (F18/F19); service_role loses table privileges on the catalogue + profiles/profile_roles and EXECUTE on the role RPCs (F12/F17). - Reviewed lifecycle: version provenance + review columns, content/freeze/ author triggers, rounds/comments/acknowledgments, save/submit/withdraw/ comment/acknowledge/decide, atomic publish_sheet_version(review_id) on the stored verdict, deprecate/archive/restore, species RPCs, equine working copy, uploads with the storage check (F7) + editor INSERT policy + 2 MiB bucket. F1-F3,F5,F6,F8,F9,F13,F15,F16 closed. Verdict is a fixture until M6 (V1-2.3). - O22: SQL business mirror removed, declared status check kept; pgTAP 011 and the Rust generator's SQL parts deleted, ledger retargeted. - Access layer sheets.ts (closed SheetFailure kinds); old client publish gate deleted; types regenerated; upload tool reads via get_sheet_asset_state. Tested on the throwaway sandbox only; DEV untouched. pgTAP 850 (real stack) / 122 (PGlite) green; real-GoTrue AR-1 B + F18 race green; fresh install and M3->M5 upgrade green; V1-1 regression green; rust:check, typecheck, lint, build, types drift clean. BDR-084, LRN-095.
This commit is contained in:
1 parent
9c13bae4bc
commit
77e5fa4cf5
33 files changed
+4613
-1617
No files matched your search
@@ -1,105 +0,0 @@
|
||||
import type { FaunosteoClient } from './client'
|
||||
|
||||
/**
|
||||
* Publication gate on the client side: the full shape and every integrity
|
||||
* rule run before the RPC, so the editor gets the complete issue list. The
|
||||
* rules run in the Rust core (R2): the caller passes its `sheet.check`
|
||||
* operation, so this package never loads the module itself. The gate fails
|
||||
* closed: anything but a publishable verdict refuses publication. The
|
||||
* database re-checks the referential rules on its own
|
||||
* (private.sheet_document_issues); this call never replaces that guard.
|
||||
*/
|
||||
|
||||
export interface SheetIssue {
|
||||
code: string
|
||||
severity: 'error' | 'warning'
|
||||
path: string
|
||||
message: string
|
||||
}
|
||||
|
||||
/** The core's verdict on a document (`sheet.check`), or why it could not give one. */
|
||||
export type SheetCheckOutcome =
|
||||
| { ok: true; value: { issues: SheetIssue[]; publishable: boolean } }
|
||||
| { ok: false; kind: string; detail?: string }
|
||||
|
||||
export type SheetValidator = (content: unknown) => SheetCheckOutcome
|
||||
|
||||
export type SheetPublishErrorKind =
|
||||
/**
|
||||
* The document does not match the strict schema, or carries a text the core cannot read
|
||||
* without altering it (`lone_surrogate`).
|
||||
*/
|
||||
| 'invalid_shape'
|
||||
/** Integrity errors (warnings never block). */
|
||||
| 'not_publishable'
|
||||
/** The validator could not run (core unavailable, trap): publication refused. */
|
||||
| 'validator_unavailable'
|
||||
|
||||
export class SheetPublishError extends Error {
|
||||
constructor(
|
||||
readonly kind: SheetPublishErrorKind,
|
||||
readonly issues: SheetIssue[] = [],
|
||||
detail = '',
|
||||
) {
|
||||
super(SheetPublishError.messageOf(kind, issues, detail))
|
||||
this.name = 'SheetPublishError'
|
||||
}
|
||||
|
||||
private static messageOf(
|
||||
kind: SheetPublishErrorKind,
|
||||
issues: SheetIssue[],
|
||||
detail: string,
|
||||
): string {
|
||||
if (kind === 'not_publishable') {
|
||||
const errors = issues.filter((issue) => issue.severity === 'error')
|
||||
return (
|
||||
`Sheet document is not publishable: ${errors.length} error(s), ` +
|
||||
`first: ${errors[0]?.code ?? 'none'}`
|
||||
)
|
||||
}
|
||||
if (kind === 'invalid_shape') {
|
||||
return `Sheet document does not match the schema${detail ? `: ${detail}` : ''}`
|
||||
}
|
||||
return `Sheet validator unavailable${detail ? ` (${detail})` : ''}`
|
||||
}
|
||||
}
|
||||
|
||||
/** The validator's kinds that judge the document itself, not the validator's state. */
|
||||
const CONTENT_KINDS: ReadonlySet<string> = new Set([
|
||||
'invalid_shape',
|
||||
'lone_surrogate',
|
||||
])
|
||||
|
||||
/** Throws unless the validator says the document is publishable. */
|
||||
function assertPublishable(validate: SheetValidator, content: unknown): void {
|
||||
const check = validate(content)
|
||||
if (!check.ok) {
|
||||
throw CONTENT_KINDS.has(check.kind)
|
||||
? new SheetPublishError('invalid_shape', [], check.detail)
|
||||
: new SheetPublishError('validator_unavailable', [], check.kind)
|
||||
}
|
||||
if (!check.value.publishable) {
|
||||
throw new SheetPublishError('not_publishable', check.value.issues)
|
||||
}
|
||||
}
|
||||
|
||||
export async function publishSheetVersion(
|
||||
client: FaunosteoClient,
|
||||
versionId: string,
|
||||
validate: SheetValidator,
|
||||
): Promise<string> {
|
||||
const draft = await client
|
||||
.from('anatomical_sheet_versions')
|
||||
.select('content')
|
||||
.eq('id', versionId)
|
||||
.single()
|
||||
if (draft.error) throw draft.error
|
||||
|
||||
assertPublishable(validate, draft.data.content)
|
||||
|
||||
const published = await client.rpc('publish_sheet_version', {
|
||||
version_id: versionId,
|
||||
})
|
||||
if (published.error) throw published.error
|
||||
return published.data
|
||||
}
|
||||
@@ -9,6 +9,71 @@ export type Json =
|
||||
export type Database = {
|
||||
public: {
|
||||
Tables: {
|
||||
anatomical_catalog_grants: {
|
||||
Row: {
|
||||
expires_at: string | null
|
||||
grant_kind: Database['public']['Enums']['catalog_grant_kind']
|
||||
granted_at: string
|
||||
granted_by: string
|
||||
id: string
|
||||
reason: string
|
||||
revocation_reason: string | null
|
||||
revoked_at: string | null
|
||||
revoked_by: string | null
|
||||
user_id: string
|
||||
verification_note: string | null
|
||||
}
|
||||
ComputedFields: never
|
||||
Insert: {
|
||||
expires_at?: string | null
|
||||
grant_kind: Database['public']['Enums']['catalog_grant_kind']
|
||||
granted_at?: string
|
||||
granted_by: string
|
||||
id?: string
|
||||
reason: string
|
||||
revocation_reason?: string | null
|
||||
revoked_at?: string | null
|
||||
revoked_by?: string | null
|
||||
user_id: string
|
||||
verification_note?: string | null
|
||||
}
|
||||
Update: {
|
||||
expires_at?: string | null
|
||||
grant_kind?: Database['public']['Enums']['catalog_grant_kind']
|
||||
granted_at?: string
|
||||
granted_by?: string
|
||||
id?: string
|
||||
reason?: string
|
||||
revocation_reason?: string | null
|
||||
revoked_at?: string | null
|
||||
revoked_by?: string | null
|
||||
user_id?: string
|
||||
verification_note?: string | null
|
||||
}
|
||||
Relationships: [
|
||||
{
|
||||
foreignKeyName: 'anatomical_catalog_grants_granted_by_fkey'
|
||||
columns: ['granted_by']
|
||||
isOneToOne: false
|
||||
referencedRelation: 'profiles'
|
||||
referencedColumns: ['id']
|
||||
},
|
||||
{
|
||||
foreignKeyName: 'anatomical_catalog_grants_revoked_by_fkey'
|
||||
columns: ['revoked_by']
|
||||
isOneToOne: false
|
||||
referencedRelation: 'profiles'
|
||||
referencedColumns: ['id']
|
||||
},
|
||||
{
|
||||
foreignKeyName: 'anatomical_catalog_grants_user_id_fkey'
|
||||
columns: ['user_id']
|
||||
isOneToOne: false
|
||||
referencedRelation: 'profiles'
|
||||
referencedColumns: ['id']
|
||||
},
|
||||
]
|
||||
}
|
||||
anatomical_sheet_assets: {
|
||||
Row: {
|
||||
byte_size: number
|
||||
@@ -61,52 +126,270 @@ export type Database = {
|
||||
},
|
||||
]
|
||||
}
|
||||
anatomical_sheet_review_acknowledgments: {
|
||||
Row: {
|
||||
created_at: string
|
||||
group_digest: string
|
||||
group_key: string
|
||||
id: string
|
||||
review_id: string
|
||||
reviewer: string
|
||||
}
|
||||
ComputedFields: never
|
||||
Insert: {
|
||||
created_at?: string
|
||||
group_digest: string
|
||||
group_key: string
|
||||
id?: string
|
||||
review_id: string
|
||||
reviewer: string
|
||||
}
|
||||
Update: {
|
||||
created_at?: string
|
||||
group_digest?: string
|
||||
group_key?: string
|
||||
id?: string
|
||||
review_id?: string
|
||||
reviewer?: string
|
||||
}
|
||||
Relationships: [
|
||||
{
|
||||
foreignKeyName: 'anatomical_sheet_review_acknowledgments_review_id_fkey'
|
||||
columns: ['review_id']
|
||||
isOneToOne: false
|
||||
referencedRelation: 'anatomical_sheet_reviews'
|
||||
referencedColumns: ['id']
|
||||
},
|
||||
{
|
||||
foreignKeyName: 'anatomical_sheet_review_acknowledgments_reviewer_fkey'
|
||||
columns: ['reviewer']
|
||||
isOneToOne: false
|
||||
referencedRelation: 'profiles'
|
||||
referencedColumns: ['id']
|
||||
},
|
||||
]
|
||||
}
|
||||
anatomical_sheet_review_comments: {
|
||||
Row: {
|
||||
author: string
|
||||
body: string
|
||||
created_at: string
|
||||
group_key: string | null
|
||||
id: string
|
||||
review_id: string
|
||||
}
|
||||
ComputedFields: never
|
||||
Insert: {
|
||||
author: string
|
||||
body: string
|
||||
created_at?: string
|
||||
group_key?: string | null
|
||||
id?: string
|
||||
review_id: string
|
||||
}
|
||||
Update: {
|
||||
author?: string
|
||||
body?: string
|
||||
created_at?: string
|
||||
group_key?: string | null
|
||||
id?: string
|
||||
review_id?: string
|
||||
}
|
||||
Relationships: [
|
||||
{
|
||||
foreignKeyName: 'anatomical_sheet_review_comments_author_fkey'
|
||||
columns: ['author']
|
||||
isOneToOne: false
|
||||
referencedRelation: 'profiles'
|
||||
referencedColumns: ['id']
|
||||
},
|
||||
{
|
||||
foreignKeyName: 'anatomical_sheet_review_comments_review_id_fkey'
|
||||
columns: ['review_id']
|
||||
isOneToOne: false
|
||||
referencedRelation: 'anatomical_sheet_reviews'
|
||||
referencedColumns: ['id']
|
||||
},
|
||||
]
|
||||
}
|
||||
anatomical_sheet_reviews: {
|
||||
Row: {
|
||||
attempts: number
|
||||
authors: string[]
|
||||
created_at: string
|
||||
decided_at: string | null
|
||||
decided_by: string | null
|
||||
decision_note: string | null
|
||||
failure_code: string | null
|
||||
failure_outcome:
|
||||
| Database['public']['Enums']['sheet_verification_outcome']
|
||||
| null
|
||||
id: string
|
||||
lease_token: string | null
|
||||
locked_at: string | null
|
||||
revision: number
|
||||
round: number
|
||||
status: Database['public']['Enums']['sheet_round_status']
|
||||
submission_note: string | null
|
||||
submitted_at: string
|
||||
submitted_by: string
|
||||
verdict: Json | null
|
||||
verified_at: string | null
|
||||
verified_with: string | null
|
||||
version_id: string
|
||||
withdrawal_note: string | null
|
||||
withdrawn_at: string | null
|
||||
withdrawn_by: string | null
|
||||
}
|
||||
ComputedFields: never
|
||||
Insert: {
|
||||
attempts?: number
|
||||
authors: string[]
|
||||
created_at?: string
|
||||
decided_at?: string | null
|
||||
decided_by?: string | null
|
||||
decision_note?: string | null
|
||||
failure_code?: string | null
|
||||
failure_outcome?:
|
||||
| Database['public']['Enums']['sheet_verification_outcome']
|
||||
| null
|
||||
id?: string
|
||||
lease_token?: string | null
|
||||
locked_at?: string | null
|
||||
revision: number
|
||||
round: number
|
||||
status?: Database['public']['Enums']['sheet_round_status']
|
||||
submission_note?: string | null
|
||||
submitted_at?: string
|
||||
submitted_by: string
|
||||
verdict?: Json | null
|
||||
verified_at?: string | null
|
||||
verified_with?: string | null
|
||||
version_id: string
|
||||
withdrawal_note?: string | null
|
||||
withdrawn_at?: string | null
|
||||
withdrawn_by?: string | null
|
||||
}
|
||||
Update: {
|
||||
attempts?: number
|
||||
authors?: string[]
|
||||
created_at?: string
|
||||
decided_at?: string | null
|
||||
decided_by?: string | null
|
||||
decision_note?: string | null
|
||||
failure_code?: string | null
|
||||
failure_outcome?:
|
||||
| Database['public']['Enums']['sheet_verification_outcome']
|
||||
| null
|
||||
id?: string
|
||||
lease_token?: string | null
|
||||
locked_at?: string | null
|
||||
revision?: number
|
||||
round?: number
|
||||
status?: Database['public']['Enums']['sheet_round_status']
|
||||
submission_note?: string | null
|
||||
submitted_at?: string
|
||||
submitted_by?: string
|
||||
verdict?: Json | null
|
||||
verified_at?: string | null
|
||||
verified_with?: string | null
|
||||
version_id?: string
|
||||
withdrawal_note?: string | null
|
||||
withdrawn_at?: string | null
|
||||
withdrawn_by?: string | null
|
||||
}
|
||||
Relationships: [
|
||||
{
|
||||
foreignKeyName: 'anatomical_sheet_reviews_decided_by_fkey'
|
||||
columns: ['decided_by']
|
||||
isOneToOne: false
|
||||
referencedRelation: 'profiles'
|
||||
referencedColumns: ['id']
|
||||
},
|
||||
{
|
||||
foreignKeyName: 'anatomical_sheet_reviews_submitted_by_fkey'
|
||||
columns: ['submitted_by']
|
||||
isOneToOne: false
|
||||
referencedRelation: 'profiles'
|
||||
referencedColumns: ['id']
|
||||
},
|
||||
{
|
||||
foreignKeyName: 'anatomical_sheet_reviews_version_id_fkey'
|
||||
columns: ['version_id']
|
||||
isOneToOne: false
|
||||
referencedRelation: 'anatomical_sheet_versions'
|
||||
referencedColumns: ['id']
|
||||
},
|
||||
{
|
||||
foreignKeyName: 'anatomical_sheet_reviews_withdrawn_by_fkey'
|
||||
columns: ['withdrawn_by']
|
||||
isOneToOne: false
|
||||
referencedRelation: 'profiles'
|
||||
referencedColumns: ['id']
|
||||
},
|
||||
]
|
||||
}
|
||||
anatomical_sheet_versions: {
|
||||
Row: {
|
||||
authors: string[]
|
||||
change_note: string
|
||||
content: NonNullable<Json>
|
||||
created_at: string
|
||||
created_by: string | null
|
||||
deprecated_at: string | null
|
||||
deprecated_by: string | null
|
||||
document_fingerprint: string | null
|
||||
document_schema_version: number
|
||||
id: string
|
||||
published_at: string | null
|
||||
published_by: string | null
|
||||
published_review_id: string | null
|
||||
revision: number
|
||||
sheet_id: string
|
||||
source_version_id: string | null
|
||||
status: Database['public']['Enums']['sheet_version_status']
|
||||
updated_at: string
|
||||
version_number: number
|
||||
}
|
||||
ComputedFields: never
|
||||
Insert: {
|
||||
authors?: string[]
|
||||
change_note?: string
|
||||
content: NonNullable<Json>
|
||||
created_at?: string
|
||||
created_by?: string | null
|
||||
deprecated_at?: string | null
|
||||
deprecated_by?: string | null
|
||||
document_fingerprint?: string | null
|
||||
document_schema_version: number
|
||||
id?: string
|
||||
published_at?: string | null
|
||||
published_by?: string | null
|
||||
published_review_id?: string | null
|
||||
revision?: number
|
||||
sheet_id: string
|
||||
source_version_id?: string | null
|
||||
status?: Database['public']['Enums']['sheet_version_status']
|
||||
updated_at?: string
|
||||
version_number: number
|
||||
}
|
||||
Update: {
|
||||
authors?: string[]
|
||||
change_note?: string
|
||||
content?: NonNullable<Json>
|
||||
created_at?: string
|
||||
created_by?: string | null
|
||||
deprecated_at?: string | null
|
||||
deprecated_by?: string | null
|
||||
document_fingerprint?: string | null
|
||||
document_schema_version?: number
|
||||
id?: string
|
||||
published_at?: string | null
|
||||
published_by?: string | null
|
||||
published_review_id?: string | null
|
||||
revision?: number
|
||||
sheet_id?: string
|
||||
source_version_id?: string | null
|
||||
status?: Database['public']['Enums']['sheet_version_status']
|
||||
updated_at?: string
|
||||
version_number?: number
|
||||
@@ -133,6 +416,13 @@ export type Database = {
|
||||
referencedRelation: 'profiles'
|
||||
referencedColumns: ['id']
|
||||
},
|
||||
{
|
||||
foreignKeyName: 'anatomical_sheet_versions_published_review_fkey'
|
||||
columns: ['published_review_id']
|
||||
isOneToOne: false
|
||||
referencedRelation: 'anatomical_sheet_reviews'
|
||||
referencedColumns: ['id']
|
||||
},
|
||||
{
|
||||
foreignKeyName: 'anatomical_sheet_versions_sheet_id_fkey'
|
||||
columns: ['sheet_id']
|
||||
@@ -140,6 +430,13 @@ export type Database = {
|
||||
referencedRelation: 'anatomical_sheets'
|
||||
referencedColumns: ['id']
|
||||
},
|
||||
{
|
||||
foreignKeyName: 'anatomical_sheet_versions_source_version_id_fkey'
|
||||
columns: ['source_version_id']
|
||||
isOneToOne: false
|
||||
referencedRelation: 'anatomical_sheet_versions'
|
||||
referencedColumns: ['id']
|
||||
},
|
||||
]
|
||||
}
|
||||
anatomical_sheets: {
|
||||
@@ -161,6 +458,7 @@ export type Database = {
|
||||
status: Database['public']['Enums']['sheet_status']
|
||||
updated_at: string
|
||||
visibility: Database['public']['Enums']['sheet_visibility']
|
||||
working_copy_source_version_id: string | null
|
||||
}
|
||||
ComputedFields: never
|
||||
Insert: {
|
||||
@@ -181,6 +479,7 @@ export type Database = {
|
||||
status?: Database['public']['Enums']['sheet_status']
|
||||
updated_at?: string
|
||||
visibility?: Database['public']['Enums']['sheet_visibility']
|
||||
working_copy_source_version_id?: string | null
|
||||
}
|
||||
Update: {
|
||||
archived_at?: string | null
|
||||
@@ -200,6 +499,7 @@ export type Database = {
|
||||
status?: Database['public']['Enums']['sheet_status']
|
||||
updated_at?: string
|
||||
visibility?: Database['public']['Enums']['sheet_visibility']
|
||||
working_copy_source_version_id?: string | null
|
||||
}
|
||||
Relationships: [
|
||||
{
|
||||
@@ -237,6 +537,13 @@ export type Database = {
|
||||
referencedRelation: 'species'
|
||||
referencedColumns: ['id']
|
||||
},
|
||||
{
|
||||
foreignKeyName: 'anatomical_sheets_working_copy_source_version_id_fkey'
|
||||
columns: ['working_copy_source_version_id']
|
||||
isOneToOne: false
|
||||
referencedRelation: 'anatomical_sheet_versions'
|
||||
referencedColumns: ['id']
|
||||
},
|
||||
]
|
||||
}
|
||||
animal_client_relations: {
|
||||
@@ -738,6 +1045,11 @@ export type Database = {
|
||||
}
|
||||
Functions: {
|
||||
ack_purge: { Args: { purge_id: string }; Returns: undefined }
|
||||
acknowledge_sheet_review_group: {
|
||||
Args: { group_digest: string; group_key: string; review_id: string }
|
||||
Returns: string
|
||||
}
|
||||
activate_species: { Args: { id: string }; Returns: string }
|
||||
archive_anatomical_sheet: { Args: { sheet_id: string }; Returns: string }
|
||||
begin_avatar_upload: {
|
||||
Args: { declared_mime: string; declared_size: number }
|
||||
@@ -772,6 +1084,10 @@ export type Database = {
|
||||
}[]
|
||||
}
|
||||
client_archive_preview: { Args: { client_id: string }; Returns: Json }
|
||||
comment_sheet_review: {
|
||||
Args: { body: string; group_key?: string; review_id: string }
|
||||
Returns: string
|
||||
}
|
||||
complete_avatar_job: {
|
||||
Args: {
|
||||
asset_id: string
|
||||
@@ -786,18 +1102,6 @@ export type Database = {
|
||||
Args: { asset_id: string }
|
||||
Returns: string
|
||||
}
|
||||
create_anatomical_sheet: {
|
||||
Args: {
|
||||
description?: string
|
||||
document: Json
|
||||
name: string
|
||||
official?: boolean
|
||||
slug: string
|
||||
species_id: string
|
||||
visibility?: Database['public']['Enums']['sheet_visibility']
|
||||
}
|
||||
Returns: string
|
||||
}
|
||||
create_animal: {
|
||||
Args: {
|
||||
birth_date?: string
|
||||
@@ -841,6 +1145,10 @@ export type Database = {
|
||||
}
|
||||
Returns: Json
|
||||
}
|
||||
create_official_sheet: {
|
||||
Args: { document: Json; slug: string }
|
||||
Returns: string
|
||||
}
|
||||
create_sheet_draft: {
|
||||
Args: {
|
||||
change_note?: string
|
||||
@@ -849,6 +1157,23 @@ export type Database = {
|
||||
}
|
||||
Returns: string
|
||||
}
|
||||
create_sheet_working_copy: {
|
||||
Args: { slug: string; source_version_id: string }
|
||||
Returns: string
|
||||
}
|
||||
create_species: {
|
||||
Args: {
|
||||
id: string
|
||||
name_en: string
|
||||
name_fr: string
|
||||
sort_order?: number
|
||||
}
|
||||
Returns: string
|
||||
}
|
||||
decide_sheet_review: {
|
||||
Args: { approve: boolean; note: string; review_id: string }
|
||||
Returns: string
|
||||
}
|
||||
delete_anatomical_sheet: { Args: { sheet_id: string }; Returns: string }
|
||||
delete_sheet_asset: { Args: { asset_id: string }; Returns: string }
|
||||
delete_sheet_version: { Args: { version_id: string }; Returns: string }
|
||||
@@ -868,12 +1193,15 @@ export type Database = {
|
||||
Args: { max_age_seconds: number }
|
||||
Returns: number
|
||||
}
|
||||
fork_anatomical_sheet: {
|
||||
get_sheet_asset_state: { Args: { asset_id: string }; Returns: Json }
|
||||
get_sheet_version: { Args: { version_id: string }; Returns: Json }
|
||||
grant_catalog_right: {
|
||||
Args: {
|
||||
name: string
|
||||
slug: string
|
||||
source_version_id: string
|
||||
visibility?: Database['public']['Enums']['sheet_visibility']
|
||||
expires_at?: string
|
||||
kind: Database['public']['Enums']['catalog_grant_kind']
|
||||
reason: string
|
||||
user_id: string
|
||||
verification_note?: string
|
||||
}
|
||||
Returns: string
|
||||
}
|
||||
@@ -884,6 +1212,8 @@ export type Database = {
|
||||
}
|
||||
Returns: string
|
||||
}
|
||||
list_catalog_grants: { Args: Record<PropertyKey, never>; Returns: Json }
|
||||
list_catalog_species: { Args: Record<PropertyKey, never>; Returns: Json }
|
||||
list_client_animals: {
|
||||
Args: {
|
||||
after_id?: string
|
||||
@@ -909,8 +1239,10 @@ export type Database = {
|
||||
started_on: string
|
||||
}[]
|
||||
}
|
||||
list_official_catalog: { Args: Record<PropertyKey, never>; Returns: Json }
|
||||
lookup_catalog_account: { Args: { email: string }; Returns: Json }
|
||||
mark_quarantine_purged: { Args: { asset_id: string }; Returns: undefined }
|
||||
publish_sheet_version: { Args: { version_id: string }; Returns: string }
|
||||
publish_sheet_version: { Args: { review_id: string }; Returns: string }
|
||||
register_sheet_asset: {
|
||||
Args: {
|
||||
byte_size: number
|
||||
@@ -925,7 +1257,15 @@ export type Database = {
|
||||
Returns: undefined
|
||||
}
|
||||
remove_avatar: { Args: Record<PropertyKey, never>; Returns: number }
|
||||
rename_species: {
|
||||
Args: { id: string; name_en: string; name_fr: string }
|
||||
Returns: string
|
||||
}
|
||||
restore_anatomical_sheet: { Args: { sheet_id: string }; Returns: string }
|
||||
revoke_catalog_right: {
|
||||
Args: { grant_id: string; reason: string }
|
||||
Returns: string
|
||||
}
|
||||
revoke_platform_role: {
|
||||
Args: {
|
||||
reason?: string
|
||||
@@ -934,6 +1274,15 @@ export type Database = {
|
||||
}
|
||||
Returns: string
|
||||
}
|
||||
save_sheet_draft: {
|
||||
Args: {
|
||||
change_note?: string
|
||||
document: Json
|
||||
expected_revision: number
|
||||
version_id: string
|
||||
}
|
||||
Returns: Json
|
||||
}
|
||||
search_animals: {
|
||||
Args: {
|
||||
after_id?: string
|
||||
@@ -987,11 +1336,8 @@ export type Database = {
|
||||
Args: { archived: boolean; client_id: string }
|
||||
Returns: Json
|
||||
}
|
||||
set_sheet_visibility: {
|
||||
Args: {
|
||||
sheet_id: string
|
||||
visibility: Database['public']['Enums']['sheet_visibility']
|
||||
}
|
||||
submit_sheet_review: {
|
||||
Args: { expected_revision: number; note?: string; version_id: string }
|
||||
Returns: string
|
||||
}
|
||||
update_animal: {
|
||||
@@ -1033,10 +1379,23 @@ export type Database = {
|
||||
}
|
||||
Returns: Json
|
||||
}
|
||||
update_inactive_species: {
|
||||
Args: {
|
||||
id: string
|
||||
name_en: string
|
||||
name_fr: string
|
||||
sort_order: number
|
||||
}
|
||||
Returns: string
|
||||
}
|
||||
void_animal_client_relation: {
|
||||
Args: { expected_revision: number; relation_id: string }
|
||||
Returns: Json
|
||||
}
|
||||
withdraw_sheet_review: {
|
||||
Args: { note?: string; review_id: string }
|
||||
Returns: string
|
||||
}
|
||||
}
|
||||
Enums: {
|
||||
animal_relation_role: 'owner' | 'keeper' | 'contact'
|
||||
@@ -1047,9 +1406,22 @@ export type Database = {
|
||||
| 'clean'
|
||||
| 'rejected'
|
||||
| 'deleted'
|
||||
catalog_grant_kind:
|
||||
| 'catalog_reader'
|
||||
| 'sheet_editor'
|
||||
| 'sheet_reviewer'
|
||||
| 'sheet_publisher'
|
||||
client_kind: 'person' | 'organization'
|
||||
platform_role: 'owner' | 'admin' | 'moderator' | 'support'
|
||||
sheet_round_status:
|
||||
| 'verifying'
|
||||
| 'open'
|
||||
| 'approved'
|
||||
| 'changes_requested'
|
||||
| 'withdrawn'
|
||||
| 'verification_failed'
|
||||
sheet_status: 'active' | 'archived' | 'deleted'
|
||||
sheet_verification_outcome: 'failed' | 'unavailable'
|
||||
sheet_version_status: 'draft' | 'published' | 'deprecated'
|
||||
sheet_visibility: 'private' | 'public'
|
||||
workspace_kind: 'personal'
|
||||
@@ -1190,9 +1562,24 @@ export const Constants = {
|
||||
'rejected',
|
||||
'deleted',
|
||||
],
|
||||
catalog_grant_kind: [
|
||||
'catalog_reader',
|
||||
'sheet_editor',
|
||||
'sheet_reviewer',
|
||||
'sheet_publisher',
|
||||
],
|
||||
client_kind: ['person', 'organization'],
|
||||
platform_role: ['owner', 'admin', 'moderator', 'support'],
|
||||
sheet_round_status: [
|
||||
'verifying',
|
||||
'open',
|
||||
'approved',
|
||||
'changes_requested',
|
||||
'withdrawn',
|
||||
'verification_failed',
|
||||
],
|
||||
sheet_status: ['active', 'archived', 'deleted'],
|
||||
sheet_verification_outcome: ['failed', 'unavailable'],
|
||||
sheet_version_status: ['draft', 'published', 'deprecated'],
|
||||
sheet_visibility: ['private', 'public'],
|
||||
workspace_kind: ['personal'],
|
||||
|
||||
@@ -44,13 +44,22 @@ export {
|
||||
/** owner | admin | moderator | support. Not a professional status. */
|
||||
export { fetchOwnPlatformRoles, type PlatformRole } from './platform-roles'
|
||||
export {
|
||||
SHEET_FAILURE_KINDS,
|
||||
SheetFailure,
|
||||
classifySheetError,
|
||||
failSheet,
|
||||
grantCatalogRight,
|
||||
revokeCatalogRight,
|
||||
listCatalogGrants,
|
||||
createOfficialSheet,
|
||||
saveSheetDraft,
|
||||
submitSheetReview,
|
||||
decideSheetReview,
|
||||
publishSheetVersion,
|
||||
SheetPublishError,
|
||||
type SheetCheckOutcome,
|
||||
type SheetIssue,
|
||||
type SheetPublishErrorKind,
|
||||
type SheetValidator,
|
||||
} from './anatomical-sheets'
|
||||
getSheetVersion,
|
||||
listOfficialCatalog,
|
||||
type SheetFailureKind,
|
||||
} from './sheets'
|
||||
export {
|
||||
ASSET_FAILURE_KINDS,
|
||||
ASSET_OWNER_COLUMNS,
|
||||
|
||||
@@ -0,0 +1,227 @@
|
||||
import type { FaunosteoClient } from './client'
|
||||
import type { Json } from './database.types'
|
||||
|
||||
/**
|
||||
* Access layer for the official anatomical-sheet workflow (V1-2.1, M4/M5):
|
||||
* typed wrappers over the server RPCs and a closed set of failure kinds. The
|
||||
* server is the only authority: every RPC answers a closed code (SQLSTATE plus
|
||||
* a lowercase dotted message), never a value or free text. This module folds
|
||||
* those answers, the session and the network into one kind the UI phrases
|
||||
* (`sheet.failure.<kind>`), exactly as `records.ts` does for V1-1. No document
|
||||
* validation happens here: the Rust core (in the page) and the worker verdict
|
||||
* decide; the former client publication gate is gone (publication takes a
|
||||
* review id only).
|
||||
*
|
||||
* The screens that call these wrappers arrive in V1-2.5 onward; V1-2.1 ships
|
||||
* the access layer and its types only.
|
||||
*/
|
||||
|
||||
/** Every closed failure the sheet RPCs raise (contract §6.5, §6.7, §5.2, §5.7). */
|
||||
export const SHEET_FAILURE_KINDS = [
|
||||
// session and rights
|
||||
'authentication_required',
|
||||
'mfa_required',
|
||||
'forbidden',
|
||||
'self_target',
|
||||
'rights.account',
|
||||
'rights.capability',
|
||||
'rights.mfa',
|
||||
'rights.owner',
|
||||
'rights.catalog',
|
||||
'not_found',
|
||||
// platform roles (AR-1 B)
|
||||
'role_active',
|
||||
'role_inactive',
|
||||
'last_owner',
|
||||
'target_invalid',
|
||||
'target_factor_missing',
|
||||
'operator_path_only',
|
||||
// catalogue rights
|
||||
'grant.active',
|
||||
'grant.ineligible',
|
||||
'grant.revoked',
|
||||
'grant.self_review',
|
||||
'grant.target_invalid',
|
||||
// drafts and saving
|
||||
'draft_conflict',
|
||||
'draft.unchanged',
|
||||
'draft.frozen',
|
||||
'draft.not_a_draft',
|
||||
'document.shape',
|
||||
'document.species',
|
||||
'document.too_large',
|
||||
// sheet and species state
|
||||
'sheet.inactive',
|
||||
'sheet.state',
|
||||
'sheet.no_source',
|
||||
'sheet.published_history',
|
||||
'sheet.historical_read_only',
|
||||
'sheet.species_invalid',
|
||||
'species.exists',
|
||||
'species.not_active',
|
||||
'species.not_inactive',
|
||||
// review rounds
|
||||
'round.open',
|
||||
'round.terminal',
|
||||
'round.not_open',
|
||||
'review.digest',
|
||||
'review.uncoverable',
|
||||
'review.separation',
|
||||
'review.groups.uncovered',
|
||||
'version.not_published',
|
||||
'version.has_rounds',
|
||||
// verdict and publication
|
||||
'verdict.missing',
|
||||
'verdict.stale',
|
||||
'verdict.fingerprint',
|
||||
'publish.review.missing',
|
||||
'publish.inherited.present',
|
||||
'publish.species.inactive',
|
||||
'publish.species.other',
|
||||
'publish.drawing.missing',
|
||||
'publish.drawing.changed',
|
||||
// uploads and working copy
|
||||
'upload_missing',
|
||||
'size_mismatch',
|
||||
'working_copy.source_invalid',
|
||||
'working_copy.exists',
|
||||
'working_copy.assets_missing',
|
||||
// shared
|
||||
'invalid_input',
|
||||
'rate_limited',
|
||||
'session_expired',
|
||||
'network',
|
||||
'unavailable',
|
||||
] as const
|
||||
export type SheetFailureKind = (typeof SHEET_FAILURE_KINDS)[number]
|
||||
|
||||
const KIND_SET: ReadonlySet<string> = new Set(SHEET_FAILURE_KINDS)
|
||||
|
||||
export class SheetFailure extends Error {
|
||||
readonly kind: SheetFailureKind
|
||||
constructor(kind: SheetFailureKind, cause?: unknown) {
|
||||
super(`sheet: ${kind}`, { cause })
|
||||
this.name = 'SheetFailure'
|
||||
this.kind = kind
|
||||
}
|
||||
}
|
||||
|
||||
interface PostgrestLikeError {
|
||||
code?: string | null
|
||||
message?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Folds a PostgREST answer into a closed kind. The RPCs raise the closed code
|
||||
* as the message (SQLSTATE 42501, P0001, 55000, 23514 or P0002); a message
|
||||
* outside the closed set, a session error (401 / PGRST30x) and a dropped
|
||||
* request each map to their own kind. Fails closed on anything unknown.
|
||||
*/
|
||||
export function classifySheetError(error: unknown, status?: number): SheetFailureKind {
|
||||
if (error instanceof SheetFailure) return error.kind
|
||||
if (error instanceof TypeError) return 'network'
|
||||
const e = (error ?? {}) as PostgrestLikeError
|
||||
if (e.message && KIND_SET.has(e.message)) return e.message as SheetFailureKind
|
||||
if (status === 401 || e.code?.startsWith('PGRST30')) return 'session_expired'
|
||||
if (status === 0) return 'network'
|
||||
return 'unavailable'
|
||||
}
|
||||
|
||||
export function failSheet(error: unknown, status?: number): never {
|
||||
throw new SheetFailure(classifySheetError(error, status), error)
|
||||
}
|
||||
|
||||
// --- Rights (owner, aal2) --------------------------------------------------
|
||||
export async function grantCatalogRight(
|
||||
client: FaunosteoClient,
|
||||
args: {
|
||||
user_id: string
|
||||
kind: 'catalog_reader' | 'sheet_editor' | 'sheet_reviewer' | 'sheet_publisher'
|
||||
reason: string
|
||||
verification_note?: string
|
||||
expires_at?: string
|
||||
},
|
||||
): Promise<string> {
|
||||
const { data, error, status } = await client.rpc('grant_catalog_right', args)
|
||||
if (error) failSheet(error, status)
|
||||
return data
|
||||
}
|
||||
|
||||
export async function revokeCatalogRight(
|
||||
client: FaunosteoClient,
|
||||
grantId: string,
|
||||
reason: string,
|
||||
): Promise<string> {
|
||||
const { data, error, status } = await client.rpc('revoke_catalog_right', {
|
||||
grant_id: grantId,
|
||||
reason,
|
||||
})
|
||||
if (error) failSheet(error, status)
|
||||
return data
|
||||
}
|
||||
|
||||
export async function listCatalogGrants(client: FaunosteoClient): Promise<Json> {
|
||||
const { data, error, status } = await client.rpc('list_catalog_grants')
|
||||
if (error) failSheet(error, status)
|
||||
return data
|
||||
}
|
||||
|
||||
// --- Sheets, drafts, review, publication -----------------------------------
|
||||
export async function createOfficialSheet(
|
||||
client: FaunosteoClient,
|
||||
slug: string,
|
||||
document: Json,
|
||||
): Promise<string> {
|
||||
const { data, error, status } = await client.rpc('create_official_sheet', { slug, document })
|
||||
if (error) failSheet(error, status)
|
||||
return data
|
||||
}
|
||||
|
||||
export async function saveSheetDraft(
|
||||
client: FaunosteoClient,
|
||||
args: { version_id: string; expected_revision: number; document: Json; change_note?: string },
|
||||
): Promise<Json> {
|
||||
const { data, error, status } = await client.rpc('save_sheet_draft', args)
|
||||
if (error) failSheet(error, status)
|
||||
return data
|
||||
}
|
||||
|
||||
export async function submitSheetReview(
|
||||
client: FaunosteoClient,
|
||||
args: { version_id: string; expected_revision: number; note?: string },
|
||||
): Promise<string> {
|
||||
const { data, error, status } = await client.rpc('submit_sheet_review', args)
|
||||
if (error) failSheet(error, status)
|
||||
return data
|
||||
}
|
||||
|
||||
export async function decideSheetReview(
|
||||
client: FaunosteoClient,
|
||||
args: { review_id: string; approve: boolean; note: string },
|
||||
): Promise<string> {
|
||||
const { data, error, status } = await client.rpc('decide_sheet_review', args)
|
||||
if (error) failSheet(error, status)
|
||||
return data
|
||||
}
|
||||
|
||||
/** Publishes an approved round. The gate is the server's: no client validation. */
|
||||
export async function publishSheetVersion(
|
||||
client: FaunosteoClient,
|
||||
reviewId: string,
|
||||
): Promise<string> {
|
||||
const { data, error, status } = await client.rpc('publish_sheet_version', { review_id: reviewId })
|
||||
if (error) failSheet(error, status)
|
||||
return data
|
||||
}
|
||||
|
||||
export async function getSheetVersion(client: FaunosteoClient, versionId: string): Promise<Json> {
|
||||
const { data, error, status } = await client.rpc('get_sheet_version', { version_id: versionId })
|
||||
if (error) failSheet(error, status)
|
||||
return data
|
||||
}
|
||||
|
||||
export async function listOfficialCatalog(client: FaunosteoClient): Promise<Json> {
|
||||
const { data, error, status } = await client.rpc('list_official_catalog')
|
||||
if (error) failSheet(error, status)
|
||||
return data
|
||||
}
|
||||
@@ -1,113 +0,0 @@
|
||||
import { nodeCoreRuntime } from '@faunosteo/core-wasm/node'
|
||||
import type { CoreRuntime } from '@faunosteo/core-wasm'
|
||||
import { publishSheetVersion, SheetPublishError } from '../src'
|
||||
import type { FaunosteoClient, SheetCheckOutcome, SheetValidator } from '../src'
|
||||
|
||||
/** The real core's `sheet.check` (R2): the gate is never tested against a stub verdict. */
|
||||
let core: CoreRuntime
|
||||
beforeAll(async () => {
|
||||
core = await nodeCoreRuntime()
|
||||
})
|
||||
const validate: SheetValidator = (content) =>
|
||||
core.call('sheet.check', JSON.stringify(content)) as SheetCheckOutcome
|
||||
|
||||
/**
|
||||
* Stub of the two client calls publishSheetVersion makes. The real RPC is
|
||||
* covered by supabase/tests/005_anatomical_sheets.sql; here the point is the
|
||||
* order of the gate: no RPC call unless the document is publishable.
|
||||
*/
|
||||
function stubClient(content: unknown) {
|
||||
const rpcCalls: unknown[] = []
|
||||
const client = {
|
||||
from: () => ({
|
||||
select: () => ({
|
||||
eq: () => ({
|
||||
single: async () => ({ data: { content }, error: null }),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
rpc: async (name: string, args: unknown) => {
|
||||
rpcCalls.push([name, args])
|
||||
return { data: 'published-id', error: null }
|
||||
},
|
||||
}
|
||||
return { client: client as unknown as FaunosteoClient, rpcCalls }
|
||||
}
|
||||
|
||||
const publishable = {
|
||||
schema_version: 2,
|
||||
species_id: 'equine',
|
||||
name: { fr: 'Test', en: 'Test' },
|
||||
description: {},
|
||||
scope_disclaimer: {},
|
||||
attribution: { authors: [], license: null, notes: null },
|
||||
vertebral_config: { regions: [] },
|
||||
references: [],
|
||||
categories: [],
|
||||
views: [
|
||||
{
|
||||
id: 'view-main',
|
||||
kind: 'main',
|
||||
name: { fr: 'Vue', en: 'View' },
|
||||
svg_asset_id: '11111111-1111-4111-8111-111111111111',
|
||||
view_box: null,
|
||||
},
|
||||
],
|
||||
annotations: [],
|
||||
finding_zones: [],
|
||||
}
|
||||
|
||||
describe('publishSheetVersion', () => {
|
||||
it('refuses publication when the validator cannot run (fail closed)', async () => {
|
||||
const { client, rpcCalls } = stubClient(publishable)
|
||||
const unavailable: SheetValidator = () => ({
|
||||
ok: false,
|
||||
kind: 'core_unavailable',
|
||||
})
|
||||
await expect(
|
||||
publishSheetVersion(client, 'v1', unavailable),
|
||||
).rejects.toMatchObject({ kind: 'validator_unavailable' })
|
||||
expect(rpcCalls).toEqual([])
|
||||
})
|
||||
|
||||
it('calls the RPC once the document passes shape and integrity checks', async () => {
|
||||
const { client, rpcCalls } = stubClient(publishable)
|
||||
await expect(publishSheetVersion(client, 'v1', validate)).resolves.toBe(
|
||||
'published-id',
|
||||
)
|
||||
expect(rpcCalls).toEqual([['publish_sheet_version', { version_id: 'v1' }]])
|
||||
})
|
||||
|
||||
it('refuses a document with integrity errors before any RPC', async () => {
|
||||
const { client, rpcCalls } = stubClient({
|
||||
...publishable,
|
||||
views: [{ ...publishable.views[0], svg_asset_id: null }],
|
||||
})
|
||||
await expect(publishSheetVersion(client, 'v1', validate)).rejects.toThrow(
|
||||
/view\.asset\.missing/,
|
||||
)
|
||||
expect(rpcCalls).toEqual([])
|
||||
})
|
||||
|
||||
it('refuses a document that does not match the schema', async () => {
|
||||
const { client, rpcCalls } = stubClient({ schema_version: 1 })
|
||||
await expect(
|
||||
publishSheetVersion(client, 'v1', validate),
|
||||
).rejects.toBeInstanceOf(SheetPublishError)
|
||||
await expect(
|
||||
publishSheetVersion(client, 'v1', validate),
|
||||
).rejects.toMatchObject({ kind: 'invalid_shape' })
|
||||
expect(rpcCalls).toEqual([])
|
||||
})
|
||||
|
||||
it('refuses a document carrying a lone surrogate as content, before any RPC (L1)', async () => {
|
||||
const { client, rpcCalls } = stubClient({
|
||||
...publishable,
|
||||
name: { fr: 'Vue \ud800', en: 'View' },
|
||||
})
|
||||
await expect(
|
||||
publishSheetVersion(client, 'v1', validate),
|
||||
).rejects.toMatchObject({ kind: 'invalid_shape' })
|
||||
expect(rpcCalls).toEqual([])
|
||||
})
|
||||
})
|
||||
@@ -55,6 +55,19 @@ const expectedColumns = {
|
||||
'updated_at',
|
||||
'workspace_id',
|
||||
],
|
||||
anatomical_catalog_grants: [
|
||||
'expires_at',
|
||||
'grant_kind',
|
||||
'granted_at',
|
||||
'granted_by',
|
||||
'id',
|
||||
'reason',
|
||||
'revocation_reason',
|
||||
'revoked_at',
|
||||
'revoked_by',
|
||||
'user_id',
|
||||
'verification_note',
|
||||
],
|
||||
anatomical_sheet_assets: [
|
||||
'byte_size',
|
||||
'content_type',
|
||||
@@ -66,18 +79,58 @@ const expectedColumns = {
|
||||
'sheet_id',
|
||||
'uploaded_at',
|
||||
],
|
||||
anatomical_sheet_review_acknowledgments: [
|
||||
'created_at',
|
||||
'group_digest',
|
||||
'group_key',
|
||||
'id',
|
||||
'review_id',
|
||||
'reviewer',
|
||||
],
|
||||
anatomical_sheet_review_comments: ['author', 'body', 'created_at', 'group_key', 'id', 'review_id'],
|
||||
anatomical_sheet_reviews: [
|
||||
'attempts',
|
||||
'authors',
|
||||
'created_at',
|
||||
'decided_at',
|
||||
'decided_by',
|
||||
'decision_note',
|
||||
'failure_code',
|
||||
'failure_outcome',
|
||||
'id',
|
||||
'lease_token',
|
||||
'locked_at',
|
||||
'revision',
|
||||
'round',
|
||||
'status',
|
||||
'submission_note',
|
||||
'submitted_at',
|
||||
'submitted_by',
|
||||
'verdict',
|
||||
'verified_at',
|
||||
'verified_with',
|
||||
'version_id',
|
||||
'withdrawal_note',
|
||||
'withdrawn_at',
|
||||
'withdrawn_by',
|
||||
],
|
||||
anatomical_sheet_versions: [
|
||||
'authors',
|
||||
'change_note',
|
||||
'content',
|
||||
'created_at',
|
||||
'created_by',
|
||||
'deprecated_at',
|
||||
'deprecated_by',
|
||||
'document_fingerprint',
|
||||
'document_schema_version',
|
||||
'id',
|
||||
'published_at',
|
||||
'published_by',
|
||||
'published_review_id',
|
||||
'revision',
|
||||
'sheet_id',
|
||||
'source_version_id',
|
||||
'status',
|
||||
'updated_at',
|
||||
'version_number',
|
||||
@@ -100,6 +153,7 @@ const expectedColumns = {
|
||||
'status',
|
||||
'updated_at',
|
||||
'visibility',
|
||||
'working_copy_source_version_id',
|
||||
],
|
||||
assets: [
|
||||
'attempts',
|
||||
@@ -197,15 +251,26 @@ const expectedFunctionArgs = {
|
||||
complete_avatar_job: ['asset_id', 'byte_size', 'lock_token', 'sha256'],
|
||||
confirm_asset_upload: ['asset_id'],
|
||||
confirm_sheet_asset_upload: ['asset_id'],
|
||||
create_anatomical_sheet: [
|
||||
'description',
|
||||
'document',
|
||||
'name',
|
||||
'official',
|
||||
'slug',
|
||||
'species_id',
|
||||
'visibility',
|
||||
],
|
||||
acknowledge_sheet_review_group: ['group_digest', 'group_key', 'review_id'],
|
||||
activate_species: ['id'],
|
||||
comment_sheet_review: ['body', 'group_key', 'review_id'],
|
||||
create_official_sheet: ['document', 'slug'],
|
||||
create_species: ['id', 'name_en', 'name_fr', 'sort_order'],
|
||||
create_sheet_working_copy: ['slug', 'source_version_id'],
|
||||
decide_sheet_review: ['approve', 'note', 'review_id'],
|
||||
get_sheet_asset_state: ['asset_id'],
|
||||
get_sheet_version: ['version_id'],
|
||||
grant_catalog_right: ['expires_at', 'kind', 'reason', 'user_id', 'verification_note'],
|
||||
list_catalog_grants: [],
|
||||
list_catalog_species: [],
|
||||
list_official_catalog: [],
|
||||
lookup_catalog_account: ['email'],
|
||||
rename_species: ['id', 'name_en', 'name_fr'],
|
||||
revoke_catalog_right: ['grant_id', 'reason'],
|
||||
save_sheet_draft: ['change_note', 'document', 'expected_revision', 'version_id'],
|
||||
submit_sheet_review: ['expected_revision', 'note', 'version_id'],
|
||||
update_inactive_species: ['id', 'name_en', 'name_fr', 'sort_order'],
|
||||
withdraw_sheet_review: ['note', 'review_id'],
|
||||
create_animal: [
|
||||
'birth_date',
|
||||
'birth_year',
|
||||
@@ -247,11 +312,10 @@ const expectedFunctionArgs = {
|
||||
deprecate_sheet_version: ['reason', 'version_id'],
|
||||
end_animal_client_relation: ['ended_on', 'expected_revision', 'relation_id'],
|
||||
expire_pending_uploads: ['max_age_seconds'],
|
||||
fork_anatomical_sheet: ['name', 'slug', 'source_version_id', 'visibility'],
|
||||
grant_platform_role: ['role', 'target_user_id'],
|
||||
list_client_animals: ['after_id', 'after_sort', 'client_id', 'page_size'],
|
||||
mark_quarantine_purged: ['asset_id'],
|
||||
publish_sheet_version: ['version_id'],
|
||||
publish_sheet_version: ['review_id'],
|
||||
register_sheet_asset: ['byte_size', 'file_name', 'sha256', 'sheet_id'],
|
||||
reject_avatar_job: ['asset_id', 'lock_token', 'reason'],
|
||||
remove_avatar: [],
|
||||
@@ -276,7 +340,6 @@ const expectedFunctionArgs = {
|
||||
],
|
||||
set_animal_archived: ['animal_id', 'archived'],
|
||||
set_client_archived: ['archived', 'client_id'],
|
||||
set_sheet_visibility: ['sheet_id', 'visibility'],
|
||||
update_animal: [
|
||||
'animal_id',
|
||||
'birth_date',
|
||||
|
||||
@@ -26,6 +26,34 @@ create table auth.users (
|
||||
updated_at timestamptz default now()
|
||||
);
|
||||
|
||||
-- MFA state read by the V1-2 assurance checks (private.has_aal2_session,
|
||||
-- private.has_verified_totp). Types, names and NOT NULL columns as in GoTrue
|
||||
-- v2.197.0 (checked on the pinned image by tests/sandbox/mfa.sandbox.ts);
|
||||
-- the columns the migrations never read are left out.
|
||||
create type auth.aal_level as enum ('aal1', 'aal2', 'aal3');
|
||||
create type auth.factor_type as enum ('totp', 'webauthn', 'phone', 'recovery_code');
|
||||
create type auth.factor_status as enum ('unverified', 'verified');
|
||||
|
||||
create table auth.sessions (
|
||||
id uuid primary key,
|
||||
user_id uuid not null references auth.users (id) on delete cascade,
|
||||
created_at timestamptz,
|
||||
updated_at timestamptz,
|
||||
factor_id uuid,
|
||||
aal auth.aal_level,
|
||||
not_after timestamptz
|
||||
);
|
||||
|
||||
create table auth.mfa_factors (
|
||||
id uuid primary key,
|
||||
user_id uuid not null references auth.users (id) on delete cascade,
|
||||
friendly_name text,
|
||||
factor_type auth.factor_type not null,
|
||||
status auth.factor_status not null,
|
||||
created_at timestamptz not null,
|
||||
updated_at timestamptz not null
|
||||
);
|
||||
|
||||
create or replace function auth.uid()
|
||||
returns uuid
|
||||
language sql
|
||||
|
||||
@@ -0,0 +1,103 @@
|
||||
/**
|
||||
* GoTrue MFA calls of the sandbox (real GoTrue v2.197.0): enrol a TOTP factor,
|
||||
* challenge and verify it to reach `aal2`, remove it. Every call carries the
|
||||
* user's own access token, as the browser does. TOTP secrets and tokens stay
|
||||
* in memory and are never printed.
|
||||
*/
|
||||
import { stack } from './stack'
|
||||
import { msToNextStep, totpCode } from './totp'
|
||||
|
||||
export interface Factor {
|
||||
id: string
|
||||
secret: string
|
||||
}
|
||||
|
||||
export interface MfaResult {
|
||||
status: number
|
||||
body: Record<string, unknown>
|
||||
}
|
||||
|
||||
async function authRequest(
|
||||
method: string,
|
||||
path: string,
|
||||
token: string,
|
||||
body?: unknown,
|
||||
): Promise<MfaResult> {
|
||||
const res = await fetch(stack.authUrl + path, {
|
||||
method,
|
||||
headers: {
|
||||
apikey: stack.anonKey,
|
||||
Authorization: `Bearer ${token}`,
|
||||
'Content-Type': 'application/json',
|
||||
},
|
||||
body: body === undefined ? undefined : JSON.stringify(body),
|
||||
})
|
||||
const text = await res.text()
|
||||
let parsed: Record<string, unknown> = {}
|
||||
try {
|
||||
parsed = JSON.parse(text) as Record<string, unknown>
|
||||
} catch {
|
||||
// not JSON: keep an empty body
|
||||
}
|
||||
return { status: res.status, body: parsed }
|
||||
}
|
||||
|
||||
/** POST /factors: a new unverified TOTP factor (the secret is shown once). */
|
||||
export async function enrolTotp(
|
||||
token: string,
|
||||
name: string,
|
||||
): Promise<{ status: number; factor: Factor | null; body: MfaResult['body'] }> {
|
||||
const res = await authRequest('POST', '/factors', token, {
|
||||
factor_type: 'totp',
|
||||
friendly_name: name,
|
||||
})
|
||||
const totp = res.body.totp as { secret?: string } | undefined
|
||||
const factor =
|
||||
res.status === 200 && typeof res.body.id === 'string' && totp?.secret
|
||||
? { id: res.body.id, secret: totp.secret }
|
||||
: null
|
||||
return { status: res.status, factor, body: res.body }
|
||||
}
|
||||
|
||||
/** Challenge then verify with the current code; resolves with the new session (aal2 on success). */
|
||||
export async function verifyTotp(
|
||||
token: string,
|
||||
factor: Factor,
|
||||
): Promise<MfaResult> {
|
||||
const challenge = await authRequest(
|
||||
'POST',
|
||||
`/factors/${factor.id}/challenge`,
|
||||
token,
|
||||
{},
|
||||
)
|
||||
if (challenge.status !== 200) return challenge
|
||||
return authRequest('POST', `/factors/${factor.id}/verify`, token, {
|
||||
challenge_id: challenge.body.id,
|
||||
code: totpCode(factor.secret),
|
||||
})
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify with a code of a step not used before for this factor: GoTrue refuses
|
||||
* a code it already accepted, so a second verification waits for the next step.
|
||||
*/
|
||||
export async function verifyTotpFreshStep(
|
||||
token: string,
|
||||
factor: Factor,
|
||||
): Promise<MfaResult> {
|
||||
await new Promise((resolve) => setTimeout(resolve, msToNextStep() + 200))
|
||||
return verifyTotp(token, factor)
|
||||
}
|
||||
|
||||
export function unenrol(token: string, factorId: string): Promise<MfaResult> {
|
||||
return authRequest('DELETE', `/factors/${factorId}`, token)
|
||||
}
|
||||
|
||||
/** The claims of an access token (payload only; the signature is not checked here). */
|
||||
export function claimsOf(token: string): Record<string, unknown> {
|
||||
const payload = token.split('.')[1] ?? ''
|
||||
return JSON.parse(Buffer.from(payload, 'base64url').toString('utf8')) as Record<
|
||||
string,
|
||||
unknown
|
||||
>
|
||||
}
|
||||
@@ -0,0 +1,91 @@
|
||||
/**
|
||||
* V1-2.1 on the throwaway stack with REAL GoTrue and PostgreSQL: the AR-1 B
|
||||
* path proven with real TOTP factors and real sessions (pgTAP uses fabricated
|
||||
* auth rows), and the last-owner race under two concurrent transactions (F18).
|
||||
* Contract docs/development/V1-2_ANATOMICAL_SHEETS.md §5.7, §15. Run through
|
||||
* `pnpm db:sandbox test tests/sandbox/sheets.sandbox.ts`.
|
||||
*/
|
||||
import { confirmedAccount, rpc, sql, errorCode, type Account } from './stack'
|
||||
import { enrolTotp, verifyTotp, claimsOf } from './mfa'
|
||||
|
||||
/** Enrols and verifies a TOTP factor, returning a fresh aal2 access token. */
|
||||
async function stepUp(account: Account): Promise<string> {
|
||||
const enrol = await enrolTotp(account.token, 'device')
|
||||
if (!enrol.factor) throw new Error(`enrol failed: ${JSON.stringify(enrol.body)}`)
|
||||
const verified = await verifyTotp(account.token, enrol.factor)
|
||||
const token = verified.body.access_token as string
|
||||
if (!token) throw new Error(`verify failed: ${JSON.stringify(verified.body)}`)
|
||||
return token
|
||||
}
|
||||
|
||||
describe('AR-1 B on real GoTrue', () => {
|
||||
let owner: Account
|
||||
let ownerAal2: string
|
||||
let target: Account
|
||||
|
||||
beforeAll(async () => {
|
||||
owner = await confirmedAccount('ar1-owner')
|
||||
target = await confirmedAccount('ar1-target')
|
||||
// Bootstrap the owner role through the operator path (no JWT).
|
||||
await sql(`select private.assign_platform_role(null, '${owner.id}', 'owner')`)
|
||||
// The target holds a verified factor (a grant needs one).
|
||||
await stepUp(target)
|
||||
ownerAal2 = await stepUp(owner)
|
||||
}, 120_000)
|
||||
|
||||
it('refuses a platform role change from the aal1 session', async () => {
|
||||
const res = await rpc('grant_platform_role', { target_user_id: target.id, role: 'support' }, owner.token)
|
||||
expect(claimsOf(owner.token).aal).toBe('aal1')
|
||||
expect([res.status, errorCode(res)]).toEqual([403, '42501'])
|
||||
expect((res.body as { message?: string }).message).toBe('mfa_required')
|
||||
})
|
||||
|
||||
it('allows the change from a live aal2 session, then reads it back', async () => {
|
||||
expect(claimsOf(ownerAal2).aal).toBe('aal2')
|
||||
const res = await rpc('grant_platform_role', { target_user_id: target.id, role: 'support' }, ownerAal2)
|
||||
expect(res.status).toBe(200)
|
||||
expect(await sql(`select count(*) from public.profile_roles where user_id = '${target.id}' and role = 'support' and revoked_at is null`)).toBe('1')
|
||||
})
|
||||
|
||||
it('refuses a grant to an account with no verified factor', async () => {
|
||||
const noFactor = await confirmedAccount('ar1-nofactor')
|
||||
const res = await rpc('grant_platform_role', { target_user_id: noFactor.id, role: 'moderator' }, ownerAal2)
|
||||
expect([res.status, (res.body as { message?: string }).message]).toEqual([400, 'target_factor_missing'])
|
||||
await sql(`delete from auth.users where id = '${noFactor.id}'`)
|
||||
})
|
||||
|
||||
afterAll(async () => {
|
||||
for (const a of [owner, target]) if (a?.id) await sql(`delete from auth.users where id = '${a.id}'`).catch(() => {})
|
||||
})
|
||||
})
|
||||
|
||||
describe('last-owner race (F18)', () => {
|
||||
it('two concurrent revocations of two owners leave one owner', async () => {
|
||||
const a = await confirmedAccount('f18-a')
|
||||
const b = await confirmedAccount('f18-b')
|
||||
const aAal2 = await stepUp(a)
|
||||
const bAal2 = await stepUp(b)
|
||||
await sql(`select private.assign_platform_role(null, '${a.id}', 'owner')`)
|
||||
await sql(`select private.assign_platform_role(null, '${b.id}', 'owner')`)
|
||||
// Neutralise every other owner so a and b are the only two.
|
||||
await sql(`update public.profile_roles set revoked_at = now(), revoke_reason = 'f18 test'
|
||||
where role = 'owner' and revoked_at is null and user_id not in ('${a.id}', '${b.id}')`)
|
||||
expect(await sql(`select count(*) from public.profile_roles where role = 'owner' and revoked_at is null`)).toBe('2')
|
||||
|
||||
// Each revokes the other, concurrently.
|
||||
const [ra, rb] = await Promise.all([
|
||||
rpc('revoke_platform_role', { target_user_id: b.id, role: 'owner', reason: 'race a' }, aAal2),
|
||||
rpc('revoke_platform_role', { target_user_id: a.id, role: 'owner', reason: 'race b' }, bAal2),
|
||||
])
|
||||
const statuses = [ra.status, rb.status]
|
||||
// The invariant that F18 broke: the two cannot both pass and leave zero
|
||||
// owners. Exactly one succeeds; the other is refused (last_owner when it
|
||||
// reaches the guard, or forbidden when it lost its own ownership first);
|
||||
// one owner always remains.
|
||||
expect(statuses.filter((s) => s === 200), JSON.stringify([ra.body, rb.body])).toHaveLength(1)
|
||||
expect(statuses.filter((s) => s !== 200)).toHaveLength(1)
|
||||
expect(await sql(`select count(*) from public.profile_roles where role = 'owner' and revoked_at is null`)).toBe('1')
|
||||
|
||||
await sql(`delete from auth.users where id in ('${a.id}', '${b.id}')`)
|
||||
}, 120_000)
|
||||
})
|
||||
@@ -0,0 +1,45 @@
|
||||
/**
|
||||
* RFC 6238 TOTP codes for the sandbox MFA tests (contract
|
||||
* docs/development/V1-2_ANATOMICAL_SHEETS.md §15): HMAC-SHA1, 30 s steps,
|
||||
* 6 digits, the parameters GoTrue v2.197.0 uses. Node `crypto` only, no
|
||||
* dependency. The secret stays in the test's memory: never printed, logged or
|
||||
* written anywhere.
|
||||
*/
|
||||
import { createHmac } from 'node:crypto'
|
||||
|
||||
const BASE32 = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567'
|
||||
export const TOTP_STEP_SECONDS = 30
|
||||
|
||||
function base32Decode(text: string): Buffer {
|
||||
const clean = text.replace(/=+$/, '').toUpperCase()
|
||||
const bytes: number[] = []
|
||||
let buffer = 0
|
||||
let bits = 0
|
||||
for (const char of clean) {
|
||||
const value = BASE32.indexOf(char)
|
||||
if (value < 0) throw new Error('totp: secret is not base32')
|
||||
buffer = (buffer << 5) | value
|
||||
bits += 5
|
||||
if (bits >= 8) {
|
||||
bits -= 8
|
||||
bytes.push((buffer >> bits) & 0xff)
|
||||
}
|
||||
}
|
||||
return Buffer.from(bytes)
|
||||
}
|
||||
|
||||
/** The 6-digit code of `secret` for the step holding `at` (ms since epoch). */
|
||||
export function totpCode(secret: string, at = Date.now()): string {
|
||||
const counter = Buffer.alloc(8)
|
||||
counter.writeBigUInt64BE(BigInt(Math.floor(at / 1000 / TOTP_STEP_SECONDS)))
|
||||
const mac = createHmac('sha1', base32Decode(secret)).update(counter).digest()
|
||||
const offset = mac[mac.length - 1] & 0x0f
|
||||
const value = (mac.readUInt32BE(offset) & 0x7fffffff) % 1_000_000
|
||||
return value.toString().padStart(6, '0')
|
||||
}
|
||||
|
||||
/** Milliseconds until the next step starts (a fresh code). */
|
||||
export function msToNextStep(at = Date.now()): number {
|
||||
const step = TOTP_STEP_SECONDS * 1000
|
||||
return step - (at % step)
|
||||
}
|
||||
@@ -18,6 +18,9 @@ import {
|
||||
sql,
|
||||
sqlOutcome,
|
||||
stack,
|
||||
} from './stack'
|
||||
import { enrolTotp, verifyTotp } from './mfa'
|
||||
import {
|
||||
uniqueEmail,
|
||||
type Account,
|
||||
} from './stack'
|
||||
@@ -194,11 +197,18 @@ describe('reads and refusals per role', () => {
|
||||
})
|
||||
|
||||
it('stores an oversized correlation header as null and keeps a short token', async () => {
|
||||
// AR-1 B: the role RPCs need a live aal2 session and a factored target, so
|
||||
// the seed owner steps up and b enrols a factor before the grant.
|
||||
const owner = await signIn(
|
||||
'owner@faunosteo.local',
|
||||
'LocalDev-only-password-1',
|
||||
)
|
||||
const token = owner.body.access_token as string
|
||||
const ownerToken = owner.body.access_token as string
|
||||
const ownerEnrol = await enrolTotp(ownerToken, 'owner device')
|
||||
const token = (await verifyTotp(ownerToken, ownerEnrol.factor!)).body
|
||||
.access_token as string
|
||||
const bEnrol = await enrolTotp(b.token, 'b device')
|
||||
await verifyTotp(b.token, bEnrol.factor!)
|
||||
const grant = await rpc(
|
||||
'grant_platform_role',
|
||||
{ target_user_id: b.id, role: 'support' },
|
||||
|
||||
Reference in new issue
Block a user