@modrinth/api-client 0.63.0 → 0.65.0

package/dist/index.d.ts

@@ -3409,6 +3409,18 @@ export declare namespace Labrinth {
                 donation: boolean;
                 url: string;
             };
+            export type NormalizedProjectNagKind = 'minecraft-title-clause' | 'project-name-non-standard-text' | 'project-name-profanity' | 'project-name-slur' | 'project-name-version' | 'project-summary-links' | 'project-summary-matches-title' | 'project-summary-non-english' | 'project-summary-non-standard-text' | 'project-summary-profanity' | 'project-summary-slur' | 'project-summary-spam' | 'summary-special-formatting' | 'summary-too-short' | 'add-icon' | 'feature-gallery-image' | 'upload-gallery-image' | 'gallery-text-non-standard' | 'gallery-text-profanity' | 'gallery-text-slur' | 'add-description' | 'adjacent-headers' | 'description-ends-with-header' | 'description-too-short' | 'long-headers' | 'missing-alt-text' | 'project-description-banned-link' | 'project-description-non-english' | 'project-description-non-standard-text' | 'project-description-profanity' | 'project-description-slur' | 'project-description-spam' | 'add-custom-license-details' | 'invalid-license-url' | 'select-license' | 'add-links' | 'add-links-server' | 'banned-link-usage' | 'gpl-license-source-required' | 'identical-links' | 'misused-discord-link' | 'verify-external-links' | 'review-permissions' | 'add-java-address' | 'all-languages' | 'select-compatibility' | 'select-country' | 'select-language' | 'too-many-languages' | 'all-tags-selected' | 'multiple-resolution-tags' | 'select-tags' | 'too-many-tags' | 'too-many-tags-server' | 'select-environment' | 'upload-version' | 'check-disclosures' | 'disclosures-special-formatting' | 'moderator-feedback';
+            export type ReplaceHyphensWithUnderscores<T extends string> = T extends `${infer Head}-${infer Tail}` ? `${Head}_${ReplaceHyphensWithUnderscores<Tail>}` : T;
+            export type ProjectNagKind = ReplaceHyphensWithUnderscores<NormalizedProjectNagKind>;
+            export type ProjectNagSeverity = 'required' | 'warning' | 'suggestion';
+            export type ProjectNag = {
+                kind: ProjectNagKind;
+                severity: ProjectNagSeverity;
+                details: Record<string, unknown>;
+            };
+            export type ProjectValidationResponse = {
+                nags: ProjectNag[];
+            };
             export type Project = {
                 id: string;
                 slug?: string;
@@ -4499,6 +4511,110 @@ export declare namespace Labrinth {
     }
     export namespace TechReview {
         export namespace Internal {
+            export type DelphiRule = {
+                id: number;
+                name: string;
+                rule: string;
+                priority: number;
+                on_issue_types: string[];
+                revision: number;
+                current_revision?: number;
+                created_at: string;
+                updated_at: string;
+                created_by: number | null;
+                updated_by: number | null;
+                affected_details_count: number;
+                affected_details: DelphiRuleAffectedDetail[];
+            };
+            export type DelphiRuleAffectedDetail = {
+                detail_id: string;
+                issue_id: string;
+                project_id: string | null;
+                project_name: string | null;
+                project_icon_url: string | null;
+                version_id: string | null;
+                version_name: string | null;
+                version_number: string | null;
+                issue_type: string;
+                key: string;
+                jar: string | null;
+                file_path: string;
+                original_severity: DelphiSeverity;
+                severity: DelphiSeverity;
+            };
+            export type GetRuleAffectedDetailsRequest = {
+                limit?: number;
+                page?: number;
+            };
+            export type GetRuleAffectedDetailsResponse = {
+                total: number;
+                details: DelphiRuleAffectedDetail[];
+            };
+            export type WriteDelphiRule = {
+                name: string;
+                rule: string;
+                priority: number;
+                on_issue_types: string[];
+            };
+            export type DelphiIssueTypeSchemaResponse = Record<string, unknown>;
+            export type TestDelphiRuleRequest = {
+                rule: string;
+                inputs: RuleInput[];
+            };
+            export type DelphiRuleEffect = {
+                severity: DelphiSeverity;
+            };
+            export type DelphiRuleSchema = Record<string, unknown>;
+            export type DelphiRuleSchemaResponse = {
+                input: DelphiRuleSchema;
+                output: DelphiRuleSchema;
+                components: Record<string, DelphiRuleSchema>;
+            };
+            export type RuleInput = {
+                schema_version: number;
+                trace: RuleTrace;
+                file_traces: RuleTrace[];
+                scan: {
+                    delphi_version: number;
+                };
+                artifact: {
+                    size: number | null;
+                    hashes: Record<string, string>;
+                };
+                project: {
+                    id: string | null;
+                    types: string[];
+                };
+                version: {
+                    id: string | null;
+                    loaders: string[];
+                };
+                file: {
+                    id: string | null;
+                };
+            };
+            export type RuleTrace = {
+                key: string;
+                issue_type: string;
+                severity: DelphiSeverity;
+                jar: string | null;
+                file_path: string;
+                data: Record<string, unknown>;
+            };
+            export type TestDelphiRuleResponse = {
+                effects: Array<DelphiRuleEffect | null>;
+            };
+            export type DelphiRuleScanPhase = 'scanning' | 'publishing' | 'complete';
+            export type DelphiRuleScanEvent = {
+                phase: DelphiRuleScanPhase;
+                revision: number;
+                scanned: number;
+                total: number;
+                effects: number;
+            };
+            export type DelphiRuleScanErrorEvent = {
+                message: string;
+            };
             export type SearchProjectsRequest = {
                 limit?: number;
                 page?: number;
@@ -4602,6 +4718,9 @@ export declare namespace Labrinth {
                 download_url: string;
                 issues: FileIssue[];
             };
+            export type GetIssueRequest = {
+                include_hidden?: boolean;
+            };
             export type FileIssue = {
                 id: string;
                 report_id: string;
@@ -4701,7 +4820,7 @@ export declare namespace Labrinth {
                 members: User[];
             };
             export type FlagReason = 'delphi';
-            export type DelphiSeverity = 'low' | 'medium' | 'high' | 'severe';
+            export type DelphiSeverity = 'hidden' | 'low' | 'medium' | 'high' | 'severe' | 'malware';
             export type DelphiReportIssueStatus = 'pending' | 'safe' | 'unsafe';
             export type ProjectReportResponse = {
                 project_report: ProjectReport | null;
@@ -5758,6 +5877,7 @@ declare class LabrinthProjectsV3Module extends AbstractModule {
      * ```
      */
     get(id: string): Promise<Labrinth.Projects.v3.Project>;
+    validate(id: string): Promise<Labrinth.Projects.v3.ProjectValidationResponse>;
     /**
      * Get a project's dependencies (v3)
      *
@@ -6137,6 +6257,16 @@ declare class LabrinthTeamsV3Module extends AbstractModule {
 
 declare class LabrinthTechReviewInternalModule extends AbstractModule {
     getModuleID(): string;
+    getRules(): Promise<Labrinth.TechReview.Internal.DelphiRule[]>;
+    getRuleSchema(): Promise<Labrinth.TechReview.Internal.DelphiRuleSchemaResponse>;
+    getIssueTypeSchema(): Promise<Labrinth.TechReview.Internal.DelphiIssueTypeSchemaResponse>;
+    getDetailRuleInput(detailId: string): Promise<Labrinth.TechReview.Internal.RuleInput>;
+    getRuleAffectedDetails(id: number, params?: Labrinth.TechReview.Internal.GetRuleAffectedDetailsRequest): Promise<Labrinth.TechReview.Internal.GetRuleAffectedDetailsResponse>;
+    testRule(request: Labrinth.TechReview.Internal.TestDelphiRuleRequest): Promise<Labrinth.TechReview.Internal.TestDelphiRuleResponse>;
+    createRule(rule: Labrinth.TechReview.Internal.WriteDelphiRule): Promise<Labrinth.TechReview.Internal.DelphiRule>;
+    updateRule(id: number, rule: Labrinth.TechReview.Internal.WriteDelphiRule): Promise<Labrinth.TechReview.Internal.DelphiRule>;
+    deleteRule(id: number): Promise<void>;
+    scanRules(signal?: AbortSignal): Promise<ReadableStream<Uint8Array>>;
     /**
      * Search for projects awaiting technical review.
      *
@@ -6178,6 +6308,7 @@ declare class LabrinthTechReviewInternalModule extends AbstractModule {
      * Get detailed information about a specific issue.
      *
      * @param issueId - The issue ID
+     * @param params - Options controlling which issue details are returned
      * @returns Issue with all its details
      *
      * @example
@@ -6186,7 +6317,7 @@ declare class LabrinthTechReviewInternalModule extends AbstractModule {
      * console.log(issue.issue_type, issue.status)
      * ```
      */
-    getIssue(issueId: string): Promise<Labrinth.TechReview.Internal.FileIssue>;
+    getIssue(issueId: string, params?: Labrinth.TechReview.Internal.GetIssueRequest): Promise<Labrinth.TechReview.Internal.FileIssue>;
     /**
      * Update the status of a technical review issue detail.
      *
@@ -6808,6 +6939,10 @@ export declare type ModrinthErrorResponse = {
      * Human-readable error description
      */
     description: string;
+    /**
+     * Structured details about the error
+     */
+    details?: unknown;
     /**
      * Optional context about where the error occurred
      */