@upvoiced/sdk 0.0.0-stage → 0.1.0

package/dist/generated/schema.js

@@ -0,0 +1,7 @@
+/**
+ * Generated from the UpVoiced API OpenAPI document (version 0.1.0)
+ * by openapi-typescript. Do not edit by hand (P2-015, ADR-0067):
+ * run `pnpm --filter @upvoiced/sdk generate` after changing routes.
+ * Document sha256: b2e98a3bd5edbe654e2e232efd73a133e4323e3ebc5263b931d0d0b9dbe01144
+ */
+export {};

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @upvoiced/sdk — typed client for the UpVoiced API (P2-015, ADR-0067, INT-004).
+ * The `paths`/`operations` types are generated from the API's OpenAPI document.
+ */
+export { UpVoiced, defaultBaseUrl, defaultMaxRetries, defaultMaxRetryDelayMs } from './client.js';
+export type { ClientOptions } from './client.js';
+export { UpVoicedError } from './errors.js';
+export type { ErrorDetail } from './errors.js';
+export type { ApiResponse, CommonRequestOptions, HttpMethod, Operation, PageItem, PaginatedPath, PathParams, PathsWith, QueryParams, RequestArgs, RequestBody, RequestOptions, ResponseData, } from './types.js';
+export type { components, operations, paths, webhooks } from './generated/schema.js';

package/dist/index.js

@@ -0,0 +1,6 @@
+/**
+ * @upvoiced/sdk — typed client for the UpVoiced API (P2-015, ADR-0067, INT-004).
+ * The `paths`/`operations` types are generated from the API's OpenAPI document.
+ */
+export { UpVoiced, defaultBaseUrl, defaultMaxRetries, defaultMaxRetryDelayMs } from './client.js';
+export { UpVoicedError } from './errors.js';

package/dist/types.d.ts

@@ -0,0 +1,91 @@
+import type { paths } from './generated/schema.js';
+/**
+ * P2-015 (ADR-0067): compile-time view over the generated `paths` interface. Every name the
+ * client accepts (paths, path/query parameters, bodies, response data) comes from the API's
+ * OpenAPI document; nothing here is written per route.
+ */
+export type HttpMethod = 'get' | 'put' | 'post' | 'patch' | 'delete';
+/** Headers the client manages itself (credentials, workspace, idempotency). */
+export type ManagedHeader = 'authorization' | 'x-workspace' | 'idempotency-key';
+type Empty<T> = [T] extends [never] ? true : [T] extends [undefined] ? true : false;
+/** Paths that define `method`. */
+export type PathsWith<M extends HttpMethod> = {
+    [P in keyof paths]: Empty<paths[P][M]> extends true ? never : P;
+}[keyof paths];
+export type Operation<P extends keyof paths, M extends HttpMethod> = Exclude<paths[P][M], undefined>;
+type ParametersOf<O> = O extends {
+    parameters: infer X;
+} ? X : never;
+type ParameterIn<O, Where extends 'path' | 'query' | 'header'> = ParametersOf<O> extends Partial<Record<Where, infer V>> ? Exclude<V, undefined> : never;
+export type PathParams<O> = ParameterIn<O, 'path'>;
+export type QueryParams<O> = ParameterIn<O, 'query'>;
+type PathOption<O> = Empty<PathParams<O>> extends true ? unknown : {
+    path: PathParams<O>;
+};
+type QueryOption<O> = Empty<QueryParams<O>> extends true ? unknown : object extends QueryParams<O> ? {
+    query?: QueryParams<O>;
+} : {
+    query: QueryParams<O>;
+};
+type JsonContent<B> = B extends {
+    content: {
+        'application/json': infer J;
+    };
+} ? J : never;
+export type RequestBody<O> = O extends {
+    requestBody: infer B;
+} ? JsonContent<B> : O extends {
+    requestBody?: infer B;
+} ? JsonContent<Exclude<B, undefined>> : never;
+type BodyOption<O> = Empty<RequestBody<O>> extends true ? unknown : O extends {
+    requestBody: unknown;
+} ? {
+    body: RequestBody<O>;
+} : {
+    body?: RequestBody<O>;
+};
+/** Options every call accepts. */
+export interface CommonRequestOptions {
+    /** Overrides the client's `workspace` (X-Workspace) for this call. */
+    workspace?: string;
+    /**
+     * Idempotency-Key for this POST (the API replays the first response for 24 h). When omitted
+     * and retries are enabled, the client generates one so a retried POST cannot apply twice.
+     */
+    idempotencyKey?: string;
+    /** Extra headers; the managed ones (Authorization, X-Workspace, Idempotency-Key) win. */
+    headers?: Record<string, string>;
+    signal?: AbortSignal;
+}
+export type RequestOptions<O> = PathOption<O> & QueryOption<O> & BodyOption<O> & CommonRequestOptions;
+/** The options argument is required only when the operation has a required part. */
+export type RequestArgs<O> = object extends RequestOptions<O> ? [options?: RequestOptions<O>] : [options: RequestOptions<O>];
+type SuccessStatus = 200 | 201 | 202 | 203 | 204 | 205 | 206;
+type ResponsesOf<O> = O extends {
+    responses: infer R;
+} ? R : never;
+type ContentOf<R> = R extends {
+    content: infer C;
+} ? 'application/json' extends keyof C ? C['application/json'] : string : undefined;
+/** The parsed body of the operation's success response(s). */
+export type ResponseData<O> = {
+    [S in keyof ResponsesOf<O> & SuccessStatus]: ContentOf<ResponsesOf<O>[S]>;
+}[keyof ResponsesOf<O> & SuccessStatus];
+/** GET paths answering `{ items, next_cursor }` and accepting `?cursor=`. */
+export type PaginatedPath = {
+    [P in PathsWith<'get'>]: ResponseData<Operation<P, 'get'>> extends {
+        items: readonly unknown[];
+        next_cursor: string | null;
+    } ? QueryParams<Operation<P, 'get'>> extends {
+        cursor?: string;
+    } ? P : never : never;
+}[PathsWith<'get'>];
+export type PageItem<P extends PaginatedPath> = ResponseData<Operation<P, 'get'>> extends {
+    items: readonly (infer I)[];
+} ? I : never;
+export interface ApiResponse<T> {
+    data: T;
+    status: number;
+    headers: Headers;
+}
+export {};

package/dist/types.js

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

package/package.json

@@ -1,6 +1,41 @@
 {
   "name": "@upvoiced/sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Typed TypeScript client for the UpVoiced API, generated from its OpenAPI document.",
+  "license": "MIT",
+  "homepage": "https://docs.upvoiced.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jpereiramp/upvoiced.git",
+    "directory": "packages/sdk"
+  },
+  "keywords": [
+    "upvoiced",
+    "feedback",
+    "roadmap",
+    "changelog",
+    "openapi",
+    "sdk"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}