@harness-engineering/types 0.0.0
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.
- package/LICENSE +21 -0
- package/README.md +68 -0
- package/dist/.tsbuildinfo +1 -0
- package/dist/index.d.mts +95 -0
- package/dist/index.d.ts +95 -0
- package/dist/index.js +57 -0
- package/dist/index.mjs +28 -0
- package/package.json +49 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Intense Visions, Inc.
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# @harness-engineering/types
|
|
2
|
+
|
|
3
|
+
Shared TypeScript types for harness-engineering packages.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @harness-engineering/types
|
|
9
|
+
# or
|
|
10
|
+
pnpm add @harness-engineering/types
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { Result, Ok, Err, isOk, isErr } from '@harness-engineering/types';
|
|
17
|
+
|
|
18
|
+
// Create successful result
|
|
19
|
+
const success: Result<number, never> = Ok(42);
|
|
20
|
+
|
|
21
|
+
// Create error result
|
|
22
|
+
const failure: Result<never, string> = Err('Something went wrong');
|
|
23
|
+
|
|
24
|
+
// Type-safe error handling
|
|
25
|
+
function divide(a: number, b: number): Result<number, string> {
|
|
26
|
+
if (b === 0) {
|
|
27
|
+
return Err('Division by zero');
|
|
28
|
+
}
|
|
29
|
+
return Ok(a / b);
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
const result = divide(10, 2);
|
|
33
|
+
if (isOk(result)) {
|
|
34
|
+
console.log(result.value); // 5
|
|
35
|
+
} else {
|
|
36
|
+
console.error(result.error);
|
|
37
|
+
}
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## API
|
|
41
|
+
|
|
42
|
+
### `Result<T, E>`
|
|
43
|
+
|
|
44
|
+
Type-safe error handling used across all harness-engineering APIs.
|
|
45
|
+
|
|
46
|
+
```typescript
|
|
47
|
+
type Result<T, E = Error> = { ok: true; value: T } | { ok: false; error: E };
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### `Ok<T>(value: T)`
|
|
51
|
+
|
|
52
|
+
Creates a successful Result.
|
|
53
|
+
|
|
54
|
+
### `Err<E>(error: E)`
|
|
55
|
+
|
|
56
|
+
Creates a failed Result.
|
|
57
|
+
|
|
58
|
+
### `isOk<T, E>(result: Result<T, E>)`
|
|
59
|
+
|
|
60
|
+
Type guard to check if Result is Ok.
|
|
61
|
+
|
|
62
|
+
### `isErr<T, E>(result: Result<T, E>)`
|
|
63
|
+
|
|
64
|
+
Type guard to check if Result is Err.
|
|
65
|
+
|
|
66
|
+
## License
|
|
67
|
+
|
|
68
|
+
MIT
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"fileNames":["../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2016.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2017.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2018.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2019.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2020.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2021.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.collection.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.generator.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.promise.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.proxy.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.reflect.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.symbol.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2016.array.include.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2016.intl.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2017.arraybuffer.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2017.date.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2017.object.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2017.sharedmemory.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2017.string.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2017.intl.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2017.typedarrays.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2018.asynciterable.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2018.intl.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2018.promise.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2018.regexp.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2019.array.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2019.object.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2019.string.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2019.symbol.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2019.intl.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2020.bigint.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2020.date.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2020.promise.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2020.sharedmemory.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2020.string.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2020.symbol.wellknown.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2020.intl.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2020.number.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2021.promise.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2021.string.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2021.weakref.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2021.intl.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.array.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.intl.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.object.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.string.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.regexp.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.decorators.d.ts","../../../node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.decorators.legacy.d.ts","../src/index.ts"],"fileInfos":[{"version":"c430d44666289dae81f30fa7b2edebf186ecc91a2d4c71266ea6ae76388792e1","affectsGlobalScope":true,"impliedFormat":1},{"version":"45b7ab580deca34ae9729e97c13cfd999df04416a79116c3bfb483804f85ded4","impliedFormat":1},{"version":"3facaf05f0c5fc569c5649dd359892c98a85557e3e0c847964caeb67076f4d75","impliedFormat":1},{"version":"e44bb8bbac7f10ecc786703fe0a6a4b952189f908707980ba8f3c8975a760962","impliedFormat":1},{"version":"5e1c4c362065a6b95ff952c0eab010f04dcd2c3494e813b493ecfd4fcb9fc0d8","impliedFormat":1},{"version":"68d73b4a11549f9c0b7d352d10e91e5dca8faa3322bfb77b661839c42b1ddec7","impliedFormat":1},{"version":"5efce4fc3c29ea84e8928f97adec086e3dc876365e0982cc8479a07954a3efd4","impliedFormat":1},{"version":"feecb1be483ed332fad555aff858affd90a48ab19ba7272ee084704eb7167569","impliedFormat":1},{"version":"ee7bad0c15b58988daa84371e0b89d313b762ab83cb5b31b8a2d1162e8eb41c2","impliedFormat":1},{"version":"c57796738e7f83dbc4b8e65132f11a377649c00dd3eee333f672b8f0a6bea671","affectsGlobalScope":true,"impliedFormat":1},{"version":"dc2df20b1bcdc8c2d34af4926e2c3ab15ffe1160a63e58b7e09833f616efff44","affectsGlobalScope":true,"impliedFormat":1},{"version":"515d0b7b9bea2e31ea4ec968e9edd2c39d3eebf4a2d5cbd04e88639819ae3b71","affectsGlobalScope":true,"impliedFormat":1},{"version":"0559b1f683ac7505ae451f9a96ce4c3c92bdc71411651ca6ddb0e88baaaad6a3","affectsGlobalScope":true,"impliedFormat":1},{"version":"0dc1e7ceda9b8b9b455c3a2d67b0412feab00bd2f66656cd8850e8831b08b537","affectsGlobalScope":true,"impliedFormat":1},{"version":"ce691fb9e5c64efb9547083e4a34091bcbe5bdb41027e310ebba8f7d96a98671","affectsGlobalScope":true,"impliedFormat":1},{"version":"8d697a2a929a5fcb38b7a65594020fcef05ec1630804a33748829c5ff53640d0","affectsGlobalScope":true,"impliedFormat":1},{"version":"4ff2a353abf8a80ee399af572debb8faab2d33ad38c4b4474cff7f26e7653b8d","affectsGlobalScope":true,"impliedFormat":1},{"version":"fb0f136d372979348d59b3f5020b4cdb81b5504192b1cacff5d1fbba29378aa1","affectsGlobalScope":true,"impliedFormat":1},{"version":"d15bea3d62cbbdb9797079416b8ac375ae99162a7fba5de2c6c505446486ac0a","affectsGlobalScope":true,"impliedFormat":1},{"version":"68d18b664c9d32a7336a70235958b8997ebc1c3b8505f4f1ae2b7e7753b87618","affectsGlobalScope":true,"impliedFormat":1},{"version":"eb3d66c8327153d8fa7dd03f9c58d351107fe824c79e9b56b462935176cdf12a","affectsGlobalScope":true,"impliedFormat":1},{"version":"38f0219c9e23c915ef9790ab1d680440d95419ad264816fa15009a8851e79119","affectsGlobalScope":true,"impliedFormat":1},{"version":"69ab18c3b76cd9b1be3d188eaf8bba06112ebbe2f47f6c322b5105a6fbc45a2e","affectsGlobalScope":true,"impliedFormat":1},{"version":"a680117f487a4d2f30ea46f1b4b7f58bef1480456e18ba53ee85c2746eeca012","affectsGlobalScope":true,"impliedFormat":1},{"version":"2f11ff796926e0832f9ae148008138ad583bd181899ab7dd768a2666700b1893","affectsGlobalScope":true,"impliedFormat":1},{"version":"4de680d5bb41c17f7f68e0419412ca23c98d5749dcaaea1896172f06435891fc","affectsGlobalScope":true,"impliedFormat":1},{"version":"954296b30da6d508a104a3a0b5d96b76495c709785c1d11610908e63481ee667","affectsGlobalScope":true,"impliedFormat":1},{"version":"ac9538681b19688c8eae65811b329d3744af679e0bdfa5d842d0e32524c73e1c","affectsGlobalScope":true,"impliedFormat":1},{"version":"0a969edff4bd52585473d24995c5ef223f6652d6ef46193309b3921d65dd4376","affectsGlobalScope":true,"impliedFormat":1},{"version":"9e9fbd7030c440b33d021da145d3232984c8bb7916f277e8ffd3dc2e3eae2bdb","affectsGlobalScope":true,"impliedFormat":1},{"version":"811ec78f7fefcabbda4bfa93b3eb67d9ae166ef95f9bff989d964061cbf81a0c","affectsGlobalScope":true,"impliedFormat":1},{"version":"717937616a17072082152a2ef351cb51f98802fb4b2fdabd32399843875974ca","affectsGlobalScope":true,"impliedFormat":1},{"version":"d7e7d9b7b50e5f22c915b525acc5a49a7a6584cf8f62d0569e557c5cfc4b2ac2","affectsGlobalScope":true,"impliedFormat":1},{"version":"71c37f4c9543f31dfced6c7840e068c5a5aacb7b89111a4364b1d5276b852557","affectsGlobalScope":true,"impliedFormat":1},{"version":"576711e016cf4f1804676043e6a0a5414252560eb57de9faceee34d79798c850","affectsGlobalScope":true,"impliedFormat":1},{"version":"89c1b1281ba7b8a96efc676b11b264de7a8374c5ea1e6617f11880a13fc56dc6","affectsGlobalScope":true,"impliedFormat":1},{"version":"74f7fa2d027d5b33eb0471c8e82a6c87216223181ec31247c357a3e8e2fddc5b","affectsGlobalScope":true,"impliedFormat":1},{"version":"d6d7ae4d1f1f3772e2a3cde568ed08991a8ae34a080ff1151af28b7f798e22ca","affectsGlobalScope":true,"impliedFormat":1},{"version":"063600664504610fe3e99b717a1223f8b1900087fab0b4cad1496a114744f8df","affectsGlobalScope":true,"impliedFormat":1},{"version":"934019d7e3c81950f9a8426d093458b65d5aff2c7c1511233c0fd5b941e608ab","affectsGlobalScope":true,"impliedFormat":1},{"version":"52ada8e0b6e0482b728070b7639ee42e83a9b1c22d205992756fe020fd9f4a47","affectsGlobalScope":true,"impliedFormat":1},{"version":"3bdefe1bfd4d6dee0e26f928f93ccc128f1b64d5d501ff4a8cf3c6371200e5e6","affectsGlobalScope":true,"impliedFormat":1},{"version":"59fb2c069260b4ba00b5643b907ef5d5341b167e7d1dbf58dfd895658bda2867","affectsGlobalScope":true,"impliedFormat":1},{"version":"639e512c0dfc3fad96a84caad71b8834d66329a1f28dc95e3946c9b58176c73a","affectsGlobalScope":true,"impliedFormat":1},{"version":"368af93f74c9c932edd84c58883e736c9e3d53cec1fe24c0b0ff451f529ceab1","affectsGlobalScope":true,"impliedFormat":1},{"version":"af3dd424cf267428f30ccfc376f47a2c0114546b55c44d8c0f1d57d841e28d74","affectsGlobalScope":true,"impliedFormat":1},{"version":"995c005ab91a498455ea8dfb63aa9f83fa2ea793c3d8aa344be4a1678d06d399","affectsGlobalScope":true,"impliedFormat":1},{"version":"959d36cddf5e7d572a65045b876f2956c973a586da58e5d26cde519184fd9b8a","affectsGlobalScope":true,"impliedFormat":1},{"version":"965f36eae237dd74e6cca203a43e9ca801ce38824ead814728a2807b1910117d","affectsGlobalScope":true,"impliedFormat":1},{"version":"3925a6c820dcb1a06506c90b1577db1fdbf7705d65b62b99dce4be75c637e26b","affectsGlobalScope":true,"impliedFormat":1},{"version":"0a3d63ef2b853447ec4f749d3f368ce642264246e02911fcb1590d8c161b8005","affectsGlobalScope":true,"impliedFormat":1},{"version":"8cdf8847677ac7d20486e54dd3fcf09eda95812ac8ace44b4418da1bbbab6eb8","affectsGlobalScope":true,"impliedFormat":1},{"version":"8444af78980e3b20b49324f4a16ba35024fef3ee069a0eb67616ea6ca821c47a","affectsGlobalScope":true,"impliedFormat":1},{"version":"3287d9d085fbd618c3971944b65b4be57859f5415f495b33a6adc994edd2f004","affectsGlobalScope":true,"impliedFormat":1},{"version":"b4b67b1a91182421f5df999988c690f14d813b9850b40acd06ed44691f6727ad","affectsGlobalScope":true,"impliedFormat":1},{"version":"8e7f8264d0fb4c5339605a15daadb037bf238c10b654bb3eee14208f860a32ea","affectsGlobalScope":true,"impliedFormat":1},{"version":"782dec38049b92d4e85c1585fbea5474a219c6984a35b004963b00beb1aab538","affectsGlobalScope":true,"impliedFormat":1},"3882d8a8d077e769586ad54b8b65ec72c158db91bc928684e6bebdb38fda0abd"],"root":[58],"options":{"composite":true,"declaration":true,"declarationMap":true,"esModuleInterop":true,"exactOptionalPropertyTypes":true,"module":99,"noFallthroughCasesInSwitch":true,"noUncheckedIndexedAccess":true,"noUnusedLocals":true,"noUnusedParameters":true,"outDir":"./","rootDir":"../src","skipLibCheck":true,"sourceMap":true,"strict":true,"target":9,"tsBuildInfoFile":"./.tsbuildinfo"},"affectedFilesPendingEmit":[[58,51]],"emitSignatures":[58],"version":"5.9.3"}
|
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @harness-engineering/types
|
|
3
|
+
*
|
|
4
|
+
* Core types and interfaces for Harness Engineering toolkit
|
|
5
|
+
*/
|
|
6
|
+
type Result<T, E = Error> = {
|
|
7
|
+
ok: true;
|
|
8
|
+
value: T;
|
|
9
|
+
} | {
|
|
10
|
+
ok: false;
|
|
11
|
+
error: E;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* Creates a successful Result
|
|
15
|
+
*/
|
|
16
|
+
declare function Ok<T>(value: T): Result<T, never>;
|
|
17
|
+
/**
|
|
18
|
+
* Creates a failed Result
|
|
19
|
+
*/
|
|
20
|
+
declare function Err<E>(error: E): Result<never, E>;
|
|
21
|
+
/**
|
|
22
|
+
* Type guard to check if a Result is successful
|
|
23
|
+
*/
|
|
24
|
+
declare function isOk<T, E>(result: Result<T, E>): result is {
|
|
25
|
+
ok: true;
|
|
26
|
+
value: T;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* Type guard to check if a Result is failed
|
|
30
|
+
*/
|
|
31
|
+
declare function isErr<T, E>(result: Result<T, E>): result is {
|
|
32
|
+
ok: false;
|
|
33
|
+
error: E;
|
|
34
|
+
};
|
|
35
|
+
interface WorkflowStep {
|
|
36
|
+
skill: string;
|
|
37
|
+
produces: string;
|
|
38
|
+
expects?: string;
|
|
39
|
+
gate?: 'pass-required' | 'advisory';
|
|
40
|
+
}
|
|
41
|
+
interface Workflow {
|
|
42
|
+
name: string;
|
|
43
|
+
steps: WorkflowStep[];
|
|
44
|
+
}
|
|
45
|
+
type StepOutcome = 'pass' | 'fail' | 'skipped';
|
|
46
|
+
interface WorkflowStepResult {
|
|
47
|
+
step: WorkflowStep;
|
|
48
|
+
outcome: StepOutcome;
|
|
49
|
+
artifact?: string;
|
|
50
|
+
error?: string;
|
|
51
|
+
durationMs: number;
|
|
52
|
+
}
|
|
53
|
+
interface WorkflowResult {
|
|
54
|
+
workflow: Workflow;
|
|
55
|
+
stepResults: WorkflowStepResult[];
|
|
56
|
+
pass: boolean;
|
|
57
|
+
totalDurationMs: number;
|
|
58
|
+
}
|
|
59
|
+
declare const STANDARD_COGNITIVE_MODES: readonly ["adversarial-reviewer", "constructive-architect", "meticulous-implementer", "diagnostic-investigator", "advisory-guide", "meticulous-verifier"];
|
|
60
|
+
type CognitiveMode = (typeof STANDARD_COGNITIVE_MODES)[number] | (string & {});
|
|
61
|
+
interface SkillMetadata {
|
|
62
|
+
name: string;
|
|
63
|
+
version: string;
|
|
64
|
+
description: string;
|
|
65
|
+
cognitive_mode?: CognitiveMode;
|
|
66
|
+
}
|
|
67
|
+
interface SkillContext {
|
|
68
|
+
skillName: string;
|
|
69
|
+
phase: string;
|
|
70
|
+
files: string[];
|
|
71
|
+
/** Optional token budget — uses a plain record to avoid cross-package deps. */
|
|
72
|
+
tokenBudget?: Record<string, number>;
|
|
73
|
+
metadata: Record<string, unknown>;
|
|
74
|
+
}
|
|
75
|
+
interface TurnContext extends SkillContext {
|
|
76
|
+
turnNumber: number;
|
|
77
|
+
previousResults: unknown[];
|
|
78
|
+
}
|
|
79
|
+
type SkillError = {
|
|
80
|
+
code: string;
|
|
81
|
+
message: string;
|
|
82
|
+
phase: string;
|
|
83
|
+
};
|
|
84
|
+
type SkillResult = {
|
|
85
|
+
success: boolean;
|
|
86
|
+
artifacts: string[];
|
|
87
|
+
summary: string;
|
|
88
|
+
};
|
|
89
|
+
interface SkillLifecycleHooks {
|
|
90
|
+
preExecution?: (context: SkillContext) => SkillContext | null;
|
|
91
|
+
perTurn?: (context: TurnContext) => TurnContext | null;
|
|
92
|
+
postExecution?: (context: SkillContext, result: SkillResult) => void;
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
export { type CognitiveMode, Err, Ok, type Result, STANDARD_COGNITIVE_MODES, type SkillContext, type SkillError, type SkillLifecycleHooks, type SkillMetadata, type SkillResult, type StepOutcome, type TurnContext, type Workflow, type WorkflowResult, type WorkflowStep, type WorkflowStepResult, isErr, isOk };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @harness-engineering/types
|
|
3
|
+
*
|
|
4
|
+
* Core types and interfaces for Harness Engineering toolkit
|
|
5
|
+
*/
|
|
6
|
+
type Result<T, E = Error> = {
|
|
7
|
+
ok: true;
|
|
8
|
+
value: T;
|
|
9
|
+
} | {
|
|
10
|
+
ok: false;
|
|
11
|
+
error: E;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* Creates a successful Result
|
|
15
|
+
*/
|
|
16
|
+
declare function Ok<T>(value: T): Result<T, never>;
|
|
17
|
+
/**
|
|
18
|
+
* Creates a failed Result
|
|
19
|
+
*/
|
|
20
|
+
declare function Err<E>(error: E): Result<never, E>;
|
|
21
|
+
/**
|
|
22
|
+
* Type guard to check if a Result is successful
|
|
23
|
+
*/
|
|
24
|
+
declare function isOk<T, E>(result: Result<T, E>): result is {
|
|
25
|
+
ok: true;
|
|
26
|
+
value: T;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* Type guard to check if a Result is failed
|
|
30
|
+
*/
|
|
31
|
+
declare function isErr<T, E>(result: Result<T, E>): result is {
|
|
32
|
+
ok: false;
|
|
33
|
+
error: E;
|
|
34
|
+
};
|
|
35
|
+
interface WorkflowStep {
|
|
36
|
+
skill: string;
|
|
37
|
+
produces: string;
|
|
38
|
+
expects?: string;
|
|
39
|
+
gate?: 'pass-required' | 'advisory';
|
|
40
|
+
}
|
|
41
|
+
interface Workflow {
|
|
42
|
+
name: string;
|
|
43
|
+
steps: WorkflowStep[];
|
|
44
|
+
}
|
|
45
|
+
type StepOutcome = 'pass' | 'fail' | 'skipped';
|
|
46
|
+
interface WorkflowStepResult {
|
|
47
|
+
step: WorkflowStep;
|
|
48
|
+
outcome: StepOutcome;
|
|
49
|
+
artifact?: string;
|
|
50
|
+
error?: string;
|
|
51
|
+
durationMs: number;
|
|
52
|
+
}
|
|
53
|
+
interface WorkflowResult {
|
|
54
|
+
workflow: Workflow;
|
|
55
|
+
stepResults: WorkflowStepResult[];
|
|
56
|
+
pass: boolean;
|
|
57
|
+
totalDurationMs: number;
|
|
58
|
+
}
|
|
59
|
+
declare const STANDARD_COGNITIVE_MODES: readonly ["adversarial-reviewer", "constructive-architect", "meticulous-implementer", "diagnostic-investigator", "advisory-guide", "meticulous-verifier"];
|
|
60
|
+
type CognitiveMode = (typeof STANDARD_COGNITIVE_MODES)[number] | (string & {});
|
|
61
|
+
interface SkillMetadata {
|
|
62
|
+
name: string;
|
|
63
|
+
version: string;
|
|
64
|
+
description: string;
|
|
65
|
+
cognitive_mode?: CognitiveMode;
|
|
66
|
+
}
|
|
67
|
+
interface SkillContext {
|
|
68
|
+
skillName: string;
|
|
69
|
+
phase: string;
|
|
70
|
+
files: string[];
|
|
71
|
+
/** Optional token budget — uses a plain record to avoid cross-package deps. */
|
|
72
|
+
tokenBudget?: Record<string, number>;
|
|
73
|
+
metadata: Record<string, unknown>;
|
|
74
|
+
}
|
|
75
|
+
interface TurnContext extends SkillContext {
|
|
76
|
+
turnNumber: number;
|
|
77
|
+
previousResults: unknown[];
|
|
78
|
+
}
|
|
79
|
+
type SkillError = {
|
|
80
|
+
code: string;
|
|
81
|
+
message: string;
|
|
82
|
+
phase: string;
|
|
83
|
+
};
|
|
84
|
+
type SkillResult = {
|
|
85
|
+
success: boolean;
|
|
86
|
+
artifacts: string[];
|
|
87
|
+
summary: string;
|
|
88
|
+
};
|
|
89
|
+
interface SkillLifecycleHooks {
|
|
90
|
+
preExecution?: (context: SkillContext) => SkillContext | null;
|
|
91
|
+
perTurn?: (context: TurnContext) => TurnContext | null;
|
|
92
|
+
postExecution?: (context: SkillContext, result: SkillResult) => void;
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
export { type CognitiveMode, Err, Ok, type Result, STANDARD_COGNITIVE_MODES, type SkillContext, type SkillError, type SkillLifecycleHooks, type SkillMetadata, type SkillResult, type StepOutcome, type TurnContext, type Workflow, type WorkflowResult, type WorkflowStep, type WorkflowStepResult, isErr, isOk };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// src/index.ts
|
|
21
|
+
var index_exports = {};
|
|
22
|
+
__export(index_exports, {
|
|
23
|
+
Err: () => Err,
|
|
24
|
+
Ok: () => Ok,
|
|
25
|
+
STANDARD_COGNITIVE_MODES: () => STANDARD_COGNITIVE_MODES,
|
|
26
|
+
isErr: () => isErr,
|
|
27
|
+
isOk: () => isOk
|
|
28
|
+
});
|
|
29
|
+
module.exports = __toCommonJS(index_exports);
|
|
30
|
+
function Ok(value) {
|
|
31
|
+
return { ok: true, value };
|
|
32
|
+
}
|
|
33
|
+
function Err(error) {
|
|
34
|
+
return { ok: false, error };
|
|
35
|
+
}
|
|
36
|
+
function isOk(result) {
|
|
37
|
+
return result.ok === true;
|
|
38
|
+
}
|
|
39
|
+
function isErr(result) {
|
|
40
|
+
return result.ok === false;
|
|
41
|
+
}
|
|
42
|
+
var STANDARD_COGNITIVE_MODES = [
|
|
43
|
+
"adversarial-reviewer",
|
|
44
|
+
"constructive-architect",
|
|
45
|
+
"meticulous-implementer",
|
|
46
|
+
"diagnostic-investigator",
|
|
47
|
+
"advisory-guide",
|
|
48
|
+
"meticulous-verifier"
|
|
49
|
+
];
|
|
50
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
51
|
+
0 && (module.exports = {
|
|
52
|
+
Err,
|
|
53
|
+
Ok,
|
|
54
|
+
STANDARD_COGNITIVE_MODES,
|
|
55
|
+
isErr,
|
|
56
|
+
isOk
|
|
57
|
+
});
|
package/dist/index.mjs
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
// src/index.ts
|
|
2
|
+
function Ok(value) {
|
|
3
|
+
return { ok: true, value };
|
|
4
|
+
}
|
|
5
|
+
function Err(error) {
|
|
6
|
+
return { ok: false, error };
|
|
7
|
+
}
|
|
8
|
+
function isOk(result) {
|
|
9
|
+
return result.ok === true;
|
|
10
|
+
}
|
|
11
|
+
function isErr(result) {
|
|
12
|
+
return result.ok === false;
|
|
13
|
+
}
|
|
14
|
+
var STANDARD_COGNITIVE_MODES = [
|
|
15
|
+
"adversarial-reviewer",
|
|
16
|
+
"constructive-architect",
|
|
17
|
+
"meticulous-implementer",
|
|
18
|
+
"diagnostic-investigator",
|
|
19
|
+
"advisory-guide",
|
|
20
|
+
"meticulous-verifier"
|
|
21
|
+
];
|
|
22
|
+
export {
|
|
23
|
+
Err,
|
|
24
|
+
Ok,
|
|
25
|
+
STANDARD_COGNITIVE_MODES,
|
|
26
|
+
isErr,
|
|
27
|
+
isOk
|
|
28
|
+
};
|
package/package.json
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@harness-engineering/types",
|
|
3
|
+
"version": "0.0.0",
|
|
4
|
+
"description": "TypeScript types and interfaces for Harness Engineering",
|
|
5
|
+
"main": "./dist/index.js",
|
|
6
|
+
"module": "./dist/index.mjs",
|
|
7
|
+
"types": "./dist/index.d.ts",
|
|
8
|
+
"exports": {
|
|
9
|
+
".": {
|
|
10
|
+
"types": "./dist/index.d.ts",
|
|
11
|
+
"import": "./dist/index.mjs",
|
|
12
|
+
"require": "./dist/index.js"
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
"keywords": [
|
|
16
|
+
"harness",
|
|
17
|
+
"engineering",
|
|
18
|
+
"types",
|
|
19
|
+
"ai",
|
|
20
|
+
"agents"
|
|
21
|
+
],
|
|
22
|
+
"files": [
|
|
23
|
+
"dist",
|
|
24
|
+
"README.md"
|
|
25
|
+
],
|
|
26
|
+
"license": "MIT",
|
|
27
|
+
"publishConfig": {
|
|
28
|
+
"access": "public"
|
|
29
|
+
},
|
|
30
|
+
"repository": {
|
|
31
|
+
"type": "git",
|
|
32
|
+
"url": "https://github.com/Intense-Visions/harness-engineering.git",
|
|
33
|
+
"directory": "packages/types"
|
|
34
|
+
},
|
|
35
|
+
"bugs": {
|
|
36
|
+
"url": "https://github.com/Intense-Visions/harness-engineering/issues"
|
|
37
|
+
},
|
|
38
|
+
"homepage": "https://github.com/Intense-Visions/harness-engineering/tree/main/packages/types#readme",
|
|
39
|
+
"devDependencies": {
|
|
40
|
+
"tsup": "^8.0.0"
|
|
41
|
+
},
|
|
42
|
+
"scripts": {
|
|
43
|
+
"build": "tsup src/index.ts --format cjs,esm --dts",
|
|
44
|
+
"dev": "tsup src/index.ts --format cjs,esm --dts --watch",
|
|
45
|
+
"lint": "eslint src",
|
|
46
|
+
"typecheck": "tsc --noEmit",
|
|
47
|
+
"clean": "rm -rf dist"
|
|
48
|
+
}
|
|
49
|
+
}
|