@norskvideo/norsk-manager-sdk 1.0.356

package/lib/src/sdk.d.ts

@@ -0,0 +1,629 @@
+import { Version as CommonVersion } from "@norskvideo/norsk-api/lib/shared/common_pb";
+/** @public */
+export declare type JobId = string;
+/** @public */
+export declare type Role = string;
+/** @public */
+export declare type ContainerUrl = string;
+/** @public */
+export declare type DockerContainer = {
+    codeType: "docker";
+    url: ContainerUrl;
+};
+/** @public */
+export declare type ClientCode = DockerContainer;
+/** @public */
+export declare type JobHistoryJobCreated = {
+    event: "created";
+    timestamp: Date;
+};
+/** @public */
+export declare type JobHistoryJobUpdated = {
+    event: "updated";
+    timestamp: Date;
+    previousJob: Job;
+};
+/** @public */
+export declare type JobHistoryJobProvisioned = {
+    event: "provisioned";
+    timestamp: Date;
+    role: Role;
+    nodeMetadata: NodeMetadata;
+};
+/** @public */
+export declare type JobHistoryJobRunning = {
+    event: "running";
+    timestamp: Date;
+    role: Role;
+    nodeMetadata: NodeMetadata;
+    runningNodeMetadata: RunningNodeMetadata;
+};
+/** @public */
+export declare type JobHistoryJobStopping = {
+    event: "stopping";
+    timestamp: Date;
+    role: Role;
+    nodeMetadata: NodeMetadata;
+    runningNodeMetadata?: RunningNodeMetadata;
+    reason: "nodeStopped" | "nodeTerminated" | "userRequested" | "unknownJob" | "jobFailed";
+};
+/** @public */
+export declare type JobHistoryJobStopped = {
+    event: "stopped";
+    timestamp: Date;
+    role: Role;
+    nodeMetadata: NodeMetadata;
+    runningNodeMetadata?: RunningNodeMetadata;
+};
+/** @public */
+export declare type JobHistoryJobCompleted = {
+    event: "completed";
+    timestamp: Date;
+};
+/** @public */
+export declare type JobHistoryEntry = JobHistoryJobCreated | JobHistoryJobUpdated | JobHistoryJobProvisioned | JobHistoryJobRunning | JobHistoryJobStopping | JobHistoryJobStopped | JobHistoryJobCompleted;
+/** @public */
+export declare type JobState = "pre" | "active" | "post";
+/** @public */
+export declare type ServiceRestart = "never" | "onFailure" | "always";
+/** @public */
+export declare type RestartIntensity = {
+    count: number;
+    period: number;
+};
+/** @public */
+export declare type EphemeralHostPort = {
+    type: "ephemeral";
+};
+/** @public */
+export declare type RangeHostPort = {
+    type: "range";
+    minPort: number;
+    maxPort: number;
+};
+/** @public */
+export declare type SpecificHostPort = {
+    type: "specific";
+    port: number;
+};
+/** @public */
+export declare type HostPort = EphemeralHostPort | RangeHostPort | SpecificHostPort;
+/** @public */
+export declare type PortMapping = {
+    containerPort: number;
+    protocol?: "tcp" | "udp";
+    hostPort: HostPort;
+    hostAddress?: string;
+};
+/** @public */
+export declare type EnvironmentVariable = {
+    name: string;
+    value: string;
+};
+/** @public */
+export declare type VolumeMount = {
+    volumeName: string;
+    containerPath: string;
+    readOnly: boolean;
+};
+/** @public */
+export declare type ServiceParameters = {
+    portMappings?: PortMapping[];
+    environmentVariables?: EnvironmentVariable[];
+    sharedMemorySize?: bigint;
+    cpuSet?: number[];
+    volumeMounts?: VolumeMount[];
+};
+/** @public */
+export declare type Service = {
+    name: string;
+    container: ClientCode;
+    restart?: ServiceRestart;
+    dependsOn?: Set<string>;
+    configuration?: string;
+    restartIntensity?: RestartIntensity;
+    command?: string;
+    parameters?: ServiceParameters;
+};
+/** @public */
+export declare type Job = {
+    jobId: JobId;
+    cloud: Cloud;
+    description: string;
+    tags: Map<string, string>;
+    startDateTime: Date;
+    currentHash: bigint;
+    services: Service[];
+    volumes?: string[];
+    managerConfiguration?: string;
+    norskMediaVersion: Version;
+    norskServiceParameters?: ServiceParameters;
+    state: JobState;
+    shape: string;
+    availabilityDomain: string;
+    subnet: string;
+    architecture: string;
+};
+/** @public */
+export declare type CreateJob = Omit<Job, "state" | "currentHash">;
+/** @public */
+export declare type JobWithHistory = {
+    job: Job;
+    history: JobHistoryEntry[];
+};
+/** @public */
+export declare type AwsNodeId = string;
+/** @public */
+export declare type PhysicalNodeId = string;
+/** @public */
+export declare type NodeId = string;
+/** @public */
+export declare type Version = "latest" | "recommended" | "previousRecommended" | "LTS";
+/** @public */
+export declare type Cloud = "aws" | "oci";
+/** @public */
+export declare type AwsInstanceId = string;
+/** @public */
+export declare type AwsInstanceType = string;
+/** @public */
+export declare type AwsRegion = string;
+export declare type OciRegion = string;
+/**  @public */
+export declare class AwsLaunchTemplateName {
+    name: string;
+    version?: string;
+}
+/**  @public */
+export declare class AwsLaunchTemplateId {
+    id: string;
+    version?: string;
+}
+/** @public */
+export declare type DaemonVersion = string;
+/** @public */
+export declare type AwsNodeCreate = {
+    nodeId: NodeId;
+    tags: Map<string, string>;
+    region: AwsRegion;
+    instanceType: string;
+    template?: AwsLaunchTemplateName | AwsLaunchTemplateId;
+    workerImageVersion?: Version;
+    workerDaemonVersion?: Version;
+};
+/** @public */
+export declare type OciNodeCreate = {
+    nodeId: NodeId;
+    tags: Map<string, string>;
+    availabilityDomain: OciRegion;
+    architecture: string;
+    shape: string;
+    subnet: string;
+    workerImageVersion?: Version;
+    workerDaemonVersion?: Version;
+};
+/** @public */
+export declare type RunningAwsMetadata = {
+    provider: "aws";
+    instanceId: AwsInstanceId;
+};
+/** @public */
+export declare type RunningOciMetadata = {
+    provider: "oci";
+};
+/** @public */
+export declare type RunningNodeProviderMetadata = RunningAwsMetadata | RunningOciMetadata;
+/** @public */
+export declare type RunningNodeMetadata = {
+    publicDnsName?: string;
+    privateDnsName: string;
+    privateIpAddress: string;
+    providerMetadata: RunningNodeProviderMetadata;
+};
+/** @public */
+export declare type AwsMetadata = {
+    provider: "aws";
+    instanceType: AwsInstanceType;
+    region: AwsRegion;
+};
+/** @public */
+export declare type OciMetadata = {
+    provider: "oci";
+};
+/** @public */
+export declare type ProviderMetadata = AwsMetadata | OciMetadata;
+/** @public */
+export declare type NodeMetadata = {
+    nodeId: NodeId;
+    tags: Map<string, string>;
+    createdAt?: Date;
+    providerMetadata: ProviderMetadata;
+};
+/** @public */
+export declare type PhysicalNode = {
+    nodeType: "physical";
+    id: PhysicalNodeId;
+    tags: Map<string, string>;
+    ipAddress: string;
+};
+/** @public */
+export declare type Log = {
+    level: "emergency" | "alert" | "critical" | "error" | "warning" | "notice" | "info" | "debug";
+    timestamp: Date;
+    message: string;
+};
+/**
+ * @public
+ * Top level Norsk configuration
+ */
+export interface NorskSettings {
+    /**
+     * Callback URL to listen on for gRPC session with Norsk Media
+     *
+     */
+    url?: string;
+    onAttemptingToConnect?: () => void;
+    onConnecting?: () => void;
+    onReady?: () => void;
+    onFailedToConnect?: () => void;
+    onShutdown?: () => void;
+    onHello?: (version: CommonVersion) => void;
+    onLogEvent?: (log: Log) => void;
+}
+/** @public */
+export declare type RunningJob = {
+    jobId: JobId;
+    role: Role;
+    nodeId: NodeId;
+};
+/**
+ * @public
+ * Job is almost ready to start - "almost" defined by property passed into
+ * the list functions - todo, sort out this description
+ * */
+export declare type JobPending = {
+    event: "jobPending";
+    jobWithHistory: JobWithHistory;
+};
+/**
+ * @public
+ * Job details have been updated
+ * */
+export declare type JobUpdated = {
+    event: "jobUpdated";
+    jobWithHistory: JobWithHistory;
+};
+/**
+ * @public
+ * A job has been updated such that it no longer matches the search criteria
+ * */
+export declare type JobOutOfWindow = {
+    event: "jobOutOfWindow";
+    jobWithHistory: JobWithHistory;
+};
+/**
+ * @public
+ * A job has been deleted
+ * */
+export declare type JobDeleted = {
+    event: "jobDeleted";
+    jobId: JobId;
+};
+/** @public */
+declare type JobInfoServiceStarted = {
+    type: "serviceStarted";
+    serviceName: string;
+};
+/** @public */
+declare type JobInfoServiceRestarting = {
+    type: "serviceRestarting";
+    serviceName: string;
+};
+/** @public */
+declare type JobInfoContainerEvent = {
+    type: "containerEvent";
+    serviceName: string;
+    text: string;
+};
+/** @public */
+declare type JobInfoComposeStage = "build" | "create" | "start" | "stop" | "down";
+/** @public */
+declare type JobInfoComponseMessage = {
+    type: "composeMessage";
+    stage: JobInfoComposeStage;
+    text: string;
+};
+/** @public */
+declare type JobInfoMessage = JobInfoServiceStarted | JobInfoServiceRestarting | JobInfoContainerEvent | JobInfoComponseMessage;
+/**
+ * @public
+ * Informational messages about a job
+ * */
+export declare type JobInfo = {
+    event: "jobInfo";
+    jobId: JobId;
+    role: Role;
+    timestamp: Date;
+    message: JobInfoMessage;
+};
+/**
+ * @public
+ * A node is starting
+ * */
+export declare type NodeStarting = {
+    event: "nodeStarting";
+    nodeMetadata: NodeMetadata;
+};
+/**
+ * @public
+ * A node has started
+ * */
+export declare type NodeStarted = {
+    event: "nodeStarted";
+    nodeMetadata: NodeMetadata;
+    runningNodeMetadata: RunningNodeMetadata;
+};
+/**
+ * @public
+ * A node is stopping
+ * */
+export declare type NodeStopping = {
+    event: "nodeStopping";
+    nodeId: NodeId;
+    reason: "createFailed" | "pendingTimeExceeded" | "startupTimeExceeded" | "initialisationHealthPingTimeExceeded" | "healthPingTimeExceeded" | "duplicateJob" | "providerStop" | "providerTerminate" | "userRequested" | "unknownNode";
+};
+/** @public
+ * A node has stopped
+ * */
+export declare type NodeStopped = {
+    event: "nodeStopped";
+    nodeId: NodeId;
+};
+/**
+ * @public
+ * A node is running - used in initial state messages
+ * */
+export declare type NodeRunning = {
+    event: "nodeRunning";
+    nodeMetadata: NodeMetadata;
+    runningNodeMetadata: RunningNodeMetadata;
+    instances: RunningJob[];
+};
+/**
+ * @public
+ * A physical node has connected
+ * */
+export declare type PhysicalNodeConnected = {
+    event: "physicalNodeConnected";
+    node: PhysicalNode;
+    instances: RunningJob[];
+};
+/**
+ * @public
+ * The health status of a provider has changed
+ * */
+export declare type ProviderHealthChange = {
+    event: "providerHealthChange";
+    health: ProviderHealth;
+};
+/**
+ * @public
+ * The manager activity stream has closed
+ * */
+export declare type EventStreamClosed = {
+    event: "eventStreamClosed";
+    error?: Error;
+};
+/** @public */
+export declare type TagComparison = {
+    comparison: "eq";
+    value: string;
+} | {
+    comparison: "neq";
+    value: string;
+} | {
+    comparison: "re";
+    value: string;
+} | {
+    comparison: "exists";
+    value: boolean;
+};
+/** @public */
+export declare type TagFilter = {
+    filterType: "tag";
+    tagName: string;
+    comparison: TagComparison;
+};
+/** @public */
+export declare type IdComparison = {
+    comparison: "eq";
+    value: string;
+} | {
+    comparison: "neq";
+    value: string;
+} | {
+    comparison: "re";
+    value: string;
+};
+/** @public */
+export declare type IdFilter = {
+    filterType: "id";
+    comparison: IdComparison;
+};
+/** @public */
+export declare type DateComparison = {
+    comparison: "eq";
+    value: Date;
+} | {
+    comparison: "lt";
+    value: Date;
+} | {
+    comparison: "lte";
+    value: Date;
+} | {
+    comparison: "gt";
+    value: Date;
+} | {
+    comparison: "gte";
+    value: Date;
+} | {
+    comparison: "between";
+    from: Date;
+    to: Date;
+};
+/** @public */
+export declare type DateFilter = {
+    filterType: "date";
+    dateType: "start" | "end";
+    comparison: DateComparison;
+};
+/** @public */
+export declare type JobFilter = TagFilter | IdFilter | DateFilter;
+/**
+ * @public
+ * Configuration for creating an event stream
+ */
+export declare type EventStreamSettings = {
+    pendingWindow: number;
+    onEvent: (event: EventStreamEvent) => void;
+};
+/**
+ * @public
+ */
+export declare type EventStreamInitialState = {
+    nodesStarting: NodeStarting[];
+    nodesRunning: NodeRunning[];
+    activeJobs: JobWithHistory[];
+    health: ProviderHealth[];
+    closeStream: () => void;
+};
+/**
+ * @public
+ */
+export declare type EventStreamEvent = JobUpdated | JobPending | JobOutOfWindow | JobDeleted | JobInfo | NodeStarting | NodeStarted | NodeStopping | NodeStopped | PhysicalNodeConnected | ProviderHealthChange | EventStreamClosed;
+/**
+ * @public
+ */
+export declare type JobSearchSettings = {
+    filter: JobFilter[];
+};
+/**
+ * @public
+ */
+export declare type CurrentJob = {
+    job: Job;
+    instances: RunningJob[];
+};
+/**
+ * @public
+ * List of events that can be raised by the jobList API - TODO - link
+ */
+export declare type JobListEvent = JobUpdated | JobPending;
+/**
+ * @public
+ */
+export declare type Health = "healthy" | "unstable" | "failed";
+/**
+ * @public
+ */
+export declare type AwsHealth = {
+    provider: "aws";
+    regions: Map<AwsRegion, Health>;
+};
+/**
+ * @public
+ */
+export declare type OciHealth = {
+    provider: "oci";
+};
+/**
+ * @public
+ */
+export declare type ProviderHealth = AwsHealth | OciHealth;
+/**
+ * @public
+ * The entrypoint for all Norsk Manager applications
+ *
+ * @example
+ * ```ts
+ * const norsk = await Norsk.connect({ url: "localhost:6790" });
+ * ```
+ */
+export declare class NorskManager {
+    nextEventStreamId: number;
+    /** @public */
+    static connect(settings: NorskSettings): Promise<NorskManager>;
+    /**
+     * @public
+     * Norsk Runtime version information
+     */
+    version: CommonVersion;
+    /**
+     * @public
+     * Close down the Norsk connection
+     */
+    close(): void;
+    /**
+     * @public - TODO - this can fail (duplicate id etc)
+     */
+    createJob(job: CreateJob): Promise<Job>;
+    /**
+     * @public - TODO - this can fail (version check etc)
+     */
+    updateJob(job: Job): Promise<Job>;
+    /**
+     * @public - TODO - can it fail?
+     */
+    deleteJob(jobId: JobId): Promise<void>;
+    /**
+     * @public - TODO - can it fail?
+     */
+    completeJob(jobId: JobId): Promise<void>;
+    /**
+     * @public - TODO
+     */
+    createAwsNode(node: AwsNodeCreate): Promise<void>;
+    /**
+   * @public - TODO
+   */
+    createOciNode(node: OciNodeCreate): Promise<void>;
+    /**
+     * @public - TODO
+     */
+    updatePhysicalNode(nodeId: PhysicalNodeId, daemonVersion: string): Promise<void>;
+    /**
+     * @public - TODO
+     */
+    terminateNode(nodeId: NodeId): Promise<void>;
+    /**
+     * @public - TODO
+     */
+    startJob(jobId: JobId, role: Role, nodeId: NodeId): Promise<void>;
+    /**
+     * @public - TODO
+     */
+    stopJob(jobId: JobId, role: Role, nodeId: NodeId): Promise<void>;
+    /**
+     * @public - TODO - check name
+     * provides a stream of activity that is essential for the creation of client-side
+     * management logic.
+     */
+    eventStream(settings: EventStreamSettings): Promise<[EventStreamInitialState, () => void]>;
+    /**
+     * @public
+     * search for jobs by id
+     */
+    jobById(id: JobId): Promise<CurrentJob | undefined>;
+    /**
+     * @public
+     * search for jobs by tag / date etc
+     */
+    jobSearch(settings: JobSearchSettings): Promise<CurrentJob[]>;
+}
+interface EventStreamAsyncIterable {
+    [Symbol.asyncIterator](): AsyncIterator<EventStreamEvent, EventStreamEvent>;
+}
+export declare function eventStream(norsk: NorskManager, options: {
+    pendingWindow: number;
+}): Promise<[EventStreamInitialState, EventStreamAsyncIterable]>;
+export {};
+//# sourceMappingURL=sdk.d.ts.map