@segmentstream/app 0.0.0-stage → 0.38.0

package/dist/jobs.d.ts

@@ -0,0 +1,49 @@
+/** A pipeline run, returned immediately by `run()` and refreshed with `getRun()`. */
+export interface JobRun {
+    readonly id: string;
+    readonly deploymentId: string;
+    readonly jobName: string;
+    /** `queued`, `starting`, `running`, `succeeded`, `failed` or `cancelled`; future values are accepted. */
+    readonly status: string;
+    readonly trigger: string;
+    readonly partitionRange?: {
+        readonly startDate: string;
+        readonly endDate: string;
+    };
+    readonly failure?: {
+        readonly code: string;
+        readonly detail: string;
+        readonly retryable: boolean;
+        readonly reference: string;
+    };
+    readonly createdAt: string;
+    readonly updatedAt: string;
+    readonly startedAt?: string;
+    readonly completedAt?: string;
+}
+export interface JobRunOptions {
+    /** Reuse the same key when retrying one submission. Defaults to a new UUID for each call. */
+    readonly idempotencyKey?: string;
+    readonly partitionRange?: {
+        readonly startDate: string;
+        readonly endDate: string;
+    };
+    readonly signal?: AbortSignal;
+}
+export interface JobReadOptions {
+    readonly signal?: AbortSignal;
+}
+/**
+ * Server-only pipeline execution. The workspace credential can start and read only jobs deployed
+ * with `allow_app_runs=True`. Check the app user's permissions before calling on their behalf.
+ */
+export interface JobsClient {
+    /** Submit a run without waiting for completion. */
+    readonly run: (jobName: string, options?: JobRunOptions) => Promise<JobRun>;
+    readonly getRun: (runId: string, options?: JobReadOptions) => Promise<JobRun>;
+    readonly listRuns: (jobName: string, options?: JobReadOptions) => Promise<readonly JobRun[]>;
+}
+export declare function createJobsClient(dependencies: {
+    readonly workspace: string;
+    readonly fetch: (path: string, init: RequestInit) => Promise<Response>;
+}): JobsClient;

package/dist/jobs.js

@@ -0,0 +1,40 @@
+import { apiErrorFrom, readJson } from "./errors.js";
+export function createJobsClient(dependencies) {
+    async function request(path, init) {
+        const response = await dependencies.fetch(path, init);
+        const payload = await readJson(response);
+        if (!response.ok) {
+            throw apiErrorFrom(response.status, payload, "SegmentStream rejected the job request.");
+        }
+        return payload;
+    }
+    return {
+        async run(jobName, options = {}) {
+            const key = options.idempotencyKey?.trim() ?? crypto.randomUUID();
+            if (!/^[A-Za-z0-9._:-]{8,128}$/.test(key)) {
+                throw new TypeError("idempotencyKey must be 8–128 letters, numbers, dots, underscores, colons or hyphens.");
+            }
+            const { run } = await request(`${dependencies.workspace}/jobs/${segment(jobName, "jobName")}/runs`, {
+                method: "POST",
+                headers: { "content-type": "application/json", "idempotency-key": key },
+                body: JSON.stringify(options.partitionRange ? { partitionRange: options.partitionRange } : {}),
+                signal: options.signal,
+            });
+            return run;
+        },
+        async getRun(runId, options = {}) {
+            const { run } = await request(`${dependencies.workspace}/runs/${segment(runId, "runId")}?includeTrigger=true`, { method: "GET", signal: options.signal });
+            return run;
+        },
+        async listRuns(jobName, options = {}) {
+            const { runs } = await request(`${dependencies.workspace}/jobs/${segment(jobName, "jobName")}/runs?includeTrigger=true`, { method: "GET", signal: options.signal });
+            return runs;
+        },
+    };
+}
+function segment(value, name) {
+    if (!value || value === "." || value === "..") {
+        throw new TypeError(`${name} must be a non-empty identifier.`);
+    }
+    return encodeURIComponent(value);
+}

