@syncmatters/script-api 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SyncMatters
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,37 @@
+# @syncmatters/script-api
+
+TypeScript type definitions for the **SyncMatters script API**.
+
+This is a **types-only** package: it provides IntelliSense and type checking when developing
+SyncMatters integration scripts locally (for example in VS Code or Cursor). Script code executes on
+the SyncMatters platform, which provides the runtime implementation of this API.
+
+## Usage
+
+```js
+import API from "@syncmatters/script-api";
+
+/** @param {API.Context} ctx */
+export async function main(ctx) {
+  ctx.log.info("Lets connect some systems!");
+}
+```
+
+Connector test harnesses additionally use the `sdk-test` entry point:
+
+```js
+import SDKTest from "@syncmatters/script-api/sdk-test";
+```
+
+Add `"checkJs": true` to your `jsconfig.json` to activate the JSDoc type annotations used in
+script `.mjs` files.
+
+## Legacy package name
+
+`@ihq/script-api` is the legacy name of this package (IntegrateHQ is now SyncMatters).
+Existing scripts importing the legacy name continue to work on-platform.
+
+## Support
+
+- <https://syncmatters.com>
+- <support@syncmatters.com>

package/api.d.ts

@@ -0,0 +1,24 @@
+import { JsonValuesReader as JVR } from "./lib/utilities/json-utils/json-values-reader.js";
+import * as JVW from "./lib/utilities/json-utils/json-values-writer.js";
+export type ScriptType = "integration" | "scriptFile" | "parseEvents" | "verifyEventIdentity" | "agentConnection" | "syncGroup" | "connectorTest" | "connectorFeatureGenerate" | "connectionSemanticTypes" | "codeEmbedding";
+export declare const EventScriptComplete = "ScriptComplete";
+export * from "./lib/coded-error.js";
+export * from "./lib/connection.js";
+export * from "./lib/context.js";
+export * from "./lib/script-error.js";
+export * from "./lib/sync.js";
+export * from "./lib/sync-group.js";
+export * from "./lib/utilities/kv-store/types.js";
+export * from "./lib/utilities/rate-limiter/rate-limiter.js";
+export type { HttpClient, HttpClientOptions, HttpRequest, } from "./lib/utilities/http-client/types.js";
+export type JsonValuesReader = InstanceType<typeof JVR>;
+export type JsonValuesWriter = InstanceType<typeof JVW.JsonValuesWriter>;
+export type WriteBehaviour = JVW.WriteBehaviour;
+export type { CsvReaderOptions } from "./lib/utilities/csv-reader/index.js";
+export type { CsvWriterOptions } from "./lib/utilities/csv-writer/csv-writer.js";
+export type { XlsxReaderOptions } from "./lib/utilities/xlsx-reader/xlsx-reader.js";
+export type { JsonValuePathPart, JsonValuePath, } from "./lib/utilities/json-utils/json-values-types.js";
+export type { FileProvider, FileProviderOptions, } from "./lib/utilities/file-provider/file-provider.js";
+export * from "./lib/logger.js";
+export { utilities } from "./lib/utilities/utilities.js";
+export { reset } from "./lib/environment.js";

package/index.d.ts

@@ -0,0 +1,3 @@
+import * as API from "./api.js";
+export default API;
+export * from "./api.js";

package/index.js

@@ -0,0 +1 @@
+throw new Error("This package contains type definitions only - connector and script code executes on the SyncMatters platform. See https://syncmatters.com");

package/lib/coded-error.d.ts

@@ -0,0 +1,7 @@
+/**
+ * CodedError extends error to expose consistent meaningful error codes.
+ */
+export interface CodedError extends Error {
+    readonly code: string;
+    readonly data?: any;
+}