search: move DocumentTypeInfo to search-common

Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
This commit is contained in:
MT Lewis
2022-01-24 14:46:11 +00:00
parent 1887a857c4
commit 634abc1a41
11 changed files with 29 additions and 28 deletions
+1 -8
View File
@@ -5,22 +5,15 @@
```ts
import { DocumentCollator } from '@backstage/search-common';
import { DocumentDecorator } from '@backstage/search-common';
import { DocumentTypeInfo } from '@backstage/search-common';
import { IndexableDocument } from '@backstage/search-common';
import { Logger as Logger_2 } from 'winston';
import { default as lunr_2 } from 'lunr';
import { Permission } from '@backstage/plugin-permission-common';
import { QueryTranslator } from '@backstage/search-common';
import { SearchEngine } from '@backstage/search-common';
import { SearchQuery } from '@backstage/search-common';
import { SearchResultSet } from '@backstage/search-common';
// Warning: (ae-missing-release-tag) "DocumentTypeInfo" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type DocumentTypeInfo = {
visibilityPermission?: Permission;
};
// Warning: (ae-missing-release-tag) "IndexBuilder" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
-1
View File
@@ -20,7 +20,6 @@
"clean": "backstage-cli clean"
},
"dependencies": {
"@backstage/plugin-permission-common": "^0.4.0-next.0",
"@backstage/search-common": "^0.2.1",
"winston": "^3.2.1",
"lunr": "^2.3.9",
@@ -14,10 +14,10 @@
* limitations under the License.
*/
import { Permission } from '@backstage/plugin-permission-common';
import {
DocumentCollator,
DocumentDecorator,
DocumentTypeInfo,
IndexableDocument,
SearchEngine,
} from '@backstage/search-common';
@@ -38,14 +38,6 @@ type IndexBuilderOptions = {
logger: Logger;
};
export type DocumentTypeInfo = {
/**
* The {@link @backstage/plugin-permission-common#Permission} that controls
* visibility of resources associated with this collator's documents.
*/
visibilityPermission?: Permission;
};
export class IndexBuilder {
private collators: Record<string, CollatorEnvelope>;
private decorators: Record<string, DocumentDecorator[]>;
-1
View File
@@ -21,7 +21,6 @@
*/
export { IndexBuilder } from './IndexBuilder';
export type { DocumentTypeInfo } from './IndexBuilder';
export { Scheduler } from './Scheduler';
export { LunrSearchEngine } from './engines';