@spicyapi/sdk 0.1.0

package/dist/src/docs/index.d.ts

@@ -0,0 +1,10 @@
+export interface DocumentationEntry {
+    slug: string;
+    title: string;
+    summary: string;
+    url: string;
+    keywords: string[];
+}
+export declare const DOCUMENTATION: DocumentationEntry[];
+export declare function searchDocumentation(query?: string, limit?: number): DocumentationEntry[];
+//# sourceMappingURL=index.d.ts.map

package/dist/src/docs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/docs/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AA8GD,eAAO,MAAM,aAAa,EAAE,kBAAkB,EAG3C,CAAC;AA6CJ,wBAAgB,mBAAmB,CAAC,KAAK,SAAK,EAAE,KAAK,SAAK,GAAG,kBAAkB,EAAE,CAoChF"}

package/dist/src/docs/index.js

@@ -0,0 +1,181 @@
+const DOCS_BASE_URL = "https://spicyapi.ai/en/docs";
+const definitions = [
+    {
+        slug: "",
+        title: "Quickstart",
+        summary: "Create a task, follow its state, and retrieve generated media.",
+        keywords: ["start", "guide", "quickstart", "入门", "开始"],
+    },
+    {
+        slug: "authentication",
+        title: "Authentication",
+        summary: "API keys, per-key controls, rotation, and incident response.",
+        keywords: ["api key", "bearer", "security", "认证", "密钥"],
+    },
+    {
+        slug: "models",
+        title: "Models and parameters",
+        summary: "Live model IDs, account-specific pricing, input schemas, and examples.",
+        keywords: ["catalog", "schema", "price", "model", "模型", "价格", "参数"],
+    },
+    {
+        slug: "tasks",
+        title: "Asynchronous tasks",
+        summary: "Create tasks, inspect task records, states, costs, and outputs.",
+        keywords: ["createTask", "recordInfo", "poll", "state", "任务", "轮询"],
+    },
+    {
+        slug: "task-actions",
+        title: "Task actions",
+        summary: "Retry failed or expired tasks safely and understand unsupported actions.",
+        keywords: ["retry", "cancel", "重试", "取消"],
+    },
+    {
+        slug: "media",
+        title: "Media transfer",
+        summary: "Direct uploads, spicy:// references, commits, and signed output downloads.",
+        keywords: ["upload", "download", "file", "image", "上传", "下载", "文件"],
+    },
+    {
+        slug: "billing",
+        title: "Billing",
+        summary: "Prices, holds, settlement, failures, refunds, and balance fields.",
+        keywords: ["cost", "credit", "balance", "payment", "billing", "余额", "付费", "计费"],
+    },
+    {
+        slug: "idempotency",
+        title: "Idempotency",
+        summary: "Retry one logical generation without duplicate work or duplicate holds.",
+        keywords: ["idempotency-key", "retry", "duplicate", "幂等", "重复"],
+    },
+    {
+        slug: "webhooks",
+        title: "Webhooks",
+        summary: "Payload versions, raw-body signatures, delivery IDs, and retries.",
+        keywords: ["callback", "hmac", "signature", "webhook", "回调", "签名"],
+    },
+    {
+        slug: "errors",
+        title: "Errors",
+        summary: "HTTP statuses, business codes, correlation IDs, and retry decisions.",
+        keywords: [
+            "code",
+            "request_id",
+            "429",
+            "503",
+            "unavailable",
+            "service unavailable",
+            "no route",
+            "customer price",
+            "错误",
+            "不可用",
+            "重试",
+        ],
+    },
+    {
+        slug: "limits",
+        title: "Rate limits",
+        summary: "Shared account rate limits and recommended backoff behavior.",
+        keywords: ["rate", "quota", "retry-after", "限流", "配额"],
+    },
+    {
+        slug: "retention",
+        title: "Data retention",
+        summary: "Task input, output, media, and operational-record retention boundaries.",
+        keywords: ["privacy", "delete", "storage", "retention", "隐私", "删除", "保留"],
+    },
+    {
+        slug: "policy",
+        title: "Content policy",
+        summary: "Transparent mature-flag forwarding, model-service behavior, and caller responsibility.",
+        keywords: ["mature", "forward", "pass through", "content", "policy", "透明传递", "内容"],
+    },
+    {
+        slug: "agents",
+        title: "Agent integrations",
+        summary: "Safe patterns for AI agents using the public API contract.",
+        keywords: ["agent", "mcp", "tool", "智能体", "代理"],
+    },
+    {
+        slug: "api-reference",
+        title: "API reference",
+        summary: "The complete public endpoint and envelope reference.",
+        keywords: ["openapi", "endpoint", "reference", "接口", "参考"],
+    },
+];
+export const DOCUMENTATION = definitions.map((entry) => ({
+    ...entry,
+    url: entry.slug ? `${DOCS_BASE_URL}/${entry.slug}` : DOCS_BASE_URL,
+}));
+const SEARCH_STOP_WORDS = new Set([
+    "a",
+    "about",
+    "across",
+    "after",
+    "an",
+    "and",
+    "are",
+    "as",
+    "at",
+    "before",
+    "by",
+    "for",
+    "from",
+    "how",
+    "in",
+    "into",
+    "is",
+    "it",
+    "of",
+    "on",
+    "or",
+    "the",
+    "to",
+    "using",
+    "what",
+    "when",
+    "where",
+    "which",
+    "who",
+    "why",
+    "with",
+    "without",
+]);
+function normalizeSearchText(value) {
+    return value
+        .normalize("NFKC")
+        .toLowerCase()
+        .replace(/[^\p{L}\p{N}]+/gu, " ")
+        .trim();
+}
+export function searchDocumentation(query = "", limit = 10) {
+    if (!Number.isInteger(limit) || limit < 1 || limit > 25) {
+        throw new TypeError("limit must be an integer between 1 and 25");
+    }
+    const normalizedQuery = normalizeSearchText(query);
+    const allTerms = normalizedQuery.split(/\s+/).filter(Boolean);
+    const meaningfulTerms = allTerms.filter((term) => !SEARCH_STOP_WORDS.has(term));
+    const terms = meaningfulTerms.length > 0 ? meaningfulTerms : allTerms;
+    if (terms.length === 0)
+        return DOCUMENTATION.slice(0, limit);
+    return DOCUMENTATION.map((entry, index) => {
+        const title = normalizeSearchText(entry.title);
+        const slug = normalizeSearchText(entry.slug);
+        const summary = normalizeSearchText(entry.summary);
+        const keywords = normalizeSearchText(entry.keywords.join(" "));
+        const haystack = `${title} ${slug} ${summary} ${keywords}`;
+        const matched = terms.filter((term) => haystack.includes(term));
+        const score = matched.reduce((total, term) => total +
+            (title.includes(term) ? 8 : 0) +
+            (slug.includes(term) ? 6 : 0) +
+            (keywords.includes(term) ? 4 : 0) +
+            (summary.includes(term) ? 2 : 0) +
+            1, haystack.includes(normalizedQuery) ? 20 : 0);
+        return { entry, index, matched: matched.length, score };
+    })
+        .filter((candidate) => candidate.matched > 0)
+        .sort((left, right) => right.matched - left.matched || right.score - left.score || left.index - right.index)
+        .slice(0, limit)
+        .map((candidate) => candidate.entry);
+}
+//# sourceMappingURL=index.js.map

