@opengeni/contracts 3.1.0-canary.2 → 3.1.2

package/dist/site-data.d.ts

@@ -0,0 +1,286 @@
+import { z } from "zod";
+/**
+ * Site Data: persistent JSON collections and files that belong to a
+ * published Site. Shared by the HTTP API, first-party agent tools and the SDK.
+ */
+export declare const SiteDataAccessMode: z.ZodEnum<{
+    append_only: "append_only";
+    per_viewer: "per_viewer";
+    shared: "shared";
+    shared_read: "shared_read";
+}>;
+export type SiteDataAccessMode = z.infer<typeof SiteDataAccessMode>;
+/** What anonymous guests of a public published Site may do in a collection. */
+export declare const SiteDataGuestAccess: z.ZodEnum<{
+    append: "append";
+    none: "none";
+    own: "own";
+    read: "read";
+}>;
+export type SiteDataGuestAccess = z.infer<typeof SiteDataGuestAccess>;
+export declare const SiteDataFilter: z.ZodObject<{
+    field: z.ZodString;
+    op: z.ZodEnum<{
+        contains: "contains";
+        eq: "eq";
+        exists: "exists";
+        gt: "gt";
+        gte: "gte";
+        in: "in";
+        lt: "lt";
+        lte: "lte";
+        ne: "ne";
+    }>;
+    value: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>]>>;
+}, z.core.$strip>;
+export type SiteDataFilter = z.infer<typeof SiteDataFilter>;
+export declare const SiteDataSort: z.ZodObject<{
+    field: z.ZodString;
+    direction: z.ZodOptional<z.ZodEnum<{
+        asc: "asc";
+        desc: "desc";
+    }>>;
+}, z.core.$strip>;
+export type SiteDataSort = z.infer<typeof SiteDataSort>;
+export declare const SiteDataQueryRequest: z.ZodObject<{
+    collection: z.ZodString;
+    where: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        field: z.ZodString;
+        op: z.ZodEnum<{
+            contains: "contains";
+            eq: "eq";
+            exists: "exists";
+            gt: "gt";
+            gte: "gte";
+            in: "in";
+            lt: "lt";
+            lte: "lte";
+            ne: "ne";
+        }>;
+        value: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>]>>;
+    }, z.core.$strip>>>;
+    sort: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        field: z.ZodString;
+        direction: z.ZodOptional<z.ZodEnum<{
+            asc: "asc";
+            desc: "desc";
+        }>>;
+    }, z.core.$strip>>>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    cursor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    count: z.ZodOptional<z.ZodBoolean>;
+    scope: z.ZodOptional<z.ZodEnum<{
+        all: "all";
+        own: "own";
+    }>>;
+}, z.core.$strip>;
+export type SiteDataQueryRequest = z.infer<typeof SiteDataQueryRequest>;
+export declare const SiteDataGetRequest: z.ZodObject<{
+    collection: z.ZodString;
+    id: z.ZodOptional<z.ZodString>;
+    key: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type SiteDataGetRequest = z.infer<typeof SiteDataGetRequest>;
+export declare const SiteDataWriteOperation: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    op: z.ZodLiteral<"insert">;
+    collection: z.ZodString;
+    key: z.ZodOptional<z.ZodString>;
+    data: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, z.core.$strip>, z.ZodObject<{
+    op: z.ZodLiteral<"put">;
+    collection: z.ZodString;
+    key: z.ZodString;
+    data: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    expectedVersion: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    key: z.ZodOptional<z.ZodString>;
+    op: z.ZodLiteral<"patch">;
+    collection: z.ZodString;
+    data: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    expectedVersion: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    key: z.ZodOptional<z.ZodString>;
+    op: z.ZodLiteral<"delete">;
+    collection: z.ZodString;
+    expectedVersion: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    key: z.ZodOptional<z.ZodString>;
+    op: z.ZodLiteral<"increment">;
+    collection: z.ZodString;
+    field: z.ZodString;
+    by: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>], "op">;
+export type SiteDataWriteOperation = z.infer<typeof SiteDataWriteOperation>;
+export declare const SiteDataWriteRequest: z.ZodObject<{
+    operations: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        op: z.ZodLiteral<"insert">;
+        collection: z.ZodString;
+        key: z.ZodOptional<z.ZodString>;
+        data: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    }, z.core.$strip>, z.ZodObject<{
+        op: z.ZodLiteral<"put">;
+        collection: z.ZodString;
+        key: z.ZodString;
+        data: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        expectedVersion: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>, z.ZodObject<{
+        id: z.ZodOptional<z.ZodString>;
+        key: z.ZodOptional<z.ZodString>;
+        op: z.ZodLiteral<"patch">;
+        collection: z.ZodString;
+        data: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        expectedVersion: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>, z.ZodObject<{
+        id: z.ZodOptional<z.ZodString>;
+        key: z.ZodOptional<z.ZodString>;
+        op: z.ZodLiteral<"delete">;
+        collection: z.ZodString;
+        expectedVersion: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>, z.ZodObject<{
+        id: z.ZodOptional<z.ZodString>;
+        key: z.ZodOptional<z.ZodString>;
+        op: z.ZodLiteral<"increment">;
+        collection: z.ZodString;
+        field: z.ZodString;
+        by: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>], "op">>;
+}, z.core.$strip>;
+export type SiteDataWriteRequest = z.infer<typeof SiteDataWriteRequest>;
+export declare const SiteDataCollectionDefinitionRequest: z.ZodObject<{
+    accessMode: z.ZodEnum<{
+        append_only: "append_only";
+        per_viewer: "per_viewer";
+        shared: "shared";
+        shared_read: "shared_read";
+    }>;
+    privateRecords: z.ZodOptional<z.ZodBoolean>;
+    guestAccess: z.ZodOptional<z.ZodEnum<{
+        append: "append";
+        none: "none";
+        own: "own";
+        read: "read";
+    }>>;
+    jsonSchema: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    indexedFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    uniqueFields: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodString>>>;
+}, z.core.$strip>;
+export type SiteDataCollectionDefinitionRequest = z.infer<typeof SiteDataCollectionDefinitionRequest>;
+export declare const SiteDataConfirmRequest: z.ZodObject<{
+    confirm: z.ZodLiteral<true>;
+}, z.core.$strip>;
+export declare const SiteDataImportRequest: z.ZodObject<{
+    format: z.ZodEnum<{
+        csv: "csv";
+        json: "json";
+    }>;
+    records: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    csv: z.ZodOptional<z.ZodString>;
+    keyField: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type SiteDataImportRequest = z.infer<typeof SiteDataImportRequest>;
+export declare const SiteDataFileScope: z.ZodEnum<{
+    private: "private";
+    shared: "shared";
+}>;
+export type SiteDataFileScope = z.infer<typeof SiteDataFileScope>;
+export declare const SiteDataErrorCode: z.ZodEnum<{
+    conflict: "conflict";
+    forbidden: "forbidden";
+    not_found: "not_found";
+    quota_exceeded: "quota_exceeded";
+    rate_limited: "rate_limited";
+    validation: "validation";
+}>;
+export type SiteDataErrorCode = z.infer<typeof SiteDataErrorCode>;
+/** HTTP status for each Site Data error code. */
+export declare const SITE_DATA_ERROR_STATUS: Record<SiteDataErrorCode, number>;
+export type SiteDataRecordResponse = {
+    id: string;
+    key: string | null;
+    data: Record<string, unknown>;
+    owner: string;
+    createdBy: string;
+    updatedBy: string;
+    version: number;
+    sizeBytes: number;
+    createdAt: string;
+    updatedAt: string;
+};
+export type SiteDataCollectionResponse = {
+    id: string;
+    name: string;
+    accessMode: SiteDataAccessMode;
+    privateRecords: boolean;
+    guestAccess: SiteDataGuestAccess;
+    jsonSchema: Record<string, unknown> | null;
+    indexedFields: string[];
+    uniqueFields: string[][];
+    recordCount: number;
+    recordBytes: number;
+    createdAt: string;
+    updatedAt: string;
+};
+export type SiteDataLimitsResponse = {
+    recordBytesPerSite: number;
+    maxRecordBytes: number;
+    maxCollectionsPerSite: number;
+    fileBytesPerSite: number;
+    maxFileBytes: number;
+    workspaceBytes: number;
+};
+export type SiteDataDescribeResponse = {
+    siteId: string;
+    collections: SiteDataCollectionResponse[];
+    usage: {
+        collectionCount: number;
+        recordCount: number;
+        recordBytes: number;
+        fileCount: number;
+        fileBytes: number;
+        workspaceBytes: number;
+    };
+    limits: SiteDataLimitsResponse;
+};
+export type SiteDataFileResponse = {
+    id: string;
+    name: string;
+    contentType: string;
+    sizeBytes: number;
+    sha256: string;
+    scope: SiteDataFileScope;
+    owner: string;
+    createdBy: string;
+    createdAt: string;
+};
+export type SiteDataQueryResponse = {
+    records: SiteDataRecordResponse[];
+    nextCursor: string | null;
+    count?: number;
+};
+export type SiteDataWriteResultResponse = {
+    op: "insert" | "put" | "patch" | "increment";
+    record: SiteDataRecordResponse;
+} | {
+    op: "delete";
+    deleted: {
+        id: string;
+    };
+};
+export type SiteDataWriteResponse = {
+    results: SiteDataWriteResultResponse[];
+};
+export type SiteDataImportResponse = {
+    imported: number;
+};
+export type SiteDataFileListResponse = {
+    files: SiteDataFileResponse[];
+    nextCursor: string | null;
+};
+export type SiteDataFileUrlResponse = {
+    url: string;
+    expiresAt: string;
+    file: SiteDataFileResponse;
+};

package/dist/site-operations.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Every HTTP operation Site code may perform through a host, as an explicit
+ * allowlist (method + exact path shape) rather than a URL prefix. Paths are
+ * the suffix after `/v1/workspaces/site-host` that the in-Site SDK client
+ * uses; `/v1/config/client` is the one path outside that prefix.
+ *
+ * The console host forwards an allowed operation to the ordinary workspace
+ * route with Site provenance. The gateway forwards it to `/_og/api<suffix>`
+ * and the API serves it at `/v1/site-runtime<suffix>`. `agent: true` marks
+ * operations that start or message an agent; every such route records which
+ * Site (and version) originated it.
+ */
+export type SiteOperationMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+export type SiteOperation = {
+    id: string;
+    method: SiteOperationMethod;
+    /** Anchored pattern on the site-host suffix (`""` is the workspace itself). */
+    pattern: RegExp;
+    agent?: true;
+    stream?: true;
+};
+export declare const SITE_OPERATIONS: readonly SiteOperation[];
+/**
+ * Tool bridge methods (MessagePort, not HTTP). The gateway serves them at
+ * POST /_og/api/tools/<method>; the console uses its tool gateway client.
+ */
+export declare const SITE_TOOL_METHODS: readonly ["catalog", "declarations", "call", "resolve", "invoke"];
+export type SiteToolMethod = (typeof SITE_TOOL_METHODS)[number];
+/**
+ * Match a Site-originated request against the allowlist. `path` is the
+ * pathname the in-Site SDK used (`/v1/workspaces/site-host/...` or
+ * `/v1/config/client`), without query. Returns the operation and the
+ * site-host suffix, or null when the operation is not allowed. Refuses
+ * encoded separators, dot segments and control characters.
+ */
+export declare function matchSiteOperation(method: string, path: string): {
+    operation: SiteOperation;
+    suffix: string;
+} | null;