@sava-info-systems/api-maker-with-extensions 1.0.0-alpha

package/dist/assets/schema-types/InterfaceProps.ts

@@ -0,0 +1,509 @@
+export enum IModelBaseProps {
+    _id = '_id',
+}
+
+export enum IUserProps {
+    name = 'name',
+    email = 'email',
+    apiPath = 'apiPath',
+    userType = 'userType',
+    password = 'password',
+    gitUrlWithCredentials = 'gitUrlWithCredentials',
+}
+
+export enum IApiUserProps {
+    name = 'name',
+    username = 'username',
+    user = 'user',
+    password = 'password',
+}
+
+export enum ISandboxDependencyProps {
+    name = 'name',
+    version = 'version',
+}
+
+export enum ITPApiSettingsProps {
+    // storeApiBundleId = 'storeApiBundleId',
+    // storeApiVersionId = 'storeApiVersionId',
+    // apiId = 'apiId',
+
+    bundleName = 'bundleName',
+    apiVersion = 'apiVersion',
+    apiName = 'apiName',
+
+    user = 'user',
+    enableCaching = 'enableCaching',
+    acceptOnlyEncryptedData = 'acceptOnlyEncryptedData',
+    apiAccessType = 'apiAccessType',
+    authTokenInfo = 'authTokenInfo',
+    thirdPartyApiSettingsCode = 'thirdPartyApiSettingsCode',
+    resetCacheOnModificationOf = 'resetCacheOnModificationOf',
+
+}
+
+export enum IAmEventProps {
+    user = 'user',
+    name = 'name',
+    triggerOnApis = 'triggerOnApis',
+    apiCategory = 'apiCategory',
+
+    instanceName = 'instanceName',
+    databaseName = 'databaseName',
+    collectionName = 'collectionName',
+    instanceApiName = 'instanceApiName',
+
+    customApiName = 'customApiName',
+
+    systemApiName = 'systemApiName',
+
+    tpInstalledApiBundleName = 'tpInstalledApiBundleName',
+    tpInstalledApiVersion = 'tpInstalledApiVersion',
+    tpInstalledApiName = 'tpInstalledApiName',
+}
+
+export enum ITriggerOnApiProps {
+    apiCategory = 'apiCategory',
+    instance = 'instance',
+    databaseName = 'databaseName',
+    collectionName = 'collectionName',
+    apiName = 'apiName',
+    // systemApiId = 'systemApiId',
+    // functionId = 'functionId',
+    // tpInstalledApiId = 'tpInstalledApiId',
+    // storeApiVersionId = 'storeApiVersionId',
+    // value = 'value',
+}
+
+export enum IAmEventListenerProps {
+    name = 'name',
+    apiCodeStr = 'apiCodeStr',
+    apiCodeStrJS = 'apiCodeStrJS',
+    apiCodeStrMap = 'apiCodeStrMap',
+    eventListenerTimeoutInMinutes = 'eventListenerTimeoutInMinutes',
+    runOnNativeProcess = 'runOnNativeProcess',
+}
+
+export enum ITPInstalledApiVersionProps {
+    version = 'version',
+    apiCodeStr = 'apiCodeStr',
+    apiCodeStrJS = 'apiCodeStrJS',
+}
+
+export enum ITPInstalledApiProps {
+    user = 'user',
+    // storeApiVersionId = 'storeApiVersionId',
+    // storeApiBundleId = 'storeApiBundleId',
+    // tpInstalledSchemaId = 'tpInstalledSchemaId',
+    bundleName = 'bundleName',
+    apiVersion = 'apiVersion',
+    apiCodeStr = 'apiCodeStr',
+
+    name = 'name',
+    path = 'path',
+    requestMethod = 'requestMethod',
+    categoryRedis = 'categoryRedis',
+    reqBodySchema = 'reqBodySchema',
+    reqQueryParametersSchema = 'reqQueryParametersSchema',
+    errorList = 'errorList',
+    apiDocs = 'apiDocs',
+    apiJsonStr = 'apiJsonStr',
+
+    // calculatedProperty
+    nameForGroup = 'nameForGroup',
+    apiBundleNameAndApiVersion = 'apiBundleNameAndApiVersion',
+
+}
+
+export enum ITPApiVersionProps {
+    user = 'user',
+    apiBundleName = 'apiBundleName',
+    apiBundleLabel = 'apiBundleLabel',
+    storeApiVersion = 'storeApiVersion',
+}
+
+export enum ICustomApiProps {
+    user = 'user',
+    name = 'name',
+    path = 'path',
+    functionCode = 'functionCode',
+    functionCodeJS = 'functionCodeJS',
+    functionBasicInfo = 'functionBasicInfo',
+    functionBasicInfoJS = 'functionBasicInfoJS',
+    // label = 'label',
+    apiDocs = 'apiDocs',
+    apiAccessType = 'apiAccessType',
+    authTokenInfo = 'authTokenInfo',
+    enableCaching = 'enableCaching',
+    acceptOnlyEncryptedData = 'acceptOnlyEncryptedData',
+    requestMethod = 'requestMethod',
+    reqBodySchema = 'reqBodySchema',
+    reqQueryParametersSchema = 'reqQueryParametersSchema',
+    resetCacheOnModificationOf = 'resetCacheOnModificationOf',
+    errorList = 'errorList',
+    runOnNativeProcess = 'runOnNativeProcess',
+}
+
+export enum IGroupProps {
+    user = 'user',
+    name = 'name'
+}
+
+export enum IInstanceApiSettingsProps {
+    instanceName = 'instanceName',
+    databaseName = 'databaseName',
+    collectionName = 'collectionName',
+    apiId = 'apiId',
+    user = 'user',
+    apiAccessType = 'apiAccessType',
+    enableCaching = 'enableCaching',
+    acceptOnlyEncryptedData = 'acceptOnlyEncryptedData',
+    authTokenInfo = 'authTokenInfo',
+    instanceApiSettingCode = 'instanceApiSettingCode',
+    instanceApiSettingCodeJS = 'instanceApiSettingCodeJS',
+}
+
+export enum IInstanceApiHooksProps {
+    instanceName = 'instanceName',
+    databaseName = 'databaseName',
+    collectionName = 'collectionName',
+    apiId = 'apiId',
+    user = 'user',
+}
+
+export enum IInstanceProps {
+    _id = '_id',
+    user = 'user',
+    name = 'name',
+    label = 'label',
+    type = 'type',
+    username = 'username',
+    password = 'password',
+    privilege = 'privilege',
+    maxPoolConnections = 'maxPoolConnections',
+    active = 'active',
+    connectionString = 'connectionString',
+}
+
+export enum ISchemaProps {
+    instanceName = 'instanceName',
+    databaseName = 'databaseName',
+    collectionName = 'collectionName',
+    propertiesCode = 'propertiesCode',
+    user = 'user',
+}
+
+export enum ISchedulerProps {
+    user = 'user',
+    name = 'name',
+    collectionName = 'collectionName',
+    // label = 'label',
+    schedulerCode = 'schedulerCode',
+    schedulerTimeoutInMinutes = 'schedulerTimeoutInMinutes',
+    active = 'active',
+    isActive = 'isActive',
+    runOnNativeProcess = 'runOnNativeProcess',
+}
+
+export enum IIntervalArrProps {
+    timeInterval = 'timeInterval',
+    timeZone = 'timeZone',
+    active = 'active',
+}
+
+export enum ISecretProps {
+    user = 'user',
+    name = 'name',
+    keysCode = 'keysCode',
+    isDefault = 'isDefault',
+}
+
+export enum I18NProps {
+    user = 'user',
+    name = 'name',
+    keysCode = 'keysCode'
+}
+
+export enum ISystemApiSettingsProps {
+    user = 'user',
+    sysApiSettingCode = 'sysApiSettingCode',
+    apiId = 'apiId',
+    enableCaching = 'enableCaching',
+    acceptOnlyEncryptedData = 'acceptOnlyEncryptedData',
+    apiAccessType = 'apiAccessType',
+    authTokenInfo = 'authTokenInfo',
+}
+
+export enum ISystemApiHooksProps {
+    user = 'user',
+    apiId = 'apiId',
+}
+
+export enum IAmStoreApiVersionProps {
+    _id = '_id',
+    // apiBundleId = 'apiBundleId',
+    bundleName = 'bundleName',
+    apiVersion = 'apiVersion',
+    user = 'user'
+}
+
+export enum IAmStoreLibApiProps {
+    bundleName = 'bundleName',
+    apiVersion = 'apiVersion',
+    // storeApiVersionId = 'storeApiVersionId',
+    user = 'user',
+    path = 'path',
+    requestMethod = 'requestMethod',
+    name = 'name',
+    categoryRedis = 'categoryRedis'
+}
+
+export enum ITPInstalledApiFieldsCommonWithStoreProps {
+    name = 'name',
+    path = 'path',
+    requestMethod = 'requestMethod',
+    categoryRedis = 'categoryRedis',
+    headers = 'headers',
+    queryParams = 'queryParams',
+    reqBodySchema = 'reqBodySchema',
+    reqQueryParametersSchema = 'reqQueryParametersSchema',
+    errorList = 'errorList',
+}
+
+export enum IAmStoreAPIBundleProps {
+    name = 'name',
+    label = 'label',
+    user = 'user',
+    iconUrl = 'iconUrl',
+    description = 'description',
+    apiBundleState = 'apiBundleState',
+    apiBundleSubState = 'apiBundleSubState',
+}
+
+export enum IAmStoreUserProps {
+    email = 'email',
+    username = 'username',
+    name = 'name',
+    userType = 'userType',
+    password = 'password',
+}
+
+export enum IGroupPermissionProps {
+    instanceName = 'instanceName',
+    databaseName = 'databaseName',
+    collectionName = 'collectionName',
+    apiBundleName = 'apiBundleName',
+    apiVersionName = 'apiVersionName',
+    apiName = 'apiName',
+}
+
+export enum IDatabaseProps {
+    db = 'db'
+}
+
+export enum ISupportedAPIParamProps {
+    name = 'name',
+    id = 'id',
+    _id = '_id',
+    nameId = 'nameId',
+    readonlyKey = 'readonlyKey',
+    readonlyValue = 'readonlyValue',
+}
+
+export enum IPrePostHookProps {
+    _id = '_id',
+    name = 'name',
+    hookCode = 'hookCode',
+    hookCodeJS = 'hookCodeJS',
+    hookCodeMap = 'hookCodeMap',
+    isActive = 'isActive',
+    runOnNativeProcess = 'runOnNativeProcess',
+}
+
+export enum IArrayOperationBodyProps {
+    find = 'find',
+    operations = 'operations',
+}
+
+export enum IArrayOperationProps {
+    operation = 'operation',
+    path = 'path',
+    dataToPush = 'dataToPush',
+    dataToPull = 'dataToPull',
+    queryToRemove = 'queryToRemove',
+    direction = 'direction',
+    position = 'position',
+    slice = 'slice',
+    sort = 'sort',
+    dataToSet = 'dataToSet',
+    arrayFilters = 'arrayFilters',
+    upsert = 'upsert',
+}
+
+export enum IStoreSecretKeysProps {
+    keyName = 'keyName',
+    keyType = 'keyType',
+    isDefault = 'isDefault',
+}
+
+export enum IStoreSecretProps {
+    user = 'user',
+    name = 'name',
+    keysCode = 'keysCode'
+}
+
+export enum INotesProps {
+    name = 'name',
+    user = 'user'
+}
+
+export enum IUtilityClassesProps {
+    name = 'name',
+    user = 'user',
+    utilityClassCode = 'utilityClassCode',
+    folderPath = 'folderPath'
+}
+
+export enum IStoreUtilityClassesProps {
+    name = 'name',
+    user = 'user',
+    bundleName = 'bundleName',
+    apiVersion = 'apiVersion',
+    // storeApiVersionId = 'storeApiVersionId',
+    utilityClassCode = 'utilityClassCode',
+    folderPath = 'folderPath',
+}
+
+export enum ILogProfileProps {
+    user = 'user',
+    name = 'name'
+}
+
+export enum IDBMigrationProps {
+    name = 'name',
+    user = 'user',
+    order = 'order',
+    label = 'label',
+    dbMigrationScriptCode = 'dbMigrationScriptCode',
+}
+
+export enum IProcessInitializerProps {
+    name = 'name',
+    user = 'user',
+    order = 'order',
+    label = 'label',
+    processInitializerCode = 'processInitializerCode',
+}
+
+export enum IAdminDashboardsProps {
+    user = 'user'
+}
+
+export enum ICallApiFromBackendProps {
+}
+
+export enum IAuthTokenInfoProps {
+    authTokenType = 'authTokenType',
+    authTokenAM = 'authTokenAM',
+    authTokenAMDB = 'authTokenAMDB',
+}
+
+export enum IAuthTokenAMProps {
+    u = 'u',
+    p = 'p',
+}
+
+export enum IRefreshTokenAMProps {
+    refresh_token = 'refresh_token',
+}
+
+export enum IAuthTokenAMDBProps {
+    instance = 'instance',
+    database = 'database',
+    collection = 'collection',
+    table = 'table',
+    usernameColumn = 'usernameColumn',
+    passwordColumn = 'passwordColumn',
+    countOfUsersForTesting = 'countOfUsersForTesting',
+    condition = 'condition',
+    sortUsersForTesting = 'sortUsersForTesting',
+    select = 'select',
+}
+
+export enum IGeneralProps {
+    COLUMN_NAME = 'COLUMN_NAME',
+    SCHEMA_NAME = 'SCHEMA_NAME',
+    CONSTRAINT_NAME = 'CONSTRAINT_NAME',
+    TABLE_NAME = 'TABLE_NAME',
+    hostName = 'hostName',
+    id = 'id',
+    _id = '_id',
+    text = 'text',
+    name = 'name',
+}
+
+export enum IOrderByProps {
+    asc = 'asc',
+    desc = 'desc'
+}
+
+export enum IGitStatusProps {
+    filePath = 'filePath',
+    gitStatus = 'gitStatus',
+    filePathOriginal = 'filePathOriginal',
+}
+
+export enum IEmitEventProps {
+    name = 'name',
+}
+
+export enum IWebSocketEventsProps {
+    id = 'id', // used in group saving. // user friendly id
+    name = 'name',
+    apiCategory = 'apiCategory',
+    user = 'user'
+}
+
+export enum IDBMastersProps {
+    id = 'id', // used in group saving. // user friendly id
+    name = 'name',
+    instanceName = 'instanceName',
+    databaseName = 'databaseName',
+    collectionName = 'collectionName',
+    user = 'user',
+    dbMasterConfig = 'dbMasterConfig',
+}
+
+export enum IAmTestCasesProps {
+    name = 'name',
+    testCaseType = 'testCaseType',
+    user = 'user'
+}
+
+export enum IGroupsDataSourceProps {
+    instance = 'instance',
+    database = 'database',
+    collection = 'collection',
+    table = 'table',
+    targetFieldForUniqueId = 'targetFieldForUniqueId',
+    groupsColumn = 'groupsColumn',
+    select = 'select',
+}
+
+export enum IAuthInfoObjectsProps {
+    authAMDBGroups = 'authAMDBGroups',
+    authGoogleGroups = 'authGoogleGroups',
+    authAWSGroups = 'authAWSGroups',
+    authAzureGroups = 'authAzureGroups',
+
+}
+
+export enum ISupportedAPIProps {
+    collectionId = 'collectionId',
+    name = 'name',
+}
+
+export enum IKTreeBaseItemProps {
+    name = 'name',
+    nameId = 'nameId',
+}

