@geenius/docs 0.1.0 → 0.4.0

package/packages/convex/dist/index.d.ts

@@ -0,0 +1,503 @@
+import * as convex_server from 'convex/server';
+import * as convex_values from 'convex/values';
+
+/**
+ * @module docsConvexConfig
+ * @package @geenius/docs-convex
+ * @description Declares the Convex component identity for the docs package so
+ * consuming apps can register the component under the canonical docs name.
+ */
+/**
+ * Convex component definition for the docs package.
+ */
+declare const component: convex_server.ComponentDefinition<any>;
+
+/**
+ * @module docsConvexMutations
+ * @package @geenius/docs-convex
+ * @description Declares the typed Convex mutation surface for creating,
+ * updating, reordering, publishing, and deleting docs sections and pages.
+ */
+/**
+ * Creates a docs section record.
+ */
+declare const createSection: convex_server.RegisteredMutation<"public", {
+    parentId?: convex_values.GenericId<"doc_sections"> | undefined;
+    icon?: string | undefined;
+    description?: string | undefined;
+    title: string;
+    slug: string;
+    order: number;
+    access: "public" | "team" | "admin";
+}, Promise<convex_values.GenericId<"doc_sections">>>;
+/**
+ * Updates mutable fields on a docs section.
+ */
+declare const updateSection: convex_server.RegisteredMutation<"public", {
+    title?: string | undefined;
+    slug?: string | undefined;
+    order?: number | undefined;
+    icon?: string | undefined;
+    description?: string | undefined;
+    access?: "public" | "team" | "admin" | undefined;
+    sectionId: convex_values.GenericId<"doc_sections">;
+}, Promise<null>>;
+/**
+ * Deletes a docs section and its dependent pages and search index entries.
+ */
+declare const deleteSection: convex_server.RegisteredMutation<"public", {
+    sectionId: convex_values.GenericId<"doc_sections">;
+}, Promise<null>>;
+/**
+ * Reorders sections according to the provided id sequence.
+ */
+declare const reorderSections: convex_server.RegisteredMutation<"public", {
+    sectionIds: convex_values.GenericId<"doc_sections">[];
+}, Promise<null>>;
+/**
+ * Creates a docs page and derives reading-time metadata from its content.
+ */
+declare const createPage: convex_server.RegisteredMutation<"public", {
+    order?: number | undefined;
+    excerpt?: string | undefined;
+    author?: {
+        avatar?: string | undefined;
+        name: string;
+    } | undefined;
+    version?: string | undefined;
+    tags?: string[] | undefined;
+    status?: "draft" | "published" | "archived" | undefined;
+    title: string;
+    slug: string;
+    access: "public" | "team" | "admin";
+    content: string;
+    sectionId: convex_values.GenericId<"doc_sections">;
+}, Promise<convex_values.GenericId<"doc_pages">>>;
+/**
+ * Updates an existing docs page and recalculates derived metadata when needed.
+ */
+declare const updatePage: convex_server.RegisteredMutation<"public", {
+    title?: string | undefined;
+    slug?: string | undefined;
+    order?: number | undefined;
+    access?: "public" | "team" | "admin" | undefined;
+    content?: string | undefined;
+    excerpt?: string | undefined;
+    sectionId?: convex_values.GenericId<"doc_sections"> | undefined;
+    lastEditedBy?: {
+        name: string;
+        editedAt: string;
+    } | undefined;
+    version?: string | undefined;
+    tags?: string[] | undefined;
+    status?: "draft" | "published" | "archived" | undefined;
+    pageId: convex_values.GenericId<"doc_pages">;
+}, Promise<null>>;
+/**
+ * Publishes a docs page.
+ */
+declare const publishPage: convex_server.RegisteredMutation<"public", {
+    pageId: convex_values.GenericId<"doc_pages">;
+}, Promise<null>>;
+/**
+ * Archives a docs page.
+ */
+declare const archivePage: convex_server.RegisteredMutation<"public", {
+    pageId: convex_values.GenericId<"doc_pages">;
+}, Promise<null>>;
+/**
+ * Deletes a docs page and its search index entries.
+ */
+declare const deletePage: convex_server.RegisteredMutation<"public", {
+    pageId: convex_values.GenericId<"doc_pages">;
+}, Promise<null>>;
+/**
+ * Reorders pages within a section according to the provided id sequence.
+ */
+declare const reorderPages: convex_server.RegisteredMutation<"public", {
+    pageIds: convex_values.GenericId<"doc_pages">[];
+}, Promise<null>>;
+/**
+ * Increments the view count for a docs page.
+ */
+declare const incrementViewCount: convex_server.RegisteredMutation<"public", {
+    pageId: convex_values.GenericId<"doc_pages">;
+}, Promise<null>>;
+/**
+ * Moves a docs page into a new section and order slot.
+ */
+declare const movePage: convex_server.RegisteredMutation<"public", {
+    pageId: convex_values.GenericId<"doc_pages">;
+    newSectionId: convex_values.GenericId<"doc_sections">;
+    newOrder: number;
+}, Promise<null>>;
+
+/**
+ * @module docsConvexQueries
+ * @package @geenius/docs-convex
+ * @description Declares the typed Convex query surface used by the docs
+ * package. The validators mirror the schema so consumers never fall back to
+ * `v.any()` for docs sections, pages, or tree payloads.
+ */
+declare const listSections: convex_server.RegisteredQuery<"public", {
+    access?: "public" | "team" | "admin" | undefined;
+}, Promise<{
+    _id: convex_values.GenericId<"doc_sections">;
+    _creationTime: number;
+    parentId?: convex_values.GenericId<"doc_sections"> | undefined;
+    icon?: string | undefined;
+    description?: string | undefined;
+    title: string;
+    slug: string;
+    order: number;
+    access: "public" | "team" | "admin";
+    createdAt: number;
+}[]>>;
+declare const getSection: convex_server.RegisteredQuery<"public", {
+    sectionId: convex_values.GenericId<"doc_sections">;
+}, Promise<{
+    _id: convex_values.GenericId<"doc_sections">;
+    _creationTime: number;
+    parentId?: convex_values.GenericId<"doc_sections"> | undefined;
+    icon?: string | undefined;
+    description?: string | undefined;
+    title: string;
+    slug: string;
+    order: number;
+    access: "public" | "team" | "admin";
+    createdAt: number;
+} | null>>;
+declare const listPagesBySection: convex_server.RegisteredQuery<"public", {
+    status?: "draft" | "published" | "archived" | undefined;
+    sectionId: convex_values.GenericId<"doc_sections">;
+}, Promise<{
+    _id: convex_values.GenericId<"doc_pages">;
+    _creationTime: number;
+    excerpt?: string | undefined;
+    lastEditedBy?: {
+        name: string;
+        editedAt: string;
+    } | undefined;
+    version?: string | undefined;
+    title: string;
+    slug: string;
+    order: number;
+    access: "public" | "team" | "admin";
+    createdAt: number;
+    content: string;
+    sectionId: convex_values.GenericId<"doc_sections">;
+    author: {
+        avatar?: string | undefined;
+        name: string;
+    };
+    tags: string[];
+    status: "draft" | "published" | "archived";
+    updatedAt: number;
+    wordCount: number;
+    readingTime: number;
+    viewCount: number;
+}[]>>;
+declare const getPage: convex_server.RegisteredQuery<"public", {
+    slug: string;
+    sectionId: convex_values.GenericId<"doc_sections">;
+}, Promise<{
+    _id: convex_values.GenericId<"doc_pages">;
+    _creationTime: number;
+    excerpt?: string | undefined;
+    lastEditedBy?: {
+        name: string;
+        editedAt: string;
+    } | undefined;
+    version?: string | undefined;
+    title: string;
+    slug: string;
+    order: number;
+    access: "public" | "team" | "admin";
+    createdAt: number;
+    content: string;
+    sectionId: convex_values.GenericId<"doc_sections">;
+    author: {
+        avatar?: string | undefined;
+        name: string;
+    };
+    tags: string[];
+    status: "draft" | "published" | "archived";
+    updatedAt: number;
+    wordCount: number;
+    readingTime: number;
+    viewCount: number;
+} | null>>;
+declare const getPageById: convex_server.RegisteredQuery<"public", {
+    pageId: convex_values.GenericId<"doc_pages">;
+}, Promise<{
+    _id: convex_values.GenericId<"doc_pages">;
+    _creationTime: number;
+    excerpt?: string | undefined;
+    lastEditedBy?: {
+        name: string;
+        editedAt: string;
+    } | undefined;
+    version?: string | undefined;
+    title: string;
+    slug: string;
+    order: number;
+    access: "public" | "team" | "admin";
+    createdAt: number;
+    content: string;
+    sectionId: convex_values.GenericId<"doc_sections">;
+    author: {
+        avatar?: string | undefined;
+        name: string;
+    };
+    tags: string[];
+    status: "draft" | "published" | "archived";
+    updatedAt: number;
+    wordCount: number;
+    readingTime: number;
+    viewCount: number;
+} | null>>;
+declare const searchPages: convex_server.RegisteredQuery<"public", {
+    access?: "public" | "team" | "admin" | undefined;
+    query: string;
+}, Promise<{
+    _id: convex_values.GenericId<"doc_pages">;
+    _creationTime: number;
+    excerpt?: string | undefined;
+    lastEditedBy?: {
+        name: string;
+        editedAt: string;
+    } | undefined;
+    version?: string | undefined;
+    title: string;
+    slug: string;
+    order: number;
+    access: "public" | "team" | "admin";
+    createdAt: number;
+    content: string;
+    sectionId: convex_values.GenericId<"doc_sections">;
+    author: {
+        avatar?: string | undefined;
+        name: string;
+    };
+    tags: string[];
+    status: "draft" | "published" | "archived";
+    updatedAt: number;
+    wordCount: number;
+    readingTime: number;
+    viewCount: number;
+}[]>>;
+declare const getFullTree: convex_server.RegisteredQuery<"public", {
+    access?: "public" | "team" | "admin" | undefined;
+}, Promise<{
+    id: convex_values.GenericId<"doc_sections">;
+    pages: {
+        id: convex_values.GenericId<"doc_pages">;
+        _id: convex_values.GenericId<"doc_pages">;
+        _creationTime: number;
+        excerpt?: string | undefined;
+        lastEditedBy?: {
+            name: string;
+            editedAt: string;
+        } | undefined;
+        version?: string | undefined;
+        title: string;
+        slug: string;
+        order: number;
+        access: "public" | "team" | "admin";
+        createdAt: number;
+        content: string;
+        sectionId: convex_values.GenericId<"doc_sections">;
+        author: {
+            avatar?: string | undefined;
+            name: string;
+        };
+        tags: string[];
+        status: "draft" | "published" | "archived";
+        updatedAt: number;
+        wordCount: number;
+        readingTime: number;
+        viewCount: number;
+    }[];
+    pageCount: number;
+    _id: convex_values.GenericId<"doc_sections">;
+    _creationTime: number;
+    parentId?: convex_values.GenericId<"doc_sections"> | undefined;
+    icon?: string | undefined;
+    description?: string | undefined;
+    title: string;
+    slug: string;
+    order: number;
+    access: "public" | "team" | "admin";
+    createdAt: number;
+}[]>>;
+declare const getRecentPages: convex_server.RegisteredQuery<"public", {
+    access?: "public" | "team" | "admin" | undefined;
+    limit?: number | undefined;
+}, Promise<{
+    id: convex_values.GenericId<"doc_pages">;
+    _id: convex_values.GenericId<"doc_pages">;
+    _creationTime: number;
+    excerpt?: string | undefined;
+    lastEditedBy?: {
+        name: string;
+        editedAt: string;
+    } | undefined;
+    version?: string | undefined;
+    title: string;
+    slug: string;
+    order: number;
+    access: "public" | "team" | "admin";
+    createdAt: number;
+    content: string;
+    sectionId: convex_values.GenericId<"doc_sections">;
+    author: {
+        avatar?: string | undefined;
+        name: string;
+    };
+    tags: string[];
+    status: "draft" | "published" | "archived";
+    updatedAt: number;
+    wordCount: number;
+    readingTime: number;
+    viewCount: number;
+}[]>>;
+declare const getPageVersions: convex_server.RegisteredQuery<"public", {
+    slug: string;
+}, Promise<{
+    id: convex_values.GenericId<"doc_pages">;
+    _id: convex_values.GenericId<"doc_pages">;
+    _creationTime: number;
+    excerpt?: string | undefined;
+    lastEditedBy?: {
+        name: string;
+        editedAt: string;
+    } | undefined;
+    version?: string | undefined;
+    title: string;
+    slug: string;
+    order: number;
+    access: "public" | "team" | "admin";
+    createdAt: number;
+    content: string;
+    sectionId: convex_values.GenericId<"doc_sections">;
+    author: {
+        avatar?: string | undefined;
+        name: string;
+    };
+    tags: string[];
+    status: "draft" | "published" | "archived";
+    updatedAt: number;
+    wordCount: number;
+    readingTime: number;
+    viewCount: number;
+}[]>>;
+
+/**
+ * @module docsConvexSchema
+ * @package @geenius/docs-convex
+ * @description Declares the docs Convex schema and exports the reusable
+ * tables object so consuming apps can merge it into larger schemas.
+ */
+/**
+ * Reusable Convex tables for the docs package.
+ */
+declare const docsTables: {
+    doc_sections: convex_server.TableDefinition<convex_values.VObject<{
+        parentId?: convex_values.GenericId<"doc_sections"> | undefined;
+        icon?: string | undefined;
+        description?: string | undefined;
+        title: string;
+        slug: string;
+        order: number;
+        access: "public" | "team" | "admin";
+        createdAt: number;
+    }, {
+        title: convex_values.VString<string, "required">;
+        slug: convex_values.VString<string, "required">;
+        parentId: convex_values.VId<convex_values.GenericId<"doc_sections"> | undefined, "optional">;
+        order: convex_values.VFloat64<number, "required">;
+        icon: convex_values.VString<string | undefined, "optional">;
+        description: convex_values.VString<string | undefined, "optional">;
+        access: convex_values.VUnion<"public" | "team" | "admin", [convex_values.VLiteral<"public", "required">, convex_values.VLiteral<"team", "required">, convex_values.VLiteral<"admin", "required">], "required", never>;
+        createdAt: convex_values.VFloat64<number, "required">;
+    }, "required", "title" | "slug" | "parentId" | "order" | "icon" | "description" | "access" | "createdAt">, {
+        by_slug: ["slug", "_creationTime"];
+        by_parentId: ["parentId", "_creationTime"];
+        by_order: ["order", "_creationTime"];
+    }, {}, {}>;
+    doc_pages: convex_server.TableDefinition<convex_values.VObject<{
+        excerpt?: string | undefined;
+        lastEditedBy?: {
+            name: string;
+            editedAt: string;
+        } | undefined;
+        version?: string | undefined;
+        title: string;
+        slug: string;
+        order: number;
+        access: "public" | "team" | "admin";
+        createdAt: number;
+        content: string;
+        sectionId: convex_values.GenericId<"doc_sections">;
+        author: {
+            avatar?: string | undefined;
+            name: string;
+        };
+        tags: string[];
+        status: "draft" | "published" | "archived";
+        updatedAt: number;
+        wordCount: number;
+        readingTime: number;
+        viewCount: number;
+    }, {
+        title: convex_values.VString<string, "required">;
+        slug: convex_values.VString<string, "required">;
+        content: convex_values.VString<string, "required">;
+        excerpt: convex_values.VString<string | undefined, "optional">;
+        sectionId: convex_values.VId<convex_values.GenericId<"doc_sections">, "required">;
+        order: convex_values.VFloat64<number, "required">;
+        author: convex_values.VObject<{
+            avatar?: string | undefined;
+            name: string;
+        }, {
+            name: convex_values.VString<string, "required">;
+            avatar: convex_values.VString<string | undefined, "optional">;
+        }, "required", "name" | "avatar">;
+        lastEditedBy: convex_values.VObject<{
+            name: string;
+            editedAt: string;
+        } | undefined, {
+            name: convex_values.VString<string, "required">;
+            editedAt: convex_values.VString<string, "required">;
+        }, "optional", "name" | "editedAt">;
+        version: convex_values.VString<string | undefined, "optional">;
+        access: convex_values.VUnion<"public" | "team" | "admin", [convex_values.VLiteral<"public", "required">, convex_values.VLiteral<"team", "required">, convex_values.VLiteral<"admin", "required">], "required", never>;
+        tags: convex_values.VArray<string[], convex_values.VString<string, "required">, "required">;
+        status: convex_values.VUnion<"draft" | "published" | "archived", [convex_values.VLiteral<"draft", "required">, convex_values.VLiteral<"published", "required">, convex_values.VLiteral<"archived", "required">], "required", never>;
+        createdAt: convex_values.VFloat64<number, "required">;
+        updatedAt: convex_values.VFloat64<number, "required">;
+        wordCount: convex_values.VFloat64<number, "required">;
+        readingTime: convex_values.VFloat64<number, "required">;
+        viewCount: convex_values.VFloat64<number, "required">;
+    }, "required", "title" | "slug" | "order" | "access" | "createdAt" | "content" | "excerpt" | "sectionId" | "author" | "lastEditedBy" | "version" | "tags" | "status" | "updatedAt" | "wordCount" | "readingTime" | "viewCount" | "author.name" | "author.avatar" | "lastEditedBy.name" | "lastEditedBy.editedAt">, {
+        by_sectionId: ["sectionId", "_creationTime"];
+        by_slug: ["slug", "_creationTime"];
+        by_status: ["status", "_creationTime"];
+        by_access: ["access", "_creationTime"];
+    }, {}, {}>;
+    doc_search_index: convex_server.TableDefinition<convex_values.VObject<{
+        sectionId: convex_values.GenericId<"doc_sections">;
+        updatedAt: number;
+        pageId: convex_values.GenericId<"doc_pages">;
+        tokens: string[];
+    }, {
+        pageId: convex_values.VId<convex_values.GenericId<"doc_pages">, "required">;
+        sectionId: convex_values.VId<convex_values.GenericId<"doc_sections">, "required">;
+        tokens: convex_values.VArray<string[], convex_values.VString<string, "required">, "required">;
+        updatedAt: convex_values.VFloat64<number, "required">;
+    }, "required", "sectionId" | "updatedAt" | "pageId" | "tokens">, {
+        by_pageId: ["pageId", "_creationTime"];
+    }, {}, {}>;
+};
+
+export { archivePage, component as componentDefinition, createPage, createSection, deletePage, deleteSection, docsTables, getFullTree, getPage, getPageById, getPageVersions, getRecentPages, getSection, incrementViewCount, listPagesBySection, listSections, movePage, publishPage, reorderPages, reorderSections, searchPages, updatePage, updateSection };