startgg-helper 2.0.2 → 2.1.0

package/main.js

@@ -1,2 +1,5 @@
 export * from "./src/query.js"
-export * from "./src/queryLimiter.js"
+export * from "./src/queryLimiter.js"
+export * from "./src/jsUtil.js"
+export * from "./src/tournamentUtil"
+export * from "./src/smashggData.js"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "startgg-helper",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "A set of functions and classes useful to communicate with the start.gg API, using any client (YOU NEED TO PROVIDE A CLIENT YOURSELF, SEE README)",
   "main": "main.js",
   "scripts": {

package/src/jsUtil.js

@@ -9,7 +9,7 @@ function processObjectPath(path){
         }
     }
     return path;
-}
+}//jsutil
 
 /**
  * 
@@ -41,4 +41,54 @@ export function deep_set(obj, path, value){
     }
     obj[finalName] = value;
     return true;
+}
+
+let currentID = 1;
+export function generateUniqueID(){
+    return currentID++;
+}//jsutil
+
+/**
+ * 
+ * @param {(() => any)[]} fArray 
+ */
+export function fResultsArray(fArray){
+    let result = [];
+    for (let f of fArray){
+        let res = f();
+        if (res !== undefined){
+            result.push(res);
+        }
+    }
+
+    return result;
+} 
+
+/**
+ * 
+ * @param  {...(() => any)} functions 
+ */
+export function fResults(...functions){
+    return fResultsArray(functions);
+}
+
+/**
+ * 
+ * @param {any} data 
+ * @param {boolean} pretty 
+ */
+export function toJSON(data, pretty){
+    return JSON.stringify(data, null, pretty ? 4 : undefined);
+}//jsutil
+
+export function isNumber(n){
+    return typeof n == "number";
+}
+
+/**
+ * 
+ * @param {number | Date | string} d 
+ */
+export function toUNIXTimestamp(d){
+    return isNaN(d) ? new Date(d).getTime() / 1000 : d;
 }

package/src/query.js

@@ -1,4 +1,3 @@
-import { GraphQLClient } from 'graphql-request';
 import { deep_get, deep_set } from './jsUtil.js';
 import { TimedQuerySemaphore } from './queryLimiter.js'
 

package/src/queryLimiter.js

@@ -1,16 +1,12 @@
 //i am a god of JS
 
-/**
- * Dummy client class that's only used in the JSDoc. 
- * In a real use case, the user will have their own client class.
- */
-class Client {
-    request(){}
-}
+//voir la diff avec la version de sgghelper ?
+
+import { GraphQLClient } from "graphql-request";
 
 export class TimedQuerySemaphore {
     /**
-     * @typedef {{client: Client, schema: string, 
+     * @typedef {{client: GraphQLClient, schema: string, 
      *  params: {[varName: string]: value}, 
      *  resolve: (value: any) => void, 
      *  reject: (reason?: any) => void}
@@ -47,7 +43,7 @@ export class TimedQuerySemaphore {
     }
 
     /**
-     * @param {Client} client 
+     * @param {GraphQLClient} client 
      * @param {string} schema 
      * @param {{[varName: string]: value}} params 
      * @returns 
@@ -74,7 +70,7 @@ export class TimedQuerySemaphore {
 
     /**
      * Executes the given query with the given GraphQL Client
-     * @param {Client} client 
+     * @param {GraphQLClient} client 
      * @param {string} schema 
      * @param {{[varName: string]: value}} params 
      * @returns 

package/src/smashggData.js

@@ -0,0 +1,3 @@
+export function removeTags(name){
+    return name.split("|").at(-1).trim();
+}//sggutil

package/src/tournamentUtil.js

@@ -0,0 +1,81 @@
+const placements = [
+        1,       2,      3,      4,       6,
+        8,      12,     16,     24,      32,
+       48,      64,     96,    128,     192,
+      256,     384,    512,    768,    1024,
+     1536,    2048,   3072,   4096,    6144,
+     8192,   12288,  16384,  24576,   32768,
+    49152,   65536,  98304, 131072,  196608,
+   262144,  393216, 524288, 786432, 1048576,
+  1572864, 2097152
+]
+//sggutil
+
+/**
+ * Extracts a slug from a string. Can be either the slug directly or the full URL.
+ * @param {string} string 
+ */
+export function extractSlug(string){
+    if (string.includes("start.gg/")){
+        return string.split("start.gg/")[1];
+    } 
+    return string;
+}
+
+/**
+ * 
+ * @param {string[]} list 
+ * @returns 
+ */
+export function extractSlugs(list){
+    return list.map(str => extractSlug(str));
+}
+
+export function getDoubleEliminationPlacementTier(placement){
+    for (let tier of placements){
+        if (placement <= tier) return tier;
+    }
+}
+
+export function getDoubleEliminationUpsetFactorFromSeeds(winnerSeed, loserSeed){
+    if (winnerSeed < loserSeed) return 0;
+
+    let winnerExpectedTierID = -1, loserExpectedTierID = -1;
+
+    for (let i = 0; i < placements.length; i++){
+        if (winnerSeed <= placements[i]) {winnerExpectedTierID = i; break;}
+    }
+
+    for (let i = 0; i < placements.length; i++){
+        if (loserSeed <= placements[i]) {
+            loserExpectedTierID = i;
+            break;
+        } 
+    }
+
+    if (!winnerExpectedTierID < 0 || !loserExpectedTierID < 0) return undefined;
+
+    return (winnerExpectedTierID - loserExpectedTierID);
+}
+
+export function getDoubleEliminationUpsetFactorFromSet(set){
+    let score1 = set.slots[0].standing.stats.score.value;
+    let score2 = set.slots[1].standing.stats.score.value;
+    let seed1 = set.slots[0].entrant.initialSeedNum;
+    let seed2 = set.slots[1].entrant.initialSeedNum;
+
+    if (score1 < 0 || score2 < 0) return [0, 0];
+
+    //console.log(set.slots[0].entrant.name, set.slots[1].entrant.name);
+    //console.log(score1, score2, seed1, seed2);
+
+    return (score1 > score2) ? [getDoubleEliminationUpsetFactorFromSeeds(seed1, seed2), 0] : [getDoubleEliminationUpsetFactorFromSeeds(seed2, seed1), 1];
+}
+
+/**
+ * Returns the tournament part in an event slug. Assumes the event slug is valid
+ * @param {string} eventSlug 
+ */
+export function getTournamentSlugFromEventSlug(eventSlug){
+    return eventSlug.split(/\/event/g)[0];
+}