@sparkelf/dsh-dataops-managed 0.3.3 → 0.3.4

package/lib/types/model-settings.d.ts

@@ -0,0 +1,64 @@
+/** Model configuration one workspace publishes and another adopts. */
+import type { Context } from '@deepseek-ai/cordis';
+/** Profile entry id whose Config holds the model providers. */
+export declare const MODEL_SETTINGS_NAMESPACE = "llm-pi-ai";
+/** One provider profile as the settings document holds it. */
+type ProviderProfile = Record<string, unknown>;
+/** Model configuration read from, or written to, the local settings document. */
+export interface ModelSettingsSnapshot {
+    /** Providers keyed by provider id. */
+    providers: Record<string, ProviderProfile>;
+    /** Revision the read observed; a write must present it back. */
+    revision: number | undefined;
+}
+/**
+ * Read the models this workspace currently holds.
+ *
+ * A missing section is an empty result rather than an error: a fresh workspace has never
+ * opened the models page, and that is the normal state for the first user to arrive.
+ * @param ctx - DSH Host context carrying the settings service.
+ * @returns Provider profiles and the revision the read observed.
+ */
+export declare function readModels(ctx: Context): ModelSettingsSnapshot;
+/**
+ * Collect every model id a workspace holds, grouped by provider.
+ * @param providers - Provider profiles to walk.
+ * @returns Model ids offered by each provider.
+ */
+export declare function modelIdsByProvider(providers: Record<string, ProviderProfile>): Record<string, string[]>;
+/**
+ * Narrow published providers to the models their publisher offers.
+ *
+ * The publisher decides which of its models other users may use; a model it kept private is
+ * dropped here, so it is never written into a reader's settings at all.
+ * @param providers - Published provider profiles.
+ * @param sharedModelIds - Model ids the publisher offers.
+ * @returns Providers holding only the offered models.
+ */
+export declare function selectSharedModels(providers: Record<string, ProviderProfile>, sharedModelIds: readonly string[]): Record<string, ProviderProfile>;
+/**
+ * Merge adopted provider profiles into the ones a workspace already holds.
+ *
+ * A provider the user already has keeps its own models and gains the adopted ones that are
+ * missing, so adopting never removes a model the user configured. The user's own entry for a
+ * model wins on conflict: that is what keeps a local edit from being overwritten.
+ * @param local - Providers the workspace holds now.
+ * @param adopted - Providers the publisher offers.
+ * @returns Providers to write, and whether anything changed.
+ */
+export declare function mergeProviders(local: Record<string, ProviderProfile>, adopted: Record<string, ProviderProfile>): {
+    providers: Record<string, ProviderProfile>;
+    changed: boolean;
+};
+/**
+ * Write provider profiles into this workspace's settings.
+ *
+ * The write presents the revision the read observed. A settings service that has moved on
+ * refuses it with its own conflict error, which the caller surfaces rather than retrying:
+ * silently overwriting a concurrent edit is exactly what this feature must not do.
+ * @param ctx - DSH Host context carrying the settings service.
+ * @param providers - Providers to store.
+ * @param revision - Revision from the read this write is based on.
+ */
+export declare function writeModels(ctx: Context, providers: Record<string, ProviderProfile>, revision: number | undefined): Promise<void>;
+export {};

package/lib/types/model-sync.d.ts

