@osdk/aip-core 0.2.0

package/build/types/types.d.ts

@@ -0,0 +1,189 @@
+/**
+* Shared types for the AIP SDK's chat completion primitives.
+*/
+export type Role = "system" | "user" | "assistant" | "tool";
+export interface SystemModelMessage {
+	role: "system";
+	content: string;
+	providerOptions?: ProviderOptions;
+}
+export interface UserModelMessage {
+	role: "user";
+	content: string | Array<TextPart | ImagePart | FilePart>;
+	providerOptions?: ProviderOptions;
+}
+export interface AssistantModelMessage {
+	role: "assistant";
+	content: string | Array<TextPart | ReasoningPart | ToolCallPart | FilePart>;
+	providerOptions?: ProviderOptions;
+}
+export interface ToolModelMessage {
+	role: "tool";
+	content: Array<ToolResultPart>;
+	providerOptions?: ProviderOptions;
+}
+export type ModelMessage = SystemModelMessage | UserModelMessage | AssistantModelMessage | ToolModelMessage;
+export interface TextPart {
+	type: "text";
+	text: string;
+	providerOptions?: ProviderOptions;
+}
+export interface ReasoningPart {
+	type: "reasoning";
+	text: string;
+	providerOptions?: ProviderOptions;
+}
+export interface ImagePart {
+	type: "image";
+	/** Base64 string, data URL, ArrayBuffer, Uint8Array, or remote URL. */
+	image: string | Uint8Array | ArrayBuffer | URL;
+	mediaType?: string;
+	providerOptions?: ProviderOptions;
+}
+export interface FilePart {
+	type: "file";
+	data: string | Uint8Array | ArrayBuffer | URL;
+	mediaType: string;
+	filename?: string;
+	providerOptions?: ProviderOptions;
+}
+export interface ToolCallPart {
+	type: "tool-call";
+	toolCallId: string;
+	toolName: string;
+	input: unknown;
+	providerOptions?: ProviderOptions;
+}
+export interface ToolResultPart {
+	type: "tool-result";
+	toolCallId: string;
+	toolName: string;
+	output: ToolResultOutput;
+	providerOptions?: ProviderOptions;
+}
+export type ToolResultOutput = {
+	type: "text"
+	value: string
+} | {
+	type: "json"
+	value: unknown
+} | {
+	type: "error-text"
+	value: string
+} | {
+	type: "error-json"
+	value: unknown
+} | {
+	type: "content"
+	value: Array<{
+		type: "text"
+		text: string
+	} | {
+		type: "media"
+		data: string
+		mediaType: string
+	}>
+};
+/**
+* Tool definition.
+*
+* `inputSchema` is intentionally typed as `unknown` rather than a specific
+* schema library type — it can be a Zod schema, a JSON Schema object, or any
+* other validator the consumer supplies.
+*/
+export interface Tool {
+	description?: string;
+	inputSchema: unknown;
+	/** Provider-specific options, e.g. OpenAI strict mode. */
+	providerOptions?: ProviderOptions;
+}
+export type ToolSet = Record<string, Tool>;
+export type ToolChoice<TOOLS extends ToolSet = ToolSet> = "auto" | "none" | "required" | {
+	type: "tool"
+	toolName: keyof TOOLS & string
+};
+export interface ToolCall<
+	NAME extends string = string,
+	INPUT = unknown
+> {
+	type: "tool-call";
+	toolCallId: string;
+	toolName: NAME;
+	input: INPUT;
+	providerExecuted?: boolean;
+	providerMetadata?: ProviderMetadata;
+}
+export interface ToolResult<
+	NAME extends string = string,
+	INPUT = unknown,
+	OUTPUT = unknown
+> {
+	type: "tool-result";
+	toolCallId: string;
+	toolName: NAME;
+	input: INPUT;
+	output: OUTPUT;
+	providerMetadata?: ProviderMetadata;
+}
+export type FinishReason = "stop" | "length" | "content-filter" | "tool-calls" | "error" | "other";
+export interface LanguageModelUsage {
+	inputTokens: number | undefined;
+	outputTokens: number | undefined;
+	totalTokens: number | undefined;
+	reasoningTokens?: number;
+	cachedInputTokens?: number;
+}
+export interface ProviderMetadata {
+	[providerId: string]: Record<string, unknown>;
+}
+export type ProviderOptions = ProviderMetadata;
+export interface Warning {
+	type: "unsupported-tool" | "other";
+	details?: string;
+	message?: string;
+}
+export interface RequestMetadata {
+	body?: unknown;
+}
+export interface ResponseMetadata {
+	id?: string;
+	modelId?: string;
+	timestamp?: Date;
+	headers?: Record<string, string>;
+	body?: unknown;
+	/** Raw assistant messages emitted by the provider. */
+	messages?: Array<AssistantModelMessage | ToolModelMessage>;
+}
+export interface ReasoningOutput {
+	type: "reasoning";
+	text: string;
+	providerMetadata?: ProviderMetadata;
+}
+export type ContentPart<TOOLS extends ToolSet = ToolSet> = {
+	type: "text"
+	text: string
+	providerMetadata?: ProviderMetadata
+} | {
+	type: "reasoning"
+	text: string
+	providerMetadata?: ProviderMetadata
+} | (ToolCall<keyof TOOLS & string> & {
+	type: "tool-call"
+}) | (ToolResult<keyof TOOLS & string> & {
+	type: "tool-result"
+});
+export interface StepResult<TOOLS extends ToolSet = ToolSet> {
+	content: Array<ContentPart<TOOLS>>;
+	text: string;
+	reasoning: Array<ReasoningOutput>;
+	reasoningText: string | undefined;
+	toolCalls: Array<ToolCall<keyof TOOLS & string>>;
+	toolResults: Array<ToolResult<keyof TOOLS & string>>;
+	finishReason: FinishReason;
+	rawFinishReason: string | undefined;
+	usage: LanguageModelUsage;
+	warnings: Array<Warning> | undefined;
+	request?: RequestMetadata;
+	response?: ResponseMetadata;
+	providerMetadata: ProviderMetadata | undefined;
+}

