@remkoj/optimizely-graph-client 1.0.1

package/dist/client/index.d.ts

@@ -0,0 +1,4 @@
+export { createClient as default, createClient, ContentGraphClient } from './client.js';
+export { createHmacFetch } from './hmac-fetch.js';
+export { isContentGraphClient } from './utils.js';
+export { AuthMode, type IOptiGraphClient, type ClientFactory } from './types.js';

package/dist/client/index.js

@@ -0,0 +1,5 @@
+export { createClient as default, createClient, ContentGraphClient } from './client.js';
+export { createHmacFetch } from './hmac-fetch.js';
+export { isContentGraphClient } from './utils.js';
+export { AuthMode } from './types.js';
+//# sourceMappingURL=index.js.map

package/dist/client/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,IAAI,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACvF,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AACjD,OAAO,EAAE,QAAQ,EAA6C,MAAM,YAAY,CAAA"}

package/dist/client/types.d.ts

@@ -0,0 +1,67 @@
+import type { GraphQLClient } from "graphql-request";
+export type RequestMethod = InstanceType<typeof GraphQLClient>['request'];
+export type ClientInstanceType = InstanceType<typeof GraphQLClient>;
+export type QueryParams = {
+    query: Parameters<RequestMethod>[0]['document'];
+    variables: Parameters<RequestMethod>[0]['variables'];
+};
+export declare enum AuthMode {
+    Public = "epi-single",
+    Basic = "use-basic",
+    HMAC = "use-hmac",
+    Token = "use-token"
+}
+export type OptiGraphSiteInfo = {
+    frontendDomain?: string;
+    cmsURL?: string;
+};
+export type IOptiGraphClientFlags = {
+    queryCache: boolean;
+    recursive: boolean;
+    cache: boolean;
+};
+export interface IOptiGraphClient extends ClientInstanceType {
+    /**
+     * Retrieve the debug indicator, as configured for this client
+     */
+    readonly debug: boolean;
+    /**
+     * Retrieve basic information about the configured frontend
+     */
+    readonly siteInfo: OptiGraphSiteInfo;
+    /**
+     * Retrieve the current authentication mode
+     */
+    readonly currentAuthMode: AuthMode;
+    /**
+     * Update the authentication data for this client.
+     * - Set to AuthMode.HMAC or AuthMode.Basic to use that authentication scheme, this requires the AppKey and Secret to be part of the configuration
+     * - Set to the actual token to be used to switch to AuthMode.Token
+     * - Set to undefined or AuthMode.Public to switch to public, read-only mode. (i.e. using the SingleKey)
+     *
+     * @param       tokenOrAuthmode     The authentication mode/token to be used
+     * @returns     The client itself
+     */
+    updateAuthentication(tokenOrAuthmode?: string | AuthMode | undefined): IOptiGraphClient;
+    /**
+     * Convenience method, for those who are more used to the API of ApolloClient
+     *
+     * @deprecated  Use the "request" method instead
+     */
+    query: RequestMethod;
+    /**
+     * Set the client controllable service configuration
+     *
+     * @param   newFlags      The configuration values to override
+     * @param   temporary     Set to true to store the old configuration, please note that you cannot invoke this method again untill the configuration has been restored first
+     * @returns Itself, so you chain it in a request
+     */
+    updateFlags(newFlags: Partial<IOptiGraphClientFlags>, temporary?: boolean): IOptiGraphClient;
+    /**
+     * Restore client controllable service configuration, after it has been saved by a temporary update. If there's nothing to restore this method will do nothing
+     *
+     * @returns Itself, so you chain it in a request
+     */
+    restoreFlags(): IOptiGraphClient;
+}
+export type ClientFactory = (token?: string) => IOptiGraphClient;

package/dist/client/types.js

@@ -0,0 +1,8 @@
+export var AuthMode;
+(function (AuthMode) {
+    AuthMode["Public"] = "epi-single";
+    AuthMode["Basic"] = "use-basic";
+    AuthMode["HMAC"] = "use-hmac";
+    AuthMode["Token"] = "use-token";
+})(AuthMode || (AuthMode = {}));
+//# sourceMappingURL=types.js.map

package/dist/client/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/client/types.ts"],"names":[],"mappings":"AAUA,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IAChB,iCAAqB,CAAA;IACrB,+BAAmB,CAAA;IACnB,6BAAiB,CAAA;IACjB,+BAAmB,CAAA;AACvB,CAAC,EALW,QAAQ,KAAR,QAAQ,QAKnB"}

