@autentikar/step 2.1.0-alpha.9 → 2.2.0

package/dist/context.d.ts

@@ -1,4 +1,4 @@
-import { S as StorageItem, a as Step } from './index-TuXvg1vy.js';
+import { S as StorageItem, a as Step } from './index-zegUAOjx.js';
 import 'file-type/core';
 import 'zod';
 
@@ -23,7 +23,26 @@ interface Preference {
 
 interface System {
     get<TValue = unknown>(name: string): Promise<TValue | undefined>;
+    /**
+     * Get the current stage of the step system.
+     * This method returns a string representing the current stage of the step system.
+     */
     stage(): string;
+    /**
+     * Get the current organization environment.
+     */
+    environment(): "PRODUCTION" | "SANDBOX" | "PREVIEW";
+    /**
+     * Dispatch a method to the step system.
+     * This method is used to trigger actions or events within the step system.
+     * It is typically used to execute a specific action or to notify the system of an event
+     */
+    dispatchStepMethod(method: string): Promise<void>;
+    /**
+     * Put an object in the step system. public access to the step system.
+     */
+    putObject<TValue = unknown>(name: string, value: TValue): Promise<void>;
+    getObject<TValue = unknown>(name: string): Promise<TValue | undefined>;
 }
 
 declare let step: Step;

package/dist/{index-TuXvg1vy.d.ts → index-zegUAOjx.d.ts}

@@ -8,7 +8,9 @@ interface Step {
     /** @deprecated Use addStepData*/
     identity(organization_id: string, instance_id: string, link_session: string | undefined, identity: IdentityDto, data: StepIdentityData): Promise<any>;
     addStepData(link_session: string | undefined, identity: IdentityDto, data: StepIdentityData): Promise<any>;
-    getStepData(type: StepIdentityData["type"], link_session: string | undefined): Promise<StepIdentityData | undefined>;
+    getStepData<T extends StepIdentityData["type"]>(type: T, link_session: string | undefined): Promise<Extract<StepIdentityData, {
+        type: T;
+    }> | undefined>;
     addVendorStat(params: {
         vendor: string;
         service: string;
@@ -20,7 +22,6 @@ interface Step {
 
 interface AutentikarRequestInit extends RequestInit {
     host: string;
-    staging: Staging;
     organization?: {
         id: string;
         alias: string;
@@ -38,11 +39,14 @@ interface AutentikarRequestInit extends RequestInit {
     output?: Record<string, string>;
     link_session: string | undefined;
     params?: unknown;
+    /** @deprecated */
+    staging: Staging;
 }
 declare class AutentikarRequest extends Request {
     readonly organization?: AutentikarRequestInit["organization"];
     readonly step?: AutentikarRequestInit["step"];
     readonly instance?: AutentikarRequestInit["instance"];
+    /** @deprecated use system.stage();. */
     readonly staging?: Staging;
     readonly link_session: string | undefined;
     readonly params?: unknown;
@@ -85,6 +89,7 @@ type StepIdentityData = {
         front: string;
         back?: string;
     };
+    expiration_date?: string;
 } | {
     type: "CARD";
     doc_type: IdentityDto["doc_type"];
@@ -110,12 +115,15 @@ type StepIdentityData = {
     type: "CONSENT";
     value: "OWN" | "AUTENTIKAR" | "NONE";
     text?: string;
+    consent_id: string;
 };
 declare class StepRequest implements Step {
     private step;
     constructor(params: Step);
     addStepData(link_session: string | undefined, identity: IdentityDto, data: StepIdentityData): Promise<any>;
-    getStepData(type: StepIdentityData["type"], link_session: string | undefined): Promise<StepIdentityData | undefined>;
+    getStepData<T extends StepIdentityData["type"]>(type: T, link_session: string | undefined): Promise<Extract<StepIdentityData, {
+        type: T;
+    }> | undefined>;
     addVendorStat(params: {
         vendor: string;
         service: string;
@@ -180,6 +188,7 @@ declare class StorageItem {
 }
 type Method = (req: AutentikarRequest) => Promise<AutentikarResponse>;
 type Resource = (req: AutentikarRequest) => Promise<AutentikarResponse>;
+type StepEvent = (req: AutentikarRequest) => Promise<AutentikarResponse>;
 type AppEnvVariables = {
     instance: {
         id: string;
@@ -238,4 +247,4 @@ declare class StepContext {
     isExpired(): boolean | 0 | undefined;
 }
 
-export { AutentikarRequest as A, FlowContext as F, IdentitySchemaDto as I, type MethodContextOrganization as M, type PersistentType as P, type Resource as R, StorageItem as S, type Step as a, AutentikarResponse as b, type StepIdentityData as c, StepRequest as d, type IdentityDto as e, type AppEnvironments as f, type Staging as g, type MethodContextFlow as h, type MethodContextInstance as i, type MethodContextStep as j, type Method as k, type AppEnvVariables as l, type AppEnv as m, StepDefinition as n, StepInstance as o, StepContext as p };
+export { AutentikarRequest as A, FlowContext as F, IdentitySchemaDto as I, type MethodContextOrganization as M, type PersistentType as P, type Resource as R, StorageItem as S, type Step as a, AutentikarResponse as b, type StepIdentityData as c, StepRequest as d, type IdentityDto as e, type AppEnvironments as f, type Staging as g, type MethodContextFlow as h, type MethodContextInstance as i, type MethodContextStep as j, type Method as k, type StepEvent as l, type AppEnvVariables as m, type AppEnv as n, StepDefinition as o, StepInstance as p, StepContext as q };

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 import 'file-type/core';
 import 'zod';
-export { m as AppEnv, l as AppEnvVariables, f as AppEnvironments, A as AutentikarRequest, b as AutentikarResponse, F as FlowContext, e as IdentityDto, I as IdentitySchemaDto, k as Method, h as MethodContextFlow, i as MethodContextInstance, M as MethodContextOrganization, j as MethodContextStep, P as PersistentType, R as Resource, g as Staging, p as StepContext, n as StepDefinition, c as StepIdentityData, o as StepInstance, d as StepRequest, S as StorageItem } from './index-TuXvg1vy.js';
+export { n as AppEnv, m as AppEnvVariables, f as AppEnvironments, A as AutentikarRequest, b as AutentikarResponse, F as FlowContext, e as IdentityDto, I as IdentitySchemaDto, k as Method, h as MethodContextFlow, i as MethodContextInstance, M as MethodContextOrganization, j as MethodContextStep, P as PersistentType, R as Resource, g as Staging, q as StepContext, o as StepDefinition, l as StepEvent, c as StepIdentityData, p as StepInstance, d as StepRequest, S as StorageItem } from './index-zegUAOjx.js';

package/dist/index.js

@@ -49,6 +49,7 @@ var AutentikarRequest = class extends Request {
   organization;
   step;
   instance;
+  /** @deprecated use system.stage();. */
   staging;
   link_session;
   params;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autentikar/step",
-  "version": "2.1.0-alpha.9",
+  "version": "2.2.0",
   "description": "",
   "files": [
     "dist"