@fluidframework/odsp-driver-definitions 1.2.3-83900 → 2.0.0-internal.1.0.0

package/dist/errors.d.ts

@@ -22,20 +22,30 @@ export declare enum OdspErrorType {
     fluidNotEnabled = "fluidNotEnabled",
     fetchTokenError = "fetchTokenError",
     cannotCatchUp = "cannotCatchUp",
-    serviceReadOnly = "serviceReadOnly",
-    locationRedirection = "locationRedirection"
+    serviceReadOnly = "serviceReadOnly"
 }
-/**
- * Base interface for all errors and warnings
- * Superset of IDriverErrorBase, but with Odsp-specific errorType
- */
-export interface IOdspError extends Omit<IDriverErrorBase, "errorType"> {
-    readonly errorType: OdspErrorType;
+export interface IOdspErrorAugmentations {
     /**
      * Server epoch indicates when the file was last modified.
      * Used to detect modifications outside Fluid's services
      */
     serverEpoch?: string;
+    /**
+     * It is the redirection url at which the network call should have been made. It is due to change
+     * in site domain of the file on server.
+     */
+    redirectLocation?: string;
+    /**
+     * It is array of error codes included in error response from server.
+     */
+    facetCodes?: string[];
+}
+/**
+ * Base interface for all errors and warnings
+ * Superset of IDriverErrorBase, but with Odsp-specific errorType and properties
+ */
+export interface IOdspError extends Omit<IDriverErrorBase, "errorType">, IOdspErrorAugmentations {
+    readonly errorType: OdspErrorType;
 }
-export declare type OdspError = DriverError | IOdspError;
+export declare type OdspError = IOdspError | (DriverError & IOdspErrorAugmentations);
 //# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -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"}
+{"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

@@ -37,8 +37,5 @@ var OdspErrorType;
     // SPO can occasionally return 403 for r/w operations on document when there is a fail over to another data center.
     // So to preserve integrity of the data, the data becomes readonly.
     OdspErrorType["serviceReadOnly"] = "serviceReadOnly";
-    // The location of file can move on Spo. So if the file location moves and we try to access the older location, then
-    // this error is thrown by server to let the client know about the new redirect location.
-    OdspErrorType["locationRedirection"] = "locationRedirection";
 })(OdspErrorType = exports.OdspErrorType || (exports.OdspErrorType = {}));
 //# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -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"]}
+{"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"]}

package/dist/factory.d.ts

