Docs powered by Archbee

Application React

1 min

L'application React se lance via une fonction start. La signature de cette fonction est :

type AppConfig = {
  app: () => ReactNode;
  ctx?: 'local-storage' | 'session-storage' | 'shadow-crm' | 'url' | { token: string } | { projectId: string };
  errorPages?: ErrorPages;
  processFragment: DocumentNode;
  redirectOnError: boolean;
  rootElementId?: string;
  customHandlers?: Record<string, unknown>;
};

export const start: (config: AppConfig) => Promise<void>;

La description des paramètres de la fonction start est :

app : composant React racine de votre application ;

ctx : paramètre indiquant où lire le contexte de l'OAV (token et projectId). Les valeurs possibles sont local-storage, session-storage, shadow-crm, url ou un objet possédant l'une des propriétés token ou projectId. La valeur par défaut est url. L'URL est toujours utilisée comme dernier recours pour la récupération du contexte.

local-storage : récupération du token via la clé ctxToken et récupération du projectId via la clé fasstProjectId ;

session-storage : récupération du token via la clé ctxToken et récupération duprojectId via la clé fasstProjectId ;

shadow-crm : récupération du contexte via le service shadow-crm ;

errorPages : objet définissant les composants React à afficher en cas d'erreur. Si aucun composant React n'est défini pour une erreur, un message par défaut est affiché. Ces composants ne sont utilisés que si la propriété redirectOnError est activée.

badRequestPage : composant React utilisé pour la page /bad-request ; message par défaut : Bad Request ;

unauthorizedPage : composant React utilisé pour la page /unauthorized ; message par défaut : Unauthorized ;

forbiddenPage : composant React utilisé pour la page /forbidden ; message par défaut : Forbidden ;

notFoundPage : composant React utilisé pour la page /not-found ; message par défaut : Not Found ;

internalServerErrorPage : composant React utilisé pour la page /internal-server-error ; message par défaut : Internal Server Error ;

processFragment : fragment GraphQL correspondant à l'objet process ;

redirectOnError : valeur booléenne indiquant si une redirection doit être effectuée lors d'une erreur au niveau de la couche GraphQL ; valeur par défaut : true. Si cette option est activée, les redirections suivantes sont définies :

Si erreur 400, redirection vers /bad-request ;

Si erreur 401, redirection vers /unauthorized ;

Si erreur 403, redirection vers /forbidden ;

Si erreur 404, redirection vers /not-found ;

Si erreur 500, redirection vers /internal-server-error ;

rootElementId : identifiant de l'élément HTML auquel attacher l'application React ; valeur par défaut : fasst-oav-root.

customHandlers : objet contenant des handlers additionnels à attacher à l'objet ProcessProvider.

Docs powered by Archbee