Skip to content

dependabit / manifest/src / validateDependencyEntry

Function: validateDependencyEntry()

ts
function validateDependencyEntry(data): {
  accessMethod: "context7" | "arxiv" | "openapi" | "github-api" | "http";
  auth?: {
     secretEnvVar?: string;
     type: "token" | "oauth" | "basic" | "none";
  };
  changeHistory: {
     detectedAt: string;
     falsePositive: boolean;
     issueNumber?: number;
     newVersion?: string;
     oldVersion?: string;
     severity: "breaking" | "major" | "minor";
  }[];
  currentStateHash: string;
  currentVersion?: string;
  description?: string;
  detectedAt: string;
  detectionConfidence: number;
  detectionMethod:   | "llm-analysis"
     | "manual"
     | "package-json"
     | "requirements-txt"
     | "code-comment";
  id: string;
  lastChanged?: string;
  lastChecked: string;
  monitoring?: {
     checkFrequency: "hourly" | "daily" | "weekly" | "monthly";
     enabled: boolean;
     ignoreChanges: boolean;
     severityOverride?: "breaking" | "major" | "minor";
  };
  name: string;
  referencedIn: {
     context?: string;
     file: string;
     line?: number;
  }[];
  type:   | "reference-implementation"
     | "schema"
     | "documentation"
     | "research-paper"
     | "api-example"
     | "other";
  url: string;
};

Defined in: packages/manifest/src/validator.ts:56

Validate a dependency entry

Parameters

ParameterType
dataunknown

Returns

ts
{
  accessMethod: "context7" | "arxiv" | "openapi" | "github-api" | "http";
  auth?: {
     secretEnvVar?: string;
     type: "token" | "oauth" | "basic" | "none";
  };
  changeHistory: {
     detectedAt: string;
     falsePositive: boolean;
     issueNumber?: number;
     newVersion?: string;
     oldVersion?: string;
     severity: "breaking" | "major" | "minor";
  }[];
  currentStateHash: string;
  currentVersion?: string;
  description?: string;
  detectedAt: string;
  detectionConfidence: number;
  detectionMethod:   | "llm-analysis"
     | "manual"
     | "package-json"
     | "requirements-txt"
     | "code-comment";
  id: string;
  lastChanged?: string;
  lastChecked: string;
  monitoring?: {
     checkFrequency: "hourly" | "daily" | "weekly" | "monthly";
     enabled: boolean;
     ignoreChanges: boolean;
     severityOverride?: "breaking" | "major" | "minor";
  };
  name: string;
  referencedIn: {
     context?: string;
     file: string;
     line?: number;
  }[];
  type:   | "reference-implementation"
     | "schema"
     | "documentation"
     | "research-paper"
     | "api-example"
     | "other";
  url: string;
}
NameTypeDefault valueDefined in
accessMethod"context7" | "arxiv" | "openapi" | "github-api" | "http"AccessMethodSchemapackages/manifest/src/schema.ts:84
auth?{ secretEnvVar?: string; type: "token" | "oauth" | "basic" | "none"; }AuthConfigSchemapackages/manifest/src/schema.ts:100
auth.secretEnvVar?string-packages/manifest/src/schema.ts:67
auth.type"token" | "oauth" | "basic" | "none"-packages/manifest/src/schema.ts:64
changeHistory{ detectedAt: string; falsePositive: boolean; issueNumber?: number; newVersion?: string; oldVersion?: string; severity: "breaking" | "major" | "minor"; }[]-packages/manifest/src/schema.ts:113
currentStateHashstring-packages/manifest/src/schema.ts:90
currentVersion?string-packages/manifest/src/schema.ts:89
description?string-packages/manifest/src/schema.ts:86
detectedAtstring-packages/manifest/src/schema.ts:95
detectionConfidencenumber-packages/manifest/src/schema.ts:94
detectionMethod| "llm-analysis" | "manual" | "package-json" | "requirements-txt" | "code-comment"DetectionMethodSchemapackages/manifest/src/schema.ts:93
idstring-packages/manifest/src/schema.ts:81
lastChanged?string-packages/manifest/src/schema.ts:97
lastCheckedstring-packages/manifest/src/schema.ts:96
monitoring?{ checkFrequency: "hourly" | "daily" | "weekly" | "monthly"; enabled: boolean; ignoreChanges: boolean; severityOverride?: "breaking" | "major" | "minor"; }-packages/manifest/src/schema.ts:101
monitoring.checkFrequency"hourly" | "daily" | "weekly" | "monthly"-packages/manifest/src/schema.ts:74
monitoring.enabledboolean-packages/manifest/src/schema.ts:73
monitoring.ignoreChangesboolean-packages/manifest/src/schema.ts:75
monitoring.severityOverride?"breaking" | "major" | "minor"-packages/manifest/src/schema.ts:76
namestring-packages/manifest/src/schema.ts:85
referencedIn{ context?: string; file: string; line?: number; }[]-packages/manifest/src/schema.ts:104
type| "reference-implementation" | "schema" | "documentation" | "research-paper" | "api-example" | "other"DependencyTypeSchemapackages/manifest/src/schema.ts:83
urlstring-packages/manifest/src/schema.ts:82

Throws

if validation fails

Released under the MIT License.