@fluidframework/odsp-driver-definitions 1.2.2 → 2.0.0-internal.1.0.0.82159

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.
package/dist/errors.d.ts CHANGED
@@ -22,20 +22,30 @@ export declare enum OdspErrorType {
22
22
  fluidNotEnabled = "fluidNotEnabled",
23
23
  fetchTokenError = "fetchTokenError",
24
24
  cannotCatchUp = "cannotCatchUp",
25
- serviceReadOnly = "serviceReadOnly",
26
- locationRedirection = "locationRedirection"
25
+ serviceReadOnly = "serviceReadOnly"
27
26
  }
28
- /**
29
- * Base interface for all errors and warnings
30
- * Superset of IDriverErrorBase, but with Odsp-specific errorType
31
- */
32
- export interface IOdspError extends Omit<IDriverErrorBase, "errorType"> {
33
- readonly errorType: OdspErrorType;
27
+ export interface IOdspErrorAugmentations {
34
28
  /**
35
29
  * Server epoch indicates when the file was last modified.
36
30
  * Used to detect modifications outside Fluid's services
37
31
  */
38
32
  serverEpoch?: string;
33
+ /**
34
+ * It is the redirection url at which the network call should have been made. It is due to change
35
+ * in site domain of the file on server.
36
+ */
37
+ redirectLocation?: string;
38
+ /**
39
+ * It is array of error codes included in error response from server.
40
+ */
41
+ facetCodes?: string[];
42
+ }
43
+ /**
44
+ * Base interface for all errors and warnings
45
+ * Superset of IDriverErrorBase, but with Odsp-specific errorType and properties
46
+ */
47
+ export interface IOdspError extends Omit<IDriverErrorBase, "errorType">, IOdspErrorAugmentations {
48
+ readonly errorType: OdspErrorType;
39
49
  }
40
- export declare type OdspError = DriverError | IOdspError;
50
+ export declare type OdspError = IOdspError | (DriverError & IOdspErrorAugmentations);
41
51
  //# sourceMappingURL=errors.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEnF,oBAAY,aAAa;IACrB;;OAEG;IACH,iBAAiB,sBAAsB;IAEvC;;OAEG;IACH,oBAAoB,yBAAyB;IAE7C;;;;OAIG;IACH,cAAc,mBAAmB;IAOjC,YAAY,iBAAiB;IAK7B,eAAe,oBAAoB;IAEnC,eAAe,oBAAoB;IAOnC,aAAa,kBAAkB;IAI/B,eAAe,oBAAoB;IAInC,mBAAmB,wBAAwB;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IACnE,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;IAClC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,oBAAY,SAAS,GACf,WAAW,GACX,UAAU,CAAC"}
1
+ {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEnF,oBAAY,aAAa;IACrB;;OAEG;IACH,iBAAiB,sBAAsB;IAEvC;;OAEG;IACH,oBAAoB,yBAAyB;IAE7C;;;;OAIG;IACH,cAAc,mBAAmB;IAOjC,YAAY,iBAAiB;IAK7B,eAAe,oBAAoB;IAEnC,eAAe,oBAAoB;IAOnC,aAAa,kBAAkB;IAI/B,eAAe,oBAAoB;CACtC;AAED,MAAM,WAAW,uBAAuB;IACpC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC,EAAE,uBAAuB;IAC5F,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;CACrC;AAED,oBAAY,SAAS,GAAG,UAAU,GAAG,CAAC,WAAW,GAAG,uBAAuB,CAAC,CAAC"}
package/dist/errors.js CHANGED
@@ -37,8 +37,5 @@ var OdspErrorType;
37
37
  // SPO can occasionally return 403 for r/w operations on document when there is a fail over to another data center.
38
38
  // So to preserve integrity of the data, the data becomes readonly.
39
39
  OdspErrorType["serviceReadOnly"] = "serviceReadOnly";
40
- // The location of file can move on Spo. So if the file location moves and we try to access the older location, then
41
- // this error is thrown by server to let the client know about the new redirect location.
42
- OdspErrorType["locationRedirection"] = "locationRedirection";
43
40
  })(OdspErrorType = exports.OdspErrorType || (exports.OdspErrorType = {}));
