@fluidframework/driver-definitions 2.53.0 → 2.60.0

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 (113) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/api-report/{driver-definitions.legacy.alpha.api.md → driver-definitions.legacy.beta.api.md} +73 -73
  3. package/dist/driverError.d.ts +10 -20
  4. package/dist/driverError.d.ts.map +1 -1
  5. package/dist/driverError.js +1 -2
  6. package/dist/driverError.js.map +1 -1
  7. package/dist/git/resources.d.ts +2 -4
  8. package/dist/git/resources.d.ts.map +1 -1
  9. package/dist/git/resources.js.map +1 -1
  10. package/dist/protocol/clients.d.ts +1 -2
  11. package/dist/protocol/clients.d.ts.map +1 -1
  12. package/dist/protocol/clients.js.map +1 -1
  13. package/dist/protocol/config.d.ts +1 -2
  14. package/dist/protocol/config.d.ts.map +1 -1
  15. package/dist/protocol/config.js.map +1 -1
  16. package/dist/protocol/consensus.d.ts +7 -14
  17. package/dist/protocol/consensus.d.ts.map +1 -1
  18. package/dist/protocol/consensus.js.map +1 -1
  19. package/dist/protocol/date.d.ts +1 -2
  20. package/dist/protocol/date.d.ts.map +1 -1
  21. package/dist/protocol/date.js.map +1 -1
  22. package/dist/protocol/protocol.d.ts +15 -30
  23. package/dist/protocol/protocol.d.ts.map +1 -1
  24. package/dist/protocol/protocol.js +2 -4
  25. package/dist/protocol/protocol.js.map +1 -1
  26. package/dist/protocol/scopes.d.ts +1 -2
  27. package/dist/protocol/scopes.d.ts.map +1 -1
  28. package/dist/protocol/scopes.js +1 -2
  29. package/dist/protocol/scopes.js.map +1 -1
  30. package/dist/protocol/sockets.d.ts +2 -4
  31. package/dist/protocol/sockets.d.ts.map +1 -1
  32. package/dist/protocol/sockets.js.map +1 -1
  33. package/dist/protocol/storage.d.ts +10 -20
  34. package/dist/protocol/storage.d.ts.map +1 -1
  35. package/dist/protocol/storage.js +2 -4
  36. package/dist/protocol/storage.js.map +1 -1
  37. package/dist/protocol/summary.d.ts +1 -2
  38. package/dist/protocol/summary.d.ts.map +1 -1
  39. package/dist/protocol/summary.js.map +1 -1
  40. package/dist/protocol/tokens.d.ts +1 -2
  41. package/dist/protocol/tokens.d.ts.map +1 -1
  42. package/dist/protocol/tokens.js.map +1 -1
  43. package/dist/storage.d.ts +17 -34
  44. package/dist/storage.d.ts.map +1 -1
  45. package/dist/storage.js +2 -4
  46. package/dist/storage.js.map +1 -1
  47. package/dist/urlResolver.d.ts +5 -10
  48. package/dist/urlResolver.d.ts.map +1 -1
  49. package/dist/urlResolver.js +1 -2
  50. package/dist/urlResolver.js.map +1 -1
  51. package/lib/driverError.d.ts +10 -20
  52. package/lib/driverError.d.ts.map +1 -1
  53. package/lib/driverError.js +1 -2
  54. package/lib/driverError.js.map +1 -1
  55. package/lib/git/resources.d.ts +2 -4
  56. package/lib/git/resources.d.ts.map +1 -1
  57. package/lib/git/resources.js.map +1 -1
  58. package/lib/protocol/clients.d.ts +1 -2
  59. package/lib/protocol/clients.d.ts.map +1 -1
  60. package/lib/protocol/clients.js.map +1 -1
  61. package/lib/protocol/config.d.ts +1 -2
  62. package/lib/protocol/config.d.ts.map +1 -1
  63. package/lib/protocol/config.js.map +1 -1
  64. package/lib/protocol/consensus.d.ts +7 -14
  65. package/lib/protocol/consensus.d.ts.map +1 -1
  66. package/lib/protocol/consensus.js.map +1 -1
  67. package/lib/protocol/date.d.ts +1 -2
  68. package/lib/protocol/date.d.ts.map +1 -1
  69. package/lib/protocol/date.js.map +1 -1
  70. package/lib/protocol/protocol.d.ts +15 -30
  71. package/lib/protocol/protocol.d.ts.map +1 -1
  72. package/lib/protocol/protocol.js +2 -4
  73. package/lib/protocol/protocol.js.map +1 -1
  74. package/lib/protocol/scopes.d.ts +1 -2
  75. package/lib/protocol/scopes.d.ts.map +1 -1
  76. package/lib/protocol/scopes.js +1 -2
  77. package/lib/protocol/scopes.js.map +1 -1
  78. package/lib/protocol/sockets.d.ts +2 -4
  79. package/lib/protocol/sockets.d.ts.map +1 -1
  80. package/lib/protocol/sockets.js.map +1 -1
  81. package/lib/protocol/storage.d.ts +10 -20
  82. package/lib/protocol/storage.d.ts.map +1 -1
  83. package/lib/protocol/storage.js +2 -4
  84. package/lib/protocol/storage.js.map +1 -1
  85. package/lib/protocol/summary.d.ts +1 -2
  86. package/lib/protocol/summary.d.ts.map +1 -1
  87. package/lib/protocol/summary.js.map +1 -1
  88. package/lib/protocol/tokens.d.ts +1 -2
  89. package/lib/protocol/tokens.d.ts.map +1 -1
  90. package/lib/protocol/tokens.js.map +1 -1
  91. package/lib/storage.d.ts +17 -34
  92. package/lib/storage.d.ts.map +1 -1
  93. package/lib/storage.js +2 -4
  94. package/lib/storage.js.map +1 -1
  95. package/lib/urlResolver.d.ts +5 -10
  96. package/lib/urlResolver.d.ts.map +1 -1
  97. package/lib/urlResolver.js +1 -2
  98. package/lib/urlResolver.js.map +1 -1
  99. package/package.json +4 -4
  100. package/src/driverError.ts +10 -20
  101. package/src/git/resources.ts +2 -4
  102. package/src/protocol/clients.ts +1 -2
  103. package/src/protocol/config.ts +1 -2
  104. package/src/protocol/consensus.ts +7 -14
  105. package/src/protocol/date.ts +1 -2
  106. package/src/protocol/protocol.ts +15 -30
  107. package/src/protocol/scopes.ts +1 -2
  108. package/src/protocol/sockets.ts +2 -4
  109. package/src/protocol/storage.ts +11 -21
  110. package/src/protocol/summary.ts +1 -2
  111. package/src/protocol/tokens.ts +1 -2
  112. package/src/storage.ts +17 -34
  113. package/src/urlResolver.ts +5 -10
@@ -10,8 +10,7 @@ const internal_1 = require("@fluidframework/core-interfaces/internal");
10
10
  const { dataCorruptionError, dataProcessingError, ...FluidErrorTypesExceptDataTypes } = internal_1.FluidErrorTypes;
11
11
  /**
12
12
  * Different error types the Driver may report out to the Host.
13
- * @legacy
14
- * @alpha
13
+ * @legacy @beta
15
14
  */
