@fluidframework/container-definitions 2.0.0-dev.7.4.0.215930 → 2.0.0-dev.7.4.0.217212

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 (67) hide show
  1. package/api-extractor-lint.json +13 -0
  2. package/api-report/container-definitions.api.md +51 -53
  3. package/dist/audience.d.ts +2 -2
  4. package/dist/audience.js.map +1 -1
  5. package/dist/browserPackage.d.ts +3 -3
  6. package/dist/browserPackage.js +1 -1
  7. package/dist/browserPackage.js.map +1 -1
  8. package/dist/container-definitions-alpha.d.ts +57 -310
  9. package/dist/container-definitions-beta.d.ts +72 -1366
  10. package/dist/container-definitions-public.d.ts +72 -1366
  11. package/dist/container-definitions-untrimmed.d.ts +55 -55
  12. package/dist/deltas.d.ts +7 -7
  13. package/dist/deltas.js.map +1 -1
  14. package/dist/error.d.ts +5 -6
  15. package/dist/error.d.ts.map +1 -1
  16. package/dist/error.js +2 -2
  17. package/dist/error.js.map +1 -1
  18. package/dist/fluidModule.d.ts +1 -1
  19. package/dist/fluidModule.js.map +1 -1
  20. package/dist/fluidPackage.d.ts +9 -9
  21. package/dist/fluidPackage.js +3 -3
  22. package/dist/fluidPackage.js.map +1 -1
  23. package/dist/loader.d.ts +21 -18
  24. package/dist/loader.d.ts.map +1 -1
  25. package/dist/loader.js +1 -1
  26. package/dist/loader.js.map +1 -1
  27. package/dist/runtime.d.ts +7 -9
  28. package/dist/runtime.d.ts.map +1 -1
  29. package/dist/runtime.js +2 -2
  30. package/dist/runtime.js.map +1 -1
  31. package/lib/audience.d.ts +2 -2
  32. package/lib/audience.js.map +1 -1
  33. package/lib/browserPackage.d.ts +3 -3
  34. package/lib/browserPackage.js +1 -1
  35. package/lib/browserPackage.js.map +1 -1
  36. package/lib/container-definitions-alpha.d.ts +57 -310
  37. package/lib/container-definitions-beta.d.ts +72 -1366
  38. package/lib/container-definitions-public.d.ts +72 -1366
  39. package/lib/container-definitions-untrimmed.d.ts +55 -55
  40. package/lib/deltas.d.ts +7 -7
  41. package/lib/deltas.js.map +1 -1
  42. package/lib/error.d.ts +5 -6
  43. package/lib/error.d.ts.map +1 -1
  44. package/lib/error.js +2 -2
  45. package/lib/error.js.map +1 -1
  46. package/lib/fluidModule.d.ts +1 -1
  47. package/lib/fluidModule.js.map +1 -1
  48. package/lib/fluidPackage.d.ts +9 -9
  49. package/lib/fluidPackage.js +3 -3
  50. package/lib/fluidPackage.js.map +1 -1
  51. package/lib/loader.d.ts +21 -18
  52. package/lib/loader.d.ts.map +1 -1
  53. package/lib/loader.js +1 -1
  54. package/lib/loader.js.map +1 -1
  55. package/lib/runtime.d.ts +7 -9
  56. package/lib/runtime.d.ts.map +1 -1
  57. package/lib/runtime.js +2 -2
  58. package/lib/runtime.js.map +1 -1
  59. package/package.json +5 -4
  60. package/src/audience.ts +2 -2
  61. package/src/browserPackage.ts +3 -3
  62. package/src/deltas.ts +7 -7
  63. package/src/error.ts +5 -6
  64. package/src/fluidModule.ts +1 -1
  65. package/src/fluidPackage.ts +9 -9
  66. package/src/loader.ts +21 -18
  67. package/src/runtime.ts +7 -9
@@ -0,0 +1,13 @@
1
+ {
2
+ "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
+ "extends": "../../../common/build/build-common/api-extractor-lint.json",
4
+ "messages": {
5
+ "extractorMessageReporting": {
6
+ // TODO: remove once base config has this enabled as an error
7
+ "ae-incompatible-release-tags": {
8
+ "logLevel": "error",
9
+ "addToApiReportFile": false
10
+ }
11
+ }
12
+ }
13
+ }
@@ -36,14 +36,14 @@ import { IUsageError } from '@fluidframework/core-interfaces';
36
36
  import { IVersion } from '@fluidframework/protocol-definitions';
