@ericbutera/kaleido 0.1.7 → 0.1.12

package/dist/components/admin/adminLayoutConfig.d.ts

@@ -0,0 +1,9 @@
+import { ComponentType } from 'react';
+type AdminLayoutConfig = {
+    SiteNavigation?: ComponentType<any>;
+    AdminNav?: ComponentType<any>;
+};
+export declare function configureAdminLayout(cfg: AdminLayoutConfig): void;
+export declare function getSiteNavigation(): ComponentType<any>;
+export declare function getAdminNav(): ComponentType<any>;
+export type { AdminLayoutConfig };

package/dist/components/common/GenericList.d.ts

@@ -1,6 +1,6 @@
-import { PaginatedQueryResult } from '../../lib/paginatedQuery';
 import { ReactNode } from 'react';
 import { ZodTypeAny } from 'zod';
+import { PaginatedQueryResult } from '../../lib/paginatedQuery';
 export interface Column<T, P = any> {
     key: string;
     header: ReactNode | ((params: P, setFilter: (key: keyof P, value: any) => void, setFilters: (updates: Partial<P>) => void) => ReactNode);

package/dist/components/featureFlags/FeatureFlagStatus.d.ts

@@ -0,0 +1,9 @@
+interface Props {
+    flag: string;
+    enabledLabel?: string;
+    disabledLabel?: string;
+    className?: string;
+    canToggle?: boolean;
+}
+export default function FeatureFlagStatus({ flag, enabledLabel, disabledLabel, className, canToggle, }: Props): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/featureFlags/defaults.d.ts

@@ -0,0 +1,3 @@
+export declare const FLAG_REGISTRATION = "registration";
+export declare const FLAG_OAUTH = "oauth";
+export declare const FLAG_API_CLIENTS = "api_clients";

package/dist/featureFlags/index.d.ts

@@ -0,0 +1,2 @@
+export * from './defaults';
+export { configureFeatureFlags, useFeatureFlag, useFeatureFlags, useUpdateFeatureFlag, type FeatureFlagRecord, type FeatureFlagsConfig, type UpdateMutation, type UseFeatureFlagsOpts, type UseFeatureFlagsResult, } from './useFeatureFlag';

package/dist/featureFlags/useFeatureFlag.d.ts

@@ -0,0 +1,86 @@
+export type FeatureFlagRecord = {
+    feature_key: string;
+    enabled: boolean;
+    description?: string | null;
+};
+export type UseFeatureFlagsOpts = {
+    page?: number;
+    per_page?: number;
+    enabledOnly?: boolean;
+};
+export type UseFeatureFlagsResult = {
+    data: FeatureFlagRecord[];
+    isLoading?: boolean;
+    isError?: boolean;
+    raw?: unknown;
+    refetch?: () => Promise<unknown>;
+};
+export type UpdateMutation = {
+    mutate: (vars: {
+        key: string;
+        enabled: boolean;
+    }) => void;
+    mutateAsync: (vars: {
+        key: string;
+        enabled: boolean;
+    }) => Promise<unknown>;
+};
+/**
+ * Configuration interface for feature flag queries.
+ * Apps (like mycorner) implement this using their OpenAPI client.
+ */
+export type FeatureFlagsConfig = {
+    useFeatureFlags: (opts?: UseFeatureFlagsOpts) => UseFeatureFlagsResult;
+    useUpdateFeatureFlag: () => UpdateMutation;
+};
+/**
+ * Configure feature flag queries once at app startup.
+ * Apps with OpenAPI clients should call this in their main setup.
+ *
+ * @example
+ * ```tsx
+ * import { configureFeatureFlags } from '@kaleido/featureFlags';
+ * import { $api } from './openapi';
+ *
+ * configureFeatureFlags({
+ *   useFeatureFlags: (opts) => {
+ *     const resp = $api.useQuery("get", "/flags");
+ *     const dataArr = resp.data?.data ?? [];
+ *     return {
+ *       data: opts?.enabledOnly ? dataArr.filter(f => f.enabled) : dataArr,
+ *       isLoading: resp.isLoading,
+ *       refetch: resp.refetch,
+ *     };
+ *   },
+ *   useUpdateFeatureFlag: () => {
+ *     const mutation = $api.useMutation("post", "/admin/feature-flags/{key}");
+ *     return {
+ *       mutate: (vars) => mutation.mutate({
+ *         params: { path: { key: vars.key } },
+ *         body: { enabled: vars.enabled }
+ *       }),
+ *       mutateAsync: (vars) => mutation.mutateAsync({
+ *         params: { path: { key: vars.key } },
+ *         body: { enabled: vars.enabled }
+ *       }),
+ *     };
+ *   }
+ * });
+ * ```
+ */
+export declare function configureFeatureFlags(cfg: FeatureFlagsConfig): void;
+/**
+ * Fetch all feature flags.
+ * Must call `configureFeatureFlags()` before using.
+ */
+export declare function useFeatureFlags(opts?: UseFeatureFlagsOpts): UseFeatureFlagsResult;
+/**
+ * Check if a specific feature flag is enabled.
+ * Must call `configureFeatureFlags()` before using.
+ */
+export declare function useFeatureFlag(flag: string): boolean;
+/**
+ * Hook to update a feature flag (admin operation).
+ * Must call `configureFeatureFlags()` before using.
+ */
+export declare function useUpdateFeatureFlag(): UpdateMutation;

package/dist/index.d.ts

@@ -6,6 +6,8 @@ export { default as AdminLayout } from './components/admin/AdminLayout';
 export { default as GenericList } from './components/common/GenericList';
 export { default as Pagination } from './components/common/Pagination';
 export { default as SortHeader } from './components/common/SortHeader';
+export * as featureFlags from './featureFlags';
+export { configureAdminLayout } from './components/admin/adminLayoutConfig';
 export type { ApiError, AuthApiClient, AuthConfig, LoginRequest, RegisterRequest, ResendConfirmationRequest, ResetRequest, User, } from './auth';
 export type { Column, GenericListProps } from './components/common/GenericList';
 export { useTasksApi } from './lib/tasksApi';