@taskcluster/client-web 105.1.0 → 107.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taskcluster/client-web",
-  "version": "105.1.0",
+  "version": "107.0.0",
   "type": "module",
   "main": "src/index.js",
   "exports": "./src/index.js",

package/src/clients/Auth.js

@@ -41,6 +41,7 @@ export default class Auth extends Client {
     this.sentryDSN.entry = {"args":["project"],"category":"Sentry Credentials","method":"get","name":"sentryDSN","output":true,"query":[],"route":"/sentry/<project>/dsn","scopes":"auth:sentry:<project>","stability":"stable","type":"function"};
     this.websocktunnelToken.entry = {"args":["wstAudience","wstClient"],"category":"Websocktunnel Credentials","method":"get","name":"websocktunnelToken","output":true,"query":[],"route":"/websocktunnel/<wstAudience>/<wstClient>","scopes":"auth:websocktunnel-token:<wstAudience>/<wstClient>","stability":"stable","type":"function"};
     this.gcpCredentials.entry = {"args":["projectId","serviceAccount"],"category":"GCP Credentials","method":"get","name":"gcpCredentials","output":true,"query":[],"route":"/gcp/credentials/<projectId>/<serviceAccount>","scopes":"auth:gcp:access-token:<projectId>/<serviceAccount>","stability":"stable","type":"function"};
+    this.githubRepoToken.entry = {"args":["appName","owner"],"category":"Github Credentials","input":true,"method":"post","name":"githubRepoToken","output":true,"query":[],"route":"/github/<appName>/<owner>/repo-token","scopes":{"AllOf":[{"each":"auth:github-repo-token:<appName>/<owner>/<repoPerm>","for":"repoPerm","in":"repoPerms"}]},"stability":"experimental","type":"function"};
     this.authenticateHawk.entry = {"args":[],"category":"Scopes and Auth","input":true,"method":"post","name":"authenticateHawk","output":true,"query":[],"route":"/authenticate-hawk","stability":"stable","type":"function"};
     this.testAuthenticate.entry = {"args":[],"category":"Scopes and Auth","input":true,"method":"post","name":"testAuthenticate","output":true,"query":[],"route":"/test-authenticate","stability":"stable","type":"function"};
     this.testAuthenticateGet.entry = {"args":[],"category":"Scopes and Auth","method":"get","name":"testAuthenticateGet","output":true,"query":[],"route":"/test-authenticate-get/","stability":"stable","type":"function"};
@@ -344,6 +345,24 @@ export default class Auth extends Client {
 
     return this.request(this.gcpCredentials.entry, args);
   }
+  // Get a Github application installation token scoped to the given repositories
+  // and permissions, using the configured app `appName`.
+  // Requesting `<permission>: <level>` on `<owner>/<repo>` requires the scope
+  // `auth:github-repo-token:<appName>/<owner>/<repo>:<permission>:<level>`.
+  // Levels and permissions are matched exactly to github token permissions
+  // which can be found at
+  // https://docs.github.com/en/rest/apps/apps?apiVersion=2026-03-10#create-an-installation-access-token-for-an-app.
+  // While token access is widened (requesting a write token will give a read+write one)
+  // scopes are not. Holding `:contents:write` alone only allows requesting a `write` token.
+  // Both owner and repo must be in lowercase in the scope.
+  // The token expires after an hour but this behavior is github dependent.
+  // You should read the `expires` property from the response if you intend
+  // to maintain active credentials in your task.
+  githubRepoToken(...args) {
+    this.validate(this.githubRepoToken.entry, args);
+
+    return this.request(this.githubRepoToken.entry, args);
+  }
   // Validate the request signature given on input and return list of scopes
   // that the authenticating client has.
   // This method is used by other services that wish rely on Taskcluster

package/src/clients/Queue.js

@@ -46,14 +46,12 @@ export default class Queue extends Client {
     this.latestArtifact.entry = {"args":["taskId","name"],"category":"Artifacts","method":"get","name":"latestArtifact","output":true,"query":[],"route":"/task/<taskId>/artifact-content/<name>","scopes":{"AllOf":[{"each":"queue:get-artifact:<name>","for":"name","in":"names"}]},"stability":"stable","type":"function"};
     this.listProvisioners.entry = {"args":[],"category":"Worker Metadata","method":"get","name":"listProvisioners","output":true,"query":["continuationToken","limit"],"route":"/provisioners","scopes":"queue:list-provisioners","stability":"deprecated","type":"function"};
     this.getProvisioner.entry = {"args":["provisionerId"],"category":"Worker Metadata","method":"get","name":"getProvisioner","output":true,"query":[],"route":"/provisioners/<provisionerId>","scopes":"queue:get-provisioner:<provisionerId>","stability":"deprecated","type":"function"};
-    this.declareProvisioner.entry = {"args":["provisionerId"],"category":"Worker Metadata","input":true,"method":"put","name":"declareProvisioner","output":true,"query":[],"route":"/provisioners/<provisionerId>","scopes":{"AllOf":[{"each":"queue:declare-provisioner:<provisionerId>#<property>","for":"property","in":"properties"}]},"stability":"deprecated","type":"function"};
     this.pendingTasks.entry = {"args":["taskQueueId"],"category":"Worker Metadata","method":"get","name":"pendingTasks","output":true,"query":[],"route":"/pending/<taskQueueId>","scopes":"queue:pending-count:<taskQueueId>","stability":"deprecated","type":"function"};
     this.taskQueueCounts.entry = {"args":["taskQueueId"],"category":"Worker Metadata","method":"get","name":"taskQueueCounts","output":true,"query":[],"route":"/task-queues/<taskQueueId>/counts","scopes":{"AllOf":["queue:pending-count:<taskQueueId>","queue:claimed-count:<taskQueueId>"]},"stability":"stable","type":"function"};
     this.listPendingTasks.entry = {"args":["taskQueueId"],"category":"Worker Metadata","method":"get","name":"listPendingTasks","output":true,"query":["continuationToken","limit"],"route":"/task-queues/<taskQueueId>/pending","scopes":"queue:pending-list:<taskQueueId>","stability":"experimental","type":"function"};
     this.listClaimedTasks.entry = {"args":["taskQueueId"],"category":"Worker Metadata","method":"get","name":"listClaimedTasks","output":true,"query":["continuationToken","limit"],"route":"/task-queues/<taskQueueId>/claimed","scopes":"queue:claimed-list:<taskQueueId>","stability":"experimental","type":"function"};
     this.listWorkerTypes.entry = {"args":["provisionerId"],"category":"Worker Metadata","method":"get","name":"listWorkerTypes","output":true,"query":["continuationToken","limit"],"route":"/provisioners/<provisionerId>/worker-types","scopes":"queue:list-worker-types:<provisionerId>","stability":"deprecated","type":"function"};
     this.getWorkerType.entry = {"args":["provisionerId","workerType"],"category":"Worker Metadata","method":"get","name":"getWorkerType","output":true,"query":[],"route":"/provisioners/<provisionerId>/worker-types/<workerType>","scopes":"queue:get-worker-type:<provisionerId>/<workerType>","stability":"deprecated","type":"function"};
-    this.declareWorkerType.entry = {"args":["provisionerId","workerType"],"category":"Worker Metadata","input":true,"method":"put","name":"declareWorkerType","output":true,"query":[],"route":"/provisioners/<provisionerId>/worker-types/<workerType>","scopes":{"AllOf":[{"each":"queue:declare-worker-type:<provisionerId>/<workerType>#<property>","for":"property","in":"properties"}]},"stability":"deprecated","type":"function"};
     this.listTaskQueues.entry = {"args":[],"category":"Worker Metadata","method":"get","name":"listTaskQueues","output":true,"query":["continuationToken","limit"],"route":"/task-queues","scopes":"queue:list-task-queues","stability":"stable","type":"function"};
     this.getTaskQueue.entry = {"args":["taskQueueId"],"category":"Worker Metadata","method":"get","name":"getTaskQueue","output":true,"query":[],"route":"/task-queues/<taskQueueId>","scopes":"queue:get-task-queue:<taskQueueId>","stability":"stable","type":"function"};
     this.listWorkers.entry = {"args":["provisionerId","workerType"],"category":"Worker Metadata","method":"get","name":"listWorkers","output":true,"query":["continuationToken","limit","quarantined"],"route":"/provisioners/<provisionerId>/worker-types/<workerType>/workers","scopes":"queue:list-workers:<provisionerId>/<workerType>","stability":"deprecated","type":"function"};
@@ -558,19 +556,6 @@ export default class Queue extends Client {
 
     return this.request(this.getProvisioner.entry, args);
   }
-  // Declare a provisioner, supplying some details about it.
-  // `declareProvisioner` allows updating one or more properties of a provisioner as long as the required scopes are
-  // possessed. For example, a request to update the `my-provisioner`
-  // provisioner with a body `{description: 'This provisioner is great'}` would require you to have the scope
-  // `queue:declare-provisioner:my-provisioner#description`.
-  // The term "provisioner" is taken broadly to mean anything with a provisionerId.
-  // This does not necessarily mean there is an associated service performing any
-  // provisioning activity.
-  declareProvisioner(...args) {
-    this.validate(this.declareProvisioner.entry, args);
-
-    return this.request(this.declareProvisioner.entry, args);
-  }
   // Get an approximate number of pending tasks for the given `taskQueueId`.
   // As task states may change rapidly, this number may not represent the exact
   // number of pending tasks, but a very good approximation.
@@ -620,16 +605,6 @@ export default class Queue extends Client {
 
     return this.request(this.getWorkerType.entry, args);
   }
-  // Declare a workerType, supplying some details about it.
-  // `declareWorkerType` allows updating one or more properties of a worker-type as long as the required scopes are
-  // possessed. For example, a request to update the `highmem` worker-type within the `my-provisioner`
-  // provisioner with a body `{description: 'This worker type is great'}` would require you to have the scope
-  // `queue:declare-worker-type:my-provisioner/highmem#description`.
-  declareWorkerType(...args) {
-    this.validate(this.declareWorkerType.entry, args);
-
-    return this.request(this.declareWorkerType.entry, args);
-  }
   // Get all active task queues.
   // The response is paged. If this end-point returns a `continuationToken`, you
   // should call the end-point again with the `continuationToken` as a query-string