@fluidframework/routerlicious-driver 2.0.0-rc.2.0.2 → 2.0.0-rc.3.0.1

package/src/restWrapper.ts

@@ -3,28 +3,30 @@
  * Licensed under the MIT License.
  */
 
+import { fromUtf8ToBase64, performance } from "@fluid-internal/client-utils";
 import { ITelemetryBaseProperties } from "@fluidframework/core-interfaces";
+import { assert } from "@fluidframework/core-utils/internal";
 import {
-	ITelemetryLoggerExt,
-	PerformanceEvent,
-	numberFromString,
-} from "@fluidframework/telemetry-utils";
-import { assert } from "@fluidframework/core-utils";
-import { fromUtf8ToBase64, performance } from "@fluid-internal/client-utils";
-import { GenericNetworkError, NonRetryableError, RateLimiter } from "@fluidframework/driver-utils";
+	GenericNetworkError,
+	NonRetryableError,
+	RateLimiter,
+} from "@fluidframework/driver-utils/internal";
 import {
 	CorrelationIdHeaderName,
 	DriverVersionHeaderName,
-	getAuthorizationTokenFromCredentials,
 	RestLessClient,
+	getAuthorizationTokenFromCredentials,
 } from "@fluidframework/server-services-client";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+import { PerformanceEvent, numberFromString } from "@fluidframework/telemetry-utils/internal";
 import fetch from "cross-fetch";
-import type { AxiosRequestConfig, RawAxiosRequestHeaders } from "axios";
 import safeStringify from "json-stringify-safe";
-import { RouterliciousErrorTypes, throwR11sNetworkError } from "./errorUtils";
-import { ITokenProvider, ITokenResponse } from "./tokens";
-import { pkgVersion as driverVersion } from "./packageVersion";
-import { QueryStringType, RestWrapper } from "./restWrapperBase";
+
+import type { AxiosRequestConfig, RawAxiosRequestHeaders } from "./axios.cjs";
+import { RouterliciousErrorTypes, throwR11sNetworkError } from "./errorUtils.js";
+import { pkgVersion as driverVersion } from "./packageVersion.js";
+import { QueryStringType, RestWrapper } from "./restWrapperBase.js";
+import { ITokenProvider, ITokenResponse } from "./tokens.js";
 
 type AuthorizationHeaderGetter = (token: ITokenResponse) => string;
 export type TokenFetcher = (refresh?: boolean) => Promise<ITokenResponse>;

package/src/restWrapperBase.ts

