@edifice.io/wiki 3.4.0-develop-pedago.1

package/lib/routes/errors/index.d.ts

@@ -0,0 +1,3 @@
+export declare const PageError: ({ withoutLayout }: {
+    withoutLayout?: boolean;
+}) => import("react/jsx-runtime").JSX.Element;

package/lib/routes/errors/not-found.d.ts

@@ -0,0 +1 @@
+export declare const NotFound: () => import("react/jsx-runtime").JSX.Element;

package/lib/routes/index.d.ts

@@ -0,0 +1,6 @@
+import { QueryClient } from '@tanstack/react-query';
+import { RouteObject, createBrowserRouter } from 'react-router-dom';
+export declare const wikiRoutes: (queryClient: QueryClient) => RouteObject[];
+export declare const routes: (queryClient: QueryClient) => RouteObject[];
+export declare const basename: string;
+export declare const router: (queryClient: QueryClient) => ReturnType<typeof createBrowserRouter>;

package/lib/routes/old-format/index.d.ts

@@ -0,0 +1,36 @@
+import { QueryClient } from '@tanstack/react-query';
+import { LoaderFunctionArgs } from 'react-router-dom';
+/** Load a wiki page OLD-FORMAT content */
+export declare const loader: (queryClient: QueryClient) => ({ params }: LoaderFunctionArgs) => Promise<{
+    comments: {
+        id: string;
+        comment: string;
+        authorId: string;
+        authorName: string;
+        createdAt: number;
+        updatedAt: number;
+        replyTo: string | undefined;
+        deleted: boolean | undefined;
+    }[] | undefined;
+    isVisible: boolean;
+    _id: string;
+    title: string;
+    content: string;
+    contentPlain: string;
+    contentVersion: number;
+    author: string;
+    authorName: string;
+    created?: import('../../models').Created;
+    modified: import('../../models').Modified;
+    lastContributer?: string;
+    lastContributerName?: string;
+    children?: [{
+        _id: string;
+        title: string;
+        isVisible: boolean;
+        position?: number;
+    }];
+    parentId?: string;
+    position?: number;
+} | null>;
+export declare const Component: () => import("react/jsx-runtime").JSX.Element | null;

package/lib/routes/page/create.d.ts

@@ -0,0 +1,4 @@
+import { QueryClient } from '@tanstack/react-query';
+import { ActionFunctionArgs } from 'react-router-dom';
+export declare const action: (queryClient: QueryClient) => ({ params, request }: ActionFunctionArgs) => Promise<Response | null>;
+export declare const CreatePage: () => import("react/jsx-runtime").JSX.Element;

package/lib/routes/page/edit.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Action called when submitting the Edition Page form.
+ * @param queryClient
+ * @returns
+ * if page has children and visibility has changed then
+ *  we return page form data to be used in visibility confirm modal
+ * else
+ *  we redirect to current page
+ */
+export declare const editAction: (queryClient: import('@tanstack/react-query').QueryClient, redirectPath?: string) => ({ params, request }: import('react-router-dom').ActionFunctionArgs) => Promise<import('../../hooks').FormPageDataProps | Response | null>;
+export declare const EditPage: () => import("react/jsx-runtime").JSX.Element | null;

package/lib/routes/page/index.d.ts

@@ -0,0 +1,37 @@
+import { QueryClient } from '@tanstack/react-query';
+import { ActionFunctionArgs, LoaderFunctionArgs } from 'react-router-dom';
+export declare const loader: (queryClient: QueryClient) => ({ params }: LoaderFunctionArgs) => Promise<{
+    comments: {
+        id: string;
+        comment: string;
+        authorId: string;
+        authorName: string;
+        createdAt: number;
+        updatedAt: number;
+        replyTo: string | undefined;
+        deleted: boolean | undefined;
+    }[] | undefined;
+    isVisible: boolean;
+    _id: string;
+    title: string;
+    content: string;
+    contentPlain: string;
+    contentVersion: number;
+    author: string;
+    authorName: string;
+    created?: import('../../models').Created;
+    modified: import('../../models').Modified;
+    lastContributer?: string;
+    lastContributerName?: string;
+    children?: [{
+        _id: string;
+        title: string;
+        isVisible: boolean;
+        position?: number;
+    }];
+    parentId?: string;
+    position?: number;
+}>;
+export declare const action: (queryClient: QueryClient) => ({ params }: ActionFunctionArgs) => Promise<Response | null>;
+export declare const visibleAction: (queryClient: QueryClient, redirectPath?: string) => ({ params, request }: ActionFunctionArgs) => Promise<import('../../hooks').FormPageDataProps | Response | null>;
+export declare const Page: () => string | import("react/jsx-runtime").JSX.Element | null;

