Merge pull request #19 from trunges21/master

Change type login and register

.github/workflows/run-tests.yml

@@ -1,21 +1,21 @@
 name: run-tests
 
 on:
-  push: 
-    branches: [master]
-  pull_request: 
-    branches: [master]
+    push:
+        branches: [master]
+    pull_request:
+        branches: [master]
 
 jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Node.js
+    test:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - name: Set up Node.js
 
-        uses: actions/setup-node@v4
-      - name: Install dependencies
-        run: npm install # `npm ci` (won't work lock files are .gitignored)
+              uses: actions/setup-node@v4
+            - name: Install dependencies
+              run: npm install # `npm ci` (won't work lock files are .gitignored)
 
-      - name: Run tests
-        run: npm test
+            - name: Run tests
+              run: npm test

dist/ApiClient.d.ts

@@ -80,24 +80,24 @@ export declare const COLLECTION_FORMATS: {
     tsv: string;
     pipes: string;
 };
-export declare type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
-export declare type Json = any;
-export declare type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
-export declare type HTTPHeaders = {
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
     [key: string]: string;
 };
-export declare type HTTPQuery = {
+export type HTTPQuery = {
     [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
 };
-export declare type HTTPBody = Json | FormData | URLSearchParams;
-export declare type HTTPRequestInit = {
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
     headers?: HTTPHeaders;
     method: HTTPMethod;
     credentials?: RequestCredentials_;
     body?: HTTPBody;
 };
-export declare type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
-export declare type InitOverrideFunction = (requestContext: {
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export type InitOverrideFunction = (requestContext: {
     init: HTTPRequestInit;
     context: RequestOpts;
 }) => Promise<RequestInit>;

dist/SDK/KindeSDK.d.ts

@@ -12,7 +12,7 @@
  */
 import * as runtime from '../ApiClient';
 import { AuthBrowserOptions } from '../types/Auth';
-import { AdditionalParameters, FeatureFlag, OptionalFlag, OrgAdditionalParams, TokenResponse } from '../types/KindeSDK';
+import { AdditionalParameters, FeatureFlag, LoginAdditionalParameters, OptionalFlag, OrgAdditionalParams, RegisterAdditionalParameters, TokenResponse } from '../types/KindeSDK';
 import { TokenType } from './Enums';
 /**
  * The KindeSDK module.
@@ -44,11 +44,11 @@ declare class KindeSDK extends runtime.BaseAPI {
     /**
      * The function takes an object as an argument, and if the object is empty, it will use the default
      * object
-     * @param {AdditionalParameters} additionalParameters - AdditionalParameters = {}
+     * @param {AdditionalParameters} additionalParameters - LoginAdditionalParameters = {}
      * @param {AuthBrowserOptions} [authBrowserOptions] - Authentication browser options.
      * @returns A promise that resolves to void.
      */
-    login(additionalParameters?: Omit<OrgAdditionalParams, 'is_create_org'>, authBrowserOptions?: AuthBrowserOptions): Promise<TokenResponse | null>;
+    login(additionalParameters?: LoginAdditionalParameters, authBrowserOptions?: AuthBrowserOptions): Promise<TokenResponse | null>;
     /**
      * This function registers an organization with additional parameters and authenticates it using an
      * authorization code.
@@ -59,7 +59,7 @@ declare class KindeSDK extends runtime.BaseAPI {
      * @param {AuthBrowserOptions} [authBrowserOptions] - Authentication browser options.
      * @returns A Promise that resolves to void.
      */
-    register(additionalParameters?: OrgAdditionalParams, authBrowserOptions?: AuthBrowserOptions): Promise<TokenResponse | null>;
+    register(additionalParameters?: RegisterAdditionalParameters, authBrowserOptions?: AuthBrowserOptions): Promise<TokenResponse | null>;
     /**
      * This function creates an organization with additional parameters.
      * @param additionalParameters

dist/types/Auth.d.ts

@@ -1,3 +1,3 @@
 import { AuthSessionOpenOptions } from 'expo-web-browser';
 import { InAppBrowserOptions } from 'react-native-inappbrowser-reborn';
-export declare type AuthBrowserOptions = InAppBrowserOptions | AuthSessionOpenOptions;
+export type AuthBrowserOptions = InAppBrowserOptions | AuthSessionOpenOptions;

dist/types/KindeSDK.d.ts

@@ -15,29 +15,29 @@
  * @module SDK/Types
  * @version 1.2.0
  */
-export declare type AdditionalParameters = {
+export type AdditionalParameters = {
     audience?: string;
     is_create_org?: boolean;
     org_code?: string;
     org_name?: string;
 };
-export declare type OrgAdditionalParams = Omit<AdditionalParameters, 'audience'>;
-export declare type UserProfile = {
+export type OrgAdditionalParams = Omit<AdditionalParameters, 'audience'>;
+export type UserProfile = {
     id: string;
     given_name: string;
     family_name: string;
     email: string;
     picture: string;
 };
-export declare type TokenResponse = {
+export type TokenResponse = {
     access_token: string;
     refresh_token: string;
     id_token: string;
     scope: string;
     token_type: string;
     expires_in: number;
 };
-export declare type AccessTokenDecoded = {
+export type AccessTokenDecoded = {
     aud: string[];
     azp: string;
     exp: number;
@@ -47,19 +47,25 @@ export declare type AccessTokenDecoded = {
     gty?: string[];
     scp?: string[];
 } & Record<string, any>;
-export declare type IdTokenDecoded = {
+export type IdTokenDecoded = {
     sub: string;
     given_name: string;
     family_name: string;
     email: string;
     picture: string;
 } & Record<string, any>;
-export declare type OptionalFlag = {
+export type OptionalFlag = {
     defaultValue?: string | boolean | number;
 };
-export declare type FeatureFlagType = 's' | 'b' | 'i';
-export declare type FeatureFlagValue = string | boolean | number;
-export declare type FeatureFlag = {
+export type FeatureFlagType = 's' | 'b' | 'i';
+export type FeatureFlagValue = string | boolean | number;
+export type FeatureFlag = {
     v?: FeatureFlagValue;
     t?: FeatureFlagType;
 };
+export type LoginAdditionalParameters = Omit<OrgAdditionalParams, 'is_create_org'> & {
+    [key: string]: unknown;
+};
+export type RegisterAdditionalParameters = OrgAdditionalParams & {
+    [key: string]: unknown;
+};

src/SDK/KindeSDK.ts

@@ -20,8 +20,10 @@ import { AuthBrowserOptions } from '../types/Auth';
 import {
     AdditionalParameters,
     FeatureFlag,
+    LoginAdditionalParameters,
     OptionalFlag,
     OrgAdditionalParams,
+    RegisterAdditionalParameters,
     TokenResponse
 } from '../types/KindeSDK';
 import { TokenType } from './Enums';
@@ -101,12 +103,12 @@ class KindeSDK extends runtime.BaseAPI {
     /**
      * The function takes an object as an argument, and if the object is empty, it will use the default
      * object
-     * @param {AdditionalParameters} additionalParameters - AdditionalParameters = {}
+     * @param {AdditionalParameters} additionalParameters - LoginAdditionalParameters = {}
      * @param {AuthBrowserOptions} [authBrowserOptions] - Authentication browser options.
      * @returns A promise that resolves to void.
      */
     async login(
-        additionalParameters: Omit<OrgAdditionalParams, 'is_create_org'> = {},
+        additionalParameters: LoginAdditionalParameters = {},
         authBrowserOptions?: AuthBrowserOptions
     ): Promise<TokenResponse | null> {
         checkAdditionalParameters(additionalParameters);
@@ -137,7 +139,7 @@ class KindeSDK extends runtime.BaseAPI {
      * @returns A Promise that resolves to void.
      */
     register(
-        additionalParameters: OrgAdditionalParams = {},
+        additionalParameters: RegisterAdditionalParameters = {},
         authBrowserOptions?: AuthBrowserOptions
     ): Promise<TokenResponse | null> {
         checkAdditionalParameters(additionalParameters);

src/SDK/Utils.ts

@@ -118,12 +118,10 @@ export const checkAdditionalParameters = (
             AdditionalParametersAllow
         ) as AdditionalParametersKeys[];
         for (const key of keyExists) {
-            if (!keysAllow.includes(key)) {
-                throw new UnexpectedException(key);
-            }
             if (
+                keysAllow.includes(key) &&
                 typeof additionalParameters[key] !==
-                AdditionalParametersAllow[key]
+                    AdditionalParametersAllow[key]
             ) {
                 throw new InvalidTypeException(
                     key,

src/types/KindeSDK.ts

@@ -74,3 +74,14 @@ export type FeatureFlag = {
     v?: FeatureFlagValue; // v -> value
     t?: FeatureFlagType; // t -> type, s -> string, b -> boolean, i -> integer
 };
+
+export type LoginAdditionalParameters = Omit<
+    OrgAdditionalParams,
+    'is_create_org'
+> & {
+    [key: string]: unknown;
+};
+
+export type RegisterAdditionalParameters = OrgAdditionalParams & {
+    [key: string]: unknown;
+};