Dependicus API Reference
    Preparing search index...

    Interface DependicusPlugin

    interface DependicusPlugin {
        columns?: CustomColumn[];
        getDependencySections?: (ctx: DependencyDetailContext) => GroupingSection[];
        getGitHubIssueSpec?: (
            context: VersionContext,
            store: FactStore,
        ) =>
            | Partial<
                {
                    assignment?: | { type: "unassigned" }
                    | { assignees: string[]; type: "assign" };
                    availableMajorVersion?: string;
                    commentSections?: { body: string; title: string }[];
                    daysOverdue?: number;
                    descriptionSections?: { body: string; title: string }[];
                    group?: string;
                    labels?: string[];
                    owner: string;
                    ownerLabel?: string;
                    policy?:
                        | { type: "skip" }
                        | { rateLimitDays?: number; type: "fyi" }
                        | { rateLimitDays?: number; type: "dueDate" };
                    repo: string;
                    targetVersion?: string;
                    thresholdDays?: number;
                },
            >
            | undefined;
        getLinearIssueSpec?: (
            context: VersionContext,
            store: FactStore,
        ) =>
            | Partial<
                {
                    assignment?: | { type: "unassigned" }
                    | { assigneeId: string; type: "delegate" };
                    availableMajorVersion?: string;
                    commentSections?: { body: string; title: string }[];
                    daysOverdue?: number;
                    descriptionSections?: { body: string; title: string }[];
                    group?: string;
                    ownerLabel?: string;
                    policy?:
                        | { type: "skip" }
                        | { rateLimitDays?: number; type: "fyi" }
                        | { rateLimitDays?: number; type: "dueDate" };
                    targetVersion?: string;
                    teamId: string;
                    thresholdDays?: number;
                },
            >
            | undefined;
        getSections?: (ctx: GroupingDetailContext) => GroupingSection[];
        getUsedByGroupKey?: UsedByGroupKeyFn;
        groupings?: GroupingConfig[];
        name: string;
        sources?: DataSource[];
        init?(ctx: PluginContext): void;
    }

    Implemented by

    Index

    Properties

    columns? getDependencySections? getGitHubIssueSpec? getLinearIssueSpec? getSections? getUsedByGroupKey? groupings? name sources?

    Methods

    init?

    Properties

    columns?: CustomColumn[]
    getDependencySections?: (ctx: DependencyDetailContext) => GroupingSection[]

    Sections for a single dependency's own page. Same shape as the grouping sections, so a plugin holding per-version detail (advisories, sizes, policy history) can render it where someone is looking at that dependency, rather than only as a metadata row.

    getGitHubIssueSpec?: (
        context: VersionContext,
        store: FactStore,
    ) =>
        | Partial<
            {
                assignment?: | { type: "unassigned" }
                | { assignees: string[]; type: "assign" };
                availableMajorVersion?: string;
                commentSections?: { body: string; title: string }[];
                daysOverdue?: number;
                descriptionSections?: { body: string; title: string }[];
                group?: string;
                labels?: string[];
                owner: string;
                ownerLabel?: string;
                policy?:
                    | { type: "skip" }
                    | { rateLimitDays?: number; type: "fyi" }
                    | { rateLimitDays?: number; type: "dueDate" };
                repo: string;
                targetVersion?: string;
                thresholdDays?: number;
            },
        >
        | undefined
    getLinearIssueSpec?: (
        context: VersionContext,
        store: FactStore,
    ) =>
        | Partial<
            {
                assignment?: | { type: "unassigned" }
                | { assigneeId: string; type: "delegate" };
                availableMajorVersion?: string;
                commentSections?: { body: string; title: string }[];
                daysOverdue?: number;
                descriptionSections?: { body: string; title: string }[];
                group?: string;
                ownerLabel?: string;
                policy?:
                    | { type: "skip" }
                    | { rateLimitDays?: number; type: "fyi" }
                    | { rateLimitDays?: number; type: "dueDate" };
                targetVersion?: string;
                teamId: string;
                thresholdDays?: number;
            },
        >
        | undefined
    getSections?: (ctx: GroupingDetailContext) => GroupingSection[]
    getUsedByGroupKey?: UsedByGroupKeyFn
    groupings?: GroupingConfig[]
    name: string
    sources?: DataSource[]

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods