== Naming Convention ==

=== Constants ===

ROW_VALUE_DESCRIPTION_COLUMN_NAME_TABLE_NAME

==== CFI ====
* ObjectType
::- DESCRIPTION_EN_OBJECT_TYPE_CODE
* [Table]Type
:: DESCRIPTION_EN_[TABLENAME]_TYPE_CODE
::i.e (FileType - MotionType - Code MOTION_FILE_TYPE_CODE)

== Handling Service Response ==
Standards how to handle service response.
Every main in any app will have algo asi:
<pre>
async request(params, { transition = false, showMsg = true, setStatus = undefined, fullResponse = false } = {}) {
const serverResponse = await httpRequest(params, setStatus, REQUEST_BRIDGE_SERVICE);
if (!serverResponse?.success) console.error(serverResponse?.errorMsg ?? 'Backend service NULL');
return serverResponse?.success
? Promise.resolve(fullResponse
? serverResponse
: serverResponse.response)
: Promise.reject(serverResponse);
}
</pre>
Por eso in the services should be handled like this:

<pre>
[service]
.then((response) => {
// Handle successful service
})
.catch((err) => {
console.log("Error: ", err);
// Handle not successful service
});
</pre>

== Parameters ==

=== Javascript ===
Function, classes and methods...
<pre>
/**
* @param {AppProps} parentProps
* @param {object} settings
**/
name(parentProps, {} = {}) {

}
</pre>

Where settings means all other props.

=== PHP ===
== PHP Service Function Guidelines ==

Every PHP service function should follow these rules:

* It must be in its own file.
* The file name and the function name should be the same.
* It should return: <code>Closure::fromCallable('file_or_function_name')</code>
* The function must include the standard service header.
<pre>
/**
* example.php
* @author [FirstName LastName] <firstName.lastName@seedburysquare.com>
* @copyright Seedbury Square, LLC. All Rights Reserved.
*
* @version YYYY-MM-DD Initial Version
*/
</pre>
* Inside the function, include the following structure:
** A validation section
<pre>
$validation = validateExampleParams($params);
if (!$validation['success']) return $validation;
</pre>
** The service logic (body)
** A return statement that returns a <code>uniformReturnObject</code>

Additionally, everything inside the function should be wrapped in a <code>try-catch</code> block.

In the <code>catch</code> block:
* Log the error using <code>error_log()</code>
* Return a <code>uniformReturnObject</code> where:
** <code>success</code> is set to <code>false</code>
** <code>errorMsg</code> and <code>displayDialog</code> contain the value of <code>$error->getMessage()</code>
<pre>
catch (\Throwable $e) {
error_log($e);
return uniformReturnObject(false, null, $e->getMessage(), $e->getMessage());
}
</pre>

<pre>
<?php

/**
* example.php
* @author [FirstName LastName] <firstName.lastName@seedburysquare.com>
* @copyright Seedbury Square, LLC. All Rights Reserved.
*
* @version YYYY-MM-DD Initial Version
*/

return Closure::fromCallable('example');
function example($params, $dbDriver = null)
{
try {
$validation = validateExampleParams($params);
if (!$validation['success']) return $validation;
$commit = !$dbDriver;
$dbDriver = $dbDriver ?? new DatabaseDriver([DATABASE_CONNECTION_CONSTANT], false);

if ($commit) $dbDriver->commit();
$response = [];
return uniformReturnObject(
$response['success'],
$response['success'] ? $response['result'] : null,
$response['success'] ? false : $response['errorMsg'],
$response['success'] ? false : $response['errorMsg']
);
} catch (\Throwable $e) {
error_log($e);
return uniformReturnObject(false, null, $e->getMessage(), $e->getMessage());
}
};
function validateExampleParams($params)
{
$errors = [];
if (!isset($params['sessionDetails'])) $errors[] = '<li>sessionDetails is not set</li>';
$mandatory = [];
foreach ($mandatory as $prop) {
if (!isset($params[$prop])) {
$errors[] = "<li>Missing: $prop</li>";
}
}
$success = empty($errors);
$errorMsg = 'example Errors: <ol>' . implode('', $errors) . '</ol>';
return uniformReturnObject(
$success,
null,
$success ? null : $errorMsg,
$success ? null : $errorMsg
);
}
</pre>

Programming Standards

== Welcome to the Seedbury Wiki ==

