@sparkrewards/sra-client 0.0.3 → 0.0.4

package/README.md

@@ -1,31 +1,106 @@
-## @sparkrewards/app-api-sdk
+## @sparkrewards/sra-client
 
 TypeScript / JavaScript client SDK for the Spark Rewards App API, generated from the Smithy service model.
 
 ### Installation
 
 ```bash
-npm install @sparkrewards/app-api-sdk
+npm install @sparkrewards/sra-client
 # or
-yarn add @sparkrewards/app-api-sdk
+yarn add @sparkrewards/sra-client
 ```
 
-### Basic usage
+### Authentication
 
-```ts
-import { AppAPIClient, PlanCommand } from "@sparkrewards/app-api-sdk";
+The App API uses **Cognito User Pools** authentication. You must configure the client with the `aws.auth#cognitoUserPools` auth scheme.
+
+> **Important:** The generated client does not automatically provide auth scheme implementations. You must configure `httpAuthSchemes` when creating the client.
+
+#### Basic Usage with AWS Amplify
+
+```typescript
+import { AppAPIClient } from '@sparkrewards/sra-client';
+import { fetchAuthSession } from 'aws-amplify/auth';
+import { 
+  HttpAuthScheme, 
+  Identity, 
+  IdentityProvider, 
+  IdentityProviderConfig 
+} from "@smithy/types";
+
+interface CognitoIdentity extends Identity {
+  token: string;
+}
+
+function createCognitoAuthScheme(token?: string): HttpAuthScheme {
+  return {
+    schemeId: "aws.auth#cognitoUserPools",
+    identityProvider: (config: IdentityProviderConfig): IdentityProvider<CognitoIdentity> => {
+      return async (): Promise<CognitoIdentity> => {
+        return { token: token || '' } as CognitoIdentity;
+      };
+    },
+    signer: {
+      sign: async (httpRequest: any, identity: any) => {
+        const cognitoIdentity = identity as CognitoIdentity;
+        httpRequest.headers["Authorization"] = `Bearer ${cognitoIdentity.token}`;
+        return httpRequest;
+      },
+    },
+  };
+}
+
+async function getClient(): Promise<AppAPIClient> {
+  const session = await fetchAuthSession();
+  const idToken = session.tokens?.idToken?.toString();
+
+  const client = new AppAPIClient({
+    endpoint: 'https://beta-api.sparkrewards.co/sra',
+    httpAuthSchemes: [createCognitoAuthScheme(idToken)],
+  });
+  
+  return client;
+}
+
+// Usage
+const client = await getClient();
+const result = await client.send(new GetUserCommand({}));
+```
+
+#### Using with Public Endpoints
+
+For public endpoints (those with `@auth([])` in the model), you don't need authentication:
+
+```typescript
+import { AppAPIClient, NearbyShopsPublicCommand } from '@sparkrewards/sra-client';
 
 const client = new AppAPIClient({
-  region: "us-east-1",
-  // endpoint, credentials, etc as needed
+  endpoint: 'https://beta-api.sparkrewards.co/sra',
+  httpAuthSchemes: [], // Empty array for public-only usage
 });
 
-async function getPlan(orgId: string) {
-  const result = await client.send(new PlanCommand({ org_id: orgId }));
-  console.log(result);
-}
+const shops = await client.send(new NearbyShopsPublicCommand({
+  lat: 40.7128,
+  lon: -74.0060,
+}));
 ```
 
+### API Operations
+
+The client supports both authenticated and public operations:
+
+**Authenticated operations** (require Cognito token):
+- `GetUser`, `UpdateUser`, `DeleteUser`, `OnboardUser`
+- `NearbyShops`, `FavoriteShops`, `GetShop`, `PinnedShop`, `PopularShops`
+- `Plan`, `Plans`, `FavoritePlans`
+- `RedeemFirstTimeReward`, `RedeemVisitReward`, `RedeemPointReward`
+- `RecordVisit`, `LikeOrg`
+
+**Public operations** (no authentication required):
+- `NearbyShopsPublic`, `PopularShopsPublic`, `GetShopPublic`
+- `PlanPublic`, `PinnedShopPublic`, `SearchShopsPublic`
+- `RadiusShops`, `SearchSuggestion`
+
 ### Regenerating from the Smithy model
 
 This package is generated by the `typescript-client-codegen` Smithy plugin. To regenerate it:
@@ -38,4 +113,3 @@ The generated package lives under:
 
 - `smithy/build/smithyprojections/smithy/source/typescript-client-codegen`
 
-

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@sparkrewards/sra-client",
     "description": "@sparkrewards/sra-client client",
-    "version": "0.0.3",
+    "version": "0.0.4",
     "scripts": {
         "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
         "build:cjs": "tsc -p tsconfig.cjs.json",