package/dist/legacy.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Metrics were called measures before the ontology SDK's manifest version 14, and metric queries
+ * @legacy ontology.metric-earlier-names
+ * aggregates. This module is the one place that still knows the earlier names: app code written for
+ * an earlier app SDK calls `aggregate` with `measures` and `orderBy[].measure`, an app may type its
+ * client with an ontology built by an earlier ontology SDK, whose entities and model declare
+ * `measures`, and a workspace may still run an ontology service built by such an SDK, which serves
+ * metric queries only at `/api/ontology/aggregate` and `/api/ontology/<entity>/aggregate` with the
+ * earlier names. The client writes the current names, and reads the earlier ones through this
+ * module.
+ */
+import type { EntityMetricQuery, MetricQuery, MetricQueryField, MetricQueryFilter, MetricQueryFilterOperator, MetricQueryGranularity, MetricQueryResult } from "./data.js";
+import type { DeclaredNames, EntityMetricQueryClient, MetricQueryClient, RequestOptions } from "./ontology.js";
+/**
+ * A metric query with its metrics under their earlier name, `measures`, and each order's under
+ * `measure`.
+ */
+type WithEarlierNames<Query extends {
+    readonly orderBy?: ReadonlyArray<object>;
+}, Metric extends string> = Omit<Query, "metrics" | "orderBy"> & {
+    readonly measures: readonly Metric[];
+    readonly orderBy?: ReadonlyArray<Omit<NonNullable<Query["orderBy"]>[number], "metric"> & {
+        readonly measure?: Metric;
+    }>;
+};
+/** @deprecated Use {@link EntityMetricQuery}: its metrics are `metrics` and `orderBy[].metric`. */
+export type AggregateRequest<Property extends string = string, Measure extends string = string, Temporal extends Property = Property, Path extends string = never> = WithEarlierNames<EntityMetricQuery<Property, Measure, Temporal, Path>, Measure>;
+/** @deprecated Use {@link MetricQuery}: its metrics are `metrics` and `orderBy[].metric`. */
+export type ModelAggregateRequest<Measure extends string = string, Dimension extends string = string> = WithEarlierNames<MetricQuery<Measure, Dimension>, Measure>;
+/** @deprecated Use {@link MetricQueryFilter}. */
+export type ModelAggregateFilter<Dimension extends string = string> = MetricQueryFilter<Dimension>;
+/** @deprecated Use {@link MetricQueryFilterOperator}. */
+export type AggregateFilterOperator = MetricQueryFilterOperator;
+/** @deprecated Use {@link MetricQueryGranularity}. */
+export type AggregateGranularity = MetricQueryGranularity;
+/** @deprecated Use {@link MetricQueryField}. */
+export type AggregateField = MetricQueryField;
+/** @deprecated Use {@link MetricQueryResult}. */
+export type AggregateResult<Row = Record<string, string | boolean | null>> = MetricQueryResult<Row>;
+/** @deprecated Use {@link MetricQueryClient}. */
+export type ModelAggregateClient<Measure extends string = string, Dimension extends string = string> = MetricQueryClient<Measure, Dimension>;
+/** @deprecated Use {@link EntityMetricQueryClient}. */
+export type AggregateEntityClient<Property extends string = string, Measure extends string = string, Temporal extends Property = Property, Path extends string = never> = EntityMetricQueryClient<Property, Measure, Temporal, Path>;
+/** The model-level `queryMetrics` under its earlier name. */
+export interface EarlierQueryMetricsName<Metric extends string, Dimension extends string> {
+    /**
+     * @deprecated Use `queryMetrics`: `aggregate` is its earlier name. It also takes the metrics as
+     * `measures` and an order's metric as `measure`.
+     */
+    readonly aggregate: (request: MetricQuery<Metric, Dimension> | ModelAggregateRequest<Metric, Dimension>, options?: RequestOptions) => Promise<MetricQueryResult>;
+}
+/** An entity's `queryMetrics` under its earlier name. */
+export interface EarlierEntityQueryMetricsName<Property extends string, Metric extends string, Temporal extends Property, Path extends string> {
+    /**
+     * @deprecated Use `queryMetrics`: `aggregate` is its earlier name. It also takes the metrics as
+     * `measures` and an order's metric as `measure`.
+     */
+    readonly aggregate: (request: EntityMetricQuery<Property, Metric, Temporal, Path> | AggregateRequest<Property, Metric, Temporal, Path>, options?: RequestOptions) => Promise<MetricQueryResult>;
+}
+/**
+ * The metrics an entity of an ontology SDK before manifest version 14 declares under their earlier
+ * name: a warehouse-backed entity's `measures`, or those of a stored entity's definition.
+ */
+export type EarlierMetricsOf<E> = E extends {
+    readonly measures: infer M;
+} ? keyof M & string : E extends {
+    readonly definition: {
+        readonly measures?: infer M;
+    };
+} ? DeclaredNames<NonNullable<M>> : never;
+/** The model metrics of such an ontology, `defineOntology({ measures })`, by their bare names. */
+export type EarlierModelMetricsOf<O> = O extends {
+    readonly config: {
+        readonly measures?: infer M;
+    };
+} ? DeclaredNames<NonNullable<M>> : never;
+export {};

