@oneclick.dev/cms-kit 0.0.104 → 0.0.106

package/dist/index.d.ts

@@ -12,6 +12,7 @@ export declare interface BaseSetting<T> {
     description?: string;
     type: SettingType;
     default?: T;
+    required?: boolean;
     valuesFrom?: string;
     visibility?: {
         dependsOn: string[];
@@ -43,6 +44,16 @@ export declare type CmsRouterLocation = string | {
     query?: Record<string, any>;
 };
 
+/** ----------------- config groups ----------------- **/
+export declare type ConditionOperator = 'isNotEmpty' | 'isEmpty' | 'equals' | 'notEquals';
+
+export declare function configGroup<const F extends ModuleSettingsSchema>(opts: {
+    label?: string;
+    description?: string;
+    visibleWhen: GroupConditions;
+    fields: F & ValidateSettingDefaults<F>;
+}): SettingGroup<F>;
+
 declare interface CustomDialogState {
     id: number;
     show: boolean;
@@ -57,7 +68,15 @@ export declare interface DataQuerySetting extends BaseSetting<string> {
     integrationKey?: string;
 }
 
-export declare function defineModuleConfig<const S extends ModuleSettingsSchema>(schema: S & ValidateDefaults<S>): S & ValidateDefaults<S>;
+export declare function defineModuleConfig<const S extends ModuleConfigSchema>(schema: S & ValidateDefaults<S>): S & ValidateDefaults<S>;
+
+/** Evaluate group conditions against current config values */
+export declare function evaluateGroupConditions(conditions: GroupConditions, configValues: Record<string, any>): boolean;
+
+export declare interface FieldCondition {
+    operator: ConditionOperator;
+    value?: any;
+}
 
 export declare interface FirestoreQueryParamFilter {
     field: string;
@@ -78,6 +97,9 @@ export declare interface FirestoreQueryParamSort {
     direction: 'asc' | 'desc';
 }
 
+/** Flatten a ModuleConfigSchema (with possible groups) into a flat settings map */
+export declare function flattenConfigSchema(schema: ModuleConfigSchema): ModuleSettingsSchema;
+
 declare interface FlowBuilderState {
     id: number;
     show: boolean;
@@ -94,6 +116,14 @@ export declare interface FormSetting extends BaseSetting<any> {
     type: 'form';
 }
 
+export declare type GroupConditions = Record<string, ConditionOperator | FieldCondition>;
+
+declare type GroupFieldValues<TSchema extends ModuleConfigSchema> = {
+    [K in keyof TSchema]: TSchema[K] extends SettingGroup<infer F> ? {
+        [FK in keyof F]: ValueTypeFromSetting<F[FK]>;
+    } : {};
+}[keyof TSchema];
+
 export declare interface InputSetting extends BaseSetting<string> {
     type: 'input' | 'textarea' | 'color';
 }
@@ -117,6 +147,8 @@ declare interface MediaSourceUpdateParams {
     allowUserFolders?: boolean;
 }
 
+export declare type ModuleConfigSchema = Record<string, ModuleSetting | SettingGroup>;
+
 export declare interface ModuleMetadata {
     name: string;
     description: string;
@@ -141,9 +173,7 @@ declare interface OverlayState {
     params: Record<string, string>;
 }
 
-export declare type ResolveConfig<TSchema extends ModuleSettingsSchema> = {
-    [K in keyof TSchema]: ValueTypeFromSetting<TSchema[K]>;
-};
+export declare type ResolveConfig<TSchema extends ModuleConfigSchema> = Simplify<TopLevelValues<TSchema> & UnionToIntersection<GroupFieldValues<TSchema>>>;
 
 export declare interface ResourceSetting extends BaseSetting<string> {
     type: 'resource';
@@ -169,8 +199,36 @@ export declare interface SendMailParams {
     body: string;
 }
 
+export declare interface SettingGroup<F extends ModuleSettingsSchema = ModuleSettingsSchema> {
+    _group: true;
+    label?: string;
+    description?: string;
+    visibleWhen: GroupConditions;
+    fields: F;
+}
+
 export declare type SettingType = 'checkbox' | 'input' | 'textarea' | 'select' | 'radio' | 'number' | 'color' | 'resource' | 'mediaSource' | 'dataQuery' | 'flow' | 'form';
 
+declare type Simplify<T> = {
+    [K in keyof T]: T[K];
+};
+
+declare type TopLevelValues<TSchema extends ModuleConfigSchema> = {
+    [K in keyof TSchema as TSchema[K] extends ModuleSetting ? K : never]: TSchema[K] extends ModuleSetting ? ValueTypeFromSetting<TSchema[K]> : never;
+};
+
+declare type UnionToIntersection<U> = (U extends any ? (x: U) => void : never) extends (x: infer I) => void ? I : never;
+
+export declare type UseAgencyIntegrations = () => {
+    getAgencyIntegrations: () => Promise<any>;
+    getAgencyIntegration: (integrationId: string) => Promise<any>;
+};
+
+export declare const useAgencyIntegrations: () => {
+    getAgencyIntegrations: () => Promise<any>;
+    getAgencyIntegration: (integrationId: string) => Promise<any>;
+};
+
 export declare function useCms(): {
     breadcrumbs: {};
     project: {};
@@ -475,7 +533,13 @@ export declare type UseUtilsService = () => {
 
 export declare const useUtilsService: () => ReturnType<UseUtilsService>;
 
-declare type ValidateDefaults<TSchema extends ModuleSettingsSchema> = {
+declare type ValidateDefaults<TSchema extends ModuleConfigSchema> = {
+    [K in keyof TSchema]: TSchema[K] extends SettingGroup ? TSchema[K] : TSchema[K] extends ModuleSetting ? TSchema[K] extends {
+        default: infer D;
+    } ? (D extends ValueTypeFromSetting<TSchema[K]> ? TSchema[K] : never) : TSchema[K] : TSchema[K];
+};
+
+declare type ValidateSettingDefaults<TSchema extends ModuleSettingsSchema> = {
     [K in keyof TSchema]: TSchema[K] extends {
         default: infer D;
     } ? (D extends ValueTypeFromSetting<TSchema[K]> ? TSchema[K] : never) : TSchema[K];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oneclick.dev/cms-kit",
-  "version": "0.0.104",
+  "version": "0.0.106",
   "type": "module",
   "main": "./dist/cms-kit.cjs",
   "module": "./dist/cms-kit.js",