npm - @mochabug/adapt-sdk - Versions diffs - 0.1.1 - Mend

@mochabug/adapt-sdk 0.1.1

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.

Files changed (99) hide show

package/dist/types.d.ts ADDED Viewed

@@ -0,0 +1,149 @@
+/**
+ * Global type definitions for the Mochabug Adapt Plugin system.
+ * These types define the runtime environment and APIs available to plugins.
+ */
+/**
+ * Execution context providing lifecycle management for asynchronous operations.
+ */
+export interface ExecutionContext {
+    waitUntil(promise: Promise<any>): void;
+    passThroughOnException(): void;
+    abort(reason?: any): void;
+}
+export interface SocketInfo {
+    remoteAddress?: string;
+    localAddress?: string;
+}
+export interface Socket {
+    get readable(): ReadableStream;
+    get writable(): WritableStream;
+    get closed(): Promise<void>;
+    get opened(): Promise<SocketInfo>;
+    get upgraded(): boolean;
+    get secureTransport(): 'on' | 'off' | 'starttls';
+    close(): Promise<void>;
+    startTls(options?: TlsOptions): Socket;
+}
+export interface TlsOptions {
+    expectedServerHostname?: string;
+}
+export interface SocketOptions {
+    secureTransport?: 'on' | 'off' | 'starttls';
+    allowHalfOpen: boolean;
+    highWaterMark?: number | bigint;
+}
+export interface SocketAddress {
+    hostname: string;
+    port: number;
+}
+export interface Fetcher {
+    fetch(input: string | URL | Request, init?: RequestInit): Promise<Response>;
+    connect(address: SocketAddress | string, options?: SocketOptions): Socket;
+}
+/**
+ * Environment represents an interface that holds
+ * all the common runtime functionality between a plugin - configurator / executor
+ *
+ * @interface
+ */
+export interface Environment {
+    /**
+     * assets is a Fetcher that wraps the Web Platform API fetch function.
+     * It provides access to files inside the assetsDir, as defined in the manifest.json file,
+     * without requiring authentication.
+     *
+     * Note: This is a simple interface to the directory content and is not suitable for serving
+     * a full-fledged website. For example, it does not attempt to guess the `Content-Type` header.
+     * You may want to wrap this Fetcher in a plugin that fills in the metadata as required.
+     *
+     * A GET request targeting a directory (instead of a file) returns a basic JSON directory
+     * listing, like:
+     *
+     * [
+     *   {"name":"foo","type":"file"},
+     *   {"name":"bar","type":"directory"}
+     * ]
+     *
+     * For file requests, the `Content-Type` will be `application/octet-stream`, while for
+     * directory listings, it will be `application/json`. Files will have a `Content-Length`
+     * header, while directories will not.
+     *
+     * HEAD requests are optimized to perform a stat() without actually opening the file.
+     *
+     * Example Request for fetching an index.html file:
+     *   GET http://./index.html
+     *
+     * Example Response:
+     *   HTTP/1.1 200 OK
+     *   Content-Type: application/octet-stream
+     *   Content-Length: 12345
+     *
+     *   <html>
+     *   ...
+     *   </html>
+     *
+     * @type {Fetcher}
+     */
+    assets: Fetcher;
+    /**
+     * HTTP Proxy fetcher for secure requests with TLS configuration and dynamic header injection.
+     * Requests are proxied through the runtime which handles certificate validation, mTLS, and
+     * template variable substitution.
+     *
+     * Service Types:
+     * - "plugin:name" - System-level services (shared across all vertices)
+     * - "user:name" - Vertex-level services (per-user configuration)
+     *
+     * Required Headers:
+     * - X-Mochabug-Adapt-Plugin-HttpProxy-Token: Bearer token
+     * - X-Mochabug-Adapt-Plugin-HttpProxy-Path: "plugin:name" or "user:name"
+     * - Host: Target host (auto-set by helper methods)
+     *
+     * TLS Modes (from service definition):
+     * - MODE_SERVER_ONLY: Validates server cert against CA bundle
+     * - MODE_MTLS: Mutual auth requiring client cert + private key
+     *
+     * Header Injection:
+     * - Template syntax: "Bearer %ACCESS_TOKEN%" (Envoy-style)
+     * - Variables resolved from runtime configuration
+     * - Injected headers override caller's headers
+     *
+     * Error Codes:
+     * - 400: Invalid header format
+     * - 401: Invalid token or no permission
+     * - 412: Service not configured or unavailable
+     *
+     * Usage (prefer helper methods):
+     * ```typescript
+     * const fetch = api.userHttpProxy("stripe_api");
+     * const res = await fetch("https://api.stripe.com/v1/charges");
+     * ```
+     *
+     * @type {Fetcher}
+     */
+    httpproxy: Fetcher;
+    /**
+     * See the runtime.proto/PluginService for a complete reference
+     */
+    plugin: Fetcher;
+}
+/**
+ * The environment available to a executor of a plugin vertex
+ * See the runtime.proto/ExecutorService for a complete reference
+ *
+ * @interface ExecutorEnvironment
+ */
+export interface ExecutorEnvironment extends Environment {
+    executor: Fetcher;
+}
+/**
+ * The environment available to a configurator of a plugin vertex
+ * See the runtime.proto/ConfiguratorService for a complete reference
+ *
+ * @interface ConfiguratorEnvironment
+ * @property {Fetcher} configurator - the configurator API
+ */
+export interface ConfiguratorEnvironment extends Environment {
+    configurator: Fetcher;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IACvC,sBAAsB,IAAI,IAAI,CAAC;IAC/B,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,UAAU;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,QAAQ,IAAI,cAAc,CAAC;IAC/B,IAAI,QAAQ,IAAI,cAAc,CAAC;IAC/B,IAAI,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAI,MAAM,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;IAClC,IAAI,QAAQ,IAAI,OAAO,CAAC;IACxB,IAAI,eAAe,IAAI,IAAI,GAAG,KAAK,GAAG,UAAU,CAAC;IACjD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC;CACxC;AAED,MAAM,WAAW,UAAU;IACzB,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,aAAa;IAC5B,eAAe,CAAC,EAAE,IAAI,GAAG,KAAK,GAAG,UAAU,CAAC;IAC5C,aAAa,EAAE,OAAO,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,OAAO;IACtB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,GAAG,OAAO,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC5E,OAAO,CAAC,OAAO,EAAE,aAAa,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM,CAAC;CAC3E;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,uBAAwB,SAAQ,WAAW;IAC1D,YAAY,EAAE,OAAO,CAAC;CACvB"}

package/package.json ADDED Viewed

@@ -0,0 +1,80 @@
+{
+  "name": "@mochabug/adapt-sdk",
+  "version": "0.1.1",
+  "description": "The API toolkit to facilitate mochabug adapt plugin development",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    "./api": {
+      "types": "./dist/api.d.ts",
+      "import": "./dist/esm/api.mjs",
+      "require": "./dist/cjs/api.cjs"
+    },
+    "./router": {
+      "types": "./dist/router.d.ts",
+      "import": "./dist/esm/router.mjs",
+      "require": "./dist/cjs/router.cjs"
+    },
+    "./mime": {
+      "types": "./dist/mime.d.ts",
+      "import": "./dist/esm/mime.mjs",
+      "require": "./dist/cjs/mime.cjs"
+    },
+    "./frontend": {
+      "types": "./dist/frontend.d.ts",
+      "import": "./dist/esm/frontend.mjs",
+      "require": "./dist/cjs/frontend.cjs"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/esm/types.mjs",
+      "require": "./dist/cjs/types.cjs"
+    }
+  },
+  "scripts": {
+    "generate": "rm -rf src/genproto && buf generate --include-imports",
+    "build": "npm run generate && tsc --noEmit && npm run test && node build.mjs && tsc --emitDeclarationOnly",
+    "test": "jest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mochabug/adapt-plugin-toolkit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mochabug/adapt-plugin-toolkit/issues"
+  },
+  "homepage": "https://github.com/mochabug/adapt-plugin-toolkit#readme",
+  "author": "Mikael Hedberg",
+  "license": "Apache-2.0",
+  "keywords": [
+    "plugin",
+    "mochabug",
+    "adapt",
+    "intelligent automation",
+    "automation",
+    "artificial intelligence"
+  ],
+  "devDependencies": {
+    "@babel/core": "^7.28.5",
+    "@babel/preset-env": "^7.28.5",
+    "@babel/preset-typescript": "^7.28.5",
+    "@jest/globals": "^30.2.0",
+    "@types/jest": "^30.0.0",
+    "@types/mime-types": "^3.0.1",
+    "babel-jest": "^30.2.0",
+    "esbuild": "^0.27.0",
+    "jest": "^30.2.0",
+    "mime-db": "^1.54.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "path-to-regexp": "^8.3.0",
+    "@bufbuild/protobuf": "^2.10.1",
+    "@connectrpc/connect": "^2.1.1"
+  }
+}