@aneuhold/core-ts-db-lib 1.0.1

package/README.md

@@ -0,0 +1,3 @@
+# Personal Core Database Library
+
+This is used to export types used in various places for database interactions in personal projects.

package/lib/documents/BaseDocument.d.ts

@@ -0,0 +1,9 @@
+import { ObjectId, Document } from 'bson';
+/**
+ * A base document which other types that will be stored in a document DB can
+ * inherit from.
+ */
+export default interface BaseDocument extends Document {
+    _id: ObjectId;
+}
+//# sourceMappingURL=BaseDocument.d.ts.map

package/lib/documents/BaseDocument.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseDocument.d.ts","sourceRoot":"","sources":["../../src/documents/BaseDocument.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAE1C;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,YAAa,SAAQ,QAAQ;IACpD,GAAG,EAAE,QAAQ,CAAC;CACf"}

package/lib/documents/BaseDocument.js

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

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

@@ -0,0 +1,20 @@
+import { ObjectId } from 'bson';
+import BaseDocument from '../BaseDocument';
+/**
+ * A standard user of all personal projects. This should be linked to from
+ * other documents that need to reference a user, instead of cluttering the
+ * key user information.
+ */
+export default class User implements BaseDocument {
+    _id: ObjectId;
+    userName: string;
+    email?: string;
+    auth: {
+        googleId?: string;
+    };
+    /**
+     * Constructs a new {@link User} with default values.
+     */
+    constructor(userName: string);
+}
+//# sourceMappingURL=User.d.ts.map

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

@@ -0,0 +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"}

package/lib/documents/common/User.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const bson_1 = require("bson");
+/**
+ * A standard user of all personal projects. This should be linked to from
+ * other documents that need to reference a user, instead of cluttering the
+ * key user information.
+ */
+class User {
+    _id = new bson_1.ObjectId();
+    userName;
+    email;
+    auth = {};
+    /**
+     * Constructs a new {@link User} with default values.
+     */
+    constructor(userName) {
+        this.userName = userName;
+    }
+}
+exports.default = User;

package/lib/index.d.ts

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

package/lib/index.d.ts.map

@@ -0,0 +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"}

package/lib/index.js

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

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@aneuhold/core-ts-db-lib",
+  "version": "1.0.1",
+  "description": "A core database library used for personal projects",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "author": "Anton G Neuhold Jr <agneuhold@gmail.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aneuhold/core-ts-db-lib.git"
+  },
+  "bugs": {
+    "url": "https://github.com/aneuhold/core-ts-db-lib/issues"
+  },
+  "homepage": "https://github.com/aneuhold/core-ts-db-lib#readme",
+  "files": [
+    "lib/**/*"
+  ],
+  "keywords": [
+    "Scripting",
+    "Node.js"
+  ],
+  "scripts": {
+    "pushpub": "npm run build && npm version patch && git push && npm publish --access public",
+    "build": "tsc",
+    "watch": "tsc -w",
+    "link:local": "cd lib && yarn link",
+    "unlink:local": "cd lib && yarn unlink",
+    "upgrade:all": "yarn upgrade --latest",
+    "test": "jest"
+  },
+  "dependencies": {
+    "bson": "^6.2.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.8",
+    "@types/node": "^20.10.4",
+    "@types/node-fetch": "^2.6.9",
+    "@typescript-eslint/eslint-plugin": "^6.14.0",
+    "@typescript-eslint/parser": "^6.14.0",
+    "eslint": "^8.35.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-prettier": "^5.0.1",
+    "jest": "^29.7.0",
+    "prettier": "^3.1.1",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.2.1",
+    "typescript": "^5.3.3"
+  }
+}