@remkoj/optimizely-graph-client 1.0.4 → 2.0.0-pre2

package/dist/services/routing/resolver.d.ts

@@ -0,0 +1,52 @@
+import { type IOptiGraphClient } from '../../client/index.js';
+import type { OptimizelyGraphConfig } from '../../types.js';
+import type { Route } from "./types.js";
+import type { ContentLinkWithLocale } from '../types.js';
+import * as GetAllRoutes from './queries/getAllRoutes.js';
+/**
+ *
+ */
+export declare class RouteResolver {
+    private _cgClient;
+    private _defaultUrlBase;
+    /**
+     * Create a new Route Resolver
+     *
+     * @param clientOrConfig    The Optimizely Graph client or configuration to
+     *                          use. If omitted, the paramterless factory method
+     *                          used to create a new instance.
+     * @param urlBase           The value for the base parameter of the URL
+     *                          constructor when reading routes from Optimizely
+     *                          Graph
+     */
+    constructor(clientOrConfig?: IOptiGraphClient | OptimizelyGraphConfig, urlBase?: string | URL);
+    /**
+     * Retrieve all registered routes for the provided domain - all domains if none specified
+     *
+     * @param       domain      The domain to filter on
+     * @returns     The list of routes
+     */
+    getRoutes(domain?: string): Promise<Route[]>;
+    /**
+     * Resolve a path to route information, either from string or from URL
+     * object.
+     *
+     * @param       path        The path to resolve for
+     * @param       domain      The domain to filter the results by
+     * @returns     The route information for the path
+     */
+    getContentInfoByPath(path: URL): Promise<undefined | Route>;
+    getContentInfoByPath(path: string, domain?: string): Promise<undefined | Route>;
+    getContentInfoById(key: string, locale?: string, version?: string | number): Promise<undefined | Route>;
+    /**
+     * Extract a content link from a route definition
+     *
+     * @param       route   The route to parse
+     * @returns     The ContentLink, with locale information
+     */
+    routeToContentLink(route: Route): ContentLinkWithLocale;
+    protected convertResponse(item: GetAllRoutes.Route): Route;
+    protected tryConvertResponse(item: GetAllRoutes.Route): Route | undefined;
+    protected isNotNullOrUndefined<T>(input: T | null | undefined): input is T;
+}
+export default RouteResolver;

package/dist/services/routing/resolver.js

