@stackshift-cloud/sdk 1.1.0 → 1.2.0

package/dist/types.d.ts

@@ -1,8 +1,11 @@
+import type { MailMode, MailSimulationOptions } from './mail-simulation.js';
+import type { MailTrackingOptions } from './mail-tracking.js';
 export type JsonValue = string | number | boolean | null | JsonValue[] | {
     [key: string]: JsonValue;
 };
 export type AssetVisibility = 'public' | 'private';
 export interface StackShiftOptions {
+    assetSpaceId?: string;
     apiKey?: string;
     baseUrl?: string;
     mailBaseUrl?: string;
@@ -23,6 +26,7 @@ export interface MailDnsRecord {
     explanation?: string;
 }
 export interface MailDomain {
+    health?: import('./mail-subscribers.js').MailSendingDomainHealth;
     id: string;
     domain: string;
     status: MailDomainStatus;
@@ -45,6 +49,8 @@ export interface MailAddress {
 }
 export type MailAddressInput = string | MailAddress | Array<string | MailAddress>;
 export interface MailSendInput {
+    simulation?: MailSimulationOptions;
+    tracking?: MailTrackingOptions;
     from: string | MailAddress;
     to: MailAddressInput;
     cc?: MailAddressInput;
@@ -67,11 +73,13 @@ export interface MailSendInput {
     stream?: string;
 }
 export interface MailSendResponse {
+    mode?: MailMode;
     id: string;
     status: MailStatus;
     idempotencyStatus: MailIdempotencyStatus;
 }
 export interface MailMessage {
+    mode?: MailMode;
     id: string;
     from: MailAddress;
     to: string[];
@@ -138,6 +146,7 @@ export interface MailRecipientSummary {
     complained: number;
 }
 export interface MailMessageSummary {
+    mode?: MailMode;
     id: string;
     from: string;
     to: string[];
@@ -269,6 +278,7 @@ export interface AssetVersion {
     created_at: string;
 }
 export interface AssetCollection {
+    revision: number;
     id: string;
     name: string;
     description?: string;
@@ -298,6 +308,9 @@ export interface AssetUploadOptions {
     metadata?: Record<string, JsonValue>;
 }
 export interface AssetListOptions {
+    collectionId?: string;
+    duplicates?: boolean;
+    security?: 'all' | 'clean' | 'pending' | 'failed';
     bucket?: string;
     prefix?: string;
     visibility?: AssetVisibility;

package/dist/workload-security.d.ts

@@ -0,0 +1,172 @@
+import type { StackShift } from './client.js';
+export type AdmissionDecision = 'allow' | 'review' | 'block';
+export type SecurityResourceStatus = 'pending' | 'approved' | 'rejected' | 'revoked' | 'expired';
+export type SecurityIncidentStatus = 'open' | 'reviewing' | 'quarantined' | 'released' | 'dismissed';
+export interface WorkloadAdmission {
+    id: string;
+    project_id?: string;
+    deployment_id?: string;
+    environment: string;
+    execution_kind: string;
+    image_reference: string;
+    image_digest: string;
+    policy_version: string;
+    decision: AdmissionDecision;
+    sanitized_evidence: unknown;
+    receipt_digest: string;
+    issued_at: string;
+    expires_at: string;
+    revoked_at?: string;
+}
+export interface ExternalDependency {
+    id: string;
+    project_id: string;
+    environment: string;
+    hostname: string;
+    port: number;
+    protocol: string;
+    purpose: string;
+    tls_required: boolean;
+    private_route_required: boolean;
+    detected: boolean;
+    status: string;
+    created_at: string;
+    updated_at: string;
+}
+export interface EgressGrant {
+    id: string;
+    project_id: string;
+    dependency_id?: string;
+    environment: string;
+    protocol: string;
+    hostname?: string;
+    cidr?: string;
+    port_start: number;
+    port_end: number;
+    purpose: string;
+    status: SecurityResourceStatus;
+    broad_public_egress: boolean;
+    expires_at: string;
+    resolved_cidrs?: string[];
+    created_at: string;
+    updated_at: string;
+}
+export interface PrivateRoute {
+    id: string;
+    project_id: string;
+    node_id: string;
+    environment: string;
+    route_kind: string;
+    cidr: string;
+    hostname?: string;
+    purpose: string;
+    status: SecurityResourceStatus;
+    expires_at: string;
+    created_at: string;
+    updated_at: string;
+}
+export interface NetworkDestination {
+    protocol: string;
+    hostname?: string;
+    cidrs?: string[];
+    port_start: number;
+    port_end: number;
+    purpose: string;
+    grant_id?: string;
+    expires_at?: string;
+}
+export interface NetworkPolicy {
+    version: string;
+    mode: 'restricted' | 'quarantined';
+    allow_stackshift_dns: boolean;
+    allow_public_web: boolean;
+    destinations: NetworkDestination[];
+    block_private_ranges: boolean;
+    block_metadata: boolean;
+    block_alternate_dns: boolean;
+    block_unexpected_udp: boolean;
+}
+export interface PolicyInspection {
+    effective: boolean;
+    policy?: NetworkPolicy;
+    pending_dependencies?: ExternalDependency[];
+}
+export interface SecurityIncident {
+    id: string;
+    project_id: string;
+    deployment_id?: string;
+    environment: string;
+    category: string;
+    confidence: 'low' | 'medium' | 'high';
+    status: SecurityIncidentStatus;
+    sanitized_summary: string;
+    sanitized_evidence: unknown;
+    quarantined_at?: string;
+    enforcement_status: string;
+    released_at?: string;
+    resolution_note?: string;
+    created_at: string;
+    updated_at: string;
+}
+export interface DeclareDependencyInput {
+    environment: string;
+    hostname: string;
+    port: number;
+    protocol: string;
+    purpose: string;
+    tls_required?: boolean;
+}
+export interface RequestGrantInput {
+    dependency_id?: string;
+    environment: string;
+    protocol: string;
+    hostname?: string;
+    cidr?: string;
+    port_start: number;
+    port_end: number;
+    purpose: string;
+    broad_public_egress?: boolean;
+    expires_at: string;
+}
+export interface RequestPrivateRouteInput {
+    node_id: string;
+    environment: string;
+    route_kind: string;
+    cidr: string;
+    hostname?: string;
+    purpose: string;
+    expires_at: string;
+}
+export declare class WorkloadSecurityClient {
+    private readonly client;
+    constructor(client: StackShift);
+    private root;
+    admissions(projectId: string, limit?: number): Promise<{
+        admissions: WorkloadAdmission[];
+    }>;
+    policy(projectId: string, environment?: string): Promise<PolicyInspection>;
+    dependencies(projectId: string, environment?: string): Promise<{
+        dependencies: ExternalDependency[];
+    }>;
+    declareDependency(projectId: string, input: DeclareDependencyInput): Promise<{
+        dependencies: ExternalDependency[];
+    }>;
+    refreshDependencies(projectId: string, environment: string): Promise<{
+        dependencies: ExternalDependency[];
+    }>;
+    grants(projectId: string, environment?: string): Promise<{
+        grants: EgressGrant[];
+    }>;
+    requestGrant(projectId: string, input: RequestGrantInput): Promise<EgressGrant>;
+    privateRoutes(projectId: string, environment?: string): Promise<{
+        private_routes: PrivateRoute[];
+    }>;
+    requestPrivateRoute(projectId: string, input: RequestPrivateRouteInput): Promise<PrivateRoute>;
+    incidents(projectId: string, status?: SecurityIncidentStatus, limit?: number): Promise<{
+        incidents: SecurityIncident[];
+    }>;
+    incident(projectId: string, incidentId: string): Promise<{
+        incident: SecurityIncident;
+        notifications: unknown[];
+    }>;
+}

package/dist/workload-security.js

@@ -0,0 +1,50 @@
+export class WorkloadSecurityClient {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    root(projectId) {
+        return `/projects/${encodeURIComponent(projectId)}/security`;
+    }
+    admissions(projectId, limit) {
+        return this.client.request(withQuery(`${this.root(projectId)}/admissions`, { limit }));
+    }
+    policy(projectId, environment) {
+        return this.client.request(withQuery(`${this.root(projectId)}/policy`, { environment }));
+    }
+    dependencies(projectId, environment) {
+        return this.client.request(withQuery(`${this.root(projectId)}/dependencies`, { environment }));
+    }
+    declareDependency(projectId, input) {
+        return this.client.request(`${this.root(projectId)}/dependencies`, { method: 'POST', body: input });
+    }
+    refreshDependencies(projectId, environment) {
+        return this.client.request(`${this.root(projectId)}/dependencies/refresh`, { method: 'POST', body: { environment } });
+    }
+    grants(projectId, environment) {
+        return this.client.request(withQuery(`${this.root(projectId)}/grants`, { environment }));
+    }
+    requestGrant(projectId, input) {
+        return this.client.request(`${this.root(projectId)}/grants`, { method: 'POST', body: input });
+    }
+    privateRoutes(projectId, environment) {
+        return this.client.request(withQuery(`${this.root(projectId)}/private-routes`, { environment }));
+    }
+    requestPrivateRoute(projectId, input) {
+        return this.client.request(`${this.root(projectId)}/private-routes`, { method: 'POST', body: input });
+    }
+    incidents(projectId, status, limit) {
+        return this.client.request(withQuery(`${this.root(projectId)}/incidents`, { status, limit }));
+    }
+    incident(projectId, incidentId) {
+        return this.client.request(`${this.root(projectId)}/incidents/${encodeURIComponent(incidentId)}`);
+    }
+}
+function withQuery(path, values) {
+    const query = new URLSearchParams();
+    for (const [key, value] of Object.entries(values)) {
+        if (value !== undefined && value !== '')
+            query.set(key, String(value));
+    }
+    return query.size ? `${path}?${query}` : path;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackshift-cloud/sdk",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Official JavaScript and TypeScript SDK for StackShift.",
   "type": "module",
   "main": "./dist/index.js",
@@ -17,7 +17,7 @@
   ],
   "scripts": {
     "build": "tsc -p tsconfig.json",
-    "test": "npm run build && node test/mail.test.mjs && node test/mail-webhooks.test.mjs && node test/mail-advanced.test.mjs && node test/mail-exports.test.mjs && node test/mail-diagnostics.test.mjs && node test/assets.test.mjs && node test/assets-platform.test.mjs"
+    "test": "npm run build && node test/mail.test.mjs && node test/mail-simulation.test.mjs && node test/mail-platform.test.mjs && node test/mail-webhooks.test.mjs && node test/mail-advanced.test.mjs && node test/mail-tracking.test.mjs && node test/mail-subscribers.test.mjs && node test/mail-exports.test.mjs && node test/mail-diagnostics.test.mjs && node test/assets.test.mjs && node test/assets-platform.test.mjs && node test/assets-video.test.mjs && node test/assets-dam.test.mjs"
   },
   "devDependencies": {
     "typescript": "^5.4.0"