@qirtaas/core 0.1.0 → 0.2.0

package/README.md

@@ -1,6 +1,6 @@
 # @qirtaas/core
 
-Framework-agnostic, embeddable rich-text editor SDK for Islamic scholarly
+Framework-agnostic, embeddable rich-text editor SDK for Islamic
 writing (Qur'an verses, hadith, RTL/Arabic typography). Ships a single bundle
 with a self-contained mount API and its own scoped styles, so it drops into any
 host page without leaking CSS or fighting the host's framework.
@@ -55,6 +55,14 @@ qirtaas.mountRenderer("#renderer", {
 The host must give the editor mount element a bounded height; the renderer grows
 with its content.
 
+## Documentation
+
+Full docs at [docs.qirtaas.io](https://docs.qirtaas.io). For AI coding
+assistants: the complete docs as one markdown file at
+[docs.qirtaas.io/llms-full.txt](https://docs.qirtaas.io/llms-full.txt), and
+ready-made integration prompts at
+[docs.qirtaas.io/ai/build-with-ai](https://docs.qirtaas.io/ai/build-with-ai).
+
 ## License
 
 MIT

package/dist/client.d.ts

@@ -1,13 +1,16 @@
 import { DuplicateDocumentResult } from './mount/duplicateDocument';
+import { DocumentSummary } from './mount/listDocuments';
+import { ShareInfo } from './mount/sharing';
 import { EditorMountOptions, EditorInstance, RendererMountOptions, RendererInstance } from './mount/types';
 export interface QirtaasClientOptions {
     /** Qirtaas API base URL. Default: https://api.qirtaas.io */
     apiUrl?: string;
     /**
-     * Returns a short-lived embed token, shared by the editor, deleteDocument and
-     * duplicateDocument (called on init, before exp, and on 401). Optional: a
-     * renderer-only client — which carries its own per-read auth — can omit it;
-     * mountEditor, deleteDocument and duplicateDocument throw if it is missing.
+     * Returns a short-lived embed token, shared by the editor and the mount-less
+     * ops (listDocuments, deleteDocument, duplicateDocument; called on init,
+     * before exp, and on 401). Optional: a renderer-only client — which carries
+     * its own per-read auth — can omit it; the editor and the mount-less ops
+     * throw if it is missing.
      */
     getToken?: () => Promise<string> | string;
 }
@@ -16,6 +19,12 @@ export interface QirtaasClient {
     mountEditor(el: Element | string, options?: EditorMountOptions): EditorInstance;
     /** Boot the read-only renderer; auth (signature/token/shareToken) is per-call. */
     mountRenderer(el: Element | string, options: RendererMountOptions): RendererInstance;
+    /**
+     * List the identity's documents (id + server-derived title, no content) over
+     * the embed-token channel — lets a host render a document list without
+     * keeping its own index of ids.
+     */
+    listDocuments(): Promise<DocumentSummary[]>;
     /** Delete a document over the embed-token channel (no mount required). */
     deleteDocument(documentId: string): Promise<void>;
     /**
@@ -23,5 +32,13 @@ export interface QirtaasClient {
      * host keep a stable published document while the author edits a private clone.
      */
     duplicateDocument(documentId: string): Promise<DuplicateDocumentResult>;
+    /** Read a document's sharing state (and token, if shared) over the embed-token channel. */
+    getShareInfo(documentId: string): Promise<ShareInfo>;
+    /**
+     * Turn public sharing on or off. Enabling mints (or returns the existing)
+     * share token — pass it to `mountRenderer({ shareToken })` for public reads.
+     * Disabling revokes it.
+     */
+    setSharing(documentId: string, isShared: boolean): Promise<ShareInfo>;
 }
 export declare function createQirtaasClient(config?: QirtaasClientOptions): QirtaasClient;

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 export { createQirtaasClient } from './client';
 export type { QirtaasClient, QirtaasClientOptions } from './client';
 export type { DuplicateDocumentResult } from './mount/duplicateDocument';
+export type { DocumentSummary } from './mount/listDocuments';
+export type { ShareInfo } from './mount/sharing';
 export type { EditorMountOptions, EditorInstance, RendererMountOptions, RendererInstance, Json, Locale, Theme, SaveState, ErrorCode, AutosaveOptions, } from './mount/types';

package/dist/mount/listDocuments.d.ts

@@ -0,0 +1,12 @@
+import { DocumentSummary } from '../services/documents';
+export type { DocumentSummary };
+/**
+ * Internal boot options. apiUrl + getToken are resolved by the client; hosts
+ * call `createQirtaasClient({ apiUrl, getToken }).listDocuments()`.
+ */
+export interface ListDocumentsOptions {
+    apiUrl: string;
+    /** Embed token source — the same the editor uses (shared at the client). */
+    getToken: () => Promise<string> | string;
+}
+export declare function listDocuments(opts: ListDocumentsOptions): Promise<DocumentSummary[]>;

package/dist/mount/sharing.d.ts

@@ -0,0 +1,17 @@
+import { ShareInfo } from '../services/documents';
+export type { ShareInfo };
+/**
+ * Internal boot options. apiUrl + getToken are resolved by the client; hosts
+ * call `createQirtaasClient({ apiUrl, getToken }).setSharing(documentId, isShared)`
+ * or `.getShareInfo(documentId)`.
+ */
+export interface SharingOptions {
+    apiUrl: string;
+    documentId: string;
+    /** Embed token source — the same the editor uses (shared at the client). */
+    getToken: () => Promise<string> | string;
+}
+export declare function getShareInfo(opts: SharingOptions): Promise<ShareInfo>;
+export declare function setSharing(opts: SharingOptions & {
+    isShared: boolean;
+}): Promise<ShareInfo>;