@uniformdev/mesh-edgehancer-sdk 20.71.0 → 20.71.2-alpha.7

package/dist/index.d.mts

@@ -236,6 +236,45 @@ type AfterAIEditResult = z.infer<typeof afterAIEditResultSchema>;
  */
 type AfterAIEditHookFn = (context: AfterAIEditContext) => Promise<AfterAIEditResult>;
 
+/**
+ * A normalized record of one bound parameter value that consumed a data
+ * resource somewhere in the composition tree. Custom edgehancer authors can
+ * use this to derive minimal upstream queries (e.g. GraphQL field selection,
+ * downstream `select.*` forwarding) instead of always fetching the full
+ * resource shape.
+ */
+type CollectedBinding = {
+    /**
+     * Data resource name referenced by the binding (post-alias-deref,
+     * post-loop-synthesis when surfaced from canvas-sdk's scope walker — the
+     * raw parsed name when produced by `collectComponentBindings`). Used as
+     * the key into per-DR binding buckets.
+     */
+    dataResource: string;
+    /**
+     * The full effective pointer for this binding, e.g. `/items/fields/title`,
+     * _including_ the leading `/<dataResource>` segment. Per-integration
+     * translators (UC's `deriveUniformContentProjection`, custom edgehancer
+     * authors) scan this for `/fields/<name>` and `/parameters/<name>` segments
+     * to derive a minimal upstream query.
+     */
+    pointer: string;
+    /**
+     * The JSON pointer expression _inside_ the data resource, with the leading
+     * `/<dataResource>` segment removed. May be undefined if the binding
+     * references the whole resource.
+     */
+    dataExpression: string | undefined;
+    /** Parameter id (property name) where the binding was found. */
+    parameterId: string;
+    /**
+     * Locale the binding's locale-scoped value was found under, if any. The
+     * empty string is normalized to undefined.
+     */
+    locale: string | undefined;
+    /** Condition index, or -1 for the default (non-conditional) value. */
+    conditionIndex: number;
+};
 type RequestEdgehancerDataResourceContext = {
     /**
      * The data resource to fetch.
@@ -529,6 +568,14 @@ type PreRequestEdgehancerDataResourceContext = {
      * The data resource definition that will be requested.
      */
     dataResource: EdgehancerMergedDataType;
+    /**
+     * The set of bindings in the originating composition/entry that consume this
+     * data resource. This can be used to derive a data projection to the target API.
+     *
+     * Undefined for editor / authoring fetches so the editor can read every
+     * field to create new bindings. Never an empty array — unused data resources are automatically skipped from being fetched.
+     */
+    bindings?: readonly CollectedBinding[];
 };
 type PreRequestEdgehancerContext = {
     fetchContext: DataResourceFetchContext;
@@ -739,4 +786,4 @@ declare function getDataResourceQueryString({ parameters, url }: EdgehancerMerge
 /** Gets the HTTP headers for a data resource */
 declare function getDataResourceHeaders({ headers }: EdgehancerMergedDataType): Headers;
 
-export { type AfterAIDataResourceEditContext, type AfterAIDataResourceEditHookFn, type AfterAIDataResourceEditResult, type AfterAIEditContext, type AfterAIEditHookFn, type AfterAIEditResult, COLLECTION_DEFAULT_LIMIT, COLLECTION_DEFAULT_OFFSET, COLLECTION_MAX_LIMIT, type ConvertBatchResultsToEdgehancerResultOptions, type CreateAIDataResourceEditContext, type CreateAIDataResourceEditHookFn, type CreateAIDataResourceEditResult, type CreateAIEditContext, type CreateAIEditHookFn, type CreateAIEditResult, type CustomEdgehancerDefinition, type DataResource, type DataResourceFetchContext, type EdgehancerDataIssue, type EdgehancerMergedDataType, type MergedDataType, type PreRequestEdgehancerContext, type PreRequestEdgehancerDataResourceContext, type PreRequestEdgehancerDataResourceResult, type PreRequestEdgehancerResult, type PreRequestHookFn, type RequestEdgehancerContext, type RequestEdgehancerDataResourceContext, type RequestEdgehancerDataResourceResolutionResult, type RequestEdgehancerResult, type RequestHookFn, type ResolveBatchIdsResult, afterAIDataResourceEditContextSchema, afterAIDataResourceEditResultSchema, afterAIEditContextSchema, afterAIEditResultSchema, convertBatchResultsToEdgehancerResult, createAIDataResourceEditContextSchema, createAIDataResourceEditResultSchema, createAIEditContextSchema, createAIEditResultSchema, dataResourceSchema, edgehancerMergedDataTypeSchema, getDataResourceAsRequest, getDataResourceHeaders, getDataResourceQueryString, getDataResourceUrl, mergedDataTypeSchema, preRequestEdgehancerDataResourceResultSchema, preRequestEdgehancerResultSchema, requestEdgehancerDataResourceResolutionResultSchema, requestEdgehancerResultSchema, resolveBatchFetchIds, resolvingIssueSchema };
+export { type AfterAIDataResourceEditContext, type AfterAIDataResourceEditHookFn, type AfterAIDataResourceEditResult, type AfterAIEditContext, type AfterAIEditHookFn, type AfterAIEditResult, COLLECTION_DEFAULT_LIMIT, COLLECTION_DEFAULT_OFFSET, COLLECTION_MAX_LIMIT, type CollectedBinding, type ConvertBatchResultsToEdgehancerResultOptions, type CreateAIDataResourceEditContext, type CreateAIDataResourceEditHookFn, type CreateAIDataResourceEditResult, type CreateAIEditContext, type CreateAIEditHookFn, type CreateAIEditResult, type CustomEdgehancerDefinition, type DataResource, type DataResourceFetchContext, type EdgehancerDataIssue, type EdgehancerMergedDataType, type MergedDataType, type PreRequestEdgehancerContext, type PreRequestEdgehancerDataResourceContext, type PreRequestEdgehancerDataResourceResult, type PreRequestEdgehancerResult, type PreRequestHookFn, type RequestEdgehancerContext, type RequestEdgehancerDataResourceContext, type RequestEdgehancerDataResourceResolutionResult, type RequestEdgehancerResult, type RequestHookFn, type ResolveBatchIdsResult, afterAIDataResourceEditContextSchema, afterAIDataResourceEditResultSchema, afterAIEditContextSchema, afterAIEditResultSchema, convertBatchResultsToEdgehancerResult, createAIDataResourceEditContextSchema, createAIDataResourceEditResultSchema, createAIEditContextSchema, createAIEditResultSchema, dataResourceSchema, edgehancerMergedDataTypeSchema, getDataResourceAsRequest, getDataResourceHeaders, getDataResourceQueryString, getDataResourceUrl, mergedDataTypeSchema, preRequestEdgehancerDataResourceResultSchema, preRequestEdgehancerResultSchema, requestEdgehancerDataResourceResolutionResultSchema, requestEdgehancerResultSchema, resolveBatchFetchIds, resolvingIssueSchema };

package/dist/index.d.ts

@@ -236,6 +236,45 @@ type AfterAIEditResult = z.infer<typeof afterAIEditResultSchema>;
  */
 type AfterAIEditHookFn = (context: AfterAIEditContext) => Promise<AfterAIEditResult>;
 
+/**
+ * A normalized record of one bound parameter value that consumed a data
+ * resource somewhere in the composition tree. Custom edgehancer authors can
+ * use this to derive minimal upstream queries (e.g. GraphQL field selection,
+ * downstream `select.*` forwarding) instead of always fetching the full
+ * resource shape.
+ */
+type CollectedBinding = {
+    /**
+     * Data resource name referenced by the binding (post-alias-deref,
+     * post-loop-synthesis when surfaced from canvas-sdk's scope walker — the
+     * raw parsed name when produced by `collectComponentBindings`). Used as
+     * the key into per-DR binding buckets.
+     */
+    dataResource: string;
+    /**
+     * The full effective pointer for this binding, e.g. `/items/fields/title`,
+     * _including_ the leading `/<dataResource>` segment. Per-integration
+     * translators (UC's `deriveUniformContentProjection`, custom edgehancer
+     * authors) scan this for `/fields/<name>` and `/parameters/<name>` segments
+     * to derive a minimal upstream query.
+     */
+    pointer: string;
+    /**
+     * The JSON pointer expression _inside_ the data resource, with the leading
+     * `/<dataResource>` segment removed. May be undefined if the binding
+     * references the whole resource.
+     */
+    dataExpression: string | undefined;
+    /** Parameter id (property name) where the binding was found. */
+    parameterId: string;
+    /**
+     * Locale the binding's locale-scoped value was found under, if any. The
+     * empty string is normalized to undefined.
+     */
+    locale: string | undefined;
+    /** Condition index, or -1 for the default (non-conditional) value. */
+    conditionIndex: number;
+};
 type RequestEdgehancerDataResourceContext = {
     /**
      * The data resource to fetch.
@@ -529,6 +568,14 @@ type PreRequestEdgehancerDataResourceContext = {
      * The data resource definition that will be requested.
      */
     dataResource: EdgehancerMergedDataType;
+    /**
+     * The set of bindings in the originating composition/entry that consume this
+     * data resource. This can be used to derive a data projection to the target API.
+     *
+     * Undefined for editor / authoring fetches so the editor can read every
+     * field to create new bindings. Never an empty array — unused data resources are automatically skipped from being fetched.
+     */
+    bindings?: readonly CollectedBinding[];
 };
 type PreRequestEdgehancerContext = {
     fetchContext: DataResourceFetchContext;
@@ -739,4 +786,4 @@ declare function getDataResourceQueryString({ parameters, url }: EdgehancerMerge
 /** Gets the HTTP headers for a data resource */
 declare function getDataResourceHeaders({ headers }: EdgehancerMergedDataType): Headers;
 
-export { type AfterAIDataResourceEditContext, type AfterAIDataResourceEditHookFn, type AfterAIDataResourceEditResult, type AfterAIEditContext, type AfterAIEditHookFn, type AfterAIEditResult, COLLECTION_DEFAULT_LIMIT, COLLECTION_DEFAULT_OFFSET, COLLECTION_MAX_LIMIT, type ConvertBatchResultsToEdgehancerResultOptions, type CreateAIDataResourceEditContext, type CreateAIDataResourceEditHookFn, type CreateAIDataResourceEditResult, type CreateAIEditContext, type CreateAIEditHookFn, type CreateAIEditResult, type CustomEdgehancerDefinition, type DataResource, type DataResourceFetchContext, type EdgehancerDataIssue, type EdgehancerMergedDataType, type MergedDataType, type PreRequestEdgehancerContext, type PreRequestEdgehancerDataResourceContext, type PreRequestEdgehancerDataResourceResult, type PreRequestEdgehancerResult, type PreRequestHookFn, type RequestEdgehancerContext, type RequestEdgehancerDataResourceContext, type RequestEdgehancerDataResourceResolutionResult, type RequestEdgehancerResult, type RequestHookFn, type ResolveBatchIdsResult, afterAIDataResourceEditContextSchema, afterAIDataResourceEditResultSchema, afterAIEditContextSchema, afterAIEditResultSchema, convertBatchResultsToEdgehancerResult, createAIDataResourceEditContextSchema, createAIDataResourceEditResultSchema, createAIEditContextSchema, createAIEditResultSchema, dataResourceSchema, edgehancerMergedDataTypeSchema, getDataResourceAsRequest, getDataResourceHeaders, getDataResourceQueryString, getDataResourceUrl, mergedDataTypeSchema, preRequestEdgehancerDataResourceResultSchema, preRequestEdgehancerResultSchema, requestEdgehancerDataResourceResolutionResultSchema, requestEdgehancerResultSchema, resolveBatchFetchIds, resolvingIssueSchema };
+export { type AfterAIDataResourceEditContext, type AfterAIDataResourceEditHookFn, type AfterAIDataResourceEditResult, type AfterAIEditContext, type AfterAIEditHookFn, type AfterAIEditResult, COLLECTION_DEFAULT_LIMIT, COLLECTION_DEFAULT_OFFSET, COLLECTION_MAX_LIMIT, type CollectedBinding, type ConvertBatchResultsToEdgehancerResultOptions, type CreateAIDataResourceEditContext, type CreateAIDataResourceEditHookFn, type CreateAIDataResourceEditResult, type CreateAIEditContext, type CreateAIEditHookFn, type CreateAIEditResult, type CustomEdgehancerDefinition, type DataResource, type DataResourceFetchContext, type EdgehancerDataIssue, type EdgehancerMergedDataType, type MergedDataType, type PreRequestEdgehancerContext, type PreRequestEdgehancerDataResourceContext, type PreRequestEdgehancerDataResourceResult, type PreRequestEdgehancerResult, type PreRequestHookFn, type RequestEdgehancerContext, type RequestEdgehancerDataResourceContext, type RequestEdgehancerDataResourceResolutionResult, type RequestEdgehancerResult, type RequestHookFn, type ResolveBatchIdsResult, afterAIDataResourceEditContextSchema, afterAIDataResourceEditResultSchema, afterAIEditContextSchema, afterAIEditResultSchema, convertBatchResultsToEdgehancerResult, createAIDataResourceEditContextSchema, createAIDataResourceEditResultSchema, createAIEditContextSchema, createAIEditResultSchema, dataResourceSchema, edgehancerMergedDataTypeSchema, getDataResourceAsRequest, getDataResourceHeaders, getDataResourceQueryString, getDataResourceUrl, mergedDataTypeSchema, preRequestEdgehancerDataResourceResultSchema, preRequestEdgehancerResultSchema, requestEdgehancerDataResourceResolutionResultSchema, requestEdgehancerResultSchema, resolveBatchFetchIds, resolvingIssueSchema };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/mesh-edgehancer-sdk",
-  "version": "20.71.0",
+  "version": "20.71.2-alpha.7+2ec20a4ae2",
   "description": "Uniform Mesh Edgehancer SDK",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -47,7 +47,7 @@
     "/dist"
   ],
   "dependencies": {
-    "@uniformdev/canvas": "20.71.0",
+    "@uniformdev/canvas": "20.71.2-alpha.7+2ec20a4ae2",
     "tsafe": "1.8.12",
     "zod": "^4.4.3"
   },
@@ -60,5 +60,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9b3f5e3fa27b275c00cc252da7ed72913464cce6"
+  "gitHead": "2ec20a4ae2d167b6e4e6ad47463b90fb16b73c47"
 }