@evefrontier/dapp-kit 0.1.3 → 0.1.6

package/README.md

@@ -44,6 +44,19 @@ function MyDapp() {
 
 Configure assembly via env (`VITE_OBJECT_ID`, as Sui Object ID) or URL (`?itemId=...&tenant=...`, derived).
 
+Install the package once; then import only what you need via subpaths.
+
+| Subpath | Use when you need |
+|--------|--------------------|
+| `@evefrontier/dapp-kit` | Default: providers, hooks, types, utils |
+| `@evefrontier/dapp-kit/graphql` | GraphQL client, queries, and response types |
+| `@evefrontier/dapp-kit/types` | Type definitions only |
+| `@evefrontier/dapp-kit/utils` | Utilities (parsing, transforms, config) |
+| `@evefrontier/dapp-kit/hooks` | Hooks only |
+| `@evefrontier/dapp-kit/providers` | Providers only |
+| `@evefrontier/dapp-kit/config` | Config / dApp kit setup |
+  
+
 ## More
 
 Hooks, types, GraphQL helpers, utilities, and wallet APIs are documented at **[http://sui-docs.evefrontier.com/](http://sui-docs.evefrontier.com/)**.

package/graphql/client.ts

@@ -45,7 +45,7 @@ import {
  * This is the low-level function used by all other GraphQL helper functions.
  * Use this when you need to execute custom queries not covered by the helper functions.
  *
- * @category GraphQL
+ * @category GraphQL Client
  * @typeParam T - The expected response data type
  * @param query - The GraphQL query string
  * @param variables - Variables to pass to the query
@@ -97,7 +97,7 @@ export async function executeGraphQLQuery<T = unknown>(
  * Use this for low-level object access when you need raw BCS data.
  * For JSON-decoded data, use {@link getObjectWithJson} instead.
  *
- * @category GraphQL
+ * @category GraphQL Client
  * @param address - The Sui object address (0x...)
  * @returns Promise resolving to object with BCS contents
  *
@@ -121,7 +121,7 @@ export async function getObjectByAddress(address: string) {
  * which is useful for assemblies that store data in dynamic fields
  * (e.g., inventory items, configuration).
  *
- * @category GraphQL
+ * @category GraphQL Client
  * @param objectId - The Sui object ID
  * @returns Promise resolving to object with dynamic fields
  *
@@ -147,7 +147,7 @@ export async function getObjectWithDynamicFields(objectId: string) {
  * This is the most common way to fetch object data when you need
  * to read the object's fields as JavaScript objects.
  *
- * @category GraphQL
+ * @category GraphQL Client
  * @param address - The Sui object address
  * @returns Promise resolving to object with JSON contents
  *
@@ -170,7 +170,7 @@ export async function getObjectWithJson(address: string) {
  * Useful for traversing ownership chains, e.g., finding all assemblies
  * owned by a specific character.
  *
- * @category GraphQL
+ * @category GraphQL Client
  * @param objectAddress - The Sui object address to query owner of
  * @param ownedObjectType - Optional type filter for owned objects
  * @returns Promise resolving to owner info and owned objects (BCS format)
@@ -203,7 +203,7 @@ export async function getObjectOwnerAndOwnedObjectsByType(
  * Similar to {@link getObjectOwnerAndOwnedObjectsByType} but returns
  * JSON-decoded contents for easier consumption.
  *
- * @category GraphQL
+ * @category GraphQL Client
  * @param objectAddress - The Sui object address
  * @param ownedObjectType - Optional type filter for owned objects
  * @returns Promise resolving to owner info and owned objects (JSON format)
@@ -227,7 +227,7 @@ export async function getObjectOwnerAndOwnedObjectsWithJson(
  * This is a specialized query for EVE Frontier assemblies that
  * follows the owner_cap_id to resolve the owning character.
  *
- * @category GraphQL
+ * @category GraphQL Client
  * @param objectAddress - The assembly object address
  * @returns Promise resolving to assembly and character data
  * @internal
@@ -248,7 +248,7 @@ export async function getObjectAndCharacterOwner(objectAddress: string) {
  * Returns only object addresses (lightweight). Use this when you need
  * to find objects and will fetch their details separately.
  *
- * @category GraphQL
+ * @category GraphQL Client
  * @param owner - The owner's Sui address
  * @param objectType - Optional Move type filter (e.g., "0xpkg::module::Type")
  * @returns Promise resolving to list of owned object addresses
@@ -281,7 +281,7 @@ export async function getOwnedObjectsByType(
  * Returns full object data with dynamic fields. Use this when you need
  * all objects from a specific package (e.g., all EVE Frontier objects).
  *
- * @category GraphQL
+ * @category GraphQL Client
  * @param owner - The owner's Sui address
  * @param packageId - The Move package ID to filter by
  * @returns Promise resolving to full object data including dynamic fields
@@ -312,7 +312,7 @@ export async function getOwnedObjectsByPackage(
  * Get all characters owned by a wallet
  * Returns the most recent character owned by the wallet
  *
- * @category GraphQL
+ * @category GraphQL Client
  */
 export async function getWalletCharacters(wallet: string) {
   return executeGraphQLQuery<GetWalletCharactersResponse>(
@@ -328,7 +328,7 @@ export async function getWalletCharacters(wallet: string) {
  * Get all characters owned by a wallet
  * Returns the characters owned by the wallet
  *
- * @category GraphQL
+ * @category GraphQL Client
  */
 export async function getCharacterAndOwnedObjects(wallet: string) {
   return executeGraphQLQuery<GetCharacterAndOwnedObjectsResponse>(
@@ -346,7 +346,7 @@ export async function getCharacterAndOwnedObjects(wallet: string) {
  * Useful for global/singleton objects where there's only one instance
  * of a particular type on-chain.
  *
- * @category GraphQL
+ * @category GraphQL Client
  * @param objectType - The full Move type string
  * @returns Promise resolving to the singleton object address
  *
@@ -372,7 +372,7 @@ export async function getSingletonObjectByType(objectType: string) {
  * a table of key/value entries via dynamic fields. Returns the first object's full
  * response including contents.extract...addressAt.dynamicFields.nodes.
  *
- * @category GraphQL
+ * @category GraphQL Client
  * @param objectType - The full Move type string (e.g. from getEnergyConfigType())
  * @param tableName - The table path for extract (e.g. "assembly_energy", "fuel_efficiency")
  * @returns Promise resolving to the GraphQL response with objects.nodes[0] and dynamicFields.nodes
@@ -402,7 +402,7 @@ export async function getSingletonConfigObjectByType(
  * Use with caution as this may return many results. Supports cursor-based
  * pagination for iterating through large result sets.
  *
- * @category GraphQL
+ * @category GraphQL Client
  * @param objectType - The full Move type string
  * @param options - Pagination options
  * @param options.first - Number of results per page (default: 50)
@@ -442,7 +442,7 @@ export async function getObjectsByType(
  * It fetches the assembly's Move object data, dynamic fields, and
  * resolves the owner character through the ownership chain.
  *
- * @category GraphQL
+ * @category GraphQL Client
  * @param assemblyId - The assembly's Sui object ID
  * @returns Promise resolving to:
  *   - `moveObject` - The assembly's Move object data with JSON contents and dynamic fields

package/graphql/queries.ts

@@ -10,7 +10,7 @@
  * Query for fetching a specific object by address with BCS-encoded contents
  * Use this for low-level object access with raw BCS data
  *
- * @category GraphQL
+ * @category GraphQL Queries
  */
 export const GET_OBJECT_BY_ADDRESS = `
   query GetObjectByAddress($address: SuiAddress!) {
@@ -31,11 +31,9 @@ export const GET_OBJECT_BY_ADDRESS = `
 `;
 
 /**
- * Query for fetching a specific assembly by ID with JSON-decoded contents
- * Retrieves the assembly contents and dynamic fields from the EVE Frontier world package
- * Use this for higher-level object access with parsed JSON data
+ * Object by address with JSON contents and dynamic fields (nodes).
  *
- * @category GraphQL
+ * @category GraphQL Queries
  */
 export const GET_OBJECT_WITH_DYNAMIC_FIELDS = `
   query GetObjectWithDynamicFields($objectId: SuiAddress!) {
@@ -66,11 +64,9 @@ export const GET_OBJECT_WITH_DYNAMIC_FIELDS = `
 `;
 
 /**
- * Query for fetching a specific assembly by ID with JSON-decoded contents
- * Retrieves the assembly contents and dynamic fields from the EVE Frontier world package
- * Use this for higher-level object access with parsed JSON data
+ * Assembly object with owner/character extract and character-owned objects (e.g. inventory).
  *
- * @category GraphQL
+ * @category GraphQL Queries
  */
 export const GET_OBJECT_DYNAMICFIELD_CHARACTER_WITH_JSON = `
 query GetObjectOwnerCharacterOwnerAndInventory(
@@ -168,7 +164,7 @@ query GetObjectOwnerCharacterOwnerAndInventory(
  * Useful for finding related objects (e.g., getting a character's assemblies)
  * Returns BCS-encoded data only
  *
- * @category GraphQL
+ * @category GraphQL Queries
  */
 export const GET_OBJECT_OWNER_AND_OWNED_OBJECTS_BY_TYPE = `
   query GetObjectOwnerAndOwnedObjectByType($object: SuiAddress!, $owned_object_type: String) {
@@ -204,7 +200,7 @@ export const GET_OBJECT_OWNER_AND_OWNED_OBJECTS_BY_TYPE = `
  * Query to get an object's owner and their owned objects of a specific type
  * Returns both BCS and JSON-decoded data for easier consumption
  *
- * @category GraphQL
+ * @category GraphQL Queries
  */
 export const GET_OBJECT_OWNER_AND_OWNED_OBJECTS_WITH_JSON = `
   query GetObjectOwnerAndOwnedObjectWithJson($object: SuiAddress!, $owned_object_type: String) {
@@ -242,7 +238,7 @@ export const GET_OBJECT_OWNER_AND_OWNED_OBJECTS_WITH_JSON = `
  * Query to get full object details with JSON contents
  * Used to fetch character details after getting the character ID from OwnerCap
  *
- * @category GraphQL
+ * @category GraphQL Queries
  */
 export const GET_OBJECT_WITH_JSON = `
   query GetObjectWithJson($address: SuiAddress!) {
@@ -267,7 +263,7 @@ export const GET_OBJECT_WITH_JSON = `
  * Query to get all objects of a specific type owned by an address
  * Returns object addresses only (lightweight)
  *
- * @category GraphQL
+ * @category GraphQL Queries
  */
 export const GET_OWNED_OBJECTS_BY_TYPE = `
   query GetOwnedObjectsByType($owner: SuiAddress!, $object_type: String) {
@@ -289,7 +285,7 @@ export const GET_OWNED_OBJECTS_BY_TYPE = `
  * Query for fetching objects owned by an address filtered by package
  * Returns full object data with dynamic fields
  *
- * @category GraphQL
+ * @category GraphQL Queries
  */
 export const GET_OWNED_OBJECTS_BY_PACKAGE = `
   query GetOwnedObjectsByPackage($owner: SuiAddress!, $packageId: SuiAddress!) {
@@ -336,7 +332,7 @@ export const GET_OWNED_OBJECTS_BY_PACKAGE = `
  * Query to get all characters owned by a wallet
  * Returns the characters owned by the wallet
  *
- * @category GraphQL
+ * @category GraphQL Queries
  */
 export const GET_WALLET_CHARACTERS = `
   query GetWalletCharacters($owner: SuiAddress!, $characterPlayerProfileType: String!) {
@@ -376,7 +372,7 @@ export const GET_WALLET_CHARACTERS = `
  * Query to get character owned by a wallet and objects owned by the character
  * Returns the character and objects owned by the character
  *
- * @category GraphQL
+ * @category GraphQL Queries
  */
 export const GET_CHARACTER_AND_OWNED_OBJECTS = `
 query GetCharacterAndOwnedObjects($owner: SuiAddress!, $characterPlayerProfileType: String!) {
@@ -440,7 +436,7 @@ query GetCharacterAndOwnedObjects($owner: SuiAddress!, $characterPlayerProfileTy
  * Query to get a singleton object by its type
  * Returns the first object of the specified type (useful for global/singleton objects)
  *
- * @category GraphQL
+ * @category GraphQL Queries
  */
 export const GET_SINGLETON_OBJECT_BY_TYPE = `
   query GetSingletonObjectByType($object_type: String) {
@@ -460,7 +456,7 @@ export const GET_SINGLETON_OBJECT_BY_TYPE = `
 /**
  * Query to get a singleton config object by its type
  *
- * @category GraphQL
+ * @category GraphQL Queries
  */
 export const GET_SINGLETON_CONFIG_OBJECT_BY_TYPE = `
   query GetSingletonConfigObjectByType($object_type: String!, $table_name: String!) {
@@ -504,7 +500,7 @@ export const GET_SINGLETON_CONFIG_OBJECT_BY_TYPE = `
  * Query to get all objects of a specific type (global search)
  * Use with caution - may return many results
  *
- * @category GraphQL
+ * @category GraphQL Queries
  */
 export const GET_OBJECTS_BY_TYPE = `
   query GetObjectsByType($object_type: String, $first: Int, $after: String) {

package/graphql/types.ts

@@ -6,13 +6,13 @@
 // Base GraphQL Types
 // ============================================================================
 
-/** @category GraphQL */
+/** Response wrapper for GraphQL with optional `data` and `errors`. @category GraphQL Types */
 export interface GraphQLResponse<T = unknown> {
   data?: T;
   errors?: Array<{ message: string }>;
 }
 
-/** @category GraphQL */
+/** Pagination cursor and has-next flag. @category GraphQL Types */
 export interface PageInfo {
   hasNextPage: boolean;
   endCursor: string | null;
@@ -22,44 +22,44 @@ export interface PageInfo {
 // Shared building blocks (reused across response types)
 // ============================================================================
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface TypeRepr {
   repr: string;
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface TypeReprWithLayout extends TypeRepr {
   layout?: string;
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface ContentsBcs {
   bcs: string;
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface ContentsTypeAndBcs extends ContentsBcs {
   type: TypeRepr;
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface ContentsJsonAndBcs extends ContentsBcs {
   json: Record<string, unknown>;
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface ContentsTypeJsonAndBcs extends ContentsJsonAndBcs {
   type: TypeRepr;
 }
 
 /** Contents with type + json only (no bcs). Reuses ContentsTypeJsonAndBcs shape.
- *  @category GraphQL
+ *  @category GraphQL Types
  */
 export type ContentsTypeAndJson = Pick<ContentsTypeJsonAndBcs, "type" | "json">;
 
 /** Node shape: contents.extract.asAddress.asObject.asMoveObject.contents.
  *  Reusable for any extract-path node whose inner contents are typed as T.
- *  @category GraphQL
+ *  @category GraphQL Types
  */
 export interface ExtractAsMoveObjectNode<T = ContentsTypeAndJson> {
   contents: {
@@ -75,24 +75,24 @@ export interface ExtractAsMoveObjectNode<T = ContentsTypeAndJson> {
   };
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface PreviousTransaction {
   effects?: { timestamp?: string };
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface ObjectNodes<T> {
   nodes: T[];
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface AddressWithObjects<T> {
   address: string;
   objects: ObjectNodes<T>;
 }
 
 /** GraphQL asAddress → asObject → asMoveObject ref chain.
- *  @category GraphQL
+ *  @category GraphQL Types
  */
 export interface AsMoveObjectRef<T> {
   asAddress?: {
@@ -103,14 +103,14 @@ export interface AsMoveObjectRef<T> {
 }
 
 /** Contents with only json (optional payload).
- *  @category GraphQL
+ *  @category GraphQL Types
  */
 export interface ContentsJsonOnly {
   json: Record<string, unknown>;
 }
 
 /** Move object ref whose contents have json of type T.
- *  @category GraphQL
+ *  @category GraphQL Types
  */
 export type MoveObjectRefWithJson<T> = AsMoveObjectRef<{
   contents: { json: T };
@@ -120,14 +120,14 @@ export type MoveObjectRefWithJson<T> = AsMoveObjectRef<{
 // Move Object Types
 // ============================================================================
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface MoveObjectContents {
   json?: Record<string, unknown>;
   bcs?: string;
   type?: TypeReprWithLayout;
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface DynamicFieldNode {
   contents: {
     json: Record<string, unknown>;
@@ -139,7 +139,7 @@ export interface DynamicFieldNode {
   };
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface MoveObjectData {
   contents: MoveObjectContents;
   dynamicFields?: ObjectNodes<DynamicFieldNode>;
@@ -149,7 +149,7 @@ export interface MoveObjectData {
 // Object Response Types
 // ============================================================================
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface SuiObjectResponse {
   address?: string;
   version?: number;
@@ -157,12 +157,12 @@ export interface SuiObjectResponse {
   asMoveObject: MoveObjectData | null;
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface GetObjectResponse {
   object?: SuiObjectResponse;
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface GetObjectByAddressResponse {
   object?: {
     address: string;
@@ -176,41 +176,41 @@ export interface GetObjectByAddressResponse {
 // Owner & Owned Objects Response Types
 // ============================================================================
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface OwnedObjectNode {
   contents: ContentsBcs;
   previousTransaction?: PreviousTransaction;
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface AddressOwner {
   address: AddressWithObjects<OwnedObjectNode>;
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface GetObjectOwnerAndOwnedObjectsResponse {
   object?: { owner?: { address?: AddressOwner["address"] } };
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface OwnedObjectNodeWithJson {
   address: string;
   contents: ContentsJsonAndBcs;
   previousTransaction?: PreviousTransaction;
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface AddressOwnerWithJson {
   address: AddressWithObjects<OwnedObjectNodeWithJson>;
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface GetObjectOwnerAndOwnedObjectsWithJsonResponse {
   object?: { owner?: { address?: AddressOwnerWithJson["address"] } };
 }
 
 /** Node shape for owner's objects in GetObjectAndCharacterOwner (authorizedObj → character).
- *  @category GraphQL
+ *  @category GraphQL Types
  */
 export interface CharacterOwnerNode {
   contents: {
@@ -218,7 +218,7 @@ export interface CharacterOwnerNode {
   };
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface GetObjectAndCharacterOwnerResponse {
   object: {
     asMoveObject: {
@@ -235,7 +235,7 @@ export interface GetObjectAndCharacterOwnerResponse {
   };
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface GetObjectWithJsonResponse {
   object?: {
     address: string;
@@ -249,12 +249,12 @@ export interface GetObjectWithJsonResponse {
 // GetOwnedObjectsByType Response Types
 // ============================================================================
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface OwnedObjectAddressNode {
   address: string;
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface GetOwnedObjectsByTypeResponse {
   address?: { objects: ObjectNodes<OwnedObjectAddressNode> };
 }
@@ -263,24 +263,24 @@ export interface GetOwnedObjectsByTypeResponse {
 // GetOwnedObjectsByPackage Response Types
 // ============================================================================
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface OwnedObjectFullNode {
   address: string;
   version: number;
   asMoveObject: MoveObjectData | null;
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface GetOwnedObjectsByPackageResponse {
   objects: ObjectNodes<OwnedObjectFullNode>;
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface GetWalletCharactersResponse {
   address: AddressWithObjects<ExtractAsMoveObjectNode>;
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface CharacterAndOwnedObjectsNode {
   contents: {
     extract: {
@@ -296,7 +296,7 @@ export interface CharacterAndOwnedObjectsNode {
   };
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface GetCharacterAndOwnedObjectsResponse {
   address: AddressWithObjects<CharacterAndOwnedObjectsNode>;
 }
@@ -305,18 +305,18 @@ export interface GetCharacterAndOwnedObjectsResponse {
 // Singleton & Type-based Query Response Types
 // ============================================================================
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface GetSingletonObjectByTypeResponse {
   objects: ObjectNodes<OwnedObjectAddressNode>;
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface ConfigExtractDynamicFieldNode {
   key: { json: string };
   value: { json: string };
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface GetSingletonConfigObjectByTypeResponse {
   objects: {
     nodes: Array<{
@@ -341,7 +341,7 @@ export interface GetSingletonConfigObjectByTypeResponse {
   };
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface ObjectWithContentsNode {
   address: string;
   version: number;
@@ -350,7 +350,7 @@ export interface ObjectWithContentsNode {
   } | null;
 }
 
-/** @category GraphQL */
+/** @category GraphQL Types */
 export interface GetObjectsByTypeResponse {
   objects: ObjectNodes<ObjectWithContentsNode> & { pageInfo: PageInfo };
 }
@@ -362,7 +362,7 @@ export interface GetObjectsByTypeResponse {
 /**
  * Raw Sui object data structure returned from the EVE Frontier package
  *
- * @category GraphQL
+ * @category GraphQL Types
  */
 export interface RawSuiObjectData {
   id: string;
@@ -422,7 +422,7 @@ export interface RawSuiObjectData {
  * OwnerCap JSON structure - returned from Character OwnerCap query
  * Contains the authorized_object_id which is the Character ID
  *
- * @category GraphQL
+ * @category GraphQL Types
  */
 export interface OwnerCapData {
   authorized_object_id: string;
@@ -432,7 +432,7 @@ export interface OwnerCapData {
 /**
  * Raw Character data structure from the EVE Frontier package
  *
- * @category GraphQL
+ * @category GraphQL Types
  */
 export interface RawCharacterData {
   id: `0x${string}`;
@@ -456,7 +456,7 @@ export interface RawCharacterData {
 /**
  * Processed character/owner information
  *
- * @category GraphQL
+ * @category GraphQL Types
  */
 export interface CharacterInfo {
   id: string;

package/hooks/useConnection.ts

@@ -9,7 +9,7 @@ import { VaultContextType } from "../types";
  * and methods to connect/disconnect wallets. Automatically detects EVE Vault
  * wallet availability.
  *
- * @category Hooks
+ * @category Hooks - Connection
  * @returns Object containing wallet state and connection methods:
  *   - `currentAccount` - The currently connected wallet account (or null)
  *   - `walletAddress` - The connected wallet's address string

package/hooks/useNotification.ts

@@ -9,7 +9,7 @@ import { NotificationContextType } from "../types";
  * and info messages to users. Commonly used after transaction completions
  * or to display important status updates.
  *
- * @category Hooks
+ * @category Hooks - Notification
  * @returns Object containing notification state and methods:
  *   - `notify` - Function to trigger a notification
  *   - `notification` - Current notification state object with:

package/hooks/useSmartObject.ts

@@ -10,7 +10,7 @@ import { SmartObjectContextType } from "../types";
  * The assembly ID is determined from URL query parameters (`?itemId=` and `?tenant=`)
  * or environment variables as a Sui object ID (`VITE_OBJECT_ID`).
  *
- * @category Hooks
+ * @category Hooks - Smart Object
  * @returns Object containing assembly state and methods:
  *   - `assembly` - The transformed assembly data (or null if not loaded)
  *   - `character` - The owner character information (or null)