@blitzreels/sdk 0.2.23 → 0.2.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (104) hide show
  1. package/README.md +109 -0
  2. package/dist/client.d.ts +24 -1
  3. package/dist/client.d.ts.map +1 -1
  4. package/dist/client.js +27 -0
  5. package/dist/client.js.map +1 -1
  6. package/dist/index.d.ts +15 -3
  7. package/dist/index.d.ts.map +1 -1
  8. package/dist/index.js +8 -1
  9. package/dist/index.js.map +1 -1
  10. package/dist/resources/auth-projects.d.ts +14 -0
  11. package/dist/resources/auth-projects.d.ts.map +1 -1
  12. package/dist/resources/auth-projects.js +18 -1
  13. package/dist/resources/auth-projects.js.map +1 -1
  14. package/dist/resources/carousels.d.ts +12 -4
  15. package/dist/resources/carousels.d.ts.map +1 -1
  16. package/dist/resources/carousels.js +6 -0
  17. package/dist/resources/carousels.js.map +1 -1
  18. package/dist/resources/characters.d.ts +16 -0
  19. package/dist/resources/characters.d.ts.map +1 -1
  20. package/dist/resources/characters.js +17 -0
  21. package/dist/resources/characters.js.map +1 -1
  22. package/dist/resources/content-batches.d.ts +176 -0
  23. package/dist/resources/content-batches.d.ts.map +1 -0
  24. package/dist/resources/content-batches.js +49 -0
  25. package/dist/resources/content-batches.js.map +1 -0
  26. package/dist/resources/content-review.d.ts +178 -0
  27. package/dist/resources/content-review.d.ts.map +1 -0
  28. package/dist/resources/content-review.js +21 -0
  29. package/dist/resources/content-review.js.map +1 -0
  30. package/dist/resources/creative-learning.d.ts +17 -0
  31. package/dist/resources/creative-learning.d.ts.map +1 -0
  32. package/dist/resources/creative-learning.js +34 -0
  33. package/dist/resources/creative-learning.js.map +1 -0
  34. package/dist/resources/creative-map.d.ts +19 -0
  35. package/dist/resources/creative-map.d.ts.map +1 -0
  36. package/dist/resources/creative-map.js +40 -0
  37. package/dist/resources/creative-map.js.map +1 -0
  38. package/dist/resources/creative-source.d.ts +555 -0
  39. package/dist/resources/creative-source.d.ts.map +1 -0
  40. package/dist/resources/creative-source.js +106 -0
  41. package/dist/resources/creative-source.js.map +1 -0
  42. package/dist/resources/customer-outcomes.d.ts +15 -0
  43. package/dist/resources/customer-outcomes.d.ts.map +1 -0
  44. package/dist/resources/customer-outcomes.js +26 -0
  45. package/dist/resources/customer-outcomes.js.map +1 -0
  46. package/dist/resources/editor.d.ts +16 -0
  47. package/dist/resources/editor.d.ts.map +1 -1
  48. package/dist/resources/exports-jobs.d.ts +17 -0
  49. package/dist/resources/exports-jobs.d.ts.map +1 -1
  50. package/dist/resources/exports-jobs.js +15 -0
  51. package/dist/resources/exports-jobs.js.map +1 -1
  52. package/dist/resources/generation.d.ts +13 -1
  53. package/dist/resources/generation.d.ts.map +1 -1
  54. package/dist/resources/generation.js +69 -1
  55. package/dist/resources/generation.js.map +1 -1
  56. package/dist/resources/hosted-drafts.d.ts +19 -0
  57. package/dist/resources/hosted-drafts.d.ts.map +1 -0
  58. package/dist/resources/hosted-drafts.js +41 -0
  59. package/dist/resources/hosted-drafts.js.map +1 -0
  60. package/dist/resources/knowledge-research.d.ts +491 -0
  61. package/dist/resources/knowledge-research.d.ts.map +1 -0
  62. package/dist/resources/knowledge-research.js +50 -0
  63. package/dist/resources/knowledge-research.js.map +1 -0
  64. package/dist/resources/knowledge.d.ts +736 -0
  65. package/dist/resources/knowledge.d.ts.map +1 -0
  66. package/dist/resources/knowledge.js +56 -0
  67. package/dist/resources/knowledge.js.map +1 -0
  68. package/dist/resources/media-clips.d.ts +277 -0
  69. package/dist/resources/media-clips.d.ts.map +1 -1
  70. package/dist/resources/media-clips.js +13 -1
  71. package/dist/resources/media-clips.js.map +1 -1
  72. package/dist/resources/publishing.d.ts +10 -1
  73. package/dist/resources/publishing.d.ts.map +1 -1
  74. package/dist/resources/publishing.js +20 -1
  75. package/dist/resources/publishing.js.map +1 -1
  76. package/dist/resources/recipes.d.ts +593 -0
  77. package/dist/resources/recipes.d.ts.map +1 -0
  78. package/dist/resources/recipes.js +60 -0
  79. package/dist/resources/recipes.js.map +1 -0
  80. package/dist/resources/series.d.ts +9 -1
  81. package/dist/resources/series.d.ts.map +1 -1
  82. package/dist/resources/series.js +59 -1
  83. package/dist/resources/series.js.map +1 -1
  84. package/dist/resources/voices.d.ts +21 -0
  85. package/dist/resources/voices.d.ts.map +1 -0
  86. package/dist/resources/voices.js +38 -0
  87. package/dist/resources/voices.js.map +1 -0
  88. package/dist/resources/web-capture.d.ts +239 -0
  89. package/dist/resources/web-capture.d.ts.map +1 -0
  90. package/dist/resources/web-capture.js +50 -0
  91. package/dist/resources/web-capture.js.map +1 -0
  92. package/dist/types/exports.d.ts +4 -0
  93. package/dist/types/exports.d.ts.map +1 -1
  94. package/dist/types/generation.d.ts +45 -1
  95. package/dist/types/generation.d.ts.map +1 -1
  96. package/dist/types/media.d.ts +4 -0
  97. package/dist/types/media.d.ts.map +1 -1
  98. package/dist/types/projects.d.ts +2 -0
  99. package/dist/types/projects.d.ts.map +1 -1
  100. package/dist/types/voices.d.ts +28 -0
  101. package/dist/types/voices.d.ts.map +1 -0
  102. package/dist/types/voices.js +2 -0
  103. package/dist/types/voices.js.map +1 -0
  104. package/package.json +2 -2
