@plyaz/types 1.18.1 → 1.18.2

package/dist/api/endpoints/featureFlags/endpoints.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Feature Flag Endpoint Type Definitions
+ *
+ * Uses fetchff's Endpoint and Req types for type-safe API definitions.
+ *
+ * Req<TResponse, TBody?, TParams?> generic parameters:
+ * - TResponse: The response type returned by the endpoint
+ * - TBody: The request body type (use 'never' for GET/DELETE)
+ * - TParams: URL path parameters type (use 'never' if no path params)
+ *
+ * Error Handling:
+ * - All endpoints use FeatureFlagErrorResponse for error responses
+ * - Errors are accessible via FetchResponse.error (ResponseError from fetchff)
+ * - Use FeatureFlagErrorResponse in hooks/consumers for typed error handling
+ */
+import type { Endpoint, Req } from 'fetchff';
+import type { EvaluateFlagRequest, EvaluateFlagParams, EvaluateFlagResponse, IsEnabledRequest, IsEnabledParams, IsEnabledResponse, EvaluateAllFlagsRequest, EvaluateAllFlagsResponse, CreateFlagResponse, UpdateFlagParams, UpdateFlagRequest, UpdateFlagResponse, DeleteFlagParams, DeleteFlagResponse, SetOverrideParams, SetOverrideRequest, SetOverrideResponse, RemoveOverrideParams, RemoveOverrideResponse, GetFlagRulesParams, GetFlagRulesResponse, RefreshCacheResponse, FeatureFlagHealthResponse } from './types';
+import type { CreateFlagRequest } from '../../../features';
+/**
+ * Feature Flag API endpoint types
+ * Complete type definitions for feature flag endpoints
+ */
+export interface FeatureFlagEndpointTypes {
+    /**
+     * POST /feature-flags/:key/evaluate - Evaluate single flag
+     * Req<Response, Body, Params>
+     */
+    evaluateFeatureFlag: Endpoint<Req<EvaluateFlagResponse, EvaluateFlagRequest, EvaluateFlagParams>>;
+    /**
+     * POST /feature-flags/:key/enabled - Check if flag is enabled
+     * Req<Response, Body, Params>
+     */
+    checkFeatureFlagEnabled: Endpoint<Req<IsEnabledResponse, IsEnabledRequest, IsEnabledParams>>;
+    /**
+     * POST /feature-flags/evaluate-all - Evaluate all flags
+     * Req<Response, Body>
+     */
+    evaluateAllFeatureFlags: Endpoint<Req<EvaluateAllFlagsResponse, EvaluateAllFlagsRequest>>;
+    /**
+     * POST /feature-flags - Create flag
+     * Req<Response, Body>
+     */
+    createFeatureFlag: Endpoint<Req<CreateFlagResponse, CreateFlagRequest<string>>>;
+    /**
+     * PUT /feature-flags/:key - Update flag
+     * Req<Response, Body, Params>
+     */
+    updateFeatureFlag: Endpoint<Req<UpdateFlagResponse, UpdateFlagRequest, UpdateFlagParams>>;
+    /**
+     * DELETE /feature-flags/:key - Delete flag
+     * Req<Response, Body, Params>
+     */
+    deleteFeatureFlag: Endpoint<Req<DeleteFlagResponse, never, DeleteFlagParams>>;
+    /**
+     * POST /feature-flags/:key/override - Set override
+     * Req<Response, Body, Params>
+     */
+    setFeatureFlagOverride: Endpoint<Req<SetOverrideResponse, SetOverrideRequest, SetOverrideParams>>;
+    /**
+     * DELETE /feature-flags/:key/override - Remove override
+     * Req<Response, Body, Params>
+     */
+    removeFeatureFlagOverride: Endpoint<Req<RemoveOverrideResponse, never, RemoveOverrideParams>>;
+    /**
+     * GET /feature-flags/:key/rules - Get flag rules
+     * Req<Response, Body, Params>
+     */
+    getFeatureFlagRules: Endpoint<Req<GetFlagRulesResponse, never, GetFlagRulesParams>>;
+    /**
+     * POST /feature-flags/refresh - Refresh cache
+     * Req<Response>
+     */
+    refreshFeatureFlagCache: Endpoint<Req<RefreshCacheResponse>>;
+    /**
+     * GET /feature-flags/health - Health check
+     * Req<Response>
+     */
+    getFeatureFlagHealth: Endpoint<Req<FeatureFlagHealthResponse>>;
+}
+/**
+ * Type guard for feature flag endpoint keys
+ */
+export type FeatureFlagEndpointKey = keyof FeatureFlagEndpointTypes;

