@protobase/schema 0.40.9 → 0.41.0

package/dist/internal.d.ts

@@ -26,6 +26,7 @@ import { layoutItems } from "./layout-items.js";
 import { viewOfList } from "./named-list.js";
 import { Locale, isLocale, locales, pickLocale } from "./locale.js";
 import { apiOriginMeta } from "./api-origin-meta.js";
+import { MobileReleaseAnswer, mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, releaseManifestFile } from "./mobile-release-address.js";
 import { authBasePath } from "./auth-base-path.js";
 import { capacitorOrigin } from "./capacitor-origins.js";
-export { type AddressCheck, type FormulaNode, type Locale, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type SearchTerm, actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, boardErrors, bottomBarFor, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefField, hrefPlaceholders, inRange, isFieldRef, isGroupChart, isLocale, layoutItems, leavesApp, linkActionError, locales, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseCapability, parseFormula, parseSize, parseTable, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, readEventStream, redactSecrets, renderPrompt, searchTerms, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };
+export { type AddressCheck, type FormulaNode, type Locale, type MobileReleaseAnswer, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type SearchTerm, actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, boardErrors, bottomBarFor, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefField, hrefPlaceholders, inRange, isFieldRef, isGroupChart, isLocale, layoutItems, leavesApp, linkActionError, locales, markFieldRefs, matchedSearchField, matchesSearch, mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, navRecentErrors, parseCapability, parseFormula, parseSize, parseTable, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, readEventStream, redactSecrets, releaseManifestFile, renderPrompt, searchTerms, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };

package/dist/internal.js

@@ -26,6 +26,7 @@ import { applyAssistantEvent, emptyAssistantState } from "./assistant/apply-even
 import { readEventStream } from "./assistant/event-stream.js";
 import { isLocale, locales, pickLocale } from "./locale.js";
 import { apiOriginMeta } from "./api-origin-meta.js";
+import { mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, releaseManifestFile } from "./mobile-release-address.js";
 import { authBasePath } from "./auth-base-path.js";
 import { capacitorOrigin } from "./capacitor-origins.js";
-export { actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, boardErrors, bottomBarFor, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefField, hrefPlaceholders, inRange, isFieldRef, isGroupChart, isLocale, layoutItems, leavesApp, linkActionError, locales, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseCapability, parseFormula, parseSize, parseTable, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, readEventStream, redactSecrets, renderPrompt, searchTerms, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };
+export { actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, boardErrors, bottomBarFor, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefField, hrefPlaceholders, inRange, isFieldRef, isGroupChart, isLocale, layoutItems, leavesApp, linkActionError, locales, markFieldRefs, matchedSearchField, matchesSearch, mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, navRecentErrors, parseCapability, parseFormula, parseSize, parseTable, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, readEventStream, redactSecrets, releaseManifestFile, renderPrompt, searchTerms, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };

package/dist/mobile-release-address.d.ts

@@ -0,0 +1,38 @@
+//#region src/mobile-release-address.d.ts
+/** The query parameters of the mobile release answer. Only `mobileReleaseQuery` writes them. */
+export declare const mobileReleaseParams: {
+  /** The native fingerprint of the binary asking (`ProtobaseNative/<fingerprint>` in its user agent). */
+  readonly fingerprint: "fingerprint";
+  /** The Protobase version of the shell the device runs, which says whether the update is required. */
+  readonly shellVersion: "shell_version";
+};
+/** Where a device asks which release it should run: `GET` with the `mobileReleaseParams`. */
+export declare const mobileReleasePath = "/api/mobile/release";
+/** Where the releases' files are served, each release under its bundle id (see `mobileReleaseBasePath`). */
+export declare const mobileReleasesPath = "/api/mobile/releases";
+/**
+ * The updater's manifest, a JSON array of `{ href, checksum, sizeInBytes }` (checksum the file's sha256 in hex): the
+ * file name `@capawesome/capacitor-live-update` reads in a release and in the app's own files.
+ */
+export declare const releaseManifestFile = "capawesome-live-update-manifest.json";
+/**
+ * The base URL path of the release `bundleId`: the updater fetches `<base>?href=<file>` for its manifest and each file.
+ * The id sits in the path because the iOS updater replaces the base URL's whole query when it adds `href`.
+ */
+export declare const mobileReleaseBasePath: (bundleId: string) => string;
+/** The query of the mobile release answer for a binary of `fingerprint` running a shell of `shellVersion`. */
+export declare const mobileReleaseQuery: ({ fingerprint, shellVersion }: {
+  fingerprint: string;
+  shellVersion: string;
+}) => string;
+/**
+ * The mobile release answer: the release the device should run, `bundleId` and `url` (the absolute base URL) both
+ * null when none runs on its binary, and whether the update is required, since the shell it runs no longer works with
+ * the server's API.
+ */
+export type MobileReleaseAnswer = {
+  bundleId: string | null;
+  url: string | null;
+  required: boolean;
+};
+//#endregion

package/dist/mobile-release-address.js

@@ -0,0 +1,29 @@
+//#region src/mobile-release-address.ts
+/** The query parameters of the mobile release answer. Only `mobileReleaseQuery` writes them. */
+const mobileReleaseParams = {
+	/** The native fingerprint of the binary asking (`ProtobaseNative/<fingerprint>` in its user agent). */
+	fingerprint: "fingerprint",
+	/** The Protobase version of the shell the device runs, which says whether the update is required. */
+	shellVersion: "shell_version"
+};
+/** Where a device asks which release it should run: `GET` with the `mobileReleaseParams`. */
+const mobileReleasePath = "/api/mobile/release";
+/** Where the releases' files are served, each release under its bundle id (see `mobileReleaseBasePath`). */
+const mobileReleasesPath = "/api/mobile/releases";
+/**
+* The updater's manifest, a JSON array of `{ href, checksum, sizeInBytes }` (checksum the file's sha256 in hex): the
+* file name `@capawesome/capacitor-live-update` reads in a release and in the app's own files.
+*/
+const releaseManifestFile = "capawesome-live-update-manifest.json";
+/**
+* The base URL path of the release `bundleId`: the updater fetches `<base>?href=<file>` for its manifest and each file.
+* The id sits in the path because the iOS updater replaces the base URL's whole query when it adds `href`.
+*/
+const mobileReleaseBasePath = (bundleId) => `${mobileReleasesPath}/${encodeURIComponent(bundleId)}`;
+/** The query of the mobile release answer for a binary of `fingerprint` running a shell of `shellVersion`. */
+const mobileReleaseQuery = ({ fingerprint, shellVersion }) => new URLSearchParams({
+	[mobileReleaseParams.fingerprint]: fingerprint,
+	[mobileReleaseParams.shellVersion]: shellVersion
+}).toString();
+//#endregion
+export { mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, releaseManifestFile };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/schema",
-  "version": "0.40.9",
+  "version": "0.41.0",
   "description": "Resource, field, view and access definitions for Protobase configs.",
   "license": "Apache-2.0",
   "repository": {