@hearthscale/app 0.2.3 → 0.2.4

package/dist/index.d.ts

@@ -16,9 +16,10 @@ interface ModelIdentity {
  *  items of an array, names a file by its asset id on the app's side,
  *  `contentMediaType` saying what it takes, and its `description` the
  *  limits the model sets on it; it reaches the Server as a `RenderUpload`
- *  in the same place. A property's `default` is what the model's saved
- *  settings give a job that leaves it out, as an image model's picture
- *  size, steps and guidance. */
+ *  in the same place. A property of `"format": "model"` names another
+ *  model of the same Server by its card id; it reaches the Server as that
+ *  model's id. A property's `default` is what the model's saved settings
+ *  give a job that leaves it out. */
 interface JobSpec {
     input: Record<string, unknown>;
 }
@@ -86,6 +87,26 @@ interface CompanionOption {
     path: string;
     sizeBytes: number;
     verifiable: boolean;
+    installed?: {
+        modelId: string;
+        path: string;
+        source: {
+            type: string;
+            repo: string;
+            revision: string;
+        };
+        sha256: string;
+        sizeBytes: number;
+    };
+    containsVision?: boolean;
+}
+/** A companion role of a candidate and the files that fill it. */
+interface CompanionRole {
+    role: string;
+    label: string;
+    options: CompanionOption[];
+    /** A gated base or encoder repository whose files this caller cannot read. */
+    gated?: string;
 }
 /** One file of a repository a pull can name: the whole shard set where it
  *  is a numbered shard, with the weights' projector beside it where the
@@ -110,23 +131,14 @@ interface HubCandidate {
         label: string;
         path: string;
     }[];
-    /** The companion roles the repository does not supply; a pull names a
-     *  file for each, found in the model's family, the first unless the
-     *  person chooses another. */
-    requires: {
-        role: string;
-        label: string;
-        options: CompanionOption[];
-    }[];
+    /** Companion roles whose files the pull selects from compatible installed
+     *  components, the model's family or the encoder's own releases. */
+    requires: CompanionRole[];
     /** The companion roles the model loads where a pull names a file for
-     *  them, which the repository does not supply: `llm_vision`, the vision
+     *  them: `llm_vision`, the vision
      *  part of a language model encoder, for a family that reads reference
      *  pictures through it. */
-    offers: {
-        role: string;
-        label: string;
-        options: CompanionOption[];
-    }[];
+    offers: CompanionRole[];
     /** Whether the repository holds vision projectors beside the file. */
     projector: boolean;
     /** The projectors to choose from where there is more than one, each
@@ -140,6 +152,8 @@ interface HubCandidate {
     /** The task the model serves, as `CatalogRole` names it. */
     role: string;
     format: string;
+    /** For an adapter: model ids from a Server, card ids from the platform. */
+    fits?: string[];
     /** Why the file cannot be pulled, in the Server's words. */
     reason?: string;
 }
@@ -544,9 +558,11 @@ type SourceKind = 'app' | 'connector';
 type ToolOutcome = 'completed' | 'failed' | 'cancelled' | 'skipped' | 'unknown';
 type Decision = 'run' | 'refused';
 /**
- * Who or what let a call run, or refused it.
+ * Who or what let a call run, or refused it. A call whose arguments name
+ * no path the tool takes is refused by its path, in words that say how to
+ * name one.
  */
-type DecisionBy = 'level' | 'silent' | 'grant' | 'fence' | 'judge' | 'review' | 'person' | 'floor';
+type DecisionBy = 'level' | 'silent' | 'grant' | 'fence' | 'judge' | 'review' | 'person' | 'floor' | 'path';
 type Risk = 'low' | 'high' | 'too_destructive';
 type Authorisation = 'explicitly_no' | 'neutral' | 'explicitly_yes';
 /**
@@ -1038,15 +1054,10 @@ type ProviderStatus = ('ready' | 'unreachable' | 'unauthenticated' | 'error') |
  */
 type CompletionOption = 'logprobs' | 'topLogprobs' | 'topK' | 'minP' | 'grammar' | 'stop' | 'seed';
 /**
- * The kinds of model an app's Discover search lists, each a task word of
- * the inference contract's `HubTask` whose models answer an app's
- * requests: chat models in GGUF, one word for each kind of media and
- * vector model a runtime of the Server installs from Hugging Face, and
- * every format a runtime of the Server reads. Draft weights, which load
- * only beside another model, are none of them, and an upscaler, which the
- * Server takes from its catalogue alone, has no word.
+ * The kinds of model an app's Discover search lists, each a `HubTask` word
+ * of the inference contract. Draft weights and upscalers have none.
  */
-type DiscoverTask = 'text' | 'image' | 'transcription' | 'diarization' | 'separation' | 'speech' | 'music' | 'embedding' | 'rerank' | 'all';
+type DiscoverTask = 'text' | 'image' | 'transcription' | 'diarization' | 'separation' | 'speech' | 'music' | 'embedding' | 'rerank' | 'adapter' | 'all';
 /**
  * What an app asks to install on a Hearthscale Server: a card a Server
  * lists and does not hold, by its id, or a file of a Hugging Face
@@ -2045,6 +2056,19 @@ interface HubCompanion {
     role: string;
     repo: string;
     file: string;
+    installed?: InstalledCompanion;
+}
+interface InstalledCompanion {
+    modelId: string;
+    path: string;
+    source: InstalledCompanionSource;
+    sha256: string;
+    sizeBytes: number;
+}
+interface InstalledCompanionSource {
+    type: string;
+    repo: string;
+    revision: string;
 }
 /**
  * A right-click entry of the app's rail button: a call of one of the
@@ -2241,6 +2265,14 @@ interface ModelCard {
      * Server reports it.
      */
     progress?: DownloadProgressBytes;
+    /**
+     * For an adapter whose Server states them, the cards of the models it fits.
+     */
+    fits?: string[];
+    /**
+     * For an adapter whose Server states them, its prompt trigger words.
+     */
+    triggers?: string[];
 }
 /**
  * A Hearthscale Server this computer names, as `ctx.models.servers` and
@@ -3620,6 +3652,14 @@ interface ViewHostMethods {
         params: Empty;
         result: Empty;
     };
+    /** Opens the Server's window at Explore, at the models of `kind`, on a
+     *  click inside the view. A kind that no Explore task lists is refused. */
+    'hearthscale/ui/open-explore': {
+        params: {
+            kind: ModelKind;
+        };
+        result: Empty;
+    };
     /** Keeps a JSON value for this view's tab, which the host gives back in
      *  `hearthscale/widgetState`; it never reaches a model. The value takes
      *  at most 65,536 UTF-16 code units as JSON text. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hearthscale/app",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "The types a Hearthscale app's backend and views import: the backend's exports and context, the view's host methods, extensions and slots; and the typed call of a view's requests.",
   "license": "MIT",
   "type": "module",
@@ -39,7 +39,7 @@
     "rollup": "^4.62.2",
     "rollup-plugin-dts": "^6.5.1",
     "typescript": "^5.6.3",
-    "@hearthscale/contract": "0.1.0"
+    "@hearthscale/contract": "0.2.3"
   },
   "scripts": {
     "build": "node scripts/build.mjs",