@taktoria/sdk 0.0.0-stage → 0.1.0

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

@@ -0,0 +1,150 @@
+// This file was auto-generated by Fern from our API Definition.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import { mergeHeaders } from "../../../../core/headers.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as environments from "../../../../environments.mjs";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
+import * as errors from "../../../../errors/index.mjs";
+import * as serializers from "../../../../serialization/index.mjs";
+import * as Taktoria from "../../../index.mjs";
+export class SearchClient {
+    constructor(options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    /**
+     * Everything in one app that matches `q`, grouped by kind: what the
+     * app's top bar search shows. Matching is the list endpoints' `q`
+     * (every word in some field, case and accents ignored, at most 100
+     * characters and 8 words; see Searching under Errors and pagination),
+     * and each group finds only what its list would show the caller: a
+     * signed-in person never finds a private objective they may not see,
+     * an event they may not run, a question on one, or a draft link's
+     * destination they may not edit. A key speaks for the workspace.
+     *
+     * Each group needs its list's read scope (see `SearchGroupType`); the
+     * groups the caller cannot read are left out, and a caller who can read
+     * none of the app's is refused with `403 insufficient_scope`, naming
+     * the scopes in `details.scopes`. A signed-in person needs a seat on the
+     * app (`403 seat_required`). Each group counts every match and returns
+     * the first five.
+     *
+     * @param {Taktoria.SearchRequest} request
+     * @param {SearchClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Taktoria.BadRequestError}
+     * @throws {@link Taktoria.UnauthorizedError}
+     * @throws {@link Taktoria.SubscriptionRequiredError}
+     * @throws {@link Taktoria.ForbiddenError}
+     * @throws {@link Taktoria.TooManyRequestsError}
+     * @throws {@link errors.TaktoriaError}
+     * @throws {@link errors.TaktoriaTimeoutError}
+     *
+     * @example
+     *     await client.search.search({
+     *         app: "launchcal",
+     *         q: "billing"
+     *     })
+     */
+    search(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__search(request, requestOptions));
+    }
+    __search(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+            const { app, q } = request;
+            const _queryParams = {
+                app: serializers.SearchApp.jsonOrThrow(app, { unrecognizedObjectKeys: "strip", omitUndefined: true }),
+                q,
+            };
+            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);
+            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.TaktoriaEnvironment.Production, "search"),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url
+                    .queryBuilder()
+                    .addMany(_queryParams)
+                    .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                    .build(),
+                timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
+                maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: serializers.SearchResponse.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Taktoria.BadRequestError(serializers.ErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 401:
+                        throw new Taktoria.UnauthorizedError(serializers.ErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 402:
+                        throw new Taktoria.SubscriptionRequiredError(serializers.ErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 403:
+                        throw new Taktoria.ForbiddenError(serializers.ErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 429:
+                        throw new Taktoria.TooManyRequestsError(serializers.ErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    default:
+                        throw new errors.TaktoriaError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/search");
+        });
+    }
+}

package/dist/esm/api/resources/search/client/index.d.mts

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/search/client/index.mjs

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/search/client/requests/SearchRequest.d.mts

@@ -0,0 +1,18 @@
+import type * as Taktoria from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         app: "launchcal",
+ *         q: "billing"
+ *     }
+ */
+export interface SearchRequest {
+    /** The app to search. Missing or unknown, `400 invalid_app`. */
+    app: Taktoria.SearchApp;
+    /**
+     * What to find. Every word must appear in one of a thing's fields;
+     * case and accents are ignored; at most 100 characters and 8
+     * words. Left out or blank, every group comes back empty.
+     */
+    q?: string;
+}

package/dist/esm/api/resources/search/client/requests/SearchRequest.mjs

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

package/dist/esm/api/resources/search/client/requests/index.d.mts

@@ -0,0 +1 @@
+export type { SearchRequest } from "./SearchRequest.mjs";

package/dist/esm/api/resources/search/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/search/exports.d.mts

