Skip to content

dependabit / manifest/src / safeValidateDependencyEntry

Function: safeValidateDependencyEntry()

ts
function safeValidateDependencyEntry(data): {
  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;
  };
  error?: ValidationError;
  success: boolean;
};

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

Safe validation for dependency entry

Parameters

ParameterType
dataunknown

Returns

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

Released under the MIT License.