From d37d50a2a95eae9394b875ea582579b07269c68d Mon Sep 17 00:00:00 2001
From: meili-bot <74670311+meili-bot@users.noreply.github.com>
Date: Tue, 24 Oct 2023 21:02:43 +0200
Subject: [PATCH 1/3] Update README.md


From a22d842eaceb9272ab809ab9de8f0e6c6086d674 Mon Sep 17 00:00:00 2001
From: Bruno Casali <brunoocasali@gmail.com>
Date: Tue, 14 Nov 2023 19:06:21 -0300
Subject: [PATCH 2/3] Add createSnapshot() method

---
 README.md               |  7 +++++
 src/clients/client.ts   | 16 ++++++++++
 tests/snapshots.test.ts | 70 +++++++++++++++++++++++++++++++++++++++++
 3 files changed, 93 insertions(+)
 create mode 100644 tests/snapshots.test.ts

diff --git a/README.md b/README.md
index 49d85101d..4d9651661 100644
--- a/README.md
+++ b/README.md
@@ -1039,6 +1039,13 @@ client.getVersion(): Promise<Version>
 client.createDump(): Promise<EnqueuedTask>
 ```
 
+### Snapshots <!-- omit in toc -->
+
+#### [Trigger a snapshot on-demand process](https://www.meilisearch.com/docs/reference/api/snapshots#create-a-snapshot)
+
+```ts
+client.createSnapshot(): Promise<EnqueuedTask>
+```
 ---
 
 Meilisearch provides and maintains many SDKs and integration tools like this one. We want to provide everyone with an **amazing search experience for any kind of project**. For a full overview of everything we create and maintain, take a look at the [integration-guides](https://github.com/meilisearch/integration-guides) repository.
diff --git a/src/clients/client.ts b/src/clients/client.ts
index 416675dd8..3cd9c6b74 100644
--- a/src/clients/client.ts
+++ b/src/clients/client.ts
@@ -443,6 +443,22 @@ class Client {
     return new EnqueuedTask(task)
   }
 
+  ///
+  /// SNAPSHOTS
+  ///
+
+  /**
+   * Creates a snapshot
+   *
+   * @returns Promise returning object of the enqueued task
+   */
+  async createSnapshot(): Promise<EnqueuedTask> {
+    const url = `snapshots`
+    const task = await this.httpRequest.post<undefined, EnqueuedTaskObject>(url)
+
+    return new EnqueuedTask(task)
+  }
+
   ///
   /// TOKENS
   ///
diff --git a/tests/snapshots.test.ts b/tests/snapshots.test.ts
new file mode 100644
index 000000000..b77e20bf7
--- /dev/null
+++ b/tests/snapshots.test.ts
@@ -0,0 +1,70 @@
+import { ErrorStatusCode } from '../src/types'
+import {
+  clearAllIndexes,
+  config,
+  MeiliSearch,
+  BAD_HOST,
+  getClient,
+} from './utils/meilisearch-test-utils'
+
+beforeEach(async () => {
+  await clearAllIndexes(config)
+})
+
+describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
+  'Test on snapshot',
+  ({ permission }) => {
+    test(`${permission} key: create a new snapshot`, async () => {
+      const client = await getClient(permission)
+      const { taskUid } = await client.createSnapshot()
+
+      await client.waitForTask(taskUid)
+    })
+  }
+)
+
+describe.each([{ permission: 'Search' }])(
+  'Test on snapshot with search api key should not have access',
+  ({ permission }) => {
+    test(`${permission} key: try to create snapshot with search key and be denied`, async () => {
+      const client = await getClient(permission)
+      await expect(client.createSnapshot()).rejects.toHaveProperty(
+        'code',
+        ErrorStatusCode.INVALID_API_KEY
+      )
+    })
+  }
+)
+
+describe.each([{ permission: 'No' }])(
+  'Test on snapshot without api key should not have access',
+  ({ permission }) => {
+    test(`${permission} key: try to create snapshot with no key and be denied`, async () => {
+      const client = await getClient(permission)
+      await expect(client.createSnapshot()).rejects.toHaveProperty(
+        'code',
+        ErrorStatusCode.MISSING_AUTHORIZATION_HEADER
+      )
+    })
+  }
+)
+
+describe.each([
+  { host: BAD_HOST, trailing: false },
+  { host: `${BAD_HOST}/api`, trailing: false },
+  { host: `${BAD_HOST}/trailing/`, trailing: true },
+])('Tests on url construction', ({ host, trailing }) => {
+  test(`Test createSnapshot route`, async () => {
+    const route = `snapshots`
+    const client = new MeiliSearch({ host })
+    const strippedHost = trailing ? host.slice(0, -1) : host
+
+    await expect(client.createSnapshot()).rejects.toHaveProperty(
+      'message',
+      `request to ${strippedHost}/${route} failed, reason: connect ECONNREFUSED ${BAD_HOST.replace(
+        'http://',
+        ''
+      )}`
+    )
+  })
+})

From d9b93ad59692c9faf14f55dd16d627a0df6f5e6b Mon Sep 17 00:00:00 2001
From: Bruno Casali <brunoocasali@gmail.com>
Date: Tue, 14 Nov 2023 19:29:19 -0300
Subject: [PATCH 3/3] Add code-sample for snapshot creation

---
 .code-samples.meilisearch.yaml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/.code-samples.meilisearch.yaml b/.code-samples.meilisearch.yaml
index bde5b1b98..388931623 100644
--- a/.code-samples.meilisearch.yaml
+++ b/.code-samples.meilisearch.yaml
@@ -549,6 +549,8 @@ faceted_search_1: |-
   client.index('books').search('classic', { facets: ['genres', 'rating', 'language'] })
 post_dump_1: |-
   client.createDump()
+create_snapshot_1: |-
+  client.createSnapshot()
 phrase_search_1: |-
   client.index('movies')
     .search('"african american" horror')