@valkey/valkey-glide 1.3.4 → 1.3.5-rc10

package/build-ts/index.d.ts

@@ -1,14 +1,19 @@
 /**
  * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
+ *
+ * This entry point re-exports:
+ * - Native bindings auto-generated by napi-rs (moved to ./native.js)
+ * - All TypeScript client-side APIs from ./src/
  */
-export { ClusterScanCursor, Script } from "glide-rs";
-export * from "./src/BaseClient";
-export * from "./src/Commands";
-export * from "./src/Errors";
-export * from "./src/GlideClient";
-export * from "./src/GlideClusterClient";
-export * from "./src/Logger";
-export * from "./src/server-modules/GlideJson";
-export * from "./src/server-modules/GlideFt";
-export * from "./src/server-modules/GlideFtOptions";
-export * from "./src/Transaction";
+import * as Native from "../build-ts/native";
+export declare const Level: typeof Native.Level, MAX_REQUEST_ARGS_LEN: number, DEFAULT_REQUEST_TIMEOUT_IN_MILLISECONDS: number, DEFAULT_CONNECTION_TIMEOUT_IN_MILLISECONDS: number, DEFAULT_INFLIGHT_REQUESTS_LIMIT: number, AsyncClient: typeof Native.AsyncClient, StartSocketConnection: typeof Native.StartSocketConnection, log: typeof Native.log, InitInternalLogger: typeof Native.InitInternalLogger, valueFromSplitPointer: typeof Native.valueFromSplitPointer, createLeakedStringVec: typeof Native.createLeakedStringVec, Script: typeof Native.Script, ClusterScanCursor: typeof Native.ClusterScanCursor, getStatistics: typeof Native.getStatistics;
+export * from "./BaseClient.js";
+export * from "./Batch.js";
+export * from "./Commands.js";
+export * from "./Errors.js";
+export * from "./GlideClient.js";
+export * from "./GlideClusterClient.js";
+export * from "./Logger.js";
+export * from "./server-modules/GlideFt.js";
+export * from "./server-modules/GlideFtOptions.js";
+export * from "./server-modules/GlideJson.js";

package/build-ts/index.js

