@sogni-ai/sogni-intelligence-client 2.1.0 → 2.2.1

package/dist-esm/schemas/prompt-contract.schema.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://sogni.ai/schemas/prompt-contract.schema.json",
+  "title": "PromptContract",
+  "description": "A PromptContract owns a tool's LLM-visible description and per-parameter docstrings. One contract per tool. Files in prompts/tools/*.json validate against this shape.",
+  "type": "object",
+  "required": ["contractId", "version", "toolName", "baseDescription", "parameterDocs"],
+  "additionalProperties": false,
+  "properties": {
+    "contractId": {
+      "type": "string",
+      "description": "Stable identifier for telemetry and registry lookup. Convention: <toolName>_v<n>."
+    },
+    "version": {
+      "type": "string",
+      "description": "Semver string. Bumped when the contract's data shape changes."
+    },
+    "toolName": {
+      "type": "string",
+      "description": "Tool the contract describes. Must match a registered tool name from enums/tool-names.json."
+    },
+    "baseDescription": {
+      "type": "string",
+      "description": "Default description shown to the LLM when this tool is visible."
+    },
+    "parameterDocs": {
+      "type": "object",
+      "description": "Per-parameter docstrings keyed by parameter name.",
+      "additionalProperties": { "type": "string" }
+    },
+    "voiceExamples": {
+      "type": "array",
+      "items": { "type": "string" },
+      "description": "Tool-specific voice or style examples (e.g. screenplay format for video)."
+    },
+    "conditionalNotes": {
+      "type": "object",
+      "description": "Conditional description fragments keyed by signal name. Appended to the baked description when the corresponding signal is present in the turn policy.",
+      "additionalProperties": { "type": "string" }
+    }
+  }
+}

package/dist-esm/schemas/tools/manage_memory.schema.json

@@ -0,0 +1,28 @@
+{
+  "title": "manage_memory tool schema",
+  "schemaVersion": "2026-05-17.1",
+  "description": "Save, read, or delete user preferences and facts that persist across conversations. Call with action \"write\" when user states a preference (\"I like watercolor style\", \"always use 16:9\"). Call with action \"read\" to recall preferences before generating. Call with action \"delete\" to remove a preference. Do NOT save transient requests — only persistent preferences.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["action"],
+  "properties": {
+    "action": {
+      "type": "string",
+      "enum": ["read", "write", "delete"],
+      "description": "Action to perform. \"read\": list all saved memories. \"write\": save or update a preference. \"delete\": remove a preference by key."
+    },
+    "key": {
+      "type": "string",
+      "description": "Unique key for the memory (e.g. \"preferred_style\", \"aspect_ratio\", \"quality_preference\"). Required for write and delete."
+    },
+    "value": {
+      "type": "string",
+      "description": "Value to save. Required for write action. Be concise but specific."
+    },
+    "category": {
+      "type": "string",
+      "enum": ["preference", "fact", "context"],
+      "description": "Memory category. \"preference\": style/format preferences. \"fact\": user facts (name, location). \"context\": project context. Default: \"preference\"."
+    }
+  }
+}

package/dist-esm/schemas/tools/resolve_personas.schema.json

@@ -0,0 +1,15 @@
+{
+  "title": "resolve_personas tool schema",
+  "schemaVersion": "2026-05-17.1",
+  "description": "Load persona reference photos AND voice clips for identity-preserving generation. Call this BEFORE edit_image when the user references a person from My Personas (e.g. \"make a picture of me\", \"draw Sarah and the kids\"). Also call this when the user explicitly asks to use a registered persona VOICE for video generation. Returns reference photos as numbered context images plus appearance descriptions. Voice clips are injected for animate_photo/generate_video, but you MUST set voicePersonaName on the video tool to use referenceAudioIdentity; do this only for explicit registered/reference voice requests, not ordinary dialogue or fictional character voices.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["names"],
+  "properties": {
+    "names": {
+      "type": "array",
+      "items": { "type": "string" },
+      "description": "Names of personas to load (case-insensitive). Must match names from the user's people list provided in the system message. Example: [\"Alex\", \"Sam\"]."
+    }
+  }
+}

package/dist-esm/schemas/tools/set_content_filter.schema.json

