@syncmatters/script-api 1.0.12 → 1.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,7 @@
1
1
  import API from "../index.js";
2
2
  import { CodedError } from "./coded-error.js";
3
3
  import { FileProvider } from "./utilities/file-provider/file-provider.js";
4
- import { SyncEndpoint, SyncSession } from "./sync.js";
4
+ import { SyncEndpoint } from "./sync.js";
5
5
  export interface Connection {
6
6
  /** org unique connection id */
7
7
  readonly id: string;
@@ -64,10 +64,10 @@ export interface Connection {
64
64
  objectIds?: string[];
65
65
  }): Promise<void>;
66
66
  /**
67
- * Requests the connection prepares for a session that will interact with sync(s)
68
- * @param options session specification.
67
+ * Constructs an endpoint through which sync(s) can interact with this connection.
68
+ * The endpoint has no active session until {@link SyncEndpoint.sessionBegin} is called.
69
69
  */
70
- syncSession?(options: SyncSession): Promise<SyncEndpoint>;
70
+ syncEndpoint?(): Promise<SyncEndpoint>;
71
71
  }
72
72
  export interface Cache {
73
73
  count: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@syncmatters/script-api",
3
- "version": "1.0.12",
3
+ "version": "1.0.13",
4
4
  "description": "TypeScript type definitions for the SyncMatters script API (types only - scripts execute on the SyncMatters platform)",
5
5
  "types": "./index.d.ts",
6
6
  "exports": {
@@ -28,7 +28,7 @@
28
28
  "license": "MIT",
29
29
  "author": "SyncMatters",
30
30
  "homepage": "https://syncmatters.com",
31
- "typesContentHash": "87bf322ba471ad760d94c31884ed28859fb460b28f3558f876ee88423eda1c92",
31
+ "typesContentHash": "5cb475fa1240d9fa9964086b867786e024b3d3b555313717aafd586bbec05675",
32
32
  "dependencies": {
33
33
  "@types/node": "*"
34
34
  }