@forgerock/davinci-client 0.0.0-beta-20250414111925 → 0.0.0-beta-20250414113129

package/dist/src/lib/collector.types.d.ts

@@ -0,0 +1,255 @@
+/** *********************************************************************
+ * SINGLE-VALUE COLLECTORS
+ */
+/**
+ * @interface SingleValueCollector - Represents a request to collect a single value from the user, like email or password.
+ */
+export type SingleValueCollectorTypes = 'PasswordCollector' | 'SingleValueCollector' | 'SingleSelectCollector' | 'TextCollector' | 'ValidatedTextCollector';
+interface SelectorOptions {
+    label: string;
+    value: string;
+}
+interface ValidationRequired {
+    type: 'required';
+    message: string;
+    rule: boolean;
+}
+interface ValidationRegex {
+    type: 'regex';
+    message: string;
+    rule: string;
+}
+export interface SingleValueCollectorWithValue<T extends SingleValueCollectorTypes> {
+    category: 'SingleValueCollector';
+    error: string | null;
+    type: T;
+    id: string;
+    name: string;
+    input: {
+        key: string;
+        value: string | number | boolean;
+        type: string;
+    };
+    output: {
+        key: string;
+        label: string;
+        type: string;
+        value: string | number | boolean;
+    };
+}
+export interface ValidatedSingleValueCollectorWithValue<T extends SingleValueCollectorTypes> {
+    category: 'ValidatedSingleValueCollector';
+    error: string | null;
+    type: T;
+    id: string;
+    name: string;
+    input: {
+        key: string;
+        value: string | number | boolean;
+        type: string;
+        validation: (ValidationRequired | ValidationRegex)[];
+    };
+    output: {
+        key: string;
+        label: string;
+        type: string;
+        value: string | number | boolean;
+    };
+}
+export interface SingleSelectCollectorWithValue<T extends SingleValueCollectorTypes> {
+    category: 'SingleValueCollector';
+    error: string | null;
+    type: T;
+    id: string;
+    name: string;
+    input: {
+        key: string;
+        value: string | number | boolean;
+        type: string;
+    };
+    output: {
+        key: string;
+        label: string;
+        type: string;
+        value: string | number | boolean;
+        options: SelectorOptions[];
+    };
+}
+export interface SingleValueCollectorNoValue<T extends SingleValueCollectorTypes> {
+    category: 'SingleValueCollector';
+    error: string | null;
+    type: T;
+    id: string;
+    name: string;
+    input: {
+        key: string;
+        value: string | number | boolean;
+        type: string;
+    };
+    output: {
+        key: string;
+        label: string;
+        type: string;
+    };
+}
+export interface SingleSelectCollectorNoValue<T extends SingleValueCollectorTypes> {
+    category: 'SingleValueCollector';
+    error: string | null;
+    type: T;
+    id: string;
+    name: string;
+    input: {
+        key: string;
+        value: string | number | boolean;
+        type: string;
+    };
+    output: {
+        key: string;
+        label: string;
+        type: string;
+        options: SelectorOptions[];
+    };
+}
+/**
+ * Type to help infer the collector based on the collector type
+ * Used specifically in the returnSingleValueCollector wrapper function.
+ * When given a type, it can narrow which type it is returning
+ *
+ * Note: You can see this type in action in the test file or in the collector.utils file.
+ */
+export type InferSingleValueCollectorType<T extends SingleValueCollectorTypes> = T extends 'TextCollector' ? TextCollector : T extends 'SingleSelectCollector' ? SingleSelectCollector : T extends 'PasswordCollector' ? PasswordCollector : SingleValueCollectorWithValue<'SingleValueCollector'> | SingleValueCollectorNoValue<'SingleValueCollector'>;
+/**
+ * SINGLE-VALUE COLLECTOR TYPES
+ */
+export type SingleValueCollector<T extends SingleValueCollectorTypes> = SingleValueCollectorWithValue<T> | SingleValueCollectorNoValue<T>;
+export type SingleValueCollectors = SingleValueCollectorNoValue<'PasswordCollector'> | SingleSelectCollectorWithValue<'SingleSelectCollector'> | SingleValueCollectorWithValue<'SingleValueCollector'> | SingleValueCollectorWithValue<'TextCollector'> | ValidatedSingleValueCollectorWithValue<'TextCollector'>;
+export type PasswordCollector = SingleValueCollectorNoValue<'PasswordCollector'>;
+export type TextCollector = SingleValueCollectorWithValue<'TextCollector'>;
+export type SingleSelectCollector = SingleSelectCollectorWithValue<'SingleSelectCollector'>;
+export type ValidatedTextCollector = ValidatedSingleValueCollectorWithValue<'TextCollector'>;
+/** *********************************************************************
+ * MULTI-VALUE COLLECTORS
+ */
+/**
+ * @interface MultiValueCollector - Represents a request to collect a single value from the user, like email or password.
+ */
+export type MultiValueCollectorTypes = 'MultiSelectCollector' | 'MultiValueCollector';
+export interface MultiValueCollectorWithValue<T extends MultiValueCollectorTypes> {
+    category: 'MultiValueCollector';
+    error: string | null;
+    type: T;
+    id: string;
+    name: string;
+    input: {
+        key: string;
+        value: string[];
+        type: string;
+    };
+    output: {
+        key: string;
+        label: string;
+        type: string;
+        value: string[];
+        options: SelectorOptions[];
+    };
+}
+export interface MultiValueCollectorNoValue<T extends MultiValueCollectorTypes> {
+    category: 'MultiValueCollector';
+    error: string | null;
+    type: T;
+    id: string;
+    name: string;
+    input: {
+        key: string;
+        value: string[];
+        type: string;
+    };
+    output: {
+        key: string;
+        label: string;
+        type: string;
+        value: string[];
+        options: SelectorOptions[];
+    };
+}
+/**
+ * Type to help infer the collector based on the collector type
+ * Used specifically in the returnMultiValueCollector wrapper function.
+ * When given a type, it can narrow which type it is returning
+ *
+ * Note: You can see this type in action in the test file or in the collector.utils file.
+ */
+export type InferMultiValueCollectorType<T extends MultiValueCollectorTypes> = T extends 'MultiSelectCollector' ? MultiValueCollectorWithValue<'MultiSelectCollector'> : MultiValueCollectorWithValue<'MultiValueCollector'> | MultiValueCollectorNoValue<'MultiValueCollector'>;
+export type MultiValueCollectors = MultiValueCollectorWithValue<'MultiValueCollector'> | MultiValueCollectorWithValue<'MultiSelectCollector'>;
+export type MultiValueCollector<T extends MultiValueCollectorTypes> = MultiValueCollectorWithValue<T> | MultiValueCollectorNoValue<T>;
+export type MultiSelectCollector = MultiValueCollectorWithValue<'MultiSelectCollector'>;
+/** *********************************************************************
+ * ACTION COLLECTORS
+ */
+/**
+ * @interface ActionCollector - Represents a user option to perform an action, like submitting a form or choosing another flow.
+ */
+export type ActionCollectorTypes = 'FlowCollector' | 'SubmitCollector' | 'IdpCollector' | 'ActionCollector';
+export interface ActionCollectorNoUrl<T extends ActionCollectorTypes> {
+    category: 'ActionCollector';
+    error: string | null;
+    type: T;
+    id: string;
+    name: string;
+    output: {
+        key: string;
+        label: string;
+        type: string;
+    };
+}
+export interface ActionCollectorWithUrl<T extends ActionCollectorTypes> {
+    category: 'ActionCollector';
+    error: string | null;
+    type: T;
+    id: string;
+    name: string;
+    output: {
+        key: string;
+        label: string;
+        type: string;
+        url?: string | null;
+    };
+}
+export type ActionCollector<T extends ActionCollectorTypes> = ActionCollectorNoUrl<T> | ActionCollectorWithUrl<T>;
+export type InferActionCollectorType<T extends ActionCollectorTypes> = T extends 'IdpCollector' ? IdpCollector : T extends 'SubmitCollector' ? SubmitCollector : T extends 'FlowCollector' ? FlowCollector : ActionCollectorWithUrl<'ActionCollector'> | ActionCollectorNoUrl<'ActionCollector'>;
+export type ActionCollectors = ActionCollectorWithUrl<'IdpCollector'> | ActionCollectorNoUrl<'ActionCollector'> | ActionCollectorNoUrl<'FlowCollector'> | ActionCollectorNoUrl<'SubmitCollector'>;
+export type FlowCollector = ActionCollectorNoUrl<'FlowCollector'>;
+export type IdpCollector = ActionCollectorWithUrl<'IdpCollector'>;
+export type SubmitCollector = ActionCollectorNoUrl<'SubmitCollector'>;
+/** *********************************************************************
+ * NO VALUE COLLECTORS
+ */
+/**
+ * @interface NoValueCollector - Represents a collect that collects no value; text only for display.
+ */
+export type NoValueCollectorTypes = 'ReadOnlyCollector' | 'NoValueCollector';
+export interface NoValueCollectorBase<T extends NoValueCollectorTypes> {
+    category: 'NoValueCollector';
+    error: string | null;
+    type: T;
+    id: string;
+    name: string;
+    output: {
+        key: string;
+        label: string;
+        type: string;
+    };
+}
+/**
+ * Type to help infer the collector based on the collector type
+ * Used specifically in the returnMultiValueCollector wrapper function.
+ * When given a type, it can narrow which type it is returning
+ *
+ * Note: You can see this type in action in the test file or in the collector.utils file.
+ */
+export type InferNoValueCollectorType<T extends NoValueCollectorTypes> = T extends 'ReadOnlyCollector' ? NoValueCollectorBase<'ReadOnlyCollector'> : NoValueCollectorBase<'NoValueCollector'>;
+export type NoValueCollectors = NoValueCollectorBase<'NoValueCollector'> | NoValueCollectorBase<'ReadOnlyCollector'>;
+export type NoValueCollector<T extends NoValueCollectorTypes> = NoValueCollectorBase<T>;
+export type ReadOnlyCollector = NoValueCollectorBase<'ReadOnlyCollector'>;
+export {};
+//# sourceMappingURL=collector.types.d.ts.map

