@types/npm-profile - npm Package Compare versions

Comparing version 5.0.1 to 5.0.2

npm-profile/index.d.ts

@@ -43,2 +43,43 @@ // Type definitions for npm-profile 5.0
 
+/**
+ * Creates a new user on the server along with a fresh bearer token for future authentication as this user.
+ * This is what you see as an authToken in an .npmrc.
+ * @async
+ */
+export function adduser(opener: (url: string) => Promise<void>, prompter: (creds: ProfileAuthCredentials) => Promise<ProfileAuthCredentials>, opts?: Options): Promise<ProfileAuthToken>;
+
+/**
+ * Tries to login using new web based login, if that fails it falls back to using the legacy CouchDB APIs.
+ * @async
+ */
+export function login(opener: (url: string) => Promise<void>, prompter: (creds: ProfileAuthCredentials) => Promise<ProfileAuthCredentials>, opts?: Options): Promise<ProfileAuthToken>;
+
+/**
+ * Tries to login using new web based login, if that fails it falls back to using the legacy CouchDB APIs.
+ * @async
+ */
+export function loginWeb(opener: (url: string) => Promise<void>, opts?: Options): Promise<ProfileAuthToken>;
+
+/**
+ * Tries to create a user new web based login,
+ * if that fails it falls back to using the legacy CouchDB APIs.
+ * @async
+ */
+export function adduserWeb(opener: (url: string) => Promise<void>, opts?: Options): Promise<ProfileAuthToken>;
+
+/**
+ * Creates a new user on the server along with a fresh bearer token for future authentication as this user.
+ * This is what you see as an authToken in an .npmrc.
+ * @async
+ */
+export function adduserCouch(username: string, email: string, password: string, opts?: Options): Promise<ProfileAuthToken>;
+
+/**
+ * Logs you into an existing user. Does not create the user if they do not already exist.
+ * Logging in means generating a new bearer token for use in future authentication.
+ * This is what you use as an authToken in an .npmrc.
+ * @async
+ */
+export function loginCouch(username: string, email: string, password: string, opts?: Options): Promise<ProfileAuthToken>;
+
 export type Options = fetch.Options & ProfileFetchOptions;
@@ -67,2 +108,20 @@
 
+export interface ProfileAuthCredentials extends ProfileCredentials {
+    /**
+     * default value for password
+     */
+    password: string;
+}
+
+export interface ProfileAuthToken {
+    /**
+     * String, to be used to authenticate further API calls.
+     */
+    token: string;
+    /**
+     * String, the username the user authenticated as.
+     */
+    username: string;
+}
+
 export interface ProfileData {
@@ -107,5 +166,5 @@ /**
     | {
-          pending: boolean;
-          [key: string]: any;
-      }
+        pending: boolean;
+        [key: string]: any;
+    }
     | [string, string]
@@ -112,0 +171,0 @@ | string;

npm-profile/package.json

 {
     "name": "@types/npm-profile",
-    "version": "5.0.1",
+    "version": "5.0.2",
     "description": "TypeScript definitions for npm-profile",
@@ -25,4 +25,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/npm-profile",
     },
-    "typesPublisherContentHash": "5431ae7d0388a2aba411d788279e420cbbb304c8641d19ac590cb5b052b8bba3",
-    "typeScriptVersion": "3.6"
+    "typesPublisherContentHash": "9ebf3dfa4adc3ac96a58db22a9f3fc24f0cc2f5b13a22b00c4228320e734b63c",
+    "typeScriptVersion": "4.0"
 }

npm-profile/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Thu, 08 Jul 2021 18:51:39 GMT
+ * Last updated: Tue, 02 Aug 2022 08:02:24 GMT
  * Dependencies: [@types/npm-registry-fetch](https://npmjs.com/package/@types/npm-registry-fetch)
@@ -14,0 +14,0 @@ * Global values: none

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9140

31.59%

Lines of code

197

34.93%

No dependency changes