@accelbyte/codegen 2.1.0 → 2.3.1

package/.eslintrc.json

@@ -0,0 +1,6 @@
+{
+  "plugins": ["unused-imports"],
+  "rules": {
+    "unused-imports/no-unused-imports": "error"
+  }
+}

package/dist/accelbyte-codegen.js

@@ -114,7 +114,7 @@ ${generateImports(body, importStatements, makeNewImportVarMap$1(), getImportable
 
 export class ${className} {
   // @ts-ignore
-  constructor(private axiosInstance: AxiosInstance, private namespace: string, private cache = false) {}
+  constructor(private axiosInstance: AxiosInstance, private namespace: string, private cache = false, private isValidationEnabled = true) {}
   ${body}
 }
   `;
@@ -139,6 +139,7 @@ export function ${className}(sdk: AccelbyteSDK, args?: ApiArgs) {
   const namespace = args?.namespace ? args?.namespace : sdkAssembly.namespace
   const cache = args?.cache ? args?.cache : sdkAssembly.cache
   const requestConfig = ApiUtils.mergedConfigs(sdkAssembly.config, args)
+  const isValidationEnabled = args?.isValidationEnabled !== false
   ${body}
   
   return {
@@ -940,7 +941,7 @@ const templateApiIndex = (serviceName, serviceNameTitle, apiList) => {
   let imports = "";
   let returnStatement = "";
   for (const cl of apiList) {
-    const dir = cl.toLowerCase().includes("admin") ? "generated-admin" : "generated-public";
+    const dir = cl.toLowerCase().includes("admin") && cl !== "AdminApi" ? "generated-admin" : "generated-public";
     imports += `
 import { ${cl} } from './${dir}/${cl}.js'`;
     returnStatement += `
@@ -1020,7 +1021,8 @@ const Endpoint = zod.z.object({
         schema: Schema.nullish()
       })
     }).nullish()
