@backstage/plugin-catalog-import 0.13.11-next.1 → 0.13.11
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/CHANGELOG.md +29 -0
- package/README.md +18 -10
- package/dist/alpha.d.ts +5 -4
- package/dist/alpha.esm.js +3 -2
- package/dist/alpha.esm.js.map +1 -1
- package/dist/index.d.ts +78 -8
- package/dist/index.esm.js +1 -0
- package/dist/index.esm.js.map +1 -1
- package/dist/package.json.esm.js +1 -1
- package/dist/translation.esm.js.map +1 -1
- package/package.json +18 -18
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,34 @@
|
|
|
1
1
|
# @backstage/plugin-catalog-import
|
|
2
2
|
|
|
3
|
+
## 0.13.11
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 538c985: Updated installation documentation to use feature discovery as the default.
|
|
8
|
+
- 0be2541: Promoted the plugin's translation ref to the stable package entry point. It was previously only available through the alpha entry point.
|
|
9
|
+
- Updated dependencies
|
|
10
|
+
- @backstage/plugin-catalog-react@2.1.0
|
|
11
|
+
- @backstage/core-plugin-api@1.12.4
|
|
12
|
+
- @backstage/core-components@0.18.8
|
|
13
|
+
- @backstage/frontend-plugin-api@0.15.0
|
|
14
|
+
- @backstage/catalog-client@1.14.0
|
|
15
|
+
- @backstage/integration@2.0.0
|
|
16
|
+
- @backstage/plugin-permission-react@0.4.41
|
|
17
|
+
- @backstage/catalog-model@1.7.7
|
|
18
|
+
- @backstage/integration-react@1.2.16
|
|
19
|
+
|
|
20
|
+
## 0.13.11-next.2
|
|
21
|
+
|
|
22
|
+
### Patch Changes
|
|
23
|
+
|
|
24
|
+
- Updated dependencies
|
|
25
|
+
- @backstage/frontend-plugin-api@0.15.0-next.1
|
|
26
|
+
- @backstage/core-plugin-api@1.12.4-next.1
|
|
27
|
+
- @backstage/catalog-client@1.14.0-next.2
|
|
28
|
+
- @backstage/plugin-catalog-react@2.1.0-next.2
|
|
29
|
+
- @backstage/integration@2.0.0-next.2
|
|
30
|
+
- @backstage/core-components@0.18.8-next.1
|
|
31
|
+
|
|
3
32
|
## 0.13.11-next.1
|
|
4
33
|
|
|
5
34
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -15,22 +15,14 @@ Some features are not yet available for all supported Git providers.
|
|
|
15
15
|
|
|
16
16
|
## Getting Started
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
Install the Catalog Import Plugin:
|
|
19
19
|
|
|
20
20
|
```bash
|
|
21
21
|
# From your Backstage root directory
|
|
22
22
|
yarn --cwd packages/app add @backstage/plugin-catalog-import
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
```tsx
|
|
28
|
-
// packages/app/src/App.tsx
|
|
29
|
-
|
|
30
|
-
import { CatalogImportPage } from '@backstage/plugin-catalog-import';
|
|
31
|
-
|
|
32
|
-
<Route path="/catalog-import" element={<CatalogImportPage />} />;
|
|
33
|
-
```
|
|
25
|
+
Once installed, the plugin is automatically available in your app through the default feature discovery. For more details and alternative installation methods, see [installing plugins](https://backstage.io/docs/frontend-system/building-apps/installing-plugins).
|
|
34
26
|
|
|
35
27
|
## Customizations
|
|
36
28
|
|
|
@@ -104,6 +96,22 @@ Following React components accept optional props for providing custom example en
|
|
|
104
96
|
/>
|
|
105
97
|
```
|
|
106
98
|
|
|
99
|
+
## Old Frontend System
|
|
100
|
+
|
|
101
|
+
If your Backstage app uses the old frontend system, you need to manually wire the
|
|
102
|
+
plugin into your app as outlined in this section. If you are on the new frontend
|
|
103
|
+
system, you can skip this.
|
|
104
|
+
|
|
105
|
+
Add the `CatalogImportPage` extension to the app:
|
|
106
|
+
|
|
107
|
+
```tsx
|
|
108
|
+
// packages/app/src/App.tsx
|
|
109
|
+
|
|
110
|
+
import { CatalogImportPage } from '@backstage/plugin-catalog-import';
|
|
111
|
+
|
|
112
|
+
<Route path="/catalog-import" element={<CatalogImportPage />} />;
|
|
113
|
+
```
|
|
114
|
+
|
|
107
115
|
## Development
|
|
108
116
|
|
|
109
117
|
Use `yarn start` to run a [development version](./dev/index.tsx) of the plugin that can be used to validate each flow with mocked data.
|
package/dist/alpha.d.ts
CHANGED
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
import * as react from 'react';
|
|
2
|
-
import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
|
|
3
2
|
import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
|
|
3
|
+
import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
|
|
4
4
|
|
|
5
|
-
/**
|
|
5
|
+
/**
|
|
6
|
+
* @alpha
|
|
7
|
+
* @deprecated Import from `@backstage/plugin-catalog-import` instead.
|
|
8
|
+
*/
|
|
6
9
|
declare const catalogImportTranslationRef: _backstage_frontend_plugin_api.TranslationRef<"catalog-import", {
|
|
7
10
|
readonly "buttons.back": "Back";
|
|
8
11
|
readonly "defaultImportPage.headerTitle": "Register an existing component";
|
|
@@ -71,7 +74,6 @@ declare const catalogImportTranslationRef: _backstage_frontend_plugin_api.Transl
|
|
|
71
74
|
readonly "stepReviewLocation.prepareResult.title": "The following Pull Request has been opened: ";
|
|
72
75
|
readonly "stepReviewLocation.prepareResult.description": "You can already import the location and {{appTitle}} will fetch the entities as soon as the Pull Request is merged.";
|
|
73
76
|
}>;
|
|
74
|
-
|
|
75
77
|
/** @alpha */
|
|
76
78
|
declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin<{
|
|
77
79
|
importPage: _backstage_core_plugin_api.RouteRef<undefined>;
|
|
@@ -117,7 +119,6 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
|
|
|
117
119
|
}>;
|
|
118
120
|
};
|
|
119
121
|
params: {
|
|
120
|
-
defaultPath?: [Error: `Use the 'path' param instead`];
|
|
121
122
|
path: string;
|
|
122
123
|
title?: string;
|
|
123
124
|
icon?: _backstage_frontend_plugin_api.IconElement;
|
package/dist/alpha.esm.js
CHANGED
|
@@ -8,8 +8,9 @@ import { rootRouteRef } from './plugin.esm.js';
|
|
|
8
8
|
import { catalogApiRef } from '@backstage/plugin-catalog-react';
|
|
9
9
|
import { RequirePermission } from '@backstage/plugin-permission-react';
|
|
10
10
|
import { catalogEntityCreatePermission } from '@backstage/plugin-catalog-common/alpha';
|
|
11
|
-
|
|
11
|
+
import { catalogImportTranslationRef as catalogImportTranslationRef$1 } from './translation.esm.js';
|
|
12
12
|
|
|
13
|
+
const catalogImportTranslationRef = catalogImportTranslationRef$1;
|
|
13
14
|
const catalogImportPage = PageBlueprint.make({
|
|
14
15
|
params: {
|
|
15
16
|
path: "/catalog-import",
|
|
@@ -54,5 +55,5 @@ var alpha = createFrontendPlugin({
|
|
|
54
55
|
}
|
|
55
56
|
});
|
|
56
57
|
|
|
57
|
-
export { alpha as default };
|
|
58
|
+
export { catalogImportTranslationRef, alpha as default };
|
|
58
59
|
//# sourceMappingURL=alpha.esm.js.map
|
package/dist/alpha.esm.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alpha.esm.js","sources":["../src/alpha.tsx"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n configApiRef,\n discoveryApiRef,\n fetchApiRef,\n} from '@backstage/core-plugin-api';\nimport {\n createFrontendPlugin,\n PageBlueprint,\n ApiBlueprint,\n} from '@backstage/frontend-plugin-api';\nimport {\n scmAuthApiRef,\n scmIntegrationsApiRef,\n} from '@backstage/integration-react';\nimport { CatalogImportClient, catalogImportApiRef } from './api';\nimport { rootRouteRef } from './plugin';\nimport { catalogApiRef } from '@backstage/plugin-catalog-react';\nimport { RequirePermission } from '@backstage/plugin-permission-react';\nimport { catalogEntityCreatePermission } from '@backstage/plugin-catalog-common/alpha';\n\
|
|
1
|
+
{"version":3,"file":"alpha.esm.js","sources":["../src/alpha.tsx"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n configApiRef,\n discoveryApiRef,\n fetchApiRef,\n} from '@backstage/core-plugin-api';\nimport {\n createFrontendPlugin,\n PageBlueprint,\n ApiBlueprint,\n} from '@backstage/frontend-plugin-api';\nimport {\n scmAuthApiRef,\n scmIntegrationsApiRef,\n} from '@backstage/integration-react';\nimport { CatalogImportClient, catalogImportApiRef } from './api';\nimport { rootRouteRef } from './plugin';\nimport { catalogApiRef } from '@backstage/plugin-catalog-react';\nimport { RequirePermission } from '@backstage/plugin-permission-react';\nimport { catalogEntityCreatePermission } from '@backstage/plugin-catalog-common/alpha';\n\nimport { catalogImportTranslationRef as _catalogImportTranslationRef } from './translation';\n\n/**\n * @alpha\n * @deprecated Import from `@backstage/plugin-catalog-import` instead.\n */\nexport const catalogImportTranslationRef = _catalogImportTranslationRef;\n\n// TODO: It's currently possible to override the import page with a custom one. We need to decide\n// whether this type of override is typically done with an input or by overriding the entire extension.\nconst catalogImportPage = PageBlueprint.make({\n params: {\n path: '/catalog-import',\n routeRef: rootRouteRef,\n loader: () =>\n import('./components/ImportPage').then(m => (\n <RequirePermission permission={catalogEntityCreatePermission}>\n <m.ImportPage />\n </RequirePermission>\n )),\n },\n});\n\nconst catalogImportApi = ApiBlueprint.make({\n params: defineParams =>\n defineParams({\n api: catalogImportApiRef,\n deps: {\n discoveryApi: discoveryApiRef,\n scmAuthApi: scmAuthApiRef,\n fetchApi: fetchApiRef,\n scmIntegrationsApi: scmIntegrationsApiRef,\n catalogApi: catalogApiRef,\n configApi: configApiRef,\n },\n factory: ({\n discoveryApi,\n scmAuthApi,\n fetchApi,\n scmIntegrationsApi,\n catalogApi,\n configApi,\n }) =>\n new CatalogImportClient({\n discoveryApi,\n scmAuthApi,\n scmIntegrationsApi,\n fetchApi,\n catalogApi,\n configApi,\n }),\n }),\n});\n\n/** @alpha */\nexport default createFrontendPlugin({\n pluginId: 'catalog-import',\n info: { packageJson: () => import('../package.json') },\n extensions: [catalogImportApi, catalogImportPage],\n routes: {\n importPage: rootRouteRef,\n },\n});\n"],"names":["_catalogImportTranslationRef"],"mappings":";;;;;;;;;;;;AA0CO,MAAM,2BAAA,GAA8BA;AAI3C,MAAM,iBAAA,GAAoB,cAAc,IAAA,CAAK;AAAA,EAC3C,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM,iBAAA;AAAA,IACN,QAAA,EAAU,YAAA;AAAA,IACV,QAAQ,MACN,OAAO,sCAAyB,CAAA,CAAE,KAAK,CAAA,CAAA,qBACrC,GAAA,CAAC,iBAAA,EAAA,EAAkB,UAAA,EAAY,+BAC7B,QAAA,kBAAA,GAAA,CAAC,CAAA,CAAE,UAAA,EAAF,EAAa,GAChB,CACD;AAAA;AAEP,CAAC,CAAA;AAED,MAAM,gBAAA,GAAmB,aAAa,IAAA,CAAK;AAAA,EACzC,MAAA,EAAQ,kBACN,YAAA,CAAa;AAAA,IACX,GAAA,EAAK,mBAAA;AAAA,IACL,IAAA,EAAM;AAAA,MACJ,YAAA,EAAc,eAAA;AAAA,MACd,UAAA,EAAY,aAAA;AAAA,MACZ,QAAA,EAAU,WAAA;AAAA,MACV,kBAAA,EAAoB,qBAAA;AAAA,MACpB,UAAA,EAAY,aAAA;AAAA,MACZ,SAAA,EAAW;AAAA,KACb;AAAA,IACA,SAAS,CAAC;AAAA,MACR,YAAA;AAAA,MACA,UAAA;AAAA,MACA,QAAA;AAAA,MACA,kBAAA;AAAA,MACA,UAAA;AAAA,MACA;AAAA,KACF,KACE,IAAI,mBAAA,CAAoB;AAAA,MACtB,YAAA;AAAA,MACA,UAAA;AAAA,MACA,kBAAA;AAAA,MACA,QAAA;AAAA,MACA,UAAA;AAAA,MACA;AAAA,KACD;AAAA,GACJ;AACL,CAAC,CAAA;AAGD,YAAe,oBAAA,CAAqB;AAAA,EAClC,QAAA,EAAU,gBAAA;AAAA,EACV,MAAM,EAAE,WAAA,EAAa,MAAM,OAAO,uBAAiB,CAAA,EAAE;AAAA,EACrD,UAAA,EAAY,CAAC,gBAAA,EAAkB,iBAAiB,CAAA;AAAA,EAChD,MAAA,EAAQ;AAAA,IACN,UAAA,EAAY;AAAA;AAEhB,CAAC,CAAA;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ import { Entity, CompoundEntityRef } from '@backstage/catalog-model';
|
|
|
5
5
|
import { ReactElement, ComponentProps, ReactNode } from 'react';
|
|
6
6
|
import { InfoCardVariants } from '@backstage/core-components';
|
|
7
7
|
import { TranslationFunction } from '@backstage/core-plugin-api/alpha';
|
|
8
|
-
import { catalogImportTranslationRef } from '@backstage/plugin-catalog-import/alpha';
|
|
8
|
+
import { catalogImportTranslationRef as catalogImportTranslationRef$1 } from '@backstage/plugin-catalog-import/alpha';
|
|
9
9
|
import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
|
|
10
10
|
import { TextFieldProps } from '@material-ui/core/TextField/TextField';
|
|
11
11
|
import { FieldErrors, Controller, UseFormProps, SubmitHandler, UseFormReturn, NestedValue } from 'react-hook-form';
|
|
@@ -266,25 +266,25 @@ interface StepperProvider {
|
|
|
266
266
|
activeState: 'analyze';
|
|
267
267
|
}>, opts: {
|
|
268
268
|
apis: StepperApis;
|
|
269
|
-
t: TranslationFunction<typeof catalogImportTranslationRef.T>;
|
|
269
|
+
t: TranslationFunction<typeof catalogImportTranslationRef$1.T>;
|
|
270
270
|
}) => StepConfiguration;
|
|
271
271
|
prepare: (s: Extract<ImportState, {
|
|
272
272
|
activeState: 'prepare';
|
|
273
273
|
}>, opts: {
|
|
274
274
|
apis: StepperApis;
|
|
275
|
-
t: TranslationFunction<typeof catalogImportTranslationRef.T>;
|
|
275
|
+
t: TranslationFunction<typeof catalogImportTranslationRef$1.T>;
|
|
276
276
|
}) => StepConfiguration;
|
|
277
277
|
review: (s: Extract<ImportState, {
|
|
278
278
|
activeState: 'review';
|
|
279
279
|
}>, opts: {
|
|
280
280
|
apis: StepperApis;
|
|
281
|
-
t: TranslationFunction<typeof catalogImportTranslationRef.T>;
|
|
281
|
+
t: TranslationFunction<typeof catalogImportTranslationRef$1.T>;
|
|
282
282
|
}) => StepConfiguration;
|
|
283
283
|
finish: (s: Extract<ImportState, {
|
|
284
284
|
activeState: 'finish';
|
|
285
285
|
}>, opts: {
|
|
286
286
|
apis: StepperApis;
|
|
287
|
-
t: TranslationFunction<typeof catalogImportTranslationRef.T>;
|
|
287
|
+
t: TranslationFunction<typeof catalogImportTranslationRef$1.T>;
|
|
288
288
|
}) => StepConfiguration;
|
|
289
289
|
}
|
|
290
290
|
/**
|
|
@@ -298,7 +298,7 @@ interface StepperProvider {
|
|
|
298
298
|
* @param t - the translation function
|
|
299
299
|
* @public
|
|
300
300
|
*/
|
|
301
|
-
declare function defaultGenerateStepper(flow: ImportFlows, defaults: StepperProvider, t: TranslationFunction<typeof catalogImportTranslationRef.T>): StepperProvider;
|
|
301
|
+
declare function defaultGenerateStepper(flow: ImportFlows, defaults: StepperProvider, t: TranslationFunction<typeof catalogImportTranslationRef$1.T>): StepperProvider;
|
|
302
302
|
|
|
303
303
|
/**
|
|
304
304
|
* Props for {@link ImportStepper}.
|
|
@@ -307,7 +307,7 @@ declare function defaultGenerateStepper(flow: ImportFlows, defaults: StepperProv
|
|
|
307
307
|
*/
|
|
308
308
|
interface ImportStepperProps {
|
|
309
309
|
initialUrl?: string;
|
|
310
|
-
generateStepper?: (flow: ImportFlows, defaults: StepperProvider, t: TranslationFunction<typeof catalogImportTranslationRef.T>) => StepperProvider;
|
|
310
|
+
generateStepper?: (flow: ImportFlows, defaults: StepperProvider, t: TranslationFunction<typeof catalogImportTranslationRef$1.T>) => StepperProvider;
|
|
311
311
|
variant?: InfoCardVariants;
|
|
312
312
|
}
|
|
313
313
|
/**
|
|
@@ -469,5 +469,75 @@ interface StepPrepareCreatePullRequestProps {
|
|
|
469
469
|
*/
|
|
470
470
|
declare const StepPrepareCreatePullRequest: (props: StepPrepareCreatePullRequestProps) => react_jsx_runtime.JSX.Element;
|
|
471
471
|
|
|
472
|
-
|
|
472
|
+
/** @public */
|
|
473
|
+
declare const catalogImportTranslationRef: _backstage_frontend_plugin_api.TranslationRef<"catalog-import", {
|
|
474
|
+
readonly "buttons.back": "Back";
|
|
475
|
+
readonly "defaultImportPage.headerTitle": "Register an existing component";
|
|
476
|
+
readonly "defaultImportPage.contentHeaderTitle": "Start tracking your component in {{appTitle}}";
|
|
477
|
+
readonly "defaultImportPage.supportTitle": "Start tracking your component in {{appTitle}} by adding it to the software catalog.";
|
|
478
|
+
readonly "importInfoCard.title": "Register an existing component";
|
|
479
|
+
readonly "importInfoCard.deepLinkTitle": "Learn more about the Software Catalog";
|
|
480
|
+
readonly "importInfoCard.linkDescription": "Enter the URL to your source code repository to add it to {{appTitle}}.";
|
|
481
|
+
readonly "importInfoCard.fileLinkTitle": "Link to an existing entity file";
|
|
482
|
+
readonly "importInfoCard.examplePrefix": "Example: ";
|
|
483
|
+
readonly "importInfoCard.fileLinkDescription": "The wizard analyzes the file, previews the entities, and adds them to the {{appTitle}} catalog.";
|
|
484
|
+
readonly "importInfoCard.exampleDescription": "The wizard discovers all {{catalogFilename}} files in the repository, previews the entities, and adds them to the {{appTitle}} catalog.";
|
|
485
|
+
readonly "importInfoCard.preparePullRequestDescription": "If no entities are found, the wizard will prepare a Pull Request that adds an example {{catalogFilename}} and prepares the {{appTitle}} catalog to load all entities as soon as the Pull Request is merged.";
|
|
486
|
+
readonly "importInfoCard.githubIntegration.label": "GitHub only";
|
|
487
|
+
readonly "importInfoCard.githubIntegration.title": "Link to a repository";
|
|
488
|
+
readonly "importStepper.finish.title": "Finish";
|
|
489
|
+
readonly "importStepper.singleLocation.title": "Select Locations";
|
|
490
|
+
readonly "importStepper.singleLocation.description": "Discovered Locations: 1";
|
|
491
|
+
readonly "importStepper.multipleLocations.title": "Select Locations";
|
|
492
|
+
readonly "importStepper.multipleLocations.description": "Discovered Locations: {{length, number}}";
|
|
493
|
+
readonly "importStepper.noLocation.title": "Create Pull Request";
|
|
494
|
+
readonly "importStepper.noLocation.createPr.detailsTitle": "Pull Request Details";
|
|
495
|
+
readonly "importStepper.noLocation.createPr.titleLabel": "Pull Request Title";
|
|
496
|
+
readonly "importStepper.noLocation.createPr.titlePlaceholder": "Add Backstage catalog entity descriptor files";
|
|
497
|
+
readonly "importStepper.noLocation.createPr.bodyLabel": "Pull Request Body";
|
|
498
|
+
readonly "importStepper.noLocation.createPr.bodyPlaceholder": "A describing text with Markdown support";
|
|
499
|
+
readonly "importStepper.noLocation.createPr.configurationTitle": "Entity Configuration";
|
|
500
|
+
readonly "importStepper.noLocation.createPr.componentNameLabel": "Name of the created component";
|
|
501
|
+
readonly "importStepper.noLocation.createPr.componentNamePlaceholder": "my-component";
|
|
502
|
+
readonly "importStepper.noLocation.createPr.ownerLoadingText": "Loading groups…";
|
|
503
|
+
readonly "importStepper.noLocation.createPr.ownerHelperText": "Select an owner from the list or enter a reference to a Group or a User";
|
|
504
|
+
readonly "importStepper.noLocation.createPr.ownerErrorHelperText": "required value";
|
|
505
|
+
readonly "importStepper.noLocation.createPr.ownerLabel": "Entity Owner";
|
|
506
|
+
readonly "importStepper.noLocation.createPr.ownerPlaceholder": "my-group";
|
|
507
|
+
readonly "importStepper.noLocation.createPr.codeownersHelperText": "WARNING: This may fail if no CODEOWNERS file is found at the target location.";
|
|
508
|
+
readonly "importStepper.analyze.title": "Select URL";
|
|
509
|
+
readonly "importStepper.prepare.title": "Import Actions";
|
|
510
|
+
readonly "importStepper.prepare.description": "Optional";
|
|
511
|
+
readonly "importStepper.review.title": "Review";
|
|
512
|
+
readonly "stepFinishImportLocation.repository.title": "The following Pull Request has been opened: ";
|
|
513
|
+
readonly "stepFinishImportLocation.repository.description": "Your entities will be imported as soon as the Pull Request is merged.";
|
|
514
|
+
readonly "stepFinishImportLocation.locations.new": "The following entities have been added to the catalog:";
|
|
515
|
+
readonly "stepFinishImportLocation.locations.backButtonText": "Register another";
|
|
516
|
+
readonly "stepFinishImportLocation.locations.existing": "A refresh was triggered for the following locations:";
|
|
517
|
+
readonly "stepFinishImportLocation.locations.viewButtonText": "View Component";
|
|
518
|
+
readonly "stepFinishImportLocation.backButtonText": "Register another";
|
|
519
|
+
readonly "stepInitAnalyzeUrl.error.default": "Received unknown analysis result of type {{type}}. Please contact the support team.";
|
|
520
|
+
readonly "stepInitAnalyzeUrl.error.url": "Must start with http:// or https://.";
|
|
521
|
+
readonly "stepInitAnalyzeUrl.error.repository": "Couldn't generate entities for your repository";
|
|
522
|
+
readonly "stepInitAnalyzeUrl.error.locations": "There are no entities at this location";
|
|
523
|
+
readonly "stepInitAnalyzeUrl.urlHelperText": "Enter the full path to your entity file to start tracking your component";
|
|
524
|
+
readonly "stepInitAnalyzeUrl.nextButtonText": "Analyze";
|
|
525
|
+
readonly "stepPrepareCreatePullRequest.description": "You entered a link to a {{integrationType}} repository but a {{catalogFilename}} could not be found. Use this form to open a Pull Request that creates one.";
|
|
526
|
+
readonly "stepPrepareCreatePullRequest.nextButtonText": "Create PR";
|
|
527
|
+
readonly "stepPrepareCreatePullRequest.previewPr.title": "Preview Pull Request";
|
|
528
|
+
readonly "stepPrepareCreatePullRequest.previewPr.subheader": "Create a new Pull Request";
|
|
529
|
+
readonly "stepPrepareCreatePullRequest.previewCatalogInfo.title": "Preview Entities";
|
|
530
|
+
readonly "stepPrepareSelectLocations.locations.description": "Select one or more locations that are present in your git repository:";
|
|
531
|
+
readonly "stepPrepareSelectLocations.locations.selectAll": "Select All";
|
|
532
|
+
readonly "stepPrepareSelectLocations.nextButtonText": "Review";
|
|
533
|
+
readonly "stepPrepareSelectLocations.existingLocations.description": "These locations already exist in the catalog:";
|
|
534
|
+
readonly "stepReviewLocation.refresh": "Refresh";
|
|
535
|
+
readonly "stepReviewLocation.import": "Import";
|
|
536
|
+
readonly "stepReviewLocation.catalog.new": "The following entities will be added to the catalog:";
|
|
537
|
+
readonly "stepReviewLocation.catalog.exists": "The following locations already exist in the catalog:";
|
|
538
|
+
readonly "stepReviewLocation.prepareResult.title": "The following Pull Request has been opened: ";
|
|
539
|
+
readonly "stepReviewLocation.prepareResult.description": "You can already import the location and {{appTitle}} will fetch the entities as soon as the Pull Request is merged.";
|
|
540
|
+
}>;
|
|
541
|
+
|
|
542
|
+
export { AutocompleteTextField, CatalogImportClient, CatalogImportPage, DefaultImportPage, EntityListComponent, ImportInfoCard, ImportStepper, PreparePullRequestForm, PreviewCatalogInfoComponent, PreviewPullRequestComponent, StepInitAnalyzeUrl, StepPrepareCreatePullRequest, catalogImportApiRef, catalogImportPlugin, catalogImportTranslationRef, defaultGenerateStepper, catalogImportPlugin as plugin };
|
|
473
543
|
export type { AnalyzeResult, AutocompleteTextFieldProps, CatalogImportApi, EntityListComponentProps, ImportFlows, ImportInfoCardProps, ImportState, ImportStepperProps, PreparePullRequestFormProps, PrepareResult, PreviewCatalogInfoComponentProps, PreviewPullRequestComponentProps, StepInitAnalyzeUrlProps, StepPrepareCreatePullRequestProps, UnpackNestedValue };
|
package/dist/index.esm.js
CHANGED
|
@@ -12,4 +12,5 @@ export { PreviewPullRequestComponent } from './components/StepPrepareCreatePullR
|
|
|
12
12
|
export { StepPrepareCreatePullRequest } from './components/StepPrepareCreatePullRequest/StepPrepareCreatePullRequest.esm.js';
|
|
13
13
|
export { catalogImportApiRef } from './api/CatalogImportApi.esm.js';
|
|
14
14
|
export { CatalogImportClient } from './api/CatalogImportClient.esm.js';
|
|
15
|
+
export { catalogImportTranslationRef } from './translation.esm.js';
|
|
15
16
|
//# sourceMappingURL=index.esm.js.map
|
package/dist/index.esm.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;"}
|
package/dist/package.json.esm.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"translation.esm.js","sources":["../src/translation.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createTranslationRef } from '@backstage/core-plugin-api/alpha';\n\n/** @
|
|
1
|
+
{"version":3,"file":"translation.esm.js","sources":["../src/translation.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createTranslationRef } from '@backstage/core-plugin-api/alpha';\n\n/** @public */\nexport const catalogImportTranslationRef = createTranslationRef({\n id: 'catalog-import',\n messages: {\n buttons: {\n back: 'Back',\n },\n defaultImportPage: {\n headerTitle: 'Register an existing component',\n contentHeaderTitle: 'Start tracking your component in {{appTitle}}',\n supportTitle:\n 'Start tracking your component in {{appTitle}} by adding it to the software catalog.',\n },\n importInfoCard: {\n title: 'Register an existing component',\n deepLinkTitle: 'Learn more about the Software Catalog',\n linkDescription:\n 'Enter the URL to your source code repository to add it to {{appTitle}}.',\n fileLinkTitle: 'Link to an existing entity file',\n examplePrefix: 'Example: ',\n fileLinkDescription:\n 'The wizard analyzes the file, previews the entities, and adds them to the {{appTitle}} catalog.',\n githubIntegration: {\n title: 'Link to a repository',\n label: 'GitHub only',\n },\n exampleDescription:\n 'The wizard discovers all {{catalogFilename}} files in the repository, previews the entities, and adds them to the {{appTitle}} catalog.',\n preparePullRequestDescription:\n 'If no entities are found, the wizard will prepare a Pull Request that adds an example {{catalogFilename}} and prepares the {{appTitle}} catalog to load all entities as soon as the Pull Request is merged.',\n },\n importStepper: {\n singleLocation: {\n title: 'Select Locations',\n description: 'Discovered Locations: 1',\n },\n multipleLocations: {\n title: 'Select Locations',\n description: 'Discovered Locations: {{length, number}}',\n },\n noLocation: {\n title: 'Create Pull Request',\n createPr: {\n detailsTitle: 'Pull Request Details',\n titleLabel: 'Pull Request Title',\n titlePlaceholder: 'Add Backstage catalog entity descriptor files',\n bodyLabel: 'Pull Request Body',\n bodyPlaceholder: 'A describing text with Markdown support',\n configurationTitle: 'Entity Configuration',\n componentNameLabel: 'Name of the created component',\n componentNamePlaceholder: 'my-component',\n ownerLoadingText: 'Loading groups…',\n ownerHelperText:\n 'Select an owner from the list or enter a reference to a Group or a User',\n ownerErrorHelperText: 'required value',\n ownerLabel: 'Entity Owner',\n ownerPlaceholder: 'my-group',\n codeownersHelperText:\n 'WARNING: This may fail if no CODEOWNERS file is found at the target location.',\n },\n },\n analyze: {\n title: 'Select URL',\n },\n prepare: {\n title: 'Import Actions',\n description: 'Optional',\n },\n review: {\n title: 'Review',\n },\n finish: {\n title: 'Finish',\n },\n },\n stepFinishImportLocation: {\n backButtonText: 'Register another',\n repository: {\n title: 'The following Pull Request has been opened: ',\n description:\n 'Your entities will be imported as soon as the Pull Request is merged.',\n },\n locations: {\n new: 'The following entities have been added to the catalog:',\n existing: 'A refresh was triggered for the following locations:',\n viewButtonText: 'View Component',\n backButtonText: 'Register another',\n },\n },\n stepInitAnalyzeUrl: {\n error: {\n repository: \"Couldn't generate entities for your repository\",\n locations: 'There are no entities at this location',\n default:\n 'Received unknown analysis result of type {{type}}. Please contact the support team.',\n url: 'Must start with http:// or https://.',\n },\n urlHelperText:\n 'Enter the full path to your entity file to start tracking your component',\n nextButtonText: 'Analyze',\n },\n stepPrepareCreatePullRequest: {\n description:\n 'You entered a link to a {{integrationType}} repository but a {{catalogFilename}} could not be found. Use this form to open a Pull Request that creates one.',\n previewPr: {\n title: 'Preview Pull Request',\n subheader: 'Create a new Pull Request',\n },\n previewCatalogInfo: {\n title: 'Preview Entities',\n },\n nextButtonText: 'Create PR',\n },\n stepPrepareSelectLocations: {\n locations: {\n description:\n 'Select one or more locations that are present in your git repository:',\n selectAll: 'Select All',\n },\n existingLocations: {\n description: 'These locations already exist in the catalog:',\n },\n nextButtonText: 'Review',\n },\n stepReviewLocation: {\n prepareResult: {\n title: 'The following Pull Request has been opened: ',\n description:\n 'You can already import the location and {{appTitle}} will fetch the entities as soon as the Pull Request is merged.',\n },\n catalog: {\n exists: 'The following locations already exist in the catalog:',\n new: 'The following entities will be added to the catalog:',\n },\n refresh: 'Refresh',\n import: 'Import',\n },\n },\n});\n"],"names":[],"mappings":";;AAmBO,MAAM,8BAA8B,oBAAA,CAAqB;AAAA,EAC9D,EAAA,EAAI,gBAAA;AAAA,EACJ,QAAA,EAAU;AAAA,IACR,OAAA,EAAS;AAAA,MACP,IAAA,EAAM;AAAA,KACR;AAAA,IACA,iBAAA,EAAmB;AAAA,MACjB,WAAA,EAAa,gCAAA;AAAA,MACb,kBAAA,EAAoB,+CAAA;AAAA,MACpB,YAAA,EACE;AAAA,KACJ;AAAA,IACA,cAAA,EAAgB;AAAA,MACd,KAAA,EAAO,gCAAA;AAAA,MACP,aAAA,EAAe,uCAAA;AAAA,MACf,eAAA,EACE,yEAAA;AAAA,MACF,aAAA,EAAe,iCAAA;AAAA,MACf,aAAA,EAAe,WAAA;AAAA,MACf,mBAAA,EACE,iGAAA;AAAA,MACF,iBAAA,EAAmB;AAAA,QACjB,KAAA,EAAO,sBAAA;AAAA,QACP,KAAA,EAAO;AAAA,OACT;AAAA,MACA,kBAAA,EACE,yIAAA;AAAA,MACF,6BAAA,EACE;AAAA,KACJ;AAAA,IACA,aAAA,EAAe;AAAA,MACb,cAAA,EAAgB;AAAA,QACd,KAAA,EAAO,kBAAA;AAAA,QACP,WAAA,EAAa;AAAA,OACf;AAAA,MACA,iBAAA,EAAmB;AAAA,QACjB,KAAA,EAAO,kBAAA;AAAA,QACP,WAAA,EAAa;AAAA,OACf;AAAA,MACA,UAAA,EAAY;AAAA,QACV,KAAA,EAAO,qBAAA;AAAA,QACP,QAAA,EAAU;AAAA,UACR,YAAA,EAAc,sBAAA;AAAA,UACd,UAAA,EAAY,oBAAA;AAAA,UACZ,gBAAA,EAAkB,+CAAA;AAAA,UAClB,SAAA,EAAW,mBAAA;AAAA,UACX,eAAA,EAAiB,yCAAA;AAAA,UACjB,kBAAA,EAAoB,sBAAA;AAAA,UACpB,kBAAA,EAAoB,+BAAA;AAAA,UACpB,wBAAA,EAA0B,cAAA;AAAA,UAC1B,gBAAA,EAAkB,sBAAA;AAAA,UAClB,eAAA,EACE,yEAAA;AAAA,UACF,oBAAA,EAAsB,gBAAA;AAAA,UACtB,UAAA,EAAY,cAAA;AAAA,UACZ,gBAAA,EAAkB,UAAA;AAAA,UAClB,oBAAA,EACE;AAAA;AACJ,OACF;AAAA,MACA,OAAA,EAAS;AAAA,QACP,KAAA,EAAO;AAAA,OACT;AAAA,MACA,OAAA,EAAS;AAAA,QACP,KAAA,EAAO,gBAAA;AAAA,QACP,WAAA,EAAa;AAAA,OACf;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,KAAA,EAAO;AAAA,OACT;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,KAAA,EAAO;AAAA;AACT,KACF;AAAA,IACA,wBAAA,EAA0B;AAAA,MACxB,cAAA,EAAgB,kBAAA;AAAA,MAChB,UAAA,EAAY;AAAA,QACV,KAAA,EAAO,8CAAA;AAAA,QACP,WAAA,EACE;AAAA,OACJ;AAAA,MACA,SAAA,EAAW;AAAA,QACT,GAAA,EAAK,wDAAA;AAAA,QACL,QAAA,EAAU,sDAAA;AAAA,QACV,cAAA,EAAgB,gBAAA;AAAA,QAChB,cAAA,EAAgB;AAAA;AAClB,KACF;AAAA,IACA,kBAAA,EAAoB;AAAA,MAClB,KAAA,EAAO;AAAA,QACL,UAAA,EAAY,gDAAA;AAAA,QACZ,SAAA,EAAW,wCAAA;AAAA,QACX,OAAA,EACE,qFAAA;AAAA,QACF,GAAA,EAAK;AAAA,OACP;AAAA,MACA,aAAA,EACE,0EAAA;AAAA,MACF,cAAA,EAAgB;AAAA,KAClB;AAAA,IACA,4BAAA,EAA8B;AAAA,MAC5B,WAAA,EACE,6JAAA;AAAA,MACF,SAAA,EAAW;AAAA,QACT,KAAA,EAAO,sBAAA;AAAA,QACP,SAAA,EAAW;AAAA,OACb;AAAA,MACA,kBAAA,EAAoB;AAAA,QAClB,KAAA,EAAO;AAAA,OACT;AAAA,MACA,cAAA,EAAgB;AAAA,KAClB;AAAA,IACA,0BAAA,EAA4B;AAAA,MAC1B,SAAA,EAAW;AAAA,QACT,WAAA,EACE,uEAAA;AAAA,QACF,SAAA,EAAW;AAAA,OACb;AAAA,MACA,iBAAA,EAAmB;AAAA,QACjB,WAAA,EAAa;AAAA,OACf;AAAA,MACA,cAAA,EAAgB;AAAA,KAClB;AAAA,IACA,kBAAA,EAAoB;AAAA,MAClB,aAAA,EAAe;AAAA,QACb,KAAA,EAAO,8CAAA;AAAA,QACP,WAAA,EACE;AAAA,OACJ;AAAA,MACA,OAAA,EAAS;AAAA,QACP,MAAA,EAAQ,uDAAA;AAAA,QACR,GAAA,EAAK;AAAA,OACP;AAAA,MACA,OAAA,EAAS,SAAA;AAAA,MACT,MAAA,EAAQ;AAAA;AACV;AAEJ,CAAC;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-catalog-import",
|
|
3
|
-
"version": "0.13.11
|
|
3
|
+
"version": "0.13.11",
|
|
4
4
|
"description": "A Backstage plugin the helps you import entities into your catalog",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "frontend-plugin",
|
|
@@ -66,18 +66,18 @@
|
|
|
66
66
|
"test": "backstage-cli package test"
|
|
67
67
|
},
|
|
68
68
|
"dependencies": {
|
|
69
|
-
"@backstage/catalog-client": "1.14.0
|
|
70
|
-
"@backstage/catalog-model": "1.7.
|
|
71
|
-
"@backstage/config": "1.3.6",
|
|
72
|
-
"@backstage/core-components": "0.18.8
|
|
73
|
-
"@backstage/core-plugin-api": "1.12.4
|
|
74
|
-
"@backstage/errors": "1.2.7",
|
|
75
|
-
"@backstage/frontend-plugin-api": "0.
|
|
76
|
-
"@backstage/integration": "2.0.0
|
|
77
|
-
"@backstage/integration-react": "1.2.16
|
|
78
|
-
"@backstage/plugin-catalog-common": "1.1.8",
|
|
79
|
-
"@backstage/plugin-catalog-react": "2.1.0
|
|
80
|
-
"@backstage/plugin-permission-react": "0.4.41
|
|
69
|
+
"@backstage/catalog-client": "^1.14.0",
|
|
70
|
+
"@backstage/catalog-model": "^1.7.7",
|
|
71
|
+
"@backstage/config": "^1.3.6",
|
|
72
|
+
"@backstage/core-components": "^0.18.8",
|
|
73
|
+
"@backstage/core-plugin-api": "^1.12.4",
|
|
74
|
+
"@backstage/errors": "^1.2.7",
|
|
75
|
+
"@backstage/frontend-plugin-api": "^0.15.0",
|
|
76
|
+
"@backstage/integration": "^2.0.0",
|
|
77
|
+
"@backstage/integration-react": "^1.2.16",
|
|
78
|
+
"@backstage/plugin-catalog-common": "^1.1.8",
|
|
79
|
+
"@backstage/plugin-catalog-react": "^2.1.0",
|
|
80
|
+
"@backstage/plugin-permission-react": "^0.4.41",
|
|
81
81
|
"@material-ui/core": "^4.12.2",
|
|
82
82
|
"@material-ui/icons": "^4.9.1",
|
|
83
83
|
"@material-ui/lab": "4.0.0-alpha.61",
|
|
@@ -90,11 +90,11 @@
|
|
|
90
90
|
"yaml": "^2.0.0"
|
|
91
91
|
},
|
|
92
92
|
"devDependencies": {
|
|
93
|
-
"@backstage/cli": "0.36.0
|
|
94
|
-
"@backstage/core-app-api": "1.19.6
|
|
95
|
-
"@backstage/dev-utils": "1.1.21
|
|
96
|
-
"@backstage/plugin-catalog": "
|
|
97
|
-
"@backstage/test-utils": "1.7.16
|
|
93
|
+
"@backstage/cli": "^0.36.0",
|
|
94
|
+
"@backstage/core-app-api": "^1.19.6",
|
|
95
|
+
"@backstage/dev-utils": "^1.1.21",
|
|
96
|
+
"@backstage/plugin-catalog": "^2.0.0",
|
|
97
|
+
"@backstage/test-utils": "^1.7.16",
|
|
98
98
|
"@testing-library/dom": "^10.0.0",
|
|
99
99
|
"@testing-library/jest-dom": "^6.0.0",
|
|
100
100
|
"@testing-library/react": "^16.0.0",
|