@aneuhold/core-ts-api-lib 1.0.1

package/README.md

@@ -0,0 +1,3 @@
+# Core TypeScript API Library
+
+A core library for interacting with and defining the backend API for personal projects. This can be pulled in to any frontend or backend personal project.

package/lib/index.d.ts

@@ -0,0 +1,6 @@
+import DOFunctionService from './services/DOFunctionService/DOFunctionService';
+import { AuthCheckPasswordInput, AuthCheckPasswordOutput, AuthCheckPasswordRawOutput } from './services/DOFunctionService/functions/authCheckPassword';
+import { AuthValidateUserInput, AuthValidateUserOutput, AuthValidateUserRawOutput } from './services/DOFunctionService/functions/authValidateUser';
+export { DOFunctionService };
+export type { AuthCheckPasswordInput, AuthCheckPasswordOutput, AuthCheckPasswordRawOutput, AuthValidateUserInput, AuthValidateUserOutput, AuthValidateUserRawOutput };
+//# 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,iBAAiB,MAAM,gDAAgD,CAAC;AAC/E,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACvB,0BAA0B,EAC3B,MAAM,0DAA0D,CAAC;AAClE,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,EAC1B,MAAM,yDAAyD,CAAC;AAGjE,OAAO,EAAE,iBAAiB,EAAE,CAAC;AAG7B,YAAY,EACV,sBAAsB,EACtB,uBAAuB,EACvB,0BAA0B,EAC1B,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,EAC1B,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.DOFunctionService = void 0;
+const DOFunctionService_1 = __importDefault(require("./services/DOFunctionService/DOFunctionService"));
+exports.DOFunctionService = DOFunctionService_1.default;

package/lib/services/APIService/APIService.d.ts

@@ -0,0 +1,7 @@
+/**
+ * A service for making calls to the backend API for personal projects. This is
+ * abstracted so that the backend implementation can change over time.
+ */
+export default class APIService {
+}
+//# sourceMappingURL=APIService.d.ts.map

package/lib/services/APIService/APIService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"APIService.d.ts","sourceRoot":"","sources":["../../../src/services/APIService/APIService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;CAAG"}

package/lib/services/APIService/APIService.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * A service for making calls to the backend API for personal projects. This is
+ * abstracted so that the backend implementation can change over time.
+ */
+class APIService {
+}
+exports.default = APIService;

package/lib/services/DOFunctionService/DOFunctionService.d.ts

@@ -0,0 +1,36 @@
+/**
+ * The input to a Digital Ocean function must always be an object.
+ */
+export type DOFunctionInput = object;
+/**
+ * The output from a Digital Ocean function must always be an object. This
+ * is the data that actually matters and doesn't require parsing the `body`
+ * property.
+ */
+export type DOFunctionOutput = object;
+/**
+ * Raw output from a Digital Ocean function must always be an object with
+ * a body property. The body property must also be an object.
+ */
+export interface DOFunctionRawOutput<TOutput extends DOFunctionOutput> {
+    /**
+     * The body is an object, which means it will automatically be serialized to
+     * JSON and the Content-Type header will be set to application/json.
+     */
+    body: TOutput;
+}
+/**
+ * Information about a Digital Ocean function.
+ */
+export type DOFunctionInfo<TInput extends DOFunctionInput, TOutput extends DOFunctionOutput> = {
+    url: string;
+    call: (args: TInput) => Promise<TOutput>;
+};
+/**
+ * A service to provide some utility related to Digital Ocean functions.
+ */
+export default class DOFunctionService {
+    static auchCheckPassword: DOFunctionInfo<import("./functions/authCheckPassword").AuthCheckPasswordInput, import("./functions/authCheckPassword").AuthCheckPasswordOutput>;
+    static authValidateUser: DOFunctionInfo<import("./functions/authValidateUser").AuthValidateUserInput, import("./functions/authValidateUser").AuthValidateUserOutput>;
+}
+//# sourceMappingURL=DOFunctionService.d.ts.map

package/lib/services/DOFunctionService/DOFunctionService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DOFunctionService.d.ts","sourceRoot":"","sources":["../../../src/services/DOFunctionService/DOFunctionService.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEtC;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,OAAO,SAAS,gBAAgB;IACnE;;;OAGG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,CACxB,MAAM,SAAS,eAAe,EAC9B,OAAO,SAAS,gBAAgB,IAC9B;IACF,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;IACpC,MAAM,CAAC,iBAAiB,kJAAqB;IAE7C,MAAM,CAAC,gBAAgB,8IAAoB;CAC5C"}

package/lib/services/DOFunctionService/DOFunctionService.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const authCheckPassword_1 = __importDefault(require("./functions/authCheckPassword"));
+const authValidateUser_1 = __importDefault(require("./functions/authValidateUser"));
+/**
+ * A service to provide some utility related to Digital Ocean functions.
+ */
+class DOFunctionService {
+    static auchCheckPassword = authCheckPassword_1.default;
+    static authValidateUser = authValidateUser_1.default;
+}
+exports.default = DOFunctionService;

