@backstage-community/plugin-announcements 2.3.0 → 2.4.0

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.
Files changed (5) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/alpha/pages.esm.js +0 -1
  3. package/dist/alpha/pages.esm.js.map +1 -1
  4. package/dist/alpha.d.ts +30 -10
  5. package/package.json +20 -20
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @backstage-community/plugin-announcements
2
2
 
3
+ ## 2.4.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 8b42b6b: Backstage version bump to v1.48.2
8
+
9
+ ### Patch Changes
10
+
11
+ - Updated dependencies [8b42b6b]
12
+ - @backstage-community/plugin-announcements-common@0.18.0
13
+ - @backstage-community/plugin-announcements-react@0.22.0
14
+
3
15
  ## 2.3.0
4
16
 
5
17
  ### Minor Changes
package/dist/alpha/pages.esm.js CHANGED
@@ -6,7 +6,6 @@ import { rootRouteRef } from '../routes.esm.js';
6
6
  const announcementsPage = PageBlueprint.makeWithOverrides({
7
7
  config: {
8
8
  schema: {
9
- title: (z) => z.string().optional(),
10
9
  /**
11
10
  * @deprecated Filter by category using URL state (e.g. ?category=...). This option will be removed.
12
11
  */
package/dist/alpha/pages.esm.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"pages.esm.js","sources":["../../src/alpha/pages.tsx"],"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 */\nimport {\n compatWrapper,\n convertLegacyRouteRef,\n} from '@backstage/core-compat-api';\nimport { PageBlueprint } from '@backstage/frontend-plugin-api';\nimport { rootRouteRef } from '../routes';\n\n/**\n * @alpha\n */\nexport const announcementsPage = PageBlueprint.makeWithOverrides({\n config: {\n schema: {\n title: z => z.string().optional(),\n /**\n * @deprecated Filter by category using URL state (e.g. ?category=...). This option will be removed.\n */\n category: z => z.string().optional(),\n hideStartAt: z => z.boolean().optional(),\n markdownRenderer: z => z.enum(['backstage', 'md-editor']).optional(),\n /**\n * @deprecated Inactive announcement are hidden by default. This option will be removed.\n */\n defaultInactive: z => z.boolean().optional(),\n },\n },\n factory: (originalFactory, { config }) =>\n originalFactory({\n path: '/announcements',\n routeRef: convertLegacyRouteRef(rootRouteRef),\n loader: async () =>\n import('../Router').then(m =>\n compatWrapper(\n <m.Router\n title={config.title}\n category={config.category}\n hideStartAt={config.hideStartAt}\n markdownRenderer={config.markdownRenderer}\n defaultInactive={config.defaultInactive}\n />,\n ),\n ),\n }),\n});\n"],"names":[],"mappings":";;;;;AAyBa,MAAA,iBAAA,GAAoB,cAAc,iBAAkB,CAAA;AAAA,EAC/D,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA,CAAA,CAAA,KAAK,CAAE,CAAA,MAAA,GAAS,QAAS,EAAA;AAAA;AAAA;AAAA;AAAA,MAIhC,QAAU,EAAA,CAAA,CAAA,KAAK,CAAE,CAAA,MAAA,GAAS,QAAS,EAAA;AAAA,MACnC,WAAa,EAAA,CAAA,CAAA,KAAK,CAAE,CAAA,OAAA,GAAU,QAAS,EAAA;AAAA,MACvC,gBAAA,EAAkB,OAAK,CAAE,CAAA,IAAA,CAAK,CAAC,WAAa,EAAA,WAAW,CAAC,CAAA,CAAE,QAAS,EAAA;AAAA;AAAA;AAAA;AAAA,MAInE,eAAiB,EAAA,CAAA,CAAA,KAAK,CAAE,CAAA,OAAA,GAAU,QAAS;AAAA;AAC7C,GACF;AAAA,EACA,SAAS,CAAC,eAAA,EAAiB,EAAE,MAAA,OAC3B,eAAgB,CAAA;AAAA,IACd,IAAM,EAAA,gBAAA;AAAA,IACN,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAAA,IAC5C,MAAQ,EAAA,YACN,OAAO,kBAAW,CAAE,CAAA,IAAA;AAAA,MAAK,CACvB,CAAA,KAAA,aAAA;AAAA,wBACE,GAAA;AAAA,UAAC,CAAE,CAAA,MAAA;AAAA,UAAF;AAAA,YACC,OAAO,MAAO,CAAA,KAAA;AAAA,YACd,UAAU,MAAO,CAAA,QAAA;AAAA,YACjB,aAAa,MAAO,CAAA,WAAA;AAAA,YACpB,kBAAkB,MAAO,CAAA,gBAAA;AAAA,YACzB,iBAAiB,MAAO,CAAA;AAAA;AAAA;AAC1B;AACF;AACF,GACH;AACL,CAAC;;;;"}
1
+ {"version":3,"file":"pages.esm.js","sources":["../../src/alpha/pages.tsx"],"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 */\nimport {\n compatWrapper,\n convertLegacyRouteRef,\n} from '@backstage/core-compat-api';\nimport { PageBlueprint } from '@backstage/frontend-plugin-api';\nimport { rootRouteRef } from '../routes';\n\n/**\n * @alpha\n */\nexport const announcementsPage = PageBlueprint.makeWithOverrides({\n config: {\n schema: {\n /**\n * @deprecated Filter by category using URL state (e.g. ?category=...). This option will be removed.\n */\n category: z => z.string().optional(),\n hideStartAt: z => z.boolean().optional(),\n markdownRenderer: z => z.enum(['backstage', 'md-editor']).optional(),\n /**\n * @deprecated Inactive announcement are hidden by default. This option will be removed.\n */\n defaultInactive: z => z.boolean().optional(),\n },\n },\n factory: (originalFactory, { config }) =>\n originalFactory({\n path: '/announcements',\n routeRef: convertLegacyRouteRef(rootRouteRef),\n loader: async () =>\n import('../Router').then(m =>\n compatWrapper(\n <m.Router\n title={config.title}\n category={config.category}\n hideStartAt={config.hideStartAt}\n markdownRenderer={config.markdownRenderer}\n defaultInactive={config.defaultInactive}\n />,\n ),\n ),\n }),\n});\n"],"names":[],"mappings":";;;;;AAyBa,MAAA,iBAAA,GAAoB,cAAc,iBAAkB,CAAA;AAAA,EAC/D,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA;AAAA;AAAA;AAAA;AAAA,MAIN,QAAU,EAAA,CAAA,CAAA,KAAK,CAAE,CAAA,MAAA,GAAS,QAAS,EAAA;AAAA,MACnC,WAAa,EAAA,CAAA,CAAA,KAAK,CAAE,CAAA,OAAA,GAAU,QAAS,EAAA;AAAA,MACvC,gBAAA,EAAkB,OAAK,CAAE,CAAA,IAAA,CAAK,CAAC,WAAa,EAAA,WAAW,CAAC,CAAA,CAAE,QAAS,EAAA;AAAA;AAAA;AAAA;AAAA,MAInE,eAAiB,EAAA,CAAA,CAAA,KAAK,CAAE,CAAA,OAAA,GAAU,QAAS;AAAA;AAC7C,GACF;AAAA,EACA,SAAS,CAAC,eAAA,EAAiB,EAAE,MAAA,OAC3B,eAAgB,CAAA;AAAA,IACd,IAAM,EAAA,gBAAA;AAAA,IACN,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAAA,IAC5C,MAAQ,EAAA,YACN,OAAO,kBAAW,CAAE,CAAA,IAAA;AAAA,MAAK,CACvB,CAAA,KAAA,aAAA;AAAA,wBACE,GAAA;AAAA,UAAC,CAAE,CAAA,MAAA;AAAA,UAAF;AAAA,YACC,OAAO,MAAO,CAAA,KAAA;AAAA,YACd,UAAU,MAAO,CAAA,QAAA;AAAA,YACjB,aAAa,MAAO,CAAA,WAAA;AAAA,YACpB,kBAAkB,MAAO,CAAA,gBAAA;AAAA,YACzB,iBAAiB,MAAO,CAAA;AAAA;AAAA;AAC1B;AACF;AACF,GACH;AACL,CAAC;;;;"}
package/dist/alpha.d.ts CHANGED
@@ -1,7 +1,8 @@
1
1
  /// <reference types="react" />
2
2
  import * as _backstage_plugin_search_react_alpha from '@backstage/plugin-search-react/alpha';
3
- import * as _backstage_catalog_model from '@backstage/catalog-model';
4
3
  import * as _backstage_plugin_catalog_react_alpha from '@backstage/plugin-catalog-react/alpha';
4
+ import * as _backstage_catalog_model from '@backstage/catalog-model';
5
+ import * as _backstage_filter_predicates from '@backstage/filter-predicates';
5
6
  import * as react from 'react';
6
7
  import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
7
8
 
@@ -51,12 +52,12 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
51
52
  kind: "entity-card";
52
53
  name: "announcements";
53
54
  config: {
54
- filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
55
- type: "content" | "summary" | "info" | undefined;
55
+ filter: _backstage_filter_predicates.FilterPredicate | undefined;
56
+ type: "content" | "info" | undefined;
56
57
  };
57
58
  configInput: {
58
- filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
59
- type?: "content" | "summary" | "info" | undefined;
59
+ filter?: _backstage_filter_predicates.FilterPredicate | undefined;
60
+ type?: "content" | "info" | undefined;
60
61
  };
61
62
  output: _backstage_frontend_plugin_api.ExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
62
63
  optional: true;
@@ -68,7 +69,7 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
68
69
  inputs: {};
69
70
  params: {
70
71
  loader: () => Promise<JSX.Element>;
71
- filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
72
+ filter?: _backstage_filter_predicates.FilterPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
72
73
  type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
73
74
  };
74
75
  }>;
