diff --git a/.changeset/search-wellington-paranormal.md b/.changeset/search-wellington-paranormal.md new file mode 100644 index 0000000000..7cd1ead2e8 --- /dev/null +++ b/.changeset/search-wellington-paranormal.md @@ -0,0 +1,13 @@ +--- +'@backstage/plugin-catalog-backend': patch +'@backstage/plugin-catalog': patch +'@backstage/plugin-search-backend-module-elasticsearch': patch +'@backstage/plugin-search-backend-module-pg': patch +'@backstage/plugin-search-backend-node': patch +'@backstage/plugin-search-backend': patch +'@backstage/plugin-search': patch +'@backstage/plugin-techdocs-backend': patch +'@backstage/plugin-techdocs-node': patch +--- + +Use `@backstage/plugin-search-common` package instead of `@backstage/search-common`. diff --git a/docs/features/search/README.md b/docs/features/search/README.md index 0856451882..f5533927fa 100644 --- a/docs/features/search/README.md +++ b/docs/features/search/README.md @@ -128,7 +128,7 @@ plugins integrated to search. | Frontend Plugin | @backstage/plugin-search | | Backend Plugin | @backstage/plugin-search-backend | | Indexer Plugin | @backstage/plugin-search-backend-node | -| Common Code | @backstage/search-common | +| Common Code | @backstage/plugin-search-common | ## Get Involved diff --git a/docs/features/search/how-to-guides.md b/docs/features/search/how-to-guides.md index ac36d64673..f1d06f38f5 100644 --- a/docs/features/search/how-to-guides.md +++ b/docs/features/search/how-to-guides.md @@ -365,7 +365,7 @@ implement the factory method that instantiates the stream: ```ts import { BatchSearchEngineIndexer } from '@backstage/plugin-search-backend-node'; -import { SearchEngine } from '@backstage/search-common'; +import { SearchEngine } from '@backstage/plugin-search-common'; export class YourSearchEngineIndexer extends BatchSearchEngineIndexer { constructor({ type }: { type: string }) { // Customize the number of documents passed to the index method per batch. diff --git a/packages/app/package.json b/packages/app/package.json index d272b88e52..45cde6df52 100644 --- a/packages/app/package.json +++ b/packages/app/package.json @@ -46,13 +46,13 @@ "@backstage/plugin-rollbar": "^0.4.1", "@backstage/plugin-scaffolder": "^0.14.0", "@backstage/plugin-search": "^0.7.2", + "@backstage/plugin-search-common": "^0.3.0", "@backstage/plugin-sentry": "^0.3.39", "@backstage/plugin-shortcuts": "^0.2.2", "@backstage/plugin-tech-radar": "^0.5.8", "@backstage/plugin-techdocs": "^0.15.0", "@backstage/plugin-todo": "^0.2.3", "@backstage/plugin-user-settings": "^0.4.0", - "@backstage/search-common": "^0.3.0", "@backstage/plugin-tech-insights": "^0.1.11", "@backstage/theme": "^0.2.15", "@material-ui/core": "^4.12.2", diff --git a/plugins/catalog-backend/api-report.md b/plugins/catalog-backend/api-report.md index 0d9f306009..09f3e4b9d9 100644 --- a/plugins/catalog-backend/api-report.md +++ b/plugins/catalog-backend/api-report.md @@ -12,7 +12,7 @@ import { CompoundEntityRef } from '@backstage/catalog-model'; import { ConditionalPolicyDecision } from '@backstage/plugin-permission-node'; import { Conditions } from '@backstage/plugin-permission-node'; import { Config } from '@backstage/config'; -import { DocumentCollatorFactory } from '@backstage/search-common'; +import { DocumentCollatorFactory } from '@backstage/plugin-search-common'; import { Entity } from '@backstage/catalog-model'; import { EntityPolicy } from '@backstage/catalog-model'; import express from 'express'; diff --git a/plugins/catalog-backend/package.json b/plugins/catalog-backend/package.json index a1404189f8..9b8e6347a5 100644 --- a/plugins/catalog-backend/package.json +++ b/plugins/catalog-backend/package.json @@ -44,7 +44,7 @@ "@backstage/plugin-permission-common": "^0.5.2", "@backstage/plugin-permission-node": "^0.5.3", "@backstage/plugin-scaffolder-common": "^0.2.3", - "@backstage/search-common": "^0.3.0", + "@backstage/plugin-search-common": "^0.3.0", "@backstage/types": "^0.1.3", "@octokit/graphql": "^4.5.8", "@types/express": "^4.17.6", diff --git a/plugins/catalog-backend/src/search/DefaultCatalogCollatorFactory.ts b/plugins/catalog-backend/src/search/DefaultCatalogCollatorFactory.ts index 440a8c8ebb..4d28559c82 100644 --- a/plugins/catalog-backend/src/search/DefaultCatalogCollatorFactory.ts +++ b/plugins/catalog-backend/src/search/DefaultCatalogCollatorFactory.ts @@ -29,7 +29,7 @@ import { UserEntity, } from '@backstage/catalog-model'; import { Config } from '@backstage/config'; -import { DocumentCollatorFactory } from '@backstage/search-common'; +import { DocumentCollatorFactory } from '@backstage/plugin-search-common'; import { catalogEntityReadPermission, CatalogEntityDocument, diff --git a/plugins/catalog/api-report.md b/plugins/catalog/api-report.md index 97a36ad020..4dd5e7c32e 100644 --- a/plugins/catalog/api-report.md +++ b/plugins/catalog/api-report.md @@ -11,7 +11,7 @@ import { CompoundEntityRef } from '@backstage/catalog-model'; import { Entity } from '@backstage/catalog-model'; import { ExternalRouteRef } from '@backstage/core-plugin-api'; import { IconComponent } from '@backstage/core-plugin-api'; -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; import { InfoCardVariants } from '@backstage/core-components'; import { Observable } from '@backstage/types'; import { Overrides } from '@material-ui/core/styles/overrides'; diff --git a/plugins/catalog/package.json b/plugins/catalog/package.json index 0a8a4af58c..07477316fa 100644 --- a/plugins/catalog/package.json +++ b/plugins/catalog/package.json @@ -42,7 +42,7 @@ "@backstage/integration-react": "^0.1.24", "@backstage/plugin-catalog-common": "^0.2.0", "@backstage/plugin-catalog-react": "^0.8.0", - "@backstage/search-common": "^0.3.0", + "@backstage/plugin-search-common": "^0.3.0", "@backstage/theme": "^0.2.15", "@backstage/types": "^0.1.2", "@material-ui/core": "^4.12.2", diff --git a/plugins/catalog/src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.tsx b/plugins/catalog/src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.tsx index 54cfe43364..422841b134 100644 --- a/plugins/catalog/src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.tsx +++ b/plugins/catalog/src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.tsx @@ -24,7 +24,7 @@ import { makeStyles, } from '@material-ui/core'; import { Link } from '@backstage/core-components'; -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; const useStyles = makeStyles({ flexContainer: { diff --git a/plugins/search-backend-module-elasticsearch/api-report.md b/plugins/search-backend-module-elasticsearch/api-report.md index d4edcc6b25..50e5a61a14 100644 --- a/plugins/search-backend-module-elasticsearch/api-report.md +++ b/plugins/search-backend-module-elasticsearch/api-report.md @@ -9,11 +9,11 @@ import { BatchSearchEngineIndexer } from '@backstage/plugin-search-backend-node' import { Client } from '@elastic/elasticsearch'; import { Config } from '@backstage/config'; import type { ConnectionOptions } from 'tls'; -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; import { Logger as Logger_2 } from 'winston'; -import { SearchEngine } from '@backstage/search-common'; -import { SearchQuery } from '@backstage/search-common'; -import { SearchResultSet } from '@backstage/search-common'; +import { SearchEngine } from '@backstage/plugin-search-common'; +import { SearchQuery } from '@backstage/plugin-search-common'; +import { SearchResultSet } from '@backstage/plugin-search-common'; // Warning: (ae-missing-release-tag) "ElasticSearchClientOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-search-backend-module-elasticsearch" does not have an export "ElasticSearchEngine" diff --git a/plugins/search-backend-module-elasticsearch/package.json b/plugins/search-backend-module-elasticsearch/package.json index f49c86f41f..b5d20038e8 100644 --- a/plugins/search-backend-module-elasticsearch/package.json +++ b/plugins/search-backend-module-elasticsearch/package.json @@ -24,8 +24,8 @@ }, "dependencies": { "@backstage/config": "^0.1.15", - "@backstage/search-common": "^0.3.0", "@backstage/plugin-search-backend-node": "^0.5.0", + "@backstage/plugin-search-common": "^0.3.0", "@elastic/elasticsearch": "7.13.0", "@acuris/aws-es-connection": "^2.2.0", "aws-sdk": "^2.948.0", diff --git a/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts b/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts index c16567fee0..f2ed5ed2b0 100644 --- a/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts +++ b/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts @@ -24,7 +24,7 @@ import { SearchEngine, SearchQuery, SearchResultSet, -} from '@backstage/search-common'; +} from '@backstage/plugin-search-common'; import { Client } from '@elastic/elasticsearch'; import esb from 'elastic-builder'; import { isEmpty, isNaN as nan, isNumber } from 'lodash'; diff --git a/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngineIndexer.ts b/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngineIndexer.ts index 2e4996cd2f..cb3674ddd1 100644 --- a/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngineIndexer.ts +++ b/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngineIndexer.ts @@ -15,7 +15,7 @@ */ import { BatchSearchEngineIndexer } from '@backstage/plugin-search-backend-node'; -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; import { Client } from '@elastic/elasticsearch'; import { Readable } from 'stream'; import { Logger } from 'winston'; diff --git a/plugins/search-backend-module-pg/api-report.md b/plugins/search-backend-module-pg/api-report.md index ba8fde5f17..39847a4935 100644 --- a/plugins/search-backend-module-pg/api-report.md +++ b/plugins/search-backend-module-pg/api-report.md @@ -4,12 +4,12 @@ ```ts import { BatchSearchEngineIndexer } from '@backstage/plugin-search-backend-node'; -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; import { Knex } from 'knex'; import { PluginDatabaseManager } from '@backstage/backend-common'; import { SearchEngine } from '@backstage/plugin-search-backend-node'; -import { SearchQuery } from '@backstage/search-common'; -import { SearchResultSet } from '@backstage/search-common'; +import { SearchQuery } from '@backstage/plugin-search-common'; +import { SearchResultSet } from '@backstage/plugin-search-common'; // Warning: (ae-missing-release-tag) "ConcretePgSearchQuery" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // diff --git a/plugins/search-backend-module-pg/package.json b/plugins/search-backend-module-pg/package.json index fb95dff540..505bb53d09 100644 --- a/plugins/search-backend-module-pg/package.json +++ b/plugins/search-backend-module-pg/package.json @@ -24,8 +24,8 @@ }, "dependencies": { "@backstage/backend-common": "^0.12.0", - "@backstage/search-common": "^0.3.0", "@backstage/plugin-search-backend-node": "^0.5.0", + "@backstage/plugin-search-common": "^0.3.0", "lodash": "^4.17.21", "knex": "^1.0.2" }, diff --git a/plugins/search-backend-module-pg/src/PgSearchEngine/PgSearchEngine.ts b/plugins/search-backend-module-pg/src/PgSearchEngine/PgSearchEngine.ts index ac42007401..8f75112837 100644 --- a/plugins/search-backend-module-pg/src/PgSearchEngine/PgSearchEngine.ts +++ b/plugins/search-backend-module-pg/src/PgSearchEngine/PgSearchEngine.ts @@ -15,7 +15,7 @@ */ import { PluginDatabaseManager } from '@backstage/backend-common'; import { SearchEngine } from '@backstage/plugin-search-backend-node'; -import { SearchQuery, SearchResultSet } from '@backstage/search-common'; +import { SearchQuery, SearchResultSet } from '@backstage/plugin-search-common'; import { PgSearchEngineIndexer } from './PgSearchEngineIndexer'; import { DatabaseDocumentStore, diff --git a/plugins/search-backend-module-pg/src/PgSearchEngine/PgSearchEngineIndexer.ts b/plugins/search-backend-module-pg/src/PgSearchEngine/PgSearchEngineIndexer.ts index 53d040cb87..fa27509a69 100644 --- a/plugins/search-backend-module-pg/src/PgSearchEngine/PgSearchEngineIndexer.ts +++ b/plugins/search-backend-module-pg/src/PgSearchEngine/PgSearchEngineIndexer.ts @@ -15,7 +15,7 @@ */ import { BatchSearchEngineIndexer } from '@backstage/plugin-search-backend-node'; -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; import { Knex } from 'knex'; import { DatabaseStore } from '../database'; diff --git a/plugins/search-backend-module-pg/src/database/DatabaseDocumentStore.test.ts b/plugins/search-backend-module-pg/src/database/DatabaseDocumentStore.test.ts index 71c012ec00..b973c2e14f 100644 --- a/plugins/search-backend-module-pg/src/database/DatabaseDocumentStore.test.ts +++ b/plugins/search-backend-module-pg/src/database/DatabaseDocumentStore.test.ts @@ -14,7 +14,7 @@ * limitations under the License. */ import { TestDatabaseId, TestDatabases } from '@backstage/backend-test-utils'; -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; import { DatabaseDocumentStore } from './DatabaseDocumentStore'; describe('DatabaseDocumentStore', () => { diff --git a/plugins/search-backend-module-pg/src/database/DatabaseDocumentStore.ts b/plugins/search-backend-module-pg/src/database/DatabaseDocumentStore.ts index 0d3ee63ca4..33b2d0c0d6 100644 --- a/plugins/search-backend-module-pg/src/database/DatabaseDocumentStore.ts +++ b/plugins/search-backend-module-pg/src/database/DatabaseDocumentStore.ts @@ -14,7 +14,7 @@ * limitations under the License. */ import { resolvePackagePath } from '@backstage/backend-common'; -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; import { Knex } from 'knex'; import { DatabaseStore, diff --git a/plugins/search-backend-module-pg/src/database/types.ts b/plugins/search-backend-module-pg/src/database/types.ts index 0a0dc35682..7e87658745 100644 --- a/plugins/search-backend-module-pg/src/database/types.ts +++ b/plugins/search-backend-module-pg/src/database/types.ts @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; import { Knex } from 'knex'; export interface PgSearchQuery { diff --git a/plugins/search-backend-node/api-report.md b/plugins/search-backend-node/api-report.md index 37945c8902..44e2d0c92d 100644 --- a/plugins/search-backend-node/api-report.md +++ b/plugins/search-backend-node/api-report.md @@ -5,17 +5,17 @@ ```ts /// -import { DocumentCollatorFactory } from '@backstage/search-common'; -import { DocumentDecoratorFactory } from '@backstage/search-common'; -import { DocumentTypeInfo } from '@backstage/search-common'; -import { IndexableDocument } from '@backstage/search-common'; +import { DocumentCollatorFactory } from '@backstage/plugin-search-common'; +import { DocumentDecoratorFactory } from '@backstage/plugin-search-common'; +import { DocumentTypeInfo } from '@backstage/plugin-search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; import { Logger as Logger_2 } from 'winston'; import { default as lunr_2 } from 'lunr'; -import { QueryTranslator } from '@backstage/search-common'; +import { QueryTranslator } from '@backstage/plugin-search-common'; import { Readable } from 'stream'; -import { SearchEngine } from '@backstage/search-common'; -import { SearchQuery } from '@backstage/search-common'; -import { SearchResultSet } from '@backstage/search-common'; +import { SearchEngine } from '@backstage/plugin-search-common'; +import { SearchQuery } from '@backstage/plugin-search-common'; +import { SearchResultSet } from '@backstage/plugin-search-common'; import { Transform } from 'stream'; import { Writable } from 'stream'; diff --git a/plugins/search-backend-node/package.json b/plugins/search-backend-node/package.json index dc8d1046b1..793bfdf74a 100644 --- a/plugins/search-backend-node/package.json +++ b/plugins/search-backend-node/package.json @@ -24,7 +24,7 @@ }, "dependencies": { "@backstage/errors": "^0.2.2", - "@backstage/search-common": "^0.3.0", + "@backstage/plugin-search-common": "^0.3.0", "@types/lunr": "^2.3.3", "lodash": "^4.17.21", "lunr": "^2.3.9", diff --git a/plugins/search-backend-node/src/IndexBuilder.test.ts b/plugins/search-backend-node/src/IndexBuilder.test.ts index 95a2e1d439..6a32343205 100644 --- a/plugins/search-backend-node/src/IndexBuilder.test.ts +++ b/plugins/search-backend-node/src/IndexBuilder.test.ts @@ -18,7 +18,7 @@ import { getVoidLogger } from '@backstage/backend-common'; import { DocumentCollatorFactory, DocumentDecoratorFactory, -} from '@backstage/search-common'; +} from '@backstage/plugin-search-common'; import { Readable, Transform } from 'stream'; import { IndexBuilder } from './IndexBuilder'; import { LunrSearchEngine, SearchEngine } from './index'; diff --git a/plugins/search-backend-node/src/IndexBuilder.ts b/plugins/search-backend-node/src/IndexBuilder.ts index e0a059e303..6be4489127 100644 --- a/plugins/search-backend-node/src/IndexBuilder.ts +++ b/plugins/search-backend-node/src/IndexBuilder.ts @@ -19,7 +19,7 @@ import { DocumentDecoratorFactory, DocumentTypeInfo, SearchEngine, -} from '@backstage/search-common'; +} from '@backstage/plugin-search-common'; import { Transform, pipeline } from 'stream'; import { Logger } from 'winston'; import { Scheduler } from './index'; diff --git a/plugins/search-backend-node/src/engines/LunrSearchEngine.test.ts b/plugins/search-backend-node/src/engines/LunrSearchEngine.test.ts index 88a3ba9a24..46aaf47c60 100644 --- a/plugins/search-backend-node/src/engines/LunrSearchEngine.test.ts +++ b/plugins/search-backend-node/src/engines/LunrSearchEngine.test.ts @@ -16,7 +16,10 @@ import { getVoidLogger } from '@backstage/backend-common'; import lunr from 'lunr'; -import { IndexableDocument, SearchEngine } from '@backstage/search-common'; +import { + IndexableDocument, + SearchEngine, +} from '@backstage/plugin-search-common'; import { ConcreteLunrQuery, LunrSearchEngine, diff --git a/plugins/search-backend-node/src/engines/LunrSearchEngine.ts b/plugins/search-backend-node/src/engines/LunrSearchEngine.ts index 394cfffac8..b642647466 100644 --- a/plugins/search-backend-node/src/engines/LunrSearchEngine.ts +++ b/plugins/search-backend-node/src/engines/LunrSearchEngine.ts @@ -20,7 +20,7 @@ import { SearchResultSet, QueryTranslator, SearchEngine, -} from '@backstage/search-common'; +} from '@backstage/plugin-search-common'; import lunr from 'lunr'; import { Logger } from 'winston'; import { LunrSearchEngineIndexer } from './LunrSearchEngineIndexer'; diff --git a/plugins/search-backend-node/src/engines/LunrSearchEngineIndexer.ts b/plugins/search-backend-node/src/engines/LunrSearchEngineIndexer.ts index 01c95f07d4..49afafea64 100644 --- a/plugins/search-backend-node/src/engines/LunrSearchEngineIndexer.ts +++ b/plugins/search-backend-node/src/engines/LunrSearchEngineIndexer.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; import lunr from 'lunr'; import { BatchSearchEngineIndexer } from '../indexing'; diff --git a/plugins/search-backend-node/src/index.ts b/plugins/search-backend-node/src/index.ts index 2edab1b01d..e84c5d6a4d 100644 --- a/plugins/search-backend-node/src/index.ts +++ b/plugins/search-backend-node/src/index.ts @@ -37,6 +37,6 @@ export * from './indexing'; export * from './test-utils'; /** - * @deprecated Import from @backstage/search-common instead + * @deprecated Import from @backstage/plugin-search-common instead */ -export type { SearchEngine } from '@backstage/search-common'; +export type { SearchEngine } from '@backstage/plugin-search-common'; diff --git a/plugins/search-backend-node/src/indexing/BatchSearchEngineIndexer.test.ts b/plugins/search-backend-node/src/indexing/BatchSearchEngineIndexer.test.ts index b692ce3aff..b4c9ff9e46 100644 --- a/plugins/search-backend-node/src/indexing/BatchSearchEngineIndexer.test.ts +++ b/plugins/search-backend-node/src/indexing/BatchSearchEngineIndexer.test.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; import { BatchSearchEngineIndexer } from './BatchSearchEngineIndexer'; import { TestPipeline } from '../test-utils'; diff --git a/plugins/search-backend-node/src/indexing/BatchSearchEngineIndexer.ts b/plugins/search-backend-node/src/indexing/BatchSearchEngineIndexer.ts index b368dd8184..6070a577ed 100644 --- a/plugins/search-backend-node/src/indexing/BatchSearchEngineIndexer.ts +++ b/plugins/search-backend-node/src/indexing/BatchSearchEngineIndexer.ts @@ -15,7 +15,7 @@ */ import { assertError } from '@backstage/errors'; -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; import { Writable } from 'stream'; /** diff --git a/plugins/search-backend-node/src/indexing/DecoratorBase.test.ts b/plugins/search-backend-node/src/indexing/DecoratorBase.test.ts index 3b045dcddf..12c61bd7d3 100644 --- a/plugins/search-backend-node/src/indexing/DecoratorBase.test.ts +++ b/plugins/search-backend-node/src/indexing/DecoratorBase.test.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; import { DecoratorBase } from './DecoratorBase'; import { TestPipeline } from '../test-utils'; diff --git a/plugins/search-backend-node/src/indexing/DecoratorBase.ts b/plugins/search-backend-node/src/indexing/DecoratorBase.ts index 382ce443e3..0541ab82d7 100644 --- a/plugins/search-backend-node/src/indexing/DecoratorBase.ts +++ b/plugins/search-backend-node/src/indexing/DecoratorBase.ts @@ -15,7 +15,7 @@ */ import { assertError } from '@backstage/errors'; -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; import { Transform } from 'stream'; /** diff --git a/plugins/search-backend-node/src/test-utils/TestPipeline.ts b/plugins/search-backend-node/src/test-utils/TestPipeline.ts index c0c2bf5f89..162572d929 100644 --- a/plugins/search-backend-node/src/test-utils/TestPipeline.ts +++ b/plugins/search-backend-node/src/test-utils/TestPipeline.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; import { pipeline, Readable, Transform, Writable } from 'stream'; /** diff --git a/plugins/search-backend-node/src/types.ts b/plugins/search-backend-node/src/types.ts index 68ccfe4c7e..d21bfaf453 100644 --- a/plugins/search-backend-node/src/types.ts +++ b/plugins/search-backend-node/src/types.ts @@ -18,7 +18,7 @@ import { DocumentCollatorFactory, DocumentDecoratorFactory, SearchEngine, -} from '@backstage/search-common'; +} from '@backstage/plugin-search-common'; import { Logger } from 'winston'; /** diff --git a/plugins/search-backend/api-report.md b/plugins/search-backend/api-report.md index 796f54c09d..d9d408395f 100644 --- a/plugins/search-backend/api-report.md +++ b/plugins/search-backend/api-report.md @@ -4,7 +4,7 @@ ```ts import { Config } from '@backstage/config'; -import { DocumentTypeInfo } from '@backstage/search-common'; +import { DocumentTypeInfo } from '@backstage/plugin-search-common'; import express from 'express'; import { Logger as Logger_2 } from 'winston'; import { PermissionAuthorizer } from '@backstage/plugin-permission-common'; diff --git a/plugins/search-backend/package.json b/plugins/search-backend/package.json index 2733be841e..c42406686c 100644 --- a/plugins/search-backend/package.json +++ b/plugins/search-backend/package.json @@ -26,11 +26,11 @@ "@backstage/backend-common": "^0.12.0", "@backstage/config": "^0.1.15", "@backstage/errors": "^0.2.2", - "@backstage/search-common": "^0.3.0", "@backstage/plugin-auth-node": "^0.1.4", "@backstage/plugin-permission-common": "^0.5.2", "@backstage/plugin-permission-node": "^0.5.3", "@backstage/plugin-search-backend-node": "^0.5.0", + "@backstage/plugin-search-common": "^0.3.0", "@backstage/types": "^0.1.3", "@types/express": "^4.17.6", "dataloader": "^2.0.0", diff --git a/plugins/search-backend/src/service/AuthorizedSearchEngine.test.ts b/plugins/search-backend/src/service/AuthorizedSearchEngine.test.ts index 137ffc24f1..ba63f8484e 100644 --- a/plugins/search-backend/src/service/AuthorizedSearchEngine.test.ts +++ b/plugins/search-backend/src/service/AuthorizedSearchEngine.test.ts @@ -24,7 +24,7 @@ import { DocumentTypeInfo, IndexableDocument, SearchEngine, -} from '@backstage/search-common'; +} from '@backstage/plugin-search-common'; import { encodePageCursor, decodePageCursor, diff --git a/plugins/search-backend/src/service/AuthorizedSearchEngine.ts b/plugins/search-backend/src/service/AuthorizedSearchEngine.ts index 82ed061196..2e65e18a84 100644 --- a/plugins/search-backend/src/service/AuthorizedSearchEngine.ts +++ b/plugins/search-backend/src/service/AuthorizedSearchEngine.ts @@ -31,7 +31,7 @@ import { SearchQuery, SearchResult, SearchResultSet, -} from '@backstage/search-common'; +} from '@backstage/plugin-search-common'; import { Config } from '@backstage/config'; import { InputError } from '@backstage/errors'; import { Writable } from 'stream'; diff --git a/plugins/search-backend/src/service/router.ts b/plugins/search-backend/src/service/router.ts index 3f25c4f24a..92e4e5526f 100644 --- a/plugins/search-backend/src/service/router.ts +++ b/plugins/search-backend/src/service/router.ts @@ -24,7 +24,10 @@ import { Config } from '@backstage/config'; import { JsonObject, JsonValue } from '@backstage/types'; import { getBearerTokenFromAuthorizationHeader } from '@backstage/plugin-auth-node'; import { PermissionAuthorizer } from '@backstage/plugin-permission-common'; -import { DocumentTypeInfo, SearchResultSet } from '@backstage/search-common'; +import { + DocumentTypeInfo, + SearchResultSet, +} from '@backstage/plugin-search-common'; import { SearchEngine } from '@backstage/plugin-search-backend-node'; import { AuthorizedSearchEngine } from './AuthorizedSearchEngine'; diff --git a/plugins/search-common/CHANGELOG.md b/plugins/search-common/CHANGELOG.md index 112d3d583a..d4f12f6146 100644 --- a/plugins/search-common/CHANGELOG.md +++ b/plugins/search-common/CHANGELOG.md @@ -1,4 +1,4 @@ -# @backstage/search-common +# @backstage/plugin-search-common ## 0.3.0 diff --git a/plugins/search-common/README.md b/plugins/search-common/README.md index 66828cc7af..7299c758d4 100644 --- a/plugins/search-common/README.md +++ b/plugins/search-common/README.md @@ -1,3 +1,3 @@ -# @backstage/search-common +# @backstage/plugin-search-common Common functionalities for Search, to be shared between various search-enabled plugins. diff --git a/plugins/search-common/api-report.md b/plugins/search-common/api-report.md index 475d85e11c..8ab25d5e42 100644 --- a/plugins/search-common/api-report.md +++ b/plugins/search-common/api-report.md @@ -1,4 +1,4 @@ -## API Report File for "@backstage/search-common" +## API Report File for "@backstage/plugin-search-common" > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). diff --git a/plugins/search-common/package.json b/plugins/search-common/package.json index 0e4482e377..98c02e5cc6 100644 --- a/plugins/search-common/package.json +++ b/plugins/search-common/package.json @@ -1,5 +1,5 @@ { - "name": "@backstage/search-common", + "name": "@backstage/plugin-search-common", "description": "Common functionalities for Search, to be shared between various search-enabled plugins", "version": "0.3.0", "main": "src/index.ts", @@ -17,7 +17,7 @@ "repository": { "type": "git", "url": "https://github.com/backstage/backstage", - "directory": "packages/search-common" + "directory": "plugins/search-common" }, "keywords": [ "backstage", diff --git a/plugins/search/api-report.md b/plugins/search/api-report.md index 10ce787a6c..0a277dab85 100644 --- a/plugins/search/api-report.md +++ b/plugins/search/api-report.md @@ -9,16 +9,16 @@ import { ApiRef } from '@backstage/core-plugin-api'; import { AsyncState } from 'react-use/lib/useAsync'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { IconComponent } from '@backstage/core-plugin-api'; -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; import { InputBaseProps } from '@material-ui/core'; import { JsonObject } from '@backstage/types'; import { default as React_2 } from 'react'; import { ReactElement } from 'react'; import { ReactNode } from 'react'; import { RouteRef } from '@backstage/core-plugin-api'; -import { SearchQuery } from '@backstage/search-common'; -import { SearchResult as SearchResult_2 } from '@backstage/search-common'; -import { SearchResultSet } from '@backstage/search-common'; +import { SearchQuery } from '@backstage/plugin-search-common'; +import { SearchResult as SearchResult_2 } from '@backstage/plugin-search-common'; +import { SearchResultSet } from '@backstage/plugin-search-common'; // Warning: (ae-missing-release-tag) "DefaultResultListItem" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // diff --git a/plugins/search/package.json b/plugins/search/package.json index 6499920806..eabfae1b16 100644 --- a/plugins/search/package.json +++ b/plugins/search/package.json @@ -39,7 +39,7 @@ "@backstage/core-plugin-api": "^0.8.0", "@backstage/errors": "^0.2.2", "@backstage/plugin-catalog-react": "^0.8.0", - "@backstage/search-common": "^0.3.0", + "@backstage/plugin-search-common": "^0.3.0", "@backstage/theme": "^0.2.15", "@backstage/types": "^0.1.3", "@material-ui/core": "^4.12.2", diff --git a/plugins/search/src/apis.ts b/plugins/search/src/apis.ts index 008002deb1..908942d87d 100644 --- a/plugins/search/src/apis.ts +++ b/plugins/search/src/apis.ts @@ -20,7 +20,7 @@ import { IdentityApi, } from '@backstage/core-plugin-api'; import { ResponseError } from '@backstage/errors'; -import { SearchQuery, SearchResultSet } from '@backstage/search-common'; +import { SearchQuery, SearchResultSet } from '@backstage/plugin-search-common'; import qs from 'qs'; export const searchApiRef = createApiRef({ diff --git a/plugins/search/src/components/DefaultResultListItem/DefaultResultListItem.tsx b/plugins/search/src/components/DefaultResultListItem/DefaultResultListItem.tsx index a6c9a36bb6..d9fbfe315e 100644 --- a/plugins/search/src/components/DefaultResultListItem/DefaultResultListItem.tsx +++ b/plugins/search/src/components/DefaultResultListItem/DefaultResultListItem.tsx @@ -15,7 +15,7 @@ */ import React, { ReactNode } from 'react'; -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; import { ListItem, ListItemIcon, diff --git a/plugins/search/src/components/SearchContext/SearchContext.tsx b/plugins/search/src/components/SearchContext/SearchContext.tsx index a9f42fe5ca..100d8a3ac3 100644 --- a/plugins/search/src/components/SearchContext/SearchContext.tsx +++ b/plugins/search/src/components/SearchContext/SearchContext.tsx @@ -16,7 +16,7 @@ import { JsonObject } from '@backstage/types'; import { useApi, AnalyticsContext } from '@backstage/core-plugin-api'; -import { SearchResultSet } from '@backstage/search-common'; +import { SearchResultSet } from '@backstage/plugin-search-common'; import React, { createContext, PropsWithChildren, diff --git a/plugins/search/src/components/SearchContext/SearchContextForStorybook.stories.tsx b/plugins/search/src/components/SearchContext/SearchContextForStorybook.stories.tsx index 36d670a1ed..7d6c35b00c 100644 --- a/plugins/search/src/components/SearchContext/SearchContextForStorybook.stories.tsx +++ b/plugins/search/src/components/SearchContext/SearchContextForStorybook.stories.tsx @@ -14,7 +14,7 @@ * limitations under the License. */ import { ApiProvider } from '@backstage/core-app-api'; -import { SearchResultSet } from '@backstage/search-common'; +import { SearchResultSet } from '@backstage/plugin-search-common'; import { TestApiRegistry } from '@backstage/test-utils'; import React, { ComponentProps, PropsWithChildren } from 'react'; import { searchApiRef } from '../../apis'; diff --git a/plugins/search/src/components/SearchResult/SearchResult.tsx b/plugins/search/src/components/SearchResult/SearchResult.tsx index 34b6840f21..d6ca9fd968 100644 --- a/plugins/search/src/components/SearchResult/SearchResult.tsx +++ b/plugins/search/src/components/SearchResult/SearchResult.tsx @@ -19,7 +19,7 @@ import { Progress, ResponseErrorPanel, } from '@backstage/core-components'; -import { SearchResult } from '@backstage/search-common'; +import { SearchResult } from '@backstage/plugin-search-common'; import React from 'react'; import { useSearch } from '../SearchContext'; diff --git a/plugins/techdocs-backend/api-report.md b/plugins/techdocs-backend/api-report.md index acce0b4981..f306ce4f35 100644 --- a/plugins/techdocs-backend/api-report.md +++ b/plugins/techdocs-backend/api-report.md @@ -7,7 +7,7 @@ import { CatalogApi } from '@backstage/catalog-client'; import { Config } from '@backstage/config'; -import { DocumentCollatorFactory } from '@backstage/search-common'; +import { DocumentCollatorFactory } from '@backstage/plugin-search-common'; import { Entity } from '@backstage/catalog-model'; import express from 'express'; import { GeneratorBuilder } from '@backstage/plugin-techdocs-node'; diff --git a/plugins/techdocs-backend/package.json b/plugins/techdocs-backend/package.json index aea75b1c3d..b11e038879 100644 --- a/plugins/techdocs-backend/package.json +++ b/plugins/techdocs-backend/package.json @@ -41,8 +41,8 @@ "@backstage/errors": "^0.2.2", "@backstage/integration": "^0.8.0", "@backstage/plugin-catalog-common": "^0.2.0", + "@backstage/plugin-search-common": "^0.3.0", "@backstage/plugin-techdocs-node": "^0.11.11", - "@backstage/search-common": "^0.3.0", "@types/express": "^4.17.6", "dockerode": "^3.3.1", "express": "^4.17.1", diff --git a/plugins/techdocs-backend/src/search/DefaultTechDocsCollatorFactory.ts b/plugins/techdocs-backend/src/search/DefaultTechDocsCollatorFactory.ts index 7ba76350e4..41d637e319 100644 --- a/plugins/techdocs-backend/src/search/DefaultTechDocsCollatorFactory.ts +++ b/plugins/techdocs-backend/src/search/DefaultTechDocsCollatorFactory.ts @@ -31,7 +31,7 @@ import { } from '@backstage/catalog-model'; import { Config } from '@backstage/config'; import { catalogEntityReadPermission } from '@backstage/plugin-catalog-common'; -import { DocumentCollatorFactory } from '@backstage/search-common'; +import { DocumentCollatorFactory } from '@backstage/plugin-search-common'; import { TechDocsDocument } from '@backstage/plugin-techdocs-node'; import unescape from 'lodash/unescape'; import fetch from 'node-fetch'; diff --git a/plugins/techdocs-node/api-report.md b/plugins/techdocs-node/api-report.md index 9ec1aafb09..768865896b 100644 --- a/plugins/techdocs-node/api-report.md +++ b/plugins/techdocs-node/api-report.md @@ -10,7 +10,7 @@ import { Config } from '@backstage/config'; import { ContainerRunner } from '@backstage/backend-common'; import { Entity } from '@backstage/catalog-model'; import express from 'express'; -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; import { Logger as Logger_2 } from 'winston'; import { PluginEndpointDiscovery } from '@backstage/backend-common'; import { ScmIntegrationRegistry } from '@backstage/integration'; diff --git a/plugins/techdocs-node/package.json b/plugins/techdocs-node/package.json index 7cbf49f954..ee2edd3e58 100644 --- a/plugins/techdocs-node/package.json +++ b/plugins/techdocs-node/package.json @@ -46,8 +46,8 @@ "@backstage/catalog-model": "^0.12.0", "@backstage/config": "^0.1.15", "@backstage/errors": "^0.2.2", - "@backstage/search-common": "^0.3.0", "@backstage/integration": "^0.8.0", + "@backstage/plugin-search-common": "^0.3.0", "@google-cloud/storage": "^5.6.0", "@trendyol-js/openstack-swift-sdk": "^0.0.5", "@types/express": "^4.17.6", diff --git a/plugins/techdocs-node/src/techdocsTypes.ts b/plugins/techdocs-node/src/techdocsTypes.ts index 0b722f4da5..77436b35d5 100644 --- a/plugins/techdocs-node/src/techdocsTypes.ts +++ b/plugins/techdocs-node/src/techdocsTypes.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { IndexableDocument } from '@backstage/search-common'; +import { IndexableDocument } from '@backstage/plugin-search-common'; /** * TechDocs indexable document interface diff --git a/scripts/api-extractor.ts b/scripts/api-extractor.ts index d37fa51c60..153861b875 100644 --- a/scripts/api-extractor.ts +++ b/scripts/api-extractor.ts @@ -237,6 +237,7 @@ const NO_WARNING_PACKAGES = [ 'plugins/scaffolder-backend-module-yeoman', 'plugins/scaffolder-common', 'plugins/search-backend-node', + 'plugins/search-common', 'plugins/techdocs-backend', 'plugins/techdocs-node', 'plugins/tech-insights', diff --git a/yarn.lock b/yarn.lock index 48784ac13c..fc8d5480a8 100644 --- a/yarn.lock +++ b/yarn.lock @@ -12049,6 +12049,7 @@ evp_bytestokey@^1.0.0, evp_bytestokey@^1.0.3: "@backstage/plugin-rollbar" "^0.4.1" "@backstage/plugin-scaffolder" "^0.14.0" "@backstage/plugin-search" "^0.7.2" + "@backstage/plugin-search-common" "^0.3.0" "@backstage/plugin-sentry" "^0.3.39" "@backstage/plugin-shortcuts" "^0.2.2" "@backstage/plugin-tech-insights" "^0.1.11" @@ -12056,7 +12057,6 @@ evp_bytestokey@^1.0.0, evp_bytestokey@^1.0.3: "@backstage/plugin-techdocs" "^0.15.0" "@backstage/plugin-todo" "^0.2.3" "@backstage/plugin-user-settings" "^0.4.0" - "@backstage/search-common" "^0.3.0" "@backstage/theme" "^0.2.15" "@material-ui/core" "^4.12.2" "@material-ui/icons" "^4.9.1"