@nu-art/ts-messaging-shared 0.401.8 → 0.500.0

package/index.d.ts

@@ -1,2 +1,3 @@
+export { CrudApiDef, type ApiCallerEventType } from '@nu-art/db-api-shared';
 export * from './message/index.js';
 export * from './topic/index.js';

package/index.js

@@ -1,2 +1,3 @@
+export { CrudApiDef } from '@nu-art/db-api-shared';
 export * from './message/index.js';
 export * from './topic/index.js';

package/message/db-def.d.ts

@@ -1,15 +1,8 @@
-import { DBDef_V3 } from '@nu-art/ts-common';
-import { DB_Message_Image, DB_Message_Text, DB_Message_Video, DBProto_Message, UI_Message } from './types.js';
-/**
- * Utility object containing type guard methods for different message types
- */
+import { Database } from '@nu-art/db-api-shared';
+import { DB_Message_Image, DB_Message_Text, DB_Message_Video, DatabaseDef_Message, UI_Message } from './types.js';
 export declare const MessageTools: {
     isText: (instance: UI_Message) => instance is DB_Message_Text;
     isImage: (instance: UI_Message) => instance is DB_Message_Image;
     isVideo: (instance: UI_Message) => instance is DB_Message_Video;
 };
-/**
- * Database definition for messages
- * Includes validation rules, versioning, and database configuration
- */
-export declare const DBDef_message: DBDef_V3<DBProto_Message>;
+export declare const DBDef_message: Database<DatabaseDef_Message>;

package/message/db-def.js

@@ -1,29 +1,14 @@
 import { deleteKeysObject, exists, removeDBObjectKeys, tsValidate, tsValidateString, tsValidateUniqueId, tsValidateValue } from '@nu-art/ts-common';
 import { MessageType_Image, MessageType_Text, MessageType_Video } from './types.js';
 import { MessagingDBGroup } from '../consts.js';
-/**
- * Utility object containing type guard methods for different message types
- */
 export const MessageTools = {
-    isText: (instance) => {
-        return instance.type === 'text';
-    },
-    isImage: (instance) => {
-        return instance.type === 'image';
-    },
-    isVideo: (instance) => {
-        return instance.type === 'video';
-    }
+    isText: (instance) => instance.type === 'text',
+    isImage: (instance) => instance.type === 'image',
+    isVideo: (instance) => instance.type === 'video',
 };
