@vercel/stega 0.0.4 → 0.0.5

package/README.md

@@ -0,0 +1,52 @@
+# @vercel/stega
+
+A simple [steganography](https://en.wikipedia.org/wiki/Steganography) library for adding hidden JSON data to strings.
+
+## Usage
+
+This package exports a few methods for encoding and decoding data. All of these methods have TypeScript type definitions and JSDoc comments explaining their parameters and return values.
+
+### `vercelStegaCombine(string, json, skip = 'auto')`
+
+This method combines a `string` with some JSON data and returns the result. The `json` can be any value that can be JSON stringified.
+
+When the `skip` property is `true`, the original string will be returned without combining the `json`. It supports `boolean` values and `'auto'`. The default is `'auto'`, which will only skip encoding when the `string` is an ISO date string or a URL.
+
+```js
+vercelStegaCombine('Hello world', { foo: 'bar' });
+// -> 'Hello world' (the JSON data is hidden in the new string)
+```
+
+### `vercelStegaEncode(json)`
+
+This method encodes JSON data as a hidden string and returns the result. The `json` can be any value that can be JSON stringified.
+
+```js
+vercelStegaEncode({ foo: 'bar' });
+// -> '' (the JSON data is hidden)
+```
+
+### `vercelStegaSplit(string)`
+
+This method splits out the original string (cleaned) and the encoded portion of the string.
+
+```js
+// In 'Hello world' (the extra data is hidden)
+vercelStegaSplit('Hello world');
+/*
+ * -> {
+ *  cleaned: 'Hello world', // This doesn't contains the encoded data
+ *  encoded: '', // This is not an empty string, it contains the encoded data
+ * }
+ */
+```
+
+### `vercelStegaDecode(string)`
+
+This method attempts to extract encoded JSON data from a `string`.
+
+```js
+// In 'Hello world' (the extra data is hidden)
+vercelStegaDecode('Hello world');
+// -> { foo: 'bar' }
+```

package/dist/cjs/encode.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.vercelStegaEncode = void 0;
+exports.vercelStegaCombine = exports.vercelStegaEncode = void 0;
 const map_1 = require("./map");
 /**
  * Encodes JSON as a hidden string
@@ -22,3 +22,29 @@ function vercelStegaEncode(json) {
         .join('');
 }
 exports.vercelStegaEncode = vercelStegaEncode;
+function isDate(string) {
+    return Boolean(Date.parse(string));
+}
+function isUrl(string) {
+    try {
+        new URL(string);
+    }
+    catch {
+        return false;
+    }
+    return true;
+}
+/**
+ * Adds an encoded JSON object to a string as hidden characters
+ * @param string - The string the JSON will be added to
+ * @param json - The JSON to add to the string
+ * @param skip - Whether to skip encoding (default: "auto")
+ */
+function vercelStegaCombine(string, json, skip = 'auto') {
+    if (skip === true)
+        return string;
+    if (skip === 'auto' && (isDate(string) || isUrl(string)))
+        return string;
+    return `${string}${vercelStegaEncode(json)}`;
+}
+exports.vercelStegaCombine = vercelStegaCombine;

package/dist/encode.d.ts

@@ -4,3 +4,12 @@
  * @returns The hidden string
  */
 export declare function vercelStegaEncode<T>(json: T): string;
+type SkipValue = 'auto' | boolean;
+/**
+ * Adds an encoded JSON object to a string as hidden characters
+ * @param string - The string the JSON will be added to
+ * @param json - The JSON to add to the string
+ * @param skip - Whether to skip encoding (default: "auto")
+ */
+export declare function vercelStegaCombine<T>(string: string, json: T, skip?: SkipValue): string;
+export {};

package/dist/esm/encode.js

@@ -18,3 +18,28 @@ export function vercelStegaEncode(json) {
     })
         .join('');
 }
+function isDate(string) {
+    return Boolean(Date.parse(string));
+}
+function isUrl(string) {
+    try {
+        new URL(string);
+    }
+    catch {
+        return false;
+    }
+    return true;
+}
+/**
+ * Adds an encoded JSON object to a string as hidden characters
+ * @param string - The string the JSON will be added to
+ * @param json - The JSON to add to the string
+ * @param skip - Whether to skip encoding (default: "auto")
+ */
+export function vercelStegaCombine(string, json, skip = 'auto') {
+    if (skip === true)
+        return string;
+    if (skip === 'auto' && (isDate(string) || isUrl(string)))
+        return string;
+    return `${string}${vercelStegaEncode(json)}`;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/stega",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Utilities for steganography",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",