@rebasepro/common 0.23.0 → 0.24.1-canary.g56af4a4

package/dist/data/buildRebaseData.d.ts

@@ -22,6 +22,28 @@ export interface EntityDataOptions {
         relations?: unknown[];
         slug?: string;
     } | undefined;
+    /**
+     * Translate the path a collection is addressed by into the path its driver
+     * stores it under.
+     *
+     * The admin addresses every collection by its slug, and a Firestore or
+     * MongoDB collection may declare a `path` of its own: `fs_diagnosis` stored
+     * at `diagnosis`, and `fs_diagnosis/abc/locales` at `diagnosis/abc/locales`.
+     * Only the driver is handed the stored path. Rows keep the address they
+     * were asked for by, because that is what the admin resolves their
+     * collection, routes and deletes by.
+     *
+     * Late-bound, like `resolveCollection`. Absent, or answering `undefined`,
+     * the address is the stored path.
+     */
+    resolveDataPath?: (path: string) => string | undefined;
+    /**
+     * The slug a property of the proxy names (`data.myNotes`). Absent, a
+     * property is its snake_case (`my_notes`). The server passes
+     * `createAccessorSlugResolver` over its collection registry, so a
+     * collection is reachable under the accessor its generated type has.
+     */
+    resolveAccessor?: (property: string) => string;
 }
 export declare function buildRebaseData(driver: DataDriver, options?: EntityDataOptions): RebaseData;
 /**
@@ -51,7 +73,7 @@ export declare function wrapAsEntityData(sdkData: Pick<RebaseSdkData, "collectio
  * — e.g. the admin routes its Entity data via `useData()` and exposes the
  * same routing as flat `context.data` for callbacks by wrapping it here.
  */
-export declare function wrapAsSdkData(entityData: RebaseData): RebaseSdkData;
+export declare function wrapAsSdkData(entityData: RebaseData, options?: Pick<EntityDataOptions, "resolveAccessor">): RebaseSdkData;
 /**
  * Build a flat {@link RebaseSdkData} from a `DataDriver`.
  *
@@ -63,5 +85,8 @@ export declare function wrapAsSdkData(entityData: RebaseData): RebaseSdkData;
  * the admin's view-model and never reaches here.
  *
  * The admin uses {@link buildRebaseData} (Entity) over its own driver.
+ *
+ * `options.resolveAccessor` names the slug a property is (see
+ * `createAccessorSlugResolver`); absent, `data.myNotes` is `my_notes`.
  */
-export declare function buildSdkData(driver: DataDriver): RebaseSdkData;
+export declare function buildSdkData(driver: DataDriver, options?: Pick<EntityDataOptions, "resolveAccessor">): RebaseSdkData;