37
37
  import { MessageType } from '@fluidframework/protocol-definitions';
38
38
 
39
- // @public
39
+ // @alpha
40
40
  export enum AttachState {
41
41
  Attached = "Attached",
42
42
  Attaching = "Attaching",
43
43
  Detached = "Detached"
44
44
  }
45
45
 
46
- // @public
46
+ // @alpha
47
47
  export namespace ConnectionState {
48
48
  export type CatchingUp = 1;
49
49
  export type Connected = 2;
@@ -51,10 +51,10 @@ export namespace ConnectionState {
51
51
  export type EstablishingConnection = 3;
52
52
  }
53
53
 
54
- // @public
54
+ // @alpha
55
55
  export type ConnectionState = ConnectionState.Disconnected | ConnectionState.EstablishingConnection | ConnectionState.CatchingUp | ConnectionState.Connected;
56
56
 
57
- // @public @deprecated
57
+ // @internal @deprecated
58
58
  export enum ContainerErrorType {
59
59
  clientSessionExpiredError = "clientSessionExpiredError",
60
60
  dataCorruptionError = "dataCorruptionError",
@@ -64,7 +64,7 @@ export enum ContainerErrorType {
64
64
  usageError = "usageError"
65
65
  }
66
66
 
67
- // @public
67
+ // @internal
68
68
  export const ContainerErrorTypes: {
69
69
  readonly clientSessionExpiredError: "clientSessionExpiredError";
70
70
  readonly genericError: "genericError";
@@ -74,28 +74,28 @@ export const ContainerErrorTypes: {
74
74
  readonly usageError: "usageError";
75
75
  };
76
76
 
77
- // @public (undocumented)
77
+ // @internal (undocumented)
78
78
  export type ContainerErrorTypes = (typeof ContainerErrorTypes)[keyof typeof ContainerErrorTypes];
79
79
 
80
- // @public
80
+ // @alpha
81
81
  export interface ContainerWarning extends IErrorBase {
82
82
  logged?: boolean;
83
83
  }
84
84
 
85
- // @public
85
+ // @alpha
86
86
  export interface IAudience extends EventEmitter {
87
87
  getMember(clientId: string): IClient | undefined;
88
88
  getMembers(): Map<string, IClient>;
89
89
  on(event: "addMember" | "removeMember", listener: (clientId: string, client: IClient) => void): this;
90
90
  }
91
91
 
92
- // @public
92
+ // @alpha
93
93
  export interface IAudienceOwner extends IAudience {
94
94
  addMember(clientId: string, details: IClient): void;
95
95
  removeMember(clientId: string): boolean;
96
96
  }
97
97
 
98
- // @public
98
+ // @alpha
99
99
  export interface IBatchMessage {
100
100
  // (undocumented)
101
101
  compression?: string;
@@ -107,12 +107,12 @@ export interface IBatchMessage {
107
107
  referenceSequenceNumber?: number;
108
108
  }
109
109
 
110
- // @public
110
+ // @internal
111
111
  export interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComparer> {
112
112
  load(source: IFluidCodeDetails): Promise<IFluidModuleWithDetails>;
113
113
  }
114
114
 
115
- // @public
115
+ // @alpha
116
116
  export interface IConnectionDetails {
117
117
  checkpointSequenceNumber: number | undefined;
118
118
  // (undocumented)
@@ -123,7 +123,7 @@ export interface IConnectionDetails {
123
123
  serviceConfiguration: IClientConfiguration;
124
124
  }
125
125
 
126
- // @public
126
+ // @alpha
127
127
  export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRouter {
128
128
  attach(request: IRequest, attachProps?: {
129
129
  deltaConnection?: "none" | "delayed";
@@ -139,7 +139,6 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
139
139
  disconnect(): void;
140
140
  dispose(error?: ICriticalContainerError): void;
141
141
  readonly disposed?: boolean;
142
- // @alpha
143
142
  forceReadonly?(readonly: boolean): any;
144
143
  getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
145
144
  getEntryPoint(): Promise<FluidObject | undefined>;
@@ -162,7 +161,7 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
162
161
  serialize(): string;
163
162
  }
164
163
 
165
- // @public
164
+ // @alpha
166
165
  export interface IContainerContext {
167
166
  readonly attachState: AttachState;
168
167
  // (undocumented)
@@ -215,7 +214,7 @@ export interface IContainerContext {
215
214
  updateDirtyContainerState(dirty: boolean): void;
216
215
  }
217
216
 
218
- // @public
217
+ // @alpha
219
218
  export interface IContainerEvents extends IEvent {
220
219
  (event: "readonly", listener: (readonly: boolean) => void): void;
221
220
  (event: "connected", listener: (clientId: string) => void): any;
@@ -231,7 +230,7 @@ export interface IContainerEvents extends IEvent {
231
230
  (event: "saved", listener: (dirty: boolean) => void): any;
232
231
  }
233
232
 
234
- // @public (undocumented)
233
+ // @internal (undocumented)
235
234
  export interface IContainerLoadMode {
236
235
  // (undocumented)
237
236
  deltaConnection?: "none" | "delayed" | undefined;
@@ -240,10 +239,10 @@ export interface IContainerLoadMode {
240
239
  pauseAfterLoad?: boolean;
241
240
  }
242
241
 
243
- // @public
242
+ // @alpha
244
243
  export type ICriticalContainerError = IErrorBase;
245
244
 
246
- // @public
245
+ // @alpha
247
246
  export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender {
248
247
  readonly active: boolean;
249
248
  readonly clientDetails: IClientDetails;
@@ -264,7 +263,7 @@ export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>
264
263
  readonly version: string;
265
264
  }
266
265
 
267
- // @public
266
+ // @alpha
268
267
  export interface IDeltaManagerEvents extends IEvent {
269
268
  // @deprecated (undocumented)
270
269
  (event: "prepareSend", listener: (messageBuffer: any[]) => void): any;
@@ -280,7 +279,7 @@ export interface IDeltaManagerEvents extends IEvent {
280
279
  }) => void): any;
281
280
  }
282
281
 
283
- // @public
282
+ // @alpha
284
283
  export interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, IDisposable {
285
284
  idle: boolean;
286
285
  length: number;
@@ -295,21 +294,21 @@ export interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, ID
295
294
  }>;
296
295
  }
297
296
 
298
- // @public
297
+ // @alpha
299
298
  export interface IDeltaQueueEvents<T> extends IErrorEvent {
300
299
  (event: "push", listener: (task: T) => void): any;
301
300
  (event: "op", listener: (task: T) => void): any;
302
301
  (event: "idle", listener: (count: number, duration: number) => void): any;
303
302
  }
304
303
 
305
- // @public
304
+ // @alpha
306
305
  export interface IDeltaSender {
307
306
  flush(): void;
308
307
  }
309
308
 
310
309
  export { IErrorBase }
311
310
 
312
- // @public
311
+ // @internal
313
312
  export interface IFluidBrowserPackage extends IFluidPackage {
314
313
  // (undocumented)
315
314
  fluid: {
@@ -318,7 +317,7 @@ export interface IFluidBrowserPackage extends IFluidPackage {
318
317
  };
319
318
  }
320
319
 
321
- // @public
320
+ // @internal
322
321
  export interface IFluidBrowserPackageEnvironment extends IFluidPackageEnvironment {
323
322
  umd: {
324
323
  files: string[];
@@ -326,45 +325,45 @@ export interface IFluidBrowserPackageEnvironment extends IFluidPackageEnvironmen
326
325
  };
327
326
  }
328
327
 
329
- // @public
328
+ // @alpha
330
329
  export interface IFluidCodeDetails {
331
330
  readonly config?: IFluidCodeDetailsConfig;
332
331
  readonly package: string | Readonly<IFluidPackage>;
333
332
  }
334
333
 
335
- // @public (undocumented)
334
+ // @alpha (undocumented)
336
335
  export const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer;
337
336
 
338
- // @public
337
+ // @alpha
339
338
  export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
340
339
  compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;
341
340
  satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
342
341
  }
343
342
 
344
- // @public
343
+ // @alpha
345
344
  export interface IFluidCodeDetailsConfig {
346
345
  // (undocumented)
347
346
  readonly [key: string]: string;
348
347
  }
349
348
 
350
- // @public
349
+ // @internal
351
350
  export interface IFluidCodeResolver {
352
351
  resolveCodeDetails(details: IFluidCodeDetails): Promise<IResolvedFluidCodeDetails>;
353
352
  }
354
353
 
355
- // @public (undocumented)
354
+ // @alpha (undocumented)
356
355
  export interface IFluidModule {
357
356
  // (undocumented)
358
357
  fluidExport: FluidObject<IRuntimeFactory & IProvideFluidCodeDetailsComparer>;
359
358
  }
360
359
 
361
- // @public
360
+ // @internal
362
361
  export interface IFluidModuleWithDetails {
363
362
  details: IFluidCodeDetails;
364
363
  module: IFluidModule;
365
364
  }
366
365
 
367
- // @public
366
+ // @alpha
368
367
  export interface IFluidPackage {
369
368
  [key: string]: unknown;
370
369
  fluid: {
@@ -373,7 +372,7 @@ export interface IFluidPackage {
373
372
  name: string;
374
373
  }
375
374
 
376
- // @public
375
+ // @alpha
377
376
  export interface IFluidPackageEnvironment {
378
377
  [target: string]: undefined | {
379
378
  files: string[];
@@ -389,7 +388,7 @@ export interface IGetPendingLocalStateProps {
389
388
  readonly stopBlobAttachingSignal?: AbortSignal;
390
389
  }
391
390
 
392
- // @public
391
+ // @internal
393
392
  export interface IHostLoader extends ILoader {
394
393
  createDetachedContainer(codeDetails: IFluidCodeDetails, createDetachedProps?: {
395
394
  canReconnect?: boolean;
@@ -401,7 +400,7 @@ export interface IHostLoader extends ILoader {
401
400
  }): Promise<IContainer>;
402
401
  }
403
402
 
404
- // @public
403
+ // @alpha
405
404
  export interface ILoader extends Partial<IProvideLoader> {
406
405
  // @deprecated (undocumented)
407
406
  readonly IFluidRouter: IFluidRouter;
@@ -410,7 +409,7 @@ export interface ILoader extends Partial<IProvideLoader> {
410
409
  resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;
411
410
  }
412
411
 
413
- // @public
412
+ // @internal
414
413
  export interface ILoaderHeader {
415
414
  // @deprecated (undocumented)
416
415
  [LoaderHeader.cache]: boolean;
@@ -425,7 +424,7 @@ export interface ILoaderHeader {
425
424
  [LoaderHeader.version]: string | undefined;
426
425
  }
427
426
 
428
- // @public (undocumented)
427
+ // @alpha (undocumented)
429
428
  export type ILoaderOptions = {
430
429
  [key in string | number]: any;
431
430
  } & {
@@ -434,7 +433,7 @@ export type ILoaderOptions = {
434
433
  maxClientLeaveWaitTime?: number;
435
434
  };
436
435
 
437
- // @public @deprecated (undocumented)
436
+ // @internal @deprecated (undocumented)
438
437
  export interface IPendingLocalState {
439
438
  // (undocumented)
440
439
  pendingRuntimeState: unknown;
@@ -442,35 +441,34 @@ export interface IPendingLocalState {
442
441
  url: string;
443
442
  }
444
443
 
445
- // @public (undocumented)
444
+ // @alpha (undocumented)
446
445
  export interface IProvideFluidCodeDetailsComparer {
447
446
  // (undocumented)
448
447
  readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
449
448
  }
450
449
 
451
- // @public (undocumented)
450
+ // @alpha (undocumented)
452
451
  export interface IProvideLoader {
453
452
  // (undocumented)
454
453
  readonly ILoader: ILoader;
455
454
  }
456
455
 
457
- // @public (undocumented)
456
+ // @alpha (undocumented)
458
457
  export interface IProvideRuntimeFactory {
459
458
  // (undocumented)
460
459
  readonly IRuntimeFactory: IRuntimeFactory;
461
460
  }
462
461
 
463
- // @public
462
+ // @internal
464
463
  export interface IResolvedFluidCodeDetails extends IFluidCodeDetails {
465
464
  readonly resolvedPackage: Readonly<IFluidPackage>;
466
465
  readonly resolvedPackageCacheId: string | undefined;
467
466
  }
468
467
 
469
- // @public
468
+ // @alpha
470
469
  export interface IRuntime extends IDisposable {
471
470
  createSummary(blobRedirectTable?: Map<string, string>): ISummaryTree;
472
471
  getEntryPoint(): Promise<FluidObject | undefined>;
473
- // @alpha
474
472
  getPendingLocalState(props?: IGetPendingLocalStateProps): unknown;
475
473
  // @deprecated
476
474
  notifyAttaching(snapshot: ISnapshotTreeWithBlobContents): void;
@@ -483,24 +481,24 @@ export interface IRuntime extends IDisposable {
483
481
  setConnectionState(connected: boolean, clientId?: string): any;
484
482
  }
485
483
 
486
- // @public (undocumented)
484
+ // @alpha (undocumented)
487
485
  export const IRuntimeFactory: keyof IProvideRuntimeFactory;
488
486
 
489
- // @public
487
+ // @alpha
490
488
  export interface IRuntimeFactory extends IProvideRuntimeFactory {
491
489
  instantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;
492
490
  }
493
491
 
494
- // @public
492
+ // @internal
495
493
  export const isFluidBrowserPackage: (maybePkg: unknown) => maybePkg is Readonly<IFluidBrowserPackage>;
496
494
 
497
- // @public
495
+ // @internal
498
496
  export const isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>;
499
497
 
500
- // @public
498
+ // @internal
501
499
  export const isFluidPackage: (pkg: unknown) => pkg is Readonly<IFluidPackage>;
502
500
 
503
- // @public
501
+ // @alpha
504
502
  export interface ISnapshotTreeWithBlobContents extends ISnapshotTree {
505
503
  // (undocumented)
506
504
  blobsContents: {
@@ -516,7 +514,7 @@ export { IThrottlingWarning }
516
514
 
517
515
  export { IUsageError }
518
516
 
519
- // @public
517
+ // @internal
520
518
  export enum LoaderHeader {
521
519
  // @deprecated (undocumented)
522
520
  cache = "fluid-cache",
@@ -529,7 +527,7 @@ export enum LoaderHeader {
529
527
  version = "version"
530
528
  }
531
529
 
532
- // @public (undocumented)
530
+ // @alpha (undocumented)
533
531
  export type ReadOnlyInfo = {
534
532
  readonly readonly: false | undefined;
535
533
  } | {
@@ -6,7 +6,7 @@ import { EventEmitter } from "events";
6
6
  import { IClient } from "@fluidframework/protocol-definitions";
7
7
  /**
8
8
  * Manages the state and the members for {@link IAudience}
9
- * @public
9
+ * @alpha
10
10
  */
11
11
  export interface IAudienceOwner extends IAudience {
12
12
  /**
@@ -24,7 +24,7 @@ export interface IAudienceOwner extends IAudience {
24
24
  *
25
25
  * See {@link https://nodejs.org/api/events.html#class-eventemitter | here} for an overview of the `EventEmitter`
26
26
  * class.
27
- * @public
27
+ * @alpha
28
28
  */
29
29
  export interface IAudience extends EventEmitter {
30
30
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"audience.js","sourceRoot":"","sources":["../src/audience.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// False positive: this is an import from the `events` package, not from Node.\n// eslint-disable-next-line unicorn/prefer-node-protocol\nimport { EventEmitter } from \"events\";\nimport { IClient } from \"@fluidframework/protocol-definitions\";\n\n/**\n * Manages the state and the members for {@link IAudience}\n * @public\n */\nexport interface IAudienceOwner extends IAudience {\n\t/**\n\t * Adds a new client to the audience\n\t */\n\taddMember(clientId: string, details: IClient): void;\n\n\t/**\n\t * Removes a client from the audience. Only emits an event if a client is actually removed\n\t * @returns if a client was removed from the audience\n\t */\n\tremoveMember(clientId: string): boolean;\n}\n\n/**\n * Audience represents all clients connected to the op stream, both read-only and read/write.\n *\n * See {@link https://nodejs.org/api/events.html#class-eventemitter | here} for an overview of the `EventEmitter`\n * class.\n * @public\n */\nexport interface IAudience extends EventEmitter {\n\t/**\n\t * See {@link https://nodejs.dev/learn/the-nodejs-event-emitter | here} for an overview of `EventEmitter.on`.\n\t */\n\ton(\n\t\tevent: \"addMember\" | \"removeMember\",\n\t\tlistener: (clientId: string, client: IClient) => void,\n\t): this;\n\n\t/**\n\t * List all clients connected to the op stream, keyed off their clientId\n\t */\n\tgetMembers(): Map<string, IClient>;\n\n\t/**\n\t * Get details about the connected client with the specified clientId,\n\t * or undefined if the specified client isn't connected\n\t */\n\tgetMember(clientId: string): IClient | undefined;\n}\n"]}
1
+ {"version":3,"file":"audience.js","sourceRoot":"","sources":["../src/audience.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// False positive: this is an import from the `events` package, not from Node.\n// eslint-disable-next-line unicorn/prefer-node-protocol\nimport { EventEmitter } from \"events\";\nimport { IClient } from \"@fluidframework/protocol-definitions\";\n\n/**\n * Manages the state and the members for {@link IAudience}\n * @alpha\n */\nexport interface IAudienceOwner extends IAudience {\n\t/**\n\t * Adds a new client to the audience\n\t */\n\taddMember(clientId: string, details: IClient): void;\n\n\t/**\n\t * Removes a client from the audience. Only emits an event if a client is actually removed\n\t * @returns if a client was removed from the audience\n\t */\n\tremoveMember(clientId: string): boolean;\n}\n\n/**\n * Audience represents all clients connected to the op stream, both read-only and read/write.\n *\n * See {@link https://nodejs.org/api/events.html#class-eventemitter | here} for an overview of the `EventEmitter`\n * class.\n * @alpha\n */\nexport interface IAudience extends EventEmitter {\n\t/**\n\t * See {@link https://nodejs.dev/learn/the-nodejs-event-emitter | here} for an overview of `EventEmitter.on`.\n\t */\n\ton(\n\t\tevent: \"addMember\" | \"removeMember\",\n\t\tlistener: (clientId: string, client: IClient) => void,\n\t): this;\n\n\t/**\n\t * List all clients connected to the op stream, keyed off their clientId\n\t */\n\tgetMembers(): Map<string, IClient>;\n\n\t/**\n\t * Get details about the connected client with the specified clientId,\n\t * or undefined if the specified client isn't connected\n\t */\n\tgetMember(clientId: string): IClient | undefined;\n}\n"]}
@@ -5,7 +5,7 @@
5
5
  import { IFluidPackage, IFluidPackageEnvironment } from "./fluidPackage";
6
6
  /**
7
7
  * A specific Fluid package environment for browsers
8
- * @public
8
+ * @internal
9
9
  */
10
10
  export interface IFluidBrowserPackageEnvironment extends IFluidPackageEnvironment {
11
11
  /**
@@ -27,7 +27,7 @@ export interface IFluidBrowserPackageEnvironment extends IFluidPackageEnvironmen
27
27
  }
28
28
  /**
29
29
  * A Fluid package for specification for browser environments
30
- * @public
30
+ * @internal
31
31
  */
32
32
  export interface IFluidBrowserPackage extends IFluidPackage {
33
33
  /**
@@ -47,7 +47,7 @@ export interface IFluidBrowserPackage extends IFluidPackage {
47
47
  /**
48
48
  * Determines if any object is an IFluidBrowserPackage
49
49
  * @param maybePkg - The object to check for compatibility with IFluidBrowserPackage
50
- * @public
50
+ * @internal
51
51
  */
52
52
  export declare const isFluidBrowserPackage: (maybePkg: unknown) => maybePkg is Readonly<IFluidBrowserPackage>;
53
53
  //# sourceMappingURL=browserPackage.d.ts.map
@@ -9,7 +9,7 @@ const fluidPackage_1 = require("./fluidPackage");
9
9
  /**
10
10
  * Determines if any object is an IFluidBrowserPackage
11
11
  * @param maybePkg - The object to check for compatibility with IFluidBrowserPackage
12
- * @public
12
+ * @internal
13
13
  */
14
14
  const isFluidBrowserPackage = (maybePkg) => (0, fluidPackage_1.isFluidPackage)(maybePkg) &&
15
15
  typeof maybePkg?.fluid?.browser?.umd?.library === "string" &&
@@ -1 +1 @@
1
- {"version":3,"file":"browserPackage.js","sourceRoot":"","sources":["../src/browserPackage.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iDAAyF;AA8CzF;;;;GAIG;AACI,MAAM,qBAAqB,GAAG,CACpC,QAAiB,EAC4B,EAAE,CAC/C,IAAA,6BAAc,EAAC,QAAQ,CAAC;IACxB,OAAO,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,KAAK,QAAQ;IAC1D,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;AALxC,QAAA,qBAAqB,yBAKmB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidPackage, isFluidPackage, IFluidPackageEnvironment } from \"./fluidPackage\";\n\n/**\n * A specific Fluid package environment for browsers\n * @public\n */\nexport interface IFluidBrowserPackageEnvironment extends IFluidPackageEnvironment {\n\t/**\n\t * The Universal Module Definition (umd) target specifics the scripts necessary for\n\t * loading a packages in a browser environment and finding its entry point.\n\t */\n\tumd: {\n\t\t/**\n\t\t * The bundled js files for loading this package.\n\t\t * These files will be loaded and executed in order.\n\t\t */\n\t\tfiles: string[];\n\n\t\t/**\n\t\t * The global name that the script entry points will be exposed.\n\t\t * This entry point should be an {@link @fluidframework/container-definitions#IFluidModule}.\n\t\t */\n\t\tlibrary: string;\n\t};\n}\n\n/**\n * A Fluid package for specification for browser environments\n * @public\n */\nexport interface IFluidBrowserPackage extends IFluidPackage {\n\t/**\n\t * {@inheritDoc @fluidframework/core-interfaces#IFluidPackage.fluid}\n\t */\n\tfluid: {\n\t\t/**\n\t\t * The browser specific package information for this package\n\t\t */\n\t\tbrowser: IFluidBrowserPackageEnvironment;\n\t\t/**\n\t\t * {@inheritDoc @fluidframework/core-interfaces#IFluidPackage.fluid.environment}\n\t\t */\n\t\t[environment: string]: IFluidPackageEnvironment;\n\t};\n}\n\n/**\n * Determines if any object is an IFluidBrowserPackage\n * @param maybePkg - The object to check for compatibility with IFluidBrowserPackage\n * @public\n */\nexport const isFluidBrowserPackage = (\n\tmaybePkg: unknown,\n): maybePkg is Readonly<IFluidBrowserPackage> =>\n\tisFluidPackage(maybePkg) &&\n\ttypeof maybePkg?.fluid?.browser?.umd?.library === \"string\" &&\n\tArray.isArray(maybePkg?.fluid?.browser?.umd?.files);\n"]}
1
+ {"version":3,"file":"browserPackage.js","sourceRoot":"","sources":["../src/browserPackage.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iDAAyF;AA8CzF;;;;GAIG;AACI,MAAM,qBAAqB,GAAG,CACpC,QAAiB,EAC4B,EAAE,CAC/C,IAAA,6BAAc,EAAC,QAAQ,CAAC;IACxB,OAAO,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,KAAK,QAAQ;IAC1D,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;AALxC,QAAA,qBAAqB,yBAKmB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidPackage, isFluidPackage, IFluidPackageEnvironment } from \"./fluidPackage\";\n\n/**\n * A specific Fluid package environment for browsers\n * @internal\n */\nexport interface IFluidBrowserPackageEnvironment extends IFluidPackageEnvironment {\n\t/**\n\t * The Universal Module Definition (umd) target specifics the scripts necessary for\n\t * loading a packages in a browser environment and finding its entry point.\n\t */\n\tumd: {\n\t\t/**\n\t\t * The bundled js files for loading this package.\n\t\t * These files will be loaded and executed in order.\n\t\t */\n\t\tfiles: string[];\n\n\t\t/**\n\t\t * The global name that the script entry points will be exposed.\n\t\t * This entry point should be an {@link @fluidframework/container-definitions#IFluidModule}.\n\t\t */\n\t\tlibrary: string;\n\t};\n}\n\n/**\n * A Fluid package for specification for browser environments\n * @internal\n */\nexport interface IFluidBrowserPackage extends IFluidPackage {\n\t/**\n\t * {@inheritDoc @fluidframework/core-interfaces#IFluidPackage.fluid}\n\t */\n\tfluid: {\n\t\t/**\n\t\t * The browser specific package information for this package\n\t\t */\n\t\tbrowser: IFluidBrowserPackageEnvironment;\n\t\t/**\n\t\t * {@inheritDoc @fluidframework/core-interfaces#IFluidPackage.fluid.environment}\n\t\t */\n\t\t[environment: string]: IFluidPackageEnvironment;\n\t};\n}\n\n/**\n * Determines if any object is an IFluidBrowserPackage\n * @param maybePkg - The object to check for compatibility with IFluidBrowserPackage\n * @internal\n */\nexport const isFluidBrowserPackage = (\n\tmaybePkg: unknown,\n): maybePkg is Readonly<IFluidBrowserPackage> =>\n\tisFluidPackage(maybePkg) &&\n\ttypeof maybePkg?.fluid?.browser?.umd?.library === \"string\" &&\n\tArray.isArray(maybePkg?.fluid?.browser?.umd?.files);\n"]}