@yimingliao/cms 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,841 @@
+import jwt from 'jsonwebtoken';
+import { BinaryLike } from 'node:crypto';
+import { cookies } from 'next/headers';
+
+interface JwtServiceConfig {
+    defaultSecret: string;
+    issuer?: string;
+    audience?: string;
+}
+/**
+ * JWT service
+ *
+ * Sign, Verify
+ */
+declare function createJwtService(config: JwtServiceConfig): {
+    sign: ({ payload, secret, expiresIn, }: {
+        payload: object;
+        secret: string;
+        expiresIn: number;
+    }) => string;
+    verify: ({ token, secret, }: {
+        token: string;
+        secret: string;
+    }) => jwt.JwtPayload;
+};
+
+declare function createArgon2Service(): {
+    hash: (password: string) => Promise<string>;
+    verify: (hash: string, plain: string) => Promise<boolean>;
+};
+
+interface CryptoServiceConfig {
+    defaultSecret: string;
+}
+/**
+ * Crypto service
+ *
+ * Encrypt & Decrypt, Calculate checksum, Sign
+ */
+declare function createCryptoService(config: CryptoServiceConfig): {
+    generateToken: () => string;
+    hash: (value: BinaryLike) => string;
+    hashBuffer: (value: BinaryLike) => Buffer;
+    encrypt: (data: string) => string;
+    decrypt: (data: string) => string;
+    sign: ({ value, expireSeconds, createdAt, }: {
+        value: string;
+        expireSeconds: number;
+        createdAt?: number;
+    }) => {
+        signed: string;
+        signature: string;
+    };
+};
+
+/**
+ * Cookie Service
+ *
+ * Set, Get, Verify, Delete
+ */
+declare function createCookieService(nextCookies: () => Promise<Awaited<ReturnType<typeof cookies>>>, cryptoService: ReturnType<typeof createCryptoService>): {
+    set: ({ name, value, expireSeconds, }: {
+        name: string;
+        value: string;
+        expireSeconds: number;
+    }) => Promise<void>;
+    setSignedCookie: ({ name, value, expireSeconds, }: {
+        name: string;
+        value: string;
+        expireSeconds: number;
+    }) => Promise<void>;
+    get: ({ name }: {
+        name: string;
+    }) => Promise<string | undefined>;
+    getSignedCookie: ({ name }: {
+        name: string;
+    }) => Promise<string>;
+    verifySignedCookie: ({ signed }: {
+        signed: string | undefined;
+    }) => string;
+    delete: ({ name }: {
+        name: string;
+    }) => Promise<void>;
+};
+
+declare const ADMIN_ROLES: {
+    SUPER_ADMIN: "SUPER_ADMIN";
+    ADMIN: "ADMIN";
+    EDITOR: "EDITOR";
+};
+type AdminRole = (typeof ADMIN_ROLES)[keyof typeof ADMIN_ROLES];
+
+interface Admin {
+    id: string;
+    email: string;
+    role: AdminRole;
+    passwordHash: string;
+    socialLinks: string[];
+    avatarImageId: string | null;
+    createdAt: Date;
+    updatedAt: Date;
+    emailVerifiedAt: Date | null;
+}
+type AdminSafe = Omit<Admin, "passwordHash">;
+
+type BaseTranslation<T extends string = string> = {
+    locale: T;
+};
+type Translation<T extends string = string> = BaseTranslation<T> & {
+    [k: string]: unknown;
+};
+
+interface AdminTranslation extends Translation {
+    id: string;
+    locale: string;
+    adminId: string;
+    name: string | null;
+    authorName: string | null;
+    description: string | null;
+    jobTitle: string | null;
+    url: string | null;
+    worksFor: string | null;
+    knowsAbout: string[];
+    homeLocation: string | null;
+    nationality: string | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+interface DeviceInfo {
+    deviceType: "mobile" | "tablet" | "console" | "smarttv" | "wearable" | "xr" | "embedded";
+    platform: string;
+    timezone?: string;
+    language?: string;
+    screenResolution?: {
+        width: number;
+        height: number;
+    };
+    browser?: string;
+    browserVersion?: string;
+    userAgent?: string;
+    [key: string]: unknown;
+}
+
+interface AdminRefreshToken {
+    id: string;
+    tokenHash: string;
+    email: string;
+    ip: string;
+    deviceInfo: DeviceInfo | null;
+    adminId: string;
+    createdAt: Date;
+    expiresAt: Date;
+}
+
+declare const FILE_TYPES: {
+    IMAGE: "IMAGE";
+    AUDIO: "AUDIO";
+    VIDEO: "VIDEO";
+    DOCUMENT: "DOCUMENT";
+    ARCHIVE: "ARCHIVE";
+    OTHER: "OTHER";
+};
+type FileType = (typeof FILE_TYPES)[keyof typeof FILE_TYPES];
+
+interface File$1 {
+    id: string;
+    key: string;
+    checksum: string;
+    width: number | null;
+    height: number | null;
+    duration: number | null;
+    originalName: string;
+    size: number;
+    extension: string;
+    mimeType: string;
+    type: FileType;
+    isLocked: boolean;
+    folderId: string | null;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt: Date | null;
+}
+
+interface FileTranslation extends Translation {
+    id: string;
+    locale: string;
+    name: string | null;
+    alt: string | null;
+    fileId: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+interface Folder {
+    id: string;
+    name: string;
+    key: string;
+    isLocked: boolean;
+    parentFolderId: string | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+type FolderFull = Folder & {
+    parentFolder: (Folder & {
+        subFolders: Folder[];
+        files: File$1[];
+    }) | null;
+    subFolders: Folder[];
+    files: File$1[];
+};
+
+declare const POST_TYPES: {
+    TOPIC: "TOPIC";
+    CATEGORY: "CATEGORY";
+    POST: "POST";
+    TAG: "TAG";
+    PAGE: "PAGE";
+};
+type PostType = (typeof POST_TYPES)[keyof typeof POST_TYPES];
+interface ExternalLink {
+    name: string;
+    href: string;
+}
+interface Faq {
+    question: string;
+    answer: string;
+}
+interface TocItem {
+    text: string;
+    id: string;
+    level: 2 | 3 | 4 | 5 | 6;
+    children?: TocItem[];
+}
+
+interface Post {
+    id: string;
+    type: PostType;
+    isLocked: boolean;
+    isActive: boolean;
+    isIndexActive: boolean;
+    index: number | null;
+    isSlugActive: boolean;
+    slug: string;
+    isFeatured: boolean;
+    isShownOnHome: boolean;
+    authorId: string | null;
+    topicId: string | null;
+    coverImageId: string | null;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt: Date | null;
+    state1: boolean;
+    state2: boolean;
+    state3: boolean;
+    state4: boolean;
+    state5: boolean;
+    state6: boolean;
+    state7: boolean;
+    state8: boolean;
+    state9: boolean;
+    state10: boolean;
+    image1Id: string | null;
+    image2Id: string | null;
+    image3Id: string | null;
+    image4Id: string | null;
+    text1: string | null;
+    text2: string | null;
+    text3: string | null;
+    text4: string | null;
+    text5: string | null;
+    text6: string | null;
+    text7: string | null;
+    text8: string | null;
+    text9: string | null;
+    text10: string | null;
+    data1: any[];
+    data2: any[];
+    data3: any[];
+    data4: any[];
+}
+
+interface PostTranslation extends Translation {
+    id: string;
+    locale: string;
+    title: string | null;
+    subtitle: string | null;
+    summary: string | null;
+    description: string | null;
+    content: string | null;
+    externalLinks: ExternalLink[];
+    faq: Faq[];
+    toc: TocItem[];
+    readTime: number | null;
+    wordCount: number;
+    postId: string;
+    createdAt: Date;
+    updatedAt: Date;
+    text1: string | null;
+    text2: string | null;
+    text3: string | null;
+    text4: string | null;
+    text5: string | null;
+    text6: string | null;
+    text7: string | null;
+    text8: string | null;
+    text9: string | null;
+    text10: string | null;
+    data1: any[];
+    data2: any[];
+    data3: any[];
+    data4: any[];
+}
+
+type PostListCard = Post & {
+    topic: (Post & {
+        translations: PostTranslation[];
+    }) | null;
+    postsInTopic: Post[];
+    children: Post[];
+    taggedPosts: Post[];
+    coverImage: File$1 | null;
+    translations: PostTranslation[];
+};
+
+type PostFull = Post & {
+    author: AdminCard | null;
+    topic: PostListCard | null;
+    postsInTopic: PostListCard[];
+    parents: PostListCard[];
+    children: PostListCard[];
+    tags: PostListCard[];
+    taggedPosts: PostListCard[];
+    relatedPosts: PostListCard[];
+    referencingPosts: PostListCard[];
+    coverImage: FileCard | null;
+    images1: FileCard[];
+    images2: FileCard[];
+    image1: FileCard | null;
+    image2: FileCard | null;
+    image3: FileCard | null;
+    image4: FileCard | null;
+    translations: PostTranslation[];
+};
+
+type FileFull = File$1 & {
+    folder: Folder | null;
+    adminAsAvatarImage: Admin[];
+    postsAsCoverImage: Post[];
+    postsAsContentImage: Post[];
+    postsAsImages1: Post[];
+    postsAsImages2: Post[];
+    postsAsImage1: Post[];
+    postsAsImage2: Post[];
+    postsAsImage3: Post[];
+    postsAsImage4: Post[];
+    translations: FileTranslation[];
+};
+
+type FileCard = File$1 & {
+    translations: FileTranslation[];
+};
+
+type AdminFull = AdminSafe & {
+    adminRefreshTokens: AdminRefreshToken[];
+    avatarImage: (File$1 & {
+        translations: FileTranslation[];
+    }) | null;
+    posts: Post[];
+    translations: AdminTranslation[];
+};
+
+type AdminCard = AdminSafe & {
+    translations: AdminTranslation[];
+};
+
+type SingleItem = {
+    id: string;
+} | null;
+type MultiItems = {
+    id: string;
+}[];
+
+interface CreateParams$4 {
+    email: string;
+    role: AdminRole;
+    passwordHash: string;
+    socialLinks: string[];
+    avatarImage: SingleItem;
+    translations: (BaseTranslation & {
+        name: string | null;
+        authorName: string | null;
+        description: string | null;
+        jobTitle: string | null;
+        url: string | null;
+        worksFor: string | null;
+        knowsAbout: string[];
+        homeLocation: string | null;
+        nationality: string | null;
+    })[];
+}
+interface UpdateParams$3 {
+    id: string;
+    email?: string;
+    role: AdminRole;
+    socialLinks: string[];
+    avatarImage: SingleItem;
+    emailVerifiedAt: Date | null;
+    translations: (BaseTranslation & {
+        name: string | null;
+        authorName: string | null;
+        description: string | null;
+        jobTitle: string | null;
+        url: string | null;
+        worksFor: string | null;
+        knowsAbout: string[];
+        homeLocation: string | null;
+        nationality: string | null;
+    })[];
+}
+
+declare function createAdminCommandRepository(prisma: any): {
+    create: ({ avatarImage, translations, ...params }: CreateParams$4) => Promise<Admin>;
+    update: ({ id, avatarImage, translations, ...params }: UpdateParams$3) => Promise<Admin>;
+    delete: ({ id }: {
+        id: string;
+    }) => Promise<Admin>;
+};
+
+interface FindListCardsParams$3 {
+    locale: string;
+    searchString?: string;
+    role?: AdminRole;
+    adminIds?: string[];
+    page?: number;
+    pageSize?: number;
+}
+interface FindParams$2 {
+    id?: string;
+    email?: string;
+}
+
+declare function createAdminQueryRepository(prisma: any): {
+    findListCards: ({ locale, searchString, role, adminIds, page, pageSize, }: FindListCardsParams$3) => Promise<{
+        items: AdminFull[];
+        total: number;
+    }>;
+    find: (params: FindParams$2) => Promise<AdminSafe | null>;
+    findFull: (params: FindParams$2) => Promise<AdminFull | null>;
+    findWithPasswordHash: (params: FindParams$2) => Promise<Admin | null>;
+};
+
+interface CreateParams$3 {
+    tokenHash: string;
+    email: string;
+    ip: string;
+    deviceInfo?: DeviceInfo;
+    adminId: string;
+    expiresAt: Date;
+}
+interface DeleteParams {
+    id?: string;
+    tokenHash?: string;
+}
+
+declare function createAdminRefreshTokenCommandRepository(prisma: any): {
+    create: ({ adminId, ...params }: CreateParams$3) => Promise<AdminRefreshToken>;
+    delete: ({ id, tokenHash }: DeleteParams) => Promise<void>;
+    deleteManyByExpired: () => Promise<number>;
+};
+
+declare function createAdminRefreshTokenQueryRepository(prisma: any): {
+    findManyByAdminId: ({ adminId, }: {
+        adminId: string;
+    }) => Promise<AdminRefreshToken[]>;
+    findByToken: ({ tokenHash, }: {
+        tokenHash: string;
+    }) => Promise<AdminRefreshToken | null>;
+};
+
+interface CreateParams$2 {
+    key: string;
+    checksum: string;
+    fileMeta: {
+        type?: string;
+        size?: number;
+        name?: string;
+    };
+    width?: number | null;
+    height?: number | null;
+    duration?: number | null;
+    folder?: SingleItem;
+    translations: (BaseTranslation & {
+        name: string | null;
+        alt: string | null;
+    })[];
+}
+interface UpdateParams$2 {
+    id: string;
+    file: File$1;
+    key: string;
+    checksum: string;
+    fileMeta: {
+        type?: string;
+        size?: number;
+        name?: string;
+    };
+    width?: number | null;
+    height?: number | null;
+    duration?: number | null;
+    folder?: SingleItem;
+    translations: (BaseTranslation & {
+        name: string | null;
+        alt: string | null;
+    })[];
+}
+
+declare function createFileCommandRepository(prisma: any): {
+    create: ({ fileMeta, folder, translations, ...params }: CreateParams$2) => Promise<FileFull>;
+    update: ({ file, id, fileMeta, folder, translations, ...params }: UpdateParams$2) => Promise<File>;
+    softDelete: ({ id }: {
+        id: string;
+    }) => Promise<File>;
+    softDeleteMany: ({ ids }: {
+        ids: string[];
+    }) => Promise<number>;
+    restoreMany: ({ ids }: {
+        ids: string[];
+    }) => Promise<number>;
+    delete: ({ id }: {
+        id: string;
+    }) => Promise<File>;
+};
+
+interface FindListCardsParams$2 {
+    locale: string;
+    searchString?: string;
+    type?: FileType | null;
+    isDeleted?: boolean;
+    isLocked?: boolean | null;
+    folderId?: string;
+    fileIds?: string[];
+    page?: number;
+    pageSize?: number;
+}
+
+declare function createFileQueryRepository(prisma: any): {
+    findListCards: ({ locale, page, pageSize, searchString, type, folderId, isLocked, isDeleted, fileIds, }: FindListCardsParams$2) => Promise<{
+        items: FileFull[];
+        total: number;
+    }>;
+    findManyByIds: ({ ids, }: {
+        ids: string[];
+    }) => Promise<FileFull[]>;
+    findFull: ({ id }: {
+        id: string;
+    }) => Promise<FileFull | null>;
+};
+
+interface CreateParams$1 {
+    key: string;
+    name: string;
+    parentFolder: Folder | null;
+}
+interface UpdateParams$1 {
+    id: string;
+    key: string;
+    name: string;
+    parentFolder: Folder | null;
+}
+
+declare function createFolderCommandRepository(prisma: any): {
+    create: ({ parentFolder, ...params }: CreateParams$1) => Promise<Folder>;
+    update: ({ id, parentFolder, ...params }: UpdateParams$1) => Promise<Folder>;
+    delete: ({ id }: {
+        id: string;
+    }) => Promise<Folder>;
+};
+
+interface FindListCardsParams$1 {
+    searchString?: string;
+    parentFolderId?: string;
+    folderIds?: string[];
+    page?: number;
+    pageSize?: number;
+}
+interface FindParams$1 {
+    id?: string;
+    key?: string;
+}
+
+declare function createFolderQueryRepository(prisma: any): {
+    findListCards: ({ searchString, parentFolderId, folderIds, page, pageSize, }: FindListCardsParams$1) => Promise<{
+        items: FolderFull[];
+        total: number;
+    }>;
+    findFull: (params: FindParams$1) => Promise<FolderFull | null>;
+};
+
+interface CreateParams {
+    type: PostType;
+    isLocked: boolean;
+    isActive: boolean;
+    isIndexActive: boolean;
+    index: number | null;
+    isSlugActive: boolean;
+    slug: string | null;
+    isFeatured: boolean;
+    isShownOnHome: boolean;
+    author: SingleItem;
+    topicId: string | null;
+    parents: MultiItems;
+    tags: MultiItems;
+    relatedPosts: MultiItems;
+    coverImage: SingleItem;
+    contentImageIds: string[];
+    state1: boolean;
+    state2: boolean;
+    state3: boolean;
+    state4: boolean;
+    state5: boolean;
+    state6: boolean;
+    state7: boolean;
+    state8: boolean;
+    state9: boolean;
+    state10: boolean;
+    images1: MultiItems;
+    images2: MultiItems;
+    image1: SingleItem;
+    image2: SingleItem;
+    image3: SingleItem;
+    image4: SingleItem;
+    text1: string | null;
+    text2: string | null;
+    text3: string | null;
+    text4: string | null;
+    text5: string | null;
+    text6: string | null;
+    text7: string | null;
+    text8: string | null;
+    text9: string | null;
+    text10: string | null;
+    data1: any[];
+    data2: any[];
+    data3: any[];
+    data4: any[];
+    translations: (BaseTranslation & {
+        title: string | null;
+        subtitle: string | null;
+        summary: string | null;
+        description: string | null;
+        content: string | null;
+        externalLinks: ExternalLink[];
+        faq: Faq[];
+        toc: TocItem[];
+        readTime: number | null;
+        wordCount: number;
+        text1: string | null;
+        text2: string | null;
+        text3: string | null;
+        text4: string | null;
+        text5: string | null;
+        text6: string | null;
+        text7: string | null;
+        text8: string | null;
+        text9: string | null;
+        text10: string | null;
+        data1: any[];
+        data2: any[];
+        data3: any[];
+        data4: any[];
+    })[];
+}
+interface UpdateParams {
+    id: string;
+    type: PostType;
+    isLocked: boolean;
+    isActive: boolean;
+    isIndexActive: boolean;
+    index: number | null;
+    isSlugActive: boolean;
+    slug: string | null;
+    isFeatured: boolean;
+    isShownOnHome: boolean;
+    author: SingleItem;
+    topicId: string | null;
+    parents: MultiItems;
+    tags: MultiItems;
+    relatedPosts: MultiItems;
+    coverImage: SingleItem;
+    contentImageIds: string[];
+    state1: boolean;
+    state2: boolean;
+    state3: boolean;
+    state4: boolean;
+    state5: boolean;
+    state6: boolean;
+    state7: boolean;
+    state8: boolean;
+    state9: boolean;
+    state10: boolean;
+    images1: MultiItems;
+    images2: MultiItems;
+    image1: SingleItem;
+    image2: SingleItem;
+    image3: SingleItem;
+    image4: SingleItem;
+    text1: string | null;
+    text2: string | null;
+    text3: string | null;
+    text4: string | null;
+    text5: string | null;
+    text6: string | null;
+    text7: string | null;
+    text8: string | null;
+    text9: string | null;
+    text10: string | null;
+    data1: any[];
+    data2: any[];
+    data3: any[];
+    data4: any[];
+    translations: (BaseTranslation & {
+        title: string | null;
+        subtitle: string | null;
+        summary: string | null;
+        description: string | null;
+        content: string | null;
+        externalLinks: ExternalLink[];
+        faq: Faq[];
+        toc: TocItem[];
+        readTime: number | null;
+        wordCount: number;
+        text1: string | null;
+        text2: string | null;
+        text3: string | null;
+        text4: string | null;
+        text5: string | null;
+        text6: string | null;
+        text7: string | null;
+        text8: string | null;
+        text9: string | null;
+        text10: string | null;
+        data1: any[];
+        data2: any[];
+        data3: any[];
+        data4: any[];
+    })[];
+}
+
+declare function createPostCommandRepository(prisma: any): {
+    create: ({ slug, author, topicId, parents, tags, relatedPosts, coverImage, contentImageIds, images1, images2, image1, image2, image3, image4, translations, ...params }: CreateParams) => Promise<Post>;
+    update: ({ id, slug, author, topicId, parents, tags, relatedPosts, coverImage, contentImageIds, images1, images2, image1, image2, image3, image4, translations, ...params }: UpdateParams) => Promise<Post>;
+    delete: ({ id }: {
+        id: string;
+    }) => Promise<Post>;
+};
+
+interface Alternate {
+    hreflang: string;
+    href: string | null;
+}
+
+interface SeoMetadata {
+    id: string;
+    locale: string;
+    title: string | null;
+    description: string | null;
+    author: string | null;
+    canonical: string | null;
+    alternate: Alternate[];
+    robots: string | null;
+    ogTitle: string | null;
+    ogDescription: string | null;
+    ogUrl: string | null;
+    ogType: string | null;
+    ogSiteName: string | null;
+    ogImage: string | null;
+    ogImageAlt: string | null;
+    ogImageType: string | null;
+    ogImageWidth: number | null;
+    ogImageHeight: number | null;
+    ogLocale: string | null;
+    ogLocaleAlternate: string[];
+    ogArticlePublishedTime: Date | null;
+    ogArticleModifiedTime: Date | null;
+    ogArticleAuthor: string | null;
+    ogArticleSection: string | null;
+    ogArticleTag: string[];
+    twitterCard: string | null;
+    twitterSite: string | null;
+    twitterCreator: string | null;
+    jsonLd: object[];
+    postId: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+interface FindListCardsParams {
+    locale: string;
+    type: PostType | null;
+    page?: number;
+    pageSize?: number;
+    searchString?: string;
+    topicId?: string;
+    postIds?: string[];
+    isActive?: boolean;
+    isIndexActive?: boolean;
+    isSlugActive?: boolean;
+    isFeatured?: boolean;
+    isShownOnHome?: boolean;
+}
+interface FindParams {
+    id?: string;
+    type?: PostType;
+    slug?: string;
+}
+interface FindManyParams {
+    type: PostType;
+    topicId?: string;
+}
+
+declare function createPostQueryRepository(prisma: any): {
+    findListCards: ({ locale, searchString, type, topicId, postIds, isActive, isIndexActive, isSlugActive, isFeatured, isShownOnHome, page, pageSize, }: FindListCardsParams) => Promise<{
+        items: PostListCard[];
+        total: number;
+    }>;
+    findMany: ({ type, topicId, }: FindManyParams) => Promise<(Post & {
+        translations: PostTranslation[];
+    })[]>;
+    find: (params: FindParams) => Promise<(Post & {
+        translations: PostTranslation[];
+    }) | null>;
+    findFull: (params: FindParams) => Promise<PostFull | null>;
+    findWithSeoMetadata: (params: FindParams) => Promise<(Post & {
+        translations: PostTranslation[];
+        seoMetadatas: SeoMetadata[];
+    }) | null>;
+};
+
+export { createAdminCommandRepository, createAdminQueryRepository, createAdminRefreshTokenCommandRepository, createAdminRefreshTokenQueryRepository, createArgon2Service, createCookieService, createCryptoService, createFileCommandRepository, createFileQueryRepository, createFolderCommandRepository, createFolderQueryRepository, createJwtService, createPostCommandRepository, createPostQueryRepository };