@nats-io/obj 3.0.0-4 → 3.0.0-5

package/package.json

@@ -1,9 +1,8 @@
 {
   "name": "@nats-io/obj",
-  "version": "3.0.0-4",
+  "version": "3.0.0-5",
   "files": [
     "lib/",
-    "build/src/",
     "LICENSE",
     "README.md"
   ],
@@ -33,8 +32,8 @@
   },
   "description": "obj library - this library implements all the base functionality for NATS objectstore for javascript clients",
   "dependencies": {
-    "@nats-io/jetstream": "~3.0.0-8",
-    "@nats-io/nats-core": "~3.0.0-23"
+    "@nats-io/jetstream": "~3.0.0-9",
+    "@nats-io/nats-core": "~3.0.0-24"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",
@@ -42,4 +41,4 @@
     "typedoc": "^0.26.5",
     "typescript": "^5.5.4"
   }
-}
+}

package/build/src/internal_mod.ts

@@ -1,13 +0,0 @@
-export type {
-  ObjectInfo,
-  ObjectResult,
-  ObjectStore,
-  ObjectStoreLink,
-  ObjectStoreMeta,
-  ObjectStoreMetaOptions,
-  ObjectStoreOptions,
-  ObjectStorePutOpts,
-  ObjectStoreStatus,
-} from "./types";
-
-export { Objm } from "./objectstore";

package/build/src/mod.ts

@@ -1,13 +0,0 @@
-export type {
-  ObjectInfo,
-  ObjectResult,
-  ObjectStore,
-  ObjectStoreLink,
-  ObjectStoreMeta,
-  ObjectStoreMetaOptions,
-  ObjectStoreOptions,
-  ObjectStorePutOpts,
-  ObjectStoreStatus,
-} from "./internal_mod";
-
-export { Objm } from "./objectstore";

package/build/src/objectstore.ts