package/dist/client/utils.d.ts

@@ -0,0 +1,6 @@
+import { AuthMode, type IOptiGraphClient } from "./types.js";
+export declare function validateToken(newToken?: string): boolean;
+export declare function getAuthMode(token?: string): AuthMode;
+export declare function base64encode(binaryString: string): string;
+export declare function isError(toTest: any): toTest is Error;
+export declare function isContentGraphClient(client: any): client is IOptiGraphClient;

package/dist/client/utils.js

@@ -0,0 +1,32 @@
+import { AuthMode } from "./types.js";
+const TOKEN_MIN_LENGTH = 16;
+export function validateToken(newToken) {
+    return newToken == undefined || newToken == AuthMode.HMAC || newToken == AuthMode.Basic || newToken.length > TOKEN_MIN_LENGTH;
+}
+export function getAuthMode(token) {
+    switch (token) {
+        case AuthMode.HMAC:
+            return AuthMode.HMAC;
+        case AuthMode.Basic:
+            return AuthMode.Basic;
+        default:
+            if (typeof (token) == 'string' && token.length > TOKEN_MIN_LENGTH)
+                return AuthMode.Token;
+            return AuthMode.Public;
+    }
+}
+export function base64encode(binaryString) {
+    if (Buffer)
+        return Buffer.from(binaryString).toString('base64');
+    return btoa(binaryString);
+}
+export function isError(toTest) {
+    return typeof (toTest) == 'object' && toTest != null && typeof toTest.name == 'string' && typeof toTest.message == 'string';
+}
+export function isContentGraphClient(client) {
+    if (typeof (client) != 'object' || client == null)
+        return false;
+    return typeof client.updateAuthentication == 'function'
+        && typeof client.request == 'function';
+}
+//# sourceMappingURL=utils.js.map

package/dist/client/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/client/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAyB,MAAM,YAAY,CAAA;AAE5D,MAAM,gBAAgB,GAAG,EAAE,CAAA;AAE3B,MAAM,UAAU,aAAa,CAAC,QAAkB;IAE5C,OAAO,QAAQ,IAAI,SAAS,IAAI,QAAQ,IAAI,QAAQ,CAAC,IAAI,IAAK,QAAQ,IAAI,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,MAAM,GAAG,gBAAgB,CAAA;AAClI,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,KAAc;IAEtC,QAAO,KAAK,EACZ,CAAC;QACG,KAAK,QAAQ,CAAC,IAAI;YACd,OAAO,QAAQ,CAAC,IAAI,CAAA;QACxB,KAAK,QAAQ,CAAC,KAAK;YACf,OAAO,QAAQ,CAAC,KAAK,CAAA;QACzB;YACI,IAAI,OAAM,CAAC,KAAK,CAAC,IAAI,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,gBAAgB;gBAC5D,OAAO,QAAQ,CAAC,KAAK,CAAA;YACzB,OAAO,QAAQ,CAAC,MAAM,CAAA;IAC9B,CAAC;AACL,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,YAAoB;IAC7C,IAAI,MAAM;QACN,OAAO,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;IACvD,OAAO,IAAI,CAAC,YAAY,CAAC,CAAA;AAC7B,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,MAAW;IAC/B,OAAO,OAAM,CAAC,MAAM,CAAC,IAAI,QAAQ,IAAI,MAAM,IAAI,IAAI,IAAI,OAAO,MAAgB,CAAC,IAAI,IAAI,QAAQ,IAAI,OAAO,MAAgB,CAAC,OAAO,IAAI,QAAQ,CAAA;AAClJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,MAAW;IAE5C,IAAI,OAAM,CAAC,MAAM,CAAC,IAAI,QAAQ,IAAI,MAAM,IAAI,IAAI;QAC5C,OAAO,KAAK,CAAA;IAChB,OAAO,OAAO,MAA2B,CAAC,oBAAoB,IAAI,UAAU;WACrE,OAAO,MAA2B,CAAC,OAAO,IAAI,UAAU,CAAA;AACnE,CAAC"}

package/dist/codegen.d.ts

@@ -0,0 +1,10 @@
+import { type OptimizelyGraphConfig } from './config.js';
+export declare function getGraphQLCodegenSchema(config?: OptimizelyGraphConfig): SchemaInfo;
+export type SchemaInfo = {
+    [schemaUri: string]: {
+        headers?: {
+            [headerName: string]: string;
+        };
+    };
+};
+export default getGraphQLCodegenSchema;

package/dist/codegen.js

