@stacksjs/orm 0.73.3 → 0.74.0

package/dist/auto-crud.d.ts

@@ -232,6 +232,34 @@ export declare function buildIndexMeta(url: URL, page: number, perPage: number,
  * solely in `buildIndexMeta`.
  */
 export declare function buildIndexPaginator(url: URL, page: number, perPage: number, rowCount: number, hasMore: boolean, total?: number): IndexPaginator;
+/**
+ * Resolve the row-scoping policy from config, with an env override.
+ *
+ * `'warn'` is the default because anything else is a breaking change to
+ * published behaviour: `'deny'` stops registering `store` / `update` /
+ * `destroy` for every model that declares no ownership, which in this
+ * framework's own model set is 62 of the 82 models that use the trait -
+ * `User` and `Team` among them.
+ *
+ * The env override exists so CI can run the strict posture without editing
+ * config, which is how an app finds out what it would lose before committing
+ * to it. An unrecognised value falls back to the default rather than throwing:
+ * a typo in a security setting should not take the API down, and the boot
+ * warning still names every unscoped model either way.
+ */
+export declare function resolveRowScopingPolicy(configured: unknown, envOverride?: string | null): ApiRowScopingPolicy;
+/**
+ * The one-line-per-boot report about models publishing unscoped mutating routes.
+ *
+ * Aggregated deliberately. The sibling warning about public reads was demoted
+ * to `debug` because 15 lines on every boot about intended behaviour is how a
+ * warning stops being read; 62 lines would be worse. One line that names the
+ * count, the models and the two ways to fix it stays readable and stays
+ * actionable.
+ *
+ * Returns null when there is nothing to report, so the caller logs nothing.
+ */
+export declare function describeUnscopedMutatingModels(modelNames: readonly string[], policy: ApiRowScopingPolicy): string | null;
 /**
  * Columns every auto-CRUD table carries regardless of declared attributes.
  * Members of the read allowlist (sort/filter) alongside the model's own
@@ -363,3 +391,8 @@ export declare interface IndexPaginator {
  */
 export type WriteValidationResult = | { valid: true }
   | { valid: false, errors: Record<string, string[]> }
+/**
+ * What to do about a model whose generated mutating routes have no row-level
+ * scoping. See `ApiSecurityOptions` in @stacksjs/types for the full reasoning.
+ */
+export type ApiRowScopingPolicy = 'warn' | 'deny';