@ngis/plugin-sdk 0.4.0

package/dist/src/api/resources.d.ts

@@ -0,0 +1,530 @@
+export type ResourceScope = "mine" | "shared" | "public" | "trash";
+export type ResourceType = "vector" | "raster" | "flow-field" | "table" | "file";
+export type ResourceStatus = "ready" | "processing" | "failed";
+export type ResourceAccess = "private" | "shared" | "team" | "public";
+export type ResourceReadMode = "live" | "snapshot";
+export type ResourceShareMode = "FROZEN" | "LIVE";
+export type SharingResourceType = "FILE" | "SCENE" | string;
+export type SharingPrincipalType = "USER" | "GROUP" | "PUBLIC";
+export type SharingPermission = "READ" | "WRITE" | "OWNER" | string;
+export interface PageResult<T> {
+    content: T[];
+    totalElements: number;
+    totalPages: number;
+    size: number;
+    number: number;
+    first?: boolean;
+    last?: boolean;
+}
+export interface NgisFileRef {
+    id: number;
+    fileId: string;
+    ownerId: string;
+    folderId?: string | null;
+    displayName?: string | null;
+    hidden?: boolean;
+    createdAt?: string | null;
+    fileType?: string | null;
+    size?: number | null;
+    source?: string | null;
+    derivedFromFileId?: string | null;
+    producedByTaskId?: string | null;
+}
+export interface NgisFile {
+    id: string;
+    name?: string | null;
+    displayName?: string | null;
+    size?: number | null;
+    md5?: string | null;
+    minioKey?: string | null;
+    ownerCount?: number | null;
+    source?: string | null;
+    fileType?: string | null;
+    createdAt?: string | null;
+    deletedAt?: string | null;
+    orphanedAt?: string | null;
+    originFileId?: string | null;
+    originOwnerId?: string | null;
+    originSharedId?: string | null;
+    derivedFromFileId?: string | null;
+    producedByTaskId?: string | null;
+    flowField?: FlowFieldSummary | null;
+}
+export interface FlowFieldSummary {
+    status: string;
+    schemaVersion: string;
+    datasetVersion: string;
+    crs: string;
+    bounds: [number, number, number, number];
+    grid?: {
+        width?: number;
+        height?: number;
+        [key: string]: unknown;
+    } | null;
+    clip?: {
+        mode?: string;
+        sourceFileId?: string | null;
+        geometryType?: string | null;
+        geometryHash?: string | null;
+        rasterization?: string;
+        [key: string]: unknown;
+    } | null;
+    totalAssetBytes: number;
+    assetCount: number;
+    shareSupported: boolean;
+    copyToLibrarySupported: boolean;
+}
+export interface NgisFileFolder {
+    id: string;
+    ownerId: string;
+    name: string;
+    parentId?: string | null;
+    size?: number | null;
+    createdAt?: string | null;
+}
+export interface NgisUploadSession {
+    uploadId: string;
+    userId?: string | null;
+    fileName: string;
+    md5: string;
+    chunkCount: number;
+    bitmap?: string | null;
+    status?: string | null;
+    expireAt?: string | null;
+}
+export type StorageQuotaState = "NORMAL" | "FULL" | "OVER_LIMIT";
+export type StorageQuotaSpace = "PERSONAL" | "TRASH";
+export type StorageQuotaApplicationStatus = "PENDING" | "APPROVED" | "REJECTED" | "CANCELLED";
+export interface StorageQuota {
+    quotaBytes: number;
+    usedBytes: number;
+    reservedBytes: number;
+    availableBytes: number;
+    usageRatio: number;
+    state: StorageQuotaState;
+    pendingApplication?: {
+        id: string;
+        requestedQuotaBytes: number;
+        status: StorageQuotaApplicationStatus;
+        createdAt: string;
+    } | null;
+    trashQuotaBytes: number;
+    trashUsedBytes: number;
+    trashAvailableBytes: number;
+    trashUsageRatio: number;
+    trashState: StorageQuotaState;
+    trashRetentionDays: number;
+    pendingTrashApplication?: {
+        id: string;
+        requestedQuotaBytes: number;
+        status: StorageQuotaApplicationStatus;
+        createdAt: string;
+    } | null;
+}
+export interface StorageTrashSettings {
+    retentionDays: number;
+}
+export interface StorageQuotaApplication {
+    id: string;
+    applicantId: string;
+    applicantUsername?: string | null;
+    applicantEmail?: string | null;
+    quotaSpace: StorageQuotaSpace;
+    quotaAtSubmit: number;
+    usedAtSubmit: number;
+    requestedQuotaBytes: number;
+    reason: string;
+    status: StorageQuotaApplicationStatus;
+    reviewerId?: string | null;
+    grantedQuotaBytes?: number | null;
+    reviewNote?: string | null;
+    reviewedAt?: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface StorageQuotaAdminApplication {
+    application: StorageQuotaApplication;
+    currentQuotaBytes: number;
+    currentUsedBytes: number;
+    currentReservedBytes: number;
+    currentAvailableBytes: number;
+}
+export interface StorageQuotaApplicationDetail {
+    application: StorageQuotaApplication;
+    currentQuotaBytes: number;
+    currentUsedBytes: number;
+    currentReservedBytes: number;
+    applicantHistory: StorageQuotaApplication[];
+}
+export interface NgisResourcePermission {
+    id: number;
+    resourceType: SharingResourceType;
+    resourceId: string;
+    principalType: SharingPrincipalType | string;
+    principalId?: string | null;
+    permission: SharingPermission;
+    grantedBy: string;
+    grantedAt: string;
+}
+export interface NgisSharedResource {
+    id: string;
+    sourceFileId?: string | null;
+    ownerId?: string | null;
+    name?: string | null;
+    fileType?: string | null;
+    freezeStatus?: "PENDING" | "READY" | "FAILED" | string | null;
+    mode?: ResourceShareMode | string | null;
+    version?: number | null;
+    publishedAt?: string | null;
+}
+export interface NgisUserGroup {
+    id: string;
+    ownerId?: string | null;
+    name: string;
+    description?: string | null;
+    createdAt?: string | null;
+}
+export interface GrantSharingParams {
+    resourceType?: SharingResourceType;
+    resourceId: string;
+    principalType: SharingPrincipalType;
+    principalId?: string | null;
+    permission: SharingPermission;
+}
+export interface PublicFileView {
+    fileId: string;
+    displayName?: string | null;
+    fileType?: string | null;
+    size?: number | null;
+    ownerId?: string | null;
+    publishedAt?: string | null;
+}
+export interface DatasetField {
+    name: string;
+    type: string;
+    nullable?: boolean;
+}
+export interface DatasetInfo {
+    fileId: string;
+    snapshot?: boolean | null;
+    snapshotId?: string | null;
+    mode?: ResourceShareMode | string | null;
+    datasetType: "VECTOR" | "RASTER" | "GENERIC" | string;
+    status: "PENDING" | "PROCESSING" | "DONE" | "FAILED" | "NOT_REGISTERED" | "N/A" | string;
+    vector?: {
+        geometryType?: string | null;
+        featureCount?: number | null;
+        srid?: number | null;
+        nativeSrid?: number | null;
+        workingSrid?: number | null;
+        fieldsSchema?: DatasetField[] | string | null;
+        pgTableName?: string | null;
+        errorMessage?: string | null;
+    } | null;
+    raster?: {
+        cogVariantId?: string | null;
+        srid?: number | null;
+        bandCount?: number | null;
+        noDataValue?: number | null;
+        pixelSizeX?: number | null;
+        pixelSizeY?: number | null;
+        bandStats?: unknown;
+        errorMessage?: string | null;
+        cogVariantSize?: number | null;
+    } | null;
+}
+export interface RasterBandStats {
+    bandIndex?: number | null;
+    min?: number | null;
+    max?: number | null;
+    mean?: number | null;
+    std?: number | null;
+}
+export interface DatasetBbox {
+    minX: number;
+    minY: number;
+    maxX: number;
+    maxY: number;
+}
+export interface DatasetAttributeField {
+    name: string;
+    type: string;
+    nullable?: boolean;
+}
+export interface DatasetAttributeMeta {
+    datasetId: string;
+    type: string;
+    total: number;
+    fields: DatasetAttributeField[];
+    defaultSelect: string[];
+    sortable: string[];
+    filterable: string[];
+    maxPageSize: number;
+}
+export interface DatasetAttributeValueCount {
+    value: string | number | boolean | null;
+    count: number;
+}
+export interface DatasetAttributeValues {
+    field: string;
+    type: string;
+    totalCount: number;
+    uniqueCount: number;
+    truncated: boolean;
+    values: DatasetAttributeValueCount[];
+}
+export interface DatasetAttributeStats {
+    field: string;
+    type: string;
+    count: number;
+    nullCount: number;
+    min?: number | null;
+    max?: number | null;
+    mean?: number | null;
+    stddev?: number | null;
+    sum?: number | null;
+    percentiles?: Record<string, number>;
+}
+export interface ClassifyDatasetAttributeParams {
+    field: string;
+    method?: "equal-interval" | "quantile" | "natural-breaks";
+    classes?: number;
+}
+export interface DatasetAttributeClassifyResult {
+    field: string;
+    method: string;
+    classes: number;
+    breaks: number[];
+}
+export type DatasetAttributeWhereOp = "=" | "!=" | ">" | ">=" | "<" | "<=" | "like" | "in" | "between";
+export interface DatasetAttributeQueryParams {
+    select?: string[];
+    filter?: {
+        bbox?: [number, number, number, number];
+        where?: {
+            field: string;
+            op: DatasetAttributeWhereOp;
+            value: unknown;
+        }[];
+    };
+    sort?: {
+        field: string;
+        dir: "asc" | "desc";
+    }[];
+    page?: {
+        limit?: number;
+        offset?: number;
+        cursor?: string;
+    };
+    includeGeometry?: boolean;
+}
+/** One feature row from `attributes/query`. `id` is a stable per-feature UUID,
+ * returned on every row regardless of `select`, and usable for selection. */
+export interface DatasetFeatureRow extends Record<string, unknown> {
+    id: string;
+}
+export interface DatasetAttributeQueryResult {
+    items: DatasetFeatureRow[];
+    /** Number of rows returned in this page. */
+    pageSize: number;
+    /** True when at least one more row exists past this page. */
+    hasMore: boolean;
+    /**
+     * @deprecated Always `null`. The service hardcodes it and the endpoint pages
+     * by `page.offset` only — never gate `hasMore` on this field.
+     */
+    nextCursor: string | null;
+    /** Server-reported query time in ms (diagnostic). */
+    elapsedMs?: number;
+}
+/** The `filter` shape shared by `attributes/query`, `count`, `export`, `subset`. */
+export type DatasetAttributeFilter = NonNullable<DatasetAttributeQueryParams["filter"]>;
+export interface DatasetAttributeCountResult {
+    /** Number of rows matching the supplied filter (unfiltered total if omitted). */
+    count: number;
+    elapsedMs?: number;
+}
+/**
+ * A cross-window selection, expressed exactly one of two ways (per api-guide §4):
+ * an explicit id list (≤ 10000), or an all-matching `filter` minus deselections.
+ */
+export type DatasetAttributeSelection = {
+    ids: string[];
+} | {
+    filter?: DatasetAttributeFilter;
+    excludeIds?: string[];
+};
+export interface ExportDatasetAttributesParams {
+    selection: DatasetAttributeSelection;
+    format: "csv" | "geojson";
+    /** Columns to export (omitted → all fields). */
+    select?: string[];
+    includeGeometry?: boolean;
+}
+export interface ExportDatasetAttributesResult {
+    blob: Blob;
+    filename: string;
+}
+export interface SubsetDatasetAttributesResult {
+    /** The new derived dataset's file id (runs through the import pipeline). */
+    fileId: string;
+    datasetStatus: string;
+}
+export interface ResourceField {
+    name: string;
+    kind: string;
+    sample: string;
+}
+export interface ResourceFolder {
+    id: string;
+    name: string;
+    parentId: string | null;
+    sizeBytes: number;
+    createdAt: string | null;
+}
+export interface ResourceListItem {
+    id: string;
+    scope: ResourceScope;
+    fileId: string;
+    refId?: number | null;
+    folderId?: string | null;
+    name: string;
+    filename: string;
+    type: ResourceType;
+    status: ResourceStatus;
+    access: ResourceAccess;
+    ownerLabel: string;
+    source: string;
+    modifiedAt: string | null;
+    modified: string;
+    sizeBytes: number;
+    size: string;
+    features: string;
+    srid: string;
+    geometry: string;
+    format: string;
+    bbox: string;
+    lineage: string;
+    originFileId?: string | null;
+    derivedFromFileId?: string | null;
+    producedByTaskId?: string | null;
+    flowFieldClip?: FlowFieldSummary["clip"];
+    fields: ResourceField[];
+    tags: string[];
+    fileType: string;
+    datasetStatus: string;
+    errorMessage?: string | null;
+    readMode: ResourceReadMode;
+    snapshotId?: string | null;
+    shareMode: ResourceShareMode;
+    canCopy: boolean;
+    canDelete: boolean;
+    canManageSharing: boolean;
+    canRepublish: boolean;
+    canRetry: boolean;
+}
+export interface ResourceListResult {
+    items: ResourceListItem[];
+    page: number;
+    size: number;
+    total: number;
+}
+export type FileReferenceKind = "CURRENT_ORIGINAL" | "CURRENT_WORKING" | "HISTORICAL_VERSION";
+export interface FileReferenceInfo {
+    sceneId: string;
+    sceneName: string;
+    sceneOwnerId: string;
+    resourceId: string;
+    resourceName: string;
+    referenceKind: FileReferenceKind;
+}
+export interface FileShareSummary {
+    shared: boolean;
+    grantCount: number;
+    snapshotStatus?: string | null;
+    copyCount: number;
+}
+export interface FileDeletionPreflight {
+    sceneReferences: FileReferenceInfo[];
+    shareSummary: FileShareSummary;
+}
+export interface FileDetachSummary {
+    resourcesDeleted: number;
+    resourcesReverted: number;
+    versionsPruned: number;
+    scenesAffected: number;
+}
+export interface ListResourcesParams {
+    scope: ResourceScope;
+    folderId?: string | null;
+    page?: number;
+    size?: number;
+}
+export interface UploadProgress {
+    phase: "hashing" | "uploading" | "merging";
+    loaded: number;
+    total: number;
+}
+export interface UploadFileOptions {
+    folderId?: string | null;
+    fileName?: string;
+    chunkSize?: number;
+    onProgress?: (progress: UploadProgress) => void;
+    signal?: AbortSignal;
+    onSessionCreated?: (session: NgisUploadSession) => void;
+}
+export declare const resourcesApi: {
+    getFile(fileId: string): Promise<NgisFile>;
+    listResources(params: ListResourcesParams): Promise<ResourceListResult>;
+    getResourceDetail(resource: ResourceListItem): Promise<ResourceListItem>;
+    listFolders(parentId?: string | null): Promise<ResourceFolder[]>;
+    createFolder(name: string, parentId?: string | null): Promise<NgisFileFolder>;
+    renameFolder(folderId: string, name: string): Promise<NgisFileFolder>;
+    deleteFolder(folderId: string): Promise<void>;
+    moveFile(fileId: string, folderId: string | null): Promise<NgisFileRef>;
+    deleteFile(fileId: string, retentionDays?: number): Promise<void>;
+    restoreFile(fileId: string): Promise<void>;
+    getFileDeletionPreflight(fileId: string): Promise<FileDeletionPreflight>;
+    permanentlyDeleteFile(fileId: string): Promise<FileDetachSummary>;
+    cancelUpload(uploadId: string): Promise<void>;
+    copyToLibrary(fileId: string, folderId?: string | null): Promise<NgisFileRef>;
+    listGroups(): Promise<NgisUserGroup[]>;
+    listSharingPermissions(resourceId: string, resourceType?: SharingResourceType): Promise<NgisResourcePermission[]>;
+    grantSharingPermission(params: GrantSharingParams): Promise<NgisResourcePermission>;
+    revokeSharingPermission(resourceId: string, principalType: SharingPrincipalType, principalId?: string | null, resourceType?: SharingResourceType): Promise<void>;
+    republishSharingResource(resourceId: string, resourceType?: SharingResourceType): Promise<NgisSharedResource>;
+    retriggerDataset(fileId: string): Promise<void>;
+    getDataset(fileId: string): Promise<DatasetInfo>;
+    getDatasetBbox(fileId: string): Promise<DatasetBbox>;
+    getDatasetAttributeMeta(fileId: string): Promise<DatasetAttributeMeta>;
+    queryDatasetAttributes(fileId: string, params: DatasetAttributeQueryParams, signal?: AbortSignal): Promise<DatasetAttributeQueryResult>;
+    /** Exact count of rows matching `filter` (omit/`{}` → unfiltered total). */
+    countDatasetAttributes(fileId: string, filter?: DatasetAttributeFilter, signal?: AbortSignal): Promise<DatasetAttributeCountResult>;
+    /** Stream the selection as a CSV / GeoJSON file download. */
+    exportDatasetAttributes(fileId: string, params: ExportDatasetAttributesParams): Promise<ExportDatasetAttributesResult>;
+    /** Materialize the selection into a new derived dataset (import pipeline). */
+    subsetDatasetAttributes(fileId: string, selection: DatasetAttributeSelection): Promise<SubsetDatasetAttributesResult>;
+    getDatasetAttributeValues(fileId: string, field: string, limit?: number): Promise<DatasetAttributeValues>;
+    getDatasetAttributeStats(fileId: string, field: string): Promise<DatasetAttributeStats>;
+    classifyDatasetAttribute(fileId: string, params: ClassifyDatasetAttributeParams): Promise<DatasetAttributeClassifyResult>;
+    uploadFile(file: File, options?: UploadFileOptions): Promise<NgisFile>;
+    download(fileId: string, scope: ResourceScope): Promise<Response>;
+};
+export declare const storageQuotaApi: {
+    get(): Promise<StorageQuota>;
+    listApplications(page?: number, size?: number): Promise<PageResult<StorageQuotaApplication>>;
+    submitApplication(quotaSpace: StorageQuotaSpace, requestedQuotaBytes: number, reason: string): Promise<StorageQuotaApplication>;
+    getTrashSettings(): Promise<StorageTrashSettings>;
+    updateTrashSettings(retentionDays: number): Promise<StorageTrashSettings>;
+    cancelApplication(applicationId: string): Promise<StorageQuotaApplication>;
+    listAdminApplications(params?: {
+        status?: StorageQuotaApplicationStatus;
+        query?: string;
+        page?: number;
+        size?: number;
+        sort?: string;
+    }): Promise<PageResult<StorageQuotaAdminApplication>>;
+    getAdminApplication(applicationId: string): Promise<StorageQuotaApplicationDetail>;
+    approveApplication(applicationId: string, grantedQuotaBytes: number, reviewNote: string): Promise<StorageQuotaApplication>;
+    rejectApplication(applicationId: string, reviewNote: string): Promise<StorageQuotaApplication>;
+};