@arisnetxsolutions/quantum-core-sdk 1.0.3 → 1.0.4

package/README.md

@@ -1,78 +1,150 @@
-# QuantumCore SDK 📦
+# QuantumCore SDK 📦 🛡️
 
-Type-safe TypeScript library for consuming content from your QuantumCore Headless CMS.
+![QuantumCore Banner](https://img.shields.io/badge/QuantumCore-Headless_CMS-6366f1?style=for-the-badge&logo=shield)
+![NPM Version](https://img.shields.io/npm/v/@arisnetxsolutions/quantum-core-sdk?style=for-the-badge&color=emerald)
+![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue?style=for-the-badge&logo=typescript)
+
+Librería oficial de **QuantumCore CMS** para el consumo de contenido de forma tipada, segura y eficiente. Diseñada especialmente para integraciones con React, Next.js, Vue y cualquier entorno Moderno de JavaScript/TypeScript.
+
+---
+
+## 🔥 Características Principales
+
+- 💎 **Type-Safe**: Aprovecha el poder de TypeScript con interfaces completas para todos tus modelos.
+- 🚀 **Zero Config**: Inicialización rápida con solo tu API Key y URL del servidor.
+- 🔐 **Dual Auth**: Soporta tanto el consumo público (API Keys de Proyecto) como la gestión administrativa (JWT).
+- 🖼️ **Asset Management**: Sistema integrado para obtener URLs absolutas de imágenes y archivos.
+- 📑 **Modular**: Separación clara entre Blog, Servicios, Galería y Funciones Administrativas.
+
+---
+
+## ⚙️ Instalación
+
+Instala el paquete mediante npm:
 
-## Installation
 ```bash
-# replace with the actual package name once published
-npm install quantum-core-sdk
+npm install @arisnetxsolutions/quantum-core-sdk
 ```
 
-## Usage
+---
 
-By default the SDK will look for an environment variable named `QUANTUMCORE_API_URL`; you can also pass the `baseUrl` option directly when creating a client. This makes it easy to configure different endpoints per environment.
+## 🚀 Inicio Rápido
 
-```bash
-# example .env file in your project root
-QUANTUMCORE_API_URL=http://localhost:3310/api/v1
+### Inicialización del Cliente
+Obtén tu **API Key** desde el panel de administración de QuantumCore en la sección "Proyectos".
+
+```typescript
+import { QuantumCore } from '@arisnetxsolutions/quantum-core-sdk';
+
+const qc = new QuantumCore({
+  baseUrl: 'https://tu-api.com/api/v1',
+  apiKey: 'tu_api_key_de_proyecto'
+});
+```
+
+---
+
+## 📖 Módulos de Contenido (Público)
+
+### 📰 Blog & Posts
+Obtén tus artículos con soporte para paginación y SEO completo.
+
+```typescript
+// Listar todos los posts
+const { data, pagination } = await qc.blog.getAll({ page: 1, limit: 12 });
+
+// Obtener detalle por slug (Ideal para rutas dinámicas)
+const post = await qc.blog.getBySlug('el-futuro-del-desarrollo-web');
+
+// Obtener por ID
+const postById = await qc.blog.getById(42);
+```
+
+### 🛠️ Servicios
+Gestiona tu catálogo de servicios, planes de precios y FAQs.
+
+```typescript
+// Listar servicios
+const { services } = await qc.services.getAll();
+
+// Obtener detalle completo
+const service = await qc.services.getBySlug('desarrollo-personalizado');
 ```
 
+### 🖼️ Galería de Imágenes
+Acceso directo a tus activos visuales organizados por categorías.
+
 ```typescript
-import { QuantumCore } from '@quantum-core/sdk';
+// Obtener imágenes de una categoría específica
+const images = await qc.gallery.getAll({ category: 'Proyectos 2024' });
 
-// explicit URL
-const cms = new QuantumCore({
-  apiKey: 'your_api_key_here',
-  baseUrl: 'https://api.quantum.core.arisnetxsolutions.com/api/v1'
+// Obtener URL absoluta de una imagen del CMS
+const imagePath = images[0].url;
+const fullUrl = qc.getImageUrl(imagePath);
+```
+
+---
+
+## 🔒 Gestión Administrativa (Auth)
+
+El SDK permite realizar operaciones que requieren autenticación de administrador (JWT).
+
+```typescript
+// 1. Iniciar sesión para obtener el token
+const { token, user } = await qc.admin.login({
+  email: 'admin@empresa.com',
+  password: 'tu_password_seguro'
 });
 
-// or rely on .env / process.env
-const cms2 = new QuantumCore({
-  apiKey: 'your_api_key_here'
+// El SDK guarda el token automáticamente para futuras peticiones Admin
+
+// 2. Crear un nuevo post desde el SDK
+const newPost = await qc.admin.posts.create({
+  title: 'Anuncio Importante',
+  content: '<p>Contenido detallado...</p>',
+  status: 'Published'
 });
 
-const posts = await cms2.blog.getAll();
-const images = await cms2.gallery.getAll();
+// 3. Subir archivos
+const formData = new FormData();
+formData.append('image', file);
+const uploadedImage = await qc.admin.images.upload(formData);
+
+// 4. Obtener estadísticas globales
+const stats = await qc.admin.getStats();
 ```
 
-## Features
-- **Full Type Safety**: All responses are fully typed.
-- **Axios-based**: Reliable and customizable HTTP client.
-- **Simplified API**: Simple methods for blog and gallery content.
-
-## Publishing to npm
-1. Ensure the `name` field in `packages/sdk/package.json` reflects the
-   package you intend to publish (currently `quantum-core-sdk`).
-   Since this is now an **unscoped** package there is no need to create an npm
-   organization or worry about scope permissions; simply pick a name that isn’t
-   already taken on the registry. If you ever switch back to a scoped name, the
-   rules earlier in this document about creating the scope and having publish
-   rights apply.
-   `quantum-core-sdk` instead.
-2. Update the version (semantic versioning) and commit the change.
-3. Run `npm run build` to regenerate `dist/`.
-4. Authenticate using an OTP or a token with 2FA bypass:
-   ```bash
-   # interactive
-   npm login
-   # you will be prompted for a 2FA code
+---
 
-   # or with an environment token
-   export NPM_TOKEN="<your-token>"
-   npm publish --access public
+## 🛠️ API Reference
+
+### Clase `QuantumCore`
+| Método | Descripción |
+| :--- | :--- |
+| `blog` | Acceso a posts y artículos. |
+| `services` | Acceso a catálogo de servicios. |
+| `gallery` | Acceso a imágenes y media. |
+| `admin` | Operaciones CRUD y configuración (Requiere Auth). |
+| `getImageUrl(path)` | Convierte un path relativo en una URL absoluta funcional. |
+
+---
+
+## 🏗️ Desarrollo & Publicación
+
+Para contribuidores o actualizaciones del SDK:
+
+1. Modifica el código en `src/`.
+2. Compila el proyecto:
+   ```bash
+   npm run build
    ```
-   (on Windows set the variable with `setx` or choose the command-line flag
-   `--//registry.npmjs.org/:_authToken=$NPM_TOKEN`).
-5. Publish:
+3. Publica en el registro de NPM:
    ```bash
-   cd packages/sdk
    npm publish --access public
    ```
 
-   If you still see a 404, it means the scope doesn’t exist or you lack
-   permissions; 403 indicates a 2FA issue.  
-   The `publish` script in `package.json` currently embeds a token – be
-   cautious about committing that to source control.
+---
 
-6. After publishing, update installation instructions above with the
-   real package name and bump the version for future releases.
+## 🛡️ Soporte
+Creado con ❤️ por el equipo de **ArisnetX Solutions**. 
+Si encuentras un bug o tienes una sugerencia, contacta con soporte técnico.

package/dist/index.d.ts

@@ -1,26 +1,94 @@
-import { Post, Image, SDKConfig } from './types';
+import { BlogDetailResponse, BlogListResponse, Image, Post, SDKConfig, ServiceListResponse, ServiceDetail, Project, User, Service } from './types';
 export declare class QuantumCore {
     private api;
     constructor(config: SDKConfig);
+    getImageUrl(path: string | null | undefined): string;
     blog: {
-        getAll: () => Promise<Post[]>;
-        getById: (id: number) => Promise<Post>;
+        getAll: (params?: {
+            page?: number;
+            limit?: number;
+        }) => Promise<BlogListResponse>;
+        getBySlug: (slug: string) => Promise<BlogDetailResponse>;
+        getById: (id: number) => Promise<BlogDetailResponse>;
     };
     gallery: {
-        getAll: () => Promise<Image[]>;
+        getAll: (params?: {
+            category?: string;
+            isVisible?: boolean;
+        }) => Promise<Image[]>;
+        getById: (id: number) => Promise<Image>;
+    };
+    services: {
+        getAll: (params?: {
+            page?: number;
+            limit?: number;
+        }) => Promise<ServiceListResponse>;
+        getBySlug: (slug: string) => Promise<ServiceDetail>;
     };
     admin: {
         posts: {
             getAll: () => Promise<Post[]>;
+            getById: (id: number | string) => Promise<Post>;
             create: (data: Partial<Post>) => Promise<Post>;
-            delete: (id: number) => Promise<any>;
+            update: (id: number | string, data: Partial<Post>) => Promise<Post>;
+            delete: (id: number | string) => Promise<any>;
+            publish: (id: number | string) => Promise<any>;
+            unpublish: (id: number | string) => Promise<any>;
+            duplicate: (id: number | string) => Promise<any>;
+            bulkDelete: (ids: (number | string)[]) => Promise<any>;
+        };
+        services: {
+            getAll: () => Promise<Service[]>;
+            getById: (id: number | string) => Promise<Service>;
+            create: (data: Partial<Service>) => Promise<Service>;
+            update: (id: number | string, data: Partial<Service>) => Promise<Service>;
+            delete: (id: number | string) => Promise<any>;
+            duplicate: (id: number | string) => Promise<any>;
+            bulkDelete: (ids: (number | string)[]) => Promise<any>;
         };
         images: {
             getAll: () => Promise<Image[]>;
+            getById: (id: number | string) => Promise<Image>;
             upload: (formData: FormData) => Promise<Image>;
-            delete: (id: number) => Promise<any>;
+            bulkUpload: (formData: FormData) => Promise<Image[]>;
+            update: (id: number | string, formData: FormData) => Promise<Image>;
+            delete: (id: number | string) => Promise<any>;
+            bulkDelete: (ids: (number | string)[]) => Promise<any>;
+            updateVisibility: (ids: (number | string)[], isVisible: boolean) => Promise<any>;
+            updateCategory: (ids: (number | string)[], category: string) => Promise<any>;
+        };
+        projects: {
+            getAll: () => Promise<Project[]>;
+            getById: (id: number | string) => Promise<Project>;
+            create: (data: Partial<Project>) => Promise<Project>;
+            update: (id: number | string, data: Partial<Project>) => Promise<Project>;
+            delete: (id: number | string) => Promise<any>;
+            regenerateKey: (id: number | string) => Promise<any>;
+        };
+        users: {
+            getAll: () => Promise<User[]>;
+            getById: (id: number | string) => Promise<User>;
+            create: (data: any) => Promise<User>;
+            update: (id: number | string, data: any) => Promise<User>;
+            delete: (id: number | string) => Promise<any>;
+            updatePermissions: (id: number | string, data: any) => Promise<any>;
+        };
+        settings: {
+            get: () => Promise<any>;
+            update: (data: any) => Promise<any>;
         };
         getStats: () => Promise<any>;
+        login: (credentials: {
+            email: string;
+            password: string;
+        }) => Promise<{
+            token: string;
+            user: User;
+        }>;
+        setToken: (token: string) => void;
+        getMe: () => Promise<User>;
+        backup: () => Promise<any>;
+        restore: (formData: FormData) => Promise<any>;
     };
 }
 export * from './types';

package/dist/index.js

@@ -1,12 +1,13 @@
 import axios from 'axios';
-import dotenv from 'dotenv';
-// load variables from .env in development or when running locally
-dotenv.config();
 export class QuantumCore {
     constructor(config) {
         this.blog = {
-            getAll: async () => {
-                const response = await this.api.get('/content/posts');
+            getAll: async (params) => {
+                const response = await this.api.get('/content/posts', { params });
+                return response.data;
+            },
+            getBySlug: async (slug) => {
+                const response = await this.api.get(`/content/posts/${encodeURIComponent(slug)}`);
                 return response.data;
             },
             getById: async (id) => {
@@ -15,29 +16,92 @@ export class QuantumCore {
             }
         };
         this.gallery = {
-            getAll: async () => {
-                const response = await this.api.get('/content/images');
+            getAll: async (params) => {
+                const response = await this.api.get('/content/images', { params });
+                return response.data;
+            },
+            getById: async (id) => {
+                const response = await this.api.get(`/content/images/${id}`);
+                return response.data;
+            }
+        };
+        this.services = {
+            getAll: async (params) => {
+                const response = await this.api.get('/content/services', { params });
+                return response.data;
+            },
+            getBySlug: async (slug) => {
+                const response = await this.api.get(`/content/services/${encodeURIComponent(slug)}`);
                 return response.data;
             }
         };
-        // Admin Management Methods
+        // Métodos de administración
         this.admin = {
             posts: {
                 getAll: async () => (await this.api.get('/admin/posts')).data,
+                getById: async (id) => (await this.api.get(`/admin/posts/${id}`)).data,
                 create: async (data) => (await this.api.post('/admin/posts', data)).data,
+                update: async (id, data) => (await this.api.put(`/admin/posts/${id}`, data)).data,
                 delete: async (id) => (await this.api.delete(`/admin/posts/${id}`)).data,
+                publish: async (id) => (await this.api.patch(`/admin/posts/${id}/publish`)).data,
+                unpublish: async (id) => (await this.api.patch(`/admin/posts/${id}/unpublish`)).data,
+                duplicate: async (id) => (await this.api.post(`/admin/posts/${id}/duplicate`)).data,
+                bulkDelete: async (ids) => (await this.api.post('/admin/posts/bulk-delete', { ids })).data,
+            },
+            services: {
+                getAll: async () => (await this.api.get('/admin/services')).data,
+                getById: async (id) => (await this.api.get(`/admin/services/${id}`)).data,
+                create: async (data) => (await this.api.post('/admin/services', data)).data,
+                update: async (id, data) => (await this.api.put(`/admin/services/${id}`, data)).data,
+                delete: async (id) => (await this.api.delete(`/admin/services/${id}`)).data,
+                duplicate: async (id) => (await this.api.post(`/admin/services/${id}/duplicate`)).data,
+                bulkDelete: async (ids) => (await this.api.post('/admin/services/bulk-delete', { ids })).data,
             },
             images: {
                 getAll: async () => (await this.api.get('/admin/images')).data,
+                getById: async (id) => (await this.api.get(`/admin/images/${id}`)).data,
                 upload: async (formData) => (await this.api.post('/admin/images', formData)).data,
+                bulkUpload: async (formData) => (await this.api.post('/admin/images/bulk-upload', formData)).data,
+                update: async (id, formData) => (await this.api.put(`/admin/images/${id}`, formData)).data,
                 delete: async (id) => (await this.api.delete(`/admin/images/${id}`)).data,
+                bulkDelete: async (ids) => (await this.api.post('/admin/images/bulk-delete', { ids })).data,
+                updateVisibility: async (ids, isVisible) => (await this.api.patch('/admin/images/bulk-visibility', { ids, isVisible })).data,
+                updateCategory: async (ids, category) => (await this.api.patch('/admin/images/bulk-category', { ids, category })).data,
+            },
+            projects: {
+                getAll: async () => (await this.api.get('/admin/projects')).data,
+                getById: async (id) => (await this.api.get(`/admin/projects/${id}`)).data,
+                create: async (data) => (await this.api.post('/admin/projects', data)).data,
+                update: async (id, data) => (await this.api.put(`/admin/projects/${id}`, data)).data,
+                delete: async (id) => (await this.api.delete(`/admin/projects/${id}`)).data,
+                regenerateKey: async (id) => (await this.api.post(`/admin/projects/${id}/regenerate-key`)).data,
+            },
+            users: {
+                getAll: async () => (await this.api.get('/admin/users')).data,
+                getById: async (id) => (await this.api.get(`/admin/users/${id}`)).data,
+                create: async (data) => (await this.api.post('/admin/users', data)).data,
+                update: async (id, data) => (await this.api.put(`/admin/users/${id}`, data)).data,
+                delete: async (id) => (await this.api.delete(`/admin/users/${id}`)).data,
+                updatePermissions: async (id, data) => (await this.api.patch(`/admin/users/${id}/permissions`, data)).data,
+            },
+            settings: {
+                get: async () => (await this.api.get('/admin/settings')).data,
+                update: async (data) => (await this.api.put('/admin/settings', data)).data,
             },
             getStats: async () => (await this.api.get('/admin/stats')).data,
+            login: async (credentials) => {
+                const response = await this.api.post('/admin/login', credentials);
+                this.api.defaults.headers.common['Authorization'] = `Bearer ${response.data.token}`;
+                return response.data;
+            },
+            setToken: (token) => {
+                this.api.defaults.headers.common['Authorization'] = `Bearer ${token}`;
+            },
+            getMe: async () => (await this.api.get('/admin/me')).data,
+            backup: async () => (await this.api.post('/admin/backup')).data,
+            restore: async (formData) => (await this.api.post('/admin/restore', formData)).data,
         };
-        // allow overriding via config, otherwise use env var, with fallback
-        const baseURL = config.baseUrl ||
-            process.env.QUANTUMCORE_API_URL ||
-            'http://localhost:3000/api/v1';
+        const baseURL = config.baseUrl || 'http://localhost:3310/api/v1';
         this.api = axios.create({
             baseURL,
             headers: {
@@ -45,5 +109,15 @@ export class QuantumCore {
             }
         });
     }
+    getImageUrl(path) {
+        if (!path)
+            return '';
+        if (path.startsWith('http'))
+            return path;
+        const baseURL = this.api.defaults.baseURL || 'http://localhost:3310/api/v1';
+        const base = baseURL.split('/api/v1')[0];
+        const normalizedPath = path.startsWith('/') ? path : `/${path}`;
+        return `${base}${normalizedPath}`;
+    }
 }
 export * from './types';

package/dist/types.d.ts

@@ -8,10 +8,96 @@ export interface Post {
     createdAt: string;
     updatedAt: string;
 }
+export interface BlogCategory {
+    id: string;
+    name: string;
+}
+export interface BlogAuthor {
+    id: string;
+    name: string;
+    avatar?: string | null;
+    bio?: string | null;
+    social?: {
+        twitter?: string | null;
+        linkedin?: string | null;
+    };
+}
+export interface BlogListItem {
+    id: string;
+    title: string;
+    slug: string;
+    excerpt: string;
+    coverImage: string | null;
+    category: BlogCategory | null;
+    author: Pick<BlogAuthor, 'id' | 'name' | 'avatar'> | null;
+    publishedAt: string;
+    readingTime: number;
+    tags: string[];
+}
+export interface BlogListResponse {
+    data: BlogListItem[];
+    pagination: {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+    };
+}
+export interface BlogDetail {
+    id: string;
+    title: string;
+    slug: string;
+    content: string;
+    coverImage: string | null;
+    gallery: string[];
+    category: BlogCategory | null;
+    author: BlogAuthor | null;
+    tags: string[];
+    seo: {
+        title: string | null;
+        description: string | null;
+        keywords: string[];
+    };
+    readingTime: number;
+    views: number;
+    publishedAt: string;
+    updatedAt: string;
+}
+export interface BlogDetailResponse {
+    data: BlogDetail;
+}
 export interface Image {
     id: number;
     url: string;
     label?: string;
+    alt?: string | null;
+    sizes?: {
+        thumbnail: {
+            url: string | null;
+            width: number | null;
+            height: number | null;
+        };
+        small: {
+            url: string | null;
+            width: number | null;
+            height: number | null;
+        };
+        medium: {
+            url: string | null;
+            width: number | null;
+            height: number | null;
+        };
+        large: {
+            url: string | null;
+            width: number | null;
+            height: number | null;
+        };
+        original: {
+            url: string | null;
+            width: number | null;
+            height: number | null;
+        };
+    } | null;
     metaTitle?: string;
     metaDesc?: string;
     projectId: number;
@@ -22,3 +108,142 @@ export interface SDKConfig {
     apiKey: string;
     baseUrl?: string;
 }
+export interface ServiceCategory {
+    id: string;
+    name: string;
+}
+export interface ServicePricingPlan {
+    name: string;
+    price: number;
+    features: string[];
+}
+export interface ServicePricing {
+    startingPrice?: number;
+    currency: string;
+    pricingModel: 'fixed' | 'hourly' | 'custom';
+    plans?: ServicePricingPlan[];
+}
+export interface ServiceImages {
+    cover?: string | null;
+    gallery: string[];
+}
+export interface ServiceDuration {
+    estimated?: string;
+}
+export interface ServiceFAQ {
+    question: string;
+    answer: string;
+}
+export interface ServiceTestimonial {
+    name: string;
+    company?: string;
+    rating: number;
+    comment: string;
+}
+export interface ServiceCTA {
+    label: string;
+    url: string;
+}
+export interface ServiceSEO {
+    title?: string;
+    description?: string;
+    keywords: string[];
+}
+export interface ServiceListItem {
+    id: string;
+    slug: string;
+    name: string;
+    shortDescription: string;
+    icon?: string | null;
+    coverImage?: string | null;
+    priceFrom?: number;
+    currency: string;
+    category?: string;
+    tags: string[];
+    featured: boolean;
+    rating: number;
+    reviews: number;
+    cta: ServiceCTA;
+}
+export interface ServiceListResponse {
+    services: ServiceListItem[];
+    pagination: {
+        total: number;
+        page: number;
+        limit: number;
+        totalPages: number;
+    };
+}
+export interface ServiceDetail {
+    id: string;
+    slug: string;
+    name: string;
+    shortDescription: string;
+    description?: string;
+    category?: ServiceCategory | null;
+    images: ServiceImages;
+    icon?: string | null;
+    features: string[];
+    technologies: string[];
+    pricing: ServicePricing;
+    duration: ServiceDuration;
+    faq: ServiceFAQ[];
+    testimonials: ServiceTestimonial[];
+    cta: ServiceCTA;
+    seo: ServiceSEO;
+    status: 'active' | 'inactive' | 'draft';
+    featured: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface Project {
+    id: number;
+    name: string;
+    description: string | null;
+    apiKey: string;
+    url: string | null;
+    status: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface User {
+    id: number;
+    email: string;
+    name: string;
+    role: 'owner' | 'admin' | 'editor';
+    permissions: any;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface Service {
+    id: number;
+    name: string;
+    slug: string;
+    shortDescription: string;
+    description: string | null;
+    categoryId: string | null;
+    categoryName: string | null;
+    icon: string | null;
+    coverImage: string | null;
+    gallery: string[];
+    features: string[];
+    technologies: string[];
+    priceFrom: number | null;
+    currency: string;
+    pricingModel: string;
+    pricingPlans: any[];
+    estimatedDuration: string | null;
+    faq: any[];
+    testimonials: any[];
+    ctaLabel: string;
+    ctaUrl: string;
+    seoTitle: string | null;
+    seoDescription: string | null;
+    seoKeywords: string[];
+    status: string;
+    featured: boolean;
+    tags: string[];
+    projectId: number;
+    createdAt: string;
+    updatedAt: string;
+}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@arisnetxsolutions/quantum-core-sdk",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "npx tsc",
-    "publish": "npm publish --access public --//registry.npmjs.org/:_authToken=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" 
+    "publish": "npm publish --access public --//registry.npmjs.org/:_authToken=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"
   },
   "keywords": [],
   "author": "",
@@ -14,7 +14,6 @@
   "type": "module",
   "dependencies": {
     "axios": "^1.13.6",
-    "dotenv": "^16.0.0",
     "typescript": "^5.9.3"
   },
   "devDependencies": {