@cleanmate/cip-sdk 1.0.0

package/README.md

@@ -0,0 +1,114 @@
+# @cleanmate/cip-sdk
+
+CleanMate CIP metadata standard utilities for smart contract metadata parsing and validation.
+
+## Installation
+
+```bash
+npm install @cleanmate/cip-sdk
+```
+
+## Usage
+
+### Basic Import
+
+```typescript
+import { parseUserProfileMetadata, stringifyUserProfileMetadata } from '@cleanmate/cip-sdk';
+```
+
+### Subpath Imports
+
+You can also import from specific subpaths:
+
+```typescript
+import { parseCleanupMetadata } from '@cleanmate/cip-sdk/cleanup';
+import { parseUserProfileMetadata } from '@cleanmate/cip-sdk/user';
+import { parseStreakSubmissionMetadata } from '@cleanmate/cip-sdk/streak';
+```
+
+## API
+
+### User Profile Metadata
+
+```typescript
+import { parseUserProfileMetadata, stringifyUserProfileMetadata, type UserProfileMetadata } from '@cleanmate/cip-sdk/user';
+
+// Parse metadata from smart contract
+const metadataString = userProfile.metadata; // JSON string from contract
+const parsed = parseUserProfileMetadata(metadataString);
+if (parsed) {
+  console.log(parsed.name);
+}
+
+// Create metadata for smart contract
+const newMetadata: UserProfileMetadata<string> = {
+  name: 'John Doe',
+  bio: 'Environmental enthusiast',
+  photo: 'ipfs://Qm...',
+  interests: ['cleaning', 'environment']
+};
+const jsonString = stringifyUserProfileMetadata(newMetadata);
+```
+
+### Cleanup Metadata
+
+```typescript
+import { parseCleanupMetadata, stringifyCleanupMetadata, type CleanupMetadata } from '@cleanmate/cip-sdk/cleanup';
+
+const metadata = parseCleanupMetadata(cleanupEvent.metadata);
+const jsonString = stringifyCleanupMetadata({
+  title: 'Beach Cleanup',
+  description: 'Monthly beach cleanup event',
+  category: 'beach',
+  media: []
+});
+```
+
+### Streak Metadata
+
+```typescript
+import { 
+  parseStreakSubmissionMetadata, 
+  stringifyStreakSubmissionMetadata,
+  parseStreakStatsMetadata,
+  stringifyStreakStatsMetadata,
+  type StreakSubmissionMetadata,
+  type StreakStatsMetadata
+} from '@cleanmate/cip-sdk/streak';
+
+// Streak submission
+const submissionMetadata: StreakSubmissionMetadata = {
+  description: 'Completed cleanup',
+  timestamp: new Date().toISOString(),
+  mediaCount: 3
+};
+const jsonString = stringifyStreakSubmissionMetadata(submissionMetadata);
+
+// Streak statistics
+const statsMetadata: StreakStatsMetadata = {
+  currentStreak: 5,
+  longestStreak: 10,
+  lastActivityDate: new Date().toISOString()
+};
+const statsJson = stringifyStreakStatsMetadata(statsMetadata);
+```
+
+## Base Utilities
+
+```typescript
+import { 
+  parseMetadata, 
+  stringifyMetadata, 
+  hasRequiredFields,
+  isMetadataObject,
+  type BaseMetadata 
+} from '@cleanmate/cip-sdk';
+```
+
+## Building
+
+```bash
+npm run build
+```
+
+This will compile TypeScript to JavaScript in the `dist` directory.

package/dist/abis/Cleanup.d.ts

@@ -0,0 +1,132 @@
+export declare const CleanupABI: ({
+    inputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+    name?: undefined;
+    anonymous?: undefined;
+    outputs?: undefined;
+} | {
+    inputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    type: string;
+    stateMutability?: undefined;
+    anonymous?: undefined;
+    outputs?: undefined;
+} | {
+    anonymous: boolean;
+    inputs: {
+        indexed: boolean;
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    type: string;
+    stateMutability?: undefined;
+    outputs?: undefined;
+} | {
+    inputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    outputs: {
+        components: ({
+            internalType: string;
+            name: string;
+            type: string;
+            components?: undefined;
+        } | {
+            components: {
+                internalType: string;
+                name: string;
+                type: string;
+            }[];
+            internalType: string;
+            name: string;
+            type: string;
+        })[];
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+    anonymous?: undefined;
+} | {
+    inputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    outputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+    anonymous?: undefined;
+} | {
+    inputs: {
+        components: ({
+            internalType: string;
+            name: string;
+            type: string;
+            components?: undefined;
+        } | {
+            components: {
+                internalType: string;
+                name: string;
+                type: string;
+            }[];
+            internalType: string;
+            name: string;
+            type: string;
+        })[];
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    outputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+    anonymous?: undefined;
+} | {
+    inputs: ({
+        internalType: string;
+        name: string;
+        type: string;
+        components?: undefined;
+    } | {
+        components: {
+            internalType: string;
+            name: string;
+            type: string;
+        }[];
+        internalType: string;
+        name: string;
+        type: string;
+    })[];
+    name: string;
+    outputs: never[];
+    stateMutability: string;
+    type: string;
+    anonymous?: undefined;
+})[];
+//# sourceMappingURL=Cleanup.d.ts.map

package/dist/abis/Cleanup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Cleanup.d.ts","sourceRoot":"","sources":["../../src/abis/Cleanup.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA6yCtB,CAAC"}