@ldsg/key-value-cache 0.2.5

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2014-present Sebastian McKenzie and other contributors
+
+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

@@ -0,0 +1 @@
+# LDSG Key Value Cache Resource

package/dist/constants.d.ts

@@ -0,0 +1,17 @@
+import { HandlerSpecificResourceSettings } from "@ldsg/handler";
+import { ResourceDefinitionSpecificResourceSettings } from "@ldsg/resource-definition";
+import { GeneralResourceSettings } from "@ldsg/types";
+/**
+ * Instantiate Resource Handler General Resource Settings
+ * 实例化资源处理程序普通资源配置
+ */
+export declare const INSTANTIATE_RESOURCE_HANDLER_GENERAL_RESOURCE_SETTINGS: GeneralResourceSettings;
+/**
+ * Instantiate Resource Handler Specific Resource Settings
+ * 实例化资源处理程序特殊资源配置
+ * 框架通过此实例化此资源
+ */
+export declare const INSTANTIATE_RESOURCE_HANDLER_SPECIFIC_RESOURCE_SETTINGS: HandlerSpecificResourceSettings;
+export declare const RESOURCE_DEFINITION_GENERAL_RESOURCE_SETTINGS: GeneralResourceSettings;
+export declare const RESOURCE_DEFINITION_SPECIFIC_RESOURCE_SETTINGS: ResourceDefinitionSpecificResourceSettings;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,+BAA+B,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,0CAA0C,EAAE,MAAM,2BAA2B,CAAC;AACvF,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,sDAAsD,EAAE,uBAIlE,CAAC;AAEJ;;;;GAIG;AACH,eAAO,MAAM,uDAAuD,EAAE,+BAQnE,CAAC;AAEJ,eAAO,MAAM,6CAA6C,EAAE,uBACnB,CAAC;AAE1C,eAAO,MAAM,8CAA8C,EAAE,0CAI1D,CAAC"}

package/dist/constants.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RESOURCE_DEFINITION_SPECIFIC_RESOURCE_SETTINGS = exports.RESOURCE_DEFINITION_GENERAL_RESOURCE_SETTINGS = exports.INSTANTIATE_RESOURCE_HANDLER_SPECIFIC_RESOURCE_SETTINGS = exports.INSTANTIATE_RESOURCE_HANDLER_GENERAL_RESOURCE_SETTINGS = void 0;
+const constants_1 = require("@ldsg/constants");
+/**
+ * Instantiate Resource Handler General Resource Settings
+ * 实例化资源处理程序普通资源配置
+ */
+exports.INSTANTIATE_RESOURCE_HANDLER_GENERAL_RESOURCE_SETTINGS = {
+    title: "键值对缓存实例化资源处理程序",
+    description: "",
+};
+/**
+ * Instantiate Resource Handler Specific Resource Settings
+ * 实例化资源处理程序特殊资源配置
+ * 框架通过此实例化此资源
+ */
+exports.INSTANTIATE_RESOURCE_HANDLER_SPECIFIC_RESOURCE_SETTINGS = {
+    code: `export * from "@ldsg/key-value-cache";`,
+    dependencies: [
+        {
+            name: "@ldsg/key-value-cache",
+        },
+    ],
+};
+exports.RESOURCE_DEFINITION_GENERAL_RESOURCE_SETTINGS = { title: "键值对缓存资源定义", description: "" };
+exports.RESOURCE_DEFINITION_SPECIFIC_RESOURCE_SETTINGS = {
+    kind: "key_value_cache",
+    parentKind: constants_1.ROOT_RESOURCE_KIND,
+};

package/dist/handler.d.ts

@@ -0,0 +1,8 @@
+import { Handler } from "@ldsg/handler";
+import { InstantiateResourceParams, InstantiateResourceRes } from "@ldsg/resource";
+import { KeyValueCacheResource } from "./resource";
+import { KeyValueCacheSpecificResourceSettings } from "./types";
+export declare const handler: Handler<[
+    InstantiateResourceParams<KeyValueCacheSpecificResourceSettings>
+], InstantiateResourceRes<KeyValueCacheResource>>;
+//# sourceMappingURL=handler.d.ts.map

