@red-hat-developer-hub/backstage-plugin-homepage-common 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# @red-hat-developer-hub/backstage-plugin-homepage-common
+
+## 0.1.0
+
+### Minor Changes
+
+- a5a1846: Homepage default content is now resolved through a new backend with RBAC, widget-oriented configuration, and translated titles. Bumps `@red-hat-developer-hub/backstage-plugin-theme` to `^0.14.1`.
+
+  **`@red-hat-developer-hub/backstage-plugin-dynamic-home-page`**
+
+  - Load default widgets from the homepage backend API (permission-aware), with a frontend API client and hooks.
+
+  **`@red-hat-developer-hub/backstage-plugin-homepage-backend` and `@red-hat-developer-hub/backstage-plugin-homepage-common`**
+
+  - Initial release: backend resolves default widgets using user context, `if` conditions; shared types and permission definitions live in homepage-common.

package/README.md

@@ -0,0 +1,5 @@
+# @red-hat-developer-hub/backstage-plugin-homepage-common
+
+Welcome to the common package for the homepage plugin!
+
+_This plugin was created through the Backstage CLI_

package/dist/index.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+var permissions = require('./permissions.cjs.js');
+
+
+
+exports.RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET = permissions.RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET;
+exports.homepageDefaultWidgetsReadPermission = permissions.homepageDefaultWidgetsReadPermission;
+exports.homepagePermissions = permissions.homepagePermissions;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,57 @@
+import { ResourcePermission } from '@backstage/plugin-permission-common';
+
+/**
+ * @public
+ */
+interface DefaultWidgetVisibility {
+    users?: string[];
+    groups?: string[];
+    permissions?: string[];
+}
+/**
+ * @public
+ */
+interface DefaultWidgetNode {
+    id?: string;
+    ref?: string;
+    props?: Record<string, unknown>;
+    layout?: unknown;
+    if?: DefaultWidgetVisibility;
+    children?: DefaultWidgetNode[];
+}
+/**
+ * @public
+ */
+interface VisibleDefaultWidget {
+    id: string;
+    ref: string;
+    props?: Record<string, unknown>;
+    layout?: unknown;
+}
+/**
+ * @public
+ */
+interface DefaultWidgetsResponse {
+    items: VisibleDefaultWidget[];
+}
+
+/**
+ * @public
+ */
+declare const RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET = "homepage-default-widget";
+/**
+ * Convenience type for homepage default widget permissions
+ * @public
+ */
+type HomepageDefaultWidgetPermission = ResourcePermission<typeof RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET>;
+/**
+ * This permission is used to read the homepage default widgets endpoint
+ * @public
+ */
+declare const homepageDefaultWidgetsReadPermission: ResourcePermission<"homepage-default-widget">;
+/**
+ * @public
+ */
+declare const homepagePermissions: ResourcePermission<"homepage-default-widget">[];
+
+export { type DefaultWidgetNode, type DefaultWidgetVisibility, type DefaultWidgetsResponse, type HomepageDefaultWidgetPermission, RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET, type VisibleDefaultWidget, homepageDefaultWidgetsReadPermission, homepagePermissions };

package/dist/index.esm.js

@@ -0,0 +1,2 @@
+export { RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET, homepageDefaultWidgetsReadPermission, homepagePermissions } from './permissions.esm.js';
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/permissions.cjs.js

@@ -0,0 +1,18 @@
+'use strict';
+
+var pluginPermissionCommon = require('@backstage/plugin-permission-common');
+
+const RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET = "homepage-default-widget";
+const homepageDefaultWidgetsReadPermission = pluginPermissionCommon.createPermission({
+  name: "homepage.default-widgets.read",
+  attributes: {
+    action: "read"
+  },
+  resourceType: RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET
+});
+const homepagePermissions = [homepageDefaultWidgetsReadPermission];
+
+exports.RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET = RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET;
+exports.homepageDefaultWidgetsReadPermission = homepageDefaultWidgetsReadPermission;
+exports.homepagePermissions = homepagePermissions;
+//# sourceMappingURL=permissions.cjs.js.map

