- Migrated developer docs to Twenty website - Modified User Guide and Docs layout to include sections and subsections **Section Example:** <img width="549" alt="Screenshot 2024-05-30 at 15 44 42" src="https://github.com/twentyhq/twenty/assets/102751374/41bd4037-4b76-48e6-bc79-48d3d6be9ab8"> **Subsection Example:** <img width="557" alt="Screenshot 2024-05-30 at 15 44 55" src="https://github.com/twentyhq/twenty/assets/102751374/f14c65a9-ab0c-4530-b624-5b20fc00511a"> - Created different components (Tabs, Tables, Editors etc.) for the mdx files **Tabs & Editor** <img width="665" alt="Screenshot 2024-05-30 at 15 47 39" src="https://github.com/twentyhq/twenty/assets/102751374/5166b5c7-b6cf-417d-9f29-b1f674c1c531"> **Tables** <img width="698" alt="Screenshot 2024-05-30 at 15 57 39" src="https://github.com/twentyhq/twenty/assets/102751374/2bbfe937-ec19-4004-ab00-f7a56e96db4a"> <img width="661" alt="Screenshot 2024-05-30 at 16 03 32" src="https://github.com/twentyhq/twenty/assets/102751374/ae95b47c-dd92-44f9-b535-ccdc953f71ff"> - Created a crawler for Twenty Developers (now that it will be on the twenty website). Once this PR is merged and the website is re-deployed, we need to start crawling and make sure the index name is ‘twenty-developer’ - Added a dropdown menu in the header to access User Guide and Developers + added Developers to footer https://github.com/twentyhq/twenty/assets/102751374/1bd1fbbd-1e65-4461-b18b-84d4ddbb8ea1 - Made new layout responsive Please fill in the information for each mdx file so that it can appear on its card, as well as in the ‘In this article’ section. Example with ‘Getting Started’ in the User Guide: <img width="786" alt="Screenshot 2024-05-30 at 16 29 39" src="https://github.com/twentyhq/twenty/assets/102751374/2714b01d-a664-4ddc-9291-528632ee12ea"> Example with info and sectionInfo filled in for 'Getting Started': <img width="620" alt="Screenshot 2024-05-30 at 16 33 57" src="https://github.com/twentyhq/twenty/assets/102751374/bc69e880-da6a-4b7e-bace-1effea866c11"> Please keep in mind that the images that are being used for Developers are the same as those found in User Guide and may not match the article. --------- Co-authored-by: Félix Malfait <felix.malfait@gmail.com>
201 lines
5.7 KiB
TypeScript
201 lines
5.7 KiB
TypeScript
import React, { useEffect, useState } from 'react';
|
|
import { TbApi, TbChevronLeft, TbLink } from 'react-icons/tb';
|
|
import { useHistory, useLocation } from '@docusaurus/router';
|
|
import { parseJson } from 'nx/src/utils/json';
|
|
|
|
import tokenForm from '!css-loader!./token-form.css';
|
|
|
|
export type SubDoc = 'core' | 'metadata';
|
|
export type TokenFormProps = {
|
|
setOpenApiJson?: (json: object) => void;
|
|
setToken?: (token: string) => void;
|
|
setBaseUrl?: (baseUrl: string) => void;
|
|
isTokenValid?: boolean;
|
|
setIsTokenValid?: (boolean) => void;
|
|
setLoadingState?: (boolean) => void;
|
|
subDoc?: SubDoc;
|
|
};
|
|
|
|
const TokenForm = ({
|
|
setOpenApiJson,
|
|
setToken,
|
|
setBaseUrl: submitBaseUrl,
|
|
isTokenValid,
|
|
setIsTokenValid,
|
|
subDoc,
|
|
setLoadingState,
|
|
}: TokenFormProps) => {
|
|
const history = useHistory();
|
|
const location = useLocation();
|
|
const [isLoading, setIsLoading] = useState(false);
|
|
const [locationSetting, setLocationSetting] = useState(
|
|
parseJson(localStorage.getItem('baseUrl'))?.locationSetting ?? 'production',
|
|
);
|
|
const [baseUrl, setBaseUrl] = useState(
|
|
parseJson(localStorage.getItem('baseUrl'))?.baseUrl ??
|
|
'https://api.twenty.com',
|
|
);
|
|
const token =
|
|
parseJson(localStorage.getItem('TryIt_securitySchemeValues'))?.bearerAuth ??
|
|
'';
|
|
|
|
const updateLoading = (loading: boolean) => {
|
|
setIsLoading(loading);
|
|
setLoadingState(loading);
|
|
};
|
|
|
|
const updateToken = async (event: React.ChangeEvent<HTMLInputElement>) => {
|
|
localStorage.setItem(
|
|
'TryIt_securitySchemeValues',
|
|
JSON.stringify({ bearerAuth: event.target.value }),
|
|
);
|
|
await submitToken(event.target.value);
|
|
};
|
|
|
|
const updateBaseUrl = (baseUrl: string, locationSetting: string) => {
|
|
let url: string;
|
|
if (locationSetting === 'production') {
|
|
url = 'https://api.twenty.com';
|
|
} else if (locationSetting === 'demo') {
|
|
url = 'https://api-demo.twenty.com';
|
|
} else if (locationSetting === 'localhost') {
|
|
url = 'http://localhost:3000';
|
|
} else {
|
|
url = baseUrl?.endsWith('/')
|
|
? baseUrl.substring(0, baseUrl.length - 1)
|
|
: baseUrl;
|
|
}
|
|
|
|
setBaseUrl(url);
|
|
setLocationSetting(locationSetting);
|
|
submitBaseUrl?.(url);
|
|
localStorage.setItem(
|
|
'baseUrl',
|
|
JSON.stringify({ baseUrl: url, locationSetting }),
|
|
);
|
|
};
|
|
|
|
const validateToken = (openApiJson) => {
|
|
setIsTokenValid(!!openApiJson.tags);
|
|
};
|
|
|
|
const getJson = async (token: string) => {
|
|
updateLoading(true);
|
|
|
|
return await fetch(baseUrl + '/open-api/' + (subDoc ?? 'core'), {
|
|
headers: { Authorization: `Bearer ${token}` },
|
|
})
|
|
.then((res) => res.json())
|
|
.then((result) => {
|
|
validateToken(result);
|
|
updateLoading(false);
|
|
|
|
return result;
|
|
})
|
|
.catch(() => {
|
|
updateLoading(false);
|
|
setIsTokenValid(false);
|
|
});
|
|
};
|
|
|
|
const submitToken = async (token) => {
|
|
if (isLoading) return;
|
|
|
|
const json = await getJson(token);
|
|
|
|
setToken && setToken(token);
|
|
|
|
setOpenApiJson && setOpenApiJson(json);
|
|
};
|
|
|
|
useEffect(() => {
|
|
(async () => {
|
|
updateBaseUrl(baseUrl, locationSetting);
|
|
await submitToken(token);
|
|
})();
|
|
}, []);
|
|
|
|
// We load playground style using useEffect as it breaks remaining docs style
|
|
useEffect(() => {
|
|
const styleElement = document.createElement('style');
|
|
styleElement.innerHTML = tokenForm.toString();
|
|
document.head.append(styleElement);
|
|
|
|
return () => styleElement.remove();
|
|
}, []);
|
|
|
|
return (
|
|
<div className="form-container">
|
|
<form className="form">
|
|
<div className="backButton" onClick={() => history.goBack()}>
|
|
<TbChevronLeft size={18} />
|
|
<span>Back</span>
|
|
</div>
|
|
<div className="inputWrapper">
|
|
<select
|
|
className="select"
|
|
onChange={(event) => {
|
|
updateBaseUrl(baseUrl, event.target.value);
|
|
}}
|
|
value={locationSetting}
|
|
>
|
|
<option value="production">Production API</option>
|
|
<option value="demo">Demo API</option>
|
|
<option value="localhost">Localhost</option>
|
|
<option value="other">Other</option>
|
|
</select>
|
|
</div>
|
|
<div className="inputWrapper">
|
|
<div className="inputIcon" title="Base URL">
|
|
<TbLink size={20} />
|
|
</div>
|
|
<input
|
|
className={'input'}
|
|
type="text"
|
|
readOnly={isLoading}
|
|
disabled={locationSetting !== 'other'}
|
|
placeholder="Base URL"
|
|
value={baseUrl}
|
|
onChange={(event) =>
|
|
updateBaseUrl(event.target.value, locationSetting)
|
|
}
|
|
onBlur={() => submitToken(token)}
|
|
/>
|
|
</div>
|
|
<div className="inputWrapper">
|
|
<div className="inputIcon" title="Api Key">
|
|
<TbApi size={20} />
|
|
</div>
|
|
<input
|
|
className={!isTokenValid && !isLoading ? 'input invalid' : 'input'}
|
|
type="text"
|
|
readOnly={isLoading}
|
|
placeholder="API Key"
|
|
defaultValue={token}
|
|
onChange={updateToken}
|
|
/>
|
|
</div>
|
|
<div className="inputWrapper" style={{ maxWidth: '100px' }}>
|
|
<select
|
|
className="select"
|
|
onChange={(event) =>
|
|
history.replace(
|
|
'/' +
|
|
location.pathname.split('/').at(-2) +
|
|
'/' +
|
|
event.target.value,
|
|
)
|
|
}
|
|
value={location.pathname.split('/').at(-1)}
|
|
>
|
|
<option value="core">Core</option>
|
|
<option value="metadata">Metadata</option>
|
|
</select>
|
|
</div>
|
|
</form>
|
|
</div>
|
|
);
|
|
};
|
|
|
|
export default TokenForm;
|