@oneclick.dev/cms-kit 0.0.121 → 0.0.123

package/dist/index.d.ts

@@ -1,4 +1,564 @@
-export * from './composables';
-export * from './composables/useCms';
-export * from './types';
-export * from './lib/composables';
+import { FetchOptions } from 'ofetch';
+import { Ref } from 'vue';
+import { useLayout } from '../components/ui/flow-builder/composables/useLayout';
+import { useRunProcess } from '../components/ui/flow-builder/composables/useRunProcess';
+
+declare type ArrayizeIfMultiple<S, TSetting> = TSetting extends {
+    multiple: true;
+} ? S[] : S;
+
+export declare interface BaseSetting<T> {
+    label: string;
+    description?: string;
+    type: SettingType;
+    default?: T;
+    required?: boolean;
+    valuesFrom?: string;
+    visibility?: {
+        dependsOn: string[];
+        visibleWhen: Record<string, (val: any) => boolean>;
+        enabledWhen?: Record<string, (val: any) => boolean>;
+    };
+}
+
+declare interface BreadcrumbItem {
+    text: string;
+    href?: string;
+}
+
+declare interface BuilderState {
+    show: boolean;
+    variableContext: Variable[];
+    resolve: ((value: Object | null) => void) | null;
+    action?: any;
+}
+
+export declare interface CheckboxSetting extends BaseSetting<boolean> {
+    type: 'checkbox';
+}
+
+export declare type CmsRouterLocation = string | {
+    name?: string;
+    path?: string;
+    params?: Record<string, any>;
+    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;
+    layout: string;
+    variables: any;
+    resolve: ((result: any) => void) | null;
+}
+
+export declare interface DataQuerySetting extends BaseSetting<string> {
+    type: 'dataQuery';
+    accept?: string[];
+    integrationKey?: string;
+}
+
+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;
+    operator: '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'not-in' | 'array-contains-any';
+    value: any;
+}
+
+export declare interface FirestoreQueryParams {
+    filters?: FirestoreQueryParamFilter[];
+    sorts?: FirestoreQueryParamSort[];
+    limit?: number;
+    startAt?: string;
+    endAt?: string;
+}
+
+export declare interface FirestoreQueryParamSort {
+    field: string;
+    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;
+    config: any;
+    workflow: any;
+    resolve: ((val: any) => void) | null;
+}
+
+export declare interface FlowSetting extends BaseSetting<any> {
+    type: 'flow';
+}
+
+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';
+}
+
+declare interface MediaSourceCreateParams {
+    name: string;
+    integrationId: string;
+    path: string;
+    allowUserFolders: boolean;
+}
+
+export declare interface MediaSourceSetting extends BaseSetting<string> {
+    type: 'mediaSource';
+    multiple?: boolean;
+}
+
+declare interface MediaSourceUpdateParams {
+    name?: string;
+    integrationId?: string;
+    path?: string;
+    allowUserFolders?: boolean;
+}
+
+export declare type ModuleConfigSchema = Record<string, ModuleSetting | SettingGroup>;
+
+export declare interface ModuleMetadata {
+    name: string;
+    description: string;
+    icon?: string;
+    version?: string;
+    author?: string;
+    tags?: string[];
+}
+
+export declare type ModuleSetting = SelectSetting | CheckboxSetting | InputSetting | NumberSetting | ResourceSetting | MediaSourceSetting | DataQuerySetting | FlowSetting | FormSetting;
+
+export declare type ModuleSettingsSchema = Record<string, ModuleSetting>;
+
+export declare interface NumberSetting extends BaseSetting<number> {
+    type: 'number';
+}
+
+declare interface OverlayState {
+    show: boolean;
+    projectId: string;
+    moduleId: string;
+    params: Record<string, string>;
+}
+
+export declare type ResolveConfig<TSchema extends ModuleConfigSchema> = Simplify<TopLevelValues<TSchema> & UnionToIntersection<GroupFieldValues<TSchema>>>;
+
+export declare interface ResourceSetting extends BaseSetting<string> {
+    type: 'resource';
+    accept?: string[];
+}
+
+/** ----------------- value typing ----------------- **/
+declare type ScalarForType<T extends SettingType> = T extends 'checkbox' ? boolean : T extends 'number' ? number : T extends 'input' | 'textarea' | 'color' | 'resource' | 'dataQuery' ? string : T extends 'mediaSource' ? string : T extends 'select' | 'radio' ? string : T extends 'flow' ? any : T extends 'form' ? any : never;
+
+export declare interface SelectSetting extends BaseSetting<string> {
+    type: 'select' | 'radio';
+    options?: {
+        label: string;
+        value: string;
+    }[];
+    predefinedOptions?: 'languages' | 'countries' | 'timezones' | 'currencies';
+    multiple?: boolean;
+}
+
+export declare interface SendMailParams {
+    to: string;
+    subject: string;
+    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 type UseAI = (integrationId: string) => {
+    generateObject: (schema: any, prompt: string, options?: any) => Promise<any>;
+};
+
+export declare const useAI: (integrationId: string) => {
+    generateObject: (schema: any, prompt: string, options?: any) => Promise<any>;
+};
+
+export declare function useCms(): {
+    breadcrumbs: {};
+    project: {};
+};
+
+export declare type UseConfirmation = () => {
+    confirm: (message: string, title?: string, confirmText?: string) => Promise<boolean>;
+};
+
+export declare const useConfirmation: () => ReturnType<UseConfirmation>;
+
+export declare type UseCustomDialog = () => {
+    customDialogStack: CustomDialogState[];
+    openCustomDialog: (layout: string, variables: Variable[]) => Promise<any>;
+    closeCustomDialog: (id: number, result: any) => void;
+};
+
+export declare const useCustomDialog: () => {
+    customDialogStack: CustomDialogState[];
+    openCustomDialog: (layout: string, variables: Variable[]) => Promise<any>;
+    closeCustomDialog: (id: number, result: any) => void;
+};
+
+export declare type UseFirebaseIntegration = (projectId: string) => {
+    add: (collection: string, data: Record<string, any>) => Promise<any>;
+    find: (collection: string, query?: FirestoreQueryParams) => Promise<any>;
+    get: (collectionOrPath: string, id?: string) => Promise<any>;
+    update: (collectionOrPath: string, id: string | undefined | null, data: Record<string, any>) => Promise<any>;
+    remove: (collectionOrPath: string, id?: string) => Promise<any>;
+};
+
+export declare const useFirebaseIntegration: (projectId: string) => {
+    add: (collection: string, data: Record<string, any>) => Promise<any>;
+    find: (collection: string, query?: FirestoreQueryParams) => Promise<any>;
+    get: (collectionOrPath: string, id?: string) => Promise<any>;
+    update: (collectionOrPath: string, id: string | undefined | null, data: Record<string, any>) => Promise<any>;
+    remove: (collectionOrPath: string, id?: string) => Promise<any>;
+};
+
+export declare type UseFlowBuilder = () => {
+    flowBuilderStack: FlowBuilderState[];
+    openFlowBuilder: (workflow: any, config?: any, externalVariables?: any[], formBuilderExtensions?: any[], flowBuilderExtensions?: any[]) => Promise<any>;
+    closeFlowBuilder: (id: number, result: any) => void;
+    runFlow: (workflow: any, context: any, formBuilderExtensions?: any[], flowBuilderExtensions?: any[]) => Promise<any>;
+};
+
+export declare const useFlowBuilder: () => ReturnType<UseFlowBuilder>;
+
+export declare type UseFormBuilder = () => {
+    formBuilderStack: any[];
+    openFormBuilder: (config?: any) => Promise<any>;
+    closeFormBuilder: (id: number, result: any) => void;
+};
+
+export declare const useFormBuilder: () => ReturnType<UseFormBuilder>;
+
+export declare type UseGoogleServiceAccountIntegration = (integrationId: string) => {
+    getGeoPoint: (address: string) => Promise<{
+        lat: number;
+        lng: number;
+    }>;
+};
+
+export declare const useGoogleServiceAccountIntegration: (integrationId: string) => {
+    getGeoPoint: (address: string) => Promise<{
+        lat: number;
+        lng: number;
+    }>;
+};
+
+export declare type UseIntegrationActionBuilder = () => {
+    showBuilder: (variableContext: Variable[], action?: any) => Promise<Object | null>;
+    onConfirm: (action: Object) => void;
+    onCancel: () => void;
+    builderState: Ref<BuilderState>;
+};
+
+export declare const useIntegrationActionBuilder: () => {
+    showBuilder: (variableContext: Variable[], action?: any) => Promise<Object | null>;
+    onConfirm: (action: Object) => void;
+    onCancel: () => void;
+    builderState: Ref<BuilderState>;
+};
+
+export declare type UseIntegrationActions = (integrationId: string) => {
+    fireAction: (action: any, variableContext: Record<string, any>) => Promise<any>;
+};
+
+export declare const useIntegrationActions: (integrationId: string) => {
+    fireAction: (action: any, variableContext: Record<string, any>) => Promise<any>;
+};
+
+export declare type UseIntegrations = () => {
+    getProjectIntegrations: (projectId: string) => Promise<any>;
+    getProjectIntegration: (projectId: string, integrationId: string) => Promise<any>;
+};
+
+export declare const useIntegrations: () => {
+    getProjectIntegrations: (projectId: string) => Promise<any>;
+    getProjectIntegration: (projectId: string, integrationId: string) => Promise<any>;
+};
+
+export { useLayout }
+
+export declare type UseLogs = () => {
+    log: (message: string, data?: any) => void;
+    logWarning: (message: string, data?: any) => void;
+    logError: (message: string, data?: any) => void;
+};
+
+export declare const useLogs: () => ReturnType<UseLogs>;
+
+export declare type UseMailer = (integrationId: string) => {
+    sendMail: (...opts: SendMailParams[]) => Promise<any>;
+};
+
+export declare const useMailer: (integrationId: string) => {
+    sendMail: (...opts: SendMailParams[]) => Promise<any>;
+};
+
+export declare type UseMediaLibrary = () => {
+    getMediaSources: (projectSlug: string) => Promise<any>;
+    getMediaSource: (projectSlug: string, sourceId: string) => Promise<any>;
+    createMediaSource: (projectSlug: string, params: MediaSourceCreateParams) => Promise<any>;
+    updateMediaSource: (projectSlug: string, sourceId: string, params: MediaSourceUpdateParams) => Promise<any>;
+    deleteMediaSource: (projectSlug: string, sourceId: string) => Promise<any>;
+    uploadFile: (sourceId: string, file: File, path?: string) => Promise<any>;
+    getStorageContent: (sourceId: string, path?: string) => Promise<any>;
+    deleteStorageFile: (sourceId: string, filePath: string) => Promise<any>;
+    renameStorageFile: (sourceId: string, fileUrl: string, oldPath: string, newName: string) => Promise<any>;
+    moveStorageFile: (sourceId: string, fileUrl: string, oldPath: string, newFolderPath: string) => Promise<any>;
+};
+
+export declare const useMediaLibrary: () => {
+    getMediaSources: (projectSlug: string) => Promise<any>;
+    getMediaSource: (projectSlug: string, sourceId: string) => Promise<any>;
+    createMediaSource: (projectSlug: string, params: MediaSourceCreateParams) => Promise<any>;
+    updateMediaSource: (projectSlug: string, sourceId: string, params: MediaSourceUpdateParams) => Promise<any>;
+    deleteMediaSource: (projectSlug: string, sourceId: string) => Promise<any>;
+    uploadFile: (sourceId: string, file: File, path?: string) => Promise<any>;
+    getStorageContent: (sourceId: string, path?: string) => Promise<any>;
+    deleteStorageFile: (sourceId: string, filePath: string) => Promise<any>;
+    renameStorageFile: (sourceId: string, fileUrl: string, oldPath: string, newName: string) => Promise<any>;
+    moveStorageFile: (sourceId: string, fileUrl: string, oldPath: string, newFolderPath: string) => Promise<any>;
+};
+
+export declare type UseModule = () => {
+    config: Record<string, any>;
+};
+
+export declare const useModule: () => ReturnType<UseModule>;
+
+export declare type UseModuleApi = () => {
+    get: <T = any>(path: string, options?: FetchOptions) => Promise<T>;
+    post: <T = any>(path: string, options?: FetchOptions) => Promise<T>;
+    patch: <T = any>(path: string, options?: FetchOptions) => Promise<T>;
+    del: <T = any>(path: string, options?: FetchOptions) => Promise<T>;
+};
+
+export declare const useModuleApi: () => {
+    get: <T = any>(path: string, options?: FetchOptions) => Promise<T>;
+    post: <T = any>(path: string, options?: FetchOptions) => Promise<T>;
+    patch: <T = any>(path: string, options?: FetchOptions) => Promise<T>;
+    del: <T = any>(path: string, options?: FetchOptions) => Promise<T>;
+};
+
+export declare type UseModuleBreadcrumbs = (factory: () => BreadcrumbItem[]) => {};
+
+export declare const useModuleBreadcrumbs: (factory: () => BreadcrumbItem[]) => {};
+
+export declare type UseModuleOverlay = () => {
+    openInOverlay: (moduleId: string, params?: Record<string, string>) => void;
+    overlayState: OverlayState;
+};
+
+export declare const useModuleOverlay: () => {
+    openInOverlay: (moduleId: string, params?: Record<string, string>) => void;
+    overlayState: OverlayState;
+};
+
+export declare type UseModulePermissions = () => {
+    isAdmin: () => boolean;
+    isSuperAdmin: () => boolean;
+    hasPermission: (permission: string) => boolean;
+    hasAnyPermission: (...permissions: string[]) => boolean;
+    hasEveryPermission: (...permissions: string[]) => boolean;
+};
+
+export declare const useModulePermissions: () => ReturnType<UseModulePermissions>;
+
+export declare type UseModuleRoute = () => {
+    navigateTo: (path?: string | number) => void;
+    projectId: string;
+    moduleId: string;
+    basePath: string;
+    params: Record<string, string>;
+    query: Record<string, string>;
+    pageComponent: any;
+};
+
+export declare const useModuleRoute: () => ReturnType<UseModuleRoute>;
+
+export declare type UseModuleStorage = () => {
+    getModuleData: (key: string) => any;
+    setModuleData: (key: string, value: any) => void;
+    removeModuleData: (key: string) => void;
+    clearModuleData: () => void;
+};
+
+export declare const useModuleStorage: () => ReturnType<UseModuleStorage>;
+
+export declare type UseOverlayParams = () => Ref<Record<string, any>>;
+
+export declare const useOverlayParams: () => Ref<Record<string, any>, Record<string, any>>;
+
+export declare type UseOverlayStack = () => {
+    stack: string[];
+    push(id: string): void;
+    pop(id: string): void;
+    isTop(id: string): boolean;
+};
+
+export declare const useOverlayStack: () => {
+    stack: string[];
+    push(id: string): void;
+    pop(id: string): void;
+    isTop(id: string): boolean;
+};
+
+export declare type UseProjectService = () => {};
+
+export declare const useProjectService: () => {};
+
+export declare type UseProjectSettings = () => {
+    project: any;
+    refreshProject: () => Promise<void>;
+    getTimezone: () => string;
+    getOffset: () => number;
+    getOffsetInMinutes: () => number;
+    formatDate: (date: string | Date) => string;
+    getCurrency: () => string;
+    formatCurrency: (amount: number, currency?: string) => string;
+};
+
+export declare const useProjectSettings: () => {
+    project: any;
+    refreshProject: () => Promise<void>;
+    getTimezone: () => string;
+    getOffset: () => number;
+    getOffsetInMinutes: () => number;
+    formatDate: (date: string | Date) => string;
+    getCurrency: () => string;
+    formatCurrency: (amount: number, currency?: string) => string;
+};
+
+export declare type UseQueryBuilder = () => {};
+
+export declare const useQueryBuilder: () => {};
+
+export declare type UseRoute = () => {
+    path: string;
+    fullPath: string;
+    name?: string | null;
+    params: Record<string, any>;
+    query: Record<string, any>;
+    hash: string;
+    meta?: Record<string, any>;
+    matched?: any[];
+};
+
+export declare const useRoute: () => {
+    path: string;
+    fullPath: string;
+    name?: string | null;
+    params: Record<string, any>;
+    query: Record<string, any>;
+    hash: string;
+    meta?: Record<string, any>;
+    matched?: any[];
+};
+
+export declare type UseRouter = () => {
+    push: (to: CmsRouterLocation) => Promise<any> | void;
+    replace: (to: CmsRouterLocation) => Promise<any> | void;
+    back: () => void;
+};
+
+export declare const useRouter: () => {
+    push: (to: CmsRouterLocation) => Promise<any> | void;
+    replace: (to: CmsRouterLocation) => Promise<any> | void;
+    back: () => void;
+};
+
+export { useRunProcess }
+
+export declare type UseUtilsService = () => {
+    urlToBase64: (url: string) => Promise<{
+        base64: string;
+        contentType: string;
+    }>;
+};
+
+export declare const useUtilsService: () => ReturnType<UseUtilsService>;
+
+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];
+};
+
+declare type ValueTypeFromSetting<TSetting extends ModuleSetting> = ArrayizeIfMultiple<ScalarForType<TSetting['type']>, TSetting>;
+
+declare interface Variable {
+    name: string;
+    type: string;
+    value: any;
+}
+
+export { }