@ooneex/types 0.0.1 → 0.0.5

package/README.md

@@ -1 +1,357 @@
-# @ooneex/router
+# @ooneex/types
+
+Shared TypeScript types, interfaces, and base definitions used across the Ooneex framework. This package provides common type definitions for HTTP methods, character encodings, scalar values, and base entity interfaces that ensure consistency throughout your application.
+
+![Browser](https://img.shields.io/badge/Browser-Compatible-green?style=flat-square&logo=googlechrome)
+![Bun](https://img.shields.io/badge/Bun-Compatible-orange?style=flat-square&logo=bun)
+![Deno](https://img.shields.io/badge/Deno-Compatible-blue?style=flat-square&logo=deno)
+![Node.js](https://img.shields.io/badge/Node.js-Compatible-green?style=flat-square&logo=node.js)
+![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue?style=flat-square&logo=typescript)
+![MIT License](https://img.shields.io/badge/License-MIT-yellow?style=flat-square)
+
+## Features
+
+✅ **HTTP Method Types** - Type-safe HTTP method definitions (GET, POST, PUT, DELETE, etc.)
+
+✅ **Base Interfaces** - Common entity interfaces with standard fields (id, timestamps, etc.)
+
+✅ **Scalar Types** - Union type for primitive values (boolean, number, bigint, string)
+
+✅ **Filter Result Type** - Standardized pagination and filtering result structure
+
+✅ **Encoding Types** - Character encoding and compression type definitions
+
+✅ **Zero Runtime** - Pure type definitions with no runtime overhead
+
+## Installation
+
+### Bun
+```bash
+bun add @ooneex/types
+```
+
+### pnpm
+```bash
+pnpm add @ooneex/types
+```
+
+### Yarn
+```bash
+yarn add @ooneex/types
+```
+
+### npm
+```bash
+npm install @ooneex/types
+```
+
+## Usage
+
+### HTTP Method Types
+
+```typescript
+import { HTTP_METHODS, type HttpMethodType } from '@ooneex/types';
+
+// Type-safe HTTP method
+const method: HttpMethodType = 'GET';
+
+// Use the constant array
+HTTP_METHODS.forEach(m => console.log(m));
+// GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD
+
+// Function with HTTP method parameter
+function makeRequest(url: string, method: HttpMethodType): void {
+  fetch(url, { method });
+}
+
+makeRequest('/api/users', 'POST'); // ✓ Valid
+makeRequest('/api/users', 'INVALID'); // ✗ Type error
+```
+
+### Base Entity Interface
+
+```typescript
+import type { IBase } from '@ooneex/types';
+
+interface User extends IBase {
+  email: string;
+  name: string;
+}
+
+const user: User = {
+  id: 'user-123',
+  email: 'john@example.com',
+  name: 'John Doe',
+  createdAt: new Date(),
+  updatedAt: new Date(),
+  isPublic: true
+};
+```
+
+### Stat Interface for Social Features
+
+```typescript
+import type { IStat } from '@ooneex/types';
+
+interface Post extends IStat {
+  title: string;
+  content: string;
+}
+
+const post: Post = {
+  id: 'post-456',
+  title: 'Hello World',
+  content: 'My first post',
+  commentsCount: 42,
+  likesCount: 156,
+  viewsCount: 1200,
+  sharesCount: 23,
+  // ... other IStat fields
+};
+```
+
+### Scalar Types
+
+```typescript
+import type { ScalarType } from '@ooneex/types';
+
+// ScalarType accepts boolean, number, bigint, or string
+const values: ScalarType[] = [
+  true,
+  42,
+  BigInt(9007199254740991),
+  'hello'
+];
+
+// Useful for generic key-value data
+function logData(data: Record<string, ScalarType>): void {
+  for (const [key, value] of Object.entries(data)) {
+    console.log(`${key}: ${value}`);
+  }
+}
+
+logData({
+  name: 'John',
+  age: 30,
+  active: true
+});
+```
+
+### Filter Result Type
+
+```typescript
+import type { FilterResultType } from '@ooneex/types';
+
+interface Product {
+  id: string;
+  name: string;
+  price: number;
+}
+
+// Paginated response type
+type ProductListResponse = FilterResultType<Product>;
+
+const response: ProductListResponse = {
+  resources: [
+    { id: '1', name: 'Widget', price: 9.99 },
+    { id: '2', name: 'Gadget', price: 19.99 }
+  ],
+  total: 50,
+  totalPages: 5,
+  page: 1,
+  limit: 10
+};
+```
+
+## API Reference
+
+### Constants
+
+#### `HTTP_METHODS`
+
+Array of valid HTTP method strings.
+
+```typescript
+const HTTP_METHODS = ["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD"] as const;
+```
+
+### Types
+
+#### `HttpMethodType`
+
+Union type of valid HTTP methods.
+
+```typescript
+type HttpMethodType = "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "OPTIONS" | "HEAD";
+```
+
+#### `ScalarType`
+
+Union type for primitive scalar values.
+
+```typescript
+type ScalarType = boolean | number | bigint | string;
+```
+
+#### `EncodingType`
+
+Valid HTTP content encoding types.
+
+```typescript
+type EncodingType = "deflate" | "gzip" | "compress" | "br" | "identity" | "*";
+```
+
+#### `CharsetType`
+
+Common character set encodings.
+
+```typescript
+type CharsetType = "ISO-8859-1" | "7-BIT" | "UTF-8" | "UTF-16" | "US-ASCII";
+```
+
+#### `FilterResultType<T>`
+
+Generic type for paginated results.
+
+```typescript
+type FilterResultType<T> = {
+  resources: T[];
+  total: number;
+  totalPages: number;
+  page: number;
+  limit: number;
+};
+```
+
+### Interfaces
+
+#### `IBase`
+
+Base interface for all entities with common fields.
+
+```typescript
+interface IBase {
+  id: string;
+  isLocked?: boolean;
+  lockedAt?: Date;
+  isBlocked?: boolean;
+  blockedAt?: Date;
+  blockReason?: string;
+  isPublic?: boolean;
+  createdAt?: Date;
+  updatedAt?: Date;
+  deletedAt?: Date;
+  language?: LocaleType;
+}
+```
+
+#### `IStat`
+
+Extended interface for entities with social/engagement statistics.
+
+```typescript
+interface IStat extends IBase {
+  commentsCount: number;
+  likesCount: number;
+  dislikesCount: number;
+  sharesCount: number;
+  viewsCount: number;
+  downloadsCount: number;
+  savesCount: number;
+  bookmarksCount: number;
+  repostsCount: number;
+  impressionsCount: number;
+  clicksCount: number;
+  engagementRate: number;
+  reach: number;
+  followersCount: number;
+  followingCount: number;
+  blockedCount: number;
+  reportsCount: number;
+}
+```
+
+## Advanced Usage
+
+### Building Custom Entity Types
+
+```typescript
+import type { IBase, ScalarType } from '@ooneex/types';
+
+// Extend IBase for your domain entities
+interface Article extends IBase {
+  title: string;
+  slug: string;
+  content: string;
+  authorId: string;
+  publishedAt?: Date;
+  tags: string[];
+}
+
+// Use ScalarType for metadata
+interface ArticleMeta {
+  [key: string]: ScalarType;
+}
+```
+
+### Type-Safe API Responses
+
+```typescript
+import type { FilterResultType, HttpMethodType } from '@ooneex/types';
+
+interface ApiResponse<T> {
+  data: T;
+  success: boolean;
+}
+
+interface PaginatedApiResponse<T> extends ApiResponse<FilterResultType<T>> {}
+
+// Type-safe API client
+async function fetchPaginated<T>(
+  endpoint: string,
+  method: HttpMethodType = 'GET'
+): Promise<PaginatedApiResponse<T>> {
+  const response = await fetch(endpoint, { method });
+  return response.json();
+}
+```
+
+### Generic Repository Interface
+
+```typescript
+import type { IBase, FilterResultType } from '@ooneex/types';
+
+interface IRepository<T extends IBase> {
+  findById(id: string): Promise<T | null>;
+  findAll(page: number, limit: number): Promise<FilterResultType<T>>;
+  create(data: Omit<T, keyof IBase>): Promise<T>;
+  update(id: string, data: Partial<T>): Promise<T>;
+  delete(id: string): Promise<boolean>;
+}
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
+
+### Development Setup
+
+1. Clone the repository
+2. Install dependencies: `bun install`
+3. Run tests: `bun run test`
+4. Build the project: `bun run build`
+
+### Guidelines
+
+- Write tests for new features
+- Follow the existing code style
+- Update documentation for API changes
+- Ensure all tests pass before submitting PR
+
+---
+
+Made with ❤️ by the Ooneex team

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { LocaleType } from "@ooneex/translation";
-type HttpMethodType = "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "OPTIONS" | "HEAD";
+declare const HTTP_METHODS: readonly ["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD"];
+type HttpMethodType = (typeof HTTP_METHODS)[number];
 type EncodingType = "deflate" | "gzip" | "compress" | "br" | "identity" | "*";
 type CharsetType = "ISO-8859-1" | "7-BIT" | "UTF-8" | "UTF-16" | "US-ASCII";
 type ScalarType = boolean | number | bigint | string;
@@ -17,19 +18,23 @@ interface IBase {
 	language?: LocaleType;
 }
 interface IStat extends IBase {
-	commentCount: number;
-	likeCount: number;
-	shareCount: number;
-	viewCount: number;
-	downloadCount: number;
-	bookmarkCount: number;
-	repostCount: number;
-	impressionCount: number;
-	clickCount: number;
+	commentsCount: number;
+	likesCount: number;
+	dislikesCount: number;
+	sharesCount: number;
+	viewsCount: number;
+	downloadsCount: number;
+	savesCount: number;
+	bookmarksCount: number;
+	repostsCount: number;
+	impressionsCount: number;
+	clicksCount: number;
 	engagementRate: number;
 	reach: number;
-	followerCount: number;
+	followersCount: number;
 	followingCount: number;
+	blockedCount: number;
+	reportsCount: number;
 }
 type FilterResultType<T> = {
 	resources: T[];
@@ -38,4 +43,4 @@ type FilterResultType<T> = {
 	page: number;
 	limit: number;
 };
-export { ScalarType, IStat, IBase, HttpMethodType, FilterResultType, EncodingType, CharsetType };
+export { ScalarType, IStat, IBase, HttpMethodType, HTTP_METHODS, FilterResultType, EncodingType, CharsetType };

package/dist/index.js

@@ -1,2 +1,3 @@
+var e=["GET","POST","PUT","DELETE","PATCH","OPTIONS","HEAD"];export{e as HTTP_METHODS};
 
-//# debugId=8B7D82A81ED7E36264756E2164756E21
+//# debugId=F2931533DC4FF1F964756E2164756E21

package/dist/index.js.map

@@ -1,9 +1,10 @@
 {
   "version": 3,
-  "sources": [],
+  "sources": ["src/index.ts"],
   "sourcesContent": [
+    "import type { LocaleType } from \"@ooneex/translation\";\n\nexport const HTTP_METHODS = [\"GET\", \"POST\", \"PUT\", \"DELETE\", \"PATCH\", \"OPTIONS\", \"HEAD\"] as const;\n\nexport type HttpMethodType = (typeof HTTP_METHODS)[number];\nexport type EncodingType = \"deflate\" | \"gzip\" | \"compress\" | \"br\" | \"identity\" | \"*\";\nexport type CharsetType = \"ISO-8859-1\" | \"7-BIT\" | \"UTF-8\" | \"UTF-16\" | \"US-ASCII\";\nexport type ScalarType = boolean | number | bigint | string;\n\nexport interface IBase {\n  id: string;\n  isLocked?: boolean;\n  lockedAt?: Date;\n  isBlocked?: boolean;\n  blockedAt?: Date;\n  blockReason?: string;\n  isPublic?: boolean;\n  createdAt?: Date;\n  updatedAt?: Date;\n  deletedAt?: Date;\n  language?: LocaleType;\n}\n\nexport interface IStat extends IBase {\n  commentsCount: number;\n  likesCount: number;\n  dislikesCount: number;\n  sharesCount: number;\n  viewsCount: number;\n  downloadsCount: number;\n  savesCount: number;\n  bookmarksCount: number;\n  repostsCount: number;\n  impressionsCount: number;\n  clicksCount: number;\n  engagementRate: number;\n  reach: number;\n  followersCount: number;\n  followingCount: number;\n  blockedCount: number;\n  reportsCount: number;\n}\n\nexport type FilterResultType<T> = {\n  resources: T[];\n  total: number;\n  totalPages: number;\n  page: number;\n  limit: number;\n};\n"
   ],
-  "mappings": "",
-  "debugId": "8B7D82A81ED7E36264756E2164756E21",
+  "mappings": "AAEO,IAAM,EAAe,CAAC,MAAO,OAAQ,MAAO,SAAU,QAAS,UAAW,MAAM",
+  "debugId": "F2931533DC4FF1F964756E2164756E21",
   "names": []
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ooneex/types",
-  "description": "",
-  "version": "0.0.1",
+  "description": "Shared TypeScript types, interfaces, and base definitions used across the Ooneex framework",
+  "version": "0.0.5",
   "type": "module",
   "files": [
     "dist",
@@ -25,11 +25,17 @@
     "test": "bun test tests",
     "build": "bunup",
     "lint": "tsgo --noEmit && bunx biome lint",
-    "publish:prod": "bun publish --tolerate-republish --access public",
-    "publish:pack": "bun pm pack --destination ./dist",
-    "publish:dry": "bun publish --dry-run"
+    "npm:publish": "bun publish --tolerate-republish --access public"
   },
   "devDependencies": {
     "@ooneex/translation": "0.0.1"
-  }
+  },
+  "keywords": [
+    "bun",
+    "definitions",
+    "ooneex",
+    "types",
+    "typescript",
+    "typings"
+  ]
 }