feat(surveys): return API only surveys method

[liyiy]

Changes

Add a new method to return API type surveys only. Update the existing getActiveMatchingSurveys to return non API surveys only.

To go in with: PostHog/posthog#16501

Checklist

• Tests for new code (see advice on the tests we use)
• Accounted for the impact of any changes across different browsers

[github-actions]

Size Change: +2.59 kB (0%)

Total Size: 668 kB

Filename	Size	Change
dist/array.full.js	173 kB	+648 B (0%)
dist/array.js	114 kB	+648 B (+1%)
dist/es.js	114 kB	+648 B (+1%)
dist/module.js	114 kB	+648 B (+1%)

ℹ️ View Unchanged

Filename	Size
dist/recorder-v2.js	93.6 kB
dist/recorder.js	58.3 kB

_{compressed-size-action}

[neilkakkar]

Hmm, this doesn't make sense to me - why are we excluding API survey type from getActiveMatchingSurveys ?

[neilkakkar]

Also, why is API a separate type? 🤔

[liyiy]

Hmm, this doesn't make sense to me - why are we excluding API survey type from getActiveMatchingSurveys ?

Because we don't want to display API surveys in our use of the call 🤔

Basically users who are creating custom UI surveys only need API type surveys through the new method

[liyiy]

Also, why is API a separate type? 🤔

I think Annika suggested it as a survey type which makes a lot of sense to me, where do you think storing that a survey is an API type belongs to instead?

[liyiy]

This might make more sense as I push my PR up for the app API survey type @neilkakkar

[benjackwhite]

Commenting on the general approach

Why do we have separate endpoints? Why not just filter after the fact?

It's pretty straightforward for devs to do filtering after the fact so I would much prefer a simple and minimal API rather than custom methods for every sub-type of survey. We will end up in the future with dozens of top level methods that are all just doing some simple filtering.

posthog.getAllSurveys(surveys => {
  handleCustomSurveys(surveys.filter(s => s.type === "API"))
})

getActiveMatchingAPISurveys for example just sounds confusing. getAllSurveyMatches is even more confusing 😅

Being highly opinionated here as these choices we will have to live with and support for basically ever.

[liyiy]

🙈 I was actually going to do that but then I thought once I did it you guys would tell me to add in separate methods for it in the library to make dev lives easier so they don't have to even filter for their survey types lol. If filtering is fine I'm going to close this PR then and just add it to the docs and surveys app instead