@nodaro/sdk 2.29.0 → 2.31.0

package/dist/entries/models.d.ts

@@ -0,0 +1,92 @@
+import { N as NodaroClientCore } from '../developer-apps-zSQXWmEG.js';
+import '@nodaro/shared/apps';
+import '@nodaro/shared/organizations';
+
+/**
+ * The company that made a model. `id` is stable — one id per company, the
+ * company's name lowercased and hyphenated (`"google"`, `"black-forest-labs"`)
+ * — so an app may key its own assets on it; a newer server can add makers, so
+ * handle an id you do not know. `name` is the company's display name.
+ */
+interface ModelMaker {
+    id: string;
+    name: string;
+}
+/**
+ * Model-catalog types. Mirrors the backend's `GET /v1/models` projection
+ * (itself shared with the MCP `list_models` tool) so the SDK stays
+ * dependency-free — same convention as `PickerCatalog` / `NodeDescriptor`.
+ */
+interface ModelSummary {
+    id: string;
+    label: string;
+    /** The company that made the model. Not the same as the family it is
+     *  grouped under: a few families name a lab or a product line (Tongyi-MAI
+     *  and HappyHorse are Alibaba's, Depth Anything is ByteDance's). Absent on
+     *  an older server. */
+    maker?: ModelMaker;
+    /** The maker's official mark (an SVG) on this deployment's media CDN, or
+     *  null when the deployment does not publish one for this maker — draw a
+     *  fallback (the maker's name or initial) then. The address carries its
+     *  file's version, so a replaced mark arrives under a new address. Absent
+     *  on an older server. */
+    logoUrl?: string | null;
+    description: string;
+    modes: string[];
+    useCases: string[];
+    /** Per-variant credit pricing: the credits a run of each variant is
+     *  charged, the figure on the node's Run button. Cloud only — editions
+     *  without a credit system (community/business) omit the field entirely. */
+    pricing?: Array<{
+        identifier: string;
+        credits: number;
+        note?: string;
+    }>;
+    featured?: boolean;
+    features?: string[];
+    aspectRatios?: string[];
+    resolutions?: string[];
+    qualities?: string[];
+    durations?: number[];
+    /** Compact per-model prompting tips (present when a doctrine exists). */
+    promptTips?: string[];
+    /** TRUE only when a sourced per-family prompt doctrine exists for this
+     *  model — gate "vendor doctrine · real rewrite" badges on this and show
+     *  a generic label otherwise (never overclaim). */
+    doctrineCovered: boolean;
+}
+interface ModelFamilyGroup {
+    family: string;
+    models: ModelSummary[];
+}
+interface ModelsListResult {
+    sections: Array<{
+        kind: "image" | "video" | "audio";
+        families: ModelFamilyGroup[];
+    }>;
+    recommendations: Array<{
+        id: string;
+        title: string;
+        modelIds: string[];
+        reason?: string;
+    } & Record<string, unknown>>;
+    totalModels: number;
+}
+interface ListModelsOptions {
+    kind?: "image" | "video" | "audio";
+    /** Operation filter, e.g. "t2v", "i2v", "t2i". */
+    mode?: string;
+    /** Vendor / lab name, e.g. "Google", "Bytedance". */
+    family?: string;
+    featuredOnly?: boolean;
+}
+declare class ModelsResource {
+    private client;
+    constructor(client: NodaroClientCore);
+    /** Browse the models available on this instance — capability sheets,
+     *  per-variant credit pricing, prompt tips, and the `doctrineCovered`
+     *  truth flag. Public endpoint; cached 5 minutes. */
+    list(opts?: ListModelsOptions): Promise<ModelsListResult>;
+}
+
+export { type ListModelsOptions, type ModelFamilyGroup, type ModelMaker, type ModelSummary, type ModelsListResult, ModelsResource };

package/dist/entries/models.js

@@ -0,0 +1,4 @@
+import '../chunk-OMH7ATOQ.js';
+export { ModelsResource } from '../chunk-Y6V6CBY5.js';
+//# sourceMappingURL=models.js.map
+//# sourceMappingURL=models.js.map

package/dist/entries/models.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"models.js"}

package/dist/entries/moodboards.cjs

