@wix/data-resourceusage-service 1.0.1 → 1.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/data-resourceusage-service",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,7 +18,7 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/data-resourceusage-service_data": "1.0.1"
+    "@wix/data-resourceusage-service_data": "1.0.3"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -42,5 +42,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "c462aa04e47589d7238874705692fc4a0a0e29ece62a447bef9141ef"
+  "falconPackageHash": "732284bd09fe5b555725ef23507c54cf616ebeff19e03581ec948e45"
 }

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

@@ -59,19 +59,320 @@ declare enum CollectionType {
     /** Collection located in externally connected storage. */
     EXTERNAL = "EXTERNAL"
 }
+interface GetResourceUsageRequest {
+    /** ResourceUsage fields to return, if empty all are returned */
+    fields?: string[];
+    /** If true, operation queries collections for up-to-date values (rather than using cached values) */
+    consistentRead?: boolean;
+}
 interface GetResourceUsageResponse {
     /** The retrieved ResourceUsage */
     resourceUsage?: ResourceUsage;
 }
+interface BulkUpdateUsagesRequest {
+    updates?: InstanceUsageUpdate[];
+}
+interface DataCollectionResourceUsageUpdate {
+    /** Data Collection ID */
+    dataCollectionId?: string;
+    /** if true present values are added to existing, otherwise values are replaced */
+    relative?: boolean;
+    /** Data Collection item count in the live environment */
+    liveItemCount?: string | null;
+    /** Data Collection item count in the sandbox environment */
+    sandboxItemCount?: string | null;
+    /** Data Collection used storage in bytes in the live environment */
+    liveUsedStorageInBytes?: string | null;
+    /** Data Collection used storage in bytes in the sandbox environment */
+    sandboxUsedStorageInBytes?: string | null;
+}
+declare enum Segment {
+    BOTH = "BOTH",
+    LIVE = "LIVE",
+    SANDBOX = "SANDBOX"
+}
+interface InstanceUsageUpdate {
+    /** Data Instance ID */
+    instanceId?: string;
+    /** Usage updates per collection */
+    collections?: DataCollectionResourceUsageUpdate[];
+    /** if true all collections not in the list assumed to have 0 usage */
+    allCollectionsPresent?: boolean;
+    /** Indicates which segment is being updated */
+    segment?: Segment;
+}
+interface BulkUpdateUsagesResponse {
+}
+interface GetStoredUsageRequest {
+    instanceId?: string;
+}
+interface GetStoredUsageResponse {
+    usages?: DataCollectionResourceUsage[];
+}
+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 Empty {
+}
+interface DataChangeEvent extends DataChangeEventEventOneOf {
+    dataChanged?: DataChanged;
+    /** resume point is lost so some changes may be lost */
+    changesLost?: ChangesLost;
+    referenceChanged?: ReferenceChanged;
+    /** segment access or mapping changed */
+    segmentChanged?: SegmentChanged;
+    /** segment migration started to new physical location */
+    segmentMigrationStarted?: SegmentMigrationStarted;
+}
+/** @oneof */
+interface DataChangeEventEventOneOf {
+    dataChanged?: DataChanged;
+    /** resume point is lost so some changes may be lost */
+    changesLost?: ChangesLost;
+    referenceChanged?: ReferenceChanged;
+    /** segment access or mapping changed */
+    segmentChanged?: SegmentChanged;
+    /** segment migration started to new physical location */
+    segmentMigrationStarted?: SegmentMigrationStarted;
+}
+interface DataChanged extends DataChangedChangeOneOf {
+    /** inserted document */
+    inserted?: Record<string, any> | null;
+    /** full replaced document */
+    replaced?: Record<string, any> | null;
+    /** partial update, removed fields are set to Empty */
+    partial?: Record<string, any> | null;
+    /** deleted document ID */
+    removedId?: string;
+    /** physical cluster ID */
+    clusterId?: string;
+    /**
+     * physical source
+     * db.collection for MongoDB
+     */
+    source?: string;
+    /** instance ID */
+    tenantId?: string;
+    /** logical collection name */
+    collectionName?: string;
+    dataStore?: DataStore;
+    documentId?: string;
+    clusterTime?: Date;
+    /** raw resume token BSON */
+    resumeToken?: string;
+    /** Initiator of the request */
+    initiator?: Initiator;
+}
+/** @oneof */
+interface DataChangedChangeOneOf {
+    /** inserted document */
+    inserted?: Record<string, any> | null;
+    /** full replaced document */
+    replaced?: Record<string, any> | null;
+    /** partial update, removed fields are set to Empty */
+    partial?: Record<string, any> | null;
+    /** deleted document ID */
+    removedId?: string;
+}
+declare enum Type {
+    /** Initiator is unknown */
+    Unknown = "Unknown",
+    /** Indicated that write has been initiated by SSR indexer */
+    SsrIndexer = "SsrIndexer"
+}
+declare enum DataStore {
+    Dev = "Dev",
+    Public = "Public"
+}
+interface Initiator {
+    type?: Type;
+}
+interface ChangesLost {
+    clusterId?: string;
+}
+interface ReferenceChanged {
+    /** physical cluster ID */
+    clusterId?: string;
+    /**
+     * physical source
+     * db.collection for MongoDB
+     */
+    source?: string;
+    /** instance ID */
+    tenantId?: string;
+    dataStore?: DataStore;
+    relationshipName?: string;
+    leftId?: string;
+    rightId?: string;
+    /** if reference is set or unset */
+    isRemoved?: boolean;
+    clusterTime?: Date;
+    /** raw resume token BSON */
+    resumeToken?: string;
+    /** ref created date */
+    createdAt?: Date;
+}
+interface SegmentChanged {
+    /** physical cluster ID */
+    clusterId?: string;
+    /**
+     * physical source
+     * db.collection for MongoDB
+     */
+    source?: string;
+    /** instance ID */
+    tenantId?: string;
+    /** segment */
+    dataStore?: DataStore;
+    /** new db name if changed */
+    newDatabase?: string | null;
+    /** new cluster if changed */
+    newClusterId?: string | null;
+    /** read permissions if changed */
+    readsEnabled?: boolean | null;
+    /** write permissions if changed */
+    writesEnabled?: boolean | null;
+    /** event time */
+    clusterTime?: Date;
+    /** raw resume token BSON */
+    resumeToken?: string;
+}
+interface SegmentMigrationStarted {
+    /** physical cluster ID */
+    clusterId?: string;
+    /**
+     * physical source
+     * db.collection for MongoDB
+     */
+    source?: string;
+    /** instance ID */
+    tenantId?: string;
+    /** segment */
+    dataStore?: DataStore;
+    /** new db name if changed */
+    newDatabase?: string;
+    /** new cluster if changed */
+    newClusterId?: string;
+    /** event time */
+    clusterTime?: Date;
+    /** raw resume token BSON */
+    resumeToken?: 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;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface DataCollectionResourceUsageNonNullableFields {
+    dataCollectionId: string;
+    liveItemCount: string;
+    liveUsedStorageInBytes: string;
+    dataCollectionType: CollectionType;
+}
+interface ResourceUsageNonNullableFields {
+    dataCollectionUsages: DataCollectionResourceUsageNonNullableFields[];
+}
 interface GetResourceUsageResponseNonNullableFields {
-    resourceUsage?: {
-        dataCollectionUsages: {
-            dataCollectionId: string;
-            liveItemCount: string;
-            liveUsedStorageInBytes: string;
-            dataCollectionType: CollectionType;
-        }[];
-    };
+    resourceUsage?: ResourceUsageNonNullableFields;
 }
 interface GetResourceUsageOptions {
     /** ResourceUsage fields to return, if empty all are returned */
@@ -83,7 +384,8 @@ interface GetResourceUsageOptions {
 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>;
+    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> = {
@@ -113,13 +415,54 @@ declare global {
 	}
 }
 
-declare function getResourceUsage$1(httpClient: HttpClient): (options?: GetResourceUsageOptions) => Promise<GetResourceUsageResponse & GetResourceUsageResponseNonNullableFields>;
+declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
-declare const getResourceUsage: BuildRESTFunction<typeof getResourceUsage$1>;
+declare const getResourceUsage: ReturnType<typeof createRESTModule<typeof publicGetResourceUsage>>;
 
+type context_ActionEvent = ActionEvent;
+type context_BulkUpdateUsagesRequest = BulkUpdateUsagesRequest;
+type context_BulkUpdateUsagesResponse = BulkUpdateUsagesResponse;
+type context_ChangesLost = ChangesLost;
+type context_CollectionType = CollectionType;
+declare const context_CollectionType: typeof CollectionType;
+type context_DataChangeEvent = DataChangeEvent;
+type context_DataChangeEventEventOneOf = DataChangeEventEventOneOf;
+type context_DataChanged = DataChanged;
+type context_DataChangedChangeOneOf = DataChangedChangeOneOf;
+type context_DataCollectionResourceUsage = DataCollectionResourceUsage;
+type context_DataCollectionResourceUsageUpdate = DataCollectionResourceUsageUpdate;
+type context_DataStore = DataStore;
+declare const context_DataStore: typeof DataStore;
+type context_DomainEvent = DomainEvent;
+type context_DomainEventBodyOneOf = DomainEventBodyOneOf;
+type context_Empty = Empty;
+type context_EntityCreatedEvent = EntityCreatedEvent;
+type context_EntityDeletedEvent = EntityDeletedEvent;
+type context_EntityUpdatedEvent = EntityUpdatedEvent;
+type context_GetResourceUsageOptions = GetResourceUsageOptions;
+type context_GetResourceUsageRequest = GetResourceUsageRequest;
+type context_GetResourceUsageResponse = GetResourceUsageResponse;
+type context_GetResourceUsageResponseNonNullableFields = GetResourceUsageResponseNonNullableFields;
+type context_GetStoredUsageRequest = GetStoredUsageRequest;
+type context_GetStoredUsageResponse = GetStoredUsageResponse;
+type context_IdentificationData = IdentificationData;
+type context_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
+type context_Initiator = Initiator;
+type context_InstanceUsageUpdate = InstanceUsageUpdate;
+type context_MessageEnvelope = MessageEnvelope;
+type context_ReferenceChanged = ReferenceChanged;
+type context_ResourceUsage = ResourceUsage;
+type context_Segment = Segment;
+declare const context_Segment: typeof Segment;
+type context_SegmentChanged = SegmentChanged;
+type context_SegmentMigrationStarted = SegmentMigrationStarted;
+type context_Type = Type;
+declare const context_Type: typeof Type;
+type context_WebhookIdentityType = WebhookIdentityType;
+declare const context_WebhookIdentityType: typeof WebhookIdentityType;
 declare const context_getResourceUsage: typeof getResourceUsage;
 declare namespace context {
-  export { context_getResourceUsage as getResourceUsage };
+  export { type context_ActionEvent as ActionEvent, type context_BulkUpdateUsagesRequest as BulkUpdateUsagesRequest, type context_BulkUpdateUsagesResponse as BulkUpdateUsagesResponse, type context_ChangesLost as ChangesLost, context_CollectionType as CollectionType, type context_DataChangeEvent as DataChangeEvent, type context_DataChangeEventEventOneOf as DataChangeEventEventOneOf, type context_DataChanged as DataChanged, type context_DataChangedChangeOneOf as DataChangedChangeOneOf, type context_DataCollectionResourceUsage as DataCollectionResourceUsage, type context_DataCollectionResourceUsageUpdate as DataCollectionResourceUsageUpdate, context_DataStore as DataStore, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_Empty as Empty, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_GetResourceUsageOptions as GetResourceUsageOptions, type context_GetResourceUsageRequest as GetResourceUsageRequest, type context_GetResourceUsageResponse as GetResourceUsageResponse, type context_GetResourceUsageResponseNonNullableFields as GetResourceUsageResponseNonNullableFields, type context_GetStoredUsageRequest as GetStoredUsageRequest, type context_GetStoredUsageResponse as GetStoredUsageResponse, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context_Initiator as Initiator, type context_InstanceUsageUpdate as InstanceUsageUpdate, type context_MessageEnvelope as MessageEnvelope, type context_ReferenceChanged as ReferenceChanged, type context_ResourceUsage as ResourceUsage, context_Segment as Segment, type context_SegmentChanged as SegmentChanged, type context_SegmentMigrationStarted as SegmentMigrationStarted, context_Type as Type, context_WebhookIdentityType as WebhookIdentityType, context_getResourceUsage as getResourceUsage };
 }
 
 export { context as data };

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

@@ -362,15 +362,17 @@ declare enum WebhookIdentityType {
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
+interface DataCollectionResourceUsageNonNullableFields {
+    dataCollectionId: string;
+    liveItemCount: string;
+    liveUsedStorageInBytes: string;
+    dataCollectionType: CollectionType;
+}
+interface ResourceUsageNonNullableFields {
+    dataCollectionUsages: DataCollectionResourceUsageNonNullableFields[];
+}
 interface GetResourceUsageResponseNonNullableFields {
-    resourceUsage?: {
-        dataCollectionUsages: {
-            dataCollectionId: string;
-            liveItemCount: string;
-            liveUsedStorageInBytes: string;
-            dataCollectionType: CollectionType;
-        }[];
-    };
+    resourceUsage?: ResourceUsageNonNullableFields;
 }
 interface GetResourceUsageOptions {
     /** ResourceUsage fields to return, if empty all are returned */
@@ -381,7 +383,8 @@ interface GetResourceUsageOptions {
 
 interface HttpClient {
     request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
-    fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
+    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> = {

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

@@ -69,15 +69,17 @@ interface GetResourceUsageResponse$1 {
     /** The retrieved ResourceUsage */
     resourceUsage?: ResourceUsage$1;
 }
+interface DataCollectionResourceUsageNonNullableFields$1 {
+    dataCollectionId: string;
+    liveItemCount: string;
+    liveUsedStorageInBytes: string;
+    dataCollectionType: CollectionType$1;
+}
+interface ResourceUsageNonNullableFields$1 {
+    dataCollectionUsages: DataCollectionResourceUsageNonNullableFields$1[];
+}
 interface GetResourceUsageResponseNonNullableFields$1 {
-    resourceUsage?: {
-        dataCollectionUsages: {
-            dataCollectionId: string;
-            liveItemCount: string;
-            liveUsedStorageInBytes: string;
-            dataCollectionType: CollectionType$1;
-        }[];
-    };
+    resourceUsage?: ResourceUsageNonNullableFields$1;
 }
 
 /** ResourceUsage describes site-wide resource limits and usage */
@@ -151,15 +153,17 @@ interface GetResourceUsageResponse {
     /** The retrieved ResourceUsage */
     resourceUsage?: ResourceUsage;
 }
+interface DataCollectionResourceUsageNonNullableFields {
+    dataCollectionId: string;
+    liveItemCount: string;
+    liveUsedStorageInBytes: string;
+    dataCollectionType: CollectionType;
+}
+interface ResourceUsageNonNullableFields {
+    dataCollectionUsages: DataCollectionResourceUsageNonNullableFields[];
+}
 interface GetResourceUsageResponseNonNullableFields {
-    resourceUsage?: {
-        dataCollectionUsages: {
-            dataCollectionId: string;
-            liveItemCount: string;
-            liveUsedStorageInBytes: string;
-            dataCollectionType: CollectionType;
-        }[];
-    };
+    resourceUsage?: ResourceUsageNonNullableFields;
 }
 
 type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {