@case-framework/survey-assistant 0.4.0 → 0.6.0

package/docs/integration.md

@@ -122,6 +122,40 @@ Only the active provider's secret is required. `SURVEY_ASSISTANT_ENABLED` is an
 optional operational override; provider, model, role, memory, request-limit, and
 execution policy remains document-owned.
 
+#### Optional experimental-identity rollout gate
+
+Importing hosts can pass `requireExperimentalIdentityOptIn: true` as a third
+argument to either configuration parser:
+
+```ts
+const config = parseSurveyAssistantConfigurationDocument(document, process.env, {
+  requireExperimentalIdentityOptIn: true,
+});
+```
+
+This adds a second, explicit production rollout gate. Outside development, an
+otherwise enabled assistant then remains disabled until the deployment also
+sets:
+
+```dotenv
+SURVEY_ASSISTANT_ALLOW_EXPERIMENTAL_IDENTITY=true
+```
+
+The environment variable alone does not enable the assistant. Enablement must
+still be requested by `enabled: true` in the configuration document or by
+`SURVEY_ASSISTANT_ENABLED=true`; an explicit
+`SURVEY_ASSISTANT_ENABLED=false` still disables it. In development, the extra
+opt-in is not required.
+
+Despite its historical name, this option does not select, create, or authorize
+an identity. Request identity and access remain controlled by the host's
+authorization callbacks. A production host with a complete authenticated-host
+integration should normally omit the parser option, unless it deliberately
+wants this additional deployment switch. Use it when a host still exposes an
+experimental client-request identity path, or when that extra production
+rollout gate is desired. If the parser option is omitted (the default),
+`SURVEY_ASSISTANT_ALLOW_EXPERIMENTAL_IDENTITY` has no effect.
+
 The shared option keys are `parallelToolCalls`, `reasoningEffort`,
 `reasoningSummary`, `promptCacheKey`, `promptCacheRetention`, `serviceTier`, and
 `textVerbosity`. Provider validation rejects known-incompatible combinations;
@@ -282,9 +316,9 @@ bounded lifecycle evidence, not an authorization input.
 
 ## Attachments
 
