@wix/secrets 1.0.34 → 1.0.36

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/secrets",
-  "version": "1.0.34",
+  "version": "1.0.36",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,7 +18,7 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/secrets_secrets": "1.0.23"
+    "@wix/secrets_secrets": "1.0.25"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -43,5 +43,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "7265cf6fdf32e25578c271adf1416fe496af5336a7a1ca5a7d29f15d"
+  "falconPackageHash": "893a772393937d105c609519d705521e13bbaf9537b7f543c0009965"
 }

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

@@ -106,9 +106,9 @@ interface DeleteSecretRequest {
 interface DeleteSecretResponse {
 }
 interface UpdateSecretRequest {
-    /** The unique ID of the secret to be updated. */
+    /** ID of the secret to update. */
     _id: string;
-    /** The secret fields to update. */
+    /** Details of a secret. */
     secret: Secret;
 }
 interface UpdateSecretResponse {
@@ -282,6 +282,10 @@ interface SecretCreatedEnvelope {
 interface SecretDeletedEnvelope {
     metadata: EventMetadata;
 }
+interface SecretUpdatedEnvelope {
+    entity: Secret;
+    metadata: EventMetadata;
+}
 
 declare function getSecretValue$1(httpClient: HttpClient): GetSecretValueSignature;
 interface GetSecretValueSignature {
@@ -355,8 +359,8 @@ interface UpdateSecretSignature {
      * > - Changing a secret's name or value will break all code using the secret.
      * > - You can't rename the secret with a name of an existing secret.
      * > - Don't leave private keys in your code! Leaving them in is a security risk. Make sure to delete the keys from the code after running `updateSecret()`.
-     * @param - The unique ID of the secret to be updated.
-     * @param - The secret fields to update.
+     * @param - ID of the secret to update.
+     * @param - Details of a secret.
      * @returns Fulfilled - When the secret is updated.
      * Rejected - Error message.
      */
@@ -364,6 +368,7 @@ interface UpdateSecretSignature {
 }
 declare const onSecretCreated$1: EventDefinition<SecretCreatedEnvelope, "wix.velo.secrets_vault.v1.secret_created">;
 declare const onSecretDeleted$1: EventDefinition<SecretDeletedEnvelope, "wix.velo.secrets_vault.v1.secret_deleted">;
+declare const onSecretUpdated$1: EventDefinition<SecretUpdatedEnvelope, "wix.velo.secrets_vault.v1.secret_updated">;
 
 declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
 
@@ -374,13 +379,21 @@ declare const deleteSecret: BuildRESTFunction<typeof deleteSecret$1> & typeof de
 declare const updateSecret: BuildRESTFunction<typeof updateSecret$1> & typeof updateSecret$1;
 
 type _publicOnSecretCreatedType = typeof onSecretCreated$1;
-/** */
+/**
+ * Triggered when a secret is created.
+ */
 declare const onSecretCreated: ReturnType<typeof createEventModule<_publicOnSecretCreatedType>>;
 
 type _publicOnSecretDeletedType = typeof onSecretDeleted$1;
-/** */
+/**
+ * Triggered when a secret is deleted.
+ */
 declare const onSecretDeleted: ReturnType<typeof createEventModule<_publicOnSecretDeletedType>>;
 
+type _publicOnSecretUpdatedType = typeof onSecretUpdated$1;
+/** */
+declare const onSecretUpdated: ReturnType<typeof createEventModule<_publicOnSecretUpdatedType>>;
+
 type context_ActionEvent = ActionEvent;
 type context_BaseEventMetadata = BaseEventMetadata;
 type context_CreateSecretRequest = CreateSecretRequest;
@@ -406,21 +419,24 @@ type context_RestoreInfo = RestoreInfo;
 type context_Secret = Secret;
 type context_SecretCreatedEnvelope = SecretCreatedEnvelope;
 type context_SecretDeletedEnvelope = SecretDeletedEnvelope;
+type context_SecretUpdatedEnvelope = SecretUpdatedEnvelope;
 type context_UpdateSecretRequest = UpdateSecretRequest;
 type context_UpdateSecretResponse = UpdateSecretResponse;
 type context_WebhookIdentityType = WebhookIdentityType;
 declare const context_WebhookIdentityType: typeof WebhookIdentityType;
 type context__publicOnSecretCreatedType = _publicOnSecretCreatedType;
 type context__publicOnSecretDeletedType = _publicOnSecretDeletedType;
+type context__publicOnSecretUpdatedType = _publicOnSecretUpdatedType;
 declare const context_createSecret: typeof createSecret;
 declare const context_deleteSecret: typeof deleteSecret;
 declare const context_getSecretValue: typeof getSecretValue;
 declare const context_listSecretInfo: typeof listSecretInfo;
 declare const context_onSecretCreated: typeof onSecretCreated;
 declare const context_onSecretDeleted: typeof onSecretDeleted;
+declare const context_onSecretUpdated: typeof onSecretUpdated;
 declare const context_updateSecret: typeof updateSecret;
 declare namespace context {
-  export { type context_ActionEvent as ActionEvent, type context_BaseEventMetadata as BaseEventMetadata, type context_CreateSecretRequest as CreateSecretRequest, type context_CreateSecretResponse as CreateSecretResponse, type context_CreateSecretResponseNonNullableFields as CreateSecretResponseNonNullableFields, type context_DeleteSecretRequest as DeleteSecretRequest, type context_DeleteSecretResponse as DeleteSecretResponse, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_EventMetadata as EventMetadata, type context_GetSecretValueRequest as GetSecretValueRequest, type context_GetSecretValueResponse as GetSecretValueResponse, type context_GetSecretValueResponseNonNullableFields as GetSecretValueResponseNonNullableFields, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context_ListSecretInfoRequest as ListSecretInfoRequest, type context_ListSecretInfoResponse as ListSecretInfoResponse, type context_MessageEnvelope as MessageEnvelope, type context_RestoreInfo as RestoreInfo, type context_Secret as Secret, type context_SecretCreatedEnvelope as SecretCreatedEnvelope, type context_SecretDeletedEnvelope as SecretDeletedEnvelope, type context_UpdateSecretRequest as UpdateSecretRequest, type context_UpdateSecretResponse as UpdateSecretResponse, context_WebhookIdentityType as WebhookIdentityType, type context__publicOnSecretCreatedType as _publicOnSecretCreatedType, type context__publicOnSecretDeletedType as _publicOnSecretDeletedType, context_createSecret as createSecret, context_deleteSecret as deleteSecret, context_getSecretValue as getSecretValue, context_listSecretInfo as listSecretInfo, context_onSecretCreated as onSecretCreated, context_onSecretDeleted as onSecretDeleted, onSecretCreated$1 as publicOnSecretCreated, onSecretDeleted$1 as publicOnSecretDeleted, context_updateSecret as updateSecret };
+  export { type context_ActionEvent as ActionEvent, type context_BaseEventMetadata as BaseEventMetadata, type context_CreateSecretRequest as CreateSecretRequest, type context_CreateSecretResponse as CreateSecretResponse, type context_CreateSecretResponseNonNullableFields as CreateSecretResponseNonNullableFields, type context_DeleteSecretRequest as DeleteSecretRequest, type context_DeleteSecretResponse as DeleteSecretResponse, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_EventMetadata as EventMetadata, type context_GetSecretValueRequest as GetSecretValueRequest, type context_GetSecretValueResponse as GetSecretValueResponse, type context_GetSecretValueResponseNonNullableFields as GetSecretValueResponseNonNullableFields, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context_ListSecretInfoRequest as ListSecretInfoRequest, type context_ListSecretInfoResponse as ListSecretInfoResponse, type context_MessageEnvelope as MessageEnvelope, type context_RestoreInfo as RestoreInfo, type context_Secret as Secret, type context_SecretCreatedEnvelope as SecretCreatedEnvelope, type context_SecretDeletedEnvelope as SecretDeletedEnvelope, type context_SecretUpdatedEnvelope as SecretUpdatedEnvelope, type context_UpdateSecretRequest as UpdateSecretRequest, type context_UpdateSecretResponse as UpdateSecretResponse, context_WebhookIdentityType as WebhookIdentityType, type context__publicOnSecretCreatedType as _publicOnSecretCreatedType, type context__publicOnSecretDeletedType as _publicOnSecretDeletedType, type context__publicOnSecretUpdatedType as _publicOnSecretUpdatedType, context_createSecret as createSecret, context_deleteSecret as deleteSecret, context_getSecretValue as getSecretValue, context_listSecretInfo as listSecretInfo, context_onSecretCreated as onSecretCreated, context_onSecretDeleted as onSecretDeleted, context_onSecretUpdated as onSecretUpdated, onSecretCreated$1 as publicOnSecretCreated, onSecretDeleted$1 as publicOnSecretDeleted, onSecretUpdated$1 as publicOnSecretUpdated, context_updateSecret as updateSecret };
 }
 
 export { context as secrets };

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

@@ -106,9 +106,9 @@ interface DeleteSecretRequest {
 interface DeleteSecretResponse {
 }
 interface UpdateSecretRequest {
-    /** The unique ID of the secret to be updated. */
+    /** ID of the secret to update. */
     _id: string;
-    /** The secret fields to update. */
+    /** Details of a secret. */
     secret: Secret;
 }
 interface UpdateSecretResponse {
@@ -282,6 +282,10 @@ interface SecretCreatedEnvelope {
 interface SecretDeletedEnvelope {
     metadata: EventMetadata;
 }
+interface SecretUpdatedEnvelope {
+    entity: Secret;
+    metadata: EventMetadata;
+}
 
 declare function getSecretValue$1(httpClient: HttpClient): GetSecretValueSignature;
 interface GetSecretValueSignature {
@@ -355,8 +359,8 @@ interface UpdateSecretSignature {
      * > - Changing a secret's name or value will break all code using the secret.
      * > - You can't rename the secret with a name of an existing secret.
      * > - Don't leave private keys in your code! Leaving them in is a security risk. Make sure to delete the keys from the code after running `updateSecret()`.
-     * @param - The unique ID of the secret to be updated.
-     * @param - The secret fields to update.
+     * @param - ID of the secret to update.
+     * @param - Details of a secret.
      * @returns Fulfilled - When the secret is updated.
      * Rejected - Error message.
      */
@@ -364,6 +368,7 @@ interface UpdateSecretSignature {
 }
 declare const onSecretCreated$1: EventDefinition<SecretCreatedEnvelope, "wix.velo.secrets_vault.v1.secret_created">;
 declare const onSecretDeleted$1: EventDefinition<SecretDeletedEnvelope, "wix.velo.secrets_vault.v1.secret_deleted">;
+declare const onSecretUpdated$1: EventDefinition<SecretUpdatedEnvelope, "wix.velo.secrets_vault.v1.secret_updated">;
 
 declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
 
@@ -374,13 +379,21 @@ declare const deleteSecret: BuildRESTFunction<typeof deleteSecret$1> & typeof de
 declare const updateSecret: BuildRESTFunction<typeof updateSecret$1> & typeof updateSecret$1;
 
 type _publicOnSecretCreatedType = typeof onSecretCreated$1;
-/** */
+/**
+ * Triggered when a secret is created.
+ */
 declare const onSecretCreated: ReturnType<typeof createEventModule<_publicOnSecretCreatedType>>;
 
 type _publicOnSecretDeletedType = typeof onSecretDeleted$1;
-/** */
+/**
+ * Triggered when a secret is deleted.
+ */
 declare const onSecretDeleted: ReturnType<typeof createEventModule<_publicOnSecretDeletedType>>;
 
+type _publicOnSecretUpdatedType = typeof onSecretUpdated$1;
+/** */
+declare const onSecretUpdated: ReturnType<typeof createEventModule<_publicOnSecretUpdatedType>>;
+
 type index_d_ActionEvent = ActionEvent;
 type index_d_BaseEventMetadata = BaseEventMetadata;
 type index_d_CreateSecretRequest = CreateSecretRequest;
@@ -406,21 +419,24 @@ type index_d_RestoreInfo = RestoreInfo;
 type index_d_Secret = Secret;
 type index_d_SecretCreatedEnvelope = SecretCreatedEnvelope;
 type index_d_SecretDeletedEnvelope = SecretDeletedEnvelope;
+type index_d_SecretUpdatedEnvelope = SecretUpdatedEnvelope;
 type index_d_UpdateSecretRequest = UpdateSecretRequest;
 type index_d_UpdateSecretResponse = UpdateSecretResponse;
 type index_d_WebhookIdentityType = WebhookIdentityType;
 declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
 type index_d__publicOnSecretCreatedType = _publicOnSecretCreatedType;
 type index_d__publicOnSecretDeletedType = _publicOnSecretDeletedType;
+type index_d__publicOnSecretUpdatedType = _publicOnSecretUpdatedType;
 declare const index_d_createSecret: typeof createSecret;
 declare const index_d_deleteSecret: typeof deleteSecret;
 declare const index_d_getSecretValue: typeof getSecretValue;
 declare const index_d_listSecretInfo: typeof listSecretInfo;
 declare const index_d_onSecretCreated: typeof onSecretCreated;
 declare const index_d_onSecretDeleted: typeof onSecretDeleted;
+declare const index_d_onSecretUpdated: typeof onSecretUpdated;
 declare const index_d_updateSecret: typeof updateSecret;
 declare namespace index_d {
-  export { type index_d_ActionEvent as ActionEvent, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_CreateSecretRequest as CreateSecretRequest, type index_d_CreateSecretResponse as CreateSecretResponse, type index_d_CreateSecretResponseNonNullableFields as CreateSecretResponseNonNullableFields, type index_d_DeleteSecretRequest as DeleteSecretRequest, type index_d_DeleteSecretResponse as DeleteSecretResponse, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, type index_d_GetSecretValueRequest as GetSecretValueRequest, type index_d_GetSecretValueResponse as GetSecretValueResponse, type index_d_GetSecretValueResponseNonNullableFields as GetSecretValueResponseNonNullableFields, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_ListSecretInfoRequest as ListSecretInfoRequest, type index_d_ListSecretInfoResponse as ListSecretInfoResponse, type index_d_MessageEnvelope as MessageEnvelope, type index_d_RestoreInfo as RestoreInfo, type index_d_Secret as Secret, type index_d_SecretCreatedEnvelope as SecretCreatedEnvelope, type index_d_SecretDeletedEnvelope as SecretDeletedEnvelope, type index_d_UpdateSecretRequest as UpdateSecretRequest, type index_d_UpdateSecretResponse as UpdateSecretResponse, index_d_WebhookIdentityType as WebhookIdentityType, type index_d__publicOnSecretCreatedType as _publicOnSecretCreatedType, type index_d__publicOnSecretDeletedType as _publicOnSecretDeletedType, index_d_createSecret as createSecret, index_d_deleteSecret as deleteSecret, index_d_getSecretValue as getSecretValue, index_d_listSecretInfo as listSecretInfo, index_d_onSecretCreated as onSecretCreated, index_d_onSecretDeleted as onSecretDeleted, onSecretCreated$1 as publicOnSecretCreated, onSecretDeleted$1 as publicOnSecretDeleted, index_d_updateSecret as updateSecret };
+  export { type index_d_ActionEvent as ActionEvent, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_CreateSecretRequest as CreateSecretRequest, type index_d_CreateSecretResponse as CreateSecretResponse, type index_d_CreateSecretResponseNonNullableFields as CreateSecretResponseNonNullableFields, type index_d_DeleteSecretRequest as DeleteSecretRequest, type index_d_DeleteSecretResponse as DeleteSecretResponse, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, type index_d_GetSecretValueRequest as GetSecretValueRequest, type index_d_GetSecretValueResponse as GetSecretValueResponse, type index_d_GetSecretValueResponseNonNullableFields as GetSecretValueResponseNonNullableFields, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_ListSecretInfoRequest as ListSecretInfoRequest, type index_d_ListSecretInfoResponse as ListSecretInfoResponse, type index_d_MessageEnvelope as MessageEnvelope, type index_d_RestoreInfo as RestoreInfo, type index_d_Secret as Secret, type index_d_SecretCreatedEnvelope as SecretCreatedEnvelope, type index_d_SecretDeletedEnvelope as SecretDeletedEnvelope, type index_d_SecretUpdatedEnvelope as SecretUpdatedEnvelope, type index_d_UpdateSecretRequest as UpdateSecretRequest, type index_d_UpdateSecretResponse as UpdateSecretResponse, index_d_WebhookIdentityType as WebhookIdentityType, type index_d__publicOnSecretCreatedType as _publicOnSecretCreatedType, type index_d__publicOnSecretDeletedType as _publicOnSecretDeletedType, type index_d__publicOnSecretUpdatedType as _publicOnSecretUpdatedType, index_d_createSecret as createSecret, index_d_deleteSecret as deleteSecret, index_d_getSecretValue as getSecretValue, index_d_listSecretInfo as listSecretInfo, index_d_onSecretCreated as onSecretCreated, index_d_onSecretDeleted as onSecretDeleted, index_d_onSecretUpdated as onSecretUpdated, onSecretCreated$1 as publicOnSecretCreated, onSecretDeleted$1 as publicOnSecretDeleted, onSecretUpdated$1 as publicOnSecretUpdated, index_d_updateSecret as updateSecret };
 }
 
 export { index_d as secrets };

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

@@ -1,28 +1,32 @@
 interface Secret$1 {
     /**
-     * A globally-unique, immutable identifier assigned to the secret upon creation.
+     * Secret ID.
      * @readonly
      */
     id?: string | null;
-    /** A unique, human-friendly name for the secret. Used for retrieving the secret easily at runtime. */
+    /**
+     * 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.
+     *
+     * **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. */
     description?: string | null;
-    /** The confidential value that is intended to be stored encrypted. */
+    /** The encrypted confidential value. */
     value?: string | null;
     /**
-     * The creation timestamp of the secret.
+     * Date and time when the secret was created.
      * @readonly
      */
     createdDate?: Date;
     /**
-     * The last-update timestamp of the secret.
+     * Date and time when the secret was updated.
      * @readonly
      */
     updatedDate?: Date;
 }
 interface GetSecretValueRequest$1 {
-    /** The name of the secret to get the value of. */
+    /** Secret name. */
     name: string;
 }
 interface GetSecretValueResponse$1 {
@@ -32,27 +36,27 @@ interface GetSecretValueResponse$1 {
 interface ListSecretInfoRequest$1 {
 }
 interface ListSecretInfoResponse$1 {
-    /** A list of info object for each secret, without the secret value itself */
+    /** A list of secrets with encrypted values. */
     secrets?: Secret$1[];
 }
 interface CreateSecretRequest$1 {
-    /** A set of fields including info and the actual value to protect. */
+    /** Details of a secret. */
     secret: Secret$1;
 }
 interface CreateSecretResponse$1 {
-    /** The globally-unique ID assigned to the secret by the service. */
+    /** Secret ID. */
     id?: string;
 }
 interface DeleteSecretRequest$1 {
-    /** The unique ID of the secret to be deleted. */
+    /** ID of the secret to delete. */
     id: string;
 }
 interface DeleteSecretResponse$1 {
 }
 interface UpdateSecretRequest$1 {
-    /** The unique ID of the secret to be updated. */
+    /** ID of the secret to update. */
     id: string;
-    /** The secret fields to update. */
+    /** Details of a secret. */
     secret: Secret$1;
 }
 interface UpdateSecretResponse$1 {
@@ -128,9 +132,9 @@ interface DeleteSecretRequest {
 interface DeleteSecretResponse {
 }
 interface UpdateSecretRequest {
-    /** The unique ID of the secret to be updated. */
+    /** ID of the secret to update. */
     _id: string;
-    /** The secret fields to update. */
+    /** Details of a secret. */
     secret: Secret;
 }
 interface UpdateSecretResponse {