@fungi.computer/gills 0.0.0-stage → 0.1.0

package/dist/rows.d.ts

@@ -0,0 +1,78 @@
+import * as Schema from "effect/Schema";
+/** Nonempty display text, bounded to 4,096 characters. */
+export declare const rowLabelSchemaV1: Schema.String;
+/** Producer-owned row identity, bounded to 513 characters. */
+export declare const rowIdentitySchemaV1: Schema.String;
+/** A navigation parameter interpreted only by the receiving App. */
+export declare const rowOpenSchemaV1: Schema.Struct<{
+    readonly params: Schema.$Array<Schema.Struct<{
+        readonly key: Schema.String;
+        readonly value: Schema.String;
+    }>>;
+}>;
+/** A bounded text row; each receiving host authorizes its open target. */
+export declare const rowSchemaV1: Schema.Struct<{
+    readonly id: Schema.String;
+    readonly title: Schema.String;
+    readonly detail: Schema.optional<Schema.String>;
+    readonly tone: Schema.optional<Schema.Literals<readonly ["attention", "running", "error", "settled", "muted"]>>;
+    /** App-owned status text with the semantic colors used by Caps Status. */
+    readonly status: Schema.optional<Schema.Struct<{
+        readonly label: Schema.String;
+        readonly tone: Schema.Literals<readonly ["neutral", "primary", "secondary", "accent", "success", "info", "warning", "error"]>;
+    }>>;
+    /** The host supplies this Gill's App identity; rows only select its view. */
+    readonly open: Schema.optional<Schema.Struct<{
+        readonly params: Schema.$Array<Schema.Struct<{
+            readonly key: Schema.String;
+            readonly value: Schema.String;
+        }>>;
+    }>>;
+}>;
+/** One shared, bounded data row; the host owns navigation and execution. */
+export type RowV1 = Schema.Schema.Type<typeof rowSchemaV1>;
+/** A page containing at most 200 shared rows. */
+export declare const rowPageSchemaV1: Schema.$Array<Schema.Struct<{
+    readonly id: Schema.String;
+    readonly title: Schema.String;
+    readonly detail: Schema.optional<Schema.String>;
+    readonly tone: Schema.optional<Schema.Literals<readonly ["attention", "running", "error", "settled", "muted"]>>;
+    /** App-owned status text with the semantic colors used by Caps Status. */
+    readonly status: Schema.optional<Schema.Struct<{
+        readonly label: Schema.String;
+        readonly tone: Schema.Literals<readonly ["neutral", "primary", "secondary", "accent", "success", "info", "warning", "error"]>;
+    }>>;
+    /** The host supplies this Gill's App identity; rows only select its view. */
+    readonly open: Schema.optional<Schema.Struct<{
+        readonly params: Schema.$Array<Schema.Struct<{
+            readonly key: Schema.String;
+            readonly value: Schema.String;
+        }>>;
+    }>>;
+}>>;
+/** A finished App call as a person reads it: a shared row plus an optional thumbnail. */
+export declare const resultRowSchemaV1: Schema.Struct<{
+    /** A Computer file the receiving host may preview; the host authorizes the read. */
+    readonly media: Schema.optional<Schema.Struct<{
+        readonly path: Schema.String;
+        readonly format: Schema.Literals<readonly ["fungi:image", "fungi:video"]>;
+    }>>;
+    readonly id: Schema.String;
+    readonly title: Schema.String;
+    readonly detail: Schema.optional<Schema.String>;
+    readonly tone: Schema.optional<Schema.Literals<readonly ["attention", "running", "error", "settled", "muted"]>>;
+    /** App-owned status text with the semantic colors used by Caps Status. */
+    readonly status: Schema.optional<Schema.Struct<{
+        readonly label: Schema.String;
+        readonly tone: Schema.Literals<readonly ["neutral", "primary", "secondary", "accent", "success", "info", "warning", "error"]>;
+    }>>;
+    /** The host supplies this Gill's App identity; rows only select its view. */
+    readonly open: Schema.optional<Schema.Struct<{
+        readonly params: Schema.$Array<Schema.Struct<{
+            readonly key: Schema.String;
+            readonly value: Schema.String;
+        }>>;
+    }>>;
+}>;
+/** One shared result row; navigation and previews stay host-authorized. */
+export type ResultRow = Schema.Schema.Type<typeof resultRowSchemaV1>;

package/dist/rows.js

@@ -0,0 +1,46 @@
+import * as Schema from "effect/Schema";
+/** Nonempty display text, bounded to 4,096 characters. */
+export const rowLabelSchemaV1 = Schema.String.pipe(Schema.check(Schema.isMinLength(1)), Schema.check(Schema.isMaxLength(4_096)));
+/** Producer-owned row identity, bounded to 513 characters. */
+export const rowIdentitySchemaV1 = Schema.String.pipe(Schema.check(Schema.isMinLength(1)), Schema.check(Schema.isMaxLength(513)));
+/** A navigation parameter interpreted only by the receiving App. */
+export const rowOpenSchemaV1 = Schema.Struct({
+    params: Schema.Array(Schema.Struct({
+        key: Schema.String.check(Schema.isMinLength(1), Schema.isMaxLength(64)),
+        value: Schema.String.check(Schema.isMaxLength(4_096)),
+    })).check(Schema.isMaxLength(16)),
+});
+/** A bounded text row; each receiving host authorizes its open target. */
+export const rowSchemaV1 = Schema.Struct({
+    id: rowIdentitySchemaV1,
+    title: rowLabelSchemaV1,
+    detail: Schema.optional(Schema.String.pipe(Schema.check(Schema.isMaxLength(1_024)))),
+    tone: Schema.optional(Schema.Literals(["attention", "running", "error", "settled", "muted"])),
+    /** App-owned status text with the semantic colors used by Caps Status. */
+    status: Schema.optional(Schema.Struct({
+        label: rowLabelSchemaV1,
+        tone: Schema.Literals([
+            "neutral",
+            "primary",
+            "secondary",
+            "accent",
+            "success",
+            "info",
+            "warning",
+            "error",
+        ]),
+    })),
+    /** The host supplies this Gill's App identity; rows only select its view. */
+    open: Schema.optional(rowOpenSchemaV1),
+});
+/** A page containing at most 200 shared rows. */
+export const rowPageSchemaV1 = Schema.Array(rowSchemaV1).pipe(Schema.check(Schema.isMaxLength(200)));
+/** A finished App call as a person reads it: a shared row plus an optional thumbnail. */
+export const resultRowSchemaV1 = Schema.Struct({
+    ...rowSchemaV1.fields,
+    /** A Computer file the receiving host may preview; the host authorizes the read. */
+    media: Schema.optional(Schema.Struct({
+        path: rowLabelSchemaV1,
+        format: Schema.Literals(["fungi:image", "fungi:video"]),
+    })),
+});

package/docs/api/README.md

@@ -0,0 +1,13 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+**@fungi.computer/gills**
+
+---
+
+# Gills
+
+Bounded Gill declarations, requests and plain-text rows for App hosts. Effect
+owns decoding; the host owns authorization, navigation and action execution.
+
+Import the public contract from `@fungi.computer/gills`. See the package README
+for a runnable quick start and the generated API for each schema and type.