-Uploads remain enabled by default for PDF, GIF, JPEG, PNG, and WebP. The server
-checks request size, count, per-file and total bytes, filename controls, data
-URL/media-type agreement, and common file signatures before provider use.
+Uploads remain enabled by default for PDF, JPEG, and PNG. The server checks
+request size, count, per-file and total bytes, filename controls,
+data URL/media-type agreement, and common file signatures before provider use.
 
 Passing `threadDocuments` enables persistence and safe replay in later turns.
 Passing `false` to the lifecycle means only persistence/replay is disabled;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@case-framework/survey-assistant",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Shared protocol, engine, and runtime for the CASE survey assistant.",
   "license": "ISC",
   "files": [
@@ -131,7 +131,7 @@
     "ai": "^7.0.52",
     "react": ">=19.2.0",
     "react-dom": ">=19.2.0",
-    "@case-framework/survey-core": "0.6.2"
+    "@case-framework/survey-core": "^0.6.2"
   },
   "peerDependenciesMeta": {
     "@mastra/ai-sdk": {

package/dist/authoring-references-yyYC4Ydi.mjs

@@ -1,98 +0,0 @@
-import path, { resolve } from "node:path";
-import { fileURLToPath } from "node:url";
-import { readFileSync } from "node:fs";
-//#region ../../node_modules/.pnpm/tsdown@0.21.10_synckit@0.11.13_typescript@6.0.3/node_modules/tsdown/esm-shims.js
-const getFilename = () => fileURLToPath(import.meta.url);
-const getDirname = () => path.dirname(getFilename());
-const __dirname = /* @__PURE__ */ getDirname();
-//#endregion
-//#region src/server/authoring-references.ts
-const loadReference = (fileName) => readFileSync(resolve(__dirname, "references", fileName), "utf8").trim();
-const surveyAuthoringReferenceTopics = [
-	"core-rules",
-	"survey-data-model",
-	"source-material-surveys",
-	"localization",
-	"rich-text-content",
-	"item-types",
-	"embedded-forms",
-	"expressions",
-	"assistant-operations",
-	"fair-by-design",
-	"survey-quality"
-];
-const ITEM_TYPE_SECTION_HEADINGS = {
-	group: "group",
-	"page-break": "page-break",
-	infoItem: "infoItem",
-	choiceItem: "choiceItem",
-	formItem: "formItem"
-};
-const builtInSurveyAuthoringItemTypes = Object.freeze(Object.keys(ITEM_TYPE_SECTION_HEADINGS));
-const extractLevelTwoSection = (markdown, heading) => {
-	const lines = markdown.split("\n");
-	const sectionStart = lines.findIndex((line) => line.trim() === `## ${heading}`);
-	if (sectionStart < 0) return;
-	const nextSectionOffset = lines.slice(sectionStart + 1).findIndex((line) => line.startsWith("## "));
-	const sectionEnd = nextSectionOffset < 0 ? lines.length : sectionStart + 1 + nextSectionOffset;
-	return lines.slice(sectionStart, sectionEnd).join("\n").trim();
-};
-const surveyAuthoringReferences = {
-	"core-rules": {
-		title: "Core authoring rules",
-		content: loadReference("core-rules.md")
-	},
-	"survey-data-model": {
-		title: "Survey data model",
-		content: loadReference("survey-data-model.md")
-	},
-	"source-material-surveys": {
-		title: "Source-material survey implementation",
-		content: loadReference("source-material-surveys.md")
-	},
-	localization: {
-		title: "Survey localization",
-		content: loadReference("localization.md")
-	},
-	"rich-text-content": {
-		title: "Rich text content",
-		content: loadReference("rich-text-content.md")
-	},
-	"item-types": {
-		title: "Item types",
-		content: loadReference("item-types.md")
-	},
-	"embedded-forms": {
-		title: "Choice option embedded forms",
-		content: loadReference("embedded-forms.md")
-	},
-	expressions: {
-		title: "Expressions",
-		content: loadReference("expressions.md")
-	},
-	"assistant-operations": {
-		title: "Assistant operations",
-		content: loadReference("assistant-operations.md")
-	},
-	"fair-by-design": {
-		title: "FAIR-by-design survey authoring",
-		content: loadReference("fair-by-design.md")
-	},
-	"survey-quality": {
-		title: "Survey quality review",
-		content: loadReference("survey-quality.md")
-	}
-};
-const getBuiltInItemTypeAuthoringReference = (itemType) => {
-	const heading = ITEM_TYPE_SECTION_HEADINGS[itemType];
-	if (!heading) return;
-	const content = extractLevelTwoSection(surveyAuthoringReferences["item-types"].content, heading);
-	return content ? {
-		title: `${heading} item type`,
-		content
-	} : void 0;
-};
-//#endregion
-export { surveyAuthoringReferences as i, getBuiltInItemTypeAuthoringReference as n, surveyAuthoringReferenceTopics as r, builtInSurveyAuthoringItemTypes as t };
-
-//# sourceMappingURL=authoring-references-yyYC4Ydi.mjs.map

package/dist/authoring-references-yyYC4Ydi.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"authoring-references-yyYC4Ydi.mjs","names":[],"sources":["../../../node_modules/.pnpm/tsdown@0.21.10_synckit@0.11.13_typescript@6.0.3/node_modules/tsdown/esm-shims.js","../src/server/authoring-references.ts"],"sourcesContent":["// Shim globals in esm bundle\nimport path from 'node:path'\nimport { fileURLToPath } from 'node:url'\n\nconst getFilename = () => fileURLToPath(import.meta.url)\nconst getDirname = () => path.dirname(getFilename())\n\nexport const __dirname = /* @__PURE__ */ getDirname()\nexport const __filename = /* @__PURE__ */ getFilename()\n","import { readFileSync } from \"node:fs\";\nimport { resolve } from \"node:path\";\n\nconst loadReference = (fileName: string) =>\n  readFileSync(resolve(__dirname, \"references\", fileName), \"utf8\").trim();\n\nexport const surveyAuthoringReferenceTopics = [\n  \"core-rules\",\n  \"survey-data-model\",\n  \"source-material-surveys\",\n  \"localization\",\n  \"rich-text-content\",\n  \"item-types\",\n  \"embedded-forms\",\n  \"expressions\",\n  \"assistant-operations\",\n  \"fair-by-design\",\n  \"survey-quality\",\n] as const;\n\nexport type SurveyAuthoringReferenceTopic = (typeof surveyAuthoringReferenceTopics)[number];\n\nconst ITEM_TYPE_SECTION_HEADINGS: Readonly<Record<string, string>> = {\n  group: \"group\",\n  \"page-break\": \"page-break\",\n  infoItem: \"infoItem\",\n  choiceItem: \"choiceItem\",\n  formItem: \"formItem\",\n};\n\nexport const builtInSurveyAuthoringItemTypes = Object.freeze(\n  Object.keys(ITEM_TYPE_SECTION_HEADINGS),\n);\n\nconst extractLevelTwoSection = (markdown: string, heading: string): string | undefined => {\n  const lines = markdown.split(\"\\n\");\n  const sectionStart = lines.findIndex((line) => line.trim() === `## ${heading}`);\n  if (sectionStart < 0) {\n    return undefined;\n  }\n\n  const nextSectionOffset = lines\n    .slice(sectionStart + 1)\n    .findIndex((line) => line.startsWith(\"## \"));\n  const sectionEnd = nextSectionOffset < 0 ? lines.length : sectionStart + 1 + nextSectionOffset;\n\n  return lines.slice(sectionStart, sectionEnd).join(\"\\n\").trim();\n};\n\nexport const surveyAuthoringReferences = {\n  \"core-rules\": {\n    title: \"Core authoring rules\",\n    content: loadReference(\"core-rules.md\"),\n  },\n  \"survey-data-model\": {\n    title: \"Survey data model\",\n    content: loadReference(\"survey-data-model.md\"),\n  },\n  \"source-material-surveys\": {\n    title: \"Source-material survey implementation\",\n    content: loadReference(\"source-material-surveys.md\"),\n  },\n  localization: {\n    title: \"Survey localization\",\n    content: loadReference(\"localization.md\"),\n  },\n  \"rich-text-content\": {\n    title: \"Rich text content\",\n    content: loadReference(\"rich-text-content.md\"),\n  },\n  \"item-types\": {\n    title: \"Item types\",\n    content: loadReference(\"item-types.md\"),\n  },\n  \"embedded-forms\": {\n    title: \"Choice option embedded forms\",\n    content: loadReference(\"embedded-forms.md\"),\n  },\n  expressions: {\n    title: \"Expressions\",\n    content: loadReference(\"expressions.md\"),\n  },\n  \"assistant-operations\": {\n    title: \"Assistant operations\",\n    content: loadReference(\"assistant-operations.md\"),\n  },\n  \"fair-by-design\": {\n    title: \"FAIR-by-design survey authoring\",\n    content: loadReference(\"fair-by-design.md\"),\n  },\n  \"survey-quality\": {\n    title: \"Survey quality review\",\n    content: loadReference(\"survey-quality.md\"),\n  },\n} as const satisfies Record<SurveyAuthoringReferenceTopic, { title: string; content: string }>;\n\nexport const getBuiltInItemTypeAuthoringReference = (\n  itemType: string,\n): { title: string; content: string } | undefined => {\n  const heading = ITEM_TYPE_SECTION_HEADINGS[itemType];\n  if (!heading) {\n    return undefined;\n  }\n\n  const content = extractLevelTwoSection(surveyAuthoringReferences[\"item-types\"].content, heading);\n  return content ? { title: `${heading} item type`, content } : undefined;\n};\n"],"x_google_ignoreList":[0],"mappings":";;;;AAIA,MAAM,oBAAoB,cAAc,OAAO,KAAK,IAAI;AACxD,MAAM,mBAAmB,KAAK,QAAQ,aAAa,CAAC;AAEpD,MAAa,YAA4B,4BAAY;;;ACJrD,MAAM,iBAAiB,aACrB,aAAa,QAAQ,WAAW,cAAc,SAAS,EAAE,OAAO,CAAC,MAAM;AAEzE,MAAa,iCAAiC;CAC5C;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD;AAID,MAAM,6BAA+D;CACnE,OAAO;CACP,cAAc;CACd,UAAU;CACV,YAAY;CACZ,UAAU;CACX;AAED,MAAa,kCAAkC,OAAO,OACpD,OAAO,KAAK,2BAA2B,CACxC;AAED,MAAM,0BAA0B,UAAkB,YAAwC;CACxF,MAAM,QAAQ,SAAS,MAAM,KAAK;CAClC,MAAM,eAAe,MAAM,WAAW,SAAS,KAAK,MAAM,KAAK,MAAM,UAAU;AAC/E,KAAI,eAAe,EACjB;CAGF,MAAM,oBAAoB,MACvB,MAAM,eAAe,EAAE,CACvB,WAAW,SAAS,KAAK,WAAW,MAAM,CAAC;CAC9C,MAAM,aAAa,oBAAoB,IAAI,MAAM,SAAS,eAAe,IAAI;AAE7E,QAAO,MAAM,MAAM,cAAc,WAAW,CAAC,KAAK,KAAK,CAAC,MAAM;;AAGhE,MAAa,4BAA4B;CACvC,cAAc;EACZ,OAAO;EACP,SAAS,cAAc,gBAAgB;EACxC;CACD,qBAAqB;EACnB,OAAO;EACP,SAAS,cAAc,uBAAuB;EAC/C;CACD,2BAA2B;EACzB,OAAO;EACP,SAAS,cAAc,6BAA6B;EACrD;CACD,cAAc;EACZ,OAAO;EACP,SAAS,cAAc,kBAAkB;EAC1C;CACD,qBAAqB;EACnB,OAAO;EACP,SAAS,cAAc,uBAAuB;EAC/C;CACD,cAAc;EACZ,OAAO;EACP,SAAS,cAAc,gBAAgB;EACxC;CACD,kBAAkB;EAChB,OAAO;EACP,SAAS,cAAc,oBAAoB;EAC5C;CACD,aAAa;EACX,OAAO;EACP,SAAS,cAAc,iBAAiB;EACzC;CACD,wBAAwB;EACtB,OAAO;EACP,SAAS,cAAc,0BAA0B;EAClD;CACD,kBAAkB;EAChB,OAAO;EACP,SAAS,cAAc,oBAAoB;EAC5C;CACD,kBAAkB;EAChB,OAAO;EACP,SAAS,cAAc,oBAAoB;EAC5C;CACF;AAED,MAAa,wCACX,aACmD;CACnD,MAAM,UAAU,2BAA2B;AAC3C,KAAI,CAAC,QACH;CAGF,MAAM,UAAU,uBAAuB,0BAA0B,cAAc,SAAS,QAAQ;AAChG,QAAO,UAAU;EAAE,OAAO,GAAG,QAAQ;EAAa;EAAS,GAAG,KAAA"}