@ziteh/yangchun-comment-client 0.1.0 → 0.2.0-alpha.1

package/README.md

@@ -0,0 +1,6 @@
+# Yang Chun Comment Client
+
+Frontend Web Component for Yang Chun Comment — a simple, lightweight, privacy-first commenting system.
+
+- [Docs](https://ycc.ziteh.dev/)
+- [GitHub](https://github.com/ziteh/yangchun-comment)

package/dist/src/api/apiService.d.ts

@@ -0,0 +1,22 @@
+import { type GetCommentsResponse, type AdminLoginResponse } from '@ziteh/yangchun-comment-shared';
+export interface AuthInfo {
+    timestamp: number;
+    token: string;
+}
+export interface CommentAuthInfo {
+    id: string;
+    timestamp: number;
+    token: string;
+}
+export interface ApiService {
+    getComments: (post: string) => Promise<GetCommentsResponse>;
+    addComment: (post: string, pseudonym: string, msg: string, replyTo?: string) => Promise<string | null>;
+    updateComment: (post: string, commentId: string, pseudonym: string, msg: string) => Promise<boolean>;
+    deleteComment: (post: string, commentId: string) => Promise<boolean>;
+    canEditComment: (commentId: string) => boolean;
+    isMyComment: (commentId: string) => boolean;
+    adminLogin: (username: string, password: string) => Promise<AdminLoginResponse | null>;
+    adminLogout: () => Promise<boolean>;
+    checkAdminAuth: () => Promise<boolean>;
+}
+export declare const createApiService: (apiUrl: string, prePowDifficulty: number, prePowSalt: string) => ApiService;

package/dist/src/api/globalApiService.d.ts

@@ -0,0 +1,10 @@
+import type { ApiService } from './apiService';
+declare class GlobalApiService {
+    private instance;
+    setInstance(service: ApiService): void;
+    getInstance(): ApiService;
+    isInitialized(): boolean;
+    clear(): void;
+}
+export declare const globalApiService: GlobalApiService;
+export {};

package/dist/src/components/comment-admin.d.ts

@@ -0,0 +1,25 @@
+import { LitElement } from 'lit';
+export declare class CommentAdmin extends LitElement {
+    static styles: import("lit").CSSResult[];
+    private accessor username;
+    private accessor password;
+    private accessor errorMessage;
+    private accessor successMessage;
+    private accessor isLoading;
+    private accessor isLoggedIn;
+    private accessor isCheckingAuth;
+    private accessor hasCheckedAuthFromComments;
+    render(): import("lit").TemplateResult<1>;
+    connectedCallback(): Promise<void>;
+    disconnectedCallback(): void;
+    updateAuthStatus(isAdmin: boolean): void;
+    private handleAdminStatusUpdated;
+    private renderLoginForm;
+    private renderAdminPanel;
+    private handleSubmit;
+    private checkAuthStatus;
+    private handleLogout;
+    private handleUsernameChange;
+    private handlePasswordChange;
+    private handleAuthStatusChange;
+}

package/dist/src/components/comment-dialog.d.ts

@@ -0,0 +1,18 @@
+import { LitElement, type PropertyValues } from 'lit';
+export declare class CommentDialog extends LitElement {
+    static styles: import("lit").CSSResult[];
+    accessor open: boolean;
+    accessor header: string;
+    private accessor dialogElement;
+    private accessor closeButton;
+    private previousFocus;
+    render(): import("lit").TemplateResult<1> | null;
+    protected updated(changedProperties: PropertyValues): void;
+    disconnectedCallback(): void;
+    private addEventListeners;
+    private removeEventListeners;
+    private handleKeyDown;
+    private trapFocus;
+    private handleClose;
+    private handleOverlayClick;
+}

package/dist/src/components/comment-info.d.ts

@@ -0,0 +1,14 @@
+import { LitElement } from 'lit';
+import type { Comment } from '@ziteh/yangchun-comment-shared';
+export declare class CommentInfo extends LitElement {
+    static styles: import("lit").CSSResult[];
+    accessor comment: Comment | null;
+    accessor isReply: boolean;
+    accessor errorMessage: string;
+    render(): import("lit").TemplateResult<1>;
+    private handleAdmin;
+    private handleHelp;
+    private handleNotify;
+    private handleErrorClear;
+    private handleCancel;
+}

package/dist/src/components/comment-input.d.ts

@@ -0,0 +1,31 @@
+import { LitElement } from 'lit';
+import './list/comment-list-item';
+export declare class CommentInput extends LitElement {
+    static shadowRootOptions: {
+        delegatesFocus: boolean;
+        clonable?: boolean;
+        customElementRegistry?: CustomElementRegistry;
+        mode: ShadowRootMode;
+        serializable?: boolean;
+        slotAssignment?: SlotAssignmentMode;
+    };
+    static styles: import("lit").CSSResult[];
+    static readonly MAX_NICKNAME_LENGTH: number;
+    static readonly MAX_MESSAGE_LENGTH: number;
+    accessor draft: string;
+    accessor nickname: string;
+    accessor editPseudonym: string;
+    accessor adminName: string;
+    accessor isAdmin: boolean;
+    private accessor isPreview;
+    private accessor previewComment;
+    private accessor honeypot;
+    render(): import("lit").TemplateResult<1>;
+    private createPreviewComment;
+    private isValidComment;
+    private handleTogglePreview;
+    private handleDraftInput;
+    private handleNicknameInput;
+    private handleHoneypotInput;
+    private handleSubmit;
+}

package/dist/src/components/list/comment-list-item.d.ts

@@ -0,0 +1,19 @@
+import { LitElement } from 'lit';
+import type { Comment } from '@ziteh/yangchun-comment-shared';
+export declare class CommentListItem extends LitElement {
+    static styles: import("lit").CSSResult[];
+    accessor comment: Comment;
+    accessor replyComments: Comment[];
+    accessor author: string;
+    private isContentExpanded;
+    private readonly MAX_LINES;
+    render(): import("lit").TemplateResult<1>;
+    private isPreviewComment;
+    private handleDelete;
+    private handleEdit;
+    private handleReply;
+    private handleContentClick;
+    private renderMarkdown;
+    private shouldShowExpandBtn;
+    private handleToggleExpand;
+}

package/dist/src/components/list/comment-list.d.ts

@@ -0,0 +1,9 @@
+import { LitElement } from 'lit';
+import type { Comment } from '@ziteh/yangchun-comment-shared';
+import './comment-list-item';
+export declare class CommentList extends LitElement {
+    static styles: import("lit").CSSResult[];
+    accessor comments: Comment[];
+    accessor author: string;
+    render(): import("lit").TemplateResult<1>;
+}

package/dist/src/components/yangchun-comment.d.ts

@@ -0,0 +1,58 @@
+import { LitElement, type PropertyValues } from 'lit';
+import './comment-input';
+import './comment-info';
+import './comment-dialog';
+import './list/comment-list';
+import './comment-admin';
+import { type I18nStrings } from '../utils/i18n';
+export declare class YangChunComment extends LitElement {
+    static styles: import("lit").CSSResult[];
+    accessor post: string;
+    accessor apiUrl: string;
+    accessor adminName: string;
+    accessor lang: string;
+    accessor prePowSalt: string;
+    accessor prePowDifficulty: number;
+    accessor customMessages: I18nStrings | undefined;
+    private accessor draft;
+    private accessor nickname;
+    private accessor comments;
+    private accessor editPseudonym;
+    private accessor deleteCommentId;
+    private accessor referenceComment;
+    private accessor isReply;
+    private accessor showAdmin;
+    private accessor showHelp;
+    private accessor showNotify;
+    private accessor showExternalLink;
+    private accessor externalLinkUrl;
+    private accessor isAdmin;
+    private accessor rssFeedUrl;
+    private accessor errorMessage;
+    private accessor commentInput;
+    private accessor commentAdmin;
+    render(): import("lit").TemplateResult<1>;
+    protected willUpdate(changedProperties: PropertyValues<this>): void;
+    protected updated(changedProperties: PropertyValues<this>): void;
+    firstUpdated(): Promise<void>;
+    disconnectedCallback(): void;
+    private updatedComments;
+    private handleRefCommentCancel;
+    private handleDraftChange;
+    private handleNicknameChange;
+    private editedSubmit;
+    private handleCommentSubmit;
+    private handleCommentReply;
+    private handleCommentDelete;
+    private handleCommentEdit;
+    private handleAuthStatusChange;
+    private handleDeleteComment;
+    private handleExternalLinkClick;
+    private handleOpenLink;
+    private handleCopyLink;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'yangchun-comment': YangChunComment;
+    }
+}

package/dist/src/components/yangchun-comment.styles.d.ts

@@ -0,0 +1,2 @@
+export declare const yangChunCommentVars: import("lit").CSSResult;
+export declare const yangChunCommentStyles: import("lit").CSSResult;

package/dist/src/index.d.ts

@@ -0,0 +1 @@
+export { YangChunComment } from './components/yangchun-comment';

package/dist/src/utils/comment.d.ts

@@ -0,0 +1,6 @@
+import type { Comment } from '@ziteh/yangchun-comment-shared';
+export declare function sortCommentsByDate(comments: Comment[], newFirst: boolean): Comment[];
+export declare function filterRootComments(comments: Comment[]): Comment[];
+export declare function filterReplyComments(comments: Comment[], replyToId: string): Comment[];
+export declare function findRootComment(comments: Comment[], commentId: string): Comment | undefined;
+export declare function findReplyComments(comments: Comment[], rootCommentId: string): Comment[];

package/dist/src/utils/format.d.ts

@@ -0,0 +1,2 @@
+export declare function formatAbsoluteDate(timestamp: number): string;
+export declare function formatRelativeDate(timestamp: number, locales?: string): string;

package/dist/src/utils/i18n.d.ts

@@ -0,0 +1,46 @@
+export interface I18nStrings {
+    bcp47: string;
+    anonymous: string;
+    submit: string;
+    preview: string;
+    edit: string;
+    edited: string;
+    editing: string;
+    delete: string;
+    reply: string;
+    replyTo: string;
+    replyingTo: string;
+    notify: string;
+    help: string;
+    cancel: string;
+    close: string;
+    author: string;
+    me: string;
+    messagePlaceholder: string;
+    nicknamePlaceholder: string;
+    confirmDelete: string;
+    confirmDeleteDesc1: string;
+    confirmDeleteDesc2: string;
+    helpDesc: string;
+    helpMdLink: string;
+    helpMdImage: string;
+    helpMdItalic: string;
+    helpMdBold: string;
+    helpMdList: string;
+    helpMdOrderedList: string;
+    helpMdInlineCode: string;
+    helpMdCodeBlock: string;
+    helpMdNoHtml: string;
+    notifyDesc: string;
+    noComments: string;
+    showMore: string;
+    showLess: string;
+    externalLinkWarning: string;
+    externalLinkDesc: string;
+    openLink: string;
+    copyLink: string;
+}
+export declare const enUS: I18nStrings;
+export declare const zhTW: I18nStrings;
+export declare function t(key: keyof I18nStrings): string;
+export declare function initI18n(lang: I18nStrings): void;

package/dist/src/utils/pow.d.ts

@@ -0,0 +1,9 @@
+export declare function solvePrePow(difficulty: number, payload: string): Promise<{
+    challenge: string;
+    nonce: number;
+}>;
+export declare function solveFormalPow(difficulty: number, challenge: string, post: string): Promise<number>;
+export declare function genFormalPowChallenge(difficulty: number): Promise<string>;
+export declare function verifyPrePow(difficulty: number, challenge: string, nonce: number): Promise<boolean>;
+export declare function verifyFormalPow(challenge: string, post: string, nonce: number): Promise<boolean>;
+export declare function cleanupPowWorker(): void;

package/dist/{utils → src/utils}/pseudonym.d.ts

@@ -1,4 +1,3 @@
-export declare function generateSHA256Hash(text: string): Promise<string>;
 export declare function generatePseudonymAndHash(originalName: string | null | undefined): Promise<{
     pseudonym: string;
     hash: string;

package/dist/src/utils/sanitize.d.ts

@@ -0,0 +1 @@
+export declare function sanitizeHtml(dirtyHtml: string): string;

package/dist/test/sanitize.test.d.ts

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