@fluidframework/core-interfaces 2.0.0-dev-rc.2.0.0.245554 → 2.0.0-dev-rc.3.0.0.250606

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.
Files changed (38) hide show
  1. package/api-report/core-interfaces.api.md +0 -50
  2. package/dist/core-interfaces-alpha.d.ts +0 -99
  3. package/dist/core-interfaces-beta.d.ts +0 -16
  4. package/dist/core-interfaces-public.d.ts +0 -16
  5. package/dist/core-interfaces-untrimmed.d.ts +0 -157
  6. package/dist/handles.d.ts +1 -1
  7. package/dist/handles.d.ts.map +1 -1
  8. package/dist/handles.js.map +1 -1
  9. package/dist/index.d.ts +0 -2
  10. package/dist/index.d.ts.map +1 -1
  11. package/dist/index.js +1 -5
  12. package/dist/index.js.map +1 -1
  13. package/lib/core-interfaces-alpha.d.ts +0 -99
  14. package/lib/core-interfaces-beta.d.ts +0 -16
  15. package/lib/core-interfaces-public.d.ts +0 -16
  16. package/lib/core-interfaces-untrimmed.d.ts +0 -157
  17. package/lib/handles.d.ts +1 -1
  18. package/lib/handles.d.ts.map +1 -1
  19. package/lib/handles.js.map +1 -1
  20. package/lib/index.d.ts +0 -2
  21. package/lib/index.d.ts.map +1 -1
  22. package/lib/index.js +0 -1
  23. package/lib/index.js.map +1 -1
  24. package/lib/test/types/fluidObjectTypes.js.map +1 -1
  25. package/lib/test/types/validateCoreInterfacesPrevious.generated.js +20 -18
  26. package/lib/test/types/validateCoreInterfacesPrevious.generated.js.map +1 -1
  27. package/package.json +45 -6
  28. package/src/handles.ts +1 -1
  29. package/src/index.ts +0 -9
  30. package/dist/fluidPackage.d.ts +0 -153
  31. package/dist/fluidPackage.d.ts.map +0 -1
  32. package/dist/fluidPackage.js +0 -41
  33. package/dist/fluidPackage.js.map +0 -1
  34. package/lib/fluidPackage.d.ts +0 -153
  35. package/lib/fluidPackage.d.ts.map +0 -1
  36. package/lib/fluidPackage.js +0 -36
  37. package/lib/fluidPackage.js.map +0 -1
  38. package/src/fluidPackage.ts +0 -179
@@ -230,27 +230,6 @@ export type IEventTransformer<TThis, TEvent extends IEvent> = TEvent extends {
230
230
  (event: string, listener: (...args: any[]) => void): any;
231
231
  } ? TransformedEvent<TThis, E0, A0> : TransformedEvent<TThis, string, any[]>;
232
232
 
233
- // @alpha @deprecated
234
- export interface IFluidCodeDetails {
235
- readonly config?: IFluidCodeDetailsConfig;
236
- readonly package: string | Readonly<IFluidPackage>;
237
- }
238
-
239
- // @internal @deprecated (undocumented)
240
- export const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer;
241
-
242
- // @internal @deprecated
243
- export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
244
- compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;
245
- satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
246
- }
247
-
248
- // @alpha @deprecated
249
- export interface IFluidCodeDetailsConfig {
250
- // (undocumented)
251
- readonly [key: string]: string;
252
- }
253
-
254
233
  // @public (undocumented)
255
234
  export const IFluidHandle: keyof IProvideFluidHandle;
256
235
 
@@ -288,23 +267,6 @@ export interface IFluidLoadable extends IProvideFluidLoadable {
288
267
  handle: IFluidHandle;
289
268
  }
290
269
 
291
- // @alpha @deprecated
292
- export interface IFluidPackage {
293
- [key: string]: unknown;
294
- fluid: {
295
- [environment: string]: undefined | IFluidPackageEnvironment;
296
- };
297
- name: string;
298
- }
299
-
300
- // @alpha @deprecated
301
- export interface IFluidPackageEnvironment {
302
- [target: string]: undefined | {
303
- files: string[];
304
- [key: string]: unknown;
305
- };
306
- }
307
-
308
270
  // @internal (undocumented)
309
271
  export const IFluidRunnable: keyof IProvideFluidRunnable;
310
272
 
@@ -328,12 +290,6 @@ export interface ILoggingError extends Error {
328
290
  getTelemetryProperties(): ITelemetryBaseProperties;
329
291
  }
330
292
 
331
- // @internal @deprecated (undocumented)
332
- export interface IProvideFluidCodeDetailsComparer {
333
- // (undocumented)
334
- readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
335
- }
336
-
337
293
  // @public (undocumented)
