All files / types/dist/schemas api.js

97.77% Statements 44/45
100% Branches 0/0
0% Functions 0/1
100% Lines 44/44

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383          16x         16x           16x         16x       16x         16x     16x       16x         16x       16x       16x     16x     16x       16x                                   16x               16x       16x           16x           16x     16x       16x         16x         16x       16x         16x                       16x 16x               16x     16x         16x 16x               16x         16x       16x   16x                           16x                 16x         16x       16x               16x         16x             16x     16x       16x                                                                                                                                                                                                                                                                                                    
import { z } from 'zod';
import { configurationsSchema, workspaceSchema, workspaceDetailsSchema, workspaceConfigSchema, siteConfigSchema, userPreferencesSchema, promptItemConfigSchema, instanceSettingsSchema, siteSettingsSchema, configLayerSchema, configPropertyMetadataSchema } from './config.js';
import { quiqrSiteRepoInfoSchema, hugoThemeRepoInfoSchema } from './embgit.js';
import { fieldSchema } from './fields.js';
// Schema for resolved preference with metadata
export const resolvedPreferenceSchema = z.object({
    value: z.unknown(),
    source: configLayerSchema,
    path: z.string()
});
export const collectionItemSchema = z.object({
    key: z.string(),
    label: z.string(),
    sortval: z.string().optional(),
    isPageBundle: z.boolean().optional()
});
export const languageSchema = z.object({
    source: z.string(),
    target: z.string(),
    lang: z.string()
});
export const fileReferenceSchema = z.object({
    src: z.string(),
    filename: z.string().optional()
});
export const frontMatterContentSchema = z.object({
    attributes: z.record(z.unknown()),
    body: z.string(),
    frontmatter: z.string().optional()
});
export const hugoServerResponseSchema = z.object({
    stopped: z.boolean()
});
export const hugoVersionCheckResponseSchema = z.object({
    installed: z.boolean(),
    version: z.string()
});
export const ssgVersionCheckResponseSchema = z.object({
    installed: z.boolean(),
    version: z.string(),
    ssgType: z.string()
});
export const ssgVersionsResponseSchema = z.object({
    ssgType: z.string(),
    versions: z.array(z.string())
});
export const collectionItemKeyResponseSchema = z.object({
    key: z.string().optional(),
    unavailableReason: z.enum(['already-exists']).optional()
});
export const folderDialogResponseSchema = z.object({
    selectedFolder: z.string().nullable()
});
export const deleteFileFromBundleResponseSchema = z.object({
    deleted: z.boolean()
});
export const uploadFileToBundlePathResponseSchema = z.object({
    uploadedPath: z.string(),
    newCollectionItemKey: z.string().optional()
});
export const communityTemplateSchema = z.object({
    HugoVersion: z.string(),
    HugoTheme: z.string(),
    QuiqrFormsEndPoints: z.number(),
    QuiqrModel: z.string(),
    QuiqrEtalageName: z.string(),
    QuiqrEtalageDescription: z.string(),
    QuiqrEtalageHomepage: z.string(),
    QuiqrEtalageDemoUrl: z.string(),
    QuiqrEtalageLicense: z.string(),
    QuiqrEtalageLicenseURL: z.string(),
    QuiqrEtalageAuthor: z.string(),
    QuiqrEtalageAuthorHomepage: z.string(),
    QuiqrEtalageScreenshots: z.array(z.string()),
    ScreenshotImageType: z.string(),
    SourceLink: z.string(),
    NormalizedName: z.string()
});
export const dynFormFieldsSchema = z.object({
    title: z.union([z.string(), z.number()]).optional(),
    fields: z.array(fieldSchema).nullable().optional(),
    key: z.string().optional(),
    content_type: z.string().optional(),
    form_field_type: z.string().optional()
});
// Parse info - tracks which files were used to build the workspace config
export const parseInfoIncludeFileSchema = z.object({
    key: z.string(),
    filename: z.string()
});
export const parseInfoSchema = z.object({
    baseFile: z.string(),
    includeFiles: z.array(parseInfoIncludeFileSchema),
    includeFilesSub: z.array(parseInfoIncludeFileSchema)
});
// Build action result - returned by buildSingle and buildCollectionItem
export const buildActionResultSchema = z.object({
    actionName: z.string(),
    stdoutType: z.string().optional(),
    stdoutContent: z.string()
});
// Collection item operation results
export const deleteCollectionItemResponseSchema = z.object({
    deleted: z.boolean()
});
export const renameCollectionItemResponseSchema = z.object({
    renamed: z.boolean(),
    item: collectionItemSchema.optional()
});
export const copyCollectionItemResponseSchema = z.object({
    copied: z.boolean(),
    item: collectionItemSchema.optional()
});
// Key pair response for createKeyPairGithub
export const keyPairResponseSchema = z.object({
    privateKey: z.string(),
    publicKey: z.string()
});
// Public key response for derivePublicKey
export const publicKeyResponseSchema = z.object({
    publicKey: z.string()
});
// AI Prompt schemas
export const llmUsageSchema = z.object({
    promptTokens: z.number(),
    completionTokens: z.number(),
    totalTokens: z.number()
}).nullable();
export const aiPromptResponseSchema = z.object({
    status: z.literal('ok'),
    response: z.string(),
    prompt: z.string().optional(),
    llm_settings: z.object({
        model: z.string(),
        temperature: z.number().optional()
    }).optional(),
    usage: llmUsageSchema.optional(),
    provider: z.string().optional()
});
// Logging schemas
export const logLevelSchema = z.enum(['debug', 'info', 'warning', 'error']);
export const baseLogEntrySchema = z.object({
    timestamp: z.string(),
    level: logLevelSchema,
    category: z.string(),
    message: z.string(),
    errorCode: z.string().optional(),
    metadata: z.record(z.unknown()).optional()
});
export const globalLogEntrySchema = baseLogEntrySchema.extend({
    type: z.literal('global')
});
export const siteLogEntrySchema = baseLogEntrySchema.extend({
    type: z.literal('site'),
    siteKey: z.string(),
    workspaceKey: z.string()
});
export const logEntrySchema = z.union([globalLogEntrySchema, siteLogEntrySchema]);
export const logQueryOptionsSchema = z.object({
    date: z.string().optional(),
    level: logLevelSchema.optional(),
    category: z.string().optional(),
    search: z.string().optional(),
    limit: z.number().optional(),
    offset: z.number().optional()
});
export const logQueryResultSchema = z.object({
    entries: z.array(logEntrySchema),
    total: z.number(),
    hasMore: z.boolean()
});
export const logDatesResultSchema = z.object({
    dates: z.array(z.string())
});
// Hugo config schema (flexible object)
export const hugoConfigSchema = z.record(z.unknown());
// Site inventory - returned by hugosite_dir_show
export const siteInventorySchema = z.object({
    dirExist: z.boolean(),
    dirName: z.string(),
    hugoConfigExists: z.boolean(),
    hugoConfigParsed: hugoConfigSchema.nullable(),
    hugoThemesDirExists: z.boolean(),
    hugoContentDirExists: z.boolean(),
    hugoDataDirExists: z.boolean(),
    hugoStaticDirExists: z.boolean(),
    quiqrModelDirExists: z.boolean(),
    quiqrFormsDirExists: z.boolean(),
    quiqrDirExists: z.boolean(),
    quiqrModelParsed: workspaceConfigSchema.nullable()
});
export const webMenuItemSchema = z.lazy(() => z.object({
    id: z.string(),
    type: z.enum(['normal', 'checkbox', 'separator', 'submenu']),
    label: z.string().optional(),
    checked: z.boolean().optional(),
    enabled: z.boolean().optional(),
    action: z.string().optional(),
    submenu: z.array(webMenuItemSchema).optional()
}));
export const webMenuDefinitionSchema = z.object({
    id: z.string(),
    label: z.string(),
    items: z.array(webMenuItemSchema)
});
export const webMenuStateSchema = z.object({
    menus: z.array(webMenuDefinitionSchema),
    version: z.number()
});
export const webMenuActionResultSchema = z.object({
    type: z.enum(['success', 'error', 'navigate', 'openDialog', 'info', 'openExternal', 'reload', 'logout', 'changePassword']),
    path: z.string().optional(),
    dialog: z.string().optional(),
    message: z.string().optional(),
    refresh: z.boolean().optional(),
    url: z.string().optional()
});
export const environmentInfoSchema = z.object({
    platform: z.enum(['macOS', 'windows', 'linux']),
    isPackaged: z.boolean()
});
// Scaffold model schemas
export const scaffoldResultSchema = z.object({
    success: z.boolean(),
    modelKey: z.string().optional(),
    modelPath: z.string().optional(),
    error: z.string().optional()
});
// Storage path schemas
export const setStoragePathRequestSchema = z.object({
    path: z.string()
});
export const getStoragePathResponseSchema = z.object({
    path: z.string()
});
// API Schemas mapping - maps API method names to their response schemas
export const apiSchemas = {
    // Workspace operations
    getConfigurations: configurationsSchema,
    listWorkspaces: z.array(workspaceSchema),
    getWorkspaceDetails: workspaceDetailsSchema,
    getWorkspaceModelParseInfo: parseInfoSchema,
    getPromptTemplateConfig: promptItemConfigSchema,
    processAiPrompt: aiPromptResponseSchema,
    updatePageFromAiResponse: z.record(z.unknown()),
    getFieldPromptTemplateConfig: promptItemConfigSchema,
    processFieldAiPrompt: aiPromptResponseSchema,
    getPreviewCheckConfiguration: z.unknown().nullable(),
    mountWorkspace: z.string(),
    serveWorkspace: z.void(),
    buildWorkspace: z.union([z.void(), z.string()]),
    // Single content operations
    getSingle: z.record(z.unknown()),
    updateSingle: z.record(z.unknown()),
    saveSingle: z.record(z.unknown()),
    openSingleInEditor: z.void(),
    buildSingle: buildActionResultSchema,
    // Collection operations
    listCollectionItems: z.array(collectionItemSchema),
    getCollectionItem: z.record(z.unknown()),
    updateCollectionItem: z.record(z.unknown()),
    createCollectionItemKey: collectionItemKeyResponseSchema,
    deleteCollectionItem: deleteCollectionItemResponseSchema,
    renameCollectionItem: renameCollectionItemResponseSchema,
    copyCollectionItem: copyCollectionItemResponseSchema,
    copyCollectionItemToLang: copyCollectionItemResponseSchema,
    makePageBundleCollectionItem: deleteCollectionItemResponseSchema, // Uses same shape: { deleted: boolean }
    buildCollectionItem: buildActionResultSchema,
    openFileDialogForCollectionItem: z.void(),
    // File operations
    parseFileToObject: z.unknown(),
    globSync: z.array(z.string()),
    getFilesInBundle: z.array(fileReferenceSchema),
    getFilesFromAbsolutePath: z.array(fileReferenceSchema),
    getThumbnailForPath: z.string().optional(),
    getThumbnailForCollectionOrSingleItemImage: z.string().optional(),
    uploadFileToBundlePath: uploadFileToBundlePathResponseSchema,
    deleteFileFromBundle: deleteFileFromBundleResponseSchema,
    openFileInEditor: z.void(),
    openFileExplorer: z.void(),
    // Site management
    getSiteConfig: siteConfigSchema,
    saveSiteConf: z.boolean(),
    copySite: z.boolean(),
    deleteSite: z.boolean(),
    checkFreeSiteName: z.boolean(),
    getCurrentSiteKey: z.string(),
    getCurrentBaseUrl: z.string(),
    getLanguages: z.array(languageSchema),
    getCreatorMessage: z.string(),
    // Site import/creation
    importSiteAction: z.void(), // ZIP-based import, no return value
    importSiteFromPrivateGitRepo: z.string(), // Returns siteKey
    importSiteFromPublicGitUrl: z.string(), // Returns siteKey
    newSiteFromPublicHugoThemeUrl: z.string(), // Returns siteKey
    newSiteFromLocalDirectory: z.string(), // Returns siteKey
    newSiteFromScratch: z.string(), // Returns siteKey
    // Git repository inspection
    quiqr_git_repo_show: quiqrSiteRepoInfoSchema,
    hugotheme_git_repo_show: hugoThemeRepoInfoSchema,
    hugosite_dir_show: siteInventorySchema,
    // Form state
    getDynFormFields: dynFormFieldsSchema.nullable().or(z.string()),
    shouldReloadForm: z.boolean(),
    getCurrentFormAccordionIndex: z.string(),
    setCurrentFormAccordionIndex: z.boolean(),
    getCurrentFormNodePath: z.string(),
    setCurrentFormNodePath: z.boolean(),
    reloadCurrentForm: z.boolean(),
    // Configuration and preferences
    readConfKey: z.union([
        userPreferencesSchema, // When reading "prefs"
        z.boolean(), // For boolean flags
        z.string().nullable(), // For currentUsername, sitesListingView
        z.record(z.string()), // For lastOpenedPublishTargetForSite
        z.object({
            siteKey: z.string().nullable(),
            workspaceKey: z.string().nullable(),
            sitePath: z.string().nullable()
        }) // For lastOpenedSite
    ]),
    readConfPrefKey: z.union([z.string(), z.boolean(), z.undefined()]),
    saveConfPrefKey: z.boolean(),
    matchRole: z.boolean(),
    invalidateCache: z.boolean(),
    getEnvironmentInfo: environmentInfoSchema,
    getStoragePath: getStoragePathResponseSchema,
    setStoragePath: z.boolean(),
    // Hugo operations
    stopHugoServer: hugoServerResponseSchema,
    getFilteredHugoVersions: z.array(z.string()),
    getHugoTemplates: z.never(),
    checkHugoVersion: hugoVersionCheckResponseSchema,
    // SSG operations
    checkSSGVersion: ssgVersionCheckResponseSchema,
    getFilteredSSGVersions: ssgVersionsResponseSchema,
    // Window management
    showLogWindow: z.object({ error: z.string(), stack: z.string() }).optional(),
    showMenuBar: z.boolean(),
    hideMenuBar: z.boolean(),
    redirectTo: z.boolean(),
    parentMountWorkspace: z.boolean(),
    reloadThemeStyle: z.object({ error: z.string(), stack: z.string() }).optional(),
    // External/shell operations
    openExternal: z.boolean(),
    openCustomCommand: z.never(),
    logToConsole: z.boolean(),
    // Sync/publish operations
    publisherDispatchAction: z.unknown(),
    createKeyPairGithub: keyPairResponseSchema,
    derivePublicKey: publicKeyResponseSchema,
    // Site library
    openSiteLibrary: z.boolean(),
    updateCommunityTemplates: z.array(communityTemplateSchema),
    showOpenFolderDialog: folderDialogResponseSchema,
    // Logging
    getApplicationLogs: logQueryResultSchema,
    getSiteLogs: logQueryResultSchema,
    getLogDates: logDatesResultSchema,
    // Menu operations (web mode)
    getMenuState: webMenuStateSchema,
    executeMenuAction: webMenuActionResultSchema,
    // Scaffold model operations
    scaffoldSingleFromFile: scaffoldResultSchema,
    scaffoldCollectionFromFile: scaffoldResultSchema,
    // Unified config operations
    getEffectivePreference: resolvedPreferenceSchema,
    getEffectivePreferences: userPreferencesSchema,
    setUserPreference: z.boolean(),
    setUserPreferences: z.boolean(),
    getAllPropertyMetadata: z.array(configPropertyMetadataSchema),
    getInstanceSettings: instanceSettingsSchema,
    getInstanceSetting: z.unknown(),
    updateInstanceSettings: z.boolean(),
    getSiteSettings: siteSettingsSchema,
    updateSiteSettings: z.boolean(),
    getCurrentUserId: z.string(),
    switchUser: z.boolean(),
    listUsers: z.array(z.string()),
    isExperimentalFeaturesEnabled: z.boolean(),
    executeCustomOpenCommand: z.boolean()
};