ai/src/logger/deprecations.ts

AI SDK by Vercel - build apps like ChatGPT, Claude, Gemini, and more with a single interface for any model using the Vercel AI Gateway or go direct to OpenAI, Anthropic, Google, or any other model provider.

// These codes are stable identifiers. Do not rename or reuse an existing code.
const deprecationCodes = new Map<string, string>([
  ['generateObject', 'AISDK_DEP_GENERATE_OBJECT'],
  ['streamObject', 'AISDK_DEP_STREAM_OBJECT'],
  ['experimental_generateSpeech', 'AISDK_DEP_EXPERIMENTAL_GENERATE_SPEECH'],
  ['experimental_transcribe', 'AISDK_DEP_EXPERIMENTAL_TRANSCRIBE'],
  ['"image" content part', 'AISDK_DEP_IMAGE_CONTENT_PART'],
  [
    '"tool-result" content of type "file-data"',
    'AISDK_DEP_TOOL_RESULT_FILE_DATA',
  ],
  [
    '"tool-result" content of type "file-url"',
    'AISDK_DEP_TOOL_RESULT_FILE_URL',
  ],
  ['"tool-result" content of type "file-id"', 'AISDK_DEP_TOOL_RESULT_FILE_ID'],
  [
    '"tool-result" content of type "file-reference"',
    'AISDK_DEP_TOOL_RESULT_FILE_REFERENCE',
  ],
  [
    '"tool-result" content of type "image-data"',
    'AISDK_DEP_TOOL_RESULT_IMAGE_DATA',
  ],
  [
    '"tool-result" content of type "image-url"',
    'AISDK_DEP_TOOL_RESULT_IMAGE_URL',
  ],
  [
    '"tool-result" content of type "image-file-id"',
    'AISDK_DEP_TOOL_RESULT_IMAGE_FILE_ID',
  ],
  [
    '"tool-result" content of type "image-file-reference"',
    'AISDK_DEP_TOOL_RESULT_IMAGE_FILE_REFERENCE',
  ],
  [
    'rawInput in output-error UI message parts',
    'AISDK_DEP_UI_MESSAGE_RAW_INPUT',
  ],
]);

/**
 * Escape punctuation and UTF-16 code units without losing case or collapsing
 * distinct settings. Underscores are escaped too, so `__` separates code parts.
 */
function encodeCodePart(value: string): string {
  return value.replace(
    /[^a-zA-Z0-9]/g,
    character =>
      `_${character.charCodeAt(0).toString(16).toUpperCase().padStart(4, '0')}`,
  );
}

export function getDeprecationCode({
  setting,
  provider,
}: {
  setting: string;
  provider?: string;
}): string {
  if (provider == null) {
    return (
      deprecationCodes.get(setting) ??
      `AISDK_DEP_SETTING_${encodeCodePart(setting)}`
    );
  }

  // Provider codes are scoped to the provider, but not to a particular model or
  // message. This works for third-party providers without changing their spec.
  return `AISDK_DEP_PROVIDER_${encodeCodePart(provider)}__${encodeCodePart(setting)}`;
}