@weavix/tracker-api-plugin 0.0.1

package/README.md

@@ -0,0 +1,25 @@
+# @weavix/tracker-api-plugin
+
+Typed Tracker API client for iframe plugins. Sends `api.tracker.call` requests through the
+generic plugin bridge (`@weavix/sdk-core`'s `sendRequest`) — no dependency on Tracker's own
+slot/entity types (`@weavix/tracker-core`), so any host's plugin can install this package to
+reach the Tracker HTTP API.
+
+The host side of the contract is implemented by `@yandex-weavix/tracker-api-host`, which any
+service running `@yandex-weavix/plugin-host-core` can register as a domain.
+
+```bash
+pnpm add @weavix/tracker-api-plugin @weavix/sdk-core
+```
+
+```ts
+import { trackerApi } from '@weavix/tracker-api-plugin';
+
+const { data } = await trackerApi.v3.get['/issues/{issueKey}']({
+    pathParams: { issueKey: 'TEST-1' },
+});
+```
+
+`trackerApi.v3.get/post/put/patch/delete` are typed against `@weavix/tracker-api-types`'
+`ApiV3*Methods` maps. `ApiContract`, `ApiCallPayload`, and `ApiCallResult` are exported for host
+implementers.

package/dist/api/trackerApi.d.ts

@@ -0,0 +1,23 @@
+import { ApiV3DeleteMethods, ApiV3GetMethods, ApiV3PatchMethods, ApiV3PostMethods, ApiV3PutMethods } from '@weavix/tracker-api-types';
+import { TrackerApiCallOptions as BaseCallOptions, TrackerApiInitOptions as BaseInitOptions } from './trackerApiBase';
+export type TrackerApiCallOptions = BaseCallOptions;
+export type TrackerApiInitOptions = BaseInitOptions;
+type ApiResult<M> = {
+    [K in keyof M]: M[K] extends (...args: infer A) => Promise<infer R> ? (...args: A) => Promise<{
+        data: R;
+        headers: Record<string, string>;
+    }> : never;
+};
+export interface TrackerApiV3 {
+    get: ApiResult<ApiV3GetMethods>;
+    post: ApiResult<ApiV3PostMethods>;
+    put: ApiResult<ApiV3PutMethods>;
+    patch: ApiResult<ApiV3PatchMethods>;
+    delete: ApiResult<ApiV3DeleteMethods>;
+}
+export interface TrackerApi {
+    v3: TrackerApiV3;
+}
+export declare const trackerApi: TrackerApi;
+export {};
+//# sourceMappingURL=trackerApi.d.ts.map

package/dist/api/trackerApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trackerApi.d.ts","sourceRoot":"","sources":["../../src/api/trackerApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EAClB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EACH,KAAK,qBAAqB,IAAI,eAAe,EAC7C,KAAK,qBAAqB,IAAI,eAAe,EAEhD,MAAM,kBAAkB,CAAC;AAE1B,MAAM,MAAM,qBAAqB,GAAG,eAAe,CAAC;AACpD,MAAM,MAAM,qBAAqB,GAAG,eAAe,CAAC;AAEpD,KAAK,SAAS,CAAC,CAAC,IAAI;KACf,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,GAC7D,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC;QAAE,IAAI,EAAE,CAAC,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC,GACrE,KAAK;CACd,CAAC;AAEF,MAAM,WAAW,YAAY;IACzB,GAAG,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC;IAChC,IAAI,EAAE,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAClC,GAAG,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC;IAChC,KAAK,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAC;IACpC,MAAM,EAAE,SAAS,CAAC,kBAAkB,CAAC,CAAC;CACzC;AAED,MAAM,WAAW,UAAU;IACvB,EAAE,EAAE,YAAY,CAAC;CACpB;AAED,eAAO,MAAM,UAAU,EAAgC,UAAU,CAAC"}

package/dist/api/trackerApiBase.d.ts

@@ -0,0 +1,28 @@
+export type TrackerApiCallOptions = {
+    pathParams?: Record<string, string>;
+    queryParams?: Record<string, unknown>;
+    bodyParams?: Record<string, unknown>;
+    file?: File;
+};
+export type TrackerApiInitOptions = {
+    apiVersion?: string;
+};
+/**
+ * Untyped runtime API class. The `v3` method nodes (`get`, `post`, ...) are Proxies that
+ * accept any string path key and build a call from it. Typing is added on top via a cast
+ * (see `./trackerApi.ts`).
+ */
+export declare class TrackerApi {
+    private static readonly V3_VERSION;
+    get v3(): {
+        get: Record<string, (opts: TrackerApiCallOptions) => Promise<unknown>>;
+        post: Record<string, (opts: TrackerApiCallOptions) => Promise<unknown>>;
+        put: Record<string, (opts: TrackerApiCallOptions) => Promise<unknown>>;
+        patch: Record<string, (opts: TrackerApiCallOptions) => Promise<unknown>>;
+        delete: Record<string, (opts: TrackerApiCallOptions) => Promise<unknown>>;
+    };
+    private createMethodProxy;
+    private call;
+}
+export declare const trackerApi: TrackerApi;
+//# sourceMappingURL=trackerApiBase.d.ts.map

package/dist/api/trackerApiBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trackerApiBase.d.ts","sourceRoot":"","sources":["../../src/api/trackerApiBase.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,qBAAqB,GAAG;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,IAAI,CAAC,EAAE,IAAI,CAAC;CACf,CAAC;AAmBF,MAAM,MAAM,qBAAqB,GAAG;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,qBAAa,UAAU;IACnB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAQ;IAE1C,IAAI,EAAE,IAAI;QACN,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;QACvE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;QACxE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;QACvE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;QACzE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;KAC7E,CAQA;IAED,OAAO,CAAC,iBAAiB;IAYzB,OAAO,CAAC,IAAI;CASf;AAED,eAAO,MAAM,UAAU,YAAmB,CAAC"}

package/dist/api/trackerApiContract.d.ts

@@ -0,0 +1,8 @@
+import { ApiCallPayload, ApiCallResult } from './types';
+export type ApiContract = {
+    'api.tracker.call': {
+        payload: ApiCallPayload;
+        result: ApiCallResult;
+    };
+};
+//# sourceMappingURL=trackerApiContract.d.ts.map

package/dist/api/trackerApiContract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trackerApiContract.d.ts","sourceRoot":"","sources":["../../src/api/trackerApiContract.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7D,MAAM,MAAM,WAAW,GAAG;IACtB,kBAAkB,EAAE;QAChB,OAAO,EAAE,cAAc,CAAC;QACxB,MAAM,EAAE,aAAa,CAAC;KACzB,CAAC;CACL,CAAC"}

package/dist/api/types.d.ts

@@ -0,0 +1,14 @@
+export type ApiCallResult = {
+    data: unknown;
+    headers: Record<string, string>;
+};
+export type ApiCallPayload = {
+    version: string;
+    method: string;
+    url: string;
+    pathParams: Record<string, string>;
+    queryParams: Record<string, unknown>;
+    bodyParams: Record<string, unknown>;
+    file?: File;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/api/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/api/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG;IACxB,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,IAAI,CAAC,EAAE,IAAI,CAAC;CACf,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { trackerApi } from './api/trackerApi';
+export type { TrackerApi, TrackerApiCallOptions, TrackerApiInitOptions, TrackerApiV3, } from './api/trackerApi';
+export type { ApiContract } from './api/trackerApiContract';
+export type { ApiCallPayload, ApiCallResult } from './api/types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,YAAY,EACR,UAAU,EACV,qBAAqB,EACrB,qBAAqB,EACrB,YAAY,GACf,MAAM,kBAAkB,CAAC;AAE1B,YAAY,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.mjs

@@ -0,0 +1,42 @@
+import { sendRequest as e } from "@weavix/sdk-core";
+//#region src/api/trackerApiBase.ts
+function t(e, t, n = {}, r) {
+	return {
+		version: r,
+		method: e,
+		url: t,
+		pathParams: n.pathParams ?? {},
+		queryParams: n.queryParams ?? {},
+		bodyParams: n.bodyParams ?? {},
+		file: n.file
+	};
+}
+//#endregion
+//#region src/api/trackerApi.ts
+var n = new class n {
+	static {
+		this.V3_VERSION = "v3";
+	}
+	get v3() {
+		return {
+			get: this.createMethodProxy("GET"),
+			post: this.createMethodProxy("POST"),
+			put: this.createMethodProxy("PUT"),
+			patch: this.createMethodProxy("PATCH"),
+			delete: this.createMethodProxy("DELETE")
+		};
+	}
+	createMethodProxy(e) {
+		let t = this;
+		return new Proxy({}, { get(r, i) {
+			return (r) => t.call(e, i, r, n.V3_VERSION);
+		} });
+	}
+	call(n, r, i = {}, a) {
+		return e("api.tracker.call", t(n, r, i, a));
+	}
+}();
+//#endregion
+export { n as trackerApi };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/api/trackerApiBase.ts","../src/api/trackerApi.ts"],"sourcesContent":["import { sendRequest } from '@weavix/sdk-core';\nimport type { ApiCallPayload, ApiCallResult } from './types';\n\nexport type TrackerApiCallOptions = {\n    pathParams?: Record<string, string>;\n    queryParams?: Record<string, unknown>;\n    bodyParams?: Record<string, unknown>;\n    file?: File;\n};\n\nfunction buildPayload(\n    method: string,\n    url: string,\n    options: TrackerApiCallOptions = {},\n    version: string,\n): ApiCallPayload {\n    return {\n        version,\n        method,\n        url,\n        pathParams: options.pathParams ?? {},\n        queryParams: options.queryParams ?? {},\n        bodyParams: options.bodyParams ?? {},\n        file: options.file,\n    };\n}\n\nexport type TrackerApiInitOptions = {\n    apiVersion?: string;\n};\n\n/**\n * Untyped runtime API class. The `v3` method nodes (`get`, `post`, ...) are Proxies that\n * accept any string path key and build a call from it. Typing is added on top via a cast\n * (see `./trackerApi.ts`).\n */\nexport class TrackerApi {\n    private static readonly V3_VERSION = 'v3';\n\n    get v3(): {\n        get: Record<string, (opts: TrackerApiCallOptions) => Promise<unknown>>;\n        post: Record<string, (opts: TrackerApiCallOptions) => Promise<unknown>>;\n        put: Record<string, (opts: TrackerApiCallOptions) => Promise<unknown>>;\n        patch: Record<string, (opts: TrackerApiCallOptions) => Promise<unknown>>;\n        delete: Record<string, (opts: TrackerApiCallOptions) => Promise<unknown>>;\n    } {\n        return {\n            get: this.createMethodProxy('GET'),\n            post: this.createMethodProxy('POST'),\n            put: this.createMethodProxy('PUT'),\n            patch: this.createMethodProxy('PATCH'),\n            delete: this.createMethodProxy('DELETE'),\n        };\n    }\n\n    private createMethodProxy(\n        method: string,\n    ): Record<string, (opts: TrackerApiCallOptions) => Promise<unknown>> {\n        const self = this;\n        return new Proxy({} as Record<string, (opts: TrackerApiCallOptions) => Promise<unknown>>, {\n            get(_, path: string) {\n                return (payload: TrackerApiCallOptions) =>\n                    self.call(method, path, payload, TrackerApi.V3_VERSION);\n            },\n        });\n    }\n\n    private call(\n        method: string,\n        url: string,\n        options: TrackerApiCallOptions = {},\n        requestVersion: string,\n    ): Promise<ApiCallResult> {\n        const payload: ApiCallPayload = buildPayload(method, url, options, requestVersion);\n        return sendRequest('api.tracker.call', payload) as Promise<ApiCallResult>;\n    }\n}\n\nexport const trackerApi = new TrackerApi();\n","import type {\n    ApiV3DeleteMethods,\n    ApiV3GetMethods,\n    ApiV3PatchMethods,\n    ApiV3PostMethods,\n    ApiV3PutMethods,\n} from '@weavix/tracker-api-types';\n\nimport {\n    type TrackerApiCallOptions as BaseCallOptions,\n    type TrackerApiInitOptions as BaseInitOptions,\n    trackerApi as trackerApiBase,\n} from './trackerApiBase';\n\nexport type TrackerApiCallOptions = BaseCallOptions;\nexport type TrackerApiInitOptions = BaseInitOptions;\n\ntype ApiResult<M> = {\n    [K in keyof M]: M[K] extends (...args: infer A) => Promise<infer R>\n        ? (...args: A) => Promise<{ data: R; headers: Record<string, string> }>\n        : never;\n};\n\nexport interface TrackerApiV3 {\n    get: ApiResult<ApiV3GetMethods>;\n    post: ApiResult<ApiV3PostMethods>;\n    put: ApiResult<ApiV3PutMethods>;\n    patch: ApiResult<ApiV3PatchMethods>;\n    delete: ApiResult<ApiV3DeleteMethods>;\n}\n\nexport interface TrackerApi {\n    v3: TrackerApiV3;\n}\n\nexport const trackerApi = trackerApiBase as unknown as TrackerApi;\n"],"mappings":";;AAUA,SAAS,EACL,GACA,GACA,IAAiC,CAAC,GAClC,GACc;CACd,OAAO;EACH;EACA;EACA;EACA,YAAY,EAAQ,cAAc,CAAC;EACnC,aAAa,EAAQ,eAAe,CAAC;EACrC,YAAY,EAAQ,cAAc,CAAC;EACnC,MAAM,EAAQ;CAClB;AACJ;;;ACUA,IAAa,IAAa,ID2CI,MA1CjB,EAAW;;oBACiB;;CAErC,IAAI,KAMF;EACE,OAAO;GACH,KAAK,KAAK,kBAAkB,KAAK;GACjC,MAAM,KAAK,kBAAkB,MAAM;GACnC,KAAK,KAAK,kBAAkB,KAAK;GACjC,OAAO,KAAK,kBAAkB,OAAO;GACrC,QAAQ,KAAK,kBAAkB,QAAQ;EAC3C;CACJ;CAEA,kBACI,GACiE;EACjE,IAAM,IAAO;EACb,OAAO,IAAI,MAAM,CAAC,GAAwE,EACtF,IAAI,GAAG,GAAc;GACjB,QAAQ,MACJ,EAAK,KAAK,GAAQ,GAAM,GAAS,EAAW,UAAU;EAC9D,EACJ,CAAC;CACL;CAEA,KACI,GACA,GACA,IAAiC,CAAC,GAClC,GACsB;EAEtB,OAAO,EAAY,oBADa,EAAa,GAAQ,GAAK,GAAS,CAC5B,CAAO;CAClD;AACJ,ECzC0B"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@weavix/tracker-api-plugin",
+  "version": "0.0.1",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [],
+  "author": "Tracker Team",
+  "license": "UNLICENSED",
+  "description": "Typed Tracker API client for plugins, host-agnostic (works with any @weavix/sdk-core plugin)",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@weavix/sdk-core": ">=0.0.0",
+    "@weavix/tracker-api-types": ">=0.0.0"
+  },
+  "devDependencies": {
+    "@weavix/tracker-api-types": "*",
+    "@types/jest": "*",
+    "@weavix/sdk-core": "0.0.0"
+  },
+  "scripts": {
+    "build": "vite build",
+    "typecheck": "tsc --noEmit"
+  }
+}