@@ -3,8 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import type { AxiosRequestConfig, AxiosRequestHeaders } from "axios";
-import { IR11sResponse } from "./restWrapper";
+import type { AxiosRequestConfig, AxiosRequestHeaders } from "./axios.cjs";
+import { IR11sResponse } from "./restWrapper.js";
 
 export abstract class RestWrapper {
 	constructor(

package/src/retriableGitManager.ts

@@ -3,16 +3,17 @@
  * Licensed under the MIT License.
  */
 
+import { runWithRetry } from "@fluidframework/driver-utils/internal";
 import type * as git from "@fluidframework/gitresources";
 import {
 	IWholeSummaryPayload,
 	IWriteSummaryResponse,
 } from "@fluidframework/server-services-client";
-import { runWithRetry } from "@fluidframework/driver-utils";
 import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
-import { IGitManager } from "./storageContracts";
-import { IR11sResponse } from "./restWrapper";
-import { IWholeFlatSnapshot } from "./contracts";
+
+import { IWholeFlatSnapshot } from "./contracts.js";
+import { IR11sResponse } from "./restWrapper.js";
+import { IGitManager } from "./storageContracts.js";
 
 export class RetriableGitManager implements IGitManager {
 	constructor(

package/src/routerliciousResolvedUrl.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import type { IResolvedUrl } from "@fluidframework/driver-definitions";
+import type { IResolvedUrl } from "@fluidframework/driver-definitions/internal";
 
 /**
  * Routerlicious extends the resolved url with additional properties to control Routerlicious-specific behaviors.

package/src/shreddedSummaryDocumentStorageService.ts

@@ -3,18 +3,12 @@
  * Licensed under the MIT License.
  */
 
-import {
-	ITelemetryLoggerExt,
-	MonitoringContext,
-	PerformanceEvent,
-	createChildMonitoringContext,
-} from "@fluidframework/telemetry-utils";
-import { stringToBuffer, Uint8ArrayToString } from "@fluid-internal/client-utils";
+import { Uint8ArrayToString, stringToBuffer } from "@fluid-internal/client-utils";
 import {
 	IDocumentStorageService,
-	ISummaryContext,
 	IDocumentStorageServicePolicies,
-} from "@fluidframework/driver-definitions";
+	ISummaryContext,
+} from "@fluidframework/driver-definitions/internal";
 import { buildGitTreeHierarchy } from "@fluidframework/protocol-base";
 import {
 	ICreateBlobResponse,
@@ -23,13 +17,20 @@ import {
 	ISummaryTree,
 	IVersion,
 } from "@fluidframework/protocol-definitions";
-import { IRouterliciousDriverPolicies } from "./policies";
-import { ICache, InMemoryCache } from "./cache";
-import { RetriableGitManager } from "./retriableGitManager";
-import { ISnapshotTreeVersion } from "./definitions";
-import { GitManager } from "./gitManager";
-import { ISummaryUploadManager } from "./storageContracts";
-import { SummaryTreeUploadManager } from "./summaryTreeUploadManager";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+import {
+	MonitoringContext,
+	PerformanceEvent,
+	createChildMonitoringContext,
+} from "@fluidframework/telemetry-utils/internal";
+
+import { ICache, InMemoryCache } from "./cache.js";
+import { ISnapshotTreeVersion } from "./definitions.js";
+import { GitManager } from "./gitManager.js";
+import { IRouterliciousDriverPolicies } from "./policies.js";
+import { RetriableGitManager } from "./retriableGitManager.js";
+import { ISummaryUploadManager } from "./storageContracts.js";
+import { SummaryTreeUploadManager } from "./summaryTreeUploadManager.js";
 
 const isNode = typeof window === "undefined";
 

package/src/storageContracts.ts

@@ -10,8 +10,9 @@ import {
 	IWholeSummaryPayloadType,
 	IWriteSummaryResponse,
 } from "@fluidframework/server-services-client";
-import { IR11sResponse } from "./restWrapper";
-import { IWholeFlatSnapshot } from "./contracts";
+
+import { IWholeFlatSnapshot } from "./contracts.js";
+import { IR11sResponse } from "./restWrapper.js";
 
 /**
  * Interface to a generic Git provider

package/src/summaryTreeUploadManager.ts

@@ -3,8 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { gitHashFile, IsoBuffer, Uint8ArrayToString } from "@fluid-internal/client-utils";
-import { assert, unreachableCase } from "@fluidframework/core-utils";
+import { IsoBuffer, Uint8ArrayToString, gitHashFile } from "@fluid-internal/client-utils";
+import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
 import { ICreateTreeEntry } from "@fluidframework/gitresources";
 import { getGitMode, getGitType } from "@fluidframework/protocol-base";
 import {
@@ -14,7 +14,8 @@ import {
 	SummaryType,
 } from "@fluidframework/protocol-definitions";
 import { IWholeSummaryPayloadType } from "@fluidframework/server-services-client";
-import { IGitManager, ISummaryUploadManager } from "./storageContracts";
+
+import { IGitManager, ISummaryUploadManager } from "./storageContracts.js";
 
 /**
  * Recursively writes summary tree as individual summary blobs.

package/src/treeUtils.ts

@@ -4,14 +4,15 @@
  */
 
 import { IsoBuffer } from "@fluid-internal/client-utils";
-import { assert } from "@fluidframework/core-utils";
+import { assert } from "@fluidframework/core-utils/internal";
 import {
-	SummaryType,
 	ISnapshotTree,
 	ISummaryTree,
 	SummaryObject,
+	SummaryType,
 } from "@fluidframework/protocol-definitions";
-import { INormalizedWholeSnapshot } from "./contracts";
+
+import { INormalizedWholeSnapshot } from "./contracts.js";
 
 /**
  * Summary tree assembler props

package/src/urlUtils.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { IResolvedUrl } from "@fluidframework/driver-definitions";
+import { IResolvedUrl } from "@fluidframework/driver-definitions/internal";
 import { ISession } from "@fluidframework/server-services-client";
 
 /**

package/src/wholeSummaryDocumentStorageService.ts

@@ -3,20 +3,14 @@
  * Licensed under the MIT License.
  */
 
-import {
-	ITelemetryLoggerExt,
-	MonitoringContext,
-	PerformanceEvent,
-	createChildMonitoringContext,
-} from "@fluidframework/telemetry-utils";
-import { performance, stringToBuffer, Uint8ArrayToString } from "@fluid-internal/client-utils";
-import { assert } from "@fluidframework/core-utils";
-import { getW3CData, promiseRaceWithWinner } from "@fluidframework/driver-base";
+import { Uint8ArrayToString, performance, stringToBuffer } from "@fluid-internal/client-utils";
+import { assert } from "@fluidframework/core-utils/internal";
+import { getW3CData, promiseRaceWithWinner } from "@fluidframework/driver-base/internal";
 import {
 	IDocumentStorageService,
-	ISummaryContext,
 	IDocumentStorageServicePolicies,
-} from "@fluidframework/driver-definitions";
+	ISummaryContext,
+} from "@fluidframework/driver-definitions/internal";
 import {
 	ICreateBlobResponse,
 	ISnapshotTree,
@@ -24,19 +18,26 @@ import {
 	ISummaryTree,
 	IVersion,
 } from "@fluidframework/protocol-definitions";
-import { ICache, InMemoryCache } from "./cache";
-import { IRouterliciousDriverPolicies } from "./policies";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+import {
+	MonitoringContext,
+	PerformanceEvent,
+	createChildMonitoringContext,
+} from "@fluidframework/telemetry-utils/internal";
+
+import { ICache, InMemoryCache } from "./cache.js";
+import { INormalizedWholeSnapshot, IWholeFlatSnapshot } from "./contracts.js";
+import { GitManager } from "./gitManager.js";
+import { IRouterliciousDriverPolicies } from "./policies.js";
+import { convertWholeFlatSnapshotToSnapshotTreeAndBlobs } from "./r11sSnapshotParser.js";
+import { IR11sResponse } from "./restWrapper.js";
+import { ISummaryUploadManager } from "./storageContracts.js";
 import {
 	convertSnapshotAndBlobsToSummaryTree,
 	evalBlobsAndTrees,
 	validateBlobsAndTrees,
-} from "./treeUtils";
-import { GitManager } from "./gitManager";
-import { WholeSummaryUploadManager } from "./wholeSummaryUploadManager";
-import { ISummaryUploadManager } from "./storageContracts";
-import { IR11sResponse } from "./restWrapper";
-import { INormalizedWholeSnapshot, IWholeFlatSnapshot } from "./contracts";
-import { convertWholeFlatSnapshotToSnapshotTreeAndBlobs } from "./r11sSnapshotParser";
+} from "./treeUtils.js";
+import { WholeSummaryUploadManager } from "./wholeSummaryUploadManager.js";
 
 const latestSnapshotId: string = "latest";
 

package/src/wholeSummaryUploadManager.ts

@@ -9,7 +9,8 @@ import {
 	IWholeSummaryPayloadType,
 	convertSummaryTreeToWholeSummaryTree,
 } from "@fluidframework/server-services-client";
-import { IGitManager, ISummaryUploadManager } from "./storageContracts";
+
+import { IGitManager, ISummaryUploadManager } from "./storageContracts.js";
 
 /**
  * Converts summary to snapshot tree and uploads with single snaphot tree payload.

package/tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+	// This config must be used in a "type": "commonjs" environment. (Use fluid-tsc commonjs.)
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"outDir": "./dist",
+	},
+}

package/tsconfig.json

@@ -1,12 +1,9 @@
 {
-	"extends": [
-		"../../../common/build/build-common/tsconfig.base.json",
-		"../../../common/build/build-common/tsconfig.cjs.json",
-	],
+	"extends": "../../../common/build/build-common/tsconfig.node16.json",
 	"include": ["src/**/*"],
 	"exclude": ["src/test/**/*"],
 	"compilerOptions": {
 		"rootDir": "./src",
-		"outDir": "./dist",
+		"outDir": "./lib",
 	},
 }

package/api-extractor-esm.json

@@ -1,4 +0,0 @@
-{
-	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-base-esm.json"
-}

package/dist/routerlicious-driver-alpha.d.ts

@@ -1,113 +0,0 @@
-import { IDocumentService } from '@fluidframework/driver-definitions';
-import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
-import { IResolvedUrl } from '@fluidframework/driver-definitions';
-import { ISession } from '@fluidframework/server-services-client';
-import { ISummaryTree } from '@fluidframework/protocol-definitions';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITokenClaims } from '@fluidframework/protocol-definitions';
-
-/* Excluded from this release type: DefaultTokenProvider */
-
-/* Excluded from this release type: DocumentPostCreateError */
-
-/* Excluded from this release type: IRouterliciousDriverPolicies */
-
-/**
- * Routerlicious extends the resolved url with additional properties to control Routerlicious-specific behaviors.
- *
- * @privateRemarks
- * {@link isRouterliciousResolvedUrl} can be used to detect whether an {@link @fluidframework/driver-definitions#IResolvedUrl}
- * is an IRouterliciousResolvedUrl.
- *
- * @alpha
- */
-export declare interface IRouterliciousResolvedUrl extends IResolvedUrl {
-    /**
-     * A flag to facilitate type narrowing from {@link @fluidframework/driver-definitions#IResolvedUrl} to IRouterliciousResolvedUrl.
-     */
-    routerliciousResolvedUrl: true;
-    /**
-     * Controls whether a newly created container will be ephemeral, which means the service will not retain it
-     * after the collaboration session ends. Only affects
-     * {@link @fluidframework/driver-definitions#IDocumentServiceFactory.createContainer} requests.
-     *
-     * @defaultValue If left undefined, treated as `false`
-     */
-    createAsEphemeral?: boolean;
-}
-
-/**
- * Abstracts the token fetching mechanism for a hosting application.
- * The hosting application is responsible for providing an implementation.
- * @public
- */
-export declare interface ITokenProvider {
-    /**
-     * Fetches the orderer token from host.
-     *
-     * @param tenantId - Tenant ID.
-     * @param documentId - Optional. Document ID is only required for document-scoped requests.
-     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
-     * This likely indicates that some previous request failed authorization due to an expired token,
-     * and so a fresh token is required.
-     *
-     * Default: `false`.
-     *
-     * NOTE: This parameter will be made required in the future.
-     */
-    fetchOrdererToken(tenantId: string, documentId?: string, refresh?: boolean): Promise<ITokenResponse>;
-    /**
-     * Fetches the storage token from host.
-     *
-     * @param tenantId - Tenant ID.
-     * @param documentId - Document ID.
-     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
-     * This likely indicates that some previous request failed authorization due to an expired token,
-     * and so a fresh token is required.
-     *
-     * Default: `false`.
-     *
-     * NOTE: This parameter will be made required in the future.
-     */
-    fetchStorageToken(tenantId: string, documentId: string, refresh?: boolean): Promise<ITokenResponse>;
-    /**
-     * A callback triggered directly after creating the document. In this callback the client has the opportunity, to
-     * verify against an authorization service, if the user who claims to create the document is the same user who
-     * created it.
-     *
-     * @remarks Notes:
-     *
-     * * Using the callback may have performance impact on the document creation process.
-     *
-     * * Any exceptions thrown in the callback would fail the creation workflow.
-     *
-     * @param documentId - Document ID.
-     * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload
-     * and document id. It can be used to validate the identity of the document creator.
-     */
-    documentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;
-}
-
-/**
- * @public
- */
-export declare interface ITokenResponse {
-    /**
-     * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.
-     */
-    jwt: string;
-    /**
-     * A flag indicating whether token was obtained from local cache.
-     *
-     * @remarks `undefined` indicates that the source of the token could not be determined.
-     */
-    fromCache?: boolean;
-}
-
-/* Excluded from this release type: ITokenService */
-
-/* Excluded from this release type: RouterliciousDocumentServiceFactory */
-
-/* Excluded from this release type: RouterliciousErrorTypes */
-
-export { }

package/dist/routerlicious-driver-beta.d.ts

@@ -1,97 +0,0 @@
-import { IDocumentService } from '@fluidframework/driver-definitions';
-import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
-import { IResolvedUrl } from '@fluidframework/driver-definitions';
-import { ISession } from '@fluidframework/server-services-client';
-import { ISummaryTree } from '@fluidframework/protocol-definitions';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITokenClaims } from '@fluidframework/protocol-definitions';
-
-/* Excluded from this release type: DefaultTokenProvider */
-
-/* Excluded from this release type: DocumentPostCreateError */
-
-/* Excluded from this release type: IDocumentService */
-
-/* Excluded from this release type: IDocumentServiceFactory */
-
-/* Excluded from this release type: IResolvedUrl */
-
-/* Excluded from this release type: IRouterliciousDriverPolicies */
-
-/* Excluded from this release type: IRouterliciousResolvedUrl */
-
-/**
- * Abstracts the token fetching mechanism for a hosting application.
- * The hosting application is responsible for providing an implementation.
- * @public
- */
-export declare interface ITokenProvider {
-    /**
-     * Fetches the orderer token from host.
-     *
-     * @param tenantId - Tenant ID.
-     * @param documentId - Optional. Document ID is only required for document-scoped requests.
-     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
-     * This likely indicates that some previous request failed authorization due to an expired token,
-     * and so a fresh token is required.
-     *
-     * Default: `false`.
-     *
-     * NOTE: This parameter will be made required in the future.
-     */
-    fetchOrdererToken(tenantId: string, documentId?: string, refresh?: boolean): Promise<ITokenResponse>;
-    /**
-     * Fetches the storage token from host.
-     *
-     * @param tenantId - Tenant ID.
-     * @param documentId - Document ID.
-     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
-     * This likely indicates that some previous request failed authorization due to an expired token,
-     * and so a fresh token is required.
-     *
-     * Default: `false`.
-     *
-     * NOTE: This parameter will be made required in the future.
-     */
-    fetchStorageToken(tenantId: string, documentId: string, refresh?: boolean): Promise<ITokenResponse>;
-    /**
-     * A callback triggered directly after creating the document. In this callback the client has the opportunity, to
-     * verify against an authorization service, if the user who claims to create the document is the same user who
-     * created it.
-     *
-     * @remarks Notes:
-     *
-     * * Using the callback may have performance impact on the document creation process.
-     *
-     * * Any exceptions thrown in the callback would fail the creation workflow.
-     *
-     * @param documentId - Document ID.
-     * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload
-     * and document id. It can be used to validate the identity of the document creator.
-     */
-    documentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;
-}
-
-/**
- * @public
- */
-export declare interface ITokenResponse {
-    /**
-     * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.
-     */
-    jwt: string;
-    /**
-     * A flag indicating whether token was obtained from local cache.
-     *
-     * @remarks `undefined` indicates that the source of the token could not be determined.
-     */
-    fromCache?: boolean;
-}
-
-/* Excluded from this release type: ITokenService */
-
-/* Excluded from this release type: RouterliciousDocumentServiceFactory */
-
-/* Excluded from this release type: RouterliciousErrorTypes */
-
-export { }

