@genesislcap/foundation-utils 15.89.0 → 15.90.1-FUI-2666.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -258,204 +258,6 @@
258
258
  }
259
259
  ]
260
260
  },
261
- {
262
- "kind": "javascript-module",
263
- "path": "src/data/inMemoryDatabase.ts",
264
- "declarations": [
265
- {
266
- "kind": "class",
267
- "description": "An in memory database of specific DatabaseRecord types.",
268
- "name": "InMemoryDatabase",
269
- "members": [
270
- {
271
- "kind": "field",
272
- "name": "isWorking",
273
- "type": {
274
- "text": "boolean"
275
- },
276
- "privacy": "public",
277
- "default": "false"
278
- },
279
- {
280
- "kind": "field",
281
- "name": "records",
282
- "type": {
283
- "text": "Record<string, T>"
284
- },
285
- "privacy": "private",
286
- "default": "{}"
287
- },
288
- {
289
- "kind": "field",
290
- "name": "beforeUpdateListeners",
291
- "privacy": "private"
292
- },
293
- {
294
- "kind": "field",
295
- "name": "afterUpdateListeners",
296
- "privacy": "private"
297
- },
298
- {
299
- "kind": "method",
300
- "name": "create",
301
- "privacy": "public",
302
- "return": {
303
- "type": {
304
- "text": "Promise<DatabaseAccessResult.Create<T>>"
305
- }
306
- },
307
- "parameters": [
308
- {
309
- "name": "newValue",
310
- "type": {
311
- "text": "Omit<T, 'id'>"
312
- }
313
- }
314
- ]
315
- },
316
- {
317
- "kind": "method",
318
- "name": "read",
319
- "privacy": "public",
320
- "return": {
321
- "type": {
322
- "text": "Promise<DatabaseAccessResult.Read<T>>"
323
- }
324
- },
325
- "parameters": [
326
- {
327
- "name": "id",
328
- "type": {
329
- "text": "string"
330
- }
331
- }
332
- ]
333
- },
334
- {
335
- "kind": "method",
336
- "name": "update",
337
- "privacy": "public",
338
- "return": {
339
- "type": {
340
- "text": "Promise<DatabaseAccessResult.Update<T>>"
341
- }
342
- },
343
- "parameters": [
344
- {
345
- "name": "id",
346
- "type": {
347
- "text": "string"
348
- }
349
- },
350
- {
351
- "name": "newValue",
352
- "type": {
353
- "text": "Omit<Partial<T>, 'id'>"
354
- }
355
- }
356
- ]
357
- },
358
- {
359
- "kind": "method",
360
- "name": "delete",
361
- "privacy": "public",
362
- "return": {
363
- "type": {
364
- "text": "Promise<DatabaseAccessResult.Delete>"
365
- }
366
- },
367
- "parameters": [
368
- {
369
- "name": "id",
370
- "type": {
371
- "text": "string"
372
- }
373
- }
374
- ]
375
- },
376
- {
377
- "kind": "method",
378
- "name": "visit",
379
- "privacy": "public",
380
- "return": {
381
- "type": {
382
- "text": "Promise<void>"
383
- }
384
- },
385
- "parameters": [
386
- {
387
- "name": "visitor",
388
- "type": {
389
- "text": "(record: T) => void"
390
- }
391
- }
392
- ]
393
- },
394
- {
395
- "kind": "method",
396
- "name": "onBeforeUpdate",
397
- "privacy": "public",
398
- "return": {
399
- "type": {
400
- "text": "() => void"
401
- }
402
- },
403
- "parameters": [
404
- {
405
- "name": "listener",
406
- "type": {
407
- "text": "Listener<DatabaseEvent.BeforeUpdate<T>>"
408
- }
409
- }
410
- ]
411
- },
412
- {
413
- "kind": "method",
414
- "name": "onAfterUpdate",
415
- "privacy": "public",
416
- "return": {
417
- "type": {
418
- "text": "() => void"
419
- }
420
- },
421
- "parameters": [
422
- {
423
- "name": "listener",
424
- "type": {
425
- "text": "Listener<DatabaseEvent.AfterUpdate<T>>"
426
- }
427
- }
428
- ]
429
- }
430
- ]
431
- }
432
- ],
433
- "exports": [
434
- {
435
- "kind": "js",
436
- "name": "InMemoryDatabase",
437
- "declaration": {
438
- "name": "InMemoryDatabase",
439
- "module": "src/data/inMemoryDatabase.ts"
440
- }
441
- }
442
- ]
443
- },
444
- {
445
- "kind": "javascript-module",
446
- "path": "src/data/index.ts",
447
- "declarations": [],
448
- "exports": [
449
- {
450
- "kind": "js",
451
- "name": "*",
452
- "declaration": {
453
- "name": "*",
454
- "package": "./inMemoryDatabase"
455
- }
456
- }
457
- ]
458
- },
459
261
  {
460
262
  "kind": "javascript-module",
461
263
  "path": "src/design-system/design-system.ts",
@@ -694,6 +496,204 @@
694
496
  }
