@plasius/ai 1.0.3

package/docs/architecture.md

@@ -0,0 +1,21 @@
+# Architecture
+
+`@plasius/ai` is structured as a contracts-first package:
+
+- **Capability model**: `AICapability` describes the logical feature set.
+- **Platform contract**: `AIPlatform` defines the async operations required by a runtime adapter.
+- **Completion contracts**: typed completion outputs normalize chat/text/image/speech/video/balance results.
+- **Schema layer**: schema definitions ensure consistent metadata and persistence shape across runtimes.
+
+## Design Intention
+
+This package is not tied to a single provider runtime. Host applications should:
+
+1. Implement or wrap an `AIPlatform` adapter.
+2. Keep provider credentials and network execution outside this package boundary.
+3. Emit normalized completion objects based on the exported contract types.
+
+## Current Boundaries
+
+- Public API: contracts and schemas from `src/platform/index.ts`.
+- Internal/provisional: files under `src/lib` and in-progress provider runtime glue.

package/docs/providers.md

@@ -0,0 +1,26 @@
+# Provider Guidance
+
+This package defines provider contracts but does not require consumers to use a
+specific provider implementation.
+
+## Recommended Integration Pattern
+
+1. Build provider adapters in your host app or a dedicated integration package.
+2. Implement `AIPlatform` for each provider.
+3. Keep provider secrets in runtime environment variables, not in UI bundles.
+4. Normalize results into exported completion models.
+
+## Adapter Checklist
+
+- Map provider-specific response IDs to `Completion.id`.
+- Populate `durationMs` from measured execution time.
+- Set `partitionKey` to your stable user/session key.
+- Attach provider usage/cost metadata to `usage`.
+- Return strongly typed completion variants for each capability.
+
+## Stability Notes
+
+- `src/platform/openai.ts` and `src/platform/pixelverse.ts` are implementation
+  work areas and should be treated as provisional until explicit public export
+  and API freeze.
+- Prefer composition from host apps until adapter APIs are finalized.

package/legal/CLA-REGISTRY.csv

@@ -0,0 +1 @@
+type,github_handle,full_name,company,email,date,approver

package/legal/CLA.md

@@ -0,0 +1,22 @@
+# Contributor License Agreements (CLA)
+
+To protect the intellectual property of this project and ensure clarity of rights, all contributors must sign a Contributor License Agreement (CLA) before their first contribution.
+
+## Which CLA should I sign?
+
+- **Individual CLA**: If you are contributing personally and not on behalf of an employer, sign the [Individual CLA](INDIVIDUAL_CLA.md).
+- **Corporate CLA**: If you are contributing as part of your work for a company, the company should sign the [Corporate CLA](CORPORATE_CLA.md).
+
+## How to sign
+
+1. Download the appropriate CLA file (Individual or Corporate).
+2. Fill in the required details, sign, and date it.
+3. Email a PDF copy of the signed document to **[contributors@plasius.co.uk](mailto:contributors@plasius.co.uk)** with subject: `CLA – Individual` or `CLA – Corporate`.
+
+## Registry
+
+All signed CLAs are logged internally in the CLA registry (`CLA-REGISTRY.csv`).
+
+## Questions?
+
+If you have any questions about which CLA to sign or how the process works, please email **[contributors@plasius.co.uk](mailto:contributors@plasius.co.uk)**.

package/legal/CORPORATE_CLA.md

@@ -0,0 +1,57 @@
+# Corporate Contributor License Agreement (CLA)
+
+## Purpose
+
+This Corporate Contributor License Agreement ("Agreement") is intended to protect the intellectual property rights of the contributors and the project, ensure clear licensing terms for contributions, and maintain trust within the community. By signing this Agreement, the corporation agrees to the terms that facilitate the use, distribution, and modification of contributions under the project's licensing framework.
+
+## Agreement
+
+1. **Representation of Authority**  
+   The undersigned individual represents and warrants that they have the full legal authority to enter into this Agreement on behalf of the corporation named below ("Corporation") and to grant the rights contained herein.
+
+2. **Grant of Copyright License**  
+   The Corporation hereby grants to the project maintainers and users a perpetual, worldwide, non-exclusive, royalty-free, irrevocable copyright license to use, reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute the contributions submitted to the project.
+
+3. **Grant of Patent License**  
+   The Corporation hereby grants to the project maintainers and users a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under any patent claims that are necessarily infringed by the contributions to make, use, sell, offer for sale, import, and otherwise dispose of the contributions or derivative works thereof.
+
+4. **Warranties and Representations**  
+   The Corporation represents and warrants that:
+
+- The contributions are the original work of the Corporation or that the Corporation has sufficient rights to grant the licenses herein.
+- The submission of the contributions does not violate any agreements or rights of third parties.
+
+5. **No Revocation**  
+   This license is granted on a perpetual basis and cannot be revoked, provided that the terms of this Agreement are met.
+
+6. **Governing Law**
+   This Agreement shall be governed by and construed in accordance with the laws of the United Kingdom, without regard to its conflict of laws principles.
+
+7. **Execution**
+
+This Agreement is effective upon signature by the authorized representative of the Corporation. Please sign and date this document, then email a scanned PDF copy to [contributors@plasius.co.uk](mailto:contributors@plasius.co.uk).
+
+---
+
+### **@plasius/api**
+
+**Corporation Legal Name:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**Authorized Representative:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**Title:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**Email:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**Date:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**Signature:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+---
+
+## How to Sign
+
+- Download this file as a template.
+- Fill in the Corporation’s legal name, authorized representative, title, email, date, and provide a signature.
+- Sign and date the document.
+- Send a scanned copy of the signed Agreement to [contributors@plasius.co.uk](mailto:contributors@plasius.co.uk).

