@taktoria/sdk 0.2.0 → 0.2.2

package/dist/esm/api/resources/okr/client/Client.mjs

@@ -47,12 +47,13 @@ export class OkrClient {
     __listObjectives() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const { year, quarter, teamId, ownerUserId, visibility, tag, q, draft, archived, limit, cursor } = request;
+            const { year, quarter, teamId, ownerUserId, parentObjectiveId, visibility, tag, q, draft, archived, limit, cursor, } = request;
             const _queryParams = {
                 year,
                 quarter,
                 teamId,
                 ownerUserId,
+                parentObjectiveId,
                 visibility: visibility != null
                     ? serializers.OkrVisibility.jsonOrThrow(visibility, {
                         unrecognizedObjectKeys: "strip",
@@ -1187,7 +1188,7 @@ export class OkrClient {
     __getScorecard() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const { year, teamId, priority, frame, mid } = request;
+            const { year, teamId, priority, tag, frame, mid } = request;
             const _queryParams = {
                 year,
                 teamId,
@@ -1197,6 +1198,7 @@ export class OkrClient {
                         omitUndefined: true,
                     })
                     : undefined,
+                tag,
                 frame,
                 mid,
             };
@@ -2344,7 +2346,7 @@ export class OkrClient {
     __listTeamScores() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const { year, quarter, period, q, sort, onlyScored, limit, cursor } = request;
+            const { year, quarter, period, q, sort, onlyScored, tag, limit, cursor } = request;
             const _queryParams = {
                 year,
                 quarter,
@@ -2357,6 +2359,7 @@ export class OkrClient {
                 q,
                 sort,
                 onlyScored,
+                tag,
                 limit,
                 cursor,
             };
@@ -2453,7 +2456,7 @@ export class OkrClient {
     __getTeamOkrs(teamSlug_1) {
         return __awaiter(this, arguments, void 0, function* (teamSlug, request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const { year, quarter, period } = request;
+            const { year, quarter, period, tag } = request;
             const _queryParams = {
                 year,
                 quarter,
@@ -2463,6 +2466,7 @@ export class OkrClient {
                         omitUndefined: true,
                     })
                     : undefined,
+                tag,
             };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);

package/dist/esm/api/resources/okr/client/requests/GetScorecardRequest.d.mts

@@ -17,6 +17,11 @@ export interface GetScorecardRequest {
      * their cells rolled up from those key results alone.
      */
     priority?: Taktoria.OkrPriority;
+    /**
+     * Only objectives carrying this tag, or holding a key result that
+     * does. One word, matched whole; case and a leading `#` are ignored.
+     */
+    tag?: string;
     /** `annual`, or a quarter `1` to `4`. Every period when left out. */
     frame?: string | string[];
     /** `false` leaves out the mid-quarter columns. */

package/dist/esm/api/resources/okr/client/requests/GetTeamOkrsRequest.d.mts

@@ -8,4 +8,9 @@ export interface GetTeamOkrsRequest {
     year?: number;
     quarter?: number;
     period?: Taktoria.OkrPeriod;
+    /**
+     * Only objectives carrying this tag, or holding a key result that
+     * does. One word, matched whole; case and a leading `#` are ignored.
+     */
+    tag?: string;
 }

package/dist/esm/api/resources/okr/client/requests/ListObjectivesRequest.d.mts

@@ -15,6 +15,8 @@ export interface ListObjectivesRequest {
      */
     teamId?: string;
     ownerUserId?: string;
+    /** Only the objectives aligned directly to this one, its children. */
+    parentObjectiveId?: string;
     visibility?: Taktoria.OkrVisibility;
     /**
      * Only objectives carrying this tag, or holding a key result that

package/dist/esm/api/resources/okr/client/requests/ListTeamScoresRequest.d.mts

@@ -16,6 +16,12 @@ export interface ListTeamScoresRequest {
     sort?: string;
     /** `true` keeps only the teams with a score. */
     onlyScored?: boolean;
+    /**
+     * Only teams holding an objective that carries this tag, or a key
+     * result that does, each scored on those alone. One word, matched
+     * whole.
+     */
+    tag?: string;
     /** At most 100; 50 when left out. */
     limit?: number;
     cursor?: string;

package/dist/esm/api/resources/okr/types/ChildObjective.d.mts

@@ -0,0 +1,15 @@
+import type * as Taktoria from "../../../index.mjs";
+/**
+ * An objective aligned to another, as its parent lists it.
+ */
+export interface ChildObjective {
+    id: string;
+    title: string;
+    /** How much it counts in its parent's score, beside the parent's key results. */
+    weight: number;
+    period: Taktoria.OkrPeriod;
+    year: number;
+    quarter?: number;
+    /** Its own score, with anything aligned under it rolled in. */
+    score?: number;
+}

package/dist/esm/api/resources/okr/types/ChildObjective.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/okr/types/CreateObjectiveRequest.d.mts

@@ -47,6 +47,11 @@ export interface CreateObjectiveRequest {
     sortOrder?: number;
     teamId?: string;
     ownerUserId?: string;
+    /**
+     * The objective it aligns to: any the caller may see, in any period.
+     * Anything else is a 422.
+     */
+    parentObjectiveId?: string;
     /**
      * Its key results, at most 50, made with it in this order; each as
      * `createKeyResult` takes one, a first `score` recorded as a

package/dist/esm/api/resources/okr/types/Objective.d.mts

@@ -30,11 +30,25 @@ export interface Objective {
     owner?: Taktoria.User;
     ownerUserId?: string;
     /**
-     * The weighted average of its key results' grades, or absent when
-     * none has been scored. Absent rather than 0.0 on purpose: an
-     * unscored objective has not failed, and a zero would say it had.
+     * The weighted average of its key results' grades, with each
+     * objective aligned under it counted like one more key result (its
+     * own score, by its weight), or absent when nothing is scored.
+     * Absent rather than 0.0 on purpose: an unscored objective has not
+     * failed, and a zero would say it had. Where a list shows only some
+     * of an objective's key results (`/okrhub/mine`, a team's page), it
+     * is those key results' average alone.
      */
     score?: number;
+    /**
+     * Its own key results' weighted average alone, as the averages over
+     * many objectives (`rollup`) count it, so that nothing counts twice.
+     */
+    keyResultScore?: number;
+    /**
+     * The objective it aligns to, if any: one, in any period. Its score
+     * counts in the parent's.
+     */
+    parentObjectiveId?: string;
     keyResults: Taktoria.KeyResult[];
     /**
      * Still being worked out, not yet agreed. A label only: a draft is

package/dist/esm/api/resources/okr/types/ObjectiveDetail.d.mts

@@ -17,4 +17,19 @@ export interface ObjectiveDetail extends Taktoria.Objective {
      * through a team) for anybody else. Every one, for a key.
      */
     updatableKeyResultIds: string[];
+    /** The objective it aligns to, if the caller may see it. */
+    parent?: Taktoria.ObjectiveRef;
+    /** `true` when it aligns to a private objective the caller may not see. */
+    parentHidden: boolean;
+    /**
+     * The objectives aligned directly to it that the caller may see,
+     * newest period first. Each counts in its `score`.
+     */
+    children: Taktoria.ChildObjective[];
+    /**
+     * How many more objectives are aligned to it that the caller may
+     * not see. They count in its `score`, so it is the same for
+     * everybody, but are never named.
+     */
+    hiddenChildren: number;
 }

package/dist/esm/api/resources/okr/types/ObjectiveRef.d.mts

@@ -0,0 +1,4 @@
+export interface ObjectiveRef {
+    id: string;
+    title: string;
+}

package/dist/esm/api/resources/okr/types/ObjectiveRef.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/okr/types/ScorecardCell.d.mts

@@ -16,4 +16,12 @@ export interface ScorecardCell {
      * it, and say so in `averageInProgress`.
      */
     inProgress?: boolean;
+    /**
+     * `true` on an objective's cell that counts the objectives aligned
+     * under it, each like one more key result by its weight, as it stood
+     * at that checkpoint (its Final once its own period is over, before
+     * then its latest check-ins). The averages take each objective on
+     * its own key results instead, so nothing counts twice.
+     */
+    withAligned?: boolean;
 }

package/dist/esm/api/resources/okr/types/ScorecardKeyResultRow.d.mts

@@ -2,6 +2,9 @@ import type * as Taktoria from "../../../index.mjs";
 export interface ScorecardKeyResultRow {
     keyResultId: string;
     title: string;
+    description?: string;
+    /** Its tags, A to Z. */
+    tags: string[];
     priority?: Taktoria.OkrPriority;
     weight: number;
     cells: Record<string, Taktoria.ScorecardCell>;

package/dist/esm/api/resources/okr/types/ScorecardRow.d.mts

@@ -5,6 +5,9 @@ import type * as Taktoria from "../../../index.mjs";
 export interface ScorecardRow {
     objectiveId: string;
     title: string;
+    description?: string;
+    /** Its tags, A to Z. */
+    tags: string[];
     weight: number;
     timeframe: Taktoria.ScorecardTimeframe;
     /** Rolled up from its key results, by weight. */

package/dist/esm/api/resources/okr/types/UpdateObjectiveRequest.d.mts

@@ -23,6 +23,11 @@ export interface UpdateObjectiveRequest {
     weight?: number;
     teamId?: string;
     ownerUserId?: string;
+    /**
+     * The objective it aligns to, any the caller may see; `null` for
+     * none. Neither the objective itself nor one aligned under it (a 422).
+     */
+    parentObjectiveId?: string;
     /** `false` publishes it. */
     draft?: boolean;
     sortOrder?: number;

package/dist/esm/api/resources/okr/types/index.d.mts

@@ -5,6 +5,7 @@ export * from "./BulkScoreSkipReason.mjs";
 export * from "./CheckIn.mjs";
 export * from "./CheckInMetric.mjs";
 export * from "./CheckInPage.mjs";
+export * from "./ChildObjective.mjs";
 export * from "./CreateCheckInRequest.mjs";
 export * from "./CreateKeyResultRequest.mjs";
 export * from "./CreateObjectiveRequest.mjs";
@@ -24,6 +25,7 @@ export * from "./MetricSourceKind.mjs";
 export * from "./Objective.mjs";
 export * from "./ObjectiveDetail.mjs";
 export * from "./ObjectivePage.mjs";
+export * from "./ObjectiveRef.mjs";
 export * from "./ObjectiveViewPage.mjs";
 export * from "./OkrCheckpoint.mjs";
 export * from "./OkrPeriod.mjs";

package/dist/esm/api/resources/okr/types/index.mjs

@@ -5,6 +5,7 @@ export * from "./BulkScoreSkipReason.mjs";
 export * from "./CheckIn.mjs";
 export * from "./CheckInMetric.mjs";
 export * from "./CheckInPage.mjs";
+export * from "./ChildObjective.mjs";
 export * from "./CreateCheckInRequest.mjs";
 export * from "./CreateKeyResultRequest.mjs";
 export * from "./CreateObjectiveRequest.mjs";
@@ -24,6 +25,7 @@ export * from "./MetricSourceKind.mjs";
 export * from "./Objective.mjs";
 export * from "./ObjectiveDetail.mjs";
 export * from "./ObjectivePage.mjs";
+export * from "./ObjectiveRef.mjs";
 export * from "./ObjectiveViewPage.mjs";
 export * from "./OkrCheckpoint.mjs";
 export * from "./OkrPeriod.mjs";

package/dist/esm/serialization/resources/okr/types/ChildObjective.d.mts

@@ -0,0 +1,16 @@
+import type * as Taktoria from "../../../../api/index.mjs";
+import * as core from "../../../../core/index.mjs";
+import type * as serializers from "../../../index.mjs";
+import { OkrPeriod } from "./OkrPeriod.mjs";
+export declare const ChildObjective: core.serialization.ObjectSchema<serializers.ChildObjective.Raw, Taktoria.ChildObjective>;
+export declare namespace ChildObjective {
+    interface Raw {
+        id: string;
+        title: string;
+        weight: number;
+        period: OkrPeriod.Raw;
+        year: number;
+        quarter?: number | null;
+        score?: number | null;
+    }
+}

package/dist/esm/serialization/resources/okr/types/ChildObjective.mjs

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../../../core/index.mjs";
+import { OkrPeriod } from "./OkrPeriod.mjs";
+export const ChildObjective = core.serialization.object({
+    id: core.serialization.string(),
+    title: core.serialization.string(),
+    weight: core.serialization.number(),
+    period: OkrPeriod,
+    year: core.serialization.number(),
+    quarter: core.serialization.number().optional(),
+    score: core.serialization.number().optional(),
+});

package/dist/esm/serialization/resources/okr/types/CreateObjectiveRequest.d.mts

@@ -19,6 +19,7 @@ export declare namespace CreateObjectiveRequest {
         sortOrder?: number | null;
         teamId?: string | null;
         ownerUserId?: string | null;
+        parentObjectiveId?: string | null;
         keyResults?: CreateKeyResultRequest.Raw[] | null;
     }
 }

package/dist/esm/serialization/resources/okr/types/CreateObjectiveRequest.mjs

@@ -16,5 +16,6 @@ export const CreateObjectiveRequest = core.serialization.object({
     sortOrder: core.serialization.number().optional(),
     teamId: core.serialization.string().optional(),
     ownerUserId: core.serialization.string().optional(),
+    parentObjectiveId: core.serialization.string().optional(),
     keyResults: core.serialization.list(CreateKeyResultRequest).optional(),
 });

package/dist/esm/serialization/resources/okr/types/Objective.d.mts

@@ -24,6 +24,8 @@ export declare namespace Objective {
         owner?: User.Raw | null;
         ownerUserId?: string | null;
         score?: number | null;
+        keyResultScore?: number | null;
+        parentObjectiveId?: string | null;
         keyResults: KeyResult.Raw[];
         draft: boolean;
         sortOrder: number;

package/dist/esm/serialization/resources/okr/types/Objective.mjs

@@ -21,6 +21,8 @@ export const Objective = core.serialization.object({
     owner: User.optional(),
     ownerUserId: core.serialization.string().optional(),
     score: core.serialization.number().optional(),
+    keyResultScore: core.serialization.number().optional(),
+    parentObjectiveId: core.serialization.string().optional(),
     keyResults: core.serialization.list(KeyResult),
     draft: core.serialization.boolean(),
     sortOrder: core.serialization.number(),

package/dist/esm/serialization/resources/okr/types/ObjectiveDetail.d.mts

@@ -1,11 +1,17 @@
 import type * as Taktoria from "../../../../api/index.mjs";
 import * as core from "../../../../core/index.mjs";
 import type * as serializers from "../../../index.mjs";
+import { ChildObjective } from "./ChildObjective.mjs";
 import { Objective } from "./Objective.mjs";
+import { ObjectiveRef } from "./ObjectiveRef.mjs";
 export declare const ObjectiveDetail: core.serialization.ObjectSchema<serializers.ObjectiveDetail.Raw, Taktoria.ObjectiveDetail>;
 export declare namespace ObjectiveDetail {
     interface Raw extends Objective.Raw {
         canEdit: boolean;
         updatableKeyResultIds: string[];
+        parent?: ObjectiveRef.Raw | null;
+        parentHidden: boolean;
+        children: ChildObjective.Raw[];
+        hiddenChildren: number;
     }
 }

package/dist/esm/serialization/resources/okr/types/ObjectiveDetail.mjs

@@ -1,9 +1,15 @@
 // This file was auto-generated by Fern from our API Definition.
 import * as core from "../../../../core/index.mjs";
+import { ChildObjective } from "./ChildObjective.mjs";
 import { Objective } from "./Objective.mjs";
+import { ObjectiveRef } from "./ObjectiveRef.mjs";
 export const ObjectiveDetail = core.serialization
     .object({
     canEdit: core.serialization.boolean(),
     updatableKeyResultIds: core.serialization.list(core.serialization.string()),
+    parent: ObjectiveRef.optional(),
+    parentHidden: core.serialization.boolean(),
+    children: core.serialization.list(ChildObjective),
+    hiddenChildren: core.serialization.number(),
 })
     .extend(Objective);

package/dist/esm/serialization/resources/okr/types/ObjectiveRef.d.mts

@@ -0,0 +1,10 @@
+import type * as Taktoria from "../../../../api/index.mjs";
+import * as core from "../../../../core/index.mjs";
+import type * as serializers from "../../../index.mjs";
+export declare const ObjectiveRef: core.serialization.ObjectSchema<serializers.ObjectiveRef.Raw, Taktoria.ObjectiveRef>;
+export declare namespace ObjectiveRef {
+    interface Raw {
+        id: string;
+        title: string;
+    }
+}

package/dist/esm/serialization/resources/okr/types/ObjectiveRef.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../../../core/index.mjs";
+export const ObjectiveRef = core.serialization.object({
+    id: core.serialization.string(),
+    title: core.serialization.string(),
+});

package/dist/esm/serialization/resources/okr/types/ScorecardCell.d.mts

@@ -9,5 +9,6 @@ export declare namespace ScorecardCell {
         source?: ScorecardCellSource.Raw | null;
         noScore?: boolean | null;
         inProgress?: boolean | null;
+        withAligned?: boolean | null;
     }
 }

package/dist/esm/serialization/resources/okr/types/ScorecardCell.mjs

@@ -6,4 +6,5 @@ export const ScorecardCell = core.serialization.object({
     source: ScorecardCellSource.optional(),
     noScore: core.serialization.boolean().optional(),
     inProgress: core.serialization.boolean().optional(),
+    withAligned: core.serialization.boolean().optional(),
 });

package/dist/esm/serialization/resources/okr/types/ScorecardKeyResultRow.d.mts

@@ -8,6 +8,8 @@ export declare namespace ScorecardKeyResultRow {
     interface Raw {
         keyResultId: string;
         title: string;
+        description?: string | null;
+        tags: string[];
         priority?: OkrPriority.Raw | null;
         weight: number;
         cells: Record<string, ScorecardCell.Raw>;

package/dist/esm/serialization/resources/okr/types/ScorecardKeyResultRow.mjs

@@ -5,6 +5,8 @@ import { ScorecardCell } from "./ScorecardCell.mjs";
 export const ScorecardKeyResultRow = core.serialization.object({
     keyResultId: core.serialization.string(),
     title: core.serialization.string(),
+    description: core.serialization.string().optional(),
+    tags: core.serialization.list(core.serialization.string()),
     priority: OkrPriority.optional(),
     weight: core.serialization.number(),
     cells: core.serialization.record(core.serialization.string(), ScorecardCell),

package/dist/esm/serialization/resources/okr/types/ScorecardRow.d.mts

@@ -9,6 +9,8 @@ export declare namespace ScorecardRow {
     interface Raw {
         objectiveId: string;
         title: string;
+        description?: string | null;
+        tags: string[];
         weight: number;
         timeframe: ScorecardTimeframe.Raw;
         cells: Record<string, ScorecardCell.Raw>;

package/dist/esm/serialization/resources/okr/types/ScorecardRow.mjs

@@ -6,6 +6,8 @@ import { ScorecardTimeframe } from "./ScorecardTimeframe.mjs";
 export const ScorecardRow = core.serialization.object({
     objectiveId: core.serialization.string(),
     title: core.serialization.string(),
+    description: core.serialization.string().optional(),
+    tags: core.serialization.list(core.serialization.string()),
     weight: core.serialization.number(),
     timeframe: ScorecardTimeframe,
     cells: core.serialization.record(core.serialization.string(), ScorecardCell),

package/dist/esm/serialization/resources/okr/types/UpdateObjectiveRequest.d.mts

@@ -16,6 +16,7 @@ export declare namespace UpdateObjectiveRequest {
         weight?: number | null;
         teamId?: string | null;
         ownerUserId?: string | null;
+        parentObjectiveId?: string | null;
         draft?: boolean | null;
         sortOrder?: number | null;
         archived?: boolean | null;

package/dist/esm/serialization/resources/okr/types/UpdateObjectiveRequest.mjs

@@ -13,6 +13,7 @@ export const UpdateObjectiveRequest = core.serialization.object({
     weight: core.serialization.number().optional(),
     teamId: core.serialization.string().optional(),
     ownerUserId: core.serialization.string().optional(),
+    parentObjectiveId: core.serialization.string().optional(),
     draft: core.serialization.boolean().optional(),
     sortOrder: core.serialization.number().optional(),
     archived: core.serialization.boolean().optional(),

package/dist/esm/serialization/resources/okr/types/index.d.mts

@@ -5,6 +5,7 @@ export * from "./BulkScoreSkipReason.mjs";
 export * from "./CheckIn.mjs";
 export * from "./CheckInMetric.mjs";
 export * from "./CheckInPage.mjs";
+export * from "./ChildObjective.mjs";
 export * from "./CreateCheckInRequest.mjs";
 export * from "./CreateKeyResultRequest.mjs";
 export * from "./CreateObjectiveRequest.mjs";
@@ -24,6 +25,7 @@ export * from "./MetricSourceKind.mjs";
 export * from "./Objective.mjs";
 export * from "./ObjectiveDetail.mjs";
 export * from "./ObjectivePage.mjs";
+export * from "./ObjectiveRef.mjs";
 export * from "./ObjectiveViewPage.mjs";
 export * from "./OkrCheckpoint.mjs";
 export * from "./OkrPeriod.mjs";

package/dist/esm/serialization/resources/okr/types/index.mjs

@@ -5,6 +5,7 @@ export * from "./BulkScoreSkipReason.mjs";
 export * from "./CheckIn.mjs";
 export * from "./CheckInMetric.mjs";
 export * from "./CheckInPage.mjs";
+export * from "./ChildObjective.mjs";
 export * from "./CreateCheckInRequest.mjs";
 export * from "./CreateKeyResultRequest.mjs";
 export * from "./CreateObjectiveRequest.mjs";
@@ -24,6 +25,7 @@ export * from "./MetricSourceKind.mjs";
 export * from "./Objective.mjs";
 export * from "./ObjectiveDetail.mjs";
 export * from "./ObjectivePage.mjs";
+export * from "./ObjectiveRef.mjs";
 export * from "./ObjectiveViewPage.mjs";
 export * from "./OkrCheckpoint.mjs";
 export * from "./OkrPeriod.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.2.0";
+export declare const SDK_VERSION = "0.2.2";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.2.0";
+export const SDK_VERSION = "0.2.2";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@taktoria/sdk",
-    "version": "0.2.0",
+    "version": "0.2.2",
     "private": false,
     "type": "commonjs",
     "main": "./dist/cjs/index.js",