@taktoria/sdk 0.2.0 → 0.2.2
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/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/okr/client/Client.js +8 -4
- package/dist/cjs/api/resources/okr/client/requests/GetScorecardRequest.d.ts +5 -0
- package/dist/cjs/api/resources/okr/client/requests/GetTeamOkrsRequest.d.ts +5 -0
- package/dist/cjs/api/resources/okr/client/requests/ListObjectivesRequest.d.ts +2 -0
- package/dist/cjs/api/resources/okr/client/requests/ListTeamScoresRequest.d.ts +6 -0
- package/dist/cjs/api/resources/okr/types/ChildObjective.d.ts +15 -0
- package/dist/cjs/api/resources/okr/types/ChildObjective.js +3 -0
- package/dist/cjs/api/resources/okr/types/CreateObjectiveRequest.d.ts +5 -0
- package/dist/cjs/api/resources/okr/types/Objective.d.ts +17 -3
- package/dist/cjs/api/resources/okr/types/ObjectiveDetail.d.ts +15 -0
- package/dist/cjs/api/resources/okr/types/ObjectiveRef.d.ts +4 -0
- package/dist/cjs/api/resources/okr/types/ObjectiveRef.js +3 -0
- package/dist/cjs/api/resources/okr/types/ScorecardCell.d.ts +8 -0
- package/dist/cjs/api/resources/okr/types/ScorecardKeyResultRow.d.ts +3 -0
- package/dist/cjs/api/resources/okr/types/ScorecardRow.d.ts +3 -0
- package/dist/cjs/api/resources/okr/types/UpdateObjectiveRequest.d.ts +5 -0
- package/dist/cjs/api/resources/okr/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/okr/types/index.js +2 -0
- package/dist/cjs/serialization/resources/okr/types/ChildObjective.d.ts +16 -0
- package/dist/cjs/serialization/resources/okr/types/ChildObjective.js +48 -0
- package/dist/cjs/serialization/resources/okr/types/CreateObjectiveRequest.d.ts +1 -0
- package/dist/cjs/serialization/resources/okr/types/CreateObjectiveRequest.js +1 -0
- package/dist/cjs/serialization/resources/okr/types/Objective.d.ts +2 -0
- package/dist/cjs/serialization/resources/okr/types/Objective.js +2 -0
- package/dist/cjs/serialization/resources/okr/types/ObjectiveDetail.d.ts +6 -0
- package/dist/cjs/serialization/resources/okr/types/ObjectiveDetail.js +6 -0
- package/dist/cjs/serialization/resources/okr/types/ObjectiveRef.d.ts +10 -0
- package/dist/cjs/serialization/resources/okr/types/ObjectiveRef.js +42 -0
- package/dist/cjs/serialization/resources/okr/types/ScorecardCell.d.ts +1 -0
- package/dist/cjs/serialization/resources/okr/types/ScorecardCell.js +1 -0
- package/dist/cjs/serialization/resources/okr/types/ScorecardKeyResultRow.d.ts +2 -0
- package/dist/cjs/serialization/resources/okr/types/ScorecardKeyResultRow.js +2 -0
- package/dist/cjs/serialization/resources/okr/types/ScorecardRow.d.ts +2 -0
- package/dist/cjs/serialization/resources/okr/types/ScorecardRow.js +2 -0
- package/dist/cjs/serialization/resources/okr/types/UpdateObjectiveRequest.d.ts +1 -0
- package/dist/cjs/serialization/resources/okr/types/UpdateObjectiveRequest.js +1 -0
- package/dist/cjs/serialization/resources/okr/types/index.d.ts +2 -0
- package/dist/cjs/serialization/resources/okr/types/index.js +2 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/okr/client/Client.mjs +8 -4
- package/dist/esm/api/resources/okr/client/requests/GetScorecardRequest.d.mts +5 -0
- package/dist/esm/api/resources/okr/client/requests/GetTeamOkrsRequest.d.mts +5 -0
- package/dist/esm/api/resources/okr/client/requests/ListObjectivesRequest.d.mts +2 -0
- package/dist/esm/api/resources/okr/client/requests/ListTeamScoresRequest.d.mts +6 -0
- package/dist/esm/api/resources/okr/types/ChildObjective.d.mts +15 -0
- package/dist/esm/api/resources/okr/types/ChildObjective.mjs +2 -0
- package/dist/esm/api/resources/okr/types/CreateObjectiveRequest.d.mts +5 -0
- package/dist/esm/api/resources/okr/types/Objective.d.mts +17 -3
- package/dist/esm/api/resources/okr/types/ObjectiveDetail.d.mts +15 -0
- package/dist/esm/api/resources/okr/types/ObjectiveRef.d.mts +4 -0
- package/dist/esm/api/resources/okr/types/ObjectiveRef.mjs +2 -0
- package/dist/esm/api/resources/okr/types/ScorecardCell.d.mts +8 -0
- package/dist/esm/api/resources/okr/types/ScorecardKeyResultRow.d.mts +3 -0
- package/dist/esm/api/resources/okr/types/ScorecardRow.d.mts +3 -0
- package/dist/esm/api/resources/okr/types/UpdateObjectiveRequest.d.mts +5 -0
- package/dist/esm/api/resources/okr/types/index.d.mts +2 -0
- package/dist/esm/api/resources/okr/types/index.mjs +2 -0
- package/dist/esm/serialization/resources/okr/types/ChildObjective.d.mts +16 -0
- package/dist/esm/serialization/resources/okr/types/ChildObjective.mjs +12 -0
- package/dist/esm/serialization/resources/okr/types/CreateObjectiveRequest.d.mts +1 -0
- package/dist/esm/serialization/resources/okr/types/CreateObjectiveRequest.mjs +1 -0
- package/dist/esm/serialization/resources/okr/types/Objective.d.mts +2 -0
- package/dist/esm/serialization/resources/okr/types/Objective.mjs +2 -0
- package/dist/esm/serialization/resources/okr/types/ObjectiveDetail.d.mts +6 -0
- package/dist/esm/serialization/resources/okr/types/ObjectiveDetail.mjs +6 -0
- package/dist/esm/serialization/resources/okr/types/ObjectiveRef.d.mts +10 -0
- package/dist/esm/serialization/resources/okr/types/ObjectiveRef.mjs +6 -0
- package/dist/esm/serialization/resources/okr/types/ScorecardCell.d.mts +1 -0
- package/dist/esm/serialization/resources/okr/types/ScorecardCell.mjs +1 -0
- package/dist/esm/serialization/resources/okr/types/ScorecardKeyResultRow.d.mts +2 -0
- package/dist/esm/serialization/resources/okr/types/ScorecardKeyResultRow.mjs +2 -0
- package/dist/esm/serialization/resources/okr/types/ScorecardRow.d.mts +2 -0
- package/dist/esm/serialization/resources/okr/types/ScorecardRow.mjs +2 -0
- package/dist/esm/serialization/resources/okr/types/UpdateObjectiveRequest.d.mts +1 -0
- package/dist/esm/serialization/resources/okr/types/UpdateObjectiveRequest.mjs +1 -0
- package/dist/esm/serialization/resources/okr/types/index.d.mts +2 -0
- package/dist/esm/serialization/resources/okr/types/index.mjs +2 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
|
|
|
43
43
|
const headers = (0, headers_js_1.mergeHeaders)({
|
|
44
44
|
"X-Fern-Language": "JavaScript",
|
|
45
45
|
"X-Fern-SDK-Name": "@taktoria/sdk",
|
|
46
|
-
"X-Fern-SDK-Version": "0.2.
|
|
47
|
-
"User-Agent": "@taktoria/sdk/0.2.
|
|
46
|
+
"X-Fern-SDK-Version": "0.2.2",
|
|
47
|
+
"User-Agent": "@taktoria/sdk/0.2.2",
|
|
48
48
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
49
49
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
50
50
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
|
@@ -83,12 +83,13 @@ class OkrClient {
|
|
|
83
83
|
__listObjectives() {
|
|
84
84
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
85
85
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
86
|
-
const { year, quarter, teamId, ownerUserId, visibility, tag, q, draft, archived, limit, cursor } = request;
|
|
86
|
+
const { year, quarter, teamId, ownerUserId, parentObjectiveId, visibility, tag, q, draft, archived, limit, cursor, } = request;
|
|
87
87
|
const _queryParams = {
|
|
88
88
|
year,
|
|
89
89
|
quarter,
|
|
90
90
|
teamId,
|
|
91
91
|
ownerUserId,
|
|
92
|
+
parentObjectiveId,
|
|
92
93
|
visibility: visibility != null
|
|
93
94
|
? serializers.OkrVisibility.jsonOrThrow(visibility, {
|
|
94
95
|
unrecognizedObjectKeys: "strip",
|
|
@@ -1223,7 +1224,7 @@ class OkrClient {
|
|
|
1223
1224
|
__getScorecard() {
|
|
1224
1225
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
1225
1226
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
1226
|
-
const { year, teamId, priority, frame, mid } = request;
|
|
1227
|
+
const { year, teamId, priority, tag, frame, mid } = request;
|
|
1227
1228
|
const _queryParams = {
|
|
1228
1229
|
year,
|
|
1229
1230
|
teamId,
|
|
@@ -1233,6 +1234,7 @@ class OkrClient {
|
|
|
1233
1234
|
omitUndefined: true,
|
|
1234
1235
|
})
|
|
1235
1236
|
: undefined,
|
|
1237
|
+
tag,
|
|
1236
1238
|
frame,
|
|
1237
1239
|
mid,
|
|
1238
1240
|
};
|
|
@@ -2380,7 +2382,7 @@ class OkrClient {
|
|
|
2380
2382
|
__listTeamScores() {
|
|
2381
2383
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
2382
2384
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
2383
|
-
const { year, quarter, period, q, sort, onlyScored, limit, cursor } = request;
|
|
2385
|
+
const { year, quarter, period, q, sort, onlyScored, tag, limit, cursor } = request;
|
|
2384
2386
|
const _queryParams = {
|
|
2385
2387
|
year,
|
|
2386
2388
|
quarter,
|
|
@@ -2393,6 +2395,7 @@ class OkrClient {
|
|
|
2393
2395
|
q,
|
|
2394
2396
|
sort,
|
|
2395
2397
|
onlyScored,
|
|
2398
|
+
tag,
|
|
2396
2399
|
limit,
|
|
2397
2400
|
cursor,
|
|
2398
2401
|
};
|
|
@@ -2489,7 +2492,7 @@ class OkrClient {
|
|
|
2489
2492
|
__getTeamOkrs(teamSlug_1) {
|
|
2490
2493
|
return __awaiter(this, arguments, void 0, function* (teamSlug, request = {}, requestOptions) {
|
|
2491
2494
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
2492
|
-
const { year, quarter, period } = request;
|
|
2495
|
+
const { year, quarter, period, tag } = request;
|
|
2493
2496
|
const _queryParams = {
|
|
2494
2497
|
year,
|
|
2495
2498
|
quarter,
|
|
@@ -2499,6 +2502,7 @@ class OkrClient {
|
|
|
2499
2502
|
omitUndefined: true,
|
|
2500
2503
|
})
|
|
2501
2504
|
: undefined,
|
|
2505
|
+
tag,
|
|
2502
2506
|
};
|
|
2503
2507
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
2504
2508
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
@@ -17,6 +17,11 @@ export interface GetScorecardRequest {
|
|
|
17
17
|
* their cells rolled up from those key results alone.
|
|
18
18
|
*/
|
|
19
19
|
priority?: Taktoria.OkrPriority;
|
|
20
|
+
/**
|
|
21
|
+
* Only objectives carrying this tag, or holding a key result that
|
|
22
|
+
* does. One word, matched whole; case and a leading `#` are ignored.
|
|
23
|
+
*/
|
|
24
|
+
tag?: string;
|
|
20
25
|
/** `annual`, or a quarter `1` to `4`. Every period when left out. */
|
|
21
26
|
frame?: string | string[];
|
|
22
27
|
/** `false` leaves out the mid-quarter columns. */
|
|
@@ -8,4 +8,9 @@ export interface GetTeamOkrsRequest {
|
|
|
8
8
|
year?: number;
|
|
9
9
|
quarter?: number;
|
|
10
10
|
period?: Taktoria.OkrPeriod;
|
|
11
|
+
/**
|
|
12
|
+
* Only objectives carrying this tag, or holding a key result that
|
|
13
|
+
* does. One word, matched whole; case and a leading `#` are ignored.
|
|
14
|
+
*/
|
|
15
|
+
tag?: string;
|
|
11
16
|
}
|
|
@@ -15,6 +15,8 @@ export interface ListObjectivesRequest {
|
|
|
15
15
|
*/
|
|
16
16
|
teamId?: string;
|
|
17
17
|
ownerUserId?: string;
|
|
18
|
+
/** Only the objectives aligned directly to this one, its children. */
|
|
19
|
+
parentObjectiveId?: string;
|
|
18
20
|
visibility?: Taktoria.OkrVisibility;
|
|
19
21
|
/**
|
|
20
22
|
* Only objectives carrying this tag, or holding a key result that
|
|
@@ -16,6 +16,12 @@ export interface ListTeamScoresRequest {
|
|
|
16
16
|
sort?: string;
|
|
17
17
|
/** `true` keeps only the teams with a score. */
|
|
18
18
|
onlyScored?: boolean;
|
|
19
|
+
/**
|
|
20
|
+
* Only teams holding an objective that carries this tag, or a key
|
|
21
|
+
* result that does, each scored on those alone. One word, matched
|
|
22
|
+
* whole.
|
|
23
|
+
*/
|
|
24
|
+
tag?: string;
|
|
19
25
|
/** At most 100; 50 when left out. */
|
|
20
26
|
limit?: number;
|
|
21
27
|
cursor?: string;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type * as Taktoria from "../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* An objective aligned to another, as its parent lists it.
|
|
4
|
+
*/
|
|
5
|
+
export interface ChildObjective {
|
|
6
|
+
id: string;
|
|
7
|
+
title: string;
|
|
8
|
+
/** How much it counts in its parent's score, beside the parent's key results. */
|
|
9
|
+
weight: number;
|
|
10
|
+
period: Taktoria.OkrPeriod;
|
|
11
|
+
year: number;
|
|
12
|
+
quarter?: number;
|
|
13
|
+
/** Its own score, with anything aligned under it rolled in. */
|
|
14
|
+
score?: number;
|
|
15
|
+
}
|
|
@@ -47,6 +47,11 @@ export interface CreateObjectiveRequest {
|
|
|
47
47
|
sortOrder?: number;
|
|
48
48
|
teamId?: string;
|
|
49
49
|
ownerUserId?: string;
|
|
50
|
+
/**
|
|
51
|
+
* The objective it aligns to: any the caller may see, in any period.
|
|
52
|
+
* Anything else is a 422.
|
|
53
|
+
*/
|
|
54
|
+
parentObjectiveId?: string;
|
|
50
55
|
/**
|
|
51
56
|
* Its key results, at most 50, made with it in this order; each as
|
|
52
57
|
* `createKeyResult` takes one, a first `score` recorded as a
|
|
@@ -30,11 +30,25 @@ export interface Objective {
|
|
|
30
30
|
owner?: Taktoria.User;
|
|
31
31
|
ownerUserId?: string;
|
|
32
32
|
/**
|
|
33
|
-
* The weighted average of its key results' grades,
|
|
34
|
-
*
|
|
35
|
-
*
|
|
33
|
+
* The weighted average of its key results' grades, with each
|
|
34
|
+
* objective aligned under it counted like one more key result (its
|
|
35
|
+
* own score, by its weight), or absent when nothing is scored.
|
|
36
|
+
* Absent rather than 0.0 on purpose: an unscored objective has not
|
|
37
|
+
* failed, and a zero would say it had. Where a list shows only some
|
|
38
|
+
* of an objective's key results (`/okrhub/mine`, a team's page), it
|
|
39
|
+
* is those key results' average alone.
|
|
36
40
|
*/
|
|
37
41
|
score?: number;
|
|
42
|
+
/**
|
|
43
|
+
* Its own key results' weighted average alone, as the averages over
|
|
44
|
+
* many objectives (`rollup`) count it, so that nothing counts twice.
|
|
45
|
+
*/
|
|
46
|
+
keyResultScore?: number;
|
|
47
|
+
/**
|
|
48
|
+
* The objective it aligns to, if any: one, in any period. Its score
|
|
49
|
+
* counts in the parent's.
|
|
50
|
+
*/
|
|
51
|
+
parentObjectiveId?: string;
|
|
38
52
|
keyResults: Taktoria.KeyResult[];
|
|
39
53
|
/**
|
|
40
54
|
* Still being worked out, not yet agreed. A label only: a draft is
|
|
@@ -17,4 +17,19 @@ export interface ObjectiveDetail extends Taktoria.Objective {
|
|
|
17
17
|
* through a team) for anybody else. Every one, for a key.
|
|
18
18
|
*/
|
|
19
19
|
updatableKeyResultIds: string[];
|
|
20
|
+
/** The objective it aligns to, if the caller may see it. */
|
|
21
|
+
parent?: Taktoria.ObjectiveRef;
|
|
22
|
+
/** `true` when it aligns to a private objective the caller may not see. */
|
|
23
|
+
parentHidden: boolean;
|
|
24
|
+
/**
|
|
25
|
+
* The objectives aligned directly to it that the caller may see,
|
|
26
|
+
* newest period first. Each counts in its `score`.
|
|
27
|
+
*/
|
|
28
|
+
children: Taktoria.ChildObjective[];
|
|
29
|
+
/**
|
|
30
|
+
* How many more objectives are aligned to it that the caller may
|
|
31
|
+
* not see. They count in its `score`, so it is the same for
|
|
32
|
+
* everybody, but are never named.
|
|
33
|
+
*/
|
|
34
|
+
hiddenChildren: number;
|
|
20
35
|
}
|
|
@@ -16,4 +16,12 @@ export interface ScorecardCell {
|
|
|
16
16
|
* it, and say so in `averageInProgress`.
|
|
17
17
|
*/
|
|
18
18
|
inProgress?: boolean;
|
|
19
|
+
/**
|
|
20
|
+
* `true` on an objective's cell that counts the objectives aligned
|
|
21
|
+
* under it, each like one more key result by its weight, as it stood
|
|
22
|
+
* at that checkpoint (its Final once its own period is over, before
|
|
23
|
+
* then its latest check-ins). The averages take each objective on
|
|
24
|
+
* its own key results instead, so nothing counts twice.
|
|
25
|
+
*/
|
|
26
|
+
withAligned?: boolean;
|
|
19
27
|
}
|
|
@@ -2,6 +2,9 @@ import type * as Taktoria from "../../../index.js";
|
|
|
2
2
|
export interface ScorecardKeyResultRow {
|
|
3
3
|
keyResultId: string;
|
|
4
4
|
title: string;
|
|
5
|
+
description?: string;
|
|
6
|
+
/** Its tags, A to Z. */
|
|
7
|
+
tags: string[];
|
|
5
8
|
priority?: Taktoria.OkrPriority;
|
|
6
9
|
weight: number;
|
|
7
10
|
cells: Record<string, Taktoria.ScorecardCell>;
|
|
@@ -5,6 +5,9 @@ import type * as Taktoria from "../../../index.js";
|
|
|
5
5
|
export interface ScorecardRow {
|
|
6
6
|
objectiveId: string;
|
|
7
7
|
title: string;
|
|
8
|
+
description?: string;
|
|
9
|
+
/** Its tags, A to Z. */
|
|
10
|
+
tags: string[];
|
|
8
11
|
weight: number;
|
|
9
12
|
timeframe: Taktoria.ScorecardTimeframe;
|
|
10
13
|
/** Rolled up from its key results, by weight. */
|
|
@@ -23,6 +23,11 @@ export interface UpdateObjectiveRequest {
|
|
|
23
23
|
weight?: number;
|
|
24
24
|
teamId?: string;
|
|
25
25
|
ownerUserId?: string;
|
|
26
|
+
/**
|
|
27
|
+
* The objective it aligns to, any the caller may see; `null` for
|
|
28
|
+
* none. Neither the objective itself nor one aligned under it (a 422).
|
|
29
|
+
*/
|
|
30
|
+
parentObjectiveId?: string;
|
|
26
31
|
/** `false` publishes it. */
|
|
27
32
|
draft?: boolean;
|
|
28
33
|
sortOrder?: number;
|
|
@@ -5,6 +5,7 @@ export * from "./BulkScoreSkipReason.js";
|
|
|
5
5
|
export * from "./CheckIn.js";
|
|
6
6
|
export * from "./CheckInMetric.js";
|
|
7
7
|
export * from "./CheckInPage.js";
|
|
8
|
+
export * from "./ChildObjective.js";
|
|
8
9
|
export * from "./CreateCheckInRequest.js";
|
|
9
10
|
export * from "./CreateKeyResultRequest.js";
|
|
10
11
|
export * from "./CreateObjectiveRequest.js";
|
|
@@ -24,6 +25,7 @@ export * from "./MetricSourceKind.js";
|
|
|
24
25
|
export * from "./Objective.js";
|
|
25
26
|
export * from "./ObjectiveDetail.js";
|
|
26
27
|
export * from "./ObjectivePage.js";
|
|
28
|
+
export * from "./ObjectiveRef.js";
|
|
27
29
|
export * from "./ObjectiveViewPage.js";
|
|
28
30
|
export * from "./OkrCheckpoint.js";
|
|
29
31
|
export * from "./OkrPeriod.js";
|
|
@@ -21,6 +21,7 @@ __exportStar(require("./BulkScoreSkipReason.js"), exports);
|
|
|
21
21
|
__exportStar(require("./CheckIn.js"), exports);
|
|
22
22
|
__exportStar(require("./CheckInMetric.js"), exports);
|
|
23
23
|
__exportStar(require("./CheckInPage.js"), exports);
|
|
24
|
+
__exportStar(require("./ChildObjective.js"), exports);
|
|
24
25
|
__exportStar(require("./CreateCheckInRequest.js"), exports);
|
|
25
26
|
__exportStar(require("./CreateKeyResultRequest.js"), exports);
|
|
26
27
|
__exportStar(require("./CreateObjectiveRequest.js"), exports);
|
|
@@ -40,6 +41,7 @@ __exportStar(require("./MetricSourceKind.js"), exports);
|
|
|
40
41
|
__exportStar(require("./Objective.js"), exports);
|
|
41
42
|
__exportStar(require("./ObjectiveDetail.js"), exports);
|
|
42
43
|
__exportStar(require("./ObjectivePage.js"), exports);
|
|
44
|
+
__exportStar(require("./ObjectiveRef.js"), exports);
|
|
43
45
|
__exportStar(require("./ObjectiveViewPage.js"), exports);
|
|
44
46
|
__exportStar(require("./OkrCheckpoint.js"), exports);
|
|
45
47
|
__exportStar(require("./OkrPeriod.js"), exports);
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type * as Taktoria from "../../../../api/index.js";
|
|
2
|
+
import * as core from "../../../../core/index.js";
|
|
3
|
+
import type * as serializers from "../../../index.js";
|
|
4
|
+
import { OkrPeriod } from "./OkrPeriod.js";
|
|
5
|
+
export declare const ChildObjective: core.serialization.ObjectSchema<serializers.ChildObjective.Raw, Taktoria.ChildObjective>;
|
|
6
|
+
export declare namespace ChildObjective {
|
|
7
|
+
interface Raw {
|
|
8
|
+
id: string;
|
|
9
|
+
title: string;
|
|
10
|
+
weight: number;
|
|
11
|
+
period: OkrPeriod.Raw;
|
|
12
|
+
year: number;
|
|
13
|
+
quarter?: number | null;
|
|
14
|
+
score?: number | null;
|
|
15
|
+
}
|
|
16
|
+
}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
15
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
16
|
+
}) : function(o, v) {
|
|
17
|
+
o["default"] = v;
|
|
18
|
+
});
|
|
19
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
20
|
+
var ownKeys = function(o) {
|
|
21
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
22
|
+
var ar = [];
|
|
23
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
24
|
+
return ar;
|
|
25
|
+
};
|
|
26
|
+
return ownKeys(o);
|
|
27
|
+
};
|
|
28
|
+
return function (mod) {
|
|
29
|
+
if (mod && mod.__esModule) return mod;
|
|
30
|
+
var result = {};
|
|
31
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
32
|
+
__setModuleDefault(result, mod);
|
|
33
|
+
return result;
|
|
34
|
+
};
|
|
35
|
+
})();
|
|
36
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
37
|
+
exports.ChildObjective = void 0;
|
|
38
|
+
const core = __importStar(require("../../../../core/index.js"));
|
|
39
|
+
const OkrPeriod_js_1 = require("./OkrPeriod.js");
|
|
40
|
+
exports.ChildObjective = core.serialization.object({
|
|
41
|
+
id: core.serialization.string(),
|
|
42
|
+
title: core.serialization.string(),
|
|
43
|
+
weight: core.serialization.number(),
|
|
44
|
+
period: OkrPeriod_js_1.OkrPeriod,
|
|
45
|
+
year: core.serialization.number(),
|
|
46
|
+
quarter: core.serialization.number().optional(),
|
|
47
|
+
score: core.serialization.number().optional(),
|
|
48
|
+
});
|
|
@@ -52,5 +52,6 @@ exports.CreateObjectiveRequest = core.serialization.object({
|
|
|
52
52
|
sortOrder: core.serialization.number().optional(),
|
|
53
53
|
teamId: core.serialization.string().optional(),
|
|
54
54
|
ownerUserId: core.serialization.string().optional(),
|
|
55
|
+
parentObjectiveId: core.serialization.string().optional(),
|
|
55
56
|
keyResults: core.serialization.list(CreateKeyResultRequest_js_1.CreateKeyResultRequest).optional(),
|
|
56
57
|
});
|
|
@@ -24,6 +24,8 @@ export declare namespace Objective {
|
|
|
24
24
|
owner?: User.Raw | null;
|
|
25
25
|
ownerUserId?: string | null;
|
|
26
26
|
score?: number | null;
|
|
27
|
+
keyResultScore?: number | null;
|
|
28
|
+
parentObjectiveId?: string | null;
|
|
27
29
|
keyResults: KeyResult.Raw[];
|
|
28
30
|
draft: boolean;
|
|
29
31
|
sortOrder: number;
|
|
@@ -57,6 +57,8 @@ exports.Objective = core.serialization.object({
|
|
|
57
57
|
owner: User_js_1.User.optional(),
|
|
58
58
|
ownerUserId: core.serialization.string().optional(),
|
|
59
59
|
score: core.serialization.number().optional(),
|
|
60
|
+
keyResultScore: core.serialization.number().optional(),
|
|
61
|
+
parentObjectiveId: core.serialization.string().optional(),
|
|
60
62
|
keyResults: core.serialization.list(KeyResult_js_1.KeyResult),
|
|
61
63
|
draft: core.serialization.boolean(),
|
|
62
64
|
sortOrder: core.serialization.number(),
|
|
@@ -1,11 +1,17 @@
|
|
|
1
1
|
import type * as Taktoria from "../../../../api/index.js";
|
|
2
2
|
import * as core from "../../../../core/index.js";
|
|
3
3
|
import type * as serializers from "../../../index.js";
|
|
4
|
+
import { ChildObjective } from "./ChildObjective.js";
|
|
4
5
|
import { Objective } from "./Objective.js";
|
|
6
|
+
import { ObjectiveRef } from "./ObjectiveRef.js";
|
|
5
7
|
export declare const ObjectiveDetail: core.serialization.ObjectSchema<serializers.ObjectiveDetail.Raw, Taktoria.ObjectiveDetail>;
|
|
6
8
|
export declare namespace ObjectiveDetail {
|
|
7
9
|
interface Raw extends Objective.Raw {
|
|
8
10
|
canEdit: boolean;
|
|
9
11
|
updatableKeyResultIds: string[];
|
|
12
|
+
parent?: ObjectiveRef.Raw | null;
|
|
13
|
+
parentHidden: boolean;
|
|
14
|
+
children: ChildObjective.Raw[];
|
|
15
|
+
hiddenChildren: number;
|
|
10
16
|
}
|
|
11
17
|
}
|
|
@@ -36,10 +36,16 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
36
36
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
37
37
|
exports.ObjectiveDetail = void 0;
|
|
38
38
|
const core = __importStar(require("../../../../core/index.js"));
|
|
39
|
+
const ChildObjective_js_1 = require("./ChildObjective.js");
|
|
39
40
|
const Objective_js_1 = require("./Objective.js");
|
|
41
|
+
const ObjectiveRef_js_1 = require("./ObjectiveRef.js");
|
|
40
42
|
exports.ObjectiveDetail = core.serialization
|
|
41
43
|
.object({
|
|
42
44
|
canEdit: core.serialization.boolean(),
|
|
43
45
|
updatableKeyResultIds: core.serialization.list(core.serialization.string()),
|
|
46
|
+
parent: ObjectiveRef_js_1.ObjectiveRef.optional(),
|
|
47
|
+
parentHidden: core.serialization.boolean(),
|
|
48
|
+
children: core.serialization.list(ChildObjective_js_1.ChildObjective),
|
|
49
|
+
hiddenChildren: core.serialization.number(),
|
|
44
50
|
})
|
|
45
51
|
.extend(Objective_js_1.Objective);
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type * as Taktoria from "../../../../api/index.js";
|
|
2
|
+
import * as core from "../../../../core/index.js";
|
|
3
|
+
import type * as serializers from "../../../index.js";
|
|
4
|
+
export declare const ObjectiveRef: core.serialization.ObjectSchema<serializers.ObjectiveRef.Raw, Taktoria.ObjectiveRef>;
|
|
5
|
+
export declare namespace ObjectiveRef {
|
|
6
|
+
interface Raw {
|
|
7
|
+
id: string;
|
|
8
|
+
title: string;
|
|
9
|
+
}
|
|
10
|
+
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
15
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
16
|
+
}) : function(o, v) {
|
|
17
|
+
o["default"] = v;
|
|
18
|
+
});
|
|
19
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
20
|
+
var ownKeys = function(o) {
|
|
21
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
22
|
+
var ar = [];
|
|
23
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
24
|
+
return ar;
|
|
25
|
+
};
|
|
26
|
+
return ownKeys(o);
|
|
27
|
+
};
|
|
28
|
+
return function (mod) {
|
|
29
|
+
if (mod && mod.__esModule) return mod;
|
|
30
|
+
var result = {};
|
|
31
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
32
|
+
__setModuleDefault(result, mod);
|
|
33
|
+
return result;
|
|
34
|
+
};
|
|
35
|
+
})();
|
|
36
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
37
|
+
exports.ObjectiveRef = void 0;
|
|
38
|
+
const core = __importStar(require("../../../../core/index.js"));
|
|
39
|
+
exports.ObjectiveRef = core.serialization.object({
|
|
40
|
+
id: core.serialization.string(),
|
|
41
|
+
title: core.serialization.string(),
|
|
42
|
+
});
|
|
@@ -42,4 +42,5 @@ exports.ScorecardCell = core.serialization.object({
|
|
|
42
42
|
source: ScorecardCellSource_js_1.ScorecardCellSource.optional(),
|
|
43
43
|
noScore: core.serialization.boolean().optional(),
|
|
44
44
|
inProgress: core.serialization.boolean().optional(),
|
|
45
|
+
withAligned: core.serialization.boolean().optional(),
|
|
45
46
|
});
|
|
@@ -41,6 +41,8 @@ const ScorecardCell_js_1 = require("./ScorecardCell.js");
|
|
|
41
41
|
exports.ScorecardKeyResultRow = core.serialization.object({
|
|
42
42
|
keyResultId: core.serialization.string(),
|
|
43
43
|
title: core.serialization.string(),
|
|
44
|
+
description: core.serialization.string().optional(),
|
|
45
|
+
tags: core.serialization.list(core.serialization.string()),
|
|
44
46
|
priority: OkrPriority_js_1.OkrPriority.optional(),
|
|
45
47
|
weight: core.serialization.number(),
|
|
46
48
|
cells: core.serialization.record(core.serialization.string(), ScorecardCell_js_1.ScorecardCell),
|
|
@@ -42,6 +42,8 @@ const ScorecardTimeframe_js_1 = require("./ScorecardTimeframe.js");
|
|
|
42
42
|
exports.ScorecardRow = core.serialization.object({
|
|
43
43
|
objectiveId: core.serialization.string(),
|
|
44
44
|
title: core.serialization.string(),
|
|
45
|
+
description: core.serialization.string().optional(),
|
|
46
|
+
tags: core.serialization.list(core.serialization.string()),
|
|
45
47
|
weight: core.serialization.number(),
|
|
46
48
|
timeframe: ScorecardTimeframe_js_1.ScorecardTimeframe,
|
|
47
49
|
cells: core.serialization.record(core.serialization.string(), ScorecardCell_js_1.ScorecardCell),
|
|
@@ -49,6 +49,7 @@ exports.UpdateObjectiveRequest = core.serialization.object({
|
|
|
49
49
|
weight: core.serialization.number().optional(),
|
|
50
50
|
teamId: core.serialization.string().optional(),
|
|
51
51
|
ownerUserId: core.serialization.string().optional(),
|
|
52
|
+
parentObjectiveId: core.serialization.string().optional(),
|
|
52
53
|
draft: core.serialization.boolean().optional(),
|
|
53
54
|
sortOrder: core.serialization.number().optional(),
|
|
54
55
|
archived: core.serialization.boolean().optional(),
|
|
@@ -5,6 +5,7 @@ export * from "./BulkScoreSkipReason.js";
|
|
|
5
5
|
export * from "./CheckIn.js";
|
|
6
6
|
export * from "./CheckInMetric.js";
|
|
7
7
|
export * from "./CheckInPage.js";
|
|
8
|
+
export * from "./ChildObjective.js";
|
|
8
9
|
export * from "./CreateCheckInRequest.js";
|
|
9
10
|
export * from "./CreateKeyResultRequest.js";
|
|
10
11
|
export * from "./CreateObjectiveRequest.js";
|
|
@@ -24,6 +25,7 @@ export * from "./MetricSourceKind.js";
|
|
|
24
25
|
export * from "./Objective.js";
|
|
25
26
|
export * from "./ObjectiveDetail.js";
|
|
26
27
|
export * from "./ObjectivePage.js";
|
|
28
|
+
export * from "./ObjectiveRef.js";
|
|
27
29
|
export * from "./ObjectiveViewPage.js";
|
|
28
30
|
export * from "./OkrCheckpoint.js";
|
|
29
31
|
export * from "./OkrPeriod.js";
|
|
@@ -21,6 +21,7 @@ __exportStar(require("./BulkScoreSkipReason.js"), exports);
|
|
|
21
21
|
__exportStar(require("./CheckIn.js"), exports);
|
|
22
22
|
__exportStar(require("./CheckInMetric.js"), exports);
|
|
23
23
|
__exportStar(require("./CheckInPage.js"), exports);
|
|
24
|
+
__exportStar(require("./ChildObjective.js"), exports);
|
|
24
25
|
__exportStar(require("./CreateCheckInRequest.js"), exports);
|
|
25
26
|
__exportStar(require("./CreateKeyResultRequest.js"), exports);
|
|
26
27
|
__exportStar(require("./CreateObjectiveRequest.js"), exports);
|
|
@@ -40,6 +41,7 @@ __exportStar(require("./MetricSourceKind.js"), exports);
|
|
|
40
41
|
__exportStar(require("./Objective.js"), exports);
|
|
41
42
|
__exportStar(require("./ObjectiveDetail.js"), exports);
|
|
42
43
|
__exportStar(require("./ObjectivePage.js"), exports);
|
|
44
|
+
__exportStar(require("./ObjectiveRef.js"), exports);
|
|
43
45
|
__exportStar(require("./ObjectiveViewPage.js"), exports);
|
|
44
46
|
__exportStar(require("./OkrCheckpoint.js"), exports);
|
|
45
47
|
__exportStar(require("./OkrPeriod.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "0.2.
|
|
1
|
+
export declare const SDK_VERSION = "0.2.2";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
|
|
|
6
6
|
const headers = mergeHeaders({
|
|
7
7
|
"X-Fern-Language": "JavaScript",
|
|
8
8
|
"X-Fern-SDK-Name": "@taktoria/sdk",
|
|
9
|
-
"X-Fern-SDK-Version": "0.2.
|
|
10
|
-
"User-Agent": "@taktoria/sdk/0.2.
|
|
9
|
+
"X-Fern-SDK-Version": "0.2.2",
|
|
10
|
+
"User-Agent": "@taktoria/sdk/0.2.2",
|
|
11
11
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
12
12
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
13
13
|
}, options === null || options === void 0 ? void 0 : options.headers);
|