@@ -0,0 +1,133 @@
+// Import GraphQL Client
+import createClient, { isContentGraphClient } from '../../client/index.js';
+// Import GraphQL Queries
+import * as GetRouteById from './queries/getRouteById.js';
+import * as GetAllRoutes from './queries/getAllRoutes.js';
+import * as GetRouteByPath from './queries/getRouteByPath.js';
+// Main router class
+/**
+ *
+ */
+export class RouteResolver {
+    /**
+     * Create a new Route Resolver
+     *
+     * @param clientOrConfig    The Optimizely Graph client or configuration to
+     *                          use. If omitted, the paramterless factory method
+     *                          used to create a new instance.
+     * @param urlBase           The value for the base parameter of the URL
+     *                          constructor when reading routes from Optimizely
+     *                          Graph
+     */
+    constructor(clientOrConfig, urlBase = "https://example.com") {
+        this._cgClient = isContentGraphClient(clientOrConfig) ? clientOrConfig : createClient(clientOrConfig);
+        this._defaultUrlBase = urlBase;
+    }
+    /**
+     * Retrieve all registered routes for the provided domain - all domains if none specified
+     *
+     * @param       domain      The domain to filter on
+     * @returns     The list of routes
+     */
+    async getRoutes(domain) {
+        this._cgClient.updateFlags({ queryCache: false }, true);
+        let page = await this._cgClient.request(GetAllRoutes.query, { domain }).catch(e => {
+            if (this._cgClient.debug)
+                console.error("[RouteResolver] Error while fetching routes", e);
+            return undefined;
+        });
+        let results = page?.Content?.items ?? [];
+        const totalCount = page?.Content?.total ?? 0;
+        const cursor = page?.Content?.cursor ?? '';
+        if (totalCount > 0 && cursor !== '' && totalCount > results.length)
+            while ((page?.Content?.items?.length ?? 0) > 0 && results.length < totalCount) {
+                page = await this._cgClient.request({
+                    document: GetAllRoutes.query,
+                    variables: {
+                        cursor,
+                        domain
+                    }
+                });
+                results = results.concat(page.Content?.items ?? []);
+            }
+        this._cgClient.restoreFlags();
+        return results.map(this.tryConvertResponse.bind(this)).filter(this.isNotNullOrUndefined);
+    }
+    async getContentInfoByPath(path, domain) {
+        const queryPath = typeof path == 'object' && path != null ? path.pathname : path;
+        const queryDomain = typeof path == 'object' && path != null ? path.protocol + '//' + path.host : domain;
+        if (this._cgClient.debug)
+            console.log(`⚪ [RouteResolver] Resolving content info for ${path} on ${domain ? domain : "all domains"}`);
+        const resultSet = await this._cgClient.request({
+            document: GetRouteByPath.query,
+            variables: { path: queryPath, domain: queryDomain }
+        });
+        if ((resultSet.Content?.items?.length ?? 0) === 0) {
+            if (this._cgClient.debug)
+                console.warn("🟠 [RouteResolver] No items in the resultset");
+            return undefined;
+        }
+        if ((resultSet.Content?.items?.length ?? 0) > 1)
+            throw new Error("🔴 [RouteResolver] Ambiguous URL provided, did you omit the domain in a multi-site setup?");
+        if (this._cgClient.debug)
+            console.log(`⚪ [RouteResolver] Resolved content info for ${path} to: ${JSON.stringify(resultSet.Content.items[0])}`);
+        return this.convertResponse(resultSet.Content.items[0]);
+    }
+    async getContentInfoById(key, locale, version) {
+        const variables = { key, version: version?.toString(), locale: locale?.replaceAll('-', '_') };
+        if (this._cgClient.debug)
+            console.log("Resolving content by id:", JSON.stringify(variables));
+        const resultSet = await this._cgClient.request({
+            document: GetRouteById.query,
+            variables
+        });
+        if (resultSet.Content?.total >= 1) {
+            if (this._cgClient.debug && resultSet.Content?.total > 1)
+                console.warn(`Received multiple entries with this ID, returning the first one from: ${(resultSet.Content?.items || []).map(x => { return `${x._metadata.key} (version: ${x._metadata.version}, locale: ${x._metadata.locale})`; }).join('; ')}`);
+            return this.convertResponse(resultSet.Content.items[0]);
+        }
+        return undefined;
+    }
+    /**
+     * Extract a content link from a route definition
+     *
+     * @param       route   The route to parse
+     * @returns     The ContentLink, with locale information
+     */
+    routeToContentLink(route) {
+        return {
+            key: route.key,
+            version: route.version,
+            locale: route.locale
+        };
+    }
+    convertResponse(item) {
+        if (!item)
+            throw new Error("RouteResolver.convertResponse(): mandatory parameter \"item\" not provided!");
+        const itemUrl = new URL(item._metadata?.url?.path ?? '/', item._metadata?.url?.domain ?? this._defaultUrlBase);
+        return {
+            locale: item._metadata.locale,
+            path: item._metadata.url.path,
+            url: itemUrl,
+            slug: item._metadata?.slug ?? "",
+            changed: item.changed ? new Date(item.changed) : null,
+            contentType: item._metadata.types,
+            version: item._metadata.version,
+            key: item._metadata.key
+        };
+    }
+    tryConvertResponse(item) {
+        try {
+            return this.convertResponse(item);
+        }
+        catch (e) {
+            console.error(`Unable to convert ${JSON.stringify(item)} to Route`, e);
+            return undefined;
+        }
+    }
+    isNotNullOrUndefined(input) {
+        return input != null && input != undefined;
+    }
+}
+export default RouteResolver;
+//# sourceMappingURL=resolver.js.map

