Skip to content

Commit

Permalink
adds new fluid-llm package
Browse files Browse the repository at this point in the history
  • Loading branch information
seanimam committed Aug 13, 2024
1 parent 09a9746 commit 6d1aeb2
Show file tree
Hide file tree
Showing 26 changed files with 709 additions and 51 deletions.
11 changes: 11 additions & 0 deletions experimental/framework/fluid-llm/.eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/*!
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
* Licensed under the MIT License.
*/

module.exports = {
extends: [require.resolve("@fluidframework/eslint-config-fluid/strict"), "prettier"],
parserOptions: {
project: ["./tsconfig.json", "./src/test/tsconfig.json"],
},
};
17 changes: 17 additions & 0 deletions experimental/framework/fluid-llm/.mocharc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/*!
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
* Licensed under the MIT License.
*/

"use strict";

const getFluidTestMochaConfig = require("@fluid-internal/mocha-test-setup/mocharc-common");

const packageDir = __dirname;
const config = getFluidTestMochaConfig(packageDir);
config.spec = process.env.MOCHA_SPEC ?? "lib/test";
// TODO: figure out why this package needs the --exit flag, tests might not be cleaning up correctly after themselves.
// AB#7856
config.exit = true;

module.exports = config;
6 changes: 6 additions & 0 deletions experimental/framework/fluid-llm/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
nyc
*.log
**/*.tsbuildinfo
src/test
dist/test
**/_api-extractor-temp/**
1 change: 1 addition & 0 deletions experimental/framework/fluid-llm/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# @fluid-experimental/fluid-llm
21 changes: 21 additions & 0 deletions experimental/framework/fluid-llm/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Copyright (c) Microsoft Corporation and contributors. All rights reserved.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
92 changes: 92 additions & 0 deletions experimental/framework/fluid-llm/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# @fluid-experimental/fluid-llm

Utilities for using SharedTree with LLM's.
This package aims to assist SharedTree based React apps using LLM's.


<!-- AUTO-GENERATED-CONTENT:START (README_FOOTER) -->

<!-- prettier-ignore-start -->
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->

## Minimum Client Requirements

These are the platform requirements for the current version of Fluid Framework Client Packages.
These requirements err on the side of being too strict since within a major version they can be relaxed over time, but not made stricter.
For Long Term Support (LTS) versions this can require supporting these platforms for several years.

It is likely that other configurations will work, but they are not supported: if they stop working, we do not consider that a bug.
If you would benefit from support for something not listed here, file an issue and the product team will evaluate your request.
When making such a request please include if the configuration already works (and thus the request is just that it becomes officially supported), or if changes are required to get it working.

### Supported Runtimes

- NodeJs ^20.10.0 except that we will drop support for it [when NodeJs 20 loses its upstream support on 2026-04-30](https://github.com/nodejs/release#release-schedule), and will support a newer LTS version of NodeJS (22) at least 1 year before 20 is end-of-life. This same policy applies to NodeJS 22 when it is end of life (2027-04-30).
- Modern browsers supporting the es2022 standard library: in response to asks we can add explicit support for using babel to polyfill to target specific standards or runtimes (meaning we can avoid/remove use of things that don't polyfill robustly, but otherwise target modern standards).

### Supported Tools

- TypeScript 5.4:
- All [`strict`](https://www.typescriptlang.org/tsconfig) options are supported.
- [`strictNullChecks`](https://www.typescriptlang.org/tsconfig) is required.
- [Configuration options deprecated in 5.0](https://github.com/microsoft/TypeScript/issues/51909) are not supported.
- `exactOptionalPropertyTypes` is currently not fully supported.
If used, narrowing members of Fluid Framework types types using `in`, `Reflect.has`, `Object.hasOwn` or `Object.prototype.hasOwnProperty` should be avoided as they may incorrectly exclude `undefined` from the possible values in some cases.
- [webpack](https://webpack.js.org/) 5
- We are not intending to be prescriptive about what bundler to use.
Other bundlers which can handle ES Modules should work, but webpack is the only one we actively test.

### Module Resolution

[`Node16`, `NodeNext`, or `Bundler`](https://www.typescriptlang.org/tsconfig#moduleResolution) resolution should be used with TypeScript compilerOptions to follow the [Node.js v12+ ESM Resolution and Loading algorithm](https://nodejs.github.io/nodejs.dev/en/api/v20/esm/#resolution-and-loading-algorithm).
Node10 resolution is not supported as it does not support Fluid Framework's API structuring pattern that is used to distinguish stable APIs from those that are in development.

### Module Formats

- ES Modules:
ES Modules are the preferred way to consume our client packages (including in NodeJs) and consuming our client packages from ES Modules is fully supported.
- CommonJs:
Consuming our client packages as CommonJs is supported only in NodeJS and only for the cases listed below.
This is done to accommodate some workflows without good ES Module support.
If you have a workflow you would like included in this list, file an issue.
Once this list of workflows motivating CommonJS support is empty, we may drop support for CommonJS one year after notice of the change is posted here.

- Testing with Jest (which lacks [stable ESM support](https://jestjs.io/docs/ecmascript-modules) due to [unstable APIs in NodeJs](https://github.com/nodejs/node/issues/37648))

## Contribution Guidelines

There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.

- Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
- [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
- Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).

Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.

## Help

Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).

Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).

Thank you!

## Trademark

This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.

Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).

Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.

<!-- prettier-ignore-end -->

<!-- AUTO-GENERATED-CONTENT:END -->
4 changes: 4 additions & 0 deletions experimental/framework/fluid-llm/api-extractor-lint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"extends": "../../../common/build/build-common/api-extractor-lint.esm.primary.json"
}
4 changes: 4 additions & 0 deletions experimental/framework/fluid-llm/api-extractor.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"extends": "../../../common/build/build-common/api-extractor-base.esm.no-legacy.json"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.json",
"mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
"mainEntryPointFilePath": "<projectFolder>/dist/public.d.ts"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
"mainEntryPointFilePath": "<projectFolder>/lib/public.d.ts"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## Alpha API Report File for "@fluid-experimental/tree-react-api"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts

// @public
export interface IReactTreeDataObject<TSchema extends ImplicitFieldSchema> extends ITreeDataObject<TSchema> {
readonly TreeViewComponent: (props: TreeViewProps<TSchema>) => React_2.JSX.Element;
}

// @public
export interface ITreeDataObject<TSchema extends ImplicitFieldSchema> {
readonly config: TreeViewConfiguration<TSchema>;
readonly key: string;
readonly tree: TreeView<TSchema>;
}

// @public
export interface SchemaIncompatibleProps {
readonly compatibility: SchemaCompatibilityStatus;
readonly upgradeSchema: () => void;
}

// @public
export function treeDataObject<TSchema extends ImplicitFieldSchema>(key: string, treeConfiguration: TreeViewConfiguration<TSchema>, createInitialTree: () => InsertableTreeFieldFromImplicitField<TSchema>): SharedObjectKind<IReactTreeDataObject<TSchema> & IFluidLoadable>;

// @public
export interface TreeViewProps<TSchema extends ImplicitFieldSchema> {
readonly errorComponent?: React_2.FC<SchemaIncompatibleProps>;
readonly viewComponent: React_2.FC<{
root: TreeFieldFromImplicitField<TSchema>;
}>;
}

// @public
export function useTree(subtreeRoot: TreeNode): void;

```
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## Beta API Report File for "@fluid-experimental/tree-react-api"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts

// @public
export interface IReactTreeDataObject<TSchema extends ImplicitFieldSchema> extends ITreeDataObject<TSchema> {
readonly TreeViewComponent: (props: TreeViewProps<TSchema>) => React_2.JSX.Element;
}

// @public
export interface ITreeDataObject<TSchema extends ImplicitFieldSchema> {
readonly config: TreeViewConfiguration<TSchema>;
readonly key: string;
readonly tree: TreeView<TSchema>;
}

// @public
export interface SchemaIncompatibleProps {
readonly compatibility: SchemaCompatibilityStatus;
readonly upgradeSchema: () => void;
}

// @public
export function treeDataObject<TSchema extends ImplicitFieldSchema>(key: string, treeConfiguration: TreeViewConfiguration<TSchema>, createInitialTree: () => InsertableTreeFieldFromImplicitField<TSchema>): SharedObjectKind<IReactTreeDataObject<TSchema> & IFluidLoadable>;

// @public
export interface TreeViewProps<TSchema extends ImplicitFieldSchema> {
readonly errorComponent?: React_2.FC<SchemaIncompatibleProps>;
readonly viewComponent: React_2.FC<{
root: TreeFieldFromImplicitField<TSchema>;
}>;
}

// @public
export function useTree(subtreeRoot: TreeNode): void;

```
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## Public API Report File for "@fluid-experimental/tree-react-api"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts

// @public
export interface IReactTreeDataObject<TSchema extends ImplicitFieldSchema> extends ITreeDataObject<TSchema> {
readonly TreeViewComponent: (props: TreeViewProps<TSchema>) => React_2.JSX.Element;
}

// @public
export interface ITreeDataObject<TSchema extends ImplicitFieldSchema> {
readonly config: TreeViewConfiguration<TSchema>;
readonly key: string;
readonly tree: TreeView<TSchema>;
}

// @public
export interface SchemaIncompatibleProps {
readonly compatibility: SchemaCompatibilityStatus;
readonly upgradeSchema: () => void;
}

// @public
export function treeDataObject<TSchema extends ImplicitFieldSchema>(key: string, treeConfiguration: TreeViewConfiguration<TSchema>, createInitialTree: () => InsertableTreeFieldFromImplicitField<TSchema>): SharedObjectKind<IReactTreeDataObject<TSchema> & IFluidLoadable>;

// @public
export interface TreeViewProps<TSchema extends ImplicitFieldSchema> {
readonly errorComponent?: React_2.FC<SchemaIncompatibleProps>;
readonly viewComponent: React_2.FC<{
root: TreeFieldFromImplicitField<TSchema>;
}>;
}

// @public
export function useTree(subtreeRoot: TreeNode): void;

```
4 changes: 4 additions & 0 deletions experimental/framework/fluid-llm/biome.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
"extends": ["../../../biome.jsonc"]
}
Loading

0 comments on commit 6d1aeb2

Please sign in to comment.