package/dist/src/lib/collector.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collector.types.d.ts","sourceRoot":"","sources":["../../../src/lib/collector.types.ts"],"names":[],"mappings":"AAMA;;GAEG;AAEH;;GAEG;AACH,MAAM,MAAM,yBAAyB,GACjC,mBAAmB,GACnB,sBAAsB,GACtB,uBAAuB,GACvB,eAAe,GACf,wBAAwB,CAAC;AAE7B,UAAU,eAAe;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,UAAU,kBAAkB;IAC1B,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,OAAO,CAAC;CACf;AAED,UAAU,eAAe;IACvB,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,6BAA6B,CAAC,CAAC,SAAS,yBAAyB;IAChF,QAAQ,EAAE,sBAAsB,CAAC;IACjC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,CAAC,CAAC;IACR,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE;QACL,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QACjC,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,MAAM,EAAE;QACN,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;KAClC,CAAC;CACH;AAED,MAAM,WAAW,sCAAsC,CAAC,CAAC,SAAS,yBAAyB;IACzF,QAAQ,EAAE,+BAA+B,CAAC;IAC1C,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,CAAC,CAAC;IACR,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE;QACL,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QACjC,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,EAAE,CAAC,kBAAkB,GAAG,eAAe,CAAC,EAAE,CAAC;KACtD,CAAC;IACF,MAAM,EAAE;QACN,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;KAClC,CAAC;CACH;AAED,MAAM,WAAW,8BAA8B,CAAC,CAAC,SAAS,yBAAyB;IACjF,QAAQ,EAAE,sBAAsB,CAAC;IACjC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,CAAC,CAAC;IACR,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE;QACL,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QACjC,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,MAAM,EAAE;QACN,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QACjC,OAAO,EAAE,eAAe,EAAE,CAAC;KAC5B,CAAC;CACH;AAED,MAAM,WAAW,2BAA2B,CAAC,CAAC,SAAS,yBAAyB;IAC9E,QAAQ,EAAE,sBAAsB,CAAC;IACjC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,CAAC,CAAC;IACR,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE;QACL,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QACjC,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,MAAM,EAAE;QACN,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED,MAAM,WAAW,4BAA4B,CAAC,CAAC,SAAS,yBAAyB;IAC/E,QAAQ,EAAE,sBAAsB,CAAC;IACjC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,CAAC,CAAC;IACR,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE;QACL,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QACjC,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,MAAM,EAAE;QACN,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,eAAe,EAAE,CAAC;KAC5B,CAAC;CACH;AAED;;;;;;GAMG;AACH,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,yBAAyB,IAC3E,CAAC,SAAS,eAAe,GACrB,aAAa,GACb,CAAC,SAAS,uBAAuB,GAC/B,qBAAqB,GACrB,CAAC,SAAS,mBAAmB,GAC3B,iBAAiB,GAOf,6BAA6B,CAAC,sBAAsB,CAAC,GACnD,2BAA2B,CAAC,sBAAsB,CAAC,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,yBAAyB,IAChE,6BAA6B,CAAC,CAAC,CAAC,GAChC,2BAA2B,CAAC,CAAC,CAAC,CAAC;AAEnC,MAAM,MAAM,qBAAqB,GAC7B,2BAA2B,CAAC,mBAAmB,CAAC,GAChD,8BAA8B,CAAC,uBAAuB,CAAC,GACvD,6BAA6B,CAAC,sBAAsB,CAAC,GACrD,6BAA6B,CAAC,eAAe,CAAC,GAC9C,sCAAsC,CAAC,eAAe,CAAC,CAAC;AAE5D,MAAM,MAAM,iBAAiB,GAAG,2BAA2B,CAAC,mBAAmB,CAAC,CAAC;AACjF,MAAM,MAAM,aAAa,GAAG,6BAA6B,CAAC,eAAe,CAAC,CAAC;AAC3E,MAAM,MAAM,qBAAqB,GAAG,8BAA8B,CAAC,uBAAuB,CAAC,CAAC;AAC5F,MAAM,MAAM,sBAAsB,GAAG,sCAAsC,CAAC,eAAe,CAAC,CAAC;AAE7F;;GAEG;AAEH;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,sBAAsB,GAAG,qBAAqB,CAAC;AAEtF,MAAM,WAAW,4BAA4B,CAAC,CAAC,SAAS,wBAAwB;IAC9E,QAAQ,EAAE,qBAAqB,CAAC;IAChC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,CAAC,CAAC;IACR,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE;QACL,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,MAAM,EAAE;QACN,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,OAAO,EAAE,eAAe,EAAE,CAAC;KAC5B,CAAC;CACH;AAED,MAAM,WAAW,0BAA0B,CAAC,CAAC,SAAS,wBAAwB;IAC5E,QAAQ,EAAE,qBAAqB,CAAC;IAChC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,CAAC,CAAC;IACR,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE;QACL,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,MAAM,EAAE;QACN,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,OAAO,EAAE,eAAe,EAAE,CAAC;KAC5B,CAAC;CACH;AAED;;;;;;GAMG;AACH,MAAM,MAAM,4BAA4B,CAAC,CAAC,SAAS,wBAAwB,IACzE,CAAC,SAAS,sBAAsB,GAC5B,4BAA4B,CAAC,sBAAsB,CAAC,GAEhD,4BAA4B,CAAC,qBAAqB,CAAC,GACnD,0BAA0B,CAAC,qBAAqB,CAAC,CAAC;AAE5D,MAAM,MAAM,oBAAoB,GAC5B,4BAA4B,CAAC,qBAAqB,CAAC,GACnD,4BAA4B,CAAC,sBAAsB,CAAC,CAAC;AAEzD,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,wBAAwB,IAC9D,4BAA4B,CAAC,CAAC,CAAC,GAC/B,0BAA0B,CAAC,CAAC,CAAC,CAAC;AAElC,MAAM,MAAM,oBAAoB,GAAG,4BAA4B,CAAC,sBAAsB,CAAC,CAAC;AAExF;;GAEG;AAEH;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAC5B,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,iBAAiB,CAAC;AAEtB,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,oBAAoB;IAClE,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,CAAC,CAAC;IACR,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE;QACN,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,oBAAoB;IACpE,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,CAAC,CAAC;IACR,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE;QACN,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACrB,CAAC;CACH;AAED,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,oBAAoB,IACtD,oBAAoB,CAAC,CAAC,CAAC,GACvB,sBAAsB,CAAC,CAAC,CAAC,CAAC;AAE9B,MAAM,MAAM,wBAAwB,CAAC,CAAC,SAAS,oBAAoB,IAAI,CAAC,SAAS,cAAc,GAC3F,YAAY,GACZ,CAAC,SAAS,iBAAiB,GACzB,eAAe,GACf,CAAC,SAAS,eAAe,GACvB,aAAa,GACb,sBAAsB,CAAC,iBAAiB,CAAC,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;AAE5F,MAAM,MAAM,gBAAgB,GACxB,sBAAsB,CAAC,cAAc,CAAC,GACtC,oBAAoB,CAAC,iBAAiB,CAAC,GACvC,oBAAoB,CAAC,eAAe,CAAC,GACrC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;AAE5C,MAAM,MAAM,aAAa,GAAG,oBAAoB,CAAC,eAAe,CAAC,CAAC;AAClE,MAAM,MAAM,YAAY,GAAG,sBAAsB,CAAC,cAAc,CAAC,CAAC;AAClE,MAAM,MAAM,eAAe,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;AAEtE;;GAEG;AAEH;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,mBAAmB,GAAG,kBAAkB,CAAC;AAE7E,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,qBAAqB;IACnE,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,CAAC,CAAC;IACR,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE;QACN,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED;;;;;;GAMG;AACH,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,qBAAqB,IACnE,CAAC,SAAS,mBAAmB,GACzB,oBAAoB,CAAC,mBAAmB,CAAC,GACzC,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;AAE/C,MAAM,MAAM,iBAAiB,GACzB,oBAAoB,CAAC,kBAAkB,CAAC,GACxC,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;AAE9C,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,qBAAqB,IAAI,oBAAoB,CAAC,CAAC,CAAC,CAAC;AAExF,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,CAAC"}