package/legal/INDIVIDUAL_CLA.md

@@ -0,0 +1,91 @@
+# Individual Contributor License Agreement (CLA)
+
+**Project:** @plasius/api (Plasius LTD)  
+**Version:** 1.0 — 2025‑09‑12  
+**Contact:** [contributors@plasius.co.uk](mailto:contributors@plasius.co.uk)
+
+---
+
+## 1. Definitions
+
+- **"You"** (or **"Contributor"**) means the individual signing this CLA and submitting Contributions to the Project.
+- **"Contribution"** means any original work of authorship, including code, documentation, data, designs, or feedback that You submit to the Project in any form (e.g., pull request, issue comment, email, file upload).
+- **"Project"** means the @plasius/api repositories and related materials owned or managed by **Plasius LTD**.
+
+## 2. Copyright License Grant
+
+You hereby grant to Plasius LTD a **perpetual, worldwide, non‑exclusive, transferable, sublicensable, royalty‑free, irrevocable** copyright license to:
+
+- use, reproduce, publicly display, publicly perform, modify, create derivative works of, and
+- distribute Contributions in source and object form,
+- and to **sublicense** these rights under any terms Plasius LTD chooses, including proprietary or open‑source licenses.
+
+## 3. Patent License Grant
+
+You hereby grant to Plasius LTD and its sublicensees a **perpetual, worldwide, non‑exclusive, transferable, royalty‑free, irrevocable** patent license to **make, have made, use, offer to sell, sell, import, and otherwise transfer** the Contribution and derivative works thereof, where such license applies only to patent claims that You **own or control** and that would be infringed by Your Contribution or its combination with the Project.
+
+## 4. Moral Rights & Attribution
+
+To the maximum extent permitted by applicable law, You **waive** and agree not to assert any moral rights (e.g., rights of attribution or integrity) in or to the Contribution against Plasius LTD. Plasius LTD may, but is not required to, credit You.
+
+## 5. Representations & Warranties
+
+You represent that:
+
+1. **Originality / Rights:** Each Contribution is Your original creation, or You have sufficient rights to submit it and grant the licenses above.
+2. **No Confidential Info:** Contributions **do not** include confidential information or trade secrets of any third party.
+3. **No Infringement:** To the best of Your knowledge, Contributions do not infringe any third‑party IP rights.
+4. **Employment / Contractor Status:** If Your employer or a third party might claim rights in Your Contribution, You have obtained **written permission** to make the Contribution and grant these licenses (attach or reference below), or Your Contribution is made **outside the scope** of your employment and without using your employer’s confidential information or resources.
+5. **Compliance:** You will follow the Project’s policies (e.g., Code of Conduct, Security Policy) and applicable laws.
+
+## 6. Third‑Party Code
+
+If Your Contribution includes code, data, or other material from a third party, You will **identify the material and its license** in the pull request or submission, and ensure it is **compatible** with the Project’s licensing model. You will not submit material subject to terms that require the Project to disclose proprietary source code (e.g., certain copyleft obligations) unless the Project has **pre‑approved** such inclusion in writing.
+
+## 7. Scope & Duration
+
+- This CLA covers **all past and future** Contributions You submit to the Project, unless and until You provide written notice to **revoke** it.
+- Revocation is **not retroactive**: rights granted for prior Contributions remain in effect.
+
+## 8. Disclaimer
+
+THE CONTRIBUTION IS PROVIDED “AS IS” WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON‑INFRINGEMENT.
+
+## 9. Governing Law & Jurisdiction
+
+This CLA is governed by the **laws of England and Wales**, and the courts of England and Wales shall have **exclusive jurisdiction** over any dispute arising out of or relating to it.
+
+## 10. Entire Agreement
+
+This CLA is the entire agreement between You and Plasius LTD regarding Contributions. It supersedes any prior discussions relating to Contributions. If any provision is held unenforceable, the remaining provisions remain in full force.
+
+---
+
+## 11. Contributor Information & Signature
+
+By signing below, You agree to the terms of this CLA for Your Contributions to the Project.
+
+**Full Name:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**Email:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**GitHub Handle:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**Address (optional):** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**Employer (if applicable):** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**If employed:** ☐ I confirm Contributions are made outside the scope of employment **or** ☐ I have attached my employer’s written permission.
+
+**Signature:** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+**Date (YYYY‑MM‑DD):** \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
+
+_Electronic signatures are accepted. You may type your name in the Signature field and email a PDF copy._
+
+**Submission:** Please email the signed CLA to **[contributors@plasius.co.uk](mailto:contributors@plasius.co.uk)** with subject line: `CLA – Individual – <GitHubHandle>`.
+
+**(Optional) Attachments / Notes:**
+
+- Employer permission letter (if required)
+- Third‑party license disclosures (if any)

