Exportações do pacote

O Orbz separa o acesso puro à API, o registro protegido para navegador e o bundle independente para navegador. Todos os frameworks renderizam o elemento nativo <orb-z>.

Mapa de pontos de entrada

Os pontos de entrada de navegador e standalone são marcados no manifesto do pacote como tendo efeitos colaterais, para que os empacotadores preservem a chamada de registro.

react-types não contém um componente React nem um adaptador de runtime. Importe-o apenas em projetos TypeScript de React ou Next.js que precisem reconhecer <orb-z> no JSX.

Entrada principal

Use a entrada principal para registro explícito e tipos de domínio reutilizáveis:

import {
  DEFAULT_ORBZ_PRESET,
  defineOrbz,
  ORBZ_PRESETS,
  ORBZ_STATES,
  type OrbzElement,
  type OrbzPresetName,
  type OrbzState,
} from "@neongate-ai/orbz";
 
defineOrbz();
 
const nextState: OrbzState = "listening";
const preset: OrbzPresetName = DEFAULT_ORBZ_PRESET;
const colors = ORBZ_PRESETS[preset];
const orb = document.querySelector<OrbzElement>("orb-z");
 
if (orb) orb.state = nextState;

Importar apenas o módulo principal nunca registra orb-z. Chame defineOrbz() ou importe /browser quando a página precisar ativar a implementação da tag.

Constantes

Os arrays e registros de predefinições ajudam a gerar controles validados sem copiar os valores aceitos pelo pacote.

import { DEFAULT_ORBZ_PRESET, ORBZ_PRESET_NAMES, ORBZ_STATES } from "@neongate-ai/orbz";
 
for (const state of ORBZ_STATES) {
  stateSelect.add(new Option(state, state));
}
 
for (const preset of ORBZ_PRESET_NAMES) {
  const label = preset === DEFAULT_ORBZ_PRESET ? "Neongate" : preset;
  presetSelect.add(new Option(label, preset));
}

Tipos

Adaptadores de fala

OpenAISpeechAdapter usa gpt-4o-mini-tts, marin e MP3 por padrão. A chave da API da OpenAI permanece no endpoint e nunca é incluída no código do navegador.

Validadores e normalizadores

Normalize configurações não confiáveis antes de armazená-las:

import {
  normalizeOrbzPreset,
  normalizeOrbzSpeed,
  normalizeOrbzState,
} from "@neongate-ai/orbz";
 
const config = {
  preset: normalizeOrbzPreset(payload.preset),
  speed: normalizeOrbzSpeed(payload.speed),
  state: normalizeOrbzState(payload.state),
};

Funções de registro

defineOrbz() é a API habitual de registro explícito. É segura para SSR e idempotente:

import { defineOrbz } from "@neongate-ai/orbz";
 
const constructor = defineOrbz();

orbzElementClassFactory() cria e mantém a classe em cache somente quando globalThis.HTMLElement existe. Ela é exportada para integrações avançadas; a maioria das aplicações deve chamar defineOrbz().

import { orbzElementClassFactory } from '@neongate-ai/orbz'
 
const constructor = orbzElementClassFactory()
// undefined on a server; an OrbzElementConstructor in a browser

As duas funções evitam avaliar uma subclasse de HTMLElement quando o DOM não está disponível.

• Pacote no npm 
• Código-fonte no GitHub