@croct/sdk 0.19.1 → 0.20.0

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.1";
+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.1";
-declare const CLIENT_LIBRARY = "Croct SDK JS v0.19.1";
+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.1";
-declare const CLIENT_LIBRARY = "Croct SDK JS v0.19.1";
+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.1";
+const VERSION = "0.20.0";
 const CLIENT_LIBRARY = `Croct SDK JS v${VERSION}`;
 export {
   BASE_ENDPOINT_URL,

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/contentFetcher.cjs

@@ -57,13 +57,13 @@ 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(
@@ -82,7 +82,7 @@ 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}.`);
@@ -136,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';
@@ -20,7 +21,10 @@ declare class ContentError<T extends ErrorResponse = ErrorResponse> extends Erro
     readonly response: T;
     constructor(response: T);
 }
-type BasicOptions = {
+type FetchResponseOptions = {
+    includeSchema?: boolean;
+};
+type BasicOptions = FetchResponseOptions & {
     version?: `${number}` | number;
     preferredLocale?: string;
     timeout?: number;
@@ -43,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 = {
@@ -60,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';
@@ -20,7 +21,10 @@ declare class ContentError<T extends ErrorResponse = ErrorResponse> extends Erro
     readonly response: T;
     constructor(response: T);
 }
-type BasicOptions = {
+type FetchResponseOptions = {
+    includeSchema?: boolean;
+};
+type BasicOptions = FetchResponseOptions & {
     version?: `${number}` | number;
     preferredLocale?: string;
     timeout?: number;
@@ -43,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 = {
@@ -60,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

@@ -33,13 +33,13 @@ 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(
@@ -58,7 +58,7 @@ 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}.`);
@@ -112,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/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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@croct/sdk",
-  "version": "0.19.1",
+  "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;