@fluidframework/ai-collab 2.10.0-306579

package/src/implicit-strategy/utils.ts

@@ -0,0 +1,54 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { type TreeMapNode, type TreeArrayNode, NodeKind } from "@fluidframework/tree";
+
+import type { ObjectPath } from "./sharedTreeDiff.js";
+
+/**
+ * Checks if the given object is an {@link TreeMapNode}.
+ */
+export function isTreeMapNode(obj: unknown): obj is TreeMapNode {
+	if (typeof obj === "object" && obj !== null) {
+		// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+		const maybeNodeKind: unknown = Object.getPrototypeOf(obj)?.constructor?.kind;
+		return maybeNodeKind === NodeKind.Map;
+	}
+	return false;
+}
+
+/**
+ * Checks if the given object is an {@link TreeArrayNode}.
+ */
+export function isTreeArrayNode(obj: unknown): obj is TreeArrayNode {
+	if (typeof obj === "object" && obj !== null) {
+		// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+		const maybeNodeKind: unknown = Object.getPrototypeOf(obj)?.constructor?.kind;
+		return maybeNodeKind === NodeKind.Array;
+	}
+	return false;
+}
+
+/**
+ * Traverses the provided {@link ObjectPath} on the provided Shared Tree or JSON object and returns the value at the end of the path.
+ *
+ * @alpha
+ */
+export function sharedTreeTraverse<T = unknown>(
+	jsonObject: TreeMapNode | TreeArrayNode | Record<string, unknown>,
+	path: ObjectPath,
+): T | undefined {
+	let current: unknown = jsonObject;
+
+	for (const key of path) {
+		if (current === undefined || current === null) {
+			return undefined;
+		}
+
+		current = isTreeMapNode(current) ? current.get(key as string) : current[key];
+	}
+
+	return current as T;
+}

package/src/index.ts

@@ -0,0 +1,39 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Experimental package for utilities that enable/simplify interaction with LLMs for apps based on SharedTree.
+ *
+ * See {@link https://github.com/microsoft/FluidFramework/tree/main/packages/framework/ai-collab#readme | README.md }
+ * for an overview of the package.
+ *
+ * @packageDocumentation
+ */
+
+export {
+	type DifferenceCreate,
+	type DifferenceChange,
+	type DifferenceMove,
+	type DifferenceRemove,
+	type Difference,
+	type ObjectPath,
+	type Options,
+	sharedTreeDiff,
+	createMergableIdDiffSeries,
+	createMergableDiffSeries,
+	SharedTreeBranchManager,
+	sharedTreeTraverse,
+} from "./implicit-strategy/index.js";
+
+export {
+	type AiCollabOptions,
+	type AiCollabSuccessResponse,
+	type AiCollabErrorResponse,
+	type TokenUsage,
+	type TokenLimits,
+	type OpenAiClientOptions,
+} from "./aiCollabApi.js";
+
+export { aiCollab } from "./aiCollab.js";

package/tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+	// This config must be used in a "type": "commonjs" environment. (Use `fluid-tsc commonjs`.)
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"outDir": "./dist",
+	},
+}

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+	"extends": "../../../common/build/build-common/tsconfig.node16.json",
+	"include": ["src/**/*"],
+	"exclude": ["src/test/**/*"],
+	"compilerOptions": {
+		"rootDir": "./src",
+		"outDir": "./lib",
+		// SharedTree seems to have issues with exactOptionalPropertyTypes: true. It has it set to false itself, and if it's
+		// not set to false here the build fails complaining about types in SharedTree's .d.ts files.
+		"exactOptionalPropertyTypes": false,
+	},
+}

package/tsdoc.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+	"extends": ["../../../common/build/build-common/tsdoc-base.json"]
+}