@evolu/common 8.5.0 → 8.6.0

package/src/local-first/Query.ts

@@ -41,6 +41,7 @@ export type { NotNull as KyselyNotNull } from "kysely";
  *
  * ```ts
  * import {
+ *   assertType,
  *   createQueryBuilder,
  *   id,
  *   NonEmptyTrimmedString100,
@@ -56,11 +57,12 @@ export type { NotNull as KyselyNotNull } from "kysely";
  * const allTodos = createQuery((db) => db.selectFrom("todo").selectAll());
  *
  * type AllTodosRow = typeof allTodos.Row;
- * expectTypeOf<typeof allTodos>().toExtend<Query<typeof Schema>>();
- * expectTypeOf<AllTodosRow["id"]>().toEqualTypeOf<TodoId>();
- * expectTypeOf<
- *   AllTodosRow["title"]
- * >().toEqualTypeOf<NonEmptyTrimmedString100 | null>();
+ * assertType<
+ *   true,
+ *   typeof allTodos extends Query<typeof Schema> ? true : false
+ * >();
+ * assertType<TodoId, AllTodosRow["id"]>();
+ * assertType<NonEmptyTrimmedString100 | null, AllTodosRow["title"]>();
  * ```
  */
 export type Query<
@@ -78,6 +80,7 @@ export type Query<
      *
      * ```ts
      * import {
+     *   assertType,
      *   createQueryBuilder,
      *   id,
      *   type InferRow,
@@ -93,9 +96,7 @@ export type Query<
      * );
      *
      * type AllTodosRow = typeof allTodos.Row;
-     * expectTypeOf<AllTodosRow>().toEqualTypeOf<
-     *   InferRow<typeof allTodos>
-     * >();
+     * assertType<InferRow<typeof allTodos>, AllTodosRow>();
      * ```
      */
     Row: R;