@@ -41,7 +41,7 @@ export interface ICollabSessionOptions {
      */
     unauthenticatedUserDisplayName?: string;
     /**
-     * @deprecated - Due to security reasons we will passing the token via Authorization header only.
+     * @deprecated - Due to security reasons we will be passing the token via Authorization header only.
      * Value indicating session preference to always pass access token via Authorization header.
      * Default behavior is to pass access token via query parameter unless overall href string
      * length exceeds 2048 characters. Using query param is performance optimization which results

package/dist/factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"factory.js","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport interface ISnapshotOptions {\n    blobs?: number;\n    deltas?: number;\n    channels?: number;\n    /*\n     * Maximum Data size (in bytes)\n     * If specified, SPO will fail snapshot request with 413 error (see OdspErrorType.snapshotTooBig)\n     * if snapshot is bigger in size than specified limit.\n     */\n    mds?: number;\n\n    /*\n     * Maximum time limit to fetch snapshot (in seconds)\n     * If specified, client will timeout the fetch request if it exceeds the time limit and\n     * will try to fetch the snapshot without blobs.\n     */\n    timeout?: number;\n}\n\nexport interface IOpsCachingPolicy {\n    /**\n     * Batch size. Controls how many ops are grouped together as single cache entry\n     * The bigger the number, the more efficient it is (less reads & writes)\n     * At the same time, big number means we wait for so many ops to accumulate, which\n     * increases chances and number of trailing ops that would not be flushed to cache\n     * when user closes tab\n     * Use any number below 1 to disable caching\n     * Default: 100\n     */\n    batchSize?: number;\n\n    /**\n     * To reduce the problem of losing trailing ops when using big batch sizes, host\n     * could specify how often driver should flush ops it has not flushed yet.\n     * -1 means do not use timer.\n     * Measured in ms.\n     * Default: 5000\n     */\n    timerGranularity?: number;\n\n    /**\n     * Total number of ops to cache. When we reach that number, ops caching stops\n     * Default: 5000\n     */\n    totalOpsToCache?: number;\n}\n\nexport interface ICollabSessionOptions {\n    /**\n     * Value indicating the display name for session that admits unauthenticated user.\n     * This name will be used in attribution associated with edits made by such user.\n     */\n    unauthenticatedUserDisplayName?: string;\n    /**\n     * @deprecated - Due to security reasons we will passing the token via Authorization header only.\n     * Value indicating session preference to always pass access token via Authorization header.\n     * Default behavior is to pass access token via query parameter unless overall href string\n     * length exceeds 2048 characters. Using query param is performance optimization which results\n     * in ODSP XHR request being treated as 'simple' request which do not require OPTIONS call to\n     * validate CORS. However, not all ODSP implementations understand this optimization.\n     * For instance, auth layer on Converged stack will fail request with access token passed via\n     * query param.\n     */\n    forceAccessTokenViaAuthorizationHeader?: boolean;\n}\n\nexport interface HostStoragePolicy {\n    snapshotOptions?: ISnapshotOptions;\n\n    /**\n     * If set to true, tells driver to concurrently fetch snapshot from storage (SPO) and cache\n     * Container loads from whatever comes first in such case.\n     * Snapshot fetched from storage is pushed to cache in either case.\n     * If set to false, driver will first consult with cache. Only on cache miss (cache does not\n     * return snapshot), driver will fetch snapshot from storage (and push it to cache), otherwise\n     * it will load from cache and not reach out to storage.\n     * Passing true results in faster loads and keeping cache more current, but it increases bandwidth consumption.\n     */\n    concurrentSnapshotFetch?: boolean;\n\n    // Options overwriting default ops fetching from storage.\n    opsBatchSize?: number;\n    concurrentOpsBatches?: number;\n\n    /**\n     * Policy controlling ops caching (leveraging IPersistedCache passed to driver factory)\n     */\n    opsCaching?: IOpsCachingPolicy;\n\n    /**\n     * Policy controlling how collaboration session is established\n     */\n    sessionOptions?: ICollabSessionOptions;\n\n    /**\n     * @deprecated - This field will be always set to true after removal.\n     * True to have the sharing link redeem fallback in case the Trees Latest/Redeem 1RT call fails with redeem error.\n     * During fallback it will first redeem the sharing link and then make the Trees latest call.\n     */\n    enableRedeemFallback?: boolean;\n\n    /**\n     * Policy controlling if we will cache initial summary when we create a document\n     */\n    cacheCreateNewSummary?: boolean;\n\n    /**\n     * @deprecated - This will be replaced with feature gate snapshotFormatFetchType.\n     * Policy controlling if we want to fetch binary format snapshot.\n     */\n    fetchBinarySnapshotFormat?: boolean;\n\n    /**\n     * If set to true, socket cache are per OdspDocumentService instead of shared across all instances\n     */\n    isolateSocketCache?: boolean;\n\n    /**\n     * Enable creation of sharing link along with the creation of file by setting this value to true.\n     * If the host provides a 'createLinkType' parameter in the request URL to the container.attach()\n     * method, we will request for send the request to ODSP with the same (if the flag is enabled) so\n     * that a sharing can be created with the creation of file to save number for round trips made to ODSP.\n     */\n     enableShareLinkWithCreate?: boolean;\n}\n"]}
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport interface ISnapshotOptions {\n    blobs?: number;\n    deltas?: number;\n    channels?: number;\n    /*\n     * Maximum Data size (in bytes)\n     * If specified, SPO will fail snapshot request with 413 error (see OdspErrorType.snapshotTooBig)\n     * if snapshot is bigger in size than specified limit.\n     */\n    mds?: number;\n\n    /*\n     * Maximum time limit to fetch snapshot (in seconds)\n     * If specified, client will timeout the fetch request if it exceeds the time limit and\n     * will try to fetch the snapshot without blobs.\n     */\n    timeout?: number;\n}\n\nexport interface IOpsCachingPolicy {\n    /**\n     * Batch size. Controls how many ops are grouped together as single cache entry\n     * The bigger the number, the more efficient it is (less reads & writes)\n     * At the same time, big number means we wait for so many ops to accumulate, which\n     * increases chances and number of trailing ops that would not be flushed to cache\n     * when user closes tab\n     * Use any number below 1 to disable caching\n     * Default: 100\n     */\n    batchSize?: number;\n\n    /**\n     * To reduce the problem of losing trailing ops when using big batch sizes, host\n     * could specify how often driver should flush ops it has not flushed yet.\n     * -1 means do not use timer.\n     * Measured in ms.\n     * Default: 5000\n     */\n    timerGranularity?: number;\n\n    /**\n     * Total number of ops to cache. When we reach that number, ops caching stops\n     * Default: 5000\n     */\n    totalOpsToCache?: number;\n}\n\nexport interface ICollabSessionOptions {\n    /**\n     * Value indicating the display name for session that admits unauthenticated user.\n     * This name will be used in attribution associated with edits made by such user.\n     */\n    unauthenticatedUserDisplayName?: string;\n    /**\n     * @deprecated - Due to security reasons we will be passing the token via Authorization header only.\n     * Value indicating session preference to always pass access token via Authorization header.\n     * Default behavior is to pass access token via query parameter unless overall href string\n     * length exceeds 2048 characters. Using query param is performance optimization which results\n     * in ODSP XHR request being treated as 'simple' request which do not require OPTIONS call to\n     * validate CORS. However, not all ODSP implementations understand this optimization.\n     * For instance, auth layer on Converged stack will fail request with access token passed via\n     * query param.\n     */\n    forceAccessTokenViaAuthorizationHeader?: boolean;\n}\n\nexport interface HostStoragePolicy {\n    snapshotOptions?: ISnapshotOptions;\n\n    /**\n     * If set to true, tells driver to concurrently fetch snapshot from storage (SPO) and cache\n     * Container loads from whatever comes first in such case.\n     * Snapshot fetched from storage is pushed to cache in either case.\n     * If set to false, driver will first consult with cache. Only on cache miss (cache does not\n     * return snapshot), driver will fetch snapshot from storage (and push it to cache), otherwise\n     * it will load from cache and not reach out to storage.\n     * Passing true results in faster loads and keeping cache more current, but it increases bandwidth consumption.\n     */\n    concurrentSnapshotFetch?: boolean;\n\n    // Options overwriting default ops fetching from storage.\n    opsBatchSize?: number;\n    concurrentOpsBatches?: number;\n\n    /**\n     * Policy controlling ops caching (leveraging IPersistedCache passed to driver factory)\n     */\n    opsCaching?: IOpsCachingPolicy;\n\n    /**\n     * Policy controlling how collaboration session is established\n     */\n    sessionOptions?: ICollabSessionOptions;\n\n    /**\n     * @deprecated - This field will be always set to true after removal.\n     * True to have the sharing link redeem fallback in case the Trees Latest/Redeem 1RT call fails with redeem error.\n     * During fallback it will first redeem the sharing link and then make the Trees latest call.\n     */\n    enableRedeemFallback?: boolean;\n\n    /**\n     * Policy controlling if we will cache initial summary when we create a document\n     */\n    cacheCreateNewSummary?: boolean;\n\n    /**\n     * @deprecated - This will be replaced with feature gate snapshotFormatFetchType.\n     * Policy controlling if we want to fetch binary format snapshot.\n     */\n    fetchBinarySnapshotFormat?: boolean;\n\n    /**\n     * If set to true, socket cache are per OdspDocumentService instead of shared across all instances\n     */\n    isolateSocketCache?: boolean;\n\n    /**\n     * Enable creation of sharing link along with the creation of file by setting this value to true.\n     * If the host provides a 'createLinkType' parameter in the request URL to the container.attach()\n     * method, we will request for send the request to ODSP with the same (if the flag is enabled) so\n     * that a sharing can be created with the creation of file to save number for round trips made to ODSP.\n     */\n     enableShareLinkWithCreate?: boolean;\n}\n"]}

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/odsp-driver-definitions";
-export declare const pkgVersion = "1.2.3-83900";
+export declare const pkgVersion = "2.0.0-internal.1.0.0";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -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,gBAAgB,CAAC"}
+{"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,yBAAyB,CAAC"}

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/odsp-driver-definitions";
-exports.pkgVersion = "1.2.3-83900";
+exports.pkgVersion = "2.0.0-internal.1.0.0";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -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,aAAa,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.3-83900\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,yCAAyC,CAAC;AACpD,QAAA,UAAU,GAAG,sBAAsB,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\";\n"]}