package/lib/routes/page/list/list.d.ts

@@ -0,0 +1,46 @@
+import { QueryClient } from '@tanstack/react-query';
+import { ActionFunctionArgs, LoaderFunctionArgs } from 'react-router-dom';
+export declare const loader: (queryClient: QueryClient) => ({ params }: LoaderFunctionArgs) => Promise<{
+    pages: {
+        isVisible: boolean;
+        _id: string;
+        title: string;
+        content: string;
+        contentPlain: string;
+        contentVersion: number;
+        author: string;
+        authorName: string;
+        modified: import('../../../models').Modified;
+        created?: import('../../../models').Created;
+        lastContributer?: string;
+        lastContributerName?: string;
+        comments?: import('../../../models').Comment[];
+        children?: [{
+            _id: string;
+            title: string;
+            isVisible: boolean;
+            position?: number;
+        }];
+        position?: number;
+        parentId?: string;
+        error?: any;
+        views?: number;
+        aiMetadata?: {
+            contentGenerated?: boolean;
+            contentGeneratedDate?: import('../../../models').Created;
+        };
+    }[];
+    _id: string;
+    title: string;
+    thumbnail: string;
+    created: import('../../../models').Created;
+    modified: import('../../../models').Modified;
+    owner: import('../../../models').Owner;
+    rights: string[];
+    index?: string;
+    shared?: string[];
+    aiGenerated?: boolean;
+    aiMetadata?: import('../../../models').AIMetadata;
+}>;
+export declare const action: (queryClient: QueryClient) => ({ params, request }: ActionFunctionArgs) => Promise<void>;
+export declare const PageList: () => string | import("react/jsx-runtime").JSX.Element;

package/lib/routes/page/list/list.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/routes/page/pageEditAction.d.ts

@@ -0,0 +1,4 @@
+import { QueryClient } from '@tanstack/react-query';
+import { ActionFunctionArgs } from 'react-router-dom';
+import { FormPageDataProps } from '../../hooks';
+export declare const pageEditAction: (queryClient: QueryClient, redirectPath?: string) => ({ params, request }: ActionFunctionArgs) => Promise<FormPageDataProps | Response | null>;

package/lib/routes/print/index.d.ts

@@ -0,0 +1,36 @@
+import { QueryClient } from '@tanstack/react-query';
+import { LoaderFunctionArgs } from 'react-router-dom';
+import { Page } from '../../models';
+export declare const printLoader: (queryClient: QueryClient) => ({ params, request }: LoaderFunctionArgs) => Promise<Page[] | {
+    comments: {
+        id: string;
+        comment: string;
+        authorId: string;
+        authorName: string;
+        createdAt: number;
+        updatedAt: number;
+        replyTo: string | undefined;
+        deleted: boolean | undefined;
+    }[] | undefined;
+    isVisible: boolean;
+    _id: string;
+    title: string;
+    content: string;
+    contentPlain: string;
+    contentVersion: number;
+    author: string;
+    authorName: string;
+    created?: import('../../models').Created;
+    modified: import('../../models').Modified;
+    lastContributer?: string;
+    lastContributerName?: string;
+    children?: [{
+        _id: string;
+        title: string;
+        isVisible: boolean;
+        position?: number;
+    }];
+    parentId?: string;
+    position?: number;
+}>;
+export declare const Component: () => import("react/jsx-runtime").JSX.Element | import("react/jsx-runtime").JSX.Element[] | null;

package/lib/routes/root/index.d.ts

@@ -0,0 +1,4 @@
+/** Check old format URL and redirect if needed */
+export declare const loader: () => Promise<null>;
+export declare const Root: () => import("react/jsx-runtime").JSX.Element;
+export default Root;

package/lib/routes/wiki/index.d.ts

@@ -0,0 +1,45 @@
+import { QueryClient } from '@tanstack/react-query';
+import { LoaderFunctionArgs } from 'react-router-dom';
+export declare const loader: (queryClient: QueryClient) => ({ params }: LoaderFunctionArgs) => Promise<{
+    pages: {
+        isVisible: boolean;
+        _id: string;
+        title: string;
+        content: string;
+        contentPlain: string;
+        contentVersion: number;
+        author: string;
+        authorName: string;
+        modified: import('../../models').Modified;
+        created?: import('../../models').Created;
+        lastContributer?: string;
+        lastContributerName?: string;
+        comments?: import('../../models').Comment[];
+        children?: [{
+            _id: string;
+            title: string;
+            isVisible: boolean;
+            position?: number;
+        }];
+        position?: number;
+        parentId?: string;
+        error?: any;
+        views?: number;
+        aiMetadata?: {
+            contentGenerated?: boolean;
+            contentGeneratedDate?: import('../../models').Created;
+        };
+    }[];
+    _id: string;
+    title: string;
+    thumbnail: string;
+    created: import('../../models').Created;
+    modified: import('../../models').Modified;
+    owner: import('../../models').Owner;
+    rights: string[];
+    index?: string;
+    shared?: string[];
+    aiGenerated?: boolean;
+    aiMetadata?: import('../../models').AIMetadata;
+}>;
+export declare const Index: () => import("react/jsx-runtime").JSX.Element;

