@croct/sdk 0.19.0 → 0.20.0

package/README.md

@@ -16,7 +16,6 @@
 <p align="center">
     <a href="https://www.npmjs.com/package/@croct/sdk"><img alt="Version" src="https://img.shields.io/npm/v/@croct/sdk"/></a>
     <a href="https://github.com/croct-tech/sdk-js/actions?query=workflow%3AValidations"><img alt="Build" src="https://github.com/croct-tech/sdk-js/workflows/Validations/badge.svg"/></a>
-    <a href="https://codeclimate.com/repos/5e7251b3172af05fe9000e27/test_coverage"><img alt="Coverage" src="https://api.codeclimate.com/v1/badges/c44df78a3ed891af11bb/test_coverage"/></a>
 </p>
 
 ## Installation

package/channel/httpBeaconChannel.cjs

@@ -56,6 +56,11 @@ class HttpBeaconChannel {
       keepalive: true
     }).then(async (response) => {
       if (response.ok) {
+        if (response.status === 202) {
+          this.logger.warn(
+            "Event tracking is currently suspended for this application, check the workspace settings. For help, see https://croct.help/sdk/javascript/suspended-service"
+          );
+        }
         this.notify(receiptId);
         return;
       }

package/channel/httpBeaconChannel.js

@@ -34,6 +34,11 @@ class HttpBeaconChannel {
       keepalive: true
     }).then(async (response) => {
       if (response.ok) {
+        if (response.status === 202) {
+          this.logger.warn(
+            "Event tracking is currently suspended for this application, check the workspace settings. For help, see https://croct.help/sdk/javascript/suspended-service"
+          );
+        }
         this.notify(receiptId);
         return;
       }

package/constants.cjs

@@ -25,7 +25,7 @@ __export(constants_exports, {
 module.exports = __toCommonJS(constants_exports);
 const BASE_ENDPOINT_URL = "https://api.croct.io";
 const MAX_QUERY_LENGTH = parseInt("<@maxQueryLength@>", 10);
-const VERSION = "0.19.0";
+const VERSION = "0.20.0";
 const CLIENT_LIBRARY = `Croct SDK JS v${VERSION}`;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/constants.d.cts

@@ -1,6 +1,6 @@
 declare const BASE_ENDPOINT_URL = "https://api.croct.io";
 declare const MAX_QUERY_LENGTH: number;
-declare const VERSION = "0.19.0";
-declare const CLIENT_LIBRARY = "Croct SDK JS v0.19.0";
+declare const VERSION = "0.20.0";
+declare const CLIENT_LIBRARY = "Croct SDK JS v0.20.0";
 
 export { BASE_ENDPOINT_URL, CLIENT_LIBRARY, MAX_QUERY_LENGTH, VERSION };

package/constants.d.ts

@@ -1,6 +1,6 @@
 declare const BASE_ENDPOINT_URL = "https://api.croct.io";
 declare const MAX_QUERY_LENGTH: number;
-declare const VERSION = "0.19.0";
-declare const CLIENT_LIBRARY = "Croct SDK JS v0.19.0";
+declare const VERSION = "0.20.0";
+declare const CLIENT_LIBRARY = "Croct SDK JS v0.20.0";
 
 export { BASE_ENDPOINT_URL, CLIENT_LIBRARY, MAX_QUERY_LENGTH, VERSION };

package/constants.js

@@ -1,6 +1,6 @@
 const BASE_ENDPOINT_URL = "https://api.croct.io";
 const MAX_QUERY_LENGTH = parseInt("<@maxQueryLength@>", 10);
-const VERSION = "0.19.0";
+const VERSION = "0.20.0";
 const CLIENT_LIBRARY = `Croct SDK JS v${VERSION}`;
 export {
   BASE_ENDPOINT_URL,

package/container.cjs

@@ -38,6 +38,7 @@ var import_contentFetcher = require('./contentFetcher.cjs');
 var import_cookieCache = require('./cache/cookieCache.cjs');
 var import_filteredLogger = require('./logging/filteredLogger.cjs');
 var import_httpBeaconChannel = require('./channel/httpBeaconChannel.cjs');
+var import_deduplicatedLogger = require('./logging/deduplicatedLogger.cjs');
 const _Container = class _Container {
   constructor(configuration) {
     this.eventManager = new import_eventManager.SynchronousEventManager();
@@ -230,7 +231,7 @@ const _Container = class _Container {
     if (this.configuration.debug) {
       return new import_logging.ConsoleLogger(prefix);
     }
-    return import_filteredLogger.FilteredLogger.include(new import_logging.ConsoleLogger(), ["error", "warn"]);
+    return new import_deduplicatedLogger.DeduplicatedLogger(import_filteredLogger.FilteredLogger.include(new import_logging.ConsoleLogger(prefix), ["error", "warn"]));
   }
   getTabStorage(namespace, ...subnamespace) {
     return this.getGlobalTabStorage("external", namespace, ...subnamespace);

package/container.d.cts

@@ -20,6 +20,7 @@ import './trackingEvents.cjs';
 import './patch.cjs';
 import './utilityTypes.cjs';
 import './sourceLocation.cjs';
+import '@croct/content-model/definition';
 
 type DependencyResolver<T> = (container: Container) => T;
 type Configuration = {

package/container.d.ts

@@ -20,6 +20,7 @@ import './trackingEvents.js';
 import './patch.js';
 import './utilityTypes.js';
 import './sourceLocation.js';
+import '@croct/content-model/definition';
 
 type DependencyResolver<T> = (container: Container) => T;
 type Configuration = {

package/container.js

@@ -22,6 +22,7 @@ import { ContentFetcher } from "./contentFetcher.js";
 import { CookieCache } from "./cache/cookieCache.js";
 import { FilteredLogger } from "./logging/filteredLogger.js";
 import { HttpBeaconChannel } from "./channel/httpBeaconChannel.js";
+import { DeduplicatedLogger } from "./logging/deduplicatedLogger.js";
 const _Container = class _Container {
   constructor(configuration) {
     this.eventManager = new SynchronousEventManager();
@@ -214,7 +215,7 @@ const _Container = class _Container {
     if (this.configuration.debug) {
       return new ConsoleLogger(prefix);
     }
-    return FilteredLogger.include(new ConsoleLogger(), ["error", "warn"]);
+    return new DeduplicatedLogger(FilteredLogger.include(new ConsoleLogger(prefix), ["error", "warn"]));
   }
   getTabStorage(namespace, ...subnamespace) {
     return this.getGlobalTabStorage("external", namespace, ...subnamespace);

package/contentFetcher.cjs

@@ -28,8 +28,9 @@ var import_logging = require('./logging/index.cjs');
 var import_apiKey = require('./apiKey.cjs');
 var import_help = require('./help.cjs');
 var ContentErrorType = /* @__PURE__ */ ((ContentErrorType2) => {
-  ContentErrorType2["TIMEOUT"] = "https://croct.help/api/content#timeout";
-  ContentErrorType2["UNEXPECTED_ERROR"] = "https://croct.help/api/content#unexpected-error";
+  ContentErrorType2["TIMEOUT"] = "https://croct.help/sdk/javascript/request-timeout";
+  ContentErrorType2["UNEXPECTED_ERROR"] = "https://croct.help/sdk/javascript/unexpected-error";
+  ContentErrorType2["SUSPENDED_SERVICE"] = "https://croct.help/sdk/javascript/suspended-service";
   return ContentErrorType2;
 })(ContentErrorType || {});
 class ContentError extends Error {
@@ -56,20 +57,20 @@ class ContentFetcher {
       defaultPreferredLocale: configuration.defaultPreferredLocale
     };
   }
-  fetch(slotId, options = {}) {
-    if (options.static === true && this.configuration.apiKey === void 0) {
+  fetch(slotId, options) {
+    if (options?.static === true && this.configuration.apiKey === void 0) {
       throw new Error("The API key must be provided to fetch static content.");
     }
     return new Promise((resolve, reject) => {
       const abortController = new AbortController();
-      const timeout = options.timeout ?? this.configuration.defaultTimeout;
+      const timeout = options?.timeout ?? this.configuration.defaultTimeout;
       let timer;
       if (timeout !== void 0) {
         timer = setTimeout(
           () => {
             const response = {
               title: `Content could not be loaded in time for slot '${slotId}'.`,
-              type: "https://croct.help/api/content#timeout" /* TIMEOUT */,
+              type: "https://croct.help/sdk/javascript/request-timeout" /* TIMEOUT */,
               detail: `The content took more than ${timeout}ms to load.`,
               status: 408
               // Request Timeout
@@ -81,10 +82,18 @@ class ContentFetcher {
           timeout
         );
       }
-      this.load(slotId, abortController.signal, options).finally(() => clearTimeout(timer)).then((response) => {
+      this.load(slotId, abortController.signal, options ?? {}).finally(() => clearTimeout(timer)).then((response) => {
         const region = response.headers.get("X-Croct-Region");
         const timing = response.headers.get("X-Croct-Timing");
         this.logger.debug(`Content for slot '${slotId}' processed by region ${region} in ${timing}.`);
+        if (response.status === 202) {
+          return reject(new ContentError({
+            status: 202,
+            title: "Service is suspended.",
+            type: "https://croct.help/sdk/javascript/suspended-service" /* SUSPENDED_SERVICE */,
+            detail: import_help.Help.forStatusCode(202)
+          }));
+        }
         return response.json().then((body) => {
           if (response.ok) {
             return resolve(body);
@@ -102,7 +111,7 @@ class ContentFetcher {
           reject(
             new ContentError({
               title: (0, import_error.formatMessage)(error),
-              type: "https://croct.help/api/content#unexpected-error" /* UNEXPECTED_ERROR */,
+              type: "https://croct.help/sdk/javascript/unexpected-error" /* UNEXPECTED_ERROR */,
               detail: "Please try again or contact Croct support if the error persists.",
               status: 500
               // Internal Server Error
@@ -127,6 +136,9 @@ class ContentFetcher {
     const payload = {
       slotId
     };
+    if (options.includeSchema === true) {
+      payload.includeSchema = true;
+    }
     if (options.version !== void 0) {
       payload.version = `${options.version}`;
     }

package/contentFetcher.d.cts

@@ -1,4 +1,5 @@
 import { JsonObject } from '@croct/json';
+import { ContentDefinitionBundle } from '@croct/content-model/definition';
 import { EvaluationContext } from './evaluator.cjs';
 import { Token } from './token/token.cjs';
 import { Logger } from './logging/logger.cjs';
@@ -12,14 +13,18 @@ type ErrorResponse = {
     detail?: string;
 };
 declare enum ContentErrorType {
-    TIMEOUT = "https://croct.help/api/content#timeout",
-    UNEXPECTED_ERROR = "https://croct.help/api/content#unexpected-error"
+    TIMEOUT = "https://croct.help/sdk/javascript/request-timeout",
+    UNEXPECTED_ERROR = "https://croct.help/sdk/javascript/unexpected-error",
+    SUSPENDED_SERVICE = "https://croct.help/sdk/javascript/suspended-service"
 }
 declare class ContentError<T extends ErrorResponse = ErrorResponse> extends Error {
     readonly response: T;
     constructor(response: T);
 }
-type BasicOptions = {
+type FetchResponseOptions = {
+    includeSchema?: boolean;
+};
+type BasicOptions = FetchResponseOptions & {
     version?: `${number}` | number;
     preferredLocale?: string;
     timeout?: number;
@@ -42,7 +47,25 @@ type ExtraFetchOptions<T extends keyof RequestInit = AllowedFetchOptions> = Pick
     [key in Exclude<keyof RequestInit, T>]?: never;
 } & Record<string, any>;
 type FetchOptions = StaticContentOptions | DynamicContentOptions;
-type FetchResponse<P extends JsonObject = JsonObject> = {
+type With<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};
+type SlotMetadata = {
+    version: string;
+    schema?: ContentDefinitionBundle;
+    experience?: {
+        experienceId: string;
+        audienceId: string;
+        experiment?: {
+            experimentId: string;
+            variantId: string;
+        };
+    };
+};
+type FetchResponse<P = JsonObject, O = FetchResponseOptions> = {
+    metadata: With<SlotMetadata, O extends {
+        includeSchema: true;
+    } ? 'schema' : never>;
     content: P;
 };
 type Configuration = {
@@ -59,11 +82,11 @@ declare class ContentFetcher {
     private readonly staticEndpoint;
     private readonly logger;
     constructor(configuration: Configuration);
-    fetch<P extends JsonObject>(slotId: string, options?: FetchOptions): Promise<FetchResponse<P>>;
+    fetch<P extends JsonObject, O extends FetchResponseOptions>(slotId: string, options?: O & FetchOptions): Promise<FetchResponse<P, O>>;
     private load;
     private logHelp;
     private static isDynamicContent;
     toJSON(): never;
 }
 
-export { type Configuration, ContentError, ContentErrorType, ContentFetcher, type DynamicContentOptions, type ErrorResponse, type FetchOptions, type FetchResponse, type StaticContentOptions };
+export { type Configuration, ContentError, ContentErrorType, ContentFetcher, type DynamicContentOptions, type ErrorResponse, type FetchOptions, type FetchResponse, type FetchResponseOptions, type SlotMetadata, type StaticContentOptions };

package/contentFetcher.d.ts

@@ -1,4 +1,5 @@
 import { JsonObject } from '@croct/json';
+import { ContentDefinitionBundle } from '@croct/content-model/definition';
 import { EvaluationContext } from './evaluator.js';
 import { Token } from './token/token.js';
 import { Logger } from './logging/logger.js';
@@ -12,14 +13,18 @@ type ErrorResponse = {
     detail?: string;
 };
 declare enum ContentErrorType {
-    TIMEOUT = "https://croct.help/api/content#timeout",
-    UNEXPECTED_ERROR = "https://croct.help/api/content#unexpected-error"
+    TIMEOUT = "https://croct.help/sdk/javascript/request-timeout",
+    UNEXPECTED_ERROR = "https://croct.help/sdk/javascript/unexpected-error",
+    SUSPENDED_SERVICE = "https://croct.help/sdk/javascript/suspended-service"
 }
 declare class ContentError<T extends ErrorResponse = ErrorResponse> extends Error {
     readonly response: T;
     constructor(response: T);
 }
-type BasicOptions = {
+type FetchResponseOptions = {
+    includeSchema?: boolean;
+};
+type BasicOptions = FetchResponseOptions & {
     version?: `${number}` | number;
     preferredLocale?: string;
     timeout?: number;
@@ -42,7 +47,25 @@ type ExtraFetchOptions<T extends keyof RequestInit = AllowedFetchOptions> = Pick
     [key in Exclude<keyof RequestInit, T>]?: never;
 } & Record<string, any>;
 type FetchOptions = StaticContentOptions | DynamicContentOptions;
-type FetchResponse<P extends JsonObject = JsonObject> = {
+type With<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};
+type SlotMetadata = {
+    version: string;
+    schema?: ContentDefinitionBundle;
+    experience?: {
+        experienceId: string;
+        audienceId: string;
+        experiment?: {
+            experimentId: string;
+            variantId: string;
+        };
+    };
+};
+type FetchResponse<P = JsonObject, O = FetchResponseOptions> = {
+    metadata: With<SlotMetadata, O extends {
+        includeSchema: true;
+    } ? 'schema' : never>;
     content: P;
 };
 type Configuration = {
@@ -59,11 +82,11 @@ declare class ContentFetcher {
     private readonly staticEndpoint;
     private readonly logger;
     constructor(configuration: Configuration);
-    fetch<P extends JsonObject>(slotId: string, options?: FetchOptions): Promise<FetchResponse<P>>;
+    fetch<P extends JsonObject, O extends FetchResponseOptions>(slotId: string, options?: O & FetchOptions): Promise<FetchResponse<P, O>>;
     private load;
     private logHelp;
     private static isDynamicContent;
     toJSON(): never;
 }
 
-export { type Configuration, ContentError, ContentErrorType, ContentFetcher, type DynamicContentOptions, type ErrorResponse, type FetchOptions, type FetchResponse, type StaticContentOptions };
+export { type Configuration, ContentError, ContentErrorType, ContentFetcher, type DynamicContentOptions, type ErrorResponse, type FetchOptions, type FetchResponse, type FetchResponseOptions, type SlotMetadata, type StaticContentOptions };

package/contentFetcher.js

@@ -4,8 +4,9 @@ import { NullLogger } from "./logging/index.js";
 import { ApiKey } from "./apiKey.js";
 import { Help } from "./help.js";
 var ContentErrorType = /* @__PURE__ */ ((ContentErrorType2) => {
-  ContentErrorType2["TIMEOUT"] = "https://croct.help/api/content#timeout";
-  ContentErrorType2["UNEXPECTED_ERROR"] = "https://croct.help/api/content#unexpected-error";
+  ContentErrorType2["TIMEOUT"] = "https://croct.help/sdk/javascript/request-timeout";
+  ContentErrorType2["UNEXPECTED_ERROR"] = "https://croct.help/sdk/javascript/unexpected-error";
+  ContentErrorType2["SUSPENDED_SERVICE"] = "https://croct.help/sdk/javascript/suspended-service";
   return ContentErrorType2;
 })(ContentErrorType || {});
 class ContentError extends Error {
@@ -32,20 +33,20 @@ class ContentFetcher {
       defaultPreferredLocale: configuration.defaultPreferredLocale
     };
   }
-  fetch(slotId, options = {}) {
-    if (options.static === true && this.configuration.apiKey === void 0) {
+  fetch(slotId, options) {
+    if (options?.static === true && this.configuration.apiKey === void 0) {
       throw new Error("The API key must be provided to fetch static content.");
     }
     return new Promise((resolve, reject) => {
       const abortController = new AbortController();
-      const timeout = options.timeout ?? this.configuration.defaultTimeout;
+      const timeout = options?.timeout ?? this.configuration.defaultTimeout;
       let timer;
       if (timeout !== void 0) {
         timer = setTimeout(
           () => {
             const response = {
               title: `Content could not be loaded in time for slot '${slotId}'.`,
-              type: "https://croct.help/api/content#timeout" /* TIMEOUT */,
+              type: "https://croct.help/sdk/javascript/request-timeout" /* TIMEOUT */,
               detail: `The content took more than ${timeout}ms to load.`,
               status: 408
               // Request Timeout
@@ -57,10 +58,18 @@ class ContentFetcher {
           timeout
         );
       }
-      this.load(slotId, abortController.signal, options).finally(() => clearTimeout(timer)).then((response) => {
+      this.load(slotId, abortController.signal, options ?? {}).finally(() => clearTimeout(timer)).then((response) => {
         const region = response.headers.get("X-Croct-Region");
         const timing = response.headers.get("X-Croct-Timing");
         this.logger.debug(`Content for slot '${slotId}' processed by region ${region} in ${timing}.`);
+        if (response.status === 202) {
+          return reject(new ContentError({
+            status: 202,
+            title: "Service is suspended.",
+            type: "https://croct.help/sdk/javascript/suspended-service" /* SUSPENDED_SERVICE */,
+            detail: Help.forStatusCode(202)
+          }));
+        }
         return response.json().then((body) => {
           if (response.ok) {
             return resolve(body);
@@ -78,7 +87,7 @@ class ContentFetcher {
           reject(
             new ContentError({
               title: formatMessage(error),
-              type: "https://croct.help/api/content#unexpected-error" /* UNEXPECTED_ERROR */,
+              type: "https://croct.help/sdk/javascript/unexpected-error" /* UNEXPECTED_ERROR */,
               detail: "Please try again or contact Croct support if the error persists.",
               status: 500
               // Internal Server Error
@@ -103,6 +112,9 @@ class ContentFetcher {
     const payload = {
       slotId
     };
+    if (options.includeSchema === true) {
+      payload.includeSchema = true;
+    }
     if (options.version !== void 0) {
       payload.version = `${options.version}`;
     }

package/evaluator.cjs

@@ -30,13 +30,14 @@ var import_logging = require('./logging/index.cjs');
 var import_apiKey = require('./apiKey.cjs');
 var import_help = require('./help.cjs');
 var EvaluationErrorType = /* @__PURE__ */ ((EvaluationErrorType2) => {
-  EvaluationErrorType2["TIMEOUT"] = "https://croct.help/api/evaluation#timeout";
-  EvaluationErrorType2["UNEXPECTED_ERROR"] = "https://croct.help/api/evaluation#unexpected-error";
-  EvaluationErrorType2["INVALID_QUERY"] = "https://croct.help/api/evaluation#invalid-query";
-  EvaluationErrorType2["TOO_COMPLEX_QUERY"] = "https://croct.help/api/evaluation#too-complex-query";
-  EvaluationErrorType2["EVALUATION_FAILED"] = "https://croct.help/api/evaluation#evaluation-failed";
-  EvaluationErrorType2["UNALLOWED_RESULT"] = "https://croct.help/api/evaluation#unallowed-result";
-  EvaluationErrorType2["UNSERIALIZABLE_RESULT"] = "https://croct.help/api/evaluation#unserializable-result";
+  EvaluationErrorType2["TIMEOUT"] = "https://croct.help/sdk/javascript/request-timeout";
+  EvaluationErrorType2["UNEXPECTED_ERROR"] = "https://croct.help/sdk/javascript/unexpected-error";
+  EvaluationErrorType2["INVALID_QUERY"] = "https://croct.help/sdk/javascript/invalid-query";
+  EvaluationErrorType2["TOO_COMPLEX_QUERY"] = "https://croct.help/sdk/javascript/too-complex-query";
+  EvaluationErrorType2["EVALUATION_FAILED"] = "https://croct.help/sdk/javascript/evaluation-failed";
+  EvaluationErrorType2["UNALLOWED_RESULT"] = "https://croct.help/sdk/javascript/unallowed-result";
+  EvaluationErrorType2["SUSPENDED_SERVICE"] = "https://croct.help/sdk/javascript/suspended-service";
+  EvaluationErrorType2["UNSERIALIZABLE_RESULT"] = "https://croct.help/sdk/javascript/unserializable-result";
   return EvaluationErrorType2;
 })(EvaluationErrorType || {});
 class EvaluationError extends Error {
@@ -74,7 +75,7 @@ const _Evaluator = class _Evaluator {
         title: "The query is too complex.",
         status: 422,
         // Unprocessable Entity
-        type: "https://croct.help/api/evaluation#too-complex-query" /* TOO_COMPLEX_QUERY */,
+        type: "https://croct.help/sdk/javascript/too-complex-query" /* TOO_COMPLEX_QUERY */,
         detail: `The query "${reference}" must be at most ${_Evaluator.MAX_QUERY_LENGTH} characters long, but it is ${length} characters long.`,
         errors: [{
           cause: "The query is longer than expected.",
@@ -98,7 +99,7 @@ const _Evaluator = class _Evaluator {
           () => {
             const response = {
               title: `Evaluation could not be completed in time for query "${reference}".`,
-              type: "https://croct.help/api/evaluation#timeout" /* TIMEOUT */,
+              type: "https://croct.help/sdk/javascript/request-timeout" /* TIMEOUT */,
               detail: `The evaluation took more than ${timeout}ms to complete.`,
               status: 408
               // Request Timeout
@@ -117,6 +118,14 @@ const _Evaluator = class _Evaluator {
           this.logger.debug(
             `Evaluation of the query "${reference}" processed by region ${region} in ${timing}.`
           );
+          if (response.status === 202) {
+            return reject(new EvaluationError({
+              status: 202,
+              type: "https://croct.help/sdk/javascript/suspended-service" /* SUSPENDED_SERVICE */,
+              title: "Service is suspended.",
+              detail: import_help.Help.forStatusCode(202)
+            }));
+          }
           return response.json().then((body) => {
             if (response.ok) {
               return resolve(body);
@@ -124,9 +133,9 @@ const _Evaluator = class _Evaluator {
             this.logHelp(response.status);
             const problem = body;
             switch (problem.type) {
-              case "https://croct.help/api/evaluation#invalid-query" /* INVALID_QUERY */:
-              case "https://croct.help/api/evaluation#evaluation-failed" /* EVALUATION_FAILED */:
-              case "https://croct.help/api/evaluation#too-complex-query" /* TOO_COMPLEX_QUERY */:
+              case "https://croct.help/sdk/javascript/invalid-query" /* INVALID_QUERY */:
+              case "https://croct.help/sdk/javascript/evaluation-failed" /* EVALUATION_FAILED */:
+              case "https://croct.help/sdk/javascript/too-complex-query" /* TOO_COMPLEX_QUERY */:
                 reject(new QueryError(problem));
                 break;
               default:
@@ -146,7 +155,7 @@ const _Evaluator = class _Evaluator {
             reject(
               new EvaluationError({
                 title: (0, import_error.formatMessage)(error),
-                type: "https://croct.help/api/evaluation#unexpected-error" /* UNEXPECTED_ERROR */,
+                type: "https://croct.help/sdk/javascript/unexpected-error" /* UNEXPECTED_ERROR */,
                 detail: "Please try again or contact Croct support if the error persists.",
                 status: 500
                 // Internal Server Error

package/evaluator.d.cts

@@ -36,13 +36,14 @@ type EvaluationOptions = {
     extra?: ExtraFetchOptions;
 };
 declare enum EvaluationErrorType {
-    TIMEOUT = "https://croct.help/api/evaluation#timeout",
-    UNEXPECTED_ERROR = "https://croct.help/api/evaluation#unexpected-error",
-    INVALID_QUERY = "https://croct.help/api/evaluation#invalid-query",
-    TOO_COMPLEX_QUERY = "https://croct.help/api/evaluation#too-complex-query",
-    EVALUATION_FAILED = "https://croct.help/api/evaluation#evaluation-failed",
-    UNALLOWED_RESULT = "https://croct.help/api/evaluation#unallowed-result",
-    UNSERIALIZABLE_RESULT = "https://croct.help/api/evaluation#unserializable-result"
+    TIMEOUT = "https://croct.help/sdk/javascript/request-timeout",
+    UNEXPECTED_ERROR = "https://croct.help/sdk/javascript/unexpected-error",
+    INVALID_QUERY = "https://croct.help/sdk/javascript/invalid-query",
+    TOO_COMPLEX_QUERY = "https://croct.help/sdk/javascript/too-complex-query",
+    EVALUATION_FAILED = "https://croct.help/sdk/javascript/evaluation-failed",
+    UNALLOWED_RESULT = "https://croct.help/sdk/javascript/unallowed-result",
+    SUSPENDED_SERVICE = "https://croct.help/sdk/javascript/suspended-service",
+    UNSERIALIZABLE_RESULT = "https://croct.help/sdk/javascript/unserializable-result"
 }
 type ErrorResponse = {
     type: EvaluationErrorType;

package/evaluator.d.ts

@@ -36,13 +36,14 @@ type EvaluationOptions = {
     extra?: ExtraFetchOptions;
 };
 declare enum EvaluationErrorType {
-    TIMEOUT = "https://croct.help/api/evaluation#timeout",
-    UNEXPECTED_ERROR = "https://croct.help/api/evaluation#unexpected-error",
-    INVALID_QUERY = "https://croct.help/api/evaluation#invalid-query",
-    TOO_COMPLEX_QUERY = "https://croct.help/api/evaluation#too-complex-query",
-    EVALUATION_FAILED = "https://croct.help/api/evaluation#evaluation-failed",
-    UNALLOWED_RESULT = "https://croct.help/api/evaluation#unallowed-result",
-    UNSERIALIZABLE_RESULT = "https://croct.help/api/evaluation#unserializable-result"
+    TIMEOUT = "https://croct.help/sdk/javascript/request-timeout",
+    UNEXPECTED_ERROR = "https://croct.help/sdk/javascript/unexpected-error",
+    INVALID_QUERY = "https://croct.help/sdk/javascript/invalid-query",
+    TOO_COMPLEX_QUERY = "https://croct.help/sdk/javascript/too-complex-query",
+    EVALUATION_FAILED = "https://croct.help/sdk/javascript/evaluation-failed",
+    UNALLOWED_RESULT = "https://croct.help/sdk/javascript/unallowed-result",
+    SUSPENDED_SERVICE = "https://croct.help/sdk/javascript/suspended-service",
+    UNSERIALIZABLE_RESULT = "https://croct.help/sdk/javascript/unserializable-result"
 }
 type ErrorResponse = {
     type: EvaluationErrorType;

package/evaluator.js

@@ -5,13 +5,14 @@ import { NullLogger } from "./logging/index.js";
 import { ApiKey } from "./apiKey.js";
 import { Help } from "./help.js";
 var EvaluationErrorType = /* @__PURE__ */ ((EvaluationErrorType2) => {
-  EvaluationErrorType2["TIMEOUT"] = "https://croct.help/api/evaluation#timeout";
-  EvaluationErrorType2["UNEXPECTED_ERROR"] = "https://croct.help/api/evaluation#unexpected-error";
-  EvaluationErrorType2["INVALID_QUERY"] = "https://croct.help/api/evaluation#invalid-query";
-  EvaluationErrorType2["TOO_COMPLEX_QUERY"] = "https://croct.help/api/evaluation#too-complex-query";
-  EvaluationErrorType2["EVALUATION_FAILED"] = "https://croct.help/api/evaluation#evaluation-failed";
-  EvaluationErrorType2["UNALLOWED_RESULT"] = "https://croct.help/api/evaluation#unallowed-result";
-  EvaluationErrorType2["UNSERIALIZABLE_RESULT"] = "https://croct.help/api/evaluation#unserializable-result";
+  EvaluationErrorType2["TIMEOUT"] = "https://croct.help/sdk/javascript/request-timeout";
+  EvaluationErrorType2["UNEXPECTED_ERROR"] = "https://croct.help/sdk/javascript/unexpected-error";
+  EvaluationErrorType2["INVALID_QUERY"] = "https://croct.help/sdk/javascript/invalid-query";
+  EvaluationErrorType2["TOO_COMPLEX_QUERY"] = "https://croct.help/sdk/javascript/too-complex-query";
+  EvaluationErrorType2["EVALUATION_FAILED"] = "https://croct.help/sdk/javascript/evaluation-failed";
+  EvaluationErrorType2["UNALLOWED_RESULT"] = "https://croct.help/sdk/javascript/unallowed-result";
+  EvaluationErrorType2["SUSPENDED_SERVICE"] = "https://croct.help/sdk/javascript/suspended-service";
+  EvaluationErrorType2["UNSERIALIZABLE_RESULT"] = "https://croct.help/sdk/javascript/unserializable-result";
   return EvaluationErrorType2;
 })(EvaluationErrorType || {});
 class EvaluationError extends Error {
@@ -49,7 +50,7 @@ const _Evaluator = class _Evaluator {
         title: "The query is too complex.",
         status: 422,
         // Unprocessable Entity
-        type: "https://croct.help/api/evaluation#too-complex-query" /* TOO_COMPLEX_QUERY */,
+        type: "https://croct.help/sdk/javascript/too-complex-query" /* TOO_COMPLEX_QUERY */,
         detail: `The query "${reference}" must be at most ${_Evaluator.MAX_QUERY_LENGTH} characters long, but it is ${length} characters long.`,
         errors: [{
           cause: "The query is longer than expected.",
@@ -73,7 +74,7 @@ const _Evaluator = class _Evaluator {
           () => {
             const response = {
               title: `Evaluation could not be completed in time for query "${reference}".`,
-              type: "https://croct.help/api/evaluation#timeout" /* TIMEOUT */,
+              type: "https://croct.help/sdk/javascript/request-timeout" /* TIMEOUT */,
               detail: `The evaluation took more than ${timeout}ms to complete.`,
               status: 408
               // Request Timeout
@@ -92,6 +93,14 @@ const _Evaluator = class _Evaluator {
           this.logger.debug(
             `Evaluation of the query "${reference}" processed by region ${region} in ${timing}.`
           );
+          if (response.status === 202) {
+            return reject(new EvaluationError({
+              status: 202,
+              type: "https://croct.help/sdk/javascript/suspended-service" /* SUSPENDED_SERVICE */,
+              title: "Service is suspended.",
+              detail: Help.forStatusCode(202)
+            }));
+          }
           return response.json().then((body) => {
             if (response.ok) {
               return resolve(body);
@@ -99,9 +108,9 @@ const _Evaluator = class _Evaluator {
             this.logHelp(response.status);
             const problem = body;
             switch (problem.type) {
-              case "https://croct.help/api/evaluation#invalid-query" /* INVALID_QUERY */:
-              case "https://croct.help/api/evaluation#evaluation-failed" /* EVALUATION_FAILED */:
-              case "https://croct.help/api/evaluation#too-complex-query" /* TOO_COMPLEX_QUERY */:
+              case "https://croct.help/sdk/javascript/invalid-query" /* INVALID_QUERY */:
+              case "https://croct.help/sdk/javascript/evaluation-failed" /* EVALUATION_FAILED */:
+              case "https://croct.help/sdk/javascript/too-complex-query" /* TOO_COMPLEX_QUERY */:
                 reject(new QueryError(problem));
                 break;
               default:
@@ -121,7 +130,7 @@ const _Evaluator = class _Evaluator {
             reject(
               new EvaluationError({
                 title: formatMessage(error),
-                type: "https://croct.help/api/evaluation#unexpected-error" /* UNEXPECTED_ERROR */,
+                type: "https://croct.help/sdk/javascript/unexpected-error" /* UNEXPECTED_ERROR */,
                 detail: "Please try again or contact Croct support if the error persists.",
                 status: 500
                 // Internal Server Error

package/facade/contentFetcherFacade.cjs

@@ -37,20 +37,23 @@ class ContentFetcherFacade {
     this.cidAssigner = configuration.cidAssigner;
     this.contextFactory = configuration.contextFactory;
   }
-  async fetch(slotId, options = {}) {
+  async fetch(slotId, options) {
     if (typeof slotId !== "string" || slotId.length === 0) {
       throw new Error("The slot ID must be a non-empty string.");
     }
-    validate(options);
+    if (options !== void 0) {
+      validate(options);
+    }
     return this.fetcher.fetch(slotId, {
       static: false,
       clientId: await this.cidAssigner.assignCid(),
       userToken: this.userTokenProvider.getToken() ?? void 0,
       previewToken: this.previewTokenProvider.getToken() ?? void 0,
-      version: options.version,
-      context: this.contextFactory.createContext(options.attributes),
-      timeout: options.timeout,
-      preferredLocale: options.preferredLocale
+      version: options?.version,
+      context: this.contextFactory.createContext(options?.attributes),
+      timeout: options?.timeout,
+      preferredLocale: options?.preferredLocale,
+      includeSchema: options?.includeSchema
     });
   }
 }

package/facade/contentFetcherFacade.d.cts

@@ -1,8 +1,9 @@
 import { JsonObject } from '@croct/json';
-import { ContentFetcher, FetchResponse } from '../contentFetcher.cjs';
+import { FetchResponseOptions, ContentFetcher, FetchResponse } from '../contentFetcher.cjs';
 import { ContextFactory } from './evaluatorFacade.cjs';
 import { TokenProvider } from '../token/token.cjs';
 import { CidAssigner } from '../cid/assigner.cjs';
+import '@croct/content-model/definition';
 import '../evaluator.cjs';
 import '../sourceLocation.cjs';
 import '../logging/logger.cjs';
@@ -10,7 +11,7 @@ import '../apiKey.cjs';
 import '../tab.cjs';
 import '../eventManager.cjs';
 
-type FetchOptions = {
+type FetchOptions = FetchResponseOptions & {
     version?: `${number}` | number;
     preferredLocale?: string;
     timeout?: number;
@@ -30,7 +31,7 @@ declare class ContentFetcherFacade {
     private readonly userTokenProvider;
     private readonly cidAssigner;
     constructor(configuration: Configuration);
-    fetch<P extends JsonObject>(slotId: string, options?: FetchOptions): Promise<FetchResponse<P>>;
+    fetch<P extends JsonObject, O extends FetchResponseOptions>(slotId: string, options?: O & FetchOptions): Promise<FetchResponse<P, O>>;
 }
 
 export { type Configuration, ContentFetcherFacade, type FetchOptions };

package/facade/contentFetcherFacade.d.ts

@@ -1,8 +1,9 @@
 import { JsonObject } from '@croct/json';
-import { ContentFetcher, FetchResponse } from '../contentFetcher.js';
+import { FetchResponseOptions, ContentFetcher, FetchResponse } from '../contentFetcher.js';
 import { ContextFactory } from './evaluatorFacade.js';
 import { TokenProvider } from '../token/token.js';
 import { CidAssigner } from '../cid/assigner.js';
+import '@croct/content-model/definition';
 import '../evaluator.js';
 import '../sourceLocation.js';
 import '../logging/logger.js';
@@ -10,7 +11,7 @@ import '../apiKey.js';
 import '../tab.js';
 import '../eventManager.js';
 
-type FetchOptions = {
+type FetchOptions = FetchResponseOptions & {
     version?: `${number}` | number;
     preferredLocale?: string;
     timeout?: number;
@@ -30,7 +31,7 @@ declare class ContentFetcherFacade {
     private readonly userTokenProvider;
     private readonly cidAssigner;
     constructor(configuration: Configuration);
-    fetch<P extends JsonObject>(slotId: string, options?: FetchOptions): Promise<FetchResponse<P>>;
+    fetch<P extends JsonObject, O extends FetchResponseOptions>(slotId: string, options?: O & FetchOptions): Promise<FetchResponse<P, O>>;
 }
 
 export { type Configuration, ContentFetcherFacade, type FetchOptions };

package/facade/contentFetcherFacade.js

@@ -15,20 +15,23 @@ class ContentFetcherFacade {
     this.cidAssigner = configuration.cidAssigner;
     this.contextFactory = configuration.contextFactory;
   }
-  async fetch(slotId, options = {}) {
+  async fetch(slotId, options) {
     if (typeof slotId !== "string" || slotId.length === 0) {
       throw new Error("The slot ID must be a non-empty string.");
     }
-    validate(options);
+    if (options !== void 0) {
+      validate(options);
+    }
     return this.fetcher.fetch(slotId, {
       static: false,
       clientId: await this.cidAssigner.assignCid(),
       userToken: this.userTokenProvider.getToken() ?? void 0,
       previewToken: this.previewTokenProvider.getToken() ?? void 0,
-      version: options.version,
-      context: this.contextFactory.createContext(options.attributes),
-      timeout: options.timeout,
-      preferredLocale: options.preferredLocale
+      version: options?.version,
+      context: this.contextFactory.createContext(options?.attributes),
+      timeout: options?.timeout,
+      preferredLocale: options?.preferredLocale,
+      includeSchema: options?.includeSchema
     });
   }
 }

package/facade/index.d.cts

@@ -19,6 +19,7 @@ import '../cache/cache.cjs';
 import '../sdkEvents.cjs';
 import './contentFetcherFacade.cjs';
 import '../contentFetcher.cjs';
+import '@croct/content-model/definition';
 import '../cache/cookieCache.cjs';
 import '../trackingEvents.cjs';
 import '../patch.cjs';

package/facade/index.d.ts

@@ -19,6 +19,7 @@ import '../cache/cache.js';
 import '../sdkEvents.js';
 import './contentFetcherFacade.js';
 import '../contentFetcher.js';
+import '@croct/content-model/definition';
 import '../cache/cookieCache.js';
 import '../trackingEvents.js';
 import '../patch.js';

package/facade/sdkFacade.d.cts

@@ -26,6 +26,7 @@ import '../retry/policy.cjs';
 import '../cache/cache.cjs';
 import '../activeRecord.cjs';
 import '../contentFetcher.cjs';
+import '@croct/content-model/definition';
 
 type Configuration = {
     appId: string;

package/facade/sdkFacade.d.ts

@@ -26,6 +26,7 @@ import '../retry/policy.js';
 import '../cache/cache.js';
 import '../activeRecord.js';
 import '../contentFetcher.js';
+import '@croct/content-model/definition';
 
 type Configuration = {
     appId: string;

package/help.cjs

@@ -24,6 +24,8 @@ var Help;
 ((Help2) => {
   function forStatusCode(statusCode) {
     switch (statusCode) {
+      case 202:
+        return "The service is temporarily suspended. For help, see https://croct.help/sdk/javascript/suspended-service";
       case 401:
         return "The request was not authorized, most likely due to invalid credentials. For help, see https://croct.help/sdk/javascript/invalid-credentials";
       case 403:

package/help.d.cts

@@ -1,4 +1,5 @@
 declare namespace Help {
+    function forStatusCode(statusCode: 204 | 401 | 403 | 408 | 423): string;
     function forStatusCode(statusCode: number): string | undefined;
 }
 

package/help.d.ts

@@ -1,4 +1,5 @@
 declare namespace Help {
+    function forStatusCode(statusCode: 204 | 401 | 403 | 408 | 423): string;
     function forStatusCode(statusCode: number): string | undefined;
 }
 

package/help.js

@@ -2,6 +2,8 @@ var Help;
 ((Help2) => {
   function forStatusCode(statusCode) {
     switch (statusCode) {
+      case 202:
+        return "The service is temporarily suspended. For help, see https://croct.help/sdk/javascript/suspended-service";
       case 401:
         return "The request was not authorized, most likely due to invalid credentials. For help, see https://croct.help/sdk/javascript/invalid-credentials";
       case 403:

package/index.d.cts

@@ -22,4 +22,5 @@ import './evaluator.cjs';
 import './sourceLocation.cjs';
 import './cid/assigner.cjs';
 import './contentFetcher.cjs';
+import '@croct/content-model/definition';
 import './cache/cookieCache.cjs';

package/index.d.ts

@@ -22,4 +22,5 @@ import './evaluator.js';
 import './sourceLocation.js';
 import './cid/assigner.js';
 import './contentFetcher.js';
+import '@croct/content-model/definition';
 import './cache/cookieCache.js';

package/logging/deduplicatedLogger.cjs

@@ -0,0 +1,70 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var deduplicatedLogger_exports = {};
+__export(deduplicatedLogger_exports, {
+  DeduplicatedLogger: () => DeduplicatedLogger
+});
+module.exports = __toCommonJS(deduplicatedLogger_exports);
+class DeduplicatedLogger {
+  constructor(logger, maxSize = 100) {
+    this.recentMessages = /* @__PURE__ */ new Set();
+    this.logger = logger;
+    this.maxSize = maxSize;
+    if (maxSize <= 0 || !Number.isInteger(maxSize)) {
+      throw new Error("maxSize must be greater than 0");
+    }
+  }
+  debug(message) {
+    if (this.isDuplicated("debug", message)) {
+      this.logger.debug(message);
+    }
+  }
+  info(message) {
+    if (this.isDuplicated("info", message)) {
+      this.logger.info(message);
+    }
+  }
+  warn(message) {
+    if (this.isDuplicated("warn", message)) {
+      this.logger.warn(message);
+    }
+  }
+  error(message) {
+    if (this.isDuplicated("error", message)) {
+      this.logger.error(message);
+    }
+  }
+  isDuplicated(level, message) {
+    const key = `${level}:${message}`;
+    if (this.recentMessages.has(key)) {
+      this.recentMessages.delete(key);
+      this.recentMessages.add(key);
+      return false;
+    }
+    if (this.recentMessages.size >= this.maxSize) {
+      const oldest = this.recentMessages.values().next().value;
+      this.recentMessages.delete(oldest);
+    }
+    this.recentMessages.add(key);
+    return true;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DeduplicatedLogger
+});

package/logging/deduplicatedLogger.d.cts

@@ -0,0 +1,15 @@
+import { Logger } from './logger.cjs';
+
+declare class DeduplicatedLogger implements Logger {
+    private readonly logger;
+    private readonly recentMessages;
+    private readonly maxSize;
+    constructor(logger: Logger, maxSize?: number);
+    debug(message: string): void;
+    info(message: string): void;
+    warn(message: string): void;
+    error(message: string): void;
+    private isDuplicated;
+}
+
+export { DeduplicatedLogger };

package/logging/deduplicatedLogger.d.ts

@@ -0,0 +1,15 @@
+import { Logger } from './logger.js';
+
+declare class DeduplicatedLogger implements Logger {
+    private readonly logger;
+    private readonly recentMessages;
+    private readonly maxSize;
+    constructor(logger: Logger, maxSize?: number);
+    debug(message: string): void;
+    info(message: string): void;
+    warn(message: string): void;
+    error(message: string): void;
+    private isDuplicated;
+}
+
+export { DeduplicatedLogger };

package/logging/deduplicatedLogger.js

@@ -0,0 +1,47 @@
+class DeduplicatedLogger {
+  constructor(logger, maxSize = 100) {
+    this.recentMessages = /* @__PURE__ */ new Set();
+    this.logger = logger;
+    this.maxSize = maxSize;
+    if (maxSize <= 0 || !Number.isInteger(maxSize)) {
+      throw new Error("maxSize must be greater than 0");
+    }
+  }
+  debug(message) {
+    if (this.isDuplicated("debug", message)) {
+      this.logger.debug(message);
+    }
+  }
+  info(message) {
+    if (this.isDuplicated("info", message)) {
+      this.logger.info(message);
+    }
+  }
+  warn(message) {
+    if (this.isDuplicated("warn", message)) {
+      this.logger.warn(message);
+    }
+  }
+  error(message) {
+    if (this.isDuplicated("error", message)) {
+      this.logger.error(message);
+    }
+  }
+  isDuplicated(level, message) {
+    const key = `${level}:${message}`;
+    if (this.recentMessages.has(key)) {
+      this.recentMessages.delete(key);
+      this.recentMessages.add(key);
+      return false;
+    }
+    if (this.recentMessages.size >= this.maxSize) {
+      const oldest = this.recentMessages.values().next().value;
+      this.recentMessages.delete(oldest);
+    }
+    this.recentMessages.add(key);
+    return true;
+  }
+}
+export {
+  DeduplicatedLogger
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@croct/sdk",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "description": "Croct SDK for JavaScript.",
   "license": "MIT",
   "author": {
@@ -81,6 +81,7 @@
   },
   "dependencies": {
     "@croct/json": "^2.0.1",
+    "@croct/content-model": "^0.21.1",
     "tslib": "^2.5.0"
   },
   "devDependencies": {

package/schema/contentFetcherSchemas.cjs

@@ -39,6 +39,7 @@ const fetchOptionsSchema = new import_validation.ObjectType({
     preferredLocale: new import_validation.StringType({
       pattern: /^[a-z]{2,3}([-_][a-z]{2,3})?$/i
     }),
+    includeSchema: new import_validation.BooleanType(),
     attributes: new import_validation.JsonObjectType()
   }
 });

package/schema/contentFetcherSchemas.js

@@ -1,4 +1,4 @@
-import { ObjectType, NumberType, JsonObjectType, StringType, UnionType } from "../validation/index.js";
+import { ObjectType, NumberType, JsonObjectType, StringType, UnionType, BooleanType } from "../validation/index.js";
 const fetchOptionsSchema = new ObjectType({
   properties: {
     timeout: new NumberType({
@@ -17,6 +17,7 @@ const fetchOptionsSchema = new ObjectType({
     preferredLocale: new StringType({
       pattern: /^[a-z]{2,3}([-_][a-z]{2,3})?$/i
     }),
+    includeSchema: new BooleanType(),
     attributes: new JsonObjectType()
   }
 });

package/sdk.d.cts

@@ -21,6 +21,7 @@ import '@croct/json';
 import './utilityTypes.cjs';
 import './sourceLocation.cjs';
 import './apiKey.cjs';
+import '@croct/content-model/definition';
 
 type Configuration = {
     appId: string;

package/sdk.d.ts

@@ -21,6 +21,7 @@ import '@croct/json';
 import './utilityTypes.js';
 import './sourceLocation.js';
 import './apiKey.js';
+import '@croct/content-model/definition';
 
 type Configuration = {
     appId: string;