@octokit/auth-oauth-app - npm Package Compare versions

Comparing version 2.1.0 to 2.2.0

dist-node/index.js

@@ -113,3 +113,3 @@ 'use strict';
 
-const VERSION = "2.1.0";
+const VERSION = "2.2.0";
 
@@ -116,0 +116,0 @@ function createOAuthAppAuth(options) {

dist-src/version.js

@@ -1,1 +0,1 @@
-export const VERSION = "2.1.0";
+export const VERSION = "2.2.0";

dist-types/auth.d.ts

@@ -1,30 +0,2 @@
-import { State, AuthOptions } from "./types";
-export declare function auth(state: State, authOptions: AuthOptions): Promise<{
-    type: string;
-    token: string;
-    tokenType: string;
-    scopes: string[];
-    clientId?: undefined;
-    clientSecret?: undefined;
-    headers?: undefined;
-    query?: undefined;
-} | {
-    type: string;
-    clientId: string;
-    clientSecret: string;
-    headers: {
-        authorization: string;
-    } | {
-        authorization?: undefined;
-    };
-    query: {
-        client_id?: undefined;
-        client_secret?: undefined;
-    } | {
-        client_id: string;
-        client_secret: string;
-    };
-    token?: undefined;
-    tokenType?: undefined;
-    scopes?: undefined;
-}>;
+import { State, AuthOptions, Authentication } from "./types";
+export declare function auth(state: State, authOptions: AuthOptions): Promise<Authentication>;

dist-types/index.d.ts

@@ -1,32 +0,9 @@
-import { StrategyOptions } from "./types";
-export declare function createOAuthAppAuth(options: StrategyOptions): ((authOptions: import("./types").AuthOptions) => Promise<{
-    type: string;
-    token: string;
-    tokenType: string;
-    scopes: string[];
-    clientId?: undefined;
-    clientSecret?: undefined;
-    headers?: undefined;
-    query?: undefined;
-} | {
-    type: string;
-    clientId: string;
-    clientSecret: string;
-    headers: {
-        authorization: string;
-    } | {
-        authorization?: undefined;
-    };
-    query: {
-        client_id?: undefined;
-        client_secret?: undefined;
-    } | {
-        client_id: string;
-        client_secret: string;
-    };
-    token?: undefined;
-    tokenType?: undefined;
-    scopes?: undefined;
-}>) & {
+import { StrategyOptions, AuthOptions, Authentication } from "./types";
+export declare type Types = {
+    StrategyOptions: StrategyOptions;
+    AuthOptions: AuthOptions;
+    Authentication: Authentication;
+};
+export declare function createOAuthAppAuth(options: StrategyOptions): ((authOptions: AuthOptions) => Promise<Authentication>) & {
     hook: (request: import("@octokit/types").RequestInterface, route: string | import("@octokit/types").EndpointOptions, parameters?: import("@octokit/types").RequestParameters | undefined) => Promise<import("@octokit/types").OctokitResponse<any>>;
 };

dist-types/types.d.ts

@@ -8,2 +8,3 @@ import * as OctokitTypes from "@octokit/types";
 export declare type RequestInterface = OctokitTypes.RequestInterface;
+export declare type StrategyInterface = OctokitTypes.StrategyInterface<[StrategyOptions], [AuthOptions], Authentication>;
 export declare type StrategyOptions = {
@@ -28,2 +29,19 @@ clientId: string;
 };
+export declare type TokenAuthentication = TokenWithScopes & {
+    type: "token";
+    tokenType: "oauth";
+};
+export declare type appAuthentication = {
+    type: "oauth-app";
+    clientId: string;
+    clientSecret: string;
+    headers: {
+        authorization?: string;
+    };
+    query: {
+        client_id?: string;
+        client_secret?: string;
+    };
+};
+export declare type Authentication = TokenAuthentication | appAuthentication;
 export declare type State = StrategyOptions & {
@@ -30,0 +48,0 @@ request: RequestInterface;

dist-types/version.d.ts

@@ -1,1 +0,1 @@
-export declare const VERSION = "2.1.0";
+export declare const VERSION = "2.2.0";

dist-web/index.js

@@ -104,3 +104,3 @@ import { getUserAgent } from 'universal-user-agent';
 
-const VERSION = "2.1.0";
+const VERSION = "2.2.0";
 
@@ -107,0 +107,0 @@ function createOAuthAppAuth(options) {

package.json

 {
   "name": "@octokit/auth-oauth-app",
   "description": "GitHub OAuth App authentication for JavaScript",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "license": "MIT",
@@ -26,3 +26,3 @@ "files": [
     "@octokit/request": "^5.3.0",
-    "@octokit/types": "^1.0.0",
+    "@octokit/types": "^2.0.0",
     "@types/btoa-lite": "^1.0.0",
@@ -52,3 +52,3 @@ "btoa-lite": "^1.0.0",
   "main": "dist-node/index.js",
-  "deno": "dist-web/index.js"
+  "module": "dist-web/index.js"
 }

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

Worsened metrics

Total package byte prevSize

49699

decreased by-0.84%

Lines of code

408

decreased by-7.48%

Dependency changes

• + Added@octokit/types@2.16.2(transitive)

• + Added@types/node@22.9.0(transitive)

• + Addedundici-types@6.19.8(transitive)

• - Removed@octokit/types@1.1.0(transitive)

• - Removed@types/node@12.20.55(transitive)

• Updated@octokit/types@^2.0.0