16
15
  exports.DriverErrorTypes = {
17
16
  // Inherit base error types
@@ -1 +1 @@
1
- {"version":3,"file":"driverError.js","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,uEAA2E;AAI3E,8GAA8G;AAC9G,MAAM,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,GAAG,8BAA8B,EAAE,GACpF,0BAAe,CAAC;AAEjB;;;;GAIG;AACU,QAAA,gBAAgB,GAAG;IAC/B,2BAA2B;IAC3B,GAAG,8BAA8B;IAEjC;;;OAGG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;OAEG;IACH,kBAAkB,EAAE,oBAAoB;IAExC;;OAEG;IACH,+BAA+B,EAAE,iCAAiC;IAElE;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,gCAAgC,EAAE,kCAAkC;IAEpE;;;OAGG;IACH,UAAU,EAAE,YAAY;IAExB;;;;;OAKG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,eAAe,EAAE,iBAAiB;IAElC;;OAEG;IACH,uBAAuB,EAAE,yBAAyB;IAElD;;;;;OAKG;IACH,wBAAwB,EAAE,0BAA0B;IAEpD;;OAEG;IACH,8BAA8B,EAAE,gCAAgC;IAEhE;;;OAGG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;;;OAIG;IACH,kBAAkB,EAAE,oBAAoB;IAExC;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,iBAAiB,EAAE,mBAAmB;CAC7B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { FluidErrorTypes } from \"@fluidframework/core-interfaces/internal\";\n\nimport type { IResolvedUrl } from \"./urlResolver.js\";\n\n// Omit `dataCorruptionError` and `dataProcessingError` from the list of values inherited from FluidErrorTypes\nconst { dataCorruptionError, dataProcessingError, ...FluidErrorTypesExceptDataTypes } =\n\tFluidErrorTypes;\n\n/**\n * Different error types the Driver may report out to the Host.\n * @legacy\n * @alpha\n */\nexport const DriverErrorTypes = {\n\t// Inherit base error types\n\t...FluidErrorTypesExceptDataTypes,\n\n\t/**\n\t * Some non-categorized (below) networking error\n\t * Include errors like fatal server error (usually 500).\n\t */\n\tgenericNetworkError: \"genericNetworkError\",\n\n\t/**\n\t * Access denied - user does not have enough privileges to open a file, or continue to operate on a file\n\t */\n\tauthorizationError: \"authorizationError\",\n\n\t/**\n\t * File not found, or file deleted during session\n\t */\n\tfileNotFoundOrAccessDeniedError: \"fileNotFoundOrAccessDeniedError\",\n\n\t/**\n\t * We can not reach server due to computer being offline.\n\t */\n\tofflineError: \"offlineError\",\n\n\t/*\n\t * Unsupported client protocol\n\t */\n\tunsupportedClientProtocolVersion: \"unsupportedClientProtocolVersion\",\n\n\t/**\n\t * User does not have write permissions to a file, but is changing content of a file.\n\t * That might be indication of some data store error - data stores should not generate ops in readonly mode.\n\t */\n\twriteError: \"writeError\",\n\n\t/**\n\t * A generic fetch failure that indicates we were not able to get a response from the server.\n\t * This may be due to the client being offline (though, if we are able to detect offline state it will be\n\t * logged as an offlineError instead). Other possibilities could be DNS errors, malformed fetch request,\n\t * CSP violation, etc.\n\t */\n\tfetchFailure: \"fetchFailure\",\n\n\t/**\n\t * This error occurs when token provider fails to fetch orderer token\n\t */\n\tfetchTokenError: \"fetchTokenError\",\n\n\t/**\n\t * Unexpected response from server. Either JSON is malformed, or some required properties are missing\n\t */\n\tincorrectServerResponse: \"incorrectServerResponse\",\n\n\t/**\n\t * This error occurs when the file is modified externally (not through Fluid protocol) in storage.\n\t * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,\n\t * and storage / driver / loader detects such mismatch.\n\t * When it's hit, client needs to forget all the knowledge about this file and start over.\n\t */\n\tfileOverwrittenInStorage: \"fileOverwrittenInStorage\",\n\n\t/**\n\t * The document is read-only and delta stream connection is forbidden.\n\t */\n\tdeltaStreamConnectionForbidden: \"deltaStreamConnectionForbidden\",\n\n\t/**\n\t * The location of file/container can change on server. So if the file location moves and we try to access the old\n\t * location, then this error is thrown to let the client know about the new location info.\n\t */\n\tlocationRedirection: \"locationRedirection\",\n\n\t/**\n\t * When a file is not a Fluid file, but has Fluid extension such as \".note\",\n\t * server won't be able to open it and will return this error. The innerMostErrorCode will be\n\t * \"fluidInvalidSchema\"\n\t */\n\tfluidInvalidSchema: \"fluidInvalidSchema\",\n\n\t/**\n\t * File is locked for read/write by storage, e.g. whole collection is locked and access denied.\n\t */\n\tfileIsLocked: \"fileIsLocked\",\n\n\t/**\n\t * Storage is out of space\n\t */\n\toutOfStorageError: \"outOfStorageError\",\n} as const;\n/**\n * {@inheritDoc (DriverErrorTypes:variable)}\n * @legacy\n * @alpha\n */\nexport type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];\n\n/**\n * Interface describing errors and warnings raised by any driver code.\n *\n * @remarks\n * Not expected to be implemented by a class or an object literal, but rather used in place of\n * any or unknown in various function signatures that pass errors around.\n *\n * \"Any\" in the interface name is a nod to the fact that errorType has lost its type constraint.\n * It will be either {@link @fluidframework/driver-definitions#(DriverErrorTypes:variable)} or the specific driver's specialized error type enum,\n * but we can't reference a specific driver's error type enum in this code.\n * @legacy\n * @alpha\n */\nexport interface IAnyDriverError extends Omit<IDriverErrorBase, \"errorType\"> {\n\treadonly errorType: string;\n\t/**\n\t * This property is used predominantly for socket io errors. It captures the underlying socket event name which resulted in the error.\n\t * i.e. connect_error, connect_document_error etc.\n\t */\n\tscenarioName?: string;\n}\n\n/**\n * Base interface for all errors and warnings\n * @legacy\n * @alpha\n */\nexport interface IDriverErrorBase {\n\t/**\n\t * Classification of what type of error this is, used programmatically by consumers to interpret the error.\n\t *\n\t * @privateRemarks TODO: use {@link DriverErrorTypes} instead (breaking change).\n\t */\n\treadonly errorType: DriverErrorTypes;\n\n\t/**\n\t * Free-form error message\n\t */\n\treadonly message: string;\n\n\t/**\n\t * True indicates the caller may retry the failed action. False indicates it's a fatal error\n\t */\n\tcanRetry: boolean;\n\n\t/**\n\t * Best guess as to network conditions (online/offline) when the error arose.\n\t * See OnlineStatus enum in driver-utils package for expected values.\n\t */\n\tonline?: string;\n\n\t/**\n\t * Whether service was reachable and we got some response from service.\n\t */\n\tendpointReached?: boolean;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IThrottlingWarning extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.throttlingError;\n\treadonly retryAfterSeconds: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IGenericNetworkError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.genericNetworkError;\n\treadonly statusCode?: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IAuthorizationError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.authorizationError;\n\treadonly claims?: string;\n\treadonly tenantId?: string;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface ILocationRedirectionError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.locationRedirection;\n\treadonly redirectUrl: IResolvedUrl;\n}\n\n/**\n * Having this uber interface without types that have their own interfaces\n * allows compiler to differentiate interfaces based on error type\n * @legacy\n * @alpha\n */\nexport interface IDriverBasicError extends IDriverErrorBase {\n\treadonly errorType:\n\t\t| typeof DriverErrorTypes.genericError\n\t\t| typeof DriverErrorTypes.fileNotFoundOrAccessDeniedError\n\t\t| typeof DriverErrorTypes.offlineError\n\t\t| typeof DriverErrorTypes.unsupportedClientProtocolVersion\n\t\t| typeof DriverErrorTypes.writeError\n\t\t| typeof DriverErrorTypes.fetchFailure\n\t\t| typeof DriverErrorTypes.fetchTokenError\n\t\t| typeof DriverErrorTypes.incorrectServerResponse\n\t\t| typeof DriverErrorTypes.fileOverwrittenInStorage\n\t\t| typeof DriverErrorTypes.fluidInvalidSchema\n\t\t| typeof DriverErrorTypes.usageError\n\t\t| typeof DriverErrorTypes.fileIsLocked\n\t\t| typeof DriverErrorTypes.outOfStorageError;\n\treadonly statusCode?: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport type DriverError =\n\t| IThrottlingWarning\n\t| IGenericNetworkError\n\t| IAuthorizationError\n\t| ILocationRedirectionError\n\t| IDriverBasicError;\n"]}
1
+ {"version":3,"file":"driverError.js","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,uEAA2E;AAI3E,8GAA8G;AAC9G,MAAM,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,GAAG,8BAA8B,EAAE,GACpF,0BAAe,CAAC;AAEjB;;;GAGG;AACU,QAAA,gBAAgB,GAAG;IAC/B,2BAA2B;IAC3B,GAAG,8BAA8B;IAEjC;;;OAGG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;OAEG;IACH,kBAAkB,EAAE,oBAAoB;IAExC;;OAEG;IACH,+BAA+B,EAAE,iCAAiC;IAElE;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,gCAAgC,EAAE,kCAAkC;IAEpE;;;OAGG;IACH,UAAU,EAAE,YAAY;IAExB;;;;;OAKG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,eAAe,EAAE,iBAAiB;IAElC;;OAEG;IACH,uBAAuB,EAAE,yBAAyB;IAElD;;;;;OAKG;IACH,wBAAwB,EAAE,0BAA0B;IAEpD;;OAEG;IACH,8BAA8B,EAAE,gCAAgC;IAEhE;;;OAGG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;;;OAIG;IACH,kBAAkB,EAAE,oBAAoB;IAExC;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,iBAAiB,EAAE,mBAAmB;CAC7B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { FluidErrorTypes } from \"@fluidframework/core-interfaces/internal\";\n\nimport type { IResolvedUrl } from \"./urlResolver.js\";\n\n// Omit `dataCorruptionError` and `dataProcessingError` from the list of values inherited from FluidErrorTypes\nconst { dataCorruptionError, dataProcessingError, ...FluidErrorTypesExceptDataTypes } =\n\tFluidErrorTypes;\n\n/**\n * Different error types the Driver may report out to the Host.\n * @legacy @beta\n */\nexport const DriverErrorTypes = {\n\t// Inherit base error types\n\t...FluidErrorTypesExceptDataTypes,\n\n\t/**\n\t * Some non-categorized (below) networking error\n\t * Include errors like fatal server error (usually 500).\n\t */\n\tgenericNetworkError: \"genericNetworkError\",\n\n\t/**\n\t * Access denied - user does not have enough privileges to open a file, or continue to operate on a file\n\t */\n\tauthorizationError: \"authorizationError\",\n\n\t/**\n\t * File not found, or file deleted during session\n\t */\n\tfileNotFoundOrAccessDeniedError: \"fileNotFoundOrAccessDeniedError\",\n\n\t/**\n\t * We can not reach server due to computer being offline.\n\t */\n\tofflineError: \"offlineError\",\n\n\t/*\n\t * Unsupported client protocol\n\t */\n\tunsupportedClientProtocolVersion: \"unsupportedClientProtocolVersion\",\n\n\t/**\n\t * User does not have write permissions to a file, but is changing content of a file.\n\t * That might be indication of some data store error - data stores should not generate ops in readonly mode.\n\t */\n\twriteError: \"writeError\",\n\n\t/**\n\t * A generic fetch failure that indicates we were not able to get a response from the server.\n\t * This may be due to the client being offline (though, if we are able to detect offline state it will be\n\t * logged as an offlineError instead). Other possibilities could be DNS errors, malformed fetch request,\n\t * CSP violation, etc.\n\t */\n\tfetchFailure: \"fetchFailure\",\n\n\t/**\n\t * This error occurs when token provider fails to fetch orderer token\n\t */\n\tfetchTokenError: \"fetchTokenError\",\n\n\t/**\n\t * Unexpected response from server. Either JSON is malformed, or some required properties are missing\n\t */\n\tincorrectServerResponse: \"incorrectServerResponse\",\n\n\t/**\n\t * This error occurs when the file is modified externally (not through Fluid protocol) in storage.\n\t * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,\n\t * and storage / driver / loader detects such mismatch.\n\t * When it's hit, client needs to forget all the knowledge about this file and start over.\n\t */\n\tfileOverwrittenInStorage: \"fileOverwrittenInStorage\",\n\n\t/**\n\t * The document is read-only and delta stream connection is forbidden.\n\t */\n\tdeltaStreamConnectionForbidden: \"deltaStreamConnectionForbidden\",\n\n\t/**\n\t * The location of file/container can change on server. So if the file location moves and we try to access the old\n\t * location, then this error is thrown to let the client know about the new location info.\n\t */\n\tlocationRedirection: \"locationRedirection\",\n\n\t/**\n\t * When a file is not a Fluid file, but has Fluid extension such as \".note\",\n\t * server won't be able to open it and will return this error. The innerMostErrorCode will be\n\t * \"fluidInvalidSchema\"\n\t */\n\tfluidInvalidSchema: \"fluidInvalidSchema\",\n\n\t/**\n\t * File is locked for read/write by storage, e.g. whole collection is locked and access denied.\n\t */\n\tfileIsLocked: \"fileIsLocked\",\n\n\t/**\n\t * Storage is out of space\n\t */\n\toutOfStorageError: \"outOfStorageError\",\n} as const;\n/**\n * {@inheritDoc (DriverErrorTypes:variable)}\n * @legacy @beta\n */\nexport type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];\n\n/**\n * Interface describing errors and warnings raised by any driver code.\n *\n * @remarks\n * Not expected to be implemented by a class or an object literal, but rather used in place of\n * any or unknown in various function signatures that pass errors around.\n *\n * \"Any\" in the interface name is a nod to the fact that errorType has lost its type constraint.\n * It will be either {@link @fluidframework/driver-definitions#(DriverErrorTypes:variable)} or the specific driver's specialized error type enum,\n * but we can't reference a specific driver's error type enum in this code.\n * @legacy @beta\n */\nexport interface IAnyDriverError extends Omit<IDriverErrorBase, \"errorType\"> {\n\treadonly errorType: string;\n\t/**\n\t * This property is used predominantly for socket io errors. It captures the underlying socket event name which resulted in the error.\n\t * i.e. connect_error, connect_document_error etc.\n\t */\n\tscenarioName?: string;\n}\n\n/**\n * Base interface for all errors and warnings\n * @legacy @beta\n */\nexport interface IDriverErrorBase {\n\t/**\n\t * Classification of what type of error this is, used programmatically by consumers to interpret the error.\n\t *\n\t * @privateRemarks TODO: use {@link DriverErrorTypes} instead (breaking change).\n\t */\n\treadonly errorType: DriverErrorTypes;\n\n\t/**\n\t * Free-form error message\n\t */\n\treadonly message: string;\n\n\t/**\n\t * True indicates the caller may retry the failed action. False indicates it's a fatal error\n\t */\n\tcanRetry: boolean;\n\n\t/**\n\t * Best guess as to network conditions (online/offline) when the error arose.\n\t * See OnlineStatus enum in driver-utils package for expected values.\n\t */\n\tonline?: string;\n\n\t/**\n\t * Whether service was reachable and we got some response from service.\n\t */\n\tendpointReached?: boolean;\n}\n\n/**\n * @legacy @beta\n */\nexport interface IThrottlingWarning extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.throttlingError;\n\treadonly retryAfterSeconds: number;\n}\n\n/**\n * @legacy @beta\n */\nexport interface IGenericNetworkError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.genericNetworkError;\n\treadonly statusCode?: number;\n}\n\n/**\n * @legacy @beta\n */\nexport interface IAuthorizationError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.authorizationError;\n\treadonly claims?: string;\n\treadonly tenantId?: string;\n}\n\n/**\n * @legacy @beta\n */\nexport interface ILocationRedirectionError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.locationRedirection;\n\treadonly redirectUrl: IResolvedUrl;\n}\n\n/**\n * Having this uber interface without types that have their own interfaces\n * allows compiler to differentiate interfaces based on error type\n * @legacy @beta\n */\nexport interface IDriverBasicError extends IDriverErrorBase {\n\treadonly errorType:\n\t\t| typeof DriverErrorTypes.genericError\n\t\t| typeof DriverErrorTypes.fileNotFoundOrAccessDeniedError\n\t\t| typeof DriverErrorTypes.offlineError\n\t\t| typeof DriverErrorTypes.unsupportedClientProtocolVersion\n\t\t| typeof DriverErrorTypes.writeError\n\t\t| typeof DriverErrorTypes.fetchFailure\n\t\t| typeof DriverErrorTypes.fetchTokenError\n\t\t| typeof DriverErrorTypes.incorrectServerResponse\n\t\t| typeof DriverErrorTypes.fileOverwrittenInStorage\n\t\t| typeof DriverErrorTypes.fluidInvalidSchema\n\t\t| typeof DriverErrorTypes.usageError\n\t\t| typeof DriverErrorTypes.fileIsLocked\n\t\t| typeof DriverErrorTypes.outOfStorageError;\n\treadonly statusCode?: number;\n}\n\n/**\n * @legacy @beta\n */\nexport type DriverError =\n\t| IThrottlingWarning\n\t| IGenericNetworkError\n\t| IAuthorizationError\n\t| ILocationRedirectionError\n\t| IDriverBasicError;\n"]}
@@ -116,8 +116,7 @@ export interface IRef {
116
116
  }
117
117
  /**
118
118
  * Required params to create ref
119
- * @legacy
120
- * @alpha
119
+ * @legacy @beta
121
120
  */
