artalk 2.10.0 → 2.10.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -465,12 +465,13 @@ declare class Api_2<SecurityDataType extends unknown> extends HttpClient<Securit
465
465
  };
466
466
  notifies: {
467
467
  /**
468
- * @description Get a list of notifies for user
468
+ * @description Get unread notifications owned by the authenticated user or anonymous comment credential
469
469
  *
470
470
  * @tags Notify
471
471
  * @name GetNotifies
472
472
  * @summary Get Notifies
473
473
  * @request GET:/notifies
474
+ * @secure
474
475
  * @response `200` `HandlerResponseNotifyList` OK
475
476
  * @response `400` `(HandlerMap & {
476
477
  msg?: string,
@@ -490,17 +491,22 @@ declare class Api_2<SecurityDataType extends unknown> extends HttpClient<Securit
490
491
  msg?: string;
491
492
  }>>;
492
493
  /**
493
- * @description Mark all notifies as read for user
494
+ * @description Mark owned notifications as read using a login or anonymous comment credential
494
495
  *
495
496
  * @tags Notify
496
497
  * @name MarkAllNotifyRead
497
498
  * @summary Mark All Notifies as Read
498
499
  * @request POST:/notifies/read
500
+ * @secure
499
501
  * @response `200` `HandlerMap` OK
500
502
  * @response `400` `(HandlerMap & {
501
503
  msg?: string,
502
504
 
503
505
  })` Bad Request
506
+ * @response `401` `(HandlerMap & {
507
+ msg?: string,
508
+
509
+ })` Unauthorized
504
510
  * @response `500` `(HandlerMap & {
505
511
  msg?: string,
506
512
 
@@ -550,6 +556,8 @@ declare class Api_2<SecurityDataType extends unknown> extends HttpClient<Securit
550
556
  })` Forbidden
551
557
  */
552
558
  getPages: (query?: {
559
+ /** Only include pages with comments (including pending comments) */
560
+ has_comments?: boolean;
553
561
  /** The limit for pagination */
554
562
  limit?: number;
555
563
  /** The offset for pagination */
@@ -1311,6 +1319,7 @@ declare interface ApiOptions {
1311
1319
  pageKey: string;
1312
1320
  pageTitle: string;
1313
1321
  timeout?: number;
1322
+ getGuestToken?: (create?: boolean) => string | undefined;
1314
1323
  getApiToken?: () => string | undefined;
1315
1324
  userInfo?: {
1316
1325
  name: string;
@@ -1895,6 +1904,8 @@ export declare interface Context extends EventManager<EventPayloadMap>, Dependen
1895
1904
  reload(): void;
1896
1905
  /** Destroy */
1897
1906
  destroy(): void;
1907
+ /** Whether `destroy()` has been called */
1908
+ isDestroyed(): boolean;
1898
1909
  /** Goto the first comment of the list */
1899
1910
  listGotoFirst(): void;
1900
1911
  /** Get the comment data list */
@@ -2760,6 +2771,7 @@ declare interface HandlerResponseCommentUpdate {
2760
2771
 
2761
2772
  declare interface HandlerResponseConfAuthProviders {
2762
2773
  anonymous: boolean;
2774
+ callback_origin?: string;
2763
2775
  providers: AuthAuthProviderInfo[];
2764
2776
  }
2765
2777
 
@@ -3312,6 +3324,8 @@ export declare interface UserInfoApiResponseData {
3312
3324
  }
3313
3325
 
3314
3326
  export declare interface UserManager {
3327
+ getGuestToken?: (server: string, create?: boolean) => string | undefined;
3328
+ setGuestToken?: (server: string, token: string) => void;
3315
3329
  getData: () => LocalUser;
3316
3330
  update: (dta: Partial<LocalUser>) => void;
3317
3331
  logout: () => void;
@@ -465,12 +465,13 @@ declare class Api_2<SecurityDataType extends unknown> extends HttpClient<Securit
465
465
  };
466
466
  notifies: {
467
467
  /**
468
- * @description Get a list of notifies for user
468
+ * @description Get unread notifications owned by the authenticated user or anonymous comment credential
469
469
  *
470
470
  * @tags Notify
471
471
  * @name GetNotifies
472
472
  * @summary Get Notifies
473
473
  * @request GET:/notifies
474
+ * @secure
474
475
  * @response `200` `HandlerResponseNotifyList` OK
475
476
  * @response `400` `(HandlerMap & {
476
477
  msg?: string,
@@ -490,17 +491,22 @@ declare class Api_2<SecurityDataType extends unknown> extends HttpClient<Securit
490
491
  msg?: string;
491
492
  }>>;
492
493
  /**
493
- * @description Mark all notifies as read for user
494
+ * @description Mark owned notifications as read using a login or anonymous comment credential
494
495
  *
495
496
  * @tags Notify
496
497
  * @name MarkAllNotifyRead
497
498
  * @summary Mark All Notifies as Read
498
499
  * @request POST:/notifies/read
500
+ * @secure
499
501
  * @response `200` `HandlerMap` OK
500
502
  * @response `400` `(HandlerMap & {
501
503
  msg?: string,
502
504
 
503
505
  })` Bad Request
506
+ * @response `401` `(HandlerMap & {
507
+ msg?: string,
508
+
509
+ })` Unauthorized
504
510
  * @response `500` `(HandlerMap & {
505
511
  msg?: string,
506
512
 
@@ -550,6 +556,8 @@ declare class Api_2<SecurityDataType extends unknown> extends HttpClient<Securit
550
556
  })` Forbidden
551
557
  */
552
558
  getPages: (query?: {
559
+ /** Only include pages with comments (including pending comments) */
560
+ has_comments?: boolean;
553
561
  /** The limit for pagination */
554
562
  limit?: number;
555
563
  /** The offset for pagination */
@@ -1311,6 +1319,7 @@ declare interface ApiOptions {
1311
1319
  pageKey: string;
1312
1320
  pageTitle: string;
1313
1321
  timeout?: number;
1322
+ getGuestToken?: (create?: boolean) => string | undefined;
1314
1323
  getApiToken?: () => string | undefined;
1315
1324
  userInfo?: {
1316
1325
  name: string;
@@ -1895,6 +1904,8 @@ export declare interface Context extends EventManager<EventPayloadMap>, Dependen
1895
1904
  reload(): void;
1896
1905
  /** Destroy */
1897
1906
  destroy(): void;
1907
+ /** Whether `destroy()` has been called */
1908
+ isDestroyed(): boolean;
1898
1909
  /** Goto the first comment of the list */
1899
1910
  listGotoFirst(): void;
1900
1911
  /** Get the comment data list */
@@ -2760,6 +2771,7 @@ declare interface HandlerResponseCommentUpdate {
2760
2771
 
2761
2772
  declare interface HandlerResponseConfAuthProviders {
2762
2773
  anonymous: boolean;
2774
+ callback_origin?: string;
2763
2775
  providers: AuthAuthProviderInfo[];
2764
2776
  }
2765
2777
 
@@ -3312,6 +3324,8 @@ export declare interface UserInfoApiResponseData {
3312
3324
  }
3313
3325
 
3314
3326
  export declare interface UserManager {
3327
+ getGuestToken?: (server: string, create?: boolean) => string | undefined;
3328
+ setGuestToken?: (server: string, token: string) => void;
3315
3329
  getData: () => LocalUser;
3316
3330
  update: (dta: Partial<LocalUser>) => void;
3317
3331
  logout: () => void;