LogalDeveloper/owncast
0
Fork 0
Code Activity

Make access token and webhooks buttons look correct

Browse Source
This commit is contained in:
Gabe Kangas
2021-02-10 00:17:16 -08:00
parent 64b41c4a57
commit 8484baac28
2 changed files with 366 additions and 299 deletions
Download Patch File Download Diff File Expand all files Collapse all files

98
web/pages/access-tokens.tsx
View File

@@ -1,21 +1,28 @@
import React, { useState, useEffect } from "react";
import React, { useState, useEffect } from 'react';
import { Table, Tag, Space, Button, Modal, Checkbox, Input, Typography, Tooltip } from 'antd';
import { DeleteOutlined, EyeTwoTone, EyeInvisibleOutlined } from '@ant-design/icons';
const { Title, Paragraph, Text } = Typography;
import format from 'date-fns/format'
import format from 'date-fns/format';
import {
fetchData,
ACCESS_TOKENS,
DELETE_ACCESS_TOKEN,
CREATE_ACCESS_TOKEN,
} from "../utils/apis";
import { fetchData, ACCESS_TOKENS, DELETE_ACCESS_TOKEN, CREATE_ACCESS_TOKEN } from '../utils/apis';
const availableScopes = {
'CAN_SEND_SYSTEM_MESSAGES': { name: 'System messages', description: 'You can send official messages on behalf of the system', color: 'purple' },
'CAN_SEND_MESSAGES': { name: 'User chat messages', description: 'You can send messages on behalf of a username', color: 'green' },
'HAS_ADMIN_ACCESS': { name: 'Has admin access', description: 'Can perform administrative actions such as moderation, get server statuses, etc', color: 'red' },
CAN_SEND_SYSTEM_MESSAGES: {
name: 'System messages',
description: 'You can send official messages on behalf of the system',
color: 'purple',
},
CAN_SEND_MESSAGES: {
name: 'User chat messages',
description: 'You can send messages on behalf of a username',
color: 'green',
},
HAS_ADMIN_ACCESS: {
name: 'Has admin access',
description: 'Can perform administrative actions such as moderation, get server statuses, etc',
color: 'red',
},
};
function convertScopeStringToTag(scopeString) {
@@ -27,9 +34,7 @@ function convertScopeStringToTag(scopeString) {
return (
<Tooltip key={scopeString} title={scope.description}>
<Tag color={scope.color} >
{scope.name}
</Tag>
<Tag color={scope.color}>{scope.name}</Tag>
</Tooltip>
);
}
@@ -39,7 +44,7 @@ function NewTokenModal(props) {
const [name, setName] = useState('');
const scopes = Object.keys(availableScopes).map(function (key) {
return { value: key, label: availableScopes[key].description }
return { value: key, label: availableScopes[key].description };
});
function onChange(checkedValues) {
@@ -55,7 +60,7 @@ function NewTokenModal(props) {
}
const okButtonProps = {
disabled: selectedScopes.length === 0 || name === ''
disabled: selectedScopes.length === 0 || name === '',
};
function selectAll() {
@@ -63,16 +68,30 @@ function NewTokenModal(props) {
}
return (
<Modal title="Create New Access token" visible={props.visible} onOk={saveToken} onCancel={props.onCancel} okButtonProps={okButtonProps}>
<p><Input value={name} placeholder="Access token name/description" onChange={(input) => setName(input.currentTarget.value)} /></p>
<Modal
title="Create New Access token"
visible={props.visible}
onOk={saveToken}
onCancel={props.onCancel}
okButtonProps={okButtonProps}
>
<p>
<Input
value={name}
placeholder="Access token name/description"
onChange={input => setName(input.currentTarget.value)}
/>
</p>
<p>
Select the permissions this access token will have. It cannot be edited after it's created.
</p>
<Checkbox.Group options={scopes} value={selectedScopes} onChange={onChange} />
<Button onClick={selectAll}>Select all</Button>
<Button type="text" size="small" onClick={selectAll}>
Select all
</Button>
</Modal>
)
);
}
export default function AccessTokens() {
@@ -87,7 +106,7 @@ export default function AccessTokens() {
<Space size="middle">
<Button onClick={() => handleDeleteToken(record.token)} icon={<DeleteOutlined />} />
</Space>
)
),
},
{
title: 'Name',
@@ -98,9 +117,7 @@ export default function AccessTokens() {
title: 'Token',
dataIndex: 'token',
key: 'token',
render: (text, record) => (
<Input.Password size="small" bordered={false} value={text} />
)
render: (text, record) => <Input.Password size="small" bordered={false} value={text} />,
},
{
title: 'Scopes',
@@ -118,7 +135,7 @@ export default function AccessTokens() {
title: 'Last Used',
dataIndex: 'lastUsed',
key: 'lastUsed',
render: (lastUsed) => {
render: lastUsed => {
if (!lastUsed) {
return 'Never';
}
@@ -143,7 +160,10 @@ export default function AccessTokens() {
async function handleDeleteToken(token) {
try {
const result = await fetchData(DELETE_ACCESS_TOKEN, { method: 'POST', data: { token: token } });
const result = await fetchData(DELETE_ACCESS_TOKEN, {
method: 'POST',
data: { token: token },
});
getAccessTokens();
} catch (error) {
handleError(error);
@@ -152,7 +172,10 @@ export default function AccessTokens() {
async function handleSaveToken(name: string, scopes: string[]) {
try {
const newToken = await fetchData(CREATE_ACCESS_TOKEN, { method: 'POST', data: { name: name, scopes: scopes } });
const newToken = await fetchData(CREATE_ACCESS_TOKEN, {
method: 'POST',
data: { name: name, scopes: scopes },
});
setTokens(tokens.concat(newToken));
} catch (error) {
handleError(error);
@@ -160,7 +183,7 @@ export default function AccessTokens() {
}
function handleError(error) {
console.error("error", error);
console.error('error', error);
alert(error);
}
@@ -181,16 +204,25 @@ export default function AccessTokens() {
<div>
<Title>Access Tokens</Title>
<Paragraph>
Access tokens are used to allow external, 3rd party tools to perform specific actions on your Owncast server.
They should be kept secure and never included in client code, instead they should be kept on a server that you control.
Access tokens are used to allow external, 3rd party tools to perform specific actions on
your Owncast server. They should be kept secure and never included in client code, instead
they should be kept on a server that you control.
</Paragraph>
<Paragraph>
Read more about how to use these tokens, with examples, at <a href="https://owncast.online/docs/integrations/">our documentation</a>.
Read more about how to use these tokens, with examples, at{' '}
<a href="https://owncast.online/docs/integrations/">our documentation</a>.
</Paragraph>
<Table rowKey="token" columns={columns} dataSource={tokens} pagination={false} />
<Button onClick={showCreateTokenModal}>Create Access Token</Button>
<NewTokenModal visible={isTokenModalVisible} onOk={handleTokenModalSaveButton} onCancel={handleTokenModalCancel} />
<br />
<Button type="primary" onClick={showCreateTokenModal}>
Create Access Token
</Button>
<NewTokenModal
visible={isTokenModalVisible}
onOk={handleTokenModalSaveButton}
onCancel={handleTokenModalCancel}
/>
</div>
);
}

109
web/pages/webhooks.tsx
View File

@@ -1,28 +1,41 @@
import React, { useState, useEffect } from "react";
import { Table, Tag, Space, Button, Modal, Checkbox, Input, Typography, Tooltip, Select } from 'antd';
import React, { useState, useEffect } from 'react';
import {
Table,
Tag,
Space,
Button,
Modal,
Checkbox,
Input,
Typography,
Tooltip,
Select,
} from 'antd';
import { DeleteOutlined, EyeTwoTone, EyeInvisibleOutlined } from '@ant-design/icons';
import { isValidUrl } from '../utils/urls';
const { Title, Paragraph, Text } = Typography;
const { Option } = Select;
import format from 'date-fns/format'
import format from 'date-fns/format';
import {
fetchData,
DELETE_WEBHOOK,
CREATE_WEBHOOK,
WEBHOOKS,
} from "../utils/apis";
import { fetchData, DELETE_WEBHOOK, CREATE_WEBHOOK, WEBHOOKS } from '../utils/apis';
const availableEvents = {
'CHAT': { name: 'Chat messages', description: 'When a user sends a chat message', color: 'purple' },
'USER_JOINED': { name: 'User joined', description: 'When a user joins the chat', color: 'green'},
'NAME_CHANGE': { name: 'User name changed', description: 'When a user changes their name', color: 'blue'},
'VISIBILITY-UPDATE': { name: 'Message visibility changed', description: 'When a message visibility changes, likely due to moderation', color: 'red'},
'STREAM_STARTED': {name: 'Stream started', description: 'When a stream starts', color: 'orange'},
'STREAM_STOPPED': {name: 'Stream stopped', description: 'When a stream stops', color: 'cyan'}
CHAT: { name: 'Chat messages', description: 'When a user sends a chat message', color: 'purple' },
USER_JOINED: { name: 'User joined', description: 'When a user joins the chat', color: 'green' },
NAME_CHANGE: {
name: 'User name changed',
description: 'When a user changes their name',
color: 'blue',
},
'VISIBILITY-UPDATE': {
name: 'Message visibility changed',
description: 'When a message visibility changes, likely due to moderation',
color: 'red',
},
STREAM_STARTED: { name: 'Stream started', description: 'When a stream starts', color: 'orange' },
STREAM_STOPPED: { name: 'Stream stopped', description: 'When a stream stops', color: 'cyan' },
};
function convertEventStringToTag(eventString) {
@@ -34,9 +47,7 @@ function convertEventStringToTag(eventString) {
return (
<Tooltip key={eventString} title={event.description}>
<Tag color={event.color} >
{event.name}
</Tag>
<Tag color={event.color}>{event.name}</Tag>
</Tooltip>
);
}
@@ -46,10 +57,9 @@ function NewWebhookModal(props) {
const [webhookUrl, setWebhookUrl] = useState('');
const events = Object.keys(availableEvents).map(function (key) {
return { value: key, label: availableEvents[key].description }
return { value: key, label: availableEvents[key].description };
});
function onChange(checkedValues) {
setSelectedEvents(checkedValues);
}
@@ -59,7 +69,7 @@ function NewWebhookModal(props) {
}
function save() {
props.onOk(webhookUrl, selectedEvents)
props.onOk(webhookUrl, selectedEvents);
// Reset the modal
setWebhookUrl('');
@@ -67,20 +77,32 @@ function NewWebhookModal(props) {
}
const okButtonProps = {
disabled: selectedEvents?.length === 0 || !isValidUrl(webhookUrl)
disabled: selectedEvents?.length === 0 || !isValidUrl(webhookUrl),
};
return (
<Modal title="Create New Webhook" visible={props.visible} onOk={save} onCancel={props.onCancel} okButtonProps={okButtonProps}>
<div><Input value={webhookUrl} placeholder="https://myserver.com/webhook" onChange={(input) => setWebhookUrl(input.currentTarget.value)} /></div>
<Modal
title="Create New Webhook"
visible={props.visible}
onOk={save}
onCancel={props.onCancel}
okButtonProps={okButtonProps}
>
<div>
<Input
value={webhookUrl}
placeholder="https://myserver.com/webhook"
onChange={input => setWebhookUrl(input.currentTarget.value)}
/>
</div>
<p>
Select the events that will be sent to this webhook.
</p>
<p>Select the events that will be sent to this webhook.</p>
<Checkbox.Group options={events} value={selectedEvents} onChange={onChange} />
<Button onClick={selectAll}>Select all</Button>
<Button type="text" size="small" onClick={selectAll}>
Select all
</Button>
</Modal>
)
);
}
export default function Webhooks() {
@@ -95,7 +117,7 @@ export default function Webhooks() {
<Space size="middle">
<Button onClick={() => handleDelete(record.id)} icon={<DeleteOutlined />} />
</Space>
)
),
},
{
title: 'URL',
@@ -140,7 +162,10 @@ export default function Webhooks() {
async function handleSave(url: string, events: string[]) {
try {
const newHook = await fetchData(CREATE_WEBHOOK, { method: 'POST', data: { url: url, events: events } });
const newHook = await fetchData(CREATE_WEBHOOK, {
method: 'POST',
data: { url: url, events: events },
});
setWebhooks(webhooks.concat(newHook));
} catch (error) {
handleError(error);
@@ -148,7 +173,7 @@ export default function Webhooks() {
}
function handleError(error) {
console.error("error", error);
console.error('error', error);
alert(error);
}
@@ -169,15 +194,25 @@ export default function Webhooks() {
<div>
<Title>Webhooks</Title>
<Paragraph>
A webhook is a callback made to an external API in response to an event. These are endpoints that live outside of Owncast and run code who wants to be made aware of events that take place on your server.
A webhook is a callback made to an external API in response to an event. These are endpoints
that live outside of Owncast and run code who wants to be made aware of events that take
place on your server.
</Paragraph>
<Paragraph>
Read more about how to use webhooks, with examples, at <a href="https://owncast.online/docs/integrations/">our documentation</a>.
Read more about how to use webhooks, with examples, at{' '}
<a href="https://owncast.online/docs/integrations/">our documentation</a>.
</Paragraph>
<Table rowKey="id" columns={columns} dataSource={webhooks} pagination={false} />
<Button onClick={showCreateModal}>Create Webhook</Button>
<NewWebhookModal visible={isModalVisible} onOk={handleModalSaveButton} onCancel={handleModalCancelButton} />
<br />
<Button type="primary" onClick={showCreateModal}>
Create Webhook
</Button>
<NewWebhookModal
visible={isModalVisible}
onOk={handleModalSaveButton}
onCancel={handleModalCancelButton}
/>
</div>
);
}