react-native-persona 2.2.0 → 2.2.3

package/lib/typescript/{src/index.d.ts → index.d.ts}

@@ -1,5 +1,7 @@
 import { Fields } from './fields';
 export { Fields };
+import { Versions } from './versions';
+export { Versions };
 declare const Unique: unique symbol;
 export declare type Opaque<T, Tag> = T & {
     [Unique]: Tag;
@@ -58,6 +60,42 @@ export declare class Inquiry {
     private onErrorListener?;
     constructor(options: InquiryOptions);
     private clearListeners;
+    /**
+     * Create an Inquiry flow builder based on a template ID.
+     *
+     * You can find your template ID on the Dashboard under Inquiries > Templates.
+     * {@link https://app.withpersona.com/dashboard/inquiry-templates}
+     *
+     * @param templateId template ID from your Persona Dashboard
+     * @return builder for the Inquiry flow
+     */
+    static fromTemplate(templateId: string): TemplateBuilder;
+    /**
+     * Create an Inquiry flow builder based on a template ID version.
+     *
+     * You can find your template ID version on the Dashboard under the
+     * settings view of a specific template.
+     * {@link https://app.withpersona.com/dashboard/inquiry-templates}
+     *
+     * @param templateVersion template version from your Persona Dashboard
+     * @return builder for the Inquiry flow
+     */
+    static fromTemplateVersion(templateVersion: string): TemplateBuilder;
+    /**
+     * Create an Inquiry flow builder based on an inquiry ID.
+     *
+     * You will need to generate the inquiry ID on the server. To try it out, you can create an
+     * inquiry from the Persona Dashboard under "Inquiries". Click on the "Create Inquiry" button
+     * and copy the inquiry ID from the URL.
+     * {@link https://app.withpersona.com/dashboard/inquiries}
+     *
+     * @param inquiryId inquiry ID from your server
+     * @return builder for the Inquiry flow
+     */
+    static fromInquiry(inquiryId: string): InquiryBuilder;
+    /**
+     * Launch the Persona Inquiry.
+     */
     start(): void;
 }
 declare class InquiryBuilder {
@@ -100,9 +138,21 @@ declare class TemplateBuilder {
     iosTheme(themeObject: Object): TemplateBuilder;
     build(): Inquiry;
 }
+/**
+ * @deprecated Use the `Inquiry` static methods instead
+ */
 declare namespace InquiryBuilders {
+    /**
+     * @deprecated Use {@link Inquiry#fromInquiry} instead
+     */
     function fromInquiry(inquiryId: string): InquiryBuilder;
+    /**
+     * @deprecated Use {@link Inquiry#fromTemplate} instead
+     */
     function fromTemplate(templateId: string): TemplateBuilder;
+    /**
+     * @deprecated Use {@link Inquiry#fromTemplateVersion} instead
+     */
     function fromTemplateVersion(templateVersion: string): TemplateBuilder;
 }
 export default InquiryBuilders;

package/lib/typescript/{persona-tools/lib → persona-tool}/AndroidResourcePrinter.d.ts

@@ -1,5 +1,5 @@
-import type { AndroidThemeObject } from "../Theme";
-import type { XMLBuilder } from "xmlbuilder2/lib/interfaces";
+import type { AndroidThemeObject } from './Theme';
+import type { XMLBuilder } from 'xmlbuilder2/lib/interfaces';
 declare class AndroidResourcePrinter {
     theme: AndroidThemeObject;
     root: XMLBuilder;

package/lib/typescript/{persona-tools/lib → persona-tool}/prompts.d.ts

@@ -1,4 +1,4 @@
-import inquirer from "inquirer";
+import inquirer from 'inquirer';
 export declare const TOOL_CHOICE: {
     AndroidTheme: string;
     iosTheme: string;

package/lib/typescript/versions.d.ts

@@ -0,0 +1,6 @@
+export declare class Versions {
+    /**
+     * @return version of the underlying Android/iOS Inquiry SDK
+     */
+    static nativeSdkVersion(): String;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-native-persona",
   "title": "React Native Persona",
-  "version": "2.2.0",
+  "version": "2.2.3",
   "description": "Launch a mobile native implementation of the Persona inquiry flow from React Native.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -9,7 +9,7 @@
   "react-native": "src/index",
   "source": "src/index",
   "bin": {
-    "persona-tool": "./bin/persona-tool"
+    "persona-tool": "bin/persona-tool"
   },
   "scripts": {
     "test": "jest",
@@ -26,7 +26,6 @@
     "android",
     "ios",
     "bin",
-    "persona-tools",
     "RNPersonaInquiry2.podspec",
     "!lib/typescript/example",
     "!android/build",
@@ -44,10 +43,10 @@
     "name": "Persona Identities, Inc.",
     "email": "support@withpersona.com"
   },
-  "homepage": "https://docs.withpersona.com/docs/react-native-sdk-v1-integration",
+  "homepage": "https://docs.withpersona.com/docs/react-native-sdk-integration",
   "license": "MIT",
   "licenseFilename": "LICENSE",
-  "readmeFilename": "README.md",
+  "readmeFilename": "PUBLIC.md",
   "peerDependencies": {
     "react": "*",
     "react-native": "*"

package/src/index.ts

@@ -5,8 +5,13 @@ import {
 } from 'react-native';
 import { processThemeValues } from './util';
 import { Fields, InquiryField, RawInquiryField } from './fields';
+
 export { Fields };
 
+import { Versions } from './versions';
+
+export { Versions };
+
 const { PersonaInquiry2 } = NativeModules;
 
 // Using Opaque types + Smart Constructor enforces validation at
@@ -174,6 +179,51 @@ export class Inquiry {
     if (this.onErrorListener) this.onErrorListener.remove();
   }
 
+  /**
+   * Create an Inquiry flow builder based on a template ID.
+   *
+   * You can find your template ID on the Dashboard under Inquiries > Templates.
+   * {@link https://app.withpersona.com/dashboard/inquiry-templates}
+   *
+   * @param templateId template ID from your Persona Dashboard
+   * @return builder for the Inquiry flow
+   */
+  static fromTemplate(templateId: string) {
+    return new TemplateBuilder(makeTemplateId(templateId), null);
+  }
+
+  /**
+   * Create an Inquiry flow builder based on a template ID version.
+   *
+   * You can find your template ID version on the Dashboard under the
+   * settings view of a specific template.
+   * {@link https://app.withpersona.com/dashboard/inquiry-templates}
+   *
+   * @param templateVersion template version from your Persona Dashboard
+   * @return builder for the Inquiry flow
+   */
+  static fromTemplateVersion(templateVersion: string) {
+    return new TemplateBuilder(null, makeTemplateVersion(templateVersion));
+  }
+
+  /**
+   * Create an Inquiry flow builder based on an inquiry ID.
+   *
+   * You will need to generate the inquiry ID on the server. To try it out, you can create an
+   * inquiry from the Persona Dashboard under "Inquiries". Click on the "Create Inquiry" button
+   * and copy the inquiry ID from the URL.
+   * {@link https://app.withpersona.com/dashboard/inquiries}
+   *
+   * @param inquiryId inquiry ID from your server
+   * @return builder for the Inquiry flow
+   */
+  static fromInquiry(inquiryId: string) {
+    return new InquiryBuilder(makeInquiryId(inquiryId));
+  }
+
+  /**
+   * Launch the Persona Inquiry.
+   */
   start() {
     this.onCompleteListener = eventEmitter.addListener(
       'onComplete',
@@ -407,17 +457,29 @@ class TemplateBuilder {
   }
 }
 
+/**
+ * @deprecated Use the `Inquiry` static methods instead
+ */
 namespace InquiryBuilders {
+  /**
+   * @deprecated Use {@link Inquiry#fromInquiry} instead
+   */
   export function fromInquiry(inquiryId: string) {
-    return new InquiryBuilder(makeInquiryId(inquiryId));
+    return Inquiry.fromInquiry(inquiryId);
   }
 
+  /**
+   * @deprecated Use {@link Inquiry#fromTemplate} instead
+   */
   export function fromTemplate(templateId: string) {
-    return new TemplateBuilder(makeTemplateId(templateId), null);
+    return Inquiry.fromTemplate(templateId);
   }
 
+  /**
+   * @deprecated Use {@link Inquiry#fromTemplateVersion} instead
+   */
   export function fromTemplateVersion(templateVersion: string) {
-    return new TemplateBuilder(null, makeTemplateVersion(templateVersion));
+    return Inquiry.fromTemplateVersion(templateVersion);
   }
 }