@synopackageland/ui 0.17.9 → 0.17.10

package/dist/lib/files.d.ts

@@ -0,0 +1,28 @@
+/** `processing`: stored, its thumbnails not made yet. `missing`: gone from storage. `changed`: its content no longer matches what was stored. */
+export type FileState = 'processing' | 'ready' | 'failed' | 'missing' | 'changed';
+export type FileItem = {
+    id: string;
+    name: string;
+    /** MIME type, such as `image/jpeg`. */
+    type?: string;
+    size?: number;
+    /** `ready` when not set. */
+    state?: FileState;
+    /** The original, to download or show full size. */
+    url?: string;
+    /** A small picture (about 320px) for a grid cell or a list. */
+    thumb?: string;
+    /** A large picture (about 1280px) for a lightbox. */
+    preview?: string;
+    width?: number;
+    height?: number;
+    /** A CSS colour shown while the picture loads or is processed. */
+    dominant?: string;
+};
+/** Whether the file is a picture a browser shows: JPEG, PNG, WebP or GIF. */
+export declare function isPicture(file: Pick<FileItem, 'name' | 'type'>): boolean;
+/** HEIC, HEIF and AVIF: kept as files, but no picture is made from them. */
+export declare function isUnsupportedPicture(file: {
+    name: string;
+    type?: string;
+}): boolean;

package/dist/lib/mentions.d.ts

@@ -22,16 +22,6 @@ export type MentionPart = {
     inactive: boolean;
     known: boolean;
 };
-/** Text with `@Label` for each chosen mention → a body with `@[id]` tokens and the ids, in order, once each. */
-export declare function mentionTokens(text: string, mentions: readonly MentionCandidate[]): {
-    body: string;
-    ids: string[];
-};
-/** A body with `@[id]` tokens → the `@Label` text to edit, and the people it mentions. An unknown id shows as itself. */
-export declare function mentionText(body: string, people: readonly MentionCandidate[]): {
-    text: string;
-    mentions: MentionCandidate[];
-};
 /** Splits a body into plain text, `@[id]` mentions and http(s) links, for display. */
 export declare function mentionParts(body: string, people?: readonly MentionCandidate[]): MentionPart[];
 /** Length in characters (code points), as a server counting runes sees it. */

package/dist/lib/richText.d.ts

@@ -0,0 +1,66 @@
+import { MentionCandidate } from './mentions';
+type Marks = {
+    strong?: true;
+    em?: true;
+    strike?: true;
+};
+export type RichTextInline = ({
+    type: 'text';
+    text: string;
+} & Marks) | ({
+    type: 'link';
+    text: string;
+    href: string;
+} & Marks) | ({
+    type: 'mention';
+    id: string;
+    label: string;
+    inactive: boolean;
+    known: boolean;
+} & Marks) | {
+    type: 'code';
+    text: string;
+}
+/** `![alt](file:ID)`; `id` is the file the app stores. */
+ | {
+    type: 'image';
+    id: string;
+    alt: string;
+};
+export type RichTextListItem = {
+    parts: RichTextInline[];
+    list?: RichTextList;
+};
+export type RichTextList = {
+    type: 'list';
+    ordered: boolean;
+    start: number;
+    items: RichTextListItem[];
+};
+export type RichTextBlock = {
+    type: 'paragraph';
+    parts: RichTextInline[];
+} | {
+    type: 'heading';
+    level: 2 | 3;
+    parts: RichTextInline[];
+} | RichTextList | {
+    type: 'quote';
+    blocks: RichTextBlock[];
+} | {
+    type: 'code';
+    text: string;
+};
+export type RichTextOptions = {
+    /** Names for the mention tokens; an unknown id shows as itself. */
+    people?: readonly MentionCandidate[];
+    /** Reads `## ` and `### ` as headings, for a rich text field; a comment leaves them as typed. */
+    headings?: boolean;
+};
+/** A body → its blocks of inline parts. */
+export declare function richTextParts(body: string, options?: RichTextOptions): RichTextBlock[];
+/** A body as plain text without the Markdown, for a notification, a preview or a search: mentions as `@Label`, links as their text, images as their alt text, list items as `• item`. */
+export declare function richTextText(body: string, options?: RichTextOptions): string;
+/** The file ids of the body's images, in order, once each. */
+export declare function richTextFileIds(body: string): string[];
+export {};

package/dist/lib/uploadQueue.d.ts

@@ -0,0 +1,39 @@
+export type UploadStatus = 'queued' | 'uploading' | 'done' | 'failed' | 'canceled';
+export type UploadTask<R = unknown> = {
+    key: string;
+    file: File;
+    name: string;
+    size: number;
+    /** Bytes sent so far, as the upload function reports them. */
+    loaded: number;
+    status: UploadStatus;
+    /** The last error's message, when `failed`. */
+    error?: string;
+    /** What the upload function resolved with, when `done`. */
+    result?: R;
+};
+export type UploadFunction<R> = (file: File, options: {
+    signal: AbortSignal;
+    onProgress: (loaded: number) => void;
+}) => Promise<R>;
+export type UploadQueueOptions<R> = {
+    /** Files sent at once; 3 by default. */
+    concurrency?: number;
+    /** Automatic retries after a failure, a second apart and then longer; 2 by default. */
+    retries?: number;
+    onDone?: (task: UploadTask<R>) => void;
+    onFailed?: (task: UploadTask<R>) => void;
+};
+export type UploadQueueController<R> = {
+    tasks: UploadTask<R>[];
+    /** Queues the files and returns their tasks. */
+    add: (files: Iterable<File>) => UploadTask<R>[];
+    retry: (key: string) => void;
+    cancel: (key: string) => void;
+    cancelAll: () => void;
+    /** Drops the task from the list, cancelling it first. */
+    remove: (key: string) => void;
+    /** Drops the tasks that are done or cancelled. */
+    clear: () => void;
+};
+export declare function useUploadQueue<R>(upload: UploadFunction<R>, options?: UploadQueueOptions<R>): UploadQueueController<R>;

package/dist/reka-runtime.json

@@ -3,7 +3,7 @@
   "version": "2.10.5",
   "delivery": "bundled-patched-esm",
   "patchManifestSha256": "14f10159b60d48ac7a0686f58faf7a30e99898dc267b3c032cf2bdd6052dc52b",
-  "bundleSha256": "d0bd784a7fa38aa20e38f78621c19dc6055ce1cda61dd2f69127c6774fa13150",
+  "bundleSha256": "6689916a8e6efff9f280730df748e7721a556d511b4d273cac5dfbcb23ddb17b",
   "sourceHashes": {
     "shared/useBodyScrollLock.js": "657592f283cb6fd25454abd284a0024af21936cb56e05b762ff0d22b6a979d32",
     "DismissableLayer/DismissableLayer.js": "da05ca544d9822a8e2b71057e78c0e1ef59423aa3893534338fb58e1ecbd1a8d",

package/dist/rich-text.d.ts

@@ -0,0 +1,3 @@
+export { default as RichTextEditor } from './components/rich-text-editor/RichTextEditor.vue';
+export { docToMarkdown, markdownToDoc } from './components/rich-text-editor/markdown';
+export type { MarkdownOptions, SerializeOptions } from './components/rich-text-editor/markdown';