@verdant-web/common 1.11.0 → 1.12.0

package/dist/esm/timestamp.d.ts

@@ -1,48 +1,48 @@
-export interface TimestampProvider {
-    now(version: number): string;
-    update(remoteTimestamp: string): void;
-    zero(version: number): string;
-    getWallClockTime(timestamp: string): number;
-}
-export declare function encodeVersion(version: number | string): string;
-export declare function OLD_encodeVersion(version: number | string): string;
-export declare class NaiveTimestampProvider implements TimestampProvider {
-    counter: number;
-    now: (version: number | string) => string;
-    update: () => void;
-    zero: (version: number | string) => string;
-    getWallClockTime: (timestamp: string) => number;
-}
-export declare class HybridLogicalClockTimestampProvider implements TimestampProvider {
-    private latest;
-    private zeroCounter;
-    now: (version: string | number) => string;
-    /**
-     * @deprecated - use now() instead and update to latest format
-     */
-    OLD_now: (version: string | number) => string;
-    /** Get the current timer state. Does not increment counter. */
-    timerState: () => HLCTimestamp;
-    update: (remoteTimestamp: string) => void;
-    get: (version: string | number, raw: HLCTimestamp) => string;
-    zero: (version: string | number) => string;
-    getWallClockTime: (timestamp: string) => number;
-}
-interface HLCTimestamp {
-    time: number;
-    counter: number;
-    node: string;
-}
-export declare function serializeHlcTimestamp(ts: HLCTimestamp): string;
-export declare function deserializeHlcTimestamp(clock: string): HLCTimestamp;
-/**
- * Below, converters for old-style timestamps are defined.
- * These are for migrating older clients to the new format.
- */
-/**
- * Converts a timestamp from the old format to the new format.
- */
-export declare function convertOldHlcTimestamp(ts: string): string;
-export declare function OLD_serializeHlcTimestamp(ts: HLCTimestamp): string;
-export declare function OLD_deserializeHlcTimestamp(clock: string): HLCTimestamp;
-export {};
+export interface TimestampProvider {
+    now(version: number): string;
+    update(remoteTimestamp: string): void;
+    zero(version: number): string;
+    getWallClockTime(timestamp: string): number;
+}
+export declare function encodeVersion(version: number | string): string;
+export declare function OLD_encodeVersion(version: number | string): string;
+export declare class NaiveTimestampProvider implements TimestampProvider {
+    counter: number;
+    now: (version: number | string) => string;
+    update: () => void;
+    zero: (version: number | string) => string;
+    getWallClockTime: (timestamp: string) => number;
+}
+export declare class HybridLogicalClockTimestampProvider implements TimestampProvider {
+    private latest;
+    private zeroCounter;
+    now: (version: string | number) => string;
+    /**
+     * @deprecated - use now() instead and update to latest format
+     */
+    OLD_now: (version: string | number) => string;
+    /** Get the current timer state. Does not increment counter. */
+    timerState: () => HLCTimestamp;
+    update: (remoteTimestamp: string) => void;
+    get: (version: string | number, raw: HLCTimestamp) => string;
+    zero: (version: string | number) => string;
+    getWallClockTime: (timestamp: string) => number;
+}
+interface HLCTimestamp {
+    time: number;
+    counter: number;
+    node: string;
+}
+export declare function serializeHlcTimestamp(ts: HLCTimestamp): string;
+export declare function deserializeHlcTimestamp(clock: string): HLCTimestamp;
+/**
+ * Below, converters for old-style timestamps are defined.
+ * These are for migrating older clients to the new format.
+ */
+/**
+ * Converts a timestamp from the old format to the new format.
+ */
+export declare function convertOldHlcTimestamp(ts: string): string;
+export declare function OLD_serializeHlcTimestamp(ts: HLCTimestamp): string;
+export declare function OLD_deserializeHlcTimestamp(clock: string): HLCTimestamp;
+export {};

package/dist/esm/timestamp.js

