@wix/secrets 1.0.31 → 1.0.32

package/build/cjs/index.d.ts

@@ -1 +1,2 @@
-export * as secrets from '@wix/secrets_secrets';
+import * as secrets from '@wix/secrets_secrets';
+export { secrets };

package/build/cjs/index.js

@@ -24,5 +24,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.secrets = void 0;
-exports.secrets = __importStar(require("@wix/secrets_secrets"));
+const secrets = __importStar(require("@wix/secrets_secrets"));
+exports.secrets = secrets;
 //# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gEAAgD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,8DAAgD;AAEvC,0BAAO"}

package/build/es/index.d.ts

@@ -1 +1,2 @@
-export * as secrets from '@wix/secrets_secrets';
+import * as secrets from '@wix/secrets_secrets';
+export { secrets };

package/build/es/index.js

@@ -1,2 +1,3 @@
-export * as secrets from '@wix/secrets_secrets';
+import * as secrets from '@wix/secrets_secrets';
+export { secrets };
 //# sourceMappingURL=index.js.map

package/build/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,sBAAsB,CAAC;AAEhD,OAAO,EAAE,OAAO,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/secrets",
-  "version": "1.0.31",
+  "version": "1.0.32",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,7 +18,7 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/secrets_secrets": "1.0.20"
+    "@wix/secrets_secrets": "1.0.21"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -27,8 +27,9 @@
     "typescript": "^5.3.2"
   },
   "scripts": {
-    "build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles",
-    "build:dts-bundles": "test -f config/rollup-config.js && rollup --config config/rollup-config.js || echo 'Warning: config/rollup-config.js not found!'",
+    "build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles && npm run build:validate-dts",
+    "build:dts-bundles": "test -f config/rollup-config.js && NODE_OPTIONS=--max-old-space-size=8192 rollup --config config/rollup-config.js || echo 'Warning: config/rollup-config.js not found!'",
+    "build:validate-dts": "tsc type-bundles/*.d.ts --noEmit",
     "test": ":"
   },
   "wix": {
@@ -42,5 +43,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "615c42017ade1a03bea476ef5c2d3ebf8d8e3fe74a7012850d805162"
+  "falconPackageHash": "5c624b6e2479b12081513a8d1f88006bf58489807c15deb35946876f"
 }

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

@@ -1,3 +1,47 @@
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
 interface Secret {
     /**
      * The secret's unique ID.
@@ -24,6 +68,10 @@ interface Secret {
      */
     _updatedDate?: Date;
 }
+interface GetSecretValueRequest {
+    /** The name of the secret to get the value of. */
+    name: string;
+}
 interface GetSecretValueResponse {
     /**
      * The plaintext, unencrypted value of the secret.
@@ -31,10 +79,117 @@ interface GetSecretValueResponse {
      */
     value?: string;
 }
+interface ListSecretInfoRequest {
+}
 interface ListSecretInfoResponse {
     /** Object containing information for each secret.  */
     secrets?: Secret[];
 }
