@extrahorizon/javascript-sdk 8.2.0-test

package/build/types/parseStoredCredentials.d.ts

@@ -0,0 +1,11 @@
+import { decodeType } from 'typescript-json-decoder';
+export declare type ExHCredentials = decodeType<typeof exhCredentialsDecoder>;
+declare const exhCredentialsDecoder: import("typescript-json-decoder").DecoderFunction<{
+    API_HOST?: string;
+    API_OAUTH_CONSUMER_KEY?: string;
+    API_OAUTH_CONSUMER_SECRET?: string;
+    API_OAUTH_TOKEN?: string;
+    API_OAUTH_TOKEN_SECRET?: string;
+}>;
+export declare const parseStoredCredentials: (fileContent: string) => ExHCredentials;
+export {};

package/build/types/rql/index.d.ts

@@ -0,0 +1,16 @@
+import { RqlBuilderFactory, RQLString } from './types';
+export * from './types';
+/**
+ * rqlParser accepts a regular string and returns a valid RQLString if it's valid.
+ * @see https://developers.extrahorizon.io/guide/rql.html
+ * @returns {RQLString}
+ * @throws {URIError}
+ * @throws {Error}
+ */
+export declare function rqlParser(rql: string): RQLString;
+/**
+ * RQL is a Resource Query Language designed for use in URIs with object data structures. RQL can be thought as basically a set of nestable named operators which each have a set of arguments written in a query string.
+ * @see https://developers.extrahorizon.io/guide/rql.html
+ * @returns
+ */
+export declare const rqlBuilder: RqlBuilderFactory;

package/build/types/rql/parser.d.ts

@@ -0,0 +1 @@
+export default function parse(query?: any, parameters?: any): any;

package/build/types/rql/types.d.ts

