@thunderid/javascript 1.11.0 → 1.12.0

package/dist/models/embedded-self-flow.d.ts

@@ -0,0 +1,75 @@
+import { EmbeddedFlowComponent, EmbeddedFlowResponseData, EmbeddedFlowResponseType, EmbeddedFlowType, FlowExecutionError } from './embedded-flow';
+/**
+ * Status of a `SELF` flow step.
+ *
+ * @experimental Part of the new ThunderID API
+ */
+export declare enum EmbeddedSelfFlowStatus {
+    /**
+     * The flow completed, for example a verification was recorded.
+     */
+    Complete = "COMPLETE",
+    /**
+     * The server refused the operation.
+     */
+    Error = "ERROR",
+    /**
+     * The flow needs more input, such as the emailed code.
+     */
+    Incomplete = "INCOMPLETE"
+}
+/**
+ * Response of a `SELF` flow.
+ *
+ * @experimental Part of the new ThunderID API
+ */
+export interface EmbeddedSelfFlowResponse {
+    /**
+     * Per-step challenge token, sent back on the next request when present.
+     */
+    challengeToken?: string;
+    /**
+     * Step data. In self attribute verification, `additionalData.maskedDestination` names where the code was sent.
+     */
+    data?: EmbeddedFlowResponseData & {
+        components?: EmbeddedFlowComponent[];
+    };
+    /**
+     * Structured error details when `flowStatus` is `ERROR`, or when a code was rejected.
+     */
+    error?: FlowExecutionError;
+    /**
+     * Identifier of this flow execution.
+     */
+    executionId: string;
+    /**
+     * Current status of the flow.
+     */
+    flowStatus: EmbeddedSelfFlowStatus;
+    /**
+     * Type of the step.
+     */
+    type?: EmbeddedFlowResponseType;
+}
+/**
+ * Request that starts or continues a `SELF` flow.
+ *
+ * @experimental Part of the new ThunderID API
+ */
+export interface EmbeddedSelfFlowRequest {
+    action?: string;
+    challengeToken?: string;
+    executionId?: string;
+    flowType?: EmbeddedFlowType.Self;
+    /**
+     * Handle of the `SELF` flow to start, such as `default-self-attribute-verification-flow`.
+     * Required on the request that starts a flow.
+     */
+    handle?: string;
+    /**
+     * Inputs of the step, such as `{attribute: 'email'}` on the request that starts self attribute
+     * verification.
+     */
+    inputs?: Record<string, string>;
+}
+//# sourceMappingURL=embedded-self-flow.d.ts.map

package/dist/models/embedded-self-flow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"embedded-self-flow.d.ts","sourceRoot":"","sources":["../../src/models/embedded-self-flow.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,qBAAqB,EACrB,wBAAwB,EACxB,wBAAwB,EACxB,gBAAgB,EAChB,kBAAkB,EACnB,MAAM,iBAAiB,CAAC;AAEzB;;;;GAIG;AACH,oBAAY,sBAAsB;IAChC;;OAEG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,KAAK,UAAU;IAEf;;OAEG;IACH,UAAU,eAAe;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,wBAAwB,GAAG;QAAC,UAAU,CAAC,EAAE,qBAAqB,EAAE,CAAA;KAAC,CAAC;IAEzE;;OAEG;IACH,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAE3B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,sBAAsB,CAAC;IAEnC;;OAEG;IACH,IAAI,CAAC,EAAE,wBAAwB,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,gBAAgB,CAAC,IAAI,CAAC;IACjC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC"}

package/dist/models/extensions/components.d.ts

@@ -6,7 +6,7 @@ import { FlowMetadataResponse } from '../flow-meta';
  */
 export interface ComponentRenderContext {
     additionalData?: Record<string, any>;
-    authType: 'signin' | 'signup' | 'recovery';
+    authType: 'signin' | 'signup' | 'recovery' | 'verification';
     formErrors: Record<string, string>;
     formValues: Record<string, string>;
     isFormValid: boolean;

package/dist/models/extensions/components.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../../src/models/extensions/components.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,qBAAqB,EAAC,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAC,oBAAoB,EAAC,MAAM,cAAc,CAAC;AAElD;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACrC,QAAQ,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC;IAC3C,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;IACnC,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACrC,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACrD,QAAQ,CAAC,EAAE,CAAC,SAAS,EAAE,qBAAqB,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,cAAc,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IAC5G,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACxC;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,SAAS,EAAE,qBAAqB,EAAE,OAAO,EAAE,sBAAsB,KAAK,OAAO,CAAC;AAE/G;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAErE;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,EAAE,oBAAoB,CAAC;CAClC"}
+{"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../../src/models/extensions/components.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,qBAAqB,EAAC,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAC,oBAAoB,EAAC,MAAM,cAAc,CAAC;AAElD;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACrC,QAAQ,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,cAAc,CAAC;IAC5D,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;IACnC,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACrC,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACrD,QAAQ,CAAC,EAAE,CAAC,SAAS,EAAE,qBAAqB,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,cAAc,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IAC5G,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACxC;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,SAAS,EAAE,qBAAqB,EAAE,OAAO,EAAE,sBAAsB,KAAK,OAAO,CAAC;AAE/G;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAErE;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,EAAE,oBAAoB,CAAC;CAClC"}

package/dist/models/user.d.ts

@@ -12,4 +12,13 @@ export interface UserProfile {
     flattenedProfile: User;
     profile: User;
 }
+/**
+ * Verification record of one of the user's attributes, as returned in `/users/me`.
+ */
+export interface VerifiedAttribute {
+    /**
+     * When the attribute's current value was verified, as an RFC 3339 timestamp.
+     */
+    verifiedAt: string;
+}
 //# sourceMappingURL=user.d.ts.map

package/dist/models/user.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/models/user.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,SAAS;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,IAAK,SAAQ,SAAS;IACrC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,gBAAgB,EAAE,IAAI,CAAC;IACvB,OAAO,EAAE,IAAI,CAAC;CACf"}
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/models/user.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,SAAS;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,IAAK,SAAQ,SAAS;IACrC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,gBAAgB,EAAE,IAAI,CAAC;IACvB,OAAO,EAAE,IAAI,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB"}

package/dist/utils/getFlowStepComponents.d.ts

@@ -0,0 +1,26 @@
+import { EmbeddedFlowComponent } from '../models/embedded-flow';
+/**
+ * The components of a flow step that collect a value or submit the step.
+ */
+export interface FlowStepComponents {
+    /** Components that submit the step, the resend action included. */
+    actions: EmbeddedFlowComponent[];
+    /** Components that collect a value. */
+    inputs: EmbeddedFlowComponent[];
+    /** The step's resend action, if it has one. */
+    resend?: EmbeddedFlowComponent;
+}
+/**
+ * Collects the inputs and actions of a flow step, nested components included, in document order.
+ *
+ * @param components - The step's components.
+ * @returns The step's inputs, actions and resend action.
+ * @example
+ * ```typescript
+ * const {actions, inputs} = getFlowStepComponents(response.data.components);
+ * const isAwaitingLink = inputs.length === 0 && actions.length === 0;
+ * ```
+ */
+declare const getFlowStepComponents: (components: EmbeddedFlowComponent[], step?: FlowStepComponents) => FlowStepComponents;
+export default getFlowStepComponents;
+//# sourceMappingURL=getFlowStepComponents.d.ts.map

package/dist/utils/getFlowStepComponents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getFlowStepComponents.d.ts","sourceRoot":"","sources":["../../src/utils/getFlowStepComponents.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,qBAAqB,EAA4B,MAAM,yBAAyB,CAAC;AAgBzF;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,mEAAmE;IACnE,OAAO,EAAE,qBAAqB,EAAE,CAAC;IACjC,uCAAuC;IACvC,MAAM,EAAE,qBAAqB,EAAE,CAAC;IAChC,+CAA+C;IAC/C,MAAM,CAAC,EAAE,qBAAqB,CAAC;CAChC;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,qBAAqB,GACzB,YAAY,qBAAqB,EAAE,EACnC,OAAM,kBAA8C,KACnD,kBAQF,CAAC;AAEF,eAAe,qBAAqB,CAAC"}

package/dist/utils/getVerifiedAttributes.d.ts

@@ -0,0 +1,14 @@
+import { User, VerifiedAttribute } from '../models/user';
+/**
+ * Returns the verified attributes of a `/users/me` profile, keyed by attribute name.
+ *
+ * A profile without the field, from a server that does not report verification, leaves every status
+ * unknown, so the result is `undefined` rather than an empty record that would read as unverified.
+ *
+ * @param user - The profile to read.
+ * @returns The verified attributes, an empty object when none is verified, or `undefined` when the
+ * profile does not report them.
+ */
+declare const getVerifiedAttributes: (user?: User | null) => Record<string, VerifiedAttribute> | undefined;
+export default getVerifiedAttributes;
+//# sourceMappingURL=getVerifiedAttributes.d.ts.map

package/dist/utils/getVerifiedAttributes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getVerifiedAttributes.d.ts","sourceRoot":"","sources":["../../src/utils/getVerifiedAttributes.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,IAAI,EAAE,iBAAiB,EAAC,MAAM,gBAAgB,CAAC;AAEvD;;;;;;;;;GASG;AACH,QAAA,MAAM,qBAAqB,GAAI,OAAO,IAAI,GAAG,IAAI,KAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,SAMvF,CAAC;AAEF,eAAe,qBAAqB,CAAC"}

package/dist/utils/isVerifiableAttribute.d.ts

@@ -0,0 +1,22 @@
+import { AttributeSchema } from '../api/account/getUsersMeMeta';
+/**
+ * Whether the signed-in user can verify the given attribute: a top-level, single-valued property of
+ * type `email` or `mobile` in the user type schema from `GET /users/me/meta`.
+ *
+ * Schema keys are top-level properties, and a multi-valued property has type `array`, so both are
+ * settled by the property's own type. An absent schema, or one without the attribute, leaves the
+ * type unknown and resolves to `false`, so no verification is started on missing information.
+ *
+ * @param userSchema - The user type schema resolved by the provider, keyed by attribute.
+ * @param attribute - The attribute to check (e.g. `email`).
+ * @returns `true` only when the schema declares `attribute` with a verifiable type.
+ * @example
+ * ```typescript
+ * if (!isVerifiableAttribute(userSchema, 'given_name')) {
+ *   return null;
+ * }
+ * ```
+ */
+declare const isVerifiableAttribute: (userSchema: Record<string, AttributeSchema> | null | undefined, attribute: string) => boolean;
+export default isVerifiableAttribute;
+//# sourceMappingURL=isVerifiableAttribute.d.ts.map

package/dist/utils/isVerifiableAttribute.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isVerifiableAttribute.d.ts","sourceRoot":"","sources":["../../src/utils/isVerifiableAttribute.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,eAAe,EAAC,MAAM,+BAA+B,CAAC;AAG9D;;;;;;;;;;;;;;;;;GAiBG;AACH,QAAA,MAAM,qBAAqB,GACzB,YAAY,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,GAAG,IAAI,GAAG,SAAS,EAC9D,WAAW,MAAM,KAChB,OAUF,CAAC;AAEF,eAAe,qBAAqB,CAAC"}

package/dist/utils/parseSelfFlowRequest.d.ts

@@ -0,0 +1,24 @@
+import { EmbeddedSelfFlowRequest } from '../models/embedded-self-flow';
+/**
+ * Result of {@link parseSelfFlowRequest}: the request to send, or the field that made it invalid.
+ */
+export type SelfFlowRequestParseResult = {
+    invalid: string;
+} | {
+    request: EmbeddedSelfFlowRequest;
+};
+/**
+ * Checks a `SELF` flow step that a browser sent to a server-side SDK, which attaches the
+ * session's access token before forwarding it. Such an endpoint is public, so its types protect
+ * nothing.
+ *
+ * Only the fields of a step are kept, so a caller cannot add a user or application identifier. A
+ * request without an `executionId` starts a flow, and must name a `SELF` flow by its handle,
+ * so the endpoint cannot start a flow of another type with the user's token.
+ *
+ * @param raw - The request body as received.
+ * @returns The request to send, or the name of the first invalid field.
+ */
+declare const parseSelfFlowRequest: (raw: unknown) => SelfFlowRequestParseResult;
+export default parseSelfFlowRequest;
+//# sourceMappingURL=parseSelfFlowRequest.d.ts.map

package/dist/utils/parseSelfFlowRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseSelfFlowRequest.d.ts","sourceRoot":"","sources":["../../src/utils/parseSelfFlowRequest.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,uBAAuB,EAAC,MAAM,8BAA8B,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IAAC,OAAO,EAAE,MAAM,CAAA;CAAC,GAAG;IAAC,OAAO,EAAE,uBAAuB,CAAA;CAAC,CAAC;AAUhG;;;;;;;;;;;GAWG;AACH,QAAA,MAAM,oBAAoB,GAAI,KAAK,OAAO,KAAG,0BA8B5C,CAAC;AAEF,eAAe,oBAAoB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thunderid/javascript",
-  "version": "1.11.0",
+  "version": "1.12.0",
   "description": "JavaScript Ecosystem SDK for ThunderID",
   "keywords": [
     "thunderid",