package/dist/legacy.js

@@ -0,0 +1,57 @@
+/** @internal The earlier name of `queryMetrics`, and of the service's `query_metrics` routes. */
+export const EARLIER_QUERY_METRICS = "aggregate";
+/**
+ * @internal A client's `queryMetrics` under its earlier name: the same call, which also takes the
+ * earlier names of the request.
+ */
+export function withEarlierQueryMetricsName(queryMetrics) {
+    return {
+        [EARLIER_QUERY_METRICS]: (request, options) => queryMetrics(renamedMetricQuery(request, EARLIER_NAMES, CURRENT_NAMES), options),
+    };
+}
+// Ontology services built by an earlier ontology SDK.
+/**
+ * @internal Posts metric queries to `<base>/<route>`. An ontology service built by an ontology SDK
+ * before manifest version 14 serves them only at `<base>/aggregate`, with `measures` and
+ * `orderBy[].measure`, and answers 404 at the current route: the query is posted there once more,
+ * with those names. Once that route answers anything but 404, the service is an earlier one, and
+ * the poster sends every later query of its client there directly.
+ */
+export function metricQueryPoster(route, post) {
+    let earlierService = false;
+    return async (base, body, signal) => {
+        if (!earlierService) {
+            const response = await post(`${base}/${route}`, body, signal);
+            if (response.status !== 404) {
+                return response;
+            }
+            await response.body?.cancel();
+        }
+        const response = await post(`${base}/${EARLIER_QUERY_METRICS}`, renamedMetricQuery(body, CURRENT_NAMES, EARLIER_NAMES), signal);
+        earlierService ||= response.status !== 404;
+        return response;
+    };
+}
+const CURRENT_NAMES = { metrics: "metrics", metric: "metric" };
+const EARLIER_NAMES = { metrics: "measures", metric: "measure" };
+/**
+ * A metric query with its metrics and each order's metric renamed from `from` to `to`. A field
+ * that already carries its `to` name is left as given, for the service to refuse both names.
+ */
+function renamedMetricQuery(query, from, to) {
+    const renamed = renamedKey(query, from.metrics, to.metrics);
+    const { orderBy } = renamed;
+    return Array.isArray(orderBy)
+        ? {
+            ...renamed,
+            orderBy: orderBy.map((order) => renamedKey(order, from.metric, to.metric)),
+        }
+        : renamed;
+}
+/** The object with its key `from` renamed `to`, in its place among the others. */
+function renamedKey(value, from, to) {
+    if (!Object.hasOwn(value, from) || Object.hasOwn(value, to)) {
+        return value;
+    }
+    return Object.fromEntries(Object.entries(value).map(([key, field]) => [key === from ? to : key, field]));
+}

package/dist/logo.d.ts

@@ -0,0 +1 @@
+export declare const SEGMENTSTREAM_LOGO_URI: string;

package/dist/logo.js

