@qirtaas/core 0.0.1

package/dist/editor/WordRangePicker.vue.d.ts

@@ -0,0 +1,37 @@
+type __VLS_Props = {
+    /** The full text to pick a word range from. */
+    text: string;
+    /** Initial [from, to] word indices. Defaults to the whole text. */
+    initialRange?: [number, number] | null;
+    /**
+     * Tailwind classes controlling the text's font, size and leading, e.g.
+     * `font-quran text-[22px] leading-[2.4]`. Layout/colour are fixed.
+     */
+    textClass?: string;
+};
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    change: (payload: {
+        fromWord: number;
+        toWord: number;
+        /** True when the selection spans the entire text. */
+        isFull: boolean;
+        /** False while the user has placed Start and is waiting to place End. */
+        complete: boolean;
+        text: string;
+    }) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onChange?: ((payload: {
+        fromWord: number;
+        toWord: number;
+        /** True when the selection spans the entire text. */
+        isFull: boolean;
+        /** False while the user has placed Start and is waiting to place End. */
+        complete: boolean;
+        text: string;
+    }) => any) | undefined;
+}>, {
+    initialRange: [number, number] | null;
+    textClass: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/editor/docUtils.d.ts

@@ -0,0 +1,4 @@
+/** Check if a TipTap JSON doc has no meaningful content (only empty paragraphs / hard breaks). */
+export declare function docIsEmpty(json: Record<string, unknown>): boolean;
+/** Check if a TipTap JSON doc contains a node of the given type. */
+export declare function docContainsNode(json: Record<string, unknown>, nodeType: string): boolean;

package/dist/editor/emojiSuggestion.d.ts

@@ -0,0 +1,37 @@
+import { EmojiItem } from '@tiptap/extension-emoji';
+import { Editor, Range } from '@tiptap/core';
+type MenuItem = (EmojiItem | HonorificMenuItem) & {
+    emoji?: string;
+};
+type HonorificMenuItem = {
+    name: string;
+    emoji: string;
+    shortcodes: string[];
+    tags: string[];
+    isHonorific: true;
+    honorificType: "jj" | "saw";
+};
+type SuggestionProps = {
+    clientRect?: (() => DOMRect | null) | null;
+    items: MenuItem[];
+    command: (item: MenuItem) => void;
+    editor: Editor;
+    range: Range;
+};
+export declare const emojiSuggestion: {
+    items: ({ query, editor }: {
+        query: string;
+        editor: unknown;
+    }) => (EmojiItem | (HonorificMenuItem & {
+        emoji?: string;
+    }))[];
+    render: () => {
+        onStart: (props: SuggestionProps) => void;
+        onUpdate: (props: SuggestionProps) => void;
+        onKeyDown: (props: {
+            event: KeyboardEvent;
+        }) => boolean;
+        onExit: () => void;
+    };
+};
+export {};

package/dist/editor/extensions/HadithNode.d.ts

@@ -0,0 +1,8 @@
+import { Node } from '@tiptap/core';
+export interface HadithNodeAttributes {
+    collectionNameArabic: string;
+    collectionNameEnglish: string;
+    number: number;
+    text: string;
+}
+export declare const HadithNode: Node<any, any>;

package/dist/editor/extensions/Honorific.d.ts

@@ -0,0 +1,9 @@
+import { Node } from '@tiptap/core';
+import { Fragment, Schema } from '@tiptap/pm/model';
+export type HonorificType = "jj" | "saw";
+/**
+ * Parses a string for :shortcode: patterns and returns a ProseMirror Fragment
+ * with text nodes and honorific nodes. Used by find-replace.
+ */
+export declare function parseReplacementText(text: string, schema: Schema): Fragment;
+export declare const Honorific: Node<any, any>;

package/dist/editor/extensions/ImageNode.d.ts

@@ -0,0 +1,14 @@
+import { Node } from '@tiptap/core';
+export type ImageAlign = "left" | "center" | "right";
+export interface ImageNodeAttributes {
+    imageId: string;
+    alt: string;
+    width: number | null;
+    height: number | null;
+    align: ImageAlign;
+}
+export interface ImageNodeOptions {
+    documentId?: string;
+    translate?: (key: string) => string;
+}
+export declare const ImageNode: Node<ImageNodeOptions, any>;

package/dist/editor/extensions/QuranMushaf.d.ts

@@ -0,0 +1,18 @@
+import { Node } from '@tiptap/core';
+export type MushafAlign = "left" | "center" | "right";
+export interface QuranMushafEndpoint {
+    surah: number;
+    ayah: number;
+    word: number;
+}
+export interface QuranMushafAttributes {
+    page: number;
+    lineStart: number;
+    lineEnd: number;
+    from: QuranMushafEndpoint | null;
+    to: QuranMushafEndpoint | null;
+    width: number | null;
+    height: number | null;
+    align: MushafAlign;
+}
+export declare const QuranMushaf: Node<any, any>;

package/dist/editor/extensions/QuranVerse.d.ts

@@ -0,0 +1,15 @@
+import { Node } from '@tiptap/core';
+export type QuranTextEncoding = "uthmani" | "qpc_hafs";
+export interface QuranVerseAttributes {
+    surah: number;
+    ayah: number;
+    fromAyah: number | null;
+    toAyah: number | null;
+    fromWord: number | null;
+    toWord: number | null;
+    surahNameArabic: string;
+    surahNameEnglish: string;
+    text: string;
+    encoding: QuranTextEncoding;
+}
+export declare const QuranVerse: Node<any, any>;

package/dist/editor/extensions/SearchReplace.d.ts

@@ -0,0 +1,31 @@
+import { Range, Extension } from '@tiptap/core';
+import { PluginKey } from '@tiptap/pm/state';
+export interface SearchReplaceOptions {
+    searchResultClass: string;
+}
+export interface SearchReplaceStorage {
+    searchTerm: string;
+    replaceTerm: string;
+    results: Range[];
+    lastSearchTerm: string;
+    caseSensitive: boolean;
+    lastCaseSensitive: boolean;
+    resultIndex: number;
+    lastResultIndex: number;
+}
+declare module "@tiptap/core" {
+    interface Commands<ReturnType> {
+        searchAndReplace: {
+            setSearchTerm: (searchTerm: string) => ReturnType;
+            setReplaceTerm: (replaceTerm: string) => ReturnType;
+            setCaseSensitive: (caseSensitive: boolean) => ReturnType;
+            resetIndex: () => ReturnType;
+            nextSearchResult: () => ReturnType;
+            previousSearchResult: () => ReturnType;
+            replace: () => ReturnType;
+            replaceAll: () => ReturnType;
+        };
+    }
+}
+export declare const searchReplacePluginKey: PluginKey<any>;
+export declare const SearchReplace: Extension<SearchReplaceOptions, SearchReplaceStorage>;

package/dist/editor/extensions/SlashCommand.d.ts

@@ -0,0 +1,8 @@
+import { Extension } from '@tiptap/core';
+export interface SlashCommandItem {
+    id: string;
+    label: string;
+    searchTerms: string[];
+    icon: string;
+}
+export declare const SlashCommand: Extension<any, any>;

package/dist/editor/extensions/resizableImageNodeView.d.ts

@@ -0,0 +1,10 @@
+import { NodeViewRenderer, NodeViewRendererProps } from '@tiptap/core';
+import { Node as PMNode } from '@tiptap/pm/model';
+export type ImageAlign = "left" | "center" | "right";
+interface Options {
+    nodeName: string;
+    buildImg: (props: NodeViewRendererProps) => HTMLImageElement;
+    syncImg?: (img: HTMLImageElement, newNode: PMNode, oldNode: PMNode) => void;
+}
+export declare function createResizableImageNodeView(opts: Options): NodeViewRenderer;
+export {};

package/dist/editor/quran/MushafPage.vue.d.ts

@@ -0,0 +1,17 @@
+import { PageWord } from './useQuranSelection';
+type __VLS_Props = {
+    page: number;
+    rangeLo: number | null;
+    rangeHi: number | null;
+    startIdx: number | null;
+    endIdx: number | null;
+};
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    wordTap: (globalIdx: number) => any;
+    pageLoaded: (words: PageWord[]) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onWordTap?: ((globalIdx: number) => any) | undefined;
+    onPageLoaded?: ((words: PageWord[]) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/editor/quran/PagePicker.vue.d.ts

@@ -0,0 +1,12 @@
+import { MushafPage } from '../../services/quran';
+type __VLS_Props = {
+    pages: MushafPage[];
+    activeIdx: number;
+};
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    select: (idx: number) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onSelect?: ((idx: number) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/editor/quran/QuranSearchStep.vue.d.ts

@@ -0,0 +1,15 @@
+import { AyahResult, SurahMatch } from '../../services/quran';
+type __VLS_Props = {
+    active?: boolean;
+};
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    selectVerse: (verse: AyahResult) => any;
+    browseSurah: (surah: SurahMatch) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onSelectVerse?: ((verse: AyahResult) => any) | undefined;
+    onBrowseSurah?: ((surah: SurahMatch) => any) | undefined;
+}>, {
+    active: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/editor/quran/SurahBrowserStep.vue.d.ts

@@ -0,0 +1,65 @@
+import { Endpoint } from './useQuranSelection';
+import { SurahMatch } from '../../services/quran';
+type __VLS_Props = {
+    surah: SurahMatch;
+    preselectVerse: number | null;
+};
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    back: () => any;
+    insertMushaf: (payload: {
+        page: number;
+        lineStart: number;
+        lineEnd: number;
+        from: Endpoint;
+        to: Endpoint;
+        width: number;
+        height: number;
+    }) => any;
+    insertInline: (payload: {
+        surah: number;
+        fromAyah: number;
+        toAyah: number;
+        surahNameArabic: string;
+        surahNameEnglish: string;
+        text: string;
+    }) => any;
+    refineWords: (payload: {
+        surah: number;
+        ayah: number;
+        fromWord: number;
+        toWord: number;
+        surahNameArabic: string;
+        surahNameEnglish: string;
+        text: string;
+    }) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onBack?: (() => any) | undefined;
+    onInsertMushaf?: ((payload: {
+        page: number;
+        lineStart: number;
+        lineEnd: number;
+        from: Endpoint;
+        to: Endpoint;
+        width: number;
+        height: number;
+    }) => any) | undefined;
+    onInsertInline?: ((payload: {
+        surah: number;
+        fromAyah: number;
+        toAyah: number;
+        surahNameArabic: string;
+        surahNameEnglish: string;
+        text: string;
+    }) => any) | undefined;
+    onRefineWords?: ((payload: {
+        surah: number;
+        ayah: number;
+        fromWord: number;
+        toWord: number;
+        surahNameArabic: string;
+        surahNameEnglish: string;
+        text: string;
+    }) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/editor/quran/WordSelectStep.vue.d.ts

@@ -0,0 +1,32 @@
+import { AyahResult } from '../../services/quran';
+type __VLS_Props = {
+    verse: AyahResult;
+    initialRange?: [number, number] | null;
+};
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    back: () => any;
+    insert: (payload: {
+        surah: number;
+        ayah: number;
+        surahNameArabic: string;
+        surahNameEnglish: string;
+        fromWord: number | null;
+        toWord: number | null;
+        text: string;
+    }) => any;
+    expandToBrowser: () => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onBack?: (() => any) | undefined;
+    onInsert?: ((payload: {
+        surah: number;
+        ayah: number;
+        surahNameArabic: string;
+        surahNameEnglish: string;
+        fromWord: number | null;
+        toWord: number | null;
+        text: string;
+    }) => any) | undefined;
+    onExpandToBrowser?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/editor/quran/formatReference.d.ts

@@ -0,0 +1,12 @@
+export interface VerseRefAttrs {
+    surah: number;
+    surahNameArabic: string;
+    surahNameEnglish?: string;
+    ayah?: number;
+    fromAyah?: number | null;
+    toAyah?: number | null;
+    fromWord?: number | null;
+    toWord?: number | null;
+}
+export declare function formatReference(attrs: VerseRefAttrs): string;
+export declare function shortReference(attrs: VerseRefAttrs): string;

package/dist/editor/quran/useQuranSelection.d.ts

@@ -0,0 +1,50 @@
+import { ComputedRef, Ref } from 'vue';
+export interface PageWord {
+    surah: number;
+    ayah: number;
+    wordIdxInAyah: number;
+    globalIdx: number;
+    lastInAyah: boolean;
+    lineNumber: number;
+}
+export type InsertMode = "inline" | "mushaf";
+export interface Endpoint {
+    surah: number;
+    ayah: number;
+    word: number;
+}
+export type BlockedReason = "cross-surah-inline";
+export interface UseQuranSelection {
+    startIdx: Ref<number | null>;
+    endIdx: Ref<number | null>;
+    mode: Ref<InsertMode>;
+    hasSelection: ComputedRef<boolean>;
+    rangeLo: ComputedRef<number | null>;
+    rangeHi: ComputedRef<number | null>;
+    from: ComputedRef<Endpoint | null>;
+    to: ComputedRef<Endpoint | null>;
+    inlineAllowed: ComputedRef<boolean>;
+    isCrossSurah: ComputedRef<boolean>;
+    blockedReason: Ref<BlockedReason | null>;
+    tapWord(globalIdx: number): void;
+    reset(): void;
+    setMode(m: InsertMode): void;
+}
+/**
+ * Selection state machine for the surah-browser mushaf view.
+ *
+ * Selections are always full-verse aligned — taps snap to verse boundaries.
+ * Partial-word selection lives elsewhere (the single-verse slider step).
+ *
+ * Tap semantics:
+ *   • First tap → select the tapped verse.
+ *   • Tap a new verse before the current range → extend backward.
+ *   • Tap a new verse after the current range → extend forward.
+ *   • Tap a verse already inside the range → collapse to just that verse.
+ *
+ * Inline mode is allowed only when the selection stays within a single surah.
+ * Mushaf mode has no extra restriction beyond same-page (enforced upstream).
+ */
+export declare function useQuranSelection(pageWords: Ref<PageWord[]>, initial?: {
+    mode?: InsertMode;
+}): UseQuranSelection;

package/dist/editor/runtime/analytics.d.ts

@@ -0,0 +1,3 @@
+export type TrackEventFn = (event: string, properties?: Record<string, unknown>) => void;
+export declare function setTrackEvent(fn: TrackEventFn): void;
+export declare function trackEvent(event: string, properties?: Record<string, unknown>): void;

package/dist/editor/runtime/context.d.ts

@@ -0,0 +1,8 @@
+import { InjectionKey, Ref } from 'vue';
+/**
+ * Read-only dark-mode flag. The host owns theme state (SPA: useTheme();
+ * embed SDK later: options.theme), so the editor only consumes it.
+ * Default: light.
+ */
+export declare const IsDarkKey: InjectionKey<Ref<boolean>>;
+export declare function useIsDark(): Ref<boolean>;

package/dist/i18n/ar.d.ts

@@ -0,0 +1,159 @@
+declare const _default: {
+    editor: {
+        placeholder: string;
+        saving: string;
+        saved: string;
+        backIcon: string;
+        slashHint: string;
+        failedToLoad: string;
+        tryAgainLater: string;
+        insert: string;
+        insertQuran: string;
+        insertHadith: string;
+        insertJJ: string;
+        insertSAW: string;
+        insertToggleList: string;
+        insertTable: string;
+        insertImage: string;
+        image: {
+            uploading: string;
+            uploadFailed: string;
+            retry: string;
+            cancel: string;
+            tooLarge: string;
+            singleOnly: string;
+            failedToLoad: string;
+            rejectedTitle: string;
+            rejectedDetail: string;
+        };
+        atom: {
+            copy: string;
+            delete: string;
+        };
+        verse: {
+            viewTafsir: string;
+        };
+        hadith: {
+            viewDetails: string;
+        };
+        findReplace: {
+            title: string;
+            findPlaceholder: string;
+            replacePlaceholder: string;
+            noResults: string;
+            next: string;
+            previous: string;
+            replace: string;
+            replaceAll: string;
+            caseSensitive: string;
+            close: string;
+        };
+        table: {
+            addRowAfter: string;
+            deleteRow: string;
+            addColAfter: string;
+            deleteCol: string;
+            toggleHeader: string;
+            deleteTable: string;
+        };
+        unsavedWarning: string;
+        tapToResave: string;
+        tapToRetry: string;
+        backLabel: string;
+    };
+    errors: {
+        loadDocument: string;
+        saveFailed: string;
+        documentTooLarge: string;
+    };
+    quran: {
+        dialogTitle: string;
+        searchPlaceholder: string;
+        noResults: string;
+        searchError: string;
+        selectionHint: string;
+        refineWords: string;
+        insert: string;
+        cancel: string;
+        back: string;
+        surahsSection: string;
+        versesSection: string;
+        verses: string;
+        browse: string;
+        typeToSearch: string;
+        openSurahInMushaf: string;
+        selectMoreVerses: string;
+        selectMoreVersesSub: string;
+        page: string;
+        previousPage: string;
+        nextPage: string;
+        pagePickerPlaceholder: string;
+        noMatches: string;
+        tapWordToStart: string;
+        tapWordToBegin: string;
+        tapVerseToSelect: string;
+        tapVerseToSelectFull: string;
+        selectedRef: string;
+        selection: string;
+        reset: string;
+        insertAs: string;
+        inline: string;
+        mushaf: string;
+        inlineDescription: string;
+        mushafDescription: string;
+        snappedToFullVerses: string;
+        inlineNoCrossSurah: string;
+        crossSurahBlocked: string;
+        preview: string;
+        previewError: string;
+        insertText: string;
+        insertMushafImage: string;
+    };
+    wordSelect: {
+        tapEndWord: string;
+    };
+    hadith: {
+        dialogTitle: string;
+        searchPlaceholder: string;
+        noResults: string;
+        searchError: string;
+        selectionHint: string;
+        insert: string;
+    };
+    hadithDetail: {
+        ariaLabel: string;
+        close: string;
+        openOnSunnah: string;
+        collection: string;
+        book: string;
+        grade: string;
+        translation: string;
+        error: string;
+        retry: string;
+    };
+    verseDetail: {
+        ariaLabel: string;
+        close: string;
+        openOnQuranCom: string;
+        translation: string;
+        translationSource: string;
+        transliteration: string;
+        tafsir: string;
+        tafsirLanguage: string;
+        error: string;
+        retry: string;
+        prev: string;
+        next: string;
+    };
+    reportData: {
+        tooltip: string;
+        title: string;
+        referenceLabel: string;
+        placeholder: string;
+        submit: string;
+        cancel: string;
+        success: string;
+        error: string;
+    };
+};
+export default _default;