44
41
  //# sourceMappingURL=errors.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAMA,IAAY,aA8CX;AA9CD,WAAY,aAAa;IACrB;;OAEG;IACH,wDAAuC,CAAA;IAEvC;;OAEG;IACH,8DAA6C,CAAA;IAE7C;;;;OAIG;IACH,kDAAiC,CAAA;IAEjC;;;;OAIG;IACH,8CAA6B,CAAA;IAE7B;;UAEM;IACN,oDAAmC,CAAA;IAEnC,oDAAmC,CAAA;IAEnC,+EAA+E;IAC/E,4GAA4G;IAC5G,mEAAmE;IACnE,qGAAqG;IACrG,4BAA4B;IAC5B,gDAA+B,CAAA;IAE/B,mHAAmH;IACnH,mEAAmE;IACnE,oDAAmC,CAAA;IAEnC,oHAAoH;IACpH,yFAAyF;IACzF,4DAA2C,CAAA;AAC/C,CAAC,EA9CW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QA8CxB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { DriverError, IDriverErrorBase } from \"@fluidframework/driver-definitions\";\n\nexport enum OdspErrorType {\n /**\n * Storage is out of space\n */\n outOfStorageError = \"outOfStorageError\",\n\n /**\n * Invalid file name (at creation of the file)\n */\n invalidFileNameError = \"invalidFileNameError\",\n\n /**\n * Snapshot is too big. Host application specified limit for snapshot size, and snapshot was bigger\n * that that limit, thus request failed. Hosting application is expected to have fall-back behavior for\n * such case.\n */\n snapshotTooBig = \"snapshotTooBig\",\n\n /*\n * Maximum time limit to fetch reached. Host application specified limit for fetching of snapshot, when\n * that limit is reached, request fails. Hosting application is expected to have fall-back behavior for\n * such case.\n */\n fetchTimeout = \"fetchTimeout\",\n\n /*\n * SPO admin toggle: fluid service is not enabled.\n */\n fluidNotEnabled = \"fluidNotEnabled\",\n\n fetchTokenError = \"fetchTokenError\",\n\n // This error will be raised when client is too behind with no way to catch up.\n // This condition will happen when user was offline for too long, resulting in old ops / blobs being deleted\n // by storage, and thus removing an ability for client to catch up.\n // This condition will result in any local changes being lost (i.e. only way to save state is by user\n // copying it over manually)\n cannotCatchUp = \"cannotCatchUp\",\n\n // SPO can occasionally return 403 for r/w operations on document when there is a fail over to another data center.\n // So to preserve integrity of the data, the data becomes readonly.\n serviceReadOnly = \"serviceReadOnly\",\n\n // The location of file can move on Spo. So if the file location moves and we try to access the older location, then\n // this error is thrown by server to let the client know about the new redirect location.\n locationRedirection = \"locationRedirection\",\n}\n\n/**\n * Base interface for all errors and warnings\n * Superset of IDriverErrorBase, but with Odsp-specific errorType\n */\nexport interface IOdspError extends Omit<IDriverErrorBase, \"errorType\"> {\n readonly errorType: OdspErrorType;\n /**\n * Server epoch indicates when the file was last modified.\n * Used to detect modifications outside Fluid's services\n */\n serverEpoch?: string;\n}\n\nexport type OdspError =\n | DriverError\n | IOdspError;\n"]}