@@ -0,0 +1,18 @@
+import { readEnvironmentVariables, applyConfigDefaults, validateConfig } from './config.js';
+export function getGraphQLCodegenSchema(config) {
+    const graphConfig = applyConfigDefaults(config ?? readEnvironmentVariables());
+    if (!validateConfig(graphConfig, true))
+        throw new Error("Invalid Optimizely Graph configuration");
+    // Create connection information for Optimizely Graph
+    const cgGateway = `${graphConfig.gateway}/content/v2?cache=false`;
+    const schemaInfo = {};
+    schemaInfo[cgGateway] = {
+        headers: {
+            Authorization: `epi-single ${graphConfig.single_key}`,
+            "X-Client": "@RemkoJ/OptimizelyGraphClient"
+        }
+    };
+    return schemaInfo;
+}
+export default getGraphQLCodegenSchema;
+//# sourceMappingURL=codegen.js.map

package/dist/codegen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codegen.js","sourceRoot":"","sources":["../src/codegen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,cAAc,EAA8B,MAAM,aAAa,CAAA;AAEvH,MAAM,UAAU,uBAAuB,CAAC,MAA8B;IAElE,MAAM,WAAW,GAAG,mBAAmB,CAAC,MAAM,IAAI,wBAAwB,EAAE,CAAC,CAAA;IAC7E,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,IAAI,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;IAE7D,qDAAqD;IACrD,MAAM,SAAS,GAAG,GAAI,WAAW,CAAC,OAAQ,yBAAyB,CAAA;IACnE,MAAM,UAAU,GAAgB,EAAE,CAAA;IAClC,UAAU,CAAC,SAAS,CAAC,GAAG;QACpB,OAAO,EAAE;YACL,aAAa,EAAE,cAAe,WAAW,CAAC,UAAW,EAAE;YACvD,UAAU,EAAE,+BAA+B;SAC9C;KACJ,CAAA;IACD,OAAO,UAAU,CAAA;AACrB,CAAC;AAUD,eAAe,uBAAuB,CAAA"}

package/dist/config.d.ts

@@ -0,0 +1,12 @@
+import type * as Types from './types.js';
+export type { ContentGraphConfig, OptimizelyGraphConfigInternal, OptimizelyGraphConfig } from './types.js';
+export declare function readEnvironmentVariables(): Types.OptimizelyGraphConfig;
+export declare function applyConfigDefaults(configuredValues: Types.OptimizelyGraphConfig): Types.OptimizelyGraphConfigInternal;
+/**
+ * Validate the configuration
+ *
+ * @param toValidate The configuration object
+ * @param forPublishedOnly Whether to only validate for published content access
+ * @returns
+ */
+export declare function validateConfig(toValidate: Types.OptimizelyGraphConfig, forPublishedOnly?: boolean, throwError?: boolean): toValidate is Types.OptimizelyGraphConfigInternal;

package/dist/config.js

