@stonyx/orm 0.3.2-alpha.2 → 0.3.2-alpha.21

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.
Files changed (47) hide show
  1. package/README.md +35 -2
  2. package/config/environment.js +8 -0
  3. package/dist/commands.js +34 -0
  4. package/dist/dynamodb/connection.d.ts +30 -0
  5. package/dist/dynamodb/connection.js +28 -0
  6. package/dist/dynamodb/dynamodb-db.d.ts +131 -0
  7. package/dist/dynamodb/dynamodb-db.js +583 -0
  8. package/dist/dynamodb/operation-builder.d.ts +76 -0
  9. package/dist/dynamodb/operation-builder.js +109 -0
  10. package/dist/dynamodb/type-map.d.ts +31 -0
  11. package/dist/dynamodb/type-map.js +48 -0
  12. package/dist/index.d.ts +1 -0
  13. package/dist/index.js +4 -4
  14. package/dist/main.d.ts +12 -12
  15. package/dist/main.js +28 -42
  16. package/dist/manage-record.d.ts +1 -0
  17. package/dist/manage-record.js +66 -4
  18. package/dist/mysql/mysql-db.d.ts +1 -0
  19. package/dist/mysql/mysql-db.js +4 -2
  20. package/dist/orm-request.js +4 -4
  21. package/dist/postgres/connection.d.ts +1 -0
  22. package/dist/postgres/connection.js +8 -6
  23. package/dist/postgres/postgres-db.d.ts +1 -0
  24. package/dist/postgres/postgres-db.js +20 -8
  25. package/dist/relationships.js +1 -1
  26. package/dist/serializer.js +27 -2
  27. package/dist/store.d.ts +10 -0
  28. package/dist/store.js +71 -1
  29. package/dist/types/orm-types.d.ts +8 -0
  30. package/package.json +17 -7
  31. package/src/commands.ts +43 -0
  32. package/src/dynamodb/connection.ts +49 -0
  33. package/src/dynamodb/dynamodb-db.ts +797 -0
  34. package/src/dynamodb/operation-builder.ts +188 -0
  35. package/src/dynamodb/type-map.ts +54 -0
  36. package/src/index.ts +5 -4
  37. package/src/main.ts +36 -50
  38. package/src/manage-record.ts +72 -4
  39. package/src/mysql/mysql-db.ts +5 -2
  40. package/src/orm-request.ts +4 -4
  41. package/src/postgres/connection.ts +10 -6
  42. package/src/postgres/postgres-db.ts +19 -8
  43. package/src/relationships.ts +1 -1
  44. package/src/serializer.ts +27 -2
  45. package/src/store.ts +75 -1
  46. package/src/types/orm-types.ts +9 -0
  47. package/src/types/stonyx.d.ts +7 -1
@@ -365,7 +365,7 @@ export default class PostgresDB {
365
365
  return this._persistDelete(modelName, context);
366
366
  }
367
367
  }
