@aneuhold/core-ts-api-lib 1.0.119 → 2.0.0

package/lib/services/DOFunctionService/functions/projectDashboard.ts

@@ -0,0 +1,127 @@
+import {
+  DashboardTask,
+  DashboardUserConfig,
+  NonogramKatanaItem,
+  NonogramKatanaUpgrade,
+  UserCTO
+} from '@aneuhold/core-ts-db-lib';
+import { UUID } from 'crypto';
+import { Translations } from '../../../types/Translations.js';
+import DOFunction, {
+  DOFunctionInput,
+  DOFunctionOutput
+} from '../DOFunction.js';
+
+/**
+ * Options for configuring the project dashboard.
+ */
+export interface ProjectDashboardOptions {
+  get?: {
+    /**
+     * Whether to include translations in the response.
+     */
+    translations?: boolean;
+    /**
+     * If true, the user config will be returned for the user
+     * and the collaborators.
+     */
+    userConfig?: boolean;
+    /**
+     * Whether to include tasks in the response.
+     */
+    tasks?: boolean;
+    /**
+     * A string indicating if the user name is valid.
+     */
+    userNameIsValid?: string;
+    /**
+     * Whether to include nonogram katana items in the response.
+     */
+    nonogramKatanaItems?: boolean;
+    /**
+     * Whether to include nonogram katana upgrades in the response.
+     */
+    nonogramKatanaUpgrades?: boolean;
+  };
+  insert?: {
+    /**
+     * Tasks to be inserted.
+     */
+    tasks?: DashboardTask[];
+    /**
+     * Nonogram katana items to be inserted.
+     */
+    nonogramKatanaItems?: NonogramKatanaItem[];
+    /**
+     * Nonogram katana upgrades to be inserted.
+     */
+    nonogramKatanaUpgrades?: NonogramKatanaUpgrade[];
+  };
+  update?: {
+    /**
+     * User configuration to be updated.
+     */
+    userConfig?: DashboardUserConfig;
+    /**
+     * Tasks to be updated.
+     */
+    tasks?: DashboardTask[];
+    /**
+     * Nonogram katana items to be updated.
+     */
+    nonogramKatanaItems?: NonogramKatanaItem[];
+    /**
+     * Nonogram katana upgrades to be updated.
+     */
+    nonogramKatanaUpgrades?: NonogramKatanaUpgrade[];
+  };
+  delete?: {
+    /**
+     * Tasks to be deleted.
+     */
+    tasks?: DashboardTask[];
+  };
+}
+
+/**
+ * Represents the input to the project dashboard function.
+ */
+export interface ProjectDashboardInput extends DOFunctionInput {
+  apiKey: UUID;
+  options: ProjectDashboardOptions;
+}
+
+/**
+ * Represents the output of the project dashboard function.
+ */
+export interface ProjectDashboardOutput extends DOFunctionOutput {
+  translations?: Translations;
+  userConfig?: DashboardUserConfig;
+  tasks?: DashboardTask[];
+  collaborators?: UserCTO[];
+  userFromUserName?: UserCTO | null;
+  nonogramKatanaItems?: NonogramKatanaItem[];
+  nonogramKatanaUpgrades?: NonogramKatanaUpgrade[];
+}
+
+/**
+ * The Digital Ocean function which handles all data requests for the
+ * dashboard project.
+ */
+export default class ProjectDashboard extends DOFunction<
+  ProjectDashboardInput,
+  ProjectDashboardOutput
+> {
+  private static instance: ProjectDashboard | undefined;
+
+  private constructor() {
+    super();
+  }
+
+  static getFunction(): ProjectDashboard {
+    if (!ProjectDashboard.instance) {
+      ProjectDashboard.instance = new ProjectDashboard();
+    }
+    return ProjectDashboard.instance;
+  }
+}

