@fluidframework/odsp-driver-definitions 2.0.0-dev.7.4.0.215930 → 2.0.0-dev.7.4.0.217212

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/odsp-driver-definitions",
-  "version": "2.0.0-dev.7.4.0.215930",
+  "version": "2.0.0-dev.7.4.0.217212",
   "description": "Socket storage implementation for SPO and ODC",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -15,7 +15,7 @@
   "module": "lib/index.mjs",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.215930"
+    "@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.217212"
   },
   "devDependencies": {
     "@fluid-tools/build-cli": "^0.28.0",
@@ -58,12 +58,13 @@
     "build:docs": "fluid-build . --task api",
     "build:esnext": "tsc-multi --config ../../../common/build/build-common/tsc-multi.esm.json",
     "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",
     "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/errors.ts

@@ -11,6 +11,7 @@ import {
 /**
  * ODSP Error types.
  * Different error types that may be thrown by the ODSP driver.
+ * @internal
  */
 export const OdspErrorTypes = {
 	// Inherit base driver error types
@@ -60,6 +61,9 @@ export const OdspErrorTypes = {
 	 */
 	blockedIPAddress: "blockedIPAddress",
 } as const;
+/**
+ * @internal
+ */
 export type OdspErrorTypes = (typeof OdspErrorTypes)[keyof typeof OdspErrorTypes];
 
 /**
@@ -67,6 +71,7 @@ export type OdspErrorTypes = (typeof OdspErrorTypes)[keyof typeof OdspErrorTypes
  * Different error types that may be thrown by the ODSP driver.
  *
  * @deprecated Use {@link (OdspErrorTypes:variable)} instead.
+ * @internal
  */
 export enum OdspErrorType {
 	/**
@@ -124,6 +129,9 @@ export enum OdspErrorType {
 	blockedIPAddress = "blockedIPAddress",
 }
 
+/**
+ * @internal
+ */
 export interface IOdspErrorAugmentations {
 	/**
 	 * Server epoch indicates when the file was last modified.
@@ -146,9 +154,13 @@ export interface IOdspErrorAugmentations {
 /**
  * Base interface for all errors and warnings
  * Superset of IDriverErrorBase, but with Odsp-specific errorType and properties
+ * @internal
  */
 export interface IOdspError extends Omit<IDriverErrorBase, "errorType">, IOdspErrorAugmentations {
 	readonly errorType: OdspErrorType;
 }
 
+/**
+ * @internal
+ */
 export type OdspError = IOdspError | (DriverError & IOdspErrorAugmentations);

package/src/factory.ts

@@ -3,6 +3,9 @@
  * Licensed under the MIT License.
  */
 
+/**
+ * @internal
+ */
 export interface ISnapshotOptions {
 	blobs?: number;
 	deltas?: number;
@@ -22,6 +25,9 @@ export interface ISnapshotOptions {
 	timeout?: number;
 }
 
+/**
+ * @internal
+ */
 export interface IOpsCachingPolicy {
 	/**
 	 * Batch size. Controls how many ops are grouped together as single cache entry
@@ -50,6 +56,9 @@ export interface IOpsCachingPolicy {
 	totalOpsToCache?: number;
 }
 
+/**
+ * @internal
+ */
 export interface ICollabSessionOptions {
 	/**
 	 * Value indicating the display name for session that admits unauthenticated user.
@@ -69,6 +78,9 @@ export interface ICollabSessionOptions {
 	forceAccessTokenViaAuthorizationHeader?: boolean;
 }
 
+/**
+ * @internal
+ */
 export interface HostStoragePolicy {
 	snapshotOptions?: ISnapshotOptions;
 

package/src/odspCache.ts

@@ -7,8 +7,12 @@ import { IResolvedUrl } from "@fluidframework/driver-definitions";
 
 /**
  * Describes what kind of content is stored in cache entry.
+ * @internal
  */
 export const snapshotKey = "snapshot";
+/**
+ * @internal
+ */
 export type CacheContentType = "snapshot" | "ops";
 
 /*
@@ -16,6 +20,9 @@ export type CacheContentType = "snapshot" | "ops";
  * There is overlapping information here - host can use all of it or parts
  * to implement storage / identify files.
  */
+/**
+ * @internal
+ */
 export interface IFileEntry {
 	/**
 	 * Unique and stable ID of the document.
@@ -33,6 +40,7 @@ export interface IFileEntry {
 
 /**
  * Cache entry. Identifies file that this entry belongs to, and type of content stored in it.
+ * @internal
  */
 export interface IEntry {
 	/**
@@ -55,6 +63,7 @@ export interface IEntry {
 
 /**
  * Cache entry. Identifies file that this entry belongs to, and type of content stored in it.
+ * @internal
  */
 export interface ICacheEntry extends IEntry {
 	/**
@@ -69,6 +78,7 @@ export interface ICacheEntry extends IEntry {
  * cache implementation that does not survive across sessions. Snapshot entires stored in the
  * IPersistedCache will be considered stale and removed after 2 days. Read the README for more
  * information.
+ * @internal
  */
 export interface IPersistedCache {
 	/**
@@ -97,6 +107,7 @@ export interface IPersistedCache {
  * Api to generate a cache key from cache entry.
  * @param entry - cache entry from which a cache key is generated
  * @returns The key for cache.
+ * @internal
  */
 export function getKeyForCacheEntry(entry: ICacheEntry): string {
 	return `${entry.file.docId}_${entry.type}_${entry.key}`;

package/src/resolvedUrl.ts

@@ -5,6 +5,9 @@
 
 import { IResolvedUrl } from "@fluidframework/driver-definitions";
 
+/**
+ * @internal
+ */
 export interface IOdspUrlParts {
 	siteUrl: string;
 	driveId: string;
@@ -14,6 +17,7 @@ export interface IOdspUrlParts {
 /**
  * @deprecated Use ISharingLinkKind type instead.
  * Type of shareLink requested/created when creating the file for the first time.
+ * @internal
  */
 export enum ShareLinkTypes {
 	csl = "csl",
@@ -21,6 +25,7 @@ export enum ShareLinkTypes {
 
 /**
  * Sharing scope of the share links created for a file.
+ * @internal
  */
 export enum SharingLinkScope {
 	organization = "organization",
@@ -31,6 +36,7 @@ export enum SharingLinkScope {
 
 /**
  * View/edit permission role for a sharing link.
+ * @internal
  */
 export enum SharingLinkRole {
 	view = "view",
@@ -40,6 +46,7 @@ export enum SharingLinkRole {
 /**
  * Defines the permissions scope for a share link requested to be created during the creation the file in ODSP.
  * Providing these properties to the /snapshot api will also create and return the requested kind of sharing link.
+ * @internal
  */
 export interface ISharingLinkKind {
 	scope: SharingLinkScope;
@@ -52,6 +59,7 @@ export interface ISharingLinkKind {
 
 /**
  * Sharing link data received from the /snapshot api response.
+ * @internal
  */
 export interface ISharingLink extends ISharingLinkKind {
 	webUrl: string;
@@ -61,6 +69,7 @@ export interface ISharingLink extends ISharingLinkKind {
  * Sharing link data created for the ODSP item.
  * Contains information about either sharing link created while creating a new file or
  * a redeemable share link created when loading an existing file
+ * @internal
  */
 export interface ShareLinkInfoType {
 	/**
@@ -98,6 +107,9 @@ export interface ShareLinkInfoType {
 	 */
 	sharingLinkToRedeem?: string;
 }
+/**
+ * @internal
+ */
 export interface IOdspResolvedUrl extends IResolvedUrl, IOdspUrlParts {
 	type: "fluid";
 	odspResolvedUrl: true;

package/src/sessionProvider.ts

@@ -7,6 +7,7 @@ import { IResolvedUrl } from "@fluidframework/driver-definitions";
 
 /**
  * Socket storage discovery api response
+ * @internal
  */
 export interface ISocketStorageDiscovery {
 	// The id of the web socket
@@ -42,6 +43,7 @@ export interface ISocketStorageDiscovery {
 /**
  * An interface that allows a concrete instance of a driver factory to interrogate itself
  * to find out if it is session aware.
+ * @internal
  */
 export interface IProvideSessionAwareDriverFactory {
 	readonly IRelaySessionAwareDriverFactory: IRelaySessionAwareDriverFactory;
@@ -50,6 +52,7 @@ export interface IProvideSessionAwareDriverFactory {
 /**
  * An interface that allows a concrete instance of a driver factory to call the `getRelayServiceSessionInfo`
  * function if it session aware.
+ * @internal
  */
 export interface IRelaySessionAwareDriverFactory extends IProvideSessionAwareDriverFactory {
 	getRelayServiceSessionInfo(

package/src/tokenFetch.ts

@@ -5,6 +5,7 @@
 
 /**
  * Represents token response
+ * @internal
  */
 export interface TokenResponse {
 	/** Token value */
@@ -16,6 +17,7 @@ export interface TokenResponse {
 
 /**
  * Represents access token fetch options
+ * @internal
  */
 export interface TokenFetchOptions {
 	/**
@@ -40,6 +42,7 @@ export interface TokenFetchOptions {
 
 /**
  * Represents access token fetch options for ODSP resource
+ * @internal
  */
 export interface OdspResourceTokenFetchOptions extends TokenFetchOptions {
 	/** Site url representing ODSP resource location */
@@ -58,6 +61,7 @@ export interface OdspResourceTokenFetchOptions extends TokenFetchOptions {
  * @returns If successful, TokenResponse object representing token value along with flag indicating
  * whether token came from cache. Legacy implementation may return a string for token value;
  * in this case it should be assumes that fromCache signal is undefined. Null is returned in case of failure.
+ * @internal
  */
 export type TokenFetcher<T> = (options: T) => Promise<string | TokenResponse | null>;
 
@@ -65,6 +69,7 @@ export type TokenFetcher<T> = (options: T) => Promise<string | TokenResponse | n
  * Helper method which transforms return value for TokenFetcher method to token string
  * @param tokenResponse - return value for TokenFetcher method
  * @returns Token value
+ * @internal
  */
 export const tokenFromResponse = (
 	tokenResponse: string | TokenResponse | null | undefined,
@@ -80,6 +85,7 @@ export const tokenFromResponse = (
  * @param tokenResponse - return value for TokenFetcher method
  * @returns Value indicating whether response came from cache.
  * Undefined is returned when we could not determine the source of token.
+ * @internal
  */
 export const isTokenFromCache = (
 	tokenResponse: string | TokenResponse | null,
@@ -92,9 +98,13 @@ export const isTokenFromCache = (
  * Identity types supported by ODSP driver.
  * `Consumer` represents user authenticated with Microsoft Account (MSA).
  * `Enterprise` represents user authenticated with M365 tenant account.
+ * @internal
  */
 export type IdentityType = "Consumer" | "Enterprise";
 
+/**
+ * @internal
+ */
 export type InstrumentedStorageTokenFetcher = (
 	options: TokenFetchOptions,
 	name: string,