@@ -0,0 +1,14 @@
+{
+  "title": "set_content_filter tool schema",
+  "schemaVersion": "2026-05-17.1",
+  "description": "Enable or disable the Safe Content Filter. When enabled, generated images/videos are checked by the safety filter and blocked if flagged. When disabled, no safety filtering is applied. Only call this when the user explicitly asks to change the setting.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["enabled"],
+  "properties": {
+    "enabled": {
+      "type": "boolean",
+      "description": "Set to true to enable the safe content filter (default), or false to disable it."
+    }
+  }
+}

package/dist-esm/tools/definitions/generate-image/definition.js

@@ -58,7 +58,7 @@ VIDEO KEYFRAMES: When generating images intended as first+last frames for video
                 },
                 numberOfVariations: {
                     type: 'number',
-                    description: 'Number of variations (1-16). Use the user\'s exact requested count in one call whenever they ask for multiple images/options/takes/versions, including images that will feed a later video after the user picks one. For screenplay/storyboard batches, this must equal the scene count AND the prompt must contain one Dynamic Prompt branch with one full scene prompt per scene; never set numberOfVariations=N with only one scene prompt. Default: 1.',
+                    description: 'Number of variations (1-16). Set to the user\'s exact requested count in ONE call whenever they ask for multiple images. Trigger phrasings: "draw N", "make N", "give me N", "show me N", "render N", "create N", "generate N", "N more", "another N", "N as separate", "N separate images", "N different images", "N options", "N takes", "N versions", "N variations", "N pictures of", "all at the same time", "in parallel", "side by side as separate". NEVER split into multiple serial generate_image calls to make N images one at a time. If the user previously got a composite "N subjects in one image" result and now says "draw N more as separate images" / "as separate" / "separately", set numberOfVariations=N for THIS call — the prior call\'s numberOfVariations does NOT carry forward when the user explicitly asks for separation. For screenplay/storyboard batches, this must equal the scene count AND the prompt must contain one Dynamic Prompt branch with one full scene prompt per scene; never set numberOfVariations=N with only one scene prompt. Default: 1 ONLY when the user clearly wants a single composite image (e.g. "draw 2 goats in a meadow" with no separation language, or explicit "in one image" / "single image" / "composite" / "sheet").',
                     minimum: 1,
                     maximum: 16,
                 },

package/dist-esm/tools/definitions/generate-image/definition.js.map