1
+ {"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAMA,IAAY,aA0CX;AA1CD,WAAY,aAAa;IACrB;;OAEG;IACH,wDAAuC,CAAA;IAEvC;;OAEG;IACH,8DAA6C,CAAA;IAE7C;;;;OAIG;IACH,kDAAiC,CAAA;IAEjC;;;;OAIG;IACH,8CAA6B,CAAA;IAE7B;;UAEM;IACN,oDAAmC,CAAA;IAEnC,oDAAmC,CAAA;IAEnC,+EAA+E;IAC/E,4GAA4G;IAC5G,mEAAmE;IACnE,qGAAqG;IACrG,4BAA4B;IAC5B,gDAA+B,CAAA;IAE/B,mHAAmH;IACnH,mEAAmE;IACnE,oDAAmC,CAAA;AACvC,CAAC,EA1CW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QA0CxB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { DriverError, IDriverErrorBase } from \"@fluidframework/driver-definitions\";\n\nexport enum OdspErrorType {\n /**\n * Storage is out of space\n */\n outOfStorageError = \"outOfStorageError\",\n\n /**\n * Invalid file name (at creation of the file)\n */\n invalidFileNameError = \"invalidFileNameError\",\n\n /**\n * Snapshot is too big. Host application specified limit for snapshot size, and snapshot was bigger\n * that that limit, thus request failed. Hosting application is expected to have fall-back behavior for\n * such case.\n */\n snapshotTooBig = \"snapshotTooBig\",\n\n /*\n * Maximum time limit to fetch reached. Host application specified limit for fetching of snapshot, when\n * that limit is reached, request fails. Hosting application is expected to have fall-back behavior for\n * such case.\n */\n fetchTimeout = \"fetchTimeout\",\n\n /*\n * SPO admin toggle: fluid service is not enabled.\n */\n fluidNotEnabled = \"fluidNotEnabled\",\n\n fetchTokenError = \"fetchTokenError\",\n\n // This error will be raised when client is too behind with no way to catch up.\n // This condition will happen when user was offline for too long, resulting in old ops / blobs being deleted\n // by storage, and thus removing an ability for client to catch up.\n // This condition will result in any local changes being lost (i.e. only way to save state is by user\n // copying it over manually)\n cannotCatchUp = \"cannotCatchUp\",\n\n // SPO can occasionally return 403 for r/w operations on document when there is a fail over to another data center.\n // So to preserve integrity of the data, the data becomes readonly.\n serviceReadOnly = \"serviceReadOnly\",\n}\n\nexport interface IOdspErrorAugmentations {\n /**\n * Server epoch indicates when the file was last modified.\n * Used to detect modifications outside Fluid's services\n */\n serverEpoch?: string;\n\n /**\n * It is the redirection url at which the network call should have been made. It is due to change\n * in site domain of the file on server.\n */\n redirectLocation?: string;\n\n /**\n * It is array of error codes included in error response from server.\n */\n facetCodes?: string[];\n}\n\n/**\n * Base interface for all errors and warnings\n * Superset of IDriverErrorBase, but with Odsp-specific errorType and properties\n */\nexport interface IOdspError extends Omit<IDriverErrorBase, \"errorType\">, IOdspErrorAugmentations {\n readonly errorType: OdspErrorType;\n}\n\nexport type OdspError = IOdspError | (DriverError & IOdspErrorAugmentations);\n"]}
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export declare const pkgName = "@fluidframework/odsp-driver-definitions";
8
- export declare const pkgVersion = "1.2.2";
8
+ export declare const pkgVersion = "2.0.0-internal.1.0.0.82159";
9
9
  //# sourceMappingURL=packageVersion.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,4CAA4C,CAAC;AACjE,eAAO,MAAM,UAAU,UAAU,CAAC"}
1
+ {"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,4CAA4C,CAAC;AACjE,eAAO,MAAM,UAAU,+BAA+B,CAAC"}
@@ -8,5 +8,5 @@
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.pkgVersion = exports.pkgName = void 0;
10
10
  exports.pkgName = "@fluidframework/odsp-driver-definitions";
11
- exports.pkgVersion = "1.2.2";
11
+ exports.pkgVersion = "2.0.0-internal.1.0.0.82159";
12
12
  //# sourceMappingURL=packageVersion.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,yCAAyC,CAAC;AACpD,QAAA,UAAU,GAAG,OAAO,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/odsp-driver-definitions\";\nexport const pkgVersion = \"1.2.2\";\n"]}
