Update types

package-shared/types/database-schema.td.js

@@ -16,9 +16,15 @@
  * @property {string} [dbDescription] - Database brief description
  * @property {string} [dbImage] - Database image - Defaults to "/images/default.png"
  * @property {DSQL_TableSchemaType[]} tables - List of database tables
- * @property {{ dbFullName: string }[]} [childrenDatabases] - List of children databases for current database which is parent
+ * @property {DSQL_ChildrenDatabaseObject[]} [childrenDatabases] - List of children databases for current database which is parent
  * @property {boolean} [childDatabase] - If current database is a child of a different parent database
  * @property {string} [childDatabaseDbFullName] - Parent database full name => "datasquirel_user_7_new_database"
+ * @property {boolean} [updateData] - Should the child database data update when the parent database data is updated?
+ */
+
+/**
+ * @typedef {object} DSQL_ChildrenDatabaseObject
+ * @property {string} dbFullName - Database Full name => "datasquirel_user_4_db_name"
  */
 
 ////////////////////////////////////////
@@ -32,6 +38,7 @@
  * @property {DSQL_IndexSchemaType[]} [indexes] - List of table indexes, if available
  * @property {DSQL_ChildrenTablesType[]} [childrenTables] - List of children tables
  * @property {boolean} [childTable] -If current table is a child clone
+ * @property {boolean} [updateData] -If the current table data updates with the parent table
  * @property {string} [childTableName] - Table slug of parent table => "blog_posts"
  * @property {string} [childTableDbFullName] - Database full name(slug) including datasquirel data => "datasquirel_user_7_new_database"
  * @property {string} [tableNameOld] - Old table name, incase of renaming table
@@ -41,16 +48,17 @@
  * @typedef {object} DSQL_ChildrenTablesType
  * @property {string} dbNameFull - Database full name(slug) including datasquirel data => "datasquirel_user_7_new_database"
  * @property {string} tableName - Table slug => "blog_posts"
+ * @property {string} [tableNameFull]
  */
 
 ////////////////////////////////////////
 
 /**
  * @typedef {object} DSQL_FieldSchemaType
- * @property {string} fieldName - Field Name(slug) => "long_description"
+ * @property {string} [fieldName] - Field Name(slug) => "long_description"
  * @property {string} [originName] - Field origin name(optional)
  * @property {boolean} [updatedField] - Has this field been renamed?
- * @property {string} dataType - Field Data type => "BIGIN" | "LONGTEXT" | "VARCHAR(***)" | ...
+ * @property {string} [dataType] - Field Data type => "BIGIN" | "LONGTEXT" | "VARCHAR(***)" | ...
  * @property {boolean} [nullValue] - Is this a null value or not?
  * @property {boolean} [notNullValue] - Is this NOT a null value?
  * @property {boolean} [primaryKey] - Is this the primary key for table?
@@ -60,16 +68,31 @@
  * @property {string} [defaultValueLiteral] - SQL key word which generates value automatically => "CURRENT_TIMESTAMP"
  * @property {DSQL_ForeignKeyType} [foreignKey] - Field foreign key reference object
  * @property {boolean} [richText] - Rich text field
- * @property {string | RegExp} [pattern] - Field pattern for validation. Can be a string or a regular expression. Example: "^[a-zA-Z0-9_]*$"
- * @property {string} [patternFlags] - Field pattern flags for validation. Example: "i"
+ * @property {boolean} [json]
+ * @property {boolean} [yaml]
+ * @property {boolean} [html]
+ * @property {boolean} [css]
+ * @property {boolean} [javascript]
+ * @property {boolean} [shell]
+ * @property {boolean} [newTempField]
+ * @property {boolean} [defaultField]
+ * @property {boolean} [plainText]
+ * @property {boolean} [unique]
+ * @property {string} [pattern]
+ * @property {string} [patternFlags]
+ * @property {string} [onUpdate]
+ * @property {string} [onUpdateLiteral]
+ * @property {string} [onDelete]
+ * @property {string} [onDeleteLiteral]
+ * @property {string[]} [cssFiles]
  */
 
 /**
  * @typedef {object} DSQL_ForeignKeyType
- * @property {string} foreignKeyName - Unique Name of foreign key
- * @property {string} destinationTableName - Reference table name(slug) => "blog_posts"
- * @property {string} destinationTableColumnName - Reference column name(slug) => "id"
- * @property {string} destinationTableColumnType - Reference table field type => "BIGINT" | "VARCHAR(***)" | ...
+ * @property {string} [foreignKeyName] - Unique Name of foreign key
+ * @property {string} [destinationTableName] - Reference table name(slug) => "blog_posts"
+ * @property {string} [destinationTableColumnName] - Reference column name(slug) => "id"
+ * @property {string} [destinationTableColumnType] - Reference table field type => "BIGINT" | "VARCHAR(***)" | ...
  * @property {boolean} [cascadeDelete] - Does the reference table entry delete when this key is deleted?
  * @property {boolean} [cascadeUpdate] - Does the reference table entry update when this key is updated?
  */
@@ -78,10 +101,11 @@
 
 /**
  * @typedef {object} DSQL_IndexSchemaType
- * @property {string} indexName - Unique Name of index => "blog_text_index"
- * @property {string} indexType - "regular" or "fullText"
- * @property {DSQL_IndexTableFieldType[]} indexTableFields - List of Index table fields
+ * @property {string} [indexName] - Unique Name of index => "blog_text_index"
+ * @property {string} [indexType] - "regular" or "fullText"
+ * @property {DSQL_IndexTableFieldType[]} [indexTableFields] - List of Index table fields
  * @property {string} [alias] - List of Index table fields
+ * @property {boolean} [newTempIndex]
  */
 
 /**
@@ -89,7 +113,3 @@
  * @property {string} value - Table Field Name
  * @property {string} dataType - Table Field data type "VARCHAR(***)" | "BIGINT" | ...
  */
-
-////////////////////////////////////////
-
-exports.DSQL_TableSchemaType = DSQL_TableSchemaType;

package-shared/types/package-shared-index.js

@@ -11,7 +11,7 @@
  * @property {string} [email_login_field]
  * @property {boolean} [token]
  * @property {boolean} [social]
- * @property {import("./database-schema.td").DSQL_DatabaseSchemaType} [dbSchema]
+ * @property {DSQL_DatabaseSchemaType} [dbSchema]
  */
 
 /**
@@ -23,5 +23,14 @@
  * @property {string} [email_login_field]
  * @property {boolean} [token]
  * @property {boolean} [social]
- * @property {import("./database-schema.td").DSQL_DatabaseSchemaType} [dbSchema]
+ * @property {DSQL_DatabaseSchemaType} [dbSchema]
+ */
+
+/**
+ * @typedef {Object} GetReturn
+ * @property {boolean} success - Did the function run successfully?
+ * @property {*} [payload] - GET request results
+ * @property {string} [msg] - Message
+ * @property {string} [error] - Error Message
+ * @property {DSQL_TableSchemaType} [schema] - Error Message
  */