package/dist/services/routing/resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolver.js","sourceRoot":"","sources":["../../../src/services/routing/resolver.ts"],"names":[],"mappings":"AAAA,wBAAwB;AACxB,OAAO,YAAY,EAAE,EAAyB,oBAAoB,EAAE,MAAM,uBAAuB,CAAA;AAOjG,yBAAyB;AACzB,OAAO,KAAK,YAAY,MAAM,2BAA2B,CAAA;AACzD,OAAO,KAAK,YAAY,MAAM,2BAA2B,CAAA;AACzD,OAAO,KAAK,cAAc,MAAM,6BAA6B,CAAA;AAE7D,oBAAoB;AACpB;;GAEG;AACH,MAAM,OAAO,aAAa;IAItB;;;;;;;;;OASG;IACH,YAAoB,cAAyD,EAAE,UAAwB,qBAAqB;QAExH,IAAI,CAAC,SAAS,GAAG,oBAAoB,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,YAAY,CAAC,cAAc,CAAC,CAAA;QACrG,IAAI,CAAC,eAAe,GAAG,OAAO,CAAA;IAClC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CAAC,MAAe;QAElC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,IAAI,CAAC,CAAA;QACvD,IAAI,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAA8C,YAAY,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;YAC3H,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK;gBACpB,OAAO,CAAC,KAAK,CAAC,6CAA6C,EAAE,CAAC,CAAC,CAAA;YACnE,OAAO,SAAS,CAAA;QACpB,CAAC,CAAC,CAAA;QACF,IAAI,OAAO,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,EAAE,CAAA;QACxC,MAAM,UAAU,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC,CAAA;QAC5C,MAAM,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,MAAM,IAAI,EAAE,CAAA;QAE1C,IAAI,UAAU,GAAG,CAAC,IAAI,MAAM,KAAK,EAAE,IAAI,UAAU,GAAG,OAAO,CAAC,MAAM;YAC9D,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,UAAU,EAC7E,CAAC;gBACG,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAA8C;oBAC7E,QAAQ,EAAE,YAAY,CAAC,KAAK;oBAC5B,SAAS,EAAE;wBACP,MAAM;wBACN,MAAM;qBACT;iBACJ,CAAC,CAAA;gBACF,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,CAAA;YACvD,CAAC;QAEL,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,CAAA;QAC7B,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;IAC5F,CAAC;IAYM,KAAK,CAAC,oBAAoB,CAAC,IAAkB,EAAE,MAAe;QAEjE,MAAM,SAAS,GAAK,OAAO,IAAI,IAAI,QAAQ,IAAI,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAA;QAClF,MAAM,WAAW,GAAG,OAAO,IAAI,IAAI,QAAQ,IAAI,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAA;QAEvG,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK;YACpB,OAAO,CAAC,GAAG,CAAC,gDAAiD,IAAK,OAAQ,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,CAAA;QAEhH,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAkD;YAC5F,QAAQ,EAAE,cAAc,CAAC,KAAK;YAC9B,SAAS,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE;SACtD,CAAC,CAAA;QAEF,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YAChD,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK;gBACpB,OAAO,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;YACjE,OAAO,SAAS,CAAA;QACpB,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,2FAA2F,CAAC,CAAA;QAEhH,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK;YACpB,OAAO,CAAC,GAAG,CAAC,+CAAgD,IAAK,QAAS,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,EAAE,CAAC,CAAA;QAE5H,OAAO,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IAC3D,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,GAAW,EAAE,MAAe,EAAE,OAAyB;QAEnF,MAAM,SAAS,GAA4B,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,GAAG,EAAC,GAAG,CAAC,EAAE,CAAA;QAErH,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK;YACpB,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAA;QAEtE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAA8C;YACxF,QAAQ,EAAE,YAAY,CAAC,KAAK;YAC5B,SAAS;SACZ,CAAC,CAAA;QAEF,IAAI,SAAS,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;YAChC,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,IAAI,SAAS,CAAC,OAAO,EAAE,KAAK,GAAG,CAAC;gBACpD,OAAO,CAAC,IAAI,CAAC,yEAA0E,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,GAAI,CAAC,CAAC,SAAS,CAAC,GAAI,cAAe,CAAC,CAAC,SAAS,CAAC,OAAQ,aAAc,CAAC,CAAC,SAAS,CAAC,MAAO,GAAG,CAAA,CAAA,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAE,EAAE,CAAC,CAAA;YAC1P,OAAO,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QAC3D,CAAC;QAED,OAAO,SAAS,CAAA;IACpB,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,KAAY;QAElC,OAAO;YACH,GAAG,EAAE,KAAK,CAAC,GAAG;YACd,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,MAAM,EAAE,KAAK,CAAC,MAAM;SACvB,CAAA;IACL,CAAC;IAES,eAAe,CAAC,IAAwB;QAE9C,IAAI,CAAC,IAAI;YACL,MAAM,IAAI,KAAK,CAAC,6EAA6E,CAAC,CAAA;QAClG,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,IAAI,GAAG,EAAE,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,MAAM,IAAI,IAAI,CAAC,eAAe,CAAC,CAAA;QAC9G,OAAO;YACH,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM;YAC7B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI;YAC7B,GAAG,EAAE,OAAO;YACZ,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,IAAI,EAAE;YAChC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI;YACrD,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK;YACjC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO;YAC/B,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG;SAC1B,CAAA;IACL,CAAC;IAES,kBAAkB,CAAC,IAAwB;QAEjD,IAAI,CAAC;YACD,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;QACrC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,OAAO,CAAC,KAAK,CAAC,qBAAsB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAE,WAAW,EAAE,CAAC,CAAC,CAAA;YACxE,OAAO,SAAS,CAAA;QACpB,CAAC;IACL,CAAC;IAES,oBAAoB,CAAI,KAA2B;QAEzD,OAAO,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI,SAAS,CAAA;IAC9C,CAAC;CACJ;AAED,eAAe,aAAa,CAAA"}