122
121
  export interface ICreateRefParams {
123
122
  ref: string;
@@ -125,8 +124,7 @@ export interface ICreateRefParams {
125
124
  }
126
125
  /**
127
126
  * Required params to patch ref
128
- * @legacy
129
- * @alpha
127
+ * @legacy @beta
130
128
  */
131
129
  export interface IPatchRefParams {
132
130
  sha: string;
@@ -1 +1 @@
1
- {"version":3,"file":"resources.d.ts","sourceRoot":"","sources":["../../src/git/resources.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB,MAAM,EAAE,OAAO,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,UAAU,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,WAAW,EAAE,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,cAAc;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QACP,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,OAAO,CAAC;QAChB,SAAS,EAAE,UAAU,CAAC;QACtB,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,WAAW,CAAC;KAClB,CAAC;IACF,OAAO,EAAE,WAAW,EAAE,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAEjC,OAAO,EAAE,MAAM,CAAC;IAIhB,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IACjC,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,gBAAgB,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,UAAU,EAAE,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC;CACF"}
1
+ {"version":3,"file":"resources.d.ts","sourceRoot":"","sources":["../../src/git/resources.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB,MAAM,EAAE,OAAO,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,UAAU,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,WAAW,EAAE,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,cAAc;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QACP,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,OAAO,CAAC;QAChB,SAAS,EAAE,UAAU,CAAC;QACtB,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,WAAW,CAAC;KAClB,CAAC;IACF,OAAO,EAAE,WAAW,EAAE,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAEjC,OAAO,EAAE,MAAM,CAAC;IAIhB,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IACjC,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,gBAAgB,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,UAAU,EAAE,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC;CACF"}
@@ -1 +1 @@
1
- {"version":3,"file":"resources.js","sourceRoot":"","sources":["../../src/git/resources.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// The types defined in this directory provide strong typing for the deserialized\n// REST payloads when communicating with the Git service.\n//\n// These should not be changed unless Git itself is changed, and should be aligned\n// with the service side definitions contained here:\n//\n// server/routerlicious/packages/gitresources/src/resources.ts\n\n/**\n * Details about the author of the commit\n * @internal\n */\nexport interface IAuthor {\n\tname: string;\n\temail: string;\n\t// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\tdate: string;\n}\n\n/**\n * Details about the committer of the commit\n * @internal\n */\nexport interface ICommitter {\n\tname: string;\n\temail: string;\n\t// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\tdate: string;\n}\n\n/**\n * Details of the commit\n * @internal\n */\nexport interface ICommitHash {\n\tsha: string;\n\turl: string;\n}\n\n/**\n * Required params to create commit\n * @internal\n */\nexport interface ICreateCommitParams {\n\tmessage: string;\n\ttree: string;\n\tparents: string[];\n\t// GitHub has signature verification on the author\n\tauthor: IAuthor;\n}\n\n/**\n * Commit content\n * @internal\n */\nexport interface ICommit {\n\tsha: string;\n\turl: string;\n\tauthor: IAuthor;\n\tcommitter: ICommitter;\n\tmessage: string;\n\ttree: ICommitHash;\n\tparents: ICommitHash[];\n}\n\n/**\n * Details of a commit\n *\n * GitHub differentiates the commit resource returned from its git and repos routes. The repos\n * route returns more site specific information (like links to the developer's account) while the git\n * route is what is actually stored in the Git repo\n *\n * https://developer.github.com/v3/git/commits/\n * https://developer.github.com/v3/repos/commits/\n * @internal\n */\nexport interface ICommitDetails {\n\turl: string;\n\tsha: string;\n\tcommit: {\n\t\turl: string;\n\t\tauthor: IAuthor;\n\t\tcommitter: ICommitter;\n\t\tmessage: string;\n\t\ttree: ICommitHash;\n\t};\n\tparents: ICommitHash[];\n}\n\n/**\n * Blob content\n * @internal\n */\nexport interface IBlob {\n\tcontent: string;\n\tencoding: string;\n\turl: string;\n\tsha: string;\n\tsize: number;\n}\n\n/**\n * Required params to create blob\n * @internal\n */\nexport interface ICreateBlobParams {\n\t// The encoded content\n\tcontent: string;\n\n\t// The encoding of the content.\n\t// eslint-disable-next-line unicorn/text-encoding-identifier-case\n\tencoding: \"utf-8\" | \"base64\";\n}\n\n/**\n * Response to create blob request\n * @internal\n */\nexport interface ICreateBlobResponse {\n\tsha: string;\n\turl: string;\n}\n\n/**\n * Ref content\n * @internal\n */\nexport interface IRef {\n\tref: string;\n\turl: string;\n\tobject: {\n\t\ttype: string;\n\t\tsha: string;\n\t\turl: string;\n\t};\n}\n\n/**\n * Required params to create ref\n * @legacy\n * @alpha\n */\nexport interface ICreateRefParams {\n\tref: string;\n\tsha: string;\n}\n\n/**\n * Required params to patch ref\n * @legacy\n * @alpha\n */\nexport interface IPatchRefParams {\n\tsha: string;\n\tforce: boolean;\n}\n\n/**\n * Required params to create repo\n * @param name - name of the repository\n * @internal\n */\nexport interface ICreateRepoParams {\n\tname: string;\n}\n\n/**\n * Required details to create tree entry\n * @internal\n */\nexport interface ICreateTreeEntry {\n\tpath: string;\n\tmode: string;\n\ttype: string;\n\tsha: string;\n}\n\n/**\n * Required params to create tree\n * @internal\n */\nexport interface ICreateTreeParams {\n\tbase_tree?: string;\n\ttree: ICreateTreeEntry[];\n}\n\n/**\n * Tree Entry Content\n * @internal\n */\nexport interface ITreeEntry {\n\tpath: string;\n\tmode: string;\n\ttype: string;\n\tsize: number;\n\tsha: string;\n\turl: string;\n}\n\n/**\n * Tree content\n * @internal\n */\nexport interface ITree {\n\tsha: string;\n\turl: string;\n\ttree: ITreeEntry[];\n}\n\n/**\n * Tagger content\n * @internal\n */\nexport interface ITagger {\n\tname: string;\n\temail: string;\n\t// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\tdate: string;\n}\n\n/**\n * Required params to create tag\n * @internal\n */\nexport interface ICreateTagParams {\n\ttag: string;\n\tmessage: string;\n\tobject: string;\n\ttype: string;\n\ttagger: ITagger;\n}\n\n/**\n * Tag content\n * @internal\n */\nexport interface ITag {\n\ttag: string;\n\tsha: string;\n\turl: string;\n\tmessage: string;\n\ttagger: ITagger;\n\tobject: {\n\t\ttype: string;\n\t\tsha: string;\n\t\turl: string;\n\t};\n}\n"]}
1
+ {"version":3,"file":"resources.js","sourceRoot":"","sources":["../../src/git/resources.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// The types defined in this directory provide strong typing for the deserialized\n// REST payloads when communicating with the Git service.\n//\n// These should not be changed unless Git itself is changed, and should be aligned\n// with the service side definitions contained here:\n//\n// server/routerlicious/packages/gitresources/src/resources.ts\n\n/**\n * Details about the author of the commit\n * @internal\n */\nexport interface IAuthor {\n\tname: string;\n\temail: string;\n\t// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\tdate: string;\n}\n\n/**\n * Details about the committer of the commit\n * @internal\n */\nexport interface ICommitter {\n\tname: string;\n\temail: string;\n\t// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\tdate: string;\n}\n\n/**\n * Details of the commit\n * @internal\n */\nexport interface ICommitHash {\n\tsha: string;\n\turl: string;\n}\n\n/**\n * Required params to create commit\n * @internal\n */\nexport interface ICreateCommitParams {\n\tmessage: string;\n\ttree: string;\n\tparents: string[];\n\t// GitHub has signature verification on the author\n\tauthor: IAuthor;\n}\n\n/**\n * Commit content\n * @internal\n */\nexport interface ICommit {\n\tsha: string;\n\turl: string;\n\tauthor: IAuthor;\n\tcommitter: ICommitter;\n\tmessage: string;\n\ttree: ICommitHash;\n\tparents: ICommitHash[];\n}\n\n/**\n * Details of a commit\n *\n * GitHub differentiates the commit resource returned from its git and repos routes. The repos\n * route returns more site specific information (like links to the developer's account) while the git\n * route is what is actually stored in the Git repo\n *\n * https://developer.github.com/v3/git/commits/\n * https://developer.github.com/v3/repos/commits/\n * @internal\n */\nexport interface ICommitDetails {\n\turl: string;\n\tsha: string;\n\tcommit: {\n\t\turl: string;\n\t\tauthor: IAuthor;\n\t\tcommitter: ICommitter;\n\t\tmessage: string;\n\t\ttree: ICommitHash;\n\t};\n\tparents: ICommitHash[];\n}\n\n/**\n * Blob content\n * @internal\n */\nexport interface IBlob {\n\tcontent: string;\n\tencoding: string;\n\turl: string;\n\tsha: string;\n\tsize: number;\n}\n\n/**\n * Required params to create blob\n * @internal\n */\nexport interface ICreateBlobParams {\n\t// The encoded content\n\tcontent: string;\n\n\t// The encoding of the content.\n\t// eslint-disable-next-line unicorn/text-encoding-identifier-case\n\tencoding: \"utf-8\" | \"base64\";\n}\n\n/**\n * Response to create blob request\n * @internal\n */\nexport interface ICreateBlobResponse {\n\tsha: string;\n\turl: string;\n}\n\n/**\n * Ref content\n * @internal\n */\nexport interface IRef {\n\tref: string;\n\turl: string;\n\tobject: {\n\t\ttype: string;\n\t\tsha: string;\n\t\turl: string;\n\t};\n}\n\n/**\n * Required params to create ref\n * @legacy @beta\n */\nexport interface ICreateRefParams {\n\tref: string;\n\tsha: string;\n}\n\n/**\n * Required params to patch ref\n * @legacy @beta\n */\nexport interface IPatchRefParams {\n\tsha: string;\n\tforce: boolean;\n}\n\n/**\n * Required params to create repo\n * @param name - name of the repository\n * @internal\n */\nexport interface ICreateRepoParams {\n\tname: string;\n}\n\n/**\n * Required details to create tree entry\n * @internal\n */\nexport interface ICreateTreeEntry {\n\tpath: string;\n\tmode: string;\n\ttype: string;\n\tsha: string;\n}\n\n/**\n * Required params to create tree\n * @internal\n */\nexport interface ICreateTreeParams {\n\tbase_tree?: string;\n\ttree: ICreateTreeEntry[];\n}\n\n/**\n * Tree Entry Content\n * @internal\n */\nexport interface ITreeEntry {\n\tpath: string;\n\tmode: string;\n\ttype: string;\n\tsize: number;\n\tsha: string;\n\turl: string;\n}\n\n/**\n * Tree content\n * @internal\n */\nexport interface ITree {\n\tsha: string;\n\turl: string;\n\ttree: ITreeEntry[];\n}\n\n/**\n * Tagger content\n * @internal\n */\nexport interface ITagger {\n\tname: string;\n\temail: string;\n\t// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\tdate: string;\n}\n\n/**\n * Required params to create tag\n * @internal\n */\nexport interface ICreateTagParams {\n\ttag: string;\n\tmessage: string;\n\tobject: string;\n\ttype: string;\n\ttagger: ITagger;\n}\n\n/**\n * Tag content\n * @internal\n */\nexport interface ITag {\n\ttag: string;\n\tsha: string;\n\turl: string;\n\tmessage: string;\n\ttagger: ITagger;\n\tobject: {\n\t\ttype: string;\n\t\tsha: string;\n\t\turl: string;\n\t};\n}\n"]}
@@ -96,8 +96,7 @@ export interface ISequencedClient {
96
96
  sequenceNumber: number;
97
97
  }
98
98
  /**
99
- * @legacy
100
- * @alpha
99
+ * @legacy @beta
101
100
  */
102
101
  export interface ISignalClient {
103
102
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"clients.d.ts","sourceRoot":"","sources":["../../src/protocol/clients.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,MAAM,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B;;;;;;;;OAQG;IACH,WAAW,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,YAAY,EAAE,aAAa,CAAC;IAE5B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC;IAExB,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IAEZ;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CAChB"}
1
+ {"version":3,"file":"clients.d.ts","sourceRoot":"","sources":["../../src/protocol/clients.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,MAAM,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B;;;;;;;;OAQG;IACH,WAAW,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,YAAY,EAAE,aAAa,CAAC;IAE5B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC;IAExB,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IAEZ;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CAChB"}
@@ -1 +1 @@
1
- {"version":3,"file":"clients.js","sourceRoot":"","sources":["../../src/protocol/clients.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IUser } from \"./users.js\";\n\n/**\n * A client's connection mode - either view-only (\"read\") or allowing edits (\"write\").\n *\n * @remarks\n *\n * Note: a user's connection mode is dependent on their permissions.\n * E.g. a user with read-only permissions will not be allowed a \"write\" connection mode.\n * @public\n */\nexport type ConnectionMode = \"write\" | \"read\";\n\n/**\n * Capabilities of a Client.\n * In particular, whether or not the client is {@link ICapabilities.interactive}.\n * @public\n */\nexport interface ICapabilities {\n\t/**\n\t * Indicates if the client represents a potentially interactive session with a user (if 'true') or if it's\n\t * a \"system entity\" (if 'false').\n\t *\n\t * @remarks\n\t *\n\t * The only \"system entity\" scenario at the moment is the\n\t * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer client}.\n\t */\n\tinteractive: boolean;\n}\n\n/**\n * {@link IClient} connection / environment metadata.\n * @public\n */\nexport interface IClientDetails {\n\t/**\n\t * {@inheritDoc ICapabilities}\n\t */\n\tcapabilities: ICapabilities;\n\n\t/**\n\t * The kind of client being described.\n\t *\n\t * `undefined` indicates that the kind could not be determined.\n\t */\n\ttype?: string;\n\n\t/**\n\t * @remarks\n\t *\n\t * If the environment needs to specify multiple properties which gives info about the environment, then\n\t * it should be in particular format like: \"prop1:val1;prop2:val2;prop3:val3\"\n\t */\n\tenvironment?: string;\n\tdevice?: string;\n}\n\n/**\n * Represents a client connected to a Fluid service, including associated user details, permissions, and connection mode.\n * @public\n */\nexport interface IClient {\n\t/**\n\t * {@inheritDoc ConnectionMode}\n\t */\n\tmode: ConnectionMode;\n\n\t/**\n\t * {@inheritDoc IClientDetails}\n\t */\n\tdetails: IClientDetails;\n\n\tpermission: string[];\n\n\t/**\n\t * The user information associated with this client connection.\n\t */\n\tuser: IUser;\n\n\t/**\n\t * Enumerates actions allowed for the client connection.\n\t */\n\tscopes: string[];\n\n\t/**\n\t * The time the client connected to the service.\n\t */\n\ttimestamp?: number;\n}\n\n/**\n * A {@link IClient} that has been acknowledged by the sequencer.\n * @public\n */\nexport interface ISequencedClient {\n\t/**\n\t * The underlying client details.\n\t */\n\tclient: IClient;\n\n\t/**\n\t * The sequence number of the \"join\" message sent when the client joined the session.\n\t */\n\tsequenceNumber: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface ISignalClient {\n\t/**\n\t * The {@link ISignalClient.client}'s unique ID.\n\t */\n\tclientId: string;\n\n\t/**\n\t * The underlying client details.\n\t */\n\tclient: IClient;\n\n\t/**\n\t * Counts the number of signals sent by the client.\n\t */\n\tclientConnectionNumber?: number;\n\n\t/**\n\t * Sequence number that indicates when the signal was created in relation to the delta stream.\n\t */\n\treferenceSequenceNumber?: number;\n}\n\n/**\n * Contents sent with a `ClientJoin` message.\n * @internal\n */\nexport interface IClientJoin {\n\t/**\n\t * The ID of the joining client.\n\t */\n\tclientId: string;\n\n\t/**\n\t * The underlying client details.\n\t */\n\tdetail: IClient;\n}\n"]}
1
+ {"version":3,"file":"clients.js","sourceRoot":"","sources":["../../src/protocol/clients.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IUser } from \"./users.js\";\n\n/**\n * A client's connection mode - either view-only (\"read\") or allowing edits (\"write\").\n *\n * @remarks\n *\n * Note: a user's connection mode is dependent on their permissions.\n * E.g. a user with read-only permissions will not be allowed a \"write\" connection mode.\n * @public\n */\nexport type ConnectionMode = \"write\" | \"read\";\n\n/**\n * Capabilities of a Client.\n * In particular, whether or not the client is {@link ICapabilities.interactive}.\n * @public\n */\nexport interface ICapabilities {\n\t/**\n\t * Indicates if the client represents a potentially interactive session with a user (if 'true') or if it's\n\t * a \"system entity\" (if 'false').\n\t *\n\t * @remarks\n\t *\n\t * The only \"system entity\" scenario at the moment is the\n\t * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer client}.\n\t */\n\tinteractive: boolean;\n}\n\n/**\n * {@link IClient} connection / environment metadata.\n * @public\n */\nexport interface IClientDetails {\n\t/**\n\t * {@inheritDoc ICapabilities}\n\t */\n\tcapabilities: ICapabilities;\n\n\t/**\n\t * The kind of client being described.\n\t *\n\t * `undefined` indicates that the kind could not be determined.\n\t */\n\ttype?: string;\n\n\t/**\n\t * @remarks\n\t *\n\t * If the environment needs to specify multiple properties which gives info about the environment, then\n\t * it should be in particular format like: \"prop1:val1;prop2:val2;prop3:val3\"\n\t */\n\tenvironment?: string;\n\tdevice?: string;\n}\n\n/**\n * Represents a client connected to a Fluid service, including associated user details, permissions, and connection mode.\n * @public\n */\nexport interface IClient {\n\t/**\n\t * {@inheritDoc ConnectionMode}\n\t */\n\tmode: ConnectionMode;\n\n\t/**\n\t * {@inheritDoc IClientDetails}\n\t */\n\tdetails: IClientDetails;\n\n\tpermission: string[];\n\n\t/**\n\t * The user information associated with this client connection.\n\t */\n\tuser: IUser;\n\n\t/**\n\t * Enumerates actions allowed for the client connection.\n\t */\n\tscopes: string[];\n\n\t/**\n\t * The time the client connected to the service.\n\t */\n\ttimestamp?: number;\n}\n\n/**\n * A {@link IClient} that has been acknowledged by the sequencer.\n * @public\n */\nexport interface ISequencedClient {\n\t/**\n\t * The underlying client details.\n\t */\n\tclient: IClient;\n\n\t/**\n\t * The sequence number of the \"join\" message sent when the client joined the session.\n\t */\n\tsequenceNumber: number;\n}\n\n/**\n * @legacy @beta\n */\nexport interface ISignalClient {\n\t/**\n\t * The {@link ISignalClient.client}'s unique ID.\n\t */\n\tclientId: string;\n\n\t/**\n\t * The underlying client details.\n\t */\n\tclient: IClient;\n\n\t/**\n\t * Counts the number of signals sent by the client.\n\t */\n\tclientConnectionNumber?: number;\n\n\t/**\n\t * Sequence number that indicates when the signal was created in relation to the delta stream.\n\t */\n\treferenceSequenceNumber?: number;\n}\n\n/**\n * Contents sent with a `ClientJoin` message.\n * @internal\n */\nexport interface IClientJoin {\n\t/**\n\t * The ID of the joining client.\n\t */\n\tclientId: string;\n\n\t/**\n\t * The underlying client details.\n\t */\n\tdetail: IClient;\n}\n"]}
@@ -4,8 +4,7 @@
4
4
  */
5
5
  /**
6
6
  * Key value store of service configuration properties provided to the client as part of connection.
7
- * @legacy
8
- * @alpha
7
+ * @legacy @beta
9
8
  */
10
9
  export interface IClientConfiguration {
11
10
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/protocol/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC5B"}
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/protocol/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC5B"}
@@ -1 +1 @@
1
- {"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/protocol/config.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/**\n * Key value store of service configuration properties provided to the client as part of connection.\n * @legacy\n * @alpha\n */\nexport interface IClientConfiguration {\n\t/**\n\t * Max message size the server will accept before requiring chunking.\n\t */\n\tmaxMessageSize: number;\n\n\t/**\n\t * Server-defined ideal block size for storing snapshots.\n\t */\n\tblockSize: number;\n\n\t/**\n\t * noopTimeFrequency & noopCountFrequency control how often a client with \"write\" connection needs to send\n\t * noop messages in case no other ops are being sent. Any op (including noops) result in client\n\t * communicating its reference sequence number to the relay service, which can recalculate MSN based on new info.\n\t * Clients send noops when either noopTimeFrequency ms elapsed from receiving the last op or when receiving\n\t * noopCountFrequency ops and only if the client did not have a chance to communicate its reference sequence\n\t * number via regular ops.\n\t * 'Infinity' will disable this feature and if no value is provided, the client choses some reasonable value.\n\t */\n\tnoopTimeFrequency?: number;\n\n\t/**\n\t * Set min op frequency with which noops would be sent in case of an active connection which is not sending any op.\n\t * See {@link IClientConfiguration.noopTimeFrequency} for more details.\n\t * 'Infinity' will disable this feature and if no value is provided, the client choses some reasonable value.\n\t */\n\tnoopCountFrequency?: number;\n}\n"]}
1
+ {"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/protocol/config.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/**\n * Key value store of service configuration properties provided to the client as part of connection.\n * @legacy @beta\n */\nexport interface IClientConfiguration {\n\t/**\n\t * Max message size the server will accept before requiring chunking.\n\t */\n\tmaxMessageSize: number;\n\n\t/**\n\t * Server-defined ideal block size for storing snapshots.\n\t */\n\tblockSize: number;\n\n\t/**\n\t * noopTimeFrequency & noopCountFrequency control how often a client with \"write\" connection needs to send\n\t * noop messages in case no other ops are being sent. Any op (including noops) result in client\n\t * communicating its reference sequence number to the relay service, which can recalculate MSN based on new info.\n\t * Clients send noops when either noopTimeFrequency ms elapsed from receiving the last op or when receiving\n\t * noopCountFrequency ops and only if the client did not have a chance to communicate its reference sequence\n\t * number via regular ops.\n\t * 'Infinity' will disable this feature and if no value is provided, the client choses some reasonable value.\n\t */\n\tnoopTimeFrequency?: number;\n\n\t/**\n\t * Set min op frequency with which noops would be sent in case of an active connection which is not sending any op.\n\t * See {@link IClientConfiguration.noopTimeFrequency} for more details.\n\t * 'Infinity' will disable this feature and if no value is provided, the client choses some reasonable value.\n\t */\n\tnoopCountFrequency?: number;\n}\n"]}
@@ -10,8 +10,7 @@ import type { ISequencedClient } from "./clients.js";
10
10
  * Consensus on the proposal is achieved if the MSN is \>= the sequence number
11
11
  * at which the proposal is made and no client within the collaboration window rejects
12
12
  * the proposal.
13
- * @legacy
14
- * @alpha
13
+ * @legacy @beta
15
14
  */
16
15
  export interface IProposal {
17
16
  /**
@@ -25,24 +24,21 @@ export interface IProposal {
25
24
  }
26
25
  /**
27
26
  * Similar to {@link IProposal} except it also includes the sequence number when it was made.
28
- * @legacy
29
- * @alpha
27
+ * @legacy @beta
30
28
  */
31
29
  export type ISequencedProposal = {
32
30
  sequenceNumber: number;
33
31
  } & IProposal;
34
32
  /**
35
33
  * Adds the sequence number at which the message was approved to an {@link ISequencedProposal}.
36
- * @legacy
37
- * @alpha
34
+ * @legacy @beta
38
35
  */
39
36
  export type IApprovedProposal = {
40
37
  approvalSequenceNumber: number;
41
38
  } & ISequencedProposal;
42
39
  /**
43
40
  * Adds the sequence number at which the message was committed to an {@link IApprovedProposal}.
44
- * @legacy
45
- * @alpha
41
+ * @legacy @beta
46
42
  */
47
43
  export type ICommittedProposal = {
48
44
  commitSequenceNumber: number;
@@ -62,8 +58,7 @@ export interface IQuorumClients {
62
58
  }
63
59
  /**
64
60
  * Interface for tracking proposals in the Quorum.
65
- * @legacy
66
- * @alpha
61
+ * @legacy @beta
67
62
  */
68
63
  export interface IQuorumProposals {
69
64
  propose(key: string, value: unknown): Promise<void>;
@@ -77,8 +72,7 @@ export interface IQuorumProposals {
77
72
  }
78
73
  /**
79
74
  * Interface combining tracking of clients as well as proposals in the Quorum.
80
- * @legacy
81
- * @alpha
75
+ * @legacy @beta
82
76
  */
83
77
  export interface IQuorum extends Omit<IQuorumClients, "on" | "once" | "off">, Omit<IQuorumProposals, "on" | "once" | "off"> {
84
78
  on: IQuorumClients["on"] & IQuorumProposals["on"];
@@ -96,8 +90,7 @@ export interface IProtocolState {
96
90
  values: [string, ICommittedProposal][];
97
91
  }
98
92
  /**
99
- * @legacy
100
- * @alpha
93
+ * @legacy @beta
101
94
  */
102
95
  export interface IProcessMessageResult {
103
96
  immediateNoOp?: boolean;
@@ -1 +1 @@
1
- {"version":3,"file":"consensus.d.ts","sourceRoot":"","sources":["../../src/protocol/consensus.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAErD;;;;;;;;;GASG;AACH,MAAM,WAAW,SAAS;IACzB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAAE,cAAc,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC;AAExE;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAAE,sBAAsB,EAAE,MAAM,CAAA;CAAE,GAAG,kBAAkB,CAAC;AAExF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAAE,oBAAoB,EAAE,MAAM,CAAA;CAAE,GAAG,iBAAiB,CAAC;AAEtF;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC5C,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAAC;IAC1D,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,KAAK,IAAI,OAAE;IACxF,EAAE,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;IAEhE,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,OAAE;IACrD,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;IAC3B,GAAG,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAE1B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAE1B,EAAE,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,OAAE;IAC3E,EAAE,CACD,KAAK,EAAE,iBAAiB,EACxB,QAAQ,EAAE,CACT,cAAc,EAAE,MAAM,EACtB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,sBAAsB,EAAE,MAAM,KAC1B,IAAI,OACR;IAEF,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC3D,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC7B,GAAG,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,OAChB,SAAQ,IAAI,CAAC,cAAc,EAAE,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC,EAClD,IAAI,CAAC,gBAAgB,EAAE,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC;IAC9C,EAAE,EAAE,cAAc,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAClD,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACpB,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,cAAc,EAAE,MAAM,CAAC;IACvB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,OAAO,EAAE,CAAC,MAAM,EAAE,gBAAgB,CAAC,EAAE,CAAC;IACtC,SAAS,EAAE,CAAC,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACpD,MAAM,EAAE,CAAC,MAAM,EAAE,kBAAkB,CAAC,EAAE,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACrC,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB"}
1
+ {"version":3,"file":"consensus.d.ts","sourceRoot":"","sources":["../../src/protocol/consensus.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAErD;;;;;;;;GAQG;AACH,MAAM,WAAW,SAAS;IACzB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAAE,cAAc,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC;AAExE;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAAE,sBAAsB,EAAE,MAAM,CAAA;CAAE,GAAG,kBAAkB,CAAC;AAExF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAAE,oBAAoB,EAAE,MAAM,CAAA;CAAE,GAAG,iBAAiB,CAAC;AAEtF;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC5C,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAAC;IAC1D,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,KAAK,IAAI,OAAE;IACxF,EAAE,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;IAEhE,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,OAAE;IACrD,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;IAC3B,GAAG,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAE1B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAE1B,EAAE,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,OAAE;IAC3E,EAAE,CACD,KAAK,EAAE,iBAAiB,EACxB,QAAQ,EAAE,CACT,cAAc,EAAE,MAAM,EACtB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,sBAAsB,EAAE,MAAM,KAC1B,IAAI,OACR;IAEF,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC3D,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC7B,GAAG,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,OAChB,SAAQ,IAAI,CAAC,cAAc,EAAE,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC,EAClD,IAAI,CAAC,gBAAgB,EAAE,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC;IAC9C,EAAE,EAAE,cAAc,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAClD,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACpB,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,cAAc,EAAE,MAAM,CAAC;IACvB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,OAAO,EAAE,CAAC,MAAM,EAAE,gBAAgB,CAAC,EAAE,CAAC;IACtC,SAAS,EAAE,CAAC,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACpD,MAAM,EAAE,CAAC,MAAM,EAAE,kBAAkB,CAAC,EAAE,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB"}
@@ -1 +1 @@
1
- {"version":3,"file":"consensus.js","sourceRoot":"","sources":["../../src/protocol/consensus.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ISequencedClient } from \"./clients.js\";\n\n/**\n * Proposal to set the given key/value pair.\n *\n * @remarks\n * Consensus on the proposal is achieved if the MSN is \\>= the sequence number\n * at which the proposal is made and no client within the collaboration window rejects\n * the proposal.\n * @legacy\n * @alpha\n */\nexport interface IProposal {\n\t/**\n\t * The key for the proposal.\n\t */\n\tkey: string;\n\n\t/**\n\t * The value of the proposal.\n\t */\n\tvalue: unknown;\n}\n\n/**\n * Similar to {@link IProposal} except it also includes the sequence number when it was made.\n * @legacy\n * @alpha\n */\nexport type ISequencedProposal = { sequenceNumber: number } & IProposal;\n\n/**\n * Adds the sequence number at which the message was approved to an {@link ISequencedProposal}.\n * @legacy\n * @alpha\n */\nexport type IApprovedProposal = { approvalSequenceNumber: number } & ISequencedProposal;\n\n/**\n * Adds the sequence number at which the message was committed to an {@link IApprovedProposal}.\n * @legacy\n * @alpha\n */\nexport type ICommittedProposal = { commitSequenceNumber: number } & IApprovedProposal;\n\n/**\n * Interface for tracking clients in the Quorum.\n * @public\n */\nexport interface IQuorumClients {\n\tgetMembers(): Map<string, ISequencedClient>;\n\tgetMember(clientId: string): ISequencedClient | undefined;\n\ton(event: \"addMember\", listener: (clientId: string, details: ISequencedClient) => void);\n\ton(event: \"removeMember\", listener: (clientId: string) => void);\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\ton(event: \"error\", listener: (message: any) => void);\n\tonce: IQuorumClients[\"on\"];\n\toff: IQuorumClients[\"on\"];\n}\n\n/**\n * Interface for tracking proposals in the Quorum.\n * @legacy\n * @alpha\n */\nexport interface IQuorumProposals {\n\tpropose(key: string, value: unknown): Promise<void>;\n\n\thas(key: string): boolean;\n\n\tget(key: string): unknown;\n\n\ton(event: \"addProposal\", listener: (proposal: ISequencedProposal) => void);\n\ton(\n\t\tevent: \"approveProposal\",\n\t\tlistener: (\n\t\t\tsequenceNumber: number,\n\t\t\tkey: string,\n\t\t\tvalue: unknown,\n\t\t\tapprovalSequenceNumber: number,\n\t\t) => void,\n\t);\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\ton(event: \"error\", listener: (message: any) => void): void;\n\tonce: IQuorumProposals[\"on\"];\n\toff: IQuorumProposals[\"on\"];\n}\n\n/**\n * Interface combining tracking of clients as well as proposals in the Quorum.\n * @legacy\n * @alpha\n */\nexport interface IQuorum\n\textends Omit<IQuorumClients, \"on\" | \"once\" | \"off\">,\n\t\tOmit<IQuorumProposals, \"on\" | \"once\" | \"off\"> {\n\ton: IQuorumClients[\"on\"] & IQuorumProposals[\"on\"];\n\tonce: IQuorum[\"on\"];\n\toff: IQuorum[\"on\"];\n}\n\n/**\n * @internal\n */\nexport interface IProtocolState {\n\tsequenceNumber: number;\n\tminimumSequenceNumber: number;\n\tmembers: [string, ISequencedClient][];\n\tproposals: [number, ISequencedProposal, string[]][];\n\tvalues: [string, ICommittedProposal][];\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IProcessMessageResult {\n\timmediateNoOp?: boolean;\n}\n"]}
1
+ {"version":3,"file":"consensus.js","sourceRoot":"","sources":["../../src/protocol/consensus.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ISequencedClient } from \"./clients.js\";\n\n/**\n * Proposal to set the given key/value pair.\n *\n * @remarks\n * Consensus on the proposal is achieved if the MSN is \\>= the sequence number\n * at which the proposal is made and no client within the collaboration window rejects\n * the proposal.\n * @legacy @beta\n */\nexport interface IProposal {\n\t/**\n\t * The key for the proposal.\n\t */\n\tkey: string;\n\n\t/**\n\t * The value of the proposal.\n\t */\n\tvalue: unknown;\n}\n\n/**\n * Similar to {@link IProposal} except it also includes the sequence number when it was made.\n * @legacy @beta\n */\nexport type ISequencedProposal = { sequenceNumber: number } & IProposal;\n\n/**\n * Adds the sequence number at which the message was approved to an {@link ISequencedProposal}.\n * @legacy @beta\n */\nexport type IApprovedProposal = { approvalSequenceNumber: number } & ISequencedProposal;\n\n/**\n * Adds the sequence number at which the message was committed to an {@link IApprovedProposal}.\n * @legacy @beta\n */\nexport type ICommittedProposal = { commitSequenceNumber: number } & IApprovedProposal;\n\n/**\n * Interface for tracking clients in the Quorum.\n * @public\n */\nexport interface IQuorumClients {\n\tgetMembers(): Map<string, ISequencedClient>;\n\tgetMember(clientId: string): ISequencedClient | undefined;\n\ton(event: \"addMember\", listener: (clientId: string, details: ISequencedClient) => void);\n\ton(event: \"removeMember\", listener: (clientId: string) => void);\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\ton(event: \"error\", listener: (message: any) => void);\n\tonce: IQuorumClients[\"on\"];\n\toff: IQuorumClients[\"on\"];\n}\n\n/**\n * Interface for tracking proposals in the Quorum.\n * @legacy @beta\n */\nexport interface IQuorumProposals {\n\tpropose(key: string, value: unknown): Promise<void>;\n\n\thas(key: string): boolean;\n\n\tget(key: string): unknown;\n\n\ton(event: \"addProposal\", listener: (proposal: ISequencedProposal) => void);\n\ton(\n\t\tevent: \"approveProposal\",\n\t\tlistener: (\n\t\t\tsequenceNumber: number,\n\t\t\tkey: string,\n\t\t\tvalue: unknown,\n\t\t\tapprovalSequenceNumber: number,\n\t\t) => void,\n\t);\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\ton(event: \"error\", listener: (message: any) => void): void;\n\tonce: IQuorumProposals[\"on\"];\n\toff: IQuorumProposals[\"on\"];\n}\n\n/**\n * Interface combining tracking of clients as well as proposals in the Quorum.\n * @legacy @beta\n */\nexport interface IQuorum\n\textends Omit<IQuorumClients, \"on\" | \"once\" | \"off\">,\n\t\tOmit<IQuorumProposals, \"on\" | \"once\" | \"off\"> {\n\ton: IQuorumClients[\"on\"] & IQuorumProposals[\"on\"];\n\tonce: IQuorum[\"on\"];\n\toff: IQuorum[\"on\"];\n}\n\n/**\n * @internal\n */\nexport interface IProtocolState {\n\tsequenceNumber: number;\n\tminimumSequenceNumber: number;\n\tmembers: [string, ISequencedClient][];\n\tproposals: [number, ISequencedProposal, string[]][];\n\tvalues: [string, ICommittedProposal][];\n}\n\n/**\n * @legacy @beta\n */\nexport interface IProcessMessageResult {\n\timmediateNoOp?: boolean;\n}\n"]}
@@ -4,8 +4,7 @@
4
4
  */
5
5
  /**
6
6
  * {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601 format} date: `YYYY-MM-DDTHH:MM:SSZ`.
7
- * @legacy
8
- * @alpha
7
+ * @legacy @beta
9
8
  */
10
9
  export type IsoDate = string;
11
10
  //# sourceMappingURL=date.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../../src/protocol/date.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC"}
1
+ {"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../../src/protocol/date.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"date.js","sourceRoot":"","sources":["../../src/protocol/date.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/**\n * {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601 format} date: `YYYY-MM-DDTHH:MM:SSZ`.\n * @legacy\n * @alpha\n */\nexport type IsoDate = string;\n"]}
1
+ {"version":3,"file":"date.js","sourceRoot":"","sources":["../../src/protocol/date.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/**\n * {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601 format} date: `YYYY-MM-DDTHH:MM:SSZ`.\n * @legacy @beta\n */\nexport type IsoDate = string;\n"]}
@@ -4,8 +4,7 @@
4
4
  */
5
5
  import type { TypedMessage } from "@fluidframework/core-interfaces/internal";
6
6
  /**
7
- * @legacy
8
- * @alpha
7
+ * @legacy @beta
9
8
  */
10
9
  export declare enum MessageType {
11
10
  /**
@@ -79,8 +78,7 @@ export declare enum SignalType {
79
78
  }
80
79
  /**
81
80
  * Messages to track latency trace.
82
- * @legacy
83
- * @alpha
81
+ * @legacy @beta
84
82
  */
85
83
  export interface ITrace {
86
84
  /**
@@ -97,8 +95,7 @@ export interface ITrace {
97
95
  timestamp: number;
98
96
  }
99
97
  /**
100
- * @legacy
101
- * @alpha
98
+ * @legacy @beta
102
99
  */
103
100
  export interface INack {
104
101
  /**
@@ -116,8 +113,7 @@ export interface INack {
116
113
  }
117
114
  /**
118
115
  * Document-specific message.
119
- * @legacy
120
- * @alpha
116
+ * @legacy @beta
121
117
  */
122
118
  export interface IDocumentMessage {
123
119
  /**
@@ -163,8 +159,7 @@ export interface IDocumentSystemMessage extends IDocumentMessage {
163
159
  }
164
160
  /**
165
161
  * Branch origin information.
166
- * @legacy
167
- * @alpha
162
+ * @legacy @beta
168
163
  */
169
164
  export interface IBranchOrigin {
170
165
  /**
@@ -182,8 +177,7 @@ export interface IBranchOrigin {
182
177
  }
183
178
  /**
184
179
  * Sequenced message for a distributed document.
185
- * @legacy
186
- * @alpha
180
+ * @legacy @beta
187
181
  */
188
182
  export interface ISequencedDocumentMessage {
189
183
  /**
@@ -282,8 +276,7 @@ export interface ISequencedDocumentAugmentedMessage extends ISequencedDocumentMe
282
276
  }
283
277
  /**
284
278
  * Common interface between incoming and outgoing signals.
285
- * @legacy
286
- * @alpha
279
+ * @legacy @beta
287
280
  */
288
281
  export interface ISignalMessageBase<TMessage extends TypedMessage = TypedMessage> {
289
282
  /**
@@ -310,8 +303,7 @@ export interface ISignalMessageBase<TMessage extends TypedMessage = TypedMessage
310
303
  }
311
304
  /**
312
305
  * Interface for signals sent by the server to clients.
313
- * @legacy
314
- * @alpha
306
+ * @legacy @beta
315
307
  */
316
308
  export interface ISignalMessage<TMessage extends TypedMessage = TypedMessage> extends ISignalMessageBase<TMessage> {
317
309
  /**
@@ -326,8 +318,7 @@ export interface ISignalMessage<TMessage extends TypedMessage = TypedMessage> ex
326
318
  */
327
319
  export type ISentSignalMessage<TMessage extends TypedMessage = TypedMessage> = ISignalMessageBase<TMessage>;
328
320
  /**
329
- * @legacy
330
- * @alpha
321
+ * @legacy @beta
331
322
  */
332
323
  export interface IUploadedSummaryDetails {
333
324
  /**
@@ -336,8 +327,7 @@ export interface IUploadedSummaryDetails {
336
327
  includesProtocolTree?: boolean;
337
328
  }
338
329
  /**
339
- * @legacy
340
- * @alpha
330
+ * @legacy @beta
341
331
  */
342
332
  export interface ISummaryContent {
343
333
  /**
@@ -374,8 +364,7 @@ export interface IServerError {
374
364
  }
375
365
  /**
376
366
  * Data about the original proposed summary message.
377
- * @legacy
378
- * @alpha
367
+ * @legacy @beta
379
368
  */
380
369
  export interface ISummaryProposal {
381
370
  /**
@@ -385,8 +374,7 @@ export interface ISummaryProposal {
385
374
  }
386
375
  /**
387
376
  * Contents of summary ack expected from the server.
388
- * @legacy
389
- * @alpha
377
+ * @legacy @beta
390
378
  */
391
379
  export interface ISummaryAck {
392
380
  /**
@@ -400,8 +388,7 @@ export interface ISummaryAck {
400
388
  }
401
389
  /**
402
390
  * Contents of summary nack expected from the server.
403
- * @legacy
404
- * @alpha
391
+ * @legacy @beta
405
392
  */
406
393
  export interface ISummaryNack {
407
394
  /**
@@ -427,8 +414,7 @@ export interface ISummaryNack {
427
414
  }
428
415
  /**
429
416
  * Interface for nack content.
430
- * @legacy
431
- * @alpha
417
+ * @legacy @beta
432
418
  */
433
419
  export interface INackContent {
434
420
  /**
@@ -454,8 +440,7 @@ export interface INackContent {
454
440
  }
455
441
  /**
456
442
  * Type of the nack.
457
- * @legacy
458
- * @alpha
443
+ * @legacy @beta
459
444
  */
460
445
  export declare enum NackErrorType {
461
446
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../../src/protocol/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AAE7E;;;GAGG;AACH,oBAAY,WAAW;IACtB;;;;;OAKG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,UAAU,SAAS;IAEnB;;OAEG;IACH,WAAW,UAAU;IAErB;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,UAAU,eAAe;IAEzB;;OAEG;IACH,WAAW,gBAAgB;IAE3B;;OAEG;IACH,SAAS,OAAO;IAEhB;;OAEG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,SAAS,iBAAiB;IAE1B;;OAEG;IACH,OAAO,YAAY;CACnB;AAED;;GAEG;AACH,oBAAY,UAAU;IACrB;;OAEG;IACH,UAAU,SAAS;IAEnB;;OAEG;IACH,WAAW,UAAU;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,MAAM;IACtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB;;OAEG;IACH,SAAS,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAExC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC/D,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACzC;;;OAGG;IAEH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAAG,IAAI,CACvD,yBAAyB,EACzB,UAAU,GAAG,aAAa,CAC1B,GAAG;IACH;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,yBAAyB;IACjF,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,kCAAmC,SAAQ,yBAAyB;IACpF,iBAAiB,EAAE,MAAM,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY;IAC/E;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,CAC3E,SAAQ,kBAAkB,CAAC,QAAQ,CAAC;IACpC;;;OAGG;IAEH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,IAC1E,kBAAkB,CAAC,QAAQ,CAAC,CAAC;AAE9B;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACvC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,uBAAuB,CAAC;CAIlC;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,EAAE,gBAAgB,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,eAAe,EAAE,gBAAgB,CAAC;IAElC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC5B;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,oBAAY,aAAa;IACxB;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,iBAAiB,sBAAsB;IAEvC;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,kBAAkB,uBAAuB;CACzC"}
1
+ {"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../../src/protocol/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AAE7E;;GAEG;AACH,oBAAY,WAAW;IACtB;;;;;OAKG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,UAAU,SAAS;IAEnB;;OAEG;IACH,WAAW,UAAU;IAErB;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,UAAU,eAAe;IAEzB;;OAEG;IACH,WAAW,gBAAgB;IAE3B;;OAEG;IACH,SAAS,OAAO;IAEhB;;OAEG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,SAAS,iBAAiB;IAE1B;;OAEG;IACH,OAAO,YAAY;CACnB;AAED;;GAEG;AACH,oBAAY,UAAU;IACrB;;OAEG;IACH,UAAU,SAAS;IAEnB;;OAEG;IACH,WAAW,UAAU;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACrB;;OAEG;IACH,SAAS,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAExC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC/D,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACzC;;;OAGG;IAEH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAAG,IAAI,CACvD,yBAAyB,EACzB,UAAU,GAAG,aAAa,CAC1B,GAAG;IACH;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,yBAAyB;IACjF,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,kCAAmC,SAAQ,yBAAyB;IACpF,iBAAiB,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY;IAC/E;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,CAC3E,SAAQ,kBAAkB,CAAC,QAAQ,CAAC;IACpC;;;OAGG;IAEH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,IAC1E,kBAAkB,CAAC,QAAQ,CAAC,CAAC;AAE9B;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,uBAAuB,CAAC;CAIlC;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,EAAE,gBAAgB,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,eAAe,EAAE,gBAAgB,CAAC;IAElC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC5B;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,oBAAY,aAAa;IACxB;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,iBAAiB,sBAAsB;IAEvC;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,kBAAkB,uBAAuB;CACzC"}
@@ -6,8 +6,7 @@
6
6
  Object.defineProperty(exports, "__esModule", { value: true });
7
7
  exports.NackErrorType = exports.SignalType = exports.MessageType = void 0;
8
8
  /**
9
- * @legacy
10
- * @alpha
9
+ * @legacy @beta
11
10
  */
12
11
  var MessageType;
13
12
  (function (MessageType) {
@@ -83,8 +82,7 @@ var SignalType;
83
82
  })(SignalType || (exports.SignalType = SignalType = {}));
84
83
  /**
85
84
  * Type of the nack.
86
- * @legacy
87
- * @alpha
85
+ * @legacy @beta
88
86
  */
89
87
  var NackErrorType;
90
88
  (function (NackErrorType) {
@@ -1 +1 @@
1
- {"version":3,"file":"protocol.js","sourceRoot":"","sources":["../../src/protocol/protocol.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;;GAGG;AACH,IAAY,WAoEX;AApED,WAAY,WAAW;IACtB;;;;;OAKG;IACH,4BAAa,CAAA;IAEb;;OAEG;IACH,kCAAmB,CAAA;IAEnB;;OAEG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,kCAAmB,CAAA;IAEnB;;OAEG;IACH,gCAAiB,CAAA;IAEjB;;OAEG;IACH,gCAAiB,CAAA;IAEjB;;OAEG;IACH,sCAAuB,CAAA;IAEvB;;OAEG;IACH,wCAAyB,CAAA;IAEzB;;OAEG;IACH,0CAA2B,CAAA;IAE3B;;OAEG;IACH,+BAAgB,CAAA;IAEhB;;OAEG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,yCAA0B,CAAA;IAE1B;;OAEG;IACH,kCAAmB,CAAA;AACpB,CAAC,EApEW,WAAW,2BAAX,WAAW,QAoEtB;AAED;;GAEG;AACH,IAAY,UAUX;AAVD,WAAY,UAAU;IACrB;;OAEG;IACH,iCAAmB,CAAA;IAEnB;;OAEG;IACH,mCAAqB,CAAA;AACtB,CAAC,EAVW,UAAU,0BAAV,UAAU,QAUrB;AAicD;;;;GAIG;AACH,IAAY,aAoBX;AApBD,WAAY,aAAa;IACxB;;OAEG;IACH,oDAAmC,CAAA;IAEnC;;OAEG;IACH,wDAAuC,CAAA;IAEvC;;OAEG;IACH,oDAAmC,CAAA;IAEnC;;OAEG;IACH,0DAAyC,CAAA;AAC1C,CAAC,EApBW,aAAa,6BAAb,aAAa,QAoBxB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { TypedMessage } from \"@fluidframework/core-interfaces/internal\";\n\n/**\n * @legacy\n * @alpha\n */\nexport enum MessageType {\n\t/**\n\t * Empty operation message. Used to send an updated reference sequence number.\n\t * Relay service is free to coalesce these messages or fully drop them, if\n\t * another message was used to update MSN to a number equal or higher than referenced\n\t * sequence number in Noop.\n\t */\n\tNoOp = \"noop\",\n\n\t/**\n\t * System message sent to indicate a new client has joined the collaboration.\n\t */\n\tClientJoin = \"join\",\n\n\t/**\n\t * System message sent to indicate a client has left the collaboration.\n\t */\n\tClientLeave = \"leave\",\n\n\t/**\n\t * Proposes a new consensus value.\n\t */\n\tPropose = \"propose\",\n\n\t/**\n\t * Message used to reject a pending proposal.\n\t */\n\tReject = \"reject\",\n\n\t/**\n\t * Message sent by client accepting proposal\n\t */\n\tAccept = \"accept\",\n\n\t/**\n\t * Summary operation (message).\n\t */\n\tSummarize = \"summarize\",\n\n\t/**\n\t * Summary operation (message) written.\n\t */\n\tSummaryAck = \"summaryAck\",\n\n\t/**\n\t * Summary operation (message) write failure.\n\t */\n\tSummaryNack = \"summaryNack\",\n\n\t/**\n\t * Operation (message) produced by container runtime.\n\t */\n\tOperation = \"op\",\n\n\t/**\n\t * Message to indicate that no active clients are present.\n\t */\n\tNoClient = \"noClient\",\n\n\t/**\n\t * Message to indicate successful round trip.\n\t */\n\tRoundTrip = \"tripComplete\",\n\n\t/**\n\t * Service specific control messages that are never sequenced.\n\t */\n\tControl = \"control\",\n}\n\n/**\n * @internal\n */\nexport enum SignalType {\n\t/**\n\t * System signal sent to indicate a new client has joined the collaboration.\n\t */\n\tClientJoin = \"join\",\n\n\t/**\n\t * System signal sent to indicate a client has left the collaboration.\n\t */\n\tClientLeave = \"leave\",\n}\n\n/**\n * Messages to track latency trace.\n * @legacy\n * @alpha\n */\nexport interface ITrace {\n\t/**\n\t * Service generating the trace.\n\t */\n\tservice: string;\n\n\t/**\n\t * Denotes receiving/sending.\n\t */\n\taction: string;\n\n\t/**\n\t * Floating point time in milliseconds with up to nanosecond precision.\n\t */\n\ttimestamp: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface INack {\n\t/**\n\t * The operation that was just nacked.\n\t */\n\toperation: IDocumentMessage | undefined;\n\n\t/**\n\t * The sequence number the client needs to catch up to before retrying.\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * Detail info about the nack.\n\t */\n\tcontent: INackContent;\n}\n\n/**\n * Document-specific message.\n * @legacy\n * @alpha\n */\nexport interface IDocumentMessage {\n\t/**\n\t * The document's client sequence number.\n\t */\n\tclientSequenceNumber: number;\n\n\t/**\n\t * The reference sequence number the message was sent relative to.\n\t */\n\treferenceSequenceNumber: number;\n\n\t/**\n\t * The type of document message being sent.\n\t */\n\ttype: string;\n\n\t/**\n\t * The contents of the message.\n\t */\n\tcontents: unknown;\n\n\t/**\n\t * App provided metadata about the operation.\n\t */\n\tmetadata?: unknown;\n\n\t/**\n\t * Server provided metadata about the operation.\n\t */\n\tserverMetadata?: unknown;\n\n\t/**\n\t * Traces related to the packet.\n\t */\n\ttraces?: ITrace[];\n\n\t/**\n\t * The compression algorithm that was used to compress contents of this message.\n\t * @experimental Not ready for use\n\t */\n\tcompression?: string;\n}\n\n/**\n * Document Message with optional system level data field.\n * @internal\n */\nexport interface IDocumentSystemMessage extends IDocumentMessage {\n\tdata: string;\n}\n\n/**\n * Branch origin information.\n * @legacy\n * @alpha\n */\nexport interface IBranchOrigin {\n\t/**\n\t * Origin branch of the message.\n\t */\n\tid: string;\n\n\t/**\n\t * Sequence number for the message in branch ID.\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * Minimum sequence number for the message in branch ID.\n\t */\n\tminimumSequenceNumber: number;\n}\n\n/**\n * Sequenced message for a distributed document.\n * @legacy\n * @alpha\n */\nexport interface ISequencedDocumentMessage {\n\t/**\n\t * The client ID that submitted the message.\n\t * For server generated messages the clientId will be null;\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tclientId: string | null;\n\n\t/**\n\t * The sequenced identifier.\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * The minimum sequence number for all connected clients.\n\t */\n\tminimumSequenceNumber: number;\n\n\t/**\n\t * The document's client sequence number.\n\t */\n\tclientSequenceNumber: number;\n\n\t/**\n\t * The reference sequence number the message was sent relative to.\n\t */\n\treferenceSequenceNumber: number;\n\n\t/**\n\t * The type of operation.\n\t */\n\ttype: string;\n\n\t/**\n\t * The contents of the message.\n\t */\n\tcontents: unknown;\n\n\t/**\n\t * App provided metadata about the operation.\n\t */\n\tmetadata?: unknown;\n\n\t/**\n\t * Server provided metadata about the operation.\n\t */\n\tserverMetadata?: unknown;\n\n\t/**\n\t * Origin branch information for the message.\n\t *\n\t * @remarks Can be marked undefined if the current message is also the origin.\n\t */\n\torigin?: IBranchOrigin;\n\n\t/**\n\t * Traces related to the packet.\n\t */\n\ttraces?: ITrace[];\n\n\t/**\n\t * Timestamp when the server ticketed the message.\n\t */\n\ttimestamp: number;\n\n\t/**\n\t * Data provided by service. Only present in service generated messages.\n\t */\n\tdata?: string;\n\n\t/**\n\t * Experimental field for storing the rolling hash at sequence number.\n\t *\n\t * @deprecated Use ISequencedDocumentMessageExperimental instead.\n\t */\n\texpHash1?: string;\n\n\t/**\n\t * The compression algorithm that was used to compress contents of this message.\n\t *\n\t * @deprecated Use ISequencedDocumentMessageExperimental instead.\n\t */\n\tcompression?: string;\n}\n\n/**\n * {@link ISequencedDocumentAugmentedMessage} with experimental properties.\n * @internal\n */\nexport type ISequencedDocumentMessageExperimental = Omit<\n\tISequencedDocumentMessage,\n\t\"expHash1\" | \"compression\"\n> & {\n\t/**\n\t * Stores the rolling hash at sequence number.\n\t */\n\texpHash1?: string;\n\n\t/**\n\t * The compression algorithm that was used to compress contents of this message.\n\t */\n\tcompression?: string;\n};\n\n/**\n * @internal\n */\nexport interface ISequencedDocumentSystemMessage extends ISequencedDocumentMessage {\n\tdata: string;\n}\n\n/**\n * @internal\n */\nexport interface ISequencedDocumentAugmentedMessage extends ISequencedDocumentMessage {\n\tadditionalContent: string;\n}\n\n/**\n * Common interface between incoming and outgoing signals.\n * @legacy\n * @alpha\n */\nexport interface ISignalMessageBase<TMessage extends TypedMessage = TypedMessage> {\n\t/**\n\t * Signal content\n\t */\n\tcontent: TMessage[\"content\"];\n\n\t/**\n\t * Signal type\n\t */\n\ttype?: TMessage[\"type\"];\n\n\t/**\n\t * Counts the number of signals sent by the sending client.\n\t */\n\tclientConnectionNumber?: number;\n\n\t/**\n\t * Sequence number that indicates when the signal was created in relation to the delta stream\n\t */\n\treferenceSequenceNumber?: number;\n\n\t/**\n\t * Client ID of the singular client the signal is being (or has been) sent to.\n\t * May only be specified when IConnect.supportedFeatures['submit_signals_v2'] is true, will throw otherwise.\n\t */\n\ttargetClientId?: string;\n}\n\n/**\n * Interface for signals sent by the server to clients.\n * @legacy\n * @alpha\n */\nexport interface ISignalMessage<TMessage extends TypedMessage = TypedMessage>\n\textends ISignalMessageBase<TMessage> {\n\t/**\n\t * The client ID that submitted the message.\n\t * For server generated messages the clientId will be null.\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tclientId: string | null;\n}\n\n/**\n * Interface for signals sent by clients to the server.\n * @internal\n */\nexport type ISentSignalMessage<TMessage extends TypedMessage = TypedMessage> =\n\tISignalMessageBase<TMessage>;\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IUploadedSummaryDetails {\n\t/**\n\t * Indicates whether the uploaded summary contains \".protocol\" tree.\n\t */\n\tincludesProtocolTree?: boolean;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface ISummaryContent {\n\t/**\n\t * Handle reference to the summary data.\n\t */\n\thandle: string;\n\n\t/**\n\t * Message included as part of the summary.\n\t */\n\tmessage: string;\n\n\t/**\n\t * Handles to parent summaries of the proposed new summary.\n\t */\n\tparents: string[];\n\n\t/**\n\t * Handle to the current latest summary stored by the service\n\t */\n\thead: string;\n\n\t/**\n\t * Details of the uploaded summary.\n\t */\n\tdetails?: IUploadedSummaryDetails;\n\n\t// TODO - need an epoch/reload bit to indicate to clients that the summary has changed and requires a reload\n\t// This could be encoded in the summary itself as well but then would require the client to download it to check\n}\n\n/**\n * General errors returned from the server.\n * May want to add error code or something similar in the future.\n * @internal\n */\nexport interface IServerError {\n\t/**\n\t * Message describing the server error.\n\t */\n\terrorMessage: string;\n}\n\n/**\n * Data about the original proposed summary message.\n * @legacy\n * @alpha\n */\nexport interface ISummaryProposal {\n\t/**\n\t * Actual sequence number of the summary message proposal.\n\t */\n\tsummarySequenceNumber: number;\n}\n\n/**\n * Contents of summary ack expected from the server.\n * @legacy\n * @alpha\n */\nexport interface ISummaryAck {\n\t/**\n\t * Handle of the complete summary.\n\t */\n\thandle: string;\n\n\t/**\n\t * Information about the proposed summary message.\n\t */\n\tsummaryProposal: ISummaryProposal;\n}\n\n/**\n * Contents of summary nack expected from the server.\n * @legacy\n * @alpha\n */\nexport interface ISummaryNack {\n\t/**\n\t * Information about the proposed summary message.\n\t */\n\tsummaryProposal: ISummaryProposal;\n\n\t/**\n\t * An error code number that represents the error. It will be a valid HTTP error code.\n\t * 403 errors are non retriable.\n\t * 400 errors are always immediately retriable.\n\t * 429 errors are retriable or non retriable (depends on type field).\n\t */\n\tcode?: number;\n\n\t/**\n\t * A message about the error for debugging/logging/telemetry purposes\n\t */\n\tmessage?: string;\n\n\t/**\n\t * Optional Retry-After time in seconds.\n\t * If specified, the client should wait this many seconds before retrying.8\n\t */\n\tretryAfter?: number;\n}\n\n/**\n * Interface for nack content.\n * @legacy\n * @alpha\n */\nexport interface INackContent {\n\t/**\n\t * An error code number that represents the error. It will be a valid HTTP error code.\n\t * 403 errors are non retriable and client should acquire a new identity before reconnection.\n\t * 400 errors are always immediately retriable\n\t * 429 errors are retriable or non retriable (depends on type field).\n\t */\n\tcode: number;\n\n\t/**\n\t * Type of the Nack.\n\t */\n\ttype: NackErrorType;\n\n\t/**\n\t * A message about the nack for debugging/logging/telemetry purposes\n\t */\n\tmessage: string;\n\n\t/**\n\t * Optional Retry-After time in seconds\n\t * If specified, the client should wait this many seconds before retrying\n\t */\n\tretryAfter?: number;\n}\n\n/**\n * Type of the nack.\n * @legacy\n * @alpha\n */\nexport enum NackErrorType {\n\t/**\n\t * Retriable after {@link ISummaryNack.retryAfter} seconds.\n\t */\n\tThrottlingError = \"ThrottlingError\",\n\n\t/**\n\t * Client's token is not valid for the intended message.\n\t */\n\tInvalidScopeError = \"InvalidScopeError\",\n\n\t/**\n\t * Clients message is invalid and should retry immediately with a valid message.\n\t */\n\tBadRequestError = \"BadRequestError\",\n\n\t/**\n\t * Service is having issues. Client should not retry.\n\t */\n\tLimitExceededError = \"LimitExceededError\",\n}\n"]}
1
+ {"version":3,"file":"protocol.js","sourceRoot":"","sources":["../../src/protocol/protocol.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACH,IAAY,WAoEX;AApED,WAAY,WAAW;IACtB;;;;;OAKG;IACH,4BAAa,CAAA;IAEb;;OAEG;IACH,kCAAmB,CAAA;IAEnB;;OAEG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,kCAAmB,CAAA;IAEnB;;OAEG;IACH,gCAAiB,CAAA;IAEjB;;OAEG;IACH,gCAAiB,CAAA;IAEjB;;OAEG;IACH,sCAAuB,CAAA;IAEvB;;OAEG;IACH,wCAAyB,CAAA;IAEzB;;OAEG;IACH,0CAA2B,CAAA;IAE3B;;OAEG;IACH,+BAAgB,CAAA;IAEhB;;OAEG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,yCAA0B,CAAA;IAE1B;;OAEG;IACH,kCAAmB,CAAA;AACpB,CAAC,EApEW,WAAW,2BAAX,WAAW,QAoEtB;AAED;;GAEG;AACH,IAAY,UAUX;AAVD,WAAY,UAAU;IACrB;;OAEG;IACH,iCAAmB,CAAA;IAEnB;;OAEG;IACH,mCAAqB,CAAA;AACtB,CAAC,EAVW,UAAU,0BAAV,UAAU,QAUrB;AAobD;;;GAGG;AACH,IAAY,aAoBX;AApBD,WAAY,aAAa;IACxB;;OAEG;IACH,oDAAmC,CAAA;IAEnC;;OAEG;IACH,wDAAuC,CAAA;IAEvC;;OAEG;IACH,oDAAmC,CAAA;IAEnC;;OAEG;IACH,0DAAyC,CAAA;AAC1C,CAAC,EApBW,aAAa,6BAAb,aAAa,QAoBxB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { TypedMessage } from \"@fluidframework/core-interfaces/internal\";\n\n/**\n * @legacy @beta\n */\nexport enum MessageType {\n\t/**\n\t * Empty operation message. Used to send an updated reference sequence number.\n\t * Relay service is free to coalesce these messages or fully drop them, if\n\t * another message was used to update MSN to a number equal or higher than referenced\n\t * sequence number in Noop.\n\t */\n\tNoOp = \"noop\",\n\n\t/**\n\t * System message sent to indicate a new client has joined the collaboration.\n\t */\n\tClientJoin = \"join\",\n\n\t/**\n\t * System message sent to indicate a client has left the collaboration.\n\t */\n\tClientLeave = \"leave\",\n\n\t/**\n\t * Proposes a new consensus value.\n\t */\n\tPropose = \"propose\",\n\n\t/**\n\t * Message used to reject a pending proposal.\n\t */\n\tReject = \"reject\",\n\n\t/**\n\t * Message sent by client accepting proposal\n\t */\n\tAccept = \"accept\",\n\n\t/**\n\t * Summary operation (message).\n\t */\n\tSummarize = \"summarize\",\n\n\t/**\n\t * Summary operation (message) written.\n\t */\n\tSummaryAck = \"summaryAck\",\n\n\t/**\n\t * Summary operation (message) write failure.\n\t */\n\tSummaryNack = \"summaryNack\",\n\n\t/**\n\t * Operation (message) produced by container runtime.\n\t */\n\tOperation = \"op\",\n\n\t/**\n\t * Message to indicate that no active clients are present.\n\t */\n\tNoClient = \"noClient\",\n\n\t/**\n\t * Message to indicate successful round trip.\n\t */\n\tRoundTrip = \"tripComplete\",\n\n\t/**\n\t * Service specific control messages that are never sequenced.\n\t */\n\tControl = \"control\",\n}\n\n/**\n * @internal\n */\nexport enum SignalType {\n\t/**\n\t * System signal sent to indicate a new client has joined the collaboration.\n\t */\n\tClientJoin = \"join\",\n\n\t/**\n\t * System signal sent to indicate a client has left the collaboration.\n\t */\n\tClientLeave = \"leave\",\n}\n\n/**\n * Messages to track latency trace.\n * @legacy @beta\n */\nexport interface ITrace {\n\t/**\n\t * Service generating the trace.\n\t */\n\tservice: string;\n\n\t/**\n\t * Denotes receiving/sending.\n\t */\n\taction: string;\n\n\t/**\n\t * Floating point time in milliseconds with up to nanosecond precision.\n\t */\n\ttimestamp: number;\n}\n\n/**\n * @legacy @beta\n */\nexport interface INack {\n\t/**\n\t * The operation that was just nacked.\n\t */\n\toperation: IDocumentMessage | undefined;\n\n\t/**\n\t * The sequence number the client needs to catch up to before retrying.\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * Detail info about the nack.\n\t */\n\tcontent: INackContent;\n}\n\n/**\n * Document-specific message.\n * @legacy @beta\n */\nexport interface IDocumentMessage {\n\t/**\n\t * The document's client sequence number.\n\t */\n\tclientSequenceNumber: number;\n\n\t/**\n\t * The reference sequence number the message was sent relative to.\n\t */\n\treferenceSequenceNumber: number;\n\n\t/**\n\t * The type of document message being sent.\n\t */\n\ttype: string;\n\n\t/**\n\t * The contents of the message.\n\t */\n\tcontents: unknown;\n\n\t/**\n\t * App provided metadata about the operation.\n\t */\n\tmetadata?: unknown;\n\n\t/**\n\t * Server provided metadata about the operation.\n\t */\n\tserverMetadata?: unknown;\n\n\t/**\n\t * Traces related to the packet.\n\t */\n\ttraces?: ITrace[];\n\n\t/**\n\t * The compression algorithm that was used to compress contents of this message.\n\t * @experimental Not ready for use\n\t */\n\tcompression?: string;\n}\n\n/**\n * Document Message with optional system level data field.\n * @internal\n */\nexport interface IDocumentSystemMessage extends IDocumentMessage {\n\tdata: string;\n}\n\n/**\n * Branch origin information.\n * @legacy @beta\n */\nexport interface IBranchOrigin {\n\t/**\n\t * Origin branch of the message.\n\t */\n\tid: string;\n\n\t/**\n\t * Sequence number for the message in branch ID.\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * Minimum sequence number for the message in branch ID.\n\t */\n\tminimumSequenceNumber: number;\n}\n\n/**\n * Sequenced message for a distributed document.\n * @legacy @beta\n */\nexport interface ISequencedDocumentMessage {\n\t/**\n\t * The client ID that submitted the message.\n\t * For server generated messages the clientId will be null;\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tclientId: string | null;\n\n\t/**\n\t * The sequenced identifier.\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * The minimum sequence number for all connected clients.\n\t */\n\tminimumSequenceNumber: number;\n\n\t/**\n\t * The document's client sequence number.\n\t */\n\tclientSequenceNumber: number;\n\n\t/**\n\t * The reference sequence number the message was sent relative to.\n\t */\n\treferenceSequenceNumber: number;\n\n\t/**\n\t * The type of operation.\n\t */\n\ttype: string;\n\n\t/**\n\t * The contents of the message.\n\t */\n\tcontents: unknown;\n\n\t/**\n\t * App provided metadata about the operation.\n\t */\n\tmetadata?: unknown;\n\n\t/**\n\t * Server provided metadata about the operation.\n\t */\n\tserverMetadata?: unknown;\n\n\t/**\n\t * Origin branch information for the message.\n\t *\n\t * @remarks Can be marked undefined if the current message is also the origin.\n\t */\n\torigin?: IBranchOrigin;\n\n\t/**\n\t * Traces related to the packet.\n\t */\n\ttraces?: ITrace[];\n\n\t/**\n\t * Timestamp when the server ticketed the message.\n\t */\n\ttimestamp: number;\n\n\t/**\n\t * Data provided by service. Only present in service generated messages.\n\t */\n\tdata?: string;\n\n\t/**\n\t * Experimental field for storing the rolling hash at sequence number.\n\t *\n\t * @deprecated Use ISequencedDocumentMessageExperimental instead.\n\t */\n\texpHash1?: string;\n\n\t/**\n\t * The compression algorithm that was used to compress contents of this message.\n\t *\n\t * @deprecated Use ISequencedDocumentMessageExperimental instead.\n\t */\n\tcompression?: string;\n}\n\n/**\n * {@link ISequencedDocumentAugmentedMessage} with experimental properties.\n * @internal\n */\nexport type ISequencedDocumentMessageExperimental = Omit<\n\tISequencedDocumentMessage,\n\t\"expHash1\" | \"compression\"\n> & {\n\t/**\n\t * Stores the rolling hash at sequence number.\n\t */\n\texpHash1?: string;\n\n\t/**\n\t * The compression algorithm that was used to compress contents of this message.\n\t */\n\tcompression?: string;\n};\n\n/**\n * @internal\n */\nexport interface ISequencedDocumentSystemMessage extends ISequencedDocumentMessage {\n\tdata: string;\n}\n\n/**\n * @internal\n */\nexport interface ISequencedDocumentAugmentedMessage extends ISequencedDocumentMessage {\n\tadditionalContent: string;\n}\n\n/**\n * Common interface between incoming and outgoing signals.\n * @legacy @beta\n */\nexport interface ISignalMessageBase<TMessage extends TypedMessage = TypedMessage> {\n\t/**\n\t * Signal content\n\t */\n\tcontent: TMessage[\"content\"];\n\n\t/**\n\t * Signal type\n\t */\n\ttype?: TMessage[\"type\"];\n\n\t/**\n\t * Counts the number of signals sent by the sending client.\n\t */\n\tclientConnectionNumber?: number;\n\n\t/**\n\t * Sequence number that indicates when the signal was created in relation to the delta stream\n\t */\n\treferenceSequenceNumber?: number;\n\n\t/**\n\t * Client ID of the singular client the signal is being (or has been) sent to.\n\t * May only be specified when IConnect.supportedFeatures['submit_signals_v2'] is true, will throw otherwise.\n\t */\n\ttargetClientId?: string;\n}\n\n/**\n * Interface for signals sent by the server to clients.\n * @legacy @beta\n */\nexport interface ISignalMessage<TMessage extends TypedMessage = TypedMessage>\n\textends ISignalMessageBase<TMessage> {\n\t/**\n\t * The client ID that submitted the message.\n\t * For server generated messages the clientId will be null.\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tclientId: string | null;\n}\n\n/**\n * Interface for signals sent by clients to the server.\n * @internal\n */\nexport type ISentSignalMessage<TMessage extends TypedMessage = TypedMessage> =\n\tISignalMessageBase<TMessage>;\n\n/**\n * @legacy @beta\n */\nexport interface IUploadedSummaryDetails {\n\t/**\n\t * Indicates whether the uploaded summary contains \".protocol\" tree.\n\t */\n\tincludesProtocolTree?: boolean;\n}\n\n/**\n * @legacy @beta\n */\nexport interface ISummaryContent {\n\t/**\n\t * Handle reference to the summary data.\n\t */\n\thandle: string;\n\n\t/**\n\t * Message included as part of the summary.\n\t */\n\tmessage: string;\n\n\t/**\n\t * Handles to parent summaries of the proposed new summary.\n\t */\n\tparents: string[];\n\n\t/**\n\t * Handle to the current latest summary stored by the service\n\t */\n\thead: string;\n\n\t/**\n\t * Details of the uploaded summary.\n\t */\n\tdetails?: IUploadedSummaryDetails;\n\n\t// TODO - need an epoch/reload bit to indicate to clients that the summary has changed and requires a reload\n\t// This could be encoded in the summary itself as well but then would require the client to download it to check\n}\n\n/**\n * General errors returned from the server.\n * May want to add error code or something similar in the future.\n * @internal\n */\nexport interface IServerError {\n\t/**\n\t * Message describing the server error.\n\t */\n\terrorMessage: string;\n}\n\n/**\n * Data about the original proposed summary message.\n * @legacy @beta\n */\nexport interface ISummaryProposal {\n\t/**\n\t * Actual sequence number of the summary message proposal.\n\t */\n\tsummarySequenceNumber: number;\n}\n\n/**\n * Contents of summary ack expected from the server.\n * @legacy @beta\n */\nexport interface ISummaryAck {\n\t/**\n\t * Handle of the complete summary.\n\t */\n\thandle: string;\n\n\t/**\n\t * Information about the proposed summary message.\n\t */\n\tsummaryProposal: ISummaryProposal;\n}\n\n/**\n * Contents of summary nack expected from the server.\n * @legacy @beta\n */\nexport interface ISummaryNack {\n\t/**\n\t * Information about the proposed summary message.\n\t */\n\tsummaryProposal: ISummaryProposal;\n\n\t/**\n\t * An error code number that represents the error. It will be a valid HTTP error code.\n\t * 403 errors are non retriable.\n\t * 400 errors are always immediately retriable.\n\t * 429 errors are retriable or non retriable (depends on type field).\n\t */\n\tcode?: number;\n\n\t/**\n\t * A message about the error for debugging/logging/telemetry purposes\n\t */\n\tmessage?: string;\n\n\t/**\n\t * Optional Retry-After time in seconds.\n\t * If specified, the client should wait this many seconds before retrying.8\n\t */\n\tretryAfter?: number;\n}\n\n/**\n * Interface for nack content.\n * @legacy @beta\n */\nexport interface INackContent {\n\t/**\n\t * An error code number that represents the error. It will be a valid HTTP error code.\n\t * 403 errors are non retriable and client should acquire a new identity before reconnection.\n\t * 400 errors are always immediately retriable\n\t * 429 errors are retriable or non retriable (depends on type field).\n\t */\n\tcode: number;\n\n\t/**\n\t * Type of the Nack.\n\t */\n\ttype: NackErrorType;\n\n\t/**\n\t * A message about the nack for debugging/logging/telemetry purposes\n\t */\n\tmessage: string;\n\n\t/**\n\t * Optional Retry-After time in seconds\n\t * If specified, the client should wait this many seconds before retrying\n\t */\n\tretryAfter?: number;\n}\n\n/**\n * Type of the nack.\n * @legacy @beta\n */\nexport enum NackErrorType {\n\t/**\n\t * Retriable after {@link ISummaryNack.retryAfter} seconds.\n\t */\n\tThrottlingError = \"ThrottlingError\",\n\n\t/**\n\t * Client's token is not valid for the intended message.\n\t */\n\tInvalidScopeError = \"InvalidScopeError\",\n\n\t/**\n\t * Clients message is invalid and should retry immediately with a valid message.\n\t */\n\tBadRequestError = \"BadRequestError\",\n\n\t/**\n\t * Service is having issues. Client should not retry.\n\t */\n\tLimitExceededError = \"LimitExceededError\",\n}\n"]}
@@ -4,8 +4,7 @@
4
4
  */
5
5
  /**
6
6
  * Defines scope access for a Container/Document.
7
- * @legacy
8
- * @alpha
7
+ * @legacy @beta
9
8
  */
10
9
  export declare enum ScopeType {
11
10
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"scopes.d.ts","sourceRoot":"","sources":["../../src/protocol/scopes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AACH,oBAAY,SAAS;IACpB;;OAEG;IACH,OAAO,aAAa;IAEpB;;OAEG;IACH,QAAQ,cAAc;IAEtB;;OAEG;IACH,YAAY,kBAAkB;CAC9B"}
1
+ {"version":3,"file":"scopes.d.ts","sourceRoot":"","sources":["../../src/protocol/scopes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,oBAAY,SAAS;IACpB;;OAEG;IACH,OAAO,aAAa;IAEpB;;OAEG;IACH,QAAQ,cAAc;IAEtB;;OAEG;IACH,YAAY,kBAAkB;CAC9B"}
@@ -7,8 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
7
7
  exports.ScopeType = void 0;
8
8
  /**
9
9
  * Defines scope access for a Container/Document.
10
- * @legacy
11
- * @alpha
10
+ * @legacy @beta
12
11
  */
13
12
  var ScopeType;
14
13
  (function (ScopeType) {
@@ -1 +1 @@
1
- {"version":3,"file":"scopes.js","sourceRoot":"","sources":["../../src/protocol/scopes.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;;;GAIG;AACH,IAAY,SAeX;AAfD,WAAY,SAAS;IACpB;;OAEG;IACH,iCAAoB,CAAA;IAEpB;;OAEG;IACH,mCAAsB,CAAA;IAEtB;;OAEG;IACH,2CAA8B,CAAA;AAC/B,CAAC,EAfW,SAAS,yBAAT,SAAS,QAepB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Defines scope access for a Container/Document.\n * @legacy\n * @alpha\n */\nexport enum ScopeType {\n\t/**\n\t * Read access is supported on the Container/Document\n\t */\n\tDocRead = \"doc:read\",\n\n\t/**\n\t * Write access is supported on the Container/Document\n\t */\n\tDocWrite = \"doc:write\",\n\n\t/**\n\t * User can generate new summaries operations\n\t */\n\tSummaryWrite = \"summary:write\",\n}\n"]}
1
+ {"version":3,"file":"scopes.js","sourceRoot":"","sources":["../../src/protocol/scopes.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;;GAGG;AACH,IAAY,SAeX;AAfD,WAAY,SAAS;IACpB;;OAEG;IACH,iCAAoB,CAAA;IAEpB;;OAEG;IACH,mCAAsB,CAAA;IAEtB;;OAEG;IACH,2CAA8B,CAAA;AAC/B,CAAC,EAfW,SAAS,yBAAT,SAAS,QAepB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Defines scope access for a Container/Document.\n * @legacy @beta\n */\nexport enum ScopeType {\n\t/**\n\t * Read access is supported on the Container/Document\n\t */\n\tDocRead = \"doc:read\",\n\n\t/**\n\t * Write access is supported on the Container/Document\n\t */\n\tDocWrite = \"doc:write\",\n\n\t/**\n\t * User can generate new summaries operations\n\t */\n\tSummaryWrite = \"summary:write\",\n}\n"]}