@mlagie/sql-connector 1.0.2 → 1.0.3-beta

package/README.md

@@ -42,25 +42,66 @@ await connect(config);
 await logout();
 ```
 
+### Interface `SchemaField`
+
+Décrit les propriétés d'un champ dans le schéma d'une table SQL. Chaque clé du dictionnaire passé au constructeur de `Schema` doit respecter cette interface.
+
+| Propriété        | Type                                 | Description                                                                 |
+|------------------|--------------------------------------|-----------------------------------------------------------------------------|
+| type             | `SqlType` ou `{ name: SqlType }`     | Type du champ (String, Number, Boolean, etc.)                               |
+| length           | `number`                             | Longueur maximale (pour VARCHAR ou INT)                                     |
+| required         | `boolean`                            | Si le champ est obligatoire (NOT NULL)                                      |
+| default          | `any`                                | Valeur par défaut                                                           |
+| unique           | `boolean`                            | Si le champ doit être unique                                                |
+| auto_increment   | `boolean`                            | Si le champ est auto-incrémenté                                             |
+| foreignKey       | `string`                             | Clé étrangère (ex: "otherTable(column)")                                   |
+| enum             | `string[]`                           | Liste de valeurs pour un champ ENUM                                         |
+| primary_key      | `boolean`                            | Si le champ est une clé primaire                                            |
+| customize        | `string`                             | Ajout d'options SQL personnalisées                                          |
+
+#### Exemple d'utilisation
+
+```javascript
+const userSchema = new Schema({
+    status: {
+        type: String,
+        enum: ["active", "inactive", "pending"], // champ ENUM
+        required: true,
+        default: "pending"
+    },
+    id: {
+        type: Number,
+        auto_increment: true,
+        primary_key: true
+    },
+    email: {
+        type: String,
+        length: 255,
+        unique: true,
+        required: true
+    }
+});
+```
+
 ### Classes `Schema`
 
 Représente un schéma de base de données.
 * Constructeur:
-    * Schema(schemaDict) : Crée une instance de Schema.
-        * schemaDict (Object) : Un dictionnaire définissant le schéma.
+        * Schema(schemaDict) : Crée une instance de Schema.
+                * schemaDict (Object) : Un dictionnaire définissant le schéma.
 
 * Exemple
 
 ```javascript
 const transferSchema = new Schema({
-  token: {
-    type: String,
-    length: 50
-  },
-  mdp: {
-    type: String,
-    length: 15
-  }
+    token: {
+        type: String,
+        length: 50
+    },
+    mdp: {
+        type: String,
+        length: 15
+    }
 });
 ```
 ## Class Model

package/index.d.ts

@@ -21,6 +21,8 @@ export interface SchemaField {
     unique?: boolean;
     auto_increment?: boolean;
     foreignKey?: string;
+    enum?: string[];
+    primary_key?: boolean;
     customize?: string;
 }
 

package/index.js

@@ -338,7 +338,13 @@ class Model {
             if (field.type && typeof field == "object") {
                 if (!sqlTypeMap[fieldType]) throw new Error(`Field ${fieldName} has unsupported type ${fieldType}.`);
 
-                let columnDefinition = `${fieldName} ${sqlTypeMap[fieldType]}${sqlTypeMap[fieldType] == "VARCHAR" || sqlTypeMap[fieldType] == "INT" ? `(${field.length > 0 ? field.length : lengthDefault})` : ""}`;
+                let columnDefinition = "";
+                if (Array.isArray(field.enum) && field.enum.length > 0) {
+                    const enumValues = field.enum.map(v => `'${v.replace(/'/g, "''")}'`).join(", ");
+                    columnDefinition = `${fieldName} ENUM(${enumValues})`;
+                } else {
+                    columnDefinition = `${fieldName} ${sqlTypeMap[fieldType]}${sqlTypeMap[fieldType] == "VARCHAR" || sqlTypeMap[fieldType] == "INT" ? `(${field.length > 0 ? field.length : lengthDefault})` : ""}`;
+                }
 
                 if (field.required) columnDefinition += ' NOT NULL';
                 if (field.default !== undefined && field.default != null) columnDefinition += ` DEFAULT "${field.default}"`;
@@ -346,6 +352,7 @@ class Model {
                 if (field.unique) columnDefinition += ' UNIQUE';
                 if (field.auto_increment) columnDefinition += ' AUTO_INCREMENT';
                 if (field.foreignKey) foreignKey.push(`FOREIGN KEY (${fieldName}) REFERENCES ${field.foreignKey}`);
+                if (field.primary_key) columnDefinition += ' PRIMARY KEY';
                 if (typeof field.customize === 'string' && field.customize.length != 0) columnDefinition += ` ${field.customize}`;
                 return columnDefinition;
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mlagie/sql-connector",
-  "version": "1.0.2",
+  "version": "1.0.3-beta",
   "description": "Le module sql-connector permet de gérer les connexions à une base de données MySQL, de définir des schémas de tables, et d'interagir avec les données de manière simple et efficace.",
   "main": "index.js",
   "scripts": {