package/dist/services/routing/types.d.ts

@@ -1,25 +1,10 @@
-export type ContentLink = {
-    id: number;
-    workId?: number | null;
-    guidValue?: string | null;
-} | {
-    id?: number | null;
-    workId?: number | null;
-    guidValue: string;
-};
-export type ContentLinkWithLocale = ContentLink & {
-    locale?: string;
-};
 export type Route = {
-    language: string;
+    locale: string;
     path: string;
     url: URL;
     slug: string;
     changed: Date | null;
-    published: Date | null;
     contentType: string[];
-    id: number;
-    workId?: number | null;
-    guid: string;
-    siteId: string;
+    version?: string | null;
+    key: string;
 };

package/dist/services/types.d.ts

@@ -0,0 +1,14 @@
+export type ContentLink = {
+    key: string;
+    version?: string | null;
+};
+export type InlineContentLink = {
+    key?: null | undefined;
+    version?: null;
+};
+export type ContentLinkWithLocale<LocaleType = string> = ContentLink & {
+    locale?: LocaleType;
+};
+export type InlineContentLinkWithLocale<LocaleType = string> = InlineContentLink & {
+    locale?: LocaleType;
+};

package/dist/services/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/services/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/services/types.ts"],"names":[],"mappings":""}

package/dist/services/utils.d.ts