@@ -0,0 +1,97 @@
+export function readEnvironmentVariables() {
+    const config = {
+        secret: getOptional('OPTIMIZELY_GRAPH_SECRET', () => getOptional('OPTIMIZELY_CONTENTGRAPH_SECRET')),
+        app_key: getOptional('OPTIMIZELY_GRAPH_APP_KEY', () => getOptional('OPTIMIZELY_CONTENTGRAPH_APP_KEY')),
+        single_key: getOptional('OPTIMIZELY_GRAPH_SINGLE_KEY', () => getOptional('OPTIMIZELY_CONTENTGRAPH_SINGLE_KEY', '')),
+        gateway: getOptional('OPTIMIZELY_GRAPH_GATEWAY', () => getOptional('OPTIMIZELY_CONTENTGRAPH_GATEWAY')),
+        deploy_domain: getOptional('SITE_DOMAIN'),
+        dxp_url: getOptional('OPTIMIZELY_CMS_URL', () => getOptional('DXP_URL')),
+        query_log: getBoolean('OPTIMIZELY_GRAPH_QUERY_LOG', () => getBoolean('OPTIMIZELY_CONTENTGRAPH_QUERY_LOG', false)),
+        debug: getBoolean('OPTIMIZELY_DEBUG', () => getBoolean('DXP_DEBUG', false)),
+    };
+    return config;
+}
+export function applyConfigDefaults(configuredValues) {
+    const defaults = {
+        single_key: "",
+        gateway: "https://cg.optimizely.com",
+        dxp_url: "",
+        deploy_domain: "",
+        debug: false,
+        query_log: false,
+    };
+    return {
+        ...defaults,
+        ...configuredValues
+    };
+}
+/**
+ * Validate the configuration
+ *
+ * @param toValidate The configuration object
+ * @param forPublishedOnly Whether to only validate for published content access
+ * @returns
+ */
+export function validateConfig(toValidate, forPublishedOnly = true, throwError = false) {
+    const hasSingleKey = isNonEmptyString(toValidate?.single_key);
+    const hasGateway = isValidUrl(toValidate?.gateway);
+    const hasSecret = forPublishedOnly || isNonEmptyString(toValidate?.secret);
+    const hasAppKey = forPublishedOnly || isNonEmptyString(toValidate?.app_key);
+    if (throwError && !hasSingleKey)
+        throw new Error("Optimizely Graph Configuration does not have a valid Single Key");
+    if (throwError && !hasGateway)
+        throw new Error("Optimizely Graph Configuration does not have a valid Gateway");
+    if (throwError && !hasSecret)
+        throw new Error("Optimizely Graph Configuration does not have a valid Secret");
+    if (throwError && !hasAppKey)
+        throw new Error("Optimizely Graph Configuration does not have a valid App Key");
+    return hasGateway && hasSingleKey && hasAppKey && hasSecret;
+}
+function isNonEmptyString(toTest) {
+    return typeof (toTest) == 'string' && toTest.length > 0;
+}
+function isValidUrl(toTest) {
+    if (!isNonEmptyString(toTest))
+        return false;
+    try {
+        var u = new URL(toTest);
+        if (u.protocol != 'https:')
+            return false;
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+function getBoolean(envVarName, defaultValue = false) {
+    const currentValue = getOptional(envVarName);
+    if (!currentValue) {
+        if (typeof (defaultValue) == 'function')
+            return defaultValue();
+        return defaultValue;
+    }
+    return currentValue == '1' || currentValue.toLowerCase() == 'true';
+}
+function getMandatory(envVarName) {
+    let value = undefined;
+    try {
+        value = process.env[envVarName];
+    }
+    catch (e) {
+        // Ignore on purpose
+    }
+    if (value == null || value == undefined || value.trim() == "")
+        throw new Error(`The environment variable ${envVarName} is required, but not set`);
+    return value.trim();
+}
+function getOptional(envVarName, defaultValue) {
+    try {
+        return getMandatory(envVarName);
+    }
+    catch (e) {
+        if (typeof (defaultValue) == 'function')
+            return defaultValue();
+        return defaultValue;
+    }
+}
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,wBAAwB;IAEpC,MAAM,MAAM,GAAiC;QACzC,MAAM,EAAE,WAAW,CAAC,yBAAyB,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAAC;QACnG,OAAO,EAAE,WAAW,CAAC,0BAA0B,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,iCAAiC,CAAC,CAAC;QACtG,UAAU,EAAE,WAAW,CAAC,6BAA6B,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,oCAAoC,EAAE,EAAE,CAAC,CAAW;QAC7H,OAAO,EAAE,WAAW,CAAC,0BAA0B,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,iCAAiC,CAAC,CAAC;QACtG,aAAa,EAAE,WAAW,CAAC,aAAa,CAAC;QACzC,OAAO,EAAE,WAAW,CAAC,oBAAoB,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QACxE,SAAS,EAAE,UAAU,CAAC,4BAA4B,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,mCAAmC,EAAE,KAAK,CAAC,CAAC;QACjH,KAAK,EAAE,UAAU,CAAC,kBAAkB,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;KAC9E,CAAA;IACD,OAAO,MAAM,CAAA;AACjB,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,gBAA6C;IAE7E,MAAM,QAAQ,GAAyC;QACnD,UAAU,EAAE,EAAE;QACd,OAAO,EAAE,2BAA2B;QACpC,OAAO,EAAE,EAAE;QACX,aAAa,EAAE,EAAE;QACjB,KAAK,EAAE,KAAK;QACZ,SAAS,EAAE,KAAK;KACnB,CAAA;IACD,OAAO;QACH,GAAG,QAAQ;QACX,GAAG,gBAAgB;KACtB,CAAA;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAC,UAAuC,EAAE,mBAA4B,IAAI,EAAE,aAAsB,KAAK;IAEjI,MAAM,YAAY,GAAG,gBAAgB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAA;IAC7D,MAAM,UAAU,GAAG,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;IAClD,MAAM,SAAS,GAAG,gBAAgB,IAAI,gBAAgB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;IAC1E,MAAM,SAAS,GAAG,gBAAgB,IAAI,gBAAgB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;IAE3E,IAAI,UAAU,IAAI,CAAC,YAAY;QAC3B,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAA;IACtF,IAAI,UAAU,IAAI,CAAC,UAAU;QACzB,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAA;IACnF,IAAI,UAAU,IAAI,CAAC,SAAS;QACxB,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAA;IAClF,IAAI,UAAU,IAAI,CAAC,SAAS;QACxB,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAA;IACnF,OAAO,UAAU,IAAI,YAAY,IAAI,SAAS,IAAI,SAAS,CAAA;AAC/D,CAAC;AAED,SAAS,gBAAgB,CAAC,MAAW;IAEjC,OAAO,OAAM,CAAC,MAAM,CAAC,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,CAAA;AAC1D,CAAC;AAED,SAAS,UAAU,CAAC,MAAW;IAE3B,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;QACzB,OAAO,KAAK,CAAA;IAChB,IAAI,CAAC;QACD,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAA;QACvB,IAAI,CAAC,CAAC,QAAQ,IAAI,QAAQ;YACtB,OAAO,KAAK,CAAA;QAChB,OAAO,IAAI,CAAA;IACf,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAA;IAChB,CAAC;AACL,CAAC;AAED,SAAS,UAAU,CAAC,UAAkB,EAAE,eAA0C,KAAK;IAEnF,MAAM,YAAY,GAAG,WAAW,CAAC,UAAU,CAAC,CAAA;IAC5C,IAAI,CAAC,YAAY,EAAE,CAAC;QAChB,IAAI,OAAM,CAAC,YAAY,CAAC,IAAI,UAAU;YAClC,OAAO,YAAY,EAAE,CAAA;QACzB,OAAO,YAAY,CAAA;IACvB,CAAC;IACD,OAAO,YAAY,IAAI,GAAG,IAAI,YAAY,CAAC,WAAW,EAAE,IAAI,MAAM,CAAA;AACtE,CAAC;AAED,SAAS,YAAY,CAAC,UAAkB;IAEpC,IAAI,KAAK,GAAwB,SAAS,CAAA;IAC1C,IAAI,CAAC;QACD,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;IACnC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,oBAAoB;IACxB,CAAC;IACD,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI,SAAS,IAAI,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE;QACzD,MAAM,IAAI,KAAK,CAAC,4BAA6B,UAAW,2BAA2B,CAAC,CAAA;IAExF,OAAO,KAAK,CAAC,IAAI,EAAE,CAAA;AACvB,CAAC;AAED,SAAS,WAAW,CAAC,UAAkB,EAAE,YAA8D;IAEnG,IAAI,CAAC;QACD,OAAO,YAAY,CAAC,UAAU,CAAC,CAAA;IACnC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,IAAI,OAAM,CAAC,YAAY,CAAC,IAAI,UAAU;YAClC,OAAO,YAAY,EAAE,CAAA;QACzB,OAAO,YAAY,CAAA;IACvB,CAAC;AACL,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './client/index.js';
+export { createClient as default } from './client/index.js';
+export * from './config.js';
+export * as Services from './services/index.js';
+export * from './services/index.js';

package/dist/index.js

@@ -0,0 +1,9 @@
+// GraphQL Client
+export * from './client/index.js';
+export { createClient as default } from './client/index.js';
+// Configuration 
+export * from './config.js';
+// Router & Channels
+export * as Services from './services/index.js';
+export * from './services/index.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,iBAAiB;AACjB,cAAc,mBAAmB,CAAA;AACjC,OAAO,EAAE,YAAY,IAAI,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAE3D,iBAAiB;AACjB,cAAc,aAAa,CAAA;AAE3B,oBAAoB;AACpB,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAA;AAC/C,cAAc,qBAAqB,CAAA"}

package/dist/services/channel-repository/definition.d.ts

@@ -0,0 +1,86 @@
+import type { ChannelDefinitionData, ChannelContent, ChannelDomain, ChannelLocale } from './types.js';
+export declare class ChannelDefinition implements Readonly<ChannelDefinitionData> {
+    readonly id: string;
+    readonly name: string;
+    readonly domains: ChannelDomain[];
+    readonly locales: ChannelLocale[];
+    readonly content: ChannelContent;
+    get isDev(): boolean;
+    get defaultLocale(): string;
+    get defaultDomain(): string;
+    protected dxp_url: string;
+    protected get editDomain(): string | undefined;
+    constructor(initialData: ChannelDefinitionData, dxp_url: string);
+    getPrimaryDomain(): URL;
+    getEditDomain(): URL;
+    getCmsUrl(): string;
+    /**
+     * Retieve the default locale specification, defined as the locale marked
+     * as "primary" else the first locale of the channel. When the channel
+     * has no locales it returns undefined.
+     *
+     * @returns     The default locale or undefined if the channel has no locales
+     */
+    getDefaultLocale(): ChannelLocale | undefined;
+    /**
+     * Ensure that the locale is part of the current channel configuration, by
+     * taking an ISO Language Code and validating it's part of the channel.
+     * When the language is not part of the channel, this method will respond with
+     * the default ISO Language Code for the channel.
+     *
+     * @param       code    The ISO Language Code to validate
+     * @returns     An ISO Language code that exists on this channel
+     */
+    resolveLocale(code?: string): string;
+    /**
+     * Ensure that the locale is part of the current channel configuration, by
+     * taking an ISO Language Code and validating it's part of the channel. Then
+     * take the slug for that locale.
+     *
+     * When the language is not part of the channel, this method will fall back
+     *
+     * @param       code    The ISO Language Code to validate
+     * @returns     The resolved slug
+     */
+    resolveSlug(code?: string): string;
+    /**
+     * Retrieve a list of all locale slugs configured for this channel
+     *
+     * @returns     The list of slugs
+     */
+    getSlugs(): string[];
+    /**
+     * Resolve the provided slug to an actual ISO locale
+     *
+     * @param       slug        The slug as read from the URL
+     * @returns     The ISO locale, undefined if the slug isn't configured
+     */
+    slugToLocale(slug: string): string | undefined;
+    /**
+     * Resolve the provided slug to a locale as understood by Optimizely
+     * Content Graph
+     *
+     * @param       slug        The slug as read from the URL
+     * @returns     The locale for Content Graph, undefined if the slug
+     *              isn't configured
+     */
+    slugToGraphLocale(slug: string): string | undefined;
+    /**
+     * Resolve the provided ISO locale code to an URL slug
+     *
+     * @param       code        The locale ISO code
+     * @returns     The slug to be used in URLs, undefined if the locale isn't
+     *              configured
+     */
+    localeToSlug(code: string): string | undefined;
+    /**
+     * Resolve the provided locale code to a locale as understood by Optimizely
+     * Content Graph
+     *
+     * @param       code        The locale ISO code
+     * @returns     The locale for Content Graph, undefined if the locale isn't
+     *              configured
+     */
+    localeToGraphLocale(code: string): string | undefined;
+}
+export default ChannelDefinition;

package/dist/services/channel-repository/definition.js

@@ -0,0 +1,125 @@
+export class ChannelDefinition {
+    get isDev() {
+        try {
+            return process.env.NODE_ENV == 'development';
+        }
+        catch (e) {
+            return false;
+        }
+    }
+    get defaultLocale() {
+        return (this.locales.filter(x => x.isDefault)[0] || this.locales[0])?.code ?? "en";
+    }
+    get defaultDomain() {
+        const primaryDomain = this.isDev ? this.domains.filter(x => x.name.includes("localhost"))[0] : this.domains.filter(x => x.isPrimary)[0];
+        return primaryDomain?.name ?? "localhost:3000";
+    }
+    get editDomain() {
+        const editDomain = this.domains.filter(x => x.isEdit)[0];
+        return editDomain?.name;
+    }
+    constructor(initialData, dxp_url) {
+        this.id = initialData.id;
+        this.name = initialData.name;
+        this.domains = initialData.domains;
+        this.locales = initialData.locales;
+        this.content = initialData.content;
+        this.dxp_url = dxp_url;
+    }
+    getPrimaryDomain() {
+        return new URL(`${this.isDev ? 'http' : 'https'}://${this.defaultDomain}/`);
+    }
+    getEditDomain() {
+        const edit = this.editDomain;
+        return edit ? new URL(`https://${edit}/`) : new URL(this.dxp_url);
+    }
+    getCmsUrl() {
+        return this.dxp_url;
+    }
+    /**
+     * Retieve the default locale specification, defined as the locale marked
+     * as "primary" else the first locale of the channel. When the channel
+     * has no locales it returns undefined.
+     *
+     * @returns     The default locale or undefined if the channel has no locales
+     */
+    getDefaultLocale() {
+        return this.locales.filter(locale => locale.isDefault)[0] || this.locales[0];
+    }
+    /**
+     * Ensure that the locale is part of the current channel configuration, by
+     * taking an ISO Language Code and validating it's part of the channel.
+     * When the language is not part of the channel, this method will respond with
+     * the default ISO Language Code for the channel.
+     *
+     * @param       code    The ISO Language Code to validate
+     * @returns     An ISO Language code that exists on this channel
+     */
+    resolveLocale(code) {
+        return code ? this.locales.filter(locale => locale.code == code)[0]?.code ?? this.defaultLocale : this.defaultLocale;
+    }
+    /**
+     * Ensure that the locale is part of the current channel configuration, by
+     * taking an ISO Language Code and validating it's part of the channel. Then
+     * take the slug for that locale.
+     *
+     * When the language is not part of the channel, this method will fall back
+     *
+     * @param       code    The ISO Language Code to validate
+     * @returns     The resolved slug
+     */
+    resolveSlug(code) {
+        return (this.locales.filter(locale => locale.code == code)[0] ?? this.getDefaultLocale())?.slug ?? "en";
+    }
+    /**
+     * Retrieve a list of all locale slugs configured for this channel
+     *
+     * @returns     The list of slugs
+     */
+    getSlugs() {
+        return this.locales.map(locale => locale.slug);
+    }
+    /**
+     * Resolve the provided slug to an actual ISO locale
+     *
+     * @param       slug        The slug as read from the URL
+     * @returns     The ISO locale, undefined if the slug isn't configured
+     */
+    slugToLocale(slug) {
+        return this.locales.filter(locale => locale.slug == slug)[0]?.code;
+    }
+    /**
+     * Resolve the provided slug to a locale as understood by Optimizely
+     * Content Graph
+     *
+     * @param       slug        The slug as read from the URL
+     * @returns     The locale for Content Graph, undefined if the slug
+     *              isn't configured
+     */
+    slugToGraphLocale(slug) {
+        return this.locales.filter(locale => locale.slug == slug)[0]?.graphLocale;
+    }
+    /**
+     * Resolve the provided ISO locale code to an URL slug
+     *
+     * @param       code        The locale ISO code
+     * @returns     The slug to be used in URLs, undefined if the locale isn't
+     *              configured
+     */
+    localeToSlug(code) {
+        return this.locales.filter(locale => locale.code == code)[0]?.slug;
+    }
+    /**
+     * Resolve the provided locale code to a locale as understood by Optimizely
+     * Content Graph
+     *
+     * @param       code        The locale ISO code
+     * @returns     The locale for Content Graph, undefined if the locale isn't
+     *              configured
+     */
+    localeToGraphLocale(code) {
+        return this.locales.filter(locale => locale.code == code)[0]?.graphLocale;
+    }
+}
+export default ChannelDefinition;
+//# sourceMappingURL=definition.js.map

package/dist/services/channel-repository/definition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definition.js","sourceRoot":"","sources":["../../../src/services/channel-repository/definition.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,iBAAiB;IAO1B,IAAW,KAAK;QAEZ,IAAI,CAAC;YACD,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,aAAa,CAAA;QAChD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,OAAO,KAAK,CAAA;QAChB,CAAC;IACL,CAAC;IAED,IAAW,aAAa;QACpB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,IAAI,CAAA;IACtF,CAAC;IACD,IAAW,aAAa;QACpB,MAAM,aAAa,GAA+B,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;QACnK,OAAO,aAAa,EAAE,IAAI,IAAI,gBAAgB,CAAA;IAClD,CAAC;IAGD,IAAc,UAAU;QACpB,MAAM,UAAU,GAA+B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;QACpF,OAAO,UAAU,EAAE,IAAI,CAAA;IAC3B,CAAC;IAED,YAAmB,WAAkC,EAAE,OAAe;QAClE,IAAI,CAAC,EAAE,GAAG,WAAW,CAAC,EAAE,CAAA;QACxB,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAAA;QAClC,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAAA;QAClC,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAAA;QAClC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IAC1B,CAAC;IAEM,gBAAgB;QAEnB,OAAO,IAAI,GAAG,CAAC,GAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,MAAM,IAAI,CAAC,aAAa,GAAG,CAAC,CAAA;IAChF,CAAC;IAEM,aAAa;QAEhB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAA;QAC5B,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,WAAY,IAAK,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACvE,CAAC;IAEM,SAAS;QAEZ,OAAO,IAAI,CAAC,OAAO,CAAA;IACvB,CAAC;IAED;;;;;;OAMG;IACI,gBAAgB;QAEnB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;IAChF,CAAC;IAED;;;;;;;;OAQG;IACI,aAAa,CAAC,IAAa;QAE9B,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAA;IACxH,CAAC;IAED;;;;;;;;;OASG;IACI,WAAW,CAAC,IAAa;QAE5B,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC,EAAE,IAAI,IAAI,IAAI,CAAA;IAC3G,CAAC;IAED;;;;OAIG;IACI,QAAQ;QAEX,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAClD,CAAC;IAED;;;;;OAKG;IACI,YAAY,CAAC,IAAY;QAE5B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAA;IACtE,CAAC;IAED;;;;;;;OAOG;IACI,iBAAiB,CAAC,IAAY;QAEjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW,CAAA;IAC7E,CAAC;IAED;;;;;;OAMG;IACI,YAAY,CAAC,IAAY;QAE5B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAA;IACtE,CAAC;IAED;;;;;;;OAOG;IACI,mBAAmB,CAAC,IAAY;QAEnC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW,CAAA;IAC7E,CAAC;CACJ;AAED,eAAe,iBAAiB,CAAA"}

package/dist/services/channel-repository/index.d.ts

@@ -0,0 +1,2 @@
+export { ChannelRepository, ChannelRepository as default } from './repository.js';
+export { ChannelDefinition } from './definition.js';

package/dist/services/channel-repository/index.js

@@ -0,0 +1,3 @@
+export { ChannelRepository, ChannelRepository as default } from './repository.js';
+export { ChannelDefinition } from './definition.js';
+//# sourceMappingURL=index.js.map

package/dist/services/channel-repository/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/channel-repository/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,IAAI,OAAO,EAAE,MAAO,iBAAiB,CAAA;AAClF,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA"}

package/dist/services/channel-repository/queries.d.ts

@@ -0,0 +1,3 @@
+export declare const getAll: string;
+export declare const getById: string;
+export declare const getByDomain: string;

package/dist/services/channel-repository/queries.js

@@ -0,0 +1,93 @@
+import { gql } from 'graphql-request';
+export const getAll = gql `query GetAllChannels {
+    GetAllChannels:SiteDefinition {
+        channels: items {
+            id: Id
+            name: Name,
+            domains: Hosts {
+                name: Name
+                type: Type
+                forLocale: Language {
+                    code: Name
+                }
+            }
+            locales:Languages {
+                code:Name
+                slug:UrlSegment
+                isDefault:IsMasterLanguage
+            }
+            content: ContentRoots {
+                startPage: StartPage {
+                    id:Id,
+                    guidValue:GuidValue
+                }
+            }
+        }
+    }
+}`;
+export const getById = gql `query GetChannelById($id: String!) {
+    GetChannelById:SiteDefinition (
+        where: {
+            Id: { eq: $id }
+        }
+        limit: 1
+    ) {
+        channels: items {
+            id: Id
+            name: Name,
+            domains: Hosts {
+                name: Name
+                type: Type
+                forLocale: Language {
+                    code: Name
+                }
+            }
+            locales:Languages {
+                code:Name
+                slug:UrlSegment
+                isDefault:IsMasterLanguage
+            }
+            content: ContentRoots {
+                startPage: StartPage {
+                    id:Id,
+                    guidValue:GuidValue
+                }
+            }
+        }
+    }
+}`;
+export const getByDomain = gql `query GetChannelByDomain($domain: String!, $fallback: String! = "___") {
+    GetChannelByDomain:SiteDefinition (
+        where: {
+            _or: [
+                {Hosts: { Name: { eq: $domain }}},
+                {Hosts: { Name: { eq: $fallback }}}
+            ]  
+        }
+        limit: 1
+    ) {
+        channels: items {
+            id: Id
+            name: Name,
+            domains: Hosts {
+                name: Name
+                type: Type
+                forLocale: Language {
+                    code: Name
+                }
+            }
+            locales:Languages {
+                code:Name
+                slug:UrlSegment
+                isDefault:IsMasterLanguage
+            }
+            content: ContentRoots {
+                startPage: StartPage {
+                    id:Id,
+                    guidValue:GuidValue
+                }
+            }
+        }
+    }
+}`;
+//# sourceMappingURL=queries.js.map

package/dist/services/channel-repository/queries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queries.js","sourceRoot":"","sources":["../../../src/services/channel-repository/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAErC,MAAM,CAAC,MAAM,MAAM,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;EAyBvB,CAAA;AACF,MAAM,CAAC,MAAM,OAAO,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA8BxB,CAAA;AACF,MAAM,CAAC,MAAM,WAAW,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiC5B,CAAA"}