liqlAdmin in khoros aurora graphql API

yogeshdixit  We can use graphqlAdmin to give permission to normal user.

Documentation: https://developer.khoros.com/khorosauroradevdocs/docs/working-with-endpoints#endpoint-module-file

Hi saikumarn 

Thanks for the response. 

Can we do this without endpoint?

Right now looks like this is only available in endpoints. I don't remember exactly, but I think it has a bit to do with security. Running GraphQL calls as admin, like with restadmin in classic, is very dangerous and has the potential to expose sensitive data, or allow users to modify data they shouldn't.

So I think for technical reasons, at least for now, it is only available in endpoints.

Thanks for the clarification MattV 

Hi saikumarn 

I have created the endpoint using the khoros documentation.

Now when i am hitting the endpoint then it is giving 404 not found.

Folder Structure: src > endpoints > CatFact > 

1. CatFact.endpoint.json

{
  "id": "CatFact",
  "httpMethods": ["GET", "POST", "PUT"],
  "postBody": "JSON"
}

2. index.ts

import type { EndpointHandlerContext } from 'aurora/externalServerContext';
import type { RouteParameters } from 'express-serve-static-core';

interface CatFactResponse {
  message: string;
}

const API = 'https://catfact.ninja/fact';

/**
 * This endpoint calls the API at https://catfact.ninja and proxies the response.  It also logs the current request URL
 * to the plugin log.
 * @param context
 */
async function handler(context: EndpointHandlerContext<RouteParameters<string>, CatFactResponse>) {
  const {
    client: { fetch },
    server: { request, response },
    utils: { log }
  } = context;

  log.info('Handling request at', request.originalUrl);
  const apiResponse = await fetch(API);
  if (apiResponse.ok) {
    console.log('ok');
    const json = (await apiResponse.json()) as Record<string, unknown>;
    return response.json({
      message: `Cat fact: ${json.fact}`
    });
  } else {
    console.log('Error ok');
    return response.status(apiResponse.status).send({ message: 'Error!' });
  }
}

export default handler;

3. package.json

{
  "name": "@customer/cat-fact-endpoint",
  "version": "1.0.0",
  "devDependencies": {
    "@types/express": "^4.17.21",
    "@types/express-serve-static-core": "^4.17.43",
    "@types/qs": "^6.9.13"
  }
}

Could you please help me figure out where I might be making a mistake?

Thanks!

Hi saikumarn 

I have updated the package name as suggested by you, but still not working :(

Thanks!

yogeshdixit 

We can follow the steps below to troubleshoot the issue:

1.Add some logs in the handler function.
Example: log.info(`Handling request: ${request.originalUrl}`);
2.Push this endpoint to your branch and then merge it into the stage-main branch.

3.Run "npm run start:logger" to check the logs.

4.If the endpoint is still not working, request the Khoros support team to restart the community.

saikumarn 

It's working now! You're a genius!

Thank you so much for your support! 😊

Hi saikumarn 

I have a function with an axios call in a component. When hitting the endpoint, it returns a 400 Bad Request. Could you please help me understand what could be the issue?

SS => https://prnt.sc/99jxHp8AX86b

async function getBadgesUsersCat() {
    console.log('call');
    const endpoint = '/endpoints/CatFact';
    
    try {
      const response = await axios.post(endpoint);
      console.log('json', response);
    } catch (error) {
      console.error(error, 'Error fetching endpoint');
    }
  }

Also, Do you have any documentation reference that includes a mutation query for the endpoint? I am trying to update the user using graphqlAdmin, but sometimes it returns a 404 Not Found or 400 Bad Request error.

Below is my mutation code in index.ts file.

Payload of below query:

import { gql } from '@apollo/client';
import type { EndpointHandlerContext } from 'aurora/externalServerContext';
import type { RouteParameters } from 'express-serve-static-core';

interface QueryResponse {
  data: {
    addUsersToRole: {
      result?: {
        id: string;
        name: string;
      };
      errors?: {
        message: string;
      };
    };
  };
}

const ADD_USER_ROLE_MUTATION = gql`
  mutation addUsersToRole($roleKey: RoleKeyInput!, $users: [UserIdInput!]!) {
    addUsersToRole(roleKey: $roleKey, users: $users) {
      result {
        id
        name
        description
      }
      errors {
        ... on GreaterThanMaxValueError {
          key
          fields
          max
          message
        }
      }
    }
  }
`;

async function handler(context: EndpointHandlerContext<RouteParameters<string>>) {
  const {
    client: { graphql },
    server: { request, response },
    utils: { log }
  } = context;

  try {
    // Parse the request body
    const { body } = request;

    // Log the received data
    log.info('Handling request to assign a role to a user', body);

    // {"roleKey":{"roleName":"Test AMA Adventurer"},"users":[{"id":"user:12"}]}

    // Send the parsed body data back as JSON
    // Execute the mutation
    const queryResponse: QueryResponse = await graphql.query({
      query: ADD_USER_ROLE_MUTATION,
      variables: { body }
    });

    response.json(queryResponse);
  } catch (error) {
    log.error('Error while handling the request', error);
  }
}

export default handler;

Thanks in Advance!