-  }).nullish()
+  }).nullish(),
+  "x-security": zod.z.any().nullish()
 });
 const Operation = zod.z.object({
   get: Endpoint.nullish(),
@@ -1059,7 +1061,8 @@ const templateMethod = ({
   bodyParams,
   queryParams,
   isFormUrlEncoded,
-  responseClass
+  responseClass,
+  deprecated
 }) => {
   let methodParams = "";
   let methodParamsNoTypes = "";
@@ -1095,7 +1098,7 @@ const templateMethod = ({
   const isDelete = ["delete"].includes(httpMethod);
   let dataPayload = "{params}";
   const descriptionText = description ? `
-  /**
+  /**${deprecated ? "\n   * @deprecated" : ""}
    * ${description.replace(/\n/g, "\n   * ")} 
    */` : "";
   let formPayloadString = "";
@@ -1130,13 +1133,13 @@ const templateMethod = ({
     const url = ${newPath}    ${formPayloadString} ${isFileUpload ? "\n// TODO file upload not implemented" : ""}
     const resultPromise = this.axiosInstance.${httpMethod}(url, ${dataPayload})
 
-${httpMethod === "get" ? `    const res = () => Validate.responseType(() => resultPromise, ${resolvedResponseClassValidated}, '${resolvedResponseClassValidated}')
+${httpMethod === "get" ? `    const res = () => this.isValidationEnabled ? Validate.responseType(() => resultPromise, ${resolvedResponseClassValidated}, '${resolvedResponseClassValidated}') : Validate.unsafeResponse(() => resultPromise)
 
     if (!this.cache) {
       return SdkCache.withoutCache(res)
     }
     const cacheKey = url + CodeGenUtil.hashCode(JSON.stringify({ params }))
-    return SdkCache.withCache(cacheKey, res)` : ""}${["post", "put", "patch", "delete"].includes(httpMethod) ? `    return Validate.responseType(() => resultPromise, ${resolvedResponseClassValidated}, '${resolvedResponseClassValidated}')` : ""}
+    return SdkCache.withCache(cacheKey, res)` : ""}${["post", "put", "patch", "delete"].includes(httpMethod) ? `    return this.isValidationEnabled ? Validate.responseType(() => resultPromise, ${resolvedResponseClassValidated}, '${resolvedResponseClassValidated}') : Validate.unsafeResponse(() => resultPromise)` : ""}
   }
   `;
   if (!isGuardInvoked) {
@@ -1168,17 +1171,14 @@ const templateApiMethod = ({
   responseClass,
   classGenName,
   methodParams,
-  methodParamsNoTypes
+  methodParamsNoTypes,
+  deprecated,
+  xSecurity
 }) => {
-  let methodSignature = "";
   let newPath = `'${path}'`;
-  let snippetSdk = "";
-  let snippetShell = "";
+  let snippetMethod = "";
   for (const pathParam of pathParams) {
     const type = ParserUtils.parseType(pathParam);
-    if (pathParam.name !== "namespace") {
-      methodSignature += pathParam.name + `:${type}, `;
-    }
     const pName = pathParam.name === "namespace" ? "this.namespace" : pathParam.name;
     if (path.match(`{${pathParam.name}}`)) {
       if (type === "string") {
@@ -1188,18 +1188,23 @@ const templateApiMethod = ({
       }
     }
   }
-  snippetShell = `curl --location --request  \\
-    ${httpMethod} '__DOMAIN__${path}'  \\
-    --header 'accept: application/json'`;
+  const snippetShellArgs = ["--location --request", `${httpMethod} '__DOMAIN__${path}'`, "--header 'accept: application/json'"];
+  const snippetApiArgs = [];
+  if (xSecurity !== void 0 || path.includes("/admin")) {
+    snippetShellArgs.push("--header 'Authorization: Bearer {access_token}'");
+    snippetApiArgs.push("{ config: { headers: { Authorization: 'Bearer {access_token}' }  }}".trim());
+  }
   if (httpMethod !== "get") {
     const curlParams = bodyParams?.map((ob) => {
       return ` "${ob.name}": ""`;
     });
-    snippetShell += `  \\
-    --data-raw '{ ${curlParams}}'`;
+    if (curlParams.length > 0) {
+      snippetShellArgs.push(`--data-raw '{ ${curlParams}}'`);
+    }
   }
+  const snippetShell = `curl ${snippetShellArgs.join(" \\\n    ")}`;
   const descriptionText = description ? `
-  /**
+  /**${deprecated ? "\n   * @deprecated" : ""}
    * ${description.replace(/\n/g, "\n   * ")} 
    */` : "";
   const resolvedResponseClass = responseClass || "unknown";
@@ -1207,20 +1212,31 @@ const templateApiMethod = ({
   const methodImpl = `
   ${descriptionText}
   async function ${classMethod}(${methodParams}): Promise<${responseType}> {
-    const $ = new ${classGenName}(Network.create(requestConfig), namespace, cache)
+    const $ = new ${classGenName}(Network.create(requestConfig), namespace, cache, isValidationEnabled)
     const resp = await $.${classMethod}(${methodParamsNoTypes})
     if (resp.error) throw resp.error
     return resp.response.data
   }
   `;
   const snippetPromiseString = responseType !== "unknown" ? `Promise<${responseType}>` : "Promise";
-  snippetSdk += `${classMethod}(${methodParams}) 
+  snippetMethod += `${classMethod}(${methodParams}) 
    // return ${snippetPromiseString}`;
-  return [methodImpl, snippetSdk, snippetShell];
+  return {
+    generatedMethodString: methodImpl,
+    snippetApiArgs,
+    snippetMethod,
+    snippetShell
+  };
 };
 
-const templateSdkSnippet = (serviceNameTitle, apiName, methodSnippet) => {
-  const methodArr = methodSnippet.split("//");
+const templateSdkSnippet = ({
+  serviceNameTitle,
+  apiName,
+  snippetMethod,
+  snippetApiArgs: snippetApiArgsParam
+}) => {
+  const methodArr = snippetMethod.split("//");
+  const snippetApiArgs = ["sdk", ...snippetApiArgsParam];
   let normMethod = normalizeMethodSnippet(methodArr[0].trim(), "data:");
   normMethod = normalizeMethodSnippet(normMethod, "queryParams:");
   normMethod = normalizeMethodSnippet(normMethod, "queryParams?:");
@@ -1229,14 +1245,16 @@ const templateSdkSnippet = (serviceNameTitle, apiName, methodSnippet) => {
 import { ${serviceNameTitle} } from '@accelbyte/sdk-${serviceNameTitle.toLowerCase()}'
 
 const sdk = Accelbyte.SDK({
+  options: {
     baseURL: 'https://demo.accelbyte.io',
     clientId: '77f88506b6174c3ea4d925f5b4096ce8',
     namespace: 'accelbyte',
     redirectURI: 'http://localhost:3030'
+  }
 })
 
-${serviceNameTitle}.${apiName}(sdk)
-     .${normMethod}`;
+${serviceNameTitle}.${apiName}(${snippetApiArgs.join(", ")})
+  .${normMethod}`;
   return sdkSnippet;
 };
 const normalizeMethodSnippet = (methodInput, splitWord) => {
@@ -1320,7 +1338,7 @@ class SwaggerReaderHelpers {
           console.error(JSON.stringify({ path, httpMethod }, null, 2));
           throw error;
         });
-        if (!endpoint.tags || endpoint.deprecated)
+        if (!endpoint.tags)
           continue;
         const [tag] = endpoint.tags;
         const pathWithBase = `${api.basePath ?? ""}${path}`;
@@ -1352,6 +1370,7 @@ class SwaggerReaderHelpers {
         const isFormUrlEncoded = ParserUtils.isFormUrlEncoded(httpMethod, endpoint.consumes);
         const pathParams = ParserUtils.filterPathParams(endpoint.parameters);
         let bodyParams = ParserUtils.filterBodyParams(endpoint.parameters);
+        const deprecated = !!endpoint.deprecated;
         if (endpoint.requestBody) {
           bodyParams = [
             {
@@ -1370,10 +1389,11 @@ class SwaggerReaderHelpers {
           bodyParams,
           queryParams,
           isFormUrlEncoded,
-          responseClass
+          responseClass,
+          deprecated
         });
         tagToEndpointClassesRecord[tag] = (tagToEndpointClassesRecord[tag] || "") + methodImpl;
-        const [generatedMethodString, snippetMethod, snippetShell] = templateApiMethod({
+        const { generatedMethodString, snippetApiArgs, snippetMethod, snippetShell } = templateApiMethod({
           classMethod,
           description,
           httpMethod,
@@ -1383,20 +1403,21 @@ class SwaggerReaderHelpers {
           responseClass,
           classGenName,
           methodParams,
-          methodParamsNoTypes
+          methodParamsNoTypes,
+          deprecated,
+          xSecurity: endpoint["x-security"]
         });
         tagToSdkClientRecord[tag] = (tagToSdkClientRecord[tag] || "") + generatedMethodString;
         tagToSdkFunctionNamesRecord[tag] = (tagToSdkFunctionNamesRecord[tag] || "") + classMethod + ",";
         tagToSdkImportsRecord[tag] = tagToSdkImportsRecord[tag] ? [.../* @__PURE__ */ new Set([...importStatements, ...tagToSdkImportsRecord[tag]])] : [...new Set(importStatements)];
         const serviceNameTitle = ParserUtils.convertDashesToTitleCase(serviceName);
         const { apiGenName } = ParserUtils.generateApiName(tag, isAdminEndpoint);
-        const resultSnippet = templateSdkSnippet(serviceNameTitle, apiGenName, snippetMethod);
+        const resultSnippet = templateSdkSnippet({ serviceNameTitle, apiName: apiGenName, snippetMethod, snippetApiArgs });
         const currentSnippetMap = {};
         snippetMap[pathWithBase][httpMethod] = currentSnippetMap;
-        if (!isAdminEndpoint) {
-          currentSnippetMap.web = !isAdminEndpoint ? resultSnippet : "";
-          currentSnippetMap.webGit = !isAdminEndpoint ? GIT_URL + `/sdk-${sdkName}/src/generated-public/${serviceName}/${apiGenName}.ts` : "";
-        }
+        currentSnippetMap.web = resultSnippet;
+        const generatedDirName = isAdminEndpoint ? "generated-admin" : "generated-public";
+        currentSnippetMap.webGit = GIT_URL + `/sdk-${sdkName}/src/${generatedDirName}/${apiGenName}.ts`;
         currentSnippetMap.shell = snippetShell;
       }
     }