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

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

@@ -0,0 +1,264 @@
+import { DuplicatePageResultOrError, PagePostPayload, PagePutPayload } from '../../../models';
+/**
+ * Page Query Options Factory
+ */
+export declare const pageQueryOptions: {
+    base: readonly ["page"];
+    findOne: ({ wikiId, pageId, originalformat, }: {
+        wikiId: string;
+        pageId: string;
+        originalformat?: boolean;
+    }) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<{
+        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;
+    }, Error, {
+        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;
+    }, import('@tanstack/react-query').QueryKey>, "queryFn"> & {
+        queryFn?: import('@tanstack/react-query').QueryFunction<{
+            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;
+        }, import('@tanstack/react-query').QueryKey, never> | undefined;
+    } & {
+        queryKey: import('@tanstack/react-query').DataTag<import('@tanstack/react-query').QueryKey, {
+            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;
+        }>;
+    };
+    findAllFromWiki: ({ wikiId, content, }: {
+        wikiId: string;
+        content: boolean;
+    }) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<import('../../../models').Page[], Error, import('../../../models').Page[], import('@tanstack/react-query').QueryKey>, "queryFn"> & {
+        queryFn?: import('@tanstack/react-query').QueryFunction<import('../../../models').Page[], import('@tanstack/react-query').QueryKey, never> | undefined;
+    } & {
+        queryKey: import('@tanstack/react-query').DataTag<import('@tanstack/react-query').QueryKey, import('../../../models').Page[]>;
+    };
+    findAllRevisionsForPage: ({ wikiId, pageId, }: {
+        wikiId: string;
+        pageId: string;
+    }) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<import('../../../models/revision').Revision[], Error, import('../../../models/revision').Revision[], import('@tanstack/react-query').QueryKey>, "queryFn"> & {
+        queryFn?: import('@tanstack/react-query').QueryFunction<import('../../../models/revision').Revision[], import('@tanstack/react-query').QueryKey, never> | undefined;
+    } & {
+        queryKey: import('@tanstack/react-query').DataTag<import('@tanstack/react-query').QueryKey, import('../../../models/revision').Revision[]>;
+    };
+    findOneRevision: ({ wikiId, pageId, revisionId, }: {
+        wikiId: string;
+        pageId: string;
+        revisionId?: string;
+    }) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<import('../../../models/revision').Revision, Error, import('../../../models/revision').Revision, import('@tanstack/react-query').QueryKey>, "queryFn"> & {
+        queryFn?: import('@tanstack/react-query').QueryFunction<import('../../../models/revision').Revision, import('@tanstack/react-query').QueryKey, never> | undefined;
+    } & {
+        queryKey: import('@tanstack/react-query').DataTag<import('@tanstack/react-query').QueryKey, import('../../../models/revision').Revision>;
+    };
+    findPagesViewsCounter: ({ pageIds }: {
+        pageIds: string[];
+    }) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<import('@edifice.io/client').ViewsCounters, Error, import('@edifice.io/client').ViewsCounters, import('@tanstack/react-query').QueryKey>, "queryFn"> & {
+        queryFn?: import('@tanstack/react-query').QueryFunction<import('@edifice.io/client').ViewsCounters, import('@tanstack/react-query').QueryKey, never> | undefined;
+    } & {
+        queryKey: import('@tanstack/react-query').DataTag<import('@tanstack/react-query').QueryKey, import('@edifice.io/client').ViewsCounters>;
+    };
+    findPageViewsDetails: ({ pageId }: {
+        pageId: string;
+    }) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<import('@edifice.io/client').ViewsDetails | undefined, Error, import('@edifice.io/client').ViewsDetails | undefined, import('@tanstack/react-query').QueryKey>, "queryFn"> & {
+        queryFn?: import('@tanstack/react-query').QueryFunction<import('@edifice.io/client').ViewsDetails | undefined, import('@tanstack/react-query').QueryKey, never> | undefined;
+    } & {
+        queryKey: import('@tanstack/react-query').DataTag<import('@tanstack/react-query').QueryKey, import('@edifice.io/client').ViewsDetails | undefined>;
+    };
+};
+/**
+ * All queries and mutations
+ */
+export declare const useGetPage: ({ wikiId, pageId, originalformat, }: {
+    wikiId: string;
+    pageId: string;
+    originalformat?: boolean;
+}) => import('@tanstack/react-query').UseQueryResult<{
+    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;
+}, Error>;
+export declare const useGetPagesFromWiki: ({ wikiId, content, }: {
+    wikiId: string;
+    content: boolean;
+}) => import('@tanstack/react-query').UseQueryResult<import('../../../models').Page[], Error>;
+export declare const useGetPagesViewsCounter: ({ pageIds }: {
+    pageIds: string[];
+}) => import('@tanstack/react-query').UseQueryResult<import('@edifice.io/client').ViewsCounters, Error>;
+export declare const useGetPageViewsDetails: ({ pageId }: {
+    pageId: string;
+}) => import('@tanstack/react-query').UseQueryResult<import('@edifice.io/client').ViewsDetails | undefined, Error>;
+export declare const useGetRevisionsPage: ({ wikiId, pageId, }: {
+    wikiId: string;
+    pageId: string;
+}) => import('@tanstack/react-query').UseQueryResult<import('../../../models/revision').Revision[], Error>;
+export declare const useGetRevisionPage: ({ wikiId, pageId, revisionId, }: {
+    wikiId: string;
+    pageId: string;
+    revisionId?: string;
+}) => import('@tanstack/react-query').UseQueryResult<import('../../../models/revision').Revision, Error>;
+export declare const useCreatePage: () => import('@tanstack/react-query').UseMutationResult<import('../../../models').Page, Error, {
+    wikiId: string;
+    data: PagePostPayload;
+}, unknown>;
+export declare const useUpdatePage: () => import('@tanstack/react-query').UseMutationResult<import('../../../models').Page, Error, {
+    wikiId: string;
+    pageId: string;
+    data: PagePutPayload;
+}, unknown>;
+export declare const useDeletePage: () => import('@tanstack/react-query').UseMutationResult<import('../../../models').Page, Error, {
+    wikiId: string;
+    pageId: string;
+}, unknown>;
+/**
+ * Duplicate page mutation
+ * On success, invalidate the following queries:
+ */
+export declare const useDuplicatePage: () => {
+    shouldIncludeSubPages: boolean;
+    toggleShouldIncludeSubPages: () => void;
+    mutation: import('@tanstack/react-query').UseMutationResult<DuplicatePageResultOrError, Error, {
+        sourceWikiId: string;
+        sourcePageId: string;
+        targetWikiIds: string[];
+        shouldIncludeSubPages: boolean;
+    }, unknown>;
+};

