@gigya-ts/web-sdk - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

dist/namespaces/accounts.d.ts

@@ -1,2 +0,2 @@
-import { AccountsGetAccountInfoRequest, AccountsGetAccountInfoResponse, AccountsGetJWTRequest, AccountsGetJWTResponse, AccountsGetSchemaRequest, AccountsGetSchemaResponse, AccountsLoginRequest, AccountsLoginResponse, AccountsResetPasswordRequest, AccountsResetPasswordResponse, AccountsSetAccountInfoRequest, AccountsSetAccountInfoResponse, GigyaData, GigyaPreferences, GigyaRequest, GigyaResponse, GigyaSubscriptions } from '@gigya-ts/rest-api';
+import { AccountsFinalizeRegistrationRequest, AccountsFinalizeRegistrationResponse, AccountsGetAccountInfoRequest, AccountsGetAccountInfoResponse, AccountsGetJWTRequest, AccountsGetJWTResponse, AccountsGetSchemaRequest, AccountsGetSchemaResponse, AccountsInitRegistrationRequest, AccountsInitRegistrationResponse, AccountsLoginRequest, AccountsLoginResponse, AccountsRegisterRequest, AccountsRegisterResponse, AccountsResetPasswordRequest, AccountsResetPasswordResponse, AccountsSetAccountInfoRequest, AccountsSetAccountInfoResponse, GigyaData, GigyaPreferences, GigyaRequest, GigyaResponse, GigyaSubscriptions } from '@gigya-ts/rest-api';
 import { GigyaJSFunction, GigyaJSOnLoginEvent, GigyaJSOnLogoutEvent, GigyaJSUIDSignature } from '../types/gigya-helpers';
@@ -23,3 +23,8 @@ /**
  */
-export type AccountsLoginRequestJS = Omit<AccountsLoginRequest, 'clientContext'>;
+export type AccountsLoginRequestJS = Omit<AccountsLoginRequest, 'clientContext'> & {
+    /**
+     * This may be used in some cases to suppress logic applied by the Web SDK, such as automatic opening of screens (e.g., in a registration completion scenario). This parameter may not be used with REST APIs.
+     */
+    ignoreInterruptions?: boolean;
+};
 /**
@@ -51,3 +56,7 @@ * @see https://help.sap.com/docs/SAP_CUSTOMER_DATA_CLOUD/8b8d6fffe113457094a17701f63e3d6a/eb93d538b9ae45bfadd9a8aaa8806753.html?#response-data
  */
