@geins/types 0.1.0

package/codegen.ts

@@ -0,0 +1,49 @@
+import type { CodegenConfig } from '@graphql-codegen/cli';
+const config: CodegenConfig = {
+  schema: '../../../schemas/schema-w-docblocks.graphql',
+  documents: [
+    '../core/src/graphql/**/*.gql',
+    '../cms/src/graphql/**/*.gql',
+    '../crm/src/graphql/**/*.gql',
+  ],
+  generates: {
+    'src/generated/graphql.ts': {
+      plugins: ['typescript', 'typescript-operations', 'jsdoc'],
+      config: {
+        typesPrefix: 'Geins',
+        typesSuffix: 'Type',
+        addDocBlocks: true,
+        printFieldsOnNewLines: true,
+        declarationKind: 'interface',
+        skipTypename: true,
+        useTypeImports: true,
+        preResolveTypes: true,
+        flattenGeneratedTypes: true,
+        flattenGeneratedTypesIncludeFragments: true,
+        avoidOptionals: false,
+        allowUndefinedQueryVariables: true,
+        //globalNamespace: 'Geins',
+        //directiveArgumentAndInputFieldMappingTypeSuffix: 'DirectiveArgs',
+        extractAllFieldsToTypes: false,
+        omitOperationSuffix: true,
+        //operationResultSuffix: 'Result',
+        // namingConvention: 'change-case-all#camelCase',
+        enumPrefix: true,
+        enumSuffix: false,
+        scalars: {
+          ID: 'string | number',
+          Int: 'number',
+          Float: 'number',
+          Long: 'number',
+          String: 'string',
+          Boolean: 'boolean',
+          Guid: 'string',
+          DateTime: 'string',
+          Decimal: 'number',
+        },
+      },
+    },
+  },
+};
+
+export default config;

package/dist/api-client/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Endpoints for the current environment.
+ * - main: The main api endpoint used to query Geins.
+ * - auth: The auth endpoint.
+ * - authSign: The auth sign endpoint.
+ * - image: The base image url
+ */
+export interface GeinsEndpoints {
+    main: string;
+    auth: string;
+    authSign: string;
+    image: string;
+}
+export interface GeinsBaseApiVars {
+    channelId?: string | null;
+    marketId?: string | null;
+    languageId?: string | null;
+}
+export interface ManagementApiCredentials {
+    apiKey: string;
+    username: string;
+    password: string;
+}

package/dist/cms/contentArea.d.ts

@@ -0,0 +1,50 @@
+import { KeyValue } from '../common';
+import { GeinsCustomerType } from '../generated';
+import type { GeinsBaseApiVars } from '../api-client';
+export interface ContentPageVariables extends BaseCmsVariables {
+    alias: string;
+}
+export interface ContentAreaVariables extends BaseCmsVariables {
+    areaName: string;
+    family: string;
+}
+export interface BaseCmsVariables extends GeinsBaseApiVars {
+    customerType?: GeinsCustomerType | null;
+    preview?: boolean | null;
+    filters?: Array<KeyValue> | null;
+    displaySetting?: string | null;
+}
+export interface ContentImageSizeType {
+    imageWidth: number;
+    imageHeight: number;
+}
+export interface ContentImageType {
+    fileName: string;
+    largestSize: ContentImageSizeType;
+}
+export interface ContentType {
+    id: string;
+    name: string;
+    sortOrder: number;
+    type: string;
+    size: string;
+    configuration: string;
+    images: ContentImageType[];
+}
+export interface ContentContainerType {
+    id: string;
+    name: string;
+    sortOrder: number;
+    layout: string;
+    responsiveMode: string;
+    design: string;
+    content: ContentType[];
+}
+export interface ContentAreaType {
+    meta: any;
+    tags: string[];
+    containers: ContentContainerType[];
+}
+export interface ContentPageServiceResult {
+    contentArea: ContentAreaType;
+}

package/dist/cms/index.d.ts

@@ -0,0 +1,2 @@
+export * from './menu';
+export * from './contentArea';

package/dist/cms/menu.d.ts

@@ -0,0 +1,10 @@
+import type { GeinsBaseApiVars } from '../api-client';
+import { GeinsMenuTypeType } from '../generated';
+export interface MenuVariables extends GeinsBaseApiVars {
+    menuLocationId: string;
+}
+export interface MenuServiceResult {
+    data: {
+        getMenuAtLocation: GeinsMenuTypeType;
+    };
+}

package/dist/common/channel.d.ts

@@ -0,0 +1,4 @@
+export type GeinsMarketLanguageType = {
+    marketId: string;
+    languageId: string;
+};

package/dist/common/event.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Event message interface
+ * @interface
+ * @name GeinsEventMessage
+ * @property {string} subject - Event subject
+ * @property {any} payload - Event payload
+ * @property {boolean} [broadcast] - Broadcast event over windows and tabs
+ * @example
+ * {
+ *  subject: 'USER_LOGIN',
+ *  payload: {
+ *   user: 'luke.skywalker@tatooine.com',
+ *  },
+ * broadcast: true,
+ * }
+ */
+export interface GeinsEventMessage {
+    subject: string;
+    payload: any;
+    broadcast?: boolean;
+}
+/**
+ * Event type
+ * Events emitted by the SDK to listen to
+ * @enum
+ * @name GeinsEventType
+ */
+export declare enum GeinsEventType {
+    USER = "USER",
+    USER_LOGIN = "USER_LOGIN",
+    USER_LOGOUT = "USER_LOGOUT",
+    USER_UPDATE = "USER_UPDATE",
+    USER_DELETE = "USER_DELETE",
+    CART = "CART",
+    CART_ADD = "CART_ADD",
+    CART_REMOVE = "CART_REMOVE",
+    CART_UPDATE = "CART_UPDATE",
+    CART_CLEAR = "CART_CLEAR"
+}

