@qvac/registry-client 0.3.0 → 0.4.0

package/README.md

@@ -139,11 +139,9 @@ The package includes a CLI for querying and downloading models from the registry
 
 ### Install
 
-The package is hosted on npm. Configure npm to use the registry for the `@qvac` scope, then install globally:
+The package is hosted on npm. Install globally:
 
 ```bash
-echo "@qvac:registry=https://registry.npmjs.org" >> ~/.npmrc
-echo "//registry.npmjs.org/:_authToken=YOUR_NPM_TOKEN" >> ~/.npmrc
 npm install -g @qvac/registry-client
 ```
 

package/index.d.ts

@@ -1,3 +1,9 @@
+import ReadyResource = require('ready-resource')
+
+export interface LifecycleLogOptions {
+  log?: (msg: string) => Promise<void> | void
+}
+
 export interface QVACBlobBinding {
   coreKey: Buffer | string
   blockOffset: number
@@ -41,6 +47,8 @@ export interface QVACDownloadOptions {
   timeout?: number
   peerTimeout?: number
   outputFile?: string
+  onProgress?: (progress: { downloaded: number, total: number, cachedBlocks: number, totalBlocks: number }) => void
+  signal?: AbortSignal
 }
 
 export interface QVACBlobDownloadOptions {
@@ -78,11 +86,29 @@ export interface FindByParams {
   includeDeprecated?: boolean
 }
 
-export class QVACRegistryClient {
+export interface LifecycleSwarmHandle {
+  readonly suspended: boolean
+  suspend (opts?: LifecycleLogOptions): Promise<void>
+  resume (opts?: LifecycleLogOptions): Promise<void>
+}
+
+export interface LifecycleStoreHandle {
+  suspend (opts?: LifecycleLogOptions): Promise<void>
+  resume (): Promise<void>
+}
+
+export class QVACRegistryClient extends ReadyResource {
   constructor (opts?: QVACRegistryClientOptions)
 
+  /** Valid only while the client remains open. Cached handles become stale after close(). */
+  readonly corestore: LifecycleStoreHandle | null
+  /** Valid only while the client remains open. Cached handles become stale after close(). */
+  readonly hyperswarm: LifecycleSwarmHandle | null
+
   ready (): Promise<void>
   close (): Promise<void>
+  suspend (opts?: LifecycleLogOptions): Promise<void>
+  resume (opts?: LifecycleLogOptions): Promise<void>
 
   getModel (path: string, source: string): Promise<QVACModelEntry | null>
   downloadModel (path: string, source: string, options?: QVACDownloadOptions): Promise<QVACDownloadResult>

package/lib/client.js

@@ -526,6 +526,42 @@ class QVACRegistryClient extends ReadyResource {
     }
   }
 
+  async suspend (opts = {}) {
+    this.logger.debug('suspend called')
+
+    if (!this.opened || this.closing) {
+      this.logger.debug('Skipping suspend while client is not open or is closing')
+      return
+    }
+
+    if (this.hyperswarm && !this.hyperswarm.suspended) {
+      await this.hyperswarm.suspend(opts)
+    }
+    if (this.corestore) {
+      await this.corestore.suspend(opts)
+    }
+
+    this.logger.debug('QVACRegistryClient suspended')
+  }
+
+  async resume (opts = {}) {
+    this.logger.debug('resume called')
+
+    if (!this.opened || this.closing) {
+      this.logger.debug('Skipping resume while client is not open or is closing')
+      return
+    }
+
+    if (this.corestore) {
+      await this.corestore.resume()
+    }
+    if (this.hyperswarm && this.hyperswarm.suspended) {
+      await this.hyperswarm.resume(opts)
+    }
+
+    this.logger.debug('QVACRegistryClient resumed')
+  }
+
   async _close () {
     this.logger.debug('_close called')
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qvac/registry-client",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "QVAC Registry client library for read-only queries via Hyperswarm",
   "license": "Apache-2.0",
   "repository": {
@@ -53,7 +53,7 @@
   },
   "dependencies": {
     "@qvac/error": "^0.1.0",
-    "@qvac/registry-schema": "^0.1.1",
+    "@qvac/registry-schema": "^0.1.2",
     "b4a": "^1.6.7",
     "bare-fs": "^4.5.2",
     "bare-os": "^3.6.2",
@@ -62,8 +62,8 @@
     "corestore": "^7.4.5",
     "hyperblobs": "^2.8.0",
     "hypercore-id-encoding": "^1.3.0",
-    "hyperdb": "^4.16.1",
     "hypercore-stats": "^2.4.0",
+    "hyperdb": "^4.16.1",
     "hyperswarm": "^4.14.0",
     "hyperswarm-stats": "^1.3.0",
     "paparam": "^1.10.0",