@octokit/app - npm Package Compare versions

Comparing version 10.1.0 to 10.1.1

dist-node/index.js

@@ -8,2 +8,3 @@ 'use strict';
 var oauthApp = require('@octokit/oauth-app');
+var authUnauthenticated = require('@octokit/auth-unauthenticated');
 var webhooks$1 = require('@octokit/webhooks');
@@ -190,3 +191,3 @@ var pluginPaginateRest = require('@octokit/plugin-paginate-rest');
 
-const VERSION = "10.1.0";
+const VERSION = "10.1.1";
 
@@ -198,5 +199,18 @@ function webhooks(appOctokit, options) {
     transform: async event => {
+      if (!("installation" in event.payload) || typeof event.payload.installation !== "object") {
+        const octokit = new appOctokit.constructor({
+          authStrategy: authUnauthenticated.createUnauthenticatedAuth,
+          auth: {
+            reason: `"installation" key missing in webhook event payload`
+          }
+        });
+        return _objectSpread2(_objectSpread2({}, event), {}, {
+          octokit: octokit
+        });
+      }
+
+      const installationId = event.payload.installation.id;
       const octokit = await appOctokit.auth({
         type: "installation",
-        installationId: event.payload.installation.id,
+        installationId,
         factory: auth => {
@@ -207,3 +221,3 @@ return new auth.octokit.constructor(_objectSpread2(_objectSpread2({}, auth.octokitOptions), {}, {
             auth: _objectSpread2(_objectSpread2({}, auth), {}, {
-              installationId: event.payload.installation.id
+              installationId
             })
@@ -210,0 +224,0 @@ }));

dist-src/version.js

@@ -1,1 +0,1 @@
-export const VERSION = "10.1.0";
+export const VERSION = "10.1.1";

dist-src/webhooks.js

 import { createAppAuth } from "@octokit/auth-app";
+import { createUnauthenticatedAuth } from "@octokit/auth-unauthenticated";
 import { Webhooks } from "@octokit/webhooks";
@@ -8,5 +9,19 @@ export function webhooks(appOctokit, options) {
         transform: async (event) => {
+            if (!("installation" in event.payload) ||
+                typeof event.payload.installation !== "object") {
+                const octokit = new appOctokit.constructor({
+                    authStrategy: createUnauthenticatedAuth,
+                    auth: {
+                        reason: `"installation" key missing in webhook event payload`,
+                    },
+                });
+                return {
+                    ...event,
+                    octokit: octokit,
+                };
+            }
+            const installationId = event.payload.installation.id;
             const octokit = (await appOctokit.auth({
                 type: "installation",
-                installationId: event.payload.installation.id,
+                installationId,
                 factory: (auth) => {
@@ -19,3 +34,3 @@ return new auth.octokit.constructor({
                                 ...auth,
-                                installationId: event.payload.installation.id,
+                                installationId,
                             },
@@ -22,0 +37,0 @@ },

dist-types/version.d.ts

@@ -1,1 +0,1 @@
-export declare const VERSION = "10.1.0";
+export declare const VERSION = "10.1.1";

dist-types/webhooks.d.ts

 import { Octokit } from "@octokit/core";
-import { Webhooks, WebhookEvent } from "@octokit/webhooks";
+import { Webhooks } from "@octokit/webhooks";
 import { Options } from "./types";
-export declare function webhooks(appOctokit: Octokit, options: Required<Options>["webhooks"]): Webhooks<WebhookEvent<any>, {
-    octokit: InstanceType<typeof Octokit>;
+export declare function webhooks(appOctokit: Octokit, options: Required<Options>["webhooks"]): Webhooks<{
+    octokit: Octokit;
+    id: string;
+    name: "push";
+    payload: import("@octokit/webhooks-definitions/schema").PushEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "public";
+    payload: import("@octokit/webhooks-definitions/schema").PublicEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "label";
+    payload: import("@octokit/webhooks-definitions/schema").LabelEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "meta";
+    payload: import("@octokit/webhooks-definitions/schema").MetaDeletedEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "repository";
+    payload: import("@octokit/webhooks-definitions/schema").RepositoryEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "milestone";
+    payload: import("@octokit/webhooks-definitions/schema").MilestoneEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "member";
+    payload: import("@octokit/webhooks-definitions/schema").MemberEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "team";
+    payload: import("@octokit/webhooks-definitions/schema").TeamEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "installation";
+    payload: import("@octokit/webhooks-definitions/schema").InstallationEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "project";
+    payload: import("@octokit/webhooks-definitions/schema").ProjectEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "status";
+    payload: import("@octokit/webhooks-definitions/schema").StatusEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "deployment";
+    payload: import("@octokit/webhooks-definitions/schema").DeploymentCreatedEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "release";
+    payload: import("@octokit/webhooks-definitions/schema").ReleaseEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "organization";
+    payload: import("@octokit/webhooks-definitions/schema").OrganizationEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "pull_request";
+    payload: import("@octokit/webhooks-definitions/schema").PullRequestEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "delete";
+    payload: import("@octokit/webhooks-definitions/schema").DeleteEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "fork";
+    payload: import("@octokit/webhooks-definitions/schema").ForkEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "ping";
+    payload: import("@octokit/webhooks-definitions/schema").PingEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "create";
+    payload: import("@octokit/webhooks-definitions/schema").CreateEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "check_run";
+    payload: import("@octokit/webhooks-definitions/schema").CheckRunEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "check_suite";
+    payload: import("@octokit/webhooks-definitions/schema").CheckSuiteEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "code_scanning_alert";
+    payload: import("@octokit/webhooks-definitions/schema").CodeScanningAlertEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "commit_comment";
+    payload: import("@octokit/webhooks-definitions/schema").CommitCommentCreatedEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "content_reference";
+    payload: import("@octokit/webhooks-definitions/schema").ContentReferenceCreatedEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "deploy_key";
+    payload: import("@octokit/webhooks-definitions/schema").DeployKeyEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "deployment_status";
+    payload: import("@octokit/webhooks-definitions/schema").DeploymentStatusCreatedEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "github_app_authorization";
+    payload: import("@octokit/webhooks-definitions/schema").GithubAppAuthorizationRevokedEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "gollum";
+    payload: import("@octokit/webhooks-definitions/schema").GollumEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "installation_repositories";
+    payload: import("@octokit/webhooks-definitions/schema").InstallationRepositoriesEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "issue_comment";
+    payload: import("@octokit/webhooks-definitions/schema").IssueCommentEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "issues";
+    payload: import("@octokit/webhooks-definitions/schema").IssuesEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "marketplace_purchase";
+    payload: import("@octokit/webhooks-definitions/schema").MarketplacePurchaseEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "membership";
+    payload: import("@octokit/webhooks-definitions/schema").MembershipEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "org_block";
+    payload: import("@octokit/webhooks-definitions/schema").OrgBlockEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "package";
+    payload: import("@octokit/webhooks-definitions/schema").PackageEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "page_build";
+    payload: import("@octokit/webhooks-definitions/schema").PageBuildEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "project_card";
+    payload: import("@octokit/webhooks-definitions/schema").ProjectCardEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "project_column";
+    payload: import("@octokit/webhooks-definitions/schema").ProjectColumnEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "pull_request_review";
+    payload: import("@octokit/webhooks-definitions/schema").PullRequestReviewEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "pull_request_review_comment";
+    payload: import("@octokit/webhooks-definitions/schema").PullRequestReviewCommentEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "repository_dispatch";
+    payload: import("@octokit/webhooks-definitions/schema").RepositoryDispatchOnDemandTestEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "repository_import";
+    payload: import("@octokit/webhooks-definitions/schema").RepositoryImportEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "repository_vulnerability_alert";
+    payload: import("@octokit/webhooks-definitions/schema").RepositoryVulnerabilityAlertEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "secret_scanning_alert";
+    payload: import("@octokit/webhooks-definitions/schema").SecretScanningAlertEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "security_advisory";
+    payload: import("@octokit/webhooks-definitions/schema").SecurityAdvisoryEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "sponsorship";
+    payload: import("@octokit/webhooks-definitions/schema").SponsorshipEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "star";
+    payload: import("@octokit/webhooks-definitions/schema").StarEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "team_add";
+    payload: import("@octokit/webhooks-definitions/schema").TeamAddEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "watch";
+    payload: import("@octokit/webhooks-definitions/schema").WatchStartedEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "workflow_dispatch";
+    payload: import("@octokit/webhooks-definitions/schema").WorkflowDispatchEvent;
+} | {
+    octokit: Octokit;
+    id: string;
+    name: "workflow_run";
+    payload: import("@octokit/webhooks-definitions/schema").WorkflowRunEvent;
 }>;

package.json

 {
   "name": "@octokit/app",
   "description": "GitHub Apps toolset for Node.js",
-  "version": "10.1.0",
+  "version": "10.1.1",
   "license": "MIT",
@@ -15,2 +15,3 @@ "files": [
     "@octokit/auth-app": "^2.10.0",
+    "@octokit/auth-unauthenticated": "^2.0.4",
     "@octokit/core": "^3.2.0",
@@ -20,3 +21,3 @@ "@octokit/oauth-app": "^2.0.1",
     "@octokit/types": "^6.0.3",
-    "@octokit/webhooks": "^7.15.1"
+    "@octokit/webhooks": "^8.0.2"
   },
@@ -23,0 +24,0 @@ "devDependencies": {

README.md

@@ -70,3 +70,3 @@ # app.js
 const { data } = await app.octokit.request("/app");
-console.log("authenticated as %s", response.data.name);
+console.log("authenticated as %s", data.name);
 
@@ -73,0 +73,0 @@ for await (const { octokit, repository } of app.eachRepository.iterator()) {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

73517

increased by15.02%

Lines of code

1271

increased by28.38%

Worsened metrics

Dependency count

7

increased by16.67%

Dependency changes

• + Added@octokit/auth-unauthenticated@^2.0.4

• + Added@octokit/webhooks@8.12.3(transitive)

• + Added@octokit/webhooks-definitions@3.67.3(transitive)

• - Removed@octokit/webhooks@7.24.3(transitive)

• Updated@octokit/webhooks@^8.0.2