338
294
  export interface IProvideFluidHandle {
339
295
  // (undocumented)
@@ -388,12 +344,6 @@ export interface IResponse {
388
344
  value: any;
389
345
  }
390
346
 
391
- // @internal @deprecated (undocumented)
392
- export const isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>;
393
-
394
- // @internal @deprecated
395
- export const isFluidPackage: (pkg: unknown) => pkg is Readonly<IFluidPackage>;
396
-
397
347
  // @internal (undocumented)
398
348
  export interface ISignalEnvelope {
399
349
  address?: string;
@@ -448,38 +448,6 @@ export declare type IEventTransformer<TThis, TEvent extends IEvent> = TEvent ext
448
448
  (event: string, listener: (...args: any[]) => void): any;
449
449
  } ? TransformedEvent<TThis, E0, A0> : TransformedEvent<TThis, string, any[]>;
450
450
 
451
- /**
452
- * Data structure used to describe the code to load on the Fluid document.
453
- *
454
- * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetails}
455
- * to have code loading modules in same package.
456
- * @alpha
457
- */
458
- export declare interface IFluidCodeDetails {
459
- /**
460
- * The code package to be used on the Fluid document. This is either the package name which will be loaded
461
- * from a package manager. Or the expanded Fluid package.
462
- */
463
- readonly package: string | Readonly<IFluidPackage>;
464
- /**
465
- * Configuration details. This includes links to the package manager and base CDNs.
466
- */
467
- readonly config?: IFluidCodeDetailsConfig;
468
- }
469
-
470
- /* Excluded from this release type: IFluidCodeDetailsComparer */
471
-
472
- /**
473
- * Package manager configuration. Provides a key value mapping of config values.
474
- *
475
- * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsConfig}
476
- * to have code loading modules in same package.
477
- * @alpha
478
- */
479
- export declare interface IFluidCodeDetailsConfig {
480
- readonly [key: string]: string;
481
- }
482
-
483
451
  /**
484
452
  * @public
485
453
  */
@@ -562,75 +530,12 @@ export declare interface IFluidLoadable extends IProvideFluidLoadable {
562
530
  handle: IFluidHandle;
563
531
  }
564
532
 
565
- /**
566
- * Fluid-specific properties expected on a package to be loaded by the code loader.
567
- * While compatible with the npm package format it is not necessary that that package is an
568
- * npm package:
569
- * {@link https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid}
570
- *
571
- * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackage}
572
- * to have code loading modules in same package.
573
- * @alpha
574
- */
575
- export declare interface IFluidPackage {
576
- /**
577
- * The name of the package that this code represnets
578
- */
579
- name: string;
580
- /**
581
- * This object represents the Fluid specific properties of the package
582
- */
583
- fluid: {
584
- /**
585
- * The name of the of the environment. This should be something like browser, or node
586
- * and contain the necessary targets for loading this code in that environment.
587
- */
588
- [environment: string]: undefined | IFluidPackageEnvironment;
589
- };
590
- /**
591
- * General access for extended fields as specific usages will
592
- * likely have additional infornamation like a definition of
593
- * compatible versions, or deployment information like rings or rollouts.
594
- */
595
- [key: string]: unknown;
596
- }
597
-
598
- /**
599
- * Specifies an environment on Fluid property of an {@link IFluidPackage}.
600
- *
601
- * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}
602
- * to have code loading modules in same package.
603
- * @alpha
604
- */
605
- export declare interface IFluidPackageEnvironment {
606
- /**
607
- * The name of the target. For a browser environment, this could be umd for scripts
608
- * or css for styles.
609
- */
610
- [target: string]: undefined | {
611
- /**
612
- * List of files for the target. These can be relative or absolute.
613
- * The code loader should resolve relative paths, and validate all
614
- * full urls.
615
- */
616
- files: string[];
617
- /**
618
- * General access for extended fields as specific usages will
619
- * likely have additional infornamation like a definition
620
- * of Library, the entrypoint for umd packages
621
- */
622
- [key: string]: unknown;
623
- };
624
- }
625
-
626
533
  /* Excluded from this release type: IFluidRunnable */
627
534
 
628
535
  /* Excluded from this release type: IGenericError */
629
536
 
630
537
  /* Excluded from this release type: ILoggingError */
631
538
 
632
- /* Excluded from this release type: IProvideFluidCodeDetailsComparer */
633
-
634
539
  /**
635
540
  * @public
636
541
  */
@@ -682,10 +587,6 @@ export declare interface IResponse {
682
587
  stack?: string;
683
588
  }
684
589
 
685
- /* Excluded from this release type: isFluidCodeDetails */
686
-
687
- /* Excluded from this release type: isFluidPackage */
688
-
689
590
  /* Excluded from this release type: ISignalEnvelope */
690
591
 
691
592
  /**
@@ -418,12 +418,6 @@ export declare type IEventTransformer<TThis, TEvent extends IEvent> = TEvent ext
418
418
  (event: string, listener: (...args: any[]) => void): any;
419
419
  } ? TransformedEvent<TThis, E0, A0> : TransformedEvent<TThis, string, any[]>;
420
420
 
421
- /* Excluded from this release type: IFluidCodeDetails */
422
-
423
- /* Excluded from this release type: IFluidCodeDetailsComparer */
424
-
425
- /* Excluded from this release type: IFluidCodeDetailsConfig */
426
-
427
421
  /**
428
422
  * @public
429
423
  */
@@ -506,18 +500,12 @@ export declare interface IFluidLoadable extends IProvideFluidLoadable {
506
500
  handle: IFluidHandle;
507
501
  }
508
502
 
509
- /* Excluded from this release type: IFluidPackage */
510
-
511
- /* Excluded from this release type: IFluidPackageEnvironment */
512
-
513
503
  /* Excluded from this release type: IFluidRunnable */
514
504
 
515
505
  /* Excluded from this release type: IGenericError */
516
506
 
517
507
  /* Excluded from this release type: ILoggingError */
518
508
 
519
- /* Excluded from this release type: IProvideFluidCodeDetailsComparer */
520
-
521
509
  /**
522
510
  * @public
523
511
  */
@@ -569,10 +557,6 @@ export declare interface IResponse {
569
557
  stack?: string;
570
558
  }
571
559
 
572
- /* Excluded from this release type: isFluidCodeDetails */
573
-
574
- /* Excluded from this release type: isFluidPackage */
575
-
576
560
  /* Excluded from this release type: ISignalEnvelope */
577
561
 
578
562
  /**
@@ -418,12 +418,6 @@ export declare type IEventTransformer<TThis, TEvent extends IEvent> = TEvent ext
418
418
  (event: string, listener: (...args: any[]) => void): any;
419
419
  } ? TransformedEvent<TThis, E0, A0> : TransformedEvent<TThis, string, any[]>;
420
420
 
421
- /* Excluded from this release type: IFluidCodeDetails */
422
-
423
- /* Excluded from this release type: IFluidCodeDetailsComparer */
424
-
425
- /* Excluded from this release type: IFluidCodeDetailsConfig */
426
-
427
421
  /**
428
422
  * @public
429
423
  */
@@ -506,18 +500,12 @@ export declare interface IFluidLoadable extends IProvideFluidLoadable {
506
500
  handle: IFluidHandle;
507
501
  }
508
502
 
509
- /* Excluded from this release type: IFluidPackage */
510
-
511
- /* Excluded from this release type: IFluidPackageEnvironment */
512
-
513
503
  /* Excluded from this release type: IFluidRunnable */
514
504
 
515
505
  /* Excluded from this release type: IGenericError */
516
506
 
517
507
  /* Excluded from this release type: ILoggingError */
518
508
 
519
- /* Excluded from this release type: IProvideFluidCodeDetailsComparer */
520
-
521
509
  /**
522
510
  * @public
523
511
  */
@@ -569,10 +557,6 @@ export declare interface IResponse {
569
557
  stack?: string;
570
558
  }
571
559
 
572
- /* Excluded from this release type: isFluidCodeDetails */
573
-
574
- /* Excluded from this release type: isFluidPackage */
575
-
576
560
  /* Excluded from this release type: ISignalEnvelope */
577
561
 
578
562
  /**
@@ -448,75 +448,6 @@ export declare type IEventTransformer<TThis, TEvent extends IEvent> = TEvent ext
448
448
  (event: string, listener: (...args: any[]) => void): any;
449
449
  } ? TransformedEvent<TThis, E0, A0> : TransformedEvent<TThis, string, any[]>;
450
450
 
451
- /**
452
- * Data structure used to describe the code to load on the Fluid document.
453
- *
454
- * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetails}
455
- * to have code loading modules in same package.
456
- * @alpha
457
- */
458
- export declare interface IFluidCodeDetails {
459
- /**
460
- * The code package to be used on the Fluid document. This is either the package name which will be loaded
461
- * from a package manager. Or the expanded Fluid package.
462
- */
463
- readonly package: string | Readonly<IFluidPackage>;
464
- /**
465
- * Configuration details. This includes links to the package manager and base CDNs.
466
- */
467
- readonly config?: IFluidCodeDetailsConfig;
468
- }
469
-
470
- /**
471
- * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}
472
- * to have code loading modules in same package.
473
- * @internal
474
- */
475
- export declare const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer;
476
-
477
- /**
478
- * Provides capability to compare Fluid code details.
479
- *
480
- * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}
481
- * to have code loading modules in same package.
482
- * @internal
483
- */
484
- export declare interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
485
- /**
486
- * Determines if the `candidate` code details satisfy the constraints specified in `constraint` code details.
487
- *
488
- * Similar semantics to:
489
- * {@link https://github.com/npm/node-semver#usage}
490
- */
491
- satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
492
- /**
493
- * Returns a number representing the ascending sort order of the `a` and `b` code details:
494
- *
495
- * - `< 0` if `a < b`.
496
- *
497
- * - `= 0` if `a === b`.
498
- *
499
- * - `> 0` if `a > b`.
500
- *
501
- * - `undefined` if `a` is not comparable to `b`.
502
- *
503
- * Similar semantics to:
504
- * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description | Array.sort}
505
- */
506
- compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;
507
- }
508
-
509
- /**
510
- * Package manager configuration. Provides a key value mapping of config values.
511
- *
512
- * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsConfig}
513
- * to have code loading modules in same package.
514
- * @alpha
515
- */
516
- export declare interface IFluidCodeDetailsConfig {
517
- readonly [key: string]: string;
518
- }
519
-
520
451
  /**
521
452
  * @public
522
453
  */