@@ -1,222 +1,59 @@
-#!/usr/bin/env node
 "use strict";
 /**
  * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
+ *
+ * This entry point re-exports:
+ * - Native bindings auto-generated by napi-rs (moved to ./native.js)
+ * - All TypeScript client-side APIs from ./src/
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-const detect_libc_1 = require("detect-libc");
-const process_1 = require("process");
-let globalObject = global;
-/* eslint-disable @typescript-eslint/no-require-imports */
-function loadNativeBinding() {
-    let nativeBinding = null;
-    switch (process_1.platform) {
-        case "linux":
-            switch (process_1.arch) {
-                case "x64":
-                    switch ((0, detect_libc_1.familySync)()) {
-                        case detect_libc_1.GLIBC:
-                            nativeBinding = require("@valkey/valkey-glide-linux-x64");
-                            break;
-                        case detect_libc_1.MUSL:
-                            nativeBinding = require("@valkey/valkey-glide-linux-musl-x64");
-                            break;
-                        default:
-                            nativeBinding = require("@valkey/valkey-glide-linux-x64");
-                            break;
-                    }
-                    break;
-                case "arm64":
-                    switch ((0, detect_libc_1.familySync)()) {
-                        case detect_libc_1.GLIBC:
-                            nativeBinding = require("@valkey/valkey-glide-linux-arm64");
-                            break;
-                        case detect_libc_1.MUSL:
-                            nativeBinding = require("@valkey/valkey-glide-linux-musl-arm64");
-                            break;
-                        default:
-                            nativeBinding = require("@valkey/valkey-glide-linux-arm64");
-                            break;
-                    }
-                    break;
-                default:
-                    throw new Error(`Unsupported OS: ${process_1.platform}, architecture: ${process_1.arch}`);
-            }
-            break;
-        case "darwin":
-            switch (process_1.arch) {
-                case "arm64":
-                    nativeBinding = require("@valkey/valkey-glide-darwin-arm64");
-                    break;
-                case "x64":
-                    nativeBinding = require("@valkey/valkey-glide-darwin-x64");
-                    break;
-                default:
-                    throw new Error(`Unsupported OS: ${process_1.platform}, architecture: ${process_1.arch}`);
-            }
-            break;
-        default:
-            throw new Error(`Unsupported OS: ${process_1.platform}, architecture: ${process_1.arch}`);
-    }
-    if (!nativeBinding) {
-        throw new Error(`Failed to load native binding`);
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
     }
-    return nativeBinding;
-}
-function initialize() {
-    const nativeBinding = loadNativeBinding();
-    const { AggregationType, BaseScanOptions, ScanOptions, ZScanOptions, HScanOptions, BitEncoding, BitFieldGet, BitFieldIncrBy, BitFieldOffset, BitFieldOverflow, BitFieldSet, BitFieldSubCommands, BitOffset, BitOffsetMultiplier, BitOffsetOptions, BitOverflowControl, BitmapIndexType, BitwiseOperation, ConditionalChange, Decoder, DecoderOption, GeoAddOptions, CoordOrigin, MemberOrigin, SearchOrigin, GeoBoxShape, GeoCircleShape, GeoSearchShape, GeoSearchResultOptions, GeoSearchStoreResultOptions, SortOrder, GeoUnit, GeospatialData, GlideClient, GlideClusterClient, GlideClientConfiguration, GlideJson, JsonBatch, GlideFt, Field, TextField, TagField, NumericField, VectorField, VectorFieldAttributesFlat, VectorFieldAttributesHnsw, FtCreateOptions, FtSearchOptions, FtInfoReturnType, FtAggregateOptions, FtAggregateLimit, FtAggregateFilter, FtAggregateGroupBy, FtAggregateReducer, FtAggregateSortBy, FtAggregateSortProperty, FtAggregateApply, FtAggregateReturnType, FtSearchReturnType, GlideRecord, GlideString, JsonGetOptions, JsonArrPopOptions, SortedSetDataType, StreamEntryDataType, HashDataType, FunctionListOptions, FunctionListResponse, FunctionStatsSingleResponse, FunctionStatsFullResponse, FunctionRestorePolicy, SlotIdTypes, SlotKeyTypes, TimeUnit, RouteByAddress, RouteOption, Routes, RestoreOptions, SingleNodeRoute, PeriodicChecksManualInterval, PeriodicChecks, Logger, Limit, LolwutOptions, LPosOptions, ListDirection, ExpireOptions, FlushMode, InfoOptions, InsertPosition, SetOptions, ZAddOptions, InfBoundary, KeyWeight, Boundary, ProtocolVersion, RangeByIndex, RangeByScore, RangeByLex, ReadFrom, ServerCredentials, SortOptions, StreamGroupOptions, StreamTrimOptions, StreamAddOptions, StreamReadGroupOptions, StreamReadOptions, StreamClaimOptions, StreamPendingOptions, ClosingError, ConfigurationError, ExecAbortError, ValkeyError, GlideReturnType, StreamEntries, ReturnTypeXinfoStream, RequestError, TimeoutError, ConnectionError, ClusterTransaction, Transaction, PubSubMsg, ScoreFilter, SignedEncoding, UnsignedEncoding, UpdateByScore, createLeakedArray, createLeakedAttribute, createLeakedBigint, createLeakedDouble, createLeakedMap, createLeakedString, Script, ObjectType, ClusterScanCursor, AdvancedGlideClientConfiguration, AdvancedGlideClusterClientConfiguration, BaseClientConfiguration, GlideClusterClientConfiguration, LevelOptions, ReturnTypeRecord, ReturnTypeMap, ClusterResponse, ReturnTypeAttribute, ReturnTypeJson, UniversalReturnTypeJson, Score, ElementAndScore, } = nativeBinding;
-    module.exports = {
-        AggregationType,
-        BaseScanOptions,
-        ScanOptions,
-        HScanOptions,
-        ZScanOptions,
-        BitEncoding,
-        BitFieldGet,
-        BitFieldIncrBy,
-        BitFieldOffset,
-        BitFieldOverflow,
-        BitFieldSet,
-        BitFieldSubCommands,
-        BitOffset,
-        BitOffsetMultiplier,
-        BitOffsetOptions,
-        BitOverflowControl,
-        BitmapIndexType,
-        BitwiseOperation,
-        ConditionalChange,
-        Decoder,
-        DecoderOption,
-        GeoAddOptions,
-        GlideFt,
-        Field,
-        TextField,
-        TagField,
-        NumericField,
-        VectorField,
-        VectorFieldAttributesFlat,
-        VectorFieldAttributesHnsw,
-        FtCreateOptions,
-        FtSearchOptions,
-        FtInfoReturnType,
-        FtAggregateOptions,
-        FtAggregateLimit,
-        FtAggregateFilter,
-        FtAggregateGroupBy,
-        FtAggregateReducer,
-        FtAggregateSortBy,
-        FtAggregateSortProperty,
-        FtAggregateApply,
-        FtAggregateReturnType,
-        FtSearchReturnType,
-        GlideRecord,
-        GlideJson,
-        JsonBatch,
-        GlideString,
-        JsonGetOptions,
-        JsonArrPopOptions,
-        SortedSetDataType,
-        StreamEntryDataType,
-        HashDataType,
-        CoordOrigin,
-        MemberOrigin,
-        SearchOrigin,
-        GeoBoxShape,
-        GeoCircleShape,
-        GeoSearchShape,
-        GeoSearchResultOptions,
-        GeoSearchStoreResultOptions,
-        SortOrder,
-        GeoUnit,
-        GeospatialData,
-        GlideClient,
-        GlideClusterClient,
-        GlideClientConfiguration,
-        AdvancedGlideClientConfiguration,
-        AdvancedGlideClusterClientConfiguration,
-        FunctionListOptions,
-        FunctionListResponse,
-        FunctionStatsSingleResponse,
-        FunctionStatsFullResponse,
-        FunctionRestorePolicy,
-        SlotIdTypes,
-        SlotKeyTypes,
-        StreamEntries,
-        TimeUnit,
-        ReturnTypeXinfoStream,
-        RouteByAddress,
-        RouteOption,
-        Routes,
-        RestoreOptions,
-        SingleNodeRoute,
-        PeriodicChecksManualInterval,
-        PeriodicChecks,
-        Logger,
-        LolwutOptions,
-        Limit,
-        LPosOptions,
-        ListDirection,
-        ExpireOptions,
-        FlushMode,
-        InfoOptions,
-        InsertPosition,
-        SetOptions,
-        ZAddOptions,
-        InfBoundary,
-        KeyWeight,
-        Boundary,
-        ProtocolVersion,
-        RangeByIndex,
-        RangeByScore,
-        RangeByLex,
-        ReadFrom,
-        ServerCredentials,
-        SortOptions,
-        StreamGroupOptions,
-        StreamTrimOptions,
-        StreamAddOptions,
-        StreamClaimOptions,
-        StreamReadGroupOptions,
-        StreamReadOptions,
-        StreamPendingOptions,
-        ClosingError,
-        ConfigurationError,
-        ExecAbortError,
-        ValkeyError,
-        GlideReturnType,
-        RequestError,
-        TimeoutError,
-        ConnectionError,
-        ClusterTransaction,
-        Transaction,
-        PubSubMsg,
-        ScoreFilter,
-        SignedEncoding,
-        UnsignedEncoding,
-        UpdateByScore,
-        createLeakedArray,
-        createLeakedAttribute,
-        createLeakedBigint,
-        createLeakedDouble,
-        createLeakedMap,
-        createLeakedString,
-        Script,
-        ObjectType,
-        ClusterScanCursor,
-        BaseClientConfiguration,
-        GlideClusterClientConfiguration,
-        LevelOptions,
-        ReturnTypeRecord,
-        ReturnTypeMap,
-        ClusterResponse,
-        ReturnTypeAttribute,
-        ReturnTypeJson,
-        UniversalReturnTypeJson,
-        Score,
-        ElementAndScore,
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
     };
-    globalObject = Object.assign(global, nativeBinding);
-}
-initialize();
-exports.default = globalObject;
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getStatistics = exports.ClusterScanCursor = exports.Script = exports.createLeakedStringVec = exports.valueFromSplitPointer = exports.InitInternalLogger = exports.log = exports.StartSocketConnection = exports.AsyncClient = exports.DEFAULT_INFLIGHT_REQUESTS_LIMIT = exports.DEFAULT_CONNECTION_TIMEOUT_IN_MILLISECONDS = exports.DEFAULT_REQUEST_TIMEOUT_IN_MILLISECONDS = exports.MAX_REQUEST_ARGS_LEN = exports.Level = void 0;
+const Native = __importStar(require("../build-ts/native"));
+exports.Level = Native.Level, exports.MAX_REQUEST_ARGS_LEN = Native.MAX_REQUEST_ARGS_LEN, exports.DEFAULT_REQUEST_TIMEOUT_IN_MILLISECONDS = Native.DEFAULT_REQUEST_TIMEOUT_IN_MILLISECONDS, exports.DEFAULT_CONNECTION_TIMEOUT_IN_MILLISECONDS = Native.DEFAULT_CONNECTION_TIMEOUT_IN_MILLISECONDS, exports.DEFAULT_INFLIGHT_REQUESTS_LIMIT = Native.DEFAULT_INFLIGHT_REQUESTS_LIMIT, exports.AsyncClient = Native.AsyncClient, exports.StartSocketConnection = Native.StartSocketConnection, exports.log = Native.log, exports.InitInternalLogger = Native.InitInternalLogger, exports.valueFromSplitPointer = Native.valueFromSplitPointer, exports.createLeakedStringVec = Native.createLeakedStringVec, exports.Script = Native.Script, exports.ClusterScanCursor = Native.ClusterScanCursor, exports.getStatistics = Native.getStatistics;
+// Export TypeScript APIs
+__exportStar(require("./BaseClient.js"), exports);
+__exportStar(require("./Batch.js"), exports);
+__exportStar(require("./Commands.js"), exports);
+__exportStar(require("./Errors.js"), exports);
+__exportStar(require("./GlideClient.js"), exports);
+__exportStar(require("./GlideClusterClient.js"), exports);
+__exportStar(require("./Logger.js"), exports);
+__exportStar(require("./server-modules/GlideFt.js"), exports);
+__exportStar(require("./server-modules/GlideFtOptions.js"), exports);
+__exportStar(require("./server-modules/GlideJson.js"), exports);

