Feat/setup wizard

dt-contacts/contacts.php

@@ -9,11 +9,11 @@
         'description' => 'Default contact functionality'
     ];
     $modules['access_module'] = [
-        'name' => 'Access Module',
+        'name' => 'Follow-up',
         'enabled' => true,
         'prerequisites' => [ 'contacts_base' ],
         'post_type' => 'contacts',
-        'description' => 'Field and workflows for follow-up ministries',
+        'description' => 'Manage incoming contacts from various sources and assign them to users for follow-up.',
         'submodule' => true
     ];
     return $modules;

dt-contacts/module-baptisms.php

@@ -3,11 +3,11 @@
 
 add_filter( 'dt_post_type_modules', function( $modules ){
     $modules['contacts_baptisms_module'] = [
-        'name' => 'Baptisms Module',
+        'name' => 'Baptisms',
         'enabled' => true,
         'prerequisites' => [ 'contacts_base' ],
         'post_type' => 'contacts',
-        'description' => 'Adds baptism fields and workflows',
+        'description' => 'Track contact baptism relationships, dates and generations',
         'submodule' => true,
     ];
     return $modules;
@@ -332,4 +332,4 @@ function(e, newContact, fieldKey, optionKey, action) {
         <?php
     }
 }
-DT_Contacts_Baptisms::instance();
+DT_Contacts_Baptisms::instance();

dt-contacts/module-coaching.php

@@ -3,11 +3,11 @@
 
 add_filter( 'dt_post_type_modules', function( $modules ){
     $modules['contacts_coaching_module'] = [
-        'name' => 'Coaching Module',
+        'name' => 'Coaching',
         'enabled' => true,
         'prerequisites' => [ 'contacts_base' ],
         'post_type' => 'contacts',
-        'description' => 'Adds coaching fields, list filters and workflows',
+        'description' => 'Track contact coaching relationships',
         'submodule' => true,
     ];
     return $modules;

dt-contacts/module-faith.php

@@ -3,11 +3,11 @@
 
 add_filter( 'dt_post_type_modules', function( $modules ){
     $modules['contacts_faith_module'] = [
-        'name' => 'Faith Module',
+        'name' => 'Faith',
         'enabled' => true,
         'prerequisites' => [ 'contacts_base' ],
         'post_type' => 'contacts',
-        'description' => 'Adds faith field status and faith milestones',
+        'description' => 'Track progress of contacts in their faith journey',
         'submodule' => true,
     ];
     return $modules;

dt-core/admin/admin-settings-endpoints.php

@@ -223,6 +223,52 @@ public function add_api_routes() {
                 'permission_callback' => [ $this, 'default_permission_check' ],
             ]
         );
+        register_rest_route(
+            $this->namespace, '/modules-update', [
+                'methods' => 'POST',
+                'callback' => [ $this, 'update_modules' ],
+                'permission_callback' => [ $this, 'default_permission_check' ],
+            ]
+        );
+        register_rest_route(
+            $this->namespace, '/update-dt-options', [
+                'methods' => 'POST',
+                'callback' => [ $this, 'update_dt_options' ],
+                'permission_callback' => [ $this, 'default_permission_check' ],
+            ]
+        );
+    }
+
+    public function update_dt_options( WP_REST_REQUEST $request ){
+        $params = $request->get_params();
+        $updated = false;
+        foreach ( $params as $option_key => $option_value ){
+            //only allow updating D.T options
+            if ( strpos( $option_key, 'dt_' ) !== 0 ){
+                continue;
+            }
+            update_option( $option_key, $option_value );
+            $updated = true;
+        }
+        return $updated;
+    }
+
+    public function update_modules( WP_REST_REQUEST $request ) {
+        $modules_option_name = 'dt_post_type_modules';
+        $modules_to_update = $request->get_param( 'modules' );
+        $modules_to_update = dt_recursive_sanitize_array( $modules_to_update );
+
+        $modules = get_option( $modules_option_name );
+
+        foreach ( $modules_to_update as $key => $enabled ){
+            if ( !isset( $modules[$key] ) ){
+                $modules[$key] = [];
+            }
+            $modules[$key]['enabled'] = !empty( $enabled );
+        }
+
+        update_option( $modules_option_name, $modules );
+        return true;
     }
 
     public function update_languages( WP_REST_REQUEST $request ) {

dt-core/admin/components/setup-wizard-celebration.js

@@ -0,0 +1,60 @@
+import { html } from 'https://cdn.jsdelivr.net/gh/lit/[email protected]/all/lit-all.min.js';
+import { OpenLitElement } from './setup-wizard-open-element.js';
+
+export class SetupWizardCelebration extends OpenLitElement {
+  static get properties() {
+    return {
+      step: { type: Object },
+    };
+  }
+
+  constructor() {
+    super();
+    this.translations = window.setupWizardShare.translations;
+  }
+
+  back() {
+    this.dispatchEvent(new CustomEvent('back'));
+  }
+  async next() {
+    await window.dt_admin_shared.update_dt_options({
+      dt_setup_wizard_completed: true,
+    });
+    window.location.href = window.setupWizardShare.admin_url;
+  }
+
+  render() {
+    return html`
+      <div class="step-layout">
+        <h2>All finished</h2>
+        <div class="content stack">
+          <p>
+            After closing this setup wizard, you'll find yourself in the
+            WordPress admin dashboard. From there, you can explore these
+            settings and continue customizing your Disciple.Tools site.
+          </p>
+          <p>
+            Disciple.Tools has a huge ability to be customized to serve your
+            needs. If you have any questions or need any further assistance in
+            getting Disciple.Tools. to work for you, please reach out on our
+            community forum or our discord channel.
+          </p>
+          <a href="https://community.disciple.tools/" target="_blank">
+            Community Forum
+          </a>
+          <a href="https://discord.gg/kp5pYmrhSd" target="_blank">
+            Discord Invitation
+          </a>
+        </div>
+        <setup-wizard-controls
+          hideSkip
+          nextLabel=${this.translations.finish}
+          @next=${this.next}
+          @back=${this.back}
+          nextLabel="Close Wizard"
+        ></setup-wizard-controls>
+      </div>
+    `;
+  }
+}
+customElements.define('setup-wizard-celebration', SetupWizardCelebration);

dt-core/admin/components/setup-wizard-controls.js

@@ -0,0 +1,54 @@
+import { html } from 'https://cdn.jsdelivr.net/gh/lit/[email protected]/all/lit-all.min.js';
+import { OpenLitElement } from './setup-wizard-open-element.js';
+
+export class SetupWizardControls extends OpenLitElement {
+  static get properties() {
+    return {
+      hideBack: { type: Boolean },
+      hideSkip: { type: Boolean },
+      backLabel: { type: String },
+      nextLabel: { type: String },
+      skipLabel: { type: String },
+      saving: { type: Boolean },
+    };
+  }
+  back() {
+    this.dispatchEvent(new CustomEvent('back'));
+  }
+  next() {
+    if (this.saving) {
+      return;
+    }
+    this.dispatchEvent(new CustomEvent('next'));
+  }
+  skip() {
+    this.dispatchEvent(new CustomEvent('skip'));
+  }
+  render() {
+    return html`
+      <div class="cluster" position="end">
+        ${this.hideSkip
+          ? ''
+          : html`
+              <button @click=${this.skip} class="btn-outline">
+                ${this.skipLabel ?? 'Skip'}
+              </button>
+            `}
+        ${this.hideBack
+          ? ''
+          : html`
+              <button @click=${this.back}>${this.backLabel ?? 'Back'}</button>
+            `}
+        <button
+          @click=${this.next}
+          class="btn-primary ${this.saving ? 'saving' : ''}"
+          ?disabled=${this.saving}
+        >
+          ${this.nextLabel ?? 'Next'}
+          ${this.saving ? html`<span class="spinner light"></span>` : ''}
+        </button>
+      </div>
+    `;
+  }
+}
+customElements.define('setup-wizard-controls', SetupWizardControls);

dt-core/admin/components/setup-wizard-details.js

@@ -0,0 +1,43 @@
+import {
+  html,
+  css,
+} from 'https://cdn.jsdelivr.net/gh/lit/[email protected]/all/lit-all.min.js';
+import { OpenLitElement } from './setup-wizard-open-element.js';
+
+export class SetupWizardDetails extends OpenLitElement {
+  static styles = [
+    css`
+      :host {
+        display: block;
+      }
+    `,
+  ];
+
+  static get properties() {
+    return {
+      step: { type: Object },
+      firstStep: { type: Boolean },
+    };
+  }
+
+  back() {
+    this.dispatchEvent(new CustomEvent('back'));
+  }
+  next() {
+    this.dispatchEvent(new CustomEvent('next'));
+  }
+
+  render() {
+    return html`
+      <div class="step-layout">
+        <div class="content">Sort out details here</div>
+        <setup-wizard-controls
+          ?hideBack=${this.firstStep}
+          @next=${this.next}
+          @back=${this.back}
+        ></setup-wizard-controls>
+      </div>
+    `;
+  }
+}
+customElements.define('setup-wizard-details', SetupWizardDetails);

dt-core/admin/components/setup-wizard-intro.js

@@ -0,0 +1,64 @@
+import { html } from 'https://cdn.jsdelivr.net/gh/lit/[email protected]/all/lit-all.min.js';
+import { OpenLitElement } from './setup-wizard-open-element.js';
+
+export class SetupWizardIntro extends OpenLitElement {
+  static get properties() {
+    return {
+      step: { type: Object },
+    };
+  }
+
+  back() {
+    this.dispatchEvent(new CustomEvent('back'));
+  }
+  next() {
+    this.dispatchEvent(new CustomEvent('next'));
+  }
+
+  render() {
+    return html`
+      <div class="step-layout">
+        <h2>Setting up Disciple.Tools for you</h2>
+        <div class="content stack">
+          <p>
+            We're glad you are here, and we want to help set you up so you can take
+            advantage of the power tool that is Disciple.Tools.
+          </p>
+          <p>
+            Disciple.Tools can be used in many ways from managing connections and
+            relationships, all the way through to tracking and managing a
+            movement of Disciple Making.
+          </p>
+          <p>
+            In order to help you, we want to take you through a series of
+            choices to give you the best start at getting Disciple.Tools setup
+            ready to suit your needs.
+          </p>
+          <p>
+            <ol>
+              <li>
+                We'll choose which parts of the system we want to enable
+              </li>
+              <li>
+                We'll select which plugins we want to install
+              </li>
+              <li>
+               We'll look at some extra setup options
+              </li>
+            </ol>
+          </p>
+          <p>
+            Ready? Let's get started.
+          </p>
+        </div>
+        <setup-wizard-controls
+          hideBack
+          hideSkip
+          @next=${this.next}
+          @back=${this.back}
+        ></setup-wizard-controls>
+      </div>
+    `;
+  }
+}
+customElements.define('setup-wizard-intro', SetupWizardIntro);