@backstage-community/plugin-npm-common 1.7.0 → 1.9.0

package/CHANGELOG.md

@@ -1,10 +1,22 @@
 # @backstage-community/plugin-npm-common
 
+## 1.9.0
+
+### Minor Changes
+
+- 9df5e2a: Add new npm registry option `extraRequestHeaders` to pass for example non-standard authentification headers.
+
+## 1.8.0
+
+### Minor Changes
+
+- 4bfc2ec: Backstage version bump to v1.40.1
+
 ## 1.7.0
 
 ### Minor Changes
 
-- c42ca51: Backstage version bump to v1.39.0
+- c42ca51: Backstage version bump to v1.39.1
 
 ## 1.6.0
 

package/dist/NpmRegistryClient.cjs.js

@@ -6,10 +6,12 @@ class NpmRegistryClient {
   fetch;
   baseUrl;
   token;
+  extraRequestHeaders;
   constructor(options) {
     this.fetch = options?.fetch || global.fetch.bind(global);
     this.baseUrl = options.baseUrl || "https://registry.npmjs.com";
     this.token = options.token;
+    this.extraRequestHeaders = options.extraRequestHeaders;
   }
   async getPackageInfo(packageName) {
     if (!packageName) {
@@ -17,7 +19,10 @@ class NpmRegistryClient {
     }
     const url = `${this.baseUrl}/${encodeURIComponent(packageName)}`;
     const response = await this.fetch(url, {
-      headers: this.token ? { Authorization: this.token } : undefined
+      headers: {
+        ...this.extraRequestHeaders,
+        ...this.token ? { Authorization: this.token } : undefined
+      }
     });
     if (!response.ok) {
       throw await errors.ResponseError.fromResponse(response);

package/dist/NpmRegistryClient.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"NpmRegistryClient.cjs.js","sources":["../src/NpmRegistryClient.ts"],"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 { ResponseError } from '@backstage/errors';\n\nimport { NpmRegistryPackageInfo } from './types';\n\n/**\n * @public\n */\nexport class NpmRegistryClient {\n  private readonly fetch: typeof fetch;\n  private readonly baseUrl: string;\n  private readonly token?: string;\n\n  constructor(options: {\n    fetch?: typeof fetch;\n    baseUrl?: string;\n    token?: string;\n  }) {\n    this.fetch = options?.fetch || global.fetch.bind(global);\n    this.baseUrl = options.baseUrl || 'https://registry.npmjs.com';\n    this.token = options.token;\n  }\n\n  async getPackageInfo(packageName: string): Promise<NpmRegistryPackageInfo> {\n    if (!packageName) {\n      throw new Error('No package name provided');\n    }\n\n    const url = `${this.baseUrl}/${encodeURIComponent(packageName)}`;\n\n    const response = await this.fetch(url, {\n      headers: this.token ? { Authorization: this.token } : undefined,\n    });\n\n    if (!response.ok) {\n      throw await ResponseError.fromResponse(response);\n    }\n    return response.json();\n  }\n}\n"],"names":["ResponseError"],"mappings":";;;;AAsBO,MAAM,iBAAkB,CAAA;AAAA,EACZ,KAAA;AAAA,EACA,OAAA;AAAA,EACA,KAAA;AAAA,EAEjB,YAAY,OAIT,EAAA;AACD,IAAA,IAAA,CAAK,QAAQ,OAAS,EAAA,KAAA,IAAS,MAAO,CAAA,KAAA,CAAM,KAAK,MAAM,CAAA;AACvD,IAAK,IAAA,CAAA,OAAA,GAAU,QAAQ,OAAW,IAAA,4BAAA;AAClC,IAAA,IAAA,CAAK,QAAQ,OAAQ,CAAA,KAAA;AAAA;AACvB,EAEA,MAAM,eAAe,WAAsD,EAAA;AACzE,IAAA,IAAI,CAAC,WAAa,EAAA;AAChB,MAAM,MAAA,IAAI,MAAM,0BAA0B,CAAA;AAAA;AAG5C,IAAA,MAAM,MAAM,CAAG,EAAA,IAAA,CAAK,OAAO,CAAI,CAAA,EAAA,kBAAA,CAAmB,WAAW,CAAC,CAAA,CAAA;AAE9D,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,KAAA,CAAM,GAAK,EAAA;AAAA,MACrC,SAAS,IAAK,CAAA,KAAA,GAAQ,EAAE,aAAe,EAAA,IAAA,CAAK,OAAU,GAAA;AAAA,KACvD,CAAA;AAED,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAM,MAAA,MAAMA,oBAAc,CAAA,YAAA,CAAa,QAAQ,CAAA;AAAA;AAEjD,IAAA,OAAO,SAAS,IAAK,EAAA;AAAA;AAEzB;;;;"}
+{"version":3,"file":"NpmRegistryClient.cjs.js","sources":["../src/NpmRegistryClient.ts"],"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 { ResponseError } from '@backstage/errors';\n\nimport { NpmRegistryPackageInfo } from './types';\n\n/**\n * @public\n */\nexport class NpmRegistryClient {\n  private readonly fetch: typeof fetch;\n  private readonly baseUrl: string;\n  private readonly token?: string;\n  private readonly extraRequestHeaders?: Record<string, string>;\n\n  constructor(options: {\n    fetch?: typeof fetch;\n    baseUrl?: string;\n    token?: string;\n    extraRequestHeaders?: Record<string, string>;\n  }) {\n    this.fetch = options?.fetch || global.fetch.bind(global);\n    this.baseUrl = options.baseUrl || 'https://registry.npmjs.com';\n    this.token = options.token;\n    this.extraRequestHeaders = options.extraRequestHeaders;\n  }\n\n  async getPackageInfo(packageName: string): Promise<NpmRegistryPackageInfo> {\n    if (!packageName) {\n      throw new Error('No package name provided');\n    }\n\n    const url = `${this.baseUrl}/${encodeURIComponent(packageName)}`;\n\n    const response = await this.fetch(url, {\n      headers: {\n        ...this.extraRequestHeaders,\n        ...(this.token ? { Authorization: this.token } : undefined),\n      },\n    });\n\n    if (!response.ok) {\n      throw await ResponseError.fromResponse(response);\n    }\n    return response.json();\n  }\n}\n"],"names":["ResponseError"],"mappings":";;;;AAsBO,MAAM,iBAAkB,CAAA;AAAA,EACZ,KAAA;AAAA,EACA,OAAA;AAAA,EACA,KAAA;AAAA,EACA,mBAAA;AAAA,EAEjB,YAAY,OAKT,EAAA;AACD,IAAA,IAAA,CAAK,QAAQ,OAAS,EAAA,KAAA,IAAS,MAAO,CAAA,KAAA,CAAM,KAAK,MAAM,CAAA;AACvD,IAAK,IAAA,CAAA,OAAA,GAAU,QAAQ,OAAW,IAAA,4BAAA;AAClC,IAAA,IAAA,CAAK,QAAQ,OAAQ,CAAA,KAAA;AACrB,IAAA,IAAA,CAAK,sBAAsB,OAAQ,CAAA,mBAAA;AAAA;AACrC,EAEA,MAAM,eAAe,WAAsD,EAAA;AACzE,IAAA,IAAI,CAAC,WAAa,EAAA;AAChB,MAAM,MAAA,IAAI,MAAM,0BAA0B,CAAA;AAAA;AAG5C,IAAA,MAAM,MAAM,CAAG,EAAA,IAAA,CAAK,OAAO,CAAI,CAAA,EAAA,kBAAA,CAAmB,WAAW,CAAC,CAAA,CAAA;AAE9D,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,KAAA,CAAM,GAAK,EAAA;AAAA,MACrC,OAAS,EAAA;AAAA,QACP,GAAG,IAAK,CAAA,mBAAA;AAAA,QACR,GAAI,IAAK,CAAA,KAAA,GAAQ,EAAE,aAAe,EAAA,IAAA,CAAK,OAAU,GAAA;AAAA;AACnD,KACD,CAAA;AAED,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAM,MAAA,MAAMA,oBAAc,CAAA,YAAA,CAAa,QAAQ,CAAA;AAAA;AAEjD,IAAA,OAAO,SAAS,IAAK,EAAA;AAAA;AAEzB;;;;"}

package/dist/NpmRegistryClient.esm.js

@@ -4,10 +4,12 @@ class NpmRegistryClient {
   fetch;
   baseUrl;
   token;
+  extraRequestHeaders;
   constructor(options) {
     this.fetch = options?.fetch || global.fetch.bind(global);
     this.baseUrl = options.baseUrl || "https://registry.npmjs.com";
     this.token = options.token;
+    this.extraRequestHeaders = options.extraRequestHeaders;
   }
   async getPackageInfo(packageName) {
     if (!packageName) {
@@ -15,7 +17,10 @@ class NpmRegistryClient {
     }
     const url = `${this.baseUrl}/${encodeURIComponent(packageName)}`;
     const response = await this.fetch(url, {
-      headers: this.token ? { Authorization: this.token } : undefined
+      headers: {
+        ...this.extraRequestHeaders,
+        ...this.token ? { Authorization: this.token } : undefined
+      }
     });
     if (!response.ok) {
       throw await ResponseError.fromResponse(response);

package/dist/NpmRegistryClient.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"NpmRegistryClient.esm.js","sources":["../src/NpmRegistryClient.ts"],"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 { ResponseError } from '@backstage/errors';\n\nimport { NpmRegistryPackageInfo } from './types';\n\n/**\n * @public\n */\nexport class NpmRegistryClient {\n  private readonly fetch: typeof fetch;\n  private readonly baseUrl: string;\n  private readonly token?: string;\n\n  constructor(options: {\n    fetch?: typeof fetch;\n    baseUrl?: string;\n    token?: string;\n  }) {\n    this.fetch = options?.fetch || global.fetch.bind(global);\n    this.baseUrl = options.baseUrl || 'https://registry.npmjs.com';\n    this.token = options.token;\n  }\n\n  async getPackageInfo(packageName: string): Promise<NpmRegistryPackageInfo> {\n    if (!packageName) {\n      throw new Error('No package name provided');\n    }\n\n    const url = `${this.baseUrl}/${encodeURIComponent(packageName)}`;\n\n    const response = await this.fetch(url, {\n      headers: this.token ? { Authorization: this.token } : undefined,\n    });\n\n    if (!response.ok) {\n      throw await ResponseError.fromResponse(response);\n    }\n    return response.json();\n  }\n}\n"],"names":[],"mappings":";;AAsBO,MAAM,iBAAkB,CAAA;AAAA,EACZ,KAAA;AAAA,EACA,OAAA;AAAA,EACA,KAAA;AAAA,EAEjB,YAAY,OAIT,EAAA;AACD,IAAA,IAAA,CAAK,QAAQ,OAAS,EAAA,KAAA,IAAS,MAAO,CAAA,KAAA,CAAM,KAAK,MAAM,CAAA;AACvD,IAAK,IAAA,CAAA,OAAA,GAAU,QAAQ,OAAW,IAAA,4BAAA;AAClC,IAAA,IAAA,CAAK,QAAQ,OAAQ,CAAA,KAAA;AAAA;AACvB,EAEA,MAAM,eAAe,WAAsD,EAAA;AACzE,IAAA,IAAI,CAAC,WAAa,EAAA;AAChB,MAAM,MAAA,IAAI,MAAM,0BAA0B,CAAA;AAAA;AAG5C,IAAA,MAAM,MAAM,CAAG,EAAA,IAAA,CAAK,OAAO,CAAI,CAAA,EAAA,kBAAA,CAAmB,WAAW,CAAC,CAAA,CAAA;AAE9D,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,KAAA,CAAM,GAAK,EAAA;AAAA,MACrC,SAAS,IAAK,CAAA,KAAA,GAAQ,EAAE,aAAe,EAAA,IAAA,CAAK,OAAU,GAAA;AAAA,KACvD,CAAA;AAED,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAM,MAAA,MAAM,aAAc,CAAA,YAAA,CAAa,QAAQ,CAAA;AAAA;AAEjD,IAAA,OAAO,SAAS,IAAK,EAAA;AAAA;AAEzB;;;;"}
+{"version":3,"file":"NpmRegistryClient.esm.js","sources":["../src/NpmRegistryClient.ts"],"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 { ResponseError } from '@backstage/errors';\n\nimport { NpmRegistryPackageInfo } from './types';\n\n/**\n * @public\n */\nexport class NpmRegistryClient {\n  private readonly fetch: typeof fetch;\n  private readonly baseUrl: string;\n  private readonly token?: string;\n  private readonly extraRequestHeaders?: Record<string, string>;\n\n  constructor(options: {\n    fetch?: typeof fetch;\n    baseUrl?: string;\n    token?: string;\n    extraRequestHeaders?: Record<string, string>;\n  }) {\n    this.fetch = options?.fetch || global.fetch.bind(global);\n    this.baseUrl = options.baseUrl || 'https://registry.npmjs.com';\n    this.token = options.token;\n    this.extraRequestHeaders = options.extraRequestHeaders;\n  }\n\n  async getPackageInfo(packageName: string): Promise<NpmRegistryPackageInfo> {\n    if (!packageName) {\n      throw new Error('No package name provided');\n    }\n\n    const url = `${this.baseUrl}/${encodeURIComponent(packageName)}`;\n\n    const response = await this.fetch(url, {\n      headers: {\n        ...this.extraRequestHeaders,\n        ...(this.token ? { Authorization: this.token } : undefined),\n      },\n    });\n\n    if (!response.ok) {\n      throw await ResponseError.fromResponse(response);\n    }\n    return response.json();\n  }\n}\n"],"names":[],"mappings":";;AAsBO,MAAM,iBAAkB,CAAA;AAAA,EACZ,KAAA;AAAA,EACA,OAAA;AAAA,EACA,KAAA;AAAA,EACA,mBAAA;AAAA,EAEjB,YAAY,OAKT,EAAA;AACD,IAAA,IAAA,CAAK,QAAQ,OAAS,EAAA,KAAA,IAAS,MAAO,CAAA,KAAA,CAAM,KAAK,MAAM,CAAA;AACvD,IAAK,IAAA,CAAA,OAAA,GAAU,QAAQ,OAAW,IAAA,4BAAA;AAClC,IAAA,IAAA,CAAK,QAAQ,OAAQ,CAAA,KAAA;AACrB,IAAA,IAAA,CAAK,sBAAsB,OAAQ,CAAA,mBAAA;AAAA;AACrC,EAEA,MAAM,eAAe,WAAsD,EAAA;AACzE,IAAA,IAAI,CAAC,WAAa,EAAA;AAChB,MAAM,MAAA,IAAI,MAAM,0BAA0B,CAAA;AAAA;AAG5C,IAAA,MAAM,MAAM,CAAG,EAAA,IAAA,CAAK,OAAO,CAAI,CAAA,EAAA,kBAAA,CAAmB,WAAW,CAAC,CAAA,CAAA;AAE9D,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,KAAA,CAAM,GAAK,EAAA;AAAA,MACrC,OAAS,EAAA;AAAA,QACP,GAAG,IAAK,CAAA,mBAAA;AAAA,QACR,GAAI,IAAK,CAAA,KAAA,GAAQ,EAAE,aAAe,EAAA,IAAA,CAAK,OAAU,GAAA;AAAA;AACnD,KACD,CAAA;AAED,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAM,MAAA,MAAM,aAAc,CAAA,YAAA,CAAa,QAAQ,CAAA;AAAA;AAEjD,IAAA,OAAO,SAAS,IAAK,EAAA;AAAA;AAEzB;;;;"}

package/dist/index.d.ts

@@ -74,10 +74,12 @@ declare class NpmRegistryClient {
     private readonly fetch;
     private readonly baseUrl;
     private readonly token?;
+    private readonly extraRequestHeaders?;
     constructor(options: {
         fetch?: typeof fetch;
         baseUrl?: string;
         token?: string;
+        extraRequestHeaders?: Record<string, string>;
     });
     getPackageInfo(packageName: string): Promise<NpmRegistryPackageInfo>;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage-community/plugin-npm-common",
   "description": "Common functionalities for the npm plugin",
-  "version": "1.7.0",
+  "version": "1.9.0",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -39,7 +39,7 @@
     "@backstage/errors": "^1.2.7"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.32.1"
+    "@backstage/cli": "^0.33.0"
   },
   "files": [
     "dist"