package/lib/services/DOFunctionService/functions/authCheckPassword.d.ts

@@ -0,0 +1,13 @@
+import { DOFunctionInfo, DOFunctionInput, DOFunctionOutput, DOFunctionRawOutput } from '../DOFunctionService';
+export interface AuthCheckPasswordInput extends DOFunctionInput {
+    password: string;
+}
+export interface AuthCheckPasswordOutput extends DOFunctionOutput {
+    passwordIsCorrect: boolean;
+}
+export interface AuthCheckPasswordRawOutput extends DOFunctionRawOutput<AuthCheckPasswordOutput> {
+    body: AuthCheckPasswordOutput;
+}
+declare const authCheckPassword: DOFunctionInfo<AuthCheckPasswordInput, AuthCheckPasswordOutput>;
+export default authCheckPassword;
+//# sourceMappingURL=authCheckPassword.d.ts.map

package/lib/services/DOFunctionService/functions/authCheckPassword.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authCheckPassword.d.ts","sourceRoot":"","sources":["../../../../src/services/DOFunctionService/functions/authCheckPassword.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACpB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,WAAW,sBAAuB,SAAQ,eAAe;IAC7D,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D,iBAAiB,EAAE,OAAO,CAAC;CAC5B;AACD,MAAM,WAAW,0BACf,SAAQ,mBAAmB,CAAC,uBAAuB,CAAC;IACpD,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,QAAA,MAAM,iBAAiB,EAAE,cAAc,CACrC,sBAAsB,EACtB,uBAAuB,CAcxB,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/lib/services/DOFunctionService/functions/authCheckPassword.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const authCheckPassword = {
+    url: 'https://faas-sfo3-7872a1dd.doserverless.co/api/v1/web/fn-66dd3ef6-c21d-46dc-b7ae-caf2ac8041ec/auth/checkPassword',
+    call: async (input) => {
+        const result = await fetch(`${authCheckPassword.url}`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify(input)
+        });
+        const json = (await result.json());
+        return json;
+    }
+};
+exports.default = authCheckPassword;

package/lib/services/DOFunctionService/functions/authValidateUser.d.ts

@@ -0,0 +1,19 @@
+import { ApiKey, User } from '@aneuhold/core-ts-db-lib';
+import { DOFunctionInfo, DOFunctionInput, DOFunctionOutput, DOFunctionRawOutput } from '../DOFunctionService';
+export interface AuthValidateUserInput extends DOFunctionInput {
+    userName: string;
+    password: string;
+}
+export interface AuthValidateUserOutput extends DOFunctionOutput {
+    success: boolean;
+    userInfo?: {
+        user: User;
+        apiKey: ApiKey;
+    };
+}
+export interface AuthValidateUserRawOutput extends DOFunctionRawOutput<AuthValidateUserOutput> {
+    body: AuthValidateUserOutput;
+}
+declare const authValidateUser: DOFunctionInfo<AuthValidateUserInput, AuthValidateUserOutput>;
+export default authValidateUser;
+//# sourceMappingURL=authValidateUser.d.ts.map

package/lib/services/DOFunctionService/functions/authValidateUser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authValidateUser.d.ts","sourceRoot":"","sources":["../../../../src/services/DOFunctionService/functions/authValidateUser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EACL,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACpB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE;QACT,IAAI,EAAE,IAAI,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AACD,MAAM,WAAW,yBACf,SAAQ,mBAAmB,CAAC,sBAAsB,CAAC;IACnD,IAAI,EAAE,sBAAsB,CAAC;CAC9B;AAED,QAAA,MAAM,gBAAgB,EAAE,cAAc,CACpC,qBAAqB,EACrB,sBAAsB,CAcvB,CAAC;AAEF,eAAe,gBAAgB,CAAC"}

package/lib/services/DOFunctionService/functions/authValidateUser.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const authValidateUser = {
+    url: 'TBD',
+    call: async (input) => {
+        const result = await fetch(`${authValidateUser.url}`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify(input)
+        });
+        const json = (await result.json());
+        return json;
+    }
+};
+exports.default = authValidateUser;

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@aneuhold/core-ts-api-lib",
+  "version": "1.0.1",
+  "description": "A library for interacting with the backend and defining the backend API 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-api-lib.git"
+  },
+  "bugs": {
+    "url": "https://github.com/aneuhold/core-ts-api-lib/issues"
+  },
+  "homepage": "https://github.com/aneuhold/core-ts-api-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",
+    "link:coredb": "yarn link @aneuhold/core-ts-db-lib",
+    "unlink:local": "cd lib && yarn unlink",
+    "unlink:coredb": "yarn unlink @aneuhold/core-ts-db-lib && yarn install --force",
+    "upgrade:all": "yarn upgrade --latest",
+    "upgrade:core": "yarn upgrade --latest --pattern @aneuhold",
+    "test": "jest"
+  },
+  "dependencies": {
+    "@aneuhold/core-ts-db-lib": "^1.0.3",
+    "@aneuhold/core-ts-lib": "^1.1.7"
+  },
+  "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"
+  }
+}