@alwaysmeticulous/client 2.40.0

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2022, Meticulous Contributors
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# Meticulous Client
+
+Helper methods using Meticulous backend API endpoints that are accessed by multiple packages.

package/dist/api/project.api.d.ts

@@ -0,0 +1,3 @@
+import { Project } from "@alwaysmeticulous/api";
+import { AxiosInstance } from "axios";
+export declare const getProject: (client: AxiosInstance) => Promise<Project | null>;

package/dist/api/project.api.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProject = void 0;
+const axios_1 = __importDefault(require("axios"));
+const getProject = async (client) => {
+    const { data } = await client
+        .get("projects/token-info")
+        .catch((error) => {
+        var _a;
+        if (axios_1.default.isAxiosError(error)) {
+            if (((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
+                return { data: null };
+            }
+        }
+        throw error;
+    });
+    return data;
+};
+exports.getProject = getProject;

package/dist/api/replay.api.d.ts

@@ -0,0 +1,8 @@
+import { Replay } from "@alwaysmeticulous/common";
+import { AxiosInstance } from "axios";
+export declare const getReplay: (client: AxiosInstance, replayId: string) => Promise<Replay>;
+export interface ReplayDownloadUrlOutput {
+    replayId: string;
+    dowloadUrl: string;
+}
+export declare const getReplayDownloadUrl: (client: AxiosInstance, replayId: string) => Promise<ReplayDownloadUrlOutput | null>;

package/dist/api/replay.api.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getReplayDownloadUrl = exports.getReplay = void 0;
+const axios_1 = __importDefault(require("axios"));
+const getReplay = async (client, replayId) => {
+    const { data } = await client.get(`replays/${replayId}`).catch((error) => {
+        var _a;
+        if (axios_1.default.isAxiosError(error)) {
+            if (((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
+                return { data: null };
+            }
+        }
+        throw error;
+    });
+    return data;
+};
+exports.getReplay = getReplay;
+const getReplayDownloadUrl = async (client, replayId) => {
+    const { data } = await client
+        .get(`replays/${replayId}/archive-url`)
+        .catch((error) => {
+        var _a;
+        if (axios_1.default.isAxiosError(error)) {
+            if (((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
+                return { data: null };
+            }
+        }
+        throw error;
+    });
+    return data;
+};
+exports.getReplayDownloadUrl = getReplayDownloadUrl;

package/dist/api/session.api.d.ts

@@ -0,0 +1,6 @@
+import { SessionData } from "@alwaysmeticulous/api";
+import { AxiosInstance } from "axios";
+export declare const getRecordedSession: (client: AxiosInstance, sessionId: string) => Promise<any>;
+export declare const getRecordedSessionData: (client: AxiosInstance, sessionId: string) => Promise<SessionData>;
+export declare const getRecordingCommandId: (client: AxiosInstance) => Promise<string>;
+export declare const postSessionIdNotification: (client: AxiosInstance, sessionId: string, recordingCommandId: string) => Promise<void>;

package/dist/api/session.api.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.postSessionIdNotification = exports.getRecordingCommandId = exports.getRecordedSessionData = exports.getRecordedSession = void 0;
+const axios_1 = __importDefault(require("axios"));
+const getRecordedSession = async (client, sessionId) => {
+    const { data } = await client.get(`sessions/${sessionId}`).catch((error) => {
+        var _a;
+        if (axios_1.default.isAxiosError(error)) {
+            if (((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
+                return { data: null };
+            }
+        }
+        throw error;
+    });
+    return data;
+};
+exports.getRecordedSession = getRecordedSession;
+const getRecordedSessionData = async (client, sessionId) => {
+    const { data } = await client
+        .get(`sessions/${sessionId}/data`)
+        .catch((error) => {
+        var _a;
+        if (axios_1.default.isAxiosError(error)) {
+            if (((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
+                return { data: null };
+            }
+        }
+        throw error;
+    });
+    return data;
+};
+exports.getRecordedSessionData = getRecordedSessionData;
+const getRecordingCommandId = async (client) => {
+    const { data } = await client.post("sessions/start");
+    const { recordingCommandId } = data;
+    return recordingCommandId;
+};
+exports.getRecordingCommandId = getRecordingCommandId;
+const postSessionIdNotification = async (client, sessionId, recordingCommandId) => {
+    await client.post(`sessions/${sessionId}/notify`, { recordingCommandId });
+};
+exports.postSessionIdNotification = postSessionIdNotification;

package/dist/api/test-run.api.d.ts

@@ -0,0 +1,8 @@
+import { TestRun } from "@alwaysmeticulous/api";
+import { AxiosInstance } from "axios";
+export interface GetLatestTestRunOptions {
+    client: AxiosInstance;
+    commitSha: string;
+}
+export declare const getLatestTestRunResults: ({ client, commitSha, }: GetLatestTestRunOptions) => Promise<TestRun | null>;
+export declare const getLatestTestRunId: (opts: GetLatestTestRunOptions) => Promise<string | null>;

package/dist/api/test-run.api.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLatestTestRunId = exports.getLatestTestRunResults = void 0;
+const axios_1 = require("axios");
+const getLatestTestRunResults = async ({ client, commitSha, }) => {
+    var _a;
+    const { data } = await client
+        .get(`test-runs/cache?commitSha=${encodeURIComponent(commitSha)}`)
+        .catch((error) => {
+        var _a;
+        if (error instanceof axios_1.AxiosError && ((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
+            return { data: null };
+        }
+        throw error;
+    });
+    return (_a = data) !== null && _a !== void 0 ? _a : null;
+};
+exports.getLatestTestRunResults = getLatestTestRunResults;
+const getLatestTestRunId = async (opts) => {
+    var _a, _b;
+    return (_b = (_a = (await (0, exports.getLatestTestRunResults)(opts))) === null || _a === void 0 ? void 0 : _a.id) !== null && _b !== void 0 ? _b : null;
+};
+exports.getLatestTestRunId = getLatestTestRunId;

package/dist/api-token.utils.d.ts

@@ -0,0 +1 @@
+export declare const getApiToken: (apiToken: string | null | undefined) => string | null;

package/dist/api-token.utils.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getApiToken = void 0;
+const fs_1 = require("fs");
+const os_1 = require("os");
+const path_1 = require("path");
+const common_1 = require("@alwaysmeticulous/common");
+const loglevel_1 = __importDefault(require("loglevel"));
+const PERSONAL_CONFIG_FILE_PATH = ".meticulous/config.json";
+const getApiToken = (apiToken) => {
+    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
+    if (apiToken) {
+        return apiToken;
+    }
+    if (process.env["METICULOUS_API_TOKEN"]) {
+        return process.env["METICULOUS_API_TOKEN"];
+    }
+    const personalConfigFileAbsolutePath = (0, path_1.join)((0, os_1.homedir)(), PERSONAL_CONFIG_FILE_PATH);
+    if ((0, fs_1.existsSync)(personalConfigFileAbsolutePath)) {
+        const config = JSON.parse((0, fs_1.readFileSync)(personalConfigFileAbsolutePath).toString("utf-8"));
+        if (config.apiToken) {
+            logger.info(`Using apiToken from ${personalConfigFileAbsolutePath}`);
+            return config.apiToken;
+        }
+    }
+    return null;
+};
+exports.getApiToken = getApiToken;

package/dist/client.d.ts

@@ -0,0 +1,5 @@
+import { AxiosInstance } from "axios";
+export interface ClientOptions {
+    apiToken: string | null | undefined;
+}
+export declare const createClient: (options: ClientOptions) => AxiosInstance;

package/dist/client.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClient = void 0;
+const common_1 = require("@alwaysmeticulous/common");
+const axios_1 = __importDefault(require("axios"));
+const loglevel_1 = __importDefault(require("loglevel"));
+const api_token_utils_1 = require("./api-token.utils");
+const BASE_API_URL = "https://app.meticulous.ai/api/";
+const createClient = ({ apiToken: apiToken_, }) => {
+    const apiToken = (0, api_token_utils_1.getApiToken)(apiToken_);
+    if (!apiToken) {
+        const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
+        logger.error("You must provide an API token by using the --apiToken parameter");
+        process.exit(1);
+    }
+    return axios_1.default.create({
+        baseURL: getApiUrl(),
+        headers: {
+            authorization: apiToken,
+        },
+    });
+};
+exports.createClient = createClient;
+const getApiUrl = () => {
+    if (process.env["METICULOUS_API_URL"]) {
+        return process.env["METICULOUS_API_URL"];
+    }
+    return BASE_API_URL;
+};

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { getProject } from "./api/project.api";
+export { getRecordedSession, getRecordedSessionData, getRecordingCommandId, postSessionIdNotification, } from "./api/session.api";
+export { getLatestTestRunId, getLatestTestRunResults, GetLatestTestRunOptions, } from "./api/test-run.api";
+export { getReplay, getReplayDownloadUrl } from "./api/replay.api";
+export { createClient, ClientOptions } from "./client";

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClient = exports.getReplayDownloadUrl = exports.getReplay = exports.getLatestTestRunResults = exports.getLatestTestRunId = exports.postSessionIdNotification = exports.getRecordingCommandId = exports.getRecordedSessionData = exports.getRecordedSession = exports.getProject = void 0;
+var project_api_1 = require("./api/project.api");
+Object.defineProperty(exports, "getProject", { enumerable: true, get: function () { return project_api_1.getProject; } });
+var session_api_1 = require("./api/session.api");
+Object.defineProperty(exports, "getRecordedSession", { enumerable: true, get: function () { return session_api_1.getRecordedSession; } });
+Object.defineProperty(exports, "getRecordedSessionData", { enumerable: true, get: function () { return session_api_1.getRecordedSessionData; } });
+Object.defineProperty(exports, "getRecordingCommandId", { enumerable: true, get: function () { return session_api_1.getRecordingCommandId; } });
+Object.defineProperty(exports, "postSessionIdNotification", { enumerable: true, get: function () { return session_api_1.postSessionIdNotification; } });
+var test_run_api_1 = require("./api/test-run.api");
+Object.defineProperty(exports, "getLatestTestRunId", { enumerable: true, get: function () { return test_run_api_1.getLatestTestRunId; } });
+Object.defineProperty(exports, "getLatestTestRunResults", { enumerable: true, get: function () { return test_run_api_1.getLatestTestRunResults; } });
+var replay_api_1 = require("./api/replay.api");
+Object.defineProperty(exports, "getReplay", { enumerable: true, get: function () { return replay_api_1.getReplay; } });
+Object.defineProperty(exports, "getReplayDownloadUrl", { enumerable: true, get: function () { return replay_api_1.getReplayDownloadUrl; } });
+var client_1 = require("./client");
+Object.defineProperty(exports, "createClient", { enumerable: true, get: function () { return client_1.createClient; } });

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@alwaysmeticulous/client",
+  "version": "2.40.0",
+  "description": "Helper methods for using the Meticulous backend API",
+  "license": "ISC",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rimraf dist tsconfig.tsbuildinfo",
+    "build": "tsc --build tsconfig.json",
+    "dev": "tsc --build tsconfig.json --watch",
+    "format": "prettier --write src",
+    "lint": "eslint src --ext=ts,tsx,js --cache",
+    "lint:commit": "eslint --cache $(git diff --relative --name-only --diff-filter=ACMRTUXB master | grep  -E \"(.js$|.ts$|.tsx$)\")",
+    "lint:fix": "eslint src --ext=ts,tsx,js --cache --fix"
+  },
+  "dependencies": {
+    "@alwaysmeticulous/common": "^2.40.0",
+    "axios": "^1.2.6"
+  },
+  "author": {
+    "name": "The Meticulous Team",
+    "email": "eng@meticulous.ai",
+    "url": "https://meticulous.ai"
+  },
+  "engines": {
+    "node": ">= 12"
+  },
+  "homepage": "https://github.com/alwaysmeticulous/meticulous-sdk",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/alwaysmeticulous/meticulous-sdk.git",
+    "directory": "packages/cli"
+  },
+  "bugs": {
+    "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
+  },
+  "gitHead": "d62af712d37801e6df9c5d4d091a97b084baa51c"
+}