@peers-app/peers-sdk 0.29.2 → 0.30.1

package/dist/package-build/build-package.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadPackageModule = loadPackageModule;
+exports.fileFieldWarnings = fileFieldWarnings;
 exports.generatePackageManifest = generatePackageManifest;
 exports.packageManifest = packageManifest;
 exports.buildPackage = buildPackage;
@@ -18,6 +19,7 @@ const node_module_1 = require("node:module");
 const path = require("node:path");
 const manifest_1 = require("../define/manifest");
 const isolated_artifact_1 = require("../package-loader/isolated-artifact");
+const field_type_1 = require("../types/field-type");
 const freeze_contracts_1 = require("./freeze-contracts");
 /** Source text SES rejects before running it, with what to tell the author. */
 const SES_REJECTED_PATTERNS = [
@@ -129,7 +131,38 @@ async function loadModule(options, entry) {
 function validateManifest(manifest, providerSource = "void 0;") {
     (0, isolated_artifact_1.validateIsolatedPackageArtifact)({ manifest: structuredClone(manifest), providerSource }, { strict: true });
 }
-/** The package's definition and manifest, validated together. */
+/** A field name that reads as a file id: `fileId`, `imageFileId`, `fileIds` (not `profileId`). */
+const FILE_ID_NAME = /(?:^file|File)Ids?$/;
+/**
+ * Warnings about table fields that look like file references but aren't: a top-level field
+ * named like a file id that isn't declared with `zodFileId`, and a `zodFileId` nested in an
+ * object field. Neither keeps its files, so Peers may free them. Internal to the build.
+ *
+ * @internal
+ * @param manifest - The package's manifest.
+ */
+function fileFieldWarnings(manifest) {
+    const warnings = [];
+    const nested = (table, fields, parent) => {
+        for (const field of fields ?? []) {
+            const path = `${parent}.${field.name}`;
+            if ((0, field_type_1.isFileReferenceField)(field)) {
+                warnings.push(`Table ${table}: "${path}" is a zodFileId inside an object field, which doesn't keep its files. Only a table's top-level fields do: move it up, or use a table of attachments.`);
+            }
+            nested(table, field.fields, path);
+        }
+    };
+    for (const table of manifest.tables ?? []) {
+        for (const field of table.fields) {
+            if (FILE_ID_NAME.test(field.name) && !(0, field_type_1.isFileReferenceField)(field)) {
+                warnings.push(`Table ${table.name}: "${field.name}" looks like a file id but isn't declared with zodFileId, so it doesn't keep its files. Declare it with zodFileId and raise the table's versionNumber.`);
+            }
+            nested(table.name, field.fields, field.name);
+        }
+    }
+    return warnings;
+}
+/** The package's definition and manifest, validated together, and the build's warnings. */
 async function validPackage(options) {
     // frozen-contracts.json gives the shapes of older versions a contract also implements.
     const definition = await loadDefinition(options);
@@ -137,7 +170,7 @@ async function validPackage(options) {
         frozen: await (0, freeze_contracts_1.readFrozenContracts)(options.root),
     });
     validateManifest(manifest);
-    return { definition, manifest };
+    return { definition, manifest, warnings: fileFieldWarnings(manifest) };
 }
 /** The package's manifest, validated and checked against the contracts it froze. */
 async function checkedPackage(options) {
@@ -146,8 +179,8 @@ async function checkedPackage(options) {
     return result;
 }
 async function writeManifest(options) {
-    const { manifest } = await checkedPackage(options);
-    return saveManifest(options, manifest);
+    const { manifest, warnings } = await checkedPackage(options);
+    return { ...(await saveManifest(options, manifest)), warnings };
 }
 async function saveManifest(options, manifest) {
     const manifestPath = path.join(options.outDir, "manifest.json");
@@ -241,7 +274,7 @@ async function packageManifest(buildOptions = {}) {
  */
 async function buildPackage(buildOptions = {}) {
     const options = resolveOptions(buildOptions);
-    const { definition, manifest } = await checkedPackage(options);
+    const { definition, manifest, warnings } = await checkedPackage(options);
     const hasProvider = definition.provides.length > 0 ||
         definition.tables.length > 0 ||
         definition.startHooks.length > 0 ||
@@ -252,7 +285,13 @@ async function buildPackage(buildOptions = {}) {
     const providerSource = output?.outputFiles?.[0]?.text ?? "";
     const artifactPath = await writeArtifact(options, manifest, providerSource);
     const { manifestPath } = await saveManifest(options, manifest);
-    return { manifest, manifestPath, artifactPath, providerChars: providerSource.length };
+    return {
+        manifest,
+        manifestPath,
+        artifactPath,
+        providerChars: providerSource.length,
+        warnings,
+    };
 }
 /**
  * Build once, then rebuild whenever a source file changes. Resolves once watching starts.

package/dist/package-build/cli.js

@@ -64,6 +64,11 @@ function summarize(result) {
     const tools = manifest.provides.reduce((count, contract) => count + contract.tools.length, 0);
     return `${manifest.provides.length} contract(s), ${tools} tool(s), ${manifest.tables?.length ?? 0} table(s)`;
 }
+/** Print the build's warnings, one per line. */
+function printWarnings(result) {
+    for (const warning of result.warnings)
+        console.warn(`Warning: ${warning}`);
+}
 function relative(file) {
     return path.relative(process.cwd(), file) || file;
 }
@@ -88,6 +93,7 @@ async function main(argv) {
             throw new Error("--watch applies to build");
         }
         const result = await (0, build_package_1.generatePackageManifest)(options);
+        printWarnings(result);
         console.log(`Manifest: ${summarize(result)} -> ${relative(result.manifestPath)}`);
         return 0;
     }
@@ -97,12 +103,14 @@ async function main(argv) {
                 console.error(`Build failed: ${result.message}`);
                 return;
             }
+            printWarnings(result);
             console.log(`Built ${relative(result.artifactPath)} (${summarize(result)}; SDK ${sdk_version_1.SDK_VERSION}; provider ${Math.round(result.providerChars / 1024)} KB)`);
         });
         console.log("Watching for changes");
         return new Promise(() => undefined);
     }
     const result = await (0, build_package_1.buildPackage)(options);
+    printWarnings(result);
     console.log(`Built ${relative(result.artifactPath)} (${summarize(result)}; SDK ${sdk_version_1.SDK_VERSION}; provider ${Math.round(result.providerChars / 1024)} KB)`);
     return 0;
 }