package/dist/handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../src/handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EACL,yBAAyB,EACzB,sBAAsB,EACvB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,qCAAqC,EAAE,MAAM,SAAS,CAAC;AAEhE,eAAO,MAAM,OAAO,EAAE,OAAO,CAC3B;IAAC,yBAAyB,CAAC,qCAAqC,CAAC;CAAC,EAClE,sBAAsB,CAAC,qBAAqB,CAAC,CACxB,CAAC"}

package/dist/handler.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = void 0;
+const instantiate_resource_1 = require("./instantiate-resource");
+exports.handler = instantiate_resource_1.instantiateResource;

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./constants";
+export * from "./handler";
+export * from "./instantiate-resource";
+export * from "./resource";
+export * from "./types";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,wBAAwB,CAAC;AACvC,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+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]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./constants"), exports);
+__exportStar(require("./handler"), exports);
+__exportStar(require("./instantiate-resource"), exports);
+__exportStar(require("./resource"), exports);
+__exportStar(require("./types"), exports);

package/dist/instantiate-resource.d.ts

@@ -0,0 +1,5 @@
+import { InstantiateResource } from "@ldsg/resource";
+import { KeyValueCacheResource } from "./resource";
+import { KeyValueCacheSpecificResourceSettings } from "./types";
+export declare const instantiateResource: InstantiateResource<KeyValueCacheSpecificResourceSettings, KeyValueCacheResource>;
+//# sourceMappingURL=instantiate-resource.d.ts.map

package/dist/instantiate-resource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instantiate-resource.d.ts","sourceRoot":"","sources":["../src/instantiate-resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,qCAAqC,EAAE,MAAM,SAAS,CAAC;AAEhE,eAAO,MAAM,mBAAmB,EAAE,mBAAmB,CACnD,qCAAqC,EACrC,qBAAqB,CAWtB,CAAC"}

package/dist/instantiate-resource.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instantiateResource = void 0;
+const resource_1 = require("./resource");
+const instantiateResource = (params) => {
+    const { resourceConstructorParams } = params;
+    const resource = new resource_1.KeyValueCacheResource(resourceConstructorParams);
+    const res = {
+        resource,
+    };
+    return res;
+};
+exports.instantiateResource = instantiateResource;

package/dist/resource.d.ts

@@ -0,0 +1,39 @@
+import { Resource, ResourceConstructorParams } from "@ldsg/resource";
+import mongoose from "mongoose";
+import { KeyValueCacheSpecificResourceSettings } from "./types";
+export declare class KeyValueCacheResource extends Resource<KeyValueCacheSpecificResourceSettings> {
+    keyValueCacheModel: mongoose.Model<{
+        key?: string | null | undefined;
+        value?: string | null | undefined;
+    }, {}, {}, {}, mongoose.Document<unknown, {}, {
+        key?: string | null | undefined;
+        value?: string | null | undefined;
+    }, {}> & {
+        key?: string | null | undefined;
+        value?: string | null | undefined;
+    } & {
+        _id: mongoose.Types.ObjectId;
+    } & {
+        __v: number;
+    }, mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, {
+        key?: string | null | undefined;
+        value?: string | null | undefined;
+    }, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
+        key?: string | null | undefined;
+        value?: string | null | undefined;
+    }>, {}> & mongoose.FlatRecord<{
+        key?: string | null | undefined;
+        value?: string | null | undefined;
+    }> & {
+        _id: mongoose.Types.ObjectId;
+    } & {
+        __v: number;
+    }>>;
+    constructor(params: ResourceConstructorParams<KeyValueCacheSpecificResourceSettings>);
+    getRealKeyInDatabase: (key: string) => string;
+    clear: () => Promise<void>;
+    getItem: (key: string) => Promise<string | null | undefined>;
+    setItem: (key: string, value: any) => Promise<void>;
+    removeItem: (key: string) => Promise<void>;
+}
+//# sourceMappingURL=resource.d.ts.map

