@turndown/library 0.0.25 → 0.0.26

package/dist/types/api/index.d.ts

@@ -0,0 +1,59 @@
+/**
+ * API Response Types
+ * Standard response structure for all API endpoints
+ */
+import { TurndownObject } from "../base";
+export interface ApiError {
+    message: string;
+    code?: string;
+    details?: TurndownObject;
+}
+export interface ApiMeta {
+    timestamp: string;
+    version: string;
+    environment: string;
+    requestId?: string;
+}
+export interface ApiResponse<T = TurndownObject> {
+    success: boolean;
+    data?: T;
+    error?: ApiError;
+    meta?: ApiMeta;
+}
+/**
+ * Error Codes
+ * Standardized error codes used across the platform
+ */
+export declare const ErrorCodes: {
+    readonly BAD_REQUEST: "BAD_REQUEST";
+    readonly VALIDATION_ERROR: "VALIDATION_ERROR";
+    readonly MISSING_FIELDS: "MISSING_FIELDS";
+    readonly UNAUTHORIZED: "UNAUTHORIZED";
+    readonly INVALID_TOKEN: "INVALID_TOKEN";
+    readonly INVALID_CREDENTIALS: "INVALID_CREDENTIALS";
+    readonly FORBIDDEN: "FORBIDDEN";
+    readonly NOT_FOUND: "NOT_FOUND";
+    readonly CONFLICT: "CONFLICT";
+    readonly ALREADY_EXISTS: "ALREADY_EXISTS";
+    readonly RATE_LIMIT_EXCEEDED: "RATE_LIMIT_EXCEEDED";
+    readonly INTERNAL_ERROR: "INTERNAL_ERROR";
+    readonly DATABASE_ERROR: "DATABASE_ERROR";
+};
+export type ErrorCode = (typeof ErrorCodes)[keyof typeof ErrorCodes];
+/**
+ * HTTP Status Codes
+ * Common status codes used in responses
+ */
+export declare const HttpStatus: {
+    readonly OK: 200;
+    readonly CREATED: 201;
+    readonly NO_CONTENT: 204;
+    readonly BAD_REQUEST: 400;
+    readonly UNAUTHORIZED: 401;
+    readonly FORBIDDEN: 403;
+    readonly NOT_FOUND: 404;
+    readonly CONFLICT: 409;
+    readonly RATE_LIMIT: 429;
+    readonly INTERNAL_ERROR: 500;
+};
+export type HttpStatusCode = (typeof HttpStatus)[keyof typeof HttpStatus];

package/dist/types/api/index.js

@@ -0,0 +1,46 @@
+/**
+ * API Response Types
+ * Standard response structure for all API endpoints
+ */
+/**
+ * Error Codes
+ * Standardized error codes used across the platform
+ */
+export const ErrorCodes = {
+    // 400 - Bad Request
+    BAD_REQUEST: "BAD_REQUEST",
+    VALIDATION_ERROR: "VALIDATION_ERROR",
+    MISSING_FIELDS: "MISSING_FIELDS",
+    // 401 - Unauthorized
+    UNAUTHORIZED: "UNAUTHORIZED",
+    INVALID_TOKEN: "INVALID_TOKEN",
+    INVALID_CREDENTIALS: "INVALID_CREDENTIALS",
+    // 403 - Forbidden
+    FORBIDDEN: "FORBIDDEN",
+    // 404 - Not Found
+    NOT_FOUND: "NOT_FOUND",
+    // 409 - Conflict
+    CONFLICT: "CONFLICT",
+    ALREADY_EXISTS: "ALREADY_EXISTS",
+    // 429 - Rate Limiting
+    RATE_LIMIT_EXCEEDED: "RATE_LIMIT_EXCEEDED",
+    // 500 - Server Errors
+    INTERNAL_ERROR: "INTERNAL_ERROR",
+    DATABASE_ERROR: "DATABASE_ERROR",
+};
+/**
+ * HTTP Status Codes
+ * Common status codes used in responses
+ */
+export const HttpStatus = {
+    OK: 200,
+    CREATED: 201,
+    NO_CONTENT: 204,
+    BAD_REQUEST: 400,
+    UNAUTHORIZED: 401,
+    FORBIDDEN: 403,
+    NOT_FOUND: 404,
+    CONFLICT: 409,
+    RATE_LIMIT: 429,
+    INTERNAL_ERROR: 500,
+};

