initial v0.8 pre-release

ui/src/components/collections/docs/RequestEmailChangeDocs.svelte

@@ -0,0 +1,144 @@
+<script>
+    import { Collection } from "pocketbase";
+    import ApiClient from "@/utils/ApiClient";
+    import CommonHelper from "@/utils/CommonHelper";
+    import CodeBlock from "@/components/base/CodeBlock.svelte";
+    import SdkTabs from "@/components/collections/docs/SdkTabs.svelte";
+
+    export let collection = new Collection();
+
+    let responseTab = 204;
+    let responses = [];
+
+    $: backendAbsUrl = CommonHelper.getApiExampleUrl(ApiClient.baseUrl);
+
+    $: responses = [
+        {
+            code: 204,
+            body: "null",
+        },
+        {
+            code: 400,
+            body: `
+                {
+                  "code": 400,
+                  "message": "Failed to authenticate.",
+                  "data": {
+                    "newEmail": {
+                      "code": "validation_required",
+                      "message": "Missing required value."
+                    }
+                  }
+                }
+            `,
+        },
+        {
+            code: 401,
+            body: `
+                {
+                  "code": 401,
+                  "message": "The request requires valid record authorization token to be set.",
+                  "data": {}
+                }
+            `,
+        },
+        {
+            code: 403,
+            body: `
+                {
+                  "code": 403,
+                  "message": "The authorized record model is not allowed to perform this action.",
+                  "data": {}
+                }
+            `,
+        },
+    ];
+</script>
+
+<h3 class="m-b-sm">Request email change ({collection.name})</h3>
+<div class="content txt-lg m-b-sm">
+    <p>Sends <strong>{collection.name}</strong> email change request.</p>
+</div>
+
+<SdkTabs
+    js={`
+        import PocketBase from 'pocketbase';
+
+        const pb = new PocketBase('${backendAbsUrl}');
+
+        ...
+
+        await pb.collection('${collection?.name}').authViaEmail('test@example.com', '123456');
+
+        await pb.collection('${collection?.name}').requestEmailChange('new@example.com');
+    `}
+    dart={`
+        import 'package:pocketbase/pocketbase.dart';
+
+        final pb = PocketBase('${backendAbsUrl}');
+
+        ...
+
+        await pb.collection('${collection?.name}').authViaEmail('test@example.com', '123456');
+
+        await pb.collection('${collection?.name}').requestEmailChange('new@example.com');
+    `}
+/>
+
+<h6 class="m-b-xs">API details</h6>
+<div class="alert alert-success">
+    <strong class="label label-primary">POST</strong>
+    <div class="content">
+        <p>
+            /api/collections/<strong>{collection.name}</strong>/confirm-email-change
+        </p>
+    </div>
+    <p class="txt-hint txt-sm txt-right">Requires record <code>Authorization:TOKEN</code> header</p>
+</div>
+
+<div class="section-title">Body Parameters</div>
+<table class="table-compact table-border m-b-base">
+    <thead>
+        <tr>
+            <th>Param</th>
+            <th>Type</th>
+            <th width="50%">Description</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>
+                <div class="inline-flex">
+                    <span class="label label-success">Required</span>
+                    <span>newEmail</span>
+                </div>
+            </td>
+            <td>
+                <span class="label">String</span>
+            </td>
+            <td>The new email address to send the change email request.</td>
+        </tr>
+    </tbody>
+</table>
+
+<div class="section-title">Responses</div>
+<div class="tabs">
+    <div class="tabs-header compact left">
+        {#each responses as response (response.code)}
+            <button
+                class="tab-item"
+                class:active={responseTab === response.code}
+                on:click={() => (responseTab = response.code)}
+            >
+                {response.code}
+            </button>
+        {/each}
+    </div>
+    <div class="tabs-content">
+        {#each responses as response (response.code)}
+            <div class="tab-item" class:active={responseTab === response.code}>
+                <CodeBlock content={response.body} />
+            </div>
+        {/each}
+    </div>
+</div>