• Español

      • ctx.dataSource

      La instancia de la fuente de datos (DataSource) vinculada al contexto de ejecución actual de RunJS, utilizada para acceder a colecciones, metadatos de campos y gestionar la configuración de colecciones dentro de la fuente de datos actual. Generalmente corresponde a la fuente de datos seleccionada para la página o bloque actual (por ejemplo, la base de datos principal main).

      Escenarios de uso

      EscenarioDescripción
      Operaciones de una sola fuente de datosObtener metadatos de colecciones y campos cuando se conoce la fuente de datos actual.
      Gestión de coleccionesObtener, agregar, actualizar o eliminar colecciones bajo la fuente de datos actual.
      Obtener campos por rutaUtilizar el formato nombreColeccion.rutaCampo para obtener definiciones de campos (soporta rutas de asociación).

      Nota: ctx.dataSource representa una única fuente de datos para el contexto actual. Para enumerar o acceder a otras fuentes de datos, utilice ctx.dataSourceManager.

      Definición de tipos

      dataSource: DataSource;

class DataSource {
  constructor(options?: Record<string, any>);

  // Propiedades de solo lectura
  get flowEngine(): FlowEngine;   // Instancia actual de FlowEngine
  get displayName(): string;      // Nombre a mostrar (soporta i18n)
  get key(): string;              // Clave de la fuente de datos, ej. 'main'
  get name(): string;             // Igual que la clave

  // Lectura de colecciones
  getCollections(): Collection[];                      // Obtener todas las colecciones
  getCollection(name: string): Collection | undefined; // Obtener colección por nombre
  getAssociation(associationName: string): CollectionField | undefined; // Obtener campo de asociación (ej. users.roles)

  // Gestión de colecciones
  addCollection(collection: Collection | CollectionOptions): void;
  updateCollection(newOptions: CollectionOptions): void;
  upsertCollection(options: CollectionOptions): Collection | undefined;
  upsertCollections(collections: CollectionOptions[], options?: { clearFields?: boolean }): void;
  removeCollection(name: string): void;
  clearCollections(): void;

  // Metadatos de campos
  getCollectionField(fieldPath: string): CollectionField | undefined;
}

      Propiedades comunes

      PropiedadTipoDescripción
      keystringClave de la fuente de datos, ej. 'main'
      namestringIgual que la clave
      displayNamestringNombre a mostrar (soporta i18n)
      flowEngineFlowEngineInstancia actual de FlowEngine

      Métodos comunes

      MétodoDescripción
      getCollections()Obtiene todas las colecciones bajo la fuente de datos actual (ordenadas y con las ocultas filtradas).
      getCollection(name)Obtiene una colección por nombre; name puede ser nombreColeccion.nombreCampo para obtener la colección de destino de una asociación.
      getAssociation(associationName)Obtiene la definición de un campo de asociación mediante nombreColeccion.nombreCampo.
      getCollectionField(fieldPath)Obtiene la definición de un campo mediante nombreColeccion.rutaCampo, soportando rutas de asociación como users.profile.avatar.

      Relación con ctx.dataSourceManager

      RequisitoUso recomendado
      Fuente de datos única vinculada al contexto actualctx.dataSource
      Punto de entrada para todas las fuentes de datosctx.dataSourceManager
      Obtener colección dentro de la fuente de datos actualctx.dataSource.getCollection(name)
      Obtener colección entre diferentes fuentes de datosctx.dataSourceManager.getCollection(dataSourceKey, collectionName)
      Obtener campo dentro de la fuente de datos actualctx.dataSource.getCollectionField('users.profile.avatar')
      Obtener campo entre diferentes fuentes de datosctx.dataSourceManager.getCollectionField('main.users.profile.avatar')

      Ejemplo

      Obtener colecciones y campos

      // Obtener todas las colecciones
const collections = ctx.dataSource.getCollections();

// Obtener colección por nombre
const users = ctx.dataSource.getCollection('users');
const primaryKey = users?.filterTargetKey ?? 'id';

// Obtener definición de campo por "nombreColeccion.rutaCampo" (soporta asociaciones)
const field = ctx.dataSource.getCollectionField('users.profile.avatar');
const userNameField = ctx.dataSource.getCollectionField('orders.createdBy.name');

      Obtener campos de asociación

      // Obtener definición de campo de asociación por nombreColeccion.nombreCampo
const rolesField = ctx.dataSource.getAssociation('users.roles');
if (rolesField?.isAssociationField()) {
  const targetCol = rolesField.targetCollection;
  // Procesar basado en la estructura de la colección de destino
}

      Recorrer colecciones para procesamiento dinámico

      const collections = ctx.dataSource.getCollections();
for (const col of collections) {
  const fields = col.getFields();
  const requiredFields = fields.filter((f) => f.options?.required);
  // ...
}

      Realizar validaciones o UI dinámica basada en metadatos de campos

      const field = ctx.dataSource.getCollectionField('users.status');
if (field) {
  const options = field.enum ?? [];
  const operators = field.getFilterOperators();
  // Realizar lógica de UI o validación basada en interface, enum, validation, etc.
}

      Notas

      • El formato de ruta para getCollectionField(fieldPath) es nombreColeccion.rutaCampo, donde el primer segmento es el nombre de la colección y los segmentos posteriores son la ruta del campo (soporta asociaciones, ej. user.name).
      • getCollection(name) soporta el formato nombreColeccion.nombreCampo, devolviendo la colección de destino del campo de asociación.
      • En el contexto de RunJS, ctx.dataSource suele estar determinado por la fuente de datos del bloque o página actual. Si no hay una fuente de datos vinculada al contexto, puede ser undefined; se recomienda realizar una comprobación de nulidad antes de su uso.

      Relacionado