2 Commits
Author SHA1 Message Date
Maurus Decimus dc462b137f Sievepad integration 2026-09-15 09:27:02 +02:00
Maurus Decimus b0b8e4e090 v1.0.10 2026-09-04 10:16:53 +02:00
11 changed files with 454 additions and 25 deletions
+18
View File
@@ -2,6 +2,24 @@
All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).
## [1.0.11] - 2026-09-15
### Added
- Sievepad integration.
### Changed
### Fixed
## [1.0.10] - 2026-09-04
### Added
### Changed
### Fixed
- Re-added map entries and object list items are seeded with their schema defaults, including a value for every non-nullable boolean.
## [1.0.9] - 2026-08-24 ## [1.0.9] - 2026-08-24
### Added ### Added
+1 -1
View File
@@ -1,7 +1,7 @@
{ {
"name": "stalwart-webui", "name": "stalwart-webui",
"private": true, "private": true,
"version": "1.0.9", "version": "1.0.11",
"description": "Stalwart WebUI", "description": "Stalwart WebUI",
"type": "module", "type": "module",
"scripts": { "scripts": {
+11 -3
View File
@@ -26,12 +26,20 @@ export function EnterpriseUpsell({ open, onClose }: EnterpriseUpsellProps) {
return ( return (
<Dialog open={open} onOpenChange={(isOpen) => !isOpen && onClose()}> <Dialog open={open} onOpenChange={(isOpen) => !isOpen && onClose()}>
<DialogContent> <DialogContent className="gap-6">
<DialogHeader> <DialogHeader className="space-y-4">
<DialogTitle>{t('enterprise.trialTitle')}</DialogTitle> <DialogTitle>{t('enterprise.trialTitle')}</DialogTitle>
<DialogDescription>{t('enterprise.trialDescription')}</DialogDescription> <DialogDescription>{t('enterprise.trialDescription')}</DialogDescription>
</DialogHeader> </DialogHeader>
<DialogFooter> <DialogFooter className="gap-2 sm:items-center">
<a
href="https://stalw.art/compare#why-isnt-feature-x-open-source"
target="_blank"
rel="noopener noreferrer"
className="text-center text-xs text-muted-foreground underline-offset-4 hover:underline sm:mr-auto sm:text-left"
>
{t('enterprise.whyNotFree')}
</a>
<Button variant="outline" onClick={onClose}> <Button variant="outline" onClick={onClose}>
{t('common.close')} {t('common.close')}
</Button> </Button>
+5
View File
@@ -53,6 +53,7 @@ import { SECRET_MASK } from '@/lib/jmapUtils';
import { toast } from '@/hooks/use-toast'; import { toast } from '@/hooks/use-toast';
import { logFormChange } from '@/lib/debug'; import { logFormChange } from '@/lib/debug';
import { FieldWidget } from '@/components/forms/FieldWidget'; import { FieldWidget } from '@/components/forms/FieldWidget';
import { isSieveScriptField } from '@/lib/sievepad';
import type { Field, Fields, Form, FormField, Schema } from '@/types/schema'; import type { Field, Fields, Form, FormField, Schema } from '@/types/schema';
import type { JmapSetResponse, JmapSetError, JmapMethodCall } from '@/types/jmap'; import type { JmapSetResponse, JmapSetError, JmapMethodCall } from '@/types/jmap';
@@ -740,6 +741,7 @@ export function DynamicForm({ viewName, objectId }: DynamicFormProps) {
})(); })();
const sectionsToRender = buildSections(combinedForm, currentFields, isCreate, edition); const sectionsToRender = buildSections(combinedForm, currentFields, isCreate, edition);
const scriptName = typeof formData.name === 'string' ? formData.name : '';
return ( return (
<div className="mx-auto max-w-4xl space-y-6"> <div className="mx-auto max-w-4xl space-y-6">
@@ -810,6 +812,9 @@ export function DynamicForm({ viewName, objectId }: DynamicFormProps) {
readOnly={fieldReadOnly} readOnly={fieldReadOnly}
error={fieldError} error={fieldError}
schema={schema} schema={schema}
sieveScriptName={
isSieveScriptField(resolved.obj.objectName, formField.name) ? scriptName : undefined
}
/> />
); );
+19 -20
View File
@@ -8,7 +8,6 @@ import { useState, useEffect, useMemo, type KeyboardEvent } from 'react';
import { useTranslation } from 'react-i18next'; import { useTranslation } from 'react-i18next';
import { useBufferedValue, useResetOnChange } from '@/hooks/useBufferedValue'; import { useBufferedValue, useResetOnChange } from '@/hooks/useBufferedValue';
import ReactMarkdown from 'react-markdown'; import ReactMarkdown from 'react-markdown';
import { Input } from '@/components/ui/input'; import { Input } from '@/components/ui/input';
import { Textarea } from '@/components/ui/textarea'; import { Textarea } from '@/components/ui/textarea';
import { Button } from '@/components/ui/button'; import { Button } from '@/components/ui/button';
@@ -21,14 +20,11 @@ import { Tooltip, TooltipContent, TooltipProvider, TooltipTrigger } from '@/comp
import { Popover, PopoverContent, PopoverTrigger } from '@/components/ui/popover'; import { Popover, PopoverContent, PopoverTrigger } from '@/components/ui/popover';
import { Combobox, type ComboboxOption } from '@/components/ui/combobox'; import { Combobox, type ComboboxOption } from '@/components/ui/combobox';
import { Calendar } from '@/components/ui/calendar'; import { Calendar } from '@/components/ui/calendar';
import { Plus, X, Eye, EyeOff, Loader2, Search, Check, ChevronRight, Calendar as CalendarIcon } from 'lucide-react'; import { Plus, X, Eye, EyeOff, Loader2, Search, Check, ChevronRight, Calendar as CalendarIcon } from 'lucide-react';
import { Collapsible, CollapsibleContent, CollapsibleTrigger } from '@/components/ui/collapsible'; import { Collapsible, CollapsibleContent, CollapsibleTrigger } from '@/components/ui/collapsible';
import { ExpressionEditor } from '@/components/expression/ExpressionEditor'; import { ExpressionEditor } from '@/components/expression/ExpressionEditor';
import { OtpAuthField } from '@/components/forms/OtpAuthField'; import { OtpAuthField } from '@/components/forms/OtpAuthField';
import { SievepadButton } from '@/components/forms/SievepadButton';
import { import {
bytesToHuman, bytesToHuman,
humanToBytes, humanToBytes,
@@ -39,7 +35,13 @@ import {
SIZE_UNITS, SIZE_UNITS,
DURATION_UNITS, DURATION_UNITS,
} from '@/lib/durationFormat'; } from '@/lib/durationFormat';
import { resolveSchema, resolveVariantForm, resolveObject, buildEmbeddedDefaults } from '@/lib/schemaResolver'; import {
resolveSchema,
resolveVariantForm,
resolveObject,
buildEmbeddedDefaults,
buildNewObjectValue,
} from '@/lib/schemaResolver';
import { cn } from '@/lib/utils'; import { cn } from '@/lib/utils';
import { useAccountStore } from '@/stores/accountStore'; import { useAccountStore } from '@/stores/accountStore';
import { useEffectiveEdition } from '@/components/forms/FormEditionContext'; import { useEffectiveEdition } from '@/components/forms/FormEditionContext';
@@ -58,6 +60,7 @@ export interface FieldWidgetProps {
readOnly: boolean; readOnly: boolean;
error?: string; error?: string;
schema: Schema; schema: Schema;
sieveScriptName?: string;
} }
function getRequiredMarker(field: Field, readOnly: boolean): 'required' | 'optional' | null { function getRequiredMarker(field: Field, readOnly: boolean): 'required' | 'optional' | null {
@@ -78,7 +81,7 @@ function getRequiredMarker(field: Field, readOnly: boolean): 'required' | 'optio
export function FieldWidget(props: FieldWidgetProps) { export function FieldWidget(props: FieldWidgetProps) {
const { t } = useTranslation(); const { t } = useTranslation();
const { field, formField, value, onChange, readOnly, error, schema } = props; const { field, formField, value, onChange, readOnly, error, schema, sieveScriptName } = props;
const ft = field.type; const ft = field.type;
const edition = useEffectiveEdition(); const edition = useEffectiveEdition();
@@ -131,7 +134,7 @@ export function FieldWidget(props: FieldWidgetProps) {
/> />
); );
case 'blobId': case 'blobId':
return <BlobField value={value} onChange={onChange} readOnly={readOnly} />; return <BlobField value={value} onChange={onChange} readOnly={readOnly} sieveScriptName={sieveScriptName} />;
case 'objectId': case 'objectId':
return ( return (
<ObjectIdField <ObjectIdField
@@ -235,6 +238,9 @@ export function FieldWidget(props: FieldWidgetProps) {
</div> </div>
)} )}
{widget} {widget}
{sieveScriptName !== undefined && ft.type === 'string' && (
<SievepadButton scriptName={sieveScriptName} source={typeof value === 'string' ? value : ''} />
)}
{error && <p className="text-xs text-destructive">{error}</p>} {error && <p className="text-xs text-destructive">{error}</p>}
</div> </div>
); );
@@ -985,9 +991,10 @@ interface BlobFieldProps {
value: unknown; value: unknown;
onChange: (value: unknown) => void; onChange: (value: unknown) => void;
readOnly: boolean; readOnly: boolean;
sieveScriptName?: string;
} }
function BlobField({ value, onChange, readOnly }: BlobFieldProps) { function BlobField({ value, onChange, readOnly, sieveScriptName }: BlobFieldProps) {
const { t } = useTranslation(); const { t } = useTranslation();
const blobId = typeof value === 'string' ? value : null; const blobId = typeof value === 'string' ? value : null;
const [content, setContent] = useState<string>(''); const [content, setContent] = useState<string>('');
@@ -1053,6 +1060,7 @@ function BlobField({ value, onChange, readOnly }: BlobFieldProps) {
rows={8} rows={8}
className="font-mono text-xs" className="font-mono text-xs"
/> />
{sieveScriptName !== undefined && <SievepadButton scriptName={sieveScriptName} source={content} />}
{modified && ( {modified && (
<p className="text-xs text-muted-foreground"> <p className="text-xs text-muted-foreground">
{t('field.contentModified', 'Content modified (will be saved as a new blob)')} {t('field.contentModified', 'Content modified (will be saved as a new blob)')}
@@ -1539,16 +1547,7 @@ function ObjectListField({
const addItem = () => { const addItem = () => {
const nextIndex = entries.length > 0 ? Math.max(...entries.map(([k]) => parseInt(k))) + 1 : 0; const nextIndex = entries.length > 0 ? Math.max(...entries.map(([k]) => parseInt(k))) + 1 : 0;
let defaults: Record<string, unknown> = {}; onChange({ ...mapValue, [String(nextIndex)]: buildNewObjectValue(schema, objectName) });
if (resolvedSchema.type === 'single' && resolvedSchema.fields.defaults) {
defaults = { ...resolvedSchema.fields.defaults };
} else if (resolvedSchema.type === 'multiple' && resolvedSchema.variants[0]) {
defaults = { '@type': resolvedSchema.variants[0].name };
if (resolvedSchema.variants[0].fields?.defaults) {
defaults = { ...defaults, ...resolvedSchema.variants[0].fields.defaults };
}
}
onChange({ ...mapValue, [String(nextIndex)]: defaults });
}; };
const removeItem = (key: string) => { const removeItem = (key: string) => {
@@ -2021,7 +2020,7 @@ function MapField({ keyClass, valueClass, value, onChange, readOnly, schema, min
if (valueClass.type === 'number') { if (valueClass.type === 'number') {
defaultValue = 0; defaultValue = 0;
} else if (valueClass.type === 'object') { } else if (valueClass.type === 'object') {
defaultValue = {}; defaultValue = buildNewObjectValue(schema, valueClass.objectName);
} }
onChange({ ...mapValue, [key]: defaultValue }); onChange({ ...mapValue, [key]: defaultValue });
+97
View File
@@ -0,0 +1,97 @@
/*
* SPDX-FileCopyrightText: 2020 Stalwart Labs LLC <[email protected]>
*
* SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-SEL
*/
import { useState } from 'react';
import { useTranslation } from 'react-i18next';
import { Bug } from 'lucide-react';
import { Button } from '@/components/ui/button';
import { Checkbox } from '@/components/ui/checkbox';
import { Label } from '@/components/ui/label';
import {
Dialog,
DialogContent,
DialogDescription,
DialogFooter,
DialogHeader,
DialogTitle,
} from '@/components/ui/dialog';
import { toast } from '@/hooks/use-toast';
import { dismissSievepadWarning, isSievepadWarningDismissed, openInSievepad } from '@/lib/sievepad';
interface SievepadButtonProps {
scriptName: string;
source: string;
}
export function SievepadButton({ scriptName, source }: SievepadButtonProps) {
const { t } = useTranslation();
const [warningOpen, setWarningOpen] = useState(false);
const [dontShowAgain, setDontShowAgain] = useState(false);
const open = () => {
openInSievepad(scriptName || t('sievepad.defaultName', 'Sieve script'), source).catch(() => {
toast({ title: t('sievepad.failed', 'Failed to open Sievepad.'), variant: 'destructive' });
});
};
const handleClick = () => {
if (isSievepadWarningDismissed()) {
open();
} else {
setDontShowAgain(false);
setWarningOpen(true);
}
};
const handleContinue = () => {
if (dontShowAgain) dismissSievepadWarning();
setWarningOpen(false);
open();
};
return (
<>
<div className="flex justify-end">
<Button type="button" variant="outline" size="sm" onClick={handleClick} disabled={!source.trim()}>
<Bug className="h-4 w-4" />
{t('sievepad.debug', 'Debug')}
</Button>
</div>
<Dialog open={warningOpen} onOpenChange={setWarningOpen}>
<DialogContent>
<DialogHeader>
<DialogTitle>{t('sievepad.warningTitle', 'Debug in Sievepad')}</DialogTitle>
<DialogDescription>
{t(
'sievepad.warningDescription',
'A new tab will open sievepad.com with a copy of this script. Sievepad compiles and runs the script entirely in your browser: nothing is uploaded to or stored on any server.',
)}
</DialogDescription>
</DialogHeader>
<div className="flex items-center gap-2">
<Checkbox
id="sievepad-dont-show-again"
checked={dontShowAgain}
onCheckedChange={(checked) => setDontShowAgain(checked === true)}
/>
<Label htmlFor="sievepad-dont-show-again" className="text-sm font-normal">
{t('sievepad.dontShowAgain', "Don't show this again")}
</Label>
</div>
<DialogFooter>
<Button type="button" variant="outline" onClick={() => setWarningOpen(false)}>
{t('common.cancel')}
</Button>
<Button type="button" onClick={handleContinue}>
{t('common.continue')}
</Button>
</DialogFooter>
</DialogContent>
</Dialog>
</>
);
}
+10 -1
View File
@@ -136,7 +136,8 @@
"trialDescription": "Get access to advanced features including multi-tenancy, AI-powered spam filtering, alerts, and more.", "trialDescription": "Get access to advanced features including multi-tenancy, AI-powered spam filtering, alerts, and more.",
"trialButton": "Start 30-Day Free Trial", "trialButton": "Start 30-Day Free Trial",
"requestTrial": "Request a free trial to unlock this feature.", "requestTrial": "Request a free trial to unlock this feature.",
"ossHidden": "This feature is not available in the open-source edition." "ossHidden": "This feature is not available in the open-source edition.",
"whyNotFree": "Why is this not free?"
}, },
"errorBoundary": { "errorBoundary": {
"title": "Something went wrong", "title": "Something went wrong",
@@ -340,6 +341,14 @@
"periodValue": "Period value" "periodValue": "Period value"
}, },
"sections": "Sections", "sections": "Sections",
"sievepad": {
"debug": "Debug",
"defaultName": "Sieve script",
"dontShowAgain": "Don't show this again",
"failed": "Failed to open Sievepad.",
"warningDescription": "A new tab will open sievepad.com with a copy of this script. Sievepad compiles and runs the script entirely in your browser: nothing is uploaded to or stored on any server.",
"warningTitle": "Debug in Sievepad"
},
"toggleTheme": "Toggle theme", "toggleTheme": "Toggle theme",
"tracing": { "tracing": {
"addFilter": "Add filter", "addFilter": "Add filter",
+113
View File
@@ -15,6 +15,7 @@ import {
deepMerge, deepMerge,
buildCreateDefaults, buildCreateDefaults,
buildEmbeddedDefaults, buildEmbeddedDefaults,
buildNewObjectValue,
} from './schemaResolver'; } from './schemaResolver';
import { getDisplayProperty } from './schemaResolver'; import { getDisplayProperty } from './schemaResolver';
@@ -865,3 +866,115 @@ describe('getDisplayProperty', () => {
expect(getDisplayProperty(schema, 'x:NoLabel')).toBe('title'); expect(getDisplayProperty(schema, 'x:NoLabel')).toBe('title');
}); });
}); });
const structSchema: Schema = {
objects: {},
schemas: {
'x:Service': { type: 'single', schemaName: 'x:Service' },
'x:Listener': { type: 'single', schemaName: 'x:Listener' },
'x:Tls': { type: 'single', schemaName: 'x:Tls' },
'x:Store': {
type: 'multiple',
variants: [
{ name: 'S3', label: 'S3', schemaName: 'x:S3Store' },
{ name: 'Manual', label: 'Manual' },
],
},
},
fields: {
'x:Service': {
properties: {
hostname: {
description: '',
type: { type: 'string', format: 'string', nullable: true },
update: 'mutable',
},
cleartext: { description: '', type: { type: 'boolean' }, update: 'mutable' },
},
},
'x:Listener': {
properties: {
enabled: { description: '', type: { type: 'boolean' }, update: 'mutable' },
proxied: { description: '', type: { type: 'boolean' }, update: 'mutable' },
readOnly: { description: '', type: { type: 'boolean' }, update: 'serverSet' },
tls: { description: '', type: { type: 'object', objectName: 'x:Tls' }, update: 'mutable' },
fallback: {
description: '',
type: { type: 'object', objectName: 'x:Tls', nullable: true },
update: 'mutable',
},
},
defaults: {
enabled: true,
},
},
'x:Tls': {
properties: {
implicit: { description: '', type: { type: 'boolean' }, update: 'mutable' },
certificateId: {
description: '',
type: { type: 'string', format: 'string', nullable: true },
update: 'mutable',
},
},
},
'x:S3Store': {
properties: {
bucket: { description: '', type: { type: 'string', format: 'string' }, update: 'mutable' },
allowInvalidCerts: { description: '', type: { type: 'boolean' }, update: 'mutable' },
},
defaults: {
bucket: 'stalwart',
},
},
},
forms: {},
lists: {},
enums: {},
dashboards: [],
layouts: [],
};
describe('buildNewObjectValue', () => {
it('seeds non-nullable booleans a struct has no defaults for', () => {
expect(buildNewObjectValue(structSchema, 'x:Service')).toEqual({ cleartext: false });
});
it('keeps schema defaults and only fills the missing booleans', () => {
const result = buildNewObjectValue(structSchema, 'x:Listener');
expect(result.enabled).toBe(true);
expect(result.proxied).toBe(false);
});
it('skips serverSet properties', () => {
expect(buildNewObjectValue(structSchema, 'x:Listener')).not.toHaveProperty('readOnly');
});
it('recurses into non-nullable embedded objects and skips nullable ones', () => {
const result = buildNewObjectValue(structSchema, 'x:Listener');
expect(result.tls).toEqual({ implicit: false });
expect(result).not.toHaveProperty('fallback');
});
it('seeds the first variant with its @type, defaults and booleans', () => {
expect(buildNewObjectValue(structSchema, 'x:Store')).toEqual({
'@type': 'S3',
bucket: 'stalwart',
allowInvalidCerts: false,
});
});
it('honours an explicit variant name', () => {
expect(buildNewObjectValue(structSchema, 'x:Store', 'Manual')).toEqual({ '@type': 'Manual' });
});
it('returns an empty object for an unknown object name', () => {
expect(buildNewObjectValue(structSchema, 'x:Unknown')).toEqual({});
});
it('still merges parent defaults into embedded children', () => {
const result = buildNewObjectValue(embeddedSchema, 'x:Model', 'FtrlCcfh');
expect(result.featureL2Normalize).toBe(true);
expect((result.parameters as Record<string, unknown>).numFeatures).toBe('20');
});
});
+56
View File
@@ -260,6 +260,62 @@ export function buildEmbeddedDefaults(
return result; return result;
} }
export function buildNewObjectValue(schema: Schema, objectName: string, variantName?: string): Record<string, unknown> {
const result = buildEmbeddedDefaults(schema, objectName, {}, variantName);
return completeStructDefaults(schema, objectName, (result['@type'] as string | undefined) ?? variantName, result);
}
function completeStructDefaults(
schema: Schema,
objectName: string,
variantName: string | undefined,
target: Record<string, unknown>,
): Record<string, unknown> {
const resolved = resolveSchema(schema, objectName);
if (!resolved) return target;
const fields =
resolved.type === 'single'
? resolved.fields
: ((variantName ? resolved.variants.find((v) => v.name === variantName) : resolved.variants[0])?.fields ?? null);
if (!fields) return target;
for (const [propName, propDef] of Object.entries(fields.properties)) {
if (propDef.update === 'serverSet') continue;
const t = propDef.type;
if (t.type === 'boolean') {
if (!(propName in target)) {
target[propName] = false;
}
continue;
}
if (t.type !== 'object' || t.nullable) continue;
const current = target[propName];
if (current !== undefined && !isPlainRecord(current)) continue;
const overrides = isPlainRecord(current) ? current : {};
const nestedEntry = schema.schemas[t.objectName];
const nestedVariant =
nestedEntry?.type === 'multiple'
? ((overrides['@type'] as string | undefined) ?? nestedEntry.variants[0]?.name)
: undefined;
const nested = completeStructDefaults(schema, t.objectName, nestedVariant, { ...overrides });
if (Object.keys(nested).length > 0) {
target[propName] = nested;
}
}
return target;
}
function isPlainRecord(value: unknown): value is Record<string, unknown> {
return value !== null && typeof value === 'object' && !Array.isArray(value);
}
export function getDisplayProperty(schema: Schema, objectName: string): string { export function getDisplayProperty(schema: Schema, objectName: string): string {
const list = schema.lists[objectName]; const list = schema.lists[objectName];
if (list?.labelProperty) return list.labelProperty; if (list?.labelProperty) return list.labelProperty;
+47
View File
@@ -0,0 +1,47 @@
/*
* SPDX-FileCopyrightText: 2020 Stalwart Labs LLC <[email protected]>
*
* SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-SEL
*/
import { inflateRawSync } from 'node:zlib';
import { describe, expect, it } from 'vitest';
import { SIEVEPAD_URL, isSieveScriptField, sievepadLink } from './sievepad';
function decode(link: string): unknown {
const token = new URLSearchParams(new URL(link).hash.slice(1)).get('w') ?? '';
return JSON.parse(inflateRawSync(Buffer.from(token, 'base64url')).toString('utf8'));
}
describe('sievepadLink', () => {
it('encodes the script as a single main entry', async () => {
const source = 'require "imap4flags";\r\naddflag "\\\\Seen";\r\n';
const link = await sievepadLink('Filters é', source);
expect(link.startsWith(`${SIEVEPAD_URL}#w=`)).toBe(true);
expect(link.slice(`${SIEVEPAD_URL}#w=`.length)).toMatch(/^[A-Za-z0-9_-]+$/);
expect(decode(link)).toEqual({
v: 1,
name: 'Filters é',
scripts: [{ name: 'main', source: 'require "imap4flags";\naddflag "\\\\Seen";\n' }],
messages: [],
settings: {},
});
});
it('truncates long workspace names', async () => {
const link = await sievepadLink('x'.repeat(200), 'keep;');
expect((decode(link) as { name: string }).name).toHaveLength(80);
});
});
describe('isSieveScriptField', () => {
it('matches only the known script fields', () => {
expect(isSieveScriptField('x:SieveUserScript', 'contents')).toBe(true);
expect(isSieveScriptField('x:SieveSystemScript', 'contents')).toBe(true);
expect(isSieveScriptField('SieveScript', 'blobId')).toBe(true);
expect(isSieveScriptField('SieveScript', 'name')).toBe(false);
expect(isSieveScriptField('x:Domain', 'contents')).toBe(false);
});
});
+77
View File
@@ -0,0 +1,77 @@
/*
* SPDX-FileCopyrightText: 2020 Stalwart Labs LLC <[email protected]>
*
* SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-SEL
*/
export const SIEVEPAD_URL = 'https://sievepad.com/';
const SIEVEPAD_FORMAT_VERSION = 1;
const SIEVEPAD_MAX_NAME_LENGTH = 80;
const SIEVEPAD_MAIN_SCRIPT = 'main';
const BASE64_CHUNK_SIZE = 0x8000;
const WARNING_DISMISSED_KEY = 'stalwart-sievepad-warning-dismissed';
const SIEVE_SCRIPT_FIELDS: Record<string, string> = {
'x:SieveSystemScript': 'contents',
'x:SieveUserScript': 'contents',
SieveScript: 'blobId',
};
export function isSieveScriptField(objectName: string, fieldName: string): boolean {
return SIEVE_SCRIPT_FIELDS[objectName] === fieldName;
}
function toBase64Url(bytes: Uint8Array): string {
let binary = '';
for (let i = 0; i < bytes.length; i += BASE64_CHUNK_SIZE) {
binary += String.fromCharCode(...bytes.subarray(i, i + BASE64_CHUNK_SIZE));
}
return btoa(binary).replace(/\+/g, '-').replace(/\//g, '_').replace(/=+$/, '');
}
export async function sievepadLink(name: string, source: string, base = SIEVEPAD_URL): Promise<string> {
const json = JSON.stringify({
v: SIEVEPAD_FORMAT_VERSION,
name: name.slice(0, SIEVEPAD_MAX_NAME_LENGTH),
scripts: [{ name: SIEVEPAD_MAIN_SCRIPT, source: source.replace(/\r\n/g, '\n') }],
messages: [],
settings: {},
});
const stream = new Blob([new TextEncoder().encode(json)]).stream().pipeThrough(new CompressionStream('deflate-raw'));
const packed = new Uint8Array(await new Response(stream).arrayBuffer());
return `${base}#w=${toBase64Url(packed)}`;
}
export async function openInSievepad(name: string, source: string): Promise<void> {
const tab = window.open('about:blank', '_blank');
if (tab) tab.opener = null;
let link: string;
try {
link = await sievepadLink(name, source);
} catch (err) {
tab?.close();
throw err;
}
if (tab) {
tab.location.replace(link);
} else {
window.open(link, '_blank', 'noopener,noreferrer');
}
}
export function isSievepadWarningDismissed(): boolean {
try {
return localStorage.getItem(WARNING_DISMISSED_KEY) === 'true';
} catch {
return false;
}
}
export function dismissSievepadWarning(): void {
try {
localStorage.setItem(WARNING_DISMISSED_KEY, 'true');
} catch {
return;
}
}