@@ -1,922 +0,0 @@
-/*
- * Copyright 2022-2024 The NATS Authors
- * 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.
- */
-
-import {
-  Base64UrlPaddedCodec,
-  DataBuffer,
-  deferred,
-  Feature,
-  headers,
-  JSONCodec,
-  MsgHdrsImpl,
-  nuid,
-  QueuedIteratorImpl,
-  SHA256,
-} from "@nats-io/nats-core/internal";
-
-import type {
-  MsgHdrs,
-  NatsConnection,
-  NatsError,
-  QueuedIterator,
-} from "@nats-io/nats-core/internal";
-
-import {
-  consumerOpts,
-  DiscardPolicy,
-  JsHeaders,
-  ListerImpl,
-  PubHeaders,
-  StoreCompression,
-  toJetStreamClient,
-} from "@nats-io/jetstream/internal";
-
-import type {
-  JetStreamClient,
-  JetStreamClientImpl,
-  JetStreamManager,
-  JsMsg,
-  Lister,
-  ListerFieldFilter,
-  PubAck,
-  PurgeResponse,
-  StorageType,
-  StreamConfig,
-  StreamInfo,
-  StreamInfoRequestOptions,
-  StreamListResponse,
-} from "@nats-io/jetstream/internal";
-
-import type {
-  ObjectInfo,
-  ObjectResult,
-  ObjectStore,
-  ObjectStoreMeta,
-  ObjectStoreMetaOptions,
-  ObjectStoreOptions,
-  ObjectStorePutOpts,
-  ObjectStoreStatus,
-} from "./types";
-
-export const osPrefix = "OBJ_";
-export const digestType = "SHA-256=";
-
-export function objectStoreStreamName(bucket: string): string {
-  validateBucket(bucket);
-  return `${osPrefix}${bucket}`;
-}
-
-export function objectStoreBucketName(stream: string): string {
-  if (stream.startsWith(osPrefix)) {
-    return stream.substring(4);
-  }
-  return stream;
-}
-
-/**
- * The entry point to creating and managing new ObjectStore instances.
- */
-export class Objm {
-  js: JetStreamClientImpl;
-
-  /**
-   * Creates an instance of the Objm that allows you to create and access ObjectStore.
-   * 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) {
-    this.js = toJetStreamClient(nc) as JetStreamClientImpl;
-  }
-
-  /**
-   * Creates and opens the specified ObjectStore. If the Object already exists, it opens the existing ObjectStore.
-   * @param name
-   * @param opts
-   */
-  create(
-    name: string,
-    opts: Partial<ObjectStoreOptions> = {},
-  ): Promise<ObjectStore> {
-    return this.#maybeCreate(name, opts);
-  }
-
-  #maybeCreate(
-    name: string,
-    opts: Partial<ObjectStoreOptions> = {},
-  ): Promise<ObjectStore> {
-    if (typeof crypto?.subtle?.digest !== "function") {
-      return Promise.reject(
-        new Error(
-          "objectstore: unable to calculate hashes - crypto.subtle.digest with sha256 support is required",
-        ),
-      );
-    }
-    const { ok, min } = this.js.nc.features.get(Feature.JS_OBJECTSTORE);
-    if (!ok) {
-      return Promise.reject(
-        new Error(`objectstore is only supported on servers ${min} or better`),
-      );
-    }
-
-    return ObjectStoreImpl.create(this.js, name, opts);
-  }
-
-  /**
-   * Returns a list of ObjectStoreInfo for all streams that are identified as
-   * being a ObjectStore (that is having names that have the prefix `OBJ_`)
-   */
-  list(): Lister<ObjectStoreStatus> {
-    const filter: ListerFieldFilter<ObjectStoreStatus> = (
-      v: unknown,
-    ): ObjectStoreStatus[] => {
-      const slr = v as StreamListResponse;
-      const streams = slr.streams.filter((v) => {
-        return v.config.name.startsWith(osPrefix);
-      });
-      streams.forEach((si) => {
-        si.config.sealed = si.config.sealed || false;
-        si.config.deny_delete = si.config.deny_delete || false;
-        si.config.deny_purge = si.config.deny_purge || false;
-        si.config.allow_rollup_hdrs = si.config.allow_rollup_hdrs || false;
-      });
-      return streams.map((si) => {
-        return new ObjectStoreStatusImpl(si);
-      });
-    };
-    const subj = `${this.js.prefix}.STREAM.LIST`;
-    return new ListerImpl<ObjectStoreStatus>(subj, filter, this.js);
-  }
-}
-
-export class ObjectStoreStatusImpl implements ObjectStoreStatus {
-  si: StreamInfo;
-  backingStore: string;
-
-  constructor(si: StreamInfo) {
-    this.si = si;
-    this.backingStore = "JetStream";
-  }
-  get bucket(): string {
-    return objectStoreBucketName(this.si.config.name);
-  }
-  get description(): string {
-    return this.si.config.description ?? "";
-  }
-  get ttl(): number {
-    return this.si.config.max_age;
-  }
-  get storage(): StorageType {
-    return this.si.config.storage;
-  }
-  get replicas(): number {
-    return this.si.config.num_replicas;
-  }
-  get sealed(): boolean {
-    return this.si.config.sealed;
-  }
-  get size(): number {
-    return this.si.state.bytes;
-  }
-  get streamInfo(): StreamInfo {
-    return this.si;
-  }
-  get metadata(): Record<string, string> | undefined {
-    return this.si.config.metadata;
-  }
-
-  get compression(): boolean {
-    if (this.si.config.compression) {
-      return this.si.config.compression !== StoreCompression.None;
-    }
-    return false;
-  }
-}
-export function validateBucket(name: string) {
-  const validBucketRe = /^[-\w]+$/;
-  if (!validBucketRe.test(name)) {
-    throw new Error(`invalid bucket name: ${name}`);
-  }
-}
-
-export type ServerObjectStoreMeta = {
-  name: string;
-  description?: string;
-  headers?: Record<string, string[]>;
-  options?: ObjectStoreMetaOptions;
-};
-
-export type ServerObjectInfo = {
-  bucket: string;
-  nuid: string;
-  size: number;
-  chunks: number;
-  digest: string;
-  deleted?: boolean;
-  mtime: string;
-  revision: number;
-  metadata?: Record<string, string>;
-} & ServerObjectStoreMeta;
-
-class ObjectInfoImpl implements ObjectInfo {
-  info: ServerObjectInfo;
-  hdrs!: MsgHdrs;
-  constructor(oi: ServerObjectInfo) {
-    this.info = oi;
-  }
-  get name(): string {
-    return this.info.name;
-  }
-  get description(): string {
-    return this.info.description ?? "";
-  }
-  get headers(): MsgHdrs {
-    if (!this.hdrs) {
-      this.hdrs = MsgHdrsImpl.fromRecord(this.info.headers || {});
-    }
-    return this.hdrs;
-  }
-  get options(): ObjectStoreMetaOptions | undefined {
-    return this.info.options;
-  }
-  get bucket(): string {
-    return this.info.bucket;
-  }
-  get chunks(): number {
-    return this.info.chunks;
-  }
-  get deleted(): boolean {
-    return this.info.deleted ?? false;
-  }
-  get digest(): string {
-    return this.info.digest;
-  }
-  get mtime(): string {
-    return this.info.mtime;
-  }
-  get nuid(): string {
-    return this.info.nuid;
-  }
-  get size(): number {
-    return this.info.size;
-  }
-  get revision(): number {
-    return this.info.revision;
-  }
-  get metadata(): Record<string, string> {
-    return this.info.metadata || {};
-  }
-  isLink() {
-    return (this.info.options?.link !== undefined) &&
-      (this.info.options?.link !== null);
-  }
-}
-
-function toServerObjectStoreMeta(
-  meta: Partial<ObjectStoreMeta>,
-): ServerObjectStoreMeta {
-  const v = {
-    name: meta.name,
-    description: meta.description ?? "",
-    options: meta.options,
-    metadata: meta.metadata,
-  } as ServerObjectStoreMeta;
-
-  if (meta.headers) {
-    const mhi = meta.headers as MsgHdrsImpl;
-    v.headers = mhi.toRecord();
-  }
-  return v;
-}
-
-function emptyReadableStream(): ReadableStream {
-  return new ReadableStream({
-    pull(c) {
-      c.enqueue(new Uint8Array(0));
-      c.close();
-    },
-  });
-}
-
-export class ObjectStoreImpl implements ObjectStore {
-  jsm: JetStreamManager;
-  js: JetStreamClient;
-  stream!: string;
-  name: string;
-
-  constructor(name: string, jsm: JetStreamManager, js: JetStreamClient) {
-    this.name = name;
-    this.jsm = jsm;
-    this.js = js;
-  }
-
-  _checkNotEmpty(name: string): { name: string; error?: Error } {
-    if (!name || name.length === 0) {
-      return { name, error: new Error("name cannot be empty") };
-    }
-    return { name };
-  }
-
-  async info(name: string): Promise<ObjectInfo | null> {
-    const info = await this.rawInfo(name);
-    return info ? new ObjectInfoImpl(info) : null;
-  }
-
-  async list(): Promise<ObjectInfo[]> {
-    const buf: ObjectInfo[] = [];
-    const iter = await this.watch({
-      ignoreDeletes: true,
-      includeHistory: true,
-    });
-    for await (const info of iter) {
-      // watch will give a null when it has initialized
-      // for us that is the hint we are done
-      if (info === null) {
-        break;
-      }
-      buf.push(info);
-    }
-    return Promise.resolve(buf);
-  }
-
-  async rawInfo(name: string): Promise<ServerObjectInfo | null> {
-    const { name: obj, error } = this._checkNotEmpty(name);
-    if (error) {
-      return Promise.reject(error);
-    }
-
-    const meta = this._metaSubject(obj);
-    try {
-      const m = await this.jsm.streams.getMessage(this.stream, {
-        last_by_subj: meta,
-      });
-      const jc = JSONCodec<ServerObjectInfo>();
-      const soi = jc.decode(m.data) as ServerObjectInfo;
-      soi.revision = m.seq;
-      return soi;
-    } catch (err) {
-      if (err.code === "404") {
-        return null;
-      }
-      return Promise.reject(err);
-    }
-  }
-
-  async _si(
-    opts?: Partial<StreamInfoRequestOptions>,
-  ): Promise<StreamInfo | null> {
-    try {
-      return await this.jsm.streams.info(this.stream, opts);
-    } catch (err) {
-      const nerr = err as NatsError;
-      if (nerr.code === "404") {
-        return null;
-      }
-      return Promise.reject(err);
-    }
-  }
-
-  async seal(): Promise<ObjectStoreStatus> {
-    let info = await this._si();
-    if (info === null) {
-      return Promise.reject(new Error("object store not found"));
-    }
-    info.config.sealed = true;
-    info = await this.jsm.streams.update(this.stream, info.config);
-    return Promise.resolve(new ObjectStoreStatusImpl(info));
-  }
-
-  async status(
-    opts?: Partial<StreamInfoRequestOptions>,
-  ): Promise<ObjectStoreStatus> {
-    const info = await this._si(opts);
-    if (info === null) {
-      return Promise.reject(new Error("object store not found"));
-    }
-    return Promise.resolve(new ObjectStoreStatusImpl(info));
-  }
-
-  destroy(): Promise<boolean> {
-    return this.jsm.streams.delete(this.stream);
-  }
-
-  async _put(
-    meta: ObjectStoreMeta,
-    rs: ReadableStream<Uint8Array> | null,
-    opts?: ObjectStorePutOpts,
-  ): Promise<ObjectInfo> {
-    const jsopts = this.js.getOptions();
-    opts = opts || { timeout: jsopts.timeout };
-    opts.timeout = opts.timeout || jsopts.timeout;
-    opts.previousRevision = opts.previousRevision ?? undefined;
-    const { timeout, previousRevision } = opts;
-    const si = (this.js as unknown as { nc: NatsConnection }).nc.info;
-    const maxPayload = si?.max_payload || 1024;
-    meta = meta || {} as ObjectStoreMeta;
-    meta.options = meta.options || {};
-    let maxChunk = meta.options?.max_chunk_size || 128 * 1024;
-    maxChunk = maxChunk > maxPayload ? maxPayload : maxChunk;
-    meta.options.max_chunk_size = maxChunk;
-
-    const old = await this.info(meta.name);
-    const { name: n, error } = this._checkNotEmpty(meta.name);
-    if (error) {
-      return Promise.reject(error);
-    }
-
-    const id = nuid.next();
-    const chunkSubj = this._chunkSubject(id);
-    const metaSubj = this._metaSubject(n);
-
-    const info = Object.assign({
-      bucket: this.name,
-      nuid: id,
-      size: 0,
-      chunks: 0,
-    }, toServerObjectStoreMeta(meta)) as ServerObjectInfo;
-
-    const d = deferred<ObjectInfo>();
-
-    const proms: Promise<unknown>[] = [];
-    const db = new DataBuffer();
-    try {
-      const reader = rs ? rs.getReader() : null;
-      const sha = new SHA256();
-
-      while (true) {
-        const { done, value } = reader
-          ? await reader.read()
-          : { done: true, value: undefined };
-        if (done) {
-          // put any partial chunk in
-          if (db.size() > 0) {
-            const payload = db.drain();
-            sha.update(payload);
-            info.chunks!++;
-            info.size! += payload.length;
-            proms.push(this.js.publish(chunkSubj, payload, { timeout }));
-          }
-          // wait for all the chunks to write
-          await Promise.all(proms);
-          proms.length = 0;
-
-          // prepare the metadata
-          info.mtime = new Date().toISOString();
-          const digest = sha.digest("base64");
-          const pad = digest.length % 3;
-          const padding = pad > 0 ? "=".repeat(pad) : "";
-          info.digest = `${digestType}${digest}${padding}`;
-          info.deleted = false;
-
-          // trailing md for the object
-          const h = headers();
-          if (typeof previousRevision === "number") {
-            h.set(
-              PubHeaders.ExpectedLastSubjectSequenceHdr,
-              `${previousRevision}`,
-            );
-          }
-          h.set(JsHeaders.RollupHdr, JsHeaders.RollupValueSubject);
-
-          // try to update the metadata
-          const pa = await this.js.publish(metaSubj, JSONCodec().encode(info), {
-            headers: h,
-            timeout,
-          });
-          // update the revision to point to the sequence where we inserted
-          info.revision = pa.seq;
-
-          // if we are here, the new entry is live
-          if (old) {
-            try {
-              await this.jsm.streams.purge(this.stream, {
-                filter: `$O.${this.name}.C.${old.nuid}`,
-              });
-            } catch (_err) {
-              // rejecting here, would mean send the wrong signal
-              // the update succeeded, but cleanup of old chunks failed.
-            }
-          }
-
-          // resolve the ObjectInfo
-          d.resolve(new ObjectInfoImpl(info!));
-          // stop
-          break;
-        }
-        if (value) {
-          db.fill(value);
-          while (db.size() > maxChunk) {
-            info.chunks!++;
-            info.size! += maxChunk;
-            const payload = db.drain(meta.options.max_chunk_size);
-            sha.update(payload);
-            proms.push(
-              this.js.publish(chunkSubj, payload, { timeout }),
-            );
-          }
-        }
-      }
-    } catch (err) {
-      // we failed, remove any partials
-      await this.jsm.streams.purge(this.stream, { filter: chunkSubj });
-      d.reject(err);
-    }
-
-    return d;
-  }
-
-  putBlob(
-    meta: ObjectStoreMeta,
-    data: Uint8Array | null,
-    opts?: ObjectStorePutOpts,
-  ): Promise<ObjectInfo> {
-    function readableStreamFrom(data: Uint8Array): ReadableStream<Uint8Array> {
-      return new ReadableStream<Uint8Array>({
-        pull(controller) {
-          controller.enqueue(data);
-          controller.close();
-        },
-      });
-    }
-    if (data === null) {
-      data = new Uint8Array(0);
-    }
-    return this.put(meta, readableStreamFrom(data), opts);
-  }
-
-  put(
-    meta: ObjectStoreMeta,
-    rs: ReadableStream<Uint8Array> | null,
-    opts?: ObjectStorePutOpts,
-  ): Promise<ObjectInfo> {
-    if (meta?.options?.link) {
-      return Promise.reject(
-        new Error("link cannot be set when putting the object in bucket"),
-      );
-    }
-    return this._put(meta, rs, opts);
-  }
-
-  async getBlob(name: string): Promise<Uint8Array | null> {
-    async function fromReadableStream(
-      rs: ReadableStream<Uint8Array>,
-    ): Promise<Uint8Array> {
-      const buf = new DataBuffer();
-      const reader = rs.getReader();
-      while (true) {
-        const { done, value } = await reader.read();
-        if (done) {
-          return buf.drain();
-        }
-        if (value && value.length) {
-          buf.fill(value);
-        }
-      }
-    }
-
-    const r = await this.get(name);
-    if (r === null) {
-      return Promise.resolve(null);
-    }
-
-    const vs = await Promise.all([r.error, fromReadableStream(r.data)]);
-    if (vs[0]) {
-      return Promise.reject(vs[0]);
-    } else {
-      return Promise.resolve(vs[1]);
-    }
-  }
-
-  async get(name: string): Promise<ObjectResult | null> {
-    const info = await this.rawInfo(name);
-    if (info === null) {
-      return Promise.resolve(null);
-    }
-
-    if (info.deleted) {
-      return Promise.resolve(null);
-    }
-
-    if (info.options && info.options.link) {
-      const ln = info.options.link.name || "";
-      if (ln === "") {
-        throw new Error("link is a bucket");
-      }
-      const os = info.options.link.bucket !== this.name
-        ? await ObjectStoreImpl.create(
-          this.js,
-          info.options.link.bucket,
-        )
-        : this;
-      return os.get(ln);
-    }
-
-    const d = deferred<Error | null>();
-
-    const r: Partial<ObjectResult> = {
-      info: new ObjectInfoImpl(info),
-      error: d,
-    };
-    if (info.size === 0) {
-      r.data = emptyReadableStream();
-      d.resolve(null);
-      return Promise.resolve(r as ObjectResult);
-    }
-
-    let controller: ReadableStreamDefaultController;
-
-    const oc = consumerOpts();
-    oc.orderedConsumer();
-    const sha = new SHA256();
-    const subj = `$O.${this.name}.C.${info.nuid}`;
-    const sub = await this.js.subscribe(subj, oc);
-    (async () => {
-      for await (const jm of sub) {
-        if (jm.data.length > 0) {
-          sha.update(jm.data);
-          controller!.enqueue(jm.data);
-        }
-        if (jm.info.pending === 0) {
-          const hash = sha.digest("base64");
-          // go pads the hash - which should be multiple of 3 - otherwise pads with '='
-          const pad = hash.length % 3;
-          const padding = pad > 0 ? "=".repeat(pad) : "";
-          const digest = `${digestType}${hash}${padding}`;
-          if (digest !== info.digest) {
-            controller!.error(
-              new Error(
-                `received a corrupt object, digests do not match received: ${info.digest} calculated ${digest}`,
-              ),
-            );
-          } else {
-            controller!.close();
-          }
-          sub.unsubscribe();
-        }
-      }
-    })()
-      .then(() => {
-        d.resolve();
-      })
-      .catch((err) => {
-        controller!.error(err);
-        d.reject(err);
-      });
-
-    r.data = new ReadableStream({
-      start(c) {
-        controller = c;
-      },
-      cancel() {
-        sub.unsubscribe();
-      },
-    });
-
-    return r as ObjectResult;
-  }
-
-  linkStore(name: string, bucket: ObjectStore): Promise<ObjectInfo> {
-    if (!(bucket instanceof ObjectStoreImpl)) {
-      return Promise.reject("bucket required");
-    }
-    const osi = bucket as ObjectStoreImpl;
-    const { name: n, error } = this._checkNotEmpty(name);
-    if (error) {
-      return Promise.reject(error);
-    }
-
-    const meta = {
-      name: n,
-      options: { link: { bucket: osi.name } },
-    };
-    return this._put(meta, null);
-  }
-
-  async link(name: string, info: ObjectInfo): Promise<ObjectInfo> {
-    const { name: n, error } = this._checkNotEmpty(name);
-    if (error) {
-      return Promise.reject(error);
-    }
-    if (info.deleted) {
-      return Promise.reject(new Error("src object is deleted"));
-    }
-    if ((info as ObjectInfoImpl).isLink()) {
-      return Promise.reject(new Error("src object is a link"));
-    }
-    const dest = await this.rawInfo(name);
-    if (dest !== null && !dest.deleted) {
-      return Promise.reject(
-        new Error("an object already exists with that name"),
-      );
-    }
-
-    const link = { bucket: info.bucket, name: info.name };
-    const mm = {
-      name: n,
-      bucket: info.bucket,
-      options: { link: link },
-    } as ObjectStoreMeta;
-    await this.js.publish(this._metaSubject(name), JSON.stringify(mm));
-    const i = await this.info(name);
-    return Promise.resolve(i!);
-  }
-
-  async delete(name: string): Promise<PurgeResponse> {
-    const info = await this.rawInfo(name);
-    if (info === null) {
-      return Promise.resolve({ purged: 0, success: false });
-    }
-    info.deleted = true;
-    info.size = 0;
-    info.chunks = 0;
-    info.digest = "";
-
-    const jc = JSONCodec();
-    const h = headers();
-    h.set(JsHeaders.RollupHdr, JsHeaders.RollupValueSubject);
-
-    await this.js.publish(this._metaSubject(info.name), jc.encode(info), {
-      headers: h,
-    });
-    return this.jsm.streams.purge(this.stream, {
-      filter: this._chunkSubject(info.nuid),
-    });
-  }
-
-  async update(
-    name: string,
-    meta: Partial<ObjectStoreMeta> = {},
-  ): Promise<PubAck> {
-    const info = await this.rawInfo(name);
-    if (info === null) {
-      return Promise.reject(new Error("object not found"));
-    }
-    if (info.deleted) {
-      return Promise.reject(
-        new Error("cannot update meta for a deleted object"),
-      );
-    }
-    meta.name = meta.name ?? info.name;
-    const { name: n, error } = this._checkNotEmpty(meta.name);
-    if (error) {
-      return Promise.reject(error);
-    }
-    if (name !== meta.name) {
-      const i = await this.info(meta.name);
-      if (i && !i.deleted) {
-        return Promise.reject(
-          new Error("an object already exists with that name"),
-        );
-      }
-    }
-    meta.name = n;
-    const ii = Object.assign({}, info, toServerObjectStoreMeta(meta!));
-    // if the name changed, delete the old meta
-    const ack = await this.js.publish(
-      this._metaSubject(ii.name),
-      JSON.stringify(ii),
-    );
-    if (name !== meta.name) {
-      await this.jsm.streams.purge(this.stream, {
-        filter: this._metaSubject(name),
-      });
-    }
-    return Promise.resolve(ack);
-  }
-
-  async watch(opts: Partial<
-    {
-      ignoreDeletes?: boolean;
-      includeHistory?: boolean;
-    }
-  > = {}): Promise<QueuedIterator<ObjectInfo | null>> {
-    opts.includeHistory = opts.includeHistory ?? false;
-    opts.ignoreDeletes = opts.ignoreDeletes ?? false;
-    let initialized = false;
-    const qi = new QueuedIteratorImpl<ObjectInfo | null>();
-    const subj = this._metaSubjectAll();
-    try {
-      await this.jsm.streams.getMessage(this.stream, { last_by_subj: subj });
-    } catch (err) {
-      if (err.code === "404") {
-        qi.push(null);
-        initialized = true;
-      } else {
-        qi.stop(err);
-      }
-    }
-    const jc = JSONCodec<ObjectInfo>();
-    const copts = consumerOpts();
-    copts.orderedConsumer();
-    if (opts.includeHistory) {
-      copts.deliverLastPerSubject();
-    } else {
-      // FIXME: Go's implementation doesn't seem correct - if history is not desired
-      //  the watch should only be giving notifications on new entries
-      initialized = true;
-      copts.deliverNew();
-    }
-    copts.callback((err: NatsError | null, jm: JsMsg | null) => {
-      if (err) {
-        qi.stop(err);
-        return;
-      }
-      if (jm !== null) {
-        const oi = jc.decode(jm.data);
-        if (oi.deleted && opts.ignoreDeletes === true) {
-          // do nothing
-        } else {
-          qi.push(oi);
-        }
-        if (jm.info?.pending === 0 && !initialized) {
-          initialized = true;
-          qi.push(null);
-        }
-      }
-    });
-
-    const sub = await this.js.subscribe(subj, copts);
-    qi._data = sub;
-    qi.iterClosed.then(() => {
-      sub.unsubscribe();
-    });
-    sub.closed.then(() => {
-      qi.stop();
-    }).catch((err) => {
-      qi.stop(err);
-    });
-
-    return qi;
-  }
-
-  _chunkSubject(id: string) {
-    return `$O.${this.name}.C.${id}`;
-  }
-
-  _metaSubject(n: string): string {
-    return `$O.${this.name}.M.${Base64UrlPaddedCodec.encode(n)}`;
-  }
-
-  _metaSubjectAll(): string {
-    return `$O.${this.name}.M.>`;
-  }
-
-  async init(opts: Partial<ObjectStoreOptions> = {}): Promise<void> {
-    try {
-      this.stream = objectStoreStreamName(this.name);
-    } catch (err) {
-      return Promise.reject(err);
-    }
-    const max_age = opts?.ttl || 0;
-    delete opts.ttl;
-    // pacify the tsc compiler downstream
-    const sc = Object.assign({ max_age }, opts) as unknown as StreamConfig;
-    sc.name = this.stream;
-    sc.allow_direct = true;
-    sc.allow_rollup_hdrs = true;
-    sc.discard = DiscardPolicy.New;
-    sc.subjects = [`$O.${this.name}.C.>`, `$O.${this.name}.M.>`];
-    if (opts.placement) {
-      sc.placement = opts.placement;
-    }
-    if (opts.metadata) {
-      sc.metadata = opts.metadata;
-    }
-    if (typeof opts.compression === "boolean") {
-      sc.compression = opts.compression
-        ? StoreCompression.S2
-        : StoreCompression.None;
-    }
-
-    try {
-      await this.jsm.streams.info(sc.name);
-    } catch (err) {
-      if (err.message === "stream not found") {
-        await this.jsm.streams.add(sc);
-      }
-    }
-  }
-
-  static async create(
-    js: JetStreamClient,
-    name: string,
-    opts: Partial<ObjectStoreOptions> = {},
-  ): Promise<ObjectStore> {
-    const jsm = await js.jetstreamManager();
-    const os = new ObjectStoreImpl(name, jsm, js);
-    await os.init(opts);
-    return Promise.resolve(os);
-  }
-}

