@pixerate/schemas 1.0.0

package/README.md

@@ -0,0 +1,66 @@
+# @pixerate/schemas
+
+A public, open-source TypeScript and Zod validation schemas package associated with Pixerate and Slopmachine. It contains unified schemas and validation models to ensure absolute API and schema stability across private and public downstream systems.
+
+## Key Features
+
+- **Standard Validation Schemas**: Validation schemas for all core capabilities including image/video payloads, job queues, fidelity states, etc.
+- **Unified Aspect Ratios**: Declares the comprehensive 10-option `AspectRatio` union (`1:1`, `2:3`, `3:2`, `3:4`, `4:3`, `4:5`, `5:4`, `9:16`, `16:9`, `21:9`) and the video aspect ratios.
+- **Lightweight & Dependency-Free**: Relies only on `zod`. Perfect for browser environments, SDKs, and server-side runtimes alike.
+
+## Structure
+
+```
+src/
+└── index.ts  # Unified exports for all Zod schemas & TypeScript types
+```
+
+## Exported Types & Schemas
+
+### 1. Fidelity
+- **Schema**: `FidelitySchema`
+- **Type**: `Fidelity` (`"outline" | "blocked" | "shaded" | "polished"`)
+
+### 2. Aspect Ratio
+- **Schema**: `AspectRatioSchema`
+- **Type**: `AspectRatio` (10 core orientations supported by current image/video generation models)
+
+### 3. Video Aspect Ratio
+- **Schema**: `VideoAspectRatioSchema`
+- **Type**: `VideoAspectRatio` (`"9:16" | "16:9"`)
+
+### 4. Generation & Transformation Payloads
+- **Image Generation**: `ImageGenerationPayload` (`ImageGenerationSchema`)
+- **Image Transformation**: `ImageTransformationPayload` (`ImageTransformationSchema`)
+- **Video Analysis**: `VideoAnalysisPayload` (`VideoAnalysisSchema`)
+
+---
+
+## Getting Started
+
+### Installation
+
+Install via npm once published to your registry:
+```bash
+npm install @pixerate/schemas
+```
+
+For local development inside monorepos, use standard symlinks or `file:` package.json paths:
+```json
+"dependencies": {
+  "@pixerate/schemas": "file:../pixerate-schemas"
+}
+```
+
+### Build Instructions
+
+Build output compiles to standard ESM target via `tsup`:
+```bash
+# Install dependencies
+npm install
+
+# Build compiled ESM and declaration files
+npm run build
+```
+
+The compiled bundles and types will reside in the `dist/` directory.

package/dist/index.d.ts