package/dist/api/endpoints/featureFlags/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Feature Flag API Endpoint Types
+ *
+ * Note: Core types (FeatureFlagValue, FeatureFlagContext, FeatureFlagEvaluation, etc.)
+ * are exported from @plyaz/types/features - import them from there
+ */
+export type { FeatureFlagEndpointTypes, FeatureFlagEndpointKey } from './endpoints';
+export type { FeatureFlagErrorResponse, EvaluateFlagRequest, EvaluateFlagParams, EvaluateFlagResponse, IsEnabledRequest, IsEnabledParams, IsEnabledResponse, EvaluateAllFlagsRequest, EvaluateAllFlagsResponse, CreateFlagResponse, UpdateFlagParams, UpdateFlagRequest, UpdateFlagResponse, DeleteFlagParams, DeleteFlagResponse, SetOverrideParams, SetOverrideRequest, SetOverrideResponse, RemoveOverrideParams, RemoveOverrideResponse, GetFlagRulesParams, GetFlagRulesResponse, RefreshCacheResponse, FeatureFlagHealthResponse, } from './types';

package/dist/api/endpoints/featureFlags/types.d.ts

@@ -0,0 +1,153 @@
+/**
+ * Feature Flag API Type Definitions
+ *
+ * Request/Response types for feature flag API endpoints.
+ * Imports core types from @plyaz/types/features.
+ *
+ * Response types are generic to support custom FeatureFlagKey types.
+ * Default to `string` for flexibility when key type is unknown.
+ */
+import type { FeatureFlagValue, FeatureFlagContext, FeatureFlagEvaluation, FeatureFlag, FeatureFlagRule } from '../../../features';
+import type { ErrorResponse } from '../../../errors';
+/**
+ * Error response type for feature flag API endpoints.
+ * Alias allows changing error structure without updating consumers.
+ */
+export type FeatureFlagErrorResponse = ErrorResponse;
+/**
+ * Request body for evaluating a flag
+ */
+export interface EvaluateFlagRequest {
+    context?: FeatureFlagContext;
+}
+/**
+ * Path parameters
+ */
+export interface EvaluateFlagParams {
+    key: string;
+}
+/**
+ * Response type - returns FeatureFlagEvaluation directly
+ * @typeParam TKey - Feature flag key type (defaults to string)
+ */
+export type EvaluateFlagResponse<TKey extends string = string> = FeatureFlagEvaluation<TKey>;
+/**
+ * Request body
+ */
+export interface IsEnabledRequest {
+    context?: FeatureFlagContext;
+}
+/**
+ * Path parameters
+ */
+export interface IsEnabledParams {
+    key: string;
+}
+/**
+ * Response type
+ */
+export interface IsEnabledResponse {
+    isEnabled: boolean;
+}
+/**
+ * Request body
+ */
+export interface EvaluateAllFlagsRequest {
+    context?: FeatureFlagContext;
+}
+/**
+ * Response type - returns Record<TKey, FeatureFlagEvaluation> directly
+ * @typeParam TKey - Feature flag key type (defaults to string)
+ */
+export type EvaluateAllFlagsResponse<TKey extends string = string> = Record<TKey, FeatureFlagEvaluation<TKey>>;
+/**
+ * Response type - returns FeatureFlag directly
+ * @typeParam TKey - Feature flag key type (defaults to string)
+ */
+export type CreateFlagResponse<TKey extends string = string> = FeatureFlag<TKey>;
+/**
+ * Path parameters
+ */
+export interface UpdateFlagParams {
+    key: string;
+}
+/**
+ * Request body
+ */
+export interface UpdateFlagRequest {
+    name?: string;
+    description?: string;
+    defaultValue?: FeatureFlagValue;
+    isEnabled?: boolean;
+}
+/**
+ * Response type - returns FeatureFlag directly
+ * @typeParam TKey - Feature flag key type (defaults to string)
+ */
+export type UpdateFlagResponse<TKey extends string = string> = FeatureFlag<TKey>;
+/**
+ * Path parameters
+ */
+export interface DeleteFlagParams {
+    key: string;
+}
+/**
+ * Response type
+ */
+export interface DeleteFlagResponse {
+    isSuccessful: boolean;
+}
+/**
+ * Path parameters
+ */
+export interface SetOverrideParams {
+    key: string;
+}
+/**
+ * Request body
+ */
+export interface SetOverrideRequest {
+    value: FeatureFlagValue;
+}
+/**
+ * Response type
+ */
+export interface SetOverrideResponse {
+    isSuccessful: boolean;
+}
+/**
+ * Path parameters
+ */
+export interface RemoveOverrideParams {
+    key: string;
+}
+/**
+ * Response type
+ */
+export interface RemoveOverrideResponse {
+    isSuccessful: boolean;
+}
+/**
+ * Path parameters
+ */
+export interface GetFlagRulesParams {
+    key: string;
+}
+/**
+ * Response type - returns FeatureFlagRule[] directly
+ * @typeParam TKey - Feature flag key type (defaults to string)
+ */
+export type GetFlagRulesResponse<TKey extends string = string> = FeatureFlagRule<TKey>[];
+/**
+ * Response type
+ */
+export interface RefreshCacheResponse {
+    isSuccessful: boolean;
+}
+/**
+ * Response type
+ */
+export interface FeatureFlagHealthResponse {
+    isInitialized: boolean;
+    provider: string;
+}

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