@@ -0,0 +1,736 @@
1
+ import { type KnowledgeApply } from "@blitzreels/contracts";
2
+ import type { SdkRequest } from "../transport.js";
3
+ export declare function knowledgeApplyRequest(input: KnowledgeApply): {
4
+ method: "PUT";
5
+ path: string;
6
+ body: {
7
+ path: string;
8
+ title: string;
9
+ kind: "brief" | "correction" | "reference" | "research";
10
+ markdown: string;
11
+ expectedRevision: number;
12
+ sources: {
13
+ url: string;
14
+ title: string;
15
+ }[];
16
+ changeRequest?: string | undefined;
17
+ };
18
+ };
19
+ export declare function createKnowledgeResource({ request }: {
20
+ request: SdkRequest;
21
+ }): {
22
+ research: {
23
+ list: (input: import("@blitzreels/contracts").KnowledgeResearchListInput) => Promise<{
24
+ jobs: {
25
+ id: string;
26
+ status: "cancelled" | "complete" | "failed" | "partial" | "queued" | "running";
27
+ request: {
28
+ prompt: string;
29
+ productUrl: string | null;
30
+ seriesId: string | null;
31
+ language: string;
32
+ maxSources: number;
33
+ maxCredits: number;
34
+ social?: {
35
+ platform: "instagram" | "tiktok";
36
+ targetUrl: string | null;
37
+ page: number;
38
+ cursor: number | null;
39
+ } | undefined;
40
+ };
41
+ createdAt: string;
42
+ updatedAt: string;
43
+ diagnostic: {
44
+ code: "billing_unavailable" | "budget_exhausted" | "input_too_large" | "invalid_response" | "knowledge_conflict" | "permission_revoked" | "provider_outcome_unknown" | "provider_rejected" | "rate_limited" | "source_blocked" | "source_unavailable" | "storage_unavailable" | "unsupported_operation" | "worker_interrupted";
45
+ message: string;
46
+ retryable: boolean;
47
+ } | null;
48
+ document: {
49
+ id: string;
50
+ revision: number;
51
+ } | null;
52
+ }[];
53
+ canEdit: boolean;
54
+ bounds: {
55
+ limit: number;
56
+ maxLimit: 20;
57
+ offset: number;
58
+ total: number;
59
+ returned: number;
60
+ hasMore: boolean;
61
+ truncated: boolean;
62
+ };
63
+ }>;
64
+ quote: (input: import("@blitzreels/contracts").KnowledgeResearchRequest) => Promise<{
65
+ spending: {
66
+ id: string;
67
+ currency: "USD";
68
+ firstPassUsd: number;
69
+ maximumUsd: number;
70
+ policyVersion: string;
71
+ retentionDays: number;
72
+ workerDispatchLimit: number;
73
+ providerAttemptLimit: number;
74
+ };
75
+ id: string;
76
+ rates: {
77
+ version: string;
78
+ discovery: number;
79
+ capture: number;
80
+ synthesis: number;
81
+ };
82
+ firstPassCredits: number;
83
+ creditLimit: number;
84
+ maxSources: number;
85
+ maxActiveJobs: number;
86
+ canStart: boolean;
87
+ blockers: ("budget_too_low" | "runtime_unavailable")[];
88
+ billing: "fixed_per_attempt";
89
+ retriesUseRemainingBudget: true;
90
+ }>;
91
+ start: (input: import("@blitzreels/contracts").KnowledgeResearchStart) => Promise<{
92
+ job: {
93
+ id: string;
94
+ status: "cancelled" | "complete" | "failed" | "partial" | "queued" | "running";
95
+ request: {
96
+ prompt: string;
97
+ productUrl: string | null;
98
+ seriesId: string | null;
99
+ language: string;
100
+ maxSources: number;
101
+ maxCredits: number;
102
+ social?: {
103
+ platform: "instagram" | "tiktok";
104
+ targetUrl: string | null;
105
+ page: number;
106
+ cursor: number | null;
107
+ } | undefined;
108
+ };
109
+ createdAt: string;
110
+ updatedAt: string;
111
+ cancelRequested: boolean;
112
+ diagnostic: {
113
+ code: "billing_unavailable" | "budget_exhausted" | "input_too_large" | "invalid_response" | "knowledge_conflict" | "permission_revoked" | "provider_outcome_unknown" | "provider_rejected" | "rate_limited" | "source_blocked" | "source_unavailable" | "storage_unavailable" | "unsupported_operation" | "worker_interrupted";
114
+ message: string;
115
+ retryable: boolean;
116
+ } | null;
117
+ document: {
118
+ id: string;
119
+ revision: number;
120
+ } | null;
121
+ captures: {
122
+ id: string;
123
+ sourceUrl: string;
124
+ finalUrl: string;
125
+ title: string;
126
+ capturedAt: string;
127
+ sha256: string;
128
+ byteLength: number;
129
+ contentType: string;
130
+ social?: {
131
+ provider: "scrapecreators";
132
+ platform: "instagram" | "tiktok";
133
+ kind: "post" | "profile";
134
+ observedAt: string;
135
+ metricsSource: "public_research";
136
+ format: "carousel" | "photo" | "profile" | "unknown" | "video";
137
+ publishedAt: string | null;
138
+ durationSeconds: number | null;
139
+ counters: {
140
+ views: number | null;
141
+ likes: number | null;
142
+ comments: number | null;
143
+ shares: number | null;
144
+ followers: number | null;
145
+ posts: number | null;
146
+ };
147
+ } | undefined;
148
+ }[];
149
+ socialDiscovery?: {
150
+ provider: "scrapecreators";
151
+ platform: "instagram" | "tiktok";
152
+ observedAt: string;
153
+ coverage: "explicit_source" | "google_indexed_reels" | "public_search";
154
+ page: number;
155
+ returned: number;
156
+ omitted: number;
157
+ truncated: boolean;
158
+ next: {
159
+ page: number;
160
+ cursor: number | null;
161
+ } | null;
162
+ } | undefined;
163
+ credits: {
164
+ limit: number;
165
+ completed: number;
166
+ reserved: number;
167
+ uncertain: number;
168
+ remaining: number;
169
+ };
170
+ steps: {
171
+ id: string;
172
+ kind: "capture" | "discovery" | "synthesis";
173
+ status: "complete" | "dispatched" | "failed" | "pending" | "reserved" | "skipped" | "unknown";
174
+ sourceUrl: string | null;
175
+ attempts: number;
176
+ diagnostic: {
177
+ code: "billing_unavailable" | "budget_exhausted" | "input_too_large" | "invalid_response" | "knowledge_conflict" | "permission_revoked" | "provider_outcome_unknown" | "provider_rejected" | "rate_limited" | "source_blocked" | "source_unavailable" | "storage_unavailable" | "unsupported_operation" | "worker_interrupted";
178
+ message: string;
179
+ retryable: boolean;
180
+ } | null;
181
+ }[];
182
+ canResume: boolean;
183
+ };
184
+ delivery: {
185
+ dispatched: boolean;
186
+ };
187
+ mutationReceipt: {
188
+ id: string;
189
+ key: string;
190
+ operation: "knowledge.research.create";
191
+ status: "completed";
192
+ replayed: boolean;
193
+ };
194
+ }>;
195
+ get: (input: {
196
+ jobId: string;
197
+ }) => Promise<{
198
+ id: string;
199
+ status: "cancelled" | "complete" | "failed" | "partial" | "queued" | "running";
200
+ request: {
201
+ prompt: string;
202
+ productUrl: string | null;
203
+ seriesId: string | null;
204
+ language: string;
205
+ maxSources: number;
206
+ maxCredits: number;
207
+ social?: {
208
+ platform: "instagram" | "tiktok";
209
+ targetUrl: string | null;
210
+ page: number;
211
+ cursor: number | null;
212
+ } | undefined;
213
+ };
214
+ createdAt: string;
215
+ updatedAt: string;
216
+ cancelRequested: boolean;
217
+ diagnostic: {
218
+ code: "billing_unavailable" | "budget_exhausted" | "input_too_large" | "invalid_response" | "knowledge_conflict" | "permission_revoked" | "provider_outcome_unknown" | "provider_rejected" | "rate_limited" | "source_blocked" | "source_unavailable" | "storage_unavailable" | "unsupported_operation" | "worker_interrupted";
219
+ message: string;
220
+ retryable: boolean;
221
+ } | null;
222
+ document: {
223
+ id: string;
224
+ revision: number;
225
+ } | null;
226
+ captures: {
227
+ id: string;
228
+ sourceUrl: string;
229
+ finalUrl: string;
230
+ title: string;
231
+ capturedAt: string;
232
+ sha256: string;
233
+ byteLength: number;
234
+ contentType: string;
235
+ social?: {
236
+ provider: "scrapecreators";
237
+ platform: "instagram" | "tiktok";
238
+ kind: "post" | "profile";
239
+ observedAt: string;
240
+ metricsSource: "public_research";
241
+ format: "carousel" | "photo" | "profile" | "unknown" | "video";
242
+ publishedAt: string | null;
243
+ durationSeconds: number | null;
244
+ counters: {
245
+ views: number | null;
246
+ likes: number | null;
247
+ comments: number | null;
248
+ shares: number | null;
249
+ followers: number | null;
250
+ posts: number | null;
251
+ };
252
+ } | undefined;
253
+ }[];
254
+ socialDiscovery?: {
255
+ provider: "scrapecreators";
256
+ platform: "instagram" | "tiktok";
257
+ observedAt: string;
258
+ coverage: "explicit_source" | "google_indexed_reels" | "public_search";
259
+ page: number;
260
+ returned: number;
261
+ omitted: number;
262
+ truncated: boolean;
263
+ next: {
264
+ page: number;
265
+ cursor: number | null;
266
+ } | null;
267
+ } | undefined;
268
+ credits: {
269
+ limit: number;
270
+ completed: number;
271
+ reserved: number;
272
+ uncertain: number;
273
+ remaining: number;
274
+ };
275
+ steps: {
276
+ id: string;
277
+ kind: "capture" | "discovery" | "synthesis";
278
+ status: "complete" | "dispatched" | "failed" | "pending" | "reserved" | "skipped" | "unknown";
279
+ sourceUrl: string | null;
280
+ attempts: number;
281
+ diagnostic: {
282
+ code: "billing_unavailable" | "budget_exhausted" | "input_too_large" | "invalid_response" | "knowledge_conflict" | "permission_revoked" | "provider_outcome_unknown" | "provider_rejected" | "rate_limited" | "source_blocked" | "source_unavailable" | "storage_unavailable" | "unsupported_operation" | "worker_interrupted";
283
+ message: string;
284
+ retryable: boolean;
285
+ } | null;
286
+ }[];
287
+ canResume: boolean;
288
+ }>;
289
+ cancel: (input: {
290
+ jobId: string;
291
+ }) => Promise<{
292
+ job: {
293
+ id: string;
294
+ status: "cancelled" | "complete" | "failed" | "partial" | "queued" | "running";
295
+ request: {
296
+ prompt: string;
297
+ productUrl: string | null;
298
+ seriesId: string | null;
299
+ language: string;
300
+ maxSources: number;
301
+ maxCredits: number;
302
+ social?: {
303
+ platform: "instagram" | "tiktok";
304
+ targetUrl: string | null;
305
+ page: number;
306
+ cursor: number | null;
307
+ } | undefined;
308
+ };
309
+ createdAt: string;
310
+ updatedAt: string;
311
+ cancelRequested: boolean;
312
+ diagnostic: {
313
+ code: "billing_unavailable" | "budget_exhausted" | "input_too_large" | "invalid_response" | "knowledge_conflict" | "permission_revoked" | "provider_outcome_unknown" | "provider_rejected" | "rate_limited" | "source_blocked" | "source_unavailable" | "storage_unavailable" | "unsupported_operation" | "worker_interrupted";
314
+ message: string;
315
+ retryable: boolean;
316
+ } | null;
317
+ document: {
318
+ id: string;
319
+ revision: number;
320
+ } | null;
321
+ captures: {
322
+ id: string;
323
+ sourceUrl: string;
324
+ finalUrl: string;
325
+ title: string;
326
+ capturedAt: string;
327
+ sha256: string;
328
+ byteLength: number;
329
+ contentType: string;
330
+ social?: {
331
+ provider: "scrapecreators";
332
+ platform: "instagram" | "tiktok";
333
+ kind: "post" | "profile";
334
+ observedAt: string;
335
+ metricsSource: "public_research";
336
+ format: "carousel" | "photo" | "profile" | "unknown" | "video";
337
+ publishedAt: string | null;
338
+ durationSeconds: number | null;
339
+ counters: {
340
+ views: number | null;
341
+ likes: number | null;
342
+ comments: number | null;
343
+ shares: number | null;
344
+ followers: number | null;
345
+ posts: number | null;
346
+ };
347
+ } | undefined;
348
+ }[];
349
+ socialDiscovery?: {
350
+ provider: "scrapecreators";
351
+ platform: "instagram" | "tiktok";
352
+ observedAt: string;
353
+ coverage: "explicit_source" | "google_indexed_reels" | "public_search";
354
+ page: number;
355
+ returned: number;
356
+ omitted: number;
357
+ truncated: boolean;
358
+ next: {
359
+ page: number;
360
+ cursor: number | null;
361
+ } | null;
362
+ } | undefined;
363
+ credits: {
364
+ limit: number;
365
+ completed: number;
366
+ reserved: number;
367
+ uncertain: number;
368
+ remaining: number;
369
+ };
370
+ steps: {
371
+ id: string;
372
+ kind: "capture" | "discovery" | "synthesis";
373
+ status: "complete" | "dispatched" | "failed" | "pending" | "reserved" | "skipped" | "unknown";
374
+ sourceUrl: string | null;
375
+ attempts: number;
376
+ diagnostic: {
377
+ code: "billing_unavailable" | "budget_exhausted" | "input_too_large" | "invalid_response" | "knowledge_conflict" | "permission_revoked" | "provider_outcome_unknown" | "provider_rejected" | "rate_limited" | "source_blocked" | "source_unavailable" | "storage_unavailable" | "unsupported_operation" | "worker_interrupted";
378
+ message: string;
379
+ retryable: boolean;
380
+ } | null;
381
+ }[];
382
+ canResume: boolean;
383
+ };
384
+ delivery: {
385
+ dispatched: boolean;
386
+ };
387
+ }>;
388
+ resume: (input: {
389
+ jobId: string;
390
+ }) => Promise<{
391
+ job: {
392
+ id: string;
393
+ status: "cancelled" | "complete" | "failed" | "partial" | "queued" | "running";
394
+ request: {
395
+ prompt: string;
396
+ productUrl: string | null;
397
+ seriesId: string | null;
398
+ language: string;
399
+ maxSources: number;
400
+ maxCredits: number;
401
+ social?: {
402
+ platform: "instagram" | "tiktok";
403
+ targetUrl: string | null;
404
+ page: number;
405
+ cursor: number | null;
406
+ } | undefined;
407
+ };
408
+ createdAt: string;
409
+ updatedAt: string;
410
+ cancelRequested: boolean;
411
+ diagnostic: {
412
+ code: "billing_unavailable" | "budget_exhausted" | "input_too_large" | "invalid_response" | "knowledge_conflict" | "permission_revoked" | "provider_outcome_unknown" | "provider_rejected" | "rate_limited" | "source_blocked" | "source_unavailable" | "storage_unavailable" | "unsupported_operation" | "worker_interrupted";
413
+ message: string;
414
+ retryable: boolean;
415
+ } | null;
416
+ document: {
417
+ id: string;
418
+ revision: number;
419
+ } | null;
420
+ captures: {
421
+ id: string;
422
+ sourceUrl: string;
423
+ finalUrl: string;
424
+ title: string;
425
+ capturedAt: string;
426
+ sha256: string;
427
+ byteLength: number;
428
+ contentType: string;
429
+ social?: {
430
+ provider: "scrapecreators";
431
+ platform: "instagram" | "tiktok";
432
+ kind: "post" | "profile";
433
+ observedAt: string;
434
+ metricsSource: "public_research";
435
+ format: "carousel" | "photo" | "profile" | "unknown" | "video";
436
+ publishedAt: string | null;
437
+ durationSeconds: number | null;
438
+ counters: {
439
+ views: number | null;
440
+ likes: number | null;
441
+ comments: number | null;
442
+ shares: number | null;
443
+ followers: number | null;
444
+ posts: number | null;
445
+ };
446
+ } | undefined;
447
+ }[];
448
+ socialDiscovery?: {
449
+ provider: "scrapecreators";
450
+ platform: "instagram" | "tiktok";
451
+ observedAt: string;
452
+ coverage: "explicit_source" | "google_indexed_reels" | "public_search";
453
+ page: number;
454
+ returned: number;
455
+ omitted: number;
456
+ truncated: boolean;
457
+ next: {
458
+ page: number;
459
+ cursor: number | null;
460
+ } | null;
461
+ } | undefined;
462
+ credits: {
463
+ limit: number;
464
+ completed: number;
465
+ reserved: number;
466
+ uncertain: number;
467
+ remaining: number;
468
+ };
469
+ steps: {
470
+ id: string;
471
+ kind: "capture" | "discovery" | "synthesis";
472
+ status: "complete" | "dispatched" | "failed" | "pending" | "reserved" | "skipped" | "unknown";
473
+ sourceUrl: string | null;
474
+ attempts: number;
475
+ diagnostic: {
476
+ code: "billing_unavailable" | "budget_exhausted" | "input_too_large" | "invalid_response" | "knowledge_conflict" | "permission_revoked" | "provider_outcome_unknown" | "provider_rejected" | "rate_limited" | "source_blocked" | "source_unavailable" | "storage_unavailable" | "unsupported_operation" | "worker_interrupted";
477
+ message: string;
478
+ retryable: boolean;
479
+ } | null;
480
+ }[];
481
+ canResume: boolean;
482
+ };
483
+ delivery: {
484
+ dispatched: boolean;
485
+ };
486
+ }>;
487
+ };
488
+ list: (input: {
489
+ search: string;
490
+ limit: number;
491
+ offset: number;
492
+ }) => Promise<{
493
+ documents: {
494
+ id: string;
495
+ path: string;
496
+ title: string;
497
+ kind: "brief" | "correction" | "reference" | "research";
498
+ revision: number;
499
+ updatedAt: string;
500
+ }[];
501
+ bounds: {
502
+ limit: number;
503
+ offset: number;
504
+ total: number;
505
+ returned: number;
506
+ hasMore: boolean;
507
+ truncated: boolean;
508
+ };
509
+ canEdit: boolean;
510
+ canCorrect: boolean;
511
+ }>;
512
+ get: (input: {
513
+ documentId: string;
514
+ revision: number | null;
515
+ }) => Promise<{
516
+ id: string;
517
+ path: string;
518
+ title: string;
519
+ kind: "brief" | "correction" | "reference" | "research";
520
+ revision: number;
521
+ updatedAt: string;
522
+ content: {
523
+ documentId: string;
524
+ revision: number;
525
+ title: string;
526
+ kind: "brief" | "correction" | "reference" | "research";
527
+ markdown: string;
528
+ sources: {
529
+ url: string;
530
+ title: string;
531
+ }[];
532
+ authorUserId: string | null;
533
+ origin: "agent" | "legacy" | "seed" | "web";
534
+ sourceRef: string | null;
535
+ contentHash: string;
536
+ createdAt: string;
537
+ };
538
+ }>;
539
+ history: (input: {
540
+ documentId: string;
541
+ limit: number;
542
+ offset: number;
543
+ }) => Promise<{
544
+ revisions: {
545
+ documentId: string;
546
+ revision: number;
547
+ title: string;
548
+ kind: "brief" | "correction" | "reference" | "research";
549
+ sources: {
550
+ url: string;
551
+ title: string;
552
+ }[];
553
+ authorUserId: string | null;
554
+ origin: "agent" | "legacy" | "seed" | "web";
555
+ sourceRef: string | null;
556
+ contentHash: string;
557
+ createdAt: string;
558
+ }[];
559
+ bounds: {
560
+ limit: number;
561
+ offset: number;
562
+ total: number;
563
+ returned: number;
564
+ hasMore: boolean;
565
+ truncated: boolean;
566
+ };
567
+ }>;
568
+ export: (input: {
569
+ documentId: string;
570
+ revision: number | null;
571
+ }) => Promise<{
572
+ filename: string;
573
+ markdown: string;
574
+ revision: number;
575
+ }>;
576
+ context: (input?: {
577
+ seriesId: string | null;
578
+ }) => Promise<{
579
+ direction: {
580
+ capturedAt: string;
581
+ scope: {
582
+ kind: "brand" | "series";
583
+ seriesId: string | null;
584
+ name: string;
585
+ };
586
+ brand: {
587
+ title: string;
588
+ sources: {
589
+ url: string;
590
+ title: string;
591
+ }[];
592
+ path: string;
593
+ documentId: string | null;
594
+ revision: number;
595
+ markdown: string;
596
+ contentHash: string;
597
+ };
598
+ series: {
599
+ title: string;
600
+ sources: {
601
+ url: string;
602
+ title: string;
603
+ }[];
604
+ path: string;
605
+ documentId: string | null;
606
+ revision: number;
607
+ markdown: string;
608
+ contentHash: string;
609
+ } | null;
610
+ };
611
+ precedence: string[];
612
+ documents: {
613
+ id: string;
614
+ path: string;
615
+ title: string;
616
+ kind: "brief" | "correction" | "reference" | "research";
617
+ revision: number;
618
+ updatedAt: string;
619
+ content: {
620
+ documentId: string;
621
+ revision: number;
622
+ title: string;
623
+ kind: "brief" | "correction" | "reference" | "research";
624
+ markdown: string;
625
+ sources: {
626
+ url: string;
627
+ title: string;
628
+ }[];
629
+ authorUserId: string | null;
630
+ origin: "agent" | "legacy" | "seed" | "web";
631
+ sourceRef: string | null;
632
+ contentHash: string;
633
+ createdAt: string;
634
+ };
635
+ }[];
636
+ bounds: {
637
+ limit: number;
638
+ offset: number;
639
+ total: number;
640
+ returned: number;
641
+ hasMore: boolean;
642
+ truncated: boolean;
643
+ };
644
+ characterLimit: number;
645
+ truncatedDocumentIds: string[];
646
+ }>;
647
+ seed: () => Promise<{
648
+ documents: {
649
+ id: string;
650
+ path: string;
651
+ title: string;
652
+ kind: "brief" | "correction" | "reference" | "research";
653
+ revision: number;
654
+ updatedAt: string;
655
+ }[];
656
+ bounds: {
657
+ limit: number;
658
+ offset: number;
659
+ total: number;
660
+ returned: number;
661
+ hasMore: boolean;
662
+ truncated: boolean;
663
+ };
664
+ canEdit: boolean;
665
+ canCorrect: boolean;
666
+ }>;
667
+ apply: (input: KnowledgeApply & {
668
+ idempotencyKey: string;
669
+ }) => Promise<{
670
+ directionChange?: {
671
+ scope: {
672
+ kind: "brand" | "series";
673
+ seriesId: string | null;
674
+ name: string;
675
+ };
676
+ request: string;
677
+ before: {
678
+ title: string;
679
+ sources: {
680
+ url: string;
681
+ title: string;
682
+ }[];
683
+ path: string;
684
+ documentId: string | null;
685
+ revision: number;
686
+ markdown: string;
687
+ contentHash: string;
688
+ };
689
+ after: {
690
+ title: string;
691
+ sources: {
692
+ url: string;
693
+ title: string;
694
+ }[];
695
+ path: string;
696
+ documentId: string | null;
697
+ revision: number;
698
+ markdown: string;
699
+ contentHash: string;
700
+ };
701
+ } | undefined;
702
+ document: {
703
+ id: string;
704
+ path: string;
705
+ title: string;
706
+ kind: "brief" | "correction" | "reference" | "research";
707
+ revision: number;
708
+ updatedAt: string;
709
+ content: {
710
+ documentId: string;
711
+ revision: number;
712
+ title: string;
713
+ kind: "brief" | "correction" | "reference" | "research";
714
+ markdown: string;
715
+ sources: {
716
+ url: string;
717
+ title: string;
718
+ }[];
719
+ authorUserId: string | null;
720
+ origin: "agent" | "legacy" | "seed" | "web";
721
+ sourceRef: string | null;
722
+ contentHash: string;
723
+ createdAt: string;
724
+ };
725
+ };
726
+ mutationReceipt: {
727
+ id: string;
728
+ key: string;
729
+ operation: string;
730
+ status: "completed";
731
+ replayed: boolean;
732
+ };
733
+ }>;
734
+ };
735
+ export type KnowledgeResource = ReturnType<typeof createKnowledgeResource>;
736
+ //# sourceMappingURL=knowledge.d.ts.map