@aneuhold/core-ts-db-lib 1.0.1 → 1.0.2

package/README.md

@@ -1,3 +1,5 @@
 # Personal Core Database Library
 
+![npm](https://img.shields.io/npm/v/%40aneuhold%2Fcore-ts-db-lib)
+
 This is used to export types used in various places for database interactions in personal projects.

package/lib/documents/common/ApiKey.d.ts

@@ -0,0 +1,22 @@
+import { ObjectId } from 'bson';
+import BaseDocument from '../BaseDocument';
+/**
+ * A document containing an API key for a particular user. This is stored
+ * separately from the {@link User} document to enhance security a bit.
+ */
+export default class ApiKey implements BaseDocument {
+    _id: ObjectId;
+    /**
+     * The API key for the user.
+     */
+    key: `${string}-${string}-${string}-${string}-${string}`;
+    /**
+     * The user ID that this key is for. This field is indexed in the database.
+     */
+    userId: ObjectId;
+    /**
+     * Constructs a new {@link ApiKey} for the provided user.
+     */
+    constructor(userId: ObjectId);
+}
+//# sourceMappingURL=ApiKey.d.ts.map

package/lib/documents/common/ApiKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiKey.d.ts","sourceRoot":"","sources":["../../../src/documents/common/ApiKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAEhC,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAE3C;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,MAAO,YAAW,YAAY;IACjD,GAAG,WAAkB;IAErB;;OAEG;IACH,GAAG,sDAAuB;IAE1B;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;gBACS,MAAM,EAAE,QAAQ;CAG7B"}

package/lib/documents/common/ApiKey.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const bson_1 = require("bson");
+const crypto_1 = __importDefault(require("crypto"));
+/**
+ * A document containing an API key for a particular user. This is stored
+ * separately from the {@link User} document to enhance security a bit.
+ */
+class ApiKey {
+    _id = new bson_1.ObjectId();
+    /**
+     * The API key for the user.
+     */
+    key = crypto_1.default.randomUUID();
+    /**
+     * The user ID that this key is for. This field is indexed in the database.
+     */
+    userId;
+    /**
+     * Constructs a new {@link ApiKey} for the provided user.
+     */
+    constructor(userId) {
+        this.userId = userId;
+    }
+}
+exports.default = ApiKey;

package/lib/documents/common/User.d.ts

@@ -8,6 +8,7 @@ import BaseDocument from '../BaseDocument';
 export default class User implements BaseDocument {
     _id: ObjectId;
     userName: string;
+    password?: string;
     email?: string;
     auth: {
         googleId?: string;

package/lib/documents/common/User.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"User.d.ts","sourceRoot":"","sources":["../../../src/documents/common/User.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAE3C;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,YAAW,YAAY;IAC/C,GAAG,WAAkB;IAErB,QAAQ,EAAE,MAAM,CAAC;IAEjB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE;QACJ,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAM;IAEP;;OAEG;gBACS,QAAQ,EAAE,MAAM;CAG7B"}
+{"version":3,"file":"User.d.ts","sourceRoot":"","sources":["../../../src/documents/common/User.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAE3C;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,YAAW,YAAY;IAC/C,GAAG,WAAkB;IAErB,QAAQ,EAAE,MAAM,CAAC;IAEjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE;QACJ,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAM;IAEP;;OAEG;gBACS,QAAQ,EAAE,MAAM;CAG7B"}

package/lib/documents/common/User.js

@@ -9,6 +9,7 @@ const bson_1 = require("bson");
 class User {
     _id = new bson_1.ObjectId();
     userName;
+    password;
     email;
     auth = {};
     /**

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 import BaseDocument from './documents/BaseDocument';
+import ApiKey from './documents/common/ApiKey';
 import User from './documents/common/User';
-export { User };
+export { User, ApiKey };
 export type { BaseDocument };
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,0BAA0B,CAAC;AACpD,OAAO,IAAI,MAAM,yBAAyB,CAAC;AAG3C,OAAO,EAAE,IAAI,EAAE,CAAC;AAGhB,YAAY,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,0BAA0B,CAAC;AACpD,OAAO,MAAM,MAAM,2BAA2B,CAAC;AAC/C,OAAO,IAAI,MAAM,yBAAyB,CAAC;AAG3C,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAGxB,YAAY,EAAE,YAAY,EAAE,CAAC"}

package/lib/index.js

@@ -3,6 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.User = void 0;
+exports.ApiKey = exports.User = void 0;
+const ApiKey_1 = __importDefault(require("./documents/common/ApiKey"));
+exports.ApiKey = ApiKey_1.default;
 const User_1 = __importDefault(require("./documents/common/User"));
 exports.User = User_1.default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aneuhold/core-ts-db-lib",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A core database library used for personal projects",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -28,6 +28,7 @@
     "link:local": "cd lib && yarn link",
     "unlink:local": "cd lib && yarn unlink",
     "upgrade:all": "yarn upgrade --latest",
+    "upgrade:core": "yarn upgrade --latest @aneuhold",
     "test": "jest"
   },
   "dependencies": {