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

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @backstage/backend-plugin-api
 
+## 0.6.10-next.2
+
+### Patch Changes
+
+- 9aac2b0: Use `--cwd` as the first `yarn` argument
+- Updated dependencies
+  - @backstage/backend-tasks@0.5.15-next.2
+  - @backstage/plugin-auth-node@0.4.4-next.2
+  - @backstage/config@1.1.1
+  - @backstage/types@1.1.1
+  - @backstage/plugin-permission-common@0.7.12
+
+## 0.6.10-next.1
+
+### Patch Changes
+
+- 1f020fe: Support `token` in `readTree`, `readUrl` and `search`
+- Updated dependencies
+  - @backstage/backend-tasks@0.5.15-next.1
+  - @backstage/config@1.1.1
+  - @backstage/types@1.1.1
+  - @backstage/plugin-auth-node@0.4.4-next.1
+  - @backstage/plugin-permission-common@0.7.12
+
 ## 0.6.10-next.0
 
 ### Patch Changes

package/README.md

@@ -8,7 +8,7 @@ Add the library to your backend plugin or module package:
 
 ```bash
 # From your Backstage root directory
-yarn add --cwd plugins/<plugin>-backend @backstage/backend-plugin-api
+yarn --cwd plugins/<plugin>-backend add @backstage/backend-plugin-api
 ```
 
 ## Documentation

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-plugin-api",
-  "version": "0.6.10-next.0",
+  "version": "0.6.10-next.2",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/index.d.ts

@@ -83,6 +83,17 @@ type ReadUrlOptions = {
      * Not all reader implementations may take this field into account.
      */
     signal?: AbortSignal;
+    /**
+     * An optional token to use for authentication when reading the resources.
+     *
+     * @remarks
+     *
+     * By default all URL Readers will use the integrations config which is supplied
+     * when creating the Readers. Sometimes it might be desireable to use the already
+     * created URLReaders but with a different token, maybe that's supplied by the user
+     * at runtime.
+     */
+    token?: string;
 };
 /**
  * A response object for {@link UrlReaderService.readUrl} operations.
@@ -165,6 +176,17 @@ type ReadTreeOptions = {
      * Not all reader implementations may take this field into account.
      */
     signal?: AbortSignal;
+    /**
+     * An optional token to use for authentication when reading the resources.
+     *
+     * @remarks
+     *
+     * By default all URL Readers will use the integrations config which is supplied
+     * when creating the Readers. Sometimes it might be desireable to use the already
+     * created URLReaders but with a different token, maybe that's supplied by the user
+     * at runtime.
+     */
+    token?: string;
 };
 /**
  * Options that control {@link ReadTreeResponse.dir} execution.
@@ -257,6 +279,17 @@ type SearchOptions = {
      * Not all reader implementations may take this field into account.
      */
     signal?: AbortSignal;
+    /**
+     * An optional token to use for authentication when reading the resources.
+     *
+     * @remarks
+     *
+     * By default all URL Readers will use the integrations config which is supplied
+     * when creating the Readers. Sometimes it might be desireable to use the already
+     * created URLReaders but with a different token, maybe that's supplied by the user
+     * at runtime.
+     */
+    token?: string;
 };
 /**
  * The output of a search operation.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/backend-plugin-api",
   "description": "Core API used by Backstage backend plugins",
-  "version": "0.6.10-next.0",
+  "version": "0.6.10-next.2",
   "main": "./dist/index.cjs.js",
   "types": "./dist/index.d.ts",
   "publishConfig": {
@@ -43,9 +43,9 @@
     "start": "backstage-cli package start"
   },
   "dependencies": {
-    "@backstage/backend-tasks": "^0.5.15-next.0",
+    "@backstage/backend-tasks": "^0.5.15-next.2",
     "@backstage/config": "^1.1.1",
-    "@backstage/plugin-auth-node": "^0.4.4-next.0",
+    "@backstage/plugin-auth-node": "^0.4.4-next.2",
     "@backstage/plugin-permission-common": "^0.7.12",
     "@backstage/types": "^1.1.1",
     "@types/express": "^4.17.6",
@@ -53,7 +53,7 @@
     "knex": "^3.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.25.2-next.0"
+    "@backstage/cli": "^0.25.2-next.2"
   },
   "files": [
     "dist",