Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 | 193x 193x 193x 16906x 11421x 4034x 1451x 193x 88995x 193x 193x 68762x 68762x 69201x 193x 4876x 4876x 4876x 193x 17x 17x 68x 193x 620x 620x 620x 686x 686x 686x 686x 193x 2486x 2486x 2486x 9817x 9817x 9817x 9815x 9815x 12474x 12474x 12474x 9815x 9817x 193x 5110x 5110x 5110x 5110x 5092x 5092x 5092x 5092x 5092x 5092x 4950x 8992x 8992x 8992x 4950x 5092x 193x 4928x 4928x 4928x 12260x 12260x 12260x 2050x 3613x 2050x 12260x 193x 2192x 2192x 2192x 2192x 2207x 2207x 2207x 2207x 2207x 2207x 193x 68762x 4876x 17x 620x 2486x 5110x 5x 4928x 7816x 4942x 4917x 4910x 2859x 2851x 2851x 2851x 6173x 2851x 2321x 553x 16906x 2192x 193x | import {isUint8Array} from '@jsonjoy.com/util/lib/buffers/isUint8Array';
import {Timestamp, type ITimestampStruct} from './clock';
import type {PatchBuilder} from './PatchBuilder';
const maybeConst = (x: unknown): boolean => {
switch (typeof x) {
case 'number':
case 'boolean':
case 'undefined':
return true;
case 'object':
return x === null || x instanceof Timestamp;
default:
return false;
}
};
export type NodeBuilderCallback = (builder: PatchBuilder) => ITimestampStruct;
/**
* @category Patch
*/
export class NodeBuilder {
constructor(public readonly build: NodeBuilderCallback) {}
}
/**
* This namespace contains all the node builders. Each node builder is a
* schema for a specific node type. Each node builder has a `build` method
* that takes a {@link NodeBuilder} and returns the ID of the node.
*/
export namespace nodes {
/**
* The `con` class represents a "con" JSON CRDT node. As the generic type
* parameter, it takes the type of the raw value.
*
* Example:
*
* ```ts
* s.con(0);
* s.con('');
* s.con<number>(123);
* s.con<0 | 1>(0);
* ```
*/
export class con<T extends unknown | ITimestampStruct> extends NodeBuilder {
public readonly type = 'con';
constructor(public readonly raw: T) {
super((builder) => builder.con(raw));
}
}
/**
* The `str` class represents a "str" JSON CRDT node. As the generic type
* parameter, it takes the type of the raw value.
*
* Example:
*
* ```ts
* s.str('');
* s.str('hello');
* s.str<string>('world');
* s.str<'' | 'hello' | 'world'>('hello');
* ```
*/
export class str<T extends string = string> extends NodeBuilder {
public readonly type = 'str';
constructor(public readonly raw: T) {
super((builder) => builder.json(raw));
}
}
/**
* The `bin` class represents a "bin" JSON CRDT node.
*/
export class bin extends NodeBuilder {
public readonly type = 'bin';
constructor(public readonly raw: Uint8Array) {
super((builder) => builder.json(raw));
}
}
/**
* The `val` class represents a "val" JSON CRDT node. As the generic type
* parameter, it takes the type of the inner node builder.
*
* Example:
*
* ```ts
* s.val(s.con(0));
* s.val(s.str(''));
* s.val(s.str('hello'));
* ```
*/
export class val<T extends NodeBuilder> extends NodeBuilder {
public readonly type = 'val';
constructor(public readonly value: T) {
super((builder) => {
const valId = builder.val();
const valueId = value.build(builder);
builder.setVal(valId, valueId);
return valId;
});
}
}
/**
* The `vec` class represents a "vec" JSON CRDT node. As the generic type
* parameter, it takes a tuple of node builders.
*
* Example:
*
* ```ts
* s.vec(s.con(0), s.con(1));
* s.vec(s.str(''), s.str('hello'));
* ```
*/
export class vec<T extends NodeBuilder[]> extends NodeBuilder {
public readonly type = 'vec';
constructor(public readonly value: T) {
super((builder) => {
const vecId = builder.vec();
const length = value.length;
if (length) {
const elementPairs: [index: number, value: ITimestampStruct][] = [];
for (let i = 0; i < length; i++) {
const element = value[i];
const elementId = element.build(builder);
elementPairs.push([i, elementId]);
}
builder.insVec(vecId, elementPairs);
}
return vecId;
});
}
}
/**
* The `obj` class represents a "obj" JSON CRDT node. As the generic type
* parameter, it takes a record of node builders. The optional generic type
* parameter is a record of optional keys.
*
* Example:
*
* ```ts
* s.obj({
* name: s.str(''),
* age: s.con(0),
* });
* ```
*
* Specify optional keys as the second argument:
*
* ```ts
* s.obj(
* {
* href: s.str('https://example.com'),
* },
* {
* title: s.str(''),
* },
* )
* ```
*
* Or, specify only the type, using the `optional` method:
*
* ```ts
* s.obj({
* href: s.str('https://example.com'),
* })
* .optional<nodes.obj({
* title: nodes.str,
* })>()
* ```
*/
export class obj<
T extends Record<string, NodeBuilder>,
// biome-ignore lint: TODO: improve {} type in the future
O extends Record<string, NodeBuilder> = {},
> extends NodeBuilder {
public readonly type = 'obj';
constructor(
public readonly obj: T,
public readonly opt?: O,
) {
super((builder) => {
const objId = builder.obj();
const keyValuePairs: [key: string, value: ITimestampStruct][] = [];
const merged = {...obj, ...opt};
const keys = Object.keys(merged);
const length = keys.length;
if (length) {
for (let i = 0; i < length; i++) {
const key = keys[i];
const valueId = merged[key].build(builder);
keyValuePairs.push([key, valueId]);
}
builder.insObj(objId, keyValuePairs);
}
return objId;
});
}
public optional<OO extends Record<string, NodeBuilder>>(): obj<T, O & OO> {
return this as unknown as obj<T, O & OO>;
}
}
/**
* A type alias for {@link obj}. It creates a "map" node schema, which is an
* object where a key can be any string and the value is of the same type.
*
* Example:
*
* ```ts
* s.map<nodes.con<number>>
* ```
*/
export type map<R extends NodeBuilder> = obj<Record<string, R>, Record<string, R>>;
/**
* The `arr` class represents a "arr" JSON CRDT node. As the generic type
* parameter, it an array of node builders.
*
* Example:
*
* ```ts
* s.arr([s.con(0), s.con(1)]);
* s.arr([s.str(''), s.str('hello')]);
* ```
*/
export class arr<T extends NodeBuilder> extends NodeBuilder {
public readonly type = 'arr';
constructor(public readonly arr: T[]) {
super((builder) => {
const arrId = builder.arr();
const length = arr.length;
if (length) {
const valueIds: ITimestampStruct[] = [];
for (let i = 0; i < length; i++) valueIds.push(arr[i].build(builder));
builder.insArr(arrId, arrId, valueIds);
}
return arrId;
});
}
}
/**
* Creates an extension node schema. The extension node is a tuple with a
* sentinel header and a data node. The sentinel header is a 3-byte
* {@link Uint8Array}, which makes this "vec" node to be treated as an
* extension "ext" node.
*
* The 3-byte header consists of the extension ID, the SID of the tuple ID,
* and the time of the tuple ID:
*
* - 1 byte for the extension id
* - 1 byte for the sid of the tuple id, modulo 256
* - 1 byte for the time of the tuple id, modulo 256
*/
export class ext<ID extends number, T extends NodeBuilder> extends NodeBuilder {
public readonly type = 'ext';
/**
* @param id A unique extension ID.
* @param data Schema of the data node of the extension.
*/
constructor(
public readonly id: ID,
public readonly data: T,
) {
super((builder) => {
const buf = new Uint8Array([id, 0, 0]);
const tupleId = builder.vec();
buf[1] = tupleId.sid % 256;
buf[2] = tupleId.time % 256;
builder.insVec(tupleId, [
[0, builder.constOrJson(s.con(buf))],
[1, data.build(builder)],
]);
return tupleId;
});
}
}
/**
* Converts a POJO value to a JSON CRDT node schema. It recursively converts
* the value to a node schema, where each property is a node builder.
*/
export type json<V> = V extends NodeBuilder
? V
: V extends Array<infer T>
? nodes.arr<json<T>>
: V extends Uint8Array
? nodes.bin
: V extends Record<string, any>
? nodes.obj<{[K in keyof V]: jsonCon<V[K]>}>
: V extends string
? nodes.str<V>
: V extends boolean
? nodes.val<nodes.con<boolean>>
: nodes.val<nodes.con<V>>;
/**
* Same as {@link json}, but converts constant values to
* {@link nodes.con} nodes, instead wrapping them into {@link nodes.val} nodes.
*/
export type jsonCon<V> = V extends number
? nodes.con<V>
: V extends boolean
? nodes.con<V>
: V extends null
? nodes.con<V>
: V extends undefined
? nodes.con<V>
: V extends ITimestampStruct
? nodes.val<nodes.con<V>>
: json<V>;
}
/**
* Schema builder. Use this to create a JSON CRDT model schema and the default
* value.
*
* Example:
*
* ```typescript
* const schema = s.obj({
* name: s.str(''),
* age: s.con(0),
* tags: s.arr<nodes.con<string>>([]),
* });
* ```
*/
export const schema = {
/**
* Creates a "con" node schema and the default value.
*
* @param raw Raw default value.
*/
con: <T extends unknown | ITimestampStruct>(raw: T) => new nodes.con<T>(raw),
/**
* Creates a "str" node schema and the default value.
*
* @param str Default value.
*/
str: <T extends string>(str: T) => new nodes.str<T>(str || ('' as T)),
/**
* Creates a "bin" node schema and the default value.
*
* @param bin Default value.
*/
bin: (bin: Uint8Array) => new nodes.bin(bin),
/**
* Creates a "val" node schema and the default value.
*
* @param val Default value.
*/
val: <T extends NodeBuilder>(val: T) => new nodes.val<T>(val),
/**
* Creates a "vec" node schema and the default value.
*
* @param vec Default value.
*/
vec: <T extends NodeBuilder[]>(...vec: T) => new nodes.vec<T>(vec),
/**
* Creates a "obj" node schema and the default value.
*
* @param obj Default value, required object keys.
* @param opt Default value of optional object keys.
*/
obj: <T extends Record<string, NodeBuilder>, O extends Record<string, NodeBuilder>>(obj: T, opt?: O) =>
new nodes.obj<T, O>(obj, opt),
/**
* This is an alias for {@link schema.obj}. It creates a "map" node schema,
* which is an object where a key can be any string and the value is of the
* same type.
*
* @param obj Default value.
*/
map: <R extends NodeBuilder>(obj: Record<string, R>): nodes.map<R> =>
schema.obj<Record<string, R>, Record<string, R>>(obj),
/**
* Creates an "arr" node schema and the default value.
*
* @param arr Default value.
*/
arr: <T extends NodeBuilder>(arr: T[]) => new nodes.arr<T>(arr),
/**
* Recursively creates a node tree from any POJO.
*/
json: <T>(value: T): nodes.json<T> => {
switch (typeof value) {
case 'object': {
if (!value) return s.val(s.con(value)) as any;
if (value instanceof NodeBuilder) return value as any;
else if (Array.isArray(value)) return s.arr(value.map((v) => s.json(v))) as any;
else if (isUint8Array(value)) return s.bin(value) as any;
else Iif (value instanceof Timestamp) return s.val(s.con(value)) as any;
else {
const obj: Record<string, NodeBuilder> = {};
const keys = Object.keys(value);
for (const key of keys) obj[key] = s.jsonCon((value as any)[key]);
return s.obj(obj) as any;
}
}
case 'string':
return s.str(value) as any;
default:
return s.val(s.con(value)) as any;
}
},
/**
* Recursively creates a schema node tree from any POJO. Same as {@link json}, but
* converts constant values to {@link nodes.con} nodes, instead wrapping them into
* {@link nodes.val} nodes.
*
* @todo Remove this once "arr" RGA supports in-place updates.
*/
jsonCon: <T>(value: T): nodes.jsonCon<T> => {
return maybeConst(value) ? (s.con(value) as any) : (s.json(value) as any);
},
/**
* Creates an extension node schema.
*
* @param id A unique extension ID.
* @param data Schema of the data node of the extension.
*/
ext: <ID extends number, T extends NodeBuilder>(id: ID, data: T) => new nodes.ext<ID, T>(id, data),
};
/**
* Schema builder. Use this to create a JSON CRDT model schema and the default
* value. Alias for {@link schema}.
*/
export const s = schema;
|