@@ -1,4 +1,5 @@
 export type * from './campaigns';
+export type * from './featureFlags';
 export type * from './health';
 export type * from './infobip';
 export type * from './virustotal';

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

@@ -3,6 +3,7 @@ import type { PollingEndpointTypes } from './health';
 import type { InfobipEndpointTypes } from './infobip';
 import type { VirusTotalEndpointTypes } from './virustotal';
 import type { CloudflareEndpointTypes, CloudFrontEndpointTypes, FastlyEndpointTypes } from './cdn';
+import type { FeatureFlagEndpointTypes } from './featureFlags';
 /**
  * Query parameters type - matches fetchff's flexible param handling
  * Supports objects, URLSearchParams, and arrays of name-value pairs
@@ -11,5 +12,5 @@ export type QueryParams = Record<string, string | number | boolean | string[] |
 /**
  * All endpoint types combined
  */
-export interface EndpointTypes extends CampaignEndpointTypes, PollingEndpointTypes, InfobipEndpointTypes, VirusTotalEndpointTypes, CloudflareEndpointTypes, CloudFrontEndpointTypes, FastlyEndpointTypes {
+export interface EndpointTypes extends CampaignEndpointTypes, PollingEndpointTypes, InfobipEndpointTypes, VirusTotalEndpointTypes, CloudflareEndpointTypes, CloudFrontEndpointTypes, FastlyEndpointTypes, FeatureFlagEndpointTypes {
 }

package/dist/api/index.cjs

@@ -579,6 +579,8 @@ var ERROR_CATEGORY = {
   Plugin: "plugin",
   /** Quota or storage limit error (e.g., exceeded storage quota). */
   Quota: "quota",
+  /** Database-related error (e.g., query failure, connection error). */
+  Database: "database",
   /** Unknown or unclassified error. */
   Unknown: "unknown"
 };
@@ -647,6 +649,7 @@ var INTERNAL_STATUS_CODES = {
   [ERROR_CATEGORY.FileOperation]: "fileOperation",
   [ERROR_CATEGORY.Plugin]: "plugin",
   [ERROR_CATEGORY.Quota]: "quota",
+  [ERROR_CATEGORY.Database]: "database",
   [ERROR_CATEGORY.Unknown]: "unknown"
 });
 var COMMON_OPERATIONS = {
@@ -831,6 +834,11 @@ var HTTP_STATUS = {
 
 // src/errors/codes.ts
 var ERROR_CODES = {
+  // ===== Generic/Common Errors =====
+  // These are package-agnostic error codes that can be used across all packages
+  NOT_IMPLEMENTED: "not.implemented",
+  PROVIDER_NOT_IMPLEMENTED: "provider.not.implemented",
+  FEATURE_NOT_SUPPORTED: "feature.not.supported",
   // ===== API Package Errors =====
   // Client Configuration
   CLIENT_INITIALIZATION_FAILED: "CLIENT_INITIALIZATION_FAILED",
@@ -1264,6 +1272,7 @@ var ERROR_CODES = {
   DB_INVALID_COUNT: "db.invalid_count",
   // Connection & Network
   DB_CONNECTION_FAILED: "db.connection_failed",
+  DB_CONNECTION_ERROR: "db.connection_error",
   DB_TIMEOUT: "db.timeout",
   // Constraints & Integrity
   DB_CONSTRAINT_VIOLATION: "db.constraint_violation",
@@ -1273,6 +1282,8 @@ var ERROR_CODES = {
   DB_ENTITY_NOT_FOUND: "db.entity_not_found",
   // Migration & Schema
   DB_MIGRATION_FAILED: "db.migration_failed",
+  // Multi-Write Operations
+  DB_MULTI_WRITE_FAILED: "db.multi_write_failed",
   // General
   DB_UNKNOWN_ERROR: "db.unknown_error",
   // ===== Payments Package Errors =====
@@ -1531,6 +1542,31 @@ var API_ERROR_CODES = {
   CDN_PROVIDER_NOT_FOUND: ERROR_CODES.CDN_PROVIDER_NOT_FOUND
 };
 var ERROR_DEFINITIONS = {
+  // ===== Generic/Common Error Definitions =====
+  [ERROR_CODES.NOT_IMPLEMENTED]: {
+    code: ERROR_CODES.NOT_IMPLEMENTED,
+    status: HTTP_STATUS.NOT_IMPLEMENTED,
+    category: ERROR_CATEGORY.System,
+    userMessage: "errors.not_implemented",
+    severity: ERROR_SEVERITY.Medium,
+    retryable: false
+  },
+  [ERROR_CODES.PROVIDER_NOT_IMPLEMENTED]: {
+    code: ERROR_CODES.PROVIDER_NOT_IMPLEMENTED,
+    status: HTTP_STATUS.NOT_IMPLEMENTED,
+    category: ERROR_CATEGORY.System,
+    userMessage: "errors.provider.not_implemented",
+    severity: ERROR_SEVERITY.Medium,
+    retryable: false
+  },
+  [ERROR_CODES.FEATURE_NOT_SUPPORTED]: {
+    code: ERROR_CODES.FEATURE_NOT_SUPPORTED,
+    status: HTTP_STATUS.NOT_IMPLEMENTED,
+    category: ERROR_CATEGORY.System,
+    userMessage: "errors.feature.not_supported",
+    severity: ERROR_SEVERITY.Low,
+    retryable: false
+  },
   // ===== API Package Error Definitions =====
   // Authentication
   [ERROR_CODES.AUTH_UNAUTHORIZED]: {
@@ -4835,6 +4871,22 @@ var ERROR_DEFINITIONS = {
     severity: ERROR_SEVERITY.High,
     retryable: true
   },
+  [ERROR_CODES.DB_CONNECTION_ERROR]: {
+    code: ERROR_CODES.DB_CONNECTION_ERROR,
+    status: HTTP_STATUS.SERVICE_UNAVAILABLE,
+    category: ERROR_CATEGORY.Network,
+    userMessage: "db.connection.error",
+    severity: ERROR_SEVERITY.High,
+    retryable: true
+  },
+  [ERROR_CODES.DB_MULTI_WRITE_FAILED]: {
+    code: ERROR_CODES.DB_MULTI_WRITE_FAILED,
+    status: HTTP_STATUS.INTERNAL_SERVER_ERROR,
+    category: ERROR_CATEGORY.Database,
+    userMessage: "db.multi_write.failed",
+    severity: ERROR_SEVERITY.High,
+    retryable: false
+  },
   [ERROR_CODES.DB_TIMEOUT]: {
     code: ERROR_CODES.DB_TIMEOUT,
     status: HTTP_STATUS.REQUEST_TIMEOUT,