velocious 1.0.486 → 1.0.488

package/build/src/packages/velocious-package.js

@@ -0,0 +1,101 @@
+// @ts-check
+import restArgsError from "../utils/rest-args-error.js";
+/**
+ * A Velocious package (engine): an external npm package that contributes data
+ * models, frontend-model resources and migrations to a consuming app. The app
+ * lists packages in `Configuration({packages: [...]})`; the framework then loads
+ * the package's `src/models`, discovers its `src/resources`, runs its
+ * `src/database/migrations`, and generates its frontend models into the app.
+ */
+export default class VelociousPackage {
+    /**
+     * Wraps a plain descriptor as a VelociousPackage (or returns it unchanged when
+     * it already is one), so packages can be listed without importing this class.
+     * @param {VelociousPackage | import("../configuration-types.js").VelociousPackageDescriptor} descriptor - Package or plain descriptor.
+     * @returns {VelociousPackage} - The package instance.
+     */
+    static from(descriptor) {
+        if (descriptor instanceof VelociousPackage) {
+            return descriptor;
+        }
+        return new VelociousPackage(descriptor);
+    }
+    /**
+     * Derives the containing directory of a module url without Node's `path`/`url`
+     * modules, so this class stays safe to import in browser/Expo bundles.
+     * @param {string} url - A module url (usually `import.meta.url`).
+     * @returns {string} - The directory path that contains the module.
+     */
+    static _directoryFromUrl(url) {
+        const directoryUrl = new URL(".", url);
+        return decodeURIComponent(directoryUrl.pathname).replace(/\/$/, "");
+    }
+    /**
+     * Runs constructor.
+     * @param {import("../configuration-types.js").VelociousPackageDescriptor} args - Package descriptor.
+     */
+    constructor({ name, url, path, modelsPath, resourcesPath, migrationsPath, ...restArgs }) {
+        restArgsError(restArgs);
+        if (!name) {
+            throw new Error("A velocious package requires a name.");
+        }
+        if (!path && !url) {
+            throw new Error(`Velocious package "${name}" requires a "path" or a "url" (usually import.meta.url).`);
+        }
+        this._name = name;
+        this._path = path || VelociousPackage._directoryFromUrl(/** @type {string} */ (url));
+        this._modelsPath = modelsPath;
+        this._resourcesPath = resourcesPath;
+        this._migrationsPath = migrationsPath;
+    }
+    /**
+     * Runs get name.
+     * @returns {string} - The package name.
+     */
+    getName() {
+        return this._name;
+    }
+    /**
+     * Runs get path.
+     * @returns {string} - The package root directory (the one that contains `src`).
+     */
+    getPath() {
+        return this._path;
+    }
+    /**
+     * Runs get models path.
+     * @returns {string} - The package's models directory.
+     */
+    getModelsPath() {
+        return this._modelsPath || `${this._path}/src/models`;
+    }
+    /**
+     * Runs get resources path.
+     * @returns {string} - The package's frontend-model resources directory.
+     */
+    getResourcesPath() {
+        return this._resourcesPath || `${this._path}/src/resources`;
+    }
+    /**
+     * Runs get migrations path.
+     * @returns {string} - The package's migrations directory.
+     */
+    getMigrationsPath() {
+        return this._migrationsPath || `${this._path}/src/database/migrations`;
+    }
+    /**
+     * Derives the internal backend-project entry the framework appends so the
+     * existing resource-discovery + frontend-model generation machinery picks up
+     * this package. Generated frontend models are written to the app's output.
+     * @param {{frontendModelsOutputPath: string | undefined}} args - The app's frontend-models output path.
+     * @returns {import("../configuration-types.js").BackendProjectConfiguration} - The derived backend project.
+     */
+    toBackendProjectConfiguration({ frontendModelsOutputPath }) {
+        return {
+            frontendModelsOutputPath,
+            path: this.getPath(),
+            resourcesPath: this.getResourcesPath()
+        };
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmVsb2Npb3VzLXBhY2thZ2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvcGFja2FnZXMvdmVsb2Npb3VzLXBhY2thZ2UuanMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsWUFBWTtBQUVaLE9BQU8sYUFBYSxNQUFNLDZCQUE2QixDQUFBO0FBRXZEOzs7Ozs7R0FNRztBQUNILE1BQU0sQ0FBQyxPQUFPLE9BQU8sZ0JBQWdCO0lBQ25DOzs7OztPQUtHO0lBQ0gsTUFBTSxDQUFDLElBQUksQ0FBQyxVQUFVO1FBQ3BCLElBQUksVUFBVSxZQUFZLGdCQUFnQixFQUFFLENBQUM7WUFDM0MsT0FBTyxVQUFVLENBQUE7UUFDbkIsQ0FBQztRQUVELE9BQU8sSUFBSSxnQkFBZ0IsQ0FBQyxVQUFVLENBQUMsQ0FBQTtJQUN6QyxDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxNQUFNLENBQUMsaUJBQWlCLENBQUMsR0FBRztRQUMxQixNQUFNLFlBQVksR0FBRyxJQUFJLEdBQUcsQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDLENBQUE7UUFFdEMsT0FBTyxrQkFBa0IsQ0FBQyxZQUFZLENBQUMsUUFBUSxDQUFDLENBQUMsT0FBTyxDQUFDLEtBQUssRUFBRSxFQUFFLENBQUMsQ0FBQTtJQUNyRSxDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsWUFBWSxFQUFDLElBQUksRUFBRSxHQUFHLEVBQUUsSUFBSSxFQUFFLFVBQVUsRUFBRSxhQUFhLEVBQUUsY0FBYyxFQUFFLEdBQUcsUUFBUSxFQUFDO1FBQ25GLGFBQWEsQ0FBQyxRQUFRLENBQUMsQ0FBQTtRQUV2QixJQUFJLENBQUMsSUFBSSxFQUFFLENBQUM7WUFDVixNQUFNLElBQUksS0FBSyxDQUFDLHNDQUFzQyxDQUFDLENBQUE7UUFDekQsQ0FBQztRQUVELElBQUksQ0FBQyxJQUFJLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztZQUNsQixNQUFNLElBQUksS0FBSyxDQUFDLHNCQUFzQixJQUFJLDJEQUEyRCxDQUFDLENBQUE7UUFDeEcsQ0FBQztRQUVELElBQUksQ0FBQyxLQUFLLEdBQUcsSUFBSSxDQUFBO1FBQ2pCLElBQUksQ0FBQyxLQUFLLEdBQUcsSUFBSSxJQUFJLGdCQUFnQixDQUFDLGlCQUFpQixDQUFDLHFCQUFxQixDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQTtRQUNwRixJQUFJLENBQUMsV0FBVyxHQUFHLFVBQVUsQ0FBQTtRQUM3QixJQUFJLENBQUMsY0FBYyxHQUFHLGFBQWEsQ0FBQTtRQUNuQyxJQUFJLENBQUMsZUFBZSxHQUFHLGNBQWMsQ0FBQTtJQUN2QyxDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsT0FBTztRQUNMLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQTtJQUNuQixDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsT0FBTztRQUNMLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQTtJQUNuQixDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsYUFBYTtRQUNYLE9BQU8sSUFBSSxDQUFDLFdBQVcsSUFBSSxHQUFHLElBQUksQ0FBQyxLQUFLLGFBQWEsQ0FBQTtJQUN2RCxDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsZ0JBQWdCO1FBQ2QsT0FBTyxJQUFJLENBQUMsY0FBYyxJQUFJLEdBQUcsSUFBSSxDQUFDLEtBQUssZ0JBQWdCLENBQUE7SUFDN0QsQ0FBQztJQUVEOzs7T0FHRztJQUNILGlCQUFpQjtRQUNmLE9BQU8sSUFBSSxDQUFDLGVBQWUsSUFBSSxHQUFHLElBQUksQ0FBQyxLQUFLLDBCQUEwQixDQUFBO0lBQ3hFLENBQUM7SUFFRDs7Ozs7O09BTUc7SUFDSCw2QkFBNkIsQ0FBQyxFQUFDLHdCQUF3QixFQUFDO1FBQ3RELE9BQU87WUFDTCx3QkFBd0I7WUFDeEIsSUFBSSxFQUFFLElBQUksQ0FBQyxPQUFPLEVBQUU7WUFDcEIsYUFBYSxFQUFFLElBQUksQ0FBQyxnQkFBZ0IsRUFBRTtTQUN2QyxDQUFBO0lBQ0gsQ0FBQztDQUNGIiwic291cmNlc0NvbnRlbnQiOlsiLy8gQHRzLWNoZWNrXG5cbmltcG9ydCByZXN0QXJnc0Vycm9yIGZyb20gXCIuLi91dGlscy9yZXN0LWFyZ3MtZXJyb3IuanNcIlxuXG4vKipcbiAqIEEgVmVsb2Npb3VzIHBhY2thZ2UgKGVuZ2luZSk6IGFuIGV4dGVybmFsIG5wbSBwYWNrYWdlIHRoYXQgY29udHJpYnV0ZXMgZGF0YVxuICogbW9kZWxzLCBmcm9udGVuZC1tb2RlbCByZXNvdXJjZXMgYW5kIG1pZ3JhdGlvbnMgdG8gYSBjb25zdW1pbmcgYXBwLiBUaGUgYXBwXG4gKiBsaXN0cyBwYWNrYWdlcyBpbiBgQ29uZmlndXJhdGlvbih7cGFja2FnZXM6IFsuLi5dfSlgOyB0aGUgZnJhbWV3b3JrIHRoZW4gbG9hZHNcbiAqIHRoZSBwYWNrYWdlJ3MgYHNyYy9tb2RlbHNgLCBkaXNjb3ZlcnMgaXRzIGBzcmMvcmVzb3VyY2VzYCwgcnVucyBpdHNcbiAqIGBzcmMvZGF0YWJhc2UvbWlncmF0aW9uc2AsIGFuZCBnZW5lcmF0ZXMgaXRzIGZyb250ZW5kIG1vZGVscyBpbnRvIHRoZSBhcHAuXG4gKi9cbmV4cG9ydCBkZWZhdWx0IGNsYXNzIFZlbG9jaW91c1BhY2thZ2Uge1xuICAvKipcbiAgICogV3JhcHMgYSBwbGFpbiBkZXNjcmlwdG9yIGFzIGEgVmVsb2Npb3VzUGFja2FnZSAob3IgcmV0dXJucyBpdCB1bmNoYW5nZWQgd2hlblxuICAgKiBpdCBhbHJlYWR5IGlzIG9uZSksIHNvIHBhY2thZ2VzIGNhbiBiZSBsaXN0ZWQgd2l0aG91dCBpbXBvcnRpbmcgdGhpcyBjbGFzcy5cbiAgICogQHBhcmFtIHtWZWxvY2lvdXNQYWNrYWdlIHwgaW1wb3J0KFwiLi4vY29uZmlndXJhdGlvbi10eXBlcy5qc1wiKS5WZWxvY2lvdXNQYWNrYWdlRGVzY3JpcHRvcn0gZGVzY3JpcHRvciAtIFBhY2thZ2Ugb3IgcGxhaW4gZGVzY3JpcHRvci5cbiAgICogQHJldHVybnMge1ZlbG9jaW91c1BhY2thZ2V9IC0gVGhlIHBhY2thZ2UgaW5zdGFuY2UuXG4gICAqL1xuICBzdGF0aWMgZnJvbShkZXNjcmlwdG9yKSB7XG4gICAgaWYgKGRlc2NyaXB0b3IgaW5zdGFuY2VvZiBWZWxvY2lvdXNQYWNrYWdlKSB7XG4gICAgICByZXR1cm4gZGVzY3JpcHRvclxuICAgIH1cblxuICAgIHJldHVybiBuZXcgVmVsb2Npb3VzUGFja2FnZShkZXNjcmlwdG9yKVxuICB9XG5cbiAgLyoqXG4gICAqIERlcml2ZXMgdGhlIGNvbnRhaW5pbmcgZGlyZWN0b3J5IG9mIGEgbW9kdWxlIHVybCB3aXRob3V0IE5vZGUncyBgcGF0aGAvYHVybGBcbiAgICogbW9kdWxlcywgc28gdGhpcyBjbGFzcyBzdGF5cyBzYWZlIHRvIGltcG9ydCBpbiBicm93c2VyL0V4cG8gYnVuZGxlcy5cbiAgICogQHBhcmFtIHtzdHJpbmd9IHVybCAtIEEgbW9kdWxlIHVybCAodXN1YWxseSBgaW1wb3J0Lm1ldGEudXJsYCkuXG4gICAqIEByZXR1cm5zIHtzdHJpbmd9IC0gVGhlIGRpcmVjdG9yeSBwYXRoIHRoYXQgY29udGFpbnMgdGhlIG1vZHVsZS5cbiAgICovXG4gIHN0YXRpYyBfZGlyZWN0b3J5RnJvbVVybCh1cmwpIHtcbiAgICBjb25zdCBkaXJlY3RvcnlVcmwgPSBuZXcgVVJMKFwiLlwiLCB1cmwpXG5cbiAgICByZXR1cm4gZGVjb2RlVVJJQ29tcG9uZW50KGRpcmVjdG9yeVVybC5wYXRobmFtZSkucmVwbGFjZSgvXFwvJC8sIFwiXCIpXG4gIH1cblxuICAvKipcbiAgICogUnVucyBjb25zdHJ1Y3Rvci5cbiAgICogQHBhcmFtIHtpbXBvcnQoXCIuLi9jb25maWd1cmF0aW9uLXR5cGVzLmpzXCIpLlZlbG9jaW91c1BhY2thZ2VEZXNjcmlwdG9yfSBhcmdzIC0gUGFja2FnZSBkZXNjcmlwdG9yLlxuICAgKi9cbiAgY29uc3RydWN0b3Ioe25hbWUsIHVybCwgcGF0aCwgbW9kZWxzUGF0aCwgcmVzb3VyY2VzUGF0aCwgbWlncmF0aW9uc1BhdGgsIC4uLnJlc3RBcmdzfSkge1xuICAgIHJlc3RBcmdzRXJyb3IocmVzdEFyZ3MpXG5cbiAgICBpZiAoIW5hbWUpIHtcbiAgICAgIHRocm93IG5ldyBFcnJvcihcIkEgdmVsb2Npb3VzIHBhY2thZ2UgcmVxdWlyZXMgYSBuYW1lLlwiKVxuICAgIH1cblxuICAgIGlmICghcGF0aCAmJiAhdXJsKSB7XG4gICAgICB0aHJvdyBuZXcgRXJyb3IoYFZlbG9jaW91cyBwYWNrYWdlIFwiJHtuYW1lfVwiIHJlcXVpcmVzIGEgXCJwYXRoXCIgb3IgYSBcInVybFwiICh1c3VhbGx5IGltcG9ydC5tZXRhLnVybCkuYClcbiAgICB9XG5cbiAgICB0aGlzLl9uYW1lID0gbmFtZVxuICAgIHRoaXMuX3BhdGggPSBwYXRoIHx8IFZlbG9jaW91c1BhY2thZ2UuX2RpcmVjdG9yeUZyb21VcmwoLyoqIEB0eXBlIHtzdHJpbmd9ICovICh1cmwpKVxuICAgIHRoaXMuX21vZGVsc1BhdGggPSBtb2RlbHNQYXRoXG4gICAgdGhpcy5fcmVzb3VyY2VzUGF0aCA9IHJlc291cmNlc1BhdGhcbiAgICB0aGlzLl9taWdyYXRpb25zUGF0aCA9IG1pZ3JhdGlvbnNQYXRoXG4gIH1cblxuICAvKipcbiAgICogUnVucyBnZXQgbmFtZS5cbiAgICogQHJldHVybnMge3N0cmluZ30gLSBUaGUgcGFja2FnZSBuYW1lLlxuICAgKi9cbiAgZ2V0TmFtZSgpIHtcbiAgICByZXR1cm4gdGhpcy5fbmFtZVxuICB9XG5cbiAgLyoqXG4gICAqIFJ1bnMgZ2V0IHBhdGguXG4gICAqIEByZXR1cm5zIHtzdHJpbmd9IC0gVGhlIHBhY2thZ2Ugcm9vdCBkaXJlY3RvcnkgKHRoZSBvbmUgdGhhdCBjb250YWlucyBgc3JjYCkuXG4gICAqL1xuICBnZXRQYXRoKCkge1xuICAgIHJldHVybiB0aGlzLl9wYXRoXG4gIH1cblxuICAvKipcbiAgICogUnVucyBnZXQgbW9kZWxzIHBhdGguXG4gICAqIEByZXR1cm5zIHtzdHJpbmd9IC0gVGhlIHBhY2thZ2UncyBtb2RlbHMgZGlyZWN0b3J5LlxuICAgKi9cbiAgZ2V0TW9kZWxzUGF0aCgpIHtcbiAgICByZXR1cm4gdGhpcy5fbW9kZWxzUGF0aCB8fCBgJHt0aGlzLl9wYXRofS9zcmMvbW9kZWxzYFxuICB9XG5cbiAgLyoqXG4gICAqIFJ1bnMgZ2V0IHJlc291cmNlcyBwYXRoLlxuICAgKiBAcmV0dXJucyB7c3RyaW5nfSAtIFRoZSBwYWNrYWdlJ3MgZnJvbnRlbmQtbW9kZWwgcmVzb3VyY2VzIGRpcmVjdG9yeS5cbiAgICovXG4gIGdldFJlc291cmNlc1BhdGgoKSB7XG4gICAgcmV0dXJuIHRoaXMuX3Jlc291cmNlc1BhdGggfHwgYCR7dGhpcy5fcGF0aH0vc3JjL3Jlc291cmNlc2BcbiAgfVxuXG4gIC8qKlxuICAgKiBSdW5zIGdldCBtaWdyYXRpb25zIHBhdGguXG4gICAqIEByZXR1cm5zIHtzdHJpbmd9IC0gVGhlIHBhY2thZ2UncyBtaWdyYXRpb25zIGRpcmVjdG9yeS5cbiAgICovXG4gIGdldE1pZ3JhdGlvbnNQYXRoKCkge1xuICAgIHJldHVybiB0aGlzLl9taWdyYXRpb25zUGF0aCB8fCBgJHt0aGlzLl9wYXRofS9zcmMvZGF0YWJhc2UvbWlncmF0aW9uc2BcbiAgfVxuXG4gIC8qKlxuICAgKiBEZXJpdmVzIHRoZSBpbnRlcm5hbCBiYWNrZW5kLXByb2plY3QgZW50cnkgdGhlIGZyYW1ld29yayBhcHBlbmRzIHNvIHRoZVxuICAgKiBleGlzdGluZyByZXNvdXJjZS1kaXNjb3ZlcnkgKyBmcm9udGVuZC1tb2RlbCBnZW5lcmF0aW9uIG1hY2hpbmVyeSBwaWNrcyB1cFxuICAgKiB0aGlzIHBhY2thZ2UuIEdlbmVyYXRlZCBmcm9udGVuZCBtb2RlbHMgYXJlIHdyaXR0ZW4gdG8gdGhlIGFwcCdzIG91dHB1dC5cbiAgICogQHBhcmFtIHt7ZnJvbnRlbmRNb2RlbHNPdXRwdXRQYXRoOiBzdHJpbmcgfCB1bmRlZmluZWR9fSBhcmdzIC0gVGhlIGFwcCdzIGZyb250ZW5kLW1vZGVscyBvdXRwdXQgcGF0aC5cbiAgICogQHJldHVybnMge2ltcG9ydChcIi4uL2NvbmZpZ3VyYXRpb24tdHlwZXMuanNcIikuQmFja2VuZFByb2plY3RDb25maWd1cmF0aW9ufSAtIFRoZSBkZXJpdmVkIGJhY2tlbmQgcHJvamVjdC5cbiAgICovXG4gIHRvQmFja2VuZFByb2plY3RDb25maWd1cmF0aW9uKHtmcm9udGVuZE1vZGVsc091dHB1dFBhdGh9KSB7XG4gICAgcmV0dXJuIHtcbiAgICAgIGZyb250ZW5kTW9kZWxzT3V0cHV0UGF0aCxcbiAgICAgIHBhdGg6IHRoaXMuZ2V0UGF0aCgpLFxuICAgICAgcmVzb3VyY2VzUGF0aDogdGhpcy5nZXRSZXNvdXJjZXNQYXRoKClcbiAgICB9XG4gIH1cbn1cbiJdfQ==

package/build/src/sync/sync-api-client-types.d.ts

@@ -0,0 +1,182 @@
+export type SyncCursor = {
+    id: string | null;
+    serverSequence: number | null;
+    updatedAt: string;
+} | null;
+export type SyncChangeEnvelope = {
+    /**
+     * - Sync data payload.
+     */
+    data: () => unknown;
+    /**
+     * - Sync row identifier.
+     */
+    id: () => unknown;
+    /**
+     * - Resource identifier.
+     */
+    resourceId: () => unknown;
+    /**
+     * - Resource type name.
+     */
+    resourceType: () => string | null;
+    /**
+     * - Sync operation type.
+     */
+    syncType: () => string;
+};
+export type SyncChangeApplyResult = {
+    /**
+     * - Whether the local store changed.
+     */
+    changed: boolean;
+    /**
+     * - Applied resource type override.
+     */
+    resourceType?: string | null | undefined;
+};
+export type SyncResourceConfig = {
+    /**
+     * - Optional post-save hook.
+     */
+    afterApply?: ((args: {
+        attributes: Record<string, unknown>;
+        data: Record<string, unknown>;
+        record: unknown;
+        sync: SyncChangeEnvelope;
+    }) => Promise<boolean | void> | boolean | void) | undefined;
+    /**
+     * - Allowed attributes builder.
+     */
+    attributes: (args: {
+        data: Record<string, unknown>;
+        record: unknown;
+        sync: SyncChangeEnvelope;
+    }) => Promise<Record<string, unknown>> | Record<string, unknown>;
+    /**
+     * - Whether this resource is sync-enabled.
+     */
+    enabled: boolean;
+    /**
+     * - Optional upsert finder.
+     */
+    findRecord?: ((args: {
+        data: Record<string, unknown>;
+        resourceId: unknown;
+        sync: SyncChangeEnvelope;
+    }) => Promise<unknown> | unknown) | undefined;
+    /**
+     * - Optional destroy finder.
+     */
+    findRecordForDelete?: ((args: {
+        resourceId: unknown;
+        sync: SyncChangeEnvelope;
+    }) => Promise<unknown> | unknown) | undefined;
+    /**
+     * - Velocious model class.
+     */
+    modelClass: unknown;
+};
+export type SyncChangesRequest = {
+    /**
+     * - Auth token.
+     */
+    authenticationToken: string;
+    /**
+     * - Last seen row id.
+     */
+    afterId?: string | null | undefined;
+    /**
+     * - Last seen server sequence.
+     */
+    afterServerSequence?: number | undefined;
+    /**
+     * - Last seen timestamp.
+     */
+    afterUpdatedAt?: string | undefined;
+    /**
+     * - Page size.
+     */
+    limit: number;
+    /**
+     * - Snapshot upper-bound row id.
+     */
+    upToId?: string | null | undefined;
+    /**
+     * - Snapshot upper-bound server sequence.
+     */
+    upToServerSequence?: number | undefined;
+    /**
+     * - Snapshot upper-bound timestamp.
+     */
+    upToUpdatedAt?: string | undefined;
+};
+export type SyncChangesResponse = {
+    /**
+     * - Error message.
+     */
+    errorMessage?: string | undefined;
+    /**
+     * - Next cursor.
+     */
+    nextCursor?: Record<string, any> | SyncCursor | undefined;
+    /**
+     * - Response status.
+     */
+    status?: string | undefined;
+    /**
+     * - Sync rows.
+     */
+    syncs?: unknown[] | undefined;
+    /**
+     * - Snapshot upper-bound cursor.
+     */
+    upToCursor?: Record<string, any> | SyncCursor | undefined;
+};
+export type SyncChangesResult = {
+    /**
+     * - Whether any local record changed.
+     */
+    changed: boolean;
+    /**
+     * - Applied page count.
+     */
+    pages: number;
+    /**
+     * - Changed flags by resource type.
+     */
+    resourceChanged: Record<string, boolean>;
+    /**
+     * - Applied counts by resource type.
+     */
+    resourceCounts: Record<string, number>;
+    /**
+     * - Applied row count.
+     */
+    syncedCount: number;
+};
+export type SyncReplayItem = {
+    /**
+     * - Sync id.
+     */
+    id: string | number;
+    /**
+     * - Replay state.
+     */
+    syncState: string;
+};
+export type SyncReplayResponse = {
+    /**
+     * - Error message.
+     */
+    errorMessage?: string | undefined;
+    /**
+     * - Response status.
+     */
+    status?: string | undefined;
+    /**
+     * - Replay results.
+     */
+    syncs?: SyncReplayItem[] | undefined;
+};
+//# sourceMappingURL=sync-api-client-types.d.ts.map

package/build/src/sync/sync-api-client-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-api-client-types.d.ts","sourceRoot":"","sources":["../../../src/sync/sync-api-client-types.js"],"names":[],"mappings":"yBAMc;IAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAC,GAAG,IAAI;;;;;UAI5E,MAAM,OAAO;;;;QACb,MAAM,OAAO;;;;gBACb,MAAM,OAAO;;;;kBACb,MAAM,MAAM,GAAG,IAAI;;;;cACnB,MAAM,MAAM;;;;;;aAKZ,OAAO;;;;;;;;;;yBAMA;QAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,MAAM,EAAE,OAAC,CAAC;QAAC,IAAI,EAAE,kBAAkB,CAAA;KAAC,KAAK,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,OAAO,GAAG,IAAI;;;;gBAC7J,CAAC,IAAI,EAAE;QAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,MAAM,EAAE,OAAC,CAAC;QAAC,IAAI,EAAE,kBAAkB,CAAA;KAAC,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;;;aAC1I,OAAO;;;;yBACA;QAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,UAAU,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,kBAAkB,CAAA;KAAC,KAAK,OAAO,CAAC,OAAC,CAAC,GAAG,OAAC;;;;kCACjG;QAAC,UAAU,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,kBAAkB,CAAA;KAAC,KAAK,OAAO,CAAC,OAAC,CAAC,GAAG,OAAC;;;;gBACzE,OAAC;;;;;;yBAKD,MAAM;;;;;;;;;;;;;;;;WAIN,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAiBN,OAAO;;;;WACP,MAAM;;;;qBACN,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;;;oBACvB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;;;;iBACtB,MAAM;;;;;;QAKN,MAAM,GAAG,MAAM;;;;eACf,MAAM"}

package/build/src/sync/sync-api-client-types.js

@@ -0,0 +1,3 @@
+// @ts-check
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3luYy1hcGktY2xpZW50LXR5cGVzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3N5bmMvc3luYy1hcGktY2xpZW50LXR5cGVzLmpzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLFlBQVkiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBAdHMtY2hlY2tcblxuLyoqXG4gKiBAbW9kdWxlIHN5bmMtYXBpLWNsaWVudC10eXBlc1xuICovXG5cbi8qKiBAdHlwZWRlZiB7e2lkOiBzdHJpbmcgfCBudWxsLCBzZXJ2ZXJTZXF1ZW5jZTogbnVtYmVyIHwgbnVsbCwgdXBkYXRlZEF0OiBzdHJpbmd9IHwgbnVsbH0gU3luY0N1cnNvciAqL1xuXG4vKipcbiAqIEB0eXBlZGVmIHtvYmplY3R9IFN5bmNDaGFuZ2VFbnZlbG9wZVxuICogQHByb3BlcnR5IHsoKSA9PiB1bmtub3dufSBkYXRhIC0gU3luYyBkYXRhIHBheWxvYWQuXG4gKiBAcHJvcGVydHkgeygpID0+IHVua25vd259IGlkIC0gU3luYyByb3cgaWRlbnRpZmllci5cbiAqIEBwcm9wZXJ0eSB7KCkgPT4gdW5rbm93bn0gcmVzb3VyY2VJZCAtIFJlc291cmNlIGlkZW50aWZpZXIuXG4gKiBAcHJvcGVydHkgeygpID0+IHN0cmluZyB8IG51bGx9IHJlc291cmNlVHlwZSAtIFJlc291cmNlIHR5cGUgbmFtZS5cbiAqIEBwcm9wZXJ0eSB7KCkgPT4gc3RyaW5nfSBzeW5jVHlwZSAtIFN5bmMgb3BlcmF0aW9uIHR5cGUuXG4gKi9cblxuLyoqXG4gKiBAdHlwZWRlZiB7b2JqZWN0fSBTeW5jQ2hhbmdlQXBwbHlSZXN1bHRcbiAqIEBwcm9wZXJ0eSB7Ym9vbGVhbn0gY2hhbmdlZCAtIFdoZXRoZXIgdGhlIGxvY2FsIHN0b3JlIGNoYW5nZWQuXG4gKiBAcHJvcGVydHkge3N0cmluZyB8IG51bGx9IFtyZXNvdXJjZVR5cGVdIC0gQXBwbGllZCByZXNvdXJjZSB0eXBlIG92ZXJyaWRlLlxuICovXG5cbi8qKlxuICogQHR5cGVkZWYge29iamVjdH0gU3luY1Jlc291cmNlQ29uZmlnXG4gKiBAcHJvcGVydHkgeyhhcmdzOiB7YXR0cmlidXRlczogUmVjb3JkPHN0cmluZywgdW5rbm93bj4sIGRhdGE6IFJlY29yZDxzdHJpbmcsIHVua25vd24+LCByZWNvcmQ6ID8sIHN5bmM6IFN5bmNDaGFuZ2VFbnZlbG9wZX0pID0+IFByb21pc2U8Ym9vbGVhbiB8IHZvaWQ+IHwgYm9vbGVhbiB8IHZvaWR9IFthZnRlckFwcGx5XSAtIE9wdGlvbmFsIHBvc3Qtc2F2ZSBob29rLlxuICogQHByb3BlcnR5IHsoYXJnczoge2RhdGE6IFJlY29yZDxzdHJpbmcsIHVua25vd24+LCByZWNvcmQ6ID8sIHN5bmM6IFN5bmNDaGFuZ2VFbnZlbG9wZX0pID0+IFByb21pc2U8UmVjb3JkPHN0cmluZywgdW5rbm93bj4+IHwgUmVjb3JkPHN0cmluZywgdW5rbm93bj59IGF0dHJpYnV0ZXMgLSBBbGxvd2VkIGF0dHJpYnV0ZXMgYnVpbGRlci5cbiAqIEBwcm9wZXJ0eSB7Ym9vbGVhbn0gZW5hYmxlZCAtIFdoZXRoZXIgdGhpcyByZXNvdXJjZSBpcyBzeW5jLWVuYWJsZWQuXG4gKiBAcHJvcGVydHkgeyhhcmdzOiB7ZGF0YTogUmVjb3JkPHN0cmluZywgdW5rbm93bj4sIHJlc291cmNlSWQ6IHVua25vd24sIHN5bmM6IFN5bmNDaGFuZ2VFbnZlbG9wZX0pID0+IFByb21pc2U8Pz4gfCA/fSBbZmluZFJlY29yZF0gLSBPcHRpb25hbCB1cHNlcnQgZmluZGVyLlxuICogQHByb3BlcnR5IHsoYXJnczoge3Jlc291cmNlSWQ6IHVua25vd24sIHN5bmM6IFN5bmNDaGFuZ2VFbnZlbG9wZX0pID0+IFByb21pc2U8Pz4gfCA/fSBbZmluZFJlY29yZEZvckRlbGV0ZV0gLSBPcHRpb25hbCBkZXN0cm95IGZpbmRlci5cbiAqIEBwcm9wZXJ0eSB7P30gbW9kZWxDbGFzcyAtIFZlbG9jaW91cyBtb2RlbCBjbGFzcy5cbiAqL1xuXG4vKipcbiAqIEB0eXBlZGVmIHtvYmplY3R9IFN5bmNDaGFuZ2VzUmVxdWVzdFxuICogQHByb3BlcnR5IHtzdHJpbmd9IGF1dGhlbnRpY2F0aW9uVG9rZW4gLSBBdXRoIHRva2VuLlxuICogQHByb3BlcnR5IHtzdHJpbmcgfCBudWxsfSBbYWZ0ZXJJZF0gLSBMYXN0IHNlZW4gcm93IGlkLlxuICogQHByb3BlcnR5IHtudW1iZXJ9IFthZnRlclNlcnZlclNlcXVlbmNlXSAtIExhc3Qgc2VlbiBzZXJ2ZXIgc2VxdWVuY2UuXG4gKiBAcHJvcGVydHkge3N0cmluZ30gW2FmdGVyVXBkYXRlZEF0XSAtIExhc3Qgc2VlbiB0aW1lc3RhbXAuXG4gKiBAcHJvcGVydHkge251bWJlcn0gbGltaXQgLSBQYWdlIHNpemUuXG4gKiBAcHJvcGVydHkge3N0cmluZyB8IG51bGx9IFt1cFRvSWRdIC0gU25hcHNob3QgdXBwZXItYm91bmQgcm93IGlkLlxuICogQHByb3BlcnR5IHtudW1iZXJ9IFt1cFRvU2VydmVyU2VxdWVuY2VdIC0gU25hcHNob3QgdXBwZXItYm91bmQgc2VydmVyIHNlcXVlbmNlLlxuICogQHByb3BlcnR5IHtzdHJpbmd9IFt1cFRvVXBkYXRlZEF0XSAtIFNuYXBzaG90IHVwcGVyLWJvdW5kIHRpbWVzdGFtcC5cbiAqL1xuXG4vKipcbiAqIEB0eXBlZGVmIHtvYmplY3R9IFN5bmNDaGFuZ2VzUmVzcG9uc2VcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBbZXJyb3JNZXNzYWdlXSAtIEVycm9yIG1lc3NhZ2UuXG4gKiBAcHJvcGVydHkge1N5bmNDdXJzb3IgfCBSZWNvcmQ8c3RyaW5nLCA/Pn0gW25leHRDdXJzb3JdIC0gTmV4dCBjdXJzb3IuXG4gKiBAcHJvcGVydHkge3N0cmluZ30gW3N0YXR1c10gLSBSZXNwb25zZSBzdGF0dXMuXG4gKiBAcHJvcGVydHkge0FycmF5PHVua25vd24+fSBbc3luY3NdIC0gU3luYyByb3dzLlxuICogQHByb3BlcnR5IHtTeW5jQ3Vyc29yIHwgUmVjb3JkPHN0cmluZywgPz59IFt1cFRvQ3Vyc29yXSAtIFNuYXBzaG90IHVwcGVyLWJvdW5kIGN1cnNvci5cbiAqL1xuXG4vKipcbiAqIEB0eXBlZGVmIHtvYmplY3R9IFN5bmNDaGFuZ2VzUmVzdWx0XG4gKiBAcHJvcGVydHkge2Jvb2xlYW59IGNoYW5nZWQgLSBXaGV0aGVyIGFueSBsb2NhbCByZWNvcmQgY2hhbmdlZC5cbiAqIEBwcm9wZXJ0eSB7bnVtYmVyfSBwYWdlcyAtIEFwcGxpZWQgcGFnZSBjb3VudC5cbiAqIEBwcm9wZXJ0eSB7UmVjb3JkPHN0cmluZywgYm9vbGVhbj59IHJlc291cmNlQ2hhbmdlZCAtIENoYW5nZWQgZmxhZ3MgYnkgcmVzb3VyY2UgdHlwZS5cbiAqIEBwcm9wZXJ0eSB7UmVjb3JkPHN0cmluZywgbnVtYmVyPn0gcmVzb3VyY2VDb3VudHMgLSBBcHBsaWVkIGNvdW50cyBieSByZXNvdXJjZSB0eXBlLlxuICogQHByb3BlcnR5IHtudW1iZXJ9IHN5bmNlZENvdW50IC0gQXBwbGllZCByb3cgY291bnQuXG4gKi9cblxuLyoqXG4gKiBAdHlwZWRlZiB7b2JqZWN0fSBTeW5jUmVwbGF5SXRlbVxuICogQHByb3BlcnR5IHtzdHJpbmcgfCBudW1iZXJ9IGlkIC0gU3luYyBpZC5cbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBzeW5jU3RhdGUgLSBSZXBsYXkgc3RhdGUuXG4gKi9cblxuLyoqXG4gKiBAdHlwZWRlZiB7b2JqZWN0fSBTeW5jUmVwbGF5UmVzcG9uc2VcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBbZXJyb3JNZXNzYWdlXSAtIEVycm9yIG1lc3NhZ2UuXG4gKiBAcHJvcGVydHkge3N0cmluZ30gW3N0YXR1c10gLSBSZXNwb25zZSBzdGF0dXMuXG4gKiBAcHJvcGVydHkge0FycmF5PFN5bmNSZXBsYXlJdGVtPn0gW3N5bmNzXSAtIFJlcGxheSByZXN1bHRzLlxuICovXG5cbmV4cG9ydCB7fVxuIl19

package/build/src/sync/sync-api-client.d.ts

@@ -0,0 +1,188 @@
+/** @typedef {import("./sync-api-client-types.js").SyncChangeApplyResult} SyncChangeApplyResult */
+/** @typedef {import("./sync-api-client-types.js").SyncChangeEnvelope} SyncChangeEnvelope */
+/** @typedef {import("./sync-api-client-types.js").SyncChangesRequest} SyncChangesRequest */
+/** @typedef {import("./sync-api-client-types.js").SyncChangesResponse} SyncChangesResponse */
+/** @typedef {import("./sync-api-client-types.js").SyncChangesResult} SyncChangesResult */
+/** @typedef {import("./sync-api-client-types.js").SyncCursor} SyncCursor */
+/** @typedef {import("./sync-api-client-types.js").SyncReplayItem} SyncReplayItem */
+/** @typedef {import("./sync-api-client-types.js").SyncReplayResponse} SyncReplayResponse */
+/** @typedef {import("./sync-api-client-types.js").SyncResourceConfig} SyncResourceConfig */
+/**
+ * Generic client-side helper for replaying pending sync envelopes through the
+ * framework-owned `/velocious/sync/replay` endpoint. Apps provide only local
+ * persistence/auth hooks.
+ */
+export default class SyncApiClient {
+    /**
+     * Pulls backend sync changes in stable pages, applies them locally, and stores
+     * the acknowledged cursor. Apps provide only auth, persistence, transport, and
+     * resource policy hooks.
+     * @param {object} args - Pull args.
+     * @param {string} args.authenticationToken - Auth token to send with change requests.
+     * @param {number} [args.batchSize] - Max syncs per request. Defaults to 100.
+     * @param {() => Promise<SyncCursor | string | null | undefined>} args.loadCursor - Loads the persisted local cursor.
+     * @param {(cursor: SyncCursor) => Promise<void>} args.saveCursor - Persists the final acknowledged cursor.
+     * @param {(payload: SyncChangesRequest) => Promise<SyncChangesResponse>} args.postChanges - Posts one changes request.
+     * @param {(sync: SyncChangeEnvelope) => Promise<SyncChangeApplyResult>} args.applySync - Applies one normalized sync row locally.
+     * @param {(progress: {pages: number, syncedCount: number}) => void} [args.onProgress] - Progress callback.
+     * @returns {Promise<SyncChangesResult>} Pull result.
+     */
+    static pullChanges(args: {
+        authenticationToken: string;
+        batchSize?: number | undefined;
+        loadCursor: () => Promise<SyncCursor | string | null | undefined>;
+        saveCursor: (cursor: SyncCursor) => Promise<void>;
+        postChanges: (payload: SyncChangesRequest) => Promise<SyncChangesResponse>;
+        applySync: (sync: SyncChangeEnvelope) => Promise<SyncChangeApplyResult>;
+        onProgress?: ((progress: {
+            pages: number;
+            syncedCount: number;
+        }) => void) | undefined;
+    }): Promise<SyncChangesResult>;
+    /**
+     * Fetches and validates one backend sync changes page.
+     * @param {object} args - Page args.
+     * @param {SyncCursor} args.afterCursor - Last acknowledged cursor.
+     * @param {string} args.authenticationToken - Auth token.
+     * @param {number} args.batchSize - Page size.
+     * @param {(payload: SyncChangesRequest) => Promise<SyncChangesResponse>} args.postChanges - Changes poster.
+     * @param {SyncCursor} args.upToCursor - Snapshot upper-bound cursor.
+     * @returns {Promise<{nextCursor: SyncCursor, syncs: SyncChangeEnvelope[], upToCursor: SyncCursor}>} Normalized changes page.
+     */
+    static changesPage({ afterCursor, authenticationToken, batchSize, postChanges, upToCursor }: {
+        afterCursor: SyncCursor;
+        authenticationToken: string;
+        batchSize: number;
+        postChanges: (payload: SyncChangesRequest) => Promise<SyncChangesResponse>;
+        upToCursor: SyncCursor;
+    }): Promise<{
+        nextCursor: SyncCursor;
+        syncs: SyncChangeEnvelope[];
+        upToCursor: SyncCursor;
+    }>;
+    /**
+     * Checks API response status and shape for change-feed pulls.
+     * @param {SyncChangesResponse} response - Changes response.
+     * @returns {void}
+     */
+    static ensureSuccessfulChangesResponse(response: SyncChangesResponse): void;
+    /**
+     * Converts a cursor into request params with the given prefix.
+     * @param {"after" | "upTo"} prefix - Request field prefix.
+     * @param {SyncCursor} cursor - Cursor to serialize.
+     * @returns {Record<string, string | number | null>} Request params.
+     */
+    static cursorPayload(prefix: "after" | "upTo", cursor: SyncCursor): Record<string, string | number | null>;
+    /**
+     * Parses a persisted or response cursor payload.
+     * @param {SyncCursor | string | Record<string, ?> | null | undefined} payload - Cursor payload.
+     * @returns {SyncCursor} Parsed cursor.
+     */
+    static syncCursorFromPayload(payload: SyncCursor | string | Record<string, unknown> | null | undefined): SyncCursor;
+    /**
+     * Builds a normalized sync row adapter.
+     * @param {?} payload - Raw sync payload.
+     * @returns {SyncChangeEnvelope} Sync row adapter.
+     */
+    static syncEnvelopeFromPayload(payload: unknown): SyncChangeEnvelope;
+    /**
+     * Builds an app-configured resource applier for pulled sync rows. The sync
+     * mechanics stay here; apps only declare which models/attributes/hooks are
+     * allowed for each resource type.
+     * @param {Record<string, SyncResourceConfig>} resources - Resource policy map.
+     * @returns {(sync: SyncChangeEnvelope) => Promise<SyncChangeApplyResult>} Sync apply callback.
+     */
+    static resourceApplier(resources: Record<string, SyncResourceConfig>): (sync: SyncChangeEnvelope) => Promise<SyncChangeApplyResult>;
+    /**
+     * Applies one sync row using declarative resource policy.
+     * @param {{resources: Record<string, SyncResourceConfig>, sync: SyncChangeEnvelope}} args - Apply args.
+     * @returns {Promise<SyncChangeApplyResult>} Apply result.
+     */
+    static applyResourceSync({ resources, sync }: {
+        resources: Record<string, SyncResourceConfig>;
+        sync: SyncChangeEnvelope;
+    }): Promise<SyncChangeApplyResult>;
+    /**
+     * Destroys a synced resource via its declared model policy.
+     * @param {{resource: SyncResourceConfig, sync: SyncChangeEnvelope}} args - Destroy args.
+     * @returns {Promise<boolean>} Whether a local row was destroyed.
+     */
+    static destroySyncedResource({ resource, sync }: {
+        resource: SyncResourceConfig;
+        sync: SyncChangeEnvelope;
+    }): Promise<boolean>;
+    /**
+     * Parses the embedded sync data JSON/object.
+     * @param {SyncChangeEnvelope} sync - Sync row.
+     * @returns {Record<string, unknown>} Sync data object.
+     */
+    static syncData(sync: SyncChangeEnvelope): Record<string, unknown>;
+    /**
+     * Drains pending sync records in stable order and marks acknowledged rows.
+     * @param {object} args - Replay args.
+     * @param {string} args.authenticationToken - Auth token to send with replay requests.
+     * @param {number} [args.batchSize] - Max syncs per request. Defaults to 100.
+     * @param {() => Promise<Array<unknown>>} args.pendingSyncs - Loads pending local sync rows in replay order.
+     * @param {(sync: unknown) => string | number | null | undefined} args.syncId - Returns the local sync id.
+     * @param {(sync: unknown) => Record<string, ?>} args.syncPayload - Builds the API sync envelope.
+     * @param {(payload: {authenticationToken: string, syncs: Array<Record<string, ?>>}) => Promise<SyncReplayResponse>} args.postReplay - Posts one replay request.
+     * @param {(sync: unknown, response: SyncReplayItem) => Promise<void>} args.markSuccessful - Marks one sync as successful locally.
+     * @returns {Promise<void>} Resolves after all batches are replayed.
+     */
+    static replayPending(args: {
+        authenticationToken: string;
+        batchSize?: number | undefined;
+        pendingSyncs: () => Promise<Array<unknown>>;
+        syncId: (sync: unknown) => string | number | null | undefined;
+        syncPayload: (sync: unknown) => Record<string, unknown>;
+        postReplay: (payload: {
+            authenticationToken: string;
+            syncs: Array<Record<string, unknown>>;
+        }) => Promise<SyncReplayResponse>;
+        markSuccessful: (sync: unknown, response: SyncReplayItem) => Promise<void>;
+    }): Promise<void>;
+    /**
+     * Replays one batch of syncs.
+     * @param {object} args - Replay args.
+     * @param {string} args.authenticationToken - Auth token.
+     * @param {Array<unknown>} args.pendingSyncs - Batch syncs.
+     * @param {(sync: unknown) => string | number | null | undefined} args.syncId - Sync id getter.
+     * @param {(sync: unknown) => Record<string, ?>} args.syncPayload - Payload builder.
+     * @param {(payload: {authenticationToken: string, syncs: Array<Record<string, ?>>}) => Promise<SyncReplayResponse>} args.postReplay - Replay poster.
+     * @param {(sync: unknown, response: SyncReplayItem) => Promise<void>} args.markSuccessful - Success hook.
+     * @returns {Promise<void>} Resolves after the batch is acknowledged.
+     */
+    static replayBatch(args: {
+        authenticationToken: string;
+        pendingSyncs: Array<unknown>;
+        syncId: (sync: unknown) => string | number | null | undefined;
+        syncPayload: (sync: unknown) => Record<string, unknown>;
+        postReplay: (payload: {
+            authenticationToken: string;
+            syncs: Array<Record<string, unknown>>;
+        }) => Promise<SyncReplayResponse>;
+        markSuccessful: (sync: unknown, response: SyncReplayItem) => Promise<void>;
+    }): Promise<void>;
+    /**
+     * Checks API response status and shape.
+     * @param {SyncReplayResponse} response - Replay response.
+     * @returns {void}
+     */
+    static ensureSuccessfulResponse(response: SyncReplayResponse): void;
+    /**
+     * Normalizes a positive batch size.
+     * @param {number | undefined} batchSize - Batch size.
+     * @returns {number} Positive batch size.
+     */
+    static normalizedBatchSize(batchSize: number | undefined): number;
+}
+export type SyncChangeApplyResult = import("./sync-api-client-types.js").SyncChangeApplyResult;
+export type SyncChangeEnvelope = import("./sync-api-client-types.js").SyncChangeEnvelope;
+export type SyncChangesRequest = import("./sync-api-client-types.js").SyncChangesRequest;
+export type SyncChangesResponse = import("./sync-api-client-types.js").SyncChangesResponse;
+export type SyncChangesResult = import("./sync-api-client-types.js").SyncChangesResult;
+export type SyncCursor = import("./sync-api-client-types.js").SyncCursor;
+export type SyncReplayItem = import("./sync-api-client-types.js").SyncReplayItem;
+export type SyncReplayResponse = import("./sync-api-client-types.js").SyncReplayResponse;
+export type SyncResourceConfig = import("./sync-api-client-types.js").SyncResourceConfig;
+//# sourceMappingURL=sync-api-client.d.ts.map

package/build/src/sync/sync-api-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-api-client.d.ts","sourceRoot":"","sources":["../../../src/sync/sync-api-client.js"],"names":[],"mappings":"AAIA,kGAAkG;AAClG,4FAA4F;AAC5F,4FAA4F;AAC5F,8FAA8F;AAC9F,0FAA0F;AAC1F,4EAA4E;AAC5E,oFAAoF;AACpF,4FAA4F;AAC5F,4FAA4F;AAE5F;;;;GAIG;AACH;IACE;;;;;;;;;;;;;OAaG;IACH,yBATG;QAAqB,mBAAmB,EAAhC,MAAM;QACQ,SAAS;QACqC,UAAU,EAAtE,MAAM,OAAO,CAAC,UAAU,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QACT,UAAU,EAAtD,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC;QAC+B,WAAW,EAA/E,CAAC,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,mBAAmB,CAAC;QACM,SAAS,EAA5E,CAAC,IAAI,EAAE,kBAAkB,KAAK,OAAO,CAAC,qBAAqB,CAAC;QACI,UAAU,eAA/D;YAAC,KAAK,EAAE,MAAM,CAAC;YAAC,WAAW,EAAE,MAAM,CAAA;SAAC,KAAK,IAAI;KAChE,GAAU,OAAO,CAAC,iBAAiB,CAAC,CA2CtC;IAED;;;;;;;;;OASG;IACH,6FAPG;QAAyB,WAAW,EAA5B,UAAU;QACG,mBAAmB,EAAhC,MAAM;QACO,SAAS,EAAtB,MAAM;QAC8D,WAAW,EAA/E,CAAC,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,mBAAmB,CAAC;QAC5C,UAAU,EAA3B,UAAU;KAClB,GAAU,OAAO,CAAC;QAAC,UAAU,EAAE,UAAU,CAAC;QAAC,KAAK,EAAE,kBAAkB,EAAE,CAAC;QAAC,UAAU,EAAE,UAAU,CAAA;KAAC,CAAC,CAmBlG;IAED;;;;OAIG;IACH,iDAHW,mBAAmB,GACjB,IAAI,CAKhB;IAED;;;;;OAKG;IACH,6BAJW,OAAO,GAAG,MAAM,UAChB,UAAU,GACR,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC,CAUlD;IAED;;;;OAIG;IACH,sCAHW,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAC,CAAC,GAAG,IAAI,GAAG,SAAS,GACxD,UAAU,CAwBtB;IAED;;;;OAIG;IACH,wCAHW,OAAC,GACC,kBAAkB,CAc9B;IAED;;;;;;OAMG;IACH,kCAHW,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAChC,CAAC,IAAI,EAAE,kBAAkB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAIxE;IAED;;;;OAIG;IACH,8CAHW;QAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;QAAC,IAAI,EAAE,kBAAkB,CAAA;KAAC,GACvE,OAAO,CAAC,qBAAqB,CAAC,CA+B1C;IAED;;;;OAIG;IACH,iDAHW;QAAC,QAAQ,EAAE,kBAAkB,CAAC;QAAC,IAAI,EAAE,kBAAkB,CAAA;KAAC,GACtD,OAAO,CAAC,OAAO,CAAC,CAU5B;IAED;;;;OAIG;IACH,sBAHW,kBAAkB,GAChB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAUnC;IAED;;;;;;;;;;;OAWG;IACH,2BATG;QAAqB,mBAAmB,EAAhC,MAAM;QACQ,SAAS;QACa,YAAY,EAAhD,MAAM,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC+B,MAAM,EAAlE,CAAC,IAAI,EAAE,OAAO,KAAK,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS;QACV,WAAW,EAAtD,CAAC,IAAI,EAAE,OAAO,KAAK,MAAM,CAAC,MAAM,EAAE,OAAC,CAAC;QAC2E,UAAU,EAAzH,CAAC,OAAO,EAAE;YAAC,mBAAmB,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAC,CAAC,CAAC,CAAA;SAAC,KAAK,OAAO,CAAC,kBAAkB,CAAC;QACvC,cAAc,EAA/E,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC;KAClE,GAAU,OAAO,CAAC,IAAI,CAAC,CASzB;IAED;;;;;;;;;;OAUG;IACH,yBARG;QAAqB,mBAAmB,EAAhC,MAAM;QACe,YAAY,EAAjC,KAAK,CAAC,OAAO,CAAC;QAC8C,MAAM,EAAlE,CAAC,IAAI,EAAE,OAAO,KAAK,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS;QACV,WAAW,EAAtD,CAAC,IAAI,EAAE,OAAO,KAAK,MAAM,CAAC,MAAM,EAAE,OAAC,CAAC;QAC2E,UAAU,EAAzH,CAAC,OAAO,EAAE;YAAC,mBAAmB,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAC,CAAC,CAAC,CAAA;SAAC,KAAK,OAAO,CAAC,kBAAkB,CAAC;QACvC,cAAc,EAA/E,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC;KAClE,GAAU,OAAO,CAAC,IAAI,CAAC,CAgCzB;IAED;;;;OAIG;IACH,0CAHW,kBAAkB,GAChB,IAAI,CAKhB;IAED;;;;OAIG;IACH,sCAHW,MAAM,GAAG,SAAS,GAChB,MAAM,CAMlB;CACF;oCAjVa,OAAO,4BAA4B,EAAE,qBAAqB;iCAC1D,OAAO,4BAA4B,EAAE,kBAAkB;iCACvD,OAAO,4BAA4B,EAAE,kBAAkB;kCACvD,OAAO,4BAA4B,EAAE,mBAAmB;gCACxD,OAAO,4BAA4B,EAAE,iBAAiB;yBACtD,OAAO,4BAA4B,EAAE,UAAU;6BAC/C,OAAO,4BAA4B,EAAE,cAAc;iCACnD,OAAO,4BAA4B,EAAE,kBAAkB;iCACvD,OAAO,4BAA4B,EAAE,kBAAkB"}