package/lib/services/queries/page/page.test.d.ts

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

package/lib/services/queries/poll/poll.query.d.ts

@@ -0,0 +1,9 @@
+export declare const pollQueryOptions: {
+    base: readonly ["poll"];
+    findOne: (pollName: string) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<import('../../api/poll/poll.types').Poll, Error, import('../../api/poll/poll.types').Poll, import('@tanstack/react-query').QueryKey>, "queryFn"> & {
+        queryFn?: import('@tanstack/react-query').QueryFunction<import('../../api/poll/poll.types').Poll, import('@tanstack/react-query').QueryKey, never> | undefined;
+    } & {
+        queryKey: import('@tanstack/react-query').DataTag<import('@tanstack/react-query').QueryKey, import('../../api/poll/poll.types').Poll>;
+    };
+};
+export declare const useGetPoll: (pollName: string) => import('@tanstack/react-query').UseQueryResult<import('../../api/poll/poll.types').Poll, Error>;

package/lib/services/queries/poll/poll.test.d.ts

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

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

@@ -0,0 +1,235 @@
+/**
+ * Wiki Query Options Factory
+ */
+export declare const wikiQueryOptions: {
+    base: readonly ["wiki"];
+    findAllAsResources: () => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<import('@edifice.io/client').IResource[], Error, import('@edifice.io/client').IResource[], import('@tanstack/react-query').QueryKey>, "queryFn"> & {
+        queryFn?: import('@tanstack/react-query').QueryFunction<import('@edifice.io/client').IResource[], import('@tanstack/react-query').QueryKey, never> | undefined;
+    } & {
+        queryKey: import('@tanstack/react-query').DataTag<import('@tanstack/react-query').QueryKey, import('@edifice.io/client').IResource[]>;
+    };
+    findAll: () => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<import('../../../models').PickedWiki[], Error, import('../../../models').PickedWiki[], import('@tanstack/react-query').QueryKey>, "queryFn"> & {
+        queryFn?: import('@tanstack/react-query').QueryFunction<import('../../../models').PickedWiki[], import('@tanstack/react-query').QueryKey, never> | undefined;
+    } & {
+        queryKey: import('@tanstack/react-query').DataTag<import('@tanstack/react-query').QueryKey, import('../../../models').PickedWiki[]>;
+    };
+    findAllWithPages: () => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<import('../../../models').Wiki[], Error, import('../../../models').Wiki[], import('@tanstack/react-query').QueryKey>, "queryFn"> & {
+        queryFn?: import('@tanstack/react-query').QueryFunction<import('../../../models').Wiki[], import('@tanstack/react-query').QueryKey, never> | undefined;
+    } & {
+        queryKey: import('@tanstack/react-query').DataTag<import('@tanstack/react-query').QueryKey, import('../../../models').Wiki[]>;
+    };
+    findOne: (wikiId: string) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<{
+        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;
+    }, Error, {
+        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;
+    }, import('@tanstack/react-query').QueryKey>, "queryFn"> & {
+        queryFn?: import('@tanstack/react-query').QueryFunction<{
+            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;
+        }, import('@tanstack/react-query').QueryKey, never> | undefined;
+    } & {
+        queryKey: import('@tanstack/react-query').DataTag<import('@tanstack/react-query').QueryKey, {
+            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 useGetWikis: () => import('@tanstack/react-query').UseQueryResult<import('../../../models').PickedWiki[], Error>;
+export declare const useGetAllWikisAsResources: () => import('@tanstack/react-query').UseQueryResult<import('@edifice.io/client').IResource[], Error>;
+export declare const useGetAllWikisWithPages: () => import('@tanstack/react-query').UseQueryResult<import('../../../models').Wiki[], Error>;
+export declare const useGetWiki: (wikiId: string) => import('@tanstack/react-query').UseQueryResult<{
+    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;
+}, Error>;

package/lib/services/queries/wiki/wiki.test.d.ts

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

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

@@ -0,0 +1,47 @@
+import { CreateParameters, CreateResult, ResourceService, UpdateParameters, UpdateResult } from '@edifice.io/client';
+export declare class WikiResourceService extends ResourceService {
+    /**
+     *
+     * @returns APP
+     */
+    getApplication(): string;
+    /**
+     *
+     * @param resourceId
+     * @returns print url
+     */
+    getPrintUrl(resourceId: string): string;
+    /**
+     *
+     * @param resourceId
+     * @returns resource url
+     */
+    getViewUrl(resourceId: string): string;
+    /**
+     * (optional) Must be use to redirect to angularjs route to create a resource
+     * @param folderId
+     */
+    getFormUrl(): string;
+    /**
+     * (optional) Must be use to redirect to angularjs route to edit a resource
+     * @param resourceId
+     */
+    getEditUrl(): string;
+    /**
+     * Allow to create a new resource
+     * @param parameters
+     * @returns id and thumbnail
+     */
+    create(parameters: CreateParameters): Promise<CreateResult>;
+    /**
+     * Allow to update a resource
+     * @param parameters
+     * @returns thumbnail and id
+     */
+    update(parameters: UpdateParameters): Promise<UpdateResult>;
+    /**
+     *
+     * @returns RESOURCE
+     */
+    getResourceType(): string;
+}

package/lib/store/assistant/index.d.ts

@@ -0,0 +1,7 @@
+import { PagesAssistantAIFormValues, PageStructure } from '../../services/api/assistant/assistant.types';
+export declare const useFormValuesStore: () => PagesAssistantAIFormValues;
+export declare const usePagesStructureStore: () => PageStructure[];
+export declare const usePagesAssistantActions: () => {
+    setFormValues: (formData: PagesAssistantAIFormValues) => void;
+    setPagesStructure: (pagesStructure: PageStructure[]) => void;
+};

package/lib/store/index.d.ts

@@ -0,0 +1,3 @@
+export * from './rights';
+export * from './treeview';
+export * from './wiki';

package/lib/store/rights/index.d.ts

@@ -0,0 +1,11 @@
+import { RightRole } from '@edifice.io/client';
+type UserRights = Record<RightRole, boolean>;
+export declare const getUserRights: () => UserRights;
+export declare const getUserRightsActions: () => {
+    setUserRights: (userRights: UserRights) => void;
+};
+export declare const useUserRights: () => UserRights;
+export declare const useUserRightsActions: () => {
+    setUserRights: (userRights: UserRights) => void;
+};
+export {};

package/lib/store/toast/index.d.ts

@@ -0,0 +1,13 @@
+interface ToastMessage {
+    type: 'success' | 'error' | 'info' | 'warning';
+    text: string;
+}
+export declare const getToastActions: () => {
+    addToastMessage: (message: Omit<ToastMessage, "id">) => void;
+};
+export declare const useToastMessages: () => ToastMessage[];
+export declare const useToastActions: () => {
+    addToastMessage: (message: Omit<ToastMessage, "id">) => void;
+    clearToastMessages: () => void;
+};
+export {};

package/lib/store/treeview/index.d.ts

@@ -0,0 +1,12 @@
+import { WikiTreeItem } from '../../models';
+export declare const getTreeData: () => WikiTreeItem[];
+export declare const getTreeActions: () => {
+    setTreeData: (treeData: WikiTreeItem[]) => void;
+    setSelectedNodeId: (selectedNodeId: string | null) => void;
+};
+export declare const useTreeData: () => WikiTreeItem[];
+export declare const useSelectedNodeId: () => string | null;
+export declare const useTreeActions: () => {
+    setTreeData: (treeData: WikiTreeItem[]) => void;
+    setSelectedNodeId: (selectedNodeId: string | null) => void;
+};