@@ -0,0 +1,86 @@
+import { z } from 'zod';
+
+declare const FidelitySchema: z.ZodEnum<["outline", "blocked", "shaded", "polished"]>;
+type Fidelity = z.infer<typeof FidelitySchema>;
+declare const AspectRatioSchema: z.ZodEnum<["1:1", "2:3", "3:2", "3:4", "4:3", "4:5", "5:4", "9:16", "16:9", "21:9"]>;
+type AspectRatio = z.infer<typeof AspectRatioSchema>;
+declare const VideoAspectRatioSchema: z.ZodEnum<["9:16", "16:9"]>;
+type VideoAspectRatio = z.infer<typeof VideoAspectRatioSchema>;
+declare const ImageGenerationSchema: z.ZodObject<{
+    prompt: z.ZodString;
+    aspectRatio: z.ZodOptional<z.ZodEnum<["1:1", "2:3", "3:2", "3:4", "4:3", "4:5", "5:4", "9:16", "16:9", "21:9"]>>;
+    seed: z.ZodOptional<z.ZodNumber>;
+    fidelity: z.ZodOptional<z.ZodEnum<["outline", "blocked", "shaded", "polished"]>>;
+}, "strip", z.ZodTypeAny, {
+    prompt: string;
+    aspectRatio?: "1:1" | "2:3" | "3:2" | "3:4" | "4:3" | "4:5" | "5:4" | "9:16" | "16:9" | "21:9" | undefined;
+    seed?: number | undefined;
+    fidelity?: "outline" | "blocked" | "shaded" | "polished" | undefined;
+}, {
+    prompt: string;
+    aspectRatio?: "1:1" | "2:3" | "3:2" | "3:4" | "4:3" | "4:5" | "5:4" | "9:16" | "16:9" | "21:9" | undefined;
+    seed?: number | undefined;
+    fidelity?: "outline" | "blocked" | "shaded" | "polished" | undefined;
+}>;
+type ImageGenerationPayload = z.infer<typeof ImageGenerationSchema>;
+declare const ImageTransformationSchema: z.ZodObject<{
+    prompt: z.ZodString;
+    changes: z.ZodString;
+    aspectRatio: z.ZodOptional<z.ZodEnum<["1:1", "2:3", "3:2", "3:4", "4:3", "4:5", "5:4", "9:16", "16:9", "21:9"]>>;
+    seed: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    prompt: string;
+    changes: string;
+    aspectRatio?: "1:1" | "2:3" | "3:2" | "3:4" | "4:3" | "4:5" | "5:4" | "9:16" | "16:9" | "21:9" | undefined;
+    seed?: number | undefined;
+}, {
+    prompt: string;
+    changes: string;
+    aspectRatio?: "1:1" | "2:3" | "3:2" | "3:4" | "4:3" | "4:5" | "5:4" | "9:16" | "16:9" | "21:9" | undefined;
+    seed?: number | undefined;
+}>;
+type ImageTransformationPayload = z.infer<typeof ImageTransformationSchema>;
+declare const VideoAnalysisCategorySchema: z.ZodEnum<["Scenes", "Environments", "Things", "Creatures", "People", "Clothes", "Shapes", "Effects", "Uploads"]>;
+type VideoAnalysisCategory = z.infer<typeof VideoAnalysisCategorySchema>;
+declare const VideoAnalysisSchema: z.ZodObject<{
+    title: z.ZodString;
+    prompt: z.ZodString;
+    category: z.ZodEnum<["Scenes", "Environments", "Things", "Creatures", "People", "Clothes", "Shapes", "Effects", "Uploads"]>;
+    fidelity: z.ZodEnum<["outline", "blocked", "shaded", "polished"]>;
+}, "strip", z.ZodTypeAny, {
+    prompt: string;
+    fidelity: "outline" | "blocked" | "shaded" | "polished";
+    title: string;
+    category: "Scenes" | "Environments" | "Things" | "Creatures" | "People" | "Clothes" | "Shapes" | "Effects" | "Uploads";
+}, {
+    prompt: string;
+    fidelity: "outline" | "blocked" | "shaded" | "polished";
+    title: string;
+    category: "Scenes" | "Environments" | "Things" | "Creatures" | "People" | "Clothes" | "Shapes" | "Effects" | "Uploads";
+}>;
+type VideoAnalysisPayload = z.infer<typeof VideoAnalysisSchema>;
+declare const QueueJobSchema: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodEnum<["text", "image", "video", "analysis"]>;
+    status: z.ZodEnum<["queued", "processing", "completed", "failed"]>;
+    payload: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    createdAt: z.ZodOptional<z.ZodAny>;
+    updatedAt: z.ZodOptional<z.ZodAny>;
+}, "strip", z.ZodTypeAny, {
+    type: "text" | "image" | "video" | "analysis";
+    status: "queued" | "processing" | "completed" | "failed";
+    id: string;
+    payload?: Record<string, any> | undefined;
+    createdAt?: any;
+    updatedAt?: any;
+}, {
+    type: "text" | "image" | "video" | "analysis";
+    status: "queued" | "processing" | "completed" | "failed";
+    id: string;
+    payload?: Record<string, any> | undefined;
+    createdAt?: any;
+    updatedAt?: any;
+}>;
+type QueueJob = z.infer<typeof QueueJobSchema>;
+
+export { type AspectRatio, AspectRatioSchema, type Fidelity, FidelitySchema, type ImageGenerationPayload, ImageGenerationSchema, type ImageTransformationPayload, ImageTransformationSchema, type QueueJob, QueueJobSchema, type VideoAnalysisCategory, VideoAnalysisCategorySchema, type VideoAnalysisPayload, VideoAnalysisSchema, type VideoAspectRatio, VideoAspectRatioSchema };

package/dist/index.js

@@ -0,0 +1,63 @@
+// src/index.ts
+import { z } from "zod";
+var FidelitySchema = z.enum(["outline", "blocked", "shaded", "polished"]);
+var AspectRatioSchema = z.enum([
+  "1:1",
+  "2:3",
+  "3:2",
+  "3:4",
+  "4:3",
+  "4:5",
+  "5:4",
+  "9:16",
+  "16:9",
+  "21:9"
+]);
+var VideoAspectRatioSchema = z.enum(["9:16", "16:9"]);
+var ImageGenerationSchema = z.object({
+  prompt: z.string(),
+  aspectRatio: AspectRatioSchema.optional(),
+  seed: z.number().int().optional(),
+  fidelity: FidelitySchema.optional()
+});
+var ImageTransformationSchema = z.object({
+  prompt: z.string(),
+  changes: z.string(),
+  aspectRatio: AspectRatioSchema.optional(),
+  seed: z.number().int().optional()
+});
+var VideoAnalysisCategorySchema = z.enum([
+  "Scenes",
+  "Environments",
+  "Things",
+  "Creatures",
+  "People",
+  "Clothes",
+  "Shapes",
+  "Effects",
+  "Uploads"
+]);
+var VideoAnalysisSchema = z.object({
+  title: z.string(),
+  prompt: z.string(),
+  category: VideoAnalysisCategorySchema,
+  fidelity: FidelitySchema
+});
+var QueueJobSchema = z.object({
+  id: z.string(),
+  type: z.enum(["text", "image", "video", "analysis"]),
+  status: z.enum(["queued", "processing", "completed", "failed"]),
+  payload: z.record(z.any()).optional(),
+  createdAt: z.any().optional(),
+  updatedAt: z.any().optional()
+});
+export {
+  AspectRatioSchema,
+  FidelitySchema,
+  ImageGenerationSchema,
+  ImageTransformationSchema,
+  QueueJobSchema,
+  VideoAnalysisCategorySchema,
+  VideoAnalysisSchema,
+  VideoAspectRatioSchema
+};

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@pixerate/schemas",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Pixerate/schemas.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Pixerate/schemas/issues"
+  },
+  "homepage": "https://github.com/Pixerate/schemas#readme",
+  "author": "Pixerate",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "typescript": "^5.4.5",
+    "tsup": "^8.0.2"
+  }
+}