public re-exports

sodazone · Jul 3, 2024 · b9beb3b · b9beb3b
1 parent 23b5c07
commit b9beb3b
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 1 deletion.
diff --git a/packages/client/src/server-types.ts b/packages/client/src/server-types.ts
@@ -9,5 +9,6 @@ export type {
   QueryResult,
   QueryPagination,
   AnyQueryArgs,
+  NetworkURN,
   AnyQueryResultItem,
 } from '@sodazone/ocelloids-service-node'
diff --git a/packages/server/src/lib.ts b/packages/server/src/lib.ts
@@ -7,7 +7,7 @@ export type {
   SignerData,
   SubscriptionId,
 } from './services/subscriptions/types.js'
-export type { AnyJson } from './services/types.js'
+export type { AnyJson, NetworkURN } from './services/types.js'
 export type {
   AgentId,
   QueryParams,

diff --git a/packages/server/src/services/agents/types.ts b/packages/server/src/services/agents/types.ts
@@ -196,18 +196,45 @@ export interface Subscribable {
   update(subscriptionId: string, patch: Operation[]): Promise<Subscription> | Subscription
 }
 
+/**
+ * Generic query arguments.
+ *
+ * @public
+ */
 export type AnyQueryArgs = Record<string, any>
+
+/**
+ * Generic query result item.
+ *
+ * @public
+ */
 export type AnyQueryResultItem = Record<string, any>
+
+/**
+ * Query pagination options.
+ *
+ * @public
+ */
 export type QueryPagination = {
   cursor?: string
   limit?: number
 }
 
+/**
+ * The query parameters.
+ *
+ * @public
+ */
 export type QueryParams<T = AnyQueryArgs> = {
   args: T
   pagination?: QueryPagination
 }
 
+/**
+ * The query result.
+ *
+ * @public
+ */
 export type QueryResult<T = AnyQueryResultItem> = {
   items: T[]
   pageInfo?: {

diff --git a/packages/server/src/services/types.ts b/packages/server/src/services/types.ts
@@ -11,6 +11,11 @@ import { Scheduler } from './persistence/scheduler.js'
 import { SubsStore } from './persistence/subs.js'
 import { BlockNumberRange, HexString } from './subscriptions/types.js'
 
+/**
+ * The network URN.
+ *
+ * @public
+ */
 export type NetworkURN = `urn:ocn:${string}`
 
 export type DB<F = Buffer | Uint8Array | string, K = string, V = any> = AbstractLevel<F, K, V>