@syncmatters/script-api 1.0.12 → 1.0.14

package/lib/connection.d.ts

@@ -1,7 +1,7 @@
 import API from "../index.js";
 import { CodedError } from "./coded-error.js";
 import { FileProvider } from "./utilities/file-provider/file-provider.js";
-import { SyncEndpoint, SyncSession } from "./sync.js";
+import { SyncEndpoint } from "./sync.js";
 export interface Connection {
     /** org unique connection id */
     readonly id: string;
@@ -64,10 +64,10 @@ export interface Connection {
         objectIds?: string[];
     }): Promise<void>;
     /**
-     * Requests the connection prepares for a session that will interact with sync(s)
-     * @param options session specification.
+     * Constructs an endpoint through which sync(s) can interact with this connection.
+     * The endpoint has no active session until {@link SyncEndpoint.sessionBegin} is called.
      */
-    syncSession?(options: SyncSession): Promise<SyncEndpoint>;
+    syncEndpoint?(): Promise<SyncEndpoint>;
 }
 export interface Cache {
     count: {

package/lib/utilities/xml-utils/types.d.ts

@@ -22,6 +22,12 @@ export interface XmlParseOptions {
      * When set, xmlParse streams matching elements; omit for a full-document Promise.
      */
     emit?: string[];
+    /**
+     * XPath subset expressions (same syntax as `emit`) naming elements to prune: a matching
+     * element and its whole subtree are dropped before any `emit` matching or recording, so
+     * documents padded with unread markup cost neither parse time nor memory. Requires `emit`.
+     */
+    skip?: string[];
 }
 /**
  * One matched element from a streaming xmlParse({ source, emit }) call.

package/lib/utilities/xml-utils/xpath-subset.d.ts

@@ -17,9 +17,10 @@ export declare function localNameOf(qname: string): string;
 /**
  * Compile one XPath-subset expression.
  * Supported: `//Name`, `/A/B/C`, `A/B` (local names only; prefixes ignored).
+ * `label` names the option being compiled so errors point at `emit` or `skip`.
  */
-export declare function compileEmitExpression(raw: string): XmlEmitMatcher;
-export declare function compileEmitExpressions(emit: string[]): XmlEmitMatcher[];
+export declare function compileEmitExpression(raw: string, label?: string): XmlEmitMatcher;
+export declare function compileEmitExpressions(expressions: string[], label?: string): XmlEmitMatcher[];
 /** True if the current element stack (local names) matches the compiled expression. */
 export declare function matchesEmit(matcher: XmlEmitMatcher, pathLocalNames: string[]): boolean;
 /** Last path step local name for a matcher (the element that starts a potential match). */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncmatters/script-api",
-  "version": "1.0.12",
+  "version": "1.0.14",
   "description": "TypeScript type definitions for the SyncMatters script API (types only - scripts execute on the SyncMatters platform)",
   "types": "./index.d.ts",
   "exports": {
@@ -28,7 +28,7 @@
   "license": "MIT",
   "author": "SyncMatters",
   "homepage": "https://syncmatters.com",
-  "typesContentHash": "87bf322ba471ad760d94c31884ed28859fb460b28f3558f876ee88423eda1c92",
+  "typesContentHash": "1908da7a9d689fba3b76a80a652493ef9028ab6cebb2e1c08db9f2cc3cb9ffa5",
   "dependencies": {
     "@types/node": "*"
   }