@types/dockerode - npm Package Compare versions

Comparing version 2.5.34 to 3.2.0

dockerode/index.d.ts

@@ -1,2 +0,2 @@
-// Type definitions for dockerode 2.5
+// Type definitions for dockerode 3.2
 // Project: https://github.com/apocas/dockerode
@@ -263,4 +263,4 @@ // Definitions by: Carl Winkler <https://github.com/seikho>
 
-        inspect(callback: Callback<SecretInfo>): void;
-        inspect(): Promise<SecretInfo>;
+        inspect(callback: Callback<Secret>): void;
+        inspect(): Promise<Secret>;
 
@@ -332,2 +332,4 @@ update(options: {}, callback: Callback<any>): void;
 
+    type Duration = number;
+
     interface ImageInfo {
@@ -407,2 +409,4 @@ Id: string;
         Ingress: boolean;
+        ConfigFrom?: { Network: string; };
+        ConfigOnly: boolean;
         Containers?: { [id: string]: NetworkContainer };
@@ -1043,14 +1047,374 @@ Options?: { [key: string]: string };
 
-    interface ServiceSpec {
-        Name: string;
+    interface Annotations {
+        Name?: string;
+        Labels?: {[name: string]: string};
     }
 
-    interface SecretInfo {
+    interface ResourceLimits {
+        NanoCPUs?: number;
+        MemoryBytes?: number;
+        Pids?: number;
+    }
+
+    interface NamedGenericResource {
+        Kind?: string;
+        Value?: string;
+    }
+
+    interface DiscreteGenericResource {
+        Kind?: string;
+        Value?: number;
+    }
+
+    type GenericResource = NamedGenericResource | DiscreteGenericResource;
+
+    interface RestartPolicy {
+        Condition?: string;
+        Delay?: number;
+        MaxAttempts?: number;
+        Window?: number;
+    }
+
+    interface Resources {
+        NanoCPUs?: number;
+        MemoryBytes?: number;
+        GenericResources?: GenericResource[];
+    }
+
+    interface ResourceRequirements {
+        Limits?: ResourceLimits;
+        Reservations?: Resources;
+    }
+
+    interface Placement {
+        Constraints?: string[];
+        Preferences?: Array<{Spread: {SpreadDescriptor: string}}>;
+        MaxReplicas?: number;
+        Platforms?: Array<{
+            Architecture: string;
+            OS: string;
+        }>;
+    }
+
+    interface NetworkAttachmentConfig {
+        Target?: string;
+        Aliases?: string[];
+        DriverOpts?: {[key: string]: string};
+    }
+
+    interface Privileges {
+        CredentialSpec?: {
+            Config?: string;
+            File?: string;
+            Registry?: string;
+        };
+        SELinuxContext?: {
+            Disable?: boolean;
+            User?: string;
+            Role?: string;
+            Type?: string;
+            Level?: string;
+        };
+    }
+
+    interface HealthConfig {
+        Test?: string[];
+        Interval?: number;
+        Timeout?: number;
+        StartPeriod?: number;
+        Retries?: number;
+    }
+
+    interface DNSConfig {
+        Nameservers?: string[];
+        Search?: string[];
+        Options?: string[];
+    }
+
+    interface SecretReference {
+        File?: {
+            Name?: string;
+            UID?: string;
+            GID?: string;
+            Mode?: number;
+        };
+        SecretID?: string;
+        SecretName?: string;
+    }
+
+    interface Ulimit {
+        Name?: string;
+        Hard?: number;
+        Soft?: number;
+    }
+
+    interface ContainerSpec {
+        Image?: string;
+        Labels?: {[label: string]: string};
+        Command?: string[];
+        Args?: string[];
+        Hostname?: string;
+        Env?: string[];
+        Dir?: string;
+        User?: string;
+        Groups?: string[];
+        Privileges?: Privileges;
+        Init?: boolean;
+        TTY?: boolean;
+        OpenStdin?: boolean;
+        ReadOnly?: boolean;
+        Mounts?: MountSettings[];
+        StopSignal?: string;
+        StopGracePeriod?: number;
+        HealthCheck?: HealthConfig;
+        Hosts?: string[];
+        DNSConfig?: DNSConfig;
+        Secrets?: SecretReference[];
+        Isolation?: string;
+        Sysctls?: {[key: string]: string};
+        CapabilityAdd?: string[];
+        CapabilityDrop?: string[];
+        Ulimits?: Ulimit[];
+    }
+
+    interface PluginSpec {
+        Name?: string;
+        Remote?: string;
+        Privileges?: {
+            Name?: string;
+            Description?: string;
+            Value?: string[];
+        };
+        Disabled?: boolean;
+        Env?: string[];
+    }
+
+    interface TaskSpecBase {
+        Resources?: ResourceRequirements;
+        RestartPolicy?: RestartPolicy;
+        Placement?: Placement;
+        Networks?: NetworkAttachmentConfig[];
+        LogDriver?: {
+            Name?: string;
+            Options?: {[key: string]: string};
+        };
+        ForceUpdate?: number;
+        Runtime?: string;
+    }
+
+    interface ContainerTaskSpec extends TaskSpecBase {
+        ContainerSpec?: ContainerSpec;
+    }
+
+    interface PluginTaskSpec extends TaskSpecBase {
+        Runtime: 'plugin';
+        PluginSpec: PluginSpec;
+    }
+
+    interface NetworkAttachmentTaskSpec extends TaskSpecBase {
+        Runtime: 'attachment';
+        NetworkAttachmentSpec: {
+            ContainerID: string;
+        };
+    }
+
+    type TaskSpec = ContainerTaskSpec | PluginTaskSpec | NetworkAttachmentTaskSpec;
+
+    interface ServiceMode {
+        Replicated?: {Replicas?: number};
+        Global?: {};
+        ReplicatedJob?: {
+            MaxConcurrent?: number;
+            TotalCompletions?: number;
+        };
+        GlobalJob?: {};
+    }
+
+    interface UpdateConfig {
+        Parallelism: number;
+        Delay?: number;
+        FailureAction?: string;
+        Monitor?: number;
+        MaxFailureRatio?: number;
+        Order: string;
+    }
+
+    interface PortConfig {
+        Name?: string;
+        Protocol?: 'tcp' | 'udp' | 'sctp';
+        TargetPort?: number;
+        PublishedPort?: number;
+        PublishMode?: 'ingress' | 'host';
+    }
+
+    interface EndpointSpec {
+        Mode?: string;
+        Ports?: PortConfig[];
+    }
+
+    interface EndpointVirtualIP {
+        NetworkID?: string;
+        Addr?: string;
+    }
+
+    interface Endpoint {
+        Spec?: EndpointSpec;
+        Ports?: PortConfig[];
+        VirtualIPs?: EndpointVirtualIP[];
+    }
+
+    interface ServiceSpec extends Annotations {
+        TaskTemplate?: TaskSpec;
+        Mode?: ServiceMode;
+        UpdateConfig?: UpdateConfig;
+        RollbackConfig?: UpdateConfig;
+        Networks?: NetworkAttachmentConfig[];
+        EndpointSpec?: EndpointSpec;
+    }
+
+    interface ServiceCreateResponse {
         ID: string;
-        Version: SecretVersion;
-        CreatedAt: string;
+        Warnings?: string[];
+    }
+
+    interface ServiceListOptions {
+        Filters: {
+            id?: string[];
+            label?: string[];
+            mode?: Array<'replicated' | 'global'>;
+            name?: string[];
+        };
+    }
+
+    interface Version {
+        Index?: number;
+    }
+
+    interface Meta {
+        Version?: Version;
+        CreatedAt?: string;
         UpdatedAt?: string;
+    }
+
+    type UpdateState = 'updating' | 'paused' | 'completed' | 'rollback_started' | 'rollback_paused' | 'rollback_completed';
+
+    interface UpdateStatus {
+        State?: UpdateState;
+        StartedAt?: string;
+        CompletedAt?: string;
+        Message?: string;
+    }
+
+    interface ServiceStatus {
+        RunningTasks: number;
+        DesiredTasks: number;
+        CompletedTasks: number;
+    }
+
+    interface JobStatus {
+        JobIteration: Version;
+        LastExecution?: string;
+    }
+
+    interface Service extends Meta {
+        ID: string;
         Spec?: ServiceSpec;
+        PreviousSpec?: ServiceSpec;
+        Endpoint?: Endpoint;
+        UpdateStatus?: UpdateStatus;
+        ServiceStatus?: ServiceStatus;
+        JobStatus?: JobStatus;
     }
 
+    interface OrchestrationConfig {
+        TaskHistoryRetentionLimit?: number;
+    }
+
+    interface RaftConfig {
+        SnapshotInterval?: number;
+        KeepOldSnapshots?: number;
+        LogEntriesForSlowFollowers?: number;
+        ElectionTick?: number;
+        HeartbeatTick?: number;
+    }
+
+    interface DispatcherConfig {
+        HeartbeatPeriod?: Duration;
+    }
+
+    type ExternalCAProtocol = 'cfssl' | string;
+
+    interface ExternalCA {
+        Protocol: ExternalCAProtocol;
+        URL: string;
+        Options?: {[key: string]: string};
+        CACert: string;
+    }
+
+    interface CAConfig {
+        NodeCertExpiry?: Duration;
+        ExternalCAs?: ExternalCA[];
+        SigningCACert?: string;
+        SigningCAKey?: string;
+        ForceRotate?: number;
+    }
+
+    interface TaskDefaults {
+        LogDriver?: Driver;
+    }
+
+    interface EncryptionConfig {
+        AutoLockManagers: boolean;
+    }
+
+    interface Spec extends Annotations {
+        Orchestration?: OrchestrationConfig;
+        Raft: RaftConfig;
+        Dispatcher?: DispatcherConfig;
+        CAConfig?: CAConfig;
+        TaskDefaults?: TaskDefaults;
+        EncryptionConfig?: EncryptionConfig;
+    }
+
+    interface TLSInfo {
+        TrustRoot?: string;
+        CertIssuerSubject?: string;
+        CertIssuerPublicKey?: string;
+    }
+
+    interface ClusterInfo extends Meta {
+        ID: string;
+        Spec: Spec;
+        TLSInfo: TLSInfo;
+        RootRotationInProgress: boolean;
+        DefaultAddrPool: string[];
+        SubnetSize: number;
+        DataPathPort: number;
+    }
+
+    interface JoinTokens {
+        Worker: string;
+        Manager: string;
+    }
+
+    interface Swarm extends ClusterInfo {
+        JoinTokens: JoinTokens;
+    }
+
+    interface Driver {
+        Name: string;
+        Options?: {[key: string]: string};
+    }
+
+    interface SecretSpec extends Annotations {
+        Data?: string;
+        Driver?: Driver;
+        Templating?: Driver;
+    }
+
+    interface Secret extends Meta {
+        ID: string;
+        Spec?: SecretSpec;
+    }
+
     interface ConfigInfo {
@@ -1302,5 +1666,5 @@ ID: string;
 
-    listServices(options: {}, callback: Callback<any[]>): void;
-    listServices(callback: Callback<any[]>): void;
-    listServices(options?: {}): Promise<any[]>;
+    listServices(options: Dockerode.ServiceListOptions, callback: Callback<Dockerode.Service[]>): void;
+    listServices(callback: Callback<Dockerode.Service[]>): void;
+    listServices(options?: Dockerode.ServiceListOptions): Promise<Dockerode.Service[]>;
 
@@ -1315,5 +1679,5 @@ listNodes(options: {}, callback: Callback<any[]>): void;
 
-    listSecrets(options: {}, callback: Callback<Dockerode.SecretInfo[]>): void;
-    listSecrets(callback: Callback<Dockerode.SecretInfo[]>): void;
-    listSecrets(options?: {}): Promise<Dockerode.SecretInfo[]>;
+    listSecrets(options: {}, callback: Callback<Dockerode.Secret[]>): void;
+    listSecrets(callback: Callback<Dockerode.Secret[]>): void;
+    listSecrets(options?: {}): Promise<Dockerode.Secret[]>;
 
@@ -1342,5 +1706,5 @@ listPlugins(options: {}, callback: Callback<Dockerode.PluginInfo[]>): void;
 
-    listNetworks(options: {}, callback: Callback<any[]>): void;
-    listNetworks(callback: Callback<any[]>): void;
-    listNetworks(options?: {}): Promise<any[]>;
+    listNetworks(options: {}, callback: Callback<Dockerode.NetworkInspectInfo[]>): void;
+    listNetworks(callback: Callback<Dockerode.NetworkInspectInfo[]>): void;
+    listNetworks(options?: {}): Promise<Dockerode.NetworkInspectInfo[]>;
 
@@ -1363,4 +1727,4 @@ listConfigs(options: {}, callback: Callback<Dockerode.ConfigInfo[]>): void;
 
-    createService(options: {}, callback: Callback<any>): void;
-    createService(options: {}): Promise<any>;
+    createService(options: Dockerode.ServiceSpec, callback: Callback<Dockerode.ServiceCreateResponse>): void;
+    createService(options: Dockerode.ServiceSpec): Promise<Dockerode.ServiceCreateResponse>;
 
@@ -1367,0 +1731,0 @@ createNetwork(options: Dockerode.NetworkCreateOptions, callback: Callback<Dockerode.Network>): void;

dockerode/package.json

 {
     "name": "@types/dockerode",
-    "version": "2.5.34",
+    "version": "3.2.0",
     "description": "TypeScript definitions for dockerode",
@@ -64,4 +64,4 @@ "license": "MIT",
     },
-    "typesPublisherContentHash": "034f4d9fcad2e8fa22d6f36d8be622b9585e04018e68a63bbb8f3894841e64e2",
-    "typeScriptVersion": "3.0"
+    "typesPublisherContentHash": "bcd404a7d1a651b0f1dbefd946a9a9f026268df3750c8be155bc7176dbce75c8",
+    "typeScriptVersion": "3.2"
 }

dockerode/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Fri, 10 Jul 2020 15:33:09 GMT
+ * Last updated: Wed, 21 Oct 2020 16:40:53 GMT
  * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
@@ -14,0 +14,0 @@ * Global values: none

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

56022

increased by18.56%

Lines of code

1558

increased by24.94%

No dependency changes