@growi/sdk-typescript 1.2.0 → 1.4.0

package/src/generated/v3/index.schemas.ts

@@ -988,30 +988,6 @@ export interface LikeParams {
   bool?: boolean;
 }
 
-/**
- * PageInfo
- */
-export interface PageInfo {
-  /** Whether the page is liked by the logged in user */
-  isLiked?: boolean;
-  /** Number of users who have liked the page */
-  sumOfLikers: number;
-  /** Ids of users who have liked the page */
-  likerIds: string[];
-  /** Number of users who have seen the page */
-  sumOfSeenUsers: number;
-  /** Ids of users who have seen the page */
-  seenUserIds: string[];
-}
-
-/**
- * PageParams
- */
-export interface PageParams {
-  /** page ID */
-  pageId: string;
-}
-
 /**
  * personal settings
  */
@@ -1476,6 +1452,89 @@ export type PagePath = string;
  */
 export type PageGrant = number;
 
+/**
+ * Basic page information
+ */
+export interface PageInfo {
+  /** Whether the page is compatible with v5 */
+  isV5Compatible?: boolean;
+  /** Whether the page is empty */
+  isEmpty?: boolean;
+  /** Whether the page is movable */
+  isMovable?: boolean;
+  /** Whether the page is deletable */
+  isDeletable?: boolean;
+  /** Whether the page is able to delete completely */
+  isAbleToDeleteCompletely?: boolean;
+  /** Whether the page is revertible */
+  isRevertible?: boolean;
+}
+
+export type PageInfoForEntityAllOf = {
+  /** Number of bookmarks */
+  bookmarkCount?: number;
+  /** Number of users who have liked the page */
+  sumOfLikers?: number;
+  /** Ids of users who have liked the page */
+  likerIds?: string[];
+  /** Number of users who have seen the page */
+  sumOfSeenUsers?: number;
+  /** Ids of users who have seen the page */
+  seenUserIds?: string[];
+  /** Content age */
+  contentAge?: number;
+  /** Number of descendant pages */
+  descendantCount?: number;
+  /** Number of comments */
+  commentCount?: number;
+};
+
+/**
+ * Page information for entity (extends IPageInfo)
+ */
+export type PageInfoForEntity = PageInfo & PageInfoForEntityAllOf;
+
+/**
+ * Subscription status
+ */
+export type PageInfoForOperationAllOfSubscriptionStatus =
+  (typeof PageInfoForOperationAllOfSubscriptionStatus)[keyof typeof PageInfoForOperationAllOfSubscriptionStatus];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const PageInfoForOperationAllOfSubscriptionStatus = {
+  SUBSCRIBE: 'SUBSCRIBE',
+  UNSUBSCRIBE: 'UNSUBSCRIBE',
+} as const;
+
+export type PageInfoForOperationAllOf = {
+  /** Whether the page is bookmarked by the logged in user */
+  isBookmarked?: boolean;
+  /** Whether the page is liked by the logged in user */
+  isLiked?: boolean;
+  /** Subscription status */
+  subscriptionStatus?: PageInfoForOperationAllOfSubscriptionStatus;
+};
+
+/**
+ * Page information for operation (extends IPageInfoForEntity)
+ */
+export type PageInfoForOperation = PageInfoForEntity & PageInfoForOperationAllOf;
+
+export type PageInfoForListingAllOf = {
+  /** Short body of the revision */
+  revisionShortBody?: string;
+};
+
+/**
+ * Page information for listing (extends IPageInfoForEntity with revision short body)
+ */
+export type PageInfoForListing = PageInfoForEntity & PageInfoForListingAllOf;
+
+/**
+ * Page information (union of all page info types)
+ */
+export type PageInfoAll = PageInfo | PageInfoForEntity | PageInfoForOperation | PageInfoForListing;
+
 /**
  * extend data
  */
@@ -2577,33 +2636,19 @@ export type GetChildrenForPageListing200 = {
 };
 
 export type GetInfoForPageListingParams = {
+  /**
+   * Array of page IDs to retrieve information for (One of pageIds or path is required)
+   */
   pageIds?: string[];
+  /**
+   * Path of the page to retrieve information for (One of pageIds or path is required)
+   */
   path?: string;
   attachBookmarkCount?: boolean;
   attachShortBody?: boolean;
 };
 