@@ -0,0 +1,2 @@
+export { SearchClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/search/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { SearchClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/search/index.d.mts

@@ -0,0 +1,2 @@
+export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/search/index.mjs

@@ -0,0 +1,2 @@
+export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/search/types/SearchApp.d.mts

@@ -0,0 +1,9 @@
+/** The app to search, by its slug. */
+export declare const SearchApp: {
+    readonly Launchcal: "launchcal";
+    readonly Okrhub: "okrhub";
+    readonly Dory: "dory";
+    readonly Golinks: "golinks";
+    readonly Memegen: "memegen";
+};
+export type SearchApp = (typeof SearchApp)[keyof typeof SearchApp];

package/dist/esm/api/resources/search/types/SearchApp.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+/** The app to search, by its slug. */
+export const SearchApp = {
+    Launchcal: "launchcal",
+    Okrhub: "okrhub",
+    Dory: "dory",
+    Golinks: "golinks",
+    Memegen: "memegen",
+};

package/dist/esm/api/resources/search/types/SearchEvent.d.mts

@@ -0,0 +1,8 @@
+import type * as Taktoria from "../../../index.mjs";
+export interface SearchEvent {
+    id: string;
+    title: string;
+    code: string;
+    phase: Taktoria.EventPhase;
+    startsAt?: Date;
+}

package/dist/esm/api/resources/search/types/SearchEvent.mjs

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

package/dist/esm/api/resources/search/types/SearchEventParent.d.mts

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

package/dist/esm/api/resources/search/types/SearchEventParent.mjs

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

package/dist/esm/api/resources/search/types/SearchGroup.d.mts

@@ -0,0 +1,7 @@
+import type * as Taktoria from "../../../index.mjs";
+export interface SearchGroup {
+    type: Taktoria.SearchGroupType;
+    /** How many match in all; `items` holds the first five. */
+    total: number;
+    items: Taktoria.SearchResult[];
+}

package/dist/esm/api/resources/search/types/SearchGroup.mjs

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

package/dist/esm/api/resources/search/types/SearchGroupType.d.mts

@@ -0,0 +1,22 @@
+/**
+ * A kind of thing an app's search finds, and the read scope it needs:
+ * `launches` (`launches:read`) and `steps` (`steps:read`) in LaunchCal;
+ * `objectives` (`objectives:read`), `keyResults` (`keyResults:read`) and
+ * `teams` (`teams:read`) in OKR Hub; `events` (`events:read`) and
+ * `questions` (`questions:read`) in Dory; `links` (`golinks:read`) in Go
+ * Links; `memes` (`memes:read`) and `templates` (`memeTemplates:read`) in
+ * Memegen.
+ */
+export declare const SearchGroupType: {
+    readonly Launches: "launches";
+    readonly Steps: "steps";
+    readonly Objectives: "objectives";
+    readonly KeyResults: "keyResults";
+    readonly Teams: "teams";
+    readonly Events: "events";
+    readonly Questions: "questions";
+    readonly Links: "links";
+    readonly Memes: "memes";
+    readonly Templates: "templates";
+};
+export type SearchGroupType = (typeof SearchGroupType)[keyof typeof SearchGroupType];

package/dist/esm/api/resources/search/types/SearchGroupType.mjs

@@ -0,0 +1,22 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * A kind of thing an app's search finds, and the read scope it needs:
+ * `launches` (`launches:read`) and `steps` (`steps:read`) in LaunchCal;
+ * `objectives` (`objectives:read`), `keyResults` (`keyResults:read`) and
+ * `teams` (`teams:read`) in OKR Hub; `events` (`events:read`) and
+ * `questions` (`questions:read`) in Dory; `links` (`golinks:read`) in Go
+ * Links; `memes` (`memes:read`) and `templates` (`memeTemplates:read`) in
+ * Memegen.
+ */
+export const SearchGroupType = {
+    Launches: "launches",
+    Steps: "steps",
+    Objectives: "objectives",
+    KeyResults: "keyResults",
+    Teams: "teams",
+    Events: "events",
+    Questions: "questions",
+    Links: "links",
+    Memes: "memes",
+    Templates: "templates",
+};

package/dist/esm/api/resources/search/types/SearchKeyResult.d.mts

@@ -0,0 +1,7 @@
+import type * as Taktoria from "../../../index.mjs";
+export interface SearchKeyResult {
+    id: string;
+    title: string;
+    score?: number;
+    objective: Taktoria.SearchObjectiveParent;
+}

package/dist/esm/api/resources/search/types/SearchKeyResult.mjs

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

package/dist/esm/api/resources/search/types/SearchLaunch.d.mts

@@ -0,0 +1,8 @@
+import type * as Taktoria from "../../../index.mjs";
+export interface SearchLaunch {
+    id: string;
+    name: string;
+    status: Taktoria.LaunchStatus;
+    draft: boolean;
+    plannedLaunchDate?: Date;
+}

package/dist/esm/api/resources/search/types/SearchLaunch.mjs

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

package/dist/esm/api/resources/search/types/SearchLink.d.mts

@@ -0,0 +1,8 @@
+export interface SearchLink {
+    id: string;
+    slug: string;
+    description?: string;
+    /** Null for a draft the caller may not edit; a key sees every destination. */
+    url?: string;
+    draft: boolean;
+}

package/dist/esm/api/resources/search/types/SearchLink.mjs

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

package/dist/esm/api/resources/search/types/SearchMeme.d.mts

@@ -0,0 +1,7 @@
+import type * as Taktoria from "../../../index.mjs";
+export interface SearchMeme {
+    id: string;
+    /** One per caption box, empty ones left out. */
+    captions: string[];
+    template: Taktoria.SearchParent;
+}

package/dist/esm/api/resources/search/types/SearchMeme.mjs

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

package/dist/esm/api/resources/search/types/SearchObjective.d.mts

@@ -0,0 +1,10 @@
+import type * as Taktoria from "../../../index.mjs";
+export interface SearchObjective {
+    id: string;
+    title: string;
+    period: Taktoria.OkrPeriod;
+    year: number;
+    quarter?: number;
+    /** Rolled up from its key results, as everywhere; null until one is scored. */
+    score?: number;
+}

package/dist/esm/api/resources/search/types/SearchObjective.mjs

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

package/dist/esm/api/resources/search/types/SearchObjectiveParent.d.mts

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

package/dist/esm/api/resources/search/types/SearchObjectiveParent.mjs

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

package/dist/esm/api/resources/search/types/SearchParent.d.mts

@@ -0,0 +1,4 @@
+export interface SearchParent {
+    id: string;
+    name: string;
+}

package/dist/esm/api/resources/search/types/SearchParent.mjs

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

package/dist/esm/api/resources/search/types/SearchQuestion.d.mts

@@ -0,0 +1,10 @@
+import type * as Taktoria from "../../../index.mjs";
+/**
+ * Never who asked it. An anonymous question stays anonymous, and a named one is the event's to show.
+ */
+export interface SearchQuestion {
+    id: string;
+    body: string;
+    status: Taktoria.QuestionStatus;
+    event: Taktoria.SearchEventParent;
+}

package/dist/esm/api/resources/search/types/SearchQuestion.mjs

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

package/dist/esm/api/resources/search/types/SearchResponse.d.mts

@@ -0,0 +1,11 @@
+import type * as Taktoria from "../../../index.mjs";
+export interface SearchResponse {
+    app: Taktoria.SearchApp;
+    /** The query as searched, trimmed and cut to 100 characters. */
+    query: string;
+    /**
+     * The app's groups, in order, each the caller's scopes can read. A
+     * group with nothing in it is still listed, with `total` 0.
+     */
+    groups: Taktoria.SearchGroup[];
+}

package/dist/esm/api/resources/search/types/SearchResponse.mjs

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

package/dist/esm/api/resources/search/types/SearchResult.d.mts

@@ -0,0 +1,37 @@
+import type * as Taktoria from "../../../index.mjs";
+/**
+ * One thing found, told apart by `type`.
+ */
+export type SearchResult = Taktoria.SearchResult.Launch | Taktoria.SearchResult.Step | Taktoria.SearchResult.Objective | Taktoria.SearchResult.KeyResult | Taktoria.SearchResult.Team | Taktoria.SearchResult.Event | Taktoria.SearchResult.Question | Taktoria.SearchResult.Link | Taktoria.SearchResult.Meme | Taktoria.SearchResult.Template;
+export declare namespace SearchResult {
+    interface Launch extends Taktoria.SearchLaunch {
+        type: "launch";
+    }
+    interface Step extends Taktoria.SearchStep {
+        type: "step";
+    }
+    interface Objective extends Taktoria.SearchObjective {
+        type: "objective";
+    }
+    interface KeyResult extends Taktoria.SearchKeyResult {
+        type: "keyResult";
+    }
+    interface Team extends Taktoria.SearchTeam {
+        type: "team";
+    }
+    interface Event extends Taktoria.SearchEvent {
+        type: "event";
+    }
+    interface Question extends Taktoria.SearchQuestion {
+        type: "question";
+    }
+    interface Link extends Taktoria.SearchLink {
+        type: "link";
+    }
+    interface Meme extends Taktoria.SearchMeme {
+        type: "meme";
+    }
+    interface Template extends Taktoria.SearchTemplate {
+        type: "template";
+    }
+}

package/dist/esm/api/resources/search/types/SearchResult.mjs

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

package/dist/esm/api/resources/search/types/SearchStep.d.mts

@@ -0,0 +1,8 @@
+import type * as Taktoria from "../../../index.mjs";
+export interface SearchStep {
+    id: string;
+    name: string;
+    status: Taktoria.StepStatus;
+    dueDate?: Date;
+    launch: Taktoria.SearchParent;
+}

package/dist/esm/api/resources/search/types/SearchStep.mjs

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

package/dist/esm/api/resources/search/types/SearchTeam.d.mts

@@ -0,0 +1,5 @@
+export interface SearchTeam {
+    id: string;
+    name: string;
+    slug: string;
+}

package/dist/esm/api/resources/search/types/SearchTeam.mjs

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

package/dist/esm/api/resources/search/types/SearchTemplate.d.mts

@@ -0,0 +1,6 @@
+export interface SearchTemplate {
+    id: string;
+    name: string;
+    /** Taken out of the picker. Found only by Memegen's app admins and keys. */
+    archived: boolean;
+}

package/dist/esm/api/resources/search/types/SearchTemplate.mjs

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

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

@@ -0,0 +1,18 @@
+export * from "./SearchApp.mjs";
+export * from "./SearchEvent.mjs";
+export * from "./SearchEventParent.mjs";
+export * from "./SearchGroup.mjs";
+export * from "./SearchGroupType.mjs";
+export * from "./SearchKeyResult.mjs";
+export * from "./SearchLaunch.mjs";
+export * from "./SearchLink.mjs";
+export * from "./SearchMeme.mjs";
+export * from "./SearchObjective.mjs";
+export * from "./SearchObjectiveParent.mjs";
+export * from "./SearchParent.mjs";
+export * from "./SearchQuestion.mjs";
+export * from "./SearchResponse.mjs";
+export * from "./SearchResult.mjs";
+export * from "./SearchStep.mjs";
+export * from "./SearchTeam.mjs";
+export * from "./SearchTemplate.mjs";

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

@@ -0,0 +1,18 @@
+export * from "./SearchApp.mjs";
+export * from "./SearchEvent.mjs";
+export * from "./SearchEventParent.mjs";
+export * from "./SearchGroup.mjs";
+export * from "./SearchGroupType.mjs";
+export * from "./SearchKeyResult.mjs";
+export * from "./SearchLaunch.mjs";
+export * from "./SearchLink.mjs";
+export * from "./SearchMeme.mjs";
+export * from "./SearchObjective.mjs";
+export * from "./SearchObjectiveParent.mjs";
+export * from "./SearchParent.mjs";
+export * from "./SearchQuestion.mjs";
+export * from "./SearchResponse.mjs";
+export * from "./SearchResult.mjs";
+export * from "./SearchStep.mjs";
+export * from "./SearchTeam.mjs";
+export * from "./SearchTemplate.mjs";