@axinom/mosaic-user-auth-utils 0.8.1-rc.1 → 0.8.1-rc.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axinom/mosaic-user-auth-utils",
-  "version": "0.8.1-rc.1",
+  "version": "0.8.1-rc.10",
   "description": "Shared types used by user-service for integration clients",
   "author": "Axinom",
   "license": "PROPRIETARY",
@@ -10,7 +10,8 @@
     "axinom mosaic"
   ],
   "files": [
-    "dist"
+    "dist",
+    "src"
   ],
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -31,5 +32,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "2a0359d6b41b58dc05d2e0a3a1fa929c6712e251"
+  "gitHead": "3006785f98bc4177e940571365d4317c9c6e0f8e"
 }

package/src/common/constants.ts

@@ -0,0 +1,47 @@
+import { IdpProtocol } from './enums';
+
+export const managedIdProviderDefaults = {
+  AX_GOOGLE: {
+    discoveryDocumentUrl:
+      'https://accounts.google.com/.well-known/openid-configuration',
+    providerIconUrl: 'https://developers.google.com/identity/images/g-logo.png',
+    additionalParams: {
+      access_type: 'offline',
+    },
+    scopes: [
+      { name: 'openid', default: true },
+      { name: 'email', default: true },
+      { name: 'profile', default: true },
+    ],
+    protocol: IdpProtocol.OIDC,
+  },
+  AX_FACEBOOK: {
+    authorizationEndpointUrl: 'https://www.facebook.com/dialog/oauth',
+    tokenEndpointUrl: 'https://graph.facebook.com/oauth/access_token',
+    userInfoEndpointUrl: 'https://graph.facebook.com/me',
+    scopes: [{ name: 'email', default: true }],
+    protocol: IdpProtocol.OAUTH2,
+  },
+  AX_APPLE: {
+    discoveryDocumentUrl:
+      'https://appleid.apple.com/.well-known/openid-configuration',
+    additionalParams: {
+      response_mode: 'form_post',
+    },
+    scopes: [
+      { name: 'openid', default: true },
+      { name: 'email', default: true },
+      { name: 'name', default: true },
+    ],
+    protocol: IdpProtocol.OIDC,
+  },
+  AX_AUTH: {
+    scopes: [
+      { name: 'openid', default: true },
+      { name: 'email', default: true },
+      { name: 'profile', default: true },
+      { name: 'offline_access', default: true },
+    ],
+    protocol: IdpProtocol.OIDC,
+  },
+};

package/src/common/enums.ts