-export type GetInfoForPageListing200IdToPageInfoMap = {
-  [key: string]: {
-    commentCount?: number;
-    contentAge?: number;
-    descendantCount?: number;
-    isAbleToDeleteCompletely?: boolean;
-    isDeletable?: boolean;
-    isEmpty?: boolean;
-    isMovable?: boolean;
-    isRevertible?: boolean;
-    isV5Compatible?: boolean;
-    likerIds?: string[];
-    seenUserIds?: string[];
-    sumOfLikers?: number;
-    sumOfSeenUsers?: number;
-  };
-};
-
-export type GetInfoForPageListing200 = {
-  idToPageInfoMap?: GetInfoForPageListing200IdToPageInfoMap;
-};
+export type GetInfoForPageListing200 = { [key: string]: PageInfoAll };
 
 export type GetPageParams = {
   /**
@@ -2674,6 +2719,13 @@ export type GetExistForPage200 = {
   isExist?: boolean;
 };
 
+export type GetInfoForPageParams = {
+  /**
+   * page id
+   */
+  pageId: ObjectId;
+};
+
 export type GetGrantDataForPageParams = {
   /**
    * page id
@@ -2792,7 +2844,7 @@ export type GetRecentForPagesParams = {
   includeWipPage?: string;
 };
 
-export type PostRenameForPagesBody = {
+export type PutRenameForPagesBody = {
   pageId: ObjectId;
   path?: PagePath;
   /** revision ID */
@@ -2807,7 +2859,7 @@ export type PostRenameForPagesBody = {
   isRecursively?: boolean;
 };
 
-export type PostRenameForPages200 = {
+export type PutRenameForPages200 = {
   page?: Page;
 };
 

package/src/generated/v3/index.ts

@@ -91,6 +91,7 @@ import type {
   GetInfoForBookmarksParams,
   GetInfoForPageListing200,
   GetInfoForPageListingParams,
+  GetInfoForPageParams,
   GetIsEnabledForQuestionnaire200,
   GetIsPasswordSetForPersonalSetting200,
   GetLimitForAttachment200,
@@ -166,8 +167,7 @@ import type {
   NotifyForPageGrant,
   OidcAuthSetting,
   Page,
-  PageInfo,
-  PageParams,
+  PageInfoAll,
   PersonalSettings,
   PostAddBookmarkToFolderForBookmarkFolder200,
   PostAddBookmarkToFolderForBookmarkFolderBody,
@@ -227,8 +227,6 @@ import type {
   PostRegister200,
   PostRegisterBody,
   PostRelationTestByIdForSlackIntegrationSettingsSlackAppIntegrationsBody,
-  PostRenameForPages200,
-  PostRenameForPagesBody,
   PostResumeRenameForPages200,
   PostResumeRenameForPagesBody,
   PostShareLinksParams,
@@ -314,6 +312,8 @@ import type {
   PutQuestionnaireSettingsForPersonalSetting200,
   PutQuestionnaireSettingsForPersonalSettingBody,
   PutRegenerateTokensByIdForSlackIntegrationSettingsSlackAppIntegrations200,
+  PutRenameForPages200,
+  PutRenameForPagesBody,
   PutResetPasswordEmailForUsersBody,
   PutResetPasswordForUsers200,
   PutResetPasswordForUsersBody,
@@ -1489,7 +1489,7 @@ export const getGrowirestapiv3 = () => {
   };
 
   /**
-   * Get the information of a page
+   * Get summary information of pages
    * @summary /page-listing/info
    */
   const getInfoForPageListing = (params?: GetInfoForPageListingParams, options?: SecondParameter<typeof customInstance>) => {
@@ -1536,11 +1536,11 @@ export const getGrowirestapiv3 = () => {
   };
 
   /**
-   * Retrieve current page info
-   * @summary Get page info
+   * Get summary informations for a page
+   * @summary /page/info
    */
-  const getInfoForPage = (pageParams: PageParams, options?: SecondParameter<typeof customInstance>) => {
-    return customInstance<PageInfo>({ url: `/page/info`, method: 'GET', headers: { 'Content-Type': 'application/json' } }, options);
+  const getInfoForPage = (params: GetInfoForPageParams, options?: SecondParameter<typeof customInstance>) => {
+    return customInstance<PageInfoAll>({ url: `/page/info`, method: 'GET', params }, options);
   };
 
   /**
@@ -1673,9 +1673,9 @@ export const getGrowirestapiv3 = () => {
   /**
    * Rename page
    */
-  const postRenameForPages = (postRenameForPagesBody: PostRenameForPagesBody, options?: SecondParameter<typeof customInstance>) => {
-    return customInstance<PostRenameForPages200>(
-      { url: `/pages/rename`, method: 'POST', headers: { 'Content-Type': 'application/json' }, data: postRenameForPagesBody },
+  const putRenameForPages = (putRenameForPagesBody: PutRenameForPagesBody, options?: SecondParameter<typeof customInstance>) => {
+    return customInstance<PutRenameForPages200>(
+      { url: `/pages/rename`, method: 'PUT', headers: { 'Content-Type': 'application/json' }, data: putRenameForPagesBody },
       options,
     );
   };
@@ -2965,7 +2965,7 @@ export const getGrowirestapiv3 = () => {
     getYjsDataByPageId,
     putSyncLatestRevisionBodyToYjsDraftByPageId,
     getRecentForPages,
-    postRenameForPages,
+    putRenameForPages,
     postResumeRenameForPages,
     deleteEmptyTrashForPages,
     getListForPages,
@@ -3285,7 +3285,7 @@ export type PutSyncLatestRevisionBodyToYjsDraftByPageIdResult = NonNullable<
   Awaited<ReturnType<ReturnType<typeof getGrowirestapiv3>['putSyncLatestRevisionBodyToYjsDraftByPageId']>>
 >;
 export type GetRecentForPagesResult = NonNullable<Awaited<ReturnType<ReturnType<typeof getGrowirestapiv3>['getRecentForPages']>>>;
-export type PostRenameForPagesResult = NonNullable<Awaited<ReturnType<ReturnType<typeof getGrowirestapiv3>['postRenameForPages']>>>;
+export type PutRenameForPagesResult = NonNullable<Awaited<ReturnType<ReturnType<typeof getGrowirestapiv3>['putRenameForPages']>>>;
 export type PostResumeRenameForPagesResult = NonNullable<Awaited<ReturnType<ReturnType<typeof getGrowirestapiv3>['postResumeRenameForPages']>>>;
 export type DeleteEmptyTrashForPagesResult = NonNullable<Awaited<ReturnType<ReturnType<typeof getGrowirestapiv3>['deleteEmptyTrashForPages']>>>;
 export type GetListForPagesResult = NonNullable<Awaited<ReturnType<ReturnType<typeof getGrowirestapiv3>['getListForPages']>>>;