@tailor-platform/sdk 2.32.0 → 2.33.0

package/dist/vitest/pglite-kysely.d.mts

@@ -82,5 +82,24 @@ export interface CreateKyselyPGliteOptions {
  * ```
  */
 export declare function createKyselyPGlite<DB = Record<string, never>>(client: PGliteClient, options?: CreateKyselyPGliteOptions): Kysely<DB>;
+/**
+ * Run `prepare` with relations unchecked, so a test can stage rows that predate a relation (for
+ * example rows whose parent does not exist, which the migration under test repairs). The setting
+ * from before the first call is restored when the last `prepareFixtures` on the client returns or
+ * throws, so the script under test still runs against checked relations, and calls that are nested
+ * or overlap keep relations unchecked until all of them are done. NOT NULL, UNIQUE, and CHECK
+ * constraints stay enforced.
+ * @param client - The PGlite instance the rows are written to
+ * @param prepare - Writes the rows, for example with the Kysely instance of the same client
+ * @returns Whatever `prepare` returns
+ * @example
+ * ```typescript
+ * await prepareFixtures(pglite, async () => {
+ *   await db.insertInto("Order").values([{ ownerID: crypto.randomUUID() }]).execute();
+ * });
+ * await db.transaction().execute((trx) => main(trx));
+ * ```
+ */
+export declare function prepareFixtures<T>(client: PGliteClient, prepare: () => Promise<T>): Promise<T>;
 //#endregion
 export {};