getSnapshotInfo

La función getSnapshotInfo devuelve el bloque meta del snapshot de contenido que el cliente tiene en disco.

Funciona en cualquier cliente, independientemente de su mode, por lo que incluso un cliente en modo 'api' que apunte a un snapshotPath puede informar sobre el snapshot que tiene en disco. Esto resulta útil para comprobaciones de actualidad — por ejemplo, registrar cuándo se generó el snapshot durante una build.

Ejemplo:

import { createClient } from '@content-island/api-client';

const client = createClient({
  accessToken: 'TU_TOKEN_DE_ACCESO',
  mode: 'snapshot',
});

const info = await client.getSnapshotInfo();
console.log(info);
/*
{
  schemaVersion: 1,
  exportedAt: '2026-06-18T09:12:43.000Z',
  projectId: '1',
  view: 'published',
}
*/

Consejo

Consulta la guía Modo snapshot para ver cómo se exportan y se sirven los snapshots.

Interfaz

La función getSnapshotInfo no acepta parámetros. Devuelve una promesa que se resuelve con el bloque meta del snapshot.

export interface ApiClient {
  getSnapshotInfo: () => Promise<SnapshotMeta>;
  // ... otros métodos
}

Carga el snapshot de forma diferida si aún no se ha leído. En un cliente sin un snapshotPath explícito, carga el snapshot por defecto en './content-island-snapshot.json' (resuelto en relación con el directorio de trabajo actual).

Salida

La función getSnapshotInfo devuelve el bloque meta del snapshot, que tiene la siguiente estructura:

interface SnapshotMeta {
  schemaVersion: number; // versión del esquema de snapshot soportada actualmente (p. ej. 1)
  exportedAt: string; // marca de tiempo ISO-8601 de cuándo se generó el snapshot
  projectId: string;
  view: 'published' | 'preview';
}

Si no existe un snapshot legible y válido en la ruta resuelta — el fichero no existe, no se puede leer, contiene un JSON inválido o tiene una schemaVersion no compatible — la llamada se rechaza con un ApiClientError tipado cuyo mensaje indica la ruta que intentó leer.