@algoux/standard-ranklist-utils 0.1.1 → 0.2.1

package/dist/index.d.cts

@@ -0,0 +1,102 @@
+import * as srk from '@algoux/standard-ranklist';
+
+declare const MIN_REGEN_SUPPORTED_VERSION = "0.3.0";
+
+declare enum EnumTheme {
+    light = "light",
+    dark = "dark"
+}
+
+interface RankValue {
+    /** Rank value initially. If the user is unofficial and rank value equals null, it will be rendered as unofficial mark such as '*'. */
+    rank: number | null;
+    /**
+     * Series segment index which this rank belongs to initially. `null` means this rank does not belong to any segment. `undefined` means it will be calculated automatically (only if the segment's count property exists).
+     * @defaultValue null
+     */
+    segmentIndex?: number | null;
+}
+type StaticRanklist = Omit<srk.Ranklist, 'rows'> & {
+    rows: Array<srk.RanklistRow & {
+        rankValues: RankValue[];
+    }>;
+};
+type CalculatedSolutionTetrad = [
+    /** user id */ string,
+    /** problem index */ number,
+    /** result */ Exclude<srk.SolutionResultFull, null> | srk.SolutionResultCustom,
+    /** solution submitted time */ srk.TimeDuration
+];
+interface ThemeColor {
+    [EnumTheme.light]: string | undefined;
+    [EnumTheme.dark]: string | undefined;
+}
+
+declare function formatTimeDuration(time: srk.TimeDuration, targetUnit?: srk.TimeUnit, fmt?: (num: number) => number): number;
+declare function preZeroFill(num: number, size: number): string;
+/**
+ * format seconds to time string
+ * @param {number} second
+ * @param {{ fillHour?: boolean, showDay?: boolean }} options
+ * @returns {string}
+ */
+declare function secToTimeStr(second: number, options?: {
+    fillHour?: boolean;
+    showDay?: boolean;
+}): string;
+/**
+ * Format number index to alphabet index
+ * 0 => 'A'
+ * 2 => 'C'
+ * 25 => 'Z'
+ * 26 => 'AA'
+ * 28 => 'AC
+ * @param {number | string} number
+ * @returns {string}
+ */
+declare function numberToAlphabet(number: number | string): string;
+/**
+ * Format alphabet index to number index
+ * 'A' => 0
+ * 'C' => 2
+ * 'Z' => 25
+ * 'AA' => 26
+ * 'AC' => 28
+ * @param {string} alphabet
+ * @returns {number}
+ */
+declare function alphabetToNumber(alphabet: string): number;
+
+declare function resolveText(text: srk.Text | undefined): string;
+/**
+ * Parse contributor string to an object which contains name, email (optional) and url (optional).
+ * @param contributor
+ * @returns parsed contributor object
+ * @example
+ * 'name <mail@example.com> (http://example.com)' -> { name: 'name', email: 'mail@example.com', url: 'http://example.com' }
+ * 'name' -> { name: 'name' }
+ * 'name <mail@example.com>' -> { name: 'name', email: 'mail@example.com' }
+ * 'name (http://example.com)' -> { name: 'name', url: 'http://example.com' }
+ * 'John Smith (http://example.com)' -> { name: 'John Smith', url: 'http://example.com' }
+ */
+declare function resolveContributor(contributor: srk.Contributor | undefined): {
+    name: string;
+    email?: string;
+    url?: string;
+} | null;
+declare function resolveColor(color: srk.Color): string | undefined;
+declare function resolveThemeColor(themeColor: srk.ThemeColor): ThemeColor;
+declare function resolveStyle(style: srk.Style): {
+    textColor: ThemeColor;
+    backgroundColor: ThemeColor;
+};
+
+declare function canRegenerateRanklist(ranklist: srk.Ranklist): boolean;
+declare function getSortedCalculatedRawSolutions(rows: srk.RanklistRow[]): CalculatedSolutionTetrad[];
+declare function filterSolutionsUntil(solutions: CalculatedSolutionTetrad[], time: srk.TimeDuration): CalculatedSolutionTetrad[];
+declare function sortRows(rows: srk.RanklistRow[]): srk.RanklistRow[];
+declare function regenerateRanklistBySolutions(originalRanklist: srk.Ranklist, solutions: CalculatedSolutionTetrad[]): srk.Ranklist;
+declare function regenerateRowsByIncrementalSolutions(originalRanklist: srk.Ranklist, solutions: CalculatedSolutionTetrad[]): srk.RanklistRow[];
+declare function convertToStaticRanklist(ranklist: srk.Ranklist): StaticRanklist;
+
+export { type CalculatedSolutionTetrad, EnumTheme, MIN_REGEN_SUPPORTED_VERSION, type RankValue, type StaticRanklist, type ThemeColor, alphabetToNumber, canRegenerateRanklist, convertToStaticRanklist, filterSolutionsUntil, formatTimeDuration, getSortedCalculatedRawSolutions, numberToAlphabet, preZeroFill, regenerateRanklistBySolutions, regenerateRowsByIncrementalSolutions, resolveColor, resolveContributor, resolveStyle, resolveText, resolveThemeColor, secToTimeStr, sortRows };