@@ -1,229 +1,229 @@
-import cuid from 'cuid';
-const VERSION_BLOCK_LENGTH = 4;
-const ENCODING_NUMBER_RADIX = 36;
-export function encodeVersion(version) {
-    return version
-        .toString(ENCODING_NUMBER_RADIX)
-        .padStart(VERSION_BLOCK_LENGTH, '0');
-}
-export function OLD_encodeVersion(version) {
-    return version.toString().padStart(6, '0');
-}
-export class NaiveTimestampProvider {
-    constructor() {
-        this.counter = 0;
-        this.now = (version) => {
-            return (encodeVersion(version) + Date.now().toString() + '-' + this.counter++);
-        };
-        this.update = () => {
-            this.counter = 0;
-        };
-        this.zero = (version) => {
-            return encodeVersion(version) + '0' + '-' + this.counter++;
-        };
-        this.getWallClockTime = (timestamp) => {
-            return parseInt(timestamp.slice(VERSION_BLOCK_LENGTH).split('-')[0], 10);
-        };
-    }
-}
-export class HybridLogicalClockTimestampProvider {
-    constructor() {
-        this.latest = {
-            time: Date.now(),
-            counter: 0,
-            node: generateNodeId(),
-        };
-        this.zeroCounter = 0;
-        this.now = (version) => {
-            this.latest = getHlcNow(this.latest);
-            return this.get(version, this.latest);
-        };
-        /**
-         * @deprecated - use now() instead and update to latest format
-         */
-        this.OLD_now = (version) => {
-            this.latest = getHlcNow(this.latest);
-            return OLD_encodeVersion(version) + OLD_serializeHlcTimestamp(this.latest);
-        };
-        /** Get the current timer state. Does not increment counter. */
-        this.timerState = () => {
-            return this.latest;
-        };
-        this.update = (remoteTimestamp) => {
-            // strip version from remote timestamp
-            const hlcString = remoteTimestamp.slice(VERSION_BLOCK_LENGTH);
-            this.latest = updateFromRemote(this.latest, deserializeHlcTimestamp(hlcString));
-        };
-        this.get = (version, raw) => {
-            return encodeVersion(version) + serializeHlcTimestamp(raw);
-        };
-        this.zero = (version) => {
-            return (encodeVersion(version) +
-                serializeHlcTimestamp({
-                    time: 0,
-                    // to keep zero timestamps unique, we use a counter here as well
-                    counter: this.zeroCounter++,
-                    node: this.latest.node,
-                }));
-        };
-        this.getWallClockTime = (timestamp) => {
-            return deserializeHlcTimestamp(timestamp.slice(VERSION_BLOCK_LENGTH)).time;
-        };
-    }
-}
-class ClockDriftError extends Error {
-    constructor(...args) {
-        super();
-        this.type = 'ClockDriftError';
-        this.message = ['maximum clock drift exceeded'].concat(args).join(' ');
-    }
-}
-class OverflowError extends Error {
-    constructor() {
-        super();
-        this.type = 'OverflowError';
-        this.message = 'timestamp counter overflow';
-    }
-}
-const COUNTER_BLOCK_LENGTH = 4;
-const NODE_BLOCK_LENGTH = 7;
-const MAX_CLOCK_DRIFT = 60 * 1000;
-// 9 base36 characters should last until the year 5000
-// when encoding a unix MS timestamp
-const TIME_BLOCK_LENGTH = 9;
-function generateNodeId() {
-    return cuid
-        .slug()
-        .padStart(NODE_BLOCK_LENGTH, '0')
-        .slice(0, NODE_BLOCK_LENGTH);
-}
-export function serializeHlcTimestamp(ts) {
-    // string representation of the time
-    const dateString = new Date(ts.time)
-        .getTime()
-        .toString(ENCODING_NUMBER_RADIX)
-        .padStart(TIME_BLOCK_LENGTH, '0');
-    // counter, 336, padded to 4 characters
-    const counter = ts.counter
-        .toString(ENCODING_NUMBER_RADIX)
-        .padStart(COUNTER_BLOCK_LENGTH, '0');
-    // node id padded to 16 characters
-    const node = ts.node.padStart(NODE_BLOCK_LENGTH, '0');
-    return `${dateString}${counter}${node}`;
-}
-function getHlcNow(prev) {
-    const wallTime = Date.now();
-    // pick prev's time if it's later than our local device
-    const newWallTime = Math.max(prev.time, wallTime);
-    // reset counter if wall time changed
-    const newCounter = prev.time === newWallTime ? prev.counter + 1 : 0;
-    // check for drift
-    if (newWallTime - wallTime > MAX_CLOCK_DRIFT) {
-        throw new ClockDriftError(newWallTime, wallTime, MAX_CLOCK_DRIFT);
-    }
-    // check for counter overflow (max is 4 bytes)
-    if (newCounter > 65535) {
-        throw new OverflowError();
-    }
-    return {
-        time: newWallTime,
-        counter: newCounter,
-        node: prev.node,
-    };
-}
-function updateFromRemote(local, remote) {
-    const wallTime = Date.now();
-    // pick remote's time if it's later than our local device
-    const newTime = Math.max(wallTime, Math.max(local.time, remote.time));
-    const maxCounter = Math.max(local.counter, remote.counter);
-    let newCounter;
-    // if all clocks are the same, increment the counter
-    if (local.time === newTime && remote.time === newTime) {
-        newCounter = maxCounter + 1;
-    }
-    // if local time is the same as new time, increment our local counter
-    else if (local.time === newTime) {
-        newCounter = local.counter + 1;
-    }
-    // if remote time is the same as new time, increment remote counter
-    else if (remote.time === newTime) {
-        newCounter = remote.counter + 1;
-    }
-    // otherwise, reset the counter
-    else {
-        newCounter = 0;
-    }
-    // check for drift
-    if (newTime - wallTime > MAX_CLOCK_DRIFT) {
-        throw new ClockDriftError(newTime, wallTime, MAX_CLOCK_DRIFT);
-    }
-    if (newCounter > 65535) {
-        throw new OverflowError();
-    }
-    return {
-        time: newTime,
-        counter: newCounter,
-        node: local.node,
-    };
-}
-export function deserializeHlcTimestamp(clock) {
-    const dateString = clock.slice(0, TIME_BLOCK_LENGTH);
-    const counter = clock.slice(TIME_BLOCK_LENGTH, TIME_BLOCK_LENGTH + COUNTER_BLOCK_LENGTH);
-    const node = clock.slice(TIME_BLOCK_LENGTH + COUNTER_BLOCK_LENGTH);
-    const time = parseInt(dateString, ENCODING_NUMBER_RADIX);
-    const counterNum = parseInt(counter, ENCODING_NUMBER_RADIX);
-    if (isNaN(time) || isNaN(counterNum)) {
-        throw new Error('invalid clock format');
-    }
-    return {
-        time,
-        counter: counterNum,
-        node,
-    };
-}
-function removeLeadingZeroes(str) {
-    return str.replace(/^0+/, '');
-}
-/**
- * Below, converters for old-style timestamps are defined.
- * These are for migrating older clients to the new format.
- */
-/**
- * Converts a timestamp from the old format to the new format.
- */
-export function convertOldHlcTimestamp(ts) {
-    const versionBlock = ts.slice(0, 6);
-    // no jokes please
-    const clockBlock = ts.slice(6);
-    const deserialized = OLD_deserializeHlcTimestamp(clockBlock);
-    // version was base 10 and now is base 36
-    const versionNumber = parseInt(versionBlock, 10);
-    const encodedVersion = encodeVersion(versionNumber);
-    return encodedVersion + serializeHlcTimestamp(deserialized);
-}
-export function OLD_serializeHlcTimestamp(ts) {
-    // ISO string representation of the time
-    const dateString = new Date(ts.time).toISOString();
-    // counter, base16, padded to 4 characters
-    const counter = ts.counter.toString(16).toUpperCase().padStart(4, '0');
-    // node id padded to 16 characters
-    const node = ts.node.padStart(16, '0');
-    return `${dateString}-${counter}-${node}`;
-}
-export function OLD_deserializeHlcTimestamp(clock) {
-    // ISO string representation of the time
-    const dateString = clock.slice(0, 24);
-    const counter = clock.slice(25, 25 + 4);
-    const node = clock.slice(25 + 4 + 1);
-    const time = new Date(dateString).getTime();
-    const counterNum = parseInt(counter, 16);
-    if (isNaN(time) || isNaN(counterNum)) {
-        throw new Error('invalid clock format');
-    }
-    return {
-        time,
-        counter: counterNum,
-        node: node.slice(node.length - 7),
-    };
-}
+import cuid from 'cuid';
+const VERSION_BLOCK_LENGTH = 4;
+const ENCODING_NUMBER_RADIX = 36;
+export function encodeVersion(version) {
+    return version
+        .toString(ENCODING_NUMBER_RADIX)
+        .padStart(VERSION_BLOCK_LENGTH, '0');
+}
+export function OLD_encodeVersion(version) {
+    return version.toString().padStart(6, '0');
+}
+export class NaiveTimestampProvider {
+    constructor() {
+        this.counter = 0;
+        this.now = (version) => {
+            return (encodeVersion(version) + Date.now().toString() + '-' + this.counter++);
+        };
+        this.update = () => {
+            this.counter = 0;
+        };
+        this.zero = (version) => {
+            return encodeVersion(version) + '0' + '-' + this.counter++;
+        };
+        this.getWallClockTime = (timestamp) => {
+            return parseInt(timestamp.slice(VERSION_BLOCK_LENGTH).split('-')[0], 10);
+        };
+    }
+}
+export class HybridLogicalClockTimestampProvider {
+    constructor() {
+        this.latest = {
+            time: Date.now(),
+            counter: 0,
+            node: generateNodeId(),
+        };
+        this.zeroCounter = 0;
+        this.now = (version) => {
+            this.latest = getHlcNow(this.latest);
+            return this.get(version, this.latest);
+        };
+        /**
+         * @deprecated - use now() instead and update to latest format
+         */
+        this.OLD_now = (version) => {
+            this.latest = getHlcNow(this.latest);
+            return OLD_encodeVersion(version) + OLD_serializeHlcTimestamp(this.latest);
+        };
+        /** Get the current timer state. Does not increment counter. */
+        this.timerState = () => {
+            return this.latest;
+        };
+        this.update = (remoteTimestamp) => {
+            // strip version from remote timestamp
+            const hlcString = remoteTimestamp.slice(VERSION_BLOCK_LENGTH);
+            this.latest = updateFromRemote(this.latest, deserializeHlcTimestamp(hlcString));
+        };
+        this.get = (version, raw) => {
+            return encodeVersion(version) + serializeHlcTimestamp(raw);
+        };
+        this.zero = (version) => {
+            return (encodeVersion(version) +
+                serializeHlcTimestamp({
+                    time: 0,
+                    // to keep zero timestamps unique, we use a counter here as well
+                    counter: this.zeroCounter++,
+                    node: this.latest.node,
+                }));
+        };
+        this.getWallClockTime = (timestamp) => {
+            return deserializeHlcTimestamp(timestamp.slice(VERSION_BLOCK_LENGTH)).time;
+        };
+    }
+}
+class ClockDriftError extends Error {
+    constructor(...args) {
+        super();
+        this.type = 'ClockDriftError';
+        this.message = ['maximum clock drift exceeded'].concat(args).join(' ');
+    }
+}
+class OverflowError extends Error {
+    constructor() {
+        super();
+        this.type = 'OverflowError';
+        this.message = 'timestamp counter overflow';
+    }
+}
+const COUNTER_BLOCK_LENGTH = 4;
+const NODE_BLOCK_LENGTH = 7;
+const MAX_CLOCK_DRIFT = 60 * 1000;
+// 9 base36 characters should last until the year 5000
+// when encoding a unix MS timestamp
+const TIME_BLOCK_LENGTH = 9;
+function generateNodeId() {
+    return cuid
+        .slug()
+        .padStart(NODE_BLOCK_LENGTH, '0')
+        .slice(0, NODE_BLOCK_LENGTH);
+}
+export function serializeHlcTimestamp(ts) {
+    // string representation of the time
+    const dateString = new Date(ts.time)
+        .getTime()
+        .toString(ENCODING_NUMBER_RADIX)
+        .padStart(TIME_BLOCK_LENGTH, '0');
+    // counter, 336, padded to 4 characters
+    const counter = ts.counter
+        .toString(ENCODING_NUMBER_RADIX)
+        .padStart(COUNTER_BLOCK_LENGTH, '0');
+    // node id padded to 16 characters
+    const node = ts.node.padStart(NODE_BLOCK_LENGTH, '0');
+    return `${dateString}${counter}${node}`;
+}
+function getHlcNow(prev) {
+    const wallTime = Date.now();
+    // pick prev's time if it's later than our local device
+    const newWallTime = Math.max(prev.time, wallTime);
+    // reset counter if wall time changed
+    const newCounter = prev.time === newWallTime ? prev.counter + 1 : 0;
+    // check for drift
+    if (newWallTime - wallTime > MAX_CLOCK_DRIFT) {
+        throw new ClockDriftError(newWallTime, wallTime, MAX_CLOCK_DRIFT);
+    }
+    // check for counter overflow (max is 4 bytes)
+    if (newCounter > 65535) {
+        throw new OverflowError();
+    }
+    return {
+        time: newWallTime,
+        counter: newCounter,
+        node: prev.node,
+    };
+}
+function updateFromRemote(local, remote) {
+    const wallTime = Date.now();
+    // pick remote's time if it's later than our local device
+    const newTime = Math.max(wallTime, Math.max(local.time, remote.time));
+    const maxCounter = Math.max(local.counter, remote.counter);
+    let newCounter;
+    // if all clocks are the same, increment the counter
+    if (local.time === newTime && remote.time === newTime) {
+        newCounter = maxCounter + 1;
+    }
+    // if local time is the same as new time, increment our local counter
+    else if (local.time === newTime) {
+        newCounter = local.counter + 1;
+    }
+    // if remote time is the same as new time, increment remote counter
+    else if (remote.time === newTime) {
+        newCounter = remote.counter + 1;
+    }
+    // otherwise, reset the counter
+    else {
+        newCounter = 0;
+    }
+    // check for drift
+    if (newTime - wallTime > MAX_CLOCK_DRIFT) {
+        throw new ClockDriftError(newTime, wallTime, MAX_CLOCK_DRIFT);
+    }
+    if (newCounter > 65535) {
+        throw new OverflowError();
+    }
+    return {
+        time: newTime,
+        counter: newCounter,
+        node: local.node,
+    };
+}
+export function deserializeHlcTimestamp(clock) {
+    const dateString = clock.slice(0, TIME_BLOCK_LENGTH);
+    const counter = clock.slice(TIME_BLOCK_LENGTH, TIME_BLOCK_LENGTH + COUNTER_BLOCK_LENGTH);
+    const node = clock.slice(TIME_BLOCK_LENGTH + COUNTER_BLOCK_LENGTH);
+    const time = parseInt(dateString, ENCODING_NUMBER_RADIX);
+    const counterNum = parseInt(counter, ENCODING_NUMBER_RADIX);
+    if (isNaN(time) || isNaN(counterNum)) {
+        throw new Error('invalid clock format');
+    }
+    return {
+        time,
+        counter: counterNum,
+        node,
+    };
+}
+function removeLeadingZeroes(str) {
+    return str.replace(/^0+/, '');
+}
+/**
+ * Below, converters for old-style timestamps are defined.
+ * These are for migrating older clients to the new format.
+ */
+/**
+ * Converts a timestamp from the old format to the new format.
+ */
+export function convertOldHlcTimestamp(ts) {
+    const versionBlock = ts.slice(0, 6);
+    // no jokes please
+    const clockBlock = ts.slice(6);
+    const deserialized = OLD_deserializeHlcTimestamp(clockBlock);
+    // version was base 10 and now is base 36
+    const versionNumber = parseInt(versionBlock, 10);
+    const encodedVersion = encodeVersion(versionNumber);
+    return encodedVersion + serializeHlcTimestamp(deserialized);
+}
+export function OLD_serializeHlcTimestamp(ts) {
+    // ISO string representation of the time
+    const dateString = new Date(ts.time).toISOString();
+    // counter, base16, padded to 4 characters
+    const counter = ts.counter.toString(16).toUpperCase().padStart(4, '0');
+    // node id padded to 16 characters
+    const node = ts.node.padStart(16, '0');
+    return `${dateString}-${counter}-${node}`;
+}
+export function OLD_deserializeHlcTimestamp(clock) {
+    // ISO string representation of the time
+    const dateString = clock.slice(0, 24);
+    const counter = clock.slice(25, 25 + 4);
+    const node = clock.slice(25 + 4 + 1);
+    const time = new Date(dateString).getTime();
+    const counterNum = parseInt(counter, 16);
+    if (isNaN(time) || isNaN(counterNum)) {
+        throw new Error('invalid clock format');
+    }
+    return {
+        time,
+        counter: counterNum,
+        node: node.slice(node.length - 7),
+    };
+}
 //# sourceMappingURL=timestamp.js.map

package/dist/esm/timestamp.test.d.ts

@@ -1 +1 @@
-export {};
+export {};