@jantstack/adonis-authz 2.0.0-alpha.1 → 2.4.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +462 -35
- package/build/commands/authz_catalog_diff.js +1 -1
- package/build/commands/authz_catalog_diff.js.map +1 -1
- package/build/commands/authz_catalog_prune_orphans.d.ts +78 -0
- package/build/commands/authz_catalog_prune_orphans.d.ts.map +1 -0
- package/build/commands/authz_catalog_prune_orphans.js +136 -0
- package/build/commands/authz_catalog_prune_orphans.js.map +1 -0
- package/build/commands/authz_catalog_sync.d.ts +17 -0
- package/build/commands/authz_catalog_sync.d.ts.map +1 -1
- package/build/commands/authz_catalog_sync.js +27 -4
- package/build/commands/authz_catalog_sync.js.map +1 -1
- package/build/commands/authz_freeze.d.ts +44 -0
- package/build/commands/authz_freeze.d.ts.map +1 -0
- package/build/commands/authz_freeze.js +95 -0
- package/build/commands/authz_freeze.js.map +1 -0
- package/build/commands/authz_reconcile.d.ts +102 -0
- package/build/commands/authz_reconcile.d.ts.map +1 -0
- package/build/commands/authz_reconcile.js +294 -0
- package/build/commands/authz_reconcile.js.map +1 -0
- package/build/commands/authz_relations_reconcile.d.ts +73 -0
- package/build/commands/authz_relations_reconcile.d.ts.map +1 -0
- package/build/commands/authz_relations_reconcile.js +225 -0
- package/build/commands/authz_relations_reconcile.js.map +1 -0
- package/build/commands/authz_scopes_relay.d.ts +47 -0
- package/build/commands/authz_scopes_relay.d.ts.map +1 -0
- package/build/commands/authz_scopes_relay.js +141 -0
- package/build/commands/authz_scopes_relay.js.map +1 -0
- package/build/commands/authz_unfreeze.d.ts +37 -0
- package/build/commands/authz_unfreeze.d.ts.map +1 -0
- package/build/commands/authz_unfreeze.js +92 -0
- package/build/commands/authz_unfreeze.js.map +1 -0
- package/build/commands/main.d.ts +6 -1
- package/build/commands/main.d.ts.map +1 -1
- package/build/commands/main.js +6 -1
- package/build/commands/main.js.map +1 -1
- package/build/commands/openfga_provision.d.ts +46 -4
- package/build/commands/openfga_provision.d.ts.map +1 -1
- package/build/commands/openfga_provision.js +90 -7
- package/build/commands/openfga_provision.js.map +1 -1
- package/build/configure.d.ts +11 -0
- package/build/configure.d.ts.map +1 -1
- package/build/configure.js +37 -1
- package/build/configure.js.map +1 -1
- package/build/index.d.ts +39 -10
- package/build/index.d.ts.map +1 -1
- package/build/index.js +35 -6
- package/build/index.js.map +1 -1
- package/build/providers/authz_provider.d.ts +26 -2
- package/build/providers/authz_provider.d.ts.map +1 -1
- package/build/providers/authz_provider.js +48 -2
- package/build/providers/authz_provider.js.map +1 -1
- package/build/services/relations.d.ts +14 -0
- package/build/services/relations.d.ts.map +1 -0
- package/build/services/relations.js +17 -0
- package/build/services/relations.js.map +1 -0
- package/build/src/{catalog.d.ts → catalog/catalog.d.ts} +41 -2
- package/build/src/catalog/catalog.d.ts.map +1 -0
- package/build/src/{catalog.js → catalog/catalog.js} +120 -14
- package/build/src/catalog/catalog.js.map +1 -0
- package/build/src/{catalog_cache.d.ts → catalog/catalog_cache.d.ts} +46 -22
- package/build/src/catalog/catalog_cache.d.ts.map +1 -0
- package/build/src/{catalog_cache.js → catalog/catalog_cache.js} +53 -43
- package/build/src/catalog/catalog_cache.js.map +1 -0
- package/build/src/define_config.d.ts +101 -3
- package/build/src/define_config.d.ts.map +1 -1
- package/build/src/define_config.js.map +1 -1
- package/build/src/drivers/database_driver.d.ts +86 -4
- package/build/src/drivers/database_driver.d.ts.map +1 -1
- package/build/src/drivers/database_driver.js +425 -11
- package/build/src/drivers/database_driver.js.map +1 -1
- package/build/src/drivers/database_relations_driver.d.ts +75 -0
- package/build/src/drivers/database_relations_driver.d.ts.map +1 -0
- package/build/src/drivers/database_relations_driver.js +450 -0
- package/build/src/drivers/database_relations_driver.js.map +1 -0
- package/build/src/drivers/openfga_driver.d.ts +713 -119
- package/build/src/drivers/openfga_driver.d.ts.map +1 -1
- package/build/src/drivers/openfga_driver.js +2048 -476
- package/build/src/drivers/openfga_driver.js.map +1 -1
- package/build/src/drivers/openfga_facts.d.ts +369 -0
- package/build/src/drivers/openfga_facts.d.ts.map +1 -0
- package/build/src/drivers/openfga_facts.js +813 -0
- package/build/src/drivers/openfga_facts.js.map +1 -0
- package/build/src/drivers/openfga_relations_driver.d.ts +120 -0
- package/build/src/drivers/openfga_relations_driver.d.ts.map +1 -0
- package/build/src/drivers/openfga_relations_driver.js +466 -0
- package/build/src/drivers/openfga_relations_driver.js.map +1 -0
- package/build/src/errors.d.ts +258 -5
- package/build/src/errors.d.ts.map +1 -1
- package/build/src/errors.js +238 -7
- package/build/src/errors.js.map +1 -1
- package/build/src/freeze.d.ts +120 -0
- package/build/src/freeze.d.ts.map +1 -0
- package/build/src/freeze.js +172 -0
- package/build/src/freeze.js.map +1 -0
- package/build/src/http/app_access_middleware.d.ts.map +1 -0
- package/build/src/http/app_access_middleware.js.map +1 -0
- package/build/src/http/resource_access_middleware.d.ts +105 -0
- package/build/src/http/resource_access_middleware.d.ts.map +1 -0
- package/build/src/http/resource_access_middleware.js +81 -0
- package/build/src/http/resource_access_middleware.js.map +1 -0
- package/build/src/identity.d.ts +74 -1
- package/build/src/identity.d.ts.map +1 -1
- package/build/src/identity.js +100 -2
- package/build/src/identity.js.map +1 -1
- package/build/src/manager.d.ts +315 -4
- package/build/src/manager.d.ts.map +1 -1
- package/build/src/manager.js +1187 -181
- package/build/src/manager.js.map +1 -1
- package/build/src/models/authz_assignment.d.ts +6 -6
- package/build/src/models/authz_assignment.d.ts.map +1 -1
- package/build/src/models/authz_deny.d.ts +6 -6
- package/build/src/models/authz_deny.d.ts.map +1 -1
- package/build/src/models/authz_permission.d.ts +6 -6
- package/build/src/models/authz_permission.d.ts.map +1 -1
- package/build/src/models/authz_role.d.ts +6 -6
- package/build/src/models/authz_role.d.ts.map +1 -1
- package/build/src/models/authz_role_permission.d.ts +6 -6
- package/build/src/models/authz_role_permission.d.ts.map +1 -1
- package/build/src/openfga.d.ts +18 -2
- package/build/src/openfga.d.ts.map +1 -1
- package/build/src/openfga.js +15 -1
- package/build/src/openfga.js.map +1 -1
- package/build/src/reconcile.d.ts +37 -0
- package/build/src/reconcile.d.ts.map +1 -0
- package/build/src/reconcile.js +69 -0
- package/build/src/reconcile.js.map +1 -0
- package/build/src/relation_partition_trigger.d.ts +8 -0
- package/build/src/relation_partition_trigger.d.ts.map +1 -0
- package/build/src/relation_partition_trigger.js +85 -0
- package/build/src/relation_partition_trigger.js.map +1 -0
- package/build/src/relations/define_relations_config.d.ts +58 -0
- package/build/src/relations/define_relations_config.d.ts.map +1 -0
- package/build/src/relations/define_relations_config.js +144 -0
- package/build/src/relations/define_relations_config.js.map +1 -0
- package/build/src/relations/manager.d.ts +38 -0
- package/build/src/relations/manager.d.ts.map +1 -0
- package/build/src/relations/manager.js +156 -0
- package/build/src/relations/manager.js.map +1 -0
- package/build/src/relations/reconcile.d.ts +62 -0
- package/build/src/relations/reconcile.d.ts.map +1 -0
- package/build/src/relations/reconcile.js +138 -0
- package/build/src/relations/reconcile.js.map +1 -0
- package/build/src/relations_config_store.d.ts +22 -0
- package/build/src/relations_config_store.d.ts.map +1 -0
- package/build/src/relations_config_store.js +74 -0
- package/build/src/relations_config_store.js.map +1 -0
- package/build/src/scope_outbox.d.ts +69 -0
- package/build/src/scope_outbox.d.ts.map +1 -0
- package/build/src/scope_outbox.js +291 -0
- package/build/src/scope_outbox.js.map +1 -0
- package/build/src/{drivers → shared}/backend_guard.d.ts +14 -0
- package/build/src/shared/backend_guard.d.ts.map +1 -0
- package/build/src/{drivers → shared}/backend_guard.js +26 -1
- package/build/src/shared/backend_guard.js.map +1 -0
- package/build/src/shared/sql_expiry.d.ts.map +1 -0
- package/build/src/shared/sql_expiry.js.map +1 -0
- package/build/src/sql_descendants.d.ts +47 -1
- package/build/src/sql_descendants.d.ts.map +1 -1
- package/build/src/sql_descendants.js +75 -1
- package/build/src/sql_descendants.js.map +1 -1
- package/build/src/testing/contract.d.ts +74 -0
- package/build/src/testing/contract.d.ts.map +1 -1
- package/build/src/testing/contract.js +672 -169
- package/build/src/testing/contract.js.map +1 -1
- package/build/src/testing/main.d.ts +6 -0
- package/build/src/testing/main.d.ts.map +1 -1
- package/build/src/testing/main.js +3 -0
- package/build/src/testing/main.js.map +1 -1
- package/build/src/testing/migration_contract.d.ts +284 -0
- package/build/src/testing/migration_contract.d.ts.map +1 -0
- package/build/src/testing/migration_contract.js +586 -0
- package/build/src/testing/migration_contract.js.map +1 -0
- package/build/src/testing/relations_contract.d.ts +51 -0
- package/build/src/testing/relations_contract.d.ts.map +1 -0
- package/build/src/testing/relations_contract.js +654 -0
- package/build/src/testing/relations_contract.js.map +1 -0
- package/build/src/testing/relations_reconcile_contract.d.ts +24 -0
- package/build/src/testing/relations_reconcile_contract.d.ts.map +1 -0
- package/build/src/testing/relations_reconcile_contract.js +172 -0
- package/build/src/testing/relations_reconcile_contract.js.map +1 -0
- package/build/src/traits/authz_scopes.js +1 -1
- package/build/src/traits/authz_scopes.js.map +1 -1
- package/build/src/traits/has_uuid.d.ts +7 -7
- package/build/src/traits/has_uuid.d.ts.map +1 -1
- package/build/src/types.d.ts +865 -82
- package/build/src/types.d.ts.map +1 -1
- package/build/src/types.js +10 -0
- package/build/src/types.js.map +1 -1
- package/build/stubs/config/authorization.stub +104 -4
- package/build/stubs/migration.stub +126 -0
- package/build/stubs/scopes_outbox_migration.stub +57 -0
- package/package.json +4 -2
- package/build/commands/openfga_import.d.ts +0 -34
- package/build/commands/openfga_import.d.ts.map +0 -1
- package/build/commands/openfga_import.js +0 -97
- package/build/commands/openfga_import.js.map +0 -1
- package/build/src/catalog.d.ts.map +0 -1
- package/build/src/catalog.js.map +0 -1
- package/build/src/catalog_cache.d.ts.map +0 -1
- package/build/src/catalog_cache.js.map +0 -1
- package/build/src/drivers/backend_guard.d.ts.map +0 -1
- package/build/src/drivers/backend_guard.js.map +0 -1
- package/build/src/drivers/sql_expiry.d.ts.map +0 -1
- package/build/src/drivers/sql_expiry.js.map +0 -1
- package/build/src/middleware/app_access_middleware.d.ts.map +0 -1
- package/build/src/middleware/app_access_middleware.js.map +0 -1
- /package/build/src/{middleware → http}/app_access_middleware.d.ts +0 -0
- /package/build/src/{middleware → http}/app_access_middleware.js +0 -0
- /package/build/src/{drivers → shared}/sql_expiry.d.ts +0 -0
- /package/build/src/{drivers → shared}/sql_expiry.js +0 -0
package/build/src/types.d.ts
CHANGED
|
@@ -105,6 +105,23 @@ export interface ScopedWriteOptions extends WriteOptions {
|
|
|
105
105
|
*/
|
|
106
106
|
within?: ScopeRef;
|
|
107
107
|
}
|
|
108
|
+
/**
|
|
109
|
+
* Opciones de las TRES notificaciones del árbol (`scopes.attached/moved/
|
|
110
|
+
* detached`) — 3b-2d. Añaden la transacción del consumidor, que solo se usa
|
|
111
|
+
* cuando hay `scopes.outbox` declarada: es lo que hace que el cambio del
|
|
112
|
+
* árbol y su encolado confirmen (o se vayan) juntos.
|
|
113
|
+
*/
|
|
114
|
+
export interface ScopeTreeWriteOptions extends ScopedWriteOptions {
|
|
115
|
+
/**
|
|
116
|
+
* La transacción ABIERTA del consumidor (`TransactionClientContract` de
|
|
117
|
+
* Lucid, o lo que use su outbox). El paquete no la interpreta: se la pasa
|
|
118
|
+
* tal cual a `scopes.outbox.enqueue` para que el INSERT del encolado caiga
|
|
119
|
+
* dentro de ella. Sin outbox declarada no hace nada; con outbox declarada
|
|
120
|
+
* y sin transacción, el encolado se confirma solo y vuelve a haber dos
|
|
121
|
+
* confirmaciones distintas (la outbox lo avisa si puede).
|
|
122
|
+
*/
|
|
123
|
+
transaction?: unknown;
|
|
124
|
+
}
|
|
108
125
|
export interface GrantOptions extends ScopedWriteOptions {
|
|
109
126
|
/**
|
|
110
127
|
* Caducidad de la asignación, en TRES estados (L0.4):
|
|
@@ -162,7 +179,89 @@ export type NormalizedRoleQuery = {
|
|
|
162
179
|
slug?: undefined;
|
|
163
180
|
scopeType?: undefined;
|
|
164
181
|
};
|
|
182
|
+
/**
|
|
183
|
+
* **Lo que un driver DECLARA de sí mismo** (3b-2e · E2). No es documentación:
|
|
184
|
+
* el manager lo LEE (el gate de deriva del árbol, E3) y la suite de contrato
|
|
185
|
+
* exige a cada capacidad su caso —el del valor declarado, nunca un `skip`—.
|
|
186
|
+
*
|
|
187
|
+
* Todas son opcionales de declarar (un driver de 2.x que no traiga
|
|
188
|
+
* `capabilities` se trata como todo `false`), pero declarar `true` lo que no
|
|
189
|
+
* se cumple es una promesa sin juez: el contrato lanza al registrarse.
|
|
190
|
+
*/
|
|
191
|
+
export interface AuthorizationDriverCapabilities {
|
|
192
|
+
/**
|
|
193
|
+
* El ÁRBOL de scopes vive como hechos del backend y el backend es el PDP
|
|
194
|
+
* (`openfga` con `hierarchy: 'facts'`). Con `true` el manager exige la
|
|
195
|
+
* mitigación de la deriva (`scopes.outbox` o la firma explícita): el árbol
|
|
196
|
+
* está en dos sitios y un `rollback` del consumidor deja al backend
|
|
197
|
+
* adelantado (cruce 4 · S5).
|
|
198
|
+
*/
|
|
199
|
+
hierarchyFacts: boolean;
|
|
200
|
+
/**
|
|
201
|
+
* `authorize` es UNA sola llamada al backend: no consulta el árbol del
|
|
202
|
+
* consumidor (`resolveChain`) y el catálogo solo a través del memo.
|
|
203
|
+
*/
|
|
204
|
+
singleCheckAuthorize: boolean;
|
|
205
|
+
/**
|
|
206
|
+
* El backend resuelve la MEMBRESÍA por sí mismo. **`false` en los dos
|
|
207
|
+
* drivers del paquete, también en `facts`** (panel 2, cruce 6): `hasRole`,
|
|
208
|
+
* `listRoles`, `listRoleScopes`, `listSubjects` y `listScopes` siguen
|
|
209
|
+
* usando `resolveChain`. Por eso el titular «sin SQL en el camino caliente»
|
|
210
|
+
* está PROHIBIDO a secas: lo cierto es «sin SQL por request en `authorize`».
|
|
211
|
+
*/
|
|
212
|
+
roleInheritanceNative: boolean;
|
|
213
|
+
/**
|
|
214
|
+
* Los `list*` enumeran también lo HEREDADO. **`false` siempre en este
|
|
215
|
+
* paquete** (invariante 7): enumerar descendientes sería abierto, y en
|
|
216
|
+
* `openfga` además obligaría a `ListObjects`, que trunca al tope del
|
|
217
|
+
* servidor sin ninguna señal (S16). Los `list*` devuelven hechos DIRECTOS.
|
|
218
|
+
*/
|
|
219
|
+
listObjectsInherited: boolean;
|
|
220
|
+
/** El driver implementa `purgeRole` de verdad (sin él no hay roles locales). */
|
|
221
|
+
purgeRole: boolean;
|
|
222
|
+
/**
|
|
223
|
+
* El driver sabe CONTAR los hechos vigentes de un rol
|
|
224
|
+
* (`countRoleAssignments`, 3b-2j). Es lo que hace verdadero el
|
|
225
|
+
* `stillGranting` de `pruneOrphanRoles`, que se lee justo antes de un
|
|
226
|
+
* borrado destructivo. Con `false` el barrido no lo sabe y lo dice
|
|
227
|
+
* (`undefined`), nunca `false`: «no lo sé» no puede degradar a «no
|
|
228
|
+
* concede».
|
|
229
|
+
*/
|
|
230
|
+
countRoleAssignments: boolean;
|
|
231
|
+
/**
|
|
232
|
+
* Las LECTURAS canonizan la ortografía del scope contra el árbol del
|
|
233
|
+
* consumidor antes de buscar los hechos (3b-2k · K1 · R2 (c)). Con `true`
|
|
234
|
+
* (driver `database`) `authorize` resuelve la cadena y usa `chain[0]`, la
|
|
235
|
+
* identidad canónica (invariante 17), así que un alias del uuid que TU
|
|
236
|
+
* tabla funde con la fila real —una columna `uuid` de PostgreSQL, una
|
|
237
|
+
* collation `*_ci` de MySQL— encuentra los mismos hechos. Con `false`
|
|
238
|
+
* (`openfga` en modo `facts`) la decisión no pasa por el árbol —es la
|
|
239
|
+
* contrapartida de `singleCheckAuthorize`— y el objeto del store se compone
|
|
240
|
+
* con la ortografía del LLAMANTE: un alias responde `false` donde la forma
|
|
241
|
+
* canónica concede. Es fail-CLOSED y no evade ningún deny, pero no es la
|
|
242
|
+
* misma respuesta: **pasa los uuids exactamente como los guarda tu tabla**.
|
|
243
|
+
* La ESCRITURA canoniza en los dos (3b-2h · 🟠 3).
|
|
244
|
+
*/
|
|
245
|
+
canonicalScopeReads: boolean;
|
|
246
|
+
/**
|
|
247
|
+
* El driver sabe ser el **ORIGEN** de una migración: implementa
|
|
248
|
+
* `enumerateFacts` y entrega sus hechos paginados, sin filtrar y con su
|
|
249
|
+
* caducidad (3b-3b). Con `true` es lo que `authz:reconcile --to=<otro>`
|
|
250
|
+
* pasa como `source.facts`. Con `false` el driver no puede ser origen por
|
|
251
|
+
* el puerto y `authz:reconcile` lo DICE (500 `E_AUTHZ_UNSUPPORTED`
|
|
252
|
+
* nombrando `enumerateFacts`), nunca una migración vacía en silencio — que
|
|
253
|
+
* es exactamente el fail-dangerous que se evita: un origen que devuelve
|
|
254
|
+
* cero hechos y un `--prune` detrás borran el destino entero.
|
|
255
|
+
*
|
|
256
|
+
* **`false` en el driver `database` a propósito**: sus hechos son
|
|
257
|
+
* `authz_assignments`/`authz_denies`, el esquema publicado del paquete, y
|
|
258
|
+
* el destino los lee de ahí directamente (`openfga.reconcile`).
|
|
259
|
+
*/
|
|
260
|
+
enumerateFacts: boolean;
|
|
261
|
+
}
|
|
165
262
|
export interface AuthorizationDriver {
|
|
263
|
+
/** Lo que este driver declara poder hacer (3b-2e · E2). Ver `AuthorizationDriverCapabilities`. */
|
|
264
|
+
readonly capabilities?: AuthorizationDriverCapabilities;
|
|
166
265
|
/**
|
|
167
266
|
* ¿El holder tiene el permiso en el scope? Evalúa la cadena completa:
|
|
168
267
|
* sin deny en la cadena Y alguna asignación vigente cuyo rol concede el
|
|
@@ -303,6 +402,102 @@ export interface AuthorizationDriver {
|
|
|
303
402
|
* `defineScopedRole` lo dice antes de escribir nada (3E · P4).
|
|
304
403
|
*/
|
|
305
404
|
purgeRole?(roleUuid: string): Promise<void>;
|
|
405
|
+
/**
|
|
406
|
+
* Cuántos hechos VIGENTES tiene cada rol, en TODOS los scopes (3b-2j,
|
|
407
|
+
* decisión del dueño del 2026-08-31 (3)). Un hecho es una asignación del
|
|
408
|
+
* rol a un holder que no ha caducado (`expiresAt` nulo o futuro, con el
|
|
409
|
+
* reloj del driver); el rol se identifica por su uuid y la respuesta va
|
|
410
|
+
* POR POSICIÓN, como `authorizeMany`. Un rol sin hechos —o que el backend
|
|
411
|
+
* no conoce— es `0`; `uuid` mal formado ⇒ 422 `E_AUTHZ_INVALID_IDENTITY`.
|
|
412
|
+
*
|
|
413
|
+
* Es lo que `pruneOrphanRoles` (`authz:catalog:prune-orphans`) necesita
|
|
414
|
+
* para decir si un rol huérfano TODAVÍA CONCEDE, y es una pregunta del
|
|
415
|
+
* PUERTO porque los hechos son del driver: hasta 3b-2j el barrido contaba
|
|
416
|
+
* filas de `authz_assignments` —la tabla del driver `database`— y con
|
|
417
|
+
* `openfga` en modo `facts`, donde viven en el store, decía siempre que
|
|
418
|
+
* no. El campo se lee justo antes de un borrado destructivo y su contrato
|
|
419
|
+
* publicado es «falso ⇒ este rol seguro que no concede», así que ese
|
|
420
|
+
* `false` era fail-dangerous.
|
|
421
|
+
*
|
|
422
|
+
* Es CONSERVADOR a propósito: cuenta hechos, no comprueba si el scope de
|
|
423
|
+
* cada uno sigue resolviendo. Cero ⇒ no concede seguro; más de cero ⇒
|
|
424
|
+
* míralo antes de purgar.
|
|
425
|
+
*
|
|
426
|
+
* OPCIONAL en el puerto (**breaking para un driver de 2.2 que no lo
|
|
427
|
+
* traiga**, y por eso opcional y no obligatorio): sin él
|
|
428
|
+
* `pruneOrphanRoles` deja `assignments` y `stillGranting` en `undefined`
|
|
429
|
+
* —jamás en `false`— y el comando lista esos roles APARTE, como los que sí
|
|
430
|
+
* conceden. Capacidad `countRoleAssignments`.
|
|
431
|
+
*/
|
|
432
|
+
countRoleAssignments?(roleUuids: string[]): Promise<number[]>;
|
|
433
|
+
/**
|
|
434
|
+
* Rehace la **proyección derivada** del catálogo para UN rol (3b-2e · E4).
|
|
435
|
+
* Opcional: solo la implementa un driver que mantenga esa proyección (el
|
|
436
|
+
* `openfga` en modo `facts`, donde lo que un rol concede son tuplas y no
|
|
437
|
+
* el catálogo local). El manager la llama después de `defineScopedRole` y
|
|
438
|
+
* `updateScopedRole` —las dos escrituras de catálogo que cambian los
|
|
439
|
+
* vínculos de un rol fuera de `syncAuthzCatalog`—, porque si no un rol
|
|
440
|
+
* recién definido no concedería NADA y un rol al que se le quita un permiso
|
|
441
|
+
* lo seguiría concediendo (fail-open). En `database` no existe: el catálogo
|
|
442
|
+
* es la fuente y no hay espejo que rehacer.
|
|
443
|
+
*/
|
|
444
|
+
projectCatalogRole?(roleUuid: string): Promise<void>;
|
|
445
|
+
/**
|
|
446
|
+
* La **proyección derivada del catálogo entero** de este driver (3b-2a ·
|
|
447
|
+
* A5), para inyectarla en `syncAuthzCatalog`/`syncCatalogs`. Opcional por
|
|
448
|
+
* el mismo motivo que `projectCatalogRole`: solo la trae un driver que
|
|
449
|
+
* mantenga un espejo del catálogo en su backend (el `openfga` en modo
|
|
450
|
+
* `facts`).
|
|
451
|
+
*
|
|
452
|
+
* Está en el PUERTO porque el camino de recuperación documentado —«un
|
|
453
|
+
* `authz:catalog:sync` reescribe la proyección»— lo ejecuta un comando que
|
|
454
|
+
* solo ve `AuthorizationDriver` (3b-8 · A1): sin esto, el CLI sincronizaba
|
|
455
|
+
* `authz_*` y dejaba el espejo del store SIN TOCAR, o sea que en `facts`
|
|
456
|
+
* un permiso quitado del catálogo seguía concediendo y un rol nuevo no
|
|
457
|
+
* concedía nada.
|
|
458
|
+
*/
|
|
459
|
+
catalogProjection?(): CatalogProjection;
|
|
460
|
+
/**
|
|
461
|
+
* **Reconstruye el estado de ESTE driver desde `authz_*` + el árbol del
|
|
462
|
+
* consumidor** (3b-3a). Es lo que hay detrás de `authz:reconcile --to=<este
|
|
463
|
+
* driver>`: hechos, árbol y proyección del catálogo, idempotente
|
|
464
|
+
* (la segunda pasada escribe cero), reanudable por lotes con cursor y
|
|
465
|
+
* **nunca silenciosa** (el reporte cuenta lo escrito, lo actualizado, lo
|
|
466
|
+
* igual, lo que sobra, lo borrado y lo que NO se migró con su motivo).
|
|
467
|
+
*
|
|
468
|
+
* `dryRun` es el VERIFICADOR: mismo recorrido, cero escrituras. Es
|
|
469
|
+
* **read-only por contrato** (panel 2, cruce 4 · S18) — un `--fix` sería un
|
|
470
|
+
* mecanismo de concesión y queda PROHIBIDO.
|
|
471
|
+
*
|
|
472
|
+
* Opcional en el puerto: un driver que no lo trae dice «no sé
|
|
473
|
+
* reconstruirme» y el manager responde 500 `E_AUTHZ_UNSUPPORTED` nombrando
|
|
474
|
+
* el método, nunca una migración a medias en silencio. El driver
|
|
475
|
+
* `database` NO lo implementa: sus tablas SON el origen, y llenarlas desde
|
|
476
|
+
* un store es la otra dirección (3b-3b).
|
|
477
|
+
*/
|
|
478
|
+
reconcile?(source: ReconcileSource, options: ReconcileOptions): Promise<ReconcileReport>;
|
|
479
|
+
/**
|
|
480
|
+
* **Los hechos de ESTE driver, paginados, para que otro se reconstruya
|
|
481
|
+
* desde ellos** (3b-3b). Es la otra mitad de `reconcile`: `reconcile` es
|
|
482
|
+
* ser el DESTINO de `authz:reconcile`, `enumerateFacts` es ser el ORIGEN.
|
|
483
|
+
*
|
|
484
|
+
* Contrato: como mucho `limit` hechos por página (más ⇒ 500), orden total
|
|
485
|
+
* y estable, cursor opaco que tiene que AVANZAR (repetirlo ⇒ 500, jamás un
|
|
486
|
+
* bucle), y **nada se filtra**: una asignación caducada sale con su
|
|
487
|
+
* `expiresAt` para que el destino la cuente en `skipped` con su motivo. Lo
|
|
488
|
+
* que el origen no sabe expresar como hecho del puerto sale en `skipped`
|
|
489
|
+
* de la página, nunca descartado en silencio.
|
|
490
|
+
*
|
|
491
|
+
* Opcional: capacidad `enumerateFacts`. El driver `database` **no lo
|
|
492
|
+
* trae** a propósito — sus hechos son `authz_assignments`/`authz_denies`,
|
|
493
|
+
* el esquema publicado del paquete, y el destino los lee de ahí (es lo que
|
|
494
|
+
* hace `openfga.reconcile`). Un driver de terceros que quiera migrar
|
|
495
|
+
* DESDE otro sitio sí lo necesita.
|
|
496
|
+
*/
|
|
497
|
+
enumerateFacts?(page: {
|
|
498
|
+
limit: number;
|
|
499
|
+
after?: string;
|
|
500
|
+
}): Promise<ReconcileFactPage>;
|
|
306
501
|
/**
|
|
307
502
|
* Roles DIRECTOS vigentes del holder en cada scope de `chain` (2D · G5),
|
|
308
503
|
* como pares `{ scope, role }`; solo roles que EXISTEN en ese scope (D5 +
|
|
@@ -330,6 +525,224 @@ export interface AuthorizationDriver {
|
|
|
330
525
|
* `authorization.expandExcludedSubtrees(excluded)` (usa tu `descendantsOf`)
|
|
331
526
|
* o resta el subárbol en tu propia consulta (CTE recursiva, `path LIKE`…).
|
|
332
527
|
*/
|
|
528
|
+
/**
|
|
529
|
+
* Lo que el manager le presta al driver para reconciliar: el árbol del
|
|
530
|
+
* consumidor (entero y paginado) y su resolutor. El driver pone lo suyo —qué
|
|
531
|
+
* hechos guarda y cómo—; el paquete no le dice cómo migrar, le da la FUENTE.
|
|
532
|
+
*/
|
|
533
|
+
export interface ReconcileSource {
|
|
534
|
+
enumerateEdges: ScopeEdgesEnumerator;
|
|
535
|
+
resolveChain: ScopeChainResolver;
|
|
536
|
+
/**
|
|
537
|
+
* Los HECHOS del origen, paginados (3b-3b). Solo hace falta en la
|
|
538
|
+
* dirección en la que el origen NO es `authz_*`: `--to=database` los lee
|
|
539
|
+
* del store con este enumerador, mientras que `--to=openfga` lee las
|
|
540
|
+
* tablas del paquete directamente (son su propio esquema publicado, no el
|
|
541
|
+
* secreto de un driver).
|
|
542
|
+
*
|
|
543
|
+
* Es **perezoso a propósito**: el manager solo resuelve el driver de
|
|
544
|
+
* ORIGEN cuando el destino lo pide, así que una migración que no necesita
|
|
545
|
+
* hechos del puerto no construye nada. Sin origen que lo implemente, la
|
|
546
|
+
* primera llamada es 500 `E_AUTHZ_UNSUPPORTED` nombrando `enumerateFacts`.
|
|
547
|
+
*/
|
|
548
|
+
facts?: ReconcileFactsEnumerator;
|
|
549
|
+
/**
|
|
550
|
+
* **Quién es la FUENTE DE VERDAD de los hechos en esta pasada** (3b-5, los
|
|
551
|
+
* dos 🔴 del auditor final). Lo decide el MANAGER, que es el único que sabe
|
|
552
|
+
* qué driver está sirviendo (`config.default`) y qué declara cada uno
|
|
553
|
+
* (`capabilities.hierarchyFacts`), y el destino lo OBEDECE.
|
|
554
|
+
*
|
|
555
|
+
* Sin esto, `--to=openfga` leía siempre `authz_assignments`/`authz_denies`,
|
|
556
|
+
* y en un despliegue `hierarchy: 'facts'` esas tablas **no son** la fuente
|
|
557
|
+
* de verdad de los hechos —lo son las tuplas del store—: la pasada
|
|
558
|
+
* reescribía lo revocado después del cutover, `--prune` borraba los denies
|
|
559
|
+
* vivos y el barrido de visibilidad del invariante 18 no se aplicaba nunca
|
|
560
|
+
* (`forbidden` salía vacío porque `wanted.facts` salía vacío).
|
|
561
|
+
*
|
|
562
|
+
* - `authzTables: true` ⇒ los hechos son las tablas del paquete y el
|
|
563
|
+
* destino las lee él mismo (es la MIGRACIÓN `database` → `openfga`);
|
|
564
|
+
* - `authzTables: false` ⇒ los hechos llegan por el PUERTO (`facts`,
|
|
565
|
+
* `enumerateFacts`) del origen `name`, que puede ser **el propio
|
|
566
|
+
* destino** cuando el destino es el driver ACTIVO y sus hechos son
|
|
567
|
+
* suyos (la pasada de MANTENIMIENTO: rehace lo derivado —marcador,
|
|
568
|
+
* catálogo, árbol y visibilidad— y no inventa ni borra un solo hecho).
|
|
569
|
+
*
|
|
570
|
+
* Ausente = `{ name: 'authz_*', authzTables: true }`: el comportamiento de
|
|
571
|
+
* 3b-3a, que es el que vale cuando el origen es el esquema publicado.
|
|
572
|
+
*/
|
|
573
|
+
factsOrigin?: ReconcileFactsOrigin;
|
|
574
|
+
}
|
|
575
|
+
/** Ver `ReconcileSource.factsOrigin` (3b-5). */
|
|
576
|
+
export interface ReconcileFactsOrigin {
|
|
577
|
+
/** Cómo se NOMBRA el origen en el reporte (clave de `drivers`, o `authz_*`). */
|
|
578
|
+
name: string;
|
|
579
|
+
/** `true` ⇒ los hechos son `authz_assignments`/`authz_denies` y los lee el destino. */
|
|
580
|
+
authzTables: boolean;
|
|
581
|
+
}
|
|
582
|
+
/**
|
|
583
|
+
* Un hecho del ORIGEN en el vocabulario del PUERTO, no en el del backend
|
|
584
|
+
* (3b-3b). Es lo que un driver entrega cuando le toca ser el origen de una
|
|
585
|
+
* migración: el destino no sabe si detrás hay tuplas, filas o un fichero.
|
|
586
|
+
*
|
|
587
|
+
* La identidad del rol es el **uuid** (3D · M1), nunca el slug: dos owners
|
|
588
|
+
* definen `lead@unit` y el slug no identifica nada. La del permiso es el
|
|
589
|
+
* **slug**, que es lo que el catálogo local sabe traducir a uuid.
|
|
590
|
+
*/
|
|
591
|
+
export interface ReconcileFact {
|
|
592
|
+
kind: 'assignment' | 'deny';
|
|
593
|
+
holder: SubjectRef;
|
|
594
|
+
/** El scope tal como lo guarda el ORIGEN; el destino lo canoniza con SU árbol. */
|
|
595
|
+
scope: ScopeRef;
|
|
596
|
+
/** `assignment`: uuid del rol. */
|
|
597
|
+
roleUuid?: string;
|
|
598
|
+
/** `deny`: slug del permiso. */
|
|
599
|
+
permission?: string;
|
|
600
|
+
/**
|
|
601
|
+
* `assignment`: la caducidad tal como está guardada, **sin filtrar**. Una
|
|
602
|
+
* caducada tiene que LLEGAR para poder contarse en `skipped` con su motivo;
|
|
603
|
+
* un origen que la filtre por su cuenta la haría desaparecer en silencio,
|
|
604
|
+
* que es justo lo que la migración no puede hacer.
|
|
605
|
+
*/
|
|
606
|
+
expiresAt?: Date | null;
|
|
607
|
+
/** Cómo lo nombra el origen (para `details`): un motivo sin la fila no se arregla. */
|
|
608
|
+
detail: string;
|
|
609
|
+
}
|
|
610
|
+
/**
|
|
611
|
+
* Una página de hechos del origen. `cursor` es opaco y tiene que AVANZAR
|
|
612
|
+
* (repetirlo ⇒ 500, nunca un bucle); `skipped` es lo que el ORIGEN no supo
|
|
613
|
+
* expresar como hecho del puerto (basura de otra versión, un holder type que
|
|
614
|
+
* el config no declara…) y que el destino suma a su reporte.
|
|
615
|
+
*/
|
|
616
|
+
export interface ReconcileFactPage {
|
|
617
|
+
facts: ReconcileFact[];
|
|
618
|
+
skipped?: ReconcileSkip[];
|
|
619
|
+
cursor?: string;
|
|
620
|
+
}
|
|
621
|
+
export type ReconcileFactsEnumerator = (page: {
|
|
622
|
+
limit: number;
|
|
623
|
+
after?: string;
|
|
624
|
+
}) => Promise<ReconcileFactPage>;
|
|
625
|
+
export interface ReconcileOptions {
|
|
626
|
+
/** Mismo recorrido, CERO escrituras. Es el verificador (read-only por contrato). */
|
|
627
|
+
dryRun?: boolean;
|
|
628
|
+
/**
|
|
629
|
+
* Borra del destino los HECHOS que el origen no respalda: los de un scope
|
|
630
|
+
* que ya no resuelve (3b-0b · AA4, «resurrección») y los que sobran (un
|
|
631
|
+
* store escrito por una versión anterior). Sin él se REPORTAN y no se
|
|
632
|
+
* borran. Lo derivado —marcador de raíz, proyección del catálogo y árbol—
|
|
633
|
+
* se rehace siempre: es un espejo de datos locales que nadie más escribe.
|
|
634
|
+
*/
|
|
635
|
+
prune?: boolean;
|
|
636
|
+
/** La salida humana de `E_AUTHZ_MASS_RECONCILE_REFUSED`. */
|
|
637
|
+
allowMassDelete?: boolean;
|
|
638
|
+
/** Filas por lote en las lecturas del origen y por `Write` en el destino (default 100). */
|
|
639
|
+
batchSize?: number;
|
|
640
|
+
/**
|
|
641
|
+
* **La cota del volcado del destino** (3b-3b · B5). Reconciliar exige
|
|
642
|
+
* comparar contra el estado ENTERO del destino, y ese volcado entra en
|
|
643
|
+
* memoria: el ORIGEN se lee por lotes con cursor, el destino no. En vez de
|
|
644
|
+
* dejarlo como una sorpresa (un OOM en producción), se declara: pasar de
|
|
645
|
+
* `maxTuples` es 500 `E_AUTHZ_RECONCILE_TOO_LARGE` **antes de escribir
|
|
646
|
+
* nada**, nombrando la cota y cómo subirla. Default
|
|
647
|
+
* `DEFAULT_RECONCILE_MAX_TUPLES`.
|
|
648
|
+
*/
|
|
649
|
+
maxTuples?: number;
|
|
650
|
+
}
|
|
651
|
+
/**
|
|
652
|
+
* Cuántas tuplas/filas del destino caben en una pasada de `authz:reconcile`
|
|
653
|
+
* (3b-3b · B5). No es una garantía de memoria: es la cota DECLARADA por
|
|
654
|
+
* encima de la cual la pasada se niega en vez de intentarlo.
|
|
655
|
+
*/
|
|
656
|
+
export declare const DEFAULT_RECONCILE_MAX_TUPLES = 1000000;
|
|
657
|
+
/**
|
|
658
|
+
* Algo que la pasada NO migró (una fila del origen) o NO tocó (una tupla del
|
|
659
|
+
* destino), con su motivo. Nunca un contador a secas: un motivo sin la fila
|
|
660
|
+
* no se puede arreglar.
|
|
661
|
+
*/
|
|
662
|
+
export interface ReconcileSkip {
|
|
663
|
+
kind: 'assignment' | 'deny' | 'edge' | 'tuple';
|
|
664
|
+
reason: string;
|
|
665
|
+
detail: string;
|
|
666
|
+
}
|
|
667
|
+
/** Los cinco números de una fase (o del total). */
|
|
668
|
+
export interface ReconcileCounts {
|
|
669
|
+
/** Tuplas nuevas en el destino. */
|
|
670
|
+
written: number;
|
|
671
|
+
/** Tuplas que estaban con OTRA caducidad y se han rehecho (delete + write). */
|
|
672
|
+
updated: number;
|
|
673
|
+
/** Tuplas que ya estaban exactamente igual. */
|
|
674
|
+
unchanged: number;
|
|
675
|
+
/** Tuplas del destino que el origen NO respalda. */
|
|
676
|
+
extra: number;
|
|
677
|
+
/** De las anteriores, las que la pasada borra (las que sobran de lo derivado, y con `prune` también los hechos). */
|
|
678
|
+
deleted: number;
|
|
679
|
+
}
|
|
680
|
+
/**
|
|
681
|
+
* Lo que movió una pasada de `authz:reconcile`. Los contadores describen el
|
|
682
|
+
* PLAN: con `dryRun` son exactamente los mismos números y no se escribe nada
|
|
683
|
+
* (lo dice `dryRun: true`), que es lo que hace del verificador un simulacro
|
|
684
|
+
* fiel y no una segunda implementación.
|
|
685
|
+
*/
|
|
686
|
+
export interface ReconcileReport extends ReconcileCounts {
|
|
687
|
+
/** El driver de destino (`--to`). */
|
|
688
|
+
to: string;
|
|
689
|
+
/**
|
|
690
|
+
* **De dónde salieron los HECHOS de esta pasada** (3b-5): el nombre del
|
|
691
|
+
* driver ORIGEN, o `authz_*` si fueron las tablas del paquete. No es
|
|
692
|
+
* decoración: es la diferencia entre una migración y una pasada de
|
|
693
|
+
* mantenimiento contra el driver activo, y el comando la imprime — una
|
|
694
|
+
* pasada que lee los hechos del sitio equivocado no puede ser silenciosa.
|
|
695
|
+
*/
|
|
696
|
+
factsFrom?: string;
|
|
697
|
+
/**
|
|
698
|
+
* **La garantía del freeze, publicada en vez de supuesta** (3b-7, juez C4).
|
|
699
|
+
* Solo en la pasada que ESCRIBE (el `--dry-run` no congela). `lapsed: true`
|
|
700
|
+
* significa que el lease se perdió a mitad —una pausa más larga que el
|
|
701
|
+
* lease, la base caída, otro dueño— y hubo una ventana en la que otros
|
|
702
|
+
* procesos pudieron escribir: la pasada NO se certifica y el comando sale
|
|
703
|
+
* distinto de cero. `leaseMs: null` = ventana sin renovación (el freeze de
|
|
704
|
+
* OPERADOR dentro del que corrió la pasada, o un lease infinito). Lo pone
|
|
705
|
+
* el MANAGER: el driver no sabe de ventanas.
|
|
706
|
+
*/
|
|
707
|
+
frozen?: {
|
|
708
|
+
durable: boolean;
|
|
709
|
+
lapsed: boolean;
|
|
710
|
+
leaseMs: number | null;
|
|
711
|
+
fence: number;
|
|
712
|
+
};
|
|
713
|
+
dryRun: boolean;
|
|
714
|
+
prune: boolean;
|
|
715
|
+
/** Los mismos números por fase: qué es catálogo, qué es árbol y qué son hechos. */
|
|
716
|
+
phases: Record<'root' | 'catalog' | 'tree' | 'facts', ReconcileCounts>;
|
|
717
|
+
/**
|
|
718
|
+
* Motivo → cuántas cosas se quedaron fuera: filas del origen que no se
|
|
719
|
+
* migraron y tuplas del destino que esta pasada no tocó (`extra-fact`, las
|
|
720
|
+
* que solo se van con `--prune`).
|
|
721
|
+
*/
|
|
722
|
+
skipped: Record<string, number>;
|
|
723
|
+
/** Y cuáles (acotado por `maxSkipDetails`): un contador no permite arreglar nada. */
|
|
724
|
+
details: ReconcileSkip[];
|
|
725
|
+
/** Ciclos del árbol del ORIGEN: sus aristas NO se escriben (FGA los evalúa y son fail-open). */
|
|
726
|
+
cycles: string[][];
|
|
727
|
+
drift: {
|
|
728
|
+
/** Faltaba el marcador de raíz: sin él el store entero DENIEGA (3b-2i). */
|
|
729
|
+
rootMarker: boolean;
|
|
730
|
+
/** Scopes con más de un padre en el destino (3b-2h · 🟠 4): cruce de tenants. */
|
|
731
|
+
multiParent: string[];
|
|
732
|
+
/**
|
|
733
|
+
* Aristas `scope#binding` que el destino tenía mal (invariante 18): la
|
|
734
|
+
* escritura de visibilidad que `scopes.moved`/`projectCatalogRole`
|
|
735
|
+
* pudieron perder si el relay no pasó.
|
|
736
|
+
*/
|
|
737
|
+
roleVisibility: number;
|
|
738
|
+
/** Cambios del árbol encolados y sin relevar: la VENTANA del relay, medida. */
|
|
739
|
+
pendingRelay: number;
|
|
740
|
+
/** Entradas APARCADAS de la outbox: divergencia permanente, no una ventana. */
|
|
741
|
+
deadRelay: number;
|
|
742
|
+
};
|
|
743
|
+
/** La pasada tiene la firma de un origen ciego (ver `E_AUTHZ_MASS_RECONCILE_REFUSED`). */
|
|
744
|
+
massDelete: boolean;
|
|
745
|
+
}
|
|
333
746
|
export interface ExcludedSubtree {
|
|
334
747
|
scope: ScopeRef;
|
|
335
748
|
/** Siempre `true`: recuerda que lo excluido es el subárbol entero. */
|
|
@@ -395,35 +808,253 @@ export type AuthorizationDriverFactory = () => AuthorizationDriver | Promise<Aut
|
|
|
395
808
|
*/
|
|
396
809
|
export type ScopeChainResolver = (scope: ScopeRef) => Promise<ScopeRef[] | null>;
|
|
397
810
|
/**
|
|
398
|
-
*
|
|
399
|
-
*
|
|
400
|
-
* sin orden exigido. Lo implementa el consumidor (o `sqlDescendantsOf`, el
|
|
401
|
-
* helper opt-in del paquete): el paquete NO lo suple con N+1 llamadas a
|
|
402
|
-
* `resolveChain`. `null` = scope desconocido. Más de `maxNodes` nodos ⇒
|
|
403
|
-
* el consumidor lanza; si devuelve de más, lanza el manager (422
|
|
404
|
-
* `E_AUTHZ_TOO_MANY_SCOPES`). Nunca se llama desde `authorize`/`hasRole`/
|
|
405
|
-
* `list*` (test de arquitectura): solo desde `authorizedScopes`.
|
|
811
|
+
* Una arista del árbol del consumidor: «`child` cuelga de `parent`» (3b-3a).
|
|
812
|
+
* `parent` puede ser `APP_SCOPE`; `child` nunca es la raíz.
|
|
406
813
|
*/
|
|
814
|
+
export interface ScopeEdge {
|
|
815
|
+
child: ScopeRef;
|
|
816
|
+
parent: ScopeRef;
|
|
817
|
+
}
|
|
818
|
+
/** Una página de `scopes.enumerateEdges`. Sin `cursor` = no queda nada más. */
|
|
819
|
+
export interface ScopeEdgePage {
|
|
820
|
+
edges: ScopeEdge[];
|
|
821
|
+
/**
|
|
822
|
+
* Continuación OPACA para la siguiente llamada (`after`). Ausente o
|
|
823
|
+
* `undefined` significa «se acabó»: devolver siempre un cursor es un bucle
|
|
824
|
+
* infinito, y el llamante lo denuncia (500) si el cursor no avanza.
|
|
825
|
+
*/
|
|
826
|
+
cursor?: string;
|
|
827
|
+
}
|
|
407
828
|
/**
|
|
408
|
-
* El árbol
|
|
409
|
-
* `
|
|
410
|
-
*
|
|
829
|
+
* **El árbol ENTERO, paginado** (3b-3a). Es la otra mitad de
|
|
830
|
+
* `resolveChain`: aquel responde «¿de qué cuelga ESTE scope?» y este
|
|
831
|
+
* «¿cuáles son todas las aristas?», que es lo que hace falta para
|
|
832
|
+
* reconstruir el árbol de un backend que lo guarda como hechos propios
|
|
833
|
+
* (`authz:reconcile --to=openfga`) y para ver las que sobran (las que el
|
|
834
|
+
* consumidor ya no respalda).
|
|
411
835
|
*
|
|
412
|
-
* Contrato
|
|
413
|
-
*
|
|
414
|
-
*
|
|
415
|
-
*
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
*
|
|
419
|
-
*
|
|
420
|
-
*
|
|
421
|
-
*
|
|
836
|
+
* Contrato:
|
|
837
|
+
* - devuelve **como mucho `limit`** aristas por página (más ⇒ 500: el
|
|
838
|
+
* llamante no puede paginar lo que no cabe en su lote);
|
|
839
|
+
* - el orden tiene que ser TOTAL y ESTABLE entre llamadas (la clave
|
|
840
|
+
* primaria vale): si no, una pasada reanudada se salta nodos;
|
|
841
|
+
* - `cursor` es opaco para el paquete y vuelve tal cual en `after`; que no
|
|
842
|
+
* avance es 500, nunca un bucle;
|
|
843
|
+
* - una arista cuyo padre no existe en la tabla NO se emite (es un nodo que
|
|
844
|
+
* `resolveChain` tampoco resuelve): el destino la ve como sobrante y
|
|
845
|
+
* `authz:reconcile` la cuenta y la reporta.
|
|
846
|
+
*
|
|
847
|
+
* Sin él, `authz:reconcile --to=openfga` no puede migrar el árbol y lo dice
|
|
848
|
+
* (500 `E_AUTHZ_CONFIG`): NO se inventa un árbol plano.
|
|
849
|
+
* `sqlScopeEdges(...)` lo implementa sobre una tabla con columna padre.
|
|
850
|
+
*/
|
|
851
|
+
export type ScopeEdgesEnumerator = (options: {
|
|
852
|
+
limit: number;
|
|
853
|
+
after?: string;
|
|
854
|
+
}) => Promise<ScopeEdgePage>;
|
|
855
|
+
/**
|
|
856
|
+
* Un cambio del ÁRBOL, tal como lo encola la outbox (3b-2d). Es exactamente
|
|
857
|
+
* lo que el consumidor notifica por `manager.scopes.*`, con la identidad ya
|
|
858
|
+
* CANÓNICA (invariante 17): se resuelve al encolar, mientras la fila del
|
|
859
|
+
* consumidor todavía existe, no al relevarla.
|
|
860
|
+
*/
|
|
861
|
+
export type ScopeTreeChange = {
|
|
862
|
+
op: 'attached';
|
|
863
|
+
child: ScopeRef;
|
|
864
|
+
parent: ScopeRef;
|
|
865
|
+
} | {
|
|
866
|
+
op: 'moved';
|
|
867
|
+
child: ScopeRef;
|
|
868
|
+
parent: ScopeRef;
|
|
869
|
+
} | {
|
|
870
|
+
op: 'detached';
|
|
871
|
+
child: ScopeRef;
|
|
872
|
+
};
|
|
873
|
+
/** Un cambio pendiente en la outbox, con la identidad de su registro. */
|
|
874
|
+
export interface PendingScopeTreeChange {
|
|
875
|
+
/** Identificador estable del registro; el relay lo devuelve al marcarlo. */
|
|
876
|
+
id: string | number;
|
|
877
|
+
change: ScopeTreeChange;
|
|
878
|
+
/** Intentos fallidos previos, si la outbox los lleva (el reporte los muestra). */
|
|
879
|
+
attempts?: number;
|
|
880
|
+
/** La última causa de fallo, si la outbox la guarda (`dead()` la enseña). */
|
|
881
|
+
lastError?: string;
|
|
882
|
+
/**
|
|
883
|
+
* Quién ordenó el cambio, si el call-site lo declaró y la outbox lo
|
|
884
|
+
* guarda. El relay lo pone en el `AuthzWriteEvent` del `scope_purged` que
|
|
885
|
+
* dispara un `detached`: la auditoría no debe perder al autor por pasar
|
|
886
|
+
* por una cola.
|
|
887
|
+
*/
|
|
888
|
+
actor?: SubjectRef;
|
|
889
|
+
}
|
|
890
|
+
/** Lo que el relay aplicó (o aplicaría), pieza a pieza. */
|
|
891
|
+
export interface RelayedScopeChange {
|
|
892
|
+
id: string | number;
|
|
893
|
+
change: ScopeTreeChange;
|
|
894
|
+
attempts?: number;
|
|
895
|
+
/** La causa, en lo que FALLÓ, se APARCÓ o se APLAZÓ (nunca en lo aplicado). */
|
|
896
|
+
error?: string;
|
|
897
|
+
}
|
|
898
|
+
/**
|
|
899
|
+
* Reporte de `authz:scopes:relay` (3b-2d; 3b-2h · 🔴 2). Dice QUÉ se aplicó,
|
|
900
|
+
* no un contador: la pasada no es atómica y un número no permite retomar nada.
|
|
901
|
+
*/
|
|
902
|
+
export interface ScopeRelayReport {
|
|
903
|
+
/** Aplicados en esta pasada, en orden. Vacío en `dryRun`. */
|
|
904
|
+
applied: RelayedScopeChange[];
|
|
905
|
+
/**
|
|
906
|
+
* El PRIMER cambio que falló, con la causa (`failures[0]`). Se conserva
|
|
907
|
+
* porque es lo que mira un supervisor; la lista completa está en
|
|
908
|
+
* `failures`.
|
|
909
|
+
*/
|
|
910
|
+
failed: {
|
|
911
|
+
id: string | number;
|
|
912
|
+
change: ScopeTreeChange;
|
|
913
|
+
error: string;
|
|
914
|
+
} | null;
|
|
915
|
+
/**
|
|
916
|
+
* TODO lo que falló en esta pasada (3b-2h · 🔴 2). Un fallo ya no para la
|
|
917
|
+
* pasada entera: para lo que DEPENDE de él —los cambios que nombran alguno
|
|
918
|
+
* de sus scopes, que salen en `deferred`— y el resto sigue.
|
|
919
|
+
*/
|
|
920
|
+
failures: Array<{
|
|
921
|
+
id: string | number;
|
|
922
|
+
change: ScopeTreeChange;
|
|
923
|
+
error: string;
|
|
924
|
+
}>;
|
|
925
|
+
/**
|
|
926
|
+
* Lo que NO se intentó porque toca un scope contaminado por un fallo o por
|
|
927
|
+
* otro aplazado de esta misma pasada. Es lo que mantiene el ORDEN del árbol
|
|
928
|
+
* (aplicar un `moved` antes que el `attached` de su padre da un árbol que
|
|
929
|
+
* nunca existió) sin dejar que una fila envenenada bloquee a los demás.
|
|
930
|
+
*/
|
|
931
|
+
deferred: RelayedScopeChange[];
|
|
932
|
+
/**
|
|
933
|
+
* Entradas APARCADAS por la outbox tras agotar sus intentos (`dead()`), si
|
|
934
|
+
* la implementación lo soporta. No se van a aplicar solas: el árbol del
|
|
935
|
+
* backend está permanentemente divergente en esos nodos y hay que mirarlas.
|
|
936
|
+
*/
|
|
937
|
+
dead: RelayedScopeChange[];
|
|
938
|
+
/**
|
|
939
|
+
* Otra pasada tenía el lease de la cola y esta no ha hecho NADA (3b-2h ·
|
|
940
|
+
* 🟠 4). No es un error: el relay es escritor ÚNICO.
|
|
941
|
+
*/
|
|
942
|
+
busy: boolean;
|
|
943
|
+
/** Quedan cambios sin aplicar tras la pasada (vuelve a ejecutar). */
|
|
944
|
+
remaining: boolean;
|
|
945
|
+
dryRun: boolean;
|
|
946
|
+
/** Solo con `dryRun`: lo que se aplicaría, en orden. */
|
|
947
|
+
wouldApply: RelayedScopeChange[];
|
|
948
|
+
}
|
|
949
|
+
/**
|
|
950
|
+
* El lease de una pasada del relay (3b-2h · 🟠 4). Lo devuelve
|
|
951
|
+
* `ScopeOutbox.acquire()` y lo suelta el manager en un `finally`.
|
|
952
|
+
*/
|
|
953
|
+
export interface ScopeOutboxLease {
|
|
954
|
+
release(): Promise<void>;
|
|
955
|
+
}
|
|
956
|
+
/** Contexto del encolado: la transacción del consumidor y quién lo ordena. */
|
|
957
|
+
export interface ScopeOutboxContext {
|
|
958
|
+
/**
|
|
959
|
+
* Lo que el llamante pasó en `ScopeTreeWriteOptions.transaction`: para
|
|
960
|
+
* Lucid, el `TransactionClientContract` de la transacción en curso. El
|
|
961
|
+
* paquete no lo interpreta —no conoce la BD del consumidor—: lo pasea.
|
|
962
|
+
*/
|
|
963
|
+
transaction?: unknown;
|
|
964
|
+
actor?: SubjectRef;
|
|
965
|
+
}
|
|
966
|
+
/**
|
|
967
|
+
* **El puerto de la outbox del árbol** (3b-2d, panel 2 cruce 4 · S5).
|
|
968
|
+
*
|
|
969
|
+
* Sin él, `manager.scopes.attached/moved/detached` escribe en el backend
|
|
970
|
+
* DENTRO de la transacción del consumidor y un `rollback` posterior deja el
|
|
971
|
+
* árbol de FGA diciendo una cosa y la BD del consumidor otra —una escalada
|
|
972
|
+
* persistente e invisible, porque la aplicación lista y audita contra SQL—.
|
|
973
|
+
* Con él, el manager no toca el driver: ENCOLA el cambio con la transacción
|
|
974
|
+
* del consumidor, así que el cambio del árbol y su intención de propagación
|
|
975
|
+
* confirman o se van juntos. Lo aplica después `authz:scopes:relay`.
|
|
976
|
+
*
|
|
977
|
+
* El paquete no impone tabla: define este puerto y publica un stub de
|
|
978
|
+
* migración (`stubs/scopes_outbox_migration.stub`) y una implementación
|
|
979
|
+
* sobre Lucid (`sqlScopeOutbox`) para quien no quiera escribir la suya.
|
|
980
|
+
*
|
|
981
|
+
* Lo que NO arregla, y hay que leerlo así: durante el lag del relay
|
|
982
|
+
* (segundos) FGA decide con el árbol VIEJO. Es un fail-open temporal — el
|
|
983
|
+
* tenant antiguo conserva acceso tras un `moved`, y los denies heredados no
|
|
984
|
+
* aplican tras un `attached`—. No hay 2PC; es el precio de tener el árbol en
|
|
985
|
+
* dos sitios.
|
|
986
|
+
*/
|
|
987
|
+
export interface ScopeOutbox {
|
|
988
|
+
/**
|
|
989
|
+
* Encola el cambio en la transacción del consumidor. Debe escribir y
|
|
990
|
+
* volver: nada de aplicarlo aquí. Si lanza, la escritura del manager falla
|
|
991
|
+
* (y la transacción del consumidor se lleva las dos cosas).
|
|
992
|
+
*/
|
|
993
|
+
enqueue(change: ScopeTreeChange, context: ScopeOutboxContext): Promise<void>;
|
|
994
|
+
/**
|
|
995
|
+
* Los pendientes MÁS ANTIGUOS primero: el orden del árbol es el del
|
|
996
|
+
* encolado. `after` (3b-2h · 🔴 2) es el id del último registro que el
|
|
997
|
+
* relay ya vio en ESTA pasada: como una entrada que falla ya no para la
|
|
998
|
+
* pasada, se queda pendiente y volvería a salir la primera para siempre.
|
|
999
|
+
* Una implementación que lo ignore sigue siendo válida —el relay detecta
|
|
1000
|
+
* que no avanza y termina la pasada—, pero solo drenará hasta el primer
|
|
1001
|
+
* lote atascado.
|
|
1002
|
+
*/
|
|
1003
|
+
pending(limit: number, after?: string | number): Promise<PendingScopeTreeChange[]>;
|
|
1004
|
+
/** Aplicado en el backend: no se vuelve a relevar. */
|
|
1005
|
+
markApplied(id: string | number): Promise<void>;
|
|
1006
|
+
/** Falló al aplicarse: se queda pendiente, con la causa a la vista. */
|
|
1007
|
+
markFailed(id: string | number, error: string): Promise<void>;
|
|
1008
|
+
/**
|
|
1009
|
+
* **Las entradas APARCADAS** (3b-2h · 🔴 2), opcional. Una entrada que ya
|
|
1010
|
+
* no se puede aplicar —su scope padre se borró antes de la pasada— no se
|
|
1011
|
+
* arregla sola: la outbox puede dejar de ofrecerla en `pending()` tras N
|
|
1012
|
+
* intentos y enseñarla aquí. El relay las REPORTA en cada pasada y el
|
|
1013
|
+
* comando sale ≠ 0 mientras haya alguna: un aparcado es una divergencia
|
|
1014
|
+
* permanente del árbol del backend, no un incidente resuelto.
|
|
1015
|
+
*/
|
|
1016
|
+
dead?(limit: number): Promise<PendingScopeTreeChange[]>;
|
|
1017
|
+
/**
|
|
1018
|
+
* **El lease del escritor ÚNICO** (3b-2h · 🟠 4), opcional. `pending()` no
|
|
1019
|
+
* reserva nada, así que dos pasadas a la vez (un `CronJob` con
|
|
1020
|
+
* `concurrencyPolicy: Allow`, dos réplicas, una pasada más larga que su
|
|
1021
|
+
* intervalo) trabajan sobre el MISMO lote: la rezagada re-aplica un
|
|
1022
|
+
* `attached` viejo después de que la otra aplicara el `moved` nuevo y deja
|
|
1023
|
+
* el árbol del store REVERTIDO —con un solo padre, así que nada lo
|
|
1024
|
+
* delata— (medido). Con `acquire`, la segunda pasada no hace nada y lo
|
|
1025
|
+
* dice (`busy`). `null` = otra pasada lo tiene.
|
|
1026
|
+
*
|
|
1027
|
+
* CONTRATO: el lease se toma UNA vez al inicio de la pasada y se sostiene
|
|
1028
|
+
* hasta el `finally`; el relay NO lo re-verifica ni lo renueva dentro del
|
|
1029
|
+
* bucle (a diferencia del freeze durable, que sí se re-afirma por lote).
|
|
1030
|
+
* Por eso la implementación DEBE ser un cerrojo SOSTENIDO mientras dura la
|
|
1031
|
+
* pasada, no un TTL que pueda vencer a mitad: los que trae el paquete lo
|
|
1032
|
+
* cumplen (`pg_try_advisory_xact_lock` vive con la transacción; `get_lock`
|
|
1033
|
+
* de MySQL con la sesión; SQLite en proceso). Un `acquire` con TTL
|
|
1034
|
+
* reabriría la ventana del doble escritor que este lease cierra.
|
|
1035
|
+
*/
|
|
1036
|
+
acquire?(): Promise<ScopeOutboxLease | null>;
|
|
1037
|
+
}
|
|
1038
|
+
/**
|
|
1039
|
+
* El árbol del consumidor hacia ABAJO (2.1, B2): todos los descendientes de
|
|
1040
|
+
* `scope` (cualquier tipo, cualquier profundidad), en cualquier orden y sin
|
|
1041
|
+
* incluirlo. Lo implementa el consumidor (o `sqlDescendantsOf`, el helper
|
|
1042
|
+
* opt-in del paquete): el paquete NO lo suple con N+1 llamadas a
|
|
1043
|
+
* `resolveChain`. `null` = «este árbol no conoce ese scope».
|
|
422
1044
|
*
|
|
423
1045
|
* Más de `maxNodes` nodos ⇒ el resolutor puede devolver la lista larga (el
|
|
424
1046
|
* paquete la caza con 422 `E_AUTHZ_TOO_MANY_SCOPES`) o lanzar; en
|
|
425
|
-
* `authorizedScopes` eso es un 422 y en `
|
|
426
|
-
* DEGRADA (3F · S2, y ver el aviso de
|
|
1047
|
+
* `authorizedScopes` eso es un 422 y en `defineScopedRole`/`updateScopedRole`
|
|
1048
|
+
* DEGRADA a la regla de nivel mínima (3F · S2, y ver el aviso de
|
|
1049
|
+
* `#assertLevelUnderOwner`).
|
|
1050
|
+
*
|
|
1051
|
+
* Solo se llama desde `authorizedScopes`/`expandExcludedSubtrees` y desde la
|
|
1052
|
+
* regla de nivel de la delegación; NUNCA desde `authorize`/`hasRole`/`list*`
|
|
1053
|
+
* (test de arquitectura) ni desde `scopes.detached`, que purga hechos del
|
|
1054
|
+
* scope EXACTO y no baja por el árbol (invariante 11; 3b-0 · Z1).
|
|
1055
|
+
*
|
|
1056
|
+
* (D7: hasta 3G había DOS docblocks seguidos aquí y el viejo contradecía al
|
|
1057
|
+
* nuevo sobre qué se espera al pasarse de `maxNodes`. Queda uno.)
|
|
427
1058
|
*/
|
|
428
1059
|
export type ScopeDescendantsResolver = (scope: ScopeRef, options: {
|
|
429
1060
|
maxNodes: number;
|
|
@@ -481,61 +1112,6 @@ export interface AuthzWriteEvent {
|
|
|
481
1112
|
* timeout (conexión rechazada) no lo lleva: esa escritura no ocurrió.
|
|
482
1113
|
*/
|
|
483
1114
|
indeterminate?: boolean;
|
|
484
|
-
/**
|
|
485
|
-
* Solo en `scope_purged`: el árbol ya NO conoce el scope notificado —el
|
|
486
|
-
* consumidor borró su fila y avisa después, que es el orden que el paquete
|
|
487
|
-
* admite— o alguno de los roles purgados tenía un owner que tampoco
|
|
488
|
-
* resuelve (3F · S1; 3G · W1/W2). `'owner-detached-unknown'` significa dos
|
|
489
|
-
* cosas a la vez, y las dos importan a quien audita: (a) la purga procede
|
|
490
|
-
* igual —bloquearla dejaba vivos el rol, sus asignaciones y los denies de
|
|
491
|
-
* un scope borrado (auditor N2), sin ninguna salida con `requireActor:
|
|
492
|
-
* true`— y (b) para ESOS roles —los que no tienen dónde medir el rango— la
|
|
493
|
-
* policy de 3E · P3 no se pudo evaluar. Para los demás sí se evalúa: el
|
|
494
|
-
* rango se mide en la cadena del OWNER de cada rol (3G · W1), así que un
|
|
495
|
-
* `detached` de un ancestro desconocido ya NO destruye los roles de
|
|
496
|
-
* descendientes vivos. Sale también con `purgedRoles: 0`.
|
|
497
|
-
*/
|
|
498
|
-
reason?: 'owner-detached-unknown';
|
|
499
|
-
/**
|
|
500
|
-
* Solo en `scope_purged`: la purga de roles se acotó al scope EXACTO
|
|
501
|
-
* porque el subárbol no se pudo enumerar (3F · S2). Ver
|
|
502
|
-
* `ScopeDetachOutcome.truncated`.
|
|
503
|
-
*/
|
|
504
|
-
truncated?: true;
|
|
505
|
-
}
|
|
506
|
-
/**
|
|
507
|
-
* Lo que devuelve `scopes.detached` (3F · S1/S2). Hasta 3E era `void` y no
|
|
508
|
-
* había forma de saber si la purga alcanzó a todo el subárbol ni si la
|
|
509
|
-
* policy de rango se llegó a evaluar.
|
|
510
|
-
*/
|
|
511
|
-
export interface ScopeDetachOutcome {
|
|
512
|
-
/** Roles LOCALES purgados (los del scope y, con `descendantsOf`, los del subárbol). */
|
|
513
|
-
purgedRoles: number;
|
|
514
|
-
/**
|
|
515
|
-
* `true` cuando el subárbol NO se pudo enumerar (más de `maxDescendants`,
|
|
516
|
-
* o un `descendantsOf` que falló) y la purga se acotó al scope EXACTO
|
|
517
|
-
* (3F · S2). Degradar en vez de tumbar la operación es la regla: declarar
|
|
518
|
-
* `scopes.descendantsOf` nunca puede dejarte peor que no declararlo, y
|
|
519
|
-
* hasta 3E un subárbol grande dejaba el `detached` en 503 sin purgar ni
|
|
520
|
-
* los roles ni los hechos (auditor N3). Los roles que quedan abajo no son
|
|
521
|
-
* visibles en ninguna parte —su owner ya no cuelga del árbol—, pero siguen
|
|
522
|
-
* ocupando su `(slug, nivel)`: hay que volver a notificar nodo a nodo o
|
|
523
|
-
* subir la cota.
|
|
524
|
-
*
|
|
525
|
-
* También es `true` cuando el árbol ya NO conoce el scope y `descendantsOf`
|
|
526
|
-
* no devolvió nada debajo (3G · W2, auditor P2): el puerto no le exige
|
|
527
|
-
* responder por un scope que `resolveChain` desconoce —puede devolver sus
|
|
528
|
-
* hijos o `null`, ver `ScopeDescendantsResolver`—, así que un vacío ahí no
|
|
529
|
-
* demuestra que debajo no quedara nada. Decir `truncated: false` era
|
|
530
|
-
* afirmar «purga completa» con el rol de la unit hija vivo y concediendo.
|
|
531
|
-
*/
|
|
532
|
-
truncated: boolean;
|
|
533
|
-
/**
|
|
534
|
-
* Igual que en `AuthzWriteEvent`: el scope notificado (o el owner de algún
|
|
535
|
-
* rol purgado) ya no está en el árbol, así que para esos roles la policy
|
|
536
|
-
* de rango no se pudo evaluar. Presente aunque `purgedRoles` sea 0.
|
|
537
|
-
*/
|
|
538
|
-
reason?: 'owner-detached-unknown';
|
|
539
1115
|
}
|
|
540
1116
|
/** Un rol del catálogo tal como lo ve el motor (3A · A2/A3, 3B · B2). */
|
|
541
1117
|
export interface CatalogRole {
|
|
@@ -628,10 +1204,9 @@ export interface ScopedRoleChanges {
|
|
|
628
1204
|
export interface AuthzCatalogWriteEvent {
|
|
629
1205
|
action: 'role_defined' | 'role_updated' | 'role_purged';
|
|
630
1206
|
/**
|
|
631
|
-
* Quién lo ordenó. La API de delegación lo exige siempre; ausente
|
|
632
|
-
*
|
|
633
|
-
*
|
|
634
|
-
* no venir.
|
|
1207
|
+
* Quién lo ordenó. La API de delegación lo exige siempre; ausente en los
|
|
1208
|
+
* `role_purged` de `authz:catalog:prune-orphans` (3b-0 · Z2), que es una
|
|
1209
|
+
* operación de PLATAFORMA y no de un actor del árbol.
|
|
635
1210
|
*/
|
|
636
1211
|
actor?: SubjectRef;
|
|
637
1212
|
role: CatalogRole;
|
|
@@ -652,4 +1227,212 @@ export interface AuthzCatalogWriteEvent {
|
|
|
652
1227
|
*/
|
|
653
1228
|
shadowedByAncestor?: CatalogRoleRef[];
|
|
654
1229
|
}
|
|
1230
|
+
/**
|
|
1231
|
+
* Un rol del catálogo tal como lo ve la PROYECCIÓN: su uuid (la identidad, 3A
|
|
1232
|
+
* · A1) y los slugs de los permisos que vincula.
|
|
1233
|
+
*/
|
|
1234
|
+
export interface CatalogProjectionRole {
|
|
1235
|
+
uuid: string;
|
|
1236
|
+
permissions: string[];
|
|
1237
|
+
}
|
|
1238
|
+
/**
|
|
1239
|
+
* Foto del catálogo confirmado que un driver puede materializar en su
|
|
1240
|
+
* backend. Se lee de `authz_*` dentro de la transacción del sync: es
|
|
1241
|
+
* DERIVADA, y por eso se puede reconstruir entera (`authz:reconcile`).
|
|
1242
|
+
*/
|
|
1243
|
+
export interface CatalogProjectionSnapshot {
|
|
1244
|
+
/** Todos los slugs de permiso del catálogo (no solo los del spec que se sincroniza). */
|
|
1245
|
+
permissions: string[];
|
|
1246
|
+
/** Todos los roles con sus vínculos rol→permiso. */
|
|
1247
|
+
roles: CatalogProjectionRole[];
|
|
1248
|
+
}
|
|
1249
|
+
/** Lo que una pasada de proyección movió. Nunca un booleano: una proyección silenciosa no se vigila. */
|
|
1250
|
+
export interface CatalogProjectionReport {
|
|
1251
|
+
/** Tuplas nuevas escritas. */
|
|
1252
|
+
written: number;
|
|
1253
|
+
/** Tuplas que sobraban (el catálogo ya no las respalda) y se han borrado. */
|
|
1254
|
+
deleted: number;
|
|
1255
|
+
/** Tuplas que ya estaban exactamente igual. */
|
|
1256
|
+
unchanged: number;
|
|
1257
|
+
}
|
|
1258
|
+
/**
|
|
1259
|
+
* **Proyección derivada del catálogo en el backend de un driver** (regla del
|
|
1260
|
+
* catálogo reescrita — panel 2, cruce 7; decisión del dueño 2026-08-28).
|
|
1261
|
+
*
|
|
1262
|
+
* El catálogo es propiedad LOCAL siempre: roles y permisos viven en `authz_*`
|
|
1263
|
+
* y ningún driver es su fuente de verdad. Un driver PUEDE mantener una
|
|
1264
|
+
* proyección (el modo `facts` de openfga: permisos como relaciones del modelo
|
|
1265
|
+
* + vínculos rol→permiso como tuplas `role:<uuid>#permits_<P>@<holder>:*`) si
|
|
1266
|
+
* y solo si: (a) es reconstruible desde `authz_*`, (b) `authz:reconcile` la
|
|
1267
|
+
* vigila y (c) NUNCA se lee como catálogo.
|
|
1268
|
+
*
|
|
1269
|
+
* Se inyecta en `syncAuthzCatalog` en vez de importarse: `src/catalog.ts` es
|
|
1270
|
+
* la ruta de un consumidor solo-database y no puede tirar del SDK de OpenFGA
|
|
1271
|
+
* (regla 3 de `check_purity.mjs`).
|
|
1272
|
+
*/
|
|
1273
|
+
export interface CatalogProjection {
|
|
1274
|
+
/**
|
|
1275
|
+
* ¿El catálogo que va a quedar es publicable en este backend? Se llama
|
|
1276
|
+
* ANTES de escribir nada (cotas de nombre y techo del modelo, A3/A4): un
|
|
1277
|
+
* catálogo que no se puede proyectar no se escribe a medias.
|
|
1278
|
+
*/
|
|
1279
|
+
assertPublishable(permissions: readonly string[]): void;
|
|
1280
|
+
/** Rehace la proyección del catálogo ya confirmado: escribe lo que falta y BORRA lo que sobra. */
|
|
1281
|
+
project(snapshot: CatalogProjectionSnapshot): Promise<CatalogProjectionReport>;
|
|
1282
|
+
}
|
|
1283
|
+
/** Un objeto de relaciones: `document:<id>`, `folder:<id>`, `group:<id>`… */
|
|
1284
|
+
export interface RelObject {
|
|
1285
|
+
/** El tipo FGA del objeto (`document`, `folder`, `space`…), declarado en `defineRelationsConfig`. */
|
|
1286
|
+
type: string;
|
|
1287
|
+
/** El id del objeto dentro de su partición. Sin `|`/`#`/`:` (los pone el driver al componer). */
|
|
1288
|
+
id: string;
|
|
1289
|
+
}
|
|
1290
|
+
/**
|
|
1291
|
+
* Un userset como sujeto: `group:eng#member` (todos los miembros del grupo).
|
|
1292
|
+
* Es lo que hace que un `relate(group:g#member, viewer, doc)` conceda `viewer`
|
|
1293
|
+
* a todo el que sea `member` de `g` (`usersetsOf`, un nivel).
|
|
1294
|
+
*/
|
|
1295
|
+
export interface RelUserset {
|
|
1296
|
+
object: RelObject;
|
|
1297
|
+
relation: string;
|
|
1298
|
+
}
|
|
1299
|
+
/**
|
|
1300
|
+
* El sujeto de una relación: un HOLDER (`{type,uuid}`, como `SubjectRef`) o un
|
|
1301
|
+
* USERSET (`{object, relation}`). El puerto lo tipa explícito porque los dos
|
|
1302
|
+
* viajan por `relate`/`listSubjects`/`check`; un userset de OTRA partición se
|
|
1303
|
+
* corta por comparación de string en el driver (nunca cruza).
|
|
1304
|
+
*/
|
|
1305
|
+
export type RelSubject = SubjectRef | RelUserset;
|
|
1306
|
+
/** Discriminador: ¿este sujeto es un userset (`group:g#member`) y no un holder? */
|
|
1307
|
+
export declare function isRelUserset(subject: RelSubject): subject is RelUserset;
|
|
1308
|
+
/**
|
|
1309
|
+
* La referencia COMPLETA a una tupla de relación, tal como la ve `assertWrite`
|
|
1310
|
+
* (R-13) y `onRelationWrite`: sujeto + relación + objeto + partición, más la
|
|
1311
|
+
* operación. Es puro dato: quien lo recibe decide (auditar, rechazar), nunca
|
|
1312
|
+
* muta el store.
|
|
1313
|
+
*/
|
|
1314
|
+
export interface RelationRef {
|
|
1315
|
+
operation: 'relate' | 'unrelate';
|
|
1316
|
+
subject: RelSubject;
|
|
1317
|
+
relation: string;
|
|
1318
|
+
object: RelObject;
|
|
1319
|
+
partition: ScopeRef;
|
|
1320
|
+
}
|
|
1321
|
+
/** El evento de escritura de relaciones (auditoría del consumidor, sin `AsyncLocalStorage`). */
|
|
1322
|
+
export interface RelationWriteEvent extends RelationRef {
|
|
1323
|
+
/** Quién ordenó la escritura (`RelationWriteOptions.actor`), ya validado. Ausente si no lo pasó. */
|
|
1324
|
+
actor?: SubjectRef;
|
|
1325
|
+
}
|
|
1326
|
+
/** Opciones comunes a `relate`/`unrelate`. */
|
|
1327
|
+
export interface RelationWriteOptions {
|
|
1328
|
+
/** Quién ordena la escritura; viaja en `RelationWriteEvent.actor`. */
|
|
1329
|
+
actor?: SubjectRef;
|
|
1330
|
+
}
|
|
1331
|
+
/** Una página de una enumeración de relaciones (cursor opaco que AVANZA, no filtra herencia). */
|
|
1332
|
+
export interface RelationPage {
|
|
1333
|
+
limit?: number;
|
|
1334
|
+
after?: string;
|
|
1335
|
+
}
|
|
1336
|
+
/**
|
|
1337
|
+
* Lo que un `RelationsDriver` DECLARA que puede hacer. Cada valor lleva su par
|
|
1338
|
+
* de casos `{ whenTrue, whenFalse }` en `runRelationsDriverContract` — nunca
|
|
1339
|
+
* un `skip` (3b-2e · E2). El runner FALLA si una capacidad declarada no tiene
|
|
1340
|
+
* poblada la cara que corresponde a su valor.
|
|
1341
|
+
*/
|
|
1342
|
+
export interface RelationsDriverCapabilities {
|
|
1343
|
+
/** `check` es UNA sola llamada al backend (`openfga`: un `Check`). */
|
|
1344
|
+
singleCheckRelations: boolean;
|
|
1345
|
+
/**
|
|
1346
|
+
* Los `listObjects` enumeran también lo HEREDADO. **`false` siempre** en
|
|
1347
|
+
* este paquete (invariante 7): en `openfga` obligaría a `ListObjects`, que
|
|
1348
|
+
* trunca al tope del servidor. Devuelven hechos DIRECTOS + lo derivado.
|
|
1349
|
+
*/
|
|
1350
|
+
listObjectsInherited: boolean;
|
|
1351
|
+
/** `listSubjects` devuelve también sujetos USERSET (`group:g#member`), no solo holders. */
|
|
1352
|
+
usersetSubjects: boolean;
|
|
1353
|
+
/**
|
|
1354
|
+
* El driver implementa `membersOf` (membresía TRANSITIVA a través de
|
|
1355
|
+
* usersets). Solo `database` (CTE recursiva); `openfga` es `false` (la
|
|
1356
|
+
* transitiva sería `ListUsers`, que trunca) ⇒ `membersOf` es 500
|
|
1357
|
+
* `E_AUTHZ_UNSUPPORTED`.
|
|
1358
|
+
*/
|
|
1359
|
+
membersOfNative: boolean;
|
|
1360
|
+
/** El driver sabe ser ORIGEN de `authz:reconcile` de relaciones (`enumerateRelations`). */
|
|
1361
|
+
enumerateRelations: boolean;
|
|
1362
|
+
/**
|
|
1363
|
+
* `listObjects` SEÑALA el truncamiento cuando el backend corta al tope
|
|
1364
|
+
* (`openfga` con `ListObjects`): la página devuelve `truncated: true`, nunca
|
|
1365
|
+
* una lista parcial muda (S16). Capacidad NUEVA, distinta del
|
|
1366
|
+
* `truncationSignal` de los `list*` de roles.
|
|
1367
|
+
*/
|
|
1368
|
+
listObjectsTruncation: boolean;
|
|
1369
|
+
}
|
|
1370
|
+
/**
|
|
1371
|
+
* Una página de `listObjects`/`listSubjects`/`enumerateRelations`. `truncated`
|
|
1372
|
+
* dice si el backend cortó al tope (solo con `listObjectsTruncation`): un
|
|
1373
|
+
* consumidor que lo ve sabe que hay MÁS y no toma la lista por completa.
|
|
1374
|
+
*/
|
|
1375
|
+
export interface RelationObjectsPage {
|
|
1376
|
+
objects: RelObject[];
|
|
1377
|
+
cursor?: string;
|
|
1378
|
+
truncated?: boolean;
|
|
1379
|
+
}
|
|
1380
|
+
export interface RelationSubjectsPage {
|
|
1381
|
+
subjects: RelSubject[];
|
|
1382
|
+
cursor?: string;
|
|
1383
|
+
truncated?: boolean;
|
|
1384
|
+
}
|
|
1385
|
+
/** Una tupla de relación tal como la enumera `enumerateRelations` (origen de reconcile). */
|
|
1386
|
+
export interface RelationTuple {
|
|
1387
|
+
subject: RelSubject;
|
|
1388
|
+
relation: string;
|
|
1389
|
+
object: RelObject;
|
|
1390
|
+
partition: ScopeRef;
|
|
1391
|
+
}
|
|
1392
|
+
export interface RelationTuplePage {
|
|
1393
|
+
tuples: RelationTuple[];
|
|
1394
|
+
cursor?: string;
|
|
1395
|
+
}
|
|
1396
|
+
/**
|
|
1397
|
+
* El puerto de ReBAC. `partition: ScopeRef` es OBLIGATORIA en TODA operación
|
|
1398
|
+
* (`APP_SCOPE` es válida para mono-tenant): el aislamiento de tenant se corta
|
|
1399
|
+
* por la partición, y el driver la serializa en el id del objeto y del
|
|
1400
|
+
* userset. La whitelist de tipo/relación (F-05) la aplica el manager ANTES de
|
|
1401
|
+
* llamar al driver, pero el driver la re-valida por defensa en profundidad.
|
|
1402
|
+
*/
|
|
1403
|
+
export interface RelationsDriver {
|
|
1404
|
+
readonly capabilities?: RelationsDriverCapabilities;
|
|
1405
|
+
/** Crea la relación `subject —relation→ object` en `partition`. Idempotente. */
|
|
1406
|
+
relate(subject: RelSubject, relation: string, object: RelObject, partition: ScopeRef, options?: RelationWriteOptions): Promise<void>;
|
|
1407
|
+
/** Retira la relación. No-op seguro si no existe (invariante 6). */
|
|
1408
|
+
unrelate(subject: RelSubject, relation: string, object: RelObject, partition: ScopeRef, options?: RelationWriteOptions): Promise<void>;
|
|
1409
|
+
/** ¿`subject` tiene `relation` sobre `object` en `partition` (directo o derivado por includes/userset)? */
|
|
1410
|
+
check(subject: RelSubject, relation: string, object: RelObject, partition: ScopeRef): Promise<boolean>;
|
|
1411
|
+
/** Los objetos de tipo `objectType` sobre los que `subject` tiene `relation`. Directos + derivados, sin herencia abierta. */
|
|
1412
|
+
listObjects(subject: RelSubject, relation: string, objectType: string, partition: ScopeRef, page?: RelationPage): Promise<RelationObjectsPage>;
|
|
1413
|
+
/** Los sujetos DIRECTOS de `relation` sobre `object` (holders y usersets). Nunca la membresía transitiva (eso es `membersOf`). */
|
|
1414
|
+
listSubjects(relation: string, object: RelObject, partition: ScopeRef, page?: RelationPage): Promise<RelationSubjectsPage>;
|
|
1415
|
+
/** Borra todas las tuplas cuyo OBJETO es `object` y demuestra cero, o lanza 500 `E_AUTHZ_PURGE_INCOMPLETE` (invariante 11). */
|
|
1416
|
+
purgeObject(object: RelObject, partition: ScopeRef): Promise<void>;
|
|
1417
|
+
/** Borra todas las tuplas cuyo SUJETO es `subject` y demuestra cero, o lanza 500. */
|
|
1418
|
+
purgeSubject(subject: RelSubject, partition: ScopeRef): Promise<void>;
|
|
1419
|
+
/**
|
|
1420
|
+
* La membresía TRANSITIVA de un objeto-grupo: todos los holders que son
|
|
1421
|
+
* `member` directa o a través de grupos anidados. DISTINTO de
|
|
1422
|
+
* `listSubjects(member, group)`, que devuelve solo los hechos DIRECTOS. Solo
|
|
1423
|
+
* lo trae el driver con `membersOfNative: true`.
|
|
1424
|
+
*/
|
|
1425
|
+
membersOf?(object: RelObject, relation: string, partition: ScopeRef, page?: RelationPage): Promise<RelationSubjectsPage>;
|
|
1426
|
+
/** ORIGEN de `authz:reconcile` de relaciones: las tuplas paginadas, sin filtrar. Solo con `enumerateRelations: true`. */
|
|
1427
|
+
enumerateRelations?(partition: ScopeRef, page?: RelationPage): Promise<RelationTuplePage>;
|
|
1428
|
+
}
|
|
1429
|
+
/**
|
|
1430
|
+
* Factory de un `RelationsDriver` (Fase 4, lote 4-6) — el análogo de
|
|
1431
|
+
* `AuthorizationDriverFactory` para el puerto de relaciones. El consumidor la
|
|
1432
|
+
* declara en `config.relations.drivers`, y `authz:relations:reconcile` la
|
|
1433
|
+
* invoca para construir el ORIGEN y el DESTINO de una migración de tuplas. El
|
|
1434
|
+
* driver `openfga` de relaciones entra por el subpath `/openfga` DENTRO de la
|
|
1435
|
+
* factory (como el de roles), así que el comando nunca toca el SDK (pureza).
|
|
1436
|
+
*/
|
|
1437
|
+
export type RelationsDriverFactory = () => RelationsDriver | Promise<RelationsDriver>;
|
|
655
1438
|
//# sourceMappingURL=types.d.ts.map
|