@modelprofile.com/flexharness-providers 7.0.0

package/ts_media_openai/index.ts

@@ -0,0 +1,26 @@
+import * as plugins from './plugins.js';
+import { Readable } from 'node:stream';
+
+export interface IOpenAiTtsOptions {
+  apiKey: string;
+  text: string;
+  voice?: 'alloy' | 'echo' | 'fable' | 'onyx' | 'nova' | 'shimmer';
+  model?: 'tts-1' | 'tts-1-hd';
+  responseFormat?: 'mp3' | 'opus' | 'aac' | 'flac';
+  speed?: number;
+}
+
+export async function textToSpeech(options: IOpenAiTtsOptions): Promise<NodeJS.ReadableStream> {
+  const client = new plugins.OpenAI({ apiKey: options.apiKey });
+  const result = await client.audio.speech.create({
+    model: options.model ?? 'tts-1',
+    voice: options.voice ?? 'alloy',
+    input: options.text,
+    response_format: options.responseFormat ?? 'mp3',
+    speed: options.speed ?? 1,
+  });
+  const stream = result.body;
+  return Readable.fromWeb(stream as any);
+}
+
+export * from './image.js';

package/ts_media_openai/plugins.ts

@@ -0,0 +1,3 @@
+import OpenAI from 'openai';
+import { toFile } from 'openai';
+export { OpenAI, toFile };

package/ts_media_openai/readme.md