+interface CreateSecretRequest {
+    /** The object including the fields of a new secret.  */
+    secret: Secret;
+}
+interface CreateSecretResponse {
+    /**
+     * The globally-unique ID assigned to the secret.
+     *
+     */
+    _id?: string;
+}
+interface DeleteSecretRequest {
+    /**
+     * The unique ID of the secret to be deleted.
+     *
+     */
+    _id: string;
+}
+interface DeleteSecretResponse {
+}
+interface UpdateSecretRequest {
+    /** The unique ID of the secret to be updated. */
+    _id: string;
+    /** The secret fields to update. */
+    secret: Secret;
+}
+interface UpdateSecretResponse {
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
 interface IdentificationData extends IdentificationDataIdOneOf {
     /** ID of a site visitor that has not logged in to the site. */
     anonymousVisitorId?: string;
@@ -68,8 +223,8 @@ declare enum WebhookIdentityType {
 interface GetSecretValueResponseNonNullableFields {
     value: string;
 }
-interface ListSecretInfoResponseNonNullableFields {
-    secrets: Secret[];
+interface CreateSecretResponseNonNullableFields {
+    _id: string;
 }
 interface BaseEventMetadata {
     /** App instance ID. */
@@ -129,67 +284,141 @@ interface SecretUpdatedEnvelope {
     metadata: EventMetadata;
 }
 
-type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
-interface HttpClient {
-    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
-    fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
+declare function getSecretValue$1(httpClient: HttpClient): GetSecretValueSignature;
+interface GetSecretValueSignature {
+    /**
+     * Retrieves the secret value specified by the secret name.
+     *
+     * The `getSecretValue()` function returns a Promise that resolves to the value of the secret with the specified given name.
+     *
+     * >**Note:**
+     * > Only use a secret's value in the backend code. Returning the secret value in the frontend is a security risk.
+     * @param - The name of the secret to get the value of.
+     * @returns Fulfilled - The value of the secret. Rejected - Error message.
+     */
+    (name: string): Promise<GetSecretValueResponse & GetSecretValueResponseNonNullableFields>;
 }
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
-type EventDefinition<Payload = unknown, Type extends string = string> = {
-    __type: 'event-definition';
-    type: Type;
-    isDomainEvent?: boolean;
-    transformations?: (envelope: unknown) => Payload;
-    __payload: Payload;
-};
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
-type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
-type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
+declare function listSecretInfo$1(httpClient: HttpClient): ListSecretInfoSignature;
+interface ListSecretInfoSignature {
+    /**
+     * Retrieves a list of objects containing information about all secrets.
+     *
+     * The `listSecretInfo()` function returns a Promise that resolves to a list containing information about all secrets stored on your site.
+     *
+     * > **Note:**
+     * > - The secret's value does not get returned for security reasons. To retrieve a secret's value, use the [`getSecretValue()`](#getSecretValue) function.
+     * @returns Fulfilled - A list of objects containing information about your site's secrets. Rejected - Error message.
+     */
+    (): Promise<ListSecretInfoResponse>;
+}
+declare function createSecret$1(httpClient: HttpClient): CreateSecretSignature;
+interface CreateSecretSignature {
+    /**
+     * Creates a new secret.
+     *
+     * The `createSecret()` function returns a Promise that resolves secret ID when the secret is created.
+     *
+     * >**Notes:**
+     * > - The secret's name cannot start with `'wix'` or be identical to an existing secret's name.
+     * > - Don't leave private keys in your code. Leaving them in your code is a security risk. Make sure to delete the keys from the code after running `createSecret()`.
+     * @param - Fields of a new secret.
+     * @returns Fulfilled - The ID of the created secret.
+     * Rejected - Error message.
+     */
+    (secret: Secret): Promise<string>;
+}
+declare function deleteSecret$1(httpClient: HttpClient): DeleteSecretSignature;
+interface DeleteSecretSignature {
+    /**
+     * Deletes an existing secret by ID.
+     *
+     * The `deleteSecret()` function returns a Promise that resolves when the secret is deleted. You can retrieve the secret `_id` using the [`listSecretInfo()`](#listsecretinfo) function.
+     *
+     * >**Note:**
+     * > Deleting a secret is irreversible and will break all code using the secret.
+     *
+     * @param - The unique ID of the secret to be deleted.
+     * @returns Fulfilled - When the secret is successfully deleted. Rejected - Error message.
+     */
+    (_id: string): Promise<void>;
+}
+declare function updateSecret$1(httpClient: HttpClient): UpdateSecretSignature;
+interface UpdateSecretSignature {
+    /**
+     * Updates the specified fields of an existing secret by ID.
+     *
+     *
+     * The `updateSecret()` function returns a Promise that resolves when the secret is successfully updated. You can update one or more fields. Only fields passed in the `secret` object will be updated. All other properties will remain unchanged.
+     *
+     * You can retrieve the `_id` parameter from the [`listSecretInfo()`](#listsecretinfo) function. The secret `_id` is different from the secret `name` used by the [`getSecretValue()`](#getsecretvalue) function.
+     *
+     * > **Notes:**
+     * > - 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.
+     * @returns Fulfilled - When the secret is updated.
+     * Rejected - Error message.
+     */
+    (_id: string, secret: Secret): Promise<void>;
 }
-
-declare function getSecretValue$1(httpClient: HttpClient): (name: string) => Promise<GetSecretValueResponse & GetSecretValueResponseNonNullableFields>;
-declare function listSecretInfo$1(httpClient: HttpClient): () => Promise<ListSecretInfoResponse & ListSecretInfoResponseNonNullableFields>;
-declare function createSecret$1(httpClient: HttpClient): (secret: Secret) => Promise<string>;
-declare function deleteSecret$1(httpClient: HttpClient): (_id: string) => Promise<void>;
-declare function updateSecret$1(httpClient: HttpClient): (_id: string, secret: Secret) => Promise<void>;
 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 const getSecretValue: BuildRESTFunction<typeof getSecretValue$1>;
-declare const listSecretInfo: BuildRESTFunction<typeof listSecretInfo$1>;
-declare const createSecret: BuildRESTFunction<typeof createSecret$1>;
-declare const deleteSecret: BuildRESTFunction<typeof deleteSecret$1>;
-declare const updateSecret: BuildRESTFunction<typeof updateSecret$1>;
-declare const onSecretCreated: BuildEventDefinition<typeof onSecretCreated$1>;
-declare const onSecretDeleted: BuildEventDefinition<typeof onSecretDeleted$1>;
-declare const onSecretUpdated: BuildEventDefinition<typeof onSecretUpdated$1>;
+declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
+
+declare const getSecretValue: BuildRESTFunction<typeof getSecretValue$1> & typeof getSecretValue$1;
+declare const listSecretInfo: BuildRESTFunction<typeof listSecretInfo$1> & typeof listSecretInfo$1;
+declare const createSecret: BuildRESTFunction<typeof createSecret$1> & typeof createSecret$1;
+declare const deleteSecret: BuildRESTFunction<typeof deleteSecret$1> & typeof deleteSecret$1;
+declare const updateSecret: BuildRESTFunction<typeof updateSecret$1> & typeof updateSecret$1;
+
+type _publicOnSecretCreatedType = typeof onSecretCreated$1;
+/** */
+declare const onSecretCreated: ReturnType<typeof createEventModule<_publicOnSecretCreatedType>>;
+
+type _publicOnSecretDeletedType = typeof onSecretDeleted$1;
+/** */
+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;
+type context_CreateSecretResponse = CreateSecretResponse;
+type context_CreateSecretResponseNonNullableFields = CreateSecretResponseNonNullableFields;
+type context_DeleteSecretRequest = DeleteSecretRequest;
+type context_DeleteSecretResponse = DeleteSecretResponse;
+type context_DomainEvent = DomainEvent;
+type context_DomainEventBodyOneOf = DomainEventBodyOneOf;
+type context_EntityCreatedEvent = EntityCreatedEvent;
+type context_EntityDeletedEvent = EntityDeletedEvent;
+type context_EntityUpdatedEvent = EntityUpdatedEvent;
+type context_EventMetadata = EventMetadata;
+type context_GetSecretValueRequest = GetSecretValueRequest;
+type context_GetSecretValueResponse = GetSecretValueResponse;
+type context_GetSecretValueResponseNonNullableFields = GetSecretValueResponseNonNullableFields;
+type context_IdentificationData = IdentificationData;
+type context_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
+type context_ListSecretInfoRequest = ListSecretInfoRequest;
+type context_ListSecretInfoResponse = ListSecretInfoResponse;
+type context_MessageEnvelope = MessageEnvelope;
+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;
@@ -199,7 +428,7 @@ declare const context_onSecretDeleted: typeof onSecretDeleted;
 declare const context_onSecretUpdated: typeof onSecretUpdated;
 declare const context_updateSecret: typeof updateSecret;
 declare namespace context {
-  export { 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, 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_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

@@ -1,3 +1,47 @@
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
 interface Secret {
     /**
      * The secret's unique ID.
@@ -179,9 +223,6 @@ declare enum WebhookIdentityType {
 interface GetSecretValueResponseNonNullableFields {
     value: string;
 }
-interface ListSecretInfoResponseNonNullableFields {
-    secrets: Secret[];
-}
 interface CreateSecretResponseNonNullableFields {
     _id: string;
 }
@@ -243,56 +284,108 @@ interface SecretUpdatedEnvelope {
     metadata: EventMetadata;
 }
 
-interface HttpClient {
-    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
-    fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
+declare function getSecretValue$1(httpClient: HttpClient): GetSecretValueSignature;
+interface GetSecretValueSignature {
+    /**
+     * Retrieves the secret value specified by the secret name.
+     *
+     * The `getSecretValue()` function returns a Promise that resolves to the value of the secret with the specified given name.
+     *
+     * >**Note:**
+     * > Only use a secret's value in the backend code. Returning the secret value in the frontend is a security risk.
+     * @param - The name of the secret to get the value of.
+     * @returns Fulfilled - The value of the secret. Rejected - Error message.
+     */
+    (name: string): Promise<GetSecretValueResponse & GetSecretValueResponseNonNullableFields>;
 }
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-type EventDefinition<Payload = unknown, Type extends string = string> = {
-    __type: 'event-definition';
-    type: Type;
-    isDomainEvent?: boolean;
-    transformations?: (envelope: unknown) => Payload;
-    __payload: Payload;
-};
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
+declare function listSecretInfo$1(httpClient: HttpClient): ListSecretInfoSignature;
+interface ListSecretInfoSignature {
+    /**
+     * Retrieves a list of objects containing information about all secrets.
+     *
+     * The `listSecretInfo()` function returns a Promise that resolves to a list containing information about all secrets stored on your site.
+     *
+     * > **Note:**
+     * > - The secret's value does not get returned for security reasons. To retrieve a secret's value, use the [`getSecretValue()`](#getSecretValue) function.
+     * @returns Fulfilled - A list of objects containing information about your site's secrets. Rejected - Error message.
+     */
+    (): Promise<ListSecretInfoResponse>;
+}
+declare function createSecret$1(httpClient: HttpClient): CreateSecretSignature;
+interface CreateSecretSignature {
+    /**
+     * Creates a new secret.
+     *
+     * The `createSecret()` function returns a Promise that resolves secret ID when the secret is created.
+     *
+     * >**Notes:**
+     * > - The secret's name cannot start with `'wix'` or be identical to an existing secret's name.
+     * > - Don't leave private keys in your code. Leaving them in your code is a security risk. Make sure to delete the keys from the code after running `createSecret()`.
+     * @param - Fields of a new secret.
+     * @returns Fulfilled - The ID of the created secret.
+     * Rejected - Error message.
+     */
+    (secret: Secret): Promise<string>;
+}
+declare function deleteSecret$1(httpClient: HttpClient): DeleteSecretSignature;
+interface DeleteSecretSignature {
+    /**
+     * Deletes an existing secret by ID.
+     *
+     * The `deleteSecret()` function returns a Promise that resolves when the secret is deleted. You can retrieve the secret `_id` using the [`listSecretInfo()`](#listsecretinfo) function.
+     *
+     * >**Note:**
+     * > Deleting a secret is irreversible and will break all code using the secret.
+     *
+     * @param - The unique ID of the secret to be deleted.
+     * @returns Fulfilled - When the secret is successfully deleted. Rejected - Error message.
+     */
+    (_id: string): Promise<void>;
 }
+declare function updateSecret$1(httpClient: HttpClient): UpdateSecretSignature;
+interface UpdateSecretSignature {
+    /**
+     * Updates the specified fields of an existing secret by ID.
+     *
+     *
+     * The `updateSecret()` function returns a Promise that resolves when the secret is successfully updated. You can update one or more fields. Only fields passed in the `secret` object will be updated. All other properties will remain unchanged.
+     *
+     * You can retrieve the `_id` parameter from the [`listSecretInfo()`](#listsecretinfo) function. The secret `_id` is different from the secret `name` used by the [`getSecretValue()`](#getsecretvalue) function.
+     *
+     * > **Notes:**
+     * > - 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.
+     * @returns Fulfilled - When the secret is updated.
+     * Rejected - Error message.
+     */
+    (_id: string, secret: Secret): Promise<void>;
+}
+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 const __metadata: {
-    PACKAGE_NAME: string;
-};
-declare function getSecretValue(httpClient: HttpClient): (name: string) => Promise<GetSecretValueResponse & GetSecretValueResponseNonNullableFields>;
-declare function listSecretInfo(httpClient: HttpClient): () => Promise<ListSecretInfoResponse & ListSecretInfoResponseNonNullableFields>;
-declare function createSecret(httpClient: HttpClient): (secret: Secret) => Promise<string>;
-declare function deleteSecret(httpClient: HttpClient): (_id: string) => Promise<void>;
-declare function updateSecret(httpClient: HttpClient): (_id: string, secret: Secret) => Promise<void>;
-declare const onSecretCreated: EventDefinition<SecretCreatedEnvelope, "wix.velo.secrets_vault.v1.secret_created">;
-declare const onSecretDeleted: EventDefinition<SecretDeletedEnvelope, "wix.velo.secrets_vault.v1.secret_deleted">;
-declare const onSecretUpdated: EventDefinition<SecretUpdatedEnvelope, "wix.velo.secrets_vault.v1.secret_updated">;
+declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
+
+declare const getSecretValue: BuildRESTFunction<typeof getSecretValue$1> & typeof getSecretValue$1;
+declare const listSecretInfo: BuildRESTFunction<typeof listSecretInfo$1> & typeof listSecretInfo$1;
+declare const createSecret: BuildRESTFunction<typeof createSecret$1> & typeof createSecret$1;
+declare const deleteSecret: BuildRESTFunction<typeof deleteSecret$1> & typeof deleteSecret$1;
+declare const updateSecret: BuildRESTFunction<typeof updateSecret$1> & typeof updateSecret$1;
+
+type _publicOnSecretCreatedType = typeof onSecretCreated$1;
+/** */
+declare const onSecretCreated: ReturnType<typeof createEventModule<_publicOnSecretCreatedType>>;
+
+type _publicOnSecretDeletedType = typeof onSecretDeleted$1;
+/** */
+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;
@@ -314,7 +407,6 @@ type index_d_IdentificationData = IdentificationData;
 type index_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
 type index_d_ListSecretInfoRequest = ListSecretInfoRequest;
 type index_d_ListSecretInfoResponse = ListSecretInfoResponse;
-type index_d_ListSecretInfoResponseNonNullableFields = ListSecretInfoResponseNonNullableFields;
 type index_d_MessageEnvelope = MessageEnvelope;
 type index_d_Secret = Secret;
 type index_d_SecretCreatedEnvelope = SecretCreatedEnvelope;
@@ -324,7 +416,9 @@ type index_d_UpdateSecretRequest = UpdateSecretRequest;
 type index_d_UpdateSecretResponse = UpdateSecretResponse;
 type index_d_WebhookIdentityType = WebhookIdentityType;
 declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
-declare const index_d___metadata: typeof __metadata;
+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;
@@ -334,7 +428,7 @@ 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_ListSecretInfoResponseNonNullableFields as ListSecretInfoResponseNonNullableFields, type index_d_MessageEnvelope as MessageEnvelope, 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, index_d___metadata as __metadata, 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, 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_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

@@ -60,9 +60,6 @@ interface UpdateSecretResponse$1 {
 interface GetSecretValueResponseNonNullableFields$1 {
     value: string;
 }
-interface ListSecretInfoResponseNonNullableFields$1 {
-    secrets: Secret$1[];
-}
 interface CreateSecretResponseNonNullableFields$1 {
     id: string;
 }
@@ -141,9 +138,6 @@ interface UpdateSecretResponse {
 interface GetSecretValueResponseNonNullableFields {
     value: string;
 }
-interface ListSecretInfoResponseNonNullableFields {
-    secrets: Secret[];
-}
 interface CreateSecretResponseNonNullableFields {
     _id: string;
 }
@@ -161,7 +155,7 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
 declare function getSecretValue(): __PublicMethodMetaInfo<'GET', {
     name: string;
 }, GetSecretValueRequest, GetSecretValueRequest$1, GetSecretValueResponse & GetSecretValueResponseNonNullableFields, GetSecretValueResponse$1 & GetSecretValueResponseNonNullableFields$1>;
-declare function listSecretInfo(): __PublicMethodMetaInfo<'GET', {}, ListSecretInfoRequest, ListSecretInfoRequest$1, ListSecretInfoResponse & ListSecretInfoResponseNonNullableFields, ListSecretInfoResponse$1 & ListSecretInfoResponseNonNullableFields$1>;
+declare function listSecretInfo(): __PublicMethodMetaInfo<'GET', {}, ListSecretInfoRequest, ListSecretInfoRequest$1, ListSecretInfoResponse, ListSecretInfoResponse$1>;
 declare function createSecret(): __PublicMethodMetaInfo<'POST', {}, CreateSecretRequest, CreateSecretRequest$1, CreateSecretResponse & CreateSecretResponseNonNullableFields, CreateSecretResponse$1 & CreateSecretResponseNonNullableFields$1>;
 declare function deleteSecret(): __PublicMethodMetaInfo<'DELETE', {
     id: string;