@fluidframework/container-runtime 2.0.0-dev.5.2.0.169897 → 2.0.0-dev.6.4.0.191258

package/src/summary/summaryGenerator.ts

@@ -7,22 +7,22 @@ import {
 	ITelemetryLoggerExt,
 	PerformanceEvent,
 	LoggingError,
-	ChildLogger,
 } from "@fluidframework/telemetry-utils";
+import { ITelemetryProperties } from "@fluidframework/core-interfaces";
+
 import {
 	assert,
 	Deferred,
 	IPromiseTimer,
 	IPromiseTimerResult,
 	Timer,
-} from "@fluidframework/common-utils";
+} from "@fluidframework/core-utils";
 import { MessageType } from "@fluidframework/protocol-definitions";
 import { getRetryDelaySecondsFromError } from "@fluidframework/driver-utils";
-import { DriverErrorType } from "@fluidframework/driver-definitions";
+import { DriverErrorTypes } from "@fluidframework/driver-definitions";
 import {
 	IAckSummaryResult,
 	INackSummaryResult,
-	ISummarizeOptions,
 	IBroadcastSummaryResult,
 	ISummarizeResults,
 	ISummarizeHeuristicData,
@@ -30,8 +30,8 @@ import {
 	SubmitSummaryResult,
 	SummarizeResultPart,
 	ISummaryCancellationToken,
-	ISummarizeTelemetryProperties,
 	SummaryGeneratorTelemetry,
+	SubmitSummaryFailureData,
 } from "./summarizerTypes";
 import { IClientSummaryWatcher } from "./summaryCollection";
 
@@ -129,7 +129,9 @@ export const getFailMessage = (errorCode: keyof typeof summarizeErrors) =>
 	`${errorCode}: ${summarizeErrors[errorCode]}`;
 
 export class SummarizeResultBuilder {
-	public readonly summarySubmitted = new Deferred<SummarizeResultPart<SubmitSummaryResult>>();
+	public readonly summarySubmitted = new Deferred<
+		SummarizeResultPart<SubmitSummaryResult, SubmitSummaryFailureData>
+	>();
 	public readonly summaryOpBroadcasted = new Deferred<
 		SummarizeResultPart<IBroadcastSummaryResult>
 	>();
@@ -137,11 +139,17 @@ export class SummarizeResultBuilder {
 		SummarizeResultPart<IAckSummaryResult, INackSummaryResult>
 	>();
 
+	/**
+	 * Fails one or more of the three results as per the passed params.
+	 * If submit fails, all three results fail.
+	 * If op broadcast fails, only op broadcast result and ack nack result fails.
+	 * If ack nack fails, only ack nack result fails.
+	 */
 	public fail(
 		message: string,
 		error: any,
+		submitFailureResult?: SubmitSummaryFailureData,
 		nackSummaryResult?: INackSummaryResult,
-		retryAfterSeconds?: number,
 	) {
 		assert(
 			!this.receivedSummaryAckOrNack.isCompleted,
@@ -153,9 +161,11 @@ export class SummarizeResultBuilder {
 			message,
 			data: undefined,
 			error,
-			retryAfterSeconds,
 		} as const;
-		this.summarySubmitted.resolve(result);
+
+		// Note that if any of these are already resolved, it will be a no-op. For example, if ack nack failed but
+		// submit summary and op broadcast has already been resolved as passed, only ack nack result will get modified.
+		this.summarySubmitted.resolve({ ...result, data: submitFailureResult });
 		this.summaryOpBroadcasted.resolve(result);
 		this.receivedSummaryAckOrNack.resolve({ ...result, data: nackSummaryResult });
 	}
@@ -168,6 +178,20 @@ export class SummarizeResultBuilder {
 	}
 }
 
+/**
+ * Errors type for errors hit during summary that may be retriable.
+ */
+export class RetriableSummaryError extends LoggingError {
+	public readonly canRetry = this.retryAfterSeconds !== undefined;
+	constructor(
+		message: string,
+		public readonly retryAfterSeconds?: number,
+		props?: ITelemetryProperties,
+	) {
+		super(message, props);
+	}
+}
+
 /**
  * This class generates and tracks a summary attempt.
  */
@@ -196,30 +220,23 @@ export class SummaryGenerator {
 	 * fullTree to generate tree without any summary handles even if unchanged
 	 */
 	public summarize(
-		summarizeProps: ISummarizeTelemetryProperties,
-		options: ISummarizeOptions,
-		cancellationToken: ISummaryCancellationToken,
+		summaryOptions: ISubmitSummaryOptions,
 		resultsBuilder = new SummarizeResultBuilder(),
 	): ISummarizeResults {
-		this.summarizeCore(summarizeProps, options, resultsBuilder, cancellationToken).catch(
-			(error) => {
-				const message = "UnexpectedSummarizeError";
-				this.logger.sendErrorEvent({ eventName: message, ...summarizeProps }, error);
-				resultsBuilder.fail(message, error);
-			},
-		);
+		this.summarizeCore(summaryOptions, resultsBuilder).catch((error) => {
+			const message = "UnexpectedSummarizeError";
+			summaryOptions.summaryLogger.sendErrorEvent({ eventName: message }, error);
+			resultsBuilder.fail(message, error);
+		});
 
 		return resultsBuilder.build();
 	}
 
 	private async summarizeCore(
-		summarizeProps: ISummarizeTelemetryProperties,
-		options: ISummarizeOptions,
+		submitSummaryOptions: ISubmitSummaryOptions,
 		resultsBuilder: SummarizeResultBuilder,
-		cancellationToken: ISummaryCancellationToken,
 	): Promise<void> {
-		const { refreshLatestAck, fullTree } = options;
-		const logger = ChildLogger.create(this.logger, undefined, { all: summarizeProps });
+		const { summaryLogger, cancellationToken, ...summarizeOptions } = submitSummaryOptions;
 
 		// Note: timeSinceLastAttempt and timeSinceLastSummary for the
 		// first summary are basically the time since the summarizer was loaded.
@@ -227,36 +244,40 @@ export class SummaryGenerator {
 		const timeSinceLastSummary =
 			Date.now() - this.heuristicData.lastSuccessfulSummary.summaryTime;
 		let summarizeTelemetryProps: SummaryGeneratorTelemetry = {
-			fullTree,
+			...summarizeOptions,
+			fullTree: summarizeOptions.fullTree ?? false,
 			timeSinceLastAttempt,
 			timeSinceLastSummary,
 		};
 
 		const summarizeEvent = PerformanceEvent.start(
-			logger,
+			summaryLogger,
 			{
 				eventName: "Summarize",
-				refreshLatestAck,
 				...summarizeTelemetryProps,
 			},
 			{ start: true, end: true, cancel: "generic" },
 		);
 
+		let summaryData: SubmitSummaryResult | undefined;
+
+		/**
+		 * Summarization can fail during submit, during op broadcast or during nack.
+		 * For submit failures, submitFailureResult should be provided. For nack failures, nackSummaryResult should
+		 * be provided. For op broadcast failures, only errors / properties should be provided.
+		 */
 		const fail = (
 			errorCode: keyof typeof summarizeErrors,
 			error?: any,
 			properties?: SummaryGeneratorTelemetry,
+			submitFailureResult?: SubmitSummaryFailureData,
 			nackSummaryResult?: INackSummaryResult,
 		) => {
-			// UploadSummary may fail with 429 and retryAfter - respect that
-			// Summary Nack also can have retryAfter, it's parsed below and comes as a property.
-			const retryAfterSeconds = getRetryDelaySecondsFromError(error);
-
 			// Report any failure as an error unless it was due to cancellation (like "disconnected" error)
 			// If failure happened on upload, we may not yet realized that socket disconnected, so check
 			// offlineError too.
 			const category =
-				cancellationToken.cancelled || error?.errorType === DriverErrorType.offlineError
+				cancellationToken.cancelled || error?.errorType === DriverErrorTypes.offlineError
 					? "generic"
 					: "error";
 
@@ -266,28 +287,23 @@ export class SummaryGenerator {
 					...properties,
 					reason,
 					category,
-					retryAfterSeconds,
+					retryAfterSeconds:
+						submitFailureResult?.retryAfterSeconds ??
+						nackSummaryResult?.retryAfterSeconds,
 				},
 				error ?? reason,
 			); // disconnect & summaryAckTimeout do not have proper error.
-			resultsBuilder.fail(reason, error, nackSummaryResult, retryAfterSeconds);
+
+			resultsBuilder.fail(reason, error, submitFailureResult, nackSummaryResult);
 		};
 
 		// Wait to generate and send summary
 		this.summarizeTimer.start();
-
-		// Use record type to prevent unexpected value types
-		let summaryData: SubmitSummaryResult | undefined;
 		try {
 			// Need to save refSeqNum before we record new attempt (happens as part of submitSummaryCallback)
 			const lastAttemptRefSeqNum = this.heuristicData.lastAttempt.refSequenceNumber;
 
-			summaryData = await this.submitSummaryCallback({
-				fullTree,
-				refreshLatestAck,
-				summaryLogger: logger,
-				cancellationToken,
-			});
+			summaryData = await this.submitSummaryCallback(submitSummaryOptions);
 
 			// Cumulatively add telemetry properties based on how far generateSummary went.
 			const referenceSequenceNumber = summaryData.referenceSequenceNumber;
@@ -307,7 +323,10 @@ export class SummaryGenerator {
 			);
 
 			if (summaryData.stage !== "submit") {
-				return fail("submitSummaryFailure", summaryData.error, summarizeTelemetryProps);
+				return fail("submitSummaryFailure", summaryData.error, summarizeTelemetryProps, {
+					stage: summaryData.stage,
+					retryAfterSeconds: getRetryDelaySecondsFromError(summaryData.error),
+				});
 			}
 
 			/**
@@ -320,14 +339,14 @@ export class SummaryGenerator {
 			 * state change of multiple data stores. So, the total number of data stores that are summarized should not
 			 * exceed the number of ops since last summary + number of data store whose reference state changed.
 			 */
-			if (!fullTree && !summaryData.forcedFullTree) {
+			if (!submitSummaryOptions.fullTree && !summaryData.forcedFullTree) {
 				const { summarizedDataStoreCount, gcStateUpdatedDataStoreCount = 0 } =
 					summaryData.summaryStats;
 				if (
 					summarizedDataStoreCount >
 					gcStateUpdatedDataStoreCount + this.heuristicData.opsSinceLastSummary
 				) {
-					logger.sendErrorEvent({
+					summaryLogger.sendErrorEvent({
 						eventName: "IncrementalSummaryViolation",
 						summarizedDataStoreCount,
 						gcStateUpdatedDataStoreCount,
@@ -340,7 +359,10 @@ export class SummaryGenerator {
 			summarizeEvent.reportEvent("generate", { ...summarizeTelemetryProps });
 			resultsBuilder.summarySubmitted.resolve({ success: true, data: summaryData });
 		} catch (error) {
-			return fail("submitSummaryFailure", error);
+			return fail("submitSummaryFailure", error, undefined /* properties */, {
+				stage: "unknown",
+				retryAfterSeconds: getRetryDelaySecondsFromError(error),
+			});
 		} finally {
 			if (summaryData === undefined) {
 				this.heuristicData.recordAttempt();
@@ -373,7 +395,7 @@ export class SummaryGenerator {
 			});
 
 			this.heuristicData.lastAttempt.summarySequenceNumber = summarizeOp.sequenceNumber;
-			logger.sendTelemetryEvent({
+			summaryLogger.sendTelemetryEvent({
 				eventName: "Summarize_Op",
 				duration: broadcastDuration,
 				referenceSequenceNumber: summarizeOp.referenceSequenceNumber,
@@ -442,7 +464,8 @@ export class SummaryGenerator {
 					"summaryNack",
 					error,
 					{ ...summarizeTelemetryProps, nackRetryAfter: retryAfterSeconds },
-					{ summaryNackOp: ackNackOp, ackNackDuration },
+					undefined /* submitFailureResult */,
+					{ summaryNackOp: ackNackOp, ackNackDuration, retryAfterSeconds },
 				);
 			}
 		} finally {

package/src/summary/summaryManager.ts

@@ -3,17 +3,32 @@
  * Licensed under the MIT License.
  */
 
-import { IDisposable, IEvent, IEventProvider } from "@fluidframework/common-definitions";
-import { assert } from "@fluidframework/common-utils";
 import {
-	ChildLogger,
+	IDisposable,
+	IEvent,
+	IEventProvider,
+	ITelemetryBaseLogger,
+} from "@fluidframework/core-interfaces";
+import { assert } from "@fluidframework/core-utils";
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import {
+	createChildLogger,
 	ITelemetryLoggerExt,
 	PerformanceEvent,
 } from "@fluidframework/telemetry-utils";
-import { DriverErrorType } from "@fluidframework/driver-definitions";
+import { DriverErrorTypes } from "@fluidframework/driver-definitions";
 import { IThrottler } from "../throttler";
 import { ISummarizerClientElection } from "./summarizerClientElection";
-import { ISummarizer, SummarizerStopReason } from "./summarizerTypes";
+import {
+	EnqueueSummarizeResult,
+	IEnqueueSummarizeOptions,
+	IOnDemandSummarizeOptions,
+	ISummarizeEventProps,
+	ISummarizeResults,
+	ISummarizer,
+	ISummarizerEvents,
+	SummarizerStopReason,
+} from "./summarizerTypes";
 import { SummaryCollection } from "./summaryCollection";
 import { Summarizer } from "./summarizer";
 
@@ -72,7 +87,7 @@ export interface ISummaryManagerConfig {
  * It observes changes in calculated summarizer and reacts to changes by either creating summarizer client or
  * stopping existing summarizer client.
  */
-export class SummaryManager implements IDisposable {
+export class SummaryManager extends TypedEventEmitter<ISummarizerEvents> implements IDisposable {
 	private readonly logger: ITelemetryLoggerExt;
 	private readonly opsToBypassInitialDelay: number;
 	private readonly initialDelayMs: number;
@@ -96,7 +111,7 @@ export class SummaryManager implements IDisposable {
 			SummaryCollection,
 			"opsSinceLastAck" | "addOpListener" | "removeOpListener"
 		>,
-		parentLogger: ITelemetryLoggerExt,
+		parentLogger: ITelemetryBaseLogger,
 		/** Creates summarizer by asking interactive container to spawn summarizing container and
 		 * get back its Summarizer instance. */
 		private readonly requestSummarizerFn: () => Promise<ISummarizer>,
@@ -107,8 +122,14 @@ export class SummaryManager implements IDisposable {
 		}: Readonly<Partial<ISummaryManagerConfig>> = {},
 		private readonly disableHeuristics?: boolean,
 	) {
-		this.logger = ChildLogger.create(parentLogger, "SummaryManager", {
-			all: { clientId: () => this.latestClientId },
+		super();
+
+		this.logger = createChildLogger({
+			logger: parentLogger,
+			namespace: "SummaryManager",
+			properties: {
+				all: { clientId: () => this.latestClientId },
+			},
 		});
 
 		this.connectedState.on("connected", this.handleConnected);
@@ -140,6 +161,10 @@ export class SummaryManager implements IDisposable {
 		this.refreshSummarizer();
 	};
 
+	private readonly handleSummarizeEvent = (eventProps: ISummarizeEventProps) => {
+		this.emit("summarize", eventProps);
+	};
+
 	private static readonly isStartingOrRunning = (state: SummaryManagerState) =>
 		state === SummaryManagerState.Starting || state === SummaryManagerState.Running;
 
@@ -241,6 +266,7 @@ export class SummaryManager implements IDisposable {
 
 				const summarizer = await this.requestSummarizerFn();
 				this.summarizer = summarizer;
+				this.summarizer.on("summarize", this.handleSummarizeEvent);
 
 				// Re-validate that it need to be running. Due to asynchrony, it may be not the case anymore
 				// If we can't run the LastSummary, simply return as to avoid paying the cost of launching
@@ -303,7 +329,7 @@ export class SummaryManager implements IDisposable {
 					// If failure happened on container load, we may not yet realized that socket disconnected, so check
 					// offlineError.
 					const category =
-						error?.errorType === DriverErrorType.offlineError ? "generic" : "error";
+						error?.errorType === DriverErrorTypes.offlineError ? "generic" : "error";
 					this.logger.sendTelemetryEvent(
 						{
 							eventName: "SummarizerException",
@@ -317,6 +343,7 @@ export class SummaryManager implements IDisposable {
 				assert(this.state !== SummaryManagerState.Off, 0x264 /* "Expected: Not Off" */);
 				this.state = SummaryManagerState.Off;
 
+				this.summarizer?.off("summarize", this.handleSummarizeEvent);
 				this.summarizer?.close();
 				this.summarizer = undefined;
 
@@ -399,26 +426,27 @@ export class SummaryManager implements IDisposable {
 		return startWithInitialDelay;
 	}
 
-	public readonly summarizeOnDemand: ISummarizer["summarizeOnDemand"] = (...args) => {
+	public summarizeOnDemand(options: IOnDemandSummarizeOptions): ISummarizeResults {
 		if (this.summarizer === undefined) {
 			throw Error("No running summarizer client");
 			// TODO: could spawn a summarizer client temporarily.
 		}
-		return this.summarizer.summarizeOnDemand(...args);
-	};
+		return this.summarizer.summarizeOnDemand(options);
+	}
 
-	public readonly enqueueSummarize: ISummarizer["enqueueSummarize"] = (...args) => {
+	public enqueueSummarize(options: IEnqueueSummarizeOptions): EnqueueSummarizeResult {
 		if (this.summarizer === undefined) {
 			throw Error("No running summarizer client");
 			// TODO: could spawn a summarizer client temporarily.
 		}
-		return this.summarizer.enqueueSummarize(...args);
-	};
+		return this.summarizer.enqueueSummarize(options);
+	}
 
 	public dispose() {
 		this.clientElection.off("electedSummarizerChanged", this.refreshSummarizer);
 		this.connectedState.off("connected", this.handleConnected);
 		this.connectedState.off("disconnected", this.handleDisconnected);
+		this.summarizer?.off("summarize", this.handleSummarizeEvent);
 		this._disposed = true;
 	}
 }

package/dist/id-compressor/idRange.d.ts

@@ -1,11 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { IdCreationRange, UnackedLocalId } from "@fluidframework/runtime-definitions";
-export declare function getIds(range: IdCreationRange): {
-    first: UnackedLocalId;
-    last: UnackedLocalId;
-    overrides?: IdCreationRange.Overrides;
-} | undefined;
-//# sourceMappingURL=idRange.d.ts.map

package/dist/id-compressor/idRange.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"idRange.d.ts","sourceRoot":"","sources":["../../src/id-compressor/idRange.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAC;AAE3F,wBAAgB,MAAM,CACrB,KAAK,EAAE,eAAe,GAEpB;IAAE,KAAK,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE,cAAc,CAAC;IAAC,SAAS,CAAC,EAAE,eAAe,CAAC,SAAS,CAAA;CAAE,GACtF,SAAS,CAsBX"}

package/dist/id-compressor/idRange.js

@@ -1,29 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIds = void 0;
-const common_utils_1 = require("@fluidframework/common-utils");
-function getIds(range) {
-    const { ids } = range;
-    if (ids === undefined) {
-        return undefined;
-    }
-    let first = ids.first;
-    let last = ids.last;
-    const overrides = ids;
-    if (overrides.overrides !== undefined) {
-        first !== null && first !== void 0 ? first : (first = overrides.overrides[0][0]);
-        last !== null && last !== void 0 ? last : (last = overrides.overrides[overrides.overrides.length - 1][0]);
-    }
-    (0, common_utils_1.assert)(first !== undefined && last !== undefined, 0x49b /* malformed IdCreationRange */);
-    return {
-        first,
-        last,
-        overrides: overrides.overrides,
-    };
-}
-exports.getIds = getIds;
-//# sourceMappingURL=idRange.js.map

package/dist/id-compressor/idRange.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"idRange.js","sourceRoot":"","sources":["../../src/id-compressor/idRange.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAsD;AAGtD,SAAgB,MAAM,CACrB,KAAsB;IAItB,MAAM,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;IACtB,IAAI,GAAG,KAAK,SAAS,EAAE;QACtB,OAAO,SAAS,CAAC;KACjB;IAED,IAAI,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IACtB,IAAI,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IAEpB,MAAM,SAAS,GAAG,GAA4C,CAAC;IAC/D,IAAI,SAAS,CAAC,SAAS,KAAK,SAAS,EAAE;QACtC,KAAK,aAAL,KAAK,cAAL,KAAK,IAAL,KAAK,GAAK,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC;QACpC,IAAI,aAAJ,IAAI,cAAJ,IAAI,IAAJ,IAAI,GAAK,SAAS,CAAC,SAAS,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC;KAChE;IAED,IAAA,qBAAM,EAAC,KAAK,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAEzF,OAAO;QACN,KAAK;QACL,IAAI;QACJ,SAAS,EAAE,SAAS,CAAC,SAAS;KAC9B,CAAC;AACH,CAAC;AA1BD,wBA0BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport type { IdCreationRange, UnackedLocalId } from \"@fluidframework/runtime-definitions\";\n\nexport function getIds(\n\trange: IdCreationRange,\n):\n\t| { first: UnackedLocalId; last: UnackedLocalId; overrides?: IdCreationRange.Overrides }\n\t| undefined {\n\tconst { ids } = range;\n\tif (ids === undefined) {\n\t\treturn undefined;\n\t}\n\n\tlet first = ids.first;\n\tlet last = ids.last;\n\n\tconst overrides = ids as Partial<IdCreationRange.HasOverrides>;\n\tif (overrides.overrides !== undefined) {\n\t\tfirst ??= overrides.overrides[0][0];\n\t\tlast ??= overrides.overrides[overrides.overrides.length - 1][0];\n\t}\n\n\tassert(first !== undefined && last !== undefined, 0x49b /* malformed IdCreationRange */);\n\n\treturn {\n\t\tfirst,\n\t\tlast,\n\t\toverrides: overrides.overrides,\n\t};\n}\n"]}

package/dist/id-compressor/numericUuid.d.ts

@@ -1,59 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { SessionId, StableId } from "@fluidframework/runtime-definitions";
-/**
- * A UUID (128 bit identifier) optimized for use as a 128 bit unsigned integer with fast addition and toString operations.
- * The string entry is the upper 76 bits of the uuid and the integer entry holds the lower 52 bits:
- *
- * ```
- * UUUUUUUU-UUUU-VUUU-vUUU-UUUUUUUUUUUU - the uuid
- * SSSSSSSS-SSSS-SSSS-SSS               - array[0]: string
- *                       N NNNNNNNNNNNN - array[1]: integer
- * ```
- *
- * The integer keeps the common case cost of incrementing and computing deltas very low.
- * The string optimizes toString by caching the the majority of the resulting string.
- */
-export declare type NumericUuid = readonly [string, number] & {
-    readonly NumericUuid: "9132ea20-a811-4756-85f8-aa6da5ca90f8";
-};
-/**
- * Calculates the numeric delta between a and b (i.e. a - b).
- * @param a - an uuid
- * @param b - an other uuid
- * @param maxDelta - the maximum integer delta (inclusive) to tolerate.
- * @returns undefined if the delta is negative or greater than `maxDelta`
- */
-export declare function getPositiveDelta(a: NumericUuid, b: NumericUuid, maxDelta: number): number | undefined;
-/**
- * @param offset - an optional offset to increment the returned StableId
- * @returns the string representation of a `NumericUuid`.
- */
-export declare function stableIdFromNumericUuid(uuid: NumericUuid, offset?: number): StableId;
-/**
- * @param stableId - a minimal uuid string
- * @returns a numeric representation of `stableId`.
- */
-export declare function numericUuidFromStableId(stableId: StableId): NumericUuid;
-/**
- * Creates a session base ID.
- * This method (rather than standard uuid generation methods) should be used to generate session IDs.
- */
-export declare function createSessionId(): SessionId;
-/**
- * Compares numeric uuids for equality.
- */
-export declare function numericUuidEquals(a: NumericUuid, b: NumericUuid): boolean;
-/**
- * Increments the uuid. `amount` must be a positive integer.
- * @returns the result of incrementing the uuid by `amount`.
- */
-export declare function incrementUuid(uuid: NumericUuid, amount: number): NumericUuid;
-/**
- * Any session uuid with all of its highish bits set is in danger of overflowing after fewer than 2^53 increments.
- * By zeroing one of those bits at random, potential overflow is prevented.
- */
-export declare function ensureSessionUuid(uuid: StableId): SessionId;
-//# sourceMappingURL=numericUuid.d.ts.map

package/dist/id-compressor/numericUuid.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"numericUuid.d.ts","sourceRoot":"","sources":["../../src/id-compressor/numericUuid.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,qCAAqC,CAAC;AAI1E;;;;;;;;;;;;GAYG;AACH,oBAAY,WAAW,GAAG,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG;IACrD,QAAQ,CAAC,WAAW,EAAE,sCAAsC,CAAC;CAC7D,CAAC;AAQF;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC/B,CAAC,EAAE,WAAW,EACd,CAAC,EAAE,WAAW,EACd,QAAQ,EAAE,MAAM,GACd,MAAM,GAAG,SAAS,CAgDpB;AAaD;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,SAAI,GAAG,QAAQ,CAW/E;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,GAAG,WAAW,CAKvE;AAED;;;GAGG;AACH,wBAAgB,eAAe,IAAI,SAAS,CAE3C;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,WAAW,GAAG,OAAO,CAEzE;AAQD;;;GAGG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,GAAG,WAAW,CAoD5E;AAiJD;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,CAoB3D"}