@carbonorm/carbonnode 3.7.17 → 3.7.19

package/src/__tests__/binaryHex.e2e.test.ts

@@ -0,0 +1,82 @@
+import { describe, it, expect, beforeAll, afterAll } from 'vitest';
+import mysql from 'mysql2/promise';
+import { PostQueryBuilder } from '../api/orm/queries/PostQueryBuilder';
+import { UpdateQueryBuilder } from '../api/orm/queries/UpdateQueryBuilder';
+import { C6C } from '../api/C6Constants';
+import { buildBinaryTestConfig } from './fixtures/c6.fixture';
+
+let pool: mysql.Pool;
+
+describe('BINARY column hex string persistence', () => {
+  beforeAll(async () => {
+    pool = mysql.createPool({
+      host: '127.0.0.1',
+      user: 'root',
+      password: 'password',
+      database: 'sakila',
+    });
+
+    await pool.query('DROP TABLE IF EXISTS binary_test');
+    await pool.query(`
+      CREATE TABLE binary_test (
+        id INT NOT NULL AUTO_INCREMENT,
+        bin_col BINARY(16) DEFAULT NULL,
+        PRIMARY KEY (id)
+      )
+    `);
+  });
+
+  afterAll(async () => {
+    await pool.end();
+  });
+
+  it('inserts and updates hex strings as Buffer in BINARY(16) columns', async () => {
+    const config = buildBinaryTestConfig();
+
+    // ---------- INSERT ----------
+    const insertBuilder = new PostQueryBuilder(
+        config as any,
+        {
+          [C6C.INSERT]: {
+            'binary_test.bin_col': '0123456789abcdef0123456789abcdef',
+          },
+        } as any,
+        false
+    );
+
+    // NOTE: allow union type so reassignment from different builders is safe
+    let sql: string;
+    let params: any[] | Record<string, any>;
+
+    ({ sql, params } = insertBuilder.build('binary_test'));
+    const [insertResult]: any = await pool.query(sql, params);
+    const id = insertResult.insertId as number;
+
+    let [rows]: any = await pool.query(
+        'SELECT HEX(bin_col) AS bin FROM binary_test WHERE id = ?',
+        [id]
+    );
+    expect(rows[0].bin).toBe('0123456789ABCDEF0123456789ABCDEF');
+
+    // ---------- UPDATE ----------
+    const updateBuilder = new UpdateQueryBuilder(
+        config as any,
+        {
+          [C6C.UPDATE]: {
+            'binary_test.bin_col': 'ffffffffffffffffffffffffffffffff',
+          },
+          WHERE: { 'binary_test.id': [C6C.EQUAL, id] },
+        } as any,
+        false
+    );
+
+    ({ sql, params } = updateBuilder.build('binary_test'));
+    await pool.query(sql, params);
+
+    [rows] = await pool.query(
+        'SELECT HEX(bin_col) AS bin FROM binary_test WHERE id = ?',
+        [id]
+    );
+    expect(rows[0].bin).toBe('FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF');
+  });
+});

package/src/__tests__/fixtures/c6.fixture.ts