@@ -599,67 +530,6 @@ export declare interface IFluidLoadable extends IProvideFluidLoadable {
599
530
  handle: IFluidHandle;
600
531
  }
601
532
 
602
- /**
603
- * Fluid-specific properties expected on a package to be loaded by the code loader.
604
- * While compatible with the npm package format it is not necessary that that package is an
605
- * npm package:
606
- * {@link https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid}
607
- *
608
- * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackage}
609
- * to have code loading modules in same package.
610
- * @alpha
611
- */
612
- export declare interface IFluidPackage {
613
- /**
614
- * The name of the package that this code represnets
615
- */
616
- name: string;
617
- /**
618
- * This object represents the Fluid specific properties of the package
619
- */
620
- fluid: {
621
- /**
622
- * The name of the of the environment. This should be something like browser, or node
623
- * and contain the necessary targets for loading this code in that environment.
624
- */
625
- [environment: string]: undefined | IFluidPackageEnvironment;
626
- };
627
- /**
628
- * General access for extended fields as specific usages will
629
- * likely have additional infornamation like a definition of
630
- * compatible versions, or deployment information like rings or rollouts.
631
- */
632
- [key: string]: unknown;
633
- }
634
-
635
- /**
636
- * Specifies an environment on Fluid property of an {@link IFluidPackage}.
637
- *
638
- * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}
639
- * to have code loading modules in same package.
640
- * @alpha
641
- */
642
- export declare interface IFluidPackageEnvironment {
643
- /**
644
- * The name of the target. For a browser environment, this could be umd for scripts
645
- * or css for styles.
646
- */
647
- [target: string]: undefined | {
648
- /**
649
- * List of files for the target. These can be relative or absolute.
650
- * The code loader should resolve relative paths, and validate all
651
- * full urls.
652
- */
653
- files: string[];
654
- /**
655
- * General access for extended fields as specific usages will
656
- * likely have additional infornamation like a definition
657
- * of Library, the entrypoint for umd packages
658
- */
659
- [key: string]: unknown;
660
- };
661
- }
662
-
663
533
  /**
664
534
  * @internal
665
535
  */
