@uniformdev/mesh-edgehancer-sdk 20.32.0 → 20.32.1-alpha.3

package/dist/index.mjs

@@ -1,3 +1,86 @@
+// ../../lib/ai-sdk/src/InvocationContexts.ts
+import { z } from "zod";
+var invocationContextsSchema = z.enum([
+  "composition",
+  "compositionPattern",
+  "componentPattern",
+  "entry",
+  "entryPattern",
+  "general"
+]);
+var invocationContextInfoSchema = z.object({
+  context: invocationContextsSchema,
+  id: z.string(),
+  displayName: z.string().optional(),
+  icon: z.string().optional()
+});
+var invocationContextAnnotationSchema = z.object({
+  type: z.literal("invocationContext"),
+  value: invocationContextInfoSchema
+});
+
+// ../../lib/ai-sdk/src/toolDefinitions/editing/createPropertyEdit.ts
+import { z as z2 } from "zod";
+var createPropertyEdit = {
+  displayName: "Create Property Edit",
+  description: "Edits a property on a composition, entry, or pattern with AI. This is a callable tool NOT FOR AGENT USE - agents use applyPropertyEdit to broker client-side application of the edit.",
+  inputSchema: z2.object({
+    edit: z2.string().describe("Describe the edit to be made to the property"),
+    currentValue: z2.unknown().describe("Current value of the property (if any exists)").optional(),
+    projectGuidance: z2.string().describe("Guidance prompt for the project (if any exists)").optional(),
+    componentGuidance: z2.string().describe("Guidance prompt for the parent component").optional(),
+    audienceGuidance: z2.string().describe(
+      "Guidance prompt for the target audience of a personalized variation. Omit for non-variation edits."
+    ).optional(),
+    propertyDefinition: z2.object({
+      id: z2.string(),
+      name: z2.string(),
+      type: z2.string(),
+      guidance: z2.string().describe("Guidance prompt from the property definition (if any exists)").optional(),
+      typeConfig: z2.unknown().optional().describe("Type-specific configuration for the property")
+    }),
+    outputLocale: z2.string().optional().describe("The locale to use when writing the edited value"),
+    documentContext: z2.string().describe("Content of the surrounding document the property is part of").optional()
+  }),
+  outputSchema: z2.object({
+    newValue: z2.string().describe(
+      "The new value of the property. When the action is clear or resetOverride, this should be empty."
+    ),
+    treatNewValueAsJson: z2.boolean().describe("Whether the newValue is a JSON string"),
+    summary: z2.string().describe(
+      "A completion message to the user that summarizes the action taken. This should be 1 sentence, in English."
+    ).optional(),
+    action: z2.enum(["setValue", "clearValue", "resetOverride"]).describe(
+      "setValue = update the value, clearValue = remove the value/set to empty, resetOverride = remove a pattern override and inherit the pattern value. Only use resetOverride if the prompt asks for it."
+    ),
+    success: z2.boolean().describe("Whether the edit could be completed successfully")
+  }),
+  runsAt: "server",
+  timeout: 100,
+  callable: true
+};
+
+// src/afterAIEdit.ts
+import { z as z3 } from "zod";
+var afterAIEditResultSchema = z3.strictObject({
+  newValue: z3.unknown(),
+  success: z3.boolean(),
+  summary: z3.string().optional()
+});
+var afterAIEditContextSchema = z3.strictObject({
+  editRequest: createPropertyEdit.inputSchema,
+  invocationContext: invocationContextsSchema,
+  userId: z3.string(),
+  currentLocale: z3.string().optional(),
+  projectId: z3.string(),
+  currentValue: z3.unknown().optional(),
+  newValue: z3.unknown(),
+  result: z3.object({
+    success: z3.boolean(),
+    summary: z3.string().optional()
+  })
+});
+
 // src/batchUtils.ts
 function convertBatchResultsToEdgehancerResult({
   batch,
@@ -57,6 +140,22 @@ var COLLECTION_DEFAULT_LIMIT = 20;
 var COLLECTION_MAX_LIMIT = 50;
 var COLLECTION_DEFAULT_OFFSET = 0;
 
+// src/createAIEdit.ts
+import { z as z4 } from "zod";
+var createAIEditContextSchema = z4.strictObject({
+  editRequest: createPropertyEdit.inputSchema,
+  invocationContext: invocationContextsSchema,
+  userId: z4.string(),
+  currentLocale: z4.string().optional(),
+  projectId: z4.string()
+});
+var createAIEditResultSchema = z4.strictObject({
+  outputJsonSchema: z4.record(z4.string(), z4.any()).describe("JSON schema (draft-07) for the edited content result"),
+  instructions: z4.string().describe(
+    "Instructions for the AI editor LLM to follow (e.g. conventions/rules, allowed values, etc). Just describe your value type, do not give guiding instructions. There is no need to worry about clearing or resetting values, that is automatically handled."
+  )
+});
+
 // src/fetchUtils.ts
 function getDataResourceAsRequest(data) {
   var _a;
@@ -96,78 +195,78 @@ function copyKeyValuePairs(source, target) {
 }
 
 // src/preRequest.ts
-import { z as z2 } from "zod";
+import { z as z6 } from "zod";
 
 // src/shared.ts
 import { assert } from "tsafe";
-import { z } from "zod";
-var parameterDefinitionSchema = z.object({
-  key: z.string(),
-  value: z.string(),
-  omitIfEmpty: z.boolean().optional()
+import { z as z5 } from "zod";
+var parameterDefinitionSchema = z5.object({
+  key: z5.string(),
+  value: z5.string(),
+  omitIfEmpty: z5.boolean().optional()
 });
-var resolvingIssueSchema = z.union([
-  z.string(),
-  z.object({
-    message: z.string(),
-    subType: z.enum(["unpublishedData", "configuration"]).optional(),
-    issueReference: z.string().optional(),
-    deepLink: z.string().optional()
+var resolvingIssueSchema = z5.union([
+  z5.string(),
+  z5.object({
+    message: z5.string(),
+    subType: z5.enum(["unpublishedData", "configuration"]).optional(),
+    issueReference: z5.string().optional(),
+    deepLink: z5.string().optional()
   })
 ]);
-var variableDefinitionSchema = z.object({
-  displayName: z.string().optional(),
-  type: z.string().optional(),
-  default: z.string(),
-  helpText: z.string().optional(),
-  order: z.number().optional(),
-  source: z.string().optional()
+var variableDefinitionSchema = z5.object({
+  displayName: z5.string().optional(),
+  type: z5.string().optional(),
+  default: z5.string(),
+  helpText: z5.string().optional(),
+  order: z5.number().optional(),
+  source: z5.string().optional()
 });
-var customEdgehancerDefinitionSchema = z.object({
-  preRequest: z.string().optional(),
-  request: z.string().optional()
+var customEdgehancerDefinitionSchema = z5.object({
+  preRequest: z5.string().optional(),
+  request: z5.string().optional()
 });
-var dataSourceVariantSchema = z.intersection(
-  z.object({
-    headers: z.array(parameterDefinitionSchema).optional(),
-    parameters: z.array(parameterDefinitionSchema).optional(),
-    variables: z.record(variableDefinitionSchema).optional()
+var dataSourceVariantSchema = z5.intersection(
+  z5.object({
+    headers: z5.array(parameterDefinitionSchema).optional(),
+    parameters: z5.array(parameterDefinitionSchema).optional(),
+    variables: z5.record(variableDefinitionSchema).optional()
   }),
-  z.object({ url: z.string() })
+  z5.object({ url: z5.string() })
 );
-var mergedDataTypeSchema = z.object({
-  id: z.string(),
-  displayName: z.string(),
-  archetype: z.string().optional(),
-  allowedOnComponents: z.array(z.string()).optional(),
-  badgeIconUrl: z.string().optional(),
-  connectorType: z.string(),
-  url: z.string(),
-  headers: z.array(parameterDefinitionSchema).optional(),
-  parameters: z.array(parameterDefinitionSchema).optional(),
-  body: z.string().optional(),
-  method: z.enum(["GET", "POST", "HEAD"]),
-  variables: z.record(variableDefinitionSchema).optional(),
-  custom: z.record(z.unknown()).optional(),
-  customPublic: z.record(z.unknown()).optional(),
-  ttl: z.number().optional(),
-  purgeKey: z.string().optional(),
-  localeMapping: z.record(z.string()).optional(),
+var mergedDataTypeSchema = z5.object({
+  id: z5.string(),
+  displayName: z5.string(),
+  archetype: z5.string().optional(),
+  allowedOnComponents: z5.array(z5.string()).optional(),
+  badgeIconUrl: z5.string().optional(),
+  connectorType: z5.string(),
+  url: z5.string(),
+  headers: z5.array(parameterDefinitionSchema).optional(),
+  parameters: z5.array(parameterDefinitionSchema).optional(),
+  body: z5.string().optional(),
+  method: z5.enum(["GET", "POST", "HEAD"]),
+  variables: z5.record(variableDefinitionSchema).optional(),
+  custom: z5.record(z5.unknown()).optional(),
+  customPublic: z5.record(z5.unknown()).optional(),
+  ttl: z5.number().optional(),
+  purgeKey: z5.string().optional(),
+  localeMapping: z5.record(z5.string()).optional(),
   edgehancer: customEdgehancerDefinitionSchema.optional(),
-  uiBadgeText: z.string().max(12).optional(),
-  variants: z.object({
+  uiBadgeText: z5.string().max(12).optional(),
+  variants: z5.object({
     unpublished: dataSourceVariantSchema.optional()
   }).optional(),
-  enableUnpublishedMode: z.boolean().optional()
+  enableUnpublishedMode: z5.boolean().optional()
 });
 assert();
-var dataResourceSchema = z.union([
-  z.string(),
-  z.object({}).catchall(z.unknown()),
-  z.number(),
-  z.boolean(),
-  z.array(z.unknown()),
-  z.undefined()
+var dataResourceSchema = z5.union([
+  z5.string(),
+  z5.object({}).catchall(z5.unknown()),
+  z5.number(),
+  z5.boolean(),
+  z5.array(z5.unknown()),
+  z5.undefined()
 ]);
 
 // src/preRequest.ts
@@ -180,39 +279,43 @@ var edgehancerMergedDataTypeSchema = mergedDataTypeSchema.omit({
   purgeKey: true,
   variables: true
 });
-var preRequestEdgehancerDataResourceResultSchema = z2.strictObject({
-  errors: z2.array(resolvingIssueSchema).optional(),
-  warnings: z2.array(resolvingIssueSchema).optional(),
-  infos: z2.array(resolvingIssueSchema).optional(),
+var preRequestEdgehancerDataResourceResultSchema = z6.strictObject({
+  errors: z6.array(resolvingIssueSchema).optional(),
+  warnings: z6.array(resolvingIssueSchema).optional(),
+  infos: z6.array(resolvingIssueSchema).optional(),
   dataResource: edgehancerMergedDataTypeSchema
 });
-var preRequestEdgehancerResultSchema = z2.strictObject({
-  dataResources: z2.array(preRequestEdgehancerDataResourceResultSchema)
+var preRequestEdgehancerResultSchema = z6.strictObject({
+  dataResources: z6.array(preRequestEdgehancerDataResourceResultSchema)
 });
 
 // src/request.ts
-import { z as z3 } from "zod";
-var requestEdgehancerDataResourceResolutionResultSchema = z3.strictObject({
-  errors: z3.array(resolvingIssueSchema).optional().describe(
+import { z as z7 } from "zod";
+var requestEdgehancerDataResourceResolutionResultSchema = z7.strictObject({
+  errors: z7.array(resolvingIssueSchema).optional().describe(
     "Errors that occurred while running your code to return with the API response, if any. Unhandled exceptions will be captured automatically."
   ),
-  warnings: z3.array(resolvingIssueSchema).optional().describe("Warnings that occurred while running your code to return with the API response, if any."),
-  infos: z3.array(resolvingIssueSchema).optional().describe(
+  warnings: z7.array(resolvingIssueSchema).optional().describe("Warnings that occurred while running your code to return with the API response, if any."),
+  infos: z7.array(resolvingIssueSchema).optional().describe(
     "Informational messages that occurred while running your code to return with the API response, if any."
   ),
-  surrogateKeys: z3.array(z3.string()).optional().describe(
+  surrogateKeys: z7.array(z7.string()).optional().describe(
     "Extra surrogate keys for the data that was fetched. These act as auxiliary cache keys that can allow granular purging of cached data."
   ),
   result: dataResourceSchema.describe("The result of fetching the data resource")
 });
-var requestEdgehancerResultSchema = z3.strictObject({
-  results: z3.array(requestEdgehancerDataResourceResolutionResultSchema)
+var requestEdgehancerResultSchema = z7.strictObject({
+  results: z7.array(requestEdgehancerDataResourceResolutionResultSchema)
 });
 export {
   COLLECTION_DEFAULT_LIMIT,
   COLLECTION_DEFAULT_OFFSET,
   COLLECTION_MAX_LIMIT,
+  afterAIEditContextSchema,
+  afterAIEditResultSchema,
   convertBatchResultsToEdgehancerResult,
+  createAIEditContextSchema,
+  createAIEditResultSchema,
   dataResourceSchema,
   edgehancerMergedDataTypeSchema,
   getDataResourceAsRequest,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/mesh-edgehancer-sdk",
-  "version": "20.32.0",
+  "version": "20.32.1-alpha.3+c30c2f2b0d",
   "description": "Uniform Mesh Edgehancer SDK",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -48,7 +48,7 @@
     "/dist"
   ],
   "dependencies": {
-    "@uniformdev/canvas": "20.32.0",
+    "@uniformdev/canvas": "20.32.1-alpha.3+c30c2f2b0d",
     "tsafe": "1.6.6",
     "zod": "3.23.8"
   },
@@ -61,5 +61,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5e94bba0b8d4295cdb77a7f72196849412da96c6"
+  "gitHead": "c30c2f2b0de9d99e7c038dba9b941039f2c18a39"
 }