package/dist/assets/schema-types/store-types.ts

@@ -0,0 +1,170 @@
+import { ISchemaType } from './types';
+
+export interface IApiSchema {
+    name: string;
+    path: string;
+    requestMethod: ERequestMethod;
+    categoryRedis: EAPICategoryRedis;
+
+    headers?: ISupportedAPIParam[];
+    autoAddHeaders?: boolean;
+    queryParams?: ISupportedAPIParam[];
+    autoAddQueryParams?: boolean;
+    requestBodyTypeSupported?: EApiRequestBodyType[];
+    reqBodySchema?: ISchemaType;
+    reqQueryParametersSchema?: ISchemaType;
+    errorList: string[];
+}
+
+export type IApiSchemaUI = Omit<IApiSchema, 'headers' | 'autoAddHeaders' | 'queryParams' | 'autoAddQueryParams' | 'requestBodyTypeSupported'>;
+
+export interface ISupportedAPIParam {
+    type: ESupportedAPIParamType;
+    name: string;
+    required: boolean;
+    readonlyKey: boolean;
+    readonlyValue: boolean;
+
+    valueArr?: any[]; // to provide list for dropdown
+    defaultValue?: any; // actual value
+    value?: any,
+    valueTemp?: any;
+    nonRemovable?: boolean; // if it is true then it will not be removable from UI.
+
+    // calculated UI properties
+    isChecked?: boolean; // left side checkbox value
+    id?: number; // left side checkbox value
+}
+
+export enum EAPICategoryRedis {
+    GET_DATA = 'GET_DATA',
+    MODIFY_DATA = 'MODIFY_DATA',
+}
+
+export enum EApiRequestBodyType {
+    FORM_DATA = 'FORM_DATA',
+    JSON = 'JSON',
+    TEXT = 'TEXT',
+}
+
+export enum ERequestMethod {
+    GET = 'GET',
+    POST = 'POST',
+    PUT = 'PUT',
+    DELETE = 'DELETE',
+}
+
+export enum ESupportedAPIParamType {
+    // input supported types
+    text = 'text',
+    number = 'number',
+
+    // custom types
+    secret = 'secret',
+    am_authorization = 'am_authorization',
+    user_authorization = 'user_authorization',
+
+    aws_authorization = 'aws_authorization',
+    google_authorization = 'google_authorization',
+    azure_authorization = 'azure_authorization',
+
+    i18n = 'i18n',
+    boolean = 'boolean',
+    dropdown = 'dropdown',
+    file = 'file',
+    files = 'files',
+}
+
+// if new entry added, please add in headers.json5 also.
+// If new entry added. Need to set in getStatusCodeFromResponseString also.
+// duplicate with types.ts
+export enum EContentType {
+    JSON = 'application/json',
+    XML = 'text/xml',
+    YAML = 'text/yaml',
+    TEXT = 'text/plain',
+    HTML = 'text/html',
+    OCTET_STREAM = 'application/octet-stream',
+}
+
+// keep all header values in lower case.
+// find in considerHeadersInRedisKey = [ and adjust also
+export enum EHeader {
+    CONTENT_TYPE = 'content-type',
+    ACCEPT_ENCODING = 'accept-encoding', // default br compression, identity = no compression, if accept-encoding header is not found br will be used. user can any of these values ['br', 'deflate', 'gzip', 'identity']
+    NO_COMPRESSION_STD = 'x-no-compression', // standard compression header is supported by us.
+
+    AUTHORIZATION_AM = 'x-am-authorization', // if API is not public then this token is mandatory.
+    AUTHORIZATION_AM_USER = 'x-am-user-authorization', // used tor EAuthTokenType
+    AUTHORIZATION_AWS = 'x-aws-authorization', // used tor EAuthTokenType
+    AUTHORIZATION_GOOGLE = 'x-google-authorization', // used tor EAuthTokenType
+    AUTHORIZATION_AZURE = 'x-azure-authorization', // used tor EAuthTokenType
+    RUN_IN_SANDBOX = 'x-am-run-in-sandbox',
+
+    ORIGIN = 'origin',
+    AUTHORIZATION = 'authorization',
+    META = 'x-am-meta', // true, false
+    SECRET = 'x-am-secret',
+    CONTENT_TYPE_RESPONSE = 'x-am-content-type-response', // EContentType
+    CACHE_CONTROL = 'x-am-cache-control', // ECacheControl
+    CODE_HASH = 'x-am-code-hash',
+    SANDBOX_TIMEOUT = 'x-am-sandbox-timeout',
+    GET_ENCRYPTED_DATA = 'x-am-get-encrypted-data', // EGetEncryptedData
+    ENCRYPTED_PAYLOAD = 'x-am-encrypted-payload', // FE will send 'true' in it when payload is encrypted for transfer.
+    RESPONSE_CASE = 'x-am-response-case', // EResponseCase
+    RESPONSE_OBJECT_TYPE = 'x-am-response-object-type', // EResponseObjectType
+    AM_I18N = 'x-am-internationalization', // user's I18N data
+
+    // response headers
+    DATA_SOURCE = 'x-am-data-source', // EDataSource // api, cache
+
+    // not for end users.
+    TEST_HOOK = 'x-am-test-hook', // while testing hook, send this as true so only that code will be executed and other hooks will not be executed.
+    TEST_EVENT = 'x-am-test-event', // it will be sent from UI when user is testing event code.
+    INTER_COMM = 'x-am-inter-comm', // Used between sandbox and process communication. It will have encrypted content.
+    SEND_ONLY_OBJECTS = 'x-am-send-only-objects-in-stream', // used by sandbox API calls internally.
+    AM_REQUEST_ID = 'x-am-request-id', // used to send requestId in response headers and internal calls can have same request Id.
+    AM_STORE_TOKEN = 'x-am-store-token', // used to get data from store public APIs
+}
+
+export enum EHeaderDBMasters {
+    DB_MASTER_NAME = 'db-master-name',
+    ADMIN_PATH = 'admin-path',
+}
+
+export enum ECacheControl {
+    reset_cache = 'reset_cache',
+    no_action = 'no_action',
+}
+
+// Duplicate with types.ts
+export enum EDataSource {
+    api = 'api',
+    cache = 'cache',
+}
+
+export enum EGetEncryptedData {
+    no_encryption = 'no_encryption',
+    get_only_encryption = 'get_only_encryption',
+    get_data_and_encryption = 'get_data_and_encryption',
+}
+
+export enum EResponseCase {
+    noChange = 'noChange', // default, do not change user response
+    camelCase = 'camelCase',
+    capitalCase = 'capitalCase',
+    constantCase = 'constantCase',
+    dotCase = 'dotCase',
+    headerCase = 'headerCase',
+    noCase = 'noCase',
+    paramCase = 'paramCase',
+    pascalCase = 'pascalCase',
+    pathCase = 'pathCase',
+    sentenceCase = 'sentenceCase',
+    snakeCase = 'snakeCase',
+}
+
+export enum EResponseObjectType {
+    no_action = 'no_action',
+    make_flat = 'make_flat',
+}