@@ -6,7 +6,7 @@ function tableModel<T extends Record<string, any>>(name: string, columns: Record
   const COLUMNS: any = {};
   Object.entries(columns).forEach(([fq, short]) => {
     COLUMNS[fq] = short;
-    TYPE_VALIDATION[fq] = {
+    TYPE_VALIDATION[short as string] = {
       MYSQL_TYPE: 'VARCHAR(255)',
       MAX_LENGTH: '255',
       AUTO_INCREMENT: false,
@@ -61,7 +61,7 @@ export function buildTestConfig() {
   } as any;
 
   // Special-case: mark binary column as BINARY to test conversion
-  C6.TABLES.actor.TYPE_VALIDATION['actor.binarycol'].MYSQL_TYPE = 'BINARY(16)';
+  C6.TABLES.actor.TYPE_VALIDATION['binarycol'].MYSQL_TYPE = 'BINARY(16)';
 
   const baseConfig: iRest<any, any, any> = {
     C6,
@@ -72,3 +72,30 @@ export function buildTestConfig() {
 
   return baseConfig;
 }
+
+export function buildBinaryTestConfig() {
+  const binaryCols = {
+    'binary_test.id': 'id',
+    'binary_test.bin_col': 'bin_col',
+  } as const;
+
+  const C6 = {
+    C6VERSION: 'test',
+    TABLES: {
+      binary_test: tableModel<'binary_test' & any>('binary_test', binaryCols as any),
+    },
+    PREFIX: '',
+    ORM: {} as any,
+  } as any;
+
+  C6.TABLES.binary_test.TYPE_VALIDATION['bin_col'].MYSQL_TYPE = 'BINARY(16)';
+
+  const baseConfig: iRest<any, any, any> = {
+    C6,
+    restModel: C6.TABLES.binary_test,
+    requestMethod: 'POST',
+    verbose: false,
+  } as any;
+
+  return baseConfig;
+}

package/src/__tests__/httpExecutorSingular.e2e.test.ts

@@ -63,6 +63,15 @@ describe("HttpExecutor singular e2e", () => {
     expect(data.rest).toHaveLength(1);
     expect(data.rest[0].first_name).toBe("Updated");
 
+    // PUT using fully qualified keys
+    await Actor.Put({
+      [Actor.ACTOR_ID]: testId,
+      [Actor.FIRST_NAME]: "UpdatedFQ",
+    } as any);
+    data = await Actor.Get({ actor_id: testId, cacheResults: false } as any);
+    expect(data.rest).toHaveLength(1);
+    expect(data.rest[0].first_name).toBe("UpdatedFQ");
+
     // DELETE singular
     await Actor.Delete({ actor_id: testId } as any);
     data = await Actor.Get({ actor_id: testId, cacheResults: false } as any);

package/src/__tests__/sakila-db/C6.js

@@ -175,6 +175,44 @@ const address = {
             },],
     }
 };
+const binary_test = {
+    TABLE_NAME: 'binary_test',
+    ID: 'binary_test.id',
+    BIN_COL: 'binary_test.bin_col',
+    PRIMARY: [
+        'binary_test.id',
+    ],
+    PRIMARY_SHORT: [
+        'id',
+    ],
+    COLUMNS: {
+        'binary_test.id': 'id',
+        'binary_test.bin_col': 'bin_col',
+    },
+    TYPE_VALIDATION: {
+        'binary_test.id': {
+            MYSQL_TYPE: 'int',
+            MAX_LENGTH: '',
+            AUTO_INCREMENT: true,
+            SKIP_COLUMN_IN_POST: false
+        },
+        'binary_test.bin_col': {
+            MYSQL_TYPE: 'binary',
+            MAX_LENGTH: '16',
+            AUTO_INCREMENT: false,
+            SKIP_COLUMN_IN_POST: false
+        },
+    },
+    REGEX_VALIDATION: {},
+    LIFECYCLE_HOOKS: {
+        GET: { beforeProcessing: {}, beforeExecution: {}, afterExecution: {}, afterCommit: {} },
+        PUT: { beforeProcessing: {}, beforeExecution: {}, afterExecution: {}, afterCommit: {} },
+        POST: { beforeProcessing: {}, beforeExecution: {}, afterExecution: {}, afterCommit: {} },
+        DELETE: { beforeProcessing: {}, beforeExecution: {}, afterExecution: {}, afterCommit: {} },
+    },
+    TABLE_REFERENCES: {},
+    TABLE_REFERENCED_BY: {}
+};
 const category = {
     TABLE_NAME: 'category',
     CATEGORY_ID: 'category.category_id',
@@ -1300,11 +1338,11 @@ const store = {
     }
 };
 export const TABLES = {
-    actor, address, category, city, country, customer, film, film_actor, film_category, film_text, inventory, language, payment, rental, staff, store,
+    actor, address, binary_test, category, city, country, customer, film, film_actor, film_category, film_text, inventory, language, payment, rental, staff, store,
 };
 export const C6 = {
     ...C6Constants,
-    C6VERSION: '3.7.17',
+    C6VERSION: '3.7.19',
     IMPORT: async (tableName) => {
         tableName = tableName.toLowerCase();
         // if tableName is not a key in the TABLES object then throw an error
@@ -1333,6 +1371,7 @@ export const C6 = {
 export const initialRestfulObjectsState = {
     actor: undefined,
     address: undefined,
+    binary_test: undefined,
     category: undefined,
     city: undefined,
     country: undefined,
@@ -1351,6 +1390,7 @@ export const initialRestfulObjectsState = {
 export const COLUMNS = {
     'actor.actor_id': 'actor_id', 'actor.first_name': 'first_name', 'actor.last_name': 'last_name', 'actor.last_update': 'last_update',
     'address.address_id': 'address_id', 'address.address': 'address', 'address.address2': 'address2', 'address.district': 'district', 'address.city_id': 'city_id', 'address.postal_code': 'postal_code', 'address.phone': 'phone', 'address.location': 'location', 'address.last_update': 'last_update',
+    'binary_test.id': 'id', 'binary_test.bin_col': 'bin_col',
     'category.category_id': 'category_id', 'category.name': 'name', 'category.last_update': 'last_update',
     'city.city_id': 'city_id', 'city.city': 'city', 'city.country_id': 'country_id', 'city.last_update': 'last_update',
     'country.country_id': 'country_id', 'country.country': 'country', 'country.last_update': 'last_update',
@@ -1384,6 +1424,13 @@ export const Address = {
         restModel: address
     }))
 };
+export const Binary_Test = {
+    ...binary_test,
+    ...restOrm(() => ({
+        ...GLOBAL_REST_PARAMETERS,
+        restModel: binary_test
+    }))
+};
 export const Category = {
     ...category,
     ...restOrm(() => ({
@@ -1483,5 +1530,5 @@ export const Store = {
     }))
 };
 C6.ORM = {
-    Actor, Address, Category, City, Country, Customer, Film, Film_Actor, Film_Category, Film_Text, Inventory, Language, Payment, Rental, Staff, Store,
+    Actor, Address, Binary_Test, Category, City, Country, Customer, Film, Film_Actor, Film_Category, Film_Text, Inventory, Language, Payment, Rental, Staff, Store,
 };

package/src/__tests__/sakila-db/C6.test.ts

@@ -59,5 +59,32 @@ describe('sakila-db generated C6 bindings', () => {
             await waitForRequests();
         });
     }
+
+    it('[actor] PUT fully qualified keys', async () => {
+        const Actor = C6.ORM.Actor;
+        const testId = 1;
+
+        let result = await Actor.Get({ [Actor.ACTOR_ID]: testId } as any);
+        let data = result?.data ?? result;
+        const originalLastName = data?.rest?.[0]?.last_name;
+
+        await Actor.Put({
+            [Actor.ACTOR_ID]: testId,
+            [Actor.LAST_NAME]: 'Updated',
+        } as any);
+
+        result = await Actor.Get({
+            [Actor.ACTOR_ID]: testId,
+            cacheResults: false,
+        } as any);
+        data = result?.data ?? result;
+        expect(data?.rest?.[0]?.last_name).toBe('Updated');
+
+        await Actor.Put({
+            [Actor.ACTOR_ID]: testId,
+            [Actor.LAST_NAME]: originalLastName,
+        } as any);
+        await waitForRequests();
+    });
 });
 

package/src/__tests__/sakila-db/C6.ts

@@ -16,6 +16,7 @@ export const RestTablePrefix = '';
 
 export type RestTableNames = 'actor'
  | 'address'
+ | 'binary_test'
  | 'category'
  | 'city'
  | 'country'
@@ -33,6 +34,7 @@ export type RestTableNames = 'actor'
 
 export type RestShortTableNames = 'actor'
  | 'address'
+ | 'binary_test'
  | 'category'
  | 'city'
  | 'country'
@@ -295,6 +297,72 @@ const address:
     }
 }
 
+/**
+CREATE TABLE `binary_test` (
+  `id` int NOT NULL AUTO_INCREMENT,
+  `bin_col` binary(16) DEFAULT NULL,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
+**/
+
+export interface iBinary_Test {
+    'id'?: number;
+    'bin_col'?: Buffer | string | null;
+}
+
+export type Binary_TestPrimaryKeys = 
+        'id'
+    ;
+
+const binary_test:
+    C6RestfulModel<
+        'binary_test',
+        iBinary_Test,
+        Binary_TestPrimaryKeys
+    > = {
+    TABLE_NAME: 'binary_test',
+    ID: 'binary_test.id',
+    BIN_COL: 'binary_test.bin_col',
+    PRIMARY: [
+        'binary_test.id',
+    ],
+    PRIMARY_SHORT: [
+        'id',
+    ],
+    COLUMNS: {
+        'binary_test.id': 'id',
+        'binary_test.bin_col': 'bin_col',
+    },
+    TYPE_VALIDATION: {
+        'binary_test.id': {
+            MYSQL_TYPE: 'int',
+            MAX_LENGTH: '',
+            AUTO_INCREMENT: true,
+            SKIP_COLUMN_IN_POST: false
+        },
+        'binary_test.bin_col': {
+            MYSQL_TYPE: 'binary',
+            MAX_LENGTH: '16',
+            AUTO_INCREMENT: false,
+            SKIP_COLUMN_IN_POST: false
+        },
+    },
+    REGEX_VALIDATION: {
+    },
+    LIFECYCLE_HOOKS: {
+        GET: {beforeProcessing:{}, beforeExecution:{}, afterExecution:{}, afterCommit:{}},
+        PUT: {beforeProcessing:{}, beforeExecution:{}, afterExecution:{}, afterCommit:{}},
+        POST: {beforeProcessing:{}, beforeExecution:{}, afterExecution:{}, afterCommit:{}},
+        DELETE: {beforeProcessing:{}, beforeExecution:{}, afterExecution:{}, afterCommit:{}},
+    },
+    TABLE_REFERENCES: {
+        
+    },
+    TABLE_REFERENCED_BY: {
+        
+    }
+}
+
 /**
 CREATE TABLE `category` (
   `category_id` tinyint unsigned NOT NULL AUTO_INCREMENT,
@@ -1916,13 +1984,14 @@ const store:
 }
 
 export const TABLES = {
-actor,address,category,city,country,customer,film,film_actor,film_category,film_text,inventory,language,payment,rental,staff,store,
+actor,address,binary_test,category,city,country,customer,film,film_actor,film_category,film_text,inventory,language,payment,rental,staff,store,
 } satisfies {
     [K in keyof RestTableInterfaces]: C6RestfulModel<K, RestTableInterfaces[K], keyof RestTableInterfaces[K] & string>;
 };
 
 export type RestTableInterfaces = iActor
  | iAddress
+ | iBinary_Test
  | iCategory
  | iCity
  | iCountry
@@ -1940,7 +2009,7 @@ export type RestTableInterfaces = iActor
 
 export const C6 : iC6Object<RestTableInterfaces> = {
     ...C6Constants,
-    C6VERSION: '3.7.17',
+    C6VERSION: '3.7.19',
     IMPORT: async (tableName: string) : Promise<iDynamicApiImport> => {
 
         tableName = tableName.toLowerCase();
@@ -1976,6 +2045,7 @@ export type tStatefulApiData<T> = T[] | undefined | null;
 export interface iRestfulObjectArrayTypes {
     actor: tStatefulApiData<iActor>,
     address: tStatefulApiData<iAddress>,
+    binary_test: tStatefulApiData<iBinary_Test>,
     category: tStatefulApiData<iCategory>,
     city: tStatefulApiData<iCity>,
     country: tStatefulApiData<iCountry>,
@@ -1997,6 +2067,7 @@ export type tRestfulObjectArrayValues = iRestfulObjectArrayTypes[keyof iRestfulO
 export const initialRestfulObjectsState: iRestfulObjectArrayTypes = {
     actor: undefined,
     address: undefined,
+    binary_test: undefined,
     category: undefined,
     city: undefined,
     country: undefined,
@@ -2016,6 +2087,7 @@ export const initialRestfulObjectsState: iRestfulObjectArrayTypes = {
 export const COLUMNS = {
     'actor.actor_id': 'actor_id','actor.first_name': 'first_name','actor.last_name': 'last_name','actor.last_update': 'last_update',
 'address.address_id': 'address_id','address.address': 'address','address.address2': 'address2','address.district': 'district','address.city_id': 'city_id','address.postal_code': 'postal_code','address.phone': 'phone','address.location': 'location','address.last_update': 'last_update',
+'binary_test.id': 'id','binary_test.bin_col': 'bin_col',
 'category.category_id': 'category_id','category.name': 'name','category.last_update': 'last_update',
 'city.city_id': 'city_id','city.city': 'city','city.country_id': 'country_id','city.last_update': 'last_update',
 'country.country_id': 'country_id','country.country': 'country','country.last_update': 'last_update',
@@ -2059,6 +2131,16 @@ export const Address = {
     }))
 }
 
+export const Binary_Test = {
+    ...binary_test,
+    ...restOrm<
+        OrmGenerics<any, 'binary_test', iBinary_Test, Binary_TestPrimaryKeys>
+    >(() => ({
+        ...GLOBAL_REST_PARAMETERS,
+        restModel: binary_test
+    }))
+}
+
 export const Category = {
     ...category,
     ...restOrm<
@@ -2200,7 +2282,7 @@ export const Store = {
 }
 
 C6.ORM = {
-    Actor,    Address,    Category,    City,    Country,    Customer,    Film,    Film_Actor,    Film_Category,    Film_Text,    Inventory,    Language,    Payment,    Rental,    Staff,    Store,
+    Actor,    Address,    Binary_Test,    Category,    City,    Country,    Customer,    Film,    Film_Actor,    Film_Category,    Film_Text,    Inventory,    Language,    Payment,    Rental,    Staff,    Store,
 };