@@ -696,15 +566,6 @@ export declare interface ILoggingError extends Error {
696
566
  getTelemetryProperties(): ITelemetryBaseProperties;
697
567
  }
698
568
 
699
- /**
700
- * @deprecated in favor of {@link @fluidframework/container-definitions#IProvideFluidCodeDetailsComparer}
701
- * to have code loading modules in same package.
702
- * @internal
703
- */
704
- export declare interface IProvideFluidCodeDetailsComparer {
705
- readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
706
- }
707
-
708
569
  /**
709
570
  * @public
710
571
  */
@@ -761,24 +622,6 @@ export declare interface IResponse {
761
622
  stack?: string;
762
623
  }
763
624
 
764
- /**
765
- * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}
766
- * to have code loading modules in same package.
767
- * @internal
768
- */
769
- export declare const isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>;
770
-
771
- /**
772
- * Check if the package.json defines a Fluid package.
773
- *
774
- * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidPackage}
775
- * to have code loading modules in same package.
776
- *
777
- * @param pkg - The package json data to check if it is a Fluid package.
778
- * @internal
779
- */
780
- export declare const isFluidPackage: (pkg: unknown) => pkg is Readonly<IFluidPackage>;
781
-
782
625
  /**
783
626
  * @internal
784
627
  */