@@ -0,0 +1,145 @@
+/** Adopt, publish, and stop following the model configuration another workspace offers. */
+import type { Context } from '@deepseek-ai/cordis';
+/** This plugin's own profile entry id, which owns the sync state. */
+export declare const SYNC_NAMESPACE = "dataops-managed";
+/** Whether this workspace follows the publisher, or keeps what its user wrote. */
+export type FollowState = 'following' | 'detached';
+/** What this workspace remembers between runs. */
+export interface SyncState {
+    /** The user here chose their own models, so adoption stops for them. */
+    detached: boolean;
+    /** Model ids adoption last wrote, so a later edit can be told apart from one of them. */
+    adoptedModelIds: string[];
+    /** Model ids the administrator keeps private; every other model is offered by default. */
+    privateModelIds: string[];
+}
+/** Read and write this workspace's sync state. */
+export interface SyncStateStore {
+    /** @returns The stored state, or defaults before anything was stored. */
+    read(): SyncState;
+    /** @param next - State to store. */
+    write(next: SyncState): Promise<void>;
+}
+/** Configuration the host half receives from the profile. */
+export interface SyncConfig {
+    /** DataOps browser/API origin reachable from the DSH Host. */
+    baseUrl: string;
+    /** DSH credential reference holding the current DataOps access JWT. */
+    credentialRef: string;
+}
+/** What the settings UI reads to describe the current state. */
+export interface SyncStatus {
+    /** Whether this workspace currently follows a publisher. */
+    followState: FollowState;
+    /** Whether an administrator currently offers models to this workspace. */
+    publisherSharing: boolean;
+    /** How many models this workspace adopts from the publisher. */
+    adoptedCount: number;
+    /** Model ids the administrator keeps private. */
+    privateModelIds: string[];
+    /** Publication time reported by the publisher, when one is sharing. */
+    publishedAt: string | null;
+    /** Whether the current user may change what this workspace shares. */
+    canPublish: boolean;
+    /** Models this workspace holds, and whether each is offered to other users. */
+    models: {
+        id: string;
+        shared: boolean;
+    }[];
+}
+/**
+ * Own the model-sync state one workspace keeps.
+ *
+ * The state lives in this workspace rather than in DataOps, because whether a user has written
+ * their own models is a fact about this workspace. Keeping it here is also what makes the
+ * promise hold across restarts: a user who chose their own models is not adopted again.
+ */
+export declare class ModelSync {
+    private readonly ctx;
+    private readonly config;
+    private readonly store;
+    constructor(ctx: Context, config: SyncConfig, store: SyncStateStore);
+    /**
+     * Read the DataOps JWT this workspace is currently authorized with.
+     * @returns The token, or undefined when the workspace has no session yet.
+     */
+    private token;
+    /** The DataOps API origin this workspace reports to. */
+    private apiBase;
+    /**
+     * Fetch the publication this workspace may adopt.
+     * @returns The published snapshot, or undefined when the workspace is not authorized.
+     */
+    private fetchPublished;
+    /**
+     * The models this workspace offers to others.
+     *
+     * Every model is offered unless the administrator marked it private, which is what makes a
+     * newly added model shared without an extra step.
+     * @param providers - Providers this workspace holds.
+     * @param privateModelIds - Model ids kept private.
+     * @returns Model ids to offer.
+     */
+    private offeredModelIds;
+    /**
+     * Report this workspace's models to DataOps as a publication.
+     *
+     * Called when an administrator turns sharing on, or edits their models while it is on. The
+     * workspace stays the owner of the configuration; DataOps stores only this copy.
+     * @param sharingEnabled - Whether sharing is on.
+     */
+    publish(sharingEnabled: boolean): Promise<void>;
+    /**
+     * Read the current user's own publication state and whether they may change it.
+     *
+     * The permission rule lives in DataOps; the browser only displays what this reports, so
+     * nothing in the page decides who is an administrator.
+     * @returns The state, or null when the workspace is not authorized.
+     */
+    readOwnState(): Promise<{
+        sharingEnabled: boolean;
+        canPublish: boolean;
+    } | null>;
+    /**
+     * Record which models the administrator keeps private.
+     * @param privateModelIds - Model ids not offered to other users.
+     * @param sharingEnabled - Whether sharing is on, so the change reaches readers now.
+     */
+    setPrivateModels(privateModelIds: readonly string[], sharingEnabled: boolean): Promise<void>;
+    /**
+     * Adopt the published models into this workspace.
+     *
+     * Does nothing when the user here writes their own models, which is what keeps a local edit
+     * from being replaced by the publisher's version. Otherwise it merges: models the workspace
+     * lacks are added, and a model it already holds is left exactly as it is.
+     * @returns Adopted provider profiles, or null when nothing was adopted.
+     */
+    adopt(): Promise<Record<string, Record<string, unknown>> | null>;
+    /**
+     * Whether this workspace holds models adoption did not put there.
+     *
+     * A model the workspace has now and adoption did not write is the user's own, so adopting
+     * again would discard their work. An empty record means adoption never ran here, and the
+     * first pass must not read the workspace's existing models as an edit.
+     * @param current - Providers the workspace holds now.
+     * @param adoptedModelIds - Model ids adoption last wrote.
+     * @returns True when the workspace holds something adoption did not write.
+     */
+    private editedSinceAdoption;
+    /**
+     * Stop following the publisher and keep what this workspace holds now.
+     *
+     * A user who chose their own models must not be pulled back, so this choice is stored and
+     * survives the next start.
+     */
+    detach(): Promise<void>;
+    /**
+     * Follow the publisher again, adopting its models on the next pass.
+     */
+    resumeFollowing(): Promise<void>;
+    /**
+     * Describe the current state for the settings UI.
+     * @returns The sync state, whether the viewer may publish, and their own models.
+     */
+    status(): Promise<SyncStatus>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sparkelf/dsh-dataops-managed",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "description": "DataOps JWT intake and credential-backed MCP tools for managed DeepSeek Harness workspaces.",
   "type": "module",
   "main": "./lib/index.js",
@@ -42,6 +42,11 @@
     "README.md",
     "LICENSE"
   ],