package/build/src/types.ts

@@ -1,340 +0,0 @@
-/*
- * Copyright 2023-2024 The NATS Authors
- * 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.
- */
-import type {
-  Placement,
-  PubAck,
-  PurgeResponse,
-  StorageType,
-  StreamInfo,
-  StreamInfoRequestOptions,
-} from "@nats-io/jetstream";
-import type { MsgHdrs, Nanos, QueuedIterator } from "@nats-io/nats-core";
-
-export type ObjectStoreLink = {
-  /**
-   * name of object store storing the data
-   */
-  bucket: string;
-  /**
-   * link to single object, when empty this means the whole store
-   */
-  name?: string;
-};
-export type ObjectStoreMetaOptions = {
-  /**
-   * If set, the object is a reference to another entry.
-   */
-  link?: ObjectStoreLink;
-  /**
-   * The maximum size in bytes for each chunk.
-   * Note that if the size exceeds the maximum size of a stream
-   * entry, the number will be clamped to the streams maximum.
-   */
-  max_chunk_size?: number;
-};
-export type ObjectStoreMeta = {
-  name: string;
-  description?: string;
-  headers?: MsgHdrs;
-  options?: ObjectStoreMetaOptions;
-  metadata?: Record<string, string>;
-};
-
-export interface ObjectInfo extends ObjectStoreMeta {
-  /**
-   * The name of the bucket where the object is stored.
-   */
-  bucket: string;
-  /**
-   * The current ID of the entries holding the data for the object.
-   */
-  nuid: string;
-  /**
-   * The size in bytes of the object.
-   */
-  size: number;
-  /**
-   * The number of entries storing the object.
-   */
-  chunks: number;
-  /**
-   * A cryptographic checksum of the data as a whole.
-   */
-  digest: string;
-  /**
-   * True if the object was deleted.
-   */
-  deleted: boolean;
-  /**
-   * An UTC timestamp
-   */
-  mtime: string;
-  /**
-   * The revision number for the entry
-   */
-  revision: number;
-}
-
-/**
- * A link reference
- */
-export interface ObjectLink {
-  /**
-   * The object store the source data
-   */
-  bucket: string;
-  /**
-   * The name of the entry holding the data. If not
-   * set it is a complete object store reference.
-   */
-  name?: string;
-}
-
-export type ObjectStoreStatus = {
-  /**
-   * The bucket name
-   */
-  bucket: string;
-  /**
-   * the description associated with the object store.
-   */
-  description: string;
-  /**
-   * The time to live for entries in the object store in nanoseconds.
-   * Convert to millis using the `millis()` function.
-   */
-  ttl: Nanos;
-  /**
-   * The object store's underlying stream storage type.
-   */
-  storage: StorageType;
-  /**
-   * The number of replicas associated with this object store.
-   */
-  replicas: number;
-  /**
-   * Set to true if the object store is sealed and will reject edits.
-   */
-  sealed: boolean;
-  /**
-   * The size in bytes that the object store occupies.
-   */
-  size: number;
-  /**
-   * The underlying storage for the object store. Currently, this always
-   * returns "JetStream".
-   */
-  backingStore: string;
-  /**
-   * The StreamInfo backing up the ObjectStore
-   */
-  streamInfo: StreamInfo;
-  /**
-   * Metadata the object store. Note that
-   * keys starting with `_nats` are reserved. This feature only supported on servers
-   * 2.10.x and better.
-   */
-  metadata?: Record<string, string> | undefined;
-  /**
-   * Compression level of the stream. This feature is only supported in
-   * servers 2.10.x and better.
-   */
-  compression: boolean;
-};
-/**
- * @deprecated {@link ObjectStoreStatus}
- */
-export type ObjectStoreInfo = ObjectStoreStatus;
-export type ObjectStoreOptions = {
-  /**
-   * A description for the object store
-   */
-  description?: string;
-  /**
-   * The time to live for entries in the object store specified
-   * as nanoseconds. Use the `nanos()` function to convert millis to
-   * nanos.
-   */
-  ttl?: Nanos;
-  /**
-   * The underlying stream storage type for the object store.
-   */
-  storage: StorageType;
-  /**
-   * The number of replicas to create.
-   */
-  replicas: number;
-  /**
-   * The maximum amount of data that the object store should store in bytes.
-   */
-  "max_bytes": number;
-  /**
-   * Placement hints for the underlying object store stream
-   */
-  placement: Placement; /**
-   * Metadata field to store additional information about the stream. Note that
-   * keys starting with `_nats` are reserved. This feature only supported on servers
-   * 2.10.x and better.
-   */
-  metadata?: Record<string, string>;
-  /**
-   * Sets the compression level of the stream. This feature is only supported in
-   * servers 2.10.x and better.
-   */
-  compression?: boolean;
-};
-/**
- * An object that allows reading the object stored under a specified name.
- */
-export type ObjectResult = {
-  /**
-   * The info of the object that was retrieved.
-   */
-  info: ObjectInfo;
-  /**
-   * The readable stream where you can read the data.
-   */
-  data: ReadableStream<Uint8Array>;
-  /**
-   * A promise that will resolve to an error if the readable stream failed
-   * to process the entire response. Should be checked when the readable stream
-   * has finished yielding data.
-   */
-  error: Promise<Error | null>;
-};
-export type ObjectStorePutOpts = {
-  /**
-   * maximum number of millis for the put requests to succeed
-   */
-  timeout?: number;
-  /**
-   * If set the ObjectStore must be at the current sequence or the
-   * put will fail. Note the sequence accounts where the metadata
-   * for the entry is stored.
-   */
-  previousRevision?: number;
-};
-
-export interface ObjectStore {
-  /**
-   * Returns the ObjectInfo of the named entry. Or null if the
-   * entry doesn't exist.
-   * @param name
-   */
-  info(name: string): Promise<ObjectInfo | null>;
-
-  /**
-   * Returns a list of the entries in the ObjectStore
-   */
-  list(): Promise<ObjectInfo[]>;
-
-  /**
-   * Returns an object you can use for reading the data from the
-   * named stored object or null if the entry doesn't exist.
-   * @param name
-   */
-  get(name: string): Promise<ObjectResult | null>;
-
-  /**
-   * Returns the data stored for the named entry.
-   * @param name
-   */
-  getBlob(name: string): Promise<Uint8Array | null>;
-
-  /**
-   * Adds an object to the store with the specified meta
-   * and using the specified ReadableStream to stream the data.
-   * @param meta
-   * @param rs
-   * @param opts
-   */
-  put(
-    meta: ObjectStoreMeta,
-    rs: ReadableStream<Uint8Array>,
-    opts?: ObjectStorePutOpts,
-  ): Promise<ObjectInfo>;
-
-  /**
-   * Puts the specified bytes into the store with the specified meta.
-   * @param meta
-   * @param data
-   * @param opts
-   */
-  putBlob(
-    meta: ObjectStoreMeta,
-    data: Uint8Array | null,
-    opts?: ObjectStorePutOpts,
-  ): Promise<ObjectInfo>;
-
-  /**
-   * Deletes the specified entry from the object store.
-   * @param name
-   */
-  delete(name: string): Promise<PurgeResponse>;
-
-  /**
-   * Adds a link to another object in the same store or a different one.
-   * Note that links of links are rejected.
-   * object.
-   * @param name
-   * @param meta
-   */
-  link(name: string, meta: ObjectInfo): Promise<ObjectInfo>;
-
-  /**
-   * Add a link to another object store
-   * @param name
-   * @param bucket
-   */
-  linkStore(name: string, bucket: ObjectStore): Promise<ObjectInfo>;
-
-  /**
-   * Watch an object store and receive updates of modifications via
-   * an iterator.
-   * @param opts
-   */
-  watch(
-    opts?: Partial<
-      {
-        ignoreDeletes?: boolean;
-        includeHistory?: boolean;
-      }
-    >,
-  ): Promise<QueuedIterator<ObjectInfo | null>>;
-
-  /**
-   * Seals the object store preventing any further modifications.
-   */
-  seal(): Promise<ObjectStoreStatus>;
-
-  /**
-   * Returns the runtime status of the object store.
-   * @param opts
-   */
-  status(opts?: Partial<StreamInfoRequestOptions>): Promise<ObjectStoreStatus>;
-
-  /**
-   * Update the metadata for an object. If the name is modified, the object
-   * is effectively renamed and will only be accessible by its new name.
-   * @param name
-   * @param meta
-   */
-  update(name: string, meta: Partial<ObjectStoreMeta>): Promise<PubAck>;
-
-  /**
-   * Destroys the object store and all its entries.
-   */
-  destroy(): Promise<boolean>;
-}