@taktoria/sdk 0.2.1 → 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.
Files changed (65) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/okr/client/Client.js +2 -1
  3. package/dist/cjs/api/resources/okr/client/requests/ListObjectivesRequest.d.ts +2 -0
  4. package/dist/cjs/api/resources/okr/types/ChildObjective.d.ts +15 -0
  5. package/dist/cjs/api/resources/okr/types/ChildObjective.js +3 -0
  6. package/dist/cjs/api/resources/okr/types/CreateObjectiveRequest.d.ts +5 -0
  7. package/dist/cjs/api/resources/okr/types/Objective.d.ts +17 -3
  8. package/dist/cjs/api/resources/okr/types/ObjectiveDetail.d.ts +15 -0
  9. package/dist/cjs/api/resources/okr/types/ObjectiveRef.d.ts +4 -0
  10. package/dist/cjs/api/resources/okr/types/ObjectiveRef.js +3 -0
  11. package/dist/cjs/api/resources/okr/types/ScorecardCell.d.ts +8 -0
  12. package/dist/cjs/api/resources/okr/types/UpdateObjectiveRequest.d.ts +5 -0
  13. package/dist/cjs/api/resources/okr/types/index.d.ts +2 -0
  14. package/dist/cjs/api/resources/okr/types/index.js +2 -0
  15. package/dist/cjs/serialization/resources/okr/types/ChildObjective.d.ts +16 -0
  16. package/dist/cjs/serialization/resources/okr/types/ChildObjective.js +48 -0
  17. package/dist/cjs/serialization/resources/okr/types/CreateObjectiveRequest.d.ts +1 -0
  18. package/dist/cjs/serialization/resources/okr/types/CreateObjectiveRequest.js +1 -0
  19. package/dist/cjs/serialization/resources/okr/types/Objective.d.ts +2 -0
  20. package/dist/cjs/serialization/resources/okr/types/Objective.js +2 -0
  21. package/dist/cjs/serialization/resources/okr/types/ObjectiveDetail.d.ts +6 -0
  22. package/dist/cjs/serialization/resources/okr/types/ObjectiveDetail.js +6 -0
  23. package/dist/cjs/serialization/resources/okr/types/ObjectiveRef.d.ts +10 -0
  24. package/dist/cjs/serialization/resources/okr/types/ObjectiveRef.js +42 -0
  25. package/dist/cjs/serialization/resources/okr/types/ScorecardCell.d.ts +1 -0
  26. package/dist/cjs/serialization/resources/okr/types/ScorecardCell.js +1 -0
  27. package/dist/cjs/serialization/resources/okr/types/UpdateObjectiveRequest.d.ts +1 -0
  28. package/dist/cjs/serialization/resources/okr/types/UpdateObjectiveRequest.js +1 -0
  29. package/dist/cjs/serialization/resources/okr/types/index.d.ts +2 -0
  30. package/dist/cjs/serialization/resources/okr/types/index.js +2 -0
  31. package/dist/cjs/version.d.ts +1 -1
  32. package/dist/cjs/version.js +1 -1
  33. package/dist/esm/BaseClient.mjs +2 -2
  34. package/dist/esm/api/resources/okr/client/Client.mjs +2 -1
  35. package/dist/esm/api/resources/okr/client/requests/ListObjectivesRequest.d.mts +2 -0
  36. package/dist/esm/api/resources/okr/types/ChildObjective.d.mts +15 -0
  37. package/dist/esm/api/resources/okr/types/ChildObjective.mjs +2 -0
  38. package/dist/esm/api/resources/okr/types/CreateObjectiveRequest.d.mts +5 -0
  39. package/dist/esm/api/resources/okr/types/Objective.d.mts +17 -3
  40. package/dist/esm/api/resources/okr/types/ObjectiveDetail.d.mts +15 -0
  41. package/dist/esm/api/resources/okr/types/ObjectiveRef.d.mts +4 -0
  42. package/dist/esm/api/resources/okr/types/ObjectiveRef.mjs +2 -0
  43. package/dist/esm/api/resources/okr/types/ScorecardCell.d.mts +8 -0
  44. package/dist/esm/api/resources/okr/types/UpdateObjectiveRequest.d.mts +5 -0
  45. package/dist/esm/api/resources/okr/types/index.d.mts +2 -0
  46. package/dist/esm/api/resources/okr/types/index.mjs +2 -0
  47. package/dist/esm/serialization/resources/okr/types/ChildObjective.d.mts +16 -0
  48. package/dist/esm/serialization/resources/okr/types/ChildObjective.mjs +12 -0
  49. package/dist/esm/serialization/resources/okr/types/CreateObjectiveRequest.d.mts +1 -0
  50. package/dist/esm/serialization/resources/okr/types/CreateObjectiveRequest.mjs +1 -0
  51. package/dist/esm/serialization/resources/okr/types/Objective.d.mts +2 -0
  52. package/dist/esm/serialization/resources/okr/types/Objective.mjs +2 -0
  53. package/dist/esm/serialization/resources/okr/types/ObjectiveDetail.d.mts +6 -0
  54. package/dist/esm/serialization/resources/okr/types/ObjectiveDetail.mjs +6 -0
  55. package/dist/esm/serialization/resources/okr/types/ObjectiveRef.d.mts +10 -0
  56. package/dist/esm/serialization/resources/okr/types/ObjectiveRef.mjs +6 -0
  57. package/dist/esm/serialization/resources/okr/types/ScorecardCell.d.mts +1 -0
  58. package/dist/esm/serialization/resources/okr/types/ScorecardCell.mjs +1 -0
  59. package/dist/esm/serialization/resources/okr/types/UpdateObjectiveRequest.d.mts +1 -0
  60. package/dist/esm/serialization/resources/okr/types/UpdateObjectiveRequest.mjs +1 -0
  61. package/dist/esm/serialization/resources/okr/types/index.d.mts +2 -0
  62. package/dist/esm/serialization/resources/okr/types/index.mjs +2 -0
  63. package/dist/esm/version.d.mts +1 -1
  64. package/dist/esm/version.mjs +1 -1
  65. package/package.json +1 -1
@@ -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.1",
47
- "User-Agent": "@taktoria/sdk/0.2.1",
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",
@@ -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
@@ -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
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -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, or absent when
34
- * none has been scored. Absent rather than 0.0 on purpose: an
35
- * unscored objective has not failed, and a zero would say it had.
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
  }
@@ -0,0 +1,4 @@
1
+ export interface ObjectiveRef {
2
+ id: string;
3
+ title: string;
4
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -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
  }
@@ -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
+ });
@@ -19,6 +19,7 @@ export declare namespace CreateObjectiveRequest {
19
19
  sortOrder?: number | null;
20
20
  teamId?: string | null;
21
21
  ownerUserId?: string | null;
22
+ parentObjectiveId?: string | null;
22
23
  keyResults?: CreateKeyResultRequest.Raw[] | null;
23
24
  }
24
25
  }
@@ -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
+ });
@@ -9,5 +9,6 @@ export declare namespace ScorecardCell {
9
9
  source?: ScorecardCellSource.Raw | null;
10
10
  noScore?: boolean | null;
11
11
  inProgress?: boolean | null;
12
+ withAligned?: boolean | null;
12
13
  }
13
14
  }
@@ -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
  });
@@ -16,6 +16,7 @@ export declare namespace UpdateObjectiveRequest {
16
16
  weight?: number | null;
17
17
  teamId?: string | null;
18
18
  ownerUserId?: string | null;
19
+ parentObjectiveId?: string | null;
19
20
  draft?: boolean | null;
20
21
  sortOrder?: number | null;
21
22
  archived?: boolean | null;
@@ -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);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.2.1";
1
+ export declare const SDK_VERSION = "0.2.2";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "0.2.1";
4
+ exports.SDK_VERSION = "0.2.2";
@@ -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.1",
10
- "User-Agent": "@taktoria/sdk/0.2.1",
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);
@@ -47,12 +47,13 @@ export class OkrClient {
47
47
  __listObjectives() {
48
48
  return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
49
49
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
50
- const { year, quarter, teamId, ownerUserId, visibility, tag, q, draft, archived, limit, cursor } = request;
50
+ const { year, quarter, teamId, ownerUserId, parentObjectiveId, visibility, tag, q, draft, archived, limit, cursor, } = request;
51
51
  const _queryParams = {
52
52
  year,
53
53
  quarter,
54
54
  teamId,
55
55
  ownerUserId,
56
+ parentObjectiveId,
56
57
  visibility: visibility != null
57
58
  ? serializers.OkrVisibility.jsonOrThrow(visibility, {
58
59
  unrecognizedObjectKeys: "strip",
@@ -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
@@ -0,0 +1,15 @@
1
+ import type * as Taktoria from "../../../index.mjs";
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
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -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, or absent when
34
- * none has been scored. Absent rather than 0.0 on purpose: an
35
- * unscored objective has not failed, and a zero would say it had.
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
  }
@@ -0,0 +1,4 @@
1
+ export interface ObjectiveRef {
2
+ id: string;
3
+ title: string;
4
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -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
  }
@@ -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.mjs";
5
5
  export * from "./CheckIn.mjs";
6
6
  export * from "./CheckInMetric.mjs";
7
7
  export * from "./CheckInPage.mjs";
8
+ export * from "./ChildObjective.mjs";
8
9
  export * from "./CreateCheckInRequest.mjs";
9
10
  export * from "./CreateKeyResultRequest.mjs";
10
11
  export * from "./CreateObjectiveRequest.mjs";
@@ -24,6 +25,7 @@ export * from "./MetricSourceKind.mjs";
24
25
  export * from "./Objective.mjs";
25
26
  export * from "./ObjectiveDetail.mjs";
26
27
  export * from "./ObjectivePage.mjs";
28
+ export * from "./ObjectiveRef.mjs";
27
29
  export * from "./ObjectiveViewPage.mjs";
28
30
  export * from "./OkrCheckpoint.mjs";
29
31
  export * from "./OkrPeriod.mjs";
@@ -5,6 +5,7 @@ export * from "./BulkScoreSkipReason.mjs";
5
5
  export * from "./CheckIn.mjs";
6
6
  export * from "./CheckInMetric.mjs";
7
7
  export * from "./CheckInPage.mjs";
8
+ export * from "./ChildObjective.mjs";
8
9
  export * from "./CreateCheckInRequest.mjs";
9
10
  export * from "./CreateKeyResultRequest.mjs";
10
11
  export * from "./CreateObjectiveRequest.mjs";
@@ -24,6 +25,7 @@ export * from "./MetricSourceKind.mjs";
24
25
  export * from "./Objective.mjs";
25
26
  export * from "./ObjectiveDetail.mjs";
26
27
  export * from "./ObjectivePage.mjs";
28
+ export * from "./ObjectiveRef.mjs";
27
29
  export * from "./ObjectiveViewPage.mjs";
28
30
  export * from "./OkrCheckpoint.mjs";
29
31
  export * from "./OkrPeriod.mjs";
@@ -0,0 +1,16 @@
1
+ import type * as Taktoria from "../../../../api/index.mjs";
2
+ import * as core from "../../../../core/index.mjs";
3
+ import type * as serializers from "../../../index.mjs";
4
+ import { OkrPeriod } from "./OkrPeriod.mjs";
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,12 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ import * as core from "../../../../core/index.mjs";
3
+ import { OkrPeriod } from "./OkrPeriod.mjs";
4
+ export const ChildObjective = core.serialization.object({
5
+ id: core.serialization.string(),
6
+ title: core.serialization.string(),
7
+ weight: core.serialization.number(),
8
+ period: OkrPeriod,
9
+ year: core.serialization.number(),
10
+ quarter: core.serialization.number().optional(),
11
+ score: core.serialization.number().optional(),
12
+ });
@@ -19,6 +19,7 @@ export declare namespace CreateObjectiveRequest {
19
19
  sortOrder?: number | null;
20
20
  teamId?: string | null;
21
21
  ownerUserId?: string | null;
22
+ parentObjectiveId?: string | null;
22
23
  keyResults?: CreateKeyResultRequest.Raw[] | null;
23
24
  }
24
25
  }
@@ -16,5 +16,6 @@ export const CreateObjectiveRequest = core.serialization.object({
16
16
  sortOrder: core.serialization.number().optional(),
17
17
  teamId: core.serialization.string().optional(),
18
18
  ownerUserId: core.serialization.string().optional(),
19
+ parentObjectiveId: core.serialization.string().optional(),
19
20
  keyResults: core.serialization.list(CreateKeyResultRequest).optional(),
20
21
  });
@@ -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;
@@ -21,6 +21,8 @@ export const Objective = core.serialization.object({
21
21
  owner: User.optional(),
22
22
  ownerUserId: core.serialization.string().optional(),
23
23
  score: core.serialization.number().optional(),
24
+ keyResultScore: core.serialization.number().optional(),
25
+ parentObjectiveId: core.serialization.string().optional(),
24
26
  keyResults: core.serialization.list(KeyResult),
25
27
  draft: core.serialization.boolean(),
26
28
  sortOrder: core.serialization.number(),
@@ -1,11 +1,17 @@
1
1
  import type * as Taktoria from "../../../../api/index.mjs";
2
2
  import * as core from "../../../../core/index.mjs";
3
3
  import type * as serializers from "../../../index.mjs";
4
+ import { ChildObjective } from "./ChildObjective.mjs";
4
5
  import { Objective } from "./Objective.mjs";
6
+ import { ObjectiveRef } from "./ObjectiveRef.mjs";
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
  }
@@ -1,9 +1,15 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
2
  import * as core from "../../../../core/index.mjs";
3
+ import { ChildObjective } from "./ChildObjective.mjs";
3
4
  import { Objective } from "./Objective.mjs";
5
+ import { ObjectiveRef } from "./ObjectiveRef.mjs";
4
6
  export const ObjectiveDetail = core.serialization
5
7
  .object({
6
8
  canEdit: core.serialization.boolean(),
7
9
  updatableKeyResultIds: core.serialization.list(core.serialization.string()),
10
+ parent: ObjectiveRef.optional(),
11
+ parentHidden: core.serialization.boolean(),
12
+ children: core.serialization.list(ChildObjective),
13
+ hiddenChildren: core.serialization.number(),
8
14
  })
9
15
  .extend(Objective);
@@ -0,0 +1,10 @@
1
+ import type * as Taktoria from "../../../../api/index.mjs";
2
+ import * as core from "../../../../core/index.mjs";
3
+ import type * as serializers from "../../../index.mjs";
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,6 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ import * as core from "../../../../core/index.mjs";
3
+ export const ObjectiveRef = core.serialization.object({
4
+ id: core.serialization.string(),
5
+ title: core.serialization.string(),
6
+ });
@@ -9,5 +9,6 @@ export declare namespace ScorecardCell {
9
9
  source?: ScorecardCellSource.Raw | null;
10
10
  noScore?: boolean | null;
11
11
  inProgress?: boolean | null;
12
+ withAligned?: boolean | null;
12
13
  }
13
14
  }
@@ -6,4 +6,5 @@ export const ScorecardCell = core.serialization.object({
6
6
  source: ScorecardCellSource.optional(),
7
7
  noScore: core.serialization.boolean().optional(),
8
8
  inProgress: core.serialization.boolean().optional(),
9
+ withAligned: core.serialization.boolean().optional(),
9
10
  });
@@ -16,6 +16,7 @@ export declare namespace UpdateObjectiveRequest {
16
16
  weight?: number | null;
17
17
  teamId?: string | null;
18
18
  ownerUserId?: string | null;
19
+ parentObjectiveId?: string | null;
19
20
  draft?: boolean | null;
20
21
  sortOrder?: number | null;
21
22
  archived?: boolean | null;
@@ -13,6 +13,7 @@ export const UpdateObjectiveRequest = core.serialization.object({
13
13
  weight: core.serialization.number().optional(),
14
14
  teamId: core.serialization.string().optional(),
15
15
  ownerUserId: core.serialization.string().optional(),
16
+ parentObjectiveId: core.serialization.string().optional(),
16
17
  draft: core.serialization.boolean().optional(),
17
18
  sortOrder: core.serialization.number().optional(),
18
19
  archived: core.serialization.boolean().optional(),
@@ -5,6 +5,7 @@ export * from "./BulkScoreSkipReason.mjs";
5
5
  export * from "./CheckIn.mjs";
6
6
  export * from "./CheckInMetric.mjs";
7
7
  export * from "./CheckInPage.mjs";
8
+ export * from "./ChildObjective.mjs";
8
9
  export * from "./CreateCheckInRequest.mjs";
9
10
  export * from "./CreateKeyResultRequest.mjs";
10
11
  export * from "./CreateObjectiveRequest.mjs";
@@ -24,6 +25,7 @@ export * from "./MetricSourceKind.mjs";
24
25
  export * from "./Objective.mjs";
25
26
  export * from "./ObjectiveDetail.mjs";
26
27
  export * from "./ObjectivePage.mjs";
28
+ export * from "./ObjectiveRef.mjs";
27
29
  export * from "./ObjectiveViewPage.mjs";
28
30
  export * from "./OkrCheckpoint.mjs";
29
31
  export * from "./OkrPeriod.mjs";
@@ -5,6 +5,7 @@ export * from "./BulkScoreSkipReason.mjs";
5
5
  export * from "./CheckIn.mjs";
6
6
  export * from "./CheckInMetric.mjs";
7
7
  export * from "./CheckInPage.mjs";
8
+ export * from "./ChildObjective.mjs";
8
9
  export * from "./CreateCheckInRequest.mjs";
9
10
  export * from "./CreateKeyResultRequest.mjs";
10
11
  export * from "./CreateObjectiveRequest.mjs";
@@ -24,6 +25,7 @@ export * from "./MetricSourceKind.mjs";
24
25
  export * from "./Objective.mjs";
25
26
  export * from "./ObjectiveDetail.mjs";
26
27
  export * from "./ObjectivePage.mjs";
28
+ export * from "./ObjectiveRef.mjs";
27
29
  export * from "./ObjectiveViewPage.mjs";
28
30
  export * from "./OkrCheckpoint.mjs";
29
31
  export * from "./OkrPeriod.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.2.1";
1
+ export declare const SDK_VERSION = "0.2.2";
@@ -1 +1 @@
1
- export const SDK_VERSION = "0.2.1";
1
+ export const SDK_VERSION = "0.2.2";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@taktoria/sdk",
3
- "version": "0.2.1",
3
+ "version": "0.2.2",
4
4
  "private": false,
5
5
  "type": "commonjs",
6
6
  "main": "./dist/cjs/index.js",