368
- async _persistCreate(modelName, _context, response) {
368
+ async _persistCreate(modelName, context, response) {
369
369
  const schemas = this.deps.introspectModels();
370
370
  const schema = schemas[modelName];
371
371
  if (!schema)
@@ -375,9 +375,11 @@ export default class PostgresDB {
375
375
  const record = recordId != null ? storeRef.get(modelName, isNaN(recordId) ? recordId : parseInt(recordId)) : null;
376
376
  if (!record)
377
377
  return;
378
- const insertData = this._recordToRow(record, schema);
379
- // For auto-increment models, remove the pending ID
380
- const isPendingId = record.__data.__pendingSqlId;
378
+ const insertData = this._recordToRow(record, schema, context.rawData);
379
+ // For auto-increment models, remove the pending ID.
380
+ // Check context.rawData (not record.__data) because __pendingSqlId is not a model
381
+ // attribute and gets lost during serialization.
382
+ const isPendingId = context.rawData?.__pendingSqlId === true;
381
383
  if (isPendingId) {
382
384
  delete insertData.id;
383
385
  }
@@ -420,7 +422,10 @@ export default class PostgresDB {
420
422
  // Check FK changes too
421
423
  for (const fkCol of Object.keys(schema.foreignKeys)) {
422
424
  const relName = fkCol.replace(/_id$/, '');
423
- const currentFkValue = record.__relationships[relName]?.id ?? null;
425
+ const relValue = record.__relationships[relName];
426
+ const currentFkValue = (relValue && typeof relValue === 'object' && relValue !== null)
427
+ ? relValue.id ?? null
428
+ : relValue ?? record.__data[relName] ?? null;
424
429
  const oldFkValue = oldState[relName] ?? null;
425
430
  if (currentFkValue !== oldFkValue) {
426
431
  changedData[fkCol] = currentFkValue;
@@ -444,7 +449,7 @@ export default class PostgresDB {
444
449
  const { sql, values } = this.deps.buildDelete(schema.table, id);
445
450
  await this.requirePool().query(sql, values);
446
451
  }
447
- _recordToRow(record, schema) {
452
+ _recordToRow(record, schema, rawData) {
448
453
  const row = {};
449
454
  const data = record.__data;
450
455
  // ID
@@ -464,13 +469,20 @@ export default class PostgresDB {
464
469
  for (const fkCol of Object.keys(schema.foreignKeys)) {
465
470
  const relName = fkCol.replace(/_id$/, '');
466
471
  const related = record.__relationships[relName];
467
- if (related) {
472
+ if (related && typeof related === 'object' && related !== null) {
468
473
  row[fkCol] = related.id;
469
474
  }
475
+ else if (related != null) {
476
+ // Raw FK value (e.g., string ID stored directly in __relationships)
477
+ row[fkCol] = related;
478
+ }
470
479
  else if (data[relName] !== undefined) {
471
- // Raw FK value (e.g., from create payload)
472
480
  row[fkCol] = data[relName];
473
481
  }
482
+ else if (rawData?.[relName] !== undefined) {
483
+ // Fallback to original create payload for unresolved belongsTo FKs
484
+ row[fkCol] = rawData[relName];
485
+ }
474
486
  }
475
487
  return row;
476
488
  }
@@ -38,4 +38,4 @@ export function getPendingRegistry() {
38
38
  export function getPendingBelongsToRegistry() {
39
39
  return relationships.get('pendingBelongsTo');
40
40
  }
41
- export const TYPES = ['global', 'hasMany', 'belongsTo', 'pending'];
41
+ export const TYPES = ['global', 'hasMany', 'belongsTo', 'pending', 'pendingBelongsTo'];
@@ -79,8 +79,33 @@ export default class Serializer {
79
79
  // Pass relationship key name to handler for pending fulfillment
80
80
  const handlerOptions = { ...options, _relationshipKey: key };
81
81
  const childRecord = handler(record, data, handlerOptions);
82
- rec[key] = childRecord;
83
- relatedRecords[key] = childRecord;
82
+ // hasMany relationships use a getter so format()/toJSON() always read
83
+ // the live registry array instead of a stale snapshot captured at
84
+ // serialization time. This is critical when child records are created
85
+ // in a later async frame — the belongsTo inverse wiring pushes into
86
+ // the shared registry array, and the getter ensures the parent sees it.
87
+ const isHasMany = handler.__relationshipType === 'hasMany';
88
+ if (isHasMany) {
89
+ // `childRecord` IS the shared registry array — define a getter that
90
+ // always dereferences through the same array reference.
91
+ const registryArray = childRecord;
92
+ Object.defineProperty(rec, key, {
93
+ enumerable: true,
94
+ configurable: true,
95
+ get: () => registryArray,
96
+ set(v) { relatedRecords[key] = v; }
97
+ });
98
+ Object.defineProperty(relatedRecords, key, {
99
+ enumerable: true,
100
+ configurable: true,
101
+ get: () => registryArray,
102
+ set(v) { Object.defineProperty(relatedRecords, key, { value: v, writable: true, enumerable: true, configurable: true }); }
103
+ });
104
+ }
105
+ else {
106
+ rec[key] = childRecord;
107
+ relatedRecords[key] = childRecord;
108
+ }
84
109
  continue;
85
110
  }
86
111
  // Aggregate property handling — use the rawData value, not the aggregate descriptor
package/dist/store.d.ts CHANGED
@@ -46,6 +46,16 @@ export default class Store {
46
46
  private _isMemoryModel;
47
47
  set(key: string, value: Map<number | string, unknown>): void;
48
48
  remove(key: string, id?: number | string): void;
49
+ /**
50
+ * Evict a record from the store with full relationship registry cleanup,
51
+ * WITHOUT calling record.clean(). This preserves the caller's reference
52
+ * to the returned record (used by memory:false post-persist eviction).
53
+ *
54
+ * @param registryId - The ID used when the record's relationships were
55
+ * registered. For SQL models with pending IDs, this is the original
56
+ * negative pending ID (before the adapter re-keyed to the real DB ID).
57
+ */
58
+ evictRecord(modelName: string, id: unknown, registryId?: unknown): void;
49
59
  unloadRecord(model: string, id: unknown, options?: UnloadOptions): void;
50
60
  unloadAllRecords(model: string, options?: UnloadOptions): void;
51
61
  private _removeFromHasManyArrays;
package/dist/store.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import Orm, { relationships } from '@stonyx/orm';
2
- import { TYPES, getHasManyRegistry, getBelongsToRegistry, getPendingRegistry } from './relationships.js';
2
+ import { TYPES, getHasManyRegistry, getBelongsToRegistry, getPendingRegistry, getPendingBelongsToRegistry } from './relationships.js';
3
3
  import ViewResolver from './view-resolver.js';
4
4
  function isStoreRecord(value) {
5
5
  return typeof value === 'object' && value !== null && '__data' in value;
@@ -112,10 +112,55 @@ export default class Store {
112
112
  if (Orm.instance?.isView?.(key)) {
113
113
  throw new Error(`Cannot remove records from read-only view '${key}'`);
114
114
  }
115
+ // Auto-persist delete to SQL
116
+ if (id && Orm.instance?.sqlDb) {
117
+ Orm.instance.sqlDb.persist('delete', key, { recordId: id }, {}).catch((err) => {
118
+ Orm.instance.emitPersistError({
119
+ operation: 'delete',
120
+ modelName: key,
121
+ recordId: id,
122
+ error: err instanceof Error ? err : new Error(String(err)),
123
+ });
124
+ });
125
+ }
115
126
  if (id)
116
127
  return this.unloadRecord(key, id);
117
128
  this.unloadAllRecords(key);
118
129
  }
130
+ /**
131
+ * Evict a record from the store with full relationship registry cleanup,
132
+ * WITHOUT calling record.clean(). This preserves the caller's reference
133
+ * to the returned record (used by memory:false post-persist eviction).
134
+ *
135
+ * @param registryId - The ID used when the record's relationships were
136
+ * registered. For SQL models with pending IDs, this is the original
137
+ * negative pending ID (before the adapter re-keyed to the real DB ID).
138
+ */
139
+ evictRecord(modelName, id, registryId) {
140
+ const modelStore = this.data.get(modelName);
141
+ if (!modelStore)
142
+ return;
143
+ if (typeof id !== 'string' && typeof id !== 'number')
144
+ return;
145
+ const raw = modelStore.get(id);
146
+ if (!raw || !isStoreRecord(raw))
147
+ return;
148
+ const visited = new Set([`${modelName}:${id}`]);
149
+ // Remove from hasMany arrays and nullify belongsTo references using current ID
150
+ // (the adapter updates record.id, so value-based matches need the current ID)
151
+ this._removeFromHasManyArrays(modelName, id, visited);
152
+ this._nullifyBelongsToReferences(modelName, id, visited);
153
+ // Clean up relationship registry entries using the registry key
154
+ // (belongsTo/hasMany registries were keyed by the ID at registration time,
155
+ // which may differ from the current ID if SQL persist re-keyed the record)
156
+ const cleanupId = registryId ?? id;
157
+ this._cleanupRelationshipRegistries(modelName, cleanupId);
158
+ // If registryId differs from id, also clean with current id as safety net
159
+ if (registryId !== undefined && registryId !== id) {
160
+ this._cleanupRelationshipRegistries(modelName, id);
161
+ }
162
+ modelStore.delete(id);
163
+ }
119
164
  unloadRecord(model, id, options = {}) {
120
165
  const modelStore = this.data.get(model);
121
166
  if (!modelStore) {
@@ -219,6 +264,31 @@ export default class Store {
219
264
  const pendingMap = getPendingRegistry().get(modelName);
220
265
  if (pendingMap)
221
266
  pendingMap.delete(recordId);
267
+ // Clean pendingBelongsTo entries in both directions
268
+ const pendingBelongsToMap = getPendingBelongsToRegistry();
269
+ if (pendingBelongsToMap) {
270
+ // Direction 1: evicted record was the TARGET others were waiting for
271
+ const targetEntries = pendingBelongsToMap.get(modelName);
272
+ if (targetEntries)
273
+ targetEntries.delete(recordId);
274
+ // Direction 2: evicted record was the SOURCE with unresolved forward-references
275
+ for (const [, targetIdMap] of pendingBelongsToMap) {
276
+ for (const [targetId, entries] of targetIdMap) {
277
+ if (!Array.isArray(entries))
278
+ continue;
279
+ const filtered = entries.filter((e) => {
280
+ const entry = e;
281
+ return !(entry.sourceModelName === modelName && entry.relationshipId === recordId);
282
+ });
283
+ if (filtered.length === 0) {
284
+ targetIdMap.delete(targetId);
285
+ }
286
+ else if (filtered.length < entries.length) {
287
+ targetIdMap.set(targetId, filtered);
288
+ }
289
+ }
290
+ }
291
+ }
222
292
  }
223
293
  /**
224
294
  * Extracts hasMany and non-bidirectional belongsTo children from a record
@@ -42,6 +42,11 @@ export interface OrmRestServerConfig {
42
42
  route: string;
43
43
  metaRoute: boolean;
44
44
  }
45
+ export interface OrmDynamoDBConfig {
46
+ region?: string;
47
+ endpoint?: string;
48
+ [key: string]: unknown;
49
+ }
45
50
  export interface OrmSection {
46
51
  db: OrmDbConfig;
47
52
  paths: OrmPaths;
@@ -49,6 +54,9 @@ export interface OrmSection {
49
54
  mysql?: OrmMysqlConfig;
50
55
  postgres?: OrmPostgresConfig;
51
56
  timescale?: OrmPostgresConfig;
57
+ dynamodb?: OrmDynamoDBConfig;
58
+ logColor?: string;
59
+ logMethod?: string;
52
60
  [key: string]: unknown;
53
61
  }
54
62
  export interface OrmConfig {
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "stonyx-async",
5
5
  "stonyx-module"
6
6
  ],
7
- "version": "0.3.2-alpha.2",
7
+ "version": "0.3.2-alpha.21",
8
8
  "description": "",
9
9
  "main": "dist/index.js",
10
10
  "type": "module",
@@ -61,16 +61,24 @@
61
61
  },
62
62
  "homepage": "https://github.com/abofs/stonyx-orm#readme",
63
63
  "dependencies": {
64
- "@stonyx/cron": "0.2.1-beta.29",
65
- "@stonyx/events": "0.1.1-beta.9",
66
- "stonyx": "0.2.3-beta.11"
64
+ "@stonyx/cron": "0.2.1-beta.70",
65
+ "@stonyx/events": "0.1.1-beta.51",
66
+ "stonyx": "0.2.3-beta.68"
67
67
  },
68
68
  "peerDependencies": {
69
+ "@aws-sdk/client-dynamodb": "^3.0.0",
70
+ "@aws-sdk/lib-dynamodb": "^3.0.0",
69
71
  "@stonyx/rest-server": ">=0.2.1-beta.14",
70
72
  "mysql2": "^3.0.0",
71
73
  "pg": "^8.0.0"
72
74
  },
73
75
  "peerDependenciesMeta": {
76
+ "@aws-sdk/client-dynamodb": {
77
+ "optional": true
78
+ },
79
+ "@aws-sdk/lib-dynamodb": {
80
+ "optional": true
81
+ },
74
82
  "mysql2": {
75
83
  "optional": true
76
84
  },
@@ -82,18 +90,20 @@
82
90
  }
83
91
  },
84
92
  "devDependencies": {
85
- "@stonyx/rest-server": "0.2.1-beta.30",
86
- "@stonyx/utils": "0.2.3-beta.7",
93
+ "@stonyx/rest-server": "0.2.1-beta.71",
94
+ "@stonyx/utils": "0.2.3-beta.25",
87
95
  "@types/node": "^25.6.0",
88
96
  "mysql2": "^3.20.0",
89
97
  "pg": "^8.20.0",
90
98
  "qunit": "^2.24.1",
91
99
  "sinon": "^21.0.0",
100
+ "tsx": "^4.21.0",
92
101
  "typescript": "^5.8.3"
93
102
  },
94
103
  "scripts": {
95
104
  "build": "tsc",
96
105
  "build:test": "tsc -p tsconfig.test.json",
97
- "test": "npm run build && npm run build:test && stonyx test 'dist-test/test/**/*-test.js'"
106
+ "test": "pnpm build && NODE_ENV=test node --import tsx/esm --import ./test/setup.ts node_modules/qunit/bin/qunit.js 'test/**/*-test.ts'",
107
+ "test:dynamodb": "pnpm build && node --import tsx/esm --import ./test/integration/dynamodb/setup.ts node_modules/qunit/bin/qunit.js 'test/integration/dynamodb/**/*-test.ts'"
98
108
  }
99
109
  }
package/src/commands.ts CHANGED
@@ -28,6 +28,13 @@ const commands: Record<string, Command> = {
28
28
  description: 'Generate a MySQL migration from current model schemas',
29
29
  bootstrap: true,
30
30
  run: async (args) => {
31
+ const config = (await import('stonyx/config')).default;
32
+
33
+ if (config.orm.dynamodb) {
34
+ console.log('DynamoDB does not use file-based migrations. Use db:sync to provision tables.');
35
+ return;
36
+ }
37
+
31
38
  const description = args?.join(' ') || 'migration';
32
39
  const { generateMigration } = await import('./mysql/migration-generator.js');
33
40
  const result = await generateMigration(description);
@@ -39,6 +46,25 @@ const commands: Record<string, Command> = {
39
46
  }
40
47
  }
41
48
  },
49
+ 'db:sync': {
50
+ description: 'Provision DynamoDB tables and GSIs from current model schemas',
51
+ bootstrap: true,
52
+ run: async () => {
53
+ const config = (await import('stonyx/config')).default;
54
+
55
+ if (!config.orm.dynamodb) {
56
+ console.error('DynamoDB is not configured. Set DYNAMODB_REGION (and optionally DYNAMODB_ENDPOINT) to enable DynamoDB mode.');
57
+ process.exit(1);
58
+ }
59
+
60
+ const { default: DynamoDBDB } = await import('./dynamodb/dynamodb-db.js');
61
+ const db = new DynamoDBDB();
62
+ await db.init();
63
+ await db.startup();
64
+ await db.shutdown();
65
+ console.log('DynamoDB tables synced successfully.');
66
+ }
67
+ },
42
68
  'db:migrate': {
43
69
  description: 'Apply pending MySQL migrations',
44
70
  bootstrap: true,
@@ -46,6 +72,11 @@ const commands: Record<string, Command> = {
46
72
  const config = (await import('stonyx/config')).default;
47
73
  const mysqlConfig = config.orm.mysql;
48
74
 
75
+ if (config.orm.dynamodb) {
76
+ console.log('DynamoDB does not use file-based migrations. Use db:sync to provision tables.');
77
+ return;
78
+ }
79
+
49
80
  if (!mysqlConfig) {
50
81
  console.error('MySQL is not configured. Set MYSQL_HOST to enable MySQL mode.');
51
82
  process.exit(1);
@@ -92,6 +123,12 @@ const commands: Record<string, Command> = {
92
123
  bootstrap: true,
93
124
  run: async () => {
94
125
  const config = (await import('stonyx/config')).default;
126
+
127
+ if (config.orm.dynamodb) {
128
+ console.log('DynamoDB does not support migration rollback. Manage table changes via the AWS console or db:sync.');
129
+ return;
130
+ }
131
+
95
132
  const mysqlConfig = config.orm.mysql;
96
133
 
97
134
  if (!mysqlConfig) {
@@ -138,6 +175,12 @@ const commands: Record<string, Command> = {
138
175
  bootstrap: true,
139
176
  run: async () => {
140
177
  const config = (await import('stonyx/config')).default;
178
+
179
+ if (config.orm.dynamodb) {
180
+ console.log('DynamoDB does not use file-based migrations. Use db:sync to provision tables.');
181
+ return;
182
+ }
183
+
141
184
  const mysqlConfig = config.orm.mysql;
142
185
 
143
186
  if (!mysqlConfig) {
@@ -0,0 +1,49 @@
1
+ /**
2
+ * DynamoDB connection factory.
3
+ *
4
+ * Dynamically imports @aws-sdk/client-dynamodb and @aws-sdk/lib-dynamodb
5
+ * so these are optional peerDependencies (matching the pg/mysql2 pattern).
6
+ */
7
+
8
+ export interface DynamoDBConfig {
9
+ region?: string;
10
+ endpoint?: string;
11
+ [key: string]: unknown;
12
+ }
13
+
14
+ // Type aliases — declared loose so we don't need to import the real SDK types
15
+ // at compile time (they're optional peer deps).
16
+ export type DocumentClient = {
17
+ send(command: unknown): Promise<unknown>;
18
+ };
19
+
20
+ export type DynamoDBClientConstructor = new (options: unknown) => { config: unknown };
21
+ export type DocumentClientFromFn = { from(client: unknown): DocumentClient };
22
+
23
+ /**
24
+ * Create a DynamoDBDocumentClient from the given config.
25
+ * Uses dynamic import so @aws-sdk/* are optional peer deps.
26
+ */
27
+ export async function createDocumentClient(dbConfig: DynamoDBConfig): Promise<DocumentClient> {
28
+ const { DynamoDBClient } = await import('@aws-sdk/client-dynamodb' as string) as {
29
+ DynamoDBClient: DynamoDBClientConstructor;
30
+ };
31
+ const { DynamoDBDocumentClient } = await import('@aws-sdk/lib-dynamodb' as string) as {
32
+ DynamoDBDocumentClient: DocumentClientFromFn;
33
+ };
34
+
35
+ const clientOptions: Record<string, unknown> = {};
36
+ if (dbConfig.region) clientOptions.region = dbConfig.region;
37
+ if (dbConfig.endpoint) clientOptions.endpoint = dbConfig.endpoint;
38
+
39
+ const rawClient = new DynamoDBClient(clientOptions);
40
+ return DynamoDBDocumentClient.from(rawClient);
41
+ }
42
+
43
+ /**
44
+ * Nullify the document client reference (DynamoDB connections are HTTP-based
45
+ * and stateless — no explicit pool close needed, but we clear the reference).
46
+ */
47
+ export function destroyDocumentClient(_client: DocumentClient | null): null {
48
+ return null;
49
+ }