@bshsolutions/sdk 0.0.1-alpha

package/README.md

@@ -0,0 +1,38 @@
+# @bshsolutions/sdk
+
+A TypeScript SDK for integrating with [BSH Engine](https://engine.bousalih.com) - a low code backend platform that allows you to create APIs for your application with minimal configuration.
+
+## What is BSH Engine?
+
+[BSH Engine](https://engine.bousalih.com) is a backend tool that enables you to build robust APIs quickly without writing boilerplate code. It provides:
+
+- **Entity Management**: Create, read, update, and delete entities with built-in CRUD operations
+- **Search & Filtering**: Advanced search and filtering for your entities
+- **Authentication**: User registration, login, and JWT token management
+- **File Storage**: Upload and manage images and files
+- **Email Services**: Send emails with templates
+- **API Key Management**: Secure API key generation and management
+- Visit [https://engine.bousalih.com](https://engine.bousalih.com) for more details.
+
+## Installation
+
+```bash
+npm install @bshsolutions/sdk
+# or
+yarn add @bshsolutions/sdk
+# or
+pnpm add @bshsolutions/sdk
+```
+
+## Quick Start
+
+### Basic Setup
+
+```typescript
+import { BshEngine } from '@bshsolutions/sdk';
+
+export const bshServices = new BshEngine()
+    .withHost('https://you-instance.com')
+```
+
+> for full documtation on how to use it visit: [https://docs.bousalih.com/docs/bsh-engine/sdk](https://docs.bousalih.com/docs/bsh-engine/sdk)

package/dist/chunk-KVBU5VZS.js

@@ -0,0 +1,55 @@
+// src/types/response/index.ts
+var isOk = (response) => response == void 0 ? false : response?.code >= 200 && response?.code < 300;
+var BshError = class extends Error {
+  constructor(status, endpoint, response) {
+    if (response) response.endpoint = endpoint;
+    super(JSON.stringify(response, null, 2));
+    this.status = status;
+    this.endpoint = endpoint;
+    this.response = response;
+    this.name = "BshError";
+  }
+};
+
+// src/types/entities/index.ts
+var BshEntityTypes = ["Table", "View", "Function"];
+var BshUpdateStrategies = ["Replace", "Upsert"];
+var BshInsertDuplicates = ["Upsert", "Error"];
+var BshPKStrategies = ["AutoIncrement", "UUID", "Fixed"];
+var BshPKTypes = ["string", "number"];
+var BshEntityPermissions = ["read", "write", "update", "delete"];
+
+// src/types/security/index.ts
+var PrincipalType = [
+  "user",
+  "role",
+  "any",
+  "apiKey"
+  /*'group'*/
+];
+var PolicyActions = ["*", "READ", "WRITE", "DELETE", "UPDATE", "SEARCH"];
+
+// src/types/config/index.ts
+var defaultSettings = {
+  name: "BshEngine",
+  api: {
+    response: {
+      showSql: true
+    },
+    auth: {
+      enableRegister: false
+    }
+  }
+};
+
+// src/types/storage/index.ts
+var formatFileSize = (file) => {
+  if (!file?.bytes) return "Unknown";
+  const sizes = ["Bytes", "KB", "MB", "GB"];
+  const i = Math.floor(Math.log(file.bytes) / Math.log(1024));
+  return Math.round(file.bytes / Math.pow(1024, i) * 100) / 100 + " " + sizes[i];
+};
+
+export { BshEntityPermissions, BshEntityTypes, BshError, BshInsertDuplicates, BshPKStrategies, BshPKTypes, BshUpdateStrategies, PolicyActions, PrincipalType, defaultSettings, formatFileSize, isOk };
+//# sourceMappingURL=chunk-KVBU5VZS.js.map
+//# sourceMappingURL=chunk-KVBU5VZS.js.map

package/dist/chunk-KVBU5VZS.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types/response/index.ts","../src/types/entities/index.ts","../src/types/security/index.ts","../src/types/config/index.ts","../src/types/storage/index.ts"],"names":[],"mappings":";AAwBO,IAAM,IAAA,GAAO,CAAC,QAAA,KAA+C,QAAA,IAAY,MAAA,GAAY,QAAQ,QAAA,EAAU,IAAA,IAAQ,GAAA,IAAO,QAAA,EAAU,IAAA,GAAO;AAEvI,IAAM,QAAA,GAAN,cAAuB,KAAA,CAAM;AAAA,EAChC,WAAA,CACW,MAAA,EACA,QAAA,EACA,QAAA,EACT;AACE,IAAA,IAAI,QAAA,WAAmB,QAAA,GAAW,QAAA;AAClC,IAAA,KAAA,CAAM,IAAA,CAAK,SAAA,CAAU,QAAA,EAAU,IAAA,EAAM,CAAC,CAAC,CAAA;AALhC,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA;AACA,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA;AAIP,IAAA,IAAA,CAAK,IAAA,GAAO,UAAA;AAAA,EAChB;AACJ;;;ACRO,IAAM,cAAA,GAAiB,CAAC,OAAA,EAAS,MAAA,EAAQ,UAAU;AACnD,IAAM,mBAAA,GAAsB,CAAC,SAAA,EAAW,QAAQ;AAChD,IAAM,mBAAA,GAAsB,CAAC,QAAA,EAAU,OAAO;AAC9C,IAAM,eAAA,GAAkB,CAAC,eAAA,EAAiB,MAAA,EAAQ,OAAO;AACzD,IAAM,UAAA,GAAa,CAAC,QAAA,EAAU,QAAQ;AACtC,IAAM,oBAAA,GAAuB,CAAC,MAAA,EAAQ,OAAA,EAAS,UAAU,QAAQ;;;ACoBjE,IAAM,aAAA,GAAgB;AAAA,EAAC,MAAA;AAAA,EAAQ,MAAA;AAAA,EAAQ,KAAA;AAAA,EAAO;AAAA;AAAqB;AACnE,IAAM,gBAAgB,CAAC,GAAA,EAAK,QAAQ,OAAA,EAAS,QAAA,EAAU,UAAU,QAAQ;;;AClCzE,IAAM,eAAA,GAA+B;AAAA,EACxC,IAAA,EAAM,WAAA;AAAA,EACN,GAAA,EAAK;AAAA,IACD,QAAA,EAAU;AAAA,MACN,OAAA,EAAS;AAAA,KACb;AAAA,IACA,IAAA,EAAM;AAAA,MACF,cAAA,EAAgB;AAAA;AACpB;AAER;;;ACeO,IAAM,cAAA,GAAiB,CAAC,IAAA,KAA2B;AACtD,EAAA,IAAI,CAAC,IAAA,EAAM,KAAA,EAAO,OAAO,SAAA;AACzB,EAAA,MAAM,KAAA,GAAQ,CAAC,OAAA,EAAS,IAAA,EAAM,MAAM,IAAI,CAAA;AACxC,EAAA,MAAM,CAAA,GAAI,IAAA,CAAK,KAAA,CAAM,IAAA,CAAK,GAAA,CAAI,IAAA,CAAK,KAAK,CAAA,GAAI,IAAA,CAAK,GAAA,CAAI,IAAI,CAAC,CAAA;AAC1D,EAAA,OAAO,IAAA,CAAK,KAAA,CAAM,IAAA,CAAK,KAAA,GAAQ,KAAK,GAAA,CAAI,IAAA,EAAM,CAAC,CAAA,GAAI,GAAG,CAAA,GAAI,GAAA,GAAM,GAAA,GAAM,MAAM,CAAC,CAAA;AACjF","file":"chunk-KVBU5VZS.js","sourcesContent":["export type BshResponse<T> = {\n    data: T[]\n    timestamp: number\n    code: number\n    status: string\n    error?: string\n    meta?: {\n        type?: string,\n        sql?: string,\n        error?: string,\n        tips?: {[key: string]: string}\n    }\n    pagination?: {\n        current: number,\n        total: number,\n        pages: number,\n        first: boolean,\n        last: boolean\n    }\n    endpoint?: string,\n    api?: string,\n    validations?: {field: string, error: string}[]\n}\n\nexport const isOk = (response: BshResponse<unknown> | undefined) => response == undefined ? false : response?.code >= 200 && response?.code < 300\n\nexport class BshError extends Error {\n    constructor(\n        public status: number,\n        public endpoint: string,\n        public response?: BshResponse<unknown>\n    ) {\n        if (response) response.endpoint = endpoint\n        super(JSON.stringify(response, null, 2));\n        this.name = 'BshError';\n    }\n}\n","import {BshObject, BshObjectPure} from '@types';\n\nexport type BshEntities = {\n    name: string\n    dbTable: string\n    dbSchema: string\n    type: 'Table' | 'View' | 'Function'\n    dbSource: string\n    updateStrategy: 'Replace' | 'Upsert'\n    insertDuplicate: 'Upsert' | 'Error'\n    bshSchema?: string\n    plugin?: string\n    auditable?: boolean\n    pks: {\n        key: string\n        strategy: 'AutoIncrement' | 'UUID' | 'Fixed'\n        type: 'string' | 'number'\n    }[]\n    permissions?: {\n        write?: boolean\n        read?: boolean\n        delete?: boolean\n        update?: boolean\n    }\n} & BshObject;\n\nexport type BshEntitiesPure = BshObjectPure<BshEntities>;\nexport type BshEntityPermissions = 'read' | 'write' | 'update' | 'delete';\nexport const BshEntityTypes = ['Table', 'View', 'Function'] as const;\nexport const BshUpdateStrategies = ['Replace', 'Upsert'] as const;\nexport const BshInsertDuplicates = ['Upsert', 'Error'] as const;\nexport const BshPKStrategies = ['AutoIncrement', 'UUID', 'Fixed'] as const;\nexport const BshPKTypes = ['string', 'number'] as const;\nexport const BshEntityPermissions = ['read', 'write', 'update', 'delete'] as const;\n\nexport type BshSchemas = {\n    name: string\n    label: string\n    description: string\n    plugin: string\n    properties: {\n        type: string\n\n        name: string\n        displayName: string\n        description: string\n\n        required: boolean\n        unique: boolean\n        default: string\n\n        length: number\n        maxLength: number\n        minLength: number\n\n        pattern: string\n    }[]\n} & BshObject;\n\nexport type BshSchemasPure = BshObjectPure<BshSchemas>;\nexport type BshSchemaProperty = BshSchemas['properties'][number];\n\nexport type BshTypes = {\n    name: string\n    label: string\n    plugin?: string\n    baseType?: string\n    schema?: string\n    meta?: {\n        description?: string\n        pattern?: string\n        maxLength?: number\n        minLength?: number\n        max?: number\n        min?: number\n    }\n} & BshObject;\n\nexport type BshTypesPure = BshObjectPure<BshTypes>;\n\n","import {BshDate, BshObject, BshObjectPure} from '@types';\n\nexport type BshUser = {\n    userId: string\n    email: string\n    password?: string\n    roles: string[]\n    status: 'ACTIVATED' | 'REQUIRED_ACTIVATION' | 'DISABLED' | 'REQUIRED_RESET_PASSWORD'\n    profile?: {\n        firstName?: string\n        lastName?: string\n        phone?: string\n        picture?: string\n        tags?: string[]\n        [k: string]: unknown\n    }\n} & BshObject;\n\nexport type BshUserInit = {\n    email: string\n    password?: string\n    roles?: string[]\n    profile: BshUser['profile']\n}\n\nexport type BshUserPure = BshObjectPure<BshUser>;\n\nexport type BshRole = {\n    name: string\n    public?: boolean\n    description?: string\n} & BshObject;\n\nexport type BshRolePure = BshObjectPure<BshRole>;\n\nexport type BshPolicy = {\n    name: string\n    description?: string\n    principals: {\n        type: Uppercase<'user' | 'group' | 'role' | 'apiKey' | 'any'>\n        value: string[]\n    }[]\n    permissions: {\n        entity: string[]\n        actions: ('READ' | 'WRITE' | 'DELETE' | 'UPDATE' | 'SEARCH' | '*')[]\n        allow: boolean\n    }[]\n    enabled: boolean\n    priority?: number\n    apiKeyId?: number\n} & BshObject;\n\nexport type BshPolicyPure = BshObjectPure<BshPolicy>;\nexport const PrincipalType = ['user', 'role', 'any', 'apiKey', /*'group'*/] as const;\nexport const PolicyActions = ['*', 'READ', 'WRITE', 'DELETE', 'UPDATE', 'SEARCH'] as const;\n\nexport type BshApiKeysScopes = {\n    read: boolean\n    write: boolean\n    delete: boolean\n    update: boolean\n}\n\nexport type BshApiKeysForm = {\n    name: string\n    description?: string\n    duration: number\n    type: 'PERSONAL' | 'MACHINE'\n    scopes: string[] // Format: [\"EntityName:ACTION\", ...]\n}\n\nexport type BshApiKeys = BshApiKeysForm & {\n    id: number\n    apiKey: string\n    startedAt: BshDate\n    expiresAt?: BshDate\n    status: 'ACTIVE' | 'REVOKED'\n    userId?: string\n} & BshObject;\n\n","import {BshObject} from \"@types\";\n\nexport type BshConfigurations<T extends Record<string, unknown> = Record<string, unknown>> = {\n    name: string;\n    description: string;\n    config?: T;\n} & BshObject\n\nexport type BshSettings = {\n    name: string;\n    api: {\n        response?: {\n            showSql?: boolean;\n        };\n        auth?: {\n            enableRegister?: boolean;\n        };\n    };\n}\n\nexport const defaultSettings: BshSettings = {\n    name: 'BshEngine',\n    api: {\n        response: {\n            showSql: true\n        },\n        auth: {\n            enableRegister: false\n        }\n    }\n}\n\n","import {BshObject, BshConfigurations} from '@types';\n\nexport type StorageProvider = 'cloudinary';\n\nexport type CloudinaryConfig = {\n    url: string;\n    folder?: string;\n}\n\nexport type StorageConfiguration = BshConfigurations & {\n    enabled?: StorageProvider;\n    cloudinary: CloudinaryConfig\n}\n\nexport type BshFiles = {\n    uri: string,\n    folder: string,\n    secureUri: string,\n    tags?: string[],\n    assetId: string,\n    bytes: number,\n    context?: { [key: string]: string },\n    publicId: string,\n    fileId: string,\n    width: number,\n    height: number,\n    format: string,\n} & BshObject\n\nexport type UploadOptions = {\n    tags: string[]\n    context: { [key: string]: unknown }\n    [key: string]: unknown;\n}\n\nexport type UploadResponse = {\n    fileId: string\n    publicId: string\n    assetId: string\n    uri: string\n    secureUri: string\n    tags: string[]\n    context: { [key: string]: unknown }\n}\n\nexport const formatFileSize = (file: BshFiles): string => {\n    if (!file?.bytes) return 'Unknown';\n    const sizes = ['Bytes', 'KB', 'MB', 'GB'];\n    const i = Math.floor(Math.log(file.bytes) / Math.log(1024));\n    return Math.round(file.bytes / Math.pow(1024, i) * 100) / 100 + ' ' + sizes[i];\n};\n\n"]}