auth0-actions 0.0.1 → 0.0.3

package/dist/index.d.ts

@@ -1,27 +1,71 @@
-export interface PostLoginEvent<TSecret, TAppMetadata, TUserMetadata> {
+/**
+ *
+ */
+export interface CredentialsExchangeEvent<TSecret, TClientMetadata> {
+    /** An object containing information describing the authorization granted to the user who is logging in. */
+    accessToken?: AccessToken;
+    /**  */
+    client?: Client<TClientMetadata>;
+    /**  */
+    request?: RequestBase<CredentialsExchangeRequestBody>;
+    /**  */
+    resource_server?: ResourceServer;
+    /**  */
+    secrets?: TSecret;
+    /**  */
+    tenant?: Tenant;
+    /**  */
+    transaction?: TransactionBase;
+}
+/**
+ *
+ */
+export interface PostLoginEvent<TSecret, TClientMetadata, TAppMetadata, TUserMetadata> {
+    /** Details about authentication signals obtained during the login flow. */
     authentication?: AuthenticationInfoWithRiskAssessment;
+    /** An object containing information describing the authorization granted to the user who is logging in. */
     authorization?: AuthorizationInfo;
-    cancelable?: boolean;
-    client?: Client;
+    /**  */
+    client?: Client<TClientMetadata>;
+    /**  */
     configuration?: Configuration;
+    /**  */
     connection?: Connection;
+    /**  */
     organization?: Organization;
-    request?: RequestBase;
+    /**  */
+    request?: Request<any>;
+    /**  */
     resource_server?: ResourceServer;
+    /**  */
     secrets?: TSecret;
+    /**  */
     stats?: Stats;
+    /**  */
     tenant?: Tenant;
+    /**  */
     transaction?: Transaction;
+    /**  */
     user?: UserBase<TAppMetadata, TUserMetadata>;
 }
+/**
+ *
+ */
+interface AccessToken {
+    customClaims: any;
+    scope: string[];
+}
 /**
  * Details about authentication signals obtained during the login flow.
  */
 interface AuthenticationInfoWithRiskAssessment {
     /** Contains the authentication methods a user has completed during their session. */
     methods: AuthenticationMethod[];
-    riskAssessment?: RiskAssessmentInfo;
+    riskAssessment?: RiskAssessmentSummary;
 }
+/**
+ *
+ */
 interface AuthenticationMethod {
     /**
      * The name of the first factor that was completed. Values include the following:
@@ -30,6 +74,9 @@ interface AuthenticationMethod {
     timestamp: string;
     type: string;
 }
+/**
+ *
+ */
 declare enum AuthenticationMethods {
     /** A social or enterprise connection was used to authenticate the user as the first factor. */
     federated = "federated",
@@ -45,19 +92,33 @@ declare enum AuthenticationMethods {
     mfa = "mfa",
     mock = "mock"
 }
+/**
+ *
+ */
 interface AuthorizationInfo {
     roles: string[];
 }
-interface Client {
+/**
+ *
+ */
+interface Client<TMetadata> {
+    /** The client id of the application the user is logging in to. */
     clientId: string;
-    metadata: {
-        [additionalProperties: string]: string;
-    };
+    /** An object for holding other application properties. */
+    metadata: TMetadata;
+    /** The name of the application (as defined in the Dashboard). */
     name: string;
+    /**  */
     strategy: string;
 }
+/**
+ *
+ */
 interface Configuration {
 }
+/**
+ *
+ */
 interface Connection {
     /**
      * The connection's identifier
@@ -78,6 +139,9 @@ interface Connection {
      */
     strategy: ConnectionStrategies;
 }
+/**
+ *
+ */
 declare enum ConnectionStrategies {
     ad = "ad",
     adfs = "adfs",
@@ -141,6 +205,18 @@ declare enum ConnectionStrategies {
     yammer = "yammer",
     yandex = "yandex"
 }
+/**
+ *
+ */
+interface CredentialsExchangeRequestBody {
+    audience: string;
+    client_id: string;
+    client_secret: string;
+    grant_type: string;
+}
+/**
+ *
+ */
 interface GeoIP {
     cityName: string;
     continentCode: string;
@@ -153,6 +229,9 @@ interface GeoIP {
     subdivisionName: string;
     timeZone: string;
 }
+/**
+ *
+ */
 interface Identity {
     connection: string;
     isSocial: boolean;
@@ -160,6 +239,25 @@ interface Identity {
     userId: string;
     user_id: string;
 }
+/**
+ *
+ */
+interface IPAddressDetails {
+    category: string;
+    ip: string;
+    matches: string;
+    source: string;
+}
+/**
+ *
+ */
+interface NewDeviceDetails {
+    device: string;
+    useragent: string;
+}
+/**
+ *
+ */
 interface Organization {
     display_name: string;
     /**
@@ -177,6 +275,9 @@ interface Organization {
      */
     name: string;
 }
+/**
+ *
+ */
 interface Query {
     audience: string;
     client_id: string;
@@ -189,31 +290,71 @@ interface Query {
     scope: string;
     state: string;
 }
-interface RequestBase {
-    ip: string;
-    method: string;
+/**
+ *
+ */
+interface Request<TBody> extends RequestBase<TBody> {
     query: Query;
-    body: RequestBody;
+}
+/**
+ *
+ */
+interface RequestBase<TBody> {
+    body: TBody;
     geoip: GeoIP;
     hostname: string;
+    ip: string;
+    method: string;
     user_agent: string;
 }
-interface RequestBody {
-}
+/**
+ *
+ */
 interface ResourceServer {
     identifier: string;
 }
-interface RiskAssessmentInfo {
+interface RiskAssessmentBase {
+    code: string;
+    confidence: string;
+}
+/**
+ *
+ */
+interface RiskAssessmentSummary {
+    assessments: RiskAssessments;
     confidence: "low" | "medium" | "high" | "neutral";
     version: string;
 }
+/**
+ *
+ */
+interface RiskAssessments {
+    ImpossibleTravel: RiskAssessmentBase;
+    NewDevice: RiskAssessmentWithDetails<NewDeviceDetails>;
+    UntrustedIP: RiskAssessmentWithDetails<IPAddressDetails>;
+}
+/**
+ *
+ */
+interface RiskAssessmentWithDetails<TDetails> {
+    details: TDetails;
+}
+/**
+ *
+ */
 interface Stats {
     logins_count: number;
 }
+/**
+ *
+ */
 interface Tenant {
     id: string;
 }
-interface Transaction {
+/**
+ *
+ */
+interface Transaction extends TransactionBase {
     acr_values: any[];
     linking_id?: string;
     locale: string;
@@ -221,12 +362,20 @@ interface Transaction {
     prompt: string[];
     protocol?: TransactionProtocols;
     redirect_uri?: string;
-    requested_scopes: string[];
     response_mode?: string;
     response_type?: string[];
     state?: string;
     ui_locales: string[];
 }
+/**
+ *
+ */
+interface TransactionBase {
+    requested_scopes: string[];
+}
+/**
+ *
+ */
 declare enum TransactionProtocols {
     oidc_basic = "oidc-basic-profile",
     oidc_hybrid = "oidc-hybrid",
@@ -242,31 +391,53 @@ declare enum TransactionProtocols {
     oauth2_refresh_token = "oauth2-refresh-token",
     oauth2_token_exchange = "oauth2-token-exchange"
 }
-export interface UserBase<AppMetadata, UserMetadata> {
-    app_metadata: AppMetadata;
+/**
+ *
+ */
+export interface UserBase<TAppMetadata, TUserMetadata> {
+    /** Data that the user has read-only access to (e.g. roles, permissions, vip, etc) */
+    app_metadata: TAppMetadata;
+    /**  */
     created_at: string;
+    /**  */
     email: string;
+    /**  */
     email_verified: boolean;
+    /**  */
     family_name: string;
+    /**  */
     given_name: string;
+    /**  */
     identities: Identity[];
+    /**  */
     last_password_reset?: string;
+    /**  */
     multifactor?: string[];
+    /**  */
     name: string;
+    /**  */
     nickname: string;
+    /**  */
     phone_number?: string;
+    /**  */
     phone_verified?: boolean;
+    /**  */
     picture: string;
+    /**  */
     updated_at: string;
+    /**  */
     user_id: string;
-    user_metadata: UserMetadata;
+    /** Data that the user has read/write access to (e.g. color_preference, blog_url, etc.) */
+    user_metadata: TUserMetadata;
+    /**  */
     username?: string;
 }
-export interface PostLoginApi {
+export interface PostLoginApi extends ActionsApiBase<PostLoginApi> {
     /** Modify the user's login access, such as by rejecting the login attempt. */
-    access: LoginAccessManager;
+    access: LoginAccessManager<PostLoginApi>;
     /** Request changes to the access token being issued. */
-    accessToken: AccessTokenManager;
+    accessToken: AccessTokenManager<PostLoginApi>;
+    /**  */
     authentication: AuthenticationManager;
     /** Store and retrieve data that persists across executions. */
     cache: CacheManager;
@@ -279,23 +450,33 @@ export interface PostLoginApi {
     /**  */
     user: UserManager;
 }
-export interface AccessTokenManager {
+export interface AccessTokenManager<TApi extends ActionsApiBase<TApi>> extends AccessTokenManagerBase<TApi> {
     /**
      * Add a scope on the Access Token that will be issued upon completion of the login flow.
      * @param scope The scope to be added.
      */
-    addScope(scope: string): PostLoginApi;
+    addScope(scope: string): TApi;
     /**
      * Remove a scope on the Access Token that will be issued upon completion of the login flow.
      * @param scope The scope to be removed.
      */
-    removeScope(scope: string): PostLoginApi;
+    removeScope(scope: string): TApi;
+}
+export interface AccessTokenManagerBase<TApi extends ActionsApiBase<TApi>> {
     /**
      * Set a custom claim on the Access Token that will be issued upon completion of the login flow.
      * @param name Name of the claim (note that this may need to be a fully-qualified URL).
      * @param value The value of the claim.
      */
-    setCustomClaim(name: string, value: any): PostLoginApi;
+    setCustomClaim(name: string, value: any): TApi;
+}
+export interface ActionsApiBase<TApi extends ActionsApiBase<TApi>> {
+    /** Modify the user's login access, such as by rejecting the login attempt. */
+    access: LoginAccessManager<TApi>;
+    /** Request changes to the access token being issued. */
+    accessToken: AccessTokenManagerBase<TApi>;
+    /** Store and retrieve data that persists across executions. */
+    cache: CacheManager;
 }
 export interface AuthenticationManager {
     /**
@@ -349,7 +530,9 @@ export interface CacheManager {
     set(key: string, value: any, options?: CacheOptions): void;
 }
 export interface CacheWriteResult {
+    /**  */
     type: 'success' | 'error';
+    /** If @see type = 'error', then the error code will be populated here. */
     code: string;
 }
 export interface CacheRecord {
@@ -393,6 +576,14 @@ export declare enum ChallengeTypes {
     webauthn_platform = "webauthn-platform",
     webauthn_roaming = "webauthn-roaming"
 }
+export interface CredentialsExchangeApi extends ActionsApiBase<CredentialsExchangeApi> {
+    /** Control availability to the access token. */
+    access: LoginAccessManager<CredentialsExchangeApi>;
+    /** Request changes to the access token being issued. */
+    accessToken: AccessTokenManagerBase<CredentialsExchangeApi>;
+    /** Store and retrieve data that persists across executions. */
+    cache: CacheManager;
+}
 export interface DuoMultifactorOptions {
     host: string;
     ikey: string;
@@ -415,14 +606,14 @@ export interface IdTokenManager {
      */
     setCustomClaim(name: string, value: any): PostLoginApi;
 }
-export interface LoginAccessManager {
+export interface LoginAccessManager<TApi extends ActionsApiBase<TApi>> {
     /**
      * Mark the current login attempt as denied. This will prevent the end-user from completing the login flow. This will NOT cancel other user-related
      * side effects (such as metadata changes) requested by this Action. The login flow will immediately stop following the completion of this action
      * and no further Actions will be executed.
      * @param reason A human-readable explanation for rejecting the login. This may be presented directly in end-user interfaces.
      */
-    deny(reason: string): PostLoginApi;
+    deny(reason: string): TApi;
 }
 export interface MultifactorManager {
     /**

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,cAAc,CAAC,OAAO,EAAE,YAAY,EAAE,aAAa;IAEhE,cAAc,CAAC,EAAE,oCAAoC,CAAA;IAErD,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAElC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,IAAI,CAAC,EAAE,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;CAChD;AAID;;GAEG;AACH,UAAU,oCAAoC;IAE1C,qFAAqF;IACrF,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAEhC,cAAc,CAAC,EAAE,kBAAkB,CAAC;CACvC;AAED,UAAU,oBAAoB;IAC1B;;OAEG;IACH,IAAI,EAAE,qBAAqB,GAAG,MAAM,CAAC;IAErC,SAAS,EAAE,MAAM,CAAC;IAGlB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,aAAK,qBAAqB;IAEtB,+FAA+F;IAC/F,SAAS,cAAc;IAEvB,OAAO;IACP,OAAO,YAAY;IAEnB,mFAAmF;IACnF,GAAG,QAAQ;IAEX,2FAA2F;IAC3F,GAAG,QAAQ;IAEX,gIAAgI;IAChI,KAAK,UAAU;IAEf,OAAO;IACP,GAAG,QAAQ;IAGX,IAAI,SAAS;CAChB;AAED,UAAU,iBAAiB;IACvB,KAAK,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,UAAU,MAAM;IAGZ,QAAQ,EAAE,MAAM,CAAC;IAGjB,QAAQ,EAAE;QAAE,CAAC,oBAAoB,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,CAAC;IAGtD,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,UAAU,aAAa;CAEtB;AAED,UAAU,UAAU;IAEhB;;MAEE;IACF,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,oBAAoB,CAAC;CAElC;AAED,aAAK,oBAAoB;IACrB,EAAE,OAAO;IACT,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,GAAG,QAAQ;IACX,UAAU,eAAe;IACzB,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,gBAAgB,qBAAqB;IACrC,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,WAAW,gBAAgB;IAC3B,aAAa,kBAAkB;IAC/B,SAAS,cAAc;IACvB,EAAE,OAAO;IACT,IAAI,SAAS;IACb,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,cAAc,mBAAmB;IACjC,YAAY,iBAAiB;IAC7B,cAAc,mBAAmB;IACjC,MAAM,WAAW;IACjB,oBAAoB,yBAAyB;IAC7C,kBAAkB,uBAAuB;IACzC,UAAU,eAAe;IACzB,KAAK,UAAU;IACf,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,GAAG,QAAQ;IACX,UAAU,eAAe;IACzB,eAAe,oBAAoB;IACnC,OAAO,YAAY;IACnB,kBAAkB,uBAAuB;IACzC,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,MAAM,WAAW;CACpB;AAED,UAAU,KAAK;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;IACrB,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,eAAe,EAAE,MAAM,CAAA;IACvB,eAAe,EAAE,MAAM,CAAA;IACvB,QAAQ,EAAE,MAAM,CAAA;CACnB;AAED,UAAU,QAAQ;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,OAAO,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;CAClB;AAED,UAAU,YAAY;IAGlB,YAAY,EAAE,MAAM,CAAC;IAErB;;MAEE;IACF,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CAEhB;AAED,UAAU,KAAK;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,CAAA;IACtB,qBAAqB,EAAE,MAAM,CAAA;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CAChB;AAED,UAAU,WAAW;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;IACb,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,UAAU,WAAW;CAAI;AAEzB,UAAU,cAAc;IACpB,UAAU,EAAE,MAAM,CAAA;CACrB;AAED,UAAU,kBAAkB;IACxB,UAAU,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;IAClD,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,UAAU,KAAK;IACX,YAAY,EAAE,MAAM,CAAA;CACvB;AAED,UAAU,MAAM;IACZ,EAAE,EAAE,MAAM,CAAA;CACb;AACD,UAAU,WAAW;IACjB,UAAU,EAAE,GAAG,EAAE,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,QAAQ,CAAC,EAAE,oBAAoB,CAAA;IAC/B,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,EAAE,CAAA;CACvB;AAED,aAAK,oBAAoB;IACrB,UAAU,uBAAuB;IAEjC,WAAW,gBAAgB;IAC3B,aAAa,0BAA0B;IACvC,KAAK,UAAU;IACf,KAAK,UAAU;IACf,qBAAqB,0BAA0B;IAC/C,kBAAkB,uBAAuB;IACzC,qBAAqB,0BAA0B;IAC/C,iBAAiB,qCAAqC;IACtD,eAAe,oBAAoB;IACnC,mBAAmB,wBAAwB;IAC3C,oBAAoB,yBAAyB;IAC7C,qBAAqB,0BAA0B;CAClD;AAGD,MAAM,WAAW,QAAQ,CAAC,WAAW,EAAE,YAAY;IAC/C,YAAY,EAAE,WAAW,CAAA;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,MAAM,CAAA;IACb,cAAc,EAAE,OAAO,CAAA;IACvB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,QAAQ,EAAE,CAAA;IACtB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,EAAE,YAAY,CAAA;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAA;CACpB;AAMD,MAAM,WAAW,YAAY;IAEzB,8EAA8E;IAC9E,MAAM,EAAE,kBAAkB,CAAC;IAE3B,wDAAwD;IACxD,WAAW,EAAE,kBAAkB,CAAC;IAEhC,cAAc,EAAE,qBAAqB,CAAC;IAEtC,+DAA+D;IAC/D,KAAK,EAAE,YAAY,CAAC;IAEpB,oDAAoD;IACpD,OAAO,EAAE,cAAc,CAAC;IAExB,OAAO;IACP,WAAW,EAAE,kBAAkB,CAAC;IAEhC,OAAO;IACP,QAAQ,EAAE,eAAe,CAAC;IAE1B,OAAO;IACP,IAAI,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IAE/B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC;IAEtC;;;OAGG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC;IAEzC;;;;OAIG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,YAAY,CAAC;CAC1D;AAED,MAAM,WAAW,qBAAqB;IAElC;;;;;;;;OAQG;IACH,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,YAAY,CAAC;IAEjD;;;;;;;;OAQG;IACH,aAAa,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAA;IAEvE;;;;;;;OAOG;IACH,gBAAgB,CAAC,OAAO,EAAE,eAAe,EAAE,GAAG,IAAI,CAAA;CACrD;AAED,MAAM,WAAW,YAAY;IAEzB;;;OAGG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAEtC;;;;OAIG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAA;IAE7B;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,CAAA;CAE7D;AAED,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,SAAS,GAAG,OAAO,CAAA;IACzB,IAAI,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,WAAW;IAExB,sCAAsC;IACtC,KAAK,EAAE,GAAG,CAAA;IAEV,6EAA6E;IAC7E,UAAU,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,YAAY;IAEzB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,eAAe;IAC5B,IAAI,EAAE,cAAc,CAAA;IAEpB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;CAC/C;AAED,MAAM,WAAW,gBAAgB;IAC7B,iBAAiB,EAAE,eAAe,EAAE,CAAA;CACvC;AAED,oBAAY,cAAc;IACtB,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,KAAK,UAAU;IACf,iBAAiB,sBAAsB;IACvC,iBAAiB,sBAAsB;IACvC,gBAAgB,qBAAqB;CACxC;AAED,MAAM,WAAW,qBAAqB;IAClC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,kBAAkB;IAC/B,gBAAgB,EAAE,MAAM,CAAA;IACxB,OAAO,EAAE,GAAG,CAAC;IAEb;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAE3B;;;;OAIG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,YAAY,CAAA;CACzD;AAED,MAAM,WAAW,kBAAkB;IAE/B;;;;;OAKG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAAC;CACtC;AAED,MAAM,WAAW,kBAAkB;IAE/B;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,sBAAsB,GAAG,UAAU,GAAG,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,YAAY,CAAA;CAC5H;AAED,MAAM,WAAW,kBAAkB;IAC/B,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,eAAe,CAAC,EAAE,qBAAqB,CAAA;CAC1C;AAED,MAAM,WAAW,eAAe;IAE5B;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAAA;IAEhD;;;;OAIG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,YAAY,CAAA;IAEjE;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,MAAM,CAAA;CACvD;AAED,MAAM,WAAW,WAAW;IAExB;;;;OAIG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,YAAY,CAAA;IAEtD;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,YAAY,CAAA;CAC1D;AAED,MAAM,WAAW,oBAAoB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,kBAAkB,EAAE,MAAM,CAAC;CAC9B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,wBAAwB,CAAC,OAAO,EAAE,eAAe;IAE9D,2GAA2G;IAC3G,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B,OAAO;IACP,MAAM,CAAC,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;IAEjC,OAAO;IACP,OAAO,CAAC,EAAE,WAAW,CAAC,8BAA8B,CAAC,CAAC;IAEtD,OAAO;IACP,eAAe,CAAC,EAAE,cAAc,CAAC;IAEjC,OAAO;IACP,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,OAAO;IACP,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,OAAO;IACP,WAAW,CAAC,EAAE,eAAe,CAAC;CAEjC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa;IAEjF,2EAA2E;IAC3E,cAAc,CAAC,EAAE,oCAAoC,CAAA;IAErD,2GAA2G;IAC3G,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAElC,OAAO;IACP,MAAM,CAAC,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;IAEjC,OAAO;IACP,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B,OAAO;IACP,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB,OAAO;IACP,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,OAAO;IACP,OAAO,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IAEvB,OAAO;IACP,eAAe,CAAC,EAAE,cAAc,CAAC;IAEjC,OAAO;IACP,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,OAAO;IACP,KAAK,CAAC,EAAE,KAAK,CAAC;IAEd,OAAO;IACP,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,OAAO;IACP,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B,OAAO;IACP,IAAI,CAAC,EAAE,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;CAChD;AAED;;GAEG;AACH,UAAU,WAAW;IAEjB,YAAY,EAAE,GAAG,CAAC;IAClB,KAAK,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,UAAU,oCAAoC;IAE1C,qFAAqF;IACrF,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAEhC,cAAc,CAAC,EAAE,qBAAqB,CAAC;CAC1C;AAED;;GAEG;AACH,UAAU,oBAAoB;IAC1B;;OAEG;IACH,IAAI,EAAE,qBAAqB,GAAG,MAAM,CAAC;IAErC,SAAS,EAAE,MAAM,CAAC;IAGlB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,aAAK,qBAAqB;IAEtB,+FAA+F;IAC/F,SAAS,cAAc;IAEvB,OAAO;IACP,OAAO,YAAY;IAEnB,mFAAmF;IACnF,GAAG,QAAQ;IAEX,2FAA2F;IAC3F,GAAG,QAAQ;IAEX,gIAAgI;IAChI,KAAK,UAAU;IAEf,OAAO;IACP,GAAG,QAAQ;IAGX,IAAI,SAAS;CAChB;AAED;;GAEG;AACH,UAAU,iBAAiB;IACvB,KAAK,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,UAAU,MAAM,CAAC,SAAS;IAEtB,kEAAkE;IAClE,QAAQ,EAAE,MAAM,CAAC;IAEjB,0DAA0D;IAC1D,QAAQ,EAAE,SAAS,CAAA;IAEnB,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO;IACP,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,UAAU,aAAa;CAEtB;AAED;;GAEG;AACH,UAAU,UAAU;IAEhB;;MAEE;IACF,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,oBAAoB,CAAC;CAElC;AAED;;GAEG;AACH,aAAK,oBAAoB;IACrB,EAAE,OAAO;IACT,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,GAAG,QAAQ;IACX,UAAU,eAAe;IACzB,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,gBAAgB,qBAAqB;IACrC,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,WAAW,gBAAgB;IAC3B,aAAa,kBAAkB;IAC/B,SAAS,cAAc;IACvB,EAAE,OAAO;IACT,IAAI,SAAS;IACb,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,cAAc,mBAAmB;IACjC,YAAY,iBAAiB;IAC7B,cAAc,mBAAmB;IACjC,MAAM,WAAW;IACjB,oBAAoB,yBAAyB;IAC7C,kBAAkB,uBAAuB;IACzC,UAAU,eAAe;IACzB,KAAK,UAAU;IACf,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,GAAG,QAAQ;IACX,UAAU,eAAe;IACzB,eAAe,oBAAoB;IACnC,OAAO,YAAY;IACnB,kBAAkB,uBAAuB;IACzC,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,MAAM,WAAW;CACpB;AAED;;GAEG;AACH,UAAU,8BAA8B;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,UAAU,KAAK;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;IACrB,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,eAAe,EAAE,MAAM,CAAA;IACvB,eAAe,EAAE,MAAM,CAAA;IACvB,QAAQ,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,UAAU,QAAQ;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,OAAO,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,UAAU,gBAAgB;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,UAAU,gBAAgB;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,UAAU,YAAY;IAGlB,YAAY,EAAE,MAAM,CAAC;IAErB;;MAEE;IACF,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CAEhB;AAED;;GAEG;AACH,UAAU,KAAK;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,CAAA;IACtB,qBAAqB,EAAE,MAAM,CAAA;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,UAAU,OAAO,CAAC,KAAK,CAAE,SAAQ,WAAW,CAAC,KAAK,CAAC;IAC/C,KAAK,EAAE,KAAK,CAAC;CAChB;AAED;;GAEG;AACH,UAAU,WAAW,CAAC,KAAK;IACvB,IAAI,EAAE,KAAK,CAAC;IACZ,KAAK,EAAE,KAAK,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,UAAU,cAAc;IACpB,UAAU,EAAE,MAAM,CAAA;CACrB;AAED,UAAU,kBAAkB;IAExB,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,UAAU,qBAAqB;IAC3B,WAAW,EAAE,eAAe,CAAC;IAC7B,UAAU,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;IAClD,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,UAAU,eAAe;IAErB,gBAAgB,EAAE,kBAAkB,CAAC;IAErC,SAAS,EAAE,yBAAyB,CAAC,gBAAgB,CAAC,CAAA;IAEtD,WAAW,EAAE,yBAAyB,CAAC,gBAAgB,CAAC,CAAA;CAC3D;AAED;;GAEG;AACH,UAAU,yBAAyB,CAAC,QAAQ;IAExC,OAAO,EAAE,QAAQ,CAAC;CACrB;AAED;;GAEG;AACH,UAAU,KAAK;IACX,YAAY,EAAE,MAAM,CAAA;CACvB;AAED;;GAEG;AACH,UAAU,MAAM;IACZ,EAAE,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,UAAU,WAAY,SAAQ,eAAe;IACzC,UAAU,EAAE,GAAG,EAAE,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,QAAQ,CAAC,EAAE,oBAAoB,CAAA;IAC/B,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,EAAE,CAAA;CACvB;AAED;;GAEG;AACH,UAAU,eAAe;IACrB,gBAAgB,EAAE,MAAM,EAAE,CAAA;CAC7B;AAED;;GAEG;AACH,aAAK,oBAAoB;IACrB,UAAU,uBAAuB;IAEjC,WAAW,gBAAgB;IAC3B,aAAa,0BAA0B;IACvC,KAAK,UAAU;IACf,KAAK,UAAU;IACf,qBAAqB,0BAA0B;IAC/C,kBAAkB,uBAAuB;IACzC,qBAAqB,0BAA0B;IAC/C,iBAAiB,qCAAqC;IACtD,eAAe,oBAAoB;IACnC,mBAAmB,wBAAwB;IAC3C,oBAAoB,yBAAyB;IAC7C,qBAAqB,0BAA0B;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ,CAAC,YAAY,EAAE,aAAa;IAEjD,qFAAqF;IACrF,YAAY,EAAE,YAAY,CAAA;IAE1B,OAAO;IACP,UAAU,EAAE,MAAM,CAAA;IAElB,OAAO;IACP,KAAK,EAAE,MAAM,CAAA;IAEb,OAAO;IACP,cAAc,EAAE,OAAO,CAAA;IAEvB,OAAO;IACP,WAAW,EAAE,MAAM,CAAA;IAEnB,OAAO;IACP,UAAU,EAAE,MAAM,CAAA;IAElB,OAAO;IACP,UAAU,EAAE,QAAQ,EAAE,CAAA;IAEtB,OAAO;IACP,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B,OAAO;IACP,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IAEtB,OAAO;IACP,IAAI,EAAE,MAAM,CAAA;IAEZ,OAAO;IACP,QAAQ,EAAE,MAAM,CAAA;IAEhB,OAAO;IACP,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB,OAAO;IACP,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB,OAAO;IACP,OAAO,EAAE,MAAM,CAAA;IAEf,OAAO;IACP,UAAU,EAAE,MAAM,CAAA;IAElB,OAAO;IACP,OAAO,EAAE,MAAM,CAAA;IAEf,0FAA0F;IAC1F,aAAa,EAAE,aAAa,CAAA;IAE5B,OAAO;IACP,QAAQ,CAAC,EAAE,MAAM,CAAA;CACpB;AAMD,MAAM,WAAW,YAAa,SAAQ,cAAc,CAAC,YAAY,CAAC;IAE9D,8EAA8E;IAC9E,MAAM,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC;IAEzC,wDAAwD;IACxD,WAAW,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC;IAE9C,OAAO;IACP,cAAc,EAAE,qBAAqB,CAAC;IAEtC,+DAA+D;IAC/D,KAAK,EAAE,YAAY,CAAC;IAEpB,oDAAoD;IACpD,OAAO,EAAE,cAAc,CAAC;IAExB,OAAO;IACP,WAAW,EAAE,kBAAkB,CAAC;IAEhC,OAAO;IACP,QAAQ,EAAE,eAAe,CAAC;IAE1B,OAAO;IACP,IAAI,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB,CAAC,IAAI,SAAS,cAAc,CAAC,IAAI,CAAC,CAAE,SAAQ,sBAAsB,CAAC,IAAI,CAAC;IAEvG;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CAEpC;AAED,MAAM,WAAW,sBAAsB,CAAC,IAAI,SAAS,cAAc,CAAC,IAAI,CAAC;IAErE;;;;OAIG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAC;CAClD;AAED,MAAM,WAAW,cAAc,CAAC,IAAI,SAAS,cAAc,CAAC,IAAI,CAAC;IAE7D,8EAA8E;IAC9E,MAAM,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAEjC,wDAAwD;IACxD,WAAW,EAAE,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAE1C,+DAA+D;IAC/D,KAAK,EAAE,YAAY,CAAC;CAEvB;AAED,MAAM,WAAW,qBAAqB;IAElC;;;;;;;;OAQG;IACH,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,YAAY,CAAC;IAEjD;;;;;;;;OAQG;IACH,aAAa,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAA;IAEvE;;;;;;;OAOG;IACH,gBAAgB,CAAC,OAAO,EAAE,eAAe,EAAE,GAAG,IAAI,CAAA;CACrD;AAED,MAAM,WAAW,YAAY;IAEzB;;;OAGG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAEtC;;;;OAIG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAA;IAE7B;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,CAAA;CAE7D;AAED,MAAM,WAAW,gBAAgB;IAE7B,OAAO;IACP,IAAI,EAAE,SAAS,GAAG,OAAO,CAAA;IAEzB,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,WAAW;IAExB,sCAAsC;IACtC,KAAK,EAAE,GAAG,CAAA;IAEV,6EAA6E;IAC7E,UAAU,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,YAAY;IAEzB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,eAAe;IAC5B,IAAI,EAAE,cAAc,CAAA;IAEpB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;CAC/C;AAED,MAAM,WAAW,gBAAgB;IAC7B,iBAAiB,EAAE,eAAe,EAAE,CAAA;CACvC;AAED,oBAAY,cAAc;IACtB,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,KAAK,UAAU;IACf,iBAAiB,sBAAsB;IACvC,iBAAiB,sBAAsB;IACvC,gBAAgB,qBAAqB;CACxC;AAED,MAAM,WAAW,sBAAuB,SAAQ,cAAc,CAAC,sBAAsB,CAAC;IAElF,gDAAgD;IAChD,MAAM,EAAE,kBAAkB,CAAC,sBAAsB,CAAC,CAAC;IAEnD,wDAAwD;IACxD,WAAW,EAAE,sBAAsB,CAAC,sBAAsB,CAAC,CAAC;IAE5D,+DAA+D;IAC/D,KAAK,EAAE,YAAY,CAAC;CAEvB;AAED,MAAM,WAAW,qBAAqB;IAClC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,kBAAkB;IAC/B,gBAAgB,EAAE,MAAM,CAAA;IACxB,OAAO,EAAE,GAAG,CAAC;IAEb;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAE3B;;;;OAIG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,YAAY,CAAA;CACzD;AAED,MAAM,WAAW,kBAAkB,CAAC,IAAI,SAAS,cAAc,CAAC,IAAI,CAAC;IAEjE;;;;;OAKG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,kBAAkB;IAE/B;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,sBAAsB,GAAG,UAAU,GAAG,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,YAAY,CAAA;CAC5H;AAED,MAAM,WAAW,kBAAkB;IAC/B,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,eAAe,CAAC,EAAE,qBAAqB,CAAA;CAC1C;AAED,MAAM,WAAW,eAAe;IAE5B;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAAA;IAEhD;;;;OAIG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,YAAY,CAAA;IAEjE;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,MAAM,CAAA;CACvD;AAED,MAAM,WAAW,WAAW;IAExB;;;;OAIG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,YAAY,CAAA;IAEtD;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,YAAY,CAAA;CAC1D;AAED,MAAM,WAAW,oBAAoB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,kBAAkB,EAAE,MAAM,CAAC;CAC9B"}

package/dist/index.js

@@ -1,7 +1,10 @@
 "use strict";
-//#region Post-Login Event
+//#region Events
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChallengeTypes = void 0;
+/**
+ *
+ */
 var AuthenticationMethods;
 (function (AuthenticationMethods) {
     /** A social or enterprise connection was used to authenticate the user as the first factor. */
@@ -19,6 +22,9 @@ var AuthenticationMethods;
     /* "Used for internal testing. */
     AuthenticationMethods["mock"] = "mock";
 })(AuthenticationMethods || (AuthenticationMethods = {}));
+/**
+ *
+ */
 var ConnectionStrategies;
 (function (ConnectionStrategies) {
     ConnectionStrategies["ad"] = "ad";
@@ -83,6 +89,9 @@ var ConnectionStrategies;
     ConnectionStrategies["yammer"] = "yammer";
     ConnectionStrategies["yandex"] = "yandex";
 })(ConnectionStrategies || (ConnectionStrategies = {}));
+/**
+ *
+ */
 var TransactionProtocols;
 (function (TransactionProtocols) {
     TransactionProtocols["oidc_basic"] = "oidc-basic-profile";
@@ -110,5 +119,4 @@ var ChallengeTypes;
     ChallengeTypes["webauthn_roaming"] = "webauthn-roaming";
 })(ChallengeTypes || (exports.ChallengeTypes = ChallengeTypes = {}));
 //#endregion
-//notes: make a C# version too.
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";AACA,0BAA0B;;;AA+C1B,IAAK,qBAsBJ;AAtBD,WAAK,qBAAqB;IAEtB,+FAA+F;IAC/F,gDAAuB,CAAA;IAEvB,OAAO;IACP,4CAAmB,CAAA;IAEnB,mFAAmF;IACnF,oCAAW,CAAA;IAEX,2FAA2F;IAC3F,oCAAW,CAAA;IAEX,gIAAgI;IAChI,wCAAe,CAAA;IAEf,OAAO;IACP,oCAAW,CAAA;IAEX,iCAAiC;IACjC,sCAAa,CAAA;AACjB,CAAC,EAtBI,qBAAqB,KAArB,qBAAqB,QAsBzB;AAgDD,IAAK,oBA8DJ;AA9DD,WAAK,oBAAoB;IACrB,iCAAS,CAAA;IACT,qCAAa,CAAA;IACb,yCAAiB,CAAA;IACjB,uCAAe,CAAA;IACf,2CAAmB,CAAA;IACnB,+CAAuB,CAAA;IACvB,mCAAW,CAAA;IACX,iDAAyB,CAAA;IACzB,uCAAe,CAAA;IACf,uCAAe,CAAA;IACf,uCAAe,CAAA;IACf,mCAAW,CAAA;IACX,yCAAiB,CAAA;IACjB,6CAAqB,CAAA;IACrB,yCAAiB,CAAA;IACjB,uCAAe,CAAA;IACf,6DAAqC,CAAA;IACrC,6CAAqB,CAAA;IACrB,uCAAe,CAAA;IACf,6CAAqB,CAAA;IACrB,yCAAiB,CAAA;IACjB,yCAAiB,CAAA;IACjB,yCAAiB,CAAA;IACjB,mDAA2B,CAAA;IAC3B,uDAA+B,CAAA;IAC/B,+CAAuB,CAAA;IACvB,iCAAS,CAAA;IACT,qCAAa,CAAA;IACb,6CAAqB,CAAA;IACrB,2CAAmB,CAAA;IACnB,yCAAiB,CAAA;IACjB,yCAAiB,CAAA;IACjB,+CAAuB,CAAA;IACvB,qCAAa,CAAA;IACb,qCAAa,CAAA;IACb,yCAAiB,CAAA;IACjB,yDAAiC,CAAA;IACjC,qDAA6B,CAAA;IAC7B,yDAAiC,CAAA;IACjC,yCAAiB,CAAA;IACjB,qEAA6C,CAAA;IAC7C,iEAAyC,CAAA;IACzC,iDAAyB,CAAA;IACzB,uCAAe,CAAA;IACf,iDAAyB,CAAA;IACzB,2CAAmB,CAAA;IACnB,mCAAW,CAAA;IACX,iDAAyB,CAAA;IACzB,2DAAmC,CAAA;IACnC,2CAAmB,CAAA;IACnB,iEAAyC,CAAA;IACzC,2CAAmB,CAAA;IACnB,2CAAmB,CAAA;IACnB,+CAAuB,CAAA;IACvB,qCAAa,CAAA;IACb,uCAAe,CAAA;IACf,mDAA2B,CAAA;IAC3B,+CAAuB,CAAA;IACvB,uCAAe,CAAA;IACf,yCAAiB,CAAA;IACjB,yCAAiB,CAAA;AACrB,CAAC,EA9DI,oBAAoB,KAApB,oBAAoB,QA8DxB;AAqGD,IAAK,oBAeJ;AAfD,WAAK,oBAAoB;IACrB,yDAAiC,CAAA;IACjC,wJAAwJ;IACxJ,mDAA2B,CAAA;IAC3B,+DAAuC,CAAA;IACvC,uCAAe,CAAA;IACf,uCAAe,CAAA;IACf,uEAA+C,CAAA;IAC/C,iEAAyC,CAAA;IACzC,uEAA+C,CAAA;IAC/C,8EAAsD,CAAA;IACtD,2DAAmC,CAAA;IACnC,mEAA2C,CAAA;IAC3C,qEAA6C,CAAA;IAC7C,uEAA+C,CAAA;AACnD,CAAC,EAfI,oBAAoB,KAApB,oBAAoB,QAexB;AAwLD,IAAY,cAOX;AAPD,WAAY,cAAc;IACtB,6BAAW,CAAA;IACX,iCAAe,CAAA;IACf,iCAAe,CAAA;IACf,yDAAuC,CAAA;IACvC,yDAAuC,CAAA;IACvC,uDAAqC,CAAA;AACzC,CAAC,EAPW,cAAc,8BAAd,cAAc,QAOzB;AAmGD,YAAY;AAGZ,+BAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";AACA,gBAAgB;;;AA8GhB;;GAEG;AACH,IAAK,qBAsBJ;AAtBD,WAAK,qBAAqB;IAEtB,+FAA+F;IAC/F,gDAAuB,CAAA;IAEvB,OAAO;IACP,4CAAmB,CAAA;IAEnB,mFAAmF;IACnF,oCAAW,CAAA;IAEX,2FAA2F;IAC3F,oCAAW,CAAA;IAEX,gIAAgI;IAChI,wCAAe,CAAA;IAEf,OAAO;IACP,oCAAW,CAAA;IAEX,iCAAiC;IACjC,sCAAa,CAAA;AACjB,CAAC,EAtBI,qBAAqB,KAArB,qBAAqB,QAsBzB;AA6DD;;GAEG;AACH,IAAK,oBA8DJ;AA9DD,WAAK,oBAAoB;IACrB,iCAAS,CAAA;IACT,qCAAa,CAAA;IACb,yCAAiB,CAAA;IACjB,uCAAe,CAAA;IACf,2CAAmB,CAAA;IACnB,+CAAuB,CAAA;IACvB,mCAAW,CAAA;IACX,iDAAyB,CAAA;IACzB,uCAAe,CAAA;IACf,uCAAe,CAAA;IACf,uCAAe,CAAA;IACf,mCAAW,CAAA;IACX,yCAAiB,CAAA;IACjB,6CAAqB,CAAA;IACrB,yCAAiB,CAAA;IACjB,uCAAe,CAAA;IACf,6DAAqC,CAAA;IACrC,6CAAqB,CAAA;IACrB,uCAAe,CAAA;IACf,6CAAqB,CAAA;IACrB,yCAAiB,CAAA;IACjB,yCAAiB,CAAA;IACjB,yCAAiB,CAAA;IACjB,mDAA2B,CAAA;IAC3B,uDAA+B,CAAA;IAC/B,+CAAuB,CAAA;IACvB,iCAAS,CAAA;IACT,qCAAa,CAAA;IACb,6CAAqB,CAAA;IACrB,2CAAmB,CAAA;IACnB,yCAAiB,CAAA;IACjB,yCAAiB,CAAA;IACjB,+CAAuB,CAAA;IACvB,qCAAa,CAAA;IACb,qCAAa,CAAA;IACb,yCAAiB,CAAA;IACjB,yDAAiC,CAAA;IACjC,qDAA6B,CAAA;IAC7B,yDAAiC,CAAA;IACjC,yCAAiB,CAAA;IACjB,qEAA6C,CAAA;IAC7C,iEAAyC,CAAA;IACzC,iDAAyB,CAAA;IACzB,uCAAe,CAAA;IACf,iDAAyB,CAAA;IACzB,2CAAmB,CAAA;IACnB,mCAAW,CAAA;IACX,iDAAyB,CAAA;IACzB,2DAAmC,CAAA;IACnC,2CAAmB,CAAA;IACnB,iEAAyC,CAAA;IACzC,2CAAmB,CAAA;IACnB,2CAAmB,CAAA;IACnB,+CAAuB,CAAA;IACvB,qCAAa,CAAA;IACb,uCAAe,CAAA;IACf,mDAA2B,CAAA;IAC3B,+CAAuB,CAAA;IACvB,uCAAe,CAAA;IACf,yCAAiB,CAAA;IACjB,yCAAiB,CAAA;AACrB,CAAC,EA9DI,oBAAoB,KAApB,oBAAoB,QA8DxB;AAsMD;;GAEG;AACH,IAAK,oBAeJ;AAfD,WAAK,oBAAoB;IACrB,yDAAiC,CAAA;IACjC,wJAAwJ;IACxJ,mDAA2B,CAAA;IAC3B,+DAAuC,CAAA;IACvC,uCAAe,CAAA;IACf,uCAAe,CAAA;IACf,uEAA+C,CAAA;IAC/C,iEAAyC,CAAA;IACzC,uEAA+C,CAAA;IAC/C,8EAAsD,CAAA;IACtD,2DAAmC,CAAA;IACnC,mEAA2C,CAAA;IAC3C,qEAA6C,CAAA;IAC7C,uEAA+C,CAAA;AACnD,CAAC,EAfI,oBAAoB,KAApB,oBAAoB,QAexB;AAoPD,IAAY,cAOX;AAPD,WAAY,cAAc;IACtB,6BAAW,CAAA;IACX,iCAAe,CAAA;IACf,iCAAe,CAAA;IACf,yDAAuC,CAAA;IACvC,yDAAuC,CAAA;IACvC,uDAAqC,CAAA;AACzC,CAAC,EAPW,cAAc,8BAAd,cAAc,QAOzB;AAgHD,YAAY"}

package/index.ts

@@ -1,27 +1,87 @@
 
-//#region Post-Login Event
+//#region Events
 
-export interface PostLoginEvent<TSecret, TAppMetadata, TUserMetadata> {
-    /* Details about authentication signals obtained during the login flow. */
+/**
+ * 
+ */
+export interface CredentialsExchangeEvent<TSecret, TClientMetadata> {
+
+    /** An object containing information describing the authorization granted to the user who is logging in. */
+    accessToken?: AccessToken;
+
+    /**  */
+    client?: Client<TClientMetadata>;
+
+    /**  */
+    request?: RequestBase<CredentialsExchangeRequestBody>;
+
+    /**  */
+    resource_server?: ResourceServer;
+
+    /**  */
+    secrets?: TSecret;
+
+    /**  */
+    tenant?: Tenant;
+
+    /**  */
+    transaction?: TransactionBase;
+
+}
+
+/**
+ * 
+ */
+export interface PostLoginEvent<TSecret, TClientMetadata, TAppMetadata, TUserMetadata> {
+
+    /** Details about authentication signals obtained during the login flow. */
     authentication?: AuthenticationInfoWithRiskAssessment
-    /* An object containing information describing the authorization granted to the user who is logging in. */
+
+    /** An object containing information describing the authorization granted to the user who is logging in. */
     authorization?: AuthorizationInfo;
-    /* True if the event was created with the cancelable option */
-    cancelable?: boolean;
-    client?: Client;
+
+    /**  */
+    client?: Client<TClientMetadata>;
+
+    /**  */
     configuration?: Configuration;
+
+    /**  */
     connection?: Connection;
+
+    /**  */
     organization?: Organization;
-    request?: RequestBase;
+
+    /**  */
+    request?: Request<any>;
+
+    /**  */
     resource_server?: ResourceServer;
+
+    /**  */
     secrets?: TSecret;
+
+    /**  */
     stats?: Stats;
+
+    /**  */
     tenant?: Tenant;
+
+    /**  */
     transaction?: Transaction;
+
+    /**  */
     user?: UserBase<TAppMetadata, TUserMetadata>;
 }
 
+/**
+ * 
+ */
+interface AccessToken {
 
+    customClaims: any;
+    scope: string[];
+}
 
 /**
  * Details about authentication signals obtained during the login flow.
@@ -31,9 +91,12 @@ interface AuthenticationInfoWithRiskAssessment {
     /** Contains the authentication methods a user has completed during their session. */
     methods: AuthenticationMethod[];
 
-    riskAssessment?: RiskAssessmentInfo;
+    riskAssessment?: RiskAssessmentSummary;
 }
 
+/**
+ * 
+ */
 interface AuthenticationMethod {
     /**
      * The name of the first factor that was completed. Values include the following:
@@ -46,6 +109,9 @@ interface AuthenticationMethod {
     type: string;
 }
 
+/**
+ * 
+ */
 enum AuthenticationMethods {
 
     /** A social or enterprise connection was used to authenticate the user as the first factor. */
@@ -70,28 +136,41 @@ enum AuthenticationMethods {
     mock = 'mock'
 }
 
+/**
+ * 
+ */
 interface AuthorizationInfo {
     roles: string[];
 }
 
-interface Client {
+/**
+ * 
+ */
+interface Client<TMetadata> {
 
-    /* The client id of the application the user is logging in to. */
+    /** The client id of the application the user is logging in to. */
     clientId: string;
 
-    /* An object for holding other application properties. */
-    metadata: { [additionalProperties: string]: string; };
+    /** An object for holding other application properties. */
+    metadata: TMetadata
 
-    /* The name of the application (as defined in the Dashboard). */
+    /** The name of the application (as defined in the Dashboard). */
     name: string;
 
+    /**  */
     strategy: string;
 }
 
+/**
+ * 
+ */
 interface Configuration {
 
 }
 
+/**
+ * 
+ */
 interface Connection {
 
     /**
@@ -116,6 +195,9 @@ interface Connection {
 
 }
 
+/**
+ * 
+ */
 enum ConnectionStrategies {
     ad = 'ad',
     adfs = 'adfs',
@@ -180,6 +262,19 @@ enum ConnectionStrategies {
     yandex = 'yandex',
 }
 
+/**
+ * 
+ */
+interface CredentialsExchangeRequestBody {
+    audience: string;
+    client_id: string;
+    client_secret: string;
+    grant_type: string;
+}
+
+/**
+ * 
+ */
 interface GeoIP {
     cityName: string
     continentCode: string
@@ -193,6 +288,9 @@ interface GeoIP {
     timeZone: string
 }
 
+/**
+ * 
+ */
 interface Identity {
     connection: string
     isSocial: boolean
@@ -201,6 +299,27 @@ interface Identity {
     user_id: string
 }
 
+/**
+ * 
+ */
+interface IPAddressDetails {
+    category: string;
+    ip: string;
+    matches: string;
+    source: string;
+}
+
+/**
+ * 
+ */
+interface NewDeviceDetails {
+    device: string;
+    useragent: string;
+}
+
+/**
+ * 
+ */
 interface Organization {
 
     /* The friendly name of the Organization. */
@@ -223,6 +342,9 @@ interface Organization {
 
 }
 
+/**
+ * 
+ */
 interface Query {
     audience: string
     client_id: string
@@ -236,35 +358,86 @@ interface Query {
     state: string
 }
 
-interface RequestBase {
-    ip: string;
-    method: string;
+/**
+ * 
+ */
+interface Request<TBody> extends RequestBase<TBody> {
     query: Query;
-    body: RequestBody;
+}
+
+/**
+ * 
+ */
+interface RequestBase<TBody> {
+    body: TBody;
     geoip: GeoIP;
     hostname: string;
+    ip: string;
+    method: string;
     user_agent: string;
 }
 
-interface RequestBody { }
-
+/**
+ * 
+ */
 interface ResourceServer {
     identifier: string
 }
 
-interface RiskAssessmentInfo {
+interface RiskAssessmentBase {
+
+    code: string;
+
+    confidence: string;
+}
+
+/**
+ * 
+ */
+interface RiskAssessmentSummary {
+    assessments: RiskAssessments;
     confidence: "low" | "medium" | "high" | "neutral";
     version: string;
 }
 
+/**
+ * 
+ */
+interface RiskAssessments {
+
+    ImpossibleTravel: RiskAssessmentBase;
+
+    NewDevice: RiskAssessmentWithDetails<NewDeviceDetails>
+
+    UntrustedIP: RiskAssessmentWithDetails<IPAddressDetails>
+}
+
+/**
+ * 
+ */
+interface RiskAssessmentWithDetails<TDetails> {
+
+    details: TDetails;
+}
+
+/**
+ * 
+ */
 interface Stats {
     logins_count: number
 }
 
+/**
+ * 
+ */
 interface Tenant {
     id: string
 }
-interface Transaction {
+
+/**
+ * 
+ */
+interface Transaction extends TransactionBase {
     acr_values: any[]
     linking_id?: string
     locale: string
@@ -272,13 +445,22 @@ interface Transaction {
     prompt: string[]
     protocol?: TransactionProtocols
     redirect_uri?: string
-    requested_scopes: string[]
     response_mode?: string
     response_type?: string[]
     state?: string
     ui_locales: string[]
 }
 
+/**
+ * 
+ */
+interface TransactionBase {
+    requested_scopes: string[]
+}
+
+/**
+ * 
+ */
 enum TransactionProtocols {
     oidc_basic = 'oidc-basic-profile',
     /*  Allows your application to have immediate access to an ID token while still providing for secure and safe retrieval of access and refresh tokens. */
@@ -296,40 +478,79 @@ enum TransactionProtocols {
     oauth2_token_exchange = 'oauth2-token-exchange',
 }
 
+/**
+ * 
+ */
+export interface UserBase<TAppMetadata, TUserMetadata> {
+
+    /** Data that the user has read-only access to (e.g. roles, permissions, vip, etc) */
+    app_metadata: TAppMetadata
 
-export interface UserBase<AppMetadata, UserMetadata> {
-    app_metadata: AppMetadata
+    /**  */
     created_at: string
+
+    /**  */
     email: string
+
+    /**  */
     email_verified: boolean
+
+    /**  */
     family_name: string
+
+    /**  */
     given_name: string
+
+    /**  */
     identities: Identity[]
+
+    /**  */
     last_password_reset?: string
+
+    /**  */
     multifactor?: string[]
+
+    /**  */
     name: string
+
+    /**  */
     nickname: string
+
+    /**  */
     phone_number?: string
+
+    /**  */
     phone_verified?: boolean
+
+    /**  */
     picture: string
+
+    /**  */
     updated_at: string
+
+    /**  */
     user_id: string
-    user_metadata: UserMetadata
+
+    /** Data that the user has read/write access to (e.g. color_preference, blog_url, etc.) */
+    user_metadata: TUserMetadata
+
+    /**  */
     username?: string
 }
 
 //#endregion
 
-//#region Post-Login API
+//#region Actions APIs
 
-export interface PostLoginApi {
+export interface PostLoginApi extends ActionsApiBase<PostLoginApi> {
 
     /** Modify the user's login access, such as by rejecting the login attempt. */
-    access: LoginAccessManager;
+    access: LoginAccessManager<PostLoginApi>;
 
     /** Request changes to the access token being issued. */
-    accessToken: AccessTokenManager;
+    accessToken: AccessTokenManager<PostLoginApi>;
 
+    /**  */
     authentication: AuthenticationManager;
 
     /** Store and retrieve data that persists across executions. */
@@ -348,26 +569,43 @@ export interface PostLoginApi {
     user: UserManager;
 }
 
-export interface AccessTokenManager {
+export interface AccessTokenManager<TApi extends ActionsApiBase<TApi>> extends AccessTokenManagerBase<TApi> {
 
     /**
      * Add a scope on the Access Token that will be issued upon completion of the login flow.
      * @param scope The scope to be added.
      */
-    addScope(scope: string): PostLoginApi;
+    addScope(scope: string): TApi;
 
     /**
      * Remove a scope on the Access Token that will be issued upon completion of the login flow.
      * @param scope The scope to be removed.
      */
-    removeScope(scope: string): PostLoginApi;
+    removeScope(scope: string): TApi;
+
+}
+
+export interface AccessTokenManagerBase<TApi extends ActionsApiBase<TApi>> {
 
     /**
      * Set a custom claim on the Access Token that will be issued upon completion of the login flow.
      * @param name Name of the claim (note that this may need to be a fully-qualified URL).
      * @param value The value of the claim.
      */
-    setCustomClaim(name: string, value: any): PostLoginApi;
+    setCustomClaim(name: string, value: any): TApi;
+}
+
+export interface ActionsApiBase<TApi extends ActionsApiBase<TApi>> {
+
+    /** Modify the user's login access, such as by rejecting the login attempt. */
+    access: LoginAccessManager<TApi>;
+
+    /** Request changes to the access token being issued. */
+    accessToken: AccessTokenManagerBase<TApi>;
+
+    /** Store and retrieve data that persists across executions. */
+    cache: CacheManager;
+
 }
 
 export interface AuthenticationManager {
@@ -431,7 +669,11 @@ export interface CacheManager {
 }
 
 export interface CacheWriteResult {
+
+    /**  */
     type: 'success' | 'error'
+
+    /** If @see type = 'error', then the error code will be populated here. */
     code: string
 }
 
@@ -487,6 +729,19 @@ export enum ChallengeTypes {
     webauthn_roaming = 'webauthn-roaming'
 }
 
+export interface CredentialsExchangeApi extends ActionsApiBase<CredentialsExchangeApi> {
+
+    /** Control availability to the access token. */
+    access: LoginAccessManager<CredentialsExchangeApi>;
+
+    /** Request changes to the access token being issued. */
+    accessToken: AccessTokenManagerBase<CredentialsExchangeApi>;
+
+    /** Store and retrieve data that persists across executions. */
+    cache: CacheManager;
+
+}
+
 export interface DuoMultifactorOptions {
     host: string
     ikey: string
@@ -514,7 +769,7 @@ export interface IdTokenManager {
     setCustomClaim(name: string, value: any): PostLoginApi
 }
 
-export interface LoginAccessManager {
+export interface LoginAccessManager<TApi extends ActionsApiBase<TApi>> {
 
     /**
      * Mark the current login attempt as denied. This will prevent the end-user from completing the login flow. This will NOT cancel other user-related 
@@ -522,7 +777,7 @@ export interface LoginAccessManager {
      * and no further Actions will be executed.
      * @param reason A human-readable explanation for rejecting the login. This may be presented directly in end-user interfaces.
      */
-    deny(reason: string): PostLoginApi;
+    deny(reason: string): TApi;
 }
 
 export interface MultifactorManager {
@@ -585,6 +840,3 @@ export interface ValidateTokenOptions {
 }
 
 //#endregion
-
-
-//notes: make a C# version too.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auth0-actions",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Type definitions and utilities for building Auth0 Actions.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",