Fixes loadSnapshot option arguments (#74)

.github/workflows/master.yml

@@ -18,10 +18,10 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Setup Deno v1.43.3
+      - name: Setup Deno v1.43.4
         uses: denoland/setup-deno@v1
         with:
-          deno-version: v1.43.3
+          deno-version: v1.43.4
 
       - name: Setup LCOV        
         run: sudo apt install -y lcov

README.md

@@ -10,6 +10,7 @@ A Deno SDK for Switcher API
 [![Master CI](https://github.com/switcherapi/switcher-client-deno/actions/workflows/master.yml/badge.svg)](https://github.com/switcherapi/switcher-client-deno/actions/workflows/master.yml)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=switcherapi_switcher-client-deno&metric=alert_status)](https://sonarcloud.io/dashboard?id=switcherapi_switcher-client-deno)
 [![deno.land/x/switcher4deno](http://shield.deno.dev/x/switcher4deno)](https://deno.land/x/switcher4deno)
+[![JSR](https://jsr.io/badges/@switcherapi/switcher-client-deno)](https://jsr.io/@switcherapi/switcher-client-deno)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Slack: Switcher-HQ](https://img.shields.io/badge/slack-@switcher/hq-blue.svg?logo=slack)](https://switcher-hq.slack.com/)
 
@@ -34,7 +35,7 @@ https://github.com/switcherapi/switcher-api
 ## Module initialization
 The context properties stores all information regarding connectivity.
 
-(*) Requires Deno 1.4x or higher (use `--unstable` flag for Deno lower than 1.4x)
+(*) Requires Deno 1.4x or higher (use `--unstable` flag for Deno versions lower than 1.4x)
 
 > Flags required
 ```
@@ -45,7 +46,8 @@ The context properties stores all information regarding connectivity.
 
 > Initialization
 ```ts
-import { Client } from "https://deno.land/x/switcher4deno@v[VERSION]/mod.ts";
+import { Client } from "@switcherapi/switcher-client-deno@[VERSION]"; // or
+import { Client } from 'https://deno.land/x/switcher4deno@v[VERSION]/mod.ts';
 
 const url = 'https://api.switcherapi.com';
 const apiKey = '[API_KEY]';

deno.jsonc

@@ -1,7 +1,7 @@
 {
   "name": "@switcherapi/switcher-client-deno",
-  "version": "2.0.0",
-  "description": "Switcher4Deno is a Feature Flag Deno SDK client for Switcher API",
+  "version": "2.0.1",
+  "description": "Switcher4Deno is a Feature Flag Deno Client SDK for Switcher API",
   "tasks": {
     "cache-reload": "deno cache --reload --lock=deno.lock --lock-write mod.ts",
     "fmt": "deno fmt mod.ts src/ --options-single-quote --options-line-width=120 --check",

deno.lock

@@ -2,23 +2,23 @@
   "version": "3",
   "packages": {
     "specifiers": {
-      "jsr:@std/assert@^0.224.0": "jsr:@std/assert@0.224.0",
-      "jsr:@std/fs@0.224.0": "jsr:@std/fs@0.224.0",
-      "jsr:@std/path@^0.224.0": "jsr:@std/path@0.224.0"
+      "jsr:@std/assert@^0.225.2": "jsr:@std/assert@0.225.2",
+      "jsr:@std/fs@0.229.1": "jsr:@std/fs@0.229.1",
+      "jsr:@std/path@^0.225.1": "jsr:@std/path@0.225.1"
     },
     "jsr": {
-      "@std/assert@0.224.0": {
-        "integrity": "8643233ec7aec38a940a8264a6e3eed9bfa44e7a71cc6b3c8874213ff401967f"
+      "@std/assert@0.225.2": {
+        "integrity": "6fd566c3ea01654d29c2b633298b7fc7599716336233852eb87e9843658fa192"
       },
-      "@std/fs@0.224.0": {
-        "integrity": "52a5ec89731ac0ca8f971079339286f88c571a4d61686acf75833f03a89d8e69",
+      "@std/fs@0.229.1": {
+        "integrity": "38d3fb31f0ca0a8c1118e039939188f32e291a3f7f17dc0868fec22024bdfadd",
         "dependencies": [
-          "jsr:@std/assert@^0.224.0",
-          "jsr:@std/path@^0.224.0"
+          "jsr:@std/assert@^0.225.2",
+          "jsr:@std/path@^0.225.1"
         ]
       },
-      "@std/path@0.224.0": {
-        "integrity": "55bca6361e5a6d158b9380e82d4981d82d338ec587de02951e2b7c3a24910ee6"
+      "@std/path@0.225.1": {
+        "integrity": "8c3220635a73730eb51fe43de9e10b79e2724a5bb8638b9355d35ae012fd9429"
       }
     }
   },

mod.ts

@@ -1,18 +1,3 @@
-// Copyright 2024-present the Switcher API authors. All rights reserved. MIT license.
-
-/**
- * Switcher Clinet SDK for working with Switcher API
- *
- * ```ts
- * Client.buildContext({ url, apiKey, domain, component, environment });
- *
- * const switcher = Client.getSwitcher();
- * await switcher.isItOn('SWITCHER_KEY'));
- * ```
- *
- * @module
- */
-
 export { Switcher } from './src/switcher.ts';
 export { Client } from './src/client.ts';
 export type { ResultDetail, SwitcherContext, SwitcherOptions } from './src/types/index.d.ts';

sonar-project.properties

@@ -1,7 +1,7 @@
 sonar.projectKey=switcherapi_switcher-client-deno
 sonar.projectName=switcher-client-deno
 sonar.organization=switcherapi
-sonar.projectVersion=2.0.0
+sonar.projectVersion=2.0.1
 
 sonar.javascript.lcov.reportPaths=coverage/report.lcov
 

src/client.ts

@@ -10,7 +10,7 @@ import {
   DEFAULT_TEST_MODE,
   SWITCHER_OPTIONS,
 } from './lib/constants.ts';
-import type { Snapshot, SwitcherContext, SwitcherOptions } from './types/index.d.ts';
+import type { LoadSnapshotOptions, Snapshot, SwitcherContext, SwitcherOptions } from './types/index.d.ts';
 import type Key from './lib/bypasser/key.ts';
 import TimedMatch from './lib/utils/timed-match/index.ts';
 import ExecutionLogger from './lib/utils/executionLogger.ts';
@@ -151,10 +151,9 @@ export class Client {
    * @param watchSnapshot when true, it will watch for snapshot file modifications
    * @param fetchRemote when true, it will initialize the snapshot from the API
    */
-  static async loadSnapshot(
-    watchSnapshot = false,
-    fetchRemote = false,
-  ): Promise<number> {
+  static async loadSnapshot(options: LoadSnapshotOptions = {}): Promise<number> {
+    const { fetchRemote = false, watchSnapshot = false } = options;
+
     Client._snapshot = loadDomain(
       util.get(Client._options.snapshotLocation, ''),
       util.get(Client._context.environment, DEFAULT_ENVIRONMENT),

src/deps.ts

@@ -1 +1 @@
-export { existsSync } from 'jsr:@std/fs@0.224.0';
+export { existsSync } from 'jsr:@std/fs@0.229.1';

src/types/index.d.ts

@@ -49,6 +49,11 @@ export type RetryOptions = {
   retryDurationIn: string;
 };
 
+export type LoadSnapshotOptions = {
+  watchSnapshot?: boolean;
+  fetchRemote?: boolean;
+};
+
 // Remote API types
 
 export type AuthResponse = {

test/playground/index.ts

@@ -16,7 +16,7 @@ let switcher: Switcher;
  */
 async function setupSwitcher(local: boolean) {
     Client.buildContext({ url, apiKey, domain, component, environment }, { local, logger: true });
-    await Client.loadSnapshot(false, local)
+    await Client.loadSnapshot({ fetchRemote: local })
         .then(version => console.log('Snapshot loaded - version:', version))
         .catch(() => console.log('Failed to load Snapshot'));
 }
@@ -136,7 +136,7 @@ const _testBypasser = async () => {
 // Requires remote API
 const _testWatchSnapshot = async () => {
     Client.buildContext({ url, apiKey, domain, component, environment }, { snapshotLocation, local: true, logger: true });
-    await Client.loadSnapshot(false, true)
+    await Client.loadSnapshot({ fetchRemote: true })
         .then(() => console.log('Snapshot loaded'))
         .catch(() => console.log('Failed to load Snapshot'));
 
@@ -153,7 +153,7 @@ const _testSnapshotAutoUpdate = async () => {
     Client.buildContext({ url, apiKey, domain, component, environment }, 
         { local: true, logger: true });
 
-    await Client.loadSnapshot(false, true);
+    await Client.loadSnapshot({ fetchRemote: true });
     const switcher = Client.getSwitcher();
 
     Client.scheduleSnapshotAutoUpdate(3, {

test/switcher-client.test.ts

@@ -241,7 +241,7 @@ describe('E2E test - Client local:', function () {
       snapshotLocation: 'generated-snapshots/'
     });
 
-    const version = await Client.loadSnapshot(false, false);
+    const version = await Client.loadSnapshot();
     assertEquals(version, 0);
     assertExists(Client.snapshot);
   });
@@ -264,7 +264,7 @@ describe('E2E test - Client local:', function () {
 
     //or
     let error: Error | undefined;
-    await Client.loadSnapshot(false, false).catch((e) => error = e);
+    await Client.loadSnapshot().catch((e) => error = e);
     assertEquals(error?.message, 'Something went wrong: It was not possible to load the file at //somewhere/');
   });
 

test/switcher-snapshot.test.ts

@@ -106,7 +106,7 @@ describe('E2E test - Client local - Snapshot:', function () {
       regexSafe: false
     });
 
-    await Client.loadSnapshot(true);
+    await Client.loadSnapshot({ watchSnapshot: true });
     assertTrue(await Client.checkSnapshot());
     assertTrue(existsSync(`generated-snapshots/${contextSettings.environment}.json`));
 
@@ -129,7 +129,7 @@ describe('E2E test - Client local - Snapshot:', function () {
       regexSafe: false
     });
 
-    await Client.loadSnapshot(true, true);
+    await Client.loadSnapshot({ watchSnapshot: true, fetchRemote: true });
     assertTrue(existsSync(`generated-snapshots/${contextSettings.environment}.json`));
 
     //restore state to avoid process leakage
@@ -157,7 +157,7 @@ describe('E2E test - Client local - Snapshot:', function () {
       success: (updated) => snapshotUpdated = updated
     });
 
-    await Client.loadSnapshot(false, true);
+    await Client.loadSnapshot({ fetchRemote: true });
 
     const switcher = Client.getSwitcher();
     assertFalse(await switcher.isItOn('FF2FOR2030'));
@@ -194,7 +194,7 @@ describe('E2E test - Client local - Snapshot:', function () {
       reject: (err: Error) => error = err
     });
 
-    await Client.loadSnapshot(false, true);
+    await Client.loadSnapshot({ fetchRemote: true });
 
     //next call will fail
     givenError('POST@/graphql', 'ECONNREFUSED');