package/build/types/types.d.ts.map

@@ -0,0 +1 @@
+{"mappings":";;;AAoBA,YAAY,OAAO,WAAW,SAAS,cAAc;AAErD,iBAAiB,mBAAmB;CAClC,MAAM;CACN;CACA,kBAAkB;AACnB;AAED,iBAAiB,iBAAiB;CAChC,MAAM;CACN,kBAAkB,MAAM,WAAW,YAAY;CAC/C,kBAAkB;AACnB;AAED,iBAAiB,sBAAsB;CACrC,MAAM;CACN,kBAEI,MAAM,WAAW,gBAAgB,eAAe;CACpD,kBAAkB;AACnB;AAED,iBAAiB,iBAAiB;CAChC,MAAM;CACN,SAAS,MAAM;CACf,kBAAkB;AACnB;AAED,YAAY,eACR,qBACA,mBACA,wBACA;AAEJ,iBAAiB,SAAS;CACxB,MAAM;CACN;CACA,kBAAkB;AACnB;AAED,iBAAiB,cAAc;CAC7B,MAAM;CACN;CACA,kBAAkB;AACnB;AAED,iBAAiB,UAAU;CACzB,MAAM;;CAEN,gBAAgB,aAAa,cAAc;CAC3C;CACA,kBAAkB;AACnB;AAED,iBAAiB,SAAS;CACxB,MAAM;CACN,eAAe,aAAa,cAAc;CAC1C;CACA;CACA,kBAAkB;AACnB;AAED,iBAAiB,aAAa;CAC5B,MAAM;CACN;CACA;CACA;CACA,kBAAkB;AACnB;AAED,iBAAiB,eAAe;CAC9B,MAAM;CACN;CACA;CACA,QAAQ;CACR,kBAAkB;AACnB;AAED,YAAY,mBACR;CAAE,MAAM;CAAQ;AAAe,IAC/B;CAAE,MAAM;CAAQ;AAAgB,IAChC;CAAE,MAAM;CAAc;AAAe,IACrC;CAAE,MAAM;CAAc;AAAgB,IACtC;CACA,MAAM;CACN,OAAO,MACH;EAAE,MAAM;EAAQ;CAAc,IAC9B;EAAE,MAAM;EAAS;EAAc;CAAmB;AAEvD;;;;;;;;AASH,iBAAiB,KAAK;CACpB;CACA;;CAEA,kBAAkB;AACnB;AAED,YAAY,UAAU,eAAe;AAErC,YAAY,WAAW,cAAc,UAAU,WAC3C,SACA,SACA,aACA;CAAE,MAAM;CAAQ,gBAAgB;AAAgB;AAEpD,iBAAiB;CAAS;CAA8B;EAAiB;CACvE,MAAM;CACN;CACA,UAAU;CACV,OAAO;CACP;CACA,mBAAmB;AACpB;AAED,iBAAiB;CACf;CACA;CACA;EACA;CACA,MAAM;CACN;CACA,UAAU;CACV,OAAO;CACP,QAAQ;CACR,mBAAmB;AACpB;AAED,YAAY,eACR,SACA,WACA,mBACA,eACA,UACA;AAEJ,iBAAiB,mBAAmB;CAClC;CACA;CACA;CACA;CACA;AACD;AAED,iBAAiB,iBAAiB;uBACV;AACvB;AAED,YAAY,kBAAkB;AAE9B,iBAAiB,QAAQ;CACvB,MAAM,qBAAqB;CAC3B;CACA;AACD;AAED,iBAAiB,gBAAgB;CAC/B;AACD;AAED,iBAAiB,iBAAiB;CAChC;CACA;CACA,YAAY;CACZ,UAAU;CACV;;CAEA,WAAW,MAAM,wBAAwB;AAC1C;AAED,iBAAiB,gBAAgB;CAC/B,MAAM;CACN;CACA,mBAAmB;AACpB;AAED,YAAY,YAAY,cAAc,UAAU,WAC5C;CAAE,MAAM;CAAQ;CAAc,mBAAmB;AAAkB,IACnE;CACA,MAAM;CACN;CACA,mBAAmB;AACpB,KACE,eAAe,kBAAkB;CAAE,MAAM;AAAa,MACtD,iBAAiB,kBAAkB;CAAE,MAAM;AAAe;AAE/D,iBAAiB,WAAW,cAAc,UAAU,SAAS;CAC3D,SAAS,MAAM,YAAY;CAC3B;CACA,WAAW,MAAM;CACjB;CACA,WAAW,MAAM,eAAe;CAChC,aAAa,MAAM,iBAAiB;CACpC,cAAc;CACd;CACA,OAAO;CACP,UAAU,MAAM;CAChB,UAAU;CACV,WAAW;CACX,kBAAkB;AACnB","names":[],"sources":["../../src/types.ts"],"version":3,"file":"types.d.ts"}

