Method addRelationRoutes

packages/core/src/utils/SchemaRouter.ts:240–372

* Add routes for relations between the current schema and another schema. * * The routes are: * * - `GET /:id/[pathname]`: Get the entities of the relation with pagination. * - `POST /:id/[pathname]`: Add entities to the relation. * - `PUT /:id/[pathname]`: Replace the entities in

(
    relationQueries: TwoRelationsQueries<
      typeof this.schema,
      GeneratedSchema<string, RelationCreateSchema, RelationSchema>
    >,
    pathname = tableToPathname(relationQueries.schemas[1].table),
    { disabled, hookEvent, isPaginationOptional }: Partial<RelationRoutesConfig> = {}
  )

   * @see {@link TwoRelationsQueries} for the `relationQueries` configuration.
   */
  addRelationRoutes<
    RelationCreateSchema extends Partial<SchemaLike<string> & { id: string }>,
    RelationSchema extends SchemaLike<string> & { id: string },
  >(
    relationQueries: TwoRelationsQueries<
      typeof this.schema,
      GeneratedSchema<string, RelationCreateSchema, RelationSchema>
    >,
    pathname = tableToPathname(relationQueries.schemas[1].table),
    { disabled, hookEvent, isPaginationOptional }: Partial<RelationRoutesConfig> = {}
  ) {
    const relationSchema = relationQueries.schemas[1];
    const relationSchemaId = camelCaseSchemaId(relationSchema);
    const columns = {
      schemaId: camelCaseSchemaId(this.schema),
      relationSchemaId,
      relationSchemaIds: relationSchemaId + 's',
    };
    const appendHookContext = (ctx: WithHookContext<IRouterParamContext & Context>, id: string) => {
      if (hookEvent) {
        ctx.appendDataHookContext(hookEvent, {
          ...buildManagementApiContext(ctx),
          [columns.schemaId]: id,
        });
      }
    };

    if (!disabled?.get) {
      this.get(
        `/:id/${pathname}`,
        koaPagination({ isOptional: isPaginationOptional }),
        koaGuard({
          params: z.object({ id: z.string().min(1) }),
          response: relationSchema.guard.array(),
          status: this.#collectRouteStatuses('get', [200, 404], 'relation'),
        }),
        this.#assembleQualifiedMiddlewares('get', 'relation'),
        async (ctx, next) => {
          const { id } = ctx.guard.params;

          // Ensure that the main entry exists
          await this.queries.findById(id);

          const [totalCount, entities] = await relationQueries.getEntities(
            relationSchema,
            { [columns.schemaId]: id },
            ctx.pagination.disabled ? undefined : ctx.pagination
          );

          if (!ctx.pagination.disabled) {
            ctx.pagination.totalCount = totalCount;
          }
          ctx.body = entities;
          return next();
        }
      );
    }