From a5c29d2b5558bb9300edc53aa08f0eabfc195f87 Mon Sep 17 00:00:00 2001 From: resq-sw Date: Fri, 15 May 2026 13:07:53 +0000 Subject: [PATCH] docs(typescript): sync API reference for master --- docs.json | 372 +++++++++--------- sdks/typescript/api/README.mdx | 2 +- .../api/analytics/index/classes/Analytics.md | 16 +- .../api/analytics/index/functions/identify.md | 2 +- .../index/functions/inferCookieDomain.md | 2 +- .../index/functions/initAnalytics.md | 2 +- .../api/analytics/index/functions/pageview.md | 2 +- .../api/analytics/index/functions/reset.md | 2 +- .../index/interfaces/AnalyticsConfig.md | 12 +- .../index/interfaces/AnalyticsEvents.md | 2 +- .../index/interfaces/GA4ProviderConfig.md | 6 +- .../index/interfaces/PostHogProviderConfig.md | 10 +- .../analytics/index/variables/analytics.md | 2 +- .../api/analytics/index/variables/track.md | 2 +- .../api/analytics/next/functions/ga4Stream.md | 18 +- .../next/functions/withAnalyticsRewrites.md | 30 +- .../interfaces/AnalyticsRewriteOptions.md | 20 +- .../react/functions/AnalyticsProvider.md | 21 +- .../analytics/react/functions/useAnalytics.md | 15 +- .../interfaces/AnalyticsProviderProps.md | 21 +- .../react/interfaces/UseAnalyticsReturn.md | 28 +- .../resq/functions/resolveResqCookieDomain.md | 6 +- .../analytics/resq/functions/sanitizeGa4Id.md | 2 +- .../resq/variables/GA4_ID_PATTERN.md | 4 +- .../variables/RESQ_SUBDOMAIN_ALLOWLIST.md | 2 +- .../after/after.fn/functions/afterFn.md | 2 +- .../after.types/interfaces/AfterConfig.md | 6 +- .../after.types/interfaces/AfterParams.md | 6 +- .../after.types/type-aliases/AfterFunc.md | 2 +- .../decorators/after/after/functions/after.md | 2 +- .../before/before.fn/functions/beforeFn.md | 2 +- .../before.types/interfaces/BeforeConfig.md | 6 +- .../before/before/functions/before.md | 2 +- .../bind/bind.fn/functions/bindFn.md | 2 +- .../bind/bind.types/interfaces/BindConfig.md | 4 +- .../decorators/bind/bind/functions/bind.md | 2 +- .../debounce.fn/functions/debounceFn.md | 2 +- .../debounce/debounce/functions/debounce.md | 2 +- .../delay/delay.fn/functions/delayFn.md | 2 +- .../decorators/delay/delay/functions/delay.md | 2 +- .../delegate.fn/functions/delegateFn.md | 2 +- .../type-aliases/Delegatable.md | 2 +- .../delegate/delegate/functions/delegate.md | 2 +- .../exec-time.fn/functions/execTimeFn.md | 2 +- .../interfaces/ExactTimeReportData.md | 8 +- .../type-aliases/ExactTimeReportable.md | 2 +- .../type-aliases/ReportFunction.md | 2 +- .../exec-time/exec-time/functions/execTime.md | 2 +- .../execute/execute/functions/selfExecute.md | 2 +- .../functions/memoizeAsyncFn.md | 6 +- .../interfaces/AsyncCache.md | 10 +- .../interfaces/AsyncMemoizeConfig.md | 8 +- .../type-aliases/AsyncMemoizable.md | 2 +- .../memoize-async/functions/memoizeAsync.md | 6 +- .../memoize/memoize.fn/functions/memoizeFn.md | 6 +- .../memoize/memoize.types/interfaces/Cache.md | 10 +- .../memoize.types/interfaces/MemoizeConfig.md | 8 +- .../memoize.types/type-aliases/KeyResolver.md | 2 +- .../memoize.types/type-aliases/Memoizable.md | 2 +- .../memoize/memoize/functions/memoize.md | 6 +- .../type-aliases/ObserverCallback.md | 2 +- .../observer/observer/functions/observe.md | 4 +- .../rate-limit.fn/functions/rateLimitFn.md | 2 +- .../interfaces/RateLimitAsyncCounter.md | 8 +- .../interfaces/RateLimitConfigs.md | 14 +- .../interfaces/RateLimitCounter.md | 8 +- .../type-aliases/RateLimitable.md | 2 +- .../rate-limit/functions/rateLimit.md | 2 +- .../classes/SimpleRateLimitCounter.md | 10 +- .../type-aliases/Readonlyable.md | 2 +- .../readonly/readonly/functions/readonly.md | 2 +- .../classes/ThrottleAsyncExecutor.md | 6 +- .../functions/throttleAsyncFn.md | 2 +- .../throttle-async/functions/throttleAsync.md | 2 +- .../throttle.fn/functions/throttleFn.md | 2 +- .../throttle/throttle/functions/throttle.md | 2 +- .../types/type-aliases/AsyncDecorator.md | 2 +- .../types/type-aliases/AsyncMethod.md | 2 +- .../types/type-aliases/Decorator.md | 2 +- .../decorators/types/type-aliases/Method.md | 2 +- .../api/decorators/utils/classes/Queue.md | 10 +- .../api/decorators/utils/classes/TaskExec.md | 4 +- .../decorators/utils/functions/isFunction.md | 2 +- .../decorators/utils/functions/isNumber.md | 2 +- .../decorators/utils/functions/isPromise.md | 2 +- .../decorators/utils/functions/isString.md | 2 +- .../api/decorators/utils/variables/logger.md | 2 +- .../api/dsa/bloom/classes/BloomFilter.md | 58 ++- .../dsa/count-min/classes/CountMinSketch.md | 56 ++- .../api/dsa/distance/classes/Distance.md | 32 +- .../dsa/distance/interfaces/Coordinates2D.md | 6 +- .../dsa/distance/interfaces/Coordinates3D.md | 8 +- .../distance/interfaces/DistanceOptions.md | 4 +- .../dsa/distance/interfaces/DistanceResult.md | 10 +- .../distance/type-aliases/DistanceFormula.md | 2 +- .../dsa/dsa/rabin-karp/classes/RabinKarp.md | 12 +- .../dsa/rabin-karp/functions/quickSearch.md | 2 +- .../dsa/rabin-karp/interfaces/PatternMatch.md | 10 +- .../rabin-karp/interfaces/RabinKarpOptions.md | 8 +- .../dsa/rabin-karp/interfaces/SearchStats.md | 10 +- .../typescript/api/dsa/graph/classes/Graph.md | 48 +-- .../dsa/graph/functions/addValidatedEdge.md | 2 +- .../dsa/graph/functions/isValidVertexId.md | 2 +- .../api/dsa/graph/interfaces/Edge.md | 8 +- .../api/dsa/graph/interfaces/GraphOptions.md | 4 +- .../api/dsa/graph/interfaces/PathResult.md | 8 +- .../dsa/graph/interfaces/TraversalResult.md | 8 +- .../api/dsa/graph/interfaces/Vertex.md | 8 +- .../api/dsa/heap/classes/BoundedHeap.md | 55 ++- .../api/dsa/heap/interfaces/Distanced.md | 19 +- .../api/dsa/lru-cache/classes/LRUCache.md | 134 ++++++- .../lru-cache/interfaces/LRUCacheOptions.md | 23 +- .../priority-queue/classes/PriorityQueue.md | 34 +- .../functions/createDeadlineQueue.md | 2 +- .../priority-queue/functions/createMaxHeap.md | 2 +- .../priority-queue/functions/createMinHeap.md | 2 +- .../functions/createPriorityLevelQueue.md | 2 +- .../functions/validatePriorityItem.md | 2 +- .../interfaces/PriorityQueueOptions.md | 6 +- .../interfaces/PriorityQueueStats.md | 8 +- .../interfaces/PriorityRequestItem.md | 12 +- .../priority-queue/type-aliases/CompareFn.md | 2 +- .../typescript/api/dsa/queue/classes/Queue.md | 22 +- .../api/dsa/queue/interfaces/QueueNode.md | 6 +- .../dsa/schemas/functions/createValidator.md | 12 +- .../api/dsa/schemas/functions/validate.md | 13 +- .../api/dsa/schemas/functions/validateSafe.md | 17 +- .../api/dsa/schemas/type-aliases/GraphEdge.md | 4 +- .../dsa/schemas/type-aliases/GraphOptions.md | 4 +- .../schemas/type-aliases/PriorityItemInput.md | 4 +- .../type-aliases/PriorityQueueOptions.md | 4 +- .../type-aliases/RabinKarpMultiSearch.md | 4 +- .../schemas/type-aliases/RabinKarpOptions.md | 4 +- .../schemas/type-aliases/RabinKarpSearch.md | 4 +- .../dsa/schemas/type-aliases/TrieInsert.md | 4 +- .../dsa/schemas/type-aliases/TrieOptions.md | 4 +- .../dsa/schemas/type-aliases/TrieSearch.md | 4 +- .../api/dsa/schemas/type-aliases/VertexId.md | 4 +- .../dsa/schemas/variables/GraphEdgeSchema.md | 5 +- .../schemas/variables/GraphOptionsSchema.md | 4 +- .../schemas/variables/PriorityItemSchema.md | 9 +- .../variables/PriorityQueueOptionsSchema.md | 4 +- .../variables/RabinKarpMultiSearchSchema.md | 4 +- .../variables/RabinKarpOptionsSchema.md | 4 +- .../variables/RabinKarpSearchSchema.md | 4 +- .../dsa/schemas/variables/TrieInsertSchema.md | 4 +- .../schemas/variables/TrieOptionsSchema.md | 7 +- .../dsa/schemas/variables/TrieSearchSchema.md | 4 +- .../dsa/schemas/variables/VertexIdSchema.md | 4 +- sdks/typescript/api/dsa/trie/classes/Trie.md | 24 +- .../api/dsa/trie/functions/rabinKarp.md | 2 +- .../dsa/trie/interfaces/TrieSearchResult.md | 8 +- .../api/http/fetcher/classes/FetcherError.md | 34 +- .../fetcher/classes/FetcherValidationError.md | 34 +- .../functions/createApiResponseSchema.md | 13 +- .../functions/createPaginatedSchema.md | 20 +- .../api/http/fetcher/functions/del.md | 7 +- .../api/http/fetcher/functions/fetcher.md | 60 ++- .../api/http/fetcher/functions/get.md | 16 +- .../api/http/fetcher/functions/head.md | 10 +- .../api/http/fetcher/functions/options.md | 8 +- .../api/http/fetcher/functions/patch.md | 7 +- .../api/http/fetcher/functions/post.md | 13 +- .../api/http/fetcher/functions/put.md | 7 +- .../http/fetcher/interfaces/FetcherOptions.md | 18 +- .../api/http/fetcher/type-aliases/Headers.md | 2 +- .../http/fetcher/type-aliases/HttpMethod.md | 2 +- .../http/fetcher/type-aliases/QueryParams.md | 2 +- .../http/fetcher/type-aliases/RequestBody.md | 2 +- .../http/security/functions/getRequestId.md | 27 +- .../functions/shouldRedirectToHttps.md | 41 +- .../logger/logger.decorators/functions/Log.md | 2 +- .../logger.decorators/functions/LogClass.md | 2 +- .../logger.decorators/functions/LogError.md | 2 +- .../logger.decorators/functions/LogTiming.md | 2 +- .../interfaces/LogClassOptions.md | 8 +- .../logger/logger.types/interfaces/LogData.md | 2 +- .../logger.types/interfaces/LogEntry.md | 14 +- .../interfaces/LogErrorOptions.md | 8 +- .../interfaces/LogMethodOptions.md | 10 +- .../interfaces/LogTimingOptions.md | 8 +- .../logger.types/interfaces/LogTransport.md | 6 +- .../logger.types/interfaces/LoggerOptions.md | 12 +- .../logger.types/type-aliases/ColorKey.md | 2 +- .../type-aliases/LogLevelString.md | 2 +- .../api/logger/logger/classes/Logger.md | 28 +- .../logger/logger/enumerations/LogLevel.md | 16 +- .../api/logger/logger/interfaces/LogData.md | 2 +- .../logger/logger/interfaces/LoggerOptions.md | 12 +- .../logger/logger/type-aliases/ColorKey.md | 2 +- .../api/logger/logger/variables/logger.md | 2 +- .../classes/MemoryRateLimitStore.md | 33 +- .../rate-limit/classes/RedisRateLimitStore.md | 51 ++- .../rate-limit/interfaces/IRateLimitStore.md | 28 +- .../type-aliases/RateLimitCheckResult.md | 4 +- .../type-aliases/RateLimitConfig.md | 4 +- .../variables/RATE_LIMIT_PRESETS.md | 27 +- .../variables/RateLimitCheckResultSchema.md | 6 +- .../variables/RateLimitConfigSchema.md | 13 +- .../throttle/classes/KeyedDebounce.md | 62 ++- .../throttle/classes/KeyedThrottle.md | 55 ++- .../throttle/classes/LeakyBucketLimiter.md | 68 +++- .../throttle/classes/SlidingWindowCounter.md | 59 ++- .../throttle/classes/TokenBucketLimiter.md | 65 ++- .../throttle/functions/debounce.md | 2 +- .../throttle/functions/throttle.md | 2 +- .../throttle/type-aliases/DebounceOptions.md | 2 +- .../throttle/type-aliases/KeyedStats.md | 2 +- .../throttle/type-aliases/RateLimiterStats.md | 2 +- .../throttle/type-aliases/ThrottleOptions.md | 2 +- .../variables/DebounceOptionsSchema.md | 2 +- .../throttle/variables/KeyedStatsSchema.md | 2 +- .../variables/RateLimiterStatsSchema.md | 2 +- .../variables/ThrottleOptionsSchema.md | 2 +- .../security/crypto/functions/decryptData.md | 26 +- .../security/crypto/functions/encryptData.md | 35 +- .../crypto/functions/generateSecureToken.md | 19 +- .../api/security/crypto/functions/hashData.md | 20 +- .../security/crypto/functions/maskEmail.md | 19 +- .../api/security/crypto/functions/maskPII.md | 17 +- .../crypto/functions/sanitizeForLogging.md | 34 +- .../security/sanitize/functions/escapeHtml.md | 2 +- .../sanitize/functions/isValidEmail.md | 2 +- .../sanitize/functions/isValidPhone.md | 2 +- .../security/sanitize/functions/isValidSSN.md | 2 +- .../security/sanitize/functions/isValidUrl.md | 2 +- .../sanitize/functions/parseJsonWithSchema.md | 2 +- .../security/sanitize/functions/redactPII.md | 2 +- .../sanitize/functions/redactPIIEffect.md | 2 +- .../sanitize/functions/safeStringify.md | 2 +- .../sanitize/functions/sanitizeJson.md | 2 +- .../sanitize/functions/sanitizeUrl.md | 2 +- .../sanitize/functions/sanitizeUrlEffect.md | 2 +- .../security/sanitize/functions/stripAnsi.md | 2 +- .../sanitize/functions/validateUserInput.md | 2 +- .../functions/validateUserInputEffect.md | 2 +- .../sanitize/type-aliases/CreditCard.md | 2 +- .../security/sanitize/type-aliases/Email.md | 2 +- .../security/sanitize/type-aliases/IPv4.md | 2 +- .../type-aliases/PIIRedactionOptions.md | 2 +- .../sanitize/type-aliases/PhoneNumber.md | 2 +- .../api/security/sanitize/type-aliases/SSN.md | 2 +- .../security/sanitize/type-aliases/SafeUrl.md | 2 +- .../sanitize/type-aliases/SanitizedString.md | 2 +- .../sanitize/type-aliases/UrlProtocol.md | 2 +- .../sanitize/type-aliases/UserInputOptions.md | 2 +- .../sanitize/variables/CreditCardSchema.md | 2 +- .../sanitize/variables/EmailSchema.md | 2 +- .../security/sanitize/variables/IPv4Schema.md | 2 +- .../variables/PIIRedactionOptionsSchema.md | 2 +- .../sanitize/variables/PhoneNumberSchema.md | 2 +- .../security/sanitize/variables/SSNSchema.md | 2 +- .../sanitize/variables/SafeUrlSchema.md | 2 +- .../variables/SanitizedStringSchema.md | 2 +- .../sanitize/variables/UrlProtocolSchema.md | 2 +- .../variables/UserInputOptionsSchema.md | 2 +- .../functions/containsCommandInjection.md | 16 +- .../functions/containsHomoglyphs.md | 16 +- .../functions/containsNoSQLInjection.md | 11 +- .../functions/containsPathTraversal.md | 11 +- .../functions/containsSQLInjection.md | 14 +- .../functions/containsXSSPatterns.md | 23 +- .../functions/detectThreatPatterns.md | 26 +- .../functions/getThreatErrorMessage.md | 12 +- .../validators/functions/isSafeInput.md | 11 +- .../validators/functions/normalizeUnicode.md | 21 +- .../functions/sanitizeForDisplay.md | 17 +- .../validators/functions/validateSafeEmail.md | 12 +- .../validators/functions/validateSafeName.md | 13 +- .../validators/functions/validateSafeText.md | 8 +- .../interfaces/ThreatDetectionConfig.md | 33 +- .../interfaces/ThreatDetectionResult.md | 17 +- .../validators/interfaces/ThreatFinding.md | 17 +- .../validators/type-aliases/ThreatType.md | 5 +- .../variables/THREAT_DETECTED_MESSAGE.md | 6 +- 275 files changed, 2187 insertions(+), 949 deletions(-) diff --git a/docs.json b/docs.json index b79f6dc0..0b9f4e74 100644 --- a/docs.json +++ b/docs.json @@ -73,21 +73,21 @@ "pages": [ "sdks/typescript/api/README", { - "group": "Analytics", + "group": "analytics", "pages": [ "sdks/typescript/api/analytics", { - "group": "Index", + "group": "index", "pages": [ "sdks/typescript/api/analytics/index", { - "group": "Classes", + "group": "classes", "pages": [ "sdks/typescript/api/analytics/index/classes/Analytics" ] }, { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/analytics/index/functions/identify", "sdks/typescript/api/analytics/index/functions/inferCookieDomain", @@ -97,7 +97,7 @@ ] }, { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/analytics/index/interfaces/AnalyticsConfig", "sdks/typescript/api/analytics/index/interfaces/AnalyticsEvents", @@ -106,7 +106,7 @@ ] }, { - "group": "Variables", + "group": "variables", "pages": [ "sdks/typescript/api/analytics/index/variables/analytics", "sdks/typescript/api/analytics/index/variables/track" @@ -115,18 +115,18 @@ ] }, { - "group": "Next", + "group": "next", "pages": [ "sdks/typescript/api/analytics/next", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/analytics/next/functions/ga4Stream", "sdks/typescript/api/analytics/next/functions/withAnalyticsRewrites" ] }, { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/analytics/next/interfaces/AnalyticsRewriteOptions" ] @@ -134,18 +134,18 @@ ] }, { - "group": "React", + "group": "react", "pages": [ "sdks/typescript/api/analytics/react", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/analytics/react/functions/AnalyticsProvider", "sdks/typescript/api/analytics/react/functions/useAnalytics" ] }, { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/analytics/react/interfaces/AnalyticsProviderProps", "sdks/typescript/api/analytics/react/interfaces/UseAnalyticsReturn" @@ -154,18 +154,18 @@ ] }, { - "group": "ResQ", + "group": "resq", "pages": [ "sdks/typescript/api/analytics/resq", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/analytics/resq/functions/resolveResqCookieDomain", "sdks/typescript/api/analytics/resq/functions/sanitizeGa4Id" ] }, { - "group": "Variables", + "group": "variables", "pages": [ "sdks/typescript/api/analytics/resq/variables/GA4_ID_PATTERN", "sdks/typescript/api/analytics/resq/variables/RESQ_SUBDOMAIN_ALLOWLIST" @@ -176,19 +176,19 @@ ] }, { - "group": "Decorators", + "group": "decorators", "pages": [ "sdks/typescript/api/decorators", { - "group": "After", + "group": "after", "pages": [ "sdks/typescript/api/decorators/after", { - "group": "After", + "group": "after", "pages": [ "sdks/typescript/api/decorators/after/after", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/after/after/functions/after" ] @@ -200,7 +200,7 @@ "pages": [ "sdks/typescript/api/decorators/after/after.fn", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/after/after.fn/functions/afterFn" ] @@ -212,14 +212,14 @@ "pages": [ "sdks/typescript/api/decorators/after/after.types", { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/decorators/after/after.types/interfaces/AfterConfig", "sdks/typescript/api/decorators/after/after.types/interfaces/AfterParams" ] }, { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/decorators/after/after.types/type-aliases/AfterFunc" ] @@ -229,15 +229,15 @@ ] }, { - "group": "Before", + "group": "before", "pages": [ "sdks/typescript/api/decorators/before", { - "group": "Before", + "group": "before", "pages": [ "sdks/typescript/api/decorators/before/before", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/before/before/functions/before" ] @@ -249,7 +249,7 @@ "pages": [ "sdks/typescript/api/decorators/before/before.fn", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/before/before.fn/functions/beforeFn" ] @@ -261,7 +261,7 @@ "pages": [ "sdks/typescript/api/decorators/before/before.types", { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/decorators/before/before.types/interfaces/BeforeConfig" ] @@ -271,15 +271,15 @@ ] }, { - "group": "Bind", + "group": "bind", "pages": [ "sdks/typescript/api/decorators/bind", { - "group": "Bind", + "group": "bind", "pages": [ "sdks/typescript/api/decorators/bind/bind", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/bind/bind/functions/bind" ] @@ -291,7 +291,7 @@ "pages": [ "sdks/typescript/api/decorators/bind/bind.fn", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/bind/bind.fn/functions/bindFn" ] @@ -303,7 +303,7 @@ "pages": [ "sdks/typescript/api/decorators/bind/bind.types", { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/decorators/bind/bind.types/interfaces/BindConfig" ] @@ -313,15 +313,15 @@ ] }, { - "group": "Debounce", + "group": "debounce", "pages": [ "sdks/typescript/api/decorators/debounce", { - "group": "Debounce", + "group": "debounce", "pages": [ "sdks/typescript/api/decorators/debounce/debounce", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/debounce/debounce/functions/debounce" ] @@ -333,7 +333,7 @@ "pages": [ "sdks/typescript/api/decorators/debounce/debounce.fn", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/debounce/debounce.fn/functions/debounceFn" ] @@ -343,15 +343,15 @@ ] }, { - "group": "Delay", + "group": "delay", "pages": [ "sdks/typescript/api/decorators/delay", { - "group": "Delay", + "group": "delay", "pages": [ "sdks/typescript/api/decorators/delay/delay", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/delay/delay/functions/delay" ] @@ -363,7 +363,7 @@ "pages": [ "sdks/typescript/api/decorators/delay/delay.fn", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/delay/delay.fn/functions/delayFn" ] @@ -373,15 +373,15 @@ ] }, { - "group": "Delegate", + "group": "delegate", "pages": [ "sdks/typescript/api/decorators/delegate", { - "group": "Delegate", + "group": "delegate", "pages": [ "sdks/typescript/api/decorators/delegate/delegate", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/delegate/delegate/functions/delegate" ] @@ -393,7 +393,7 @@ "pages": [ "sdks/typescript/api/decorators/delegate/delegate.fn", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/delegate/delegate.fn/functions/delegateFn" ] @@ -405,7 +405,7 @@ "pages": [ "sdks/typescript/api/decorators/delegate/delegate.types", { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/decorators/delegate/delegate.types/type-aliases/Delegatable" ] @@ -415,15 +415,15 @@ ] }, { - "group": "Exec Time", + "group": "exec-time", "pages": [ "sdks/typescript/api/decorators/exec-time", { - "group": "Exec Time", + "group": "exec-time", "pages": [ "sdks/typescript/api/decorators/exec-time/exec-time", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/exec-time/exec-time/functions/execTime" ] @@ -435,7 +435,7 @@ "pages": [ "sdks/typescript/api/decorators/exec-time/exec-time.fn", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/exec-time/exec-time.fn/functions/execTimeFn" ] @@ -447,13 +447,13 @@ "pages": [ "sdks/typescript/api/decorators/exec-time/exec-time.types", { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/decorators/exec-time/exec-time.types/interfaces/ExactTimeReportData" ] }, { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/decorators/exec-time/exec-time.types/type-aliases/ExactTimeReportable", "sdks/typescript/api/decorators/exec-time/exec-time.types/type-aliases/ReportFunction" @@ -464,15 +464,15 @@ ] }, { - "group": "Execute", + "group": "execute", "pages": [ "sdks/typescript/api/decorators/execute", { - "group": "Execute", + "group": "execute", "pages": [ "sdks/typescript/api/decorators/execute/execute", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/execute/execute/functions/selfExecute" ] @@ -482,21 +482,21 @@ ] }, { - "group": "Index", + "group": "index", "pages": [ "sdks/typescript/api/decorators/index" ] }, { - "group": "Memoize", + "group": "memoize", "pages": [ "sdks/typescript/api/decorators/memoize", { - "group": "Memoize", + "group": "memoize", "pages": [ "sdks/typescript/api/decorators/memoize/memoize", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/memoize/memoize/functions/memoize" ] @@ -508,7 +508,7 @@ "pages": [ "sdks/typescript/api/decorators/memoize/memoize.fn", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/memoize/memoize.fn/functions/memoizeFn" ] @@ -520,14 +520,14 @@ "pages": [ "sdks/typescript/api/decorators/memoize/memoize.types", { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/decorators/memoize/memoize.types/interfaces/Cache", "sdks/typescript/api/decorators/memoize/memoize.types/interfaces/MemoizeConfig" ] }, { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/decorators/memoize/memoize.types/type-aliases/KeyResolver", "sdks/typescript/api/decorators/memoize/memoize.types/type-aliases/Memoizable" @@ -538,15 +538,15 @@ ] }, { - "group": "Memoize Async", + "group": "memoize-async", "pages": [ "sdks/typescript/api/decorators/memoize-async", { - "group": "Memoize Async", + "group": "memoize-async", "pages": [ "sdks/typescript/api/decorators/memoize-async/memoize-async", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/memoize-async/memoize-async/functions/memoizeAsync" ] @@ -558,7 +558,7 @@ "pages": [ "sdks/typescript/api/decorators/memoize-async/memoize-async.fn", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/memoize-async/memoize-async.fn/functions/memoizeAsyncFn" ] @@ -570,14 +570,14 @@ "pages": [ "sdks/typescript/api/decorators/memoize-async/memoize-async.types", { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/decorators/memoize-async/memoize-async.types/interfaces/AsyncCache", "sdks/typescript/api/decorators/memoize-async/memoize-async.types/interfaces/AsyncMemoizeConfig" ] }, { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/decorators/memoize-async/memoize-async.types/type-aliases/AsyncMemoizable" ] @@ -587,15 +587,15 @@ ] }, { - "group": "Observer", + "group": "observer", "pages": [ "sdks/typescript/api/decorators/observer", { - "group": "Observer", + "group": "observer", "pages": [ "sdks/typescript/api/decorators/observer/observer", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/observer/observer/functions/observe" ] @@ -607,7 +607,7 @@ "pages": [ "sdks/typescript/api/decorators/observer/observer.types", { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/decorators/observer/observer.types/type-aliases/ObserverCallback" ] @@ -617,15 +617,15 @@ ] }, { - "group": "Rate Limit", + "group": "rate-limit", "pages": [ "sdks/typescript/api/decorators/rate-limit", { - "group": "Rate Limit", + "group": "rate-limit", "pages": [ "sdks/typescript/api/decorators/rate-limit/rate-limit", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/rate-limit/rate-limit/functions/rateLimit" ] @@ -637,7 +637,7 @@ "pages": [ "sdks/typescript/api/decorators/rate-limit/rate-limit.fn", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/rate-limit/rate-limit.fn/functions/rateLimitFn" ] @@ -649,7 +649,7 @@ "pages": [ "sdks/typescript/api/decorators/rate-limit/rate-limit.types", { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/decorators/rate-limit/rate-limit.types/interfaces/RateLimitAsyncCounter", "sdks/typescript/api/decorators/rate-limit/rate-limit.types/interfaces/RateLimitConfigs", @@ -657,7 +657,7 @@ ] }, { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/decorators/rate-limit/rate-limit.types/type-aliases/RateLimitable" ] @@ -665,11 +665,11 @@ ] }, { - "group": "Simple Rate Limit Counter", + "group": "simple-rate-limit-counter", "pages": [ "sdks/typescript/api/decorators/rate-limit/simple-rate-limit-counter", { - "group": "Classes", + "group": "classes", "pages": [ "sdks/typescript/api/decorators/rate-limit/simple-rate-limit-counter/classes/SimpleRateLimitCounter" ] @@ -679,15 +679,15 @@ ] }, { - "group": "Readonly", + "group": "readonly", "pages": [ "sdks/typescript/api/decorators/readonly", { - "group": "Readonly", + "group": "readonly", "pages": [ "sdks/typescript/api/decorators/readonly/readonly", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/readonly/readonly/functions/readonly" ] @@ -699,7 +699,7 @@ "pages": [ "sdks/typescript/api/decorators/readonly/readonly.types", { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/decorators/readonly/readonly.types/type-aliases/Readonlyable" ] @@ -709,15 +709,15 @@ ] }, { - "group": "Throttle", + "group": "throttle", "pages": [ "sdks/typescript/api/decorators/throttle", { - "group": "Throttle", + "group": "throttle", "pages": [ "sdks/typescript/api/decorators/throttle/throttle", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/throttle/throttle/functions/throttle" ] @@ -729,7 +729,7 @@ "pages": [ "sdks/typescript/api/decorators/throttle/throttle.fn", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/throttle/throttle.fn/functions/throttleFn" ] @@ -739,15 +739,15 @@ ] }, { - "group": "Throttle Async", + "group": "throttle-async", "pages": [ "sdks/typescript/api/decorators/throttle-async", { - "group": "Throttle Async", + "group": "throttle-async", "pages": [ "sdks/typescript/api/decorators/throttle-async/throttle-async", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/throttle-async/throttle-async/functions/throttleAsync" ] @@ -755,11 +755,11 @@ ] }, { - "group": "Throttle Async Executor", + "group": "throttle-async-executor", "pages": [ "sdks/typescript/api/decorators/throttle-async/throttle-async-executor", { - "group": "Classes", + "group": "classes", "pages": [ "sdks/typescript/api/decorators/throttle-async/throttle-async-executor/classes/ThrottleAsyncExecutor" ] @@ -771,7 +771,7 @@ "pages": [ "sdks/typescript/api/decorators/throttle-async/throttle-async.fn", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/throttle-async/throttle-async.fn/functions/throttleAsyncFn" ] @@ -781,11 +781,11 @@ ] }, { - "group": "Types", + "group": "types", "pages": [ "sdks/typescript/api/decorators/types", { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/decorators/types/type-aliases/AsyncDecorator", "sdks/typescript/api/decorators/types/type-aliases/AsyncMethod", @@ -796,18 +796,18 @@ ] }, { - "group": "Utils", + "group": "utils", "pages": [ "sdks/typescript/api/decorators/utils", { - "group": "Classes", + "group": "classes", "pages": [ "sdks/typescript/api/decorators/utils/classes/Queue", "sdks/typescript/api/decorators/utils/classes/TaskExec" ] }, { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/decorators/utils/functions/isFunction", "sdks/typescript/api/decorators/utils/functions/isNumber", @@ -816,7 +816,7 @@ ] }, { - "group": "Variables", + "group": "variables", "pages": [ "sdks/typescript/api/decorators/utils/variables/logger" ] @@ -826,15 +826,15 @@ ] }, { - "group": "DSA", + "group": "dsa", "pages": [ "sdks/typescript/api/dsa", { - "group": "Bloom", + "group": "bloom", "pages": [ "sdks/typescript/api/dsa/bloom", { - "group": "Classes", + "group": "classes", "pages": [ "sdks/typescript/api/dsa/bloom/classes/BloomFilter" ] @@ -842,11 +842,11 @@ ] }, { - "group": "Count Min", + "group": "count-min", "pages": [ "sdks/typescript/api/dsa/count-min", { - "group": "Classes", + "group": "classes", "pages": [ "sdks/typescript/api/dsa/count-min/classes/CountMinSketch" ] @@ -854,17 +854,17 @@ ] }, { - "group": "Distance", + "group": "distance", "pages": [ "sdks/typescript/api/dsa/distance", { - "group": "Classes", + "group": "classes", "pages": [ "sdks/typescript/api/dsa/distance/classes/Distance" ] }, { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/dsa/distance/interfaces/Coordinates2D", "sdks/typescript/api/dsa/distance/interfaces/Coordinates3D", @@ -873,7 +873,7 @@ ] }, { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/dsa/distance/type-aliases/DistanceFormula" ] @@ -881,26 +881,26 @@ ] }, { - "group": "DSA", + "group": "dsa", "pages": [ { - "group": "Rabin Karp", + "group": "rabin-karp", "pages": [ "sdks/typescript/api/dsa/dsa/rabin-karp", { - "group": "Classes", + "group": "classes", "pages": [ "sdks/typescript/api/dsa/dsa/rabin-karp/classes/RabinKarp" ] }, { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/dsa/dsa/rabin-karp/functions/quickSearch" ] }, { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/dsa/dsa/rabin-karp/interfaces/PatternMatch", "sdks/typescript/api/dsa/dsa/rabin-karp/interfaces/RabinKarpOptions", @@ -912,24 +912,24 @@ ] }, { - "group": "Graph", + "group": "graph", "pages": [ "sdks/typescript/api/dsa/graph", { - "group": "Classes", + "group": "classes", "pages": [ "sdks/typescript/api/dsa/graph/classes/Graph" ] }, { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/dsa/graph/functions/addValidatedEdge", "sdks/typescript/api/dsa/graph/functions/isValidVertexId" ] }, { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/dsa/graph/interfaces/Edge", "sdks/typescript/api/dsa/graph/interfaces/GraphOptions", @@ -941,17 +941,17 @@ ] }, { - "group": "Heap", + "group": "heap", "pages": [ "sdks/typescript/api/dsa/heap", { - "group": "Classes", + "group": "classes", "pages": [ "sdks/typescript/api/dsa/heap/classes/BoundedHeap" ] }, { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/dsa/heap/interfaces/Distanced" ] @@ -959,23 +959,23 @@ ] }, { - "group": "Index", + "group": "index", "pages": [ "sdks/typescript/api/dsa/index" ] }, { - "group": "Lru Cache", + "group": "lru-cache", "pages": [ "sdks/typescript/api/dsa/lru-cache", { - "group": "Classes", + "group": "classes", "pages": [ "sdks/typescript/api/dsa/lru-cache/classes/LRUCache" ] }, { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/dsa/lru-cache/interfaces/LRUCacheOptions" ] @@ -983,17 +983,17 @@ ] }, { - "group": "Priority Queue", + "group": "priority-queue", "pages": [ "sdks/typescript/api/dsa/priority-queue", { - "group": "Classes", + "group": "classes", "pages": [ "sdks/typescript/api/dsa/priority-queue/classes/PriorityQueue" ] }, { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/dsa/priority-queue/functions/createDeadlineQueue", "sdks/typescript/api/dsa/priority-queue/functions/createMaxHeap", @@ -1003,7 +1003,7 @@ ] }, { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/dsa/priority-queue/interfaces/PriorityQueueOptions", "sdks/typescript/api/dsa/priority-queue/interfaces/PriorityQueueStats", @@ -1011,7 +1011,7 @@ ] }, { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/dsa/priority-queue/type-aliases/CompareFn" ] @@ -1019,17 +1019,17 @@ ] }, { - "group": "Queue", + "group": "queue", "pages": [ "sdks/typescript/api/dsa/queue", { - "group": "Classes", + "group": "classes", "pages": [ "sdks/typescript/api/dsa/queue/classes/Queue" ] }, { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/dsa/queue/interfaces/QueueNode" ] @@ -1037,11 +1037,11 @@ ] }, { - "group": "Schemas", + "group": "schemas", "pages": [ "sdks/typescript/api/dsa/schemas", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/dsa/schemas/functions/createValidator", "sdks/typescript/api/dsa/schemas/functions/validate", @@ -1049,7 +1049,7 @@ ] }, { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/dsa/schemas/type-aliases/GraphEdge", "sdks/typescript/api/dsa/schemas/type-aliases/GraphOptions", @@ -1065,7 +1065,7 @@ ] }, { - "group": "Variables", + "group": "variables", "pages": [ "sdks/typescript/api/dsa/schemas/variables/GraphEdgeSchema", "sdks/typescript/api/dsa/schemas/variables/GraphOptionsSchema", @@ -1083,23 +1083,23 @@ ] }, { - "group": "Trie", + "group": "trie", "pages": [ "sdks/typescript/api/dsa/trie", { - "group": "Classes", + "group": "classes", "pages": [ "sdks/typescript/api/dsa/trie/classes/Trie" ] }, { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/dsa/trie/functions/rabinKarp" ] }, { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/dsa/trie/interfaces/TrieSearchResult" ] @@ -1109,22 +1109,22 @@ ] }, { - "group": "HTTP", + "group": "http", "pages": [ "sdks/typescript/api/http", { - "group": "Fetcher", + "group": "fetcher", "pages": [ "sdks/typescript/api/http/fetcher", { - "group": "Classes", + "group": "classes", "pages": [ "sdks/typescript/api/http/fetcher/classes/FetcherError", "sdks/typescript/api/http/fetcher/classes/FetcherValidationError" ] }, { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/http/fetcher/functions/createApiResponseSchema", "sdks/typescript/api/http/fetcher/functions/createPaginatedSchema", @@ -1139,13 +1139,13 @@ ] }, { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/http/fetcher/interfaces/FetcherOptions" ] }, { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/http/fetcher/type-aliases/Headers", "sdks/typescript/api/http/fetcher/type-aliases/HttpMethod", @@ -1156,17 +1156,17 @@ ] }, { - "group": "Index", + "group": "index", "pages": [ "sdks/typescript/api/http/index" ] }, { - "group": "Security", + "group": "security", "pages": [ "sdks/typescript/api/http/security", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/http/security/functions/getRequestId", "sdks/typescript/api/http/security/functions/shouldRedirectToHttps" @@ -1177,46 +1177,46 @@ ] }, { - "group": "Logger", + "group": "logger", "pages": [ "sdks/typescript/api/logger", { - "group": "Index", + "group": "index", "pages": [ "sdks/typescript/api/logger/index" ] }, { - "group": "Logger", + "group": "logger", "pages": [ "sdks/typescript/api/logger/logger", { - "group": "Classes", + "group": "classes", "pages": [ "sdks/typescript/api/logger/logger/classes/Logger" ] }, { - "group": "Enumerations", + "group": "enumerations", "pages": [ "sdks/typescript/api/logger/logger/enumerations/LogLevel" ] }, { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/logger/logger/interfaces/LogData", "sdks/typescript/api/logger/logger/interfaces/LoggerOptions" ] }, { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/logger/logger/type-aliases/ColorKey" ] }, { - "group": "Variables", + "group": "variables", "pages": [ "sdks/typescript/api/logger/logger/variables/logger" ] @@ -1228,7 +1228,7 @@ "pages": [ "sdks/typescript/api/logger/logger.decorators", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/logger/logger.decorators/functions/Log", "sdks/typescript/api/logger/logger.decorators/functions/LogClass", @@ -1243,7 +1243,7 @@ "pages": [ "sdks/typescript/api/logger/logger.types", { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/logger/logger.types/interfaces/LogClassOptions", "sdks/typescript/api/logger/logger.types/interfaces/LogData", @@ -1256,7 +1256,7 @@ ] }, { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/logger/logger.types/type-aliases/ColorKey", "sdks/typescript/api/logger/logger.types/type-aliases/LogLevelString" @@ -1267,41 +1267,41 @@ ] }, { - "group": "Rate Limiting", + "group": "rate-limiting", "pages": [ "sdks/typescript/api/rate-limiting", { - "group": "Index", + "group": "index", "pages": [ "sdks/typescript/api/rate-limiting/index" ] }, { - "group": "Rate Limit", + "group": "rate-limit", "pages": [ "sdks/typescript/api/rate-limiting/rate-limit", { - "group": "Classes", + "group": "classes", "pages": [ "sdks/typescript/api/rate-limiting/rate-limit/classes/MemoryRateLimitStore", "sdks/typescript/api/rate-limiting/rate-limit/classes/RedisRateLimitStore" ] }, { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/rate-limiting/rate-limit/interfaces/IRateLimitStore" ] }, { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/rate-limiting/rate-limit/type-aliases/RateLimitCheckResult", "sdks/typescript/api/rate-limiting/rate-limit/type-aliases/RateLimitConfig" ] }, { - "group": "Variables", + "group": "variables", "pages": [ "sdks/typescript/api/rate-limiting/rate-limit/variables/RATE_LIMIT_PRESETS", "sdks/typescript/api/rate-limiting/rate-limit/variables/RateLimitCheckResultSchema", @@ -1311,11 +1311,11 @@ ] }, { - "group": "Throttle", + "group": "throttle", "pages": [ "sdks/typescript/api/rate-limiting/throttle", { - "group": "Classes", + "group": "classes", "pages": [ "sdks/typescript/api/rate-limiting/throttle/classes/KeyedDebounce", "sdks/typescript/api/rate-limiting/throttle/classes/KeyedThrottle", @@ -1325,14 +1325,14 @@ ] }, { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/rate-limiting/throttle/functions/debounce", "sdks/typescript/api/rate-limiting/throttle/functions/throttle" ] }, { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/rate-limiting/throttle/type-aliases/DebounceOptions", "sdks/typescript/api/rate-limiting/throttle/type-aliases/KeyedStats", @@ -1341,7 +1341,7 @@ ] }, { - "group": "Variables", + "group": "variables", "pages": [ "sdks/typescript/api/rate-limiting/throttle/variables/DebounceOptionsSchema", "sdks/typescript/api/rate-limiting/throttle/variables/KeyedStatsSchema", @@ -1354,15 +1354,15 @@ ] }, { - "group": "Security", + "group": "security", "pages": [ "sdks/typescript/api/security", { - "group": "Crypto", + "group": "crypto", "pages": [ "sdks/typescript/api/security/crypto", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/security/crypto/functions/decryptData", "sdks/typescript/api/security/crypto/functions/encryptData", @@ -1376,17 +1376,17 @@ ] }, { - "group": "Index", + "group": "index", "pages": [ "sdks/typescript/api/security/index" ] }, { - "group": "Sanitize", + "group": "sanitize", "pages": [ "sdks/typescript/api/security/sanitize", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/security/sanitize/functions/escapeHtml", "sdks/typescript/api/security/sanitize/functions/isValidEmail", @@ -1406,7 +1406,7 @@ ] }, { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/security/sanitize/type-aliases/CreditCard", "sdks/typescript/api/security/sanitize/type-aliases/Email", @@ -1421,7 +1421,7 @@ ] }, { - "group": "Variables", + "group": "variables", "pages": [ "sdks/typescript/api/security/sanitize/variables/CreditCardSchema", "sdks/typescript/api/security/sanitize/variables/EmailSchema", @@ -1438,11 +1438,11 @@ ] }, { - "group": "Validators", + "group": "validators", "pages": [ "sdks/typescript/api/security/validators", { - "group": "Functions", + "group": "functions", "pages": [ "sdks/typescript/api/security/validators/functions/containsCommandInjection", "sdks/typescript/api/security/validators/functions/containsHomoglyphs", @@ -1461,7 +1461,7 @@ ] }, { - "group": "Interfaces", + "group": "interfaces", "pages": [ "sdks/typescript/api/security/validators/interfaces/ThreatDetectionConfig", "sdks/typescript/api/security/validators/interfaces/ThreatDetectionResult", @@ -1469,13 +1469,13 @@ ] }, { - "group": "Type Aliases", + "group": "type-aliases", "pages": [ "sdks/typescript/api/security/validators/type-aliases/ThreatType" ] }, { - "group": "Variables", + "group": "variables", "pages": [ "sdks/typescript/api/security/validators/variables/THREAT_DETECTED_MESSAGE" ] @@ -2554,4 +2554,4 @@ "website": "https://resq.software" } } -} +} \ No newline at end of file diff --git a/sdks/typescript/api/README.mdx b/sdks/typescript/api/README.mdx index a1e1da3c..508080ed 100644 --- a/sdks/typescript/api/README.mdx +++ b/sdks/typescript/api/README.mdx @@ -4,7 +4,7 @@ Auto-generated reference for [`resq-software/npm`](https://github.com/resq-softw ## Packages -- `@resq-sw/analytics` — `v0.3.0` +- `@resq-sw/analytics` — `v0.4.0` - `@resq-sw/decorators` — `v0.1.1` - `@resq-sw/dsa` — `v0.1.0` - `@resq-sw/http` — `v0.1.1` diff --git a/sdks/typescript/api/analytics/index/classes/Analytics.md b/sdks/typescript/api/analytics/index/classes/Analytics.md index 42f584be..758f3938 100644 --- a/sdks/typescript/api/analytics/index/classes/Analytics.md +++ b/sdks/typescript/api/analytics/index/classes/Analytics.md @@ -1,6 +1,6 @@ # Class: Analytics -Defined in: [index.ts:111](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L111) +Defined in: [index.ts:111](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L111) ## Constructors @@ -20,7 +20,7 @@ Defined in: [index.ts:111](https://github.com/resq-software/npm/blob/f2ab5fc82f4 > **get** **config**(): `Readonly`\<[`AnalyticsConfig`](../interfaces/AnalyticsConfig)\> \| `null` -Defined in: [index.ts:116](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L116) +Defined in: [index.ts:116](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L116) ##### Returns @@ -34,7 +34,7 @@ Defined in: [index.ts:116](https://github.com/resq-software/npm/blob/f2ab5fc82f4 > **get** **posthog**(): `PostHog` \| `null` -Defined in: [index.ts:120](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L120) +Defined in: [index.ts:120](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L120) ##### Returns @@ -46,7 +46,7 @@ Defined in: [index.ts:120](https://github.com/resq-software/npm/blob/f2ab5fc82f4 > **identify**(`userId`, `traits?`): `void` -Defined in: [index.ts:181](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L181) +Defined in: [index.ts:181](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L181) #### Parameters @@ -68,7 +68,7 @@ Defined in: [index.ts:181](https://github.com/resq-software/npm/blob/f2ab5fc82f4 > **init**(`config`): `Promise`\<`void`\> -Defined in: [index.ts:124](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L124) +Defined in: [index.ts:124](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L124) #### Parameters @@ -86,7 +86,7 @@ Defined in: [index.ts:124](https://github.com/resq-software/npm/blob/f2ab5fc82f4 > **pageview**(`url?`): `void` -Defined in: [index.ts:211](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L211) +Defined in: [index.ts:211](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L211) Manually emit a pageview. Most consumers do **not** need to call this: PostHog's `capture_pageview: "history_change"` (set in init) auto-captures @@ -110,7 +110,7 @@ for first-paint pageviews before init has resolved. > **reset**(): `void` -Defined in: [index.ts:194](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L194) +Defined in: [index.ts:194](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L194) #### Returns @@ -122,7 +122,7 @@ Defined in: [index.ts:194](https://github.com/resq-software/npm/blob/f2ab5fc82f4 > **track**\<`E`\>(`event`, `properties?`): `void` -Defined in: [index.ts:166](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L166) +Defined in: [index.ts:166](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L166) #### Type Parameters diff --git a/sdks/typescript/api/analytics/index/functions/identify.md b/sdks/typescript/api/analytics/index/functions/identify.md index fca8b6b3..6d9cc46f 100644 --- a/sdks/typescript/api/analytics/index/functions/identify.md +++ b/sdks/typescript/api/analytics/index/functions/identify.md @@ -2,7 +2,7 @@ > **identify**(`userId`, `traits?`): `void` -Defined in: [index.ts:226](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L226) +Defined in: [index.ts:226](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L226) ## Parameters diff --git a/sdks/typescript/api/analytics/index/functions/inferCookieDomain.md b/sdks/typescript/api/analytics/index/functions/inferCookieDomain.md index 9e8b6ad7..46947c67 100644 --- a/sdks/typescript/api/analytics/index/functions/inferCookieDomain.md +++ b/sdks/typescript/api/analytics/index/functions/inferCookieDomain.md @@ -2,7 +2,7 @@ > **inferCookieDomain**(`domains`): `string` \| `undefined` -Defined in: [index.ts:243](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L243) +Defined in: [index.ts:243](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L243) ## Parameters diff --git a/sdks/typescript/api/analytics/index/functions/initAnalytics.md b/sdks/typescript/api/analytics/index/functions/initAnalytics.md index 326106f8..1e303975 100644 --- a/sdks/typescript/api/analytics/index/functions/initAnalytics.md +++ b/sdks/typescript/api/analytics/index/functions/initAnalytics.md @@ -2,7 +2,7 @@ > **initAnalytics**(`config`): `Promise`\<`void`\> -Defined in: [index.ts:222](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L222) +Defined in: [index.ts:222](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L222) ## Parameters diff --git a/sdks/typescript/api/analytics/index/functions/pageview.md b/sdks/typescript/api/analytics/index/functions/pageview.md index 15d587c0..b46d4412 100644 --- a/sdks/typescript/api/analytics/index/functions/pageview.md +++ b/sdks/typescript/api/analytics/index/functions/pageview.md @@ -2,7 +2,7 @@ > **pageview**(`url?`): `void` -Defined in: [index.ts:231](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L231) +Defined in: [index.ts:231](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L231) ## Parameters diff --git a/sdks/typescript/api/analytics/index/functions/reset.md b/sdks/typescript/api/analytics/index/functions/reset.md index 4d2eaf0a..b25e2b18 100644 --- a/sdks/typescript/api/analytics/index/functions/reset.md +++ b/sdks/typescript/api/analytics/index/functions/reset.md @@ -2,7 +2,7 @@ > **reset**(): `void` -Defined in: [index.ts:229](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L229) +Defined in: [index.ts:229](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L229) ## Returns diff --git a/sdks/typescript/api/analytics/index/interfaces/AnalyticsConfig.md b/sdks/typescript/api/analytics/index/interfaces/AnalyticsConfig.md index a1349eba..8c175309 100644 --- a/sdks/typescript/api/analytics/index/interfaces/AnalyticsConfig.md +++ b/sdks/typescript/api/analytics/index/interfaces/AnalyticsConfig.md @@ -1,6 +1,6 @@ # Interface: AnalyticsConfig -Defined in: [index.ts:50](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L50) +Defined in: [index.ts:50](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L50) ## Properties @@ -8,7 +8,7 @@ Defined in: [index.ts:50](https://github.com/resq-software/npm/blob/f2ab5fc82f4f > `optional` **cookieDomain?**: `string` -Defined in: [index.ts:53](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L53) +Defined in: [index.ts:53](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L53) *** @@ -16,7 +16,7 @@ Defined in: [index.ts:53](https://github.com/resq-software/npm/blob/f2ab5fc82f4f > `optional` **debug?**: `boolean` -Defined in: [index.ts:55](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L55) +Defined in: [index.ts:55](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L55) *** @@ -24,7 +24,7 @@ Defined in: [index.ts:55](https://github.com/resq-software/npm/blob/f2ab5fc82f4f > `optional` **disabled?**: `boolean` -Defined in: [index.ts:54](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L54) +Defined in: [index.ts:54](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L54) *** @@ -32,7 +32,7 @@ Defined in: [index.ts:54](https://github.com/resq-software/npm/blob/f2ab5fc82f4f > `optional` **ga4?**: [`GA4ProviderConfig`](./GA4ProviderConfig) -Defined in: [index.ts:52](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L52) +Defined in: [index.ts:52](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L52) *** @@ -40,4 +40,4 @@ Defined in: [index.ts:52](https://github.com/resq-software/npm/blob/f2ab5fc82f4f > `optional` **posthog?**: [`PostHogProviderConfig`](./PostHogProviderConfig) -Defined in: [index.ts:51](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L51) +Defined in: [index.ts:51](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L51) diff --git a/sdks/typescript/api/analytics/index/interfaces/AnalyticsEvents.md b/sdks/typescript/api/analytics/index/interfaces/AnalyticsEvents.md index d431b09c..4f621333 100644 --- a/sdks/typescript/api/analytics/index/interfaces/AnalyticsEvents.md +++ b/sdks/typescript/api/analytics/index/interfaces/AnalyticsEvents.md @@ -1,6 +1,6 @@ # Interface: AnalyticsEvents -Defined in: [index.ts:34](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L34) +Defined in: [index.ts:34](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L34) Augmentable typed event registry. Consumers extend this via module augmentation to get type-safe `track()` calls: diff --git a/sdks/typescript/api/analytics/index/interfaces/GA4ProviderConfig.md b/sdks/typescript/api/analytics/index/interfaces/GA4ProviderConfig.md index a744ee14..a52ff58d 100644 --- a/sdks/typescript/api/analytics/index/interfaces/GA4ProviderConfig.md +++ b/sdks/typescript/api/analytics/index/interfaces/GA4ProviderConfig.md @@ -1,6 +1,6 @@ # Interface: GA4ProviderConfig -Defined in: [index.ts:45](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L45) +Defined in: [index.ts:45](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L45) ## Properties @@ -8,7 +8,7 @@ Defined in: [index.ts:45](https://github.com/resq-software/npm/blob/f2ab5fc82f4f > `optional` **domains?**: `string`[] -Defined in: [index.ts:47](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L47) +Defined in: [index.ts:47](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L47) *** @@ -16,4 +16,4 @@ Defined in: [index.ts:47](https://github.com/resq-software/npm/blob/f2ab5fc82f4f > **measurementId**: `string` -Defined in: [index.ts:46](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L46) +Defined in: [index.ts:46](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L46) diff --git a/sdks/typescript/api/analytics/index/interfaces/PostHogProviderConfig.md b/sdks/typescript/api/analytics/index/interfaces/PostHogProviderConfig.md index 7cce70b2..55ba7480 100644 --- a/sdks/typescript/api/analytics/index/interfaces/PostHogProviderConfig.md +++ b/sdks/typescript/api/analytics/index/interfaces/PostHogProviderConfig.md @@ -1,6 +1,6 @@ # Interface: PostHogProviderConfig -Defined in: [index.ts:38](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L38) +Defined in: [index.ts:38](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L38) ## Properties @@ -8,7 +8,7 @@ Defined in: [index.ts:38](https://github.com/resq-software/npm/blob/f2ab5fc82f4f > `optional` **host?**: `string` -Defined in: [index.ts:40](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L40) +Defined in: [index.ts:40](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L40) *** @@ -16,7 +16,7 @@ Defined in: [index.ts:40](https://github.com/resq-software/npm/blob/f2ab5fc82f4f > **key**: `string` -Defined in: [index.ts:39](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L39) +Defined in: [index.ts:39](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L39) *** @@ -24,7 +24,7 @@ Defined in: [index.ts:39](https://github.com/resq-software/npm/blob/f2ab5fc82f4f > `optional` **options?**: `Partial`\<`PostHogConfig`\> -Defined in: [index.ts:42](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L42) +Defined in: [index.ts:42](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L42) *** @@ -32,4 +32,4 @@ Defined in: [index.ts:42](https://github.com/resq-software/npm/blob/f2ab5fc82f4f > `optional` **uiHost?**: `string` -Defined in: [index.ts:41](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L41) +Defined in: [index.ts:41](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L41) diff --git a/sdks/typescript/api/analytics/index/variables/analytics.md b/sdks/typescript/api/analytics/index/variables/analytics.md index eeaae021..1ae8cbdf 100644 --- a/sdks/typescript/api/analytics/index/variables/analytics.md +++ b/sdks/typescript/api/analytics/index/variables/analytics.md @@ -2,4 +2,4 @@ > `const` **analytics**: [`Analytics`](../classes/Analytics) -Defined in: [index.ts:220](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L220) +Defined in: [index.ts:220](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L220) diff --git a/sdks/typescript/api/analytics/index/variables/track.md b/sdks/typescript/api/analytics/index/variables/track.md index f2fde5c9..5b7fcfc4 100644 --- a/sdks/typescript/api/analytics/index/variables/track.md +++ b/sdks/typescript/api/analytics/index/variables/track.md @@ -2,4 +2,4 @@ > `const` **track**: [`Analytics`](../classes/Analytics)\[`"track"`\] -Defined in: [index.ts:224](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L224) +Defined in: [index.ts:224](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/index.ts#L224) diff --git a/sdks/typescript/api/analytics/next/functions/ga4Stream.md b/sdks/typescript/api/analytics/next/functions/ga4Stream.md index ddb7d407..aed0f5b2 100644 --- a/sdks/typescript/api/analytics/next/functions/ga4Stream.md +++ b/sdks/typescript/api/analytics/next/functions/ga4Stream.md @@ -2,7 +2,17 @@ > **ga4Stream**(`measurementId`, `domains?`): [`GA4ProviderConfig`](../../index/interfaces/GA4ProviderConfig) -Defined in: [next/index.ts:74](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/next/index.ts#L74) +Defined in: [next/index.ts:139](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/next/index.ts#L139) + +Build a [GA4ProviderConfig](../../index/interfaces/GA4ProviderConfig) with cross-subdomain linker +domains. Drop into `AnalyticsConfig.ga4`: + +```ts +const config: AnalyticsConfig = { + posthog: { ... }, + ga4: ga4Stream("G-XXXXXXX", ["resq.software", "research.resq.software", "viz.resq.software"]), +}; +``` ## Parameters @@ -10,10 +20,16 @@ Defined in: [next/index.ts:74](https://github.com/resq-software/npm/blob/f2ab5fc `string` +GA4 Measurement ID (`G-…`). + ### domains? `string`[] +Domain allow-list passed to gtag's `linker.domains`, + so cross-subdomain navigation no longer counts as referral + traffic. + ## Returns [`GA4ProviderConfig`](../../index/interfaces/GA4ProviderConfig) diff --git a/sdks/typescript/api/analytics/next/functions/withAnalyticsRewrites.md b/sdks/typescript/api/analytics/next/functions/withAnalyticsRewrites.md index 77c9a285..8d800a49 100644 --- a/sdks/typescript/api/analytics/next/functions/withAnalyticsRewrites.md +++ b/sdks/typescript/api/analytics/next/functions/withAnalyticsRewrites.md @@ -2,7 +2,22 @@ > **withAnalyticsRewrites**\<`T`\>(`nextConfig`, `options?`): `T` -Defined in: [next/index.ts:41](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/next/index.ts#L41) +Defined in: [next/index.ts:90](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/next/index.ts#L90) + +Wrap a Next.js config to add reverse-proxy rewrites for +`@resq-sw/analytics`. + +Adds two rules to the `beforeFiles` rewrite array: + +1. `//static/:path* → assetsUpstream/static/:path*` + (PostHog snippet bundle). +2. `//:path* → upstream/:path*` + (everything else: capture, decide, `/e/`). + +Pre-existing user-defined rewrites are preserved — the proxy +rules go *first* so they win when paths overlap. Also forces +`skipTrailingSlashRedirect: true`, which is required for the +proxy to work reliably across `/ingest` and `/ingest/`. ## Type Parameters @@ -10,6 +25,8 @@ Defined in: [next/index.ts:41](https://github.com/resq-software/npm/blob/f2ab5fc `T` *extends* `MinimalNextConfig` +The user's full `next.config.{js,ts}` type. + ## Parameters ### nextConfig @@ -23,3 +40,14 @@ Defined in: [next/index.ts:41](https://github.com/resq-software/npm/blob/f2ab5fc ## Returns `T` + +## Example + +```ts +import { withAnalyticsRewrites } from "@resq-sw/analytics/next"; + +export default withAnalyticsRewrites({ + reactStrictMode: true, + // ...rest of your config +}); +``` diff --git a/sdks/typescript/api/analytics/next/interfaces/AnalyticsRewriteOptions.md b/sdks/typescript/api/analytics/next/interfaces/AnalyticsRewriteOptions.md index 79c1ed25..bbcb54d5 100644 --- a/sdks/typescript/api/analytics/next/interfaces/AnalyticsRewriteOptions.md +++ b/sdks/typescript/api/analytics/next/interfaces/AnalyticsRewriteOptions.md @@ -1,6 +1,12 @@ # Interface: AnalyticsRewriteOptions -Defined in: [next/index.ts:21](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/next/index.ts#L21) +Defined in: [next/index.ts:39](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/next/index.ts#L39) + +Options for [withAnalyticsRewrites](../functions/withAnalyticsRewrites). + +Defaults are tuned for PostHog's US ingestion endpoints; override +`upstream` / `assetsUpstream` for EU regions or self-hosted +deployments. ## Properties @@ -8,7 +14,9 @@ Defined in: [next/index.ts:21](https://github.com/resq-software/npm/blob/f2ab5fc > `optional` **assetsUpstream?**: `string` -Defined in: [next/index.ts:24](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/next/index.ts#L24) +Defined in: [next/index.ts:45](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/next/index.ts#L45) + +PostHog static-assets endpoint. Default `"https://us-assets.i.posthog.com"`. *** @@ -16,7 +24,9 @@ Defined in: [next/index.ts:24](https://github.com/resq-software/npm/blob/f2ab5fc > `optional` **prefix?**: `string` -Defined in: [next/index.ts:22](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/next/index.ts#L22) +Defined in: [next/index.ts:41](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/next/index.ts#L41) + +Local path prefix that proxies to PostHog. Default `"/ingest"`. *** @@ -24,4 +34,6 @@ Defined in: [next/index.ts:22](https://github.com/resq-software/npm/blob/f2ab5fc > `optional` **upstream?**: `string` -Defined in: [next/index.ts:23](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/next/index.ts#L23) +Defined in: [next/index.ts:43](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/next/index.ts#L43) + +PostHog ingestion endpoint. Default `"https://us.i.posthog.com"`. diff --git a/sdks/typescript/api/analytics/react/functions/AnalyticsProvider.md b/sdks/typescript/api/analytics/react/functions/AnalyticsProvider.md index bc45687d..a265f70c 100644 --- a/sdks/typescript/api/analytics/react/functions/AnalyticsProvider.md +++ b/sdks/typescript/api/analytics/react/functions/AnalyticsProvider.md @@ -2,7 +2,12 @@ > **AnalyticsProvider**(`__namedParameters`): `ReactNode` -Defined in: [react/index.ts:48](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/react/index.ts#L48) +Defined in: [react/index.ts:102](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/react/index.ts#L102) + +Boot the analytics singleton once on mount and render `children`. + +Idempotent — repeat mounts (e.g. fast-refresh, tree-rebuild) are +detected via a ref guard and do not re-initialise PostHog / GA4. ## Parameters @@ -13,3 +18,17 @@ Defined in: [react/index.ts:48](https://github.com/resq-software/npm/blob/f2ab5f ## Returns `ReactNode` + +## Examples + +```tsx + + + +``` + +```tsx + + + +``` diff --git a/sdks/typescript/api/analytics/react/functions/useAnalytics.md b/sdks/typescript/api/analytics/react/functions/useAnalytics.md index b424ea72..b6880f65 100644 --- a/sdks/typescript/api/analytics/react/functions/useAnalytics.md +++ b/sdks/typescript/api/analytics/react/functions/useAnalytics.md @@ -2,8 +2,21 @@ > **useAnalytics**(): [`UseAnalyticsReturn`](../interfaces/UseAnalyticsReturn) -Defined in: [react/index.ts:81](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/react/index.ts#L81) +Defined in: [react/index.ts:160](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/react/index.ts#L160) + +Component-level access to the analytics surface. + +Does **not** subscribe to React state — calls to `track` are pure +side effects, so the hook is safe to call once per component +without causing re-renders. ## Returns [`UseAnalyticsReturn`](../interfaces/UseAnalyticsReturn) + +## Example + +```tsx +const { track } = useAnalytics(); + +``` diff --git a/sdks/typescript/api/analytics/react/interfaces/AnalyticsProviderProps.md b/sdks/typescript/api/analytics/react/interfaces/AnalyticsProviderProps.md index cc9b9e22..08e0abcd 100644 --- a/sdks/typescript/api/analytics/react/interfaces/AnalyticsProviderProps.md +++ b/sdks/typescript/api/analytics/react/interfaces/AnalyticsProviderProps.md @@ -1,6 +1,8 @@ # Interface: AnalyticsProviderProps -Defined in: [react/index.ts:30](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/react/index.ts#L30) +Defined in: [react/index.ts:45](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/react/index.ts#L45) + +Props for [AnalyticsProvider](../functions/AnalyticsProvider). ## Properties @@ -8,7 +10,9 @@ Defined in: [react/index.ts:30](https://github.com/resq-software/npm/blob/f2ab5f > `optional` **children?**: `ReactNode` -Defined in: [react/index.ts:33](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/react/index.ts#L33) +Defined in: [react/index.ts:60](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/react/index.ts#L60) + +Wrapped tree. *** @@ -16,7 +20,12 @@ Defined in: [react/index.ts:33](https://github.com/resq-software/npm/blob/f2ab5f > **config**: [`AnalyticsConfig`](../../index/interfaces/AnalyticsConfig) -Defined in: [react/index.ts:31](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/react/index.ts#L31) +Defined in: [react/index.ts:52](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/react/index.ts#L52) + +Provider configuration — PostHog/GA4 credentials, +cross-subdomain cookie domain, debug flag, etc. Read once on +mount; later prop changes do **not** re-initialise the +singleton (use [reset](../../index/functions/reset) + a remount if you need that). *** @@ -24,4 +33,8 @@ Defined in: [react/index.ts:31](https://github.com/resq-software/npm/blob/f2ab5f > `optional` **deferUntilIdle?**: `boolean` -Defined in: [react/index.ts:32](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/react/index.ts#L32) +Defined in: [react/index.ts:58](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/react/index.ts#L58) + +Wait for `requestIdleCallback` before booting analytics so it +never sits on the LCP critical path. Defaults to `true`. Set +to `false` only when you need first-paint events captured. diff --git a/sdks/typescript/api/analytics/react/interfaces/UseAnalyticsReturn.md b/sdks/typescript/api/analytics/react/interfaces/UseAnalyticsReturn.md index ac04bf36..86092200 100644 --- a/sdks/typescript/api/analytics/react/interfaces/UseAnalyticsReturn.md +++ b/sdks/typescript/api/analytics/react/interfaces/UseAnalyticsReturn.md @@ -1,6 +1,12 @@ # Interface: UseAnalyticsReturn -Defined in: [react/index.ts:73](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/react/index.ts#L73) +Defined in: [react/index.ts:134](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/react/index.ts#L134) + +Return type of [useAnalytics](../functions/useAnalytics). + +Bundles the public method surface of the singleton plus a direct +reference to it for advanced callers (e.g. component-level +`groupIdentify`, `featureFlags`). ## Properties @@ -8,7 +14,9 @@ Defined in: [react/index.ts:73](https://github.com/resq-software/npm/blob/f2ab5f > **analytics**: [`Analytics`](../../index/classes/Analytics) -Defined in: [react/index.ts:78](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/react/index.ts#L78) +Defined in: [react/index.ts:144](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/react/index.ts#L144) + +Direct singleton reference for advanced PostHog/GA4 features not on this surface. *** @@ -16,7 +24,9 @@ Defined in: [react/index.ts:78](https://github.com/resq-software/npm/blob/f2ab5f > **identify**: (`userId`, `traits?`) => `void` -Defined in: [react/index.ts:75](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/react/index.ts#L75) +Defined in: [react/index.ts:138](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/react/index.ts#L138) + +Bind an identity to the current session. Use on sign-in. #### Parameters @@ -38,7 +48,9 @@ Defined in: [react/index.ts:75](https://github.com/resq-software/npm/blob/f2ab5f > **pageview**: (`url?`) => `void` -Defined in: [react/index.ts:77](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/react/index.ts#L77) +Defined in: [react/index.ts:142](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/react/index.ts#L142) + +Manually emit a pageview (rarely needed — auto-capture is on by default). #### Parameters @@ -56,7 +68,9 @@ Defined in: [react/index.ts:77](https://github.com/resq-software/npm/blob/f2ab5f > **reset**: () => `void` -Defined in: [react/index.ts:76](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/react/index.ts#L76) +Defined in: [react/index.ts:140](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/react/index.ts#L140) + +Clear identity + provider state. Use on sign-out. #### Returns @@ -68,7 +82,9 @@ Defined in: [react/index.ts:76](https://github.com/resq-software/npm/blob/f2ab5f > **track**: \<`E`\>(`event`, `properties?`) => `void` -Defined in: [react/index.ts:74](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/react/index.ts#L74) +Defined in: [react/index.ts:136](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/react/index.ts#L136) + +Type-safe `track(event, props)` — extend `AnalyticsEvents` for typed events. #### Type Parameters diff --git a/sdks/typescript/api/analytics/resq/functions/resolveResqCookieDomain.md b/sdks/typescript/api/analytics/resq/functions/resolveResqCookieDomain.md index 94e004ba..cc536c20 100644 --- a/sdks/typescript/api/analytics/resq/functions/resolveResqCookieDomain.md +++ b/sdks/typescript/api/analytics/resq/functions/resolveResqCookieDomain.md @@ -2,7 +2,7 @@ > **resolveResqCookieDomain**(`host?`): `string` \| `undefined` -Defined in: [resq.ts:97](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/resq.ts#L97) +Defined in: [resq.ts:97](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/resq.ts#L97) Resolve the production ResQ cookie domain only when the current host actually lives under `resq.software`. @@ -12,9 +12,9 @@ their cookie rejected by the browser with a domain mismatch, silently breaking analytics in every non-prod environment. This guards that path so the package can ship safe defaults. -Hostnames are case-insensitive per RFC 3986 §3.2.2. Browsers normalise +Hostnames are case-insensitive per RFC 3986 §3.2.2. Browsers normalize `window.location.hostname` to lowercase, but server-side reads of the -`Host` header can carry whatever casing the client sent — normalise +`Host` header can carry whatever casing the client sent — normalize here so a stray `RESQ.SOFTWARE` from a Workers `request.headers` read still returns the cookie domain. diff --git a/sdks/typescript/api/analytics/resq/functions/sanitizeGa4Id.md b/sdks/typescript/api/analytics/resq/functions/sanitizeGa4Id.md index 6573f27e..aed6f1f6 100644 --- a/sdks/typescript/api/analytics/resq/functions/sanitizeGa4Id.md +++ b/sdks/typescript/api/analytics/resq/functions/sanitizeGa4Id.md @@ -2,7 +2,7 @@ > **sanitizeGa4Id**(`id`): `string` \| `null` -Defined in: [resq.ts:69](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/resq.ts#L69) +Defined in: [resq.ts:69](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/resq.ts#L69) Validate a GA4 Measurement ID against [GA4\_ID\_PATTERN](../variables/GA4_ID_PATTERN). diff --git a/sdks/typescript/api/analytics/resq/variables/GA4_ID_PATTERN.md b/sdks/typescript/api/analytics/resq/variables/GA4_ID_PATTERN.md index 2c87d520..3ce69092 100644 --- a/sdks/typescript/api/analytics/resq/variables/GA4_ID_PATTERN.md +++ b/sdks/typescript/api/analytics/resq/variables/GA4_ID_PATTERN.md @@ -2,12 +2,12 @@ > `const` **GA4\_ID\_PATTERN**: `RegExp` -Defined in: [resq.ts:57](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/resq.ts#L57) +Defined in: [resq.ts:57](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/analytics/src/resq.ts#L57) Strict GA4 Measurement ID shape per Google's documented format: `G-` followed by 6–32 uppercase ASCII letters / digits. -Used as a sanitiser before interpolating an env-var-sourced ID into an +Used as a sanitizer before interpolating an env-var-sourced ID into an inline `