@@ -0,0 +1,69 @@
+import type { ContentLink, ContentLinkWithLocale, InlineContentLink, InlineContentLinkWithLocale } from "./types.js";
+/**
+ * Transform a locale code (e.g. en-US) to a Optimizely Graph compatible locale
+ * (e.g. en_US).
+ *
+ * @param       locale          The locale to transform
+ * @returns     The Optimizely Graph safe locale
+ */
+export declare function localeToGraphLocale<T>(locale: T): T extends string ? string : never;
+/**
+ * Tranform an Optimizely Graph locale (e.g. en_US) to an ISO locale (e.g. en-US)
+ *
+ * @param       graphLocale     The locale as supported by Optimizely Graph
+ * @returns     The ISO Locale
+ */
+export declare function graphLocaleToLocale<T>(graphLocale: T): T extends string ? string : never;
+/**
+ * Check if two ContentLinks point to the same content item, if either of the
+ * links set the version or locale, these values must be equal across the ContentLinks
+ *
+ * @param       link1       The first compared link
+ * @param       link2       The second compared link
+ * @returns     True if they links point to the same content item, False otherwise
+ */
+export declare function contentLinkIsEqual(link1: ContentLink | ContentLinkWithLocale, link2: ContentLink | ContentLinkWithLocale): boolean;
+/**
+ * Check if two ContentLinks point to the same content item, if either of the
+ * links set the version or locale, these values must be equal across the ContentLinks
+ *
+ * @param       link1       The first compared link
+ * @param       link2       The second compared link
+ * @returns     True if they links point to the same content item, False otherwise
+ */
+export declare function contentLinkIsEqualIgnoreVersion(link1: ContentLink | ContentLinkWithLocale, link2: ContentLink | ContentLinkWithLocale): boolean;
+/**
+ * Test if the provided value can be understood as a ContentLink
+ *
+ * @param       toTest      The value under test
+ * @returns     True if the object can be understood as a ContentLink, False otherwise
+ */
+export declare function isContentLink(toTest: any): toTest is ContentLink;
+export declare function isContentLinkWithLocale(toTest: any): toTest is ContentLinkWithLocale;
+/**
+ * Test if the variable is an
+ *
+ * @param toTest
+ * @returns
+ */
+export declare function isInlineContentLink(toTest: any): toTest is InlineContentLinkWithLocale;
+type Nullable<T> = {
+    [K in keyof T]?: T[K] | null;
+} | null | undefined;
+/**
+ * Take the normalizable value
+ *
+ * @param toNormalize
+ * @returns
+ */
+export declare function normalizeContentLink(toNormalize: Nullable<ContentLink | InlineContentLink>): ContentLink | InlineContentLink | undefined;
+export declare function normalizeContentLinkWithLocale<LT = string>(toNormalize: Nullable<ContentLinkWithLocale<LT>>): ContentLinkWithLocale<LT> | undefined;
+/**
+ * Create a textual representation of a content link
+ *
+ * @param       contentLink     The (inline) content link to transform to a string
+ * @param       unique          Set to true to ensure that this method returns a string that can be used as key
+ * @returns     The textual representation of the ContentLink
+ */
+export declare function contentLinkToString(contentLink: ContentLink | InlineContentLink | null | undefined, unique?: boolean): string;
+export {};

package/dist/services/utils.js