@@ -1 +1 @@
-{"version":3,"file":"definition.js","sourceRoot":"","sources":["../../../../src/tools/definitions/generate-image/definition.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,uBAAuB,EAAE,MAAM,4CAA4C,CAAC;AACrF,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AAEnE,MAAM,CAAC,MAAM,UAAU,GAAmB;IACxC,IAAI,EAAE,UAAU;IAChB,QAAQ,EAAE;QACR,IAAI,EAAE,gBAAgB;QACtB,WAAW,EACT,ywBAAywB;QAC3wB,UAAU,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE;;EAErB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;siBAsB6gB;iBAC7hB;gBACD,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE;wBACJ,aAAa;wBACb,SAAS,EAAE,SAAS,EAAE,kBAAkB,EAAE,eAAe,EAAE,YAAY,EAAE,OAAO,EAAE,SAAS;wBAC3F,WAAW,EAAE,qBAAqB;wBAClC,WAAW,EAAE,cAAc,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,eAAe;wBAClF,mBAAmB,EAAE,mBAAmB,EAAE,eAAe,EAAE,cAAc;wBACzE,eAAe,EAAE,gBAAgB,EAAE,gBAAgB;qBACpD;oBACD,WAAW,EACT,ouCAAouC;iBACvuC;gBACD,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,2yBAA2yB;iBAC9yB;gBACD,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,4yBAA4yB;iBAC/yB;gBACD,kBAAkB,EAAE;oBAClB,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,4bAA4b;oBAC9b,OAAO,EAAE,CAAC;oBACV,OAAO,EAAE,EAAE;iBACZ;gBACD,cAAc,EAAE;oBACd,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,oJAAoJ;iBACvJ;gBACD,uBAAuB,EAAE;oBACvB,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,uXAAuX;iBAC1X;gBACD,gBAAgB,EAAE;oBAChB,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,sLAAsL;iBACzL;gBACD,IAAI,EAAE;oBACJ,IAAI,EAAE,SAAS;oBACf,WAAW,EACT,uIAAuI;iBAC1I;gBACD,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,2KAA2K;iBAC9K;gBACD,eAAe,EAAE;oBACf,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC;oBACvC,WAAW,EACT,kRAAkR;iBACrR;gBACD,YAAY,EAAE;oBACZ,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC;oBACpC,WAAW,EACT,uLAAuL;iBAC1L;gBACD,WAAW,EAAE;oBACX,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,GAAG,wBAAwB,glBAAglB;iBAC9mB;aACF;YACD,QAAQ,EAAE,CAAC,QAAQ,CAAC;SACrB;KACF;CACF,CAAC"}
+{"version":3,"file":"definition.js","sourceRoot":"","sources":["../../../../src/tools/definitions/generate-image/definition.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,uBAAuB,EAAE,MAAM,4CAA4C,CAAC;AACrF,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AAEnE,MAAM,CAAC,MAAM,UAAU,GAAmB;IACxC,IAAI,EAAE,UAAU;IAChB,QAAQ,EAAE;QACR,IAAI,EAAE,gBAAgB;QACtB,WAAW,EACT,ywBAAywB;QAC3wB,UAAU,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE;;EAErB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;siBAsB6gB;iBAC7hB;gBACD,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE;wBACJ,aAAa;wBACb,SAAS,EAAE,SAAS,EAAE,kBAAkB,EAAE,eAAe,EAAE,YAAY,EAAE,OAAO,EAAE,SAAS;wBAC3F,WAAW,EAAE,qBAAqB;wBAClC,WAAW,EAAE,cAAc,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,eAAe;wBAClF,mBAAmB,EAAE,mBAAmB,EAAE,eAAe,EAAE,cAAc;wBACzE,eAAe,EAAE,gBAAgB,EAAE,gBAAgB;qBACpD;oBACD,WAAW,EACT,ouCAAouC;iBACvuC;gBACD,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,2yBAA2yB;iBAC9yB;gBACD,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,4yBAA4yB;iBAC/yB;gBACD,kBAAkB,EAAE;oBAClB,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,guCAAguC;oBACluC,OAAO,EAAE,CAAC;oBACV,OAAO,EAAE,EAAE;iBACZ;gBACD,cAAc,EAAE;oBACd,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,oJAAoJ;iBACvJ;gBACD,uBAAuB,EAAE;oBACvB,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,uXAAuX;iBAC1X;gBACD,gBAAgB,EAAE;oBAChB,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,sLAAsL;iBACzL;gBACD,IAAI,EAAE;oBACJ,IAAI,EAAE,SAAS;oBACf,WAAW,EACT,uIAAuI;iBAC1I;gBACD,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,2KAA2K;iBAC9K;gBACD,eAAe,EAAE;oBACf,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC;oBACvC,WAAW,EACT,kRAAkR;iBACrR;gBACD,YAAY,EAAE;oBACZ,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC;oBACpC,WAAW,EACT,uLAAuL;iBAC1L;gBACD,WAAW,EAAE;oBACX,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,GAAG,wBAAwB,glBAAglB;iBAC9mB;aACF;YACD,QAAQ,EAAE,CAAC,QAAQ,CAAC;SACrB;KACF;CACF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sogni-ai/sogni-intelligence-client",
-  "version": "2.1.0",
+  "version": "2.2.1",
   "description": "Public Sogni Intelligence client — Node.js convenience wrapper for the Sogni SDK plus the public-safe subset of @sogni/creative-agent contracts (ContractRegistry, AssetManifest, RunRecord, tool envelopes). For agent builders, third-party integrations, and downstream SDKs.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -173,6 +173,7 @@
   "homepage": "https://github.com/Sogni-AI/sogni-intelligence-client#readme",
   "dependencies": {
     "@sogni-ai/sogni-client": "5.0.0-alpha.6",
+    "@sogni-ai/sogni-protocol": "^1.0.0-alpha.2",
     "sharp": "^0.34.5"
   },
   "devDependencies": {