package/dist/types/auth/index.d.ts

@@ -0,0 +1,137 @@
+/**
+ * Authentication Types
+ * Request/Response types for authentication endpoints
+ */
+import { User, AccountType, DeviceInfo } from "../user";
+/**
+ * Token Payload
+ * JWT token payload structure
+ */
+export interface TokenPayload {
+    userId: string;
+    email: string;
+    name: string;
+}
+/**
+ * Auth Token Response
+ * Standard structure for authentication responses with tokens
+ */
+export interface AuthTokenResponse {
+    user: User;
+    accessToken: string;
+    refreshToken: string;
+    expiresAt: string;
+}
+/**
+ * Signup Request
+ * Request body for user signup
+ */
+export interface SignupRequest {
+    email: string;
+    password: string;
+    firstName: string;
+    lastName?: string;
+    accountType: AccountType;
+    deviceInfo?: DeviceInfo;
+}
+/**
+ * Signup Response
+ * Response from signup endpoint
+ */
+export interface SignupResponse extends AuthTokenResponse {
+}
+/**
+ * Signin Request
+ * Request body for user signin
+ */
+export interface SigninRequest {
+    email: string;
+    password: string;
+    deviceInfo?: DeviceInfo;
+}
+/**
+ * Signin Response
+ * Response from signin endpoint
+ */
+export interface SigninResponse extends AuthTokenResponse {
+}
+/**
+ * Refresh Token Request
+ * Request body for token refresh
+ */
+export interface RefreshTokenRequest {
+    refreshToken: string;
+    deviceInfo?: DeviceInfo;
+}
+/**
+ * Refresh Token Response
+ * Response from token refresh endpoint
+ */
+export interface RefreshTokenResponse extends AuthTokenResponse {
+}
+/**
+ * Signout Request
+ * Request body for signout
+ */
+export interface SignoutRequest {
+    refreshToken: string;
+}
+/**
+ * Signout All Request
+ * Request body for signing out from all devices
+ */
+export interface SignoutAllRequest {
+    userId: string;
+}
+/**
+ * Get User Request
+ * Request parameters for getting user info
+ */
+export interface GetUserRequest {
+    userId?: string;
+    email?: string;
+}
+/**
+ * Get User Response
+ * Response from get user endpoint
+ */
+export interface GetUserResponse {
+    user: User | null;
+}
+/**
+ * Password Validation Rules
+ * Rules for password validation
+ */
+export interface PasswordValidationRules {
+    minLength: number;
+    requireUppercase: boolean;
+    requireLowercase: boolean;
+    requireNumbers: boolean;
+    requireSpecialChars: boolean;
+}
+/**
+ * Password Validation Result
+ * Result of password validation
+ */
+export interface PasswordValidationResult {
+    valid: boolean;
+    errors: string[];
+}
+/**
+ * Email Validation Result
+ * Result of email validation
+ */
+export interface EmailValidationResult {
+    valid: boolean;
+    error?: string;
+}
+/**
+ * Rate Limit Status
+ * Information about rate limiting status
+ */
+export interface RateLimitStatus {
+    isLimited: boolean;
+    attempts: number;
+    maxAttempts: number;
+    resetTime?: string;
+}

package/dist/types/auth/index.js

@@ -0,0 +1,5 @@
+/**
+ * Authentication Types
+ * Request/Response types for authentication endpoints
+ */
+export {};

