@wix/secrets 1.0.43 → 1.0.44

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/secrets",
-  "version": "1.0.43",
+  "version": "1.0.44",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -21,7 +21,7 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/secrets_secrets": "1.0.31"
+    "@wix/secrets_secrets": "1.0.32"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -46,5 +46,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "bf2d19c272a275b1f50acdac9db19522b5c2761b8a820f30ae969993"
+  "falconPackageHash": "ce8a0745a45eb834a2f0e808ab7d328822eb59657cfeef8ec6312850"
 }

package/type-bundles/context.bundle.d.ts

@@ -478,17 +478,17 @@ type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
 
 interface Secret {
     /**
-     * Secret ID.
+     * Unique secret ID.
      * @readonly
      */
     _id?: string | null;
     /**
-     * A unique, human-friendly name for the secret. Use it to retrieve the secret value easily with the [Get Secret Value](https://dev.wix.com/docs/rest/business-management/secrets/get-secret-value) endpoint.
+     * A unique, human-friendly name for the secret. Use it to retrieve the secret value with Get Secret Value.
      *
      * **Note:** You can use alphanumeric characters and the following special characters: `_+=-@#$`. Spaces are not supported.
      */
     name?: string | null;
-    /** An optional text describing the secret's purpose or any other notes about it. */
+    /** Optional text describing the secret's purpose or any other notes about it. */
     description?: string | null;
     /** The encrypted confidential value. */
     value?: string | null;
@@ -508,7 +508,7 @@ interface GetSecretValueRequest {
     name: string;
 }
 interface GetSecretValueResponse {
-    /** The plaintext, unencrypted value of the secret. */
+    /** The confidential value to protect, such as an API key. */
     value?: string;
 }
 interface ListSecretInfoRequest {
@@ -522,7 +522,7 @@ interface CreateSecretRequest {
     secret: Secret;
 }
 interface CreateSecretResponse {
-    /** Secret ID. */
+    /** Unique secret ID. */
     _id?: string;
 }
 interface DeleteSecretRequest {
@@ -717,6 +717,11 @@ declare function getSecretValue$1(httpClient: HttpClient): GetSecretValueSignatu
 interface GetSecretValueSignature {
     /**
      * Retrieves a secret value by name.
+     *
+     * <blockquote class="caution">
+     * __Caution:__
+     * Only use a secret's value in the backend code. Returning the secret value in the frontend is a security risk.
+     * </blockquote>
      * @param - The name of the secret to get the value of.
      */
     (name: string): Promise<GetSecretValueResponse & GetSecretValueResponseNonNullableFields>;
@@ -726,7 +731,7 @@ interface ListSecretInfoSignature {
     /**
      * Retrieves a list of secrets.
      *
-     * >**Note:** This endpoint doesn't return the secret's value for security reasons. To retrieve the value, call [Get Secret Value](https://dev.wix.com/docs/rest/business-management/secrets/get-secret-value).
+     * > **Note:** This method doesn't return the secret's value for security reasons. To retrieve the value, call [Get Secret Value](https://dev.wix.com/docs/rest/business-management/secrets/get-secret-value).
      */
     (): Promise<ListSecretInfoResponse>;
 }
@@ -735,7 +740,7 @@ interface CreateSecretSignature {
     /**
      * Creates a secret.
      * @param - Fields of a new secret.
-     * @returns Secret ID.
+     * @returns Unique secret ID.
      */
     (secret: Secret): Promise<string>;
 }
@@ -743,6 +748,11 @@ declare function deleteSecret$1(httpClient: HttpClient): DeleteSecretSignature;
 interface DeleteSecretSignature {
     /**
      * Deletes a secret.
+     *
+     * <blockquote class="warning">
+     * __Warning:__
+     * Deleting a secret is irreversible and will break all code using the secret.
+     * </blockquote>
      * @param - The unique ID of the secret to be deleted.
      */
     (_id: string): Promise<void>;

package/type-bundles/index.bundle.d.ts

@@ -478,17 +478,17 @@ type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
 
 interface Secret {
     /**
-     * Secret ID.
+     * Unique secret ID.
      * @readonly
      */
     _id?: string | null;
     /**
-     * A unique, human-friendly name for the secret. Use it to retrieve the secret value easily with the [Get Secret Value](https://dev.wix.com/docs/rest/business-management/secrets/get-secret-value) endpoint.
+     * A unique, human-friendly name for the secret. Use it to retrieve the secret value with Get Secret Value.
      *
      * **Note:** You can use alphanumeric characters and the following special characters: `_+=-@#$`. Spaces are not supported.
      */
     name?: string | null;
-    /** An optional text describing the secret's purpose or any other notes about it. */
+    /** Optional text describing the secret's purpose or any other notes about it. */
     description?: string | null;
     /** The encrypted confidential value. */
     value?: string | null;
@@ -508,7 +508,7 @@ interface GetSecretValueRequest {
     name: string;
 }
 interface GetSecretValueResponse {
-    /** The plaintext, unencrypted value of the secret. */
+    /** The confidential value to protect, such as an API key. */
     value?: string;
 }
 interface ListSecretInfoRequest {
@@ -522,7 +522,7 @@ interface CreateSecretRequest {
     secret: Secret;
 }
 interface CreateSecretResponse {
-    /** Secret ID. */
+    /** Unique secret ID. */
     _id?: string;
 }
 interface DeleteSecretRequest {
@@ -717,6 +717,11 @@ declare function getSecretValue$1(httpClient: HttpClient): GetSecretValueSignatu
 interface GetSecretValueSignature {
     /**
      * Retrieves a secret value by name.
+     *
+     * <blockquote class="caution">
+     * __Caution:__
+     * Only use a secret's value in the backend code. Returning the secret value in the frontend is a security risk.
+     * </blockquote>
      * @param - The name of the secret to get the value of.
      */
     (name: string): Promise<GetSecretValueResponse & GetSecretValueResponseNonNullableFields>;
@@ -726,7 +731,7 @@ interface ListSecretInfoSignature {
     /**
      * Retrieves a list of secrets.
      *
-     * >**Note:** This endpoint doesn't return the secret's value for security reasons. To retrieve the value, call [Get Secret Value](https://dev.wix.com/docs/rest/business-management/secrets/get-secret-value).
+     * > **Note:** This method doesn't return the secret's value for security reasons. To retrieve the value, call [Get Secret Value](https://dev.wix.com/docs/rest/business-management/secrets/get-secret-value).
      */
     (): Promise<ListSecretInfoResponse>;
 }
@@ -735,7 +740,7 @@ interface CreateSecretSignature {
     /**
      * Creates a secret.
      * @param - Fields of a new secret.
-     * @returns Secret ID.
+     * @returns Unique secret ID.
      */
     (secret: Secret): Promise<string>;
 }
@@ -743,6 +748,11 @@ declare function deleteSecret$1(httpClient: HttpClient): DeleteSecretSignature;
 interface DeleteSecretSignature {
     /**
      * Deletes a secret.
+     *
+     * <blockquote class="warning">
+     * __Warning:__
+     * Deleting a secret is irreversible and will break all code using the secret.
+     * </blockquote>
      * @param - The unique ID of the secret to be deleted.
      */
     (_id: string): Promise<void>;

package/type-bundles/meta.bundle.d.ts

@@ -1,16 +1,16 @@
 interface Secret$1 {
     /**
-     * Secret ID.
+     * Unique secret ID.
      * @readonly
      */
     id?: string | null;
     /**
-     * A unique, human-friendly name for the secret. Use it to retrieve the secret value easily with the [Get Secret Value](https://dev.wix.com/docs/rest/business-management/secrets/get-secret-value) endpoint.
+     * A unique, human-friendly name for the secret. Use it to retrieve the secret value with Get Secret Value.
      *
      * **Note:** You can use alphanumeric characters and the following special characters: `_+=-@#$`. Spaces are not supported.
      */
     name?: string | null;
-    /** An optional text describing the secret's purpose or any other notes about it. */
+    /** Optional text describing the secret's purpose or any other notes about it. */
     description?: string | null;
     /** The encrypted confidential value. */
     value?: string | null;
@@ -30,7 +30,7 @@ interface GetSecretValueRequest$1 {
     name: string;
 }
 interface GetSecretValueResponse$1 {
-    /** The plaintext, unencrypted value of the secret. */
+    /** The confidential value to protect, such as an API key. */
     value?: string;
 }
 interface ListSecretInfoRequest$1 {
@@ -44,7 +44,7 @@ interface CreateSecretRequest$1 {
     secret: Secret$1;
 }
 interface CreateSecretResponse$1 {
-    /** Secret ID. */
+    /** Unique secret ID. */
     id?: string;
 }
 interface DeleteSecretRequest$1 {
@@ -70,17 +70,17 @@ interface CreateSecretResponseNonNullableFields$1 {
 
 interface Secret {
     /**
-     * Secret ID.
+     * Unique secret ID.
      * @readonly
      */
     _id?: string | null;
     /**
-     * A unique, human-friendly name for the secret. Use it to retrieve the secret value easily with the [Get Secret Value](https://dev.wix.com/docs/rest/business-management/secrets/get-secret-value) endpoint.
+     * A unique, human-friendly name for the secret. Use it to retrieve the secret value with Get Secret Value.
      *
      * **Note:** You can use alphanumeric characters and the following special characters: `_+=-@#$`. Spaces are not supported.
      */
     name?: string | null;
-    /** An optional text describing the secret's purpose or any other notes about it. */
+    /** Optional text describing the secret's purpose or any other notes about it. */
     description?: string | null;
     /** The encrypted confidential value. */
     value?: string | null;
@@ -100,7 +100,7 @@ interface GetSecretValueRequest {
     name: string;
 }
 interface GetSecretValueResponse {
-    /** The plaintext, unencrypted value of the secret. */
+    /** The confidential value to protect, such as an API key. */
     value?: string;
 }
 interface ListSecretInfoRequest {
@@ -114,7 +114,7 @@ interface CreateSecretRequest {
     secret: Secret;
 }
 interface CreateSecretResponse {
-    /** Secret ID. */
+    /** Unique secret ID. */
     _id?: string;
 }
 interface DeleteSecretRequest {