Behave or be sent to [https://wiki.seedburysquare.com/index.php/The_Dungeon the dungeon].

== Overview ==

Established in 2016, '''Seedbury Square''' has grown to become a mayor player in the development of custom web-based application space. Clients range from the public to the private sector with some of the platforms supporting complete professions.

== Development Standards ==
Seedbury Square uses these [https://wiki.seedburysquare.com/index.php/Programming_Standards programming standards]

== Active Projects ==
From all the [https://wiki.seedburysquare.com/index.php/Projects projects] developed by Seedbury Square, these are actively being developed or maintained as of 2025.
=== [https://wiki.seedburysquare.com/index.php/Ksitropy Ksitropy] ===
The everything app.
=== [https://wiki.seedburysquare.com/index.php/SUMAC Sistema Unificado de Manejo y Administración de Casos (SUMAC)] ===
Contains the following projects:
* Court of First Instance (CFI)
** Judges
** Admin
* Court of Appeals (COA)
** Judges
** Admin
* Supreme Court (SC)
** Judges
** Admin
* Attorney
* Clerk

== Technologies Used ==
=== Frontend ===
* Frameworks: (project-dependent)
** [https://mozilla.github.io/pdf.js/ PDF.JS]
** [https://pdf-lib.js.org/ pdf-lib]
** [https://www.tiny.cloud/tinymce/ TinyMCE]
** [https://wiki.seedburysquare.com/index.php/SeedburySquareFrameworkBrrrrr Proprietary Framework]
* Styling
** Vanilla CSS
* Code style
** Default [https://code.visualstudio.com/ VSCode] Settings conventions
* Folder structure
** Modular
** Reusable components
* Testing: Try and break it testing
* Version control: Git with feature-branch workflow

=== Backend ===
* Languages
** Node.js
** PHP (based on project needs)
* Frameworks
** [https://www.setasign.com/products/setapdf-core/details/ SetaPDF-Core]
** [https://www.setasign.com/products/setapdf-stamper/details/ SetaPDF-Stamper]
** [https://www.setasign.com/products/fpdi/about/ FPDI] (based on project needs)
* Architecture: RESTful APIs (where applicable)
* Database
** MSSQL
** MariaDB
** Neo4J
* Authentication: IDK
* Logging: Still Don't konw
* Testing: Try and break it testing
* CI/CD: I don't know what this means.

== New Employee Setup Procedure ==

=== Hardware/Access Setup ===

# Provide oldest computer available.
::- New Computers are only for older employees.
# Create company email and communication accounts (Slack, Google Workspace, etc.)
# Provide access to repositories (GitHub/GitLab), project boards (Jira/Trello), and documentation

=== Software Installation ===
# Install development tools: VS Code, Docker, Postman, etc.
# Clone required repositories
# Follow README or internal docs to set up dev environment
# Join onboarding session with team lead or HR

=== Onboarding Checklist ===
* [ ] NDA signed and uploaded
* [ ] Accounts created
* [ ] Introductory meeting scheduled
* [ ] Onboarding tasks assigned in project management tool
* [ ] Dev environment verified and working

== See Also ==
* [[Project Alpha Documentation]]
* [[Employee Onboarding Checklist]]
* [[Tech Stack Overview]]

== Helpful Tools ==
* [[VSCode Snippets]]

== External Links ==
* [https://www.seedburysquare.com/ Official Website]
* [https://github.com/SeedburySquare GitHub Organization]

VSCode Snippets

2025-03-31T19:02:58Z

Jcm-seedburry: /* PHP */

VSCode Snippets

2025-03-31T18:57:17Z

2025-03-31T18:49:16Z

Jcm-seedburry:

== Javascript ==
* Class Author
<pre>
{
"classAuthorJS": {
"scope": "javascript,typescript",
"prefix": "class",
"body": [
"/**",
"* $TM_FILENAME_BASE.js",
"* @author [FirstName LastName] <firstName.lastName@seedburysquare.com>",
"* @copyright Seedbury Square, LLC. All Rights Reserved.",
"*",
"* @version $CURRENT_YEAR-$CURRENT_MONTH_NAME-$CURRENT_DATE Initial Version",
"*/",
"",
"export class $TM_FILENAME_BASE{",
"constructor(){",
"this.view = setElementClassList(getElementContainer(), '${TM_FILENAME_BASE/^(.)(.*)/${1:/downcase}${2}/}__view');",
"$1",
"}",
"}"
],
"description": "Heading for new JS File"
}
}
</pre>

* console.log() ([[Cristian Lopez]] delete before pushing code)
<pre>
{
"console.log()": {
"scope": "javascript,typescript, jsx, tsx",
"prefix": "cl",
"body": [
"console.log($1);"
],
"description": "console.log();"
}
}
</pre>

VSCode Snippets

2025-03-31T18:47:23Z

Jcm-seedburry: