@evolu/common 6.0.1-preview.16 → 6.0.1-preview.18

package/dist/src/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./Array.js";
 export * from "./Assert.js";
 export * from "./BigInt.js";
+export * from "./Brand.js";
 export * from "./Buffer.js";
 export * from "./Callbacks.js";
 export * from "./Console.js";

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC"}

package/dist/src/index.js

@@ -1,6 +1,7 @@
 export * from "./Array.js";
 export * from "./Assert.js";
 export * from "./BigInt.js";
+export * from "./Brand.js";
 export * from "./Buffer.js";
 export * from "./Callbacks.js";
 export * from "./Console.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evolu/common",
-  "version": "6.0.1-preview.16",
+  "version": "6.0.1-preview.18",
   "description": "TypeScript library and local-first framework",
   "keywords": [
     "evolu",
@@ -45,10 +45,10 @@
     "@noble/ciphers": "^1.3.0",
     "@noble/hashes": "^1.8.0",
     "@scure/bip39": "^1.6.0",
-    "kysely": "^0.28.2",
-    "msgpackr": "^1.11.4",
+    "kysely": "^0.28.4",
+    "msgpackr": "^1.11.5",
     "nanoid": "^3.3.11",
-    "random": "^5.4.0"
+    "random": "^5.4.1"
   },
   "devDependencies": {
     "@bokuweb/zstd-wasm": "0.0.27",
@@ -56,7 +56,7 @@
     "@types/ws": "^8.18.1",
     "better-sqlite3": "^12.1.1",
     "shx": "^0.3.4",
-    "typescript": "^5.8.3",
+    "typescript": "^5.9.2",
     "vitest": "^3.2.3",
     "ws": "^8.18.2",
     "@evolu/tsconfig": "0.0.2"

package/src/Brand.ts

@@ -0,0 +1,75 @@
+/**
+ * A utility interface for creating branded types.
+ *
+ * Branded types enhance type safety by differentiating otherwise identical base
+ * types, such as `number` or `string`, to enforce stricter type checks.
+ *
+ * Supports multiple brands, allowing types to act like flags.
+ *
+ * ### Example 1: Single Brand
+ *
+ * ```ts
+ * // A branded type definition
+ * type UserId = number & Brand<"UserId">;
+ *
+ * // A function that creates `UserId` values.
+ * // Casting with `as UserId` is unsafe, so `createUserId` must be unit-tested.
+ * const createUserId = (): UserId => {
+ *   return 123 as UserId; // Unsafe casting
+ * };
+ *
+ * const userId = createUserId();
+ *
+ * // A function that accepts only `UserId`.
+ * const getUser = (id: UserId) => {
+ *   // Implementation
+ * };
+ *
+ * getUser(userId); // ✅ Valid
+ * getUser(123); // ❌ TypeScript error
+ * getUser("123"); // ❌ TypeScript error
+ * ```
+ *
+ * ### Example 2: Multiple Brands
+ *
+ * ```ts
+ * // Define branded types
+ * type Min1 = string & Brand<"Min1">;
+ * type Max100 = string & Brand<"Max100">;
+ * type Min1Max100 = string & Brand<"Min1" | "Max100">;
+ *
+ * // Functions requiring specific brands
+ * const requiresMin1 = (value: Min1): void => {};
+ * const requiresMax100 = (value: Max100): void => {};
+ *
+ * // Values with single brands
+ * const min1Value: Min1 = "hello" as Min1;
+ * const max100Value: Max100 = "world" as Max100;
+ *
+ * // Value with multiple brands
+ * const min1Max100Value: Min1Max100 = "typescript" as Min1Max100;
+ *
+ * // Valid cases
+ * requiresMin1(min1Value); // ✅ Valid
+ * requiresMax100(max100Value); // ✅ Valid
+ * requiresMin1(min1Max100Value); // ✅ Valid: Min1Max100 satisfies Min1
+ * requiresMax100(min1Max100Value); // ✅ Valid: Min1Max100 satisfies Max100
+ * ```
+ */
+export interface Brand<B extends string> {
+  readonly [__brand]: Readonly<Record<B, true>>;
+}
+
+declare const __brand: unique symbol;
+
+/**
+ * Determines whether a type `T` is a branded type.
+ *
+ * Works with any base type intersected with a `Brand`.
+ *
+ * ### Examples
+ *
+ * - `IsBranded<string>` -> false
+ * - `IsBranded<string & Brand<"X">>` -> true
+ */
+export type IsBranded<T> = T extends Brand<string> ? true : false;

package/src/Callbacks.ts

@@ -1,5 +1,5 @@
 import { NanoIdLibDep } from "./NanoId.js";
-import { Brand } from "./Types.js";
+import { Brand } from "./Brand.js";
 
 /**
  * Manages one-time callback functions.

package/src/Crypto.ts

@@ -20,7 +20,7 @@ import {
   NonNegativeInt,
   Uint8Array,
 } from "./Type.js";
-import { Brand } from "./Types.js";
+import { Brand } from "./Brand.js";
 import { assert } from "./Assert.js";
 
 /** `Uint8Array` created by {@link createRandomBytes}. */

package/src/Evolu/Db.ts

@@ -1,8 +1,4 @@
-import {
-  isNonEmptyArray,
-  isNonEmptyReadonlyArray,
-  NonEmptyReadonlyArray,
-} from "../Array.js";
+import { isNonEmptyArray, NonEmptyReadonlyArray } from "../Array.js";
 import { assert, assertNonEmptyReadonlyArray } from "../Assert.js";
 import { CallbackId } from "../Callbacks.js";
 import { ConsoleDep } from "../Console.js";
@@ -121,7 +117,6 @@ export type DbWorkerInput =
       readonly type: "init";
       readonly config: Config;
       readonly dbSchema: DbSchema;
-      readonly initialData: ReadonlyArray<DbChange>;
     }
   | {
       readonly type: "mutate";
@@ -157,6 +152,7 @@ export type DbWorkerOutput =
   | {
       readonly type: "onInit";
       readonly appOwner: AppOwner;
+      readonly isFirst: boolean;
     }
   | {
       readonly type: "onError";
@@ -289,11 +285,11 @@ export const createDbWorkerForPlatform = (
         let appOwner: AppOwner;
         let clock: Clock;
 
-        const versionTableExists = currentDbSchema.value.tables.some(
+        const dbIsInitialized = currentDbSchema.value.tables.some(
           (table) => table.name === "evolu_version",
         );
 
-        if (versionTableExists) {
+        if (dbIsInitialized) {
           const versionResult = sqlite.exec<{
             protocolVersion: number;
           }>(sql`select protocolVersion from evolu_version limit 1;`);
@@ -383,15 +379,11 @@ export const createDbWorkerForPlatform = (
           storage: storage.value,
         };
 
-        if (
-          !versionTableExists &&
-          isNonEmptyReadonlyArray(initMessage.initialData)
-        ) {
-          const result = applyChanges(depsWithoutSync)(initMessage.initialData);
-          if (!result.ok) return result;
-        }
-
-        postMessage({ type: "onInit", appOwner });
+        postMessage({
+          type: "onInit",
+          appOwner,
+          isFirst: !dbIsInitialized,
+        });
 
         const sync = platformDeps.createSync(platformDeps)({
           ...initMessage.config,

package/src/Evolu/Evolu.ts

@@ -465,36 +465,36 @@ export type EvoluDeps = CreateDbWorkerDep &
   ConsoleDep &
   CreateAppStateDep;
 
-export interface EvoluConfigWithInitialData<S extends EvoluSchema = EvoluSchema>
-  extends Config {
+export interface EvoluConfigWithFunctions extends Config {
   /**
-   * Use this option to create initial data (fixtures).
+   * Callback invoked when the database is initialized. Use `isFirst` to perform
+   * one-time setup like initial data seeding.
    *
    * ### Example
    *
    * ```ts
    * const evolu = createEvolu(evoluReactWebDeps)(Schema, {
-   *   initialData: (evolu) => {
-   *     const todoCategory = evolu.insert("todoCategory", {
-   *       name: "Not Urgent",
-   *     });
+   *   onInit: ({ appOwner, isFirst }) => {
+   *     if (isFirst) {
+   *       const todoCategoryId = getOrThrow(
+   *         evolu.insert("todoCategory", {
+   *           name: "Not Urgent",
+   *         }),
+   *       );
    *
-   *     // This is a developer error, which should be fixed immediately.
-   *     assert(todoCategory.ok, "invalid initial data");
-   *
-   *     evolu.insert("todo", {
-   *       title: "Try React Suspense",
-   *       categoryId: todoCategory.value.id,
-   *     });
+   *       evolu.insert("todo", {
+   *         title: "Try React Suspense",
+   *         categoryId: todoCategoryId.id,
+   *       });
+   *     }
    *   },
    * });
    * ```
    */
-  initialData?: (evolu: EvoluForInitialData<S>) => void;
-}
-
-export interface EvoluForInitialData<S extends EvoluSchema = EvoluSchema> {
-  insert: Mutation<S, "insert">;
+  readonly onInit?: (params: {
+    readonly appOwner: AppOwner;
+    readonly isFirst: boolean;
+  }) => void;
 }
 
 // For hot reloading and Evolu multitenancy.
@@ -553,7 +553,7 @@ export const createEvolu =
   (deps: EvoluDeps) =>
   <S extends EvoluSchema>(
     schema: ValidateSchema<S> extends never ? S : ValidateSchema<S>,
-    partialConfig: Partial<EvoluConfigWithInitialData<S>> = {},
+    partialConfig: Partial<EvoluConfigWithFunctions> = {},
   ): Evolu<S> => {
     const config = { ...defaultConfig, ...partialConfig };
 
@@ -577,15 +577,13 @@ const createEvoluInstance =
   (deps: EvoluDeps) =>
   (
     schema: EvoluSchema,
-    evoluConfig: EvoluConfigWithInitialData,
+    evoluConfig: EvoluConfigWithFunctions,
   ): InternalEvoluInstance => {
     deps.console.enabled = evoluConfig.enableLogging ?? false;
 
     deps.console.log("[evolu]", "createEvoluInstance");
 
-    // evoluConfig.mnemonic
-
-    const { initialData, indexes, ...config } = evoluConfig;
+    const { onInit, indexes, ...config } = evoluConfig;
 
     const errorStore = createStore<EvoluError | null>(null);
     const rowsStore = createStore<QueryRowsMap>(new Map());
@@ -608,6 +606,10 @@ const createEvoluInstance =
       switch (message.type) {
         case "onInit": {
           appOwnerStore.set(message.appOwner);
+          onInit?.({
+            appOwner: message.appOwner,
+            isFirst: message.isFirst,
+          });
           break;
         }
 
@@ -702,40 +704,10 @@ const createEvoluInstance =
       return type;
     };
 
-    const initialDataDbChanges: Array<DbChange> = [];
-
-    /**
-     * Note that the initial data function is called even if it is unnecessary
-     * (initial data are already in the DB) because we don't want to wait for
-     * SQLite's response. Initial data should be small (because they are inlined
-     * in the code), so it's ok.
-     */
-    if (initialData)
-      initialData({
-        insert: (table, props) => {
-          const id = createId(deps);
-          const values = getMutationType(table, "insert").fromUnknown(props);
-
-          if (values.ok) {
-            const valuesWithCreatedAt = {
-              ...values.value,
-              createdAt: new Date(deps.time.now()).toISOString(),
-            };
-            const dbChange = { table, id, values: valuesWithCreatedAt };
-            assertValidDbChange(dbChange);
-            initialDataDbChanges.push(dbChange);
-            return ok({ id });
-          }
-
-          return values;
-        },
-      });
-
     dbWorker.postMessage({
       type: "init",
       config,
       dbSchema,
-      initialData: initialDataDbChanges,
     });
 
     const loadQueryMicrotaskQueue: Array<Query> = [];

package/src/Evolu/Owner.ts

@@ -1,3 +1,4 @@
+/* eslint-disable jsdoc/no-undefined-types */
 /**
  * Evolu Owner - Data Ownership and Collaboration
  *

package/src/Evolu/Protocol.ts

@@ -1,3 +1,4 @@
+/* eslint-disable jsdoc/no-undefined-types */
 /**
  * Evolu Protocol
  *
@@ -182,7 +183,8 @@ import {
   PositiveInt,
   record,
 } from "../Type.js";
-import { Brand, Predicate } from "../Types.js";
+import { Predicate } from "../Types.js";
+import { Brand } from "../Brand.js";
 import { Owner, OwnerId, WriteKey, writeKeyLength } from "./Owner.js";
 import {
   BinaryTimestamp,

package/src/Evolu/Public.ts

@@ -5,12 +5,7 @@
  */
 
 export { createEvolu } from "./Evolu.js";
-export type {
-  Evolu,
-  EvoluConfigWithInitialData,
-  EvoluDeps,
-  EvoluError,
-} from "./Evolu.js";
+export type { Evolu, EvoluDeps, EvoluError } from "./Evolu.js";
 export * from "./Owner.js";
 export { binaryIdToId, idToBinaryId } from "./Protocol.js";
 export type { BinaryId } from "./Protocol.js";

package/src/Evolu/Query.ts

@@ -8,7 +8,8 @@ import {
   SqliteValue,
 } from "../Sqlite.js";
 import { Store, StoreSubscribe } from "../Store.js";
-import { Brand, Simplify } from "../Types.js";
+import { Simplify } from "../Types.js";
+import { Brand } from "../Brand.js";
 
 /**
  * A type-safe SQL query.

package/src/Evolu/Schema.ts

@@ -32,8 +32,8 @@ import { DbSchema } from "./Db.js";
 import { createIndexes, DbIndexesBuilder } from "./Kysely.js";
 import {
   BinaryId,
-  maxProtocolMessageRangesSize,
   CrdtMessage,
+  maxProtocolMessageRangesSize,
 } from "./Protocol.js";
 import { Query, Row } from "./Query.js";
 import { BinaryTimestamp } from "./Timestamp.js";
@@ -251,13 +251,6 @@ export interface MutationOptions {
    * `onlyValidate: true`.
    */
   readonly onlyValidate?: boolean;
-
-  // /**
-  //  * The owner to use for this mutation. Can be a {@link ShardOwner} for sharding
-  //  * app data or a {@link SharedOwner} for collaborative write access. If
-  //  * omitted, defaults to the app's {@link AppOwner}.
-  //  */
-  // readonly owner?: ShardOwner | SharedOwner;
 }
 
 /**

package/src/Evolu/Storage.ts

@@ -29,7 +29,7 @@ import { RandomDep } from "../Random.js";
 import { ok, Result } from "../Result.js";
 import { sql, SqliteDep, SqliteError } from "../Sqlite.js";
 import { Int64String, NonNegativeInt, PositiveInt } from "../Type.js";
-import { Brand } from "../Types.js";
+import { Brand } from "../Brand.js";
 import { OwnerId } from "./Owner.js";
 import {
   BinaryOwnerId,

package/src/Evolu/Timestamp.ts

@@ -13,7 +13,7 @@ import {
   regex,
   String,
 } from "../Type.js";
-import { Brand } from "../Types.js";
+import { Brand } from "../Brand.js";
 
 export interface TimestampConfig {
   /**

package/src/Number.ts

@@ -2,12 +2,8 @@ import { NonEmptyReadonlyArray } from "./Array.js";
 import { assertNonEmptyReadonlyArray } from "./Assert.js";
 import { err, ok, Result } from "./Result.js";
 import { NonNegativeInt, PositiveInt } from "./Type.js";
-import {
-  IntentionalNever,
-  IsBranded,
-  Predicate,
-  WidenLiteral,
-} from "./Types.js";
+import { IntentionalNever, Predicate, WidenLiteral } from "./Types.js";
+import { IsBranded } from "./Brand.js";
 
 export const increment = (n: number): number => n + 1;
 

package/src/Result.ts

@@ -1,36 +1,17 @@
 /**
  * 🛡️ Type-safe errors
  *
- * ## Intro
- *
  * The problem with throwing an exception in JavaScript is that the caught error
  * is always of an unknown type. The unknown type is a problem because we can't
  * be sure all errors have been handled because the TypeScript compiler can't
- * help us.
- *
- * Some other languages like Rust 🦀 or Haskell 📚 use a type-safe approach to
- * error handling, where errors are explicitly represented as part of the return
- * type, such as Result or Either, allowing the developer to handle all errors
- * safely. ✅
- *
- * ✨ Evolu uses {@link Result}, and it looks like this:
- *
- * ```ts
- * type Result<T, E> = Ok<T> | Err<E>;
- *
- * interface Ok<T> {
- *   readonly ok: true;
- *   readonly value: T;
- * }
- *
- * interface Err<E> {
- *   readonly ok: false;
- *   readonly error: E;
- * }
+ * tell us. Some other languages like Rust 🦀 or Haskell 📚 use a type-safe
+ * approach to error handling, where errors are explicitly represented as part
+ * of the return type, such as Result or Either, allowing the developer to
+ * handle all errors safely. ✅
  *
- * const ok = <T>(value: T): Ok<T> => ({ ok: true, value });
- * const err = <E>(error: E): Err<E> => ({ ok: false, error });
- * ```
+ * This type models that approach in TypeScript. A `Result` can be either
+ * {@link Ok} (success) or {@link Err} (error). Use {@link ok} to create a
+ * successful result and {@link err} to create an error result.
  *
  * Now let's look at how `Result` can be used for safe JSON parsing:
  *
@@ -197,9 +178,8 @@
  * ### How do I handle an array of operations and short-circuit on the first error?
  *
  * If you have an array of operations (not results), you should make them
- * _lazy_—that is, represent each operation as a function (see `LazyValue` in
- * `Function.ts`). This way, you only execute each operation as needed, and can
- * stop on the first error:
+ * _lazy_—that is, represent each operation as a function. This way, you only
+ * execute each operation as needed, and can stop on the first error:
  *
  * ```ts
  * import type { LazyValue } from "./Function";
@@ -234,15 +214,6 @@
  * developers. While monads and functional helpers can be powerful, they often
  * obscure control flow and make debugging harder. Evolu's approach keeps error
  * handling explicit and straightforward.
- *
- * @module
- */
-
-/**
- * A `Result` can be either {@link Ok} (success) or {@link Err} (error).
- *
- * Use {@link ok} to create a successful result and {@link err} to create an error
- * result.
  */
 export type Result<T, E> = Ok<T> | Err<E>;
 
@@ -355,12 +326,14 @@ export const err = <E>(error: E): Err<E> => ({ ok: false, error });
  * const config = getOrThrow(loadConfig());
  * // Safe to use config here
  * ```
+ *
+ * Throws: `Error` with the original error attached as `cause`.
  */
 export const getOrThrow = <T, E>(result: Result<T, E>): T => {
   if (result.ok) {
     return result.value;
   } else {
-    throw new Error(`Result error: ${JSON.stringify(result.error)}`);
+    throw new Error("getOrThrow failed", { cause: result.error });
   }
 };
 

package/src/Sqlite.ts

@@ -11,7 +11,8 @@ import {
   Uint8Array,
   union,
 } from "./Type.js";
-import { Brand, Predicate, IntentionalNever } from "./Types.js";
+import { Predicate, IntentionalNever } from "./Types.js";
+import { Brand } from "./Brand.js";
 
 /**
  * SQLite driver interface. This is the minimal interface that platform-specific

package/src/Type.ts

@@ -1,3 +1,4 @@
+/* eslint-disable jsdoc/no-undefined-types */
 /**
  * 🧩 Validation, Parsing, and Transformation
  *
@@ -79,7 +80,8 @@ import { NanoIdLibDep } from "./NanoId.js";
 import { isPlainObject } from "./Object.js";
 import { Err, err, Ok, ok, Result, trySync } from "./Result.js";
 import { safelyStringifyUnknownValue } from "./String.js";
-import type { Brand, Literal, Simplify, WidenLiteral } from "./Types.js";
+import type { Literal, Simplify, WidenLiteral } from "./Types.js";
+import type { Brand } from "./Brand.js";
 import { IntentionalNever } from "./Types.js";
 
 export interface Type<

package/src/Types.ts

@@ -78,82 +78,6 @@ export type NullablePartial<
  */
 export type IntentionalNever = never;
 
-/**
- * A utility interface for creating branded types.
- *
- * Branded types enhance type safety by differentiating otherwise identical base
- * types, such as `number` or `string`, to enforce stricter type checks.
- *
- * Supports multiple brands, allowing types to act like flags.
- *
- * ### Example 1: Single Brand
- *
- * ```ts
- * // A branded type definition
- * type UserId = number & Brand<"UserId">;
- *
- * // A function that creates `UserId` values.
- * // Casting with `as UserId` is unsafe, so `createUserId` must be unit-tested.
- * const createUserId = (): UserId => {
- *   return 123 as UserId; // Unsafe casting
- * };
- *
- * const userId = createUserId();
- *
- * // A function that accepts only `UserId`.
- * const getUser = (id: UserId) => {
- *   // Implementation
- * };
- *
- * getUser(userId); // ✅ Valid
- * getUser(123); // ❌ TypeScript error
- * getUser("123"); // ❌ TypeScript error
- * ```
- *
- * ### Example 2: Multiple Brands
- *
- * ```ts
- * // Define branded types
- * type Min1 = string & Brand<"Min1">;
- * type Max100 = string & Brand<"Max100">;
- * type Min1Max100 = string & Brand<"Min1" | "Max100">;
- *
- * // Functions requiring specific brands
- * const requiresMin1 = (value: Min1): void => {};
- * const requiresMax100 = (value: Max100): void => {};
- *
- * // Values with single brands
- * const min1Value: Min1 = "hello" as Min1;
- * const max100Value: Max100 = "world" as Max100;
- *
- * // Value with multiple brands
- * const min1Max100Value: Min1Max100 = "typescript" as Min1Max100;
- *
- * // Valid cases
- * requiresMin1(min1Value); // ✅ Valid
- * requiresMax100(max100Value); // ✅ Valid
- * requiresMin1(min1Max100Value); // ✅ Valid: Min1Max100 satisfies Min1
- * requiresMax100(min1Max100Value); // ✅ Valid: Min1Max100 satisfies Max100
- * ```
- */
-export interface Brand<B extends string> {
-  readonly [__brand]: Readonly<Record<B, true>>;
-}
-
-declare const __brand: unique symbol;
-
-/**
- * Determines whether a type `T` is a branded type.
- *
- * Works with any base type intersected with a `Brand`.
- *
- * ### Examples
- *
- * - `IsBranded<string>` -> false
- * - `IsBranded<string & Brand<"X">>` -> true
- */
-export type IsBranded<T> = T extends Brand<string> ? true : false;
-
 /**
  * String | number | bigint | boolean | undefined | null
  *

package/src/index.ts

@@ -1,6 +1,7 @@
 export * from "./Array.js";
 export * from "./Assert.js";
 export * from "./BigInt.js";
+export * from "./Brand.js";
 export * from "./Buffer.js";
 export * from "./Callbacks.js";
 export * from "./Console.js";