package/dist/src/lib/collector.types.js

@@ -0,0 +1,11 @@
+/*
+ * Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+/** *********************************************************************
+ * SINGLE-VALUE COLLECTORS
+ */
+export {};
+//# sourceMappingURL=collector.types.js.map

package/dist/src/lib/collector.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collector.types.js","sourceRoot":"","sources":["../../../src/lib/collector.types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH;;GAEG"}

package/dist/src/lib/collector.utils.d.ts

@@ -0,0 +1,100 @@
+/**
+ * Import the required types
+ */
+import type { ActionCollectors, ActionCollectorTypes, InferSingleValueCollectorType, InferMultiValueCollectorType, SingleValueCollectorTypes, MultiValueCollectorTypes, NoValueCollectorTypes, InferNoValueCollectorType, ValidatedSingleValueCollectorWithValue, ValidatedTextCollector } from './collector.types.js';
+import type { MultiSelectFieldValue, ReadOnlyFieldValue, RedirectFieldValue, SingleSelectFieldValue, StandardFieldValue, ValidatedFieldValue } from './davinci.types.js';
+/**
+ * @function returnActionCollector - Creates an ActionCollector object based on the provided field and index.
+ * @param {DaVinciField} field - The field object containing key, label, type, and links.
+ * @param {number} idx - The index to be used in the id of the ActionCollector.
+ * @param {ActionCollectorTypes} [collectorType] - Optional type of the ActionCollector.
+ * @returns {ActionCollector} The constructed ActionCollector object.
+ */
+export declare function returnActionCollector<CollectorType extends ActionCollectorTypes>(field: RedirectFieldValue | StandardFieldValue, idx: number, collectorType: CollectorType): ActionCollectors;
+/**
+ * @function returnFlowCollector - Returns a flow collector object
+ * @param {DaVinciField} field - The field representing the flow button
+ * @param {number} idx - The index of the field in the form
+ * @returns {FlowCollector} - The flow collector object
+ */
+export declare function returnFlowCollector(field: StandardFieldValue, idx: number): ActionCollectors;
+/**
+ * @function returnIdpCollector - Returns a social login collector object
+ * @param {DaVinciField} field - The field representing the social login button
+ * @param {number} idx - The index of the field in the form
+ * @returns {SocialLoginCollector} - The social login collector object
+ */
+export declare function returnIdpCollector(field: RedirectFieldValue, idx: number): ActionCollectors;
+/**
+ * @function returnSubmitCollector - Returns a submit collector object
+ * @param {DaVinciField} field - The field representing the submit button
+ * @param {number} idx - The index of the field in the form
+ * @returns {ActionCollector} - The submit collector object
+ */
+export declare function returnSubmitCollector(field: StandardFieldValue, idx: number): ActionCollectors;
+/**
+ * @function returnSingleValueCollector - Creates a SingleValueCollector object based on the provided field, index, and optional collector type.
+ * @param {DaVinciField} field - The field object containing key, label, type, and links.
+ * @param {number} idx - The index to be used in the id of the SingleValueCollector.
+ * @param {SingleValueCollectorTypes} [collectorType] - Optional type of the SingleValueCollector.
+ * @returns {SingleValueCollector} The constructed SingleValueCollector object.
+ */
+export declare function returnSingleValueCollector<Field extends StandardFieldValue | SingleSelectFieldValue | ValidatedFieldValue, CollectorType extends SingleValueCollectorTypes = 'SingleValueCollector'>(field: Field, idx: number, collectorType: CollectorType, data?: string): import("./collector.types.js").SingleSelectCollector | ValidatedSingleValueCollectorWithValue<"TextCollector"> | InferSingleValueCollectorType<CollectorType>;
+/**
+ * @function returnPasswordCollector - Creates a PasswordCollector object based on the provided field and index.
+ * @param {DaVinciField} field - The field object containing key, label, type, and links.
+ * @param {number} idx - The index to be used in the id of the PasswordCollector.
+ * @returns {PasswordCollector} The constructed PasswordCollector object.
+ */
+export declare function returnPasswordCollector(field: StandardFieldValue, idx: number): import("./collector.types.js").SingleSelectCollector | import("./collector.types.js").PasswordCollector | ValidatedSingleValueCollectorWithValue<"TextCollector">;
+/**
+ * @function returnTextCollector - Creates a TextCollector object based on the provided field and index.
+ * @param {DaVinciField} field - The field object containing key, label, type, and links.
+ * @param {number} idx - The index to be used in the id of the TextCollector.
+ * @returns {TextCollector} The constructed TextCollector object.
+ */
+export declare function returnTextCollector(field: StandardFieldValue, idx: number, data: string): import("./collector.types.js").TextCollector | import("./collector.types.js").SingleSelectCollector | ValidatedSingleValueCollectorWithValue<"TextCollector">;
+/**
+ * @function returnSingleSelectCollector - Creates a SingleCollector object based on the provided field and index.
+ * @param {DaVinciField} field - The field object containing key, label, type, and links.
+ * @param {number} idx - The index to be used in the id of the SingleCollector.
+ * @returns {SingleValueCollector} The constructed SingleCollector object.
+ */
+export declare function returnSingleSelectCollector(field: SingleSelectFieldValue, idx: number, data: string): import("./collector.types.js").SingleSelectCollector | ValidatedSingleValueCollectorWithValue<"TextCollector">;
+/**
+ * @function returnMultiValueCollector - Creates a MultiValueCollector object based on the provided field, index, and optional collector type.
+ * @param {DaVinciField} field - The field object containing key, label, type, and links.
+ * @param {number} idx - The index to be used in the id of the MultiValueCollector.
+ * @param {MultiValueCollectorTypes} [collectorType] - Optional type of the MultiValueCollector.
+ * @returns {MultiValueCollector} The constructed MultiValueCollector object.
+ */
+export declare function returnMultiValueCollector<Field extends MultiSelectFieldValue, CollectorType extends MultiValueCollectorTypes = 'MultiValueCollector'>(field: Field, idx: number, collectorType: CollectorType, data?: string[]): InferMultiValueCollectorType<CollectorType>;
+/**
+ * @function returnMultiSelectCollector - Creates a DropDownCollector object based on the provided field and index.
+ * @param {DaVinciField} field - The field object containing key, label, type, and links.
+ * @param {number} idx - The index to be used in the id of the DropDownCollector.
+ * @returns {SingleValueCollector} The constructed DropDownCollector object.
+ */
+export declare function returnMultiSelectCollector(field: MultiSelectFieldValue, idx: number, data: string[]): import("./collector.types.js").MultiValueCollectorWithValue<"MultiSelectCollector">;
+/**
+ * @function returnMultiValueCollector - Creates a MultiValueCollector object based on the provided field, index, and optional collector type.
+ * @param {DaVinciField} field - The field object containing key, label, type, and links.
+ * @param {number} idx - The index to be used in the id of the MultiValueCollector.
+ * @param {MultiValueCollectorTypes} [collectorType] - Optional type of the MultiValueCollector.
+ * @returns {MultiValueCollector} The constructed MultiValueCollector object.
+ */
+export declare function returnNoValueCollector<Field extends ReadOnlyFieldValue, CollectorType extends NoValueCollectorTypes = 'NoValueCollector'>(field: Field, idx: number, collectorType: CollectorType): InferNoValueCollectorType<CollectorType>;
+/**
+ * @function returnMultiSelectCollector - Creates a DropDownCollector object based on the provided field and index.
+ * @param {DaVinciField} field - The field object containing key, label, type, and links.
+ * @param {number} idx - The index to be used in the id of the DropDownCollector.
+ * @returns {SingleValueCollector} The constructed DropDownCollector object.
+ */
+export declare function returnReadOnlyCollector(field: ReadOnlyFieldValue, idx: number): import("./collector.types.js").NoValueCollectorBase<"ReadOnlyCollector">;
+/**
+ * @function returnValidator - Creates a validator function based on the provided collector
+ * @param collector {ValidatedTextCollector} - The collector to which the value will be validated
+ * @returns {function} - A "validator" function that validates the input value
+ */
+export declare function returnValidator(collector: ValidatedTextCollector): (value: string) => string[];
+//# sourceMappingURL=collector.utils.d.ts.map

