@fungi.computer/oyster 0.48.0 → 0.49.0

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.
package/docs/api/pack.md CHANGED
@@ -111,6 +111,16 @@ type PackedRelease = Readonly<{
111
111
 
112
112
  A packed Release on disk.
113
113
 
114
+ ---
115
+
116
+ ### UploadedRelease
117
+
118
+ ```ts
119
+ type UploadedRelease = Schema.Schema.Type<typeof releaseSchema>;
120
+ ```
121
+
122
+ The Release `release.json` names, as read and uploaded.
123
+
114
124
  ## Variables
115
125
 
116
126
  ### installationOperationSchema
@@ -317,6 +327,117 @@ retains its original lifetime.
317
327
 
318
328
  ---
319
329
 
330
+ ### previewBuiltRelease()
331
+
332
+ ```ts
333
+ function previewBuiltRelease(input): Promise<{
334
+ name: string;
335
+ capabilities: readonly (
336
+ | "computer.list"
337
+ | "computer.readFile"
338
+ | "computer.writeFile"
339
+ | "computer.execute"
340
+ | "approvals"
341
+ | "agent.list"
342
+ | "agent.manage"
343
+ | "agent.rename"
344
+ | "agent.avatar"
345
+ | "agent.instructions"
346
+ | "agent.toolPolicy"
347
+ | "agent.read"
348
+ | "agent.send"
349
+ | "llm.generation"
350
+ | "media.generation"
351
+ | "media.share"
352
+ | "games:servers"
353
+ | "git.repository"
354
+ | "apps.open"
355
+ | "apps.call"
356
+ | "app.storage"
357
+ | "app.events.emit"
358
+ | "team.workbenchHost"
359
+ | "marketplace.browse"
360
+ | "marketplace.purchase"
361
+ | "workflow.run"
362
+ | "workflow.publish"
363
+ | "workflow.arm"
364
+ | "world"
365
+ | "channels.read"
366
+ | "channels.personal.manage"
367
+ )[];
368
+ update: {
369
+ installationId: string;
370
+ needsApproval: readonly (
371
+ | "computer.list"
372
+ | "computer.readFile"
373
+ | "computer.writeFile"
374
+ | "computer.execute"
375
+ | "approvals"
376
+ | "agent.list"
377
+ | "agent.manage"
378
+ | "agent.rename"
379
+ | "agent.avatar"
380
+ | "agent.instructions"
381
+ | "agent.toolPolicy"
382
+ | "agent.read"
383
+ | "agent.send"
384
+ | "llm.generation"
385
+ | "media.generation"
386
+ | "media.share"
387
+ | "games:servers"
388
+ | "git.repository"
389
+ | "apps.open"
390
+ | "apps.call"
391
+ | "app.storage"
392
+ | "app.events.emit"
393
+ | "team.workbenchHost"
394
+ | "marketplace.browse"
395
+ | "marketplace.purchase"
396
+ | "workflow.run"
397
+ | "workflow.publish"
398
+ | "workflow.arm"
399
+ | "world"
400
+ | "channels.read"
401
+ | "channels.personal.manage"
402
+ )[];
403
+ } | null;
404
+ }>;
405
+ ```
406
+
407
+ Ask the Oyster what installing a Release it already holds would request, and
408
+ whether it would update an existing installation.
409
+
410
+ #### Parameters
411
+
412
+ | Parameter | Type |
413
+ | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
414
+ | `input` | `Readonly`\<\{ `url`: `string`; `key`: `string`; `release`: [`UploadedRelease`](#uploadedrelease); `installationId?`: `string`; `signal?`: `AbortSignal`; \}\> |
415
+
416
+ #### Returns
417
+
418
+ `Promise`\<\{ `name`: `string`; `capabilities`: readonly ( \| `"computer.list"`
419
+ \| `"computer.readFile"` \| `"computer.writeFile"` \| `"computer.execute"` \|
420
+ `"approvals"` \| `"agent.list"` \| `"agent.manage"` \| `"agent.rename"` \|
421
+ `"agent.avatar"` \| `"agent.instructions"` \| `"agent.toolPolicy"` \|
422
+ `"agent.read"` \| `"agent.send"` \| `"llm.generation"` \| `"media.generation"`
423
+ \| `"media.share"` \| `"games:servers"` \| `"git.repository"` \| `"apps.open"`
424
+ \| `"apps.call"` \| `"app.storage"` \| `"app.events.emit"` \|
425
+ `"team.workbenchHost"` \| `"marketplace.browse"` \| `"marketplace.purchase"` \|
426
+ `"workflow.run"` \| `"workflow.publish"` \| `"workflow.arm"` \| `"world"` \|
427
+ `"channels.read"` \| `"channels.personal.manage"`)[]; `update`: \| \{
428
+ `installationId`: `string`; `needsApproval`: readonly ( \| `"computer.list"` \|
429
+ `"computer.readFile"` \| `"computer.writeFile"` \| `"computer.execute"` \|
430
+ `"approvals"` \| `"agent.list"` \| `"agent.manage"` \| `"agent.rename"` \|
431
+ `"agent.avatar"` \| `"agent.instructions"` \| `"agent.toolPolicy"` \|
432
+ `"agent.read"` \| `"agent.send"` \| `"llm.generation"` \| `"media.generation"`
433
+ \| `"media.share"` \| `"games:servers"` \| `"git.repository"` \| `"apps.open"`
434
+ \| `"apps.call"` \| `"app.storage"` \| `"app.events.emit"` \|
435
+ `"team.workbenchHost"` \| `"marketplace.browse"` \| `"marketplace.purchase"` \|
436
+ `"workflow.run"` \| `"workflow.publish"` \| `"workflow.arm"` \| `"world"` \|
437
+ `"channels.read"` \| `"channels.personal.manage"`)[]; \} \| `null`; \}\>
438
+
439
+ ---
440
+
320
441
  ### previewRelease()
321
442
 
322
443
  ```ts
@@ -407,8 +528,8 @@ function previewRelease(input): Promise<{
407
528
  }>;
408
529
  ```
409
530
 
410
- Upload one built Release and ask the Oyster what installing it would request, so
411
- an owner can confirm several Releases once before any install.
531
+ Upload one built Release and preview it, so an owner can confirm several
532
+ Releases once before any install.
412
533
 
413
534
  #### Parameters
414
535
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fungi.computer/oyster",
3
- "version": "0.48.0",
3
+ "version": "0.49.0",
4
4
  "author": "Levi <levi@technomancy.dev>",
5
5
  "description": "Oyster by Fungi: open-source Apps for people and AI agents. Try with one command or run on your own Cloudflare account.",
6
6
  "homepage": "https://docs.fungi.computer/oyster",