Skip to content
Puffball0.2.0
API reference

app-event-facts

Import

Section titled “Import”
Import
import * as api from "@fungi.computer/puffball/app-event-facts";

Exports

Section titled “Exports”
Kind Export Description
type alias AppEventInput Parsed EventSink input before the host attaches installation identity.
type alias AppEventGitSource Host-attested repository origin of an accepted push fact.
type alias AppEventFact Canonical saved event fact for delivery to a host event router.
constant appEventInputSchema Canonical EventSink body; installation identity is supplied by the host.
constant appEventFactSchema Saved host fact delivered to the shared Workflows event router.

AppEventInputtype alias

Section titled “AppEventInput”
Signature
type AppEventInput = z.output<typeof appEventInputSchema>;

Parsed EventSink input before the host attaches installation identity.

AppEventGitSourcetype alias

Section titled “AppEventGitSource”
Signature
type AppEventGitSource = NonNullable<AppEventFact["gitSource"]>;

Host-attested repository origin of an accepted push fact.

AppEventFacttype alias

Section titled “AppEventFact”
Signature
type AppEventFact = z.output<typeof appEventFactSchema>;

Canonical saved event fact for delivery to a host event router.

appEventInputSchemaconstant

Section titled “appEventInputSchema”
Signature
const appEventInputSchema: ZodObject<
  {
    type: ZodString;
    payload: ZodObject<
      {
        type: ZodString;
        timestamp: ZodString;
        data: ZodJSONSchema;
      },
      $strict
    >;
    eventId: ZodString;
  },
  $strict
>;

Canonical EventSink body; installation identity is supplied by the host.

appEventFactSchemaconstant

Section titled “appEventFactSchema”
Signature
const appEventFactSchema: ZodObject<
  {
    type: ZodString;
    payload: ZodObject<
      {
        type: ZodString;
        timestamp: ZodString;
        data: ZodJSONSchema;
      },
      $strict
    >;
    eventId: ZodString;
    installationId: ZodString;
    appId: ZodString;
    releaseId: ZodString;
    gitSource: ZodOptional<
      ZodObject<
        {
          eventId: ZodLazy<ZodString>;
          repository: ZodString;
          updates: ZodArray<
            ZodObject<
              {
                ref: ZodString;
                before: ZodString;
                after: ZodString;
              },
              $strict
            >
          >;
          providerRepository: ZodString;
        },
        $strict
      >
    >;
  },
  $strict
>;

Saved host fact delivered to the shared Workflows event router.