@uniformdev/mesh-edgehancer-sdk 20.36.0 → 20.36.1-alpha.1

package/dist/index.js

@@ -33,7 +33,15 @@ __export(src_exports, {
   COLLECTION_DEFAULT_LIMIT: () => COLLECTION_DEFAULT_LIMIT,
   COLLECTION_DEFAULT_OFFSET: () => COLLECTION_DEFAULT_OFFSET,
   COLLECTION_MAX_LIMIT: () => COLLECTION_MAX_LIMIT,
+  afterAIDataResourceEditContextSchema: () => afterAIDataResourceEditContextSchema,
+  afterAIDataResourceEditResultSchema: () => afterAIDataResourceEditResultSchema,
+  afterAIEditContextSchema: () => afterAIEditContextSchema,
+  afterAIEditResultSchema: () => afterAIEditResultSchema,
   convertBatchResultsToEdgehancerResult: () => convertBatchResultsToEdgehancerResult,
+  createAIDataResourceEditContextSchema: () => createAIDataResourceEditContextSchema,
+  createAIDataResourceEditResultSchema: () => createAIDataResourceEditResultSchema,
+  createAIEditContextSchema: () => createAIEditContextSchema,
+  createAIEditResultSchema: () => createAIEditResultSchema,
   dataResourceSchema: () => dataResourceSchema,
   edgehancerMergedDataTypeSchema: () => edgehancerMergedDataTypeSchema,
   getDataResourceAsRequest: () => getDataResourceAsRequest,
@@ -50,6 +58,126 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
+// ../../lib/ai-sdk/src/InvocationContexts.ts
+var z = __toESM(require("zod"), 1);
+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
+});
+
+// src/afterAIDataResourceEdit.ts
+var z2 = __toESM(require("zod"));
+var afterAIDataResourceEditResultSchema = z2.strictObject({
+  newValue: z2.record(z2.string(), z2.string()),
+  success: z2.boolean(),
+  summary: z2.string().optional()
+});
+var afterAIDataResourceEditContextSchema = z2.strictObject({
+  /**
+   * The the data type of the data resource being edited (merged with its data source)
+   * NOTE: this can contain secrets, API keys, etc. Do not directly expose it to the AI agent!
+   * NOTE: this does not include the current value's variables, if any
+   */
+  mergedDataType: z2.custom(),
+  /** Which data source variant is currently active (undefined = published data) */
+  dataSourceVariant: z2.custom().optional(),
+  /** The edit request details */
+  editRequest: z2.object({
+    /** The edit instruction from the AI agent */
+    edit: z2.string(),
+    /** Current value of the data resource's variables (if any) */
+    currentValue: z2.record(z2.string(), z2.string()).optional()
+  }),
+  /** AI invocation context */
+  invocationContext: invocationContextsSchema,
+  /** User ID making the edit */
+  userId: z2.string(),
+  /** Project ID */
+  projectId: z2.string(),
+  /** The new value generated by AI */
+  newValue: z2.record(z2.string(), z2.string()),
+  /** The result from the AI editing process */
+  result: z2.object({
+    success: z2.boolean(),
+    summary: z2.string().optional()
+  })
+});
+
+// ../../lib/ai-sdk/src/toolDefinitions/editing/createPropertyEdit.ts
+var z3 = __toESM(require("zod"), 1);
+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: z3.object({
+    edit: z3.string().describe("Describe the edit to be made to the property"),
+    currentValue: z3.unknown().describe("Current value of the property (if any exists)").optional(),
+    projectGuidance: z3.string().describe("Guidance prompt for the project (if any exists)").optional(),
+    componentGuidance: z3.string().describe("Guidance prompt for the parent component").optional(),
+    audienceGuidance: z3.string().describe(
+      "Guidance prompt for the target audience of a personalized variation. Omit for non-variation edits."
+    ).optional(),
+    propertyDefinition: z3.object({
+      id: z3.string(),
+      name: z3.string(),
+      type: z3.string(),
+      guidance: z3.string().describe("Guidance prompt from the property definition (if any exists)").optional(),
+      typeConfig: z3.unknown().optional().describe("Type-specific configuration for the property")
+    }),
+    outputLocale: z3.string().optional().describe("The locale to use when writing the edited value"),
+    documentContext: z3.string().describe("Content of the surrounding document the property is part of").optional()
+  }),
+  outputSchema: z3.object({
+    newValue: z3.string().describe(
+      "The new value of the property. When the action is clear or resetOverride, this should be empty."
+    ),
+    treatNewValueAsJson: z3.boolean().describe("Whether the newValue is a JSON string"),
+    summary: z3.string().describe(
+      "A completion message to the user that summarizes the action taken. This should be 1 sentence, in English."
+    ).optional(),
+    action: z3.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: z3.boolean().describe("Whether the edit could be completed successfully")
+  }),
+  runsAt: "server",
+  timeout: 100,
+  callable: true
+};
+
+// src/afterAIEdit.ts
+var z4 = __toESM(require("zod"));
+var afterAIEditResultSchema = z4.strictObject({
+  newValue: z4.unknown(),
+  success: z4.boolean(),
+  summary: z4.string().optional()
+});
+var afterAIEditContextSchema = z4.strictObject({
+  editRequest: createPropertyEdit.inputSchema,
+  invocationContext: invocationContextsSchema,
+  userId: z4.string(),
+  currentLocale: z4.string().optional(),
+  projectId: z4.string(),
+  newValue: z4.unknown(),
+  result: z4.object({
+    success: z4.boolean(),
+    summary: z4.string().optional()
+  })
+});
+
 // src/batchUtils.ts
 function convertBatchResultsToEdgehancerResult({
   batch,
@@ -109,6 +237,54 @@ var COLLECTION_DEFAULT_LIMIT = 20;
 var COLLECTION_MAX_LIMIT = 50;
 var COLLECTION_DEFAULT_OFFSET = 0;
 
+// src/createAIDataResourceEdit.ts
+var z5 = __toESM(require("zod"));
+var createAIDataResourceEditContextSchema = z5.strictObject({
+  /**
+   * The the data type of the data resource being edited (merged with its data source)
+   * NOTE: this can contain secrets, API keys, etc. Do not directly expose it to the AI agent!
+   * NOTE: this does not include the current value's variables, if any
+   */
+  mergedDataType: z5.custom(),
+  /** Which data source variant is currently active (undefined = published data) */
+  dataSourceVariant: z5.custom().optional(),
+  /** The edit request details */
+  editRequest: z5.object({
+    /** The edit instruction from the AI agent */
+    edit: z5.string(),
+    /** Current value of the data resource's variables (if any) */
+    currentValue: z5.record(z5.string(), z5.string()).optional()
+  }),
+  /** AI invocation context */
+  invocationContext: invocationContextsSchema,
+  /** User ID making the edit */
+  userId: z5.string(),
+  /** Project ID */
+  projectId: z5.string()
+});
+var createAIDataResourceEditResultSchema = z5.strictObject({
+  outputJsonSchema: z5.record(z5.string(), z5.any()).describe("JSON schema (draft-07) for the edited data resource result"),
+  instructions: z5.string().describe(
+    "Instructions for the AI editor LLM to follow when editing this data resource (e.g. conventions/rules, allowed values, data format expectations, etc). Describe how to transform or edit the data resource content."
+  )
+});
+
+// src/createAIEdit.ts
+var z6 = __toESM(require("zod"));
+var createAIEditContextSchema = z6.strictObject({
+  editRequest: createPropertyEdit.inputSchema,
+  invocationContext: invocationContextsSchema,
+  userId: z6.string(),
+  currentLocale: z6.string().optional(),
+  projectId: z6.string()
+});
+var createAIEditResultSchema = z6.strictObject({
+  outputJsonSchema: z6.record(z6.string(), z6.any()).describe("JSON schema (draft-07) for the edited content result"),
+  instructions: z6.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;
@@ -148,78 +324,80 @@ function copyKeyValuePairs(source, target) {
 }
 
 // src/preRequest.ts
-var z2 = __toESM(require("zod"));
+var z8 = __toESM(require("zod"));
 
 // src/shared.ts
 var import_tsafe = require("tsafe");
-var z = __toESM(require("zod"));
-var parameterDefinitionSchema = z.object({
-  key: z.string(),
-  value: z.string(),
-  omitIfEmpty: z.boolean().optional()
+var z7 = __toESM(require("zod"));
+var parameterDefinitionSchema = z7.object({
+  key: z7.string(),
+  value: z7.string(),
+  omitIfEmpty: z7.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 = z7.union([
+  z7.string(),
+  z7.object({
+    message: z7.string(),
+    subType: z7.enum(["unpublishedData", "configuration"]).optional(),
+    issueReference: z7.string().optional(),
+    deepLink: z7.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 = z7.object({
+  displayName: z7.string().optional(),
+  type: z7.string().optional(),
+  default: z7.string(),
+  helpText: z7.string().optional(),
+  order: z7.number().optional(),
+  source: z7.string().optional()
 });
-var customEdgehancerDefinitionSchema = z.object({
-  preRequest: z.string().optional(),
-  request: z.string().optional()
+var customEdgehancerDefinitionSchema = z7.object({
+  preRequest: z7.string().optional(),
+  request: z7.string().optional(),
+  createAIDataResourceEdit: z7.string().optional(),
+  afterAIDataResourceEdit: z7.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 = z7.intersection(
+  z7.object({
+    headers: z7.array(parameterDefinitionSchema).optional(),
+    parameters: z7.array(parameterDefinitionSchema).optional(),
+    variables: z7.record(variableDefinitionSchema).optional()
   }),
-  z.object({ url: z.string() })
+  z7.object({ url: z7.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 = z7.object({
+  id: z7.string(),
+  displayName: z7.string(),
+  archetype: z7.string().optional(),
+  allowedOnComponents: z7.array(z7.string()).optional(),
+  badgeIconUrl: z7.string().optional(),
+  connectorType: z7.string(),
+  url: z7.string(),
+  headers: z7.array(parameterDefinitionSchema).optional(),
+  parameters: z7.array(parameterDefinitionSchema).optional(),
+  body: z7.string().optional(),
+  method: z7.enum(["GET", "POST", "HEAD"]),
+  variables: z7.record(variableDefinitionSchema).optional(),
+  custom: z7.record(z7.unknown()).optional(),
+  customPublic: z7.record(z7.unknown()).optional(),
+  ttl: z7.number().optional(),
+  purgeKey: z7.string().optional(),
+  localeMapping: z7.record(z7.string()).optional(),
   edgehancer: customEdgehancerDefinitionSchema.optional(),
-  uiBadgeText: z.string().max(12).optional(),
-  variants: z.object({
+  uiBadgeText: z7.string().max(12).optional(),
+  variants: z7.object({
     unpublished: dataSourceVariantSchema.optional()
   }).optional(),
-  enableUnpublishedMode: z.boolean().optional()
+  enableUnpublishedMode: z7.boolean().optional()
 });
 (0, import_tsafe.assert)();
-var dataResourceSchema = z.union([
-  z.string(),
-  z.object({}).catchall(z.unknown()),
-  z.number(),
-  z.boolean(),
-  z.array(z.unknown()),
-  z.undefined()
+var dataResourceSchema = z7.union([
+  z7.string(),
+  z7.object({}).catchall(z7.unknown()),
+  z7.number(),
+  z7.boolean(),
+  z7.array(z7.unknown()),
+  z7.undefined()
 ]);
 
 // src/preRequest.ts
@@ -232,40 +410,48 @@ 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 = z8.strictObject({
+  errors: z8.array(resolvingIssueSchema).optional(),
+  warnings: z8.array(resolvingIssueSchema).optional(),
+  infos: z8.array(resolvingIssueSchema).optional(),
   dataResource: edgehancerMergedDataTypeSchema
 });
-var preRequestEdgehancerResultSchema = z2.strictObject({
-  dataResources: z2.array(preRequestEdgehancerDataResourceResultSchema)
+var preRequestEdgehancerResultSchema = z8.strictObject({
+  dataResources: z8.array(preRequestEdgehancerDataResourceResultSchema)
 });
 
 // src/request.ts
-var z3 = __toESM(require("zod"));
-var requestEdgehancerDataResourceResolutionResultSchema = z3.strictObject({
-  errors: z3.array(resolvingIssueSchema).optional().describe(
+var z9 = __toESM(require("zod"));
+var requestEdgehancerDataResourceResolutionResultSchema = z9.strictObject({
+  errors: z9.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: z9.array(resolvingIssueSchema).optional().describe("Warnings that occurred while running your code to return with the API response, if any."),
+  infos: z9.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: z9.array(z9.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 = z9.strictObject({
+  results: z9.array(requestEdgehancerDataResourceResolutionResultSchema)
 });
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   COLLECTION_DEFAULT_LIMIT,
   COLLECTION_DEFAULT_OFFSET,
   COLLECTION_MAX_LIMIT,
+  afterAIDataResourceEditContextSchema,
+  afterAIDataResourceEditResultSchema,
+  afterAIEditContextSchema,
+  afterAIEditResultSchema,
   convertBatchResultsToEdgehancerResult,
+  createAIDataResourceEditContextSchema,
+  createAIDataResourceEditResultSchema,
+  createAIEditContextSchema,
+  createAIEditResultSchema,
   dataResourceSchema,
   edgehancerMergedDataTypeSchema,
   getDataResourceAsRequest,