@seshuk/payload-plugin-openapi 0.2.3 → 1.0.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +72 -26
- package/dist/_tooling/telemetry.js +168 -0
- package/dist/_tooling/telemetry.js.map +1 -0
- package/dist/cli/generateSpec.d.ts +2 -0
- package/dist/cli/generateSpec.js +40 -0
- package/dist/cli/generateSpec.js.map +1 -0
- package/dist/index.d.ts +8 -9
- package/dist/index.js +76 -65
- package/dist/index.js.map +1 -0
- package/dist/{endpoints → server/endpoints}/interactiveAuth.d.ts +2 -2
- package/dist/server/endpoints/interactiveAuth.js +25 -0
- package/dist/server/endpoints/interactiveAuth.js.map +1 -0
- package/dist/server/endpoints/spec.d.ts +5 -0
- package/dist/server/endpoints/spec.js +39 -0
- package/dist/server/endpoints/spec.js.map +1 -0
- package/dist/server/options/resolveOptions.d.ts +4 -0
- package/dist/server/options/resolveOptions.js +65 -0
- package/dist/server/options/resolveOptions.js.map +1 -0
- package/dist/server/spec/build.d.ts +14 -0
- package/dist/server/spec/build.js +40 -0
- package/dist/server/spec/build.js.map +1 -0
- package/dist/server/spec/buildDocument.d.ts +16 -0
- package/dist/server/spec/buildDocument.js +340 -0
- package/dist/server/spec/buildDocument.js.map +1 -0
- package/dist/server/spec/components.d.ts +61 -0
- package/dist/server/spec/components.js +265 -0
- package/dist/server/spec/components.js.map +1 -0
- package/dist/{spec → server/spec}/downconvert.d.ts +2 -1
- package/dist/server/spec/downconvert.js +69 -0
- package/dist/server/spec/downconvert.js.map +1 -0
- package/dist/server/spec/entitySchemas.d.ts +15 -0
- package/dist/server/spec/entitySchemas.js +207 -0
- package/dist/server/spec/entitySchemas.js.map +1 -0
- package/dist/{spec → server/spec}/fields.d.ts +2 -1
- package/dist/server/spec/fields.js +47 -0
- package/dist/server/spec/fields.js.map +1 -0
- package/dist/server/spec/filters.d.ts +16 -0
- package/dist/server/spec/filters.js +102 -0
- package/dist/server/spec/filters.js.map +1 -0
- package/dist/server/spec/hierarchy.d.ts +11 -0
- package/dist/server/spec/hierarchy.js +43 -0
- package/dist/server/spec/hierarchy.js.map +1 -0
- package/dist/{spec → server/spec}/names.d.ts +2 -2
- package/dist/server/spec/names.js +43 -0
- package/dist/server/spec/names.js.map +1 -0
- package/dist/server/spec/params.d.ts +57 -0
- package/dist/server/spec/params.js +394 -0
- package/dist/server/spec/params.js.map +1 -0
- package/dist/server/spec/paths/auth.d.ts +10 -0
- package/dist/server/spec/paths/auth.js +190 -0
- package/dist/server/spec/paths/auth.js.map +1 -0
- package/dist/server/spec/paths/collections.d.ts +11 -0
- package/dist/server/spec/paths/collections.js +418 -0
- package/dist/server/spec/paths/collections.js.map +1 -0
- package/dist/server/spec/paths/custom.d.ts +12 -0
- package/dist/server/spec/paths/custom.js +42 -0
- package/dist/server/spec/paths/custom.js.map +1 -0
- package/dist/server/spec/paths/globals.d.ts +11 -0
- package/dist/server/spec/paths/globals.js +87 -0
- package/dist/server/spec/paths/globals.js.map +1 -0
- package/dist/server/spec/paths/jobs.d.ts +9 -0
- package/dist/server/spec/paths/jobs.js +98 -0
- package/dist/server/spec/paths/jobs.js.map +1 -0
- package/dist/server/spec/paths/system.d.ts +9 -0
- package/dist/server/spec/paths/system.js +203 -0
- package/dist/server/spec/paths/system.js.map +1 -0
- package/dist/server/spec/paths/versions.d.ts +22 -0
- package/dist/server/spec/paths/versions.js +185 -0
- package/dist/server/spec/paths/versions.js.map +1 -0
- package/dist/server/spec/plugins/ecommerce.d.ts +3 -0
- package/dist/server/spec/plugins/ecommerce.js +270 -0
- package/dist/server/spec/plugins/ecommerce.js.map +1 -0
- package/dist/server/spec/plugins/importExport.d.ts +3 -0
- package/dist/server/spec/plugins/importExport.js +202 -0
- package/dist/server/spec/plugins/importExport.js.map +1 -0
- package/dist/server/spec/plugins/index.d.ts +3 -0
- package/dist/server/spec/plugins/index.js +21 -0
- package/dist/server/spec/plugins/index.js.map +1 -0
- package/dist/server/spec/plugins/mcp.d.ts +3 -0
- package/dist/server/spec/plugins/mcp.js +118 -0
- package/dist/server/spec/plugins/mcp.js.map +1 -0
- package/dist/server/spec/plugins/multiTenant.d.ts +3 -0
- package/dist/server/spec/plugins/multiTenant.js +39 -0
- package/dist/server/spec/plugins/multiTenant.js.map +1 -0
- package/dist/server/spec/plugins/search.d.ts +3 -0
- package/dist/server/spec/plugins/search.js +43 -0
- package/dist/server/spec/plugins/search.js.map +1 -0
- package/dist/server/spec/plugins/seo.d.ts +3 -0
- package/dist/server/spec/plugins/seo.js +83 -0
- package/dist/server/spec/plugins/seo.js.map +1 -0
- package/dist/server/spec/plugins/shared.d.ts +35 -0
- package/dist/server/spec/plugins/shared.js +37 -0
- package/dist/server/spec/plugins/shared.js.map +1 -0
- package/dist/server/spec/plugins/storageR2.d.ts +3 -0
- package/dist/server/spec/plugins/storageR2.js +91 -0
- package/dist/server/spec/plugins/storageR2.js.map +1 -0
- package/dist/server/spec/plugins/stripe.d.ts +10 -0
- package/dist/server/spec/plugins/stripe.js +102 -0
- package/dist/server/spec/plugins/stripe.js.map +1 -0
- package/dist/server/spec/security.d.ts +34 -0
- package/dist/server/spec/security.js +100 -0
- package/dist/server/spec/security.js.map +1 -0
- package/dist/server/spec/tags.d.ts +37 -0
- package/dist/server/spec/tags.js +99 -0
- package/dist/server/spec/tags.js.map +1 -0
- package/dist/server/telemetry.d.ts +31 -0
- package/dist/server/telemetry.js +33 -0
- package/dist/server/telemetry.js.map +1 -0
- package/dist/server/ui/createUiPlugin.d.ts +16 -0
- package/dist/server/ui/createUiPlugin.js +33 -0
- package/dist/server/ui/createUiPlugin.js.map +1 -0
- package/dist/{ui → server/ui}/html.d.ts +5 -3
- package/dist/server/ui/html.js +11 -0
- package/dist/server/ui/html.js.map +1 -0
- package/dist/server/ui/scalar.d.ts +4 -0
- package/dist/server/ui/scalar.js +17 -0
- package/dist/server/ui/scalar.js.map +1 -0
- package/dist/server/ui/swagger.d.ts +4 -0
- package/dist/server/ui/swagger.js +18 -0
- package/dist/server/ui/swagger.js.map +1 -0
- package/dist/shared/constants.d.ts +4 -0
- package/dist/shared/constants.js +6 -0
- package/dist/shared/constants.js.map +1 -0
- package/dist/shared/translations/index.d.ts +5 -0
- package/dist/{translations → shared/translations}/index.js +49 -47
- package/dist/shared/translations/index.js.map +1 -0
- package/dist/shared/translations/locales/ar.d.ts +3 -0
- package/dist/shared/translations/locales/ar.js +173 -0
- package/dist/shared/translations/locales/ar.js.map +1 -0
- package/dist/shared/translations/locales/az.d.ts +3 -0
- package/dist/shared/translations/locales/az.js +173 -0
- package/dist/shared/translations/locales/az.js.map +1 -0
- package/dist/shared/translations/locales/bg.d.ts +3 -0
- package/dist/shared/translations/locales/bg.js +173 -0
- package/dist/shared/translations/locales/bg.js.map +1 -0
- package/dist/shared/translations/locales/bnBd.d.ts +3 -0
- package/dist/shared/translations/locales/bnBd.js +173 -0
- package/dist/shared/translations/locales/bnBd.js.map +1 -0
- package/dist/shared/translations/locales/bnIn.d.ts +3 -0
- package/dist/shared/translations/locales/bnIn.js +173 -0
- package/dist/shared/translations/locales/bnIn.js.map +1 -0
- package/dist/shared/translations/locales/ca.d.ts +3 -0
- package/dist/shared/translations/locales/ca.js +173 -0
- package/dist/shared/translations/locales/ca.js.map +1 -0
- package/dist/shared/translations/locales/cs.d.ts +3 -0
- package/dist/shared/translations/locales/cs.js +173 -0
- package/dist/shared/translations/locales/cs.js.map +1 -0
- package/dist/shared/translations/locales/da.d.ts +3 -0
- package/dist/shared/translations/locales/da.js +173 -0
- package/dist/shared/translations/locales/da.js.map +1 -0
- package/dist/shared/translations/locales/de.d.ts +3 -0
- package/dist/shared/translations/locales/de.js +173 -0
- package/dist/shared/translations/locales/de.js.map +1 -0
- package/dist/shared/translations/locales/en.d.ts +3 -0
- package/dist/shared/translations/locales/en.js +173 -0
- package/dist/shared/translations/locales/en.js.map +1 -0
- package/dist/shared/translations/locales/es.d.ts +3 -0
- package/dist/shared/translations/locales/es.js +173 -0
- package/dist/shared/translations/locales/es.js.map +1 -0
- package/dist/shared/translations/locales/et.d.ts +3 -0
- package/dist/shared/translations/locales/et.js +173 -0
- package/dist/shared/translations/locales/et.js.map +1 -0
- package/dist/shared/translations/locales/fa.d.ts +3 -0
- package/dist/shared/translations/locales/fa.js +173 -0
- package/dist/shared/translations/locales/fa.js.map +1 -0
- package/dist/shared/translations/locales/fr.d.ts +3 -0
- package/dist/shared/translations/locales/fr.js +173 -0
- package/dist/shared/translations/locales/fr.js.map +1 -0
- package/dist/shared/translations/locales/he.d.ts +3 -0
- package/dist/shared/translations/locales/he.js +173 -0
- package/dist/shared/translations/locales/he.js.map +1 -0
- package/dist/shared/translations/locales/hr.d.ts +3 -0
- package/dist/shared/translations/locales/hr.js +173 -0
- package/dist/shared/translations/locales/hr.js.map +1 -0
- package/dist/shared/translations/locales/hu.d.ts +3 -0
- package/dist/shared/translations/locales/hu.js +173 -0
- package/dist/shared/translations/locales/hu.js.map +1 -0
- package/dist/shared/translations/locales/hy.d.ts +3 -0
- package/dist/shared/translations/locales/hy.js +173 -0
- package/dist/shared/translations/locales/hy.js.map +1 -0
- package/dist/shared/translations/locales/id.d.ts +3 -0
- package/dist/shared/translations/locales/id.js +173 -0
- package/dist/shared/translations/locales/id.js.map +1 -0
- package/dist/shared/translations/locales/is.d.ts +3 -0
- package/dist/shared/translations/locales/is.js +173 -0
- package/dist/shared/translations/locales/is.js.map +1 -0
- package/dist/shared/translations/locales/it.d.ts +3 -0
- package/dist/shared/translations/locales/it.js +173 -0
- package/dist/shared/translations/locales/it.js.map +1 -0
- package/dist/shared/translations/locales/ja.d.ts +3 -0
- package/dist/shared/translations/locales/ja.js +173 -0
- package/dist/shared/translations/locales/ja.js.map +1 -0
- package/dist/shared/translations/locales/ko.d.ts +3 -0
- package/dist/shared/translations/locales/ko.js +173 -0
- package/dist/shared/translations/locales/ko.js.map +1 -0
- package/dist/shared/translations/locales/lt.d.ts +3 -0
- package/dist/shared/translations/locales/lt.js +173 -0
- package/dist/shared/translations/locales/lt.js.map +1 -0
- package/dist/shared/translations/locales/lv.d.ts +3 -0
- package/dist/shared/translations/locales/lv.js +173 -0
- package/dist/shared/translations/locales/lv.js.map +1 -0
- package/dist/shared/translations/locales/my.d.ts +3 -0
- package/dist/shared/translations/locales/my.js +173 -0
- package/dist/shared/translations/locales/my.js.map +1 -0
- package/dist/shared/translations/locales/nb.d.ts +3 -0
- package/dist/shared/translations/locales/nb.js +173 -0
- package/dist/shared/translations/locales/nb.js.map +1 -0
- package/dist/shared/translations/locales/nl.d.ts +3 -0
- package/dist/shared/translations/locales/nl.js +173 -0
- package/dist/shared/translations/locales/nl.js.map +1 -0
- package/dist/shared/translations/locales/pl.d.ts +3 -0
- package/dist/shared/translations/locales/pl.js +173 -0
- package/dist/shared/translations/locales/pl.js.map +1 -0
- package/dist/shared/translations/locales/pt.d.ts +3 -0
- package/dist/shared/translations/locales/pt.js +173 -0
- package/dist/shared/translations/locales/pt.js.map +1 -0
- package/dist/shared/translations/locales/ro.d.ts +3 -0
- package/dist/shared/translations/locales/ro.js +173 -0
- package/dist/shared/translations/locales/ro.js.map +1 -0
- package/dist/shared/translations/locales/rs.d.ts +3 -0
- package/dist/shared/translations/locales/rs.js +173 -0
- package/dist/shared/translations/locales/rs.js.map +1 -0
- package/dist/shared/translations/locales/rsLatin.d.ts +3 -0
- package/dist/shared/translations/locales/rsLatin.js +173 -0
- package/dist/shared/translations/locales/rsLatin.js.map +1 -0
- package/dist/shared/translations/locales/ru.d.ts +3 -0
- package/dist/shared/translations/locales/ru.js +173 -0
- package/dist/shared/translations/locales/ru.js.map +1 -0
- package/dist/shared/translations/locales/sk.d.ts +3 -0
- package/dist/shared/translations/locales/sk.js +173 -0
- package/dist/shared/translations/locales/sk.js.map +1 -0
- package/dist/shared/translations/locales/sl.d.ts +3 -0
- package/dist/shared/translations/locales/sl.js +173 -0
- package/dist/shared/translations/locales/sl.js.map +1 -0
- package/dist/shared/translations/locales/sv.d.ts +3 -0
- package/dist/shared/translations/locales/sv.js +173 -0
- package/dist/shared/translations/locales/sv.js.map +1 -0
- package/dist/shared/translations/locales/ta.d.ts +3 -0
- package/dist/shared/translations/locales/ta.js +173 -0
- package/dist/shared/translations/locales/ta.js.map +1 -0
- package/dist/shared/translations/locales/th.d.ts +3 -0
- package/dist/shared/translations/locales/th.js +173 -0
- package/dist/shared/translations/locales/th.js.map +1 -0
- package/dist/shared/translations/locales/tr.d.ts +3 -0
- package/dist/shared/translations/locales/tr.js +173 -0
- package/dist/shared/translations/locales/tr.js.map +1 -0
- package/dist/shared/translations/locales/uk.d.ts +3 -0
- package/dist/shared/translations/locales/uk.js +173 -0
- package/dist/shared/translations/locales/uk.js.map +1 -0
- package/dist/shared/translations/locales/vi.d.ts +3 -0
- package/dist/shared/translations/locales/vi.js +173 -0
- package/dist/shared/translations/locales/vi.js.map +1 -0
- package/dist/shared/translations/locales/zh.d.ts +3 -0
- package/dist/shared/translations/locales/zh.js +173 -0
- package/dist/shared/translations/locales/zh.js.map +1 -0
- package/dist/shared/translations/locales/zhTw.d.ts +3 -0
- package/dist/shared/translations/locales/zhTw.js +173 -0
- package/dist/shared/translations/locales/zhTw.js.map +1 -0
- package/dist/shared/translations/types.d.ts +180 -0
- package/dist/shared/translations/types.js +1 -0
- package/dist/shared/types/index.d.ts +412 -0
- package/dist/shared/types/index.js +1 -0
- package/dist/{utils.d.ts → shared/utils.d.ts} +1 -0
- package/dist/shared/utils.js +13 -0
- package/dist/shared/utils.js.map +1 -0
- package/package.json +70 -39
- package/dist/bin/generateSpec.d.ts +0 -25
- package/dist/bin/generateSpec.js +0 -61
- package/dist/constants.d.ts +0 -1
- package/dist/constants.js +0 -2
- package/dist/endpoints/interactiveAuth.js +0 -27
- package/dist/endpoints/spec.d.ts +0 -5
- package/dist/endpoints/spec.js +0 -39
- package/dist/options.d.ts +0 -2
- package/dist/options.js +0 -45
- package/dist/spec/build.d.ts +0 -14
- package/dist/spec/build.js +0 -36
- package/dist/spec/buildDocument.d.ts +0 -15
- package/dist/spec/buildDocument.js +0 -268
- package/dist/spec/components.d.ts +0 -44
- package/dist/spec/components.js +0 -265
- package/dist/spec/downconvert.js +0 -74
- package/dist/spec/entitySchemas.d.ts +0 -15
- package/dist/spec/entitySchemas.js +0 -250
- package/dist/spec/fields.js +0 -44
- package/dist/spec/filters.d.ts +0 -11
- package/dist/spec/filters.js +0 -83
- package/dist/spec/names.js +0 -37
- package/dist/spec/params.d.ts +0 -55
- package/dist/spec/params.js +0 -436
- package/dist/spec/paths/auth.d.ts +0 -9
- package/dist/spec/paths/auth.js +0 -274
- package/dist/spec/paths/collections.d.ts +0 -9
- package/dist/spec/paths/collections.js +0 -278
- package/dist/spec/paths/custom.d.ts +0 -9
- package/dist/spec/paths/custom.js +0 -41
- package/dist/spec/paths/globals.d.ts +0 -9
- package/dist/spec/paths/globals.js +0 -78
- package/dist/spec/paths/jobs.d.ts +0 -7
- package/dist/spec/paths/jobs.js +0 -130
- package/dist/spec/paths/versions.d.ts +0 -19
- package/dist/spec/paths/versions.js +0 -252
- package/dist/spec/security.d.ts +0 -19
- package/dist/spec/security.js +0 -96
- package/dist/spec/tags.d.ts +0 -27
- package/dist/spec/tags.js +0 -79
- package/dist/translations/index.d.ts +0 -6
- package/dist/translations/locales/ar.d.ts +0 -2
- package/dist/translations/locales/ar.js +0 -81
- package/dist/translations/locales/az.d.ts +0 -2
- package/dist/translations/locales/az.js +0 -81
- package/dist/translations/locales/bg.d.ts +0 -2
- package/dist/translations/locales/bg.js +0 -81
- package/dist/translations/locales/bnBd.d.ts +0 -2
- package/dist/translations/locales/bnBd.js +0 -81
- package/dist/translations/locales/bnIn.d.ts +0 -2
- package/dist/translations/locales/bnIn.js +0 -81
- package/dist/translations/locales/ca.d.ts +0 -2
- package/dist/translations/locales/ca.js +0 -81
- package/dist/translations/locales/cs.d.ts +0 -2
- package/dist/translations/locales/cs.js +0 -81
- package/dist/translations/locales/da.d.ts +0 -2
- package/dist/translations/locales/da.js +0 -81
- package/dist/translations/locales/de.d.ts +0 -2
- package/dist/translations/locales/de.js +0 -81
- package/dist/translations/locales/en.d.ts +0 -2
- package/dist/translations/locales/en.js +0 -81
- package/dist/translations/locales/es.d.ts +0 -2
- package/dist/translations/locales/es.js +0 -81
- package/dist/translations/locales/et.d.ts +0 -2
- package/dist/translations/locales/et.js +0 -81
- package/dist/translations/locales/fa.d.ts +0 -2
- package/dist/translations/locales/fa.js +0 -81
- package/dist/translations/locales/fr.d.ts +0 -2
- package/dist/translations/locales/fr.js +0 -81
- package/dist/translations/locales/he.d.ts +0 -2
- package/dist/translations/locales/he.js +0 -81
- package/dist/translations/locales/hr.d.ts +0 -2
- package/dist/translations/locales/hr.js +0 -81
- package/dist/translations/locales/hu.d.ts +0 -2
- package/dist/translations/locales/hu.js +0 -81
- package/dist/translations/locales/hy.d.ts +0 -2
- package/dist/translations/locales/hy.js +0 -81
- package/dist/translations/locales/id.d.ts +0 -2
- package/dist/translations/locales/id.js +0 -81
- package/dist/translations/locales/is.d.ts +0 -2
- package/dist/translations/locales/is.js +0 -81
- package/dist/translations/locales/it.d.ts +0 -2
- package/dist/translations/locales/it.js +0 -81
- package/dist/translations/locales/ja.d.ts +0 -2
- package/dist/translations/locales/ja.js +0 -81
- package/dist/translations/locales/ko.d.ts +0 -2
- package/dist/translations/locales/ko.js +0 -81
- package/dist/translations/locales/lt.d.ts +0 -2
- package/dist/translations/locales/lt.js +0 -81
- package/dist/translations/locales/lv.d.ts +0 -2
- package/dist/translations/locales/lv.js +0 -81
- package/dist/translations/locales/my.d.ts +0 -2
- package/dist/translations/locales/my.js +0 -81
- package/dist/translations/locales/nb.d.ts +0 -2
- package/dist/translations/locales/nb.js +0 -81
- package/dist/translations/locales/nl.d.ts +0 -2
- package/dist/translations/locales/nl.js +0 -81
- package/dist/translations/locales/pl.d.ts +0 -2
- package/dist/translations/locales/pl.js +0 -81
- package/dist/translations/locales/pt.d.ts +0 -2
- package/dist/translations/locales/pt.js +0 -81
- package/dist/translations/locales/ro.d.ts +0 -2
- package/dist/translations/locales/ro.js +0 -81
- package/dist/translations/locales/rs.d.ts +0 -2
- package/dist/translations/locales/rs.js +0 -81
- package/dist/translations/locales/rsLatin.d.ts +0 -2
- package/dist/translations/locales/rsLatin.js +0 -81
- package/dist/translations/locales/ru.d.ts +0 -2
- package/dist/translations/locales/ru.js +0 -81
- package/dist/translations/locales/sk.d.ts +0 -2
- package/dist/translations/locales/sk.js +0 -81
- package/dist/translations/locales/sl.d.ts +0 -2
- package/dist/translations/locales/sl.js +0 -81
- package/dist/translations/locales/sv.d.ts +0 -2
- package/dist/translations/locales/sv.js +0 -81
- package/dist/translations/locales/ta.d.ts +0 -2
- package/dist/translations/locales/ta.js +0 -81
- package/dist/translations/locales/th.d.ts +0 -2
- package/dist/translations/locales/th.js +0 -81
- package/dist/translations/locales/tr.d.ts +0 -2
- package/dist/translations/locales/tr.js +0 -81
- package/dist/translations/locales/uk.d.ts +0 -2
- package/dist/translations/locales/uk.js +0 -81
- package/dist/translations/locales/vi.d.ts +0 -2
- package/dist/translations/locales/vi.js +0 -81
- package/dist/translations/locales/zh.d.ts +0 -2
- package/dist/translations/locales/zh.js +0 -81
- package/dist/translations/locales/zhTw.d.ts +0 -2
- package/dist/translations/locales/zhTw.js +0 -81
- package/dist/translations/types.d.ts +0 -87
- package/dist/translations/types.js +0 -1
- package/dist/types.d.ts +0 -192
- package/dist/types.js +0 -1
- package/dist/ui/createUiPlugin.d.ts +0 -14
- package/dist/ui/createUiPlugin.js +0 -28
- package/dist/ui/html.js +0 -8
- package/dist/ui/scalar.d.ts +0 -1
- package/dist/ui/scalar.js +0 -12
- package/dist/ui/swagger.d.ts +0 -1
- package/dist/ui/swagger.js +0 -12
- package/dist/utils.js +0 -13
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { isPlainObject } from "../../shared/utils.js";
|
|
2
|
+
import { INTERACTIVE_SCHEME_NAME, SECURITY_SCHEME_NAME } from "./components.js";
|
|
3
|
+
import { PLUGIN_NAME } from "../../shared/constants.js";
|
|
4
|
+
import { operationPlugin } from "./filters.js";
|
|
5
|
+
const HTTP_METHODS = [
|
|
6
|
+
"get",
|
|
7
|
+
"post",
|
|
8
|
+
"patch",
|
|
9
|
+
"put",
|
|
10
|
+
"delete"
|
|
11
|
+
];
|
|
12
|
+
const securedRequirement = (login = false) => login ? [{ [SECURITY_SCHEME_NAME]: [] }, { [INTERACTIVE_SCHEME_NAME]: [] }] : [{ [SECURITY_SCHEME_NAME]: [] }];
|
|
13
|
+
const OVERRIDE_FALLBACK = {
|
|
14
|
+
readVersions: "read",
|
|
15
|
+
validate: "update"
|
|
16
|
+
};
|
|
17
|
+
const withTimeout = async (promise, timeoutMs) => {
|
|
18
|
+
let timer;
|
|
19
|
+
const guard = new Promise((resolve) => {
|
|
20
|
+
timer = setTimeout(() => resolve(false), timeoutMs);
|
|
21
|
+
});
|
|
22
|
+
try {
|
|
23
|
+
return await Promise.race([promise.then((value) => value === true, () => false), guard]);
|
|
24
|
+
} finally {
|
|
25
|
+
if (timer) clearTimeout(timer);
|
|
26
|
+
}
|
|
27
|
+
};
|
|
28
|
+
const evaluateAccess = async (access, opts = {}) => {
|
|
29
|
+
if (!access) return false;
|
|
30
|
+
const { locale, timeoutMs = 250, baseAccess } = opts;
|
|
31
|
+
const trap = (allowed, value) => new Proxy({}, { get(_target, key) {
|
|
32
|
+
if (key === allowed) return value;
|
|
33
|
+
throw new Error("req.payload accessed during build");
|
|
34
|
+
} });
|
|
35
|
+
const payloadTrap = trap("config", trap("baseAccess", baseAccess));
|
|
36
|
+
const req = {
|
|
37
|
+
user: null,
|
|
38
|
+
headers: new Headers(),
|
|
39
|
+
context: {},
|
|
40
|
+
locale,
|
|
41
|
+
payload: payloadTrap
|
|
42
|
+
};
|
|
43
|
+
try {
|
|
44
|
+
const result = access({ req });
|
|
45
|
+
if (result && typeof result.then === "function") return await withTimeout(result, timeoutMs);
|
|
46
|
+
return result === true;
|
|
47
|
+
} catch {
|
|
48
|
+
return false;
|
|
49
|
+
}
|
|
50
|
+
};
|
|
51
|
+
const readSecurityOverride = (entity) => {
|
|
52
|
+
const meta = entity.custom?.openapi?.security;
|
|
53
|
+
if ((isPlainObject(meta) ? Object.values(meta) : [meta]).some((value) => typeof value === "boolean")) throw new Error(`[${PLUGIN_NAME}] custom.openapi.security true/false on "${entity.slug}" was removed, use 'public' or 'secured'`);
|
|
54
|
+
return meta === void 0 ? void 0 : meta;
|
|
55
|
+
};
|
|
56
|
+
const overrideFor = (override, op) => {
|
|
57
|
+
const fallback = OVERRIDE_FALLBACK[op];
|
|
58
|
+
const marking = typeof override === "string" ? override : override?.[op] ?? (fallback ? override?.[fallback] : void 0);
|
|
59
|
+
return marking === void 0 ? void 0 : marking === "public";
|
|
60
|
+
};
|
|
61
|
+
const resolveEntitySecurity = async ({ entity, operations, locale, baseAccess }) => {
|
|
62
|
+
const override = readSecurityOverride(entity);
|
|
63
|
+
const access = entity.access;
|
|
64
|
+
const out = {};
|
|
65
|
+
for (const op of operations) out[op] = overrideFor(override, op) ?? await evaluateAccess(access?.[op], {
|
|
66
|
+
locale,
|
|
67
|
+
baseAccess
|
|
68
|
+
}) ? void 0 : securedRequirement();
|
|
69
|
+
return out;
|
|
70
|
+
};
|
|
71
|
+
const withLogin = (security) => security.some((r) => "PayloadToken" in r) && !security.some((r) => "PayloadLogin" in r) ? [...security, { [INTERACTIVE_SCHEME_NAME]: [] }] : security;
|
|
72
|
+
const applySecurity = async ({ paths, slug, kind, plugin, security, login = false }) => {
|
|
73
|
+
if (!security && !login) return paths;
|
|
74
|
+
for (const [path, item] of Object.entries(paths)) {
|
|
75
|
+
if (!item) continue;
|
|
76
|
+
const ops = item;
|
|
77
|
+
for (const method of HTTP_METHODS) {
|
|
78
|
+
const op = ops[method];
|
|
79
|
+
if (!op) continue;
|
|
80
|
+
if (login && op.security) op.security = withLogin(op.security);
|
|
81
|
+
if (!security) continue;
|
|
82
|
+
const detected = op.security?.length ? "secured" : "public";
|
|
83
|
+
const decision = await security({
|
|
84
|
+
method,
|
|
85
|
+
path,
|
|
86
|
+
slug,
|
|
87
|
+
kind,
|
|
88
|
+
plugin: operationPlugin(op, plugin),
|
|
89
|
+
detected
|
|
90
|
+
});
|
|
91
|
+
if (decision === "public") delete op.security;
|
|
92
|
+
else if (decision === "secured") op.security = securedRequirement(login);
|
|
93
|
+
else if (Array.isArray(decision)) op.security = decision;
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
return paths;
|
|
97
|
+
};
|
|
98
|
+
export { applySecurity, evaluateAccess, readSecurityOverride, resolveEntitySecurity, securedRequirement };
|
|
99
|
+
|
|
100
|
+
//# sourceMappingURL=security.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"security.js","names":[],"sources":["../../../src/server/spec/security.ts"],"sourcesContent":["import type { PathsObject, SecurityRequirementObject } from '@scalar/openapi-types/3.2'\nimport type { Access, SanitizedConfig } from 'payload'\n\nimport { PLUGIN_NAME } from '@/shared/constants.js'\nimport type {\n Entity,\n EntityOperation,\n EntitySecurityOverride,\n HttpMethod,\n OperationKind,\n SecurityOption,\n} from '@/shared/types/index.js'\nimport { isPlainObject } from '@/shared/utils.js'\n\nimport { INTERACTIVE_SCHEME_NAME, SECURITY_SCHEME_NAME } from './components.js'\nimport { operationPlugin } from './filters.js'\n\nconst HTTP_METHODS: HttpMethod[] = ['get', 'post', 'patch', 'put', 'delete']\n\nexport const securedRequirement = (login = false): SecurityRequirementObject[] =>\n login ? [{ [SECURITY_SCHEME_NAME]: [] }, { [INTERACTIVE_SCHEME_NAME]: [] }] : [{ [SECURITY_SCHEME_NAME]: [] }]\n\ntype ProbedOperation = EntityOperation | 'readVersions'\n\nconst OVERRIDE_FALLBACK: Partial<Record<ProbedOperation, EntityOperation>> = {\n readVersions: 'read',\n validate: 'update',\n}\n\nexport type EntitySecurity = Partial<Record<ProbedOperation, SecurityRequirementObject[] | undefined>>\n\nconst withTimeout = async (promise: Promise<unknown>, timeoutMs: number): Promise<boolean> => {\n let timer: ReturnType<typeof setTimeout> | undefined\n const guard = new Promise<false>((resolve) => {\n timer = setTimeout(() => resolve(false), timeoutMs)\n })\n try {\n return await Promise.race([\n promise.then(\n (value) => value === true,\n () => false,\n ),\n guard,\n ])\n } finally {\n if (timer) clearTimeout(timer)\n }\n}\n\nexport const evaluateAccess = async (\n access: Access | undefined,\n opts: { locale?: string; timeoutMs?: number; baseAccess?: SanitizedConfig['baseAccess'] } = {},\n): Promise<boolean> => {\n if (!access) return false\n const { locale, timeoutMs = 250, baseAccess } = opts\n const trap = <T extends object>(allowed: PropertyKey, value: unknown): T =>\n new Proxy({} as T, {\n get(_target, key) {\n if (key === allowed) return value\n throw new Error('req.payload accessed during build')\n },\n })\n const payloadTrap = trap('config', trap('baseAccess', baseAccess))\n const req = { user: null, headers: new Headers(), context: {}, locale, payload: payloadTrap }\n try {\n const result = access({ req } as never)\n if (result && typeof (result as Promise<unknown>).then === 'function') {\n return await withTimeout(result as Promise<unknown>, timeoutMs)\n }\n return result === true\n } catch {\n return false\n }\n}\n\nexport const readSecurityOverride = (entity: {\n slug: string\n custom?: { openapi?: { security?: unknown } }\n}): EntitySecurityOverride | undefined => {\n const meta = entity.custom?.openapi?.security\n const values = isPlainObject(meta) ? Object.values(meta) : [meta]\n if (values.some((value) => typeof value === 'boolean')) {\n throw new Error(\n `[${PLUGIN_NAME}] custom.openapi.security true/false on \"${entity.slug}\" was removed, use 'public' or 'secured'`,\n )\n }\n return meta === undefined ? undefined : (meta as EntitySecurityOverride)\n}\n\nconst overrideFor = (override: EntitySecurityOverride | undefined, op: ProbedOperation): boolean | undefined => {\n const fallback = OVERRIDE_FALLBACK[op]\n const marking =\n typeof override === 'string'\n ? override\n : (override?.[op as EntityOperation] ?? (fallback ? override?.[fallback] : undefined))\n return marking === undefined ? undefined : marking === 'public'\n}\n\nexport const resolveEntitySecurity = async ({\n entity,\n operations,\n locale,\n baseAccess,\n}: {\n entity: Entity\n operations: ProbedOperation[]\n locale?: string\n baseAccess?: SanitizedConfig['baseAccess']\n}): Promise<EntitySecurity> => {\n const override = readSecurityOverride(entity)\n const access = entity.access as Partial<Record<ProbedOperation, Access>> | undefined\n const out: EntitySecurity = {}\n for (const op of operations) {\n const declared = overrideFor(override, op)\n const isPublic = declared ?? (await evaluateAccess(access?.[op], { locale, baseAccess }))\n out[op] = isPublic ? undefined : securedRequirement()\n }\n return out\n}\n\nconst withLogin = (security: SecurityRequirementObject[]): SecurityRequirementObject[] =>\n security.some((r) => SECURITY_SCHEME_NAME in r) && !security.some((r) => INTERACTIVE_SCHEME_NAME in r)\n ? [...security, { [INTERACTIVE_SCHEME_NAME]: [] }]\n : security\n\nexport const applySecurity = async ({\n paths,\n slug,\n kind,\n plugin,\n security,\n login = false,\n}: {\n paths: PathsObject\n slug?: string\n kind: OperationKind\n plugin?: string\n security?: SecurityOption\n login?: boolean\n}): Promise<PathsObject> => {\n if (!security && !login) return paths\n for (const [path, item] of Object.entries(paths)) {\n if (!item) continue\n const ops = item as Record<HttpMethod, { security?: SecurityRequirementObject[] } | undefined>\n for (const method of HTTP_METHODS) {\n const op = ops[method]\n if (!op) continue\n if (login && op.security) op.security = withLogin(op.security)\n if (!security) continue\n const detected = op.security?.length ? 'secured' : 'public'\n const decision = await security({ method, path, slug, kind, plugin: operationPlugin(op, plugin), detected })\n if (decision === 'public') delete op.security\n else if (decision === 'secured') op.security = securedRequirement(login)\n else if (Array.isArray(decision)) op.security = decision\n }\n }\n return paths\n}\n"],"mappings":";;;;AAiBA,MAAM,eAA6B;CAAC;CAAO;CAAQ;CAAS;CAAO;AAAQ;AAE3E,MAAa,sBAAsB,QAAQ,UACzC,QAAQ,CAAC,GAAG,uBAAuB,CAAC,EAAE,GAAG,GAAG,0BAA0B,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,uBAAuB,CAAC,EAAE,CAAC;AAI/G,MAAM,oBAAuE;CAC3E,cAAc;CACd,UAAU;AACZ;AAIA,MAAM,cAAc,OAAO,SAA2B,cAAwC;CAC5F,IAAI;CACJ,MAAM,QAAQ,IAAI,SAAgB,YAAY;EAC5C,QAAQ,iBAAiB,QAAQ,KAAK,GAAG,SAAS;CACpD,CAAC;CACD,IAAI;EACF,OAAO,MAAM,QAAQ,KAAK,CACxB,QAAQ,MACL,UAAU,UAAU,YACf,KACR,GACA,KACF,CAAC;CACH,UAAU;EACR,IAAI,OAAO,aAAa,KAAK;CAC/B;AACF;AAEA,MAAa,iBAAiB,OAC5B,QACA,OAA4F,CAAC,MACxE;CACrB,IAAI,CAAC,QAAQ,OAAO;CACpB,MAAM,EAAE,QAAQ,YAAY,KAAK,eAAe;CAChD,MAAM,QAA0B,SAAsB,UACpD,IAAI,MAAM,CAAC,GAAQ,EACjB,IAAI,SAAS,KAAK;EAChB,IAAI,QAAQ,SAAS,OAAO;EAC5B,MAAM,IAAI,MAAM,mCAAmC;CACrD,EACF,CAAC;CACH,MAAM,cAAc,KAAK,UAAU,KAAK,cAAc,UAAU,CAAC;CACjE,MAAM,MAAM;EAAE,MAAM;EAAM,SAAS,IAAI,QAAQ;EAAG,SAAS,CAAC;EAAG;EAAQ,SAAS;CAAY;CAC5F,IAAI;EACF,MAAM,SAAS,OAAO,EAAE,IAAI,CAAU;EACtC,IAAI,UAAU,OAAQ,OAA4B,SAAS,YACzD,OAAO,MAAM,YAAY,QAA4B,SAAS;EAEhE,OAAO,WAAW;CACpB,QAAQ;EACN,OAAO;CACT;AACF;AAEA,MAAa,wBAAwB,WAGK;CACxC,MAAM,OAAO,OAAO,QAAQ,SAAS;CAErC,KADe,cAAc,IAAI,IAAI,OAAO,OAAO,IAAI,IAAI,CAAC,IAAI,EAAA,CACrD,MAAM,UAAU,OAAO,UAAU,SAAS,GACnD,MAAM,IAAI,MACR,IAAI,YAAY,2CAA2C,OAAO,KAAK,yCACzE;CAEF,OAAO,SAAS,KAAA,IAAY,KAAA,IAAa;AAC3C;AAEA,MAAM,eAAe,UAA8C,OAA6C;CAC9G,MAAM,WAAW,kBAAkB;CACnC,MAAM,UACJ,OAAO,aAAa,WAChB,WACC,WAAW,QAA2B,WAAW,WAAW,YAAY,KAAA;CAC/E,OAAO,YAAY,KAAA,IAAY,KAAA,IAAY,YAAY;AACzD;AAEA,MAAa,wBAAwB,OAAO,EAC1C,QACA,YACA,QACA,iBAM6B;CAC7B,MAAM,WAAW,qBAAqB,MAAM;CAC5C,MAAM,SAAS,OAAO;CACtB,MAAM,MAAsB,CAAC;CAC7B,KAAK,MAAM,MAAM,YAGf,IAAI,MAFa,YAAY,UAAU,EACf,KAAM,MAAM,eAAe,SAAS,KAAK;EAAE;EAAQ;CAAW,CAAC,IAClE,KAAA,IAAY,mBAAmB;CAEtD,OAAO;AACT;AAEA,MAAM,aAAa,aACjB,SAAS,MAAM,MAAA,kBAA8B,CAAC,KAAK,CAAC,SAAS,MAAM,MAAA,kBAAiC,CAAC,IACjG,CAAC,GAAG,UAAU,GAAG,0BAA0B,CAAC,EAAE,CAAC,IAC/C;AAEN,MAAa,gBAAgB,OAAO,EAClC,OACA,MACA,MACA,QACA,UACA,QAAQ,YAQkB;CAC1B,IAAI,CAAC,YAAY,CAAC,OAAO,OAAO;CAChC,KAAK,MAAM,CAAC,MAAM,SAAS,OAAO,QAAQ,KAAK,GAAG;EAChD,IAAI,CAAC,MAAM;EACX,MAAM,MAAM;EACZ,KAAK,MAAM,UAAU,cAAc;GACjC,MAAM,KAAK,IAAI;GACf,IAAI,CAAC,IAAI;GACT,IAAI,SAAS,GAAG,UAAU,GAAG,WAAW,UAAU,GAAG,QAAQ;GAC7D,IAAI,CAAC,UAAU;GACf,MAAM,WAAW,GAAG,UAAU,SAAS,YAAY;GACnD,MAAM,WAAW,MAAM,SAAS;IAAE;IAAQ;IAAM;IAAM;IAAM,QAAQ,gBAAgB,IAAI,MAAM;IAAG;GAAS,CAAC;GAC3G,IAAI,aAAa,UAAU,OAAO,GAAG;QAChC,IAAI,aAAa,WAAW,GAAG,WAAW,mBAAmB,KAAK;QAClE,IAAI,MAAM,QAAQ,QAAQ,GAAG,GAAG,WAAW;EAClD;CACF;CACA,OAAO;AACT"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { Translate } from "../../shared/translations/types.js";
|
|
2
|
+
import { TagObject } from "@scalar/openapi-types/3.2";
|
|
3
|
+
export declare const NAV_COLLECTIONS = "Collections";
|
|
4
|
+
export declare const NAV_GLOBALS = "Globals";
|
|
5
|
+
export declare const NAV_SYSTEM = "System";
|
|
6
|
+
export declare const NAV_PLUGINS = "Plugins";
|
|
7
|
+
export declare const entityTagName: (base: string) => string;
|
|
8
|
+
export declare const authTagName: (base: string) => string;
|
|
9
|
+
export declare const versionsTagName: (base: string) => string;
|
|
10
|
+
declare const SYSTEM_TAG_SUMMARIES: {
|
|
11
|
+
readonly Jobs: 'tagJobs';
|
|
12
|
+
readonly Uploads: 'tagUploads';
|
|
13
|
+
readonly Reorder: 'tagReorder';
|
|
14
|
+
readonly Access: 'tagAccess';
|
|
15
|
+
};
|
|
16
|
+
export type SystemTag = keyof typeof SYSTEM_TAG_SUMMARIES;
|
|
17
|
+
export interface CollectionTagInfo {
|
|
18
|
+
base: string;
|
|
19
|
+
hasAuth: boolean;
|
|
20
|
+
hasVersions: boolean;
|
|
21
|
+
description?: string;
|
|
22
|
+
}
|
|
23
|
+
export interface GlobalTagInfo {
|
|
24
|
+
base: string;
|
|
25
|
+
hasVersions: boolean;
|
|
26
|
+
description?: string;
|
|
27
|
+
}
|
|
28
|
+
export interface TagHierarchyInput {
|
|
29
|
+
collections: CollectionTagInfo[];
|
|
30
|
+
globals: GlobalTagInfo[];
|
|
31
|
+
systemTags: SystemTag[];
|
|
32
|
+
pluginTags?: string[];
|
|
33
|
+
t: Translate;
|
|
34
|
+
nested: boolean;
|
|
35
|
+
}
|
|
36
|
+
export declare const buildTagHierarchy: ({ collections, globals, systemTags, pluginTags, t, nested }: TagHierarchyInput) => TagObject[];
|
|
37
|
+
//# sourceMappingURL=tags.d.ts.map
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
const NAV_COLLECTIONS = "Collections";
|
|
2
|
+
const NAV_GLOBALS = "Globals";
|
|
3
|
+
const NAV_SYSTEM = "System";
|
|
4
|
+
const NAV_PLUGINS = "Plugins";
|
|
5
|
+
const entityTagName = (base) => base;
|
|
6
|
+
const authTagName = (base) => `${base} Auth`;
|
|
7
|
+
const versionsTagName = (base) => `${base} Versions`;
|
|
8
|
+
const SYSTEM_TAG_SUMMARIES = {
|
|
9
|
+
Jobs: "tagJobs",
|
|
10
|
+
Uploads: "tagUploads",
|
|
11
|
+
Reorder: "tagReorder",
|
|
12
|
+
Access: "tagAccess"
|
|
13
|
+
};
|
|
14
|
+
const buildTagHierarchy = ({ collections, globals, systemTags, pluginTags = [], t, nested }) => {
|
|
15
|
+
if (!nested) return [...collections.map((c) => ({
|
|
16
|
+
name: entityTagName(c.base),
|
|
17
|
+
description: c.description
|
|
18
|
+
})), ...globals.map((g) => ({
|
|
19
|
+
name: entityTagName(g.base),
|
|
20
|
+
description: g.description
|
|
21
|
+
}))];
|
|
22
|
+
const tags = [];
|
|
23
|
+
if (collections.length > 0) {
|
|
24
|
+
tags.push({
|
|
25
|
+
name: NAV_COLLECTIONS,
|
|
26
|
+
summary: t("tagCollections"),
|
|
27
|
+
description: t("tagCollectionsDesc"),
|
|
28
|
+
kind: "nav"
|
|
29
|
+
});
|
|
30
|
+
for (const c of collections) {
|
|
31
|
+
tags.push({
|
|
32
|
+
name: entityTagName(c.base),
|
|
33
|
+
parent: NAV_COLLECTIONS,
|
|
34
|
+
description: c.description
|
|
35
|
+
});
|
|
36
|
+
if (c.hasAuth) tags.push({
|
|
37
|
+
name: authTagName(c.base),
|
|
38
|
+
parent: c.base,
|
|
39
|
+
summary: t("tagAuth")
|
|
40
|
+
});
|
|
41
|
+
if (c.hasVersions) tags.push({
|
|
42
|
+
name: versionsTagName(c.base),
|
|
43
|
+
parent: c.base,
|
|
44
|
+
summary: t("tagVersions")
|
|
45
|
+
});
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
if (globals.length > 0) {
|
|
49
|
+
tags.push({
|
|
50
|
+
name: NAV_GLOBALS,
|
|
51
|
+
summary: t("tagGlobals"),
|
|
52
|
+
description: t("tagGlobalsDesc"),
|
|
53
|
+
kind: "nav"
|
|
54
|
+
});
|
|
55
|
+
for (const g of globals) {
|
|
56
|
+
tags.push({
|
|
57
|
+
name: entityTagName(g.base),
|
|
58
|
+
parent: NAV_GLOBALS,
|
|
59
|
+
description: g.description
|
|
60
|
+
});
|
|
61
|
+
if (g.hasVersions) tags.push({
|
|
62
|
+
name: versionsTagName(g.base),
|
|
63
|
+
parent: g.base,
|
|
64
|
+
summary: t("tagVersions")
|
|
65
|
+
});
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
if (systemTags.length > 0) {
|
|
69
|
+
tags.push({
|
|
70
|
+
name: NAV_SYSTEM,
|
|
71
|
+
summary: t("tagSystem"),
|
|
72
|
+
description: t("tagSystemDesc"),
|
|
73
|
+
kind: "nav"
|
|
74
|
+
});
|
|
75
|
+
for (const name of systemTags) tags.push({
|
|
76
|
+
name,
|
|
77
|
+
parent: NAV_SYSTEM,
|
|
78
|
+
summary: t(SYSTEM_TAG_SUMMARIES[name])
|
|
79
|
+
});
|
|
80
|
+
}
|
|
81
|
+
const taken = new Set(tags.map((tag) => tag.name));
|
|
82
|
+
const freePluginTags = pluginTags.filter((name) => !taken.has(name));
|
|
83
|
+
if (freePluginTags.length > 0) {
|
|
84
|
+
tags.push({
|
|
85
|
+
name: NAV_PLUGINS,
|
|
86
|
+
summary: t("tagPlugins"),
|
|
87
|
+
description: t("tagPluginsDesc"),
|
|
88
|
+
kind: "nav"
|
|
89
|
+
});
|
|
90
|
+
for (const name of freePluginTags) tags.push({
|
|
91
|
+
name,
|
|
92
|
+
parent: NAV_PLUGINS
|
|
93
|
+
});
|
|
94
|
+
}
|
|
95
|
+
return tags;
|
|
96
|
+
};
|
|
97
|
+
export { NAV_COLLECTIONS, NAV_GLOBALS, NAV_PLUGINS, NAV_SYSTEM, authTagName, buildTagHierarchy, entityTagName, versionsTagName };
|
|
98
|
+
|
|
99
|
+
//# sourceMappingURL=tags.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tags.js","names":[],"sources":["../../../src/server/spec/tags.ts"],"sourcesContent":["import type { TagObject } from '@scalar/openapi-types/3.2'\n\nimport type { Translate } from '@/shared/translations/types.js'\n\nexport const NAV_COLLECTIONS = 'Collections'\nexport const NAV_GLOBALS = 'Globals'\nexport const NAV_SYSTEM = 'System'\nexport const NAV_PLUGINS = 'Plugins'\n\nexport const entityTagName = (base: string): string => base\nexport const authTagName = (base: string): string => `${base} Auth`\nexport const versionsTagName = (base: string): string => `${base} Versions`\n\nconst SYSTEM_TAG_SUMMARIES = {\n Jobs: 'tagJobs',\n Uploads: 'tagUploads',\n Reorder: 'tagReorder',\n Access: 'tagAccess',\n} as const\n\nexport type SystemTag = keyof typeof SYSTEM_TAG_SUMMARIES\n\nexport interface CollectionTagInfo {\n base: string\n hasAuth: boolean\n hasVersions: boolean\n description?: string\n}\n\nexport interface GlobalTagInfo {\n base: string\n hasVersions: boolean\n description?: string\n}\n\nexport interface TagHierarchyInput {\n collections: CollectionTagInfo[]\n globals: GlobalTagInfo[]\n systemTags: SystemTag[]\n pluginTags?: string[]\n t: Translate\n nested: boolean\n}\n\nexport const buildTagHierarchy = ({\n collections,\n globals,\n systemTags,\n pluginTags = [],\n t,\n nested,\n}: TagHierarchyInput): TagObject[] => {\n if (!nested) {\n return [\n ...collections.map((c) => ({ name: entityTagName(c.base), description: c.description })),\n ...globals.map((g) => ({ name: entityTagName(g.base), description: g.description })),\n ]\n }\n\n const tags: TagObject[] = []\n\n if (collections.length > 0) {\n tags.push({\n name: NAV_COLLECTIONS,\n summary: t('tagCollections'),\n description: t('tagCollectionsDesc'),\n kind: 'nav',\n })\n for (const c of collections) {\n tags.push({ name: entityTagName(c.base), parent: NAV_COLLECTIONS, description: c.description })\n if (c.hasAuth) tags.push({ name: authTagName(c.base), parent: c.base, summary: t('tagAuth') })\n if (c.hasVersions) tags.push({ name: versionsTagName(c.base), parent: c.base, summary: t('tagVersions') })\n }\n }\n\n if (globals.length > 0) {\n tags.push({ name: NAV_GLOBALS, summary: t('tagGlobals'), description: t('tagGlobalsDesc'), kind: 'nav' })\n for (const g of globals) {\n tags.push({ name: entityTagName(g.base), parent: NAV_GLOBALS, description: g.description })\n if (g.hasVersions) tags.push({ name: versionsTagName(g.base), parent: g.base, summary: t('tagVersions') })\n }\n }\n\n if (systemTags.length > 0) {\n tags.push({ name: NAV_SYSTEM, summary: t('tagSystem'), description: t('tagSystemDesc'), kind: 'nav' })\n for (const name of systemTags) tags.push({ name, parent: NAV_SYSTEM, summary: t(SYSTEM_TAG_SUMMARIES[name]) })\n }\n\n const taken = new Set(tags.map((tag) => tag.name))\n const freePluginTags = pluginTags.filter((name) => !taken.has(name))\n if (freePluginTags.length > 0) {\n tags.push({ name: NAV_PLUGINS, summary: t('tagPlugins'), description: t('tagPluginsDesc'), kind: 'nav' })\n for (const name of freePluginTags) tags.push({ name, parent: NAV_PLUGINS })\n }\n\n return tags\n}\n"],"mappings":"AAIA,MAAa,kBAAkB;AAC/B,MAAa,cAAc;AAC3B,MAAa,aAAa;AAC1B,MAAa,cAAc;AAE3B,MAAa,iBAAiB,SAAyB;AACvD,MAAa,eAAe,SAAyB,GAAG,KAAK;AAC7D,MAAa,mBAAmB,SAAyB,GAAG,KAAK;AAEjE,MAAM,uBAAuB;CAC3B,MAAM;CACN,SAAS;CACT,SAAS;CACT,QAAQ;AACV;AA0BA,MAAa,qBAAqB,EAChC,aACA,SACA,YACA,aAAa,CAAC,GACd,GACA,aACoC;CACpC,IAAI,CAAC,QACH,OAAO,CACL,GAAG,YAAY,KAAK,OAAO;EAAE,MAAM,cAAc,EAAE,IAAI;EAAG,aAAa,EAAE;CAAY,EAAE,GACvF,GAAG,QAAQ,KAAK,OAAO;EAAE,MAAM,cAAc,EAAE,IAAI;EAAG,aAAa,EAAE;CAAY,EAAE,CACrF;CAGF,MAAM,OAAoB,CAAC;CAE3B,IAAI,YAAY,SAAS,GAAG;EAC1B,KAAK,KAAK;GACR,MAAM;GACN,SAAS,EAAE,gBAAgB;GAC3B,aAAa,EAAE,oBAAoB;GACnC,MAAM;EACR,CAAC;EACD,KAAK,MAAM,KAAK,aAAa;GAC3B,KAAK,KAAK;IAAE,MAAM,cAAc,EAAE,IAAI;IAAG,QAAQ;IAAiB,aAAa,EAAE;GAAY,CAAC;GAC9F,IAAI,EAAE,SAAS,KAAK,KAAK;IAAE,MAAM,YAAY,EAAE,IAAI;IAAG,QAAQ,EAAE;IAAM,SAAS,EAAE,SAAS;GAAE,CAAC;GAC7F,IAAI,EAAE,aAAa,KAAK,KAAK;IAAE,MAAM,gBAAgB,EAAE,IAAI;IAAG,QAAQ,EAAE;IAAM,SAAS,EAAE,aAAa;GAAE,CAAC;EAC3G;CACF;CAEA,IAAI,QAAQ,SAAS,GAAG;EACtB,KAAK,KAAK;GAAE,MAAM;GAAa,SAAS,EAAE,YAAY;GAAG,aAAa,EAAE,gBAAgB;GAAG,MAAM;EAAM,CAAC;EACxG,KAAK,MAAM,KAAK,SAAS;GACvB,KAAK,KAAK;IAAE,MAAM,cAAc,EAAE,IAAI;IAAG,QAAQ;IAAa,aAAa,EAAE;GAAY,CAAC;GAC1F,IAAI,EAAE,aAAa,KAAK,KAAK;IAAE,MAAM,gBAAgB,EAAE,IAAI;IAAG,QAAQ,EAAE;IAAM,SAAS,EAAE,aAAa;GAAE,CAAC;EAC3G;CACF;CAEA,IAAI,WAAW,SAAS,GAAG;EACzB,KAAK,KAAK;GAAE,MAAM;GAAY,SAAS,EAAE,WAAW;GAAG,aAAa,EAAE,eAAe;GAAG,MAAM;EAAM,CAAC;EACrG,KAAK,MAAM,QAAQ,YAAY,KAAK,KAAK;GAAE;GAAM,QAAQ;GAAY,SAAS,EAAE,qBAAqB,KAAK;EAAE,CAAC;CAC/G;CAEA,MAAM,QAAQ,IAAI,IAAI,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC;CACjD,MAAM,iBAAiB,WAAW,QAAQ,SAAS,CAAC,MAAM,IAAI,IAAI,CAAC;CACnE,IAAI,eAAe,SAAS,GAAG;EAC7B,KAAK,KAAK;GAAE,MAAM;GAAa,SAAS,EAAE,YAAY;GAAG,aAAa,EAAE,gBAAgB;GAAG,MAAM;EAAM,CAAC;EACxG,KAAK,MAAM,QAAQ,gBAAgB,KAAK,KAAK;GAAE;GAAM,QAAQ;EAAY,CAAC;CAC5E;CAEA,OAAO;AACT"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { OpenApiPluginOptions, ResolvedOptions } from "../shared/types/index.js";
|
|
2
|
+
import { Payload, PluginsMap } from "payload";
|
|
3
|
+
export type TelemetryFeatures = {
|
|
4
|
+
access: boolean;
|
|
5
|
+
cache: boolean;
|
|
6
|
+
extensions: boolean;
|
|
7
|
+
extensionTransform: boolean;
|
|
8
|
+
filtersEntities: boolean;
|
|
9
|
+
filtersExcludeOperations: boolean;
|
|
10
|
+
filtersIncludeSystem: boolean;
|
|
11
|
+
interactiveAuth: boolean;
|
|
12
|
+
nestedTags: boolean;
|
|
13
|
+
openapiVersion30: boolean;
|
|
14
|
+
openapiVersion31: boolean;
|
|
15
|
+
security: boolean;
|
|
16
|
+
serve: boolean;
|
|
17
|
+
servers: boolean;
|
|
18
|
+
trustedHosts: boolean;
|
|
19
|
+
uiScalar: boolean;
|
|
20
|
+
uiSwagger: boolean;
|
|
21
|
+
};
|
|
22
|
+
export declare const buildFeatures: ({ plugins, resolved }: {
|
|
23
|
+
plugins: PluginsMap;
|
|
24
|
+
resolved: ResolvedOptions;
|
|
25
|
+
}) => TelemetryFeatures;
|
|
26
|
+
export declare const reportOpenApiTelemetry: ({ features, options, payload }: {
|
|
27
|
+
features: TelemetryFeatures;
|
|
28
|
+
options: OpenApiPluginOptions;
|
|
29
|
+
payload: Payload;
|
|
30
|
+
}) => Promise<void>;
|
|
31
|
+
//# sourceMappingURL=telemetry.d.ts.map
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { PLUGIN_NAME, SCALAR_PLUGIN_NAME, SWAGGER_UI_PLUGIN_NAME } from "../shared/constants.js";
|
|
2
|
+
import { reportTelemetry } from "../_tooling/telemetry.js";
|
|
3
|
+
const buildFeatures = ({ plugins, resolved }) => ({
|
|
4
|
+
access: Boolean(resolved.access),
|
|
5
|
+
cache: resolved.cache,
|
|
6
|
+
extensions: resolved.extensions.length > 0,
|
|
7
|
+
extensionTransform: resolved.extensions.some((extension) => Boolean(extension.transform)),
|
|
8
|
+
filtersEntities: resolved.filters.include.length > 0 || resolved.filters.exclude.length > 0,
|
|
9
|
+
filtersExcludeOperations: resolved.filters.excludeOperations.length > 0,
|
|
10
|
+
filtersIncludeSystem: resolved.filters.includeSystem,
|
|
11
|
+
interactiveAuth: resolved.interactiveAuth.enabled,
|
|
12
|
+
nestedTags: resolved.nestedTags,
|
|
13
|
+
openapiVersion30: resolved.openapiVersion === "3.0",
|
|
14
|
+
openapiVersion31: resolved.openapiVersion === "3.1",
|
|
15
|
+
security: Boolean(resolved.security),
|
|
16
|
+
serve: resolved.serve,
|
|
17
|
+
servers: Boolean(resolved.servers),
|
|
18
|
+
trustedHosts: resolved.trustedHosts.length > 0,
|
|
19
|
+
uiScalar: Boolean(plugins[SCALAR_PLUGIN_NAME]),
|
|
20
|
+
uiSwagger: Boolean(plugins[SWAGGER_UI_PLUGIN_NAME])
|
|
21
|
+
});
|
|
22
|
+
const reportOpenApiTelemetry = ({ features, options, payload }) => reportTelemetry({
|
|
23
|
+
disableEnv: "OPENAPI_TELEMETRY_DISABLED",
|
|
24
|
+
docsUrl: "https://payload-plugin-openapi.seshuk.im/v1/configuration/telemetry",
|
|
25
|
+
features,
|
|
26
|
+
option: options.telemetry,
|
|
27
|
+
packageName: PLUGIN_NAME,
|
|
28
|
+
payload,
|
|
29
|
+
product: "payload-plugin-openapi"
|
|
30
|
+
});
|
|
31
|
+
export { buildFeatures, reportOpenApiTelemetry };
|
|
32
|
+
|
|
33
|
+
//# sourceMappingURL=telemetry.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"telemetry.js","names":[],"sources":["../../src/server/telemetry.ts"],"sourcesContent":["import { reportTelemetry } from '@seshuk/payload-plugin-tooling/telemetry'\nimport type { Payload, PluginsMap } from 'payload'\n\nimport { PLUGIN_NAME, SCALAR_PLUGIN_NAME, SWAGGER_UI_PLUGIN_NAME } from '@/shared/constants.js'\nimport type { OpenApiPluginOptions, ResolvedOptions } from '@/shared/types/index.js'\n\nexport type TelemetryFeatures = {\n access: boolean\n cache: boolean\n extensions: boolean\n extensionTransform: boolean\n filtersEntities: boolean\n filtersExcludeOperations: boolean\n filtersIncludeSystem: boolean\n interactiveAuth: boolean\n nestedTags: boolean\n openapiVersion30: boolean\n openapiVersion31: boolean\n security: boolean\n serve: boolean\n servers: boolean\n trustedHosts: boolean\n uiScalar: boolean\n uiSwagger: boolean\n}\n\nexport const buildFeatures = ({\n plugins,\n resolved,\n}: {\n plugins: PluginsMap\n resolved: ResolvedOptions\n}): TelemetryFeatures => ({\n access: Boolean(resolved.access),\n cache: resolved.cache,\n extensions: resolved.extensions.length > 0,\n extensionTransform: resolved.extensions.some((extension) => Boolean(extension.transform)),\n filtersEntities: resolved.filters.include.length > 0 || resolved.filters.exclude.length > 0,\n filtersExcludeOperations: resolved.filters.excludeOperations.length > 0,\n filtersIncludeSystem: resolved.filters.includeSystem,\n interactiveAuth: resolved.interactiveAuth.enabled,\n nestedTags: resolved.nestedTags,\n openapiVersion30: resolved.openapiVersion === '3.0',\n openapiVersion31: resolved.openapiVersion === '3.1',\n security: Boolean(resolved.security),\n serve: resolved.serve,\n servers: Boolean(resolved.servers),\n trustedHosts: resolved.trustedHosts.length > 0,\n uiScalar: Boolean(plugins[SCALAR_PLUGIN_NAME]),\n uiSwagger: Boolean(plugins[SWAGGER_UI_PLUGIN_NAME]),\n})\n\nexport const reportOpenApiTelemetry = ({\n features,\n options,\n payload,\n}: {\n features: TelemetryFeatures\n options: OpenApiPluginOptions\n payload: Payload\n}): Promise<void> =>\n reportTelemetry({\n disableEnv: 'OPENAPI_TELEMETRY_DISABLED',\n docsUrl: 'https://payload-plugin-openapi.seshuk.im/v1/configuration/telemetry',\n features,\n option: options.telemetry,\n packageName: PLUGIN_NAME,\n payload,\n product: 'payload-plugin-openapi',\n })\n"],"mappings":";;AA0BA,MAAa,iBAAiB,EAC5B,SACA,gBAIwB;CACxB,QAAQ,QAAQ,SAAS,MAAM;CAC/B,OAAO,SAAS;CAChB,YAAY,SAAS,WAAW,SAAS;CACzC,oBAAoB,SAAS,WAAW,MAAM,cAAc,QAAQ,UAAU,SAAS,CAAC;CACxF,iBAAiB,SAAS,QAAQ,QAAQ,SAAS,KAAK,SAAS,QAAQ,QAAQ,SAAS;CAC1F,0BAA0B,SAAS,QAAQ,kBAAkB,SAAS;CACtE,sBAAsB,SAAS,QAAQ;CACvC,iBAAiB,SAAS,gBAAgB;CAC1C,YAAY,SAAS;CACrB,kBAAkB,SAAS,mBAAmB;CAC9C,kBAAkB,SAAS,mBAAmB;CAC9C,UAAU,QAAQ,SAAS,QAAQ;CACnC,OAAO,SAAS;CAChB,SAAS,QAAQ,SAAS,OAAO;CACjC,cAAc,SAAS,aAAa,SAAS;CAC7C,UAAU,QAAQ,QAAQ,mBAAmB;CAC7C,WAAW,QAAQ,QAAQ,uBAAuB;AACpD;AAEA,MAAa,0BAA0B,EACrC,UACA,SACA,cAMA,gBAAgB;CACd,YAAY;CACZ,SAAS;CACT;CACA,QAAQ,QAAQ;CAChB,aAAa;CACb;CACA,SAAS;AACX,CAAC"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { UiPluginOptions } from "../../shared/types/index.js";
|
|
2
|
+
export interface UiRenderArgs {
|
|
3
|
+
specUrl: string;
|
|
4
|
+
cdnBase: string;
|
|
5
|
+
pinned: boolean;
|
|
6
|
+
title: string;
|
|
7
|
+
configuration: Record<string, unknown>;
|
|
8
|
+
}
|
|
9
|
+
export interface UiPluginSpec {
|
|
10
|
+
slug: string;
|
|
11
|
+
defaultDocsUrl: string;
|
|
12
|
+
defaultCdnBase: string;
|
|
13
|
+
render: (args: UiRenderArgs) => string;
|
|
14
|
+
}
|
|
15
|
+
export declare const createUiPlugin: (spec: UiPluginSpec) => (options?: UiPluginOptions | undefined) => import("payload").Plugin;
|
|
16
|
+
//# sourceMappingURL=createUiPlugin.d.ts.map
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { PLUGIN_NAME } from "../../shared/constants.js";
|
|
2
|
+
import { assertNoRemovedKeys } from "../options/resolveOptions.js";
|
|
3
|
+
import { Forbidden, definePlugin } from "payload";
|
|
4
|
+
const createUiPlugin = (spec) => definePlugin({
|
|
5
|
+
slug: spec.slug,
|
|
6
|
+
plugin: ({ config, options = {} }) => {
|
|
7
|
+
assertNoRemovedKeys([[options.specEndpoint, "specEndpoint was renamed to specURL"]]);
|
|
8
|
+
if (options.enabled === false) return config;
|
|
9
|
+
return {
|
|
10
|
+
...config,
|
|
11
|
+
endpoints: [...config.endpoints ?? [], {
|
|
12
|
+
path: options.path ?? spec.defaultDocsUrl,
|
|
13
|
+
method: "get",
|
|
14
|
+
handler: async (req) => {
|
|
15
|
+
if (options.access && await options.access({ req }) !== true) throw new Forbidden(req.t);
|
|
16
|
+
const { custom, routes } = req.payload.config;
|
|
17
|
+
const resolved = custom?.[PLUGIN_NAME];
|
|
18
|
+
const html = spec.render({
|
|
19
|
+
specUrl: options.specURL ?? `${routes?.api ?? "/api"}${resolved?.path ?? "/openapi.json"}`,
|
|
20
|
+
cdnBase: options.cdnBase ?? spec.defaultCdnBase,
|
|
21
|
+
pinned: (options.cdnBase ?? spec.defaultCdnBase) === spec.defaultCdnBase,
|
|
22
|
+
title: resolved?.info.title ?? "API Reference",
|
|
23
|
+
configuration: options.configuration ?? {}
|
|
24
|
+
});
|
|
25
|
+
return new Response(html, { headers: { "content-type": "text/html; charset=utf-8" } });
|
|
26
|
+
}
|
|
27
|
+
}]
|
|
28
|
+
};
|
|
29
|
+
}
|
|
30
|
+
});
|
|
31
|
+
export { createUiPlugin };
|
|
32
|
+
|
|
33
|
+
//# sourceMappingURL=createUiPlugin.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createUiPlugin.js","names":[],"sources":["../../../src/server/ui/createUiPlugin.ts"],"sourcesContent":["import { definePlugin, Forbidden } from 'payload'\n\nimport { assertNoRemovedKeys } from '@/server/options/resolveOptions.js'\nimport { PLUGIN_NAME } from '@/shared/constants.js'\nimport type { ResolvedOptions, UiPluginOptions } from '@/shared/types/index.js'\n\nexport interface UiRenderArgs {\n specUrl: string\n cdnBase: string\n pinned: boolean\n title: string\n configuration: Record<string, unknown>\n}\n\nexport interface UiPluginSpec {\n slug: string\n defaultDocsUrl: string\n defaultCdnBase: string\n render: (args: UiRenderArgs) => string\n}\n\nexport const createUiPlugin = (spec: UiPluginSpec) =>\n definePlugin<UiPluginOptions | undefined>({\n slug: spec.slug,\n plugin: ({ config, options = {} }) => {\n assertNoRemovedKeys([[(options as Record<string, unknown>).specEndpoint, 'specEndpoint was renamed to specURL']])\n if (options.enabled === false) return config\n\n return {\n ...config,\n endpoints: [\n ...(config.endpoints ?? []),\n {\n path: options.path ?? spec.defaultDocsUrl,\n method: 'get',\n handler: async (req) => {\n if (options.access && (await options.access({ req })) !== true) throw new Forbidden(req.t)\n const { custom, routes } = req.payload.config\n const resolved = custom?.[PLUGIN_NAME] as ResolvedOptions | undefined\n const html = spec.render({\n specUrl: options.specURL ?? `${routes?.api ?? '/api'}${resolved?.path ?? '/openapi.json'}`,\n cdnBase: options.cdnBase ?? spec.defaultCdnBase,\n pinned: (options.cdnBase ?? spec.defaultCdnBase) === spec.defaultCdnBase,\n title: resolved?.info.title ?? 'API Reference',\n configuration: options.configuration ?? {},\n })\n return new Response(html, { headers: { 'content-type': 'text/html; charset=utf-8' } })\n },\n },\n ],\n }\n },\n })\n"],"mappings":";;;AAqBA,MAAa,kBAAkB,SAC7B,aAA0C;CACxC,MAAM,KAAK;CACX,SAAS,EAAE,QAAQ,UAAU,CAAC,QAAQ;EACpC,oBAAoB,CAAC,CAAE,QAAoC,cAAc,qCAAqC,CAAC,CAAC;EAChH,IAAI,QAAQ,YAAY,OAAO,OAAO;EAEtC,OAAO;GACL,GAAG;GACH,WAAW,CACT,GAAI,OAAO,aAAa,CAAC,GACzB;IACE,MAAM,QAAQ,QAAQ,KAAK;IAC3B,QAAQ;IACR,SAAS,OAAO,QAAQ;KACtB,IAAI,QAAQ,UAAW,MAAM,QAAQ,OAAO,EAAE,IAAI,CAAC,MAAO,MAAM,MAAM,IAAI,UAAU,IAAI,CAAC;KACzF,MAAM,EAAE,QAAQ,WAAW,IAAI,QAAQ;KACvC,MAAM,WAAW,SAAS;KAC1B,MAAM,OAAO,KAAK,OAAO;MACvB,SAAS,QAAQ,WAAW,GAAG,QAAQ,OAAO,SAAS,UAAU,QAAQ;MACzE,SAAS,QAAQ,WAAW,KAAK;MACjC,SAAS,QAAQ,WAAW,KAAK,oBAAoB,KAAK;MAC1D,OAAO,UAAU,KAAK,SAAS;MAC/B,eAAe,QAAQ,iBAAiB,CAAC;KAC3C,CAAC;KACD,OAAO,IAAI,SAAS,MAAM,EAAE,SAAS,EAAE,gBAAgB,2BAA2B,EAAE,CAAC;IACvF;GACF,CACF;EACF;CACF;AACF,CAAC"}
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
export declare const escapeHtml: (value: string) => string;
|
|
2
2
|
export declare const jsonForScript: (value: unknown) => string;
|
|
3
3
|
export declare const htmlPage: ({ title, head, body }: {
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
4
|
+
title: string;
|
|
5
|
+
head: string;
|
|
6
|
+
body: string;
|
|
7
7
|
}) => string;
|
|
8
8
|
export declare const specUrlExpr: (specUrl: string) => string;
|
|
9
|
+
export declare const integrityAttrs: (pinned: boolean, integrity: string) => string;
|
|
10
|
+
//# sourceMappingURL=html.d.ts.map
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
const escapeHtml = (value) => value.replace(/&/g, "&").replace(/</g, "<").replace(/>/g, ">").replace(/"/g, """);
|
|
2
|
+
const jsonForScript = (value) => JSON.stringify(value ?? {}).replace(/[<>&\u2028\u2029]/g, (char) => `\\u${char.charCodeAt(0).toString(16).padStart(4, "0")}`);
|
|
3
|
+
const htmlPage = ({ title, head, body }) => `<!doctype html><html><head><meta charset="utf-8"/><title>${escapeHtml(title)}</title><meta name="viewport" content="width=device-width, initial-scale=1"/>${head}</head><body>${body}</body></html>`;
|
|
4
|
+
const specUrlExpr = (specUrl) => {
|
|
5
|
+
const u = jsonForScript(specUrl);
|
|
6
|
+
return `(function(){var l=new URLSearchParams(location.search).get('lang');return ${u}+(l?((${u}.indexOf('?')>-1?'&':'?')+'lang='+encodeURIComponent(l)):'')})()`;
|
|
7
|
+
};
|
|
8
|
+
const integrityAttrs = (pinned, integrity) => pinned ? ` integrity="${integrity}" crossorigin="anonymous"` : "";
|
|
9
|
+
export { escapeHtml, htmlPage, integrityAttrs, jsonForScript, specUrlExpr };
|
|
10
|
+
|
|
11
|
+
//# sourceMappingURL=html.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"html.js","names":[],"sources":["../../../src/server/ui/html.ts"],"sourcesContent":["export const escapeHtml = (value: string): string =>\n value.replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>').replace(/\"/g, '"')\n\nexport const jsonForScript = (value: unknown): string =>\n JSON.stringify(value ?? {}).replace(\n /[<>&\\u2028\\u2029]/g,\n (char) => `\\\\u${char.charCodeAt(0).toString(16).padStart(4, '0')}`,\n )\n\nexport const htmlPage = ({ title, head, body }: { title: string; head: string; body: string }): string =>\n `<!doctype html><html><head><meta charset=\"utf-8\"/><title>${escapeHtml(title)}</title>` +\n `<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\"/>${head}</head>` +\n `<body>${body}</body></html>`\n\nexport const specUrlExpr = (specUrl: string): string => {\n const u = jsonForScript(specUrl)\n return `(function(){var l=new URLSearchParams(location.search).get('lang');return ${u}+(l?((${u}.indexOf('?')>-1?'&':'?')+'lang='+encodeURIComponent(l)):'')})()`\n}\n\nexport const integrityAttrs = (pinned: boolean, integrity: string): string =>\n pinned ? ` integrity=\"${integrity}\" crossorigin=\"anonymous\"` : ''\n"],"mappings":"AAAA,MAAa,cAAc,UACzB,MAAM,QAAQ,MAAM,OAAO,CAAC,CAAC,QAAQ,MAAM,MAAM,CAAC,CAAC,QAAQ,MAAM,MAAM,CAAC,CAAC,QAAQ,MAAM,QAAQ;AAEjG,MAAa,iBAAiB,UAC5B,KAAK,UAAU,SAAS,CAAC,CAAC,CAAC,CAAC,QAC1B,uBACC,SAAS,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,SAAS,GAAG,GAAG,GACjE;AAEF,MAAa,YAAY,EAAE,OAAO,MAAM,WACtC,4DAA4D,WAAW,KAAK,EAAE,+EACN,KAAK,eACpE,KAAK;AAEhB,MAAa,eAAe,YAA4B;CACtD,MAAM,IAAI,cAAc,OAAO;CAC/B,OAAO,6EAA6E,EAAE,QAAQ,EAAE;AAClG;AAEA,MAAa,kBAAkB,QAAiB,cAC9C,SAAS,eAAe,UAAU,6BAA6B"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { SCALAR_PLUGIN_NAME } from "../../shared/constants.js";
|
|
2
|
+
import { createUiPlugin } from "./createUiPlugin.js";
|
|
3
|
+
import { escapeHtml, htmlPage, integrityAttrs, jsonForScript, specUrlExpr } from "./html.js";
|
|
4
|
+
const SCRIPT_INTEGRITY = "sha384-omTRdD9MbjA1vm12DqRUVvqJlr3VzSixvAdF1Jruu9AJOiJKyTKraIB6DyX+m10M";
|
|
5
|
+
const scalar = createUiPlugin({
|
|
6
|
+
slug: SCALAR_PLUGIN_NAME,
|
|
7
|
+
defaultDocsUrl: "/docs",
|
|
8
|
+
defaultCdnBase: "https://cdn.jsdelivr.net/npm/@scalar/api-reference@1.72.4/dist/browser/standalone.js",
|
|
9
|
+
render: ({ specUrl, cdnBase, pinned, title, configuration }) => htmlPage({
|
|
10
|
+
title,
|
|
11
|
+
head: "",
|
|
12
|
+
body: `<div id="app"></div><script src="${escapeHtml(cdnBase)}"${integrityAttrs(pinned, SCRIPT_INTEGRITY)}><\/script><script>Scalar.createApiReference('#app',{url:${specUrlExpr(specUrl)},...${jsonForScript(configuration)}})<\/script>`
|
|
13
|
+
})
|
|
14
|
+
});
|
|
15
|
+
export { scalar };
|
|
16
|
+
|
|
17
|
+
//# sourceMappingURL=scalar.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"scalar.js","names":[],"sources":["../../../src/server/ui/scalar.ts"],"sourcesContent":["import { SCALAR_PLUGIN_NAME } from '@/shared/constants.js'\n\nimport { createUiPlugin } from './createUiPlugin.js'\nimport { escapeHtml, htmlPage, integrityAttrs, jsonForScript, specUrlExpr } from './html.js'\n\nconst SCRIPT_INTEGRITY = 'sha384-omTRdD9MbjA1vm12DqRUVvqJlr3VzSixvAdF1Jruu9AJOiJKyTKraIB6DyX+m10M'\n\nexport const scalar = createUiPlugin({\n slug: SCALAR_PLUGIN_NAME,\n defaultDocsUrl: '/docs',\n defaultCdnBase: 'https://cdn.jsdelivr.net/npm/@scalar/api-reference@1.72.4/dist/browser/standalone.js',\n render: ({ specUrl, cdnBase, pinned, title, configuration }) =>\n htmlPage({\n title,\n head: '',\n body:\n `<div id=\"app\"></div>` +\n `<script src=\"${escapeHtml(cdnBase)}\"${integrityAttrs(pinned, SCRIPT_INTEGRITY)}></script>` +\n `<script>Scalar.createApiReference('#app',{url:${specUrlExpr(specUrl)},` +\n `...${jsonForScript(configuration)}})</script>`,\n }),\n})\n"],"mappings":";;;AAKA,MAAM,mBAAmB;AAEzB,MAAa,SAAS,eAAe;CACnC,MAAM;CACN,gBAAgB;CAChB,gBAAgB;CAChB,SAAS,EAAE,SAAS,SAAS,QAAQ,OAAO,oBAC1C,SAAS;EACP;EACA,MAAM;EACN,MACE,oCACgB,WAAW,OAAO,EAAE,GAAG,eAAe,QAAQ,gBAAgB,EAAE,2DAC/B,YAAY,OAAO,EAAE,MAChE,cAAc,aAAa,EAAE;CACvC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { SWAGGER_UI_PLUGIN_NAME } from "../../shared/constants.js";
|
|
2
|
+
import { createUiPlugin } from "./createUiPlugin.js";
|
|
3
|
+
import { escapeHtml, htmlPage, integrityAttrs, jsonForScript, specUrlExpr } from "./html.js";
|
|
4
|
+
const STYLE_INTEGRITY = "sha384-Ov4/wv3j2bmct8cDc5X4ngJZohVPzEmc6uDPH8WeljUxO5vtoykvMEfbu9Vh6RaW";
|
|
5
|
+
const SCRIPT_INTEGRITY = "sha384-ZPehFMQommnnuaZ4rpxgkgTT2DKFVp4hZC/7pLit+9Lek9T1YGSo23eHFbvNkXkw";
|
|
6
|
+
const swaggerUi = createUiPlugin({
|
|
7
|
+
slug: SWAGGER_UI_PLUGIN_NAME,
|
|
8
|
+
defaultDocsUrl: "/docs",
|
|
9
|
+
defaultCdnBase: "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.33.1",
|
|
10
|
+
render: ({ specUrl, cdnBase, pinned, title, configuration }) => htmlPage({
|
|
11
|
+
title,
|
|
12
|
+
head: `<link rel="stylesheet" href="${escapeHtml(cdnBase)}/swagger-ui.css"${integrityAttrs(pinned, STYLE_INTEGRITY)}/>`,
|
|
13
|
+
body: `<div id="swagger-ui"></div><script src="${escapeHtml(cdnBase)}/swagger-ui-bundle.js"${integrityAttrs(pinned, SCRIPT_INTEGRITY)}><\/script><script>window.onload=()=>SwaggerUIBundle({url:${specUrlExpr(specUrl)},dom_id:'#swagger-ui',...${jsonForScript(configuration)}})<\/script>`
|
|
14
|
+
})
|
|
15
|
+
});
|
|
16
|
+
export { swaggerUi };
|
|
17
|
+
|
|
18
|
+
//# sourceMappingURL=swagger.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"swagger.js","names":[],"sources":["../../../src/server/ui/swagger.ts"],"sourcesContent":["import { SWAGGER_UI_PLUGIN_NAME } from '@/shared/constants.js'\n\nimport { createUiPlugin } from './createUiPlugin.js'\nimport { escapeHtml, htmlPage, integrityAttrs, jsonForScript, specUrlExpr } from './html.js'\n\nconst STYLE_INTEGRITY = 'sha384-Ov4/wv3j2bmct8cDc5X4ngJZohVPzEmc6uDPH8WeljUxO5vtoykvMEfbu9Vh6RaW'\nconst SCRIPT_INTEGRITY = 'sha384-ZPehFMQommnnuaZ4rpxgkgTT2DKFVp4hZC/7pLit+9Lek9T1YGSo23eHFbvNkXkw'\n\nexport const swaggerUi = createUiPlugin({\n slug: SWAGGER_UI_PLUGIN_NAME,\n defaultDocsUrl: '/docs',\n defaultCdnBase: 'https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.33.1',\n render: ({ specUrl, cdnBase, pinned, title, configuration }) =>\n htmlPage({\n title,\n head: `<link rel=\"stylesheet\" href=\"${escapeHtml(cdnBase)}/swagger-ui.css\"${integrityAttrs(pinned, STYLE_INTEGRITY)}/>`,\n body:\n `<div id=\"swagger-ui\"></div>` +\n `<script src=\"${escapeHtml(cdnBase)}/swagger-ui-bundle.js\"${integrityAttrs(pinned, SCRIPT_INTEGRITY)}></script>` +\n `<script>window.onload=()=>SwaggerUIBundle({url:${specUrlExpr(specUrl)},` +\n `dom_id:'#swagger-ui',...${jsonForScript(configuration)}})</script>`,\n }),\n})\n"],"mappings":";;;AAKA,MAAM,kBAAkB;AACxB,MAAM,mBAAmB;AAEzB,MAAa,YAAY,eAAe;CACtC,MAAM;CACN,gBAAgB;CAChB,gBAAgB;CAChB,SAAS,EAAE,SAAS,SAAS,QAAQ,OAAO,oBAC1C,SAAS;EACP;EACA,MAAM,gCAAgC,WAAW,OAAO,EAAE,kBAAkB,eAAe,QAAQ,eAAe,EAAE;EACpH,MACE,2CACgB,WAAW,OAAO,EAAE,wBAAwB,eAAe,QAAQ,gBAAgB,EAAE,4DACnD,YAAY,OAAO,EAAE,2BAC5C,cAAc,aAAa,EAAE;CAC5D,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export declare const PLUGIN_NAME = "@seshuk/payload-plugin-openapi";
|
|
2
|
+
export declare const SCALAR_PLUGIN_NAME = "@seshuk/payload-plugin-openapi/scalar";
|
|
3
|
+
export declare const SWAGGER_UI_PLUGIN_NAME = "@seshuk/payload-plugin-openapi/swagger-ui";
|
|
4
|
+
//# sourceMappingURL=constants.d.ts.map
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
const PLUGIN_NAME = "@seshuk/payload-plugin-openapi";
|
|
2
|
+
const SCALAR_PLUGIN_NAME = `${PLUGIN_NAME}/scalar`;
|
|
3
|
+
const SWAGGER_UI_PLUGIN_NAME = `${PLUGIN_NAME}/swagger-ui`;
|
|
4
|
+
export { PLUGIN_NAME, SCALAR_PLUGIN_NAME, SWAGGER_UI_PLUGIN_NAME };
|
|
5
|
+
|
|
6
|
+
//# sourceMappingURL=constants.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"constants.js","names":[],"sources":["../../src/shared/constants.ts"],"sourcesContent":["export const PLUGIN_NAME = '@seshuk/payload-plugin-openapi'\nexport const SCALAR_PLUGIN_NAME = `${PLUGIN_NAME}/scalar`\nexport const SWAGGER_UI_PLUGIN_NAME = `${PLUGIN_NAME}/swagger-ui`\n"],"mappings":"AAAA,MAAa,cAAc;AAC3B,MAAa,qBAAqB,GAAG,YAAY;AACjD,MAAa,yBAAyB,GAAG,YAAY"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { PluginDefaultTranslationsObject, Translate } from "./types.js";
|
|
2
|
+
import { AcceptedLanguages, I18n } from "@payloadcms/translations";
|
|
3
|
+
export declare const makeT: (i18n: Pick<I18n, 't'>) => Translate;
|
|
4
|
+
export declare const translations: { [key in AcceptedLanguages]?: PluginDefaultTranslationsObject; };
|
|
5
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -43,54 +43,56 @@ import { uk } from "./locales/uk.js";
|
|
|
43
43
|
import { vi } from "./locales/vi.js";
|
|
44
44
|
import { zh } from "./locales/zh.js";
|
|
45
45
|
import { zhTw } from "./locales/zhTw.js";
|
|
46
|
-
const makeT = (i18n)=>{
|
|
47
|
-
|
|
48
|
-
|
|
46
|
+
const makeT = (i18n) => {
|
|
47
|
+
const t = i18n.t;
|
|
48
|
+
return (key, vars) => t ? t(`${PLUGIN_NAME}:${key}`, vars) : key;
|
|
49
49
|
};
|
|
50
50
|
const translations = {
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
51
|
+
ar,
|
|
52
|
+
az,
|
|
53
|
+
bg,
|
|
54
|
+
"bn-BD": bnBd,
|
|
55
|
+
"bn-IN": bnIn,
|
|
56
|
+
ca,
|
|
57
|
+
cs,
|
|
58
|
+
da,
|
|
59
|
+
de,
|
|
60
|
+
en,
|
|
61
|
+
es,
|
|
62
|
+
et,
|
|
63
|
+
fa,
|
|
64
|
+
fr,
|
|
65
|
+
he,
|
|
66
|
+
hr,
|
|
67
|
+
hu,
|
|
68
|
+
hy,
|
|
69
|
+
id,
|
|
70
|
+
is,
|
|
71
|
+
it,
|
|
72
|
+
ja,
|
|
73
|
+
ko,
|
|
74
|
+
lt,
|
|
75
|
+
lv,
|
|
76
|
+
my,
|
|
77
|
+
nb,
|
|
78
|
+
nl,
|
|
79
|
+
pl,
|
|
80
|
+
pt,
|
|
81
|
+
ro,
|
|
82
|
+
rs,
|
|
83
|
+
"rs-latin": rsLatin,
|
|
84
|
+
ru,
|
|
85
|
+
sk,
|
|
86
|
+
sl,
|
|
87
|
+
sv,
|
|
88
|
+
ta,
|
|
89
|
+
th,
|
|
90
|
+
tr,
|
|
91
|
+
uk,
|
|
92
|
+
vi,
|
|
93
|
+
zh,
|
|
94
|
+
"zh-TW": zhTw
|
|
95
95
|
};
|
|
96
96
|
export { makeT, translations };
|
|
97
|
+
|
|
98
|
+
//# sourceMappingURL=index.js.map
|