package/dist/types/base/index.d.ts

@@ -3,16 +3,11 @@ export type TurndownObject<T = GenericTurndownObject> = Record<string, T> | T |
 export type ObjectValues<T> = T[keyof T];
 export type ObjectKeys<T> = [keyof T];
 export interface MetaData {
-    company_id: string;
+    companyId: string;
     deleted: boolean;
-    updated_by: string;
-    created_by: string;
-    created_at: Date;
-    updated_at: Date;
+    updatedBy: string;
+    createdBy: string;
+    createdAt: Date;
+    updatedAt: Date;
 }
-export declare const STATUS: {
-    readonly ACTIVE: "ACTIVE";
-    readonly INACTIVE: "INACTIVE";
-};
-export type Status = ObjectValues<typeof STATUS>;
 export * from "./paging.types";

package/dist/types/base/index.js

@@ -1,5 +1 @@
-export const STATUS = {
-    ACTIVE: "ACTIVE",
-    INACTIVE: "INACTIVE",
-};
 export * from "./paging.types";

package/dist/types/base/paging.types.d.ts

@@ -1,16 +1,30 @@
+/**
+ * Represents the pagination metadata for a paginated response.
+ */
 export interface PagingResult {
     hasNextPage: boolean;
     totalPages: number;
     totalRecords: number;
 }
+/**
+ * A generic wrapper that combines data with pagination information.
+ * @template T - The type of data being paginated
+ */
 export interface DataWithPagingResult<T> {
     data: T;
     pagination: PagingResult;
 }
+/**
+ * Defines a sorting condition for query results.
+ */
 export interface SortCondition {
     name: string;
     direction: "ASC" | "DESC";
 }
