@protoboardai/cloud 0.0.0-stage → 0.2.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,13 @@
+Protoboard Stack: @protoboardai/cloud
+Copyright 2026 Delta Robotics, Inc.
+
+This product includes software developed at Delta Robotics, Inc.
+(https://deltaroboticsinc.com).
+
+Licensed under the Apache License, Version 2.0 (the "License").
+See the LICENSE file in this package for full terms.
+
+"Protoboard", the Protoboard logo and the "0" mark are trademarks of
+Delta Robotics, Inc. The License grants no rights to them (section 6);
+see TRADEMARKS.md in the Protoboard Stack repository
+(https://github.com/Delta-Robotics-Inc/protoboard-stack).

package/README.md

@@ -1,3 +1,40 @@
-# Temporary Holding Version
+# @protoboardai/cloud
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The typed client of the Protoboard parts service (API v1), and of any other
+`uhd-library/v1` library. Apache-2.0 (`LICENSE`, `NOTICE`).
+
+Everything it downloads is verified before it is returned: an envelope
+against its digest and its definition digest, a file against its sha256.
+Node 22.13 or later; no dependencies (global `fetch`, `node:crypto`,
+`node:fs`). The package ships its TypeScript sources; Protoboard runs them
+through tsx.
+
+| Module | What |
+| --- | --- |
+| `src/client.ts` | `PartsClient` (`@protoboardai/cloud/client`), with the envelope helpers re-exported. |
+| `src/envelope.ts` | The `protoboard.part-revision/v1` envelope (`@protoboardai/cloud/envelope`): types, canonical JSON, digests, validation. Pure. |
+| `src/api.ts` | Request and response types of API v1. |
+| `src/taxonomy.ts` | The category taxonomy as the service serves it: ancestors, tree with counts, shape checks. Pure. |
+| `src/kits.ts` | The service's kit manifests (`x-kits`): types and shape checks. Pure. |
+
+```ts
+import { PartsClient, vendoredDefinition } from "@protoboardai/cloud/client";
+
+const cloud = new PartsClient({ baseUrl: process.env.PROTOBOARD_CLOUD_URL ?? "http://localhost:8787" });
+const { parts } = await cloud.search({ q: "2207 motor", domain: "mechanical" });
+const { revisions } = await cloud.getClosure(parts[0].partId, parts[0].recommendedRevision!); // verified, dependencies first
+for (const env of revisions) writeFileSync(`parts/catalog/${env.partId}.json`, vendoredDefinition(env));
+```
+
+With `discover: true` the client finds a library's API root from its
+`/.well-known/uhd-library` document.
+
+## The service
+
+This package is the client only. The parts service it talks to is hosted
+by Protoboard; any other server that speaks `uhd-library/v1` works with it
+too (`discover: true`).
+
+The package is `"private": true` in this repository, so a plain `npm
+publish` refuses it; `scripts/registry/publish-stack.mjs` publishes a staged
+copy with the rest of the stack.

package/package.json

@@ -1,6 +1,45 @@
 {
   "name": "@protoboardai/cloud",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.1",
+  "description": "Client for the Protoboard parts library: search, part revisions and verified downloads.",
+  "license": "Apache-2.0",
+  "author": "Delta Robotics, Inc.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Delta-Robotics-Inc/protoboard-stack.git",
+    "directory": "packages/cloud"
+  },
+  "type": "module",
+  "engines": {
+    "node": ">=22.13"
+  },
+  "exports": {
+    ".": "./src/client.ts",
+    "./client": "./src/client.ts",
+    "./envelope": "./src/envelope.ts"
+  },
+  "files": [
+    "src/client.ts",
+    "src/api.ts",
+    "src/envelope.ts",
+    "src/taxonomy.ts",
+    "src/kits.ts",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "protoboard",
+    "hardware",
+    "parts",
+    "library",
+    "client"
+  ],
+  "homepage": "https://protoboard.ai",
+  "bugs": {
+    "url": "https://github.com/Delta-Robotics-Inc/protoboard-stack/issues"
+  }
+}

package/src/api.ts

@@ -0,0 +1,351 @@
+/**
+ * Response and request shapes of the parts API v1, shared by the server and
+ * the client: types, and the few constant lists both sides check against.
+ */
+import type { PartRef, PartRevisionEnvelope } from "./envelope.js";
+import type { TaxonomyTreeNode } from "./taxonomy.js";
+
+export type { TaxonomyTreeNode, ServiceTaxonomyDocument } from "./taxonomy.js";
+
+export interface Deprecation {
+  reason: string;
+  at: string;
+  replacedBy?: PartRef;
+}
+
+export interface RevisionRow {
+  partId: string;
+  revision: number;
+  digest: string;
+  definitionDigest: string;
+  uhdSchema: string;
+  createdAt: string;
+  publisher: string;
+  deprecated?: Deprecation;
+  /**
+   * Service extra: whether this revision and every dependency it pins can
+   * be given out (every file backing a definition artifact is
+   * redistributable, UHD library protocol § 4.5).
+   */
+  redistributable?: boolean;
+}
+
+/**
+ * Which files a request may see. `all` (the default) is the team's view:
+ * every file whatever its terms. `redistributable` serves only parts whose
+ * revision is redistributable, and only files whose terms say
+ * `redistributable`: the view under `/distributable/v1`, or `?distribution=redistributable` on `/v1`.
+ */
+export type DistributionScope = "all" | "redistributable";
+
+/** A file by content address (`GET /v1/blobs/:sha256`). */
+export interface BlobRef {
+  sha256: string;
+  size: number;
+  mediaType: string;
+}
+
+export interface PartSummary {
+  partId: string;
+  name: string;
+  description?: string;
+  manufacturer?: string;
+  partNumber?: string;
+  /** Taxonomy paths the definition lists (`ModuleDef.categories`), in its order. */
+  categories: string[];
+  /** Free-form tags and the category paths, merged (as the library manifest's `taxonomy`). */
+  tags: string[];
+  protocols: string[];
+  domains: string[];
+  /** Highest revision. */
+  latestRevision: number;
+  /** Highest revision that is not deprecated (absent when all are). */
+  recommendedRevision?: number;
+  deprecated?: Deprecation;
+  /** The recommended revision's thumbnail file, when it carries one. */
+  thumbnail?: BlobRef;
+  /**
+   * Service extra (capability `x-sort`): the part's relevance in this library,
+   * 0 and up, higher first. A library-side value about the part (a seed the
+   * library's owners set, plus recent use; docs/relevance.md), never part of
+   * a revision or its digest. Absent from libraries that do not rank.
+   */
+  relevance?: number;
+}
+
+/** The orders `GET /v1/parts` takes in `sort` (capability `x-sort`; docs/relevance.md). */
+export const SEARCH_SORTS = ["relevance", "name", "manufacturer", "updated"] as const;
+export type SearchSort = (typeof SEARCH_SORTS)[number];
+
+/** One price break: the unit price from `quantity` pieces up, in the offer's currency. */
+export interface OfferPriceBreak {
+  quantity: number;
+  unitPrice: number;
+}
+
+/**
+ * A supplier offer: commercial data about a part, kept apart from its
+ * technical facts. An offer is for one ordering code (`mpn`): a series part
+ * (one catalog part per manufacturer series, e.g. a resistor family) is
+ * placed at many values, each its own MPN, and each is priced only by offers
+ * for that MPN.
+ *
+ * Prices are per piece of the part. A pack sold as one item is stated per
+ * piece, with the pack in `packaging` and `minQuantity`.
+ */
+export interface Offer {
+  id?: number;
+  partId: string;
+  /** The ordering code this offer is for, as the manufacturer states it (packaging suffix included). Offers stored before MPNs were required carry the part's own `part_number`. */
+  mpn: string;
+  supplier: string;
+  /** The supplier's own code for the item. */
+  sku?: string;
+  url?: string;
+  /** Price per piece at the first break (`minQuantity`, else 1): what a client that reads one price quotes. */
+  unitPrice?: number;
+  /** ISO 4217. Prices are never converted. */
+  currency?: string;
+  /** Every price break shown, ascending by quantity; the first one's price is `unitPrice`. */
+  priceBreaks?: OfferPriceBreak[];
+  /** Minimum order quantity, in pieces. */
+  minQuantity?: number;
+  /** Pieces in stock at the supplier when observed; 0 when it showed none. */
+  stock?: number;
+  /** Lead time the supplier states, in weeks. */
+  leadTimeWeeks?: number;
+  /** Packaging or sale unit as listed: "Tape & Reel", "pack of 10". */
+  packaging?: string;
+  /** Storefront or market: "US", "DE", "CN". */
+  market?: string;
+  /** A franchised distributor or the manufacturer's own store; absent when not known. */
+  authorized?: boolean;
+  /** INTERNAL, publishers only: what the observer wrote down about the listing and how it was read. Never served to users. */
+  note?: string;
+  /** When the offer was observed at the supplier (when the price was fetched). */
+  observedAt: string;
+  /**
+   * INTERNAL, publishers only: where the observation came from (a URL, a quote
+   * reference; "protopart-import" for prices carried over from ProtoPart).
+   * Required when an offer is recorded; never served to users (`PUBLIC_OFFER_FIELDS`).
+   */
+  source?: string;
+  /** The observation is too old, or the product discontinued, to quote as a current price: history, not a quote. Absent means not known to be stale. */
+  stale?: boolean;
+}
+
+/**
+ * The members of an offer a user is served (`GET /v1/parts/:id/offers`): the
+ * result of pricing, by source. Everything else an offer record holds
+ * (`source`, `note`: how and where the price was read) stays in the service
+ * and is given only to a publisher who asks for the internal view. A new
+ * member is internal until it is added here; test/offers-public.test.ts pins
+ * the list.
+ */
+export const PUBLIC_OFFER_FIELDS = [
+  "id",
+  "partId",
+  "mpn",
+  "supplier",
+  "sku",
+  "url",
+  "unitPrice",
+  "currency",
+  "priceBreaks",
+  "minQuantity",
+  "stock",
+  "leadTimeWeeks",
+  "packaging",
+  "market",
+  "authorized",
+  "observedAt",
+  "stale",
+] as const;
+/** An offer as users see it. */
+export type PublicOffer = Pick<Offer, (typeof PUBLIC_OFFER_FIELDS)[number]>;
+
+export interface SearchQuery {
+  q?: string;
+  /** Taxonomy path: parts with a category at it or below it. */
+  taxonomy?: string;
+  domain?: string;
+  protocol?: string;
+  tag?: string;
+  /** The same filter as `taxonomy` (this service's name for it before the protocol); `taxonomy` wins when both are given. */
+  category?: string;
+  includeDeprecated?: boolean;
+  limit?: number;
+  /** `nextCursor` of the previous page. */
+  cursor?: string;
+  /** Before cursors; still accepted. */
+  offset?: number;
+  /** Return facet counts. */
+  facets?: boolean;
+  /** `redistributable`: only parts whose recommended revision is redistributable (`DistributionScope`). */
+  distribution?: "redistributable";
+  /**
+   * The order of the results (capability `x-sort`, this library's extension):
+   * `relevance` (the default: with search words, the closeness of the text
+   * match first and relevance within it), `name`, `manufacturer` or `updated`
+   * (newest revision first). Ties end on the part id, so every order is
+   * stable. A library without the capability ignores it.
+   */
+  sort?: SearchSort;
+}
+
+/** Counts of matching parts per value, over every page; taxonomy counts each path and every ancestor. */
+export interface SearchFacets {
+  taxonomy: Record<string, number>;
+  domain: Record<string, number>;
+  protocol: Record<string, number>;
+  tag: Record<string, number>;
+  /**
+   * Service extra (not part of the protocol): parts per taxonomy path (each
+   * part counted once at every ancestor of its categories), over every filter
+   * of the query except the taxonomy filter, so a drill-down shows the counts
+   * of siblings and children alike.
+   */
+  categories: Record<string, number>;
+}
+
+/** `GET /v1/parts`: the uhd-library/v1 search response. */
+export interface SearchResult {
+  total: number;
+  parts: PartSummary[];
+  /** Pass as `cursor` for the next page; null on the last. */
+  nextCursor: string | null;
+  facets?: SearchFacets;
+}
+
+/** `GET /.well-known/uhd-library` and `GET /v1`: the uhd-library/v1 discovery document, plus the service's counts. */
+export interface Discovery {
+  protocol: "uhd-library/v1";
+  name: string;
+  id: string;
+  description?: string;
+  version: string;
+  api: string;
+  envelopeSchemas: string[];
+  uhdSchema: { min: string; below: string };
+  /** `id` is a service extra: the taxonomy's id ("uhd"). */
+  taxonomy: { id?: string; version: string; namespaces?: string[] } | null;
+  capabilities: string[];
+  auth: { read: "none" } | { read: "bearer"; realm?: string; documentation?: string };
+  limits: { defaultPageSize: number; maxPageSize: number };
+  /** Service extras (not part of the protocol). */
+  service: string;
+  publishing: boolean;
+  /** The scope this document describes; on the team's view, where the redistributable view lives. */
+  distribution: DistributionScope;
+  views?: { redistributable: string };
+  /** With capability `x-sort`: the values `sort` takes in a search, and the order without it. */
+  sort?: { values: SearchSort[]; default: SearchSort };
+  /**
+   * How to sign in, when the service authenticates users (PB-911). From
+   * 0.2.0 (PB-928) every read of the library needs a signed-in user:
+   * `required` lists them (search, taxonomy, parts, revisions, files, kits,
+   * offers, downloads), and `auth.read` is `bearer`. Firebase details are
+   * identifiers for clients, never secrets.
+   */
+  account?: {
+    required: string[];
+    provider: "firebase";
+    projectId?: string;
+    apiKey?: string;
+    signInUrl?: string;
+    deviceUrl?: string;
+    emulator?: string;
+  };
+  /** The library's counts: left out for a request that is not signed in, when the service authenticates users. */
+  parts?: number;
+  revisions?: number;
+  blobs?: number;
+  blobBytes?: number;
+}
+
+/** `GET /v1/taxonomy`: the taxonomy the service uses, with part counts. */
+export interface TaxonomyResult {
+  taxonomy: {
+    id: string;
+    version: string;
+    extensions: { library: string; root: string; taxonomyVersion: string }[];
+    /** When it was given to the service. */
+    setAt: string;
+  };
+  /** Parts counted (the query's filters apply, the taxonomy filter excepted). */
+  total: number;
+  /** Of those, parts with no category. */
+  uncategorised: number;
+  nodes: TaxonomyTreeNode[];
+  /** Category paths parts list that the taxonomy does not have, with their part counts. */
+  unknown: { path: string; count: number }[];
+}
+
+/** `GET /v1/parts/:partId/revisions/:revision/closure`. */
+export interface Closure {
+  root: PartRef;
+  /** The root and every transitive dependency, each at its pinned revision; dependencies first. */
+  revisions: PartRevisionEnvelope[];
+  /** Parts reached at more than one revision (a project can hold only one). */
+  conflicts: { partId: string; revisions: number[] }[];
+}
+
+/** Every error response: `{ error: ApiError }`. */
+export interface ApiError {
+  code: string;
+  message: string;
+  [detail: string]: unknown;
+}
+
+/** A part's relevance seed: the value the library's owners gave it (library/relevance.json), with the reason. */
+export interface RelevanceSeed {
+  partId: string;
+  seed: number;
+  reason?: string;
+  setAt?: string;
+}
+
+/** `PUT /v1/relevance`: every seed, as `{ <partId>: { seed, reason? } }`; a part left out is cleared to 0. */
+export type RelevanceSeeds = Record<string, { seed: number; reason?: string }>;
+
+export interface RelevanceSeedsResult {
+  /** Seeds written (new, or a changed value or reason). */
+  set: number;
+  unchanged: number;
+  /** Parts that had a seed and are not in the body: now 0. */
+  cleared: number;
+  /** Seeded part ids the catalog does not hold (kept: they apply when the part is published). */
+  unknown: string[];
+}
+
+/** What a recorded download is counted as: a revision asked for by itself, or one pulled in as a pinned dependency of another. */
+export type UsageKind = "revision" | "dependency";
+
+/** One part in `GET /v1/usage` (publishers only). */
+export interface UsageRow {
+  partId: string;
+  name?: string;
+  /** Requests for the full revision in the period, every one counted: adds, and looks (a detail page, an update check). */
+  downloads: number;
+  /** Closure downloads (`parts add`, an applied `parts update`, the VS Code add), once per account, part revision and day: what informs relevance. */
+  adds: number;
+  /** The same two numbers for the revisions downloaded, by revision. */
+  revisions: Record<string, { downloads: number; adds: number }>;
+  /** Times the part came along as a pinned dependency of another (once per account, revision and day). */
+  asDependency: number;
+  seed: number;
+  relevance: number;
+}
+
+/** `GET /v1/usage`: the most added parts over a period (publishers only). */
+export interface UsageReport {
+  /** First and last day counted (UTC, `YYYY-MM-DD`), inclusive. */
+  from: string;
+  to: string;
+  days: number;
+  totals: { downloads: number; adds: number; parts: number };
+  /** By adds, then downloads, then part id. */
+  parts: UsageRow[];
+  /** Adds per day over the period, days without any left out. */
+  daily: { day: string; downloads: number; adds: number }[];
+}