@backstage/backend-plugin-api 0.4.1-next.2 → 0.5.1-next.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @backstage/backend-plugin-api
 
+## 0.5.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/config@1.0.7
+  - @backstage/backend-tasks@0.5.1-next.0
+  - @backstage/types@1.0.2
+  - @backstage/plugin-auth-node@0.2.13-next.0
+  - @backstage/plugin-permission-common@0.7.4
+
+## 0.5.0
+
+### Minor Changes
+
+- c1ee073a82b: Added `lastModifiedAt` field on `UrlReaderService` responses and a `lastModifiedAfter` option to `UrlReaderService.readUrl`.
+
+### Patch Changes
+
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 482dae5de1c: Updated link to docs.
+- Updated dependencies
+  - @backstage/plugin-auth-node@0.2.12
+  - @backstage/backend-tasks@0.5.0
+  - @backstage/plugin-permission-common@0.7.4
+  - @backstage/config@1.0.7
+  - @backstage/types@1.0.2
+
 ## 0.4.1-next.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -56,6 +56,25 @@ declare type ReadUrlOptions = {
      * of the response along with a new ETag.
      */
     etag?: string;
+    /**
+     * A date which can be provided to check whether a
+     * {@link UrlReaderService.readUrl} response has changed since the lastModifiedAt.
+     *
+     * @remarks
+     *
+     * In the {@link UrlReaderService.readUrl} response, an lastModifiedAt is returned
+     * along with data. The lastModifiedAt date represents the last time the data
+     * was modified.
+     *
+     * When an lastModifiedAfter is given in ReadUrlOptions, {@link UrlReaderService.readUrl}
+     * will compare the lastModifiedAfter against the lastModifiedAt of the target. If
+     * the data has not been modified since this date, the {@link UrlReaderService.readUrl}
+     * will throw a {@link @backstage/errors#NotModifiedError} indicating that the
+     * response does not contain any new data. If they do not match,
+     * {@link UrlReaderService.readUrl} will return the rest of the response along with new
+     * lastModifiedAt date.
+     */
+    lastModifiedAfter?: Date;
     /**
      * An abort signal to pass down to the underlying request.
      *
@@ -91,6 +110,10 @@ declare type ReadUrlResponse = {
      * Can be used to compare and cache responses when doing subsequent calls.
      */
     etag?: string;
+    /**
+     * Last modified date of the file contents.
+     */
+    lastModifiedAt?: Date;
 };
 /**
  * An options object for {@link UrlReaderService.readTree} operations.
@@ -195,8 +218,18 @@ declare type ReadTreeResponse = {
  * @public
  */
 declare type ReadTreeResponseFile = {
+    /**
+     * The filepath of the data.
+     */
     path: string;
+    /**
+     * The binary contents of the file.
+     */
     content(): Promise<Buffer>;
+    /**
+     * The last modified timestamp of the data.
+     */
+    lastModifiedAt?: Date;
 };
 /**
  * An options object for search operations.
@@ -254,6 +287,10 @@ declare type SearchResponseFile = {
      * The binary contents of the file.
      */
     content(): Promise<Buffer>;
+    /**
+     * The last modified timestamp of the data.
+     */
+    lastModifiedAt?: Date;
 };
 
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/backend-plugin-api",
   "description": "Core API used by Backstage backend plugins",
-  "version": "0.4.1-next.2",
+  "version": "0.5.1-next.0",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "publishConfig": {
@@ -32,17 +32,17 @@
     "start": "backstage-cli package start"
   },
   "dependencies": {
-    "@backstage/backend-tasks": "^0.5.0-next.2",
-    "@backstage/config": "^1.0.7-next.0",
-    "@backstage/plugin-auth-node": "^0.2.12-next.2",
-    "@backstage/plugin-permission-common": "^0.7.4-next.0",
+    "@backstage/backend-tasks": "^0.5.1-next.0",
+    "@backstage/config": "^1.0.7",
+    "@backstage/plugin-auth-node": "^0.2.13-next.0",
+    "@backstage/plugin-permission-common": "^0.7.4",
     "@backstage/types": "^1.0.2",
     "@types/express": "^4.17.6",
     "express": "^4.17.1",
     "knex": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.4-next.1"
+    "@backstage/cli": "^0.22.6-next.0"
   },
   "files": [
     "dist",