package/dist/handles.d.ts CHANGED
@@ -2,8 +2,8 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- import type { IRequest, IResponse } from "./fluidRouter.js";
6
5
  import type { IFluidLoadable } from "./fluidLoadable.js";
6
+ import type { IRequest, IResponse } from "./fluidRouter.js";
7
7
  import type { FluidObject } from "./provider.js";
8
8
  /**
9
9
  * @public
@@ -1 +1 @@
1
- {"version":3,"file":"handles.d.ts","sourceRoot":"","sources":["../src/handles.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BAAkD,CAAC;AAE3F;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;CAClD;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,0BAA0B;IACtE;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,mBAAmB,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,WAAW,IAAI,IAAI,CAAC;IAEpB,aAAa,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACrD;AAED;;GAEG;AACH,eAAO,MAAM,YAAY,EAAE,MAAM,mBAAoC,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY,CAE5B,CAAC,GAAG,WAAW,GAAG,cAAc,CAC/B,SAAQ,mBAAmB;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAE7B;;;;OAIG;IACH,WAAW,IAAI,IAAI,CAAC;IAEpB;;OAEG;IACH,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;IAElB;;;;;OAKG;IACH,IAAI,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;CACjC"}
1
+ {"version":3,"file":"handles.d.ts","sourceRoot":"","sources":["../src/handles.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BAAkD,CAAC;AAE3F;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;CAClD;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,0BAA0B;IACtE;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,mBAAmB,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,WAAW,IAAI,IAAI,CAAC;IAEpB,aAAa,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACrD;AAED;;GAEG;AACH,eAAO,MAAM,YAAY,EAAE,MAAM,mBAAoC,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY,CAE5B,CAAC,GAAG,WAAW,GAAG,cAAc,CAC/B,SAAQ,mBAAmB;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAE7B;;;;OAIG;IACH,WAAW,IAAI,IAAI,CAAC;IAEpB;;OAEG;IACH,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;IAElB;;;;;OAKG;IACH,IAAI,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;CACjC"}
@@ -1 +1 @@
1
- {"version":3,"file":"handles.js","sourceRoot":"","sources":["../src/handles.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAMH;;GAEG;AACU,QAAA,mBAAmB,GAAqC,qBAAqB,CAAC;AAsC3F;;GAEG;AACU,QAAA,YAAY,GAA8B,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IRequest, IResponse } from \"./fluidRouter.js\";\nimport type { IFluidLoadable } from \"./fluidLoadable.js\";\nimport type { FluidObject } from \"./provider.js\";\n\n/**\n * @public\n */\nexport const IFluidHandleContext: keyof IProvideFluidHandleContext = \"IFluidHandleContext\";\n\n/**\n * @public\n */\nexport interface IProvideFluidHandleContext {\n\treadonly IFluidHandleContext: IFluidHandleContext;\n}\n\n/**\n * Describes a routing context from which other `IFluidHandleContext`s are defined.\n * @public\n */\nexport interface IFluidHandleContext extends IProvideFluidHandleContext {\n\t/**\n\t * The absolute path to the handle context from the root.\n\t */\n\treadonly absolutePath: string;\n\n\t/**\n\t * The parent IFluidHandleContext that has provided a route path to this IFluidHandleContext or undefined\n\t * at the root.\n\t */\n\treadonly routeContext?: IFluidHandleContext;\n\n\t/**\n\t * Flag indicating whether or not the entity has services attached.\n\t */\n\treadonly isAttached: boolean;\n\n\t/**\n\t * Runs through the graph and attach the bounded handles.\n\t */\n\tattachGraph(): void;\n\n\tresolveHandle(request: IRequest): Promise<IResponse>;\n}\n\n/**\n * @public\n */\nexport const IFluidHandle: keyof IProvideFluidHandle = \"IFluidHandle\";\n\n/**\n * @public\n */\nexport interface IProvideFluidHandle {\n\treadonly IFluidHandle: IFluidHandle;\n}\n\n/**\n * Handle to a shared {@link FluidObject}.\n * @public\n */\nexport interface IFluidHandle<\n\t// REVIEW: Constrain `T` to something? How do we support dds and datastores safely?\n\tT = FluidObject & IFluidLoadable,\n> extends IProvideFluidHandle {\n\t/**\n\t * @deprecated Do not use handle's path for routing. Use `get` to get the underlying object.\n\t *\n\t * The absolute path to the handle context from the root.\n\t */\n\treadonly absolutePath: string;\n\n\t/**\n\t * Flag indicating whether or not the entity has services attached.\n\t */\n\treadonly isAttached: boolean;\n\n\t/**\n\t * @deprecated To be removed. This is part of an internal API surface and should not be called.\n\t *\n\t * Runs through the graph and attach the bounded handles.\n\t */\n\tattachGraph(): void;\n\n\t/**\n\t * Returns a promise to the Fluid Object referenced by the handle.\n\t */\n\tget(): Promise<T>;\n\n\t/**\n\t * @deprecated To be removed. This is part of an internal API surface and should not be called.\n\t *\n\t * Binds the given handle to this one or attach the given handle if this handle is attached.\n\t * A bound handle will also be attached once this handle is attached.\n\t */\n\tbind(handle: IFluidHandle): void;\n}\n"]}
1
+ {"version":3,"file":"handles.js","sourceRoot":"","sources":["../src/handles.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAMH;;GAEG;AACU,QAAA,mBAAmB,GAAqC,qBAAqB,CAAC;AAsC3F;;GAEG;AACU,QAAA,YAAY,GAA8B,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IFluidLoadable } from \"./fluidLoadable.js\";\nimport type { IRequest, IResponse } from \"./fluidRouter.js\";\nimport type { FluidObject } from \"./provider.js\";\n\n/**\n * @public\n */\nexport const IFluidHandleContext: keyof IProvideFluidHandleContext = \"IFluidHandleContext\";\n\n/**\n * @public\n */\nexport interface IProvideFluidHandleContext {\n\treadonly IFluidHandleContext: IFluidHandleContext;\n}\n\n/**\n * Describes a routing context from which other `IFluidHandleContext`s are defined.\n * @public\n */\nexport interface IFluidHandleContext extends IProvideFluidHandleContext {\n\t/**\n\t * The absolute path to the handle context from the root.\n\t */\n\treadonly absolutePath: string;\n\n\t/**\n\t * The parent IFluidHandleContext that has provided a route path to this IFluidHandleContext or undefined\n\t * at the root.\n\t */\n\treadonly routeContext?: IFluidHandleContext;\n\n\t/**\n\t * Flag indicating whether or not the entity has services attached.\n\t */\n\treadonly isAttached: boolean;\n\n\t/**\n\t * Runs through the graph and attach the bounded handles.\n\t */\n\tattachGraph(): void;\n\n\tresolveHandle(request: IRequest): Promise<IResponse>;\n}\n\n/**\n * @public\n */\nexport const IFluidHandle: keyof IProvideFluidHandle = \"IFluidHandle\";\n\n/**\n * @public\n */\nexport interface IProvideFluidHandle {\n\treadonly IFluidHandle: IFluidHandle;\n}\n\n/**\n * Handle to a shared {@link FluidObject}.\n * @public\n */\nexport interface IFluidHandle<\n\t// REVIEW: Constrain `T` to something? How do we support dds and datastores safely?\n\tT = FluidObject & IFluidLoadable,\n> extends IProvideFluidHandle {\n\t/**\n\t * @deprecated Do not use handle's path for routing. Use `get` to get the underlying object.\n\t *\n\t * The absolute path to the handle context from the root.\n\t */\n\treadonly absolutePath: string;\n\n\t/**\n\t * Flag indicating whether or not the entity has services attached.\n\t */\n\treadonly isAttached: boolean;\n\n\t/**\n\t * @deprecated To be removed. This is part of an internal API surface and should not be called.\n\t *\n\t * Runs through the graph and attach the bounded handles.\n\t */\n\tattachGraph(): void;\n\n\t/**\n\t * Returns a promise to the Fluid Object referenced by the handle.\n\t */\n\tget(): Promise<T>;\n\n\t/**\n\t * @deprecated To be removed. This is part of an internal API surface and should not be called.\n\t *\n\t * Binds the given handle to this one or attach the given handle if this handle is attached.\n\t * A bound handle will also be attached once this handle is attached.\n\t */\n\tbind(handle: IFluidHandle): void;\n}\n"]}
package/dist/index.d.ts CHANGED
@@ -8,8 +8,6 @@ export { FluidErrorTypes } from "./error.js";
8
8
  export type { ExtendEventProvider, IErrorEvent, IEvent, IEventProvider, IEventThisPlaceHolder, IEventTransformer, ReplaceIEventThisPlaceHolder, TransformedEvent, } from "./events.js";
