@roostorg/types 1.1.1 → 2.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@roostorg/types",
   "type": "module",
-  "version": "1.1.1",
+  "version": "2.0.0",
   "description": "Shared types across Coop services",
   "module": "transpiled/index.js",
   "typings": "./transpiled/index.d.ts",
@@ -10,6 +10,11 @@
     "prepublishOnly": "npm run build",
     "test": "npm run build && node --test transpiled/test_scripts/"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/roostorg/coop",
+    "directory": "types"
+  },
   "author": "Roostorg",
   "files": [
     "transpiled"

package/transpiled/integration.d.ts

@@ -31,7 +31,7 @@ export type ModelCardSubsection = Readonly<{
  * Either subsections (with bold sub-headings) or top-level fields, or both.
  */
 export type ModelCardSection = Readonly<{
-    /** Stable id for the section (e.g. "modelDetails", "trainingData"). */
+    /** Stable id for the section (e.g. "trainingData", "biasAndLimitations"). */
     id: string;
     /** Display title (e.g. "Model Details"). */
     title: string;
@@ -62,10 +62,10 @@ export type ModelCard = Readonly<{
  * Section ids that every integration's model card must include.
  * Use assertModelCardHasRequiredSections() to validate at runtime.
  */
-export declare const REQUIRED_MODEL_CARD_SECTION_IDS: readonly ["modelDetails", "technicalIntegration"];
+export declare const REQUIRED_MODEL_CARD_SECTION_IDS: readonly ["trainingData", "policyAndTaxonomy", "annotationMethodology", "performanceBenchmarks", "biasAndLimitations", "implementationGuidance", "relevantLinks"];
 /**
- * Asserts that a model card has at least the required sections (basic information
- * and technical integration). Call when registering integration manifests.
+ * Asserts that a model card has at least the required sections.
+ * Call when registering integration manifests.
  * @throws Error if any required section id is missing
  */
 export declare function assertModelCardHasRequiredSections(card: ModelCard): void;
@@ -116,10 +116,9 @@ export type IntegrationManifest = Readonly<{
     signalTypeIds?: readonly string[];
     /**
      * Model card: structured metadata (model name, version, sections) for the UI.
-     * When present, the integration detail page renders it. Built-in integrations
-     * should always provide a model card with at least sections "modelDetails" and
-     * "technicalIntegration"; use assertModelCardHasRequiredSections() when
-     * registering.
+     * When present, the integration detail page renders it. Integrations must
+     * include all sections listed in REQUIRED_MODEL_CARD_SECTION_IDS; use
+     * assertModelCardHasRequiredSections() when registering.
      */
     modelCard?: ModelCard;
     /**
@@ -133,6 +132,8 @@ export type IntegrationManifest = Readonly<{
      * If you provide logoPath and logoWithBackgroundPath, the server will serve the files at
      * GET /api/v1/integration-logos/:integrationId and GET /api/v1/integration-logos/:integrationId/with-background
      * and set logoUrl and logoWithBackgroundUrl accordingly.
+     * Usage: logoUrl/logoPath = plain logo (no background), used on the integrations page;
+     * logoWithBackgroundUrl/logoWithBackgroundPath = logo with background, used in signal modals.
      * If you provide logoUrl and logoWithBackgroundUrl, the server will use those URLs directly.
      * Prefered size: ~180x180px for logoUrl and ~120x120px for logoWithBackgroundUrl.
      * Prefer a square or horizontal logo that scales well.

package/transpiled/integration.js

@@ -13,20 +13,24 @@
  * Use assertModelCardHasRequiredSections() to validate at runtime.
  */
 export const REQUIRED_MODEL_CARD_SECTION_IDS = [
-    'modelDetails',
-    'technicalIntegration',
+    'trainingData',
+    'policyAndTaxonomy',
+    'annotationMethodology',
+    'performanceBenchmarks',
+    'biasAndLimitations',
+    'implementationGuidance',
+    'relevantLinks',
 ];
 /**
- * Asserts that a model card has at least the required sections (basic information
- * and technical integration). Call when registering integration manifests.
+ * Asserts that a model card has at least the required sections.
+ * Call when registering integration manifests.
  * @throws Error if any required section id is missing
  */
 export function assertModelCardHasRequiredSections(card) {
     const sectionIds = new Set((card.sections ?? []).map((s) => s.id));
-    for (const requiredId of REQUIRED_MODEL_CARD_SECTION_IDS) {
-        if (!sectionIds.has(requiredId)) {
-            throw new Error(`Model card must include a section with id "${requiredId}" (e.g. Basic Information / Model Details and Technical Integration).`);
-        }
+    const missing = REQUIRED_MODEL_CARD_SECTION_IDS.filter((id) => !sectionIds.has(id));
+    if (missing.length > 0) {
+        throw new Error(`Model card is missing required section(s): ${missing.map((id) => `"${id}"`).join(', ')}.`);
     }
 }
 /**