package/lib/errors.d.ts

@@ -22,20 +22,30 @@ export declare enum OdspErrorType {
     fluidNotEnabled = "fluidNotEnabled",
     fetchTokenError = "fetchTokenError",
     cannotCatchUp = "cannotCatchUp",
-    serviceReadOnly = "serviceReadOnly",
-    locationRedirection = "locationRedirection"
+    serviceReadOnly = "serviceReadOnly"
 }
-/**
- * Base interface for all errors and warnings
- * Superset of IDriverErrorBase, but with Odsp-specific errorType
- */
-export interface IOdspError extends Omit<IDriverErrorBase, "errorType"> {
-    readonly errorType: OdspErrorType;
+export interface IOdspErrorAugmentations {
     /**
      * Server epoch indicates when the file was last modified.
      * Used to detect modifications outside Fluid's services
      */
     serverEpoch?: string;
+    /**
+     * It is the redirection url at which the network call should have been made. It is due to change
+     * in site domain of the file on server.
+     */
+    redirectLocation?: string;
+    /**
+     * It is array of error codes included in error response from server.
+     */
+    facetCodes?: string[];
+}
+/**
+ * Base interface for all errors and warnings
+ * Superset of IDriverErrorBase, but with Odsp-specific errorType and properties
+ */
+export interface IOdspError extends Omit<IDriverErrorBase, "errorType">, IOdspErrorAugmentations {
+    readonly errorType: OdspErrorType;
 }
-export declare type OdspError = DriverError | IOdspError;
+export declare type OdspError = IOdspError | (DriverError & IOdspErrorAugmentations);
 //# sourceMappingURL=errors.d.ts.map

package/lib/errors.d.ts.map

@@ -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"}
+{"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

@@ -34,8 +34,5 @@ export var OdspErrorType;
     // SPO can occasionally return 403 for r/w operations on document when there is a fail over to another data center.
     // So to preserve integrity of the data, the data becomes readonly.
     OdspErrorType["serviceReadOnly"] = "serviceReadOnly";
-    // The location of file can move on Spo. So if the file location moves and we try to access the older location, then
-    // this error is thrown by server to let the client know about the new redirect location.
-    OdspErrorType["locationRedirection"] = "locationRedirection";
 })(OdspErrorType || (OdspErrorType = {}));
 //# sourceMappingURL=errors.js.map

