@ohos-ports/keyv-memcache 0.0.0-stage → 2.0.2-beta.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2017-2021 Luke Childs
+Copyright (c) 2021-2022 Jared Wray
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,143 @@
-# Temporary Holding Version
+# @keyv/memcache [<img width="100" align="right" src="https://jaredwray.com/images/keyv-symbol.svg" alt="keyv">](https://github.com/jaredwra/keyv)
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+> Memcache storage adapter for [Keyv](https://github.com/jaredwray/keyv)
+
+
+[![build](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml/badge.svg)](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml)
+[![codecov](https://codecov.io/gh/jaredwray/keyv/branch/main/graph/badge.svg?token=bRzR3RyOXZ)](https://codecov.io/gh/jaredwray/keyv)
+[![GitHub license](https://img.shields.io/github/license/jaredwray/keyv)](https://github.com/jaredwray/keyv/blob/main/LICENSE)
+[![npm](https://img.shields.io/npm/dm/@keyv/memcache)](https://npmjs.com/package/@keyv/memcache)
+
+## Install
+
+```shell
+npm install --save @keyv/memcache
+```
+
+## Keyv Compression is not Supported
+
+This package does not support compression. If you need compression, please use the `@keyv/redis` or another service package instead.
+
+## Usage
+
+```js
+import Keyv from 'keyv';
+import KeyvMemcache from '@keyv/memcache';
+
+const memcache = new KeyvMemcache('user:pass@localhost:11211');
+const keyv = new Keyv({ store: memcache });
+
+//set 
+await keyv.set("foo","bar", 6000) //Expiring time is optional
+
+//get
+const obj = await keyv.get("foo");
+
+//delete
+await keyv.delete("foo");
+
+//clear
+await keyv.clear();
+
+```
+
+## Usage with Namespaces
+
+```js
+import Keyv from 'keyv';
+import KeyvMemcache from '@keyv/memcache';
+
+const memcache = new KeyvMemcache('user:pass@localhost:11211');
+const keyv1 = new Keyv({ store: memcache, namespace: "namespace1" });
+const keyv2 = new Keyv({ store: memcache, namespace: "namespace2" });
+
+//set 
+await keyv1.set("foo","bar1", 6000) //Expiring time is optional
+await keyv2.set("foo","bar2", 6000) //Expiring time is optional
+
+//get
+const obj1 = await keyv1.get("foo"); //will return bar1
+const obj2 = await keyv2.get("foo"); //will return bar2
+
+```
+
+# Works with Memcached, Memcachier, Redislabs, and Google Cloud
+
+## Using Memcached 
+
+1. Install Memcached and start an instance
+```js
+
+//set the server to the correct address and port 
+const server = "localhost:11211"
+
+const Keyv = require("keyv");
+const KeyvMemcache = require("@keyv/memcache");
+
+const memcache = new KeyvMemcache(server);
+const keyv = new Keyv({ store: memcache});
+```
+
+## Using Memcachier 
+
+1. Go to https://www.memcachier.com and signup
+2. Create a cache and setup where. 
+3. In the screen take the username, password, and url and place it into your code:
+```js
+
+//best practice is to not hard code your config in code. 
+const user = "";
+const pass = "";
+const server = "XXX.XXX.XXX.memcachier.com:11211"
+
+const Keyv = require("keyv");
+const KeyvMemcache = require("@keyv/memcache");
+
+const memcache = new KeyvMemcache(user +":"+ pass +"@"+ server);
+const keyv = new Keyv({ store: memcache});
+
+```
+
+## Using Redislabs Memcache Protocol 
+
+1. Go to https://www.redislabs.com and signup
+2. Create a database and make sure to set the `Protocol` to memcached
+3. In the screen take the username, password, and `endpoint` (the server) and place it into your code:
+```js
+
+//best practice is to not hard code your config in code. 
+const user = "";
+const pass = "";
+const server = "XXX.XXX.XXX.XXX.cloud.redislabs.com:XXX"
+
+const Keyv = require("keyv");
+const KeyvMemcache = require("@keyv/memcache");
+
+const memcache = new KeyvMemcache(user +":"+ pass +"@"+ server);
+const keyv = new Keyv({ store: memcache});
+
+```
+
+## Using Google Cloud
+
+1. Go to https://cloud.google.com/ and sign up.
+2. Go to the memcached configuration page in the google cloud console by navigating to Memorystore > Memcached. 
+3. On the memcached page (Eg. https://console.cloud.google.com/memorystore/memcached/instances?project=example), Click Create Instance
+4. Fill in all mandatory fields as needed. You will need to set up a private service connection.
+5. To set up a private service connection, click the Set Up Connection button.
+6. Once required fields are complete, click the Create button to create the instance.
+7. Google provides further documentation for connecting to and managing your Memecached instance [here](https://cloud.google.com/memorystore/docs/memcached). 
+
+```js
+import Keyv from 'keyv';
+import KeyvMemcache from '@keyv/memcache';
+
+const memcache = new KeyvMemcache("insert the internal google memcached discovery endpoint");
+const keyv = new Keyv({ store: memcache});
+
+```
+
+
+## License
+
+[MIT © Jared Wray](LISCENCE)

package/dist/index.cjs

@@ -0,0 +1,157 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  KeyvMemcache: () => KeyvMemcache,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var import_node_events = __toESM(require("events"), 1);
+var import_memjs = __toESM(require("memjs"), 1);
+var import_serialize = require("@keyv/serialize");
+var KeyvMemcache = class extends import_node_events.default {
+  ttlSupport = true;
+  namespace;
+  client;
+  opts;
+  constructor(uri, options) {
+    super();
+    options = {
+      ...typeof uri === "string" ? { uri } : uri,
+      ...options
+    };
+    if (options.uri && options.url === void 0) {
+      options.url = options.uri;
+    }
+    if (uri === void 0) {
+      uri = "localhost:11211";
+      options.url = options.uri = uri;
+    }
+    this.opts = options;
+    this.client = import_memjs.default.Client.create(uri, options);
+  }
+  _getNamespace() {
+    return `namespace:${this.namespace}`;
+  }
+  async get(key) {
+    return new Promise((resolve, reject) => {
+      this.client.get(this.formatKey(key), (error, value) => {
+        if (error) {
+          this.emit("error", error);
+          reject(error);
+        } else {
+          let value_;
+          if (value === null) {
+            value_ = {
+              value: void 0,
+              expires: 0
+            };
+          } else {
+            value_ = this.opts.deserialize ? this.opts.deserialize(value) : (0, import_serialize.defaultDeserialize)(value);
+          }
+          resolve(value_);
+        }
+      });
+    });
+  }
+  async getMany(keys) {
+    const promises = [];
+    for (const key of keys) {
+      promises.push(this.get(key));
+    }
+    return Promise.allSettled(promises).then((values) => {
+      const data = [];
+      for (const value of values) {
+        data.push(value.value);
+      }
+      return data;
+    });
+  }
+  async set(key, value, ttl) {
+    const options = {};
+    if (ttl !== void 0) {
+      options.expires = options.ttl = Math.floor(ttl / 1e3);
+    }
+    await this.client.set(this.formatKey(key), value, options);
+  }
+  async delete(key) {
+    return new Promise((resolve, reject) => {
+      this.client.delete(this.formatKey(key), (error, success) => {
+        if (error) {
+          this.emit("error", error);
+          reject(error);
+        } else {
+          resolve(Boolean(success));
+        }
+      });
+    });
+  }
+  async deleteMany(keys) {
+    const promises = keys.map(async (key) => this.delete(key));
+    const results = await Promise.allSettled(promises);
+    return results.every((x) => x.value === true);
+  }
+  async clear() {
+    return new Promise((resolve, reject) => {
+      this.client.flush((error) => {
+        if (error) {
+          this.emit("error", error);
+          reject(error);
+        } else {
+          resolve(void 0);
+        }
+      });
+    });
+  }
+  formatKey(key) {
+    let result = key;
+    if (this.namespace) {
+      result = this.namespace.trim() + ":" + key.trim();
+    }
+    return result;
+  }
+  async has(key) {
+    return new Promise((resolve) => {
+      this.client.get(this.formatKey(key), (error, value) => {
+        if (error) {
+          resolve(false);
+        } else {
+          resolve(value !== null);
+        }
+      });
+    });
+  }
+};
+var index_default = KeyvMemcache;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  KeyvMemcache
+});

package/dist/index.d.cts

@@ -0,0 +1,26 @@
+import EventEmitter from 'node:events';
+import memcache from 'memjs';
+import { KeyvStoreAdapter, StoredData } from 'keyv';
+
+type KeyvMemcacheOptions = {
+    url?: string;
+    expires?: number;
+} & memcache.ClientOptions & Record<string, any>;
+declare class KeyvMemcache extends EventEmitter implements KeyvStoreAdapter {
+    ttlSupport: boolean;
+    namespace?: string;
+    client: memcache.Client;
+    opts: KeyvMemcacheOptions;
+    constructor(uri?: string, options?: KeyvMemcacheOptions);
+    _getNamespace(): string;
+    get<Value>(key: string): Promise<StoredData<Value>>;
+    getMany<Value>(keys: string[]): Promise<StoredData<Value>[]>;
+    set(key: string, value: any, ttl?: number): Promise<void>;
+    delete(key: string): Promise<boolean>;
+    deleteMany(keys: string[]): Promise<boolean>;
+    clear(): Promise<void>;
+    formatKey(key: string): string;
+    has(key: string): Promise<boolean>;
+}
+
+export { KeyvMemcache, type KeyvMemcacheOptions, KeyvMemcache as default };

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+import EventEmitter from 'node:events';
+import memcache from 'memjs';
+import { KeyvStoreAdapter, StoredData } from 'keyv';
+
+type KeyvMemcacheOptions = {
+    url?: string;
+    expires?: number;
+} & memcache.ClientOptions & Record<string, any>;
+declare class KeyvMemcache extends EventEmitter implements KeyvStoreAdapter {
+    ttlSupport: boolean;
+    namespace?: string;
+    client: memcache.Client;
+    opts: KeyvMemcacheOptions;
+    constructor(uri?: string, options?: KeyvMemcacheOptions);
+    _getNamespace(): string;
+    get<Value>(key: string): Promise<StoredData<Value>>;
+    getMany<Value>(keys: string[]): Promise<StoredData<Value>[]>;
+    set(key: string, value: any, ttl?: number): Promise<void>;
+    delete(key: string): Promise<boolean>;
+    deleteMany(keys: string[]): Promise<boolean>;
+    clear(): Promise<void>;
+    formatKey(key: string): string;
+    has(key: string): Promise<boolean>;
+}
+
+export { KeyvMemcache, type KeyvMemcacheOptions, KeyvMemcache as default };

package/dist/index.js

@@ -0,0 +1,122 @@
+// src/index.ts
+import EventEmitter from "events";
+import memcache from "memjs";
+import { defaultDeserialize } from "@keyv/serialize";
+var KeyvMemcache = class extends EventEmitter {
+  ttlSupport = true;
+  namespace;
+  client;
+  opts;
+  constructor(uri, options) {
+    super();
+    options = {
+      ...typeof uri === "string" ? { uri } : uri,
+      ...options
+    };
+    if (options.uri && options.url === void 0) {
+      options.url = options.uri;
+    }
+    if (uri === void 0) {
+      uri = "localhost:11211";
+      options.url = options.uri = uri;
+    }
+    this.opts = options;
+    this.client = memcache.Client.create(uri, options);
+  }
+  _getNamespace() {
+    return `namespace:${this.namespace}`;
+  }
+  async get(key) {
+    return new Promise((resolve, reject) => {
+      this.client.get(this.formatKey(key), (error, value) => {
+        if (error) {
+          this.emit("error", error);
+          reject(error);
+        } else {
+          let value_;
+          if (value === null) {
+            value_ = {
+              value: void 0,
+              expires: 0
+            };
+          } else {
+            value_ = this.opts.deserialize ? this.opts.deserialize(value) : defaultDeserialize(value);
+          }
+          resolve(value_);
+        }
+      });
+    });
+  }
+  async getMany(keys) {
+    const promises = [];
+    for (const key of keys) {
+      promises.push(this.get(key));
+    }
+    return Promise.allSettled(promises).then((values) => {
+      const data = [];
+      for (const value of values) {
+        data.push(value.value);
+      }
+      return data;
+    });
+  }
+  async set(key, value, ttl) {
+    const options = {};
+    if (ttl !== void 0) {
+      options.expires = options.ttl = Math.floor(ttl / 1e3);
+    }
+    await this.client.set(this.formatKey(key), value, options);
+  }
+  async delete(key) {
+    return new Promise((resolve, reject) => {
+      this.client.delete(this.formatKey(key), (error, success) => {
+        if (error) {
+          this.emit("error", error);
+          reject(error);
+        } else {
+          resolve(Boolean(success));
+        }
+      });
+    });
+  }
+  async deleteMany(keys) {
+    const promises = keys.map(async (key) => this.delete(key));
+    const results = await Promise.allSettled(promises);
+    return results.every((x) => x.value === true);
+  }
+  async clear() {
+    return new Promise((resolve, reject) => {
+      this.client.flush((error) => {
+        if (error) {
+          this.emit("error", error);
+          reject(error);
+        } else {
+          resolve(void 0);
+        }
+      });
+    });
+  }
+  formatKey(key) {
+    let result = key;
+    if (this.namespace) {
+      result = this.namespace.trim() + ":" + key.trim();
+    }
+    return result;
+  }
+  async has(key) {
+    return new Promise((resolve) => {
+      this.client.get(this.formatKey(key), (error, value) => {
+        if (error) {
+          resolve(false);
+        } else {
+          resolve(value !== null);
+        }
+      });
+    });
+  }
+};
+var index_default = KeyvMemcache;
+export {
+  KeyvMemcache,
+  index_default as default
+};

package/package.json

@@ -1,6 +1,88 @@
 {
   "name": "@ohos-ports/keyv-memcache",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "2.0.2-beta.0",
+  "description": "Memcache storage adapter for Keyv",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js"
+    }
+  },
+  "xo": {
+    "rules": {
+      "import/no-named-as-default": "off",
+      "unicorn/prefer-module": "off",
+      "unicorn/prefer-event-target": "off",
+      "unicorn/no-array-reduce": "off",
+      "n/prefer-global/process": "off",
+      "node/prefer-global/process": "off",
+      "unicorn/prefer-object-from-entries": "off",
+      "unicorn/prefer-node-protocol": "off",
+      "@typescript-eslint/consistent-type-imports": "off",
+      "@typescript-eslint/consistent-type-definitions": "off",
+      "@typescript-eslint/no-empty-function": "off",
+      "import/extensions": "off",
+      "no-promise-executor-return": "off",
+      "import/no-extraneous-dependencies": "off"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ohos-ports/ohos-ports.git",
+    "directory": "ports/@keyv/memcache/2.0.2"
+  },
+  "keywords": [
+    "memcache",
+    "keyv",
+    "storage",
+    "adapter",
+    "key",
+    "value",
+    "store",
+    "cache",
+    "ttl"
+  ],
+  "author": "Jared Wray <me@jaredwray.com> (https://jaredwray.com)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ohos-ports/ohos-ports/issues"
+  },
+  "homepage": "https://github.com/jaredwray/keyv",
+  "dependencies": {
+    "buffer": "^6.0.3",
+    "memjs": "^1.3.2",
+    "@keyv/serialize": "^1.0.3"
+  },
+  "peerDependencies": {
+    "keyv": "^5.3.4"
+  },
+  "devDependencies": {
+    "@types/memjs": "^1.3.3",
+    "@vitest/coverage-v8": "^3.2.3",
+    "rimraf": "^6.0.1",
+    "tsd": "^0.32.0",
+    "tsup": "^8.5.0",
+    "typescript": "^5.8.3",
+    "@ohos-ports/vitest": "^5.0.1-beta.0",
+    "xo": "^1.1.0",
+    "@keyv/compress-gzip": "^2.0.3",
+    "@keyv/test-suite": "^2.0.7"
+  },
+  "tsd": {
+    "directory": "test"
+  },
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "rimraf ./dist && tsup src/index.ts --format cjs,esm --dts --clean",
+    "test": "xo --fix && vitest run --coverage",
+    "test:ci": "xo && vitest --run --sequence.setupFiles=list",
+    "clean": "rimraf ./node_modules ./coverage ./dist"
+  }
+}