@backstage/plugin-app-node 0.0.0-nightly-20230808022043

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# @backstage/plugin-app-node
+
+## 0.0.0-nightly-20230808022043
+
+### Minor Changes
+
+- 9fbe95ef6503: Added the `app` plugin node library, initially providing an extension point that can be used to configure a static fallback handler.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.0.0-nightly-20230808022043

package/README.md

@@ -0,0 +1,5 @@
+# @backstage/plugin-app-node
+
+Welcome to the Node.js library package for the app plugin!
+
+_This plugin was created through the Backstage CLI_

package/dist/index.cjs.js

@@ -0,0 +1,12 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+
+const staticFallbackHandlerExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "app.staticFallbackHandler"
+});
+
+exports.staticFallbackHandlerExtensionPoint = staticFallbackHandlerExtensionPoint;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/extensions.ts"],"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 { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport { Handler } from 'express';\n\n/**\n * The interface for {@link staticFallbackHandlerExtensionPoint}.\n *\n * @public\n */\nexport interface StaticFallbackHandlerExtensionPoint {\n  /**\n   * Sets the static fallback handler. This can only be done once.\n   */\n  setStaticFallbackHandler(handler: Handler): void;\n}\n\n/**\n * An extension point the exposes the ability to configure a static fallback handler for the app backend.\n *\n * The static fallback handler is a request handler to handle requests for static content that is not\n * present in the app bundle.\n *\n * This can be used to avoid issues with clients on older deployment versions trying to access lazy\n * loaded content that is no longer present. Typically the requests would fall back to a long-term\n * object store where all recently deployed versions of the app are present.\n *\n * Another option is to provide a `database` that will take care of storing the static assets instead.\n *\n * If both `database` and `staticFallbackHandler` are provided, the `database` will attempt to serve\n * static assets first, and if they are not found, the `staticFallbackHandler` will be called.\n *\n * @public\n */\nexport const staticFallbackHandlerExtensionPoint =\n  createExtensionPoint<StaticFallbackHandlerExtensionPoint>({\n    id: 'app.staticFallbackHandler',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;;;AAgDO,MAAM,sCACXA,qCAA0D,CAAA;AAAA,EACxD,EAAI,EAAA,2BAAA;AACN,CAAC;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { Handler } from 'express';
+
+/**
+ * The interface for {@link staticFallbackHandlerExtensionPoint}.
+ *
+ * @public
+ */
+interface StaticFallbackHandlerExtensionPoint {
+    /**
+     * Sets the static fallback handler. This can only be done once.
+     */
+    setStaticFallbackHandler(handler: Handler): void;
+}
+/**
+ * An extension point the exposes the ability to configure a static fallback handler for the app backend.
+ *
+ * The static fallback handler is a request handler to handle requests for static content that is not
+ * present in the app bundle.
+ *
+ * This can be used to avoid issues with clients on older deployment versions trying to access lazy
+ * loaded content that is no longer present. Typically the requests would fall back to a long-term
+ * object store where all recently deployed versions of the app are present.
+ *
+ * Another option is to provide a `database` that will take care of storing the static assets instead.
+ *
+ * If both `database` and `staticFallbackHandler` are provided, the `database` will attempt to serve
+ * static assets first, and if they are not found, the `staticFallbackHandler` will be called.
+ *
+ * @public
+ */
+declare const staticFallbackHandlerExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<StaticFallbackHandlerExtensionPoint>;
+
+export { StaticFallbackHandlerExtensionPoint, staticFallbackHandlerExtensionPoint };

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@backstage/plugin-app-node",
+  "description": "Node.js library for the app plugin",
+  "version": "0.0.0-nightly-20230808022043",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "node-library"
+  },
+  "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"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.0.0-nightly-20230808022043"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@backstage/backend-plugin-api": "^0.0.0-nightly-20230808022043",
+    "@types/express": "^4.17.6",
+    "express": "^4.17.1"
+  }
+}