@@ -91,32 +92,51 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
91
92
  }>;
92
93
  "page:announcements": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
93
94
  config: {
94
- title: string | undefined;
95
95
  category: string | undefined;
96
96
  hideStartAt: boolean | undefined;
97
97
  markdownRenderer: "backstage" | "md-editor" | undefined;
98
98
  defaultInactive: boolean | undefined;
99
99
  path: string | undefined;
100
+ title: string | undefined;
100
101
  };
101
102
  configInput: {
102
- title?: string | undefined;
103
103
  category?: string | undefined;
104
104
  defaultInactive?: boolean | undefined;
105
105
  hideStartAt?: boolean | undefined;
106
106
  markdownRenderer?: "backstage" | "md-editor" | undefined;
107
+ title?: string | undefined;
107
108
  path?: string | undefined;
108
109
  };
109
110
  output: _backstage_frontend_plugin_api.ExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
110
111
  optional: true;
112
+ }> | _backstage_frontend_plugin_api.ExtensionDataRef<string, "core.title", {
113
+ optional: true;
114
+ }> | _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_frontend_plugin_api.IconElement, "core.icon", {
115
+ optional: true;
111
116
  }>;
112
- inputs: {};
117
+ inputs: {
118
+ pages: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
119
+ optional: true;
120
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.title", {
121
+ optional: true;
122
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.IconElement, "core.icon", {
123
+ optional: true;
124
+ }>, {
125
+ singleton: false;
126
+ optional: false;
127
+ internal: false;
128
+ }>;
129
+ };
113
130
  kind: "page";