@@ -0,0 +1,37 @@
+OpenAI audio and image generation using the OpenAI client SDK.
+
+Part of the [FlexHarness toolbox](https://code.foss.global/modelprofile.com/flexharness).
+Install the components your project uses. Provider adapters are registered explicitly;
+the agent and harness do not install or register vendor SDKs.
+
+```sh
+pnpm add @modelprofile.com/flexharness-providers
+```
+
+See the [toolbox usage and migration guide](https://code.foss.global/modelprofile.com/flexharness#readme)
+for composition examples and the SmartAI/SmartAgent migration map.
+
+## Issue Reporting and Security
+
+Report issues and security concerns through [community.foss.global](https://community.foss.global).
+
+## License and Legal Information
+
+This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the repository license file.
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
+
+Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
+
+### Company Information
+
+Task Venture Capital GmbH<br>
+Registered at District Court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

package/ts_openai_account/index.ts

@@ -0,0 +1,11 @@
+export * from './smartai.providers.interfaces.js';
+export * from './smartai.providers.error.js';
+export * from './smartai.providers.credentials.js';
+export * from './smartai.providers.openai.js';
+export * from './smartai.providers.registry.js';
+export {
+  OPENAI_CHATGPT_AUTH_ISSUER,
+  OPENAI_CHATGPT_CLIENT_ID,
+  OPENAI_CHATGPT_CODEX_BASE_URL,
+  OPENAI_CHATGPT_DEFAULT_ORIGINATOR,
+} from '@modelprofile.com/flexharness-providers/auth';

package/ts_openai_account/plugins.ts

@@ -0,0 +1,9 @@
+// node native scope
+import * as crypto from 'node:crypto';
+import * as http from 'node:http';
+import { Buffer } from 'node:buffer';
+import type { Server } from 'node:http';
+import type { Socket } from 'node:net';
+
+export { Buffer, crypto, http };
+export type { Server, Socket };

package/ts_openai_account/readme.md

@@ -0,0 +1,37 @@
+OpenAI account lifecycle, authenticated model catalogs, rate limits and credential envelopes.
+
+Part of the [FlexHarness toolbox](https://code.foss.global/modelprofile.com/flexharness).
+Install the components your project uses. Provider adapters are registered explicitly;
+the agent and harness do not install or register vendor SDKs.
+
+```sh
+pnpm add @modelprofile.com/flexharness-providers
+```
+
+See the [toolbox usage and migration guide](https://code.foss.global/modelprofile.com/flexharness#readme)
+for composition examples and the SmartAI/SmartAgent migration map.
+
+## Issue Reporting and Security
+
+Report issues and security concerns through [community.foss.global](https://community.foss.global).
+
+## License and Legal Information
+
+This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the repository license file.
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
+
+Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
+
+### Company Information
+
+Task Venture Capital GmbH<br>
+Registered at District Court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

package/ts_openai_account/smartai.providers.credentials.ts

@@ -0,0 +1,163 @@
+import * as plugins from './plugins.js';
+import { parseOpenAiChatGptTokenInfo } from '@modelprofile.com/flexharness-providers/auth';
+import { createSmartAiProviderError } from './smartai.providers.error.js';
+import type { IOpenAiChatGptAuthCredentials } from '@modelprofile.com/flexharness-providers/auth';
+import type {
+  IOpenAiChatGptOAuthCredential,
+  TSmartAiProviderCredential,
+} from './smartai.providers.interfaces.js';
+
+export const providerCredentialEnvelopeVersion = 1 as const;
+export const providerCredentialEnvelopeMaxBytes = 16_384;
+
+interface IProviderCredentialEnvelopeV1 {
+  schemaVersion: typeof providerCredentialEnvelopeVersion;
+  credential: TSmartAiProviderCredential;
+}
+
+const isPlainObject = (valueArg: unknown): valueArg is Record<string, unknown> =>
+  typeof valueArg === 'object'
+  && valueArg !== null
+  && !Array.isArray(valueArg)
+  && (
+    Object.getPrototypeOf(valueArg) === Object.prototype
+    || Object.getPrototypeOf(valueArg) === null
+  );
+
+const hasExactKeys = (valueArg: Record<string, unknown>, keysArg: readonly string[]): boolean => {
+  const keys = Object.keys(valueArg);
+  return keys.length === keysArg.length && keysArg.every((key) => Object.hasOwn(valueArg, key));
+};
+
+const boundedString = (valueArg: unknown, maximumBytesArg: number): valueArg is string =>
+  typeof valueArg === 'string'
+  && valueArg.length > 0
+  && plugins.Buffer.byteLength(valueArg, 'utf8') <= maximumBytesArg;
+
+const parseOAuthCredential = (
+  valueArg: Record<string, unknown>,
+): IOpenAiChatGptOAuthCredential => {
+  const required = [
+    'kind',
+    'providerId',
+    'accessToken',
+    'refreshToken',
+    'idToken',
+  ];
+  const optional = ['lastRefreshAt'];
+  const keys = Object.keys(valueArg);
+  if (
+    !required.every((key) => Object.hasOwn(valueArg, key))
+    || keys.some((key) => !required.includes(key) && !optional.includes(key))
+    || valueArg.kind !== 'chatgptOAuth'
+    || valueArg.providerId !== 'openai'
+    || !boundedString(valueArg.accessToken, providerCredentialEnvelopeMaxBytes)
+    || !boundedString(valueArg.refreshToken, providerCredentialEnvelopeMaxBytes)
+    || !boundedString(valueArg.idToken, providerCredentialEnvelopeMaxBytes)
+    || (
+      valueArg.lastRefreshAt !== undefined
+      && (
+        !boundedString(valueArg.lastRefreshAt, 128)
+        || !Number.isFinite(Date.parse(valueArg.lastRefreshAt))
+      )
+    )
+  ) {
+    throw createSmartAiProviderError('CREDENTIAL_INVALID');
+  }
+  try {
+    parseOpenAiChatGptTokenInfo(valueArg.idToken);
+  } catch {
+    throw createSmartAiProviderError('CREDENTIAL_INVALID');
+  }
+  return {
+    kind: 'chatgptOAuth',
+    providerId: 'openai',
+    accessToken: valueArg.accessToken,
+    refreshToken: valueArg.refreshToken,
+    idToken: valueArg.idToken,
+    ...(typeof valueArg.lastRefreshAt === 'string'
+      ? { lastRefreshAt: valueArg.lastRefreshAt }
+      : {}),
+  };
+};
+
+const parseCredential = (valueArg: unknown): TSmartAiProviderCredential => {
+  if (!isPlainObject(valueArg)) throw createSmartAiProviderError('CREDENTIAL_INVALID');
+  if (valueArg.kind === 'apiKey') {
+    if (
+      !hasExactKeys(valueArg, ['kind', 'providerId', 'apiKey'])
+      || !boundedString(valueArg.providerId, 256)
+      || !boundedString(valueArg.apiKey, providerCredentialEnvelopeMaxBytes)
+    ) {
+      throw createSmartAiProviderError('CREDENTIAL_INVALID');
+    }
+    return { kind: 'apiKey', providerId: valueArg.providerId, apiKey: valueArg.apiKey };
+  }
+  return parseOAuthCredential(valueArg);
+};
+
+export const serializeProviderCredential = (
+  credentialArg: TSmartAiProviderCredential,
+): Uint8Array => {
+  const credential = parseCredential(credentialArg);
+  const envelope: IProviderCredentialEnvelopeV1 = {
+    schemaVersion: providerCredentialEnvelopeVersion,
+    credential,
+  };
+  const bytes = plugins.Buffer.from(JSON.stringify(envelope), 'utf8');
+  if (bytes.byteLength > providerCredentialEnvelopeMaxBytes) {
+    bytes.fill(0);
+    throw createSmartAiProviderError('CREDENTIAL_INVALID');
+  }
+  return Uint8Array.from(bytes);
+};
+
+export const parseProviderCredential = (
+  envelopeBytesArg: Uint8Array,
+): TSmartAiProviderCredential => {
+  if (
+    !(envelopeBytesArg instanceof Uint8Array)
+    || envelopeBytesArg.byteLength < 1
+    || envelopeBytesArg.byteLength > providerCredentialEnvelopeMaxBytes
+  ) {
+    throw createSmartAiProviderError('CREDENTIAL_INVALID');
+  }
+  const copiedBytes = plugins.Buffer.from(envelopeBytesArg);
+  let parsed: unknown;
+  try {
+    parsed = JSON.parse(copiedBytes.toString('utf8')) as unknown;
+  } catch {
+    throw createSmartAiProviderError('CREDENTIAL_INVALID');
+  } finally {
+    copiedBytes.fill(0);
+  }
+  if (
+    !isPlainObject(parsed)
+    || !hasExactKeys(parsed, ['schemaVersion', 'credential'])
+    || parsed.schemaVersion !== providerCredentialEnvelopeVersion
+  ) {
+    throw createSmartAiProviderError('CREDENTIAL_INVALID');
+  }
+  return parseCredential(parsed.credential);
+};
+
+export const toOpenAiChatGptAuthCredentials = (
+  credentialArg: IOpenAiChatGptOAuthCredential,
+): IOpenAiChatGptAuthCredentials => {
+  const credential = parseOAuthCredential(credentialArg as unknown as Record<string, unknown>);
+  let tokenInfo;
+  try {
+    tokenInfo = parseOpenAiChatGptTokenInfo(credential.idToken);
+  } catch {
+    throw createSmartAiProviderError('CREDENTIAL_INVALID');
+  }
+  return {
+    accessToken: credential.accessToken,
+    refreshToken: credential.refreshToken,
+    idToken: credential.idToken,
+    ...(tokenInfo.chatgptAccountId ? { accountId: tokenInfo.chatgptAccountId } : {}),
+    tokenInfo: {
+      ...tokenInfo,
+    },
+  };
+};

package/ts_openai_account/smartai.providers.error.ts

@@ -0,0 +1,49 @@
+export type TSmartAiProviderErrorCode =
+  | 'ABORTED'
+  | 'CLOSED'
+  | 'CREDENTIAL_INVALID'
+  | 'INVALID_ARGUMENT'
+  | 'LOGIN_BUSY'
+  | 'LOGIN_CANCELED'
+  | 'LOGIN_FAILED'
+  | 'MODEL_LIST_FAILED'
+  | 'NETWORK_FAILED'
+  | 'PROTOCOL_ERROR'
+  | 'REFRESH_FAILED'
+  | 'TIMEOUT';
+
+const codes = new Set<TSmartAiProviderErrorCode>([
+  'ABORTED',
+  'CLOSED',
+  'CREDENTIAL_INVALID',
+  'INVALID_ARGUMENT',
+  'LOGIN_BUSY',
+  'LOGIN_CANCELED',
+  'LOGIN_FAILED',
+  'MODEL_LIST_FAILED',
+  'NETWORK_FAILED',
+  'PROTOCOL_ERROR',
+  'REFRESH_FAILED',
+  'TIMEOUT',
+]);
+
+export class SmartAiProviderError extends Error {
+  public readonly code: TSmartAiProviderErrorCode;
+
+  constructor(codeArg: TSmartAiProviderErrorCode) {
+    const code = codes.has(codeArg) ? codeArg : 'PROTOCOL_ERROR';
+    super(`SmartAI provider operation failed (${code}).`);
+    this.name = 'SmartAiProviderError';
+    this.code = code;
+    Object.setPrototypeOf(this, new.target.prototype);
+    this.stack = `${this.name}: ${this.message}`;
+  }
+
+  public toJSON(): { name: string; code: TSmartAiProviderErrorCode; message: string } {
+    return { name: this.name, code: this.code, message: this.message };
+  }
+}
+
+export const createSmartAiProviderError = (
+  codeArg: TSmartAiProviderErrorCode,
+): SmartAiProviderError => new SmartAiProviderError(codeArg);

package/ts_openai_account/smartai.providers.interfaces.ts

@@ -0,0 +1,222 @@
+export type TSmartAiProviderId = string;
+export type TSmartAiProviderLoginFlow = 'browser' | 'device';
+export type TSmartAiProviderInputModality = 'text' | 'image' | 'audio';
+
+export interface ISmartAiProviderDescriptor {
+  providerId: TSmartAiProviderId;
+  displayName: string;
+  loginFlows: readonly TSmartAiProviderLoginFlow[];
+  supportsApiKey: boolean;
+}
+
+export interface ISmartAiProviderApiKeyCredential {
+  kind: 'apiKey';
+  providerId: TSmartAiProviderId;
+  apiKey: string;
+}
+
+export interface IOpenAiChatGptOAuthCredential {
+  kind: 'chatgptOAuth';
+  providerId: 'openai';
+  accessToken: string;
+  refreshToken: string;
+  idToken: string;
+  lastRefreshAt?: string;
+}
+
+export type TSmartAiProviderCredential =
+  | ISmartAiProviderApiKeyCredential
+  | IOpenAiChatGptOAuthCredential;
+
+export interface ISmartAiProviderAccountSummary {
+  providerId: TSmartAiProviderId;
+  authKind: TSmartAiProviderCredential['kind'];
+  accountId?: string;
+  email?: string;
+  plan?: string;
+}
+
+export interface ISmartAiProviderLoginResult {
+  credential: IOpenAiChatGptOAuthCredential;
+  account: ISmartAiProviderAccountSummary;
+}
+
+export interface ISmartAiProviderBrowserLoginPrompt {
+  flow: 'browser';
+  authUrl: string;
+}
+
+export interface ISmartAiProviderDeviceLoginPrompt {
+  flow: 'device';
+  verificationUrl: string;
+  userCode: string;
+}
+
+export type TSmartAiProviderLoginPrompt =
+  | ISmartAiProviderBrowserLoginPrompt
+  | ISmartAiProviderDeviceLoginPrompt;
+
+export type TSmartAiProviderCancelStatus = 'canceled' | 'notFound';
+
+export interface ISmartAiProviderLoginHandle {
+  readonly prompt: TSmartAiProviderLoginPrompt;
+  readonly completion: Promise<ISmartAiProviderLoginResult>;
+  cancel(): Promise<TSmartAiProviderCancelStatus>;
+  close(): Promise<void>;
+}
+
+export interface ISmartAiProviderOperationOptions {
+  signal?: AbortSignal;
+  timeoutMs?: number;
+}
+
+export interface ISmartAiProviderModelReasoningEffort {
+  effort: string;
+  description: string;
+}
+
+export interface ISmartAiProviderModelServiceTier {
+  id: string;
+  name: string;
+  description: string;
+}
+
+export interface ISmartAiProviderModel {
+  providerId: 'openai';
+  modelId: string;
+  wireModel: string;
+  displayName: string;
+  description: string;
+  hidden: boolean;
+  reasoningEfforts: ISmartAiProviderModelReasoningEffort[];
+  defaultReasoningEffort: string;
+  inputModalities: TSmartAiProviderInputModality[];
+  supportsPersonality: boolean;
+  serviceTiers: ISmartAiProviderModelServiceTier[];
+  defaultServiceTier?: string;
+  isDefault: boolean;
+}
+
+export interface ISmartAiProviderModelListOptions extends ISmartAiProviderOperationOptions {
+  cursor?: string;
+  limit?: number;
+  includeHidden?: boolean;
+}
+
+export type TSmartAiProviderCredentialOperationErrorCode =
+  | 'ABORTED'
+  | 'TIMEOUT';
+
+export interface ISmartAiProviderRefreshSuccess {
+  success: true;
+  credential: IOpenAiChatGptOAuthCredential;
+  account: ISmartAiProviderAccountSummary;
+}
+
+export interface ISmartAiProviderRefreshFailure {
+  success: false;
+  credential: IOpenAiChatGptOAuthCredential;
+  errorCode: TSmartAiProviderCredentialOperationErrorCode | 'REFRESH_FAILED';
+}
+
+export type TSmartAiProviderRefreshResult =
+  | ISmartAiProviderRefreshSuccess
+  | ISmartAiProviderRefreshFailure;
+
+export interface ISmartAiProviderModelListSuccess {
+  success: true;
+  models: ISmartAiProviderModel[];
+  nextCursor?: string;
+}
+
+export interface ISmartAiProviderModelListFailure {
+  success: false;
+  errorCode: TSmartAiProviderCredentialOperationErrorCode
+    | 'CREDENTIAL_REFRESH_REQUIRED'
+    | 'MODEL_LIST_FAILED';
+}
+
+export type TSmartAiProviderModelListResult =
+  | ISmartAiProviderModelListSuccess
+  | ISmartAiProviderModelListFailure;
+
+export interface ISmartAiProviderRateLimitWindow {
+  usedPercent: number;
+  limitWindowSeconds: number;
+  resetAfterSeconds: number;
+  /** Unix timestamp in seconds. */
+  resetsAt: number;
+}
+
+export interface ISmartAiProviderRateLimitDetails {
+  allowed: boolean;
+  limitReached: boolean;
+  primaryWindow?: ISmartAiProviderRateLimitWindow;
+  secondaryWindow?: ISmartAiProviderRateLimitWindow;
+}
+
+export interface ISmartAiProviderAdditionalRateLimit {
+  limitName: string;
+  meteredFeature: string;
+  rateLimit?: ISmartAiProviderRateLimitDetails;
+}
+
+export interface ISmartAiProviderAccountRateLimits {
+  providerId: 'openai';
+  plan: string;
+  observedAt: string;
+  rateLimit?: ISmartAiProviderRateLimitDetails;
+  additionalRateLimits: ISmartAiProviderAdditionalRateLimit[];
+  rateLimitReachedType?: string;
+  rateLimitResetCreditsAvailableCount?: number;
+}
+
+export interface ISmartAiProviderAccountRateLimitsSuccess {
+  success: true;
+  rateLimits: ISmartAiProviderAccountRateLimits;
+}
+
+export interface ISmartAiProviderAccountRateLimitsFailure {
+  success: false;
+  errorCode: TSmartAiProviderCredentialOperationErrorCode
+    | 'CREDENTIAL_REFRESH_REQUIRED'
+    | 'ACCOUNT_RATE_LIMITS_FAILED';
+}
+
+export type TSmartAiProviderAccountRateLimitsResult =
+  | ISmartAiProviderAccountRateLimitsSuccess
+  | ISmartAiProviderAccountRateLimitsFailure;
+
+export interface ISmartAiProviderLoginOptions extends ISmartAiProviderOperationOptions {
+  flow: TSmartAiProviderLoginFlow;
+}
+
+export interface ISmartAiProviderAdapter {
+  readonly descriptor: ISmartAiProviderDescriptor;
+  createApiKeyCredential(apiKey: string): ISmartAiProviderApiKeyCredential;
+  inspectCredential(credential: TSmartAiProviderCredential): ISmartAiProviderAccountSummary;
+  beginLogin(options: ISmartAiProviderLoginOptions): Promise<ISmartAiProviderLoginHandle>;
+  refreshCredential(
+    credential: IOpenAiChatGptOAuthCredential,
+    options?: ISmartAiProviderOperationOptions,
+  ): Promise<TSmartAiProviderRefreshResult>;
+  listModels(
+    credential: IOpenAiChatGptOAuthCredential,
+    options?: ISmartAiProviderModelListOptions,
+  ): Promise<TSmartAiProviderModelListResult>;
+  getAccountRateLimits(
+    credential: IOpenAiChatGptOAuthCredential,
+    options?: ISmartAiProviderOperationOptions,
+  ): Promise<TSmartAiProviderAccountRateLimitsResult>;
+  logoutCredential(
+    credential: IOpenAiChatGptOAuthCredential,
+    options?: ISmartAiProviderOperationOptions,
+  ): Promise<void>;
+  dispose(): Promise<void>;
+}
+
+export interface IOpenAiProviderAdapterOptions {
+  fetch?: typeof fetch;
+  originator?: string;
+  now?: () => Date;
+}