package/build/types/uiMessage.d.ts

@@ -0,0 +1,85 @@
+/**
+* UI-level message and stream-chunk shapes for the AIP SDK's chat
+* primitives. Describes the wire format that transports produce and UI
+* consumers read — a thin local subset of the AI SDK v5 UI types
+* covering the v0 text-only surface.
+*/
+import type { FinishReason, LanguageModelUsage } from "./types.js";
+export type UIMessageRole = "system" | "user" | "assistant";
+export type UIMessagePart = {
+	type: "text"
+	text: string
+} | {
+	type: "reasoning"
+	text: string
+} | {
+	type: "file"
+	url: string
+	mediaType: string
+};
+export interface UIMessage {
+	id: string;
+	role: UIMessageRole;
+	parts: Array<UIMessagePart>;
+	metadata?: Record<string, unknown>;
+}
+export type UIMessageChunk = {
+	type: "start"
+	messageId: string
+} | {
+	type: "start-step"
+} | {
+	type: "text-start"
+	id: string
+} | {
+	type: "text-delta"
+	id: string
+	delta: string
+} | {
+	type: "text-end"
+	id: string
+} | {
+	type: "reasoning-start"
+	id: string
+} | {
+	type: "reasoning-delta"
+	id: string
+	delta: string
+} | {
+	type: "reasoning-end"
+	id: string
+} | {
+	type: "tool-input-available"
+	toolCallId: string
+	toolName: string
+	input: unknown
+} | {
+	type: "finish-step"
+} | {
+	type: "finish"
+	messageMetadata?: {
+		finishReason?: FinishReason
+		usage?: LanguageModelUsage
+	}
+} | {
+	type: "error"
+	errorText: string
+};
+export type ChatTransportTrigger = "submit-message" | "regenerate-message";
+export interface ChatTransportSendMessagesArgs<MSG extends UIMessage> {
+	trigger: ChatTransportTrigger;
+	chatId: string;
+	messageId: string;
+	messages: ReadonlyArray<MSG>;
+	abortSignal: AbortSignal | undefined;
+	headers?: Record<string, string>;
+}
+export interface ChatTransportReconnectArgs {
+	chatId: string;
+}
+export interface ChatTransport<MSG extends UIMessage = UIMessage> {
+	sendMessages(args: ChatTransportSendMessagesArgs<MSG>): Promise<ReadableStream<UIMessageChunk>>;
+	reconnectToStream(args: ChatTransportReconnectArgs): Promise<ReadableStream<UIMessageChunk> | null>;
+}
+/** Concatenate all `text` parts of a UIMessage into a single string. */
+export declare function getUIMessageText(message: UIMessage): string;

package/build/types/uiMessage.d.ts.map