114
131
  name: undefined;
115
132
  params: {
116
133
  defaultPath?: [Error: "Use the 'path' param instead"] | undefined;
117
134
  path: string;
118
- loader: () => Promise<JSX.Element>;
135
+ title?: string | undefined;
136
+ icon?: _backstage_frontend_plugin_api.IconElement | undefined;
137
+ loader?: (() => Promise<react.JSX.Element>) | undefined;
119
138
  routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
139
+ noHeader?: boolean | undefined;
120
140
  };
121
141
  }>;
122
142
  "search-filter-result-type:announcements/announcements-results-type": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage-community/plugin-announcements",
3
- "version": "2.3.0",
3
+ "version": "2.4.0",
4
4
  "main": "./dist/index.esm.js",
5
5
  "types": "./dist/index.d.ts",
6
6
  "license": "Apache-2.0",
@@ -61,22 +61,22 @@
61
61
  "postpack": "backstage-cli package postpack"
62
62
  },
63
63
  "dependencies": {
64
- "@backstage-community/plugin-announcements-common": "^0.17.0",
65
- "@backstage-community/plugin-announcements-react": "^0.21.0",
64
+ "@backstage-community/plugin-announcements-common": "^0.18.0",
65
+ "@backstage-community/plugin-announcements-react": "^0.22.0",
66
66
  "@backstage/catalog-model": "^1.7.6",
67
- "@backstage/core-app-api": "^1.19.4",
68
- "@backstage/core-compat-api": "^0.5.7",
69
- "@backstage/core-components": "^0.18.6",
70
- "@backstage/core-plugin-api": "^1.12.2",
67
+ "@backstage/core-app-api": "^1.19.5",
68
+ "@backstage/core-compat-api": "^0.5.8",
69
+ "@backstage/core-components": "^0.18.7",
70
+ "@backstage/core-plugin-api": "^1.12.3",
71
71
  "@backstage/errors": "^1.2.7",
72
- "@backstage/frontend-plugin-api": "^0.13.4",
73
- "@backstage/plugin-catalog-react": "^1.21.6",
74
- "@backstage/plugin-permission-react": "^0.4.39",
75
- "@backstage/plugin-search-common": "^1.2.21",
76
- "@backstage/plugin-search-react": "^1.10.2",
77
- "@backstage/plugin-signals-react": "^0.0.18",
78
- "@backstage/theme": "^0.7.1",
79
- "@backstage/ui": "^0.11.2",
72
+ "@backstage/frontend-plugin-api": "^0.14.1",
73
+ "@backstage/plugin-catalog-react": "^2.0.0",
74
+ "@backstage/plugin-permission-react": "^0.4.40",
75
+ "@backstage/plugin-search-common": "^1.2.22",
76
+ "@backstage/plugin-search-react": "^1.10.4",
77
+ "@backstage/plugin-signals-react": "^0.0.19",
78
+ "@backstage/theme": "^0.7.2",
79
+ "@backstage/ui": "^0.12.0",
80
80
  "@material-ui/core": "^4.12.2",
81
81
  "@material-ui/icons": "^4.11.3",
82
82
  "@material-ui/lab": "4.0.0-alpha.61",
@@ -95,11 +95,11 @@
95
95
  "react-router-dom": "^6.3.0"
96
96
  },
97
97
  "devDependencies": {
98
- "@backstage/cli": "^0.35.3",
99
- "@backstage/dev-utils": "^1.1.19",
100
- "@backstage/frontend-test-utils": "^0.4.5",
101
- "@backstage/plugin-signals": "^0.0.27",
102
- "@backstage/test-utils": "^1.7.14",
98
+ "@backstage/cli": "^0.35.4",
99
+ "@backstage/dev-utils": "^1.1.20",
100
+ "@backstage/frontend-test-utils": "^0.5.0",
101
+ "@backstage/plugin-signals": "^0.0.28",
102
+ "@backstage/test-utils": "^1.7.15",
103
103
  "@testing-library/jest-dom": "^6.3.0",
104
104
  "@testing-library/react": "^14.0.0",
105
105
  "@testing-library/user-event": "^14.5.1",