@@ -0,0 +1,25 @@
+// Official asset: apps/website/public/segmentstream-logo-black.svg. Keep it in sync.
+const SVG = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="283 330 755 162" fill="none">
+  <!-- S icon (black) -->
+  <path fill="#18181b" d="M342.57,485.52l46.86-61.07c4.2-5.48,3.17-13.33-2.31-17.54l-1.08-0.83c-6.34-4.86-15.42-3.67-20.29,2.67l-29.25,38.12c-9.07,11.82-6.84,28.75,4.98,37.82L342.57,485.52z"/>
+  <path fill="#18181b" d="M393.15,410.11c-0.16-15.51-12.79-28.04-28.34-28.04H349.9c-4.94,0-8.95,4.01-8.95,8.95v19.39h42.52l0.01,0.01c0.09,0,0.19-0.01,0.28-0.01c4.37,0,7.9,3.54,7.9,7.9c0,0.9-0.15,1.77-0.43,2.58c0,0,1.25-3.04,1.63-5.72c0.24-1.69,0.29-3.97,0.3-4.77v0c0-0.03,0-0.06,0-0.09C393.15,410.18,393.15,410.11,393.15,410.11z"/>
+  <path fill="#18181b" d="M339.43,335.27l-46.86,61.07c-4.2,5.48-3.17,13.33,2.31,17.54l1.08,0.83c6.34,4.86,15.42,3.67,20.29-2.67l29.25-38.12c9.07-11.82,6.84-28.75-4.98-37.82L339.43,335.27z"/>
+  <path fill="#18181b" d="M288.85,410.68c0.16,15.51,12.79,28.04,28.34,28.04h14.91c4.94,0,8.95-4.01,8.95-8.95v-19.39h-42.52l-0.01-0.01c-0.09,0-0.19,0.01-0.28,0.01c-4.37,0-7.9-3.54-7.9-7.9c0-0.9,0.15-1.77,0.43-2.58c0,0-1.25,3.04-1.63,5.72c-0.24,1.69-0.29,3.97-0.3,4.77v0c0,0.03,0,0.06,0,0.09C288.85,410.6,288.85,410.68,288.85,410.68z"/>
+  <!-- Wordmark: segmentstream (black) -->
+  <g fill="#18181b">
+    <path d="M452.61,400.96c-1.03-1.65-2.99-3.72-6.2-3.72c-1.45,0-2.48,0.52-3.1,1.14c-0.52,0.52-0.93,1.34-0.93,2.27c0,1.14,0.52,1.86,1.45,2.48c0.62,0.41,1.24,0.62,3.41,1.76l5.16,2.58c2.27,1.14,4.44,2.27,6.09,4.03c2.38,2.38,3.2,5.06,3.2,8.06c0,3.92-1.45,7.33-3.82,9.91c-3.41,3.72-7.64,4.85-12.19,4.85c-2.79,0-6.3-0.41-9.4-2.79c-2.48-1.86-4.54-4.85-5.58-7.95l8.26-3.92c0.52,1.45,1.45,3.3,2.38,4.13c0.62,0.62,2.07,1.65,4.44,1.65c1.55,0,3.2-0.52,4.13-1.45c0.83-0.83,1.45-2.17,1.45-3.41c0-1.24-0.41-2.27-1.34-3.3c-1.24-1.24-2.68-1.96-4.34-2.68l-3.72-1.76c-1.96-0.93-4.34-2.07-5.99-3.72c-2.27-2.17-3.1-4.54-3.1-7.33c0-3.51,1.34-6.92,3.61-9.29c1.96-2.07,5.27-4.13,10.64-4.13c3.1,0,5.58,0.62,8.05,2.27c1.45,0.93,3.41,2.58,4.96,5.37L452.61,400.96z"/>
+    <path d="M509.71,423.06c-1.86,3.3-4.54,6.2-7.33,7.95c-3.51,2.27-8.16,3.3-12.81,3.3c-5.78,0-10.53-1.45-14.66-5.58c-4.13-4.13-6.4-10.12-6.4-16.63c0-6.71,2.37-13.22,6.92-17.86c3.61-3.61,8.36-5.89,14.56-5.89c6.92,0,11.36,2.99,13.94,5.68c5.58,5.78,6.09,13.84,6.09,18.38v1.24h-31.19c0.21,3.1,1.55,6.61,3.72,8.78c2.38,2.38,5.27,2.79,7.74,2.79c2.79,0,4.85-0.62,6.92-2.17c1.76-1.34,3.1-3.1,4.03-4.75L509.71,423.06z M499.7,405.4c-0.41-2.38-1.55-4.44-3.1-5.89c-1.34-1.24-3.51-2.48-6.82-2.48c-3.51,0-5.78,1.45-7.12,2.79c-1.45,1.34-2.58,3.41-3.1,5.58H499.7z"/>
+    <path d="M552.37,389.5h10.12v39.96c0,10.22-1.14,17.55-7.13,22.62c-2.79,2.27-7.33,4.65-14.46,4.65c-5.06,0-10.12-1.24-14.25-5.37c-3.2-3.2-5.68-8.26-6.4-13.53h9.81c0.41,2.38,1.65,5.16,3.2,6.81c1.24,1.34,3.72,3,7.85,3c4.23,0,6.71-1.65,7.95-2.89c3.3-3.2,3.3-7.75,3.3-10.95v-5.68c-4.65,5.89-10.33,6.2-13.22,6.2c-5.58,0-10.22-1.55-14.35-5.89c-3.92-4.13-6.51-10.02-6.51-17.25c0-7.95,3-13.42,6.4-16.83c4.34-4.44,9.5-5.99,14.77-5.99c4.34,0,9.19,1.45,12.91,5.89V389.5z M533.05,400.34c-2.58,2.38-4.44,6.4-4.44,11.05c0,4.34,1.65,8.57,4.34,10.95c1.86,1.65,4.65,2.89,7.75,2.89c3.2,0,5.99-0.93,8.47-3.51c2.99-3.2,3.82-6.92,3.82-10.22c0-4.85-1.55-8.47-4.13-10.95c-2.48-2.48-5.27-3.1-8.16-3.1C537.91,397.45,535.33,398.17,533.05,400.34z"/>
+    <path d="M575.29,389.5h10.12v4.03c3.41-4.13,7.43-5.16,10.74-5.16c4.54,0,8.78,2.17,11.26,6.4c3.61-5.16,9.09-6.4,12.91-6.4c5.27,0,9.91,2.48,12.39,6.82c0.83,1.45,2.27,4.65,2.27,10.95v26.85h-10.12v-23.96c0-4.85-0.52-6.82-0.93-7.75c-0.62-1.65-2.17-3.82-5.78-3.82c-2.48,0-4.65,1.34-5.99,3.2c-1.76,2.48-1.96,6.2-1.96,9.91v22.41h-10.12v-23.96c0-4.85-0.52-6.82-0.93-7.75c-0.62-1.65-2.17-3.82-5.78-3.82c-2.48,0-4.65,1.34-5.99,3.2c-1.76,2.48-1.96,6.2-1.96,9.91v22.41h-10.12V389.5z"/>
+    <path d="M686.72,423.06c-1.86,3.3-4.54,6.2-7.33,7.95c-3.51,2.27-8.16,3.3-12.8,3.3c-5.78,0-10.53-1.45-14.66-5.58c-4.13-4.13-6.4-10.12-6.4-16.63c0-6.71,2.38-13.22,6.92-17.86c3.61-3.61,8.36-5.89,14.56-5.89c6.92,0,11.36,2.99,13.94,5.68c5.58,5.78,6.09,13.84,6.09,18.38v1.24h-31.19c0.21,3.1,1.55,6.61,3.72,8.78c2.38,2.38,5.27,2.79,7.75,2.79c2.79,0,4.85-0.62,6.92-2.17c1.76-1.34,3.1-3.1,4.03-4.75L686.72,423.06z M676.7,405.4c-0.41-2.38-1.55-4.44-3.1-5.89c-1.34-1.24-3.51-2.48-6.82-2.48c-3.51,0-5.78,1.45-7.13,2.79c-1.45,1.34-2.58,3.41-3.1,5.58H676.7z"/>
+    <path d="M697.46,389.5h10.12v4.03c4.34-4.85,9.29-5.16,11.77-5.16c8.05,0,11.46,4.03,12.81,5.89c1.65,2.38,2.68,5.37,2.68,12.08v26.64h-10.12v-24.16c0-11.05-4.13-11.36-7.95-11.36c-4.54,0-9.19,0.62-9.19,14.66v20.86h-10.12V389.5z"/>
+    <path d="M758.08,398.79v34.18h-10.12v-34.18h-4.23v-9.29h4.23v-15.9h10.12v15.9h7.75v9.29H758.08z"/>
+    <path d="M791.64,400.96c-1.03-1.65-2.99-3.72-6.2-3.72c-1.45,0-2.48,0.52-3.1,1.14c-0.52,0.52-0.93,1.34-0.93,2.27c0,1.14,0.52,1.86,1.45,2.48c0.62,0.41,1.24,0.62,3.41,1.76l5.16,2.58c2.27,1.14,4.44,2.27,6.09,4.03c2.38,2.38,3.2,5.06,3.2,8.06c0,3.92-1.45,7.33-3.82,9.91c-3.41,3.72-7.64,4.85-12.19,4.85c-2.79,0-6.3-0.41-9.4-2.79c-2.48-1.86-4.54-4.85-5.58-7.95l8.26-3.92c0.52,1.45,1.45,3.3,2.38,4.13c0.62,0.62,2.07,1.65,4.44,1.65c1.55,0,3.2-0.52,4.13-1.45c0.83-0.83,1.45-2.17,1.45-3.41c0-1.24-0.41-2.27-1.34-3.3c-1.24-1.24-2.69-1.96-4.34-2.68l-3.72-1.76c-1.96-0.93-4.34-2.07-5.99-3.72c-2.27-2.17-3.1-4.54-3.1-7.33c0-3.51,1.34-6.92,3.61-9.29c1.96-2.07,5.27-4.13,10.64-4.13c3.1,0,5.58,0.62,8.05,2.27c1.45,0.93,3.41,2.58,4.96,5.37L791.64,400.96z"/>
+    <path d="M820.25,398.79v34.18h-10.12v-34.18h-4.23v-9.29h4.23v-15.9h10.12v15.9h7.75v9.29H820.25z"/>
+    <path d="M834.81,389.5h10.12v3.92c1.14-1.34,2.79-2.79,4.23-3.61c1.96-1.14,3.92-1.45,6.2-1.45c2.48,0,5.16,0.41,7.95,2.07l-4.13,9.19c-2.27-1.45-4.13-1.55-5.16-1.55c-2.17,0-4.34,0.31-6.3,2.38c-2.79,2.99-2.79,7.13-2.79,10.02v22.51h-10.12V389.5z"/>
+    <path d="M904.83,423.06c-1.86,3.3-4.54,6.2-7.33,7.95c-3.51,2.27-8.16,3.3-12.8,3.3c-5.78,0-10.53-1.45-14.66-5.58c-4.13-4.13-6.4-10.12-6.4-16.63c0-6.71,2.38-13.22,6.92-17.86c3.61-3.61,8.36-5.89,14.56-5.89c6.92,0,11.36,2.99,13.94,5.68c5.58,5.78,6.09,13.84,6.09,18.38v1.24h-31.19c0.21,3.1,1.55,6.61,3.72,8.78c2.38,2.38,5.27,2.79,7.75,2.79c2.79,0,4.85-0.62,6.92-2.17c1.76-1.34,3.1-3.1,4.03-4.75L904.83,423.06z M894.81,405.4c-0.41-2.38-1.55-4.44-3.1-5.89c-1.34-1.24-3.51-2.48-6.82-2.48c-3.51,0-5.78,1.45-7.13,2.79c-1.45,1.34-2.58,3.41-3.1,5.58H894.81z"/>
+    <path d="M946.38,389.5h10.12v43.48h-10.12v-4.54c-4.44,5.16-9.91,5.89-13.01,5.89c-13.43,0-21.07-11.15-21.07-23.13c0-14.15,9.71-22.82,21.17-22.82c3.2,0,8.78,0.83,12.91,6.2V389.5z M922.63,411.39c0,7.54,4.75,13.84,12.08,13.84c6.4,0,12.29-4.65,12.29-13.74c0-9.5-5.89-14.04-12.29-14.04C927.38,397.45,922.63,403.64,922.63,411.39z"/>
+    <path d="M969.31,389.5h10.12v4.03c3.41-4.13,7.43-5.16,10.74-5.16c4.54,0,8.78,2.17,11.26,6.4c3.62-5.16,9.09-6.4,12.91-6.4c5.27,0,9.91,2.48,12.39,6.82c0.83,1.45,2.27,4.65,2.27,10.95v26.85h-10.12v-23.96c0-4.85-0.52-6.82-0.93-7.75c-0.62-1.65-2.17-3.82-5.78-3.82c-2.48,0-4.65,1.34-5.99,3.2c-1.76,2.48-1.96,6.2-1.96,9.91v22.41H994.1v-23.96c0-4.85-0.52-6.82-0.93-7.75c-0.62-1.65-2.17-3.82-5.78-3.82c-2.48,0-4.65,1.34-5.99,3.2c-1.76,2.48-1.96,6.2-1.96,9.91v22.41h-10.12V389.5z"/>
+  </g>
+</svg>`;
+export const SEGMENTSTREAM_LOGO_URI = `data:image/svg+xml,${encodeURIComponent(SVG)}`;

package/dist/me.d.ts

@@ -0,0 +1,42 @@
+import type { JsonValue } from "./ontology.js";
+export declare const ME_PATH = "/api/ontology/me";
+/**
+ * A permission the user holds only for the records its `where` matches, as `/me` sends it. `where`
+ * is the condition in the wire form of a query: snake_case field names, and the signed-in user as
+ * `{ "$me": [] }` or a path from them as `{ "$me": ["staff_member", "division"] }`. It is
+ * informational, for what the app shows; the ontology service enforces it on every read and write.
+ */
+export interface ScopedPermission {
+    /** `<entity>:<verb>`, spelled as in `permissions`, such as `staffMember:update`. */
+    readonly permission: string;
+    readonly where: {
+        readonly [field: string]: JsonValue;
+    };
+}
+/**
+ * The signed-in person as the ontology knows them: their `user` record, the roles they hold, the
+ * permissions those roles grant, wildcards included, and which of them cover only some records.
+ */
+export interface CurrentUser {
+    /** The ontology `user` record's id: what relationships such as `lead.ownerId` hold. */
+    readonly id: string;
+    readonly name: string | null;
+    readonly email: string | null;
+    /** `member` for people. */
+    readonly kind: string;
+    readonly active: boolean;
+    /** The ontology roles the user holds, such as `sales`. */
+    readonly roles: ReadonlyArray<string>;
+    /** The permissions the roles grant, such as `lead:changeStatus` or `*:read`. */
+    readonly permissions: ReadonlyArray<string>;
+    /**
+     * The permissions of `permissions` held only for the records their `where` matches. Absent when
+     * none is scoped, and from ontologies older than 0.40.0.
+     */
+    readonly scopes?: ReadonlyArray<ScopedPermission>;
+}
+/**
+ * Reads `{ user: { id, name, email, kind, active }, roles, permissions, scopes? }` tolerantly: unknown
+ * fields are ignored and only what the SDK presents is checked. `null` when it is not that shape.
+ */
+export declare function parseMe(payload: unknown): CurrentUser | null;

package/dist/me.js

@@ -0,0 +1,54 @@
+/** The ontology service's account of the caller: `GET /api/ontology/me`. */
+import { toCamelCase } from "./ontology-names.js";
+export const ME_PATH = "/api/ontology/me";
+/**
+ * Reads `{ user: { id, name, email, kind, active }, roles, permissions, scopes? }` tolerantly: unknown
+ * fields are ignored and only what the SDK presents is checked. `null` when it is not that shape.
+ */
+export function parseMe(payload) {
+    if (typeof payload !== "object" || payload === null) {
+        return null;
+    }
+    const { user, roles, permissions, scopes } = payload;
+    if (typeof user !== "object" || user === null) {
+        return null;
+    }
+    const { id, name, email, kind, active } = user;
+    if (typeof id !== "string" || id === "") {
+        return null;
+    }
+    const scoped = scopedPermissions(scopes);
+    return {
+        id,
+        name: typeof name === "string" ? name : null,
+        email: typeof email === "string" ? email : null,
+        kind: typeof kind === "string" ? kind : "member",
+        active: typeof active === "boolean" ? active : true,
+        roles: strings(roles).map(toCamelCase),
+        permissions: strings(permissions).map(toCamelCase),
+        ...(scoped.length === 0 ? {} : { scopes: scoped }),
+    };
+}
+/** The `{ permission, where }` entries of `scopes`; others are skipped. */
+function scopedPermissions(value) {
+    if (!Array.isArray(value)) {
+        return [];
+    }
+    return value.flatMap((entry) => {
+        if (typeof entry !== "object" || entry === null) {
+            return [];
+        }
+        const { permission, where } = entry;
+        return typeof permission === "string" &&
+            typeof where === "object" &&
+            where !== null &&
+            !Array.isArray(where)
+            ? [{ permission: toCamelCase(permission), where: where }]
+            : [];
+    });
+}
+function strings(value) {
+    return Array.isArray(value)
+        ? value.filter((item) => typeof item === "string")
+        : [];
+}

package/dist/navigation/build.d.ts

@@ -0,0 +1,68 @@
+import { generatePageCatalog, type PageCatalogOntology, type PageCatalogRouting } from "./generate.js";
+export * from "./generate.js";
+export { withPageCatalog } from "./next.js";
+export declare const PAGE_CATALOG_PATH = ".segmentstream/navigation/page-catalog.json";
+export declare const PAGE_CATALOG_CONTEXT_PATH = ".segmentstream/navigation/build-context.json";
+export declare const PAGE_CATALOG_COMPILED_PATH = ".segmentstream/navigation/compiled.json";
+/** Read only routing source, never dependencies, generated artifacts, or page modules via import. */
+export declare function readPageCatalogFiles(projectDir: string): Promise<ReadonlyMap<string, string>>;
+interface RoutingRule {
+    readonly source: string;
+    readonly regex: string;
+    readonly internal?: boolean;
+    readonly destination?: string;
+    readonly has?: readonly unknown[];
+    readonly missing?: readonly unknown[];
+}
+interface RoutingInventory {
+    readonly redirects: readonly RoutingRule[];
+    readonly rewrites: {
+        readonly beforeFiles: readonly RoutingRule[];
+        readonly afterFiles: readonly RoutingRule[];
+        readonly fallback: readonly RoutingRule[];
+    };
+}
+/** Prove static matches exactly and compare complete path shapes for dynamic pages. */
+export declare function verifyPageCatalogRouting(catalog: ReturnType<typeof generatePageCatalog>, inventory: RoutingInventory, frameworkInterceptions?: readonly RoutingRule[]): void;
+/** Run before parallel app/ontology builds, using the ontology evaluated from the same immutable source. */
+export declare function preparePageCatalog(input: {
+    readonly projectDir: string;
+    readonly ontology: PageCatalogOntology;
+    readonly sourceHash: string;
+}): Promise<{
+    enabled: false;
+    coverage: {
+        pages: number;
+        annotated: number;
+        unannotated: number;
+    };
+    catalog?: undefined;
+    catalogPath?: undefined;
+} | {
+    enabled: true;
+    catalog: import("./generate.js").PageCatalogV1;
+    catalogPath: string;
+    coverage: {
+        pages: number;
+        annotated: number;
+        unannotated: number;
+    };
+}>;
+/** Compiler-stage safety check; final verification below must also follow the complete build command. */
+export declare function verifyCompiledPageCatalog(input: {
+    projectDir: string;
+    distDir: string;
+    routing?: PageCatalogRouting;
+}): Promise<void>;
+/** Verify final resolved routes after any app build command, including custom commands. */
+export declare function verifyPageCatalogBuild(input: {
+    readonly projectDir: string;
+}): Promise<{
+    enabled: false;
+    revision?: undefined;
+    pages?: undefined;
+} | {
+    enabled: true;
+    revision: string;
+    pages: number;
+}>;