-/**
- * Validator for automatically generated message properties
- */
-const Validator_GeneratedProps_Text = {
+const Validator_GeneratedProps_Message = {
     _auditorId: tsValidateUniqueId,
 };
-/**
- * Base validator for common message properties
- */
 const Validator_BaseMessage = {
     topicId: tsValidateUniqueId,
 };
@@ -41,12 +26,6 @@ const Validator_DB_Message_Text = {
     type: tsValidateValue([MessageType_Text]),
     text: tsValidateString(),
 };
-/**
- * Validates modifiable properties of a message based on its type
- *
- * @param instance - The message instance to validate
- * @returns Validation result or error message
- */
 const Validator_ModifiableProps_Message = (instance) => {
     if (!exists(instance))
         return 'No object received';
@@ -59,25 +38,22 @@ const Validator_ModifiableProps_Message = (instance) => {
         case MessageType_Video:
             return tsValidate(__toValidate, Validator_DB_Message_Video);
         default:
-            // @ts-ignore
-            return `Could not find message type('${instance.type}') when attempting to validate a message!`;
+            return `Could not find message type('${instance?.type}') when attempting to validate a message!`;
     }
 };
-/**
- * Database definition for messages
- * Includes validation rules, versioning, and database configuration
- */
 export const DBDef_message = {
+    dbKey: 'messages',
+    entityName: 'Message',
     modifiablePropsValidator: Validator_ModifiableProps_Message,
-    generatedPropsValidator: Validator_GeneratedProps_Text,
+    generatedPropsValidator: Validator_GeneratedProps_Message,
+    generatedProps: ['_auditorId'],
     versions: ['1.0.0'],
-    dbKey: 'messages',
+    uniqueKeys: ['_id'],
     frontend: {
         group: MessagingDBGroup,
         name: 'message',
     },
     backend: {
-        name: 'messages'
+        name: 'messages',
     },
-    entityName: 'Message',
 };

package/message/types.d.ts

@@ -1,31 +1,20 @@
 /**
- * @fileoverview Defines the types and interfaces for the messaging system.
- * This includes message types, database schemas, and UI representations.
- */
-import { AuditableV2, DB_Object, DBProto, Proto_DB_Object, UniqueId, VersionsDeclaration } from '@nu-art/ts-common';
-/**
- * Version declaration for message types
- * Currently supports version 1.0.0
+ * Types and interfaces for the messaging system: message types, DB schemas, UI representations.
  */
+import { DB_Object, DB_ProtoSeed, DB_Prototype, VersionsDeclaration } from '@nu-art/db-api-shared';
+export declare const Message_DbKey = "messages";
+type DBKey = typeof Message_DbKey;
 type VersionTypes_Message = {
     '1.0.0': DB_Message;
 };
 type Versions = VersionsDeclaration<['1.0.0'], VersionTypes_Message>;
-type Dependencies = {};
 type UniqueKeys = '_id';
-type GeneratedProps = '_auditorId';
-type Proto = Proto_DB_Object<DB_Message, 'messages', GeneratedProps, Versions, UniqueKeys, Dependencies>;
-/** Constant representing a text message type */
+type GeneratedKeys = '_auditorId';
+type Dependencies = {};
+type Proto = DB_ProtoSeed<DB_Message, DBKey, GeneratedKeys, Versions, UniqueKeys, Dependencies>;
 export declare const MessageType_Text: "text";
-/** Constant representing an image message type */
 export declare const MessageType_Image: "image";
-/** Constant representing a video message type */
 export declare const MessageType_Video: "video";
-export type DBProto_Message = DBProto<Proto>;
-export type UI_Message = DBProto_Message['uiType'];
-/**
- * Mapping of message types to their respective data structures
- */
 export type MessageTypes_DataMap = {
     text: {
         text: string;
@@ -33,33 +22,27 @@ export type MessageTypes_DataMap = {
     image: {
         url: string;
     };
-    video: {};
+    video: Record<string, never>;
 };
-/** Union type of all possible message types */
 export type MessageType = keyof MessageTypes_DataMap;
-/**
- * Base interface for all message types
- * @property topicId - Unique identifier for the topic this message belongs to
- */
 export type BaseMessage = {
-    topicId: UniqueId;
+    topicId: string;
 };
-/** Database representation of a text message */
 export type DB_Message_Text = BaseMessage & {
     type: typeof MessageType_Text;
     text: string;
 };
-/** Database representation of an image message */
 export type DB_Message_Image = BaseMessage & {
     type: typeof MessageType_Image;
     url: string;
 };
-/** Database representation of a video message */
 export type DB_Message_Video = BaseMessage & {
     type: typeof MessageType_Video;
 };
-/** Union type of all possible message content types */
 export type MessageContent = DB_Message_Text | DB_Message_Image | DB_Message_Video;
-/** Complete database message type including base DB object properties and audit information */
-export type DB_Message = DB_Object & AuditableV2 & MessageContent;
+export type DB_Message = DB_Object<DBKey> & {
+    _auditorId?: string;
+} & MessageContent;
+export type DatabaseDef_Message = DB_Prototype<Proto>;
+export type UI_Message = DatabaseDef_Message['uiType'];
 export {};

package/message/types.js

@@ -1,10 +1,7 @@
 /**
- * @fileoverview Defines the types and interfaces for the messaging system.
- * This includes message types, database schemas, and UI representations.
+ * Types and interfaces for the messaging system: message types, DB schemas, UI representations.
  */
-/** Constant representing a text message type */
+export const Message_DbKey = 'messages';
 export const MessageType_Text = 'text';
-/** Constant representing an image message type */
 export const MessageType_Image = 'image';
-/** Constant representing a video message type */
 export const MessageType_Video = 'video';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nu-art/ts-messaging-shared",
-  "version": "0.401.8",
+  "version": "0.500.0",
   "description": "A messaging module for Thunderstorm framework that provides topic-based messaging system with support for different message types (text, image, video) and discussion management features",
   "keywords": [
     "TacB0sS",
@@ -31,8 +31,8 @@
     "build": "tsc"
   },
   "dependencies": {
-    "@nu-art/ts-common": "0.401.8",
-    "@nu-art/thunderstorm-shared": "0.401.8",
+    "@nu-art/ts-common": "0.500.0",
+    "@nu-art/db-api-shared": "0.500.0",
     "react": "^18.0.0"
   },
   "devDependencies": {

package/topic/db-def.d.ts

@@ -1,7 +1,7 @@
-import { DBDef_V3 } from '@nu-art/ts-common';
-import { DBProto_Topic } from './types.js';
+import { Database } from '@nu-art/db-api-shared';
+import { DatabaseDef_Topic } from './types.js';
 export declare const Validator_GeneratedProps_Topic: {
     type: import("@nu-art/ts-common").Validator<string>;
     refId: import("@nu-art/ts-common").Validator<string>;
 };
-export declare const DBDef_Topic: DBDef_V3<DBProto_Topic>;
+export declare const DBDef_Topic: Database<DatabaseDef_Topic>;

package/topic/db-def.js

@@ -6,16 +6,18 @@ export const Validator_GeneratedProps_Topic = {
     refId: tsValidateUniqueId,
 };
 export const DBDef_Topic = {
+    dbKey: 'topics',
+    entityName: 'Topic',
     modifiablePropsValidator: Validator_ModifiableProps,
     generatedPropsValidator: Validator_GeneratedProps_Topic,
+    generatedProps: ['refId', 'type'],
     versions: ['1.0.0'],
-    dbKey: 'topics',
-    entityName: 'Topic',
+    uniqueKeys: ['_id'],
     frontend: {
         group: MessagingDBGroup,
         name: 'topic',
     },
     backend: {
         name: 'topics',
-    }
+    },
 };

package/topic/types.d.ts

@@ -1,16 +1,18 @@
-import { DB_Object, DBProto, Proto_DB_Object, VersionsDeclaration } from '@nu-art/ts-common';
+import { DB_Object, DB_ProtoSeed, DB_Prototype, VersionsDeclaration } from '@nu-art/db-api-shared';
+export declare const Topic_DbKey = "topics";
+type DBKey = typeof Topic_DbKey;
 type VersionTypes_Topic = {
     '1.0.0': DB_Topic;
 };
 type Versions = VersionsDeclaration<['1.0.0'], VersionTypes_Topic>;
-type Dependencies = {};
 type UniqueKeys = '_id';
-type GeneratedProps = 'type' | 'refId';
-type Proto = Proto_DB_Object<DB_Topic, 'topics', GeneratedProps, Versions, UniqueKeys, Dependencies>;
-export type DBProto_Topic = DBProto<Proto>;
-export type UI_Topic = DBProto_Topic['uiType'];
-export type DB_Topic = DB_Object & {
+type GeneratedKeys = 'type' | 'refId';
+type Dependencies = {};
+type Proto = DB_ProtoSeed<DB_Topic, DBKey, GeneratedKeys, Versions, UniqueKeys, Dependencies>;
+export type DB_Topic = DB_Object<DBKey> & {
     type: string;
     refId: string;
 };
+export type DatabaseDef_Topic = DB_Prototype<Proto>;
+export type UI_Topic = DatabaseDef_Topic['uiType'];
 export {};

package/topic/types.js

@@ -1 +1 @@
-export {};
+export const Topic_DbKey = 'topics';