@peers-app/peers-sdk 0.14.0 → 0.15.0

package/dist/data/package-versions.js

@@ -52,28 +52,31 @@ const types_1 = require("./orm/types");
 const package_version_permissions_1 = require("./package-version-permissions");
 const schema = zod_1.z.object({
     packageVersionId: zod_types_1.zodPeerId,
-    packageId: zod_types_1.zodPeerId.describe('The package this version belongs to'),
+    packageId: zod_types_1.zodPeerId.describe("The package this version belongs to"),
     version: zod_1.z.string().describe('Semantic version string (e.g., "1.0.0")'),
     versionTag: zod_1.z.string().optional().describe('Version tag (e.g., "stable", "beta")'),
-    packageVersionHash: zod_1.z.string().describe('Hash of the combined bundle file hashes'),
-    packageBundleFileId: zod_types_1.zodPeerId.describe('File ID of the package bundle'),
-    packageBundleFileHash: zod_1.z.string().describe('Hash of the package bundle file'),
-    routesBundleFileId: zod_types_1.zodPeerId.optional().describe('File ID of the routes bundle'),
-    routesBundleFileHash: zod_1.z.string().optional().describe('Hash of the routes bundle'),
-    uiBundleFileId: zod_types_1.zodPeerId.optional().describe('File ID of the UI bundle'),
-    uiBundleFileHash: zod_1.z.string().optional().describe('Hash of the UI bundle'),
-    appNavs: app_nav_1.appNavSchema.array().optional().describe('The app navigation items that this version provides'),
-    signature: zod_1.z.string().describe('The signed hash of this data excluding the signature itself'),
-    createdBy: zod_types_1.zodPeerId.describe('The user who created this version'),
-    createdAt: zod_1.z.string().describe('ISO timestamp of when this version was created'),
+    packageVersionHash: zod_1.z.string().describe("Hash of the combined bundle file hashes"),
+    packageBundleFileId: zod_types_1.zodPeerId.describe("File ID of the package bundle"),
+    packageBundleFileHash: zod_1.z.string().describe("Hash of the package bundle file"),
+    routesBundleFileId: zod_types_1.zodPeerId.optional().describe("File ID of the routes bundle"),
+    routesBundleFileHash: zod_1.z.string().optional().describe("Hash of the routes bundle"),
+    uiBundleFileId: zod_types_1.zodPeerId.optional().describe("File ID of the UI bundle"),
+    uiBundleFileHash: zod_1.z.string().optional().describe("Hash of the UI bundle"),
+    appNavs: app_nav_1.appNavSchema
+        .array()
+        .optional()
+        .describe("The app navigation items that this version provides"),
+    signature: zod_1.z.string().describe("The signed hash of this data excluding the signature itself"),
+    createdBy: zod_types_1.zodPeerId.describe("The user who created this version"),
+    createdAt: zod_1.z.string().describe("ISO timestamp of when this version was created"),
 });
 const metaData = {
-    name: 'PackageVersions',
-    description: 'Versioned builds of packages',
-    primaryKeyName: 'packageVersionId',
-    iconClassName: 'bi bi-tag-fill',
+    name: "PackageVersions",
+    description: "Versioned builds of packages",
+    primaryKeyName: "packageVersionId",
+    iconClassName: "bi bi-tag-fill",
     fields: (0, types_1.schemaToFields)(schema),
-    indexes: [{ fields: ['packageId'] }],
+    indexes: [{ fields: ["packageId"] }],
 };
 let PackageVersionsTable = (() => {
     let _classSuper = table_1.Table;
@@ -105,20 +108,22 @@ let PackageVersionsTable = (() => {
                 await (0, package_version_permissions_1.verifyPackageVersionSignature)(packageVersion, this.groupId);
             }
             catch (err) {
-                throw new Error('Package version verification failed.  Did you mean to call `signAndSave`?', { cause: err });
+                throw new Error("Package version verification failed.  Did you mean to call `signAndSave`?", {
+                    cause: err,
+                });
             }
             return super.save(packageVersion, opts);
         }
         async signAndSave(packageVersion, opts) {
             if (!PackageVersionsTable.addSignatureToPackageVersion) {
-                throw new Error('Package version signing is not enabled. Call PackageVersionsTable.enablePackageVersionSigning(fn) to enable it.');
+                throw new Error("Package version signing is not enabled. Call PackageVersionsTable.enablePackageVersionSigning(fn) to enable it.");
             }
             packageVersion = await PackageVersionsTable.addSignatureToPackageVersion(packageVersion);
             return super.save(packageVersion, opts);
         }
         static addSignatureToPackageVersion = undefined;
         static enablePackageVersionSigning(fn) {
-            this.addSignatureToPackageVersion = fn;
+            PackageVersionsTable.addSignatureToPackageVersion = fn;
         }
         constructor() {
             super(...arguments);
@@ -135,18 +140,24 @@ function PackageVersions(dataContext) {
  * Compute a hash combining the bundle file hashes to uniquely identify this version's content.
  */
 function computePackageVersionHash(version, versionTag, packageBundleFileHash, routesBundleFileHash, uiBundleFileHash) {
-    return (0, keys_1.hashValue)([version, versionTag, packageBundleFileHash, routesBundleFileHash ?? '', uiBundleFileHash ?? ''].join(':'));
+    return (0, keys_1.hashValue)([
+        version,
+        versionTag,
+        packageBundleFileHash,
+        routesBundleFileHash ?? "",
+        uiBundleFileHash ?? "",
+    ].join(":"));
 }
 function isVersionInRange(activeVersion, incomingVersion, range) {
-    if (range === 'pinned')
+    if (range === "pinned")
         return false;
-    if (range === 'latest')
+    if (range === "latest")
         return true;
-    const [aMaj, aMin] = activeVersion.split('.').map(Number);
-    const [iMaj, iMin] = incomingVersion.split('.').map(Number);
-    if (range === 'patch')
+    const [aMaj, aMin] = activeVersion.split(".").map(Number);
+    const [iMaj, iMin] = incomingVersion.split(".").map(Number);
+    if (range === "patch")
         return aMaj === iMaj && aMin === iMin;
-    if (range === 'minor')
+    if (range === "minor")
         return aMaj === iMaj;
     return false;
 }
@@ -154,8 +165,8 @@ function isVersionInRange(activeVersion, incomingVersion, range) {
  * Returns true if incomingVersion is strictly newer than activeVersion (semver comparison).
  */
 function isNewerVersion(activeVersion, incomingVersion) {
-    const [aMaj = 0, aMin = 0, aPat = 0] = activeVersion.split('.').map(Number);
-    const [iMaj = 0, iMin = 0, iPat = 0] = incomingVersion.split('.').map(Number);
+    const [aMaj = 0, aMin = 0, aPat = 0] = activeVersion.split(".").map(Number);
+    const [iMaj = 0, iMin = 0, iPat = 0] = incomingVersion.split(".").map(Number);
     if (iMaj !== aMaj)
         return iMaj > aMaj;
     if (iMin !== aMin)
@@ -163,13 +174,16 @@ function isNewerVersion(activeVersion, incomingVersion) {
     return iPat > aPat;
 }
 function doesTagMatch(activeVersionTag, incomingVersionTag, followVersionTags, deviceVersionTag) {
-    const inTag = incomingVersionTag || 'stable';
+    const inTag = incomingVersionTag || "stable";
     if (deviceVersionTag)
         return inTag === deviceVersionTag;
     if (!followVersionTags) {
-        return inTag === (activeVersionTag || 'stable');
+        return inTag === (activeVersionTag || "stable");
     }
-    if (followVersionTags === '*')
+    if (followVersionTags === "*")
         return true;
-    return followVersionTags.split(',').map(t => t.trim()).includes(inTag);
+    return followVersionTags
+        .split(",")
+        .map((t) => t.trim())
+        .includes(inTag);
 }

package/dist/data/packages.d.ts

@@ -33,8 +33,8 @@ declare const schema: z.ZodObject<{
     name: string;
     description: string;
     signature: string;
-    createdBy: string;
     packageId: string;
+    createdBy: string;
     disabled?: boolean | undefined;
     appNavs?: {
         name: string;
@@ -50,8 +50,8 @@ declare const schema: z.ZodObject<{
     name: string;
     description: string;
     signature: string;
-    createdBy: string;
     packageId: string;
+    createdBy: string;
     disabled?: boolean | undefined;
     appNavs?: {
         name: string;

package/dist/data/packages.js

@@ -50,20 +50,34 @@ const schema = zod_1.z.object({
     packageId: zod_types_1.zodPeerId,
     name: zod_1.z.string(),
     description: zod_1.z.string(),
-    createdBy: zod_types_1.zodPeerId.describe('The user who created the package'),
-    disabled: zod_1.z.boolean().optional().describe("Whether the package's components should be loaded and included in the app runtime"),
-    remoteRepo: zod_1.z.string().optional().describe('The remote repository where the package is stored'),
-    appNavs: app_nav_1.appNavSchema.array().optional().describe('The app navigation items that this package provides'),
-    activePackageVersionId: zod_types_1.zodPeerId.optional().describe('FK to PackageVersions — the currently active version'),
-    versionFollowRange: zod_1.z.enum(['pinned', 'patch', 'minor', 'latest']).optional().describe('Auto-update range: pinned=never, patch=same major.minor, minor=same major, latest=always'),
-    followVersionTags: zod_1.z.string().optional().describe('Tag policy: undefined="current" (follow active tag), "*"=any tag, or CSV like "stable,prod"'),
-    signature: zod_1.z.string().describe('The signed hash of this data excluding the signature itself'),
+    createdBy: zod_types_1.zodPeerId.describe("The user who created the package"),
+    disabled: zod_1.z
+        .boolean()
+        .optional()
+        .describe("Whether the package's components should be loaded and included in the app runtime"),
+    remoteRepo: zod_1.z.string().optional().describe("The remote repository where the package is stored"),
+    appNavs: app_nav_1.appNavSchema
+        .array()
+        .optional()
+        .describe("The app navigation items that this package provides"),
+    activePackageVersionId: zod_types_1.zodPeerId
+        .optional()
+        .describe("FK to PackageVersions — the currently active version"),
+    versionFollowRange: zod_1.z
+        .enum(["pinned", "patch", "minor", "latest"])
+        .optional()
+        .describe("Auto-update range: pinned=never, patch=same major.minor, minor=same major, latest=always"),
+    followVersionTags: zod_1.z
+        .string()
+        .optional()
+        .describe('Tag policy: undefined="current" (follow active tag), "*"=any tag, or CSV like "stable,prod"'),
+    signature: zod_1.z.string().describe("The signed hash of this data excluding the signature itself"),
 });
 const metaData = {
-    name: 'Packages',
-    description: 'The Peers packages that this computer is aware of (some may be disabled)',
-    primaryKeyName: 'packageId',
-    iconClassName: 'bi bi-box-fill',
+    name: "Packages",
+    description: "The Peers packages that this computer is aware of (some may be disabled)",
+    primaryKeyName: "packageId",
+    iconClassName: "bi bi-box-fill",
     fields: (0, types_1.schemaToFields)(schema),
 };
 let PackagesTable = (() => {
@@ -96,20 +110,22 @@ let PackagesTable = (() => {
                 await (0, package_permissions_1.verifyPackageSignature)(packageObj, this.groupId);
             }
             catch (err) {
-                throw new Error('Package verification failed.  Did you mean to call `signAndSave`?', { cause: err });
+                throw new Error("Package verification failed.  Did you mean to call `signAndSave`?", {
+                    cause: err,
+                });
             }
             return super.save(packageObj, opts);
         }
         async signAndSave(packageObj, opts) {
             if (!PackagesTable.addSignatureToPackage) {
-                throw new Error('Package signing is not enabled. Call PackagesTable.enablePackageSigning(fn) to enable it.');
+                throw new Error("Package signing is not enabled. Call PackagesTable.enablePackageSigning(fn) to enable it.");
             }
             packageObj = await PackagesTable.addSignatureToPackage(packageObj);
             return super.save(packageObj, opts);
         }
         static addSignatureToPackage = undefined;
         static enablePackageSigning(fn) {
-            this.addSignatureToPackage = fn;
+            PackagesTable.addSignatureToPackage = fn;
         }
         async delete(packageId) {
             // anyone (with write permissions) can delete packages since that isn't a security risk (unless something else is relying on a package to be present?)
@@ -132,6 +148,8 @@ exports.PackagesTable = PackagesTable;
 function Packages(dataContext) {
     return (0, context_1.getTableContainer)(dataContext).getTable(metaData, schema, PackagesTable);
 }
-exports.packagesRootDir = '~/peers/packages';
-exports.reloadPackagesOnPageRefresh = (0, persistent_vars_1.deviceVar)('reloadPackagesOnPageRefresh', { defaultValue: true, });
-exports.autoUpdatePeersCore = (0, persistent_vars_1.deviceVar)('autoUpdatePeersCore', { defaultValue: true });
+exports.packagesRootDir = "~/peers/packages";
+exports.reloadPackagesOnPageRefresh = (0, persistent_vars_1.deviceVar)("reloadPackagesOnPageRefresh", {
+    defaultValue: true,
+});
+exports.autoUpdatePeersCore = (0, persistent_vars_1.deviceVar)("autoUpdatePeersCore", { defaultValue: true });

package/dist/data/packages.utils.d.ts

@@ -1,3 +1,3 @@
-import { IPackage } from "./packages";
-import { DataContext } from "../context/data-context";
+import type { DataContext } from "../context/data-context";
+import { type IPackage } from "./packages";
 export declare function copyPackageToAnotherDataContext(packageId: string, fromDataContext: DataContext, toDataContext: DataContext): Promise<IPackage>;

package/dist/data/packages.utils.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.copyPackageToAnotherDataContext = copyPackageToAnotherDataContext;
-const packages_1 = require("./packages");
 const files_1 = require("./files");
 const package_versions_1 = require("./package-versions");
+const packages_1 = require("./packages");
 async function copyBundleFile(fileId, fromFiles, toFiles, label) {
     if (!fileId)
         return;
@@ -29,9 +29,9 @@ async function copyPackageToAnotherDataContext(packageId, fromDataContext, toDat
         const toPvTable = (0, package_versions_1.PackageVersions)(toDataContext);
         const pv = await fromPvTable.get(pkg.activePackageVersionId);
         if (pv) {
-            await copyBundleFile(pv.packageBundleFileId, fromFiles, toFiles, 'Version package bundle');
-            await copyBundleFile(pv.routesBundleFileId, fromFiles, toFiles, 'Version routes bundle');
-            await copyBundleFile(pv.uiBundleFileId, fromFiles, toFiles, 'Version UI bundle');
+            await copyBundleFile(pv.packageBundleFileId, fromFiles, toFiles, "Version package bundle");
+            await copyBundleFile(pv.routesBundleFileId, fromFiles, toFiles, "Version routes bundle");
+            await copyBundleFile(pv.uiBundleFileId, fromFiles, toFiles, "Version UI bundle");
             await toPvTable.signAndSave(pv, { saveAsSnapshot: true });
         }
     }

package/dist/data/persistent-vars.d.ts

@@ -5,12 +5,12 @@
  * (requires SQLite which is not available in peers-sdk)
  */
 import { z } from "zod";
-import { UserContext } from "../context";
+import type { UserContext } from "../context";
 import type { DataContext } from "../context/data-context";
-import { Observable } from "../observable";
-import { ISaveOptions } from "./orm";
+import { type Observable } from "../observable";
+import type { ISaveOptions } from "./orm";
 import { Table } from "./orm/table";
-import { ITableMetaData } from "./orm/types";
+import { type ITableMetaData } from "./orm/types";
 declare const schema: z.ZodObject<{
     persistentVarId: z.ZodEffects<z.ZodString, string, string>;
     name: z.ZodString;
@@ -65,7 +65,7 @@ export type PersistentVar<T> = Observable<T> & {
 };
 export declare function getPersistentVar(name: string, dataContext?: DataContext): Promise<IPersistentVar | undefined>;
 interface IPersistentVarOptionsBase {
-    scope?: 'device' | 'user' | 'group' | 'groupDevice' | 'groupUser';
+    scope?: "device" | "user" | "group" | "groupDevice" | "groupUser";
     userContext?: UserContext;
     dataContext?: DataContext;
     isSecret?: boolean;
@@ -81,30 +81,30 @@ interface IPersistentVarOptionsWithoutDefault<T> extends IPersistentVarOptionsBa
 /**
  * A persistent variable that is stored only on this device, in the user's personal db
  */
-export declare function deviceVar<T = string>(name: string, opts: Omit<IPersistentVarOptionsWithDefault<T>, 'scope' | 'dataContext'>): PersistentVar<T>;
-export declare function deviceVar<T = string>(name: string, opts?: Omit<IPersistentVarOptionsWithoutDefault<T>, 'scope' | 'dataContext'>): PersistentVar<T | undefined>;
+export declare function deviceVar<T = string>(name: string, opts: Omit<IPersistentVarOptionsWithDefault<T>, "scope" | "dataContext">): PersistentVar<T>;
+export declare function deviceVar<T = string>(name: string, opts?: Omit<IPersistentVarOptionsWithoutDefault<T>, "scope" | "dataContext">): PersistentVar<T | undefined>;
 /**
  * A persistent variable that is stored in the user's personal db and synced across all their devices
  */
-export declare function userVar<T = string>(name: string, opts: Omit<IPersistentVarOptionsWithDefault<T>, 'scope' | 'dataContext'>): PersistentVar<T>;
-export declare function userVar<T = string>(name: string, opts?: Omit<IPersistentVarOptionsWithoutDefault<T>, 'scope' | 'dataContext'>): PersistentVar<T | undefined>;
+export declare function userVar<T = string>(name: string, opts: Omit<IPersistentVarOptionsWithDefault<T>, "scope" | "dataContext">): PersistentVar<T>;
+export declare function userVar<T = string>(name: string, opts?: Omit<IPersistentVarOptionsWithoutDefault<T>, "scope" | "dataContext">): PersistentVar<T | undefined>;
 /**
  * A persistent variable that is shared by all users in a group. It is stored in the group's db and synced across all users and devices in the group.
  * It can have a different value for each group on the device.
  * If secret=true, it is encrypted with the group's secret key
  */
-export declare function groupVar<T = string>(name: string, opts: Omit<IPersistentVarOptionsWithDefault<T>, 'scope'>): PersistentVar<T>;
-export declare function groupVar<T = string>(name: string, opts?: Omit<IPersistentVarOptionsWithoutDefault<T>, 'scope'>): PersistentVar<T | undefined>;
+export declare function groupVar<T = string>(name: string, opts: Omit<IPersistentVarOptionsWithDefault<T>, "scope">): PersistentVar<T>;
+export declare function groupVar<T = string>(name: string, opts?: Omit<IPersistentVarOptionsWithoutDefault<T>, "scope">): PersistentVar<T | undefined>;
 /**
  * A persistent variable that is stored only on this device, in the user's personal db.
  * It can have a different value for each group on the device but is not synced to other devices.
  */
-export declare function groupDeviceVar<T = string>(name: string, opts: Omit<IPersistentVarOptionsWithDefault<T>, 'scope'>): PersistentVar<T>;
-export declare function groupDeviceVar<T = string>(name: string, opts?: Omit<IPersistentVarOptionsWithoutDefault<T>, 'scope'>): PersistentVar<T | undefined>;
+export declare function groupDeviceVar<T = string>(name: string, opts: Omit<IPersistentVarOptionsWithDefault<T>, "scope">): PersistentVar<T>;
+export declare function groupDeviceVar<T = string>(name: string, opts?: Omit<IPersistentVarOptionsWithoutDefault<T>, "scope">): PersistentVar<T | undefined>;
 /**
  * A persistent variable that is stored in the user's personal db and synced across all their devices in the group.
  * It can have a different value for each user in the group and a different value for each group the user is in.
  */
-export declare function groupUserVar<T = string>(name: string, opts: Omit<IPersistentVarOptionsWithDefault<T>, 'scope'>): PersistentVar<T>;
-export declare function groupUserVar<T = string>(name: string, opts?: Omit<IPersistentVarOptionsWithoutDefault<T>, 'scope'>): PersistentVar<T | undefined>;
+export declare function groupUserVar<T = string>(name: string, opts: Omit<IPersistentVarOptionsWithDefault<T>, "scope">): PersistentVar<T>;
+export declare function groupUserVar<T = string>(name: string, opts?: Omit<IPersistentVarOptionsWithoutDefault<T>, "scope">): PersistentVar<T | undefined>;
 export {};