9
9
  export type { IProvideFluidLoadable, IProvideFluidRunnable } from "./fluidLoadable.js";
10
10
  export { IFluidLoadable, IFluidRunnable } from "./fluidLoadable.js";
11
- export type { IFluidPackageEnvironment, IFluidPackage, IFluidCodeDetailsConfig, IFluidCodeDetails, IProvideFluidCodeDetailsComparer, } from "./fluidPackage.js";
12
- export { isFluidPackage, isFluidCodeDetails, IFluidCodeDetailsComparer } from "./fluidPackage.js";
13
11
  export type { IRequest, IRequestHeader, IResponse } from "./fluidRouter.js";
14
12
  export type { IProvideFluidHandleContext, IProvideFluidHandle } from "./handles.js";
15
13
  export { IFluidHandleContext, IFluidHandle } from "./handles.js";
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEnD,YAAY,EAAE,UAAU,EAAE,aAAa,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAC7F,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,YAAY,EACX,mBAAmB,EACnB,WAAW,EACX,MAAM,EACN,cAAc,EACd,qBAAqB,EACrB,iBAAiB,EACjB,4BAA4B,EAC5B,gBAAgB,GAChB,MAAM,aAAa,CAAC;AAErB,YAAY,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AACvF,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpE,YAAY,EACX,wBAAwB,EACxB,aAAa,EACb,uBAAuB,EACvB,iBAAiB,EACjB,gCAAgC,GAChC,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAKlG,YAAY,EAAE,QAAQ,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE5E,YAAY,EAAE,0BAA0B,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACpF,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEjE,YAAY,EACX,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,MAAM,EACN,8BAA8B,GAC9B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,YAAY,EAAE,uBAAuB,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAC3F,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACpE,YAAY,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEnD,YAAY,EAAE,UAAU,EAAE,aAAa,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAC7F,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,YAAY,EACX,mBAAmB,EACnB,WAAW,EACX,MAAM,EACN,cAAc,EACd,qBAAqB,EACrB,iBAAiB,EACjB,4BAA4B,EAC5B,gBAAgB,GAChB,MAAM,aAAa,CAAC;AAErB,YAAY,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AACvF,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAKpE,YAAY,EAAE,QAAQ,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE5E,YAAY,EAAE,0BAA0B,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACpF,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEjE,YAAY,EACX,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,MAAM,EACN,8BAA8B,GAC9B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,YAAY,EAAE,uBAAuB,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAC3F,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACpE,YAAY,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC"}
package/dist/index.js CHANGED
@@ -4,16 +4,12 @@
4
4
  * Licensed under the MIT License.