+/**
+ * Defines a filter condition for querying data.
+ * Only one of valueString, valueNumber, or valueBoolean should be provided based on the field type.
+ */
 export interface FilterCondition {
     name: string;
     condition: "=" | ">" | "<" | "!=" | "LIKE" | "IN" | ">=" | "<=";
@@ -19,6 +33,9 @@ export interface FilterCondition {
     valueBoolean?: boolean;
     useAnd?: boolean;
 }
+/**
+ * Represents a request for paginated data with optional sorting and filtering.
+ */
 export interface PaginationRequest {
     page: number;
     size: number;

package/dist/types/errors/index.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Error Types
+ * Custom error types and validation error structures
+ */
+import { ErrorCode } from "../api";
+import { TurndownObject } from "../base";
+/**
+ * Validation Error Detail
+ * Detailed information about a validation error
+ */
+export interface ValidationErrorDetail {
+    field: string;
+    message: string;
+    value?: TurndownObject;
+}
+/**
+ * Missing Fields Error Detail
+ * Information about missing required fields
+ */
+export interface MissingFieldsErrorDetail {
+    missingFields: string[];
+}
+/**
+ * Rate Limit Error Detail
+ * Information about rate limiting
+ */
+export interface RateLimitErrorDetail {
+    retryAfter?: number;
+    message: string;
+}
+/**
+ * Error Response Detail
+ * Union type for all possible error details
+ */
+export type ErrorResponseDetail = ValidationErrorDetail[] | MissingFieldsErrorDetail | RateLimitErrorDetail | Record<string, TurndownObject> | string;
+/**
+ * Typed API Error
+ * API error with typed details
+ */
+export interface TypedApiError<T = ErrorResponseDetail> {
+    message: string;
+    code: ErrorCode;
+    details?: T;
+}
+/**
+ * Error Helper Types
+ * For identifying specific error types
+ */
+export type ValidationError = TypedApiError<ValidationErrorDetail[]>;
+export type MissingFieldsError = TypedApiError<MissingFieldsErrorDetail>;
+export type RateLimitError = TypedApiError<RateLimitErrorDetail>;
+/**
+ * Type guard for ValidationError
+ */
+export declare function isValidationError(error: TurndownObject): error is ValidationError;
+/**
+ * Type guard for MissingFieldsError
+ */
+export declare function isMissingFieldsError(error: TurndownObject): error is MissingFieldsError;
+/**
+ * Type guard for RateLimitError
+ */
+export declare function isRateLimitError(error: TurndownObject): error is RateLimitError;
+/**
+ * Type guard for authentication errors
+ */
+export declare function isAuthError(error: TurndownObject): boolean;

package/dist/types/errors/index.js

@@ -0,0 +1,31 @@
+/**
+ * Error Types
+ * Custom error types and validation error structures
+ */
+/**
+ * Type guard for ValidationError
+ */
+export function isValidationError(error) {
+    return error?.code === "VALIDATION_ERROR" && Array.isArray(error?.details);
+}
+/**
+ * Type guard for MissingFieldsError
+ */
+export function isMissingFieldsError(error) {
+    return (error?.code === "MISSING_FIELDS" &&
+        Array.isArray(error?.details?.missingFields));
+}
+/**
+ * Type guard for RateLimitError
+ */
+export function isRateLimitError(error) {
+    return error?.code === "RATE_LIMIT_EXCEEDED";
+}
+/**
+ * Type guard for authentication errors
+ */
+export function isAuthError(error) {
+    return (error?.code === "UNAUTHORIZED" ||
+        error?.code === "INVALID_TOKEN" ||
+        error?.code === "INVALID_CREDENTIALS");
+}

package/dist/types/index.d.ts

@@ -1,2 +1,10 @@
-export * from "./user";
+/**
+ * @turndown/shared-types
+ * Shared TypeScript types and interfaces for Turndown platform
+ * Used by both frontend (React Native/Web) and backend (Node.js)
+ */
+export * from "./api";
+export * from "./auth";
 export * from "./base";
+export * from "./user";
+export * from "./errors";

package/dist/types/index.js

@@ -1,2 +1,10 @@
-export * from "./user";
+/**
+ * @turndown/shared-types
+ * Shared TypeScript types and interfaces for Turndown platform
+ * Used by both frontend (React Native/Web) and backend (Node.js)
+ */
+export * from "./api";
+export * from "./auth";
 export * from "./base";
+export * from "./user";
+export * from "./errors";

package/dist/types/user/index.d.ts

@@ -1,24 +1,10 @@
-import { MetaData, ObjectValues, Status } from "@/types";
-export interface User extends Omit<MetaData, "created_by" | "updated_by"> {
+import { MetaData, ObjectValues } from "@/types";
+export interface User extends MetaData {
     id: string;
     firstName: string;
-    lastName: string;
-    mi: string;
-    username: string;
+    lastName?: string | null;
     email: string;
-    password: string;
-    loginAttempts: number;
-    locked: boolean;
-    passwordLastReset: Date;
-    passwordResetRequired: boolean;
-    type: AccountType;
-    status: Status;
-    companyId: number;
-    phoneNumber: string;
-    phoneFormat: string;
-    language: Language;
-    biometrics: string;
-    lastLogin: Date;
+    accountType: AccountType;
 }
 export declare const ACCOUNT_TYPE: {
     readonly TURNDOWN_ADMIN: "TURNDOWN_ADMIN";
@@ -35,3 +21,14 @@ export declare const LANGUAGE: {
     readonly GERMAN: "GERMAN";
 };
 export type Language = ObjectValues<typeof LANGUAGE>;
+export interface DeviceInfo {
+    userAgent?: string;
+    ip?: string;
+    deviceName?: string;
+}
+export interface UserSession {
+    id: number;
+    deviceInfo?: DeviceInfo | null;
+    createdAt: string;
+    lastUsedAt: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turndown/library",
-  "version": "0.0.25",
+  "version": "0.0.26",
   "description": "Shared TypeScript library for the Turndown suite.",
   "keywords": [
     "types",