@@ -0,0 +1,21 @@
+'use strict';
+
+require('../chunk-ZKBHD27K.cjs');
+var chunkZCWKX4V6_cjs = require('../chunk-ZCWKX4V6.cjs');
+
+
+
+Object.defineProperty(exports, "MOODBOARD_DIRECTION_PREFIX", {
+  enumerable: true,
+  get: function () { return chunkZCWKX4V6_cjs.MOODBOARD_DIRECTION_PREFIX; }
+});
+Object.defineProperty(exports, "MoodboardsResource", {
+  enumerable: true,
+  get: function () { return chunkZCWKX4V6_cjs.MoodboardsResource; }
+});
+Object.defineProperty(exports, "moodboardDirectionId", {
+  enumerable: true,
+  get: function () { return chunkZCWKX4V6_cjs.moodboardDirectionId; }
+});
+//# sourceMappingURL=moodboards.cjs.map
+//# sourceMappingURL=moodboards.cjs.map

package/dist/entries/moodboards.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"moodboards.cjs"}

package/dist/entries/moodboards.d.cts

@@ -0,0 +1,77 @@
+import { N as NodaroClientCore } from '../developer-apps-zSQXWmEG.cjs';
+import '@nodaro/shared/apps';
+import '@nodaro/shared/organizations';
+
+/** One image of a moodboard — a link, never a copy. */
+interface MoodboardImage {
+    /** An http(s) image link (no localhost or private address), up to 2048 characters. */
+    url: string;
+    /** Up to 200 characters; it goes along with the image as a style reference. */
+    caption?: string;
+}
+/** One of your moodboards. */
+interface Moodboard {
+    id: string;
+    name: string;
+    /** The words a run puts into the prompt as the moodboard's look. */
+    description: string | null;
+    /** 1–12 images, in order. */
+    images: MoodboardImage[];
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateMoodboardInput {
+    /** 1–80 characters. */
+    name: string;
+    /** Up to 1000 characters. */
+    description?: string | null;
+    /** 1–12 images. */
+    images: MoodboardImage[];
+}
+/** Only the fields you send are written; `images` replaces them all; `description: null` clears it. */
+interface UpdateMoodboardInput {
+    name?: string;
+    description?: string | null;
+    images?: MoodboardImage[];
+}
+interface ListMoodboardsParams {
+    /** Page size, 1–100 (server default 50). */
+    limit?: number;
+    /** The previous page's `nextCursor`. */
+    cursor?: string;
+}
+interface MoodboardPage {
+    data: Moodboard[];
+    /** Pass back as `cursor` for the next page; `null` on the last one. */
+    nextCursor: string | null;
+}
+/** The prefix of a moodboard's generate-image direction id (`direction.style`). */
+declare const MOODBOARD_DIRECTION_PREFIX: "moodboard:";
+/**
+ * A moodboard as a generate-image direction value — put it on
+ * `direction.style`. The run puts its description into the prompt and sends
+ * its images as style references after your own references, up to the
+ * model's reference limit (the answer's `warnings` says when some did not
+ * fit). The job keeps the id.
+ */
+declare function moodboardDirectionId(id: string): `moodboard:${string}`;
+/**
+ * Moodboards — `GET/POST /v1/moodboards`, `GET/PATCH/DELETE /v1/moodboards/:id`.
+ *
+ * Yours only (another person's id answers 404). Use one on generate-image as
+ * `direction: { style: moodboardDirectionId(id) }`. OAuth app tokens need
+ * `assets:read` for reads and `assets:write` for writes.
+ */
+declare class MoodboardsResource {
+    private client;
+    constructor(client: NodaroClientCore);
+    /** Your moodboards, newest first. Page with `nextCursor`. */
+    list(params?: ListMoodboardsParams): Promise<MoodboardPage>;
+    get(id: string): Promise<Moodboard>;
+    create(input: CreateMoodboardInput): Promise<Moodboard>;
+    update(id: string, input: UpdateMoodboardInput): Promise<Moodboard>;
+    /** Deletes the moodboard only; the images it links to are untouched. */
+    delete(id: string): Promise<void>;
+}
+
+export { type CreateMoodboardInput, type ListMoodboardsParams, MOODBOARD_DIRECTION_PREFIX, type Moodboard, type MoodboardImage, type MoodboardPage, MoodboardsResource, type UpdateMoodboardInput, moodboardDirectionId };

package/dist/entries/moodboards.d.ts

@@ -0,0 +1,77 @@
+import { N as NodaroClientCore } from '../developer-apps-zSQXWmEG.js';
+import '@nodaro/shared/apps';
+import '@nodaro/shared/organizations';
+
+/** One image of a moodboard — a link, never a copy. */
+interface MoodboardImage {
+    /** An http(s) image link (no localhost or private address), up to 2048 characters. */
+    url: string;
+    /** Up to 200 characters; it goes along with the image as a style reference. */
+    caption?: string;
+}
+/** One of your moodboards. */
+interface Moodboard {
+    id: string;
+    name: string;
+    /** The words a run puts into the prompt as the moodboard's look. */
+    description: string | null;
+    /** 1–12 images, in order. */
+    images: MoodboardImage[];
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateMoodboardInput {
+    /** 1–80 characters. */
+    name: string;
+    /** Up to 1000 characters. */
+    description?: string | null;
+    /** 1–12 images. */
+    images: MoodboardImage[];
+}
+/** Only the fields you send are written; `images` replaces them all; `description: null` clears it. */
+interface UpdateMoodboardInput {
+    name?: string;
+    description?: string | null;
+    images?: MoodboardImage[];
+}
+interface ListMoodboardsParams {
+    /** Page size, 1–100 (server default 50). */
+    limit?: number;
+    /** The previous page's `nextCursor`. */
+    cursor?: string;
+}
+interface MoodboardPage {
+    data: Moodboard[];
+    /** Pass back as `cursor` for the next page; `null` on the last one. */
+    nextCursor: string | null;
+}
+/** The prefix of a moodboard's generate-image direction id (`direction.style`). */
+declare const MOODBOARD_DIRECTION_PREFIX: "moodboard:";
+/**
+ * A moodboard as a generate-image direction value — put it on
+ * `direction.style`. The run puts its description into the prompt and sends
+ * its images as style references after your own references, up to the
+ * model's reference limit (the answer's `warnings` says when some did not
+ * fit). The job keeps the id.
+ */
+declare function moodboardDirectionId(id: string): `moodboard:${string}`;
+/**
+ * Moodboards — `GET/POST /v1/moodboards`, `GET/PATCH/DELETE /v1/moodboards/:id`.
+ *
+ * Yours only (another person's id answers 404). Use one on generate-image as
+ * `direction: { style: moodboardDirectionId(id) }`. OAuth app tokens need
+ * `assets:read` for reads and `assets:write` for writes.
+ */
+declare class MoodboardsResource {
+    private client;
+    constructor(client: NodaroClientCore);
+    /** Your moodboards, newest first. Page with `nextCursor`. */
+    list(params?: ListMoodboardsParams): Promise<MoodboardPage>;
+    get(id: string): Promise<Moodboard>;
+    create(input: CreateMoodboardInput): Promise<Moodboard>;
+    update(id: string, input: UpdateMoodboardInput): Promise<Moodboard>;
+    /** Deletes the moodboard only; the images it links to are untouched. */
+    delete(id: string): Promise<void>;
+}
+
+export { type CreateMoodboardInput, type ListMoodboardsParams, MOODBOARD_DIRECTION_PREFIX, type Moodboard, type MoodboardImage, type MoodboardPage, MoodboardsResource, type UpdateMoodboardInput, moodboardDirectionId };

package/dist/entries/moodboards.js

@@ -0,0 +1,4 @@
+import '../chunk-37Y5QAVA.js';
+export { MOODBOARD_DIRECTION_PREFIX, MoodboardsResource, moodboardDirectionId } from '../chunk-YVU2M7MI.js';
+//# sourceMappingURL=moodboards.js.map
+//# sourceMappingURL=moodboards.js.map

package/dist/entries/moodboards.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"moodboards.js"}

package/dist/entries/node-presets.cjs

@@ -0,0 +1,13 @@
+'use strict';
+
+require('../chunk-RA42NMWV.cjs');
+var chunk34PU2DAT_cjs = require('../chunk-34PU2DAT.cjs');
+
+
+
+Object.defineProperty(exports, "PresetsResource", {
+  enumerable: true,
+  get: function () { return chunk34PU2DAT_cjs.PresetsResource; }
+});
+//# sourceMappingURL=node-presets.cjs.map
+//# sourceMappingURL=node-presets.cjs.map

package/dist/entries/node-presets.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"node-presets.cjs"}

