@exponential_app/engine 0.0.0-stage → 0.1.1

package/dist/types/domain-contract/src/app-share.d.ts

@@ -0,0 +1,222 @@
+export declare const APP_SHARE: {
+    $comment: string;
+    tokenBytes: number;
+    urlPrefix: string;
+    testIds: {
+        shareLinks: string;
+        shareRow: string;
+    };
+    outcomes: string[];
+    caps: {
+        perIpPerHour: number;
+        perLinkPerHour: number;
+        maxBodyBytes: number;
+        viewRows: number;
+        viewPerIpPerHour: number;
+        auditDays: number;
+    };
+    copy: {
+        title: string;
+        submit: string;
+        view: string;
+        off: string;
+        on: string;
+        expired: string;
+        orphaned: string;
+        expiresOn: string;
+        copyLink: string;
+        newLink: string;
+        guest: string;
+        gone: string;
+        tooMany: string;
+        closed: string;
+        thanks: string;
+    };
+    expiryChoices: ({
+        days: number;
+        label: string;
+    } | {
+        days: null;
+        label: string;
+    })[];
+    stateCases: ({
+        name: string;
+        link: null;
+        declared: boolean;
+        now: string;
+        state: string;
+    } | {
+        name: string;
+        link: {
+            revokedAt: null;
+            expiresAt: null;
+        };
+        declared: boolean;
+        now: string;
+        state: string;
+    } | {
+        name: string;
+        link: {
+            revokedAt: null;
+            expiresAt: string;
+        };
+        declared: boolean;
+        now: string;
+        state: string;
+    } | {
+        name: string;
+        link: {
+            revokedAt: string;
+            expiresAt: string;
+        };
+        declared: boolean;
+        now: string;
+        state: string;
+    })[];
+    capCases: {
+        name: string;
+        ipCount: number;
+        linkCount: number;
+        allowed: boolean;
+    }[];
+    fieldCases: ({
+        name: string;
+        schema: {
+            type: string;
+            required: string[];
+            properties: {
+                title: {
+                    type: string;
+                };
+                note: {
+                    type: string;
+                };
+                amount?: undefined;
+                receipt?: undefined;
+            };
+        };
+        fields: string[];
+        submit: string[];
+        view: string[];
+    } | {
+        name: string;
+        schema: {
+            type: string;
+            required: string[];
+            properties: {
+                title: {
+                    type: string;
+                };
+                amount: {
+                    type: string;
+                };
+                receipt: {
+                    type: string;
+                    format: string;
+                };
+                note?: undefined;
+            };
+        };
+        submit: string[];
+        view: string[];
+        fields?: undefined;
+    })[];
+    bylineCases: ({
+        name: string;
+        shareName: string;
+        byline: string;
+        text: string;
+    } | {
+        name: string;
+        shareName: null;
+        byline: string;
+        text: string;
+    })[];
+    rowCases: ({
+        name: string;
+        mode: string;
+        state: string;
+        expiresAt: null;
+        text: string;
+    } | {
+        name: string;
+        mode: string;
+        state: string;
+        expiresAt: string;
+        text: string;
+    })[];
+    historyCases: {
+        name: string;
+        via: string;
+        actor: string;
+        names: {
+            u1: string;
+        };
+        who: string;
+    }[];
+    switchCases: {
+        state: string;
+        on: boolean;
+    }[];
+};
+export declare const APP_SHARE_COPY: {
+    title: string;
+    submit: string;
+    view: string;
+    off: string;
+    on: string;
+    expired: string;
+    orphaned: string;
+    expiresOn: string;
+    copyLink: string;
+    newLink: string;
+    guest: string;
+    gone: string;
+    tooMany: string;
+    closed: string;
+    thanks: string;
+};
+export declare const APP_SHARE_CAPS: {
+    perIpPerHour: number;
+    perLinkPerHour: number;
+    maxBodyBytes: number;
+    viewRows: number;
+    viewPerIpPerHour: number;
+    auditDays: number;
+};
+/** VAPP-247: the Public links row's expiry items, in menu order (`days` null = never). */
+export declare const APP_SHARE_EXPIRY_CHOICES: readonly {
+    days: number | null;
+    label: string;
+}[];
+export type ShareLinkState = `off` | `on` | `expired` | `orphaned`;
+export type ShareMode = `submit` | `view`;
+export interface ShareSchema {
+    required?: string[];
+    properties: Record<string, {
+        format?: string;
+        items?: {
+            format?: string;
+        };
+        type?: string;
+    }>;
+}
+/** A link's state at `now` (`stateCases`); `declared` = the published
+ *  package still declares the share. */
+export declare function linkState(link: {
+    revokedAt: string | null;
+    expiresAt: string | null;
+} | null, declared: boolean, now: string): ShareLinkState;
+/** May one more submission land (`capCases`)? */
+export declare function underShareCaps(ipCount: number, linkCount: number): boolean;
+/** The fields a link exposes (`fieldCases`): the declared `fields` in their
+ *  order, else the Data tab's order (required, then by name); unknown names
+ *  and files dropped. */
+export declare function shareFields(schema: ShareSchema, fields?: readonly string[]): string[];
+/** The By/author label (`bylineCases`): a shared record reads Guest. */
+export declare function shareByline(shareName: string | null | undefined, byline: string): string;
+/** A Settings row's subtitle (`rowCases`). */
+export declare function shareRowSubtitle(mode: ShareMode, state: ShareLinkState, expiresAt: string | null): string;
+/** A Settings row's Switch (`switchCases`): an orphaned link still reads on,
+ *  so its owner can revoke it. */
+export declare function shareSwitchOn(state: ShareLinkState): boolean;