package/package.json

@@ -0,0 +1,117 @@
+{
+  "name": "@plasius/ai",
+  "version": "1.0.3",
+  "description": "Plasius AI functions providing chatbot, text-to-speech, speech-to-text, and AI-generated images and videos",
+  "keywords": [
+    "chatbot",
+    "text-to-speech",
+    "speech-to-text",
+    "AI-generated images",
+    "AI-generated videos",
+    "Plasius AI"
+  ],
+  "main": "./dist-cjs/index.js",
+  "types": "./dist/index.d.ts",
+  "private": false,
+  "type": "module",
+  "scripts": {
+    "build": "tsc --build && npm run build:cjs",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "test:coverage:watch": "vitest --coverage",
+    "clean": "rimraf dist-cjs dist tsconfig.tsbuildinfo",
+    "reset:clean": "rm -rf node_modules package-lock.json && npm run clean",
+    "audit:ts": "tsc --noEmit --pretty",
+    "audit:eslint": "eslint \"{src,apps,packages}/**/*.{ts,tsx}\" --max-warnings=0 --ext .ts,.tsx",
+    "audit:deps": "depcheck --skip-missing=true",
+    "audit:npm": "npm audit --audit-level=moderate || true",
+    "audit:test": "vitest run --coverage",
+    "audit:all": "npm-run-all -l audit:ts audit:eslint audit:deps audit:npm audit:test",
+    "build:cjs": "tsc -p tsconfig.json --module commonjs --moduleResolution node --outDir dist-cjs --tsBuildInfoFile dist-cjs/tsconfig.tsbuildinfo",
+    "lint": "eslint .",
+    "prepare": "npm run build"
+  },
+  "author": "Plasius LTD <development@plasius.co.uk>",
+  "license": "MIT",
+  "dependencies": {
+    "@plasius/entity-manager": "^1.0.4",
+    "@plasius/error": "^1.0.0",
+    "@plasius/profile": "^1.0.0",
+    "@plasius/schema": "^1.0.0"
+  },
+  "peerDependencies": {
+    "openai": "^5.19.1",
+    "react": "^19.1.0"
+  },
+  "devDependencies": {
+    "@testing-library/react": "^16.3.0",
+    "@types/node": "^24.3.1",
+    "@types/react": "^19.1.8",
+    "@types/uuid": "^10.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.38.0",
+    "@typescript-eslint/parser": "^8.38.0",
+    "@vitest/coverage-v8": "^3.2.4",
+    "ajv": "^6.12.6",
+    "depcheck": "^1.4.7",
+    "eslint": "^9.33.0",
+    "npm-run-all": "^4.1.5",
+    "openai": "^5.19.1",
+    "react": "19.1.0",
+    "react-dom": "19.1.0",
+    "react-router-dom": "^7.6.2",
+    "tsx": "^4.20.3",
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.4",
+    "zod": "^4.1.5"
+  },
+  "sideEffects": [
+    "*.css"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist-cjs/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "module": "./dist/index.js",
+  "files": [
+    "dist",
+    "dist-cjs",
+    "src",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE",
+    "SECURITY.md",
+    "CODE_OF_CONDUCT.md",
+    "CONTRIBUTORS.md",
+    "docs",
+    "legal"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Plasius-LTD/ai.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Plasius-LTD/ai/issues"
+  },
+  "homepage": "https://github.com/Plasius-LTD/ai#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "funding": [
+    {
+      "type": "patreon",
+      "url": "https://www.patreon.com/c/plasiusltd/membership"
+    },
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/Plasius-LTD"
+    }
+  ],
+  "engines": {
+    "node": ">=22.12"
+  }
+}

package/src/components/pixelverse/balance.module.css

@@ -0,0 +1,6 @@
+.balance_container {
+  position: relative;
+  top: 0;
+  right: 0;
+  z-index: 1000;
+}

package/src/components/pixelverse/balance.tsx