package/lib/routes/wiki/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/services/api/assistant/assistant.service.d.ts

@@ -0,0 +1,9 @@
+import { AssistantGenerateRequest, AssistantGenerateResponse } from './assistant.types';
+export declare const baseURL = "/wiki";
+export declare const assistantService: {
+    /**
+     * Generate the wiki pages and then the pages content.
+     * @returns a Promise of PagesStructureResponse
+     */
+    generate(requestPayload: AssistantGenerateRequest): Promise<AssistantGenerateResponse>;
+};

package/lib/services/api/assistant/assistant.types.d.ts

@@ -0,0 +1,19 @@
+export interface PagesAssistantAIStep1FormValues {
+    level: string;
+    subject: string;
+}
+export interface PagesAssistantAIStep2FormValues {
+    sequence: string;
+    keywords?: string;
+}
+export interface PagesAssistantAIFormValues extends PagesAssistantAIStep1FormValues, PagesAssistantAIStep2FormValues {
+}
+export interface AssistantGenerateRequest extends PagesAssistantAIFormValues {
+    wikiId: string;
+}
+export interface AssistantGenerateResponse {
+    wikiId: string;
+}
+export interface PageStructure {
+    title: string;
+}

package/lib/services/api/index.d.ts

@@ -0,0 +1,261 @@
+import { ViewsCounters, ViewsDetails } from '@edifice.io/client';
+import { DuplicatePageResultOrError, Page, PagePostPayload, PagePutPayload, PagesPutPayload, PickedWiki, Wiki } from '../../models';
+import { Revision } from '../../models/revision';
+export declare const baseURL = "/wiki";
+export declare const wikiService: {
+    getWikisFromExplorer({ pageSize, startIdx, }: {
+        pageSize?: number;
+        startIdx?: number;
+    }): Promise<import('@edifice.io/client').IResource[]>;
+    /**
+     *
+     * @returns all wikis without pages
+     */
+    getWikis(): Promise<PickedWiki[]>;
+    /**
+     *
+     * @param wikiId string
+     * @returns get a wiki by id
+     */
+    getWiki(wikiId: string): Promise<{
+        pages: {
+            isVisible: boolean;
+            _id: string;
+            title: string;
+            content: string;
+            contentPlain: string;
+            contentVersion: number;
+            author: string;
+            authorName: string;
+            modified: import('../../models').Modified;
+            created?: import('../../models').Created;
+            lastContributer?: string;
+            lastContributerName?: string;
+            comments?: import('../../models').Comment[];
+            children?: [{
+                _id: string;
+                title: string;
+                isVisible: boolean;
+                position?: number;
+            }];
+            position?: number;
+            parentId?: string;
+            error?: any;
+            views?: number;
+            aiMetadata?: {
+                contentGenerated?: boolean;
+                contentGeneratedDate?: import('../../models').Created;
+            };
+        }[];
+        _id: string;
+        title: string;
+        thumbnail: string;
+        created: import('../../models').Created;
+        modified: import('../../models').Modified;
+        owner: import('../../models').Owner;
+        rights: string[];
+        index?: string;
+        shared?: string[];
+        aiGenerated?: boolean;
+        aiMetadata?: import('../../models').AIMetadata;
+    }>;
+    /**
+     *
+     * @param wikiId string
+     * @returns get wiki pages by wiki id
+     */
+    getWikiPages(wikiId: string, content: boolean): Promise<Page[]>;
+    /**
+     *
+     * @returns all wikis with pages
+     */
+    getAllWikisWithPages(): Promise<Wiki[]>;
+    /**
+     *
+     * @param wikiId string
+     * @param pageId string
+     * @returns get a page of a wiki by id
+     */
+    getPage({ wikiId, pageId, originalformat, }: {
+        wikiId: string;
+        pageId: string;
+        originalformat?: boolean;
+    }): Promise<{
+        comments: {
+            id: string;
+            comment: string;
+            authorId: string;
+            authorName: string;
+            createdAt: number;
+            updatedAt: number;
+            replyTo: string | undefined;
+            deleted: boolean | undefined;
+        }[] | undefined;
+        isVisible: boolean;
+        _id: string;
+        title: string;
+        content: string;
+        contentPlain: string;
+        contentVersion: number;
+        author: string;
+        authorName: string;
+        created?: import('../../models').Created;
+        modified: import('../../models').Modified;
+        lastContributer?: string;
+        lastContributerName?: string;
+        children?: [{
+            _id: string;
+            title: string;
+            isVisible: boolean;
+            position?: number;
+        }];
+        parentId?: string;
+        position?: number;
+    }>;
+    /**
+     *
+     * @param wikiId
+     * @param pageId
+     * @returns all revisions of a page
+     */
+    getRevisionsPage({ wikiId, pageId, }: {
+        wikiId: string;
+        pageId: string;
+    }): Promise<Revision[]>;
+    /**
+     *
+     * @param wikiId
+     * @param pageId
+     * @param revisionId
+     * @returns on revision of a page by id
+     */
+    getRevisionPage({ wikiId, pageId, revisionId, }: {
+        wikiId: string;
+        pageId: string;
+        revisionId: string;
+    }): Promise<Revision>;
+    /**
+     *
+     * @param wikiId
+     * @creates a new page
+     */
+    createPage({ wikiId, data, }: {
+        wikiId: string;
+        data: PagePostPayload;
+    }): Promise<Page>;
+    /**
+     *
+     * @param wikiId
+     * @updates a page
+     */
+    updatePage({ wikiId, pageId, data, }: {
+        wikiId: string;
+        pageId: string;
+        data: PagePutPayload;
+    }): Promise<Page>;
+    /**
+     *
+     * @param wikiId
+     * @updates pages
+     */
+    updatePages({ wikiId, data, }: {
+        wikiId: string;
+        data: PagesPutPayload;
+    }): Promise<Page[]>;
+    /**
+     * Delete a page of the current wiki.
+     *
+     * @param {Object} params - expected params to delete a page.
+     * @param {string} params.wikiId - current wiki id.
+     * @param {string} params.pageId - id of a page from the current wiki.
+     * @returns {Promise<void>} a promise after deleting the page
+     */
+    deletePage({ wikiId, pageId }: {
+        wikiId: string;
+        pageId: string;
+    }): Promise<Page>;
+    deletePages({ wikiId, ids }: {
+        wikiId: string;
+        ids: string[];
+    }): Promise<Page[]>;
+    /**
+     * Create a new comment
+     *
+     * @param {Object} params - expected params to create a new comment.
+     * @param {string} params.wikiId - current wiki id.
+     * @param {string} params.pageId - id of a page from the current wiki.
+     * @param {string} params.comment - comment text.
+     * @returns {Promise<void>} a promise after creating the new comment.
+     */
+    createComment({ wikiId, pageId, comment, replyTo, }: {
+        wikiId: string;
+        pageId: string;
+        comment: string;
+        replyTo?: string;
+    }): Promise<Comment>;
+    /**
+     * Update a comment
+     *
+     * @param {Object} params - expected params to update a comment.
+     * @param {string} params.wikiId - current wiki id.
+     * @param {string} params.pageId - id of a page from the current wiki.
+     * @param {string} params.comment - new comment text.
+     * @returns {Promise<void>} a promise after updating the comment.
+     */
+    updateComment({ wikiId, pageId, commentId, comment, }: {
+        wikiId: string;
+        pageId: string;
+        commentId: string;
+        comment: string;
+    }): Promise<Comment>;
+    /**
+     * Delete a comment
+     *
+     * @param {Object} params - expected params to delete a comment.
+     * @param {string} params.wikiId - current wiki id.
+     * @param {string} params.pageId - id of a page from the current wiki.
+     * @param {string} params.commentId - id of the comment to be deleted.
+     * @returns {Promise<void>} a promise after deleting the comment.
+     */
+    deleteComment({ wikiId, pageId, commentId, }: {
+        wikiId: string;
+        pageId: string;
+        commentId: string;
+    }): Promise<Comment>;
+    /**
+     * Duplicate a page
+     *
+     * @param {string} params.sourceWikiId - source wiki id.
+     * @param {string} params.sourcePageId - source page id.
+     * @param {string[]} params.targetWikiIds - target wiki ids.
+     * @returns {Promise<PickedPageId[]>} a promise that resolves to the newly created page.
+     */
+    duplicatePage({ sourceWikiId, sourcePageId, targetWikiIds, shouldIncludeSubPages, }: {
+        sourceWikiId: string;
+        sourcePageId: string;
+        targetWikiIds: string[];
+        shouldIncludeSubPages: boolean;
+    }): Promise<DuplicatePageResultOrError>;
+    /**
+     * Gets pages views counter (audience).
+     * @param {string[]} params.pageIds - pages ids to get views counter.
+     * @returns {Promise<ViewsCounters>} a promise that resolves to the views counters.
+     */
+    getPagesViewsCounter({ pageIds, }: {
+        pageIds: string[];
+    }): Promise<ViewsCounters>;
+    /**
+     * Gets one page view details (audience).
+     * @param {string[]} params.pageIds - page id to get views details.
+     * @returns {Promise<ViewsDetails>} a promise that resolves to the views details.
+     */
+    getPageViewsDetails({ pageId, }: {
+        pageId: string;
+    }): Promise<ViewsDetails | undefined>;
+    /**
+     * Trigger a page view (audience).
+     * @param {string} params.pageId - page id to trigger view.
+     * @returns {Promise<void>} a promise that resolves to void.
+     */
+    triggerPageView(pageId: string): Promise<void>;
+};