package/dist/entries/node-presets.d.cts

@@ -0,0 +1,217 @@
+import { N as NodaroClientCore } from '../developer-apps-zSQXWmEG.cjs';
+import { FactoryPreset } from '@nodaro/prompts/presets';
+import '@nodaro/shared/apps';
+import '@nodaro/shared/organizations';
+
+/**
+ * A user's saved custom preset (`GET /v1/node-presets`). Mirrors the backend's
+ * camelCase row shape. `data` is captured node config — merge it into a node's
+ * data when building/running a workflow to "apply" the preset.
+ */
+interface NodePreset {
+    id: string;
+    nodeType: string;
+    name: string;
+    description?: string;
+    data: Record<string, unknown>;
+    groupId?: string;
+    tags: string[];
+    sortOrder: number;
+    /**
+     * How many connected reference images the preset works from (0 = none),
+     * counted from the `{image:N}` tokens in its prompt. Absent from servers that
+     * predate it.
+     */
+    minReferences?: number;
+    /** `minReferences > 0` — the preset works from a connected photo. */
+    needsImage?: boolean;
+    /** The example picture stored with the preset, or null. */
+    previewUrl?: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/** A user's preset folder/section (`GET /v1/node-preset-groups`). */
+interface NodePresetGroup {
+    id: string;
+    nodeType: string;
+    name: string;
+    kind: "folder" | "section";
+    sortOrder: number;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * One built-in preset as `GET /v1/node-presets/factory` serves it: the
+ * catalog entry plus what a client needs to present it.
+ */
+interface FactoryPresetEntry extends FactoryPreset {
+    /**
+     * How many connected reference images the preset works from (0 = none):
+     * Reference Sheet, Portrait Transformations, Edits and every template using
+     * `{image:N}` need at least one. Absent from servers that predate it.
+     */
+    minReferences?: number;
+    /** `minReferences > 0` — the preset works from a connected photo. */
+    needsImage?: boolean;
+    /**
+     * An example picture of what the preset makes — an absolute URL on the
+     * server you asked — or null while the preset has none.
+     */
+    previewUrl?: string | null;
+}
+/**
+ * Result of `GET /v1/node-presets/factory` — the built-in (factory) catalog for
+ * a node type.
+ */
+interface FactoryPresetsResult {
+    data: FactoryPresetEntry[];
+}
+/** `POST /v1/node-presets` body. */
+interface CreateNodePresetInput {
+    /** The node type the preset configures, e.g. `"generate-image"`. */
+    nodeType: string;
+    /** Unique per node type (case-insensitive); a duplicate answers 409 `name_taken`. */
+    name: string;
+    description?: string;
+    /** Node config (≤ 64 KB). Runtime keys (results, job ids, labels) are stripped. */
+    data: Record<string, unknown>;
+    /** One of your preset groups, or null for none. */
+    groupId?: string | null;
+    tags?: string[];
+    sortOrder?: number;
+    /**
+     * An example picture: an image stored on this platform (an upload or a
+     * generated result) that already exists. Anything else answers 400.
+     */
+    previewUrl?: string | null;
+}
+/** `PATCH /v1/node-presets/:id` body — every field optional; `previewUrl: null` removes the picture. */
+type UpdateNodePresetInput = Partial<Omit<CreateNodePresetInput, "nodeType">>;
+/** One entry of `POST /v1/node-presets/import` (the `presets export` envelope's entries fit). */
+interface ImportNodePresetInput {
+    nodeType: string;
+    name: string;
+    description?: string;
+    data: Record<string, unknown>;
+    previewUrl?: string | null;
+}
+/** `POST /v1/node-presets/reorder` body. */
+interface ReorderNodePresetsInput {
+    groups?: Array<{
+        id: string;
+        sortOrder: number;
+    }>;
+    /** `groupId` moves the preset into one of your groups (null = out of any group). */
+    presets?: Array<{
+        id: string;
+        groupId?: string | null;
+        sortOrder: number;
+    }>;
+}
+/** A favorite: a factory preset id (`"generate-image/character-board"`) or one of your preset ids. */
+interface NodePresetFavoriteInput {
+    nodeType: string;
+    presetId: string;
+}
+/** `POST /v1/node-preset-groups` body. */
+interface CreateNodePresetGroupInput {
+    nodeType: string;
+    name: string;
+    /** A collapsible `"folder"` (default) or a flat `"section"` header. */
+    kind?: "folder" | "section";
+    sortOrder?: number;
+}
+/** `PATCH /v1/node-preset-groups/:id` body. */
+interface UpdateNodePresetGroupInput {
+    name?: string;
+    sortOrder?: number;
+}
+/**
+ * Node presets — reusable, named node configurations: your own presets and
+ * folders, your favorites, and the built-in factory catalog.
+ *
+ * To *use* a preset, take its `data` and merge it into a node's config when you
+ * create/update a workflow. `needsImage` / `minReferences` say how many photos
+ * it works from; `previewUrl` is an example picture (null when there is none).
+ *
+ * The factory catalog (`listFactory`) is public: no token needed. Reads of
+ * your own library need the `presets:read` scope for an OAuth app token;
+ * writes (create, update, delete, import, reorder, favorites, groups) need
+ * `assets:write`. Your own API key needs neither — but a key limited to some
+ * workflows cannot reach your own presets (it reads the factory catalog as
+ * anyone can).
+ */
+declare class PresetsResource {
+    private client;
+    constructor(client: NodaroClientCore);
+    /**
+     * `GET /v1/node-presets` → your custom presets, newest first. Pass `nodeType`
+     * (e.g. `"generate-image"`) to filter to one node type.
+     */
+    list(nodeType?: string): Promise<NodePreset[]>;
+    /**
+     * `GET /v1/node-preset-groups` → your preset folders/sections, in display
+     * order. Pass `nodeType` to filter to one node type.
+     */
+    listGroups(nodeType?: string): Promise<NodePresetGroup[]>;
+    /**
+     * `GET /v1/node-presets/factory` → the built-in catalog for `nodeType`. These
+     * ship with the app (no account needed to exist), so they're a good starting
+     * point for "what configs are available".
+     *
+     * Login is optional: the catalog is public, so this works on a client with
+     * no credential at all (`auth: { getToken: async () => null }`) — show the
+     * names, example pictures (`previewUrl`) and photo counts (`minReferences`,
+     * `needsImage`) to a visitor who is not signed in, and ask for a login only
+     * when they generate. Your OWN presets (`list()`) still need a token.
+     */
+    listFactory(nodeType: string): Promise<FactoryPresetsResult>;
+    /** `POST /v1/node-presets` → the new preset. */
+    create(input: CreateNodePresetInput): Promise<NodePreset>;
+    /**
+     * `PATCH /v1/node-presets/:id` → the updated preset. Pass the `updatedAt` you
+     * read as `expectedUpdatedAt` to refuse (409 `conflict`) a change made
+     * elsewhere since.
+     */
+    update(id: string, patch: UpdateNodePresetInput, opts?: {
+        expectedUpdatedAt?: string;
+    }): Promise<NodePreset>;
+    /** `DELETE /v1/node-presets/:id` (404 when it is not yours). `expectedUpdatedAt` as on `update`. */
+    delete(id: string, opts?: {
+        expectedUpdatedAt?: string;
+    }): Promise<{
+        success: true;
+    }>;
+    /**
+     * `POST /v1/node-presets/import` — up to 500 presets in one call. A name you
+     * already use gets an "(imported N)" suffix; a preset whose data is empty
+     * after stripping runtime keys is skipped.
+     */
+    import(presets: ImportNodePresetInput[]): Promise<{
+        imported: number;
+    }>;
+    /** `POST /v1/node-presets/reorder` — positions (and group membership) for many presets and groups at once. */
+    reorder(input: ReorderNodePresetsInput): Promise<{
+        ok: true;
+    }>;
+    /** `GET /v1/node-presets/favorites` → your favorite preset ids for `nodeType`, newest first. */
+    favorites(nodeType: string): Promise<string[]>;
+    /** `POST /v1/node-presets/favorites` — idempotent. */
+    addFavorite(input: NodePresetFavoriteInput): Promise<{
+        success: true;
+    }>;
+    /** `DELETE /v1/node-presets/favorites` — idempotent. */
+    removeFavorite(input: NodePresetFavoriteInput): Promise<{
+        success: true;
+    }>;
+    /** `POST /v1/node-preset-groups` → the new folder or section. */
+    createGroup(input: CreateNodePresetGroupInput): Promise<NodePresetGroup>;
+    /** `PATCH /v1/node-preset-groups/:id` → the renamed or moved group. */
+    updateGroup(id: string, patch: UpdateNodePresetGroupInput): Promise<NodePresetGroup>;
+    /** `DELETE /v1/node-preset-groups/:id` — its presets move out of the group; none are deleted. */
+    deleteGroup(id: string): Promise<{
+        success: true;
+    }>;
+}
+
+export { type CreateNodePresetGroupInput, type CreateNodePresetInput, type FactoryPresetEntry, type FactoryPresetsResult, type ImportNodePresetInput, type NodePreset, type NodePresetFavoriteInput, type NodePresetGroup, PresetsResource, type ReorderNodePresetsInput, type UpdateNodePresetGroupInput, type UpdateNodePresetInput };