From 6593047efd67f7fa42c6f94f2f2d2243dd85bb31 Mon Sep 17 00:00:00 2001 From: Benjamin Toby Date: Fri, 18 Apr 2025 12:06:15 +0100 Subject: [PATCH] Updates --- dist/client/auth/github/getAccessToken.d.ts | 13 + dist/client/auth/google/getAccessToken.d.ts | 18 + dist/client/auth/logout.d.ts | 8 + dist/client/auth/post-login.d.ts | 9 + dist/client/fetch/index.d.ts | 21 + dist/client/index.d.ts | 55 + dist/client/media/client.d.ts | 14 + dist/client/media/imageInputFileToBase64.d.ts | 11 + dist/client/media/imageInputToBase64.d.ts | 15 + dist/client/media/inputFileToBase64.d.ts | 21 + dist/client/utils/parseClientCookies.d.ts | 8 + dist/console-colors.d.ts | 28 + dist/engine/dsql.d.ts | 2 + dist/engine/dump.d.ts | 2 + dist/engine/schema-to-typedef.d.ts | 2 + dist/index.d.ts | 146 ++ dist/package-shared/actions/delete-file.d.ts | 18 + .../actions/get-csrf-header-name.d.ts | 1 + dist/package-shared/actions/get-schema.d.ts | 10 + dist/package-shared/actions/get.d.ts | 25 + dist/package-shared/actions/post.d.ts | 15 + dist/package-shared/actions/upload-file.d.ts | 23 + dist/package-shared/actions/upload-image.d.ts | 25 + .../actions/users/add-user.d.ts | 15 + .../actions/users/delete-user.d.ts | 12 + .../actions/users/get-token.d.ts | 20 + .../actions/users/get-user.d.ts | 13 + .../actions/users/login-user.d.ts | 37 + .../actions/users/logout-user.d.ts | 24 + .../actions/users/reauth-user.d.ts | 20 + .../actions/users/send-email-code.d.ts | 23 + .../actions/users/social/github-auth.d.ts | 35 + .../actions/users/social/google-auth.d.ts | 22 + .../actions/users/update-user.d.ts | 15 + .../actions/users/user-auth.d.ts | 28 + .../users/validate-temp-email-code.d.ts | 14 + .../actions/users/validate-token.d.ts | 15 + .../external-services/arcjet/index.d.ts | 0 .../functions/api/query/get.d.ts | 25 + .../functions/api/query/post.d.ts | 16 + .../api/social-login/facebookLogin.d.ts | 8 + .../api/social-login/githubLogin.d.ts | 43 + .../api/social-login/googleLogin.d.ts | 22 + .../api/social-login/handleSocialDb.d.ts | 5 + .../api/social-login/loginSocialUser.d.ts | 22 + .../functions/api/users/api-create-user.d.ts | 25 + .../functions/api/users/api-delete-user.d.ts | 14 + .../functions/api/users/api-get-user.d.ts | 5 + .../functions/api/users/api-login.d.ts | 5 + .../functions/api/users/api-reauth-user.d.ts | 13 + .../api/users/api-send-email-code.d.ts | 22 + .../functions/api/users/api-update-user.d.ts | 18 + .../reset-password/(utils)/encrypt-url.d.ts | 11 + .../api-send-reset-password-link.d.ts | 22 + .../api/users/social/api-github-login.d.ts | 17 + .../api/users/social/api-google-login.d.ts | 5 + .../backend/addAdminUserOnLogin.d.ts | 20 + .../functions/backend/addMariadbUser.d.ts | 8 + .../functions/backend/addUsersTableToDb.d.ts | 12 + .../functions/backend/api-cred.d.ts | 6 + .../backend/auth/write-auth-files.d.ts | 29 + .../cookies/get-auth-cookie-names.d.ts | 14 + .../functions/backend/db/addDbEntry.d.ts | 20 + .../functions/backend/db/deleteDbEntry.d.ts | 16 + .../backend/db/pathTraversalCheck.d.ts | 5 + .../functions/backend/db/runQuery.d.ts | 21 + .../functions/backend/db/sanitizeSql.d.ts | 8 + .../functions/backend/db/updateDbEntry.d.ts | 19 + .../functions/backend/dbHandler.d.ts | 4 + .../backend/defaultFieldsRegexp.d.ts | 7 + .../backend/fullAccessDbHandler.d.ts | 11 + .../backend/grabNewUsersTableSchema.d.ts | 9 + .../backend/grabSchemaFieldsFromData.d.ts | 16 + .../functions/backend/grabUserSchemaData.d.ts | 6 + .../functions/backend/handleNodemailer.d.ts | 11 + .../backend/html/sanitizeHtmlOptions.d.ts | 9 + .../functions/backend/httpRequest.d.ts | 13 + .../functions/backend/httpsRequest.d.ts | 15 + .../backend/noDatabaseDbHandler.d.ts | 4 + .../functions/backend/parseDbResults.d.ts | 13 + .../functions/backend/queues/add-queue.d.ts | 10 + .../backend/queues/delete-queue.d.ts | 6 + .../functions/backend/queues/get-queue.d.ts | 10 + .../backend/queues/update-queue.d.ts | 7 + .../functions/backend/serverError.d.ts | 18 + .../functions/backend/setUserSchemaData.d.ts | 10 + .../functions/backend/suSocketAuth.d.ts | 8 + .../backend/updateUsersTableSchema.d.ts | 13 + .../backend/varDatabaseDbHandler.d.ts | 12 + .../backend/varReadOnlyDatabaseDbHandler.d.ts | 12 + .../functions/dsql/db-schema-to-type.d.ts | 6 + .../functions/dsql/decrypt.d.ts | 10 + .../functions/dsql/default-fields-regexp.d.ts | 7 + .../functions/dsql/encrypt.d.ts | 10 + .../dsql/generate-type-definitions.d.ts | 11 + .../functions/dsql/hashPassword.d.ts | 9 + .../dsql/sql/sql-delete-generator.d.ts | 13 + .../functions/dsql/sql/sql-generator.d.ts | 24 + .../dsql/sql/sql-insert-generator.d.ts | 13 + .../functions/email/fns/validate-email.d.ts | 10 + .../email/verification/email-mx-lookup.d.ts | 1 + .../email/verification/email-regex-test.d.ts | 1 + .../email/verification/smtp-verification.d.ts | 1 + dist/package-shared/shell/checkDb.d.ts | 1 + .../createDbFromSchema/check-db-record.d.ts | 12 + .../check-table-record.d.ts | 15 + .../createDbFromSchema/handle-indexes.d.ts | 14 + .../shell/createDbFromSchema/index.d.ts | 11 + dist/package-shared/shell/deploy.d.ts | 1 + dist/package-shared/shell/encodingUpdate.d.ts | 1 + .../shell/functions/jsonToBase64.d.ts | 1 + .../shell/grantFullPriviledges.d.ts | 1 + dist/package-shared/shell/lessWatch.d.ts | 1 + .../shell/mariadb-users/handleGrants.d.ts | 16 + .../mariadb-users/refreshUsersAndGrants.d.ts | 11 + .../mariadb-users/resetSQLPasswords.d.ts | 1 + .../mariadb-users/users/create-user.d.ts | 1 + .../mariadb-users/users/update-user.d.ts | 1 + dist/package-shared/shell/readImage.d.ts | 1 + .../shell/recoverMainJsonFromDb.d.ts | 1 + .../shell/resetSQLCredentials.d.ts | 1 + .../shell/resetSQLCredentialsPasswords.d.ts | 1 + .../shell/scripts/convert-js-to-ts.d.ts | 1 + .../shell/setSQLCredentials.d.ts | 1 + dist/package-shared/shell/tailwindWatch.d.ts | 1 + .../shell/test-external-server.d.ts | 1 + dist/package-shared/shell/testSQLEscape.d.ts | 10 + .../shell/updateChildrenTablesOnDb.d.ts | 1 + .../shell/updateDateTimestamps.d.ts | 1 + .../shell/updateDbSlugsForTableRecords.d.ts | 1 + dist/package-shared/shell/updateSSLUsers.d.ts | 1 + .../shell/utils/camelJoinedtoCamelSpace.d.ts | 7 + .../shell/utils/createTable.d.ts | 13 + .../package-shared/shell/utils/dbHandler.d.ts | 10 + .../utils/generateColumnDescription.d.ts | 13 + .../shell/utils/noDatabaseDbHandler.d.ts | 1 + .../shell/utils/slugToCamelTitle.d.ts | 4 + .../shell/utils/supplementTable.d.ts | 14 + .../shell/utils/updateTable.d.ts | 19 + .../shell/utils/varDatabaseDbHandler.d.ts | 9 + dist/package-shared/types/dsql.d.ts | 309 ++++ dist/package-shared/types/index.d.ts | 1407 +++++++++++++++++ .../backend/export-mariadb-database.d.ts | 8 + .../utils/backend/global-db/DB_HANDLER.d.ts | 5 + .../global-db/DSQL_USER_DB_HANDLER.d.ts | 10 + .../backend/global-db/LOCAL_DB_HANDLER.d.ts | 4 + .../backend/global-db/NO_DB_HANDLER.d.ts | 7 + .../backend/global-db/ROOT_DB_HANDLER.d.ts | 7 + .../utils/backend/grabDbSSL.d.ts | 8 + .../backend/import-mariadb-database.d.ts | 8 + .../utils/backend/names/grab-dir-names.d.ts | 34 + .../names/replace-datasquirel-db-name.d.ts | 6 + .../utils/backend/parseCookies.d.ts | 16 + .../utils/camelJoinedtoCamelSpace.d.ts | 7 + .../utils/check-if-is-master.d.ts | 6 + dist/package-shared/utils/console-colors.d.ts | 55 + .../utils/data-fetching/crud.d.ts | 9 + .../utils/data-fetching/method-crud.d.ts | 21 + .../utils/db/conn-db-handler.d.ts | 25 + .../utils/deserialize-query.d.ts | 8 + dist/package-shared/utils/ejson.d.ts | 17 + dist/package-shared/utils/empty-dir.d.ts | 1 + dist/package-shared/utils/endConnection.d.ts | 6 + .../utils/generateColumnDescription.d.ts | 21 + .../utils/grab-cookie-expirt-date.d.ts | 1 + .../utils/grab-db-full-name.d.ts | 9 + .../utils/grab-dsql-connection.d.ts | 24 + .../package-shared/utils/grab-host-names.d.ts | 19 + dist/package-shared/utils/grab-keys.d.ts | 19 + .../utils/grab-query-and-values.d.ts | 19 + .../utils/logging/debug-log.d.ts | 25 + dist/package-shared/utils/numberfy.d.ts | 10 + dist/package-shared/utils/parse-env.d.ts | 3 + .../utils/serialize-cookies.d.ts | 8 + .../package-shared/utils/serialize-query.d.ts | 4 + .../utils/slugToCamelTitle.d.ts | 4 + dist/package-shared/utils/slugify.d.ts | 9 + dist/package-shared/utils/trim-sql.d.ts | 5 + package.json | 2 +- tsconfig.json | 2 +- 180 files changed, 3965 insertions(+), 2 deletions(-) create mode 100644 dist/client/auth/github/getAccessToken.d.ts create mode 100644 dist/client/auth/google/getAccessToken.d.ts create mode 100644 dist/client/auth/logout.d.ts create mode 100644 dist/client/auth/post-login.d.ts create mode 100644 dist/client/fetch/index.d.ts create mode 100644 dist/client/index.d.ts create mode 100644 dist/client/media/client.d.ts create mode 100644 dist/client/media/imageInputFileToBase64.d.ts create mode 100644 dist/client/media/imageInputToBase64.d.ts create mode 100644 dist/client/media/inputFileToBase64.d.ts create mode 100644 dist/client/utils/parseClientCookies.d.ts create mode 100644 dist/console-colors.d.ts create mode 100644 dist/engine/dsql.d.ts create mode 100644 dist/engine/dump.d.ts create mode 100644 dist/engine/schema-to-typedef.d.ts create mode 100644 dist/index.d.ts create mode 100644 dist/package-shared/actions/delete-file.d.ts create mode 100644 dist/package-shared/actions/get-csrf-header-name.d.ts create mode 100644 dist/package-shared/actions/get-schema.d.ts create mode 100644 dist/package-shared/actions/get.d.ts create mode 100644 dist/package-shared/actions/post.d.ts create mode 100644 dist/package-shared/actions/upload-file.d.ts create mode 100644 dist/package-shared/actions/upload-image.d.ts create mode 100644 dist/package-shared/actions/users/add-user.d.ts create mode 100644 dist/package-shared/actions/users/delete-user.d.ts create mode 100644 dist/package-shared/actions/users/get-token.d.ts create mode 100644 dist/package-shared/actions/users/get-user.d.ts create mode 100644 dist/package-shared/actions/users/login-user.d.ts create mode 100644 dist/package-shared/actions/users/logout-user.d.ts create mode 100644 dist/package-shared/actions/users/reauth-user.d.ts create mode 100644 dist/package-shared/actions/users/send-email-code.d.ts create mode 100644 dist/package-shared/actions/users/social/github-auth.d.ts create mode 100644 dist/package-shared/actions/users/social/google-auth.d.ts create mode 100644 dist/package-shared/actions/users/update-user.d.ts create mode 100644 dist/package-shared/actions/users/user-auth.d.ts create mode 100644 dist/package-shared/actions/users/validate-temp-email-code.d.ts create mode 100644 dist/package-shared/actions/users/validate-token.d.ts create mode 100644 dist/package-shared/external-services/arcjet/index.d.ts create mode 100644 dist/package-shared/functions/api/query/get.d.ts create mode 100644 dist/package-shared/functions/api/query/post.d.ts create mode 100644 dist/package-shared/functions/api/social-login/facebookLogin.d.ts create mode 100644 dist/package-shared/functions/api/social-login/githubLogin.d.ts create mode 100644 dist/package-shared/functions/api/social-login/googleLogin.d.ts create mode 100644 dist/package-shared/functions/api/social-login/handleSocialDb.d.ts create mode 100644 dist/package-shared/functions/api/social-login/loginSocialUser.d.ts create mode 100644 dist/package-shared/functions/api/users/api-create-user.d.ts create mode 100644 dist/package-shared/functions/api/users/api-delete-user.d.ts create mode 100644 dist/package-shared/functions/api/users/api-get-user.d.ts create mode 100644 dist/package-shared/functions/api/users/api-login.d.ts create mode 100644 dist/package-shared/functions/api/users/api-reauth-user.d.ts create mode 100644 dist/package-shared/functions/api/users/api-send-email-code.d.ts create mode 100644 dist/package-shared/functions/api/users/api-update-user.d.ts create mode 100644 dist/package-shared/functions/api/users/reset-password/(utils)/encrypt-url.d.ts create mode 100644 dist/package-shared/functions/api/users/reset-password/api-send-reset-password-link.d.ts create mode 100644 dist/package-shared/functions/api/users/social/api-github-login.d.ts create mode 100644 dist/package-shared/functions/api/users/social/api-google-login.d.ts create mode 100644 dist/package-shared/functions/backend/addAdminUserOnLogin.d.ts create mode 100644 dist/package-shared/functions/backend/addMariadbUser.d.ts create mode 100644 dist/package-shared/functions/backend/addUsersTableToDb.d.ts create mode 100644 dist/package-shared/functions/backend/api-cred.d.ts create mode 100644 dist/package-shared/functions/backend/auth/write-auth-files.d.ts create mode 100644 dist/package-shared/functions/backend/cookies/get-auth-cookie-names.d.ts create mode 100644 dist/package-shared/functions/backend/db/addDbEntry.d.ts create mode 100644 dist/package-shared/functions/backend/db/deleteDbEntry.d.ts create mode 100644 dist/package-shared/functions/backend/db/pathTraversalCheck.d.ts create mode 100644 dist/package-shared/functions/backend/db/runQuery.d.ts create mode 100644 dist/package-shared/functions/backend/db/sanitizeSql.d.ts create mode 100644 dist/package-shared/functions/backend/db/updateDbEntry.d.ts create mode 100644 dist/package-shared/functions/backend/dbHandler.d.ts create mode 100644 dist/package-shared/functions/backend/defaultFieldsRegexp.d.ts create mode 100644 dist/package-shared/functions/backend/fullAccessDbHandler.d.ts create mode 100644 dist/package-shared/functions/backend/grabNewUsersTableSchema.d.ts create mode 100644 dist/package-shared/functions/backend/grabSchemaFieldsFromData.d.ts create mode 100644 dist/package-shared/functions/backend/grabUserSchemaData.d.ts create mode 100644 dist/package-shared/functions/backend/handleNodemailer.d.ts create mode 100644 dist/package-shared/functions/backend/html/sanitizeHtmlOptions.d.ts create mode 100644 dist/package-shared/functions/backend/httpRequest.d.ts create mode 100644 dist/package-shared/functions/backend/httpsRequest.d.ts create mode 100644 dist/package-shared/functions/backend/noDatabaseDbHandler.d.ts create mode 100644 dist/package-shared/functions/backend/parseDbResults.d.ts create mode 100644 dist/package-shared/functions/backend/queues/add-queue.d.ts create mode 100644 dist/package-shared/functions/backend/queues/delete-queue.d.ts create mode 100644 dist/package-shared/functions/backend/queues/get-queue.d.ts create mode 100644 dist/package-shared/functions/backend/queues/update-queue.d.ts create mode 100644 dist/package-shared/functions/backend/serverError.d.ts create mode 100644 dist/package-shared/functions/backend/setUserSchemaData.d.ts create mode 100644 dist/package-shared/functions/backend/suSocketAuth.d.ts create mode 100644 dist/package-shared/functions/backend/updateUsersTableSchema.d.ts create mode 100644 dist/package-shared/functions/backend/varDatabaseDbHandler.d.ts create mode 100644 dist/package-shared/functions/backend/varReadOnlyDatabaseDbHandler.d.ts create mode 100644 dist/package-shared/functions/dsql/db-schema-to-type.d.ts create mode 100644 dist/package-shared/functions/dsql/decrypt.d.ts create mode 100644 dist/package-shared/functions/dsql/default-fields-regexp.d.ts create mode 100644 dist/package-shared/functions/dsql/encrypt.d.ts create mode 100644 dist/package-shared/functions/dsql/generate-type-definitions.d.ts create mode 100644 dist/package-shared/functions/dsql/hashPassword.d.ts create mode 100644 dist/package-shared/functions/dsql/sql/sql-delete-generator.d.ts create mode 100644 dist/package-shared/functions/dsql/sql/sql-generator.d.ts create mode 100644 dist/package-shared/functions/dsql/sql/sql-insert-generator.d.ts create mode 100644 dist/package-shared/functions/email/fns/validate-email.d.ts create mode 100644 dist/package-shared/functions/email/verification/email-mx-lookup.d.ts create mode 100644 dist/package-shared/functions/email/verification/email-regex-test.d.ts create mode 100644 dist/package-shared/functions/email/verification/smtp-verification.d.ts create mode 100644 dist/package-shared/shell/checkDb.d.ts create mode 100644 dist/package-shared/shell/createDbFromSchema/check-db-record.d.ts create mode 100644 dist/package-shared/shell/createDbFromSchema/check-table-record.d.ts create mode 100644 dist/package-shared/shell/createDbFromSchema/handle-indexes.d.ts create mode 100644 dist/package-shared/shell/createDbFromSchema/index.d.ts create mode 100644 dist/package-shared/shell/deploy.d.ts create mode 100644 dist/package-shared/shell/encodingUpdate.d.ts create mode 100644 dist/package-shared/shell/functions/jsonToBase64.d.ts create mode 100644 dist/package-shared/shell/grantFullPriviledges.d.ts create mode 100644 dist/package-shared/shell/lessWatch.d.ts create mode 100644 dist/package-shared/shell/mariadb-users/handleGrants.d.ts create mode 100644 dist/package-shared/shell/mariadb-users/refreshUsersAndGrants.d.ts create mode 100644 dist/package-shared/shell/mariadb-users/resetSQLPasswords.d.ts create mode 100644 dist/package-shared/shell/mariadb-users/users/create-user.d.ts create mode 100644 dist/package-shared/shell/mariadb-users/users/update-user.d.ts create mode 100644 dist/package-shared/shell/readImage.d.ts create mode 100644 dist/package-shared/shell/recoverMainJsonFromDb.d.ts create mode 100644 dist/package-shared/shell/resetSQLCredentials.d.ts create mode 100644 dist/package-shared/shell/resetSQLCredentialsPasswords.d.ts create mode 100644 dist/package-shared/shell/scripts/convert-js-to-ts.d.ts create mode 100644 dist/package-shared/shell/setSQLCredentials.d.ts create mode 100644 dist/package-shared/shell/tailwindWatch.d.ts create mode 100644 dist/package-shared/shell/test-external-server.d.ts create mode 100644 dist/package-shared/shell/testSQLEscape.d.ts create mode 100644 dist/package-shared/shell/updateChildrenTablesOnDb.d.ts create mode 100644 dist/package-shared/shell/updateDateTimestamps.d.ts create mode 100644 dist/package-shared/shell/updateDbSlugsForTableRecords.d.ts create mode 100644 dist/package-shared/shell/updateSSLUsers.d.ts create mode 100644 dist/package-shared/shell/utils/camelJoinedtoCamelSpace.d.ts create mode 100644 dist/package-shared/shell/utils/createTable.d.ts create mode 100644 dist/package-shared/shell/utils/dbHandler.d.ts create mode 100644 dist/package-shared/shell/utils/generateColumnDescription.d.ts create mode 100644 dist/package-shared/shell/utils/noDatabaseDbHandler.d.ts create mode 100644 dist/package-shared/shell/utils/slugToCamelTitle.d.ts create mode 100644 dist/package-shared/shell/utils/supplementTable.d.ts create mode 100644 dist/package-shared/shell/utils/updateTable.d.ts create mode 100644 dist/package-shared/shell/utils/varDatabaseDbHandler.d.ts create mode 100644 dist/package-shared/types/dsql.d.ts create mode 100644 dist/package-shared/types/index.d.ts create mode 100644 dist/package-shared/utils/backend/export-mariadb-database.d.ts create mode 100644 dist/package-shared/utils/backend/global-db/DB_HANDLER.d.ts create mode 100644 dist/package-shared/utils/backend/global-db/DSQL_USER_DB_HANDLER.d.ts create mode 100644 dist/package-shared/utils/backend/global-db/LOCAL_DB_HANDLER.d.ts create mode 100644 dist/package-shared/utils/backend/global-db/NO_DB_HANDLER.d.ts create mode 100644 dist/package-shared/utils/backend/global-db/ROOT_DB_HANDLER.d.ts create mode 100644 dist/package-shared/utils/backend/grabDbSSL.d.ts create mode 100644 dist/package-shared/utils/backend/import-mariadb-database.d.ts create mode 100644 dist/package-shared/utils/backend/names/grab-dir-names.d.ts create mode 100644 dist/package-shared/utils/backend/names/replace-datasquirel-db-name.d.ts create mode 100644 dist/package-shared/utils/backend/parseCookies.d.ts create mode 100644 dist/package-shared/utils/camelJoinedtoCamelSpace.d.ts create mode 100644 dist/package-shared/utils/check-if-is-master.d.ts create mode 100644 dist/package-shared/utils/console-colors.d.ts create mode 100644 dist/package-shared/utils/data-fetching/crud.d.ts create mode 100644 dist/package-shared/utils/data-fetching/method-crud.d.ts create mode 100644 dist/package-shared/utils/db/conn-db-handler.d.ts create mode 100644 dist/package-shared/utils/deserialize-query.d.ts create mode 100644 dist/package-shared/utils/ejson.d.ts create mode 100644 dist/package-shared/utils/empty-dir.d.ts create mode 100644 dist/package-shared/utils/endConnection.d.ts create mode 100644 dist/package-shared/utils/generateColumnDescription.d.ts create mode 100644 dist/package-shared/utils/grab-cookie-expirt-date.d.ts create mode 100644 dist/package-shared/utils/grab-db-full-name.d.ts create mode 100644 dist/package-shared/utils/grab-dsql-connection.d.ts create mode 100644 dist/package-shared/utils/grab-host-names.d.ts create mode 100644 dist/package-shared/utils/grab-keys.d.ts create mode 100644 dist/package-shared/utils/grab-query-and-values.d.ts create mode 100644 dist/package-shared/utils/logging/debug-log.d.ts create mode 100644 dist/package-shared/utils/numberfy.d.ts create mode 100644 dist/package-shared/utils/parse-env.d.ts create mode 100644 dist/package-shared/utils/serialize-cookies.d.ts create mode 100644 dist/package-shared/utils/serialize-query.d.ts create mode 100644 dist/package-shared/utils/slugToCamelTitle.d.ts create mode 100644 dist/package-shared/utils/slugify.d.ts create mode 100644 dist/package-shared/utils/trim-sql.d.ts diff --git a/dist/client/auth/github/getAccessToken.d.ts b/dist/client/auth/github/getAccessToken.d.ts new file mode 100644 index 0000000..b09acb4 --- /dev/null +++ b/dist/client/auth/github/getAccessToken.d.ts @@ -0,0 +1,13 @@ +type Param = { + clientId: string; + redirectUrl: string; + setLoading?: (arg0: boolean) => void; + scopes?: string[]; +}; +/** + * Login with Github Function + * =============================================================================== + * @description This function uses github api to login a user with datasquirel + */ +export default function getAccessToken({ clientId, redirectUrl, setLoading, scopes, }: Param): void; +export {}; diff --git a/dist/client/auth/google/getAccessToken.d.ts b/dist/client/auth/google/getAccessToken.d.ts new file mode 100644 index 0000000..714c31b --- /dev/null +++ b/dist/client/auth/google/getAccessToken.d.ts @@ -0,0 +1,18 @@ +interface GoogleGetAccessTokenFunctionParams { + clientId: string; + triggerPrompt?: boolean; + setLoading?: React.Dispatch>; +} +/** + * Login with Google Function + * =============================================================================== + * @description This function uses google identity api to login a user with datasquirel + */ +export default function getAccessToken(params: GoogleGetAccessTokenFunctionParams): Promise; +/** + * # Google Login Function + */ +export declare function googleLogin({ google, clientId, setLoading, triggerPrompt, }: GoogleGetAccessTokenFunctionParams & { + google: any; +}): Promise; +export {}; diff --git a/dist/client/auth/logout.d.ts b/dist/client/auth/logout.d.ts new file mode 100644 index 0000000..661ed46 --- /dev/null +++ b/dist/client/auth/logout.d.ts @@ -0,0 +1,8 @@ +/** + * Login with Google Function + * =============================================================================== + * @description This function uses google identity api to login a user with datasquirel + */ +export default function logout(params?: { + googleClientId?: any; +}): Promise; diff --git a/dist/client/auth/post-login.d.ts b/dist/client/auth/post-login.d.ts new file mode 100644 index 0000000..812a233 --- /dev/null +++ b/dist/client/auth/post-login.d.ts @@ -0,0 +1,9 @@ +import { APILoginFunctionReturn } from "../../package-shared/types"; +/** + * Client Setup After Login + * =============================================================================== + * @description This function sets local storage variables like `csrf` after a user + * is logged in. Use this in conjunction with the `datasquirel.user.loginUser` + * function + */ +export default function postLogin(res: APILoginFunctionReturn): boolean; diff --git a/dist/client/fetch/index.d.ts b/dist/client/fetch/index.d.ts new file mode 100644 index 0000000..9976f51 --- /dev/null +++ b/dist/client/fetch/index.d.ts @@ -0,0 +1,21 @@ +type FetchApiOptions = { + method: "POST" | "GET" | "DELETE" | "PUT" | "PATCH" | "post" | "get" | "delete" | "put" | "patch"; + body?: object | string; + headers?: FetchHeader; +}; +type FetchHeader = HeadersInit & { + [key: string]: string | null; +}; +export type FetchApiReturn = { + success: boolean; + payload: any; + msg?: string; + [key: string]: any; +}; +/** + * # Fetch API + */ +export default function fetchApi(url: string, options?: FetchApiOptions, csrf?: boolean, +/** Key to use to grab local Storage csrf value. */ +localStorageCSRFKey?: string): Promise; +export {}; diff --git a/dist/client/index.d.ts b/dist/client/index.d.ts new file mode 100644 index 0000000..7020fcd --- /dev/null +++ b/dist/client/index.d.ts @@ -0,0 +1,55 @@ +import imageInputFileToBase64 from "./media/imageInputFileToBase64"; +import imageInputToBase64 from "./media/imageInputToBase64"; +import inputFileToBase64 from "./media/inputFileToBase64"; +import getAccessToken from "./auth/google/getAccessToken"; +import getGithubAccessToken from "./auth/github/getAccessToken"; +import logout from "./auth/logout"; +import fetchApi from "./fetch"; +import serializeQuery from "../package-shared/utils/serialize-query"; +import serializeCookies from "../package-shared/utils/serialize-cookies"; +import numberfy from "../package-shared/utils/numberfy"; +import slugify from "../package-shared/utils/slugify"; +import postLogin from "./auth/post-login"; +import deserializeQuery from "../package-shared/utils/deserialize-query"; +import debugLog from "../package-shared/utils/logging/debug-log"; +/** + * Main Export + */ +declare const datasquirelClient: { + media: { + imageInputToBase64: typeof imageInputToBase64; + imageInputFileToBase64: typeof imageInputFileToBase64; + inputFileToBase64: typeof inputFileToBase64; + }; + auth: { + google: { + getAccessToken: typeof getAccessToken; + }; + github: { + getAccessToken: typeof getGithubAccessToken; + }; + logout: typeof logout; + postLogin: typeof postLogin; + }; + fetch: { + fetchApi: typeof fetchApi; + clientFetch: typeof fetchApi; + }; + utils: { + deserializeQuery: typeof deserializeQuery; + serializeQuery: typeof serializeQuery; + serializeCookies: typeof serializeCookies; + EJSON: { + parse: (string: string | null | number, reviver?: (this: any, key: string, value: any) => any) => { + [s: string]: any; + } | { + [s: string]: any; + }[] | undefined; + stringify: (value: any, replacer?: ((this: any, key: string, value: any) => any) | null, space?: string | number) => string | undefined; + }; + numberfy: typeof numberfy; + slugify: typeof slugify; + debugLog: typeof debugLog; + }; +}; +export default datasquirelClient; diff --git a/dist/client/media/client.d.ts b/dist/client/media/client.d.ts new file mode 100644 index 0000000..c4d102c --- /dev/null +++ b/dist/client/media/client.d.ts @@ -0,0 +1,14 @@ +import imageInputFileToBase64 from "./imageInputFileToBase64"; +import imageInputToBase64 from "./imageInputToBase64"; +/** + * ========================== + * Main Export + * ========================== + */ +declare const datasquirelClient: { + media: { + imageInputToBase64: typeof imageInputToBase64; + imageInputFileToBase64: typeof imageInputFileToBase64; + }; +}; +export default datasquirelClient; diff --git a/dist/client/media/imageInputFileToBase64.d.ts b/dist/client/media/imageInputFileToBase64.d.ts new file mode 100644 index 0000000..1ae7a4c --- /dev/null +++ b/dist/client/media/imageInputFileToBase64.d.ts @@ -0,0 +1,11 @@ +import { ImageInputFileToBase64FunctionReturn } from "../../package-shared/types"; +type Param = { + imageInputFile: File; + maxWidth?: number; + imagePreviewNode?: HTMLImageElement; +}; +/** + * # Image input File top Base64 + */ +export default function imageInputFileToBase64({ imageInputFile, maxWidth, imagePreviewNode, }: Param): Promise; +export {}; diff --git a/dist/client/media/imageInputToBase64.d.ts b/dist/client/media/imageInputToBase64.d.ts new file mode 100644 index 0000000..469fabe --- /dev/null +++ b/dist/client/media/imageInputToBase64.d.ts @@ -0,0 +1,15 @@ +type FunctionReturn = { + imageBase64?: string; + imageBase64Full?: string; + imageName?: string; +}; +type Param = { + imageInput: HTMLInputElement; + maxWidth?: number; + mimeType?: string; +}; +/** + * # Image Input Element to Base 64 + */ +export default function imageInputToBase64({ imageInput, maxWidth, mimeType, }: Param): Promise; +export {}; diff --git a/dist/client/media/inputFileToBase64.d.ts b/dist/client/media/inputFileToBase64.d.ts new file mode 100644 index 0000000..1e3431e --- /dev/null +++ b/dist/client/media/inputFileToBase64.d.ts @@ -0,0 +1,21 @@ +type FunctionReturn = { + fileBase64?: string; + fileBase64Full?: string; + fileName?: string; + fileSize?: number; + fileType?: string; +}; +type Param = { + inputFile: File; + allowedRegex?: RegExp; +}; +/** + * Input File to base64 + * ============================================================================== + * + * @description This function takes in a *SINGLE* input file from a HTML file input element. + * HTML file input elements usually return an array of input objects, so be sure to select the target + * file from the array. + */ +export default function inputFileToBase64({ inputFile, allowedRegex, }: Param): Promise; +export {}; diff --git a/dist/client/utils/parseClientCookies.d.ts b/dist/client/utils/parseClientCookies.d.ts new file mode 100644 index 0000000..87d9b65 --- /dev/null +++ b/dist/client/utils/parseClientCookies.d.ts @@ -0,0 +1,8 @@ +/** + * Parse request cookies + * ============================================================================== * + * @description This function takes in a request object and returns the cookies as a JS object + */ +export default function (): { + [s: string]: any; +} | null; diff --git a/dist/console-colors.d.ts b/dist/console-colors.d.ts new file mode 100644 index 0000000..ab20fc1 --- /dev/null +++ b/dist/console-colors.d.ts @@ -0,0 +1,28 @@ +declare const colors: { + Reset: string; + Bright: string; + Dim: string; + Underscore: string; + Blink: string; + Reverse: string; + Hidden: string; + FgBlack: string; + FgRed: string; + FgGreen: string; + FgYellow: string; + FgBlue: string; + FgMagenta: string; + FgCyan: string; + FgWhite: string; + FgGray: string; + BgBlack: string; + BgRed: string; + BgGreen: string; + BgYellow: string; + BgBlue: string; + BgMagenta: string; + BgCyan: string; + BgWhite: string; + BgGray: string; +}; +export default colors; diff --git a/dist/engine/dsql.d.ts b/dist/engine/dsql.d.ts new file mode 100644 index 0000000..82d43b5 --- /dev/null +++ b/dist/engine/dsql.d.ts @@ -0,0 +1,2 @@ +#! /usr/bin/env node +export default function run(): Promise; diff --git a/dist/engine/dump.d.ts b/dist/engine/dump.d.ts new file mode 100644 index 0000000..237deca --- /dev/null +++ b/dist/engine/dump.d.ts @@ -0,0 +1,2 @@ +#! /usr/bin/env node +export {}; diff --git a/dist/engine/schema-to-typedef.d.ts b/dist/engine/schema-to-typedef.d.ts new file mode 100644 index 0000000..237deca --- /dev/null +++ b/dist/engine/schema-to-typedef.d.ts @@ -0,0 +1,2 @@ +#! /usr/bin/env node +export {}; diff --git a/dist/index.d.ts b/dist/index.d.ts new file mode 100644 index 0000000..572f05b --- /dev/null +++ b/dist/index.d.ts @@ -0,0 +1,146 @@ +import { ServerlessMysql } from "serverless-mysql"; +declare global { + var DSQL_DB_CONN: ServerlessMysql | undefined; + var DSQL_READ_ONLY_DB_CONN: ServerlessMysql | undefined; + var DSQL_FULL_ACCESS_DB_CONN: ServerlessMysql | undefined; + var DSQL_USE_LOCAL: boolean | undefined; + var ERROR_CALLBACK: ErrorCallback | undefined; +} +import get from "./package-shared/actions/get"; +import post from "./package-shared/actions/post"; +import getSchema from "./package-shared/actions/get-schema"; +import uploadImage from "./package-shared/actions/upload-image"; +import uploadFile from "./package-shared/actions/upload-file"; +import deleteFile from "./package-shared/actions/delete-file"; +import createUser from "./package-shared/actions/users/add-user"; +import updateUser from "./package-shared/actions/users/update-user"; +import loginUser from "./package-shared/actions/users/login-user"; +import sendEmailCode from "./package-shared/actions/users/send-email-code"; +import logoutUser from "./package-shared/actions/users/logout-user"; +import userAuth from "./package-shared/actions/users/user-auth"; +import reAuthUser from "./package-shared/actions/users/reauth-user"; +import getUser from "./package-shared/actions/users/get-user"; +import loginWithGoogle from "./package-shared/actions/users/social/google-auth"; +import loginWithGithub from "./package-shared/actions/users/social/github-auth"; +import getToken from "./package-shared/actions/users/get-token"; +import validateToken from "./package-shared/actions/users/validate-token"; +import sqlGenerator from "./package-shared/functions/dsql/sql/sql-generator"; +import sqlInsertGenerator from "./package-shared/functions/dsql/sql/sql-insert-generator"; +import sqlDeleteGenerator from "./package-shared/functions/dsql/sql/sql-delete-generator"; +import trimSql from "./package-shared/utils/trim-sql"; +import parseCookies from "./package-shared/utils/backend/parseCookies"; +import httpRequest from "./package-shared/functions/backend/httpRequest"; +import connDbHandler from "./package-shared/utils/db/conn-db-handler"; +import encrypt from "./package-shared/functions/dsql/encrypt"; +import decrypt from "./package-shared/functions/dsql/decrypt"; +import hashPassword from "./package-shared/functions/dsql/hashPassword"; +import validateTempEmailCode from "./package-shared/actions/users/validate-temp-email-code"; +import deleteUser from "./package-shared/actions/users/delete-user"; +import dsqlCrud from "./package-shared/utils/data-fetching/crud"; +import dsqlMethodCrud from "./package-shared/utils/data-fetching/method-crud"; +import debugLog from "./package-shared/utils/logging/debug-log"; +import { ErrorCallback } from "./package-shared/types"; +import parseEnv from "./package-shared/utils/parse-env"; +/** + * Main Export + */ +declare const datasquirel: { + /** + * Get Action + */ + get: typeof get; + /** + * Post Action + */ + post: typeof post; + media: { + uploadImage: typeof uploadImage; + uploadFile: typeof uploadFile; + deleteFile: typeof deleteFile; + }; + user: { + createUser: typeof createUser; + deleteUser: typeof deleteUser; + loginUser: typeof loginUser; + sendEmailCode: typeof sendEmailCode; + logoutUser: typeof logoutUser; + userAuth: typeof userAuth; + reAuthUser: typeof reAuthUser; + updateUser: typeof updateUser; + getUser: typeof getUser; + getToken: typeof getToken; + validateToken: typeof validateToken; + validateTempEmailCode: typeof validateTempEmailCode; + social: { + loginWithGoogle: typeof loginWithGoogle; + loginWithGithub: typeof loginWithGithub; + }; + }; + getSchema: typeof getSchema; + client: { + media: { + imageInputToBase64: typeof import("./client/media/imageInputToBase64").default; + imageInputFileToBase64: typeof import("./client/media/imageInputFileToBase64").default; + inputFileToBase64: typeof import("./client/media/inputFileToBase64").default; + }; + auth: { + google: { + getAccessToken: typeof import("./client/auth/google/getAccessToken").default; + }; + github: { + getAccessToken: typeof import("./client/auth/github/getAccessToken").default; + }; + logout: typeof import("./client/auth/logout").default; + postLogin: typeof import("./client/auth/post-login").default; + }; + fetch: { + fetchApi: typeof import("./client/fetch").default; + clientFetch: typeof import("./client/fetch").default; + }; + utils: { + deserializeQuery: typeof import("./package-shared/utils/deserialize-query").default; + serializeQuery: typeof import("./package-shared/utils/serialize-query").default; + serializeCookies: typeof import("./package-shared/utils/serialize-cookies").default; + EJSON: { + parse: (string: string | null | number, reviver?: (this: any, key: string, value: any) => any) => { + [s: string]: any; + } | { + [s: string]: any; + }[] | undefined; + stringify: (value: any, replacer?: ((this: any, key: string, value: any) => any) | null, space?: string | number) => string | undefined; + }; + numberfy: typeof import("./package-shared/utils/numberfy").default; + slugify: typeof import("./package-shared/utils/slugify").default; + debugLog: typeof debugLog; + }; + }; + sql: { + sqlGenerator: typeof sqlGenerator; + sqlInsertGenerator: typeof sqlInsertGenerator; + sqlDeleteGenerator: typeof sqlDeleteGenerator; + trim: typeof trimSql; + }; + utils: { + crypto: { + encrypt: typeof encrypt; + decrypt: typeof decrypt; + hashPassword: typeof hashPassword; + }; + parseCookies: typeof parseCookies; + httpRequest: typeof httpRequest; + connDbHandler: typeof connDbHandler; + debugLog: typeof debugLog; + parseEnv: typeof parseEnv; + }; + /** + * Run Crud actions `get`, `insert`, `update`, `delete` + * @note *Requires global variables `DSQL_USE_LOCAL` and `DSQL_DB_CONN` + */ + crud: typeof dsqlCrud; + /** + * Run Crud based on request Methods `GET`, `POST`, `PUT`, `PATCH` + * @note *Requires global variables `DSQL_USE_LOCAL` and `DSQL_DB_CONN` + */ + methodCrud: typeof dsqlMethodCrud; +}; +export default datasquirel; diff --git a/dist/package-shared/actions/delete-file.d.ts b/dist/package-shared/actions/delete-file.d.ts new file mode 100644 index 0000000..af89680 --- /dev/null +++ b/dist/package-shared/actions/delete-file.d.ts @@ -0,0 +1,18 @@ +interface Return { + success: boolean; + payload: { + urlPath: string; + urlThumbnailPath: string; + } | null; + msg?: string; +} +type Param = { + key: string; + url: string; + user_id?: string | number; +}; +/** + * # Delete File via API + */ +export default function deleteFile({ key, url, user_id, }: Param): Promise; +export {}; diff --git a/dist/package-shared/actions/get-csrf-header-name.d.ts b/dist/package-shared/actions/get-csrf-header-name.d.ts new file mode 100644 index 0000000..c3eef54 --- /dev/null +++ b/dist/package-shared/actions/get-csrf-header-name.d.ts @@ -0,0 +1 @@ +export default function getCsrfHeaderName(): string; diff --git a/dist/package-shared/actions/get-schema.d.ts b/dist/package-shared/actions/get-schema.d.ts new file mode 100644 index 0000000..310591c --- /dev/null +++ b/dist/package-shared/actions/get-schema.d.ts @@ -0,0 +1,10 @@ +import { DSQL_DatabaseSchemaType, DSQL_FieldSchemaType, DSQL_TableSchemaType, GetSchemaAPIParam } from "../types"; +type GetSchemaReturn = { + success: boolean; + payload?: DSQL_DatabaseSchemaType | DSQL_TableSchemaType | DSQL_FieldSchemaType | null; +}; +/** + * # Get Schema for Database, table, or field * + */ +export default function getSchema({ key, database, field, table, user_id, env, }: GetSchemaAPIParam): Promise; +export {}; diff --git a/dist/package-shared/actions/get.d.ts b/dist/package-shared/actions/get.d.ts new file mode 100644 index 0000000..9f0fb13 --- /dev/null +++ b/dist/package-shared/actions/get.d.ts @@ -0,0 +1,25 @@ +import { ApiGetQueryObject, GetReturn } from "../types"; +type Param = { + key?: string; + db?: string; + query: string | ApiGetQueryObject; + queryValues?: string[]; + tableName?: string; + user_id?: string | number; + debug?: boolean; + forceLocal?: boolean; +}; +export type ApiGetParams = Param; +/** + * # Make a get request to Datasquirel API + */ +export default function get({ key, db, query, queryValues, tableName, user_id, debug, forceLocal, }: Param): Promise; +export {}; diff --git a/dist/package-shared/actions/post.d.ts b/dist/package-shared/actions/post.d.ts new file mode 100644 index 0000000..9a1c2d8 --- /dev/null +++ b/dist/package-shared/actions/post.d.ts @@ -0,0 +1,15 @@ +import { PostDataPayload, PostReturn } from "../types"; +type Param = { + key?: string; + database?: string; + query: string | PostDataPayload; + queryValues?: any[]; + tableName?: string; + user_id?: boolean; + forceLocal?: boolean; +}; +/** + * # Make a post request to Datasquirel API + */ +export default function post({ key, query, queryValues, database, tableName, user_id, forceLocal, }: Param): Promise; +export {}; diff --git a/dist/package-shared/actions/upload-file.d.ts b/dist/package-shared/actions/upload-file.d.ts new file mode 100644 index 0000000..8944248 --- /dev/null +++ b/dist/package-shared/actions/upload-file.d.ts @@ -0,0 +1,23 @@ +interface Return { + success: boolean; + payload: { + urlPath: string; + } | null; + msg?: string; +} +type Param = { + key: string; + payload: { + fileData: string; + fileName: string; + mimeType?: string; + folder?: string; + isPrivate?: boolean; + }; + user_id?: boolean; +}; +/** + * # Upload File via API + */ +export default function uploadImage({ key, payload, user_id, }: Param): Promise; +export {}; diff --git a/dist/package-shared/actions/upload-image.d.ts b/dist/package-shared/actions/upload-image.d.ts new file mode 100644 index 0000000..2cdba7a --- /dev/null +++ b/dist/package-shared/actions/upload-image.d.ts @@ -0,0 +1,25 @@ +interface FunctionReturn { + success: boolean; + payload: { + urlPath: string; + urlThumbnailPath: string; + } | null; + msg?: string; +} +type Param = { + key?: string; + payload: { + imageData: string; + imageName: string; + mimeType?: string; + thumbnailSize?: number; + folder?: string; + isPrivate?: boolean; + }; + user_id?: boolean; +}; +/** + * # Upload Image via API + */ +export default function uploadImage({ key, payload, user_id, }: Param): Promise; +export {}; diff --git a/dist/package-shared/actions/users/add-user.d.ts b/dist/package-shared/actions/users/add-user.d.ts new file mode 100644 index 0000000..0ef96b6 --- /dev/null +++ b/dist/package-shared/actions/users/add-user.d.ts @@ -0,0 +1,15 @@ +import { AddUserFunctionReturn, UserDataPayload } from "../../types"; +type Param = { + key?: string; + database?: string; + payload: UserDataPayload; + encryptionKey?: string; + encryptionSalt?: string; + user_id?: string | number; + apiUserId?: string | number; +}; +/** + * # Add User to Database + */ +export default function addUser({ key, payload, database, encryptionKey, user_id, apiUserId, }: Param): Promise; +export {}; diff --git a/dist/package-shared/actions/users/delete-user.d.ts b/dist/package-shared/actions/users/delete-user.d.ts new file mode 100644 index 0000000..25b8fb7 --- /dev/null +++ b/dist/package-shared/actions/users/delete-user.d.ts @@ -0,0 +1,12 @@ +import { UpdateUserFunctionReturn } from "../../types"; +type Param = { + key?: string; + database?: string; + deletedUserId: string | number; + user_id?: boolean; +}; +/** + * # Update User + */ +export default function deleteUser({ key, database, user_id, deletedUserId, }: Param): Promise; +export {}; diff --git a/dist/package-shared/actions/users/get-token.d.ts b/dist/package-shared/actions/users/get-token.d.ts new file mode 100644 index 0000000..7d690a8 --- /dev/null +++ b/dist/package-shared/actions/users/get-token.d.ts @@ -0,0 +1,20 @@ +import http from "http"; +type Param = { + request?: http.IncomingMessage; + cookieString?: string; + encryptionKey: string; + encryptionSalt: string; + database: string; +}; +type Return = { + key: string | undefined; + csrf: string | undefined; +}; +/** + * Get just the access token for user + * ============================================================================== + * @description This Function takes in a request object and returns a user token + * string and csrf token string + */ +export default function getToken({ request, encryptionKey, encryptionSalt, cookieString, }: Param): Return; +export {}; diff --git a/dist/package-shared/actions/users/get-user.d.ts b/dist/package-shared/actions/users/get-user.d.ts new file mode 100644 index 0000000..b2c9476 --- /dev/null +++ b/dist/package-shared/actions/users/get-user.d.ts @@ -0,0 +1,13 @@ +import { GetUserFunctionReturn } from "../../types"; +type Param = { + key: string; + database: string; + userId: number; + fields?: string[]; + apiUserId?: boolean; +}; +/** + * # Get User + */ +export default function getUser({ key, userId, database, fields, apiUserId, }: Param): Promise; +export {}; diff --git a/dist/package-shared/actions/users/login-user.d.ts b/dist/package-shared/actions/users/login-user.d.ts new file mode 100644 index 0000000..df2bb75 --- /dev/null +++ b/dist/package-shared/actions/users/login-user.d.ts @@ -0,0 +1,37 @@ +import http from "http"; +import { APILoginFunctionReturn } from "../../types"; +type Param = { + key?: string; + database: string; + payload: { + email?: string; + username?: string; + password?: string; + }; + additionalFields?: string[]; + request?: http.IncomingMessage & { + [s: string]: any; + }; + response?: http.ServerResponse & { + [s: string]: any; + }; + encryptionKey?: string; + encryptionSalt?: string; + email_login?: boolean; + email_login_code?: string; + temp_code_field?: string; + token?: boolean; + user_id?: string | number; + skipPassword?: boolean; + debug?: boolean; + skipWriteAuthFile?: boolean; + apiUserID?: string | number; + dbUserId?: string | number; + cleanupTokens?: boolean; + secureCookie?: boolean; +}; +/** + * # Login A user + */ +export default function loginUser({ key, payload, database, additionalFields, response, encryptionKey, encryptionSalt, email_login, email_login_code, temp_code_field, token, user_id, skipPassword, apiUserID, skipWriteAuthFile, dbUserId, debug, cleanupTokens, secureCookie, request, }: Param): Promise; +export {}; diff --git a/dist/package-shared/actions/users/logout-user.d.ts b/dist/package-shared/actions/users/logout-user.d.ts new file mode 100644 index 0000000..f491fa7 --- /dev/null +++ b/dist/package-shared/actions/users/logout-user.d.ts @@ -0,0 +1,24 @@ +import http from "http"; +type Param = { + encryptedUserString?: string; + request?: http.IncomingMessage & { + [s: string]: any; + }; + response?: http.ServerResponse & { + [s: string]: any; + }; + cookieString?: string; + database?: string; + dsqlUserId?: string | number; + debug?: boolean; +}; +type Return = { + success: boolean; + msg: string; + cookieNames?: any; +}; +/** + * # Logout user + */ +export default function logoutUser({ response, database, dsqlUserId, encryptedUserString, request, cookieString, debug, }: Param): Return; +export {}; diff --git a/dist/package-shared/actions/users/reauth-user.d.ts b/dist/package-shared/actions/users/reauth-user.d.ts new file mode 100644 index 0000000..f6531b7 --- /dev/null +++ b/dist/package-shared/actions/users/reauth-user.d.ts @@ -0,0 +1,20 @@ +import http from "http"; +import { APILoginFunctionReturn } from "../../types"; +type Param = { + key?: string; + database?: string; + response?: http.ServerResponse; + request?: http.IncomingMessage; + level?: "deep" | "normal"; + encryptionKey?: string; + encryptionSalt?: string; + additionalFields?: string[]; + encryptedUserString?: string; + user_id?: string | number; + secureCookie?: boolean; +}; +/** + * # Reauthorize User + */ +export default function reauthUser({ key, database, response, request, level, encryptionKey, encryptionSalt, additionalFields, encryptedUserString, user_id, secureCookie, }: Param): Promise; +export {}; diff --git a/dist/package-shared/actions/users/send-email-code.d.ts b/dist/package-shared/actions/users/send-email-code.d.ts new file mode 100644 index 0000000..209d639 --- /dev/null +++ b/dist/package-shared/actions/users/send-email-code.d.ts @@ -0,0 +1,23 @@ +import http from "http"; +import { SendOneTimeCodeEmailResponse } from "../../types"; +type Param = { + key?: string; + database?: string; + email: string; + temp_code_field_name?: string; + response?: http.ServerResponse & { + [s: string]: any; + }; + mail_domain?: string; + mail_username?: string; + mail_password?: string; + mail_port?: number; + sender?: string; + user_id?: boolean; + extraCookies?: import("../../types").CookieObject[]; +}; +/** + * # Send Email Code to a User + */ +export default function sendEmailCode({ key, email, database, temp_code_field_name, mail_domain, mail_password, mail_username, mail_port, sender, user_id, response, extraCookies, }: Param): Promise; +export {}; diff --git a/dist/package-shared/actions/users/social/github-auth.d.ts b/dist/package-shared/actions/users/social/github-auth.d.ts new file mode 100644 index 0000000..64a823d --- /dev/null +++ b/dist/package-shared/actions/users/social/github-auth.d.ts @@ -0,0 +1,35 @@ +import http from "http"; +interface FunctionReturn { + success: boolean; + user: { + id: number; + first_name: string; + last_name: string; + csrf_k: string; + social_id: string; + } | null; + dsqlUserId?: number; + msg?: string; +} +type Param = { + key: string; + code: string; + email: string | null; + database: string; + clientId: string; + clientSecret: string; + response: http.ServerResponse; + encryptionKey: string; + encryptionSalt: string; + additionalFields?: string[]; + additionalData?: { + [s: string]: string | number; + }; + user_id?: boolean; + secureCookie?: boolean; +}; +/** + * # SERVER FUNCTION: Login with google Function + */ +export default function githubAuth({ key, code, email, database, clientId, clientSecret, response, encryptionKey, encryptionSalt, additionalFields, user_id, additionalData, secureCookie, }: Param): Promise; +export {}; diff --git a/dist/package-shared/actions/users/social/google-auth.d.ts b/dist/package-shared/actions/users/social/google-auth.d.ts new file mode 100644 index 0000000..470918d --- /dev/null +++ b/dist/package-shared/actions/users/social/google-auth.d.ts @@ -0,0 +1,22 @@ +import http from "http"; +import { APILoginFunctionReturn } from "../../../types"; +type Param = { + key?: string; + token: string; + database?: string; + response?: http.ServerResponse; + encryptionKey?: string; + encryptionSalt?: string; + additionalFields?: string[]; + additionalData?: { + [s: string]: string | number; + }; + apiUserID?: string | number; + debug?: boolean; + secureCookie?: boolean; +}; +/** + * # SERVER FUNCTION: Login with google Function + */ +export default function googleAuth({ key, token, database, response, encryptionKey, encryptionSalt, additionalFields, additionalData, apiUserID, debug, secureCookie, }: Param): Promise; +export {}; diff --git a/dist/package-shared/actions/users/update-user.d.ts b/dist/package-shared/actions/users/update-user.d.ts new file mode 100644 index 0000000..0ad47da --- /dev/null +++ b/dist/package-shared/actions/users/update-user.d.ts @@ -0,0 +1,15 @@ +import { UpdateUserFunctionReturn } from "../../types"; +type Param = { + key?: string; + database?: string; + updatedUserId: string | number; + payload: { + [s: string]: any; + }; + user_id?: boolean; +}; +/** + * # Update User + */ +export default function updateUser({ key, payload, database, user_id, updatedUserId, }: Param): Promise; +export {}; diff --git a/dist/package-shared/actions/users/user-auth.d.ts b/dist/package-shared/actions/users/user-auth.d.ts new file mode 100644 index 0000000..9e5e54e --- /dev/null +++ b/dist/package-shared/actions/users/user-auth.d.ts @@ -0,0 +1,28 @@ +import http from "http"; +import { AuthenticatedUser } from "../../types"; +type Param = { + request?: http.IncomingMessage & { + [s: string]: any; + }; + req?: http.IncomingMessage & { + [s: string]: any; + }; + cookieString?: string; + encryptedUserString?: string; + encryptionKey?: string; + encryptionSalt?: string; + level?: "deep" | "normal"; + database?: string; + dsqlUserId?: string | number; + expiry?: number; + csrfHeaderName?: string; + debug?: boolean; +}; +/** + * Authenticate User from request + * ============================================================================== + * @description This Function takes in a request object and returns a user object + * with the user's data + */ +export default function userAuth({ request, req, encryptionKey, encryptionSalt, level, database, dsqlUserId, encryptedUserString, expiry, cookieString, csrfHeaderName, debug, }: Param): AuthenticatedUser; +export {}; diff --git a/dist/package-shared/actions/users/validate-temp-email-code.d.ts b/dist/package-shared/actions/users/validate-temp-email-code.d.ts new file mode 100644 index 0000000..952298f --- /dev/null +++ b/dist/package-shared/actions/users/validate-temp-email-code.d.ts @@ -0,0 +1,14 @@ +import http from "http"; +import { SendOneTimeCodeEmailResponse } from "../../types"; +type Param = { + request?: http.IncomingMessage & { + [s: string]: any; + }; + cookieString?: string; + email?: string; +}; +/** + * # Verify the temp email code sent to the user's email address + */ +export default function validateTempEmailCode({ request, email, cookieString, }: Param): Promise; +export {}; diff --git a/dist/package-shared/actions/users/validate-token.d.ts b/dist/package-shared/actions/users/validate-token.d.ts new file mode 100644 index 0000000..4196071 --- /dev/null +++ b/dist/package-shared/actions/users/validate-token.d.ts @@ -0,0 +1,15 @@ +import { DATASQUIREL_LoggedInUser } from "../../types"; +type Param = { + token: string; + encryptionKey: string; + encryptionSalt: string; + level?: ("deep" | "normal") | null; + database: string; +}; +/** + * Validate Token + * ====================================== + * @description This Function takes in a encrypted token and returns a user object + */ +export default function validateToken({ token, encryptionKey, encryptionSalt, }: Param): DATASQUIREL_LoggedInUser | null; +export {}; diff --git a/dist/package-shared/external-services/arcjet/index.d.ts b/dist/package-shared/external-services/arcjet/index.d.ts new file mode 100644 index 0000000..e69de29 diff --git a/dist/package-shared/functions/api/query/get.d.ts b/dist/package-shared/functions/api/query/get.d.ts new file mode 100644 index 0000000..6ccae7a --- /dev/null +++ b/dist/package-shared/functions/api/query/get.d.ts @@ -0,0 +1,25 @@ +import { DbContextsArray } from "../../backend/db/runQuery"; +import { ApiGetQueryObject } from "../../../types"; +type Param = { + query: string | ApiGetQueryObject; + queryValues?: (string | number)[]; + dbFullName: string; + tableName?: string; + dbSchema?: import("../../../types").DSQL_DatabaseSchemaType; + debug?: boolean; + dbContext?: (typeof DbContextsArray)[number]; + forceLocal?: boolean; +}; +/** + * # Get Function FOr API + */ +export default function apiGet({ query, dbFullName, queryValues, tableName, dbSchema, debug, dbContext, forceLocal, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/api/query/post.d.ts b/dist/package-shared/functions/api/query/post.d.ts new file mode 100644 index 0000000..9767467 --- /dev/null +++ b/dist/package-shared/functions/api/query/post.d.ts @@ -0,0 +1,16 @@ +import { DbContextsArray } from "../../backend/db/runQuery"; +import { DSQL_DatabaseSchemaType, PostReturn } from "../../../types"; +type Param = { + query: any; + queryValues?: (string | number)[]; + dbFullName: string; + tableName?: string; + dbSchema?: DSQL_DatabaseSchemaType; + dbContext?: (typeof DbContextsArray)[number]; + forceLocal?: boolean; +}; +/** + * # Post Function For API + */ +export default function apiPost({ query, dbFullName, queryValues, tableName, dbSchema, dbContext, forceLocal, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/api/social-login/facebookLogin.d.ts b/dist/package-shared/functions/api/social-login/facebookLogin.d.ts new file mode 100644 index 0000000..ffab001 --- /dev/null +++ b/dist/package-shared/functions/api/social-login/facebookLogin.d.ts @@ -0,0 +1,8 @@ +import { UserType } from "../../../types"; +/** + * # Facebook Login + */ +export default function facebookLogin({ usertype, body, }: { + body: any; + usertype: UserType; +}): Promise; diff --git a/dist/package-shared/functions/api/social-login/githubLogin.d.ts b/dist/package-shared/functions/api/social-login/githubLogin.d.ts new file mode 100644 index 0000000..4f064bd --- /dev/null +++ b/dist/package-shared/functions/api/social-login/githubLogin.d.ts @@ -0,0 +1,43 @@ +export interface GithubUserPayload { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + name: string; + company: string; + blog: string; + location: string; + email: string; + hireable: string; + bio: string; + twitter_username: string; + public_repos: number; + public_gists: number; + followers: number; + following: number; + created_at: string; + updated_at: string; +} +type Param = { + code: string; + clientId: string; + clientSecret: string; +}; +/** + * # Login/signup a github user + */ +export default function githubLogin({ code, clientId, clientSecret, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/api/social-login/googleLogin.d.ts b/dist/package-shared/functions/api/social-login/googleLogin.d.ts new file mode 100644 index 0000000..0ed8594 --- /dev/null +++ b/dist/package-shared/functions/api/social-login/googleLogin.d.ts @@ -0,0 +1,22 @@ +type Param = { + usertype: string; + foundUser: any; + isSocialValidated: boolean; + isUserValid: boolean; + reqBody: any; + serverRes: any; + loginFailureReason: any; +}; +/** + * # Google Login + */ +export default function googleLogin({ usertype, foundUser, isSocialValidated, isUserValid, reqBody, serverRes, loginFailureReason, }: Param): Promise<{ + isGoogleAuthValid: boolean; + newFoundUser: null; + loginFailureReason: any; +} | { + isGoogleAuthValid: boolean; + newFoundUser: any; + loginFailureReason?: undefined; +} | undefined>; +export {}; diff --git a/dist/package-shared/functions/api/social-login/handleSocialDb.d.ts b/dist/package-shared/functions/api/social-login/handleSocialDb.d.ts new file mode 100644 index 0000000..037499e --- /dev/null +++ b/dist/package-shared/functions/api/social-login/handleSocialDb.d.ts @@ -0,0 +1,5 @@ +import { APILoginFunctionReturn, HandleSocialDbFunctionParams } from "../../../types"; +/** + * # Handle Social DB + */ +export default function handleSocialDb({ database, social_id, email, social_platform, payload, invitation, supEmail, additionalFields, debug, }: HandleSocialDbFunctionParams): Promise; diff --git a/dist/package-shared/functions/api/social-login/loginSocialUser.d.ts b/dist/package-shared/functions/api/social-login/loginSocialUser.d.ts new file mode 100644 index 0000000..92df0e6 --- /dev/null +++ b/dist/package-shared/functions/api/social-login/loginSocialUser.d.ts @@ -0,0 +1,22 @@ +import { APILoginFunctionReturn } from "../../../types"; +type Param = { + user: { + first_name: string; + last_name: string; + email: string; + social_id: string | number; + }; + social_platform: string; + invitation?: any; + database?: string; + additionalFields?: string[]; + debug?: boolean; +}; +/** + * Function to login social user + * ============================================================================== + * @description This function logs in the user after 'handleSocialDb' function finishes + * the user creation or confirmation process + */ +export default function loginSocialUser({ user, social_platform, invitation, database, additionalFields, debug, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/api/users/api-create-user.d.ts b/dist/package-shared/functions/api/users/api-create-user.d.ts new file mode 100644 index 0000000..85eed9f --- /dev/null +++ b/dist/package-shared/functions/api/users/api-create-user.d.ts @@ -0,0 +1,25 @@ +import { APICreateUserFunctionParams } from "../../../types"; +/** + * # API Create User + */ +export default function apiCreateUser({ encryptionKey, payload, database, userId, }: APICreateUserFunctionParams): Promise<{ + success: boolean; + msg: string; + payload?: undefined; + sqlResult?: undefined; +} | { + success: boolean; + msg: string | undefined; + payload: null; + sqlResult?: undefined; +} | { + success: boolean; + payload: any; + msg?: undefined; + sqlResult?: undefined; +} | { + success: boolean; + msg: string; + sqlResult: any; + payload: null; +}>; diff --git a/dist/package-shared/functions/api/users/api-delete-user.d.ts b/dist/package-shared/functions/api/users/api-delete-user.d.ts new file mode 100644 index 0000000..ff07caf --- /dev/null +++ b/dist/package-shared/functions/api/users/api-delete-user.d.ts @@ -0,0 +1,14 @@ +type Param = { + dbFullName: string; + deletedUserId: string | number; +}; +type Return = { + success: boolean; + result?: any; + msg?: string; +}; +/** + * # Update API User Function + */ +export default function apiDeleteUser({ dbFullName, deletedUserId, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/api/users/api-get-user.d.ts b/dist/package-shared/functions/api/users/api-get-user.d.ts new file mode 100644 index 0000000..6d24e53 --- /dev/null +++ b/dist/package-shared/functions/api/users/api-get-user.d.ts @@ -0,0 +1,5 @@ +import { APIGetUserFunctionParams, GetUserFunctionReturn } from "../../../types"; +/** + * # API Get User + */ +export default function apiGetUser({ fields, dbFullName, userId, }: APIGetUserFunctionParams): Promise; diff --git a/dist/package-shared/functions/api/users/api-login.d.ts b/dist/package-shared/functions/api/users/api-login.d.ts new file mode 100644 index 0000000..f6c9b2e --- /dev/null +++ b/dist/package-shared/functions/api/users/api-login.d.ts @@ -0,0 +1,5 @@ +import { APILoginFunctionParams, APILoginFunctionReturn } from "../../../types"; +/** + * # API Login + */ +export default function apiLoginUser({ encryptionKey, email, username, password, database, additionalFields, email_login, email_login_code, email_login_field, skipPassword, social, dbUserId, debug, }: APILoginFunctionParams): Promise; diff --git a/dist/package-shared/functions/api/users/api-reauth-user.d.ts b/dist/package-shared/functions/api/users/api-reauth-user.d.ts new file mode 100644 index 0000000..ac8930c --- /dev/null +++ b/dist/package-shared/functions/api/users/api-reauth-user.d.ts @@ -0,0 +1,13 @@ +import { APILoginFunctionReturn } from "../../../types"; +type Param = { + existingUser: { + [s: string]: any; + }; + database?: string; + additionalFields?: string[]; +}; +/** + * # Re-authenticate API user + */ +export default function apiReauthUser({ existingUser, database, additionalFields, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/api/users/api-send-email-code.d.ts b/dist/package-shared/functions/api/users/api-send-email-code.d.ts new file mode 100644 index 0000000..2b21878 --- /dev/null +++ b/dist/package-shared/functions/api/users/api-send-email-code.d.ts @@ -0,0 +1,22 @@ +import http from "http"; +import { SendOneTimeCodeEmailResponse } from "../../../types"; +type Param = { + email: string; + database: string; + email_login_field?: string; + mail_domain?: string; + mail_port?: number; + sender?: string; + mail_username?: string; + mail_password?: string; + html: string; + response?: http.ServerResponse & { + [s: string]: any; + }; + extraCookies?: import("../../../../package-shared/types").CookieObject[]; +}; +/** + * # Send Email Login Code + */ +export default function apiSendEmailCode({ email, database, email_login_field, mail_domain, mail_port, sender, mail_username, mail_password, html, response, extraCookies, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/api/users/api-update-user.d.ts b/dist/package-shared/functions/api/users/api-update-user.d.ts new file mode 100644 index 0000000..2f0bfd9 --- /dev/null +++ b/dist/package-shared/functions/api/users/api-update-user.d.ts @@ -0,0 +1,18 @@ +type Param = { + payload: { + [s: string]: any; + }; + dbFullName: string; + updatedUserId: string | number; + dbSchema?: import("../../../types").DSQL_DatabaseSchemaType; +}; +type Return = { + success: boolean; + payload?: any; + msg?: string; +}; +/** + * # Update API User Function + */ +export default function apiUpdateUser({ payload, dbFullName, updatedUserId, dbSchema, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/api/users/reset-password/(utils)/encrypt-url.d.ts b/dist/package-shared/functions/api/users/reset-password/(utils)/encrypt-url.d.ts new file mode 100644 index 0000000..b72d261 --- /dev/null +++ b/dist/package-shared/functions/api/users/reset-password/(utils)/encrypt-url.d.ts @@ -0,0 +1,11 @@ +type Param = { + email: string; + encryptionKey?: string; + encryptionSalt?: string; +}; +export type EncryptResetPasswordObject = { + email: string; + createdAt: number; +}; +export default function encryptReserPasswordUrl({ email, encryptionKey, encryptionSalt, }: Param): void; +export {}; diff --git a/dist/package-shared/functions/api/users/reset-password/api-send-reset-password-link.d.ts b/dist/package-shared/functions/api/users/reset-password/api-send-reset-password-link.d.ts new file mode 100644 index 0000000..ec5b472 --- /dev/null +++ b/dist/package-shared/functions/api/users/reset-password/api-send-reset-password-link.d.ts @@ -0,0 +1,22 @@ +type Return = { + success: boolean; + msg?: string; + error?: string; +}; +type Param = { + key?: string; + database: string; + email: string; + encryptionKey?: string; + encryptionSalt?: string; + debug?: boolean; + apiUserID?: string | number; + dbUserId?: string | number; +}; +/** + * # API Login + */ +export default function apiSendResetPasswordLink({ database, email, dbUserId, debug, }: Param): Promise; +export type SendResetPasswordParam = Param; +export type SendResetPasswordReturn = Return; +export {}; diff --git a/dist/package-shared/functions/api/users/social/api-github-login.d.ts b/dist/package-shared/functions/api/users/social/api-github-login.d.ts new file mode 100644 index 0000000..93e3442 --- /dev/null +++ b/dist/package-shared/functions/api/users/social/api-github-login.d.ts @@ -0,0 +1,17 @@ +import { APILoginFunctionReturn } from "../../../../types"; +type Param = { + code?: string; + clientId?: string; + clientSecret?: string; + database?: string; + additionalFields?: string[]; + additionalData?: { + [s: string]: string | number; + }; + email?: string; +}; +/** + * # API Login with Github + */ +export default function apiGithubLogin({ code, clientId, clientSecret, database, additionalFields, email, additionalData, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/api/users/social/api-google-login.d.ts b/dist/package-shared/functions/api/users/social/api-google-login.d.ts new file mode 100644 index 0000000..145fb07 --- /dev/null +++ b/dist/package-shared/functions/api/users/social/api-google-login.d.ts @@ -0,0 +1,5 @@ +import { APIGoogleLoginFunctionParams, APILoginFunctionReturn } from "../../../../types"; +/** + * # API google login + */ +export default function apiGoogleLogin({ token, database, additionalFields, additionalData, debug, }: APIGoogleLoginFunctionParams): Promise; diff --git a/dist/package-shared/functions/backend/addAdminUserOnLogin.d.ts b/dist/package-shared/functions/backend/addAdminUserOnLogin.d.ts new file mode 100644 index 0000000..33f89fe --- /dev/null +++ b/dist/package-shared/functions/backend/addAdminUserOnLogin.d.ts @@ -0,0 +1,20 @@ +import { DATASQUIREL_LoggedInUser } from "../../types"; +type Param = { + query: { + invite: number; + database_access: string; + priviledge: string; + email: string; + }; + user: DATASQUIREL_LoggedInUser; +}; +/** + * Add Admin User on Login + * ============================================================================== + * + * @description this function handles admin users that have been invited by another + * admin user. This fires when the invited user has been logged in or a new account + * has been created for the invited user + */ +export default function addAdminUserOnLogin({ query, user, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/backend/addMariadbUser.d.ts b/dist/package-shared/functions/backend/addMariadbUser.d.ts new file mode 100644 index 0000000..e7c4dbf --- /dev/null +++ b/dist/package-shared/functions/backend/addMariadbUser.d.ts @@ -0,0 +1,8 @@ +type Param = { + userId: number | string; +}; +/** + * # Add Mariadb User + */ +export default function addMariadbUser({ userId }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/backend/addUsersTableToDb.d.ts b/dist/package-shared/functions/backend/addUsersTableToDb.d.ts new file mode 100644 index 0000000..b46a28c --- /dev/null +++ b/dist/package-shared/functions/backend/addUsersTableToDb.d.ts @@ -0,0 +1,12 @@ +type Param = { + userId: number; + database: string; + payload?: { + [s: string]: any; + }; +}; +/** + * # Add User Table to Database + */ +export default function addUsersTableToDb({ userId, database, payload, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/backend/api-cred.d.ts b/dist/package-shared/functions/backend/api-cred.d.ts new file mode 100644 index 0000000..c88266c --- /dev/null +++ b/dist/package-shared/functions/backend/api-cred.d.ts @@ -0,0 +1,6 @@ +import { CheckApiCredentialsFn } from "../../types"; +/** + * # Grap API Credentials + */ +declare const grabApiCred: CheckApiCredentialsFn; +export default grabApiCred; diff --git a/dist/package-shared/functions/backend/auth/write-auth-files.d.ts b/dist/package-shared/functions/backend/auth/write-auth-files.d.ts new file mode 100644 index 0000000..fd55e29 --- /dev/null +++ b/dist/package-shared/functions/backend/auth/write-auth-files.d.ts @@ -0,0 +1,29 @@ +export declare const grabAuthDirs: () => { + root: string; + auth: string; +}; +export declare const initAuthFiles: () => boolean; +/** + * # Write Auth Files + */ +export declare const writeAuthFile: (name: string, data: string, cleanup?: { + userId: string | number; +}) => boolean; +/** + * # Clean up User Auth Files + */ +export declare const cleanupUserAuthFiles: (userId: string | number) => boolean; +/** + * # Get Auth Files + */ +export declare const getAuthFile: (name: string) => string | null; +/** + * # Delete Auth Files + * @param {string} name + */ +export declare const deleteAuthFile: (name: string) => void | null; +/** + * # Delete Auth Files + * @param {string} name + */ +export declare const checkAuthFile: (name: string) => boolean; diff --git a/dist/package-shared/functions/backend/cookies/get-auth-cookie-names.d.ts b/dist/package-shared/functions/backend/cookies/get-auth-cookie-names.d.ts new file mode 100644 index 0000000..d4e65ee --- /dev/null +++ b/dist/package-shared/functions/backend/cookies/get-auth-cookie-names.d.ts @@ -0,0 +1,14 @@ +type Param = { + database?: string; + userId?: string | number; +}; +type Return = { + keyCookieName: string; + csrfCookieName: string; + oneTimeCodeName: string; +}; +/** + * # Grab Auth Cookie Names + */ +export default function getAuthCookieNames(params?: Param): Return; +export {}; diff --git a/dist/package-shared/functions/backend/db/addDbEntry.d.ts b/dist/package-shared/functions/backend/db/addDbEntry.d.ts new file mode 100644 index 0000000..5158db4 --- /dev/null +++ b/dist/package-shared/functions/backend/db/addDbEntry.d.ts @@ -0,0 +1,20 @@ +import { DbContextsArray } from "./runQuery"; +type Param = { + dbContext?: (typeof DbContextsArray)[number]; + paradigm?: "Read Only" | "Full Access"; + dbFullName?: string; + tableName: string; + data: any; + tableSchema?: import("../../../types").DSQL_TableSchemaType; + duplicateColumnName?: string; + duplicateColumnValue?: string; + update?: boolean; + encryptionKey?: string; + encryptionSalt?: string; + forceLocal?: boolean; +}; +/** + * Add a db Entry Function + */ +export default function addDbEntry({ dbContext, paradigm, dbFullName, tableName, data, tableSchema, duplicateColumnName, duplicateColumnValue, update, encryptionKey, encryptionSalt, forceLocal, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/backend/db/deleteDbEntry.d.ts b/dist/package-shared/functions/backend/db/deleteDbEntry.d.ts new file mode 100644 index 0000000..c7e4e73 --- /dev/null +++ b/dist/package-shared/functions/backend/db/deleteDbEntry.d.ts @@ -0,0 +1,16 @@ +import { DbContextsArray } from "./runQuery"; +type Param = { + dbContext?: (typeof DbContextsArray)[number]; + dbFullName: string; + tableName: string; + tableSchema?: import("../../../types").DSQL_TableSchemaType; + identifierColumnName: string; + identifierValue: string | number; + forceLocal?: boolean; +}; +/** + * # Delete DB Entry Function + * @description + */ +export default function deleteDbEntry({ dbContext, dbFullName, tableName, identifierColumnName, identifierValue, forceLocal, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/backend/db/pathTraversalCheck.d.ts b/dist/package-shared/functions/backend/db/pathTraversalCheck.d.ts new file mode 100644 index 0000000..628f1c8 --- /dev/null +++ b/dist/package-shared/functions/backend/db/pathTraversalCheck.d.ts @@ -0,0 +1,5 @@ +/** + * # Path Traversal Check + * @returns {string} + */ +export default function pathTraversalCheck(text: string | number): string; diff --git a/dist/package-shared/functions/backend/db/runQuery.d.ts b/dist/package-shared/functions/backend/db/runQuery.d.ts new file mode 100644 index 0000000..50cab86 --- /dev/null +++ b/dist/package-shared/functions/backend/db/runQuery.d.ts @@ -0,0 +1,21 @@ +export declare const DbContextsArray: readonly ["Master", "Dsql User"]; +type Param = { + dbContext?: (typeof DbContextsArray)[number]; + dbFullName: string; + query: string | any; + readOnly?: boolean; + debug?: boolean; + dbSchema?: import("../../../types").DSQL_DatabaseSchemaType; + queryValuesArray?: (string | number)[]; + tableName?: string; + forceLocal?: boolean; +}; +type Return = { + result: any; + error?: string; +}; +/** + * # Run DSQL users queries + */ +export default function runQuery({ dbFullName, query, readOnly, dbSchema, queryValuesArray, tableName, debug, dbContext, forceLocal, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/backend/db/sanitizeSql.d.ts b/dist/package-shared/functions/backend/db/sanitizeSql.d.ts new file mode 100644 index 0000000..910380c --- /dev/null +++ b/dist/package-shared/functions/backend/db/sanitizeSql.d.ts @@ -0,0 +1,8 @@ +/** + * Sanitize SQL function + * ============================================================================== + * @description this function takes in a text(or number) and returns a sanitized + * text, usually without spaces + */ +declare function sanitizeSql(text: any, spaces?: boolean, regex?: RegExp | null): any; +export default sanitizeSql; diff --git a/dist/package-shared/functions/backend/db/updateDbEntry.d.ts b/dist/package-shared/functions/backend/db/updateDbEntry.d.ts new file mode 100644 index 0000000..fb12bbe --- /dev/null +++ b/dist/package-shared/functions/backend/db/updateDbEntry.d.ts @@ -0,0 +1,19 @@ +import { DbContextsArray } from "./runQuery"; +type Param = { + dbContext?: (typeof DbContextsArray)[number]; + dbFullName?: string; + tableName: string; + encryptionKey?: string; + encryptionSalt?: string; + data: any; + tableSchema?: import("../../../types").DSQL_TableSchemaType; + identifierColumnName: string; + identifierValue: string | number; + forceLocal?: boolean; +}; +/** + * # Update DB Function + * @description + */ +export default function updateDbEntry({ dbContext, dbFullName, tableName, data, tableSchema, identifierColumnName, identifierValue, encryptionKey, encryptionSalt, forceLocal, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/backend/dbHandler.d.ts b/dist/package-shared/functions/backend/dbHandler.d.ts new file mode 100644 index 0000000..7bfe147 --- /dev/null +++ b/dist/package-shared/functions/backend/dbHandler.d.ts @@ -0,0 +1,4 @@ +/** + * # Main DB Handler Function + */ +export default function dbHandler(...args: any[]): Promise; diff --git a/dist/package-shared/functions/backend/defaultFieldsRegexp.d.ts b/dist/package-shared/functions/backend/defaultFieldsRegexp.d.ts new file mode 100644 index 0000000..f9e698e --- /dev/null +++ b/dist/package-shared/functions/backend/defaultFieldsRegexp.d.ts @@ -0,0 +1,7 @@ +/** + * Regular expression to match default fields + * + * @description Regular expression to match default fields + */ +declare const defaultFieldsRegexp: RegExp; +export default defaultFieldsRegexp; diff --git a/dist/package-shared/functions/backend/fullAccessDbHandler.d.ts b/dist/package-shared/functions/backend/fullAccessDbHandler.d.ts new file mode 100644 index 0000000..828f500 --- /dev/null +++ b/dist/package-shared/functions/backend/fullAccessDbHandler.d.ts @@ -0,0 +1,11 @@ +type Param = { + queryString: string; + tableSchema?: import("../../types").DSQL_TableSchemaType | null; + queryValuesArray?: string[]; + forceLocal?: boolean; +}; +/** + * # Full Access Db Handler + */ +export default function fullAccessDbHandler({ queryString, tableSchema, queryValuesArray, forceLocal, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/backend/grabNewUsersTableSchema.d.ts b/dist/package-shared/functions/backend/grabNewUsersTableSchema.d.ts new file mode 100644 index 0000000..35a5aaa --- /dev/null +++ b/dist/package-shared/functions/backend/grabNewUsersTableSchema.d.ts @@ -0,0 +1,9 @@ +import { DSQL_TableSchemaType } from "../../types"; +/** + * # Add User Table to Database + */ +export default function grabNewUsersTableSchema(params: { + payload?: { + [s: string]: any; + }; +}): DSQL_TableSchemaType | null; diff --git a/dist/package-shared/functions/backend/grabSchemaFieldsFromData.d.ts b/dist/package-shared/functions/backend/grabSchemaFieldsFromData.d.ts new file mode 100644 index 0000000..3c76808 --- /dev/null +++ b/dist/package-shared/functions/backend/grabSchemaFieldsFromData.d.ts @@ -0,0 +1,16 @@ +import { DSQL_FieldSchemaType } from "../../types"; +type Param = { + data?: { + [s: string]: any; + }; + fields?: string[]; + excludeData?: { + [s: string]: any; + }; + excludeFields?: DSQL_FieldSchemaType[]; +}; +/** + * # Add User Table to Database + */ +export default function grabSchemaFieldsFromData({ data, fields, excludeData, excludeFields, }: Param): DSQL_FieldSchemaType[]; +export {}; diff --git a/dist/package-shared/functions/backend/grabUserSchemaData.d.ts b/dist/package-shared/functions/backend/grabUserSchemaData.d.ts new file mode 100644 index 0000000..db0268c --- /dev/null +++ b/dist/package-shared/functions/backend/grabUserSchemaData.d.ts @@ -0,0 +1,6 @@ +/** + * # Grab User Schema Data + */ +export default function grabUserSchemaData({ userId, }: { + userId: string | number; +}): import("../../types").DSQL_DatabaseSchemaType[] | null; diff --git a/dist/package-shared/functions/backend/handleNodemailer.d.ts b/dist/package-shared/functions/backend/handleNodemailer.d.ts new file mode 100644 index 0000000..a0a6f2e --- /dev/null +++ b/dist/package-shared/functions/backend/handleNodemailer.d.ts @@ -0,0 +1,11 @@ +import Mail from "nodemailer/lib/mailer"; +import SMTPTransport from "nodemailer/lib/smtp-transport"; +export type HandleNodemailerParam = Mail.Options & { + senderName?: string; + alias?: string | null; + options?: SMTPTransport.Options; +}; +/** + * # Handle mails With Nodemailer + */ +export default function handleNodemailer(params: HandleNodemailerParam): Promise; diff --git a/dist/package-shared/functions/backend/html/sanitizeHtmlOptions.d.ts b/dist/package-shared/functions/backend/html/sanitizeHtmlOptions.d.ts new file mode 100644 index 0000000..676f6c7 --- /dev/null +++ b/dist/package-shared/functions/backend/html/sanitizeHtmlOptions.d.ts @@ -0,0 +1,9 @@ +declare const sanitizeHtmlOptions: { + allowedTags: string[]; + allowedAttributes: { + a: string[]; + img: string[]; + "*": string[]; + }; +}; +export default sanitizeHtmlOptions; diff --git a/dist/package-shared/functions/backend/httpRequest.d.ts b/dist/package-shared/functions/backend/httpRequest.d.ts new file mode 100644 index 0000000..254966e --- /dev/null +++ b/dist/package-shared/functions/backend/httpRequest.d.ts @@ -0,0 +1,13 @@ +import { HttpFunctionResponse, HttpRequestParams } from "../../types"; +/** + * # Generate a http Request + */ +export default function httpRequest(params: HttpRequestParams): Promise>; diff --git a/dist/package-shared/functions/backend/httpsRequest.d.ts b/dist/package-shared/functions/backend/httpsRequest.d.ts new file mode 100644 index 0000000..836d4ca --- /dev/null +++ b/dist/package-shared/functions/backend/httpsRequest.d.ts @@ -0,0 +1,15 @@ +type Param = { + scheme?: string; + url?: string; + method?: string; + hostname?: string; + path?: string; + port?: number | string; + headers?: object; + body?: object; +}; +/** + * # Make Https Request + */ +export default function httpsRequest({ url, method, hostname, path, headers, body, port, scheme, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/backend/noDatabaseDbHandler.d.ts b/dist/package-shared/functions/backend/noDatabaseDbHandler.d.ts new file mode 100644 index 0000000..95dce69 --- /dev/null +++ b/dist/package-shared/functions/backend/noDatabaseDbHandler.d.ts @@ -0,0 +1,4 @@ +/** + * # No Database DB Handler + */ +export default function noDatabaseDbHandler(queryString: string): Promise; diff --git a/dist/package-shared/functions/backend/parseDbResults.d.ts b/dist/package-shared/functions/backend/parseDbResults.d.ts new file mode 100644 index 0000000..51a7845 --- /dev/null +++ b/dist/package-shared/functions/backend/parseDbResults.d.ts @@ -0,0 +1,13 @@ +type Param = { + unparsedResults: any[]; + tableSchema?: import("../../types").DSQL_TableSchemaType; +}; +/** + * Parse Database results + * ============================================================================== + * @description this function takes a database results array gotten from a DB handler + * function, decrypts encrypted fields, and returns an updated array with no encrypted + * fields + */ +export default function parseDbResults({ unparsedResults, tableSchema, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/backend/queues/add-queue.d.ts b/dist/package-shared/functions/backend/queues/add-queue.d.ts new file mode 100644 index 0000000..1253ea9 --- /dev/null +++ b/dist/package-shared/functions/backend/queues/add-queue.d.ts @@ -0,0 +1,10 @@ +import { DSQL_DATASQUIREL_PROCESS_QUEUE } from "../../../types/dsql"; +type Param = { + queue: DSQL_DATASQUIREL_PROCESS_QUEUE; + userId: string | number; + dummy?: boolean; +}; +export default function addQueue({ queue, userId, dummy }: Param): Promise<(import("../../../types").PostReturn & { + queryObject?: ReturnType>; +}) | null | undefined>; +export {}; diff --git a/dist/package-shared/functions/backend/queues/delete-queue.d.ts b/dist/package-shared/functions/backend/queues/delete-queue.d.ts new file mode 100644 index 0000000..99ed65a --- /dev/null +++ b/dist/package-shared/functions/backend/queues/delete-queue.d.ts @@ -0,0 +1,6 @@ +type Param = { + queueId: string | number; + userId: string | number; +}; +export default function deleteQueue({ queueId, userId }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/backend/queues/get-queue.d.ts b/dist/package-shared/functions/backend/queues/get-queue.d.ts new file mode 100644 index 0000000..b588aff --- /dev/null +++ b/dist/package-shared/functions/backend/queues/get-queue.d.ts @@ -0,0 +1,10 @@ +import { DSQL_DATASQUIREL_PROCESS_QUEUE } from "../../../types/dsql"; +import { DsqlCrudQueryObject } from "../../../types"; +type Param = { + queueId?: string | number; + userId?: string | number; + query?: DsqlCrudQueryObject; + single?: boolean; +}; +export default function getQueue({ queueId, userId, query, single, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/backend/queues/update-queue.d.ts b/dist/package-shared/functions/backend/queues/update-queue.d.ts new file mode 100644 index 0000000..3667a93 --- /dev/null +++ b/dist/package-shared/functions/backend/queues/update-queue.d.ts @@ -0,0 +1,7 @@ +import { DSQL_DATASQUIREL_PROCESS_QUEUE } from "../../../types/dsql"; +type Param = { + queueId: string | number; + queue: DSQL_DATASQUIREL_PROCESS_QUEUE; +}; +export default function updateQueue({ queueId, queue }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/backend/serverError.d.ts b/dist/package-shared/functions/backend/serverError.d.ts new file mode 100644 index 0000000..f8f1951 --- /dev/null +++ b/dist/package-shared/functions/backend/serverError.d.ts @@ -0,0 +1,18 @@ +import { IncomingMessage } from "http"; +type Param = { + user?: { + id?: number | string; + first_name?: string; + last_name?: string; + email?: string; + } & any; + message: string; + component?: string; + noMail?: boolean; + req?: import("next").NextApiRequest & IncomingMessage; +}; +/** + * # Server Error + */ +export default function serverError({ user, message, component, noMail, req, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/backend/setUserSchemaData.d.ts b/dist/package-shared/functions/backend/setUserSchemaData.d.ts new file mode 100644 index 0000000..38fd4fb --- /dev/null +++ b/dist/package-shared/functions/backend/setUserSchemaData.d.ts @@ -0,0 +1,10 @@ +import { DSQL_DatabaseSchemaType } from "../../types"; +type Param = { + userId: string | number; + schemaData: DSQL_DatabaseSchemaType[]; +}; +/** + * # Set User Schema Data + */ +export default function setUserSchemaData({ userId, schemaData, }: Param): boolean; +export {}; diff --git a/dist/package-shared/functions/backend/suSocketAuth.d.ts b/dist/package-shared/functions/backend/suSocketAuth.d.ts new file mode 100644 index 0000000..719ec0b --- /dev/null +++ b/dist/package-shared/functions/backend/suSocketAuth.d.ts @@ -0,0 +1,8 @@ +import { IncomingMessage } from "http"; +export default function (req: IncomingMessage): Promise<{ + email: string; + password: string; + authKey: string; + logged_in_status: boolean; + date: number; +} | null>; diff --git a/dist/package-shared/functions/backend/updateUsersTableSchema.d.ts b/dist/package-shared/functions/backend/updateUsersTableSchema.d.ts new file mode 100644 index 0000000..896c89e --- /dev/null +++ b/dist/package-shared/functions/backend/updateUsersTableSchema.d.ts @@ -0,0 +1,13 @@ +type Param = { + userId: number | string; + database: string; + newFields?: string[]; + newPayload?: { + [s: string]: any; + }; +}; +/** + * # Add User Table to Database + */ +export default function updateUsersTableSchema({ userId, database, newFields, newPayload, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/backend/varDatabaseDbHandler.d.ts b/dist/package-shared/functions/backend/varDatabaseDbHandler.d.ts new file mode 100644 index 0000000..07da850 --- /dev/null +++ b/dist/package-shared/functions/backend/varDatabaseDbHandler.d.ts @@ -0,0 +1,12 @@ +type Param = { + queryString: string; + queryValuesArray?: any[]; + database?: string; + tableSchema?: import("../../types").DSQL_TableSchemaType; + debug?: boolean; +}; +/** + * # DB handler for specific database + */ +export default function varDatabaseDbHandler({ queryString, queryValuesArray, database, tableSchema, debug, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/backend/varReadOnlyDatabaseDbHandler.d.ts b/dist/package-shared/functions/backend/varReadOnlyDatabaseDbHandler.d.ts new file mode 100644 index 0000000..e3c2272 --- /dev/null +++ b/dist/package-shared/functions/backend/varReadOnlyDatabaseDbHandler.d.ts @@ -0,0 +1,12 @@ +type Param = { + queryString: string; + queryValuesArray?: string[]; + tableSchema?: import("../../types").DSQL_TableSchemaType; + forceLocal?: boolean; +}; +/** + * # Read Only Db Handler with Varaibles + * @returns + */ +export default function varReadOnlyDatabaseDbHandler({ queryString, queryValuesArray, tableSchema, forceLocal, }: Param): Promise; +export {}; diff --git a/dist/package-shared/functions/dsql/db-schema-to-type.d.ts b/dist/package-shared/functions/dsql/db-schema-to-type.d.ts new file mode 100644 index 0000000..ed0cc73 --- /dev/null +++ b/dist/package-shared/functions/dsql/db-schema-to-type.d.ts @@ -0,0 +1,6 @@ +import { DSQL_DatabaseSchemaType } from "../../types"; +type Params = { + dbSchema?: DSQL_DatabaseSchemaType; +}; +export default function dbSchemaToType(params?: Params): string[] | undefined; +export {}; diff --git a/dist/package-shared/functions/dsql/decrypt.d.ts b/dist/package-shared/functions/dsql/decrypt.d.ts new file mode 100644 index 0000000..eb8b2f5 --- /dev/null +++ b/dist/package-shared/functions/dsql/decrypt.d.ts @@ -0,0 +1,10 @@ +type Param = { + encryptedString: string; + encryptionKey?: string; + encryptionSalt?: string; +}; +/** + * # Decrypt Function + */ +export default function decrypt({ encryptedString, encryptionKey, encryptionSalt, }: Param): string; +export {}; diff --git a/dist/package-shared/functions/dsql/default-fields-regexp.d.ts b/dist/package-shared/functions/dsql/default-fields-regexp.d.ts new file mode 100644 index 0000000..9a1f5b4 --- /dev/null +++ b/dist/package-shared/functions/dsql/default-fields-regexp.d.ts @@ -0,0 +1,7 @@ +/** + * Check for user in local storage + * + * @description Preventdefault, declare variables + */ +declare const defaultFieldsRegexp: RegExp; +export default defaultFieldsRegexp; diff --git a/dist/package-shared/functions/dsql/encrypt.d.ts b/dist/package-shared/functions/dsql/encrypt.d.ts new file mode 100644 index 0000000..e5aab16 --- /dev/null +++ b/dist/package-shared/functions/dsql/encrypt.d.ts @@ -0,0 +1,10 @@ +type Param = { + data: string; + encryptionKey?: string; + encryptionSalt?: string; +}; +/** + * # Encrypt String + */ +export default function encrypt({ data, encryptionKey, encryptionSalt, }: Param): string | null; +export {}; diff --git a/dist/package-shared/functions/dsql/generate-type-definitions.d.ts b/dist/package-shared/functions/dsql/generate-type-definitions.d.ts new file mode 100644 index 0000000..5560cb9 --- /dev/null +++ b/dist/package-shared/functions/dsql/generate-type-definitions.d.ts @@ -0,0 +1,11 @@ +import { DSQL_TableSchemaType } from "../../types"; +type Param = { + paradigm: "JavaScript" | "TypeScript" | undefined; + table: DSQL_TableSchemaType; + query?: any; + typeDefName?: string; + allValuesOptional?: boolean; + addExport?: boolean; +}; +export default function generateTypeDefinition({ paradigm, table, query, typeDefName, allValuesOptional, addExport, }: Param): string | null; +export {}; diff --git a/dist/package-shared/functions/dsql/hashPassword.d.ts b/dist/package-shared/functions/dsql/hashPassword.d.ts new file mode 100644 index 0000000..359ae68 --- /dev/null +++ b/dist/package-shared/functions/dsql/hashPassword.d.ts @@ -0,0 +1,9 @@ +type Param = { + password: string; + encryptionKey?: string; +}; +/** + * # Hash password Function + */ +export default function hashPassword({ password, encryptionKey, }: Param): string; +export {}; diff --git a/dist/package-shared/functions/dsql/sql/sql-delete-generator.d.ts b/dist/package-shared/functions/dsql/sql/sql-delete-generator.d.ts new file mode 100644 index 0000000..b423204 --- /dev/null +++ b/dist/package-shared/functions/dsql/sql/sql-delete-generator.d.ts @@ -0,0 +1,13 @@ +interface SQLDeleteGenReturn { + query: string; + values: string[]; +} +/** + * # SQL Delete Generator + */ +export default function sqlDeleteGenerator({ tableName, data, dbFullName, }: { + data: any; + tableName: string; + dbFullName?: string; +}): SQLDeleteGenReturn | undefined; +export {}; diff --git a/dist/package-shared/functions/dsql/sql/sql-generator.d.ts b/dist/package-shared/functions/dsql/sql/sql-generator.d.ts new file mode 100644 index 0000000..a107975 --- /dev/null +++ b/dist/package-shared/functions/dsql/sql/sql-generator.d.ts @@ -0,0 +1,24 @@ +import { ServerQueryParam } from "../../../types"; +type Param = { + genObject?: ServerQueryParam; + tableName: string; + dbFullName?: string; +}; +type Return = { + string: string; + values: string[]; +}; +/** + * # SQL Query Generator + * @description Generates an SQL Query for node module `mysql` or `serverless-mysql` + */ +export default function sqlGenerator({ tableName, genObject, dbFullName }: Param): Return; +export {}; diff --git a/dist/package-shared/functions/dsql/sql/sql-insert-generator.d.ts b/dist/package-shared/functions/dsql/sql/sql-insert-generator.d.ts new file mode 100644 index 0000000..646b504 --- /dev/null +++ b/dist/package-shared/functions/dsql/sql/sql-insert-generator.d.ts @@ -0,0 +1,13 @@ +interface SQLInsertGenReturn { + query: string; + values: string[]; +} +/** + * # SQL Insert Generator + */ +export default function sqlInsertGenerator({ tableName, data, dbFullName, }: { + data: any[]; + tableName: string; + dbFullName?: string; +}): SQLInsertGenReturn | undefined; +export {}; diff --git a/dist/package-shared/functions/email/fns/validate-email.d.ts b/dist/package-shared/functions/email/fns/validate-email.d.ts new file mode 100644 index 0000000..3358698 --- /dev/null +++ b/dist/package-shared/functions/email/fns/validate-email.d.ts @@ -0,0 +1,10 @@ +import { HandleNodemailerParam } from "../../backend/handleNodemailer"; +type Param = { + email?: string; + welcomeEmailOptions?: HandleNodemailerParam; +}; +export default function validateEmail({ email, welcomeEmailOptions, }: Param): Promise<{ + isValid: boolean; + message?: string; +}>; +export {}; diff --git a/dist/package-shared/functions/email/verification/email-mx-lookup.d.ts b/dist/package-shared/functions/email/verification/email-mx-lookup.d.ts new file mode 100644 index 0000000..d7cc4e3 --- /dev/null +++ b/dist/package-shared/functions/email/verification/email-mx-lookup.d.ts @@ -0,0 +1 @@ +export default function emailMxLookup(email?: string, debug?: boolean): Promise; diff --git a/dist/package-shared/functions/email/verification/email-regex-test.d.ts b/dist/package-shared/functions/email/verification/email-regex-test.d.ts new file mode 100644 index 0000000..e458c71 --- /dev/null +++ b/dist/package-shared/functions/email/verification/email-regex-test.d.ts @@ -0,0 +1 @@ +export default function emailRegexCheck(email: string): boolean; diff --git a/dist/package-shared/functions/email/verification/smtp-verification.d.ts b/dist/package-shared/functions/email/verification/smtp-verification.d.ts new file mode 100644 index 0000000..c52a7aa --- /dev/null +++ b/dist/package-shared/functions/email/verification/smtp-verification.d.ts @@ -0,0 +1 @@ +export default function verifyEmailSMTP(email: string): Promise; diff --git a/dist/package-shared/shell/checkDb.d.ts b/dist/package-shared/shell/checkDb.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/checkDb.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/createDbFromSchema/check-db-record.d.ts b/dist/package-shared/shell/createDbFromSchema/check-db-record.d.ts new file mode 100644 index 0000000..040e60e --- /dev/null +++ b/dist/package-shared/shell/createDbFromSchema/check-db-record.d.ts @@ -0,0 +1,12 @@ +import { DSQL_DatabaseSchemaType } from "../../types"; +import { DSQL_DATASQUIREL_USER_DATABASES } from "../../types/dsql"; +type Param = { + userId?: number | string | null; + dbSchema: DSQL_DatabaseSchemaType; +}; +/** + * # Create database from Schema Function + * @requires DSQL_DB_CONN - Gobal Variable for Datasquirel Database + */ +export default function checkDbRecordCreateDbSchema({ userId, dbSchema, }: Param): Promise; +export {}; diff --git a/dist/package-shared/shell/createDbFromSchema/check-table-record.d.ts b/dist/package-shared/shell/createDbFromSchema/check-table-record.d.ts new file mode 100644 index 0000000..4673583 --- /dev/null +++ b/dist/package-shared/shell/createDbFromSchema/check-table-record.d.ts @@ -0,0 +1,15 @@ +import { DSQL_DatabaseSchemaType, DSQL_TableSchemaType } from "../../types"; +import { DSQL_DATASQUIREL_USER_DATABASE_TABLES, DSQL_DATASQUIREL_USER_DATABASES } from "../../types/dsql"; +type Param = { + userId?: number | string | null; + tableSchema?: DSQL_TableSchemaType; + dbSchema: DSQL_DatabaseSchemaType[]; + dbRecord?: DSQL_DATASQUIREL_USER_DATABASES; + dbFullName: string; +}; +/** + * # Create database from Schema Function + * @requires DSQL_DB_CONN - Gobal Variable for Datasquirel Database + */ +export default function checkTableRecordCreateDbSchema({ userId, tableSchema, dbSchema, dbRecord, dbFullName, }: Param): Promise; +export {}; diff --git a/dist/package-shared/shell/createDbFromSchema/handle-indexes.d.ts b/dist/package-shared/shell/createDbFromSchema/handle-indexes.d.ts new file mode 100644 index 0000000..b0c9b2f --- /dev/null +++ b/dist/package-shared/shell/createDbFromSchema/handle-indexes.d.ts @@ -0,0 +1,14 @@ +import { DSQL_IndexSchemaType } from "../../types"; +type Param = { + tableName: string; + dbFullName: string; + indexes: DSQL_IndexSchemaType[]; +}; +/** + * Handle DATASQUIREL Table Indexes + * =================================================== + * @description Iterate through each datasquirel schema + * table index(if available), and perform operations + */ +export default function handleIndexescreateDbFromSchema({ dbFullName, tableName, indexes, }: Param): Promise; +export {}; diff --git a/dist/package-shared/shell/createDbFromSchema/index.d.ts b/dist/package-shared/shell/createDbFromSchema/index.d.ts new file mode 100644 index 0000000..a350e69 --- /dev/null +++ b/dist/package-shared/shell/createDbFromSchema/index.d.ts @@ -0,0 +1,11 @@ +type Param = { + userId?: number | string | null; + targetDatabase?: string; + dbSchemaData?: import("../../types").DSQL_DatabaseSchemaType[]; +}; +/** + * # Create database from Schema Function + * @requires DSQL_DB_CONN - Gobal Variable for Datasquirel Database + */ +export default function createDbFromSchema({ userId, targetDatabase, dbSchemaData, }: Param): Promise; +export {}; diff --git a/dist/package-shared/shell/deploy.d.ts b/dist/package-shared/shell/deploy.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/deploy.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/encodingUpdate.d.ts b/dist/package-shared/shell/encodingUpdate.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/encodingUpdate.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/functions/jsonToBase64.d.ts b/dist/package-shared/shell/functions/jsonToBase64.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/functions/jsonToBase64.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/grantFullPriviledges.d.ts b/dist/package-shared/shell/grantFullPriviledges.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/grantFullPriviledges.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/lessWatch.d.ts b/dist/package-shared/shell/lessWatch.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/lessWatch.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/mariadb-users/handleGrants.d.ts b/dist/package-shared/shell/mariadb-users/handleGrants.d.ts new file mode 100644 index 0000000..050d8cb --- /dev/null +++ b/dist/package-shared/shell/mariadb-users/handleGrants.d.ts @@ -0,0 +1,16 @@ +export interface GrantType { + database: string; + table: string; + privileges: string[]; +} +type Param = { + username?: string; + host?: string; + grants?: GrantType[]; + userId: string; +}; +/** + * # Handle Grants for Users + */ +export default function handleGrants({ username, host, grants, userId, }: Param): Promise; +export {}; diff --git a/dist/package-shared/shell/mariadb-users/refreshUsersAndGrants.d.ts b/dist/package-shared/shell/mariadb-users/refreshUsersAndGrants.d.ts new file mode 100644 index 0000000..99d4596 --- /dev/null +++ b/dist/package-shared/shell/mariadb-users/refreshUsersAndGrants.d.ts @@ -0,0 +1,11 @@ +type Param = { + userId?: number | string; + mariadbUserHost?: string; + mariadbUsername?: string; + sqlUserID?: string | number; +}; +/** + * # Refresh Mariadb User Grants + */ +export default function refreshUsersAndGrants({ userId, mariadbUserHost, mariadbUsername, sqlUserID, }: Param): Promise; +export {}; diff --git a/dist/package-shared/shell/mariadb-users/resetSQLPasswords.d.ts b/dist/package-shared/shell/mariadb-users/resetSQLPasswords.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/mariadb-users/resetSQLPasswords.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/mariadb-users/users/create-user.d.ts b/dist/package-shared/shell/mariadb-users/users/create-user.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/mariadb-users/users/create-user.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/mariadb-users/users/update-user.d.ts b/dist/package-shared/shell/mariadb-users/users/update-user.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/mariadb-users/users/update-user.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/readImage.d.ts b/dist/package-shared/shell/readImage.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/readImage.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/recoverMainJsonFromDb.d.ts b/dist/package-shared/shell/recoverMainJsonFromDb.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/recoverMainJsonFromDb.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/resetSQLCredentials.d.ts b/dist/package-shared/shell/resetSQLCredentials.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/resetSQLCredentials.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/resetSQLCredentialsPasswords.d.ts b/dist/package-shared/shell/resetSQLCredentialsPasswords.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/resetSQLCredentialsPasswords.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/scripts/convert-js-to-ts.d.ts b/dist/package-shared/shell/scripts/convert-js-to-ts.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/scripts/convert-js-to-ts.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/setSQLCredentials.d.ts b/dist/package-shared/shell/setSQLCredentials.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/setSQLCredentials.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/tailwindWatch.d.ts b/dist/package-shared/shell/tailwindWatch.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/tailwindWatch.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/test-external-server.d.ts b/dist/package-shared/shell/test-external-server.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/test-external-server.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/testSQLEscape.d.ts b/dist/package-shared/shell/testSQLEscape.d.ts new file mode 100644 index 0000000..4d08c82 --- /dev/null +++ b/dist/package-shared/shell/testSQLEscape.d.ts @@ -0,0 +1,10 @@ +/** ****************************************************************************** */ +/** ****************************************************************************** */ +/** ****************************************************************************** */ +/** ****************************************************************************** */ +/** ****************************************************************************** */ +/** ****************************************************************************** */ +/** + * # Test SQL Escape + */ +export default function testSQLEscape(): Promise; diff --git a/dist/package-shared/shell/updateChildrenTablesOnDb.d.ts b/dist/package-shared/shell/updateChildrenTablesOnDb.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/updateChildrenTablesOnDb.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/updateDateTimestamps.d.ts b/dist/package-shared/shell/updateDateTimestamps.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/updateDateTimestamps.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/updateDbSlugsForTableRecords.d.ts b/dist/package-shared/shell/updateDbSlugsForTableRecords.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/updateDbSlugsForTableRecords.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/updateSSLUsers.d.ts b/dist/package-shared/shell/updateSSLUsers.d.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/dist/package-shared/shell/updateSSLUsers.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/dist/package-shared/shell/utils/camelJoinedtoCamelSpace.d.ts b/dist/package-shared/shell/utils/camelJoinedtoCamelSpace.d.ts new file mode 100644 index 0000000..0e45d5d --- /dev/null +++ b/dist/package-shared/shell/utils/camelJoinedtoCamelSpace.d.ts @@ -0,0 +1,7 @@ +/** + * Convert Camel Joined Text to Camel Spaced Text + * ============================================================================== + * @description this function takes a camel cased text without spaces, and returns + * a camel-case-spaced text + */ +export default function camelJoinedtoCamelSpace(text: string): string | null; diff --git a/dist/package-shared/shell/utils/createTable.d.ts b/dist/package-shared/shell/utils/createTable.d.ts new file mode 100644 index 0000000..8d81665 --- /dev/null +++ b/dist/package-shared/shell/utils/createTable.d.ts @@ -0,0 +1,13 @@ +import { DSQL_TableSchemaType } from "../../types"; +type Param = { + dbFullName: string; + tableName: string; + tableInfoArray: any[]; + tableSchema?: DSQL_TableSchemaType; + recordedDbEntry?: any; +}; +/** + * # Create Table Functions + */ +export default function createTable({ dbFullName, tableName, tableInfoArray, tableSchema, recordedDbEntry, }: Param): Promise; +export {}; diff --git a/dist/package-shared/shell/utils/dbHandler.d.ts b/dist/package-shared/shell/utils/dbHandler.d.ts new file mode 100644 index 0000000..b8c16d4 --- /dev/null +++ b/dist/package-shared/shell/utils/dbHandler.d.ts @@ -0,0 +1,10 @@ +type Param = { + query: string; + values?: string[] | object; +}; +/** + * # Main DB Handler Function + * @requires DSQL_DB_CONN - Gobal Variable for Datasquirel Database + */ +export default function dbHandler({ query, values, }: Param): Promise; +export {}; diff --git a/dist/package-shared/shell/utils/generateColumnDescription.d.ts b/dist/package-shared/shell/utils/generateColumnDescription.d.ts new file mode 100644 index 0000000..39e293f --- /dev/null +++ b/dist/package-shared/shell/utils/generateColumnDescription.d.ts @@ -0,0 +1,13 @@ +type Param = { + columnData: import("../../types").DSQL_FieldSchemaType; + primaryKeySet?: boolean; +}; +type Return = { + fieldEntryText: string; + newPrimaryKeySet: boolean; +}; +/** + * # Generate Table Column Description + */ +export default function generateColumnDescription({ columnData, primaryKeySet, }: Param): Return; +export {}; diff --git a/dist/package-shared/shell/utils/noDatabaseDbHandler.d.ts b/dist/package-shared/shell/utils/noDatabaseDbHandler.d.ts new file mode 100644 index 0000000..975eb54 --- /dev/null +++ b/dist/package-shared/shell/utils/noDatabaseDbHandler.d.ts @@ -0,0 +1 @@ +export default function noDatabaseDbHandler(queryString: string): Promise; diff --git a/dist/package-shared/shell/utils/slugToCamelTitle.d.ts b/dist/package-shared/shell/utils/slugToCamelTitle.d.ts new file mode 100644 index 0000000..6da4a1e --- /dev/null +++ b/dist/package-shared/shell/utils/slugToCamelTitle.d.ts @@ -0,0 +1,4 @@ +/** + * # Sulg To Camel Case + */ +export default function slugToCamelTitle(text: string): string | null; diff --git a/dist/package-shared/shell/utils/supplementTable.d.ts b/dist/package-shared/shell/utils/supplementTable.d.ts new file mode 100644 index 0000000..5bd56ad --- /dev/null +++ b/dist/package-shared/shell/utils/supplementTable.d.ts @@ -0,0 +1,14 @@ +import { DSQL_FieldSchemaType } from "../../types"; +type Param = { + tableInfoArray: DSQL_FieldSchemaType[]; +}; +/** + * # Supplement Table + */ +export default function supplementTable({ tableInfoArray }: Param): DSQL_FieldSchemaType[]; +export {}; +/** ****************************************************************************** */ +/** ****************************************************************************** */ +/** ****************************************************************************** */ +/** ****************************************************************************** */ +/** ****************************************************************************** */ diff --git a/dist/package-shared/shell/utils/updateTable.d.ts b/dist/package-shared/shell/utils/updateTable.d.ts new file mode 100644 index 0000000..290cf59 --- /dev/null +++ b/dist/package-shared/shell/utils/updateTable.d.ts @@ -0,0 +1,19 @@ +type Param = { + dbFullName: string; + tableName: string; + tableSchema: import("../../types").DSQL_TableSchemaType; + tableNameFull?: string; + tableInfoArray: import("../../types").DSQL_FieldSchemaType[]; + userId?: number | string | null; + dbSchema: import("../../types").DSQL_DatabaseSchemaType[]; + tableIndexes?: import("../../types").DSQL_IndexSchemaType[]; + clone?: boolean; + tableIndex?: number; + childDb?: boolean; + recordedDbEntry?: any; +}; +/** + * # Update table function + */ +export default function updateTable({ dbFullName, tableName, tableInfoArray, userId, dbSchema, tableIndexes, tableSchema, clone, childDb, tableIndex, tableNameFull, recordedDbEntry, }: Param): Promise; +export {}; diff --git a/dist/package-shared/shell/utils/varDatabaseDbHandler.d.ts b/dist/package-shared/shell/utils/varDatabaseDbHandler.d.ts new file mode 100644 index 0000000..52ffafc --- /dev/null +++ b/dist/package-shared/shell/utils/varDatabaseDbHandler.d.ts @@ -0,0 +1,9 @@ +type Param = { + queryString: string; + queryValuesArray?: string[]; +}; +/** + * # DB handler for specific database + */ +export default function varDatabaseDbHandler({ queryString, queryValuesArray, }: Param): Promise; +export {}; diff --git a/dist/package-shared/types/dsql.d.ts b/dist/package-shared/types/dsql.d.ts new file mode 100644 index 0000000..5774dd1 --- /dev/null +++ b/dist/package-shared/types/dsql.d.ts @@ -0,0 +1,309 @@ +export declare const DsqlTables: readonly ["users", "mariadb_users", "api_keys", "invitations", "user_users", "delegated_user_tables", "user_databases", "user_database_tables", "user_media", "delegated_users", "unsubscribes", "notifications", "docs_pages", "docs_page_extra_links", "deleted_api_keys", "servers", "process_queue"]; +export type DSQL_DATASQUIREL_USERS = { + id?: number; + uuid?: string; + first_name?: string; + last_name?: string; + uid?: string; + email?: string; + user_type?: string; + user_priviledge?: number; + username?: string; + password?: string; + image?: string; + image_thumbnail?: string; + social_login?: number; + social_platform?: string; + social_id?: string; + mariadb_user?: string; + mariadb_host?: string; + mariadb_pass?: string; + disk_usage_in_mb?: number; + verification_status?: number; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +}; +export type DSQL_DATASQUIREL_MARIADB_USERS = { + id?: number; + uuid?: string; + user_id?: number; + username?: string; + host?: string; + password?: string; + primary?: number; + grants?: string; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +}; +export type DSQL_DATASQUIREL_API_KEYS = { + id?: number; + uuid?: string; + user_id?: number; + name?: string; + slug?: string; + key?: string; + scope?: string; + csrf?: string; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +}; +export type DSQL_DATASQUIREL_INVITATIONS = { + id?: number; + uuid?: string; + inviting_user_id?: number; + invited_user_email?: string; + invitation_status?: string; + database_access?: string; + priviledge?: string; + db_tables_data?: string; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +}; +export type DSQL_DATASQUIREL_USER_USERS = { + id?: number; + uuid?: string; + user_id?: number; + invited_user_id?: number; + database?: string; + database_access?: string; + first_name?: string; + last_name?: string; + email?: string; + username?: string; + password?: string; + phone?: string; + user_type?: string; + user_priviledge?: string; + image?: string; + image_thumbnail?: string; + city?: string; + state?: string; + country?: string; + zip_code?: string; + address?: string; + social_login?: number; + social_platform?: string; + social_id?: string; + verification_status?: number; + more_user_data?: string; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +}; +export type DSQL_DATASQUIREL_DELEGATED_USER_TABLES = { + id?: number; + uuid?: string; + delegated_user_id?: number; + root_user_id?: number; + database?: string; + table?: string; + priviledge?: string; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +}; +export type DSQL_DATASQUIREL_USER_DATABASES = { + id?: number; + uuid?: string; + user_id?: number; + db_name?: string; + db_slug?: string; + db_full_name?: string; + db_image?: string; + db_description?: string; + remote_connected?: number; + remote_connection_type?: string; + remote_db_full_name?: string; + remote_connection_host?: string; + remote_connection_key?: string; + active_clone?: number; + active_clone_parent_db?: string; + active_data?: number; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +}; +export type DSQL_DATASQUIREL_USER_DATABASE_TABLES = { + id?: number; + uuid?: string; + user_id?: number; + db_id?: number; + db_slug?: string; + table_name?: string; + table_slug?: string; + table_description?: string; + child_table?: number; + child_table_parent_database?: string; + child_table_parent_table?: string; + active_data?: number; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +}; +export type DSQL_DATASQUIREL_USER_MEDIA = { + id?: number; + uuid?: string; + user_id?: number; + media_name?: string; + folder?: string; + media_url?: string; + media_thumbnail_url?: string; + media_path?: string; + media_thumbnail_path?: string; + media_type?: string; + width?: number; + height?: number; + size?: number; + private?: number; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +}; +export type DSQL_DATASQUIREL_DELEGATED_USERS = { + id?: number; + uuid?: string; + user_id?: number; + delegated_user_id?: number; + permissions?: string; + permission_level_code?: number; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +}; +export type DSQL_DATASQUIREL_UNSUBSCRIBES = { + id?: number; + uuid?: string; + user_id?: number; + email?: string; + type?: string; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +}; +export type DSQL_DATASQUIREL_NOTIFICATIONS = { + id?: number; + uuid?: string; + user_id?: number; + title?: string; + message?: string; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +}; +export type DSQL_DATASQUIREL_DOCS_PAGES = { + id?: number; + uuid?: string; + title?: string; + slug?: string; + description?: string; + content?: string; + text_content?: string; + level?: number; + page_order?: number; + parent_id?: number; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +}; +export type DSQL_DATASQUIREL_DOCS_PAGE_EXTRA_LINKS = { + id?: number; + uuid?: string; + docs_page_id?: number; + title?: string; + description?: string; + url?: string; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +}; +export type DSQL_DATASQUIREL_DELETED_API_KEYS = { + id?: number; + uuid?: string; + user_id?: number; + key?: string; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +}; +export type DSQL_DATASQUIREL_SERVERS = { + id?: number; + uuid?: string; + server_id?: number; + ip?: string; + ssh_user?: string; + ssh_port?: number; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +}; +export type DSQL_DATASQUIREL_PROCESS_QUEUE = { + id?: number; + uuid?: string; + user_id?: number; + title?: string; + job_type?: string; + data?: string; + running?: number; + server_id?: number; + error?: number; + error_message?: string; + success?: number; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +}; diff --git a/dist/package-shared/types/index.d.ts b/dist/package-shared/types/index.d.ts new file mode 100644 index 0000000..903e99d --- /dev/null +++ b/dist/package-shared/types/index.d.ts @@ -0,0 +1,1407 @@ +import type { RequestOptions } from "https"; +import { Editor } from "tinymce"; +export type DSQL_DatabaseFullName = string; +export interface DSQL_DatabaseSchemaType { + dbName: string; + dbSlug: string; + dbFullName: string; + dbDescription?: string; + dbImage?: string; + tables: DSQL_TableSchemaType[]; + childrenDatabases?: DSQL_ChildrenDatabaseObject[]; + childDatabase?: boolean; + childDatabaseDbFullName?: string; + updateData?: boolean; +} +export interface DSQL_ChildrenDatabaseObject { + dbFullName: string; +} +export interface DSQL_TableSchemaType { + tableName: string; + tableFullName: string; + tableDescription?: string; + fields: DSQL_FieldSchemaType[]; + indexes?: DSQL_IndexSchemaType[]; + childrenTables?: DSQL_ChildrenTablesType[]; + childTable?: boolean; + updateData?: boolean; + childTableName?: string; + childTableDbFullName?: string; + tableNameOld?: string; +} +export interface DSQL_ChildrenTablesType { + dbNameFull: string; + tableName: string; + tableNameFull?: string; +} +export declare const TextFieldTypesArray: readonly [{ + readonly title: "Plain Text"; + readonly value: "plain"; +}, { + readonly title: "Rich Text"; + readonly value: "richText"; +}, { + readonly title: "JSON"; + readonly value: "json"; +}, { + readonly title: "YAML"; + readonly value: "yaml"; +}, { + readonly title: "HTML"; + readonly value: "html"; +}, { + readonly title: "CSS"; + readonly value: "css"; +}, { + readonly title: "Javascript"; + readonly value: "javascript"; +}, { + readonly title: "Shell"; + readonly value: "shell"; +}]; +export type DSQL_FieldSchemaType = { + fieldName?: string; + originName?: string; + updatedField?: boolean; + dataType?: string; + nullValue?: boolean; + notNullValue?: boolean; + primaryKey?: boolean; + encrypted?: boolean; + autoIncrement?: boolean; + defaultValue?: string | number; + defaultValueLiteral?: string; + foreignKey?: DSQL_ForeignKeyType; + newTempField?: boolean; + defaultField?: boolean; + plainText?: boolean; + unique?: boolean; + pattern?: string; + patternFlags?: string; + onUpdate?: string; + onUpdateLiteral?: string; + onDelete?: string; + onDeleteLiteral?: string; + cssFiles?: string[]; + integerLength?: string | number; + decimals?: string | number; +} & { + [key in (typeof TextFieldTypesArray)[number]["value"]]?: boolean; +}; +export interface DSQL_ForeignKeyType { + foreignKeyName?: string; + destinationTableName?: string; + destinationTableColumnName?: string; + destinationTableColumnType?: string; + cascadeDelete?: boolean; + cascadeUpdate?: boolean; +} +export interface DSQL_IndexSchemaType { + indexName?: string; + indexType?: string; + indexTableFields?: DSQL_IndexTableFieldType[]; + alias?: string; + newTempIndex?: boolean; +} +export interface DSQL_IndexTableFieldType { + value: string; + dataType: string; +} +export interface DSQL_MYSQL_SHOW_INDEXES_Type { + Key_name: string; + Table: string; + Column_name: string; + Collation: string; + Index_type: string; + Cardinality: string; + Index_comment: string; + Comment: string; +} +export interface DSQL_MYSQL_SHOW_COLUMNS_Type { + Field: string; + Type: string; + Null: string; + Key: string; + Default: string; + Extra: string; +} +export interface DSQL_MYSQL_FOREIGN_KEYS_Type { + CONSTRAINT_NAME: string; + CONSTRAINT_SCHEMA: string; + TABLE_NAME: string; +} +export interface DSQL_MYSQL_user_databases_Type { + id: number; + user_id: number; + db_full_name: string; + db_name: string; + db_slug: string; + db_image: string; + db_description: string; + active_clone: number; + active_data: 0 | 1; + active_clone_parent_db: string; + remote_connected?: number; + remote_db_full_name?: string; + remote_connection_host?: string; + remote_connection_key?: string; + remote_connection_type?: string; + user_priviledge?: string; + date_created?: string; + image_thumbnail?: string; + first_name?: string; + last_name?: string; + email?: string; +} +export interface PackageUserLoginRequestBody { + encryptionKey: string; + payload: any; + database: string; + additionalFields?: string[]; + email_login?: boolean; + email_login_code?: string; + email_login_field?: string; + token?: boolean; + social?: boolean; + dbSchema?: DSQL_DatabaseSchemaType; + skipPassword?: boolean; + dbUserId: string | number; +} +export interface PackageUserLoginLocalBody { + payload: any; + additionalFields?: string[]; + email_login?: boolean; + email_login_code?: string; + email_login_field?: string; + token?: boolean; + social?: boolean; + dbSchema?: DSQL_DatabaseSchemaType; + skipPassword?: boolean; +} +export type ImageInputFileToBase64FunctionReturn = { + imageBase64?: string; + imageBase64Full?: string; + imageName?: string; + imageSize?: number; +}; +export interface GetReqQueryObject { + db: string; + query: string; + queryValues?: string; + tableName?: string; + debug?: boolean; +} +export type DATASQUIREL_LoggedInUser = { + id: number; + uuid?: string; + first_name: string; + last_name: string; + email: string; + phone?: string; + user_type?: string; + username?: string; + image?: string; + image_thumbnail?: string; + social_login?: number; + social_platform?: string; + social_id?: string; + verification_status?: number; + csrf_k: string; + logged_in_status: boolean; + date: number; +} & { + [key: string]: any; +}; +export interface AuthenticatedUser { + success: boolean; + payload: DATASQUIREL_LoggedInUser | null; + msg?: string; + userId?: number; + cookieNames?: any; +} +export interface SuccessUserObject { + id: number; + first_name: string; + last_name: string; + email: string; +} +export interface AddUserFunctionReturn { + success: boolean; + payload?: SuccessUserObject | null; + msg?: string; + sqlResult?: any; +} +export interface GoogleIdentityPromptNotification { + getMomentType: () => string; + getDismissedReason: () => string; + getNotDisplayedReason: () => string; + getSkippedReason: () => string; + isDismissedMoment: () => boolean; + isDisplayMoment: () => boolean; + isDisplayed: () => boolean; + isNotDisplayed: () => boolean; + isSkippedMoment: () => boolean; +} +export type UserDataPayload = { + first_name: string; + last_name: string; + email: string; + password?: string; + username?: string; +} & { + [key: string]: any; +}; +export interface GetUserFunctionReturn { + success: boolean; + payload: { + id: number; + first_name: string; + last_name: string; + username: string; + email: string; + phone: string; + social_id: [string]; + image: string; + image_thumbnail: string; + verification_status: [number]; + } | null; +} +export interface ReauthUserFunctionReturn { + success: boolean; + payload: DATASQUIREL_LoggedInUser | null; + msg?: string; + userId?: number; + token?: string; +} +export interface UpdateUserFunctionReturn { + success: boolean; + payload?: Object[] | string; +} +export interface GetReturn { + success: boolean; + payload?: any; + msg?: string; + error?: string; + schema?: DSQL_TableSchemaType; + finalQuery?: string; +} +export interface GetSchemaRequestQuery { + database?: string; + table?: string; + field?: string; + user_id?: string | number; + env?: { + [k: string]: string; + }; +} +export interface GetSchemaAPICredentialsParam { + key: string; +} +export type GetSchemaAPIParam = GetSchemaRequestQuery & GetSchemaAPICredentialsParam; +export interface PostReturn { + success: boolean; + payload?: Object[] | string | PostInsertReturn; + msg?: string; + error?: any; + schema?: DSQL_TableSchemaType; +} +export interface PostDataPayload { + action: "insert" | "update" | "delete"; + table: string; + data?: object; + identifierColumnName?: string; + identifierValue?: string; + duplicateColumnName?: string; + duplicateColumnValue?: string; + update?: boolean; +} +export interface LocalPostReturn { + success: boolean; + payload?: any; + msg?: string; + error?: string; +} +export interface LocalPostQueryObject { + query: string | PostDataPayload; + tableName?: string; + queryValues?: string[]; +} +export interface PostInsertReturn { + fieldCount: number; + affectedRows: number; + insertId: number; + serverStatus: number; + warningCount: number; + message: string; + protocol41: boolean; + changedRows: number; +} +export type UserType = DATASQUIREL_LoggedInUser; +export interface ApiKeyDef { + name: string; + scope: string; + date_created: string; + apiKeyPayload: string; +} +export interface MetricsType { + dbCount: number; + tablesCount: number; + mediaCount: number; + apiKeysCount: number; +} +export interface DashboardContextType { + user?: UserType; + databases?: DSQL_MYSQL_user_databases_Type[]; + setTargetDatabase?: React.Dispatch>; + targetDatabase?: DSQL_MYSQL_user_databases_Type; + metrics?: MetricsType; +} +export interface AddDbContextType { + user?: UserType; + databases?: DSQL_MYSQL_user_databases_Type[]; + dbImage?: string | null | ImageObjectType; + setDbImage?: React.Dispatch>; + query?: any; + duplicateDb?: DSQL_MYSQL_user_databases_Type; +} +export interface EditDbContextType { + user?: UserType; + database?: DSQL_MYSQL_user_databases_Type; + dbImage?: string | null | ImageObjectType; + setDbImage?: React.Dispatch>; +} +export interface RichTextEditorsRefArray { + fieldName: string; + ref: React.MutableRefObject; +} +export interface JSONTextEditorsRefArray { + fieldName: string; + ref: React.MutableRefObject; +} +export interface TableEntriesContextType { + user: UserType; + database: DSQL_MYSQL_user_databases_Type; + table: DSQL_TableSchemaType; + dbSchemaData: DSQL_DatabaseSchemaType[]; + entries: any[]; + targetEntry?: any; + setTargetEntry: React.Dispatch>; + richTextEditors: React.MutableRefObject; + jsonTextEditors: React.MutableRefObject; + query?: any; + confirmedDelegetedUser?: any; + activeEntries: any[] | null; + setActiveEntries: React.Dispatch>; + targetField: React.MutableRefObject; + searchTerm: React.MutableRefObject; + entriesCount: number; +} +export interface AddEntryContextType { + user: UserType; + database: DSQL_MYSQL_user_databases_Type; + table: DSQL_TableSchemaType; + dbSchemaData: DSQL_DatabaseSchemaType[]; + richTextEditors: React.MutableRefObject; + jsonTextEditors: React.MutableRefObject; + query: any; + duplicateEntry: any; + confirmedDelegetedUser: any; +} +export interface UserDatabasesContextType { + user: UserType; + users: any[]; + targetUser: any; + setTargetUser: React.Dispatch>; + databases: DSQL_MYSQL_user_databases_Type[]; +} +export interface SettingsPageContextType { + user: UserType; + image: any; + setImage: React.Dispatch>; + activeUser: any; +} +export interface MediaFolderPageContextType { + user: UserType; + media: any[]; + targetMedia: any; + setTargetMedia: React.Dispatch>; + folders: any[]; + query: any; + staticHost: string; + folder: string; +} +export interface TablesContextType { + user: UserType; + database: DSQL_MYSQL_user_databases_Type; + tables: MYSQL_user_database_tables_table_def[]; + targetTable: MYSQL_user_database_tables_table_def | null; + setTargetTable: React.Dispatch>; + query: any; + confirmedDelegetedUser: any; +} +export interface EditTableContextType { + user: UserType; + database: DSQL_MYSQL_user_databases_Type; + table: DSQL_TableSchemaType; + tableFields: DSQL_FieldSchemaType[]; + setTableFields: React.Dispatch>; + targetField: DSQL_FieldSchemaType | null; + setTargetField: React.Dispatch>; + pageRefresh: number; + setPageRefresh: React.Dispatch>; + refreshFieldsListRef: React.MutableRefObject> | undefined>; + dbSchemaData: DSQL_DatabaseSchemaType[]; + query: any; + confirmedDelegetedUser: any; +} +export interface SingleDatabaseContextType { + user: UserType; + database: DSQL_MYSQL_user_databases_Type; + tables: MYSQL_user_database_tables_table_def[]; + targetTable: MYSQL_user_database_tables_table_def | null; + setTargetTable: React.Dispatch>; + query: any; + confirmedDelegetedUser: any; +} +export interface ApiKeysContextType { + user?: UserType; + apiKeys?: any[]; + setApiKeys?: React.Dispatch>; + targetApiKey?: any | null; + setTargetApiKey?: React.Dispatch>; + newApiKey?: any | null; + setNewApiKey?: React.Dispatch>; +} +export interface LoginFormContextType { + user?: UserType | null; + loading: boolean; + setLoading: React.Dispatch>; + alert: string | boolean; + setAlert: React.Dispatch>; +} +export interface CreateAccountContextType { + user?: UserType | null; + query: CreateAccountQueryType; + invitingUser: any; +} +export interface CreateAccountQueryType { + invite?: number; + database_access?: string; + priviledge?: string; + email?: string; +} +export interface DocsAsidePageObject { + id: number; + title: string; + slug: string; + parent_id?: number; + level?: number; +} +export interface AllUserUsersContextType { + user?: UserType; + users?: MYSQL_delegated_users_table_def[]; + targetUser?: MYSQL_user_users_table_def | undefined; + setTargetUser?: React.Dispatch>; + databases?: DSQL_MYSQL_user_databases_Type[]; + pendingInvitations?: MYSQL_invitations_table_def[]; + pendingInvitationsReceived?: any[]; + adminUsers?: any[]; + invitedAccounts?: any[]; +} +export interface AddSocialLoginContextType { + user?: UserType; + database?: DSQL_MYSQL_user_databases_Type; + query?: any; + socialLogins?: SocialLoginObjectType[]; +} +export interface DelegatedDbContextType { + user: UserType; + users: MYSQL_user_users_table_def[]; + targetUser: MYSQL_user_users_table_def | undefined; + setTargetUser: React.Dispatch>; + database: DSQL_MYSQL_user_databases_Type; +} +export interface AddUserUserContextType { + user: UserType; + database: DSQL_MYSQL_user_databases_Type; + table: DSQL_TableSchemaType; + query: any; + confirmedDelegetedUser: any; +} +export interface UserUsersContextType { + user: UserType; + users: MYSQL_user_users_table_def[]; + targetUser?: MYSQL_user_users_table_def; + setTargetUser: React.Dispatch>; + database: DSQL_MYSQL_user_databases_Type; + table: DSQL_TableSchemaType; + dbSchemaData: DSQL_DatabaseSchemaType[]; + query: any; + confirmedDelegetedUser: any; +} +export interface DatabaseSingleUserContextType { + user: UserType; + database: DSQL_MYSQL_user_databases_Type; + singleUser: MYSQL_user_users_table_def; + table: DSQL_TableSchemaType; + dbSchemaData: DSQL_DatabaseSchemaType[]; + query: any; + confirmedDelegetedUser: any; +} +export interface SingleUserUserContextType { + user: UserType; + singleUser: MYSQL_user_users_table_def; +} +export interface AddUserContextType { + user: UserType; + users: MYSQL_delegated_users_table_def[]; + databases: DSQL_MYSQL_user_databases_Type[]; + query: any; +} +export interface MediaContextType { + user: UserType; + media: MYSQL_user_media_table_def[]; + targetMedia: MYSQL_user_media_table_def | null; + setTargetMedia: React.Dispatch>; + folders: string[]; + staticHost: string; +} +export interface MediaSubFolderContextType { + user: UserType; + media: MYSQL_user_media_table_def[]; + targetMedia: MYSQL_user_media_table_def | null; + setTargetMedia: React.Dispatch>; + folders: string[]; + query: any; + folder: string; + staticHost: string; +} +export interface FieldsContextType { + user: UserType; + database: DSQL_MYSQL_user_databases_Type; + table: DSQL_TableSchemaType; + dbSchemaData: DSQL_DatabaseSchemaType[]; + targetField: DSQL_FieldSchemaType | null; + setTargetField: React.Dispatch>; + refreshFieldsListRef: React.MutableRefObject> | undefined>; + tableFields: DSQL_FieldSchemaType[]; + setTableFields: React.Dispatch>; + updateTableAfterFieldsUpdateFunction: () => void; + query: any; + confirmedDelegetedUser: any; +} +export interface SingleTableContextType { + user: UserType; + database: DSQL_MYSQL_user_databases_Type; + table: DSQL_TableSchemaType; + tableRecord: MYSQL_user_database_tables_table_def; + tableFields: DSQL_FieldSchemaType[]; + setTableFields: React.Dispatch>; + tableIndexes: DSQL_IndexSchemaType[]; + setTableIndexes: React.Dispatch>; + dbSchemaData: DSQL_DatabaseSchemaType[]; + entries: any[]; + targetEntry: any; + setTargetEntry: React.Dispatch>; + richTextEditors: React.MutableRefObject; + jsonTextEditors: React.MutableRefObject; + query: any; + confirmedDelegetedUser: any; + targetField: DSQL_FieldSchemaType | null; + setTargetField: React.Dispatch>; + refreshFieldsListRef: React.MutableRefObject>>; + updateTableAfterFieldsUpdateFunction: () => void; + entriesCount: number; +} +export interface SingleEntryContextType { + user: UserType; + database: DSQL_MYSQL_user_databases_Type; + table: DSQL_TableSchemaType; + dbSchemaData: DSQL_DatabaseSchemaType[]; + entry: any; + targetEntry: any; + setTargetEntry: React.Dispatch>; + richTextEditors: React.MutableRefObject; + jsonTextEditors: React.MutableRefObject; + query: any; + confirmedDelegetedUser: any; + prevEntry: any; + nextEntry: any; +} +export interface UserSchemaContextType { + user: UserType; + dbSchemaData: DSQL_DatabaseSchemaType[]; +} +export interface ConnectContextType { + user?: UserType; + query?: any; + mariadbUserCred?: MariaDBUserCredType; + mariadbUsers?: MYSQL_mariadb_users_table_def[]; + targetMariadbUser?: MYSQL_mariadb_users_table_def | null; + setTargetMariadbUser?: React.Dispatch>; + refresh?: number; + setRefresh?: React.Dispatch>; +} +export interface MYSQL_mariadb_users_table_def { + id?: number; + user_id?: number; + username?: string; + host?: string; + password?: string; + primary?: number; + grants?: string; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +} +export interface DbContextType { + user?: UserType; + databases?: DSQL_MYSQL_user_databases_Type[]; + targetDatabase?: DSQL_MYSQL_user_databases_Type; + setTargetDatabase?: React.Dispatch>; +} +export interface MariaDBUserCredType { + mariadb_user?: string; + mariadb_host?: string; + mariadb_pass?: string; +} +export interface AddTableContextType { + user?: UserType; + dbSchemaData?: DSQL_DatabaseSchemaType[]; + database?: DSQL_MYSQL_user_databases_Type; + tables?: DSQL_TableSchemaType[]; + tableFields?: DSQL_FieldSchemaType[]; + setTableFields?: React.Dispatch>; + targetField?: DSQL_FieldSchemaType | null; + setTargetField?: React.Dispatch>; + pageRefresh?: number | null; + setPageRefresh?: React.Dispatch>; + refreshFieldsListRef?: React.MutableRefObject> | undefined>; + query?: any; +} +export interface DbSchemaContextType { + user?: UserType; + database?: DSQL_MYSQL_user_databases_Type; + dbImage?: string; + setDbImage?: React.Dispatch>; + dbSchemaData?: DSQL_DatabaseSchemaType[]; + tables?: any[]; +} +export interface DbShellContextType { + user?: UserType; + database?: DSQL_MYSQL_user_databases_Type; + dbImage?: string; + setDbImage?: React.Dispatch>; + dbSchemaData?: DSQL_DatabaseSchemaType[]; + tables?: any[]; +} +export interface DbConnectContextType { + user: UserType; + database: DSQL_MYSQL_user_databases_Type; + targetDbSchema: DSQL_DatabaseSchemaType; + query: any; +} +export interface ImageObjectType { + imageName?: string; + mimeType?: string; + imageSize?: number; + private?: boolean; + imageBase64?: string; + imageBase64Full?: string; +} +export interface FileObjectType { + fileName?: string; + private?: boolean; + fileType?: string; + fileSize?: number; + fileBase64?: string; + fileBase64Full?: string; +} +export interface SocialLoginObjectType { + platform?: string; + paradigm?: string; + clientId?: string; + clientSecret?: string; + callbackUrl?: string; + domain1?: string; + domain2?: string; + domain3?: string; +} +export interface DbConnectType { + url: string; + key: string; + database: DSQL_MYSQL_user_databases_Type; + dbSchema: DSQL_DatabaseSchemaType; + type: "pull" | "push"; + remoteDbs?: DSQL_DatabaseSchemaType[]; + targetDb?: DSQL_DatabaseSchemaType; +} +export interface MYSQL_MediaType { + id?: number; + user_id?: number; + media_name?: string; + folder?: string; + media_url?: string; + media_thumbnail_url?: string; + media_type?: string; + width?: string; + height?: string; + size?: string; + private?: string; +} +export interface UserFileObject { + title?: string; + path?: string; + data?: string; +} +export interface UserFileObject2 { + type?: string; + name?: string; + root?: string; + content?: UserFileObject2[]; +} +export interface MYSQL_user_users_table_def { + id?: number; + user_id?: number; + invited_user_id?: number; + database?: string; + database_access?: string; + first_name?: string; + last_name?: string; + email?: string; + username?: string; + password?: string; + phone?: string; + user_type?: string; + user_priviledge?: string; + image?: string; + image_thumbnail?: string; + city?: string; + state?: string; + country?: string; + zip_code?: string; + address?: string; + social_login?: number; + social_platform?: string; + social_id?: string; + verification_status?: number; + more_user_data?: string; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; + inviteeFirstName?: string; + inviteeLastName?: string; + inviteeEmail?: string; + inviteeImage?: string; +} +export interface MYSQL_user_database_tables_table_def { + id?: number; + user_id?: number; + db_id?: number; + db_slug?: string; + table_name?: string; + table_slug?: string; + table_description?: string; + child_table?: number; + active_data?: 0 | 1; + child_table_parent_database?: string; + child_table_parent_table?: string; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +} +export interface MYSQL_user_media_table_def { + id?: number; + user_id?: number; + media_name?: string; + folder?: string; + media_url?: string; + media_thumbnail_url?: string; + media_path?: string; + media_thumbnail_path?: string; + media_type?: string; + width?: number; + height?: number; + size?: number; + private?: number; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +} +export interface MYSQL_delegated_users_table_def { + id?: number; + user_id?: number; + delegated_user_id?: number; + permissions?: string; + permission_level_code?: number; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +} +export interface MYSQL_invitations_table_def { + id?: number; + inviting_user_id?: number; + invited_user_email?: string; + invitation_status?: string; + database_access?: string; + priviledge?: string; + db_tables_data?: string; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +} +export interface MYSQL_docs_pages_table_def { + id?: number; + title?: string; + slug?: string; + description?: string; + content?: string; + text_content?: string; + level?: number; + page_order?: number; + parent_id?: number; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +} +export interface MYSQL_delegated_user_tables_table_def { + id?: number; + delegated_user_id?: number; + root_user_id?: number; + database?: string; + table?: string; + priviledge?: string; + date_created?: string; + date_created_code?: number; + date_created_timestamp?: string; + date_updated?: string; + date_updated_code?: number; + date_updated_timestamp?: string; +} +export type ApiKeyObject = { + user_id?: string | number; + full_access?: boolean; + sign?: string; + date_code?: number; + target_database?: string; + target_table?: string; + error?: string; +}; +export type AddApiKeyRequestBody = { + api_key_name: string; + api_key_slug: string; + api_key_scope?: "fullAccess" | "readOnly"; + target_database?: string; + target_table?: string; +}; +export type CheckApiCredentialsFn = (param: CheckApiCredentialsFnParam) => ApiKeyObject | null | undefined; +export type CheckApiCredentialsFnParam = { + key?: string; + database?: string; + table?: string; + user_id?: string | number; + media?: boolean; +}; +export type FetchApiFn = (url: string, options?: FetchApiOptions, csrf?: boolean) => Promise; +export type FetchApiOptions = RequestInit & { + method: "POST" | "GET" | "DELETE" | "PUT" | "PATCH" | "post" | "get" | "delete" | "put" | "patch"; + body?: object | string; + headers?: FetchHeader; + query?: { + [key: string]: any; + }; +}; +type FetchHeader = HeadersInit & { + [key: string]: any; +}; +export type FetchApiReturn = { + success: boolean; + payload: any; + msg?: string; + [key: string]: any; +}; +export declare const ServerQueryOperators: readonly ["AND", "OR"]; +export declare const ServerQueryEqualities: readonly ["EQUAL", "LIKE", "NOT EQUAL"]; +export type ServerQueryParam = { + selectFields?: string[]; + query?: ServerQueryQueryObject; + limit?: number; + page?: number; + offset?: number; + order?: { + field: keyof T; + strategy: "ASC" | "DESC"; + }; + searchOperator?: (typeof ServerQueryOperators)[number]; + searchEquality?: (typeof ServerQueryEqualities)[number]; + addUserId?: { + fieldName: keyof T; + }; + join?: ServerQueryParamsJoin[]; + [key: string]: any; +}; +export type ServerQueryObject = { + value?: string | string[]; + operator?: (typeof ServerQueryOperators)[number]; + equality?: (typeof ServerQueryEqualities)[number]; + tableName?: string; + __query?: { + [key in keyof T]: Omit, "__query">; + }; +}; +export type ServerQueryQueryObject = { + [key in keyof T]: ServerQueryObject; +}; +export type FetchDataParams = { + path: string; + method?: "GET" | "POST" | "PATCH" | "PUT" | "DELETE"; + body?: object | string; + query?: AuthFetchQuery; + tableName?: string; +}; +export type AuthFetchQuery = ServerQueryParam & { + [key: string]: any; +}; +export type ServerQueryParamsJoin = { + joinType: "INNER JOIN" | "JOIN" | "LEFT JOIN" | "RIGHT JOIN"; + alias?: string; + tableName: Table; + match?: ServerQueryParamsJoinMatchObject | ServerQueryParamsJoinMatchObject[]; + selectFields?: (keyof Field | { + field: keyof Field; + alias?: string; + count?: boolean; + })[]; + operator?: (typeof ServerQueryOperators)[number]; +}; +export type ServerQueryParamsJoinMatchObject = { + /** Field name from the **Root Table** */ + source: string | ServerQueryParamsJoinMatchSourceTargetObject; + /** Field name from the **Join Table** */ + target?: keyof Field | ServerQueryParamsJoinMatchSourceTargetObject; + /** A literal value: No source and target Needed! */ + targetLiteral?: string; +}; +export type ServerQueryParamsJoinMatchSourceTargetObject = { + tableName: string; + fieldName: string; +}; +export type ApiConnectBody = { + url: string; + key: string; + database: DSQL_MYSQL_user_databases_Type; + dbSchema: DSQL_DatabaseSchemaType; + type: "pull" | "push"; + user_id?: string | number; +}; +export type SuUserType = { + email: string; + password: string; + authKey: string; + logged_in_status: boolean; + date: number; +}; +export type MariadbRemoteServerObject = { + host: string; + port: number; + primary?: boolean; + loadBalanced?: boolean; + users?: MariadbRemoteServerUserObject[]; +}; +export type MariadbRemoteServerUserObject = { + name: string; + password: string; + host: string; +}; +export type APILoginFunctionParams = { + encryptionKey: string; + email?: string; + username?: string; + password?: string; + database: string; + additionalFields?: string[]; + email_login?: boolean; + email_login_code?: string; + email_login_field?: string; + token?: boolean; + skipPassword?: boolean; + social?: boolean; + dbUserId?: number | string; + debug?: boolean; +}; +export type APILoginFunctionReturn = { + success: boolean; + msg?: string; + payload?: DATASQUIREL_LoggedInUser | null; + userId?: number | string; + key?: string; + token?: string; + csrf?: string; + cookieNames?: any; +}; +export type APICreateUserFunctionParams = { + encryptionKey?: string; + payload: any; + database: string; + userId?: string | number; +}; +export type APICreateUserFunction = (params: APICreateUserFunctionParams) => Promise; +/** + * API Get User Function + */ +export type APIGetUserFunctionParams = { + fields: string[]; + dbFullName: string; + userId: string | number; +}; +/** + * API Google Login Function + */ +export type APIGoogleLoginFunctionParams = { + token: string; + database?: string; + additionalFields?: string[]; + additionalData?: { + [key: string]: string | number; + }; + debug?: boolean; +}; +export type APIGoogleLoginFunction = (params: APIGoogleLoginFunctionParams) => Promise; +/** + * Handle Social DB Function + */ +export type HandleSocialDbFunctionParams = { + database?: string; + social_id: string | number; + email: string; + social_platform: string; + payload: any; + invitation?: any; + supEmail?: string; + additionalFields?: string[]; + debug?: boolean; +}; +export type HandleSocialDbFunctionReturn = { + success: boolean; + user?: DATASQUIREL_LoggedInUser | null; + msg?: string; + social_id?: string | number; + social_platform?: string; + payload?: any; + alert?: boolean; + newUser?: any; + error?: any; +} | null; +/** + * Handle Social User Auth on Datasquirel Database + * ============================================================================== + * + * @description This function handles all social login logic after the social user + * has been authenticated and userpayload is present. The payload MUST contain the + * specified fields because this funciton will create a new user if the authenticated + * user does not exist. + * + * @param {HandleSocialDbFunctionParams} params - function parameters inside an object + * + * @returns {Promise} - Response object + */ +export type HandleSocialDbFunction = (params: HandleSocialDbFunctionParams) => Promise; +export type ApiReauthUserReturn = { + success: boolean; + payload?: { + [key: string]: any; + } | null; + msg?: string; + userId?: string | number; +}; +export type GoogleAccessTokenObject = { + access_token: string; + token_type: "Bearer"; + expires_in: number; + scope: string; + authuser: string; + prompt: string; +}; +export type GoogleOauth2User = { + sub: string; + name: string; + given_name: string; + family_name: string; + picture: string; + email: string; + email_verified: boolean; +}; +export interface AceEditorOptions { + animatedScroll?: boolean; + autoScrollEditorIntoView?: boolean; + behavioursEnabled?: boolean; + copyWithEmptySelection?: boolean; + cursorStyle?: "ace" | "slim" | "smooth" | "wide"; + customScrollbar?: boolean; + displayIndentGuides?: boolean; + dragDelay?: number; + dragEnabled?: boolean; + enableAutoIndent?: boolean; + enableBasicAutocompletion?: boolean | any[]; + enableKeyboardAccessibility?: boolean; + enableLiveAutocompletion?: boolean | any[]; + enableMobileMenu?: boolean; + enableMultiselect?: boolean; + enableSnippets?: boolean; + fadeFoldWidgets?: boolean; + firstLineNumber?: number; + fixedWidthGutter?: boolean; + focusTimeout?: number; + foldStyle?: "markbegin" | "markbeginend" | "manual"; + fontFamily?: string; + fontSize?: number; + hScrollBarAlwaysVisible?: boolean; + hasCssTransforms?: boolean; + highlightActiveLine?: boolean; + highlightGutterLine?: boolean; + highlightIndentGuides?: boolean; + highlightSelectedWord?: boolean; + indentedSoftWrap?: boolean; + keyboardHandler?: string; + liveAutocompletionDelay?: number; + liveAutocompletionThreshold?: number; + maxLines?: number; + maxPixelHeight?: number; + mergeUndoDeltas?: boolean | "always"; + minLines?: number; + mode?: string; + navigateWithinSoftTabs?: boolean; + newLineMode?: AceAjax.NewLineMode; + overwrite?: boolean; + placeholder?: string; + printMargin?: number | boolean; + printMarginColumn?: number; + readOnly?: boolean; + relativeLineNumbers?: boolean; + scrollPastEnd?: number; + scrollSpeed?: number; + selectionStyle?: string; + session?: any; + showFoldWidgets?: boolean; + showFoldedAnnotations?: boolean; + showGutter?: boolean; + showInvisibles?: boolean; + showLineNumbers?: boolean; + showPrintMargin?: boolean; + tabSize?: number; + textInputAriaLabel?: string; + theme?: string; + tooltipFollowsMouse?: boolean; + useSoftTabs?: boolean; + useSvgGutterIcons?: boolean; + useWorker?: boolean; + vScrollBarAlwaysVisible?: boolean; + value?: string; + wrap?: number | boolean | "off" | "free" | "printmargin"; + wrapBehavioursEnabled?: boolean; + wrapMethod?: "code" | "text" | "auto"; +} +export type SendOneTimeCodeEmailResponse = { + success: boolean; + code?: string; + createdAt?: number; + email?: string; + msg?: string; +}; +export type CookieObject = { + name: string; + value: string; + domain?: string; + path?: string; + expires?: Date; + maxAge?: number; + secure?: boolean; + httpOnly?: boolean; + sameSite?: "Strict" | "Lax" | "None"; + priority?: "Low" | "Medium" | "High"; +}; +export type HttpRequestParams = RequestOptions & { + scheme?: "http" | "https"; + body?: ReqObj; + query?: ReqObj; + urlEncodedFormBody?: boolean; +}; +export type HttpRequestFunction = (param: HttpRequestParams) => Promise>; +export type HttpFunctionResponse = { + status: number; + data?: ResObj; + error?: string; + str?: string; + requestedPath?: string; +}; +export type ApiGetQueryObject = { + query: ServerQueryParam; + table: string; + dbFullName?: string; +}; +export declare const DataCrudRequestMethods: readonly ["GET", "POST", "PUT", "DELETE"]; +export type DsqlMethodCrudParam = { + method: (typeof DataCrudRequestMethods)[number]; + body?: T; + query?: DsqlCrudQueryObject; + tableName: string; + addUser?: { + field: keyof T; + }; + user?: DATASQUIREL_LoggedInUser; + extraData?: T; + transformData?: DsqlCrudTransformDataFunction; + transformQuery?: DsqlCrudTransformQueryFunction; + existingData?: T; + targetId?: string | number; + sanitize?: (data?: T) => T; + debug?: boolean; +}; +export type DsqlCrudTransformDataFunction = (params: { + data: T; + user?: DATASQUIREL_LoggedInUser; + existingData?: T; + reqMethod: (typeof DataCrudRequestMethods)[number]; +}) => Promise; +export type DsqlCrudTransformQueryFunction = (params: { + query: DsqlCrudQueryObject; + user?: DATASQUIREL_LoggedInUser; + reqMethod: (typeof DataCrudRequestMethods)[number]; +}) => Promise>; +export declare const DsqlCrudActions: readonly ["insert", "update", "delete", "get"]; +export type DsqlCrudQueryObject = ServerQueryParam & { + query?: ServerQueryQueryObject; +}; +export type DsqlCrudParam = { + action: (typeof DsqlCrudActions)[number]; + table: string; + data?: T; + targetId?: string | number; + query?: DsqlCrudQueryObject; + sanitize?: (data?: T) => T; + debug?: boolean; +}; +export type ErrorCallback = (title: string, error: Error, data?: any) => void; +export interface MariaDBUser { + Host: string; + User: string; + Password: string; + Select_priv: string; + Insert_priv: string; + Update_priv: string; + Delete_priv: string; + Create_priv: string; + Drop_priv: string; + Reload_priv: string; + Shutdown_priv: string; + Process_priv: string; + File_priv: string; + Grant_priv: string; + References_priv: string; + Index_priv: string; + Alter_priv: string; + Show_db_priv: string; + Super_priv: string; + Create_tmp_table_priv: string; + Lock_tables_priv: string; + Execute_priv: string; + Repl_slave_priv: string; + Repl_client_priv: string; + Create_view_priv: string; + Show_view_priv: string; + Create_routine_priv: string; + Alter_routine_priv: string; + Create_user_priv: string; + Event_priv: string; + Trigger_priv: string; + Create_tablespace_priv: string; + Delete_history_priv: string; + ssl_type: string; + ssl_cipher: string; + x509_issuer: string; + x509_subject: string; + max_questions: number; + max_updates: number; + max_connections: number; + max_user_connections: number; + plugin: string; + authentication_string: string; + password_expired: string; + is_role: string; + default_role: string; + max_statement_time: number; +} +export {}; diff --git a/dist/package-shared/utils/backend/export-mariadb-database.d.ts b/dist/package-shared/utils/backend/export-mariadb-database.d.ts new file mode 100644 index 0000000..1da21da --- /dev/null +++ b/dist/package-shared/utils/backend/export-mariadb-database.d.ts @@ -0,0 +1,8 @@ +export type ExportMariaDBDatabaseParam = { + dbFullName: string; + targetFilePath: string; + mariadbUser?: string; + mariadbHost?: string; + mariadbPass?: string; +}; +export default function exportMariadbDatabase({ dbFullName, targetFilePath, mariadbHost, mariadbPass, mariadbUser, }: ExportMariaDBDatabaseParam): string | Buffer; diff --git a/dist/package-shared/utils/backend/global-db/DB_HANDLER.d.ts b/dist/package-shared/utils/backend/global-db/DB_HANDLER.d.ts new file mode 100644 index 0000000..fe0f49b --- /dev/null +++ b/dist/package-shared/utils/backend/global-db/DB_HANDLER.d.ts @@ -0,0 +1,5 @@ +/** + * # DSQL user read-only DB handler + * @requires DSQL_DB_CONN - Gobal Variable for Datasquirel Database + */ +export default function DB_HANDLER(...args: any[]): Promise; diff --git a/dist/package-shared/utils/backend/global-db/DSQL_USER_DB_HANDLER.d.ts b/dist/package-shared/utils/backend/global-db/DSQL_USER_DB_HANDLER.d.ts new file mode 100644 index 0000000..df60927 --- /dev/null +++ b/dist/package-shared/utils/backend/global-db/DSQL_USER_DB_HANDLER.d.ts @@ -0,0 +1,10 @@ +type Param = { + paradigm: "Full Access" | "FA" | "Read Only"; + queryString: string; + queryValues?: string[]; +}; +/** + * # DSQL user read-only DB handler + */ +export default function DSQL_USER_DB_HANDLER({ paradigm, queryString, queryValues, }: Param): Promise; +export {}; diff --git a/dist/package-shared/utils/backend/global-db/LOCAL_DB_HANDLER.d.ts b/dist/package-shared/utils/backend/global-db/LOCAL_DB_HANDLER.d.ts new file mode 100644 index 0000000..5914fda --- /dev/null +++ b/dist/package-shared/utils/backend/global-db/LOCAL_DB_HANDLER.d.ts @@ -0,0 +1,4 @@ +/** + * # DSQL user read-only DB handler + */ +export default function LOCAL_DB_HANDLER(...args: any[]): Promise; diff --git a/dist/package-shared/utils/backend/global-db/NO_DB_HANDLER.d.ts b/dist/package-shared/utils/backend/global-db/NO_DB_HANDLER.d.ts new file mode 100644 index 0000000..f40dff3 --- /dev/null +++ b/dist/package-shared/utils/backend/global-db/NO_DB_HANDLER.d.ts @@ -0,0 +1,7 @@ +/** + * # DSQL user read-only DB handler + */ +export default function NO_DB_HANDLER(...args: any[]): Promise | { + success: boolean; + error: any; +}; diff --git a/dist/package-shared/utils/backend/global-db/ROOT_DB_HANDLER.d.ts b/dist/package-shared/utils/backend/global-db/ROOT_DB_HANDLER.d.ts new file mode 100644 index 0000000..e671f45 --- /dev/null +++ b/dist/package-shared/utils/backend/global-db/ROOT_DB_HANDLER.d.ts @@ -0,0 +1,7 @@ +/** + * # Root DB handler + */ +export default function ROOT_DB_HANDLER(...args: any[]): Promise | { + success: boolean; + error: any; +}; diff --git a/dist/package-shared/utils/backend/grabDbSSL.d.ts b/dist/package-shared/utils/backend/grabDbSSL.d.ts new file mode 100644 index 0000000..4ca0dd9 --- /dev/null +++ b/dist/package-shared/utils/backend/grabDbSSL.d.ts @@ -0,0 +1,8 @@ +type Return = string | (import("tls").SecureContextOptions & { + rejectUnauthorized?: boolean | undefined; +}) | undefined; +/** + * # Grall SSL + */ +export default function grabDbSSL(): Return; +export {}; diff --git a/dist/package-shared/utils/backend/import-mariadb-database.d.ts b/dist/package-shared/utils/backend/import-mariadb-database.d.ts new file mode 100644 index 0000000..96762c9 --- /dev/null +++ b/dist/package-shared/utils/backend/import-mariadb-database.d.ts @@ -0,0 +1,8 @@ +export type ExportMariaDBDatabaseParam = { + dbFullName: string; + targetFilePath: string; + mariadbUser?: string; + mariadbHost?: string; + mariadbPass?: string; +}; +export default function importMariadbDatabase({ dbFullName, targetFilePath, mariadbHost, mariadbPass, mariadbUser, }: ExportMariaDBDatabaseParam): Promise>; diff --git a/dist/package-shared/utils/backend/names/grab-dir-names.d.ts b/dist/package-shared/utils/backend/names/grab-dir-names.d.ts new file mode 100644 index 0000000..656ea5e --- /dev/null +++ b/dist/package-shared/utils/backend/names/grab-dir-names.d.ts @@ -0,0 +1,34 @@ +import { DATASQUIREL_LoggedInUser, UserType } from "../../../types"; +type Param = { + user?: DATASQUIREL_LoggedInUser | UserType; + userId?: string | number | null; + appDir?: string; +}; +export default function grabDirNames(param?: Param): { + appDir: string; + schemasDir: string; + userDirPath: string | undefined; + mainShemaJSONFilePath: string; + mainDbTypeDefFile: string; + tempDirName: string; + defaultTableFieldsJSONFilePath: string; + usersSchemaDir: string; + userSchemaMainJSONFilePath: string | undefined; + userPrivateMediaDir: string | undefined; + userPrivateExportsDir: string | undefined; + userPrivateSQLExportsDir: string | undefined; + userPrivateTempSQLExportsDir: string | undefined; + userPrivateTempJSONSchemaFilePath: string | undefined; + userPrivateDbExportZipFileName: string; + userPrivateDbExportZipFilePath: string | undefined; + userPrivateDbImportZipFileName: string; + userPrivateDbImportZipFilePath: string | undefined; + dbNginxLoadBalancerConfigFile: string; + dockerComposeFile: string; + testDockerComposeFile: string; + extraDockerComposeFile: string; + siteSetupFile: string; + envFile: string; + testEnvFile: string; +}; +export {}; diff --git a/dist/package-shared/utils/backend/names/replace-datasquirel-db-name.d.ts b/dist/package-shared/utils/backend/names/replace-datasquirel-db-name.d.ts new file mode 100644 index 0000000..5d052cb --- /dev/null +++ b/dist/package-shared/utils/backend/names/replace-datasquirel-db-name.d.ts @@ -0,0 +1,6 @@ +type Param = { + str: string; + userId: string | number; +}; +export default function replaceDatasquirelDbName({ str, userId, }: Param): string; +export {}; diff --git a/dist/package-shared/utils/backend/parseCookies.d.ts b/dist/package-shared/utils/backend/parseCookies.d.ts new file mode 100644 index 0000000..f90911e --- /dev/null +++ b/dist/package-shared/utils/backend/parseCookies.d.ts @@ -0,0 +1,16 @@ +import { IncomingMessage } from "http"; +/** + * Parse request cookies + * =================================================== + * + * @description This function takes in a request object and + * returns the cookies as a JS object + */ +export default function parseCookies({ request, cookieString, }: { + request?: IncomingMessage & { + [s: string]: any; + }; + cookieString?: string; +}): { + [s: string]: string; +}; diff --git a/dist/package-shared/utils/camelJoinedtoCamelSpace.d.ts b/dist/package-shared/utils/camelJoinedtoCamelSpace.d.ts new file mode 100644 index 0000000..0e45d5d --- /dev/null +++ b/dist/package-shared/utils/camelJoinedtoCamelSpace.d.ts @@ -0,0 +1,7 @@ +/** + * Convert Camel Joined Text to Camel Spaced Text + * ============================================================================== + * @description this function takes a camel cased text without spaces, and returns + * a camel-case-spaced text + */ +export default function camelJoinedtoCamelSpace(text: string): string | null; diff --git a/dist/package-shared/utils/check-if-is-master.d.ts b/dist/package-shared/utils/check-if-is-master.d.ts new file mode 100644 index 0000000..12846f6 --- /dev/null +++ b/dist/package-shared/utils/check-if-is-master.d.ts @@ -0,0 +1,6 @@ +type Param = { + dbContext?: "Master" | "Dsql User"; + dbFullName?: string; +}; +export default function checkIfIsMaster({ dbContext, dbFullName }: Param): boolean; +export {}; diff --git a/dist/package-shared/utils/console-colors.d.ts b/dist/package-shared/utils/console-colors.d.ts new file mode 100644 index 0000000..4a92b09 --- /dev/null +++ b/dist/package-shared/utils/console-colors.d.ts @@ -0,0 +1,55 @@ +declare const consoleColors: { + Reset: string; + Bright: string; + Dim: string; + Underscore: string; + Blink: string; + Reverse: string; + Hidden: string; + FgBlack: string; + FgRed: string; + FgGreen: string; + FgYellow: string; + FgBlue: string; + FgMagenta: string; + FgCyan: string; + FgWhite: string; + FgGray: string; + BgBlack: string; + BgRed: string; + BgGreen: string; + BgYellow: string; + BgBlue: string; + BgMagenta: string; + BgCyan: string; + BgWhite: string; + BgGray: string; +}; +export default consoleColors; +export declare const ccol: { + Reset: string; + Bright: string; + Dim: string; + Underscore: string; + Blink: string; + Reverse: string; + Hidden: string; + FgBlack: string; + FgRed: string; + FgGreen: string; + FgYellow: string; + FgBlue: string; + FgMagenta: string; + FgCyan: string; + FgWhite: string; + FgGray: string; + BgBlack: string; + BgRed: string; + BgGreen: string; + BgYellow: string; + BgBlue: string; + BgMagenta: string; + BgCyan: string; + BgWhite: string; + BgGray: string; +}; diff --git a/dist/package-shared/utils/data-fetching/crud.d.ts b/dist/package-shared/utils/data-fetching/crud.d.ts new file mode 100644 index 0000000..1c1b22d --- /dev/null +++ b/dist/package-shared/utils/data-fetching/crud.d.ts @@ -0,0 +1,9 @@ +import sqlGenerator from "../../functions/dsql/sql/sql-generator"; +import { DsqlCrudParam, PostReturn } from "../../types"; +export default function dsqlCrud({ action, data, table, targetId, query, sanitize, debug, }: DsqlCrudParam): Promise<(PostReturn & { + queryObject?: ReturnType>; +}) | null>; diff --git a/dist/package-shared/utils/data-fetching/method-crud.d.ts b/dist/package-shared/utils/data-fetching/method-crud.d.ts new file mode 100644 index 0000000..d105b80 --- /dev/null +++ b/dist/package-shared/utils/data-fetching/method-crud.d.ts @@ -0,0 +1,21 @@ +import sqlGenerator from "../../functions/dsql/sql/sql-generator"; +import { DsqlMethodCrudParam, ServerQueryParam } from "../../types"; +export type APIDataCrudQuery = ServerQueryParam & { + page?: number; +}; +export type CRUDResponseObject

