@ethlete/agent-rules 0.1.0-next.1 → 0.1.0-next.10

package/src/lib/timetrack.d.ts

@@ -0,0 +1,86 @@
+export type TimetrackIssue = {
+    key: string;
+    id: string;
+    summary: string;
+    issueType: string;
+    parentKey?: string;
+    subject?: string;
+};
+export type TimetrackStatus = {
+    version: number;
+    jiraReady: boolean;
+    projects: {
+        key: string;
+        name: string;
+    }[];
+    subjectField: string;
+};
+export type TimetrackInstance = {
+    levels: {
+        hierarchyLevel: number;
+        typeNames: string[];
+    }[];
+    suggestedParenting: 'parent-field' | 'issue-link';
+    subjectFieldCandidates: {
+        id: string;
+        name: string;
+    }[];
+};
+export type TimetrackRepoProject = {
+    repoPath: string;
+    projectKey?: string;
+    private: boolean;
+    inherited: boolean;
+    suggestedProjectKey?: string;
+};
+export type TimetrackWorklog = {
+    day: string;
+    issueKey: string;
+    description: string;
+    fromMs: number;
+    toMs: number;
+    durationMs: number;
+};
+/**
+ * Where the app writes the port and the token, which is its data directory on each platform.
+ *
+ * `TIMETRACK_AGENT_DISCOVERY` names the file directly, for a machine whose app data lives somewhere
+ * else and for a test.
+ */
+export declare const timetrackDiscoveryPath: () => string;
+/**
+ * Asks the running Timetrack app to carry out one operation.
+ *
+ * It is the only way this package reaches Jira. The token lives in the app's keychain entry and in no
+ * repository, so a checkout an agent works in holds nothing worth stealing and nothing to rotate.
+ */
+export declare const askTimetrack: <T>(request: Record<string, unknown> & {
+    op: string;
+}) => Promise<T>;
+export declare const timetrackStatus: () => Promise<TimetrackStatus>;
+export declare const timetrackInstance: () => Promise<TimetrackInstance>;
+export declare const timetrackIssue: (key: string) => Promise<TimetrackIssue>;
+export declare const timetrackSearch: (options: {
+    text?: string;
+    projectKey?: string;
+    assignedToMe?: boolean;
+    limit?: number;
+}) => Promise<TimetrackIssue[]>;
+export declare const timetrackRepoProject: (repoPath: string) => Promise<TimetrackRepoProject>;
+export declare const timetrackCreateIssue: (options: {
+    summary: string;
+    description?: string;
+    projectKey?: string;
+    issueTypeName?: string;
+    parentKey?: string;
+    subject?: string;
+}) => Promise<{
+    key: string;
+    id: string;
+}>;
+export declare const timetrackAddWorklog: (options: {
+    issueKey: string;
+    description?: string;
+    fromMs: number;
+    durationMs: number;
+}) => Promise<TimetrackWorklog>;

package/src/lib/timetrack.js

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.timetrackAddWorklog = exports.timetrackCreateIssue = exports.timetrackRepoProject = exports.timetrackSearch = exports.timetrackIssue = exports.timetrackInstance = exports.timetrackStatus = exports.askTimetrack = exports.timetrackDiscoveryPath = void 0;
+const tslib_1 = require("tslib");
+const fs_1 = require("fs");
+const os_1 = require("os");
+const path_1 = require("path");
+/** The Timetrack app's bundle identifier, which is also the name of its data directory. */
+const IDENTIFIER = 'io.ethlete.timetrack';
+const DISCOVERY_FILENAME = 'agent.json';
+/**
+ * The contract version this client speaks. The app writes its own into the discovery file, and a
+ * mismatch stops here rather than at a field that is missing for a reason nobody can see.
+ */
+const PROTOCOL_VERSION = 1;
+/** A Jira search behind a slow instance is the long case; the app's own deadline is 60 seconds. */
+const TIMEOUT_MS = 70000;
+const PATH = '/agent';
+const NOT_RUNNING = [
+    'Timetrack is not running, so no Jira credentials are reachable.',
+    'Start the app — it holds the token for every repository on this machine — then try again.',
+].join('\n');
+/**
+ * Where the app writes the port and the token, which is its data directory on each platform.
+ *
+ * `TIMETRACK_AGENT_DISCOVERY` names the file directly, for a machine whose app data lives somewhere
+ * else and for a test.
+ */
+const timetrackDiscoveryPath = () => {
+    var _a, _b, _c;
+    const override = (_a = process.env['TIMETRACK_AGENT_DISCOVERY']) === null || _a === void 0 ? void 0 : _a.trim();
+    if (override)
+        return override;
+    const home = (0, os_1.homedir)();
+    if ((0, os_1.platform)() === 'darwin')
+        return (0, path_1.join)(home, 'Library', 'Application Support', IDENTIFIER, DISCOVERY_FILENAME);
+    if ((0, os_1.platform)() === 'win32') {
+        const appData = (_b = process.env['APPDATA']) === null || _b === void 0 ? void 0 : _b.trim();
+        return (0, path_1.join)(appData || (0, path_1.join)(home, 'AppData', 'Roaming'), IDENTIFIER, DISCOVERY_FILENAME);
+    }
+    const dataHome = (_c = process.env['XDG_DATA_HOME']) === null || _c === void 0 ? void 0 : _c.trim();
+    return (0, path_1.join)(dataHome || (0, path_1.join)(home, '.local', 'share'), IDENTIFIER, DISCOVERY_FILENAME);
+};
+exports.timetrackDiscoveryPath = timetrackDiscoveryPath;
+const readDiscovery = () => {
+    const path = (0, exports.timetrackDiscoveryPath)();
+    if (!(0, fs_1.existsSync)(path))
+        throw new Error(NOT_RUNNING);
+    let parsed;
+    try {
+        parsed = JSON.parse((0, fs_1.readFileSync)(path, 'utf8'));
+    }
+    catch (_a) {
+        throw new Error(`${path} is not readable JSON. Restart Timetrack, which rewrites it at every start.`);
+    }
+    const discovery = parsed;
+    if (typeof discovery.port !== 'number' || typeof discovery.token !== 'string') {
+        throw new Error(`${path} names no port and token. Restart Timetrack, which rewrites it at every start.`);
+    }
+    if (discovery.version !== PROTOCOL_VERSION) {
+        throw new Error(`Timetrack speaks version ${discovery.version} of the agent contract and this CLI speaks ${PROTOCOL_VERSION}. Update whichever is older.`);
+    }
+    return { version: discovery.version, port: discovery.port, token: discovery.token };
+};
+/**
+ * Asks the running Timetrack app to carry out one operation.
+ *
+ * It is the only way this package reaches Jira. The token lives in the app's keychain entry and in no
+ * repository, so a checkout an agent works in holds nothing worth stealing and nothing to rotate.
+ */
+const askTimetrack = (request) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    const discovery = readDiscovery();
+    let response;
+    try {
+        response = yield fetch(`http://127.0.0.1:${discovery.port}${PATH}`, {
+            method: 'POST',
+            headers: { authorization: `Bearer ${discovery.token}`, 'content-type': 'application/json' },
+            body: JSON.stringify(request),
+            signal: AbortSignal.timeout(TIMEOUT_MS),
+        });
+    }
+    catch (_a) {
+        // The file is there and the socket is not, which is what a discovery file left behind by an app
+        // that has since stopped looks like.
+        throw new Error(NOT_RUNNING);
+    }
+    if (response.status === 401) {
+        throw new Error('Timetrack refused the token. It writes a new one at every start — restart the app.');
+    }
+    if (!response.ok)
+        throw new Error(`Timetrack answered ${response.status} ${response.statusText}.`);
+    const answer = (yield response.json());
+    if (!answer.ok)
+        throw new Error(answer.message);
+    return answer.value;
+});
+exports.askTimetrack = askTimetrack;
+const timetrackStatus = () => (0, exports.askTimetrack)({ op: 'status' });
+exports.timetrackStatus = timetrackStatus;
+const timetrackInstance = () => (0, exports.askTimetrack)({ op: 'jira.instance' });
+exports.timetrackInstance = timetrackInstance;
+const timetrackIssue = (key) => tslib_1.__awaiter(void 0, void 0, void 0, function* () { return (yield (0, exports.askTimetrack)({ op: 'jira.issue', key })).issue; });
+exports.timetrackIssue = timetrackIssue;
+const timetrackSearch = (options) => tslib_1.__awaiter(void 0, void 0, void 0, function* () { return (yield (0, exports.askTimetrack)(Object.assign({ op: 'jira.search' }, options))).issues; });
+exports.timetrackSearch = timetrackSearch;
+const timetrackRepoProject = (repoPath) => (0, exports.askTimetrack)({ op: 'repo.project', repoPath });
+exports.timetrackRepoProject = timetrackRepoProject;
+const timetrackCreateIssue = (options) => tslib_1.__awaiter(void 0, void 0, void 0, function* () { return (yield (0, exports.askTimetrack)(Object.assign({ op: 'jira.create' }, options))).issue; });
+exports.timetrackCreateIssue = timetrackCreateIssue;
+const timetrackAddWorklog = (options) => tslib_1.__awaiter(void 0, void 0, void 0, function* () { return (yield (0, exports.askTimetrack)(Object.assign({ op: 'worklog.add' }, options))).worklog; });
+exports.timetrackAddWorklog = timetrackAddWorklog;
+//# sourceMappingURL=timetrack.js.map