@@ -0,0 +1,168 @@
+declare type NotAnRQLStringError = 'Please use rqlBuilder to construct valid RQL. See README for an example.';
+declare type RQLCheck<T> = T extends any ? NotAnRQLStringError : T;
+export declare type RQLString = RQLCheck<string>;
+declare type RQLBuilderString = RQLString | string;
+export declare type RQLBuilderOptions = {
+    doubleEncodeValues?: boolean;
+    rql?: RQLBuilderString;
+};
+export declare type RQLBuilderInput = RQLBuilderString | RQLBuilderOptions;
+export interface RqlBuilderFactory {
+    /**
+     * @deprecated this property is only meant to be used for backwards compatibility when upgrading to v8.0.0
+     *
+     * **Previous behaviour:**
+     * - RQL values could be provided as double encoded to an rql builder
+     * - `rqlBuilder.doubleEncodeValues` could be set to `true` to enable double encoding of values for all rql builders
+     * - `rqlBuilder({ doubleEncodeValues: true })...` could enable automatic double encoding of values for an rql builder
+     *
+     *
+     * **New behaviour:**
+     * - RQL values are automatically double encoded when using an rql builder
+     *
+     * **How to upgrade to 8.0.0:**
+     * - Update any RQL values to no longer be encoded manually or using methods such as `encodeURIComponent()`
+     * - old value: 'Hypertension%2520%252D%2520STAGE%25201'
+     * - new value: 'Hypertension - STAGE 1'
+     *
+     * **Alternatively**:
+     * - `rqlBuilder.doubleEncodeValues` can be set to `false` to disable double encoding of values for all rql builders
+     * - `rqlBuilder({ doubleEncodeValues: true })...` enables automatic double encoding of values for an rql builder
+     *
+     */
+    doubleEncodeValues?: boolean;
+    (input?: RQLBuilderInput): RQLBuilder;
+}
+export interface RQLBuilder {
+    /**
+     * Trims each object down to the set of properties defined in the arguments
+     * - Only return field1 and field2 from the records: select(field1, field2)
+     */
+    select: (fields: string | string[]) => RQLBuilder;
+    /**
+     * - Only return 1 record: limit(1)
+     * - Only return 10 records and skip the first 50: limit(10, 50)
+     */
+    limit: (limit: number, offset?: number) => RQLBuilder;
+    /**
+     * Sorts by the given property in order specified by the prefix
+     * - \+ for ascending
+     * - \- for descending
+     */
+    sort: (fields: string | string[]) => RQLBuilder;
+    /**
+     * Filters for objects where the specified property's value is not in the provided array
+     */
+    out: (field: string, values: string[]) => RQLBuilder;
+    /**
+     * Filters for objects where the specified property's value is in the provided array
+     */
+    in: (field: string, values: string[]) => RQLBuilder;
+    /**
+     * Filters for objects where the specified property's value is greater than or equal to the provided value
+     */
+    ge: (field: string, value: string) => RQLBuilder;
+    /**
+     * Filters for objects where the specified property's value is equal to the provided value
+     */
+    eq: (field: string, value: string) => RQLBuilder;
+    /**
+     * Filters for objects where the specified property's value is less than or equal to the provided value
+     */
+    le: (field: string, value: string) => RQLBuilder;
+    /**
+     * Filters for objects where the specified property's value is not equal to the provided value
+     */
+    ne: (field: string, value: string) => RQLBuilder;
+    /**
+     * Filters for objects where the specified string field contains the substring provided in the value.
+     */
+    like: (field: string, value: string) => RQLBuilder;
+    /**
+     * Filters for objects where the specified property's value is less than the provided value
+     */
+    lt: (field: string, value: string) => RQLBuilder;
+    /**
+     * Filters for objects where the specified property's value is greater than the provided value
+     */
+    gt: (field: string, value: string) => RQLBuilder;
+    /**
+     * Allows combining results of 2 or more queries with the logical AND operator.
+     */
+    and: (...conditions: RQLString[]) => RQLBuilder;
+    /**
+     * Allows combining results of 2 or more queries with the logical OR operator.
+     */
+    or: (...conditions: RQLString[]) => RQLBuilder;
+    /**
+     * @description `contains(field)` only returns records having this field as property
+     * @example
+     * await exh.data.documents.find(
+     *   schemaId,
+     *   { rql: rqlBuilder().contains('data.indicator').build()
+     * });
+     * @returns returns documents containing the `data.indicator` field
+     *
+     * @description Filters for objects where the specified property's value is an array and the array contains
+     * any value that equals the provided value or satisfies the provided condition.
+     * `contains(field, itemField > 30)` only returns records having a property `field` which have a prop `itemField` for which the condition is valid
+     * `contains` with a single property is not strictly needed. This can be replaced with `gt(field.itemField,30)`.
+     * @example
+     * await exh.data.documents.find(schemaId, {
+     *   rql: rqlBuilder()
+     *         .contains(
+     *              "data",
+     *              rqlBuilder().gt("heartrate", "60").intermediate(),
+     *                rqlBuilder().lt("heartrate", "90").intermediate()
+     *          )
+     *          .build();
+     * });
+     * @return Only returns documents with a data object containing `heartrate > 60` and `heartrate > 90`
+     */
+    contains: (field: string, ...conditions: RQLString[]) => RQLBuilder;
+    /**
+     * @description `excludes(field)` only returns records not having this field as property
+     * @example
+     * await exh.data.documents.find(
+     *   schemaId,
+     *   { rql: rqlBuilder().excludes('data.indicator').build()
+     * });
+     * @returns returns documents not containing the `data.indicator` field
+     *
+     * @description Filters for objects where the specified property's value is an array and the array excludes
+     * any value that equals the provided value or satisfies the provided condition.
+     * `excludes(field, itemField > 30)` only returns records having a property `field` which have a prop `itemField` for which the condition is invalid
+     * @example
+     * await exh.data.documents.find(schemaId, {
+     *   rql: rqlBuilder()
+     *     .excludes("data", rqlBuilder().gt("heartrate", "60").intermediate())
+     *     .build(),
+     * });
+     * @return Only returns documents excluding documents where `data.heartrate > 60`
+     */
+    excludes: (field: string, ...conditions: RQLString[]) => RQLBuilder;
+    /**
+     * @description skipCount() Skips the record counting step of a request to increase performance.
+     *
+     * As a result, the page object in a response will not include the total field.
+     *
+     * @example
+     * await exh.data.documents.find(schemaId, {
+     *   rql: rqlBuilder()
+     *          .skipCount()
+     *          .build(),
+     * });
+     */
+    skipCount: () => RQLBuilder;
+    /**
+     * Returns a valid rqlString
+     * @returns valid rqlString
+     */
+    build: () => RQLString;
+    /**
+     * Returns an intermediate rqlString you can combine in or/and statements
+     * @returns valid rqlString
+     */
+    intermediate: () => RQLString;
+}
+export {};

package/build/types/services/auth/applications/index.d.ts

@@ -0,0 +1,5 @@
+import type { HttpInstance } from '../../../types';
+import { HttpClient } from '../../http-client';
+import type { AuthApplicationsService } from '../types';
+declare const _default: (client: HttpClient, httpWithAuth: HttpInstance) => AuthApplicationsService;
+export default _default;

