@redis/json 1.0.4 → 1.0.5

package/README.md

@@ -1,6 +1,6 @@
 # @redis/json
 
-This package provides support for the [RedisJSON](https://redisjson.io) module, which adds JSON as a native data type to Redis.  It extends the [Node Redis client](https://github.com/redis/node-redis) to include functions for each of the RedisJSON commands.
+This package provides support for the [RedisJSON](https://redis.io/docs/stack/json/) module, which adds JSON as a native data type to Redis.  It extends the [Node Redis client](https://github.com/redis/node-redis) to include functions for each of the RedisJSON commands.
 
 To use these extra commands, your Redis server must have the RedisJSON module installed.
 
@@ -10,7 +10,7 @@ For a complete example, see [`managing-json.js`](https://github.com/redis/node-r
 
 ### Storing JSON Documents in Redis
 
-The [`JSON.SET`](https://oss.redis.com/redisjson/commands/#jsonset) command stores a JSON value at a given JSON Path in a Redis key.
+The [`JSON.SET`](https://redis.io/commands/json.set/) command stores a JSON value at a given JSON Path in a Redis key.
 
 Here, we'll store a JSON document in the root of the Redis key "`mydoc`":
 
@@ -37,11 +37,11 @@ await client.json.set('noderedis:jsondata', '$', {
 });
 ```
 
-For more information about RedisJSON's path syntax, [check out the documentation](https://oss.redis.com/redisjson/path/).
+For more information about RedisJSON's path syntax, [check out the documentation](https://redis.io/docs/stack/json/path/).
 
 ### Retrieving JSON Documents from Redis
 
-With RedisJSON, we can retrieve all or part(s) of a JSON document using the [`JSON.GET`]() command and one or more JSON Paths.  Let's get the name and age of one of the pets:
+With RedisJSON, we can retrieve all or part(s) of a JSON document using the [`JSON.GET`](https://redis.io/commands/json.get/) command and one or more JSON Paths.  Let's get the name and age of one of the pets:
 
 ```javascript
 const results = await client.json.get('noderedis:jsondata', {
@@ -62,19 +62,19 @@ const results = await client.json.get('noderedis:jsondata', {
 
 RedisJSON includes commands that can atomically update values in a JSON document, in place in Redis without having to first retrieve the entire document.
 
-Using the [`JSON.NUMINCRBY`](https://oss.redis.com/redisjson/commands/#jsonnumincrby) command, we can update the age of one of the pets like this:
+Using the [`JSON.NUMINCRBY`](https://redis.io/commands/json.numincrby/) command, we can update the age of one of the pets like this:
 
 ```javascript
 await client.json.numIncrBy('noderedis:jsondata', '.pets[1].age', 1);
 ```
 
-And we can add a new object to the pets array with the [`JSON.ARRAPPEND`](https://oss.redis.com/redisjson/commands/#jsonarrappend) command:
+And we can add a new object to the pets array with the [`JSON.ARRAPPEND`](https://redis.io/commands/json.arrappend/) command:
 
 ```javascript
- await client.json.arrAppend('noderedis:jsondata', '.pets', {
-    name: 'Robin',
-    species: 'bird',
-    age: 1,
-    isMammal: false
-  });
+await client.json.arrAppend('noderedis:jsondata', '.pets', {
+  name: 'Robin',
+  species: 'bird',
+  age: 1,
+  isMammal: false
+});
 ```

package/dist/commands/MERGE.d.ts

@@ -0,0 +1,4 @@
+import { RedisJSON } from '.';
+export declare const FIRST_KEY_INDEX = 1;
+export declare function transformArguments(key: string, path: string, json: RedisJSON): Array<string>;
+export declare function transformReply(): 'OK';

package/dist/commands/MERGE.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformArguments = exports.FIRST_KEY_INDEX = void 0;
+const _1 = require(".");
+exports.FIRST_KEY_INDEX = 1;
+function transformArguments(key, path, json) {
+    return ['JSON.MERGE', key, path, (0, _1.transformRedisJsonArgument)(json)];
+}
+exports.transformArguments = transformArguments;

package/dist/commands/MSET.d.ts

@@ -0,0 +1,11 @@
+import { RedisJSON } from '.';
+import { RedisCommandArgument } from '@redis/client/dist/lib/commands';
+export declare const FIRST_KEY_INDEX = 1;
+interface JsonMSetItem {
+    key: RedisCommandArgument;
+    path: RedisCommandArgument;
+    value: RedisJSON;
+}
+export declare function transformArguments(items: Array<JsonMSetItem>): Array<string>;
+export declare function transformReply(): 'OK';
+export {};

package/dist/commands/MSET.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformArguments = exports.FIRST_KEY_INDEX = void 0;
+const _1 = require(".");
+exports.FIRST_KEY_INDEX = 1;
+function transformArguments(items) {
+    const args = new Array(1 + items.length * 3);
+    args[0] = 'JSON.MSET';
+    let argsIndex = 1;
+    for (let i = 0; i < items.length; i++) {
+        const item = items[i];
+        args[argsIndex++] = item.key;
+        args[argsIndex++] = item.path;
+        args[argsIndex++] = (0, _1.transformRedisJsonArgument)(item.value);
+    }
+    return args;
+}
+exports.transformArguments = transformArguments;

package/dist/commands/RESP.d.ts

@@ -1,5 +1,5 @@
 export declare const FIRST_KEY_INDEX = 1;
 export declare function transformArguments(key: string, path?: string): Array<string>;
-declare type RESPReply = Array<string | number | RESPReply>;
+type RESPReply = Array<string | number | RESPReply>;
 export declare function transformReply(): RESPReply;
 export {};

package/dist/commands/STRAPPEND.d.ts

@@ -1,6 +1,6 @@
 export declare const FIRST_KEY_INDEX = 1;
-declare type AppendArguments = [key: string, append: string];
-declare type AppendWithPathArguments = [key: string, path: string, append: string];
+type AppendArguments = [key: string, append: string];
+type AppendWithPathArguments = [key: string, path: string, append: string];
 export declare function transformArguments(...[key, pathOrAppend, append]: AppendArguments | AppendWithPathArguments): Array<string>;
 export declare function transformReply(): number | Array<number>;
 export {};

package/dist/commands/index.d.ts

@@ -8,7 +8,9 @@ import * as DEBUG_MEMORY from './DEBUG_MEMORY';
 import * as DEL from './DEL';
 import * as FORGET from './FORGET';
 import * as GET from './GET';
+import * as MERGE from './MERGE';
 import * as MGET from './MGET';
+import * as MSET from './MSET';
 import * as NUMINCRBY from './NUMINCRBY';
 import * as NUMMULTBY from './NUMMULTBY';
 import * as OBJKEYS from './OBJKEYS';
@@ -39,8 +41,12 @@ declare const _default: {
     forget: typeof FORGET;
     GET: typeof GET;
     get: typeof GET;
+    MERGE: typeof MERGE;
+    merge: typeof MERGE;
     MGET: typeof MGET;
     mGet: typeof MGET;
+    MSET: typeof MSET;
+    mSet: typeof MSET;
     NUMINCRBY: typeof NUMINCRBY;
     numIncrBy: typeof NUMINCRBY;
     NUMMULTBY: typeof NUMMULTBY;
@@ -67,7 +73,7 @@ interface RedisJSONObject {
     [key: string]: RedisJSON;
     [key: number]: RedisJSON;
 }
-export declare type RedisJSON = null | boolean | number | string | Date | RedisJSONArray | RedisJSONObject;
+export type RedisJSON = null | boolean | number | string | Date | RedisJSONArray | RedisJSONObject;
 export declare function transformRedisJsonArgument(json: RedisJSON): string;
 export declare function transformRedisJsonReply(json: string): RedisJSON;
 export declare function transformRedisJsonNullReply(json: string | null): RedisJSON | null;

package/dist/commands/index.js

@@ -11,7 +11,9 @@ const DEBUG_MEMORY = require("./DEBUG_MEMORY");
 const DEL = require("./DEL");
 const FORGET = require("./FORGET");
 const GET = require("./GET");
+const MERGE = require("./MERGE");
 const MGET = require("./MGET");
+const MSET = require("./MSET");
 const NUMINCRBY = require("./NUMINCRBY");
 const NUMMULTBY = require("./NUMMULTBY");
 const OBJKEYS = require("./OBJKEYS");
@@ -42,8 +44,12 @@ exports.default = {
     forget: FORGET,
     GET,
     get: GET,
+    MERGE,
+    merge: MERGE,
     MGET,
     mGet: MGET,
+    MSET,
+    mSet: MSET,
     NUMINCRBY,
     numIncrBy: NUMINCRBY,
     NUMMULTBY,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redis/json",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "license": "MIT",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -18,12 +18,24 @@
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "@redis/test-utils": "*",
-    "@types/node": "^18.7.10",
+    "@types/node": "^20.6.2",
     "nyc": "^15.1.0",
-    "release-it": "^15.3.0",
+    "release-it": "^16.1.5",
     "source-map-support": "^0.5.21",
     "ts-node": "^10.9.1",
-    "typedoc": "^0.23.10",
-    "typescript": "^4.7.4"
-  }
+    "typedoc": "^0.25.1",
+    "typescript": "^5.2.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/redis/node-redis.git"
+  },
+  "bugs": {
+    "url": "https://github.com/redis/node-redis/issues"
+  },
+  "homepage": "https://github.com/redis/node-redis/tree/master/packages/json",
+  "keywords": [
+    "redis",
+    "RedisJSON"
+  ]
 }