= { + success: boolean; + payload?: P; + msg?: string; + error?: string; + queryObject?: ReturnType>; +}; +export default function dsqlMethodCrud({ method, tableName, addUser, user, extraData, transformData, existingData, body, query, targetId, sanitize, transformQuery, debug, }: DsqlMethodCrudParam): Promise>; diff --git a/dist/package-shared/utils/db/conn-db-handler.d.ts b/dist/package-shared/utils/db/conn-db-handler.d.ts new file mode 100644 index 0000000..d770791 --- /dev/null +++ b/dist/package-shared/utils/db/conn-db-handler.d.ts @@ -0,0 +1,25 @@ +import { ServerlessMysql } from "serverless-mysql"; +type QueryObject = { + query: string; + values?: (string | number | undefined)[]; +}; +type Return = ReturnType | null; +/** + * # Run Query From MySQL Connection + * @description Run a query from a pre-existing MySQL/Mariadb Connection + * setup with `serverless-mysql` npm module + */ +export default function connDbHandler( +/** + * ServerlessMySQL Connection Object + */ +conn?: ServerlessMysql, +/** + * String Or `QueryObject` Array + */ +query?: QueryObject["query"] | QueryObject[], +/** + * Array of Values to Sanitize and Inject + */ +values?: QueryObject["values"]): Promise>; +export {}; diff --git a/dist/package-shared/utils/deserialize-query.d.ts b/dist/package-shared/utils/deserialize-query.d.ts new file mode 100644 index 0000000..d0930b8 --- /dev/null +++ b/dist/package-shared/utils/deserialize-query.d.ts @@ -0,0 +1,8 @@ +/** + * # Convert Serialized Query back to object + */ +export default function deserializeQuery(query: string | { + [s: string]: any; +}): { + [s: string]: any; +}; diff --git a/dist/package-shared/utils/ejson.d.ts b/dist/package-shared/utils/ejson.d.ts new file mode 100644 index 0000000..4966a4a --- /dev/null +++ b/dist/package-shared/utils/ejson.d.ts @@ -0,0 +1,17 @@ +/** + * # EJSON parse string + */ +declare function parse(string: string | null | number, reviver?: (this: any, key: string, value: any) => any): { + [s: string]: any; +} | { + [s: string]: any; +}[] | undefined; +/** + * # EJSON stringify object + */ +declare function stringify(value: any, replacer?: ((this: any, key: string, value: any) => any) | null, space?: string | number): string | undefined; +declare const EJSON: { + parse: typeof parse; + stringify: typeof stringify; +}; +export default EJSON; diff --git a/dist/package-shared/utils/empty-dir.d.ts b/dist/package-shared/utils/empty-dir.d.ts new file mode 100644 index 0000000..eb1e20b --- /dev/null +++ b/dist/package-shared/utils/empty-dir.d.ts @@ -0,0 +1 @@ +export default function emptyDirectory(dir: string): void; diff --git a/dist/package-shared/utils/endConnection.d.ts b/dist/package-shared/utils/endConnection.d.ts new file mode 100644 index 0000000..422a24e --- /dev/null +++ b/dist/package-shared/utils/endConnection.d.ts @@ -0,0 +1,6 @@ +import mysql from "mysql"; +/** + * # End MYSQL Connection + */ +declare function endConnection(connection: mysql.Connection): void; +export default endConnection; diff --git a/dist/package-shared/utils/generateColumnDescription.d.ts b/dist/package-shared/utils/generateColumnDescription.d.ts new file mode 100644 index 0000000..eb1d28b --- /dev/null +++ b/dist/package-shared/utils/generateColumnDescription.d.ts @@ -0,0 +1,21 @@ +/** ****************************************************************************** */ +/** ****************************************************************************** */ +/** ****************************************************************************** */ +/** ****************************************************************************** */ +/** ****************************************************************************** */ +/** ****************************************************************************** */ +/** + * # Generate SQL text for Field + */ +export default function generateColumnDescription({ columnData, primaryKeySet, }: { + columnData: import("../types").DSQL_FieldSchemaType; + primaryKeySet?: boolean; +}): { + fieldEntryText: string; + newPrimaryKeySet: boolean; +}; +/** ****************************************************************************** */ +/** ****************************************************************************** */ +/** ****************************************************************************** */ +/** ****************************************************************************** */ +/** ****************************************************************************** */ diff --git a/dist/package-shared/utils/grab-cookie-expirt-date.d.ts b/dist/package-shared/utils/grab-cookie-expirt-date.d.ts new file mode 100644 index 0000000..3126a16 --- /dev/null +++ b/dist/package-shared/utils/grab-cookie-expirt-date.d.ts @@ -0,0 +1 @@ +export default function grabCookieExpiryDate(): string; diff --git a/dist/package-shared/utils/grab-db-full-name.d.ts b/dist/package-shared/utils/grab-db-full-name.d.ts new file mode 100644 index 0000000..d77309c --- /dev/null +++ b/dist/package-shared/utils/grab-db-full-name.d.ts @@ -0,0 +1,9 @@ +type Param = { + dbName: string; + userId?: string | number; +}; +/** + * # Grab Database Full Name + */ +export default function grabDbFullName({ dbName, userId }: Param): string; +export {}; diff --git a/dist/package-shared/utils/grab-dsql-connection.d.ts b/dist/package-shared/utils/grab-dsql-connection.d.ts new file mode 100644 index 0000000..225f264 --- /dev/null +++ b/dist/package-shared/utils/grab-dsql-connection.d.ts @@ -0,0 +1,24 @@ +import { ServerlessMysql } from "serverless-mysql"; +type Param = { + /** + * Read Only? + */ + ro?: boolean; + /** + * Full Access? + */ + fa?: boolean; + /** + * No Database Connection + */ + noDb?: boolean; + /** + * Is this a local connection? + */ + local?: boolean; +}; +/** + * # Grab General CONNECTION for DSQL + */ +export default function grabDSQLConnection(param?: Param): ServerlessMysql; +export {}; diff --git a/dist/package-shared/utils/grab-host-names.d.ts b/dist/package-shared/utils/grab-host-names.d.ts new file mode 100644 index 0000000..5296a8b --- /dev/null +++ b/dist/package-shared/utils/grab-host-names.d.ts @@ -0,0 +1,19 @@ +import https from "https"; +import http from "http"; +type GrabHostNamesReturn = { + host: string; + port: number | string; + scheme: typeof http | typeof https; + user_id: string | number; +}; +type Param = { + userId?: string | number; + env?: { + [k: string]: string; + }; +}; +/** + * # Grab Names For Query + */ +export default function grabHostNames(param?: Param): GrabHostNamesReturn; +export {}; diff --git a/dist/package-shared/utils/grab-keys.d.ts b/dist/package-shared/utils/grab-keys.d.ts new file mode 100644 index 0000000..834bc46 --- /dev/null +++ b/dist/package-shared/utils/grab-keys.d.ts @@ -0,0 +1,19 @@ +export type GrabEncryptionKeysParam = { + encryptionKey?: string; + encryptionSalt?: string; + apiKey?: string; + algorithm?: string; + bufferAllocSize?: number; +}; +/** + * # Grab Encryption Keys + * @description Grab Required Encryption Keys + */ +export default function grabKeys(param?: GrabEncryptionKeysParam): { + key: string | undefined; + keyLen: number; + salt: string | undefined; + apiKey: string | undefined; + algorithm: string; + bufferAllocSize: number; +}; diff --git a/dist/package-shared/utils/grab-query-and-values.d.ts b/dist/package-shared/utils/grab-query-and-values.d.ts new file mode 100644 index 0000000..f87b9c3 --- /dev/null +++ b/dist/package-shared/utils/grab-query-and-values.d.ts @@ -0,0 +1,19 @@ +import { ApiGetQueryObject } from "../types"; +type Param = { + query: string | ApiGetQueryObject; + values?: (string | number)[]; +}; +export default function apiGetGrabQueryAndValues({ query, values }: Param): { + query: string; + values: (string | number)[] | undefined; + valuesString: string | undefined; +}; +export {}; diff --git a/dist/package-shared/utils/logging/debug-log.d.ts b/dist/package-shared/utils/logging/debug-log.d.ts new file mode 100644 index 0000000..3d0c568 --- /dev/null +++ b/dist/package-shared/utils/logging/debug-log.d.ts @@ -0,0 +1,25 @@ +declare const LogTypes: readonly ["error", "warning"]; +type Param = { + /** + * data to be logged. + */ + log: any; + /** + * Log Title. Could be name of function or name of variable + */ + title?: string; + /** + * Label for the log + */ + label?: string; + /** + * Log type. `error` or `warning` or default + */ + type?: (typeof LogTypes)[number]; + /** + * Whether to add a time stamp + */ + addTime?: boolean; +}; +export default function debugLog({ log, label, title, type, addTime }: Param): void; +export {}; diff --git a/dist/package-shared/utils/numberfy.d.ts b/dist/package-shared/utils/numberfy.d.ts new file mode 100644 index 0000000..803c09c --- /dev/null +++ b/dist/package-shared/utils/numberfy.d.ts @@ -0,0 +1,10 @@ +/** + * # Get Number from any input + * @example + * numberfy("123") // 123 + * numberfy("123.456") // 123 + * numberfy("123.456", 2) // 123.46 + * numberfy("123.456", 0) // 123 + * numberfy("123.456", 3) // 123.456 + */ +export default function numberfy(num: any, decimals?: number): number; diff --git a/dist/package-shared/utils/parse-env.d.ts b/dist/package-shared/utils/parse-env.d.ts new file mode 100644 index 0000000..6fa5e62 --- /dev/null +++ b/dist/package-shared/utils/parse-env.d.ts @@ -0,0 +1,3 @@ +export default function parseEnv(/** Env File Path */ envPath: string): { + [k: string]: string; +}; diff --git a/dist/package-shared/utils/serialize-cookies.d.ts b/dist/package-shared/utils/serialize-cookies.d.ts new file mode 100644 index 0000000..e88432e --- /dev/null +++ b/dist/package-shared/utils/serialize-cookies.d.ts @@ -0,0 +1,8 @@ +import { CookieObject } from "../types"; +/** + * # Serialize Cookies + * @description Convert cookie object to string array + */ +export default function serializeCookies({ cookies, }: { + cookies: CookieObject[]; +}): string[]; diff --git a/dist/package-shared/utils/serialize-query.d.ts b/dist/package-shared/utils/serialize-query.d.ts new file mode 100644 index 0000000..139698b --- /dev/null +++ b/dist/package-shared/utils/serialize-query.d.ts @@ -0,0 +1,4 @@ +/** + * # Serialize Query + */ +export default function serializeQuery(query: any): string; diff --git a/dist/package-shared/utils/slugToCamelTitle.d.ts b/dist/package-shared/utils/slugToCamelTitle.d.ts new file mode 100644 index 0000000..610626f --- /dev/null +++ b/dist/package-shared/utils/slugToCamelTitle.d.ts @@ -0,0 +1,4 @@ +/** + * # Slug to Camel case Title + */ +export default function slugToCamelTitle(text: String): string | null; diff --git a/dist/package-shared/utils/slugify.d.ts b/dist/package-shared/utils/slugify.d.ts new file mode 100644 index 0000000..6549342 --- /dev/null +++ b/dist/package-shared/utils/slugify.d.ts @@ -0,0 +1,9 @@ +/** + * # Return the slug of a string + * + * @example + * slugify("Hello World") // "hello-world" + * slugify("Yes!") // "yes" + * slugify("Hello!!! World!") // "hello-world" + */ +export default function slugify(str: string): string; diff --git a/dist/package-shared/utils/trim-sql.d.ts b/dist/package-shared/utils/trim-sql.d.ts new file mode 100644 index 0000000..c70059b --- /dev/null +++ b/dist/package-shared/utils/trim-sql.d.ts @@ -0,0 +1,5 @@ +/** + * # Trim SQL + * @description Remove Returns and miltiple spaces from SQL Query + */ +export default function trimSql(sql: string): string; diff --git a/package.json b/package.json index c8591fc..a6afe3e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@moduletrace/datasquirel", - "version": "4.4.0", + "version": "4.4.1", "description": "Cloud-based SQL data management tool", "main": "dist/index.js", "bin": { diff --git a/tsconfig.json b/tsconfig.json index d786d79..839ec7b 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -13,7 +13,7 @@ "resolveJsonModule": true, "jsx": "preserve", "moduleResolution": "node", - "declaration": false, + "declaration": true, "outDir": "dist", "plugins": [ {