package/dist/resource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../src/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;AACrE,OAAO,QAAoB,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,qCAAqC,EAAE,MAAM,SAAS,CAAC;AAEhE,qBAAa,qBAAsB,SAAQ,QAAQ,CAAC,qCAAqC,CAAC;IACxF,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;QAAC;gBAGjB,MAAM,EAAE,yBAAyB,CAAC,qCAAqC,CAAC;IAuB1E,oBAAoB,GAAI,KAAK,MAAM,YAMjC;IAEF,KAAK,sBAEH;IAEF,OAAO,GAAU,KAAK,MAAM,wCAU1B;IAEF,OAAO,GAAU,KAAK,MAAM,EAAE,OAAO,GAAG,mBAiBtC;IAEF,UAAU,GAAU,KAAK,MAAM,mBAM7B;CACH"}

package/dist/resource.js

@@ -0,0 +1,91 @@
+"use strict";
+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]; } };
+    }
+    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);
+    };
+    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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyValueCacheResource = void 0;
+const resource_1 = require("@ldsg/resource");
+const mongoose_1 = __importStar(require("mongoose"));
+class KeyValueCacheResource extends resource_1.Resource {
+    constructor(params) {
+        super(params);
+        this.getRealKeyInDatabase = (key) => {
+            const { keyPrefix = "" } = this.settings;
+            const res = `${keyPrefix}${key}`;
+            return res;
+        };
+        this.clear = async () => {
+            await this.keyValueCacheModel.deleteMany();
+        };
+        this.getItem = async (key) => {
+            const realKey = this.getRealKeyInDatabase(key);
+            const findOneRes = await this.keyValueCacheModel.findOne({
+                id: realKey,
+            });
+            const res = findOneRes === null || findOneRes === void 0 ? void 0 : findOneRes.value;
+            return res;
+        };
+        this.setItem = async (key, value) => {
+            const realKey = this.getRealKeyInDatabase(key);
+            await this.keyValueCacheModel.findOneAndUpdate({
+                key: realKey,
+            }, {
+                $set: {
+                    value,
+                },
+            }, {
+                upsert: true,
+                new: true,
+            });
+        };
+        this.removeItem = async (key) => {
+            const realKey = this.getRealKeyInDatabase(key);
+            await this.keyValueCacheModel.deleteMany({
+                key: realKey,
+            });
+        };
+        const { collectionName = "key-value-cache" } = params.settings;
+        const keyValueCacheSchema = new mongoose_1.Schema({
+            key: {
+                type: String,
+                index: true,
+                unique: true,
+            },
+            value: {
+                type: String,
+            },
+        });
+        this.keyValueCacheModel = mongoose_1.default.model(collectionName, keyValueCacheSchema);
+    }
+}
+exports.KeyValueCacheResource = KeyValueCacheResource;

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./specific-resource-settings";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC"}

package/dist/types/index.js

@@ -0,0 +1,17 @@
+"use strict";
+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]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./specific-resource-settings"), exports);

package/dist/types/specific-resource-settings.d.ts

@@ -0,0 +1,12 @@
+import { SpecificResourceSettings } from "@ldsg/types";
+export interface KeyValueCacheSpecificResourceSettings extends SpecificResourceSettings {
+    /**
+     * Collection Name
+     */
+    collectionName?: string;
+    /**
+     * Key Prefix
+     */
+    keyPrefix?: string;
+}
+//# sourceMappingURL=specific-resource-settings.d.ts.map

package/dist/types/specific-resource-settings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"specific-resource-settings.d.ts","sourceRoot":"","sources":["../../src/types/specific-resource-settings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAEvD,MAAM,WAAW,qCACf,SAAQ,wBAAwB;IAChC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/dist/types/specific-resource-settings.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@ldsg/key-value-cache",
+  "version": "0.2.5",
+  "description": "",
+  "main": "dist/index.js",
+  "files": [
+    "dist/"
+  ],
+  "types": "dist",
+  "keywords": [],
+  "author": "wanxger",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "express": "^4.18.2",
+    "mongoose": "^8.14.3",
+    "@ldsg/handler": "0.2.5",
+    "@ldsg/resource": "0.2.5",
+    "@ldsg/types": "0.2.5",
+    "@ldsg/resource-definition": "0.2.5"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.17",
+    "@types/node": "^20.13.0",
+    "@types/supertest": "^6.0.0",
+    "supertest": "^6.3.4"
+  },
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "clean": "rm -rf dist"
+  }
+}