@rebasepro/types 0.13.0 → 0.13.1-canary.g3660bd5

package/dist/controllers/data.d.ts

@@ -34,13 +34,19 @@ export interface FilterCondition {
  *
  * `limit`/`offset` and `page` describe the same window two ways. If **both
  * `offset` and `page` are provided, `page` wins** — the backend computes
- * `offset = (page - 1) * (limit ?? 20)` and ignores the explicit `offset`.
- * Pick one style per query.
+ * `offset = (page - 1) * (limit ?? DEFAULT_LIST_LIMIT)` and ignores the
+ * explicit `offset`. Pick one style per query.
  *
  * @group Data
  */
 export interface FindParams<M extends Record<string, unknown> = Record<string, unknown>> {
-    /** Maximum number of items to return (default: 20). */
+    /**
+     * Maximum number of items to return.
+     *
+     * Defaults to {@link DEFAULT_LIST_LIMIT}, and is clamped to
+     * {@link MAX_LIST_LIMIT}. Both bounds are applied by the backend, so a
+     * read is never unbounded whether or not a limit was asked for.
+     */
     limit?: number;
     /**
      * Number of items to skip. Ignored when {@link FindParams.page} is also
@@ -49,7 +55,7 @@ export interface FindParams<M extends Record<string, unknown> = Record<string, u
     offset?: number;
     /**
      * Page number (1-indexed), alternative to {@link FindParams.offset}.
-     * When set, overrides `offset` as `(page - 1) * (limit ?? 20)`.
+     * When set, overrides `offset` as `(page - 1) * (limit ?? DEFAULT_LIST_LIMIT)`.
      */
     page?: number;
     /**
@@ -539,10 +545,15 @@ export type RebaseData<DB = unknown> = {
      * Dynamic collection accessor.
      * Access any collection by its slug as a property.
      *
+     * The index signature is `CollectionAccessor` alone, for the reason
+     * spelled out on {@link RebaseSdkData}: unioning in the `collection`
+     * method's own signature is unnecessary across an intersection, and it
+     * costs `data.products.find()` — the access this `@example` documents.
+     *
      * @example
      * data.products.find({ where: { status: ["==", "published"] } })
      */
-    [collectionSlug: string]: CollectionAccessor | ((slug: string) => CollectionAccessor);
+    [collectionSlug: string]: CollectionAccessor;
 });
 /**
  * The unified data access object for the **SDK** — flat rows, no Entity wrapper.
@@ -595,6 +606,26 @@ export type InsertOf<T> = T extends {
 export type UpdateOf<T> = T extends {
     Update: infer U extends Record<string, unknown>;
 } ? U : Partial<RowOf<T>>;
+/**
+ * Note on the untyped branch below: its index signature is
+ * `SDKCollectionClient`, NOT `SDKCollectionClient | ((slug: string) => …)`.
+ *
+ * The union looks like it is needed so `collection` — a method on this same
+ * object — satisfies the index signature. It is not, because `collection` is
+ * declared in a *separate* member of the intersection, and TypeScript only
+ * requires named properties to be assignable to an index signature declared
+ * alongside them. Including the function arm cost the documented accessor:
+ *
+ *     rebase.dataAsAdmin.projects.find()
+ *     //                          ^ Property 'find' does not exist on type
+ *     //                            'SDKCollectionClient | ((slug: string) => …)'
+ *
+ * Every project without a generated `Database` type lands on this branch, so
+ * property-style access — the form used by the `@example` below, by the
+ * scaffolded function template, and by the 0.13 migration note — did not
+ * compile for any of them. Do not restore the arm; use `collection(slug)` if a
+ * caller genuinely needs the by-slug function.
+ */
 export type RebaseSdkData<DB = unknown> = {
     /**
      * Get a flat collection accessor by slug.
@@ -614,5 +645,5 @@ export type RebaseSdkData<DB = unknown> = {
      * @example
      * data.products.find({ where: { status: ["==", "published"] } })
      */
-    [collectionSlug: string]: SDKCollectionClient | ((slug: string) => SDKCollectionClient);
+    [collectionSlug: string]: SDKCollectionClient;
 });

package/dist/index.es.js

@@ -307,6 +307,7 @@ var ADMIN_COLLECTION_KEYS = [
 	"defaultSize",
 	"defaultViewMode",
 	"disableDefaultActions",
+	"display",
 	"enabledViews",
 	"entityActions",
 	"entityViews",