@@ -0,0 +1 @@
+{"mappings":";;;;;;AAuBA,cAAc,cAAc,0BAA0B,YAAa;AAEnE,YAAY,gBAAgB,WAAW,SAAS;AAEhD,YAAY,gBACR;CAAE,MAAM;CAAQ;AAAc,IAC9B;CAAE,MAAM;CAAa;AAAc,IACnC;CAAE,MAAM;CAAQ;CAAa;AAAmB;AAEpD,iBAAiB,UAAU;CACzB;CACA,MAAM;CACN,OAAO,MAAM;CACb,WAAW;AACZ;AAED,YAAY,iBACR;CAAE,MAAM;CAAS;AAAmB,IACpC;CAAE,MAAM;AAAc,IACtB;CAAE,MAAM;CAAc;AAAY,IAClC;CAAE,MAAM;CAAc;CAAY;AAAe,IACjD;CAAE,MAAM;CAAY;AAAY,IAChC;CAAE,MAAM;CAAmB;AAAY,IACvC;CAAE,MAAM;CAAmB;CAAY;AAAe,IACtD;CAAE,MAAM;CAAiB;AAAY,IACrC;CACA,MAAM;CACN;CACA;CACA;AACD,IACC;CAAE,MAAM;AAAe,IACvB;CACA,MAAM;CACN,kBAAkB;EAChB,eAAe;EACf,QAAQ;CACT;AACF,IACC;CAAE,MAAM;CAAS;AAAmB;AAExC,YAAY,uBAAuB,mBAAmB;AAEtD,iBAAiB,8BAA8B,YAAY,WAAW;CACpE,SAAS;CACT;CACA;CACA,UAAU,cAAc;CACxB,aAAa;CACb,UAAU;AACX;AAED,iBAAiB,2BAA2B;CAC1C;AACD;AAED,iBAAiB,cAAc,YAAY,YAAY,WAAW;CAChE,aACEA,MAAM,8BAA8B,OACnC,QAAQ,eAAe;CAE1B,kBACEC,MAAM,6BACL,QAAQ,eAAe;AAC3B;;AAGD,OAAO,iBAAS,iBAAiBC,SAAS","names":["args: ChatTransportSendMessagesArgs<MSG>","args: ChatTransportReconnectArgs","message: UIMessage"],"sources":["../../src/uiMessage.ts"],"version":3,"file":"uiMessage.d.ts"}

package/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "@osdk/aip-core",
+  "version": "0.2.0",
+  "description": "Core building blocks for the AIP SDK: streaming chat completions, tool calling, and chat transports backed by the Foundry Language Model Service",
+  "access": "public",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/palantir/osdk-ts.git"
+  },
+  "exports": {
+    ".": {
+      "browser": "./build/browser/index.js",
+      "import": {
+        "types": "./build/types/index.d.ts",
+        "default": "./build/esm/index.js"
+      },
+      "require": "./build/cjs/index.cjs",
+      "default": "./build/browser/index.js"
+    },
+    "./ai-sdk": {
+      "browser": "./build/browser/public/ai-sdk.js",
+      "import": {
+        "types": "./build/types/public/ai-sdk.d.ts",
+        "default": "./build/esm/public/ai-sdk.js"
+      },
+      "require": "./build/cjs/public/ai-sdk.cjs",
+      "default": "./build/browser/public/ai-sdk.js"
+    },
+    "./*": {
+      "browser": "./build/browser/public/*.js",
+      "import": {
+        "types": "./build/types/public/*.d.ts",
+        "default": "./build/esm/public/*.js"
+      },
+      "require": "./build/cjs/public/*.cjs",
+      "default": "./build/browser/public/*.js"
+    }
+  },
+  "scripts": {
+    "check-attw": "attw --pack .",
+    "check-spelling": "cspell --quiet .",
+    "clean": "rm -rf lib dist types build tsconfig.tsbuildinfo",
+    "fix-lint": "eslint . --fix && dprint fmt --config $(find-up dprint.json)",
+    "lint": "eslint . && dprint check  --config $(find-up dprint.json)",
+    "test": "vitest run --pool=forks",
+    "transpileBrowser": "monorepo.tool.transpile -f esm -m normal -t browser",
+    "transpileCjs": "monorepo.tool.transpile -f cjs -m bundle -t node",
+    "transpileEsm": "monorepo.tool.transpile -f esm -m normal -t node",
+    "transpileTypes": "monorepo.tool.transpile -f esm -m types -t node",
+    "typecheck": "tsc --noEmit --emitDeclarationOnly false"
+  },
+  "peerDependencies": {
+    "@ai-sdk/provider": "^3.0.0",
+    "@osdk/client": "workspace:^",
+    "@osdk/language-models": "workspace:^"
+  },
+  "peerDependenciesMeta": {
+    "@ai-sdk/provider": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@ai-sdk/provider": "^3.0.8",
+    "@osdk/monorepo.api-extractor": "workspace:~",
+    "@osdk/monorepo.tsconfig": "workspace:~",
+    "@types/node": "^18.19.0",
+    "typescript": "~5.5.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "build/cjs",
+    "build/esm",
+    "build/browser",
+    "build/types",
+    "CHANGELOG.md",
+    "package.json",
+    "templates",
+    "*.d.ts"
+  ],
+  "main": "./build/cjs/index.cjs",
+  "module": "./build/esm/index.js",
+  "types": "./build/cjs/index.d.cts",
+  "type": "module"
+}