package/lib/services/api/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/services/api/poll/poll.service.d.ts

@@ -0,0 +1,17 @@
+import { Poll, PollRequestPayload } from './poll.types';
+export declare const IMPORT_PDF_POLL_ID = "import-pdf";
+export declare const baseURL = "/wiki";
+export declare const pollService: {
+    /**
+     * Get Poll by Poll Name
+     * @param pollName Poll name to retrieve
+     * @returns a Poll object representing the Poll
+     */
+    getPoll(pollName: string): Promise<Poll>;
+    /**
+     * Submit a vote to a poll. The poll is identified by the pollId in the request payload.
+     * @param pollName Name of the poll (used for local storage key)
+     * @param requestPayload JSON object with the vote.
+     */
+    submitPollVote(pollName: string, requestPayload: PollRequestPayload): Promise<void>;
+};

package/lib/services/api/poll/poll.types.d.ts

@@ -0,0 +1,27 @@
+import { Created, Modified } from '../../../models';
+export declare enum PollVoteResult {
+    YES = "YES",
+    NO = "NO"
+}
+export interface PollRequestPayload {
+    vote: PollVoteResult;
+}
+export interface PollVote {
+    vote: PollVoteResult;
+    userId: string;
+    userName: string;
+    userEmail: string;
+    created: Created;
+    modified: Modified;
+}
+export interface Poll {
+    _id: string;
+    name: string;
+    description: string;
+    votes: Array<PollVote>;
+    created: Created;
+    modified: Modified;
+    authorId: string;
+    authorName: string;
+    authorEmail: string;
+}

