feat(modify): Allow picking fields

[sandrina-p]

Follow-up of #71, scoped on allowing to pick certain fields

Linear issue (internal)

New specs

Imagine the schema below with 4 fields to buy tickets:

const schemaTickets = {
  properties: {
    age: {
      title: 'Age',
      type: 'integer',
    },
    quantity: {
      title: 'Quantity',
      type: 'integer',
    },
    has_premium: {
      title: 'Has premium',
      type: 'string',
    },
    premium_id: {
      title: 'Premium ID',
      type: 'boolean',
    },
  },
  'x-jsf-order': ['age', 'quantity', 'has_premium', 'premium_id'],
  allOf: [
    {
      if: {
        properties: {
          has_premium: {
            const: 'yes',
          },
        },
        required: ['has_premium'],
      },
      then: {
        required: ['premium_id'],
      },
      else: {
        properties: {
          premium_id: false,
        },
      },
    },
  ],
};

If you want a JSON Schema with just the quantity field, pass the following config:

const { schema, warnings } = modify(schemaTickets, {
  pick: ['quantity'],
});

Which will return you the schema:

{
  properties: {
    quantity: {
      title: 'Quantity',
      type: 'integer',
    }
  },
  'x-jsf-order': ['quantity'],
  allOf: undefined
};

Other features:

• When picked fields have conditional fields, they are also included and it's included in the warnings.
• NOT done:
  • Pick nested fields
  • Ignore conditionals with missing fields

[danielcardoso5]

Hey @sandrina-p , I'll review this one tomorrow morning!

[sandrina-p]

@danielcardoso5 Ready for a new review :D

[danielcardoso5]

Looks good @sandrina-p! Thank you for the added comments re: fieldsets ✨