@opengeni/sdk 3.3.2 → 3.4.0

package/dist/site-data.d.ts

@@ -0,0 +1,178 @@
+/**
+ * Site Data for Site HTML: persistent JSON collections and files that belong
+ * to the published Site. Requests travel over the host's Site HTTP channel;
+ * the host adds the viewer's credentials and pins the Site, and the API
+ * enforces each collection's access mode. Stored records are untrusted input:
+ * render them with textContent, never innerHTML.
+ */
+export type OpenGeniSiteDataErrorCode = "validation" | "conflict" | "not_found" | "forbidden"
+/** This viewer may not do this on this Site (a role the Site's rules exclude). */
+ | "not_available_for_viewer" | "quota_exceeded" | "rate_limited" | "site_data_unsupported" | "request_failed";
+export declare class OpenGeniSiteDataError extends Error {
+    readonly code: OpenGeniSiteDataErrorCode;
+    readonly status: number;
+    readonly details: Record<string, unknown>;
+    constructor(code: OpenGeniSiteDataErrorCode, message: string, status: number, details?: Record<string, unknown>);
+}
+export type OpenGeniSiteDataRecord<T extends Record<string, unknown> = Record<string, unknown>> = {
+    id: string;
+    key: string | null;
+    data: T;
+    /** Principal that owns the record, such as `user:<id>`. */
+    owner: string;
+    createdBy: string;
+    updatedBy: string;
+    version: number;
+    sizeBytes: number;
+    createdAt: string;
+    updatedAt: string;
+};
+export type OpenGeniSiteDataScalar = string | number | boolean | null;
+export type OpenGeniSiteDataFilter = {
+    /** Dotted data path (up to 4 levels) or $id, $key, $owner, $createdAt, $updatedAt, $version. */
+    field: string;
+    op: "eq" | "ne" | "in" | "gt" | "gte" | "lt" | "lte" | "contains" | "exists";
+    value?: OpenGeniSiteDataScalar | OpenGeniSiteDataScalar[];
+};
+export type OpenGeniSiteDataListOptions = {
+    where?: OpenGeniSiteDataFilter[];
+    sort?: Array<{
+        field: string;
+        direction?: "asc" | "desc";
+    }>;
+    /** 1 to 200; 50 by default. */
+    limit?: number;
+    cursor?: string | null;
+    count?: boolean;
+    /** `own` returns only the viewer's records. */
+    scope?: "own" | "all";
+};
+export type OpenGeniSiteDataPage<T extends Record<string, unknown> = Record<string, unknown>> = {
+    records: OpenGeniSiteDataRecord<T>[];
+    nextCursor: string | null;
+    count?: number;
+};
+/** A record by id, or by your own key. A plain string is treated as a key. */
+export type OpenGeniSiteDataRef = string | {
+    id: string;
+} | {
+    key: string;
+};
+export type OpenGeniSiteDataOperation = {
+    op: "insert";
+    collection: string;
+    key?: string;
+    data: Record<string, unknown>;
+} | {
+    op: "put";
+    collection: string;
+    key: string;
+    data: Record<string, unknown>;
+    expectedVersion?: number;
+} | ({
+    op: "patch";
+    collection: string;
+    data: Record<string, unknown>;
+    expectedVersion?: number;
+} & RefFields) | ({
+    op: "delete";
+    collection: string;
+    expectedVersion?: number;
+} & RefFields) | ({
+    op: "increment";
+    collection: string;
+    field: string;
+    by?: number;
+} & RefFields);
+type RefFields = {
+    id: string;
+    key?: never;
+} | {
+    key: string;
+    id?: never;
+};
+export type OpenGeniSiteDataWriteResult = {
+    op: "insert" | "put" | "patch" | "increment";
+    record: OpenGeniSiteDataRecord;
+} | {
+    op: "delete";
+    deleted: {
+        id: string;
+    };
+};
+export type OpenGeniSiteDataCollection<T extends Record<string, unknown> = Record<string, unknown>> = {
+    readonly name: string;
+    list(options?: OpenGeniSiteDataListOptions): Promise<OpenGeniSiteDataPage<T>>;
+    /** Resolves null when the record does not exist or is not visible to the viewer. */
+    get(ref: OpenGeniSiteDataRef): Promise<OpenGeniSiteDataRecord<T> | null>;
+    insert(data: T, options?: {
+        key?: string;
+    }): Promise<OpenGeniSiteDataRecord<T>>;
+    /** Create or replace the record with this key. */
+    put(key: string, data: T, options?: {
+        expectedVersion?: number;
+    }): Promise<OpenGeniSiteDataRecord<T>>;
+    /** Shallow-merge fields; expectedVersion turns concurrent edits into a conflict error. */
+    patch(ref: OpenGeniSiteDataRef, data: Partial<T>, options?: {
+        expectedVersion?: number;
+    }): Promise<OpenGeniSiteDataRecord<T>>;
+    delete(ref: OpenGeniSiteDataRef, options?: {
+        expectedVersion?: number;
+    }): Promise<void>;
+    /** Atomically add to a numeric field; a missing key is created. */
+    increment(ref: OpenGeniSiteDataRef, field: string, by?: number): Promise<OpenGeniSiteDataRecord<T>>;
+    count(where?: OpenGeniSiteDataFilter[], options?: {
+        scope?: "own" | "all";
+    }): Promise<number>;
+};
+export type OpenGeniSiteData = {
+    collection<T extends Record<string, unknown> = Record<string, unknown>>(name: string): OpenGeniSiteDataCollection<T>;
+    /** Up to 100 operations across collections, applied together or not at all. */
+    batch(operations: OpenGeniSiteDataOperation[]): Promise<OpenGeniSiteDataWriteResult[]>;
+    count(collection: string, where?: OpenGeniSiteDataFilter[]): Promise<number>;
+};
+export type OpenGeniSiteFile = {
+    id: string;
+    name: string;
+    contentType: string;
+    sizeBytes: number;
+    sha256: string;
+    /** shared: every viewer can open it. private: only the uploader and the Site's managers. */
+    scope: "shared" | "private";
+    owner: string;
+    createdBy: string;
+    createdAt: string;
+};
+export type OpenGeniSiteFiles = {
+    upload(file: Blob | ArrayBuffer | Uint8Array, options?: {
+        name?: string;
+        contentType?: string;
+        scope?: "shared" | "private";
+    }): Promise<OpenGeniSiteFile>;
+    list(options?: {
+        limit?: number;
+        cursor?: string | null;
+    }): Promise<{
+        files: OpenGeniSiteFile[];
+        nextCursor: string | null;
+    }>;
+    /** A short-lived download URL for an img/src, link or fetch. */
+    url(fileId: string): Promise<{
+        url: string;
+        expiresAt: string;
+        file: OpenGeniSiteFile;
+    }>;
+    delete(fileId: string): Promise<void>;
+};
+/** Path prefix the host rewrites to its pinned Site; Site code never names a Site id. */
+export declare const SITE_DATA_PATH_PREFIX = "/v1/workspaces/site-host/published-artifacts/current";
+type SiteDataFetch = (path: string, init: RequestInit) => Promise<Response>;
+/**
+ * Build the typed Site Data facade over a Site HTTP fetch. `ready` resolves
+ * once the host has said whether it serves Site Data.
+ */
+export declare function createOpenGeniSiteData(fetchSite: SiteDataFetch, ready: () => Promise<boolean>): {
+    data: OpenGeniSiteData;
+    files: OpenGeniSiteFiles;
+};
+export {};

package/dist/site-document.d.ts

@@ -0,0 +1,5 @@
+import { SITE_BROWSER_RUNTIME } from "./site-browser-runtime.gen.js";
+export declare const SITE_CLIENT_SCRIPT_PATH = "/__opengeni/site-tools/client.js";
+export { SITE_BROWSER_RUNTIME };
+/** Resolve only the optional client tag; ordinary bundled Sites remain unchanged. */
+export declare function resolveSiteClientScript(html: string): string;