5
5
  */
6
6
  Object.defineProperty(exports, "__esModule", { value: true });
7
- exports.LogLevel = exports.IFluidHandle = exports.IFluidHandleContext = exports.IFluidCodeDetailsComparer = exports.isFluidCodeDetails = exports.isFluidPackage = exports.IFluidRunnable = exports.IFluidLoadable = exports.FluidErrorTypes = void 0;
7
+ exports.LogLevel = exports.IFluidHandle = exports.IFluidHandleContext = exports.IFluidRunnable = exports.IFluidLoadable = exports.FluidErrorTypes = void 0;
8
8
  var error_js_1 = require("./error.js");
9
9
  Object.defineProperty(exports, "FluidErrorTypes", { enumerable: true, get: function () { return error_js_1.FluidErrorTypes; } });
10
10
  var fluidLoadable_js_1 = require("./fluidLoadable.js");
11
11
  Object.defineProperty(exports, "IFluidLoadable", { enumerable: true, get: function () { return fluidLoadable_js_1.IFluidLoadable; } });
12
12
  Object.defineProperty(exports, "IFluidRunnable", { enumerable: true, get: function () { return fluidLoadable_js_1.IFluidRunnable; } });
13
- var fluidPackage_js_1 = require("./fluidPackage.js");
14
- Object.defineProperty(exports, "isFluidPackage", { enumerable: true, get: function () { return fluidPackage_js_1.isFluidPackage; } });
15
- Object.defineProperty(exports, "isFluidCodeDetails", { enumerable: true, get: function () { return fluidPackage_js_1.isFluidCodeDetails; } });
16
- Object.defineProperty(exports, "IFluidCodeDetailsComparer", { enumerable: true, get: function () { return fluidPackage_js_1.IFluidCodeDetailsComparer; } });
17
13
  var handles_js_1 = require("./handles.js");
18
14
  Object.defineProperty(exports, "IFluidHandleContext", { enumerable: true, get: function () { return handles_js_1.IFluidHandleContext; } });