package/dist/src/docs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/docs/index.ts"],"names":[],"mappings":"AAQA,MAAM,aAAa,GAAG,6BAA6B,CAAC;AAEpD,MAAM,WAAW,GAA2C;IAC1D;QACE,IAAI,EAAE,EAAE;QACR,KAAK,EAAE,YAAY;QACnB,OAAO,EAAE,gEAAgE;QACzE,QAAQ,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,CAAC;KACvD;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,KAAK,EAAE,gBAAgB;QACvB,OAAO,EAAE,8DAA8D;QACvE,QAAQ,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC;KACxD;IACD;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,uBAAuB;QAC9B,OAAO,EAAE,wEAAwE;QACjF,QAAQ,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC;KACpE;IACD;QACE,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,oBAAoB;QAC3B,OAAO,EAAE,iEAAiE;QAC1E,QAAQ,EAAE,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC;KACpE;IACD;QACE,IAAI,EAAE,cAAc;QACpB,KAAK,EAAE,cAAc;QACrB,OAAO,EAAE,0EAA0E;QACnF,QAAQ,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC;KAC1C;IACD;QACE,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,gBAAgB;QACvB,OAAO,EAAE,4EAA4E;QACrF,QAAQ,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC;KACpE;IACD;QACE,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,SAAS;QAChB,OAAO,EAAE,mEAAmE;QAC5E,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC;KAChF;IACD;QACE,IAAI,EAAE,aAAa;QACnB,KAAK,EAAE,aAAa;QACpB,OAAO,EAAE,yEAAyE;QAClF,QAAQ,EAAE,CAAC,iBAAiB,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,CAAC;KAChE;IACD;QACE,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,UAAU;QACjB,OAAO,EAAE,mEAAmE;QAC5E,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC;KACnE;IACD;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,QAAQ;QACf,OAAO,EAAE,sEAAsE;QAC/E,QAAQ,EAAE;YACR,MAAM;YACN,YAAY;YACZ,KAAK;YACL,KAAK;YACL,aAAa;YACb,qBAAqB;YACrB,UAAU;YACV,gBAAgB;YAChB,IAAI;YACJ,KAAK;YACL,IAAI;SACL;KACF;IACD;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,aAAa;QACpB,OAAO,EAAE,8DAA8D;QACvE,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC;KACvD;IACD;QACE,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,gBAAgB;QACvB,OAAO,EAAE,yEAAyE;QAClF,QAAQ,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC;KAC1E;IACD;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,gBAAgB;QACvB,OAAO,EACL,wFAAwF;QAC1F,QAAQ,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,cAAc,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC;KACnF;IACD;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,oBAAoB;QAC3B,OAAO,EAAE,4DAA4D;QACrE,QAAQ,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC;KAChD;IACD;QACE,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,eAAe;QACtB,OAAO,EAAE,sDAAsD;QAC/D,QAAQ,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,CAAC;KAC3D;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAyB,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC7E,GAAG,KAAK;IACR,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,aAAa,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,aAAa;CACnE,CAAC,CAAC,CAAC;AAEJ,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC;IAChC,GAAG;IACH,OAAO;IACP,QAAQ;IACR,OAAO;IACP,IAAI;IACJ,KAAK;IACL,KAAK;IACL,IAAI;IACJ,IAAI;IACJ,QAAQ;IACR,IAAI;IACJ,KAAK;IACL,MAAM;IACN,KAAK;IACL,IAAI;IACJ,MAAM;IACN,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,OAAO;IACP,MAAM;IACN,MAAM;IACN,OAAO;IACP,OAAO;IACP,KAAK;IACL,KAAK;IACL,MAAM;IACN,SAAS;CACV,CAAC,CAAC;AAEH,SAAS,mBAAmB,CAAC,KAAa;IACxC,OAAO,KAAK;SACT,SAAS,CAAC,MAAM,CAAC;SACjB,WAAW,EAAE;SACb,OAAO,CAAC,kBAAkB,EAAE,GAAG,CAAC;SAChC,IAAI,EAAE,CAAC;AACZ,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,KAAK,GAAG,EAAE,EAAE,KAAK,GAAG,EAAE;IACxD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,EAAE,EAAE,CAAC;QACxD,MAAM,IAAI,SAAS,CAAC,2CAA2C,CAAC,CAAC;IACnE,CAAC;IACD,MAAM,eAAe,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACnD,MAAM,QAAQ,GAAG,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9D,MAAM,eAAe,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IAChF,MAAM,KAAK,GAAG,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC;IACtE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAE7D,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACxC,MAAM,KAAK,GAAG,mBAAmB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,IAAI,GAAG,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7C,MAAM,OAAO,GAAG,mBAAmB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACnD,MAAM,QAAQ,GAAG,mBAAmB,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/D,MAAM,QAAQ,GAAG,GAAG,KAAK,IAAI,IAAI,IAAI,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC3D,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QAChE,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAC1B,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CACd,KAAK;YACL,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9B,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7B,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACjC,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAChC,CAAC,EACH,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAC5C,CAAC;QACF,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;IAC1D,CAAC,CAAC;SACC,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,GAAG,CAAC,CAAC;SAC5C,IAAI,CACH,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CACd,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CACvF;SACA,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC;SACf,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AACzC,CAAC"}