@nu-art/ts-focused-object-shared 0.400.5

package/api-def.d.ts

@@ -0,0 +1,14 @@
+import { ApiDefResolver, BodyApi } from '@nu-art/thunderstorm-shared';
+import { FocusedEntity } from './types.js';
+export type FocusedItem_Update = {
+    request: {
+        focusedEntities: FocusedEntity[];
+    };
+    response: void;
+};
+export type ApiStruct_FocusedObject = {
+    _v1: {
+        update: BodyApi<FocusedItem_Update['response'], FocusedItem_Update['request']>;
+    };
+};
+export declare const ApiDef_FocusedObject: ApiDefResolver<ApiStruct_FocusedObject>;

package/api-def.js

@@ -0,0 +1,10 @@
+import { HttpMethod } from '@nu-art/thunderstorm-shared';
+export const ApiDef_FocusedObject = {
+    _v1: {
+        // setFocusStatusByTabId: {method: HttpMethod.POST, path: '/v1/focus-object/set-focus-status'},
+        // updateFocusData: {method: HttpMethod.POST, path: '/v1/focus-object/focus'},
+        // releaseObject: {method: HttpMethod.POST, path: '/v1/focus-object/release'},
+        // releaseByTabId: {method: HttpMethod.POST, path: '/v1/focus-object/release-tab'}, // Tab Id is sent as header, so we know what tab to release.
+        update: { method: HttpMethod.POST, path: '/v1/focus-object/update' },
+    }
+};

package/consts.d.ts

@@ -0,0 +1,2 @@
+export declare const DefaultTTL_FocusedObject: number;
+export declare const getRelationalPath: () => string;

package/consts.js

@@ -0,0 +1,3 @@
+import { Minute } from '@nu-art/ts-common';
+export const DefaultTTL_FocusedObject = 10 * Minute;
+export const getRelationalPath = () => `/state/ModuleBE_FocusedObject/focusedData/`;

package/index.d.ts

@@ -0,0 +1,3 @@
+export declare const PackageName_TsFocusedObject = "ts-focused-object";
+export * from './api-def.js';
+export * from './types.js';

package/index.js

@@ -0,0 +1,3 @@
+export const PackageName_TsFocusedObject = 'ts-focused-object';
+export * from './api-def.js';
+export * from './types.js';

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@nu-art/ts-focused-object-shared",
+  "version": "0.400.5",
+  "description": "ts-focused-object - Express & Typescript based backend framework Shared",
+  "keywords": [
+    "TacB0sS",
+    "infra",
+    "nu-art",
+    "thunderstorm",
+    "typescript",
+    "ts-focused-object"
+  ],
+  "homepage": "https://github.com/nu-art-js/thunderstorm",
+  "bugs": {
+    "url": "https://github.com/nu-art-js/thunderstorm/issues"
+  },
+  "publishConfig": {
+    "directory": "dist",
+    "linkDirectory": true
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com:nu-art-js/thunderstorm.git"
+  },
+  "license": "Apache-2.0",
+  "author": "TacB0sS",
+  "files": [
+    "**/*"
+  ],
+  "scripts": {
+    "build": "tsc"
+  },
+  "dependencies": {
+    "@nu-art/ts-common": "0.400.5",
+    "@nu-art/thunderstorm-shared": "0.400.5",
+    "@nu-art/firebase-shared": "0.400.5",
+    "@nu-art/user-account-shared": "0.400.5",
+    "firebase": "^11.9.0",
+    "firebase-admin": "13.4.0",
+    "firebase-functions": "6.3.2",
+    "react": "^18.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.0.0",
+    "@types/chai": "^4.3.4",
+    "@types/mocha": "^10.0.1"
+  },
+  "unitConfig": {
+    "type": "typescript-lib"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js"
+    },
+    "./*": {
+      "types": "./*.d.ts",
+      "import": "./*.js"
+    }
+  }
+}

package/types.d.ts

@@ -0,0 +1,21 @@
+import { TypedMap, UniqueId } from '@nu-art/ts-common';
+type TabId_Map<T> = TypedMap<T>;
+type DeviceId_Map<T> = TypedMap<T>;
+type AccountId_Map<T> = TypedMap<T>;
+type ItemId_Map<T> = TypedMap<T>;
+type DbName_Map<T> = TypedMap<T>;
+/**
+ * First layer is dbKey.<br>
+ * Then _id of an item in the collection.<br>
+ * Then _id of the user-account.<br>
+ * Then the id of the device, as we can have multiple devices for each account.<br>
+ * Then the id of the tab, as we can have multiple tabs across each device.<br>
+ * And only then the actual data, which is a timestamp (number)<br>
+ * <p>===<p><b>dbName / objectId / accountId / deviceId / tabId / timestamp
+ */
+export type FocusData_Map = DbName_Map<ItemId_Map<AccountId_Map<DeviceId_Map<TabId_Map<number>>>>>;
+export type FocusedEntity = {
+    dbKey: string;
+    itemId: UniqueId;
+};
+export {};

package/types.js

@@ -0,0 +1 @@
+export {};