@chisquare-tech/origine-ngx-apps-services 0.2.4 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chisquare-tech/origine-ngx-apps-services",
-  "version": "0.2.4",
+  "version": "0.4.0",
   "description": "Origine's Services module screens: managed Postgres, MySQL and Valkey — the list with quota, the create wizard, and the instance page (connection details, attachments, databases and users, backups and PITR, metrics, logs, settings).",
   "repository": {
     "type": "git",

package/types/chisquare-tech-origine-ngx-apps-services.d.ts

@@ -8,16 +8,24 @@ interface ServicesProject {
     id: string;
     key: string;
     name: string;
-    /** The caller's capabilities on the project: view, resources.manage (Maintainer+), … */
-    capabilities: string[];
-    /** The organization's region, as the wizard shows it ("EU · Frankfurt"). */
+    /** The organization's region, the default for a new service, as the wizard shows it ("EU · Frankfurt"). */
     region?: string;
     archivedAt?: string;
 }
+/** A region a new service can run in (D-54), as the host offers it. */
+interface ServicesRegion {
+    id: string;
+    /** Its name as the organization's screens show it ("EU · Frankfurt"). */
+    name: string;
+    /** The organization's region: a new service's default. */
+    default?: boolean;
+}
 /** An app services can be attached to, with the environments it runs in. */
 interface ServicesApp {
     name: string;
     environments: string[];
+    /** The region each environment runs in, by environment (D-54), when deploy says. */
+    regions?: Record<string, string>;
 }
 /**
  * What the Services screens need from the app that mounts them (cloud/web provides it, as it
@@ -27,6 +35,16 @@ interface ServicesApp {
 declare abstract class ServicesHost {
     abstract readonly project: Signal<ServicesProject | null>;
     abstract readonly projectLoaded: Signal<boolean>;
+    /**
+     * Whether the caller holds capability id on the project (V4-01): for every environment, or for a
+     * protected or unprotected one. An instance's own page reads Detail.caps, for its environment.
+     */
+    abstract can(id: string, env?: 'protected' | 'unprotected'): boolean;
+    /**
+     * The regions on offer for a new service, the organization's marked default (D-54). With none or
+     * one there is nothing to pick, and the wizard shows the region as text.
+     */
+    regions?(): ServicesRegion[];
     /** A router link to a path inside the current project ('' is its overview). */
     abstract link(path?: string): string[];
     /** The project's apps; empty when there are none (attaching then takes a typed name). */
@@ -60,6 +78,11 @@ interface Engine {
     dumps?: boolean;
     console: 'sql' | 'keys' | 'streams' | 'queues';
     parameters: Param[];
+    /** The extensions a database may create (Postgres, D-30). */
+    extensions?: {
+        name: string;
+        description: string;
+    }[];
 }
 interface Param {
     engine: string;
@@ -150,6 +173,9 @@ interface Summary {
     purgeAt?: string;
     nodes: number;
     fork: boolean;
+    /** Where it runs (D-54): picked at creation, the organization's region by default. */
+    region?: string;
+    regionName?: string;
 }
 interface ServiceList {
     items: Summary[];
@@ -159,6 +185,67 @@ interface Database {
     name: string;
     createdBy: string;
     createdAt: string;
+    /** Postgres extensions asked for in it (V8-04), each created once the cell reports it. */
+    extensions?: {
+        name: string;
+        created: boolean;
+    }[];
+}
+/** A major version upgrade (V8-01). */
+interface Upgrade {
+    id: string;
+    from: string;
+    to: string;
+    method: 'in-place' | 'new-instance' | string;
+    state: 'scheduled' | 'backing-up' | 'upgrading' | 'testing' | 'ready' | 'done' | 'failed' | 'canceled' | string;
+    at: string;
+    scheduled: boolean;
+    backup: string;
+    backupName?: string;
+    target?: string;
+    targetName?: string;
+    message?: string;
+    startedAt?: string;
+    finishedAt?: string;
+}
+interface UpgradeView {
+    current?: Upgrade;
+    offer: {
+        to?: string;
+        methods: string[];
+        refused?: string;
+        notes: string[];
+    };
+    running?: string;
+}
+/** Backup copies in another region (V8-02). */
+interface CopyView {
+    region: string;
+    regionName: string;
+    last?: {
+        region: string;
+        at: string;
+        objects: number;
+        bytes: number;
+        copied: number;
+        deleted: number;
+        error?: string;
+        through?: string;
+    };
+    offered: {
+        id: string;
+        name: string;
+    }[];
+}
+/** Storage auto-grow (V8-04). */
+interface StorageView {
+    autoGrow: boolean;
+    maxGb: number;
+    limitGb: number;
+    expandable?: boolean;
+    message?: string;
+    grownAt?: string;
+    atPercent: number;
 }
 interface UserView {
     name: string;
@@ -167,6 +254,10 @@ interface UserView {
     rotating: boolean;
     attached: string[];
     createdAt: string;
+    /** Its scheduled rotation: every rotateEveryDays days (0: none), next on nextRotation. */
+    rotateEveryDays: number;
+    rotatedAt?: string;
+    nextRotation?: string;
 }
 interface Backup {
     name: string;
@@ -252,7 +343,8 @@ interface Detail extends Summary {
     restoreBackup?: string;
     provisionedAt?: string;
     finalBackup: boolean;
-    canManage: boolean;
+    /** The services capability ids the caller holds on this instance's environment (V4-01). */
+    caps: string[];
     standby: boolean;
     replicas: number;
     readyNodes: number;
@@ -276,6 +368,10 @@ interface Detail extends Summary {
     /** RabbitMQ: what the caller's role opens of the management UI. */
     management?: 'admin' | 'read' | '';
     restoreVolumes?: boolean;
+    upgrade?: UpgradeView;
+    copy?: CopyView;
+    storage?: StorageView;
+    restoreCopy?: boolean;
 }
 interface Revealed {
     user: string;
@@ -340,6 +436,8 @@ interface CreateInput {
     version?: string;
     plan: string;
     environment?: string;
+    /** The region it runs in (D-54): one of the regions on offer; the organization's when left out. */
+    region?: string;
     database?: string;
     backupHour?: number;
     retentionDays?: number;
@@ -364,6 +462,11 @@ interface UpdateInput {
     standby?: boolean;
     replicas?: number;
     parameters?: Record<string, string>;
+    /** V8-02: the region backups are copied to ('' stops copying and deletes the copies). */
+    copyRegion?: string;
+    /** V8-04: storage auto-grow and its cap in GB (0: the limit). */
+    autoGrow?: boolean;
+    autoGrowMaxGb?: number;
 }
 declare function apiMessage(err: any, fallback?: string): string;
 declare class ServicesApi {
@@ -382,17 +485,29 @@ declare class ServicesApi {
     removeDatabase(project: string, id: string, name: string): Observable<unknown>;
     addUser(project: string, id: string, name: string, preset: string): Observable<unknown>;
     removeUser(project: string, id: string, name: string): Observable<unknown>;
+    /** A user's scheduled rotation: every 30 to 365 days, or 0 for none (V0-22). */
+    setRotation(project: string, id: string, user: string, rotateEveryDays: number): Observable<Detail>;
     rotate(project: string, id: string, user?: string, graceMinutes?: number): Observable<Rotation>;
     retire(project: string, id: string, rotation: string): Observable<unknown>;
     backupNow(project: string, id: string): Observable<unknown>;
     deleteBackup(project: string, id: string, name: string): Observable<unknown>;
     /** A link to a RabbitMQ instance's management UI, for the caller only (read-only for Developers). */
     management(project: string, id: string): Observable<ManagementLink>;
+    /** A major version upgrade (V8-01): in place or into a new instance, now or in the maintenance window. */
+    upgrade(project: string, id: string, body: {
+        version?: string;
+        method: string;
+        when: 'now' | 'window';
+    }): Observable<Detail>;
+    cancelUpgrade(project: string, id: string): Observable<Detail>;
+    addExtension(project: string, id: string, database: string, name: string): Observable<Detail>;
+    removeExtension(project: string, id: string, database: string, name: string): Observable<Detail>;
     restore(project: string, id: string, body: {
         pointInTime?: string;
         backup?: string;
         name?: string;
         volumes?: boolean;
+        region?: string;
     }): Observable<Detail>;
     attach(project: string, id: string, body: {
         app: string;
@@ -493,6 +608,7 @@ declare class ServicesListPage {
     protected readonly backups: typeof backupsLine;
     protected readonly price: typeof money;
     protected readonly rows: _angular_core.Signal<Summary[]>;
+    /** services.instance.create in some environment (V4-01). */
     protected readonly canManage: _angular_core.Signal<boolean>;
     protected readonly quotaLine: _angular_core.Signal<string>;
     private readonly route;
@@ -538,13 +654,16 @@ declare class ServicesNewPage {
     protected readonly attach: _angular_core.WritableSignal<string>;
     protected readonly hour: _angular_core.WritableSignal<number>;
     protected readonly ha: _angular_core.WritableSignal<boolean>;
-    protected readonly nodes: _angular_core.Signal<1 | 2 | 3>;
+    protected readonly nodes: _angular_core.Signal<2 | 1 | 3>;
     protected readonly haLabel: _angular_core.Signal<string>;
     protected readonly keep: _angular_core.WritableSignal<number>;
     protected readonly busy: _angular_core.WritableSignal<boolean>;
     protected readonly error: _angular_core.WritableSignal<string>;
     protected readonly engines: _angular_core.Signal<Engine[]>;
     protected readonly plans: _angular_core.Signal<Plan[]>;
+    /** The regions on offer (D-54), the organization's picked for you; with one, the region is text. */
+    protected readonly regions: _angular_core.Signal<_chisquare_tech_origine_ngx_apps_services.ServicesRegion[]>;
+    protected readonly regionId: _angular_core.WritableSignal<string>;
     protected readonly region: _angular_core.Signal<string>;
     protected readonly versionLabel: _angular_core.Signal<string>;
     protected readonly envs: _angular_core.Signal<string[]>;
@@ -651,7 +770,13 @@ declare class ServicePage {
     protected readonly engine: _angular_core.Signal<Engine | null>;
     protected readonly envVar: _angular_core.Signal<string>;
     protected readonly plans: _angular_core.Signal<Plan[]>;
+    /** Where the instance runs (D-54): its own region, the organization's by default. */
     protected readonly region: _angular_core.Signal<string>;
+    /** The region of the chosen app's chosen environment, when deploy says (D-54). */
+    protected readonly attRegion: _angular_core.Signal<string>;
+    /** An app attaches only to a service in its own region (D-54). */
+    protected readonly attOtherRegion: _angular_core.Signal<boolean>;
+    protected readonly rotationPeriods: number[];
     protected readonly conn: _angular_core.Signal<_chisquare_tech_origine_ngx_apps_services.Connection | null>;
     protected readonly snippetKeys: _angular_core.Signal<string[]>;
     protected readonly backups: _angular_core.Signal<Backup[]>;
@@ -684,6 +809,14 @@ declare class ServicePage {
     protected dialogTitle(dl: Dialog, d: Detail): string;
     private run;
     protected toggleReveal(d: Detail): void;
+    /** Whether the caller holds capability id on the instance's environment (V4-01). */
+    protected has(d: Detail, id: string): boolean;
+    /** A user's scheduled rotation (V0-22): every 30 to 365 days, or never. */
+    protected setRotation(d: Detail, user: string, days: number): void;
+    protected rotationLine(u: {
+        rotateEveryDays: number;
+        nextRotation?: string;
+    }): string;
     protected attach(d: Detail): void;
     protected detach(d: Detail, a: Attachment): void;
     protected askRotate(d: Detail): void;
@@ -691,6 +824,9 @@ declare class ServicePage {
     protected retire(d: Detail, r: Rotation): void;
     protected addDb(d: Detail): void;
     protected removeDb(d: Detail, name: string): void;
+    /** A Postgres extension from the allow-list (V8-04, D-30); what it needs comes with it. */
+    protected addExt(d: Detail, db: string, name: string): void;
+    protected dropExt(d: Detail, db: string, name: string): void;
     protected addUser(d: Detail): void;
     protected removeUser(d: Detail, name: string): void;
     protected backupNow(d: Detail): void;
@@ -802,7 +938,9 @@ declare class ServiceConsoleTab {
     private readonly api;
     readonly d: _angular_core.InputSignal<Detail>;
     readonly projectKey: _angular_core.InputSignal<string>;
-    readonly kind: _angular_core.InputSignal<"keys" | "sql" | "streams" | "queues">;
+    /** The console and the inspector need services.connect on the instance's environment (V4-01). */
+    protected readonly may: _angular_core.Signal<boolean>;
+    readonly kind: _angular_core.InputSignal<"sql" | "keys" | "streams" | "queues">;
     protected readonly sql: _angular_core.Signal<boolean>;
     protected readonly running: _angular_core.Signal<boolean>;
     protected readonly runsAs: _angular_core.Signal<string>;
@@ -833,6 +971,8 @@ declare class ServiceDumpsCard {
     private readonly router;
     readonly d: _angular_core.InputSignal<Detail>;
     readonly projectKey: _angular_core.InputSignal<string>;
+    /** Whether the caller holds capability id on the instance's environment (V4-01). */
+    protected may(id: string): boolean;
     readonly dumps: _angular_core.InputSignal<boolean>;
     readonly done: _angular_core.OutputEmitterRef<string>;
     readonly failed: _angular_core.OutputEmitterRef<string>;
@@ -857,4 +997,4 @@ declare class ServiceDumpsCard {
 }
 
 export { DAYS, ENGINE_COLOUR, HIDDEN_POLL_MS, LIFECYCLE, PRESETS, ServiceConsoleTab, ServiceDumpsCard, ServiceLogsTab, ServiceMetricsTab, ServicePage, ServicesApi, ServicesHost, ServicesListPage, ServicesNewPage, apiMessage, backupKind, backupsLine, bytes, fromLocalInput, hhmm, hhmmss, money, moving, num, pct, pollDelay, presetChip, ratio, shortDate, spark, sparkPath, stateChip, stateDot, toLocalInput, utcHour, when };
-export type { Attachment, Backup, Catalog, Connection, CreateInput, Database, Detail, Dump, Engine, EngineVersion, Figure, Gauge, Inspection, LogKind, LogLine, Logs, ManagementLink, Metrics, Param, Plan, PodView, QueryResult, Quota, Revealed, Rotation, ServiceList, ServicesApp, ServicesProject, State, Stream, Summary, UpdateInput, UserView };
+export type { Attachment, Backup, Catalog, Connection, CopyView, CreateInput, Database, Detail, Dump, Engine, EngineVersion, Figure, Gauge, Inspection, LogKind, LogLine, Logs, ManagementLink, Metrics, Param, Plan, PodView, QueryResult, Quota, Revealed, Rotation, ServiceList, ServicesApp, ServicesProject, ServicesRegion, State, StorageView, Stream, Summary, UpdateInput, Upgrade, UpgradeView, UserView };