@@ -0,0 +1,65 @@
+import { useEffect, useState } from "react";
+import { v4 as uuidv4 } from "uuid";
+import styles from "./balance.module.css";
+
+interface BalanceResponse {
+  account_id: number;
+  credit_monthly: number;
+  credit_package: number;
+}
+
+interface BalanceApiResponse {
+  Resp?: BalanceResponse;
+}
+
+export default function Balance({ apiKey }: { apiKey: string }) {
+  const [balance, setBalance] = useState<BalanceResponse | null>(null);
+
+  const fetchBalance = async (): Promise<void> => {
+    try {
+      const response = await fetch("/pixelapi/openapi/v2/account/balance", {
+        method: "GET",
+        headers: {
+          "API-KEY": apiKey,
+          "AI-trace-ID": uuidv4(),
+          Accept: "application/json",
+          "Content-Type": "application/json",
+        },
+        referrerPolicy: "no-referrer",
+      });
+
+      if (!response.ok) {
+        console.error("Failed to fetch balance:", response.status, response.statusText);
+        return;
+      }
+
+      const data = (await response.json()) as unknown as BalanceApiResponse;
+      if (data?.Resp) {
+        setBalance(data.Resp);
+      }
+    } catch (err) {
+      console.error("fetchBalance() error", err);
+    }
+  };
+
+  useEffect(() => {
+    void fetchBalance(); // initial load
+    const intervalId = setInterval(() => {
+      void fetchBalance();
+    }, 600000);
+    return () => clearInterval(intervalId);
+  }, [apiKey]);
+
+  return (
+    <div className={styles.balance_container}>
+      {balance ? (
+        <div>
+          <p>Monthly Credit: {balance.credit_monthly}</p>
+          <p>Package Credit: {balance.credit_package}</p>
+        </div>
+      ) : (
+        <p>Loading balance...</p>
+      )}
+    </div>
+  );
+}

package/src/components/pixelverse/index.ts

@@ -0,0 +1,2 @@
+export * from "./balance.js";
+export * from "./pixelverseeditor.js";

package/src/components/pixelverse/pixelverseeditor.tsx

@@ -0,0 +1,74 @@
+import React, { useState } from "react";
+import Balance from "./balance.js";
+
+// --- Pixelverse API Calls ---
+
+interface PixelverseEditorProps {
+  apiKey: string;
+  onVideoGenerated?: (videoUrl: string) => void;
+  onImageUpload?: (imageUrl: string) => void;
+  prompt?: string;
+  onPromptChange?: (prompt: string) => void;
+  negative_prompt?: string;
+  onNegativePromptChange?: (negative_prompt: string) => void;
+  template_id?: string;
+  onTemplateIdChange?: (template_id: string) => void;
+  seed?: number;
+  onSeedChange?: (seed: number) => void;
+}
+
+export function PixelverseEditor({
+  apiKey,
+  onVideoGenerated,
+  prompt,
+  negative_prompt,
+  template_id,
+  seed,
+}: PixelverseEditorProps) {
+  const [videoUrl, setVideoUrl] = useState("");
+  const [videoId, setVideoId] = useState<number | null>(null);
+  const [selectedFile, setSelectedFile] = useState<File | null>(null);
+  const [loading, setLoading] = useState(false);
+  const [videoStatus, setVideoStatus] = useState<number>(0);
+
+  const handleFileChange = (e: React.ChangeEvent<HTMLInputElement>) => {
+    if (e.target.files?.[0]) {
+      setSelectedFile(e.target.files[0]);
+      handleUploadProcess();
+    }
+  };
+
+  const handleRegenerate = () => {
+  };
+
+  const handleUploadProcess = async () => {
+    
+  };
+
+  return (
+    <div>
+      <Balance apiKey={apiKey} />
+      {videoStatus === 0 && !selectedFile && (
+        <div>
+          <p>Drag/Drop or Click HERE to upload</p>
+          <input
+            title="Upload Image"
+            type="file"
+            accept=".jpg,.jpeg,.png,.webp"
+            onChange={handleFileChange}
+          />
+        </div>
+      )}
+      {loading && <div>Loading...</div>}
+      {videoStatus === 0 && selectedFile && (
+        <button onClick={handleUploadProcess}>Start Upload</button>
+      )}
+      {videoStatus === 1 && (
+        <div>
+          <video src={videoUrl} controls />
+          <button onClick={handleRegenerate}>Regenerate</button>
+        </div>
+      )}
+    </div>
+  );
+}

package/src/global.d.ts

@@ -0,0 +1,9 @@
+// global.d.ts
+declare module "*.module.css" {
+  const classes: { [key: string]: string };
+  export default classes;
+}
+declare module "*.module.scss" {
+  const classes: { [key: string]: string };
+  export default classes;
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from "./platform/index.js";