@@ -0,0 +1,135 @@
+/**
+ * Transform a locale code (e.g. en-US) to a Optimizely Graph compatible locale
+ * (e.g. en_US).
+ *
+ * @param       locale          The locale to transform
+ * @returns     The Optimizely Graph safe locale
+ */
+export function localeToGraphLocale(locale) {
+    if (typeof (locale) != 'string' || (locale.length != 2 && locale.length != 5))
+        throw new Error(`The value ${locale} is not a supported ISO locale`);
+    return locale.replaceAll('-', '_');
+}
+/**
+ * Tranform an Optimizely Graph locale (e.g. en_US) to an ISO locale (e.g. en-US)
+ *
+ * @param       graphLocale     The locale as supported by Optimizely Graph
+ * @returns     The ISO Locale
+ */
+export function graphLocaleToLocale(graphLocale) {
+    if (typeof (graphLocale) != 'string' || (graphLocale.length != 2 && graphLocale.length != 5))
+        throw new Error(`The value ${graphLocale} is not a supported ISO locale`);
+    return graphLocale.replaceAll('_', '-');
+}
+/**
+ * Check if two ContentLinks point to the same content item, if either of the
+ * links set the version or locale, these values must be equal across the ContentLinks
+ *
+ * @param       link1       The first compared link
+ * @param       link2       The second compared link
+ * @returns     True if they links point to the same content item, False otherwise
+ */
+export function contentLinkIsEqual(link1, link2) {
+    if (link1.key != link2.key)
+        return false;
+    if ((link1.version || link2.version) && link1.version != link2.version)
+        return false;
+    if ((link1.locale || link2.locale) && link1.locale != link2.locale)
+        return false;
+    return true;
+}
+/**
+ * Check if two ContentLinks point to the same content item, if either of the
+ * links set the version or locale, these values must be equal across the ContentLinks
+ *
+ * @param       link1       The first compared link
+ * @param       link2       The second compared link
+ * @returns     True if they links point to the same content item, False otherwise
+ */
+export function contentLinkIsEqualIgnoreVersion(link1, link2) {
+    if (link1.key != link2.key)
+        return false;
+    if ((link1.locale || link2.locale) && link1.locale != link2.locale)
+        return false;
+    return true;
+}
+/**
+ * Test if the provided value can be understood as a ContentLink
+ *
+ * @param       toTest      The value under test
+ * @returns     True if the object can be understood as a ContentLink, False otherwise
+ */
+export function isContentLink(toTest) {
+    // It must be an object
+    if (typeof (toTest) != 'object' || toTest == null)
+        return false;
+    // The object must have a key, string, miniumum length 1 char
+    return typeof (toTest.key) == 'string' && toTest.key.length > 0;
+}
+export function isContentLinkWithLocale(toTest) {
+    if (!isContentLink(toTest))
+        return false;
+    const locale = toTest.locale;
+    return locale == undefined || locale == null || (typeof (locale) == 'string' && locale.length >= 2 && locale.length <= 5);
+}
+/**
+ * Test if the variable is an
+ *
+ * @param toTest
+ * @returns
+ */
+export function isInlineContentLink(toTest) {
+    if (typeof toTest != 'object' || toTest == null)
+        return false;
+    return toTest.key == null &&
+        (toTest.version == null || toTest.version == undefined) &&
+        (typeof toTest.locale == 'string' || toTest.locale == null || toTest.locale == undefined);
+}
+/**
+ * Take the normalizable value
+ *
+ * @param toNormalize
+ * @returns
+ */
+export function normalizeContentLink(toNormalize) {
+    if (!(isContentLink(toNormalize) || isInlineContentLink(toNormalize)))
+        return undefined;
+    const newLink = {
+        key: toNormalize.key
+    };
+    if (toNormalize.version)
+        newLink.version = toNormalize.version.toString();
+    return toNormalize;
+}
+export function normalizeContentLinkWithLocale(toNormalize) {
+    const normalized = normalizeContentLink(toNormalize);
+    if (toNormalize?.locale != undefined && !(typeof (toNormalize?.locale) == 'string' && (toNormalize.locale.length == 2 || toNormalize.locale.length == 5)))
+        normalized.locale = toNormalize.locale;
+    return normalized;
+}
+function generateUniqueKey(prefix = "inline::") {
+    try {
+        return prefix + crypto.randomUUID().replaceAll('-', '');
+    }
+    catch (e) {
+        console.warn("💥 Crypto library unavailable, expect key collisions");
+        return prefix + 'default';
+    }
+}
+/**
+ * Create a textual representation of a content link
+ *
+ * @param       contentLink     The (inline) content link to transform to a string
+ * @param       unique          Set to true to ensure that this method returns a string that can be used as key
+ * @returns     The textual representation of the ContentLink
+ */
+export function contentLinkToString(contentLink, unique = false) {
+    if (!contentLink)
+        return unique ? generateUniqueKey('no-content::') : '[no content]';
+    return [
+        contentLink.key == null ? (unique ? generateUniqueKey() : "[inline content]") : contentLink.key,
+        contentLink.version,
+        contentLink.locale
+    ].filter(x => x).join('::');
+}
+//# sourceMappingURL=utils.js.map

