@htlkg/data 0.0.1

package/dist/queries/index.d.ts

@@ -0,0 +1,386 @@
+import { Brand, Account, User, Product, ProductInstance } from '@htlkg/core/types';
+
+/**
+ * Brand Query Functions
+ *
+ * Provides query functions for fetching brand data from the GraphQL API.
+ */
+
+/**
+ * Get a single brand by ID
+ *
+ * @example
+ * ```typescript
+ * import { getBrand } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const brand = await getBrand(client, 'brand-123');
+ * ```
+ */
+declare function getBrand<TClient = any>(client: TClient, id: string): Promise<Brand | null>;
+/**
+ * List all brands with optional filtering
+ *
+ * @example
+ * ```typescript
+ * import { listBrands } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const brands = await listBrands(client, {
+ *   filter: { status: { eq: 'active' } }
+ * });
+ * ```
+ */
+declare function listBrands<TClient = any>(client: TClient, options?: {
+    filter?: any;
+    limit?: number;
+    nextToken?: string;
+}): Promise<{
+    items: Brand[];
+    nextToken?: string;
+}>;
+/**
+ * Get a brand with its product instances
+ *
+ * @example
+ * ```typescript
+ * import { getBrandWithProducts } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const brand = await getBrandWithProducts(client, 'brand-123');
+ * ```
+ */
+declare function getBrandWithProducts<TClient = any>(client: TClient, id: string): Promise<Brand | null>;
+/**
+ * List brands by account ID
+ *
+ * @example
+ * ```typescript
+ * import { listBrandsByAccount } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const brands = await listBrandsByAccount(client, 'account-123');
+ * ```
+ */
+declare function listBrandsByAccount<TClient = any>(client: TClient, accountId: string, options?: {
+    limit?: number;
+    nextToken?: string;
+}): Promise<{
+    items: Brand[];
+    nextToken?: string;
+}>;
+/**
+ * List active brands
+ *
+ * @example
+ * ```typescript
+ * import { listActiveBrands } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const brands = await listActiveBrands(client);
+ * ```
+ */
+declare function listActiveBrands<TClient = any>(client: TClient, options?: {
+    limit?: number;
+    nextToken?: string;
+}): Promise<{
+    items: Brand[];
+    nextToken?: string;
+}>;
+
+/**
+ * Account Query Functions
+ *
+ * Provides query functions for fetching account data from the GraphQL API.
+ */
+
+/**
+ * Get a single account by ID
+ *
+ * @example
+ * ```typescript
+ * import { getAccount } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const account = await getAccount(client, 'account-123');
+ * ```
+ */
+declare function getAccount<TClient = any>(client: TClient, id: string): Promise<Account | null>;
+/**
+ * List all accounts with optional filtering
+ *
+ * @example
+ * ```typescript
+ * import { listAccounts } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const accounts = await listAccounts(client);
+ * ```
+ */
+declare function listAccounts<TClient = any>(client: TClient, options?: {
+    filter?: any;
+    limit?: number;
+    nextToken?: string;
+}): Promise<{
+    items: Account[];
+    nextToken?: string;
+}>;
+/**
+ * Get an account with its brands
+ *
+ * @example
+ * ```typescript
+ * import { getAccountWithBrands } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const account = await getAccountWithBrands(client, 'account-123');
+ * ```
+ */
+declare function getAccountWithBrands<TClient = any>(client: TClient, id: string): Promise<Account | null>;
+
+/**
+ * User Query Functions
+ *
+ * Provides query functions for fetching user data from the GraphQL API.
+ */
+
+/**
+ * Get a single user by ID
+ *
+ * @example
+ * ```typescript
+ * import { getUser } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const user = await getUser(client, 'user-123');
+ * ```
+ */
+declare function getUser<TClient = any>(client: TClient, id: string): Promise<User | null>;
+/**
+ * Get a user by Cognito ID
+ *
+ * @example
+ * ```typescript
+ * import { getUserByCognitoId } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const user = await getUserByCognitoId(client, 'cognito-id-123');
+ * ```
+ */
+declare function getUserByCognitoId<TClient = any>(client: TClient, cognitoId: string): Promise<User | null>;
+/**
+ * Get a user by email
+ *
+ * @example
+ * ```typescript
+ * import { getUserByEmail } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const user = await getUserByEmail(client, 'user@example.com');
+ * ```
+ */
+declare function getUserByEmail<TClient = any>(client: TClient, email: string): Promise<User | null>;
+/**
+ * List all users with optional filtering
+ *
+ * @example
+ * ```typescript
+ * import { listUsers } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const users = await listUsers(client, {
+ *   filter: { status: { eq: 'active' } }
+ * });
+ * ```
+ */
+declare function listUsers<TClient = any>(client: TClient, options?: {
+    filter?: any;
+    limit?: number;
+    nextToken?: string;
+}): Promise<{
+    items: User[];
+    nextToken?: string;
+}>;
+/**
+ * List users by account ID
+ *
+ * @example
+ * ```typescript
+ * import { listUsersByAccount } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const users = await listUsersByAccount(client, 'account-123');
+ * ```
+ */
+declare function listUsersByAccount<TClient = any>(client: TClient, accountId: string, options?: {
+    limit?: number;
+    nextToken?: string;
+}): Promise<{
+    items: User[];
+    nextToken?: string;
+}>;
+/**
+ * List active users
+ *
+ * @example
+ * ```typescript
+ * import { listActiveUsers } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const users = await listActiveUsers(client);
+ * ```
+ */
+declare function listActiveUsers<TClient = any>(client: TClient, options?: {
+    limit?: number;
+    nextToken?: string;
+}): Promise<{
+    items: User[];
+    nextToken?: string;
+}>;
+
+/**
+ * Product Query Functions
+ *
+ * Provides query functions for fetching product and product instance data from the GraphQL API.
+ */
+
+/**
+ * Get a single product by ID
+ *
+ * @example
+ * ```typescript
+ * import { getProduct } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const product = await getProduct(client, 'product-123');
+ * ```
+ */
+declare function getProduct<TClient = any>(client: TClient, id: string): Promise<Product | null>;
+/**
+ * List all products with optional filtering
+ *
+ * @example
+ * ```typescript
+ * import { listProducts } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const products = await listProducts(client, {
+ *   filter: { isActive: { eq: true } }
+ * });
+ * ```
+ */
+declare function listProducts<TClient = any>(client: TClient, options?: {
+    filter?: any;
+    limit?: number;
+    nextToken?: string;
+}): Promise<{
+    items: Product[];
+    nextToken?: string;
+}>;
+/**
+ * List active products
+ *
+ * @example
+ * ```typescript
+ * import { listActiveProducts } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const products = await listActiveProducts(client);
+ * ```
+ */
+declare function listActiveProducts<TClient = any>(client: TClient, options?: {
+    limit?: number;
+    nextToken?: string;
+}): Promise<{
+    items: Product[];
+    nextToken?: string;
+}>;
+/**
+ * Get a single product instance by ID
+ *
+ * @example
+ * ```typescript
+ * import { getProductInstance } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const instance = await getProductInstance(client, 'instance-123');
+ * ```
+ */
+declare function getProductInstance<TClient = any>(client: TClient, id: string): Promise<ProductInstance | null>;
+/**
+ * List product instances by brand ID
+ *
+ * @example
+ * ```typescript
+ * import { listProductInstancesByBrand } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const instances = await listProductInstancesByBrand(client, 'brand-123');
+ * ```
+ */
+declare function listProductInstancesByBrand<TClient = any>(client: TClient, brandId: string, options?: {
+    limit?: number;
+    nextToken?: string;
+}): Promise<{
+    items: ProductInstance[];
+    nextToken?: string;
+}>;
+/**
+ * List product instances by account ID
+ *
+ * @example
+ * ```typescript
+ * import { listProductInstancesByAccount } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const instances = await listProductInstancesByAccount(client, 'account-123');
+ * ```
+ */
+declare function listProductInstancesByAccount<TClient = any>(client: TClient, accountId: string, options?: {
+    limit?: number;
+    nextToken?: string;
+}): Promise<{
+    items: ProductInstance[];
+    nextToken?: string;
+}>;
+/**
+ * List enabled product instances by brand ID
+ *
+ * @example
+ * ```typescript
+ * import { listEnabledProductInstancesByBrand } from '@htlkg/data/queries';
+ * import { generateClient } from '@htlkg/data/client';
+ *
+ * const client = generateClient<Schema>();
+ * const instances = await listEnabledProductInstancesByBrand(client, 'brand-123');
+ * ```
+ */
+declare function listEnabledProductInstancesByBrand<TClient = any>(client: TClient, brandId: string, options?: {
+    limit?: number;
+    nextToken?: string;
+}): Promise<{
+    items: ProductInstance[];
+    nextToken?: string;
+}>;
+
+export { getAccount, getAccountWithBrands, getBrand, getBrandWithProducts, getProduct, getProductInstance, getUser, getUserByCognitoId, getUserByEmail, listAccounts, listActiveBrands, listActiveProducts, listActiveUsers, listBrands, listBrandsByAccount, listEnabledProductInstancesByBrand, listProductInstancesByAccount, listProductInstancesByBrand, listProducts, listUsers, listUsersByAccount };