@gitbook/api - npm Package Compare versions

Comparing version 0.146.0 to 0.147.0

dist/constants.d.ts

+export declare const APITOKEN_LABEL_MAX_LENGTH = 50;
+export declare const URL_MAX_LENGTH = 2048;
+export declare const SPACE_TITLE_MAX_LENGTH = 50;
+export declare const EMOJI_MAX_LENGTH = 50;
+export declare const CONTENT_VISIBILITY_ENUM: ["public", "unlisted", "share-link", "visitor-auth", "in-collection", "private"];
+export declare const SPACE_EDIT_MODE_ENUM: ["live", "locked"];
+export declare const EXPRESSION_MAX_LENGTH = 1024;
+export declare const EXPRESSION_MIN_LENGTH = 0;
+export declare const TRANSLATION_LANGUAGE_ENUM: ["en", "fr", "de", "es", "it", "pt", "pt-br", "ru", "ja", "zh", "yue", "ko", "ar", "hi", "nl", "pl", "tr", "sv", "no", "da", "fi", "el", "cs", "hu", "ro", "th", "vi", "id", "ms", "he", "uk", "sk", "bg", "hr", "lt", "lv", "et", "sl"];
+export declare const GIT_SYNC_PROVIDER_ENUM: ["github", "gitlab", "github-legacy"];
+export declare const MEMBER_ROLE_ENUM: ["admin", "create", "edit", "review", "comment", "read"];
+export declare const ORGANIZATION_TEAM_TITLE_MAX_LENGTH = 64;
+export declare const ORGANIZATION_TEAM_TITLE_MIN_LENGTH = 1;
+export declare const ICON_MAX_LENGTH = 50;
+export declare const DOCUMENT_TEXT_COLOR_ENUM: ["default", "green", "blue", "red", "orange", "yellow", "purple", "$primary", "$info", "$success", "$warning", "$danger"];
+export declare const DOCUMENT_TEXT_BACKGROUND_COLOR_ENUM: ["default", "green", "blue", "red", "orange", "yellow", "purple", "$primary", "$info", "$success", "$warning", "$danger"];
+export declare const TEXT_ALIGNMENT_ENUM: ["start", "center", "end"];
+export declare const CARDS_IMAGE_OBJECT_FIT_ENUM: ["contain", "fill", "cover"];
+export declare const VERTICAL_ALIGNMENT_ENUM: ["top", "middle", "bottom"];
+export declare const REVISION_PAGE_LAYOUT_OPTIONS_WIDTH_ENUM: ["default", "wide"];
+export declare const REVISION_PAGE_LAYOUT_OPTIONS_COVER_SIZE_ENUM: ["hero", "full"];
+export declare const CHANGE_REQUEST_STATUS_ENUM: ["draft", "open", "archived", "merged"];
+export declare const CHANGE_REQUEST_SUBJECT_MAX_LENGTH = 100;
+export declare const CHANGE_REQUEST_SUBJECT_MIN_LENGTH = 0;
+export declare const ORGANIZATION_TITLE_MAX_LENGTH = 255;
+export declare const ORGANIZATION_TITLE_MIN_LENGTH = 2;
+export declare const ORGANIZATION_HOSTNAME_MAX_LENGTH = 32;
+export declare const ORGANIZATION_HOSTNAME_MIN_LENGTH = 3;
+export declare const ORGANIZATION_TYPE_ENUM: ["business", "community"];
+export declare const ORGANIZATION_USE_CASE_ENUM: ["internalDocs", "docsSite", "audienceControlledSite", "productDocs", "teamKnowledgeBase", "designSystem", "openSourceDocs", "notes", "other"];
+export declare const ORGANIZATION_COMMUNITY_TYPE_ENUM: ["nonProfit", "openSource", "education"];
+export declare const BILLING_PRODUCT_ENUM: ["free_2024", "plus_2024", "pro_2024", "enterprise_2024", "community_2024", "free", "plus", "pro", "internal"];
+export declare const BILLING_INTERVAL_ENUM: ["monthly", "yearly"];
+export declare const BILLING_TRIAL_STATUS_ENUM: ["notapplicable", "none", "active", "ended", "expired"];
+export declare const BLOCK_SOURCE_ENUM: ["backoffice", "external", "internal"];
+export declare const BLOCK_REASON_MAX_LENGTH = 255;
+export declare const BLOCK_REASON_MIN_LENGTH = 1;
+export declare const COLLECTION_TITLE_MAX_LENGTH = 50;
+export declare const COLLECTION_DESCRIPTION_MAX_LENGTH = 100;
+export declare const COLLECTION_DESCRIPTION_MIN_LENGTH = 0;
+export declare const OPEN_APISPEC_SLUG_MAX_LENGTH = 100;
+export declare const OPEN_APISPEC_SLUG_MIN_LENGTH = 1;
+export declare const OPEN_APISPEC_SLUG_PATTERN = "^[a-zA-Z0-9]+(?:-[a-zA-Z0-9]+)*$";
+export declare const OPEN_APISPEC_PROCESSING_STATE_ENUM: ["pending", "progress", "complete"];
+export declare const OPEN_APISPEC_VISIBILITY_ENUM: ["private", "public"];
+export declare const OPEN_APISPEC_PROCESSING_ERROR_CODE_ENUM: ["FETCH_TIMEOUT", "FETCH_ERROR", "PARSE_ERROR"];
+export declare const CONTENT_REFERENCE_STATUS_ENUM: ["ok", "broken", "in-app"];
+export declare const CONTENT_REFERENCE_RELATION_ENUM: ["reference", "dependsOn"];
+export declare const CHANGE_REQUEST_REVIEW_STATUS_ENUM: ["changes-requested", "approved"];
+export declare const REVISION_PAGE_TYPE_ENUM: ["document", "group", "link", "computed"];
+export declare const REVISION_PAGE_LAYOUT_PRESET_ENUM: ["docs", "editorial", "landing"];
+export declare const INTEGRATION_TITLE_MAX_LENGTH = 30;
+export declare const INTEGRATION_TITLE_MIN_LENGTH = 2;
+export declare const INTEGRATION_DESCRIPTION_MAX_LENGTH = 100;
+export declare const INTEGRATION_SUMMARY_MAX_LENGTH = 2048;
+export declare const INTEGRATION_TARGET_ENUM: ["all", "site", "space", "organization"];
+export declare const INTEGRATION_VISIBILITY_ENUM: ["public", "private", "unlisted"];
+export declare const INTEGRATION_SCOPE_ENUM: ["space:content:read", "space:content:write", "space:metadata:read", "space:metadata:write", "space:git:sync", "page:feedback:read", "site:metadata:read", "site:views:read", "site:script:inject", "site:script:cookies", "site:visitor:auth", "site:adaptive:read", "site:adaptive:write", "openapi:read", "openapi:write", "conversations:ingest"];
+export declare const INTEGRATION_CATEGORY_ENUM: ["analytics", "collaboration", "content", "gitsync", "marketing", "visitor-auth", "other"];
+export declare const INTEGRATION_INSTALLATION_STATUS_ENUM: ["active", "pending", "paused"];
+export declare const INTEGRATION_INSTALLATION_SPACE_SELECTION_ENUM: ["all", "selected"];
+export declare const INTEGRATION_INSTALLATION_SITE_SELECTION_ENUM: ["all", "selected"];
+export declare const PAGE_FEEDBACK_RATING_ENUM: ["bad", "ok", "good"];
+export declare const SITE_TYPE_ENUM: ["basic", "premium", "ultimate", "sponsored", "legacy-basic", "legacy-premium"];
+export declare const SITE_TITLE_MAX_LENGTH = 128;
+export declare const SITE_TITLE_MIN_LENGTH = 2;
+export declare const SITE_HOSTNAME_MAX_LENGTH = 512;
+export declare const SITE_HOSTNAME_PATTERN = "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?[.]){2,}[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$";
+export declare const SITE_BASENAME_MAX_LENGTH = 100;
+export declare const SITE_BASENAME_MIN_LENGTH = 1;
+export declare const SITE_PROXY_ORIGIN_MAX_LENGTH = 512;
+export declare const SITE_PROXY_ORIGIN_PATTERN = "^([\\w-]+\\.)*[\\w-]+\\.[a-zA-Z]{2,}(\\/[\\w-]+)+$";
+export declare const SITE_VISIBILITY_ENUM: ["public", "unlisted", "share-link", "visitor-auth"];
+export declare const SITE_ADS_TOPIC_ENUM: ["webdev", "crypto"];
+export declare const SITE_AGENTS_CONTEXT_ENUM: ["excluded", "included"];
+export declare const SITE_FEATURE_KEY_ENUM: ["sites-adaptive-content", "sites-advanced-customization", "sites-advanced-insights", "sites-ads", "sites-ai-search", "sites-ai-assistant", "sites-embed", "sites-api-playground", "sites-basic-customization", "sites-custom-domain", "sites-custom-fonts", "sites-custom-subdirectory", "sites-full-text-search", "sites-multivariant-site", "sites-no-custom-domain", "sites-page-feedback", "sites-page-traffic-insights", "sites-pdf-export", "sites-preview-deployments", "sites-public-visibility", "sites-redirects", "sites-search-insights", "sites-sections", "sites-seo", "sites-share-links", "sites-unlisted-visibility", "sites-user-contribution", "sites-visitor-authentication", "sites-visitors"];
+export declare const SITE_CUSTOMIZATION_FEATURE_ENUM: ["header-logo", "theme-preset", "premium-fonts", "custom-icons", "footer-logo", "footer-links", "footer-copyright", "semantic-colors"];
+export declare const CONTENT_KIT_ICON_ENUM: ["close", "edit", "github", "gitlab", "maximize", "email", "settings", "search", "delete", "star", "warning", "link", "link-external", "eye", "eye-off", "lock", "check", "check-circle"];
+export declare const SITE_SECTION_TITLE_MAX_LENGTH = 128;
+export declare const SITE_SECTION_TITLE_MIN_LENGTH = 2;
+export declare const SITE_SECTION_DESCRIPTION_MAX_LENGTH = 256;
+export declare const SITE_SECTION_DESCRIPTION_MIN_LENGTH = 0;
+export declare const SITE_SECTION_PATH_MAX_LENGTH = 100;
+export declare const SITE_SECTION_PATH_MIN_LENGTH = 1;
+export declare const SITE_SPACE_PATH_MAX_LENGTH = 100;
+export declare const SITE_SPACE_PATH_MIN_LENGTH = 1;
+export declare const SITE_SECTION_GROUP_TITLE_MAX_LENGTH = 100;
+export declare const SITE_SECTION_GROUP_TITLE_MIN_LENGTH = 1;
+export declare const TEAM_MEMBER_ROLE_ENUM: ["owner", "member"];
+export declare const BILLING_SWITCH_ACTION_ENUM: ["trial", "upgrade", "upgrade_passive", "downgrade", "undo_cancel", "switch_interval"];
+export declare const BILLING_METER_ENUM: ["ai_responses", "ai_agent_responses", "translation_words"];
+export declare const SAMLPROVIDER_LABEL_MAX_LENGTH = 30;
+export declare const SAMLPROVIDER_LABEL_MIN_LENGTH = 1;
+export declare const SAMLPROVIDER_ENTITY_ID_MAX_LENGTH = 1024;
+export declare const SAMLPROVIDER_CERTIFICATE_MAX_LENGTH = 10000;
+export declare const SAMLPROVIDER_STATUS_ENUM: ["active", "pending"];
+export declare const AGENT_TASK_STATUS_ENUM: ["backlog", "started", "completed", "canceled"];
+export declare const TRANSLATION_STATUS_ENUM: ["pending", "running", "completed"];
+export declare const STORAGE_UPLOAD_KIND_ENUM: ["customization_font", "import_file"];
+export declare const FONT_FAMILY_MAX_LENGTH = 50;
+export declare const FONT_FAMILY_MIN_LENGTH = 1;
+export declare const STORAGE_FILE_KEY_MAX_LENGTH = 512;
+export declare const STORAGE_FILE_KEY_MIN_LENGTH = 1;
+export declare const CUSTOMIZATION_THEME_ENUM: ["clean", "muted", "bold", "gradient"];
+export declare const COLOR_PATTERN = "^#(?:[0-9a-fA-F]{3}){1,2}$";
+export declare const CUSTOMIZATION_CORNERS_ENUM: ["straight", "rounded", "circular"];
+export declare const CUSTOMIZATION_DEPTH_ENUM: ["subtle", "flat"];
+export declare const CUSTOMIZATION_LINKS_STYLE_ENUM: ["default", "accent"];
+export declare const CUSTOMIZATION_DEFAULT_FONT_ENUM: ["ABCFavorit", "Inter", "Roboto", "RobotoSlab", "OpenSans", "SourceSansPro", "Lato", "Ubuntu", "Raleway", "Merriweather", "Overpass", "NotoSans", "IBMPlexSerif", "Poppins", "FiraSans"];
+export declare const CUSTOMIZATION_DEFAULT_MONOSPACE_FONT_ENUM: ["FiraCode", "IBMPlexMono", "JetBrainsMono", "SourceCodePro", "RobotoMono", "SpaceMono", "DMMono", "Inconsolata"];
+export declare const CUSTOMIZATION_BACKGROUND_ENUM: ["plain", "match"];
+export declare const CUSTOMIZATION_ICONS_STYLE_ENUM: ["regular", "solid", "duotone", "light", "thin"];
+export declare const CUSTOMIZATION_SIDEBAR_BACKGROUND_STYLE_ENUM: ["default", "filled"];
+export declare const CUSTOMIZATION_SIDEBAR_LIST_STYLE_ENUM: ["default", "pill", "line"];
+export declare const CUSTOMIZATION_SEARCH_STYLE_ENUM: ["prominent", "subtle"];
+export declare const CUSTOMIZATION_LOCALE_ENUM: ["en", "fr", "es", "zh", "ja", "de", "nl", "no", "pt-br", "ru"];
+export declare const CUSTOMIZATION_HEADER_PRESET_ENUM: ["default", "bold", "contrast", "custom", "none"];
+export declare const CUSTOMIZATION_CONTENT_LINK_TITLE_MAX_LENGTH = 64;
+export declare const CUSTOMIZATION_ANNOUNCEMENT_MESSAGE_MAX_LENGTH = 128;
+export declare const CUSTOMIZATION_ANNOUNCEMENT_MESSAGE_MIN_LENGTH = 2;
+export declare const CUSTOMIZATION_THEME_MODE_ENUM: ["light", "dark"];
+export declare const CUSTOMIZATION_AIMODE_ENUM: ["none", "search", "assistant"];
+export declare const SITE_EXTERNAL_LINKS_TARGET_ENUM: ["self", "blank"];
+export declare const SHARE_LINK_NAME_MAX_LENGTH = 50;
+export declare const SHARE_LINK_NAME_MIN_LENGTH = 0;
+export declare const AIMODEL_ENUM: ["fast", "reasoning-low", "reasoning-medium", "reasoning-high"];
+export declare const SITE_INSIGHTS_DISPLAY_CONTEXT_ENUM: ["site", "embed"];
+export declare const SITE_INSIGHTS_LINK_POSITION_ENUM: ["announcement", "header", "footer", "sidebar", "content"];
+export declare const SITE_INSIGHTS_TRADEMARK_PLACEMENT_ENUM: ["sidebar", "ad", "footer", "pdf"];
+export declare const SITE_INSIGHTS_AD_PLACEMENT_ENUM: ["aside"];
+export declare const SITE_INSIGHTS_EVENT_TYPE_ENUM: ["page_view", "search_open", "search_type_query", "search_open_result", "page_post_feedback", "page_post_feedback_comment", "ask_question", "ask_view", "ask_rate_response", "link_click", "api_client_open", "api_client_request", "ad_click", "ad_display", "trademark_click"];
+export declare const SITE_INSIGHTS_VISITOR_BROWSER_ENUM: ["chrome", "firefox", "safari", "edge", "ie", "opera", "unknown"];
+export declare const SITE_INSIGHTS_VISITOR_DEVICE_ENUM: ["desktop", "tablet", "mobile", "unknown"];
+export declare const SITE_INSIGHTS_VISITOR_OS_ENUM: ["windows", "macos", "linux", "android", "ios", "unknown"];
+export declare const SITE_INSIGHTS_VISITOR_BOT_ENUM: ["unknown", "googlebot", "bingbot", "duckduckbot", "facebookbot", "applebot", "chatgpt", "anthropic"];
+export declare const SITE_INSIGHTS_QUERY_OPERATOR_ENUM: ["in", "notIn", "greaterThan", "greaterThanOrEqual", "lessThan", "lessThanOrEqual"];
+export declare const SITE_INSIGHTS_QUERY_RANGE_PRESET_ENUM: ["lastYear", "last3Months", "last30Days", "last7Days", "last24Hours"];
+export declare const SITE_REDIRECT_SOURCE_PATH_MAX_LENGTH = 512;
+export declare const SITE_REDIRECT_SOURCE_PATH_PATTERN = "^\\/(?:[A-Za-z0-9\\-._~]|%[0-9A-Fa-f]{2})+(?:\\/(?:[A-Za-z0-9\\-._~]|%[0-9A-Fa-f]{2})+)*$";
+export declare const SITE_MCP_SERVER_NAME_MAX_LENGTH = 100;
+export declare const SITE_MCP_SERVER_NAME_MIN_LENGTH = 1;
+export declare const CUSTOM_HOSTNAME_DNS_STATUS_ENUM: ["dns_passed", "dns_wrong_cname", "dns_no_cname", "dns_cloudflare_proxied", "dns_wrong_caa"];
+export declare const CUSTOM_HOSTNAME_SSL_STATUS_ENUM: ["live", "ssl_unknown", "ssl_pending", "ssl_failed", "ssl_retry_expired"];
+export declare const CUSTOM_HOSTNAME_ERROR_STATUS_ENUM: ["invalid_domain", "internal_error"];
+export declare const CLOUDFLARE_HOSTNAME_STATUS_ENUM: ["pending", "active", "blocked", "moved", "deleted"];
+export declare const CLOUDFLARE_HOSTNAME_TLSSTATUS_ENUM: ["initializing", "pending_validation", "pending_issuance", "pending_deployment", "active", "pending_deletion", "pending_cleanup", "deleted"];
+export declare const CLOUDFLARE_HOSTNAME_TLSVALIDATION_METHOD_ENUM: ["http", "txt", "email"];
+export declare const SHA256_MAX_LENGTH = 64;
+export declare const SHA256_MIN_LENGTH = 64;
+export declare const GIT_BOOK_USERS_ENUM: ["gitbook:agent"];
+export declare const REVISION_SEMANTIC_CHANGE_TYPE_ENUM: ["page_created", "page_edited", "page_deleted", "page_moved", "file_created", "file_edited", "file_deleted", "custom_fields_edited"];
+export declare const GIT_SYNC_OPERATION_STATE_ENUM: ["running", "failure", "success"];
+export declare const GIT_SYNC_OPERATION_DIRECTION_ENUM: ["export", "import"];
+export declare const GIT_SYNC_OPERATION_STAGE_ENUM: ["repo_fetch", "config_check", "content_process", "finalize"];
+export declare const APIINTEGRATION_SCOPE_ENUM: ["integration:read", "integration:update", "integration:installation:read", "integration:installation:update"];
+export declare const SITE_ADS_STATUS_ENUM: ["pending", "in-review", "live", "rejected", "disabled"];
+export declare const AIMESSAGE_ROLE_ENUM: ["user", "assistant", "developer"];
+export declare const AGENT_STATUS_ENUM: ["idle", "processing", "errored"];

dist/index.d.ts

 import { Api } from './client';
 import { GitBookAPIError } from './GitBookAPIError';
 export * from './client';
+export * from './constants';
 export { GitBookAPIError };
@@ -5,0 +6,0 @@ export declare const GITBOOK_DEFAULT_ENDPOINT = "https://api.gitbook.com";

package.json

@@ -7,3 +7,3 @@ {
     "types": "./dist/index.d.ts",
-    "version": "0.146.0",
+    "version": "0.147.0",
     "sideEffects": false,
@@ -10,0 +10,0 @@ "files": [

No alert changes

Improved metrics

Total package byte prevSize

2846419

2.58%

Number of package files

10

11.11%

Lines of code

65213

1.84%

No dependency changes