@nats-io/kv 3.0.0-10

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,158 @@
+# kv
+
+The kv module implements the NATS KV functionality using JetStream for
+JavaScript clients. JetStream clients can use streams to store and access data.
+KV is materialized view that presents a different _API_ to interact with the
+data stored in a stream using the API for a Key-Value store which should be
+familiar to many application developers.
+
+## Installation
+
+Note that this library is distributed in two different registries:
+
+- npm a node-specific library supporting CJS (`require`) and ESM (`import`)
+- jsr a node and other ESM (`import`) compatible runtimes (deno, browser, node)
+
+If your application doesn't use `require`, you can simply depend on the JSR
+version.
+
+### NPM
+
+The NPM registry hosts a node-only compatible version of the library
+[@nats-io/kv](https://www.npmjs.com/package/@nats-io/kv) supporting both CJS and
+ESM:
+
+```bash
+npm install @nats-io/kv
+```
+
+### JSR
+
+The JSR registry hosts the ESM-only [@nats-io/kv](https://jsr.io/@nats-io/kv)
+version of the library.
+
+```bash
+deno add @nats-io/kv
+```
+
+```bash
+npx jsr add @nats-io/kv
+```
+
+```bash
+yarn dlx jsr add @nats-io/kv
+```
+
+```bash
+bunx jsr add @nats-io/kv
+```
+
+## Referencing the library
+
+Once you import the library, you can reference in your code as:
+
+```javascript
+import { Kvm } from "@nats-io/kv";
+
+// or in node (only when using CJS)
+const { Kvm } = require("@nats-io/kv");
+
+// using a nats connection:
+const kvm = new Kvm(nc);
+await kvm.list();
+await kvm.create("mykv");
+```
+
+If you want to customize some of the JetStream options when working with KV, you
+can:
+
+```typescript
+import { jetStream } from "@nats-io/jetstream";
+import { Kvm } from "@nats-io/kv";
+
+const js = jetstream(nc, { timeout: 10_000 });
+// KV will inherit all the options from the JetStream client
+const kvm = new Kvm(js);
+```
+
+```typescript
+// create the named KV or bind to it if it exists:
+const kvm = new Kvm(nc);
+const kv = await kvm.create("testing", { history: 5 });
+// if the kv is expected to exist:
+// const kv = await kvm.open("testing");
+
+// create an entry - this is similar to a put, but will fail if the
+// key exists
+const hw = await kv.create("hello.world", "hi");
+
+// Values in KV are stored as KvEntries:
+// {
+//   bucket: string,
+//   key: string,
+//   value: Uint8Array,
+//   created: Date,
+//   revision: number,
+//   delta?: number,
+//   operation: "PUT"|"DEL"|"PURGE"
+// }
+// The operation property specifies whether the value was
+// updated (PUT), deleted (DEL) or purged (PURGE).
+
+// you can monitor values modification in a KV by watching.
+// You can watch specific key subset or everything.
+// Watches start with the latest value for each key in the
+// set of keys being watched - in this case all keys
+const watch = await kv.watch();
+(async () => {
+  for await (const e of watch) {
+    // do something with the change
+    console.log(
+      `watch: ${e.key}: ${e.operation} ${e.value ? e.string() : ""}`,
+    );
+  }
+})().then();
+
+// update the entry
+await kv.put("hello.world", sc.encode("world"));
+// retrieve the KvEntry storing the value
+// returns null if the value is not found
+const e = await kv.get("hello.world");
+// initial value of "hi" was overwritten above
+console.log(`value for get ${e?.string()}`);
+
+const buf: string[] = [];
+const keys = await kv.keys();
+await (async () => {
+  for await (const k of keys) {
+    buf.push(k);
+  }
+})();
+console.log(`keys contains hello.world: ${buf[0] === "hello.world"}`);
+
+let h = await kv.history({ key: "hello.world" });
+await (async () => {
+  for await (const e of h) {
+    // do something with the historical value
+    // you can test e.operation for "PUT", "DEL", or "PURGE"
+    // to know if the entry is a marker for a value set
+    // or for a deletion or purge.
+    console.log(
+      `history: ${e.key}: ${e.operation} ${e.value ? sc.decode(e.value) : ""}`,
+    );
+  }
+})();
+
+// deletes the key - the delete is recorded
+await kv.delete("hello.world");
+
+// purge is like delete, but all history values
+// are dropped and only the purge remains.
+await kv.purge("hello.world");
+
+// stop the watch operation above
+watch.stop();
+
+// danger: destroys all values in the KV!
+await kv.destroy();
+```

package/lib/internal_mod.d.ts

@@ -0,0 +1,3 @@
+export type { KV, KvCodec, KvCodecs, KvDeleteOptions, KvEntry, KvLimits, KvOptions, KvPutOptions, KvStatus, KvWatchEntry, KvWatchOptions, RoKV, } from "./types";
+export { kvPrefix, KvWatchInclude } from "./types";
+export { Base64KeyCodec, Bucket, defaultBucketOpts, Kvm, NoopKvCodecs, validateBucket, validateKey, } from "./kv";

package/lib/internal_mod.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateKey = exports.validateBucket = exports.NoopKvCodecs = exports.Kvm = exports.defaultBucketOpts = exports.Bucket = exports.Base64KeyCodec = exports.KvWatchInclude = exports.kvPrefix = void 0;
+var types_1 = require("./types");
+Object.defineProperty(exports, "kvPrefix", { enumerable: true, get: function () { return types_1.kvPrefix; } });
+Object.defineProperty(exports, "KvWatchInclude", { enumerable: true, get: function () { return types_1.KvWatchInclude; } });
+var kv_1 = require("./kv");
+Object.defineProperty(exports, "Base64KeyCodec", { enumerable: true, get: function () { return kv_1.Base64KeyCodec; } });
+Object.defineProperty(exports, "Bucket", { enumerable: true, get: function () { return kv_1.Bucket; } });
+Object.defineProperty(exports, "defaultBucketOpts", { enumerable: true, get: function () { return kv_1.defaultBucketOpts; } });
+Object.defineProperty(exports, "Kvm", { enumerable: true, get: function () { return kv_1.Kvm; } });
+Object.defineProperty(exports, "NoopKvCodecs", { enumerable: true, get: function () { return kv_1.NoopKvCodecs; } });
+Object.defineProperty(exports, "validateBucket", { enumerable: true, get: function () { return kv_1.validateBucket; } });
+Object.defineProperty(exports, "validateKey", { enumerable: true, get: function () { return kv_1.validateKey; } });
+//# sourceMappingURL=internal_mod.js.map

package/lib/internal_mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal_mod.js","sourceRoot":"","sources":["../build/src/internal_mod.ts"],"names":[],"mappings":";;;AAeA,iCAAmD;AAA1C,iGAAA,QAAQ,OAAA;AAAE,uGAAA,cAAc,OAAA;AAEjC,2BAQc;AAPZ,oGAAA,cAAc,OAAA;AACd,4FAAA,MAAM,OAAA;AACN,uGAAA,iBAAiB,OAAA;AACjB,yFAAA,GAAG,OAAA;AACH,kGAAA,YAAY,OAAA;AACZ,oGAAA,cAAc,OAAA;AACd,iGAAA,WAAW,OAAA"}

package/lib/kv.d.ts

@@ -0,0 +1,121 @@
+import type { MsgHdrs, NatsConnection, Payload, QueuedIterator } from "@nats-io/nats-core/internal";
+import { StorageType } from "@nats-io/jetstream/internal";
+import type { ConsumerConfig, JetStreamClient, JetStreamClientImpl, JetStreamManager, JsMsg, Lister, Placement, PurgeOpts, PurgeResponse, Republish, StoredMsg, StreamInfo } from "@nats-io/jetstream/internal";
+import type { KV, KvCodec, KvCodecs, KvDeleteOptions, KvEntry, KvOptions, KvPutOptions, KvRemove, KvStatus, KvWatchEntry, KvWatchOptions } from "./types";
+import { KvWatchInclude } from "./types";
+export declare function Base64KeyCodec(): KvCodec<string>;
+export declare function NoopKvCodecs(): KvCodecs;
+export declare function defaultBucketOpts(): Partial<KvOptions>;
+export declare const kvOperationHdr = "KV-Operation";
+export declare function validateKey(k: string): void;
+export declare function validateSearchKey(k: string): void;
+export declare function hasWildcards(k: string): boolean;
+export declare function validateBucket(name: string): void;
+/**
+ * The entry point to creating new KV instances.
+ */
+export declare class Kvm {
+    #private;
+    js: JetStreamClientImpl;
+    /**
+     * Creates an instance of the Kv that allows you to create and access KV stores.
+     * Note that if the argument is a NatsConnection, default JetStream Options are
+     * used. If you want to set some options, please provide a JetStreamClient instead.
+     * @param nc
+     */
+    constructor(nc: JetStreamClient | NatsConnection);
+    /**
+     * Creates and opens the specified KV. If the KV already exists, it opens the existing KV.
+     * @param name
+     * @param opts
+     */
+    create(name: string, opts?: Partial<KvOptions>): Promise<KV>;
+    /**
+     * Open to the specified KV. If the KV doesn't exist, this API will fail.
+     * @param name
+     * @param opts
+     */
+    open(name: string, opts?: Partial<KvOptions>): Promise<KV>;
+    /**
+     * Lists all available KVs
+     */
+    list(): Lister<KvStatus>;
+}
+export declare class Bucket implements KV, KvRemove {
+    js: JetStreamClient;
+    jsm: JetStreamManager;
+    stream: string;
+    bucket: string;
+    direct: boolean;
+    codec: KvCodecs;
+    prefix: string;
+    editPrefix: string;
+    useJsPrefix: boolean;
+    _prefixLen: number;
+    constructor(bucket: string, js: JetStreamClient, jsm: JetStreamManager);
+    static create(js: JetStreamClient, name: string, opts?: Partial<KvOptions>): Promise<KV>;
+    static bind(js: JetStreamClient, name: string, opts?: Partial<KvOptions>): Promise<KV>;
+    init(opts?: Partial<KvOptions>): Promise<void>;
+    initializePrefixes(info: StreamInfo): void;
+    bucketName(): string;
+    subjectForBucket(): string;
+    subjectForKey(k: string, edit?: boolean): string;
+    fullKeyName(k: string): string;
+    get prefixLen(): number;
+    encodeKey(key: string): string;
+    decodeKey(ekey: string): string;
+    validateKey: typeof validateKey;
+    validateSearchKey: typeof validateSearchKey;
+    hasWildcards: typeof hasWildcards;
+    close(): Promise<void>;
+    dataLen(data: Uint8Array, h?: MsgHdrs): number;
+    smToEntry(sm: StoredMsg): KvEntry;
+    jmToWatchEntry(jm: JsMsg, isUpdate: boolean): KvWatchEntry;
+    create(k: string, data: Payload): Promise<number>;
+    update(k: string, data: Payload, version: number): Promise<number>;
+    put(k: string, data: Payload, opts?: Partial<KvPutOptions>): Promise<number>;
+    get(k: string, opts?: {
+        revision: number;
+    }): Promise<KvEntry | null>;
+    purge(k: string, opts?: Partial<KvDeleteOptions>): Promise<void>;
+    delete(k: string, opts?: Partial<KvDeleteOptions>): Promise<void>;
+    purgeDeletes(olderMillis?: number): Promise<PurgeResponse>;
+    _deleteOrPurge(k: string, op: "DEL" | "PURGE", opts?: Partial<KvDeleteOptions>): Promise<void>;
+    _doDeleteOrPurge(k: string, op: "DEL" | "PURGE", opts?: Partial<KvDeleteOptions>): Promise<void>;
+    _buildCC(k: string | string[], content: KvWatchInclude, opts?: Partial<ConsumerConfig>): Partial<ConsumerConfig>;
+    remove(k: string): Promise<void>;
+    history(opts?: {
+        key?: string | string[];
+        headers_only?: boolean;
+    }): Promise<QueuedIterator<KvWatchEntry>>;
+    canSetWatcherName(): boolean;
+    watch(opts?: KvWatchOptions): Promise<QueuedIterator<KvWatchEntry>>;
+    keys(k?: string | string[]): Promise<QueuedIterator<string>>;
+    purgeBucket(opts?: PurgeOpts): Promise<PurgeResponse>;
+    destroy(): Promise<boolean>;
+    status(): Promise<KvStatus>;
+}
+export declare class KvStatusImpl implements KvStatus {
+    si: StreamInfo;
+    cluster: string;
+    constructor(si: StreamInfo, cluster?: string);
+    get bucket(): string;
+    get values(): number;
+    get history(): number;
+    get ttl(): number;
+    get bucket_location(): string;
+    get backingStore(): StorageType;
+    get storage(): StorageType;
+    get replicas(): number;
+    get description(): string;
+    get maxBucketSize(): number;
+    get maxValueSize(): number;
+    get max_bytes(): number;
+    get placement(): Placement;
+    get placementCluster(): string;
+    get republish(): Republish;
+    get streamInfo(): StreamInfo;
+    get size(): number;
+    get metadata(): Record<string, string>;
+    get compression(): boolean;
+}