@flagpole/api-types 1.0.10 → 1.0.11

package/README.md

@@ -1,54 +1,2 @@
-# @flagpole/api-types
-
-TypeScript types for the FlagPole API.
-
-## Installation
-
-```bash
-npm install @flagpole/api-types
-```
-
-## Usage
-
-```typescript
-import { 
-  CreateFeatureFlagDto,
-  FeatureFlag,
-  CreateOrganizationDto,
-  Organization,
-  Api
-} from '@flagpole/api-types';
-
-// Use the types in your application
-const createFlag: CreateFeatureFlagDto = {
-  name: 'my-feature',
-  description: 'My new feature flag',
-  isEnabled: false,
-  environments: ['development']
-};
-
-// API Client usage
-const api = new Api({
-  baseURL: 'https://api.useflagpole.dev',
-});
-
-// Set authorization header
-api.instance.defaults.headers.common['Authorization'] = `Bearer ${token}`;
-
-const flags = await api.featureFlags.findAll();
-```
-
-## Version
-
-This package is automatically generated from the FlagPole API OpenAPI specification.
-The version corresponds to the API version it was generated from.
-
-## Generated Files
-
-- `flagpole-api-types.ts` - Main types and API client
-- `index.d.ts` - TypeScript declarations  
-- `index.js` - CommonJS exports
-
-## Support
-
-For issues with the API types, please refer to the main FlagPole API repository.
+# @flagpole/api-types v1.0.11
+TypeScript types for FlagPole API generated from OpenAPI specification.

package/lib/flagpole-api-types.d.ts

@@ -35,6 +35,52 @@ export interface CheckoutSessionResponseDto {
     /** @example "https://checkout.stripe.com/pay/cs_test_1234567890" */
     url: object | null;
 }
+export interface ConditionRuleDto {
+    /** Whether this is an allow list (true) or block list (false) */
+    allowList?: boolean;
+    /** The attribute to check (custom condition) */
+    attribute?: string;
+    /** Array of browser names */
+    browsers?: string[];
+    /** Array of country codes */
+    countries?: string[];
+    /** Days of week (0-6, Sunday=0) */
+    daysOfWeek?: number[];
+    /** Array of email addresses (user condition) */
+    email?: string[];
+    /** Array of email domains (user condition) */
+    emailDomain?: string[];
+    /**
+     * End date for time-based condition
+     * @format date-time
+     */
+    endDate?: string;
+    /** Hours of day (0-23) */
+    hours?: number[];
+    /** Whether to target mobile devices */
+    mobile?: boolean;
+    /** The operator to use for comparison (custom condition) */
+    operator?: "equals" | "contains" | "startsWith" | "endsWith" | "regex";
+    /** Array of operating systems */
+    os?: string[];
+    /** Array of region codes */
+    regions?: string[];
+    /**
+     * Start date for time-based condition
+     * @format date-time
+     */
+    startDate?: string;
+    /** Time zone for the condition */
+    timeZone?: string;
+    /** Array of user IDs (user condition) */
+    userId?: string[];
+    /** Array of user types (user condition) */
+    userType?: string[];
+    /** Array of values to match against (custom condition) */
+    values?: string[];
+    /** Array of version strings */
+    versions?: string[];
+}
 export type CreateApiKeyDto = object;
 export interface CreateCheckoutSessionByPlanDto {
     /**
@@ -65,7 +111,26 @@ export interface CreateCheckoutSessionByPlanDto {
     trialPeriodDays?: number;
 }
 export type CreateCheckoutSessionDto = object;
-export type CreateFeatureFlagDto = object;
+export interface CreateFeatureFlagDto {
+    /** Conditions for when the flag should be active */
+    conditions?: FeatureFlagConditionsDto;
+    /**
+     * Description of the feature flag
+     * @example "Enables dark mode UI"
+     */
+    description: string;
+    environments?: Environment[];
+    /**
+     * Whether the flag is initially enabled
+     * @default false
+     */
+    isEnabled?: boolean;
+    /**
+     * Unique name of the feature flag
+     * @example "dark-mode"
+     */
+    name: string;
+}
 export interface CreateOrganizationDto {
     /**
      * The name of the organization
@@ -118,7 +183,26 @@ export interface DemoRequestDto {
      */
     notes?: string;
 }
+/** Environments where this flag is active */
+export type Environment = "development" | "staging" | "production";
 export type FeatureFlag = object;
+export interface FeatureFlagConditionDto {
+    /** Rules for the condition */
+    rules?: ConditionRuleDto;
+    type: "percentage" | "user" | "time" | "geo" | "device" | "custom";
+    /**
+     * Percentage value (0-100) for percentage condition
+     * @min 0
+     * @max 100
+     */
+    value?: number;
+}
+export interface FeatureFlagConditionsDto {
+    /** Array of conditions */
+    conditions: FeatureFlagConditionDto[];
+    /** Logical operator to combine conditions */
+    operator: "AND" | "OR";
+}
 export type FeatureFlagControllerCreateData = FeatureFlag;
 export type FeatureFlagControllerDeleteData = any;
 export type FeatureFlagControllerFindAllData = FeatureFlag[];
@@ -669,9 +753,9 @@ export declare namespace Api {
         type RequestQuery = {};
         type RequestBody = CreateFeatureFlagDto;
         type RequestHeaders = {
+            "x-organization-id": string;
             /** ID of the current project */
             "x-project-id": string;
-            "x-organization-id": string;
         };
         type ResponseBody = FeatureFlagControllerCreateData;
     }
@@ -1097,9 +1181,8 @@ export declare class HttpClient<SecurityDataType = unknown> {
 /**
  * @title FlagPole API
  * @version 1.0.0
- * @license Proprietary (https://useflagpole.dev/terms)
  * @baseUrl http://localhost:5000
- * @contact FlagPole Support <support@useflagpole.dev> (https://useflagpole.dev)
+ * @contact
  *
  * API for managing feature flags and organizations
  */

package/lib/flagpole-api-types.js

@@ -95,9 +95,8 @@ exports.HttpClient = HttpClient;
 /**
  * @title FlagPole API
  * @version 1.0.0
- * @license Proprietary (https://useflagpole.dev/terms)
  * @baseUrl http://localhost:5000
- * @contact FlagPole Support <support@useflagpole.dev> (https://useflagpole.dev)
+ * @contact
  *
  * API for managing feature flags and organizations
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flagpole/api-types",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "description": "TypeScript types for FlagPole API",
   "main": "index.js",
   "types": "index.d.ts",
@@ -41,4 +41,4 @@
     "typescript": "^5.7.2",
     "@types/node": "^22.9.4"
   }
-}
+}