@luv1211/dsh-pet 0.1.1-rc.2

package/lib/types/index.d.ts

@@ -0,0 +1,114 @@
+/**
+ * Global desktop-pet domain: durable user preferences and a live,
+ * session-event-derived activity read model for companion clients.
+ * @module @luv1211/dsh-pet
+ */
+import type { Context } from '@deepseek-ai/cordis';
+import z from '@deepseek-ai/schemastery';
+import { TypertRemoteService } from '@deepseek-ai/dsh-typert-protocol';
+import { type PetCatalogOptions } from './catalog.ts';
+import type { PetFolderResult, PetImportResult, PetSnapshot, PetCatalog } from './types.ts';
+export type * from './types.ts';
+export type * from './renderer.ts';
+export { DEFAULT_PET_ID, DEFAULT_PET_SIZE_PX, MAX_PET_SIZE_PX, MIN_PET_SIZE_PX, PET_PREFERENCE_VERSION, comparePetActivities, defaultPetPreference, isDragMovement, petStatusForHostActivity, petWidthForSize, resolvePetPreference, selectLookDirection, selectPetPresentation, validatePetSize, validatePetPackage, } from './runtime.ts';
+export { petSpriteAvatar, petSpriteFrame } from './renderer.ts';
+declare module '@deepseek-ai/cordis' {
+    interface Context {
+        pets: PetService;
+    }
+}
+/** Host configuration for the DSH-owned package root and validation limits. */
+export interface Config extends PetCatalogOptions {
+}
+/** Pet service (`ctx.pets`): one durable preference writer and activity aggregator. */
+export declare class PetService extends TypertRemoteService {
+    static inject: string[];
+    static Config: z<Config>;
+    private readonly scope;
+    private preference;
+    private readonly catalogStore;
+    private catalog;
+    private readonly activities;
+    private tail;
+    constructor(ctx: Context, config?: Config);
+    /**
+     * The host-native operations the current composition provides. Resolved
+     * per access, not captured at construction: the `petNative` provider mounts
+     * as a later tree row than this service, and the composed directory picker
+     * can also enter the context later. An explicit `petNative` provider wins;
+     * otherwise the actions derive from the composed directory picker when it
+     * serves the native backend.
+     * @returns the native operations, or `undefined` in browser-only compositions.
+     */
+    private get nativeActions();
+    /**
+     * Read the latest durable preference and every current activity record.
+     * @returns a detached, deterministically ordered snapshot.
+     */
+    getSnapshot(): PetSnapshot;
+    /**
+     * Read the current validated built-in and user package descriptors.
+     * @returns a detached catalog of validated package descriptors.
+     */
+    getCatalog(): PetCatalog;
+    /**
+     * Import one validated package selected by the native host, without accepting a client path.
+     * @returns the publication, cancellation, or host-availability result.
+     */
+    importPetPackage(): Promise<PetImportResult>;
+    /**
+     * Rescan the user package root and republish the catalog, so packages added
+     * or removed on disk appear without a restart.
+     * @returns the fresh snapshot after the rescan.
+     */
+    refreshCatalog(): PetSnapshot;
+    /**
+     * Replace one existing user package's content with bytes selected by the
+     * native host. The picked manifest must name the requested package, and a
+     * mismatch or a non-user target fails before anything is written.
+     * @param petId - user package identifier to replace.
+     * @returns the replacement, cancellation, or host-availability result.
+     */
+    updatePetPackage(petId: string): Promise<PetImportResult>;
+    /**
+     * Ask the native host to open the configured DSH pet directory.
+     * @returns the opened or host-availability result.
+     */
+    openPetFolder(): Promise<PetFolderResult>;
+    /**
+     * Select a built-in or previously imported pet package.
+     * @param selectedPetId - non-empty package identifier.
+     * @returns the committed fresh snapshot.
+     */
+    selectPet(selectedPetId: string): Promise<PetSnapshot>;
+    /**
+     * Persist one validated logical CSS height for the selected companion.
+     * @param sizePx - logical CSS height between the configured pet limits.
+     * @returns the committed fresh snapshot.
+     */
+    setSize(sizePx: number): Promise<PetSnapshot>;
+    /**
+     * Wake or tuck the selected companion.
+     * @param awake - whether companion clients render the selected pet awake.
+     * @returns the committed fresh snapshot.
+     */
+    setAwake(awake: boolean): Promise<PetSnapshot>;
+    /**
+     * Serve the companion page's one awake write (`POST {awake: boolean}`),
+     * answering with the committed snapshot so the page applies it immediately.
+     * The cross-site write fence matches the API gateway: only the JSON media
+     * type is accepted, which forces a CORS preflight this loopback server never
+     * answers, so a "simple" cross-site POST cannot tuck the pet blind.
+     * @param req - the raw request; method, media type, and body are validated here.
+     * @param res - the raw response; every failure path answers a status without a body.
+     */
+    private handleOverlayAwake;
+    /** Replace the local adapter state from one detached host projection. */
+    private applyActivity;
+    /** Serialize one preference write and return only after durable persistence. */
+    private commit;
+    /** Publish a detached read model after a preference commit or activity transition. */
+    private publish;
+}
+export default PetService;
+//# sourceMappingURL=index.d.ts.map