695
497
  ]
696
498
  },
499
+ {
500
+ "kind": "javascript-module",
501
+ "path": "src/data/inMemoryDatabase.ts",
502
+ "declarations": [
503
+ {
504
+ "kind": "class",
505
+ "description": "An in memory database of specific DatabaseRecord types.",
506
+ "name": "InMemoryDatabase",
507
+ "members": [
508
+ {
509
+ "kind": "field",
510
+ "name": "isWorking",
511
+ "type": {
512
+ "text": "boolean"
513
+ },
514
+ "privacy": "public",
515
+ "default": "false"
516
+ },
517
+ {
518
+ "kind": "field",
519
+ "name": "records",
520
+ "type": {
521
+ "text": "Record<string, T>"
522
+ },
523
+ "privacy": "private",
524
+ "default": "{}"
525
+ },
526
+ {
527
+ "kind": "field",
528
+ "name": "beforeUpdateListeners",
529
+ "privacy": "private"
530
+ },
531
+ {
532
+ "kind": "field",
533
+ "name": "afterUpdateListeners",
534
+ "privacy": "private"
535
+ },
536
+ {
537
+ "kind": "method",
538
+ "name": "create",
539
+ "privacy": "public",
540
+ "return": {
541
+ "type": {
542
+ "text": "Promise<DatabaseAccessResult.Create<T>>"
543
+ }
544
+ },
545
+ "parameters": [
546
+ {
547
+ "name": "newValue",
548
+ "type": {
549
+ "text": "Omit<T, 'id'>"
550
+ }
551
+ }
552
+ ]
553
+ },
554
+ {
555
+ "kind": "method",
556
+ "name": "read",
557
+ "privacy": "public",
558
+ "return": {
559
+ "type": {
560
+ "text": "Promise<DatabaseAccessResult.Read<T>>"
561
+ }
562
+ },
563
+ "parameters": [
564
+ {
565
+ "name": "id",
566
+ "type": {
567
+ "text": "string"
568
+ }
569
+ }
570
+ ]
571
+ },
572
+ {
573
+ "kind": "method",
574
+ "name": "update",
575
+ "privacy": "public",
576
+ "return": {
577
+ "type": {
578
+ "text": "Promise<DatabaseAccessResult.Update<T>>"
579
+ }
580
+ },
581
+ "parameters": [
582
+ {
583
+ "name": "id",
584
+ "type": {
585
+ "text": "string"
586
+ }
587
+ },
588
+ {
589
+ "name": "newValue",
590
+ "type": {
591
+ "text": "Omit<Partial<T>, 'id'>"
592
+ }
593
+ }
594
+ ]
595
+ },
596
+ {
597
+ "kind": "method",
598
+ "name": "delete",
599
+ "privacy": "public",
600
+ "return": {
601
+ "type": {
602
+ "text": "Promise<DatabaseAccessResult.Delete>"
603
+ }
604
+ },
605
+ "parameters": [
606
+ {
607
+ "name": "id",
608
+ "type": {
609
+ "text": "string"
610
+ }
611
+ }
612
+ ]
613
+ },
614
+ {
615
+ "kind": "method",
616
+ "name": "visit",
617
+ "privacy": "public",
618
+ "return": {
619
+ "type": {
620
+ "text": "Promise<void>"
621
+ }
622
+ },
623
+ "parameters": [
624
+ {
625
+ "name": "visitor",
626
+ "type": {
627
+ "text": "(record: T) => void"
628
+ }
629
+ }
630
+ ]
631
+ },
632
+ {
633
+ "kind": "method",
634
+ "name": "onBeforeUpdate",
635
+ "privacy": "public",
636
+ "return": {
637
+ "type": {
638
+ "text": "() => void"
639
+ }
640
+ },
641
+ "parameters": [
642
+ {
643
+ "name": "listener",
644
+ "type": {
645
+ "text": "Listener<DatabaseEvent.BeforeUpdate<T>>"
646
+ }
647
+ }
648
+ ]
649
+ },
650
+ {
651
+ "kind": "method",
652
+ "name": "onAfterUpdate",
653
+ "privacy": "public",
654
+ "return": {
655
+ "type": {
656
+ "text": "() => void"
657
+ }
658
+ },
659
+ "parameters": [
660
+ {
661
+ "name": "listener",
662
+ "type": {
663
+ "text": "Listener<DatabaseEvent.AfterUpdate<T>>"
664
+ }
665
+ }
666
+ ]
667
+ }
668
+ ]
669
+ }
670
+ ],
671
+ "exports": [
672
+ {
673
+ "kind": "js",
674
+ "name": "InMemoryDatabase",
675
+ "declaration": {
676
+ "name": "InMemoryDatabase",
677
+ "module": "src/data/inMemoryDatabase.ts"
678
+ }
679
+ }
680
+ ]
681
+ },
682
+ {
683
+ "kind": "javascript-module",
684
+ "path": "src/data/index.ts",
685
+ "declarations": [],
686
+ "exports": [
687
+ {
688
+ "kind": "js",
689
+ "name": "*",
690
+ "declaration": {
691
+ "name": "*",
692
+ "package": "./inMemoryDatabase"
693
+ }
694
+ }
695
+ ]
696
+ },
697
697
  {
698
698
  "kind": "javascript-module",
699
699
  "path": "src/directives/index.ts",
@@ -32,6 +32,11 @@ export declare const createObserver: <EventType>() => Observer<EventType>;
32
32
  * @param element - HTMLElement to observe
33
33
  * @param callback - any function called when the visibility changes
34
34
  * @returns A cleanup function to disconnect the observer
35
+ * @remarks
36
+ * The observer uses the implicit root, the top-level viewport, so content of an open modal (a
37
+ * `<dialog>` opened with `showModal()`, or a `position: fixed` overlay) is reported as visible when
38
+ * it is on screen. An element is reported as hidden while it is scrolled out of the viewport, and an
39
+ * element inside an iframe is reported as hidden while the iframe itself is off screen.
35
40
  * @public
36
41
  */
37
42
  export declare const respondToVisibility: (element: HTMLElement, callback: (arg0: boolean) => any) => (() => void);
@@ -1 +1 @@
1
- {"version":3,"file":"observer.d.ts","sourceRoot":"","sources":["../../../src/observer/observer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,SAAS,IAAI,CAAC,EAAE,EAAE,SAAS,KAAK,IAAI,CAAC;AAC1D;;;;GAIG;AACH,MAAM,MAAM,SAAS,CAAC,SAAS,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,SAAS,CAAC,KAAK,MAAM,IAAI,CAAC;AACjF;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,QAAQ,CAAC,SAAS;IACjC,SAAS,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;IAChC,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;CAC7B;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,SAAS,OAAK,QAAQ,CAAC,SAAS,CAW9D,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAC9B,SAAS,WAAW,EACpB,UAAU,CAAC,IAAI,EAAE,OAAO,KAAK,GAAG,KAC/B,CAAC,MAAM,IAAI,CAgBb,CAAC"}
1
+ {"version":3,"file":"observer.d.ts","sourceRoot":"","sources":["../../../src/observer/observer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,SAAS,IAAI,CAAC,EAAE,EAAE,SAAS,KAAK,IAAI,CAAC;AAC1D;;;;GAIG;AACH,MAAM,MAAM,SAAS,CAAC,SAAS,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,SAAS,CAAC,KAAK,MAAM,IAAI,CAAC;AACjF;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,QAAQ,CAAC,SAAS;IACjC,SAAS,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;IAChC,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;CAC7B;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,SAAS,OAAK,QAAQ,CAAC,SAAS,CAW9D,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,mBAAmB,GAC9B,SAAS,WAAW,EACpB,UAAU,CAAC,IAAI,EAAE,OAAO,KAAK,GAAG,KAC/B,CAAC,MAAM,IAAI,CAYb,CAAC"}
@@ -19,17 +19,19 @@ export const createObserver = () => {
19
19
  * @param element - HTMLElement to observe
20
20
  * @param callback - any function called when the visibility changes
21
21
  * @returns A cleanup function to disconnect the observer
22
+ * @remarks
23
+ * The observer uses the implicit root, the top-level viewport, so content of an open modal (a
24
+ * `<dialog>` opened with `showModal()`, or a `position: fixed` overlay) is reported as visible when
25
+ * it is on screen. An element is reported as hidden while it is scrolled out of the viewport, and an
26
+ * element inside an iframe is reported as hidden while the iframe itself is off screen.
22
27
  * @public
23
28
  */
24
29
  export const respondToVisibility = (element, callback) => {
25
- const options = {
26
- root: document.documentElement,
27
- };
28
30
  const observer = new IntersectionObserver((entries) => {
29
31
  entries.forEach((entry) => {
30
32
  callback(entry.intersectionRatio > 0);
31
33
  });
32
- }, options);
34
+ });
33
35
  observer.observe(element);
34
36
  return () => {
35
37
  observer.disconnect();
@@ -19589,7 +19589,7 @@
19589
19589
  {
19590
19590
  "kind": "Function",
19591
19591
  "canonicalReference": "@genesislcap/foundation-utils!respondToVisibility:function(1)",
19592
- "docComment": "/**\n * Setup an `IntersectionObserver` which will activate a callback function when an element becomes visible on screen\n *\n * @param element - HTMLElement to observe\n *\n * @param callback - any function called when the visibility changes\n *\n * @returns A cleanup function to disconnect the observer\n *\n * @public\n */\n",
19592
+ "docComment": "/**\n * Setup an `IntersectionObserver` which will activate a callback function when an element becomes visible on screen\n *\n * @remarks\n *\n * The observer uses the implicit root, the top-level viewport, so content of an open modal (a `<dialog>` opened with `showModal()`, or a `position: fixed` overlay) is reported as visible when it is on screen. An element is reported as hidden while it is scrolled out of the viewport, and an element inside an iframe is reported as hidden while the iframe itself is off screen.\n *\n * @param element - HTMLElement to observe\n *\n * @param callback - any function called when the visibility changes\n *\n * @returns A cleanup function to disconnect the observer\n *\n * @public\n */\n",
19593
19593
  "excerptTokens": [
19594
19594
  {
19595
19595
  "kind": "Content",
@@ -2463,6 +2463,11 @@ export declare type ResourceType = (typeof ResourceType)[keyof typeof ResourceTy
2463
2463
  * @param element - HTMLElement to observe
2464
2464
  * @param callback - any function called when the visibility changes
2465
2465
  * @returns A cleanup function to disconnect the observer
2466
+ * @remarks
2467
+ * The observer uses the implicit root, the top-level viewport, so content of an open modal (a
2468
+ * `<dialog>` opened with `showModal()`, or a `position: fixed` overlay) is reported as visible when
2469
+ * it is on screen. An element is reported as hidden while it is scrolled out of the viewport, and an
2470
+ * element inside an iframe is reported as hidden while the iframe itself is off screen.
2466
2471
  * @public
2467
2472
  */
2468
2473
  export declare const respondToVisibility: (element: HTMLElement, callback: (arg0: boolean) => any) => (() => void);
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-utils",
3
3
  "description": "Genesis Foundation Utils",
4
- "version": "15.89.0",
4
+ "version": "15.90.1-FUI-2666.5",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -29,17 +29,17 @@
29
29
  }
30
30
  },
31
31
  "devDependencies": {
32
- "@genesislcap/foundation-testing": "15.89.0",
33
- "@genesislcap/genx": "15.89.0",
34
- "@genesislcap/ts-builder": "15.89.0",
35
- "@genesislcap/uvu-playwright-builder": "15.89.0",
36
- "@genesislcap/vite-builder": "15.89.0",
37
- "@genesislcap/webpack-builder": "15.89.0",
32
+ "@genesislcap/foundation-testing": "15.90.1-FUI-2666.5",
33
+ "@genesislcap/genx": "15.90.1-FUI-2666.5",
34
+ "@genesislcap/ts-builder": "15.90.1-FUI-2666.5",
35
+ "@genesislcap/uvu-playwright-builder": "15.90.1-FUI-2666.5",
36
+ "@genesislcap/vite-builder": "15.90.1-FUI-2666.5",
37
+ "@genesislcap/webpack-builder": "15.90.1-FUI-2666.5",
38
38
  "@types/json-schema": "^7.0.11"
39
39
  },
40
40
  "dependencies": {
41
- "@genesislcap/expression-builder": "15.89.0",
42
- "@genesislcap/foundation-logger": "15.89.0",
41
+ "@genesislcap/expression-builder": "15.90.1-FUI-2666.5",
42
+ "@genesislcap/foundation-logger": "15.90.1-FUI-2666.5",
43
43
  "@microsoft/fast-components": "2.30.6",
44
44
  "@microsoft/fast-element": "1.14.0",
45
45
  "@microsoft/fast-foundation": "2.50.0",