package/dist/package-build/contract-source.js

@@ -316,7 +316,7 @@ class Code {
             (field.enumValues !== undefined &&
                 new Set(field.enumValues).size !== field.enumValues.length) ||
             field.defaultValue !== undefined ||
-            field.subType !== undefined ||
+            (field.subType !== undefined && !(0, field_type_1.isFileReferenceField)(field)) ||
             field.optional === false ||
             field.isArray === false ||
             field.description === "") {
@@ -367,11 +367,13 @@ class Code {
                 return values?.length && new Set(values).size === 1
                     ? `z.literal(${JSON.stringify(values[0])})`
                     : "z.boolean()";
-            case field_type_1.FieldType.id:
-                this.imports.add("zodPeerId");
+            case field_type_1.FieldType.id: {
+                const idSchema = (0, field_type_1.isFileReferenceField)(field) ? "zodFileId" : "zodPeerId";
+                this.imports.add(idSchema);
                 return values?.length
-                    ? `zodPeerId.refine((value) => ${JSON.stringify(values)}.includes(value))`
-                    : "zodPeerId";
+                    ? `${idSchema}.refine((value) => ${JSON.stringify(values)}.includes(value))`
+                    : idSchema;
+            }
             case field_type_1.FieldType.Date:
                 return "z.date()";
             case field_type_1.FieldType.blob:

package/dist/package-installer/package-installer.d.ts

@@ -37,11 +37,9 @@ export declare function ensurePackageVersionAppNavs(dataContext: DataContext, de
  */
 export declare function installAllPackageBundles(dataContext: DataContext, deps: IPackageInstallerDeps): Promise<void>;
 /**
- * Save a bundle's content as a File record, deduplicating by hash.
- *
- * If a File with the same hash already exists for this bundle name,
- * the existing record is reused — no new File is created. This eliminates
- * the "new File record on every dev reload" bug.
+ * Save a bundle's content as a file the runtime owns: collected once no package version
+ * references it. The same content and name give the same file, so a rebuild with no change
+ * adds no row, and every save stores the chunks again (restoring any a device has freed).
  */
 export declare function saveBundleFile(dataContext: DataContext, content: string, name: string, _packageId: string): Promise<{
     fileId: string;

package/dist/package-installer/package-installer.js

@@ -98,7 +98,7 @@ async function installPackageFromBundles(dataContext, deps, packageId, opts) {
         });
         return { packageVersion: existingPv, loaded, unchanged, warning };
     }
-    // 7. Save bundle files (deduped by hash)
+    // 7. Save bundle files (the same content and name is the same file)
     const packageFile = await saveBundleFile(dataContext, packageBundle, `${packageId}-package.bundle.js`, packageId);
     let routesFile;
     if (routesBundle) {
@@ -278,28 +278,12 @@ async function installAllPackageBundles(dataContext, deps) {
     }
 }
 /**
- * Save a bundle's content as a File record, deduplicating by hash.
- *
- * If a File with the same hash already exists for this bundle name,
- * the existing record is reused — no new File is created. This eliminates
- * the "new File record on every dev reload" bug.
+ * Save a bundle's content as a file the runtime owns: collected once no package version
+ * references it. The same content and name give the same file, so a rebuild with no change
+ * adds no row, and every save stores the chunks again (restoring any a device has freed).
  */
 async function saveBundleFile(dataContext, content, name, _packageId) {
-    const fileHash = (0, file_types_1.computeFileHash)(content);
-    const filesTable = (0, files_1.Files)(dataContext);
-    // Check if a file with this hash already exists for this bundle name
-    const existing = await filesTable.findOne({ name, fileHash });
-    if (existing) {
-        return { fileId: existing.fileId, fileHash: existing.fileHash };
-    }
-    const fileId = (0, utils_1.newid)();
-    const metadata = {
-        fileId,
-        name,
-        fileSize: content.length,
-        mimeType: "application/javascript",
-    };
-    const saved = await filesTable.saveFile(metadata, content);
+    const saved = await (0, files_1.Files)(dataContext).saveFile({ name, mimeType: "application/javascript", keep: false }, content);
     return { fileId: saved.fileId, fileHash: saved.fileHash };
 }
 /**

package/dist/package-installer/package-propagation.js

@@ -125,7 +125,7 @@ async function installPvInGroupNoActivate(source, dest, pv) {
     if (!files)
         return false;
     for (const file of files) {
-        await copyFileTree(source, dest, file);
+        await copyBundleRow(dest, file);
     }
     const propagatedPv = buildPropagatedPv(pv, files);
     await (0, package_versions_1.PackageVersions)(dest).signAndSave(propagatedPv, {
@@ -162,9 +162,9 @@ async function installPvInGroup(source, dest, pv, retryCnt = 0) {
     if (!files) {
         return await retryOrFail(source, dest, pv, retryCnt, "missing files");
     }
-    // Copy file records (including index files) into destination
+    // Copy the bundles' rows into the destination
     for (const file of files) {
-        await copyFileTree(source, dest, file);
+        await copyBundleRow(dest, file);
     }
     // Save sanitized PV
     const propagatedPv = buildPropagatedPv(pv, files);
@@ -231,20 +231,9 @@ async function copyBundleFiles(source, pv) {
     }
     return bundles;
 }
-async function copyFileTree(source, dest, bundle, copiedIds = new Set()) {
-    await saveFileAndIndexTree((0, files_1.Files)(source), (0, files_1.Files)(dest), bundle.file, copiedIds);
-}
-async function saveFileAndIndexTree(sourceFiles, destFiles, file, copiedIds) {
-    if (copiedIds.has(file.fileId))
-        return;
-    copiedIds.add(file.fileId);
-    if (file.indexFileId) {
-        const indexFile = await sourceFiles.get(file.indexFileId);
-        if (indexFile) {
-            await saveFileAndIndexTree(sourceFiles, destFiles, indexFile, copiedIds);
-        }
-    }
-    await destFiles.saveFileRecord(file);
+/** Copy a bundle's row into `dest`. It keeps its id: a file's id doesn't depend on its context. */
+async function copyBundleRow(dest, bundle) {
+    await (0, files_1.Files)(dest).saveFileRecord(bundle.file);
 }
 /** Select the best publisher-signed release under an Admin-approved package's follow policy. */
 async function activateBestEligibleVersion(dataContext, pkg) {

package/dist/system-ids.d.ts

@@ -217,3 +217,5 @@ export declare const hostShellContractId = "00mveexhw7ezjfghxomlo011g";
 export declare const groupMembersContractId = "00mvzfzkuf4djwjrsxq9cnaxt";
 /** Local-only System Files v1: save and read files in the caller's own context; allocated once with newid(). */
 export declare const filesContractId = "00mw1pvs1eupopu6sttetmki0";
+/** Local-only System File Storage v1: this device's chunk store and its migration; allocated once with newid(). */
+export declare const fileStorageContractId = "00mw2svtlb4yv8opod7vnofgn";

package/dist/system-ids.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.filesContractId = exports.groupMembersContractId = exports.hostShellContractId = exports.packagesContractId = exports.desktopToolsContractId = exports.hostToolsContractId = exports.toolCatalogContractId = exports.schedulerToolIds = exports.schedulerContractId = exports.contractCatalogToolIds = exports.contractCatalogContractId = exports.httpToolIds = exports.httpContractId = exports.localFoldersToolIds = exports.localFoldersContractId = exports.identityToolIds = exports.identityContractId = exports.invitesToolIds = exports.invitesContractId = exports.toolAccessControlToolIds = exports.toolAccessControlContractId = exports.syncCheckContractId = exports.appUpdatesContractId = exports.networkControlContractId = exports.networkDiagnosticsContractId = exports.deviceOperationsContractId = exports.logsContractId = exports.peersSystemPackageId = exports.peersCoreRevokedPublishPublicKeys = exports.peersCorePublishPublicKey = exports.peersCorePackageRepoUrl = exports.peersCorePackageId = exports.createGroupToolId = exports.queryDatabaseToolId = exports.runWorkflowToolId = exports.defaultSendMessageToolId = exports.defaultAssistantRunnerToolId = exports.adminAssistantId = exports.openCodeAssistantId = exports.defaultAssistantId = exports.peersRootUserId = void 0;
+exports.fileStorageContractId = exports.filesContractId = exports.groupMembersContractId = exports.hostShellContractId = exports.packagesContractId = exports.desktopToolsContractId = exports.hostToolsContractId = exports.toolCatalogContractId = exports.schedulerToolIds = exports.schedulerContractId = exports.contractCatalogToolIds = exports.contractCatalogContractId = exports.httpToolIds = exports.httpContractId = exports.localFoldersToolIds = exports.localFoldersContractId = exports.identityToolIds = exports.identityContractId = exports.invitesToolIds = exports.invitesContractId = exports.toolAccessControlToolIds = exports.toolAccessControlContractId = exports.syncCheckContractId = exports.appUpdatesContractId = exports.networkControlContractId = exports.networkDiagnosticsContractId = exports.deviceOperationsContractId = exports.logsContractId = exports.peersSystemPackageId = exports.peersCoreRevokedPublishPublicKeys = exports.peersCorePublishPublicKey = exports.peersCorePackageRepoUrl = exports.peersCorePackageId = exports.createGroupToolId = exports.queryDatabaseToolId = exports.runWorkflowToolId = exports.defaultSendMessageToolId = exports.defaultAssistantRunnerToolId = exports.adminAssistantId = exports.openCodeAssistantId = exports.defaultAssistantId = exports.peersRootUserId = void 0;
 /** Stable user ID that owns built-in Peers system records. */
 exports.peersRootUserId = "000peers0user000000000001";
 /** Default assistant used when no user-selected assistant is available. */
@@ -224,3 +224,5 @@ exports.hostShellContractId = "00mveexhw7ezjfghxomlo011g";
 exports.groupMembersContractId = "00mvzfzkuf4djwjrsxq9cnaxt";
 /** Local-only System Files v1: save and read files in the caller's own context; allocated once with newid(). */
 exports.filesContractId = "00mw1pvs1eupopu6sttetmki0";
+/** Local-only System File Storage v1: this device's chunk store and its migration; allocated once with newid(). */
+exports.fileStorageContractId = "00mw2svtlb4yv8opod7vnofgn";

package/dist/types/field-type.d.ts

@@ -32,6 +32,10 @@ export interface IField {
     optional?: boolean;
     /** The value is an array of `type`; `fields`, `enumValues` describe each element. */
     isArray?: boolean;
+    /**
+     * What the value means beyond its type. {@link FILE_SUBTYPE} on an `id` field makes it a file
+     * reference ({@link isFileReferenceField}); `"markdown"` on a string asks UIs to render it.
+     */
     subType?: string;
     /** An object's own fields. Absent: any object. Only on `object`; other keys may be present. */
     fields?: IField[];
@@ -52,3 +56,13 @@ export declare const fieldSchema: z.ZodObject<{
     fields: z.ZodOptional<z.ZodLazy<z.ZodArray<z.ZodType<IField>>>>;
     enumValues: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
 }, "strip", z.ZodTypeAny, IField, IField>;
+/** The {@link IField.subType} of an `id` field that names a file: what `zodFileId` declares. */
+export declare const FILE_SUBTYPE = "file";
+/**
+ * True when a table field references files: an `id` field, or an array of them, with
+ * {@link FILE_SUBTYPE}. Only a table's top-level fields count; a file id nested in an object
+ * field isn't a reference.
+ *
+ * @param field - One of a table definition's top-level fields.
+ */
+export declare function isFileReferenceField(field: Pick<IField, "type" | "subType">): boolean;

package/dist/types/field-type.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fieldSchema = exports.FieldType = void 0;
+exports.FILE_SUBTYPE = exports.fieldSchema = exports.FieldType = void 0;
+exports.isFileReferenceField = isFileReferenceField;
 const zod_1 = require("zod");
 //export type FieldType = 'id' | 'string' | 'number' | 'boolean' | 'Date' | 'object' | 'blob' | 'any';
 /** The value types a Peers IR field can have. */
@@ -27,3 +28,15 @@ exports.fieldSchema = zod_1.z.object({
     fields: zod_1.z.lazy(() => zod_1.z.array(exports.fieldSchema)).optional(),
     enumValues: zod_1.z.array(zod_1.z.union([zod_1.z.string(), zod_1.z.number(), zod_1.z.boolean()])).optional(),
 });
+/** The {@link IField.subType} of an `id` field that names a file: what `zodFileId` declares. */
+exports.FILE_SUBTYPE = "file";
+/**
+ * True when a table field references files: an `id` field, or an array of them, with
+ * {@link FILE_SUBTYPE}. Only a table's top-level fields count; a file id nested in an object
+ * field isn't a reference.
+ *
+ * @param field - One of a table definition's top-level fields.
+ */
+function isFileReferenceField(field) {
+    return field.type === FieldType.id && field.subType === exports.FILE_SUBTYPE;
+}

package/dist/types/zod-types.d.ts

@@ -9,6 +9,16 @@ export declare const zodAnyObjectOrArray: z.ZodUnion<[z.ZodObject<{}, "strip", z
  * records the field as an id.
  */
 export declare const zodPeerId: z.ZodEffects<z.ZodString, string, string>;
+/**
+ * A file's id, as `SystemFiles.save` returns it: a {@link zodPeerId} marked as a file reference
+ * (`subType: "file"`). A synced table's top-level field declared with it, or with an array of it,
+ * keeps the files it names: Peers frees a file's bytes only some time after no such field names
+ * it. Local-only tables, package variables, plain string fields, and nested object fields
+ * don't declare references.
+ *
+ * Changing a field to `zodFileId` changes the table's definition, so raise its `versionNumber`.
+ */
+export declare const zodFileId: z.ZodEffects<z.ZodString, string, string>;
 /** Any zod object schema. */
 export type ZodObjectType = z.ZodObject<any>;
 /** Any zod array schema. */

package/dist/types/zod-types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.zodPeerId = exports.zodAnyObjectOrArray = exports.zodAnyObject = exports.z = void 0;
+exports.zodFileId = exports.zodPeerId = exports.zodAnyObjectOrArray = exports.zodAnyObject = exports.z = void 0;
 const zod_1 = require("zod");
 const peer_id_1 = require("../peer-id");
 const field_type_1 = require("./field-type");
@@ -14,13 +14,31 @@ Object.defineProperty(exports, "z", { enumerable: true, get: function () { retur
 exports.zodAnyObject = zod_1.z.object({}).catchall(zod_1.z.any());
 /** Any plain object or any array. */
 exports.zodAnyObjectOrArray = zod_1.z.union([exports.zodAnyObject, zod_1.z.array(zod_1.z.any())]);
+/** A new peer-id schema, marked as {@link FieldType.id} and, given one, a subtype. */
+function peerIdSchema(subType) {
+    const schema = zod_1.z.string().refine((value) => {
+        return (0, peer_id_1.isid)(value);
+    }, {
+        message: "Invalid peer id, it must be a 25 character alphanumeric string",
+    });
+    schema._def._fieldType = field_type_1.FieldType.id;
+    if (subType) {
+        schema._def._subType = subType;
+    }
+    return schema;
+}
 /**
  * A 25-character peer id from `newid()`. Marked as {@link FieldType.id}, so `schemaToFields`
  * records the field as an id.
  */
-exports.zodPeerId = zod_1.z.string().refine((value) => {
-    return (0, peer_id_1.isid)(value);
-}, {
-    message: "Invalid peer id, it must be a 25 character alphanumeric string",
-});
-exports.zodPeerId._def._fieldType = field_type_1.FieldType.id;
+exports.zodPeerId = peerIdSchema();
+/**
+ * A file's id, as `SystemFiles.save` returns it: a {@link zodPeerId} marked as a file reference
+ * (`subType: "file"`). A synced table's top-level field declared with it, or with an array of it,
+ * keeps the files it names: Peers frees a file's bytes only some time after no such field names
+ * it. Local-only tables, package variables, plain string fields, and nested object fields
+ * don't declare references.
+ *
+ * Changing a field to `zodFileId` changes the table's definition, so raise its `versionNumber`.
+ */
+exports.zodFileId = peerIdSchema(field_type_1.FILE_SUBTYPE);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peers-app/peers-sdk",
-  "version": "0.29.2",
+  "version": "0.30.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/peers-app/peers-sdk.git"