package/lib/errors.js.map

@@ -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"]}
+{"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"]}

package/lib/factory.d.ts

@@ -41,7 +41,7 @@ export interface ICollabSessionOptions {
      */
     unauthenticatedUserDisplayName?: string;
     /**
-     * @deprecated - Due to security reasons we will passing the token via Authorization header only.
+     * @deprecated - Due to security reasons we will be passing the token via Authorization header only.
      * Value indicating session preference to always pass access token via Authorization header.
      * Default behavior is to pass access token via query parameter unless overall href string
      * length exceeds 2048 characters. Using query param is performance optimization which results

package/lib/factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"factory.js","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport interface ISnapshotOptions {\n    blobs?: number;\n    deltas?: number;\n    channels?: number;\n    /*\n     * Maximum Data size (in bytes)\n     * If specified, SPO will fail snapshot request with 413 error (see OdspErrorType.snapshotTooBig)\n     * if snapshot is bigger in size than specified limit.\n     */\n    mds?: number;\n\n    /*\n     * Maximum time limit to fetch snapshot (in seconds)\n     * If specified, client will timeout the fetch request if it exceeds the time limit and\n     * will try to fetch the snapshot without blobs.\n     */\n    timeout?: number;\n}\n\nexport interface IOpsCachingPolicy {\n    /**\n     * Batch size. Controls how many ops are grouped together as single cache entry\n     * The bigger the number, the more efficient it is (less reads & writes)\n     * At the same time, big number means we wait for so many ops to accumulate, which\n     * increases chances and number of trailing ops that would not be flushed to cache\n     * when user closes tab\n     * Use any number below 1 to disable caching\n     * Default: 100\n     */\n    batchSize?: number;\n\n    /**\n     * To reduce the problem of losing trailing ops when using big batch sizes, host\n     * could specify how often driver should flush ops it has not flushed yet.\n     * -1 means do not use timer.\n     * Measured in ms.\n     * Default: 5000\n     */\n    timerGranularity?: number;\n\n    /**\n     * Total number of ops to cache. When we reach that number, ops caching stops\n     * Default: 5000\n     */\n    totalOpsToCache?: number;\n}\n\nexport interface ICollabSessionOptions {\n    /**\n     * Value indicating the display name for session that admits unauthenticated user.\n     * This name will be used in attribution associated with edits made by such user.\n     */\n    unauthenticatedUserDisplayName?: string;\n    /**\n     * @deprecated - Due to security reasons we will passing the token via Authorization header only.\n     * Value indicating session preference to always pass access token via Authorization header.\n     * Default behavior is to pass access token via query parameter unless overall href string\n     * length exceeds 2048 characters. Using query param is performance optimization which results\n     * in ODSP XHR request being treated as 'simple' request which do not require OPTIONS call to\n     * validate CORS. However, not all ODSP implementations understand this optimization.\n     * For instance, auth layer on Converged stack will fail request with access token passed via\n     * query param.\n     */\n    forceAccessTokenViaAuthorizationHeader?: boolean;\n}\n\nexport interface HostStoragePolicy {\n    snapshotOptions?: ISnapshotOptions;\n\n    /**\n     * If set to true, tells driver to concurrently fetch snapshot from storage (SPO) and cache\n     * Container loads from whatever comes first in such case.\n     * Snapshot fetched from storage is pushed to cache in either case.\n     * If set to false, driver will first consult with cache. Only on cache miss (cache does not\n     * return snapshot), driver will fetch snapshot from storage (and push it to cache), otherwise\n     * it will load from cache and not reach out to storage.\n     * Passing true results in faster loads and keeping cache more current, but it increases bandwidth consumption.\n     */\n    concurrentSnapshotFetch?: boolean;\n\n    // Options overwriting default ops fetching from storage.\n    opsBatchSize?: number;\n    concurrentOpsBatches?: number;\n\n    /**\n     * Policy controlling ops caching (leveraging IPersistedCache passed to driver factory)\n     */\n    opsCaching?: IOpsCachingPolicy;\n\n    /**\n     * Policy controlling how collaboration session is established\n     */\n    sessionOptions?: ICollabSessionOptions;\n\n    /**\n     * @deprecated - This field will be always set to true after removal.\n     * True to have the sharing link redeem fallback in case the Trees Latest/Redeem 1RT call fails with redeem error.\n     * During fallback it will first redeem the sharing link and then make the Trees latest call.\n     */\n    enableRedeemFallback?: boolean;\n\n    /**\n     * Policy controlling if we will cache initial summary when we create a document\n     */\n    cacheCreateNewSummary?: boolean;\n\n    /**\n     * @deprecated - This will be replaced with feature gate snapshotFormatFetchType.\n     * Policy controlling if we want to fetch binary format snapshot.\n     */\n    fetchBinarySnapshotFormat?: boolean;\n\n    /**\n     * If set to true, socket cache are per OdspDocumentService instead of shared across all instances\n     */\n    isolateSocketCache?: boolean;\n\n    /**\n     * Enable creation of sharing link along with the creation of file by setting this value to true.\n     * If the host provides a 'createLinkType' parameter in the request URL to the container.attach()\n     * method, we will request for send the request to ODSP with the same (if the flag is enabled) so\n     * that a sharing can be created with the creation of file to save number for round trips made to ODSP.\n     */\n     enableShareLinkWithCreate?: boolean;\n}\n"]}
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport interface ISnapshotOptions {\n    blobs?: number;\n    deltas?: number;\n    channels?: number;\n    /*\n     * Maximum Data size (in bytes)\n     * If specified, SPO will fail snapshot request with 413 error (see OdspErrorType.snapshotTooBig)\n     * if snapshot is bigger in size than specified limit.\n     */\n    mds?: number;\n\n    /*\n     * Maximum time limit to fetch snapshot (in seconds)\n     * If specified, client will timeout the fetch request if it exceeds the time limit and\n     * will try to fetch the snapshot without blobs.\n     */\n    timeout?: number;\n}\n\nexport interface IOpsCachingPolicy {\n    /**\n     * Batch size. Controls how many ops are grouped together as single cache entry\n     * The bigger the number, the more efficient it is (less reads & writes)\n     * At the same time, big number means we wait for so many ops to accumulate, which\n     * increases chances and number of trailing ops that would not be flushed to cache\n     * when user closes tab\n     * Use any number below 1 to disable caching\n     * Default: 100\n     */\n    batchSize?: number;\n\n    /**\n     * To reduce the problem of losing trailing ops when using big batch sizes, host\n     * could specify how often driver should flush ops it has not flushed yet.\n     * -1 means do not use timer.\n     * Measured in ms.\n     * Default: 5000\n     */\n    timerGranularity?: number;\n\n    /**\n     * Total number of ops to cache. When we reach that number, ops caching stops\n     * Default: 5000\n     */\n    totalOpsToCache?: number;\n}\n\nexport interface ICollabSessionOptions {\n    /**\n     * Value indicating the display name for session that admits unauthenticated user.\n     * This name will be used in attribution associated with edits made by such user.\n     */\n    unauthenticatedUserDisplayName?: string;\n    /**\n     * @deprecated - Due to security reasons we will be passing the token via Authorization header only.\n     * Value indicating session preference to always pass access token via Authorization header.\n     * Default behavior is to pass access token via query parameter unless overall href string\n     * length exceeds 2048 characters. Using query param is performance optimization which results\n     * in ODSP XHR request being treated as 'simple' request which do not require OPTIONS call to\n     * validate CORS. However, not all ODSP implementations understand this optimization.\n     * For instance, auth layer on Converged stack will fail request with access token passed via\n     * query param.\n     */\n    forceAccessTokenViaAuthorizationHeader?: boolean;\n}\n\nexport interface HostStoragePolicy {\n    snapshotOptions?: ISnapshotOptions;\n\n    /**\n     * If set to true, tells driver to concurrently fetch snapshot from storage (SPO) and cache\n     * Container loads from whatever comes first in such case.\n     * Snapshot fetched from storage is pushed to cache in either case.\n     * If set to false, driver will first consult with cache. Only on cache miss (cache does not\n     * return snapshot), driver will fetch snapshot from storage (and push it to cache), otherwise\n     * it will load from cache and not reach out to storage.\n     * Passing true results in faster loads and keeping cache more current, but it increases bandwidth consumption.\n     */\n    concurrentSnapshotFetch?: boolean;\n\n    // Options overwriting default ops fetching from storage.\n    opsBatchSize?: number;\n    concurrentOpsBatches?: number;\n\n    /**\n     * Policy controlling ops caching (leveraging IPersistedCache passed to driver factory)\n     */\n    opsCaching?: IOpsCachingPolicy;\n\n    /**\n     * Policy controlling how collaboration session is established\n     */\n    sessionOptions?: ICollabSessionOptions;\n\n    /**\n     * @deprecated - This field will be always set to true after removal.\n     * True to have the sharing link redeem fallback in case the Trees Latest/Redeem 1RT call fails with redeem error.\n     * During fallback it will first redeem the sharing link and then make the Trees latest call.\n     */\n    enableRedeemFallback?: boolean;\n\n    /**\n     * Policy controlling if we will cache initial summary when we create a document\n     */\n    cacheCreateNewSummary?: boolean;\n\n    /**\n     * @deprecated - This will be replaced with feature gate snapshotFormatFetchType.\n     * Policy controlling if we want to fetch binary format snapshot.\n     */\n    fetchBinarySnapshotFormat?: boolean;\n\n    /**\n     * If set to true, socket cache are per OdspDocumentService instead of shared across all instances\n     */\n    isolateSocketCache?: boolean;\n\n    /**\n     * Enable creation of sharing link along with the creation of file by setting this value to true.\n     * If the host provides a 'createLinkType' parameter in the request URL to the container.attach()\n     * method, we will request for send the request to ODSP with the same (if the flag is enabled) so\n     * that a sharing can be created with the creation of file to save number for round trips made to ODSP.\n     */\n     enableShareLinkWithCreate?: boolean;\n}\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/odsp-driver-definitions";
-export declare const pkgVersion = "1.2.3-83900";
+export declare const pkgVersion = "2.0.0-internal.1.0.0";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.d.ts.map

@@ -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,gBAAgB,CAAC"}
+{"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,yBAAyB,CAAC"}

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/odsp-driver-definitions";
-export const pkgVersion = "1.2.3-83900";
+export const pkgVersion = "2.0.0-internal.1.0.0";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -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,aAAa,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.3-83900\";\n"]}
+{"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,sBAAsB,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\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/odsp-driver-definitions",
-  "version": "1.2.3-83900",
+  "version": "2.0.0-internal.1.0.0",
   "description": "Socket storage implementation for SPO and ODC",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -36,14 +36,14 @@
     "typetests:gen": "fluid-type-validator -g -d ."
   },
   "dependencies": {
-    "@fluidframework/driver-definitions": "1.2.3-83900"
+    "@fluidframework/driver-definitions": "^2.0.0-internal.1.0.0"
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.2.74327",
+    "@fluidframework/build-tools": "^0.3.1000",
     "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/odsp-driver-definitions-previous": "npm:@fluidframework/odsp-driver-definitions@1.2.1",
-    "@fluidframework/protocol-definitions": "^0.1028.2000",
+    "@fluidframework/odsp-driver-definitions-previous": "npm:@fluidframework/odsp-driver-definitions@^1.0.0",
+    "@fluidframework/protocol-definitions": "^1.0.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "concurrently": "^6.2.0",
@@ -55,7 +55,17 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "1.2.2",
-    "broken": {}
+    "version": "2.0.0",
+    "broken": {
+      "TypeAliasDeclaration_OdspError": {
+        "forwardCompat": false
+      },
+      "InterfaceDeclaration_IOdspError": {
+        "forwardCompat": false
+      },
+      "EnumDeclaration_OdspErrorType": {
+        "forwardCompat": false
+      }
+    }
   }
 }