package/dist/services/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/services/utils.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAI,MAAS;IAE5C,IAAI,OAAM,CAAC,MAAM,CAAC,IAAI,QAAQ,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC;QACxE,MAAM,IAAI,KAAK,CAAC,aAAc,MAAO,gCAAgC,CAAC,CAAA;IAC1E,OAAO,MAAM,CAAC,UAAU,CAAC,GAAG,EAAC,GAAG,CAAsC,CAAA;AAC1E,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAI,WAAc;IAEjD,IAAI,OAAM,CAAC,WAAW,CAAC,IAAI,QAAQ,IAAI,CAAC,WAAW,CAAC,MAAM,IAAI,CAAC,IAAI,WAAW,CAAC,MAAM,IAAI,CAAC,CAAC;QACvF,MAAM,IAAI,KAAK,CAAC,aAAc,WAAY,gCAAgC,CAAC,CAAA;IAC/E,OAAO,WAAW,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAsC,CAAA;AAChF,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAA0C,EAAE,KAA0C;IAErH,IAAI,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,GAAG;QACtB,OAAO,KAAK,CAAA;IAChB,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO;QAClE,OAAO,KAAK,CAAA;IAChB,IAAI,CAAE,KAA+B,CAAC,MAAM,IAAK,KAA+B,CAAC,MAAM,CAAC,IAAK,KAA+B,CAAC,MAAM,IAAK,KAA+B,CAAC,MAAM;QAC1K,OAAO,KAAK,CAAA;IAChB,OAAO,IAAI,CAAA;AACf,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,+BAA+B,CAAC,KAA0C,EAAE,KAA0C;IAElI,IAAI,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,GAAG;QACtB,OAAO,KAAK,CAAA;IAChB,IAAI,CAAE,KAA+B,CAAC,MAAM,IAAK,KAA+B,CAAC,MAAM,CAAC,IAAK,KAA+B,CAAC,MAAM,IAAK,KAA+B,CAAC,MAAM;QAC1K,OAAO,KAAK,CAAA;IAChB,OAAO,IAAI,CAAA;AACf,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,MAAW;IAErC,uBAAuB;IACvB,IAAI,OAAM,CAAC,MAAM,CAAC,IAAI,QAAQ,IAAI,MAAM,IAAI,IAAI;QAC5C,OAAO,KAAK,CAAA;IAEhB,6DAA6D;IAC7D,OAAO,OAAM,CAAE,MAAsB,CAAC,GAAG,CAAC,IAAI,QAAQ,IAAM,MAAsB,CAAC,GAAc,CAAC,MAAM,GAAG,CAAC,CAAA;AAChH,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,MAAW;IAE/C,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC;QACtB,OAAO,KAAK,CAAA;IAEhB,MAAM,MAAM,GAAI,MAAgC,CAAC,MAAM,CAAA;IACvD,OAAO,MAAM,IAAI,SAAS,IAAI,MAAM,IAAI,IAAI,IAAI,CAAC,OAAM,CAAC,MAAM,CAAC,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC,CAAA;AAC5H,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAW;IAE3C,IAAI,OAAO,MAAM,IAAI,QAAQ,IAAI,MAAM,IAAI,IAAI;QAC3C,OAAO,KAAK,CAAA;IAEhB,OAAQ,MAAsC,CAAC,GAAG,IAAI,IAAI;QACtD,CAAE,MAAsC,CAAC,OAAO,IAAI,IAAI,IAAK,MAAsC,CAAC,OAAO,IAAI,SAAS,CAAC;QACzH,CAAC,OAAQ,MAAsC,CAAC,MAAM,IAAI,QAAQ,IAAK,MAAsC,CAAC,MAAM,IAAI,IAAI,IAAK,MAAsC,CAAC,MAAM,IAAI,SAAS,CAAC,CAAA;AACpM,CAAC;AAMD;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,WAAsD;IAEvF,IAAI,CAAC,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,mBAAmB,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,SAAS,CAAA;IAEpB,MAAM,OAAO,GAAqC;QAC9C,GAAG,EAAE,WAAW,CAAC,GAAG;KACvB,CAAA;IACD,IAAI,WAAW,CAAC,OAAO;QACnB,OAAO,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAA;IAEpD,OAAO,WAAW,CAAA;AACtB,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAc,WAAgD;IAExG,MAAM,UAAU,GAAG,oBAAoB,CAAC,WAAW,CAA8B,CAAA;IACjF,IAAI,WAAW,EAAE,MAAM,IAAI,SAAS,IAAI,CAAC,CAAC,OAAM,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,QAAQ,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;QACpJ,UAAU,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAA;IAC1C,OAAO,UAAU,CAAA;AACrB,CAAC;AAED,SAAS,iBAAiB,CAAC,SAAiB,UAAU;IAElD,IAAI,CAAC;QACD,OAAO,MAAM,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC,UAAU,CAAC,GAAG,EAAC,EAAE,CAAC,CAAA;IAC1D,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,OAAO,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAA;QACpE,OAAO,MAAM,GAAG,SAAS,CAAA;IAC7B,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,WAA+D,EAAE,SAAkB,KAAK;IAExH,IAAI,CAAC,WAAW;QACZ,OAAO,MAAM,CAAC,CAAC,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,cAAc,CAAA;IACtE,OAAO;QACH,WAAW,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG;QAC/F,WAAW,CAAC,OAAO;QAClB,WAAqC,CAAC,MAAM;KAChD,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AAC/B,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@remkoj/optimizely-graph-client",
   "license": "Apache-2.0",