package/build/types/services/auth/applications/types.d.ts

@@ -0,0 +1,190 @@
+import { AffectedRecords, OptionsBase, OptionsWithRql, PagedResult } from '../../../types';
+export interface AuthApplicationsService {
+    /**
+     * ## Create a new application
+     * You can use this function to create a new `oAuth1` or `oAuth2` application.
+     *
+     * You need permissions to use this function.
+     *
+     * #### Global Permissions
+     * `CREATE_APPLICATIONS` - Provides the ability to create new applications.
+     *
+     * @param data {@link OAuth1ApplicationCreation} or {@link OAuth2ApplicationCreation}
+     * @returns The newly created {@link OAuth1Application} or {@link OAuth2Application}.
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     * @throws {@link FieldFormatError} when one of the provided parameters is not correctly formatted according to the documentation.
+     */
+    create<T extends OAuth1ApplicationCreation | OAuth2ApplicationCreation>(data: T, options?: OptionsBase): Promise<T extends OAuth1ApplicationCreation ? OAuth1Application : OAuth2Application>;
+    /**
+     * ## Get a list of applications
+     * Provides a paginated list of applications currently registered in the cluster.
+     *
+     * Every logged-in user is able to retrieve a limited set of fields (only `name`, `description`, `logo` and `type').
+     *
+     * #### Global Permissions
+     * `VIEW_APPLICATIONS` - Returns all applications fields
+     *
+     * #### Function details
+     * @param options {@link OptionsWithRql} addional options with rql that can be set for your request to the cluster.
+     *
+     * @returns Provides a paginated list of applications currently registered in the cluster.
+     *
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     * */
+    get(options?: OptionsWithRql): Promise<PagedResult<OAuth1Application | OAuth2Application>>;
+    /**
+     * ## Update an existing application
+     * You can use this function to update an existing `oAuth1` or `oAuth2` application.
+     *
+     * You need permissions to use this function.
+     *
+     * #### Global Permissions
+     * `UPDATE_APPLICATIONS` - Provides the ability to update existing applications.
+     *
+     * #### Function details
+     * @param applicationId A hexadecimal identifier of 24 characters of the application you want to update.
+     * @param data {@link OAuth1ApplicationUpdate} or {@link OAuth2ApplicationUpdate} containing the fields you want to update.
+     * The fields that are left undefined will not be updated.
+     * @param options {@link OptionsBase} addional options that can be set for your request to the cluster.
+     *
+     * @returns {Promise} A Promise with the number of affected records.
+     *
+     * @throws {@link ResourceUnknownError} when no application is found for the specified application Id.
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     * @throws {@link FieldFormatError} when one of the provided parameters is not correctly formatted according to the documentation.
+     */
+    update<T extends OAuth1ApplicationUpdate | OAuth2ApplicationUpdate>(applicationId: string, data: T, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * ## Delete an application
+     * You can use this function to remove an existing `oAuth1` or `oAuth2` application.
+     *
+     * You need permissions to use this function.
+     *
+     * #### Global permisions
+     * `DELETE_APPLICATIONS` - Provides the ability to remove the applications.
+     *
+     * #### Function details
+     * @param applicationId A hexadecimal identifier of 24 characters of the application you want to remove.
+     * @param options {@link OptionsBase} addional options that can be set for your request to the cluster.
+     *
+     * @returns {Promise} A Promise with the number of affected records.
+     *
+     * @throws {@link ResourceUnknownError} when no application is found for the specified application Id.
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     */
+    remove(applicationId: string, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * ## Create an application version
+     * You can use this function to create a new application version.
+     *
+     * You need permissions to use this function.
+     *
+     * #### Global permissions
+     * `CREATE_APPLICATIONS`- Provides the ability to create new application versions.
+     *
+     * #### Function details
+     * @param applicationId A hexadecimal identifier of 24 characters of the application.
+     * @param data An {@link ApplicationVersionCreation} object
+     * @param options {@link OptionsBase} addional options that can be set for your request to the cluster.
+     *
+     * @returns The newly created {@link OAuth1ApplicationVersion} or {@link OAuth2ApplicationVersion}.
+     *
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     * @throws {@link FieldFormatError} when one of the provided parameters is not correctly formatted according to the documentation.
+     */
+    createVersion(applicationId: string, data: ApplicationVersionCreation, options?: OptionsBase): Promise<ApplicationVersion>;
+    /**
+     * ## Delete an application version
+     * You can use this function to remove an existing appliction version.
+     *
+     * When you remove an application version users with existing oAuth1 tokens trying to communicate with the cluster will receive a `OAUTH_KEY_EXCEPTION`.
+     * In case of oAuth2 tokens users will receive a `OAUTH2_CLIENT_ID_EXCEPTION` when trying to use their refresh token to get new access tokens.
+     * You can use the error's above to force users to switch to a newer version of your applications in case the backend no longer recoginizes them.
+     *
+     * You need permissions to execute this function
+     *
+     * #### Global permissions
+     * `DELETE_APPLICATIONS` - Provides the ability to remove application versions.
+     *
+     * #### Function details
+     * @param applicationId A hexadecimal identifier of 24 characters of the application.
+     * @param versionId the version Identifier or `name` of the application version.
+     * @param options {@link OptionsBase} addional options that can be set for your request to the cluster.
+     *
+     * @returns {Promise} A Promise with the number of affected records.
+     *
+     * @throws {ResourceUnknownError} when the specified application or version could not be found
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     */
+    deleteVersion(applicationId: string, versionId: string, options?: OptionsBase): Promise<AffectedRecords>;
+}
+/**
+ * @name Application
+ */
+export interface Application {
+    /** A 24 character long hexadecimal value acting as the identifier of your application */
+    id: string;
+    /** The name of your application. A minimum 1 and maximm of 100 characters is accepted */
+    name: string;
+    /** A Description of your application. A minimum 1 and maximm of 250 characters is accepted */
+    description: string;
+    /** The timestamp when the application was last updated */
+    updateTimestamp: Date;
+    /** The timestamp when the application was created */
+    creationTimestamp: Date;
+}
+export interface OAuth1Application extends Application {
+    /** type of the application */
+    type: ApplicationType.oauth1;
+    /** A List cointaining the different versions of the application */
+    versions?: OAuth1ApplicationVersion[];
+}
+export interface OAuth2Application extends Application {
+    /** type of the application */
+    type: ApplicationType.oauth2;
+    /** A List containing the different versions of the application */
+    versions?: OAuth2ApplicationVersion[];
+    /**
+     * @deprecated
+     * The logo of the application. Can be used in the oAuth2.0 authorization code grant to indicate the user what application he is authorizing.
+     * A hexadecimal value with a minimum of 1 and maximum of 100 characters is allowed.
+     * */
+    logo?: string;
+    /** A list of approved uri's that can be used when authenticating with [an authorization code grant flow](https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1). Can only be used in an oAuth2 application type. A minimum of 1 uri and maximum 50 uri's can be provided. This field is required upon creation to the application */
+    redirectUris?: string[];
+    /**
+     * Defines wether your application should be considered a confidential app according to the [oAuth2.0 spec](https://www.rfc-editor.org/rfc/rfc6749). If not provided upon creation this value defaults to false.
+     */
+    confidential: boolean;
+}
+export declare enum ApplicationType {
+    oauth1 = "oauth1",
+    oauth2 = "oauth2"
+}
+export declare type ApplicationCreation = Required<Pick<Application, 'name' | 'description'>>;
+export declare type OAuth1ApplicationCreation = ApplicationCreation & Required<Pick<OAuth1Application, 'type'>>;
+export declare type OAuth2ApplicationCreation = ApplicationCreation & Required<Pick<OAuth2Application, 'type' | 'redirectUris'>> & Partial<Pick<OAuth2Application, 'logo' | 'confidential'>>;
+export interface ApplicationVersion {
+    /** The identifier of this version */
+    id: string;
+    /** The name of the application version. We suggest using semantic versioning vX.X.X (e.g. v1.2.0) */
+    name: string;
+    /** The timestap when this version was created */
+    creationTimestamp: Date;
+}
+export interface OAuth1ApplicationVersion extends ApplicationVersion {
+    /** the oAuth1 consumerKey */
+    consumerKey: string;
+    /** the oAuth1 consumerSecret */
+    consumerSecret: string;
+}
+export interface OAuth2ApplicationVersion extends ApplicationVersion {
+    /** The oAuth2 clientId */
+    clientId: string;
+    /** The oAuth2 clientSecret */
+    clientSecret: string;
+}
+export declare type ApplicationUpdate = Partial<Pick<Application, 'name' | 'description'>>;
+export declare type OAuth1ApplicationUpdate = ApplicationUpdate & Required<Pick<OAuth1Application, 'type'>>;
+export declare type OAuth2ApplicationUpdate = ApplicationUpdate & Required<Pick<OAuth2Application, 'type'>> & Partial<Pick<OAuth2Application, 'logo' | 'redirectUris'>>;
+export declare type ApplicationVersionCreation = Required<Partial<Pick<ApplicationVersion, 'name'>>>;

package/build/types/services/auth/index.d.ts

@@ -0,0 +1,3 @@
+import type { HttpInstance } from '../../types';
+import type { AuthService } from './types';
+export declare function authService(httpWithAuth: HttpInstance): AuthService;

package/build/types/services/auth/oauth1/index.d.ts

@@ -0,0 +1,5 @@
+import type { HttpInstance } from '../../../types';
+import { HttpClient } from '../../http-client';
+import type { AuthOauth1Service } from './types';
+declare const _default: (client: HttpClient, httpWithAuth: HttpInstance) => AuthOauth1Service;
+export default _default;

package/build/types/services/auth/oauth1/types.d.ts

@@ -0,0 +1,63 @@
+import { AffectedRecords, OptionsWithRql, PagedResult } from '../../types';
+export interface AuthOauth1Service {
+    /**
+     * Generate an SSO token with OAuth 1 authentication
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/SSO/post_oauth1_ssoTokens_generate
+     * @throws {ApplicationNotAuthenticatedError}
+     * @throws {UserNotAuthenticatedError}
+     */
+    generateSsoToken(): Promise<SsoToken>;
+    /**
+     * Consume an SSO token to get OAuth 1 tokens
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/SSO/post_oauth1_ssoTokens_generate
+     * @throws {ApplicationNotAuthenticatedError}
+     * @throws {ResourceUnknownError}
+     */
+    consumeSsoToken(ssoToken: string): Promise<OAuth1Token>;
+    /**
+     * Get a list of OAuth1 tokens
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Can only see a list of OAuth1 tokens for this account
+     * VIEW_AUTHORIZATIONS | global | Can see a list of OAuth1 tokens for any account
+     * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/OAuth1/get_oauth1_tokens
+     */
+    getTokens(options?: OptionsWithRql): Promise<PagedResult<OAuth1Token>>;
+    /**
+     * Delete a token
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Can only see a list of OAuth1 tokens for this account
+     * VIEW_AUTHORIZATIONS | | Can remove any OAuth1 tokens of any account
+     * * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/OAuth1/post_oauth1_tokens_mfa
+     */
+    removeToken(tokenId: string): Promise<AffectedRecords>;
+}
+export interface SsoToken {
+    id: string;
+    ssoToken: string;
+    userId: string;
+    createdByApplicationId: string;
+    expiryTimestamp: Date;
+    creationTimestamp: Date;
+    updateTimestamp: Date;
+}
+export interface OAuth1Token {
+    id: string;
+    userId: string;
+    applicationId: string;
+    token: string;
+    tokenSecret: string;
+    lastUsedTimestamp: Date;
+    creationTimestamp: Date;
+}

package/build/types/services/auth/oauth2/index.d.ts

@@ -0,0 +1,5 @@
+import type { HttpInstance } from '../../../types';
+import { HttpClient } from '../../http-client';
+import type { AuthOauth2Service } from './types';
+declare const _default: (client: HttpClient, httpWithAuth: HttpInstance) => AuthOauth2Service;
+export default _default;

package/build/types/services/auth/oauth2/types.d.ts

@@ -0,0 +1,52 @@
+import { AffectedRecords, OptionsBase, OptionsWithRql, PagedResult } from '../../types';
+export interface AuthOauth2Service {
+    /**
+     * Create an OAuth2 authorization
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/OAuth2/post_oauth2_authorizations
+     * @throws {ApplicationUnknownError}
+     * @throws {CallbackNotValidError}
+     * @throws {UnsupportedResponseTypeError}
+     */
+    createAuthorization(data: OAuth2AuthorizationCreation, options?: OptionsBase): Promise<OAuth2Authorization>;
+    /**
+     * Get a list of OAuth2 Authorizations
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * VIEW_AUTHORIZATIONS | global | **Required** for this endpoint
+     * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/OAuth2/get_oauth2_authorizations
+     */
+    getAuthorizations(options?: OptionsWithRql): Promise<PagedResult<OAuth2Authorization>>;
+    /**
+     * Delete an OAuth2 Authorization
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * DELETE_AUTHORIZATIONS | global | **Required** for this endpoint
+     * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/OAuth2/delete_oauth2_authorizations__authorizationId_
+     * @throws {ResourceUnknownError}
+     */
+    deleteAuthorization(authorizationId: string, options?: OptionsWithRql): Promise<AffectedRecords>;
+}
+export interface OAuth2AuthorizationCreation {
+    responseType: string;
+    clientId: string;
+    redirectUri: string;
+    state: string;
+    scope: string;
+}
+export interface OAuth2Authorization {
+    id: string;
+    userId: string;
+    clientId: string;
+    authorizationCode: string;
+    state: string;
+    /** The timestamp when the authorization was last updated */
+    updateTimestamp?: Date;
+    /** The timestamp when the authorization was created */
+    creationTimestamp?: Date;
+}

package/build/types/services/auth/oidc/index.d.ts

@@ -0,0 +1,5 @@
+import { HttpInstance } from '../../../types';
+import { HttpClient } from '../../http-client';
+import { OidcService } from './types';
+declare const _default: (oidcClient: HttpClient, httpWithAuth: HttpInstance) => OidcService;
+export default _default;

package/build/types/services/auth/oidc/loginAttempts/index.d.ts

@@ -0,0 +1,5 @@
+import { HttpInstance } from '../../../../http/types';
+import { HttpClient } from '../../../http-client';
+import { LoginAttemptsService } from './types';
+declare const _default: (oidcClient: HttpClient, httpWithAuth: HttpInstance) => LoginAttemptsService;
+export default _default;

package/build/types/services/auth/oidc/loginAttempts/types.d.ts

@@ -0,0 +1,67 @@
+import { FindAllIterator } from '../../../helpers';
+import { OptionsWithRql, PagedResultWithPager } from '../../../types';
+export interface LoginAttemptsService {
+    /**
+     * ## Retrieve a paged list of login attempts
+     *
+     * **Global Permissions:**
+     * - `VIEW_OIDC_LOGIN_ATTEMPTS` - Allows a user to view login attempts
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns A paged list of login attempts {@link PagedResultWithPager PagedResultWithPager<LoginAttempt>}
+     */
+    find(options?: OptionsWithRql): Promise<PagedResultWithPager<LoginAttempt>>;
+    /**
+     * ## Retrieve a list of all login attempts
+     *
+     * **Global Permissions:**
+     * - `VIEW_OIDC_LOGIN_ATTEMPTS` - Allows a user to view login attempts
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns An array of login attempts {@link LoginAttempt LoginAttempt[]}
+     * @throws {@link Error} Do not pass in limit operator with findAll
+     */
+    findAll(options?: OptionsWithRql): Promise<LoginAttempt[]>;
+    /**
+     * ## Retrieve a paged list of login attempts
+     *
+     * **Global Permissions:**
+     * - `VIEW_OIDC_LOGIN_ATTEMPTS` - Allows a user to view login attempts
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns An iterator for the queried login attempts {@link FindAllIterator FindAllIterator<LoginAttempt>}
+     */
+    findAllIterator(options?: OptionsWithRql): FindAllIterator<LoginAttempt>;
+    /**
+     * ## Retrieve the first queried login attempt
+     *
+     * **Global Permissions:**
+     * - `VIEW_OIDC_LOGIN_ATTEMPTS` - Allows a user to view login attempts
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns The first element of the queried login attempts {@link LoginAttempt}
+     */
+    findFirst(options?: OptionsWithRql): Promise<LoginAttempt>;
+}
+export declare enum LoginAttemptStatus {
+    SUCCESS = "success",
+    FAILED = "failed"
+}
+export interface LoginAttempt {
+    /** The Extra Horizon document id */
+    id: string;
+    /** The (success / failed) status of a login attempt. */
+    status: LoginAttemptStatus;
+    /** The id of the provider */
+    providerId: string;
+    /** The unique name of the provider */
+    providerName: string;
+    /** The subject id (sub) of the user for the given provider */
+    providerSubjectId: string;
+    /** The Extra Horizon user id */
+    userId: string;
+    /** An Extra Horizon formatted error for failed requests */
+    error: {
+        name: string;
+        message: string;
+        code: number;
+    };
+    /** The date and time of the login attempt */
+    creationTimestamp: Date;
+}

package/build/types/services/auth/oidc/providers/index.d.ts

@@ -0,0 +1,5 @@
+import { HttpInstance } from '../../../../http/types';
+import { HttpClient } from '../../../http-client';
+import { OidcProviderService } from './types';
+declare const _default: (oidcClient: HttpClient, httpWithAuth: HttpInstance) => OidcProviderService;
+export default _default;