package/build-ts/native.d.ts

@@ -0,0 +1,92 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+export const enum Level {
+    Debug = 3,
+    Error = 0,
+    Info = 2,
+    Trace = 4,
+    Warn = 1,
+    Off = 5,
+}
+export const MAX_REQUEST_ARGS_LEN: number;
+export const DEFAULT_REQUEST_TIMEOUT_IN_MILLISECONDS: number;
+export const DEFAULT_CONNECTION_TIMEOUT_IN_MILLISECONDS: number;
+export const DEFAULT_INFLIGHT_REQUESTS_LIMIT: number;
+export declare function StartSocketConnection(): Promise<string>;
+export declare function log(
+    logLevel: Level,
+    logIdentifier: string,
+    message: string,
+): void;
+export declare function InitInternalLogger(
+    level?: Level | undefined | null,
+    fileName?: string | undefined | null,
+): Level;
+export declare function valueFromSplitPointer(
+    highBits: number,
+    lowBits: number,
+    stringDecoder: boolean,
+):
+    | null
+    | string
+    | Uint8Array
+    | number
+    | {}
+    | Boolean
+    | BigInt
+    | Set<any>
+    | any[]
+    | Buffer;
+/**
+ * @internal @test
+ * This function is for tests that require a value allocated on the heap.
+ * Should NOT be used in production.
+ */
+export declare function createLeakedStringVec(
+    message: Array<Uint8Array>,
+): [number, number];
+export declare function getStatistics(): object;
+export declare class AsyncClient {
+    static CreateConnection(connectionAddress: string): AsyncClient;
+    get(key: string): Promise<string | Buffer | null>;
+    set(key: string, value: string): Promise<string | Buffer | "OK" | null>;
+}
+/** A wrapper for a script object. As long as this object is alive, the script's code is saved in memory, and can be resent to the server. */
+export declare class Script {
+    /** Construct with the script's code. */
+    constructor(code: string | Uint8Array);
+    /** Returns the hash of the script. */
+    getHash(): string;
+}
+/**
+ * This struct is used to keep track of the cursor of a cluster scan.
+ * We want to avoid passing the cursor between layers of the application,
+ * So we keep the state in the container and only pass the id of the cursor.
+ * The cursor is stored in the container and can be retrieved using the id.
+ * The cursor is removed from the container when the object is deleted (dropped).
+ * To create a cursor:
+ * ```typescript
+ * // For a new cursor
+ * let cursor = new ClusterScanCursor();
+ * // Using an existing id
+ * let cursor = new ClusterScanCursor("cursor_id");
+ * ```
+ * To get the cursor id:
+ * ```typescript
+ * let cursorId = cursor.getCursor();
+ * ```
+ * To check if the scan is finished:
+ * ```typescript
+ * let isFinished = cursor.isFinished(); // true if the scan is finished
+ * ```
+ */
+export declare class ClusterScanCursor {
+    constructor(newCursor?: string | undefined | null);
+    /** Returns the cursor id. */
+    getCursor(): string;
+    /** Returns true if the scan is finished. */
+    isFinished(): boolean;
+}