@wix/auto_sdk_cache_cache 1.0.0 → 1.0.2

package/build/internal/es/src/ssr-v1-invalidate-cache-request-cache.public.js.map

@@ -1 +1 @@
-{"version":3,"file":"ssr-v1-invalidate-cache-request-cache.public.js","sourceRoot":"","sources":["../../../../src/ssr-v1-invalidate-cache-request-cache.public.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,eAAe,IAAI,wBAAwB,GAC5C,MAAM,sDAAsD,CAAC;AAE9D,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC;AAEzD,MAAM,UAAU,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,mBAA0C,EAAE,EAAE,CACpD,wBAAwB,CACtB,mBAAmB;IACnB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC"}
+{"version":3,"file":"ssr-v1-invalidate-cache-request-cache.public.js","sourceRoot":"","sources":["../../../../src/ssr-v1-invalidate-cache-request-cache.public.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,eAAe,IAAI,wBAAwB,EAC3C,cAAc,IAAI,uBAAuB,GAC1C,MAAM,sDAAsD,CAAC;AAE9D,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC;AAEzD,MAAM,UAAU,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,mBAA0C,EAAE,EAAE,CACpD,wBAAwB,CACtB,mBAAmB;IACnB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AA4BD,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,uBAAuB;IACrB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC"}

package/build/internal/es/src/ssr-v1-invalidate-cache-request-cache.types.d.ts

@@ -13,3 +13,7 @@ export interface InvalidationMethodsInvalidateByOneOf {
 }
 export interface InvalidateCacheResponse {
 }
+export interface PurgeSiteCacheRequest {
+}
+export interface PurgeSiteCacheResponse {
+}

package/build/internal/es/src/ssr-v1-invalidate-cache-request-cache.universal.d.ts

@@ -13,6 +13,10 @@ export interface InvalidationMethodsInvalidateByOneOf {
 }
 export interface InvalidateCacheResponse {
 }
+export interface PurgeSiteCacheRequest {
+}
+export interface PurgeSiteCacheResponse {
+}
 /**
  * <blockquote class="important">
  *
@@ -23,7 +27,7 @@ export interface InvalidateCacheResponse {
  *
  * Invalidates or clears previously cached return values based on specified tags.
  *
- * The `invalidationMethods` parameter accepts an array of objects, each containing a `tag` field. These tags are defined when caching return values of web methods ([SDK](https://dev.wix.com/docs/sdk/core-modules/web-methods/web-method) | [Velo](https://dev.wix.com/docs/velo/api-reference/wix-web-module/web-method)) and routers (currently [Velo](https://dev.wix.com/docs/velo/api-reference/wix-router/ok) only).
+ * The `invalidationMethods` parameter accepts an array of objects, each containing a `tag` field. These tags are defined when caching return values of site [web methods](https://dev.wix.com/docs/sdk/core-modules/web-methods/introduction) and [routers](https://dev.wix.com/docs/velo/events-service-plugins/routers/service-plugins/wix-router/introduction#events-service-plugins_routers_service-plugins_wix-router_router-caching).
  *
  * For example, an array such as `[{ tag: "contacts" }, { tag: "labels" }]` will clear any cached return values tagged with "contacts" or "labels."
  *
@@ -32,8 +36,7 @@ export interface InvalidateCacheResponse {
  * >**Notes:**
  * >- If you don't specify any tags in the `invalidationMethods` parameter, no caches are invalidated.
  * >- If you don't call Invalidate Cache, caches are only invalidated when the Time to Live (TTL) expires or when the site is republished with a code change.
- *
- * >- (Velo only) Call Invalidate Cache to invalidate your web method and router caches. To invalidate Server Side Rendering (SSR) caches for your site, use the `invalidateCache()` function from the [`wix-site-backend`](https://dev.wix.com/docs/velo/api-reference/wix-site-backend/invalidate-cache) module.
+ * >- This method does not invalidate the Server Side Rendering (SSR) cache for your site. To invalidate that cache, use the Invalidate Cache method from the [`wix-site-backend`](https://dev.wix.com/docs/velo/api-reference/wix-site-backend/invalidate-cache) module.
  * @param invalidationMethods - An array of objects containing a `tag` field used to identify the cache to invalidate. All cached return values with any listed tags are invalidated. If no tags are specified, nothing is invalidated.
  * @public
  * @documentationMaturity preview
@@ -42,3 +45,12 @@ export interface InvalidateCacheResponse {
  * @fqn com.wixpress.html.cache.invalidate.InvalidateCacheService.invalidateCache
  */
 export declare function invalidateCache(invalidationMethods: InvalidationMethods[]): Promise<void>;
+/**
+ * Invalidates or clears previously cached return values based on metaSiteID.
+ * Takes the metaSiteID from the context and performs a hard purge.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId SSR.INVALIDATE_SITE_CACHE
+ * @fqn com.wixpress.html.cache.invalidate.InvalidateCacheService.PurgeSiteCache
+ */
+export declare function purgeSiteCache(): Promise<void>;

package/build/internal/es/src/ssr-v1-invalidate-cache-request-cache.universal.js

@@ -11,7 +11,7 @@ import * as ambassadorWixSsrV1InvalidateCacheRequest from './ssr-v1-invalidate-c
  *
  * Invalidates or clears previously cached return values based on specified tags.
  *
- * The `invalidationMethods` parameter accepts an array of objects, each containing a `tag` field. These tags are defined when caching return values of web methods ([SDK](https://dev.wix.com/docs/sdk/core-modules/web-methods/web-method) | [Velo](https://dev.wix.com/docs/velo/api-reference/wix-web-module/web-method)) and routers (currently [Velo](https://dev.wix.com/docs/velo/api-reference/wix-router/ok) only).
+ * The `invalidationMethods` parameter accepts an array of objects, each containing a `tag` field. These tags are defined when caching return values of site [web methods](https://dev.wix.com/docs/sdk/core-modules/web-methods/introduction) and [routers](https://dev.wix.com/docs/velo/events-service-plugins/routers/service-plugins/wix-router/introduction#events-service-plugins_routers_service-plugins_wix-router_router-caching).
  *
  * For example, an array such as `[{ tag: "contacts" }, { tag: "labels" }]` will clear any cached return values tagged with "contacts" or "labels."
  *
@@ -20,8 +20,7 @@ import * as ambassadorWixSsrV1InvalidateCacheRequest from './ssr-v1-invalidate-c
  * >**Notes:**
  * >- If you don't specify any tags in the `invalidationMethods` parameter, no caches are invalidated.
  * >- If you don't call Invalidate Cache, caches are only invalidated when the Time to Live (TTL) expires or when the site is republished with a code change.
- *
- * >- (Velo only) Call Invalidate Cache to invalidate your web method and router caches. To invalidate Server Side Rendering (SSR) caches for your site, use the `invalidateCache()` function from the [`wix-site-backend`](https://dev.wix.com/docs/velo/api-reference/wix-site-backend/invalidate-cache) module.
+ * >- This method does not invalidate the Server Side Rendering (SSR) cache for your site. To invalidate that cache, use the Invalidate Cache method from the [`wix-site-backend`](https://dev.wix.com/docs/velo/api-reference/wix-site-backend/invalidate-cache) module.
  * @param invalidationMethods - An array of objects containing a `tag` field used to identify the cache to invalidate. All cached return values with any listed tags are invalidated. If no tags are specified, nothing is invalidated.
  * @public
  * @documentationMaturity preview
@@ -51,4 +50,32 @@ export async function invalidateCache(invalidationMethods) {
         throw transformedError;
     }
 }
+/**
+ * Invalidates or clears previously cached return values based on metaSiteID.
+ * Takes the metaSiteID from the context and performs a hard purge.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId SSR.INVALIDATE_SITE_CACHE
+ * @fqn com.wixpress.html.cache.invalidate.InvalidateCacheService.PurgeSiteCache
+ */
+export async function purgeSiteCache() {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[0];
+    const payload = renameKeysFromSDKRequestToRESTRequest({});
+    const reqOpts = ambassadorWixSsrV1InvalidateCacheRequest.purgeSiteCache(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: {},
+            singleArgumentUnchanged: false,
+        }, []);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
 //# sourceMappingURL=ssr-v1-invalidate-cache-request-cache.universal.js.map

package/build/internal/es/src/ssr-v1-invalidate-cache-request-cache.universal.js.map

@@ -1 +1 @@
-{"version":3,"file":"ssr-v1-invalidate-cache-request-cache.universal.js","sourceRoot":"","sources":["../../../../src/ssr-v1-invalidate-cache-request-cache.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EAAE,qCAAqC,EAAE,MAAM,yCAAyC,CAAC;AAEhG,OAAO,KAAK,wCAAwC,MAAM,iDAAiD,CAAC;AAqB5G;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,mBAA0C;IAE1C,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,mBAAmB,EAAE,mBAAmB;KACzC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,wCAAwC,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAEpE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,mBAAmB,EAAE,MAAM,EAAE;YACzD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,qBAAqB,CAAC,CACxB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}
+{"version":3,"file":"ssr-v1-invalidate-cache-request-cache.universal.js","sourceRoot":"","sources":["../../../../src/ssr-v1-invalidate-cache-request-cache.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EAAE,qCAAqC,EAAE,MAAM,yCAAyC,CAAC;AAEhG,OAAO,KAAK,wCAAwC,MAAM,iDAAiD,CAAC;AAyB5G;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,mBAA0C;IAE1C,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,mBAAmB,EAAE,mBAAmB;KACzC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,wCAAwC,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAEpE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,mBAAmB,EAAE,MAAM,EAAE;YACzD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,qBAAqB,CAAC,CACxB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc;IAClC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,wCAAwC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAEnE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_cache_cache",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -48,5 +48,5 @@
       "fqdn": "wix.ssr.v1.invalidate_cache_request"
     }
   },
-  "falconPackageHash": "caa5780e8497abbecf2f704d28feb30b5f725e12f5a348dcb1a33337"
+  "falconPackageHash": "6da3f6d7d1083fa2ea1c90352b15b89e78f355f3c0969d9e10470f40"
 }