BREAKING CHANGE(DockerHost): Refactor public API to DockerHost facade; introduce DockerResource base; make resource static methods internal; support flexible descriptors and stream compatibility

ts/classes.secret.ts

@@ -1,12 +1,18 @@
 import * as plugins from './plugins.js';
 import { DockerHost } from './classes.host.js';
+import { DockerResource } from './classes.base.js';
 
 // interfaces
 import * as interfaces from './interfaces/index.js';
 
-export class DockerSecret {
-  // STATIC
-  public static async getSecrets(dockerHostArg: DockerHost) {
+export class DockerSecret extends DockerResource {
+  // STATIC (Internal - prefixed with _ to indicate internal use)
+
+  /**
+   * Internal: Get all secrets
+   * Public API: Use dockerHost.getSecrets() instead
+   */
+  public static async _list(dockerHostArg: DockerHost) {
     const response = await dockerHostArg.request('GET', '/secrets');
     const secrets: DockerSecret[] = [];
     for (const secret of response.body) {
@@ -17,20 +23,32 @@ export class DockerSecret {
     return secrets;
   }
 
-  public static async getSecretByID(dockerHostArg: DockerHost, idArg: string) {
-    const secrets = await this.getSecrets(dockerHostArg);
+  /**
+   * Internal: Get secret by ID
+   * Public API: Use dockerHost.getSecretById(id) instead
+   */
+  public static async _fromId(dockerHostArg: DockerHost, idArg: string) {
+    const secrets = await this._list(dockerHostArg);
     return secrets.find((secret) => secret.ID === idArg);
   }
 
-  public static async getSecretByName(
+  /**
+   * Internal: Get secret by name
+   * Public API: Use dockerHost.getSecretByName(name) instead
+   */
+  public static async _fromName(
     dockerHostArg: DockerHost,
     nameArg: string,
   ) {
-    const secrets = await this.getSecrets(dockerHostArg);
+    const secrets = await this._list(dockerHostArg);
     return secrets.find((secret) => secret.Spec.Name === nameArg);
   }
 
-  public static async createSecret(
+  /**
+   * Internal: Create a secret
+   * Public API: Use dockerHost.createSecret(descriptor) instead
+   */
+  public static async _create(
     dockerHostArg: DockerHost,
     secretDescriptor: interfaces.ISecretCreationDescriptor,
   ) {
@@ -48,12 +66,12 @@ export class DockerSecret {
     Object.assign(newSecretInstance, response.body);
     Object.assign(
       newSecretInstance,
-      await DockerSecret.getSecretByID(dockerHostArg, newSecretInstance.ID),
+      await DockerSecret._fromId(dockerHostArg, newSecretInstance.ID),
     );
     return newSecretInstance;
   }
 
-  // INSTANCE
+  // INSTANCE PROPERTIES
   public ID: string;
   public Spec: {
     Name: string;
@@ -63,13 +81,24 @@ export class DockerSecret {
     Index: string;
   };
 
-  public dockerHost: DockerHost;
   constructor(dockerHostArg: DockerHost) {
-    this.dockerHost = dockerHostArg;
+    super(dockerHostArg);
+  }
+
+  // INSTANCE METHODS
+
+  /**
+   * Refreshes this secret's state from the Docker daemon
+   */
+  public async refresh(): Promise<void> {
+    const updated = await DockerSecret._fromId(this.dockerHost, this.ID);
+    if (updated) {
+      Object.assign(this, updated);
+    }
   }
 
   /**
-   * updates a secret
+   * Updates a secret
    */
   public async update(contentArg: string) {
     const route = `/secrets/${this.ID}/update?=version=${this.Version.Index}`;
@@ -84,11 +113,16 @@ export class DockerSecret {
     );
   }
 
+  /**
+   * Removes this secret from the Docker daemon
+   */
   public async remove() {
     await this.dockerHost.request('DELETE', `/secrets/${this.ID}`);
   }
 
-  // get things
+  /**
+   * Gets the version label of this secret
+   */
   public async getVersion() {
     return this.Spec.Labels.version;
   }