@stonyx/orm 0.3.2-beta.7 → 0.3.2-beta.70

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.
@@ -0,0 +1,188 @@
1
+ /**
2
+ * DynamoDB operation parameter builders.
3
+ *
4
+ * Each function returns a plain-object "params" bag that can be passed
5
+ * directly to the corresponding DocumentClient command
6
+ * (PutCommand, GetCommand, UpdateCommand, DeleteCommand, ScanCommand, QueryCommand).
7
+ *
8
+ * All functions are pure — no SDK imports here; the caller wraps params
9
+ * in the appropriate Command class.
10
+ */
11
+
12
+ export interface PutItemParams {
13
+ TableName: string;
14
+ Item: Record<string, unknown>;
15
+ ConditionExpression?: string;
16
+ }
17
+
18
+ export interface GetItemParams {
19
+ TableName: string;
20
+ Key: Record<string, unknown>;
21
+ }
22
+
23
+ export interface UpdateItemParams {
24
+ TableName: string;
25
+ Key: Record<string, unknown>;
26
+ UpdateExpression: string;
27
+ ExpressionAttributeNames: Record<string, string>;
28
+ ExpressionAttributeValues: Record<string, unknown>;
29
+ ReturnValues: string;
30
+ }
31
+
32
+ export interface DeleteItemParams {
33
+ TableName: string;
34
+ Key: Record<string, unknown>;
35
+ }
36
+
37
+ export interface ScanParams {
38
+ TableName: string;
39
+ FilterExpression?: string;
40
+ ExpressionAttributeNames?: Record<string, string>;
41
+ ExpressionAttributeValues?: Record<string, unknown>;
42
+ ExclusiveStartKey?: Record<string, unknown>;
43
+ }
44
+
45
+ export interface QueryParams {
46
+ TableName: string;
47
+ IndexName: string;
48
+ KeyConditionExpression: string;
49
+ ExpressionAttributeNames: Record<string, string>;
50
+ ExpressionAttributeValues: Record<string, unknown>;
51
+ ExclusiveStartKey?: Record<string, unknown>;
52
+ }
53
+
54
+ /**
55
+ * PutItem — optionally with a condition expression.
56
+ *
57
+ * Pass conditionExpression = 'attribute_not_exists(id)' to enforce uniqueness.
58
+ */
59
+ export function buildPutItem(
60
+ tableName: string,
61
+ item: Record<string, unknown>,
62
+ conditionExpression?: string,
63
+ ): PutItemParams {
64
+ const params: PutItemParams = { TableName: tableName, Item: item };
65
+ if (conditionExpression) params.ConditionExpression = conditionExpression;
66
+ return params;
67
+ }
68
+
69
+ /**
70
+ * GetItem by primary key.
71
+ */
72
+ export function buildGetItem(
73
+ tableName: string,
74
+ key: Record<string, unknown>,
75
+ ): GetItemParams {
76
+ return { TableName: tableName, Key: key };
77
+ }
78
+
79
+ /**
80
+ * UpdateItem with a SET expression built from the `updates` object.
81
+ * Only the supplied attributes are updated (diff-based call site).
82
+ */
83
+ export function buildUpdateItem(
84
+ tableName: string,
85
+ key: Record<string, unknown>,
86
+ updates: Record<string, unknown>,
87
+ ): UpdateItemParams {
88
+ const names: Record<string, string> = {};
89
+ const values: Record<string, unknown> = {};
90
+ const setClauses: string[] = [];
91
+
92
+ for (const [attr, val] of Object.entries(updates)) {
93
+ const nameAlias = `#${attr}`;
94
+ const valAlias = `:${attr}`;
95
+ names[nameAlias] = attr;
96
+ values[valAlias] = val;
97
+ setClauses.push(`${nameAlias} = ${valAlias}`);
98
+ }
99
+
100
+ return {
101
+ TableName: tableName,
102
+ Key: key,
103
+ UpdateExpression: `SET ${setClauses.join(', ')}`,
104
+ ExpressionAttributeNames: names,
105
+ ExpressionAttributeValues: values,
106
+ ReturnValues: 'NONE',
107
+ };
108
+ }
109
+
110
+ /**
111
+ * DeleteItem by primary key.
112
+ */
113
+ export function buildDeleteItem(
114
+ tableName: string,
115
+ key: Record<string, unknown>,
116
+ ): DeleteItemParams {
117
+ return { TableName: tableName, Key: key };
118
+ }
119
+
120
+ /**
121
+ * ScanCommand params.
122
+ * If conditions are supplied they are rendered as a FilterExpression using AND.
123
+ */
124
+ export function buildScan(
125
+ tableName: string,
126
+ conditions?: Record<string, unknown>,
127
+ exclusiveStartKey?: Record<string, unknown>,
128
+ ): ScanParams {
129
+ const params: ScanParams = { TableName: tableName };
130
+
131
+ if (exclusiveStartKey) params.ExclusiveStartKey = exclusiveStartKey;
132
+
133
+ if (conditions && Object.keys(conditions).length > 0) {
134
+ const names: Record<string, string> = {};
135
+ const values: Record<string, unknown> = {};
136
+ const clauses: string[] = [];
137
+
138
+ for (const [attr, val] of Object.entries(conditions)) {
139
+ const nameAlias = `#${attr}`;
140
+ const valAlias = `:${attr}`;
141
+ names[nameAlias] = attr;
142
+ values[valAlias] = val;
143
+ clauses.push(`${nameAlias} = ${valAlias}`);
144
+ }
145
+
146
+ params.FilterExpression = clauses.join(' AND ');
147
+ params.ExpressionAttributeNames = names;
148
+ params.ExpressionAttributeValues = values;
149
+ }
150
+
151
+ return params;
152
+ }
153
+
154
+ /**
155
+ * QueryCommand params for a GSI.
156
+ * keyConditions must be in the form { attrName: value } and will be rendered
157
+ * as equality expressions joined by AND.
158
+ */
159
+ export function buildQuery(
160
+ tableName: string,
161
+ indexName: string,
162
+ keyConditions: Record<string, unknown>,
163
+ exclusiveStartKey?: Record<string, unknown>,
164
+ ): QueryParams {
165
+ const names: Record<string, string> = {};
166
+ const values: Record<string, unknown> = {};
167
+ const clauses: string[] = [];
168
+
169
+ for (const [attr, val] of Object.entries(keyConditions)) {
170
+ const nameAlias = `#${attr}`;
171
+ const valAlias = `:${attr}`;
172
+ names[nameAlias] = attr;
173
+ values[valAlias] = val;
174
+ clauses.push(`${nameAlias} = ${valAlias}`);
175
+ }
176
+
177
+ const params: QueryParams = {
178
+ TableName: tableName,
179
+ IndexName: indexName,
180
+ KeyConditionExpression: clauses.join(' AND '),
181
+ ExpressionAttributeNames: names,
182
+ ExpressionAttributeValues: values,
183
+ };
184
+
185
+ if (exclusiveStartKey) params.ExclusiveStartKey = exclusiveStartKey;
186
+
187
+ return params;
188
+ }
@@ -0,0 +1,54 @@
1
+ /**
2
+ * Maps ORM attribute types to DynamoDB scalar attribute types.
3
+ * DynamoDB DocumentClient auto-marshalls JS objects, so most values
4
+ * are sent as their native JS types. This map is used by the
5
+ * schema-introspector and startup provisioner for table/GSI creation.
6
+ */
7
+
8
+ export type DynamoScalarType = 'S' | 'N' | 'BOOL';
9
+
10
+ /**
11
+ * DynamoDB attribute-type string for a given ORM attr type.
12
+ * - string → S
13
+ * - number / float → N (stored as Number; DocumentClient handles it)
14
+ * - boolean → BOOL
15
+ * - date → S (ISO-8601 string — enables range queries)
16
+ * - timestamp → N (milliseconds since epoch)
17
+ * - passthrough/trim/etc → S (safe default)
18
+ *
19
+ * For key schema declarations only `S` and `N` are valid; BOOL
20
+ * is legal for attributes but never for a PK/SK.
21
+ */
22
+ const typeMap: Record<string, DynamoScalarType> = {
23
+ string: 'S',
24
+ number: 'N',
25
+ float: 'N',
26
+ boolean: 'BOOL',
27
+ date: 'S',
28
+ timestamp: 'N',
29
+ passthrough: 'S',
30
+ trim: 'S',
31
+ uppercase: 'S',
32
+ ceil: 'N',
33
+ floor: 'N',
34
+ round: 'N',
35
+ };
36
+
37
+ /**
38
+ * Returns the DynamoDB attribute type for a given ORM type string.
39
+ * Defaults to 'S' for any unknown/custom type.
40
+ */
41
+ export function getDynamoType(attrType: string): DynamoScalarType {
42
+ return typeMap[attrType] ?? 'S';
43
+ }
44
+
45
+ /**
46
+ * Returns the DynamoDB key type ('S' | 'N') for use in KeySchema.
47
+ * BOOL cannot be a key attribute; anything that maps to BOOL falls back to 'S'.
48
+ */
49
+ export function getDynamoKeyType(attrType: string): 'S' | 'N' {
50
+ const t = getDynamoType(attrType);
51
+ return t === 'N' ? 'N' : 'S';
52
+ }
53
+
54
+ export default typeMap;
package/src/index.ts CHANGED
@@ -26,6 +26,7 @@ import { count, avg, sum, min, max } from './aggregates.js';
26
26
 