+  "scripts": {
+    "build": "rm -rf lib && tsc -p tsconfig.build.json && tsdown",
+    "bundle": "tsdown",
+    "prepack": "pnpm run build"
+  },
   "engines": {
     "node": "^22.19.0 || >=24.0.0"
   },
@@ -56,41 +61,39 @@
   },
   "peerDependencies": {
     "@deepseek-ai/cordis": "^4.0.4",
-    "@deepseek-ai/dsh-credentials": "0.1.7-rc.2",
-    "@deepseek-ai/dsh-host-webserver": "0.1.7-rc.2",
     "@deepseek-ai/dsh-client-locale": "0.1.7-rc.2",
+    "@deepseek-ai/dsh-client-ui-conversation": "0.1.7-rc.2",
     "@deepseek-ai/dsh-client-ui-primitives": "0.1.7-rc.2",
+    "@deepseek-ai/dsh-client-ui-renderer": "0.1.7-rc.2",
     "@deepseek-ai/dsh-client-ui-settings": "0.1.7-rc.2",
+    "@deepseek-ai/dsh-client-ui-sidebar": "0.1.7-rc.2",
     "@deepseek-ai/dsh-client-ui-slots": "0.1.7-rc.2",
+    "@deepseek-ai/dsh-credentials": "0.1.7-rc.2",
+    "@deepseek-ai/dsh-host-webserver": "0.1.7-rc.2",
+    "@deepseek-ai/dsh-settings": "0.1.7-rc.2",
     "@deepseek-ai/dsh-tools": "0.1.7-rc.2",
     "@deepseek-ai/schemastery": ">=3.18.1",
     "@sparkelf/dsh-plugin-mcp-credentials": ">=0.1.0-rc.14",
-    "react": ">=18.2.0 <20",
-    "@deepseek-ai/dsh-client-ui-renderer": "0.1.7-rc.2",
-    "@deepseek-ai/dsh-client-ui-conversation": "0.1.7-rc.2",
-    "@deepseek-ai/dsh-client-ui-sidebar": "0.1.7-rc.2"
+    "react": ">=18.2.0 <20"
   },
   "devDependencies": {
     "@deepseek-ai/cordis": "4.0.4",
-    "@deepseek-ai/dsh-credentials": "0.1.7-rc.2",
-    "@deepseek-ai/dsh-host-webserver": "0.1.7-rc.2",
     "@deepseek-ai/dsh-client-locale": "0.1.7-rc.2",
+    "@deepseek-ai/dsh-client-ui-conversation": "0.1.7-rc.2",
     "@deepseek-ai/dsh-client-ui-primitives": "0.1.7-rc.2",
+    "@deepseek-ai/dsh-client-ui-renderer": "0.1.7-rc.2",
     "@deepseek-ai/dsh-client-ui-settings": "0.1.7-rc.2",
+    "@deepseek-ai/dsh-client-ui-sidebar": "0.1.7-rc.2",
     "@deepseek-ai/dsh-client-ui-slots": "0.1.7-rc.2",
+    "@deepseek-ai/dsh-credentials": "0.1.7-rc.2",
+    "@deepseek-ai/dsh-host-webserver": "0.1.7-rc.2",
+    "@deepseek-ai/dsh-settings": "0.1.7-rc.2",
     "@deepseek-ai/dsh-tools": "0.1.7-rc.2",
     "@deepseek-ai/schemastery": "3.18.2",
     "@sparkelf/dsh-plugin-mcp-credentials": "0.1.0-rc.14",
     "@types/react": "~18.3.1",
     "lightningcss": "^1.32.0",
     "react": "^18.2.0",
-    "tsdown": "^0.22.2",
-    "@deepseek-ai/dsh-client-ui-renderer": "0.1.7-rc.2",
-    "@deepseek-ai/dsh-client-ui-conversation": "0.1.7-rc.2",
-    "@deepseek-ai/dsh-client-ui-sidebar": "0.1.7-rc.2"
-  },
-  "scripts": {
-    "build": "rm -rf lib && tsc -p tsconfig.build.json && tsdown",
-    "bundle": "tsdown"
+    "tsdown": "^0.22.2"
   }
-}
+}