package/lib/types/DashboardConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DashboardConfig.d.ts","sourceRoot":"","sources":["../../src/types/DashboardConfig.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,2BAA2B,EAAE,MAAM,CAAC;IACpC,cAAc,EAAE;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,YAAY,EAAE,MAAM,CAAC;QACrB,4BAA4B,EAAE,MAAM,CAAC;QACrC,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,CAAC"}
+{"version":3,"file":"DashboardConfig.d.ts","sourceRoot":"./src/","sources":["types/DashboardConfig.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,2BAA2B,EAAE,MAAM,CAAC;IACpC,cAAc,EAAE;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,YAAY,EAAE,MAAM,CAAC;QACrB,4BAA4B,EAAE,MAAM,CAAC;QACrC,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,CAAC"}

package/lib/types/DashboardConfig.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
+//# sourceMappingURL=DashboardConfig.js.map

package/lib/types/DashboardConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DashboardConfig.js","sourceRoot":"./src/","sources":["types/DashboardConfig.ts"],"names":[],"mappings":""}

package/lib/types/DashboardConfig.ts

@@ -0,0 +1,14 @@
+/**
+ * The config for the dashboard project that is returned to every authenticated
+ * user inside that project.
+ */
+export type DashboardConfig = {
+  projectDashboardFunctionUrl: string;
+  automationUrls: {
+    sunLight: string;
+    zoomLighting: string;
+    bedTimeButStillWatchingShows: string;
+    bedTime: string;
+    sunrise: string;
+  };
+};

package/lib/types/Translations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Translations.d.ts","sourceRoot":"","sources":["../../src/types/Translations.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC;CAC5B"}
+{"version":3,"file":"Translations.d.ts","sourceRoot":"./src/","sources":["types/Translations.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC;CAC5B"}

package/lib/types/Translations.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
+//# sourceMappingURL=Translations.js.map

package/lib/types/Translations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Translations.js","sourceRoot":"./src/","sources":["types/Translations.ts"],"names":[],"mappings":""}

package/lib/types/Translations.ts

@@ -0,0 +1,14 @@
+/**
+ * An individual translation as defined in the translations repo.
+ */
+export type Translation = {
+  value: string;
+  description: string;
+};
+
+/**
+ * A collection of translations for a given project.
+ */
+export interface Translations {
+  [key: string]: Translation;
+}

package/package.json

@@ -1,12 +1,33 @@
 {
   "name": "@aneuhold/core-ts-api-lib",
-  "version": "1.0.119",
+  "author": "Anton G. Neuhold Jr.",
+  "license": "MIT",
+  "version": "2.0.0",
   "description": "A library for interacting with the backend and defining the backend API for personal projects.",
+  "packageManager": "yarn@4.5.1",
+  "type": "module",
+  "scripts": {
+    "build": "rimraf lib && tsc --project tsconfig.build.json && tsx ./scripts/copyTsFiles.ts",
+    "lint": "eslint",
+    "test": "vitest run",
+    "jsr:validate": "tb pkg validateJsr",
+    "checkAll": "yarn build && yarn lint && yarn test && yarn jsr:validate",
+    "jsr:publish": "tb pkg publishJsr",
+    "upgrade:core": "yarn up '@aneuhold/*'",
+    "upgrade:all": "yarn up"
+  },
   "main": "lib/index.js",
+  "module": "lib/index.js",
   "types": "lib/index.d.ts",
-  "author": "Anton G Neuhold Jr <agneuhold@gmail.com>",
-  "license": "MIT",
-  "packageManager": "yarn@4.5.0",
+  "files": [
+    "lib/**/*"
+  ],
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/aneuhold/core-ts-api-lib.git"
@@ -15,26 +36,12 @@
     "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"
+    "API",
+    "Node.js",
+    "Database",
+    "TypeScript"
   ],
-  "scripts": {
-    "pushpub": "yarn build && npm version patch && git push",
-    "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 up",
-    "upgrade:core": "yarn up '@aneuhold/*'",
-    "test": "jest --passWithNoTests",
-    "lint": "yarn eslint"
-  },
   "dependencies": {
     "@aneuhold/core-ts-db-lib": "^2.0.4",
     "@aneuhold/core-ts-lib": "^2.0.6",
@@ -42,14 +49,14 @@
   },
   "devDependencies": {
     "@aneuhold/eslint-config": "^1.0.40",
-    "@types/jest": "^29.5.13",
-    "@types/node": "^20.16.10",
-    "@types/node-fetch": "^2.6.11",
+    "@aneuhold/main-scripts": "^2.0.6",
+    "@types/node": "^20.17.1",
     "eslint": "^9.13.0",
-    "jest": "^29.7.0",
+    "jsr": "^0.13.2",
     "prettier": "^3.3.3",
-    "ts-jest": "^29.2.5",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.6.2"
+    "rimraf": "^6.0.1",
+    "tsx": "^4.19.1",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.3"
   }
 }