-  "version": "1.0.4",
+  "version": "2.0.0-pre2",
   "packageManager": "yarn@4.1.1",
   "repository": "https://github.com/remkoj/optimizely-dxp-clients.git",
   "author": "Remko Jantzen <693172+remkoj@users.noreply.github.com>",
@@ -19,7 +19,8 @@
     "./router": "./dist/services/routing/index.js",
     "./channels": "./dist/services/channel-repository/index.js",
     "./admin": "./dist/admin-api/index.js",
-    "./codegen": "./dist/codegen.js"
+    "./codegen": "./dist/codegen.js",
+    "./utils": "./dist/services/utils.js"
   },
   "typesVersions": {
     "*": {
@@ -43,18 +44,21 @@
       ],
       "codegen": [
         "dist/codegen.d.ts"
+      ],
+      "utils": [
+        "./dist/services/utils.d.ts"
       ]
     }
   },
   "devDependencies": {
     "@types/crypto-js": "^4.2.2",
-    "@types/node": "^20.12.6",
+    "@types/node": "^20.12.10",
     "graphql": "^16.8.1",
     "graphql-request": "^6.1.0",
     "openapi-typescript-codegen": "^0.29.0",
     "prop-types": "^15.8.1",
-    "scheduler": "^0.23.0",
-    "typescript": "^5.4.4"
+    "scheduler": "^0.23.2",
+    "typescript": "^5.4.5"
   },
   "dependencies": {
     "crypto-js": "^4.2.0"
@@ -65,9 +69,10 @@
   "scripts": {
     "clean": "tsc --build --clean",
     "compile-ts": "tsc --build",
-    "prepare": "openapi --input https://cg.optimizely.com/app/swagger/swagger.json --output ./src/admin-api/client --name OptimizelyGraphAdminApi && node ./build/update-imports.cjs && tsc --build",
-    "watch": "tsc --watch",
+    "prepare": "yarn generate-admin && tsc --build",
+    "watch": "yarn tsc --watch",
     "recompile": "tsc --build --clean && tsc --build --force",
     "generate-admin": "openapi --input https://cg.optimizely.com/app/swagger/swagger.json --output ./src/admin-api/client --name OptimizelyGraphAdminApi && node ./build/update-imports.cjs"
-  }
+  },
+  "stableVersion": "1.0.4"
 }