@sprigr/apps-app-sdk 0.13.0 → 0.14.0

package/dist/index.d.ts

@@ -669,6 +669,12 @@ declare function withSprigrLogFallback<E extends WfpBridgeEnv & object>(env: E,
  * fails with `shard_field_invalid`: a patch cannot be routed to its shard
  * otherwise. The per-call cap is the same 1000 objects as `import`.
  *
+ * `withAcl: true` is a narrower mode: it re-stamps `acl_principals` on rows
+ * already in the app's `-acl-files` index and nothing else. Every patch must
+ * be exactly `{ objectID, acl_principals }`, and `createIfNotExists` and
+ * `index` cannot be combined with it. Content is written only by an ACL
+ * `import`, whole.
+ *
  * This module carries two things:
  *
  *   1. `buildPartialUpdateBody`, the wire body both transports send, with
@@ -687,10 +693,13 @@ declare function withSprigrLogFallback<E extends WfpBridgeEnv & object>(env: E,
  * swallow.
  *
  * Wire contract (workers/provisioning/src/wfp-data.ts in sprigr-team):
- *   POST { index?, objects, createIfNotExists? }
+ *   POST { index?, objects, createIfNotExists?, withAcl? }
  *   200 { ok: true, updated, skippedMissing, index, physical_indexes? }
  *   400 { error, detail, index? } with error one of too_many_objects,
- *       invalid_object, unknown_data_index, shard_field_invalid, ...
+ *       invalid_object, unknown_data_index, shard_field_invalid,
+ *       acl_partial_update_fields, acl_partial_update_create_unsupported,
+ *       acl_index_combination_unsupported, missing_acl_principals,
+ *       invalid_acl_principal, ...
  *   401 / 404 bad token / inactive install
  */
 
@@ -708,6 +717,8 @@ interface SprigrDataPartialUpdateBody {
     index?: string;
     objects: SprigrDataPatch[];
     createIfNotExists: boolean;
+    /** Present (and true) only for an ACL re-stamp. */
+    withAcl?: true;
 }
 interface PartialUpdateDataOptions extends SprigrDataPartialUpdateOpts {
     /** Ceiling on the HTTP fallback. No default: a data write is awaited for its result. */
@@ -2244,6 +2255,17 @@ interface SprigrDataPartialUpdateOpts extends SprigrDataIndexOpts {
      * missing target is counted in `skippedMissing` instead of being written.
      */
     createIfNotExists?: boolean;
+    /**
+     * Re-stamp `acl_principals` on rows already in the app's `-acl-files`
+     * index without rewriting the rest of each row. Every object must be
+     * exactly `{ objectID, acl_principals }` with a non-empty, valid principal
+     * list; `createIfNotExists` and `index` are refused alongside it. Use it
+     * when the source changes who may see an item without reporting the item
+     * as changed (OneDrive's delta omits sharing-only changes). Needs a
+     * platform with sprigr/sprigr-team#9843; older wrappers drop the flag,
+     * which `partialUpdateData` detects and throws on.
+     */
+    withAcl?: boolean;
 }
 /** Reply of `env.SPRIGR.data.partialUpdate` (`POST /internal/wfp/data/partial-update`). */
 interface SprigrDataPartialUpdateResult {

package/dist/index.js

@@ -512,6 +512,7 @@ function withSprigrLogFallback(env, opts) {
 // src/platform-data.ts
 var DATA_PARTIAL_UPDATE_PATH = "/internal/wfp/data/partial-update";
 var SPRIGR_DATA_MAX_OBJECTS_PER_CALL = 1e3;
+var ACL_INDEX_SUFFIX = "-acl-files";
 var SprigrDataValidationError = class extends Error {
   error;
   index;
@@ -556,12 +557,51 @@ function buildPartialUpdateBody(objects, opts) {
       error: "unknown_data_index"
     });
   }
+  const withAcl = opts?.withAcl === true;
+  if (withAcl) checkAclRestamp(objects, opts, at);
   return {
     ...opts?.index !== void 0 ? { index: opts.index } : {},
     objects,
-    createIfNotExists: opts?.createIfNotExists === true
+    createIfNotExists: opts?.createIfNotExists === true,
+    ...withAcl ? { withAcl: true } : {}
   };
 }
+function checkAclRestamp(objects, opts, at) {
+  if (opts?.createIfNotExists === true) {
+    throw new SprigrDataValidationError(
+      `${at}: withAcl only re-stamps existing rows; createIfNotExists would create a row with principals and no content`,
+      { error: "acl_partial_update_create_unsupported" }
+    );
+  }
+  if (opts?.index !== void 0) {
+    throw new SprigrDataValidationError(`${at}: withAcl targets the reserved -acl-files index and cannot be combined with index`, {
+      error: "acl_index_combination_unsupported"
+    });
+  }
+  for (let i = 0; i < objects.length; i++) {
+    const o = objects[i];
+    const extra = Object.keys(o).find((k) => k !== "objectID" && k !== "acl_principals");
+    if (extra !== void 0) {
+      throw new SprigrDataValidationError(
+        `${at}: objects[${i}] carries "${extra}"; a withAcl partial update sets only objectID and acl_principals (write content with data.import withAcl)`,
+        { error: "acl_partial_update_fields", index: i }
+      );
+    }
+    const principals = o.acl_principals;
+    if (!Array.isArray(principals) || principals.length === 0) {
+      throw new SprigrDataValidationError(`${at}: objects[${i}] needs a non-empty acl_principals: string[]`, {
+        error: "missing_acl_principals",
+        index: i
+      });
+    }
+  }
+}
+function assertAclIndex(result) {
+  if (typeof result?.index === "string" && result.index.endsWith(ACL_INDEX_SUFFIX)) return result;
+  throw new Error(
+    `data.partialUpdate withAcl landed on ${String(result?.index)}, not the ${ACL_INDEX_SUFFIX} index: this app was built by a platform wrapper that drops withAcl. Republish the app to pick up the current wrapper.`
+  );
+}
 function bindingPartialUpdate(env) {
   const data = env.SPRIGR?.data;
   return typeof data?.partialUpdate === "function" ? data.partialUpdate.bind(data) : null;
@@ -579,10 +619,12 @@ async function partialUpdateData(env, objects, opts) {
   const body = buildPartialUpdateBody(objects, dataOpts);
   const injected = bindingPartialUpdate(env);
   if (injected) {
-    return injected(body.objects, {
+    const result = await injected(body.objects, {
       ...body.index !== void 0 ? { index: body.index } : {},
-      createIfNotExists: body.createIfNotExists
+      createIfNotExists: body.createIfNotExists,
+      ...body.withAcl ? { withAcl: true } : {}
     });
+    return body.withAcl ? assertAclIndex(result) : result;
   }
   const bridge = resolveInstallBridge(env);
   if (!bridge) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sprigr/apps-app-sdk",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",