1
+ {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,yCAAyC,CAAC;AACpD,QAAA,UAAU,GAAG,4BAA4B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/odsp-driver-definitions\";\nexport const pkgVersion = \"2.0.0-internal.1.0.0.82159\";\n"]}
package/lib/errors.d.ts CHANGED
@@ -22,20 +22,30 @@ export declare enum OdspErrorType {
22
22
  fluidNotEnabled = "fluidNotEnabled",
23
23
  fetchTokenError = "fetchTokenError",
24
24
  cannotCatchUp = "cannotCatchUp",
25
- serviceReadOnly = "serviceReadOnly",
26
- locationRedirection = "locationRedirection"
25
+ serviceReadOnly = "serviceReadOnly"
27
26
  }
28
- /**
29
- * Base interface for all errors and warnings
30
- * Superset of IDriverErrorBase, but with Odsp-specific errorType
31
- */
32
- export interface IOdspError extends Omit<IDriverErrorBase, "errorType"> {
33
- readonly errorType: OdspErrorType;
27
+ export interface IOdspErrorAugmentations {
34
28
  /**
35
29
  * Server epoch indicates when the file was last modified.
36
30
  * Used to detect modifications outside Fluid's services
37
31
  */
38
32
  serverEpoch?: string;
33
+ /**
34
+ * It is the redirection url at which the network call should have been made. It is due to change
35
+ * in site domain of the file on server.
36
+ */
37
+ redirectLocation?: string;
38
+ /**
39
+ * It is array of error codes included in error response from server.
40
+ */
41
+ facetCodes?: string[];
42
+ }
43
+ /**
44
+ * Base interface for all errors and warnings
45
+ * Superset of IDriverErrorBase, but with Odsp-specific errorType and properties
46
+ */
47
+ export interface IOdspError extends Omit<IDriverErrorBase, "errorType">, IOdspErrorAugmentations {
48
+ readonly errorType: OdspErrorType;
39
49
  }
40
- export declare type OdspError = DriverError | IOdspError;
50
+ export declare type OdspError = IOdspError | (DriverError & IOdspErrorAugmentations);
41
51
  //# sourceMappingURL=errors.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEnF,oBAAY,aAAa;IACrB;;OAEG;IACH,iBAAiB,sBAAsB;IAEvC;;OAEG;IACH,oBAAoB,yBAAyB;IAE7C;;;;OAIG;IACH,cAAc,mBAAmB;IAOjC,YAAY,iBAAiB;IAK7B,eAAe,oBAAoB;IAEnC,eAAe,oBAAoB;IAOnC,aAAa,kBAAkB;IAI/B,eAAe,oBAAoB;IAInC,mBAAmB,wBAAwB;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IACnE,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;IAClC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,oBAAY,SAAS,GACf,WAAW,GACX,UAAU,CAAC"}
1
+ {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEnF,oBAAY,aAAa;IACrB;;OAEG;IACH,iBAAiB,sBAAsB;IAEvC;;OAEG;IACH,oBAAoB,yBAAyB;IAE7C;;;;OAIG;IACH,cAAc,mBAAmB;IAOjC,YAAY,iBAAiB;IAK7B,eAAe,oBAAoB;IAEnC,eAAe,oBAAoB;IAOnC,aAAa,kBAAkB;IAI/B,eAAe,oBAAoB;CACtC;AAED,MAAM,WAAW,uBAAuB;IACpC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC,EAAE,uBAAuB;IAC5F,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;CACrC;AAED,oBAAY,SAAS,GAAG,UAAU,GAAG,CAAC,WAAW,GAAG,uBAAuB,CAAC,CAAC"}
package/lib/errors.js CHANGED
@@ -34,8 +34,5 @@ export var OdspErrorType;
34
34
  // SPO can occasionally return 403 for r/w operations on document when there is a fail over to another data center.
35
35
  // So to preserve integrity of the data, the data becomes readonly.
36
36
  OdspErrorType["serviceReadOnly"] = "serviceReadOnly";
37
- // The location of file can move on Spo. So if the file location moves and we try to access the older location, then
38
- // this error is thrown by server to let the client know about the new redirect location.
39
- OdspErrorType["locationRedirection"] = "locationRedirection";
40
37
  })(OdspErrorType || (OdspErrorType = {}));
41
38
  //# sourceMappingURL=errors.js.map