package/dist/common/index.d.ts

@@ -0,0 +1,21 @@
+import type { GeinsChannelTypeType } from '../generated';
+export * from './channel';
+export * from './event';
+export type Environment = 'prod' | 'qa' | 'dev';
+export interface KeyValue {
+    key: string;
+    value: string;
+}
+export type GeinsSettings = {
+    apiKey: string;
+    accountName: string;
+    channel: string;
+    tld: string;
+    locale: string;
+    market: string;
+    environment?: Environment;
+};
+export interface GeinsChannelInterface {
+    current: () => Promise<GeinsChannelTypeType | undefined>;
+    all: () => Promise<GeinsChannelTypeType[] | undefined>;
+}

package/dist/crm/auth.d.ts

@@ -0,0 +1,152 @@
+/**
+ * Interface representing the authentication credentials required for user login.
+ */
+export interface AuthCredentials {
+    /**
+     * The username of the user attempting to authenticate.
+     */
+    username: string;
+    /**
+     * The password of the user attempting to authenticate.
+     */
+    password: string;
+    /**
+     * The new password for the user, used when updating or resetting a password.
+     * This field is optional.
+     */
+    newPassword?: string;
+    /**
+     * A boolean indicating whether the user should be remembered on this device.
+     * Defaults to `false` if not provided.
+     */
+    rememberUser?: boolean;
+}
+/**
+ * Interface representing the response from an authentication attempt.
+ */
+export interface AuthResponse {
+    /**
+     * A boolean indicating whether the authentication attempt was successful.
+     */
+    succeeded: boolean;
+    /**
+     * The authenticated user information, if the authentication was successful.
+     * This field is optional.
+     */
+    user?: AuthUser;
+    /**
+     * The tokens provided upon successful authentication, used for session management.
+     * This field is optional.
+     */
+    tokens?: AuthTokens;
+}
+/**
+ * Interface representing the authentication tokens used for session management.
+ */
+export interface AuthTokens {
+    /**
+     * The primary token used for authenticating subsequent API requests.
+     * This field is optional.
+     */
+    token?: string;
+    /**
+     * The refresh token used to obtain a new primary token when the current one expires.
+     * This field is optional.
+     */
+    refreshToken?: string;
+    /**
+     * The maximum age (in seconds) for the session before it expires.
+     * This field is optional.
+     */
+    maxAge?: number;
+    /**
+     * A boolean indicating whether the token has already expired.
+     * This field is optional.
+     */
+    expired?: boolean;
+    /**
+     * The expiration timestamp (in milliseconds since Unix epoch) of the token.
+     * This field is optional.
+     */
+    expires?: number;
+    /**
+     * The number of seconds until the token expires.
+     * This field is optional.
+     */
+    expiresIn?: number;
+    /**
+     * A boolean indicating whether the token is about to expire soon.
+     * This field is optional.
+     */
+    expiresSoon?: boolean;
+}
+/**
+ * Interface representing the authenticated user information.
+ */
+export interface AuthUser {
+    /**
+     * A boolean indicating whether the user is authenticated.
+     * This field is optional.
+     */
+    authenticated?: boolean;
+    /**
+     * The unique identifier of the authenticated user.
+     * This field is optional.
+     */
+    userId?: string;
+    /**
+     * The username of the authenticated user.
+     * This field is optional.
+     */
+    username?: string;
+    /**
+     * The type of customer (e.g., regular, premium) the authenticated user is.
+     * This field is optional.
+     */
+    customerType?: string;
+    /**
+     * The discount percentage (if any) available to the authenticated user.
+     * This field is optional.
+     */
+    memberDiscount?: string;
+    /**
+     * The type of membership (e.g., silver, gold) the authenticated user has.
+     * This field is optional.
+     */
+    memberType?: string;
+    /**
+     * The unique identifier of the membership the authenticated user holds.
+     * This field is optional.
+     */
+    memberId?: string;
+}
+export interface AuthUserToken {
+    maxAge: number;
+    token: string;
+    refreshToken: string;
+}
+export interface AuthSignature {
+    identity: string;
+    signature: string;
+    timestamp: string;
+}
+export declare enum AuthClientConnectionModes {
+    Proxy = "Proxy",
+    Direct = "Direct"
+}
+export type AuthClientConnectionMode = keyof typeof AuthClientConnectionModes;
+/**
+ * Authentication settings used by the client.
+ */
+export interface AuthSettings {
+    /**
+     * The client connection mode used for authentication.
+     */
+    clientConnectionMode: AuthClientConnectionMode;
+    /**
+     * The URL of the proxy server used for authentication.
+     * This field is optional.
+     * Defaults to `/api/auth` if not provided.
+     */
+    proxyUrl?: string;
+}

package/dist/crm/index.d.ts

@@ -0,0 +1 @@
+export * from './auth';