@valkey/valkey-glide 1.1.0-rc10

package/README.md

@@ -0,0 +1,39 @@
+# Valkey GLIDE
+
+Valkey General Language Independent Driver for the Enterprise (GLIDE), is an open-source Valkey client library. Valkey GLIDE is one of the official client libraries for Valkey, and it supports all Valkey commands. Valkey GLIDE supports Valkey 7.2 and above, and Redis open-source 6.2, 7.0 and 7.2. Application programmers use Valkey GLIDE to safely and reliably connect their applications to Valkey- and Redis OSS- compatible services. Valkey GLIDE is designed for reliability, optimized performance, and high-availability, for Valkey and Redis OSS based applications. It is sponsored and supported by AWS, and is pre-configured with best practices learned from over a decade of operating Redis OSS-compatible services used by hundreds of thousands of customers. To help ensure consistency in application development and operations, Valkey GLIDE is implemented using a core driver framework, written in Rust, with language specific extensions. This design ensures consistency in features across languages and reduces overall complexity.
+
+## Supported Engine Versions
+
+Refer to the [Supported Engine Versions table](https://github.com/valkey-io/valkey-glide/blob/main/README.md#supported-engine-versions) for details.
+
+## Current Status
+
+We've made Valkey GLIDE an open-source project, and are releasing it in Preview to the community to gather feedback, and actively collaborate on the project roadmap. We welcome questions and contributions from all Redis stakeholders.
+This preview release is recommended for testing purposes only.
+
+# Getting Started - Node Wrapper
+
+## System Requirements
+
+In this release, Valkey GLIDE is available for Python and Java. Support for Node.js is actively under development, with plans to include more programming languages in the future. We're tracking future features on the [roadmap](https://github.com/orgs/aws/projects/187/).
+
+## NodeJS supported version
+
+Node.js 16.20 or higher.
+
+## Documentation
+
+Visit our [wiki](https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper) for examples and further details on TLS, Read strategy, Timeouts and various other configurations.
+
+### Building & Testing
+
+Development instructions for local building & testing the package are in the [DEVELOPER.md](https://github.com/valkey-io/valkey-glide/blob/main/node/DEVELOPER.md#build-from-source) file.
+
+### Supported platforms
+
+Currentlly the package is supported on:
+
+| Operation systems | C lib                | Architecture      |
+| ----------------- | -------------------- | ----------------- |
+| `Linux`           | `glibc`, `musl libc` | `x86_64`, `arm64` |
+| `macOS`           | `Darwin`             | `x86_64`, `arm64` |

package/build-ts/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
+ */
+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/Transaction";

package/build-ts/index.js

@@ -0,0 +1,184 @@
+#!/usr/bin/env node
+"use strict";
+/**
+ * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
+ */
+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 "x64":
+                    nativeBinding = require("@valkey/valkey-glide-darwin-x64");
+                    break;
+                case "arm64":
+                    nativeBinding = require("@valkey/valkey-glide-darwin-arm64");
+                    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`);
+    }
+    return nativeBinding;
+}
+function initialize() {
+    const nativeBinding = loadNativeBinding();
+    const { AggregationType, BaseScanOptions, 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, GlideRecord, GlideString, 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, UpdateOptions, ProtocolVersion, RangeByIndex, RangeByScore, RangeByLex, ReadFrom, ServerCredentials, SortClusterOptions, SortOptions, SortedSetRange, 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, parseInfoResponse, } = nativeBinding;
+    module.exports = {
+        AggregationType,
+        BaseScanOptions,
+        HScanOptions,
+        ZScanOptions,
+        BitEncoding,
+        BitFieldGet,
+        BitFieldIncrBy,
+        BitFieldOffset,
+        BitFieldOverflow,
+        BitFieldSet,
+        BitFieldSubCommands,
+        BitOffset,
+        BitOffsetMultiplier,
+        BitOffsetOptions,
+        BitOverflowControl,
+        BitmapIndexType,
+        BitwiseOperation,
+        ConditionalChange,
+        Decoder,
+        DecoderOption,
+        GeoAddOptions,
+        GlideRecord,
+        GlideString,
+        SortedSetDataType,
+        StreamEntryDataType,
+        HashDataType,
+        CoordOrigin,
+        MemberOrigin,
+        SearchOrigin,
+        GeoBoxShape,
+        GeoCircleShape,
+        GeoSearchShape,
+        GeoSearchResultOptions,
+        GeoSearchStoreResultOptions,
+        SortOrder,
+        GeoUnit,
+        GeospatialData,
+        GlideClient,
+        GlideClusterClient,
+        GlideClientConfiguration,
+        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,
+        UpdateOptions,
+        ProtocolVersion,
+        RangeByIndex,
+        RangeByScore,
+        RangeByLex,
+        ReadFrom,
+        ServerCredentials,
+        SortClusterOptions,
+        SortOptions,
+        SortedSetRange,
+        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,
+        parseInfoResponse,
+    };
+    globalObject = Object.assign(global, nativeBinding);
+}
+initialize();
+exports.default = globalObject;