@@ -0,0 +1,126 @@
+/**
+ * This is the Error Type that the REST middleware will respond when there's an error
+ * from the User Service that does not belong to Token/SignOut or IDPConfiguration responses.
+ */
+export enum UserAuthErrorCode {
+  AUTH_FLOW_ERROR = 'AUTH_FLOW_ERROR',
+  IDP_CONFIGURATION_ERROR = 'IDP_CONFIGURATION_ERROR',
+  BAD_REQUEST = 'BAD_REQUEST',
+  ACCOUNT_NOT_ACTIVE = 'ACCOUNT_NOT_ACTIVE',
+  INVALID_USER = 'INVALID_USER',
+  INVALID_APPLICATION = 'INVALID_APPLICATION',
+  APPLICATION_NOT_ACTIVE = 'APPLICATION_NOT_ACTIVE',
+  INVALID_IDP_CONNECTION = 'INVALID_IDP_CONNECTION',
+  INTERNAL_SERVER_ERROR = 'INTERNAL_SERVER_ERROR',
+}
+
+/**
+ * Token response code from User Service Auth API
+ */
+export enum TokenResponseCode {
+  SUCCESS = 'SUCCESS',
+  NEEDS_LOGIN = 'NEEDS_LOGIN',
+  USER_NOT_FOUND = 'USER_NOT_FOUND',
+  ACCOUNT_NOT_ACTIVE = 'ACCOUNT_NOT_ACTIVE',
+  AUTH_FLOW_ERROR = 'AUTH_FLOW_ERROR',
+  BAD_REQUEST = 'BAD_REQUEST',
+  INTERNAL_SERVER_ERROR = 'INTERNAL_SERVER_ERROR',
+}
+
+/**
+ * Sign out response code from User Service Auth API
+ */
+export enum SignOutResponseCode {
+  SUCCESS = 'SUCCESS',
+  BAD_REQUEST = 'BAD_REQUEST',
+  INTERNAL_SERVER_ERROR = 'INTERNAL_SERVER_ERROR',
+}
+
+/**
+ * IDP Configuration response code from User Service Auth API
+ */
+export enum IdpConfigurationResponseCode {
+  SUCCESS = 'SUCCESS',
+  APPLICATION_NOT_ACTIVE = 'APPLICATION_NOT_ACTIVE',
+  NO_ACTIVE_IDPS = 'NO_ACTIVE_IDPS',
+  ACCOUNT_NOT_ACTIVE = 'ACCOUNT_NOT_ACTIVE',
+  BAD_REQUEST = 'BAD_REQUEST',
+  INTERNAL_SERVER_ERROR = 'INTERNAL_SERVER_ERROR',
+}
+
+/**
+ * Sign In With Credentials Response Code from User Service Auth API
+ */
+export enum SignInResponseCode {
+  SUCCESS = 'SUCCESS',
+  INTERNAL_SERVER_ERROR = 'INTERNAL_SERVER_ERROR',
+  AUTH_FLOW_ERROR = 'AUTH_FLOW_ERROR',
+  INVALID_CREDENTIALS = 'INVALID_CREDENTIALS',
+  SERVICE_CONFIGURATION_ERROR = 'SERVICE_CONFIGURATION_ERROR',
+  INVALID_IDP_CONNECTION = 'INVALID_IDP_CONNECTION',
+  APPLICATION_NOT_ACTIVE = 'APPLICATION_NOT_ACTIVE',
+}
+
+/**
+ * Sign In With Credentials Password Reset/Complete Password Reset Code from User Service Auth API
+ */
+export enum ResetPasswordResponseCode {
+  SUCCESS = 'SUCCESS',
+  ERROR = 'ERROR',
+  SERVICE_CONFIGURATION_ERROR = 'SERVICE_CONFIGURATION_ERROR',
+}
+
+/**
+ * Sign Up With Credential Response Code from User Service Auth API
+ */
+export enum UserSignUpResponseCode {
+  SUCCESS = 'SUCCESS',
+  ERROR = 'ERROR',
+  SERVICE_CONFIGURATION_ERROR = 'SERVICE_CONFIGURATION_ERROR',
+}
+
+/**
+ * Verify Sign Up With Credential Response Code from User Service Auth API
+ */
+export enum CompleteUserSignUpResponseCode {
+  SUCCESS = 'SUCCESS',
+  ERROR = 'ERROR',
+  SERVICE_CONFIGURATION_ERROR = 'SERVICE_CONFIGURATION_ERROR',
+}
+
+/**
+ * OTP Check Response Code from User Service Auth API
+ * This response type is used for both Sign Up OTP check and Reset Password OTP check.
+ */
+export enum CheckOtpResponseCode {
+  SUCCESS = 'SUCCESS',
+  ERROR = 'ERROR',
+  SERVICE_CONFIGURATION_ERROR = 'SERVICE_CONFIGURATION_ERROR',
+}
+
+/**
+ * IDP Protocol categories
+ */
+export enum IdpProtocol {
+  OIDC = 'OIDC',
+  OAUTH2 = 'OAUTH2',
+  DELEGATED = 'DELEGATED',
+}
+
+/**
+ * Response codes specific to Native Cookie Decryption.
+ */
+export enum DecryptNativeCookieResponseCode {
+  SUCCESS = 'SUCCESS',
+  COOKIE_DECRYPTION_FAILED = 'COOKIE_DECRYPTION_FAILED',
+}
+
+/**
+ * Response codes specific to End User Application Token Generation
+ */
+export enum AuthenticateEndUserApplicationResponseCode {
+  SUCCESS = 'SUCCESS',
+  APPLICATION_NOT_FOUND = 'APPLICATION_NOT_FOUND',
+  APPLICATION_NOT_ENABLED = 'APPLICATION_NOT_ENABLED',
+  END_USER_APP_TOKEN_GENERATION_ERROR = 'END_USER_APP_TOKEN_GENERATION_ERROR',
+}

