@strapi/admin 5.53.0 → 5.55.0
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.
- package/dist/admin/admin/src/App.js +1 -1
- package/dist/admin/admin/src/App.js.map +1 -1
- package/dist/admin/admin/src/App.mjs +1 -1
- package/dist/admin/admin/src/App.mjs.map +1 -1
- package/dist/admin/admin/src/components/DismissibleBanner.js +60 -0
- package/dist/admin/admin/src/components/DismissibleBanner.js.map +1 -0
- package/dist/admin/admin/src/components/DismissibleBanner.mjs +58 -0
- package/dist/admin/admin/src/components/DismissibleBanner.mjs.map +1 -0
- package/dist/admin/admin/src/components/Form.js +11 -2
- package/dist/admin/admin/src/components/Form.js.map +1 -1
- package/dist/admin/admin/src/components/Form.mjs +11 -2
- package/dist/admin/admin/src/components/Form.mjs.map +1 -1
- package/dist/admin/admin/src/components/FormInputs/DateTime.js +1 -1
- package/dist/admin/admin/src/components/FormInputs/DateTime.js.map +1 -1
- package/dist/admin/admin/src/components/FormInputs/DateTime.mjs +1 -1
- package/dist/admin/admin/src/components/FormInputs/DateTime.mjs.map +1 -1
- package/dist/admin/admin/src/components/FormInputs/Time.js +1 -1
- package/dist/admin/admin/src/components/FormInputs/Time.js.map +1 -1
- package/dist/admin/admin/src/components/FormInputs/Time.mjs +1 -1
- package/dist/admin/admin/src/components/FormInputs/Time.mjs.map +1 -1
- package/dist/admin/admin/src/components/LanguageProvider.js +35 -1
- package/dist/admin/admin/src/components/LanguageProvider.js.map +1 -1
- package/dist/admin/admin/src/components/LanguageProvider.mjs +17 -2
- package/dist/admin/admin/src/components/LanguageProvider.mjs.map +1 -1
- package/dist/admin/admin/src/components/MainNav/NavUser.js +1 -2
- package/dist/admin/admin/src/components/MainNav/NavUser.js.map +1 -1
- package/dist/admin/admin/src/components/MainNav/NavUser.mjs +1 -2
- package/dist/admin/admin/src/components/MainNav/NavUser.mjs.map +1 -1
- package/dist/admin/admin/src/components/MediaLibraryBanner.js +85 -0
- package/dist/admin/admin/src/components/MediaLibraryBanner.js.map +1 -0
- package/dist/admin/admin/src/components/MediaLibraryBanner.mjs +83 -0
- package/dist/admin/admin/src/components/MediaLibraryBanner.mjs.map +1 -0
- package/dist/admin/admin/src/components/Providers.js +6 -6
- package/dist/admin/admin/src/components/Providers.js.map +1 -1
- package/dist/admin/admin/src/components/Providers.mjs +6 -6
- package/dist/admin/admin/src/components/Providers.mjs.map +1 -1
- package/dist/admin/admin/src/components/SubNav.js +113 -35
- package/dist/admin/admin/src/components/SubNav.js.map +1 -1
- package/dist/admin/admin/src/components/SubNav.mjs +115 -37
- package/dist/admin/admin/src/components/SubNav.mjs.map +1 -1
- package/dist/admin/admin/src/components/SubNavFolder.js +188 -0
- package/dist/admin/admin/src/components/SubNavFolder.js.map +1 -0
- package/dist/admin/admin/src/components/SubNavFolder.mjs +186 -0
- package/dist/admin/admin/src/components/SubNavFolder.mjs.map +1 -0
- package/dist/admin/admin/src/components/UpsellBanner.js +56 -86
- package/dist/admin/admin/src/components/UpsellBanner.js.map +1 -1
- package/dist/admin/admin/src/components/UpsellBanner.mjs +58 -88
- package/dist/admin/admin/src/components/UpsellBanner.mjs.map +1 -1
- package/dist/admin/admin/src/core/store/configure.js +14 -2
- package/dist/admin/admin/src/core/store/configure.js.map +1 -1
- package/dist/admin/admin/src/core/store/configure.mjs +14 -2
- package/dist/admin/admin/src/core/store/configure.mjs.map +1 -1
- package/dist/admin/admin/src/core/store/hooks.mjs +1 -1
- package/dist/admin/admin/src/features/Auth.js +162 -46
- package/dist/admin/admin/src/features/Auth.js.map +1 -1
- package/dist/admin/admin/src/features/Auth.mjs +164 -48
- package/dist/admin/admin/src/features/Auth.mjs.map +1 -1
- package/dist/admin/admin/src/features/Tracking.js.map +1 -1
- package/dist/admin/admin/src/features/Tracking.mjs.map +1 -1
- package/dist/admin/admin/src/hooks/useRegisterUnsavedChanges.js +19 -0
- package/dist/admin/admin/src/hooks/useRegisterUnsavedChanges.js.map +1 -0
- package/dist/admin/admin/src/hooks/useRegisterUnsavedChanges.mjs +17 -0
- package/dist/admin/admin/src/hooks/useRegisterUnsavedChanges.mjs.map +1 -0
- package/dist/admin/admin/src/hooks/{useIdleSessionLogout.js → useSessionKeepalive.js} +34 -27
- package/dist/admin/admin/src/hooks/useSessionKeepalive.js.map +1 -0
- package/dist/admin/admin/src/hooks/{useIdleSessionLogout.mjs → useSessionKeepalive.mjs} +34 -27
- package/dist/admin/admin/src/hooks/useSessionKeepalive.mjs.map +1 -0
- package/dist/admin/admin/src/layouts/AuthenticatedLayout.js +2 -0
- package/dist/admin/admin/src/layouts/AuthenticatedLayout.js.map +1 -1
- package/dist/admin/admin/src/layouts/AuthenticatedLayout.mjs +2 -0
- package/dist/admin/admin/src/layouts/AuthenticatedLayout.mjs.map +1 -1
- package/dist/admin/admin/src/pages/SessionsPage.js +2 -5
- package/dist/admin/admin/src/pages/SessionsPage.js.map +1 -1
- package/dist/admin/admin/src/pages/SessionsPage.mjs +2 -5
- package/dist/admin/admin/src/pages/SessionsPage.mjs.map +1 -1
- package/dist/admin/admin/src/render.js +6 -1
- package/dist/admin/admin/src/render.js.map +1 -1
- package/dist/admin/admin/src/render.mjs +6 -1
- package/dist/admin/admin/src/render.mjs.map +1 -1
- package/dist/admin/admin/src/translations/en.json.js +16 -0
- package/dist/admin/admin/src/translations/en.json.js.map +1 -1
- package/dist/admin/admin/src/translations/en.json.mjs +16 -0
- package/dist/admin/admin/src/translations/en.json.mjs.map +1 -1
- package/dist/admin/admin/src/utils/baseQuery.js +3 -13
- package/dist/admin/admin/src/utils/baseQuery.js.map +1 -1
- package/dist/admin/admin/src/utils/baseQuery.mjs +3 -13
- package/dist/admin/admin/src/utils/baseQuery.mjs.map +1 -1
- package/dist/admin/admin/src/utils/getFetchClient.js +34 -5
- package/dist/admin/admin/src/utils/getFetchClient.js.map +1 -1
- package/dist/admin/admin/src/utils/getFetchClient.mjs +34 -6
- package/dist/admin/admin/src/utils/getFetchClient.mjs.map +1 -1
- package/dist/admin/admin/src/utils/unsavedChangesRegistry.js +25 -0
- package/dist/admin/admin/src/utils/unsavedChangesRegistry.js.map +1 -0
- package/dist/admin/admin/src/utils/unsavedChangesRegistry.mjs +22 -0
- package/dist/admin/admin/src/utils/unsavedChangesRegistry.mjs.map +1 -0
- package/dist/admin/admin/tests/utils.js +14 -14
- package/dist/admin/admin/tests/utils.js.map +1 -1
- package/dist/admin/admin/tests/utils.mjs +14 -14
- package/dist/admin/admin/tests/utils.mjs.map +1 -1
- package/dist/admin/ee/admin/src/hooks/useAIAvailability.js +1 -6
- package/dist/admin/ee/admin/src/hooks/useAIAvailability.js.map +1 -1
- package/dist/admin/ee/admin/src/hooks/useAIAvailability.mjs +1 -6
- package/dist/admin/ee/admin/src/hooks/useAIAvailability.mjs.map +1 -1
- package/dist/admin/ee/admin/src/pages/SettingsPage/pages/ApplicationInfoPage/components/AIUsage.js +7 -1
- package/dist/admin/ee/admin/src/pages/SettingsPage/pages/ApplicationInfoPage/components/AIUsage.js.map +1 -1
- package/dist/admin/ee/admin/src/pages/SettingsPage/pages/ApplicationInfoPage/components/AIUsage.mjs +7 -1
- package/dist/admin/ee/admin/src/pages/SettingsPage/pages/ApplicationInfoPage/components/AIUsage.mjs.map +1 -1
- package/dist/admin/ee/admin/src/pages/SettingsPage/pages/AuditLogs/utils/getActionTypesDefaultMessages.js +9 -1
- package/dist/admin/ee/admin/src/pages/SettingsPage/pages/AuditLogs/utils/getActionTypesDefaultMessages.js.map +1 -1
- package/dist/admin/ee/admin/src/pages/SettingsPage/pages/AuditLogs/utils/getActionTypesDefaultMessages.mjs +9 -1
- package/dist/admin/ee/admin/src/pages/SettingsPage/pages/AuditLogs/utils/getActionTypesDefaultMessages.mjs.map +1 -1
- package/dist/admin/ee/admin/src/pages/SettingsPage/pages/SingleSignOnPage.js +0 -4
- package/dist/admin/ee/admin/src/pages/SettingsPage/pages/SingleSignOnPage.js.map +1 -1
- package/dist/admin/ee/admin/src/pages/SettingsPage/pages/SingleSignOnPage.mjs +0 -4
- package/dist/admin/ee/admin/src/pages/SettingsPage/pages/SingleSignOnPage.mjs.map +1 -1
- package/dist/admin/index.js +1 -0
- package/dist/admin/index.js.map +1 -1
- package/dist/admin/index.mjs +1 -1
- package/dist/admin/src/components/DismissibleBanner.d.ts +8 -0
- package/dist/admin/src/components/MediaLibraryBanner.d.ts +2 -0
- package/dist/admin/src/components/SubNav.d.ts +27 -8
- package/dist/admin/src/components/SubNavFolder.d.ts +15 -0
- package/dist/admin/src/features/Tracking.d.ts +2 -1
- package/dist/admin/src/hooks/useRegisterUnsavedChanges.d.ts +6 -0
- package/dist/admin/src/hooks/useSessionKeepalive.d.ts +88 -0
- package/dist/admin/src/services/admin.d.ts +1 -0
- package/dist/admin/src/utils/getFetchClient.d.ts +14 -6
- package/dist/admin/src/utils/unsavedChangesRegistry.d.ts +11 -0
- package/dist/ee/admin/src/pages/SettingsPage/pages/AuditLogs/utils/getActionTypesDefaultMessages.d.ts +8 -0
- package/dist/ee/server/src/controllers/admin.d.ts.map +1 -1
- package/dist/ee/server/src/index.d.ts.map +1 -1
- package/dist/server/ee/server/src/controllers/admin.js +1 -5
- package/dist/server/ee/server/src/controllers/admin.js.map +1 -1
- package/dist/server/ee/server/src/controllers/admin.mjs +1 -5
- package/dist/server/ee/server/src/controllers/admin.mjs.map +1 -1
- package/dist/server/ee/server/src/index.js +2 -0
- package/dist/server/ee/server/src/index.js.map +1 -1
- package/dist/server/ee/server/src/index.mjs +2 -0
- package/dist/server/ee/server/src/index.mjs.map +1 -1
- package/dist/server/server/src/ai/controllers/ai.js +3 -3
- package/dist/server/server/src/ai/controllers/ai.js.map +1 -1
- package/dist/server/server/src/ai/controllers/ai.mjs +3 -3
- package/dist/server/server/src/ai/controllers/ai.mjs.map +1 -1
- package/dist/server/server/src/ai/services/ai.js +37 -12
- package/dist/server/server/src/ai/services/ai.js.map +1 -1
- package/dist/server/server/src/ai/services/ai.mjs +37 -12
- package/dist/server/server/src/ai/services/ai.mjs.map +1 -1
- package/dist/server/server/src/audit-logs/tokens.js +106 -0
- package/dist/server/server/src/audit-logs/tokens.js.map +1 -0
- package/dist/server/server/src/audit-logs/tokens.mjs +99 -0
- package/dist/server/server/src/audit-logs/tokens.mjs.map +1 -0
- package/dist/server/server/src/controllers/admin.js +10 -1
- package/dist/server/server/src/controllers/admin.js.map +1 -1
- package/dist/server/server/src/controllers/admin.mjs +10 -1
- package/dist/server/server/src/controllers/admin.mjs.map +1 -1
- package/dist/server/server/src/services/api-token.js +106 -4
- package/dist/server/server/src/services/api-token.js.map +1 -1
- package/dist/server/server/src/services/api-token.mjs +107 -5
- package/dist/server/server/src/services/api-token.mjs.map +1 -1
- package/dist/server/server/src/services/transfer/token.js +56 -4
- package/dist/server/server/src/services/transfer/token.js.map +1 -1
- package/dist/server/server/src/services/transfer/token.mjs +57 -5
- package/dist/server/server/src/services/transfer/token.mjs.map +1 -1
- package/dist/server/src/ai/services/ai.d.ts +3 -1
- package/dist/server/src/ai/services/ai.d.ts.map +1 -1
- package/dist/server/src/audit-logs/tokens.d.ts +86 -0
- package/dist/server/src/audit-logs/tokens.d.ts.map +1 -0
- package/dist/server/src/controllers/admin.d.ts +1 -0
- package/dist/server/src/controllers/admin.d.ts.map +1 -1
- package/dist/server/src/controllers/index.d.ts +1 -0
- package/dist/server/src/controllers/index.d.ts.map +1 -1
- package/dist/server/src/index.d.ts +1 -0
- package/dist/server/src/index.d.ts.map +1 -1
- package/dist/server/src/services/api-token.d.ts.map +1 -1
- package/dist/server/src/services/transfer/token.d.ts.map +1 -1
- package/dist/shared/contracts/admin.d.ts +1 -0
- package/dist/shared/contracts/admin.d.ts.map +1 -1
- package/dist/shared/contracts/shared.d.ts +1 -0
- package/dist/shared/contracts/shared.d.ts.map +1 -1
- package/package.json +7 -7
- package/dist/admin/admin/src/hooks/useIdleSessionLogout.js.map +0 -1
- package/dist/admin/admin/src/hooks/useIdleSessionLogout.mjs.map +0 -1
- package/dist/admin/src/hooks/useIdleSessionLogout.d.ts +0 -87
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Tracking.js","sources":["../../../../../admin/src/features/Tracking.tsx"],"sourcesContent":["import * as React from 'react';\n\nimport axios, { AxiosResponse } from 'axios';\n\nimport { Tours } from '../components/GuidedTour/Tours';\nimport { useDeviceType } from '../hooks/useDeviceType';\nimport { useInitQuery, useTelemetryPropertiesQuery } from '../services/admin';\n\nimport { useAppInfo } from './AppInfo';\nimport { useAuth } from './Auth';\nimport { useStrapiApp } from './StrapiApp';\n\nexport interface TelemetryProperties {\n useTypescriptOnServer?: boolean;\n useTypescriptOnAdmin?: boolean;\n isHostedOnStrapiCloud?: boolean;\n numberOfAllContentTypes?: number;\n numberOfComponents?: number;\n numberOfDynamicZones?: number;\n}\n\nexport interface TrackingContextValue {\n uuid?: string | boolean;\n telemetryProperties?: TelemetryProperties;\n}\n\n/* -------------------------------------------------------------------------------------------------\n * Context\n * -----------------------------------------------------------------------------------------------*/\n\nconst TrackingContext = React.createContext<TrackingContextValue>({\n uuid: false,\n});\n\n/* -------------------------------------------------------------------------------------------------\n * Provider\n * -----------------------------------------------------------------------------------------------*/\n\nexport interface TrackingProviderProps {\n children: React.ReactNode;\n}\n\nconst TrackingProvider = ({ children }: TrackingProviderProps) => {\n const token = useAuth('App', (state) => state.token);\n const { data: initData } = useInitQuery();\n const { uuid } = initData ?? {};\n const getAllWidgets = useStrapiApp('TrackingProvider', (state) => state.widgets.getAll);\n\n const { data } = useTelemetryPropertiesQuery(undefined, {\n skip: !initData?.uuid || !token,\n });\n React.useEffect(() => {\n if (uuid && data) {\n const event = 'didInitializeAdministration';\n try {\n fetch(`${process.env.STRAPI_ANALYTICS_URL || 'https://analytics.strapi.io'}/api/v2/track`, {\n method: 'POST',\n body: JSON.stringify({\n // This event is anonymous\n event,\n userId: '',\n eventPropeties: {},\n groupProperties: {\n ...data,\n projectId: uuid,\n registeredWidgets: getAllWidgets().map((widget) => widget.uid),\n },\n }),\n headers: {\n 'Content-Type': 'application/json',\n 'X-Strapi-Event': event,\n },\n });\n } catch {\n // silence is golden\n }\n }\n }, [data, uuid, getAllWidgets]);\n const value = React.useMemo(\n () => ({\n uuid,\n telemetryProperties: data,\n }),\n [uuid, data]\n );\n\n return <TrackingContext.Provider value={value}>{children}</TrackingContext.Provider>;\n};\n\n/* -------------------------------------------------------------------------------------------------\n * Hook\n * -----------------------------------------------------------------------------------------------*/\n\n/**\n * We can group these events together because none have properties so there's no benefit\n * to having them as separate types.\n *\n * Meanwhile those with properties have different property shapes corresponding to the specific\n * event so understanding which properties go with which event is very helpful.\n */\nexport interface EventWithoutProperties {\n name:\n | 'changeComponentsOrder'\n | 'didAddComponentToDynamicZone'\n | 'didBulkDeleteEntries'\n | 'didNotBulkDeleteEntries'\n | 'didChangeDisplayedFields'\n | 'didCheckDraftRelations'\n | 'didClickGuidedTourHomepageApiTokens'\n | 'didClickGuidedTourHomepageContentManager'\n | 'didClickGuidedTourHomepageContentTypeBuilder'\n | 'didClickGuidedTourStep1CollectionType'\n | 'didClickGuidedTourStep2ContentManager'\n | 'didClickGuidedTourStep3ApiTokens'\n | 'didClickonBlogSection'\n | 'didClickonCodeExampleSection'\n | 'didClickonReadTheDocumentationSection'\n | 'didClickOnTryStrapiCloudSection'\n | 'didClickonTutorialSection'\n | 'didCreateGuidedTourCollectionType'\n | 'didCreateGuidedTourEntry'\n | 'didCreateNewRole'\n | 'didCreateRole'\n | 'didDeleteToken'\n | 'didDuplicateRole'\n | 'didEditEditSettings'\n | 'didEditEmailTemplates'\n | 'didEditFieldNameOnContentType'\n | 'didEditListSettings'\n | 'didEditMediaLibraryConfig'\n | 'didEditNameOfContentType'\n | 'didGenerateGuidedTourApiTokens'\n | 'didLaunchGuidedtour'\n | 'didNotCreateFirstAdmin'\n | 'didNotSaveComponent'\n | 'didPluginLearnMore'\n | 'didBulkPublishEntries'\n | 'didNotBulkPublishEntries'\n | 'didUnpublishEntry'\n | 'didBulkUnpublishEntries'\n | 'didNotBulkUnpublishEntries'\n | 'didSaveComponent'\n | 'didSaveContentType'\n | 'didSearch'\n | 'didSkipGuidedtour'\n | 'didSubmitPlugin'\n | 'didSubmitProvider'\n | 'didUpdateConditions'\n | 'didSelectAllMediaLibraryElements'\n | 'didSelectContentTypeFieldSettings'\n | 'didSelectContentTypeSettings'\n | 'didEditAuthenticationProvider'\n | 'didRestoreHistoryVersion'\n | 'hasClickedCTBAddFieldBanner'\n | 'removeComponentFromDynamicZone'\n | 'willAddMoreFieldToContentType'\n | 'willBulkDeleteEntries'\n | 'willBulkPublishEntries'\n | 'willBulkUnpublishEntries'\n | 'willChangeNumberOfEntriesPerPage'\n | 'willCheckDraftRelations'\n | 'willCreateComponent'\n | 'willCreateComponentFromAttributesModal'\n | 'willCreateContentType'\n | 'willCreateFirstAdmin'\n | 'willCreateNewRole'\n | 'willCreateRole'\n | 'willCreateSingleType'\n | 'willCreateStage'\n | 'willCreateWorkflow'\n | 'willDeleteEntryFromList'\n | 'willDeleteFieldOfContentType'\n | 'willDuplicateRole'\n | 'willEditEditLayout'\n | 'willEditEmailTemplates'\n | 'willEditEntryFromButton'\n | 'willEditEntryFromList'\n | 'willEditReleaseFromHome'\n | 'willEditFieldOfContentType'\n | 'willEditMediaLibraryConfig'\n | 'willEditNameOfContentType'\n | 'willEditNameOfSingleType'\n | 'willEditAuthenticationProvider'\n | 'willEditFieldNameOnContentType'\n | 'willEditStage'\n | 'willFilterEntries'\n | 'willInstallPlugin'\n | 'willOpenAuditLogDetailsFromHome'\n | 'willUnpublishEntry'\n | 'willSaveComponent'\n | 'willSaveContentType'\n | 'willSaveContentTypeLayout'\n | 'didEditFieldNameOnContentType'\n | 'didCreateRelease'\n | 'didStartNewChat'\n | 'didLaunchGuidedtour'\n | 'didEditAICaption'\n | 'didEditAIAlternativeText'\n | 'didGenerateMetadataRetroactively';\n\n properties?: never;\n}\n\ninterface DidAccessAuthenticatedAdministrationEvent {\n name: 'didAccessAuthenticatedAdministration';\n properties: {\n registeredWidgets: string[];\n projectId: string;\n };\n}\n\ninterface DidFilterMediaLibraryElementsEvent {\n name: 'didFilterMediaLibraryElements';\n properties: MediaEvents['properties'] & {\n filter: string;\n };\n}\n\ninterface DidSortMediaLibraryElementsEvent {\n name: 'didSortMediaLibraryElements';\n properties: MediaEvents['properties'] & {\n sort: string;\n };\n}\n\ninterface DidCropFileEvent {\n name: 'didCropFile';\n properties: MediaEvents['properties'] & {\n duplicatedFile: null | boolean;\n };\n}\n\ninterface DidSelectFile {\n name: 'didSelectFile';\n properties: MediaEvents['properties'] & {\n source: 'url' | 'computer';\n };\n}\n\ninterface DidEditMediaLibraryElementsEvent {\n name: 'didEditMediaLibraryElements';\n properties: MediaEvents['properties'] & {\n type: string;\n changeLocation: string | boolean;\n };\n}\n\ninterface MediaEvents {\n name:\n | 'didSearchMediaLibraryElements'\n | 'didReplaceMedia'\n | 'didAddMediaLibraryFolders'\n | 'willAddMediaLibraryAssets';\n properties: {\n location: string;\n };\n}\n\ninterface DidSelectContentTypeFieldTypeEvent {\n name: 'didSelectContentTypeFieldType';\n properties: {\n type?: string;\n };\n}\n\ninterface DidChangeModeEvent {\n name: 'didChangeMode';\n properties: {\n newMode: string;\n };\n}\ninterface DidSubmitWithErrorsFirstAdminEvent {\n name: 'didSubmitWithErrorsFirstAdmin';\n properties: {\n count: string;\n };\n}\n\ninterface WillNavigateEvent {\n name: 'willNavigate';\n properties: {\n from: string;\n to: string;\n };\n}\n\ninterface DidClickOnDocLink {\n name: 'didClickOnDocLink';\n properties: {\n from: string;\n to: string;\n };\n}\n\ninterface DidAccessTokenListEvent {\n name: 'didAccessTokenList';\n properties: {\n tokenType: TokenEvents['properties']['tokenType'];\n number: number;\n };\n}\ninterface LogoEvent {\n name: 'didChangeLogo' | 'didClickResetLogo';\n properties: {\n logo: 'menu' | 'auth';\n };\n}\n\ninterface TokenEvents {\n name:\n | 'didCopyTokenKey'\n | 'didAddTokenFromList'\n | 'didEditTokenFromList'\n | 'willAccessTokenList'\n | 'willAddTokenFromList'\n | 'willCreateToken'\n | 'willDeleteToken'\n | 'willEditToken'\n | 'willEditTokenFromList';\n properties: {\n tokenType: 'api-token' | 'transfer-token';\n };\n}\n\ninterface WillModifyTokenEvent {\n name: 'didCreateToken' | 'didEditToken';\n properties: {\n tokenType: TokenEvents['properties']['tokenType'];\n kind?: 'admin' | 'content-api';\n type?: 'custom' | 'full-access' | 'read-only' | Array<'push' | 'pull' | 'push-pull'>;\n };\n}\n\ninterface DeleteEntryEvents {\n name: 'willDeleteEntry' | 'didDeleteEntry' | 'didNotDeleteEntry';\n properties: {\n status?: string;\n error?: unknown;\n };\n}\n\ninterface CreateEntryEvents {\n name: 'willCreateEntry' | 'didCreateEntry' | 'didNotCreateEntry';\n properties: {\n documentId?: string;\n status?: string;\n error?: unknown;\n fromPreview?: boolean;\n fromRelationModal?: boolean;\n };\n}\n\ninterface PublishEntryEvents {\n name: 'willPublishEntry' | 'didPublishEntry';\n properties: {\n documentId?: string;\n fromPreview?: boolean;\n fromRelationModal?: boolean;\n };\n}\n\ninterface UpdateEntryEvents {\n name: 'willEditEntry' | 'didEditEntry' | 'didNotEditEntry';\n properties: {\n documentId?: string;\n status?: string;\n error?: unknown;\n fromPreview?: boolean;\n fromRelationModal?: boolean;\n };\n}\n\ninterface DidFilterEntriesEvent {\n name: 'didFilterEntries';\n properties: {\n useRelation: boolean;\n };\n}\n\ninterface DidPublishRelease {\n name: 'didPublishRelease';\n properties: {\n totalEntries: number;\n totalPublishedEntries: number;\n totalUnpublishedEntries: number;\n };\n}\n\ninterface DidUsePresetPromptEvent {\n name: 'didUsePresetPrompt';\n properties: {\n promptType:\n | 'generate-product-schema'\n | 'tell-me-about-the-content-type-builder'\n | 'tell-me-about-strapi';\n };\n}\n\ninterface DidAnswerMessageEvent {\n name: 'didAnswerMessage';\n properties: {\n successful: boolean;\n };\n}\n\ninterface DidVoteAnswerEvent {\n name: 'didVoteAnswer';\n properties: {\n value: 'positive' | 'negative';\n };\n}\n\ninterface DidUpdateCTBSchema {\n name: 'didUpdateCTBSchema';\n properties: {\n success: boolean;\n newContentTypes: number;\n editedContentTypes: number;\n deletedContentTypes: number;\n newComponents: number;\n editedComponents: number;\n deletedComponents: number;\n newFields: number;\n editedFields: number;\n deletedFields: number;\n };\n}\n\ninterface DidSkipGuidedTour {\n name: 'didSkipGuidedTour';\n properties: {\n name: keyof Tours | 'all';\n };\n}\n\ninterface DidCompleteGuidedTour {\n name: 'didCompleteGuidedTour';\n properties: {\n name: keyof Tours | 'all';\n };\n}\n\ninterface DidStartGuidedTour {\n name: 'didStartGuidedTour';\n properties: {\n name: keyof Tours;\n fromHomepage?: boolean;\n };\n}\n\ninterface WillEditEntryFromHome {\n name: 'willEditEntryFromHome';\n properties: {\n entryType: 'edited' | 'published' | 'assigned';\n };\n}\n\ninterface DidOpenHomeWidgetLink {\n name: 'didOpenHomeWidgetLink';\n properties: {\n widgetUID: string;\n };\n}\n\ninterface DidOpenKeyStatisticsWidgetLink {\n name: 'didOpenKeyStatisticsWidgetLink';\n properties: {\n itemKey: string;\n };\n}\n\ntype EventsWithProperties =\n | CreateEntryEvents\n | PublishEntryEvents\n | DidAccessAuthenticatedAdministrationEvent\n | DidAccessTokenListEvent\n | DidChangeModeEvent\n | DidCropFileEvent\n | DeleteEntryEvents\n | DidEditMediaLibraryElementsEvent\n | DidFilterMediaLibraryElementsEvent\n | DidFilterEntriesEvent\n | DidSelectContentTypeFieldTypeEvent\n | DidSelectFile\n | DidSortMediaLibraryElementsEvent\n | DidSubmitWithErrorsFirstAdminEvent\n | DidUsePresetPromptEvent\n | DidAnswerMessageEvent\n | DidVoteAnswerEvent\n | LogoEvent\n | TokenEvents\n | UpdateEntryEvents\n | WillModifyTokenEvent\n | WillNavigateEvent\n | DidClickOnDocLink\n | DidPublishRelease\n | MediaEvents\n | DidUpdateCTBSchema\n | DidSkipGuidedTour\n | DidCompleteGuidedTour\n | DidStartGuidedTour\n | DidOpenHomeWidgetLink\n | DidOpenKeyStatisticsWidgetLink\n | WillEditEntryFromHome;\n\nexport type TrackingEvent = EventWithoutProperties | EventsWithProperties;\nexport interface UseTrackingReturn {\n /**\n * This type helps show all the available event names before you start typing,\n * however autocomplete isn't great.\n */\n trackUsage<TEvent extends TrackingEvent>(\n event: TEvent['name'],\n properties: TEvent['properties']\n ): Promise<null | AxiosResponse<string>>;\n trackUsage<TEvent extends Extract<TrackingEvent, { properties?: never }>>(\n event: TEvent['name'],\n properties?: never\n ): Promise<null | AxiosResponse<string>>;\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n trackUsage<TEvent extends Extract<TrackingEvent, { properties: object }>>(\n event: TEvent['name'],\n properties: TEvent['properties']\n ): Promise<null | AxiosResponse<string>>;\n}\n\n/**\n * @description Used to send amplitude events to the Strapi Tracking hub.\n *\n * @example\n * ```tsx\n * import { useTracking } from '@strapi/strapi/admin';\n *\n * const MyComponent = () => {\n * const { trackUsage } = useTracking();\n *\n * const handleClick = () => {\n * trackUsage('my-event', { myProperty: 'myValue' });\n * }\n *\n * return <button onClick={handleClick}>Send Event</button>\n * }\n * ```\n */\nconst useTracking = (): UseTrackingReturn => {\n const deviceType = useDeviceType();\n const deviceTypeRef = React.useRef(deviceType);\n deviceTypeRef.current = deviceType;\n const { uuid, telemetryProperties } = React.useContext(TrackingContext);\n const userId = useAppInfo('useTracking', (state) => state.userId);\n const trackUsage = React.useCallback(\n async <TEvent extends TrackingEvent>(\n event: TEvent['name'],\n properties?: TEvent['properties']\n ) => {\n try {\n if (uuid && !window.strapi.telemetryDisabled) {\n const res = await axios.post<string>(\n `${process.env.STRAPI_ANALYTICS_URL || 'https://analytics.strapi.io'}/api/v2/track`,\n {\n event,\n userId,\n eventProperties: { ...properties },\n userProperties: {\n deviceType: deviceTypeRef.current,\n },\n groupProperties: {\n ...telemetryProperties,\n projectId: uuid,\n projectType: window.strapi.projectType,\n },\n },\n {\n headers: {\n 'Content-Type': 'application/json',\n 'X-Strapi-Event': event,\n },\n }\n );\n\n return res;\n }\n } catch {\n // Silence is golden\n }\n\n return null;\n },\n [telemetryProperties, userId, uuid]\n );\n\n return { trackUsage };\n};\n\nexport { TrackingProvider, useTracking };\n"],"names":["TrackingContext","React","createContext","uuid","TrackingProvider","children","token","useAuth","state","data","initData","useInitQuery","getAllWidgets","useStrapiApp","widgets","getAll","useTelemetryPropertiesQuery","undefined","skip","useEffect","event","fetch","process","env","STRAPI_ANALYTICS_URL","method","body","JSON","stringify","userId","eventPropeties","groupProperties","projectId","registeredWidgets","map","widget","uid","headers","value","useMemo","telemetryProperties","_jsx","Provider","useTracking","deviceType","useDeviceType","deviceTypeRef","useRef","current","useContext","useAppInfo","trackUsage","useCallback","properties","window","strapi","telemetryDisabled","res","axios","post","eventProperties","userProperties","projectType"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA;;AAEkG,qGAElG,MAAMA,eAAAA,iBAAkBC,gBAAAA,CAAMC,aAAa,CAAuB;IAChEC,IAAAA,EAAM;AACR,CAAA,CAAA;AAUA,MAAMC,gBAAAA,GAAmB,CAAC,EAAEC,QAAQ,EAAyB,GAAA;AAC3D,IAAA,MAAMC,QAAQC,YAAAA,CAAQ,KAAA,EAAO,CAACC,KAAAA,GAAUA,MAAMF,KAAK,CAAA;AACnD,IAAA,MAAM,EAAEG,IAAAA,EAAMC,QAAQ,EAAE,GAAGC,kBAAAA,EAAAA;AAC3B,IAAA,MAAM,EAAER,IAAI,EAAE,GAAGO,YAAY,EAAC;IAC9B,MAAME,aAAAA,GAAgBC,uBAAa,kBAAA,EAAoB,CAACL,QAAUA,KAAAA,CAAMM,OAAO,CAACC,MAAM,CAAA;AAEtF,IAAA,MAAM,EAAEN,IAAI,EAAE,GAAGO,kCAA4BC,SAAAA,EAAW;QACtDC,IAAAA,EAAM,CAACR,QAAAA,EAAUP,IAAAA,IAAQ,CAACG;AAC5B,KAAA,CAAA;AACAL,IAAAA,gBAAAA,CAAMkB,SAAS,CAAC,IAAA;AACd,QAAA,IAAIhB,QAAQM,IAAAA,EAAM;AAChB,YAAA,MAAMW,KAAAA,GAAQ,6BAAA;YACd,IAAI;gBACFC,KAAAA,CAAM,CAAA,EAAGC,QAAQC,GAAG,CAACC,oBAAoB,IAAI,6BAAA,CAA8B,aAAa,CAAC,EAAE;oBACzFC,MAAAA,EAAQ,MAAA;oBACRC,IAAAA,EAAMC,IAAAA,CAAKC,SAAS,CAAC;;AAEnBR,wBAAAA,KAAAA;wBACAS,MAAAA,EAAQ,EAAA;AACRC,wBAAAA,cAAAA,EAAgB,EAAC;wBACjBC,eAAAA,EAAiB;AACf,4BAAA,GAAGtB,IAAI;4BACPuB,SAAAA,EAAW7B,IAAAA;AACX8B,4BAAAA,iBAAAA,EAAmBrB,gBAAgBsB,GAAG,CAAC,CAACC,MAAAA,GAAWA,OAAOC,GAAG;AAC/D;AACF,qBAAA,CAAA;oBACAC,OAAAA,EAAS;wBACP,cAAA,EAAgB,kBAAA;wBAChB,gBAAA,EAAkBjB;AACpB;AACF,iBAAA,CAAA;AACF,YAAA,CAAA,CAAE,OAAM;;AAER,YAAA;AACF,QAAA;IACF,CAAA,EAAG;AAACX,QAAAA,IAAAA;AAAMN,QAAAA,IAAAA;AAAMS,QAAAA;AAAc,KAAA,CAAA;AAC9B,IAAA,MAAM0B,KAAAA,GAAQrC,gBAAAA,CAAMsC,OAAO,CACzB,KAAO;AACLpC,YAAAA,IAAAA;YACAqC,mBAAAA,EAAqB/B;AACvB,SAAA,CAAA,EACA;AAACN,QAAAA,IAAAA;AAAMM,QAAAA;AAAK,KAAA,CAAA;IAGd,qBAAOgC,cAAA,CAACzC,gBAAgB0C,QAAQ,EAAA;QAACJ,KAAAA,EAAOA,KAAAA;AAAQjC,QAAAA,QAAAA,EAAAA;;AAClD;AAubA;;;;;;;;;;;;;;;;;AAiBC,UACKsC,WAAAA,GAAc,IAAA;AAClB,IAAA,MAAMC,UAAAA,GAAaC,2BAAAA,EAAAA;IACnB,MAAMC,aAAAA,GAAgB7C,gBAAAA,CAAM8C,MAAM,CAACH,UAAAA,CAAAA;AACnCE,IAAAA,aAAAA,CAAcE,OAAO,GAAGJ,UAAAA;IACxB,MAAM,EAAEzC,IAAI,EAAEqC,mBAAmB,EAAE,GAAGvC,gBAAAA,CAAMgD,UAAU,CAACjD,eAAAA,CAAAA;AACvD,IAAA,MAAM6B,SAASqB,kBAAAA,CAAW,aAAA,EAAe,CAAC1C,KAAAA,GAAUA,MAAMqB,MAAM,CAAA;AAChE,IAAA,MAAMsB,UAAAA,GAAalD,gBAAAA,CAAMmD,WAAW,CAClC,OACEhC,KAAAA,EACAiC,UAAAA,GAAAA;QAEA,IAAI;AACF,YAAA,IAAIlD,QAAQ,CAACmD,MAAAA,CAAOC,MAAM,CAACC,iBAAiB,EAAE;AAC5C,gBAAA,MAAMC,GAAAA,GAAM,MAAMC,sBAAAA,CAAMC,IAAI,CAC1B,CAAA,EAAGrC,OAAAA,CAAQC,GAAG,CAACC,oBAAoB,IAAI,6BAAA,CAA8B,aAAa,CAAC,EACnF;AACEJ,oBAAAA,KAAAA;AACAS,oBAAAA,MAAAA;oBACA+B,eAAAA,EAAiB;AAAE,wBAAA,GAAGP;AAAW,qBAAA;oBACjCQ,cAAAA,EAAgB;AACdjB,wBAAAA,UAAAA,EAAYE,cAAcE;AAC5B,qBAAA;oBACAjB,eAAAA,EAAiB;AACf,wBAAA,GAAGS,mBAAmB;wBACtBR,SAAAA,EAAW7B,IAAAA;wBACX2D,WAAAA,EAAaR,MAAAA,CAAOC,MAAM,CAACO;AAC7B;iBACF,EACA;oBACEzB,OAAAA,EAAS;wBACP,cAAA,EAAgB,kBAAA;wBAChB,gBAAA,EAAkBjB;AACpB;AACF,iBAAA,CAAA;gBAGF,OAAOqC,GAAAA;AACT,YAAA;AACF,QAAA,CAAA,CAAE,OAAM;;AAER,QAAA;QAEA,OAAO,IAAA;IACT,CAAA,EACA;AAACjB,QAAAA,mBAAAA;AAAqBX,QAAAA,MAAAA;AAAQ1B,QAAAA;AAAK,KAAA,CAAA;IAGrC,OAAO;AAAEgD,QAAAA;AAAW,KAAA;AACtB;;;;;"}
|
|
1
|
+
{"version":3,"file":"Tracking.js","sources":["../../../../../admin/src/features/Tracking.tsx"],"sourcesContent":["import * as React from 'react';\n\nimport axios, { AxiosResponse } from 'axios';\n\nimport { Tours } from '../components/GuidedTour/Tours';\nimport { useDeviceType } from '../hooks/useDeviceType';\nimport { useInitQuery, useTelemetryPropertiesQuery } from '../services/admin';\n\nimport { useAppInfo } from './AppInfo';\nimport { useAuth } from './Auth';\nimport { useStrapiApp } from './StrapiApp';\n\nexport interface TelemetryProperties {\n useTypescriptOnServer?: boolean;\n useTypescriptOnAdmin?: boolean;\n isHostedOnStrapiCloud?: boolean;\n numberOfAllContentTypes?: number;\n numberOfComponents?: number;\n numberOfDynamicZones?: number;\n numberOfContentTypeFolders?: number;\n}\n\nexport interface TrackingContextValue {\n uuid?: string | boolean;\n telemetryProperties?: TelemetryProperties;\n}\n\n/* -------------------------------------------------------------------------------------------------\n * Context\n * -----------------------------------------------------------------------------------------------*/\n\nconst TrackingContext = React.createContext<TrackingContextValue>({\n uuid: false,\n});\n\n/* -------------------------------------------------------------------------------------------------\n * Provider\n * -----------------------------------------------------------------------------------------------*/\n\nexport interface TrackingProviderProps {\n children: React.ReactNode;\n}\n\nconst TrackingProvider = ({ children }: TrackingProviderProps) => {\n const token = useAuth('App', (state) => state.token);\n const { data: initData } = useInitQuery();\n const { uuid } = initData ?? {};\n const getAllWidgets = useStrapiApp('TrackingProvider', (state) => state.widgets.getAll);\n\n const { data } = useTelemetryPropertiesQuery(undefined, {\n skip: !initData?.uuid || !token,\n });\n React.useEffect(() => {\n if (uuid && data) {\n const event = 'didInitializeAdministration';\n try {\n fetch(`${process.env.STRAPI_ANALYTICS_URL || 'https://analytics.strapi.io'}/api/v2/track`, {\n method: 'POST',\n body: JSON.stringify({\n // This event is anonymous\n event,\n userId: '',\n eventPropeties: {},\n groupProperties: {\n ...data,\n projectId: uuid,\n registeredWidgets: getAllWidgets().map((widget) => widget.uid),\n },\n }),\n headers: {\n 'Content-Type': 'application/json',\n 'X-Strapi-Event': event,\n },\n });\n } catch {\n // silence is golden\n }\n }\n }, [data, uuid, getAllWidgets]);\n const value = React.useMemo(\n () => ({\n uuid,\n telemetryProperties: data,\n }),\n [uuid, data]\n );\n\n return <TrackingContext.Provider value={value}>{children}</TrackingContext.Provider>;\n};\n\n/* -------------------------------------------------------------------------------------------------\n * Hook\n * -----------------------------------------------------------------------------------------------*/\n\n/**\n * We can group these events together because none have properties so there's no benefit\n * to having them as separate types.\n *\n * Meanwhile those with properties have different property shapes corresponding to the specific\n * event so understanding which properties go with which event is very helpful.\n */\nexport interface EventWithoutProperties {\n name:\n | 'changeComponentsOrder'\n | 'didAddComponentToDynamicZone'\n | 'didBulkDeleteEntries'\n | 'didNotBulkDeleteEntries'\n | 'didChangeDisplayedFields'\n | 'didCheckDraftRelations'\n | 'didClickGuidedTourHomepageApiTokens'\n | 'didClickGuidedTourHomepageContentManager'\n | 'didClickGuidedTourHomepageContentTypeBuilder'\n | 'didClickGuidedTourStep1CollectionType'\n | 'didClickGuidedTourStep2ContentManager'\n | 'didClickGuidedTourStep3ApiTokens'\n | 'didClickonBlogSection'\n | 'didClickonCodeExampleSection'\n | 'didClickonReadTheDocumentationSection'\n | 'didClickOnTryStrapiCloudSection'\n | 'didClickonTutorialSection'\n | 'didCreateGuidedTourCollectionType'\n | 'didCreateGuidedTourEntry'\n | 'didCreateNewRole'\n | 'didCreateRole'\n | 'didDeleteToken'\n | 'didDuplicateRole'\n | 'didEditEditSettings'\n | 'didEditEmailTemplates'\n | 'didEditFieldNameOnContentType'\n | 'didEditListSettings'\n | 'didEditMediaLibraryConfig'\n | 'didEditNameOfContentType'\n | 'didGenerateGuidedTourApiTokens'\n | 'didLaunchGuidedtour'\n | 'didNotCreateFirstAdmin'\n | 'didNotSaveComponent'\n | 'didPluginLearnMore'\n | 'didBulkPublishEntries'\n | 'didNotBulkPublishEntries'\n | 'didUnpublishEntry'\n | 'didBulkUnpublishEntries'\n | 'didNotBulkUnpublishEntries'\n | 'didSaveComponent'\n | 'didSaveContentType'\n | 'didSearch'\n | 'didSkipGuidedtour'\n | 'didSubmitPlugin'\n | 'didSubmitProvider'\n | 'didUpdateConditions'\n | 'didSelectAllMediaLibraryElements'\n | 'didSelectContentTypeFieldSettings'\n | 'didSelectContentTypeSettings'\n | 'didEditAuthenticationProvider'\n | 'didRestoreHistoryVersion'\n | 'hasClickedCTBAddFieldBanner'\n | 'removeComponentFromDynamicZone'\n | 'willAddMoreFieldToContentType'\n | 'willBulkDeleteEntries'\n | 'willBulkPublishEntries'\n | 'willBulkUnpublishEntries'\n | 'willChangeNumberOfEntriesPerPage'\n | 'willCheckDraftRelations'\n | 'willCreateComponent'\n | 'willCreateComponentFromAttributesModal'\n | 'willCreateContentType'\n | 'willCreateFirstAdmin'\n | 'willCreateNewRole'\n | 'willCreateRole'\n | 'willCreateSingleType'\n | 'willCreateStage'\n | 'willCreateWorkflow'\n | 'willDeleteEntryFromList'\n | 'willDeleteFieldOfContentType'\n | 'willDuplicateRole'\n | 'willEditEditLayout'\n | 'willEditEmailTemplates'\n | 'willEditEntryFromButton'\n | 'willEditEntryFromList'\n | 'willEditReleaseFromHome'\n | 'willEditFieldOfContentType'\n | 'willEditMediaLibraryConfig'\n | 'willEditNameOfContentType'\n | 'willEditNameOfSingleType'\n | 'willEditAuthenticationProvider'\n | 'willEditFieldNameOnContentType'\n | 'willEditStage'\n | 'willFilterEntries'\n | 'willInstallPlugin'\n | 'willOpenAuditLogDetailsFromHome'\n | 'willUnpublishEntry'\n | 'willSaveComponent'\n | 'willSaveContentType'\n | 'willSaveContentTypeLayout'\n | 'didEditFieldNameOnContentType'\n | 'didCreateRelease'\n | 'didStartNewChat'\n | 'didLaunchGuidedtour'\n | 'didEditAICaption'\n | 'didEditAIAlternativeText'\n | 'didGenerateMetadataRetroactively'\n | 'didActOnFolders';\n\n properties?: never;\n}\n\ninterface DidAccessAuthenticatedAdministrationEvent {\n name: 'didAccessAuthenticatedAdministration';\n properties: {\n registeredWidgets: string[];\n projectId: string;\n };\n}\n\ninterface DidFilterMediaLibraryElementsEvent {\n name: 'didFilterMediaLibraryElements';\n properties: MediaEvents['properties'] & {\n filter: string;\n };\n}\n\ninterface DidSortMediaLibraryElementsEvent {\n name: 'didSortMediaLibraryElements';\n properties: MediaEvents['properties'] & {\n sort: string;\n };\n}\n\ninterface DidCropFileEvent {\n name: 'didCropFile';\n properties: MediaEvents['properties'] & {\n duplicatedFile: null | boolean;\n };\n}\n\ninterface DidSelectFile {\n name: 'didSelectFile';\n properties: MediaEvents['properties'] & {\n source: 'url' | 'computer';\n };\n}\n\ninterface DidEditMediaLibraryElementsEvent {\n name: 'didEditMediaLibraryElements';\n properties: MediaEvents['properties'] & {\n type: string;\n changeLocation: string | boolean;\n };\n}\n\ninterface MediaEvents {\n name:\n | 'didSearchMediaLibraryElements'\n | 'didReplaceMedia'\n | 'didAddMediaLibraryFolders'\n | 'willAddMediaLibraryAssets';\n properties: {\n location: string;\n };\n}\n\ninterface DidSelectContentTypeFieldTypeEvent {\n name: 'didSelectContentTypeFieldType';\n properties: {\n type?: string;\n };\n}\n\ninterface DidChangeModeEvent {\n name: 'didChangeMode';\n properties: {\n newMode: string;\n };\n}\ninterface DidSubmitWithErrorsFirstAdminEvent {\n name: 'didSubmitWithErrorsFirstAdmin';\n properties: {\n count: string;\n };\n}\n\ninterface WillNavigateEvent {\n name: 'willNavigate';\n properties: {\n from: string;\n to: string;\n };\n}\n\ninterface DidClickOnDocLink {\n name: 'didClickOnDocLink';\n properties: {\n from: string;\n to: string;\n };\n}\n\ninterface DidAccessTokenListEvent {\n name: 'didAccessTokenList';\n properties: {\n tokenType: TokenEvents['properties']['tokenType'];\n number: number;\n };\n}\ninterface LogoEvent {\n name: 'didChangeLogo' | 'didClickResetLogo';\n properties: {\n logo: 'menu' | 'auth';\n };\n}\n\ninterface TokenEvents {\n name:\n | 'didCopyTokenKey'\n | 'didAddTokenFromList'\n | 'didEditTokenFromList'\n | 'willAccessTokenList'\n | 'willAddTokenFromList'\n | 'willCreateToken'\n | 'willDeleteToken'\n | 'willEditToken'\n | 'willEditTokenFromList';\n properties: {\n tokenType: 'api-token' | 'transfer-token';\n };\n}\n\ninterface WillModifyTokenEvent {\n name: 'didCreateToken' | 'didEditToken';\n properties: {\n tokenType: TokenEvents['properties']['tokenType'];\n kind?: 'admin' | 'content-api';\n type?: 'custom' | 'full-access' | 'read-only' | Array<'push' | 'pull' | 'push-pull'>;\n };\n}\n\ninterface DeleteEntryEvents {\n name: 'willDeleteEntry' | 'didDeleteEntry' | 'didNotDeleteEntry';\n properties: {\n status?: string;\n error?: unknown;\n };\n}\n\ninterface CreateEntryEvents {\n name: 'willCreateEntry' | 'didCreateEntry' | 'didNotCreateEntry';\n properties: {\n documentId?: string;\n status?: string;\n error?: unknown;\n fromPreview?: boolean;\n fromRelationModal?: boolean;\n };\n}\n\ninterface PublishEntryEvents {\n name: 'willPublishEntry' | 'didPublishEntry';\n properties: {\n documentId?: string;\n fromPreview?: boolean;\n fromRelationModal?: boolean;\n };\n}\n\ninterface UpdateEntryEvents {\n name: 'willEditEntry' | 'didEditEntry' | 'didNotEditEntry';\n properties: {\n documentId?: string;\n status?: string;\n error?: unknown;\n fromPreview?: boolean;\n fromRelationModal?: boolean;\n };\n}\n\ninterface DidFilterEntriesEvent {\n name: 'didFilterEntries';\n properties: {\n useRelation: boolean;\n };\n}\n\ninterface DidPublishRelease {\n name: 'didPublishRelease';\n properties: {\n totalEntries: number;\n totalPublishedEntries: number;\n totalUnpublishedEntries: number;\n };\n}\n\ninterface DidUsePresetPromptEvent {\n name: 'didUsePresetPrompt';\n properties: {\n promptType:\n | 'generate-product-schema'\n | 'tell-me-about-the-content-type-builder'\n | 'tell-me-about-strapi';\n };\n}\n\ninterface DidAnswerMessageEvent {\n name: 'didAnswerMessage';\n properties: {\n successful: boolean;\n };\n}\n\ninterface DidVoteAnswerEvent {\n name: 'didVoteAnswer';\n properties: {\n value: 'positive' | 'negative';\n };\n}\n\ninterface DidUpdateCTBSchema {\n name: 'didUpdateCTBSchema';\n properties: {\n success: boolean;\n newContentTypes: number;\n editedContentTypes: number;\n deletedContentTypes: number;\n newComponents: number;\n editedComponents: number;\n deletedComponents: number;\n newFields: number;\n editedFields: number;\n deletedFields: number;\n };\n}\n\ninterface DidSkipGuidedTour {\n name: 'didSkipGuidedTour';\n properties: {\n name: keyof Tours | 'all';\n };\n}\n\ninterface DidCompleteGuidedTour {\n name: 'didCompleteGuidedTour';\n properties: {\n name: keyof Tours | 'all';\n };\n}\n\ninterface DidStartGuidedTour {\n name: 'didStartGuidedTour';\n properties: {\n name: keyof Tours;\n fromHomepage?: boolean;\n };\n}\n\ninterface WillEditEntryFromHome {\n name: 'willEditEntryFromHome';\n properties: {\n entryType: 'edited' | 'published' | 'assigned';\n };\n}\n\ninterface DidOpenHomeWidgetLink {\n name: 'didOpenHomeWidgetLink';\n properties: {\n widgetUID: string;\n };\n}\n\ninterface DidOpenKeyStatisticsWidgetLink {\n name: 'didOpenKeyStatisticsWidgetLink';\n properties: {\n itemKey: string;\n };\n}\n\ntype EventsWithProperties =\n | CreateEntryEvents\n | PublishEntryEvents\n | DidAccessAuthenticatedAdministrationEvent\n | DidAccessTokenListEvent\n | DidChangeModeEvent\n | DidCropFileEvent\n | DeleteEntryEvents\n | DidEditMediaLibraryElementsEvent\n | DidFilterMediaLibraryElementsEvent\n | DidFilterEntriesEvent\n | DidSelectContentTypeFieldTypeEvent\n | DidSelectFile\n | DidSortMediaLibraryElementsEvent\n | DidSubmitWithErrorsFirstAdminEvent\n | DidUsePresetPromptEvent\n | DidAnswerMessageEvent\n | DidVoteAnswerEvent\n | LogoEvent\n | TokenEvents\n | UpdateEntryEvents\n | WillModifyTokenEvent\n | WillNavigateEvent\n | DidClickOnDocLink\n | DidPublishRelease\n | MediaEvents\n | DidUpdateCTBSchema\n | DidSkipGuidedTour\n | DidCompleteGuidedTour\n | DidStartGuidedTour\n | DidOpenHomeWidgetLink\n | DidOpenKeyStatisticsWidgetLink\n | WillEditEntryFromHome;\n\nexport type TrackingEvent = EventWithoutProperties | EventsWithProperties;\nexport interface UseTrackingReturn {\n /**\n * This type helps show all the available event names before you start typing,\n * however autocomplete isn't great.\n */\n trackUsage<TEvent extends TrackingEvent>(\n event: TEvent['name'],\n properties: TEvent['properties']\n ): Promise<null | AxiosResponse<string>>;\n trackUsage<TEvent extends Extract<TrackingEvent, { properties?: never }>>(\n event: TEvent['name'],\n properties?: never\n ): Promise<null | AxiosResponse<string>>;\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n trackUsage<TEvent extends Extract<TrackingEvent, { properties: object }>>(\n event: TEvent['name'],\n properties: TEvent['properties']\n ): Promise<null | AxiosResponse<string>>;\n}\n\n/**\n * @description Used to send amplitude events to the Strapi Tracking hub.\n *\n * @example\n * ```tsx\n * import { useTracking } from '@strapi/strapi/admin';\n *\n * const MyComponent = () => {\n * const { trackUsage } = useTracking();\n *\n * const handleClick = () => {\n * trackUsage('my-event', { myProperty: 'myValue' });\n * }\n *\n * return <button onClick={handleClick}>Send Event</button>\n * }\n * ```\n */\nconst useTracking = (): UseTrackingReturn => {\n const deviceType = useDeviceType();\n const deviceTypeRef = React.useRef(deviceType);\n deviceTypeRef.current = deviceType;\n const { uuid, telemetryProperties } = React.useContext(TrackingContext);\n const userId = useAppInfo('useTracking', (state) => state.userId);\n const trackUsage = React.useCallback(\n async <TEvent extends TrackingEvent>(\n event: TEvent['name'],\n properties?: TEvent['properties']\n ) => {\n try {\n if (uuid && !window.strapi.telemetryDisabled) {\n const res = await axios.post<string>(\n `${process.env.STRAPI_ANALYTICS_URL || 'https://analytics.strapi.io'}/api/v2/track`,\n {\n event,\n userId,\n eventProperties: { ...properties },\n userProperties: {\n deviceType: deviceTypeRef.current,\n },\n groupProperties: {\n ...telemetryProperties,\n projectId: uuid,\n projectType: window.strapi.projectType,\n },\n },\n {\n headers: {\n 'Content-Type': 'application/json',\n 'X-Strapi-Event': event,\n },\n }\n );\n\n return res;\n }\n } catch {\n // Silence is golden\n }\n\n return null;\n },\n [telemetryProperties, userId, uuid]\n );\n\n return { trackUsage };\n};\n\nexport { TrackingProvider, useTracking };\n"],"names":["TrackingContext","React","createContext","uuid","TrackingProvider","children","token","useAuth","state","data","initData","useInitQuery","getAllWidgets","useStrapiApp","widgets","getAll","useTelemetryPropertiesQuery","undefined","skip","useEffect","event","fetch","process","env","STRAPI_ANALYTICS_URL","method","body","JSON","stringify","userId","eventPropeties","groupProperties","projectId","registeredWidgets","map","widget","uid","headers","value","useMemo","telemetryProperties","_jsx","Provider","useTracking","deviceType","useDeviceType","deviceTypeRef","useRef","current","useContext","useAppInfo","trackUsage","useCallback","properties","window","strapi","telemetryDisabled","res","axios","post","eventProperties","userProperties","projectType"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA;;AAEkG,qGAElG,MAAMA,eAAAA,iBAAkBC,gBAAAA,CAAMC,aAAa,CAAuB;IAChEC,IAAAA,EAAM;AACR,CAAA,CAAA;AAUA,MAAMC,gBAAAA,GAAmB,CAAC,EAAEC,QAAQ,EAAyB,GAAA;AAC3D,IAAA,MAAMC,QAAQC,YAAAA,CAAQ,KAAA,EAAO,CAACC,KAAAA,GAAUA,MAAMF,KAAK,CAAA;AACnD,IAAA,MAAM,EAAEG,IAAAA,EAAMC,QAAQ,EAAE,GAAGC,kBAAAA,EAAAA;AAC3B,IAAA,MAAM,EAAER,IAAI,EAAE,GAAGO,YAAY,EAAC;IAC9B,MAAME,aAAAA,GAAgBC,uBAAa,kBAAA,EAAoB,CAACL,QAAUA,KAAAA,CAAMM,OAAO,CAACC,MAAM,CAAA;AAEtF,IAAA,MAAM,EAAEN,IAAI,EAAE,GAAGO,kCAA4BC,SAAAA,EAAW;QACtDC,IAAAA,EAAM,CAACR,QAAAA,EAAUP,IAAAA,IAAQ,CAACG;AAC5B,KAAA,CAAA;AACAL,IAAAA,gBAAAA,CAAMkB,SAAS,CAAC,IAAA;AACd,QAAA,IAAIhB,QAAQM,IAAAA,EAAM;AAChB,YAAA,MAAMW,KAAAA,GAAQ,6BAAA;YACd,IAAI;gBACFC,KAAAA,CAAM,CAAA,EAAGC,QAAQC,GAAG,CAACC,oBAAoB,IAAI,6BAAA,CAA8B,aAAa,CAAC,EAAE;oBACzFC,MAAAA,EAAQ,MAAA;oBACRC,IAAAA,EAAMC,IAAAA,CAAKC,SAAS,CAAC;;AAEnBR,wBAAAA,KAAAA;wBACAS,MAAAA,EAAQ,EAAA;AACRC,wBAAAA,cAAAA,EAAgB,EAAC;wBACjBC,eAAAA,EAAiB;AACf,4BAAA,GAAGtB,IAAI;4BACPuB,SAAAA,EAAW7B,IAAAA;AACX8B,4BAAAA,iBAAAA,EAAmBrB,gBAAgBsB,GAAG,CAAC,CAACC,MAAAA,GAAWA,OAAOC,GAAG;AAC/D;AACF,qBAAA,CAAA;oBACAC,OAAAA,EAAS;wBACP,cAAA,EAAgB,kBAAA;wBAChB,gBAAA,EAAkBjB;AACpB;AACF,iBAAA,CAAA;AACF,YAAA,CAAA,CAAE,OAAM;;AAER,YAAA;AACF,QAAA;IACF,CAAA,EAAG;AAACX,QAAAA,IAAAA;AAAMN,QAAAA,IAAAA;AAAMS,QAAAA;AAAc,KAAA,CAAA;AAC9B,IAAA,MAAM0B,KAAAA,GAAQrC,gBAAAA,CAAMsC,OAAO,CACzB,KAAO;AACLpC,YAAAA,IAAAA;YACAqC,mBAAAA,EAAqB/B;AACvB,SAAA,CAAA,EACA;AAACN,QAAAA,IAAAA;AAAMM,QAAAA;AAAK,KAAA,CAAA;IAGd,qBAAOgC,cAAA,CAACzC,gBAAgB0C,QAAQ,EAAA;QAACJ,KAAAA,EAAOA,KAAAA;AAAQjC,QAAAA,QAAAA,EAAAA;;AAClD;AAwbA;;;;;;;;;;;;;;;;;AAiBC,UACKsC,WAAAA,GAAc,IAAA;AAClB,IAAA,MAAMC,UAAAA,GAAaC,2BAAAA,EAAAA;IACnB,MAAMC,aAAAA,GAAgB7C,gBAAAA,CAAM8C,MAAM,CAACH,UAAAA,CAAAA;AACnCE,IAAAA,aAAAA,CAAcE,OAAO,GAAGJ,UAAAA;IACxB,MAAM,EAAEzC,IAAI,EAAEqC,mBAAmB,EAAE,GAAGvC,gBAAAA,CAAMgD,UAAU,CAACjD,eAAAA,CAAAA;AACvD,IAAA,MAAM6B,SAASqB,kBAAAA,CAAW,aAAA,EAAe,CAAC1C,KAAAA,GAAUA,MAAMqB,MAAM,CAAA;AAChE,IAAA,MAAMsB,UAAAA,GAAalD,gBAAAA,CAAMmD,WAAW,CAClC,OACEhC,KAAAA,EACAiC,UAAAA,GAAAA;QAEA,IAAI;AACF,YAAA,IAAIlD,QAAQ,CAACmD,MAAAA,CAAOC,MAAM,CAACC,iBAAiB,EAAE;AAC5C,gBAAA,MAAMC,GAAAA,GAAM,MAAMC,sBAAAA,CAAMC,IAAI,CAC1B,CAAA,EAAGrC,OAAAA,CAAQC,GAAG,CAACC,oBAAoB,IAAI,6BAAA,CAA8B,aAAa,CAAC,EACnF;AACEJ,oBAAAA,KAAAA;AACAS,oBAAAA,MAAAA;oBACA+B,eAAAA,EAAiB;AAAE,wBAAA,GAAGP;AAAW,qBAAA;oBACjCQ,cAAAA,EAAgB;AACdjB,wBAAAA,UAAAA,EAAYE,cAAcE;AAC5B,qBAAA;oBACAjB,eAAAA,EAAiB;AACf,wBAAA,GAAGS,mBAAmB;wBACtBR,SAAAA,EAAW7B,IAAAA;wBACX2D,WAAAA,EAAaR,MAAAA,CAAOC,MAAM,CAACO;AAC7B;iBACF,EACA;oBACEzB,OAAAA,EAAS;wBACP,cAAA,EAAgB,kBAAA;wBAChB,gBAAA,EAAkBjB;AACpB;AACF,iBAAA,CAAA;gBAGF,OAAOqC,GAAAA;AACT,YAAA;AACF,QAAA,CAAA,CAAE,OAAM;;AAER,QAAA;QAEA,OAAO,IAAA;IACT,CAAA,EACA;AAACjB,QAAAA,mBAAAA;AAAqBX,QAAAA,MAAAA;AAAQ1B,QAAAA;AAAK,KAAA,CAAA;IAGrC,OAAO;AAAEgD,QAAAA;AAAW,KAAA;AACtB;;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Tracking.mjs","sources":["../../../../../admin/src/features/Tracking.tsx"],"sourcesContent":["import * as React from 'react';\n\nimport axios, { AxiosResponse } from 'axios';\n\nimport { Tours } from '../components/GuidedTour/Tours';\nimport { useDeviceType } from '../hooks/useDeviceType';\nimport { useInitQuery, useTelemetryPropertiesQuery } from '../services/admin';\n\nimport { useAppInfo } from './AppInfo';\nimport { useAuth } from './Auth';\nimport { useStrapiApp } from './StrapiApp';\n\nexport interface TelemetryProperties {\n useTypescriptOnServer?: boolean;\n useTypescriptOnAdmin?: boolean;\n isHostedOnStrapiCloud?: boolean;\n numberOfAllContentTypes?: number;\n numberOfComponents?: number;\n numberOfDynamicZones?: number;\n}\n\nexport interface TrackingContextValue {\n uuid?: string | boolean;\n telemetryProperties?: TelemetryProperties;\n}\n\n/* -------------------------------------------------------------------------------------------------\n * Context\n * -----------------------------------------------------------------------------------------------*/\n\nconst TrackingContext = React.createContext<TrackingContextValue>({\n uuid: false,\n});\n\n/* -------------------------------------------------------------------------------------------------\n * Provider\n * -----------------------------------------------------------------------------------------------*/\n\nexport interface TrackingProviderProps {\n children: React.ReactNode;\n}\n\nconst TrackingProvider = ({ children }: TrackingProviderProps) => {\n const token = useAuth('App', (state) => state.token);\n const { data: initData } = useInitQuery();\n const { uuid } = initData ?? {};\n const getAllWidgets = useStrapiApp('TrackingProvider', (state) => state.widgets.getAll);\n\n const { data } = useTelemetryPropertiesQuery(undefined, {\n skip: !initData?.uuid || !token,\n });\n React.useEffect(() => {\n if (uuid && data) {\n const event = 'didInitializeAdministration';\n try {\n fetch(`${process.env.STRAPI_ANALYTICS_URL || 'https://analytics.strapi.io'}/api/v2/track`, {\n method: 'POST',\n body: JSON.stringify({\n // This event is anonymous\n event,\n userId: '',\n eventPropeties: {},\n groupProperties: {\n ...data,\n projectId: uuid,\n registeredWidgets: getAllWidgets().map((widget) => widget.uid),\n },\n }),\n headers: {\n 'Content-Type': 'application/json',\n 'X-Strapi-Event': event,\n },\n });\n } catch {\n // silence is golden\n }\n }\n }, [data, uuid, getAllWidgets]);\n const value = React.useMemo(\n () => ({\n uuid,\n telemetryProperties: data,\n }),\n [uuid, data]\n );\n\n return <TrackingContext.Provider value={value}>{children}</TrackingContext.Provider>;\n};\n\n/* -------------------------------------------------------------------------------------------------\n * Hook\n * -----------------------------------------------------------------------------------------------*/\n\n/**\n * We can group these events together because none have properties so there's no benefit\n * to having them as separate types.\n *\n * Meanwhile those with properties have different property shapes corresponding to the specific\n * event so understanding which properties go with which event is very helpful.\n */\nexport interface EventWithoutProperties {\n name:\n | 'changeComponentsOrder'\n | 'didAddComponentToDynamicZone'\n | 'didBulkDeleteEntries'\n | 'didNotBulkDeleteEntries'\n | 'didChangeDisplayedFields'\n | 'didCheckDraftRelations'\n | 'didClickGuidedTourHomepageApiTokens'\n | 'didClickGuidedTourHomepageContentManager'\n | 'didClickGuidedTourHomepageContentTypeBuilder'\n | 'didClickGuidedTourStep1CollectionType'\n | 'didClickGuidedTourStep2ContentManager'\n | 'didClickGuidedTourStep3ApiTokens'\n | 'didClickonBlogSection'\n | 'didClickonCodeExampleSection'\n | 'didClickonReadTheDocumentationSection'\n | 'didClickOnTryStrapiCloudSection'\n | 'didClickonTutorialSection'\n | 'didCreateGuidedTourCollectionType'\n | 'didCreateGuidedTourEntry'\n | 'didCreateNewRole'\n | 'didCreateRole'\n | 'didDeleteToken'\n | 'didDuplicateRole'\n | 'didEditEditSettings'\n | 'didEditEmailTemplates'\n | 'didEditFieldNameOnContentType'\n | 'didEditListSettings'\n | 'didEditMediaLibraryConfig'\n | 'didEditNameOfContentType'\n | 'didGenerateGuidedTourApiTokens'\n | 'didLaunchGuidedtour'\n | 'didNotCreateFirstAdmin'\n | 'didNotSaveComponent'\n | 'didPluginLearnMore'\n | 'didBulkPublishEntries'\n | 'didNotBulkPublishEntries'\n | 'didUnpublishEntry'\n | 'didBulkUnpublishEntries'\n | 'didNotBulkUnpublishEntries'\n | 'didSaveComponent'\n | 'didSaveContentType'\n | 'didSearch'\n | 'didSkipGuidedtour'\n | 'didSubmitPlugin'\n | 'didSubmitProvider'\n | 'didUpdateConditions'\n | 'didSelectAllMediaLibraryElements'\n | 'didSelectContentTypeFieldSettings'\n | 'didSelectContentTypeSettings'\n | 'didEditAuthenticationProvider'\n | 'didRestoreHistoryVersion'\n | 'hasClickedCTBAddFieldBanner'\n | 'removeComponentFromDynamicZone'\n | 'willAddMoreFieldToContentType'\n | 'willBulkDeleteEntries'\n | 'willBulkPublishEntries'\n | 'willBulkUnpublishEntries'\n | 'willChangeNumberOfEntriesPerPage'\n | 'willCheckDraftRelations'\n | 'willCreateComponent'\n | 'willCreateComponentFromAttributesModal'\n | 'willCreateContentType'\n | 'willCreateFirstAdmin'\n | 'willCreateNewRole'\n | 'willCreateRole'\n | 'willCreateSingleType'\n | 'willCreateStage'\n | 'willCreateWorkflow'\n | 'willDeleteEntryFromList'\n | 'willDeleteFieldOfContentType'\n | 'willDuplicateRole'\n | 'willEditEditLayout'\n | 'willEditEmailTemplates'\n | 'willEditEntryFromButton'\n | 'willEditEntryFromList'\n | 'willEditReleaseFromHome'\n | 'willEditFieldOfContentType'\n | 'willEditMediaLibraryConfig'\n | 'willEditNameOfContentType'\n | 'willEditNameOfSingleType'\n | 'willEditAuthenticationProvider'\n | 'willEditFieldNameOnContentType'\n | 'willEditStage'\n | 'willFilterEntries'\n | 'willInstallPlugin'\n | 'willOpenAuditLogDetailsFromHome'\n | 'willUnpublishEntry'\n | 'willSaveComponent'\n | 'willSaveContentType'\n | 'willSaveContentTypeLayout'\n | 'didEditFieldNameOnContentType'\n | 'didCreateRelease'\n | 'didStartNewChat'\n | 'didLaunchGuidedtour'\n | 'didEditAICaption'\n | 'didEditAIAlternativeText'\n | 'didGenerateMetadataRetroactively';\n\n properties?: never;\n}\n\ninterface DidAccessAuthenticatedAdministrationEvent {\n name: 'didAccessAuthenticatedAdministration';\n properties: {\n registeredWidgets: string[];\n projectId: string;\n };\n}\n\ninterface DidFilterMediaLibraryElementsEvent {\n name: 'didFilterMediaLibraryElements';\n properties: MediaEvents['properties'] & {\n filter: string;\n };\n}\n\ninterface DidSortMediaLibraryElementsEvent {\n name: 'didSortMediaLibraryElements';\n properties: MediaEvents['properties'] & {\n sort: string;\n };\n}\n\ninterface DidCropFileEvent {\n name: 'didCropFile';\n properties: MediaEvents['properties'] & {\n duplicatedFile: null | boolean;\n };\n}\n\ninterface DidSelectFile {\n name: 'didSelectFile';\n properties: MediaEvents['properties'] & {\n source: 'url' | 'computer';\n };\n}\n\ninterface DidEditMediaLibraryElementsEvent {\n name: 'didEditMediaLibraryElements';\n properties: MediaEvents['properties'] & {\n type: string;\n changeLocation: string | boolean;\n };\n}\n\ninterface MediaEvents {\n name:\n | 'didSearchMediaLibraryElements'\n | 'didReplaceMedia'\n | 'didAddMediaLibraryFolders'\n | 'willAddMediaLibraryAssets';\n properties: {\n location: string;\n };\n}\n\ninterface DidSelectContentTypeFieldTypeEvent {\n name: 'didSelectContentTypeFieldType';\n properties: {\n type?: string;\n };\n}\n\ninterface DidChangeModeEvent {\n name: 'didChangeMode';\n properties: {\n newMode: string;\n };\n}\ninterface DidSubmitWithErrorsFirstAdminEvent {\n name: 'didSubmitWithErrorsFirstAdmin';\n properties: {\n count: string;\n };\n}\n\ninterface WillNavigateEvent {\n name: 'willNavigate';\n properties: {\n from: string;\n to: string;\n };\n}\n\ninterface DidClickOnDocLink {\n name: 'didClickOnDocLink';\n properties: {\n from: string;\n to: string;\n };\n}\n\ninterface DidAccessTokenListEvent {\n name: 'didAccessTokenList';\n properties: {\n tokenType: TokenEvents['properties']['tokenType'];\n number: number;\n };\n}\ninterface LogoEvent {\n name: 'didChangeLogo' | 'didClickResetLogo';\n properties: {\n logo: 'menu' | 'auth';\n };\n}\n\ninterface TokenEvents {\n name:\n | 'didCopyTokenKey'\n | 'didAddTokenFromList'\n | 'didEditTokenFromList'\n | 'willAccessTokenList'\n | 'willAddTokenFromList'\n | 'willCreateToken'\n | 'willDeleteToken'\n | 'willEditToken'\n | 'willEditTokenFromList';\n properties: {\n tokenType: 'api-token' | 'transfer-token';\n };\n}\n\ninterface WillModifyTokenEvent {\n name: 'didCreateToken' | 'didEditToken';\n properties: {\n tokenType: TokenEvents['properties']['tokenType'];\n kind?: 'admin' | 'content-api';\n type?: 'custom' | 'full-access' | 'read-only' | Array<'push' | 'pull' | 'push-pull'>;\n };\n}\n\ninterface DeleteEntryEvents {\n name: 'willDeleteEntry' | 'didDeleteEntry' | 'didNotDeleteEntry';\n properties: {\n status?: string;\n error?: unknown;\n };\n}\n\ninterface CreateEntryEvents {\n name: 'willCreateEntry' | 'didCreateEntry' | 'didNotCreateEntry';\n properties: {\n documentId?: string;\n status?: string;\n error?: unknown;\n fromPreview?: boolean;\n fromRelationModal?: boolean;\n };\n}\n\ninterface PublishEntryEvents {\n name: 'willPublishEntry' | 'didPublishEntry';\n properties: {\n documentId?: string;\n fromPreview?: boolean;\n fromRelationModal?: boolean;\n };\n}\n\ninterface UpdateEntryEvents {\n name: 'willEditEntry' | 'didEditEntry' | 'didNotEditEntry';\n properties: {\n documentId?: string;\n status?: string;\n error?: unknown;\n fromPreview?: boolean;\n fromRelationModal?: boolean;\n };\n}\n\ninterface DidFilterEntriesEvent {\n name: 'didFilterEntries';\n properties: {\n useRelation: boolean;\n };\n}\n\ninterface DidPublishRelease {\n name: 'didPublishRelease';\n properties: {\n totalEntries: number;\n totalPublishedEntries: number;\n totalUnpublishedEntries: number;\n };\n}\n\ninterface DidUsePresetPromptEvent {\n name: 'didUsePresetPrompt';\n properties: {\n promptType:\n | 'generate-product-schema'\n | 'tell-me-about-the-content-type-builder'\n | 'tell-me-about-strapi';\n };\n}\n\ninterface DidAnswerMessageEvent {\n name: 'didAnswerMessage';\n properties: {\n successful: boolean;\n };\n}\n\ninterface DidVoteAnswerEvent {\n name: 'didVoteAnswer';\n properties: {\n value: 'positive' | 'negative';\n };\n}\n\ninterface DidUpdateCTBSchema {\n name: 'didUpdateCTBSchema';\n properties: {\n success: boolean;\n newContentTypes: number;\n editedContentTypes: number;\n deletedContentTypes: number;\n newComponents: number;\n editedComponents: number;\n deletedComponents: number;\n newFields: number;\n editedFields: number;\n deletedFields: number;\n };\n}\n\ninterface DidSkipGuidedTour {\n name: 'didSkipGuidedTour';\n properties: {\n name: keyof Tours | 'all';\n };\n}\n\ninterface DidCompleteGuidedTour {\n name: 'didCompleteGuidedTour';\n properties: {\n name: keyof Tours | 'all';\n };\n}\n\ninterface DidStartGuidedTour {\n name: 'didStartGuidedTour';\n properties: {\n name: keyof Tours;\n fromHomepage?: boolean;\n };\n}\n\ninterface WillEditEntryFromHome {\n name: 'willEditEntryFromHome';\n properties: {\n entryType: 'edited' | 'published' | 'assigned';\n };\n}\n\ninterface DidOpenHomeWidgetLink {\n name: 'didOpenHomeWidgetLink';\n properties: {\n widgetUID: string;\n };\n}\n\ninterface DidOpenKeyStatisticsWidgetLink {\n name: 'didOpenKeyStatisticsWidgetLink';\n properties: {\n itemKey: string;\n };\n}\n\ntype EventsWithProperties =\n | CreateEntryEvents\n | PublishEntryEvents\n | DidAccessAuthenticatedAdministrationEvent\n | DidAccessTokenListEvent\n | DidChangeModeEvent\n | DidCropFileEvent\n | DeleteEntryEvents\n | DidEditMediaLibraryElementsEvent\n | DidFilterMediaLibraryElementsEvent\n | DidFilterEntriesEvent\n | DidSelectContentTypeFieldTypeEvent\n | DidSelectFile\n | DidSortMediaLibraryElementsEvent\n | DidSubmitWithErrorsFirstAdminEvent\n | DidUsePresetPromptEvent\n | DidAnswerMessageEvent\n | DidVoteAnswerEvent\n | LogoEvent\n | TokenEvents\n | UpdateEntryEvents\n | WillModifyTokenEvent\n | WillNavigateEvent\n | DidClickOnDocLink\n | DidPublishRelease\n | MediaEvents\n | DidUpdateCTBSchema\n | DidSkipGuidedTour\n | DidCompleteGuidedTour\n | DidStartGuidedTour\n | DidOpenHomeWidgetLink\n | DidOpenKeyStatisticsWidgetLink\n | WillEditEntryFromHome;\n\nexport type TrackingEvent = EventWithoutProperties | EventsWithProperties;\nexport interface UseTrackingReturn {\n /**\n * This type helps show all the available event names before you start typing,\n * however autocomplete isn't great.\n */\n trackUsage<TEvent extends TrackingEvent>(\n event: TEvent['name'],\n properties: TEvent['properties']\n ): Promise<null | AxiosResponse<string>>;\n trackUsage<TEvent extends Extract<TrackingEvent, { properties?: never }>>(\n event: TEvent['name'],\n properties?: never\n ): Promise<null | AxiosResponse<string>>;\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n trackUsage<TEvent extends Extract<TrackingEvent, { properties: object }>>(\n event: TEvent['name'],\n properties: TEvent['properties']\n ): Promise<null | AxiosResponse<string>>;\n}\n\n/**\n * @description Used to send amplitude events to the Strapi Tracking hub.\n *\n * @example\n * ```tsx\n * import { useTracking } from '@strapi/strapi/admin';\n *\n * const MyComponent = () => {\n * const { trackUsage } = useTracking();\n *\n * const handleClick = () => {\n * trackUsage('my-event', { myProperty: 'myValue' });\n * }\n *\n * return <button onClick={handleClick}>Send Event</button>\n * }\n * ```\n */\nconst useTracking = (): UseTrackingReturn => {\n const deviceType = useDeviceType();\n const deviceTypeRef = React.useRef(deviceType);\n deviceTypeRef.current = deviceType;\n const { uuid, telemetryProperties } = React.useContext(TrackingContext);\n const userId = useAppInfo('useTracking', (state) => state.userId);\n const trackUsage = React.useCallback(\n async <TEvent extends TrackingEvent>(\n event: TEvent['name'],\n properties?: TEvent['properties']\n ) => {\n try {\n if (uuid && !window.strapi.telemetryDisabled) {\n const res = await axios.post<string>(\n `${process.env.STRAPI_ANALYTICS_URL || 'https://analytics.strapi.io'}/api/v2/track`,\n {\n event,\n userId,\n eventProperties: { ...properties },\n userProperties: {\n deviceType: deviceTypeRef.current,\n },\n groupProperties: {\n ...telemetryProperties,\n projectId: uuid,\n projectType: window.strapi.projectType,\n },\n },\n {\n headers: {\n 'Content-Type': 'application/json',\n 'X-Strapi-Event': event,\n },\n }\n );\n\n return res;\n }\n } catch {\n // Silence is golden\n }\n\n return null;\n },\n [telemetryProperties, userId, uuid]\n );\n\n return { trackUsage };\n};\n\nexport { TrackingProvider, useTracking };\n"],"names":["TrackingContext","React","createContext","uuid","TrackingProvider","children","token","useAuth","state","data","initData","useInitQuery","getAllWidgets","useStrapiApp","widgets","getAll","useTelemetryPropertiesQuery","undefined","skip","useEffect","event","fetch","process","env","STRAPI_ANALYTICS_URL","method","body","JSON","stringify","userId","eventPropeties","groupProperties","projectId","registeredWidgets","map","widget","uid","headers","value","useMemo","telemetryProperties","_jsx","Provider","useTracking","deviceType","useDeviceType","deviceTypeRef","useRef","current","useContext","useAppInfo","trackUsage","useCallback","properties","window","strapi","telemetryDisabled","res","axios","post","eventProperties","userProperties","projectType"],"mappings":";;;;;;;;;AA0BA;;AAEkG,qGAElG,MAAMA,eAAAA,iBAAkBC,KAAAA,CAAMC,aAAa,CAAuB;IAChEC,IAAAA,EAAM;AACR,CAAA,CAAA;AAUA,MAAMC,gBAAAA,GAAmB,CAAC,EAAEC,QAAQ,EAAyB,GAAA;AAC3D,IAAA,MAAMC,QAAQC,OAAAA,CAAQ,KAAA,EAAO,CAACC,KAAAA,GAAUA,MAAMF,KAAK,CAAA;AACnD,IAAA,MAAM,EAAEG,IAAAA,EAAMC,QAAQ,EAAE,GAAGC,YAAAA,EAAAA;AAC3B,IAAA,MAAM,EAAER,IAAI,EAAE,GAAGO,YAAY,EAAC;IAC9B,MAAME,aAAAA,GAAgBC,aAAa,kBAAA,EAAoB,CAACL,QAAUA,KAAAA,CAAMM,OAAO,CAACC,MAAM,CAAA;AAEtF,IAAA,MAAM,EAAEN,IAAI,EAAE,GAAGO,4BAA4BC,SAAAA,EAAW;QACtDC,IAAAA,EAAM,CAACR,QAAAA,EAAUP,IAAAA,IAAQ,CAACG;AAC5B,KAAA,CAAA;AACAL,IAAAA,KAAAA,CAAMkB,SAAS,CAAC,IAAA;AACd,QAAA,IAAIhB,QAAQM,IAAAA,EAAM;AAChB,YAAA,MAAMW,KAAAA,GAAQ,6BAAA;YACd,IAAI;gBACFC,KAAAA,CAAM,CAAA,EAAGC,QAAQC,GAAG,CAACC,oBAAoB,IAAI,6BAAA,CAA8B,aAAa,CAAC,EAAE;oBACzFC,MAAAA,EAAQ,MAAA;oBACRC,IAAAA,EAAMC,IAAAA,CAAKC,SAAS,CAAC;;AAEnBR,wBAAAA,KAAAA;wBACAS,MAAAA,EAAQ,EAAA;AACRC,wBAAAA,cAAAA,EAAgB,EAAC;wBACjBC,eAAAA,EAAiB;AACf,4BAAA,GAAGtB,IAAI;4BACPuB,SAAAA,EAAW7B,IAAAA;AACX8B,4BAAAA,iBAAAA,EAAmBrB,gBAAgBsB,GAAG,CAAC,CAACC,MAAAA,GAAWA,OAAOC,GAAG;AAC/D;AACF,qBAAA,CAAA;oBACAC,OAAAA,EAAS;wBACP,cAAA,EAAgB,kBAAA;wBAChB,gBAAA,EAAkBjB;AACpB;AACF,iBAAA,CAAA;AACF,YAAA,CAAA,CAAE,OAAM;;AAER,YAAA;AACF,QAAA;IACF,CAAA,EAAG;AAACX,QAAAA,IAAAA;AAAMN,QAAAA,IAAAA;AAAMS,QAAAA;AAAc,KAAA,CAAA;AAC9B,IAAA,MAAM0B,KAAAA,GAAQrC,KAAAA,CAAMsC,OAAO,CACzB,KAAO;AACLpC,YAAAA,IAAAA;YACAqC,mBAAAA,EAAqB/B;AACvB,SAAA,CAAA,EACA;AAACN,QAAAA,IAAAA;AAAMM,QAAAA;AAAK,KAAA,CAAA;IAGd,qBAAOgC,GAAA,CAACzC,gBAAgB0C,QAAQ,EAAA;QAACJ,KAAAA,EAAOA,KAAAA;AAAQjC,QAAAA,QAAAA,EAAAA;;AAClD;AAubA;;;;;;;;;;;;;;;;;AAiBC,UACKsC,WAAAA,GAAc,IAAA;AAClB,IAAA,MAAMC,UAAAA,GAAaC,aAAAA,EAAAA;IACnB,MAAMC,aAAAA,GAAgB7C,KAAAA,CAAM8C,MAAM,CAACH,UAAAA,CAAAA;AACnCE,IAAAA,aAAAA,CAAcE,OAAO,GAAGJ,UAAAA;IACxB,MAAM,EAAEzC,IAAI,EAAEqC,mBAAmB,EAAE,GAAGvC,KAAAA,CAAMgD,UAAU,CAACjD,eAAAA,CAAAA;AACvD,IAAA,MAAM6B,SAASqB,UAAAA,CAAW,aAAA,EAAe,CAAC1C,KAAAA,GAAUA,MAAMqB,MAAM,CAAA;AAChE,IAAA,MAAMsB,UAAAA,GAAalD,KAAAA,CAAMmD,WAAW,CAClC,OACEhC,KAAAA,EACAiC,UAAAA,GAAAA;QAEA,IAAI;AACF,YAAA,IAAIlD,QAAQ,CAACmD,MAAAA,CAAOC,MAAM,CAACC,iBAAiB,EAAE;AAC5C,gBAAA,MAAMC,GAAAA,GAAM,MAAMC,KAAAA,CAAMC,IAAI,CAC1B,CAAA,EAAGrC,OAAAA,CAAQC,GAAG,CAACC,oBAAoB,IAAI,6BAAA,CAA8B,aAAa,CAAC,EACnF;AACEJ,oBAAAA,KAAAA;AACAS,oBAAAA,MAAAA;oBACA+B,eAAAA,EAAiB;AAAE,wBAAA,GAAGP;AAAW,qBAAA;oBACjCQ,cAAAA,EAAgB;AACdjB,wBAAAA,UAAAA,EAAYE,cAAcE;AAC5B,qBAAA;oBACAjB,eAAAA,EAAiB;AACf,wBAAA,GAAGS,mBAAmB;wBACtBR,SAAAA,EAAW7B,IAAAA;wBACX2D,WAAAA,EAAaR,MAAAA,CAAOC,MAAM,CAACO;AAC7B;iBACF,EACA;oBACEzB,OAAAA,EAAS;wBACP,cAAA,EAAgB,kBAAA;wBAChB,gBAAA,EAAkBjB;AACpB;AACF,iBAAA,CAAA;gBAGF,OAAOqC,GAAAA;AACT,YAAA;AACF,QAAA,CAAA,CAAE,OAAM;;AAER,QAAA;QAEA,OAAO,IAAA;IACT,CAAA,EACA;AAACjB,QAAAA,mBAAAA;AAAqBX,QAAAA,MAAAA;AAAQ1B,QAAAA;AAAK,KAAA,CAAA;IAGrC,OAAO;AAAEgD,QAAAA;AAAW,KAAA;AACtB;;;;"}
|
|
1
|
+
{"version":3,"file":"Tracking.mjs","sources":["../../../../../admin/src/features/Tracking.tsx"],"sourcesContent":["import * as React from 'react';\n\nimport axios, { AxiosResponse } from 'axios';\n\nimport { Tours } from '../components/GuidedTour/Tours';\nimport { useDeviceType } from '../hooks/useDeviceType';\nimport { useInitQuery, useTelemetryPropertiesQuery } from '../services/admin';\n\nimport { useAppInfo } from './AppInfo';\nimport { useAuth } from './Auth';\nimport { useStrapiApp } from './StrapiApp';\n\nexport interface TelemetryProperties {\n useTypescriptOnServer?: boolean;\n useTypescriptOnAdmin?: boolean;\n isHostedOnStrapiCloud?: boolean;\n numberOfAllContentTypes?: number;\n numberOfComponents?: number;\n numberOfDynamicZones?: number;\n numberOfContentTypeFolders?: number;\n}\n\nexport interface TrackingContextValue {\n uuid?: string | boolean;\n telemetryProperties?: TelemetryProperties;\n}\n\n/* -------------------------------------------------------------------------------------------------\n * Context\n * -----------------------------------------------------------------------------------------------*/\n\nconst TrackingContext = React.createContext<TrackingContextValue>({\n uuid: false,\n});\n\n/* -------------------------------------------------------------------------------------------------\n * Provider\n * -----------------------------------------------------------------------------------------------*/\n\nexport interface TrackingProviderProps {\n children: React.ReactNode;\n}\n\nconst TrackingProvider = ({ children }: TrackingProviderProps) => {\n const token = useAuth('App', (state) => state.token);\n const { data: initData } = useInitQuery();\n const { uuid } = initData ?? {};\n const getAllWidgets = useStrapiApp('TrackingProvider', (state) => state.widgets.getAll);\n\n const { data } = useTelemetryPropertiesQuery(undefined, {\n skip: !initData?.uuid || !token,\n });\n React.useEffect(() => {\n if (uuid && data) {\n const event = 'didInitializeAdministration';\n try {\n fetch(`${process.env.STRAPI_ANALYTICS_URL || 'https://analytics.strapi.io'}/api/v2/track`, {\n method: 'POST',\n body: JSON.stringify({\n // This event is anonymous\n event,\n userId: '',\n eventPropeties: {},\n groupProperties: {\n ...data,\n projectId: uuid,\n registeredWidgets: getAllWidgets().map((widget) => widget.uid),\n },\n }),\n headers: {\n 'Content-Type': 'application/json',\n 'X-Strapi-Event': event,\n },\n });\n } catch {\n // silence is golden\n }\n }\n }, [data, uuid, getAllWidgets]);\n const value = React.useMemo(\n () => ({\n uuid,\n telemetryProperties: data,\n }),\n [uuid, data]\n );\n\n return <TrackingContext.Provider value={value}>{children}</TrackingContext.Provider>;\n};\n\n/* -------------------------------------------------------------------------------------------------\n * Hook\n * -----------------------------------------------------------------------------------------------*/\n\n/**\n * We can group these events together because none have properties so there's no benefit\n * to having them as separate types.\n *\n * Meanwhile those with properties have different property shapes corresponding to the specific\n * event so understanding which properties go with which event is very helpful.\n */\nexport interface EventWithoutProperties {\n name:\n | 'changeComponentsOrder'\n | 'didAddComponentToDynamicZone'\n | 'didBulkDeleteEntries'\n | 'didNotBulkDeleteEntries'\n | 'didChangeDisplayedFields'\n | 'didCheckDraftRelations'\n | 'didClickGuidedTourHomepageApiTokens'\n | 'didClickGuidedTourHomepageContentManager'\n | 'didClickGuidedTourHomepageContentTypeBuilder'\n | 'didClickGuidedTourStep1CollectionType'\n | 'didClickGuidedTourStep2ContentManager'\n | 'didClickGuidedTourStep3ApiTokens'\n | 'didClickonBlogSection'\n | 'didClickonCodeExampleSection'\n | 'didClickonReadTheDocumentationSection'\n | 'didClickOnTryStrapiCloudSection'\n | 'didClickonTutorialSection'\n | 'didCreateGuidedTourCollectionType'\n | 'didCreateGuidedTourEntry'\n | 'didCreateNewRole'\n | 'didCreateRole'\n | 'didDeleteToken'\n | 'didDuplicateRole'\n | 'didEditEditSettings'\n | 'didEditEmailTemplates'\n | 'didEditFieldNameOnContentType'\n | 'didEditListSettings'\n | 'didEditMediaLibraryConfig'\n | 'didEditNameOfContentType'\n | 'didGenerateGuidedTourApiTokens'\n | 'didLaunchGuidedtour'\n | 'didNotCreateFirstAdmin'\n | 'didNotSaveComponent'\n | 'didPluginLearnMore'\n | 'didBulkPublishEntries'\n | 'didNotBulkPublishEntries'\n | 'didUnpublishEntry'\n | 'didBulkUnpublishEntries'\n | 'didNotBulkUnpublishEntries'\n | 'didSaveComponent'\n | 'didSaveContentType'\n | 'didSearch'\n | 'didSkipGuidedtour'\n | 'didSubmitPlugin'\n | 'didSubmitProvider'\n | 'didUpdateConditions'\n | 'didSelectAllMediaLibraryElements'\n | 'didSelectContentTypeFieldSettings'\n | 'didSelectContentTypeSettings'\n | 'didEditAuthenticationProvider'\n | 'didRestoreHistoryVersion'\n | 'hasClickedCTBAddFieldBanner'\n | 'removeComponentFromDynamicZone'\n | 'willAddMoreFieldToContentType'\n | 'willBulkDeleteEntries'\n | 'willBulkPublishEntries'\n | 'willBulkUnpublishEntries'\n | 'willChangeNumberOfEntriesPerPage'\n | 'willCheckDraftRelations'\n | 'willCreateComponent'\n | 'willCreateComponentFromAttributesModal'\n | 'willCreateContentType'\n | 'willCreateFirstAdmin'\n | 'willCreateNewRole'\n | 'willCreateRole'\n | 'willCreateSingleType'\n | 'willCreateStage'\n | 'willCreateWorkflow'\n | 'willDeleteEntryFromList'\n | 'willDeleteFieldOfContentType'\n | 'willDuplicateRole'\n | 'willEditEditLayout'\n | 'willEditEmailTemplates'\n | 'willEditEntryFromButton'\n | 'willEditEntryFromList'\n | 'willEditReleaseFromHome'\n | 'willEditFieldOfContentType'\n | 'willEditMediaLibraryConfig'\n | 'willEditNameOfContentType'\n | 'willEditNameOfSingleType'\n | 'willEditAuthenticationProvider'\n | 'willEditFieldNameOnContentType'\n | 'willEditStage'\n | 'willFilterEntries'\n | 'willInstallPlugin'\n | 'willOpenAuditLogDetailsFromHome'\n | 'willUnpublishEntry'\n | 'willSaveComponent'\n | 'willSaveContentType'\n | 'willSaveContentTypeLayout'\n | 'didEditFieldNameOnContentType'\n | 'didCreateRelease'\n | 'didStartNewChat'\n | 'didLaunchGuidedtour'\n | 'didEditAICaption'\n | 'didEditAIAlternativeText'\n | 'didGenerateMetadataRetroactively'\n | 'didActOnFolders';\n\n properties?: never;\n}\n\ninterface DidAccessAuthenticatedAdministrationEvent {\n name: 'didAccessAuthenticatedAdministration';\n properties: {\n registeredWidgets: string[];\n projectId: string;\n };\n}\n\ninterface DidFilterMediaLibraryElementsEvent {\n name: 'didFilterMediaLibraryElements';\n properties: MediaEvents['properties'] & {\n filter: string;\n };\n}\n\ninterface DidSortMediaLibraryElementsEvent {\n name: 'didSortMediaLibraryElements';\n properties: MediaEvents['properties'] & {\n sort: string;\n };\n}\n\ninterface DidCropFileEvent {\n name: 'didCropFile';\n properties: MediaEvents['properties'] & {\n duplicatedFile: null | boolean;\n };\n}\n\ninterface DidSelectFile {\n name: 'didSelectFile';\n properties: MediaEvents['properties'] & {\n source: 'url' | 'computer';\n };\n}\n\ninterface DidEditMediaLibraryElementsEvent {\n name: 'didEditMediaLibraryElements';\n properties: MediaEvents['properties'] & {\n type: string;\n changeLocation: string | boolean;\n };\n}\n\ninterface MediaEvents {\n name:\n | 'didSearchMediaLibraryElements'\n | 'didReplaceMedia'\n | 'didAddMediaLibraryFolders'\n | 'willAddMediaLibraryAssets';\n properties: {\n location: string;\n };\n}\n\ninterface DidSelectContentTypeFieldTypeEvent {\n name: 'didSelectContentTypeFieldType';\n properties: {\n type?: string;\n };\n}\n\ninterface DidChangeModeEvent {\n name: 'didChangeMode';\n properties: {\n newMode: string;\n };\n}\ninterface DidSubmitWithErrorsFirstAdminEvent {\n name: 'didSubmitWithErrorsFirstAdmin';\n properties: {\n count: string;\n };\n}\n\ninterface WillNavigateEvent {\n name: 'willNavigate';\n properties: {\n from: string;\n to: string;\n };\n}\n\ninterface DidClickOnDocLink {\n name: 'didClickOnDocLink';\n properties: {\n from: string;\n to: string;\n };\n}\n\ninterface DidAccessTokenListEvent {\n name: 'didAccessTokenList';\n properties: {\n tokenType: TokenEvents['properties']['tokenType'];\n number: number;\n };\n}\ninterface LogoEvent {\n name: 'didChangeLogo' | 'didClickResetLogo';\n properties: {\n logo: 'menu' | 'auth';\n };\n}\n\ninterface TokenEvents {\n name:\n | 'didCopyTokenKey'\n | 'didAddTokenFromList'\n | 'didEditTokenFromList'\n | 'willAccessTokenList'\n | 'willAddTokenFromList'\n | 'willCreateToken'\n | 'willDeleteToken'\n | 'willEditToken'\n | 'willEditTokenFromList';\n properties: {\n tokenType: 'api-token' | 'transfer-token';\n };\n}\n\ninterface WillModifyTokenEvent {\n name: 'didCreateToken' | 'didEditToken';\n properties: {\n tokenType: TokenEvents['properties']['tokenType'];\n kind?: 'admin' | 'content-api';\n type?: 'custom' | 'full-access' | 'read-only' | Array<'push' | 'pull' | 'push-pull'>;\n };\n}\n\ninterface DeleteEntryEvents {\n name: 'willDeleteEntry' | 'didDeleteEntry' | 'didNotDeleteEntry';\n properties: {\n status?: string;\n error?: unknown;\n };\n}\n\ninterface CreateEntryEvents {\n name: 'willCreateEntry' | 'didCreateEntry' | 'didNotCreateEntry';\n properties: {\n documentId?: string;\n status?: string;\n error?: unknown;\n fromPreview?: boolean;\n fromRelationModal?: boolean;\n };\n}\n\ninterface PublishEntryEvents {\n name: 'willPublishEntry' | 'didPublishEntry';\n properties: {\n documentId?: string;\n fromPreview?: boolean;\n fromRelationModal?: boolean;\n };\n}\n\ninterface UpdateEntryEvents {\n name: 'willEditEntry' | 'didEditEntry' | 'didNotEditEntry';\n properties: {\n documentId?: string;\n status?: string;\n error?: unknown;\n fromPreview?: boolean;\n fromRelationModal?: boolean;\n };\n}\n\ninterface DidFilterEntriesEvent {\n name: 'didFilterEntries';\n properties: {\n useRelation: boolean;\n };\n}\n\ninterface DidPublishRelease {\n name: 'didPublishRelease';\n properties: {\n totalEntries: number;\n totalPublishedEntries: number;\n totalUnpublishedEntries: number;\n };\n}\n\ninterface DidUsePresetPromptEvent {\n name: 'didUsePresetPrompt';\n properties: {\n promptType:\n | 'generate-product-schema'\n | 'tell-me-about-the-content-type-builder'\n | 'tell-me-about-strapi';\n };\n}\n\ninterface DidAnswerMessageEvent {\n name: 'didAnswerMessage';\n properties: {\n successful: boolean;\n };\n}\n\ninterface DidVoteAnswerEvent {\n name: 'didVoteAnswer';\n properties: {\n value: 'positive' | 'negative';\n };\n}\n\ninterface DidUpdateCTBSchema {\n name: 'didUpdateCTBSchema';\n properties: {\n success: boolean;\n newContentTypes: number;\n editedContentTypes: number;\n deletedContentTypes: number;\n newComponents: number;\n editedComponents: number;\n deletedComponents: number;\n newFields: number;\n editedFields: number;\n deletedFields: number;\n };\n}\n\ninterface DidSkipGuidedTour {\n name: 'didSkipGuidedTour';\n properties: {\n name: keyof Tours | 'all';\n };\n}\n\ninterface DidCompleteGuidedTour {\n name: 'didCompleteGuidedTour';\n properties: {\n name: keyof Tours | 'all';\n };\n}\n\ninterface DidStartGuidedTour {\n name: 'didStartGuidedTour';\n properties: {\n name: keyof Tours;\n fromHomepage?: boolean;\n };\n}\n\ninterface WillEditEntryFromHome {\n name: 'willEditEntryFromHome';\n properties: {\n entryType: 'edited' | 'published' | 'assigned';\n };\n}\n\ninterface DidOpenHomeWidgetLink {\n name: 'didOpenHomeWidgetLink';\n properties: {\n widgetUID: string;\n };\n}\n\ninterface DidOpenKeyStatisticsWidgetLink {\n name: 'didOpenKeyStatisticsWidgetLink';\n properties: {\n itemKey: string;\n };\n}\n\ntype EventsWithProperties =\n | CreateEntryEvents\n | PublishEntryEvents\n | DidAccessAuthenticatedAdministrationEvent\n | DidAccessTokenListEvent\n | DidChangeModeEvent\n | DidCropFileEvent\n | DeleteEntryEvents\n | DidEditMediaLibraryElementsEvent\n | DidFilterMediaLibraryElementsEvent\n | DidFilterEntriesEvent\n | DidSelectContentTypeFieldTypeEvent\n | DidSelectFile\n | DidSortMediaLibraryElementsEvent\n | DidSubmitWithErrorsFirstAdminEvent\n | DidUsePresetPromptEvent\n | DidAnswerMessageEvent\n | DidVoteAnswerEvent\n | LogoEvent\n | TokenEvents\n | UpdateEntryEvents\n | WillModifyTokenEvent\n | WillNavigateEvent\n | DidClickOnDocLink\n | DidPublishRelease\n | MediaEvents\n | DidUpdateCTBSchema\n | DidSkipGuidedTour\n | DidCompleteGuidedTour\n | DidStartGuidedTour\n | DidOpenHomeWidgetLink\n | DidOpenKeyStatisticsWidgetLink\n | WillEditEntryFromHome;\n\nexport type TrackingEvent = EventWithoutProperties | EventsWithProperties;\nexport interface UseTrackingReturn {\n /**\n * This type helps show all the available event names before you start typing,\n * however autocomplete isn't great.\n */\n trackUsage<TEvent extends TrackingEvent>(\n event: TEvent['name'],\n properties: TEvent['properties']\n ): Promise<null | AxiosResponse<string>>;\n trackUsage<TEvent extends Extract<TrackingEvent, { properties?: never }>>(\n event: TEvent['name'],\n properties?: never\n ): Promise<null | AxiosResponse<string>>;\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n trackUsage<TEvent extends Extract<TrackingEvent, { properties: object }>>(\n event: TEvent['name'],\n properties: TEvent['properties']\n ): Promise<null | AxiosResponse<string>>;\n}\n\n/**\n * @description Used to send amplitude events to the Strapi Tracking hub.\n *\n * @example\n * ```tsx\n * import { useTracking } from '@strapi/strapi/admin';\n *\n * const MyComponent = () => {\n * const { trackUsage } = useTracking();\n *\n * const handleClick = () => {\n * trackUsage('my-event', { myProperty: 'myValue' });\n * }\n *\n * return <button onClick={handleClick}>Send Event</button>\n * }\n * ```\n */\nconst useTracking = (): UseTrackingReturn => {\n const deviceType = useDeviceType();\n const deviceTypeRef = React.useRef(deviceType);\n deviceTypeRef.current = deviceType;\n const { uuid, telemetryProperties } = React.useContext(TrackingContext);\n const userId = useAppInfo('useTracking', (state) => state.userId);\n const trackUsage = React.useCallback(\n async <TEvent extends TrackingEvent>(\n event: TEvent['name'],\n properties?: TEvent['properties']\n ) => {\n try {\n if (uuid && !window.strapi.telemetryDisabled) {\n const res = await axios.post<string>(\n `${process.env.STRAPI_ANALYTICS_URL || 'https://analytics.strapi.io'}/api/v2/track`,\n {\n event,\n userId,\n eventProperties: { ...properties },\n userProperties: {\n deviceType: deviceTypeRef.current,\n },\n groupProperties: {\n ...telemetryProperties,\n projectId: uuid,\n projectType: window.strapi.projectType,\n },\n },\n {\n headers: {\n 'Content-Type': 'application/json',\n 'X-Strapi-Event': event,\n },\n }\n );\n\n return res;\n }\n } catch {\n // Silence is golden\n }\n\n return null;\n },\n [telemetryProperties, userId, uuid]\n );\n\n return { trackUsage };\n};\n\nexport { TrackingProvider, useTracking };\n"],"names":["TrackingContext","React","createContext","uuid","TrackingProvider","children","token","useAuth","state","data","initData","useInitQuery","getAllWidgets","useStrapiApp","widgets","getAll","useTelemetryPropertiesQuery","undefined","skip","useEffect","event","fetch","process","env","STRAPI_ANALYTICS_URL","method","body","JSON","stringify","userId","eventPropeties","groupProperties","projectId","registeredWidgets","map","widget","uid","headers","value","useMemo","telemetryProperties","_jsx","Provider","useTracking","deviceType","useDeviceType","deviceTypeRef","useRef","current","useContext","useAppInfo","trackUsage","useCallback","properties","window","strapi","telemetryDisabled","res","axios","post","eventProperties","userProperties","projectType"],"mappings":";;;;;;;;;AA2BA;;AAEkG,qGAElG,MAAMA,eAAAA,iBAAkBC,KAAAA,CAAMC,aAAa,CAAuB;IAChEC,IAAAA,EAAM;AACR,CAAA,CAAA;AAUA,MAAMC,gBAAAA,GAAmB,CAAC,EAAEC,QAAQ,EAAyB,GAAA;AAC3D,IAAA,MAAMC,QAAQC,OAAAA,CAAQ,KAAA,EAAO,CAACC,KAAAA,GAAUA,MAAMF,KAAK,CAAA;AACnD,IAAA,MAAM,EAAEG,IAAAA,EAAMC,QAAQ,EAAE,GAAGC,YAAAA,EAAAA;AAC3B,IAAA,MAAM,EAAER,IAAI,EAAE,GAAGO,YAAY,EAAC;IAC9B,MAAME,aAAAA,GAAgBC,aAAa,kBAAA,EAAoB,CAACL,QAAUA,KAAAA,CAAMM,OAAO,CAACC,MAAM,CAAA;AAEtF,IAAA,MAAM,EAAEN,IAAI,EAAE,GAAGO,4BAA4BC,SAAAA,EAAW;QACtDC,IAAAA,EAAM,CAACR,QAAAA,EAAUP,IAAAA,IAAQ,CAACG;AAC5B,KAAA,CAAA;AACAL,IAAAA,KAAAA,CAAMkB,SAAS,CAAC,IAAA;AACd,QAAA,IAAIhB,QAAQM,IAAAA,EAAM;AAChB,YAAA,MAAMW,KAAAA,GAAQ,6BAAA;YACd,IAAI;gBACFC,KAAAA,CAAM,CAAA,EAAGC,QAAQC,GAAG,CAACC,oBAAoB,IAAI,6BAAA,CAA8B,aAAa,CAAC,EAAE;oBACzFC,MAAAA,EAAQ,MAAA;oBACRC,IAAAA,EAAMC,IAAAA,CAAKC,SAAS,CAAC;;AAEnBR,wBAAAA,KAAAA;wBACAS,MAAAA,EAAQ,EAAA;AACRC,wBAAAA,cAAAA,EAAgB,EAAC;wBACjBC,eAAAA,EAAiB;AACf,4BAAA,GAAGtB,IAAI;4BACPuB,SAAAA,EAAW7B,IAAAA;AACX8B,4BAAAA,iBAAAA,EAAmBrB,gBAAgBsB,GAAG,CAAC,CAACC,MAAAA,GAAWA,OAAOC,GAAG;AAC/D;AACF,qBAAA,CAAA;oBACAC,OAAAA,EAAS;wBACP,cAAA,EAAgB,kBAAA;wBAChB,gBAAA,EAAkBjB;AACpB;AACF,iBAAA,CAAA;AACF,YAAA,CAAA,CAAE,OAAM;;AAER,YAAA;AACF,QAAA;IACF,CAAA,EAAG;AAACX,QAAAA,IAAAA;AAAMN,QAAAA,IAAAA;AAAMS,QAAAA;AAAc,KAAA,CAAA;AAC9B,IAAA,MAAM0B,KAAAA,GAAQrC,KAAAA,CAAMsC,OAAO,CACzB,KAAO;AACLpC,YAAAA,IAAAA;YACAqC,mBAAAA,EAAqB/B;AACvB,SAAA,CAAA,EACA;AAACN,QAAAA,IAAAA;AAAMM,QAAAA;AAAK,KAAA,CAAA;IAGd,qBAAOgC,GAAA,CAACzC,gBAAgB0C,QAAQ,EAAA;QAACJ,KAAAA,EAAOA,KAAAA;AAAQjC,QAAAA,QAAAA,EAAAA;;AAClD;AAwbA;;;;;;;;;;;;;;;;;AAiBC,UACKsC,WAAAA,GAAc,IAAA;AAClB,IAAA,MAAMC,UAAAA,GAAaC,aAAAA,EAAAA;IACnB,MAAMC,aAAAA,GAAgB7C,KAAAA,CAAM8C,MAAM,CAACH,UAAAA,CAAAA;AACnCE,IAAAA,aAAAA,CAAcE,OAAO,GAAGJ,UAAAA;IACxB,MAAM,EAAEzC,IAAI,EAAEqC,mBAAmB,EAAE,GAAGvC,KAAAA,CAAMgD,UAAU,CAACjD,eAAAA,CAAAA;AACvD,IAAA,MAAM6B,SAASqB,UAAAA,CAAW,aAAA,EAAe,CAAC1C,KAAAA,GAAUA,MAAMqB,MAAM,CAAA;AAChE,IAAA,MAAMsB,UAAAA,GAAalD,KAAAA,CAAMmD,WAAW,CAClC,OACEhC,KAAAA,EACAiC,UAAAA,GAAAA;QAEA,IAAI;AACF,YAAA,IAAIlD,QAAQ,CAACmD,MAAAA,CAAOC,MAAM,CAACC,iBAAiB,EAAE;AAC5C,gBAAA,MAAMC,GAAAA,GAAM,MAAMC,KAAAA,CAAMC,IAAI,CAC1B,CAAA,EAAGrC,OAAAA,CAAQC,GAAG,CAACC,oBAAoB,IAAI,6BAAA,CAA8B,aAAa,CAAC,EACnF;AACEJ,oBAAAA,KAAAA;AACAS,oBAAAA,MAAAA;oBACA+B,eAAAA,EAAiB;AAAE,wBAAA,GAAGP;AAAW,qBAAA;oBACjCQ,cAAAA,EAAgB;AACdjB,wBAAAA,UAAAA,EAAYE,cAAcE;AAC5B,qBAAA;oBACAjB,eAAAA,EAAiB;AACf,wBAAA,GAAGS,mBAAmB;wBACtBR,SAAAA,EAAW7B,IAAAA;wBACX2D,WAAAA,EAAaR,MAAAA,CAAOC,MAAM,CAACO;AAC7B;iBACF,EACA;oBACEzB,OAAAA,EAAS;wBACP,cAAA,EAAgB,kBAAA;wBAChB,gBAAA,EAAkBjB;AACpB;AACF,iBAAA,CAAA;gBAGF,OAAOqC,GAAAA;AACT,YAAA;AACF,QAAA,CAAA,CAAE,OAAM;;AAER,QAAA;QAEA,OAAO,IAAA;IACT,CAAA,EACA;AAACjB,QAAAA,mBAAAA;AAAqBX,QAAAA,MAAAA;AAAQ1B,QAAAA;AAAK,KAAA,CAAA;IAGrC,OAAO;AAAEgD,QAAAA;AAAW,KAAA;AACtB;;;;"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var React = require('react');
|
|
4
|
+
var unsavedChangesRegistry = require('../utils/unsavedChangesRegistry.js');
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Registers whether the current surface has unsaved edits so session-expiry
|
|
8
|
+
* logout can warn before clearing auth state (which unmounts forms).
|
|
9
|
+
*/ const useRegisterUnsavedChanges = (id, enabled)=>{
|
|
10
|
+
React.useEffect(()=>{
|
|
11
|
+
return unsavedChangesRegistry.registerUnsavedChangesCheck(id, ()=>enabled);
|
|
12
|
+
}, [
|
|
13
|
+
id,
|
|
14
|
+
enabled
|
|
15
|
+
]);
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
exports.useRegisterUnsavedChanges = useRegisterUnsavedChanges;
|
|
19
|
+
//# sourceMappingURL=useRegisterUnsavedChanges.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useRegisterUnsavedChanges.js","sources":["../../../../../admin/src/hooks/useRegisterUnsavedChanges.ts"],"sourcesContent":["import { useEffect } from 'react';\n\nimport { registerUnsavedChangesCheck } from '../utils/unsavedChangesRegistry';\n\n/**\n * Registers whether the current surface has unsaved edits so session-expiry\n * logout can warn before clearing auth state (which unmounts forms).\n */\nconst useRegisterUnsavedChanges = (id: string, enabled: boolean): void => {\n useEffect(() => {\n return registerUnsavedChangesCheck(id, () => enabled);\n }, [id, enabled]);\n};\n\nexport { useRegisterUnsavedChanges };\n"],"names":["useRegisterUnsavedChanges","id","enabled","useEffect","registerUnsavedChangesCheck"],"mappings":";;;;;AAIA;;;IAIA,MAAMA,yBAAAA,GAA4B,CAACC,EAAAA,EAAYC,OAAAA,GAAAA;IAC7CC,eAAAA,CAAU,IAAA;QACR,OAAOC,kDAAAA,CAA4BH,IAAI,IAAMC,OAAAA,CAAAA;IAC/C,CAAA,EAAG;AAACD,QAAAA,EAAAA;AAAIC,QAAAA;AAAQ,KAAA,CAAA;AAClB;;;;"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { useEffect } from 'react';
|
|
2
|
+
import { registerUnsavedChangesCheck } from '../utils/unsavedChangesRegistry.mjs';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Registers whether the current surface has unsaved edits so session-expiry
|
|
6
|
+
* logout can warn before clearing auth state (which unmounts forms).
|
|
7
|
+
*/ const useRegisterUnsavedChanges = (id, enabled)=>{
|
|
8
|
+
useEffect(()=>{
|
|
9
|
+
return registerUnsavedChangesCheck(id, ()=>enabled);
|
|
10
|
+
}, [
|
|
11
|
+
id,
|
|
12
|
+
enabled
|
|
13
|
+
]);
|
|
14
|
+
};
|
|
15
|
+
|
|
16
|
+
export { useRegisterUnsavedChanges };
|
|
17
|
+
//# sourceMappingURL=useRegisterUnsavedChanges.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useRegisterUnsavedChanges.mjs","sources":["../../../../../admin/src/hooks/useRegisterUnsavedChanges.ts"],"sourcesContent":["import { useEffect } from 'react';\n\nimport { registerUnsavedChangesCheck } from '../utils/unsavedChangesRegistry';\n\n/**\n * Registers whether the current surface has unsaved edits so session-expiry\n * logout can warn before clearing auth state (which unmounts forms).\n */\nconst useRegisterUnsavedChanges = (id: string, enabled: boolean): void => {\n useEffect(() => {\n return registerUnsavedChangesCheck(id, () => enabled);\n }, [id, enabled]);\n};\n\nexport { useRegisterUnsavedChanges };\n"],"names":["useRegisterUnsavedChanges","id","enabled","useEffect","registerUnsavedChangesCheck"],"mappings":";;;AAIA;;;IAIA,MAAMA,yBAAAA,GAA4B,CAACC,EAAAA,EAAYC,OAAAA,GAAAA;IAC7CC,SAAAA,CAAU,IAAA;QACR,OAAOC,2BAAAA,CAA4BH,IAAI,IAAMC,OAAAA,CAAAA;IAC/C,CAAA,EAAG;AAACD,QAAAA,EAAAA;AAAIC,QAAAA;AAAQ,KAAA,CAAA;AAClB;;;;"}
|
|
@@ -27,31 +27,38 @@ const SESSION_EXPIRY_BUFFER_MS = 1000;
|
|
|
27
27
|
/**
|
|
28
28
|
* How long before the access token's `exp` an active tab renews. Renewing
|
|
29
29
|
* ahead of expiry (rather than at it) means the refreshed token is already in
|
|
30
|
-
* shared storage by the time any *other* tab's
|
|
31
|
-
* sibling re-syncs instead of racing the refresh
|
|
30
|
+
* shared storage by the time any *other* tab's post-expiry timer fires — so an
|
|
31
|
+
* idle sibling re-syncs instead of racing the refresh.
|
|
32
32
|
*/ const SESSION_RENEW_MARGIN_MS = 10000;
|
|
33
33
|
/**
|
|
34
|
-
* Keep the admin session alive while the user is active
|
|
35
|
-
*
|
|
34
|
+
* Keep the admin session alive while the user is active — without one tab
|
|
35
|
+
* tearing down another, and without logging anyone out because a short-lived
|
|
36
|
+
* access token aged out.
|
|
36
37
|
*
|
|
37
|
-
* The access token
|
|
38
|
-
*
|
|
39
|
-
*
|
|
38
|
+
* The access token (`accessTokenLifespan`, e.g. 30 min) is transport plumbing,
|
|
39
|
+
* not the session length; the refresh token's idle/max window is the session.
|
|
40
|
+
* So expiry of the access JWT must never clear auth state or unmount the page:
|
|
41
|
+
* the next user-initiated request 401s, `withTokenRefresh` refreshes and
|
|
42
|
+
* retries, and only a *rejected* refresh ends the session (`onSessionDead`).
|
|
43
|
+
* Two timers are armed per token:
|
|
40
44
|
*
|
|
41
45
|
* - Renew (at `exp` minus a margin): if the user interacted during this token's
|
|
42
46
|
* lifetime, silently renew *ahead* of expiry. The new `setToken` re-arms the
|
|
43
47
|
* hook; a server rejection (`onSessionDead`) ends the session globally.
|
|
44
48
|
* Renewing early guarantees the refreshed token reaches shared storage before
|
|
45
|
-
* any sibling tab's
|
|
46
|
-
* -
|
|
47
|
-
* first re-syncs from a token another tab refreshed (so an idle tab rides
|
|
48
|
-
* an active sibling), then renews if activity arrived late
|
|
49
|
-
*
|
|
49
|
+
* any sibling tab's post-expiry timer fires.
|
|
50
|
+
* - Post-expiry (just after `exp`): the fallback when this tab did not renew.
|
|
51
|
+
* It first re-syncs from a token another tab refreshed (so an idle tab rides
|
|
52
|
+
* on an active sibling), then renews if activity arrived late. If the tab is
|
|
53
|
+
* still idle, it does nothing destructive — the stale access token stays in
|
|
54
|
+
* place so form state survives until the next request.
|
|
55
|
+
*
|
|
56
|
+
* Idle tabs must not renew: a tab left open forever must not keep the session
|
|
57
|
+
* alive past the server's idle/max window.
|
|
50
58
|
*
|
|
51
59
|
* If the JWT can't be decoded (malformed, missing `exp`), the timers are skipped
|
|
52
|
-
* silently — the
|
|
53
|
-
|
|
54
|
-
*/ const useIdleSessionLogout = ({ token, onExpired, onSessionDead, getStoredToken, onResync, getLastActivityAt, renewSession, disabled = false })=>{
|
|
60
|
+
* silently — the 401 refresh path still covers the next user-initiated request.
|
|
61
|
+
*/ const useSessionKeepalive = ({ token, onSessionDead, getStoredToken, onResync, getLastActivityAt, renewSession, disabled = false })=>{
|
|
55
62
|
React__namespace.useEffect(()=>{
|
|
56
63
|
if (!token || disabled) {
|
|
57
64
|
return undefined;
|
|
@@ -81,7 +88,7 @@ const SESSION_EXPIRY_BUFFER_MS = 1000;
|
|
|
81
88
|
renewSession().then((renewed)=>{
|
|
82
89
|
if (!renewed) {
|
|
83
90
|
// Server rejected the refresh: the session is truly over.
|
|
84
|
-
|
|
91
|
+
onSessionDead?.();
|
|
85
92
|
}
|
|
86
93
|
// On success, storeToken -> setToken updates the token prop, which
|
|
87
94
|
// re-runs this effect and re-arms against the new exp.
|
|
@@ -97,26 +104,26 @@ const SESSION_EXPIRY_BUFFER_MS = 1000;
|
|
|
97
104
|
renew();
|
|
98
105
|
}
|
|
99
106
|
}, renewDelay);
|
|
100
|
-
// Fallback
|
|
101
|
-
|
|
102
|
-
const
|
|
107
|
+
// Fallback just after expiry for tabs that did not renew: re-sync or
|
|
108
|
+
// late-activity renew. Idle tabs leave the stale token alone.
|
|
109
|
+
const postExpiryDelay = Math.max(expiry - armedAt + SESSION_EXPIRY_BUFFER_MS, 0);
|
|
110
|
+
const postExpiryTimeoutId = window.setTimeout(()=>{
|
|
103
111
|
if (tryResync()) {
|
|
104
112
|
return;
|
|
105
113
|
}
|
|
106
114
|
if (wasActive() && renewSession) {
|
|
107
115
|
renew();
|
|
108
|
-
return;
|
|
109
116
|
}
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
117
|
+
// Genuinely idle: do nothing. Keep the (stale) access token and the page
|
|
118
|
+
// mounted. The next request will 401 and either refresh transparently or
|
|
119
|
+
// hit the session-dead path if the server rejects the refresh.
|
|
120
|
+
}, postExpiryDelay);
|
|
113
121
|
return ()=>{
|
|
114
122
|
window.clearTimeout(renewTimeoutId);
|
|
115
|
-
window.clearTimeout(
|
|
123
|
+
window.clearTimeout(postExpiryTimeoutId);
|
|
116
124
|
};
|
|
117
125
|
}, [
|
|
118
126
|
token,
|
|
119
|
-
onExpired,
|
|
120
127
|
onSessionDead,
|
|
121
128
|
getStoredToken,
|
|
122
129
|
onResync,
|
|
@@ -128,5 +135,5 @@ const SESSION_EXPIRY_BUFFER_MS = 1000;
|
|
|
128
135
|
|
|
129
136
|
exports.SESSION_EXPIRY_BUFFER_MS = SESSION_EXPIRY_BUFFER_MS;
|
|
130
137
|
exports.SESSION_RENEW_MARGIN_MS = SESSION_RENEW_MARGIN_MS;
|
|
131
|
-
exports.
|
|
132
|
-
//# sourceMappingURL=
|
|
138
|
+
exports.useSessionKeepalive = useSessionKeepalive;
|
|
139
|
+
//# sourceMappingURL=useSessionKeepalive.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useSessionKeepalive.js","sources":["../../../../../admin/src/hooks/useSessionKeepalive.ts"],"sourcesContent":["import * as React from 'react';\n\nimport { decodeAccessTokenExpiry } from '../utils/jwt';\n\nconst SESSION_EXPIRY_BUFFER_MS = 1000;\n/**\n * How long before the access token's `exp` an active tab renews. Renewing\n * ahead of expiry (rather than at it) means the refreshed token is already in\n * shared storage by the time any *other* tab's post-expiry timer fires — so an\n * idle sibling re-syncs instead of racing the refresh.\n */\nconst SESSION_RENEW_MARGIN_MS = 10_000;\n\ninterface UseSessionKeepaliveOptions {\n /**\n * The current admin access JWT (from Redux), or `null` when logged out.\n */\n token: string | null;\n /**\n * Called when a renewal attempt is rejected by the server (the session is\n * truly over: refresh token idle/max window elapsed). This is a\n * server-confirmed end of session, so it SHOULD broadcast a global logout to\n * every tab.\n */\n onSessionDead?: () => void;\n /**\n * Read the access token currently in shared storage (localStorage/cookie).\n * Because every open tab shares the same refresh cookie, an active tab that\n * refreshes writes a newer access token here. When omitted, the hook never\n * re-syncs across tabs.\n */\n getStoredToken?: () => string | null;\n /**\n * Adopt a newer shared token instead of treating this tab's token as stale.\n * Typically dispatches `setToken`, which updates Redux and causes this hook\n * to re-arm against the later `exp`. Only called when `getStoredToken`\n * returns a token whose `exp` is later than the in-memory one.\n */\n onResync?: (token: string) => void;\n /**\n * Epoch ms of the user's last interaction (pointer, key, scroll, …). Used to\n * decide whether to silently renew when the access token is about to expire.\n * Idle tabs must NOT renew — that would defeat the server's\n * `idleSessionLifespan` / `idleRefreshTokenLifespan`. When omitted, the hook\n * never treats the tab as active.\n */\n getLastActivityAt?: () => number;\n /**\n * Silently renew the session (rotate the refresh token + mint a new access\n * token). Resolves `true` on success — the resulting `setToken` re-arms this\n * hook against the new `exp` — or `false` when the server rejects it. Only\n * called when the user was active during the current token's lifetime.\n */\n renewSession?: () => Promise<boolean>;\n /**\n * Escape hatch for tests / dev environments where we don't want the\n * automatic renew / re-sync behavior. Mirrors the existing `_disableRenewToken`\n * prop on `<AuthProvider>`.\n */\n disabled?: boolean;\n}\n\n/**\n * Keep the admin session alive while the user is active — without one tab\n * tearing down another, and without logging anyone out because a short-lived\n * access token aged out.\n *\n * The access token (`accessTokenLifespan`, e.g. 30 min) is transport plumbing,\n * not the session length; the refresh token's idle/max window is the session.\n * So expiry of the access JWT must never clear auth state or unmount the page:\n * the next user-initiated request 401s, `withTokenRefresh` refreshes and\n * retries, and only a *rejected* refresh ends the session (`onSessionDead`).\n * Two timers are armed per token:\n *\n * - Renew (at `exp` minus a margin): if the user interacted during this token's\n * lifetime, silently renew *ahead* of expiry. The new `setToken` re-arms the\n * hook; a server rejection (`onSessionDead`) ends the session globally.\n * Renewing early guarantees the refreshed token reaches shared storage before\n * any sibling tab's post-expiry timer fires.\n * - Post-expiry (just after `exp`): the fallback when this tab did not renew.\n * It first re-syncs from a token another tab refreshed (so an idle tab rides\n * on an active sibling), then renews if activity arrived late. If the tab is\n * still idle, it does nothing destructive — the stale access token stays in\n * place so form state survives until the next request.\n *\n * Idle tabs must not renew: a tab left open forever must not keep the session\n * alive past the server's idle/max window.\n *\n * If the JWT can't be decoded (malformed, missing `exp`), the timers are skipped\n * silently — the 401 refresh path still covers the next user-initiated request.\n */\nconst useSessionKeepalive = ({\n token,\n onSessionDead,\n getStoredToken,\n onResync,\n getLastActivityAt,\n renewSession,\n disabled = false,\n}: UseSessionKeepaliveOptions): void => {\n React.useEffect(() => {\n if (!token || disabled) {\n return undefined;\n }\n\n const expiry = decodeAccessTokenExpiry(token);\n if (expiry === null) {\n return undefined;\n }\n\n // When this token became active. Activity recorded after this point means\n // the user was present during the token's lifetime.\n const armedAt = Date.now();\n const wasActive = () =>\n typeof getLastActivityAt === 'function' && getLastActivityAt() >= armedAt;\n\n // Adopt a fresher token another tab wrote to shared storage. Returns true\n // when it re-synced (caller should stop).\n const tryResync = (): boolean => {\n const storedToken = getStoredToken?.() ?? null;\n if (storedToken && storedToken !== token && onResync) {\n const storedExpiry = decodeAccessTokenExpiry(storedToken);\n if (storedExpiry !== null && storedExpiry > expiry) {\n onResync(storedToken);\n return true;\n }\n }\n return false;\n };\n\n const renew = () => {\n renewSession!().then((renewed) => {\n if (!renewed) {\n // Server rejected the refresh: the session is truly over.\n onSessionDead?.();\n }\n // On success, storeToken -> setToken updates the token prop, which\n // re-runs this effect and re-arms against the new exp.\n });\n };\n\n // Renew ahead of expiry while the user is active.\n const renewDelay = Math.max(expiry - armedAt - SESSION_RENEW_MARGIN_MS, 0);\n const renewTimeoutId = window.setTimeout(() => {\n if (tryResync()) {\n return;\n }\n if (wasActive() && renewSession) {\n renew();\n }\n }, renewDelay);\n\n // Fallback just after expiry for tabs that did not renew: re-sync or\n // late-activity renew. Idle tabs leave the stale token alone.\n const postExpiryDelay = Math.max(expiry - armedAt + SESSION_EXPIRY_BUFFER_MS, 0);\n const postExpiryTimeoutId = window.setTimeout(() => {\n if (tryResync()) {\n return;\n }\n if (wasActive() && renewSession) {\n renew();\n }\n // Genuinely idle: do nothing. Keep the (stale) access token and the page\n // mounted. The next request will 401 and either refresh transparently or\n // hit the session-dead path if the server rejects the refresh.\n }, postExpiryDelay);\n\n return () => {\n window.clearTimeout(renewTimeoutId);\n window.clearTimeout(postExpiryTimeoutId);\n };\n }, [token, onSessionDead, getStoredToken, onResync, getLastActivityAt, renewSession, disabled]);\n};\n\nexport { useSessionKeepalive, SESSION_EXPIRY_BUFFER_MS, SESSION_RENEW_MARGIN_MS };\nexport type { UseSessionKeepaliveOptions };\n"],"names":["SESSION_EXPIRY_BUFFER_MS","SESSION_RENEW_MARGIN_MS","useSessionKeepalive","token","onSessionDead","getStoredToken","onResync","getLastActivityAt","renewSession","disabled","React","useEffect","undefined","expiry","decodeAccessTokenExpiry","armedAt","Date","now","wasActive","tryResync","storedToken","storedExpiry","renew","then","renewed","renewDelay","Math","max","renewTimeoutId","window","setTimeout","postExpiryDelay","postExpiryTimeoutId","clearTimeout"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAIA,MAAMA,wBAAAA,GAA2B;AACjC;;;;;AAKC,UACKC,uBAAAA,GAA0B;AAmDhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BC,UACKC,mBAAAA,GAAsB,CAAC,EAC3BC,KAAK,EACLC,aAAa,EACbC,cAAc,EACdC,QAAQ,EACRC,iBAAiB,EACjBC,YAAY,EACZC,QAAAA,GAAW,KAAK,EACW,GAAA;AAC3BC,IAAAA,gBAAAA,CAAMC,SAAS,CAAC,IAAA;QACd,IAAI,CAACR,SAASM,QAAAA,EAAU;YACtB,OAAOG,SAAAA;AACT,QAAA;AAEA,QAAA,MAAMC,SAASC,2BAAAA,CAAwBX,KAAAA,CAAAA;AACvC,QAAA,IAAIU,WAAW,IAAA,EAAM;YACnB,OAAOD,SAAAA;AACT,QAAA;;;QAIA,MAAMG,OAAAA,GAAUC,KAAKC,GAAG,EAAA;AACxB,QAAA,MAAMC,SAAAA,GAAY,IAChB,OAAOX,iBAAAA,KAAsB,cAAcA,iBAAAA,EAAAA,IAAuBQ,OAAAA;;;AAIpE,QAAA,MAAMI,SAAAA,GAAY,IAAA;AAChB,YAAA,MAAMC,cAAcf,cAAAA,IAAAA,IAAsB,IAAA;YAC1C,IAAIe,WAAAA,IAAeA,WAAAA,KAAgBjB,KAAAA,IAASG,QAAAA,EAAU;AACpD,gBAAA,MAAMe,eAAeP,2BAAAA,CAAwBM,WAAAA,CAAAA;gBAC7C,IAAIC,YAAAA,KAAiB,IAAA,IAAQA,YAAAA,GAAeR,MAAAA,EAAQ;oBAClDP,QAAAA,CAASc,WAAAA,CAAAA;oBACT,OAAO,IAAA;AACT,gBAAA;AACF,YAAA;YACA,OAAO,KAAA;AACT,QAAA,CAAA;AAEA,QAAA,MAAME,KAAAA,GAAQ,IAAA;YACZd,YAAAA,EAAAA,CAAgBe,IAAI,CAAC,CAACC,OAAAA,GAAAA;AACpB,gBAAA,IAAI,CAACA,OAAAA,EAAS;;AAEZpB,oBAAAA,aAAAA,IAAAA;AACF,gBAAA;;;AAGF,YAAA,CAAA,CAAA;AACF,QAAA,CAAA;;AAGA,QAAA,MAAMqB,aAAaC,IAAAA,CAAKC,GAAG,CAACd,MAAAA,GAASE,UAAUd,uBAAAA,EAAyB,CAAA,CAAA;QACxE,MAAM2B,cAAAA,GAAiBC,MAAAA,CAAOC,UAAU,CAAC,IAAA;AACvC,YAAA,IAAIX,SAAAA,EAAAA,EAAa;AACf,gBAAA;AACF,YAAA;AACA,YAAA,IAAID,eAAeV,YAAAA,EAAc;AAC/Bc,gBAAAA,KAAAA,EAAAA;AACF,YAAA;QACF,CAAA,EAAGG,UAAAA,CAAAA;;;AAIH,QAAA,MAAMM,kBAAkBL,IAAAA,CAAKC,GAAG,CAACd,MAAAA,GAASE,UAAUf,wBAAAA,EAA0B,CAAA,CAAA;QAC9E,MAAMgC,mBAAAA,GAAsBH,MAAAA,CAAOC,UAAU,CAAC,IAAA;AAC5C,YAAA,IAAIX,SAAAA,EAAAA,EAAa;AACf,gBAAA;AACF,YAAA;AACA,YAAA,IAAID,eAAeV,YAAAA,EAAc;AAC/Bc,gBAAAA,KAAAA,EAAAA;AACF,YAAA;;;;QAIF,CAAA,EAAGS,eAAAA,CAAAA;QAEH,OAAO,IAAA;AACLF,YAAAA,MAAAA,CAAOI,YAAY,CAACL,cAAAA,CAAAA;AACpBC,YAAAA,MAAAA,CAAOI,YAAY,CAACD,mBAAAA,CAAAA;AACtB,QAAA,CAAA;IACF,CAAA,EAAG;AAAC7B,QAAAA,KAAAA;AAAOC,QAAAA,aAAAA;AAAeC,QAAAA,cAAAA;AAAgBC,QAAAA,QAAAA;AAAUC,QAAAA,iBAAAA;AAAmBC,QAAAA,YAAAA;AAAcC,QAAAA;AAAS,KAAA,CAAA;AAChG;;;;;;"}
|
|
@@ -5,31 +5,38 @@ const SESSION_EXPIRY_BUFFER_MS = 1000;
|
|
|
5
5
|
/**
|
|
6
6
|
* How long before the access token's `exp` an active tab renews. Renewing
|
|
7
7
|
* ahead of expiry (rather than at it) means the refreshed token is already in
|
|
8
|
-
* shared storage by the time any *other* tab's
|
|
9
|
-
* sibling re-syncs instead of racing the refresh
|
|
8
|
+
* shared storage by the time any *other* tab's post-expiry timer fires — so an
|
|
9
|
+
* idle sibling re-syncs instead of racing the refresh.
|
|
10
10
|
*/ const SESSION_RENEW_MARGIN_MS = 10000;
|
|
11
11
|
/**
|
|
12
|
-
* Keep the admin session alive while the user is active
|
|
13
|
-
*
|
|
12
|
+
* Keep the admin session alive while the user is active — without one tab
|
|
13
|
+
* tearing down another, and without logging anyone out because a short-lived
|
|
14
|
+
* access token aged out.
|
|
14
15
|
*
|
|
15
|
-
* The access token
|
|
16
|
-
*
|
|
17
|
-
*
|
|
16
|
+
* The access token (`accessTokenLifespan`, e.g. 30 min) is transport plumbing,
|
|
17
|
+
* not the session length; the refresh token's idle/max window is the session.
|
|
18
|
+
* So expiry of the access JWT must never clear auth state or unmount the page:
|
|
19
|
+
* the next user-initiated request 401s, `withTokenRefresh` refreshes and
|
|
20
|
+
* retries, and only a *rejected* refresh ends the session (`onSessionDead`).
|
|
21
|
+
* Two timers are armed per token:
|
|
18
22
|
*
|
|
19
23
|
* - Renew (at `exp` minus a margin): if the user interacted during this token's
|
|
20
24
|
* lifetime, silently renew *ahead* of expiry. The new `setToken` re-arms the
|
|
21
25
|
* hook; a server rejection (`onSessionDead`) ends the session globally.
|
|
22
26
|
* Renewing early guarantees the refreshed token reaches shared storage before
|
|
23
|
-
* any sibling tab's
|
|
24
|
-
* -
|
|
25
|
-
* first re-syncs from a token another tab refreshed (so an idle tab rides
|
|
26
|
-
* an active sibling), then renews if activity arrived late
|
|
27
|
-
*
|
|
27
|
+
* any sibling tab's post-expiry timer fires.
|
|
28
|
+
* - Post-expiry (just after `exp`): the fallback when this tab did not renew.
|
|
29
|
+
* It first re-syncs from a token another tab refreshed (so an idle tab rides
|
|
30
|
+
* on an active sibling), then renews if activity arrived late. If the tab is
|
|
31
|
+
* still idle, it does nothing destructive — the stale access token stays in
|
|
32
|
+
* place so form state survives until the next request.
|
|
33
|
+
*
|
|
34
|
+
* Idle tabs must not renew: a tab left open forever must not keep the session
|
|
35
|
+
* alive past the server's idle/max window.
|
|
28
36
|
*
|
|
29
37
|
* If the JWT can't be decoded (malformed, missing `exp`), the timers are skipped
|
|
30
|
-
* silently — the
|
|
31
|
-
|
|
32
|
-
*/ const useIdleSessionLogout = ({ token, onExpired, onSessionDead, getStoredToken, onResync, getLastActivityAt, renewSession, disabled = false })=>{
|
|
38
|
+
* silently — the 401 refresh path still covers the next user-initiated request.
|
|
39
|
+
*/ const useSessionKeepalive = ({ token, onSessionDead, getStoredToken, onResync, getLastActivityAt, renewSession, disabled = false })=>{
|
|
33
40
|
React.useEffect(()=>{
|
|
34
41
|
if (!token || disabled) {
|
|
35
42
|
return undefined;
|
|
@@ -59,7 +66,7 @@ const SESSION_EXPIRY_BUFFER_MS = 1000;
|
|
|
59
66
|
renewSession().then((renewed)=>{
|
|
60
67
|
if (!renewed) {
|
|
61
68
|
// Server rejected the refresh: the session is truly over.
|
|
62
|
-
|
|
69
|
+
onSessionDead?.();
|
|
63
70
|
}
|
|
64
71
|
// On success, storeToken -> setToken updates the token prop, which
|
|
65
72
|
// re-runs this effect and re-arms against the new exp.
|
|
@@ -75,26 +82,26 @@ const SESSION_EXPIRY_BUFFER_MS = 1000;
|
|
|
75
82
|
renew();
|
|
76
83
|
}
|
|
77
84
|
}, renewDelay);
|
|
78
|
-
// Fallback
|
|
79
|
-
|
|
80
|
-
const
|
|
85
|
+
// Fallback just after expiry for tabs that did not renew: re-sync or
|
|
86
|
+
// late-activity renew. Idle tabs leave the stale token alone.
|
|
87
|
+
const postExpiryDelay = Math.max(expiry - armedAt + SESSION_EXPIRY_BUFFER_MS, 0);
|
|
88
|
+
const postExpiryTimeoutId = window.setTimeout(()=>{
|
|
81
89
|
if (tryResync()) {
|
|
82
90
|
return;
|
|
83
91
|
}
|
|
84
92
|
if (wasActive() && renewSession) {
|
|
85
93
|
renew();
|
|
86
|
-
return;
|
|
87
94
|
}
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
95
|
+
// Genuinely idle: do nothing. Keep the (stale) access token and the page
|
|
96
|
+
// mounted. The next request will 401 and either refresh transparently or
|
|
97
|
+
// hit the session-dead path if the server rejects the refresh.
|
|
98
|
+
}, postExpiryDelay);
|
|
91
99
|
return ()=>{
|
|
92
100
|
window.clearTimeout(renewTimeoutId);
|
|
93
|
-
window.clearTimeout(
|
|
101
|
+
window.clearTimeout(postExpiryTimeoutId);
|
|
94
102
|
};
|
|
95
103
|
}, [
|
|
96
104
|
token,
|
|
97
|
-
onExpired,
|
|
98
105
|
onSessionDead,
|
|
99
106
|
getStoredToken,
|
|
100
107
|
onResync,
|
|
@@ -104,5 +111,5 @@ const SESSION_EXPIRY_BUFFER_MS = 1000;
|
|
|
104
111
|
]);
|
|
105
112
|
};
|
|
106
113
|
|
|
107
|
-
export { SESSION_EXPIRY_BUFFER_MS, SESSION_RENEW_MARGIN_MS,
|
|
108
|
-
//# sourceMappingURL=
|
|
114
|
+
export { SESSION_EXPIRY_BUFFER_MS, SESSION_RENEW_MARGIN_MS, useSessionKeepalive };
|
|
115
|
+
//# sourceMappingURL=useSessionKeepalive.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useSessionKeepalive.mjs","sources":["../../../../../admin/src/hooks/useSessionKeepalive.ts"],"sourcesContent":["import * as React from 'react';\n\nimport { decodeAccessTokenExpiry } from '../utils/jwt';\n\nconst SESSION_EXPIRY_BUFFER_MS = 1000;\n/**\n * How long before the access token's `exp` an active tab renews. Renewing\n * ahead of expiry (rather than at it) means the refreshed token is already in\n * shared storage by the time any *other* tab's post-expiry timer fires — so an\n * idle sibling re-syncs instead of racing the refresh.\n */\nconst SESSION_RENEW_MARGIN_MS = 10_000;\n\ninterface UseSessionKeepaliveOptions {\n /**\n * The current admin access JWT (from Redux), or `null` when logged out.\n */\n token: string | null;\n /**\n * Called when a renewal attempt is rejected by the server (the session is\n * truly over: refresh token idle/max window elapsed). This is a\n * server-confirmed end of session, so it SHOULD broadcast a global logout to\n * every tab.\n */\n onSessionDead?: () => void;\n /**\n * Read the access token currently in shared storage (localStorage/cookie).\n * Because every open tab shares the same refresh cookie, an active tab that\n * refreshes writes a newer access token here. When omitted, the hook never\n * re-syncs across tabs.\n */\n getStoredToken?: () => string | null;\n /**\n * Adopt a newer shared token instead of treating this tab's token as stale.\n * Typically dispatches `setToken`, which updates Redux and causes this hook\n * to re-arm against the later `exp`. Only called when `getStoredToken`\n * returns a token whose `exp` is later than the in-memory one.\n */\n onResync?: (token: string) => void;\n /**\n * Epoch ms of the user's last interaction (pointer, key, scroll, …). Used to\n * decide whether to silently renew when the access token is about to expire.\n * Idle tabs must NOT renew — that would defeat the server's\n * `idleSessionLifespan` / `idleRefreshTokenLifespan`. When omitted, the hook\n * never treats the tab as active.\n */\n getLastActivityAt?: () => number;\n /**\n * Silently renew the session (rotate the refresh token + mint a new access\n * token). Resolves `true` on success — the resulting `setToken` re-arms this\n * hook against the new `exp` — or `false` when the server rejects it. Only\n * called when the user was active during the current token's lifetime.\n */\n renewSession?: () => Promise<boolean>;\n /**\n * Escape hatch for tests / dev environments where we don't want the\n * automatic renew / re-sync behavior. Mirrors the existing `_disableRenewToken`\n * prop on `<AuthProvider>`.\n */\n disabled?: boolean;\n}\n\n/**\n * Keep the admin session alive while the user is active — without one tab\n * tearing down another, and without logging anyone out because a short-lived\n * access token aged out.\n *\n * The access token (`accessTokenLifespan`, e.g. 30 min) is transport plumbing,\n * not the session length; the refresh token's idle/max window is the session.\n * So expiry of the access JWT must never clear auth state or unmount the page:\n * the next user-initiated request 401s, `withTokenRefresh` refreshes and\n * retries, and only a *rejected* refresh ends the session (`onSessionDead`).\n * Two timers are armed per token:\n *\n * - Renew (at `exp` minus a margin): if the user interacted during this token's\n * lifetime, silently renew *ahead* of expiry. The new `setToken` re-arms the\n * hook; a server rejection (`onSessionDead`) ends the session globally.\n * Renewing early guarantees the refreshed token reaches shared storage before\n * any sibling tab's post-expiry timer fires.\n * - Post-expiry (just after `exp`): the fallback when this tab did not renew.\n * It first re-syncs from a token another tab refreshed (so an idle tab rides\n * on an active sibling), then renews if activity arrived late. If the tab is\n * still idle, it does nothing destructive — the stale access token stays in\n * place so form state survives until the next request.\n *\n * Idle tabs must not renew: a tab left open forever must not keep the session\n * alive past the server's idle/max window.\n *\n * If the JWT can't be decoded (malformed, missing `exp`), the timers are skipped\n * silently — the 401 refresh path still covers the next user-initiated request.\n */\nconst useSessionKeepalive = ({\n token,\n onSessionDead,\n getStoredToken,\n onResync,\n getLastActivityAt,\n renewSession,\n disabled = false,\n}: UseSessionKeepaliveOptions): void => {\n React.useEffect(() => {\n if (!token || disabled) {\n return undefined;\n }\n\n const expiry = decodeAccessTokenExpiry(token);\n if (expiry === null) {\n return undefined;\n }\n\n // When this token became active. Activity recorded after this point means\n // the user was present during the token's lifetime.\n const armedAt = Date.now();\n const wasActive = () =>\n typeof getLastActivityAt === 'function' && getLastActivityAt() >= armedAt;\n\n // Adopt a fresher token another tab wrote to shared storage. Returns true\n // when it re-synced (caller should stop).\n const tryResync = (): boolean => {\n const storedToken = getStoredToken?.() ?? null;\n if (storedToken && storedToken !== token && onResync) {\n const storedExpiry = decodeAccessTokenExpiry(storedToken);\n if (storedExpiry !== null && storedExpiry > expiry) {\n onResync(storedToken);\n return true;\n }\n }\n return false;\n };\n\n const renew = () => {\n renewSession!().then((renewed) => {\n if (!renewed) {\n // Server rejected the refresh: the session is truly over.\n onSessionDead?.();\n }\n // On success, storeToken -> setToken updates the token prop, which\n // re-runs this effect and re-arms against the new exp.\n });\n };\n\n // Renew ahead of expiry while the user is active.\n const renewDelay = Math.max(expiry - armedAt - SESSION_RENEW_MARGIN_MS, 0);\n const renewTimeoutId = window.setTimeout(() => {\n if (tryResync()) {\n return;\n }\n if (wasActive() && renewSession) {\n renew();\n }\n }, renewDelay);\n\n // Fallback just after expiry for tabs that did not renew: re-sync or\n // late-activity renew. Idle tabs leave the stale token alone.\n const postExpiryDelay = Math.max(expiry - armedAt + SESSION_EXPIRY_BUFFER_MS, 0);\n const postExpiryTimeoutId = window.setTimeout(() => {\n if (tryResync()) {\n return;\n }\n if (wasActive() && renewSession) {\n renew();\n }\n // Genuinely idle: do nothing. Keep the (stale) access token and the page\n // mounted. The next request will 401 and either refresh transparently or\n // hit the session-dead path if the server rejects the refresh.\n }, postExpiryDelay);\n\n return () => {\n window.clearTimeout(renewTimeoutId);\n window.clearTimeout(postExpiryTimeoutId);\n };\n }, [token, onSessionDead, getStoredToken, onResync, getLastActivityAt, renewSession, disabled]);\n};\n\nexport { useSessionKeepalive, SESSION_EXPIRY_BUFFER_MS, SESSION_RENEW_MARGIN_MS };\nexport type { UseSessionKeepaliveOptions };\n"],"names":["SESSION_EXPIRY_BUFFER_MS","SESSION_RENEW_MARGIN_MS","useSessionKeepalive","token","onSessionDead","getStoredToken","onResync","getLastActivityAt","renewSession","disabled","React","useEffect","undefined","expiry","decodeAccessTokenExpiry","armedAt","Date","now","wasActive","tryResync","storedToken","storedExpiry","renew","then","renewed","renewDelay","Math","max","renewTimeoutId","window","setTimeout","postExpiryDelay","postExpiryTimeoutId","clearTimeout"],"mappings":";;;AAIA,MAAMA,wBAAAA,GAA2B;AACjC;;;;;AAKC,UACKC,uBAAAA,GAA0B;AAmDhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BC,UACKC,mBAAAA,GAAsB,CAAC,EAC3BC,KAAK,EACLC,aAAa,EACbC,cAAc,EACdC,QAAQ,EACRC,iBAAiB,EACjBC,YAAY,EACZC,QAAAA,GAAW,KAAK,EACW,GAAA;AAC3BC,IAAAA,KAAAA,CAAMC,SAAS,CAAC,IAAA;QACd,IAAI,CAACR,SAASM,QAAAA,EAAU;YACtB,OAAOG,SAAAA;AACT,QAAA;AAEA,QAAA,MAAMC,SAASC,uBAAAA,CAAwBX,KAAAA,CAAAA;AACvC,QAAA,IAAIU,WAAW,IAAA,EAAM;YACnB,OAAOD,SAAAA;AACT,QAAA;;;QAIA,MAAMG,OAAAA,GAAUC,KAAKC,GAAG,EAAA;AACxB,QAAA,MAAMC,SAAAA,GAAY,IAChB,OAAOX,iBAAAA,KAAsB,cAAcA,iBAAAA,EAAAA,IAAuBQ,OAAAA;;;AAIpE,QAAA,MAAMI,SAAAA,GAAY,IAAA;AAChB,YAAA,MAAMC,cAAcf,cAAAA,IAAAA,IAAsB,IAAA;YAC1C,IAAIe,WAAAA,IAAeA,WAAAA,KAAgBjB,KAAAA,IAASG,QAAAA,EAAU;AACpD,gBAAA,MAAMe,eAAeP,uBAAAA,CAAwBM,WAAAA,CAAAA;gBAC7C,IAAIC,YAAAA,KAAiB,IAAA,IAAQA,YAAAA,GAAeR,MAAAA,EAAQ;oBAClDP,QAAAA,CAASc,WAAAA,CAAAA;oBACT,OAAO,IAAA;AACT,gBAAA;AACF,YAAA;YACA,OAAO,KAAA;AACT,QAAA,CAAA;AAEA,QAAA,MAAME,KAAAA,GAAQ,IAAA;YACZd,YAAAA,EAAAA,CAAgBe,IAAI,CAAC,CAACC,OAAAA,GAAAA;AACpB,gBAAA,IAAI,CAACA,OAAAA,EAAS;;AAEZpB,oBAAAA,aAAAA,IAAAA;AACF,gBAAA;;;AAGF,YAAA,CAAA,CAAA;AACF,QAAA,CAAA;;AAGA,QAAA,MAAMqB,aAAaC,IAAAA,CAAKC,GAAG,CAACd,MAAAA,GAASE,UAAUd,uBAAAA,EAAyB,CAAA,CAAA;QACxE,MAAM2B,cAAAA,GAAiBC,MAAAA,CAAOC,UAAU,CAAC,IAAA;AACvC,YAAA,IAAIX,SAAAA,EAAAA,EAAa;AACf,gBAAA;AACF,YAAA;AACA,YAAA,IAAID,eAAeV,YAAAA,EAAc;AAC/Bc,gBAAAA,KAAAA,EAAAA;AACF,YAAA;QACF,CAAA,EAAGG,UAAAA,CAAAA;;;AAIH,QAAA,MAAMM,kBAAkBL,IAAAA,CAAKC,GAAG,CAACd,MAAAA,GAASE,UAAUf,wBAAAA,EAA0B,CAAA,CAAA;QAC9E,MAAMgC,mBAAAA,GAAsBH,MAAAA,CAAOC,UAAU,CAAC,IAAA;AAC5C,YAAA,IAAIX,SAAAA,EAAAA,EAAa;AACf,gBAAA;AACF,YAAA;AACA,YAAA,IAAID,eAAeV,YAAAA,EAAc;AAC/Bc,gBAAAA,KAAAA,EAAAA;AACF,YAAA;;;;QAIF,CAAA,EAAGS,eAAAA,CAAAA;QAEH,OAAO,IAAA;AACLF,YAAAA,MAAAA,CAAOI,YAAY,CAACL,cAAAA,CAAAA;AACpBC,YAAAA,MAAAA,CAAOI,YAAY,CAACD,mBAAAA,CAAAA;AACtB,QAAA,CAAA;IACF,CAAA,EAAG;AAAC7B,QAAAA,KAAAA;AAAOC,QAAAA,aAAAA;AAAeC,QAAAA,cAAAA;AAAgBC,QAAAA,QAAAA;AAAUC,QAAAA,iBAAAA;AAAmBC,QAAAA,YAAAA;AAAcC,QAAAA;AAAS,KAAA,CAAA;AAChG;;;;"}
|
|
@@ -11,6 +11,7 @@ var lt = require('semver/functions/lt');
|
|
|
11
11
|
var valid = require('semver/functions/valid');
|
|
12
12
|
var LazyOutlet = require('../components/LazyOutlet.js');
|
|
13
13
|
var LeftMenu = require('../components/LeftMenu.js');
|
|
14
|
+
var MediaLibraryBanner = require('../components/MediaLibraryBanner.js');
|
|
14
15
|
var NpsSurvey = require('../components/NpsSurvey.js');
|
|
15
16
|
var PageHelpers = require('../components/PageHelpers.js');
|
|
16
17
|
var PluginsInitializer = require('../components/PluginsInitializer.js');
|
|
@@ -152,6 +153,7 @@ const AdminLayout = ()=>{
|
|
|
152
153
|
},
|
|
153
154
|
children: [
|
|
154
155
|
/*#__PURE__*/ jsxRuntime.jsx(UpsellBanner.UpsellBanner, {}),
|
|
156
|
+
/*#__PURE__*/ jsxRuntime.jsx(MediaLibraryBanner.MediaLibraryBanner, {}),
|
|
155
157
|
/*#__PURE__*/ jsxRuntime.jsx(LazyOutlet.LazyOutlet, {
|
|
156
158
|
suspenseOnly: true
|
|
157
159
|
})
|