27
27
  export { default } from './main.js';
28
28
  export { store, relationships } from './main.js';
29
+ export type { PersistErrorDetail } from './main.js';
29
30
  export { Model, View, Serializer }; // base classes
30
31
  export { attr, belongsTo, hasMany, createRecord, updateRecord }; // helpers
31
32
  export { count, avg, sum, min, max }; // aggregate helpers
package/src/main.ts CHANGED
@@ -49,6 +49,13 @@ const defaultOptions: OrmOptions = {
49
49
  dbType: 'json'
50
50
  }
51
51
 
52
+ export interface PersistErrorDetail {
53
+ operation: 'create' | 'update' | 'delete';
54
+ modelName: string;
55
+ recordId: unknown;
56
+ error: Error;
57
+ }
58
+
52
59
  export default class Orm {
53
60
  static initialized: boolean = false;
54
61
  static relationships: Map<string, Map<string, unknown>> = new Map();
@@ -65,6 +72,8 @@ export default class Orm {
65
72
  sqlDb?: SqlDb;
66
73
  db?: OrmDB | SqlDb;
67
74
 
75
+ private _persistErrorHandler: ((detail: PersistErrorDetail) => void) | null = null;
76
+
68
77
  constructor(options: OrmOptions = {}) {
69
78
  if (Orm.instance) return Orm.instance;
70
79
 
@@ -81,6 +90,11 @@ export default class Orm {
81
90
  }
82
91
 
83
92
  async init(): Promise<void> {
93
+ // Self-register so log.db works even when @stonyx/orm is in the
94
+ // consumer's `dependencies` (stonyx loader only merges devDependencies).
95
+ const { logColor = 'white', logMethod = 'db' } = config.orm;
96
+ log.defineType(logMethod, logColor);
97
+
84
98
  const { paths, restServer } = config.orm;
85
99
 
86
100
  const promises: Promise<unknown>[] = ['Model', 'Serializer', 'Transform'].map(type => {
@@ -150,6 +164,11 @@ export default class Orm {
150
164
  this.sqlDb = new MysqlDB() as SqlDb;
151
165
  this.db = this.sqlDb;
152
166
  promises.push(this.sqlDb.init());
167
+ } else if (config.orm.dynamodb) {
168
+ const { default: DynamoDBDB } = await import('./dynamodb/dynamodb-db.js');
169
+ this.sqlDb = new DynamoDBDB() as SqlDb;
170
+ this.db = this.sqlDb;
171
+ promises.push(this.sqlDb.init());
153
172
  } else if (this.options.dbType !== 'none') {
154
173
  const db = new DB();
155
174
  this.db = db;
@@ -214,6 +233,32 @@ export default class Orm {
214
233
  return !!this.views[`${modelClassPrefix}View`];
215
234
  }
216
235
 
236
+ /**
237
+ * Register a callback to be invoked when a fire-and-forget SQL persist fails.
238
+ * Without a handler, persist errors are logged via log.error (backwards-compatible).
239
+ */
240
+ onPersistError(handler: ((detail: PersistErrorDetail) => void) | null): void {
241
+ this._persistErrorHandler = handler;
242
+ }
243
+
244
+ /**
245
+ * Emit a persist error to the registered handler, or fall back to log.error.
246
+ */
247
+ emitPersistError(detail: PersistErrorDetail): void {
248
+ const fallbackLog = () => log.error?.(`[ORM] Failed to persist ${detail.operation} for ${detail.modelName}:${String(detail.recordId)}: ${detail.error.message}`);
249
+
250
+ if (this._persistErrorHandler) {
251
+ try {
252
+ this._persistErrorHandler(detail);
253
+ } catch (handlerError) {
254
+ fallbackLog();
255
+ log.error?.(`[ORM] onPersistError handler threw: ${handlerError instanceof Error ? handlerError.message : String(handlerError)}`);
256
+ }
257
+ } else {
258
+ fallbackLog();
259
+ }
260
+ }
261
+
217
262
  // Queue warnings to avoid the same error from being logged in the same iteration
218
263
  warn(message: string): void {
219
264
  this.warnings.add(message);
@@ -3,7 +3,6 @@ import OrmRecord from './record.js';
3
3
  import { getGlobalRegistry, getPendingRegistry, getPendingBelongsToRegistry, getBelongsToRegistry, getHasManyRegistry } from './relationships.js';
4
4
  import type Serializer from './serializer.js';
5
5
  import { isOrmRecord } from './utils.js';
6
- import log from 'stonyx/log';
7
6
 
8
7
  interface CreateRecordOptions {
9
8
  isDbRecord?: boolean;
@@ -80,6 +79,28 @@ export function createRecord(modelName: string, rawData: { [key: string]: unknow
80
79
  pendingHasMany.splice(0);
81
80
  }
82
81
 
82
+ // FK-based inverse hasMany wiring — when a child record is created with a
83
+ // foreign-key field (e.g. `owner: 'owner-1'` on an animal), find any parent
84
+ // whose hasMany registry targets this model and push the child into the
85
+ // parent's shared array. This covers edge cases where the child is created
86
+ // in a separate async frame without a belongsTo handler firing.
87
+ const hasManyReg = getHasManyRegistry();
88
+ if (hasManyReg) {
89
+ for (const [parentModelName, targetMap] of hasManyReg) {
90
+ const childArrayMap = targetMap.get(modelName);
91
+ if (!childArrayMap) continue;
92
+
93
+ // Check if rawData contains a FK field matching the parent model name
94
+ const fkValue = rawData[parentModelName];
95
+ if (fkValue === undefined || fkValue === null) continue;
96
+
97
+ const parentArray = childArrayMap.get(fkValue);
98
+ if (parentArray && !parentArray.includes(record)) {
99
+ parentArray.push(record);
100
+ }
101
+ }
102
+ }
103
+
83
104
  // Fulfill pending belongsTo relationships
84
105
  const pendingBelongsToQueue = getPendingBelongsToRegistry();
85
106
  const pendingBelongsToRaw = pendingBelongsToQueue.get(modelName)?.get(record.id);
@@ -87,7 +108,7 @@ export function createRecord(modelName: string, rawData: { [key: string]: unknow
87
108
 
88
109
  if (pendingBelongsTo) {
89
110
  const belongsToReg = getBelongsToRegistry();
90
- const hasManyReg = getHasManyRegistry();
111
+ const pendingHasManyReg = getHasManyRegistry();
91
112
 
92
113
  for (const { sourceRecord, sourceModelName, relationshipKey, relationshipId } of pendingBelongsTo) {
93
114
  // Update the belongsTo relationship on the source record
@@ -104,7 +125,7 @@ export function createRecord(modelName: string, rawData: { [key: string]: unknow
104
125
  }
105
126
 
106
127
  // Wire inverse hasMany if it exists
107
- const inverseHasMany = hasManyReg.get(modelName)?.get(sourceModelName)?.get(record.id);
128
+ const inverseHasMany = pendingHasManyReg.get(modelName)?.get(sourceModelName)?.get(record.id);
108
129
 
109
130
  if (inverseHasMany && !inverseHasMany.includes(sourceRecord)) {
110
131
  inverseHasMany.push(sourceRecord);
@@ -120,7 +141,12 @@ export function createRecord(modelName: string, rawData: { [key: string]: unknow
120
141
  if (shouldPersist) {
121
142
  const response = { data: { id: record.id } };
122
143
  orm!.sqlDb!.persist('create', modelName, { rawData }, response).catch((err: unknown) => {
123
- log.error?.(`[ORM] Failed to persist create for ${modelName}:${String(record.id)}: ${err instanceof Error ? err.message : String(err)}`);
144
+ orm!.emitPersistError({
145
+ operation: 'create',
146
+ modelName,
147
+ recordId: record.id,
148
+ error: err instanceof Error ? err : new Error(String(err)),
149
+ });
124
150
  });
125
151
  }
126
152
 
@@ -148,7 +174,12 @@ export function updateRecord(record: OrmRecord, rawData: unknown, userOptions: C
148
174
  const shouldPersist = orm?.sqlDb && !options.isDbRecord && !userOptions._relationshipKey && !options._skipAutoPersist;
149
175
  if (shouldPersist && modelName) {
150
176
  orm!.sqlDb!.persist('update', modelName, { record, oldState }, {}).catch((err: unknown) => {
151
- log.error?.(`[ORM] Failed to persist update for ${modelName}:${String(record.id)}: ${err instanceof Error ? err.message : String(err)}`);
177
+ orm!.emitPersistError({
178
+ operation: 'update',
179
+ modelName,
180
+ recordId: record.id,
181
+ error: err instanceof Error ? err : new Error(String(err)),
182
+ });
152
183
  });
153
184
  }
154
185
  }
@@ -8,6 +8,7 @@ interface PgConfig {
8
8
  password: string;
9
9
  database: string;
10
10
  connectionLimit: number;
11
+ [key: string]: unknown;
11
12
  }
12
13
 
13
14
  let pool: PgPool | null = null;
@@ -20,15 +21,18 @@ export async function getPool(pgConfig: PgConfig, extensions: string[] = ['vecto
20
21
 
21
22
  const { default: pg } = await import('pg');
22
23
 
24
+ const { host, port, user, password, database, connectionLimit, migrationsDir, migrationsTable, ...poolOpts } = pgConfig;
25
+
23
26
  pool = new pg.Pool({
24
- host: pgConfig.host,
25
- port: pgConfig.port,
26
- user: pgConfig.user,
27
- password: pgConfig.password,
28
- database: pgConfig.database,
29
- max: pgConfig.connectionLimit,
27
+ host,
28
+ port,
29
+ user,
30
+ password,
31
+ database,
32
+ max: connectionLimit,
30
33
  idleTimeoutMillis: 30000,
31
34
  connectionTimeoutMillis: 10000,
35
+ ...poolOpts,
32
36
  });
33
37
 
34
38
  // Enable requested PostgreSQL extensions
package/src/serializer.ts CHANGED
@@ -94,8 +94,33 @@ export default class Serializer {
94
94
  const handlerOptions = { ...options, _relationshipKey: key };
95
95
  const childRecord = handler(record, data, handlerOptions);
96
96
 
97
- rec[key] = childRecord;
98
- relatedRecords[key] = childRecord;
97
+ // hasMany relationships use a getter so format()/toJSON() always read
98
+ // the live registry array instead of a stale snapshot captured at
99
+ // serialization time. This is critical when child records are created
100
+ // in a later async frame — the belongsTo inverse wiring pushes into
101
+ // the shared registry array, and the getter ensures the parent sees it.
102
+ const isHasMany = (handler as { __relationshipType?: string }).__relationshipType === 'hasMany';
103
+
104
+ if (isHasMany) {
105
+ // `childRecord` IS the shared registry array — define a getter that
106
+ // always dereferences through the same array reference.
107
+ const registryArray = childRecord as unknown[];
108
+ Object.defineProperty(rec, key, {
109
+ enumerable: true,
110
+ configurable: true,
111
+ get: () => registryArray,
112
+ set(v: unknown) { relatedRecords[key] = v; }
113
+ });
114
+ Object.defineProperty(relatedRecords, key, {
115
+ enumerable: true,
116
+ configurable: true,
117
+ get: () => registryArray,
118
+ set(v: unknown) { Object.defineProperty(relatedRecords, key, { value: v, writable: true, enumerable: true, configurable: true }); }
119
+ });
120
+ } else {
121
+ rec[key] = childRecord;
122
+ relatedRecords[key] = childRecord;
123
+ }
99
124
 
100
125
  continue;
101
126
  }
package/src/store.ts CHANGED
@@ -179,7 +179,12 @@ export default class Store {
179
179
  // Auto-persist delete to SQL
180
180
  if (id && Orm.instance?.sqlDb) {
181
181
  Orm.instance.sqlDb.persist('delete', key, { recordId: id }, {}).catch((err: unknown) => {
182
- console.error(`[ORM] Failed to persist delete for ${key}:${id}: ${err instanceof Error ? err.message : String(err)}`);
182
+ Orm.instance.emitPersistError({
183
+ operation: 'delete',
184
+ modelName: key,
185
+ recordId: id,
186
+ error: err instanceof Error ? err : new Error(String(err)),
187
+ });
183
188
  });
184
189
  }
185
190
 
@@ -48,6 +48,12 @@ export interface OrmRestServerConfig {
48
48
  metaRoute: boolean;
49
49
  }
50
50
 
51
+ export interface OrmDynamoDBConfig {
52
+ region?: string;
53
+ endpoint?: string;
54
+ [key: string]: unknown;
55
+ }
56
+
51
57
  export interface OrmSection {
52
58
  db: OrmDbConfig;
53
59
  paths: OrmPaths;
@@ -55,6 +61,9 @@ export interface OrmSection {
55
61
  mysql?: OrmMysqlConfig;
56
62
  postgres?: OrmPostgresConfig;
57
63
  timescale?: OrmPostgresConfig;
64
+ dynamodb?: OrmDynamoDBConfig;
65
+ logColor?: string;
66
+ logMethod?: string;
58
67
  [key: string]: unknown;
59
68
  }
60
69
 
@@ -5,7 +5,13 @@ declare module 'stonyx/config' {
5
5
  }
6
6
 
7
7
  declare module 'stonyx/log' {
8
- const log: Record<string, ((...args: unknown[]) => void) | undefined>;
8
+ interface Log {
9
+ db(message: string): void;
10
+ error(message: string, ...args: unknown[]): void;
11
+ defineType(type: string, setting: string, options?: Record<string, unknown> | null): void;
12
+ [key: string]: ((...args: unknown[]) => void) | undefined;
13
+ }
14
+ const log: Log;
9
15
  export default log;
10
16
  }
11
17