@soulcraft/brainy 3.13.0 → 3.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -37,7 +37,29 @@ import type { BrainyAugmentation as BA, BaseAugmentation as BaseA, AugmentationC
37
37
  export type BrainyAugmentation = BA;
38
38
  export type BaseAugmentation = BaseA;
39
39
  export type AugmentationContext = AC;
40
+ /**
41
+ * @deprecated Use BrainyAugmentation from '../augmentations/brainyAugmentation.js' instead
42
+ *
43
+ * @example
44
+ * // ❌ Old way (v2.x):
45
+ * import { IAugmentation } from '@soulcraft/brainy/types/augmentations'
46
+ *
47
+ * // ✅ New way (v3.x):
48
+ * import { BrainyAugmentation } from '@soulcraft/brainy'
49
+ */
40
50
  export type IAugmentation = BrainyAugmentation;
51
+ /**
52
+ * @deprecated Augmentation types are now unified under BrainyAugmentation interface
53
+ *
54
+ * @example
55
+ * // ❌ Old way (v2.x):
56
+ * import { AugmentationType } from '@soulcraft/brainy/types/augmentations'
57
+ * if (augmentation.type === AugmentationType.SENSE) { ... }
58
+ *
59
+ * // ✅ New way (v3.x):
60
+ * import { BrainyAugmentation } from '@soulcraft/brainy'
61
+ * // Use the unified BrainyAugmentation interface directly
62
+ */
41
63
  export declare enum AugmentationType {
42
64
  SENSE = "sense",
43
65
  CONDUIT = "conduit",
@@ -49,23 +71,139 @@ export declare enum AugmentationType {
49
71
  WEBSOCKET = "webSocket",
50
72
  SYNAPSE = "synapse"
51
73
  }
74
+ /**
75
+ * @deprecated Use BrainyAugmentation interface directly instead of namespace types
76
+ *
77
+ * @example
78
+ * // ❌ Old way (v2.x):
79
+ * import { BrainyAugmentations } from '@soulcraft/brainy/types/augmentations'
80
+ * class MyAugmentation implements BrainyAugmentations.ISenseAugmentation { ... }
81
+ *
82
+ * // ✅ New way (v3.x):
83
+ * import { BrainyAugmentation } from '@soulcraft/brainy'
84
+ * class MyAugmentation implements BrainyAugmentation { ... }
85
+ */
52
86
  export declare namespace BrainyAugmentations {
87
+ /** @deprecated Use BrainyAugmentation instead */
53
88
  type ISenseAugmentation = BrainyAugmentation;
89
+ /** @deprecated Use BrainyAugmentation instead */
54
90
  type IConduitAugmentation = BrainyAugmentation;
91
+ /** @deprecated Use BrainyAugmentation instead */
55
92
  type ICognitionAugmentation = BrainyAugmentation;
93
+ /** @deprecated Use BrainyAugmentation instead */
56
94
  type IMemoryAugmentation = BrainyAugmentation;
95
+ /** @deprecated Use BrainyAugmentation instead */
57
96
  type IPerceptionAugmentation = BrainyAugmentation;
97
+ /** @deprecated Use BrainyAugmentation instead */
58
98
  type IDialogAugmentation = BrainyAugmentation;
99
+ /** @deprecated Use BrainyAugmentation instead */
59
100
  type IActivationAugmentation = BrainyAugmentation;
101
+ /** @deprecated Use BrainyAugmentation instead */
60
102
  type ISynapseAugmentation = BrainyAugmentation;
61
103
  }
104
+ /**
105
+ * @deprecated Use BrainyAugmentation from '../augmentations/brainyAugmentation.js' instead
106
+ *
107
+ * @example
108
+ * // ❌ Old way (v2.x):
109
+ * import { ISenseAugmentation } from '@soulcraft/brainy/types/augmentations'
110
+ * class MySense implements ISenseAugmentation { ... }
111
+ *
112
+ * // ✅ New way (v3.x):
113
+ * import { BrainyAugmentation } from '@soulcraft/brainy'
114
+ * class MySense implements BrainyAugmentation { ... }
115
+ */
62
116
  export type ISenseAugmentation = BrainyAugmentation;
117
+ /**
118
+ * @deprecated Use BrainyAugmentation from '../augmentations/brainyAugmentation.js' instead
119
+ *
120
+ * @example
121
+ * // ❌ Old way (v2.x):
122
+ * import { IConduitAugmentation } from '@soulcraft/brainy/types/augmentations'
123
+ *
124
+ * // ✅ New way (v3.x):
125
+ * import { BrainyAugmentation } from '@soulcraft/brainy'
126
+ */
63
127
  export type IConduitAugmentation = BrainyAugmentation;
128
+ /**
129
+ * @deprecated Use BrainyAugmentation from '../augmentations/brainyAugmentation.js' instead
130
+ *
131
+ * @example
132
+ * // ❌ Old way (v2.x):
133
+ * import { ICognitionAugmentation } from '@soulcraft/brainy/types/augmentations'
134
+ *
135
+ * // ✅ New way (v3.x):
136
+ * import { BrainyAugmentation } from '@soulcraft/brainy'
137
+ */
64
138
  export type ICognitionAugmentation = BrainyAugmentation;
139
+ /**
140
+ * @deprecated Use BrainyAugmentation from '../augmentations/brainyAugmentation.js' instead
141
+ *
142
+ * @example
143
+ * // ❌ Old way (v2.x):
144
+ * import { IMemoryAugmentation } from '@soulcraft/brainy/types/augmentations'
145
+ *
146
+ * // ✅ New way (v3.x):
147
+ * import { BrainyAugmentation } from '@soulcraft/brainy'
148
+ */
65
149
  export type IMemoryAugmentation = BrainyAugmentation;
150
+ /**
151
+ * @deprecated Use BrainyAugmentation from '../augmentations/brainyAugmentation.js' instead
152
+ *
153
+ * @example
154
+ * // ❌ Old way (v2.x):
155
+ * import { IPerceptionAugmentation } from '@soulcraft/brainy/types/augmentations'
156
+ *
157
+ * // ✅ New way (v3.x):
158
+ * import { BrainyAugmentation } from '@soulcraft/brainy'
159
+ */
66
160
  export type IPerceptionAugmentation = BrainyAugmentation;
161
+ /**
162
+ * @deprecated Use BrainyAugmentation from '../augmentations/brainyAugmentation.js' instead
163
+ *
164
+ * @example
165
+ * // ❌ Old way (v2.x):
166
+ * import { IDialogAugmentation } from '@soulcraft/brainy/types/augmentations'
167
+ *
168
+ * // ✅ New way (v3.x):
169
+ * import { BrainyAugmentation } from '@soulcraft/brainy'
170
+ */
67
171
  export type IDialogAugmentation = BrainyAugmentation;
172
+ /**
173
+ * @deprecated Use BrainyAugmentation from '../augmentations/brainyAugmentation.js' instead
174
+ *
175
+ * @example
176
+ * // ❌ Old way (v2.x):
177
+ * import { IActivationAugmentation } from '@soulcraft/brainy/types/augmentations'
178
+ *
179
+ * // ✅ New way (v3.x):
180
+ * import { BrainyAugmentation } from '@soulcraft/brainy'
181
+ */
68
182
  export type IActivationAugmentation = BrainyAugmentation;
183
+ /**
184
+ * @deprecated Use BrainyAugmentation from '../augmentations/brainyAugmentation.js' instead
185
+ *
186
+ * @example
187
+ * // ❌ Old way (v2.x):
188
+ * import { ISynapseAugmentation } from '@soulcraft/brainy/types/augmentations'
189
+ *
190
+ * // ✅ New way (v3.x):
191
+ * import { BrainyAugmentation } from '@soulcraft/brainy'
192
+ */
69
193
  export type ISynapseAugmentation = BrainyAugmentation;
194
+ /**
195
+ * @deprecated WebSocket support is now built into BrainyAugmentation interface
196
+ *
197
+ * @example
198
+ * // ❌ Old way (v2.x):
199
+ * import { IWebSocketSupport } from '@soulcraft/brainy/types/augmentations'
200
+ * class MyAugmentation implements IWebSocketSupport { ... }
201
+ *
202
+ * // ✅ New way (v3.x):
203
+ * import { BrainyAugmentation } from '@soulcraft/brainy'
204
+ * class MyAugmentation implements BrainyAugmentation {
205
+ * // WebSocket functionality is now part of the unified interface
206
+ * }
207
+ */
70
208
  export interface IWebSocketSupport {
71
209
  }
@@ -4,6 +4,18 @@
4
4
  * This file contains only the minimal types needed for augmentations.
5
5
  * The main augmentation interfaces are now in augmentations/brainyAugmentation.ts
6
6
  */
7
+ /**
8
+ * @deprecated Augmentation types are now unified under BrainyAugmentation interface
9
+ *
10
+ * @example
11
+ * // ❌ Old way (v2.x):
12
+ * import { AugmentationType } from '@soulcraft/brainy/types/augmentations'
13
+ * if (augmentation.type === AugmentationType.SENSE) { ... }
14
+ *
15
+ * // ✅ New way (v3.x):
16
+ * import { BrainyAugmentation } from '@soulcraft/brainy'
17
+ * // Use the unified BrainyAugmentation interface directly
18
+ */
7
19
  export var AugmentationType;
8
20
  (function (AugmentationType) {
9
21
  AugmentationType["SENSE"] = "sense";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@soulcraft/brainy",
3
- "version": "3.13.0",
3
+ "version": "3.14.0",
4
4
  "description": "Universal Knowledge Protocol™ - World's first Triple Intelligence database unifying vector, graph, and document search in one API. 31 nouns × 40 verbs for infinite expressiveness.",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.js",