@@ -126,6 +127,7 @@ export interface Row {
  *
  * ```ts
  * import {
+ *   assertType,
  *   createQueryBuilder,
  *   evoluJsonArrayFrom,
  *   id,
@@ -157,10 +159,13 @@ export interface Row {
  *     ]),
  * );
  *
- * expectTypeOf<(typeof people.Row.pets)[number]>().toEqualTypeOf<{
- *   petId: typeof Schema.pet.id.Output;
- *   name: NonEmptyTrimmedString100 | null;
- * }>();
+ * assertType<
+ *   {
+ *     petId: typeof Schema.pet.id.Output;
+ *     name: NonEmptyTrimmedString100 | null;
+ *   },
+ *   (typeof people.Row.pets)[number]
+ * >();
  * ```
  */
 export const evoluJsonArrayFrom = <O>(
@@ -185,6 +190,7 @@ export const evoluJsonArrayFrom = <O>(
  *
  * ```ts
  * import {
+ *   assertType,
  *   createQueryBuilder,
  *   evoluJsonObjectFrom,
  *   id,
@@ -218,10 +224,13 @@ export const evoluJsonArrayFrom = <O>(
  *     ]),
  * );
  *
- * expectTypeOf<typeof people.Row.favoritePet>().toEqualTypeOf<{
- *   petId: typeof Schema.pet.id.Output;
- *   name: NonEmptyTrimmedString100 | null;
- * } | null>();
+ * assertType<
+ *   {
+ *     petId: typeof Schema.pet.id.Output;
+ *     name: NonEmptyTrimmedString100 | null;
+ *   } | null,
+ *   typeof people.Row.favoritePet
+ * >();
  * ```
  */
 export const evoluJsonObjectFrom = <O>(
@@ -244,6 +253,7 @@ export const evoluJsonObjectFrom = <O>(
  *
  * ```ts
  * import {
+ *   assertType,
  *   createQueryBuilder,
  *   evoluJsonBuildObject,
  *   id,
@@ -274,11 +284,14 @@ export const evoluJsonObjectFrom = <O>(
  *     ]),
  * );
  *
- * expectTypeOf<typeof people.Row.name>().toEqualTypeOf<{
- *   first: NonEmptyTrimmedString100 | null;
- *   last: NonEmptyTrimmedString100 | null;
- *   full: string;
- * }>();
+ * assertType<
+ *   {
+ *     first: NonEmptyTrimmedString100 | null;
+ *     last: NonEmptyTrimmedString100 | null;
+ *     full: string;
+ *   },
+ *   typeof people.Row.name
+ * >();
  * ```
  */
 export const evoluJsonBuildObject = <

package/src/local-first/Relay.ts

@@ -79,6 +79,9 @@ export interface RelayConfig extends StorageConfig {
    * ```ts
    * import {
    *   AppName,
+   *   assertEqual,
+   *   assertTrue,
+   *   assertType,
    *   createAppOwner,
    *   createEvolu,
    *   createOwnerWebSocketTransport,
@@ -107,7 +110,10 @@ export interface RelayConfig extends StorageConfig {
    *     transports: [transport],
    *   },
    * );
-   * expectTypeOf(createTodoEvolu).toExtend<AnyTask>();
+   * assertType<
+   *   true,
+   *   typeof createTodoEvolu extends AnyTask ? true : false
+   * >();
    *
    * // Relay: accept owners allowed by the app's access policy.
    * type IsOwnerAllowed = NonNullable<RelayConfig["isOwnerAllowed"]>;
@@ -115,12 +121,13 @@ export interface RelayConfig extends StorageConfig {
    * const isOwnerAllowed: IsOwnerAllowed = (ownerId, { signal }) =>
    *   !signal.aborted && allowedOwnerIds.has(ownerId);
    *
-   * expect(
-   *   isOwnerAllowed(appOwner.id, {
+   * assertEqual(
+   *   await isOwnerAllowed(appOwner.id, {
    *     signal: new AbortController().signal,
    *   }),
-   * ).toBe(true);
-   * expect(transport.url).toContain(`ownerId=${appOwner.id}`);
+   *   true,
+   * );
+   * assertTrue(transport.url.includes(`ownerId=${appOwner.id}`));
    * ```
    */
   readonly isOwnerAllowed?: (

package/src/local-first/Schema.ts

@@ -62,6 +62,8 @@ export type AnyStandardSchemaV1 = StandardSchemaV1<any, any>;
  * ```ts
  * import * as z from "zod";
  * import {
+ *   assertOk,
+ *   assertTrue,
  *   id,
  *   NonEmptyTrimmedString100,
  *   nullOr,
@@ -79,7 +81,7 @@ export type AnyStandardSchemaV1 = StandardSchemaV1<any, any>;
  *     isCompleted: nullOr(SqliteBoolean),
  *   },
  * };
- * expectOk(Schema.todo.title.fromUnknown("Write docs"), "Write docs");
+ * assertOk(Schema.todo.title.fromUnknown("Write docs"), "Write docs");
  *
  * // Zod, or another Standard Schema library
  * const ZodSchema = {
@@ -89,7 +91,7 @@ export type AnyStandardSchemaV1 = StandardSchemaV1<any, any>;
  *     isCompleted: z.union([z.literal(0), z.literal(1)]).nullable(),
  *   },
  * };
- * expect(ZodSchema.todo.title.safeParse("Write docs").success).toBe(true);
+ * assertTrue(ZodSchema.todo.title.safeParse("Write docs").success);
  * ```
  */
 export type EvoluSchema = ReadonlyRecord<
@@ -238,6 +240,7 @@ export interface MutationOptions {
    *
    * ```ts
    * import {
+   *   assertEqual,
    *   createAppOwner,
    *   createOwnerSecret,
    *   createRandomBytes,
@@ -263,7 +266,7 @@ export interface MutationOptions {
    *   createOwnerSecret({ randomBytes }),
    * );
    *
-   * const insertOwnedRows = (evolu: Evolu<typeof Schema>): void => {
+   * const _insertOwnedRows = (evolu: Evolu<typeof Schema>): void => {
    *   // Partition app data by project.
    *   evolu.insert(
    *     "task",
@@ -279,8 +282,8 @@ export interface MutationOptions {
    *   );
    * };
    *
-   * expect(projectOwner.type).toBe("ShardOwner");
-   * expect(sharedOwner.type).toBe("SharedOwner");
+   * assertEqual(projectOwner.type, "ShardOwner");
+   * assertEqual(sharedOwner.type, "SharedOwner");
    * ```
    */
   readonly ownerId?: OwnerId;
@@ -448,6 +451,8 @@ export const evoluSchemaToSqliteSchema = <S extends EvoluSchema>(
  *
  * ```ts
  * import {
+ *   assertTrue,
+ *   assertType,
  *   createQueryBuilder,
  *   id,
  *   NonEmptyTrimmedString100,
@@ -471,12 +476,15 @@ export const evoluSchemaToSqliteSchema = <S extends EvoluSchema>(
  *   db.selectFrom("todo").select(["id", "title", "isCompleted"]),
  * );
  *
- * expectTypeOf<typeof todosQuery.Row>().toEqualTypeOf<{
- *   id: TodoId;
- *   title: NonEmptyTrimmedString100 | null;
- *   isCompleted: SqliteBoolean | null;
- * }>();
- * expect(todosQuery).toBeTypeOf("string");
+ * assertType<
+ *   {
+ *     id: TodoId;
+ *     title: NonEmptyTrimmedString100 | null;
+ *     isCompleted: SqliteBoolean | null;
+ *   },
+ *   typeof todosQuery.Row
+ * >();
+ * assertTrue(typeof todosQuery === "string");
  * ```
  */
 export const createQueryBuilder = <S extends EvoluSchema>(

package/src/local-first/Storage.ts

@@ -70,6 +70,7 @@ export interface StorageConfig {
    *
    * ```ts
    * import {
+   *   assertEqual,
    *   createAppOwner,
    *   createOwnerSecret,
    *   createRandomBytes,
@@ -87,12 +88,13 @@ export interface StorageConfig {
    *     ownerId === appOwner.id && requiredBytes <= maxBytes,
    * };
    *
-   * expect(
+   * assertEqual(
    *   await relayStorageConfig.isOwnerWithinQuota(
    *     appOwner.id,
    *     PositiveInt.orThrow(2048),
    *   ),
-   * ).toBe(false);
+   *   false,
+   * );
    * ```
    */
   readonly isOwnerWithinQuota: (