package/lib/errors.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAMA,MAAM,CAAN,IAAY,aA8CX;AA9CD,WAAY,aAAa;IACrB;;OAEG;IACH,wDAAuC,CAAA;IAEvC;;OAEG;IACH,8DAA6C,CAAA;IAE7C;;;;OAIG;IACH,kDAAiC,CAAA;IAEjC;;;;OAIG;IACH,8CAA6B,CAAA;IAE7B;;UAEM;IACN,oDAAmC,CAAA;IAEnC,oDAAmC,CAAA;IAEnC,+EAA+E;IAC/E,4GAA4G;IAC5G,mEAAmE;IACnE,qGAAqG;IACrG,4BAA4B;IAC5B,gDAA+B,CAAA;IAE/B,mHAAmH;IACnH,mEAAmE;IACnE,oDAAmC,CAAA;IAEnC,oHAAoH;IACpH,yFAAyF;IACzF,4DAA2C,CAAA;AAC/C,CAAC,EA9CW,aAAa,KAAb,aAAa,QA8CxB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { DriverError, IDriverErrorBase } from \"@fluidframework/driver-definitions\";\n\nexport enum OdspErrorType {\n /**\n * Storage is out of space\n */\n outOfStorageError = \"outOfStorageError\",\n\n /**\n * Invalid file name (at creation of the file)\n */\n invalidFileNameError = \"invalidFileNameError\",\n\n /**\n * Snapshot is too big. Host application specified limit for snapshot size, and snapshot was bigger\n * that that limit, thus request failed. Hosting application is expected to have fall-back behavior for\n * such case.\n */\n snapshotTooBig = \"snapshotTooBig\",\n\n /*\n * Maximum time limit to fetch reached. Host application specified limit for fetching of snapshot, when\n * that limit is reached, request fails. Hosting application is expected to have fall-back behavior for\n * such case.\n */\n fetchTimeout = \"fetchTimeout\",\n\n /*\n * SPO admin toggle: fluid service is not enabled.\n */\n fluidNotEnabled = \"fluidNotEnabled\",\n\n fetchTokenError = \"fetchTokenError\",\n\n // This error will be raised when client is too behind with no way to catch up.\n // This condition will happen when user was offline for too long, resulting in old ops / blobs being deleted\n // by storage, and thus removing an ability for client to catch up.\n // This condition will result in any local changes being lost (i.e. only way to save state is by user\n // copying it over manually)\n cannotCatchUp = \"cannotCatchUp\",\n\n // SPO can occasionally return 403 for r/w operations on document when there is a fail over to another data center.\n // So to preserve integrity of the data, the data becomes readonly.\n serviceReadOnly = \"serviceReadOnly\",\n\n // The location of file can move on Spo. So if the file location moves and we try to access the older location, then\n // this error is thrown by server to let the client know about the new redirect location.\n locationRedirection = \"locationRedirection\",\n}\n\n/**\n * Base interface for all errors and warnings\n * Superset of IDriverErrorBase, but with Odsp-specific errorType\n */\nexport interface IOdspError extends Omit<IDriverErrorBase, \"errorType\"> {\n readonly errorType: OdspErrorType;\n /**\n * Server epoch indicates when the file was last modified.\n * Used to detect modifications outside Fluid's services\n */\n serverEpoch?: string;\n}\n\nexport type OdspError =\n | DriverError\n | IOdspError;\n"]}
1
+ {"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAMA,MAAM,CAAN,IAAY,aA0CX;AA1CD,WAAY,aAAa;IACrB;;OAEG;IACH,wDAAuC,CAAA;IAEvC;;OAEG;IACH,8DAA6C,CAAA;IAE7C;;;;OAIG;IACH,kDAAiC,CAAA;IAEjC;;;;OAIG;IACH,8CAA6B,CAAA;IAE7B;;UAEM;IACN,oDAAmC,CAAA;IAEnC,oDAAmC,CAAA;IAEnC,+EAA+E;IAC/E,4GAA4G;IAC5G,mEAAmE;IACnE,qGAAqG;IACrG,4BAA4B;IAC5B,gDAA+B,CAAA;IAE/B,mHAAmH;IACnH,mEAAmE;IACnE,oDAAmC,CAAA;AACvC,CAAC,EA1CW,aAAa,KAAb,aAAa,QA0CxB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { DriverError, IDriverErrorBase } from \"@fluidframework/driver-definitions\";\n\nexport enum OdspErrorType {\n /**\n * Storage is out of space\n */\n outOfStorageError = \"outOfStorageError\",\n\n /**\n * Invalid file name (at creation of the file)\n */\n invalidFileNameError = \"invalidFileNameError\",\n\n /**\n * Snapshot is too big. Host application specified limit for snapshot size, and snapshot was bigger\n * that that limit, thus request failed. Hosting application is expected to have fall-back behavior for\n * such case.\n */\n snapshotTooBig = \"snapshotTooBig\",\n\n /*\n * Maximum time limit to fetch reached. Host application specified limit for fetching of snapshot, when\n * that limit is reached, request fails. Hosting application is expected to have fall-back behavior for\n * such case.\n */\n fetchTimeout = \"fetchTimeout\",\n\n /*\n * SPO admin toggle: fluid service is not enabled.\n */\n fluidNotEnabled = \"fluidNotEnabled\",\n\n fetchTokenError = \"fetchTokenError\",\n\n // This error will be raised when client is too behind with no way to catch up.\n // This condition will happen when user was offline for too long, resulting in old ops / blobs being deleted\n // by storage, and thus removing an ability for client to catch up.\n // This condition will result in any local changes being lost (i.e. only way to save state is by user\n // copying it over manually)\n cannotCatchUp = \"cannotCatchUp\",\n\n // SPO can occasionally return 403 for r/w operations on document when there is a fail over to another data center.\n // So to preserve integrity of the data, the data becomes readonly.\n serviceReadOnly = \"serviceReadOnly\",\n}\n\nexport interface IOdspErrorAugmentations {\n /**\n * Server epoch indicates when the file was last modified.\n * Used to detect modifications outside Fluid's services\n */\n serverEpoch?: string;\n\n /**\n * It is the redirection url at which the network call should have been made. It is due to change\n * in site domain of the file on server.\n */\n redirectLocation?: string;\n\n /**\n * It is array of error codes included in error response from server.\n */\n facetCodes?: string[];\n}\n\n/**\n * Base interface for all errors and warnings\n * Superset of IDriverErrorBase, but with Odsp-specific errorType and properties\n */\nexport interface IOdspError extends Omit<IDriverErrorBase, \"errorType\">, IOdspErrorAugmentations {\n readonly errorType: OdspErrorType;\n}\n\nexport type OdspError = IOdspError | (DriverError & IOdspErrorAugmentations);\n"]}
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export declare const pkgName = "@fluidframework/odsp-driver-definitions";
8
- export declare const pkgVersion = "1.2.2";
8
+ export declare const pkgVersion = "2.0.0-internal.1.0.0.82159";
9
9
  //# sourceMappingURL=packageVersion.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,4CAA4C,CAAC;AACjE,eAAO,MAAM,UAAU,UAAU,CAAC"}
