@dxos/plugin-file 0.10.0 → 0.11.1

package/dist/types/src/operations/create.d.ts

@@ -1,7 +1,7 @@
 import * as Effect from 'effect/Effect';
 import { Capability } from '@dxos/app-framework';
 import { Operation } from '@dxos/compute';
-import { FileCapabilities, FileOperation } from '../types';
+import { FileOperation } from '../types';
 export declare class UnsupportedFileTypeError extends Error {
     readonly type: string;
     constructor(type: string);
@@ -14,12 +14,21 @@ export declare class FileTooLargeError extends Error {
 export declare class NoBackendError extends Error {
     constructor();
 }
+export declare class FileReadError extends Error {
+    constructor(cause: unknown);
+}
 /**
- * Resolve the configured {@link FileCapabilities.Backend} from the plugin
- * settings atom. Falls back to the inline backend (or the first registered
- * one) if the configured id is missing or settings aren't available.
+ * Resolves the storage name to force for an upload:
+ * - the storage name the user explicitly configured in Settings.backend, if it matches a
+ *   registered {@link FileCapabilities.Backend} descriptor
+ * - otherwise `undefined`, leaving `File.fromBytes`'s `storage` option unset so it falls through
+ *   to the Blob registry's own configured default (edge when configured, inline otherwise)
+ *   instead of hardcoding `inline`
+ *
+ * Still requires at least one descriptor to be registered, as a sanity check that the plugin's
+ * settings UI has something to show.
  */
-export declare const resolveActiveBackend: Effect.Effect<FileCapabilities.Backend, NoBackendError, Capability.Service>;
+export declare const resolveActiveStorage: Effect.Effect<string | undefined, NoBackendError, Capability.Service>;
 declare const handler: Operation.WithHandler<typeof FileOperation.Create>;
 export default handler;
 //# sourceMappingURL=create.d.ts.map

package/dist/types/src/operations/create.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../../../src/operations/create.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAgB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C,OAAO,EAAQ,gBAAgB,EAAE,aAAa,EAA+C,MAAM,UAAU,CAAC;AAE9G,qBAAa,wBAAyB,SAAQ,KAAK;aACrB,IAAI,EAAE,MAAM;IAAxC,YAA4B,IAAI,EAAE,MAAM,EAGvC;CACF;AAED,qBAAa,iBAAkB,SAAQ,KAAK;aAExB,IAAI,EAAE,MAAM;aACZ,KAAK,EAAE,MAAM;IAF/B,YACkB,IAAI,EAAE,MAAM,EACZ,KAAK,GAAE,MAAsB,EAI9C;CACF;AAED,qBAAa,cAAe,SAAQ,KAAK;IACvC,cAGC;CACF;AAED;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,6EAmB/B,CAAC;AAEH,QAAA,MAAM,OAAO,EAAE,SAAS,CAAC,WAAW,CAAC,OAAO,aAAa,CAAC,MAAM,CAuB/D,CAAC;eAEa,OAAO"}
+{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../../../src/operations/create.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAgB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAG1C,OAAO,EAA0B,aAAa,EAAgC,MAAM,UAAU,CAAC;AAE/F,qBAAa,wBAAyB,SAAQ,KAAK;aACrB,IAAI,EAAE,MAAM;IAAxC,YAA4B,IAAI,EAAE,MAAM,EAGvC;CACF;AAED,qBAAa,iBAAkB,SAAQ,KAAK;aAExB,IAAI,EAAE,MAAM;aACZ,KAAK,EAAE,MAAM;IAF/B,YACkB,IAAI,EAAE,MAAM,EACZ,KAAK,GAAE,MAA6B,EAIrD;CACF;AAED,qBAAa,cAAe,SAAQ,KAAK;IACvC,cAGC;CACF;AAED,qBAAa,aAAc,SAAQ,KAAK;IACtC,YAAY,KAAK,EAAE,OAAO,EAIzB;CACF;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,uEAoB/B,CAAC;AAEH,QAAA,MAAM,OAAO,EAAE,SAAS,CAAC,WAAW,CAAC,OAAO,aAAa,CAAC,MAAM,CA2B/D,CAAC;eAEa,OAAO"}

package/dist/types/src/operations/read.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"read.d.ts","sourceRoot":"","sources":["../../../../src/operations/read.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAI1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,QAAA,MAAM,OAAO,EAAE,SAAS,CAAC,WAAW,CAAC,OAAO,aAAa,CAAC,IAAI,CAoB7D,CAAC;eAEa,OAAO"}
+{"version":3,"file":"read.d.ts","sourceRoot":"","sources":["../../../../src/operations/read.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAI1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAczC,QAAA,MAAM,OAAO,EAAE,SAAS,CAAC,WAAW,CAAC,OAAO,aAAa,CAAC,IAAI,CAyB7D,CAAC;eAEa,OAAO"}

package/dist/types/src/types/FileCapabilities.d.ts

@@ -1,41 +1,23 @@
-import { type Atom } from '@effect-atom/atom-react';
+import { type Atom } from '@effect-atom/atom';
 import { Capability } from '@dxos/app-framework';
-import { type Database } from '@dxos/echo';
-import { type Space } from '@dxos/react-client/echo';
-import { File } from '@dxos/types';
 import * as Settings from './Settings';
 /**
- * A file storage backend. Each backend ingests a File from the user and
- * returns the metadata + the {@link File.FileData} to attach to a
- * {@link File.File} object.
+ * Descriptor for a registered `BlobBackend` storage option, surfaced in the file plugin's
+ * settings UI. Actual upload/read logic lives in the Blob backend registered on the Hypergraph
+ * under `storage` (see `client.graph.registerBlobBackend`) — this type carries no behavior.
  */
 export type Backend = {
-    /** Stable backend id (e.g. 'inline', 'wnfs'). Used as the settings key. */
-    readonly id: string;
     /** Display label shown in the settings UI. */
     readonly name: string;
     /** Description shown next to the backend in settings. */
     readonly description?: string;
-    /** Upload a file. Throws on validation errors (size cap, unsupported MIME). */
-    readonly upload: (file: globalThis.File, db: Database.Database) => Promise<UploadResult>;
-};
-export type UploadResult = {
-    readonly name: string;
-    readonly type: string;
-    readonly size: number;
-    readonly data: File.FileData;
+    /**
+     * `Blob.fromBytes`'s `storage` option to use when this backend is selected. Also the settings
+     * key identifying this backend — one `BlobBackend` is registered per storage name, so the two
+     * concepts always coincide.
+     */
+    readonly storage: string;
 };
 export declare const Backend: Capability.InterfaceDef<Backend>;
-/**
- * Resolves an external URL (e.g. `wnfs://…`) into a renderable URL (a
- * `blob:`, `data:`, or `http(s):` URL). Consumers iterate registered
- * resolvers and pick the first that returns true from {@link UrlResolver#test}.
- */
-export type UrlResolver = {
-    readonly id: string;
-    readonly test: (url: string) => boolean;
-    readonly resolve: (url: string, file: File.File, space?: Space) => Promise<string | undefined>;
-};
-export declare const UrlResolver: Capability.InterfaceDef<UrlResolver>;
 export declare const SettingsAtom: Capability.InterfaceDef<Atom.Writable<Settings.Settings, Settings.Settings>>;
 //# sourceMappingURL=FileCapabilities.d.ts.map

package/dist/types/src/types/FileCapabilities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FileCapabilities.d.ts","sourceRoot":"","sources":["../../../../src/types/FileCapabilities.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAEpD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAInC,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AAEvC;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,8CAA8C;IAC9C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,yDAAyD;IACzD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,+EAA+E;IAC/E,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,QAAQ,CAAC,QAAQ,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;CAC1F,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC;CAC9B,CAAC;AAEF,eAAO,MAAM,OAAO,kCAAqE,CAAC;AAE1F;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;IACxC,QAAQ,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,KAAK,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAChG,CAAC;AAEF,eAAO,MAAM,WAAW,sCAA8E,CAAC;AAEvG,eAAO,MAAM,YAAY,8EAExB,CAAC"}
+{"version":3,"file":"FileCapabilities.d.ts","sourceRoot":"","sources":["../../../../src/types/FileCapabilities.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAIjD,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AAEvC;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,8CAA8C;IAC9C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,yDAAyD;IACzD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,eAAO,MAAM,OAAO,kCAAqE,CAAC;AAE1F,eAAO,MAAM,YAAY,8EAExB,CAAC"}

package/dist/types/src/types/Settings.d.ts

@@ -1,5 +1,5 @@
 import * as Schema from 'effect/Schema';
-export declare const DEFAULT_BACKEND_ID = "inline";
+export declare const DEFAULT_BACKEND_STORAGE = "inline";
 export declare const Settings: Schema.mutable<Schema.Struct<{
     backend: Schema.optional<Schema.SchemaClass<string, string, never>>;
 }>>;

package/dist/types/src/types/Settings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Settings.d.ts","sourceRoot":"","sources":["../../../../src/types/Settings.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,eAAO,MAAM,kBAAkB,WAAW,CAAC;AAE3C,eAAO,MAAM,QAAQ;;GAUpB,CAAC;AAEF,MAAM,WAAW,QAAS,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,QAAQ,CAAC;CAAG"}
+{"version":3,"file":"Settings.d.ts","sourceRoot":"","sources":["../../../../src/types/Settings.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,eAAO,MAAM,uBAAuB,WAAW,CAAC;AAEhD,eAAO,MAAM,QAAQ;;GAUpB,CAAC;AAEF,MAAM,WAAW,QAAS,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,QAAQ,CAAC;CAAG"}

package/dist/types/src/types/limits.d.ts

@@ -1,4 +1,3 @@
-export declare const MAX_FILE_SIZE: number;
 export declare const ACCEPTED_MIME: Record<string, string[]>;
 export declare const isAcceptedMimeType: (type: string) => boolean;
 //# sourceMappingURL=limits.d.ts.map

package/dist/types/src/types/limits.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"limits.d.ts","sourceRoot":"","sources":["../../../../src/types/limits.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,aAAa,QAAkB,CAAC;AAE7C,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAIlD,CAAC;AAEF,eAAO,MAAM,kBAAkB,SAAU,MAAM,KAAG,OAQjD,CAAC"}
+{"version":3,"file":"limits.d.ts","sourceRoot":"","sources":["../../../../src/types/limits.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAIlD,CAAC;AAEF,eAAO,MAAM,kBAAkB,SAAU,MAAM,KAAG,OAQjD,CAAC"}