🔥 feat: Remove password grant_type (#159)

* 🔥 feat: Remove password grant_type

* 📝 feat: Update docs

Author: enZane

packages/drupal-auth-client/README.md

@@ -9,37 +9,16 @@ Make sure your Drupal site is using the [simple_oauth](https://www.drupal.org/pr
 ### Importing library
 
 ```javascript
-import { drupalAuthClient } from "drupal-auth-client"
+import { drupalAuthClient } from "drupal-auth-client";
 ```
 
 ### Using `client_credentials`
 
 ```javascript
-
-const client = drupalAuthClient(
-  "https://drupal.site",
-  "client_credentials",
-  {
-    clientId: "client_id",
-    clientSecret: "client_secret",
-  },
-)
-```
-
-### Using `password`
-
-```javascript
-
-const client = drupalAuthClient(
-  "https://drupal.site",
-  "password",
-  {
-    username: "username",
-    password: "password",
-    clientId: "client_id",
-    clientSecret: "client_secret",
-  },
-)
+const client = drupalAuthClient("https://drupal.site", {
+  clientId: "client_id",
+  clientSecret: "client_secret",
+});
 ```
 
 ## Supporting organizations

packages/drupal-auth-client/package.json

@@ -1,15 +1,14 @@
 {
   "name": "drupal-auth-client",
-  "version": "0.4.0",
+  "version": "1.0.0",
   "description": "Drupal Auth Client",
   "keywords": [
     "auth",
     "drupal"
   ],
   "main": "dist/index.js",
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "bundlesize": [
     {
@@ -29,4 +28,4 @@
     "@types/node": "^20.12.12",
     "typescript": "^5.4.5"
   }
-}
+}

packages/drupal-auth-client/src/authHandlers.ts

@@ -4,7 +4,7 @@ export const clientCredentialsHeader = async (
   authUri: string,
   clientId: string,
   clientSecret: string,
-  fetcher: Config["fetcher"],
+  fetcher: Config["fetcher"]
 ) => {
   const formData = new FormData();
   formData.append("grant_type", "client_credentials");
@@ -20,37 +20,7 @@ export const clientCredentialsHeader = async (
   });
 
   if (response.ok) {
-    return await response.json() as OAuthPayload;
-  }
-
-  return null;
-};
-
-export const passwordHeader = async (
-  authUri: string,
-  username: string,
-  password: string,
-  clientId: string,
-  clientSecret: string,
-  fetcher: Config["fetcher"],
-) => {
-  const formData = new FormData();
-  formData.append("grant_type", "password");
-  formData.append("client_id", clientId);
-  formData.append("client_secret", clientSecret);
-  formData.append("username", username);
-  formData.append("password", password);
-
-  const response = await fetcher(authUri, {
-    method: "post",
-    headers: {
-      Accept: "application/json",
-    },
-    body: formData,
-  });
-
-  if (response.ok) {
-    return await response.json() as OAuthPayload;
+    return (await response.json()) as OAuthPayload;
   }
 
   return null;

packages/drupal-auth-client/src/index.ts

@@ -1,87 +1,43 @@
-import { clientCredentialsHeader, passwordHeader } from "./authHandlers";
-import type { Auth, Config, Options } from "./types";
+import { clientCredentialsHeader } from "./authHandlers";
+import type { Config, Options } from "./types";
 
-const calculateAuthHeader = async <TAuth extends Auth["token_type"]>(
+const calculateAuthHeader = async (
   uri: string,
-  type: TAuth,
-  options: Options<TAuth>,
+  options: Options,
   fetcher: Config["fetcher"]
 ) => {
-  if (type === "client_credentials") {
-    const { clientId, clientSecret} =
-      options as Options<"client_credentials">;
-    const header = await clientCredentialsHeader(
-      uri,
-      clientId,
-      clientSecret,
-      fetcher,
-    );
-
-    if (header) {
-      return header;
-    }
-  }
-
-  if (type === "password") {
-    const { username, password, clientId, clientSecret } =
-      options as Options<"password">;
-    const header = await passwordHeader(
-      uri,
-      username,
-      password,
-      clientId,
-      clientSecret,
-      fetcher,
-    );
+  const { clientId, clientSecret } = options;
+  const header = await clientCredentialsHeader(
+    uri,
+    clientId,
+    clientSecret,
+    fetcher
+  );
 
-    if (header) {
-      return header;
-    }
+  if (header) {
+    return header;
   }
-
-  return null;
 };
 
 /**
  * Return headers based on the given auth and config
  * @param uri The uri of the drupal site
- * @param auth The auth strategy to use
  * @param options {Config} The auth options
  * @param config The config for the client
  *
  * The type for the options is decided by the auth type
  * @example
  * const client = drupalAuthClient(
  *  "https://drupal.site",
- * "client_credentials",
  *  {
  *    clientId: "client_id",
  *    clientSecret: "client_secret",
  *  },
  * );
- *
- * In the above example, you only need to provide the clientId and clientSecret
- * because the auth type is "client_credentials" but if you set the auth type to
- * "password" you would need to provide the username and password as well.
- *
- * @example
- * const client = drupalAuthClient(
- *  "https://drupal.site",
- *  "password",
- *  {
- *    username: "username",
- *    password: "password",
- *    clientId: "client_id",
- *    clientSecret: "client_secret",
- *   }
- * );
- *
- *
  **/
-const drupalAuthClient = async <TAuth extends Auth["token_type"]>(
+const drupalAuthClient = async (
   uri: string,
-  type: TAuth,
-  options: Options<TAuth>,
+  options: Options,
   config: Config = {
     fetcher: fetch,
   }
@@ -91,12 +47,7 @@ const drupalAuthClient = async <TAuth extends Auth["token_type"]>(
   const url = new URL(uri);
   const formattedAuthURI = authURI ? authURI : `${url.origin}/oauth/token`;
 
-  const header = await calculateAuthHeader(
-    formattedAuthURI,
-    type,
-    options,
-    fetcher
-  )
+  const header = await calculateAuthHeader(formattedAuthURI, options, fetcher);
 
   if (!header) {
     throw new Error("Unable to fetch auth header");
@@ -106,8 +57,3 @@ const drupalAuthClient = async <TAuth extends Auth["token_type"]>(
 };
 
 export { drupalAuthClient };
-
-/**
- * @deprecated
- */
-export default drupalAuthClient;

packages/drupal-auth-client/src/types.ts

@@ -1,30 +1,16 @@
-type ClientOptions = {
+export type Options = {
   clientId: string;
   clientSecret: string;
 };
 
 type ClientCredentialsOAuth = {
-  token_type: "client_credentials";
-  options: ClientOptions;
+  options: Options;
 };
 
-type PasswordOAuth = {
-  token_type: "password";
-  options: {
-    username: string;
-    password: string;
-  } & ClientOptions;
-};
-
-export type Auth = ClientCredentialsOAuth | PasswordOAuth;
-
-export type Options<TConfig extends Auth["token_type"]> = Extract<
-  Auth,
-  { token_type: TConfig }
->["options"];
+export type Auth = ClientCredentialsOAuth;
 
 export type Config = {
-  fetcher: any;
+  fetcher: typeof fetch;
   authURI?: string;
 };