package/dist/permissions.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.cjs.js","sources":["../src/permissions.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\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  createPermission,\n  ResourcePermission,\n} from '@backstage/plugin-permission-common';\n\n/**\n * @public\n */\nexport const RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET = 'homepage-default-widget';\n\n/**\n * Convenience type for homepage default widget permissions\n * @public\n */\nexport type HomepageDefaultWidgetPermission = ResourcePermission<\n  typeof RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET\n>;\n\n/**\n * This permission is used to read the homepage default widgets endpoint\n * @public\n */\nexport const homepageDefaultWidgetsReadPermission = createPermission({\n  name: 'homepage.default-widgets.read',\n  attributes: {\n    action: 'read',\n  },\n  resourceType: RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET,\n});\n\n/**\n * @public\n */\nexport const homepagePermissions = [homepageDefaultWidgetsReadPermission];\n"],"names":["createPermission"],"mappings":";;;;AAuBO,MAAM,qCAAwC,GAAA;AAc9C,MAAM,uCAAuCA,uCAAiB,CAAA;AAAA,EACnE,IAAM,EAAA,+BAAA;AAAA,EACN,UAAY,EAAA;AAAA,IACV,MAAQ,EAAA;AAAA,GACV;AAAA,EACA,YAAc,EAAA;AAChB,CAAC;AAKY,MAAA,mBAAA,GAAsB,CAAC,oCAAoC;;;;;;"}

package/dist/permissions.esm.js

@@ -0,0 +1,14 @@
+import { createPermission } from '@backstage/plugin-permission-common';
+
+const RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET = "homepage-default-widget";
+const homepageDefaultWidgetsReadPermission = createPermission({
+  name: "homepage.default-widgets.read",
+  attributes: {
+    action: "read"
+  },
+  resourceType: RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET
+});
+const homepagePermissions = [homepageDefaultWidgetsReadPermission];
+
+export { RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET, homepageDefaultWidgetsReadPermission, homepagePermissions };
+//# sourceMappingURL=permissions.esm.js.map

package/dist/permissions.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.esm.js","sources":["../src/permissions.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\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  createPermission,\n  ResourcePermission,\n} from '@backstage/plugin-permission-common';\n\n/**\n * @public\n */\nexport const RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET = 'homepage-default-widget';\n\n/**\n * Convenience type for homepage default widget permissions\n * @public\n */\nexport type HomepageDefaultWidgetPermission = ResourcePermission<\n  typeof RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET\n>;\n\n/**\n * This permission is used to read the homepage default widgets endpoint\n * @public\n */\nexport const homepageDefaultWidgetsReadPermission = createPermission({\n  name: 'homepage.default-widgets.read',\n  attributes: {\n    action: 'read',\n  },\n  resourceType: RESOURCE_TYPE_HOMEPAGE_DEFAULT_WIDGET,\n});\n\n/**\n * @public\n */\nexport const homepagePermissions = [homepageDefaultWidgetsReadPermission];\n"],"names":[],"mappings":";;AAuBO,MAAM,qCAAwC,GAAA;AAc9C,MAAM,uCAAuC,gBAAiB,CAAA;AAAA,EACnE,IAAM,EAAA,+BAAA;AAAA,EACN,UAAY,EAAA;AAAA,IACV,MAAQ,EAAA;AAAA,GACV;AAAA,EACA,YAAc,EAAA;AAChB,CAAC;AAKY,MAAA,mBAAA,GAAsB,CAAC,oCAAoC;;;;"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@red-hat-developer-hub/backstage-plugin-homepage-common",
+  "version": "0.1.0",
+  "license": "Apache-2.0",
+  "description": "Common functionalities for the homepage plugin",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "module": "dist/index.esm.js",
+    "types": "dist/index.d.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/redhat-developer/rhdh-plugins",
+    "directory": "workspaces/homepage/plugins/homepage-common"
+  },
+  "backstage": {
+    "role": "common-library",
+    "pluginId": "homepage",
+    "pluginPackages": [
+      "@red-hat-developer-hub/backstage-plugin-dynamic-home-page",
+      "@red-hat-developer-hub/backstage-plugin-homepage-backend",
+      "@red-hat-developer-hub/backstage-plugin-homepage-common"
+    ]
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage/plugin-permission-common": "^0.9.7"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.36.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "typesVersions": {
+    "*": {
+      "package.json": [
+        "package.json"
+      ]
+    }
+  },
+  "module": "dist/index.esm.js"
+}