import {z} from 'zod' export type FeatureFlagStatus = 'enabled' | 'disabled' | 'archived'; export type ServingMethod = 'client' | 'server' | 'remote_or_local' | 'remote_only'; export type ManagementVariant = {key: string, value: boolean | string | unknown, description?: string | undefined, is_control: boolean, split: number, is_sticky?: boolean | undefined}; export type RuntimeEventTimeWindow = 'while_flag_enabled'; export type FirstTimeEventDuration = 'end_of_session' | 'indefinitely'; export type RuntimeEventRule = {event_name: string, time_window: RuntimeEventTimeWindow, duration?: FirstTimeEventDuration | undefined, property_filters?: {[key: string]: unknown} | undefined}; export type ManagementVariantOverride = {key: string}; export type ManagementRollout = {name?: string | undefined, cohort_definition?: {[key: string]: unknown} | undefined, runtime_evaluation_definition?: {[key: string]: unknown} | undefined, runtime_evaluation_rule?: {[key: string]: unknown} | undefined, runtime_event_rule?: RuntimeEventRule | undefined, cohort_hash?: string | undefined, rollout_percentage: number, variant_override?: ManagementVariantOverride | undefined, variant_splits: {[key: string]: number}}; export type ManagementRuleSet = {variants: Array, rollout: Array, test?: {[key: string]: {[key: string]: string}} | undefined}; export type FeatureFlagRequest = {name: string, key: string, description?: string | undefined, tags: Array, experiment_id?: unknown | undefined, status?: FeatureFlagStatus | undefined, context: string, data_group_id?: (string | number) | undefined, serving_method: ServingMethod, ruleset: ManagementRuleSet, workspace_id?: number | undefined, is_experiment_active?: boolean | undefined, hash_salt?: string | undefined, reset_hash_salt?: boolean | undefined}; export type CreateApiProjectsProjectIdWorkspacesWorkspaceIdFeatureFlagsArgs = {body: FeatureFlagRequest}; export type CreateApiProjectsProjectIdWorkspacesWorkspaceIdFeatureFlagsOptions = {baseUrl?: string | undefined, ServiceAccount?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const featureFlagStatus = z.enum(["enabled", "disabled", "archived"]); export const servingMethod = z.enum(["client", "server", "remote_or_local", "remote_only"]); export const managementVariant = z.object({key: z.string(), value: z.union([z.boolean(), z.string().max(32768), z.unknown()]), description: z.string().optional(), is_control: z.boolean(), split: z.number().gte(0).lte(1), is_sticky: z.boolean().optional()}); export const runtimeEventTimeWindow = z.literal("while_flag_enabled"); export const firstTimeEventDuration = z.enum(["end_of_session", "indefinitely"]); export const runtimeEventRule = z.object({event_name: z.string(), time_window: runtimeEventTimeWindow, duration: firstTimeEventDuration.optional(), property_filters: z.record(z.string(), z.unknown()).optional()}); export const managementVariantOverride = z.object({key: z.string()}); export const managementRollout = z.object({name: z.string().optional(), cohort_definition: z.record(z.string(), z.unknown()).optional(), runtime_evaluation_definition: z.record(z.string(), z.unknown()).optional(), runtime_evaluation_rule: z.record(z.string(), z.unknown()).optional(), runtime_event_rule: runtimeEventRule.optional(), cohort_hash: z.string().optional(), rollout_percentage: z.number().gte(0).lte(1), variant_override: managementVariantOverride.optional(), variant_splits: z.record(z.string(), z.number())}); export const managementRuleSet = z.object({variants: z.array(managementVariant), rollout: z.array(managementRollout), test: z.record(z.string(), z.record(z.string(), z.string())).optional()}); export const featureFlagApiResponse = z.object({can_update_basic: z.boolean().optional(), is_superadmin: z.boolean().optional(), allow_staff_override: z.boolean().optional(), can_view: z.boolean().optional(), can_share: z.boolean().optional(), can_pin: z.boolean().optional(), is_shared_with_project: z.boolean().optional(), name: z.string().min(1).max(255), key: z.string().min(1).max(255), description: z.string().optional(), tags: z.array(z.string()), experiment_id: z.string().optional(), status: featureFlagStatus.optional(), context: z.string().min(1).max(255), data_group_id: z.union([z.string(), z.number().int()]).optional(), serving_method: servingMethod, ruleset: managementRuleSet, workspace_id: z.number().int().optional(), is_experiment_active: z.boolean().optional(), hash_salt: z.string().min(32).max(32).optional(), reset_hash_salt: z.boolean().optional(), id: z.string(), project_id: z.number().int(), content_type: z.string(), created: z.string(), creator_id: z.number().int(), creator_name: z.string(), creator_email: z.string(), modified: z.string(), last_modified_by_id: z.number().int().optional(), last_modified_by_name: z.string().optional(), last_modified_by_email: z.string().optional(), is_favorited: z.boolean().optional(), pinned_date: z.string().optional(), enabled_at: z.string().optional(), deleted: z.string().optional(), content_environments_id: z.string().optional(), project_name: z.string().optional()}); export const singleFeatureFlagApiResponse = z.object({status: z.string(), results: featureFlagApiResponse}); export const managementApiErrorResponse = z.object({status: z.string(), type: z.string(), error: z.union([z.string(), z.object({})])}); export const singleFeatureFlagResponse = z.union([singleFeatureFlagApiResponse, managementApiErrorResponse]); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Create Feature Flag * * POST /projects/{project_id}/workspaces/{workspace_id}/feature-flags * * Also accepts auth: ProjectSecret */ export const createApiProjectsProjectIdWorkspacesWorkspaceIdFeatureFlags = async (args: CreateApiProjectsProjectIdWorkspacesWorkspaceIdFeatureFlagsArgs, options?: CreateApiProjectsProjectIdWorkspacesWorkspaceIdFeatureFlagsOptions) => { const {baseUrl = "https://mixpanel.com/api/query", fetch: fetchFn = fetch, ServiceAccount} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (ServiceAccount !== undefined) headers.set('authorization', `Basic ${btoa(`${ServiceAccount.username}:${ServiceAccount.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/projects/${encodeURIComponent(String(args.project_id))}/workspaces/${encodeURIComponent(String(args.workspace_id))}/feature-flags${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(singleFeatureFlagResponse, await res.json()) };