package/src/errors.ts

@@ -46,25 +46,33 @@ export enum OdspErrorType {
     // SPO can occasionally return 403 for r/w operations on document when there is a fail over to another data center.
     // So to preserve integrity of the data, the data becomes readonly.
     serviceReadOnly = "serviceReadOnly",
-
-    // The location of file can move on Spo. So if the file location moves and we try to access the older location, then
-    // this error is thrown by server to let the client know about the new redirect location.
-    locationRedirection = "locationRedirection",
 }
 
-/**
- * Base interface for all errors and warnings
- * Superset of IDriverErrorBase, but with Odsp-specific errorType
- */
-export interface IOdspError extends Omit<IDriverErrorBase, "errorType"> {
-    readonly errorType: OdspErrorType;
+export interface IOdspErrorAugmentations {
     /**
      * Server epoch indicates when the file was last modified.
      * Used to detect modifications outside Fluid's services
      */
     serverEpoch?: string;
+
+    /**
+     * It is the redirection url at which the network call should have been made. It is due to change
+     * in site domain of the file on server.
+     */
+    redirectLocation?: string;
+
+    /**
+     * It is array of error codes included in error response from server.
+     */
+    facetCodes?: string[];
+}
+
+/**
+ * Base interface for all errors and warnings
+ * Superset of IDriverErrorBase, but with Odsp-specific errorType and properties
+ */
+export interface IOdspError extends Omit<IDriverErrorBase, "errorType">, IOdspErrorAugmentations {
+    readonly errorType: OdspErrorType;
 }
 
-export type OdspError =
-    | DriverError
-    | IOdspError;
+export type OdspError = IOdspError | (DriverError & IOdspErrorAugmentations);

package/src/factory.ts

@@ -57,7 +57,7 @@ export interface ICollabSessionOptions {
      */
     unauthenticatedUserDisplayName?: string;
     /**
-     * @deprecated - Due to security reasons we will passing the token via Authorization header only.
+     * @deprecated - Due to security reasons we will be passing the token via Authorization header only.
      * Value indicating session preference to always pass access token via Authorization header.
      * Default behavior is to pass access token via query parameter unless overall href string
      * length exceeds 2048 characters. Using query param is performance optimization which results

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/odsp-driver-definitions";
-export const pkgVersion = "1.2.3-83900";
+export const pkgVersion = "2.0.0-internal.1.0.0";