@fabrika/provider-zerops 0.8.2 → 0.9.0-cloudflare.2

package/types/src/installation/placement-options.d.ts

@@ -0,0 +1,11 @@
+export declare const parsePlatformScheme: (raw: string | undefined) => "http" | "https";
+export declare const parsePlatformHostname: (raw: string) => string;
+export declare const parsePlatformHosts: (raw: {
+    iam: string | undefined;
+    control: string | undefined;
+    operations: string | undefined;
+}) => {
+    iam: string;
+    control: string;
+    operations: string;
+} | undefined;

package/types/src/installation/platform-archive.d.ts

@@ -0,0 +1,7 @@
+import type { ZeropsSourceDataFile } from '../source/port';
+/**
+ * The prepared platform archive plus the one generated data file (ADR-0045): every entry of the commit is copied
+ * byte for byte, and the file is appended after the last one. A commit that already holds the path, as a file or
+ * as a directory, is refused rather than overridden.
+ */
+export declare const archiveWithDataFile: (compressed: Uint8Array<ArrayBuffer>, file: ZeropsSourceDataFile) => Uint8Array<ArrayBuffer>;

package/types/src/installation/platform-source.d.ts

@@ -0,0 +1,8 @@
+import { type ZeropsArtifactSourceDescriptor } from '../index';
+export interface PreparedPlatformSource {
+    commitSha: string;
+    descriptor: ZeropsArtifactSourceDescriptor;
+    archivePath: string;
+    dispose(): Promise<void>;
+}
+export declare function preparePlatformSource(sourceDir: string, signal: AbortSignal): Promise<PreparedPlatformSource>;

package/types/src/installation/platform-upload.d.ts

@@ -0,0 +1,3 @@
+export type PlatformUploadFetch = (url: string, init: RequestInit) => Promise<Response>;
+export declare const validatePlatformUploadUrl: (value: string) => void;
+export declare const uploadPlatformArchive: (url: string, archive: Blob, signal: AbortSignal, uploadFetch: PlatformUploadFetch) => Promise<void>;

package/types/src/installation/sidecar.d.ts

@@ -0,0 +1,49 @@
+/** Everything the scaffold stages: the CLI-owned trio plus the operator-owned, write-once pin. */
+export declare const SIDECAR_FILES: readonly [".gitignore", "README.md", "fabrika.ref", ".github/workflows/platform.yml"];
+/** The file that pins which published fabrika tag this installation runs. */
+export declare const FABRIKA_REF_FILE = "fabrika.ref";
+/** The generated pipeline. CLI-owned: `init` and `upgrade` both rewrite it. */
+export declare const SIDECAR_WORKFLOW_PATH = ".github/workflows/platform.yml";
+/** What a rendered sidecar repository is named after. */
+export interface SidecarValues {
+    /** The operator's name for this installation. The GitHub Environment is named after it too. */
+    readonly installation: string;
+    /** `<owner>/<name>` of the sidecar repository itself. */
+    readonly repo: string;
+    /** The published fabrika tag to pin, used only when `fabrika.ref` does not exist yet. */
+    readonly fabrikaRef: string;
+}
+/** The generated pipeline for one installation. Its only placeholder is the installation, which names its GitHub Environment. */
+export declare const renderSidecarWorkflow: (installation: string) => Promise<string>;
+/**
+ * The installation a sidecar's current workflow was rendered for, read back from its GitHub Environment.
+ *
+ * Not from the repository name: `init --repo` accepts any name, and a workflow rendered for the wrong
+ * Environment deploys with no credentials.
+ */
+export declare const readSidecarWorkflowInstallation: (dir: string) => Promise<string>;
+/**
+ * Write the sidecar files into `dir`.
+ *
+ * The workflow, the README and the `.gitignore` are CLI-owned and refreshed on every run, so a fix to
+ * the generated pipeline reaches every installation on its operator's next `init` (and the workflow on
+ * the next `upgrade`). `fabrika.ref` is
+ * written ONLY when absent: bumping it is how an operator rolls the installation forward, and a refresh
+ * that reset it would silently roll them back.
+ *
+ * An existing `fabrika.ref` is validated rather than ignored — a sidecar that has drifted onto a branch
+ * is exactly the case the two gates exist for, and finding it here beats finding it in a failed run.
+ */
+export declare const materializeSidecarScaffold: (dir: string, values: SidecarValues) => Promise<void>;
+/** The pin a checkout carries, for the closing summary. */
+export declare const readPinnedTag: (dir: string) => Promise<string>;
+/**
+ * The default sidecar repository for an installation, following the predecessor's `vozka-platform-<account>`
+ * precedent: named so its relation to the installation is obvious. A parameter, never a constant — one
+ * operator's installations are not another's.
+ */
+export declare const defaultSidecarRepo: (installation: string) => string;
+/** Where the sidecar is checked out locally: `./fabrika-zerops-<installation>` under the cwd. */
+/** The sidecar checkout's directory name when `--checkout` is not given; `init` creates it and `upgrade` reads it. */
+export declare const defaultCheckoutName: (installation: string) => string;
+export declare const defaultCheckoutDir: (installation: string) => string;

package/types/src/installation/source-options.d.ts

@@ -0,0 +1 @@
+export declare const readInstallationSourceDir: (argv: readonly string[], env: Record<string, string | undefined>) => string;

package/types/src/installation/topology/artifacts.d.ts

@@ -0,0 +1,8 @@
+/** One file to write, with a path relative to the repository root. */
+export interface Artifact {
+    /** Repo-relative, POSIX-separated. */
+    path: string;
+    content: string;
+}
+/** Every artifact this package generates, in a stable order. */
+export declare const generatedArtifacts: () => Artifact[];

package/types/src/installation/topology/index.d.ts

@@ -0,0 +1,5 @@
+export { type Artifact, generatedArtifacts } from './artifacts';
+export { assertCorePackageIsExplicit, assertOnlyPublicService, assertZeropsHostnames } from './invariants';
+export { fabrikaZeropsYaml, PROXY_HEALTH_PORT, PROXY_PUBLIC_PORTS } from './setups';
+export { appsTopology, type CompiledDocument, type CompiledTopology, compileTopology, fabrikaTopologies, platformTopology, PROXY_HOSTNAME, } from './topology';
+export { assertArtifactMatchesSchema, parseYaml, validateYaml } from './validate';