package/dist/src/lib/collector.utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collector.utils.d.ts","sourceRoot":"","sources":["../../../src/lib/collector.utils.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,OAAO,KAAK,EACV,gBAAgB,EAChB,oBAAoB,EACpB,6BAA6B,EAC7B,4BAA4B,EAC5B,yBAAyB,EACzB,wBAAwB,EAExB,qBAAqB,EACrB,yBAAyB,EACzB,sCAAsC,EACtC,sBAAsB,EACvB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EACV,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,EACtB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,oBAAoB,CAAC;AAE5B;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,SAAS,oBAAoB,EAC9E,KAAK,EAAE,kBAAkB,GAAG,kBAAkB,EAC9C,GAAG,EAAE,MAAM,EACX,aAAa,EAAE,aAAa,GAC3B,gBAAgB,CA+ClB;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,kBAAkB,EAAE,GAAG,EAAE,MAAM,oBAEzE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,kBAAkB,EAAE,GAAG,EAAE,MAAM,oBAExE;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,kBAAkB,EAAE,GAAG,EAAE,MAAM,oBAE3E;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACxC,KAAK,SAAS,kBAAkB,GAAG,sBAAsB,GAAG,mBAAmB,EAC/E,aAAa,SAAS,yBAAyB,GAAG,sBAAsB,EACxE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,IAAI,CAAC,EAAE,MAAM,iKAoHvE;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,kBAAkB,EAAE,GAAG,EAAE,MAAM,qKAE7E;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,kBAAkB,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,iKAEvF;AACD;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACzC,KAAK,EAAE,sBAAsB,EAC7B,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,kHAGb;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CACvC,KAAK,SAAS,qBAAqB,EACnC,aAAa,SAAS,wBAAwB,GAAG,qBAAqB,EACtE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,GAiCnE,4BAA4B,CAAC,aAAa,CAAC,CACjD;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,qBAAqB,EAC5B,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EAAE,uFAGf;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,SAAS,kBAAkB,EAChC,aAAa,SAAS,qBAAqB,GAAG,kBAAkB,EAChE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,GAoBlD,yBAAyB,CAAC,aAAa,CAAC,CAC9C;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,kBAAkB,EAAE,GAAG,EAAE,MAAM,4EAE7E;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,sBAAsB,WAEhD,MAAM,cAkBtB"}