Add scope property to credentials metadata json object

__tests__/main.test.ts

@@ -846,7 +846,8 @@ describe('credentialsFromEnv', () => {
         password: 'baz',
         token: 'tok',
         host: 'h',
-        'replaces-base': false
+        'replaces-base': false,
+        scope: '@mycompany'
       }
     ]
     process.env.GITHUB_REGISTRIES_PROXY = Buffer.from(
@@ -859,6 +860,7 @@ describe('credentialsFromEnv', () => {
     expect(setSecretSpy).toHaveBeenCalledWith('tok')
     expect(setSecretSpy).not.toHaveBeenCalledWith('bar')
     expect(setSecretSpy).not.toHaveBeenCalledWith('https://foo')
+    expect(setSecretSpy).not.toHaveBeenCalledWith('@mycompany')
   })
 })
 

__tests__/updater.test.ts

@@ -151,6 +151,38 @@ describe('Updater', () => {
     })
   })
 
+  describe('when given npm_registry credentials with a scope', () => {
+    const jobDetails = {...mockJobDetails}
+
+    new Updater(
+      'MOCK_UPDATER_IMAGE_NAME',
+      'MOCK_PROXY_IMAGE_NAME',
+      mockApiClient,
+      jobDetails,
+      [
+        {
+          type: 'npm_registry',
+          registry:
+            'jfrogghdemo.jfrog.io/artifactory/api/npm/dpndbt-pvt-repo-npm-key/',
+          username: 'npm_user',
+          token: 'npm_token',
+          scope: '@mycompany'
+        }
+      ]
+    )
+
+    it('generates credentials metadata with the scope', () => {
+      expect(jobDetails['credentials-metadata']).toEqual([
+        {
+          type: 'npm_registry',
+          registry:
+            'jfrogghdemo.jfrog.io/artifactory/api/npm/dpndbt-pvt-repo-npm-key/',
+          scope: '@mycompany'
+        }
+      ])
+    })
+  })
+
   describe('when given npm_registry credentials with a URL and not a registry', () => {
     const jobDetails = {...mockJobDetails}
 

src/api-client.ts

@@ -42,6 +42,7 @@ export type Credential = {
   'index-url'?: string
   'env-key'?: string
   'replaces-base'?: boolean
+  scope?: string
   'public-key-fingerprint'?: string
   'auth-key'?: string
   'tenant-id'?: string

src/main.ts

@@ -448,7 +448,14 @@ export function credentialsFromEnv(): Credential[] {
     botSay('Failed to parse GITHUB_REGISTRIES_PROXY environment variable')
   }
 
-  const nonSecrets = ['type', 'url', 'username', 'host', 'replaces-base']
+  const nonSecrets = [
+    'type',
+    'url',
+    'username',
+    'host',
+    'replaces-base',
+    'scope'
+  ]
   for (const e of parsed) {
     // Mask credentials to reduce chance of accidental leakage in logs.
     for (const key of Object.keys(e)) {

src/updater.ts

@@ -80,6 +80,9 @@ export class Updater {
       if (credential['replaces-base'] !== undefined) {
         obj['replaces-base'] = credential['replaces-base']
       }
+      if (credential.scope !== undefined) {
+        obj.scope = credential.scope
+      }
       if (credential['public-key-fingerprint'] !== undefined) {
         obj['public-key-fingerprint'] = credential['public-key-fingerprint']
       }