@hasagi/schema 0.6.6 → 0.6.8

package/get-extended-help.d.ts

@@ -1,4 +1,4 @@
-type Schema = {
+type LCUHelpSchema = {
     types: any[];
     functions: any[];
     events: any[];
@@ -68,13 +68,9 @@ export interface XHelp {
     events: Event[];
 }
 declare function getExtendedHelp(includeRawData: true): Promise<{
-    extendedSchema: Schema;
-    fullSchema: Schema;
-    consoleSchema: Schema;
-}>;
-declare function getExtendedHelp(includeRawData?: boolean): Promise<Schema | {
-    extendedSchema: Schema;
-    fullSchema: Schema;
-    consoleSchema: Schema;
+    extendedSchema: LCUHelpSchema;
+    fullSchema: LCUHelpSchema;
+    consoleSchema: LCUHelpSchema;
 }>;
+declare function getExtendedHelp(includeRawData?: boolean): Promise<LCUHelpSchema>;
 export { getExtendedHelp };

package/get-extended-help.js

@@ -100,3 +100,4 @@ async function getExtendedHelp(includeRawData) {
     return extendedSchema;
 }
 export { getExtendedHelp };
+const x = await getExtendedHelp();

package/openapi/generate-openapi-v3.js

@@ -1,5 +1,26 @@
 import { HasagiClient as HasagiLiteClient } from "@hasagi/core";
 import { getSwaggerTypeName } from "../util.js";
+const desc = `Auto-generated using LCU's /help endpoint.
+The following endpoints are not entirely auto-generated because their /help response is missing necessary fields:
+
+%missing_data%
+
+### Rules
+
+1.  No interacting with shop.
+2.  No interacting with chat.
+3.  No interacting with anything authentication related.
+4.  Don't automate anything Riot doesn't want you to (like ready check, bans, and champ selection)
+5.  If you can do it using the official Riot API, then don't do it using LCU.
+6.  Don't try to expose data that Riot wants to hide, e.g. names in ranked champ select.
+7.  Just because something isn't listed here doesn't mean it's allowed.
+
+### Disclaimer
+
+swagger.dysolix.dev is not endorsed by Riot Games and does not reflect the views or opinions of Riot Games or anyone officially involved in producing or managing Riot Games properties. 
+Riot Games and all associated properties are trademarks or registered trademarks of Riot Games, Inc
+
+[Privacy Policy](https://legal.dysolix.dev/privacy)`;
 function getRootType(input) {
     const isObject = input.fields.length > 0;
     const isEnum = input.values.length > 0;
@@ -69,7 +90,7 @@ export async function generateOpenAPIv3(schema) {
             version,
         },
         components: { schemas: {} },
-        paths: {}
+        paths: {},
     };
     let tags = [];
     schema.types.forEach(type => openAPISchema.components.schemas[type.name] = getRootType(type));
@@ -142,27 +163,7 @@ export async function generateOpenAPIv3(schema) {
         return t1.name.localeCompare(t2.name);
     });
     let i = 1;
-    openAPISchema.info.description =
-        `
-Auto-generated using LCU's /help endpoint.
-The following endpoints are not entirely auto-generated because their /help response is missing necessary fields:
-
-${functionsWithMissingData.map(func => `${i++}.\t${func}`).join("\n")}
-
-### Rules
-
-1.  No interacting with shop.
-2.  No interacting with chat.
-3.  No interacting with anything authentication related.
-4.  Don't automate anything Riot doesn't want you to (like ready check, bans, and champ selection)
-5.  If you can do it using the official Riot API, then don't do it using LCU.
-6.  Don't try to expose data that Riot wants to hide, e.g. names in ranked champ select.
-7.  Just because something isn't listed here doesn't mean it's allowed.
-
-### Disclaimer
-
-dysolix.dev is not endorsed by Riot Games and does not reflect the views or opinions of Riot Games or anyone officially involved in producing or managing Riot Games properties. 
-Riot Games and all associated properties are trademarks or registered trademarks of Riot Games, Inc`;
+    openAPISchema.info.description = desc.replace("%missing_data%", functionsWithMissingData.map(func => `${i++}.\t${func}`).join("\n"));
     return openAPISchema;
 }
 function endpointToOperation(endpoint, schema) {
@@ -238,7 +239,7 @@ function endpointToOperation(endpoint, schema) {
     if (endpoint.method === "GET" && !response.content) {
         response.content = {
             "application/json": {
-                schema: {}
+                schema: { type: "object" }
             }
         };
     }

package/openapi/openapi-schema.js

@@ -111,8 +111,11 @@ function getTypeBySchemaObject(schema, namespace) {
             return getArrayTypeBySchemaObject(schema, namespace).split("\n").join("\n\t");
         case "object":
             return getObjectTypeBySchemaObject(schema, namespace).split("\n").join("\n\t");
-        default:
-            return `${namespace}.${TYPE_OVERRIDES[schema.type]?.rename ? TYPE_OVERRIDES[schema.type].rename : schema.type}`;
+        default: {
+            if (schema.type === undefined)
+                return "unknown";
+            return `${namespace ? `${namespace}.` : ""}${schema.type}`;
+        }
     }
 }
 function getArrayTypeBySchemaObject(schema, namespace) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hasagi/schema",
-  "version": "0.6.6",
+  "version": "0.6.8",
   "keywords": [
     "hasagi"
   ],