feat: new console sdk and typings

# Conflicts:
#	package-lock.json
#	package.json
This commit is contained in:
Jake Barnby committed 2024-02-19 17:22:44 +13:00
1 parent 006dd3bbf1
commit 44edd461c6
28 files changed
+109 -85

No files matched your search

+2 -2
View File
@@ -8,7 +8,7 @@
import InputDigits from '$lib/elements/forms/inputDigits.svelte';
import { addNotification } from '$lib/stores/notifications';
import { sdk } from '$lib/stores/sdk';
import { AuthenticatorProvider } from '@appwrite.io/console';
import { AuthenticatorType } from '@appwrite.io/console';
export let showDelete = false;
@@ -17,7 +17,7 @@
async function deleteProvider() {
try {
await sdk.forConsole.account.deleteAuthenticator(AuthenticatorProvider.Totp, code);
await sdk.forConsole.account.deleteAuthenticator(AuthenticatorType.Totp, code);
await invalidate(Dependencies.ACCOUNT);
await invalidate(Dependencies.FACTORS);
showDelete = false;
+8 -8
View File
@@ -8,22 +8,22 @@
import { Table, TableBody, TableCell, TableRow } from '$lib/elements/table';
import { addNotification } from '$lib/stores/notifications';
import { sdk } from '$lib/stores/sdk';
import { AuthenticatorFactor, type Models } from '@appwrite.io/console';
import { AuthenticatorType, type Models } from '@appwrite.io/console';
export let showSetup = false;
export let showRecoveryCodes = false;
let code: string;
let provider: Models.MfaProvider = null;
let type: Models.MfaType = null;
async function addAuthenticator(): Promise<URL> {
provider = await sdk.forConsole.account.addAuthenticator(AuthenticatorFactor.Totp);
type = await sdk.forConsole.account.addAuthenticator(AuthenticatorType.Totp);
return sdk.forConsole.avatars.getQR(provider.uri, 192 * 2);
return sdk.forConsole.avatars.getQR(type.uri, 192 * 2);
}
async function verifyAuthenticator() {
try {
await sdk.forConsole.account.verifyAuthenticator(AuthenticatorFactor.Totp, code);
await sdk.forConsole.account.verifyAuthenticator(AuthenticatorType.Totp, code);
await invalidate(Dependencies.ACCOUNT);
await invalidate(Dependencies.FACTORS);
showSetup = false;
@@ -72,8 +72,8 @@
description="Learn more about multi-factor authentication in our documentation."
bind:show={showRecoveryCodes}
onSubmit={verifyAuthenticator}>
{#if provider}
{@const formattedBackupCodes = provider.backups.join('\n')}
{#if type}
{@const formattedBackupCodes = type.backups.join('\n')}
<Alert type="info">
<span slot="title">
It is highly recommended to securely store your recovery codes
@@ -109,7 +109,7 @@
</div>
<Table noMargin noStyles>
<TableBody>
{#each provider.backups as code}
{#each type.backups as code}
<TableRow>
<TableCell title="code">
<Output value={code} hideCopyIcon>{code}</Output>
+1 -1
View File
@@ -2,4 +2,4 @@ import { page } from '$app/stores';
import { derived } from 'svelte/store';
import type { Models } from '@appwrite.io/console';
export const factors = derived(page, ($page) => $page.data.factors as Models.MfaProviders);
export const factors = derived(page, ($page) => $page.data.factors as Models.MfaFactors);
@@ -4,8 +4,8 @@
// TODO: fix TemplateType and TemplateLocale typing once SDK is updated
return await sdk.forConsole.projects.getEmailTemplate(
projectId,
type as TemplateType,
locale as TemplateLocale
type as EmailTemplateType,
locale as EmailTemplateLocale
);
} catch (e) {
addNotification({
@@ -19,8 +19,8 @@
// TODO: fix TemplateType and TemplateLocale typing once SDK is updated
return await sdk.forConsole.projects.getSmsTemplate(
projectId,
type as TemplateType,
locale as TemplateLocale
type as SMSTemplateType,
locale as SMSTemplateLocale
);
} catch (e) {
addNotification({
@@ -54,7 +54,12 @@
import ChangeOrganizationTierCloud from '$routes/console/changeOrganizationTierCloud.svelte';
import { wizard } from '$lib/stores/wizard';
import { BillingPlan } from '$lib/constants';
import type { TemplateLocale, TemplateType } from '@appwrite.io/console';
import type {
SMSTemplateLocale,
SMSTemplateType,
EmailTemplateType,
EmailTemplateLocale
} from '@appwrite.io/console';
const projectId = $page.params.project;
@@ -15,7 +15,7 @@
import deepEqual from 'deep-equal';
import { Submit, trackError, trackEvent } from '$lib/actions/analytics';
import { Box } from '$lib/components';
import type { TemplateLocale, TemplateType } from '@appwrite.io/console';
import type { EmailTemplateLocale, EmailTemplateType } from '@appwrite.io/console';
export let loading = false;
let openResetModal = false;
@@ -56,8 +56,8 @@
// TODO: fix TemplateType and TemplateLocale typing once SDK is updated
await sdk.forConsole.projects.updateEmailTemplate(
$project.$id,
$emailTemplate.type ? ($emailTemplate.type as TemplateType) : undefined,
$emailTemplate.locale ? ($emailTemplate.locale as TemplateLocale) : undefined,
$emailTemplate.type ? ($emailTemplate.type as EmailTemplateType) : undefined,
$emailTemplate.locale ? ($emailTemplate.locale as EmailTemplateLocale) : undefined,
$emailTemplate.subject ? $emailTemplate.subject : undefined,
$emailTemplate.message ? $emailTemplate.message : undefined,
$emailTemplate.senderName ? $emailTemplate.senderName : undefined,
@@ -4,7 +4,7 @@
import { Button } from '$lib/elements/forms';
import { addNotification } from '$lib/stores/notifications';
import { sdk } from '$lib/stores/sdk';
import type { TemplateLocale, TemplateType } from '@appwrite.io/console';
import type { EmailTemplateLocale, EmailTemplateType } from '@appwrite.io/console';
import { project } from '../../store';
import { loadEmailTemplate } from './+page.svelte';
import { baseEmailTemplate, emailTemplate } from './store';
@@ -18,8 +18,8 @@
// TODO: fix TemplateType and TemplateLocale typing once SDK is updated
await sdk.forConsole.projects.deleteEmailTemplate(
$project.$id,
$emailTemplate.type as TemplateType,
$emailTemplate.locale as TemplateLocale
$emailTemplate.type as EmailTemplateType,
$emailTemplate.locale as EmailTemplateLocale
);
$emailTemplate = await loadEmailTemplate(
$project.$id,
@@ -3,7 +3,7 @@
import { Modal } from '$lib/components';
import { Button } from '$lib/elements/forms';
import { sdk } from '$lib/stores/sdk';
import type { TemplateLocale, TemplateType } from '@appwrite.io/console';
import type { SMSTemplateLocale, SMSTemplateType } from '@appwrite.io/console';
import { project } from '../../store';
import { loadSmsTemplate } from './+page.svelte';
import { baseSmsTemplate, smsTemplate } from './store';
@@ -17,8 +17,8 @@
// TODO: fix TemplateType and TemplateLocale typing once SDK is updated
await sdk.forConsole.projects.deleteSmsTemplate(
$project.$id,
$smsTemplate.type as TemplateType,
$smsTemplate.locale as TemplateLocale
$smsTemplate.type as SMSTemplateType,
$smsTemplate.locale as SMSTemplateLocale
);
$smsTemplate = await loadSmsTemplate(
@@ -8,7 +8,7 @@
import deepEqual from 'deep-equal';
import { Submit, trackError, trackEvent } from '$lib/actions/analytics';
import { Box } from '$lib/components';
import type { TemplateLocale, TemplateType } from '@appwrite.io/console';
import type { SMSTemplateLocale, SMSTemplateType } from '@appwrite.io/console';
export let loading = false;
const projectId = $page.params.project;
@@ -39,8 +39,8 @@
// TODO: fix TemplateType and TemplateLocale typing once SDK is updated
await sdk.forConsole.projects.updateSmsTemplate(
projectId,
$smsTemplate.type as TemplateType,
$smsTemplate.locale as TemplateLocale,
$smsTemplate.type as SMSTemplateType,
$smsTemplate.locale as SMSTemplateLocale,
$smsTemplate.message
);
@@ -13,7 +13,7 @@ export const load: LayoutLoad = async ({ params, depends }) => {
header: Header,
breadcrumbs: Breadcrumbs,
user: await sdk.forProject.users.get(params.user),
userFactors: await sdk.forProject.users.listProviders(params.user)
userFactors: await sdk.forProject.users.listFactors(params.user)
};
} catch (e) {
error(e.code, e.message);
@@ -8,7 +8,7 @@
import InputDigits from '$lib/elements/forms/inputDigits.svelte';
import { addNotification } from '$lib/stores/notifications';
import { sdk } from '$lib/stores/sdk';
import { AuthenticatorProvider } from '@appwrite.io/console';
import { AuthenticatorType } from '@appwrite.io/console';
import { user } from './store';
export let showDelete = false;
@@ -18,11 +18,7 @@
async function deleteProvider() {
try {
await sdk.forConsole.users.deleteAuthenticator(
$user.$id,
AuthenticatorProvider.Totp,
''
);
await sdk.forConsole.users.deleteAuthenticator($user.$id, AuthenticatorType.Totp, '');
await invalidate(Dependencies.ACCOUNT);
await invalidate(Dependencies.FACTORS);
showDelete = false;
@@ -6,4 +6,4 @@ export const user = derived(
page,
($page) => $page.data.user as Models.User<Record<string, string>>
);
export const userFactors = derived(page, ($page) => $page.data.userFactors as Models.MfaProviders);
export const userFactors = derived(page, ($page) => $page.data.userFactors as Models.MfaFactors);
@@ -28,7 +28,7 @@
} from '$lib/elements/table';
import { toLocaleDateTime } from '$lib/helpers/date';
import { Container } from '$lib/layout';
import { MessageType, MessagingProviderType } from '@appwrite.io/console';
import { MessageStatus, MessagingProviderType } from '@appwrite.io/console';
import type { PageData } from './$types';
import CreateMessageDropdown from './createMessageDropdown.svelte';
import FailedModal from './failedModal.svelte';
@@ -141,7 +141,7 @@
<TableCellCheck
bind:selectedIds={selected}
id={message.$id}
disabled={message.status === MessageType.Processing} />
disabled={message.status === MessageStatus.Processing} />
{#each $columns as column (column.id)}
{#if column.show}
@@ -12,7 +12,7 @@
import Wizard from '../wizard.svelte';
import type { PageData } from './$types';
import { isValueOfStringEnum } from '$lib/helpers/types';
import { MessageType, MessagingProviderType } from '@appwrite.io/console';
import { MessageStatus, MessagingProviderType } from '@appwrite.io/console';
import Topics from './topics.svelte';
import Targets from './targets.svelte';
@@ -35,7 +35,7 @@
topics: $message.topics,
users: $message.users,
targets: $message.targets,
status: MessageType.Draft,
status: MessageStatus.Draft,
scheduledAt: $message.scheduledAt
};
@@ -100,19 +100,19 @@
{#if $message.providerType === MessagingProviderType.Email}
<EmailPreview
message={$message}
onEdit={$message.status === MessageType.Draft ? onEdit : null} />
onEdit={$message.status === MessageStatus.Draft ? onEdit : null} />
{:else if $message.providerType === MessagingProviderType.Sms}
<SMSPreview
message={$message}
onEdit={$message.status === MessageType.Draft ? onEdit : null} />
onEdit={$message.status === MessageStatus.Draft ? onEdit : null} />
{:else if $message.providerType === MessagingProviderType.Push}
<PushPreview
message={$message}
onEdit={$message.status === MessageType.Draft ? onEdit : null} />
onEdit={$message.status === MessageStatus.Draft ? onEdit : null} />
{/if}
<Topics topics={Object.values(data.topicsById)} />
<Targets targets={Object.values(data.targetsById)} usersById={data.usersById} />
{#if $message.status !== MessageType.Processing}
{#if $message.status !== MessageStatus.Processing}
<Delete message={$message} />
{/if}
</Container>
@@ -41,7 +41,7 @@
</TableCellText>
<TableCellText title="subscribers">
{topic.total}
{topic.smsTotal + topic.emailTotal + topic.pushTotal}
</TableCellText>
</TableRow>
{/each}
@@ -232,6 +232,7 @@
undefined,
undefined,
undefined,
undefined,
enabled
);
break;
@@ -105,6 +105,7 @@
$providerParams[$provider].password || undefined,
$providerParams[$provider].encryption,
$providerParams[$provider].autoTLS,
$providerParams[$provider].mailer || undefined,
$providerParams[$provider].fromName || undefined,
$providerParams[$provider].fromEmail,
$providerParams[$provider].replyToName || undefined,
@@ -11,7 +11,7 @@
import { CardGrid, BoxAvatar, Heading } from '$lib/components';
import { Button } from '$lib/elements/forms';
import { writable } from 'svelte/store';
import { topic } from './store';
import { topic, topicTotal } from './store';
import { goto } from '$app/navigation';
import { project } from '$routes/console/project-[project]/store';
import DeleteTopic from './deleteTopic.svelte';
@@ -31,7 +31,7 @@
<h6 class="u-bold u-trim-1">{$topic.name}</h6>
</svelte:fragment>
<p>
{$topic.total} subscriber{$topic.total === 1 ? '' : 's'}
{$topicTotal} subscriber{$topicTotal === 1 ? '' : 's'}
</p>
</BoxAvatar>
</svelte:fragment>
@@ -1,7 +1,7 @@
<script lang="ts">
import { CardGrid, Heading } from '$lib/components';
import { toLocaleDateTime } from '$lib/helpers/date';
import { topic } from './store';
import { topic, topicTotal } from './store';
</script>
<CardGrid>
@@ -11,7 +11,7 @@
<svelte:fragment slot="aside">
<div class="u-flex u-main-space-between">
<div data-private>
<p class="title">{$topic.total} subscriber{$topic.total === 1 ? '' : 's'}</p>
<p class="title">{$topicTotal} subscriber{$topicTotal === 1 ? '' : 's'}</p>
<p>Created: {toLocaleDateTime($topic.$createdAt)}</p>
</div>
</div>
@@ -7,3 +7,7 @@ export const topic = derived(
// TODO: Set actual type
($page) => $page.data.topic as Models.Topic
);
export const topicTotal = derived(
topic,
($topic) => $topic.emailTotal + $topic.smsTotal + $topic.pushTotal
);
@@ -4,7 +4,7 @@
import { sdk } from '$lib/stores/sdk';
import { Query, type Models } from '@appwrite.io/console';
import { createEventDispatcher } from 'svelte';
import { providerType } from './wizard/store';
import { providerType, getTotal } from './wizard/store';
export let show: boolean;
export let topicsById: Record<string, Models.Topic>;
@@ -98,12 +98,14 @@
checked={!!selected[topicId]}
on:change={(event) => onTopicSelection(event, topic)}>
<svelte:fragment slot="description">
<span class="title"
><span class="u-line-height-1-5">
<span class="title">
<span class="u-line-height-1-5">
<span class="body-text-2 u-bold" data-private>
{topic.name}
</span><span class="collapsible-button-optional"
>({topic.total} subscribers)</span>
</span>
<span class="collapsible-button-optional">
({getTotal(topic)} subscribers)
</span>
</span></span>
</svelte:fragment>
</InputCheckbox>
@@ -12,7 +12,7 @@
import { project } from '../store';
import { wizard } from '$lib/stores/wizard';
import { providerType, messageParams, operation } from './wizard/store';
import { ID, MessageType, MessagingProviderType, type Models } from '@appwrite.io/console';
import { ID, MessageStatus, MessagingProviderType, type Models } from '@appwrite.io/console';
import { Dependencies } from '$lib/constants';
async function create() {
@@ -81,10 +81,10 @@
wizard.hide();
let message = '';
switch (response.status) {
case MessageType.Draft:
case MessageStatus.Draft:
message = 'The message has been saved as draft.';
break;
case MessageType.Processing:
case MessageStatus.Processing:
message = 'The message is queued for processing.';
break;
case 'scheduled':
@@ -181,10 +181,10 @@
wizard.hide();
let message = '';
switch (response.status) {
case MessageType.Draft:
case MessageStatus.Draft:
message = 'The message has been saved as draft.';
break;
case MessageType.Processing:
case MessageStatus.Processing:
message = 'The message is queued for processing.';
break;
case 'scheduled':
@@ -212,7 +212,7 @@
}
async function saveDraft() {
$messageParams[$providerType].status = MessageType.Draft;
$messageParams[$providerType].status = MessageStatus.Draft;
if ($operation === 'create') {
create();
} else {
@@ -13,7 +13,7 @@
import { CustomId, Modal } from '$lib/components';
import { user } from '$lib/stores/user';
import { clickOnEnter } from '$lib/helpers/a11y';
import { ID, MessageType, MessagingProviderType } from '@appwrite.io/console';
import { ID, MessageStatus, MessagingProviderType } from '@appwrite.io/console';
import { sdk } from '$lib/stores/sdk';
let showCustomId = false;
@@ -35,7 +35,7 @@
$messageParams[MessagingProviderType.Email]?.targets || [],
undefined,
undefined,
MessageType.Processing,
MessageStatus.Processing,
$messageParams[MessagingProviderType.Email]?.html || false,
undefined
);
@@ -41,7 +41,7 @@
import { CustomId, Modal } from '$lib/components';
import { user } from '$lib/stores/user';
import { clickOnEnter } from '$lib/helpers/a11y';
import { ID, MessageType, MessagingProviderType } from '@appwrite.io/console';
import { ID, MessageStatus, MessagingProviderType } from '@appwrite.io/console';
import { sdk } from '$lib/stores/sdk';
import PushPhone from '../pushPhone.svelte';
import { onMount } from 'svelte';
@@ -76,7 +76,7 @@
undefined,
undefined,
undefined,
MessageType.Processing,
MessageStatus.Processing,
undefined
);
}
@@ -5,7 +5,7 @@
import { CustomId, Modal } from '$lib/components';
import { user } from '$lib/stores/user';
import { clickOnEnter } from '$lib/helpers/a11y';
import { ID, MessageType, MessagingProviderType } from '@appwrite.io/console';
import { ID, MessageStatus, MessagingProviderType } from '@appwrite.io/console';
import { sdk } from '$lib/stores/sdk';
import SMSPhone from '../smsPhone.svelte';
@@ -24,7 +24,7 @@
$messageParams[MessagingProviderType.Sms]?.topics || [],
$messageParams[MessagingProviderType.Sms]?.users || [],
$messageParams[MessagingProviderType.Sms]?.targets || [],
MessageType.Processing,
MessageStatus.Processing,
undefined
);
}
@@ -10,7 +10,7 @@
TableRow
} from '$lib/elements/table';
import { WizardStep } from '$lib/layout';
import { messageParams, providerType, targetsById } from './store';
import { messageParams, providerType, targetsById, getTotal } from './store';
import Actions from '../actions.svelte';
import { topicsById } from '../store';
import type { Models } from '@appwrite.io/console';
@@ -50,8 +50,9 @@
<WizardStep>
<svelte:fragment slot="title">Targets</svelte:fragment>
<!-- TODO: add support for topics -->
<svelte:fragment slot="subtitle"
>Select targets to whom this message should be directed.</svelte:fragment>
<svelte:fragment slot="subtitle">
Select targets to whom this message should be directed.
</svelte:fragment>
{#if targetIdsLength === 0 && topicIdsLength === 0}
<Card>
<div class="u-flex u-cross-center u-flex-vertical u-main-center u-flex">
@@ -83,12 +84,14 @@
<TableRow>
<TableCell title="Target">
<div class="u-flex u-cross-center">
<span class="title"
><span class="u-line-height-1-5">
<span class="title">
<span class="u-line-height-1-5">
<span class="body-text-2 u-bold" data-private>
{topic.name}
</span><span class="collapsible-button-optional"
>({topic.total} subscribers)</span>
</span>
<span class="collapsible-button-optional">
({getTotal(topic)} subscribers)
</span>
</span></span>
</div>
</TableCell>
@@ -109,8 +112,9 @@
<TableRow>
<TableCell title="Target">
<div class="u-flex u-cross-center">
<span class="text"
>{target.name ? target.name : target.identifier}</span>
<span class="text">
{target.name ? target.name : target.identifier}
</span>
</div>
</TableCell>
@@ -2,7 +2,7 @@
import { Button, FormList, InputDate, InputSelect, InputTime } from '$lib/elements/forms';
import Helper from '$lib/elements/forms/helper.svelte';
import { WizardStep } from '$lib/layout';
import { MessageType, MessagingProviderType } from '@appwrite.io/console';
import { MessageStatus, MessagingProviderType } from '@appwrite.io/console';
import { messageParams, providerType } from './store';
let when: 'now' | 'later' = 'now';
@@ -41,9 +41,9 @@
};
async function beforeSubmit() {
$messageParams[$providerType].status = MessageType.Processing;
$messageParams[$providerType].status = MessageStatus.Processing;
if (when === 'later') {
$messageParams[$providerType].status = 'scheduled' as MessageType;
$messageParams[$providerType].status = 'scheduled' as MessageStatus;
$messageParams[$providerType].scheduledAt = dateTime.toISOString();
}
}
@@ -1,12 +1,12 @@
import { MessageType, MessagingProviderType, type Models } from '@appwrite.io/console';
import { writable } from 'svelte/store';
import { MessageStatus, MessagingProviderType, type Models } from '@appwrite.io/console';
import { get, writable } from 'svelte/store';
export type MessageParams = {
messageId: string;
topics: string[];
users: string[];
targets: string[];
status: MessageType;
status: MessageStatus;
scheduledAt?: string;
};
@@ -44,3 +44,16 @@ export const messageParams = writable<{
[MessagingProviderType.Sms]: null,
[MessagingProviderType.Push]: null
});
export function getTotal(topic: Models.Topic): number {
switch (get(providerType)) {
case 'email':
return topic.emailTotal;
case 'sms':
return topic.smsTotal;
case 'push':
return topic.pushTotal;
default:
return 0;
}
}
+2 -4
View File
@@ -8,7 +8,7 @@
import { Dependencies } from '$lib/constants';
import { Submit, trackEvent, trackError } from '$lib/actions/analytics';
import { page } from '$app/stores';
import { AuthenticatorProvider } from '@appwrite.io/console';
import { AuthenticationFactor } from '@appwrite.io/console';
import InputDigits from '$lib/elements/forms/inputDigits.svelte';
let code: string, disabled: boolean;
@@ -16,9 +16,7 @@
async function verify() {
try {
disabled = true;
const challenge = await sdk.forConsole.account.createChallenge(
AuthenticatorProvider.Totp
);
const challenge = await sdk.forConsole.account.create2FAChallenge(AuthenticationFactor.Totp);
await sdk.forConsole.account.updateChallenge(challenge.$id, code);
await invalidate(Dependencies.ACCOUNT);
trackEvent(Submit.AccountCreate);