@growi/sdk-typescript 1.7.0 → 1.10.0

package/dist/utils/v3/axios-instance.js.map

@@ -1 +1 @@
-{"version":3,"file":"axios-instance.js","sourceRoot":"","sources":["../../../src/utils/v3/axios-instance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAkC,MAAM,OAAO,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAE7D,MAAM,CAAC,MAAM,cAAc,GAAG,CAAI,MAA0B,EAAE,OAA4B,EAAc,EAAE;IACxG,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;IAE1C,MAAM,eAAe,GAAG,aAAa,CAAC,QAAQ,CAAC;IAC/C,MAAM,OAAO,GAAG,GAAG,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,OAAO,IAAI,eAAe,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,UAAU,CAAC;IAE3G,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,CAAC;QACrC,GAAG,MAAM;QACT,GAAG,OAAO;QACV,OAAO;QACP,WAAW,EAAE,MAAM,CAAC,KAAK;KAC1B,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IAE5B,aAAa;IACb,OAAO,CAAC,MAAM,GAAG,GAAG,EAAE;QACpB,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IACnC,CAAC,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC"}
+{"version":3,"file":"axios-instance.js","sourceRoot":"","sources":["../../../src/utils/v3/axios-instance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAkC,MAAM,OAAO,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAGpE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAI,MAA0B,EAAE,OAA+B,EAAc,EAAE;IAC3G,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAEhD,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;IAE1C,MAAM,QAAQ,GAAG,oBAAoB,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAChE,MAAM,OAAO,GAAG,GAAG,YAAY,EAAE,OAAO,IAAI,MAAM,EAAE,OAAO,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,UAAU,CAAC;IAEzG,MAAM,OAAO,GAAG,QAAQ,CAAC;QACvB,GAAG,MAAM;QACT,GAAG,YAAY;QACf,OAAO;QACP,WAAW,EAAE,MAAM,CAAC,KAAK;KAC1B,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IAE5B,aAAa;IACb,OAAO,CAAC,MAAM,GAAG,GAAG,EAAE;QACpB,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IACnC,CAAC,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@growi/sdk-typescript",
-  "version": "1.7.0",
+  "version": "1.10.0",
   "description": "GROWI SDK for TypeScript, providing utilities and types for building applications that interact with GROWI.",
   "type": "module",
   "license": "MIT",

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

@@ -2,7 +2,7 @@
  * Generated by orval v7.9.0 🍺
  * Do not edit manually.
  * GROWI REST API v1
- * OpenAPI spec version: 7.3.0-RC.0
+ * OpenAPI spec version: 7.5.5-RC.0
  */
 /**
  * The type for Comment.comment
@@ -186,11 +186,58 @@ export interface ErrorV3 {
  */
 export type ObjectId = string;
 
+/**
+ * Page
+ */
+export interface PageForTreeItem {
+  _id?: ObjectId;
+  path?: PagePath;
+  parent?: PagePath;
+  grant?: PageGrant;
+  lastUpdateUser?: User;
+  descendantCount?: number;
+  isEmpty?: boolean;
+  wip?: boolean;
+  /** date created at */
+  createdAt?: string;
+  /** date updated at */
+  updatedAt?: string;
+}
+
 /**
  * Page path
  */
 export type PagePath = string;
 
+/**
+ * @nullable
+ */
+export type GetPageResponsePage = (Page & unknown) | null;
+
+/**
+ * Metadata about the page request
+ * @nullable
+ */
+export type GetPageResponseMeta = { [key: string]: unknown } | null;
+
+/**
+ * Response for GET /page endpoint
+ */
+export interface GetPageResponse {
+  /** @nullable */
+  page?: GetPageResponsePage;
+  /**
+   * Array of pages when findAll parameter is used. Null otherwise.
+   * @nullable
+   */
+  pages?: Page[] | null;
+  /**
+   * Metadata about the page request
+   * @nullable
+   */
+  meta?: GetPageResponseMeta;
+}
+
 /**
  * Grant for page
  */
@@ -277,7 +324,7 @@ export type PageInfoForListing = PageInfoForEntity & PageInfoForListingAllOf;
 /**
  * Page information (union of all page info types)
  */
-export type PageInfoAll = PageInfo | PageInfoForEntity | PageInfoForOperation | PageInfoForListing;
+export type PageInfoExt = PageInfo | PageInfoForEntity | PageInfoForOperation | PageInfoForListing;
 
 /**
  * extend data

package/src/generated/v1/index.ts

@@ -2,7 +2,7 @@
  * Generated by orval v7.9.0 🍺
  * Do not edit manually.
  * GROWI REST API v1
- * OpenAPI spec version: 7.3.0-RC.0
+ * OpenAPI spec version: 7.5.5-RC.0
  */
 import type {
   AddComment200,

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

@@ -2,7 +2,7 @@
  * Generated by orval v7.9.0 🍺
  * Do not edit manually.
  * GROWI REST API v3
- * OpenAPI spec version: 7.3.0-RC.0
+ * OpenAPI spec version: 7.5.5-RC.0
  */
 export interface SyncStatus {
   isExecutingSync?: boolean;
@@ -10,6 +10,48 @@ export interface SyncStatus {
   count?: number;
 }
 
+/**
+ * The type of suggestion
+ */
+export type PathSuggestionType = (typeof PathSuggestionType)[keyof typeof PathSuggestionType];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const PathSuggestionType = {
+  memo: 'memo',
+  search: 'search',
+  category: 'category',
+} as const;
+
+/**
+ * Whether the content is flow (time-based) or stock (reference)
+ */
+export type PathSuggestionInformationType = (typeof PathSuggestionInformationType)[keyof typeof PathSuggestionInformationType];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const PathSuggestionInformationType = {
+  flow: 'flow',
+  stock: 'stock',
+} as const;
+
+export interface PathSuggestion {
+  /** The type of suggestion */
+  type: PathSuggestionType;
+  /** Suggested page path */
+  path: string;
+  /** Human-readable label for the suggestion */
+  label: string;
+  /** Explanation of why this path is suggested */
+  description: string;
+  /** Page grant (1=public, 4=owner_only, 5=user_group) */
+  grant: number;
+  /** Whether the content is flow (time-based) or stock (reference) */
+  informationType?: PathSuggestionInformationType;
+}
+
+export interface SuggestPathResponse {
+  suggestions?: PathSuggestion[];
+}
+
 export type ActivityResponseSerializedPaginationResultDocsItemSnapshot = {
   username?: string;
   _id?: string;
@@ -543,8 +585,6 @@ export interface ThemesMetadata {
 export interface CustomizeSidebar {
   /** The flag whether sidebar is collapsed mode or not. */
   isSidebarCollapsedMode?: boolean;
-  /** The flag whether sidebar is closed at dock mode or not. */
-  isSidebarClosedAtDockMode?: boolean;
 }
 
 /**
@@ -1109,6 +1149,8 @@ export interface GeneralSetting {
   isAllGroupMembershipRequiredForPageCompleteDeletion?: boolean;
   /** type of pageDeletionAuthority */
   pageCompleteDeletionAuthority?: string;
+  /** hide all user pages from general users */
+  disableUserPages?: boolean;
   /** enable hide by owner */
   hideRestrictedByOwner?: boolean;
   /** enable hide by group */
@@ -1187,51 +1229,6 @@ export interface LdapAuthSetting {
   ldapGroupDnProperty?: string;
 }
 
-export interface SamlAuthSetting {
-  /** array of missing mandatory config keys */
-  missingMandatoryConfigKeys?: string[];
-  /** use only env vars for some options */
-  useOnlyEnvVarsForSomeOptions?: boolean;
-  /** entry point for saml */
-  samlEntryPoint?: string;
-  /** issuer for saml */
-  samlIssuer?: string;
-  /** issuer for saml */
-  samlEnvVarIssuer?: string;
-  /** certificate for saml */
-  samlCert?: string;
-  /** certificate for saml */
-  samlEnvVarCert?: string;
-  /** attribute mapping id for saml */
-  samlAttrMapId?: string;
-  /** attribute mapping user name for saml */
-  samlAttrMapUserName?: string;
-  /** attribute mapping mail for saml */
-  samlAttrMapMail?: string;
-  /** attribute mapping id for saml */
-  samlEnvVarAttrMapId?: string;
-  /** attribute mapping user name for saml */
-  samlEnvVarAttrMapUserName?: string;
-  /** attribute mapping mail for saml */
-  samlEnvVarAttrMapMail?: string;
-  /** attribute mapping first name for saml */
-  samlAttrMapFirstName?: string;
-  /** attribute mapping last name for saml */
-  samlAttrMapLastName?: string;
-  /** attribute mapping first name for saml */
-  samlEnvVarAttrMapFirstName?: string;
-  /** attribute mapping last name for saml */
-  samlEnvVarAttrMapLastName?: string;
-  /** local account automatically linked the user name matched */
-  isSameUsernameTreatedAsIdenticalUser?: boolean;
-  /** local account automatically linked the email matched */
-  isSameEmailTreatedAsIdenticalUser?: boolean;
-  /** ABLCRule for saml */
-  samlABLCRule?: string;
-  /** ABLCRule for saml */
-  samlEnvVarABLCRule?: string;
-}
-
 export interface OidcAuthSetting {
   /** provider name for oidc */
   oidcProviderName?: string;
@@ -1289,6 +1286,51 @@ export interface GoogleOAuthSetting {
   isSameUsernameTreatedAsIdenticalUser?: boolean;
 }
 
+export interface SamlAuthSetting {
+  /** array of missing mandatory config keys */
+  missingMandatoryConfigKeys?: string[];
+  /** use only env vars for some options */
+  useOnlyEnvVarsForSomeOptions?: boolean;
+  /** entry point for saml */
+  samlEntryPoint?: string;
+  /** issuer for saml */
+  samlIssuer?: string;
+  /** issuer for saml */
+  samlEnvVarIssuer?: string;
+  /** certificate for saml */
+  samlCert?: string;
+  /** certificate for saml */
+  samlEnvVarCert?: string;
+  /** attribute mapping id for saml */
+  samlAttrMapId?: string;
+  /** attribute mapping user name for saml */
+  samlAttrMapUserName?: string;
+  /** attribute mapping mail for saml */
+  samlAttrMapMail?: string;
+  /** attribute mapping id for saml */
+  samlEnvVarAttrMapId?: string;
+  /** attribute mapping user name for saml */
+  samlEnvVarAttrMapUserName?: string;
+  /** attribute mapping mail for saml */
+  samlEnvVarAttrMapMail?: string;
+  /** attribute mapping first name for saml */
+  samlAttrMapFirstName?: string;
+  /** attribute mapping last name for saml */
+  samlAttrMapLastName?: string;
+  /** attribute mapping first name for saml */
+  samlEnvVarAttrMapFirstName?: string;
+  /** attribute mapping last name for saml */
+  samlEnvVarAttrMapLastName?: string;
+  /** local account automatically linked the user name matched */
+  isSameUsernameTreatedAsIdenticalUser?: boolean;
+  /** local account automatically linked the email matched */
+  isSameEmailTreatedAsIdenticalUser?: boolean;
+  /** ABLCRule for saml */
+  samlABLCRule?: string;
+  /** ABLCRule for saml */
+  samlEnvVarABLCRule?: string;
+}
+
 export type ShareLinkRelatedPage = {
   /** The unique identifier of the related page */
   _id?: string;
@@ -1428,11 +1470,58 @@ export interface ErrorV3 {
  */
 export type ObjectId = string;
 
+/**
+ * Page
+ */
+export interface PageForTreeItem {
+  _id?: ObjectId;
+  path?: PagePath;
+  parent?: PagePath;
+  grant?: PageGrant;
+  lastUpdateUser?: User;
+  descendantCount?: number;
+  isEmpty?: boolean;
+  wip?: boolean;
+  /** date created at */
+  createdAt?: string;
+  /** date updated at */
+  updatedAt?: string;
+}
+
 /**
  * Page path
  */
 export type PagePath = string;
 
+/**
+ * @nullable
+ */
+export type GetPageResponsePage = (Page & unknown) | null;
+
+/**
+ * Metadata about the page request
+ * @nullable
+ */
+export type GetPageResponseMeta = { [key: string]: unknown } | null;
+
+/**
+ * Response for GET /page endpoint
+ */
+export interface GetPageResponse {
+  /** @nullable */
+  page?: GetPageResponsePage;
+  /**
+   * Array of pages when findAll parameter is used. Null otherwise.
+   * @nullable
+   */
+  pages?: Page[] | null;
+  /**
+   * Metadata about the page request
+   * @nullable
+   */
+  meta?: GetPageResponseMeta;
+}
+
 /**
  * Grant for page
  */
@@ -1519,7 +1608,7 @@ export type PageInfoForListing = PageInfoForEntity & PageInfoForListingAllOf;
 /**
  * Page information (union of all page info types)
  */
-export type PageInfoAll = PageInfo | PageInfoForEntity | PageInfoForOperation | PageInfoForListing;
+export type PageInfoExt = PageInfo | PageInfoForEntity | PageInfoForOperation | PageInfoForListing;
 
 /**
  * extend data
@@ -1925,6 +2014,14 @@ export type GetPluginTemplatesByLocaleByTemplateIdByReposIdByOrganizationIdForTe
   markdown?: string;
 };
 
+export type PostSuggestPathForAiToolsBody = {
+  /**
+   * The page content to analyze for path suggestions
+   * @maxLength 50000
+   */
+  body: string;
+};
+
 export type PostPluginsBodyPluginInstallerForm = {
   url?: string;
   ghBranch?: string;
@@ -1960,6 +2057,10 @@ export type GetAdminHome200 = {
   adminHomeParams?: SystemInformationParams;
 };
 
+export type PutFileUploadSettingsForAppSettings200 = {
+  responseParams?: FileUploadSettingParams;
+};
+
 export type GetAppSettings200 = {
   appSettingsParams?: AppSettingParams;
 };
@@ -1986,8 +2087,25 @@ export type PutSmtpSettingForAppSettings200 = {
  */
 export type PostSmtpTestForAppSettings200 = { [key: string]: unknown };
 
-export type PutFileUploadSettingsForAppSettings200 = {
-  responseParams?: FileUploadSettingParams;
+export type PutOauth2SettingForAppSettingsBody = {
+  /** e-mail address used as from address */
+  fromAddress?: string;
+  /** transmission method */
+  transmissionMethod?: string;
+  /** OAuth 2.0 Client ID */
+  oauth2ClientId?: string;
+  /** OAuth 2.0 Client Secret */
+  oauth2ClientSecret?: string;
+  /** OAuth 2.0 Refresh Token */
+  oauth2RefreshToken?: string;
+  /** Email address of the authorized account */
+  oauth2User?: string;
+};
+
+export type PutOauth2SettingForAppSettings200MailSettingParams = { [key: string]: unknown };
+
+export type PutOauth2SettingForAppSettings200 = {
+  mailSettingParams?: PutOauth2SettingForAppSettings200MailSettingParams;
 };
 
 export type PostV5SchemaMigrationForAppSettings200 = {
@@ -2132,6 +2250,28 @@ export type PutBookmarks200 = {
   bookmark?: Bookmark;
 };
 
+export type PutContentDispositionSettings200CurrentDispositionSettings = {
+  /** The list of MIME types set to inline. */
+  inlineMimeTypes?: string[];
+  /** The list of MIME types set to attachment. */
+  attachmentMimeTypes?: string[];
+};
+
+export type PutContentDispositionSettings200 = {
+  currentDispositionSettings?: PutContentDispositionSettings200CurrentDispositionSettings;
+};
+
+export type GetContentDispositionSettings200CurrentDispositionSettings = {
+  /** The list of MIME types set to inline. */
+  inlineMimeTypes?: string[];
+  /** The list of MIME types set to attachment. */
+  attachmentMimeTypes?: string[];
+};
+
+export type GetContentDispositionSettings200 = {
+  currentDispositionSettings?: GetContentDispositionSettings200CurrentDispositionSettings;
+};
+
 export type GetCustomizeSetting200 = {
   /** customize params */
   customizeParams?: CustomizeSetting;
@@ -2377,23 +2517,8 @@ export type GetHealthcheck503 = {
   info?: HealthcheckInfo;
 };
 
-/**
- * import settings params
- */
-export type GetImport200ImportSettingsParams = {
-  /** the team name of esa.io */
-  esaTeamName?: string;
-  /** the access token of esa.io */
-  esaAccessToken?: string;
-  /** the team name of qiita.com */
-  qiitaTeamName?: string;
-  /** the access token of qiita.com */
-  qiitaAccessToken?: string;
-};
-
-export type GetImport200 = {
-  /** import settings params */
-  importSettingsParams?: GetImport200ImportSettingsParams;
+export type GetStatusForImport200 = {
+  status?: ImportStatus;
 };
 
 /**
@@ -2412,10 +2537,6 @@ export type PostImportBody = {
   options?: PostImportBodyOptions;
 };
 
-export type GetStatusForImport200 = {
-  status?: ImportStatus;
-};
-
 export type PostUploadForImportBody = {
   file?: Blob;
 };
@@ -2545,35 +2666,7 @@ export type PutEnabledByIdForNotificationSettingGlobalNotification200 = {
 };
 
 export type GetRootForPageListing200 = {
-  rootPage?: Page;
-};
-
-export type GetAncestorsChildrenForPageListingParams = {
-  path: string;
-};
-
-export type GetAncestorsChildrenForPageListing200AncestorsChildren = {
-  [key: string]: {
-    /** Document ID */
-    _id?: string;
-    /** Number of descendants */
-    descendantCount?: number;
-    /** Indicates if the node is empty */
-    isEmpty?: boolean;
-    /** Access level */
-    grant?: number;
-    /** Path string */
-    path?: string;
-    /**
-     * Revision ID (nullable)
-     * @nullable
-     */
-    revision?: string | null;
-  };
-};
-
-export type GetAncestorsChildrenForPageListing200 = {
-  ancestorsChildren?: GetAncestorsChildrenForPageListing200AncestorsChildren;
+  rootPage?: PageForTreeItem;
 };
 
 export type GetChildrenForPageListingParams = {
@@ -2582,7 +2675,7 @@ export type GetChildrenForPageListingParams = {
 };
 
 export type GetChildrenForPageListing200 = {
-  children?: Page[];
+  children?: PageForTreeItem[];
 };
 
 export type GetInfoForPageListingParams = {
@@ -2598,7 +2691,37 @@ export type GetInfoForPageListingParams = {
   attachShortBody?: boolean;
 };
 
-export type GetInfoForPageListing200 = { [key: string]: PageInfoAll };
+export type GetInfoForPageListing200 = { [key: string]: PageInfoExt };
+
+export type GetItemForPageListingParams = {
+  id: string;
+};
+
+export type GetItemForPageListing200 = {
+  item?: PageForTreeItem;
+};
+
+export type GetSharedForPageParams = {
+  /**
+   * share link ID
+   */
+  shareLinkId: ObjectId;
+  /**
+   * page ID
+   */
+  pageId: ObjectId;
+};
+
+export type GetInfoForPageParams = {
+  /**
+   * page id
+   */
+  pageId: ObjectId;
+  /**
+   * share link id for shared page access
+   */
+  shareLinkId?: ObjectId;
+};
 
 export type GetPageParams = {
   /**
@@ -2609,6 +2732,18 @@ export type GetPageParams = {
    * page path
    */
   path?: PagePath;
+  /**
+   * If set, returns all pages matching the path (returns pages array instead of single page)
+   */
+  findAll?: boolean;
+  /**
+   * Specific revision ID to retrieve
+   */
+  revisionId?: ObjectId;
+  /**
+   * Include empty pages in results when using findAll
+   */
+  includeEmpty?: boolean;
 };
 
 export type PostPageBodyGrantUserGroupIdsItem = {
@@ -2674,13 +2809,6 @@ export type GetExistForPage200 = {
   isExist?: boolean;
 };
 
-export type GetInfoForPageParams = {
-  /**
-   * page id
-   */
-  pageId: ObjectId;
-};
-
 export type GetGrantDataForPageParams = {
   /**
    * page id
@@ -2802,8 +2930,6 @@ export type GetRecentForPagesParams = {
 export type PutRenameForPagesBody = {
   pageId: ObjectId;
   path?: PagePath;
-  /** revision ID */
-  revisionId: string;
   /** new path */
   newPagePath?: string;
   /** whether redirect page */