@fluidframework/routerlicious-driver 2.0.0-dev-rc.3.0.0.254513 → 2.0.0-dev-rc.3.0.0.254866

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

@@ -1,260 +0,0 @@
-import { IDocumentService } from '@fluidframework/driver-definitions/internal';
-import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
-import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
-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';
-
-/**
- * Default token provider in case the host does not provide one. It simply caches the provided jwt and returns it back.
- * @internal
- */
-export declare class DefaultTokenProvider implements ITokenProvider {
-    private readonly jwt;
-    constructor(jwt: string);
-    fetchOrdererToken(): Promise<ITokenResponse>;
-    fetchStorageToken(): Promise<ITokenResponse>;
-}
-
-/**
- * Error returned by {@link RouterliciousDocumentServiceFactory.createContainer} when an error is thrown
- * in {@link ITokenProvider.documentPostCreateCallback}.
- * It is the consumer's responsibility to ensure that any state related to container creation is appropriately
- * cleaned up in the event of failure.
- * This includes the document itself, which will have been created by the time this error was thrown.
- *
- * @remarks TODO: examples of suggested actions for recovery.
- * - How would a user delete the created document?
- * - What would a retry pattern look like here?
- * @internal
- */
-export declare class DocumentPostCreateError extends Error {
-    /**
-     * Inner error being wrapped.
-     */
-    private readonly innerError;
-    constructor(
-    /**
-     * Inner error being wrapped.
-     */
-    innerError: Error);
-    readonly name = "DocumentPostCreateError";
-    get stack(): string | undefined;
-}
-
-/**
- * @internal
- */
-export declare interface IRouterliciousDriverPolicies {
-    /**
-     * Enable prefetching entire snapshot tree into memory before it is loaded by the runtime.
-     * Default: true
-     */
-    enablePrefetch: boolean;
-    /**
-     * Rate limit concurrent storage requests.
-     * Default: 100
-     */
-    maxConcurrentStorageRequests: number;
-    /**
-     * Rate limit concurrent orderer requests.
-     * Default: 100
-     */
-    maxConcurrentOrdererRequests: number;
-    /**
-     * Enable uploading entire summary tree as a IWholeSummaryPayload to storage.
-     * Default: false
-     */
-    enableWholeSummaryUpload: boolean;
-    /**
-     * Enable service endpoint discovery when creating or joining a session.
-     * Default: false
-     */
-    enableDiscovery: boolean;
-    /**
-     * Enable using RestLess which avoids CORS preflight requests.
-     * Default: true
-     */
-    enableRestLess: boolean;
-    /**
-     * Enable internal cache of summaries/snapshots.
-     * Reduces Summarizer boot time and reduces server load in E2E tests.
-     * Default: true
-     */
-    enableInternalSummaryCaching: boolean;
-    /**
-     * Enable downgrading socket connection to long-polling
-     * when websocket connection cannot be established.
-     * Default: true
-     */
-    enableLongPollingDowngrade: boolean;
-}
-
-/**
- * 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;
-}
-
-/**
- * Abstracts the discovery of claims contained within a token.
- * @internal
- */
-export declare interface ITokenService {
-    /**
-     * Extracts the {@link @fluidframework/protocol-definitions#ITokenClaims | token claims} from the provided
-     * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} string representation.
-     */
-    extractClaims(token: string): ITokenClaims;
-}
-
-/**
- * Factory for creating the routerlicious document service. Use this if you want to
- * use the routerlicious implementation.
- * @internal
- */
-export declare class RouterliciousDocumentServiceFactory implements IDocumentServiceFactory {
-    private readonly tokenProvider;
-    private readonly driverPolicies;
-    private readonly blobCache;
-    private readonly wholeSnapshotTreeCache;
-    private readonly shreddedSummaryTreeCache;
-    constructor(tokenProvider: ITokenProvider, driverPolicies?: Partial<IRouterliciousDriverPolicies>);
-    /**
-     * {@inheritDoc @fluidframework/driver-definitions#IDocumentServiceFactory.createContainer}
-     *
-     * @throws {@link DocumentPostCreateError}
-         * If an exception is thrown while invoking the provided {@link ITokenProvider.documentPostCreateCallback}.
-         */
-     createContainer(createNewSummary: ISummaryTree | undefined, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-     /**
-      * {@inheritDoc @fluidframework/driver-definitions#IDocumentServiceFactory.createDocumentService}
-      *
-      * @returns Routerlicious document service.
-      */
-     createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean, session?: ISession): Promise<IDocumentService>;
-    }
-
-    /**
-     * Routerlicious Error types
-     * Different error types that may be thrown by the routerlicious driver
-     * @internal
-     */
-    export declare const RouterliciousErrorTypes: {
-        /**
-         * SSL Certificate Error.
-         */
-        readonly sslCertError: "sslCertError";
-        readonly genericNetworkError: "genericNetworkError";
-        readonly authorizationError: "authorizationError";
-        readonly fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError";
-        readonly offlineError: "offlineError";
-        readonly unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion";
-        readonly writeError: "writeError";
-        readonly fetchFailure: "fetchFailure";
-        readonly fetchTokenError: "fetchTokenError";
-        readonly incorrectServerResponse: "incorrectServerResponse";
-        readonly fileOverwrittenInStorage: "fileOverwrittenInStorage";
-        readonly deltaStreamConnectionForbidden: "deltaStreamConnectionForbidden";
-        readonly locationRedirection: "locationRedirection";
-        readonly fluidInvalidSchema: "fluidInvalidSchema";
-        readonly fileIsLocked: "fileIsLocked";
-        readonly outOfStorageError: "outOfStorageError";
-        readonly genericError: "genericError";
-        readonly throttlingError: "throttlingError";
-        readonly usageError: "usageError";
-    };
-
-    /**
-     * @internal
-     */
-    export declare type RouterliciousErrorTypes = (typeof RouterliciousErrorTypes)[keyof typeof RouterliciousErrorTypes];
-
-    export { }

package/dist/tsdoc-metadata.json

@@ -1,11 +0,0 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.42.3"
-    }
-  ]
-}

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

@@ -1,113 +0,0 @@
-import { IDocumentService } from '@fluidframework/driver-definitions/internal';
-import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
-import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
-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/lib/routerlicious-driver-beta.d.ts

@@ -1,97 +0,0 @@
-import { IDocumentService } from '@fluidframework/driver-definitions/internal';
-import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
-import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
-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/lib/routerlicious-driver-public.d.ts

@@ -1,97 +0,0 @@
-import { IDocumentService } from '@fluidframework/driver-definitions/internal';
-import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
-import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
-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 { }