package/src/common/types.ts

@@ -0,0 +1,159 @@
+import {
+  CheckOtpResponseCode,
+  CompleteUserSignUpResponseCode,
+  DecryptNativeCookieResponseCode,
+  IdpConfigurationResponseCode,
+  ResetPasswordResponseCode,
+  SignInResponseCode,
+  SignOutResponseCode,
+  TokenResponseCode,
+  UserSignUpResponseCode,
+} from './enums';
+
+/**
+ * Represents a user token
+ */
+export interface UserToken {
+  accessToken: string;
+  expiresInSeconds: number;
+  expiresAt: Date;
+}
+
+/**
+ * Represents an authenticated user
+ */
+export interface User {
+  id: string;
+  name: string | null;
+  email: string | null;
+  profileId: string;
+  token: UserToken;
+}
+
+/**
+ * Token response from User Service Auth API
+ */
+export interface TokenResponse {
+  code: TokenResponseCode;
+  message?: string;
+  tenantId?: string;
+  environmentId?: string;
+  applicationId?: string;
+  extensions?: unknown;
+  user?: User;
+}
+
+/**
+ * Sign out response from User Service Auth API
+ */
+export interface SignOutResponse {
+  code: SignOutResponseCode;
+  message?: string;
+}
+
+/**
+ * Represents an IDP Configuration
+ */
+export interface IdpConfiguration {
+  idpConnectionId: string;
+  providerId: string;
+  clientId: string;
+  providerIconUrl: string | null;
+  title: string;
+  sortOrder: number | null;
+}
+
+/**
+ * IDP Configuration response from User Service Auth API
+ */
+export interface IdpConfigurationResponse {
+  code: IdpConfigurationResponseCode;
+  message?: string;
+  tenantId?: string;
+  environmentId?: string;
+  applicationId?: string;
+  availableIdentityProviders?: IdpConfiguration[];
+}
+
+/**
+ * The well known endpoints exposed by ax-user-service.
+ */
+export interface WellKnownEndpointResponse {
+  jwks: string;
+  userServiceAdminGQL: string;
+  userServiceEndUserGQL: string;
+  axAuthManagementGQL: string;
+  axAuthEndpoint: string;
+}
+
+/**
+ * Response for a SignInWithCredentials flow.
+ */
+export interface SignInResponse {
+  code: SignInResponseCode;
+  message?: string;
+  details?: Record<string, unknown>;
+}
+
+/**
+ * Represents the response for a User Sign Up request.
+ */
+export interface UserSignUpResponse {
+  code: UserSignUpResponseCode;
+  idpUserId?: string;
+  message?: string;
+}
+
+/**
+ * Represents the response for a Complete User Sign Up request.
+ */
+export interface CompleteUserSignUpResponse {
+  code: CompleteUserSignUpResponseCode;
+  idpUserId?: string;
+  message?: string;
+}
+
+/**
+ * Represents the response for InitiatePasswordReset request.
+ */
+export interface InitiatePasswordResetResponse {
+  code: ResetPasswordResponseCode;
+  message?: string;
+  details?: Record<string, unknown>;
+}
+
+/**
+ * Represents the response for a CompletePasswordReset request.
+ */
+export interface CompletePasswordResetResponse {
+  code: ResetPasswordResponseCode;
+  message?: string;
+  details?: Record<string, unknown>;
+}
+
+/**
+ * Represents the response for a Check Password Reset OTP Request
+ */
+export interface CheckPasswordResetOtpResponse {
+  code: CheckOtpResponseCode;
+  message?: string;
+  isOtpValid?: boolean;
+}
+
+/**
+ * Represents the response for a User Sign Up OTP Request
+ */
+export interface CheckUserSignUpOtpResponse {
+  code: CheckOtpResponseCode;
+  message?: string;
+  isOtpValid?: boolean;
+}
+
+/**
+ * Represents the response for a Native Cookie Decrypt Response
+ */
+export interface DecryptNativeCookieResponse {
+  code: DecryptNativeCookieResponseCode;
+  message?: string;
+  decryptedCookie?: string;
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './common/constants';
+export * from './common/enums';
+export * from './common/types';