package/dist/routerlicious-driver-public.d.ts

@@ -1,97 +0,0 @@
-import { IDocumentService } from '@fluidframework/driver-definitions';
-import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
-import { IResolvedUrl } from '@fluidframework/driver-definitions';
-import { ISession } from '@fluidframework/server-services-client';
-import { ISummaryTree } from '@fluidframework/protocol-definitions';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITokenClaims } from '@fluidframework/protocol-definitions';
-
-/* Excluded from this release type: DefaultTokenProvider */
-
-/* Excluded from this release type: DocumentPostCreateError */
-
-/* Excluded from this release type: IDocumentService */
-
-/* Excluded from this release type: IDocumentServiceFactory */
-
-/* Excluded from this release type: IResolvedUrl */
-
-/* Excluded from this release type: IRouterliciousDriverPolicies */
-
-/* Excluded from this release type: IRouterliciousResolvedUrl */
-
-/**
- * Abstracts the token fetching mechanism for a hosting application.
- * The hosting application is responsible for providing an implementation.
- * @public
- */
-export declare interface ITokenProvider {
-    /**
-     * Fetches the orderer token from host.
-     *
-     * @param tenantId - Tenant ID.
-     * @param documentId - Optional. Document ID is only required for document-scoped requests.
-     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
-     * This likely indicates that some previous request failed authorization due to an expired token,
-     * and so a fresh token is required.
-     *
-     * Default: `false`.
-     *
-     * NOTE: This parameter will be made required in the future.
-     */
-    fetchOrdererToken(tenantId: string, documentId?: string, refresh?: boolean): Promise<ITokenResponse>;
-    /**
-     * Fetches the storage token from host.
-     *
-     * @param tenantId - Tenant ID.
-     * @param documentId - Document ID.
-     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
-     * This likely indicates that some previous request failed authorization due to an expired token,
-     * and so a fresh token is required.
-     *
-     * Default: `false`.
-     *
-     * NOTE: This parameter will be made required in the future.
-     */
-    fetchStorageToken(tenantId: string, documentId: string, refresh?: boolean): Promise<ITokenResponse>;
-    /**
-     * A callback triggered directly after creating the document. In this callback the client has the opportunity, to
-     * verify against an authorization service, if the user who claims to create the document is the same user who
-     * created it.
-     *
-     * @remarks Notes:
-     *
-     * * Using the callback may have performance impact on the document creation process.
-     *
-     * * Any exceptions thrown in the callback would fail the creation workflow.
-     *
-     * @param documentId - Document ID.
-     * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload
-     * and document id. It can be used to validate the identity of the document creator.
-     */
-    documentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;
-}
-
-/**
- * @public
- */
-export declare interface ITokenResponse {
-    /**
-     * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.
-     */
-    jwt: string;
-    /**
-     * A flag indicating whether token was obtained from local cache.
-     *
-     * @remarks `undefined` indicates that the source of the token could not be determined.
-     */
-    fromCache?: boolean;
-}
-
-/* Excluded from this release type: ITokenService */
-
-/* Excluded from this release type: RouterliciousDocumentServiceFactory */
-
-/* Excluded from this release type: RouterliciousErrorTypes */
-
-export { }