1
+ {"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,4CAA4C,CAAC;AACjE,eAAO,MAAM,UAAU,+BAA+B,CAAC"}
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export const pkgName = "@fluidframework/odsp-driver-definitions";
8
- export const pkgVersion = "1.2.2";
8
+ export const pkgVersion = "2.0.0-internal.1.0.0.82159";
9
9
  //# sourceMappingURL=packageVersion.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,yCAAyC,CAAC;AACjE,MAAM,CAAC,MAAM,UAAU,GAAG,OAAO,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/odsp-driver-definitions\";\nexport const pkgVersion = \"1.2.2\";\n"]}
1
+ {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,yCAAyC,CAAC;AACjE,MAAM,CAAC,MAAM,UAAU,GAAG,4BAA4B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/odsp-driver-definitions\";\nexport const pkgVersion = \"2.0.0-internal.1.0.0.82159\";\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/odsp-driver-definitions",
3
- "version": "1.2.2",
3
+ "version": "2.0.0-internal.1.0.0.82159",
4
4
  "description": "Socket storage implementation for SPO and ODC",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -36,14 +36,14 @@
36
36
  "typetests:gen": "fluid-type-validator -g -d ."
37
37
  },
38
38
  "dependencies": {
39
- "@fluidframework/driver-definitions": "^1.2.2"
39
+ "@fluidframework/driver-definitions": "2.0.0-internal.1.0.0.82159"
40
40
  },
