@fluidframework/routerlicious-driver 2.0.0-dev.7.4.0.215930 → 2.0.0-dev.7.4.0.216897

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

@@ -1,245 +1,31 @@
-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';
 
-/**
- * Default token provider in case the host does not provide one. It simply caches the provided jwt and returns it back.
- */
-export declare class DefaultTokenProvider implements ITokenProvider {
-    private readonly jwt;
-    constructor(jwt: string);
-    fetchOrdererToken(): Promise<ITokenResponse>;
-    fetchStorageToken(): Promise<ITokenResponse>;
-}
+/* Excluded from this release type: DefaultTokenProvider */
 
-/**
- * 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?
- */
-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;
-}
+/* Excluded from this release type: DocumentPostCreateError */
 
-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;
-    /**
-     * Indicates that the container is ephemeral.
-     * Artifacts relates to the container are limited to container lifetime.
-     * Default: false
-     */
-    isEphemeralContainer: boolean;
-}
+/* Excluded from this release type: IDocumentService */
 
-/**
- * Abstracts the token fetching mechanism for a hosting application.
- * The hosting application is responsible for providing an implementation.
- */
-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
-     * (see {@link RouterliciousDocumentServiceFactory.createContainer} for more details).
-     *
-     * @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>;
-}
+/* Excluded from this release type: IDocumentServiceFactory */
 
-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: IResolvedUrl */
 
-/**
- * Abstracts the discovery of claims contained within a token.
- */
-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;
-}
+/* Excluded from this release type: IRouterliciousDriverPolicies */
 
-/**
- * Factory for creating the routerlicious document service. Use this if you want to
- * use the routerlicious implementation.
- */
-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>;
-    }
+/* Excluded from this release type: ITelemetryBaseLogger */
 
-    /**
-     * Routerlicious Error types
-     * Different error types that may be thrown by the routerlicious driver
-     *
-     * @deprecated Use {@link (RouterliciousErrorTypes:variable)} instead.
-     */
-    export declare enum RouterliciousErrorType {
-        /**
-         * File not found, or file deleted during session
-         */
-        fileNotFoundOrAccessDeniedError = "fileNotFoundOrAccessDeniedError",
-        /**
-         * SSL Certificate Error.
-         */
-        sslCertError = "sslCertError"
-    }
+/* Excluded from this release type: ITokenProvider */
 
-    /**
-     * Routerlicious Error types
-     * Different error types that may be thrown by the routerlicious driver
-     */
-    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";
-    };
+/* Excluded from this release type: ITokenResponse */
 
-    export declare type RouterliciousErrorTypes = (typeof RouterliciousErrorTypes)[keyof typeof RouterliciousErrorTypes];
+/* Excluded from this release type: ITokenService */
 
-    export { }
+/* Excluded from this release type: RouterliciousDocumentServiceFactory */
+
+/* Excluded from this release type: RouterliciousErrorType */
+
+/* Excluded from this release type: RouterliciousErrorTypes */
+
+export { }

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