19
15
  Object.defineProperty(exports, "IFluidHandle", { enumerable: true, get: function () { return handles_js_1.IFluidHandle; } });
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH,uCAA6C;AAApC,2GAAA,eAAe,OAAA;AAcxB,uDAAoE;AAA3D,kHAAA,cAAc,OAAA;AAAE,kHAAA,cAAc,OAAA;AASvC,qDAAkG;AAAzF,iHAAA,cAAc,OAAA;AAAE,qHAAA,kBAAkB,OAAA;AAAE,4HAAA,yBAAyB,OAAA;AAQtE,2CAAiE;AAAxD,iHAAA,mBAAmB,OAAA;AAAE,0GAAA,YAAY,OAAA;AAU1C,yCAAuC;AAA9B,qGAAA,QAAQ,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport type { IDisposable } from \"./disposable.js\";\n\nexport type { IErrorBase, IGenericError, IUsageError, IThrottlingWarning } from \"./error.js\";\nexport { FluidErrorTypes } from \"./error.js\";\n\nexport type {\n\tExtendEventProvider,\n\tIErrorEvent,\n\tIEvent,\n\tIEventProvider,\n\tIEventThisPlaceHolder,\n\tIEventTransformer,\n\tReplaceIEventThisPlaceHolder,\n\tTransformedEvent,\n} from \"./events.js\";\n\nexport type { IProvideFluidLoadable, IProvideFluidRunnable } from \"./fluidLoadable.js\";\nexport { IFluidLoadable, IFluidRunnable } from \"./fluidLoadable.js\";\n\nexport type {\n\tIFluidPackageEnvironment,\n\tIFluidPackage,\n\tIFluidCodeDetailsConfig,\n\tIFluidCodeDetails,\n\tIProvideFluidCodeDetailsComparer,\n} from \"./fluidPackage.js\";\nexport { isFluidPackage, isFluidCodeDetails, IFluidCodeDetailsComparer } from \"./fluidPackage.js\";\n\n// TypeScript forgets the index signature when customers augment IRequestHeader if we export *.\n// So we export the explicit members as a workaround:\n// https://github.com/microsoft/TypeScript/issues/18877#issuecomment-476921038\nexport type { IRequest, IRequestHeader, IResponse } from \"./fluidRouter.js\";\n\nexport type { IProvideFluidHandleContext, IProvideFluidHandle } from \"./handles.js\";\nexport { IFluidHandleContext, IFluidHandle } from \"./handles.js\";\n\nexport type {\n\tILoggingError,\n\tITelemetryBaseEvent,\n\tITelemetryBaseLogger,\n\tITelemetryBaseProperties,\n\tTagged,\n\tTelemetryBaseEventPropertyType,\n} from \"./logger.js\";\nexport { LogLevel } from \"./logger.js\";\nexport type { FluidObjectProviderKeys, FluidObject, FluidObjectKeys } from \"./provider.js\";\nexport type { ConfigTypes, IConfigProviderBase } from \"./config.js\";\nexport type { ISignalEnvelope } from \"./messages.js\";\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH,uCAA6C;AAApC,2GAAA,eAAe,OAAA;AAcxB,uDAAoE;AAA3D,kHAAA,cAAc,OAAA;AAAE,kHAAA,cAAc,OAAA;AAQvC,2CAAiE;AAAxD,iHAAA,mBAAmB,OAAA;AAAE,0GAAA,YAAY,OAAA;AAU1C,yCAAuC;AAA9B,qGAAA,QAAQ,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport type { IDisposable } from \"./disposable.js\";\n\nexport type { IErrorBase, IGenericError, IUsageError, IThrottlingWarning } from \"./error.js\";\nexport { FluidErrorTypes } from \"./error.js\";\n\nexport type {\n\tExtendEventProvider,\n\tIErrorEvent,\n\tIEvent,\n\tIEventProvider,\n\tIEventThisPlaceHolder,\n\tIEventTransformer,\n\tReplaceIEventThisPlaceHolder,\n\tTransformedEvent,\n} from \"./events.js\";\n\nexport type { IProvideFluidLoadable, IProvideFluidRunnable } from \"./fluidLoadable.js\";\nexport { IFluidLoadable, IFluidRunnable } from \"./fluidLoadable.js\";\n\n// TypeScript forgets the index signature when customers augment IRequestHeader if we export *.\n// So we export the explicit members as a workaround:\n// https://github.com/microsoft/TypeScript/issues/18877#issuecomment-476921038\nexport type { IRequest, IRequestHeader, IResponse } from \"./fluidRouter.js\";\n\nexport type { IProvideFluidHandleContext, IProvideFluidHandle } from \"./handles.js\";\nexport { IFluidHandleContext, IFluidHandle } from \"./handles.js\";\n\nexport type {\n\tILoggingError,\n\tITelemetryBaseEvent,\n\tITelemetryBaseLogger,\n\tITelemetryBaseProperties,\n\tTagged,\n\tTelemetryBaseEventPropertyType,\n} from \"./logger.js\";\nexport { LogLevel } from \"./logger.js\";\nexport type { FluidObjectProviderKeys, FluidObject, FluidObjectKeys } from \"./provider.js\";\nexport type { ConfigTypes, IConfigProviderBase } from \"./config.js\";\nexport type { ISignalEnvelope } from \"./messages.js\";\n"]}