package/src/lib/timetrack.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timetrack.js","sourceRoot":"","sources":["../../../../../libs/agent-rules/src/lib/timetrack.ts"],"names":[],"mappings":";;;;AAAA,2BAA8C;AAC9C,2BAAuC;AACvC,+BAA4B;AAE5B,2FAA2F;AAC3F,MAAM,UAAU,GAAG,sBAAsB,CAAC;AAE1C,MAAM,kBAAkB,GAAG,YAAY,CAAC;AAExC;;;GAGG;AACH,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAE3B,mGAAmG;AACnG,MAAM,UAAU,GAAG,KAAM,CAAC;AAE1B,MAAM,IAAI,GAAG,QAAQ,CAAC;AA6CtB,MAAM,WAAW,GAAG;IAClB,iEAAiE;IACjE,2FAA2F;CAC5F,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEb;;;;;GAKG;AACI,MAAM,sBAAsB,GAAG,GAAG,EAAE;;IACzC,MAAM,QAAQ,GAAG,MAAA,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,0CAAE,IAAI,EAAE,CAAC;IAElE,IAAI,QAAQ;QAAE,OAAO,QAAQ,CAAC;IAE9B,MAAM,IAAI,GAAG,IAAA,YAAO,GAAE,CAAC;IAEvB,IAAI,IAAA,aAAQ,GAAE,KAAK,QAAQ;QAAE,OAAO,IAAA,WAAI,EAAC,IAAI,EAAE,SAAS,EAAE,qBAAqB,EAAE,UAAU,EAAE,kBAAkB,CAAC,CAAC;IAEjH,IAAI,IAAA,aAAQ,GAAE,KAAK,OAAO,EAAE,CAAC;QAC3B,MAAM,OAAO,GAAG,MAAA,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,0CAAE,IAAI,EAAE,CAAC;QAE/C,OAAO,IAAA,WAAI,EAAC,OAAO,IAAI,IAAA,WAAI,EAAC,IAAI,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,UAAU,EAAE,kBAAkB,CAAC,CAAC;IAC3F,CAAC;IAED,MAAM,QAAQ,GAAG,MAAA,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,0CAAE,IAAI,EAAE,CAAC;IAEtD,OAAO,IAAA,WAAI,EAAC,QAAQ,IAAI,IAAA,WAAI,EAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,UAAU,EAAE,kBAAkB,CAAC,CAAC;AACzF,CAAC,CAAC;AAlBW,QAAA,sBAAsB,0BAkBjC;AAEF,MAAM,aAAa,GAAG,GAAc,EAAE;IACpC,MAAM,IAAI,GAAG,IAAA,8BAAsB,GAAE,CAAC;IAEtC,IAAI,CAAC,IAAA,eAAU,EAAC,IAAI,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;IAEpD,IAAI,MAAe,CAAC;IAEpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,iBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IAClD,CAAC;IAAC,WAAM,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,6EAA6E,CAAC,CAAC;IACxG,CAAC;IAED,MAAM,SAAS,GAAG,MAA4B,CAAC;IAE/C,IAAI,OAAO,SAAS,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,SAAS,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9E,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,gFAAgF,CAAC,CAAC;IAC3G,CAAC;IAED,IAAI,SAAS,CAAC,OAAO,KAAK,gBAAgB,EAAE,CAAC;QAC3C,MAAM,IAAI,KAAK,CACb,4BAA4B,SAAS,CAAC,OAAO,8CAA8C,gBAAgB,8BAA8B,CAC1I,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,CAAC;AACtF,CAAC,CAAC;AAEF;;;;;GAKG;AACI,MAAM,YAAY,GAAG,CAAU,OAAiD,EAAc,EAAE;IACrG,MAAM,SAAS,GAAG,aAAa,EAAE,CAAC;IAClC,IAAI,QAAkB,CAAC;IAEvB,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,KAAK,CAAC,oBAAoB,SAAS,CAAC,IAAI,GAAG,IAAI,EAAE,EAAE;YAClE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,SAAS,CAAC,KAAK,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC3F,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC7B,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC;SACxC,CAAC,CAAC;IACL,CAAC;IAAC,WAAM,CAAC;QACP,gGAAgG;QAChG,qCAAqC;QACrC,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;IAC/B,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAC;IACxG,CAAC;IAED,IAAI,CAAC,QAAQ,CAAC,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,GAAG,CAAC,CAAC;IAEnG,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAc,CAAC;IAEpD,IAAI,CAAC,MAAM,CAAC,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAEhD,OAAO,MAAM,CAAC,KAAK,CAAC;AACtB,CAAC,CAAA,CAAC;AA5BW,QAAA,YAAY,gBA4BvB;AAEK,MAAM,eAAe,GAAG,GAAG,EAAE,CAAC,IAAA,oBAAY,EAAkB,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;AAAxE,QAAA,eAAe,mBAAyD;AAE9E,MAAM,iBAAiB,GAAG,GAAG,EAAE,CAAC,IAAA,oBAAY,EAAoB,EAAE,EAAE,EAAE,eAAe,EAAE,CAAC,CAAC;AAAnF,QAAA,iBAAiB,qBAAkE;AAEzF,MAAM,cAAc,GAAG,CAAO,GAAW,EAAE,EAAE,0DAClD,OAAA,CAAC,MAAM,IAAA,oBAAY,EAA4B,EAAE,EAAE,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA,GAAA,CAAC;AADtE,QAAA,cAAc,kBACwD;AAE5E,MAAM,eAAe,GAAG,CAAO,OAKrC,EAAE,EAAE,0DAAC,OAAA,CAAC,MAAM,IAAA,oBAAY,kBAAiC,EAAE,EAAE,aAAa,IAAK,OAAO,EAAG,CAAC,CAAC,MAAM,CAAA,GAAA,CAAC;AALtF,QAAA,eAAe,mBAKuE;AAE5F,MAAM,oBAAoB,GAAG,CAAC,QAAgB,EAAE,EAAE,CACvD,IAAA,oBAAY,EAAuB,EAAE,EAAE,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,CAAC;AAD1D,QAAA,oBAAoB,wBACsC;AAEhE,MAAM,oBAAoB,GAAG,CAAO,OAO1C,EAAE,EAAE,0DAAC,OAAA,CAAC,MAAM,IAAA,oBAAY,kBAA2C,EAAE,EAAE,aAAa,IAAK,OAAO,EAAG,CAAC,CAAC,KAAK,CAAA,GAAA,CAAC;AAP/F,QAAA,oBAAoB,wBAO2E;AAErG,MAAM,mBAAmB,GAAG,CAAO,OAKzC,EAAE,EAAE,0DAAC,OAAA,CAAC,MAAM,IAAA,oBAAY,kBAAkC,EAAE,EAAE,aAAa,IAAK,OAAO,EAAG,CAAC,CAAC,OAAO,CAAA,GAAA,CAAC;AALxF,QAAA,mBAAmB,uBAKqE"}