frontend-plugin-api: switch naming recommendation from define to defineParams

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2025-08-01 11:11:51 +02:00
parent e739a01e2d
commit 147482b700
40 changed files with 225 additions and 214 deletions
+41 -41
View File
@@ -74,8 +74,8 @@ import { DefaultDialogApi } from './apis/DefaultDialogApi';
export const apis = [
ApiBlueprint.make({
name: 'dialog',
params: define =>
define({
params: defineParams =>
defineParams({
api: dialogApiRef,
deps: {},
factory: () => new DefaultDialogApi(),
@@ -83,8 +83,8 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'discovery',
params: define =>
define({
params: defineParams =>
defineParams({
api: discoveryApiRef,
deps: { configApi: configApiRef },
factory: ({ configApi }) =>
@@ -95,8 +95,8 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'alert',
params: define =>
define({
params: defineParams =>
defineParams({
api: alertApiRef,
deps: {},
factory: () => new AlertApiForwarder(),
@@ -104,8 +104,8 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'analytics',
params: define =>
define({
params: defineParams =>
defineParams({
api: analyticsApiRef,
deps: {},
factory: () => new NoOpAnalyticsApi(),
@@ -113,8 +113,8 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'error',
params: define =>
define({
params: defineParams =>
defineParams({
api: errorApiRef,
deps: { alertApi: alertApiRef },
factory: ({ alertApi }) => {
@@ -126,8 +126,8 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'storage',
params: define =>
define({
params: defineParams =>
defineParams({
api: storageApiRef,
deps: { errorApi: errorApiRef },
factory: ({ errorApi }) => WebStorage.create({ errorApi }),
@@ -135,8 +135,8 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'fetch',
params: define =>
define({
params: defineParams =>
defineParams({
api: fetchApiRef,
deps: {
configApi: configApiRef,
@@ -160,8 +160,8 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'oauth-request',
params: define =>
define({
params: defineParams =>
defineParams({
api: oauthRequestApiRef,
deps: {},
factory: () => new OAuthRequestManager(),
@@ -169,8 +169,8 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'google-auth',
params: define =>
define({
params: defineParams =>
defineParams({
api: googleAuthApiRef,
deps: {
discoveryApi: discoveryApiRef,
@@ -188,8 +188,8 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'microsoft-auth',
params: define =>
define({
params: defineParams =>
defineParams({
api: microsoftAuthApiRef,
deps: {
discoveryApi: discoveryApiRef,
@@ -207,8 +207,8 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'github-auth',
params: define =>
define({
params: defineParams =>
defineParams({
api: githubAuthApiRef,
deps: {
discoveryApi: discoveryApiRef,
@@ -227,8 +227,8 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'okta-auth',
params: define =>
define({
params: defineParams =>
defineParams({
api: oktaAuthApiRef,
deps: {
discoveryApi: discoveryApiRef,
@@ -246,8 +246,8 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'gitlab-auth',
params: define =>
define({
params: defineParams =>
defineParams({
api: gitlabAuthApiRef,
deps: {
discoveryApi: discoveryApiRef,
@@ -265,8 +265,8 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'onelogin-auth',
params: define =>
define({
params: defineParams =>
defineParams({
api: oneloginAuthApiRef,
deps: {
discoveryApi: discoveryApiRef,
@@ -284,8 +284,8 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'bitbucket-auth',
params: define =>
define({
params: defineParams =>
defineParams({
api: bitbucketAuthApiRef,
deps: {
discoveryApi: discoveryApiRef,
@@ -304,8 +304,8 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'bitbucket-server-auth',
params: define =>
define({
params: defineParams =>
defineParams({
api: bitbucketServerAuthApiRef,
deps: {
discoveryApi: discoveryApiRef,
@@ -324,8 +324,8 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'atlassian-auth',
params: define =>
define({
params: defineParams =>
defineParams({
api: atlassianAuthApiRef,
deps: {
discoveryApi: discoveryApiRef,
@@ -344,8 +344,8 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'vmware-cloud-auth',
params: define =>
define({
params: defineParams =>
defineParams({
api: vmwareCloudAuthApiRef,
deps: {
discoveryApi: discoveryApiRef,
@@ -364,8 +364,8 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'permission',
params: define =>
define({
params: defineParams =>
defineParams({
api: permissionApiRef,
deps: {
discovery: discoveryApiRef,
@@ -378,12 +378,12 @@ export const apis = [
}),
ApiBlueprint.make({
name: 'scm-auth',
params: define => define(ScmAuth.createDefaultApiFactory()),
params: defineParams => defineParams(ScmAuth.createDefaultApiFactory()),
}),
ApiBlueprint.make({
name: 'scm-integrations',
params: define =>
define({
params: defineParams =>
defineParams({
api: scmIntegrationsApiRef,
deps: { configApi: configApiRef },
factory: ({ configApi }) => ScmIntegrationsApi.fromConfig(configApi),
+2 -2
View File
@@ -21,8 +21,8 @@ import { ApiBlueprint } from '@backstage/frontend-plugin-api';
export const AppLanguageApi = ApiBlueprint.make({
name: 'app-language',
params: define =>
define({
params: defineParams =>
defineParams({
api: appLanguageApiRef,
deps: {},
factory: () => AppLanguageSelector.createWithStorage(),
+2 -2
View File
@@ -40,8 +40,8 @@ export const AppThemeApi = ApiBlueprint.makeWithOverrides({
}),
},
factory: (originalFactory, { inputs }) => {
return originalFactory(define =>
define({
return originalFactory(defineParams =>
defineParams({
api: appThemeApiRef,
deps: {},
factory: () =>
+2 -2
View File
@@ -35,8 +35,8 @@ export const ComponentsApi = ApiBlueprint.makeWithOverrides({
),
},
factory: (originalFactory, { inputs }) => {
return originalFactory(define =>
define({
return originalFactory(defineParams =>
defineParams({
api: componentsApiRef,
deps: {},
factory: () =>
@@ -26,8 +26,8 @@ import { LocalStorageFeatureFlags } from '../../../../packages/core-app-api/src/
*/
export const FeatureFlagsApi = ApiBlueprint.make({
name: 'feature-flags',
params: define =>
define({
params: defineParams =>
defineParams({
// TODO: properly discovery feature flags, maybe rework the whole thing
api: featureFlagsApiRef,
deps: {},
+2 -2
View File
@@ -36,8 +36,8 @@ export const IconsApi = ApiBlueprint.makeWithOverrides({
}),
},
factory: (originalFactory, { inputs }) => {
return originalFactory(define =>
define({
return originalFactory(defineParams =>
defineParams({
api: iconsApiRef,
deps: {},
factory: () =>
@@ -38,8 +38,8 @@ export const TranslationsApi = ApiBlueprint.makeWithOverrides({
),
},
factory: (originalFactory, { inputs }) => {
return originalFactory(define =>
define({
return originalFactory(defineParams =>
defineParams({
api: translationApiRef,
deps: { languageApi: appLanguageApiRef },
factory: ({ languageApi }) =>