@foss.global/codefeed 5.4.0 → 5.6.0

package/dist_ts/classes.giteasourceinventory.d.ts

@@ -43,13 +43,16 @@ export interface IGiteaSourceInventoryOptions {
     packageTransferTimeoutMs?: number;
 }
 /** A class of source data a run measures only when its discovery selects it. */
-export type TGiteaSourceInventoryClass = 'packages';
+export type TGiteaSourceInventoryClass = 'packages' | 'collaboration';
 export interface IGiteaSourceDiscoveryOptions {
     /**
      * Classes beside the instance, owners and repositories to list for
      * measurement. `packages` lists every package, so `units` measures one unit
      * per package; without it, discovery carries no `packages` and the package
-     * class is unread.
+     * class is unread. `collaboration` sets discovery's `collaboration: true`,
+     * so `units` measures one collaboration unit per repository, and the
+     * composed inventory carries the records and every organization's
+     * `labelRecords`; without it, collaboration records are unread.
      */
     classes?: readonly TGiteaSourceInventoryClass[];
 }
@@ -90,17 +93,21 @@ export declare class GiteaSourceInventory {
     get metrics(): IForgeRequestMetrics;
     /**
      * Identifies the source and its reader and lists every owner and repository
-     * with its id, and with `classes: ['packages']` every package from the
-     * administrator package listing (`packages`, absent otherwise). Rejects
-     * unless the token belongs to a site administrator, and rejects an unknown
-     * class with `invalid-options`; a listing that does not finish, or that
-     * lists a repository id twice, is reported in `incompleteReasons`.
+     * with its id, with `classes: ['packages']` every package from the
+     * administrator package listing (`packages`, absent otherwise), and with
+     * `classes: ['collaboration']` sets `collaboration: true`. Rejects unless
+     * the token belongs to a site administrator, and rejects an unknown class
+     * with `invalid-options`; a listing that does not finish, or that lists a
+     * repository id twice, is reported in `incompleteReasons`.
      */
     discover(signalArg?: AbortSignal, optionsArg?: IGiteaSourceDiscoveryOptions): Promise<IDiscovery>;
     /**
      * Every unit a run over this discovery measures: the instance, then owners,
      * then repositories, then the packages discovery lists when it selected
-     * them.
+     * them, then, when it selected collaboration, one collaboration unit per
+     * repository, keyed by the repository's id. A discovery that selects
+     * collaboration while a repository has no id rejects with
+     * `repository-id-missing`; it never falls back to keying by name.
      */
     units(discoveryArg: IDiscovery): TUnit[];
     /**
@@ -114,12 +121,13 @@ export declare class GiteaSourceInventory {
     lookupRepository(idArg: string, signalArg?: AbortSignal): Promise<TGiteaSourceRepositoryLookup>;
     /**
      * Measures one unit. Never rejects: a unit whose primary record cannot be
-     * read is `failed`, and so is a repository unit carrying an id that its name
-     * no longer answers with (`repository-identity-changed`). A package unit is
-     * read whole or fails, never partly: a listing that does not finish, an
-     * index that is not what its file list promises (`unexpected-manifest-shape`)
-     * and a result over `forgeSourceInventoryUnitMaxBytes` of UTF-8 JSON
-     * (`unit-over-bound`) fail it, and its record is never truncated.
+     * read is `failed`, and so is a repository or collaboration unit carrying an
+     * id that its name no longer answers with (`repository-identity-changed`).
+     * Package and collaboration units are read whole or fail, never partly: a
+     * listing that does not finish, an index that is not what its file list
+     * promises (`unexpected-manifest-shape`) and a result over
+     * `forgeSourceInventoryUnitMaxBytes` of UTF-8 JSON (`unit-over-bound`) fail
+     * it, and its records are never truncated.
      */
     measureUnit(unitArg: TUnit, signalArg?: AbortSignal): Promise<TUnitResult>;
     /**
@@ -139,7 +147,11 @@ export declare class GiteaSourceInventory {
  * `packages` and `totals.packageContent` (`composeGiteaPackageContent`) are
  * present exactly when discovery lists packages, an empty list included; a
  * package without a record is left out, never truncated, and makes its
- * content measures partial.
+ * content measures partial. `collaboration` and every organization's
+ * `labelRecords` are present exactly when discovery selects collaboration: a
+ * repository without a collaboration result for its discovered id is left
+ * out and named in the reasons, and a record list that is not measured is a
+ * reason by its path, such as `collaboration.issues`.
  */
 export declare const composeGiteaSourceInventory: (discoveryArg: IDiscovery, resultsArg: TUnitResult[], generatorsArg: plugins.fossInterfaces.data.IForgeSourceInventoryGenerator[]) => IInventory;
 export {};