@fluidframework/core-interfaces 0.43.1000-60718 → 1.0.0

package/api-report/core-interfaces.api.md

@@ -1,231 +0,0 @@
-## API Report File for "@fluidframework/core-interfaces"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-// Warning: (ae-incompatible-release-tags) The symbol "FluidObject" is marked as @public, but its signature references "FluidObjectProviderKeys" which is marked as @internal
-//
-// @public
-export type FluidObject<T = unknown> = {
-    readonly [P in FluidObjectProviderKeys<T>]?: T[P];
-};
-
-// @public
-export type FluidObjectKeys<T> = keyof FluidObject<T>;
-
-// Warning: (ae-internal-missing-underscore) The name "FluidObjectProviderKeys" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal
-export type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string extends TProp ? never : number extends TProp ? never : TProp extends keyof Required<T>[TProp] ? Required<T>[TProp] extends Required<Required<T>[TProp]>[TProp] ? TProp : never : never;
-
-// @public @deprecated (undocumented)
-export interface IFluidCodeDetails {
-    readonly config?: IFluidCodeDetailsConfig;
-    readonly package: string | Readonly<IFluidPackage>;
-}
-
-// @public @deprecated (undocumented)
-export const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer;
-
-// @public @deprecated (undocumented)
-export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
-    compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;
-    satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
-}
-
-// @public @deprecated (undocumented)
-export interface IFluidCodeDetailsConfig {
-    // (undocumented)
-    readonly [key: string]: string;
-}
-
-// @public (undocumented)
-export const IFluidHandle: keyof IProvideFluidHandle;
-
-// @public
-export interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
-    // @deprecated (undocumented)
-    readonly absolutePath: string;
-    attachGraph(): void;
-    bind(handle: IFluidHandle): void;
-    get(): Promise<T>;
-    readonly isAttached: boolean;
-}
-
-// @public (undocumented)
-export const IFluidHandleContext: keyof IProvideFluidHandleContext;
-
-// @public
-export interface IFluidHandleContext extends IProvideFluidHandleContext {
-    readonly absolutePath: string;
-    attachGraph(): void;
-    readonly isAttached: boolean;
-    // (undocumented)
-    resolveHandle(request: IRequest): Promise<IResponse>;
-    readonly routeContext?: IFluidHandleContext;
-}
-
-// @public (undocumented)
-export const IFluidLoadable: keyof IProvideFluidLoadable;
-
-// @public
-export interface IFluidLoadable extends IProvideFluidLoadable {
-    // (undocumented)
-    handle: IFluidHandle;
-}
-
-// @public @deprecated (undocumented)
-export interface IFluidObject {
-    // @deprecated (undocumented)
-    readonly IFluidHandle?: IFluidHandle;
-    // @deprecated (undocumented)
-    readonly IFluidHandleContext?: IFluidHandleContext;
-    // @deprecated (undocumented)
-    readonly IFluidLoadable?: IFluidLoadable;
-    // @deprecated (undocumented)
-    readonly IFluidRouter?: IFluidRouter;
-    // @deprecated (undocumented)
-    readonly IFluidRunnable?: IFluidRunnable;
-    // @deprecated (undocumented)
-    readonly IFluidSerializer?: IFluidSerializer;
-}
-
-// @public @deprecated (undocumented)
-export interface IFluidPackage {
-    [key: string]: unknown;
-    fluid: {
-        [environment: string]: undefined | IFluidPackageEnvironment;
-    };
-    name: string;
-}
-
-// @public @deprecated (undocumented)
-export interface IFluidPackageEnvironment {
-    [target: string]: undefined | {
-        files: string[];
-        [key: string]: unknown;
-    };
-}
-
-// @public (undocumented)
-export const IFluidRouter: keyof IProvideFluidRouter;
-
-// @public (undocumented)
-export interface IFluidRouter extends IProvideFluidRouter {
-    // (undocumented)
-    request(request: IRequest): Promise<IResponse>;
-}
-
-// @public (undocumented)
-export const IFluidRunnable: keyof IProvideFluidRunnable;
-
-// @public (undocumented)
-export interface IFluidRunnable {
-    // (undocumented)
-    run(...args: any[]): Promise<void>;
-    // (undocumented)
-    stop(reason?: string): void;
-}
-
-// @public @deprecated (undocumented)
-export const IFluidSerializer: keyof IProvideFluidSerializer;
-
-// @public @deprecated (undocumented)
-export interface IFluidSerializer extends IProvideFluidSerializer {
-    decode?(input: any): any;
-    parse(value: string): any;
-    replaceHandles(value: any, bind: IFluidHandle): any;
-    stringify(value: any, bind: IFluidHandle): string;
-}
-
-// @public @deprecated (undocumented)
-export interface IProvideFluidCodeDetailsComparer {
-    // (undocumented)
-    readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
-}
-
-// @public (undocumented)
-export interface IProvideFluidHandle {
-    // (undocumented)
-    readonly IFluidHandle: IFluidHandle;
-}
-
-// @public (undocumented)
-export interface IProvideFluidHandleContext {
-    // (undocumented)
-    readonly IFluidHandleContext: IFluidHandleContext;
-}
-
-// @public (undocumented)
-export interface IProvideFluidLoadable {
-    // (undocumented)
-    readonly IFluidLoadable: IFluidLoadable;
-}
-
-// @public
-export interface IProvideFluidRouter {
-    // (undocumented)
-    readonly IFluidRouter: IFluidRouter;
-}
-
-// @public (undocumented)
-export interface IProvideFluidRunnable {
-    // (undocumented)
-    readonly IFluidRunnable: IFluidRunnable;
-}
-
-// @public @deprecated (undocumented)
-export interface IProvideFluidSerializer {
-    // (undocumented)
-    readonly IFluidSerializer: IFluidSerializer;
-}
-
-// @public (undocumented)
-export interface IRequest {
-    // (undocumented)
-    headers?: IRequestHeader;
-    // (undocumented)
-    url: string;
-}
-
-// @public (undocumented)
-export interface IRequestHeader {
-    // (undocumented)
-    [index: string]: any;
-}
-
-// @public (undocumented)
-export interface IResponse {
-    // (undocumented)
-    headers?: {
-        [key: string]: any;
-    };
-    // (undocumented)
-    mimeType: string;
-    // (undocumented)
-    stack?: string;
-    // (undocumented)
-    status: number;
-    // (undocumented)
-    value: any;
-}
-
-// @public @deprecated
-export interface ISerializedHandle {
-    // (undocumented)
-    type: "__fluid_handle__";
-    // (undocumented)
-    url: string;
-}
-
-// @public @deprecated (undocumented)
-export const isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>;
-
-// @public @deprecated (undocumented)
-export const isFluidPackage: (pkg: any) => pkg is Readonly<IFluidPackage>;
-
-
-// (No @packageDocumentation comment for this package)
-
-```

package/dist/serializer.d.ts

@@ -1,56 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { IFluidHandle } from "./handles";
-/**
- * JSON serialized form of an IFluidHandle
- * @deprecated - Moved to fluidframework/shared-object-base package
- */
-export interface ISerializedHandle {
-    type: "__fluid_handle__";
-    url: string;
-}
-/**
- * @deprecated - Moved to fluidframework/shared-object-base package
- */
-export declare const IFluidSerializer: keyof IProvideFluidSerializer;
-/**
- * @deprecated - Moved to fluidframework/shared-object-base package
- */
-export interface IProvideFluidSerializer {
-    readonly IFluidSerializer: IFluidSerializer;
-}
-/**
- * @deprecated - Moved to fluidframework/shared-object-base package
- */
-export interface IFluidSerializer extends IProvideFluidSerializer {
-    /**
-     * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object
-     * where any embedded IFluidHandles have been replaced with a serializable form.
-     *
-     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from
-     * the root to any replaced handles.  (If no handles are found, returns the original object.)
-     */
-    replaceHandles(value: any, bind: IFluidHandle): any;
-    /**
-     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an
-     * equivalent object tree where any encoded IFluidHandles have been replaced with thier decoded form.
-     *
-     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from
-     * the root to any replaced handles.  (If no handles are found, returns the original object.)
-     *
-     * The decoded handles are implicitly bound to the handle context of this serializer.
-     */
-    decode?(input: any): any;
-    /**
-     * Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.
-     */
-    stringify(value: any, bind: IFluidHandle): string;
-    /**
-     * Parses the given JSON input string and returns the JavaScript object defined by it. Any Fluid
-     * handles will be realized as part of the parse
-     */
-    parse(value: string): any;
-}
-//# sourceMappingURL=serializer.d.ts.map

package/dist/serializer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"serializer.d.ts","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAE9B,IAAI,EAAE,kBAAkB,CAAC;IAGzB,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAAM,uBAA4C,CAAC;AAElF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,uBAAuB;IAC7D;;;;;;OAMG;IACH,cAAc,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,GAAG,CAAC;IAEpD;;;;;;;;OAQG;IACH,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,MAAM,CAAC;IAElD;;;OAGG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CAC7B"}

package/dist/serializer.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IFluidSerializer = void 0;
-/**
- * @deprecated - Moved to fluidframework/shared-object-base package
- */
-exports.IFluidSerializer = "IFluidSerializer";
-//# sourceMappingURL=serializer.js.map

package/dist/serializer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"serializer.js","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":";;;AAkBA;;GAEG;AACU,QAAA,gBAAgB,GAAkC,kBAAkB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IFluidHandle } from \"./handles\";\n\n/**\n * JSON serialized form of an IFluidHandle\n * @deprecated - Moved to fluidframework/shared-object-base package\n */\nexport interface ISerializedHandle {\n    // Marker to indicate to JSON.parse that the object is a Fluid handle\n    type: \"__fluid_handle__\";\n\n    // URL to the object. Relative URLs are relative to the handle context passed to the stringify.\n    url: string;\n}\n\n/**\n * @deprecated - Moved to fluidframework/shared-object-base package\n */\nexport const IFluidSerializer: keyof IProvideFluidSerializer = \"IFluidSerializer\";\n\n/**\n * @deprecated - Moved to fluidframework/shared-object-base package\n */\nexport interface IProvideFluidSerializer {\n    readonly IFluidSerializer: IFluidSerializer;\n}\n\n/**\n * @deprecated - Moved to fluidframework/shared-object-base package\n */\nexport interface IFluidSerializer extends IProvideFluidSerializer {\n    /**\n     * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object\n     * where any embedded IFluidHandles have been replaced with a serializable form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     */\n    replaceHandles(value: any, bind: IFluidHandle): any;\n\n    /**\n     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an\n     * equivalent object tree where any encoded IFluidHandles have been replaced with thier decoded form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     *\n     * The decoded handles are implicitly bound to the handle context of this serializer.\n     */\n    decode?(input: any): any;\n\n    /**\n     * Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.\n     */\n    stringify(value: any, bind: IFluidHandle): string;\n\n    /**\n     * Parses the given JSON input string and returns the JavaScript object defined by it. Any Fluid\n     * handles will be realized as part of the parse\n     */\n    parse(value: string): any;\n}\n"]}

package/lib/serializer.d.ts

@@ -1,56 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { IFluidHandle } from "./handles";
-/**
- * JSON serialized form of an IFluidHandle
- * @deprecated - Moved to fluidframework/shared-object-base package
- */
-export interface ISerializedHandle {
-    type: "__fluid_handle__";
-    url: string;
-}
-/**
- * @deprecated - Moved to fluidframework/shared-object-base package
- */
-export declare const IFluidSerializer: keyof IProvideFluidSerializer;
-/**
- * @deprecated - Moved to fluidframework/shared-object-base package
- */
-export interface IProvideFluidSerializer {
-    readonly IFluidSerializer: IFluidSerializer;
-}
-/**
- * @deprecated - Moved to fluidframework/shared-object-base package
- */
-export interface IFluidSerializer extends IProvideFluidSerializer {
-    /**
-     * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object
-     * where any embedded IFluidHandles have been replaced with a serializable form.
-     *
-     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from
-     * the root to any replaced handles.  (If no handles are found, returns the original object.)
-     */
-    replaceHandles(value: any, bind: IFluidHandle): any;
-    /**
-     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an
-     * equivalent object tree where any encoded IFluidHandles have been replaced with thier decoded form.
-     *
-     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from
-     * the root to any replaced handles.  (If no handles are found, returns the original object.)
-     *
-     * The decoded handles are implicitly bound to the handle context of this serializer.
-     */
-    decode?(input: any): any;
-    /**
-     * Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.
-     */
-    stringify(value: any, bind: IFluidHandle): string;
-    /**
-     * Parses the given JSON input string and returns the JavaScript object defined by it. Any Fluid
-     * handles will be realized as part of the parse
-     */
-    parse(value: string): any;
-}
-//# sourceMappingURL=serializer.d.ts.map

package/lib/serializer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"serializer.d.ts","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAE9B,IAAI,EAAE,kBAAkB,CAAC;IAGzB,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAAM,uBAA4C,CAAC;AAElF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,uBAAuB;IAC7D;;;;;;OAMG;IACH,cAAc,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,GAAG,CAAC;IAEpD;;;;;;;;OAQG;IACH,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,MAAM,CAAC;IAElD;;;OAGG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CAC7B"}

package/lib/serializer.js

@@ -1,5 +0,0 @@
-/**
- * @deprecated - Moved to fluidframework/shared-object-base package
- */
-export const IFluidSerializer = "IFluidSerializer";
-//# sourceMappingURL=serializer.js.map

package/lib/serializer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"serializer.js","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":"AAkBA;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAkC,kBAAkB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IFluidHandle } from \"./handles\";\n\n/**\n * JSON serialized form of an IFluidHandle\n * @deprecated - Moved to fluidframework/shared-object-base package\n */\nexport interface ISerializedHandle {\n    // Marker to indicate to JSON.parse that the object is a Fluid handle\n    type: \"__fluid_handle__\";\n\n    // URL to the object. Relative URLs are relative to the handle context passed to the stringify.\n    url: string;\n}\n\n/**\n * @deprecated - Moved to fluidframework/shared-object-base package\n */\nexport const IFluidSerializer: keyof IProvideFluidSerializer = \"IFluidSerializer\";\n\n/**\n * @deprecated - Moved to fluidframework/shared-object-base package\n */\nexport interface IProvideFluidSerializer {\n    readonly IFluidSerializer: IFluidSerializer;\n}\n\n/**\n * @deprecated - Moved to fluidframework/shared-object-base package\n */\nexport interface IFluidSerializer extends IProvideFluidSerializer {\n    /**\n     * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object\n     * where any embedded IFluidHandles have been replaced with a serializable form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     */\n    replaceHandles(value: any, bind: IFluidHandle): any;\n\n    /**\n     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an\n     * equivalent object tree where any encoded IFluidHandles have been replaced with thier decoded form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     *\n     * The decoded handles are implicitly bound to the handle context of this serializer.\n     */\n    decode?(input: any): any;\n\n    /**\n     * Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.\n     */\n    stringify(value: any, bind: IFluidHandle): string;\n\n    /**\n     * Parses the given JSON input string and returns the JavaScript object defined by it. Any Fluid\n     * handles will be realized as part of the parse\n     */\n    parse(value: string): any;\n}\n"]}

package/src/serializer.ts

@@ -1,65 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { IFluidHandle } from "./handles";
-
-/**
- * JSON serialized form of an IFluidHandle
- * @deprecated - Moved to fluidframework/shared-object-base package
- */
-export interface ISerializedHandle {
-    // Marker to indicate to JSON.parse that the object is a Fluid handle
-    type: "__fluid_handle__";
-
-    // URL to the object. Relative URLs are relative to the handle context passed to the stringify.
-    url: string;
-}
-
-/**
- * @deprecated - Moved to fluidframework/shared-object-base package
- */
-export const IFluidSerializer: keyof IProvideFluidSerializer = "IFluidSerializer";
-
-/**
- * @deprecated - Moved to fluidframework/shared-object-base package
- */
-export interface IProvideFluidSerializer {
-    readonly IFluidSerializer: IFluidSerializer;
-}
-
-/**
- * @deprecated - Moved to fluidframework/shared-object-base package
- */
-export interface IFluidSerializer extends IProvideFluidSerializer {
-    /**
-     * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object
-     * where any embedded IFluidHandles have been replaced with a serializable form.
-     *
-     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from
-     * the root to any replaced handles.  (If no handles are found, returns the original object.)
-     */
-    replaceHandles(value: any, bind: IFluidHandle): any;
-
-    /**
-     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an
-     * equivalent object tree where any encoded IFluidHandles have been replaced with thier decoded form.
-     *
-     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from
-     * the root to any replaced handles.  (If no handles are found, returns the original object.)
-     *
-     * The decoded handles are implicitly bound to the handle context of this serializer.
-     */
-    decode?(input: any): any;
-
-    /**
-     * Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.
-     */
-    stringify(value: any, bind: IFluidHandle): string;
-
-    /**
-     * Parses the given JSON input string and returns the JavaScript object defined by it. Any Fluid
-     * handles will be realized as part of the parse
-     */
-    parse(value: string): any;
-}