-export type AccountsGetAccountInfoResponseJS<DataSchema extends GigyaData, PreferencesSchema extends GigyaPreferences, SubscriptionsSchema extends GigyaSubscriptions> = AccountsGetAccountInfoResponse<DataSchema, PreferencesSchema, SubscriptionsSchema> & GigyaJSUIDSignature;
+export type AccountsGetAccountInfoResponseJS<DataSchema extends GigyaData, PreferencesSchema extends GigyaPreferences, SubscriptionsSchema extends GigyaSubscriptions> = AccountsGetAccountInfoResponse<DataSchema, PreferencesSchema, SubscriptionsSchema> & GigyaJSUIDSignature & {
+    password: {
+        created?: string;
+    };
+};
 /**
@@ -87,2 +96,31 @@ * @see https://help.sap.com/docs/SAP_CUSTOMER_DATA_CLOUD/8b8d6fffe113457094a17701f63e3d6a/4135d4e170b21014bbc5a10ce4041860.html#parameters
 export type AccountsGetSchemaResponseJS = AccountsGetSchemaResponse;
+/**
+ * @see https://help.sap.com/docs/SAP_CUSTOMER_DATA_CLOUD/8b8d6fffe113457094a17701f63e3d6a/4136cef070b21014bbc5a10ce4041860.html#method-parameters
+ */
+export type AccountsInitRegistrationRequestJS = Omit<AccountsInitRegistrationRequest, 'dataCenter'>;
+/**
+ * @TODO: This is not documented in the Gigya WebSDK docs.
+ */
+export type AccountsInitRegistrationResponseJS = AccountsInitRegistrationResponse;
+/**
+ * @see https://help.sap.com/docs/SAP_CUSTOMER_DATA_CLOUD/8b8d6fffe113457094a17701f63e3d6a/41389fe070b21014bbc5a10ce4041860.html#parameters
+ */
+export type AccountsRegisterRequestJS<DataSchema extends GigyaData, PreferencesSchema extends GigyaPreferences, SubscriptionsSchema extends GigyaSubscriptions> = AccountsRegisterRequest<DataSchema, PreferencesSchema, SubscriptionsSchema> & {
+    /**
+     * This may be used in some cases to suppress logic applied by the Web SDK, such as automatic opening of screens (e.g., in a registration completion scenario). This parameter may not be used with REST APIs.
+     */
+    ignoreInterruptions?: boolean;
+};
+/**
+ * @TODO: This is not documented in the Gigya WebSDK docs.
+ */
+export type AccountsRegisterResponseJS<DataSchema extends GigyaData, PreferencesSchema extends GigyaPreferences, SubscriptionsSchema extends GigyaSubscriptions> = Omit<AccountsRegisterResponse<DataSchema, PreferencesSchema, SubscriptionsSchema>, 'password'>;
+/**
+ * @see https://help.sap.com/docs/SAP_CUSTOMER_DATA_CLOUD/8b8d6fffe113457094a17701f63e3d6a/4134b19d70b21014bbc5a10ce4041860.html#parameters
+ */
+export type AccountsFinalizeRegistrationRequestJS = AccountsFinalizeRegistrationRequest;
+/**
+ * @TODO: This is not documented in the Gigya WebSDK docs.
+ */
+export type AccountsFinalizeRegistrationResponseJS<DataSchema extends GigyaData, PreferencesSchema extends GigyaPreferences, SubscriptionsSchema extends GigyaSubscriptions> = Omit<AccountsFinalizeRegistrationResponse<DataSchema, PreferencesSchema, SubscriptionsSchema>, 'password'>;
 export type GigyaAccountsNamespaceJS<DataSchema extends GigyaData, PreferencesSchema extends GigyaPreferences, SubscriptionsSchema extends GigyaSubscriptions> = {
@@ -100,2 +138,40 @@ /**
     /**
+     *  This method completes on-site user registration.
+     *
+     *  For registration through a social network, see accounts.socialLogin.
+     *
+     *  On-site registration requires three API calls:
+     *
+     *      1. accounts.initRegistration
+     *      2. accounts.register
+     *      3. accounts.finalizeRegistration
+     *
+     *  This method is not required if the finalizeRegistration parameter was set to true in accounts.register.
+     *
+     *  @see https://help.sap.com/docs/SAP_CUSTOMER_DATA_CLOUD/8b8d6fffe113457094a17701f63e3d6a/4134b19d70b21014bbc5a10ce4041860.html
+     */
+    finalizeRegistration: GigyaJSFunction<AccountsFinalizeRegistrationRequestJS, AccountsFinalizeRegistrationResponseJS<DataSchema, PreferencesSchema, SubscriptionsSchema>>;
+    /**
+     * This method retrieves user account data.
+     *
+     * @note We recommend using this method from your server-side rather than from your web-client, and only pass the relevant data to the client-side, thus not exposing the entire account data to the client.
+     */
+    getAccountInfo: GigyaJSFunction<AccountsGetAccountInfoRequestJS, AccountsGetAccountInfoResponseJS<DataSchema, PreferencesSchema, SubscriptionsSchema>>;
+    /**
+     * This API is used to obtain an id_token containing the active session's user data.
+     */
+    getJWT: GigyaJSFunction<AccountsGetJWTRequestJS, AccountsGetJWTResponseJS>;
+    /**
+     * This method retrieves the schema of the Profile object and the Data object (the site specific custom data object) in Gigya's Accounts Storage.
+     *
+     * @see https://help.sap.com/docs/SAP_CUSTOMER_DATA_CLOUD/8b8d6fffe113457094a17701f63e3d6a/4135d4e170b21014bbc5a10ce4041860.html
+     */
+    getSchema: GigyaJSFunction<AccountsGetSchemaRequestJS, AccountsGetSchemaResponseJS>;
+    /**
+     * This method initializes a registration process at a site.
+     *
+     * @see https://help.sap.com/docs/SAP_CUSTOMER_DATA_CLOUD/8b8d6fffe113457094a17701f63e3d6a/4136cef070b21014bbc5a10ce4041860.html
+     */
+    initRegistration: GigyaJSFunction<AccountsInitRegistrationRequestJS, AccountsInitRegistrationResponseJS>;
+    /**
      * This method logs in a user to your site and opens a session for the logged-in user on success.
@@ -113,12 +189,8 @@ *
     /**
-     * This method retrieves user account data.
+     * This method registers a new user at your site.
      *
-     * @note We recommend using this method from your server-side rather than from your web-client, and only pass the relevant data to the client-side, thus not exposing the entire account data to the client.
+     * @see https://help.sap.com/docs/SAP_CUSTOMER_DATA_CLOUD/8b8d6fffe113457094a17701f63e3d6a/41389fe070b21014bbc5a10ce4041860.html
      */
-    getAccountInfo: GigyaJSFunction<AccountsGetAccountInfoRequestJS, AccountsGetAccountInfoResponseJS<DataSchema, PreferencesSchema, SubscriptionsSchema>>;
+    register: GigyaJSFunction<AccountsRegisterRequestJS<DataSchema, PreferencesSchema, SubscriptionsSchema>, AccountsRegisterResponseJS<DataSchema, PreferencesSchema, SubscriptionsSchema>>;
     /**
-     * This API is used to obtain an id_token containing the active session's user data.
-     */
-    getJWT: GigyaJSFunction<AccountsGetJWTRequestJS, AccountsGetJWTResponseJS>;
-    /**
      * The password can be reset either via email or directly. The email format is according to the templates defined in the site policy.
@@ -133,9 +205,3 @@ */
     setAccountInfo: GigyaJSFunction<AccountsSetAccountInfoRequestJS<DataSchema, PreferencesSchema, SubscriptionsSchema>, AccountsSetAccountInfoResponseJS>;
-    /**
-     * This method retrieves the schema of the Profile object and the Data object (the site specific custom data object) in Gigya's Accounts Storage.
-     *
-     * @see https://help.sap.com/docs/SAP_CUSTOMER_DATA_CLOUD/8b8d6fffe113457094a17701f63e3d6a/4135d4e170b21014bbc5a10ce4041860.html
-     */
-    getSchema: GigyaJSFunction<AccountsGetSchemaRequestJS, AccountsGetSchemaResponseJS>;
 };
 //# sourceMappingURL=accounts.d.ts.map

package.json

 {
   "name": "@gigya-ts/web-sdk",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "TypeScript definitions for the Gigya Web SDK",
@@ -14,3 +14,3 @@ "type": "module",
   "dependencies": {
-    "@gigya-ts/rest-api": "0.0.3"
+    "@gigya-ts/rest-api": "0.0.4"
   },
@@ -17,0 +17,0 @@ "devDependencies": {

No alert changes

Improved metrics

Total package byte prevSize

23735

increased by28.78%

Lines of code

314

increased by27.64%

Dependency changes

• + Added@gigya-ts/rest-api@0.0.4(transitive)

• - Removed@gigya-ts/rest-api@0.0.3(transitive)

• Updated@gigya-ts/rest-api@0.0.4