package/lib/services/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * API
+ */
+export * from './api';
+/**
+ * Queries
+ */
+export * from './queries';
+/**
+ * Explorer Service
+ */
+export * from './resource';

package/lib/services/queries/actions.d.ts

@@ -0,0 +1,11 @@
+import { IAction } from '@edifice.io/client';
+/**
+ * actionsQueryOptions: check action availability depending on workflow right
+ * @param actions (expects an array of actions)
+ * @returns queryOptions with key, fn, and selected data
+ */
+export declare const actionsQueryOptions: (actions: IAction[]) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<Record<string, boolean>, Error, IAction[], import('@tanstack/react-query').QueryKey>, "queryFn"> & {
+    queryFn?: import('@tanstack/react-query').QueryFunction<Record<string, boolean>, import('@tanstack/react-query').QueryKey, never> | undefined;
+} & {
+    queryKey: import('@tanstack/react-query').DataTag<import('@tanstack/react-query').QueryKey, Record<string, boolean>>;
+};

package/lib/services/queries/comment.d.ts

@@ -0,0 +1,20 @@
+/**
+ * All queries and mutations
+ */
+export declare const useCreateComment: () => import('@tanstack/react-query').UseMutationResult<Comment, Error, {
+    wikiId: string;
+    pageId: string;
+    comment: string;
+    replyTo?: string;
+}, unknown>;
+export declare const useUpdateComment: () => import('@tanstack/react-query').UseMutationResult<Comment, Error, {
+    wikiId: string;
+    pageId: string;
+    commentId: string;
+    comment: string;
+}, unknown>;
+export declare const useDeleteComment: () => import('@tanstack/react-query').UseMutationResult<Comment, Error, {
+    wikiId: string;
+    pageId: string;
+    commentId: string;
+}, unknown>;

package/lib/services/queries/index.d.ts

@@ -0,0 +1,4 @@
+export * from './actions';
+export * from './comment';
+export * from './page/page';
+export * from './wiki/wiki';