package/dist/index.d.mts

@@ -0,0 +1,102 @@
+import * as srk from '@algoux/standard-ranklist';
+
+declare const MIN_REGEN_SUPPORTED_VERSION = "0.3.0";
+
+declare enum EnumTheme {
+    light = "light",
+    dark = "dark"
+}
+
+interface RankValue {
+    /** Rank value initially. If the user is unofficial and rank value equals null, it will be rendered as unofficial mark such as '*'. */
+    rank: number | null;
+    /**
+     * Series segment index which this rank belongs to initially. `null` means this rank does not belong to any segment. `undefined` means it will be calculated automatically (only if the segment's count property exists).
+     * @defaultValue null
+     */
+    segmentIndex?: number | null;
+}
+type StaticRanklist = Omit<srk.Ranklist, 'rows'> & {
+    rows: Array<srk.RanklistRow & {
+        rankValues: RankValue[];
+    }>;
+};
+type CalculatedSolutionTetrad = [
+    /** user id */ string,
+    /** problem index */ number,
+    /** result */ Exclude<srk.SolutionResultFull, null> | srk.SolutionResultCustom,
+    /** solution submitted time */ srk.TimeDuration
+];
+interface ThemeColor {
+    [EnumTheme.light]: string | undefined;
+    [EnumTheme.dark]: string | undefined;
+}
+
+declare function formatTimeDuration(time: srk.TimeDuration, targetUnit?: srk.TimeUnit, fmt?: (num: number) => number): number;
+declare function preZeroFill(num: number, size: number): string;
+/**
+ * format seconds to time string
+ * @param {number} second
+ * @param {{ fillHour?: boolean, showDay?: boolean }} options
+ * @returns {string}
+ */
+declare function secToTimeStr(second: number, options?: {
+    fillHour?: boolean;
+    showDay?: boolean;
+}): string;
+/**
+ * Format number index to alphabet index
+ * 0 => 'A'
+ * 2 => 'C'
+ * 25 => 'Z'
+ * 26 => 'AA'
+ * 28 => 'AC
+ * @param {number | string} number
+ * @returns {string}
+ */
+declare function numberToAlphabet(number: number | string): string;
+/**
+ * Format alphabet index to number index
+ * 'A' => 0
+ * 'C' => 2
+ * 'Z' => 25
+ * 'AA' => 26
+ * 'AC' => 28
+ * @param {string} alphabet
+ * @returns {number}
+ */
+declare function alphabetToNumber(alphabet: string): number;
+
+declare function resolveText(text: srk.Text | undefined): string;
+/**
+ * Parse contributor string to an object which contains name, email (optional) and url (optional).
+ * @param contributor
+ * @returns parsed contributor object
+ * @example
+ * 'name <mail@example.com> (http://example.com)' -> { name: 'name', email: 'mail@example.com', url: 'http://example.com' }
+ * 'name' -> { name: 'name' }
+ * 'name <mail@example.com>' -> { name: 'name', email: 'mail@example.com' }
+ * 'name (http://example.com)' -> { name: 'name', url: 'http://example.com' }
+ * 'John Smith (http://example.com)' -> { name: 'John Smith', url: 'http://example.com' }
+ */
+declare function resolveContributor(contributor: srk.Contributor | undefined): {
+    name: string;
+    email?: string;
+    url?: string;
+} | null;
+declare function resolveColor(color: srk.Color): string | undefined;
+declare function resolveThemeColor(themeColor: srk.ThemeColor): ThemeColor;
+declare function resolveStyle(style: srk.Style): {
+    textColor: ThemeColor;
+    backgroundColor: ThemeColor;
+};
+
+declare function canRegenerateRanklist(ranklist: srk.Ranklist): boolean;
+declare function getSortedCalculatedRawSolutions(rows: srk.RanklistRow[]): CalculatedSolutionTetrad[];
+declare function filterSolutionsUntil(solutions: CalculatedSolutionTetrad[], time: srk.TimeDuration): CalculatedSolutionTetrad[];
+declare function sortRows(rows: srk.RanklistRow[]): srk.RanklistRow[];
+declare function regenerateRanklistBySolutions(originalRanklist: srk.Ranklist, solutions: CalculatedSolutionTetrad[]): srk.Ranklist;
+declare function regenerateRowsByIncrementalSolutions(originalRanklist: srk.Ranklist, solutions: CalculatedSolutionTetrad[]): srk.RanklistRow[];
+declare function convertToStaticRanklist(ranklist: srk.Ranklist): StaticRanklist;
+
+export { type CalculatedSolutionTetrad, EnumTheme, MIN_REGEN_SUPPORTED_VERSION, type RankValue, type StaticRanklist, type ThemeColor, alphabetToNumber, canRegenerateRanklist, convertToStaticRanklist, filterSolutionsUntil, formatTimeDuration, getSortedCalculatedRawSolutions, numberToAlphabet, preZeroFill, regenerateRanklistBySolutions, regenerateRowsByIncrementalSolutions, resolveColor, resolveContributor, resolveStyle, resolveText, resolveThemeColor, secToTimeStr, sortRows };