@arisnetxsolutions/quantum-core-sdk 1.0.0

package/README.md

@@ -0,0 +1,100 @@
+# QuantumCore SDK 📦
+
+Type-safe TypeScript library for consuming content from your QuantumCore Headless CMS.
+
+## Installation
+```bash
+npm install @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.
+
+```bash
+# example .env file in your project root
+QUANTUMCORE_API_URL=http://localhost:3310/api/v1
+```
+
+```typescript
+import { QuantumCore } from '@quantum-core/sdk';
+
+// explicit URL
+const cms = new QuantumCore({
+  apiKey: 'your_api_key_here',
+  baseUrl: 'https://api.quantum.core.arisnetxsolutions.com/api/v1'
+});
+
+// or rely on .env / process.env
+const cms2 = new QuantumCore({
+  apiKey: 'your_api_key_here'
+});
+
+const posts = await cms2.blog.getAll();
+const images = await cms2.gallery.getAll();
+```
+
+## 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
+When you're ready to release a new version of the SDK, follow these steps:
+
+1. **Update the version** in `packages/sdk/package.json` (use semantic versioning).
+   make sure the `name` field is set to `@quantum-core/sdk` so you publish to the
+   scoped namespace rather than the global `sdk` package. Note that the scope
+   must exist: either create an **organization** called `quantum-core` on
+   <https://www.npmjs.com/org> or use `npm org create quantum-core` (if you have a
+   paid account). You will also need to be a member of that org. If the scope does
+   not exist the publish attempt will return a 404 with "Scope not found".
+   Alternatively, if you don't want a scope you can choose an unscoped name like
+   `@quantumcoresdk` or simply `quantum-core-sdk`.
+2. Run `npm run build` from `packages/sdk` to ensure `dist/` is up to date.
+3. Log in to npm if you haven't already:
+   ```bash
+   cd packages/sdk
+   npm login
+   ```
+4. Publish the package:
+   ```bash
+   npm publish --access public
+   ```
+   The `--access public` flag is still required for scoped packages. If your npm
+   account has two‑factor authentication enabled you'll encounter a 403 unless you
+   either:
+   
+   * run `npm login` and enter the one‑time 2FA code when prompted (interactive). You
+     can also supply the OTP during publish with `npm publish --otp=<code>`.
+   * or, for automation or CI, create a **publish token** with `automation=publish`
+     and `bypass 2fa` from your npm account settings and export it as `NPM_TOKEN`.
+     For example:
+     ```bash
+     export NPM_TOKEN="<your-token>"
+     npm publish --access public
+     ```
+     (on Windows `setx NPM_TOKEN "<your-token>"` or use the appropriate method).
+
+   The error message in your last attempt:
+
+   > npm error 403 Forbidden - Two-factor authentication or granular access token
+   > with bypass 2fa enabled is required to publish packages.
+   
+   indicates the credentials used by the CLI did not have bypass permission; the
+   login command you ran (`npm login automation=publish, bypass 2fa`) does not
+   actually attach a token to subsequent requests, which is why the publish still
+   failed. Use a real token or interactive login/OTP approach instead.
+
+   Also be sure you don't accidentally publish your local `.env` file – the
+   included `.npmignore` now explicitly lists `.env` to prevent that.
+
+> The package name (`@quantum-core/sdk`) is scoped, so `--access public` is required
+> for public registries. You can also run `npm version patch|minor|major` to bump the
+> version and automatically create a git tag before publishing.
+>
+> Make sure you have access to the `@quantum-core` scope on npm (ask the org owner to
+> add you if necessary). If 2FA is enabled, either publish with a token that allows
+> bypassing 2FA or use `npm login` + one‑time code.
+>
+>Your changes should be committed and tagged in Git before publishing.

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+import { Post, Image, SDKConfig } from './types';
+export declare class QuantumCore {
+    private api;
+    constructor(config: SDKConfig);
+    blog: {
+        getAll: () => Promise<Post[]>;
+        getById: (id: number) => Promise<Post>;
+    };
+    gallery: {
+        getAll: () => Promise<Image[]>;
+    };
+    admin: {
+        posts: {
+            getAll: () => Promise<Post[]>;
+            create: (data: Partial<Post>) => Promise<Post>;
+            delete: (id: number) => Promise<any>;
+        };
+        images: {
+            getAll: () => Promise<Image[]>;
+            upload: (formData: FormData) => Promise<Image>;
+            delete: (id: number) => Promise<any>;
+        };
+        getStats: () => Promise<any>;
+    };
+}
+export * from './types';

package/dist/index.js

@@ -0,0 +1,49 @@
+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');
+                return response.data;
+            },
+            getById: async (id) => {
+                const response = await this.api.get(`/content/posts/${id}`);
+                return response.data;
+            }
+        };
+        this.gallery = {
+            getAll: async () => {
+                const response = await this.api.get('/content/images');
+                return response.data;
+            }
+        };
+        // Admin Management Methods
+        this.admin = {
+            posts: {
+                getAll: async () => (await this.api.get('/admin/posts')).data,
+                create: async (data) => (await this.api.post('/admin/posts', data)).data,
+                delete: async (id) => (await this.api.delete(`/admin/posts/${id}`)).data,
+            },
+            images: {
+                getAll: async () => (await this.api.get('/admin/images')).data,
+                upload: async (formData) => (await this.api.post('/admin/images', formData)).data,
+                delete: async (id) => (await this.api.delete(`/admin/images/${id}`)).data,
+            },
+            getStats: async () => (await this.api.get('/admin/stats')).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';
+        this.api = axios.create({
+            baseURL,
+            headers: {
+                'X-API-KEY': config.apiKey
+            }
+        });
+    }
+}
+export * from './types';

package/dist/types.d.ts

@@ -0,0 +1,24 @@
+export interface Post {
+    id: number;
+    title: string;
+    content: string;
+    metaTitle?: string;
+    metaDesc?: string;
+    projectId: number;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface Image {
+    id: number;
+    url: string;
+    label?: string;
+    metaTitle?: string;
+    metaDesc?: string;
+    projectId: number;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface SDKConfig {
+    apiKey: string;
+    baseUrl?: string;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@arisnetxsolutions/quantum-core-sdk",
+  "version": "1.0.0",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "npx tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "module",
+  "dependencies": {
+    "axios": "^1.13.6",
+    "dotenv": "^16.0.0",
+    "typescript": "^5.9.3"
+  },
+  "devDependencies": {
+    "@types/node": "^25.4.0"
+  }
+}