@@ -8,6 +8,7 @@ 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;
@@ -26,6 +27,7 @@ export declare class DefaultTokenProvider implements ITokenProvider {
  * @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 {
     /**
@@ -41,6 +43,9 @@ export declare class DocumentPostCreateError extends Error {
     get stack(): string | undefined;
 }
 
+/**
+ * @internal
+ */
 export declare interface IRouterliciousDriverPolicies {
     /**
      * Enable prefetching entire snapshot tree into memory before it is loaded by the runtime.
@@ -95,6 +100,7 @@ export declare interface IRouterliciousDriverPolicies {
 /**
  * Abstracts the token fetching mechanism for a hosting application.
  * The hosting application is responsible for providing an implementation.
+ * @internal
  */
 export declare interface ITokenProvider {
     /**
@@ -144,6 +150,9 @@ export declare interface ITokenProvider {
     documentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;
 }
 
+/**
+ * @internal
+ */
 export declare interface ITokenResponse {
     /**
      * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.
@@ -159,6 +168,7 @@ export declare interface ITokenResponse {
 
 /**
  * Abstracts the discovery of claims contained within a token.
+ * @internal
  */
 export declare interface ITokenService {
     /**
@@ -171,6 +181,7 @@ export declare interface ITokenService {
 /**
  * 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;
@@ -199,6 +210,7 @@ export declare class RouterliciousDocumentServiceFactory implements IDocumentSer
      * Different error types that may be thrown by the routerlicious driver
      *
      * @deprecated Use {@link (RouterliciousErrorTypes:variable)} instead.
+     * @internal
      */
     export declare enum RouterliciousErrorType {
         /**
@@ -214,6 +226,7 @@ export declare class RouterliciousDocumentServiceFactory implements IDocumentSer
     /**
      * Routerlicious Error types
      * Different error types that may be thrown by the routerlicious driver
+     * @internal
      */
     export declare const RouterliciousErrorTypes: {
         /**
@@ -224,6 +237,13 @@ export declare class RouterliciousDocumentServiceFactory implements IDocumentSer
         readonly authorizationError: "authorizationError";
         readonly fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError";
         readonly offlineError: "offlineError";
+        /**
+         * Routerlicious Error types
+         * Different error types that may be thrown by the routerlicious driver
+         *
+         * @deprecated Use {@link (RouterliciousErrorTypes:variable)} instead.
+         * @internal
+         */
         readonly unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion";
         readonly writeError: "writeError";
         readonly fetchFailure: "fetchFailure";
@@ -240,6 +260,9 @@ export declare class RouterliciousDocumentServiceFactory implements IDocumentSer
         readonly usageError: "usageError";
     };
 
+    /**
+     * @internal
+     */
     export declare type RouterliciousErrorTypes = (typeof RouterliciousErrorTypes)[keyof typeof RouterliciousErrorTypes];
 
     export { }

package/lib/tokens.d.ts

@@ -5,6 +5,7 @@
 import { ITokenClaims } from "@fluidframework/protocol-definitions";
 /**
  * Abstracts the discovery of claims contained within a token.
+ * @internal
  */
 export interface ITokenService {
     /**
@@ -13,6 +14,9 @@ export interface ITokenService {
      */
     extractClaims(token: string): ITokenClaims;
 }
+/**
+ * @internal
+ */
 export interface ITokenResponse {
     /**
      * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.
@@ -28,6 +32,7 @@ export interface ITokenResponse {
 /**
  * Abstracts the token fetching mechanism for a hosting application.
  * The hosting application is responsible for providing an implementation.
+ * @internal
  */
 export interface ITokenProvider {
     /**

package/lib/tokens.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B;;;OAGG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC;CAC3C;AAED,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAChB,QAAQ,EAAE,MAAM,EAChB,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAChB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;;;;;;;;;;;;;;OAeG;IACH,0BAA0B,CAAC,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtF"}
+{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAEpE;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B;;;OAGG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC9B;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAChB,QAAQ,EAAE,MAAM,EAChB,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAChB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;;;;;;;;;;;;;;OAeG;IACH,0BAA0B,CAAC,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtF"}

package/lib/tokens.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"tokens.mjs","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITokenClaims } from \"@fluidframework/protocol-definitions\";\n\n/**\n * Abstracts the discovery of claims contained within a token.\n */\nexport interface ITokenService {\n\t/**\n\t * Extracts the {@link @fluidframework/protocol-definitions#ITokenClaims | token claims} from the provided\n\t * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} string representation.\n\t */\n\textractClaims(token: string): ITokenClaims;\n}\n\nexport interface ITokenResponse {\n\t/**\n\t * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.\n\t */\n\tjwt: string;\n\n\t/**\n\t * A flag indicating whether token was obtained from local cache.\n\t *\n\t * @remarks `undefined` indicates that the source of the token could not be determined.\n\t */\n\tfromCache?: boolean;\n}\n\n/**\n * Abstracts the token fetching mechanism for a hosting application.\n * The hosting application is responsible for providing an implementation.\n */\nexport interface ITokenProvider {\n\t/**\n\t * Fetches the orderer token from host.\n\t *\n\t * @param tenantId - Tenant ID.\n\t * @param documentId - Optional. Document ID is only required for document-scoped requests.\n\t * @param refresh - Optional flag indicating whether token fetch must bypass local cache.\n\t * This likely indicates that some previous request failed authorization due to an expired token,\n\t * and so a fresh token is required.\n\t *\n\t * Default: `false`.\n\t *\n\t * NOTE: This parameter will be made required in the future.\n\t */\n\tfetchOrdererToken(\n\t\ttenantId: string,\n\t\tdocumentId?: string,\n\t\trefresh?: boolean,\n\t): Promise<ITokenResponse>;\n\n\t/**\n\t * Fetches the storage token from host.\n\t *\n\t * @param tenantId - Tenant ID.\n\t * @param documentId - Document ID.\n\t * @param refresh - Optional flag indicating whether token fetch must bypass local cache.\n\t * This likely indicates that some previous request failed authorization due to an expired token,\n\t * and so a fresh token is required.\n\t *\n\t * Default: `false`.\n\t *\n\t * NOTE: This parameter will be made required in the future.\n\t */\n\tfetchStorageToken(\n\t\ttenantId: string,\n\t\tdocumentId: string,\n\t\trefresh?: boolean,\n\t): Promise<ITokenResponse>;\n\n\t/**\n\t * A callback triggered directly after creating the document. In this callback the client has the opportunity, to\n\t * verify against an authorization service, if the user who claims to create the document is the same user who\n\t * created it.\n\t *\n\t * @remarks Notes:\n\t *\n\t * * Using the callback may have performance impact on the document creation process.\n\t *\n\t * * Any exceptions thrown in the callback would fail the creation workflow\n\t * (see {@link RouterliciousDocumentServiceFactory.createContainer} for more details).\n\t *\n\t * @param documentId - Document ID.\n\t * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload\n\t * and document id. It can be used to validate the identity of the document creator.\n\t */\n\tdocumentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;\n}\n"]}
+{"version":3,"file":"tokens.mjs","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITokenClaims } from \"@fluidframework/protocol-definitions\";\n\n/**\n * Abstracts the discovery of claims contained within a token.\n * @internal\n */\nexport interface ITokenService {\n\t/**\n\t * Extracts the {@link @fluidframework/protocol-definitions#ITokenClaims | token claims} from the provided\n\t * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} string representation.\n\t */\n\textractClaims(token: string): ITokenClaims;\n}\n\n/**\n * @internal\n */\nexport interface ITokenResponse {\n\t/**\n\t * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.\n\t */\n\tjwt: string;\n\n\t/**\n\t * A flag indicating whether token was obtained from local cache.\n\t *\n\t * @remarks `undefined` indicates that the source of the token could not be determined.\n\t */\n\tfromCache?: boolean;\n}\n\n/**\n * Abstracts the token fetching mechanism for a hosting application.\n * The hosting application is responsible for providing an implementation.\n * @internal\n */\nexport interface ITokenProvider {\n\t/**\n\t * Fetches the orderer token from host.\n\t *\n\t * @param tenantId - Tenant ID.\n\t * @param documentId - Optional. Document ID is only required for document-scoped requests.\n\t * @param refresh - Optional flag indicating whether token fetch must bypass local cache.\n\t * This likely indicates that some previous request failed authorization due to an expired token,\n\t * and so a fresh token is required.\n\t *\n\t * Default: `false`.\n\t *\n\t * NOTE: This parameter will be made required in the future.\n\t */\n\tfetchOrdererToken(\n\t\ttenantId: string,\n\t\tdocumentId?: string,\n\t\trefresh?: boolean,\n\t): Promise<ITokenResponse>;\n\n\t/**\n\t * Fetches the storage token from host.\n\t *\n\t * @param tenantId - Tenant ID.\n\t * @param documentId - Document ID.\n\t * @param refresh - Optional flag indicating whether token fetch must bypass local cache.\n\t * This likely indicates that some previous request failed authorization due to an expired token,\n\t * and so a fresh token is required.\n\t *\n\t * Default: `false`.\n\t *\n\t * NOTE: This parameter will be made required in the future.\n\t */\n\tfetchStorageToken(\n\t\ttenantId: string,\n\t\tdocumentId: string,\n\t\trefresh?: boolean,\n\t): Promise<ITokenResponse>;\n\n\t/**\n\t * A callback triggered directly after creating the document. In this callback the client has the opportunity, to\n\t * verify against an authorization service, if the user who claims to create the document is the same user who\n\t * created it.\n\t *\n\t * @remarks Notes:\n\t *\n\t * * Using the callback may have performance impact on the document creation process.\n\t *\n\t * * Any exceptions thrown in the callback would fail the creation workflow\n\t * (see {@link RouterliciousDocumentServiceFactory.createContainer} for more details).\n\t *\n\t * @param documentId - Document ID.\n\t * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload\n\t * and document id. It can be used to validate the identity of the document creator.\n\t */\n\tdocumentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/routerlicious-driver",
-  "version": "2.0.0-dev.7.4.0.215930",
+  "version": "2.0.0-dev.7.4.0.216897",
   "description": "Socket.IO + Git implementation of Fluid service API",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -47,17 +47,17 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/core-utils": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/driver-base": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/driver-utils": "2.0.0-dev.7.4.0.215930",
+    "@fluid-internal/client-utils": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/core-utils": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/driver-base": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/driver-utils": "2.0.0-dev.7.4.0.216897",
     "@fluidframework/gitresources": "^2.0.1",
     "@fluidframework/protocol-base": "^2.0.1",
     "@fluidframework/protocol-definitions": "^3.0.0",
     "@fluidframework/server-services-client": "^2.0.1",
-    "@fluidframework/telemetry-utils": "2.0.0-dev.7.4.0.215930",
+    "@fluidframework/telemetry-utils": "2.0.0-dev.7.4.0.216897",
     "cross-fetch": "^3.1.5",
     "json-stringify-safe": "5.0.1",
     "socket.io-client": "^4.6.1",
@@ -69,7 +69,7 @@
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.28.0",
     "@fluidframework/eslint-config-fluid": "^3.1.0",
-    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.4.0.215930",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.4.0.216897",
     "@fluidframework/routerlicious-driver-previous": "npm:@fluidframework/routerlicious-driver@2.0.0-internal.7.2.0",
     "@microsoft/api-extractor": "^7.38.3",
     "@types/mocha": "^9.1.1",
@@ -120,12 +120,13 @@
     "build:esnext": "tsc-multi --config ../../../common/build/build-common/tsc-multi.esm.json",
     "build:genver": "gen-version",
     "build:test": "tsc-multi --config ./tsc-multi.test.json",
+    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run prettier:fix",
-    "lint": "npm run prettier && npm run eslint",
+    "lint": "npm run prettier && npm run check:release-tags && npm run eslint",
     "lint:fix": "npm run prettier:fix && npm run eslint:fix",
     "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
     "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",

package/src/defaultTokenProvider.ts

@@ -7,6 +7,7 @@ import { ITokenProvider, ITokenResponse } from "./tokens";
 
 /**
  * Default token provider in case the host does not provide one. It simply caches the provided jwt and returns it back.
+ * @internal
  */
 
 export class DefaultTokenProvider implements ITokenProvider {

package/src/documentServiceFactory.ts

@@ -58,6 +58,7 @@ const defaultRouterliciousDriverPolicies: IRouterliciousDriverPolicies = {
 /**
  * Factory for creating the routerlicious document service. Use this if you want to
  * use the routerlicious implementation.
+ * @internal
  */
 export class RouterliciousDocumentServiceFactory implements IDocumentServiceFactory {
 	private readonly driverPolicies: IRouterliciousDriverPolicies;
@@ -376,6 +377,7 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
  * @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 class DocumentPostCreateError extends Error {
 	public constructor(

package/src/errorUtils.ts

@@ -20,6 +20,7 @@ import { pkgVersion as driverVersion } from "./packageVersion";
 /**
  * Routerlicious Error types
  * Different error types that may be thrown by the routerlicious driver
+ * @internal
  */
 export const RouterliciousErrorTypes = {
 	// Inherit base driver error types
@@ -30,6 +31,9 @@ export const RouterliciousErrorTypes = {
 	 */
 	sslCertError: "sslCertError",
 } as const;
+/**
+ * @internal
+ */
 export type RouterliciousErrorTypes =
 	(typeof RouterliciousErrorTypes)[keyof typeof RouterliciousErrorTypes];
 
@@ -38,6 +42,7 @@ export type RouterliciousErrorTypes =
  * Different error types that may be thrown by the routerlicious driver
  *
  * @deprecated Use {@link (RouterliciousErrorTypes:variable)} instead.
+ * @internal
  */
 export enum RouterliciousErrorType {
 	/**

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/routerlicious-driver";
-export const pkgVersion = "2.0.0-dev.7.4.0.215930";
+export const pkgVersion = "2.0.0-dev.7.4.0.216897";

package/src/policies.ts

@@ -3,6 +3,9 @@
  * Licensed under the MIT License.
  */
 
+/**
+ * @internal
+ */
 export interface IRouterliciousDriverPolicies {
 	/**
 	 * Enable prefetching entire snapshot tree into memory before it is loaded by the runtime.

package/src/tokens.ts

@@ -7,6 +7,7 @@ import { ITokenClaims } from "@fluidframework/protocol-definitions";
 
 /**
  * Abstracts the discovery of claims contained within a token.
+ * @internal
  */
 export interface ITokenService {
 	/**
@@ -16,6 +17,9 @@ export interface ITokenService {
 	extractClaims(token: string): ITokenClaims;
 }
 
+/**
+ * @internal
+ */
 export interface ITokenResponse {
 	/**
 	 * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.
@@ -33,6 +37,7 @@ export interface ITokenResponse {
 /**
  * Abstracts the token fetching mechanism for a hosting application.
  * The hosting application is responsible for providing an implementation.
+ * @internal
  */
 export interface ITokenProvider {
 	/**