41
41
  "devDependencies": {
42
42
  "@fluidframework/build-common": "^0.24.0",
43
- "@fluidframework/build-tools": "^0.2.74327",
43
+ "@fluidframework/build-tools": "^0.3.0-0",
44
44
  "@fluidframework/eslint-config-fluid": "^0.28.2000",
45
- "@fluidframework/odsp-driver-definitions-previous": "npm:@fluidframework/odsp-driver-definitions@1.2.1",
46
- "@fluidframework/protocol-definitions": "^0.1028.2000",
45
+ "@fluidframework/odsp-driver-definitions-previous": "npm:@fluidframework/odsp-driver-definitions@^1.0.0",
46
+ "@fluidframework/protocol-definitions": "^0.1029.1000-0",
47
47
  "@microsoft/api-extractor": "^7.22.2",
48
48
  "@rushstack/eslint-config": "^2.5.1",
49
49
  "concurrently": "^6.2.0",
@@ -55,7 +55,17 @@
55
55
  "typescript-formatter": "7.1.0"
56
56
  },
57
57
  "typeValidation": {
58
- "version": "1.2.2",
59
- "broken": {}
58
+ "version": "2.0.0",
59
+ "broken": {
60
+ "TypeAliasDeclaration_OdspError": {
61
+ "forwardCompat": false
62
+ },
63
+ "InterfaceDeclaration_IOdspError": {
64
+ "forwardCompat": false
65
+ },
66
+ "EnumDeclaration_OdspErrorType": {
67
+ "forwardCompat": false
68
+ }
69
+ }
60
70
  }
61
71
  }
package/src/errors.ts CHANGED
@@ -46,25 +46,33 @@ export enum OdspErrorType {
46
46
  // SPO can occasionally return 403 for r/w operations on document when there is a fail over to another data center.
47
47
  // So to preserve integrity of the data, the data becomes readonly.
48
48
  serviceReadOnly = "serviceReadOnly",
49
-
50
- // The location of file can move on Spo. So if the file location moves and we try to access the older location, then
51
- // this error is thrown by server to let the client know about the new redirect location.
52
- locationRedirection = "locationRedirection",
53
49
  }
54
50
 
55
- /**
56
- * Base interface for all errors and warnings
57
- * Superset of IDriverErrorBase, but with Odsp-specific errorType
58
- */
59
- export interface IOdspError extends Omit<IDriverErrorBase, "errorType"> {
60
- readonly errorType: OdspErrorType;
51
+ export interface IOdspErrorAugmentations {
61
52
  /**
62
53
  * Server epoch indicates when the file was last modified.
63
54
  * Used to detect modifications outside Fluid's services
64
55
  */
65
56
  serverEpoch?: string;
57
+
58
+ /**
59
+ * It is the redirection url at which the network call should have been made. It is due to change
60
+ * in site domain of the file on server.
61
+ */
62
+ redirectLocation?: string;
63
+
64
+ /**
65
+ * It is array of error codes included in error response from server.
66
+ */
67
+ facetCodes?: string[];
68
+ }
69
+
70
+ /**
71
+ * Base interface for all errors and warnings
72
+ * Superset of IDriverErrorBase, but with Odsp-specific errorType and properties
73
+ */
74
+ export interface IOdspError extends Omit<IDriverErrorBase, "errorType">, IOdspErrorAugmentations {
75
+ readonly errorType: OdspErrorType;
66
76
  }
67
77
 
68
- export type OdspError =
69
- | DriverError
70
- | IOdspError;
78
+ export type OdspError = IOdspError | (DriverError & IOdspErrorAugmentations);
@@ -6,4 +6,4 @@
6
6
  */
7
7
 
8
8
  export const pkgName = "@fluidframework/odsp-driver-definitions";
9
- export const pkgVersion = "1.2.2";
9
+ export const pkgVersion = "2.0.0-internal.1.0.0.82159";