@phis/contracts 0.7.4 → 0.7.5

package/README.md

@@ -26,6 +26,15 @@ and change at different moments.
 @phis/contracts/server-capabilities  the capability snapshot phis reports and the UI acts on
 @phis/contracts/site-groups          the membership levels of a Site group, as both ends count them
 @phis/contracts/user-state           the shapes a Module may keep a person's decisions in, and the key grammar
+@phis/contracts/references           the Page reference grammar both sides derive and compare
+@phis/contracts/resource-links       the links from a Phi record into an Add-on's own system
+@phis/contracts/support              the Support ticket vocabulary
+@phis/contracts/threads              the thread vocabulary
+@phis/contracts/conditions           the runtime condition descriptors
+@phis/contracts/controls             the Control descriptors
+@phis/contracts/forms                the Form descriptors and their parsers
+@phis/contracts/layout               the layout vocabulary
+@phis/contracts/timeline             the timeline entries
 ```
 
 ## Before the v1 release, interface versions stay at 1
@@ -74,7 +83,8 @@ What it covers:
 - **Schema** -- `PhisAddonSchemaDescriptor` and its column, index and constraint descriptors. Tables are
   declared, not migrated by hand; phis applies them.
 - **Service kinds** -- the Core-owned kinds an Add-on may supply an implementation of: Media Storage
-  (`PhisMediaStorageAdapter`, upload plans, object I/O) and Directory. `PHIS_SERVICE_KINDS` names them
+  (`PhisMediaStorageAdapter`, upload plans, object I/O), Directory, Payments, Translation and Support
+  Forwarding. `PHIS_SERVICE_KINDS` names them
   and `PHIS_SERVICE_INTERFACE_DIGESTS` holds the digest of each kind's current interface; Core refuses an
   Add-on built against a different digest at install.
 - **Core capabilities** -- `PHIS_CORE_CAPABILITIES`, the catalogue ids an Add-on may require. Declare
@@ -182,7 +192,8 @@ URL is built stays with each side, and phis's numeric Space kind never reaches a
 ## `/http`
 
 The request header names phis reads and the site UI writes: `PHIS_TOKEN_HEADER` (`x-phis-token`),
-`PHIS_SITE_KEY_HEADER`, `PHIS_AREA_HEADER`, `PHIS_REQUEST_PATH_HEADER` and `PHIS_REQUEST_SEARCH_HEADER`.
+`PHIS_SITE_KEY_HEADER`, `PHIS_AREA_HEADER`, `PHIS_REQUEST_PATH_HEADER`, `PHIS_REQUEST_SEARCH_HEADER` and
+`PHIS_FORM_RELAY_HEADER`.
 A disagreement here is not a type error but a 403 or 400 at runtime.
 
 ## `/locale`

package/dist/access.d.ts

@@ -85,7 +85,6 @@ export declare const PhiUserEmailSource: {
     readonly GitHub: 23;
 };
 export type PhiUserEmailSourceValue = (typeof PhiUserEmailSource)[keyof typeof PhiUserEmailSource];
-export declare function isPhiUserEmailSource(value: unknown): value is PhiUserEmailSourceValue;
 /**
  * Which source a login provider's key stands for.
  *
@@ -168,6 +167,10 @@ export declare function canPhiAccessSubjectReach(subject: PhiAccessSubject, poli
  * keeping stable.
  */
 export declare function isPhiAccessPolicyProviderOwned(policy: PhiViewerAccessPolicy, ownerProviderId?: PhiRoleProviderId | null): boolean;
+/** Whether a value is a provider id: `@scope/name`, with further segments allowed. */
+export declare function isPhiProviderId(value: unknown): value is `@${string}/${string}`;
+/** Whether a value is a Site group key, as `phis.site_groups.key` accepts it. */
+export declare function isPhiSiteGroupKey(value: unknown): value is string;
 /**
  * Reads a stored descriptor back into a policy, or null.
  *

package/dist/access.js

@@ -84,10 +84,6 @@ export const PhiUserEmailSource = {
     Microsoft: 22,
     GitHub: 23,
 };
-export function isPhiUserEmailSource(value) {
-    return typeof value === "number"
-        && Object.values(PhiUserEmailSource).includes(value);
-}
 /**
  * Which source a login provider's key stands for.
  *
@@ -182,6 +178,14 @@ export function isPhiAccessPolicyProviderOwned(policy, ownerProviderId) {
 }
 const PROVIDER_ID_PATTERN = /^@[^/]+\/[^/]+(?:\/[^/]+)*$/;
 const GROUP_KEY_PATTERN = /^[a-z0-9][a-z0-9._-]{0,159}$/u;
+/** Whether a value is a provider id: `@scope/name`, with further segments allowed. */
+export function isPhiProviderId(value) {
+    return typeof value === "string" && PROVIDER_ID_PATTERN.test(value);
+}
+/** Whether a value is a Site group key, as `phis.site_groups.key` accepts it. */
+export function isPhiSiteGroupKey(value) {
+    return typeof value === "string" && GROUP_KEY_PATTERN.test(value);
+}
 /** The same shape an Add-on manifest may declare a role under. */
 const ADDON_ROLE_NAME_PATTERN = /^[a-z][a-z0-9-]{0,63}$/;
 /**

package/dist/media-storage.d.ts

@@ -294,7 +294,7 @@ export type PhiMediaUploadCompletionInput = {
  */
 export declare const PHIS_MEDIA_CHECKSUM_ALGORITHMS: readonly ["sha256", "sha512", "sha256-composite", "xxhash128", "crc64nvme", "crc32c", "crc32", "md5"];
 export type PhisMediaChecksumAlgorithm = (typeof PHIS_MEDIA_CHECKSUM_ALGORITHMS)[number];
-export { PHIS_MEDIA_UPLOAD_MAX_PART_COUNT, PHIS_MEDIA_UPLOAD_PART_SIZE_BYTES, formatPhiMediaCompositeChecksum, parsePhiMediaCompositeChecksum, resolvePhiMediaUploadPartCount, resolvePhiMediaUploadPartSizeBytes, } from "./media.js";
+export { PHIS_MEDIA_UPLOAD_MAX_PART_COUNT, PHIS_MEDIA_UPLOAD_PART_SIZE_BYTES, formatPhiMediaCompositeChecksum, resolvePhiMediaUploadPartCount, resolvePhiMediaUploadPartSizeBytes, } from "./media.js";
 /**
  * The digests strong enough to answer "is this the same file", rather than only "did it arrive intact".
  *

package/dist/media-storage.js

@@ -36,7 +36,7 @@ export const PHIS_MEDIA_CHECKSUM_ALGORITHMS = [
  * that request is signed. So the rule cannot sit behind the Add-on surface, and it must not be written
  * twice -- two copies of a division are two divisions the day one of them is edited.
  */
-export { PHIS_MEDIA_UPLOAD_MAX_PART_COUNT, PHIS_MEDIA_UPLOAD_PART_SIZE_BYTES, formatPhiMediaCompositeChecksum, parsePhiMediaCompositeChecksum, resolvePhiMediaUploadPartCount, resolvePhiMediaUploadPartSizeBytes, } from "./media.js";
+export { PHIS_MEDIA_UPLOAD_MAX_PART_COUNT, PHIS_MEDIA_UPLOAD_PART_SIZE_BYTES, formatPhiMediaCompositeChecksum, resolvePhiMediaUploadPartCount, resolvePhiMediaUploadPartSizeBytes, } from "./media.js";
 /**
  * The digests strong enough to answer "is this the same file", rather than only "did it arrive intact".
  *

package/dist/media.d.ts

@@ -265,8 +265,3 @@ export declare function resolvePhiMediaUploadPartCount(sizeBytes: number): numbe
  * SHA-256 that simply failed to match. Naming the division makes a mismatch legible instead of puzzling.
  */
 export declare function formatPhiMediaCompositeChecksum(digestHex: string, partCount: number, partSizeBytes: number): string;
-export declare function parsePhiMediaCompositeChecksum(value: string): {
-    digest: string;
-    partCount: number;
-    partSizeBytes: number;
-} | null;

package/dist/media.js

@@ -409,13 +409,3 @@ export function resolvePhiMediaUploadPartCount(sizeBytes) {
 export function formatPhiMediaCompositeChecksum(digestHex, partCount, partSizeBytes) {
     return `${digestHex.toLowerCase()}-${partCount}-${partSizeBytes}`;
 }
-export function parsePhiMediaCompositeChecksum(value) {
-    const match = /^([0-9a-f]{64})-(\d{1,5})-(\d{1,12})$/u.exec(value.trim().toLowerCase());
-    if (!match)
-        return null;
-    const partCount = Number(match[2]);
-    const partSizeBytes = Number(match[3]);
-    if (partCount < 1 || partSizeBytes < 1)
-        return null;
-    return { digest: match[1], partCount, partSizeBytes };
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phis/contracts",
-  "version": "0.7.4",
+  "version": "0.7.5",
   "license": "Apache-2.0",
   "type": "module",
   "publishConfig": {