Variable: PreferencesSchemas

Makaio Framework

---

Makaio Framework / services-core/preferences/schemas / PreferencesSchemas

Variable: PreferencesSchemas

const PreferencesSchemas: object

Defined in: ../../../packages/services/core/src/preferences/schemas.ts:60

Preferences domain schemas.

Subjects for preference management via bus communication. Each key becomes a subject identifier as: preferences.{key}

Type Declaration

delete

delete: object

Delete a preference.

Subject: preferences.delete Type: Request (RPC)

delete.request

request: ZodObject<{ category: ZodString; key: ZodObject<{ context: ZodOptional<ZodString>; scope: ZodString; surface: ZodOptional<ZodEnum<{ app: "app"; ui: "ui"; }>>; viewport: ZodOptional<ZodEnum<{ desktop: "desktop"; mobile: "mobile"; tablet: "tablet"; }>>; }, $strip>; }, $strip>

delete.response

response: ZodObject<{ success: ZodBoolean; }, $strip>

get

get: object

Get a preference value.

Subject: preferences.get Type: Request (RPC)

Returns

The stored value or null if not found

get.request

request: ZodObject<{ category: ZodString; key: ZodObject<{ context: ZodOptional<ZodString>; scope: ZodString; surface: ZodOptional<ZodEnum<{ app: "app"; ui: "ui"; }>>; viewport: ZodOptional<ZodEnum<{ desktop: "desktop"; mobile: "mobile"; tablet: "tablet"; }>>; }, $strip>; }, $strip>

get.response

response: ZodObject<{ value: ZodNullable<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>; }, $strip>

list

list: object

List preferences matching criteria.

Subject: preferences.list Type: Request (RPC)

list.request

request: ZodObject<{ category: ZodOptional<ZodString>; key: ZodOptional<ZodObject<{ context: ZodOptional<ZodOptional<ZodString>>; scope: ZodOptional<ZodString>; surface: ZodOptional<ZodOptional<ZodEnum<{ app: …; ui: …; }>>>; viewport: ZodOptional<ZodOptional<ZodEnum<{ desktop: …; mobile: …; tablet: …; }>>>; }, $strip>>; }, $strip>

list.response

response: ZodObject<{ items: ZodArray<ZodObject<{ category: ZodString; key: ZodObject<{ context: ZodOptional<ZodString>; scope: ZodString; surface: ZodOptional<ZodEnum<…>>; viewport: ZodOptional<ZodEnum<…>>; }, $strip>; updatedAt: ZodNumber; value: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>; }, $strip>>; }, $strip>

set

set: object

Set a preference value.

Subject: preferences.set Type: Request (RPC)

set.request

request: ZodObject<{ category: ZodString; key: ZodObject<{ context: ZodOptional<ZodString>; scope: ZodString; surface: ZodOptional<ZodEnum<{ app: "app"; ui: "ui"; }>>; viewport: ZodOptional<ZodEnum<{ desktop: "desktop"; mobile: "mobile"; tablet: "tablet"; }>>; }, $strip>; value: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>; }, $strip>

set.response

response: ZodObject<{ success: ZodBoolean; }, $strip>