npm - @duckity/js - Versions diffs - 0.1.0 - Mend

@duckity/js 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/examples/example.html +11 -0
package/package.json +23 -0
package/rollup.config.ts +11 -0
package/src/index.ts +56 -0
package/src/processing/worker.ts +16 -0
package/src/processing/wrapper.ts +18 -0
package/src/requests.ts +74 -0
package/tsconfig.json +31 -0

package/examples/example.html ADDED Viewed

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Duckity @duckity/js Example</title>
+</head>
+<body>
+    <script src=""></script>
+</body>
+</html>

package/package.json ADDED Viewed

@@ -0,0 +1,23 @@
+{
+  "name": "@duckity/js",
+  "version": "0.1.0",
+  "module": "src/index.ts",
+  "scripts": {
+    "bundle": "rollup --config rollup.config.ts --configPlugin typescript"
+  },
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^12.3.0",
+    "@rollup/plugin-wasm": "^6.2.2",
+    "@types/bun": "latest",
+    "rollup": "^4.62.3",
+    "rollup-plugin-web-worker-loader": "^1.7.0",
+    "tsdown": "^0.22.14"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "collaborators": [
+    "Rafael Bradley <rafabradleyrb@gmail.com>"
+  ],
+  "type": "module"
+}

package/rollup.config.ts ADDED Viewed

@@ -0,0 +1,11 @@
+import typescript from "@rollup/plugin-typescript";
+import { wasm } from "@rollup/plugin-wasm";
+export default {
+  input: "src/index.ts",
+  output: {
+    dir: "dist",
+    format: "esm",
+  },
+  plugins: [typescript(), wasm()],
+};

package/src/index.ts ADDED Viewed

@@ -0,0 +1,56 @@
+import wrapper from "./processing/wrapper";
+import { post } from "./requests";
+/**
+ * Options for getting a Duckity challenge from the API.
+ */
+export interface GetDuckityChallengeOptions {
+  /**
+   * The custom-context threat correlation keys to be sent with the request.
+   */
+  keys?: { [key: string]: string };
+  /**
+   * The base URL to the API endpoint. Defaults to `https://quack.duckity.com` if not provided.
+   *
+   * Update this when self-hosting a Duckling. No trailing slash must be included in the URL.
+   */
+  api?: string;
+}
+/**
+ * The response from the Duckling API when requesting a challenge.
+ */
+interface ChallengeResponse {
+  /**
+   * The encoded challenge string returned by the Duckling API.
+   */
+  challenge: string;
+}
+/**
+ * Fetches, solves, and returns the solution to a Duckity challenge for the given protection
+ * profile ID.
+ *
+ * @param protectionProfileId The ID of the protection profile to get the challenge for.
+ * @param options Optional parameters for the challenge issuance.
+ * @returns The solution to the challenge issued by Duckity.
+ */
+export async function solve(
+  protectionProfileId: string,
+  options?: GetDuckityChallengeOptions,
+): Promise<string> {
+  let response: ChallengeResponse = await post(
+    `${options?.api || "https://quack.duckity.com"}/v1/challenge`,
+    {
+      body: {
+        id: protectionProfileId,
+        keys: options?.keys || {},
+      },
+    },
+  );
+  let solution = await wrapper.solve(response.challenge);
+  return solution;
+}

package/src/processing/worker.ts ADDED Viewed

@@ -0,0 +1,16 @@
+import * as Comlink from "comlink";
+import { process } from "@duckity/wasm";
+/**
+ * Expose the `process` function from the WASM module to the main thread via Comlink.
+ *
+ * This allows the main thread to call the `process` function in the worker thread, which will
+ * handle the processing of the challenges without blocking the main thread.
+ */
+const api = {
+  async process(challenge: string) {
+    return process(challenge);
+  },
+};
+Comlink.expose(api);

package/src/processing/wrapper.ts ADDED Viewed

@@ -0,0 +1,18 @@
+import wasm from "@duckity/wasm/duckity_wasm_bg.wasm";
+import * as Comlink from "comlink";
+/**
+ * Web Worker that handles the processing of the challenges.
+ */
+const worker = new Worker(, {
+  type: "module",
+});
+/**
+ * Wrap the worker with Comlink to allow for easy communication between the main thread and the
+ * worker thread. The worker exposes a `solve` function that takes a challenge string and returns a
+ * promise that resolves to the solution string.
+ */
+export default Comlink.wrap<{
+  solve(challenge: string): Promise<string>;
+}>(worker);

package/src/requests.ts ADDED Viewed

@@ -0,0 +1,74 @@
+/**
+ * Error schema for API responses. This is used to extract error messages from failed requests.
+ */
+interface ErrorMessage {
+  title: string;
+  message: string;
+}
+/**
+ * Wrapper function for making HTTP requests using the Fetch API. It handles JSON parsing and error
+ * handling, throwing an error with a message extracted from the response if the request fails.
+ *
+ * @param url The URL to make the request to.
+ * @param options Extra options to pass to the Fetch API, such as method, headers, and body.
+ * @returns The parsed JSON response from the server if the request is successful.
+ */
+async function request<T>(url: string, options?: RequestInit): Promise<T> {
+  const response = await fetch(url, options);
+  let data;
+  try {
+    data = await response.json();
+  } catch {
+    data = await response.text();
+  }
+  if (!response.ok) {
+    throw new Error(
+      (data as ErrorMessage | undefined)?.message || "Request failed",
+    );
+  }
+  return data as T;
+}
+/**
+ * Makes a GET request to the specified URL and returns the parsed JSON response.
+ *
+ * If the request fails, it throws an error with a message extracted from the response if
+ * available, or a generic message if not.
+ *
+ * @param url The URL to make the request to.
+ * @param options Extra options to pass to the Fetch API, such as headers and body.
+ * @returns The parsed JSON response from the server if the request is successful.
+ */
+export function get<T>(url: string, options?: RequestInit): Promise<T> {
+  return request(url, {
+    method: "GET",
+    ...options,
+  });
+}
+/**
+ * Makes a POST request to the specified URL and returns the parsed JSON response.
+ *
+ * If the request fails, it throws an error with a message extracted from the response if
+ * available, or a generic message if not.
+ *
+ * @param url The URL to make the request to.
+ * @param options Extra options to pass to the Fetch API, such as headers and body.
+ * @returns The parsed JSON response from the server if the request is successful.
+ */
+export function post<T>(url: string, options?: Omit<RequestInit, "body"> & { body: any }): Promise<T> {
+  return request(url, {
+    method: "POST",
+    headers: {
+      "Content-Type": "application/json",
+      ...options?.headers,
+    },
+    body: options?.body ? JSON.stringify(options.body) : undefined,
+    ...options,
+  });
+}

package/tsconfig.json ADDED Viewed

@@ -0,0 +1,31 @@
+{
+  "compilerOptions": {
+    // Environment setup & latest features
+    "lib": ["ESNext"],
+    "target": "ESNext",
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+    "types": ["bun"],
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+    "outDir": "dist",
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  }
+}